starknet 4.19.2 → 4.19.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.19.3](https://github.com/0xs34n/starknet.js/compare/v4.19.2...v4.19.3) (2023-01-12)
+
+### Bug Fixes
+
+- remove any type in simulateTransaction ([a94db18](https://github.com/0xs34n/starknet.js/commit/a94db1887c9fee676ac9b313190453abd5ea2554))
+- update account.simulateTransaction return type ([3c3d397](https://github.com/0xs34n/starknet.js/commit/3c3d397a4fb1042c7358f70f50df0a4ce2893220))
+
 ## [4.19.2](https://github.com/0xs34n/starknet.js/compare/v4.19.1...v4.19.2) (2023-01-11)
 
 ### Bug Fixes

package/dist/index.d.ts

@@ -971,139 +971,6 @@ interface Result extends Array<any> {
 
 declare type BlockIdentifier = BlockNumber | BigNumberish;
 
-/**
- * Common interface response
- * Intersection (sequencer response ∩ (∪ rpc responses))
- */
-
-interface GetBlockResponse {
-    timestamp: number;
-    block_hash: string;
-    block_number: number;
-    new_root: string;
-    parent_hash: string;
-    status: Status;
-    transactions: Array<string>;
-    gas_price?: string;
-    sequencer_address?: string;
-    starknet_version?: string;
-    transaction_receipts?: any;
-}
-interface GetCodeResponse {
-    bytecode: string[];
-}
-declare type GetTransactionResponse = InvokeTransactionResponse & DeclareTransactionResponse;
-interface CommonTransactionResponse {
-    transaction_hash?: string;
-    version?: string;
-    signature?: Signature;
-    max_fee?: string;
-    nonce?: string;
-}
-interface InvokeTransactionResponse extends CommonTransactionResponse {
-    contract_address?: string;
-    entry_point_selector?: string;
-    calldata: RawCalldata;
-}
-interface ContractEntryPoint {
-    offset: string;
-    selector: string;
-}
-interface DeclareTransactionResponse extends CommonTransactionResponse {
-    contract_class?: any;
-    sender_address?: string;
-}
-declare type GetTransactionReceiptResponse = InvokeTransactionReceiptResponse | DeclareTransactionReceiptResponse;
-interface CommonTransactionReceiptResponse {
-    transaction_hash: string;
-    status?: Status;
-    actual_fee?: string;
-    status_data?: string;
-}
-interface MessageToL1 {
-    to_address: string;
-    payload: Array<string>;
-}
-interface Event {
-    from_address: string;
-    keys: Array<string>;
-    data: Array<string>;
-}
-interface MessageToL2 {
-    from_address: string;
-    payload: Array<string>;
-}
-interface InvokeTransactionReceiptResponse extends CommonTransactionReceiptResponse {
-    /** @deprecated Use l2_to_l1_messages */
-    messages_sent?: Array<MessageToL1>;
-    events?: Array<Event>;
-    l1_origin_message?: MessageToL2;
-}
-declare type DeclareTransactionReceiptResponse = CommonTransactionReceiptResponse;
-interface EstimateFeeResponse {
-    overall_fee: BN__default;
-    gas_consumed?: BN__default;
-    gas_price?: BN__default;
-}
-interface InvokeFunctionResponse {
-    transaction_hash: string;
-}
-interface DeclareContractResponse {
-    transaction_hash: string;
-    class_hash: string;
-}
-declare type CallContractResponse = {
-    result: Array<string>;
-};
-declare type EstimateFeeAction = {
-    type: 'INVOKE';
-    payload: AllowArray<Call>;
-} | {
-    type: 'DECLARE';
-    payload: DeclareContractPayload;
-} | {
-    type: 'DEPLOY_ACCOUNT';
-    payload: DeployAccountContractPayload;
-} | {
-    type: 'DEPLOY';
-    payload: UniversalDeployerContractPayload;
-};
-declare type EstimateFeeResponseBulk = Array<EstimateFeeResponse>;
-
-interface EstimateFee extends EstimateFeeResponse {
-    suggestedMaxFee: BN__default;
-}
-declare type EstimateFeeBulk = Array<EstimateFee>;
-interface EstimateFeeDetails {
-    nonce?: BigNumberish;
-    blockIdentifier?: BlockIdentifier;
-}
-interface DeployContractResponse {
-    contract_address: string;
-    transaction_hash: string;
-}
-declare type MultiDeployContractResponse = {
-    contract_address: Array<string>;
-    transaction_hash: string;
-};
-declare type DeployContractUDCResponse = {
-    contract_address: string;
-    transaction_hash: string;
-    address: string;
-    deployer: string;
-    unique: string;
-    classHash: string;
-    calldata_len: string;
-    calldata: Array<string>;
-    salt: string;
-};
-declare type DeclareDeployUDCResponse = {
-    declare: {
-        class_hash: BigNumberish;
-    } & DeclareTransactionReceiptResponse;
-    deploy: DeployContractUDCResponse;
-};
-
 declare type GetTransactionStatusResponse = {
     tx_status: Status;
     block_hash?: string;
@@ -1437,6 +1304,146 @@ declare namespace Sequencer {
     };
 }
 
+/**
+ * Common interface response
+ * Intersection (sequencer response ∩ (∪ rpc responses))
+ */
+
+interface GetBlockResponse {
+    timestamp: number;
+    block_hash: string;
+    block_number: number;
+    new_root: string;
+    parent_hash: string;
+    status: Status;
+    transactions: Array<string>;
+    gas_price?: string;
+    sequencer_address?: string;
+    starknet_version?: string;
+    transaction_receipts?: any;
+}
+interface GetCodeResponse {
+    bytecode: string[];
+}
+declare type GetTransactionResponse = InvokeTransactionResponse & DeclareTransactionResponse;
+interface CommonTransactionResponse {
+    transaction_hash?: string;
+    version?: string;
+    signature?: Signature;
+    max_fee?: string;
+    nonce?: string;
+}
+interface InvokeTransactionResponse extends CommonTransactionResponse {
+    contract_address?: string;
+    entry_point_selector?: string;
+    calldata: RawCalldata;
+}
+interface ContractEntryPoint {
+    offset: string;
+    selector: string;
+}
+interface DeclareTransactionResponse extends CommonTransactionResponse {
+    contract_class?: any;
+    sender_address?: string;
+}
+declare type GetTransactionReceiptResponse = InvokeTransactionReceiptResponse | DeclareTransactionReceiptResponse;
+interface CommonTransactionReceiptResponse {
+    transaction_hash: string;
+    status?: Status;
+    actual_fee?: string;
+    status_data?: string;
+}
+interface MessageToL1 {
+    to_address: string;
+    payload: Array<string>;
+}
+interface Event {
+    from_address: string;
+    keys: Array<string>;
+    data: Array<string>;
+}
+interface MessageToL2 {
+    from_address: string;
+    payload: Array<string>;
+}
+interface InvokeTransactionReceiptResponse extends CommonTransactionReceiptResponse {
+    /** @deprecated Use l2_to_l1_messages */
+    messages_sent?: Array<MessageToL1>;
+    events?: Array<Event>;
+    l1_origin_message?: MessageToL2;
+}
+declare type DeclareTransactionReceiptResponse = CommonTransactionReceiptResponse;
+interface EstimateFeeResponse {
+    overall_fee: BN__default;
+    gas_consumed?: BN__default;
+    gas_price?: BN__default;
+}
+interface InvokeFunctionResponse {
+    transaction_hash: string;
+}
+interface DeclareContractResponse {
+    transaction_hash: string;
+    class_hash: string;
+}
+declare type CallContractResponse = {
+    result: Array<string>;
+};
+declare type EstimateFeeAction = {
+    type: 'INVOKE';
+    payload: AllowArray<Call>;
+} | {
+    type: 'DECLARE';
+    payload: DeclareContractPayload;
+} | {
+    type: 'DEPLOY_ACCOUNT';
+    payload: DeployAccountContractPayload;
+} | {
+    type: 'DEPLOY';
+    payload: UniversalDeployerContractPayload;
+};
+declare type EstimateFeeResponseBulk = Array<EstimateFeeResponse>;
+interface TransactionSimulationResponse {
+    trace: TransactionTraceResponse;
+    fee_estimation: EstimateFeeResponse;
+}
+
+interface EstimateFee extends EstimateFeeResponse {
+    suggestedMaxFee: BN__default;
+}
+declare type EstimateFeeBulk = Array<EstimateFee>;
+interface EstimateFeeDetails {
+    nonce?: BigNumberish;
+    blockIdentifier?: BlockIdentifier;
+}
+interface DeployContractResponse {
+    contract_address: string;
+    transaction_hash: string;
+}
+declare type MultiDeployContractResponse = {
+    contract_address: Array<string>;
+    transaction_hash: string;
+};
+declare type DeployContractUDCResponse = {
+    contract_address: string;
+    transaction_hash: string;
+    address: string;
+    deployer: string;
+    unique: string;
+    classHash: string;
+    calldata_len: string;
+    calldata: Array<string>;
+    salt: string;
+};
+declare type DeclareDeployUDCResponse = {
+    declare: {
+        class_hash: BigNumberish;
+    } & DeclareTransactionReceiptResponse;
+    deploy: DeployContractUDCResponse;
+};
+interface TransactionSimulation extends TransactionSimulationResponse {
+    fee_estimation: EstimateFee;
+}
+
 declare abstract class ProviderInterface {
     abstract chainId: StarknetChainId;
     /**
@@ -1638,6 +1645,21 @@ declare abstract class ProviderInterface {
      * @return GetTransactionReceiptResponse
      */
     abstract waitForTransaction(txHash: BigNumberish, retryInterval?: number, successStates?: Array<Status>): Promise<GetTransactionReceiptResponse>;
+    /**
+     * Simulates the transaction and returns the transaction trace and estimated fee.
+     *
+     * @param invocation the invocation object containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     * - signature - (defaults to []) the signature
+     * @param details - optional details containing:
+     * - nonce - optional nonce
+     * - version - optional version
+     * @param blockIdentifier - block identifier
+     * @returns the transaction trace and estimated fee
+     */
+    abstract getSimulateTransaction(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
 }
 
 declare type RpcProviderOptions = {
@@ -1717,6 +1739,7 @@ declare class RpcProvider implements ProviderInterface {
      * @returns events and the pagination of the events
      */
     getEvents(eventFilter: RPC.EventFilter): Promise<RPC.GetEventsResponse>;
+    getSimulateTransaction(_invocation: Invocation, _invocationDetails: InvocationsDetailsWithNonce, _blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
 }
 
 declare type NetworkName = 'mainnet-alpha' | 'goerli-alpha' | 'goerli-alpha-2';
@@ -1792,7 +1815,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>;
-    simulateTransaction(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<Sequencer.TransactionSimulationResponse>;
+    getSimulateTransaction(invocation: Invocation, invocationDetails: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<TransactionSimulationResponse>;
 }
 
 interface ProviderOptions {
@@ -1823,6 +1846,7 @@ declare class Provider implements ProviderInterface {
     getDeployAccountEstimateFee(transaction: DeployAccountContractTransaction, details: InvocationsDetailsWithNonce, blockIdentifier?: BlockIdentifier): Promise<EstimateFeeResponse>;
     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>;
 }
 
 declare class LibraryError extends CustomError {
@@ -2280,6 +2304,17 @@ declare abstract class AccountInterface extends ProviderInterface {
      * @returns suggestedMaxFee
      */
     abstract getSuggestedMaxFee(estimateFeeAction: EstimateFeeAction, details: EstimateFeeDetails): Promise<BigNumberish>;
+    /**
+     * Simulates the transaction and returns the transaction trace and estimated fee.
+     *
+     * @param calls the invocation object containing:
+     * - contractAddress - the address of the contract
+     * - entrypoint - the entrypoint of the contract
+     * - calldata - (defaults to []) the calldata
+     *
+     * @returns response from estimate_fee
+     */
+    abstract simulateTransaction(calls: AllowArray<Call>, estimateFeeDetails?: EstimateFeeDetails): Promise<TransactionSimulation>;
 }
 
 declare class Account extends Provider implements AccountInterface {
@@ -2310,6 +2345,7 @@ declare class Account extends Provider implements AccountInterface {
     buildDeclarePayload({ classHash, contract }: DeclareContractPayload, { nonce, chainId, version, walletAddress, maxFee }: InvocationsSignerDetails): Promise<DeclareContractTransaction>;
     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>;
 }
 
 declare type CallOptions = {
@@ -2769,4 +2805,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, 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, 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 };

package/dist/index.global.js

@@ -21058,6 +21058,9 @@ var starknet = (() => {
     async getEvents(eventFilter) {
       return this.fetchEndpoint("starknet_getEvents", { filter: eventFilter });
     }
+    async getSimulateTransaction(_invocation, _invocationDetails, _blockIdentifier) {
+      throw new Error("RPC does not implement simulateTransaction function");
+    }
   };
 
   // src/provider/sequencer.ts
@@ -21151,6 +21154,31 @@ var starknet = (() => {
         };
       });
     }
+    parseFeeSimulateTransactionResponse(res) {
+      if ("overall_fee" in res.fee_estimation) {
+        let gasInfo = {};
+        try {
+          gasInfo = {
+            gas_consumed: toBN(res.fee_estimation.gas_usage),
+            gas_price: toBN(res.fee_estimation.gas_price)
+          };
+        } catch {
+        }
+        return {
+          trace: res.trace,
+          fee_estimation: {
+            ...gasInfo,
+            overall_fee: toBN(res.fee_estimation.overall_fee)
+          }
+        };
+      }
+      return {
+        trace: res.trace,
+        fee_estimation: {
+          overall_fee: toBN(res.fee_estimation.amount)
+        }
+      };
+    }
     parseCallContractResponse(res) {
       return {
         result: res.result
@@ -21552,7 +21580,7 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
       };
       return this.fetchEndpoint("estimate_message_fee", { blockIdentifier }, validCallL1Handler);
     }
-    async simulateTransaction(invocation, invocationDetails, blockIdentifier = this.blockIdentifier) {
+    async getSimulateTransaction(invocation, invocationDetails, blockIdentifier = this.blockIdentifier) {
       return this.fetchEndpoint(
         "simulate_transaction",
         { blockIdentifier },
@@ -21564,7 +21592,7 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
           version: toHex(toBN((invocationDetails == null ? void 0 : invocationDetails.version) || 1)),
           nonce: toHex(toBN(invocationDetails.nonce))
         }
-      );
+      ).then(this.responseParser.parseFeeSimulateTransactionResponse);
     }
   };
 
@@ -21650,6 +21678,9 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
     async waitForTransaction(txHash, retryInterval, successStates) {
       return this.provider.waitForTransaction(txHash, retryInterval, successStates);
     }
+    async getSimulateTransaction(invocation, invocationDetails, blockIdentifier) {
+      return this.provider.getSimulateTransaction(invocation, invocationDetails, blockIdentifier);
+    }
   };
 
   // src/provider/interface.ts
@@ -23054,6 +23085,33 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
       });
       return calls;
     }
+    async simulateTransaction(calls, { nonce: providedNonce, blockIdentifier } = {}) {
+      const transactions = Array.isArray(calls) ? calls : [calls];
+      const nonce = toBN(providedNonce ?? await this.getNonce());
+      const version3 = toBN(feeTransactionVersion);
+      const chainId = await this.getChainId();
+      const signerDetails = {
+        walletAddress: this.address,
+        nonce,
+        maxFee: ZERO,
+        version: version3,
+        chainId
+      };
+      const invocation = await this.buildInvocation(transactions, signerDetails);
+      const response = await super.getSimulateTransaction(
+        invocation,
+        { version: version3, nonce },
+        blockIdentifier
+      );
+      const suggestedMaxFee = estimatedFeeToMaxFee(response.fee_estimation.overall_fee);
+      return {
+        ...response,
+        fee_estimation: {
+          ...response.fee_estimation,
+          suggestedMaxFee
+        }
+      };
+    }
   };
 
   // src/account/interface.ts