ParentTransaction
Classes
ParentContractCallTransactionReceipt
Defined in: message/ParentTransaction.ts:397
A ParentTransactionReceipt with additional functionality that only exists if the transaction created a single call to a child chain contract - this includes token deposits.
Methods
getEthDeposits()
getEthDeposits(childProvider: Provider): Promise<EthDepositMessage[]>;
Defined in: message/ParentTransaction.ts:191
Get any eth deposit messages created by this transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | Provider |
Returns
Promise<EthDepositMessage[]>
Inherited from
ParentTransactionReceipt.getEthDeposits;
getInboxMessageDeliveredEvents()
getInboxMessageDeliveredEvents(): unknown[];
Defined in: message/ParentTransaction.ts:134
Get any InboxMessageDelivered events that were emitted during this transaction
Returns
unknown[]
Inherited from
ParentTransactionReceipt.getInboxMessageDeliveredEvents;
getMessageDeliveredEvents()
getMessageDeliveredEvents(): unknown[];
Defined in: message/ParentTransaction.ts:126
Get any MessageDelivered events that were emitted during this transaction
Returns
unknown[]
Inherited from
ParentTransactionReceipt.getMessageDeliveredEvents;
getMessageEvents()
getMessageEvents(): object[];
Defined in: message/ParentTransaction.ts:147
Get combined data for any InboxMessageDelivered and MessageDelivered events emitted during this transaction
Returns
object[]
Inherited from
ParentTransactionReceipt.getMessageEvents;
getParentToChildMessages()
getParentToChildMessages<T>(childSignerOrProvider: T): Promise<ParentToChildMessageReaderOrWriter<T>[]>;
Defined in: message/ParentTransaction.ts:248
Get any parent-to-child messages created by this transaction
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
childSignerOrProvider | T |
Returns
Promise<ParentToChildMessageReaderOrWriter<T>[]>
Inherited from
ParentTransactionReceipt.getParentToChildMessages;
getParentToChildMessagesClassic()
getParentToChildMessagesClassic(childProvider: Provider): Promise<ParentToChildMessageReaderClassic[]>;
Defined in: message/ParentTransaction.ts:216
Get classic parent-to-child messages created by this transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | Provider |
Returns
Promise<ParentToChildMessageReaderClassic[]>
Inherited from
ParentTransactionReceipt.getParentToChildMessagesClassic;
getTokenDepositEvents()
getTokenDepositEvents(): unknown[];
Defined in: message/ParentTransaction.ts:298
Get any token deposit events created by this transaction
Returns
unknown[]
Inherited from
ParentTransactionReceipt.getTokenDepositEvents;
isClassic()
isClassic<T>(childSignerOrProvider: T): Promise<boolean>;
Defined in: message/ParentTransaction.ts:106
Check if is a classic transaction
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
childSignerOrProvider | T |
Returns
Promise<boolean>
Inherited from
ParentTransactionReceipt.isClassic;
waitForChildTransactionReceipt()
waitForChildTransactionReceipt<T>(
childSignerOrProvider: T,
confirmations?: number,
timeout?: number): Promise<object & ParentToChildMessageWaitForStatusResult>;
Defined in: message/ParentTransaction.ts:407
Wait for the transaction to arrive and be executed on the child chain
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
childSignerOrProvider | T | - |
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 the child chain. Throws on timeout. |
Returns
Promise<object & ParentToChildMessageWaitForStatusResult>
The wait result contains complete, a status, a ParentToChildMessage and optionally the childTxReceipt.
If complete is true then this message is in the terminal state.
For contract calls this is true only if the status is REDEEMED.
monkeyPatchContractCallWait()
static monkeyPatchContractCallWait(contractTransaction: ContractTransaction): ParentContractCallTransaction;
Defined in: message/ParentTransaction.ts:343
Replaces the wait function with one that returns a ParentContractCallTransactionReceipt
Parameters
| Parameter | Type | Description |
|---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentContractCallTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchContractCallWait;
monkeyPatchEthDepositWait()
static monkeyPatchEthDepositWait(contractTransaction: ContractTransaction): ParentEthDepositTransaction;
Defined in: message/ParentTransaction.ts:327
Replaces the wait function with one that returns a ParentEthDepositTransactionReceipt
Parameters
| Parameter | Type | Description |
|---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentEthDepositTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchEthDepositWait;
monkeyPatchWait()
static monkeyPatchWait(contractTransaction: ContractTransaction): ParentContractTransaction;
Defined in: message/ParentTransaction.ts:311
Replaces the wait function with one that returns a ParentTransactionReceipt
Parameters
| Parameter | Type | Description |
|---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentContractTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchWait;
ParentEthDepositTransactionReceipt
Defined in: message/ParentTransaction.ts:359
A ParentTransactionReceipt with additional functionality that only exists if the transaction created a single eth deposit.
Methods
getEthDeposits()
getEthDeposits(childProvider: Provider): Promise<EthDepositMessage[]>;
Defined in: message/ParentTransaction.ts:191
Get any eth deposit messages created by this transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | Provider |
Returns
Promise<EthDepositMessage[]>
Inherited from
ParentTransactionReceipt.getEthDeposits;
getInboxMessageDeliveredEvents()
getInboxMessageDeliveredEvents(): unknown[];
Defined in: message/ParentTransaction.ts:134
Get any InboxMessageDelivered events that were emitted during this transaction
Returns
unknown[]
Inherited from
ParentTransactionReceipt.getInboxMessageDeliveredEvents;
getMessageDeliveredEvents()
getMessageDeliveredEvents(): unknown[];
Defined in: message/ParentTransaction.ts:126
Get any MessageDelivered events that were emitted during this transaction
Returns
unknown[]
Inherited from
ParentTransactionReceipt.getMessageDeliveredEvents;
getMessageEvents()
getMessageEvents(): object[];
Defined in: message/ParentTransaction.ts:147
Get combined data for any InboxMessageDelivered and MessageDelivered events emitted during this transaction
Returns
object[]
Inherited from
ParentTransactionReceipt.getMessageEvents;
getParentToChildMessages()
getParentToChildMessages<T>(childSignerOrProvider: T): Promise<ParentToChildMessageReaderOrWriter<T>[]>;
Defined in: message/ParentTransaction.ts:248
Get any parent-to-child messages created by this transaction
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
childSignerOrProvider | T |
Returns
Promise<ParentToChildMessageReaderOrWriter<T>[]>
Inherited from
ParentTransactionReceipt.getParentToChildMessages;
getParentToChildMessagesClassic()
getParentToChildMessagesClassic(childProvider: Provider): Promise<ParentToChildMessageReaderClassic[]>;
Defined in: message/ParentTransaction.ts:216
Get classic parent-to-child messages created by this transaction
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | Provider |
Returns
Promise<ParentToChildMessageReaderClassic[]>
Inherited from
ParentTransactionReceipt.getParentToChildMessagesClassic;
getTokenDepositEvents()
getTokenDepositEvents(): unknown[];
Defined in: message/ParentTransaction.ts:298
Get any token deposit events created by this transaction
Returns
unknown[]
Inherited from
ParentTransactionReceipt.getTokenDepositEvents;
isClassic()
isClassic<T>(childSignerOrProvider: T): Promise<boolean>;
Defined in: message/ParentTransaction.ts:106
Check if is a classic transaction
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
childSignerOrProvider | T |
Returns
Promise<boolean>
Inherited from
ParentTransactionReceipt.isClassic;
waitForChildTransactionReceipt()
waitForChildTransactionReceipt(
childProvider: Provider,
confirmations?: number,
timeout?: number): Promise<object & EthDepositMessageWaitForStatusResult>;
Defined in: message/ParentTransaction.ts:369
Wait for the funds to arrive on the child chain
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | 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 the child chain. Throws on timeout. |
Returns
Promise<object & EthDepositMessageWaitForStatusResult>
The wait result contains complete, a status, the ParentToChildMessage and optionally the childTxReceipt
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.
monkeyPatchContractCallWait()
static monkeyPatchContractCallWait(contractTransaction: ContractTransaction): ParentContractCallTransaction;
Defined in: message/ParentTransaction.ts:343
Replaces the wait function with one that returns a ParentContractCallTransactionReceipt
Parameters
| Parameter | Type | Description |
|---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentContractCallTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchContractCallWait;
monkeyPatchEthDepositWait()
static monkeyPatchEthDepositWait(contractTransaction: ContractTransaction): ParentEthDepositTransaction;
Defined in: message/ParentTransaction.ts:327
Replaces the wait function with one that returns a ParentEthDepositTransactionReceipt
Parameters
| Parameter | Type | Description |
|---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentEthDepositTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchEthDepositWait;
monkeyPatchWait()
static monkeyPatchWait(contractTransaction: ContractTransaction): ParentContractTransaction;
Defined in: message/ParentTransaction.ts:311
Replaces the wait function with one that returns a ParentTransactionReceipt
Parameters
| Parameter | Type | Description |
|---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentContractTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchWait;