Merge pull request #24 from starknet-id/feat/getstarkname_multicall

feat: add getStarkNames
lfglabs-dev · Feb 27, 2024 · 75e434b · 75e434b
2 parents 017a8a1 + d03f734
commit 75e434b
Show file tree

Hide file tree

Showing 14 changed files with 99 additions and 1,261 deletions.
diff --git a/example/.gitignore b/example/.gitignore
diff --git a/example/index.html b/example/index.html
diff --git a/example/package-lock.json b/example/package-lock.json
diff --git a/example/package.json b/example/package.json
diff --git a/example/src/App.tsx b/example/src/App.tsx
diff --git a/example/src/main.tsx b/example/src/main.tsx
diff --git a/example/tsconfig.json b/example/tsconfig.json
diff --git a/example/tsconfig.node.json b/example/tsconfig.node.json
diff --git a/example/vite.config.ts b/example/vite.config.ts
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "starknetid.js",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "JavaScript library for Starknet ID",
   "private": false,
   "license": "MIT",

diff --git a/packages/core/__test__/default.test.ts b/packages/core/__test__/default.test.ts
@@ -3,6 +3,8 @@ import { StarknetIdNavigator } from "../src";
 import {
   compiledIdentitySierra,
   compiledIdentitySierraCasm,
+  compiledMulticallSierra,
+  compiledMulticallSierraCasm,
   compiledNamingSierra,
   compiledNamingSierraCasm,
   compiledPricingSierra,
@@ -20,6 +22,7 @@ describe("test starknetid.js sdk", () => {
     "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7";
   let NamingContract: string;
   let IdentityContract: string;
+  let MulticallContract: string;
 
   beforeAll(async () => {
     expect(account).toBeInstanceOf(Account);
@@ -62,6 +65,16 @@ describe("test starknetid.js sdk", () => {
     );
     NamingContract = namingResponse.deploy.contract_address;
 
+    // Deploy multicall contract
+    const multicallResponse = await account.declareAndDeploy(
+      {
+        contract: compiledMulticallSierra,
+        casm: compiledMulticallSierraCasm,
+      },
+      { maxFee: 1e18 },
+    );
+    MulticallContract = multicallResponse.deploy.contract_address;
+
     const { transaction_hash } = await account.execute(
       [
         {
@@ -129,6 +142,24 @@ describe("test starknetid.js sdk", () => {
     expect(name).toBe("ben.stark");
   });
 
+  test("getStarkNames should work", async () => {
+    const starknetIdNavigator = new StarknetIdNavigator(
+      provider,
+      constants.StarknetChainId.SN_GOERLI,
+      {
+        naming: NamingContract,
+        identity: IdentityContract,
+      },
+    );
+    expect(starknetIdNavigator).toBeInstanceOf(StarknetIdNavigator);
+    const addresses = [account.address, account.address, account.address];
+    const names = await starknetIdNavigator.getStarkNames(
+      addresses,
+      MulticallContract,
+    );
+    expect(names).toEqual(["ben.stark", "ben.stark", "ben.stark"]);
+  });
+
   test("getStarknetId should return id 1 for ben.stark", async () => {
     const starknetIdNavigator = new StarknetIdNavigator(
       provider,

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "starknetid.js",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "keywords": [
     "starknet",
     "starknetid",

diff --git a/packages/core/src/starknetIdNavigator/default.ts b/packages/core/src/starknetIdNavigator/default.ts
@@ -11,6 +11,7 @@ import {
   cairo,
   Contract,
   RawArgs,
+  RawArgsArray,
 } from "starknet";
 import {
   decodeDomain,
@@ -95,6 +96,59 @@ export class StarknetIdNavigator implements StarknetIdNavigatorInterface {
     }
   }
 
+  public async getStarkNames(
+    addresses: string[],
+    multicallContract?: string,
+  ): Promise<string[]> {
+    const namingContract =
+      this.StarknetIdContract.naming ?? getNamingContract(this.chainId);
+    const multicallAddress =
+      multicallContract ?? getMulticallContract(this.chainId);
+
+    // We need our contract to know the abi,
+    // otherwise we have to hardcode all the values for each enums
+    const { abi: multicallAbi } = await this.provider.getClassAt(
+      multicallAddress,
+    );
+    const contract = new Contract(
+      multicallAbi,
+      multicallAddress,
+      this.provider,
+    );
+
+    try {
+      // build calldata for all addresses
+      let calldata: RawArgsArray = [];
+      addresses.forEach((address) => {
+        calldata.push({
+          execution: this.staticExecution(),
+          to: this.hardcoded(namingContract),
+          selector: this.hardcoded(
+            hash.getSelectorFromName("address_to_domain"),
+          ),
+          calldata: [this.hardcoded(address)],
+        });
+      });
+
+      const data = await contract.call("aggregate", [calldata]);
+
+      let result: string[] = [];
+      if (Array.isArray(data)) {
+        data.forEach((hexDomain: any) => {
+          const decimalDomain = hexDomain
+            .map((element: bigint) => BigInt(element))
+            .slice(1);
+          const stringDomain = decodeDomain(decimalDomain);
+          result.push(stringDomain);
+        });
+      }
+
+      return result;
+    } catch (e) {
+      throw new Error("Could not get stark names");
+    }
+  }
+
   public async getStarknetId(domain: string): Promise<string> {
     const contract =
       this.StarknetIdContract.naming ?? getNamingContract(this.chainId);

diff --git a/packages/core/src/starknetIdNavigator/interface.ts b/packages/core/src/starknetIdNavigator/interface.ts
@@ -22,6 +22,18 @@ export abstract class StarknetIdNavigatorInterface {
    */
   public abstract getStarkName(address: string): Promise<string>;
 
+  /**
+   * Get Starknames from an array of address
+   *
+   * @param addresses
+   * @param multicallContract (optional, will use the default one if not provided)
+   * @returns starknames
+   */
+  public abstract getStarkNames(
+    addresses: string[],
+    multicallContract?: string,
+  ): Promise<string[]>;
+
   /**
    * Get Starknet id from domain
    *