feat: implement and calculate the current key period using pallas #1541
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
- update the source of dependencies `pallas-addresses`, `pallas-codec`, `pallas-network`, `pallas-primitives`, `pallas-traverse` to a git repository with branch `feat/genesis-config` - add a new method `calculate_kes_period` to fetch chain point and genesis config through local statequery - implement logic in the `calculate_kes_period` method to calculate the kes period based on retrieved data
- remove the `fallback` field from `pallaschainobserver` - update the `pallaschainobserver::new` method signature to no longer accept `fallback` argument in `pallas_observer.rs` - update the test functions in the `mod tests` section to no longer use `fallback` in `pallas_observer.rs` - remove the `fallback` field and related code in `mithrilinfrastructure` in `infrastructure.rs`
- remove unnecessary imports in `chain_observer/pallas_observer.rs` - fix formatting issues in the code - simplify the `get_fake_utxo_by_address` function definition
- update the `pallas-addresses`, `pallas-codec`, `pallas-network`, `pallas-primitives`, `pallas-traverse`, and `pallas-crypto` dependencies to use the `txpipe` repository and `main` branch instead of the `falcucci` repository and `feat/genesis-config` branch in `cargo.toml`
- refactor the code to retrieve `slots_per_kes_period` from `config` instead of directly from `genesis_config` - improve error handling by adding context to the error message - adjust the calculation of `current_kes_period` to use the updated `slots_per_kes_period` calculation from `config`
- change error message from obtaining genesis config to extracting the config.
|
hey @jpraynaud ready for review |
- add validation for slots_per_kes_period being greater than 0 - update error message for slots_per_kes_period being 0
- add a new async function `calculate_kes_period` that takes `&self, chain_point: point, slots_per_kes_period: u64` as arguments - rename the function `calculate_kes_period` to `get_kes_period` - modify code in the test mod to match the changes in `calculate_kes_period` function
- update the specific point value from 53536042 to 52851885 in the `getchainpoint` request.
- add a comment for the `calculate_kes_period` method - include `chain_point` and `slots_per_kes_period` as arguments at the method definition
Alenar
reviewed
Mar 1, 2024
- change return type of function from `u32` to `kesperiod` - fix error handling and conversion in the function - update test case with new chain point slot value
- refactor the `pallaschainobserver` implementation to handle `slots_per_kes_period` being `0` differently - update the calculation of `current_kes_period` to handle the new logic for `slots_per_kes_period` being `0`
- add detailed documentation for the `calculate_kes_period` function and its usage - improve the explanation of the calculation formula for the kes period - include an example with input values for the calculation formula
- fix a typo in the variable description from `s symbolizes` to `s represents`
|
@jpraynaud @Alenar done, thank you. |
jpraynaud
approved these changes
Mar 1, 2024
- update the comment and variable names in `mithril-common/src/chain_observer/pallas_observer.rs` to improve clarity.
falcucci
force-pushed
the
feat/kes_period
branch
from
4cea399
to
af349bf
Compare
|
Hi @falcucci, it looks like some clippy warnings need also to be fixed: https://github.com/input-output-hk/mithril/actions/runs/8113314179/job/22176650787#step:4:1110 |
- remove unused imports related to chainobserver in infrastructure.rs - update the import to use pallaschainobserver directly
|
@jpraynaud true, fixed. |
- update the version number in `mithril-common/cargo.toml` from `0.3.15` to `0.3.16`
- change code block syntax in comments to `no_run` - update comments in code for example clarity
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| /// | ||
| /// ## Example: | ||
| /// | ||
| ///! ```no_run |
Check warning
Code scanning / clippy
this is an outer doc comment and does not apply to the parent module or crate
| /// | ||
| /// ## Example: | ||
| /// | ||
| ///! ```no_run |
Check warning
Code scanning / clippy
this is an outer doc comment and does not apply to the parent module or crate
- update comments for the `calculate current kes period` function in `mithril-common/src/chain_observer/pallas_observer.rs`
Comment on lines
237
to
259
| ///! # Calculate Current KES Period | ||
| ///! | ||
| ///! It calculates the current Key Evolving Signature (KES) period | ||
| ///! based on the provided `chain_point` and `slots_per_kes_period`. | ||
| ///! | ||
| ///! The calculation formula is represented as: | ||
| ///! | ||
| ///! `current_kes_period = ⌊current_slot_number/slots_per_kes_period⌋` | ||
| ///! | ||
| ///! where: | ||
| ///! - `current_slot_number` represents the current slot number given by the `point` on the chain. | ||
| ///! - `slots_per_kes_period` represents the number of slots in a KES period. | ||
| ///! - `⌊x⌋` is the floor function which rounds the greatest integer less than or equal to `x`. | ||
| ///! | ||
| ///! ## Example: | ||
| ///! | ||
| ///!! ```no_run | ||
| ///! let (chain_point, slots_per_kes_period) = (Point::new(1), 10); | ||
| ///! match calculate_kes_period(&self, chain_point, slots_per_kes_period) { | ||
| ///! Ok(kes_period) => println!("Current KES Period: {}", kes_period), | ||
| ///! Err(e) => println!("Error occurred: {}", e), | ||
| ///! } | ||
| ///! ``` |
Check warning
Code scanning / clippy
this is an outer doc comment and does not apply to the parent module or crate
Comment on lines
237
to
259
| ///! # Calculate Current KES Period | ||
| ///! | ||
| ///! It calculates the current Key Evolving Signature (KES) period | ||
| ///! based on the provided `chain_point` and `slots_per_kes_period`. | ||
| ///! | ||
| ///! The calculation formula is represented as: | ||
| ///! | ||
| ///! `current_kes_period = ⌊current_slot_number/slots_per_kes_period⌋` | ||
| ///! | ||
| ///! where: | ||
| ///! - `current_slot_number` represents the current slot number given by the `point` on the chain. | ||
| ///! - `slots_per_kes_period` represents the number of slots in a KES period. | ||
| ///! - `⌊x⌋` is the floor function which rounds the greatest integer less than or equal to `x`. | ||
| ///! | ||
| ///! ## Example: | ||
| ///! | ||
| ///!! ```no_run | ||
| ///! let (chain_point, slots_per_kes_period) = (Point::new(1), 10); | ||
| ///! match calculate_kes_period(&self, chain_point, slots_per_kes_period) { | ||
| ///! Ok(kes_period) => println!("Current KES Period: {}", kes_period), | ||
| ///! Err(e) => println!("Error occurred: {}", e), | ||
| ///! } | ||
| ///! ``` |
Check warning
Code scanning / clippy
this is an outer doc comment and does not apply to the parent module or crate
- updated the documentation for the `calculate current kes period` function in `pallas_observer.rs`
Comment on lines
253
to
259
| ///! ```no_run | ||
| ///! let (chain_point, slots_per_kes_period) = (Point::new(1), 10); | ||
| ///! match calculate_kes_period(&self, chain_point, slots_per_kes_period) { | ||
| ///! Ok(kes_period) => println!("Current KES Period: {}", kes_period), | ||
| ///! Err(e) => println!("Error occurred: {}", e), | ||
| ///! } | ||
| ///! ``` |
Check warning
Code scanning / clippy
this is an outer doc comment and does not apply to the parent module or crate
Comment on lines
253
to
259
| ///! ```no_run | ||
| ///! let (chain_point, slots_per_kes_period) = (Point::new(1), 10); | ||
| ///! match calculate_kes_period(&self, chain_point, slots_per_kes_period) { | ||
| ///! Ok(kes_period) => println!("Current KES Period: {}", kes_period), | ||
| ///! Err(e) => println!("Error occurred: {}", e), | ||
| ///! } | ||
| ///! ``` |
Check warning
Code scanning / clippy
this is an outer doc comment and does not apply to the parent module or crate
- update `calculate_kes_period` function in `pallas_observer.rs` to include a new example with chain_point and slots_per_kes_period values - remove the old example from the `calculate_kes_period` function in `pallas_observer.rs`
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.
Pre-submit checklist
fixes #1315