specs: supervisor api #533
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Take a quick pass at the supervisor api. This is useful because there are many teams integrating into this right now. op-geth has already integrated, the op-reth integration is ongoing as well as the rbuilder integration should be happening soon. This enables us to point to spec as the source of truth in how the API is meant to work.
tynes
requested review from
protolambda,
ajsutton,
sebastianst and
mslipper
as code owners
|
This doesn't include all of the methods, see https://github.com/ethereum-optimism/optimism/blob/develop/op-supervisor/supervisor/frontend/frontend.go#L18-L28 h/t @refcell |
refcell
reviewed
Jan 23, 2025
Comment on lines
+26
to
+32
| ## RPC API | ||
|
|
||
| ### `supervisor_checkMessage` | ||
|
|
||
| Checks the safety level of a specific message based on its identifier and message hash. | ||
| This RPC is useful for the block builder to determine if a message is should be included | ||
| in a block. |
There was a problem hiding this comment.
emhane
reviewed
Jan 24, 2025
| ### `supervisor_checkMessage` | ||
|
|
||
| Checks the safety level of a specific message based on its identifier and message hash. | ||
| This RPC is useful for the block builder to determine if a message is should be included |
There was a problem hiding this comment.
Suggested change
| This RPC is useful for the block builder to determine if a message is should be included | |
| This RPC is useful for the block builder to determine if a message should be included |
| #### Parameters | ||
|
|
||
| - identifier: [Identifier](./messaging.md#message-identifier) - The identifier of the message to check. | ||
| - message hash: Hash - Hash of the initiating message. |
There was a problem hiding this comment.
Suggested change
| - message hash: Hash - Hash of the initiating message. | |
| - message hash: Hash - Hash of the initiating message payload. |
Comment on lines
+50
to
+70
| ### `supervisor_superRootAtTimestamp` | ||
|
|
||
| Gets the super root at a specific timestamp. | ||
|
|
||
| #### Parameters | ||
|
|
||
| - timestamp: hexutil.Uint64 - Timestamp to query. | ||
|
|
||
| #### Returns | ||
|
|
||
| - object | ||
| - timestamp: hexutil.Uint64 - The timestamp of the super root | ||
| - superRoot: Hash - The root of the super root | ||
| - chains: []object - List of chains included in the super root | ||
| - chainId: hexutil.Uint64 - The chainid | ||
| - canonical: Hash - output root at the latest canonical block | ||
| - pending: hexutil.Bytes - output root preimage | ||
|
|
||
| #### Description | ||
|
|
||
| Retrieves the super root state at the specified timestamp, which represents the global state across all monitored chains. |
There was a problem hiding this comment.
would be nice with a sentence about why this is used, like the method above says "to determine if a message should be included in a block"...what's the point of knowing a super root at a certain timestamp?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Take a quick pass at the supervisor api. This is useful because there
are many teams integrating into this right now.
op-geth has already integrated, the op-reth integration is ongoing as
well as the rbuilder integration should be happening soon.
This enables us to point to spec as the source of truth in how the API
is meant to work.