OP Viem

Appearance

On this page

simulateDepositERC20 ​

Simulates a deposit of ERC20 tokens to L2.

ts
import { base, publicL1Actions } from 'op-viem'
import { baseAddresses } from 'op-viem/chains'
import { createPublicClient } from 'viem'

const USDCL1 = '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48'
const USDCL2 = '0x2e668bb88287675e34c8df82686dfd0b7f0c0383'

const publicClient = createPublicClient({
  account,
  chain: mainnet,
  transport: http(),
}).extend(publicL1Actions)

const { request } = await publicClient.simulateDepositERC20({
  args: {
    l1Token: USDCL1,
    l2Token: USDCL2,
    to: '0xFd4F24676eD4588928213F37B126B53c07186F45',
    amount: 1n,
    minGasLimit: 100000,
  },
  l1StandardBridge: baseAddresses.l1StandardBridge,
  account: '0xd8da6bf26964af9d7eed9e03e53415d37aa96045',
})

Return Value ​

Returns a request that can be passed to Viem's writeContract and a result indicating whether the simulation succeeded.

Parameters ​

args ​

  • l1Token ​

    • Type: Address
    • The L1 token contract address.

  • l2Token ​

    • Type: Address
    • The L2 token contract address.

  • to ​

    • Type: Address
    • The address to deposit the tokens to.

  • amount ​

    • Type: bigint
    • The amount of tokens to deposit.

  • minGasLimit ​

    • Type: number
    • The gas limit for the transaction.

  • extraData (optional) ​

    • Type: Hex
    • Extra data to include in the transaction.

l1StandardBridge ​

The L1StandardBridge contract.

account ​

  • Type: Address

The address to deposit the tokens from.