writeSendMessage ​

Excutes a sendMessage call to the L1CrossDomainMessenger contract. This is a fairly low level function and generally it will be more convenient to use writeContractDeposit.

import { SendMessageParameters } from 'op-viem'
import { base } from 'op-viem/chains'
import { account, opStackL1WalletClient } from './config'

const args: SendMessageParameters = {
  target: '0x00008453e27e8e88f305f13cf27c30d724fdd055',
  minGasLimit: 85000,
  message: '0x8c874ebd0021fb3f',
}

const hash = await opStackL1WalletClient.writeSendMessage({
  args,
  l2Chain: base,
  value: 1n,
})

import { createWalletClient, custom } from 'viem'
import { privateKeyToAccount } from 'viem/accounts'
import { mainnet } from 'viem/chains'
import { walletL1OpStackActions } from 'op-viem'

export const opStackL1WalletClient = createWalletClient({
  chain: mainnet,
  transport: custom(window.ethereum)
}).extend(walletL1OpStackActions)

// JSON-RPC Account
export const [account] = await walletClient.getAddresses()
// Local Account
export const account = privateKeyToAccount(...)

Return Value ​

Hash

A Transaction Hash.

writeContract only returns a Transaction Hash. If you would like to retrieve the return data of a write function, you can use the [simulatSendMessage action] – this action does not execute a transaction, and does not require gas.

Parameters ​

args ​

• target ​

  • Type: Address
  • The to address of the L2 transaction.

• minGasLimit ​

  • Type: number
  • The minimum gas limit for the L2 transaction. This will be padded to account for some overhead on the OPStack contract calls.

• message (optional) ​

  • Type: Hex
  • Default: 0x
  • The calldata of the L2 transaction

await walletClient.writeSendMessage({
  args: { 
    target: '0x00008453e27e8e88f305f13cf27c30d724fdd055',
    minGasLimit: 85000,
    message: '0x8c874ebd0021fb3f',
  }
  l2Chain: base,
})

l2Chain (optional) ​

• Type: OpStackChain

The destination L2 chain of the deposit transaction. l2Chain.opStackConfig.l1.chainId must match chain.id (from client.chain or chain passed explicitly as an arg). The address at l2Chain.opStackConfig.l1.contracts.l1CrossDomainMessenger.address will be used for the contract call. If this is argument not passed or if no such contract definition exists, l1CrossDomainMessengerAddress must be passed explicitly.

await walletClient.writeSendMessage({
  args,
  l2Chain: base, 
})

l1CrossDomainMessengerAddress (optional) ​

• Type: Address

The L1CrossDomainMessengerAddress contract where the sendMessage call should be made.

await walletClient.writeSendMessage({
  args,
  l1CrossDomainMessengerAddress: messenger, 
})

value (optional) ​

• Type: number

Value in wei sent with this transaction. This value will be credited to the balance of the caller address on L2 before the L2 transaction created by this transaction is made.

await walletClient.writeUnsafeDepositTransaction({
  args,
  optimismPortalAddress: portal,
  value: parseEther(1), 
})