feat: implement slot arithmetic #39
Draft
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
KtorZ
reviewed
Dec 20, 2024
| } | ||
|
|
||
| // The start is inclusive and the end is exclusive. In a valid EraHistory, the | ||
| // end of each era will equal the start of the next one. |
There was a problem hiding this comment.
Is this another constraint it makes sense to validate / enforce in an EraHistory constructor @KtorZ?
i.e. just pass in a Vec<(Bound, Params)>, and then use the start of the next one as the end of the previous one, with the last one taking a None?
abailly
reviewed
Dec 21, 2024
| pub struct Bound { | ||
| pub time: u64, // Milliseconds | ||
| pub slot: Slot, | ||
| pub epoch: u64, |
There was a problem hiding this comment.
I think I would also have a type Epoch = u64 but maybe overkill?
| #[derive(Clone, PartialEq, Eq)] | ||
| pub struct EraParams { | ||
| epoch_size: u64, | ||
| slot_length: u64, // Milliseconds |
crates/time/src/lib.rs
Outdated
| let t0 = eras.slot_to_relative_time(172801); | ||
| assert_eq!(t0, Err(TimeHorizonError::PastTimeHorizon)); | ||
| let t1 = eras.slot_to_relative_time(172800); | ||
| assert_eq!(t1, Ok(172800000)); |
There was a problem hiding this comment.
I am not a big fan of testing several things in a single test: When the test fails, it's hard to know quickly what's failed, you would have to look at the source code of the test to know exactly what broke, which is annoying.
I would suggest to:
- not prefix test functions with
test_, we know they are tests because there's an annotation just above - have more explicit test names (eg.
slot_to_time_fails_given_its_past_upper_bound) - have each function test a single "thing" (possibly using parameterised tests to avoid duplication)
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.
this is a draft PR for slot arithmetic to help align on implementation as per last week's meeting.
this implements slot-to-time, time-to-slot, slot-to-epoch, and epoch boundary functions. these functions depend on the current state of the node. in particular, the start and end times, the slot lengths, and the epoch lengths of all known eras are required. this information is captured by an
EraHistorytype roughly corresponding to theInterpetertype used inOuroboros.Consensus.HardFork.History.Qry.just like in
Qry.hs, these functions require that the latest era in the era history argument ends at the epoch of the safe zone (seeOuroboros.Consensus.HardFork.Combinator.State.Infra), so care must be taken by the caller to ensure that an up-to-date era history is supplied. the end of the era history expresses that we can't definitively predict times beyond that point.to elaborate on the details, as far as i understand:
the expectations for this deliverable have been kept pretty loose so far, so i'm open to any feedback.