Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add ADR for epochs #1550

Merged
merged 4 commits into from
Jan 11, 2024
Merged

docs: add ADR for epochs #1550

merged 4 commits into from
Jan 11, 2024

Conversation

mpoke
Copy link
Contributor

@mpoke mpoke commented Jan 5, 2024

Description

Closes: #1514

Add ADR for ICS Epochs.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

@mpoke mpoke requested a review from a team as a code owner January 5, 2024 17:26
@github-actions github-actions bot added C:Docs Assigned automatically by the PR labeler C:ADR Assigned automatically by the PR labeler labels Jan 5, 2024

- Add a param that sets the number of blocks in an epoch, i.e., `BlocksPerEpoch`.
We can use `BlockHeight() % BlocksPerEpoch == 0` to decide when an epoch is over.
Note that `BlocksPerEpoch` can also be a hardcoded constant as it's unlikely that it will change often.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think hardcoded constant isn't really a great option, since we don't want to force people to fork if they just need a different epoch, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. A parameter would be cleaner, but it's not a must. Especially as this will be code run on the Hub.

docs/docs/adrs/adr-014-epochs.md Show resolved Hide resolved
docs/docs/adrs/adr-014-epochs.md Outdated Show resolved Hide resolved
docs/docs/adrs/adr-014-epochs.md Outdated Show resolved Hide resolved
mpoke and others added 2 commits January 8, 2024 11:50
@mpoke mpoke requested a review from p-offtermatt January 8, 2024 10:51

The implementation of epochs requires the following changes:

- Add a param that sets the number of blocks in an epoch, i.e., `BlocksPerEpoch`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a max value for BlocksPerEpoch which should not be exeeded?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really. Of course reasonable values are needed to not increase too much the delay of propagating validator updates, see #1550 (comment).

@mpoke mpoke added this pull request to the merge queue Jan 11, 2024
Merged via the queue into main with commit f783b06 Jan 11, 2024
14 checks passed
@mpoke mpoke deleted the marius/1514-adr-epochs branch January 11, 2024 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:ADR Assigned automatically by the PR labeler C:Docs Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ADR describing ICS epochs
3 participants