Release v0.5.0 - Githubissues

rymnc commented 6 months ago

With this issue we scope out from #91 the features and issues we want to address in the next zerokit release v0.5.0.

Reported items may change according to any eventual blocker found or re-prioritization of items.

`maintenance`

[x] Clean up the tests, refactor common tree init logic and insertion logic into macros or functions
[x] Update documentation for rln-v2 to include new serde format
[x] add QoL traits to the Hasher associated type in MerkleTree trait: #238
[x] refactor benchmarks, remove the following function https://github.com/vacp2p/zerokit/blob/0521c7349e7aa36e25b43e4663def226451a7147/rln/tests/poseidon_tree.rs#L13
[x] Remove the resources_folder from the rln config

[x] Include https://github.com/oskarth/mopro/tree/main/ark-zkey as part of the pre-processing of zkey to make the lib load faster

[x] Remove tree_height 32 resources and associated circuit loading within https://github.com/vacp2p/zerokit/blob/d91a5b35688d7b033466dc879e494b07ecbbb6ee/rln/src/circuit.rs#L35-L37
[x] Define the kats better in https://github.com/vacp2p/zerokit/blob/d91a5b35688d7b033466dc879e494b07ecbbb6ee/rln/tests/protocol.rs#L17-L69
[x] Investigate tree reconciliation mechanism, where we can introspect and check which indices have 0 set in their leaves. If this is possible, patch rln-v1 branch with this feature too. This will help clients assess if their tree is structured appropriately

[x] Expose a public function to fetch the root of a subtree at level n, i.e

pub fn get_subtree_root<W: Write, R: Read>(&self, mut input_data: R, mut output_data: W) -> Result<()>

tyshko-rostyslav commented 6 months ago

I'll take removing tree_height 32 resources

rymnc commented 5 months ago

addressed in all the PRs mentioned above, and released on crates.io, github too.