proto: extract sequencer and sequencer-relayer types as protobuf #355
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
This patch extracts Rust types that are used in communication between sequencer, sequencer-relayer, conductor, and celestia (as the data availability layer). The resulting protobuf types are intended to be the only way that services exchange data, making the current json-based wire format obsolete. The protobuf types defined in v1alpha1 of the sequencer API are deprecated (and were also never used).
github-actions
bot
added
conductor
|
Blocked on #346 being merged |
SuperFluffy
changed the title
github-actions
bot
removed
the
sequencer
noot
reviewed
Sep 13, 2023
crates/astria-proto/proto/astria/sequencer/v1alpha2/celestia.proto
Outdated
Show resolved
Hide resolved
noot
reviewed
Sep 13, 2023
crates/astria-proto/proto/astria/sequencer/v1alpha2/celestia.proto
Outdated
Show resolved
Hide resolved
noot
reviewed
Sep 13, 2023
crates/astria-proto/proto/astria/sequencer/v1alpha2/validation.proto
Outdated
Show resolved
Hide resolved
noot
requested changes
Sep 13, 2023
It is, but I wanted to move this to a |
|
@SuperFluffy I'm quite sure the protos currently in astria/sequencer/v1alpha1/block.proto and data.proto are not used anywhere at all, so you can remove them safely as it doesn't actually affect v1alpha1 |
noot
approved these changes
Sep 18, 2023
noot
reviewed
Sep 18, 2023
crates/astria-proto/proto/astria/sequencer/v1alpha2/block.proto
Outdated
Show resolved
Hide resolved
noot
reviewed
Sep 18, 2023
crates/astria-proto/proto/astria/sequencer/v1alpha2/celestia.proto
Outdated
Show resolved
Hide resolved
SuperFluffy
added a commit
that referenced
this pull request
Sep 18, 2023
## Summary Replace all implicit eyre errors by context specific typed errors ## Background Same reasoning as for #375 as part of the work for #332: `sequencer-types` has to be made a dependency of `sequencer-client`, which only uses typed errors. Therefore `sequencer-types` must have typed errors (because otherwise `sequencer-client` would be "infected" by eyre, which would require changing all of sequencer-client to also use eyre. ## Changes - Introduced one error variant per distinct eyre error. ## Testing N/A. Nothing changed on the code level. Testing that the errors are actually triggered could be done in a follow-up PR, but big parts of the code will be replaced by the work in #355 and follow-up PRs to it, moving the types exchanged over RPCs to the astria-proto crate. ## Breaking Changelist - No observable breaking changes in the astria services. Breaking changes in the library crates because their public API changed (errors), but we are not considering them right now ## Related Issues #12 #86 #366 #332
|
Something broke github. After squashing and rebasing on top of recent main this PR is no longer in sync with its branch. Opening a new PR. |
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.
Summary
This patch defines protobuf versions of various types that are currently only defined in Rust and exchange as json-serialized text.
Background
astria-protois intended to be the single source of truth for the wire format of data that is exchanged between services. At the momentSequencerBlockData,SequencerNamespaceData,RollupNamespaceDataandInclusionProofare only defined in Rust. Some older versions of these exist as protobuf but were never used in the public interfaces.Changes
v1alpha2API for sequencer block, inclusion proof, and celestia blobs (calledCelestiaItemandCelestiaHeader).Testing
Related Issues
#12 originally defined sequencer blocks and transactions as protobuf, but these were never actually implemented.
#86 is the reason this effort was started.