Class: L1EthDepositTransactionReceipt
message/L1Transaction.L1EthDepositTransactionReceipt
An L1TransactionReceipt with additional functionality that only exists if the transaction created a single eth deposit.
Hierarchy
L1TransactionReceipt↳
L1EthDepositTransactionReceipt
Methods
getEthDeposits
getEthDeposits(l2Provider): Promise<EthDepositMessage[]>
Get any eth deposit messages created by this transaction
Parameters
| Name | Type |
|---|---|
l2Provider | Provider |
Returns
Promise<EthDepositMessage[]>
Inherited from
L1TransactionReceipt.getEthDeposits
Defined in
src/lib/message/L1Transaction.ts:182
getInboxMessageDeliveredEvents
getInboxMessageDeliveredEvents(): { data: string ; messageNum: BigNumber }[]
Get any InboxMessageDelivered events that were emitted during this transaction
Returns
{ data: string ; messageNum: BigNumber }[]
Inherited from
L1TransactionReceipt.getInboxMessageDeliveredEvents
Defined in
src/lib/message/L1Transaction.ts:125
getL1ToL2Messages
getL1ToL2Messages<T>(l2SignerOrProvider): Promise<L1ToL2MessageReaderOrWriter<T>[]>
Get any l1tol2 messages created by this transaction
Type parameters
| Name | Type |
|---|---|
T | extends SignerOrProvider |
Parameters
| Name | Type |
|---|---|
l2SignerOrProvider | T |
Returns
Promise<L1ToL2MessageReaderOrWriter<T>[]>
Inherited from
L1TransactionReceipt.getL1ToL2Messages
Defined in
src/lib/message/L1Transaction.ts:239
getL1ToL2MessagesClassic
getL1ToL2MessagesClassic(l2Provider): Promise<L1ToL2MessageReaderClassic[]>
Get classic l1tol2 messages created by this transaction
Parameters
| Name | Type |
|---|---|
l2Provider | Provider |
Returns
Promise<L1ToL2MessageReaderClassic[]>
Inherited from
L1TransactionReceipt.getL1ToL2MessagesClassic
Defined in
src/lib/message/L1Transaction.ts:207
getMessageDeliveredEvents
getMessageDeliveredEvents(): { baseFeeL1: BigNumber ; beforeInboxAcc: string ; inbox: string ; kind: number ; messageDataHash: string ; messageIndex: BigNumber ; sender: string ; timestamp: BigNumber }[]
Get any MessageDelivered events that were emitted during this transaction
Returns
{ baseFeeL1: BigNumber ; beforeInboxAcc: string ; inbox: string ; kind: number ; messageDataHash: string ; messageIndex: BigNumber ; sender: string ; timestamp: BigNumber }[]
Inherited from
L1TransactionReceipt.getMessageDeliveredEvents
Defined in
src/lib/message/L1Transaction.ts:117
getMessageEvents
getMessageEvents(): { bridgeMessageEvent: { baseFeeL1: BigNumber ; beforeInboxAcc: string ; inbox: string ; kind: number ; messageDataHash: string ; messageIndex: BigNumber ; sender: string ; timestamp: BigNumber } ; inboxMessageEvent: { data: string ; messageNum: BigNumber } }[]
Get combined data for any InboxMessageDelivered and MessageDelivered events emitted during this transaction
Returns
{ bridgeMessageEvent: { baseFeeL1: BigNumber ; beforeInboxAcc: string ; inbox: string ; kind: number ; messageDataHash: string ; messageIndex: BigNumber ; sender: string ; timestamp: BigNumber } ; inboxMessageEvent: { data: string ; messageNum: BigNumber } }[]
Inherited from
L1TransactionReceipt.getMessageEvents
Defined in
src/lib/message/L1Transaction.ts:138
getTokenDepositEvents
getTokenDepositEvents(): { _amount: BigNumber ; _from: string ; _sequenceNumber: BigNumber ; _to: string ; l1Token: string }[]
Get any token deposit events created by this transaction
Returns
{ _amount: BigNumber ; _from: string ; _sequenceNumber: BigNumber ; _to: string ; l1Token: string }[]
Inherited from
L1TransactionReceipt.getTokenDepositEvents
Defined in
src/lib/message/L1Transaction.ts:287
isClassic
isClassic<T>(l2SignerOrProvider): Promise<boolean>
Check if is a classic transaction
Type parameters
| Name | Type |
|---|---|
T | extends SignerOrProvider |
Parameters
| Name | Type |
|---|---|
l2SignerOrProvider | T |
Returns
Promise<boolean>
Inherited from
L1TransactionReceipt.isClassic
Defined in
src/lib/message/L1Transaction.ts:105
waitForL2
waitForL2(l2Provider, confirmations?, timeout?): Promise<{ complete: boolean ; message: EthDepositMessage } & EthDepositMessageWaitResult>
Wait for the funds to arrive on L2
Parameters
| Name | Type | Description |
|---|---|---|
l2Provider | Provider | - |
confirmations? | number | Amount of confirmations the retryable ticket and the auto redeem receipt should have |
timeout? | number | Amount of time to wait for the retryable ticket to be created Defaults to 15 minutes, as by this time all transactions are expected to be included on L2. Throws on timeout. |
Returns
Promise<{ complete: boolean ; message: EthDepositMessage } & EthDepositMessageWaitResult>
The wait result contains complete, a status, the L1ToL2Message and optionally the l2TxReceipt
If complete is true then this message is in the terminal state.
For eth deposits complete this is when the status is FUNDS_DEPOSITED, EXPIRED or REDEEMED.
Defined in
src/lib/message/L1Transaction.ts:358
monkeyPatchContractCallWait
Static monkeyPatchContractCallWait(contractTransaction): L1ContractCallTransaction
Replaces the wait function with one that returns an L1ContractCallTransactionReceipt
Parameters
| Name | Type |
|---|---|
contractTransaction | ContractTransaction |
Returns
L1ContractCallTransaction
Inherited from
L1TransactionReceipt.monkeyPatchContractCallWait
Defined in
src/lib/message/L1Transaction.ts:332
monkeyPatchEthDepositWait
Static monkeyPatchEthDepositWait(contractTransaction): L1EthDepositTransaction
Replaces the wait function with one that returns an L1EthDepositTransactionReceipt
Parameters
| Name | Type |
|---|---|
contractTransaction | ContractTransaction |
Returns
L1EthDepositTransaction
Inherited from
L1TransactionReceipt.monkeyPatchEthDepositWait
Defined in
src/lib/message/L1Transaction.ts:316
monkeyPatchWait
Static monkeyPatchWait(contractTransaction): L1ContractTransaction<L1TransactionReceipt>
Replaces the wait function with one that returns an L1TransactionReceipt
Parameters
| Name | Type |
|---|---|
contractTransaction | ContractTransaction |
Returns
L1ContractTransaction<L1TransactionReceipt>
Inherited from
L1TransactionReceipt.monkeyPatchWait