EVMWallet

​

Extends

• Wallet<EVMChain>

​

Constructors

​

new EVMWallet()

new EVMWallet(wallet): EVMWallet

​

Parameters

Parameter	Type
wallet	Wallet<EVMSmartWalletChain>

​

Returns

EVMWallet

​

Overrides

Wallet.constructor

​

Defined in

packages/wallets/src/wallets/evm.ts:19

​

Properties

Property	Type	Inherited from	Defined in
address	string	Wallet.address	packages/wallets/src/wallets/wallet.ts:41
chain	EVMSmartWalletChain	Wallet.chain	packages/wallets/src/wallets/wallet.ts:40
owner?	string	Wallet.owner	packages/wallets/src/wallets/wallet.ts:42
signer	Signer<keyof SignResultMap>	Wallet.signer	packages/wallets/src/wallets/wallet.ts:43

​

Methods

​

addDelegatedSigner()

addDelegatedSigner(signer): Promise<void>

Add a delegated signer to the wallet

​

Parameters

Parameter	Type	Description
signer	object	The signer
signer.signer	string	-

​

Returns

Promise<void>

The delegated signer

​

Inherited from

Wallet.addDelegatedSigner

​

Defined in

packages/wallets/src/wallets/wallet.ts:235

---

​

balances()

balances(tokens?, chains?): Promise<Balances>

Get the wallet balances - always includes USDC and native token (ETH/SOL)

​

Parameters

Parameter	Type	Description
tokens?	string[]	Additional tokens to request (optional: native token and usdc are always included)
chains?	Chain[]	The chains (optional)

​

Returns

Promise<Balances>

The balances returns nativeToken, usdc, tokens

​

Throws

If the balances cannot be retrieved

​

Inherited from

Wallet.balances

​

Defined in

packages/wallets/src/wallets/wallet.ts:80

---

​

delegatedSigners()

delegatedSigners(): Promise<DelegatedSigner[]>

​

Returns

Promise<DelegatedSigner[]>

​

Inherited from

Wallet.delegatedSigners

​

Defined in

packages/wallets/src/wallets/wallet.ts:265

---

​

experimental_activity()

experimental_activity(): Promise<WalletsV1Alpha2ActivityResponseDto>

Experimental

Get the wallet activity

​

Returns

Promise<WalletsV1Alpha2ActivityResponseDto>

The activity This API is experimental and may change in the future

​

Throws

If the activity cannot be retrieved

​

Inherited from

Wallet.experimental_activity

​

Defined in

packages/wallets/src/wallets/wallet.ts:186

---

​

experimental_nfts()

experimental_nfts(params): Promise<GetNftsResponse>

Experimental

Get the wallet NFTs

​

Parameters

Parameter	Type	Description
params	object	The parameters
params.page	number	The page number
params.perPage	number	The number of NFTs per page

​

Returns

Promise<GetNftsResponse>

The NFTs This API is experimental and may change in the future

​

Inherited from

Wallet.experimental_nfts

​

Defined in

packages/wallets/src/wallets/wallet.ts:164

---

​

experimental_transactions()

experimental_transactions(): Promise<GetTransactionsResponse>

Get the wallet transactions

​

Returns

Promise<GetTransactionsResponse>

The transactions

​

Inherited from

Wallet.experimental_transactions

​

Defined in

packages/wallets/src/wallets/wallet.ts:176

---

​

getViemClient()

getViemClient(params?): object

​

Parameters

Parameter	Type
params?	object
params.transport?	HttpTransport

​

Returns

object

account

account: undefined

The Account of the Client.

batch?

optional batch: object

Flags for batch settings.

batch.multicall?

optional multicall: boolean | object

Toggle to enable eth_call multicall aggregation.

cacheTime

cacheTime: number

Time (in ms) that cached data will remain in memory.

call()

call: (parameters) => Promise<CallReturnType>

Parameters

Parameter	Type
parameters	CallParameters<Chain>

Returns

Promise<CallReturnType>

The call data. CallReturnType

ccipRead?

optional ccipRead: false | object

CCIP Read configuration.

chain

chain: Chain

Chain for the client.

createAccessList()

createAccessList: (parameters) => Promise<object>

Parameters

Parameter	Type
parameters	CreateAccessListParameters<Chain>

Returns

Promise<object>

The call data. CreateAccessListReturnType

accessList

accessList: AccessList

gasUsed

gasUsed: bigint

createBlockFilter()

createBlockFilter: () => Promise<object>

Returns

Promise<object>

Filter. CreateBlockFilterReturnType

id

id: `0x${string}`

request

request: EIP1193RequestFn<readonly [object, object, object]>

type

type: "block"

createContractEventFilter()

createContractEventFilter: <abi, eventName, args, strict, fromBlock, toBlock>(args) => Promise<CreateContractEventFilterReturnType<abi, eventName, args, strict, fromBlock, toBlock>>

Type Parameters

Type Parameter	Default type
abi extends Abi | readonly unknown[]	-
eventName extends undefined | string	-
args extends undefined | Record<string, unknown> | readonly unknown[]	-
strict extends undefined | boolean	undefined
fromBlock extends undefined | bigint | BlockTag	undefined
toBlock extends undefined | bigint | BlockTag	undefined

Parameters

Parameter	Type	Description
args	CreateContractEventFilterParameters<abi, eventName, args, strict, fromBlock, toBlock>	CreateContractEventFilterParameters

Returns

Promise<CreateContractEventFilterReturnType<abi, eventName, args, strict, fromBlock, toBlock>>

Filter. CreateContractEventFilterReturnType

createEventFilter()

createEventFilter: <abiEvent, abiEvents, strict, fromBlock, toBlock, _EventName, _Args>(args?) => Promise<{ [K in string | number | symbol]: Filter<“event”, abiEvents, _EventName, _Args, strict, fromBlock, toBlock>[K] }>

Type Parameters

Type Parameter	Default type
abiEvent extends undefined | AbiEvent	undefined
abiEvents extends undefined | readonly unknown[] | readonly AbiEvent[]	abiEvent extends AbiEvent ? [abiEvent<abiEvent>] : undefined
strict extends undefined | boolean	undefined
fromBlock extends undefined | bigint | BlockTag	undefined
toBlock extends undefined | bigint | BlockTag	undefined
_EventName extends undefined | string	MaybeAbiEventName<abiEvent>
_Args extends undefined | Record<string, unknown> | readonly unknown[]	undefined

Parameters

Parameter	Type	Description
args?	CreateEventFilterParameters<abiEvent, abiEvents, strict, fromBlock, toBlock, _EventName, _Args>	CreateEventFilterParameters

Returns

Promise<{ [K in string | number | symbol]: Filter<“event”, abiEvents, _EventName, _Args, strict, fromBlock, toBlock>[K] }>

Filter. CreateEventFilterReturnType

createPendingTransactionFilter()

createPendingTransactionFilter: () => Promise<object>

Returns

Promise<object>

Filter. CreateBlockFilterReturnType

id

id: `0x${string}`

request

request: EIP1193RequestFn<readonly [object, object, object]>

type

type: "transaction"

estimateContractGas()

estimateContractGas: <chain, abi, functionName, args>(args) => Promise<bigint>

Type Parameters

Type Parameter
chain extends undefined | Chain
abi extends Abi | readonly unknown[]
functionName extends string
args extends unknown

Parameters

Parameter	Type	Description
args	EstimateContractGasParameters<abi, functionName, args, chain>	EstimateContractGasParameters

Returns

Promise<bigint>

The gas estimate (in wei). EstimateContractGasReturnType

estimateFeesPerGas()

estimateFeesPerGas: <chainOverride, type>(args?) => Promise<EstimateFeesPerGasReturnType<type>>

Type Parameters

Type Parameter	Default type
chainOverride extends undefined | Chain	undefined
type extends FeeValuesType	"eip1559"

Parameters

Parameter	Type
args?	EstimateFeesPerGasParameters<Chain, chainOverride, type>

Returns

Promise<EstimateFeesPerGasReturnType<type>>

An estimate (in wei) for the fees per gas. EstimateFeesPerGasReturnType

estimateGas()

estimateGas: (args) => Promise<bigint>

Parameters

Parameter	Type	Description
args	EstimateGasParameters<Chain>	EstimateGasParameters

Returns

Promise<bigint>

The gas estimate (in wei). EstimateGasReturnType

estimateMaxPriorityFeePerGas()

estimateMaxPriorityFeePerGas: <chainOverride>(args?) => Promise<bigint>

Type Parameters

Type Parameter	Default type
chainOverride extends undefined | Chain	undefined

Parameters

Parameter	Type
args?	object
args.chain?	null | chainOverride

Returns

Promise<bigint>

An estimate (in wei) for the max priority fee per gas. EstimateMaxPriorityFeePerGasReturnType

extend()

extend: <client>(fn) => Client<HttpTransport, Chain, undefined, PublicRpcSchema, { [K in string | number | symbol]: client[K] } & PublicActions<HttpTransport, Chain>>

Type Parameters

Type Parameter
client extends object & ExactPartial<ExtendableProtectedActions<HttpTransport, Chain, undefined>>

Parameters

Parameter	Type
fn	(client) => client

Returns

Client<HttpTransport, Chain, undefined, PublicRpcSchema, { [K in string | number | symbol]: client[K] } & PublicActions<HttpTransport, Chain>>

getBalance()

getBalance: (args) => Promise<bigint>

Parameters

Parameter	Type	Description
args	GetBalanceParameters	GetBalanceParameters

Returns

Promise<bigint>

The balance of the address in wei. GetBalanceReturnType

getBlobBaseFee()

getBlobBaseFee: () => Promise<bigint>

Returns

Promise<bigint>

The blob base fee (in wei). GetBlobBaseFeeReturnType

getBlock()

getBlock: <includeTransactions, blockTag>(args?) => Promise<object>

Type Parameters

Type Parameter	Default type
includeTransactions extends boolean	false
blockTag extends BlockTag	"latest"

Parameters

Parameter	Type	Description
args?	GetBlockParameters<includeTransactions, blockTag>	GetBlockParameters

Returns

Promise<object>

Information about the block. GetBlockReturnType

baseFeePerGas

baseFeePerGas: null | bigint

Base fee per gas

blobGasUsed

blobGasUsed: bigint

Total used blob gas by all transactions in this block

difficulty

difficulty: bigint

Difficulty for this block

excessBlobGas

excessBlobGas: bigint

Excess blob gas

extraData

extraData: `0x${string}`

“Extra data” field of this block

gasLimit

gasLimit: bigint

Maximum gas allowed in this block

gasUsed

gasUsed: bigint

Total used gas by all transactions in this block

hash

hash: blockTag extends "pending" ? null : `0x${string}`

Block hash or null if pending

logsBloom

logsBloom: blockTag extends "pending" ? null : `0x${string}`

Logs bloom filter or null if pending

miner

miner: `0x${string}`

Address that received this block’s mining rewards

mixHash

mixHash: `0x${string}`

Unique identifier for the block.

nonce

nonce: blockTag extends "pending" ? null : `0x${string}`

Proof-of-work hash or null if pending

number

number: blockTag extends "pending" ? null : bigint

Block number or null if pending

parentBeaconBlockRoot?

optional parentBeaconBlockRoot: `0x${string}`

Root of the parent beacon chain block

parentHash

parentHash: `0x${string}`

Parent block hash

receiptsRoot

receiptsRoot: `0x${string}`

Root of the this block’s receipts trie

sealFields

sealFields: `0x${string}`[]

sha3Uncles

sha3Uncles: `0x${string}`

SHA3 of the uncles data in this block

size

size: bigint

Size of this block in bytes

stateRoot

stateRoot: `0x${string}`

Root of this block’s final state trie

timestamp

timestamp: bigint

Unix timestamp of when this block was collated

totalDifficulty

totalDifficulty: null | bigint

Total difficulty of the chain until this block

transactions

transactions: includeTransactions extends true ? (object | object | object | object | object)[] : `0x${string}`[]

transactionsRoot

transactionsRoot: `0x${string}`

Root of this block’s transaction trie

uncles

uncles: `0x${string}`[]

List of uncle hashes

withdrawals?

optional withdrawals: Withdrawal[]

List of withdrawal objects

withdrawalsRoot?

optional withdrawalsRoot: `0x${string}`

Root of the this block’s withdrawals trie

getBlockNumber()

getBlockNumber: (args?) => Promise<bigint>

Parameters

Parameter	Type	Description
args?	GetBlockNumberParameters	GetBlockNumberParameters

Returns

Promise<bigint>

The number of the block. GetBlockNumberReturnType

getBlockTransactionCount()

getBlockTransactionCount: (args?) => Promise<number>

Parameters

Parameter	Type	Description
args?	GetBlockTransactionCountParameters	GetBlockTransactionCountParameters

Returns

Promise<number>

The block transaction count. GetBlockTransactionCountReturnType

getBytecode()

getBytecode: (args) => Promise<GetCodeReturnType>

Parameters

Parameter	Type
args	GetCodeParameters

Returns

Promise<GetCodeReturnType>

Deprecated

Use getCode instead.

getChainId()

getChainId: () => Promise<number>

Returns

Promise<number>

The current chain ID. GetChainIdReturnType

getCode()

getCode: (args) => Promise<GetCodeReturnType>

Parameters

Parameter	Type	Description
args	GetCodeParameters	GetBytecodeParameters

Returns

Promise<GetCodeReturnType>

The contract’s bytecode. GetBytecodeReturnType

getContractEvents()

getContractEvents: <abi, eventName, strict, fromBlock, toBlock>(args) => Promise<GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>>

Type Parameters

Type Parameter	Default type
abi extends Abi | readonly unknown[]	-
eventName extends undefined | string	undefined
strict extends undefined | boolean	undefined
fromBlock extends undefined | bigint | BlockTag	undefined
toBlock extends undefined | bigint | BlockTag	undefined

Parameters

Parameter	Type
args	GetContractEventsParameters<abi, eventName, strict, fromBlock, toBlock>

Returns

Promise<GetContractEventsReturnType<abi, eventName, strict, fromBlock, toBlock>>

A list of event logs. GetContractEventsReturnType

getEip712Domain()

getEip712Domain: (args) => Promise<GetEip712DomainReturnType>

Parameters

Parameter	Type
args	GetEip712DomainParameters

Returns

Promise<GetEip712DomainReturnType>

The EIP-712 domain, fields, and extensions. GetEip712DomainReturnType

getEnsAddress()

getEnsAddress: (args) => Promise<GetEnsAddressReturnType>

Parameters

Parameter	Type	Description
args	object	GetEnsAddressParameters
args.blockNumber?	bigint	The balance of the account at a block number.
args.blockTag?	BlockTag	The balance of the account at a block tag. Default 'latest'
args.coinType?	number	ENSIP-9 compliant coinType used to resolve addresses for other chains
args.gatewayUrls?	string[]	Universal Resolver gateway URLs to use for resolving CCIP-read requests.
args.name	string	Name to get the address for.
args.strict?	boolean	Whether or not to throw errors propagated from the ENS Universal Resolver Contract.
args.universalResolverAddress?	`0x${string}`	Address of ENS Universal Resolver Contract.

Returns

Promise<GetEnsAddressReturnType>

Address for ENS name or null if not found. GetEnsAddressReturnType

getEnsAvatar()

getEnsAvatar: (args) => Promise<GetEnsAvatarReturnType>

Parameters

Parameter	Type	Description
args	object	GetEnsAvatarParameters
args.assetGatewayUrls?	AssetGatewayUrls	Gateway urls to resolve IPFS and/or Arweave assets.
args.blockNumber?	bigint	The balance of the account at a block number.
args.blockTag?	BlockTag	The balance of the account at a block tag. Default 'latest'
args.gatewayUrls?	string[]	Universal Resolver gateway URLs to use for resolving CCIP-read requests.
args.name	string	ENS name to get Text for.
args.strict?	boolean	Whether or not to throw errors propagated from the ENS Universal Resolver Contract.
args.universalResolverAddress?	`0x${string}`	Address of ENS Universal Resolver Contract.

Returns

Promise<GetEnsAvatarReturnType>

Avatar URI or null if not found. GetEnsAvatarReturnType

getEnsName()

getEnsName: (args) => Promise<GetEnsNameReturnType>

Parameters

Parameter	Type	Description
args	object	GetEnsNameParameters
args.address	`0x${string}`	Address to get ENS name for.
args.blockNumber?	bigint	The balance of the account at a block number.
args.blockTag?	BlockTag	The balance of the account at a block tag. Default 'latest'
args.gatewayUrls?	string[]	Universal Resolver gateway URLs to use for resolving CCIP-read requests.
args.strict?	boolean	Whether or not to throw errors propagated from the ENS Universal Resolver Contract.
args.universalResolverAddress?	`0x${string}`	Address of ENS Universal Resolver Contract.

Returns

Promise<GetEnsNameReturnType>

Name or null if not found. GetEnsNameReturnType

getEnsResolver()

getEnsResolver: (args) => Promise<`0x${string}`>

Parameters

Parameter	Type	Description
args	object	GetEnsResolverParameters
args.blockNumber?	bigint	The balance of the account at a block number.
args.blockTag?	BlockTag	The balance of the account at a block tag. Default 'latest'
args.name	string	Name to get the address for.
args.universalResolverAddress?	`0x${string}`	Address of ENS Universal Resolver Contract.

Returns

Promise<`0x${string}`>

Address for ENS resolver. GetEnsResolverReturnType

getEnsText()

getEnsText: (args) => Promise<GetEnsTextReturnType>

Parameters

Parameter	Type	Description
args	object	GetEnsTextParameters
args.blockNumber?	bigint	The balance of the account at a block number.
args.blockTag?	BlockTag	The balance of the account at a block tag. Default 'latest'
args.gatewayUrls?	string[]	Universal Resolver gateway URLs to use for resolving CCIP-read requests.
args.key	string	Text record to retrieve.
args.name	string	ENS name to get Text for.
args.strict?	boolean	Whether or not to throw errors propagated from the ENS Universal Resolver Contract.
args.universalResolverAddress?	`0x${string}`	Address of ENS Universal Resolver Contract.

Returns

Promise<GetEnsTextReturnType>

Address for ENS resolver. GetEnsTextReturnType

getFeeHistory()

getFeeHistory: (args) => Promise<GetFeeHistoryReturnType>

Parameters

Parameter	Type	Description
args	GetFeeHistoryParameters	GetFeeHistoryParameters

Returns

Promise<GetFeeHistoryReturnType>

The gas estimate (in wei). GetFeeHistoryReturnType

getFilterChanges()

getFilterChanges: <filterType, abi, eventName, strict, fromBlock, toBlock>(args) => Promise<GetFilterChangesReturnType<filterType, abi, eventName, strict, fromBlock, toBlock>>

Type Parameters

Type Parameter	Default type
filterType extends FilterType	-
abi extends undefined | Abi | readonly unknown[]	-
eventName extends undefined | string	-
strict extends undefined | boolean	undefined
fromBlock extends undefined | bigint | BlockTag	undefined
toBlock extends undefined | bigint | BlockTag	undefined

Parameters

Parameter	Type	Description
args	GetFilterChangesParameters<filterType, abi, eventName, strict, fromBlock, toBlock>	GetFilterChangesParameters

Returns

Promise<GetFilterChangesReturnType<filterType, abi, eventName, strict, fromBlock, toBlock>>

Logs or hashes. GetFilterChangesReturnType

getFilterLogs()

getFilterLogs: <abi, eventName, strict, fromBlock, toBlock>(args) => Promise<GetFilterLogsReturnType<abi, eventName, strict, fromBlock, toBlock>>

Type Parameters

Type Parameter	Default type
abi extends undefined | Abi | readonly unknown[]	-
eventName extends undefined | string	-
strict extends undefined | boolean	undefined
fromBlock extends undefined | bigint | BlockTag	undefined
toBlock extends undefined | bigint | BlockTag	undefined

Parameters

Parameter	Type	Description
args	GetFilterLogsParameters<abi, eventName, strict, fromBlock, toBlock>	GetFilterLogsParameters

Returns

Promise<GetFilterLogsReturnType<abi, eventName, strict, fromBlock, toBlock>>

A list of event logs. GetFilterLogsReturnType

getGasPrice()

getGasPrice: () => Promise<bigint>

Returns

Promise<bigint>

The gas price (in wei). GetGasPriceReturnType

getLogs()

getLogs: <abiEvent, abiEvents, strict, fromBlock, toBlock>(args?) => Promise<GetLogsReturnType<abiEvent, abiEvents, strict, fromBlock, toBlock>>

Type Parameters

Type Parameter	Default type
abiEvent extends undefined | AbiEvent	undefined
abiEvents extends undefined | readonly unknown[] | readonly AbiEvent[]	abiEvent extends AbiEvent ? [abiEvent<abiEvent>] : undefined
strict extends undefined | boolean	undefined
fromBlock extends undefined | bigint | BlockTag	undefined
toBlock extends undefined | bigint | BlockTag	undefined

Parameters

Parameter	Type	Description
args?	GetLogsParameters<abiEvent, abiEvents, strict, fromBlock, toBlock>	GetLogsParameters

Returns

Promise<GetLogsReturnType<abiEvent, abiEvents, strict, fromBlock, toBlock>>

A list of event logs. GetLogsReturnType

getProof()

getProof: (args) => Promise<GetProofReturnType>

Parameters

Parameter	Type
args	GetProofParameters

Returns

Promise<GetProofReturnType>

Proof data. GetProofReturnType

getStorageAt()

getStorageAt: (args) => Promise<GetStorageAtReturnType>

Parameters

Parameter	Type	Description
args	GetStorageAtParameters	GetStorageAtParameters

Returns

Promise<GetStorageAtReturnType>

The value of the storage slot. GetStorageAtReturnType

getTransaction()

getTransaction: <blockTag>(args) => Promise<object | object | object | object | object>

Type Parameters

Type Parameter	Default type
blockTag extends BlockTag	"latest"

Parameters

Parameter	Type	Description
args	GetTransactionParameters<blockTag>	GetTransactionParameters

Returns

Promise<object | object | object | object | object>

The transaction information. GetTransactionReturnType

getTransactionConfirmations()

getTransactionConfirmations: (args) => Promise<bigint>

Parameters

Parameter	Type	Description
args	GetTransactionConfirmationsParameters<Chain>	GetTransactionConfirmationsParameters

Returns

Promise<bigint>

The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. GetTransactionConfirmationsReturnType

getTransactionCount()

getTransactionCount: (args) => Promise<number>

Parameters

Parameter	Type	Description
args	GetTransactionCountParameters	GetTransactionCountParameters

Returns

Promise<number>

The number of transactions an account has sent. GetTransactionCountReturnType

getTransactionReceipt()

getTransactionReceipt: (args) => Promise<TransactionReceipt>

Parameters

Parameter	Type	Description
args	GetTransactionReceiptParameters	GetTransactionReceiptParameters

Returns

Promise<TransactionReceipt>

The transaction receipt. GetTransactionReceiptReturnType

key

key: string

A key for the client.

multicall()

multicall: <contracts, allowFailure>(args) => Promise<MulticallReturnType<contracts, allowFailure>>

Type Parameters

Type Parameter	Default type
contracts extends readonly unknown[]	-
allowFailure extends boolean	true

Parameters

Parameter	Type	Description
args	MulticallParameters<contracts, allowFailure>	MulticallParameters

Returns

Promise<MulticallReturnType<contracts, allowFailure>>

An array of results with accompanying status. MulticallReturnType

name

name: string

A name for the client.

pollingInterval

pollingInterval: number

Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.

prepareTransactionRequest()

prepareTransactionRequest: <request, chainOverride, accountOverride>(args) => Promise<{ [K in string | number | symbol]: (UnionRequiredBy<Extract<UnionOmit<(…), (…)> & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)), IsNever<(…)> extends true ? unknown : ExactPartial<(…)>> & Object, ParameterTypeToParameters<request[“parameters”] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : “type” | “fees” | “gas” | “nonce” | “blobVersionedHashes” | “chainId”>> & (unknown extends request[“kzg”] ? Object : Pick<request, “kzg”>))[K] }>

Type Parameters

Type Parameter	Default type
request extends Omit<object, "from"> | Omit<object, "from"> | Omit<object, "from"> | Omit<object, "from"> | Omit<object, "from"> & object & object	-
chainOverride extends undefined | Chain	undefined
accountOverride extends undefined | `0x${string}` | Account	undefined

Parameters

Parameter	Type	Description
args	PrepareTransactionRequestParameters<Chain, undefined | Account, chainOverride, accountOverride, request>	PrepareTransactionRequestParameters

Returns

Promise<{ [K in string | number | symbol]: (UnionRequiredBy<Extract<UnionOmit<(…), (…)> & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)), IsNever<(…)> extends true ? unknown : ExactPartial<(…)>> & Object, ParameterTypeToParameters<request[“parameters”] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : “type” | “fees” | “gas” | “nonce” | “blobVersionedHashes” | “chainId”>> & (unknown extends request[“kzg”] ? Object : Pick<request, “kzg”>))[K] }>

The transaction request. PrepareTransactionRequestReturnType

readContract()

readContract: <abi, functionName, args>(args) => Promise<ReadContractReturnType<abi, functionName, args>>

Type Parameters

Type Parameter
abi extends Abi | readonly unknown[]
functionName extends string
args extends unknown

Parameters

Parameter	Type	Description
args	ReadContractParameters<abi, functionName, args>	ReadContractParameters

Returns

Promise<ReadContractReturnType<abi, functionName, args>>

The response from the contract. Type is inferred. ReadContractReturnType

request

request: EIP1193RequestFn<PublicRpcSchema>

Request function wrapped with friendly error handling

sendRawTransaction()

sendRawTransaction: (args) => Promise<`0x${string}`>

Parameters

Parameter	Type
args	SendRawTransactionParameters

Returns

Promise<`0x${string}`>

The transaction hash. SendRawTransactionReturnType

simulate()

simulate: <calls>(args) => Promise<SimulateBlocksReturnType<calls>>

Type Parameters

Type Parameter
calls extends readonly unknown[]

Parameters

Parameter	Type
args	SimulateBlocksParameters<calls>

Returns

Promise<SimulateBlocksReturnType<calls>>

Deprecated

Use simulateBlocks instead.

simulateBlocks()

simulateBlocks: <calls>(args) => Promise<SimulateBlocksReturnType<calls>>

Type Parameters

Type Parameter
calls extends readonly unknown[]

Parameters

Parameter	Type
args	SimulateBlocksParameters<calls>

Returns

Promise<SimulateBlocksReturnType<calls>>

Simulated blocks. SimulateReturnType

simulateCalls()

simulateCalls: <calls>(args) => Promise<SimulateCallsReturnType<calls>>

Type Parameters

Type Parameter
calls extends readonly unknown[]

Parameters

Parameter	Type
args	SimulateCallsParameters<calls>

Returns

Promise<SimulateCallsReturnType<calls>>

Results. SimulateCallsReturnType

simulateContract()

simulateContract: <abi, functionName, args, chainOverride, accountOverride>(args) => Promise<SimulateContractReturnType<abi, functionName, args, Chain, undefined | Account, chainOverride, accountOverride>>

Type Parameters

Type Parameter	Default type
abi extends Abi | readonly unknown[]	-
functionName extends string	-
args extends unknown	-
chainOverride extends undefined | Chain	-
accountOverride extends undefined | `0x${string}` | Account	undefined

Parameters

Parameter	Type	Description
args	SimulateContractParameters<abi, functionName, args, Chain, chainOverride, accountOverride>	SimulateContractParameters

Returns

Promise<SimulateContractReturnType<abi, functionName, args, Chain, undefined | Account, chainOverride, accountOverride>>

The simulation result and write request. SimulateContractReturnType

transport

transport: TransportConfig<"http", EIP1193RequestFn> & object

The RPC transport

Type declaration

fetchOptions?

optional fetchOptions: Omit<RequestInit, "body">

url?

optional url: string

type

type: string

The type of client.

uid

uid: string

A unique ID for the client.

uninstallFilter()

uninstallFilter: (args) => Promise<boolean>

Parameters

Parameter	Type	Description
args	UninstallFilterParameters	UninstallFilterParameters

Returns

Promise<boolean>

A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType

verifyMessage()

verifyMessage: (args) => Promise<boolean>

Parameters

Parameter	Type	Description
args	object	-
args.address	`0x${string}`	The address that signed the original message.
args.blockNumber?	bigint	The balance of the account at a block number.
args.blockTag?	BlockTag	The balance of the account at a block tag. Default 'latest'
args.factory?	`0x${string}`	-
args.factoryData?	`0x${string}`	-
args.message	SignableMessage	The message to be verified.
args.signature	`0x${string}` | Signature | ByteArray	The signature that was generated by signing the message with the address’s private key.
args.universalSignatureVerifierAddress?	`0x${string}`	-

Returns

Promise<boolean>

Whether or not the signature is valid. VerifyMessageReturnType

verifySiweMessage()

verifySiweMessage: (args) => Promise<boolean>

Parameters

Parameter	Type	Description
args	object	-
args.address?	`0x${string}`	Ethereum address to check against.
args.blockNumber?	bigint	The balance of the account at a block number.
args.blockTag?	BlockTag	The balance of the account at a block tag. Default 'latest'
args.domain?	string	RFC 3986 authority to check against.
args.message	string	EIP-4361 formatted message.
args.nonce?	string	Random string to check against.
args.scheme?	string	RFC 3986 URI scheme to check against.
args.signature	`0x${string}`	Signature to check against.
args.time?	Date	Current time to check optional expirationTime and notBefore fields. Default new Date()

Returns

Promise<boolean>

Whether or not the signature is valid. VerifySiweMessageReturnType

verifyTypedData()

verifyTypedData: (args) => Promise<boolean>

Parameters

Parameter	Type
args	VerifyTypedDataParameters

Returns

Promise<boolean>

Whether or not the signature is valid. VerifyTypedDataReturnType

waitForTransactionReceipt()

waitForTransactionReceipt: (args) => Promise<TransactionReceipt>

Parameters

Parameter	Type	Description
args	WaitForTransactionReceiptParameters<Chain>	WaitForTransactionReceiptParameters

Returns

Promise<TransactionReceipt>

The transaction receipt. WaitForTransactionReceiptReturnType

watchBlockNumber()

watchBlockNumber: (args) => WatchBlockNumberReturnType

Parameters

Parameter	Type	Description
args	WatchBlockNumberParameters	WatchBlockNumberParameters

Returns

WatchBlockNumberReturnType

A function that can be invoked to stop watching for new block numbers. WatchBlockNumberReturnType

watchBlocks()

watchBlocks: <includeTransactions, blockTag>(args) => WatchBlocksReturnType

Type Parameters

Type Parameter	Default type
includeTransactions extends boolean	false
blockTag extends BlockTag	"latest"

Parameters

Parameter	Type	Description
args	WatchBlocksParameters<HttpTransport, Chain, includeTransactions, blockTag>	WatchBlocksParameters

Returns

WatchBlocksReturnType

A function that can be invoked to stop watching for new block numbers. WatchBlocksReturnType

watchContractEvent()

watchContractEvent: <abi, eventName, strict>(args) => WatchContractEventReturnType

Type Parameters

Type Parameter	Default type
abi extends Abi | readonly unknown[]	-
eventName extends string	-
strict extends undefined | boolean	undefined

Parameters

Parameter	Type	Description
args	WatchContractEventParameters<abi, eventName, strict, HttpTransport>	WatchContractEventParameters

Returns

WatchContractEventReturnType

A function that can be invoked to stop watching for new event logs. WatchContractEventReturnType

watchEvent()

watchEvent: <abiEvent, abiEvents, strict>(args) => WatchEventReturnType

Type Parameters

Type Parameter	Default type
abiEvent extends undefined | AbiEvent	undefined
abiEvents extends undefined | readonly unknown[] | readonly AbiEvent[]	abiEvent extends AbiEvent ? [abiEvent<abiEvent>] : undefined
strict extends undefined | boolean	undefined

Parameters

Parameter	Type	Description
args	WatchEventParameters<abiEvent, abiEvents, strict, HttpTransport>	WatchEventParameters

Returns

WatchEventReturnType

A function that can be invoked to stop watching for new Event Logs. WatchEventReturnType

watchPendingTransactions()

watchPendingTransactions: (args) => WatchPendingTransactionsReturnType

Parameters

Parameter	Type	Description
args	WatchPendingTransactionsParameters<HttpTransport>	WatchPendingTransactionsParameters

Returns

WatchPendingTransactionsReturnType

A function that can be invoked to stop watching for new pending transaction hashes. WatchPendingTransactionsReturnType

​

Defined in

packages/wallets/src/wallets/evm.ts:124

---

​

send()

send<T>(to, token, amount, options?): Promise<Transaction<T extends object ? true : false>>

Send a token to a wallet or user locator

​

Type Parameters

Type Parameter	Default type
T extends undefined | TransactionInputOptions	undefined

​

Parameters

Parameter	Type	Description
to	string | UserLocator	The recipient (address or user locator)
token	string	The token (address or currency symbol)
amount	string	The amount to send (decimal units)
options?	T	The options for the transaction

​

Returns

Promise<Transaction<T extends object ? true : false>>

The transaction

​

Inherited from

Wallet.send

​

Defined in

packages/wallets/src/wallets/wallet.ts:202

---

​

sendTransaction()

sendTransaction<T>(params): Promise<Transaction<T["options"] extends object ? true : false>>

​

Type Parameters

Type Parameter
T extends EVMTransactionInput

​

Parameters

Parameter	Type
params	T

​

Returns

Promise<Transaction<T["options"] extends object ? true : false>>

​

Defined in

packages/wallets/src/wallets/evm.ts:40

---

​

signMessage()

signMessage(message): Promise<string>

​

Parameters

Parameter	Type
message	string

​

Returns

Promise<string>

​

Defined in

packages/wallets/src/wallets/evm.ts:57

---

​

signTypedData()

signTypedData<typedData, primaryType>(params): Promise<string>

​

Type Parameters

Type Parameter	Default type
typedData extends Record<string, unknown> | object	-
primaryType extends string | number | symbol	keyof typedData

​

Parameters

Parameter	Type
params	TypedDataDefinition<typedData, primaryType, typedData extends object ? keyof typedData<typedData> : string> & object

​

Returns

Promise<string>

​

Defined in

packages/wallets/src/wallets/evm.ts:76

---

​

from()

static from(wallet): EVMWallet

​

Parameters

Parameter	Type
wallet	Wallet<Chain>

​

Returns

EVMWallet

​

Defined in

packages/wallets/src/wallets/evm.ts:32