Skip to content

Commit c9a5692

Browse files
authored
docs(readme): clarify bootstrap and test instructions (#3220)
Improve wording and formatting in the bootstrap template README for better clarity. Update instructions for configuration, faucet setup, node and db-sync startup, and running tests. Fix script names and provide clearer guidance on using synced data and environment variables.
1 parent b42f344 commit c9a5692

File tree

1 file changed

+34
-28
lines changed

1 file changed

+34
-28
lines changed

testnets_bootstrap_template/README.md

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,65 +4,71 @@ Testnet Bootstrap
44
Configuration
55
-------------
66

7-
* Rename the directory to eg. `preview_bootstrap`
8-
* Go to <https://book.world.dev.cardano.org/environments.html>
9-
and download genesis and configuration files
10-
* Replace the empty placeholder files with the downloaded files, so the file names are preserved
11-
* Make sure the `config-relay1.json` points to correct names of the genesis files (the file names differ from the downloaded ones)
7+
* Copy and rename this directory, for example to `preview_bootstrap`.
8+
* Visit <https://book.world.dev.cardano.org/environments.html>
9+
and download the genesis and configuration files.
10+
* Replace the empty placeholder files in this directory with the downloaded files, preserving the original file names.
11+
* Ensure that `config-relay1.json` references the correct genesis file names (these typically differ from the downloaded names).
1212

13-
Nix shell
13+
Nix Shell
1414
---------
1515

16-
The assumption is you are running all the following commands in the DevOps nix-shell.
16+
All commands below assume you are running inside the DevOps Nix shell.
1717

1818
Faucet
1919
------
2020

21-
* If you already have an address on the testnet, create a `shelley/faucet.addr` file with the address,
22-
and `shelley/faucet.vkey` and `shelley/faucet.skey` with the corresponding keys
23-
* OR run the `faucet_setup.sh` script. Export `TESTNET_NAME` and optionally `APIKEY`
21+
* If you already have a testnet address, create `shelley/faucet.addr` with the address,
22+
and add `shelley/faucet.vkey` and `shelley/faucet.skey` with the corresponding keys.
23+
* **Or** run the `faucet_setup.sh` script. Export `TESTNET_NAME` and optionally `APIKEY` before running it.
2424

25-
Running the node
25+
Running the Node
2626
----------------
2727

28-
* Run the `run_relay1.sh` script
29-
* Wait until the node is synced (check in another terminal window)
28+
* Run the `run_relay1.sh` script.
29+
* Wait until the node is fully synced (you can monitor progress from another terminal).
3030

31-
Running the db-sync
32-
--------------------
31+
Running db-sync
32+
---------------
3333

34-
* Set the `CARDANO_NODE_SOCKET_PATH`: `export CARDANO_NODE_SOCKET_PATH=$PWD/relay1.socket`
35-
* When you don't have db and snapshot for the given testnet available, start & setup postgres with clean db
34+
* Set the `CARDANO_NODE_SOCKET_PATH`:
35+
36+
```sh
37+
export CARDANO_NODE_SOCKET_PATH=$PWD/relay1.socket
38+
```
39+
40+
* If you **do not** already have a database and snapshot for the given testnet, start Postgres with a clean database:
3641

3742
```sh
3843
/path/to/cardano-node-tests-repo/scripts/postgres-start.sh ~/tmp/postgres-for-testnet/ -k
3944
./postgres-setup.sh
4045
```
4146

42-
* When you already have db and snapshot for the given testnet available, start postgres with correct data
47+
* If you **do** already have a database and snapshot, start Postgres using the existing data:
4348

4449
```sh
4550
/path/to/cardano-node-tests-repo/scripts/postgres-start.sh ~/tmp/postgres-for-testnet/
4651
```
4752

48-
* Start db-sync ONLY AFTER the node is fully synced:
53+
* Start db-sync **only after the node is fully synced**:
4954

5055
```sh
51-
./run-cardano-dbsync
56+
./run_dbsync.sh
5257
```
5358

54-
* Wait until the db-sync is fully synced
59+
* Wait until db-sync has fully synced.
5560

56-
Running tests
61+
Running Tests
5762
-------------
5863

59-
Once the node and optionally db-sync are fully synced, you can stop them and start the tests.
60-
Note that the testing framework will start node and db-sync processes automatically. It will use the synced states of both node and db-sync if available in the bootstrap directory.
64+
Once the node and (optionally) db-sync are fully synced, you can stop them and run the tests.
65+
The testing framework will start fresh node and db-sync processes automatically, and will reuse
66+
the synced data from the bootstrap directory.
6167

62-
* open another terminal
63-
* cd to `cardano-node-tests` repository
64-
* run the tests
68+
* Open another terminal.
69+
* Change to the `cardano-node-tests` repository.
70+
* Run the tests:
6571

6672
```sh
67-
NODE_REV=10.4.1 BOOTSTRAP_DIR=~/path/to/preview_bootstrap ./.github/regression.sh
73+
NODE_REV=10.5.1 BOOTSTRAP_DIR=~/path/to/preview_bootstrap ./.github/regression.sh
6874
```

0 commit comments

Comments
 (0)