starknet 4.21.1 → 4.22.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [4.22.0](https://github.com/0xs34n/starknet.js/compare/v4.21.1...v4.22.0) (2023-02-22)
+
+### Features
+
+- move starkname to provider ([8e88ed0](https://github.com/0xs34n/starknet.js/commit/8e88ed0dd9f651dd9decea75dfdae2357e6bfa4a))
+
 ## [4.21.1](https://github.com/0xs34n/starknet.js/compare/v4.21.0...v4.21.1) (2023-02-20)
 
 ### Bug Fixes

package/dist/index.d.ts

@@ -64,9 +64,9 @@ declare namespace number {
 /**
  * Starknet RPC version 0.2.0
  *
- * StarkNet Node API 0.45.0 - rpc 0.2.1
- * StarkNet Node Write API 0.3.0 - rpc 0.2.1
- * StarkNet Trace API 0.4.0 - rpc 0.2.1
+ * Starknet Node API 0.45.0 - rpc 0.2.1
+ * Starknet Node Write API 0.3.0 - rpc 0.2.1
+ * Starknet Trace API 0.4.0 - rpc 0.2.1
  *
  * TypeScript Representation of OpenRpc protocol types
  */
@@ -1512,7 +1512,7 @@ declare abstract class ProviderInterface {
      */
     abstract getChainId(): Promise<StarknetChainId>;
     /**
-     * Calls a function on the StarkNet contract.
+     * Calls a function on the Starknet contract.
      *
      * @param call transaction to be called
      * @param blockIdentifier block identifier
@@ -1806,6 +1806,8 @@ declare class RpcProvider implements ProviderInterface {
      */
     getEvents(eventFilter: RPC.EventFilter): Promise<RPC.GetEventsResponse>;
     getSimulateTransaction(_invocation: Invocation, _invocationDetails: InvocationsDetailsWithNonce, _blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
+    getStarkName(address: BigNumberish, StarknetIdContract?: string): Promise<string>;
+    getAddressFromStarkName(name: string, StarknetIdContract?: string): Promise<string>;
 }
 
 declare type NetworkName = 'mainnet-alpha' | 'goerli-alpha' | 'goerli-alpha-2';
@@ -1884,6 +1886,8 @@ declare class SequencerProvider implements ProviderInterface {
     getSimulateTransaction(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
     getStateUpdate(blockIdentifier?: BlockIdentifier): Promise<StateUpdateResponse>;
     getBlockTraces(blockIdentifier?: BlockIdentifier): Promise<Sequencer.BlockTransactionTracesResponse>;
+    getStarkName(address: BigNumberish, StarknetIdContract?: string): Promise<string>;
+    getAddressFromStarkName(name: string, StarknetIdContract?: string): Promise<string>;
 }
 
 interface ProviderOptions {
@@ -1916,6 +1920,8 @@ declare class Provider implements ProviderInterface {
     waitForTransaction(txHash: BigNumberish, retryInterval?: number, successStates?: Array<Status>): Promise<GetTransactionReceiptResponse>;
     getSimulateTransaction(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
     getStateUpdate(blockIdentifier?: BlockIdentifier): Promise<StateUpdateResponse>;
+    getStarkName(address: BigNumberish, StarknetIdContract?: string): Promise<string>;
+    getAddressFromStarkName(name: string, StarknetIdContract?: string): Promise<string>;
 }
 
 declare class LibraryError extends CustomError {
@@ -2391,8 +2397,6 @@ declare class Account extends Provider implements AccountInterface {
     address: string;
     constructor(providerOrOptions: ProviderOptions | ProviderInterface, address: string, keyPairOrSigner: KeyPair | SignerInterface);
     getNonce(blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
-    getStarkName(StarknetIdContract?: string): Promise<string | Error>;
-    getAddressFromStarkName(name: string, StarknetIdContract?: string): Promise<string | Error>;
     estimateFee(calls: AllowArray<Call>, estimateFeeDetails?: EstimateFeeDetails | undefined): Promise<EstimateFee>;
     estimateInvokeFee(calls: AllowArray<Call>, { nonce: providedNonce, blockIdentifier }?: EstimateFeeDetails): Promise<EstimateFee>;
     estimateDeclareFee({ classHash, contract }: DeclareContractPayload, { blockIdentifier, nonce: providedNonce }?: EstimateFeeDetails): Promise<EstimateFee>;
@@ -2415,6 +2419,8 @@ declare class Account extends Provider implements AccountInterface {
     buildAccountDeployPayload({ classHash, addressSalt, constructorCalldata, contractAddress: providedContractAddress, }: DeployAccountContractPayload, { nonce, chainId, version, maxFee }: InvocationsSignerDetails): Promise<DeployAccountContractTransaction>;
     buildUDCContractPayload(payload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[]): Call[];
     simulateTransaction(calls: AllowArray<Call>, { nonce: providedNonce, blockIdentifier }?: EstimateFeeDetails): Promise<TransactionSimulation>;
+    getStarkName(address?: BigNumberish, // default to the wallet address
+    StarknetIdContract?: string): Promise<string>;
 }
 
 declare type CallOptions = {

package/dist/index.global.js

@@ -20720,8 +20720,149 @@ var starknet = (() => {
     }
   };
 
-  // src/provider/utils.ts
+  // src/provider/starknetId.ts
+  var import_bn3 = __toESM(require_bn());
+
+  // src/utils/starknetId.ts
   var import_bn2 = __toESM(require_bn());
+  var basicAlphabet = "abcdefghijklmnopqrstuvwxyz0123456789-";
+  var basicSizePlusOne = new import_bn2.default(basicAlphabet.length + 1);
+  var bigAlphabet = "\u8FD9\u6765";
+  var basicAlphabetSize = new import_bn2.default(basicAlphabet.length);
+  var bigAlphabetSize = new import_bn2.default(bigAlphabet.length);
+  var bigAlphabetSizePlusOne = new import_bn2.default(bigAlphabet.length + 1);
+  function extractStars(str) {
+    let k = 0;
+    while (str.endsWith(bigAlphabet[bigAlphabet.length - 1])) {
+      str = str.substring(0, str.length - 1);
+      k += 1;
+    }
+    return [str, k];
+  }
+  function useDecoded(encoded) {
+    let decoded = "";
+    encoded.forEach((subdomain) => {
+      while (!subdomain.isZero()) {
+        const code = subdomain.mod(basicSizePlusOne).toNumber();
+        subdomain = subdomain.div(basicSizePlusOne);
+        if (code === basicAlphabet.length) {
+          const nextSubdomain = subdomain.div(bigAlphabetSizePlusOne);
+          if (nextSubdomain.isZero()) {
+            const code2 = subdomain.mod(bigAlphabetSizePlusOne).toNumber();
+            subdomain = nextSubdomain;
+            if (code2 === 0)
+              decoded += basicAlphabet[0];
+            else
+              decoded += bigAlphabet[code2 - 1];
+          } else {
+            const code2 = subdomain.mod(bigAlphabetSize).toNumber();
+            decoded += bigAlphabet[code2];
+            subdomain = subdomain.div(bigAlphabetSize);
+          }
+        } else
+          decoded += basicAlphabet[code];
+      }
+      const [str, k] = extractStars(decoded);
+      if (k)
+        decoded = str + (k % 2 === 0 ? bigAlphabet[bigAlphabet.length - 1].repeat(k / 2 - 1) + bigAlphabet[0] + basicAlphabet[1] : bigAlphabet[bigAlphabet.length - 1].repeat((k - 1) / 2 + 1));
+      decoded += ".";
+    });
+    if (!decoded) {
+      return decoded;
+    }
+    return decoded.concat("stark");
+  }
+  function useEncoded(decoded) {
+    let encoded = new import_bn2.default(0);
+    let multiplier = new import_bn2.default(1);
+    if (decoded.endsWith(bigAlphabet[0] + basicAlphabet[1])) {
+      const [str, k] = extractStars(decoded.substring(0, decoded.length - 2));
+      decoded = str + bigAlphabet[bigAlphabet.length - 1].repeat(2 * (k + 1));
+    } else {
+      const [str, k] = extractStars(decoded);
+      if (k)
+        decoded = str + bigAlphabet[bigAlphabet.length - 1].repeat(1 + 2 * (k - 1));
+    }
+    for (let i = 0; i < decoded.length; i += 1) {
+      const char = decoded[i];
+      const index = basicAlphabet.indexOf(char);
+      const bnIndex = new import_bn2.default(basicAlphabet.indexOf(char));
+      if (index !== -1) {
+        if (i === decoded.length - 1 && decoded[i] === basicAlphabet[0]) {
+          encoded = encoded.add(multiplier.mul(basicAlphabetSize));
+          multiplier = multiplier.mul(basicSizePlusOne);
+          multiplier = multiplier.mul(basicSizePlusOne);
+        } else {
+          encoded = encoded.add(multiplier.mul(bnIndex));
+          multiplier = multiplier.mul(basicSizePlusOne);
+        }
+      } else if (bigAlphabet.indexOf(char) !== -1) {
+        encoded = encoded.add(multiplier.mul(basicAlphabetSize));
+        multiplier = multiplier.mul(basicSizePlusOne);
+        const newid = (i === decoded.length - 1 ? 1 : 0) + bigAlphabet.indexOf(char);
+        encoded = encoded.add(multiplier.mul(new import_bn2.default(newid)));
+        multiplier = multiplier.mul(bigAlphabetSize);
+      }
+    }
+    return encoded;
+  }
+  function getStarknetIdContract(chainId) {
+    const starknetIdMainnetContract = "0x6ac597f8116f886fa1c97a23fa4e08299975ecaf6b598873ca6792b9bbfb678";
+    const starknetIdTestnetContract = "0x05cf267a0af6101667013fc6bd3f6c11116a14cda9b8c4b1198520d59f900b17";
+    switch (chainId) {
+      case "0x534e5f4d41494e" /* MAINNET */:
+        return starknetIdMainnetContract;
+      case "0x534e5f474f45524c49" /* TESTNET */:
+        return starknetIdTestnetContract;
+      default:
+        throw new Error("Starknet.id is not yet deployed on this network");
+    }
+  }
+
+  // src/provider/starknetId.ts
+  async function getStarkName(provider, address, StarknetIdContract) {
+    const chainId = await provider.getChainId();
+    const contract = StarknetIdContract ?? getStarknetIdContract(chainId);
+    try {
+      const hexDomain = await provider.callContract({
+        contractAddress: contract,
+        entrypoint: "address_to_domain",
+        calldata: compileCalldata({
+          address: toHex(toBN(address))
+        })
+      });
+      const decimalDomain = hexDomain.result.map((element) => new import_bn3.BN(hexToDecimalString(element))).slice(1);
+      const stringDomain = useDecoded(decimalDomain);
+      if (!stringDomain) {
+        throw Error("Starkname not found");
+      }
+      return stringDomain;
+    } catch (e) {
+      if (e instanceof Error && e.message === "Starkname not found") {
+        throw e;
+      }
+      throw Error("Could not get stark name");
+    }
+  }
+  async function getAddressFromStarkName(provider, name, StarknetIdContract) {
+    const chainId = await provider.getChainId();
+    const contract = StarknetIdContract ?? getStarknetIdContract(chainId);
+    try {
+      const addressData = await provider.callContract({
+        contractAddress: contract,
+        entrypoint: "domain_to_address",
+        calldata: compileCalldata({
+          domain: [useEncoded(name.replace(".stark", "")).toString(10)]
+        })
+      });
+      return addressData.result[0];
+    } catch {
+      throw Error("Could not get address from stark name");
+    }
+  }
+
+  // src/provider/utils.ts
+  var import_bn4 = __toESM(require_bn());
   var validBlockTags = ["latest", "pending"];
   var Block = class {
     constructor(_identifier) {
@@ -20735,7 +20876,7 @@ var starknet = (() => {
     setIdentifier(__identifier) {
       if (typeof __identifier === "string" && isHex(__identifier)) {
         this.hash = __identifier;
-      } else if (import_bn2.BN.isBN(__identifier)) {
+      } else if (import_bn4.BN.isBN(__identifier)) {
         this.hash = toHex(__identifier);
       } else if (typeof __identifier === "number") {
         this.number = __identifier;
@@ -21064,6 +21205,12 @@ var starknet = (() => {
     async getSimulateTransaction(_invocation, _invocationDetails, _blockIdentifier) {
       throw new Error("RPC does not implement simulateTransaction function");
     }
+    async getStarkName(address, StarknetIdContract) {
+      return getStarkName(this, address, StarknetIdContract);
+    }
+    async getAddressFromStarkName(name, StarknetIdContract) {
+      return getAddressFromStarkName(this, name, StarknetIdContract);
+    }
   };
 
   // src/provider/sequencer.ts
@@ -21630,6 +21777,12 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
       const args = new Block(blockIdentifier).sequencerIdentifier;
       return this.fetchEndpoint("get_block_traces", { ...args });
     }
+    async getStarkName(address, StarknetIdContract) {
+      return getStarkName(this, address, StarknetIdContract);
+    }
+    async getAddressFromStarkName(name, StarknetIdContract) {
+      return getAddressFromStarkName(this, name, StarknetIdContract);
+    }
   };
 
   // src/provider/default.ts
@@ -21720,6 +21873,12 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
     async getStateUpdate(blockIdentifier) {
       return this.provider.getStateUpdate(blockIdentifier);
     }
+    async getStarkName(address, StarknetIdContract) {
+      return getStarkName(this, address, StarknetIdContract);
+    }
+    async getAddressFromStarkName(name, StarknetIdContract) {
+      return getAddressFromStarkName(this, name, StarknetIdContract);
+    }
   };
 
   // src/provider/interface.ts
@@ -21730,7 +21889,7 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
   var defaultProvider = new Provider();
 
   // src/utils/calldata.ts
-  var import_bn3 = __toESM(require_bn());
+  var import_bn5 = __toESM(require_bn());
   var import_minimalistic_assert4 = __toESM(require_minimalistic_assert());
   var CheckCallData = class {
     constructor(abi) {
@@ -21781,7 +21940,7 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
         }
         if (input.type === "felt") {
           (0, import_minimalistic_assert4.default)(
-            typeof args[argPosition] === "string" || typeof args[argPosition] === "number" || args[argPosition] instanceof import_bn3.default,
+            typeof args[argPosition] === "string" || typeof args[argPosition] === "number" || args[argPosition] instanceof import_bn5.default,
             `arg ${input.name} should be a felt (string, number, BigNumber)`
           );
           argPosition += 1;
@@ -21806,7 +21965,7 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
           if (input.type === "felt*") {
             args[argPosition].forEach((felt) => {
               (0, import_minimalistic_assert4.default)(
-                typeof felt === "string" || typeof felt === "number" || felt instanceof import_bn3.default,
+                typeof felt === "string" || typeof felt === "number" || felt instanceof import_bn5.default,
                 `arg ${input.name} should be an array of string, number or BigNumber`
               );
             });
@@ -21819,7 +21978,7 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
             );
             args[argPosition].forEach((felt) => {
               (0, import_minimalistic_assert4.default)(
-                typeof felt === "string" || typeof felt === "number" || felt instanceof import_bn3.default,
+                typeof felt === "string" || typeof felt === "number" || felt instanceof import_bn5.default,
                 `arg ${input.name} should be an array of string, number or BigNumber`
               );
             });
@@ -22220,9 +22379,6 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
     }
   };
 
-  // src/account/default.ts
-  var import_bn5 = __toESM(require_bn());
-
   // src/signer/interface.ts
   var SignerInterface = class {
   };
@@ -22598,99 +22754,6 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
     };
   }
 
-  // src/utils/starknetId.ts
-  var import_bn4 = __toESM(require_bn());
-  var basicAlphabet = "abcdefghijklmnopqrstuvwxyz0123456789-";
-  var basicSizePlusOne = new import_bn4.default(basicAlphabet.length + 1);
-  var bigAlphabet = "\u8FD9\u6765";
-  var basicAlphabetSize = new import_bn4.default(basicAlphabet.length);
-  var bigAlphabetSize = new import_bn4.default(bigAlphabet.length);
-  var bigAlphabetSizePlusOne = new import_bn4.default(bigAlphabet.length + 1);
-  function extractStars(str) {
-    let k = 0;
-    while (str.endsWith(bigAlphabet[bigAlphabet.length - 1])) {
-      str = str.substring(0, str.length - 1);
-      k += 1;
-    }
-    return [str, k];
-  }
-  function useDecoded(encoded) {
-    let decoded = "";
-    encoded.forEach((subdomain) => {
-      while (!subdomain.isZero()) {
-        const code = subdomain.mod(basicSizePlusOne).toNumber();
-        subdomain = subdomain.div(basicSizePlusOne);
-        if (code === basicAlphabet.length) {
-          const nextSubdomain = subdomain.div(bigAlphabetSizePlusOne);
-          if (nextSubdomain.isZero()) {
-            const code2 = subdomain.mod(bigAlphabetSizePlusOne).toNumber();
-            subdomain = nextSubdomain;
-            if (code2 === 0)
-              decoded += basicAlphabet[0];
-            else
-              decoded += bigAlphabet[code2 - 1];
-          } else {
-            const code2 = subdomain.mod(bigAlphabetSize).toNumber();
-            decoded += bigAlphabet[code2];
-            subdomain = subdomain.div(bigAlphabetSize);
-          }
-        } else
-          decoded += basicAlphabet[code];
-      }
-      const [str, k] = extractStars(decoded);
-      if (k)
-        decoded = str + (k % 2 === 0 ? bigAlphabet[bigAlphabet.length - 1].repeat(k / 2 - 1) + bigAlphabet[0] + basicAlphabet[1] : bigAlphabet[bigAlphabet.length - 1].repeat((k - 1) / 2 + 1));
-      decoded += ".";
-    });
-    return decoded.concat("stark");
-  }
-  function useEncoded(decoded) {
-    let encoded = new import_bn4.default(0);
-    let multiplier = new import_bn4.default(1);
-    if (decoded.endsWith(bigAlphabet[0] + basicAlphabet[1])) {
-      const [str, k] = extractStars(decoded.substring(0, decoded.length - 2));
-      decoded = str + bigAlphabet[bigAlphabet.length - 1].repeat(2 * (k + 1));
-    } else {
-      const [str, k] = extractStars(decoded);
-      if (k)
-        decoded = str + bigAlphabet[bigAlphabet.length - 1].repeat(1 + 2 * (k - 1));
-    }
-    for (let i = 0; i < decoded.length; i += 1) {
-      const char = decoded[i];
-      const index = basicAlphabet.indexOf(char);
-      const bnIndex = new import_bn4.default(basicAlphabet.indexOf(char));
-      if (index !== -1) {
-        if (i === decoded.length - 1 && decoded[i] === basicAlphabet[0]) {
-          encoded = encoded.add(multiplier.mul(basicAlphabetSize));
-          multiplier = multiplier.mul(basicSizePlusOne);
-          multiplier = multiplier.mul(basicSizePlusOne);
-        } else {
-          encoded = encoded.add(multiplier.mul(bnIndex));
-          multiplier = multiplier.mul(basicSizePlusOne);
-        }
-      } else if (bigAlphabet.indexOf(char) !== -1) {
-        encoded = encoded.add(multiplier.mul(basicAlphabetSize));
-        multiplier = multiplier.mul(basicSizePlusOne);
-        const newid = (i === decoded.length - 1 ? 1 : 0) + bigAlphabet.indexOf(char);
-        encoded = encoded.add(multiplier.mul(new import_bn4.default(newid)));
-        multiplier = multiplier.mul(bigAlphabetSize);
-      }
-    }
-    return encoded;
-  }
-  function getStarknetIdContract(chainId) {
-    const starknetIdMainnetContract = "0x6ac597f8116f886fa1c97a23fa4e08299975ecaf6b598873ca6792b9bbfb678";
-    const starknetIdTestnetContract = "0x05cf267a0af6101667013fc6bd3f6c11116a14cda9b8c4b1198520d59f900b17";
-    switch (chainId) {
-      case "0x534e5f4d41494e" /* MAINNET */:
-        return starknetIdMainnetContract;
-      case "0x534e5f474f45524c49" /* TESTNET */:
-        return starknetIdTestnetContract;
-      default:
-        throw new Error("Starknet.id is not yet deployed on this network");
-    }
-  }
-
   // src/account/default.ts
   var Account = class extends Provider {
     constructor(providerOrOptions, address, keyPairOrSigner) {
@@ -22701,40 +22764,6 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
     async getNonce(blockIdentifier) {
       return super.getNonceForAddress(this.address, blockIdentifier);
     }
-    async getStarkName(StarknetIdContract) {
-      const chainId = await this.getChainId();
-      const contract = StarknetIdContract ?? getStarknetIdContract(chainId);
-      try {
-        const hexDomain = await this.callContract({
-          contractAddress: contract,
-          entrypoint: "address_to_domain",
-          calldata: compileCalldata({
-            address: this.address
-          })
-        });
-        const decimalDomain = hexDomain.result.map((element) => new import_bn5.BN(hexToDecimalString(element))).slice(1);
-        const stringDomain = useDecoded(decimalDomain);
-        return stringDomain;
-      } catch {
-        return Error("Could not get stark name");
-      }
-    }
-    async getAddressFromStarkName(name, StarknetIdContract) {
-      const chainId = await this.getChainId();
-      const contract = StarknetIdContract ?? getStarknetIdContract(chainId);
-      try {
-        const addressData = await this.callContract({
-          contractAddress: contract,
-          entrypoint: "domain_to_address",
-          calldata: compileCalldata({
-            domain: [useEncoded(name.replace(".stark", "")).toString(10)]
-          })
-        });
-        return addressData.result[0];
-      } catch {
-        return Error("Could not get address from stark name");
-      }
-    }
     async estimateFee(calls, estimateFeeDetails) {
       return this.estimateInvokeFee(calls, estimateFeeDetails);
     }
@@ -23163,6 +23192,9 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
         }
       };
     }
+    async getStarkName(address = this.address, StarknetIdContract) {
+      return super.getStarkName(address, StarknetIdContract);
+    }
   };
 
   // src/account/interface.ts