Struct sc_network::config::Params[][src]

pub struct Params<B: BlockT, H: ExHashT> {
Show 14 fields pub role: Role, pub executor: Option<Box<dyn Fn(Pin<Box<dyn Future<Output = ()> + Send>>) + Send>>, pub transactions_handler_executor: Box<dyn Fn(Pin<Box<dyn Future<Output = ()> + Send>>) + Send>, pub network_config: NetworkConfiguration, pub chain: Arc<dyn Client<B>>, pub transaction_pool: Arc<dyn TransactionPool<H, B>>, pub protocol_id: ProtocolId, pub import_queue: Box<dyn ImportQueue<B>>, pub block_announce_validator: Box<dyn BlockAnnounceValidator<B> + Send>, pub metrics_registry: Option<Registry>, pub block_request_protocol_config: RequestResponseConfig, pub light_client_request_protocol_config: RequestResponseConfig, pub state_request_protocol_config: RequestResponseConfig, pub warp_sync: Option<(Arc<dyn WarpSyncProvider<B>>, RequestResponseConfig)>,
}
Expand description

Network initialization parameters.

Fields

role: Role

Assigned role for our node (full, light, …).

executor: Option<Box<dyn Fn(Pin<Box<dyn Future<Output = ()> + Send>>) + Send>>

How to spawn background tasks. If you pass None, then a threads pool will be used by default.

transactions_handler_executor: Box<dyn Fn(Pin<Box<dyn Future<Output = ()> + Send>>) + Send>

How to spawn the background task dedicated to the transactions handler.

network_config: NetworkConfiguration

Network layer configuration.

chain: Arc<dyn Client<B>>

Client that contains the blockchain.

transaction_pool: Arc<dyn TransactionPool<H, B>>

Pool of transactions.

The network worker will fetch transactions from this object in order to propagate them on the network.

protocol_id: ProtocolId

Name of the protocol to use on the wire. Should be different for each chain.

import_queue: Box<dyn ImportQueue<B>>

Import queue to use.

The import queue is the component that verifies that blocks received from other nodes are valid.

block_announce_validator: Box<dyn BlockAnnounceValidator<B> + Send>

Type to check incoming block announcements.

metrics_registry: Option<Registry>

Registry for recording prometheus metrics to.

block_request_protocol_config: RequestResponseConfig

Request response configuration for the block request protocol.

RequestResponseConfig::name is used to tag outgoing block requests with the correct protocol name. In addition all of RequestResponseConfig is used to handle incoming block requests, if enabled.

Can be constructed either via crate::block_request_handler::generate_protocol_config allowing outgoing but not incoming requests, or constructed via crate::block_request_handler::BlockRequestHandler::new allowing both outgoing and incoming requests.

light_client_request_protocol_config: RequestResponseConfig

Request response configuration for the light client request protocol.

Can be constructed either via crate::light_client_requests::generate_protocol_config allowing outgoing but not incoming requests, or constructed via crate::light_client_requests::handler::LightClientRequestHandler::new allowing both outgoing and incoming requests.

state_request_protocol_config: RequestResponseConfig

Request response configuration for the state request protocol.

Can be constructed either via crate::block_request_handler::generate_protocol_config allowing outgoing but not incoming requests, or constructed via crate::state_request_handler::StateRequestHandler::new allowing both outgoing and incoming requests.

warp_sync: Option<(Arc<dyn WarpSyncProvider<B>>, RequestResponseConfig)>

Optional warp sync protocol support. Include protocol config and sync provider.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert from a value of T into an equivalent instance of Option<Self>. Read more

Consume self to return Some equivalent value of Option<T>. Read more

Converts self into T using Into<T>. Read more

Converts self into a target type. Read more

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Causes self to use its Binary implementation when Debug-formatted.

Causes self to use its Display implementation when Debug-formatted. Read more

Causes self to use its LowerExp implementation when Debug-formatted. Read more

Causes self to use its LowerHex implementation when Debug-formatted. Read more

Causes self to use its Octal implementation when Debug-formatted.

Causes self to use its Pointer implementation when Debug-formatted. Read more

Causes self to use its UpperExp implementation when Debug-formatted. Read more

Causes self to use its UpperHex implementation when Debug-formatted. Read more

Performs the conversion.

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

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

Performs the conversion.

Get a reference to the inner from the outer.

Get a mutable reference to the inner from the outer.

Pipes by value. This is generally the method you want to use. Read more

Borrows self and passes that borrow into the pipe function. Read more

Mutably borrows self and passes that borrow into the pipe function. Read more

Borrows self, then passes self.borrow() into the pipe function. Read more

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

Borrows self, then passes self.as_ref() into the pipe function.

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

Borrows self, then passes self.deref() into the pipe function.

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

Pipes a value into a function that cannot ordinarily be called in suffix position. Read more

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

Pipes a dereference into a function that cannot normally be called in suffix position. Read more

Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more

Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more

Pipes a mutable reference into a function that cannot ordinarily be called in suffix position. Read more

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be Self

Convert from a value of T into an equivalent instance of Self. Read more

Consume self to return an equivalent value of T. Read more

Immutable access to a value. Read more

Mutable access to a value. Read more

Immutable access to the Borrow<B> of a value. Read more

Mutable access to the BorrowMut<B> of a value. Read more

Immutable access to the AsRef<R> view of a value. Read more

Mutable access to the AsMut<R> view of a value. Read more

Immutable access to the Deref::Target of a value. Read more

Mutable access to the Deref::Target of a value. Read more

Calls .tap() only in debug builds, and is erased in release builds.

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

Provides immutable access for inspection. Read more

Calls tap in debug builds, and does nothing in release builds.

Provides mutable access for modification. Read more

Calls tap_mut in debug builds, and does nothing in release builds.

Provides immutable access to the reference for inspection.

Calls tap_ref in debug builds, and does nothing in release builds.

Provides mutable access to the reference for modification.

Calls tap_ref_mut in debug builds, and does nothing in release builds.

Provides immutable access to the borrow for inspection. Read more

Calls tap_borrow in debug builds, and does nothing in release builds.

Provides mutable access to the borrow for modification.

Calls tap_borrow_mut in debug builds, and does nothing in release builds. Read more

Immutably dereferences self for inspection.

Calls tap_deref in debug builds, and does nothing in release builds.

Mutably dereferences self for modification.

Calls tap_deref_mut in debug builds, and does nothing in release builds. Read more

Attempts to convert self into T using TryInto<T>. Read more

Attempts to convert self into a target type. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The counterpart to unchecked_from.

Consume self to return an equivalent value of T.

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

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