Skip to content
This repository was archived by the owner on Dec 26, 2024. It is now read-only.

Commit d05fefc

Browse files
feat(consensus): update README for running milestone 2 (#2190)
1 parent 4038a34 commit d05fefc

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

crates/sequencing/papyrus_consensus/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,19 @@ versions. Breaking changes are expected to happen in the near future.
1111
2. Start by running any nodes which are validators for `consensus.start_height` which is by default 0 to avoid them missing the proposal.
1212
1. You can change the default topic by adding: `--consensus.topic "TOPIC"`
1313

14-
Bootstrap Node - this must be run first:
14+
#### Bootstrap Node
15+
This must be run first:
1516
```
1617
cargo run --package papyrus_node --bin papyrus_node -- --base_layer.node_url <ETH_NODE_URL> --network.#is_none false --consensus.#is_none false --consensus.validator_id 0x1 --storage.db_config.path_prefix <UNIQUE>
1718
```
1819
- This will log `local_peer_id` which is used by other nodes. (Alternatively pass `network.secret_key` to have a fixed peer id).
1920

20-
Other Nodes - the last run should use `--consensus.validator_id 0x0`.
21+
#### Other Nodes
22+
2123
```
2224
cargo run --package papyrus_node --bin papyrus_node -- --base_layer.node_url <ETH_NODE_URL> --network.#is_none false --consensus.#is_none false --consensus.validator_id 0x<UNIQUE> --network.tcp_port <UNIQUE> --network.bootstrap_peer_multiaddr.#is_none false --rpc.server_address 127.0.0.1:<UNIQUE> --monitoring_gateway.server_address 127.0.0.1:<UNIQUE> --storage.db_config.path_prefix <UNIQUE> --network.bootstrap_peer_multiaddr /ip4/127.0.0.1/tcp/10000/p2p/<BOOT_NODE_PEER_ID>
2325
```
26+
- The validator set, (0, 1, 2, 3), is hardcoded in milestone 2.
27+
- Node 0 is the first proposer and should be run last.
2428

2529
UNIQUE - a value unique among all nodes running locally.

0 commit comments

Comments
 (0)