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

Merge pull request #313 from waku-org/furps-for-codex

Browse Source 
docs: furps suggestion for simple codex poc
This commit is contained in:
fryorcraken 2025-06-12 16:04:07 +10:00 committed by GitHub
commit a115762d59
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 38 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
FURPS/application/codex_archiving.md Normal file
View File

@ -0,0 +1,25 @@
# Codex Archiving PoC FURPS
## Functionality
1. Any end user can publish a backup snapshot of the entire SDS log to Codex.
2. End user (may be privileged) can publish the corresponding Codex CID with metadata over Waku to a dedicated snapshot content topic.
3. Participants can query the Waku snapshot topic for the latest CID.
4. Participants can retrieve the archived messages from Codex.
5. Participants can perform a store Query for more recent messages following the snapshot timestamp and SDS state.
## Usability
1. Workflow should be conceptually identical, whether the Codex interaction is via a local node or Codex gateway.
2. Publishing or retrieving via Codex should be optional.
## Reliability
## Performance
## Supportability
1. Developers can use this protocol in web applications.
## + (Privacy, Anonymity, Deployments)

18
draft-roadmap/formalize_and_expand_waku_web_apps.md
View File

@ -52,14 +52,22 @@ Logos Movement Community Enabling
### [Codex for Message Archival PoC](https://github.com/waku-org/pm/issues/293)
TODO - Hanno is defining some FURPS and we can review.
**Owner**: App/Chat Dev
**Owner**: {one waku subteam}
**Feature**: [{Feature Name (only 1)}]({path/to/furps/file})
**Feature**: [Codex Archiving PoC](/FURPS/application/codex_archiving.md)
**FURPS**:
- {F1. copy-paste full furps statement}
- F1. Any end user can publish a backup snapshot of the entire SDS log to Codex.
- F2. End user (may be privileged) can publish the corresponding Codex CID with metadata over Waku to a dedicated snapshot content topic.
- F3. Participants can query the Waku snapshot topic for the latest CID.
- F4. Participants can retrieve the archived messages from Codex.
- F5. Participants can perform a store Query for more recent messages following the snapshot timestamp and SDS state.
- U1. Workflow should be conceptually identical, whether the Codex interaction is via a local node or Codex gateway.
- U2. Publishing or retrieving via Codex should be optional.
- S1. Developers can use this protocol in web applications.
**Checklist**:
- [ ] Specs: link to specs and/or API definition