cargo spellcheck (#3067)

This commit is contained in:
Bernhard Schuster
2021-05-22 02:15:47 +02:00
committed by GitHub
parent 9b06a38bb6
commit e8652e73db
34 changed files with 69 additions and 69 deletions
+1 -1
View File
@@ -24,7 +24,7 @@ service that can be used to run a Polkadot node. This is disabled by default,
and can be started by running `systemctl start polkadot` on demand (use and can be started by running `systemctl start polkadot` on demand (use
`systemctl enable polkadot` to make it auto-start after reboot). By default, it `systemctl enable polkadot` to make it auto-start after reboot). By default, it
will run as the `polkadot` user. Command-line flags passed to the binary can will run as the `polkadot` user. Command-line flags passed to the binary can
be customised by editing `/etc/default/polkadot`. This file will not be be customized by editing `/etc/default/polkadot`. This file will not be
overwritten on updating polkadot. You may also just run the node directly from overwritten on updating polkadot. You may also just run the node directly from
the command-line. the command-line.
@@ -79,7 +79,7 @@ sp_api::decl_runtime_apis! {
/// ///
/// Returns `None` if message is too expensive to be sent to Kusama from this chain. /// Returns `None` if message is too expensive to be sent to Kusama from this chain.
/// ///
/// Please keep in mind that this method returns lowest message fee required for message /// Please keep in mind that this method returns the lowest message fee required for message
/// to be accepted to the lane. It may be good idea to pay a bit over this price to account /// to be accepted to the lane. It may be good idea to pay a bit over this price to account
/// future exchange rate changes and guarantee that relayer would deliver your message /// future exchange rate changes and guarantee that relayer would deliver your message
/// to the target chain. /// to the target chain.
@@ -109,7 +109,7 @@ sp_api::decl_runtime_apis! {
pub trait FromKusamaInboundLaneApi { pub trait FromKusamaInboundLaneApi {
/// Returns nonce of the latest message, received by given lane. /// Returns nonce of the latest message, received by given lane.
fn latest_received_nonce(lane: LaneId) -> MessageNonce; fn latest_received_nonce(lane: LaneId) -> MessageNonce;
/// Nonce of latest message that has been confirmed to the bridged chain. /// Nonce of the latest message that has been confirmed to the bridged chain.
fn latest_confirmed_nonce(lane: LaneId) -> MessageNonce; fn latest_confirmed_nonce(lane: LaneId) -> MessageNonce;
/// State of the unrewarded relayers set at given lane. /// State of the unrewarded relayers set at given lane.
fn unrewarded_relayers_state(lane: LaneId) -> UnrewardedRelayersState; fn unrewarded_relayers_state(lane: LaneId) -> UnrewardedRelayersState;
@@ -79,7 +79,7 @@ sp_api::decl_runtime_apis! {
/// ///
/// Returns `None` if message is too expensive to be sent to Polkadot from this chain. /// Returns `None` if message is too expensive to be sent to Polkadot from this chain.
/// ///
/// Please keep in mind that this method returns lowest message fee required for message /// Please keep in mind that this method returns the lowest message fee required for message
/// to be accepted to the lane. It may be good idea to pay a bit over this price to account /// to be accepted to the lane. It may be good idea to pay a bit over this price to account
/// future exchange rate changes and guarantee that relayer would deliver your message /// future exchange rate changes and guarantee that relayer would deliver your message
/// to the target chain. /// to the target chain.
@@ -109,7 +109,7 @@ sp_api::decl_runtime_apis! {
pub trait FromPolkadotInboundLaneApi { pub trait FromPolkadotInboundLaneApi {
/// Returns nonce of the latest message, received by given lane. /// Returns nonce of the latest message, received by given lane.
fn latest_received_nonce(lane: LaneId) -> MessageNonce; fn latest_received_nonce(lane: LaneId) -> MessageNonce;
/// Nonce of latest message that has been confirmed to the bridged chain. /// Nonce of the latest message that has been confirmed to the bridged chain.
fn latest_confirmed_nonce(lane: LaneId) -> MessageNonce; fn latest_confirmed_nonce(lane: LaneId) -> MessageNonce;
/// State of the unrewarded relayers set at given lane. /// State of the unrewarded relayers set at given lane.
fn unrewarded_relayers_state(lane: LaneId) -> UnrewardedRelayersState; fn unrewarded_relayers_state(lane: LaneId) -> UnrewardedRelayersState;
@@ -127,7 +127,7 @@ sp_api::decl_runtime_apis! {
/// ///
/// Returns `None` if message is too expensive to be sent to Rococo from this chain. /// Returns `None` if message is too expensive to be sent to Rococo from this chain.
/// ///
/// Please keep in mind that this method returns lowest message fee required for message /// Please keep in mind that this method returns the lowest message fee required for message
/// to be accepted to the lane. It may be good idea to pay a bit over this price to account /// to be accepted to the lane. It may be good idea to pay a bit over this price to account
/// future exchange rate changes and guarantee that relayer would deliver your message /// future exchange rate changes and guarantee that relayer would deliver your message
/// to the target chain. /// to the target chain.
@@ -157,7 +157,7 @@ sp_api::decl_runtime_apis! {
pub trait FromRococoInboundLaneApi { pub trait FromRococoInboundLaneApi {
/// Returns nonce of the latest message, received by given lane. /// Returns nonce of the latest message, received by given lane.
fn latest_received_nonce(lane: LaneId) -> MessageNonce; fn latest_received_nonce(lane: LaneId) -> MessageNonce;
/// Nonce of latest message that has been confirmed to the bridged chain. /// Nonce of the latest message that has been confirmed to the bridged chain.
fn latest_confirmed_nonce(lane: LaneId) -> MessageNonce; fn latest_confirmed_nonce(lane: LaneId) -> MessageNonce;
/// State of the unrewarded relayers set at given lane. /// State of the unrewarded relayers set at given lane.
fn unrewarded_relayers_state(lane: LaneId) -> UnrewardedRelayersState; fn unrewarded_relayers_state(lane: LaneId) -> UnrewardedRelayersState;
@@ -141,7 +141,7 @@ sp_api::decl_runtime_apis! {
/// ///
/// Returns `None` if message is too expensive to be sent to Westend from this chain. /// Returns `None` if message is too expensive to be sent to Westend from this chain.
/// ///
/// Please keep in mind that this method returns lowest message fee required for message /// Please keep in mind that this method returns the lowest message fee required for message
/// to be accepted to the lane. It may be good idea to pay a bit over this price to account /// to be accepted to the lane. It may be good idea to pay a bit over this price to account
/// future exchange rate changes and guarantee that relayer would deliver your message /// future exchange rate changes and guarantee that relayer would deliver your message
/// to the target chain. /// to the target chain.
@@ -171,7 +171,7 @@ sp_api::decl_runtime_apis! {
pub trait FromWestendInboundLaneApi { pub trait FromWestendInboundLaneApi {
/// Returns nonce of the latest message, received by given lane. /// Returns nonce of the latest message, received by given lane.
fn latest_received_nonce(lane: LaneId) -> MessageNonce; fn latest_received_nonce(lane: LaneId) -> MessageNonce;
/// Nonce of latest message that has been confirmed to the bridged chain. /// Nonce of the latest message that has been confirmed to the bridged chain.
fn latest_confirmed_nonce(lane: LaneId) -> MessageNonce; fn latest_confirmed_nonce(lane: LaneId) -> MessageNonce;
/// State of the unrewarded relayers set at given lane. /// State of the unrewarded relayers set at given lane.
fn unrewarded_relayers_state(lane: LaneId) -> UnrewardedRelayersState; fn unrewarded_relayers_state(lane: LaneId) -> UnrewardedRelayersState;
@@ -70,7 +70,7 @@ pub type InstanceId = [u8; 4];
/// Type of accounts on the source chain. /// Type of accounts on the source chain.
pub enum SourceAccount<T> { pub enum SourceAccount<T> {
/// An account that belongs to Root (priviledged origin). /// An account that belongs to Root (privileged origin).
Root, Root,
/// A non-priviledged account. /// A non-priviledged account.
/// ///
@@ -82,7 +82,7 @@ pub enum SourceAccount<T> {
/// Derive an account ID from a foreign account ID. /// Derive an account ID from a foreign account ID.
/// ///
/// This function returns an encoded Blake2 hash. It is the responsibility of the caller to ensure /// This function returns an encoded Blake2 hash. It is the responsibility of the caller to ensure
/// this can be succesfully decoded into an AccountId. /// this can be successfully decoded into an AccountId.
/// ///
/// The `bridge_id` is used to provide extra entropy when producing account IDs. This helps prevent /// The `bridge_id` is used to provide extra entropy when producing account IDs. This helps prevent
/// AccountId collisions between different bridges on a single target chain. /// AccountId collisions between different bridges on a single target chain.
+1 -1
View File
@@ -168,7 +168,7 @@ impl Artifacts {
.is_none()); .is_none());
} }
/// Remove and retrive the artifacts from the table that are older than the supplied Time-To-Live. /// Remove and retrieve the artifacts from the table that are older than the supplied Time-To-Live.
pub fn prune(&mut self, artifact_ttl: Duration) -> Vec<ArtifactId> { pub fn prune(&mut self, artifact_ttl: Duration) -> Vec<ArtifactId> {
let now = SystemTime::now(); let now = SystemTime::now();
+5 -5
View File
@@ -52,8 +52,8 @@ impl ValidationHost {
/// Execute PVF with the given code, params and priority. The result of execution will be sent /// Execute PVF with the given code, params and priority. The result of execution will be sent
/// to the provided result sender. /// to the provided result sender.
/// ///
/// This is async to accomodate the fact a possibility of back-pressure. In vast majority of /// This is async to accommodate the fact a possibility of back-pressure. In the vast majority of
/// situations this function should return immediatelly. /// situations this function should return immediately.
/// ///
/// Returns an error if the request cannot be sent to the validation host, i.e. if it shut down. /// Returns an error if the request cannot be sent to the validation host, i.e. if it shut down.
pub async fn execute_pvf( pub async fn execute_pvf(
@@ -76,8 +76,8 @@ impl ValidationHost {
/// Sends a signal to the validation host requesting to prepare a list of the given PVFs. /// Sends a signal to the validation host requesting to prepare a list of the given PVFs.
/// ///
/// This is async to accomodate the fact a possibility of back-pressure. In vast majority of /// This is async to accommodate the fact a possibility of back-pressure. In the vast majority of
/// situations this function should return immediatelly. /// situations this function should return immediately.
/// ///
/// Returns an error if the request cannot be sent to the validation host, i.e. if it shut down. /// Returns an error if the request cannot be sent to the validation host, i.e. if it shut down.
pub async fn heads_up(&mut self, active_pvfs: Vec<Pvf>) -> Result<(), String> { pub async fn heads_up(&mut self, active_pvfs: Vec<Pvf>) -> Result<(), String> {
@@ -219,7 +219,7 @@ struct PendingExecutionRequest {
result_tx: ResultSender, result_tx: ResultSender,
} }
/// A mapping from an artifact ID which is in preparation state to the list of pending exeuction /// A mapping from an artifact ID which is in preparation state to the list of pending execution
/// requests that should be executed once the artifact's prepration is finished. /// requests that should be executed once the artifact's prepration is finished.
#[derive(Default)] #[derive(Default)]
struct AwaitingPrepare(HashMap<ArtifactId, Vec<PendingExecutionRequest>>); struct AwaitingPrepare(HashMap<ArtifactId, Vec<PendingExecutionRequest>>);
@@ -68,7 +68,7 @@ pub enum Fatal {
Runtime(#[from] #[source] runtime::Fatal), Runtime(#[from] #[source] runtime::Fatal),
} }
/// Non fatal errors of this subsystem. /// Non-fatal errors of this subsystem.
#[derive(Debug, Error)] #[derive(Debug, Error)]
pub enum NonFatal { pub enum NonFatal {
/// av-store will drop the sender on any error that happens. /// av-store will drop the sender on any error that happens.
@@ -221,13 +221,13 @@ impl FetchTask {
} }
} }
/// Whether or not there are still relay parents around with this candidate pending /// Whether there are still relay parents around with this candidate pending
/// availability. /// availability.
pub fn is_live(&self) -> bool { pub fn is_live(&self) -> bool {
!self.live_in.is_empty() !self.live_in.is_empty()
} }
/// Whether or not this task can be considered finished. /// Whether this task can be considered finished.
/// ///
/// That is, it is either canceled, succeeded or failed. /// That is, it is either canceled, succeeded or failed.
pub fn is_finished(&self) -> bool { pub fn is_finished(&self) -> bool {
@@ -91,7 +91,7 @@ impl Requester {
} }
/// Update heads that need availability distribution. /// Update heads that need availability distribution.
/// ///
/// For all active heads we will be fetching our chunks for availabilty distribution. /// For all active heads we will be fetching our chunks for availability distribution.
#[tracing::instrument(level = "trace", skip(self, ctx, runtime, update), fields(subsystem = LOG_TARGET))] #[tracing::instrument(level = "trace", skip(self, ctx, runtime, update), fields(subsystem = LOG_TARGET))]
pub async fn update_fetching_heads<Context>( pub async fn update_fetching_heads<Context>(
&mut self, &mut self,
@@ -68,7 +68,7 @@ pub struct TestState {
pub relay_chain: Vec<Hash>, pub relay_chain: Vec<Hash>,
/// Whenever the subsystem tries to fetch an erasure chunk one item of the given vec will be /// Whenever the subsystem tries to fetch an erasure chunk one item of the given vec will be
/// popped. So you can experiment with serving invalid chunks or no chunks on request and see /// popped. So you can experiment with serving invalid chunks or no chunks on request and see
/// whether the subystem still succeds with its goal. /// whether the subsystem still succeeds with its goal.
pub chunks: HashMap<(CandidateHash, ValidatorIndex), Vec<Option<ErasureChunk>>>, pub chunks: HashMap<(CandidateHash, ValidatorIndex), Vec<Option<ErasureChunk>>>,
/// All chunks that are valid and should be accepted. /// All chunks that are valid and should be accepted.
pub valid_chunks: HashSet<(CandidateHash, ValidatorIndex)>, pub valid_chunks: HashSet<(CandidateHash, ValidatorIndex)>,
@@ -233,7 +233,7 @@ impl BitfieldDistribution {
} }
} }
/// Modify the reputation of a peer based on its behaviour. /// Modify the reputation of a peer based on its behavior.
#[tracing::instrument(level = "trace", skip(ctx), fields(subsystem = LOG_TARGET))] #[tracing::instrument(level = "trace", skip(ctx), fields(subsystem = LOG_TARGET))]
async fn modify_reputation<Context>( async fn modify_reputation<Context>(
ctx: &mut Context, ctx: &mut Context,
@@ -560,7 +560,7 @@ where
} }
} }
/// Handle the changes necassary when our view changes. /// Handle the changes necessary when our view changes.
#[tracing::instrument(level = "trace", fields(subsystem = LOG_TARGET))] #[tracing::instrument(level = "trace", fields(subsystem = LOG_TARGET))]
fn handle_our_view_change(state: &mut ProtocolState, view: OurView) { fn handle_our_view_change(state: &mut ProtocolState, view: OurView) {
let old_view = std::mem::replace(&mut (state.view), view); let old_view = std::mem::replace(&mut (state.view), view);
+1 -1
View File
@@ -317,7 +317,7 @@ impl<Net, AD, Context> Subsystem<Context> for NetworkBridge<Net, AD>
} }
struct PeerData { struct PeerData {
/// Latest view sent by the peer. /// The Latest view sent by the peer.
view: View, view: View,
} }
+1 -1
View File
@@ -93,7 +93,7 @@ where
/// An action to be carried out by the network. /// An action to be carried out by the network.
/// ///
/// This type is used for implementing `Sink` in order to cummunicate asynchronously with the /// This type is used for implementing `Sink` in order to communicate asynchronously with the
/// underlying network implementation in the `Network` trait. /// underlying network implementation in the `Network` trait.
#[derive(Debug, PartialEq)] #[derive(Debug, PartialEq)]
pub enum NetworkAction { pub enum NetworkAction {
@@ -1048,7 +1048,7 @@ mod tests {
/// Generate a new relay parent and inform the subsystem about the new view. /// Generate a new relay parent and inform the subsystem about the new view.
/// ///
/// If `merge_views == true` it means the subsystem will be informed that we working on the old `relay_parent` /// If `merge_views == true` it means the subsystem will be informed that we are working on the old `relay_parent`
/// and the new one. /// and the new one.
async fn advance_to_new_round(&mut self, virtual_overseer: &mut VirtualOverseer, merge_views: bool) { async fn advance_to_new_round(&mut self, virtual_overseer: &mut VirtualOverseer, merge_views: bool) {
let old_relay_parent = self.relay_parent; let old_relay_parent = self.relay_parent;
@@ -1339,7 +1339,7 @@ mod tests {
); );
} }
/// Check that the next received message is a collation advertisment message. /// Check that the next received message is a collation advertisement message.
async fn expect_advertise_collation_msg( async fn expect_advertise_collation_msg(
virtual_overseer: &mut VirtualOverseer, virtual_overseer: &mut VirtualOverseer,
peer: &PeerId, peer: &PeerId,
+4 -4
View File
@@ -324,14 +324,14 @@ pub mod v1 {
LargeStatement(StatementMetadata), LargeStatement(StatementMetadata),
} }
/// Data that maes a statement unique. /// Data that makes a statement unique.
#[derive(Debug, Clone, Encode, Decode, PartialEq, Eq, Hash)] #[derive(Debug, Clone, Encode, Decode, PartialEq, Eq, Hash)]
pub struct StatementMetadata { pub struct StatementMetadata {
/// Relayt parent this statement is relevant under. /// Relay parent this statement is relevant under.
pub relay_parent: Hash, pub relay_parent: Hash,
/// Hash of the candidate that got validated. /// Hash of the candidate that got validated.
pub candidate_hash: CandidateHash, pub candidate_hash: CandidateHash,
/// Validator that attested the valididty. /// Validator that attested the validity.
pub signed_by: ValidatorIndex, pub signed_by: ValidatorIndex,
/// Signature of seconding validator. /// Signature of seconding validator.
pub signature: ValidatorSignature, pub signature: ValidatorSignature,
@@ -369,7 +369,7 @@ pub mod v1 {
} }
} }
/// Whether or not this message contains a large statement. /// Whether this message contains a large statement.
pub fn is_large_statement(&self) -> bool { pub fn is_large_statement(&self) -> bool {
if let Self::LargeStatement(_) = self { if let Self::LargeStatement(_) = self {
true true
@@ -30,7 +30,7 @@ pub enum PeerSet {
Collation, Collation,
} }
/// Whether or not a node is an authority or not. /// Whether a node is an authority or not.
/// ///
/// Peer set configuration gets adjusted accordingly. /// Peer set configuration gets adjusted accordingly.
#[derive(Copy, Clone, Debug, Eq, PartialEq)] #[derive(Copy, Clone, Debug, Eq, PartialEq)]
@@ -104,7 +104,7 @@ pub enum Recipient {
/// discovery system. /// discovery system.
#[derive(Debug)] #[derive(Debug)]
pub struct OutgoingRequest<Req> { pub struct OutgoingRequest<Req> {
/// Intendent recipient of this request. /// Intended recipient of this request.
pub peer: Recipient, pub peer: Recipient,
/// The actual request to send over the wire. /// The actual request to send over the wire.
pub payload: Req, pub payload: Req,
@@ -28,7 +28,7 @@ use crate::LOG_TARGET;
/// General result. /// General result.
pub type Result<T> = std::result::Result<T, Error>; pub type Result<T> = std::result::Result<T, Error>;
/// Result for non fatal only failures. /// Result for non-fatal only failures.
pub type NonFatalResult<T> = std::result::Result<T, NonFatal>; pub type NonFatalResult<T> = std::result::Result<T, NonFatal>;
/// Result for fatal only failures. /// Result for fatal only failures.
pub type FatalResult<T> = std::result::Result<T, Fatal>; pub type FatalResult<T> = std::result::Result<T, Fatal>;
@@ -39,7 +39,7 @@ const RETRY_TIMEOUT: Duration = Duration::from_millis(500);
/// Messages coming from a background task. /// Messages coming from a background task.
pub enum RequesterMessage { pub enum RequesterMessage {
/// Get an update of availble peers to try for fetching a given statement. /// Get an update of available peers to try for fetching a given statement.
GetMorePeers { GetMorePeers {
relay_parent: Hash, relay_parent: Hash,
candidate_hash: CandidateHash, candidate_hash: CandidateHash,
@@ -69,7 +69,7 @@ pub enum RequesterMessage {
/// A fetching task, taking care of fetching large statements via request/response. /// A fetching task, taking care of fetching large statements via request/response.
/// ///
/// A fetch task does not know about a particular `Statement` instead it just tries fetching a /// A fetch task does not know about a particular `Statement` instead it just tries fetching a
/// `CommittedCandidateReceipt` from peers, whether or not this can be used to re-assemble one ore /// `CommittedCandidateReceipt` from peers, whether this can be used to re-assemble one ore
/// many `SignedFullStatement`s needs to be verified by the caller. /// many `SignedFullStatement`s needs to be verified by the caller.
pub async fn fetch( pub async fn fetch(
relay_parent: Hash, relay_parent: Hash,
@@ -35,7 +35,7 @@ const COST_INVALID_REQUEST: Rep = Rep::CostMajor("Peer sent unparsable request")
/// Messages coming from a background task. /// Messages coming from a background task.
pub enum ResponderMessage { pub enum ResponderMessage {
/// Get an update of availble peers to try for fetching a given statement. /// Get an update of available peers to try for fetching a given statement.
GetData { GetData {
requesting_peer: PeerId, requesting_peer: PeerId,
relay_parent: Hash, relay_parent: Hash,
@@ -48,7 +48,7 @@ pub enum ResponderMessage {
/// A fetching task, taking care of fetching large statements via request/response. /// A fetching task, taking care of fetching large statements via request/response.
/// ///
/// A fetch task does not know about a particular `Statement` instead it just tries fetching a /// A fetch task does not know about a particular `Statement` instead it just tries fetching a
/// `CommittedCandidateReceipt` from peers, whether or not this can be used to re-assemble one ore /// `CommittedCandidateReceipt` from peers, whether this can be used to re-assemble one ore
/// many `SignedFullStatement`s needs to be verified by the caller. /// many `SignedFullStatement`s needs to be verified by the caller.
pub async fn respond( pub async fn respond(
mut receiver: mpsc::Receiver<sc_network::config::IncomingRequest>, mut receiver: mpsc::Receiver<sc_network::config::IncomingRequest>,
+2 -2
View File
@@ -51,7 +51,7 @@ pub const POV_BOMB_LIMIT: usize = MAX_POV_SIZE as usize;
/// ///
/// This is the committed candidate receipt instead of the bare candidate receipt. As such, /// This is the committed candidate receipt instead of the bare candidate receipt. As such,
/// it gives access to the commitments to validators who have not executed the candidate. This /// it gives access to the commitments to validators who have not executed the candidate. This
/// is necessary to allow a block-producing validator to include candidates from outside of the para /// is necessary to allow a block-producing validator to include candidates from outside the para
/// it is assigned to. /// it is assigned to.
#[derive(Clone, PartialEq, Eq, Encode, Decode)] #[derive(Clone, PartialEq, Eq, Encode, Decode)]
pub enum Statement { pub enum Statement {
@@ -202,7 +202,7 @@ pub struct CollationResult {
pub collation: Collation, pub collation: Collation,
/// An optional result sender that should be informed about a successfully seconded collation. /// An optional result sender that should be informed about a successfully seconded collation.
/// ///
/// There is no guarantee that this sender is informed ever about any result, it is completly okay to just drop it. /// There is no guarantee that this sender is informed ever about any result, it is completely okay to just drop it.
/// However, if it is called, it should be called with the signed statement of a parachain validator seconding the /// However, if it is called, it should be called with the signed statement of a parachain validator seconding the
/// collation. /// collation.
pub result_sender: Option<futures::channel::oneshot::Sender<SignedFullStatement>>, pub result_sender: Option<futures::channel::oneshot::Sender<SignedFullStatement>>,
+4 -4
View File
@@ -59,16 +59,16 @@ pub struct Extensions {
pub bad_blocks: sc_client_api::BadBlocks<polkadot_primitives::v1::Block>, pub bad_blocks: sc_client_api::BadBlocks<polkadot_primitives::v1::Block>,
} }
/// The `ChainSpec` parametrised for the polkadot runtime. /// The `ChainSpec` parameterized for the polkadot runtime.
pub type PolkadotChainSpec = service::GenericChainSpec<polkadot::GenesisConfig, Extensions>; pub type PolkadotChainSpec = service::GenericChainSpec<polkadot::GenesisConfig, Extensions>;
/// The `ChainSpec` parametrised for the kusama runtime. /// The `ChainSpec` parameterized for the kusama runtime.
pub type KusamaChainSpec = service::GenericChainSpec<kusama::GenesisConfig, Extensions>; pub type KusamaChainSpec = service::GenericChainSpec<kusama::GenesisConfig, Extensions>;
/// The `ChainSpec` parametrised for the westend runtime. /// The `ChainSpec` parameterized for the westend runtime.
pub type WestendChainSpec = service::GenericChainSpec<westend::GenesisConfig, Extensions>; pub type WestendChainSpec = service::GenericChainSpec<westend::GenesisConfig, Extensions>;
/// The `ChainSpec` parametrized for the rococo runtime. /// The `ChainSpec` parameterized for the rococo runtime.
pub type RococoChainSpec = service::GenericChainSpec<RococoGenesisExt, Extensions>; pub type RococoChainSpec = service::GenericChainSpec<RococoGenesisExt, Extensions>;
/// Extension for the Rococo genesis config to support a custom changes to the genesis state. /// Extension for the Rococo genesis config to support a custom changes to the genesis state.
@@ -20,8 +20,8 @@
//! //!
//! - Ergonomic API with little repetition. //! - Ergonomic API with little repetition.
//! - Still explicitness where it matters - fatal errors should be visible and justified. //! - Still explicitness where it matters - fatal errors should be visible and justified.
//! - Easy recovering from non fatal errors. //! - Easy recovering from non-fatal errors.
//! - Errors start as non fatal and can be made fatal at the level where it is really clear they //! - Errors start as non-fatal and can be made fatal at the level where it is really clear they
//! are fatal. E.g. cancellation of a oneshot might be fatal in one case, but absolutely expected //! are fatal. E.g. cancellation of a oneshot might be fatal in one case, but absolutely expected
//! in another. //! in another.
//! - Good error messages. Fatal errors don't need to be properly structured (as we won't handle //! - Good error messages. Fatal errors don't need to be properly structured (as we won't handle
@@ -37,7 +37,7 @@ use thiserror::Error;
/// Errors might either be fatal and should bring the subsystem down or are at least at the point /// Errors might either be fatal and should bring the subsystem down or are at least at the point
/// of occurrence deemed potentially recoverable. /// of occurrence deemed potentially recoverable.
/// ///
/// Upper layers might have a better view and might make a non fatal error of a called function a /// Upper layers might have a better view and might make a non-fatal error of a called function a
/// fatal one. The opposite should not happen, therefore don't make an error fatal if you don't /// fatal one. The opposite should not happen, therefore don't make an error fatal if you don't
/// know it is in all cases. /// know it is in all cases.
/// ///
@@ -102,7 +102,7 @@ use thiserror::Error;
/// } /// }
/// ``` /// ```
/// Then mostly use `Error` in functions, you may also use `NonFatal` and `Fatal` directly in /// Then mostly use `Error` in functions, you may also use `NonFatal` and `Fatal` directly in
/// functions that strictly only fail non fatal or fatal respectively, as `Fatal` and `NonFatal` /// functions that strictly only fail non-fatal or fatal respectively, as `Fatal` and `NonFatal`
/// can automatically converted into the above defined `Error`. /// can automatically converted into the above defined `Error`.
/// ``` /// ```
#[derive(Debug, Error)] #[derive(Debug, Error)]
@@ -135,7 +135,7 @@ impl<E, F> Fault<E, F>
Self::Fatal(f.into()) Self::Fatal(f.into())
} }
/// Build an `Fault` from compatible non fatal error. /// Build an `Fault` from compatible non-fatal error.
pub fn from_non_fatal<E1: Into<E>>(e: E1) -> Self { pub fn from_non_fatal<E1: Into<E>>(e: E1) -> Self {
Self::Err(e.into()) Self::Err(e.into())
} }
@@ -153,10 +153,10 @@ impl<E, F> Fault<E, F>
} }
} }
/// Unwrap non fatal error and report fatal one. /// Unwrap non-fatal error and report fatal one.
/// ///
/// This function is useful for top level error handling. Fatal errors will be extracted, /// This function is useful for top level error handling. Fatal errors will be extracted,
/// non fatal error will be returned for handling. /// non-fatal error will be returned for handling.
/// ///
/// Usage: /// Usage:
/// ///
@@ -63,7 +63,7 @@ pub struct ExtendedSessionInfo {
pub validator_info: ValidatorInfo, pub validator_info: ValidatorInfo,
} }
/// Information about ourself, in case we are an `Authority`. /// Information about ourselves, in case we are an `Authority`.
/// ///
/// This data is derived from the `SessionInfo` and our key as found in the keystore. /// This data is derived from the `SessionInfo` and our key as found in the keystore.
pub struct ValidatorInfo { pub struct ValidatorInfo {
+1 -1
View File
@@ -181,7 +181,7 @@ pub enum SubsystemError {
/// Per origin (or subsystem) annotations to wrap an error. /// Per origin (or subsystem) annotations to wrap an error.
#[error("Error originated in {origin}")] #[error("Error originated in {origin}")]
FromOrigin { FromOrigin {
/// An additional anotation tag for the origin of `source`. /// An additional annotation tag for the origin of `source`.
origin: &'static str, origin: &'static str,
/// The wrapped error. Marked as source for tracking the error chain. /// The wrapped error. Marked as source for tracking the error chain.
#[source] source: Box<dyn 'static + std::error::Error + Send + Sync> #[source] source: Box<dyn 'static + std::error::Error + Send + Sync>
@@ -45,7 +45,7 @@ impl<M> NetworkBridgeEvent<M> {
/// ///
/// This tries to transform M in `PeerMessage` to a message type specific to a subsystem. /// This tries to transform M in `PeerMessage` to a message type specific to a subsystem.
/// It is used to dispatch events coming from a peer set to the various subsystems that are /// It is used to dispatch events coming from a peer set to the various subsystems that are
/// handled within that peer set. More concretly a `ValidationProtocol` will be transformed /// handled within that peer set. More concretely a `ValidationProtocol` will be transformed
/// for example into a `BitfieldDistributionMessage` in case of the `BitfieldDistribution` /// for example into a `BitfieldDistributionMessage` in case of the `BitfieldDistribution`
/// constructor. /// constructor.
/// ///
+1 -1
View File
@@ -29,7 +29,7 @@ use sp_runtime::Perbill;
const DEFAULT_PROTOCOL_ID: &str = "dot"; const DEFAULT_PROTOCOL_ID: &str = "dot";
/// The `ChainSpec` parametrized for polkadot test runtime. /// The `ChainSpec` parameterized for polkadot test runtime.
pub type PolkadotChainSpec = pub type PolkadotChainSpec =
service::GenericChainSpec<polkadot_test_runtime::GenesisConfig, Extensions>; service::GenericChainSpec<polkadot_test_runtime::GenesisConfig, Extensions>;
+4 -4
View File
@@ -104,7 +104,7 @@ impl ClientHandle for TestClient {
/// nodes if you want the future node to be connected to other nodes. /// nodes if you want the future node to be connected to other nodes.
/// ///
/// The `storage_update_func` function will be executed in an externalities provided environment /// The `storage_update_func` function will be executed in an externalities provided environment
/// and can be used to make adjustements to the runtime genesis storage. /// and can be used to make adjustments to the runtime genesis storage.
pub fn node_config( pub fn node_config(
storage_update_func: impl Fn(), storage_update_func: impl Fn(),
task_executor: TaskExecutor, task_executor: TaskExecutor,
@@ -210,7 +210,7 @@ pub fn node_config(
/// want it to be connected to other nodes. /// want it to be connected to other nodes.
/// ///
/// The `storage_update_func` function will be executed in an externalities provided environment /// The `storage_update_func` function will be executed in an externalities provided environment
/// and can be used to make adjustements to the runtime genesis storage. /// and can be used to make adjustments to the runtime genesis storage.
pub fn run_validator_node( pub fn run_validator_node(
task_executor: TaskExecutor, task_executor: TaskExecutor,
key: Sr25519Keyring, key: Sr25519Keyring,
@@ -242,11 +242,11 @@ pub fn run_validator_node(
/// want it to be connected to other nodes. /// want it to be connected to other nodes.
/// ///
/// The `storage_update_func` function will be executed in an externalities provided environment /// The `storage_update_func` function will be executed in an externalities provided environment
/// and can be used to make adjustements to the runtime genesis storage. /// and can be used to make adjustments to the runtime genesis storage.
/// ///
/// # Note /// # Note
/// ///
/// The collator functionionality still needs to be registered at the node! This can be done using /// The collator functionality still needs to be registered at the node! This can be done using
/// [`PolkadotTestNode::register_collator`]. /// [`PolkadotTestNode::register_collator`].
pub fn run_collator_node( pub fn run_collator_node(
task_executor: TaskExecutor, task_executor: TaskExecutor,
+2 -2
View File
@@ -184,7 +184,7 @@ pub const PARACHAIN_INFO: Info = Info {
scheduling: Scheduling::Always, scheduling: Scheduling::Always,
}; };
/// Auxilliary for when there's an attempt to swap two parachains/parathreads. /// Auxiliary for when there's an attempt to swap two parachains/parathreads.
pub trait SwapAux { pub trait SwapAux {
/// Result describing whether it is possible to swap two parachains. Doesn't mutate state. /// Result describing whether it is possible to swap two parachains. Doesn't mutate state.
fn ensure_can_swap(one: Id, other: Id) -> Result<(), &'static str>; fn ensure_can_swap(one: Id, other: Id) -> Result<(), &'static str>;
@@ -435,7 +435,7 @@ pub struct AbridgedCandidateReceipt<H = Hash> {
/// A candidate-receipt with commitments directly included. /// A candidate-receipt with commitments directly included.
pub struct CommitedCandidateReceipt<H = Hash> { pub struct CommitedCandidateReceipt<H = Hash> {
/// The descriptor of the candidae. /// The descriptor of the candidate.
pub descriptor: CandidateDescriptor, pub descriptor: CandidateDescriptor,
/// The commitments of the candidate receipt. /// The commitments of the candidate receipt.
+5 -5
View File
@@ -181,7 +181,7 @@ pub const PARACHAINS_INHERENT_IDENTIFIER: InherentIdentifier = *b"parachn0";
pub const ASSIGNMENT_KEY_TYPE_ID: KeyTypeId = KeyTypeId(*b"asgn"); pub const ASSIGNMENT_KEY_TYPE_ID: KeyTypeId = KeyTypeId(*b"asgn");
/// Maximum compressed code size we support right now. /// Maximum compressed code size we support right now.
/// At the moment we have runtime upgrade on chain, which restricts scalability severly. If we want /// At the moment we have runtime upgrade on chain, which restricts scalability severely. If we want
/// to have bigger values, we should fix that first. /// to have bigger values, we should fix that first.
pub const MAX_CODE_SIZE: u32 = 3 * 1024 * 1024; pub const MAX_CODE_SIZE: u32 = 3 * 1024 * 1024;
@@ -370,7 +370,7 @@ impl<H: Clone> CommittedCandidateReceipt<H> {
self.to_plain().hash() self.to_plain().hash()
} }
/// Does this committed candidate receipt corrensponds to the given [`CandidateReceipt`]? /// Does this committed candidate receipt corresponds to the given [`CandidateReceipt`]?
pub fn corresponds_to(&self, receipt: &CandidateReceipt<H>) -> bool where H: PartialEq { pub fn corresponds_to(&self, receipt: &CandidateReceipt<H>) -> bool where H: PartialEq {
receipt.descriptor == self.descriptor && receipt.commitments_hash == self.commitments.hash() receipt.descriptor == self.descriptor && receipt.commitments_hash == self.commitments.hash()
} }
@@ -392,7 +392,7 @@ impl Ord for CommittedCandidateReceipt {
} }
/// The validation data provides information about how to create the inputs for validation of a candidate. /// The validation data provides information about how to create the inputs for validation of a candidate.
/// This information is derived from the chain state and will vary from para to para, although some of the /// This information is derived from the chain state and will vary from para to para, although some
/// fields may be the same for every para. /// fields may be the same for every para.
/// ///
/// Since this data is used to form inputs to the validation function, it needs to be persisted by the /// Since this data is used to form inputs to the validation function, it needs to be persisted by the
@@ -408,7 +408,7 @@ impl Ord for CommittedCandidateReceipt {
/// already been done. As such, there is no need for the validation data used to inform validators and /// already been done. As such, there is no need for the validation data used to inform validators and
/// collators about the checks the relay-chain will perform to be persisted by the availability system. /// collators about the checks the relay-chain will perform to be persisted by the availability system.
/// ///
/// The `PersistedValidationData` should be relatively lightweight primarly because it is constructed /// The `PersistedValidationData` should be relatively lightweight primarily because it is constructed
/// during inclusion for each candidate and therefore lies on the critical path of inclusion. /// during inclusion for each candidate and therefore lies on the critical path of inclusion.
#[derive(PartialEq, Eq, Clone, Encode, Decode)] #[derive(PartialEq, Eq, Clone, Encode, Decode)]
#[cfg_attr(feature = "std", derive(Debug, Default, MallocSizeOf))] #[cfg_attr(feature = "std", derive(Debug, Default, MallocSizeOf))]
@@ -1025,7 +1025,7 @@ pub enum ConsensusLog {
/// A parachain or parathread upgraded its code. /// A parachain or parathread upgraded its code.
#[codec(index = 1)] #[codec(index = 1)]
ParaUpgradeCode(Id, Hash), ParaUpgradeCode(Id, Hash),
/// A parachain or parathread scheduled a code ugprade. /// A parachain or parathread scheduled a code upgrade.
#[codec(index = 2)] #[codec(index = 2)]
ParaScheduleUpgradeCode(Id, Hash, BlockNumber), ParaScheduleUpgradeCode(Id, Hash, BlockNumber),
/// Governance requests to auto-approve every candidate included up to the given block /// Governance requests to auto-approve every candidate included up to the given block
+1 -1
View File
@@ -122,7 +122,7 @@ pub mod pallet {
/// [bidder, range, parachain_id, amount] /// [bidder, range, parachain_id, amount]
WonDeploy(T::AccountId, SlotRange, ParaId, BalanceOf<T>), WonDeploy(T::AccountId, SlotRange, ParaId, BalanceOf<T>),
/// An existing parachain won the right to continue. /// An existing parachain won the right to continue.
/// First balance is the extra amount reseved. Second is the total amount reserved. /// First balance is the extra amount reserved. Second is the total amount reserved.
/// [parachain_id, begin, count, total_amount] /// [parachain_id, begin, count, total_amount]
WonRenewal(ParaId, LeasePeriodOf<T>, LeasePeriodOf<T>, BalanceOf<T>), WonRenewal(ParaId, LeasePeriodOf<T>, LeasePeriodOf<T>, BalanceOf<T>),
/// Funds were reserved for a winning bid. First balance is the extra amount reserved. /// Funds were reserved for a winning bid. First balance is the extra amount reserved.
+1 -1
View File
@@ -69,7 +69,7 @@ impl WeightInfo for TestWeightInfo {
fn move_claim() -> Weight { 0 } fn move_claim() -> Weight { 0 }
} }
/// The kind of a statement an account needs to make for a claim to be valid. /// The kind of statement an account needs to make for a claim to be valid.
#[derive(Encode, Decode, Clone, Copy, Eq, PartialEq, RuntimeDebug)] #[derive(Encode, Decode, Clone, Copy, Eq, PartialEq, RuntimeDebug)]
#[cfg_attr(feature = "std", derive(Serialize, Deserialize))] #[cfg_attr(feature = "std", derive(Serialize, Deserialize))]
pub enum StatementKind { pub enum StatementKind {