feat(docs): ADR 003 - Propagation of Proposed Values #884

cason · 2025-03-04T10:22:17Z

Closes: ~~365~~ #937

PR author checklist

For all contributors

Reference GitHub issue
Ensure PR title follows the conventional commits spec

For external contributors

Maintainers of Malachite are allowed to push changes to the branch

adizere

Thanks Daniel, really appreciate starting this!

docs/architecture/adr-003-values-propagation.md

…into cason/365-adr

adizere · 2025-03-20T16:11:58Z

I made the scope of this ADR more narrow: It should simply tackle #937

codecov · 2025-03-21T16:07:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.22%. Comparing base (f4618cf) to head (82a0d08).
Report is 3 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #884      +/-   ##
==========================================
- Coverage   81.38%   81.22%   -0.16%     
==========================================
  Files         193      194       +1     
  Lines       16827    16989     +162     
==========================================
+ Hits        13694    13798     +104     
- Misses       3133     3191      +58

Flag	Coverage Δ
integration	`81.08% <ø> (-0.15%)`	⬇️
mbt	`7.91% <ø> (-0.08%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
core	`∅ <ø> (∅)`
engine	`∅ <ø> (∅)`
app	`∅ <ø> (∅)`
starknet	`∅ <ø> (∅)`

docs/architecture/adr-003-values-propagation.md

Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com>

docs/architecture/adr-003-values-propagation.md

Co-authored-by: Romain Ruetschi <romain@informal.systems> Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com>

Co-authored-by: Daniel <daniel.cason@informal.systems> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com>

adizere

I think it's ready. Massive effort, thank you all!

fixed

nenadmilosevic95

I made a pass on old document and it looks good for me. The only thing I am not sure about is if we should use V notation somehow in Consensus By Value section.

For the new section I made some comments.

docs/architecture/adr-003-values-propagation.md

ancazamfir · 2025-03-27T11:23:55Z

The only thing I am not sure about is if we should use V notation somehow in Consensus By Value section.

yes, it's not perfect but I am ok with current version. @cason wdyt?

Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com>

* docs: added file to ADR 003 on values propopagation * docs: ADR 003 general Context * docs: ADR 003, Tendermint context vs general one * docs: ADR 003, Value Propagation context * docs: ADR 103 Alternatives overview * docs: ADR 003, Context simplified and rewritten * docs: ADR 003, sketched Alternatives sections * docs: ADR 003, overivew of dissemination approaches * first take on describing current designs * small improvments on the text * feat: mermaid diagrams of value propagation modes * Minor changes Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com> * Small text changes Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com> * fix: diagrams * Update docs/architecture/adr-003-values-propagation.md Co-authored-by: Romain Ruetschi <romain@informal.systems> Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com> * Use V and v, fix diagrams, add some app requirements * Fix typos * Separate consensus core and engine, remove network * Correct diagrams * Address review comments * Add details for the different diagram blocks * Add warnings for ProposalOnly * Apply suggestions from code review Co-authored-by: Daniel <daniel.cason@informal.systems> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com> * Small changes * Remvove TODO * Show streaming before LocallyProposedValue, add own Proposal msg * Rearange receiver boxes * Apply suggestions from code review Co-authored-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com> * initial pass, ~50% done * pass on value propagation considerations section * Generate proposal for PartsOnly in the engine * Explicit requirements for PartsOnly * Add reference to tendermint consensus algo changes * Spelling * Small fixes * Clarify ProposalOnly for large values * Fix Engine description * Apply suggestions from code review Co-authored-by: Daniel <daniel.cason@informal.systems> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com> * Ref fixes * Update docs/architecture/adr-003-values-propagation.md Co-authored-by: Daniel <daniel.cason@informal.systems> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com> * Update docs/architecture/adr-003-values-propagation.md Co-authored-by: Daniel <daniel.cason@informal.systems> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Daniel <daniel.cason@informal.systems> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com> * valid_round mandatory for PartsOnly * second pass * minor rephrasing * Cleanup * Review comment * Add restreaming section * Review comments - correct restreaming behavior at non-proposer * Review comments * small updates Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com> * add `V` in consensus by value section Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com> --------- Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com> Co-authored-by: Nenad Milosevic <nenadmilosevic@Nenads-MacBook-Pro.local> Co-authored-by: Romain Ruetschi <romain@informal.systems> Co-authored-by: Bastien Faivre <faivre.bast@gmail.com> Co-authored-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com> Co-authored-by: Anca Zamfir <zamfiranca@gmail.com> Co-authored-by: Anca Zamfir <ancazamfir@users.noreply.github.com> Co-authored-by: Adi Seredinschi <a@seredinschi.net>

cason added 2 commits March 4, 2025 09:22

docs: added file to ADR 003 on values propopagation

99a715b

docs: ADR 003 general Context

c462f6f

romac changed the title ~~Cason/365 adr~~ docs: ADR 003 - Propagation of Proposed Values Mar 4, 2025

romac added the documentation Improvements or additions to documentation label Mar 4, 2025

cason added 3 commits March 4, 2025 13:26

docs: ADR 003, Tendermint context vs general one

0900b60

docs: ADR 003, Value Propagation context

1f564d7

docs: ADR 103 Alternatives overview

ead61e6

adizere reviewed Mar 6, 2025

View reviewed changes

cason added 3 commits March 6, 2025 18:55

docs: ADR 003, Context simplified and rewritten

f0ee5ed

docs: ADR 003, sketched Alternatives sections

99a288c

Merge branch 'main' into cason/365-adr

749a3b1

cason assigned nenadmilosevic95 Mar 18, 2025

Merge branch 'main' into cason/365-adr

443f5cc

adizere mentioned this pull request Mar 18, 2025

docs: Document how to drive the low-level consensus engine #929

Closed

cason added 2 commits March 18, 2025 18:49

Merge branch 'main' into cason/365-adr

b23e839

docs: ADR 003, overivew of dissemination approaches

0a52f8a

romac changed the title ~~docs: ADR 003 - Propagation of Proposed Values~~ feat(docs): ADR 003 - Propagation of Proposed Values Mar 19, 2025

Merge branch 'cason/365-adr' of github.com:informalsystems/malachite …

49345cb

…into cason/365-adr

first take on describing current designs

ebd5da7

Nenad Milosevic and others added 2 commits March 21, 2025 17:46

small improvments on the text

82a0d08

Merge branch 'main' into cason/365-adr

651dfd9

romac reviewed Mar 24, 2025

View reviewed changes

docs/architecture/adr-003-values-propagation.md Outdated Show resolved Hide resolved

bastienfaivre and others added 3 commits March 24, 2025 15:19

feat: mermaid diagrams of value propagation modes

f5d2768

Minor changes

879dc27

Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com>

Small text changes

f830402

Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com>

ancazamfir previously requested changes Mar 24, 2025

View reviewed changes

bastienfaivre and others added 2 commits March 24, 2025 18:29

fix: diagrams

f245045

Update docs/architecture/adr-003-values-propagation.md

001a1be

Co-authored-by: Romain Ruetschi <romain@informal.systems> Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com>

ancazamfir and others added 5 commits March 26, 2025 13:49

Update docs/architecture/adr-003-values-propagation.md

77d21f2

Co-authored-by: Daniel <daniel.cason@informal.systems> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com>

Apply suggestions from code review

a044bdb

Co-authored-by: Daniel <daniel.cason@informal.systems> Signed-off-by: Anca Zamfir <ancazamfir@users.noreply.github.com>

valid_round mandatory for PartsOnly

0370ded

second pass

fa36fbf

minor rephrasing

2fdd936

adizere approved these changes Mar 26, 2025

View reviewed changes

Merge branch 'main' into cason/365-adr

7af4487

romac approved these changes Mar 27, 2025

View reviewed changes

adizere assigned ancazamfir and unassigned adizere Mar 27, 2025

adizere linked an issue Mar 27, 2025 that may be closed by this pull request

Clarify the role of various proposal-related methods in the core library API #937

Closed

Cleanup

0d33f11

ancazamfir requested a review from nenadmilosevic95 March 27, 2025 09:37

ancazamfir added 2 commits March 27, 2025 10:46

Review comment

753d9d6

Add restreaming section

05c95dc

nenadmilosevic95 reviewed Mar 27, 2025

View reviewed changes

docs/architecture/adr-003-values-propagation.md Outdated Show resolved Hide resolved

docs/architecture/adr-003-values-propagation.md Outdated Show resolved Hide resolved

docs/architecture/adr-003-values-propagation.md Outdated Show resolved Hide resolved

ancazamfir added 2 commits March 27, 2025 11:57

Review comments - correct restreaming behavior at non-proposer

c33540f

Review comments

7be2b78

nenadmilosevic95 added 2 commits March 27, 2025 12:30

small updates

e9aff4c

Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com>

add V in consensus by value section

77cc03a

Signed-off-by: nenadmilosevic95 <50905385+nenadmilosevic95@users.noreply.github.com>

ancazamfir approved these changes Mar 27, 2025

View reviewed changes

ancazamfir added this pull request to the merge queue Mar 27, 2025

ancazamfir removed this pull request from the merge queue due to a manual request Mar 27, 2025

ancazamfir added this pull request to the merge queue Mar 27, 2025

Merged via the queue into main with commit 2e750e5 Mar 27, 2025
19 checks passed

ancazamfir deleted the cason/365-adr branch March 27, 2025 12:28

feat(docs): ADR 003 - Propagation of Proposed Values #884

feat(docs): ADR 003 - Propagation of Proposed Values #884

Uh oh!

Conversation

cason commented Mar 4, 2025 • edited by adizere Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR author checklist

For all contributors

For external contributors

Uh oh!

adizere left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adizere commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adizere left a comment

Choose a reason for hiding this comment

Uh oh!

nenadmilosevic95 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ancazamfir commented Mar 27, 2025

Uh oh!

Uh oh!

Uh oh!

cason commented Mar 4, 2025 •

edited by adizere

Loading

adizere commented Mar 20, 2025 •

edited

Loading

codecov bot commented Mar 21, 2025 •

edited

Loading