starknet 5.24.3 → 5.24.5

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [5.24.5](https://github.com/starknet-io/starknet.js/compare/v5.24.4...v5.24.5) (2023-12-10)
+
+### Bug Fixes
+
+- apply bound for contract address from hash calculation ([6d8c291](https://github.com/starknet-io/starknet.js/commit/6d8c291bce130d7b00ae6d81aff071c4986f04af))
+- **Calldata.compile:** do not split long `entrypoint` names before calling `getSelectorFromName` ([89715da](https://github.com/starknet-io/starknet.js/commit/89715da3fdb4b497cc5771eb83a88460007740b6))
+- prioritize error states in waitForTransaction evaluation ([ac54404](https://github.com/starknet-io/starknet.js/commit/ac544045e2079b68042d850a09b203fc5536c0d0))
+
+## [5.24.4](https://github.com/starknet-io/starknet.js/compare/v5.24.3...v5.24.4) (2023-12-06)
+
+### Bug Fixes
+
+- typos ([#862](https://github.com/starknet-io/starknet.js/issues/862)) ([b2431d3](https://github.com/starknet-io/starknet.js/commit/b2431d36d636821b32403ef0aa4def2312b10254))
+
 ## [5.24.3](https://github.com/starknet-io/starknet.js/compare/v5.24.2...v5.24.3) (2023-11-20)
 
 ### Bug Fixes

package/README.md

@@ -64,6 +64,8 @@ If you consider to contribute to this project please read [CONTRIBUTING.md](http
 
 Special thanks to all the [contributors](https://github.com/starknet-io/starknet.js/graphs/contributors), especially to:
 
+- Sean ([@0xs34n](https://github.com/0xs34n)), the original creator of Straknet.js!
+
 - Janek ([@janek26](https://github.com/janek26)) and Dhruv ([@dhruvkelawala](https://github.com/dhruvkelawala)) from [Argent](https://github.com/argentlabs)
 
 - Toni ([@tabaktoni](https://github.com/tabaktoni)) and Ivan ([@ivpavici](https://github.com/ivpavici)) from [SpaceShard](https://www.spaceshard.io/)

package/dist/index.d.ts

@@ -128,8 +128,9 @@ declare const BN_FEE_TRANSACTION_VERSION_1: bigint;
 declare const BN_FEE_TRANSACTION_VERSION_2: bigint;
 declare const ZERO = 0n;
 declare const MASK_250: bigint;
-declare const MASK_251: bigint;
 declare const API_VERSION = 0n;
+declare const MAX_STORAGE_ITEM_SIZE = 256n;
+declare const ADDR_BOUND: bigint;
 declare enum BaseUrl {
     SN_MAIN = "https://alpha-mainnet.starknet.io",
     SN_GOERLI = "https://alpha4.starknet.io"
@@ -156,6 +157,7 @@ declare const UDC: {
 declare const RPC_GOERLI_NODES: string[];
 declare const RPC_MAINNET_NODES: string[];
 
+declare const constants_ADDR_BOUND: typeof ADDR_BOUND;
 declare const constants_API_VERSION: typeof API_VERSION;
 declare const constants_BN_FEE_TRANSACTION_VERSION_1: typeof BN_FEE_TRANSACTION_VERSION_1;
 declare const constants_BN_FEE_TRANSACTION_VERSION_2: typeof BN_FEE_TRANSACTION_VERSION_2;
@@ -167,7 +169,7 @@ declare const constants_HEX_STR_TRANSACTION_VERSION_1: typeof HEX_STR_TRANSACTIO
 declare const constants_HEX_STR_TRANSACTION_VERSION_2: typeof HEX_STR_TRANSACTION_VERSION_2;
 declare const constants_IS_BROWSER: typeof IS_BROWSER;
 declare const constants_MASK_250: typeof MASK_250;
-declare const constants_MASK_251: typeof MASK_251;
+declare const constants_MAX_STORAGE_ITEM_SIZE: typeof MAX_STORAGE_ITEM_SIZE;
 type constants_NetworkName = NetworkName;
 declare const constants_NetworkName: typeof NetworkName;
 declare const constants_RPC_GOERLI_NODES: typeof RPC_GOERLI_NODES;
@@ -181,6 +183,7 @@ declare const constants_UDC: typeof UDC;
 declare const constants_ZERO: typeof ZERO;
 declare namespace constants {
   export {
+    constants_ADDR_BOUND as ADDR_BOUND,
     constants_API_VERSION as API_VERSION,
     constants_BN_FEE_TRANSACTION_VERSION_1 as BN_FEE_TRANSACTION_VERSION_1,
     constants_BN_FEE_TRANSACTION_VERSION_2 as BN_FEE_TRANSACTION_VERSION_2,
@@ -191,7 +194,7 @@ declare namespace constants {
     constants_HEX_STR_TRANSACTION_VERSION_2 as HEX_STR_TRANSACTION_VERSION_2,
     constants_IS_BROWSER as IS_BROWSER,
     constants_MASK_250 as MASK_250,
-    constants_MASK_251 as MASK_251,
+    constants_MAX_STORAGE_ITEM_SIZE as MAX_STORAGE_ITEM_SIZE,
     constants_NetworkName as NetworkName,
     constants_RPC_GOERLI_NODES as RPC_GOERLI_NODES,
     constants_RPC_MAINNET_NODES as RPC_MAINNET_NODES,
@@ -3802,56 +3805,59 @@ declare abstract class SignerInterface {
     /**
      * Method to get the public key of the signer
      *
-     * @returns public key of signer as hex string with 0x prefix
+     * @returns format: hex-string
      */
     abstract getPubKey(): Promise<string>;
     /**
-     * Sign an JSON object for off-chain usage with the starknet private key and return the signature
-     * This adds a message prefix so it cant be interchanged with transactions
+     * Signs a JSON object for off-chain usage with the Starknet private key and returns the signature
+     * This adds a message prefix so it can't be interchanged with transactions
      *
      * @param typedData - JSON object to be signed
-     * @param accountAddress - account
-     * @returns the signature of the JSON object
-     * @throws {Error} if the JSON object is not a valid JSON
+     * @param accountAddress
      */
     abstract signMessage(typedData: TypedData, accountAddress: string): Promise<Signature>;
     /**
-     * Signs a transaction with the starknet private key and returns the signature
-     *
-     * @param invocation the invocation object containing:
-     * - contractAddress - the address of the contract
-     * - entrypoint - the entrypoint of the contract
-     * - calldata - (defaults to []) the calldata
-     * @param abi (optional) the abi of the contract for better displaying
+     * Signs transactions with the Starknet private key and returns the signature
      *
-     * @returns signature
+     * @param transactions - Array of Call objects, each including:<br/>
+     *  - contractAddress<br/>
+     *  - entrypoint<br/>
+     *  - calldata<br/>
+     * @param transactionsDetail - InvocationsSignerDetails object with:<br/>
+     *  - walletAddress<br/>
+     *  - chainId<br/>
+     *  - cairoVersion<br/>
+     *  - maxFee<br/>
+     *  - version<br/>
+     *  - nonce<br/>
+     * @param abis - (optional) An array of Abi objects for displaying decoded data
      */
     abstract signTransaction(transactions: Call[], transactionsDetail: InvocationsSignerDetails, abis?: Abi[]): Promise<Signature>;
     /**
-     * Signs a DEPLOY_ACCOUNT transaction with the starknet private key and returns the signature
+     * Signs a DEPLOY_ACCOUNT transaction with the Starknet private key and returns the signature
      *
-     * @param transaction
-     * - contractAddress - the computed address of the contract
-     * - constructorCalldata - calldata to be passed in deploy constructor
-     * - addressSalt - contract address salt
-     * - chainId - the chainId to declare contract on
-     * - maxFee - maxFee for the declare transaction
-     * - version - transaction version
-     * - nonce - Nonce of the declare transaction
-     * @returns signature
+     * @param transaction<br/>
+     * - contractAddress<br/>
+     * - chainId<br/>
+     * - classHash<br/>
+     * - constructorCalldata<br/>
+     * - addressSalt<br/>
+     * - maxFee<br/>
+     * - version<br/>
+     * - nonce<br/>
      */
     abstract signDeployAccountTransaction(transaction: DeployAccountSignerDetails): Promise<Signature>;
     /**
-     * Signs a DECLARE transaction with the starknet private key and returns the signature
+     * Signs a DECLARE transaction with the Starknet private key and returns the signature
      *
-     * @param transaction
-     * - classHash - computed class hash. Will be replaced by ContractClass in future once class hash is present in CompiledContract
-     * - senderAddress - the address of the sender
-     * - chainId - the chainId to declare contract on
-     * - maxFee - maxFee for the declare transaction
-     * - version - transaction version
-     * - nonce - Nonce of the declare transaction
-     * @returns signature
+     * @param transaction<br/>
+     * - classHash<br/>
+     * - compiledClassHash? - used for Cairo1<br/>
+     * - senderAddress<br/>
+     * - chainId<br/>
+     * - maxFee<br/>
+     * - version<br/>
+     * - nonce<br/>
      */
     abstract signDeclareTransaction(transaction: DeclareSignerDetails): Promise<Signature>;
 }

package/dist/index.global.js

@@ -720,6 +720,7 @@ var starknet = (() => {
   // src/constants.ts
   var constants_exports = {};
   __export(constants_exports, {
+    ADDR_BOUND: () => ADDR_BOUND,
     API_VERSION: () => API_VERSION,
     BN_FEE_TRANSACTION_VERSION_1: () => BN_FEE_TRANSACTION_VERSION_1,
     BN_FEE_TRANSACTION_VERSION_2: () => BN_FEE_TRANSACTION_VERSION_2,
@@ -730,7 +731,7 @@ var starknet = (() => {
     HEX_STR_TRANSACTION_VERSION_2: () => HEX_STR_TRANSACTION_VERSION_2,
     IS_BROWSER: () => IS_BROWSER,
     MASK_250: () => MASK_250,
-    MASK_251: () => MASK_251,
+    MAX_STORAGE_ITEM_SIZE: () => MAX_STORAGE_ITEM_SIZE,
     NetworkName: () => NetworkName,
     RPC_GOERLI_NODES: () => RPC_GOERLI_NODES,
     RPC_MAINNET_NODES: () => RPC_MAINNET_NODES,
@@ -996,8 +997,9 @@ var starknet = (() => {
   var BN_FEE_TRANSACTION_VERSION_2 = 2n ** 128n + BN_TRANSACTION_VERSION_2;
   var ZERO = 0n;
   var MASK_250 = 2n ** 250n - 1n;
-  var MASK_251 = 2n ** 251n;
   var API_VERSION = ZERO;
+  var MAX_STORAGE_ITEM_SIZE = 256n;
+  var ADDR_BOUND = 2n ** 251n - MAX_STORAGE_ITEM_SIZE;
   var BaseUrl = /* @__PURE__ */ ((BaseUrl2) => {
     BaseUrl2["SN_MAIN"] = "https://alpha-mainnet.starknet.io";
     BaseUrl2["SN_GOERLI"] = "https://alpha4.starknet.io";
@@ -4939,7 +4941,7 @@ var starknet = (() => {
     if (input.type === "core::starknet::eth_address::EthAddress") {
       assert(
         typeof parameter !== "object",
-        `EthAdress type is waiting a BigNumberish. Got ${parameter}`
+        `EthAddress type is waiting a BigNumberish. Got ${parameter}`
       );
       const param = BigInt(parameter.toString(10));
       assert(
@@ -5156,10 +5158,10 @@ var starknet = (() => {
           const oe = Array.isArray(o) ? [o.length.toString(), ...o] : o;
           return Object.entries(oe).flatMap(([k, v]) => {
             let value = v;
-            if (isLongText(value))
-              value = splitLongString(value);
             if (k === "entrypoint")
               value = getSelectorFromName(value);
+            else if (isLongText(value))
+              value = splitLongString(value);
             const kk = Array.isArray(oe) && k === "0" ? "$$len" : k;
             if (isBigInt(value))
               return [[`${prefix}${kk}`, felt(value)]];
@@ -6084,13 +6086,14 @@ var starknet = (() => {
     const compiledCalldata = CallData.compile(constructorCalldata);
     const constructorCalldataHash = computeHashOnElements2(compiledCalldata);
     const CONTRACT_ADDRESS_PREFIX = felt("0x535441524b4e45545f434f4e54524143545f41444452455353");
-    return computeHashOnElements2([
+    const hash2 = computeHashOnElements2([
       CONTRACT_ADDRESS_PREFIX,
       deployerAddress,
       salt,
       classHash,
       constructorCalldataHash
     ]);
+    return toHex(BigInt(hash2) % ADDR_BOUND);
   }
   function nullSkipReplacer(key, value) {
     if (key === "attributes" || key === "accessible_scopes") {
@@ -11022,8 +11025,10 @@ var starknet = (() => {
       let isErrorState = false;
       const retryInterval = options?.retryInterval ?? 5e3;
       const errorStates = options?.errorStates ?? [
-        rpc_exports.ETransactionStatus.REJECTED,
-        rpc_exports.ETransactionExecutionStatus.REVERTED
+        rpc_exports.ETransactionStatus.REJECTED
+        // TODO: commented out to preserve the long-standing behavior of "reverted" not being treated as an error by default
+        // should decide which behavior to keep in the future
+        // RPC.ETransactionExecutionStatus.REVERTED,
       ];
       const successStates = options?.successStates ?? [
         rpc_exports.ETransactionExecutionStatus.SUCCEEDED,
@@ -11041,14 +11046,14 @@ var starknet = (() => {
             const error = new Error("waiting for transaction status");
             throw error;
           }
-          if (successStates.includes(executionStatus) || successStates.includes(finalityStatus)) {
-            onchain = true;
-          } else if (errorStates.includes(executionStatus) || errorStates.includes(finalityStatus)) {
+          if (errorStates.includes(executionStatus) || errorStates.includes(finalityStatus)) {
             const message = `${executionStatus}: ${finalityStatus}`;
             const error = new Error(message);
             error.response = txStatus;
             isErrorState = true;
             throw error;
+          } else if (successStates.includes(executionStatus) || successStates.includes(finalityStatus)) {
+            onchain = true;
           }
         } catch (error) {
           if (error instanceof Error && isErrorState) {
@@ -13402,7 +13407,7 @@ ${res.tx_failure_reason.error_message}`;
     return addHexPrefix(removeHexPrefix(toHex(address)).padStart(64, "0"));
   }
   function validateAndParseAddress(address) {
-    assertInRange(address, ZERO, MASK_251, "Starknet Address");
+    assertInRange(address, ZERO, ADDR_BOUND - 1n, "Starknet Address");
     const result = addAddressPadding(address);
     if (!result.match(/^(0x)?[0-9a-fA-F]{64}$/)) {
       throw new Error("Invalid Address Format");