Skip to main content

Version: Next

Class: Account

Hierarchy

Provider
↳ Account

Implements

AccountInterface

Constructors

constructor

• new Account(providerOrOptions, address, pkOrSigner, cairoVersion?, transactionVersion?)

Parameters

Name	Type	Default value
`providerOrOptions`	`ProviderOptions` \| `ProviderInterface`	`undefined`
`address`	`string`	`undefined`
`pkOrSigner`	`string` \| `Uint8Array` \| `SignerInterface`	`undefined`
`cairoVersion?`	`CairoVersion`	`undefined`
`transactionVersion`	`V2` \| `V3`	`DEFAULT_TRANSACTION_VERSION`

Overrides

Provider.constructor

Defined in

src/account/default.ts:71

Properties

signer

• signer: SignerInterface

Implementation of

AccountInterface.signer

Defined in

src/account/default.ts:63

address

• address: string

Implementation of

AccountInterface.address

Defined in

src/account/default.ts:65

cairoVersion

• cairoVersion: CairoVersion

Implementation of

AccountInterface.cairoVersion

Defined in

src/account/default.ts:67

transactionVersion

• Readonly transactionVersion: V2 | V3

Defined in

src/account/default.ts:69

deploySelf

• deploySelf: (__namedParameters: DeployAccountContractPayload, details: UniversalDetails) => Promise<DeployContractResponse>

Type declaration

▸ («destructured», details?): Promise<DeployContractResponse>

Parameters

Name	Type
`«destructured»`	`DeployAccountContractPayload`
`details`	`UniversalDetails`

Returns

Promise<DeployContractResponse>

Defined in

src/account/default.ts:480

channel

• channel: RpcChannel

Implementation of

AccountInterface.channel

Inherited from

Provider.channel

Defined in

src/provider/rpc.ts:35

getStateUpdate

• getStateUpdate: () => Promise<PENDING_STATE_UPDATE>(blockIdentifier: "pending") => Promise<PENDING_STATE_UPDATE>(blockIdentifier: "latest") => Promise<STATE_UPDATE>(blockIdentifier?: BlockIdentifier) => Promise<StateUpdateResponse>

Type declaration

▸ (): Promise<PENDING_STATE_UPDATE>

Returns

Promise<PENDING_STATE_UPDATE>

▸ (blockIdentifier): Promise<PENDING_STATE_UPDATE>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

Promise<PENDING_STATE_UPDATE>

▸ (blockIdentifier): Promise<STATE_UPDATE>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Promise<STATE_UPDATE>

▸ (blockIdentifier?): Promise<StateUpdateResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StateUpdateResponse>

Implementation of

AccountInterface.getStateUpdate

Inherited from

Provider.getStateUpdate

Defined in

src/provider/rpc.ts:98

Methods

getStarkName

▸ Static getStarkName(provider, address, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`provider`	`ProviderInterface`
`address`	`BigNumberish`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Provider.getStarkName

Defined in

src/provider/extensions/starknetId.ts:25

getAddressFromStarkName

▸ Static getAddressFromStarkName(provider, name, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`provider`	`ProviderInterface`
`name`	`string`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Provider.getAddressFromStarkName

Defined in

src/provider/extensions/starknetId.ts:58

getPreferredVersion

▸ Private getPreferredVersion(type12, type3): ETransactionVersion

Parameters

Name	Type
`type12`	`ETransactionVersion`
`type3`	`ETransactionVersion`

Returns

ETransactionVersion

Defined in

src/account/default.ts:94

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

Implementation of

AccountInterface.getNonce

Defined in

src/account/default.ts:101

getNonceSafe

▸ Private getNonceSafe(nonce?): Promise<bigint>

Parameters

Name	Type
`nonce?`	`BigNumberish`

Returns

Promise<bigint>

Defined in

src/account/default.ts:105

getCairoVersion

▸ getCairoVersion(classHash?): Promise<CairoVersion>

Retrieves the Cairo version from the network and sets cairoVersion if not already set in the constructor

Parameters

Name	Type	Description
`classHash?`	`string`	if provided detects Cairo version from classHash, otherwise from the account address

Returns

Promise<CairoVersion>

Defined in

src/account/default.ts:118

estimateFee

▸ estimateFee(calls, estimateFeeDetails?): Promise<EstimateFee>

Parameters

Name	Type
`calls`	`AllowArray`<`Call`>
`estimateFeeDetails`	`UniversalDetails`

Returns

Promise<EstimateFee>

Defined in

src/account/default.ts:128

estimateInvokeFee

▸ estimateInvokeFee(calls, details?): Promise<EstimateFee>

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
`details`	`UniversalDetails`	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<EstimateFee>

response from estimate_fee

Implementation of

AccountInterface.estimateInvokeFee

Defined in

src/account/default.ts:135

estimateDeclareFee

▸ estimateDeclareFee(payload, details?): Promise<EstimateFee>

Estimate Fee for executing a DECLARE transaction on starknet

Parameters

Name	Type	Description
`payload`	`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)
`details`	`UniversalDetails`	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<EstimateFee>

response from estimate_fee

Implementation of

AccountInterface.estimateDeclareFee

Defined in

src/account/default.ts:168

estimateAccountDeployFee

▸ estimateAccountDeployFee(«destructured», details?): Promise<EstimateFee>

Estimate Fee for executing a DEPLOY_ACCOUNT transaction on starknet

Parameters

Name	Type	Description
`«destructured»`	`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.
`details`	`UniversalDetails`	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<EstimateFee>

response from estimate_fee

Implementation of

AccountInterface.estimateAccountDeployFee

Defined in

src/account/default.ts:200

estimateDeployFee

▸ estimateDeployFee(payload, details?): Promise<EstimateFee>

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
`payload`	`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
`details`	`UniversalDetails`	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<EstimateFee>

Implementation of

AccountInterface.estimateDeployFee

Defined in

src/account/default.ts:238

estimateFeeBulk

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

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

Parameters

Name	Type
`invocations`	`Invocations`
`details`	`UniversalDetails`

Returns

Promise<EstimateFeeBulk>

response from estimate_fee

Implementation of

AccountInterface.estimateFeeBulk

Defined in

src/account/default.ts:246

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

Implementation of

AccountInterface.simulateTransaction

Defined in

src/account/default.ts:267

execute

▸ execute(calls, abis?, details?): Promise<InvokedTransaction>

Invoke execute function in account contract

Parameters

Name	Type	Default value	Description
`calls`	`AllowArray`<`Call`>	`undefined`	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
`abis`	`undefined` \| `Abi`[]	`undefined`	-
`details`	`UniversalDetails`	`{}`	-

Returns

Promise<InvokedTransaction>

response from addTransaction

Implementation of

AccountInterface.execute

Defined in

src/account/default.ts:292

declareIfNot

▸ declareIfNot(payload, transactionsDetail?): Promise<DeclaredTransaction>

First check if contract is already declared, if not declare it If contract already declared returned transaction_hash is ''. Method will pass even if contract is already declared

Parameters

Name	Type	Description
`payload`	`DeclareContractPayload`	-
`transactionsDetail`	`UniversalDetails`	(optional)

Returns

Promise<DeclaredTransaction>

Defined in

src/account/default.ts:348

declare

▸ declare(payload, details?): Promise<DeclaredTransaction>

Declares a given compiled contract (json) to starknet

Parameters

Name	Type	Description
`payload`	`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.
`details`	`UniversalDetails`	InvocationsDetails

Returns

Promise<DeclaredTransaction>

a confirmation of sending a transaction on the starknet contract

Implementation of

AccountInterface.declare

Defined in

src/account/default.ts:364

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`	`UniversalDetails`	InvocationsDetails

Returns

Promise<MultiDeployContractResponse>

contract_address[]
transaction_hash

Implementation of

AccountInterface.deploy

Defined in

src/account/default.ts:408

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`	`UniversalDetails`	InvocationsDetails

Returns

Promise<DeployContractUDCResponse>

contract_address
transaction_hash
address
deployer
unique
classHash
calldata_len
calldata
salt

Implementation of

AccountInterface.deployContract

Defined in

src/account/default.ts:454

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`	`UniversalDetails`	InvocationsDetails

Returns

Promise<DeclareDeployUDCResponse>

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

Implementation of

AccountInterface.declareAndDeploy

Defined in

src/account/default.ts:463

deployAccount

▸ deployAccount(«destructured», details?): Promise<DeployContractResponse>

Deploy the account on Starknet

Parameters

Name	Type	Description
`«destructured»`	`DeployAccountContractPayload`	transaction payload to be deployed containing: - classHash: computed class hash of compiled contract - optional constructor calldata - optional address salt - optional contractAddress
`details`	`UniversalDetails`	InvocationsDetails

Returns

Promise<DeployContractResponse>

a confirmation of sending a transaction on the starknet contract

Implementation of

AccountInterface.deployAccount

Defined in

src/account/default.ts:482

signMessage

▸ signMessage(typedData): Promise<Signature>

Sign an JSON object for off-chain usage with the starknet private key and return the signature This adds a message prefix so it cant be interchanged with transactions

Throws

if the JSON object is not a valid JSON

Parameters

Name	Type
`typedData`	`TypedData`

Returns

Promise<Signature>

the signature of the JSON object

Implementation of

AccountInterface.signMessage

Defined in

src/account/default.ts:542

hashMessage

▸ hashMessage(typedData): Promise<string>

Hash a JSON object with pederson hash and return the hash This adds a message prefix so it cant be interchanged with transactions

Throws

if the JSON object is not a valid JSON

Parameters

Name	Type
`typedData`	`TypedData`

Returns

Promise<string>

the hash of the JSON object

Implementation of

AccountInterface.hashMessage

Defined in

src/account/default.ts:546

verifyMessageHash

▸ verifyMessageHash(hash, signature): Promise<boolean>

Verify a signature of a given hash

Warning

This method is not recommended, use verifyMessage instead

Throws

if the signature is not a valid signature

Parameters

Name	Type	Description
`hash`	`BigNumberish`	hash to be verified
`signature`	`Signature`	signature of the hash

Returns

Promise<boolean>

true if the signature is valid, false otherwise

Implementation of

AccountInterface.verifyMessageHash

Defined in

src/account/default.ts:550

verifyMessage

▸ verifyMessage(typedData, signature): Promise<boolean>

Verify a signature of a JSON object

Throws

if the JSON object is not a valid JSON or the signature is not a valid signature

Parameters

Name	Type	Description
`typedData`	`TypedData`	JSON object to be verified
`signature`	`Signature`	signature of the JSON object

Returns

Promise<boolean>

true if the signature is valid, false otherwise

Implementation of

AccountInterface.verifyMessage

Defined in

src/account/default.ts:566

getUniversalSuggestedFee

▸ Private getUniversalSuggestedFee(version, «destructured», details): Promise<{ maxFee: BigNumberish ; resourceBounds: RESOURCE_BOUNDS_MAPPING }>

Parameters

Name	Type
`version`	`ETransactionVersion`
`«destructured»`	`EstimateFeeAction`
`details`	`UniversalDetails`

Returns

Promise<{ maxFee: BigNumberish ; resourceBounds: RESOURCE_BOUNDS_MAPPING }>

Defined in

src/account/default.ts:575

getSuggestedFee

▸ getSuggestedFee(«destructured», details): Promise<EstimateFee>

Gets Suggested Max Fee based on the transaction type

Parameters

Name	Type
`«destructured»`	`EstimateFeeAction`
`details`	`UniversalDetails`

Returns

Promise<EstimateFee>

EstimateFee (...response, resourceBounds, suggestedMaxFee)

Implementation of

AccountInterface.getSuggestedFee

Defined in

src/account/default.ts:598

buildInvocation

▸ buildInvocation(call, details): Promise<Invocation>

Parameters

Name	Type
`call`	`Call`[]
`details`	`InvocationsSignerDetails`

Returns

Promise<Invocation>

Defined in

src/account/default.ts:633

buildDeclarePayload

▸ buildDeclarePayload(payload, details): Promise<DeclareContractTransaction>

Parameters

Name	Type
`payload`	`DeclareContractPayload`
`details`	`InvocationsSignerDetails`

Returns

Promise<DeclareContractTransaction>

Defined in

src/account/default.ts:648

buildAccountDeployPayload

▸ buildAccountDeployPayload(«destructured», details): Promise<DeployAccountContractTransaction>

Parameters

Name	Type
`«destructured»`	`DeployAccountContractPayload`
`details`	`InvocationsSignerDetails`

Returns

Promise<DeployAccountContractTransaction>

Defined in

src/account/default.ts:678

buildUDCContractPayload

▸ buildUDCContractPayload(payload): Call[]

Parameters

Name	Type
`payload`	`UniversalDeployerContractPayload` \| `UniversalDeployerContractPayload`[]

Returns

Defined in

src/account/default.ts:709

accountInvocationsFactory

▸ accountInvocationsFactory(invocations, details): Promise<AccountInvocations>

Parameters

Name	Type
`invocations`	`Invocations`
`details`	`AccountInvocationsFactoryDetails`

Returns

Promise<AccountInvocations>

Defined in

src/account/default.ts:736

getStarkName

▸ getStarkName(address?, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`address`	`BigNumberish`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Overrides

Provider.getStarkName

Defined in

src/account/default.ts:829

fetch

▸ fetch(method, params?, id?): Promise<Response>

Parameters

Name	Type	Default value
`method`	`string`	`undefined`
`params?`	`object`	`undefined`
`id`	`string` \| `number`	`0`

Returns

Promise<Response>

Inherited from

Defined in

src/provider/rpc.ts:45

getChainId

▸ getChainId(): Promise<StarknetChainId>

Gets the Starknet chain Id

Returns

Promise<StarknetChainId>

the chain Id

Implementation of

AccountInterface.getChainId

Inherited from

Provider.getChainId

Defined in

src/provider/rpc.ts:49

getSpecVersion

▸ getSpecVersion(): Promise<string>

Returns

Promise<string>

Inherited from

Provider.getSpecVersion

Defined in

src/provider/rpc.ts:53

getNonceForAddress

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

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

Parameters

Name	Type	Description
`contractAddress`	`BigNumberish`	contract address
`blockIdentifier?`	`BlockIdentifier`	-

Returns

Promise<string>

the hex nonce

Implementation of

AccountInterface.getNonceForAddress

Inherited from

Provider.getNonceForAddress

Defined in

src/provider/rpc.ts:57

getBlock

▸ getBlock(): Promise<PendingBlock>

Gets the block information

Returns

Promise<PendingBlock>

the block object

Implementation of

AccountInterface.getBlock

Inherited from

Provider.getBlock

Defined in

src/provider/rpc.ts:64

▸ getBlock(blockIdentifier): Promise<PendingBlock>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

Promise<PendingBlock>

Implementation of

AccountInterface.getBlock

Inherited from

Provider.getBlock

Defined in

src/provider/rpc.ts:65

▸ getBlock(blockIdentifier): Promise<Block>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Promise<Block>

Implementation of

AccountInterface.getBlock

Inherited from

Provider.getBlock

Defined in

src/provider/rpc.ts:66

▸ getBlock(blockIdentifier?): Promise<GetBlockResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<GetBlockResponse>

Implementation of

AccountInterface.getBlock

Inherited from

Provider.getBlock

Defined in

src/provider/rpc.ts:67

getBlockLatestAccepted

▸ getBlockLatestAccepted(): Promise<BlockHashAndNumber>

Get the most recent accepted block hash and number

Returns

Promise<BlockHashAndNumber>

Inherited from

Provider.getBlockLatestAccepted

Defined in

src/provider/rpc.ts:77

getBlockNumber

▸ getBlockNumber(): Promise<number>

Get the most recent accepted block number redundant use getBlockLatestAccepted();

Returns

Promise<number>

Number of the latest block

Inherited from

Provider.getBlockNumber

Defined in

src/provider/rpc.ts:86

getBlockWithTxHashes

▸ getBlockWithTxHashes(blockIdentifier?): Promise<BlockWithTxHashes>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockWithTxHashes>

Inherited from

Provider.getBlockWithTxHashes

Defined in

src/provider/rpc.ts:90

getBlockWithTxs

▸ getBlockWithTxs(blockIdentifier?): Promise<BlockWithTxs>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockWithTxs>

Inherited from

Provider.getBlockWithTxs

Defined in

src/provider/rpc.ts:94

getBlockStateUpdate

▸ getBlockStateUpdate(): Promise<PENDING_STATE_UPDATE>

Returns

Promise<PENDING_STATE_UPDATE>

Inherited from

Provider.getBlockStateUpdate

Defined in

src/provider/rpc.ts:100

▸ getBlockStateUpdate(blockIdentifier): Promise<PENDING_STATE_UPDATE>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

Promise<PENDING_STATE_UPDATE>

Inherited from

Provider.getBlockStateUpdate

Defined in

src/provider/rpc.ts:101

▸ getBlockStateUpdate(blockIdentifier): Promise<STATE_UPDATE>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Promise<STATE_UPDATE>

Inherited from

Provider.getBlockStateUpdate

Defined in

src/provider/rpc.ts:102

▸ getBlockStateUpdate(blockIdentifier?): Promise<StateUpdateResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StateUpdateResponse>

Inherited from

Provider.getBlockStateUpdate

Defined in

src/provider/rpc.ts:103

getBlockTransactionsTraces

▸ getBlockTransactionsTraces(blockIdentifier?): Promise<BlockTransactionsTraces>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockTransactionsTraces>

Inherited from

Provider.getBlockTransactionsTraces

Defined in

src/provider/rpc.ts:108

getBlockTransactionCount

▸ getBlockTransactionCount(blockIdentifier?): Promise<number>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<number>

Inherited from

Provider.getBlockTransactionCount

Defined in

src/provider/rpc.ts:112

getPendingTransactions

▸ getPendingTransactions(): Promise<TransactionWithHash[]>

Return transactions from pending block

Deprecated

Instead use getBlock(BlockTag.pending); (will be removed in next minor version) Utility method, same result can be achieved using getBlockWithTxHashes(BlockTag.pending);

Returns

Promise<TransactionWithHash[]>

Inherited from

Provider.getPendingTransactions

Defined in

src/provider/rpc.ts:121

getTransaction

▸ getTransaction(txHash): Promise<TransactionWithHash>

Gets the transaction information from a tx id.

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TransactionWithHash>

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

Implementation of

AccountInterface.getTransaction

Inherited from

Provider.getTransaction

Defined in

src/provider/rpc.ts:128

getTransactionByHash

▸ getTransactionByHash(txHash): Promise<TransactionWithHash>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TransactionWithHash>

Inherited from

Provider.getTransactionByHash

Defined in

src/provider/rpc.ts:132

getTransactionByBlockIdAndIndex

▸ getTransactionByBlockIdAndIndex(blockIdentifier, index): Promise<TransactionWithHash>

Parameters

Name	Type
`blockIdentifier`	`BlockIdentifier`
`index`	`number`

Returns

Promise<TransactionWithHash>

Inherited from

Provider.getTransactionByBlockIdAndIndex

Defined in

src/provider/rpc.ts:136

getTransactionReceipt

▸ getTransactionReceipt(txHash): Promise<INVOKE_TXN_RECEIPT | PENDING_INVOKE_TXN_RECEIPT | DECLARE_TXN_RECEIPT | PENDING_DECLARE_TXN_RECEIPT | DEPLOY_ACCOUNT_TXN_RECEIPT | PENDING_DEPLOY_ACCOUNT_TXN_RECEIPT | DEPLOY_TXN_RECEIPT | L1_HANDLER_TXN_RECEIPT | PENDING_L1_HANDLER_TXN_RECEIPT>

Gets the transaction receipt from a tx hash.

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<INVOKE_TXN_RECEIPT | PENDING_INVOKE_TXN_RECEIPT | DECLARE_TXN_RECEIPT | PENDING_DECLARE_TXN_RECEIPT | DEPLOY_ACCOUNT_TXN_RECEIPT | PENDING_DEPLOY_ACCOUNT_TXN_RECEIPT | DEPLOY_TXN_RECEIPT | L1_HANDLER_TXN_RECEIPT | PENDING_L1_HANDLER_TXN_RECEIPT>

the transaction receipt object

Implementation of

AccountInterface.getTransactionReceipt

Inherited from

Provider.getTransactionReceipt

Defined in

src/provider/rpc.ts:140

getTransactionTrace

▸ getTransactionTrace(txHash): Promise<TRANSACTION_TRACE>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TRANSACTION_TRACE>

Inherited from

Provider.getTransactionTrace

Defined in

src/provider/rpc.ts:146

getTransactionStatus

▸ getTransactionStatus(transactionHash): Promise<TransactionStatus>

Get the status of a transaction

Parameters

Name	Type
`transactionHash`	`BigNumberish`

Returns

Promise<TransactionStatus>

Inherited from

Provider.getTransactionStatus

Defined in

src/provider/rpc.ts:153

getSimulateTransaction

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

Parameters

Name	Type	Description
`invocations`	`AccountInvocations`	AccountInvocations
`options?`	`getSimulateTransactionOptions`	-

Returns

Promise<SimulateTransactionResponse>

Implementation of

AccountInterface.getSimulateTransaction

Inherited from

Provider.getSimulateTransaction

Defined in

src/provider/rpc.ts:164

waitForTransaction

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

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<TXN_RECEIPT>

GetTransactionReceiptResponse

Implementation of

AccountInterface.waitForTransaction

Inherited from

Provider.waitForTransaction

Defined in

src/provider/rpc.ts:174

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`	`BigNumberish`
`key`	`BigNumberish`	from getStorageVarAddress('<STORAGE_VARIABLE_NAME>') (WIP)
`blockIdentifier?`	`BlockIdentifier`	block identifier

Returns

Promise<string>

the value of the storage variable

Implementation of

AccountInterface.getStorageAt

Inherited from

Provider.getStorageAt

Defined in

src/provider/rpc.ts:178

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`	`BigNumberish`	contract address
`blockIdentifier?`	`BlockIdentifier`	block identifier

Returns

Promise<string>

Class hash

Implementation of

AccountInterface.getClassHashAt

Inherited from

Provider.getClassHashAt

Defined in

src/provider/rpc.ts:186

getClassByHash

▸ getClassByHash(classHash): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Returns the contract class deployed under the given class hash.

Parameters

Name	Type	Description
`classHash`	`BigNumberish`	class hash

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Contract class of compiled contract

Implementation of

AccountInterface.getClassByHash

Inherited from

Provider.getClassByHash

Defined in

src/provider/rpc.ts:190

getClass

▸ getClass(classHash, blockIdentifier?): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Parameters

Name	Type
`classHash`	`BigNumberish`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Inherited from

Provider.getClass

Defined in

src/provider/rpc.ts:194

getClassAt

▸ getClassAt(contractAddress, blockIdentifier?): Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Gets the contract class of the deployed contract.

Parameters

Name	Type	Description
`contractAddress`	`BigNumberish`	contract address
`blockIdentifier?`	`BlockIdentifier`	block identifier

Returns

Promise<LegacyContractClass | Omit<CompiledSierra, "sierra_program_debug_info">>

Contract class of compiled contract

Implementation of

AccountInterface.getClassAt

Inherited from

Provider.getClassAt

Defined in

src/provider/rpc.ts:200

getContractVersion

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

Gets the contract version from the provided address

Parameters

Name	Type	Description
`contractAddress`	`BigNumberish`	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>

Implementation of

AccountInterface.getContractVersion

Inherited from

Provider.getContractVersion

Defined in

src/provider/rpc.ts:206

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

Gets the contract version from the provided address

Parameters

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

Returns

Promise<ContractVersion>

Implementation of

AccountInterface.getContractVersion

Inherited from

Provider.getContractVersion

Defined in

src/provider/rpc.ts:211

getEstimateFee

▸ getEstimateFee(invocation, invocationDetails, blockIdentifier?, skipValidate?): Promise<EstimateFeeResponse>

Deprecated

use gettypeEstimateFee (will be refactored based on type after sequencer deprecation)

Parameters

Name	Type
`invocation`	`Invocation`
`invocationDetails`	`InvocationsDetailsWithNonce`
`blockIdentifier?`	`BlockIdentifier`
`skipValidate?`	`boolean`

Returns

Promise<EstimateFeeResponse>

Implementation of

AccountInterface.getEstimateFee

Inherited from

Provider.getEstimateFee

Defined in

src/provider/rpc.ts:247

getInvokeEstimateFee

▸ getInvokeEstimateFee(invocation, invocationDetails, 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
`invocationDetails`	`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

Implementation of

AccountInterface.getInvokeEstimateFee

Inherited from

Provider.getInvokeEstimateFee

Defined in

src/provider/rpc.ts:256

getDeclareEstimateFee

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

Estimates the fee for a given DECLARE transaction

Parameters

Name	Type	Description
`invocation`	`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

Implementation of

AccountInterface.getDeclareEstimateFee

Inherited from

Provider.getDeclareEstimateFee

Defined in

src/provider/rpc.ts:276

getDeployAccountEstimateFee

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

Estimates the fee for a given DEPLOY_ACCOUNT transaction

Parameters

Name	Type	Description
`invocation`	`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

Implementation of

AccountInterface.getDeployAccountEstimateFee

Inherited from

Provider.getDeployAccountEstimateFee

Defined in

src/provider/rpc.ts:296

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

Implementation of

AccountInterface.getEstimateFeeBulk

Inherited from

Provider.getEstimateFeeBulk

Defined in

src/provider/rpc.ts:316

invokeFunction

▸ invokeFunction(functionInvocation, details): Promise<InvokedTransaction>

Invokes a function on starknet

Deprecated

This method wont be supported as soon as fees are mandatory. Should not be used outside of Account class

Parameters

Name	Type	Description
`functionInvocation`	`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<InvokedTransaction>

response from addTransaction

Implementation of

AccountInterface.invokeFunction

Inherited from

Provider.invokeFunction

Defined in

src/provider/rpc.ts:325

declareContract

▸ declareContract(transaction, details): Promise<DeclaredTransaction>

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<DeclaredTransaction>

a confirmation of sending a transaction on the starknet contract

Implementation of

AccountInterface.declareContract

Inherited from

Provider.declareContract

Defined in

src/provider/rpc.ts:332

deployAccountContract

▸ deployAccountContract(transaction, details): Promise<DeployedAccountTransaction>

Deploys a given compiled Account contract (json) to starknet

Parameters

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

Returns

Promise<DeployedAccountTransaction>

a confirmation of sending a transaction on the starknet contract

Implementation of

AccountInterface.deployAccountContract

Inherited from

Provider.deployAccountContract

Defined in

src/provider/rpc.ts:339

callContract

▸ callContract(call, blockIdentifier?): Promise<string[]>

Calls a function on the Starknet contract.

Parameters

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

Returns

Promise<string[]>

the result of the function on the smart contract.

Implementation of

AccountInterface.callContract

Inherited from

Provider.callContract

Defined in

src/provider/rpc.ts:349

estimateMessageFee

▸ estimateMessageFee(message, blockIdentifier?): Promise<FEE_ESTIMATE>

NEW: Estimate the fee for a message from L1

Parameters

Name	Type	Description
`message`	`MSG_FROM_L1`	Message From L1
`blockIdentifier?`	`BlockIdentifier`	-

Returns

Promise<FEE_ESTIMATE>

Inherited from

Provider.estimateMessageFee

Defined in

src/provider/rpc.ts:357

getSyncingStats

▸ getSyncingStats(): Promise<Syncing>

Returns an object about the sync status, or false if the node is not synching

Returns

Promise<Syncing>

Object with the stats data

Inherited from

Provider.getSyncingStats

Defined in

src/provider/rpc.ts:365

getEvents

▸ getEvents(eventFilter): Promise<EVENTS_CHUNK>

Returns all events matching the given filter

Parameters

Name	Type
`eventFilter`	`EventFilter`

Returns

Promise<EVENTS_CHUNK>

events and the pagination of the events

Inherited from

Provider.getEvents

Defined in

src/provider/rpc.ts:373

getAddressFromStarkName

▸ getAddressFromStarkName(name, StarknetIdContract?): Promise<string>

Parameters

Name	Type
`name`	`string`
`StarknetIdContract?`	`string`

Returns

Promise<string>

Inherited from

Provider.getAddressFromStarkName

Defined in

src/provider/extensions/starknetId.ts:16

Hierarchy
Implements
Constructors
- constructor
Properties
Methods