docs: modify epochs ADR to capture latest design #1668

insumity · 2024-02-29T13:41:21Z

Description

Modified the epochs ADR to describe the latest epoch-implementation we decided upon (see #1516).

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)

p-offtermatt

LGTM, one nit about a sentence that I find unclear.

docs/docs/adrs/adr-014-epochs.md

sainoe

LGTM

MSalopek

If you can, can you add some docs about to changing the params using a governance proposal?

…gov proposal

insumity · 2024-03-05T10:28:03Z

If you can, can you add some docs about to changing the params using a governance proposal?

@MSalopek Added a sentence ("This param can be changed through a governance proposal to ...") on the fact that param can be changed and that it is bounded.

* modified ADR to capture the epoch design

* docs: modify epochs ADR to capture latest design (#1668) * modified ADR to capture the epoch design * feat!: introduce epochs (#1660) * cleanup ./changelog entries * rebase * fix!: Validation of SlashAcks fails due to marshaling to Bech32 (backport #1570) (#1577) fix!: Validation of SlashAcks fails due to marshaling to Bech32 (#1570) * add different Bech32Prefix for consumer and provider * separate app encoding and params * remove ConsumerValPubKey from ValidatorConfig * update addresses in tests * make SlashAcks consistent across chains * add comments for clarity * Regenerate traces * Fix argument order * set bech32prefix for provider to cosmos * add changelog entries * add consumer-double-downtime e2e test * update nightly-e2e workflow * fix typo * add consumer-double-downtime to testConfigs * remove changes on provider * skip invalid SlashAcks * seal the config * clear the outstanding downtime flag for new vals * add info on upgrading to v4.0.0 * fix upgrade handler * fix changeover e2e test * Update tests/e2e/config.go Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * Update tests/e2e/config.go Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * add AccountPrefix to ChainConfig * fix docstrings * update AccountAddressPrefix in app.go * fix consumer-misb e2e test --------- Co-authored-by: Philip Offtermatt <p.offtermatt@gmail.com> Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com> Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> (cherry picked from commit 8604692) Co-authored-by: Marius Poke <marius.poke@posteo.de> * docs: update changelog for v4.0.0 (#1578) update changelog * docs: prepare for v4.0.0 (#1581) * unclog build * update release notes * update release date * added proto declaration * temp commit * temp commit * more changes * first commit * add param and fix tests * reduce epoch size for e2e * clean up * mbt fix * fix diff bug * cleaning up * cleaning up * cleaning up * cleaning up * cleaning up * cleaning up * added more tests * more fixes * nit fixes * cleaning up * increase downtime by one block * fix logs * took into account Marius' comments * tiny fixes * Update x/ccv/provider/keeper/params.go Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com> * use Bech32 addresses as keys for maps * refactor nextBlocks(epoch) to nextEpoch * fixed comment * Remove new block creation during consumer chain setup * Revert "Remove new block creation during consumer chain setup" This reverts commit 85a52b7. * added simple param test * added upper bound and addressed a comment * Add another edge case for diffing * used smarted solution (based on Philip's comment) for diffing validators * refactor!: remove key-assignment replacements (#1672) * initial commit * removed KeyAssignmentReplacementsKey * refactor: simplify key-assignment logic (#1684) * fixed typo: depreciated to deprecated --------- Co-authored-by: Marius Poke <marius.poke@posteo.de> * add the epoch param in the docs --------- Co-authored-by: mpoke <marius.poke@posteo.de> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com> Co-authored-by: Philip Offtermatt <p.offtermatt@gmail.com> * test: Add epochs to MBT (#1676) * cleanup ./changelog entries * rebase * fix!: Validation of SlashAcks fails due to marshaling to Bech32 (backport #1570) (#1577) fix!: Validation of SlashAcks fails due to marshaling to Bech32 (#1570) * add different Bech32Prefix for consumer and provider * separate app encoding and params * remove ConsumerValPubKey from ValidatorConfig * update addresses in tests * make SlashAcks consistent across chains * add comments for clarity * Regenerate traces * Fix argument order * set bech32prefix for provider to cosmos * add changelog entries * add consumer-double-downtime e2e test * update nightly-e2e workflow * fix typo * add consumer-double-downtime to testConfigs * remove changes on provider * skip invalid SlashAcks * seal the config * clear the outstanding downtime flag for new vals * add info on upgrading to v4.0.0 * fix upgrade handler * fix changeover e2e test * Update tests/e2e/config.go Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * Update tests/e2e/config.go Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * add AccountPrefix to ChainConfig * fix docstrings * update AccountAddressPrefix in app.go * fix consumer-misb e2e test --------- Co-authored-by: Philip Offtermatt <p.offtermatt@gmail.com> Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com> Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> (cherry picked from commit 8604692) Co-authored-by: Marius Poke <marius.poke@posteo.de> * docs: update changelog for v4.0.0 (#1578) update changelog * docs: prepare for v4.0.0 (#1581) * unclog build * update release notes * update release date * added proto declaration * temp commit * temp commit * more changes * first commit * add param and fix tests * reduce epoch size for e2e * clean up * mbt fix * fix diff bug * cleaning up * cleaning up * cleaning up * cleaning up * cleaning up * cleaning up * added more tests * more fixes * nit fixes * cleaning up * increase downtime by one block * fix logs * took into account Marius' comments * tiny fixes * Update x/ccv/provider/keeper/params.go Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com> * use Bech32 addresses as keys for maps * refactor nextBlocks(epoch) to nextEpoch * Start adding epochs * Adjust tests for epochs * Use invariant script instead of handwriting Makefile * Fix key assignment valset invariant * Add better run_invariants script * Start adding epochs from trace into driver * Remove new block creation during consumer chain setup * Adjust model for epochs * Take into account comments * Revert changes to actions.go * Revert changes to x/ * Remove unused listMul * Advance time by epochLength instead of 1 second * Indent condition and clarify EndProviderEpoch --------- Co-authored-by: mpoke <marius.poke@posteo.de> Co-authored-by: insumity <karolos@informal.systems> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com> * added changelogs * rebase and fix compatibility test * Update docs/docs/adrs/adr-014-epochs.md Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * Update docs/docs/adrs/adr-014-epochs.md Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * nit change in test * removed blocks per epoch upper limit --------- Co-authored-by: mpoke <marius.poke@posteo.de> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Simon Noetzlin <simon.ntz@gmail.com> Co-authored-by: Philip Offtermatt <p.offtermatt@gmail.com> Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com>

modified ADR

f333487

github-actions bot added C:Docs Assigned automatically by the PR labeler C:ADR Assigned automatically by the PR labeler labels Feb 29, 2024

small updates

38bdd7f

insumity self-assigned this Feb 29, 2024

insumity requested review from mpoke, sainoe and p-offtermatt February 29, 2024 13:51

insumity marked this pull request as ready for review February 29, 2024 13:51

insumity requested a review from a team as a code owner February 29, 2024 13:51

p-offtermatt approved these changes Feb 29, 2024

View reviewed changes

docs/docs/adrs/adr-014-epochs.md Show resolved Hide resolved

sainoe approved these changes Mar 1, 2024

View reviewed changes

added one more sentence on multiple key-assignment changes

8774209

MSalopek approved these changes Mar 4, 2024

View reviewed changes

added comment that the BlocksPerEpoch param can be changed through a …

5e7df66

…gov proposal

mpoke approved these changes Mar 6, 2024

View reviewed changes

insumity merged commit f08ed68 into feat/epochs Mar 7, 2024
14 checks passed

insumity deleted the insumity/update-ADR branch March 7, 2024 13:48

insumity added a commit that referenced this pull request Mar 11, 2024

docs: modify epochs ADR to capture latest design (#1668)

157efcb

* modified ADR to capture the epoch design

insumity mentioned this pull request Mar 11, 2024

feat!: introduce epochs #1691

Merged

21 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: modify epochs ADR to capture latest design #1668

docs: modify epochs ADR to capture latest design #1668

insumity commented Feb 29, 2024 •

edited

Loading

p-offtermatt left a comment

sainoe left a comment

MSalopek left a comment

insumity commented Mar 5, 2024

docs: modify epochs ADR to capture latest design #1668

docs: modify epochs ADR to capture latest design #1668

Conversation

insumity commented Feb 29, 2024 • edited Loading

Description

Author Checklist

Reviewers Checklist

p-offtermatt left a comment

Choose a reason for hiding this comment

sainoe left a comment

Choose a reason for hiding this comment

MSalopek left a comment

Choose a reason for hiding this comment

insumity commented Mar 5, 2024

insumity commented Feb 29, 2024 •

edited

Loading