You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/root/manual/developer-docs/nodes/mithril-signer.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -182,7 +182,7 @@ Here is a list of the available parameters:
182
182
|`db_directory`|`--db-directory`| - |`DB_DIRECTORY`| Directory to snapshot from the **Cardano Node**|`/db`| - |:heavy_check_mark:|
183
183
|`network`| - | - |`NETWORK`| Cardano network | - |`testnet` or `mainnet` or `devnet`|:heavy_check_mark:|
184
184
`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)
186
186
|`run_interval`| - | - |`RUN_INTERVAL`| Interval between two runtime cycles in ms | - |`60000`|:heavy_check_mark:|
Copy file name to clipboardExpand all lines: docs/root/manual/getting-started/run-signer-node.md
+5-48Lines changed: 5 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,10 +35,8 @@ For more information about the **Mithril Protocol**, please refer to the [About
35
35
## What you'll need
36
36
37
37
* 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
42
40
43
41
* Access to the file system of a `relay`**Cardano Node** running on the `testnet`:
44
42
* Read rights on the `Database` folder (`--database-path` setting of the **Cardano Node**)
@@ -54,30 +52,15 @@ For more information about the **Mithril Protocol**, please refer to the [About
54
52
55
53
## Mithril Keys Certification
56
54
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.
60
-
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
-
:::
64
55
65
-
### Stable mode: Certify your Pool Id
56
+
### Certify your Pool Id
66
57
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:
68
59
69
60
* Compute automatically the `PoolId`
70
61
* Verify that you are the owner of the `PoolId`, and thus of the associated stakes used by Mithril protocol
71
62
* 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
72
63
73
-
This mode is displayed with a specific **Stable** mention in this document.
74
-
75
-
### Deprecated mode: Declare your Pool Id
76
-
77
-
In this mode, the Cardano `Pool Id` that you specify is not strictly verified. It is associated to Cardano stakes based on your declaration. This mode is deprecated and replaced by the certification mode above.
78
-
79
-
This mode is presented in the setup of this document with a specific **Deprecated** mention.
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.
166
149
167
-
***Stable mode**: in the `/opt/mithril/mithril-signer/service.env` env file:
150
+
*In the `/opt/mithril/mithril-signer/service.env` env file:
168
151
*`KES_SECRET_KEY_PATH=/cardano/keys/kes.skey`: replace `/cardano/keys/kes.skey` with the path to your Cardano `KES Secret Key` file
169
152
*`OPERATIONAL_CERTIFICATE_PATH=/cardano/cert/opcert.cert`: replace `/cardano/cert/opcert.cert` with the path to your Cardano `Operational Certificate` file
170
153
*`DB_DIRECTORY=/cardano/db`: replace `/cardano/db` with the path to the database folder of the **Cardano Node** (the one in `--database-path`)
@@ -173,20 +156,10 @@ Replace this value with the correct user. We assume that the user used to run th
173
156
*`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.)
174
157
*`STORE_RETENTION_LIMIT`: if set, this will limit the number of records in some internal stores (5 is a good fit).
175
158
176
-
***Deprecated mode**: in the `/opt/mithril/mithril-signer/service.env` env file:
177
-
*`PARTY_ID=YOUR_POOL_ID_BECH32`: replace `YOUR_POOL_ID_BECH32` with your BECH32 `Pool Id`
178
-
*`DB_DIRECTORY=/cardano/db`: replace `/cardano/db` with the path to the database folder of the **Cardano Node** (the one in `--database-path`)
179
-
*`CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket`: replace with the path to the IPC file (`CARDANO_NODE_SOCKET_PATH` env var)
180
-
*`CARDANO_CLI_PATH=/app/bin/cardano-cli`: replace with the path to the `cardano-cli` executable
181
-
*`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.)
182
-
*`STORE_RETENTION_LIMIT`: if set, this will limit the number of records in some internal stores (5 is a good fit).
183
-
184
159
:::
185
160
186
161
First create an env file that will be used by the service:
Copy file name to clipboardExpand all lines: docs/versioned_docs/version-maintained/manual/getting-started/run-signer-node.md
-6Lines changed: 0 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,12 +72,6 @@ In this mode, you declare your Cardano `Operational Certificate` file and `KES S
72
72
73
73
This mode is displayed with a specific **Stable** mention in this document.
74
74
75
-
### Deprecated mode: Declare your Pool Id
76
-
77
-
In this mode, the Cardano `Pool Id` that you specify is not strictly verified. It is associated to Cardano stakes based on your declaration. This mode is deprecated and replaced by the certification mode above.
78
-
79
-
This mode is presented in the setup of this document with a specific **Deprecated** mention.
println!("WARNING: Uncertified signer registration by providing a Pool Id is deprecated and will be removed soon! (Pool Id: {:?})", party_id);
255
+
println!("WARNING: Uncertified signer registration by providing a Pool Id is decommissionned and must be used for tests only! (Pool Id: {:?})", party_id);
0 commit comments