Version: 7.6.4

Class: WalletAccount

Hierarchy

Account

↳ WalletAccount

Implements

AccountInterface

Constructors

constructor

• new WalletAccount(providerOrOptions, walletProvider, address, cairoVersion?, paymaster?): WalletAccount

Parameters

Name	Type
`providerOrOptions`	`ProviderOptions` \| `ProviderInterface`
`walletProvider`	`StarknetWalletProvider`
`address`	`string`
`cairoVersion?`	`CairoVersion`
`paymaster?`	`PaymasterOptions` \| `PaymasterInterface`

Properties

walletProvider

• walletProvider: StarknetWalletProvider

Defined in

src/wallet/account.ts:44

signer

• signer: SignerInterface

Implementation of

AccountInterface.signer

Inherited from

Account.signer

Defined in

src/account/default.ts:98

address

• address: string

Implementation of

AccountInterface.address

Inherited from

Account.address

Defined in

src/account/default.ts:100

cairoVersion

• cairoVersion: CairoVersion

Implementation of

AccountInterface.cairoVersion

Inherited from

Account.cairoVersion

Defined in

src/account/default.ts:102

transactionVersion

• Readonly transactionVersion: "0x2" | "0x3"

Inherited from

Account.transactionVersion

Defined in

src/account/default.ts:104

paymaster

• paymaster: PaymasterInterface

Inherited from

Account.paymaster

Defined in

src/account/default.ts:106

deploySelf

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

Type declaration

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

Parameters

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

Returns

Promise<DeployContractResponse>

Inherited from

Account.deploySelf

Defined in

src/account/default.ts:634

responseParser

• responseParser: RPCResponseParser

Inherited from

Account.responseParser

Defined in

src/provider/rpc.ts:65

channel

• channel: RpcChannel | RpcChannel

Implementation of

AccountInterface.channel

Inherited from

Account.channel

Defined in

src/provider/rpc.ts:67

getStateUpdate

• getStateUpdate: () => Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>(blockIdentifier: "pending") => Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>(blockIdentifier: "latest") => Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>(blockIdentifier?: BlockIdentifier) => Promise<StateUpdateResponse>

Type declaration

▸ (): Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Returns

Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

▸ (blockIdentifier): Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

▸ (blockIdentifier): Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

▸ (blockIdentifier?): Promise<StateUpdateResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StateUpdateResponse>

Implementation of

AccountInterface.getStateUpdate

Inherited from

Account.getStateUpdate

Defined in

src/provider/rpc.ts:268

Methods

connect

▸ connect(provider, walletProvider, cairoVersion?, paymaster?, silentMode?): Promise<WalletAccount>

Parameters

Name	Type	Default value
`provider`	`ProviderInterface`	`undefined`
`walletProvider`	`StarknetWalletProvider`	`undefined`
`cairoVersion?`	`CairoVersion`	`undefined`
`paymaster?`	`PaymasterOptions` \| `PaymasterInterface`	`undefined`
`silentMode`	`boolean`	`false`

Returns

Promise<WalletAccount>

Defined in

src/wallet/account.ts:164

connectSilent

▸ connectSilent(provider, walletProvider, cairoVersion?, paymaster?): Promise<WalletAccount>

Parameters

Name	Type
`provider`	`ProviderInterface`
`walletProvider`	`StarknetWalletProvider`
`cairoVersion?`	`CairoVersion`
`paymaster?`	`PaymasterOptions` \| `PaymasterInterface`

Returns

Promise<WalletAccount>

Defined in

src/wallet/account.ts:175

getStarkName

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

Parameters

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

Returns

Promise<string>

Inherited from

Account.getStarkName

Defined in

src/provider/extensions/starknetId.ts:62

getAddressFromStarkName

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

Parameters

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

Returns

Promise<string>

Inherited from

Account.getAddressFromStarkName

Defined in

src/provider/extensions/starknetId.ts:96

getStarkProfile

▸ getStarkProfile(provider, address, StarknetIdContract?, StarknetIdIdentityContract?, StarknetIdVerifierContract?, StarknetIdPfpContract?, StarknetIdPopContract?, StarknetIdMulticallContract?): Promise<StarkProfile>

Parameters

Name	Type
`provider`	`ProviderInterface`
`address`	`BigNumberish`
`StarknetIdContract?`	`string`
`StarknetIdIdentityContract?`	`string`
`StarknetIdVerifierContract?`	`string`
`StarknetIdPfpContract?`	`string`
`StarknetIdPopContract?`	`string`
`StarknetIdMulticallContract?`	`string`

Returns

Promise<StarkProfile>

Inherited from

Account.getStarkProfile

Defined in

src/provider/extensions/starknetId.ts:128

onAccountChange

▸ onAccountChange(callback): void

WALLET EVENTS

Parameters

Name	Type
`callback`	`AccountChangeEventHandler`

Returns

void

Defined in

src/wallet/account.ts:74

onNetworkChanged

▸ onNetworkChanged(callback): void

Parameters

Name	Type
`callback`	`NetworkChangeEventHandler`

Returns

void

Defined in

src/wallet/account.ts:78

requestAccounts

▸ requestAccounts(silentMode?): Promise<string[]>

WALLET SPECIFIC METHODS

Parameters

Name	Type	Default value
`silentMode`	`boolean`	`false`

Returns

Promise<string[]>

Defined in

src/wallet/account.ts:85

getPermissions

▸ getPermissions(): Promise<"accounts"[]>

Returns

Promise<"accounts"[]>

Defined in

src/wallet/account.ts:89

switchStarknetChain

▸ switchStarknetChain(chainId): Promise<boolean>

Parameters

Name	Type
`chainId`	`"0x534e5f4d41494e"` \| `"0x534e5f5345504f4c4941"`

Returns

Promise<boolean>

Defined in

src/wallet/account.ts:93

watchAsset

▸ watchAsset(asset): Promise<boolean>

Parameters

Name	Type
`asset`	`WatchAssetParameters`

Returns

Promise<boolean>

Defined in

src/wallet/account.ts:97

addStarknetChain

▸ addStarknetChain(chain): Promise<boolean>

Parameters

Name	Type
`chain`	`AddStarknetChainParameters`

Returns

Promise<boolean>

Defined in

src/wallet/account.ts:101

execute

▸ execute(calls): Promise<AddInvokeTransactionResult>

ACCOUNT METHODS

Parameters

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

Returns

Promise<AddInvokeTransactionResult>

Implementation of

AccountInterface.execute

Overrides

Account.execute

Defined in

src/wallet/account.ts:108

declare

▸ declare(payload): Promise<AddDeclareTransactionResult>

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.

Returns

Promise<AddDeclareTransactionResult>

a confirmation of sending a transaction on the starknet contract

Implementation of

AccountInterface.declare

Overrides

Account.declare

Defined in

src/wallet/account.ts:125

deploy

▸ deploy(payload): 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

Returns

Promise<MultiDeployContractResponse>

contract_address[]
transaction_hash

Implementation of

AccountInterface.deploy

Overrides

Account.deploy

Defined in

src/wallet/account.ts:148

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

Implementation of

AccountInterface.signMessage

Overrides

Account.signMessage

Defined in

src/wallet/account.ts:160

getPreferredVersion

▸ getPreferredVersion(type12, type3): ETransactionVersion

Parameters

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

Returns

ETransactionVersion

Inherited from

Account.getPreferredVersion

Defined in

src/account/default.ts:144

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

Inherited from

Account.getNonce

Defined in

src/account/default.ts:151

getNonceSafe

▸ getNonceSafe(nonce?): Promise<bigint>

Parameters

Name	Type
`nonce?`	`BigNumberish`

Returns

Promise<bigint>

Inherited from

Account.getNonceSafe

Defined in

src/account/default.ts:155

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>

Inherited from

Account.getCairoVersion

Defined in

src/account/default.ts:168

estimateFee

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

Parameters

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

Returns

Promise<EstimateFee>

Inherited from

Account.estimateFee

Defined in

src/account/default.ts:178

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

Inherited from

Account.estimateInvokeFee

Defined in

src/account/default.ts:185

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

Inherited from

Account.estimateDeclareFee

Defined in

src/account/default.ts:224

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

Inherited from

Account.estimateAccountDeployFee

Defined in

src/account/default.ts:262

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

Inherited from

Account.estimateDeployFee

Defined in

src/account/default.ts:301

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	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`	`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<EstimateFeeBulk>

response from estimate_fee

Implementation of

AccountInterface.estimateFeeBulk

Inherited from

Account.estimateFeeBulk

Defined in

src/account/default.ts:309

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

Inherited from

Account.simulateTransaction

Defined in

src/account/default.ts:335

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

Implementation of

AccountInterface.buildPaymasterTransaction

Inherited from

Account.buildPaymasterTransaction

Defined in

src/account/default.ts:411

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

Implementation of

AccountInterface.estimatePaymasterTransactionFee

Inherited from

Account.estimatePaymasterTransactionFee

Defined in

src/account/default.ts:450

preparePaymasterTransaction

▸ preparePaymasterTransaction(preparedTransaction): Promise<ExecutableUserTransaction>

Parameters

Name	Type
`preparedTransaction`	`PreparedTransaction`

Returns

Promise<ExecutableUserTransaction>

Inherited from

Account.preparePaymasterTransaction

Defined in

src/account/default.ts:458

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

Implementation of

AccountInterface.executePaymasterTransaction

Inherited from

Account.executePaymasterTransaction

Defined in

src/account/default.ts:501

declareIfNot

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

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<{ class_hash: string ; transaction_hash: string }>

Inherited from

Account.declareIfNot

Defined in

src/account/default.ts:535

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

Inherited from

Account.deployContract

Defined in

src/account/default.ts:608

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

Inherited from

Account.declareAndDeploy

Defined in

src/account/default.ts:617

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

Inherited from

Account.deployAccount

Defined in

src/account/default.ts:636

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

Implementation of

AccountInterface.hashMessage

Inherited from

Account.hashMessage

Defined in

src/account/default.ts:700

getSnip9Version

▸ getSnip9Version(): Promise<"0" | "1" | "2">

Verify if an account is compatible with SNIP-9 outside execution, and with which version of this standard.

Returns

Promise<"0" | "1" | "2">

Not compatible, V1, V2.

Example

const result = myAccount.getSnip9Version();
// result = "V1"

Inherited from

Account.getSnip9Version

Defined in

src/account/default.ts:713

isValidSnip9Nonce

▸ isValidSnip9Nonce(nonce): Promise<boolean>

Verify if a SNIP-9 nonce has not yet been used by the account.

Parameters

Name	Type	Description
`nonce`	`BigNumberish`	SNIP-9 nonce to test.

Returns

Promise<boolean>

true if SNIP-9 nonce not yet used.

Example

const result = myAccount.isValidSnip9Nonce(1234);
// result = true

Inherited from

Account.isValidSnip9Nonce

Defined in

src/account/default.ts:734

getSnip9Nonce

▸ getSnip9Nonce(): Promise<string>

Outside transaction needs a specific SNIP-9 nonce, that we get in this function. A SNIP-9 nonce can be any number not yet used ; no ordering is needed.

Returns

Promise<string>

an Hex string of a SNIP-9 nonce.

Example

const result = myAccount.getSnip9Nonce();
// result = "0x28a612590dbc36927933c8ee0f357eee639c8b22b3d3aa86949eed3ada4ac55"

Inherited from

Account.getSnip9Nonce

Defined in

src/account/default.ts:758

getOutsideTransaction

▸ getOutsideTransaction(options, calls, version?, nonce?): Promise<OutsideTransaction>

Creates an object containing transaction(s) that can be executed by an other account with Account.executeFromOutside(), called Outside Transaction.

Parameters

Name	Type	Description
`options`	`OutsideExecutionOptions`	Parameters of the transaction(s).
`calls`	`AllowArray`<`Call`>	Transaction(s) to execute.
`version?`	`"0"` \| `"1"` \| `"2"`	SNIP-9 version of the Account that creates the outside transaction.
`nonce?`	`BigNumberish`	Outside Nonce.

Returns

Promise<OutsideTransaction>

and object that can be used in Account.executeFromOutside()

Example

const now_seconds = Math.floor(Date.now() / 1000);
const callOptions: OutsideExecutionOptions = {
  caller: executorAccount.address,
  execute_after: now_seconds - 3600,
  execute_before: now_seconds + 3600,
};
const call1: Call = {
  contractAddress: ethAddress,
  entrypoint: 'transfer',
  calldata: {
    recipient: recipientAccount.address,
    amount: cairo.uint256(100),
  },
};
const outsideTransaction1: OutsideTransaction = await signerAccount.getOutsideTransaction(
  callOptions,
  call3
);
// result = {
// outsideExecution: {
// caller: '0x64b48806902a367c8598f4f95c305e8c1a1acba5f082d294a43793113115691',
// nonce: '0x28a612590dbc36927933c8ee0f357eee639c8b22b3d3aa86949eed3ada4ac55',
// execute_after: 1723650229, execute_before: 1723704229, calls: [[Object]] },
// signature: Signature {
// r: 67518627037915514985321278857825384106482999609634873287406612756843916814n,
// s: 737198738569840639192844101690009498983611654458636624293579534560862067709n, recovery: 0 },
// signerAddress: '0x655f8fd7c4013c07cf12a92184aa6c314d181443913e21f7e209a18f0c78492',
// version: '2'
// }

Inherited from

Account.getOutsideTransaction

Defined in

src/account/default.ts:795

executeFromOutside

▸ executeFromOutside(outsideTransaction, opts?): Promise<{ transaction_hash: string }>

An account B executes a transaction that has been signed by an account A. Fees are paid by B.

Parameters

Name	Type	Description
`outsideTransaction`	`AllowArray`<`OutsideTransaction`>	the signed transaction generated by `Account.getOutsideTransaction()`.
`opts?`	`UniversalDetails`	same options than `Account.execute()`.

Returns

Promise<{ transaction_hash: string }>

same response than Account.execute().

Example

const outsideTransaction1: OutsideTransaction = await signerAccount.getOutsideTransaction(
  callOptions,
  call1
);
const outsideTransaction2: OutsideTransaction = await signerAccount.getOutsideTransaction(
  callOptions4,
  call4
);
const result = await myAccount.executeFromOutside([outsideTransaction1, outsideTransaction2]);
// result = { transaction_hash: '0x11233...`}

Inherited from

Account.executeFromOutside

Defined in

src/account/default.ts:855

getUniversalSuggestedFee

▸ getUniversalSuggestedFee(version, «destructured», details): Promise<UniversalSuggestedFee>

Parameters

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

Returns

Promise<UniversalSuggestedFee>

Inherited from

Account.getUniversalSuggestedFee

Defined in

src/account/default.ts:867

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

Inherited from

Account.getSuggestedFee

Defined in

src/account/default.ts:895

buildInvocation

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

Parameters

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

Returns

Promise<Invocation>

Inherited from

Account.buildInvocation

Defined in

src/account/default.ts:917

buildDeclarePayload

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

Parameters

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

Returns

Promise<DeclareContractTransaction>

Inherited from

Account.buildDeclarePayload

Defined in

src/account/default.ts:932

buildAccountDeployPayload

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

Parameters

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

Returns

Promise<DeployAccountContractTransaction>

Inherited from

Account.buildAccountDeployPayload

Defined in

src/account/default.ts:964

buildUDCContractPayload

▸ buildUDCContractPayload(payload): Call[]

Parameters

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

Returns

Call[]

Inherited from

Account.buildUDCContractPayload

Defined in

src/account/default.ts:998

accountInvocationsFactory

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

Parameters

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

Returns

Promise<AccountInvocations>

Inherited from

Account.accountInvocationsFactory

Defined in

src/account/default.ts:1025

getStarkName

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

Parameters

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

Returns

Promise<string>

Inherited from

Account.getStarkName

Defined in

src/account/default.ts:1123

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

Account.fetch

Defined in

src/provider/rpc.ts:131

getChainId

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

Gets the Starknet chain Id

Returns

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

the chain Id

Implementation of

AccountInterface.getChainId

Inherited from

Account.getChainId

Defined in

src/provider/rpc.ts:135

readSpecVersion

▸ readSpecVersion(): undefined | "0.7.1" | "0.8.1"

read channel spec version

Returns

undefined | "0.7.1" | "0.8.1"

Inherited from

Account.readSpecVersion

Defined in

src/provider/rpc.ts:142

getSpecVersion

▸ getSpecVersion(): Promise<string>

get channel spec version

Returns

Promise<string>

Inherited from

Account.getSpecVersion

Defined in

src/provider/rpc.ts:149

setUpSpecVersion

▸ setUpSpecVersion(): Promise<"0.7.1" | "0.8.1">

setup channel spec version and return it

Returns

Promise<"0.7.1" | "0.8.1">

Inherited from

Account.setUpSpecVersion

Defined in

src/provider/rpc.ts:156

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

Account.getNonceForAddress

Defined in

src/provider/rpc.ts:160

getBlock

▸ getBlock(): 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

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

Implementation of

AccountInterface.getBlock

Inherited from

Account.getBlock

Defined in

src/provider/rpc.ts:167

▸ 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 }>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

Implementation of

AccountInterface.getBlock

Inherited from

Account.getBlock

Defined in

src/provider/rpc.ts:168

▸ 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[] }>

Implementation of

AccountInterface.getBlock

Inherited from

Account.getBlock

Defined in

src/provider/rpc.ts:169

▸ getBlock(blockIdentifier?): Promise<GetBlockResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<GetBlockResponse>

Implementation of

AccountInterface.getBlock

Inherited from

Account.getBlock

Defined in

src/provider/rpc.ts:170

getBlockLatestAccepted

▸ getBlockLatestAccepted(): Promise<BlockHashAndNumber>

Get the most recent accepted block hash and number

Returns

Promise<BlockHashAndNumber>

Inherited from

Account.getBlockLatestAccepted

Defined in

src/provider/rpc.ts:180

getBlockNumber

▸ getBlockNumber(): Promise<number>

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

Returns

Promise<number>

Number of the latest block

Inherited from

Account.getBlockNumber

Defined in

src/provider/rpc.ts:189

getBlockWithTxHashes

▸ getBlockWithTxHashes(blockIdentifier?): Promise<BlockWithTxHashes>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockWithTxHashes>

Inherited from

Account.getBlockWithTxHashes

Defined in

src/provider/rpc.ts:193

getBlockWithTxs

▸ getBlockWithTxs(blockIdentifier?): Promise<BlockWithTxs>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockWithTxs>

Inherited from

Account.getBlockWithTxs

Defined in

src/provider/rpc.ts:197

waitForBlock

▸ waitForBlock(blockIdentifier?, retryInterval?): Promise<void>

Pause the execution of the script until a specified block is created.

Parameters

Name	Type	Default value	Description
`blockIdentifier`	`BlockIdentifier`	`'pending'`	bloc number (BigNumberish) or 'pending' or 'latest'. Use of 'latest" or of a block already created will generate no pause.
`retryInterval?`	`number`	`5000`	number of milliseconds between 2 requests to the node

Returns

Promise<void>

Example

await myProvider.waitForBlock();
// wait the creation of the pending block

Inherited from

Account.waitForBlock

Defined in

src/provider/rpc.ts:212

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

Implementation of

AccountInterface.getL1GasPrice

Inherited from

Account.getL1GasPrice

Defined in

src/provider/rpc.ts:242

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'

Implementation of

AccountInterface.getL1MessageHash

Inherited from

Account.getL1MessageHash

Defined in

src/provider/rpc.ts:248

getBlockWithReceipts

▸ getBlockWithReceipts(blockIdentifier?): Promise<OnlyFirst<BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | BlockWithTxReceipts>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<OnlyFirst<BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | OnlyFirst<PENDING_BLOCK_WITH_RECEIPTS, { status: BLOCK_STATUS } & BLOCK_HEADER & BLOCK_BODY_WITH_RECEIPTS & PENDING_BLOCK_HEADER> | BlockWithTxReceipts>

Inherited from

Account.getBlockWithReceipts

Defined in

src/provider/rpc.ts:264

getBlockStateUpdate

▸ getBlockStateUpdate(): Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Returns

Inherited from

Account.getBlockStateUpdate

Defined in

src/provider/rpc.ts:270

▸ getBlockStateUpdate(blockIdentifier): Promise<{ block_hash: never ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"pending"`

Returns

Inherited from

Account.getBlockStateUpdate

Defined in

src/provider/rpc.ts:271

▸ getBlockStateUpdate(blockIdentifier): Promise<{ block_hash: string ; new_root: string ; old_root: string ; state_diff: { storage_diffs: { address: string; storage_entries: { key: string; value: string; }[]; }[]; deprecated_declared_classes: string[]; declared_classes: { class_hash: string; compiled_class_hash: string; }[]; deployed_contracts: { address: string; class_hash: string; }[]; replaced_classes: { contract_address: string; class_hash: string; }[]; nonces: { nonce: string; contract_address: string; }[]; } }>

Parameters

Name	Type
`blockIdentifier`	`"latest"`

Returns

Inherited from

Account.getBlockStateUpdate

Defined in

src/provider/rpc.ts:272

▸ getBlockStateUpdate(blockIdentifier?): Promise<StateUpdateResponse>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StateUpdateResponse>

Inherited from

Account.getBlockStateUpdate

Defined in

src/provider/rpc.ts:273

getBlockTransactionsTraces

▸ getBlockTransactionsTraces(blockIdentifier?): Promise<BlockTransactionsTraces | BlockTransactionsTraces>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<BlockTransactionsTraces | BlockTransactionsTraces>

Inherited from

Account.getBlockTransactionsTraces

Defined in

src/provider/rpc.ts:278

getBlockTransactionCount

▸ getBlockTransactionCount(blockIdentifier?): Promise<number>

Parameters

Name	Type
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<number>

Inherited from

Account.getBlockTransactionCount

Defined in

src/provider/rpc.ts:282

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

Account.getTransaction

Defined in

src/provider/rpc.ts:286

getTransactionByHash

▸ getTransactionByHash(txHash): Promise<TransactionWithHash>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TransactionWithHash>

Inherited from

Account.getTransactionByHash

Defined in

src/provider/rpc.ts:290

getTransactionByBlockIdAndIndex

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

Parameters

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

Returns

Promise<TransactionWithHash>

Inherited from

Account.getTransactionByBlockIdAndIndex

Defined in

src/provider/rpc.ts:294

getTransactionReceipt

▸ getTransactionReceipt(txHash): Promise<GetTransactionReceiptResponse>

Gets the transaction receipt from a tx hash.

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<GetTransactionReceiptResponse>

the transaction receipt object

Implementation of

AccountInterface.getTransactionReceipt

Inherited from

Account.getTransactionReceipt

Defined in

src/provider/rpc.ts:298

getTransactionTrace

▸ getTransactionTrace(txHash): Promise<TRANSACTION_TRACE>

Parameters

Name	Type
`txHash`	`BigNumberish`

Returns

Promise<TRANSACTION_TRACE>

Inherited from

Account.getTransactionTrace

Defined in

src/provider/rpc.ts:305

getTransactionStatus

▸ getTransactionStatus(transactionHash): Promise<TransactionStatus>

Get the status of a transaction

Parameters

Name	Type
`transactionHash`	`BigNumberish`

Returns

Promise<TransactionStatus>

Inherited from

Account.getTransactionStatus

Defined in

src/provider/rpc.ts:312

getSimulateTransaction

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

Parameters

Name	Type	Description
`invocations`	`AccountInvocations`	AccountInvocations
`options?`	`getSimulateTransactionOptions`	blockIdentifier and flags to skip validation and fee charge - blockIdentifier - skipValidate (default false) - skipFeeCharge (default true)

Returns

Promise<SimulateTransactionResponse>

Implementation of

AccountInterface.getSimulateTransaction

Inherited from

Account.getSimulateTransaction

Defined in

src/provider/rpc.ts:323

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

Implementation of

AccountInterface.waitForTransaction

Inherited from

Account.waitForTransaction

Defined in

src/provider/rpc.ts:333

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

Account.getStorageAt

Defined in

src/provider/rpc.ts:345

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

Account.getClassHashAt

Defined in

src/provider/rpc.ts:353

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

Account.getClassByHash

Defined in

src/provider/rpc.ts:357

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

Account.getClass

Defined in

src/provider/rpc.ts:361

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

Account.getClassAt

Defined in

src/provider/rpc.ts:367

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

Account.getContractVersion

Defined in

src/provider/rpc.ts:373

▸ 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

Account.getContractVersion

Defined in

src/provider/rpc.ts:378

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

Account.getInvokeEstimateFee

Defined in

src/provider/rpc.ts:411

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

Account.getDeclareEstimateFee

Defined in

src/provider/rpc.ts:431

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

Account.getDeployAccountEstimateFee

Defined in

src/provider/rpc.ts:451

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

Account.getEstimateFeeBulk

Defined in

src/provider/rpc.ts:471

invokeFunction

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

Invokes a function on starknet

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<{ transaction_hash: string }>

response from addTransaction

Implementation of

AccountInterface.invokeFunction

Inherited from

Account.invokeFunction

Defined in

src/provider/rpc.ts:480

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

Implementation of

AccountInterface.declareContract

Inherited from

Account.declareContract

Defined in

src/provider/rpc.ts:487

deployAccountContract

▸ deployAccountContract(transaction, details): Promise<{ contract_address: string ; transaction_hash: string }>

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<{ contract_address: string ; transaction_hash: string }>

a confirmation of sending a transaction on the starknet contract

Implementation of

AccountInterface.deployAccountContract

Inherited from

Account.deployAccountContract

Defined in

src/provider/rpc.ts:494

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

Account.callContract

Defined in

src/provider/rpc.ts:501

estimateMessageFee

▸ estimateMessageFee(message, blockIdentifier?): Promise<{ unit: "WEI" | "FRI" ; overall_fee: string | number ; l1_gas_price: undefined | number ; l2_gas_price: undefined | number ; l1_data_gas_price: undefined | number ; l1_gas_consumed: undefined | number ; l2_gas_consumed: undefined | number ; l1_data_gas_consumed: undefined | number ; gas_consumed: undefined | string ; gas_price: undefined | string ; data_gas_consumed: undefined | string ; data_gas_price: undefined | string }>

NEW: Estimate the fee for a message from L1

Parameters

Name	Type	Description
`message`	`Object`	Message From L1
`message.entry_point_selector`	`string`	-
`message.from_address`	`string`	-
`message.to_address`	`string`	-
`message.payload`	`string`[]	-
`blockIdentifier?`	`BlockIdentifier`	-

Returns

Promise<{ unit: "WEI" | "FRI" ; overall_fee: string | number ; l1_gas_price: undefined | number ; l2_gas_price: undefined | number ; l1_data_gas_price: undefined | number ; l1_gas_consumed: undefined | number ; l2_gas_consumed: undefined | number ; l1_data_gas_consumed: undefined | number ; gas_consumed: undefined | string ; gas_price: undefined | string ; data_gas_consumed: undefined | string ; data_gas_price: undefined | string }>

Inherited from

Account.estimateMessageFee

Defined in

src/provider/rpc.ts:509

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

Account.getSyncingStats

Defined in

src/provider/rpc.ts:520

getEvents

▸ getEvents(eventFilter): Promise<{ events: { keys: string[]; data: string[]; block_number: number; block_hash: string; transaction_hash: string; from_address: string; }[] ; continuation_token: undefined | string }>

Returns all events matching the given filter

Parameters

Name	Type
`eventFilter`	`EventFilter`

Returns

Promise<{ events: { keys: string[]; data: string[]; block_number: number; block_hash: string; transaction_hash: string; from_address: string; }[] ; continuation_token: undefined | string }>

events and the pagination of the events

Inherited from

Account.getEvents

Defined in

src/provider/rpc.ts:528

verifyMessageInStarknet

▸ verifyMessageInStarknet(message, signature, accountAddress, signatureVerificationFunctionName?, signatureVerificationResponse?): Promise<boolean>

Verify in Starknet a signature of a TypedData object or of a given hash.

Parameters

Name	Type	Description
`message`	`TypedData` \| `BigNumberish`	TypedData object to be verified, or message hash to be verified.
`signature`	`Signature`	signature of the message.
`accountAddress`	`BigNumberish`	address of the account that has signed the message.
`signatureVerificationFunctionName?`	`string`	if account contract with non standard account verification function name.
`signatureVerificationResponse?`	`Object`	if account contract with non standard response of verification function.
`signatureVerificationResponse.okResponse`	`string`[]	-
`signatureVerificationResponse.nokResponse`	`string`[]	-
`signatureVerificationResponse.error`	`string`[]	-

Returns

Promise<boolean>

const myTypedMessage: TypedMessage = .... ;
const messageHash = typedData.getMessageHash(myTypedMessage,accountAddress);
const sign: WeierstrassSignatureType = ec.starkCurve.sign(messageHash, privateKey);
const accountAddress = "0x43b7240d227aa2fb8434350b3321c40ac1b88c7067982549e7609870621b535";
const result1 = myRpcProvider.verifyMessageInStarknet(myTypedMessage, sign, accountAddress);
const result2 = myRpcProvider.verifyMessageInStarknet(messageHash, sign, accountAddress);
// result1 = result2 = true

Inherited from

Account.verifyMessageInStarknet

Defined in

src/provider/rpc.ts:550

isClassDeclared

▸ isClassDeclared(contractClassIdentifier, blockIdentifier?): Promise<boolean>

Test if class is already declared from ContractClassIdentifier Helper method using getClass

Parameters

Name	Type
`contractClassIdentifier`	`ContractClassIdentifier`
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<boolean>

Inherited from

Account.isClassDeclared

Defined in

src/provider/rpc.ts:639

prepareInvocations

▸ prepareInvocations(invocations): Promise<Invocations>

Build bulk invocations with auto-detect declared class

Test if class is declared if not declare it preventing already declared class error and not declared class errors
Order declarations first

Parameters

Name	Type
`invocations`	`Invocations`

Returns

Promise<Invocations>

Inherited from

Account.prepareInvocations

Defined in

src/provider/rpc.ts:670

getL1MessagesStatus

▸ getL1MessagesStatus(transactionHash): Promise<L1L2MessagesStatus>

Given an l1 tx hash, returns the associated l1_handler tx hashes and statuses for all L1 -> L2 messages sent by the l1 transaction, ordered by the l1 tx sending order

Parameters

Name	Type
`transactionHash`	`BigNumberish`

Returns

Promise<L1L2MessagesStatus>

Inherited from

Account.getL1MessagesStatus

Defined in

src/provider/rpc.ts:694

getStorageProof

▸ getStorageProof(classHashes, contractAddresses, contractsStorageKeys, blockIdentifier?): Promise<StorageProof>

Get merkle paths in one of the state tries: global state, classes, individual contract

Parameters

Name	Type
`classHashes`	`BigNumberish`[]
`contractAddresses`	`BigNumberish`[]
`contractsStorageKeys`	`CONTRACT_STORAGE_KEYS`[]
`blockIdentifier?`	`BlockIdentifier`

Returns

Promise<StorageProof>

Inherited from

Account.getStorageProof

Defined in

src/provider/rpc.ts:705

getCompiledCasm

▸ getCompiledCasm(classHash): Promise<CASM_COMPILED_CONTRACT_CLASS>

Get the contract class definition in the given block associated with the given hash

Parameters

Name	Type
`classHash`	`BigNumberish`

Returns

Promise<CASM_COMPILED_CONTRACT_CLASS>

Inherited from

Account.getCompiledCasm

Defined in

src/provider/rpc.ts:726

getAddressFromStarkName

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

Parameters

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

Returns

Promise<string>

Inherited from

Account.getAddressFromStarkName

Defined in

src/provider/extensions/starknetId.ts:31

getStarkProfile

▸ getStarkProfile(address, StarknetIdContract?, StarknetIdIdentityContract?, StarknetIdVerifierContract?, StarknetIdPfpContract?, StarknetIdPopContract?, StarknetIdMulticallContract?): Promise<StarkProfile>

Parameters

Name	Type
`address`	`BigNumberish`
`StarknetIdContract?`	`string`
`StarknetIdIdentityContract?`	`string`
`StarknetIdVerifierContract?`	`string`
`StarknetIdPfpContract?`	`string`
`StarknetIdPopContract?`	`string`
`StarknetIdMulticallContract?`	`string`

Returns

Promise<StarkProfile>

Inherited from

Account.getStarkProfile

Defined in

src/provider/extensions/starknetId.ts:40

Hierarchy​

Implements​

Constructors​

constructor​

Parameters​

Returns​

Overrides​

Defined in​

Properties​

walletProvider​

Defined in​

signer​

Implementation of​

Inherited from​

Defined in​

address​

Implementation of​

Inherited from​

Defined in​

cairoVersion​

Implementation of​

Inherited from​

Defined in​

transactionVersion​

Inherited from​

Defined in​

paymaster​

Inherited from​

Defined in​

deploySelf​

Type declaration​

Parameters​

Returns​

Inherited from​

Defined in​

responseParser​

Inherited from​

Defined in​

channel​

Implementation of​

Inherited from​

Defined in​

getStateUpdate​

Type declaration​

Returns​

Parameters​

Returns​

Parameters​

Returns​

Parameters​

Returns​

Implementation of​

Inherited from​

Defined in​

Methods​

connect​

Parameters​

Returns​

Defined in​

connectSilent​

Parameters​

Returns​

Defined in​

getStarkName​

Parameters​

Returns​

Inherited from​

Defined in​

getAddressFromStarkName​

Parameters​

Returns​

Inherited from​

Defined in​

getStarkProfile​

Parameters​

Returns​

Inherited from​

Defined in​

onAccountChange​

Parameters​

Hierarchy

Implements

Constructors

constructor

Parameters

Returns

Overrides

Defined in

Properties

walletProvider

Defined in

signer

Implementation of

Inherited from

Defined in

address

Implementation of

Inherited from

Defined in

cairoVersion

Implementation of

Inherited from

Defined in

transactionVersion

Inherited from

Defined in

paymaster

Inherited from

Defined in

deploySelf

Type declaration

Parameters

Returns

Inherited from

Defined in

responseParser

Inherited from

Defined in

channel

Implementation of

Inherited from

Defined in

getStateUpdate

Type declaration

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Inherited from

Defined in

Methods

connect

Parameters

Returns

Defined in

connectSilent

Parameters

Returns

Defined in

getStarkName

Parameters

Returns

Inherited from

Defined in

getAddressFromStarkName

Parameters

Returns

Inherited from

Defined in

getStarkProfile

Parameters

Returns

Inherited from

Defined in

onAccountChange

Parameters