Skip to content

Commit ff87c84

Browse files
authored
Update Waku Links (#104)
Change Waku links that do not point to master waku/specs repo. Also update title for template, to look better on the rfc website.
1 parent e60519b commit ff87c84

File tree

8 files changed

+37
-37
lines changed

8 files changed

+37
-37
lines changed

status/raw/simple-scaling.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ efficient way will be part of a future document.
6363
Sharding the [11/WAKU2-RELAY](../../waku/standards/core/11/relay.md)
6464
network is an integral part of scaling the Status app.
6565

66-
[51/WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md)
66+
[WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)
6767
specifies shards clusters, which are sets of `1024` shards
6868
(separate pubsub mesh networks).
6969
Content topics specified by application protocols can be distributed over these shards.
7070
The Status app protocols are assigned to shard cluster `16`,
71-
as defined in [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/waku-RFC/informational/relay-static-shard-alloc.md).
71+
as defined in [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/master/informational/relay-static-shard-alloc.md).
7272

73-
[WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md)
73+
[WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)
7474
specifies three sharding methods.
7575
This document uses *static sharding*,
7676
which leaves the distribution of content topics to application protocols,
@@ -88,7 +88,7 @@ The 1024 shards within the main Status shard cluster are allocated as follows.
8888
| 768 - 895 | 1:1 chat |
8989
| 896 - 1023 | media and control msgs |
9090

91-
Shard indices are mapped to pubsub topic names as follows (specified in [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md)).
91+
Shard indices are mapped to pubsub topic names as follows (specified in [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)).
9292

9393
`/waku/2/rs/<cluster_id>/<shard_number>`
9494

@@ -154,7 +154,7 @@ message CommunityDescription {
154154
}
155155
```
156156

157-
> *Note*: Currently, Status app has allocated shared cluster `16` in [52/WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/waku-RFC/informational/relay-static-shard-alloc.md).
157+
> *Note*: Currently, Status app has allocated shared cluster `16` in [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/master/informational/relay-static-shard-alloc.md).
158158
Status app could allocate more shard clusters, for instance to establish a test net.
159159
We could add the shard cluster index to the community description as well.
160160
The recommendation for now,
@@ -168,7 +168,7 @@ Status communities can be mapped to shards in two ways: static, and owner-based.
168168

169169
With static mapping,
170170
communities are assigned a specific shard index within the Status shard cluster.
171-
This mapping is similar in nature to the shard cluster allocation in [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/waku-RFC/informational/relay-static-shard-alloc.md).
171+
This mapping is similar in nature to the shard cluster allocation in [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/master/informational/relay-static-shard-alloc.md).
172172
Shard indices allocated in that way are in the range `16 - 127`.
173173
The Status CC community uses index `16`
174174
(not to confuse with shard cluster index `16`, which is the Status shard cluster).
@@ -310,7 +310,7 @@ Light protocols comprise
310310
* [19/WAKU2-LIGHTPUSH](../../waku/standards/core/19/lightpush.md) for sending messages
311311
* [12/WAKU2-FILTER](../../waku/standards/core/12/filter.md)
312312
for requesting messages with specific attributes
313-
* [WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/peer-exchange/peer-exchange.md)
313+
* [WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/master/standards/core/peer-exchange.md)
314314
for discovering peers
315315

316316
## Waku Archive
@@ -333,7 +333,7 @@ In fact, the archive service can be offered by infrastructure nodes.
333333

334334
## Discovery
335335

336-
Shard discovery is covered by [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md).
336+
Shard discovery is covered by [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md).
337337
This allows the Status app to abstract from the discovery process and
338338
simply address shards by their index.
339339

@@ -344,7 +344,7 @@ this document suggests using [libp2p rendezvous](https://github.com/libp2p/specs
344344
Nodes can check whether they are behind a restrictive NAT using the
345345
[libp2p AutoNAT protocol](https://github.com/libp2p/specs/blob/master/autonat/README.md).
346346

347-
> *Note:* The following will move into [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md),
347+
> *Note:* The following will move into [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md),
348348
or [33/WAKU2-DISCV5](../../waku/standards/core/33/discv5.md):
349349
Nodes behind restrictive NATs SHOULD not announce their publicly unreachable address
350350
via [33/WAKU2-DISCV5](../../waku/standards/core/33/discv5.md) discovery.
@@ -369,9 +369,9 @@ functionality offered by the libp2p circuit relay protocols, and
369369
to upgrade to a direct connection.
370370

371371
Nodes that do not announce themselves at all and only plan to use light protocols,
372-
MAY use rendezvous discovery instead of or along-side [WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/peer-exchange/peer-exchange.md).
372+
MAY use rendezvous discovery instead of or along-side [WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/master/standards/core/peer-exchange.md).
373373
For these nodes, rendezvous and
374-
[WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/peer-exchange/peer-exchange.md)
374+
[WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/master/standards/core/peer-exchange.md)
375375
offer the same functionality,
376376
but return node sets sampled in different ways.
377377
Using both can help increasing connectivity.
@@ -401,7 +401,7 @@ The string conversion SHOULD remove leading zeros.
401401
field is of type string, a more efficient byte encoding is not utilized.
402402

403403
Registering shard 2 in the Status shard cluster (with shard cluster index 16,
404-
see [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/waku-RFC/informational/relay-static-shard-alloc.md),
404+
see [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/master/informational/relay-static-shard-alloc.md),
405405
the register query would look like
406406

407407
```rs
@@ -601,7 +601,7 @@ It could be rate-limited with RLN.
601601

602602
This document makes several trade-offs to privacy and anonymity.
603603
Todo: elaborate.
604-
See [WAKU2-ADVERSARIAL-MODELS](https://github.com/waku-org/specs/blob/waku-RFC/informational/adversarial-models.md)
604+
See [WAKU2-ADVERSARIAL-MODELS](https://github.com/waku-org/specs/blob/master/informational/adversarial-models.md)
605605
for information on Waku Anonymity.
606606

607607
## Copyright
@@ -614,12 +614,12 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
614614
* [55/STATUS-1TO1-CHAT](../55/1to1-chat.md)
615615
* [23/WAKU2-TOPICS](../../waku/informational/23/topics.md)
616616
* [11/WAKU2-RELAY](../../waku/standards/core/11/relay.md)
617-
* [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md)
618-
* [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/waku-RFC/informational/relay-static-shard-alloc.md)
617+
* [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)
618+
* [WAKU2-RELAY-STATIC-SHARD-ALLOC](https://github.com/waku-org/specs/blob/master/informational/relay-static-shard-alloc.md)
619619
* [30/ADAPTIVE-NODES](../../waku/informational/30/adaptive-nodes.md)
620620
* [19/WAKU2-LIGHTPUSH](../../waku/standards/core/19/lightpush.md)
621621
* [12/WAKU2-FILTER](../../waku/standards/core/12/filter.md)
622-
* [WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/peer-exchange/peer-exchange.md)
622+
* [WAKU2-PEER-EXCHANGE](https://github.com/waku-org/specs/blob/master/standards/core/peer-exchange.md)
623623
* [13/WAKU2-STORE](../../waku/standards/core/13/store.md)
624624
* [libp2p rendezvous](https://github.com/libp2p/specs/blob/master/rendezvous/README.md)
625625
* [libp2p AutoNAT protocol](https://github.com/libp2p/specs/blob/master/autonat/README.md)
@@ -629,9 +629,9 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
629629
* [DCUtR](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md)
630630
* [scoring](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#extended-validators)
631631
* [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
632-
* [WAKU2-ADVERSARIAL-MODELS](https://github.com/waku-org/specs/blob/waku-RFC/informational/adversarial-models.md)
632+
* [WAKU2-ADVERSARIAL-MODELS](https://github.com/waku-org/specs/blob/master/informational/adversarial-models.md)
633633

634634
## Informative
635635

636636
* [Circuit Relay](https://docs.libp2p.io/concepts/nat/circuit-relay/)
637-
* [WAKU2-ENR](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/enr.md)
637+
* [WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md)

status/raw/url-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ this specification proposes a standard method for encoding data within URLs.
2626
- Community: Refer to [STATUS-COMMUNITIES](../56/communities.md)
2727
- Channel: Refer to terminology in [STATUS-COMMUNITIES](../56/communities.md)
2828
- User: Refer to terminology in [STATUS-COMMUNITIES](../56/communities.md)
29-
- Shard Refer to terminology in [51/WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)
29+
- Shard Refer to terminology in [WAKU2-RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)
3030

3131
## Wire Format
3232

vac/template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
slug: XX
3-
title: XX/(WAKU2|LOGOS|CODEX|*)-TEMPLATE
4-
name: (Waku v2 | Logos | Codex) RFC Template
5-
status: (raw|draft|stable)
6-
category: (Standards Track|Informational|Best Current Practice)
3+
title: TEMPLATE
4+
name: RFC Template
5+
status: raw/draft/stable/deprecated
6+
category: Standards Track/Informational/Best Current Practice
77
tags: an optional list of tags, not standard
88
editor: Daniel Kaiser <danielkaiser@status.im>
99
contributors:

waku/informational/23/topics.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ In [10/WAKU2 spec](../../standards/core/10/waku2.md) there are two types of topi
1919
## Pubsub Topics
2020

2121
Pubsub topics are used for routing of messages (see [11/WAKU2-RELAY](../../standards/core/11/relay.md)),
22-
and can be named implicitly by Waku sharding (see [RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md)).
22+
and can be named implicitly by Waku sharding (see [RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)).
2323
This document comprises recommendations for explicitly naming pubsub topics
24-
(e.g. when choosing *named sharding* as specified in [RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md)).
24+
(e.g. when choosing *named sharding* as specified in [RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)).
2525

2626
### Pubsub Topic Format
2727

@@ -80,7 +80,7 @@ but for different domains completely.
8080

8181
### Named Topic Sharding Example
8282

83-
The following is an example of named sharding, as specified in [RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md).
83+
The following is an example of named sharding, as specified in [RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md).
8484

8585
```text
8686
waku/2/waku-9_shard-0/
@@ -175,7 +175,7 @@ Copyright and related rights waived via
175175

176176
- [10/WAKU2 spec](../../standards/core/10/waku2.md)
177177
- [11/WAKU2-RELAY](../../standards/core/11/relay.md)
178-
- [RELAY-SHARDING](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/relay-sharding.md)
178+
- [RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)
179179
- [Ethereum 2 P2P spec](https://github.com/ethereum/eth2.0-specs/blob/dev/specs/phase0/p2p-interface.md#topics-and-messages)
180180
- [14/WAKU2-MESSAGE](../../standards/core/14/message.md)
181181
- [12/WAKU2-FILTER](../../standards/core/12/filter.md)

waku/standards/core/10/waku2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ It is possible to bypass the discovery domain by specifying static nodes.
224224

225225
#### Use of ENR
226226

227-
[31/WAKU2-ENR](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/enr.md)
227+
[WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md)
228228
describes the usage of [EIP-778 ENR (Ethereum Node Records)](https://eips.ethereum.org/EIPS/eip-778)
229229
for Waku v2 discovery purposes.
230230
It introduces two new ENR fields, `multiaddrs` and
@@ -574,7 +574,7 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
574574

575575
17. [Node Discovery v5](https://github.com/ethereum/devp2p/blob/8fd5f7e1c1ec496a9d8dc1640a8548b8a8b5986b/discv5/discv5.md)
576576

577-
18. [31/WAKU2-ENR](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/enr.md)
577+
18. [WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md)
578578

579579
19. [EIP-778 ENR (Ethereum Node Records)](https://eips.ethereum.org/EIPS/eip-778)
580580

waku/standards/core/14/message.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ The key agreement is performed out of band.
118118
And provides an encrypted signature and padding for some form of unlinkability.
119119

120120
- **Version 2:**
121-
The payload SHOULD be encoded according to [35/WAKU2-NOISE]([/spec/35](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/noise.md)).
121+
The payload SHOULD be encoded according to [WAKU2-NOISE](https://github.com/waku-org/specs/blob/master/standards/application/noise.md).
122122
Waku Noise protocol provides symmetric encryption and asymmetric key exchange.
123123

124124
Any `version` value not included in this list is reserved for future specification.
@@ -254,5 +254,5 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
254254
- [6/WAKU1](../../legacy/6/waku1.md)
255255
- [Google Protocol buffers v3](https://developers.google.com/protocol-buffers/)
256256
- [26/WAKU-PAYLOAD](../../application/26/payload.md)
257-
- [35/WAKU2-NOISE]([/spec/35](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/noise.md))
257+
- [WAKU2-NOISE](https://github.com/waku-org/specs/blob/master/standards/application/noise.md)
258258
- [62/STATUS-PAYLOADS](../../../../status/62/payloads.md/#clock-vs-timestamp-and-message-ordering)

waku/standards/core/19/lightpush.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ message PushRPC {
5050
Nodes that respond to `PushRequests` MUST either
5151
relay the encapsulated message via [11/WAKU2-RELAY](../11/relay.md) protocol
5252
on the specified `pubsub_topic`,
53-
or forward the `PushRequest` via 19/LIGHTPUSH on a [WAKU2-DANDELION](https://github.com/waku-org/specs/blob/waku-RFC/standards/application/dandelion.md)
53+
or forward the `PushRequest` via 19/LIGHTPUSH on a [WAKU2-DANDELION](https://github.com/waku-org/specs/blob/master/standards/application/dandelion.md)
5454
stem.
5555
If they are unable to do so for some reason,
5656
they SHOULD return an error code in `PushResponse`.
@@ -71,5 +71,5 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
7171
## References
7272

7373
* [11/WAKU2-RELAY](../11/relay.md)
74-
* [WAKU2-DANDELION](https://github.com/waku-org/specs/blob/waku-RFC/standards/application/dandelion.md)
74+
* [WAKU2-DANDELION](https://github.com/waku-org/specs/blob/master/standards/application/dandelion.md)
7575
* [17/WAKU2-RLN-RELAY](../17/rln-relay.md)

waku/standards/core/33/discv5.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ within the network.
4141
in order of increasing decentralization
4242

4343
* hard coded bootstrap nodes
44-
* [`DNS discovery`](https://rfc.vac.dev/spec/10/#discovery-domain) (based on [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459))
44+
* [`DNS discovery`](../10/waku2.md/#discovery-domain) (based on [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459))
4545
* `peer-exchange` (work in progress)
4646
* `33/WAKU2-DISCV5` (specified in this document)
4747

@@ -74,7 +74,7 @@ This also increases decentralization.
7474
isolated from the Ethereum Discovery v5 network.
7575

7676
Another simple solution would be taking part in the Ethereum Discovery network,
77-
and filtering Waku nodes based on whether they support [WAKU2-ENR](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/enr.md).
77+
and filtering Waku nodes based on whether they support [WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md).
7878
This solution is more resilient towards eclipse attacks.
7979
However, this discovery method is very inefficient
8080
for small percentages of Waku nodes
@@ -206,12 +206,12 @@ raises research questions that we will address in future stages of our discv5 ro
206206

207207
1. [10/WAKU2](../10/waku2.md)
208208
1. [11/WAKU2-RELAY](../11/relay.md)
209-
1. [`WAKU2-ENR`](https://github.com/waku-org/specs/blob/waku-RFC/standards/core/enr.md)
209+
1. [WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md)
210210
1. [Node Discovery Protocol v5 (`discv5`)](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md)
211211
1. [`discv5` semantics](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md).
212212
1. [`discv5` wire protocol](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-wire.md)
213213
1. [`discv5` topic discovery](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md#topic-advertisement)
214-
1. [Waku DNS discovery](https://rfc.vac.dev/spec/10/#discovery-domain)
214+
1. [Waku DNS discovery](../10/waku2.md/#discovery-domain)
215215
1. [libp2p AutoNAT protocol](https://github.com/libp2p/specs/blob/master/autonat/README.md)
216216
1. [`EIP-1459`](https://eips.ethereum.org/EIPS/eip-1459)
217217
1. [`GossipSub`](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md)

0 commit comments

Comments
 (0)