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

example and documentation for Merkle-tree API #628

Merged
merged 14 commits into from
Oct 20, 2024
Merged

Conversation

yshekel
Copy link
Collaborator

@yshekel yshekel commented Oct 10, 2024

No description provided.

@yshekel yshekel marked this pull request as ready for review October 14, 2024 12:54

:::note
Any combination of hashes is valid including **Poseidon** that computes on field elements.
Copy link
Contributor

Choose a reason for hiding this comment

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

Are there any limitations on Poseidon in the tree (Odd bit width for example messing with the layer width)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think that the field size must divide the output size of previous layer. But this is true for all other hashes too.
About converting random data to field elements it's the responsibility of the hasher function, not the tree.

@yshekel yshekel changed the title example for Merkle-tree commit and open example and documentation for Merkle-tree API Oct 15, 2024

## What is a Merkle Tree?

A **Merkle tree** is a cryptographic data structure that allows for **efficient verification of data integrity**. It consists of:
Copy link
Contributor

Choose a reason for hiding this comment

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

do you realy need to copy paste this section per API?

Copy link
Collaborator Author

@yshekel yshekel Oct 20, 2024

Choose a reason for hiding this comment

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

I will link the rust to general part for the intro. The rest I will have some duplication but otherwise rust has not text at all. Makes sense?

docs/sidebars.js Outdated Show resolved Hide resolved
@mickeyasa
Copy link
Contributor

comment

@yshekel yshekel merged commit 77aa7d5 into main Oct 20, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants