Struct ClientBuilder

pub struct ClientBuilder { /* private fields */ }

Builder than 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

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

pub fn new(genesis_verification_key: &str) -> ClientBuilder

Constructs a new ClientBuilder without any dependency set.

Use ClientBuilder::aggregator if you don’t need to set a custom AggregatorClient to request data from the aggregator.

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 with_aggregator_client( self, aggregator_client: Arc<dyn AggregatorClient>, ) -> ClientBuilder

Set the AggregatorClient that will be used to request data to the aggregator.

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

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_snapshot_downloader( self, snapshot_downloader: Arc<dyn SnapshotDownloader>, ) -> ClientBuilder

Set the SnapshotDownloader that will be used to download snapshots.

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

Set the [Logger] to use.

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).

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

Sets the options to be used by the client.