Skip to content

Commit 9821445

Browse files
authored
docs(consensus): Update docs with seed peer list from main node (#3381)
1 parent 9a10dcf commit 9821445

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

docs/src/guides/advanced/16_decentralization.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ If you are using the recommended file-based configuration then you'll need to ad
3535
consensus:
3636
server_addr: '0.0.0.0:3054'
3737
public_addr:
38+
'???'
3839
# Address under which the node is accessible to the other nodes.
3940
# It can be a public domain, like `example.com:3054`, in case the main node is accessible from the internet,
4041
# or it can be a kubernetes cluster domain, like `server-v2-core.<cluster name>.svc.cluster.local:3054` in
@@ -46,9 +47,12 @@ consensus:
4647
chain_id: ??? # chain id
4748
protocol_version: 1 # consensus protocol version
4849
validators:
49-
- key: validator:public:??? # public key of the main node (copy this PUBLIC key from the secrets you generated)
50+
- key: validator:public:??? # validator public key of the main node (copy this PUBLIC key from the secrets you generated)
5051
weight: 1
5152
leader: validator:public:??? # same as above - main node will be the only validator and the only leader.
53+
seed_peers:
54+
- key: 'node:public:ed25519:...' # node public key of the main node (copy this PUBLIC key from the secrets you generated)
55+
addr: '???' # same as public_addr above
5256
```
5357
5458
And the secrets you generated to your `secrets.yaml` config file:
@@ -68,6 +72,7 @@ content:
6872
```yaml
6973
server_addr: '0.0.0.0:3054'
7074
public_addr:
75+
'???'
7176
# Address under which the node is accessible to the other nodes.
7277
# It can be a public domain, like `example.com:3054`, in case the main node is accessible from the internet,
7378
# or it can be a kubernetes cluster domain, like `server-v2-core.<cluster name>.svc.cluster.local:3054` in
@@ -79,9 +84,12 @@ genesis_spec:
7984
chain_id: ??? # chain id
8085
protocol_version: 1 # consensus protocol version
8186
validators:
82-
- key: validator:public:??? # public key of the main node (copy this PUBLIC key from the secrets you generated)
87+
- key: validator:public:??? # validator public key of the main node (copy this PUBLIC key from the secrets you generated)
8388
weight: 1
8489
leader: validator:public:??? # same as above - main node will be the only validator and the only leader.
90+
seed_peers:
91+
- key: 'node:public:ed25519:...' # node public key of the main node (copy this PUBLIC key from the secrets you generated)
92+
addr: '???' # same as public_addr above
8593
```
8694
8795
And a `consensus_secrets.yaml` file with the with the secrets you generated previously:

docs/src/guides/external-node/10_decentralization.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,6 @@ On the gossipnet, the data integrity will be protected by the BFT (byzantine fau
99

1010
## Enabling gossipnet on your node
1111

12-
> [!NOTE]
13-
>
14-
> Because the data transmitted over the gossipnet is signed by the main node (and eventually by the consensus quorum),
15-
> the signatures need to be backfilled to the node's local storage the first time you switch from centralized (ZKsync
16-
> API based) synchronization to the decentralized (gossipnet based) synchronization (this is a one-time thing). With the
17-
> current implementation it may take a couple of hours and gets faster the more nodes you add to the
18-
> `gossip_static_outbound` list (see below). We are working to remove this inconvenience.
19-
2012
> [!NOTE]
2113
>
2214
> The minimal supported server version for this is
@@ -65,9 +57,6 @@ for more details):
6557
your node from getting DoS`ed by too large network messages. Use the value from the template.
6658
- `gossip_dynamic_inbound_limit` - maximal number of unauthenticated concurrent inbound connections that can be
6759
established to your node. This is a DDoS protection measure.
68-
- `gossip_static_outbound` - list of trusted peers that your node should always try to connect to. The template contains
69-
the nodes maintained by Matterlabs, but you can add more if you know any. Note that the list contains both the network
70-
address AND the public key of the node - this prevents spoofing attacks.
7160

7261
### Setting environment variables
7362

0 commit comments

Comments
 (0)