diff --git a/explorer/404.html b/explorer/404.html index 18cbeb89884..8800b56160d 100644 --- a/explorer/404.html +++ b/explorer/404.html @@ -1 +1 @@ -
\ No newline at end of file + \ No newline at end of file diff --git a/explorer/_next/static/tsMTeS2W1YJW5qD_f--fE/_buildManifest.js b/explorer/_next/static/DUXxGhYis8T07U85dzMzq/_buildManifest.js similarity index 100% rename from explorer/_next/static/tsMTeS2W1YJW5qD_f--fE/_buildManifest.js rename to explorer/_next/static/DUXxGhYis8T07U85dzMzq/_buildManifest.js diff --git a/explorer/_next/static/tsMTeS2W1YJW5qD_f--fE/_ssgManifest.js b/explorer/_next/static/DUXxGhYis8T07U85dzMzq/_ssgManifest.js similarity index 100% rename from explorer/_next/static/tsMTeS2W1YJW5qD_f--fE/_ssgManifest.js rename to explorer/_next/static/DUXxGhYis8T07U85dzMzq/_ssgManifest.js diff --git a/explorer/index.html b/explorer/index.html index ff66112b336..73f0e6e0b78 100644 --- a/explorer/index.html +++ b/explorer/index.html @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/rust-doc/help.html b/rust-doc/help.html index 14865cbef53..e881243b698 100644 --- a/rust-doc/help.html +++ b/rust-doc/help.html @@ -1 +1 @@ -Redirecting to ../../mithril_aggregator/enum.SnapshotStoreType.html...
- - - \ No newline at end of file diff --git a/rust-doc/mithril_aggregator/enum.SnapshotStoreType.html b/rust-doc/mithril_aggregator/enum.SnapshotStoreType.html deleted file mode 100644 index b0a81b5c5de..00000000000 --- a/rust-doc/mithril_aggregator/enum.SnapshotStoreType.html +++ /dev/null @@ -1,19 +0,0 @@ -pub enum SnapshotStoreType {
- Gcp,
- Local,
-}
Snapshot store type enumerates the different kinds of snapshot stores. -Local storage is mainly used by development and test environements while GCP -is intended for production use.
-source
. Read moreself
and other
values to be equal, and is used
-by ==
.key
and return true
if they are equal.pub enum SnapshotUploaderType {
+SnapshotUploaderType in mithril_aggregator - Rust pub enum SnapshotUploaderType {
Gcp,
Local,
}
Expand description
Uploader needed to copy the snapshot once computed.
Variants§
Trait Implementations§
source§impl Clone for SnapshotUploaderType
source§fn clone(&self) -> SnapshotUploaderType
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for SnapshotUploaderType
source§impl<'de> Deserialize<'de> for SnapshotUploaderType
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl PartialEq<SnapshotUploaderType> for SnapshotUploaderType
source§fn eq(&self, other: &SnapshotUploaderType) -> bool
This method tests for self
and other
values to be equal, and is used
+Trait Implementations§
source§impl Clone for SnapshotUploaderType
source§fn clone(&self) -> SnapshotUploaderType
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for SnapshotUploaderType
source§impl<'de> Deserialize<'de> for SnapshotUploaderType
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moresource§impl PartialEq<SnapshotUploaderType> for SnapshotUploaderType
source§fn eq(&self, other: &SnapshotUploaderType) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
.source§impl Serialize for SnapshotUploaderType
source§impl Eq for SnapshotUploaderType
source§impl StructuralEq for SnapshotUploaderType
source§impl StructuralPartialEq for SnapshotUploaderType
Auto Trait Implementations§
§impl RefUnwindSafe for SnapshotUploaderType
§impl Send for SnapshotUploaderType
§impl Sync for SnapshotUploaderType
§impl Unpin for SnapshotUploaderType
§impl UnwindSafe for SnapshotUploaderType
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.source§impl Serialize for SnapshotUploaderType
source§impl Eq for SnapshotUploaderType
source§impl StructuralEq for SnapshotUploaderType
source§impl StructuralPartialEq for SnapshotUploaderType
Auto Trait Implementations§
§impl RefUnwindSafe for SnapshotUploaderType
§impl Send for SnapshotUploaderType
§impl Sync for SnapshotUploaderType
§impl Unpin for SnapshotUploaderType
§impl UnwindSafe for SnapshotUploaderType
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> Into<U> for Twhere
U: From<T>,
const: unstable · source§fn into(self) -> U
Calls U::from(self)
.
diff --git a/rust-doc/mithril_aggregator/index.html b/rust-doc/mithril_aggregator/index.html
index 5272bc4f038..8845f634764 100644
--- a/rust-doc/mithril_aggregator/index.html
+++ b/rust-doc/mithril_aggregator/index.html
@@ -1,4 +1,4 @@
-mithril_aggregator - Rust Crate mithril_aggregator
source · Expand description
Mithril aggregator
+
mithril_aggregator - Rust Crate mithril_aggregator
source · Expand description
Mithril aggregator
The Aggregator is responsible for:
- registering signers
@@ -17,9 +17,7 @@
persist them in a separate database.
Structs
Configuration structure dedicated to the AggregatorRuntime.The runner responsibility is to expose a code API for the state machine. It
holds services and configuration.The AggregatorRuntime responsibility is to create a state machine to handle
all actions required by the process of getting multi-signatures.
-See the documentation for more explanations about the Aggregator state machine.Store for [CertificatePending].Store for issued certificates.Aggregator configurationDefault configuration with all the default values for configurations.DependencyManager handles the dependenciesDummy uploader for test purposes.Snapshotter that does nothing. It is mainly used for test purposes.Adapter to convert [RegisterSignerMessage] to [Signer] instances.Configuration expected for Genesis commands.Gzip Snapshotter create a compressed file.Store for local snapshots.LocalSnapshotUploader is a snapshot uploader working using local filesMithril Aggregator NodeImplementation of a CertificateCreatorImplementation of a SignerRegistererMultiSignerImpl is an implementation of the MultiSignerProtocolParameter
store.GoogleCloudPlatformSnapshotStore is a snapshot store working using Google Cloud Platform servicesGCPSnapshotUploader is a snapshot uploader working using Google Cloud Platform servicesRepresents the information needed to handle a signer registration roundStore for [SingleSignatures].Adapter to turn [CertificatePending] instances into [CertificatePendingMessage].Adapter to spawn [EpochSettingsMessage] from [EpochSettings] instances.Store for the VerificationKey
.Enums
Error type for multi signer service.Error encountered or produced by the Runtime.
+See the documentation for more explanations about the Aggregator state machine.Store for [CertificatePending].Store for issued certificates.Aggregator configurationDefault configuration with all the default values for configurations.DependencyManager handles the dependenciesDummy uploader for test purposes.Snapshotter that does nothing. It is mainly used for test purposes.Adapter to convert [RegisterSignerMessage] to [Signer] instances.Configuration expected for Genesis commands.Gzip Snapshotter create a compressed file.Store for local snapshots.LocalSnapshotUploader is a snapshot uploader working using local filesMithril Aggregator NodeImplementation of a CertificateCreatorImplementation of a SignerRegistererMultiSignerImpl is an implementation of the MultiSignerProtocolParameter
store.GCPSnapshotUploader is a snapshot uploader working using Google Cloud Platform servicesRepresents the information needed to handle a signer registration roundStore for [SingleSignatures].Adapter to turn [CertificatePending] instances into [CertificatePendingMessage].Adapter to spawn [EpochSettingsMessage] from [EpochSettings] instances.Store for the VerificationKey
.Enums
Error type for multi signer service.Error encountered or produced by the Runtime.
This enum represents the faith of the errors produced during the state
-transitions.Error type for signer registerer service.Snapshotter error type.Snapshot store type enumerates the different kinds of snapshot stores.
-Local storage is mainly used by development and test environements while GCP
-is intended for production use.Uploader needed to copy the snapshot once computed.Traits
This trait is intended to allow mocking the AggregatorRunner in tests.
+transitions.Error type for signer registerer service.Snapshotter error type.Uploader needed to copy the snapshot once computed.Traits
This trait is intended to allow mocking the AggregatorRunner in tests.
It exposes all the methods needed by the state machine.Define a way to create a [Certificate][mithril_common::entities::Certificate]MultiSigner is the cryptographic engine in charge of producing multi signatures from individual signaturesTrait for mocking ProtocolParameterStore
.Trait to register a signerTrait to open a signer registration roundSnapshotStore represents a snapshot store interactorSnapshotUploader represents a snapshot uploader interactorDefine the ability to create snapshots.Mocking trait for VerificationKeyStore
.
\ No newline at end of file
diff --git a/rust-doc/mithril_aggregator/sidebar-items.js b/rust-doc/mithril_aggregator/sidebar-items.js
index 0dd9280113f..95fa6eb8bda 100644
--- a/rust-doc/mithril_aggregator/sidebar-items.js
+++ b/rust-doc/mithril_aggregator/sidebar-items.js
@@ -1 +1 @@
-window.SIDEBAR_ITEMS = {"enum":[["ProtocolError","Error type for multi signer service."],["RuntimeError","Error encountered or produced by the Runtime. This enum represents the faith of the errors produced during the state transitions."],["SignerRegistrationError","Error type for signer registerer service."],["SnapshotError","Snapshotter error type."],["SnapshotStoreType","Snapshot store type enumerates the different kinds of snapshot stores. Local storage is mainly used by development and test environements while GCP is intended for production use."],["SnapshotUploaderType","Uploader needed to copy the snapshot once computed."]],"mod":[["database","database module. This module contains the entities definition tied with database representation with their associated providers."],["event_store","Event Store module This module proposes tools to send messages between processes and how to persist them in a separate database."]],"struct":[["AggregatorConfig","Configuration structure dedicated to the AggregatorRuntime."],["AggregatorRunner","The runner responsibility is to expose a code API for the state machine. It holds services and configuration."],["AggregatorRuntime","The AggregatorRuntime responsibility is to create a state machine to handle all actions required by the process of getting multi-signatures. See the documentation for more explanations about the Aggregator state machine."],["CertificatePendingStore","Store for [CertificatePending]."],["CertificateStore","Store for issued certificates."],["Configuration","Aggregator configuration"],["DefaultConfiguration","Default configuration with all the default values for configurations."],["DependencyManager","DependencyManager handles the dependencies"],["DumbSnapshotUploader","Dummy uploader for test purposes."],["DumbSnapshotter","Snapshotter that does nothing. It is mainly used for test purposes."],["FromRegisterSignerAdapter","Adapter to convert [RegisterSignerMessage] to [Signer] instances."],["GenesisConfiguration","Configuration expected for Genesis commands."],["GzipSnapshotter","Gzip Snapshotter create a compressed file."],["LocalSnapshotStore","Store for local snapshots."],["LocalSnapshotUploader","LocalSnapshotUploader is a snapshot uploader working using local files"],["MainOpts","Mithril Aggregator Node"],["MithrilCertificateCreator","Implementation of a [CertificateCreator]"],["MithrilSignerRegisterer","Implementation of a [SignerRegisterer]"],["MultiSignerImpl","MultiSignerImpl is an implementation of the MultiSigner"],["ProtocolParametersStore","`ProtocolParameter` store."],["RemoteSnapshotStore","GoogleCloudPlatformSnapshotStore is a snapshot store working using Google Cloud Platform services"],["RemoteSnapshotUploader","GCPSnapshotUploader is a snapshot uploader working using Google Cloud Platform services"],["SignerRegistrationRound","Represents the information needed to handle a signer registration round"],["SingleSignatureStore","Store for [SingleSignatures]."],["ToCertificatePendingMessageAdapter","Adapter to turn [CertificatePending] instances into [CertificatePendingMessage]."],["ToEpochSettingsMessageAdapter","Adapter to spawn [EpochSettingsMessage] from [EpochSettings] instances."],["VerificationKeyStore","Store for the `VerificationKey`."]],"trait":[["AggregatorRunnerTrait","This trait is intended to allow mocking the AggregatorRunner in tests. It exposes all the methods needed by the state machine."],["CertificateCreator","Define a way to create a [Certificate][mithril_common::entities::Certificate]"],["MultiSigner","MultiSigner is the cryptographic engine in charge of producing multi signatures from individual signatures"],["ProtocolParametersStorer","Trait for mocking `ProtocolParameterStore`."],["SignerRegisterer","Trait to register a signer"],["SignerRegistrationRoundOpener","Trait to open a signer registration round"],["SnapshotStore","SnapshotStore represents a snapshot store interactor"],["SnapshotUploader","SnapshotUploader represents a snapshot uploader interactor"],["Snapshotter","Define the ability to create snapshots."],["VerificationKeyStorer","Mocking trait for `VerificationKeyStore`."]]};
\ No newline at end of file
+window.SIDEBAR_ITEMS = {"enum":[["ProtocolError","Error type for multi signer service."],["RuntimeError","Error encountered or produced by the Runtime. This enum represents the faith of the errors produced during the state transitions."],["SignerRegistrationError","Error type for signer registerer service."],["SnapshotError","Snapshotter error type."],["SnapshotUploaderType","Uploader needed to copy the snapshot once computed."]],"mod":[["database","database module. This module contains the entities definition tied with database representation with their associated providers."],["event_store","Event Store module This module proposes tools to send messages between processes and how to persist them in a separate database."]],"struct":[["AggregatorConfig","Configuration structure dedicated to the AggregatorRuntime."],["AggregatorRunner","The runner responsibility is to expose a code API for the state machine. It holds services and configuration."],["AggregatorRuntime","The AggregatorRuntime responsibility is to create a state machine to handle all actions required by the process of getting multi-signatures. See the documentation for more explanations about the Aggregator state machine."],["CertificatePendingStore","Store for [CertificatePending]."],["CertificateStore","Store for issued certificates."],["Configuration","Aggregator configuration"],["DefaultConfiguration","Default configuration with all the default values for configurations."],["DependencyManager","DependencyManager handles the dependencies"],["DumbSnapshotUploader","Dummy uploader for test purposes."],["DumbSnapshotter","Snapshotter that does nothing. It is mainly used for test purposes."],["FromRegisterSignerAdapter","Adapter to convert [RegisterSignerMessage] to [Signer] instances."],["GenesisConfiguration","Configuration expected for Genesis commands."],["GzipSnapshotter","Gzip Snapshotter create a compressed file."],["LocalSnapshotStore","Store for local snapshots."],["LocalSnapshotUploader","LocalSnapshotUploader is a snapshot uploader working using local files"],["MainOpts","Mithril Aggregator Node"],["MithrilCertificateCreator","Implementation of a [CertificateCreator]"],["MithrilSignerRegisterer","Implementation of a [SignerRegisterer]"],["MultiSignerImpl","MultiSignerImpl is an implementation of the MultiSigner"],["ProtocolParametersStore","`ProtocolParameter` store."],["RemoteSnapshotUploader","GCPSnapshotUploader is a snapshot uploader working using Google Cloud Platform services"],["SignerRegistrationRound","Represents the information needed to handle a signer registration round"],["SingleSignatureStore","Store for [SingleSignatures]."],["ToCertificatePendingMessageAdapter","Adapter to turn [CertificatePending] instances into [CertificatePendingMessage]."],["ToEpochSettingsMessageAdapter","Adapter to spawn [EpochSettingsMessage] from [EpochSettings] instances."],["VerificationKeyStore","Store for the `VerificationKey`."]],"trait":[["AggregatorRunnerTrait","This trait is intended to allow mocking the AggregatorRunner in tests. It exposes all the methods needed by the state machine."],["CertificateCreator","Define a way to create a [Certificate][mithril_common::entities::Certificate]"],["MultiSigner","MultiSigner is the cryptographic engine in charge of producing multi signatures from individual signatures"],["ProtocolParametersStorer","Trait for mocking `ProtocolParameterStore`."],["SignerRegisterer","Trait to register a signer"],["SignerRegistrationRoundOpener","Trait to open a signer registration round"],["SnapshotStore","SnapshotStore represents a snapshot store interactor"],["SnapshotUploader","SnapshotUploader represents a snapshot uploader interactor"],["Snapshotter","Define the ability to create snapshots."],["VerificationKeyStorer","Mocking trait for `VerificationKeyStore`."]]};
\ No newline at end of file
diff --git a/rust-doc/mithril_aggregator/snapshot_stores/remote_snapshot_store/struct.RemoteSnapshotStore.html b/rust-doc/mithril_aggregator/snapshot_stores/remote_snapshot_store/struct.RemoteSnapshotStore.html
deleted file mode 100644
index 7fb4378a4f8..00000000000
--- a/rust-doc/mithril_aggregator/snapshot_stores/remote_snapshot_store/struct.RemoteSnapshotStore.html
+++ /dev/null
@@ -1,11 +0,0 @@
-
-
-
-
- Redirection
-
-
- Redirecting to ../../../mithril_aggregator/struct.RemoteSnapshotStore.html...
-
-
-
\ No newline at end of file
diff --git a/rust-doc/mithril_aggregator/struct.Configuration.html b/rust-doc/mithril_aggregator/struct.Configuration.html
index d580cc8f2d6..d636b4e5c91 100644
--- a/rust-doc/mithril_aggregator/struct.Configuration.html
+++ b/rust-doc/mithril_aggregator/struct.Configuration.html
@@ -1,11 +1,10 @@
-Configuration in mithril_aggregator - Rust Struct mithril_aggregator::Configuration
source · pub struct Configuration {Show 19 fields
+Configuration in mithril_aggregator - Rust Struct mithril_aggregator::Configuration
source · pub struct Configuration {Show 18 fields
pub cardano_cli_path: PathBuf,
pub cardano_node_socket_path: PathBuf,
pub network_magic: Option<u64>,
pub network: String,
pub protocol_parameters: ProtocolParameters,
pub url_snapshot_manifest: String,
- pub snapshot_store_type: SnapshotStoreType,
pub snapshot_uploader_type: SnapshotUploaderType,
pub snapshot_bucket_name: Option<String>,
pub server_ip: String,
@@ -27,7 +26,6 @@
§network: String
Cardano network
§protocol_parameters: ProtocolParameters
Protocol parameters
§url_snapshot_manifest: String
Snapshots manifest location
-§snapshot_store_type: SnapshotStoreType
Type of snapshot store to use
§snapshot_uploader_type: SnapshotUploaderType
Type of snapshot uploader to use
§snapshot_bucket_name: Option<String>
Bucket name where the snapshots are stored if snapshot_uploader_type is Gcp
§server_ip: String
Server listening IP
@@ -43,13 +41,12 @@
setting.
§era_reader_adapter_type: EraReaderAdapterType
Era reader adapter type
§era_reader_adapter_params: Option<String>
Era reader adapter parameters
-Implementations§
source§impl Configuration
sourcepub fn get_server_url(&self) -> String
Build the server URL from configuration.
-sourcepub fn build_snapshot_store(
&self
) -> Result<Arc<dyn SnapshotStore>, Box<dyn Error>>
Create a snapshot store from the configuration settings.
-sourcepub fn build_snapshot_uploader(
&self
) -> Result<Arc<dyn SnapshotUploader>, Box<dyn Error>>
Create a snapshot uploader from configuration settings.
-sourcepub fn build_era_reader_adapter(
&self,
chain_observer: Arc<dyn ChainObserver>
) -> Result<Arc<dyn EraReaderAdapter>, Box<dyn Error>>
Create era reader adapter from configuration settings.
-sourcepub fn get_network(&self) -> Result<CardanoNetwork, ConfigError>
Check configuration and return a representation of the Cardano network.
-sourcepub fn get_sqlite_file(&self) -> PathBuf
Return the file of the SQLite stores. If the directory does not exist, it is created.
-Trait Implementations§
source§impl Clone for Configuration
source§fn clone(&self) -> Configuration
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for Configuration
source§impl<'de> Deserialize<'de> for Configuration
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for Configuration
§impl Send for Configuration
§impl Sync for Configuration
§impl Unpin for Configuration
§impl UnwindSafe for Configuration
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> From<T> for T
const: unstable · source§fn from(t: T) -> T
Returns the argument unchanged.
+Implementations§
source§impl Configuration
sourcepub fn get_server_url(&self) -> String
Build the server URL from configuration.
+sourcepub fn build_snapshot_uploader(
&self
) -> Result<Arc<dyn SnapshotUploader>, Box<dyn Error>>
Create a snapshot uploader from configuration settings.
+sourcepub fn build_era_reader_adapter(
&self,
chain_observer: Arc<dyn ChainObserver>
) -> Result<Arc<dyn EraReaderAdapter>, Box<dyn Error>>
Create era reader adapter from configuration settings.
+sourcepub fn get_network(&self) -> Result<CardanoNetwork, ConfigError>
Check configuration and return a representation of the Cardano network.
+sourcepub fn get_sqlite_file(&self) -> PathBuf
Return the file of the SQLite stores. If the directory does not exist, it is created.
+Trait Implementations§
source§impl Clone for Configuration
source§fn clone(&self) -> Configuration
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for Configuration
source§impl<'de> Deserialize<'de> for Configuration
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for Configuration
§impl Send for Configuration
§impl Sync for Configuration
§impl Unpin for Configuration
§impl UnwindSafe for Configuration
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> Into<U> for Twhere
U: From<T>,
const: unstable · source§fn into(self) -> U
Calls U::from(self)
.
diff --git a/rust-doc/mithril_aggregator/struct.DefaultConfiguration.html b/rust-doc/mithril_aggregator/struct.DefaultConfiguration.html
index 9706ecf1a1f..ae24b931caa 100644
--- a/rust-doc/mithril_aggregator/struct.DefaultConfiguration.html
+++ b/rust-doc/mithril_aggregator/struct.DefaultConfiguration.html
@@ -1,4 +1,4 @@
-DefaultConfiguration in mithril_aggregator - Rust Struct mithril_aggregator::DefaultConfiguration
source · pub struct DefaultConfiguration {
+DefaultConfiguration in mithril_aggregator - Rust Struct mithril_aggregator::DefaultConfiguration
source · pub struct DefaultConfiguration {
pub server_ip: String,
pub server_port: String,
pub db_directory: String,
@@ -14,7 +14,7 @@
§snapshot_store_type: String
Type of snapshot store to use
§snapshot_uploader_type: String
Type of snapshot uploader to use
§era_reader_adapter_type: String
Era reader adapter type
-Trait Implementations§
source§impl Clone for DefaultConfiguration
source§fn clone(&self) -> DefaultConfiguration
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for DefaultConfiguration
source§impl Default for DefaultConfiguration
source§impl Source for DefaultConfiguration
source§fn clone_into_box(&self) -> Box<dyn Source + Send + Sync>
source§fn collect(&self) -> Result<Map<String, Value>, ConfigError>
Collect all configuration properties available from this source and return
+Trait Implementations§
source§impl Clone for DefaultConfiguration
source§fn clone(&self) -> DefaultConfiguration
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for DefaultConfiguration
source§impl Default for DefaultConfiguration
source§impl Source for DefaultConfiguration
source§fn clone_into_box(&self) -> Box<dyn Source + Send + Sync>
source§fn collect(&self) -> Result<Map<String, Value>, ConfigError>
Collect all configuration properties available from this source and return
a Map.§fn collect_to(&self, cache: &mut Value) -> Result<(), ConfigError>
Collects all configuration properties to a provided cache.Auto Trait Implementations§
§impl RefUnwindSafe for DefaultConfiguration
§impl Send for DefaultConfiguration
§impl Sync for DefaultConfiguration
§impl Unpin for DefaultConfiguration
§impl UnwindSafe for DefaultConfiguration
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_aggregator/struct.GenesisConfiguration.html b/rust-doc/mithril_aggregator/struct.GenesisConfiguration.html
index f1d2b80cf02..82765537bc5 100644
--- a/rust-doc/mithril_aggregator/struct.GenesisConfiguration.html
+++ b/rust-doc/mithril_aggregator/struct.GenesisConfiguration.html
@@ -1,4 +1,4 @@
-GenesisConfiguration in mithril_aggregator - Rust Struct mithril_aggregator::GenesisConfiguration
source · pub struct GenesisConfiguration {
+GenesisConfiguration in mithril_aggregator - Rust Struct mithril_aggregator::GenesisConfiguration
source · pub struct GenesisConfiguration {
pub cardano_cli_path: PathBuf,
pub cardano_node_socket_path: PathBuf,
pub db_directory: PathBuf,
@@ -23,9 +23,9 @@
When new records are added, oldest records are automatically deleted so
there can always be at max the number of records specified by this
setting.
-
Implementations§
source§impl GenesisConfiguration
sourcepub fn get_network(&self) -> Result<CardanoNetwork, ConfigError>
Check configuration and return a representation of the Cardano network.
-sourcepub fn get_sqlite_file(&self) -> PathBuf
Return the file of the SQLite stores. If the directory does not exist, it is created.
-Trait Implementations§
source§impl Clone for GenesisConfiguration
source§fn clone(&self) -> GenesisConfiguration
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for GenesisConfiguration
source§impl<'de> Deserialize<'de> for GenesisConfiguration
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for GenesisConfiguration
§impl Send for GenesisConfiguration
§impl Sync for GenesisConfiguration
§impl Unpin for GenesisConfiguration
§impl UnwindSafe for GenesisConfiguration
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> From<T> for T
const: unstable · source§fn from(t: T) -> T
Returns the argument unchanged.
+Implementations§
source§impl GenesisConfiguration
sourcepub fn get_network(&self) -> Result<CardanoNetwork, ConfigError>
Check configuration and return a representation of the Cardano network.
+sourcepub fn get_sqlite_file(&self) -> PathBuf
Return the file of the SQLite stores. If the directory does not exist, it is created.
+Trait Implementations§
source§impl Clone for GenesisConfiguration
source§fn clone(&self) -> GenesisConfiguration
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for GenesisConfiguration
source§impl<'de> Deserialize<'de> for GenesisConfiguration
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for GenesisConfiguration
§impl Send for GenesisConfiguration
§impl Sync for GenesisConfiguration
§impl Unpin for GenesisConfiguration
§impl UnwindSafe for GenesisConfiguration
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> Into<U> for Twhere
U: From<T>,
const: unstable · source§fn into(self) -> U
Calls U::from(self)
.
diff --git a/rust-doc/mithril_aggregator/struct.MainOpts.html b/rust-doc/mithril_aggregator/struct.MainOpts.html
index 72c534bd424..1e341adf6bc 100644
--- a/rust-doc/mithril_aggregator/struct.MainOpts.html
+++ b/rust-doc/mithril_aggregator/struct.MainOpts.html
@@ -1,4 +1,4 @@
-MainOpts in mithril_aggregator - Rust Struct mithril_aggregator::MainOpts
source · pub struct MainOpts {
+MainOpts in mithril_aggregator - Rust Struct mithril_aggregator::MainOpts
source · pub struct MainOpts {
pub command: MainCommand,
pub run_mode: String,
pub verbose: u8,
@@ -10,9 +10,9 @@
§verbose: u8
Verbosity level
§db_directory: Option<PathBuf>
Directory of the Cardano node files
§config_directory: PathBuf
Directory where configuration file is located
-Implementations§
Trait Implementations§
source§impl Args for MainOpts
source§fn group_id() -> Option<Id>
Report the [ArgGroup::id
][crate::ArgGroup::id] for this set of argumentssource§fn augment_args<'b>(__clap_app: Command) -> Command
source§fn augment_args_for_update<'b>(__clap_app: Command) -> Command
source§impl FromArgMatches for MainOpts
source§fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
source§fn from_arg_matches_mut(
__clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>
source§fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches
) -> Result<(), Error>
Assign values from ArgMatches
to self
.source§fn update_from_arg_matches_mut(
&mut self,
__clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>
Assign values from ArgMatches
to self
.source§impl Parser for MainOpts
§fn try_parse() -> Result<Self, Error<RichFormatter>>
Parse from std::env::args_os()
, return Err on error.§fn parse_from<I, T>(itr: I) -> Selfwhere
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Parse from iterator, exit on error§fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Parse from iterator, return Err on error.§fn update_from<I, T>(&mut self, itr: I)where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Update from iterator, exit on error§fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Update from iterator, return Err on error.source§impl Source for MainOpts
source§fn clone_into_box(&self) -> Box<dyn Source + Send + Sync>
source§fn collect(&self) -> Result<Map<String, Value>, ConfigError>
Collect all configuration properties available from this source and return
+Implementations§
Trait Implementations§
source§impl Args for MainOpts
source§fn group_id() -> Option<Id>
Report the [ArgGroup::id
][crate::ArgGroup::id] for this set of argumentssource§fn augment_args<'b>(__clap_app: Command) -> Command
source§fn augment_args_for_update<'b>(__clap_app: Command) -> Command
source§impl FromArgMatches for MainOpts
source§fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>
source§fn from_arg_matches_mut(
__clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>
source§fn update_from_arg_matches(
&mut self,
__clap_arg_matches: &ArgMatches
) -> Result<(), Error>
Assign values from ArgMatches
to self
.source§fn update_from_arg_matches_mut(
&mut self,
__clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>
Assign values from ArgMatches
to self
.source§impl Parser for MainOpts
§fn try_parse() -> Result<Self, Error<RichFormatter>>
Parse from std::env::args_os()
, return Err on error.§fn parse_from<I, T>(itr: I) -> Selfwhere
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Parse from iterator, exit on error§fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Parse from iterator, return Err on error.§fn update_from<I, T>(&mut self, itr: I)where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Update from iterator, exit on error§fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where
I: IntoIterator<Item = T>,
T: Into<OsString> + Clone,
Update from iterator, return Err on error.source§impl Source for MainOpts
source§fn clone_into_box(&self) -> Box<dyn Source + Send + Sync>
source§fn collect(&self) -> Result<Map<String, Value>, ConfigError>
Collect all configuration properties available from this source and return
a Map.§fn collect_to(&self, cache: &mut Value) -> Result<(), ConfigError>
Collects all configuration properties to a provided cache.Auto Trait Implementations§
§impl RefUnwindSafe for MainOpts
§impl Send for MainOpts
§impl Sync for MainOpts
§impl Unpin for MainOpts
§impl UnwindSafe for MainOpts
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_aggregator/struct.RemoteSnapshotStore.html b/rust-doc/mithril_aggregator/struct.RemoteSnapshotStore.html
deleted file mode 100644
index 4b95851ee4e..00000000000
--- a/rust-doc/mithril_aggregator/struct.RemoteSnapshotStore.html
+++ /dev/null
@@ -1,13 +0,0 @@
-RemoteSnapshotStore in mithril_aggregator - Rust Struct mithril_aggregator::RemoteSnapshotStore
source · pub struct RemoteSnapshotStore { /* private fields */ }
Expand description
GoogleCloudPlatformSnapshotStore is a snapshot store working using Google Cloud Platform services
-Implementations§
Trait Implementations§
source§impl SnapshotStore for RemoteSnapshotStore
source§fn list_snapshots<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Snapshot>, SnapshotStoreError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
List snapshots
-Auto Trait Implementations§
§impl !RefUnwindSafe for RemoteSnapshotStore
§impl Send for RemoteSnapshotStore
§impl Sync for RemoteSnapshotStore
§impl Unpin for RemoteSnapshotStore
§impl !UnwindSafe for RemoteSnapshotStore
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
source§impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
source§fn lossless_try_into(self) -> Option<Dst>
Performs the conversion.source§impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
source§fn lossy_into(self) -> Dst
Performs the conversion.source§impl<T> OverflowingAs for T
source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.source§impl<T> SaturatingAs for T
source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
source§fn saturating_cast_from(src: Src) -> Dst
Casts the value.source§impl<T> UnwrappedAs for T
source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
source§fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.source§impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
source§impl<T> WrappingAs for T
source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
source§fn wrapping_cast_from(src: Src) -> Dst
Casts the value.
\ No newline at end of file
diff --git a/rust-doc/mithril_aggregator/trait.SnapshotStore.html b/rust-doc/mithril_aggregator/trait.SnapshotStore.html
index 31a499b116b..466308b66bc 100644
--- a/rust-doc/mithril_aggregator/trait.SnapshotStore.html
+++ b/rust-doc/mithril_aggregator/trait.SnapshotStore.html
@@ -6,4 +6,4 @@
Required Methods§
sourcefn list_snapshots<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Snapshot>, SnapshotStoreError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
List snapshots
Implementors§
source§impl SnapshotStore for LocalSnapshotStore
source§impl SnapshotStore for RemoteSnapshotStore
\ No newline at end of file
+Implementors§
source§impl SnapshotStore for LocalSnapshotStore
\ No newline at end of file
diff --git a/rust-doc/mithril_client/enum.RuntimeError.html b/rust-doc/mithril_client/enum.RuntimeError.html
index a52ffb46787..2afad6e0d19 100644
--- a/rust-doc/mithril_client/enum.RuntimeError.html
+++ b/rust-doc/mithril_client/enum.RuntimeError.html
@@ -2,23 +2,23 @@
MissingDependency(String),
InvalidInput(String),
AggregatorHandler(AggregatorHandlerError),
- CertificateRetriever(CertificateRetrieverError),
- ImmutableDigester(ImmutableDigesterError),
+ CertificateRetriever(CertificateRetrieverError),
+ ImmutableDigester(ImmutableDigesterError),
DigestDoesntMatch(String),
- Protocol(CertificateVerifierError),
+ Protocol(CertificateVerifierError),
}Expand description
Runtime related errors.
Variants§
§MissingDependency(String)
Error raised when accessing a missing dependency.
§InvalidInput(String)
Error raised when the user provided an invalid input.
§AggregatorHandler(AggregatorHandlerError)
Error raised when an AggregatorHandlerError is caught when querying the aggregator using
a AggregatorHandler.
-§CertificateRetriever(CertificateRetrieverError)
Error raised when a CertificateRetrieverError tries to retrieve a
-certificate
-§ImmutableDigester(ImmutableDigesterError)
Error raised when the digest computation fails.
+§CertificateRetriever(CertificateRetrieverError)
Error raised when a CertificateRetrieverError tries to retrieve a
+certificate
+§ImmutableDigester(ImmutableDigesterError)
Error raised when the digest computation fails.
§DigestDoesntMatch(String)
Error raised when the digest stored in the signed message doesn’t match the
-certificate
+certificate
hash.
-§Protocol(CertificateVerifierError)
Error raised when verification fails.
-Trait Implementations§
source§impl Debug for RuntimeError
source§impl Display for RuntimeError
source§impl Error for RuntimeError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<AggregatorHandlerError> for RuntimeError
source§fn from(source: AggregatorHandlerError) -> Self
Converts to this type from the input type.source§impl From<CertificateRetrieverError> for RuntimeError
source§fn from(source: CertificateRetrieverError) -> Self
Converts to this type from the input type.source§impl From<CertificateVerifierError> for RuntimeError
source§fn from(source: CertificateVerifierError) -> Self
Converts to this type from the input type.source§impl From<ImmutableDigesterError> for RuntimeError
source§fn from(source: ImmutableDigesterError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl !RefUnwindSafe for RuntimeError
§impl Send for RuntimeError
§impl Sync for RuntimeError
§impl Unpin for RuntimeError
§impl !UnwindSafe for RuntimeError
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> From<T> for T
Trait Implementations§
source§impl Debug for RuntimeError
source§impl Display for RuntimeError
source§impl Error for RuntimeError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<AggregatorHandlerError> for RuntimeError
source§fn from(source: AggregatorHandlerError) -> Self
Converts to this type from the input type.source§impl From<CertificateRetrieverError> for RuntimeError
source§impl From<CertificateVerifierError> for RuntimeError
Auto Trait Implementations§
§impl !RefUnwindSafe for RuntimeError
§impl Send for RuntimeError
§impl Sync for RuntimeError
§impl Unpin for RuntimeError
§impl !UnwindSafe for RuntimeError
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> Into<U> for Twhere
U: From<T>,
const: unstable · source§fn into(self) -> U
Calls U::from(self)
.
diff --git a/rust-doc/mithril_client/fn.convert_to_field_items.html b/rust-doc/mithril_client/fn.convert_to_field_items.html
index 7c61f045a6e..fe21d387f6d 100644
--- a/rust-doc/mithril_client/fn.convert_to_field_items.html
+++ b/rust-doc/mithril_client/fn.convert_to_field_items.html
@@ -1,2 +1,2 @@
-convert_to_field_items in mithril_client - Rust Function mithril_client::convert_to_field_items
source · Expand description
Convert Snapshot to SnapshotFieldItems routine
+convert_to_field_items in mithril_client - Rust Function mithril_client::convert_to_field_items
source · Expand description
Convert Snapshot to SnapshotFieldItems routine
\ No newline at end of file
diff --git a/rust-doc/mithril_client/index.html b/rust-doc/mithril_client/index.html
index 4df38c60afc..de64aa4871e 100644
--- a/rust-doc/mithril_client/index.html
+++ b/rust-doc/mithril_client/index.html
@@ -4,7 +4,7 @@
the AggregatorHandler trait.
To list, download, and validate snapshots use the Runtime.
You must initialize it by giving it a CertificateVerifier, a ProtocolGenesisVerifier and a AggregatorHandler, and a
-Digester
+Digester
implementations using the with_xxx
methods.
Modules
Command module
-This module holds the subcommands that can be used from the CLI.Structs
AggregatorHTTPClient is a http client for an aggregatorClient configurationAdapter to convert CertificateMessage to Certificate instancesAdapter to convert SnapshotListMessage to SnapshotList instancesAdapter to convert SnapshotMessage to Snapshot instancesMithril client runtimeEnums
AggregatorHandler related errors.Runtime related errors.Traits
AggregatorHandler represents a read interactor with an aggregatorFunctions
Convert Snapshot to SnapshotFieldItems routine
\ No newline at end of file
+This module holds the subcommands that can be used from the CLI.Structs
AggregatorHTTPClient is a http client for an aggregatorClient configurationAdapter to convert [CertificateMessage] to [Certificate] instancesAdapter to convert [SnapshotListMessage] to SnapshotList instancesAdapter to convert [SnapshotMessage] to [Snapshot] instancesMithril client runtimeEnums
AggregatorHandler related errors.Runtime related errors.Traits
AggregatorHandler represents a read interactor with an aggregatorFunctions
Convert Snapshot to SnapshotFieldItems routine
\ No newline at end of file
diff --git a/rust-doc/mithril_client/struct.AggregatorHTTPClient.html b/rust-doc/mithril_client/struct.AggregatorHTTPClient.html
index 3b2cf786fae..8c3741ba75b 100644
--- a/rust-doc/mithril_client/struct.AggregatorHTTPClient.html
+++ b/rust-doc/mithril_client/struct.AggregatorHTTPClient.html
@@ -1,12 +1,12 @@
AggregatorHTTPClient in mithril_client - Rust Struct mithril_client::AggregatorHTTPClient
source · pub struct AggregatorHTTPClient { /* private fields */ }
Expand description
AggregatorHTTPClient is a http client for an aggregator
Implementations§
source§impl AggregatorHTTPClient
sourcepub fn prepare_request_builder(
&self,
request_builder: RequestBuilder
) -> RequestBuilder
Forge a client request adding protocol version in the headers.
-Trait Implementations§
source§impl AggregatorHandler for AggregatorHTTPClient
Trait Implementations§
source§impl AggregatorHandler for AggregatorHTTPClient
source§fn list_snapshots<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Snapshot>, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
List snapshots
+source§fn get_snapshot_details<'life0, 'life1, 'async_trait>(
&'life0 self,
digest: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Snapshot, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Get snapshot details
source§fn download_snapshot<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
digest: &'life1 str,
location: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<String, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Download Snapshot
source§fn unpack_snapshot<'life0, 'life1, 'async_trait>(
&'life0 self,
digest: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<String, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Unpack snapshot
-source§fn as_certificate_retriever(&self) -> Arc<dyn CertificateRetriever>
Upcast to a CertificateRetriever
-source§impl CertificateRetriever for AggregatorHTTPClient
source§fn get_certificate_details<'life0, 'life1, 'async_trait>(
&'life0 self,
certificate_hash: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Certificate, CertificateRetrieverError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Get certificate details
+source§fn as_certificate_retriever(&self) -> Arc<dyn CertificateRetriever>
Upcast to a CertificateRetriever
+source§impl CertificateRetriever for AggregatorHTTPClient
source§fn get_certificate_details<'life0, 'life1, 'async_trait>(
&'life0 self,
certificate_hash: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Certificate, CertificateRetrieverError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Get certificate details
source§impl Clone for AggregatorHTTPClient
source§fn clone(&self) -> AggregatorHTTPClient
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for AggregatorHTTPClient
§impl Send for AggregatorHTTPClient
§impl Sync for AggregatorHTTPClient
§impl Unpin for AggregatorHTTPClient
§impl UnwindSafe for AggregatorHTTPClient
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_client/struct.Config.html b/rust-doc/mithril_client/struct.Config.html
index 947a08d3350..b163042a565 100644
--- a/rust-doc/mithril_client/struct.Config.html
+++ b/rust-doc/mithril_client/struct.Config.html
@@ -1,11 +1,11 @@
Config in mithril_client - Rust Struct mithril_client::Config
source · pub struct Config {
pub network: String,
pub aggregator_endpoint: String,
- pub genesis_verification_key: HexEncodedGenesisVerificationKey,
+ pub genesis_verification_key: HexEncodedGenesisVerificationKey,
}
Expand description
Client configuration
Fields§
§network: String
Cardano network
§aggregator_endpoint: String
Aggregator endpoint
-§genesis_verification_key: HexEncodedGenesisVerificationKey
Genesis verification key
+§genesis_verification_key: HexEncodedGenesisVerificationKey
Genesis verification key
Trait Implementations§
source§impl<'de> Deserialize<'de> for Config
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for Config
§impl Send for Config
§impl Sync for Config
§impl Unpin for Config
§impl UnwindSafe for Config
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_client/struct.FromCertificateMessageAdapter.html b/rust-doc/mithril_client/struct.FromCertificateMessageAdapter.html
index eb42736cfed..83fac76693a 100644
--- a/rust-doc/mithril_client/struct.FromCertificateMessageAdapter.html
+++ b/rust-doc/mithril_client/struct.FromCertificateMessageAdapter.html
@@ -1,5 +1,5 @@
-FromCertificateMessageAdapter in mithril_client - Rust pub struct FromCertificateMessageAdapter;
Expand description
Adapter to convert CertificateMessage to Certificate instances
-Implementations§
source§impl FromCertificateMessageAdapter
sourcepub fn adapt(certificate_message: CertificateMessage) -> Certificate
Method to trigger the conversion
+FromCertificateMessageAdapter in mithril_client - Rust pub struct FromCertificateMessageAdapter;
Expand description
Adapter to convert [CertificateMessage] to [Certificate] instances
+Implementations§
Auto Trait Implementations§
§impl RefUnwindSafe for FromCertificateMessageAdapter
§impl Send for FromCertificateMessageAdapter
§impl Sync for FromCertificateMessageAdapter
§impl Unpin for FromCertificateMessageAdapter
§impl UnwindSafe for FromCertificateMessageAdapter
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_client/struct.FromSnapshotListMessageAdapter.html b/rust-doc/mithril_client/struct.FromSnapshotListMessageAdapter.html
index 6fcd3df7fe6..a6f8abc0c1a 100644
--- a/rust-doc/mithril_client/struct.FromSnapshotListMessageAdapter.html
+++ b/rust-doc/mithril_client/struct.FromSnapshotListMessageAdapter.html
@@ -1,5 +1,5 @@
-FromSnapshotListMessageAdapter in mithril_client - Rust pub struct FromSnapshotListMessageAdapter;
Expand description
Adapter to convert SnapshotListMessage to SnapshotList instances
-Implementations§
source§impl FromSnapshotListMessageAdapter
sourcepub fn adapt(snapshot_list_message: SnapshotListMessage) -> Vec<Snapshot> ⓘ
Method to trigger the conversion
+FromSnapshotListMessageAdapter in mithril_client - Rust pub struct FromSnapshotListMessageAdapter;
Expand description
Adapter to convert [SnapshotListMessage] to SnapshotList instances
+Implementations§
Auto Trait Implementations§
§impl RefUnwindSafe for FromSnapshotListMessageAdapter
§impl Send for FromSnapshotListMessageAdapter
§impl Sync for FromSnapshotListMessageAdapter
§impl Unpin for FromSnapshotListMessageAdapter
§impl UnwindSafe for FromSnapshotListMessageAdapter
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_client/struct.FromSnapshotMessageAdapter.html b/rust-doc/mithril_client/struct.FromSnapshotMessageAdapter.html
index 0281babc59c..515fa4bad55 100644
--- a/rust-doc/mithril_client/struct.FromSnapshotMessageAdapter.html
+++ b/rust-doc/mithril_client/struct.FromSnapshotMessageAdapter.html
@@ -1,5 +1,5 @@
-FromSnapshotMessageAdapter in mithril_client - Rust pub struct FromSnapshotMessageAdapter;
Expand description
Adapter to convert SnapshotMessage to Snapshot instances
-Implementations§
source§impl FromSnapshotMessageAdapter
sourcepub fn adapt(snapshot_message: SnapshotMessage) -> Snapshot
Method to trigger the conversion
+FromSnapshotMessageAdapter in mithril_client - Rust pub struct FromSnapshotMessageAdapter;
Expand description
Adapter to convert [SnapshotMessage] to [Snapshot] instances
+Implementations§
Auto Trait Implementations§
§impl RefUnwindSafe for FromSnapshotMessageAdapter
§impl Send for FromSnapshotMessageAdapter
§impl Sync for FromSnapshotMessageAdapter
§impl Unpin for FromSnapshotMessageAdapter
§impl UnwindSafe for FromSnapshotMessageAdapter
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_client/struct.Runtime.html b/rust-doc/mithril_client/struct.Runtime.html
index 45334dcf515..9da11ba52fe 100644
--- a/rust-doc/mithril_client/struct.Runtime.html
+++ b/rust-doc/mithril_client/struct.Runtime.html
@@ -4,9 +4,9 @@
Fields§
§network: String
Cardano network
Implementations§
source§impl Runtime
sourcepub async fn list_snapshots(
&self,
aggregator_handler: Arc<dyn AggregatorHandler>
) -> Result<Vec<SnapshotListItem>, RuntimeError>
List snapshots
-sourcepub async fn show_snapshot<'a>(
&self,
aggregator_handler: Arc<dyn AggregatorHandler + 'a>,
digest: &str
) -> Result<Snapshot, RuntimeError>
Show a snapshot
+sourcepub async fn show_snapshot<'a>(
&self,
aggregator_handler: Arc<dyn AggregatorHandler + 'a>,
digest: &str
) -> Result<Snapshot, RuntimeError>
Show a snapshot
sourcepub async fn download_snapshot<'a>(
&self,
aggregator_handler: Arc<dyn AggregatorHandler + 'a>,
digest: &str,
location_index: isize
) -> Result<(String, String), RuntimeError>
Download a snapshot by digest
-sourcepub async fn restore_snapshot<'a>(
&mut self,
aggregator_handler: Arc<dyn AggregatorHandler + 'a>,
digester: Box<dyn ImmutableDigester + 'a>,
certificate_verifier: Box<dyn CertificateVerifier + 'a>,
genesis_verifier: ProtocolGenesisVerifier,
digest: &str
) -> Result<String, RuntimeError>
Restore a snapshot by digest
+sourcepub async fn restore_snapshot<'a>(
&mut self,
aggregator_handler: Arc<dyn AggregatorHandler + 'a>,
digester: Box<dyn ImmutableDigester + 'a>,
certificate_verifier: Box<dyn CertificateVerifier + 'a>,
genesis_verifier: ProtocolGenesisVerifier,
digest: &str
) -> Result<String, RuntimeError>
Restore a snapshot by digest
Auto Trait Implementations§
§impl RefUnwindSafe for Runtime
§impl Send for Runtime
§impl Sync for Runtime
§impl Unpin for Runtime
§impl UnwindSafe for Runtime
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_client/trait.AggregatorHandler.html b/rust-doc/mithril_client/trait.AggregatorHandler.html
index 7a878a85064..f460f215ac9 100644
--- a/rust-doc/mithril_client/trait.AggregatorHandler.html
+++ b/rust-doc/mithril_client/trait.AggregatorHandler.html
@@ -1,13 +1,13 @@
-AggregatorHandler in mithril_client - Rust Trait mithril_client::AggregatorHandler
source · pub trait AggregatorHandler: CertificateRetriever + Sync + Send {
- fn list_snapshots<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Snapshot>, AggregatorHandlerError>> + Send + 'async_trait>>
where
Self: 'async_trait,
'life0: 'async_trait;
- fn get_snapshot_details<'life0, 'life1, 'async_trait>(
&'life0 self,
digest: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Snapshot, AggregatorHandlerError>> + Send + 'async_trait>>
where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait;
+AggregatorHandler in mithril_client - Rust Trait mithril_client::AggregatorHandler
source · pub trait AggregatorHandler: CertificateRetriever + Sync + Send {
+ fn list_snapshots<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Snapshot>, AggregatorHandlerError>> + Send + 'async_trait>>
where
Self: 'async_trait,
'life0: 'async_trait;
+ fn get_snapshot_details<'life0, 'life1, 'async_trait>(
&'life0 self,
digest: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Snapshot, AggregatorHandlerError>> + Send + 'async_trait>>
where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait;
fn download_snapshot<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
digest: &'life1 str,
location: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<String, AggregatorHandlerError>> + Send + 'async_trait>>
where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait;
fn unpack_snapshot<'life0, 'life1, 'async_trait>(
&'life0 self,
digest: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<String, AggregatorHandlerError>> + Send + 'async_trait>>
where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait;
- fn as_certificate_retriever(&self) -> Arc<dyn CertificateRetriever>;
+ fn as_certificate_retriever(&self) -> Arc<dyn CertificateRetriever>;
}
Expand description
AggregatorHandler represents a read interactor with an aggregator
-Required Methods§
sourcefn list_snapshots<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Snapshot>, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
List snapshots
-sourcefn get_snapshot_details<'life0, 'life1, 'async_trait>(
&'life0 self,
digest: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Snapshot, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Get snapshot details
+Required Methods§
sourcefn list_snapshots<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<Snapshot>, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
List snapshots
+sourcefn get_snapshot_details<'life0, 'life1, 'async_trait>(
&'life0 self,
digest: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<Snapshot, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Get snapshot details
sourcefn download_snapshot<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
digest: &'life1 str,
location: &'life2 str
) -> Pin<Box<dyn Future<Output = Result<String, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Download snapshot
sourcefn unpack_snapshot<'life0, 'life1, 'async_trait>(
&'life0 self,
digest: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<String, AggregatorHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Unpack snapshot
-sourcefn as_certificate_retriever(&self) -> Arc<dyn CertificateRetriever>
Upcast to a CertificateRetriever
+sourcefn as_certificate_retriever(&self) -> Arc<dyn CertificateRetriever>
Upcast to a CertificateRetriever
Implementors§
\ No newline at end of file
diff --git a/rust-doc/mithril_common/index.html b/rust-doc/mithril_common/index.html
index 58778506352..00f0bda954d 100644
--- a/rust-doc/mithril_common/index.html
+++ b/rust-doc/mithril_common/index.html
@@ -1,4 +1,4 @@
-mithril_common - Rust Crate mithril_common
source · Expand description
Shared datatypes and traits used by Mithril rust projects
+mithril_common - Rust Crate mithril_common
source · Expand description
Shared datatypes and traits used by Mithril rust projects
Provide:
- A way to store data with the store types
diff --git a/rust-doc/mithril_common/store/adapter/struct.SQLiteAdapter.html b/rust-doc/mithril_common/store/adapter/struct.SQLiteAdapter.html
index f95fd108fb1..e3baa85ef79 100644
--- a/rust-doc/mithril_common/store/adapter/struct.SQLiteAdapter.html
+++ b/rust-doc/mithril_common/store/adapter/struct.SQLiteAdapter.html
@@ -1,6 +1,6 @@
-SQLiteAdapter in mithril_common::store::adapter - Rust Struct mithril_common::store::adapter::SQLiteAdapter
source · pub struct SQLiteAdapter<K, V> { /* private fields */ }
Expand description
Store adapter for SQLite3
-Implementations§
source§impl<K, V> SQLiteAdapter<K, V>where
K: Serialize,
V: DeserializeOwned,
Trait Implementations§
source§impl<K, V> StoreAdapter for SQLiteAdapter<K, V>where
K: Send + Sync + Serialize + DeserializeOwned,
V: Send + Sync + Serialize + DeserializeOwned,
source§fn store_record<'life0, 'life1, 'life2, 'async_trait>(
&'life0 mut self,
key: &'life1 Self::Key,
record: &'life2 Self::Record
) -> Pin<Box<dyn Future<Output = Result<(), AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Store the given record
.source§fn get_record<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 Self::Key
) -> Pin<Box<dyn Future<Output = Result<Option<Self::Record>, AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Get the record stored using the given key
.source§fn record_exists<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 Self::Key
) -> Pin<Box<dyn Future<Output = Result<bool, AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Check if a record exist for the given key
.source§fn get_last_n_records<'life0, 'async_trait>(
&'life0 self,
how_many: usize
) -> Pin<Box<dyn Future<Output = Result<Vec<(Self::Key, Self::Record)>, AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get the last n
records in the storeAuto Trait Implementations§
§impl<K, V> !RefUnwindSafe for SQLiteAdapter<K, V>
§impl<K, V> Send for SQLiteAdapter<K, V>where
K: Send,
V: Send,
§impl<K, V> Sync for SQLiteAdapter<K, V>where
K: Sync,
V: Sync,
§impl<K, V> Unpin for SQLiteAdapter<K, V>where
K: Unpin,
V: Unpin,
§impl<K, V> !UnwindSafe for SQLiteAdapter<K, V>
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> From<T> for T
const: unstable · source§fn from(t: T) -> T
Returns the argument unchanged.
+SQLiteAdapter in mithril_common::store::adapter - Rust Struct mithril_common::store::adapter::SQLiteAdapter
source · pub struct SQLiteAdapter<K, V> { /* private fields */ }
Expand description
Store adapter for SQLite3
+Implementations§
source§impl<K, V> SQLiteAdapter<K, V>where
K: Serialize,
V: DeserializeOwned,
Trait Implementations§
source§impl<K, V> StoreAdapter for SQLiteAdapter<K, V>where
K: Send + Sync + Serialize + DeserializeOwned,
V: Send + Sync + Serialize + DeserializeOwned,
source§fn store_record<'life0, 'life1, 'life2, 'async_trait>(
&'life0 mut self,
key: &'life1 Self::Key,
record: &'life2 Self::Record
) -> Pin<Box<dyn Future<Output = Result<(), AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
Store the given record
.source§fn get_record<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 Self::Key
) -> Pin<Box<dyn Future<Output = Result<Option<Self::Record>, AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Get the record stored using the given key
.source§fn record_exists<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 Self::Key
) -> Pin<Box<dyn Future<Output = Result<bool, AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Check if a record exist for the given key
.source§fn get_last_n_records<'life0, 'async_trait>(
&'life0 self,
how_many: usize
) -> Pin<Box<dyn Future<Output = Result<Vec<(Self::Key, Self::Record)>, AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Get the last n
records in the storeAuto Trait Implementations§
§impl<K, V> RefUnwindSafe for SQLiteAdapter<K, V>where
K: RefUnwindSafe,
V: RefUnwindSafe,
§impl<K, V> Send for SQLiteAdapter<K, V>where
K: Send,
V: Send,
§impl<K, V> Sync for SQLiteAdapter<K, V>where
K: Sync,
V: Sync,
§impl<K, V> Unpin for SQLiteAdapter<K, V>where
K: Unpin,
V: Unpin,
§impl<K, V> UnwindSafe for SQLiteAdapter<K, V>where
K: UnwindSafe,
V: UnwindSafe,
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
source§impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
source§fn lossless_try_into(self) -> Option<Dst>
Performs the conversion.source§impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
source§fn lossy_into(self) -> Dst
Performs the conversion.source§impl<T> OverflowingAs for T
source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.source§impl<T> SaturatingAs for T
source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
source§fn saturating_cast_from(src: Src) -> Dst
Casts the value.source§impl<T> UnwrappedAs for T
source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
source§fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.source§impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
source§impl<T> WrappingAs for T
source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
source§fn wrapping_cast_from(src: Src) -> Dst
Casts the value.
\ No newline at end of file
+WithDispatch
wrapper. Read moresource§impl<T> WrappingAs for T
source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
source§fn wrapping_cast_from(src: Src) -> Dst
Casts the value.§impl<T> SendSyncUnwindSafe for Twhere
T: Send + Sync + UnwindSafe + ?Sized,
\ No newline at end of file
diff --git a/rust-doc/mithril_common/store/adapter/struct.SQLiteResultIterator.html b/rust-doc/mithril_common/store/adapter/struct.SQLiteResultIterator.html
index 95d9e0e3155..125c04723f6 100644
--- a/rust-doc/mithril_common/store/adapter/struct.SQLiteResultIterator.html
+++ b/rust-doc/mithril_common/store/adapter/struct.SQLiteResultIterator.html
@@ -1,8 +1,8 @@
-SQLiteResultIterator in mithril_common::store::adapter - Rust Struct mithril_common::store::adapter::SQLiteResultIterator
source · pub struct SQLiteResultIterator<V> { /* private fields */ }
Expand description
Iterator over SQLite adapter results.
+SQLiteResultIterator in mithril_common::store::adapter - Rust Struct mithril_common::store::adapter::SQLiteResultIterator
source · pub struct SQLiteResultIterator<V> { /* private fields */ }
Expand description
Iterator over SQLite adapter results.
important: For now all the results are loaded in memory, it would be better to
consume the cursor but this is a quick solution.
-Implementations§
source§impl<V> SQLiteResultIterator<V>where
V: DeserializeOwned,
sourcepub fn new(
connection: MutexGuard<'_, Connection>,
table_name: &str
) -> Result<SQLiteResultIterator<V>, AdapterError>
Create a new instance of the iterator.
-Trait Implementations§
source§impl<V> Iterator for SQLiteResultIterator<V>
source§fn next(&mut self) -> Option<Self::Item>
Advances the iterator and returns the next value. Read moresource§fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
🔬This is a nightly-only experimental API. (iter_next_chunk
)Advances the iterator and returns an array containing the next N
values. Read more1.0.0 · source§fn size_hint(&self) -> (usize, Option<usize>)
Returns the bounds on the remaining length of the iterator. Read more1.0.0 · source§fn count(self) -> usizewhere
Self: Sized,
Consumes the iterator, counting the number of iterations and returning it. Read more1.0.0 · source§fn last(self) -> Option<Self::Item>where
Self: Sized,
Consumes the iterator, returning the last element. Read moresource§fn advance_by(&mut self, n: usize) -> Result<(), usize>
🔬This is a nightly-only experimental API. (iter_advance_by
)Advances the iterator by n
elements. Read more1.0.0 · source§fn nth(&mut self, n: usize) -> Option<Self::Item>
Returns the n
th element of the iterator. Read more1.28.0 · source§fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,
Creates an iterator starting at the same point, but stepping by
+Implementations§
source§impl<V> SQLiteResultIterator<V>where
V: DeserializeOwned,
sourcepub fn new(
connection: &Connection,
table_name: &str
) -> Result<SQLiteResultIterator<V>, AdapterError>
Create a new instance of the iterator.
+Trait Implementations§
source§impl<V> Iterator for SQLiteResultIterator<V>
source§fn next(&mut self) -> Option<Self::Item>
Advances the iterator and returns the next value. Read moresource§fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
🔬This is a nightly-only experimental API. (iter_next_chunk
)Advances the iterator and returns an array containing the next N
values. Read more1.0.0 · source§fn size_hint(&self) -> (usize, Option<usize>)
Returns the bounds on the remaining length of the iterator. Read more1.0.0 · source§fn count(self) -> usizewhere
Self: Sized,
Consumes the iterator, counting the number of iterations and returning it. Read more1.0.0 · source§fn last(self) -> Option<Self::Item>where
Self: Sized,
Consumes the iterator, returning the last element. Read moresource§fn advance_by(&mut self, n: usize) -> Result<(), usize>
🔬This is a nightly-only experimental API. (iter_advance_by
)Advances the iterator by n
elements. Read more1.0.0 · source§fn nth(&mut self, n: usize) -> Option<Self::Item>
Returns the n
th element of the iterator. Read more1.28.0 · source§fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,
Creates an iterator starting at the same point, but stepping by
the given amount at each iteration. Read more1.0.0 · source§fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>where
Self: Sized,
U: IntoIterator<Item = Self::Item>,
Takes two iterators and creates a new iterator over both in sequence. Read more1.0.0 · source§fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where
Self: Sized,
U: IntoIterator,
‘Zips up’ two iterators into a single iterator of pairs. Read moresource§fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>where
Self: Sized,
G: FnMut() -> Self::Item,
🔬This is a nightly-only experimental API. (iter_intersperse
)Creates a new iterator which places an item generated by separator
between adjacent items of the original iterator. Read more1.0.0 · source§fn map<B, F>(self, f: F) -> Map<Self, F>where
Self: Sized,
F: FnMut(Self::Item) -> B,
Takes a closure and creates an iterator which calls that closure on each
element. Read more1.21.0 · source§fn for_each<F>(self, f: F)where
Self: Sized,
F: FnMut(Self::Item),
Calls a closure on each element of an iterator. Read more1.0.0 · source§fn filter<P>(self, predicate: P) -> Filter<Self, P>where
Self: Sized,
P: FnMut(&Self::Item) -> bool,
Creates an iterator which uses a closure to determine if an element
diff --git a/rust-doc/mithril_common/store/adapter/trait.StoreAdapter.html b/rust-doc/mithril_common/store/adapter/trait.StoreAdapter.html
index 555e18acc48..b0e580b92cb 100644
--- a/rust-doc/mithril_common/store/adapter/trait.StoreAdapter.html
+++ b/rust-doc/mithril_common/store/adapter/trait.StoreAdapter.html
@@ -18,4 +18,4 @@
sourcefn remove<'life0, 'life1, 'async_trait>(
&'life0 mut self,
key: &'life1 Self::Key
) -> Pin<Box<dyn Future<Output = Result<Option<Self::Record>, AdapterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
remove values from store
if the value exists it is returned by the adapter otherwise None is returned
Implementors§
source§impl<K, V> StoreAdapter for MemoryAdapter<K, V>where
K: Hash + Eq + Send + Sync + Clone,
V: Send + Sync + Clone,
source§impl<K, V> StoreAdapter for SQLiteAdapter<K, V>where
K: Send + Sync + Serialize + DeserializeOwned,
V: Send + Sync + Serialize + DeserializeOwned,
\ No newline at end of file
+Implementors§
source§impl<K, V> StoreAdapter for MemoryAdapter<K, V>where
K: Hash + Eq + Send + Sync + Clone,
V: Send + Sync + Clone,
source§impl<K, V> StoreAdapter for SQLiteAdapter<K, V>where
K: Send + Sync + Serialize + DeserializeOwned,
V: Send + Sync + Serialize + DeserializeOwned,
\ No newline at end of file
diff --git a/rust-doc/mithril_signer/enum.RunnerError.html b/rust-doc/mithril_signer/enum.RunnerError.html
index 3f1e84c8fcc..c4ab71ce44a 100644
--- a/rust-doc/mithril_signer/enum.RunnerError.html
+++ b/rust-doc/mithril_signer/enum.RunnerError.html
@@ -1,12 +1,12 @@
RunnerError in mithril_signer - Rust Enum mithril_signer::RunnerError
source · pub enum RunnerError {
NoValueError(String),
NoStakeForSelf(),
- NoStakeForSigner(PartyId),
+ NoStakeForSigner(PartyId),
FileParse(String),
}
Expand description
This type represents the errors thrown from the Runner.
Variants§
§NoValueError(String)
Value was expected from a subsystem but None was returned.
§NoStakeForSelf()
Could not associate my node with a stake.
-§NoStakeForSigner(PartyId)
Could not find the stake for one of the signers.
+§NoStakeForSigner(PartyId)
Could not find the stake for one of the signers.
§FileParse(String)
Parse file error
Trait Implementations§
source§impl Clone for RunnerError
source§fn clone(&self) -> RunnerError
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for RunnerError
source§impl Display for RunnerError
source§impl Error for RunnerError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<RunnerError> for RuntimeError
source§fn from(value: RunnerError) -> Self
Converts to this type from the input type.source§impl PartialEq<RunnerError> for RunnerError
source§fn eq(&self, other: &RunnerError) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
.1.0.0 · source§fn ne(&self, other: &Rhs) -> bool
This method tests for !=
. The default implementation is almost always
diff --git a/rust-doc/mithril_signer/enum.RuntimeError.html b/rust-doc/mithril_signer/enum.RuntimeError.html
index 8049ebc5eb8..f9b0ecec101 100644
--- a/rust-doc/mithril_signer/enum.RuntimeError.html
+++ b/rust-doc/mithril_signer/enum.RuntimeError.html
@@ -18,7 +18,7 @@
Critical error means the runtime will exit and the software will return
an error code.
Implementations§
source§impl RuntimeError
sourcepub fn is_critical(&self) -> bool
Easy matching Critical errors.
-Trait Implementations§
source§impl Debug for RuntimeError
source§impl Display for RuntimeError
source§impl Error for RuntimeError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<EpochError> for RuntimeError
source§fn from(value: EpochError) -> Self
Converts to this type from the input type.source§impl From<RunnerError> for RuntimeError
source§fn from(value: RunnerError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl !RefUnwindSafe for RuntimeError
§impl Send for RuntimeError
§impl Sync for RuntimeError
§impl Unpin for RuntimeError
§impl !UnwindSafe for RuntimeError
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.Trait Implementations§
source§impl Debug for RuntimeError
source§impl Display for RuntimeError
source§impl Error for RuntimeError
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<EpochError> for RuntimeError
source§impl From<RunnerError> for RuntimeError
source§fn from(value: RunnerError) -> Self
Converts to this type from the input type.Auto Trait Implementations§
§impl !RefUnwindSafe for RuntimeError
§impl Send for RuntimeError
§impl Sync for RuntimeError
§impl Unpin for RuntimeError
§impl !UnwindSafe for RuntimeError
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> Into<U> for Twhere
U: From<T>,
const: unstable · source§fn into(self) -> U
Calls U::from(self)
.
diff --git a/rust-doc/mithril_signer/enum.SignerState.html b/rust-doc/mithril_signer/enum.SignerState.html
index d28dcdfd0b9..8cd9f544aba 100644
--- a/rust-doc/mithril_signer/enum.SignerState.html
+++ b/rust-doc/mithril_signer/enum.SignerState.html
@@ -1,23 +1,23 @@
SignerState in mithril_signer - Rust Enum mithril_signer::SignerState
source · pub enum SignerState {
Init,
Unregistered {
- epoch: Epoch,
+ epoch: Epoch,
},
Registered {
- beacon: Beacon,
+ beacon: Beacon,
},
Signed {
- beacon: Beacon,
+ beacon: Beacon,
},
}
Expand description
Different possible states of the state machine.
Variants§
§Init
Starting state
-§Unregistered
Fields
§epoch: Epoch
Current Epoch
+§Unregistered
Fields
§epoch: Epoch
Current Epoch
Hold the latest known epoch in order to help synchronisation
with the aggregator
-§Registered
Fields
§beacon: Beacon
Beacon when Signer may sign.
+§Registered
Fields
§beacon: Beacon
Beacon when Signer may sign.
Registered
state. The Signer has successfuly registered against the
Aggregator for this Epoch, it is now able to sign.
-§Signed
Fields
§beacon: Beacon
Beacon when Signer signed.
+§Signed
Fields
§beacon: Beacon
Beacon when Signer signed.
Signed
state. The Signer has signed the immutable files for the
current Beacon.
Implementations§
source§impl SignerState
sourcepub fn is_init(&self) -> bool
Returns true
if the state in Init
diff --git a/rust-doc/mithril_signer/enum.SingleSignerError.html b/rust-doc/mithril_signer/enum.SingleSignerError.html
index 7a0762377e0..43fe2a93747 100644
--- a/rust-doc/mithril_signer/enum.SingleSignerError.html
+++ b/rust-doc/mithril_signer/enum.SingleSignerError.html
@@ -3,16 +3,16 @@
UnregisteredPartyId(),
ProtocolSignerCreationFailure(String),
ProtocolInitializerMissing(),
- ProtocolInitializerNotRegistered(ProtocolRegistrationError),
+ ProtocolInitializerNotRegistered(ProtocolRegistrationError),
Codec(String),
}Expand description
SingleSigner error structure.
Variants§
§UnregisteredVerificationKey()
This signer has not registered for this Epoch hence cannot participate to the signature.
§UnregisteredPartyId()
No stake is associated with this signer.
§ProtocolSignerCreationFailure(String)
Cryptographic Signer creation error.
§ProtocolInitializerMissing()
Could not fetch a protocol initializer for this Epoch.
-§ProtocolInitializerNotRegistered(ProtocolRegistrationError)
Could not fetch a signer from a protocol initializer.
+§ProtocolInitializerNotRegistered(ProtocolRegistrationError)
Could not fetch a signer from a protocol initializer.
§Codec(String)
Encoding / Decoding error.
-Trait Implementations§
source§impl Debug for SingleSignerError
source§impl Display for SingleSignerError
source§impl Error for SingleSignerError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<ProtocolRegistrationErrorWrapper> for SingleSignerError
source§fn from(source: ProtocolRegistrationError) -> Self
Converts to this type from the input type.source§impl PartialEq<SingleSignerError> for SingleSignerError
source§fn eq(&self, other: &SingleSignerError) -> bool
This method tests for self
and other
values to be equal, and is used
+Trait Implementations§
source§impl Debug for SingleSignerError
source§impl Display for SingleSignerError
source§impl Error for SingleSignerError
source§fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more1.0.0 · source§fn description(&self) -> &str
👎Deprecated since 1.42.0: use the Display impl or to_string()source§impl From<ProtocolRegistrationErrorWrapper> for SingleSignerError
source§impl PartialEq<SingleSignerError> for SingleSignerError
source§fn eq(&self, other: &SingleSignerError) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
.source§impl Eq for SingleSignerError
source§impl StructuralEq for SingleSignerError
source§impl StructuralPartialEq for SingleSignerError
Auto Trait Implementations§
§impl RefUnwindSafe for SingleSignerError
§impl Send for SingleSignerError
§impl Sync for SingleSignerError
§impl Unpin for SingleSignerError
§impl UnwindSafe for SingleSignerError
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
diff --git a/rust-doc/mithril_signer/index.html b/rust-doc/mithril_signer/index.html
index 108ec0350ed..69329126238 100644
--- a/rust-doc/mithril_signer/index.html
+++ b/rust-doc/mithril_signer/index.html
@@ -1,9 +1,9 @@
-mithril_signer - Rust Crate mithril_signer
source · Expand description
Mithril Signer crate documentation
+mithril_signer - Rust Crate mithril_signer
source · Expand description
Mithril Signer crate documentation
This crate is used by Cardano nodes to participate to Mithril signatures.
It proposes tools to communicate with Mithril aggregators and to issue Single Signatures.
See the Mithril documentation
for more information on how it works.
-Structs
CertificateHandlerHTTPClient is a http client for an aggregatorClient configurationDefault configuration with all the default values for configurations.Adapter to convert EpochSettingsMessage to EpochSettings.Adapter to turn CertificatePendingMessage instances into CertificatePending.This is responsible of creating new instances of ProtocolInitializer.Implementation of the SingleSigner.Create a SignerService instance for Production environment.Implementation of the ProtocolInitializerStorerController methods for the Signer’s state machine.This structure groups all the services required by the state machine.The state machine is responsible of the execution of the signer automate.Adapter to create RegisterSignerMessage from Signer instance.Enums
Error structure for the Certificate Handler.MithrilProtocolInitializerBuilder error structure.This type represents the errors thrown from the Runner.RuntimeError
+Structs
CertificateHandlerHTTPClient is a http client for an aggregatorClient configurationDefault configuration with all the default values for configurations.Adapter to convert [EpochSettingsMessage] to [EpochSettings].Adapter to turn [CertificatePendingMessage] instances into [CertificatePending].This is responsible of creating new instances of ProtocolInitializer.Implementation of the SingleSigner.Create a SignerService instance for Production environment.Implementation of the ProtocolInitializerStorerController methods for the Signer’s state machine.This structure groups all the services required by the state machine.The state machine is responsible of the execution of the signer automate.Adapter to create [RegisterSignerMessage] from [Signer] instance.Enums
Error structure for the Certificate Handler.MithrilProtocolInitializerBuilder error structure.This type represents the errors thrown from the Runner.RuntimeError
Error kinds tied to their faith in the state machine.Different possible states of the state machine.SingleSigner error structure.Traits
Trait for mocking and testing a CertificateHandler
Store the ProtocolInitializer used for each Epoch. This is useful because
protocol parameters and stake distribution change over time.This trait is mainly intended for mocking.The ServiceBuilder is intended to manage Services instance creation.
The goal of this is to put all this code out of the way of business code.The SingleSigner is the structure responsible of issuing SingleSignatures.
\ No newline at end of file
diff --git a/rust-doc/mithril_signer/struct.CertificateHandlerHTTPClient.html b/rust-doc/mithril_signer/struct.CertificateHandlerHTTPClient.html
index 3ce4296d5ab..5c492d36cdb 100644
--- a/rust-doc/mithril_signer/struct.CertificateHandlerHTTPClient.html
+++ b/rust-doc/mithril_signer/struct.CertificateHandlerHTTPClient.html
@@ -1,7 +1,7 @@
CertificateHandlerHTTPClient in mithril_signer - Rust pub struct CertificateHandlerHTTPClient { /* private fields */ }
Expand description
CertificateHandlerHTTPClient is a http client for an aggregator
Implementations§
source§impl CertificateHandlerHTTPClient
sourcepub fn prepare_request_builder(
&self,
request_builder: RequestBuilder
) -> RequestBuilder
Forge a client request adding protocol version in the headers.
-Trait Implementations§
source§impl CertificateHandler for CertificateHandlerHTTPClient
source§fn retrieve_epoch_settings<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Option<EpochSettings>, CertificateHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Retrieves epoch settings from the aggregatorsource§fn retrieve_pending_certificate<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Option<CertificatePending>, CertificateHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Retrieves a pending certificate from the aggregatorsource§fn register_signer<'life0, 'life1, 'async_trait>(
&'life0 self,
signer: &'life1 Signer
) -> Pin<Box<dyn Future<Output = Result<(), CertificateHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Registers signer with the aggregator.source§fn register_signatures<'life0, 'life1, 'async_trait>(
&'life0 self,
signatures: &'life1 SingleSignatures
) -> Pin<Box<dyn Future<Output = Result<(), CertificateHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Registers single signatures with the aggregator.Auto Trait Implementations§
§impl RefUnwindSafe for CertificateHandlerHTTPClient
§impl Send for CertificateHandlerHTTPClient
§impl Sync for CertificateHandlerHTTPClient
§impl Unpin for CertificateHandlerHTTPClient
§impl UnwindSafe for CertificateHandlerHTTPClient
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.Trait Implementations§
source§impl CertificateHandler for CertificateHandlerHTTPClient
source§fn retrieve_epoch_settings<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Option<EpochSettings>, CertificateHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Retrieves epoch settings from the aggregatorsource§fn retrieve_pending_certificate<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Result<Option<CertificatePending>, CertificateHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Retrieves a pending certificate from the aggregatorsource§fn register_signer<'life0, 'life1, 'async_trait>(
&'life0 self,
signer: &'life1 Signer
) -> Pin<Box<dyn Future<Output = Result<(), CertificateHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Registers signer with the aggregator.source§fn register_signatures<'life0, 'life1, 'async_trait>(
&'life0 self,
signatures: &'life1 SingleSignatures
) -> Pin<Box<dyn Future<Output = Result<(), CertificateHandlerError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Registers single signatures with the aggregator.Auto Trait Implementations§
§impl RefUnwindSafe for CertificateHandlerHTTPClient
§impl Send for CertificateHandlerHTTPClient
§impl Sync for CertificateHandlerHTTPClient
§impl Unpin for CertificateHandlerHTTPClient
§impl UnwindSafe for CertificateHandlerHTTPClient
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> Into<U> for Twhere
U: From<T>,
const: unstable · source§fn into(self) -> U
Calls U::from(self)
.
diff --git a/rust-doc/mithril_signer/struct.Configuration.html b/rust-doc/mithril_signer/struct.Configuration.html
index 86ef7939712..298362e164e 100644
--- a/rust-doc/mithril_signer/struct.Configuration.html
+++ b/rust-doc/mithril_signer/struct.Configuration.html
@@ -4,7 +4,7 @@
pub network_magic: Option<u64>,
pub network: String,
pub aggregator_endpoint: String,
- pub party_id: Option<PartyId>,
+ pub party_id: Option<PartyId>,
pub run_interval: u64,
pub db_directory: PathBuf,
pub data_stores_directory: PathBuf,
@@ -13,7 +13,7 @@
pub operational_certificate_path: Option<PathBuf>,
pub disable_digests_cache: bool,
pub reset_digests_cache: bool,
- pub era_reader_adapter_type: EraReaderAdapterType,
+ pub era_reader_adapter_type: EraReaderAdapterType,
pub era_reader_adapter_params: Option<String>,
}Expand description
Client configuration
Fields§
§cardano_cli_path: PathBuf
Cardano CLI tool path
@@ -23,7 +23,7 @@
useful for TestNet & DevNet
§network: String
Cardano network
§aggregator_endpoint: String
Aggregator endpoint
-§party_id: Option<PartyId>
Party Id
+§party_id: Option<PartyId>
Party Id
§run_interval: u64
Run Interval
§db_directory: PathBuf
Directory to snapshot
§data_stores_directory: PathBuf
Directory to store signer data (Stakes, Protocol initializers, …)
@@ -33,12 +33,12 @@
§disable_digests_cache: bool
Disable immutables digests cache.
§reset_digests_cache: bool
If set the existing immutables digests cache will be reset.
Will be ignored if set in conjunction with disable_digests_cache
.
-§era_reader_adapter_type: EraReaderAdapterType
Era reader adapter type
+§era_reader_adapter_type: EraReaderAdapterType
Era reader adapter type
§era_reader_adapter_params: Option<String>
Era reader adapter parameters
-Implementations§
source§impl Configuration
sourcepub fn get_network(&self) -> Result<CardanoNetwork, ConfigError>
Return the CardanoNetwork value from the configuration.
+Implementations§
source§impl Configuration
sourcepub fn get_network(&self) -> Result<CardanoNetwork, ConfigError>
Return the CardanoNetwork value from the configuration.
sourcepub fn get_sqlite_file(&self) -> PathBuf
Create the SQL store directory if not exist and return the path of the
SQLite3 file.
-sourcepub fn build_era_reader_adapter(
&self,
chain_observer: Arc<dyn ChainObserver>
) -> Result<Arc<dyn EraReaderAdapter>, Box<dyn Error>>
Create era reader adapter from configuration settings.
+Trait Implementations§
source§impl Clone for Configuration
source§fn clone(&self) -> Configuration
Returns a copy of the value. Read more1.0.0 · source§fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read moresource§impl Debug for Configuration
source§impl<'de> Deserialize<'de> for Configuration
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read moreAuto Trait Implementations§
§impl RefUnwindSafe for Configuration
§impl Send for Configuration
§impl Sync for Configuration
§impl Unpin for Configuration
§impl UnwindSafe for Configuration
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_signer/struct.FromEpochSettingsAdapter.html b/rust-doc/mithril_signer/struct.FromEpochSettingsAdapter.html
index 787041c3c6f..7e93c55e0c9 100644
--- a/rust-doc/mithril_signer/struct.FromEpochSettingsAdapter.html
+++ b/rust-doc/mithril_signer/struct.FromEpochSettingsAdapter.html
@@ -1,5 +1,5 @@
-FromEpochSettingsAdapter in mithril_signer - Rust Struct mithril_signer::FromEpochSettingsAdapter
source · pub struct FromEpochSettingsAdapter;
Expand description
Adapter to convert EpochSettingsMessage to EpochSettings.
-Implementations§
source§impl FromEpochSettingsAdapter
sourcepub fn adapt(message: EpochSettingsMessage) -> EpochSettings
Method to convert.
+FromEpochSettingsAdapter in mithril_signer - Rust Struct mithril_signer::FromEpochSettingsAdapter
source · pub struct FromEpochSettingsAdapter;
Expand description
Adapter to convert [EpochSettingsMessage] to [EpochSettings].
+Implementations§
Auto Trait Implementations§
§impl RefUnwindSafe for FromEpochSettingsAdapter
§impl Send for FromEpochSettingsAdapter
§impl Sync for FromEpochSettingsAdapter
§impl Unpin for FromEpochSettingsAdapter
§impl UnwindSafe for FromEpochSettingsAdapter
Blanket Implementations§
source§impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.source§impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
Instruments this type with the current Span
, returning an
diff --git a/rust-doc/mithril_signer/struct.FromPendingCertificateMessageAdapter.html b/rust-doc/mithril_signer/struct.FromPendingCertificateMessageAdapter.html
index 64aa8874e6c..45b149a322a 100644
--- a/rust-doc/mithril_signer/struct.FromPendingCertificateMessageAdapter.html
+++ b/rust-doc/mithril_signer/struct.FromPendingCertificateMessageAdapter.html
@@ -1,5 +1,5 @@
-FromPendingCertificateMessageAdapter in mithril_signer - Rust pub struct FromPendingCertificateMessageAdapter;
Expand description
Adapter to turn CertificatePendingMessage instances into CertificatePending.
-Implementations§
source§impl FromPendingCertificateMessageAdapter
sourcepub fn adapt(message: CertificatePendingMessage) -> CertificatePending
Adapter method
+FromPendingCertificateMessageAdapter in mithril_signer - Rust pub struct FromPendingCertificateMessageAdapter;
Expand description
Adapter to turn [CertificatePendingMessage] instances into [CertificatePending].
+Implementations§
Auto Trait Implementations§
§impl RefUnwindSafe for FromPendingCertificateMessageAdapter
§impl Send for FromPendingCertificateMessageAdapter
§impl Sync for FromPendingCertificateMessageAdapter
§impl Unpin for FromPendingCertificateMessageAdapter
§impl UnwindSafe for FromPendingCertificateMessageAdapter
Blanket Implementations§