Class: AccountInterface

Hierarchy

• ProviderInterface

  ↳ AccountInterface

Implemented by

• Account
• WalletAccount

Constructors

constructor

• new AccountInterface(): AccountInterface

Returns

AccountInterface

Inherited from

ProviderInterface.constructor

Properties

address

• Abstract address: string

Defined in

src/account/interface.ts:37

---

signer

• Abstract signer: SignerInterface

Defined in

src/account/interface.ts:39

---

cairoVersion

• Abstract cairoVersion: CairoVersion

Defined in

src/account/interface.ts:41

---

channel

• Abstract channel: RpcChannel | RpcChannel

Inherited from

ProviderInterface.channel

Defined in

src/provider/interface.ts:37

Methods

estimateInvokeFee

▸ estimateInvokeFee(calls, estimateFeeDetails?): Promise<EstimateFeeResponse>

Estimate Fee for executing an INVOKE transaction on starknet

Parameters

Name	Type	Description
calls	AllowArray<Call>	the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata? - (defaults to []) the calldata
estimateFeeDetails?	EstimateFeeDetails	blockIdentifier? - nonce? = 0 - skipValidate? - default true - tip? - prioritize order of transactions in the mempool. - accountDeploymentData? - deploy an account contract (substitution for deploy account transaction) - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337) - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei

Returns

Promise<EstimateFeeResponse>

response from estimate_fee

Defined in

src/account/interface.ts:64

---

estimateDeclareFee

▸ estimateDeclareFee(contractPayload, estimateFeeDetails?): Promise<EstimateFeeResponse>

Estimate Fee for executing a DECLARE transaction on starknet

Parameters

Name	Type	Description
contractPayload	DeclareContractPayload	the payload object containing: - contract - the compiled contract to be declared - casm? - compiled cairo assembly. Cairo1(casm or compiledClassHash are required) - classHash? - the class hash of the compiled contract. Precalculate for faster execution. - compiledClassHash?: class hash of the cairo assembly. Cairo1(casm or compiledClassHash are required)
estimateFeeDetails?	EstimateFeeDetails	blockIdentifier? - nonce? = 0 - skipValidate? - default true - tip? - prioritize order of transactions in the mempool. - accountDeploymentData? - deploy an account contract (substitution for deploy account transaction) - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337) - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei

Returns

Promise<EstimateFeeResponse>

response from estimate_fee

Defined in

src/account/interface.ts:91

---

estimateAccountDeployFee

▸ estimateAccountDeployFee(contractPayload, estimateFeeDetails?): Promise<EstimateFeeResponse>

Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet

Parameters

Name	Type	Description
contractPayload	DeployAccountContractPayload	classHash - the class hash of the compiled contract. - constructorCalldata? - constructor data; - contractAddress? - future account contract address. Precalculate for faster execution. - addressSalt? - salt used for calculation of the contractAddress. Required if contractAddress is provided.
estimateFeeDetails?	EstimateFeeDetails	blockIdentifier? - nonce? = 0 - skipValidate? - default true - tip? - prioritize order of transactions in the mempool. - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337) - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei

Returns

Promise<EstimateFeeResponse>

response from estimate_fee

Defined in

src/account/interface.ts:117

---

estimateDeployFee

▸ estimateDeployFee(deployContractPayload, estimateFeeDetails?): Promise<EstimateFeeResponse>

Estimate Fee for executing a UDC DEPLOY transaction on starknet This is different from the normal DEPLOY transaction as it goes through the Universal Deployer Contract (UDC)

Parameters

Name	Type	Description
deployContractPayload	UniversalDeployerContractPayload | UniversalDeployerContractPayload[]	array or singular - classHash: computed class hash of compiled contract - salt: address salt - unique: bool if true ensure unique salt - constructorCalldata: constructor calldata
estimateFeeDetails?	EstimateFeeDetails	blockIdentifier? - nonce? - skipValidate? - default true - tip? - prioritize order of transactions in the mempool. - accountDeploymentData? - deploy an account contract (substitution for deploy account transaction) - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337) - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei

Returns

Promise<EstimateFeeResponse>

Defined in

src/account/interface.ts:143

---

estimateFeeBulk

▸ estimateFeeBulk(invocations, details?): Promise<EstimateFeeResponseBulk>

Estimate Fee for executing a list of transactions on starknet Contract must be deployed for fee estimation to be possible

Parameters

Name	Type	Description
invocations	Invocations	array of transaction object containing : - type - the type of transaction : 'DECLARE' | (multi)'DEPLOY' | (multi)'INVOKE_FUNCTION' | 'DEPLOY_ACCOUNT' - payload - the payload of the transaction
details?	EstimateFeeDetails	blockIdentifier? - nonce? - skipValidate? - default true - tip? - prioritize order of transactions in the mempool. - accountDeploymentData? - deploy an account contract (substitution for deploy account transaction) - paymasterData? - entity other than the transaction sender to pay the transaction fees(EIP-4337) - nonceDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - feeDataAvailabilityMode? - allows users to choose their preferred data availability mode (Volition) - version? - specify ETransactionVersion - V3 Transactions fee is in fri, oldV transactions fee is in wei

Returns

Promise<EstimateFeeResponseBulk>

response from estimate_fee

Defined in

src/account/interface.ts:169

---

getSuggestedFee

▸ getSuggestedFee(estimateFeeAction, details): Promise<EstimateFee>

Gets Suggested Max Fee based on the transaction type

Parameters

Name	Type
estimateFeeAction	EstimateFeeAction
details	EstimateFeeDetails

Returns

Promise<EstimateFee>

EstimateFee (...response, resourceBounds, suggestedMaxFee)

Defined in

src/account/interface.ts:181

---

simulateTransaction

▸ simulateTransaction(invocations, details?): Promise<SimulateTransactionResponse>

Simulates an array of transaction and returns an array of transaction trace and estimated fee.

Parameters

Name	Type	Description
invocations	Invocations	Invocations containing: - type - transaction type: DECLARE, (multi)DEPLOY, DEPLOY_ACCOUNT, (multi)INVOKE_FUNCTION
details?	SimulateTransactionDetails	SimulateTransactionDetails

Returns

Promise<SimulateTransactionResponse>

response from simulate_transaction

Defined in

src/account/interface.ts:195

---

execute

▸ execute(transactions, transactionsDetail?): Promise<{ transaction_hash: string }>

Invoke execute function in account contract

Parameters

Name	Type	Description
transactions	AllowArray<Call>	the invocation object or an array of them, containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata - signature - (defaults to []) the signature
transactionsDetail?	InvocationsDetails	Additional optional parameters for the transaction

Returns

Promise<{ transaction_hash: string }>

response from addTransaction

Defined in

src/account/interface.ts:212

---

estimatePaymasterTransactionFee

▸ estimatePaymasterTransactionFee(calls, paymasterDetails): Promise<PaymasterFeeEstimate>

Estimate Fee for executing a paymaster transaction on starknet

Parameters

Name	Type	Description
calls	Call[]	the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata
paymasterDetails	PaymasterDetails	the paymaster details containing: - feeMode - the fee mode - deploymentData - the deployment data (optional) - timeBounds - the time bounds (optional)

Returns

Promise<PaymasterFeeEstimate>

response extracting fee from buildPaymasterTransaction

Defined in

src/account/interface.ts:232

---

buildPaymasterTransaction

▸ buildPaymasterTransaction(calls, paymasterDetails): Promise<PreparedTransaction>

Build a paymaster transaction

Parameters

Name	Type	Description
calls	Call[]	the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata
paymasterDetails	PaymasterDetails	the paymaster details containing: - feeMode - the fee mode - deploymentData - the deployment data (optional) - timeBounds - the time bounds (optional)

Returns

Promise<PreparedTransaction>

the prepared transaction

Defined in

src/account/interface.ts:252

---

executePaymasterTransaction

▸ executePaymasterTransaction(calls, paymasterDetails, maxFeeInGasToken?): Promise<{ transaction_hash: string }>

Execute a paymaster transaction

Assert that the gas token value is equal to the provided gas fees Assert that the calls are strictly equal to the returned calls. Assert that the gas token (in gas token) price is not too high, if provided. Assert that typedData to signed is strictly equal to the provided typedData.

Parameters

Name	Type	Description
calls	Call[]	the invocation object containing: - contractAddress - the address of the contract - entrypoint - the entrypoint of the contract - calldata - (defaults to []) the calldata
paymasterDetails	PaymasterDetails	the paymaster details containing: - feeMode - the fee mode (sponsored or default) - deploymentData - the deployment data (optional) - timeBounds - the time bounds when the transaction is valid (optional) - executeAfter and executeBefore expected to be in seconds (BLOCK_TIMESTAMP)
maxFeeInGasToken?	BigNumberish	the max fee acceptable to pay in gas token (optional)

Returns

Promise<{ transaction_hash: string }>

the tarnsaction hash if successful, otherwise an error is thrown

Defined in

src/account/interface.ts:279

---

declare

▸ declare(contractPayload, transactionsDetail?): Promise<{ class_hash: string ; transaction_hash: string }>

Declares a given compiled contract (json) to starknet

Parameters

Name	Type	Description
contractPayload	DeclareContractPayload	transaction payload to be deployed containing: - contract: compiled contract code - (optional) classHash: computed class hash of compiled contract. Pre-compute it for faster execution. - (required for Cairo1 without compiledClassHash) casm: CompiledContract | string; - (optional for Cairo1 with casm) compiledClassHash: compiled class hash from casm. Pre-compute it for faster execution.
transactionsDetail?	InvocationsDetails	InvocationsDetails

Returns

Promise<{ class_hash: string ; transaction_hash: string }>

a confirmation of sending a transaction on the starknet contract

Defined in

src/account/interface.ts:297

---

deploy

▸ deploy(payload, details?): Promise<MultiDeployContractResponse>

Deploys a declared contract to starknet - using Universal Deployer Contract (UDC) support multicall

Parameters

Name	Type	Description
payload	UniversalDeployerContractPayload | UniversalDeployerContractPayload[]	classHash: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt
details?	InvocationsDetails	InvocationsDetails

Returns

Promise<MultiDeployContractResponse>

• contract_address[]
• transaction_hash

Defined in

src/account/interface.ts:317

---

deployContract

▸ deployContract(payload, details?): Promise<DeployContractUDCResponse>

Simplify deploy simulating old DeployContract with same response + UDC specific response Internal wait for L2 transaction, support multicall

Parameters

Name	Type	Description
payload	UniversalDeployerContractPayload | UniversalDeployerContractPayload[]	classHash: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt
details?	InvocationsDetails	InvocationsDetails

Returns

Promise<DeployContractUDCResponse>

• contract_address
• transaction_hash
• address
• deployer
• unique
• classHash
• calldata_len
• calldata
• salt

Defined in

src/account/interface.ts:344

---

declareAndDeploy

▸ declareAndDeploy(payload, details?): Promise<DeclareDeployUDCResponse>

Declares and Deploy a given compiled contract (json) to starknet using UDC Internal wait for L2 transaction, do not support multicall Method will pass even if contract is already declared (internal using DeclareIfNot)

Parameters

Name	Type	Description
payload	DeclareAndDeployContractPayload	contract: compiled contract code - [casm=cairo1]: CairoAssembly | undefined; - [compiledClassHash]: string | undefined; - [classHash]: computed class hash of compiled contract - [constructorCalldata] contract constructor calldata - [salt=pseudorandom] deploy address salt - [unique=true] ensure unique salt
details?	InvocationsDetails	InvocationsDetails

Returns

Promise<DeclareDeployUDCResponse>

• declare
  • transaction_hash
• deploy
  • contract_address
  • transaction_hash
  • address
  • deployer
  • unique
  • classHash
  • calldata_len
  • calldata
  • salt

Defined in

src/account/interface.ts:378

---

deployAccount

▸ deployAccount(contractPayload, transactionsDetail?): Promise<DeployContractResponse>

Deploy the account on Starknet

Parameters

Name	Type	Description
contractPayload	DeployAccountContractPayload	transaction payload to be deployed containing: - classHash: computed class hash of compiled contract - optional constructor calldata - optional address salt - optional contractAddress
transactionsDetail?	InvocationsDetails	InvocationsDetails

Returns

Promise<DeployContractResponse>

a confirmation of sending a transaction on the starknet contract

Defined in

src/account/interface.ts:395

---

signMessage

▸ signMessage(typedData): Promise<Signature>

Signs a TypedData object for off-chain usage with the Starknet private key and returns the signature This adds a message prefix so it can't be interchanged with transactions

Parameters

Name	Type	Description
typedData	TypedData	TypedData object to be signed

Returns

Promise<Signature>

the signature of the TypedData object

Throws

if typedData is not a valid TypedData

Defined in

src/account/interface.ts:408

---

hashMessage

▸ hashMessage(typedData): Promise<string>

Hash a TypedData object with Pedersen hash and return the hash This adds a message prefix so it can't be interchanged with transactions

Parameters

Name	Type	Description
typedData	TypedData	TypedData object to be hashed

Returns

Promise<string>

the hash of the TypedData object

Throws

if typedData is not a valid TypedData

Defined in

src/account/interface.ts:418

---

getNonce

▸ getNonce(blockIdentifier?): Promise<string>

Gets the nonce of the account with respect to a specific block

Parameters

Name	Type	Description
blockIdentifier?	BlockIdentifier	optional blockIdentifier. Defaults to 'pending'

Returns

Promise<string>

nonce of the account

Defined in

src/account/interface.ts:426

---

getChainId

▸ getChainId(): Promise<"0x534e5f4d41494e" | "0x534e5f5345504f4c4941">

Gets the Starknet chain Id

Returns

Promise<"0x534e5f4d41494e" | "0x534e5f5345504f4c4941">

the chain Id

Inherited from

ProviderInterface.getChainId

Defined in

src/provider/interface.ts:44

---

callContract

▸ callContract(call, blockIdentifier?): Promise<CallContractResponse>

Calls a function on the Starknet contract.

Parameters

Name	Type	Description
call	Call	transaction to be called
blockIdentifier?	BlockIdentifier	block identifier

Returns

Promise<CallContractResponse>

the result of the function on the smart contract.

Inherited from

ProviderInterface.callContract

Defined in

src/provider/interface.ts:53

---

getBlock

▸ getBlock(blockIdentifier?): Promise<{ transactions: string[] ; parent_hash: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string }>

Gets the block information

Parameters

Name	Type	Description
blockIdentifier?	"pending"	block identifier

Returns

Promise<{ transactions: string[] ; parent_hash: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string }>

the block object

Inherited from

ProviderInterface.getBlock

Defined in

src/provider/interface.ts:64

▸ getBlock(blockIdentifier): Promise<{ status: BLOCK_STATUS ; block_hash: string ; parent_hash: string ; block_number: number ; new_root: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string ; transactions: string[] }>

Parameters

Name	Type
blockIdentifier	"latest"

Returns

Promise<{ status: BLOCK_STATUS ; block_hash: string ; parent_hash: string ; block_number: number ; new_root: string ; timestamp: number ; sequencer_address: string ; l1_gas_price: RESOURCE_PRICE ; l2_gas_price: RESOURCE_PRICE ; l1_data_gas_price: RESOURCE_PRICE ; l1_da_mode: L1_DA_MODE ; starknet_version: string ; transactions: string[] }>

Inherited from

ProviderInterface.getBlock

Defined in

src/provider/interface.ts:65

▸ getBlock(blockIdentifier): Promise<GetBlockResponse>

Parameters

Name	Type
blockIdentifier	BlockIdentifier

Returns

Promise<GetBlockResponse>

Inherited from

ProviderInterface.getBlock

Defined in

src/provider/interface.ts:66

---

getClassAt

▸ getClassAt(contractAddress, blockIdentifier?): Promise<ContractClassResponse>

Gets the contract class of the deployed contract.

Parameters

Name	Type	Description
contractAddress	string	contract address
blockIdentifier?	BlockIdentifier	block identifier

Returns

Promise<ContractClassResponse>

Contract class of compiled contract

Inherited from

ProviderInterface.getClassAt

Defined in

src/provider/interface.ts:75

---

getL1GasPrice

▸ getL1GasPrice(blockIdentifier): Promise<string>

Gets the price of l1 gas in the block

Parameters

Name	Type	Description
blockIdentifier	BlockIdentifier	block identifier

Returns

Promise<string>

gas price of the block

Inherited from

ProviderInterface.getL1GasPrice

Defined in

src/provider/interface.ts:86

---

getL1MessageHash

▸ getL1MessageHash(l2TxHash): Promise<string>

Get L1 message hash from L2 transaction hash

Parameters

Name	Type	Description
l2TxHash	BigNumberish	L2 transaction hash

Returns

Promise<string>

Hex string of L1 message hash

Example

In Sepolia Testnet :

const result = provider.getL1MessageHash(
  '0x28dfc05eb4f261b37ddad451ff22f1d08d4e3c24dc646af0ec69fa20e096819'
);
// result = '0x55b3f8b6e607fffd9b4d843dfe8f9b5c05822cd94fcad8797deb01d77805532a'

Inherited from

ProviderInterface.getL1MessageHash

Defined in

src/provider/interface.ts:99

---

getClassHashAt

▸ getClassHashAt(contractAddress, blockIdentifier?): Promise<string>

Returns the contract class hash in the given block for the contract deployed at the given address

Parameters

Name	Type	Description
contractAddress	string	contract address
blockIdentifier?	BlockIdentifier	block identifier

Returns

Promise<string>

Class hash

Inherited from

ProviderInterface.getClassHashAt

Defined in

src/provider/interface.ts:108

---

getClassByHash

▸ getClassByHash(classHash): Promise<ContractClassResponse>

Returns the contract class deployed under the given class hash.

Parameters

Name	Type	Description
classHash	string	class hash

Returns

Promise<ContractClassResponse>

Contract class of compiled contract

Inherited from

ProviderInterface.getClassByHash

Defined in

src/provider/interface.ts:119

---

getNonceForAddress

▸ getNonceForAddress(contractAddress, blockIdentifier?): Promise<string>

Returns the nonce associated with the given address in the given block

Parameters

Name	Type	Description
contractAddress	string	contract address
blockIdentifier?	BlockIdentifier	-

Returns

Promise<string>

the hex nonce

Inherited from

ProviderInterface.getNonceForAddress

Defined in

src/provider/interface.ts:127

---

getStorageAt

▸ getStorageAt(contractAddress, key, blockIdentifier?): Promise<string>

Get the value of the storage (contract's variable) at the given address and key

Parameters

Name	Type	Description
contractAddress	string
key	BigNumberish	from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
blockIdentifier?	BlockIdentifier	block identifier

Returns

Promise<string>

the value of the storage variable

Inherited from

ProviderInterface.getStorageAt

Defined in

src/provider/interface.ts:140

---

getTransaction

▸ getTransaction(transactionHash): Promise<TransactionWithHash>

Gets the transaction information from a tx id.

Parameters

Name	Type
transactionHash	BigNumberish

Returns

Promise<TransactionWithHash>

the transaction object { transaction_id, status, transaction, block_number?, block_number?, transaction_index?, transaction_failure_reason? }

Inherited from

ProviderInterface.getTransaction

Defined in

src/provider/interface.ts:152

---

getTransactionReceipt

▸ getTransactionReceipt(transactionHash): Promise<GetTransactionReceiptResponse>

Gets the transaction receipt from a tx hash.

Parameters

Name	Type
transactionHash	BigNumberish

Returns

Promise<GetTransactionReceiptResponse>

the transaction receipt object

Inherited from

ProviderInterface.getTransactionReceipt

Defined in

src/provider/interface.ts:160

---

deployAccountContract

▸ deployAccountContract(payload, details): Promise<DeployContractResponse>

Deploys a given compiled Account contract (json) to starknet

Parameters

Name	Type	Description
payload	DeployAccountContractPayload	payload to be deployed containing: - compiled contract code - constructor calldata - address salt
details	InvocationsDetailsWithNonce	-

Returns

Promise<DeployContractResponse>

a confirmation of sending a transaction on the starknet contract

Inherited from

ProviderInterface.deployAccountContract

Defined in

src/provider/interface.ts:173

---

invokeFunction

▸ invokeFunction(invocation, details): Promise<{ transaction_hash: string }>

Invokes a function on starknet

Parameters

Name	Type	Description
invocation	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
details	InvocationsDetailsWithNonce	optional details containing: - nonce - optional nonce - version - optional version - maxFee - optional maxFee

Returns

Promise<{ transaction_hash: string }>

response from addTransaction

Inherited from

ProviderInterface.invokeFunction

Defined in

src/provider/interface.ts:192

---

declareContract

▸ declareContract(transaction, details): Promise<{ class_hash: string ; transaction_hash: string }>

Declares a given compiled contract (json) to starknet

Parameters

Name	Type	Description
transaction	DeclareContractTransaction	transaction payload to be deployed containing: - compiled contract code - sender address - signature
details	InvocationsDetailsWithNonce	Invocation Details containing: - nonce - optional version - optional maxFee

Returns

Promise<{ class_hash: string ; transaction_hash: string }>

a confirmation of sending a transaction on the starknet contract

Inherited from

ProviderInterface.declareContract

Defined in

src/provider/interface.ts:209

---

getInvokeEstimateFee

▸ getInvokeEstimateFee(invocation, details, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponse>

Estimates the fee for a given INVOKE transaction

Parameters

Name	Type	Description
invocation	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
details	InvocationsDetailsWithNonce	optional details containing: - nonce - optional nonce - version - optional version
blockIdentifier?	BlockIdentifier	(optional) block identifier
skipValidate?	boolean	(optional) skip cairo validate method

Returns

Promise<EstimateFeeResponse>

the estimated fee

Inherited from

ProviderInterface.getInvokeEstimateFee

Defined in

src/provider/interface.ts:229

---

getDeclareEstimateFee

▸ getDeclareEstimateFee(transaction, details, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponse>

Estimates the fee for a given DECLARE transaction

Parameters

Name	Type	Description
transaction	DeclareContractTransaction	transaction payload to be declared containing: - compiled contract code - sender address - signature - (defaults to []) the signature
details	InvocationsDetailsWithNonce	optional details containing: - nonce - version - optional version - optional maxFee
blockIdentifier?	BlockIdentifier	(optional) block identifier
skipValidate?	boolean	(optional) skip cairo validate method

Returns

Promise<EstimateFeeResponse>

the estimated fee

Inherited from

ProviderInterface.getDeclareEstimateFee

Defined in

src/provider/interface.ts:251

---

getDeployAccountEstimateFee

▸ getDeployAccountEstimateFee(transaction, details, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponse>

Estimates the fee for a given DEPLOY_ACCOUNT transaction

Parameters

Name	Type	Description
transaction	DeployAccountContractTransaction	transaction payload to be deployed containing: - classHash - constructorCalldata - addressSalt - signature - (defaults to []) the signature
details	InvocationsDetailsWithNonce	optional details containing: - nonce - version - optional version - optional maxFee
blockIdentifier?	BlockIdentifier	(optional) block identifier
skipValidate?	boolean	(optional) skip cairo validate method

Returns

Promise<EstimateFeeResponse>

the estimated fee

Inherited from

ProviderInterface.getDeployAccountEstimateFee

Defined in

src/provider/interface.ts:274

---

getEstimateFeeBulk

▸ getEstimateFeeBulk(invocations, options?): Promise<EstimateFeeResponseBulk>

Estimates the fee for a list of INVOKE transaction

Parameters

Name	Type	Description
invocations	AccountInvocations	AccountInvocations - Complete invocations array with account details
options?	getEstimateFeeBulkOptions	getEstimateFeeBulkOptions - (optional) blockIdentifier - BlockIdentifier

Returns

Promise<EstimateFeeResponseBulk>

the estimated fee

Inherited from

ProviderInterface.getEstimateFeeBulk

Defined in

src/provider/interface.ts:289

---

waitForTransaction

▸ waitForTransaction(txHash, options?): Promise<GetTransactionReceiptResponse>

Wait for the transaction to be accepted

Parameters

Name	Type	Description
txHash	BigNumberish	transaction hash
options?	waitForTransactionOptions	waitForTransactionOptions - (optional) retryInterval: number | undefined; - (optional) successStates: TransactionStatus[] | undefined;

Returns

Promise<GetTransactionReceiptResponse>

GetTransactionReceiptResponse

Inherited from

ProviderInterface.waitForTransaction

Defined in

src/provider/interface.ts:302

---

getSimulateTransaction

▸ getSimulateTransaction(invocations, options?): Promise<SimulateTransactionResponse>

Simulates the transaction and returns the transaction trace and estimated fee.

Parameters

Name	Type	Description
invocations	AccountInvocations	AccountInvocations - Complete invocations array with account details
options?	getSimulateTransactionOptions	getSimulateTransactionOptions - (optional) blockIdentifier - block identifier - (optional) skipValidate - skip cairo validate method - (optional) skipExecute - skip cairo execute method

Returns

Promise<SimulateTransactionResponse>

an array of transaction trace and estimated fee

Inherited from

ProviderInterface.getSimulateTransaction

Defined in

src/provider/interface.ts:317

---

getStateUpdate

▸ getStateUpdate(blockIdentifier?): Promise<StateUpdateResponse>

Gets the state changes in a specific block (result of executing the requested block)

Parameters

Name	Type	Description
blockIdentifier?	BlockIdentifier	block identifier

Returns

Promise<StateUpdateResponse>

StateUpdateResponse

Inherited from

ProviderInterface.getStateUpdate

Defined in

src/provider/interface.ts:328

---

getContractVersion

▸ getContractVersion(contractAddress, classHash?, options?): Promise<ContractVersion>

Gets the contract version from the provided address

Parameters

Name	Type	Description
contractAddress	string	string
classHash?	undefined	undefined
options?	getContractVersionOptions	getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier

Returns

Promise<ContractVersion>

Inherited from

ProviderInterface.getContractVersion

Defined in

src/provider/interface.ts:338

▸ getContractVersion(contractAddress, classHash, options?): Promise<ContractVersion>

Gets the contract version from the provided address

Parameters

Name	Type	Description
contractAddress	undefined	undefined
classHash	string
options?	getContractVersionOptions	getContractVersionOptions - (optional) compiler - (default true) extract compiler version using type tactic from abi - (optional) blockIdentifier - block identifier

Returns

Promise<ContractVersion>

Inherited from

ProviderInterface.getContractVersion

Defined in

src/provider/interface.ts:352