starknet 4.19.3 → 4.20.0

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+# [4.20.0](https://github.com/0xs34n/starknet.js/compare/v4.19.3...v4.20.0) (2023-01-17)
+
+### Bug Fixes
+
+- add utility getter in Block class ([3a52292](https://github.com/0xs34n/starknet.js/commit/3a5229277978c3235eaf1f7003b39eeabecac53e))
+- update responseParser & query parameters for sequencer ([a72db02](https://github.com/0xs34n/starknet.js/commit/a72db020aa1ac6924b2c047d067d553ac1b87248))
+
+### Features
+
+- add support for get_state_update in provider ([76035a1](https://github.com/0xs34n/starknet.js/commit/76035a148e7863fa1dbe440920eca34498480aa9))
+
 ## [4.19.3](https://github.com/0xs34n/starknet.js/compare/v4.19.2...v4.19.3) (2023-01-12)
 
 ### Bug Fixes

package/dist/index.d.ts

@@ -1021,6 +1021,27 @@ declare type CallL1Handler = {
     entry_point_selector: string;
     payload: Array<string>;
 };
+declare type StateDiffItem = {
+    key: string;
+    value: string;
+};
+declare type StorageDiffItem = {
+    address: string;
+    storage_entries: [key: string, value: string];
+};
+declare type DeployedContractItem = {
+    address: string;
+    class_hash: string;
+};
+declare type Nonces = {
+    contract_address: string;
+    nonce: string;
+};
+declare type SequencerIdentifier = {
+    blockHash: string;
+} | {
+    blockNumber: BlockNumber;
+};
 declare namespace Sequencer {
     type DeclareTransaction = {
         type: 'DECLARE';
@@ -1167,6 +1188,19 @@ declare namespace Sequencer {
         unit: string;
     };
     type EstimateFeeResponseBulk = AllowArray<EstimateFeeResponse>;
+    type StateUpdateResponse = {
+        block_hash: string;
+        new_root: string;
+        old_root: string;
+        state_diff: {
+            storage_diffs: Array<{
+                [address: string]: Array<StateDiffItem>;
+            }>;
+            declared_contract_hashes: Array<string>;
+            deployed_contracts: Array<DeployedContractItem>;
+            nonces: Array<Nonces>;
+        };
+    };
     type Endpoints = {
         get_contract_addresses: {
             QUERY: never;
@@ -1269,10 +1303,11 @@ declare namespace Sequencer {
         };
         get_state_update: {
             QUERY: {
-                blockHash: string;
+                blockHash?: string;
+                blockNumber?: BlockNumber;
             };
             REQUEST: never;
-            RESPONSE: any;
+            RESPONSE: StateUpdateResponse;
         };
         get_full_contract: {
             QUERY: {
@@ -1406,6 +1441,17 @@ interface TransactionSimulationResponse {
     trace: TransactionTraceResponse;
     fee_estimation: EstimateFeeResponse;
 }
+interface StateUpdateResponse {
+    block_hash: string;
+    new_root: string;
+    old_root: string;
+    state_diff: {
+        storage_diffs: Array<StorageDiffItem>;
+        declared_contract_hashes: Array<string>;
+        deployed_contracts: Array<DeployedContractItem>;
+        nonces: Array<Nonces>;
+    };
+}
 
 interface EstimateFee extends EstimateFeeResponse {
     suggestedMaxFee: BN__default;
@@ -1660,6 +1706,13 @@ declare abstract class ProviderInterface {
      * @returns the transaction trace and estimated fee
      */
     abstract getSimulateTransaction(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
+    /**
+     * Gets the state changes in a specific block
+     *
+     * @param blockIdentifier - block identifier
+     * @returns StateUpdateResponse
+     */
+    abstract getStateUpdate(blockIdentifier?: BlockIdentifier): Promise<StateUpdateResponse>;
 }
 
 declare type RpcProviderOptions = {
@@ -1816,6 +1869,7 @@ declare class SequencerProvider implements ProviderInterface {
     getTransactionTrace(txHash: BigNumberish): Promise<TransactionTraceResponse>;
     estimateMessageFee({ from_address, to_address, entry_point_selector, payload }: CallL1Handler, blockIdentifier?: BlockIdentifier): Promise<Sequencer.EstimateFeeResponse>;
     getSimulateTransaction(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
+    getStateUpdate(blockIdentifier?: BlockIdentifier): Promise<StateUpdateResponse>;
 }
 
 interface ProviderOptions {
@@ -1847,6 +1901,7 @@ declare class Provider implements ProviderInterface {
     getCode(contractAddress: string, blockIdentifier?: BlockIdentifier): Promise<GetCodeResponse>;
     waitForTransaction(txHash: BigNumberish, retryInterval?: number, successStates?: Array<Status>): Promise<GetTransactionReceiptResponse>;
     getSimulateTransaction(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
+    getStateUpdate(blockIdentifier?: BlockIdentifier): Promise<StateUpdateResponse>;
 }
 
 declare class LibraryError extends CustomError {
@@ -2805,4 +2860,4 @@ declare function validateChecksumAddress(address: string): boolean;
 declare function isUrl(s?: string): boolean;
 declare function buildUrl(baseUrl: string, defaultPath: string, urlOrPath?: string): string;
 
-export { Abi, AbiEntry, Account, AccountInterface, AllowArray, Args, AsyncContractFunction, BlockNumber, BlockTag, Call, CallContractResponse, CallDetails, CallL1Handler, CallOptions, Calldata, CommonTransactionReceiptResponse, CommonTransactionResponse, CompiledContract, CompressedCompiledContract, CompressedProgram, Contract, ContractClass, ContractEntryPoint, ContractFactory, ContractFunction, ContractInterface, DeclareContractPayload, DeclareContractResponse, DeclareContractTransaction, DeclareDeployContractPayload, DeclareDeployUDCResponse, DeclareSignerDetails, DeclareTransactionReceiptResponse, DeclareTransactionResponse, DeployAccountContractPayload, DeployAccountContractTransaction, DeployAccountSignerDetails, DeployContractPayload, DeployContractResponse, DeployContractUDCResponse, EntryPointType, EntryPointsByType, EstimateFee, EstimateFeeAction, EstimateFeeBulk, EstimateFeeDetails, EstimateFeeResponse, EstimateFeeResponseBulk, Event, ExecutionResources, FunctionAbi, FunctionInvocation, GatewayError, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionReceiptResponse, GetTransactionResponse, GetTransactionStatusResponse, HttpError, Invocation, InvocationBulk, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeTransactionReceiptResponse, InvokeTransactionResponse, KeyPair, LibraryError, MessageToL1, MessageToL2, MultiDeployContractResponse, Overrides, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, RPC, RawArgs, RawCalldata, Result, RpcProvider, RpcProviderOptions, Sequencer, SequencerProvider, SequencerProviderOptions, Signature, Signer, SignerInterface, Status, Struct, StructAbi, TransactionBulk, TransactionSimulation, TransactionSimulationResponse, TransactionStatus, TransactionTraceResponse, TransactionType, UniversalDeployerContractPayload, addAddressPadding, buildUrl, constants, defaultProvider, ellipticCurve as ec, encode, getChecksumAddress, hash, isUrl, json, merkle, number, shortString, stark, transaction, index as typedData, uint256, validateAndParseAddress, validateChecksumAddress };
+export { Abi, AbiEntry, Account, AccountInterface, AllowArray, Args, AsyncContractFunction, BlockNumber, BlockTag, Call, CallContractResponse, CallDetails, CallL1Handler, CallOptions, Calldata, CommonTransactionReceiptResponse, CommonTransactionResponse, CompiledContract, CompressedCompiledContract, CompressedProgram, Contract, ContractClass, ContractEntryPoint, ContractFactory, ContractFunction, ContractInterface, DeclareContractPayload, DeclareContractResponse, DeclareContractTransaction, DeclareDeployContractPayload, DeclareDeployUDCResponse, DeclareSignerDetails, DeclareTransactionReceiptResponse, DeclareTransactionResponse, DeployAccountContractPayload, DeployAccountContractTransaction, DeployAccountSignerDetails, DeployContractPayload, DeployContractResponse, DeployContractUDCResponse, DeployedContractItem, EntryPointType, EntryPointsByType, EstimateFee, EstimateFeeAction, EstimateFeeBulk, EstimateFeeDetails, EstimateFeeResponse, EstimateFeeResponseBulk, Event, ExecutionResources, FunctionAbi, FunctionInvocation, GatewayError, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionReceiptResponse, GetTransactionResponse, GetTransactionStatusResponse, HttpError, Invocation, InvocationBulk, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeTransactionReceiptResponse, InvokeTransactionResponse, KeyPair, LibraryError, MessageToL1, MessageToL2, MultiDeployContractResponse, Nonces, Overrides, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, RPC, RawArgs, RawCalldata, Result, RpcProvider, RpcProviderOptions, Sequencer, SequencerIdentifier, SequencerProvider, SequencerProviderOptions, Signature, Signer, SignerInterface, StateDiffItem, StateUpdateResponse, Status, StorageDiffItem, Struct, StructAbi, TransactionBulk, TransactionSimulation, TransactionSimulationResponse, TransactionStatus, TransactionTraceResponse, TransactionType, UniversalDeployerContractPayload, addAddressPadding, buildUrl, constants, defaultProvider, ellipticCurve as ec, encode, getChecksumAddress, hash, isUrl, json, merkle, number, shortString, stark, transaction, index as typedData, uint256, validateAndParseAddress, validateChecksumAddress };

package/dist/index.global.js

@@ -20766,6 +20766,9 @@ var starknet = (() => {
     set identifier(_identifier) {
       this.setIdentifier(_identifier);
     }
+    get sequencerIdentifier() {
+      return this.hash !== null ? { blockHash: this.hash } : { blockNumber: this.number ?? this.tag };
+    }
   };
 
   // src/provider/rpc.ts
@@ -21201,6 +21204,29 @@ var starknet = (() => {
         class_hash: res.class_hash
       };
     }
+    parseGetStateUpdateResponse(res) {
+      const nonces = [].concat(res.state_diff.nonces).map(({ contract_address, nonce }) => {
+        return {
+          contract_address,
+          nonce
+        };
+      });
+      const storage_diffs = [].concat(res.state_diff.storage_diffs).map(({ address, storage_entries }) => {
+        return {
+          address,
+          storage_entries
+        };
+      });
+      return {
+        ...res,
+        state_diff: {
+          storage_diffs,
+          declared_contract_hashes: res.state_diff.declared_contract_hashes,
+          deployed_contracts: res.state_diff.deployed_contracts,
+          nonces
+        }
+      };
+    }
   };
 
   // src/utils/url.ts
@@ -21594,6 +21620,12 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
         }
       ).then(this.responseParser.parseFeeSimulateTransactionResponse);
     }
+    async getStateUpdate(blockIdentifier = this.blockIdentifier) {
+      const args = new Block(blockIdentifier).sequencerIdentifier;
+      return this.fetchEndpoint("get_state_update", { ...args }).then(
+        this.responseParser.parseGetStateUpdateResponse
+      );
+    }
   };
 
   // src/provider/default.ts
@@ -21681,6 +21713,9 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
     async getSimulateTransaction(invocation, invocationDetails, blockIdentifier) {
       return this.provider.getSimulateTransaction(invocation, invocationDetails, blockIdentifier);
     }
+    async getStateUpdate(blockIdentifier) {
+      return this.provider.getStateUpdate(blockIdentifier);
+    }
   };
 
   // src/provider/interface.ts