Skip to content

Commit e5b6270

Browse files
committed
Remove useless Cardano network references related to mithril-client-cli
1 parent 09eb684 commit e5b6270

File tree

5 files changed

+12
-23
lines changed

5 files changed

+12
-23
lines changed

docs/website/root/manual/developer-docs/nodes/mithril-client.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Run in release mode with a specific mode:
168168
Run in release mode with a custom configuration using environment variables:
169169

170170
```bash
171-
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) NETWORK=**YOUR_CARDANO_NETWORK** AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT** ./mithril-client
171+
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT** ./mithril-client
172172
```
173173

174174
:::tip
@@ -207,7 +207,6 @@ To prepare the environment variables, retrieve the values from the above **Mithr
207207

208208
```bash
209209
export MITHRIL_IMAGE_ID=**YOUR_MITHRIL_IMAGE_ID**
210-
export NETWORK=**YOUR_CARDANO_NETWORK**
211210
export AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
212211
export GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**)
213212
export SNAPSHOT_DIGEST=latest
@@ -217,7 +216,6 @@ Here is an example configuration for the `release-preprod` network and the `late
217216

218217
```bash
219218
export MITHRIL_IMAGE_ID=latest
220-
export NETWORK=preprod
221219
export AGGREGATOR_ENDPOINT=https://aggregator.release-preprod.api.mithril.network/aggregator
222220
export GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/mithril-infra/configuration/release-preprod/genesis.vkey)
223221
export SNAPSHOT_DIGEST=latest
@@ -227,7 +225,7 @@ Proceed by creating a shell function for the Mithril client:
227225

228226
```bash
229227
mithril_client () {
230-
docker run --rm -e NETWORK=$NETWORK -e GENESIS_VERIFICATION_KEY=$GENESIS_VERIFICATION_KEY -e AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT --name='mithril-client' -v $(pwd):/app/data -u $(id -u) ghcr.io/input-output-hk/mithril-client:$MITHRIL_IMAGE_ID $@
228+
docker run --rm -e GENESIS_VERIFICATION_KEY=$GENESIS_VERIFICATION_KEY -e AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT --name='mithril-client' -v $(pwd):/app/data -u $(id -u) ghcr.io/input-output-hk/mithril-client:$MITHRIL_IMAGE_ID $@
231229
}
232230
```
233231

@@ -336,7 +334,6 @@ Here is a list of the available parameters:
336334
| `verbose` | `--verbose` | `-v` | `VERBOSE` | Verbosity level | - | Parsed from the number of occurrences: `-v` for `Warning`, `-vv` for `Info`, `-vvv` for `Debug` and `-vvvv` for `Trace` | :heavy_check_mark: |
337335
| `unstable` | `--unstable` | - | - | Enable unstable commands | - | - | - |
338336
| `run_mode` | `--run-mode` | - | `RUN_MODE` | Runtime mode | `dev` | - | :heavy_check_mark: |
339-
| `network` | - | - | `NETWORK` | Cardano network | - | `testnet` or `mainnet` or `devnet` | :heavy_check_mark: |
340337
| `aggregator_endpoint` | `--aggregator-endpoint` | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | :heavy_check_mark: |
341338
| `genesis_verification_key` | - | - | `GENESIS_VERIFICATION_KEY` | Genesis verification key | - | - | :heavy_check_mark: |
342339
| `log_format_json` | `--log-format-json` | - | - | Enable JSON output for logs | - | - | - |

docs/website/root/manual/getting-started/bootstrap-cardano-node.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ Then, create a shell function for the Mithril client:
186186

187187
```bash
188188
mithril_client () {
189-
docker run --rm -e NETWORK=$NETWORK -e GENESIS_VERIFICATION_KEY=$GENESIS_VERIFICATION_KEY -e AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT --name='mithril-client' -v $(pwd):/app/data -u $(id -u) ghcr.io/input-output-hk/mithril-client:$MITHRIL_IMAGE_ID $@
189+
docker run --rm -e GENESIS_VERIFICATION_KEY=$GENESIS_VERIFICATION_KEY -e AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT --name='mithril-client' -v $(pwd):/app/data -u $(id -u) ghcr.io/input-output-hk/mithril-client:$MITHRIL_IMAGE_ID $@
190190
}
191191
```
192192

@@ -211,9 +211,6 @@ In the following part of the document, you will need to replace the `./mithril-c
211211
### Step 1: Prepare some useful variables
212212

213213
```bash
214-
# Cardano network
215-
export NETWORK=**YOUR_CARDANO_NETWORK**
216-
217214
# Aggregator API endpoint URL
218215
export AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
219216

@@ -313,7 +310,7 @@ docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind
313310
Launch an empty Cardano node and make it live in minutes!
314311

315312
```bash
316-
docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind,source="$(pwd)/data/testnet/$SNAPSHOT_DIGEST/db",target=/data/db/ -e NETWORK=**YOUR_CARDANO_NETWORK** inputoutput/cardano-node
313+
docker run -v cardano-node-ipc:/ipc -v cardano-node-data:/data --mount type=bind,source="$(pwd)/data/testnet/$SNAPSHOT_DIGEST/db",target=/data/db/ -e NETWORK=testnet inputoutput/cardano-node
317314
```
318315

319316
You will see the node start by validating the files ingested from the snapshot archive:

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

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -427,9 +427,6 @@ tail -n 22 ./node-pool2/node.log
427427
### Step 1: Prepare some useful variables
428428
429429
```bash
430-
# Cardano network
431-
export NETWORK=devnet
432-
433430
# Aggregator API endpoint URL
434431
export AGGREGATOR_ENDPOINT=http://localhost:8080/aggregator
435432

@@ -445,7 +442,7 @@ You can pick an online test aggregator directly from the [Mithril Explorer](http
445442
List the available snapshots with which you can bootstrap a Cardano node:
446443
447444
```bash
448-
NETWORK=$NETWORK AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT ./mithril-client snapshot list
445+
AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT ./mithril-client snapshot list
449446
```
450447
451448
You will see a list of snapshots:
@@ -472,7 +469,7 @@ You will see a list of snapshots:
472469
To get more details from a specific snapshot (optional), run:
473470
474471
```bash
475-
NETWORK=$NETWORK AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT ./mithril-client snapshot show $SNAPSHOT_DIGEST
472+
AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT ./mithril-client snapshot show $SNAPSHOT_DIGEST
476473
```
477474
478475
You will see more information about the snapshot:
@@ -504,7 +501,7 @@ You will see more information about the snapshot:
504501
To download the selected snapshot from the remote location to your remote location, run:
505502
506503
```bash
507-
NETWORK=$NETWORK AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT ./mithril-client snapshot download $SNAPSHOT_DIGEST
504+
AGGREGATOR_ENDPOINT=$AGGREGATOR_ENDPOINT ./mithril-client snapshot download $SNAPSHOT_DIGEST
508505
```
509506
510507
You will see that the certificate chain is validated to ensure the issued certificate is genuine and then the selected snapshot archive is downloaded, unpacked and verified against the corresponding certificate.

mithril-client-cli/config/dev.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
2-
"network": "testnet",
3-
"aggregator_endpoint": "http://localhost:8080/aggregator",
4-
"genesis_verification_key": "5b3132372c37332c3132342c3136312c362c3133372c3133312c3231332c3230372c3131372c3139382c38352c3137362c3139392c3136322c3234312c36382c3132332c3131392c3134352c31332c3233322c3234332c34392c3232392c322c3234392c3230352c3230352c33392c3233352c34345d"
2+
"aggregator_endpoint": "http://localhost:8080/aggregator",
3+
"genesis_verification_key": "5b3132372c37332c3132342c3136312c362c3133372c3133312c3231332c3230372c3131372c3139382c38352c3137362c3139392c3136322c3234312c36382c3132332c3131392c3134352c31332c3233322c3234332c34392c3232392c322c3234392c3230352c3230352c33392c3233352c34345d"
54
}
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
{
2-
"network": "preview",
3-
"aggregator_endpoint": "https://aggregator.pre-release-preview.api.mithril.network/aggregator",
4-
"genesis_verification_key": "5b3132372c37332c3132342c3136312c362c3133372c3133312c3231332c3230372c3131372c3139382c38352c3137362c3139392c3136322c3234312c36382c3132332c3131392c3134352c31332c3233322c3234332c34392c3232392c322c3234392c3230352c3230352c33392c3233352c34345d"
5-
}
2+
"aggregator_endpoint": "https://aggregator.pre-release-preview.api.mithril.network/aggregator",
3+
"genesis_verification_key": "5b3132372c37332c3132342c3136312c362c3133372c3133312c3231332c3230372c3131372c3139382c38352c3137362c3139392c3136322c3234312c36382c3132332c3131392c3134352c31332c3233322c3234332c34392c3232392c322c3234392c3230352c3230352c33392c3233352c34345d"
4+
}

0 commit comments

Comments
 (0)