Struct iapyx::NodeLoadConfig

pub struct NodeLoadConfig {

    pub config: Configuration,
    pub use_v1: bool,
    pub batch_size: usize,
    pub criterion: Option<u8>,
    pub address: String,
    pub debug: bool,
    pub use_https: bool,
    pub read_pin_from_filename: bool,
    pub reuse_accounts_early: bool,
    pub reuse_accounts_lazy: bool,
    pub global_pin: String,
    pub qr_codes_folder: Option<PathBuf>,
    pub secrets_folder: Option<PathBuf>,
    pub voting_group: String,
}

Node Load configuration struct. It defines all aspects of load run.

Fields

config: Configuration

Inner configuration which controls common settings like grace period or step delay

use_v1: bool

Use REST API V1, which allows send batch votes or checking individual vote status

batch_size: usize

Batch size for single load step

criterion: Option<u8>

Success criteria for run. It helps to put simple assertion on outcome of load scenario. Usually it should be number from 0 to 100 describing for instance expected success rate for load messages

address: String

REST API address to be excercised by load tool

debug: bool

Print verbose information during load

use_https: bool

Use https protocol

read_pin_from_filename: bool

This parameter work in conjunction with global_pin and qr_codes_folder. If source of account secrets is a specific folder with qr codes, then each qr code need to be individually decrypted using pin code. This parameter defines strategy of acquiring pin for qr code. Using this parameter and with correct format of file (which should be for example alice_1234.png) load tool can successfully decrypt all qr code. Alternative for this setting is global pin.

reuse_accounts_early: bool

Sometimes we may want to run load tool again on the same environment. The problem is that, Jormungandr blockchain uses account based model so we need to refresh accounts spending counters This particular settings controls when load tool will refresh account. If set to true load tool will refresh all accounts before starting the load. It is important because it may be long operation depending on amount of source accounts

reuse_accounts_lazy: bool

This particular settings controls when load tool will refresh account. If set to true load tool will refresh all accounts just before running votes from particular account, removing necessity to wait for sync completion like when using reuse_accounts_early parameter.

global_pin: String

This parameter work in conjunction with qr_codes_folder. If for some reasons file name does not contain pin, then we can use this setting to set global pin for every qr code

qr_codes_folder: Option<PathBuf>

Source folder for seed qr codes which can be used during load scenario. Source can be either qr code folder (defined by qr_codes_folder) or secret key as bech32 file (defined by secrets_folder)

secrets_folder: Option<PathBuf>

Source folder for seed bech32 accounts file which will be use during load scenario

voting_group: String

Voting groups which account belongs to. Existence of this paramters clearly forbids mixed accounts (direct voters or reps)

Implementations

impl Config

pub fn rest_settings(&self) -> RestSettings

Gets rest settings

pub fn build_multi_controller(&self) -> Result<MultiController, Error>

Construct multi controller (for multi accounts handling)

Errors

On error reading qr or secret files

Panics

On internal os error when extracting path from directory for specific qr code

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.