ChildTransaction
Classes
ChildTransactionReceipt
Defined in: message/ChildTransaction.ts:54
Extension of ethers-js TransactionReceipt, adding Arbitrum-specific functionality
Implements
TransactionReceipt
Methods
getBatchConfirmations()
getBatchConfirmations(childProvider: JsonRpcProvider): Promise<BigNumber>;
Defined in: message/ChildTransaction.ts:138
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
getBatchNumber()
getBatchNumber(childProvider: JsonRpcProvider): Promise<BigNumber>;
Defined in: message/ChildTransaction.ts:151
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
getChildToParentEvents()
getChildToParentEvents(): ChildToParentTransactionEvent[];
Defined in: message/ChildTransaction.ts:97
Get ChildToParentTransactionEvent events created by this transaction
Returns
ChildToParentTransactionEvent[]
getChildToParentMessages()
getChildToParentMessages<T>(parentSignerOrProvider: T): Promise<ChildToParentMessageReaderOrWriter<T>[]>;
Defined in: message/ChildTransaction.ts:119
Get any child-to-parent-messages created by this transaction
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
parentSignerOrProvider | T |
Returns
Promise<ChildToParentMessageReaderOrWriter<T>[]>
getRedeemScheduledEvents()
getRedeemScheduledEvents(): object[];
Defined in: message/ChildTransaction.ts:111
Get event data for any redeems that were scheduled in this transaction
Returns
object[]
isDataAvailable()
isDataAvailable(childProvider: JsonRpcProvider, confirmations: number): Promise<boolean>;
Defined in: message/ChildTransaction.ts:173
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>
monkeyPatchWait()
static monkeyPatchWait(contractTransaction: ContractTransaction): ChildContractTransaction;
Defined in: message/ChildTransaction.ts:187
Replaces the wait function with one that returns an L2TransactionReceipt
Parameters
| Parameter | Type | Description |
|---|---|---|
contractTransaction | ContractTransaction |
Returns
ChildContractTransaction
toRedeemTransaction()
static toRedeemTransaction(redeemTx: ChildContractTransaction, childProvider: Provider): RedeemTransaction;
Defined in: message/ChildTransaction.ts:208
Adds a waitForRedeem function to a redeem transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
redeemTx | ChildContractTransaction | |
childProvider | Provider |
Returns
RedeemTransaction