Module: message/ChildTransaction
ChildTransactionReceipt
Extension of ethers-js TransactionReceipt, adding Arbitrum-specific functionality
Implements
TransactionReceipt
Methods
getBatchConfirmations()
getBatchConfirmations(childProvider): Promise< BigNumber >
Get number of parent chain confirmations that the batch including this tx has
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | JsonRpcProvider |
Returns
Promise< BigNumber >
number of confirmations of batch including tx, or 0 if no batch included this tx
Source
arbitrum-sdk/src/lib/message/ChildTransaction.ts:138
getBatchNumber()
getBatchNumber(childProvider): Promise< BigNumber >
Get the number of the batch that included this tx (will throw if no such batch exists)
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | JsonRpcProvider |
Returns
Promise< BigNumber >
number of batch in which tx was included, or errors if no batch includes the current tx
Source
arbitrum-sdk/src/lib/message/ChildTransaction.ts:151
getChildToParentEvents()
getChildToParentEvents(): ChildToParentTransactionEvent[]
Get ChildToParentTransactionEvent events created by this transaction
Returns
ChildToParentTransactionEvent[]
Source
arbitrum-sdk/src/lib/message/ChildTransaction.ts:97
getChildToParentMessages()
getChildToParentMessages<T>(parentSignerOrProvider): Promise< ChildToParentMessageReaderOrWriter< T >[] >
Get any child-to-parent-messages created by this transaction
Type parameters
| Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type |
|---|---|
parentSignerOrProvider | T |
Returns
Promise< ChildToParentMessageReaderOrWriter< T >[] >
Source
arbitrum-sdk/src/lib/message/ChildTransaction.ts:119
getRedeemScheduledEvents()
getRedeemScheduledEvents(): {donatedGas: BigNumber; gasDonor: string; maxRefund: BigNumber; retryTxHash: string; sequenceNum: BigNumber; submissionFeeRefund: BigNumber; ticketId: string;}[]
Get event data for any redeems that were scheduled in this transaction
Returns
{donatedGas: BigNumber; gasDonor: string; maxRefund: BigNumber; retryTxHash: string; sequenceNum: BigNumber; submissionFeeRefund: BigNumber; ticketId: string;}[]
Source
arbitrum-sdk/src/lib/message/ChildTransaction.ts:111
isDataAvailable()
isDataAvailable(childProvider, confirmations = 10): Promise< boolean >
Whether the data associated with this transaction has been made available on parent chain
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
childProvider | JsonRpcProvider | undefined | |
confirmations | number | 10 | The number of confirmations on the batch before data is to be considered available |
Returns
Promise< boolean >
Source
arbitrum-sdk/src/lib/message/ChildTransaction.ts:173
monkeyPatchWait()
static monkeyPatchWait(contractTransaction): ChildContractTransaction
Replaces the wait function with one that returns an L2TransactionReceipt
Parameters
| Parameter | Type | Description |
|---|---|---|
contractTransaction | ContractTransaction |
Returns
ChildContractTransaction
Source
arbitrum-sdk/src/lib/message/ChildTransaction.ts:187
toRedeemTransaction()
static toRedeemTransaction(redeemTx, childProvider): RedeemTransaction
Adds a waitForRedeem function to a redeem transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
redeemTx | ChildContractTransaction | |
childProvider | Provider |
Returns
RedeemTransaction