Class CrossChainMessenger

Index

Constructors

Properties

_outputCache bedrock bridges contracts depositConfirmationBlocks estimateGas l1BlockTimeSeconds l1ChainId l1SignerOrProvider l2ChainId l2SignerOrProvider nativeTokenAddress populateTransaction

Accessors

l1Provider l1Signer l2Provider l2Signer

Constructors

constructor

new CrossChainMessenger(opts): CrossChainMessenger
Creates a new CrossChainProvider instance.
Parameters
- opts: {
      bedrock?: boolean;
      bridges?: BridgeAdapterData;
      contracts?: DeepPartial<OEContractsLike>;
      depositConfirmationBlocks?: NumberLike;
      l1BlockTimeSeconds?: NumberLike;
      l1ChainId: NumberLike;
      l1SignerOrProvider: SignerOrProviderLike;
      l2ChainId: NumberLike;
      l2SignerOrProvider: SignerOrProviderLike;
      nativeTokenAddress?: AddressLike;
  }
  Options for the provider.
  - Optional bedrock?: boolean
    Whether or not to enable Bedrock compatibility.
  - Optional bridges?: BridgeAdapterData
    Optional bridge address list.
  - Optional contracts?: DeepPartial<OEContractsLike>
    Optional contract address overrides.
  - Optional depositConfirmationBlocks?: NumberLike
    Optional number of blocks before a deposit is confirmed.
  - Optional l1BlockTimeSeconds?: NumberLike
    Optional estimated block time in seconds for the L1 chain.
  - l1ChainId: NumberLike
    Chain ID for the L1 chain.
  - l1SignerOrProvider: SignerOrProviderLike
    Signer or Provider for the L1 chain, or a JSON-RPC url.
  - l2ChainId: NumberLike
    Chain ID for the L2 chain.
  - l2SignerOrProvider: SignerOrProviderLike
    Signer or Provider for the L2 chain, or a JSON-RPC url.
  - Optional nativeTokenAddress?: AddressLike
Returns CrossChainMessenger
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:151

Properties

`Private` _outputCache

_outputCache: {
root: string;
valid: boolean;
}[] = []

Cache for output root validation. Output roots are expensive to verify, so we cache them.

Type declaration

root: string
valid: boolean

bedrock

bedrock: boolean

Whether or not Bedrock compatibility is enabled.

bridges

bridges: BridgeAdapters

List of custom bridges for the given network.

contracts

contracts: OEContracts

Contract objects attached to their respective providers and addresses.

depositConfirmationBlocks

depositConfirmationBlocks: number

Number of blocks before a deposit is considered confirmed.

estimateGas

estimateGas: {
    approveERC20: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>);
    approveNativeToken: ((amount, opts?) => Promise<BigNumber>);
    bridgeERC20: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>);
    bridgeETH: ((amount, opts?) => Promise<BigNumber>);
    bridgeNativeToken: ((amount, opts?) => Promise<BigNumber>);
    finalizeMessage: ((message, opts?, messageIndex?) => Promise<BigNumber>);
    proveMessage: ((message, opts?, messageIndex?) => Promise<BigNumber>);
    resendMessage: ((message, messageGasLimit, opts?) => Promise<BigNumber>);
    sendMessage: ((message, opts?) => Promise<BigNumber>);
    withdrawERC20: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>);
    withdrawETH: ((amount, opts?) => Promise<BigNumber>);
    withdrawNativeToken: ((amount, opts?) => Promise<BigNumber>);
} = ...

Object that holds the functions that estimates the gas required for a given transaction. Follows the pattern used by ethers.js.

Type declaration

approveERC20: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>)
Estimates gas required to approve some tokens to deposit into the L2 chain.

Param: l1Token
The L1 token address.

Param: l2Token
The L2 token address.

Param: amount
Amount of the token to approve.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction response for the approval transaction.
- - (l1Token, l2Token, amount, opts?): Promise<BigNumber>
  - Estimates gas required to approve some tokens to deposit into the L2 chain.
    Parameters
    - l1Token: AddressLike
      The L1 token address.
    - l2Token: AddressLike
      The L2 token address.
    - amount: NumberLike
      Amount of the token to approve.
    - Optional opts: {
      overrides?: CallOverrides;
      }
      Additional options.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
    Returns Promise<BigNumber>
    Transaction response for the approval transaction.
approveNativeToken: ((amount, opts?) => Promise<BigNumber>)
Estimates gas required to approve L2 Native tokens to deposit into the L2 chain.

Param: amount
Amount of the token to approve.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction response for the approval transaction.
- - (amount, opts?): Promise<BigNumber>
  - Estimates gas required to approve L2 Native tokens to deposit into the L2 chain.
    Parameters
    - amount: NumberLike
      Amount of the token to approve.
    - Optional opts: {
      overrides?: CallOverrides;
      }
      Additional options.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
    Returns Promise<BigNumber>
    Transaction response for the approval transaction.
bridgeERC20: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>)
Estimates gas required to deposit some ERC20 tokens into the L2 chain.

Param: l1Token
Address of the L1 token.

Param: l2Token
Address of the L2 token.

Param: amount
Amount to deposit.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L2. Defaults to sender.

Param: opts.l2GasLimit
Optional gas limit to use for the transaction on L2.

Param: opts.overrides
Optional transaction overrides.

Returns
Gas estimate for the transaction.
- - (l1Token, l2Token, amount, opts?): Promise<BigNumber>
  - Estimates gas required to deposit some ERC20 tokens into the L2 chain.
    Parameters
    - l1Token: AddressLike
      Address of the L1 token.
    - l2Token: AddressLike
      Address of the L2 token.
    - amount: NumberLike
      Amount to deposit.
    - Optional opts: {
          l2GasLimit?: NumberLike;
          overrides?: CallOverrides;
          recipient?: AddressLike;
      }
      Additional options.
      
      Optional l2GasLimit?: NumberLike
      Optional gas limit to use for the transaction on L2.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L2. Defaults to sender.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
bridgeETH: ((amount, opts?) => Promise<BigNumber>)
Estimates gas required to deposit some ETH into the L2 chain.

Param: amount
Amount of ETH to deposit.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L2. Defaults to sender.

Param: opts.l2GasLimit
Optional gas limit to use for the transaction on L2.

Param: opts.overrides
Optional transaction overrides.

Returns
Gas estimate for the transaction.
- - (amount, opts?): Promise<BigNumber>
  - Estimates gas required to deposit some ETH into the L2 chain.
    Parameters
    - amount: NumberLike
      Amount of ETH to deposit.
    - Optional opts: {
          l2GasLimit?: NumberLike;
          overrides?: CallOverrides;
          recipient?: AddressLike;
      }
      Additional options.
      
      Optional l2GasLimit?: NumberLike
      Optional gas limit to use for the transaction on L2.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L2. Defaults to sender.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
bridgeNativeToken: ((amount, opts?) => Promise<BigNumber>)
Estimates gas required to deposit some L2 Native Token into the L2 chain.

Param: amount
Amount of L2 Native Token to deposit.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L2. Defaults to sender.

Param: opts.l2GasLimit
Optional gas limit to use for the transaction on L2.

Param: opts.overrides
Optional transaction overrides.

Returns
Gas estimate for the transaction.
- - (amount, opts?): Promise<BigNumber>
  - Estimates gas required to deposit some L2 Native Token into the L2 chain.
    Parameters
    - amount: NumberLike
      Amount of L2 Native Token to deposit.
    - Optional opts: {
          l2GasLimit?: NumberLike;
          overrides?: CallOverrides;
          recipient?: AddressLike;
      }
      Additional options.
      
      Optional l2GasLimit?: NumberLike
      Optional gas limit to use for the transaction on L2.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L2. Defaults to sender.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
finalizeMessage: ((message, opts?, messageIndex?) => Promise<BigNumber>)
Estimates gas required to finalize a cross chain message. Only applies to L2 to L1 messages.

Param: message
Message to generate the finalization transaction for.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Param: messageIndex
The index of the message, if multiple exist from multicall

Returns
Gas estimate for the transaction.
- - (message, opts?, messageIndex?): Promise<BigNumber>
  - Estimates gas required to finalize a cross chain message. Only applies to L2 to L1 messages.
    Parameters
    - message: MessageLike
      Message to generate the finalization transaction for.
    - Optional opts: {
      overrides?: CallOverrides;
      }
      Additional options.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
    - messageIndex: number = 0
      The index of the message, if multiple exist from multicall
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
proveMessage: ((message, opts?, messageIndex?) => Promise<BigNumber>)
Estimates gas required to prove a cross chain message. Only applies to L2 to L1 messages.

Param: message
Message to generate the proving transaction for.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Param: messageIndex
The index of the message, if multiple exist from multicall

Returns
Gas estimate for the transaction.
- - (message, opts?, messageIndex?): Promise<BigNumber>
  - Estimates gas required to prove a cross chain message. Only applies to L2 to L1 messages.
    Parameters
    - message: MessageLike
      Message to generate the proving transaction for.
    - Optional opts: {
      overrides?: CallOverrides;
      }
      Additional options.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
    - messageIndex: number = 0
      The index of the message, if multiple exist from multicall
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
resendMessage: ((message, messageGasLimit, opts?) => Promise<BigNumber>)
Estimates gas required to resend a cross chain message. Only applies to L1 to L2 messages.

Param: message
Cross chain message to resend.

Param: messageGasLimit
New gas limit to use for the message.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Returns
Gas estimate for the transaction.
- - (message, messageGasLimit, opts?): Promise<BigNumber>
  - Estimates gas required to resend a cross chain message. Only applies to L1 to L2 messages.
    Parameters
    - message: MessageLike
      Cross chain message to resend.
    - messageGasLimit: NumberLike
      New gas limit to use for the message.
    - Optional opts: {
      overrides?: CallOverrides;
      }
      Additional options.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
sendMessage: ((message, opts?) => Promise<BigNumber>)
Estimates gas required to send a cross chain message.

Param: message
Cross chain message to send.

Param: opts
Additional options.

Param: opts.l2GasLimit
Optional gas limit to use for the transaction on L2.

Param: opts.overrides
Optional transaction overrides.

Returns
Gas estimate for the transaction.
- - (message, opts?): Promise<BigNumber>
  - Estimates gas required to send a cross chain message.
    Parameters
    - message: CrossChainMessageRequest
      Cross chain message to send.
    - Optional opts: {
      l2GasLimit?: NumberLike;
      overrides?: CallOverrides;
      }
      Additional options.
      
      Optional l2GasLimit?: NumberLike
      Optional gas limit to use for the transaction on L2.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
withdrawERC20: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>)
Estimates gas required to withdraw some ERC20 tokens back to the L1 chain.

Param: l1Token
Address of the L1 token.

Param: l2Token
Address of the L2 token.

Param: amount
Amount to withdraw.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L1. Defaults to sender.

Param: opts.overrides
Optional transaction overrides.

Returns
Gas estimate for the transaction.
- - (l1Token, l2Token, amount, opts?): Promise<BigNumber>
  - Estimates gas required to withdraw some ERC20 tokens back to the L1 chain.
    Parameters
    - l1Token: AddressLike
      Address of the L1 token.
    - l2Token: AddressLike
      Address of the L2 token.
    - amount: NumberLike
      Amount to withdraw.
    - Optional opts: {
      overrides?: CallOverrides;
      recipient?: AddressLike;
      }
      Additional options.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L1. Defaults to sender.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
withdrawETH: ((amount, opts?) => Promise<BigNumber>)
Estimates gas required to withdraw some ETH back to the L1 chain.

Param: amount
Amount of ETH to withdraw.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L1. Defaults to sender.

Param: opts.overrides
Optional transaction overrides.

Returns
Gas estimate for the transaction.
- - (amount, opts?): Promise<BigNumber>
  - Estimates gas required to withdraw some ETH back to the L1 chain.
    Parameters
    - amount: NumberLike
      Amount of ETH to withdraw.
    - Optional opts: {
      overrides?: CallOverrides;
      recipient?: AddressLike;
      }
      Additional options.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L1. Defaults to sender.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
withdrawNativeToken: ((amount, opts?) => Promise<BigNumber>)
Estimates gas required to withdraw some L2 Native Token back to the L1 chain.

Param: amount
Amount of L2 Native Token to withdraw.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L1. Defaults to sender.

Param: opts.overrides
Optional transaction overrides.

Returns
Gas estimate for the transaction.
- - (amount, opts?): Promise<BigNumber>
  - Estimates gas required to withdraw some L2 Native Token back to the L1 chain.
    Parameters
    - amount: NumberLike
      Amount of L2 Native Token to withdraw.
    - Optional opts: {
      overrides?: CallOverrides;
      recipient?: AddressLike;
      }
      Additional options.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L1. Defaults to sender.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.

l1BlockTimeSeconds

l1BlockTimeSeconds: number

Estimated average L1 block time in seconds.

l1ChainId

l1ChainId: number

Chain ID for the L1 network.

l1SignerOrProvider

l1SignerOrProvider: Provider | Signer

Provider connected to the L1 chain.

l2ChainId

l2ChainId: number

Chain ID for the L2 network.

l2SignerOrProvider

l2SignerOrProvider: Provider | Signer

Provider connected to the L2 chain.

nativeTokenAddress

nativeTokenAddress: string

Native Token Address

populateTransaction

populateTransaction: {
    approveERC20: ((l1Token, l2Token, amount, opts?) => Promise<TransactionRequest>);
    approveNativeToken: ((amount, opts?) => Promise<TransactionRequest>);
    bridgeERC20: ((l1Token, l2Token, amount, opts?, isEstimatingGas?) => Promise<TransactionRequest>);
    bridgeETH: ((amount, opts?, isEstimatingGas?) => Promise<TransactionRequest>);
    bridgeNativeToken: ((amount, opts?, isEstimatingGas?) => Promise<TransactionRequest>);
    finalizeMessage: ((message, opts?, messageIndex?) => Promise<TransactionRequest>);
    proveMessage: ((message, opts?, messageIndex?) => Promise<TransactionRequest>);
    resendMessage: ((message, messageGasLimit, opts?, messageIndex?) => Promise<TransactionRequest>);
    sendMessage: ((message, opts?) => Promise<TransactionRequest>);
    withdrawERC20: ((l1Token, l2Token, amount, opts?) => Promise<TransactionRequest>);
    withdrawETH: ((amount, opts?) => Promise<TransactionRequest>);
    withdrawNativeToken: ((amount, opts?) => Promise<TransactionRequest>);
} = ...

Object that holds the functions that generate transactions to be signed by the user. Follows the pattern used by ethers.js.

Type declaration

approveERC20: ((l1Token, l2Token, amount, opts?) => Promise<TransactionRequest>)
Generates a transaction for approving some tokens to deposit into the L2 chain.

Param: l1Token
The L1 token address.

Param: l2Token
The L2 token address.

Param: amount
Amount of the token to approve.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction response for the approval transaction.
- - (l1Token, l2Token, amount, opts?): Promise<TransactionRequest>
  - Generates a transaction for approving some tokens to deposit into the L2 chain.
    Parameters
    - l1Token: AddressLike
      The L1 token address.
    - l2Token: AddressLike
      The L2 token address.
    - amount: NumberLike
      Amount of the token to approve.
    - Optional opts: {
      overrides?: Overrides;
      }
      Additional options.
      
      Optional overrides?: Overrides
      Optional transaction overrides.
    Returns Promise<TransactionRequest>
    Transaction response for the approval transaction.
approveNativeToken: ((amount, opts?) => Promise<TransactionRequest>)
Generates a transaction for approving L2 Native Token tokens to deposit into the L2 chain.

Param: amount
Amount of the L2 Native Token to approve.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction response for the approval transaction.
- - (amount, opts?): Promise<TransactionRequest>
  - Generates a transaction for approving L2 Native Token tokens to deposit into the L2 chain.
    Parameters
    - amount: NumberLike
      Amount of the L2 Native Token to approve.
    - Optional opts: {
      overrides?: Overrides;
      }
      Additional options.
      
      Optional overrides?: Overrides
      Optional transaction overrides.
    Returns Promise<TransactionRequest>
    Transaction response for the approval transaction.
bridgeERC20: ((l1Token, l2Token, amount, opts?, isEstimatingGas?) => Promise<TransactionRequest>)
Generates a transaction for depositing some ERC20 tokens into the L2 chain.

Param: l1Token
Address of the L1 token.

Param: l2Token
Address of the L2 token.

Param: amount
Amount to deposit.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L2. Defaults to sender.

Param: opts.l2GasLimit
Optional gas limit to use for the transaction on L2.

Param: opts.overrides
Optional transaction overrides.

Param: isEstimatingGas
determine to estimate gas.

Returns
Transaction that can be signed and executed to deposit the tokens.
- - (l1Token, l2Token, amount, opts?, isEstimatingGas?): Promise<TransactionRequest>
  - Generates a transaction for depositing some ERC20 tokens into the L2 chain.
    Parameters
    - l1Token: AddressLike
      Address of the L1 token.
    - l2Token: AddressLike
      Address of the L2 token.
    - amount: NumberLike
      Amount to deposit.
    - Optional opts: {
          l2GasLimit?: NumberLike;
          overrides?: CallOverrides;
          recipient?: AddressLike;
      }
      Additional options.
      
      Optional l2GasLimit?: NumberLike
      Optional gas limit to use for the transaction on L2.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L2. Defaults to sender.
    - isEstimatingGas: boolean = false
      determine to estimate gas.
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to deposit the tokens.
bridgeETH: ((amount, opts?, isEstimatingGas?) => Promise<TransactionRequest>)
Generates a transaction for depositing some ETH into the L2 chain.

Param: amount
Amount of ETH to deposit.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L2. Defaults to sender.

Param: opts.l2GasLimit
Optional gas limit to use for the transaction on L2.

Param: opts.overrides
Optional transaction overrides.

Param: isEstimatingGas
Enable estimation gas

Returns
Transaction that can be signed and executed to deposit the ETH.
- - (amount, opts?, isEstimatingGas?): Promise<TransactionRequest>
  - Generates a transaction for depositing some ETH into the L2 chain.
    Parameters
    - amount: NumberLike
      Amount of ETH to deposit.
    - Optional opts: {
          l2GasLimit?: NumberLike;
          overrides?: CallOverrides;
          recipient?: AddressLike;
      }
      Additional options.
      
      Optional l2GasLimit?: NumberLike
      Optional gas limit to use for the transaction on L2.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L2. Defaults to sender.
    - isEstimatingGas: boolean = false
      Enable estimation gas
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to deposit the ETH.
bridgeNativeToken: ((amount, opts?, isEstimatingGas?) => Promise<TransactionRequest>)
Generates a transaction for depositing some L2 Native Token into the L2 chain.

Param: amount
Amount of L2 Native Token to deposit.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L2. Defaults to sender.

Param: opts.l2GasLimit
Optional gas limit to use for the transaction on L2.

Param: opts.overrides
Optional transaction overrides.

Param: isEstimatingGas
Enable estimation gas

Returns
Transaction that can be signed and executed to deposit the L2 Native Token.
- - (amount, opts?, isEstimatingGas?): Promise<TransactionRequest>
  - Generates a transaction for depositing some L2 Native Token into the L2 chain.
    Parameters
    - amount: NumberLike
      Amount of L2 Native Token to deposit.
    - Optional opts: {
          l2GasLimit?: NumberLike;
          overrides?: CallOverrides;
          recipient?: AddressLike;
      }
      Additional options.
      
      Optional l2GasLimit?: NumberLike
      Optional gas limit to use for the transaction on L2.
      
      Optional overrides?: CallOverrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L2. Defaults to sender.
    - isEstimatingGas: boolean = false
      Enable estimation gas
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to deposit the L2 Native Token.
finalizeMessage: ((message, opts?, messageIndex?) => Promise<TransactionRequest>)
Generates a message finalization transaction that can be signed and executed. Only applicable for L2 to L1 messages. Will throw an error if the message has not completed its challenge period yet.

Param: message
Message to generate the finalization transaction for.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Param: messageIndex
The index of the message, if multiple exist from multicall

Returns
Transaction that can be signed and executed to finalize the message.
- - (message, opts?, messageIndex?): Promise<TransactionRequest>
  - Generates a message finalization transaction that can be signed and executed. Only applicable for L2 to L1 messages. Will throw an error if the message has not completed its challenge period yet.
    Parameters
    - message: MessageLike
      Message to generate the finalization transaction for.
    - Optional opts: {
      overrides?: PayableOverrides;
      }
      Additional options.
      
      Optional overrides?: PayableOverrides
      Optional transaction overrides.
    - messageIndex: number = 0
      The index of the message, if multiple exist from multicall
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to finalize the message.
proveMessage: ((message, opts?, messageIndex?) => Promise<TransactionRequest>)
Generates a message proving transaction that can be signed and executed. Only applicable for L2 to L1 messages.

Param: message
Message to generate the proving transaction for.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Param: messageIndex
The index of the message, if multiple exist from multicall

Returns
Transaction that can be signed and executed to prove the message.
- - (message, opts?, messageIndex?): Promise<TransactionRequest>
  - Generates a message proving transaction that can be signed and executed. Only applicable for L2 to L1 messages.
    Parameters
    - message: MessageLike
      Message to generate the proving transaction for.
    - Optional opts: {
      overrides?: PayableOverrides;
      }
      Additional options.
      
      Optional overrides?: PayableOverrides
      Optional transaction overrides.
    - messageIndex: number = 0
      The index of the message, if multiple exist from multicall
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to prove the message.
resendMessage: ((message, messageGasLimit, opts?, messageIndex?) => Promise<TransactionRequest>)
Generates a transaction that resends a given cross chain message. Only applies to L1 to L2 messages. This transaction can be signed and executed by a signer.

Param: message
Cross chain message to resend.

Param: messageGasLimit
New gas limit to use for the message.

Param: opts
Additional options.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction that can be signed and executed to resend the message.
- - (message, messageGasLimit, opts?, messageIndex?): Promise<TransactionRequest>
  - Generates a transaction that resends a given cross chain message. Only applies to L1 to L2 messages. This transaction can be signed and executed by a signer.
    Parameters
    - message: MessageLike
      Cross chain message to resend.
    - messageGasLimit: NumberLike
      New gas limit to use for the message.
    - Optional opts: {
      overrides?: Overrides;
      }
      Additional options.
      
      Optional overrides?: Overrides
      Optional transaction overrides.
    - messageIndex: number = 0
      The index of the withdrawal if multiple are made with multicall
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to resend the message.
sendMessage: ((message, opts?) => Promise<TransactionRequest>)
Generates a transaction that sends a given cross chain message. This transaction can be signed and executed by a signer.

Param: message
Cross chain message to send.

Param: opts
Additional options.

Param: opts.l2GasLimit
Optional gas limit to use for the transaction on L2.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction that can be signed and executed to send the message.
- - (message, opts?): Promise<TransactionRequest>
  - Generates a transaction that sends a given cross chain message. This transaction can be signed and executed by a signer.
    Parameters
    - message: CrossChainMessageRequest
      Cross chain message to send.
    - Optional opts: {
      l2GasLimit?: NumberLike;
      overrides?: Overrides;
      }
      Additional options.
      
      Optional l2GasLimit?: NumberLike
      Optional gas limit to use for the transaction on L2.
      
      Optional overrides?: Overrides
      Optional transaction overrides.
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to send the message.
withdrawERC20: ((l1Token, l2Token, amount, opts?) => Promise<TransactionRequest>)
Generates a transaction for withdrawing some ERC20 tokens back to the L1 chain.

Param: l1Token
Address of the L1 token.

Param: l2Token
Address of the L2 token.

Param: amount
Amount to withdraw.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L1. Defaults to sender.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction that can be signed and executed to withdraw the tokens.
- - (l1Token, l2Token, amount, opts?): Promise<TransactionRequest>
  - Generates a transaction for withdrawing some ERC20 tokens back to the L1 chain.
    Parameters
    - l1Token: AddressLike
      Address of the L1 token.
    - l2Token: AddressLike
      Address of the L2 token.
    - amount: NumberLike
      Amount to withdraw.
    - Optional opts: {
      overrides?: Overrides;
      recipient?: AddressLike;
      }
      Additional options.
      
      Optional overrides?: Overrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L1. Defaults to sender.
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to withdraw the tokens.
withdrawETH: ((amount, opts?) => Promise<TransactionRequest>)
Generates a transaction for withdrawing some ETH back to the L1 chain.

Param: amount
Amount of ETH to withdraw.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L1. Defaults to sender.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction that can be signed and executed to withdraw the ETH.
- - (amount, opts?): Promise<TransactionRequest>
  - Generates a transaction for withdrawing some ETH back to the L1 chain.
    Parameters
    - amount: NumberLike
      Amount of ETH to withdraw.
    - Optional opts: {
      overrides?: Overrides;
      recipient?: AddressLike;
      }
      Additional options.
      
      Optional overrides?: Overrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L1. Defaults to sender.
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to withdraw the ETH.
withdrawNativeToken: ((amount, opts?) => Promise<TransactionRequest>)
Generates a transaction for withdrawing some L2 Native Token back to the L1 chain.

Param: amount
Amount of L2 Native Token to withdraw.

Param: opts
Additional options.

Param: opts.recipient
Optional address to receive the funds on L1. Defaults to sender.

Param: opts.overrides
Optional transaction overrides.

Returns
Transaction that can be signed and executed to withdraw the L2 Native Token.
- - (amount, opts?): Promise<TransactionRequest>
  - Generates a transaction for withdrawing some L2 Native Token back to the L1 chain.
    Parameters
    - amount: NumberLike
      Amount of L2 Native Token to withdraw.
    - Optional opts: {
      overrides?: Overrides;
      recipient?: AddressLike;
      }
      Additional options.
      
      Optional overrides?: Overrides
      Optional transaction overrides.
      
      Optional recipient?: AddressLike
      Optional address to receive the funds on L1. Defaults to sender.
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to withdraw the L2 Native Token.

Accessors

l1Provider

get l1Provider(): Provider
Provider connected to the L1 chain.

Returns Provider
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:209

l1Signer

get l1Signer(): Signer
Signer connected to the L1 chain.

Returns Signer
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:231

l2Provider

get l2Provider(): Provider
Provider connected to the L2 chain.

Returns Provider
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:220

l2Signer

get l2Signer(): Signer
Signer connected to the L2 chain.

Returns Signer
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:242

Methods

approval

approval(l1Token, l2Token, opts?): Promise<BigNumber>
Queries the account's approval amount for a given L1 token.
Parameters
- l1Token: AddressLike
  The L1 token address.
- l2Token: AddressLike
  The L2 token address.
- Optional opts: {
  signer?: Signer;
  }
  Additional options.
  - Optional signer?: Signer
    Optional signer to get the approval for.
Returns Promise<BigNumber>
Amount of tokens approved for deposits from the account.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:2108

approveERC20

approveERC20(l1Token, l2Token, amount, opts?): Promise<TransactionResponse>
Approves a deposit into the L2 chain.
Parameters
- l1Token: AddressLike
  The L1 token address.
- l2Token: AddressLike
  The L2 token address.
- amount: NumberLike
  Amount of the token to approve.
- Optional opts: {
  overrides?: Overrides;
  signer?: Signer;
  }
  Additional options.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the approval transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:2130

approveNativeToken

approveNativeToken(amount, opts?): Promise<TransactionResponse>
Approves a deposit L2 Native Token into the L2 chain.
Parameters
- amount: NumberLike
  Amount of the L2 Native Token to approve.
- Optional opts: {
  overrides?: Overrides;
  signer?: Signer;
  }
  Additional options.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the approval transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:2087

bridgeERC20

bridgeERC20(l1Token, l2Token, amount, opts?): Promise<TransactionResponse>
Deposits some ERC20 tokens into the L2 chain.
Parameters
- l1Token: AddressLike
  Address of the L1 token.
- l2Token: AddressLike
  Address of the L2 token.
- amount: NumberLike
  Amount to deposit.
- Optional opts: {
      l2GasLimit?: NumberLike;
      overrides?: CallOverrides;
      recipient?: AddressLike;
      signer?: Signer;
  }
  Additional options.
  - Optional l2GasLimit?: NumberLike
    Optional gas limit to use for the transaction on L2.
  - Optional overrides?: CallOverrides
    Optional transaction overrides.
  - Optional recipient?: AddressLike
    Optional address to receive the funds on L2. Defaults to sender.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the deposit transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:2162

bridgeETH

bridgeETH(amount, opts?): Promise<TransactionResponse>
Deposits some ETH into the L2 chain.
Parameters
- amount: NumberLike
  Amount of ETH to deposit (in wei).
- Optional opts: {
      l2GasLimit?: NumberLike;
      overrides?: Overrides;
      recipient?: AddressLike;
      signer?: Signer;
  }
  Additional options.
  - Optional l2GasLimit?: NumberLike
    Optional gas limit to use for the transaction on L2.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional recipient?: AddressLike
    Optional address to receive the funds on L2. Defaults to sender.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the deposit transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1993

bridgeNativeToken

bridgeNativeToken(amount, opts?): Promise<TransactionResponse>
Deposits some L2 Native Token into the L2 chain.
Parameters
- amount: NumberLike
  Amount of L2 Native Token to deposit
- Optional opts: {
      l2GasLimit?: NumberLike;
      overrides?: Overrides;
      recipient?: AddressLike;
      signer?: Signer;
  }
  Additional options.
  - Optional l2GasLimit?: NumberLike
    Optional gas limit to use for the transaction on L2.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional recipient?: AddressLike
    Optional address to receive the funds on L2. Defaults to sender.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the deposit transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:2041

estimateL2MessageGasLimit

estimateL2MessageGasLimit(message, opts?, messageIndex?): Promise<BigNumber>
Estimates the amount of gas required to fully execute a given message on L2. Only applies to L1 => L2 messages. You would supply this gas limit when sending the message to L2.
Parameters
- message: MessageRequestLike
  Message get a gas estimate for.
- Optional opts: {
  bufferPercent?: number;
  from?: string;
  }
  Options object.
  - Optional bufferPercent?: number
    Percentage of gas to add to the estimate. Defaults to 20.
  - Optional from?: string
    Address to use as the sender.
- messageIndex: number = 0
Returns Promise<BigNumber>
Estimates L2 gas limit.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1130

estimateMessageWaitTimeSeconds

estimateMessageWaitTimeSeconds(message, messageIndex?, fromBlockOrBlockHash?, toBlockOrBlockHash?): Promise<number>
Returns the estimated amount of time before the message can be executed. When this is a message being sent to L1, this will return the estimated time until the message will complete its challenge period. When this is a message being sent to L2, this will return the estimated amount of time until the message will be picked up and executed on L2.
Parameters
- message: MessageLike
  Message to estimate the time remaining for.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
- Optional fromBlockOrBlockHash: BlockTag
- Optional toBlockOrBlockHash: BlockTag
Returns Promise<number>
Estimated amount of time remaining (in seconds) before the message can be executed.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1179

finalizeMessage

finalizeMessage(message, opts?, messageIndex?): Promise<TransactionResponse>
Finalizes a cross chain message that was sent from L2 to L1. Only applicable for L2 to L1 messages. Will throw an error if the message has not completed its challenge period yet.
Parameters
- message: MessageLike
  Message to finalize.
- Optional opts: {
  overrides?: PayableOverrides;
  signer?: Signer;
  }
  Additional options.
  - Optional overrides?: PayableOverrides
    Optional transaction overrides.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<TransactionResponse>
Transaction response for the finalization transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1965

fpac

fpac(): Promise<boolean>
Uses portal version to determine if the messenger is using fpac contracts. Better not to cache this value as it will change during the fpac upgrade and we want clients to automatically begin using the new logic without throwing any errors.

Returns Promise<boolean>
Whether or not the messenger is using fpac contracts.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:257

getBedrockMessageProof

getBedrockMessageProof(message, messageIndex?): Promise<BedrockCrossChainMessageProof>
Generates the bedrock proof required to finalize an L2 to L1 message.
Parameters
- message: MessageLike
  Message to generate a proof for.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<BedrockCrossChainMessageProof>
Proof that can be used to finalize the message.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1826

getBridgeForTokenPair

getBridgeForTokenPair(l1Token, l2Token): Promise<IBridgeAdapter>
Finds the appropriate bridge adapter for a given L1<>L2 token pair. Will throw if no bridges support the token pair or if more than one bridge supports the token pair.
Parameters
- l1Token: AddressLike
  L1 token address.
- l2Token: AddressLike
  L2 token address.
Returns Promise<IBridgeAdapter>
The appropriate bridge adapter for the given token pair.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:529

getChallengePeriodSeconds

getChallengePeriodSeconds(): Promise<number>
Queries the current challenge period in seconds from the StateCommitmentChain.

Returns Promise<number>
Current challenge period in seconds.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1252

getDepositsByAddress

getDepositsByAddress(address, opts?): Promise<TokenBridgeMessage[]>
Gets all deposits for a given address.
Parameters
- address: AddressLike
  Address to search for messages from.
- opts: {
  fromBlock?: BlockTag;
  toBlock?: BlockTag;
  } = {}
  Options object.
  - Optional fromBlock?: BlockTag
    Block to start searching for messages from. If not provided, will start from the first block (block #0).
  - Optional toBlock?: BlockTag
    Block to stop searching for messages at. If not provided, will stop at the latest known block ("latest").
Returns Promise<TokenBridgeMessage[]>
All deposit token bridge messages sent by the given address.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:571

getMessageBedrockOutput

getMessageBedrockOutput(message, messageIndex?): Promise<BedrockOutputData>
Returns the Bedrock output root that corresponds to the given message.
Parameters
- message: MessageLike
  Message to get the Bedrock output root for.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<BedrockOutputData>
Bedrock output root.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1456

getMessageProof

getMessageProof(message, messageIndex?): Promise<CrossChainMessageProof>
Generates the proof required to finalize an L2 to L1 message.
Parameters
- message: MessageLike
  Message to generate a proof for.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<CrossChainMessageProof>
Proof that can be used to finalize the message.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1766

getMessageReceipt

getMessageReceipt(message, messageIndex?, fromBlockOrBlockHash?, toBlockOrHash?): Promise<MessageReceipt>
Finds the receipt of the transaction that executed a particular cross chain message.
Parameters
- message: MessageLike
  Message to find the receipt of.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
- Optional fromBlockOrBlockHash: BlockTag
  The start block to use for the query filter on the RECEIVING chain
- Optional toBlockOrHash: BlockTag
Returns Promise<MessageReceipt>
CrossChainMessage receipt including receipt of the transaction that relayed the given message.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:879

getMessageStateRoot

getMessageStateRoot(message, messageIndex?): Promise<StateRoot>
Returns the state root that corresponds to a given message. This is the state root for the block in which the transaction was included, as published to the StateCommitmentChain. If the state root for the given message has not been published yet, this function returns null.
Parameters
- message: MessageLike
  Message to find a state root for.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<StateRoot>
State root for the block in which the message was created.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1579

getMessageStatus

getMessageStatus(message, messageIndex?, fromBlockOrBlockHash?, toBlockOrBlockHash?): Promise<MessageStatus>
Retrieves the status of a particular message as an enum.
Parameters
- message: MessageLike
  Cross chain message to check the status of.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
- Optional fromBlockOrBlockHash: BlockTag
  The start block to use for the query filter on the RECEIVING chain
- Optional toBlockOrBlockHash: BlockTag
  The end block to use for the query filter on the RECEIVING chain
Returns Promise<MessageStatus>
Status of the message.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:704

getMessagesByTransaction

getMessagesByTransaction(transaction, opts?): Promise<CrossChainMessage[]>
Retrieves all cross chain messages sent within a given transaction.
Parameters
- transaction: TransactionLike
  Transaction hash or receipt to find messages from.
- opts: {
  direction?: MessageDirection;
  } = {}
  Options object.
  - Optional direction?: MessageDirection
    Direction to search for messages in. If not provided, will attempt to automatically search both directions under the assumption that a transaction hash will only exist on one chain. If the hash exists on both chains, will throw an error.
Returns Promise<CrossChainMessage[]>
All cross chain messages sent within the transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:283

getProvenWithdrawal

getProvenWithdrawal(withdrawalHash): Promise<ProvenWithdrawal>
Queries the OptimismPortal contract's provenWithdrawals mapping for a ProvenWithdrawal that matches the passed withdrawalHash
Parameters
- withdrawalHash: string
Returns Promise<ProvenWithdrawal>
A ProvenWithdrawal object

Bedrock
Note: This function is bedrock-specific.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1283

getStateBatchAppendedEventByBatchIndex

getStateBatchAppendedEventByBatchIndex(batchIndex): Promise<Event>
Returns the StateBatchAppended event that was emitted when the batch with a given index was created. Returns null if no such event exists (the batch has not been submitted).
Parameters
- batchIndex: number
  Index of the batch to find an event for.
Returns Promise<Event>
StateBatchAppended event for the batch, or null if no such batch exists.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1638

getStateBatchAppendedEventByTransactionIndex

getStateBatchAppendedEventByTransactionIndex(transactionIndex): Promise<Event>
Returns the StateBatchAppended event for the batch that includes the transaction with the given index. Returns null if no such event exists.
Parameters
- transactionIndex: number
  Index of the L2 transaction to find an event for.
Returns Promise<Event>
StateBatchAppended event for the batch that includes the given transaction by index.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1664

getStateRootBatchByTransactionIndex

getStateRootBatchByTransactionIndex(transactionIndex): Promise<StateRootBatch>
Returns information about the state root batch that included the state root for the given transaction by index. Returns null if no such state root has been published yet.
Parameters
- transactionIndex: number
  Index of the L2 transaction to find a state root batch for.
Returns Promise<StateRootBatch>
State root batch for the given transaction index, or null if none exists yet.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1730

getWithdrawalsByAddress

getWithdrawalsByAddress(address, opts?): Promise<TokenBridgeMessage[]>
Gets all withdrawals for a given address.
Parameters
- address: AddressLike
  Address to search for messages from.
- opts: {
  fromBlock?: BlockTag;
  toBlock?: BlockTag;
  } = {}
  Options object.
  - Optional fromBlock?: BlockTag
    Block to start searching for messages from. If not provided, will start from the first block (block #0).
  - Optional toBlock?: BlockTag
    Block to stop searching for messages at. If not provided, will stop at the latest known block ("latest").
Returns Promise<TokenBridgeMessage[]>
All withdrawal token bridge messages sent by the given address.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:605

isValidOutputRoot

isValidOutputRoot(outputRoot, l2BlockNumber): Promise<boolean>
Checks whether a given root claim is valid. Uses the L2 node that the SDK is connected to when verifying the claim. Assumes that the connected L2 node is honest.
Parameters
- outputRoot: string
  Output root to verify.
- l2BlockNumber: number
  L2 block number the root is for.
Returns Promise<boolean>
Whether or not the root is valid.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1389

proveMessage

proveMessage(message, opts?, messageIndex?): Promise<TransactionResponse>
Proves a cross chain message that was sent from L2 to L1. Only applicable for L2 to L1 messages.
Parameters
- message: MessageLike
  Message to finalize.
- Optional opts: {
  overrides?: Overrides;
  signer?: Signer;
  }
  Additional options.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
- messageIndex: number = 0
  The index of the withdrawal if multiple are made with multicall
Returns Promise<TransactionResponse>
Transaction response for the finalization transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1935

resendMessage

resendMessage(message, messageGasLimit, opts?): Promise<TransactionResponse>
Resends a given cross chain message with a different gas limit. Only applies to L1 to L2 messages. If provided an L2 to L1 message, this function will throw an error.
Parameters
- message: MessageLike
  Cross chain message to resend.
- messageGasLimit: NumberLike
  New gas limit to use for the message.
- Optional opts: {
  overrides?: Overrides;
  signer?: Signer;
  }
  Additional options.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the message resending transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1908

sendMessage

sendMessage(message, opts?): Promise<TransactionResponse>
Sends a given cross chain message. Where the message is sent depends on the direction attached to the message itself.
Parameters
- message: CrossChainMessageRequest
  Cross chain message to send.
- Optional opts: {
      l2GasLimit?: NumberLike;
      overrides?: Overrides;
      signer?: Signer;
  }
  Additional options.
  - Optional l2GasLimit?: NumberLike
    Optional gas limit to use for the transaction on L2.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the message sending transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1881

toBedrockCrossChainMessage

toBedrockCrossChainMessage(message, messageIndex?): Promise<CrossChainMessage>
Transforms a legacy message into its corresponding Bedrock representation.
Parameters
- message: MessageLike
  Legacy message to transform.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<CrossChainMessage>
Bedrock representation of the message.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:374

toCrossChainMessage

toCrossChainMessage(message, messageIndex?): Promise<CrossChainMessage>
Resolves a MessageLike into a CrossChainMessage object. Unlike other coercion functions, this function is stateful and requires making additional requests. For now I'm going to keep this function here, but we could consider putting a similar function inside of utils/coercion.ts if people want to use this without having to create an entire CrossChainProvider object.
Parameters
- message: MessageLike
  MessageLike to resolve into a CrossChainMessage.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<CrossChainMessage>
Message coerced into a CrossChainMessage.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:639

toLowLevelMessage

toLowLevelMessage(message, messageIndex?): Promise<CoreCrossChainMessage>
Transforms a CrossChainMessenger message into its low-level representation inside the L2ToL1MessagePasser contract on L2.
Parameters
- message: MessageLike
  Message to transform.
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<CoreCrossChainMessage>
Transformed message.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:422

waitForMessageReceipt

waitForMessageReceipt(message, opts?, messageIndex?): Promise<MessageReceipt>
Waits for a message to be executed and returns the receipt of the transaction that executed the given message.
Parameters
- message: MessageLike
  Message to wait for.
- opts: {
      confirmations?: number;
      fromBlockOrBlockHash?: BlockTag;
      pollIntervalMs?: number;
      timeoutMs?: number;
      toBlockOrHash?: BlockTag;
  } = {}
  Options to pass to the waiting function.
  - Optional confirmations?: number
    Number of transaction confirmations to wait for before returning.
  - Optional fromBlockOrBlockHash?: BlockTag
    The start block to use for the query filter on the RECEIVING chain
  - Optional pollIntervalMs?: number
    Number of milliseconds to wait between polling for the receipt.
  - Optional timeoutMs?: number
    Milliseconds to wait before timing out.
  - Optional toBlockOrHash?: BlockTag
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<MessageReceipt>
CrossChainMessage receipt including receipt of the transaction that relayed the given message.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:992

waitForMessageStatus

waitForMessageStatus(message, status, opts?, messageIndex?): Promise<void>
Waits until the status of a given message changes to the expected status. Note that if the status of the given message changes to a status that implies the expected status, this will still return. If the status of the message changes to a status that exclues the expected status, this will throw an error.
Parameters
- message: MessageLike
  Message to wait for.
- status: MessageStatus
  Expected status of the message.
- opts: {
      fromBlockOrBlockHash?: BlockTag;
      pollIntervalMs?: number;
      timeoutMs?: number;
      toBlockOrBlockHash?: BlockTag;
  } = {}
  Options to pass to the waiting function.
  - Optional fromBlockOrBlockHash?: BlockTag
    The start block to use for the query filter on the RECEIVING chain
  - Optional pollIntervalMs?: number
    Number of milliseconds to wait when polling.
  - Optional timeoutMs?: number
    Milliseconds to wait before timing out.
  - Optional toBlockOrBlockHash?: BlockTag
    The end block to use for the query filter on the RECEIVING chain
- messageIndex: number = 0
  The index of the message, if multiple exist from multicall
Returns Promise<void>
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:1045

withdrawERC20

withdrawERC20(l1Token, l2Token, amount, opts?): Promise<TransactionResponse>
Withdraws some ERC20 tokens back to the L1 chain.
Parameters
- l1Token: AddressLike
  Address of the L1 token.
- l2Token: AddressLike
  Address of the L2 token.
- amount: NumberLike
  Amount to withdraw.
- Optional opts: {
      overrides?: Overrides;
      recipient?: AddressLike;
      signer?: Signer;
  }
  Additional options.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional recipient?: AddressLike
    Optional address to receive the funds on L1. Defaults to sender.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the withdraw transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:2190

withdrawETH

withdrawETH(amount, opts?): Promise<TransactionResponse>
Withdraws some ETH back to the L1 chain.
Parameters
- amount: NumberLike
  Amount of ETH to withdraw.
- Optional opts: {
      overrides?: Overrides;
      recipient?: AddressLike;
      signer?: Signer;
  }
  Additional options.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional recipient?: AddressLike
    Optional address to receive the funds on L1. Defaults to sender.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the withdraw transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:2017

withdrawNativeToken

withdrawNativeToken(amount, opts?): Promise<TransactionResponse>
Withdraws some L2 Native Token back to the L1 chain.
Parameters
- amount: NumberLike
  Amount of L2 Native Token to withdraw.
- Optional opts: {
      overrides?: Overrides;
      recipient?: AddressLike;
      signer?: Signer;
  }
  Additional options.
  - Optional overrides?: Overrides
    Optional transaction overrides.
  - Optional recipient?: AddressLike
    Optional address to receive the funds on L1. Defaults to sender.
  - Optional signer?: Signer
    Optional signer to use to send the transaction.
Returns Promise<TransactionResponse>
Transaction response for the withdrawal transaction.
- Defined in packages/tokamak/sdk/src/cross-chain-messenger.ts:2065

Class CrossChainMessenger

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional bedrock?: boolean

Optional bridges?: BridgeAdapterData

Optional contracts?: DeepPartial<OEContractsLike>

Optional depositConfirmationBlocks?: NumberLike

Optional l1BlockTimeSeconds?: NumberLike

l1ChainId: NumberLike

l1SignerOrProvider: SignerOrProviderLike

l2ChainId: NumberLike

l2SignerOrProvider: SignerOrProviderLike

Optional nativeTokenAddress?: AddressLike

Returns CrossChainMessenger

Properties

Private _outputCache

Type declaration

root: string

valid: boolean

bedrock

bridges

contracts

depositConfirmationBlocks

estimateGas

Type declaration

approveERC20: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>)

Param: l1Token

Param: l2Token

Param: amount

Param: opts

Param: opts.overrides

Returns

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: CallOverrides; }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

approveNativeToken: ((amount, opts?) => Promise<BigNumber>)

Param: amount

Param: opts

Param: opts.overrides

Returns

Parameters

amount: NumberLike

Optional opts: { overrides?: CallOverrides; }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

bridgeERC20: ((l1Token, l2Token, amount, opts?) => Promise<BigNumber>)

Param: l1Token

Param: l2Token

Param: amount

Param: opts

Param: opts.recipient

Param: opts.l2GasLimit

Param: opts.overrides

Returns

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike; }

Optional l2GasLimit?: NumberLike

Optional overrides?: CallOverrides

Optional recipient?: AddressLike

Returns Promise<BigNumber>

bridgeETH: ((amount, opts?) => Promise<BigNumber>)

Param: amount

Param: opts

Param: opts.recipient

Param: opts.l2GasLimit

Param: opts.overrides

Returns

`Optional` bedrock?: boolean

`Optional` bridges?: BridgeAdapterData

`Optional` contracts?: DeepPartial<OEContractsLike>

`Optional` depositConfirmationBlocks?: NumberLike

`Optional` l1BlockTimeSeconds?: NumberLike

`Optional` nativeTokenAddress?: AddressLike

`Private` _outputCache

`Optional` opts: {
overrides?: CallOverrides;
}

`Optional` overrides?: CallOverrides

`Optional` opts: {
overrides?: CallOverrides;
}

`Optional` overrides?: CallOverrides

`Optional` opts: {
l2GasLimit?: NumberLike;
overrides?: CallOverrides;
recipient?: AddressLike;
}

`Optional` l2GasLimit?: NumberLike

`Optional` overrides?: CallOverrides

`Optional` recipient?: AddressLike

`Optional` opts: {
l2GasLimit?: NumberLike;
overrides?: CallOverrides;
recipient?: AddressLike;
}

`Optional` l2GasLimit?: NumberLike

`Optional` overrides?: CallOverrides

`Optional` recipient?: AddressLike

`Optional` opts: {
l2GasLimit?: NumberLike;
overrides?: CallOverrides;
recipient?: AddressLike;
}

`Optional` l2GasLimit?: NumberLike

`Optional` overrides?: CallOverrides

`Optional` recipient?: AddressLike

`Optional` opts: {
overrides?: CallOverrides;
}

`Optional` overrides?: CallOverrides

`Optional` opts: {
overrides?: CallOverrides;
}

`Optional` overrides?: CallOverrides

`Optional` opts: {
overrides?: CallOverrides;
}

`Optional` overrides?: CallOverrides

`Optional` opts: {
l2GasLimit?: NumberLike;
overrides?: CallOverrides;
}

`Optional` l2GasLimit?: NumberLike

`Optional` overrides?: CallOverrides