ICrossChainMessenger | @constellation-labs/sdk

Handles L1/L2 interactions.

Hierarchy

ICrossChainMessenger

Implemented by

CrossChainMessenger

Properties

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: any; approveERC721: any; depositERC20: any; depositERC721: any; depositETH: any; finalizeMessage: any; resendMessage: any; sendMessage: any; withdrawERC20: any; withdrawERC721: any; withdrawETH: any }

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

Type declaration

approveERC20:function
- approveERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:900
  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.
approveERC721:function
- approveERC721(l1Token: AddressLike, l2Token: AddressLike, TOKEN_ID: NumberLike, opts?: { overrides?: CallOverrides }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:920
  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.
  - TOKEN_ID: NumberLike
    
    Token ID.
  - Optional opts: { overrides?: CallOverrides }
    
    Additional options.
    - Optional overrides?: CallOverrides
      
      Optional transaction overrides.
  Returns Promise<BigNumber>
  Transaction response for the approval transaction.
depositERC20:function
- depositERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:977
  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.
depositERC721:function
- depositERC721(l1Token: AddressLike, l2Token: AddressLike, TOKEN_ID: NumberLike, opts?: { extra_data?: String; l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:1002
  Estimates gas required to deposit some ERC721 tokens into the L2 chain.
  
  Parameters
  - l1Token: AddressLike
    
    Address of the L1 token.
  - l2Token: AddressLike
    
    Address of the L2 token.
  - TOKEN_ID: NumberLike
    
    Token ID.
  - Optional opts: { extra_data?: String; l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }
    
    Additional options.
    - Optional extra_data?: String
      
      Extra data to forward—will not be used to execute any code.
    - 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>
  Transaction response for the deposit transaction.
depositETH:function
- depositETH(amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides; recipient?: AddressLike }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:939
  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:function
- finalizeMessage(message: MessageLike, opts?: { overrides?: CallOverrides }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:883
  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.
resendMessage:function
- resendMessage(message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: CallOverrides }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:867
  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:function
- sendMessage(message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: CallOverrides }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:850
  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:function
- withdrawERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:1025
  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.
withdrawERC721:function
- withdrawERC721(l1Token: AddressLike, l2Token: AddressLike, TOKEN_ID: NumberLike, opts?: { extra_data?: String; overrides?: CallOverrides; recipient?: AddressLike }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:1048
  Estimates gas required to withdraw some ERC721 tokens back to the L1 chain.
  
  Parameters
  - l1Token: AddressLike
    
    Address of the L1 token.
  - l2Token: AddressLike
    
    Address of the L2 token.
  - TOKEN_ID: NumberLike
    
    Token ID.
  - Optional opts: { extra_data?: String; overrides?: CallOverrides; recipient?: AddressLike }
    
    Additional options.
    - Optional extra_data?: String
      
      Extra data to forward—will not be used to execute any code.
    - 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:function
- withdrawETH(amount: NumberLike, opts?: { overrides?: CallOverrides; recipient?: AddressLike }): Promise<BigNumber>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:957
  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.

getLogsProvider

getLogsProvider: Provider

Dedicated provider for eth_getLogs

l1BlockTimeSeconds

l1BlockTimeSeconds: number

Estimated average L1 block time in seconds.

l1ChainId

l1ChainId: number

Chain ID for the L1 network.

l1Provider

l1Provider: Provider

Provider connected to the L1 chain.

l1Signer

l1Signer: Signer

Signer connected to the L1 chain.

l1SignerOrProvider

l1SignerOrProvider: Signer | Provider

Provider connected to the L1 chain.

l2ChainId

l2ChainId: number

Chain ID for the L2 network.

l2Provider

l2Provider: Provider

Provider connected to the L2 chain.

l2Signer

l2Signer: Signer

Signer connected to the L2 chain.

l2SignerOrProvider

l2SignerOrProvider: Signer | Provider

Provider connected to the L2 chain.

populateTransaction

populateTransaction: { approveERC20: any; approveERC721: any; depositERC20: any; depositERC721: any; depositETH: any; finalizeMessage: any; resendMessage: any; sendMessage: any; withdrawERC20: any; withdrawERC721: any; withdrawETH: any }

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

Type declaration

approveERC20:function
- approveERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:678
  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—should always be 1.
  - Optional opts: { overrides?: Overrides }
    
    Additional options.
    - Optional overrides?: Overrides
      
      Optional transaction overrides.
  Returns Promise<TransactionRequest>
  Transaction response for the approval transaction.
approveERC721:function
- approveERC721(l1Token: AddressLike, l2Token: AddressLike, TOKEN_ID: NumberLike, opts?: { overrides?: Overrides }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:698
  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.
  - TOKEN_ID: NumberLike
    
    Token ID.
  - Optional opts: { overrides?: Overrides }
    
    Additional options.
    - Optional overrides?: Overrides
      
      Optional transaction overrides.
  Returns Promise<TransactionRequest>
  Transaction response for the approval transaction.
depositERC20:function
- depositERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:755
  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?: Overrides; recipient?: AddressLike }
    
    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.
  Returns Promise<TransactionRequest>
  Transaction that can be signed and executed to deposit the tokens.
depositERC721:function
- depositERC721(l1Token: AddressLike, l2Token: AddressLike, TOKEN_ID: NumberLike, opts?: { extra_data?: String; l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:800
  Generates a transaction for depositing some ERC721 tokens into the L2 chain.
  
  Parameters
  - l1Token: AddressLike
    
    Address of the L1 token.
  - l2Token: AddressLike
    
    Address of the L2 token.
  - TOKEN_ID: NumberLike
    
    Token ID.
  - Optional opts: { extra_data?: String; l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }
    
    Additional options.
    - Optional extra_data?: String
      
      Extra data to forward—will not be used to execute any code.
    - 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.
  Returns Promise<TransactionRequest>
  Transaction response for the deposit transaction.
depositETH:function
- depositETH(amount: NumberLike, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:717
  Generates a transaction for depositing some ETH into the L2 chain.
  
  Parameters
  - amount: NumberLike
    
    Amount of ETH to deposit.
  - Optional opts: { l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike }
    
    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.
  Returns Promise<TransactionRequest>
  Transaction that can be signed and executed to deposit the ETH.
finalizeMessage:function
- finalizeMessage(message: MessageLike, opts?: { overrides?: Overrides }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:661
  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?: Overrides }
    
    Additional options.
    - Optional overrides?: Overrides
      
      Optional transaction overrides.
  Returns Promise<TransactionRequest>
  Transaction that can be signed and executed to finalize the message.
resendMessage:function
- resendMessage(message: MessageLike, messageGasLimit: NumberLike, opts?: { overrides?: Overrides }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:643
  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:function
- sendMessage(message: CrossChainMessageRequest, opts?: { l2GasLimit?: NumberLike; overrides?: Overrides }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:625
  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:function
- withdrawERC20(l1Token: AddressLike, l2Token: AddressLike, amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:777
  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.
withdrawERC721:function
- withdrawERC721(l1Token: AddressLike, l2Token: AddressLike, TOKEN_ID: NumberLike, opts?: { extra_data?: String; overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:824
  Generates a transaction for withdrawing some ERC721 tokens back to the L1 chain.
  
  Parameters
  - l1Token: AddressLike
    
    Address of the L1 token.
  - l2Token: AddressLike
    
    Address of the L2 token.
  - TOKEN_ID: NumberLike
    
    Token ID.
  - Optional opts: { extra_data?: String; overrides?: Overrides; recipient?: AddressLike }
    
    Additional options.
    - Optional extra_data?: String
      
      Extra data to forward—will not be used to execute any code.
    - Optional overrides?: Overrides
      
      Optional transaction overrides.
    - Optional recipient?: AddressLike
      
      Optional address to receive the funds on L2. Defaults to sender.
  Returns Promise<TransactionRequest>
  Transaction response for the deposit transaction.
withdrawETH:function
- withdrawETH(amount: NumberLike, opts?: { overrides?: Overrides; recipient?: AddressLike }): Promise<TransactionRequest>
- - Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:735
  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.

Methods

approval

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

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:457
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:476
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.

approveERC721

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

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:498
Approves a deposit into the L2 chain.

Parameters
- l1Token: AddressLike
  
  The L1 token address.
- l2Token: AddressLike
  
  The L2 token address.
- TOKEN_ID: NumberLike
  
  Token ID.
- 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?: Overrides; recipient?: AddressLike; signer?: Signer }): Promise<TransactionResponse>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:521
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?: 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.

depositERC721

depositERC721(l1Token: AddressLike, l2Token: AddressLike, TOKEN_ID: NumberLike, opts?: { extra_data?: String; l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike; signer?: Signer }): Promise<TransactionResponse>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:548
Deposits some ERC721 tokens into the L2 chain.

Parameters
- l1Token: AddressLike
  
  Address of the L1 token.
- l2Token: AddressLike
  
  Address of the L2 token.
- TOKEN_ID: NumberLike
  
  Token ID.
- Optional opts: { extra_data?: String; l2GasLimit?: NumberLike; overrides?: Overrides; recipient?: AddressLike; signer?: Signer }
  
  Additional options.
  - Optional extra_data?: String
    
    Extra data to forward—will not be used to execute any code.
  - 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.

depositETH

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

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:419
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:273
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:290
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?: Overrides; signer?: Signer }): Promise<TransactionResponse>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:400
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?: 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.

getBridgeForTokenPair

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

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:149
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:297
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<BridgeMessage[]>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:165
Gets all deposits for a given address.

Parameters
- address: AddressLike
  
  Address to search for messages from.
- Optional 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<BridgeMessage[]>
All deposit token bridge messages sent by the given address.

getMessageProof

getMessageProof(message: MessageLike): Promise<CrossChainMessageProof>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:348
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:219
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:307
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:210
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:109
Retrieves all cross chain messages sent within a given transaction.

Parameters
- transaction: TransactionLike
  
  Transaction hash or receipt to find messages from.
- Optional 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.

getStateBatchAppendedEventByBatchIndex

getStateBatchAppendedEventByBatchIndex(batchIndex: number): Promise<Event>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:316
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:327
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:338
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<BridgeMessage[]>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:184
Gets all withdrawals for a given address.

Parameters
- address: AddressLike
  
  Address to search for messages from.
- Optional 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<BridgeMessage[]>
All withdrawal token bridge messages sent by the given address.

resendMessage

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

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:381
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 packages/sdk/src/interfaces/cross-chain-messenger.ts:361
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.

toCrossChainMessage

toCrossChainMessage(message: MessageLike): Promise<CrossChainMessage>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:202
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.

waitForMessageReceipt

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

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:233
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.
- Optional 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 packages/sdk/src/interfaces/cross-chain-messenger.ts:254
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.
- Optional 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 packages/sdk/src/interfaces/cross-chain-messenger.ts:573
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.

withdrawERC721

withdrawERC721(l1Token: AddressLike, l2Token: AddressLike, TOKEN_ID: NumberLike, opts?: { extra_data?: String; overrides?: Overrides; recipient?: AddressLike; signer?: Signer }): Promise<TransactionResponse>

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:598
Withdraws some ERC721 tokens back to the L1 chain.

Parameters
- l1Token: AddressLike
  
  Address of the L1 token.
- l2Token: AddressLike
  
  Address of the L2 token.
- TOKEN_ID: NumberLike
  
  Token ID.
- Optional opts: { extra_data?: String; overrides?: Overrides; recipient?: AddressLike; signer?: Signer }
  
  Additional options.
  - Optional extra_data?: String
    
    Extra data to forward—will not be used to execute any code.
  - 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.

withdrawETH

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

- Defined in packages/sdk/src/interfaces/cross-chain-messenger.ts:439
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

Implemented by

Index

Properties

Methods

Properties

bridges

contracts

depositConfirmationBlocks

estimateGas

Type declaration

approveERC20:function

Parameters

l1Token: AddressLike

l2Token: AddressLike

amount: NumberLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

approveERC721:function

Parameters

l1Token: AddressLike

l2Token: AddressLike

TOKEN_ID: NumberLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

depositERC20:function

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>

depositERC721:function

Parameters

l1Token: AddressLike

l2Token: AddressLike

TOKEN_ID: NumberLike

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

Optional extra_data?: String

Optional l2GasLimit?: NumberLike

Optional overrides?: CallOverrides

Optional recipient?: AddressLike

Returns Promise<BigNumber>

depositETH:function

Parameters

amount: NumberLike

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

Optional l2GasLimit?: NumberLike

Optional overrides?: CallOverrides

Optional recipient?: AddressLike

Returns Promise<BigNumber>

finalizeMessage:function

Parameters

message: MessageLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

resendMessage:function

Parameters

message: MessageLike

messageGasLimit: NumberLike

Optional opts: { overrides?: CallOverrides }

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

sendMessage:function

Parameters

message: CrossChainMessageRequest

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

Optional l2GasLimit?: NumberLike

Optional overrides?: CallOverrides

Returns Promise<BigNumber>

withdrawERC20:function

Parameters

l1Token: AddressLike

l2Token: AddressLike