docs: add notes and todos

rln/src/lib.rs

@@ -41,6 +41,8 @@ mod test {
         println!("Root: {:#}", root);
         println!("Merkle proof: {:#?}", merkle_proof);
 
+        // TODO Expand this test to cover RLN end to end
+
         // // change signal and external_nullifier here
         // let signal = b"xxx";
         // let external_nullifier = b"appId";

rln/src/main.rs

@@ -1,3 +1,6 @@
+/// This is basic entry point for `cargo run` to play around with proof,
+/// outputs, etc.
+///
 use ark_circom::{CircomBuilder, CircomConfig};
 use ark_std::rand::thread_rng;
 use color_eyre::Result;
@@ -29,6 +32,8 @@ struct WitnessInput {
     rln_identifier: String,
 }
 
+// TODO: This should use public.rs as much as possible
+
 // RLN
 fn groth16_proof_example() -> Result<()> {
     // Tracing to help with debugging

rln/src/public.rs

@@ -1,3 +1,6 @@
+/// This is the main public API for RLN. It is used by the FFI, and should be
+/// used by tests etc as well
+///
 use crate::merkle::IncrementalMerkleTree;
 use crate::poseidon::{Poseidon as PoseidonHasher, PoseidonParams};
 use semaphore::hash::Hash;
@@ -48,6 +51,9 @@ struct WitnessInput {
     rln_identifier: String,
 }
 
+// TODO Isolate hardcoded JSON test here
+// TODO Expand API to have better coverage of things needed
+
 impl RLN {
     // TODO Break this apart here
     pub fn new() -> RLN {