logos-messaging/pm
1
0
Fork 0
mirror of https://github.com/logos-messaging/pm.git synced 2026-01-08 00:53:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

add browser furps

Browse Source
This commit is contained in:
Sasha 2025-06-04 00:52:17 +02:00 committed by fryorcraken
parent a38fefb055
commit 37226f90a1
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
3 changed files with 26 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
FURPS/application/js-waku.md
View File

@ -1,27 +1,17 @@
# JS-Waku FURPS # JS-Waku FURPS
TODO
## Functionality ## Functionality
1. ...
## Usability ## Usability
1. ...
## Reliability ## Reliability
1. ... 1. From an operating state, a node can resume transmitting messages within 1 second after disconnection; in a network with 1 bootstrap node, 100 service nodes and 500 browser nodes (**Vac-DST**)
## Performance ## Performance
1. ... 1. From a cold start, a node can start transmitting messages within 5 seconds; in a network with 1 bootstrap node, 100 service nodes and 500 browser nodes (**Vac-DST**)
## Supportability ## Supportability
1. ...
## + (Privacy, Anonymity, Deployments) ## + (Privacy, Anonymity, Deployments)
1. ...

2
FURPS/core/waku_api.md
View File

@ -9,6 +9,7 @@
3. Support relay node operation mode. 3. Support relay node operation mode.
4. Does automatic peer discovery based on the node platform and operation mode. 4. Does automatic peer discovery based on the node platform and operation mode.
5. Returns health and connectivity information using proven heuristics. 5. Returns health and connectivity information using proven heuristics.
6. Previously discovered peers are persisted across restarted, and potentially used for future connections.
## Usability ## Usability
@ -17,6 +18,7 @@
3. Developers do not need to specify the protocols used to send and receive messages; it is deduced from the mode of operation. 3. Developers do not need to specify the protocols used to send and receive messages; it is deduced from the mode of operation.
4. Developers pass and receive data to the API in types native to the wrapping language. 4. Developers pass and receive data to the API in types native to the wrapping language.
5. By default, auto-sharding is applied, meaning developers do not need to be concerned by sharding; pubsub topics are never exposed. 5. By default, auto-sharding is applied, meaning developers do not need to be concerned by sharding; pubsub topics are never exposed.
6. Developers only need to handle errors in cases of irretrievable failure requiring end-user action. Internal errors are not bubbled up if they can be recovered internally.
## Reliability ## Reliability

23
draft-roadmap/improve_devex_api_twn_metrics_docs.md
View File

@ -3,7 +3,7 @@
**Estimated date of completion**: {Enter date} **Estimated date of completion**: {Enter date}
**Resources Required for 2025H2**: **Resources Required for 2025H2**:
- {roles and % application to it} - 1 js-waku engineer TODO
- {external services consumed (Vac/IFT)} - {external services consumed (Vac/IFT)}
- {infrastructure} - {infrastructure}
@ -130,11 +130,13 @@ Spec delivery not included.
- F2. Support edge node operation mode. - F2. Support edge node operation mode.
- F4. Does automatic peer discovery based on the node platform and operation mode. - F4. Does automatic peer discovery based on the node platform and operation mode.
- F5. Returns health and connectivity information using proven heuristics. - F5. Returns health and connectivity information using proven heuristics.
- F6. Previously discovered peers are persisted across restarted, and potentially used for future connections.
- U1. When setting up a Waku node, no need to specify what protocols to mount, only an operational mode (edge or relay). - U1. When setting up a Waku node, no need to specify what protocols to mount, only an operational mode (edge or relay).
- U2. Disconnection detection and recovery, and other peer management matters are automatically handled. - U2. Disconnection detection and recovery, and other peer management matters are automatically handled.
- U3. Developers do not need to specify the protocols used to send and receive messages; it is deduced from the mode of operation. - U3. Developers do not need to specify the protocols used to send and receive messages; it is deduced from the mode of operation.
- U4. Developers pass and receive data to the API in types native to the wrapping language. - U4. Developers pass and receive data to the API in types native to the wrapping language.
- U5. By default, auto-sharding is applied, meaning developers do not need to be concerned by sharding; pubsub topics are never exposed. - U5. By default, auto-sharding is applied, meaning developers do not need to be concerned by sharding; pubsub topics are never exposed.
- U6. Developers only need to handle errors in cases of irretrievable failure requiring end-user action. Internal errors are not bubbled up if they can be recovered internally.
- R1. Sends a message using peer-to-peer reliability (service node redundancy, optional store confirmation) - R1. Sends a message using peer-to-peer reliability (service node redundancy, optional store confirmation)
- R2. Receives messages using peer-to-peer reliability (service node redundancy, periodic store query, periodic filter ping) - R2. Receives messages using peer-to-peer reliability (service node redundancy, periodic store query, periodic filter ping)
@ -157,11 +159,13 @@ For S3. Browser; distribution via npmjs.com.
- F3. Support relay node operation mode. - F3. Support relay node operation mode.
- F4. Does automatic peer discovery based on the node platform and operation mode. - F4. Does automatic peer discovery based on the node platform and operation mode.
- F5. Returns health and connectivity information using proven heuristics. - F5. Returns health and connectivity information using proven heuristics.
- F6. Previously discovered peers are persisted across restarted, and potentially used for future connections.
- U1. When setting up a Waku node, no need to specify what protocols to mount, only an operational mode (edge or relay). - U1. When setting up a Waku node, no need to specify what protocols to mount, only an operational mode (edge or relay).
- U2. Disconnection detection and recovery, and other peer management matters are automatically handled. - U2. Disconnection detection and recovery, and other peer management matters are automatically handled.
- U3. Developers do not need to specify the protocols used to send and receive messages; it is deduced from the mode of operation. - U3. Developers do not need to specify the protocols used to send and receive messages; it is deduced from the mode of operation.
- U4. Developers pass and receive data to the API in types native to the wrapping language. - U4. Developers pass and receive data to the API in types native to the wrapping language.
- U5. By default, auto-sharding is applied, meaning developers do not need to be concerned by sharding; pubsub topics are never exposed. - U5. By default, auto-sharding is applied, meaning developers do not need to be concerned by sharding; pubsub topics are never exposed.
- U6. Developers only need to handle errors in cases of irretrievable failure requiring end-user action. Internal errors are not bubbled up if they can be recovered internally.
- R1. Sends a message using peer-to-peer reliability (service node redundancy, optional store confirmation) - R1. Sends a message using peer-to-peer reliability (service node redundancy, optional store confirmation)
- R2. Receives messages using peer-to-peer reliability (service node redundancy, periodic store query, periodic filter ping) - R2. Receives messages using peer-to-peer reliability (service node redundancy, periodic store query, periodic filter ping)
@ -200,3 +204,20 @@ For:
- [ ] Code: link to GitHub issues/PRs/Epic - [ ] Code: link to GitHub issues/PRs/Epic
- [ ] Dogfood: link to dogfooding session/artefact - [ ] Dogfood: link to dogfooding session/artefact
- [ ] Docs: links to README.md or docs.waku.org (TBD) - [ ] Docs: links to README.md or docs.waku.org (TBD)
## Optimise Browser Bootstrapping
**Owner**: js-waku
**Feature**: [js-waku](/FURPS/application/js-waku.md)
**FURPS**:
- R1. From an operating state, a node can resume transmitting messages within 1 second after disconnection; in a network with 1 bootstrap node, 100 service nodes and 500 browser nodes (**Vac-DST**)
- P1. From a cold start, a node can start transmitting messages within 5 seconds; in a network with 1 bootstrap node, 100 service nodes and 500 browser nodes (**Vac-DST**)
**Checklist**:
- [ ] Specs: link to specs and/or API definition
- [ ] Code: link to GitHub issues/PRs/Epic
- [ ] Dogfood: link to dogfooding session/artefact
- [ ] Docs: links to README.md or docs.waku.org (TBD)