Release v0.5.0

[rymnc]

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

• Clean up the tests, refactor common tree init logic and insertion logic into macros or functions
• Update documentation for rln-v2 to include new serde format
• add QoL traits to the Hasher associated type in MerkleTree trait: chore(rln): add QoL traits to the Hasher associated type in MerkleTree trait #238
• refactor benchmarks, remove the following function

  zerokit/rln/tests/poseidon_tree.rs

  Line 13 in 0521c73

  fn test_zerokit_merkle_implementations_performances() {

• Remove the resources_folder from the rln config

Usage of arkzkey vs zkey

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

rln

• Remove tree_height 32 resources and associated circuit loading within

  zerokit/rln/src/circuit.rs

  Lines 35 to 37 in d91a5b3

  	pub const TEST_PARAMETERS_INDEX: usize = 0;
  	pub const TEST_TREE_HEIGHT: usize = [20, 32][TEST_PARAMETERS_INDEX];
  	pub const TEST_RESOURCES_FOLDER: &str = ["tree_height_20", "tree_height_32"][TEST_PARAMETERS_INDEX];

• Define the kats better in

  zerokit/rln/tests/protocol.rs

  Lines 17 to 69 in d91a5b3

  	const WITNESS_JSON_20: &str = r#"
  	{
  	"externalNullifier": "21074405743803627666274838159589343934394162804826017440941339048886754734203",
  	"identityPathIndex": [
  	1,
  	1,
  	1,
  	0,
  	1,
  	0,
  	1,
  	0,
  	1,
  	0,
  	1,
  	0,
  	0,
  	0,
  	0,
  	0,
  	1,
  	1,
  	1,
  	0
  	],
  	"identitySecret": "2301650865650889795878889082892690584512243988708213561328369865554257051708",
  	"messageId": "1",
  	"pathElements": [
  	"14082964758224722211945379872337797638951236517417253447686770846170014042825",
  	"6628418579821163687428454604867534487917867918886059133241840211975892987309",
  	"12745863228198753394445659605634840709296716381893463421165313830643281758511",
  	"56118267389743063830320351452083247040583061493621478539311100137113963555",
  	"3648731943306935051357703221473866306053186513730785325303257057776816073765",
  	"10548621390442503192989374711060717107954536293658152583621924810330521179016",
  	"11741160669079729961275351458682156164905457324981803454515784688429276743441",
  	"17165464309215350864730477596846156251863702878546777829650812432906796008534",
  	"18947162586829418653666557598416458949428989734998924978331450666032720066913",
  	"8809427088917589399897132358419395928548406347152047718919154153577297139202",
  	"6261460226929242970747566981077801929281729646713842579109271945192964422300",
  	"13871468675790284383809887052382100311103716176061564908030808887079542722597",
  	"10413964486611723004584705484327518190402370933255450052832412709168190985805",
  	"3978387560092078849178760154060822400741873818692524912249877867958842934383",
  	"14014915591348694328771517896715085647041518432952027841088176673715002508448",
  	"17680675606519345547327984724173632294904524423937145835611954334756161077843",
  	"17107175244885276119916848057745382329169223109661217238296871427531065458152",
  	"18326186549441826262593357123467931475982067066825042001499291800252145875109",
  	"7043961192177345916232559778383741091053414803377017307095275172896944935996",
  	"2807630271073553218355393059254209097448243975722083008310815929736065268921"
  	],
  	"userMessageLimit": "100",
  	"x": "20645213238265527935869146898028115621427162613172918400241870500502509785943"
  	}
  	"#;

• 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
• 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]

I'll take removing tree_height 32 resources

[rymnc]

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