tevmGetAccount

tevmGetAccount(client, params): Promise<GetAccountResult<TevmGetAccountError>>

A tree-shakeable version of the tevmGetAccount action for viem. Retrieves the account information from TEVM.

This function allows you to retrieve information about an account, including its address and optionally its contract storage. The returnStorage parameter determines whether the contract storage should be returned. Note that it only returns the storage that is cached in the VM. In fork mode, if the storage hasn’t been cached yet, it will not be returned. This defaults to false. Be aware that returning storage can be very expensive if a contract has a lot of storage.

Parameters

• client: Client<TevmTransport<string>, undefined | Chain, undefined | Account, undefined, undefined | object>

The viem client configured with TEVM transport.

• params: GetAccountParams<boolean>

Parameters for retrieving the account information.

Returns

Promise<GetAccountResult<TevmGetAccountError>>

The account information.

Example

import { tevmGetAccount } from 'tevm/actions'
import { createClient, http } from 'viem'
import { optimism } from 'tevm/common'
import { createTevmTransport } from 'tevm'

const client = createClient({
  transport: createTevmTransport({
    fork: { transport: http('https://mainnet.optimism.io')({}) }
  }),
  chain: optimism,
})

async function example() {
  const account = await tevmGetAccount(client, {
    address: '0x123...',
    returnStorage: true,
  })
  console.log(account)
}

example()

See

• GetAccountParams for options reference.
• GetAccountResult for return values reference.
• TEVM Actions Guide

Defined in

packages/memory-client/src/tevmGetAccount.js:45