add blog article about new client API #975
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jpraynaud
reviewed
Jun 12, 2023
|
|
||
| If the file can be verified against the multi-signature, it is saved on the disk. | ||
|
|
||
| The Mithril stake distribution may not be a convenient artifact for Caradano users but it paves the way for other signed entities that will come in the future. You have an idea of something that you would like to see certified by Mithril multi-signature? Come and talk about it in our [Discord channel](https://discord.gg/5kaErDKDRq). |
There was a problem hiding this comment.
The conclusion is a bit confusing IMHO.
Suggested change
| The Mithril stake distribution may not be a convenient artifact for Caradano users but it paves the way for other signed entities that will come in the future. You have an idea of something that you would like to see certified by Mithril multi-signature? Come and talk about it in our [Discord channel](https://discord.gg/5kaErDKDRq). | |
| Feel free to reach out to us on the [Discord channel](https://discord.gg/5kaErDKDRq) for questions and/or help. | |
Comment on lines
8
to
12
| ## Mithril client now access signed Mithril Stake Distributions | ||
|
|
||
| Since the last few months, the Mithril team has been working on signing other artifacts than just Cardano nodes' snapshots. The first other signed artifact is the stake distribution involved in Mithril Signatures. The Aggregator nodes now advertise for different types of messages to be signed and the Signer nodes know if they can handle them or not without making old nodes to crash. If you are curious, you may go and see in [Mithril Explorer](https://mithril.network/explorer), there are now different tabs, one for each type of signed artifact. | ||
|
|
||
| The last part of this development was to make the signers aware of different kinds of artifacts and be able to verify theirs signature. This implied changing completely the command line API of the client command. By example: |
There was a problem hiding this comment.
I think the goal of this post is to warn users that the client interface will change shortly and that the way they retrieve snapshots has changed. This is not very clear in the sub title and the below introduction
Suggested change
| ## Mithril client now access signed Mithril Stake Distributions | |
| Since the last few months, the Mithril team has been working on signing other artifacts than just Cardano nodes' snapshots. The first other signed artifact is the stake distribution involved in Mithril Signatures. The Aggregator nodes now advertise for different types of messages to be signed and the Signer nodes know if they can handle them or not without making old nodes to crash. If you are curious, you may go and see in [Mithril Explorer](https://mithril.network/explorer), there are now different tabs, one for each type of signed artifact. | |
| The last part of this development was to make the signers aware of different kinds of artifacts and be able to verify theirs signature. This implied changing completely the command line API of the client command. By example: | |
| ### Mithril client interface is evolving | |
| For the last few months, we have implemented the capability for the Mithril protocol to sign multiple types of data: on top of the already existing Cardano node database snapshots, the Mithril stake distribution is now also signed on its own. | |
| In order to make the client able to work on the different types of data that are certified, we have changed its command line API. | |
| For example: |
| $> mithril-client list | ||
| ``` | ||
|
|
||
| this command was previously used to list Cardano node snapshots. But now it is unclear that it lists snapshots, Mithril stake distributions or any other artifacts that will be supported in the future. So this has to be abandoned in favor of a more explicit syntax: |
There was a problem hiding this comment.
Suggested change
| this command was previously used to list Cardano node snapshots. But now it is unclear that it lists snapshots, Mithril stake distributions or any other artifacts that will be supported in the future. So this has to be abandoned in favor of a more explicit syntax: | |
| This command was previously used to list Cardano node snapshots. It has been abandoned in favor of a more explicit syntax: |
| Furthermore, the old version had two different subcommands to 1. download and 2. verify a snapshot. These 2 commands have now be merged into one single `download` command: | ||
|
|
||
| ``` | ||
| $> mithril-client snapshot dowload 5109c1eaa6619bc… |
There was a problem hiding this comment.
Suggested change
| $> mithril-client snapshot dowload 5109c1eaa6619bc… | |
| $> ./mithril-client snapshot dowload 5109c1eaa6619bc… |
| The last part of this development was to make the signers aware of different kinds of artifacts and be able to verify theirs signature. This implied changing completely the command line API of the client command. By example: | ||
|
|
||
| ``` | ||
| $> mithril-client list |
There was a problem hiding this comment.
Also in the other commands 🙂
Suggested change
| $> mithril-client list | |
| $> ./mithril-client list |
| $> mithril-client msd list | ||
| ``` | ||
|
|
||
| In the same way it is for snapshots, it is possible to download and verify the stake distribution involved in Mithril signatures as JSON file: |
There was a problem hiding this comment.
Suggested change
| In the same way it is for snapshots, it is possible to download and verify the stake distribution involved in Mithril signatures as JSON file: | |
| As for the Cardano snapshots, it is possible to download and verify the stake distribution involved in Mithril multi-signatures as a JSON file: |
| $> mithril-client snapshot dowload 5109c1eaa6619bc… | ||
| ``` | ||
|
|
||
| This organization of the client opens the use of a new `mithril-stake-distribution` subcommand: |
There was a problem hiding this comment.
Suggested change
| This organization of the client opens the use of a new `mithril-stake-distribution` subcommand: | |
| This organization of the client opens the use of a new `mithril-stake-distribution` sub-command: |
| $> mithril-client msd download 713e2803e998f… | ||
| ``` | ||
|
|
||
| If the file can be verified against the multi-signature, it is saved on the disk. |
There was a problem hiding this comment.
Suggested change
| If the file can be verified against the multi-signature, it is saved on the disk. | |
| If the file certification can be verified, it is saved on the disk. |
ghubertpalo
force-pushed
the
greg/969/blog_article_client_msd
branch
from
c2f3dc5 to
79af39b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Content
This PR includes a blog post to explain that the CLI options are going to change and why.
Pre-submit checklist
Issue(s)
Relates to #960