logos-messaging/pm
1
0
Fork 0
mirror of https://github.com/logos-messaging/pm.git synced 2026-05-20 17:39:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: address review comments

Browse Source 
Co-authored-by: fryorcraken <110212804+fryorcraken@users.noreply.github.com>
This commit is contained in:
Danish Arora 2025-07-28 16:31:30 +05:30
parent e91d18cf0b
commit 9e7a7b3e85
No known key found for this signature in database
GPG Key ID: 1C6EF37CDAE1426E
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
requirements/zerokit.md
View File

@ -4,16 +4,15 @@
Zerokit is the recommended library for cryptographic operations including Poseidon hashing, RLN identity generation, and proof verification. Zerokit is the recommended library for cryptographic operations including Poseidon hashing, RLN identity generation, and proof verification.
Waku relies on Zerokit, primarily for two implementaions: Waku relies on Zerokit, primarily for two implementaions:
- js-waku (rln-wasm): credentials - js-waku (rln-wasm): credentials (now), proof generation and verification (2025H2)
- nwaku: credentials + proof generation & verification - nwaku: proof generation & verification (now), credentials (2025H2)
Current JS integration faces two main challenges: Current JS integration faces two main challenges:
- **WASM cold start/load latency:** The WASM blob load time improved from ~15 seconds (v0.1.0) to ~5 seconds (v0.2.0). Notably, the current `rln-wasm` build includes proof generation and verification, which js-waku does not require. This suggests a smaller, credential-only WASM library could further reduce load times for js-waku. - **WASM cold start/load latency:** The WASM blob load time improved from ~15 seconds (v0.1.0) to ~5 seconds (v0.2.0). Notably, the current `rln-wasm` build includes proof generation and verification, which not all web apps built with Waku require. And even if one web app requires both credentials and proof verification/generation, it is likely done in different areas from a UX and functional PoV. This suggests a smaller, credential-only and proof-handling-only WASM libraries could further reduce load times for js-waku.
- **Endianness mismatch:** js-waku uses big-endian (BE) throughout, as required by contracts, while Zerokit expects little-endian (LE). This necessitates conversion when interfacing between the two, though this is less critical than load latency. - **Endianness mismatch:** js-waku uses big-endian (BE) throughout, as required by contracts, while Zerokit expects little-endian (LE). This necessitates conversion when interfacing between the two, though this is less critical than load latency.
Additional minor challenges: Additional minor challenges:
- Insufficient documentation and upgrade notes. - Lack of documentation regarding `InitOutput` and root exports.
- Unclear purpose and usage of `InitOutput` and root exports.
- Ambiguity around the sequence and role of initialization functions such as `init()`, `initPanicHook()`, etc. - Ambiguity around the sequence and role of initialization functions such as `init()`, `initPanicHook()`, etc.
We aim to align expectations and optimize collaboration between the Waku and Vac ACZ teams by clearly expressing our functional and non-functional requirements. We aim to align expectations and optimize collaboration between the Waku and Vac ACZ teams by clearly expressing our functional and non-functional requirements.
@ -31,18 +30,16 @@ We aim to align expectations and optimize collaboration between the Waku and Vac
- **F1.1:** Generate deterministic identity commitment (`idCommitment`) from entropy/seed. - **F1.1:** Generate deterministic identity commitment (`idCommitment`) from entropy/seed.
- **F1.2:** Generate full identity object (`commitment`, `secret`, `nullifier`, `trapdoor`). - **F1.2:** Generate full identity object (`commitment`, `secret`, `nullifier`, `trapdoor`).
- **F1.3:** Support Big-Endian (BE), instead of Little-Endian (LE)
### Usability ### Usability
- **U1.1:** WASM load time should be <5s in cold start on most browsers. - **U1.1:** WASM load time should be <5s in cold start on most browsers.
- **U1.3:** _Optional:_ Provide a reduced WASM build or a dedicated `@zerokit/credentials` package that only supports credentials (no proof logic). - **U1.2:** API accepts and return Big-Endian (BE), so data can be passed to Web3 RPC API without manipulation.
- **U1.3:** Documentation is provided to use APIs to generate and load credentials.
### Reliability ### Reliability
- **R1.1:** Deterministic outputs — BE/LE encoding should not affect hash reproducibility (if possible). - **R1.1:** Inter-operability between Zerokit FFI (x86_64, ARM, binaries) and WASI (browser WASM) APIs.
- **R1.2:** Cross-language consistency between js-waku and nwaku.
- **R1.3:** Exposed APIs should be stable and well-documented.
### Performance ### Performance
@ -50,7 +47,7 @@ We aim to align expectations and optimize collaboration between the Waku and Vac
### Supportability ### Supportability
- **S1.1:** Available for: JavaScript/TypeScript (browsers), nim - **S1.1:** Available for: JavaScript/TypeScript (browsers)
--- - **S1.2:** Available for Nim
## Use Case 2: Proof Generation and Verification