@across-protocol/app-sdk / AcrossClient

Class: AcrossClient

Entrypoint for the Across Integrator SDK

Properties

logger

logger: LoggerT

Defined in

packages/sdk/src/client.ts:143

Accessors

isTenderlyEnabled

get isTenderlyEnabled(): boolean

Returns

boolean

Defined in

packages/sdk/src/client.ts:153

Methods

executeQuote()

executeQuote(params): Promise<void>

Execute a quote by:

Approving the SpokePool contract if necessary
Depositing the input token on the origin chain
Waiting for the deposit to be filled on the destination chain

See executeQuote for more details.

Parameters

• params: Omit<ExecuteQuoteParams, "logger" | "integratorId" | "originClient" | "destinationClient">

See ExecuteQuoteParams.

Returns

Promise<void>

The deposit ID and receipts for the deposit and fill transactions.

Example

const quote = await client.getQuote({ route, inputAmount });
const { depositId } = await client.executeQuote({ deposit: quote.deposit });

Defined in

packages/sdk/src/client.ts:244

getAvailableRoutes()

getAvailableRoutes(params): Promise<GetAvailableRoutesReturnType>

Get the available routes for a given set of parameters. See getAvailableRoutes.

Parameters

• params: Omit<GetAvailableRoutesParams, "logger" | "apiUrl">

See GetAvailableRoutesParams.

Returns

Promise<GetAvailableRoutesReturnType>

See GetAvailableRoutesReturnType.

Defined in

packages/sdk/src/client.ts:320

getDeposit()

getDeposit(params): Promise<Deposit>

Get a deposit by its deposit tx hash or deposit id + spoke pool address. See getDeposit.

Parameters

• params: Omit<GetDepositParams, "destinationChainClient" | "indexerUrl" | "originChainClient">

See GetDepositParams.

Returns

Promise<Deposit>

See Deposit.

Defined in

packages/sdk/src/client.ts:531

getFillByDepositTx()

getFillByDepositTx(params): Promise<FillStatus>

Get a fill after a deposit has been made. See getFillByDepositTx.

Parameters

• params: Omit<GetFillByDepositTxParams, "logger" | "destinationChainClient" | "indexerUrl" | "originChainClient">

See GetFillByDepositTxParams.

Returns

Promise<FillStatus>

See FillStatus.

Defined in

packages/sdk/src/client.ts:499

getLimits()

getLimits(params): Promise<GetLimitsReturnType>

Get the deposit limits for a given route. See getLimits.

Parameters

• params: Omit<GetLimitsParams, "logger" | "apiUrl">

See GetLimitsParams.

Returns

Promise<GetLimitsReturnType>

See GetLimitsReturnType.

Defined in

packages/sdk/src/client.ts:374

getPublicClient()

getPublicClient(chainId): object

Internal

Parameters

• chainId: number

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>

Executes a new message call immediately without submitting a transaction to the network.

Docs: https://viem.sh/docs/actions/public/call
JSON-RPC Methods: eth_call

Parameters

• parameters: CallParameters<Chain>

Returns

Promise<CallReturnType>

The call data. CallReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const data = await client.call({
  account: "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
  data: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
  to: "0x70997970c51812dc3a010c7d01b50e0d17dc79c8",
});

ccipRead?

optional ccipRead: false | object

CCIP Read configuration.

chain

chain: Chain

Chain for the client.

createBlockFilter()

createBlockFilter: () => Promise<object>

Creates a Filter to listen for new block hashes that can be used with getFilterChanges.

Docs: https://viem.sh/docs/actions/public/createBlockFilter
JSON-RPC Methods: eth_newBlockFilter

Returns

Promise<object>

Filter. CreateBlockFilterReturnType

id

id: `0x${string}`

request

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

type

type: "block"

Example

import { createPublicClient, createBlockFilter, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await createBlockFilter(client);
// { id: "0x345a6572337856574a76364e457a4366", type: 'block' }

createContractEventFilter()

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

Creates a Filter to retrieve event logs that can be used with getFilterChanges or getFilterLogs.

Docs: https://viem.sh/docs/contract/createContractEventFilter

Type Parameters

• 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

• args: CreateContractEventFilterParameters<abi, eventName, args, strict, fromBlock, toBlock>

CreateContractEventFilterParameters

Returns

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

Filter. CreateContractEventFilterReturnType

Example

import { createPublicClient, http, parseAbi } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await client.createContractEventFilter({
  abi: parseAbi(["event Transfer(address indexed, address indexed, uint256)"]),
});

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

Creates a Filter to listen for new events that can be used with getFilterChanges.

Docs: https://viem.sh/docs/actions/public/createEventFilter
JSON-RPC Methods: eth_newFilter

Type Parameters

• 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

• 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

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await client.createEventFilter({
  address: "0xfba3912ca04dd458c843e2ee08967fc04f3579c2",
});

createPendingTransactionFilter()

createPendingTransactionFilter: () => Promise<object>

Creates a Filter to listen for new pending transaction hashes that can be used with getFilterChanges.

Docs: https://viem.sh/docs/actions/public/createPendingTransactionFilter
JSON-RPC Methods: eth_newPendingTransactionFilter

Returns

Promise<object>

Filter. CreateBlockFilterReturnType

id

id: `0x${string}`

request

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

type

type: "transaction"

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await client.createPendingTransactionFilter();
// { id: "0x345a6572337856574a76364e457a4366", type: 'transaction' }

estimateContractGas()

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

Estimates the gas required to successfully execute a contract write function call.

Docs: https://viem.sh/docs/contract/estimateContractGas

Type Parameters

• chain extends undefined | Chain

• abi extends Abi | readonly unknown[]

• functionName extends string

• args extends unknown

Parameters

• args: EstimateContractGasParameters<abi, functionName, args, chain>

EstimateContractGasParameters

Returns

Promise<bigint>

The gas estimate (in wei). EstimateContractGasReturnType

Remarks

Internally, uses a Public Client to call the estimateGas action with ABI-encoded data.

Example

import { createPublicClient, http, parseAbi } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const gas = await client.estimateContractGas({
  address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
  abi: parseAbi(["function mint() public"]),
  functionName: "mint",
  account: "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266",
});

estimateFeesPerGas()

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

Returns an estimate for the fees per gas for a transaction to be included in the next block.

Docs: https://viem.sh/docs/actions/public/estimateFeesPerGas

Type Parameters

• chainOverride extends undefined | Chain = undefined

• type extends FeeValuesType = "eip1559"

Parameters

• args?: EstimateFeesPerGasParameters<Chain, chainOverride, type>

Returns

Promise<EstimateFeesPerGasReturnType<type>>

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

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const maxPriorityFeePerGas = await client.estimateFeesPerGas();
// { maxFeePerGas: ..., maxPriorityFeePerGas: ... }

estimateGas()

estimateGas: (args) => Promise<bigint>

Estimates the gas necessary to complete a transaction without submitting it to the network.

Docs: https://viem.sh/docs/actions/public/estimateGas
JSON-RPC Methods: eth_estimateGas

Parameters

• args: EstimateGasParameters<Chain>

EstimateGasParameters

Returns

Promise<bigint>

The gas estimate (in wei). EstimateGasReturnType

Example

import { createPublicClient, http, parseEther } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const gasEstimate = await client.estimateGas({
  account: "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e",
  to: "0x70997970c51812dc3a010c7d01b50e0d17dc79c8",
  value: parseEther("1"),
});

estimateMaxPriorityFeePerGas()

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

Returns an estimate for the max priority fee per gas (in wei) for a transaction to be included in the next block.

Docs: https://viem.sh/docs/actions/public/estimateMaxPriorityFeePerGas

Type Parameters

• chainOverride extends undefined | Chain = undefined

Parameters

• args?

• args.chain?: null | chainOverride

Returns

Promise<bigint>

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

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const maxPriorityFeePerGas = await client.estimateMaxPriorityFeePerGas();
// 10000000n

extend()

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

Type Parameters

• client extends object & ExactPartial<ExtendableProtectedActions<Transport, Chain, undefined>>

Parameters

• fn

Returns

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

getBalance()

getBalance: (args) => Promise<bigint>

Returns the balance of an address in wei.

Docs: https://viem.sh/docs/actions/public/getBalance
JSON-RPC Methods: eth_getBalance

Parameters

• args: GetBalanceParameters

GetBalanceParameters

Returns

Promise<bigint>

The balance of the address in wei. GetBalanceReturnType

Remarks

You can convert the balance to ether units with formatEther.

const balance = await getBalance(client, {
  address: "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e",
  blockTag: "safe",
});
const balanceAsEther = formatEther(balance);
// "6.942"

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const balance = await client.getBalance({
  address: "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e",
});
// 10000000000000000000000n (wei)

getBlobBaseFee()

getBlobBaseFee: () => Promise<bigint>

Returns the base fee per blob gas in wei.

Docs: https://viem.sh/docs/actions/public/getBlobBaseFee
JSON-RPC Methods: eth_blobBaseFee

Returns

Promise<bigint>

The blob base fee (in wei). GetBlobBaseFeeReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";
import { getBlobBaseFee } from "viem/public";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const blobBaseFee = await client.getBlobBaseFee();

getBlock()

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

Returns information about a block at a block number, hash, or tag.

Docs: https://viem.sh/docs/actions/public/getBlock
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks
JSON-RPC Methods:
- Calls eth_getBlockByNumber for blockNumber & blockTag.
- Calls eth_getBlockByHash for blockHash.

Type Parameters

• includeTransactions extends boolean = false

• blockTag extends BlockTag = "latest"

Parameters

• 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

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

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const block = await client.getBlock();

getBlockNumber()

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

Returns the number of the most recent block seen.

Docs: https://viem.sh/docs/actions/public/getBlockNumber
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/fetching-blocks
JSON-RPC Methods: eth_blockNumber

Parameters

• args?: GetBlockNumberParameters

GetBlockNumberParameters

Returns

Promise<bigint>

The number of the block. GetBlockNumberReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const blockNumber = await client.getBlockNumber();
// 69420n

getBlockTransactionCount()

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

Returns the number of Transactions at a block number, hash, or tag.

Docs: https://viem.sh/docs/actions/public/getBlockTransactionCount
JSON-RPC Methods:
- Calls eth_getBlockTransactionCountByNumber for blockNumber & blockTag.
- Calls eth_getBlockTransactionCountByHash for blockHash.

Parameters

• args?: GetBlockTransactionCountParameters

GetBlockTransactionCountParameters

Returns

Promise<number>

The block transaction count. GetBlockTransactionCountReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const count = await client.getBlockTransactionCount();

getBytecode()

getBytecode: (args) => Promise<GetCodeReturnType>

Parameters

• args: GetCodeParameters

Returns

Promise<GetCodeReturnType>

Deprecated

Use getCode instead.

getChainId()

getChainId: () => Promise<number>

Returns the chain ID associated with the current network.

Docs: https://viem.sh/docs/actions/public/getChainId
JSON-RPC Methods: eth_chainId

Returns

Promise<number>

The current chain ID. GetChainIdReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const chainId = await client.getChainId();
// 1

getCode()

getCode: (args) => Promise<GetCodeReturnType>

Retrieves the bytecode at an address.

Docs: https://viem.sh/docs/contract/getCode
JSON-RPC Methods: eth_getCode

Parameters

• args: GetCodeParameters

GetBytecodeParameters

Returns

Promise<GetCodeReturnType>

The contract's bytecode. GetBytecodeReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const code = await client.getCode({
  address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
});

getContractEvents()

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

Returns a list of event logs emitted by a contract.

Docs: https://viem.sh/docs/actions/public/getContractEvents
JSON-RPC Methods: eth_getLogs

Type Parameters

• 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

• args: GetContractEventsParameters<abi, eventName, strict, fromBlock, toBlock>

Returns

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

A list of event logs. GetContractEventsReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";
import { wagmiAbi } from "./abi";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const logs = await client.getContractEvents(client, {
  address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
  abi: wagmiAbi,
  eventName: "Transfer",
});

getEip712Domain()

getEip712Domain: (args) => Promise<GetEip712DomainReturnType>

Reads the EIP-712 domain from a contract, based on the ERC-5267 specification.

Parameters

• args: GetEip712DomainParameters

Returns

Promise<GetEip712DomainReturnType>

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

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});

const domain = await client.getEip712Domain({
  address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
});
// {
//   domain: {
//     name: 'ExampleContract',
//     version: '1',
//     chainId: 1,
//     verifyingContract: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
//   },
//   fields: '0x0f',
//   extensions: [],
// }

getEnsAddress()

getEnsAddress: (args) => Promise<GetEnsAddressReturnType>

Gets address for ENS name.

Docs: https://viem.sh/docs/ens/actions/getEnsAddress
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens

Parameters

• args

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

Remarks

Calls resolve(bytes, bytes) on ENS Universal Resolver Contract.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";
import { normalize } from "viem/ens";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const ensAddress = await client.getEnsAddress({
  name: normalize("wevm.eth"),
});
// '0xd2135CfB216b74109775236E36d4b433F1DF507B'

getEnsAvatar()

getEnsAvatar: (args) => Promise<GetEnsAvatarReturnType>

Gets the avatar of an ENS name.

Docs: https://viem.sh/docs/ens/actions/getEnsAvatar
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens

Parameters

• args

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

Remarks

Calls getEnsText with key set to 'avatar'.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";
import { normalize } from "viem/ens";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const ensAvatar = await client.getEnsAvatar({
  name: normalize("wevm.eth"),
});
// 'https://ipfs.io/ipfs/Qma8mnp6xV3J2cRNf3mTth5C8nV11CAnceVinc3y8jSbio'

getEnsName()

getEnsName: (args) => Promise<GetEnsNameReturnType>

Gets primary name for specified address.

Docs: https://viem.sh/docs/ens/actions/getEnsName
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens

Parameters

• args

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

Remarks

Calls reverse(bytes) on ENS Universal Resolver Contract to "reverse resolve" the address to the primary ENS name.

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const ensName = await client.getEnsName({
  address: "0xd2135CfB216b74109775236E36d4b433F1DF507B",
});
// 'wevm.eth'

getEnsResolver()

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

Gets resolver for ENS name.

Docs: https://viem.sh/docs/ens/actions/getEnsResolver
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens

Parameters

• args

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

Remarks

Calls findResolver(bytes) on ENS Universal Resolver Contract to retrieve the resolver of an ENS name.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";
import { normalize } from "viem/ens";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const resolverAddress = await client.getEnsResolver({
  name: normalize("wevm.eth"),
});
// '0x4976fb03C32e5B8cfe2b6cCB31c09Ba78EBaBa41'

getEnsText()

getEnsText: (args) => Promise<GetEnsTextReturnType>

Gets a text record for specified ENS name.

Docs: https://viem.sh/docs/ens/actions/getEnsResolver
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/ens

Parameters

• args

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

Remarks

Calls resolve(bytes, bytes) on ENS Universal Resolver Contract.

Since ENS names prohibit certain forbidden characters (e.g. underscore) and have other validation rules, you likely want to normalize ENS names with UTS-46 normalization before passing them to getEnsAddress. You can use the built-in normalize function for this.

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";
import { normalize } from "viem/ens";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const twitterRecord = await client.getEnsText({
  name: normalize("wevm.eth"),
  key: "com.twitter",
});
// 'wevm_dev'

getFeeHistory()

getFeeHistory: (args) => Promise<GetFeeHistoryReturnType>

Returns a collection of historical gas information.

Docs: https://viem.sh/docs/actions/public/getFeeHistory
JSON-RPC Methods: eth_feeHistory

Parameters

• args: GetFeeHistoryParameters

GetFeeHistoryParameters

Returns

Promise<GetFeeHistoryReturnType>

The gas estimate (in wei). GetFeeHistoryReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const feeHistory = await client.getFeeHistory({
  blockCount: 4,
  rewardPercentiles: [25, 75],
});

getFilterChanges()

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

Returns a list of logs or hashes based on a Filter since the last time it was called.

Docs: https://viem.sh/docs/actions/public/getFilterChanges
JSON-RPC Methods: eth_getFilterChanges

Type Parameters

• 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

• args: GetFilterChangesParameters<filterType, abi, eventName, strict, fromBlock, toBlock>

GetFilterChangesParameters

Returns

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

Logs or hashes. GetFilterChangesReturnType

Remarks

A Filter can be created from the following actions:

createBlockFilter
createContractEventFilter
createEventFilter
createPendingTransactionFilter

Depending on the type of filter, the return value will be different:

If the filter was created with createContractEventFilter or createEventFilter, it returns a list of logs.
If the filter was created with createPendingTransactionFilter, it returns a list of transaction hashes.
If the filter was created with createBlockFilter, it returns a list of block hashes.

Examples

// Blocks
import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await client.createBlockFilter();
const hashes = await client.getFilterChanges({ filter });

// Contract Events
import { createPublicClient, http, parseAbi } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await client.createContractEventFilter({
  address: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
  abi: parseAbi(["event Transfer(address indexed, address indexed, uint256)"]),
  eventName: "Transfer",
});
const logs = await client.getFilterChanges({ filter });

// Raw Events
import { createPublicClient, http, parseAbiItem } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await client.createEventFilter({
  address: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
  event: parseAbiItem(
    "event Transfer(address indexed, address indexed, uint256)",
  ),
});
const logs = await client.getFilterChanges({ filter });

// Transactions
import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await client.createPendingTransactionFilter();
const hashes = await client.getFilterChanges({ filter });

getFilterLogs()

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

Returns a list of event logs since the filter was created.

Docs: https://viem.sh/docs/actions/public/getFilterLogs
JSON-RPC Methods: eth_getFilterLogs

Type Parameters

• 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

• args: GetFilterLogsParameters<abi, eventName, strict, fromBlock, toBlock>

GetFilterLogsParameters

Returns

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

A list of event logs. GetFilterLogsReturnType

Remarks

getFilterLogs is only compatible with event filters.

Example

import { createPublicClient, http, parseAbiItem } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const filter = await client.createEventFilter({
  address: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
  event: parseAbiItem(
    "event Transfer(address indexed, address indexed, uint256)",
  ),
});
const logs = await client.getFilterLogs({ filter });

getGasPrice()

getGasPrice: () => Promise<bigint>

Returns the current price of gas (in wei).

Docs: https://viem.sh/docs/actions/public/getGasPrice
JSON-RPC Methods: eth_gasPrice

Returns

Promise<bigint>

The gas price (in wei). GetGasPriceReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const gasPrice = await client.getGasPrice();

getLogs()

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

Returns a list of event logs matching the provided parameters.

Docs: https://viem.sh/docs/actions/public/getLogs
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/filters-and-logs/event-logs
JSON-RPC Methods: eth_getLogs

Type Parameters

• 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

• args?: GetLogsParameters<abiEvent, abiEvents, strict, fromBlock, toBlock>

GetLogsParameters

Returns

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

A list of event logs. GetLogsReturnType

Example

import { createPublicClient, http, parseAbiItem } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const logs = await client.getLogs();

getProof()

getProof: (args) => Promise<GetProofReturnType>

Returns the account and storage values of the specified account including the Merkle-proof.

Docs: https://viem.sh/docs/actions/public/getProof
JSON-RPC Methods:
- Calls eth_getProof

Parameters

• args: GetProofParameters

Returns

Promise<GetProofReturnType>

Proof data. GetProofReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const block = await client.getProof({
  address: "0x...",
  storageKeys: ["0x..."],
});

getStorageAt()

getStorageAt: (args) => Promise<GetStorageAtReturnType>

Returns the value from a storage slot at a given address.

Docs: https://viem.sh/docs/contract/getStorageAt
JSON-RPC Methods: eth_getStorageAt

Parameters

• args: GetStorageAtParameters

GetStorageAtParameters

Returns

Promise<GetStorageAtReturnType>

The value of the storage slot. GetStorageAtReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";
import { getStorageAt } from "viem/contract";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const code = await client.getStorageAt({
  address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
  slot: toHex(0),
});

getTransaction()

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

Returns information about a Transaction given a hash or block identifier.

Docs: https://viem.sh/docs/actions/public/getTransaction
Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
JSON-RPC Methods: eth_getTransactionByHash

Type Parameters

• blockTag extends BlockTag = "latest"

Parameters

• args: GetTransactionParameters<blockTag>

GetTransactionParameters

Returns

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

The transaction information. GetTransactionReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const transaction = await client.getTransaction({
  hash: "0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d",
});

getTransactionConfirmations()

getTransactionConfirmations: (args) => Promise<bigint>

Returns the number of blocks passed (confirmations) since the transaction was processed on a block.

Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations
Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
JSON-RPC Methods: eth_getTransactionConfirmations

Parameters

• 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

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const confirmations = await client.getTransactionConfirmations({
  hash: "0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d",
});

getTransactionCount()

getTransactionCount: (args) => Promise<number>

Returns the number of Transactions an Account has broadcast / sent.

Docs: https://viem.sh/docs/actions/public/getTransactionCount
JSON-RPC Methods: eth_getTransactionCount

Parameters

• args: GetTransactionCountParameters

GetTransactionCountParameters

Returns

Promise<number>

The number of transactions an account has sent. GetTransactionCountReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const transactionCount = await client.getTransactionCount({
  address: "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e",
});

getTransactionReceipt()

getTransactionReceipt: (args) => Promise<TransactionReceipt>

Returns the Transaction Receipt given a Transaction hash.

Docs: https://viem.sh/docs/actions/public/getTransactionReceipt
Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/fetching-transactions
JSON-RPC Methods: eth_getTransactionReceipt

Parameters

• args: GetTransactionReceiptParameters

GetTransactionReceiptParameters

Returns

Promise<TransactionReceipt>

The transaction receipt. GetTransactionReceiptReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const transactionReceipt = await client.getTransactionReceipt({
  hash: "0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d",
});

key

key: string

A key for the client.

multicall()

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

Similar to readContract, but batches up multiple functions on a contract in a single RPC call via the multicall3 contract.

Docs: https://viem.sh/docs/contract/multicall

Type Parameters

• contracts extends readonly unknown[]

• allowFailure extends boolean = true

Parameters

• args: MulticallParameters<contracts, allowFailure>

MulticallParameters

Returns

Promise<MulticallReturnType<contracts, allowFailure>>

An array of results with accompanying status. MulticallReturnType

Example

import { createPublicClient, http, parseAbi } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const abi = parseAbi([
  "function balanceOf(address) view returns (uint256)",
  "function totalSupply() view returns (uint256)",
]);
const result = await client.multicall({
  contracts: [
    {
      address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
      abi,
      functionName: "balanceOf",
      args: ["0xA0Cf798816D4b9b9866b5330EEa46a18382f251e"],
    },
    {
      address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
      abi,
      functionName: "totalSupply",
    },
  ],
});
// [{ result: 424122n, status: 'success' }, { result: 1000000n, status: 'success' }]

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" | "gas" | "nonce" | "blobVersionedHashes" | "fees" | "chainId">> & (unknown extends request["kzg"] ? Object : Pick<request, "kzg">))[K] }>

Prepares a transaction request for signing.

Docs: https://viem.sh/docs/actions/wallet/prepareTransactionRequest

Type Parameters

• 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

• 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" | "gas" | "nonce" | "blobVersionedHashes" | "fees" | "chainId">> & (unknown extends request["kzg"] ? Object : Pick<request, "kzg">))[K] }>

The transaction request. PrepareTransactionRequestReturnType

Examples

import { createWalletClient, custom } from "viem";
import { mainnet } from "viem/chains";

const client = createWalletClient({
  chain: mainnet,
  transport: custom(window.ethereum),
});
const request = await client.prepareTransactionRequest({
  account: "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e",
  to: "0x0000000000000000000000000000000000000000",
  value: 1n,
});

// Account Hoisting
import { createWalletClient, http } from "viem";
import { privateKeyToAccount } from "viem/accounts";
import { mainnet } from "viem/chains";

const client = createWalletClient({
  account: privateKeyToAccount("0x…"),
  chain: mainnet,
  transport: custom(window.ethereum),
});
const request = await client.prepareTransactionRequest({
  to: "0x0000000000000000000000000000000000000000",
  value: 1n,
});

readContract()

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

Calls a read-only function on a contract, and returns the response.

Docs: https://viem.sh/docs/contract/readContract
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/reading-contracts

Type Parameters

• abi extends Abi | readonly unknown[]

• functionName extends string

• args extends unknown

Parameters

• args: ReadContractParameters<abi, functionName, args>

ReadContractParameters

Returns

Promise<ReadContractReturnType<abi, functionName, args>>

The response from the contract. Type is inferred. ReadContractReturnType

Remarks

A "read-only" function (constant function) on a Solidity contract is denoted by a view or pure keyword. They can only read the state of the contract, and cannot make any changes to it. Since read-only methods do not change the state of the contract, they do not require any gas to be executed, and can be called by any user without the need to pay for gas.

Internally, uses a Public Client to call the call action with ABI-encoded data.

Example

import { createPublicClient, http, parseAbi } from "viem";
import { mainnet } from "viem/chains";
import { readContract } from "viem/contract";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const result = await client.readContract({
  address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
  abi: parseAbi(["function balanceOf(address) view returns (uint256)"]),
  functionName: "balanceOf",
  args: ["0xA0Cf798816D4b9b9866b5330EEa46a18382f251e"],
});
// 424122n

request

request: EIP1193RequestFn<PublicRpcSchema>

Request function wrapped with friendly error handling

sendRawTransaction()

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

Sends a signed transaction to the network

Docs: https://viem.sh/docs/actions/wallet/sendRawTransaction
JSON-RPC Method: eth_sendRawTransaction

Parameters

• args: SendRawTransactionParameters

Returns

Promise<`0x${string}`>

The transaction hash. SendRawTransactionReturnType

Example

import { createWalletClient, custom } from "viem";
import { mainnet } from "viem/chains";
import { sendRawTransaction } from "viem/wallet";

const client = createWalletClient({
  chain: mainnet,
  transport: custom(window.ethereum),
});

const hash = await client.sendRawTransaction({
  serializedTransaction:
    "0x02f850018203118080825208808080c080a04012522854168b27e5dc3d5839bab5e6b39e1a0ffd343901ce1622e3d64b48f1a04e00902ae0502c4728cbf12156290df99c3ed7de85b1dbfe20b5c36931733a33",
});

simulateContract()

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

Simulates/validates a contract interaction. This is useful for retrieving return data and revert reasons of contract write functions.

Docs: https://viem.sh/docs/contract/simulateContract
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/contracts/writing-to-contracts

Type Parameters

• abi extends Abi | readonly unknown[]

• functionName extends string

• args extends unknown

• chainOverride extends undefined | Chain

• accountOverride extends undefined | `0x${string}` | Account = undefined

Parameters

• 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

Remarks

This function does not require gas to execute and does not change the state of the blockchain. It is almost identical to readContract, but also supports contract write functions.

Internally, uses a Public Client to call the call action with ABI-encoded data.

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const result = await client.simulateContract({
  address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
  abi: parseAbi(["function mint(uint32) view returns (uint32)"]),
  functionName: "mint",
  args: ["69420"],
  account: "0xA0Cf798816D4b9b9866b5330EEa46a18382f251e",
});

transport

transport: TransportConfig<string, EIP1193RequestFn> & Record<string, any>

The RPC transport

type

type: string

The type of client.

uid

uid: string

A unique ID for the client.

uninstallFilter()

uninstallFilter: (args) => Promise<boolean>

Destroys a Filter that was created from one of the following Actions:

createBlockFilter
createEventFilter
createPendingTransactionFilter
Docs: https://viem.sh/docs/actions/public/uninstallFilter
JSON-RPC Methods: eth_uninstallFilter

Parameters

• args: UninstallFilterParameters

UninstallFilterParameters

Returns

Promise<boolean>

A boolean indicating if the Filter was successfully uninstalled. UninstallFilterReturnType

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";
import { createPendingTransactionFilter, uninstallFilter } from "viem/public";

const filter = await client.createPendingTransactionFilter();
const uninstalled = await client.uninstallFilter({ filter });
// true

verifyMessage()

verifyMessage: (args) => Promise<boolean>

Verify that a message was signed by the provided address.

Compatible with Smart Contract Accounts & Externally Owned Accounts via ERC-6492.

Docs https://viem.sh/docs/actions/public/verifyMessage

Parameters

• args

• 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}` | Uint8Array | Signature

The signature that was generated by signing the message with the address's private key.

Returns

Promise<boolean>

Whether or not the signature is valid. VerifyMessageReturnType

verifySiweMessage()

verifySiweMessage: (args) => Promise<boolean>

Verifies EIP-4361 formatted message was signed.

Compatible with Smart Contract Accounts & Externally Owned Accounts via ERC-6492.

Docs https://viem.sh/docs/siwe/actions/verifySiweMessage

Parameters

• args

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

Verify that typed data was signed by the provided address.

Docs https://viem.sh/docs/actions/public/verifyTypedData

Parameters

• args: VerifyTypedDataParameters

Returns

Promise<boolean>

Whether or not the signature is valid. VerifyTypedDataReturnType

waitForTransactionReceipt()

waitForTransactionReceipt: (args) => Promise<TransactionReceipt>

Waits for the Transaction to be included on a Block (one confirmation), and then returns the Transaction Receipt. If the Transaction reverts, then the action will throw an error.

Docs: https://viem.sh/docs/actions/public/waitForTransactionReceipt
Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions/sending-transactions
JSON-RPC Methods:
- Polls eth_getTransactionReceipt on each block until it has been processed.
- If a Transaction has been replaced:
  - Calls eth_getBlockByNumber and extracts the transactions
  - Checks if one of the Transactions is a replacement
  - If so, calls eth_getTransactionReceipt.

Parameters

• args: WaitForTransactionReceiptParameters<Chain>

WaitForTransactionReceiptParameters

Returns

Promise<TransactionReceipt>

The transaction receipt. WaitForTransactionReceiptReturnType

Remarks

The waitForTransactionReceipt action additionally supports Replacement detection (e.g. sped up Transactions).

Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel). Transactions are replaced when they are sent from the same nonce.

There are 3 types of Transaction Replacement reasons:

repriced: The gas price has been modified (e.g. different maxFeePerGas)
cancelled: The Transaction has been cancelled (e.g. value === 0n)
replaced: The Transaction has been replaced (e.g. different value or data)

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const transactionReceipt = await client.waitForTransactionReceipt({
  hash: "0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d",
});

watchBlockNumber()

watchBlockNumber: (args) => WatchBlockNumberReturnType

Watches and returns incoming block numbers.

Docs: https://viem.sh/docs/actions/public/watchBlockNumber
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks
JSON-RPC Methods:
- When poll: true, calls eth_blockNumber on a polling interval.
- When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newHeads" event.

Parameters

• args: WatchBlockNumberParameters

WatchBlockNumberParameters

Returns

WatchBlockNumberReturnType

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

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const unwatch = await client.watchBlockNumber({
  onBlockNumber: (blockNumber) => console.log(blockNumber),
});

watchBlocks()

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

Watches and returns information for incoming blocks.

Docs: https://viem.sh/docs/actions/public/watchBlocks
Examples: https://stackblitz.com/github/wevm/viem/tree/main/examples/blocks/watching-blocks
JSON-RPC Methods:
- When poll: true, calls eth_getBlockByNumber on a polling interval.
- When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newHeads" event.

Type Parameters

• includeTransactions extends boolean = false

• blockTag extends BlockTag = "latest"

Parameters

• args: WatchBlocksParameters<Transport, Chain, includeTransactions, blockTag>

WatchBlocksParameters

Returns

WatchBlocksReturnType

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

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const unwatch = await client.watchBlocks({
  onBlock: (block) => console.log(block),
});

watchContractEvent()

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

Watches and returns emitted contract event logs.

Docs: https://viem.sh/docs/contract/watchContractEvent

Type Parameters

• abi extends Abi | readonly unknown[]

• eventName extends string

• strict extends undefined | boolean = undefined

Parameters

• args: WatchContractEventParameters<abi, eventName, strict, Transport>

WatchContractEventParameters

Returns

WatchContractEventReturnType

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

Remarks

This Action will batch up all the event logs found within the pollingInterval, and invoke them via onLogs.

watchContractEvent will attempt to create an Event Filter and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. eth_newFilter), then watchContractEvent will fall back to using getLogs instead.

Example

import { createPublicClient, http, parseAbi } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const unwatch = client.watchContractEvent({
  address: "0xFBA3912Ca04dd458c843e2EE08967fC04f3579c2",
  abi: parseAbi([
    "event Transfer(address indexed from, address indexed to, uint256 value)",
  ]),
  eventName: "Transfer",
  args: { from: "0xc961145a54C96E3aE9bAA048c4F4D6b04C13916b" },
  onLogs: (logs) => console.log(logs),
});

watchEvent()

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

Watches and returns emitted Event Logs.

Docs: https://viem.sh/docs/actions/public/watchEvent
JSON-RPC Methods:
- RPC Provider supports eth_newFilter:
  - Calls eth_newFilter to create a filter (called on initialize).
  - On a polling interval, it will call eth_getFilterChanges.
- RPC Provider does not support eth_newFilter:
  - Calls eth_getLogs for each block between the polling interval.

Type Parameters

• abiEvent extends undefined | AbiEvent = undefined

• abiEvents extends undefined | readonly unknown[] | readonly AbiEvent[] = abiEvent extends AbiEvent ? [abiEvent<abiEvent>] : undefined

• strict extends undefined | boolean = undefined

Parameters

• args: WatchEventParameters<abiEvent, abiEvents, strict, Transport>

WatchEventParameters

Returns

WatchEventReturnType

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

Remarks

This Action will batch up all the Event Logs found within the pollingInterval, and invoke them via onLogs.

watchEvent will attempt to create an Event Filter and listen to changes to the Filter per polling interval, however, if the RPC Provider does not support Filters (e.g. eth_newFilter), then watchEvent will fall back to using getLogs instead.

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const unwatch = client.watchEvent({
  onLogs: (logs) => console.log(logs),
});

watchPendingTransactions()

watchPendingTransactions: (args) => WatchPendingTransactionsReturnType

Watches and returns pending transaction hashes.

Docs: https://viem.sh/docs/actions/public/watchPendingTransactions
JSON-RPC Methods:
- When poll: true
  - Calls eth_newPendingTransactionFilter to initialize the filter.
  - Calls eth_getFilterChanges on a polling interval.
- When poll: false & WebSocket Transport, uses a WebSocket subscription via eth_subscribe and the "newPendingTransactions" event.

Parameters

• args: WatchPendingTransactionsParameters<Transport>

WatchPendingTransactionsParameters

Returns

WatchPendingTransactionsReturnType

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

Remarks

This Action will batch up all the pending transactions found within the pollingInterval, and invoke them via onTransactions.

Example

import { createPublicClient, http } from "viem";
import { mainnet } from "viem/chains";

const client = createPublicClient({
  chain: mainnet,
  transport: http(),
});
const unwatch = await client.watchPendingTransactions({
  onTransactions: (hashes) => console.log(hashes),
});

Defined in

packages/sdk/src/client.ts:218

getQuote()

getQuote(params): Promise<Quote>

Get a quote for a given set of parameters. See getQuote.

Parameters

• params: Omit<GetQuoteParams, "logger" | "apiUrl">

See GetQuoteParams.

Returns

Promise<Quote>

See Quote.

Defined in

packages/sdk/src/client.ts:412

getSuggestedFees()

getSuggestedFees(params): Promise<GetSuggestedFeesReturnType>

Get the suggested fees for a given route. See getSuggestedFees.

Parameters

• params: Omit<GetSuggestedFeesParams, "logger" | "apiUrl">

See GetSuggestedFeesParams.

Returns

Promise<GetSuggestedFeesReturnType>

See GetSuggestedFeesReturnType.

Defined in

packages/sdk/src/client.ts:335

getSupportedChains()

getSupportedChains(params): Promise<ChainsQueryResponse>

Parameters

• params: Omit<GetSupportedChainsParams, "logger" | "apiUrl">

Returns

Promise<ChainsQueryResponse>

Defined in

packages/sdk/src/client.ts:549

simulateDepositTx()

simulateDepositTx(params): Promise<SimulateContractReturnType>

Parameters

• params: Omit<SimulateDepositTxParams, "logger" | "publicClient" | "integratorId">

Returns

Promise<SimulateContractReturnType>

Defined in

packages/sdk/src/client.ts:443

simulateTxOnTenderly()

simulateTxOnTenderly(params): Promise<object>

Parameters

• params: Omit<TenderlySimulateTxParams, "accessKey" | "accountSlug" | "enableShare" | "projectSlug">

Returns

Promise<object>

simulationId

simulationId: string

simulationUrl

simulationUrl: string = url

Defined in

packages/sdk/src/client.ts:559

update()

update(params): void

Parameters

• params: Pick<AcrossClientOptions, "walletClient">

Returns

void

Defined in

packages/sdk/src/client.ts:211

waitForDepositTx()

waitForDepositTx(params): Promise<DepositStatus>

Parameters

• params: Omit<WaitForDepositTxParams, "publicClient">

Returns

Promise<DepositStatus>

Defined in

packages/sdk/src/client.ts:487

waitForFillTx()

waitForFillTx(params): Promise<FillStatus>

Parameters

• params: Omit<WaitForFillTxParams, "destinationChainClient">

Returns

Promise<FillStatus>

Defined in

packages/sdk/src/client.ts:515

create()

static create(options): AcrossClient

Create a new AcrossClient instance as a singleton.

Parameters

• options: AcrossClientOptions

See AcrossClientOptions.

Returns

AcrossClient

A new AcrossClient instance if it doesn't exist, otherwise the existing instance.

Defined in

packages/sdk/src/client.ts:190

getInstance()

static getInstance(): AcrossClient

Get the existing AcrossClient singleton instance.

Returns

AcrossClient

The existing AcrossClient instance.

Throws

If the instance is not initialized.

Defined in

packages/sdk/src/client.ts:202

Files

AcrossClient.md

Latest commit

History

AcrossClient.md

File metadata and controls

Class: AcrossClient

Properties

logger

Defined in

Accessors

isTenderlyEnabled

Returns

Defined in

Methods

executeQuote()

Parameters

Returns

Example

Defined in

getAvailableRoutes()

Parameters

Returns

Defined in

getDeposit()

Parameters

Returns

Defined in

getFillByDepositTx()

Parameters

Returns

Defined in

getLimits()

Parameters

Returns

Defined in

getPublicClient()

Parameters

Returns

account

batch?

batch.multicall?

cacheTime

call()

Parameters

Returns

Example

ccipRead?

chain

createBlockFilter()

Returns

id

request

type

Example

createContractEventFilter()

Type Parameters

Parameters

Returns

Example

createEventFilter()

Type Parameters

Parameters

Returns

Example

createPendingTransactionFilter()

Returns

id

request

type

Example

estimateContractGas()

Type Parameters

Parameters

Returns

Remarks

Example

estimateFeesPerGas()

Type Parameters

Parameters