Skip to content

Commit b7547a9

Browse files
committed
Update documentation
Make it reflect that the uncertified signer registration mode is deprecated.
1 parent b1fe21b commit b7547a9

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/root/manual/getting-started/run-signer-node.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ 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**: The Cardano `Pool Id` in a `BECH32` format such as `pool1frevxe70aqw2ce58c0muyesnahl88nfjjsp25h85jwakzgd2g2l`
39-
* **Experimental**:
38+
* **Stable**:
4039
* The Cardano `Operational Certificate` file of the pool
4140
* The Cardano `KES Secret Key` file of the pool
41+
* **Deprecated**: The Cardano `Pool Id` in a `BECH32` format such as `pool1frevxe70aqw2ce58c0muyesnahl88nfjjsp25h85jwakzgd2g2l`
4242

4343
* Access to the file system of a `relay` **Cardano Node** running on the `testnet`:
4444
* Read rights on the `Database` folder (`--database-path` setting of the **Cardano Node**)
@@ -62,21 +62,21 @@ Your feedback is very important, so feel free to contact us on the #moria channe
6262

6363
:::
6464

65-
### Stable mode: Declare your Pool Id
66-
67-
In this stable 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 soon to be deprecated and replaced by the certification mode below.
68-
69-
This is the default mode presented in the setup of this document, it is displayed with a specific **Stable** mention.
70-
71-
### Experimental mode: Certify your Pool Id
65+
### Stable mode: Certify your Pool Id
7266

7367
In this mode, you declare your Cardano `Operational Certificate` file and `KES Secret Key` file which allows to:
7468

7569
* Compute automatically the `PoolId`
7670
* Verify that you are the owner of the `PoolId`, and thus of the associated stakes used by Mithril protocol
7771
* 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
7872

79-
This mode is displayed with a specific **Experimental** mention in this document.
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.
8080

8181
## Building your own executable
8282

@@ -165,16 +165,16 @@ sudo mv mithril-signer /opt/mithril
165165
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.
166166

167167
* **Stable mode**: in the `/opt/mithril/mithril-signer/service.env` env file:
168-
* `PARTY_ID=YOUR_POOL_ID_BECH32`: replace `YOUR_POOL_ID_BECH32` with your BECH32 `Pool Id`
168+
* `KES_SECRET_KEY_PATH=/cardano/keys/kes.skey`: replace `/cardano/keys/kes.skey` with the path to your Cardano `KES Secret Key` file
169+
* `OPERATIONAL_CERTIFICATE_PATH=/cardano/cert/opcert.cert`: replace `/cardano/cert/opcert.cert` with the path to your Cardano `Operational Certificate` file
169170
* `DB_DIRECTORY=/cardano/db`: replace `/cardano/db` with the path to the database folder of the **Cardano Node** (the one in `--database-path`)
170171
* `CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket`: replace with the path to the IPC file (`CARDANO_NODE_SOCKET_PATH` env var)
171172
* `CARDANO_CLI_PATH=/app/bin/cardano-cli`: replace with the path to the `cardano-cli` executable
172173
* `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.)
173174
* `STORE_RETENTION_LIMIT`: if set, this will limit the number of records in some internal stores (5 is a good fit).
174175

175-
* :boom: **Experimental mode**: in the `/opt/mithril/mithril-signer/service.env` env file:
176-
* `KES_SECRET_KEY_PATH=/cardano/keys/kes.skey`: replace `/cardano/keys/kes.skey` with the path to your Cardano `KES Secret Key` file
177-
* `OPERATIONAL_CERTIFICATE_PATH=/cardano/cert/pool.cert`: replace `/cardano/cert/pool.cert` with the path to your Cardano `Operational Certificate` file
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`
178178
* `DB_DIRECTORY=/cardano/db`: replace `/cardano/db` with the path to the database folder of the **Cardano Node** (the one in `--database-path`)
179179
* `CARDANO_NODE_SOCKET_PATH=/cardano/ipc/node.socket`: replace with the path to the IPC file (`CARDANO_NODE_SOCKET_PATH` env var)
180180
* `CARDANO_CLI_PATH=/app/bin/cardano-cli`: replace with the path to the `cardano-cli` executable
@@ -189,7 +189,8 @@ First create an env file that will be used by the service:
189189

190190
```bash
191191
sudo bash -c 'cat > /opt/mithril/mithril-signer.env << EOF
192-
PARTY_ID=**YOUR_POOL_ID_BECH32**
192+
KES_SECRET_KEY_PATH=**YOUR_KES_SECRET_KEY_PATH**
193+
OPERATIONAL_CERTIFICATE_PATH=**YOUR_OPERATIONAL_CERTIFICATE_PATH**
193194
NETWORK=**YOUR_CARDANO_NETWORK**
194195
AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
195196
RUN_INTERVAL=60000
@@ -201,12 +202,11 @@ STORE_RETENTION_LIMIT=5
201202
EOF'
202203
```
203204

204-
* :boom: **Experimental mode**:
205+
* **Deprecated mode**:
205206

206207
```bash
207208
sudo bash -c 'cat > /opt/mithril/mithril-signer.env << EOF
208-
KES_SECRET_KEY_PATH=**YOUR_KES_SECRET_KEY_PATH**
209-
OPERATIONAL_CERTIFICATE_PATH=**YOUR_OPERATIONAL_CERTIFICATE_PATH**
209+
PARTY_ID=**YOUR_POOL_ID_BECH32**
210210
NETWORK=**YOUR_CARDANO_NETWORK**
211211
AGGREGATOR_ENDPOINT=**YOUR_AGGREGATOR_ENDPOINT**
212212
RUN_INTERVAL=60000

0 commit comments

Comments
 (0)