Module: message/ParentToChildMessage

EthDepositMessage

A message for Eth deposits from ParentChain to Chain

Constructors

constructor()

new EthDepositMessage(
  chainProvider,
  chainChainId,
  messageNumber,
  from,
  to,
  value): EthDepositMessage

Parameters

Parameter	Type	Description
chainProvider	Provider
chainChainId	number
messageNumber	BigNumber
from	string	-
to	string	Recipient address of the ETH on Chain
value	BigNumber

Returns

EthDepositMessage

Source

arbitrum-sdk/src/lib/message/ParentToChildMessage.ts:852

Properties

Property	Type	Description
readonly chainChainId	number
private readonly chainProvider	Provider
readonly messageNumber	BigNumber
readonly to	string	Recipient address of the ETH on Chain
readonly value	BigNumber

Methods

fromEventComponents()

static fromEventComponents(
  chainProvider,
  messageNumber,
  senderAddr,
  inboxMessageEventData): Promise< EthDepositMessage >

Create an EthDepositMessage from data emitted in event when calling ethDeposit on Inbox.sol

Parameters

Parameter	Type	Description
chainProvider	Provider
messageNumber	BigNumber	The message number in the Inbox.InboxMessageDelivered event
senderAddr	string	The sender address from Bridge.MessageDelivered event
inboxMessageEventData	string	The data field from the Inbox.InboxMessageDelivered event

Returns

Promise< EthDepositMessage >

Source

arbitrum-sdk/src/lib/message/ParentToChildMessage.ts:823

---

parseEthDepositData()

static private parseEthDepositData(eventData): object

Parse the data field in event InboxMessageDelivered(uint256 indexed messageNum, bytes data);

Parameters

Parameter	Type	Description
eventData	string

Returns

destination and amount

Member	Type
to	string
value	BigNumber

Source

arbitrum-sdk/src/lib/message/ParentToChildMessage.ts:802

---

ParentToChildMessageReaderOrWriter

ParentToChildMessageReaderOrWriter: <T> T extends Provider ? ParentToChildMessageReader : ParentToChildMessageWriter

Conditional type for Signer or Provider. If T is of type Provider then ParentToChildMessageReaderOrWriter<T> will be of type ParentToChildMessageReader. If T is of type Signer then ParentToChildMessageReaderOrWriter<T> will be of type ParentToChildMessageWriter.

Type parameters

Parameter
T extends SignerOrProvider

Source

arbitrum-sdk/src/lib/message/ParentToChildMessage.ts:98

---

ParentToChildMessageWaitForStatusResult

ParentToChildMessageWaitForStatusResult: {status: ParentToChildMessageStatus.REDEEMED; txReceipt: TransactionReceipt;} | {status: Exclude< ParentToChildMessageStatus, ParentToChildMessageStatus.REDEEMED >;}

If the status is redeemed an chainTxReceipt is populated. For all other statuses chainTxReceipt is not populated

Source

arbitrum-sdk/src/lib/message/ParentToChildMessage.ts:240