Skip to content

Commit 72978a9

Browse files
authored
Merge pull request #679 from input-output-hk/jpraynaud/update-crates-version-2302
Update crates version 2302
2 parents 697b10e + 54a515f commit 72978a9

File tree

6 files changed

+12
-49
lines changed

6 files changed

+12
-49
lines changed

Cargo.lock

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/versioned_docs/version-maintained/manual/developer-docs/nodes/mithril-signer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Here is a list of the available parameters:
182182
| `db_directory` | `--db-directory` | - | `DB_DIRECTORY` | Directory to snapshot from the **Cardano Node** | `/db` | - | :heavy_check_mark: |
183183
| `network` | - | - | `NETWORK` | Cardano network | - | `testnet` or `mainnet` or `devnet` | :heavy_check_mark: |
184184
`network_magic` | - | - | `NETWORK_MAGIC` | Cardano Network Magic number (for `testnet` and `devnet`) | - | `1097911063` or `42` | - |
185-
| `party_id` | - | - | `PARTY_ID` | Party Id of the signer, usually the `Pool Id` of the SPO | - | `pool1pxaqe80sqpde7902er5kf6v0c7y0sv6d5g676766v2h829fvs3x` | - | Mandatory in `Pool Id Declaration Mode` where the owner is not verified (soon to be deprecated)
185+
| `party_id` | - | - | `PARTY_ID` | Party Id of the signer, usually the `Pool Id` of the SPO | - | `pool1pxaqe80sqpde7902er5kf6v0c7y0sv6d5g676766v2h829fvs3x` | - | Mandatory in `Pool Id Declaration Mode` where the owner is not verified (decommissioned, only available when built with `allow_skip_signer_certification` feature, for test only)
186186
| `run_interval` | - | - | `RUN_INTERVAL` | Interval between two runtime cycles in ms | - | `60000` | :heavy_check_mark: |
187187
| `aggregator_endpoint` | - | - | `AGGREGATOR_ENDPOINT` | Aggregator node endpoint | - | `https://aggregator.pre-release-preview.api.mithril.network/aggregator` | :heavy_check_mark: |
188188
| `data_stores_directory` | - | - | `DATA_STORES_DIRECTORY` | Directory to store signer data (Stakes, Protocol initializers, ...) | - | `./mithril-signer/stores` | :heavy_check_mark: |

docs/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md

Lines changed: 5 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,8 @@ For more information about the **Mithril Protocol**, please refer to the [About
3535
## What you'll need
3636

3737
* Operating a **Cardano Node** as a **Stake Pool**:
38-
* **Stable**:
39-
* The Cardano `Operational Certificate` file of the pool
40-
* The Cardano `KES Secret Key` file of the pool
41-
* **Deprecated**: The Cardano `Pool Id` in a `BECH32` format such as `pool1frevxe70aqw2ce58c0muyesnahl88nfjjsp25h85jwakzgd2g2l`
38+
* The Cardano `Operational Certificate` file of the pool
39+
* The Cardano `KES Secret Key` file of the pool
4240

4341
* Access to the file system of a `relay` **Cardano Node** running on the `testnet`:
4442
* Read rights on the `Database` folder (`--database-path` setting of the **Cardano Node**)
@@ -54,24 +52,15 @@ For more information about the **Mithril Protocol**, please refer to the [About
5452

5553
## Mithril Keys Certification
5654

57-
:::danger
58-
59-
The cryptographic certification of the Mithril keys is an experimental feature. We strongly recommend that you first setup a Mithril Signer node in the stable mode. Once you are able to sign in the stable mode is a good time to start experimenting with the keys certification.
6055

61-
Your feedback is very important, so feel free to contact us on the #moria channel on the IOG [Discord server](https://discord.gg/5kaErDKDRq), or to file an issue on GitHub.
62-
63-
:::
56+
### Certify your Pool Id
6457

65-
### Stable mode: Certify your Pool Id
66-
67-
In this mode, you declare your Cardano `Operational Certificate` file and `KES Secret Key` file which allows to:
58+
You must declare your Cardano `Operational Certificate` file and `KES Secret Key` file which allows to:
6859

6960
* Compute automatically the `PoolId`
7061
* Verify that you are the owner of the `PoolId`, and thus of the associated stakes used by Mithril protocol
7162
* Verify that you are the owner of the Mithril `Signer Secret Key`, and thus allowed to contribute to the multi-signatures and certificate production of the Mithril network
7263

73-
This mode is displayed with a specific **Stable** mention in this document.
74-
7564
## Building your own executable
7665

7766
### Download source
@@ -158,7 +147,7 @@ sudo mv mithril-signer /opt/mithril
158147
* `User=cardano`:
159148
Replace this value with the correct user. We assume that the user used to run the **Cardano Node** is `cardano`. The **Mithril Signer** must imperatively run with the same user.
160149

161-
* **Stable mode**: in the `/opt/mithril/mithril-signer/service.env` env file:
150+
* In the `/opt/mithril/mithril-signer/service.env` env file:
162151
* `KES_SECRET_KEY_PATH=/cardano/keys/kes.skey`: replace `/cardano/keys/kes.skey` with the path to your Cardano `KES Secret Key` file
163152
* `OPERATIONAL_CERTIFICATE_PATH=/cardano/cert/opcert.cert`: replace `/cardano/cert/opcert.cert` with the path to your Cardano `Operational Certificate` file
164153
* `DB_DIRECTORY=/cardano/db`: replace `/cardano/db` with the path to the database folder of the **Cardano Node** (the one in `--database-path`)
@@ -167,20 +156,10 @@ Replace this value with the correct user. We assume that the user used to run th
167156
* `DATA_STORES_DIRECTORY=/opt/mithril/stores`: replace with the path to a folder where the **Mithril Signer** will store its data (`/opt/mithril/stores` e.g.)
168157
* `STORE_RETENTION_LIMIT`: if set, this will limit the number of records in some internal stores (5 is a good fit).
169158

170-
* **Deprecated mode**: in the `/opt/mithril/mithril-signer/service.env` env file:
171-
* `PARTY_ID=YOUR_POOL_ID_BECH32`: replace `YOUR_POOL_ID_BECH32` with your BECH32 `Pool Id`
172-
* `DB_DIRECTORY=/cardano/db`: replace `/cardano/db` with the path to the database folder of the **Cardano Node** (the one in `--database-path`)
173-
* `CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket`: replace with the path to the IPC file (`CARDANO_NODE_SOCKET_PATH` env var)
174-
* `CARDANO_CLI_PATH=/app/bin/cardano-cli`: replace with the path to the `cardano-cli` executable
175-
* `DATA_STORES_DIRECTORY=/opt/mithril/stores`: replace with the path to a folder where the **Mithril Signer** will store its data (`/opt/mithril/stores` e.g.)
176-
* `STORE_RETENTION_LIMIT`: if set, this will limit the number of records in some internal stores (5 is a good fit).
177-
178159
:::
179160

180161
First create an env file that will be used by the service:
181162

182-
* **Stable mode**:
183-
184163
```bash
185164
sudo bash -c 'cat > /opt/mithril/mithril-signer.env << EOF
186165
KES_SECRET_KEY_PATH=**YOUR_KES_SECRET_KEY_PATH**
@@ -196,22 +175,6 @@ STORE_RETENTION_LIMIT=5
196175
EOF'
197176
```
198177

199-
* **Deprecated mode**:
200-
201-
```bash
202-
sudo bash -c 'cat > /opt/mithril/mithril-signer.env << EOF
203-
PARTY_ID=**YOUR_POOL_ID_BECH32**
204-
NETWORK=**YOUR_CARDANO_NETWORK**
205-
AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
206-
RUN_INTERVAL=60000
207-
DB_DIRECTORY=/cardano/db
208-
CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket
209-
CARDANO_CLI_PATH=/app/bin/cardano-cli
210-
DATA_STORES_DIRECTORY=/opt/mithril/stores
211-
STORE_RETENTION_LIMIT=5
212-
EOF'
213-
```
214-
215178
Then we will create a `/etc/systemd/system/mithril-signer.service` description file for our service
216179

217180
```bash

mithril-aggregator/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "mithril-aggregator"
3-
version = "0.2.0"
3+
version = "0.2.1"
44
description = "A Mithril Aggregator server"
55
authors = { workspace = true }
66
edition = { workspace = true }

mithril-client/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "mithril-client"
3-
version = "0.2.0"
3+
version = "0.2.1"
44
description = "A Mithril Client"
55
authors = { workspace = true }
66
edition = { workspace = true }

mithril-signer/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "mithril-signer"
3-
version = "0.2.0"
3+
version = "0.2.1"
44
description = "A Mithril Signer"
55
authors = { workspace = true }
66
edition = { workspace = true }

0 commit comments

Comments
 (0)