pub struct RelaychainConfigBuilder<State> { /* private fields */ }
Expand description

A relay chain configuration builder, used to build a RelaychainConfig declaratively with fields validation.

Implementations§

source§

impl RelaychainConfigBuilder<Initial>

source

pub fn new( validation_context: Rc<RefCell<ValidationContext>> ) -> RelaychainConfigBuilder<Initial>

source

pub fn with_chain<T>(self, chain: T) -> RelaychainConfigBuilder<WithChain>
where T: TryInto<Chain>, T::Error: Error + Send + Sync + 'static,

Set the chain name (e.g. rococo-local).

source§

impl RelaychainConfigBuilder<WithChain>

source

pub fn with_default_command<T>(self, command: T) -> Self
where T: TryInto<Command>, T::Error: Error + Send + Sync + 'static,

Set the default command used for nodes. Can be overridden.

source

pub fn with_default_image<T>(self, image: T) -> Self
where T: TryInto<Image>, T::Error: Error + Send + Sync + 'static,

Set the default container image used for nodes. Can be overridden.

source

pub fn with_default_resources( self, f: impl FnOnce(ResourcesBuilder) -> ResourcesBuilder ) -> Self

Set the default resources limits used for nodes. Can be overridden.

source

pub fn with_default_db_snapshot( self, location: impl Into<AssetLocation> ) -> Self

Set the default database snapshot location that will be used for state. Can be overridden.

source

pub fn with_default_args(self, args: Vec<Arg>) -> Self

Set the default arguments that will be used to execute the node command. Can be overridden.

source

pub fn with_chain_spec_path(self, location: impl Into<AssetLocation>) -> Self

Set the location of a pre-existing chain specification for the relay chain.

source

pub fn with_chain_spec_command(self, cmd_template: impl Into<String>) -> Self

Set the chain-spec command template for the relay chain.

source

pub fn chain_spec_command_is_local(self, choice: bool) -> Self

Set if the chain-spec command needs to be run locally or not (false by default)

source

pub fn with_random_nominators_count(self, random_nominators_count: u32) -> Self

Set the number of random nominators to create for chains using staking, this is used in tandem with max_nominations to simulate the amount of nominators and nominations.

source

pub fn with_max_nominations(self, max_nominations: u8) -> Self

Set the maximum number of nominations to create per nominator.

source

pub fn with_genesis_overrides(self, genesis_overrides: impl Into<Value>) -> Self

Set the genesis overrides as a JSON object.

source

pub fn with_node( self, f: impl FnOnce(NodeConfigBuilder<Initial>) -> NodeConfigBuilder<Buildable> ) -> RelaychainConfigBuilder<WithAtLeastOneNode>

Add a new node using a nested NodeConfigBuilder.

source§

impl RelaychainConfigBuilder<WithAtLeastOneNode>

source

pub fn with_node( self, f: impl FnOnce(NodeConfigBuilder<Initial>) -> NodeConfigBuilder<Buildable> ) -> Self

Add a new node using a nested NodeConfigBuilder.

source

pub fn build(self) -> Result<RelaychainConfig, Vec<Error>>

Seals the builder and returns a RelaychainConfig if there are no validation errors, else returns errors.

Trait Implementations§

source§

impl Default for RelaychainConfigBuilder<Initial>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<State> Freeze for RelaychainConfigBuilder<State>

§

impl<State> !RefUnwindSafe for RelaychainConfigBuilder<State>

§

impl<State> !Send for RelaychainConfigBuilder<State>

§

impl<State> !Sync for RelaychainConfigBuilder<State>

§

impl<State> Unpin for RelaychainConfigBuilder<State>
where State: Unpin,

§

impl<State> !UnwindSafe for RelaychainConfigBuilder<State>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more