ParentTransaction
Classes
ParentContractCallTransactionReceipt
A ParentTransactionReceipt with additional functionality that only exists if the transaction created a single call to a child chain contract - this includes token deposits.
Extends
ParentTransactionReceipt
Methods
getEthDeposits()
getEthDeposits(childProvider: Provider): Promise<EthDepositMessage[]>
Get any eth deposit messages created by this transaction
Parameters
Parameter | Type |
---|---|
childProvider | Provider |
Returns
Promise
<EthDepositMessage
[]>
Inherited from
ParentTransactionReceipt.getEthDeposits
Source
message/ParentTransaction.ts:191
getInboxMessageDeliveredEvents()
getInboxMessageDeliveredEvents(): object[]
Get any InboxMessageDelivered events that were emitted during this transaction
Returns
object
[]
Inherited from
ParentTransactionReceipt.getInboxMessageDeliveredEvents
Source
message/ParentTransaction.ts:134
getMessageDeliveredEvents()
getMessageDeliveredEvents(): object[]
Get any MessageDelivered events that were emitted during this transaction
Returns
object
[]
Inherited from
ParentTransactionReceipt.getMessageDeliveredEvents
Source
message/ParentTransaction.ts:126
getMessageEvents()
getMessageEvents(): object[]
Get combined data for any InboxMessageDelivered and MessageDelivered events emitted during this transaction
Returns
object
[]
Inherited from
ParentTransactionReceipt.getMessageEvents
Source
message/ParentTransaction.ts:147
getParentToChildMessages()
getParentToChildMessages<T>(childSignerOrProvider: T): Promise<ParentToChildMessageReaderOrWriter<T>[]>
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
Source
message/ParentTransaction.ts:248
getParentToChildMessagesClassic()
getParentToChildMessagesClassic(childProvider: Provider): Promise<ParentToChildMessageReaderClassic[]>
Get classic parent-to-child messages created by this transaction
Parameters
Parameter | Type | Description |
---|---|---|
childProvider | Provider |
Returns
Promise
<ParentToChildMessageReaderClassic
[]>
Inherited from
ParentTransactionReceipt.getParentToChildMessagesClassic
Source
message/ParentTransaction.ts:216
getTokenDepositEvents()
getTokenDepositEvents(): object[]
Get any token deposit events created by this transaction
Returns
object
[]
Inherited from
ParentTransactionReceipt.getTokenDepositEvents
Source
message/ParentTransaction.ts:298
isClassic()
isClassic<T>(childSignerOrProvider: T): Promise<boolean>
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
Source
message/ParentTransaction.ts:106
waitForChildTransactionReceipt()
waitForChildTransactionReceipt<T>(
childSignerOrProvider: T,
confirmations?: number,
timeout?: number): Promise<object & ParentToChildMessageWaitForStatusResult>
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.
Source
message/ParentTransaction.ts:407
monkeyPatchContractCallWait()
static monkeyPatchContractCallWait(contractTransaction: ContractTransaction): ParentContractCallTransaction
Replaces the wait function with one that returns a ParentContractCallTransactionReceipt
Parameters
Parameter | Type | Description |
---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentContractCallTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchContractCallWait
Source
message/ParentTransaction.ts:343
monkeyPatchEthDepositWait()
static monkeyPatchEthDepositWait(contractTransaction: ContractTransaction): ParentEthDepositTransaction
Replaces the wait function with one that returns a ParentEthDepositTransactionReceipt
Parameters
Parameter | Type | Description |
---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentEthDepositTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchEthDepositWait
Source
message/ParentTransaction.ts:327
monkeyPatchWait()
static monkeyPatchWait(contractTransaction: ContractTransaction): ParentContractTransaction<ParentTransactionReceipt>
Replaces the wait function with one that returns a ParentTransactionReceipt
Parameters
Parameter | Type | Description |
---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentContractTransaction
<ParentTransactionReceipt
>
Inherited from
ParentTransactionReceipt.monkeyPatchWait
Source
message/ParentTransaction.ts:311
ParentEthDepositTransactionReceipt
A ParentTransactionReceipt with additional functionality that only exists if the transaction created a single eth deposit.
Extends
ParentTransactionReceipt
Methods
getEthDeposits()
getEthDeposits(childProvider: Provider): Promise<EthDepositMessage[]>
Get any eth deposit messages created by this transaction
Parameters
Parameter | Type |
---|---|
childProvider | Provider |
Returns
Promise
<EthDepositMessage
[]>
Inherited from
ParentTransactionReceipt.getEthDeposits
Source
message/ParentTransaction.ts:191
getInboxMessageDeliveredEvents()
getInboxMessageDeliveredEvents(): object[]
Get any InboxMessageDelivered events that were emitted during this transaction
Returns
object
[]
Inherited from
ParentTransactionReceipt.getInboxMessageDeliveredEvents
Source
message/ParentTransaction.ts:134
getMessageDeliveredEvents()
getMessageDeliveredEvents(): object[]
Get any MessageDelivered events that were emitted during this transaction
Returns
object
[]
Inherited from
ParentTransactionReceipt.getMessageDeliveredEvents
Source
message/ParentTransaction.ts:126
getMessageEvents()
getMessageEvents(): object[]
Get combined data for any InboxMessageDelivered and MessageDelivered events emitted during this transaction
Returns
object
[]
Inherited from
ParentTransactionReceipt.getMessageEvents
Source
message/ParentTransaction.ts:147
getParentToChildMessages()
getParentToChildMessages<T>(childSignerOrProvider: T): Promise<ParentToChildMessageReaderOrWriter<T>[]>
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
Source
message/ParentTransaction.ts:248
getParentToChildMessagesClassic()
getParentToChildMessagesClassic(childProvider: Provider): Promise<ParentToChildMessageReaderClassic[]>
Get classic parent-to-child messages created by this transaction
Parameters
Parameter | Type | Description |
---|---|---|
childProvider | Provider |
Returns
Promise
<ParentToChildMessageReaderClassic
[]>
Inherited from
ParentTransactionReceipt.getParentToChildMessagesClassic
Source
message/ParentTransaction.ts:216
getTokenDepositEvents()
getTokenDepositEvents(): object[]
Get any token deposit events created by this transaction
Returns
object
[]
Inherited from
ParentTransactionReceipt.getTokenDepositEvents
Source
message/ParentTransaction.ts:298
isClassic()
isClassic<T>(childSignerOrProvider: T): Promise<boolean>
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
Source
message/ParentTransaction.ts:106
waitForChildTransactionReceipt()
waitForChildTransactionReceipt(
childProvider: Provider,
confirmations?: number,
timeout?: number): Promise<object & EthDepositMessageWaitForStatusResult>
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.
Source
message/ParentTransaction.ts:369
monkeyPatchContractCallWait()
static monkeyPatchContractCallWait(contractTransaction: ContractTransaction): ParentContractCallTransaction
Replaces the wait function with one that returns a ParentContractCallTransactionReceipt
Parameters
Parameter | Type | Description |
---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentContractCallTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchContractCallWait
Source
message/ParentTransaction.ts:343
monkeyPatchEthDepositWait()
static monkeyPatchEthDepositWait(contractTransaction: ContractTransaction): ParentEthDepositTransaction
Replaces the wait function with one that returns a ParentEthDepositTransactionReceipt
Parameters
Parameter | Type | Description |
---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentEthDepositTransaction
Inherited from
ParentTransactionReceipt.monkeyPatchEthDepositWait
Source
message/ParentTransaction.ts:327
monkeyPatchWait()
static monkeyPatchWait(contractTransaction: ContractTransaction): ParentContractTransaction<ParentTransactionReceipt>
Replaces the wait function with one that returns a ParentTransactionReceipt
Parameters
Parameter | Type | Description |
---|---|---|
contractTransaction | ContractTransaction |
Returns
ParentContractTransaction
<ParentTransactionReceipt
>
Inherited from
ParentTransactionReceipt.monkeyPatchWait