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.

Sign up for GitHub

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

Jump to bottom

Add MdBook for Documentation #160

Merged
merged 7 commits into from
Jun 13, 2024
Merged

Add MdBook for Documentation #160

merged 7 commits into from
Jun 13, 2024

Conversation

aszepieniec
Copy link
Contributor

  • Add mdBook for documentation
  • Migrate existing documentations there
  • Add documentation for consensus logic wrt transactions

@aszepieniec
docs: Create mdBook
ec08ef1 
 - Create directory
 - Add outline
 - Copy over existing docs and update links
 - Delete deprecated directory `developer_docs`
@aszepieniec
docs: Add consensus overview
eb5fc0f
@aszepieniec
docs: Finish first draft of transaction validity
bbc2c13
@Sword-Smith
Copy link
Member

RemovalRecordsIntegrity :: (transaction_kernel_mast_hash : Digest) ⟶ (inputs_salted_utxos_hash : Digest)

Is the RemovalRecordsIntegrity program supposed to output something? I don't see that being the case currently. But maybe that's just in the pipeline?

@aszepieniec
Copy link
Contributor Author

RemovalRecordsIntegrity :: (transaction_kernel_mast_hash : Digest) ⟶ (inputs_salted_utxos_hash : Digest)

Is the RemovalRecordsIntegrity program supposed to output something? I don't see that being the case currently. But maybe that's just in the pipeline?

Yes, although an equally valid design would have been to take input_salted_utxos_hash as an argument and authenticate it. We still need to update the code.

@aszepieniec @Sword-Smith
docs: Address updating of removal records auth paths
308ecbb 
Co-authored-by: Thorkil Værge <thor@neptune.cash>
@aszepieniec aszepieniec merged commit 6180347 into master Jun 13, 2024
3 checks passed
@Sword-Smith Sword-Smith deleted the asz/consensus-logic-documentation branch August 27, 2024 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Sword-Smith Sword-Smith Sword-Smith left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aszepieniec @Sword-Smith