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

store sync first draft

Browse Source
This commit is contained in:
SionoiS 2024-09-06 11:11:37 -04:00
parent f5e7f23fa8
commit 1069535b9b
No known key found for this signature in database
GPG Key ID: C9458A8CB1852951
1 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
standards/core/store-sync.md Normal file
View File

@ -0,0 +1,51 @@
---
title: WAKU-STORE-SYNC
name: Waku Store Syncronization
editor: Simon-Pierre Vivier <simvivier@status.im>
contributors:
---
## Abstract
This document describe the strategy Waku store node will employ to stay synchronized.
The goal being that all store nodes eventually archive the same set of messages.
## Background / Rationale / Motivation
Message propagation in the network is not perfect,
even with GossipSub mechanisms to detect missed messages.
Nodes can also go offline for various reason outside our control.
Store nodes that want to provide a good service must be able to remedy situations like these.
By having store nodes syncronize with each other through various protocols,
the set of archived messages network wide will be eventually consistent.
## Theory / Semantics
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
Various protocols and features that help with message consistency are described below.
### Store Resume
This feature allow a node to fill the gap in messages for the period it was offline.
At startup, a node use the Store protocol to query a random node for
the time interval since it was last online.
It is RECOMMENDED” to limit the time interval to a maximum of 6 hours.
### Waku Sync
Nodes that stay online can still miss messages.
Waku Sync is used to find those messages by periodically syncing with random node.
It is RECOMMENDED to trigger a sync every 5 minutes for the time range of the last hour.
After both hash set are reconciled, the Store protocol is used to reciprocally query the other node with the hash differences found.
TODO link to spec
## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
## References
TODO