Module: inbox/inbox

InboxTools

Tools for interacting with the inbox and bridge contracts

Methods

estimateArbitrumGas()

private estimateArbitrumGas(transactionl2Request, l2Provider): Promise< GasComponentsWithL2Part >

We should use nodeInterface to get the gas estimate is because we are making a delayed inbox message which doesn't need l1 calldata gas fee part.

Parameters

Parameter	Type
transactionl2Request	RequiredTransactionRequestType
l2Provider	Provider

Returns

Promise\< GasComponentsWithL2Part >

Source

arbitrum-sdk/src/lib/inbox/inbox.ts:120

---

findFirstBlockBelow()

private findFirstBlockBelow(blockNumber, blockTimestamp): Promise< Block >

Find the first (or close to first) block whose number is below the provided number, and whose timestamp is below the provided timestamp

Parameters

Parameter	Type	Description
blockNumber	number
blockTimestamp	number

Returns

Promise\< Block >

Source

arbitrum-sdk/src/lib/inbox/inbox.ts:83

---

forceInclude()

forceInclude&lt;T&gt;(messageDeliveredEvent?, overrides?): Promise< T extends ForceInclusionParams ? ContractTransaction : null | ContractTransaction >

Force includes all eligible messages in the delayed inbox. The inbox contract doesnt allow a message to be force-included until after a delay period has been completed.

Type parameters

Parameter
T extends undefined | ForceInclusionParams

Parameters

Parameter	Type	Description
messageDeliveredEvent?	T	Provide this to include all messages up to this one. Responsibility is on the caller to check the eligibility of this event.
overrides?	Overrides	-

Returns

Promise\< T extends ForceInclusionParams ? ContractTransaction : null | ContractTransaction >

The force include transaction, or null if no eligible message were found for inclusion

Source

arbitrum-sdk/src/lib/inbox/inbox.ts:304

---

getEventsAndIncreaseRange()

private getEventsAndIncreaseRange(
  bridge,
  searchRangeBlocks,
  maxSearchRangeBlocks,
  rangeMultiplier): Promise< FetchedEvent< MessageDeliveredEvent >[] >

Look for force includable events in the search range blocks, if no events are found the search range is increased incrementally up to the max search range blocks.

Parameters

Parameter	Type	Description
bridge	Bridge
searchRangeBlocks	number
maxSearchRangeBlocks	number
rangeMultiplier	number	-

Returns

Promise\< FetchedEvent\< MessageDeliveredEvent >[] >

Source

arbitrum-sdk/src/lib/inbox/inbox.ts:204

---

getForceIncludableBlockRange()

private getForceIncludableBlockRange(blockNumberRangeSize): Promise< {endBlock: number; startBlock: number;} >

Get a range of blocks within messages eligible for force inclusion emitted events

Parameters

Parameter	Type	Description
blockNumberRangeSize	number

Returns

Promise\< {endBlock: number; startBlock: number;} >

Source

arbitrum-sdk/src/lib/inbox/inbox.ts:150

---

getForceIncludableEvent()

getForceIncludableEvent(
  maxSearchRangeBlocks = ...,
  startSearchRangeBlocks = 100,
  rangeMultipler = 2): Promise< null | ForceInclusionParams >

Find the event of the latest message that can be force include

Parameters

Parameter	Type	Default value	Description
maxSearchRangeBlocks	number	undefined	The max range of blocks to search in. Defaults to 3 * 6545 ( = ~3 days) prior to the first eligble block
startSearchRangeBlocks	number	100	The start range of block to search in. Moves incrementally up to the maxSearchRangeBlocks. Defaults to 100;
rangeMultipler	number	2	-

Returns

Promise\< null | ForceInclusionParams >

Null if non can be found.

Source

arbitrum-sdk/src/lib/inbox/inbox.ts:255

---

sendL2SignedTx()

sendL2SignedTx(signedTx): Promise< null | ContractTransaction >

Send l2 signed tx using delayed inox, which won't alias the sender's adddress It will be automatically included by the sequencer on l2, if it isn't included within 24 hours, you can force include it

Parameters

Parameter	Type	Description
signedTx	string	A signed transaction which can be sent directly to network, you can call inboxTools.signL2Message to get.

Returns

Promise\< null | ContractTransaction >

The l1 delayed inbox's transaction itself.

Source

arbitrum-sdk/src/lib/inbox/inbox.ts:349

---

signL2Tx()

signL2Tx(txRequest, l2Signer): Promise< string >

Sign a transaction with msg.to, msg.value and msg.data. You can use this as a helper to call inboxTools.sendL2SignedMessage above.

Parameters

Parameter	Type	Description
txRequest	RequiredTransactionRequestType	-
l2Signer	Signer	ethers Signer type, used to sign l2 transaction

Returns

Promise\< string >

The l1 delayed inbox's transaction signed data.

Source

arbitrum-sdk/src/lib/inbox/inbox.ts:377