Module: message/L2ToL1MessageClassic
L2ToL1MessageReaderClassic
Provides read-only access for classic l2-to-l1-messages
Extends
L2ToL1MessageClassic
Properties
| Property | Type | Description |
|---|---|---|
readonly batchNumber | BigNumber | The number of the batch this message is part of |
readonly indexInBatch | BigNumber | The index of this message in the batch |
protected outboxAddress | null | string | Contains the classic outbox address, or set to zero address if this network did not have a classic outbox deployed |
Methods
getFirstExecutableBlock()
getFirstExecutableBlock(l2Provider): Promise< null | BigNumber >
Estimates the L1 block number in which this L2 to L1 tx will be available for execution
Parameters
| Parameter | Type | Description |
|---|---|---|
l2Provider | Provider |
Returns
Promise\< null | BigNumber >
Always returns null for classic l2toL1 messages since they can be executed in any block now.
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:374
getOutboxAddress()
protected getOutboxAddress(l2Provider, batchNumber): Promise< string >
Classic had 2 outboxes, we need to find the correct one for the provided batch number
Parameters
| Parameter | Type | Description |
|---|---|---|
l2Provider | Provider | |
batchNumber | number |
Returns
Promise\< string >
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:206
hasExecuted()
hasExecuted(l2Provider): Promise< boolean >
Check if given outbox message has already been executed
Parameters
| Parameter | Type |
|---|---|
l2Provider | Provider |
Returns
Promise\< boolean >
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:293
status()
status(l2Provider): Promise< L2ToL1MessageStatus >
Get the status of this message In order to check if the message has been executed proof info must be provided.
Parameters
| Parameter | Type |
|---|---|
l2Provider | Provider |
Returns
Promise\< L2ToL1MessageStatus >
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:331
tryGetProof()
tryGetProof(l2Provider): Promise< null | MessageBatchProofInfo >
Get the execution proof for this message. Returns null if the batch does not exist yet.
Parameters
| Parameter | Type | Description |
|---|---|---|
l2Provider | Provider |
Returns
Promise\< null | MessageBatchProofInfo >
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:277
waitUntilOutboxEntryCreated()
waitUntilOutboxEntryCreated(l2Provider, retryDelay = 500): Promise< CONFIRMED | EXECUTED >
Waits until the outbox entry has been created, and will not return until it has been. WARNING: Outbox entries are only created when the corresponding node is confirmed. Which can take 1 week+, so waiting here could be a very long operation.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
l2Provider | Provider | undefined | - |
retryDelay | number | 500 |
Returns
Promise\< CONFIRMED | EXECUTED >
outbox entry status (either executed or confirmed but not pending)
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:354
fromBatchNumber()
static fromBatchNumber<T>(
l1SignerOrProvider,
batchNumber,
indexInBatch,
l1Provider?): L2ToL1MessageReaderOrWriterClassic< T >
Instantiates a new L2ToL1MessageWriterClassic or L2ToL1MessageReaderClassic object.
Type parameters
| Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
l1SignerOrProvider | T | Signer or provider to be used for executing or reading the L2-to-L1 message. |
batchNumber | BigNumber | The number of the batch containing the L2-to-L1 message. |
indexInBatch | BigNumber | The index of the L2-to-L1 message within the batch. |
l1Provider? | Provider | Optional. Used to override the Provider which is attached to l1SignerOrProvider in case you need more control. This will be a required parameter in a future major version update. |
Returns
L2ToL1MessageReaderOrWriterClassic\< T >
Inherited from
L2ToL1MessageClassic.fromBatchNumber
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:125
L2ToL1MessageWriterClassic
Provides read and write access for classic l2-to-l1-messages
Extends
Constructors
constructor()
new L2ToL1MessageWriterClassic(
l1Signer,
batchNumber,
indexInBatch,
l1Provider?): L2ToL1MessageWriterClassic
Instantiates a new L2ToL1MessageWriterClassic object.
Parameters
| Parameter | Type | Description |
|---|---|---|
l1Signer | Signer | The signer to be used for executing the L2-to-L1 message. |
batchNumber | BigNumber | The number of the batch containing the L2-to-L1 message. |
indexInBatch | BigNumber | The index of the L2-to-L1 message within the batch. |
l1Provider? | Provider | Optional. Used to override the Provider which is attached to l1Signer in case you need more control. This will be a required parameter in a future major version update. |
Returns
Overrides
L2ToL1MessageReaderClassic.constructor
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:394
Properties
| Property | Type | Description |
|---|---|---|
readonly batchNumber | BigNumber | The number of the batch this message is part of |
readonly indexInBatch | BigNumber | The index of this message in the batch |
private readonly l1Signer | Signer | The signer to be used for executing the L2-to-L1 message. |
protected outboxAddress | null | string | Contains the classic outbox address, or set to zero address if this network did not have a classic outbox deployed |
Methods
execute()
execute(l2Provider, overrides?): Promise< ContractTransaction >
Executes the L2ToL1Message on L1. Will throw an error if the outbox entry has not been created, which happens when the corresponding assertion is confirmed.
Parameters
| Parameter | Type |
|---|---|
l2Provider | Provider |
overrides? | Overrides |
Returns
Promise\< ContractTransaction >
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:409
getFirstExecutableBlock()
getFirstExecutableBlock(l2Provider): Promise< null | BigNumber >
Estimates the L1 block number in which this L2 to L1 tx will be available for execution
Parameters
| Parameter | Type | Description |
|---|---|---|
l2Provider | Provider |
Returns
Promise\< null | BigNumber >
Always returns null for classic l2toL1 messages since they can be executed in any block now.
Inherited from
L2ToL1MessageReaderClassic.getFirstExecutableBlock
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:374
getOutboxAddress()
protected getOutboxAddress(l2Provider, batchNumber): Promise< string >
Classic had 2 outboxes, we need to find the correct one for the provided batch number
Parameters
| Parameter | Type | Description |
|---|---|---|
l2Provider | Provider | |
batchNumber | number |
Returns
Promise\< string >
Inherited from
L2ToL1MessageReaderClassic.getOutboxAddress
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:206
hasExecuted()
hasExecuted(l2Provider): Promise< boolean >
Check if given outbox message has already been executed
Parameters
| Parameter | Type |
|---|---|
l2Provider | Provider |
Returns
Promise\< boolean >
Inherited from
L2ToL1MessageReaderClassic.hasExecuted
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:293
status()
status(l2Provider): Promise< L2ToL1MessageStatus >
Get the status of this message In order to check if the message has been executed proof info must be provided.
Parameters
| Parameter | Type |
|---|---|
l2Provider | Provider |
Returns
Promise\< L2ToL1MessageStatus >
Inherited from
L2ToL1MessageReaderClassic.status
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:331
tryGetProof()
tryGetProof(l2Provider): Promise< null | MessageBatchProofInfo >
Get the execution proof for this message. Returns null if the batch does not exist yet.
Parameters
| Parameter | Type | Description |
|---|---|---|
l2Provider | Provider |
Returns
Promise\< null | MessageBatchProofInfo >
Inherited from
L2ToL1MessageReaderClassic.tryGetProof
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:277
waitUntilOutboxEntryCreated()
waitUntilOutboxEntryCreated(l2Provider, retryDelay = 500): Promise< CONFIRMED | EXECUTED >
Waits until the outbox entry has been created, and will not return until it has been. WARNING: Outbox entries are only created when the corresponding node is confirmed. Which can take 1 week+, so waiting here could be a very long operation.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
l2Provider | Provider | undefined | - |
retryDelay | number | 500 |
Returns
Promise\< CONFIRMED | EXECUTED >
outbox entry status (either executed or confirmed but not pending)
Inherited from
L2ToL1MessageReaderClassic.waitUntilOutboxEntryCreated
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:354
fromBatchNumber()
static fromBatchNumber<T>(
l1SignerOrProvider,
batchNumber,
indexInBatch,
l1Provider?): L2ToL1MessageReaderOrWriterClassic< T >
Instantiates a new L2ToL1MessageWriterClassic or L2ToL1MessageReaderClassic object.
Type parameters
| Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
l1SignerOrProvider | T | Signer or provider to be used for executing or reading the L2-to-L1 message. |
batchNumber | BigNumber | The number of the batch containing the L2-to-L1 message. |
indexInBatch | BigNumber | The index of the L2-to-L1 message within the batch. |
l1Provider? | Provider | Optional. Used to override the Provider which is attached to l1SignerOrProvider in case you need more control. This will be a required parameter in a future major version update. |
Returns
L2ToL1MessageReaderOrWriterClassic\< T >
Inherited from
L2ToL1MessageReaderClassic.fromBatchNumber
Source
arbitrum-sdk/src/lib/message/L2ToL1MessageClassic.ts:125
L2ToL1MessageReaderOrWriterClassic
L2ToL1MessageReaderOrWriterClassic: <T> T extends Provider ? L2ToL1MessageReaderClassic : L2ToL1MessageWriterClassic
Conditional type for Signer or Provider. If T is of type Provider then L2ToL1MessageReaderOrWriter\<T> will be of type L2ToL1MessageReader. If T is of type Signer then L2ToL1MessageReaderOrWriter\<T> will be of type L2ToL1MessageWriter.
Type parameters
| Parameter |
|---|
T extends SignerOrProvider |