Struct CertificateChainBuilder

pub struct CertificateChainBuilder<'a> { /* private fields */ }

A builder for creating a certificate chain. For tests only.

Simple example usage for building a fully valid certificate chain

    use mithril_common::crypto_helper::ProtocolParameters;
    use mithril_common::test_utils::CertificateChainBuilder;

    let (certificate_chain, _protocol_genesis_verifier) = CertificateChainBuilder::new()
        .with_total_certificates(5)
        .with_certificates_per_epoch(2)
        .build();

    assert_eq!(5, certificate_chain.len());

More complex example usage for building a fully valid certificate chain

    use std::cmp::min;
    use mithril_common::crypto_helper::ProtocolParameters;
    use mithril_common::test_utils::CertificateChainBuilder;

    let (certificate_chain, _protocol_genesis_verifier) = CertificateChainBuilder::new()
        .with_total_certificates(5)
        .with_certificates_per_epoch(2)
        .with_protocol_parameters(ProtocolParameters {
            m: 100,
            k: 5,
            phi_f: 0.65,
        })
        .with_total_signers_per_epoch_processor(&|epoch| min(1 + *epoch as usize, 10))
        .build();

    assert_eq!(5, certificate_chain.len());

Advanced example usage for building an adversarial certificate chain

    use mithril_common::entities::Epoch;
    use mithril_common::crypto_helper::ProtocolParameters;
    use mithril_common::test_utils::CertificateChainBuilder;

    let (certificate_chain, _protocol_genesis_verifier) = CertificateChainBuilder::new()
        .with_total_certificates(5)
        .with_certificates_per_epoch(2)
        .with_standard_certificate_processor(&|certificate, context| {
            let mut certificate = certificate;
            // Alter the epoch of the last certificate
            if context.is_last_certificate() {
                certificate.epoch = Epoch(123);
            }

            certificate
       })
       .build();

    assert_eq!(5, certificate_chain.len());

Implementations

impl<'a> CertificateChainBuilder<'a>

pub fn new() -> Self

Create a new CertificateChainBuilder instance.

pub fn with_total_certificates(self, total_certificates: u64) -> Self

Set the total number of certificates to generate.

pub fn with_certificates_per_epoch(self, certificates_per_epoch: u64) -> Self

Set the number of certificates per epoch.

pub fn with_protocol_parameters( self, protocol_parameters: ProtocolParameters, ) -> Self

Set the protocol parameters.

pub fn with_total_signers_per_epoch_processor( self, total_signers_per_epoch_processor: &'a dyn Fn(Epoch) -> usize, ) -> Self

Set the total signers per epoch processor.

pub fn with_genesis_certificate_processor( self, genesis_certificate_processor: &'a dyn Fn(Certificate, &CertificateChainBuilderContext<'_>, &ProtocolGenesisSigner) -> Certificate, ) -> Self

Set the genesis certificate processor.

pub fn with_standard_certificate_processor( self, standard_certificate_processor: &'a dyn Fn(Certificate, &CertificateChainBuilderContext<'_>) -> Certificate, ) -> Self

Set the standard certificate processor.

pub fn with_certificate_chaining_method( self, certificate_chaining_method: CertificateChainingMethod, ) -> Self

Set the chaining method to use when building the certificate chain.

pub fn build(self) -> (Vec<Certificate>, ProtocolGenesisVerifier)

Build the certificate chain.

Trait Implementations

impl Default for CertificateChainBuilder<'_>

fn default() -> Self

Returns the “default value” for a type.