Skip to content

Commit 537e6ad

Browse files
committed
refactor: replace "BFT nodes" with "Full nodes" in devnet
1 parent d415b23 commit 537e6ad

File tree

8 files changed

+35
-35
lines changed

8 files changed

+35
-35
lines changed

docs/website/root/manual/getting-started/run-mithril-devnet.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In this guide, you will learn how to run a demonstration of a **Mithril network*
1313
You can launch a private Mithril network using the following topology:
1414

1515
* `2` **Cardano nodes** configured as **stake pool operators (SPOs)** with a **Mithril signer** on top
16-
* `1` **Cardano node** configured as a **BFT node** with a **Mithril aggregator** on top
16+
* `1` **Cardano node** configured as a **Full node** with a **Mithril aggregator** on top
1717

1818
![Devnet Topology](images/devnet-topology.png)
1919

@@ -72,15 +72,15 @@ Open a terminal window. Run a devnet with one BTF and two SPO Cardano nodes.
7272
The network setup will be quicker when using remote Docker images:
7373

7474
```bash
75-
MITHRIL_IMAGE_ID=latest NUM_BFT_NODES=1 NUM_POOL_NODES=2 ./devnet-run.sh
75+
MITHRIL_IMAGE_ID=latest FULL_NODES=1 NUM_POOL_NODES=2 ./devnet-run.sh
7676
```
7777

7878
**Option 2**: Use local Docker images
7979

8080
Note that using local Docker images to build Mithril nodes may take more time:
8181

8282
```bash
83-
NUM_BFT_NODES=1 NUM_POOL_NODES=2 ./devnet-run.sh
83+
FULL_NODES=1 NUM_POOL_NODES=2 ./devnet-run.sh
8484
```
8585

8686
:::info
@@ -101,9 +101,9 @@ You should see the following information displayed:
101101
=====================================================================
102102

103103
>> Directory: artifacts
104-
>> Cardano BFT nodes: 1
104+
>> Cardano Full nodes: 1
105105
>> Cardano SPO nodes: 2
106-
>> Info: Mithril aggregator will be attached to the first Cardano BFT node
106+
>> Info: Mithril aggregator will be attached to the first Cardano Full node
107107
>> Info: Mithril signers will be attached to each Cardano SPO node
108108

109109
=====================================================================
@@ -112,7 +112,7 @@ You should see the following information displayed:
112112

113113
>> Start Cardano network
114114
cardano-node: no process found
115-
>> Starting Cardano node 'node-bft1'
115+
>> Starting Cardano node 'node-full1'
116116
>> Starting Cardano node 'node-pool1'
117117
>> Starting Cardano node 'node-pool2'
118118
>> Wait for Cardano network to be ready
@@ -340,7 +340,7 @@ mithril-signer-node-pool2_1 | {"msg":"Sleeping for 1000","v":0,"name":"slog-rs"
340340

341341
=====================================================================
342342
=====================================================================
343-
tail -n 22 ./node-bft1/node.log
343+
tail -n 22 ./node-full1/node.log
344344
=====================================================================
345345
[jp:cardano.node.ChainDB:Info:25] [2022-07-05 11:27:28.01 UTC] Took ledger snapshot DiskSnapshot {dsNumber = 219, dsSuffix = Nothing} at 075fc8366d353b45debedfc6faa92148c8fad584d81dbb4ea7b8b4d121489452 at slot 219
346346
[jp:cardano.node.ChainDB:Notice:21] [2022-07-05 11:27:40.76 UTC] Chain extended, new tip: af93c6964de49d0696bf194c222f6e5a40e5123ef688a20613a33a705b6b736a at slot 253

mithril-test-lab/mithril-devnet/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
It scaffolds a private compound devnet with Cardano and Mithril nodes:
66

7-
* `N` Cardano BFT nodes
7+
* `N` Cardano Full nodes
88
* `P` Cardano SPO nodes
9-
* `1` Mithril Aggregator node (attached to the first Cardano BFT node)
9+
* `1` Mithril Aggregator node (attached to the first Cardano Full node)
1010
* `P` Mithril Signer nodes (attached to each Cardano SPO nodes)
1111

1212
## Credits
@@ -34,10 +34,10 @@ chmod u+x *.sh
3434
## One step run with default configuration
3535

3636
```bash
37-
# Run devnet with 1 BFT node and 2 SPO nodes (with local docker images)
37+
# Run devnet with 1 Full node and 2 SPO nodes (with local docker images)
3838
./devnet-run.sh
3939

40-
# Run devnet with 1 BFT node and 2 SPO nodes (with remote docker images)
40+
# Run devnet with 1 Full node and 2 SPO nodes (with remote docker images)
4141
MITHRIL_IMAGE_ID=main-c9213ca ./devnet-run.sh
4242

4343
# Run devnet with Cardano nodes only
@@ -89,8 +89,8 @@ NODES=mithril ./devnet-query.sh
8989
## One step run with custom configuration
9090

9191
```bash
92-
# Run devnet with 2 BFT nodes and 5 SPO nodes
93-
ARTIFACTS_DIR=artifacts NUM_BFT_NODES=2 NUM_POOL_NODES=5 ./devnet-run.sh
92+
# Run devnet with 2 Full nodes and 5 SPO nodes
93+
ARTIFACTS_DIR=artifacts NUM_FULL_NODES=2 NUM_POOL_NODES=5 ./devnet-run.sh
9494

9595
# Run devnet custom slot length (0.5s) and custom epoch length (120s)
9696
# Slot length: the duration of a Cardano Eslot (can help modulate the immutables creation rate)
@@ -115,11 +115,11 @@ ARTIFACTS_DIR=artifacts ./devnet-visualize.sh
115115
```bash
116116
# Parameters
117117
ARTIFACTS_DIR=artifacts # Directory where artifacts are produced
118-
NUM_BFT_NODES=1 # Number of Cardano BFT nodes
118+
NUM_FULL_NODES=1 # Number of Cardano Full nodes
119119
NUM_POOL_NODES=3 # Number of Cardano SPO nodes
120120

121-
# Bootstrap devnet with 1 BFT nodes and 3 SPO nodes
122-
rm -rf ${ARTIFACTS_DIR} && ./devnet-mkfiles.sh ${ARTIFACTS_DIR} ${NUM_BFT_NODES} ${NUM_POOL_NODES}
121+
# Bootstrap devnet with 1 Full node and 3 SPO nodes
122+
rm -rf ${ARTIFACTS_DIR} && ./devnet-mkfiles.sh ${ARTIFACTS_DIR} ${NUM_FULL_NODES} ${NUM_POOL_NODES}
123123

124124
# Change directory
125125
cd ${ARTIFACTS_DIR}
@@ -169,7 +169,7 @@ artifacts
169169
├── cardano-node
170170
├── docker-compose.yaml
171171
├── log.sh
172-
├── node-bft1
172+
├── node-full1
173173
│ ├── byron
174174
│ │ ├── delegate.cert
175175
│ │ ├── delegate.key

mithril-test-lab/mithril-devnet/devnet-run.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ fi
4343

4444
# Start devnet Mithril nodes
4545
if [ "${NODES}" = "mithril" ] || [ "${NODES}" = "*" ]; then
46-
echo ">> Info: Mithril Aggregator will be attached to the first Cardano BFT node"
46+
echo ">> Info: Mithril Aggregator will be attached to the first Cardano Full node"
4747
echo ">> Info: Mithril Signers will be attached to each Cardano SPO node"
4848
echo "====================================================================="
4949
echo " Start Mithril nodes"

mithril-test-lab/mithril-devnet/mkfiles/mkfiles-docker.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ version: "3.9"
1010
services:
1111
EOF
1212

13-
for NODE in ${BFT_NODES}; do
13+
for NODE in ${FULL_NODES}; do
1414

1515
PORT=$(cat ${NODE}/port)
1616
HOST=$(cat ${NODE}/host)
@@ -104,7 +104,7 @@ EOF
104104

105105
done
106106

107-
for NODE in ${BFT_NODES}; do
107+
for NODE in ${FULL_NODES}; do
108108

109109
cat >> docker-compose.yaml <<EOF
110110
mithril-aggregator:

mithril-test-lab/mithril-devnet/mkfiles/mkfiles-init.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ fi
2929
if [ -z "${HARD_FORK_CONWAY_AT_EPOCH}" ]; then
3030
HARD_FORK_CONWAY_AT_EPOCH=0
3131
fi
32-
if [ -z "${NUM_BFT_NODES}" ]; then
33-
NUM_BFT_NODES="1"
32+
if [ -z "${NUM_FULL_NODES}" ]; then
33+
NUM_FULL_NODES="1"
3434
fi
3535
if [ -z "${NUM_POOL_NODES}" ]; then
3636
NUM_POOL_NODES="2"
@@ -49,7 +49,7 @@ DEVNET_VERSION=$(cat VERSION)
4949
# Display configuration summary
5050
echo ">> Devnet Version: ${DEVNET_VERSION}"
5151
echo ">> Artifacts Directory[env::ARTIFACTS_DIR]: ${ARTIFACTS_DIR}"
52-
echo ">> Cardano BFT nodes [env::NUM_BFT_NODES]: ${NUM_BFT_NODES}"
52+
echo ">> Cardano Full nodes [env::NUM_FULL_NODES]: ${NUM_FULL_NODES}"
5353
echo ">> Cardano SPO nodes [env::NUM_POOL_NODES]: ${NUM_POOL_NODES}"
5454
echo ">> Cardano Node Version [env::CARDANO_NODE_VERSION]: ${CARDANO_NODE_VERSION}"
5555
echo ">> Cardano Network Magic [env::NETWORK_MAGIC]: ${NETWORK_MAGIC}"

mithril-test-lab/mithril-devnet/mkfiles/mkfiles-start.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ set -e
1212
1313
EOF
1414

15-
for NODE in ${BFT_NODES}; do
15+
for NODE in ${FULL_NODES}; do
1616
cat >> ${NODE}/start-node.sh <<EOF
1717
#!/usr/bin/env bash
1818

mithril-test-lab/mithril-devnet/mkfiles/mkfiles-topology.sh

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
NODE_PORT_START=3000
33

44
# Create network topology
5-
BFT_NODES=()
6-
BFT_NODES_N=()
7-
for (( i=1; i<=${NUM_BFT_NODES}; i++ ))
5+
FULL_NODES=()
6+
FULL_NODES_N=()
7+
for (( i=1; i<=${NUM_FULL_NODES}; i++ ))
88
do
9-
BFT_NODES=("${BFT_NODES[@]}" "node-bft${i}")
10-
BFT_NODES_N=("${BFT_NODES_N[@]}" "${i}")
9+
FULL_NODES=("${FULL_NODES[@]}" "node-full${i}")
10+
FULL_NODES_N=("${FULL_NODES_N[@]}" "${i}")
1111
done
12-
BFT_NODES=${BFT_NODES[@]}
13-
BFT_NODES_N=${BFT_NODES_N[@]}
12+
FULL_NODES=${FULL_NODES[@]}
13+
FULL_NODES_N=${FULL_NODES_N[@]}
1414

1515
POOL_NODES=()
1616
POOL_NODES_N=()
@@ -31,7 +31,7 @@ UTXO_ADDRS=${UTXO_ADDRS[@]}
3131
USER_ADDRS=${USER_ADDRS[@]}
3232
POOL_ADDRS=${POOL_ADDRS[@]}
3333

34-
ALL_NODES="${BFT_NODES} ${POOL_NODES}"
34+
ALL_NODES="${FULL_NODES} ${POOL_NODES}"
3535

3636
# create the node directories
3737
for NODE in ${ALL_NODES}; do
@@ -43,7 +43,7 @@ NODE_ADDR=$LISTENING_ADDR
4343
NODE_PORT=NODE_PORT_START
4444
TOPOLOGY='{"Producers": []}'
4545
TOPOLOGY_DOCKER=$TOPOLOGY
46-
for NODE in ${BFT_NODES}; do
46+
for NODE in ${FULL_NODES}; do
4747
NODE_PORT=$(( ${NODE_PORT} + 1))
4848
echo ${NODE_PORT} > ${NODE}/port
4949
echo ${LISTENING_ADDR} > ${NODE}/host
@@ -56,7 +56,7 @@ for NODE in ${POOL_NODES}; do
5656
done
5757
echo $TOPOLOGY | jq . > topology.json
5858

59-
for NODE in ${BFT_NODES}; do
59+
for NODE in ${FULL_NODES}; do
6060
cat topology.json > ${NODE}/topology.json
6161
done
6262
NODE_IX=0

mithril-test-lab/mithril-end-to-end/src/devnet/runner.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ impl Devnet {
8686
"ARTIFACTS_DIR",
8787
bootstrap_args.artifacts_target_dir.to_str().unwrap(),
8888
);
89-
bootstrap_command.env("NUM_BFT_NODES", 0.to_string());
89+
bootstrap_command.env("NUM_FULL_NODES", 0.to_string());
9090
bootstrap_command.env(
9191
"NUM_POOL_NODES",
9292
bootstrap_args.number_of_pool_nodes.to_string(),

0 commit comments

Comments
 (0)