Skip to content

estimateDepositETHGas

Estimates gas to initiate a deposit ETH transaction on an L1, which executes a transaction on an L2.

Usage

example.ts
import { mantle } from '@mantleio/viem/chains'
import { account, publicClientL1 } from './config'
 
const gas = await publicClientL1.estimateDepositETHGas({
  account,
  request: {
    amount: parseEther('0.001'),
  },
  targetChain: mantle,
})

Returns

bigint

Gas required to execute the transaction on the L1.

Parameters

account

  • Type: Account | Address

The Account to send the transaction from.

Accepts a JSON-RPC Account or Local Account (Private Key, etc).

const gas = await client.estimateDepositETHGas({
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266', 
  request: {
    amount: parseEther('0.001'),
  },
  targetChain: mantle,
})

args.amount

  • Type: bigint

Value in wei sent with this transaction on the L2. Debited from the caller's L2 balance.

const gas = await client.estimateDepositETHGas({
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  request: {
    amount: parseEther('1'), 
  },
  targetChain: mantle,
})

targetChain

The L2 chain to execute the transaction on.

import { mainnet } from 'viem/chains'
 
const gas = await client.estimateDepositETHGas({
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  request: {
    amount: parseEther('1'),
  },
  chain: mainnet,
  targetChain: mantle, 
})

chain (optional)

  • Type: Chain
  • Default: client.chain

The L1 chain. If there is a mismatch between the wallet's current chain & this chain, an error will be thrown.

import { mainnet } from 'viem/chains'
 
const gas = await client.estimateDepositETHGas({
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  request: {
    amount: parseEther('1'),
  },
  chain: mainnet, 
  targetChain: mantle,
})

maxFeePerGas (optional)

  • Type: bigint

Total fee per gas (in wei), inclusive of maxPriorityFeePerGas.

const gas = await client.estimateDepositETHGas({
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  request: {
    amount: parseEther('1'),
  },
  maxFeePerGas: parseGwei('20'), 
  targetChain: mantle,
})

maxPriorityFeePerGas (optional)

  • Type: bigint

Max priority fee per gas (in wei). Only applies to EIP-1559 Transactions

const gas = await client.estimateDepositETHGas({
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  request: {
    amount: parseEther('1'),
  },
  maxFeePerGas: parseGwei('20'),
  maxPriorityFeePerGas: parseGwei('2'), 
  targetChain: mantle,
})

nonce (optional)

  • Type: number

Unique number identifying this transaction.

const gas = await client.estimateDepositETHGas({
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  request: {
    amount: parseEther('1'),
  },
  nonce: 69, 
  targetChain: mantle,
})

portalAddress (optional)

  • Type: Address
  • Default: targetChain.contracts.portal[chainId].address

The address of the Mantle Optimism Portal contract. Defaults to the Mantle Optimism Portal contract specified on the targetChain.

If a portalAddress is provided, the targetChain parameter becomes optional.

const gas = await client.estimateDepositETHGas({
  account: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266',
  request: {
    amount: parseEther('1'),
  },
  portalAddress: '0xbEb5Fc579115071764c7423A4f12eDde41f106Ed', 
})