Redesign mithril client api #1332

Else the new `mithril-client` crate will conflict with it as they would share the same name. Note: current lib usages, and rust doc, had to be updated since this change the import path.

…gator path

Doing this required to address a circular dependency: The certificate client need to have a certificate verifier that need to have a certificate retriever that was implemented by the certificate client. To solve this a internal type, `InternalCertificateRetriever` is added to implement the `CertificateRetriever` trait.

This new `Client` is just a struct that hold an Arc to each of the available subclients.

Including: list, get (latest hash from list), verify certificate chain, and message validation.

… server

This allow to hide from the trait that the aggregator client works using http, making this design more robust if we change the way to communicate to an aggregator.

+ Change the snapshot client `show` method into a `get` method that return an option. This is in order to have the same method name on all clients. + Note: the test doesn't handle the download right now, it will be added later.

Using a builder pattern, manually setting dependencies is optional since if they're missing the builder will be able to construct them by itself.

and adapt existing adapters to just use the try into. This make far more simple to switch between the message and the concrete type, we don't need to define an adapter anymore (are the adapters really usefull ?).

…to a module

…client It was strange that the aggregator client was handling the snapshot download since by design a snapshot can be downloaded using something else than http (ipfs, torrent, ...). This make easier to add new snapshot location type to the client.

The trailing slash is significant. Without it, the last path component is considered to be a “file” name to be removed. When `aggregator_url` is ending with a trailing slash (ex: https://whatever/aggregator/), the `Url::join` with the endpoint works fine => https://whatever/aggregator/endpoint In case there is no trailing slash in the `aggregator_url` (ex: https://whatever/aggregator), the `Url::join` with the endpoint remove the last part of the url => https://whatever/endpoint

…dbackReceiver

- `download_id`: a unique identifier (build using uuid::v4) to track individual download even with simultaneous downloads. - `size` to the 'progress' event: allow a completion percentage without the need to keep data in memory.

In order to do so the `verify_certificate_chain` method of the verifier could not be used since we can't known when an individual certificate is valid.

…ient This allow to reduce the number of re-export of `mithril-common` needed since we can now use a `CerticateMessage` as our main certicate type instead of using the `mithril_common::entities::Certificate` full type. Meaning that we don't have to re-export crypto helpers or types anymore ! To do so we define a new `CertificateVerifier` trait that only have a method that validate a chain and implement it with a new `MithrilCertificateVerifier` struct that use internally the verifier from `mithril-common`. As with the `InternalCertificateRetriever` this add some complexity to this specific part but the trade-off for it are worth it (as said before: no crypto type re-export leading to far less mithril-common dependency on the api level).

Using `pub use` instead of `pub type` lead to a better rust-doc since the re-exported type are displayed as 'internal' type instead of alias. + Move all alias to a dedicated mod to cleanup the `lib.rs`.

This simplify the import of those types that are likely the one that will be the most used by third parties. Co-authored-by: Damien Lachaume <dlachaumepalo@users.noreply.github.com>

Fix typos and move `certificate().verify_chain` before `snapshot().download_unpack` in integration test, doc and example.

… 'mithril-client' to 'mithril-client-cli'

- Fix outdated `utils` module documentation. - Add more details on a hack comment. - rename `aggregator_url` to `aggregator_endpoint`. - rename `SnapshotDownloadComplete` mithril event to `SnapshotDownloadCompleted`. - Add a Todo on the verify chain to specify that we want to merge most of its code in the `mithril-common` codebase.

Since the cli won't be used anymore to define the client library.

Typos in dev documentation and lib.rs

Only use the features that we needs

By running 'nix flake update' command.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redesign mithril client api #1332

Redesign mithril client api #1332

Commits on Nov 13, 2023