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

refactor(spec): new structure for the specs/ directory #602

Merged
merged 26 commits into from
Dec 6, 2024

Conversation

cason
Copy link
Contributor

@cason cason commented Nov 22, 2024

Rendered specs entry point.

Part of #250:

  • Create a specs/synchronization directory for synchronization protocols
  • Create a specs/starknet directory for forced-updates, proof scheduling, and parts streaming
  • Create a specs/network/discovery with the discovery protocol
  • Create a specs/network/gossip for gossipsub documentation
  • Move Quint main model into specs/consensus/quint and fix all derived issues

Closes #609:

  • Fixes Quint workflows to consider all Quint files
  • Reorganize consensus/quint by removing the specs subdir

This PR contains a lot of change, I am sorry for that. But notice that most changes are renames or moves. And a lot of actual changes are there to reflect the performed renames and moves.


PR author checklist

@cason cason added work in progress Work in progress spec Related to specifications open-source Tasks required for open-sourcing the repository labels Nov 22, 2024
@cason cason self-assigned this Nov 22, 2024
@cason cason requested a review from josef-widder November 25, 2024 12:57
@cason cason marked this pull request as ready for review November 25, 2024 13:03
.then(reset)
.then(addL1BlockProofWithHeight(1,1))
.expect(L2[L2.length()-1] == L1[L1.length()-1].latestProvenL2BlockHash)
//// TODO: fix those tests, see https://github.com/informalsystems/malachite/issues/610.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Associated issue: #610

@@ -4,7 +4,7 @@ pub fn generate_test_traces(spec_rel_path: &str, gen_dir: &str, quint_seed: u64)
println!("🪄 Generating test traces for {spec_rel_path:?}...");

let spec_abs_path = format!(
"{}/../../../../specs/quint/{spec_rel_path}",
"{}/../../../../specs/consensus/quint/{spec_rel_path}",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This should not be hardcoded in this way, I'd say.

@cason cason requested a review from romac November 25, 2024 13:12
@cason cason changed the title refactor(spec): new structure for the specs/ directory (WIP) refactor(spec): new structure for the specs/ directory Nov 25, 2024
@cason cason added quint and removed work in progress Work in progress labels Nov 25, 2024
cason and others added 4 commits November 29, 2024 08:49
#623)

* spec: consensus README.md updated

* spec/consensus: README re-organized

* spec/consensu: added design.md document, empty by now

* spec/consensus: removed empty design.md

* spec: new design.md file from existing English spec

* spec/consensus: design introduction rephrased

* spec/consensus: moved message handling to a new file

* spec/consensus: improvements to message handling

* spec/consensus: some fixes to design.md

* spec/consensus: fixed pseudo-code in design.md

* spec/consensus: moved picture to a local path
@josef-widder josef-widder merged commit b31b846 into main Dec 6, 2024
13 checks passed
@josef-widder josef-widder deleted the cason/250-spec-reorg branch December 6, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source Tasks required for open-sourcing the repository quint spec Related to specifications
Projects
None yet
Development

Successfully merging this pull request may close these issues.

quint: review and reorganize consensus modeling directory
3 participants