Skip to content

Commit 01b90f5

Browse files
committed
Provide the minimum supported Cardano node version for Signers
1 parent 0e40969 commit 01b90f5

File tree

3 files changed

+49
-0
lines changed

3 files changed

+49
-0
lines changed

cardano-min-versions.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"about": "Minimum supported Cardano node versions for Mithril signers",
3+
"network": {
4+
"mainnet": "8.7.3",
5+
"preprod": "8.7.3",
6+
"preview": "8.7.3",
7+
"sanchonet": "8.9.0"
8+
}
9+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Cardano minimum versions for Signers
2+
3+
## Introduction
4+
5+
The [cardano-min-versions.json](../../../cardano-min-versions.json) file, which specifies the minimum supported versions of the Cardano node for Mithril signers
6+
This ensures compatibility and functionality across different networks.
7+
8+
## Maintaining the file
9+
10+
When a new a new Cardano node version is released:
11+
- Verify the Cardano node compatibility with Mithril nodes, especially through the CI process.
12+
- Depending on the network:
13+
- For the stable networks `preview`, `preprod`, and `mainnet`: the minimum supported `cardano-node` version must be updated to be two stable releases behind the current release version.
14+
- For the unstable network `sanchonet`: given its current evolving nature, the minimum supported `cardano-node` version may vary from the stable one.

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,32 @@ Note that this guide works on a Linux machine only.
113113

114114
:::
115115

116+
:::info
117+
118+
To verify that your node version is supported, compare the version of your Cardano node with the minimum supported versions listed in the `cardano-min-versions.json` file located at the root of the repository.
119+
120+
First, check the version of your Cardano node by running the following command:
121+
122+
```bash
123+
cardano-node --version
124+
```
125+
126+
Then, refer to the minimum supported versions listed in the `cardano-min-versions.json` file, which can be found [here](https://github.com/input-output-hk/mithril/blob/main/cardano-min-versions.json).
127+
128+
You can also fetch the minimum supported version for your network using the command below:
129+
```bash
130+
wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/cardano-min-versions.json | jq -r '.network.**YOUR_CARDANO_NETWORK**'
131+
```
132+
133+
Here is an example for `preprod`:
134+
```bash
135+
wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/cardano-min-versions.json | jq -r '.network.preprod'
136+
```
137+
138+
Compare the Cardano node versions, if your node version is equal to or higher than the minimum supported version listed for your network, your Cardano node is supported.
139+
140+
:::
141+
116142
### Building your own executable
117143

118144
#### Download the source file

0 commit comments

Comments
 (0)