Skip to content

Commit 8900bfd

Browse files
jpraynaudjpraynaud
committed
Redirect documentation of nodes on website
This avoids duplicating the documentation and facilitates maintenance.
1 parent 1b85589 commit 8900bfd

File tree

3 files changed

+12
-389
lines changed

3 files changed

+12
-389
lines changed

‎mithril-aggregator/README.md‎

Lines changed: 3 additions & 220 deletions
Original file line numberDiff line numberDiff line change
@@ -1,223 +1,6 @@
11
# Mithril Aggregator
22

3-
**This is a work in progress** :hammer_and_wrench:
3+
## Documentation
4+
:rocket: The documentation is available at [`Mithril Aggregator Node`](https://mithril.network/doc/manual/developer-docs/nodes/mithril-aggregator)
45

5-
This is a first version of the Mithril Aggregagator
6-
7-
---
8-
9-
## Pre-requisites
10-
11-
**Install Rust**
12-
13-
- Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version).
14-
- Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev`
15-
- Ensure `libsqlite3` is installed on your system and check its version is at least `3.40`. Run `sqlite3 --version` to check your version.
16-
17-
## Mithril test networks
18-
19-
The Mithril test networks are:
20-
21-
- `preview`: Test network with magic id `2`, implemented on the IOG hosted Mithril Aggregator
22-
- `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
23-
- `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
24-
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
26-
27-
## Download source code
28-
29-
```bash
30-
# Download sources from github
31-
git clone https://github.com/input-output-hk/mithril
32-
33-
# Go to sources directory
34-
cd mithril-aggregator
35-
```
36-
37-
## Development test and build
38-
39-
```bash
40-
# Test
41-
make test
42-
43-
# Help
44-
make help
45-
46-
# Doc
47-
make doc
48-
49-
# Run in debug with default configuration
50-
make debug
51-
```
52-
53-
## Release build and run binary 'serve' command
54-
55-
Build and run in release with default configuration
56-
57-
```bash
58-
make run
59-
```
60-
61-
Or, build only in release
62-
63-
```bash
64-
make build
65-
```
66-
67-
Display the help menu
68-
69-
```bash
70-
./mithril-aggregator --help
71-
```
72-
73-
You should see
74-
75-
```bash
76-
mithril-aggregator
77-
Node args
78-
79-
USAGE:
80-
mithril-aggregator [OPTIONS] <SUBCOMMAND>
81-
82-
OPTIONS:
83-
--db-directory <DB_DIRECTORY>
84-
Directory to snapshot [default: /db]
85-
86-
-h, --help
87-
Print help information
88-
89-
-r, --run-mode <RUN_MODE>
90-
Run Mode [default: dev]
91-
92-
--server-ip <SERVER_IP>
93-
Server listening IP [default: 0.0.0.0]
94-
95-
--server-port <SERVER_PORT>
96-
Server listening port [default: 8080]
97-
98-
--snapshot-directory <SNAPSHOT_DIRECTORY>
99-
Directory to store snapshot Defaults to work folder [default: .]
100-
101-
-v, --verbose
102-
Verbosity level
103-
104-
SUBCOMMANDS:
105-
genesis Aggregator runs in Genesis tools mode
106-
help Print this message or the help of the given subcommand(s)
107-
serve Aggregator runs in Serve mode
108-
```
109-
110-
Run 'serve' command in release with default configuration
111-
112-
```bash
113-
./mithril-aggregator serve
114-
```
115-
116-
Run 'serve' command in release with a specific mode
117-
118-
```bash
119-
./mithril-aggregator serve -r preview
120-
```
121-
122-
Run 'serve' command in release with a custom configuration via env vars
123-
124-
```bash
125-
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) RUN_INTERVAL=60000 NETWORK=**YOUR_CARDANO_NETWORK** ./mithril-aggregator serve
126-
```
127-
128-
## Release build and run binary 'genesis' command
129-
130-
Build in release with default configuration
131-
132-
```bash
133-
make build
134-
```
135-
136-
Display the help menu
137-
138-
```bash
139-
./mithril-aggregator genesis --help
140-
```
141-
142-
You should see
143-
144-
```bash
145-
mithril-aggregator-genesis
146-
Aggregator runs in Genesis tools mode
147-
148-
USAGE:
149-
mithril-aggregator genesis <SUBCOMMAND>
150-
151-
OPTIONS:
152-
-h, --help Print help information
153-
154-
SUBCOMMANDS:
155-
bootstrap Bootstrap a genesis certificate Test only usage
156-
export Export payload to sign with genesis secret key
157-
help Print this message or the help of the given subcommand(s)
158-
import Import payload signed with genesis secret key and create & import a genesis certificate
159-
```
160-
161-
Run 'genesis bootstrap' command in release with default configuration, **only in test mode**.
162-
This allows the Mithril Aggregator node to bootstrap a `Genesis Certificate`. After this operation, the Mithril Aggregator will be able to produce new snapshots and certificates.
163-
164-
```bash
165-
./mithril-aggregator genesis bootstrap
166-
```
167-
168-
Or with a specific `Genesis Secret Key`, **only in test mode**.
169-
170-
```bash
171-
./mithril-aggregator genesis bootstrap --genesis-secret-key **YOUR_SECRET_KEY*
172-
```
173-
174-
Run 'genesis export' command in release with default configuration.
175-
This allows the Mithril Aggregator node to export the `Genesis Payload` that needs to be signed (and later reimported) of the `Genesis Certificate`. The signature of the `Genesis Payload` must be done manually with the owner of the `Genesis Secret Key`.
176-
177-
```bash
178-
./mithril-aggregator genesis export
179-
```
180-
181-
Or with a custom export path (to override the default value `./mithril-genesis-payload.txt`)
182-
183-
```bash
184-
./mithril-aggregator genesis export --target-path **YOUR_TARGET_PATH**
185-
```
186-
187-
Run 'genesis import' command in release with default configuration.
188-
This allows the Mithril Aggregator node to import the signed payload of the `Genesis Certificate` and create it in the store. After this operation, the Mithril Aggregator will be able to produce new snapshots and certificates.
189-
190-
```bash
191-
./mithril-aggregator genesis import
192-
```
193-
194-
Or with a custom export path (to override the default value `./mithril-genesis-signed-payload.txt`)
195-
196-
```bash
197-
./mithril-aggregator genesis import --signed-payload-path **YOUR_SIGNED_PAYLOAD_PATH**
198-
```
199-
200-
Run 'genesis import' command in release with a custom configuration via env vars
201-
202-
```bash
203-
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) RUN_INTERVAL=60000 NETWORK=**YOUR_CARDANO_NETWORK** ./mithril-aggregator genesis import
204-
```
205-
206-
```
207-
208-
## Build and run Docker container
209-
210-
```bash
211-
# Build Docker image
212-
make docker-build
213-
214-
# Run Docker container
215-
make docker-run
216-
```
217-
218-
## Interact with the Mithril Aggregator
219-
220-
```bash
221-
# Interact with the aggregator through the OpenAPI UI
222-
open -u https://input-output-hk.github.io/mithril/openapi-ui/
223-
```
6+
:mag: The architecture of the node is explained [here](https://mithril.network/doc/mithril/mithril-network/aggregator)

‎mithril-client/README.md‎

Lines changed: 5 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,8 @@
1-
# Mithril Network / Mithril Client
1+
# Mithril Client
22

3-
**This is a work in progress** :hammer_and_wrench:s
3+
## Documentation
4+
:rocket: The documentation is available at [`Mithril Client Node`](https://mithril.network/doc/manual/developer-docs/nodes/mithril-client)
45

5-
* A **Mithril Client** is able to download, verify authenticity and restore a snapshot into a **Cardano Node**.
6-
* It allows user to bootstrap a **Cardano Node** in minutes instead of days.
7-
* This cli implements a MVP version of a **Mithril Client**.
8-
* Complete documentation is available from [Mithril page](https://mithril.network/doc/).
6+
:bulb: A guide on how to [`Bootstrap a Cardano Node`](https://mithril.network/doc/manual/getting-started/bootstrap-cardano-node) with Mithril
97

10-
---
11-
12-
## Pre-requisites
13-
14-
**Install Rust**
15-
16-
* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version).
17-
* Install Rust [Clippy](https://github.com/rust-lang/rust-clippy) component.
18-
19-
## Mithril test networks
20-
21-
The Mithril test networks are:
22-
23-
* `preview`: Test network with magic id `2`, implemented on the IOG hosted Mithril Aggregator
24-
* `preprod`: Test network with magic id `1`, not implemented yet on the IOG hosted Mithril Aggregator
25-
* `testnet`: Legacy test network with magic id `1097911063`, used to be on the IOG hosted Mithril Aggregator, now deprecated
26-
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
28-
29-
## Download source code
30-
31-
```bash
32-
# Download sources from github
33-
git clone https://github.com/input-output-hk/mithril
34-
35-
# Go to sources directory
36-
cd mithril-client
37-
```
38-
39-
## Development test and build
40-
41-
```bash
42-
# Test
43-
make test
44-
45-
# Help
46-
make help
47-
48-
# Doc
49-
make doc
50-
51-
# Run with default configuration
52-
make debug
53-
```
54-
55-
## Release build and run binary
56-
57-
```bash
58-
# Build and run in release with default configuration
59-
make run list
60-
61-
# Or
62-
# Build
63-
make build
64-
65-
# Help
66-
./mithril-client --help
67-
68-
# Run and show list of snapshots
69-
./mithril-client list
70-
71-
# Run and show list of snapshots for the testnet config file
72-
# Run in a specific mode
73-
./mithril-client -r preview list
74-
75-
# Run with custom configuration with env vars
76-
GENESIS_VERIFICATION_KEY=$(wget -q -O - **YOUR_GENESIS_VERIFICATION_KEY**) NETWORK=**YOUR_CARDANO_NETWORK** AGGREGATOR_ENDPOINT=**YOUR_AGREGATOR_ENDPOINT** ./mithril-client
77-
```
78-
79-
You can use the `--json` option in order to display results in `JSON` format for the `list` and `show` commands:
80-
81-
```bash
82-
./mithril-client list --json
83-
```
84-
85-
## Build and run Docker container
86-
87-
```bash
88-
# Build Docker image
89-
make docker-build
90-
91-
# Run Docker container
92-
make docker-run
93-
```
8+
:mag: The architecture of the node is explained [here](https://mithril.network/doc/mithril/mithril-network/client)

0 commit comments

Comments
 (0)