Struct AuthoritySelectionDataSourceMock 

pub struct AuthoritySelectionDataSourceMock {
    pub registrations_data: MockRegistrationsConfig,
}

Mock authority selection data source that serves registration data in a round-robin fashion

Creating the data source

This data source can be created by wrapping a manually created MockRegistrationsConfig. However, the preferred way to do it is by loading the registrations data from a JSON file using the MockRegistrationsConfig::read_registrations method.

An example configuration file can look like this:

[
  {
    "permissioned": [
        {
            "name": "Test permissioned account 1",
            "sidechain_pub_key": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "aura_pub_key": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "grandpa_pub_key": "0x0000000000000000000000000000000000000000000000000000000000000000"
        }
    ],
    "registrations": [
        {
            "name": "Test registered account 2",
            "sidechain_pub_key": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "mainchain_pub_key": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "mainchain_signature": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "sidechain_signature": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "registration_utxo": "0x0000000000000000000000000000000000000000000000000000000000000000#0",
            "status": "Active",
            "aura_pub_key": "0x0000000000000000000000000000000000000000000000000000000000000000",
            "grandpa_pub_key": "0x0000000000000000000000000000000000000000000000000000000000000000"
        }
    ],
    "nonce": "0x0000000000000000000000000000000000000000000000000000000000000000",
    "d_parameter": {
      "permissioned": 16,
      "registered": 16
    }
  }
]

See the structure and documentation of MockEpochCandidates for more information.

This file can be loaded and used to create a data source like this:

use partner_chains_mock_data_sources::*;

let registrations_data = MockRegistrationsConfig::read_registrations("registrations.json").unwrap();

let data_source = AuthoritySelectionDataSourceMock { registrations_data };

Alternatively the data source can be created using AuthoritySelectionDataSourceMock::new_from_env:

use partner_chains_mock_data_sources::AuthoritySelectionDataSourceMock;

let data_source = AuthoritySelectionDataSourceMock::new_from_env();

The file name fill be then sourced from the MOCK_REGISTRATIONS_FILE environment variable.

Fields

registrations_data: MockRegistrationsConfig

Data source configuration containing the mock data to be served

Implementations

impl AuthoritySelectionDataSourceMock

pub fn new_from_env() -> Result<Self, Box<dyn Error + Send + Sync>>

Creates a new mocked authority selection data source using configuration from th file pointed to by the MOCK_REGISTRATIONS_FILE environment variable.

Trait Implementations

impl AuthoritySelectionDataSource for AuthoritySelectionDataSourceMock

fn get_ariadne_parameters<'life0, 'async_trait>( &'life0 self, epoch_number: McEpochNumber, _d_parameter_validator: PolicyId, _permissioned_candidates_validator: PolicyId, ) -> Pin<Box<dyn Future<Output = Result<AriadneParameters, Box<dyn Error + Send + Sync>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns D-parameter and list of permissioned candidates that is effective for the given epoch. The data from the latest block of data_epoch(epoch) will be used if available, otherwise returns data at the latest block of the chain.

fn get_candidates<'life0, 'async_trait>( &'life0 self, epoch: McEpochNumber, _committee_candidate_address: MainchainAddress, ) -> Pin<Box<dyn Future<Output = Result<Vec<CandidateRegistrations>, Box<dyn Error + Send + Sync>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the list of registrations that is effective for the given epoch. The data from the latest block of data_epoch(epoch) will be used if available, otherwise returns data at the latest block of the chain. Each item is a list of one candidate registrations.

fn get_epoch_nonce<'life0, 'async_trait>( &'life0 self, epoch_number: McEpochNumber, ) -> Pin<Box<dyn Future<Output = Result<Option<EpochNonce>, Box<dyn Error + Send + Sync>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns Cardano Epoch Nonce. None, if the nonce for given epoch is not known yet.

fn data_epoch<'life0, 'async_trait>( &'life0 self, for_epoch: McEpochNumber, ) -> Pin<Box<dyn Future<Output = Result<McEpochNumber, Box<dyn Error + Send + Sync>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Arguments