Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder that can be used to create a Client easily or with custom dependencies.

Implementations

impl ClientBuilder

pub fn aggregator( endpoint: &str, genesis_verification_key: &str, ) -> ClientBuilder

👎Deprecated since 0.12.36: Use new method instead and set the genesis verification key with set_genesis_verification_key

Constructs a new ClientBuilder that fetches data from the aggregator at the given endpoint and with the given genesis verification key.

pub fn automatic(network: &str, genesis_verification_key: &str) -> ClientBuilder

Available on non-target_family=wasm only.

Constructs a new ClientBuilder that automatically discovers the aggregator for the given Mithril network and with the given genesis verification key.

pub fn new(aggregator_discovery: AggregatorDiscoveryType) -> ClientBuilder

Constructs a new ClientBuilder without any dependency set.

pub fn set_genesis_verification_key( self, genesis_verification_key: GenesisVerificationKey, ) -> ClientBuilder

Sets the genesis verification key to use when verifying certificates.

pub fn with_capabilities( self, capabilities: RequiredAggregatorCapabilities, ) -> ClientBuilder

Available on non-target_family=wasm only.

Sets the aggregator capabilities expected to be matched by the aggregator with which the client will interact.

pub fn with_aggregator_discoverer( self, discoverer: Arc<dyn AggregatorDiscoverer>, ) -> ClientBuilder

Available on non-target_family=wasm only.

Sets the aggregator discoverer to use to find the aggregator endpoint when in automatic discovery.

pub fn build(self) -> MithrilResult<Client>

Returns a Client that uses the dependencies provided to this ClientBuilder.

The builder will try to create the missing dependencies using default implementations if possible.

pub fn discover_aggregator( &self, network: &MithrilNetwork, ) -> MithrilResult<impl Iterator<Item = AggregatorEndpoint>>

Available on non-target_family=wasm only.

Discover available aggregator endpoints for the given Mithril network and required capabilities.

pub fn with_era_fetcher(self, era_fetcher: Arc<dyn EraFetcher>) -> ClientBuilder

Sets the EraFetcher that will be used by the client to retrieve the current Mithril era.

pub fn with_certificate_verifier( self, certificate_verifier: Arc<dyn CertificateVerifier>, ) -> ClientBuilder

Set the CertificateVerifier that will be used to validate certificates.

pub fn with_certificate_verifier_cache( self, certificate_verifier_cache: Option<Arc<dyn CertificateVerifierCache>>, ) -> ClientBuilder

Available on crate feature unstable only.

Set the CertificateVerifierCache that will be used to cache certificate validation results.

Passing a None value will disable the cache if any was previously set.

pub fn with_http_file_downloader( self, http_file_downloader: Arc<dyn FileDownloader>, ) -> ClientBuilder

Available on crate feature fs only.

Set the FileDownloader that will be used to download artifacts with HTTP.

pub fn set_ancillary_verification_key<T: Into<Option<String>>>( self, ancillary_verification_key: T, ) -> ClientBuilder

Available on crate feature fs only.

Set the ancillary verification key to use when verifying the downloaded ancillary files.

pub fn with_logger(self, logger: Logger) -> Self

Set the Logger to use.

pub fn with_origin_tag(self, origin_tag: Option<String>) -> Self

Set the origin tag.

pub fn with_client_type(self, client_type: Option<String>) -> Self

Set the client type.

pub fn with_options(self, options: ClientOptions) -> Self

Sets the options to be used by the client.

pub fn add_feedback_receiver(self, receiver: Arc<dyn FeedbackReceiver>) -> Self

Add a feedback receiver to receive events for tasks that can have a long duration (ie: snapshot download or a long certificate chain validation).