[][src]Crate sc_service

Substrate service. Starts a thread that spins up the network, client, and extrinsic pool. Manages communication between them.

Re-exports

pub use self::error::Error;
pub use config::BasePath;
pub use config::Configuration;
pub use config::RpcMethods;
pub use config::TaskExecutor;
pub use config::TaskType;

Modules

chain_ops

Chain utilities.

client

Substrate Client and associated logic.

config

Service configuration.

error

Errors that can occur during the service operation.

Structs

GenericChainSpec

A configuration of a chain. Can be used to build a genesis block.

NetworkStatusSinks

Sinks to propagate network status updates. For each element, every time the Interval fires we push an element on the sender.

NoopRpcExtensionBuilder

A utility struct for implementing an RpcExtensionBuilder given a cloneable RpcExtension, the resulting builder will simply ignore the provided DenyUnsafe instance and return a static RpcExtension instance.

RpcHandlers

RPC handlers that can perform RPC queries.

RpcMetadata

RPC Metadata.

RpcSession

An RPC session. Used to perform in-memory RPC queries (ie. RPC queries that don't go through the HTTP or WebSockets server).

ServiceComponents

The individual components of the chain, built by the service builder. You are encouraged to deconstruct this into its fields.

ServiceParams

Parameters to pass into build.

SpawnTaskHandle

An handle for spawning tasks in the service.

TaskManager

Helper struct to manage background/async tasks in Service.

TelemetryOnConnectSinks

Sinks to propagate telemetry connection established events.

TransactionPoolAdapter

Transaction pool adapter.

TransactionPoolOptions

Pool configuration options.

Enums

ChainType

The type of a chain.

DatabaseConfig

Where to find the database..

PruningMode

Pruning mode.

Role

Role of the local node.

TracingReceiver

Used to configure how to receive the metrics

Traits

ChainSpec

Common interface of a chain specification.

ChainSpecExtension

A collection of ChainSpec extensions.

ImportQueue

Blocks import queue API.

InPoolTransaction

In-pool transaction interface.

IntoPoolError

Transaction pool error conversion.

MallocSizeOfWasm

A type that implements MallocSizeOf on native but not wasm.

NativeExecutionDispatch

Delegate for dispatching a CodeExecutor call.

RpcExtensionBuilder

A utility trait for building an RPC extension given a DenyUnsafe instance. This is useful since at service definition time we don't know whether the specific interface where the RPC extension will be exposed is safe or not. This trait allows us to lazily build the RPC extension whenever we bind the service to an interface.

RuntimeGenesis

A set of traits for the runtime genesis config.

TransactionPool

Transaction pool interface.

Functions

build

Put together the components of a service from the parameters.

new_client

Create an instance of db-backed client.

new_full_client

Creates a new full client for the given config.

new_full_parts

Create the initial parts of a full node.

new_light_parts

Create the initial parts of a light node.

Type Definitions

NoExtension

A type denoting empty extensions.

Properties

Arbitrary properties defined in chain spec as a JSON object

TFullBackend

Full client backend type.

TFullCallExecutor

Full client call executor type.

TFullClient

Full client type.

TLightBackend

Light client backend type.

TLightBackendWithHash

Light client backend type with a specific hash type.

TLightCallExecutor

Light call executor type.

TLightClient

Light client type.

TLightClientWithBackend

Light client type with a specific backend.