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

Update Dev docs for Poseidon2 #710

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

ShaniBabayoff
Copy link
Contributor

Copying the Supported Bindings section from poseidon2.md.

Describe the changes

This PR...

Linked Issues

Resolves #

Copying the Supported Bindings section from poseidon2.md.
@LeonHibnik LeonHibnik mentioned this pull request Dec 29, 2024
@@ -71,6 +71,83 @@ The S box power alpha, number of full rounds and partial rounds, rounds constant

In the current version the padding is not supported and should be performed by the user.

## Supported Bindings

[`Rust`](https://github.com/ingonyama-zk/icicle/tree/main/wrappers/rust/icicle-core/src/poseidon2)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Go also supports Poseidon2, although it is per curve/field, for example for bn254

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@LeonHibnik LeonHibnik changed the title Update hash.md Update Dev docs for Poseidon2 Jan 1, 2025

#### Rust API

This is the most basic way to use the Poseidon2 API. See the [examples/poseidon2](https://github.com/ingonyama-zk/icicle/tree/b12d83e6bcb8ee598409de78015bd118458a55d0/examples/rust/poseidon2) folder for the relevant code
Copy link
Collaborator

Choose a reason for hiding this comment

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

what is this commit? is it merged to main?

println!("computed digest: {:?} ",out_init_slice.as_slice().to_vec()[0]);
```

#### Merkle Tree Builder
Copy link
Collaborator

Choose a reason for hiding this comment

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

why merkle on the hash page?

[`Go`](https://github.com/ingonyama-zk/icicle/blob/main/wrappers/golang/curves/bn254/poseidon2/poseidon2.go)


#### Rust API
Copy link
Collaborator

Choose a reason for hiding this comment

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

I dont understand what this should be here. Maybe in the rust page as a poseidon2 example below.
https://github.com/ingonyama-zk/icicle/blob/main/docs/docs/icicle/rust-bindings/hash.md

Copy link
Collaborator

@yshekel yshekel left a comment

Choose a reason for hiding this comment

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

I think this is not the correct page to update. Merkle should be removed from hash page. Rust example can be under the rust hash page https://github.com/ingonyama-zk/icicle/blob/main/docs/docs/icicle/rust-bindings/hash.md

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.

3 participants