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
@@ -168,7 +168,7 @@ impl Artifacts {
.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> {
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
/// to the provided result sender.
///
/// This is async to accomodate the fact a possibility of back-pressure. In vast majority of
/// situations this function should return immediatelly.
/// This is async to accommodate the fact a possibility of back-pressure. In the vast majority of
/// 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.
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.
///
/// This is async to accomodate the fact a possibility of back-pressure. In vast majority of
/// situations this function should return immediatelly.
/// This is async to accommodate the fact a possibility of back-pressure. In the vast majority of
/// 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.
pub async fn heads_up(&mut self, active_pvfs: Vec<Pvf>) -> Result<(), String> {
@@ -219,7 +219,7 @@ struct PendingExecutionRequest {
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.
#[derive(Default)]
struct AwaitingPrepare(HashMap<ArtifactId, Vec<PendingExecutionRequest>>);
@@ -68,7 +68,7 @@ pub enum Fatal {
Runtime(#[from] #[source] runtime::Fatal),
}
/// Non fatal errors of this subsystem.
/// Non-fatal errors of this subsystem.
#[derive(Debug, Error)]
pub enum NonFatal {
/// 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.
pub fn is_live(&self) -> bool {
!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.
pub fn is_finished(&self) -> bool {
@@ -91,7 +91,7 @@ impl Requester {
}
/// 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))]
pub async fn update_fetching_heads<Context>(
&mut self,
@@ -68,7 +68,7 @@ pub struct TestState {
pub relay_chain: Vec<Hash>,
/// 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
/// whether the subystem still succeds with its goal.
/// whether the subsystem still succeeds with its goal.
pub chunks: HashMap<(CandidateHash, ValidatorIndex), Vec<Option<ErasureChunk>>>,
/// All chunks that are valid and should be accepted.
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))]
async fn modify_reputation<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))]
fn handle_our_view_change(state: &mut ProtocolState, view: OurView) {
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 {
/// Latest view sent by the peer.
/// The Latest view sent by the peer.
view: View,
}
+1 -1
View File
@@ -93,7 +93,7 @@ where
/// 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.
#[derive(Debug, PartialEq)]
pub enum NetworkAction {
@@ -1048,7 +1048,7 @@ mod tests {
/// 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.
async fn advance_to_new_round(&mut self, virtual_overseer: &mut VirtualOverseer, merge_views: bool) {
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(
virtual_overseer: &mut VirtualOverseer,
peer: &PeerId,
+4 -4
View File
@@ -324,14 +324,14 @@ pub mod v1 {
LargeStatement(StatementMetadata),
}
/// Data that maes a statement unique.
/// Data that makes a statement unique.
#[derive(Debug, Clone, Encode, Decode, PartialEq, Eq, Hash)]
pub struct StatementMetadata {
/// Relayt parent this statement is relevant under.
/// Relay parent this statement is relevant under.
pub relay_parent: Hash,
/// Hash of the candidate that got validated.
pub candidate_hash: CandidateHash,
/// Validator that attested the valididty.
/// Validator that attested the validity.
pub signed_by: ValidatorIndex,
/// Signature of seconding validator.
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 {
if let Self::LargeStatement(_) = self {
true
@@ -30,7 +30,7 @@ pub enum PeerSet {
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.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
@@ -104,7 +104,7 @@ pub enum Recipient {
/// discovery system.
#[derive(Debug)]
pub struct OutgoingRequest<Req> {
/// Intendent recipient of this request.
/// Intended recipient of this request.
pub peer: Recipient,
/// The actual request to send over the wire.
pub payload: Req,
@@ -28,7 +28,7 @@ use crate::LOG_TARGET;
/// General result.
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>;
/// Result for fatal only failures.
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.
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 {
relay_parent: Hash,
candidate_hash: CandidateHash,
@@ -69,7 +69,7 @@ pub enum RequesterMessage {
/// 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
/// `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.
pub async fn fetch(
relay_parent: Hash,
@@ -35,7 +35,7 @@ const COST_INVALID_REQUEST: Rep = Rep::CostMajor("Peer sent unparsable request")
/// Messages coming from a background task.
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 {
requesting_peer: PeerId,
relay_parent: Hash,
@@ -48,7 +48,7 @@ pub enum ResponderMessage {
/// 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
/// `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.
pub async fn respond(
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,
/// 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.
#[derive(Clone, PartialEq, Eq, Encode, Decode)]
pub enum Statement {
@@ -202,7 +202,7 @@ pub struct CollationResult {
pub collation: 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
/// collation.
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>,
}
/// The `ChainSpec` parametrised for the polkadot runtime.
/// The `ChainSpec` parameterized for the polkadot runtime.
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>;
/// The `ChainSpec` parametrised for the westend runtime.
/// The `ChainSpec` parameterized for the westend runtime.
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>;
/// Extension for the Rococo genesis config to support a custom changes to the genesis state.
@@ -20,8 +20,8 @@
//!
//! - Ergonomic API with little repetition.
//! - Still explicitness where it matters - fatal errors should be visible and justified.
//! - 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
//! - 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
//! are fatal. E.g. cancellation of a oneshot might be fatal in one case, but absolutely expected
//! in another.
//! - 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
/// 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
/// 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
/// 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`.
/// ```
#[derive(Debug, Error)]
@@ -135,7 +135,7 @@ impl<E, F> Fault<E, F>
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 {
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,
/// non fatal error will be returned for handling.
/// non-fatal error will be returned for handling.
///
/// Usage:
///
@@ -63,7 +63,7 @@ pub struct ExtendedSessionInfo {
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.
pub struct ValidatorInfo {
+1 -1
View File
@@ -181,7 +181,7 @@ pub enum SubsystemError {
/// Per origin (or subsystem) annotations to wrap an error.
#[error("Error originated in {origin}")]
FromOrigin {
/// An additional anotation tag for the origin of `source`.
/// An additional annotation tag for the origin of `source`.
origin: &'static str,
/// The wrapped error. Marked as source for tracking the error chain.
#[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.
/// 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`
/// constructor.
///
+1 -1
View File
@@ -29,7 +29,7 @@ use sp_runtime::Perbill;
const DEFAULT_PROTOCOL_ID: &str = "dot";
/// The `ChainSpec` parametrized for polkadot test runtime.
/// The `ChainSpec` parameterized for polkadot test runtime.
pub type PolkadotChainSpec =
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.
///
/// 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(
storage_update_func: impl Fn(),
task_executor: TaskExecutor,
@@ -210,7 +210,7 @@ pub fn node_config(
/// want it to be connected to other nodes.
///
/// 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(
task_executor: TaskExecutor,
key: Sr25519Keyring,
@@ -242,11 +242,11 @@ pub fn run_validator_node(
/// want it to be connected to other nodes.
///
/// 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
///
/// 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`].
pub fn run_collator_node(
task_executor: TaskExecutor,