57/STATUS-Simple-Scaling: Short Summary (#633)

* Update add-short-summary-abstract

* Update links + description

* Update README.md

* Update README.md
This commit is contained in:
Jimmy Debe 2023-12-04 10:27:22 -05:00 committed by GitHub
parent ddf3b3606a
commit e806798668
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 11 deletions

View File

@ -5,6 +5,7 @@ name: Status Simple Scaling
status: raw status: raw
category: Informational category: Informational
tags: waku/application tags: waku/application
description: Describes how to scale Status Communities and Status 1-to-1 Chat using existing Waku v2 protocols and components.
editor: Daniel Kaiser <danielkaiser@status.im> editor: Daniel Kaiser <danielkaiser@status.im>
contributors: contributors:
- Alvaro Revuelta <alrevuelta@status.im> - Alvaro Revuelta <alrevuelta@status.im>
@ -136,7 +137,7 @@ Status app could allocate more shard clusters, for instance to establish a test
We could add the shard cluster index to the community description as well. We could add the shard cluster index to the community description as well.
The recommendation for now is to keep it as a configuration option of the Status app. The recommendation for now is to keep it as a configuration option of the Status app.
> *Note*: Once this RFC moves forward, the new community description protobuf fields should be mentioned in [56/STATUS-COMMUNITIES](https://rfc.vac.dev/spec/56/). > *Note*: Once this RFC moves forward, the new community description protobuf fields should be mentioned in [56/STATUS-COMMUNITIES](/spec/56/).
Status communities can be mapped to shards in two ways: static, and owner-based. Status communities can be mapped to shards in two ways: static, and owner-based.
@ -259,7 +260,7 @@ Light protocols comprise
* [19/WAKU2-LIGHTPUSH](/spec/19/) for sending messages * [19/WAKU2-LIGHTPUSH](/spec/19/) for sending messages
* [12/WAKU2-FILTER](/spec/12/) for requesting messages with specific attributes * [12/WAKU2-FILTER](/spec/12/) for requesting messages with specific attributes
* [34/WAKU2-PEER-EXCHANGE](/spec/34) for discovering peers * [34/WAKU2-PEER-EXCHANGE](/spec/34/) for discovering peers
# Waku Archive # Waku Archive
@ -306,8 +307,8 @@ functionality offered by the libp2p circuit relay protocols, and
2) use [DCUtR](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md) to upgrade to a direct connection. 2) use [DCUtR](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md) to upgrade to a direct connection.
Nodes that do not announce themselves at all and only plan to use light protocols, Nodes that do not announce themselves at all and only plan to use light protocols,
MAY use rendezvous discovery instead of or along-side [34/WAKU2-PEER-EXCHANGE](/specs/34). MAY use rendezvous discovery instead of or along-side [34/WAKU2-PEER-EXCHANGE](/specs/34/).
For these nodes, rendezvous and [34/WAKU2-PEER-EXCHANGE](/specs/34) offer the same functionality, For these nodes, rendezvous and [34/WAKU2-PEER-EXCHANGE](/specs/34/) offer the same functionality,
but return node sets sampled in different ways. but return node sets sampled in different ways.
Using both can help increasing connectivity. Using both can help increasing connectivity.
@ -330,7 +331,7 @@ The app name, `my-app` is used to encode a single shard in the form:
<rs (utf8 encoded)> | <2-byte shard cluster index> | <2-byte shard index> <rs (utf8 encoded)> | <2-byte shard cluster index> | <2-byte shard index>
``` ```
Registering shard 2 in the Status shard cluster (with shard cluster index 16, see [52/WAKU2-RELAY-STATIC-SHARD-ALLOC](/spec/52/h)), Registering shard 2 in the Status shard cluster (with shard cluster index 16, see [52/WAKU2-RELAY-STATIC-SHARD-ALLOC](/spec/52/)),
the register query would look like the register query would look like
``` ```
@ -470,18 +471,26 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
# References # References
* [56/STATUS-COMMUNITIES](/spec/56/)
* [55/STATUS-1TO1-CHAT](/spec/55/)
* [23/WAKU2-TOPICS](/spec/23/)
* [11/WAKU2-RELAY](/spec/11/) * [11/WAKU2-RELAY](/spec/11/)
* [51/WAKU2-RELAY-SHARDING](/spec/51/) * [51/WAKU2-RELAY-SHARDING](/spec/51/)
* [33/WAKU2-DISCV5](/spec/33/) * [52/WAKU2-RELAY-STATIC-SHARD-ALLOC](/spec/52/)
* [13/WAKU2-STORE](/spec/13/) * [30/ADAPTIVE-NODES](/spec/30/)
* [19/WAKU2-LIGHTPUSH](/spec/19/) * [19/WAKU2-LIGHTPUSH](/spec/19/)
* [12/WAKU2-FILTER](/spec/12/) * [12/WAKU2-FILTER](/spec/12/)
* [34/WAKU2-PEER-EXCHANGE](/spec/34/) * [34/WAKU2-PEER-EXCHANGE](/spec/34/)
* [13/WAKU2-STORE](/spec/13/)
* [libp2p rendezvous](https://github.com/libp2p/specs/blob/master/rendezvous/README.md)
* [libp2p AutoNAT protocol](https://github.com/libp2p/specs/blob/master/autonat/README.md)
* [33/WAKU2-DISCV5](/spec/33/) * [33/WAKU2-DISCV5](/spec/33/)
* [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
* [libp2p circuit relay](https://github.com/libp2p/specs/blob/6634ca7abb2f955645243d48d1cd2fd02a8e8880/relay/circuit-v2.md) * [libp2p circuit relay](https://github.com/libp2p/specs/blob/6634ca7abb2f955645243d48d1cd2fd02a8e8880/relay/circuit-v2.md)
* [limiting](https://github.com/libp2p/specs/blob/6634ca7abb2f955645243d48d1cd2fd02a8e8880/relay/circuit-v2.md#reservation)
* [DCUtR](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md) * [DCUtR](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md)
* [scoring](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#extended-validators)
* [45/WAKU2-ADVERSARIAL-MODELS](/spec/45/)
## Informative
* [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
* [31/WAKU2-ENR](/spec/31/) * [31/WAKU2-ENR](/spec/31/)
* [45/WAKU2-ADVERSARIAL-MODELS](/spec/45)