From c2e807b994f0706cc3053c74f544a8ac2e154e0c Mon Sep 17 00:00:00 2001 From: fryorcraken Date: Fri, 13 Jun 2025 00:12:03 +1000 Subject: [PATCH] Final furps, rename api --- FURPS/core/rln_smart_contract.md | 6 +++--- FURPS/core/{waku_api.md => waku_sdk.md} | 4 +--- draft-roadmap/improve_devex_api_twn_metrics_docs.md | 4 ++-- draft-roadmap/integrate_rln_with_waku_api.md | 13 +++++-------- draft-roadmap/nim_usage_improvements.md | 2 +- draft-roadmap/streamline_dev_ex_local_dev_rust.md | 2 +- 6 files changed, 13 insertions(+), 18 deletions(-) rename FURPS/core/{waku_api.md => waku_sdk.md} (96%) diff --git a/FURPS/core/rln_smart_contract.md b/FURPS/core/rln_smart_contract.md index e617eec..0ef8d3e 100644 --- a/FURPS/core/rln_smart_contract.md +++ b/FURPS/core/rln_smart_contract.md @@ -12,6 +12,7 @@ 1. Application developers can set RLN rate limit at insertion. 2. User does not need to wait for merkle tree synchronization and building to start relaying or sending messages. +3. Application does not need to do a Web3 RPC call for every tree change to generate or validate messages. ## Reliability @@ -28,6 +29,5 @@ ## + (Privacy, Anonymity, Deployments) -1. Smart Contracts are deployed on Linea Sepolia. -2. TWN uses smart contracts deployed on Linea Sepolia. - +1. Smart Contracts are deployed on ~Linea Sepolia~ Status L2 Sepolia. +2. TWN uses smart contracts deployed on ~Linea Sepolia~ Status L2 Sepolia. diff --git a/FURPS/core/waku_api.md b/FURPS/core/waku_sdk.md similarity index 96% rename from FURPS/core/waku_api.md rename to FURPS/core/waku_sdk.md index f1a70a8..bab1afc 100644 --- a/FURPS/core/waku_api.md +++ b/FURPS/core/waku_sdk.md @@ -1,6 +1,4 @@ -# Waku API FURPS - -(proposing to move away from "messaging api" to avoid confusion) +# Waku ADK FURPS ## Functionality diff --git a/draft-roadmap/improve_devex_api_twn_metrics_docs.md b/draft-roadmap/improve_devex_api_twn_metrics_docs.md index c2ef723..1110eb2 100644 --- a/draft-roadmap/improve_devex_api_twn_metrics_docs.md +++ b/draft-roadmap/improve_devex_api_twn_metrics_docs.md @@ -93,7 +93,7 @@ Spec delivery not included. **Owner**: js-waku -**Feature**: [Waku API](/FURPS/core/waku_api.md) +**Feature**: [Waku SDK](/FURPS/core/waku_sdk.md) **FURPS**: - F1. Setup, start and stop a Waku node. @@ -122,7 +122,7 @@ For S3. Browser; distribution via npmjs.com. **Owner**: nwaku -**Feature**: [Waku API](/FURPS/core/waku_api.md) +**Feature**: [Waku SDK](/FURPS/core/waku_sdk.md) **FURPS**: - F1. Setup, start and stop a Waku node. diff --git a/draft-roadmap/integrate_rln_with_waku_api.md b/draft-roadmap/integrate_rln_with_waku_api.md index cd4eb40..6930a8a 100644 --- a/draft-roadmap/integrate_rln_with_waku_api.md +++ b/draft-roadmap/integrate_rln_with_waku_api.md @@ -118,14 +118,13 @@ See deliverables. ### Deploy RLN Contracts to Status L2 testnet -TODO FURPS - **Owner**: nwaku -**Feature**: [{Feature Name (only 1)}]({path/to/furps/file}) +**Feature**: [RLN Smart Contract](/FURPS/core/rln_smart_contract.md) **FURPS**: -- {F1. copy-paste full furps statement} +- +1. Smart Contracts are deployed on Status L2 Sepolia. +- +2. TWN uses smart contracts deployed on Status L2 Sepolia. **Checklist**: - [ ] Specs: link to specs and/or API definition @@ -135,14 +134,12 @@ TODO FURPS ### Improve RLN UX by reducing Web3 RPC calls -TODO FURPS - **Owner**: core research -**Feature**: [{Feature Name (only 1)}]({path/to/furps/file}) +**Feature**: [RLN Smart Contract](/FURPS/core/rln_smart_contract.md) **FURPS**: -- {F1. copy-paste full furps statement} +- U3. Application does not need to do a Web3 RPC call for every tree change to generate or validate messages. **Checklist**: - [ ] Specs: link to specs and/or API definition diff --git a/draft-roadmap/nim_usage_improvements.md b/draft-roadmap/nim_usage_improvements.md index 3986cee..f864976 100644 --- a/draft-roadmap/nim_usage_improvements.md +++ b/draft-roadmap/nim_usage_improvements.md @@ -62,7 +62,7 @@ Note: maybe taken over by Vac-Nim **Owner**: nwaku -**Feature**: [Waku API](/FURPS/core/waku_api.md) +**Feature**: [Waku SDK](/FURPS/core/waku_sdk.md) **FURPS**: - F8. When wrapping the C API, conversion from native types to Protobuf is needed by the wrapper (PoC). diff --git a/draft-roadmap/streamline_dev_ex_local_dev_rust.md b/draft-roadmap/streamline_dev_ex_local_dev_rust.md index 873486b..8ad0d66 100644 --- a/draft-roadmap/streamline_dev_ex_local_dev_rust.md +++ b/draft-roadmap/streamline_dev_ex_local_dev_rust.md @@ -78,7 +78,7 @@ See deliverables. **Owner**: nwaku -**Feature**: [Waku API](/FURPS/core/waku_api.md) +**Feature**: [Waku SDK(/FURPS/core/waku_sdk.md) **FURPS**: - S4. Rust; available on crates.io.