Skip to content

Commit dda86ee

Browse files
committed
Update nodes README
Use generic identifiers **YOUR_CARDANO_NETWORK** and **YOUR_AGGREGATOR_ENDPOINT**.
1 parent 7024503 commit dda86ee

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

mithril-aggregator/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Mithril test networks are:
2222
- `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
2323
- `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
2424

25-
In this documentation, we use the generic `**YOUR_TEST_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
25+
In this documentation, we use the generic `**YOUR_CARDANO_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
2626

2727
## Download source code
2828

@@ -122,7 +122,7 @@ Run 'serve' command in release with a specific mode
122122
Run 'serve' command in release with a custom configuration via env vars
123123

124124
```bash
125-
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) RUN_INTERVAL=60000 NETWORK=**YOUR_TEST_NETWORK** ./mithril-aggregator serve
125+
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) RUN_INTERVAL=60000 NETWORK=**YOUR_CARDANO_NETWORK** ./mithril-aggregator serve
126126
```
127127

128128
## Release build and run binary 'genesis' command
@@ -200,7 +200,7 @@ Or with a custom export path (to override the default value `./mithril-genesis-s
200200
Run 'genesis import' command in release with a custom configuration via env vars
201201

202202
```bash
203-
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) RUN_INTERVAL=60000 NETWORK=**YOUR_TEST_NETWORK** ./mithril-aggregator genesis import
203+
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) RUN_INTERVAL=60000 NETWORK=**YOUR_CARDANO_NETWORK** ./mithril-aggregator genesis import
204204
```
205205

206206
```

mithril-client/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The Mithril test networks are:
2424
* `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
2525
* `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
2626

27-
In this documentation, we use the generic `**YOUR_TEST_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
27+
In this documentation, we use the generic `**YOUR_CARDANO_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
2828

2929
## Download source code
3030

@@ -73,7 +73,7 @@ make build
7373
./mithril-client -r preview list
7474

7575
# Run with custom configuration with env vars
76-
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) NETWORK=**YOUR_TEST_NETWORK** AGGREGATOR_ENDPOINT=https://aggregator.api.mithril.network/aggregator ./mithril-client
76+
GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey) NETWORK=**YOUR_CARDANO_NETWORK** AGGREGATOR_ENDPOINT=**YOUR_AGREGATOR_ENDPOINT** ./mithril-client
7777
```
7878

7979
You can use the `--json` option in order to display results in `JSON` format for the `list` and `show` commands:

mithril-signer/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The Mithril test networks are:
3131
- `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
3232
- `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
3333

34-
In this documentation, we use the generic `**YOUR_TEST_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
34+
In this documentation, we use the generic `**YOUR_CARDANO_NETWORK**` identifier, but you need to replace it with the identifier of the network that runs on your Cardano node
3535

3636
## Development test and build
3737

@@ -69,7 +69,7 @@ make build
6969
./mithril-signer -r preview
7070

7171
# Run with custom configuration with env vars
72-
NETWORK=**YOUR_TEST_NETWORK** AGGREGATOR_ENDPOINT=https://aggregator.api.mithril.network/aggregator ./mithril-signer
72+
NETWORK=**YOUR_CARDANO_NETWORK** AGGREGATOR_ENDPOINT=**YOUR_AGREGATOR_ENDPOINT** ./mithril-signer
7373
```
7474

7575
## Build and run Docker container

0 commit comments

Comments
 (0)