Unverified Commit 8a75570d authored by Chevdor's avatar Chevdor Committed by GitHub
Browse files

Fix spelling (#3845)

* Fix spelling

* Add missing entry

* Proper fix for KeyPair
parent f9d3fb2d
Pipeline #159176 failed with stages
in 36 minutes and 56 seconds
...@@ -65,6 +65,7 @@ isn ...@@ -65,6 +65,7 @@ isn
io io
js js
keccak256/M keccak256/M
keypair/MS
KSM/S KSM/S
Lane1 Lane1
Lane2 Lane2
...@@ -101,6 +102,7 @@ parablock/MS ...@@ -101,6 +102,7 @@ parablock/MS
parachain/MS parachain/MS
parameterize/D parameterize/D
pallet_message_lane pallet_message_lane
plancks
polkadot/MS polkadot/MS
pov-block/MS pov-block/MS
PoA PoA
......
...@@ -27,7 +27,7 @@ use structopt::StructOpt; ...@@ -27,7 +27,7 @@ use structopt::StructOpt;
/// since messages sent over the bridge will be able to spend these. /// since messages sent over the bridge will be able to spend these.
#[derive(StructOpt)] #[derive(StructOpt)]
pub struct DeriveAccount { pub struct DeriveAccount {
/// A bridge instance to initalize. /// A bridge instance to initialize.
#[structopt(possible_values = &FullBridge::variants(), case_insensitive = true)] #[structopt(possible_values = &FullBridge::variants(), case_insensitive = true)]
bridge: FullBridge, bridge: FullBridge,
/// Source-chain address to derive Target-chain address from. /// Source-chain address to derive Target-chain address from.
......
...@@ -40,7 +40,7 @@ pub enum MessagePayload { ...@@ -40,7 +40,7 @@ pub enum MessagePayload {
/// A `MessagePayload` to encode. /// A `MessagePayload` to encode.
#[derive(StructOpt)] #[derive(StructOpt)]
pub struct EncodeMessage { pub struct EncodeMessage {
/// A bridge instance to initalize. /// A bridge instance to initialize.
#[structopt(possible_values = &FullBridge::variants(), case_insensitive = true)] #[structopt(possible_values = &FullBridge::variants(), case_insensitive = true)]
bridge: FullBridge, bridge: FullBridge,
#[structopt(flatten)] #[structopt(flatten)]
......
...@@ -25,7 +25,7 @@ use structopt::{clap::arg_enum, StructOpt}; ...@@ -25,7 +25,7 @@ use structopt::{clap::arg_enum, StructOpt};
/// Initialize bridge pallet. /// Initialize bridge pallet.
#[derive(StructOpt)] #[derive(StructOpt)]
pub struct InitBridge { pub struct InitBridge {
/// A bridge instance to initalize. /// A bridge instance to initialize.
#[structopt(possible_values = &InitBridgeName::variants(), case_insensitive = true)] #[structopt(possible_values = &InitBridgeName::variants(), case_insensitive = true)]
bridge: InitBridgeName, bridge: InitBridgeName,
#[structopt(flatten)] #[structopt(flatten)]
......
...@@ -72,7 +72,7 @@ pub enum Command { ...@@ -72,7 +72,7 @@ pub enum Command {
/// The message is being sent to the source chain, delivered to the target chain and dispatched /// The message is being sent to the source chain, delivered to the target chain and dispatched
/// there. /// there.
SendMessage(send_message::SendMessage), SendMessage(send_message::SendMessage),
/// Generate SCALE-encoded `Call` for choosen network. /// Generate SCALE-encoded `Call` for the chosen network.
/// ///
/// The call can be used either as message payload or can be wrapped into a transaction /// The call can be used either as message payload or can be wrapped into a transaction
/// and executed on the chain directly. /// and executed on the chain directly.
...@@ -235,7 +235,7 @@ pub trait CliChain: relay_substrate_client::Chain { ...@@ -235,7 +235,7 @@ pub trait CliChain: relay_substrate_client::Chain {
/// Bridge Message Payload type. /// Bridge Message Payload type.
/// ///
/// TODO [#854] This should be removed in favour of target-specifc types. /// TODO [#854] This should be removed in favor of target-specifc types.
type MessagePayload; type MessagePayload;
/// Numeric value of SS58 format. /// Numeric value of SS58 format.
...@@ -354,7 +354,7 @@ where ...@@ -354,7 +354,7 @@ where
} }
/// Create chain-specific set of configuration objects: connection parameters, /// Create chain-specific set of configuration objects: connection parameters,
/// signing parameters and bridge initialisation parameters. /// signing parameters and bridge initialization parameters.
#[macro_export] #[macro_export]
macro_rules! declare_chain_options { macro_rules! declare_chain_options {
($chain:ident, $chain_prefix:ident) => { ($chain:ident, $chain_prefix:ident) => {
...@@ -385,7 +385,7 @@ macro_rules! declare_chain_options { ...@@ -385,7 +385,7 @@ macro_rules! declare_chain_options {
} }
impl [<$chain SigningParams>] { impl [<$chain SigningParams>] {
/// Parse signing params into chain-specific KeyPair. /// Parse signing params into chain-specific `KeyPair`.
pub fn to_keypair<Chain: CliChain>(&self) -> anyhow::Result<Chain::KeyPair> { pub fn to_keypair<Chain: CliChain>(&self) -> anyhow::Result<Chain::KeyPair> {
use sp_core::crypto::Pair; use sp_core::crypto::Pair;
......
...@@ -59,7 +59,7 @@ pub trait SubstrateMessageLane: MessageLane { ...@@ -59,7 +59,7 @@ pub trait SubstrateMessageLane: MessageLane {
const INBOUND_LANE_LATEST_RECEIVED_NONCE_METHOD: &'static str; const INBOUND_LANE_LATEST_RECEIVED_NONCE_METHOD: &'static str;
/// Name of the runtime method that returns latest confirmed (reward-paid) nonce at the target chain. /// Name of the runtime method that returns latest confirmed (reward-paid) nonce at the target chain.
const INBOUND_LANE_LATEST_CONFIRMED_NONCE_METHOD: &'static str; const INBOUND_LANE_LATEST_CONFIRMED_NONCE_METHOD: &'static str;
/// Numebr of the runtime method that returns state of "unrewarded relayers" set at the target chain. /// Number of the runtime method that returns state of "unrewarded relayers" set at the target chain.
const INBOUND_LANE_UNREWARDED_RELAYERS_STATE: &'static str; const INBOUND_LANE_UNREWARDED_RELAYERS_STATE: &'static str;
/// Name of the runtime method that returns id of best finalized source header at target chain. /// Name of the runtime method that returns id of best finalized source header at target chain.
......
...@@ -248,7 +248,7 @@ async fn background_task<SourceChain, TargetChain, TargetSign>( ...@@ -248,7 +248,7 @@ async fn background_task<SourceChain, TargetChain, TargetSign>(
} }
} }
/// Returns `Some()` with inclusive range of headers which must be scanned for manadatory headers /// Returns `Some()` with inclusive range of headers which must be scanned for mandatory headers
/// and the first of such headers must be submitted to the target node. /// and the first of such headers must be submitted to the target node.
async fn mandatory_headers_scan_range<C: Chain>( async fn mandatory_headers_scan_range<C: Chain>(
best_finalized_source_header_at_source: Option<C::BlockNumber>, best_finalized_source_header_at_source: Option<C::BlockNumber>,
......
...@@ -56,7 +56,7 @@ pub trait Chain: ChainBase + Clone { ...@@ -56,7 +56,7 @@ pub trait Chain: ChainBase + Clone {
type Call: Dispatchable + Debug; type Call: Dispatchable + Debug;
/// Balance of an account in native tokens. /// Balance of an account in native tokens.
/// ///
/// The chain may suport multiple tokens, but this particular type is for token that is used /// The chain may support multiple tokens, but this particular type is for token that is used
/// to pay for transaction dispatch, to reward different relayers (headers, messages), etc. /// to pay for transaction dispatch, to reward different relayers (headers, messages), etc.
type Balance: Parameter + Member + DeserializeOwned + Clone + Copy + CheckedSub + PartialOrd + SaturatingAdd + Zero; type Balance: Parameter + Member + DeserializeOwned + Clone + Copy + CheckedSub + PartialOrd + SaturatingAdd + Zero;
} }
......
...@@ -79,7 +79,7 @@ impl<C: Chain> std::fmt::Debug for Client<C> { ...@@ -79,7 +79,7 @@ impl<C: Chain> std::fmt::Debug for Client<C> {
impl<C: Chain> Client<C> { impl<C: Chain> Client<C> {
/// Returns client that is able to call RPCs on Substrate node over websocket connection. /// Returns client that is able to call RPCs on Substrate node over websocket connection.
/// ///
/// This function will keep connecting to given Sustrate node until connection is established /// This function will keep connecting to given Substrate node until connection is established
/// and is functional. If attempt fail, it will wait for `RECONNECT_DELAY` and retry again. /// and is functional. If attempt fail, it will wait for `RECONNECT_DELAY` and retry again.
pub async fn new(params: ConnectionParams) -> Self { pub async fn new(params: ConnectionParams) -> Self {
loop { loop {
...@@ -224,7 +224,7 @@ impl<C: Chain> Client<C> { ...@@ -224,7 +224,7 @@ impl<C: Chain> Client<C> {
/// Get the nonce of the given Substrate account. /// Get the nonce of the given Substrate account.
/// ///
/// Note: It's the caller's responsibility to make sure `account` is a valid ss58 address. /// Note: It's the caller's responsibility to make sure `account` is a valid SS58 address.
pub async fn next_account_index(&self, account: C::AccountId) -> Result<C::Index> { pub async fn next_account_index(&self, account: C::AccountId) -> Result<C::Index> {
Ok(Substrate::<C>::system_account_next_index(&*self.client, account).await?) Ok(Substrate::<C>::system_account_next_index(&*self.client, account).await?)
} }
......
...@@ -225,6 +225,7 @@ shareable ...@@ -225,6 +225,7 @@ shareable
Simnet/MS Simnet/MS
spawn/SR spawn/SR
spawner spawner
SS58
sr25519 sr25519
startup/MS startup/MS
stateful stateful
...@@ -235,6 +236,7 @@ substream ...@@ -235,6 +236,7 @@ substream
subsystem/MS subsystem/MS
subsystems' subsystems'
supermajority supermajority
SURI
systemwide systemwide
taskmanager/MS taskmanager/MS
TCP TCP
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment