starknet 5.13.0 → 5.13.2

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [5.13.2](https://github.com/0xs34n/starknet.js/compare/v5.13.1...v5.13.2) (2023-06-16)
+
+### Bug Fixes
+
+- rpc storage key & added simple storage test ([6c66202](https://github.com/0xs34n/starknet.js/commit/6c66202a966003509460dedf91e98177f7f4af27))
+
+## [5.13.1](https://github.com/0xs34n/starknet.js/compare/v5.13.0...v5.13.1) (2023-06-14)
+
+### Bug Fixes
+
+- common abi type for ContractClassResponse ([55a8d98](https://github.com/0xs34n/starknet.js/commit/55a8d981be4ee4d861c7a3f988c012801af3d905))
+
 # [5.13.0](https://github.com/0xs34n/starknet.js/compare/v5.12.0...v5.13.0) (2023-06-12)
 
 ### Bug Fixes

package/dist/index.d.ts

@@ -237,7 +237,7 @@ type CompiledSierra = {
  * format produced after compressing 'sierra_program', stringifies 'abi' property and omit sierra_program_debug_info
  * CompressedCompiledSierra
  */
-type SierraContractClass = Omit<CompiledSierra, 'sierra_program' | 'abi' | 'sierra_program_debug_info'> & {
+type SierraContractClass = Omit<CompiledSierra, 'abi' | 'sierra_program_debug_info'> & {
     sierra_program: string;
     abi: string;
 };
@@ -1161,7 +1161,6 @@ declare namespace RPC {
     type Traces = OPENRPC.Traces;
     type BlockHash = OPENRPC.BlockHash;
     type BlockHashAndNumber = OPENRPC.BlockHashAndNumber;
-    type GetClassResponse = OPENRPC.ContractClass;
     type EstimateFeeResponse = OPENRPC.EstimatedFee;
     type GetBlockWithTxHashesResponse = OPENRPC.BlockWithTxHashes;
     type GetBlockWithTxs = OPENRPC.BlockWithTxs;
@@ -1739,6 +1738,9 @@ interface StateUpdateResponse {
         deprecated_declared_classes?: RPC.DeprecatedDeclaredClasses;
     };
 }
+type ContractClassResponse = Omit<ContractClass, 'abi'> & {
+    abi?: Abi;
+};
 
 interface EstimateFee extends EstimateFeeResponse {
     suggestedMaxFee: bigint;
@@ -1907,6 +1909,7 @@ type index_CompiledSierraCasm = CompiledSierraCasm;
 type index_CompleteDeclareContractPayload = CompleteDeclareContractPayload;
 type index_CompressedProgram = CompressedProgram;
 type index_ContractClass = ContractClass;
+type index_ContractClassResponse = ContractClassResponse;
 type index_ContractEntryPoint = ContractEntryPoint;
 type index_ContractEntryPointFields = ContractEntryPointFields;
 type index_ContractFunction = ContractFunction;
@@ -2048,6 +2051,7 @@ declare namespace index {
     index_CompleteDeclareContractPayload as CompleteDeclareContractPayload,
     index_CompressedProgram as CompressedProgram,
     index_ContractClass as ContractClass,
+    index_ContractClassResponse as ContractClassResponse,
     index_ContractEntryPoint as ContractEntryPoint,
     index_ContractEntryPointFields as ContractEntryPointFields,
     index_ContractFunction as ContractFunction,
@@ -2183,7 +2187,7 @@ declare abstract class ProviderInterface {
      * @param blockIdentifier - block identifier
      * @returns Contract class of compiled contract
      */
-    abstract getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClass | RPC.ContractClass>;
+    abstract getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClassResponse>;
     /**
      * Returns the class hash deployed under the given address.
      *
@@ -2198,7 +2202,7 @@ declare abstract class ProviderInterface {
      * @param classHash - class hash
      * @returns Contract class of compiled contract
      */
-    abstract getClassByHash(classHash: string): Promise<ContractClass | RPC.ContractClass>;
+    abstract getClassByHash(classHash: string): Promise<ContractClassResponse>;
     /**
      * Gets the nonce of a contract with respect to a specific block
      *
@@ -2378,9 +2382,9 @@ declare class Provider implements ProviderInterface {
     constructor(providerOrOptions?: ProviderOptions | ProviderInterface);
     getChainId(): Promise<StarknetChainId>;
     getBlock(blockIdentifier: BlockIdentifier): Promise<GetBlockResponse>;
-    getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClass | RPC.ContractClass>;
+    getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClassResponse>;
     getClassHashAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<string>;
-    getClassByHash(classHash: string): Promise<ContractClass | RPC.ContractClass>;
+    getClassByHash(classHash: string): Promise<ContractClassResponse>;
     getEstimateFee(invocationWithTxType: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier: BlockIdentifier): Promise<EstimateFeeResponse>;
     getInvokeEstimateFee(invocationWithTxType: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier, skipValidate?: boolean): Promise<EstimateFeeResponse>;
     getEstimateFeeBulk(invocations: AccountInvocations, options: getEstimateFeeBulkOptions): Promise<EstimateFeeResponseBulk>;
@@ -2447,9 +2451,9 @@ declare class SequencerProvider implements ProviderInterface {
     getStorageAt(contractAddress: string, key: BigNumberish, blockIdentifier?: BlockIdentifier): Promise<Sequencer.Storage>;
     getTransaction(txHash: BigNumberish): Promise<GetTransactionResponse>;
     getTransactionReceipt(txHash: BigNumberish): Promise<GetTransactionReceiptResponse>;
-    getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClass>;
+    getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClassResponse>;
     getClassHashAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<string>;
-    getClassByHash(classHash: string, blockIdentifier?: BlockIdentifier): Promise<ContractClass>;
+    getClassByHash(classHash: string, blockIdentifier?: BlockIdentifier): Promise<ContractClassResponse>;
     getCompiledClassByClassHash(classHash: string, blockIdentifier?: BlockIdentifier): Promise<CairoAssembly>;
     invokeFunction(functionInvocation: Invocation, details: InvocationsDetailsWithNonce): Promise<InvokeFunctionResponse>;
     deployAccountContract({ classHash, constructorCalldata, addressSalt, signature }: DeployAccountContractTransaction, details: InvocationsDetailsWithNonce): Promise<DeployContractResponse>;
@@ -2528,9 +2532,9 @@ declare class RpcProvider implements ProviderInterface {
     getTransactionByHash(txHash: string): Promise<RPC.GetTransactionByHashResponse>;
     getTransactionByBlockIdAndIndex(blockIdentifier: BlockIdentifier, index: number): Promise<RPC.GetTransactionByBlockIdAndIndex>;
     getTransactionReceipt(txHash: string): Promise<RPC.TransactionReceipt>;
-    getClassByHash(classHash: RPC.Felt): Promise<RPC.ContractClass>;
-    getClass(classHash: RPC.Felt, blockIdentifier?: BlockIdentifier): Promise<RPC.ContractClass>;
-    getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<RPC.ContractClass>;
+    getClassByHash(classHash: RPC.Felt): Promise<ContractClassResponse>;
+    getClass(classHash: RPC.Felt, blockIdentifier?: BlockIdentifier): Promise<ContractClassResponse>;
+    getClassAt(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<ContractClassResponse>;
     getCode(_contractAddress: string, _blockIdentifier?: BlockIdentifier): Promise<GetCodeResponse>;
     getEstimateFee(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
     getInvokeEstimateFee(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
@@ -3230,6 +3234,14 @@ declare function isHex(hex: string): boolean;
 declare function toBigInt(value: BigNumberish): bigint;
 declare function isBigInt(value: any): value is bigint;
 declare function toHex(number: BigNumberish): string;
+/**
+ * Convert BigNumberish to STORAGE_KEY
+ * Same as toHex but conforming pattern STORAGE_KEY pattern ^0x0[0-7]{1}[a-fA-F0-9]{0,62}$
+ * A storage key. Represented as up to 62 hex digits, 3 bits, and 5 leading zeroes.
+ * 0x0 + [0-7] + 62 hex = 0x + 64 hex
+ * @param number BigNumberish
+ */
+declare function toStorageKey(number: BigNumberish): string;
 declare function hexToDecimalString(hex: string): string;
 /**
  * Remove hex string leading zero and lower case '0x01A'.. -> '0x1a..'
@@ -3269,6 +3281,7 @@ declare const num_toBigInt: typeof toBigInt;
 declare const num_toCairoBool: typeof toCairoBool;
 declare const num_toHex: typeof toHex;
 declare const num_toHexString: typeof toHexString;
+declare const num_toStorageKey: typeof toStorageKey;
 declare namespace num {
   export {
     num_BigNumberish as BigNumberish,
@@ -3288,6 +3301,7 @@ declare namespace num {
     num_toCairoBool as toCairoBool,
     num_toHex as toHex,
     num_toHexString as toHexString,
+    num_toStorageKey as toStorageKey,
   };
 }
 
@@ -3787,4 +3801,4 @@ declare class CallData {
 /** @deprecated prefer the 'num' naming */
 declare const number: typeof num;
 
-export { Abi, AbiEntry, AbiStructs, Account, AccountInterface, AccountInvocationItem, AccountInvocations, AccountInvocationsFactoryDetails, AllowArray, Args, ArgsOrCalldata, ArgsOrCalldataWithOptions, ArraySignatureType, AsyncContractFunction, BigNumberish, BlockIdentifier, BlockNumber, BlockTag, Builtins, ByteCode, CairoAssembly, CairoContract, CairoVersion, Call, CallContractResponse, CallData, CallDetails, CallL1Handler, CallOptions, CallStruct, Calldata, CommonTransactionReceiptResponse, CommonTransactionResponse, CompiledContract, CompiledSierra, CompiledSierraCasm, CompleteDeclareContractPayload, CompressedProgram, Contract, ContractClass, ContractEntryPoint, ContractEntryPointFields, ContractFactory, ContractFunction, ContractInterface, ContractOptions, CustomError, DeclareAndDeployContractPayload, DeclareContractPayload, DeclareContractResponse, DeclareContractTransaction, DeclareDeployUDCResponse, DeclareSignerDetails, DeclareTransactionReceiptResponse, DeclareTransactionResponse, DeployAccountContractPayload, DeployAccountContractTransaction, DeployAccountSignerDetails, DeployContractPayload, DeployContractResponse, DeployContractUDCResponse, DeployedContractItem, Details, EntryPointType, EntryPointsByType, EstimateFee, EstimateFeeAction, EstimateFeeBulk, EstimateFeeDetails, EstimateFeeResponse, EstimateFeeResponseBulk, Event, ExecutionResources, FunctionAbi, FunctionInvocation, GatewayError, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionReceiptResponse, GetTransactionResponse, GetTransactionStatusResponse, HexCalldata, HttpError, Invocation, Invocations, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeOptions, InvokeTransactionReceiptResponse, InvokeTransactionResponse, LegacyCompiledContract, LegacyContractClass, LibraryError, MessageToL1, MessageToL2, MultiDeployContractResponse, MultiType, Nonce, OptionalPayload, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, PythonicHints, RPC, RawArgs, RawArgsArray, RawArgsObject, RawCalldata, Result, RpcProvider, RpcProviderOptions, SIMULATION_FLAG, Sequencer, SequencerHttpMethod, SequencerIdentifier, SequencerProvider, SequencerProviderOptions, SierraContractClass, SierraContractEntryPointFields, SierraEntryPointsByType, SierraProgramDebugInfo, Signature, Signer, SignerInterface, SimulateTransactionDetails, SimulateTransactionResponse, SimulatedTransaction, SimulationFlags, StarkNetDomain, StarkNetMerkleType, StarkNetType, StateUpdateResponse, Status, Storage, Struct, StructAbi, TransactionStatus, TransactionType, Tupled, TypedData, Uint256, UniversalDeployerContractPayload, WeierstrassSignatureType, addAddressPadding, buildUrl, cairo, constants, defaultProvider, ec, encode, fixProto, fixStack, getCalldata, getChecksumAddress, getEstimateFeeBulkOptions, getSimulateTransactionOptions, hash, isUrl, json, merkle, num, number, shortString, splitArgsAndOptions, stark, starknetId, transaction, typedData, index as types, uint256$1 as uint256, validateAndParseAddress, validateChecksumAddress, waitForTransactionOptions };
+export { Abi, AbiEntry, AbiStructs, Account, AccountInterface, AccountInvocationItem, AccountInvocations, AccountInvocationsFactoryDetails, AllowArray, Args, ArgsOrCalldata, ArgsOrCalldataWithOptions, ArraySignatureType, AsyncContractFunction, BigNumberish, BlockIdentifier, BlockNumber, BlockTag, Builtins, ByteCode, CairoAssembly, CairoContract, CairoVersion, Call, CallContractResponse, CallData, CallDetails, CallL1Handler, CallOptions, CallStruct, Calldata, CommonTransactionReceiptResponse, CommonTransactionResponse, CompiledContract, CompiledSierra, CompiledSierraCasm, CompleteDeclareContractPayload, CompressedProgram, Contract, ContractClass, ContractClassResponse, ContractEntryPoint, ContractEntryPointFields, ContractFactory, ContractFunction, ContractInterface, ContractOptions, CustomError, DeclareAndDeployContractPayload, DeclareContractPayload, DeclareContractResponse, DeclareContractTransaction, DeclareDeployUDCResponse, DeclareSignerDetails, DeclareTransactionReceiptResponse, DeclareTransactionResponse, DeployAccountContractPayload, DeployAccountContractTransaction, DeployAccountSignerDetails, DeployContractPayload, DeployContractResponse, DeployContractUDCResponse, DeployedContractItem, Details, EntryPointType, EntryPointsByType, EstimateFee, EstimateFeeAction, EstimateFeeBulk, EstimateFeeDetails, EstimateFeeResponse, EstimateFeeResponseBulk, Event, ExecutionResources, FunctionAbi, FunctionInvocation, GatewayError, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionReceiptResponse, GetTransactionResponse, GetTransactionStatusResponse, HexCalldata, HttpError, Invocation, Invocations, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeOptions, InvokeTransactionReceiptResponse, InvokeTransactionResponse, LegacyCompiledContract, LegacyContractClass, LibraryError, MessageToL1, MessageToL2, MultiDeployContractResponse, MultiType, Nonce, OptionalPayload, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, PythonicHints, RPC, RawArgs, RawArgsArray, RawArgsObject, RawCalldata, Result, RpcProvider, RpcProviderOptions, SIMULATION_FLAG, Sequencer, SequencerHttpMethod, SequencerIdentifier, SequencerProvider, SequencerProviderOptions, SierraContractClass, SierraContractEntryPointFields, SierraEntryPointsByType, SierraProgramDebugInfo, Signature, Signer, SignerInterface, SimulateTransactionDetails, SimulateTransactionResponse, SimulatedTransaction, SimulationFlags, StarkNetDomain, StarkNetMerkleType, StarkNetType, StateUpdateResponse, Status, Storage, Struct, StructAbi, TransactionStatus, TransactionType, Tupled, TypedData, Uint256, UniversalDeployerContractPayload, WeierstrassSignatureType, addAddressPadding, buildUrl, cairo, constants, defaultProvider, ec, encode, fixProto, fixStack, getCalldata, getChecksumAddress, getEstimateFeeBulkOptions, getSimulateTransactionOptions, hash, isUrl, json, merkle, num, number, shortString, splitArgsAndOptions, stark, starknetId, transaction, typedData, index as types, uint256$1 as uint256, validateAndParseAddress, validateChecksumAddress, waitForTransactionOptions };

package/dist/index.global.js

@@ -2906,7 +2906,8 @@ var starknet = (() => {
     toBigInt: () => toBigInt,
     toCairoBool: () => toCairoBool,
     toHex: () => toHex,
-    toHexString: () => toHexString
+    toHexString: () => toHexString,
+    toStorageKey: () => toStorageKey
   });
 
   // node_modules/@noble/curves/esm/abstract/utils.js
@@ -3126,6 +3127,10 @@ var starknet = (() => {
   function toHex(number3) {
     return addHexPrefix(toBigInt(number3).toString(16));
   }
+  function toStorageKey(number3) {
+    const res = addHexPrefix(toBigInt(number3).toString(16).padStart(64, "0"));
+    return res;
+  }
   function hexToDecimalString(hex) {
     return BigInt(addHexPrefix(hex)).toString(10);
   }
@@ -7269,18 +7274,18 @@ var starknet = (() => {
   }
   function formatSpaces(json) {
     let insideQuotes = false;
-    let newString = "";
+    const newString = [];
     for (const char of json) {
-      if (char === '"' && newString.endsWith("\\") === false) {
+      if (char === '"' && (newString.length > 0 && newString.slice(-1)[0] === "\\") === false) {
         insideQuotes = !insideQuotes;
       }
       if (insideQuotes) {
-        newString += char;
+        newString.push(char);
       } else {
-        newString += char === ":" ? ": " : char === "," ? ", " : char;
+        newString.push(char === ":" ? ": " : char === "," ? ", " : char);
       }
     }
-    return newString;
+    return newString.join("");
   }
   function computeHintedClassHash(compiledContract) {
     const { abi, program } = compiledContract;
@@ -11707,6 +11712,12 @@ var starknet = (() => {
         };
       });
     }
+    parseContractClassResponse(res) {
+      return {
+        ...res,
+        abi: typeof res.abi === "string" ? JSON.parse(res.abi) : res.abi
+      };
+    }
   };
 
   // src/provider/errors.ts
@@ -12032,7 +12043,7 @@ var starknet = (() => {
       return this.fetchEndpoint("starknet_getStateUpdate", { block_id });
     }
     async getStorageAt(contractAddress, key, blockIdentifier = this.blockIdentifier) {
-      const parsedKey = toHex(key);
+      const parsedKey = toStorageKey(key);
       const block_id = new Block(blockIdentifier).identifier;
       return this.fetchEndpoint("starknet_getStorageAt", {
         contract_address: contractAddress,
@@ -12059,14 +12070,17 @@ var starknet = (() => {
     }
     async getClass(classHash, blockIdentifier = this.blockIdentifier) {
       const block_id = new Block(blockIdentifier).identifier;
-      return this.fetchEndpoint("starknet_getClass", { class_hash: classHash, block_id });
+      return this.fetchEndpoint("starknet_getClass", {
+        class_hash: classHash,
+        block_id
+      }).then(this.responseParser.parseContractClassResponse);
     }
     async getClassAt(contractAddress, blockIdentifier = this.blockIdentifier) {
       const block_id = new Block(blockIdentifier).identifier;
       return this.fetchEndpoint("starknet_getClassAt", {
         block_id,
         contract_address: contractAddress
-      });
+      }).then(this.responseParser.parseContractClassResponse);
     }
     async getCode(_contractAddress, _blockIdentifier) {
       throw new Error("RPC does not implement getCode function");
@@ -12512,11 +12526,11 @@ var starknet = (() => {
         }
       };
     }
-    // TODO: Define response as new type as it diff from ContractClass
-    parseSierraContractClassResponse(res) {
+    parseContractClassResponse(res) {
+      const response = isSierra(res) ? res : parseContract(res);
       return {
-        ...res,
-        abi: JSON.parse(res.abi)
+        ...response,
+        abi: typeof response.abi === "string" ? JSON.parse(response.abi) : response.abi
       };
     }
   };
@@ -12731,24 +12745,16 @@ var starknet = (() => {
     }
     async getClassAt(contractAddress, blockIdentifier = this.blockIdentifier) {
       return this.fetchEndpoint("get_full_contract", { blockIdentifier, contractAddress }).then(
-        (res) => {
-          if (isSierra(res)) {
-            return this.responseParser.parseSierraContractClassResponse(res);
-          }
-          return parseContract(res);
-        }
+        this.responseParser.parseContractClassResponse
       );
     }
     async getClassHashAt(contractAddress, blockIdentifier = this.blockIdentifier) {
       return this.fetchEndpoint("get_class_hash_at", { blockIdentifier, contractAddress });
     }
     async getClassByHash(classHash, blockIdentifier = this.blockIdentifier) {
-      return this.fetchEndpoint("get_class_by_hash", { classHash, blockIdentifier }).then((res) => {
-        if (isSierra(res)) {
-          return this.responseParser.parseSierraContractClassResponse(res);
-        }
-        return parseContract(res);
-      });
+      return this.fetchEndpoint("get_class_by_hash", { classHash, blockIdentifier }).then(
+        this.responseParser.parseContractClassResponse
+      );
     }
     async getCompiledClassByClassHash(classHash, blockIdentifier = this.blockIdentifier) {
       return this.fetchEndpoint("get_compiled_class_by_class_hash", { classHash, blockIdentifier });