starknet 4.17.1 → 4.18.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [4.18.0](https://github.com/0xs34n/starknet.js/compare/v4.17.1...v4.18.0) (2022-12-23)
+
+### Bug Fixes
+
+- merge develop into branch ([21efcb1](https://github.com/0xs34n/starknet.js/commit/21efcb1cefd6ea70a9d49e060ff620e88002e3b6))
+
+### Features
+
+- simulate_transaction support on sequencer ([304c3cc](https://github.com/0xs34n/starknet.js/commit/304c3cc1af81bc8810581546f043caca01db173b))
+- update simulate tx ([8f3ea55](https://github.com/0xs34n/starknet.js/commit/8f3ea55eb1e23cefc0419902a2ebbe10ee373ccb))
+- update simulate tx in sequencer ([d79a9fa](https://github.com/0xs34n/starknet.js/commit/d79a9faa307936561504c120f67f3fb2f18423b6))
+
 ## [4.17.1](https://github.com/0xs34n/starknet.js/compare/v4.17.0...v4.17.1) (2022-12-14)
 
 ### Bug Fixes

package/README.md

@@ -56,14 +56,6 @@ Guides can be found [here](https://www.starknetjs.com/guides/intro)
 
 [Click Here](https://www.starknetjs.com/docs/API/)
 
-## 🚀 Powered by Starknet.js
-
-- [Argent X - the first StarkNet wallet](https://github.com/argentlabs/argent-x)
-- [Braavos - your new wallet on top of StarkNet](https://chrome.google.com/webstore/detail/braavos-wallet/jnlgamecbpmbajjfhmmmlhejkemejdma)
-- [React + Starknet.js boilerplate](https://github.com/fracek/starknet-react-example)
-- [AMM Demo](https://www.starknetswap.com/)
-- [mySwap - the first DeFi app to launch on StarkNet](https://myswap.xyz)
-
 ## ✏️ Contributing
 
 If you consider to contribute to this project please read [CONTRIBUTING.md](https://github.com/0xs34n/starknet.js/blob/main/CONTRIBUTING.md) first.
@@ -72,9 +64,9 @@ If you consider to contribute to this project please read [CONTRIBUTING.md](http
 
 Special thanks to all the [contributors](https://github.com/0xs34n/starknet.js/graphs/contributors), especially to:
 
-Janek ([@janek26](https://github.com/janek26)), Axel ([@delaaxe](https://github.com/delaaxe)) and Dhruv ([@dhruvkelawala](https://github.com/dhruvkelawala)) from [Argent](https://github.com/argentlabs)
+Janek ([@janek26](https://github.com/janek26)) and Dhruv ([@dhruvkelawala](https://github.com/dhruvkelawala)) from [Argent](https://github.com/argentlabs)
 
-Miljan ([@MilGard91](https://github.com/MilGard91)) from [Shard Labs](https://shardlabs.io/)
+Toni ([@tabaktoni](https://github.com/tabaktoni)) and Ivan ([@ivpavici](https://github.com/ivpavici)) from [Shard Labs](https://shardlabs.io/)
 
 and of course the [StarkWare](https://starkware.co/) team for their dedicated support!
 

package/dist/index.d.ts

@@ -1114,7 +1114,7 @@ declare type ExecutionResources = {
     };
     n_memory_holes: number;
 };
-declare type GetTransactionTraceResponse = {
+declare type TransactionTraceResponse = {
     validate_invocation?: FunctionInvocation;
     function_invocation?: FunctionInvocation;
     fee_transfer_invocation?: FunctionInvocation;
@@ -1256,10 +1256,16 @@ declare namespace Sequencer {
     type DeployAccountEstimateFee = Omit<DeployAccountTransaction, 'max_fee'>;
     type DeployEstimateFee = DeployTransaction;
     type EstimateFeeRequest = InvokeEstimateFee | DeclareEstimateFee | DeployEstimateFee | DeployAccountEstimateFee;
+    type TransactionSimulationResponse = {
+        trace: TransactionTraceResponse;
+        fee_estimation: Sequencer.EstimateFeeResponse;
+    };
+    type SimulateTransaction = Omit<InvokeFunctionTransaction, 'max_fee' | 'entry_point_type'>;
     type EstimateFeeResponse = {
         overall_fee: number;
         gas_price: number;
         gas_usage: number;
+        uint: string;
     } | {
         amount: BN__default;
         unit: string;
@@ -1294,7 +1300,7 @@ declare namespace Sequencer {
                 transactionHash: string;
             };
             REQUEST: never;
-            RESPONSE: GetTransactionTraceResponse;
+            RESPONSE: TransactionTraceResponse;
         };
         get_transaction_receipt: {
             QUERY: {
@@ -1384,6 +1390,13 @@ declare namespace Sequencer {
             REQUEST: any;
             RESPONSE: EstimateFeeResponse;
         };
+        simulate_transaction: {
+            QUERY: {
+                blockIdentifier: BlockIdentifier;
+            };
+            REQUEST: SimulateTransaction;
+            RESPONSE: TransactionSimulationResponse;
+        };
     };
 }
 
@@ -1725,8 +1738,9 @@ declare class SequencerProvider implements ProviderInterface {
      * @param txHash
      * @returns the transaction trace
      */
-    getTransactionTrace(txHash: BigNumberish): Promise<GetTransactionTraceResponse>;
+    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>;
 }
 
 interface ProviderOptions {
@@ -2684,4 +2698,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, EstimateFeeDetails, EstimateFeeResponse, Event, ExecutionResources, FunctionAbi, FunctionInvocation, GatewayError, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionReceiptResponse, GetTransactionResponse, GetTransactionStatusResponse, GetTransactionTraceResponse, HttpError, Invocation, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeTransactionReceiptResponse, InvokeTransactionResponse, KeyPair, MessageToL1, MessageToL2, MultiDeployContractResponse, Overrides, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, RPC, RawArgs, RawCalldata, Result, RpcProvider, RpcProviderOptions, Sequencer, SequencerProvider, SequencerProviderOptions, Signature, Signer, SignerInterface, Status, Struct, StructAbi, TransactionStatus, 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, EstimateFeeDetails, EstimateFeeResponse, Event, ExecutionResources, FunctionAbi, FunctionInvocation, GatewayError, GetBlockResponse, GetCodeResponse, GetContractAddressesResponse, GetTransactionReceiptResponse, GetTransactionResponse, GetTransactionStatusResponse, HttpError, Invocation, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeTransactionReceiptResponse, InvokeTransactionResponse, KeyPair, MessageToL1, MessageToL2, MultiDeployContractResponse, Overrides, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, RPC, RawArgs, RawCalldata, Result, RpcProvider, RpcProviderOptions, Sequencer, SequencerProvider, SequencerProviderOptions, Signature, Signer, SignerInterface, Status, Struct, StructAbi, 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

@@ -20792,7 +20792,7 @@ var starknet = (() => {
           calldata: parseCalldata(functionInvocation.calldata),
           type: "INVOKE",
           max_fee: toHex(toBN(details.maxFee || 0)),
-          version: toHex(toBN(details.version || 0)),
+          version: toHex(toBN(details.version || 1)),
           signature: bigNumberishArrayToHexadecimalStringArray(functionInvocation.signature || []),
           nonce: toHex(toBN(details.nonce))
         }
@@ -21118,7 +21118,8 @@ var starknet = (() => {
         "add_transaction",
         "call_contract",
         "estimate_fee",
-        "estimate_message_fee"
+        "estimate_message_fee",
+        "simulate_transaction"
       ];
       return postMethodEndpoints.includes(endpoint) ? "POST" : "GET";
     }
@@ -21363,6 +21364,20 @@ ${res.tx_failure_reason.error_message}` : res.tx_status;
       };
       return this.fetchEndpoint("estimate_message_fee", { blockIdentifier }, validCallL1Handler);
     }
+    async simulateTransaction(invocation, invocationDetails, blockIdentifier = this.blockIdentifier) {
+      return this.fetchEndpoint(
+        "simulate_transaction",
+        { blockIdentifier },
+        {
+          type: "INVOKE_FUNCTION",
+          contract_address: invocation.contractAddress,
+          calldata: invocation.calldata ?? [],
+          signature: bigNumberishArrayToDecimalStringArray(invocation.signature || []),
+          version: toHex(toBN((invocationDetails == null ? void 0 : invocationDetails.version) || 1)),
+          nonce: toHex(toBN(invocationDetails.nonce))
+        }
+      );
+    }
   };
 
   // src/provider/default.ts