mirror of
https://github.com/logos-messaging/pm.git
synced 2026-01-05 07:33:08 +00:00
Add FURPS
This commit is contained in:
parent
f514c7fb3d
commit
e62128052d
25
FURPS/application/local_web_dev_harness.md
Normal file
25
FURPS/application/local_web_dev_harness.md
Normal file
@ -0,0 +1,25 @@
|
||||
# Local Web Dev Harness FURPS
|
||||
|
||||
## Functionality
|
||||
|
||||
1. Runs local Waku node to test Web application without relying on external connectivity.
|
||||
2. js-waku runs in NodeJS for testing and CI purposes.
|
||||
|
||||
## Usability
|
||||
|
||||
1. Developer only need to run a script or preset to start local Waku node and have their web app connect to it.
|
||||
2. Potential WSS/HTTPS issues are worked around so that developer does need to manually generate or import SSL certificates.
|
||||
3. There is an easy option for the developer to bootstrap and connect to local node, instead of external peers.
|
||||
|
||||
## Reliability
|
||||
|
||||
## Performance
|
||||
|
||||
|
||||
## Supportability
|
||||
|
||||
1. Linux and Mac development environments.
|
||||
2. Local network without RLN.
|
||||
3. Chrome and Firefox browsers.
|
||||
|
||||
## + (Privacy, Anonymity, Deployments)
|
||||
20
FURPS/core/rln_api.md
Normal file
20
FURPS/core/rln_api.md
Normal file
@ -0,0 +1,20 @@
|
||||
# Waku RLN API FURPS
|
||||
|
||||
TODO
|
||||
|
||||
## Functionality
|
||||
|
||||
|
||||
## Usability
|
||||
|
||||
|
||||
## Reliability
|
||||
|
||||
## Performance
|
||||
|
||||
## Supportability
|
||||
|
||||
|
||||
## + (Privacy, Anonymity, Deployments)
|
||||
|
||||
1. ...
|
||||
@ -3,10 +3,14 @@
|
||||
## Functionality
|
||||
|
||||
1. Light push service node can attach RLN proof for clients.
|
||||
2. Relay node can attach RLN proof for outbound messages.
|
||||
3. Relay node can verify RLN proof for inbound messages.
|
||||
4. Light push client can be configured to generate proof for outbound messages.
|
||||
5. Filter client can be configured to verify proof for inbound messages.
|
||||
|
||||
## Usability
|
||||
|
||||
1. Light push clients do not need RLN logic.
|
||||
1. Light push clients do not need RLN logic when using RLNaaS.
|
||||
|
||||
## Reliability
|
||||
|
||||
@ -23,6 +27,7 @@
|
||||
## Supportability
|
||||
|
||||
1. Service node proof generation for light push clients is available in `wakunode2` for browser clients.
|
||||
2. Browser edge nodes can be configured to verify and generate proofs.
|
||||
|
||||
## + (Privacy, Anonymity, Deployments)
|
||||
|
||||
|
||||
@ -71,10 +71,13 @@ TODO
|
||||
|
||||
**Owner**: js-waku
|
||||
|
||||
**Feature**: [{Feature Name (only 1)}]({path/to/furps/file})
|
||||
**Feature**: [RLN Relay](/FURPS/core/rln_relay.md)
|
||||
|
||||
**FURPS**:
|
||||
- {F1. copy-paste full furps statement}
|
||||
- F4. Light push client can be configured to generate proof for outbound messages.
|
||||
- F5. Filter client can be configured to verify proof for inbound messages.
|
||||
|
||||
- S2. Browser edge nodes can be configured to verify and generate proofs.
|
||||
|
||||
**Checklist**:
|
||||
- [ ] Specs: link to specs and/or API definition
|
||||
@ -86,7 +89,8 @@ TODO
|
||||
|
||||
**Owner**: nwaku
|
||||
|
||||
**Feature**: [{Feature Name (only 1)}]({path/to/furps/file})
|
||||
TODO
|
||||
**Feature**: [Waku RLN API](/FURPS/core/rln_api.md)
|
||||
|
||||
**FURPS**:
|
||||
- {F1. copy-paste full furps statement}
|
||||
|
||||
@ -95,12 +95,27 @@ TODO
|
||||
|
||||
### Local Web Dev Harness
|
||||
|
||||
TODO: update milestone
|
||||
1 js-waku engineer, 70% cap allocated;
|
||||
start 1st Sep, end 19th Sep;
|
||||
|
||||
|
||||
**Owner**: js-waku
|
||||
|
||||
**Feature**: [{Feature Name (only 1)}]({path/to/furps/file})
|
||||
**Feature**: [Local Web Dev Harness](/FURPS/application/local_web_dev_harness.md)
|
||||
|
||||
**FURPS**:
|
||||
- {F1. copy-paste full furps statement}
|
||||
|
||||
- F1. Runs local Waku node to test Web application without relying on external connectivity.
|
||||
- F2. js-waku runs in NodeJS for testing and CI purposes.
|
||||
|
||||
- U1. Developer only need to run a script or preset to start local Waku node and have their web app connect to it.
|
||||
- U2. Potential WSS/HTTPS issues are worked around so that developer does need to manually generate or import SSL certificates.
|
||||
- U3. There is an easy option for the developer to bootstrap and connect to local node, instead of external peers.
|
||||
|
||||
- S1. Linux and Mac development environments.
|
||||
- S2. Local network without RLN.
|
||||
- S3. Chrome and Firefox browsers.
|
||||
|
||||
**Checklist**:
|
||||
- [ ] Specs: link to specs and/or API definition
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user