Skip to main content

inbox

Classes

InboxTools

Tools for interacting with the inbox and bridge contracts

Methods

estimateArbitrumGas()
private estimateArbitrumGas(transactionl2Request: RequiredTransactionRequestType, l2Provider: Provider): 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
ParameterType
transactionl2RequestRequiredTransactionRequestType
l2ProviderProvider
Returns

Promise<GasComponentsWithL2Part>

Source

inbox/inbox.ts:120

findFirstBlockBelow()
private findFirstBlockBelow(blockNumber: number, blockTimestamp: number): 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
ParameterTypeDescription
blockNumbernumber
blockTimestampnumber
Returns

Promise<Block>

Source

inbox/inbox.ts:83

forceInclude()
forceInclude<T>(messageDeliveredEvent?: T, overrides?: 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
Type parameter
T extends undefined | ForceInclusionParams
Parameters
ParameterTypeDescription
messageDeliveredEvent?TProvide 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

inbox/inbox.ts:304

getEventsAndIncreaseRange()
private getEventsAndIncreaseRange(
bridge: Bridge,
searchRangeBlocks: number,
maxSearchRangeBlocks: number,
rangeMultiplier: number): 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
ParameterTypeDescription
bridgeBridge
searchRangeBlocksnumber
maxSearchRangeBlocksnumber
rangeMultipliernumber-
Returns

Promise<FetchedEvent<MessageDeliveredEvent>[]>

Source

inbox/inbox.ts:204

getForceIncludableBlockRange()
private getForceIncludableBlockRange(blockNumberRangeSize: number): Promise<object>

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

Parameters
ParameterTypeDescription
blockNumberRangeSizenumber
Returns

Promise<object>

MemberTypeValue
endBlocknumberfirstEligibleBlock.number
startBlocknumber...
Source

inbox/inbox.ts:150

getForceIncludableEvent()
getForceIncludableEvent(
maxSearchRangeBlocks: number,
startSearchRangeBlocks: number,
rangeMultipler: number): Promise<null | ForceInclusionParams>

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

Parameters
ParameterTypeDefault valueDescription
maxSearchRangeBlocksnumberundefinedThe max range of blocks to search in.
Defaults to 3 * 6545 ( = ~3 days) prior to the first eligble block
startSearchRangeBlocksnumber100The start range of block to search in.
Moves incrementally up to the maxSearchRangeBlocks. Defaults to 100;
rangeMultiplernumber2-
Returns

Promise<null | ForceInclusionParams>

Null if non can be found.

Source

inbox/inbox.ts:255

sendL2SignedTx()
sendL2SignedTx(signedTx: string): 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
ParameterTypeDescription
signedTxstringA 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

inbox/inbox.ts:349

signL2Tx()
signL2Tx(txRequest: RequiredTransactionRequestType, l2Signer: Signer): 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
ParameterTypeDescription
txRequestRequiredTransactionRequestType-
l2SignerSignerethers Signer type, used to sign l2 transaction
Returns

Promise<string>

The l1 delayed inbox's transaction signed data.

Source

inbox/inbox.ts:377