Crate polkadot_service

Polkadot service. Specialized wrapper over substrate service.

Re-exports

• pub use self::overseer::OverseerGen;
• pub use self::overseer::OverseerGenArgs;
• pub use self::overseer::RealOverseerGen;
• pub use chain_spec::KusamaChainSpec;
• pub use chain_spec::PolkadotChainSpec;
• pub use chain_spec::RococoChainSpec;
• pub use chain_spec::WestendChainSpec;
• pub use kusama_runtime;
• pub use kusama_runtime_constants;
• pub use rococo_runtime;
• pub use rococo_runtime_constants;

Modules

• benchmarking
  Code related to benchmarking a node.
• chain_spec
  Polkadot chain configurations.
• generic
  Generic implementations of crate::traits::Header, crate::traits::Block and crate::traits::Extrinsic.
• overseer
• runtime_traits
  Primitives for the runtime modules.
• workers
  Utilities and tests for locating the PVF worker binaries.

Structs

• ApiRef
  Auxiliary wrapper that holds an api instance and binds it to the given lifetime.
• BlakeTwo256
  Blake2-256 Hash implementation.
• Configuration
  Service configuration.
• Handle
  A handle used to communicate with the Overseer.
• LongestChain
  Implement Longest Chain Select implementation where ‘longest’ is defined as the highest number of blocks
• NewFull
• NewFullParams
• Overseer
  The orchestra.
• OverseerConnector
  External connector.
• ParaId
  Unique identifier of a parachain.
• PrometheusConfig
  Configuration of the Prometheus endpoint.
• Proposal
  A proposal that is created by a Proposer.
• RuntimeApi
• SelectRelayChain
  A chain-selection implementation which provides safety for relay chains.
• TaskManager
  Helper struct to manage background/async tasks in Service.
• TransactionPoolOptions
  Pool configuration options.

Enums

• Chain
  Identifies the variant of the chain.
• DatabaseSource
  Where to find the database..
• Error
• IsParachainNode
  Is this node running as in-process node for a parachain node?
• PruningMode
  Pruning mode.
• Role
  Role of the local node.
• SubstrateServiceError
  Service errors.

Constants

• AVAILABILITY_CONFIG

Traits

• AuthorityDiscoveryApi
  The authority discovery api.
• AuxStore
  Provides access to an auxiliary database.
• BabeApi
  API necessary for block authorship with BABE.
• Backend
  Client backend.
• BlockImport
  Block import trait.
• BlockT
  Something which fulfills the abstract idea of a Substrate block. It has types for Extrinsic pieces of information as well as a Header.
• CallExecutor
  Method call executor.
• ChainSpec
  Common interface of a chain specification.
• ConstructRuntimeApi
  Something that can be constructed to a runtime api.
• CoreApi
  The Core runtime api that every Substrate runtime needs to implement.
• GetLastTimestamp
  This runtime API is only implemented for the test runtime!
• HeaderBackend
  Blockchain database header backend. Does not perform any validation.
• HeaderMetadata
  Handles header metadata: hash, number, parent hash, etc.
• HeaderProvider
  Provides the header and block number for a hash.
• HeaderProviderProvider
  Decoupling the provider.
• HeaderT
  Something which fulfills the abstract idea of a Substrate header. It has types for a Number, a Hash and a Hashing. It provides access to an extrinsics_root, state_root and parent_hash, as well as a digest and a block number.
• IdentifyVariant
  Can be called for a Configuration to identify which network the configuration targets.
• NativeExecutionDispatch
  Delegate for dispatching a CodeExecutor call.
• ParachainHost
  The API for querying the state of parachains on-chain.
• ProvideRuntimeApi
  Something that provides a runtime api.
• RuntimeGenesis
  A set of traits for the runtime genesis config.
• SelectChain
  The SelectChain trait defines the strategy upon which the head is chosen if multiple forks are present for an opaque definition of “best” in the specific chain build.
• StateBackend
  A state backend is used to read state data and can have changes committed to it.

Functions

• build_full
  Build a full node.
• new_chain_ops
  Builds a new object suitable for chain operations.
• new_full
  Create a new full node of arbitrary runtime and executor.
• open_database
• revert_backend
  Reverts the node state down to at most the last finalized block.

Type Definitions

• Block
  Block type.
• BlockId
  Block ID.
• BlockNumber
  The block number type used by Polkadot. 32-bits will allow for 136 years of blocks assuming 1 block per second.
• CollatorPair
  A Parachain collator keypair.
• FullBackend
• FullClient
• Hash
  A hash of some data used by the relay chain.
• NumberFor
  Extract the number type for a block.
• OverseerHandle
  Handle for an orchestra.
• TFullBackend
  Full client backend type.
• TFullCallExecutor
  Full client call executor type.
• TFullClient
  Full client type.