starknet 5.3.0 → 5.4.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# [5.4.0](https://github.com/0xs34n/starknet.js/compare/v5.3.0...v5.4.0) (2023-04-03)
+
+### Bug Fixes
+
+- adjust suggested max fee response type ([78b1f81](https://github.com/0xs34n/starknet.js/commit/78b1f814f2a65fa0b28ed27912b69d3dfbc022ad))
+
+### Features
+
+- support cairo1 execute calldata ([1f7f001](https://github.com/0xs34n/starknet.js/commit/1f7f00155ae89ff871cdf987cd3b5238377d5450))
+
 # [5.3.0](https://github.com/0xs34n/starknet.js/compare/v5.2.0...v5.3.0) (2023-03-29)
 
 ### Features

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as _noble_curves_abstract_weierstrass from '@noble/curves/abstract/weierstrass';
 import * as poseidon from '@noble/curves/abstract/poseidon';
 import * as microStarknet from 'micro-starknet';
-import { CustomError } from 'ts-custom-error';
+import { CustomError } from 'ts-custom-error/dist/custom-error';
 
 declare const IS_BROWSER: boolean;
 declare function arrayBufferToString(array: ArrayBuffer): string;
@@ -368,10 +368,12 @@ declare type Invocation = CallDetails & {
 declare type Call = CallDetails & {
     entrypoint: string;
 };
+declare type CairoVersion = '0' | '1';
 declare type InvocationsDetails = {
     nonce?: BigNumberish;
     maxFee?: BigNumberish;
     version?: BigNumberish;
+    cairoVersion?: CairoVersion;
 };
 /**
  * Contain all additional details params
@@ -446,6 +448,11 @@ declare type waitForTransactionOptions = {
     retryInterval?: number;
     successStates?: Array<TransactionStatus>;
 };
+interface CallStruct {
+    to: string;
+    selector: string;
+    calldata: string[];
+}
 
 declare type Calldata = string[];
 declare type Overrides = {
@@ -461,14 +468,14 @@ interface InvocationsSignerDetails extends Required<InvocationsDetails> {
 }
 interface DeclareSignerDetails {
     classHash: string;
-    senderAddress: BigNumberish;
+    senderAddress: string;
     chainId: StarknetChainId;
     maxFee: BigNumberish;
     version: BigNumberish;
     nonce: BigNumberish;
     compiledClassHash?: string;
 }
-declare type DeployAccountSignerDetails = Required<DeployAccountContractPayload> & Required<InvocationsDetails> & {
+declare type DeployAccountSignerDetails = Required<DeployAccountContractPayload> & Omit<Required<InvocationsDetails>, 'cairoVersion'> & {
     contractAddress: BigNumberish;
     chainId: StarknetChainId;
 };
@@ -1650,6 +1657,7 @@ interface EstimateFeeDetails {
     nonce?: BigNumberish;
     blockIdentifier?: BlockIdentifier;
     skipValidate?: boolean;
+    cairoVersion?: CairoVersion;
 }
 interface DeployContractResponse {
     contract_address: string;
@@ -2546,7 +2554,7 @@ declare abstract class AccountInterface extends ProviderInterface {
      * @param  {BlockIdentifier} blockIdentifier - optional blockIdentifier. Defaults to 'pending'
      * @returns nonce of the account
      */
-    abstract getNonce(blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
+    abstract getNonce(blockIdentifier?: BlockIdentifier): Promise<Nonce>;
     /**
      * Gets Suggested Max Fee based on the transaction type
      *
@@ -2554,7 +2562,7 @@ declare abstract class AccountInterface extends ProviderInterface {
      * @param  {EstimateFeeDetails} details
      * @returns suggestedMaxFee
      */
-    abstract getSuggestedMaxFee(estimateFeeAction: EstimateFeeAction, details: EstimateFeeDetails): Promise<BigNumberish>;
+    abstract getSuggestedMaxFee(estimateFeeAction: EstimateFeeAction, details: EstimateFeeDetails): Promise<bigint>;
     /**
      * Simulates the transaction and returns the transaction trace and estimated fee.
      *
@@ -2572,13 +2580,13 @@ declare class Account extends Provider implements AccountInterface {
     signer: SignerInterface;
     address: string;
     constructor(providerOrOptions: ProviderOptions | ProviderInterface, address: string, pkOrSigner: Uint8Array | string | SignerInterface);
-    getNonce(blockIdentifier?: BlockIdentifier): Promise<BigNumberish>;
+    getNonce(blockIdentifier?: BlockIdentifier): Promise<Nonce>;
     estimateFee(calls: AllowArray<Call>, estimateFeeDetails?: EstimateFeeDetails | undefined): Promise<EstimateFee>;
-    estimateInvokeFee(calls: AllowArray<Call>, { nonce: providedNonce, blockIdentifier, skipValidate }?: EstimateFeeDetails): Promise<EstimateFee>;
-    estimateDeclareFee({ contract, classHash: providedClassHash, casm, compiledClassHash }: DeclareContractPayload, { blockIdentifier, nonce: providedNonce, skipValidate }?: EstimateFeeDetails): Promise<EstimateFee>;
-    estimateAccountDeployFee({ classHash, addressSalt, constructorCalldata, contractAddress: providedContractAddress, }: DeployAccountContractPayload, { blockIdentifier, skipValidate }?: EstimateFeeDetails): Promise<EstimateFee>;
+    estimateInvokeFee(calls: AllowArray<Call>, { nonce: providedNonce, blockIdentifier, skipValidate, cairoVersion }?: EstimateFeeDetails): Promise<EstimateFee>;
+    estimateDeclareFee({ contract, classHash: providedClassHash, casm, compiledClassHash }: DeclareContractPayload, { blockIdentifier, nonce: providedNonce, skipValidate, cairoVersion }?: EstimateFeeDetails): Promise<EstimateFee>;
+    estimateAccountDeployFee({ classHash, addressSalt, constructorCalldata, contractAddress: providedContractAddress, }: DeployAccountContractPayload, { blockIdentifier, skipValidate, cairoVersion }?: EstimateFeeDetails): Promise<EstimateFee>;
     estimateDeployFee(payload: UniversalDeployerContractPayload | UniversalDeployerContractPayload[], transactionsDetail?: InvocationsDetails | undefined): Promise<EstimateFee>;
-    estimateFeeBulk(transactions: TransactionBulk, { nonce: providedNonce, blockIdentifier }?: EstimateFeeDetails): Promise<EstimateFeeBulk>;
+    estimateFeeBulk(transactions: TransactionBulk, { nonce: providedNonce, blockIdentifier, cairoVersion }?: EstimateFeeDetails): Promise<EstimateFeeBulk>;
     buildInvocation(call: Array<Call>, signerDetails: InvocationsSignerDetails): Promise<Invocation>;
     execute(calls: AllowArray<Call>, abis?: Abi[] | undefined, transactionsDetail?: InvocationsDetails): Promise<InvokeFunctionResponse>;
     declare(payload: DeclareContractPayload, transactionsDetail?: InvocationsDetails): Promise<DeclareContractResponse>;
@@ -2590,14 +2598,14 @@ declare class Account extends Provider implements AccountInterface {
     hashMessage(typedData: TypedData): Promise<string>;
     verifyMessageHash(hash: BigNumberish, signature: Signature): Promise<boolean>;
     verifyMessage(typedData: TypedData, signature: Signature): Promise<boolean>;
-    getSuggestedMaxFee({ type, payload }: EstimateFeeAction, details: EstimateFeeDetails): Promise<string>;
+    getSuggestedMaxFee({ type, payload }: EstimateFeeAction, details: EstimateFeeDetails): Promise<bigint>;
     /**
      * @deprecated will be renamed to buildDeclareContractTransaction
      */
     buildDeclarePayload(payload: 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, skipValidate }?: EstimateFeeDetails): Promise<TransactionSimulation>;
+    simulateTransaction(calls: AllowArray<Call>, { nonce: providedNonce, blockIdentifier, skipValidate, cairoVersion }?: EstimateFeeDetails): Promise<TransactionSimulation>;
     getStarkName(address?: BigNumberish, // default to the wallet address
     StarknetIdContract?: string): Promise<string>;
 }
@@ -2844,34 +2852,21 @@ declare namespace hash {
   };
 }
 
-declare const parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
-declare const stringify: {
-    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
-    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
-};
-declare const parseAlwaysAsBig: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
-declare const stringifyAlwaysAsBig: {
-    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
-    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
-};
-declare const _default: {
-    parse: (text: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => any;
-    stringify: {
-        (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
-        (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
-    };
-};
+declare const parse: (x: string) => any;
+declare const parseAlwaysAsBig: (x: string) => any;
+declare const stringify: (value: JavaScriptValue, replacer?: any, space?: string | number | undefined, numberStringifiers?: NumberStringifier[] | undefined) => string;
+/** @deprecated */
+declare const stringifyAlwaysAsBig: (value: JavaScriptValue, replacer?: any, space?: string | number | undefined, numberStringifiers?: NumberStringifier[] | undefined) => string;
 
 declare const json_parse: typeof parse;
-declare const json_stringify: typeof stringify;
 declare const json_parseAlwaysAsBig: typeof parseAlwaysAsBig;
+declare const json_stringify: typeof stringify;
 declare const json_stringifyAlwaysAsBig: typeof stringifyAlwaysAsBig;
 declare namespace json {
   export {
-    _default as default,
     json_parse as parse,
-    json_stringify as stringify,
     json_parseAlwaysAsBig as parseAlwaysAsBig,
+    json_stringify as stringify,
     json_stringifyAlwaysAsBig as stringifyAlwaysAsBig,
   };
 }
@@ -2894,15 +2889,42 @@ declare const transformCallsToMulticallArrays: (calls: Call[]) => {
  */
 declare const fromCallsToExecuteCalldata: (calls: Call[]) => string[];
 declare const fromCallsToExecuteCalldataWithNonce: (calls: Call[], nonce: BigNumberish) => string[];
+/**
+ * Transforms a list of Calls, each with their own calldata, into
+ * two arrays: one with the entrypoints, and one with the concatenated calldata.
+ * @param calls
+ * @returns
+ */
+declare const transformCallsToMulticallArrays_cairo1: (calls: Call[]) => CallStruct[];
+/**
+ * Transforms a list of calls in the full flattened calldata expected
+ * by the __execute__ protocol.
+ * @param calls
+ * @returns
+ */
+declare const fromCallsToExecuteCalldata_cairo1: (calls: Call[]) => string[];
+/**
+ *
+ * @param calls Call array
+ * @param cairoVersion Defaults to 0
+ * @returns string[] of calldata
+ */
+declare const getExecuteCalldata: (calls: Call[], cairoVersion?: CairoVersion) => string[];
 
 declare const transaction_transformCallsToMulticallArrays: typeof transformCallsToMulticallArrays;
 declare const transaction_fromCallsToExecuteCalldata: typeof fromCallsToExecuteCalldata;
 declare const transaction_fromCallsToExecuteCalldataWithNonce: typeof fromCallsToExecuteCalldataWithNonce;
+declare const transaction_transformCallsToMulticallArrays_cairo1: typeof transformCallsToMulticallArrays_cairo1;
+declare const transaction_fromCallsToExecuteCalldata_cairo1: typeof fromCallsToExecuteCalldata_cairo1;
+declare const transaction_getExecuteCalldata: typeof getExecuteCalldata;
 declare namespace transaction {
   export {
     transaction_transformCallsToMulticallArrays as transformCallsToMulticallArrays,
     transaction_fromCallsToExecuteCalldata as fromCallsToExecuteCalldata,
     transaction_fromCallsToExecuteCalldataWithNonce as fromCallsToExecuteCalldataWithNonce,
+    transaction_transformCallsToMulticallArrays_cairo1 as transformCallsToMulticallArrays_cairo1,
+    transaction_fromCallsToExecuteCalldata_cairo1 as fromCallsToExecuteCalldata_cairo1,
+    transaction_getExecuteCalldata as getExecuteCalldata,
   };
 }
 
@@ -3123,4 +3145,4 @@ declare class CallData {
 /** @deprecated prefer the 'num' naming */
 declare const number: typeof num;
 
-export { Abi, AbiEntry, AbiStructs, Account, AccountInterface, AllowArray, Args, AsyncContractFunction, BlockNumber, BlockTag, Builtins, ByteCode, CairoAssembly, CairoContract, Call, CallContractResponse, CallData, CallDetails, CallL1Handler, CallOptions, Calldata, CommonTransactionReceiptResponse, CommonTransactionResponse, CompiledContract, CompiledSierra, CompiledSierraCasm, CompleteDeclareContractPayload, CompressedProgram, Contract, ContractClass, ContractEntryPoint, ContractEntryPointFields, ContractFactory, ContractFunction, ContractInterface, 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, Hints, HttpError, Invocation, InvocationBulk, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeTransactionReceiptResponse, InvokeTransactionResponse, LegacyCompiledContract, LegacyContractClass, LibraryError, MessageToL1, MessageToL2, MultiDeployContractResponse, Nonce, Overrides, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, RPC, RawArgs, RawCalldata, RpcProvider, RpcProviderOptions, Sequencer, SequencerHttpMethod, SequencerIdentifier, SequencerProvider, SequencerProviderOptions, SierraContractClass, SierraContractEntryPointFields, SierraEntryPointsByType, SierraProgramDebugInfo, Signature, Signer, SignerInterface, StateUpdateResponse, Status, Storage, Struct, StructAbi, TransactionBulk, TransactionSimulation, TransactionSimulationResponse, TransactionStatus, TransactionTraceResponse, TransactionType, Tupled, UniversalDeployerContractPayload, addAddressPadding, buildUrl, constants, defaultProvider, ec, encode, getChecksumAddress, hash, isUrl, json, merkle, num, number, shortString, stark, transaction, index as typedData, uint256, validateAndParseAddress, validateChecksumAddress, waitForTransactionOptions };
+export { Abi, AbiEntry, AbiStructs, Account, AccountInterface, AllowArray, Args, AsyncContractFunction, 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, 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, Hints, HttpError, Invocation, InvocationBulk, InvocationsDetails, InvocationsDetailsWithNonce, InvocationsSignerDetails, InvokeFunctionResponse, InvokeTransactionReceiptResponse, InvokeTransactionResponse, LegacyCompiledContract, LegacyContractClass, LibraryError, MessageToL1, MessageToL2, MultiDeployContractResponse, Nonce, Overrides, ParsedStruct, Program, Provider, ProviderInterface, ProviderOptions, RPC, RawArgs, RawCalldata, RpcProvider, RpcProviderOptions, Sequencer, SequencerHttpMethod, SequencerIdentifier, SequencerProvider, SequencerProviderOptions, SierraContractClass, SierraContractEntryPointFields, SierraEntryPointsByType, SierraProgramDebugInfo, Signature, Signer, SignerInterface, StateUpdateResponse, Status, Storage, Struct, StructAbi, TransactionBulk, TransactionSimulation, TransactionSimulationResponse, TransactionStatus, TransactionTraceResponse, TransactionType, Tupled, UniversalDeployerContractPayload, addAddressPadding, buildUrl, constants, defaultProvider, ec, encode, getChecksumAddress, hash, isUrl, json, merkle, num, number, shortString, stark, transaction, index as typedData, uint256, validateAndParseAddress, validateChecksumAddress, waitForTransactionOptions };