Module: message/ParentTransaction

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): Promise< EthDepositMessage[] >

Get any eth deposit messages created by this transaction

Parameters

Parameter	Type
childProvider	Provider

Returns

Promise< EthDepositMessage[] >

Inherited from

ParentTransactionReceipt.getEthDeposits

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:191

---

getInboxMessageDeliveredEvents()

getInboxMessageDeliveredEvents(): {data: string; messageNum: BigNumber;}[]

Get any InboxMessageDelivered events that were emitted during this transaction

Returns

{data: string; messageNum: BigNumber;}[]

Inherited from

ParentTransactionReceipt.getInboxMessageDeliveredEvents

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:134

---

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

ParentTransactionReceipt.getMessageDeliveredEvents

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:126

---

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

ParentTransactionReceipt.getMessageEvents

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:147

---

getParentToChildMessages()

getParentToChildMessages&lt;T&gt;(childSignerOrProvider): Promise< ParentToChildMessageReaderOrWriter< T >[] >

Get any parent-to-child messages created by this transaction

Type parameters

Parameter
T extends SignerOrProvider

Parameters

Parameter	Type	Description
childSignerOrProvider	T

Returns

Promise< ParentToChildMessageReaderOrWriter< T >[] >

Inherited from

ParentTransactionReceipt.getParentToChildMessages

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:248

---

getParentToChildMessagesClassic()

getParentToChildMessagesClassic(childProvider): 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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:216

---

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

ParentTransactionReceipt.getTokenDepositEvents

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:298

---

isClassic()

isClassic&lt;T&gt;(childSignerOrProvider): Promise< boolean >

Check if is a classic transaction

Type parameters

Parameter
T extends SignerOrProvider

Parameters

Parameter	Type	Description
childSignerOrProvider	T

Returns

Promise< boolean >

Inherited from

ParentTransactionReceipt.isClassic

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:106

---

waitForChildTx()

waitForChildTx<T>(
  childSignerOrProvider,
  confirmations?,
  timeout?): Promise< Object >

Wait for the transaction to arrive and be executed on the child chain

Type parameters

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 >

The wait result contains complete, a status, a ParentToChildMessage and optionally the childChainTxReceipt. 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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:407

---

monkeyPatchContractCallWait()

static monkeyPatchContractCallWait(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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:343

---

monkeyPatchEthDepositWait()

static monkeyPatchEthDepositWait(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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:327

---

monkeyPatchWait()

static monkeyPatchWait(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

arbitrum-sdk/src/lib/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): Promise< EthDepositMessage[] >

Get any eth deposit messages created by this transaction

Parameters

Parameter	Type
childProvider	Provider

Returns

Promise< EthDepositMessage[] >

Inherited from

ParentTransactionReceipt.getEthDeposits

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:191

---

getInboxMessageDeliveredEvents()

getInboxMessageDeliveredEvents(): {data: string; messageNum: BigNumber;}[]

Get any InboxMessageDelivered events that were emitted during this transaction

Returns

{data: string; messageNum: BigNumber;}[]

Inherited from

ParentTransactionReceipt.getInboxMessageDeliveredEvents

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:134

---

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

ParentTransactionReceipt.getMessageDeliveredEvents

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:126

---

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

ParentTransactionReceipt.getMessageEvents

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:147

---

getParentToChildMessages()

getParentToChildMessages&lt;T&gt;(childSignerOrProvider): Promise< ParentToChildMessageReaderOrWriter< T >[] >

Get any parent-to-child messages created by this transaction

Type parameters

Parameter
T extends SignerOrProvider

Parameters

Parameter	Type	Description
childSignerOrProvider	T

Returns

Promise< ParentToChildMessageReaderOrWriter< T >[] >

Inherited from

ParentTransactionReceipt.getParentToChildMessages

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:248

---

getParentToChildMessagesClassic()

getParentToChildMessagesClassic(childProvider): 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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:216

---

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

ParentTransactionReceipt.getTokenDepositEvents

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:298

---

isClassic()

isClassic&lt;T&gt;(childSignerOrProvider): Promise< boolean >

Check if is a classic transaction

Type parameters

Parameter
T extends SignerOrProvider

Parameters

Parameter	Type	Description
childSignerOrProvider	T

Returns

Promise< boolean >

Inherited from

ParentTransactionReceipt.isClassic

Source

arbitrum-sdk/src/lib/message/ParentTransaction.ts:106

---

waitForChildTx()

waitForChildTx(
  childProvider,
  confirmations?,
  timeout?): Promise< {complete: boolean; message: EthDepositMessage;} & 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< {complete: boolean; message: EthDepositMessage;} & EthDepositMessageWaitForStatusResult >

The wait result contains complete, a status, the ParentToChildMessage and optionally the childChainTxReceipt 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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:369

---

monkeyPatchContractCallWait()

static monkeyPatchContractCallWait(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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:343

---

monkeyPatchEthDepositWait()

static monkeyPatchEthDepositWait(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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:327

---

monkeyPatchWait()

static monkeyPatchWait(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

arbitrum-sdk/src/lib/message/ParentTransaction.ts:311