ChildToParentMessageNitro
Classes
ChildToParentMessageNitro
Defined in: message/ChildToParentMessageNitro.ts:136
Base functionality for nitro Child->Parent messages
Extended by
Methods
fromEvent()
static fromEvent<T>(
parentSignerOrProvider: T,
event: object,
parentProvider?: Provider): ChildToParentMessageReaderOrWriterNitro<T>;
Defined in: message/ChildToParentMessageNitro.ts:148
Instantiates a new ChildToParentMessageWriterNitro or ChildToParentMessageReaderNitro object.
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
parentSignerOrProvider | T | Signer or provider to be used for executing or reading the Child-to-Parent message. |
event | { arbBlockNum: BigNumber; caller: string; callvalue: BigNumber; data: string; destination: string; ethBlockNum: BigNumber; hash: BigNumber; position: BigNumber; timestamp: BigNumber; } | The event containing the data of the Child-to-Parent message. |
event.arbBlockNum | BigNumber | - |
event.caller? | string | - |
event.callvalue? | BigNumber | - |
event.data? | string | - |
event.destination? | string | - |
event.ethBlockNum? | BigNumber | - |
event.hash? | BigNumber | - |
event.position? | BigNumber | - |
event.timestamp? | BigNumber | - |
parentProvider? | Provider | Optional. Used to override the Provider which is attached to parentSignerOrProvider in case you need more control. This will be a required parameter in a future major version update. |
Returns
ChildToParentMessageReaderOrWriterNitro<T>
ChildToParentMessageReaderNitro
Defined in: message/ChildToParentMessageNitro.ts:190
Provides read-only access nitro for child-to-parent-messages
Extends
Extended by
Methods
getFirstExecutableBlock()
getFirstExecutableBlock(childProvider: Provider): Promise<BigNumber | null>;
Defined in: message/ChildToParentMessageNitro.ts:596
Estimates the L1 block number in which this L2 to L1 tx will be available for execution. If the message can or already has been executed, this returns null
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | Provider |
Returns
Promise<BigNumber | null>
expected parent chain block number where the child chain to parent chain message will be executable. Returns null if the message can be or already has been executed
hasExecuted()
protected hasExecuted(childProvider: Provider): Promise<boolean>;
Defined in: message/ChildToParentMessageNitro.ts:225
Check if this message has already been executed in the Outbox
Parameters
| Parameter | Type |
|---|---|
childProvider | Provider |
Returns
Promise<boolean>
status()
status(childProvider: Provider): Promise<ChildToParentMessageStatus>;
Defined in: message/ChildToParentMessageNitro.ts:240
Get the status of this message In order to check if the message has been executed proof info must be provided.
Parameters
| Parameter | Type |
|---|---|
childProvider | Provider |
Returns
Promise<ChildToParentMessageStatus>
waitUntilReadyToExecute()
waitUntilReadyToExecute(childProvider: Provider, retryDelay: number): Promise<CONFIRMED | EXECUTED>;
Defined in: message/ChildToParentMessageNitro.ts:507
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 |
|---|---|---|---|
childProvider | Provider | undefined | - |
retryDelay | number | 500 |
Returns
Promise<CONFIRMED | EXECUTED>
outbox entry status (either executed or confirmed but not pending)
fromEvent()
static fromEvent<T>(
parentSignerOrProvider: T,
event: object,
parentProvider?: Provider): ChildToParentMessageReaderOrWriterNitro<T>;
Defined in: message/ChildToParentMessageNitro.ts:148
Instantiates a new ChildToParentMessageWriterNitro or ChildToParentMessageReaderNitro object.
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
parentSignerOrProvider | T | Signer or provider to be used for executing or reading the Child-to-Parent message. |
event | { arbBlockNum: BigNumber; caller: string; callvalue: BigNumber; data: string; destination: string; ethBlockNum: BigNumber; hash: BigNumber; position: BigNumber; timestamp: BigNumber; } | The event containing the data of the Child-to-Parent message. |
event.arbBlockNum | BigNumber | - |
event.caller? | string | - |
event.callvalue? | BigNumber | - |
event.data? | string | - |
event.destination? | string | - |
event.ethBlockNum? | BigNumber | - |
event.hash? | BigNumber | - |
event.position? | BigNumber | - |
event.timestamp? | BigNumber | - |
parentProvider? | Provider | Optional. Used to override the Provider which is attached to parentSignerOrProvider in case you need more control. This will be a required parameter in a future major version update. |
Returns
ChildToParentMessageReaderOrWriterNitro<T>
Inherited from
ChildToParentMessageNitro.fromEvent
ChildToParentMessageWriterNitro
Defined in: message/ChildToParentMessageNitro.ts:716
Provides read and write access for nitro child-to-Parent-messages
Extends
Constructors
Constructor
new ChildToParentMessageWriterNitro(
parentSigner: Signer,
event: object,
parentProvider?: Provider): ChildToParentMessageWriterNitro;
Defined in: message/ChildToParentMessageNitro.ts:724
Instantiates a new ChildToParentMessageWriterNitro object.
Parameters
| Parameter | Type | Description |
|---|---|---|
parentSigner | Signer | The signer to be used for executing the Child-to-Parent message. |
event | { arbBlockNum: BigNumber; caller: string; callvalue: BigNumber; data: string; destination: string; ethBlockNum: BigNumber; hash: BigNumber; position: BigNumber; timestamp: BigNumber; } | The event containing the data of the Child-to-Parent message. |
event.arbBlockNum | BigNumber | - |
event.caller? | string | - |
event.callvalue? | BigNumber | - |
event.data? | string | - |
event.destination? | string | - |
event.ethBlockNum? | BigNumber | - |
event.hash? | BigNumber | - |
event.position? | BigNumber | - |
event.timestamp? | BigNumber | - |
parentProvider? | Provider | Optional. Used to override the Provider which is attached to parentSigner in case you need more control. This will be a required parameter in a future major version update. |
Returns
ChildToParentMessageWriterNitro
Overrides
ChildToParentMessageReaderNitro.constructor
Methods
execute()
execute(childProvider: Provider, overrides?: Overrides): Promise<ContractTransaction>;
Defined in: message/ChildToParentMessageNitro.ts:738
Executes the ChildToParentMessage on Parent Chain. Will throw an error if the outbox entry has not been created, which happens when the corresponding assertion is confirmed.
Parameters
| Parameter | Type |
|---|---|
childProvider | Provider |
overrides? | Overrides |
Returns
Promise<ContractTransaction>
getFirstExecutableBlock()
getFirstExecutableBlock(childProvider: Provider): Promise<BigNumber | null>;
Defined in: message/ChildToParentMessageNitro.ts:596
Estimates the L1 block number in which this L2 to L1 tx will be available for execution. If the message can or already has been executed, this returns null
Parameters
| Parameter | Type | Description |
|---|---|---|
childProvider | Provider |
Returns
Promise<BigNumber | null>
expected parent chain block number where the child chain to parent chain message will be executable. Returns null if the message can be or already has been executed
Inherited from
ChildToParentMessageReaderNitro.getFirstExecutableBlock
hasExecuted()
protected hasExecuted(childProvider: Provider): Promise<boolean>;
Defined in: message/ChildToParentMessageNitro.ts:225
Check if this message has already been executed in the Outbox
Parameters
| Parameter | Type |
|---|---|
childProvider | Provider |
Returns
Promise<boolean>
Inherited from
ChildToParentMessageReaderNitro.hasExecuted
status()
status(childProvider: Provider): Promise<ChildToParentMessageStatus>;
Defined in: message/ChildToParentMessageNitro.ts:240
Get the status of this message In order to check if the message has been executed proof info must be provided.
Parameters
| Parameter | Type |
|---|---|
childProvider | Provider |
Returns
Promise<ChildToParentMessageStatus>
Inherited from
ChildToParentMessageReaderNitro.status
waitUntilReadyToExecute()
waitUntilReadyToExecute(childProvider: Provider, retryDelay: number): Promise<CONFIRMED | EXECUTED>;
Defined in: message/ChildToParentMessageNitro.ts:507
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 |
|---|---|---|---|
childProvider | Provider | undefined | - |
retryDelay | number | 500 |
Returns
Promise<CONFIRMED | EXECUTED>
outbox entry status (either executed or confirmed but not pending)
Inherited from
ChildToParentMessageReaderNitro.waitUntilReadyToExecute
fromEvent()
static fromEvent<T>(
parentSignerOrProvider: T,
event: object,
parentProvider?: Provider): ChildToParentMessageReaderOrWriterNitro<T>;
Defined in: message/ChildToParentMessageNitro.ts:148
Instantiates a new ChildToParentMessageWriterNitro or ChildToParentMessageReaderNitro object.
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |
Parameters
| Parameter | Type | Description |
|---|---|---|
parentSignerOrProvider | T | Signer or provider to be used for executing or reading the Child-to-Parent message. |
event | { arbBlockNum: BigNumber; caller: string; callvalue: BigNumber; data: string; destination: string; ethBlockNum: BigNumber; hash: BigNumber; position: BigNumber; timestamp: BigNumber; } | The event containing the data of the Child-to-Parent message. |
event.arbBlockNum | BigNumber | - |
event.caller? | string | - |
event.callvalue? | BigNumber | - |
event.data? | string | - |
event.destination? | string | - |
event.ethBlockNum? | BigNumber | - |
event.hash? | BigNumber | - |
event.position? | BigNumber | - |
event.timestamp? | BigNumber | - |
parentProvider? | Provider | Optional. Used to override the Provider which is attached to parentSignerOrProvider in case you need more control. This will be a required parameter in a future major version update. |
Returns
ChildToParentMessageReaderOrWriterNitro<T>
Inherited from
ChildToParentMessageReaderNitro.fromEvent
Type Aliases
ChildToParentMessageReaderOrWriterNitro
type ChildToParentMessageReaderOrWriterNitro<T> = T extends Provider ? ChildToParentMessageReaderNitro : ChildToParentMessageWriterNitro;
Defined in: message/ChildToParentMessageNitro.ts:64
Conditional type for Signer or Provider. If T is of type Provider then ChildToParentMessageReaderOrWriter<T> will be of type ChildToParentMessageReader. If T is of type Signer then ChildToParentMessageReaderOrWriter<T> will be of type ChildToParentMessageWriter.
Type Parameters
| Type Parameter |
|---|
T extends SignerOrProvider |