specs: add oracle specification doc #1941
Merged
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
github-actions
bot
added
the
documentation
Fraser999
approved these changes
Feb 18, 2025
specs/oracle.md
Outdated
| ## High level overview | ||
|
|
||
| Astria uses CometBFT for consensus, which communicates with the application | ||
| logic using [ABCI++](https://docs.cometbft.com/v0.37/spec/abci/abci++_basic_concepts#consensusblock-execution-methods). |
There was a problem hiding this comment.
Suggested change
| logic using [ABCI++](https://docs.cometbft.com/v0.37/spec/abci/abci++_basic_concepts#consensusblock-execution-methods). | |
| logic using [ABCI++](https://docs.cometbft.com/v0.38/spec/abci/abci++_basic_concepts#consensusblock-execution-methods). |
specs/oracle.md
Outdated
|
|
||
| The overall price for a currency pair is calculated by using the voting-power-weighted | ||
| median of the prices posted by each validator. This way, one malfunctioning validator | ||
| should not be able to affect the resulting aggregated price. |
There was a problem hiding this comment.
Suggested change
| should not be able to affect the resulting aggregated price. | |
| should not be able to significantly affect the resulting aggregated price. |
specs/oracle.md
Outdated
|
|
||
| ```rust | ||
| pub struct ExtendedCommitInfoWithCurrencyPairMapping { | ||
| // the entire set of vote extensions finalized in the sequencer block. |
There was a problem hiding this comment.
Suggested change
| // the entire set of vote extensions finalized in the sequencer block. | |
| /// The entire set of vote extensions finalized in the sequencer block. |
specs/oracle.md
Outdated
Comment on lines
87
to
88
| // mapping of currency pair ID (since vote extensions contain only ID->price) | ||
| // to the currency pair and its price decimals. |
There was a problem hiding this comment.
Suggested change
| // mapping of currency pair ID (since vote extensions contain only ID->price) | |
| // to the currency pair and its price decimals. | |
| /// Mapping of currency pair ID (since vote extensions contain only ID->price) | |
| /// to the currency pair and its price decimals. |
specs/oracle.md
Outdated
| } | ||
| ``` | ||
|
|
||
| The price data is set to the rollup as a `RollupData::OracleData` variant, which |
There was a problem hiding this comment.
Suggested change
| The price data is set to the rollup as a `RollupData::OracleData` variant, which | |
| The price data is sent to the rollup as a `RollupData::OracleData` variant, which |
specs/oracle.md
Outdated
|
|
||
| #### `process_proposal` | ||
|
|
||
| Other validators receive the proposed block in [`process_proposal`](https://github.com/astriaorg/astria/blob/b2083b4a82195dc9be1e85f31cea14c724b8b4ec/crates/astria-sequencer/src/app/vote_extension.rs#L271). |
There was a problem hiding this comment.
This links to validate_proposal - might be worthwhile renaming process_proposal in this doc throughout (but maybe mention validate_proposal is called during process proposal?
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
add oracle specification which details how the oracle protocol works, the types and functions changed, changes to the sequencer app and conductor.
Related Issues
closes #1890