@morph-l2/sdk / CrossChainMessenger
Class: CrossChainMessenger
Constructors
new CrossChainMessenger()
new CrossChainMessenger(opts): CrossChainMessenger
Creates a new CrossChainProvider instance.
Parameters
• opts
Options for the provider.
• opts.backendURL?: string
backend for withdraw proof gen.
• opts.bridges?: BridgeAdapterData
Optional bridge address list.
• opts.contracts?: DeepPartial<OEContractsLike\
Optional contract address overrides.
• opts.depositConfirmationBlocks?: NumberLike
Optional number of blocks before a deposit is confirmed.
• opts.l1BlockTimeSeconds?: NumberLike
Optional estimated block time in seconds for the L1 chain.
• opts.l1ChainId: NumberLike
Chain ID for the L1 chain.
• opts.l1SignerOrProvider: SignerOrProviderLike
Signer or Provider for the L1 chain, or a JSON-RPC url.
• opts.l2ChainId: NumberLike
Chain ID for the L2 chain.
• opts.l2SignerOrProvider: SignerOrProviderLike
Signer or Provider for the L2 chain, or a JSON-RPC url.
Returns
CrossChainMessenger
Source
src/cross-chain-messenger.ts:146
Properties
backendURL
backendURL: string
Backend url for withdrawal prove server
Source
src/cross-chain-messenger.ts:80
bridges
bridges: BridgeAdapters
List of custom bridges for the given network.
Source
src/cross-chain-messenger.ts:120
contracts
contracts: OEContracts
Contract objects attached to their respective providers and addresses.
Source
src/cross-chain-messenger.ts:115
depositConfirmationBlocks
depositConfirmationBlocks: number
Number of blocks before a deposit is considered confirmed.
Source
src/cross-chain-messenger.ts:125
estimateGas
estimateGas: object
Object that holds the functions that estimates the gas required for a given transaction. Follows the pattern used by ethers.js.
approveERC20()
approveERC20: (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.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: CallOverrides
Optional transaction overrides.
• opts.recipient?: AddressLike
• opts.signer?: Signer
Returns
Promise<BigNumber\
depositERC20()
depositERC20: (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.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: CallOverrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L2. Defaults to sender.
Returns
Promise<BigNumber\
depositETH()
depositETH: (amount, opts?) = Promise<BigNumber\
Estimates gas required to deposit some ETH into the L2 chain.
Parameters
• amount: NumberLike
Amount of ETH to deposit.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: CallOverrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L2. Defaults to sender.
Returns
Promise<BigNumber\
proveAndRelayMessage()
proveAndRelayMessage: (message, opts?) = Promise<BigNumber\
Estimates gas required to proveAndRelay a cross chain message. Only applies to L2 to L1 messages.
Parameters
• message: MessageLike
Message to generate the proving transaction for.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: CallOverrides
Optional transaction overrides.
Returns
Promise<BigNumber\
sendMessage()
sendMessage: (message, opts?) = Promise<BigNumber\
Estimates gas required to send a cross chain message.
Parameters
• message: CrossChainMessageRequest
Cross chain message to send.
• opts?
Additional options.
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: CallOverrides
Optional transaction overrides.
Returns
Promise<BigNumber\
withdrawERC20()
withdrawERC20: (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.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: CallOverrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L1. Defaults to sender.
Returns
Promise<BigNumber\
withdrawETH()
withdrawETH: (amount, opts?) = Promise<BigNumber\
Estimates gas required to withdraw some ETH back to the L1 chain.
Parameters
• amount: NumberLike
Amount of ETH to withdraw.
• opts?
Additional options.
• opts.overrides?: CallOverrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L1. Defaults to sender.
Returns
Promise<BigNumber\
Source
src/cross-chain-messenger.ts:1837
l1BlockTimeSeconds
l1BlockTimeSeconds: number
Estimated average L1 block time in seconds.
Source
src/cross-chain-messenger.ts:130
l1ChainId
l1ChainId: number
Chain ID for the L1 network.
Source
src/cross-chain-messenger.ts:105
l1CrossDomainMessenger
l1CrossDomainMessenger: Contract
CrossDomainMessenger connected to the L1 chain.
Source
src/cross-chain-messenger.ts:95
l1SignerOrProvider
l1SignerOrProvider: Provider | Signer
Provider connected to the L1 chain.
Source
src/cross-chain-messenger.ts:85
l2ChainId
l2ChainId: number
Chain ID for the L2 network.
Source
src/cross-chain-messenger.ts:110
l2CrossDomainMessenger
l2CrossDomainMessenger: Contract
CrossDomainMessenger connected to the L2 chain.
Source
src/cross-chain-messenger.ts:100
l2SignerOrProvider
l2SignerOrProvider: Provider | Signer
Provider connected to the L2 chain.
Source
src/cross-chain-messenger.ts:90
populateTransaction
populateTransaction: object
Object that holds the functions that generate transactions to be signed by the user. Follows the pattern used by ethers.js.
approveERC20()
approveERC20: (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.
• opts
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.recipient?: AddressLike
• opts.signer: Signer
Returns
Promise<TransactionRequest\
depositERC20()
depositERC20: (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.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: CallOverrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L2. Defaults to sender.
• isEstimatingGas?: boolean= false
Returns
Promise<TransactionRequest\
depositETH()
depositETH: (amount, opts?, isEstimatingGas) = Promise<TransactionRequest\
Generates a transaction for depositing some ETH into the L2 chain.
Parameters
• amount: NumberLike
Amount of ETH to deposit.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: PayableOverrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L2. Defaults to sender.
• isEstimatingGas?: boolean= false
Returns
Promise<TransactionRequest\
proveAndRelayMessage()
proveAndRelayMessage: (message, opts?) = Promise<TransactionRequest\
Generates a message proving and relaying transaction that can be signed and executed. Only applicable for L2 to L1 messages.
Parameters
• message: MessageLike
Message to generate the proving transaction for.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: PayableOverrides
Optional transaction overrides.
Returns
Promise<TransactionRequest\
sendMessage()
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.
Parameters
• message: CrossChainMessageRequest
Cross chain message to send.
• opts?
Additional options.
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: Overrides
Optional transaction overrides.
Returns
Promise<TransactionRequest\
withdrawERC20()
withdrawERC20: (l1Token, l2Token, amount, opts?, isEstimatingGas?) = 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.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L1. Defaults to sender.
• isEstimatingGas?: boolean
Returns
Promise<TransactionRequest\
withdrawETH()
withdrawETH: (amount, opts?, isEstimatingGas?) = Promise<TransactionRequest\
Generates a transaction for withdrawing some ETH back to the L1 chain.
Parameters
• amount: NumberLike
Amount of ETH to withdraw.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L1. Defaults to sender.
• isEstimatingGas?: boolean
Returns
Promise<TransactionRequest\
Source
src/cross-chain-messenger.ts:1498
Accessors
l1Provider
get l1Provider(): Provider
Provider connected to the L1 chain.
Returns
Provider
Source
src/cross-chain-messenger.ts:221
l1Signer
get l1Signer(): Signer
Signer connected to the L1 chain.
Returns
Signer
Source
src/cross-chain-messenger.ts:243
l2Provider
get l2Provider(): Provider
Provider connected to the L2 chain.
Returns
Provider
Source
src/cross-chain-messenger.ts:232
l2Signer
get l2Signer(): Signer
Signer connected to the L2 chain.
Returns
Signer
Source
src/cross-chain-messenger.ts:254
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.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: Overrides
• opts.recipient?: AddressLike
• opts.signer?: Signer
Optional signer to get the approval for.
Returns
Promise<BigNumber\
Amount of tokens approved for deposits from the account.
Source
src/cross-chain-messenger.ts:1381
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.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.recipient?: AddressLike
• opts.signer?: Signer
Optional signer to use to send the transaction.
Returns
Promise<TransactionResponse\
Transaction response for the approval transaction.
Source
src/cross-chain-messenger.ts:1406
depositERC20()
depositERC20(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.
• opts?
Additional options.
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L2. Defaults to sender.
• opts.signer?: Signer
Optional signer to use to send the transaction.
Returns
Promise<TransactionResponse\
Transaction response for the deposit transaction.
Source
src/cross-chain-messenger.ts:1438
depositETH()
depositETH(amount, opts?): Promise<TransactionResponse\
Deposits some ETH into the L2 chain.
Parameters
• amount: NumberLike
Amount of ETH to deposit (in wei).
• opts?
Additional options.
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L2. Defaults to sender.
• opts.signer?: Signer
Optional signer to use to send the transaction.
Returns
Promise<TransactionResponse\
Transaction response for the deposit transaction.
Source
src/cross-chain-messenger.ts:1336
encodeFunctionMessage()
encodeFunctionMessage(__namedParameters): string
L2CrossDomainMessenger contract encode message, such as hashCrossDomainMessagev1
Parameters
• __namedParameters
• __namedParameters.message: string
• __namedParameters.messageNonce: BigNumber
• __namedParameters.sender: string
• __namedParameters.target: string
• __namedParameters.value: BigNumber
Returns
string
Source
src/cross-chain-messenger.ts:1114
estimateL2MessageGasLimit()
estimateL2MessageGasLimit(message, opts?): 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.
• opts?
Options object.
• opts.bufferPercent?: number
Percentage of gas to add to the estimate. Defaults to 20.
• opts.from?: string
Address to use as the sender.
Returns
Promise<BigNumber\
Estimates L2 gas limit.
Source
src/cross-chain-messenger.ts:982
estimateMessageWaitTimeSeconds()
estimateMessageWaitTimeSeconds(message): 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.
Returns
Promise<number\
Estimated amount of time remaining (in seconds) before the message can be executed.
Source
src/cross-chain-messenger.ts:1024
getBackendTreeSyncIndex()
getBackendTreeSyncIndex(): Promise<number\
Returns
Promise<number\
Source
src/cross-chain-messenger.ts:1257
getBridgeForTokenPair()
getBridgeForTokenPair(l1Token, l2Token): Promise[IBridgeAdapter](/docs/build-on-morph/sdk/interfaces/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.
Source
src/cross-chain-messenger.ts:407
getChallengePeriodSeconds()
getChallengePeriodSeconds(): Promise<number\
Queries the current challenge period in seconds from the StateCommitmentChain.
Returns
Promise<number\
Current challenge period in seconds.
Source
src/cross-chain-messenger.ts:1087
getCommittedL2BlockNumber()
getCommittedL2BlockNumber(): Promise<any\
Returns
Promise<any\
Source
src/cross-chain-messenger.ts:1136
getDepositsByAddress()
getDepositsByAddress(address, opts): Promise<TokenBridgeMessage[]\
Gets all deposits for a given address.
Parameters
• address: AddressLike
Address to search for messages from.
• opts= {}
Options object.
• opts.fromBlock?: BlockTag
Block to start searching for messages from. If not provided, will start from the first block (block #0).
• opts.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.
Source
src/cross-chain-messenger.ts:453
getFinalizedL2BlockNumber()
getFinalizedL2BlockNumber(): Promise<any\
Returns
Promise<any\
Source
src/cross-chain-messenger.ts:1154
getMessageReceipt()
getMessageReceipt(message, opts): Promise<MessageReceipt\
Finds the receipt of the transaction that executed a particular cross chain message.
Parameters
• message: MessageLike
Message to find the receipt of.
• opts= {}
• opts.direction?: MessageDirection
Returns
Promise<MessageReceipt\
CrossChainMessage receipt including receipt of the transaction that relayed the given message.
Source
src/cross-chain-messenger.ts:778
getMessageStatus()
getMessageStatus(message, opts): Promise<MessageStatus\
Retrieves the status of a particular message as an enum.
Parameters
• message: MessageLike
Cross chain message to check the status of.
• opts= {}
• opts.direction?: MessageDirection
Returns
Promise<MessageStatus\
Status of the message.
Source
src/cross-chain-messenger.ts:663
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= {}
Options object.
• opts.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.
Source
src/cross-chain-messenger.ts:272
getProvenWithdrawal()
getProvenWithdrawal(withdrawalHash): Promise<ProvenWithdrawal\
Queries the L1CrossDomainMessenger contract's provenWithdrawals mapping
for a ProvenWithdrawal that matches the passed withdrawalHash
Parameters
• withdrawalHash: string
Returns
Promise<ProvenWithdrawal\
A ProvenWithdrawal object
Source
src/cross-chain-messenger.ts:1099
getWithdrawMessageProof()
getWithdrawMessageProof(message): Promise<WithdrawMessageProof\
Generates the proof required to finalize an L2 to L1 message.
Parameters
• message: MessageLike
Message to generate a proof for.
Returns
Promise<WithdrawMessageProof\
Proof that can be used to finalize the message.
Source
src/cross-chain-messenger.ts:1177
getWithdrawalsByAddress()
getWithdrawalsByAddress(address, opts): Promise<TokenBridgeMessage[]\
Gets all withdrawals for a given address.
Parameters
• address: AddressLike
Address to search for messages from.
• opts= {}
Options object.
• opts.fromBlock?: BlockTag
Block to start searching for messages from. If not provided, will start from the first block (block #0).
• opts.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.
Source
src/cross-chain-messenger.ts:487
proveAndRelayMessage()
proveAndRelayMessage(message, opts?): Promise<TransactionResponse\
Prove and relay a cross chain message that was sent from L2 to L1. Only applicable for L2 to L1 messages.
Parameters
• message: MessageLike
Message to finalize.
• opts?
Additional options.
• opts.direction?: MessageDirection
• opts.overrides?: CallOverrides
Optional transaction overrides.
• opts.signer?: Signer
Optional signer to use to send the transaction.
Returns
Promise<TransactionResponse\
Transaction response for the finalization transaction.
Source
src/cross-chain-messenger.ts:1307
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.
• opts?
Additional options.
• opts.l2GasLimit?: NumberLike
Optional gas limit to use for the transaction on L2.
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.signer?: Signer
Optional signer to use to send the transaction.
Returns
Promise<TransactionResponse\
Transaction response for the message sending transaction.
Source
src/cross-chain-messenger.ts:1281
toCrossChainMessage()
toCrossChainMessage(message, opts?): 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.
• opts?
• opts.direction?: MessageDirection
Returns
Promise<CrossChainMessage\
Message coerced into a CrossChainMessage.
Source
src/cross-chain-messenger.ts:520
toLowLevelMessage()
toLowLevelMessage(message, opts?): Promise<LowLevelMessage\
Transforms a CrossChainMessenger message into its low-level representation inside the L2ToL1MessagePasser contract on L2.
Parameters
• message: MessageLike
Message to transform.
• opts?
• opts.direction?: MessageDirection
• opts.overrides?: PayableOverrides
Returns
Promise<LowLevelMessage\
Transformed message.
Source
src/cross-chain-messenger.ts:354
waitBatchFinalize()
waitBatchFinalize(transactionHash): Promise<void\
Parameters
• transactionHash: string
Returns
Promise<void\
Source
src/cross-chain-messenger.ts:629
waitForMessageReceipt()
waitForMessageReceipt(message, opts): 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= {}
Options to pass to the waiting function.
• opts.confirmations?: number
Number of transaction confirmations to wait for before returning.
• opts.pollIntervalMs?: number
Number of milliseconds to wait between polling for the receipt.
• opts.timeoutMs?: number
Milliseconds to wait before timing out.
Returns
Promise<MessageReceipt\
CrossChainMessage receipt including receipt of the transaction that relayed the given message.
Source
src/cross-chain-messenger.ts:866
waitForMessageStatus()
waitForMessageStatus(message, status, opts): 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= {}
Options to pass to the waiting function.
• opts.direction?: MessageDirection
• opts.pollIntervalMs?: number
Number of milliseconds to wait when polling.
• opts.timeoutMs?: number
Milliseconds to wait before timing out.
Returns
Promise<void\
Source
src/cross-chain-messenger.ts:904
waitRollupSuccess()
waitRollupSuccess(transactionHash): Promise<void\
Parameters
• transactionHash: string
Returns
Promise<void\
Source
src/cross-chain-messenger.ts:581
waitSyncSuccess()
waitSyncSuccess(transactionHash): Promise<void\
Parameters
• transactionHash: string
Returns
Promise<void\
Source
src/cross-chain-messenger.ts:605
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.
• opts?
Additional options.
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L1. Defaults to sender.
• opts.signer?: Signer
Optional signer to use to send the transaction.
Returns
Promise<TransactionResponse\
Transaction response for the withdraw transaction.
Source
src/cross-chain-messenger.ts:1472
withdrawETH()
withdrawETH(amount, opts?): Promise<TransactionResponse\
Withdraws some ETH back to the L1 chain.
Parameters
• amount: NumberLike
Amount of ETH to withdraw.
• opts?
Additional options.
• opts.overrides?: Overrides
Optional transaction overrides.
• opts.recipient?: AddressLike
Optional address to receive the funds on L1. Defaults to sender.
• opts.signer?: Signer
Optional signer to use to send the transaction.
Returns
Promise<TransactionResponse\
Transaction response for the withdraw transaction.
Source
src/cross-chain-messenger.ts:1360