CrossChainMessenger | @eth-optimism/sdk

Hierarchy

CrossChainMessenger

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new CrossChainMessenger(opts: { bedrock?: boolean; bridges?: BridgeAdapterData; contracts?: DeepPartial<OEContractsLike>; depositConfirmationBlocks?: NumberLike; l1BlockTimeSeconds?: NumberLike; l1ChainId: NumberLike; l1SignerOrProvider: SignerOrProviderLike; l2ChainId: NumberLike; l2SignerOrProvider: SignerOrProviderLike }): CrossChainMessenger

- Defined in src/cross-chain-messenger.ts:135
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 }
  
  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.
Returns CrossChainMessenger

Properties

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: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>); depositERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>); depositETH: ((amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>); finalizeMessage: ((message: MessageLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>); proveMessage: ((message: MessageLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>); resendMessage: ((message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>); sendMessage: ((message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides }) => Promise<BigNumber>); withdrawERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>); withdrawETH: ((amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }) => 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: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>)
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }): 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.
depositERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>)
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }): 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.
depositETH: ((amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>)
- - (amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }): 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.
finalizeMessage: ((message: MessageLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>)
- - (message: MessageLike, opts?: { overrides?: CallOverrides }): 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.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
proveMessage: ((message: MessageLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>)
- - (message: MessageLike, opts?: { overrides?: CallOverrides }): 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.
    Returns Promise<BigNumber>
    Gas estimate for the transaction.
resendMessage: ((message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>)
- - (message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: CallOverrides }): 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: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides }) => Promise<BigNumber>)
- - (message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides }): 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: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>)
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }): 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: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>)
- - (amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }): 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.

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.

populateTransaction

populateTransaction: { approveERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides }) => Promise<TransactionRequest>); depositERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }, isEstimatingGas?: boolean) => Promise<TransactionRequest>); depositETH: ((amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: PayableOverrides; recipient?: AddressLike }, isEstimatingGas?: boolean) => Promise<TransactionRequest>); finalizeMessage: ((message: MessageLike, opts?: { overrides?: PayableOverrides }) => Promise<TransactionRequest>); proveMessage: ((message: MessageLike, opts?: { overrides?: PayableOverrides }) => Promise<TransactionRequest>); resendMessage: ((message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: Overrides }) => Promise<TransactionRequest>); sendMessage: ((message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides }) => Promise<TransactionRequest>); withdrawERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest>); withdrawETH: ((amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }) => 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: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides }) => Promise<TransactionRequest>)
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides }): 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.
depositERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }, isEstimatingGas?: boolean) => Promise<TransactionRequest>)
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }, isEstimatingGas?: boolean): 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
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to deposit the tokens.
depositETH: ((amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: PayableOverrides; recipient?: AddressLike }, isEstimatingGas?: boolean) => Promise<TransactionRequest>)
- - (amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: PayableOverrides; recipient?: AddressLike }, isEstimatingGas?: boolean): 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?: PayableOverrides; recipient?: AddressLike }
      
      Additional options.
      - Optional l2GasLimit?: NumberLike
        
        Optional gas limit to use for the transaction on L2.
      - Optional overrides?: PayableOverrides
        
        Optional transaction overrides.
      - Optional recipient?: AddressLike
        
        Optional address to receive the funds on L2. Defaults to sender.
    - isEstimatingGas: boolean = false
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to deposit the ETH.
finalizeMessage: ((message: MessageLike, opts?: { overrides?: PayableOverrides }) => Promise<TransactionRequest>)
- - (message: MessageLike, opts?: { overrides?: PayableOverrides }): 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.
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to finalize the message.
proveMessage: ((message: MessageLike, opts?: { overrides?: PayableOverrides }) => Promise<TransactionRequest>)
- - (message: MessageLike, opts?: { overrides?: PayableOverrides }): 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.
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to prove the message.
resendMessage: ((message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: Overrides }) => Promise<TransactionRequest>)
- - (message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: Overrides }): 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.
    Returns Promise<TransactionRequest>
    Transaction that can be signed and executed to resend the message.
sendMessage: ((message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides }) => Promise<TransactionRequest>)
- - (message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides }): 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: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest>)
- - (l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }): 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: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }) => Promise<TransactionRequest>)
- - (amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }): 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.

Accessors

l1Provider

get l1Provider(): Provider

- Defined in src/cross-chain-messenger.ts:188
Provider connected to the L1 chain.

Returns Provider

l1Signer

get l1Signer(): Signer

- Defined in src/cross-chain-messenger.ts:210
Signer connected to the L1 chain.

Returns Signer

l2Provider

get l2Provider(): Provider

- Defined in src/cross-chain-messenger.ts:199
Provider connected to the L2 chain.

Returns Provider

l2Signer

get l2Signer(): Signer

- Defined in src/cross-chain-messenger.ts:221
Signer connected to the L2 chain.

Returns Signer

Methods

approval

approval(l1Token: AddressLike, l2Token: AddressLike, opts?: { signer?: Signer }): Promise<BigNumber>

- Defined in src/cross-chain-messenger.ts:1552
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.

approveERC20

approveERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1574
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.

depositERC20

depositERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1606
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.

depositETH

depositETH(amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1506
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.

estimateL2MessageGasLimit

estimateL2MessageGasLimit(message: MessageRequestLike, opts?: { bufferPercent?: number; from?: string }): Promise<BigNumber>

- Defined in src/cross-chain-messenger.ts:907
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.
Returns Promise<BigNumber>
Estimates L2 gas limit.

estimateMessageWaitTimeSeconds

estimateMessageWaitTimeSeconds(message: MessageLike): Promise<number>

- Defined in src/cross-chain-messenger.ts:949
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.
Returns Promise<number>
Estimated amount of time remaining (in seconds) before the message can be executed.

finalizeMessage

finalizeMessage(message: MessageLike, opts?: { overrides?: PayableOverrides; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1483
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.
Returns Promise<TransactionResponse>
Transaction response for the finalization transaction.

getBedrockMessageProof

getBedrockMessageProof(message: MessageLike): Promise<BedrockCrossChainMessageProof>

- Defined in src/cross-chain-messenger.ts:1354
Generates the bedrock proof required to finalize an L2 to L1 message.

Parameters
- message: MessageLike
  
  Message to generate a proof for.
Returns Promise<BedrockCrossChainMessageProof>
Proof that can be used to finalize the message.

getBridgeForTokenPair

getBridgeForTokenPair(l1Token: AddressLike, l2Token: AddressLike): Promise<IBridgeAdapter>

- Defined in src/cross-chain-messenger.ts:477
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.

getChallengePeriodSeconds

getChallengePeriodSeconds(): Promise<number>

- Defined in src/cross-chain-messenger.ts:1013
Queries the current challenge period in seconds from the StateCommitmentChain.

Returns Promise<number>
Current challenge period in seconds.

getDepositsByAddress

getDepositsByAddress(address: AddressLike, opts?: { fromBlock?: BlockTag; toBlock?: BlockTag }): Promise<TokenBridgeMessage[]>

- Defined in src/cross-chain-messenger.ts:510
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.

getMessageBedrockOutput

getMessageBedrockOutput(message: MessageLike): Promise<BedrockOutputData>

- Defined in src/cross-chain-messenger.ts:1060
Returns the Bedrock output root that corresponds to the given message.

Parameters
- message: MessageLike
  
  Message to get the Bedrock output root for.
Returns Promise<BedrockOutputData>
Bedrock output root.

getMessageProof

getMessageProof(message: MessageLike): Promise<CrossChainMessageProof>

- Defined in src/cross-chain-messenger.ts:1296
Generates the proof required to finalize an L2 to L1 message.

Parameters
- message: MessageLike
  
  Message to generate a proof for.
Returns Promise<CrossChainMessageProof>
Proof that can be used to finalize the message.

getMessageReceipt

getMessageReceipt(message: MessageLike): Promise<MessageReceipt>

- Defined in src/cross-chain-messenger.ts:715
Finds the receipt of the transaction that executed a particular cross chain message.

Parameters
- message: MessageLike
  
  Message to find the receipt of.
Returns Promise<MessageReceipt>
CrossChainMessage receipt including receipt of the transaction that relayed the given message.

getMessageStateRoot

getMessageStateRoot(message: MessageLike): Promise<StateRoot>

- Defined in src/cross-chain-messenger.ts:1111
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.
Returns Promise<StateRoot>
State root for the block in which the message was created.

getMessageStatus

getMessageStatus(message: MessageLike): Promise<MessageStatus>

- Defined in src/cross-chain-messenger.ts:639
Retrieves the status of a particular message as an enum.

Parameters
- message: MessageLike
  
  Cross chain message to check the status of.
Returns Promise<MessageStatus>
Status of the message.

getMessagesByTransaction

getMessagesByTransaction(transaction: TransactionLike, opts?: { direction?: MessageDirection }): Promise<CrossChainMessage[]>

- Defined in src/cross-chain-messenger.ts:239
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.

getProvenWithdrawal

getProvenWithdrawal(withdrawalHash: string): Promise<ProvenWithdrawal>

- Defined in src/cross-chain-messenger.ts:1044
Queries the OptimismPortal contract's provenWithdrawals mapping for a ProvenWithdrawal that matches the passed withdrawalHash

bedrock
Note: This function is bedrock-specific.

Parameters
- withdrawalHash: string
Returns Promise<ProvenWithdrawal>
A ProvenWithdrawal object

getStateBatchAppendedEventByBatchIndex

getStateBatchAppendedEventByBatchIndex(batchIndex: number): Promise<Event>

- Defined in src/cross-chain-messenger.ts:1169
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.

getStateBatchAppendedEventByTransactionIndex

getStateBatchAppendedEventByTransactionIndex(transactionIndex: number): Promise<Event>

- Defined in src/cross-chain-messenger.ts:1195
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.

getStateRootBatchByTransactionIndex

getStateRootBatchByTransactionIndex(transactionIndex: number): Promise<StateRootBatch>

- Defined in src/cross-chain-messenger.ts:1261
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.

getWithdrawalsByAddress

getWithdrawalsByAddress(address: AddressLike, opts?: { fromBlock?: BlockTag; toBlock?: BlockTag }): Promise<TokenBridgeMessage[]>

- Defined in src/cross-chain-messenger.ts:544
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.

proveMessage

proveMessage(message: MessageLike, opts?: { overrides?: Overrides; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1462
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.
Returns Promise<TransactionResponse>
Transaction response for the finalization transaction.

resendMessage

resendMessage(message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: Overrides; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1435
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.

sendMessage

sendMessage(message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1408
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.

toBedrockCrossChainMessage

toBedrockCrossChainMessage(message: MessageLike): Promise<CrossChainMessage>

- Defined in src/cross-chain-messenger.ts:329
Transforms a legacy message into its corresponding Bedrock representation.

Parameters
- message: MessageLike
  
  Legacy message to transform.
Returns Promise<CrossChainMessage>
Bedrock representation of the message.

toCrossChainMessage

toCrossChainMessage(message: MessageLike): Promise<CrossChainMessage>

- Defined in src/cross-chain-messenger.ts:577
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.
Returns Promise<CrossChainMessage>
Message coerced into a CrossChainMessage.

toLowLevelMessage

toLowLevelMessage(message: MessageLike): Promise<CoreCrossChainMessage>

- Defined in src/cross-chain-messenger.ts:375
Transforms a CrossChainMessenger message into its low-level representation inside the L2ToL1MessagePasser contract on L2.

Parameters
- message: MessageLike
  
  Message to transform.
Returns Promise<CoreCrossChainMessage>
Transformed message.

waitForMessageReceipt

waitForMessageReceipt(message: MessageLike, opts?: { confirmations?: number; pollIntervalMs?: number; timeoutMs?: number }): Promise<MessageReceipt>

- Defined in src/cross-chain-messenger.ts:792
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; pollIntervalMs?: number; timeoutMs?: number } = {}
  
  Options to pass to the waiting function.
  - Optional confirmations?: number
    
    Number of transaction confirmations to wait for before returning.
  - Optional pollIntervalMs?: number
    
    Number of milliseconds to wait between polling for the receipt.
  - Optional timeoutMs?: number
    
    Milliseconds to wait before timing out.
Returns Promise<MessageReceipt>
CrossChainMessage receipt including receipt of the transaction that relayed the given message.

waitForMessageStatus

waitForMessageStatus(message: MessageLike, status: MessageStatus, opts?: { pollIntervalMs?: number; timeoutMs?: number }): Promise<void>

- Defined in src/cross-chain-messenger.ts:830
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: { pollIntervalMs?: number; timeoutMs?: number } = {}
  
  Options to pass to the waiting function.
  - Optional pollIntervalMs?: number
    
    Number of milliseconds to wait when polling.
  - Optional timeoutMs?: number
    
    Milliseconds to wait before timing out.
Returns Promise<void>

withdrawERC20

withdrawERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1639
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.

withdrawETH

withdrawETH(amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike; signer?: Signer }): Promise<TransactionResponse>

- Defined in src/cross-chain-messenger.ts:1530
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.

Hierarchy

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

Returns CrossChainMessenger

Properties

bedrock

bridges

contracts

depositConfirmationBlocks

estimateGas

Type declaration

approveERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>)

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

depositERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>)

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>

depositETH: ((amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>)

Parameters

amount: NumberLike

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

Optional l2GasLimit?: NumberLike

Optional overrides?: CallOverrides

Optional recipient?: AddressLike

Returns Promise<BigNumber>

finalizeMessage: ((message: MessageLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>)

Parameters

message: MessageLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

proveMessage: ((message: MessageLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>)

Parameters

message: MessageLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

resendMessage: ((message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: CallOverrides }) => Promise<BigNumber>)

Parameters

message: MessageLike

messageGasLimit: NumberLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

sendMessage: ((message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides }) => Promise<BigNumber>)

Parameters

message: CrossChainMessageRequest

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

Optional l2GasLimit?: NumberLike

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

withdrawERC20: ((l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }) => Promise<BigNumber>)

Parameters