mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-11 15:21:08 +00:00
runtime: Account nicknames (#3930)
* Add Nicknames module for accounts. * Integrate into node. * Fix build * Update srml/nicks/src/lib.rs Co-Authored-By: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Bump runtime * Improve weight docs * Docs. * Apply suggestions from code review Co-Authored-By: Bastian Köcher <bkchr@users.noreply.github.com>
This commit is contained in:
Gavin Wood
Generated
+16
@@ -2525,6 +2525,7 @@ dependencies = [
|
||||
"srml-im-online 0.1.0",
|
||||
"srml-indices 2.0.0",
|
||||
"srml-membership 2.0.0",
|
||||
"srml-nicks 2.0.0",
|
||||
"srml-offences 1.0.0",
|
||||
"srml-randomness-collective-flip 2.0.0",
|
||||
"srml-session 2.0.0",
|
||||
@@ -4350,6 +4351,21 @@ dependencies = [
|
||||
"substrate-primitives 2.0.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "srml-nicks"
|
||||
version = "2.0.0"
|
||||
dependencies = [
|
||||
"parity-scale-codec 1.0.6 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"serde 1.0.101 (registry+https://github.com/rust-lang/crates.io-index)",
|
||||
"sr-io 2.0.0",
|
||||
"sr-primitives 2.0.0",
|
||||
"sr-std 2.0.0",
|
||||
"srml-balances 2.0.0",
|
||||
"srml-support 2.0.0",
|
||||
"srml-system 2.0.0",
|
||||
"substrate-primitives 2.0.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "srml-offences"
|
||||
version = "1.0.0"
|
||||
|
||||
@@ -96,6 +96,7 @@ members = [
|
||||
"srml/indices",
|
||||
"srml/membership",
|
||||
"srml/metadata",
|
||||
"srml/nicks",
|
||||
"srml/offences",
|
||||
"srml/randomness-collective-flip",
|
||||
"srml/scored-pool",
|
||||
|
||||
@@ -40,6 +40,7 @@ grandpa = { package = "srml-grandpa", path = "../../srml/grandpa", default-featu
|
||||
im-online = { package = "srml-im-online", path = "../../srml/im-online", default-features = false }
|
||||
indices = { package = "srml-indices", path = "../../srml/indices", default-features = false }
|
||||
membership = { package = "srml-membership", path = "../../srml/membership", default-features = false }
|
||||
nicks = { package = "srml-nicks", path = "../../srml/nicks", default-features = false }
|
||||
offences = { package = "srml-offences", path = "../../srml/offences", default-features = false }
|
||||
randomness-collective-flip = { package = "srml-randomness-collective-flip", path = "../../srml/randomness-collective-flip", default-features = false }
|
||||
session = { package = "srml-session", path = "../../srml/session", default-features = false, features = ["historical"] }
|
||||
@@ -82,6 +83,7 @@ std = [
|
||||
"im-online/std",
|
||||
"indices/std",
|
||||
"membership/std",
|
||||
"nicks/std",
|
||||
"node-primitives/std",
|
||||
"offchain-primitives/std",
|
||||
"offences/std",
|
||||
|
||||
@@ -83,8 +83,8 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
|
||||
// and set impl_version to equal spec_version. If only runtime
|
||||
// implementation changes and behavior does not, then leave spec_version as
|
||||
// is and increment impl_version.
|
||||
spec_version: 185,
|
||||
impl_version: 185,
|
||||
spec_version: 186,
|
||||
impl_version: 186,
|
||||
apis: RUNTIME_API_VERSIONS,
|
||||
};
|
||||
|
||||
@@ -440,7 +440,7 @@ impl offences::Trait for Runtime {
|
||||
}
|
||||
|
||||
impl authority_discovery::Trait for Runtime {
|
||||
type AuthorityId = BabeId;
|
||||
type AuthorityId = BabeId;
|
||||
}
|
||||
|
||||
impl grandpa::Trait for Runtime {
|
||||
@@ -458,6 +458,22 @@ impl finality_tracker::Trait for Runtime {
|
||||
type ReportLatency = ReportLatency;
|
||||
}
|
||||
|
||||
parameter_types! {
|
||||
pub const ReservationFee: Balance = 1 * DOLLARS;
|
||||
pub const MinLength: usize = 3;
|
||||
pub const MaxLength: usize = 16;
|
||||
}
|
||||
|
||||
impl nicks::Trait for Runtime {
|
||||
type Event = Event;
|
||||
type Currency = Balances;
|
||||
type ReservationFee = ReservationFee;
|
||||
type Slashed = Treasury;
|
||||
type KillOrigin = collective::EnsureMember<AccountId, CouncilCollective>;
|
||||
type MinLength = MinLength;
|
||||
type MaxLength = MaxLength;
|
||||
}
|
||||
|
||||
impl system::offchain::CreateTransaction<Runtime, UncheckedExtrinsic> for Runtime {
|
||||
type Public = <Signature as traits::Verify>::Signer;
|
||||
type Signature = Signature;
|
||||
@@ -518,6 +534,7 @@ construct_runtime!(
|
||||
AuthorityDiscovery: authority_discovery::{Module, Call, Config<T>},
|
||||
Offences: offences::{Module, Call, Storage, Event},
|
||||
RandomnessCollectiveFlip: randomness_collective_flip::{Module, Call, Storage},
|
||||
Nicks: nicks::{Module, Call, Storage, Event<T>},
|
||||
}
|
||||
);
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
[package]
|
||||
name = "srml-nicks"
|
||||
version = "2.0.0"
|
||||
authors = ["Parity Technologies <admin@parity.io>"]
|
||||
edition = "2018"
|
||||
|
||||
[dependencies]
|
||||
serde = { version = "1.0.101", optional = true }
|
||||
codec = { package = "parity-scale-codec", version = "1.0.0", default-features = false, features = ["derive"] }
|
||||
rstd = { package = "sr-std", path = "../../core/sr-std", default-features = false }
|
||||
runtime-io = { package = "sr-io", path = "../../core/sr-io", default-features = false }
|
||||
sr-primitives = { path = "../../core/sr-primitives", default-features = false }
|
||||
support = { package = "srml-support", path = "../support", default-features = false }
|
||||
system = { package = "srml-system", path = "../system", default-features = false }
|
||||
|
||||
[dev-dependencies]
|
||||
primitives = { package = "substrate-primitives", path = "../../core/primitives" }
|
||||
balances = { package = "srml-balances", path = "../balances", default-features = false }
|
||||
|
||||
[features]
|
||||
default = ["std"]
|
||||
std = [
|
||||
"serde",
|
||||
"codec/std",
|
||||
"rstd/std",
|
||||
"runtime-io/std",
|
||||
"sr-primitives/std",
|
||||
"support/std",
|
||||
"system/std",
|
||||
]
|
||||
@@ -0,0 +1,331 @@
|
||||
// Copyright 2019 Parity Technologies (UK) Ltd.
|
||||
// This file is part of Substrate.
|
||||
|
||||
// Substrate is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
|
||||
// Substrate is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
//! # Nicks Module
|
||||
//!
|
||||
//! - [`nicks::Trait`](./trait.Trait.html)
|
||||
//! - [`Call`](./enum.Call.html)
|
||||
//!
|
||||
//! ## Overview
|
||||
//!
|
||||
//! Nicks is a trivial module for keeping track of account names on-chain. It makes no effort to
|
||||
//! create a name hierarchy, be a DNS replacement or provide reverse lookups.
|
||||
//!
|
||||
//! ## Interface
|
||||
//!
|
||||
//! ### Dispatchable Functions
|
||||
//!
|
||||
//! * `set_name` - Set the associated name of an account; a small deposit is reserved if not already
|
||||
//! taken.
|
||||
//! * `clear_name` - Remove an account's associated name; the deposit is returned.
|
||||
//! * `kill_name` - Forcibly remove the associated name; the deposit is lost.
|
||||
//!
|
||||
//! [`Call`]: ./enum.Call.html
|
||||
//! [`Trait`]: ./trait.Trait.html
|
||||
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
use rstd::prelude::*;
|
||||
use sr_primitives::{
|
||||
traits::{StaticLookup, EnsureOrigin}, weights::SimpleDispatchInfo,
|
||||
};
|
||||
use support::{
|
||||
decl_module, decl_event, decl_storage, ensure, traits::{
|
||||
Currency, ReservableCurrency, OnUnbalanced, Get
|
||||
},
|
||||
};
|
||||
use system::{ensure_signed, ensure_root};
|
||||
|
||||
type BalanceOf<T> = <<T as Trait>::Currency as Currency<<T as system::Trait>::AccountId>>::Balance;
|
||||
type NegativeImbalanceOf<T> = <<T as Trait>::Currency as Currency<<T as system::Trait>::AccountId>>::NegativeImbalance;
|
||||
|
||||
pub trait Trait: system::Trait {
|
||||
/// The overarching event type.
|
||||
type Event: From<Event<Self>> + Into<<Self as system::Trait>::Event>;
|
||||
|
||||
/// The currency trait.
|
||||
type Currency: ReservableCurrency<Self::AccountId>;
|
||||
|
||||
/// Reservation fee.
|
||||
type ReservationFee: Get<BalanceOf<Self>>;
|
||||
|
||||
/// What to do with slashed funds.
|
||||
type Slashed: OnUnbalanced<NegativeImbalanceOf<Self>>;
|
||||
|
||||
/// The origin which may forcibly remove a name. Root can always do this.
|
||||
type KillOrigin: EnsureOrigin<Self::Origin>;
|
||||
|
||||
/// The minimum length a name may be.
|
||||
type MinLength: Get<usize>;
|
||||
|
||||
/// The maximum length a name may be.
|
||||
type MaxLength: Get<usize>;
|
||||
}
|
||||
|
||||
decl_storage! {
|
||||
trait Store for Module<T: Trait> as Sudo {
|
||||
/// The lookup table for names.
|
||||
NameOf: map T::AccountId => Option<(Vec<u8>, BalanceOf<T>)>;
|
||||
}
|
||||
}
|
||||
|
||||
decl_event!(
|
||||
pub enum Event<T> where AccountId = <T as system::Trait>::AccountId, Balance = BalanceOf<T> {
|
||||
/// A name was set.
|
||||
NameSet(AccountId),
|
||||
/// A name was changed.
|
||||
NameChanged(AccountId),
|
||||
/// A name was cleared, and the given balance returned.
|
||||
NameCleared(AccountId, Balance),
|
||||
/// A name was removed and the given balance slashed.
|
||||
NameKilled(AccountId, Balance),
|
||||
}
|
||||
);
|
||||
|
||||
decl_module! {
|
||||
// Simple declaration of the `Module` type. Lets the macro know what it's working on.
|
||||
pub struct Module<T: Trait> for enum Call where origin: T::Origin {
|
||||
fn deposit_event() = default;
|
||||
|
||||
/// Set an account's name. The name should be a UTF-8-encoded string by convention, though
|
||||
/// we don't check it.
|
||||
///
|
||||
/// The name may not be more than `T::MaxLength` bytes, nor less than `T::MinLength` bytes.
|
||||
///
|
||||
/// If the account doesn't already have a name, then a fee of `ReservationFee` is reserved
|
||||
/// in the account.
|
||||
///
|
||||
/// The dispatch origin for this call must be _Signed_.
|
||||
///
|
||||
/// # <weight>
|
||||
/// - O(1).
|
||||
/// - At most one balance operation.
|
||||
/// - One storage read/write.
|
||||
/// - One event.
|
||||
/// # </weight>
|
||||
#[weight = SimpleDispatchInfo::FixedNormal(50_000)]
|
||||
fn set_name(origin, name: Vec<u8>) {
|
||||
let sender = ensure_signed(origin)?;
|
||||
|
||||
ensure!(name.len() >= T::MinLength::get(), "Name too short");
|
||||
ensure!(name.len() <= T::MaxLength::get(), "Name too long");
|
||||
|
||||
let deposit = if let Some((_, deposit)) = <NameOf<T>>::get(&sender) {
|
||||
Self::deposit_event(RawEvent::NameSet(sender.clone()));
|
||||
deposit
|
||||
} else {
|
||||
let deposit = T::ReservationFee::get();
|
||||
T::Currency::reserve(&sender, deposit.clone())?;
|
||||
Self::deposit_event(RawEvent::NameChanged(sender.clone()));
|
||||
deposit
|
||||
};
|
||||
|
||||
<NameOf<T>>::insert(&sender, (name, deposit));
|
||||
}
|
||||
|
||||
/// Clear an account's name and return the deposit. Fails if the account was not named.
|
||||
///
|
||||
/// The dispatch origin for this call must be _Signed_.
|
||||
///
|
||||
/// # <weight>
|
||||
/// - O(1).
|
||||
/// - One balance operation.
|
||||
/// - One storage read/write.
|
||||
/// - One event.
|
||||
/// # </weight>
|
||||
fn clear_name(origin) {
|
||||
let sender = ensure_signed(origin)?;
|
||||
|
||||
let deposit = <NameOf<T>>::take(&sender).ok_or("Not named")?.1;
|
||||
|
||||
let _ = T::Currency::unreserve(&sender, deposit.clone());
|
||||
|
||||
Self::deposit_event(RawEvent::NameCleared(sender, deposit));
|
||||
}
|
||||
|
||||
/// Remove an account's name and take charge of the deposit.
|
||||
///
|
||||
/// Fails if `who` has not been named. The deposit is dealt with through `T::Slashed`
|
||||
/// imbalance handler.
|
||||
///
|
||||
/// The dispatch origin for this call must be _Root_ or match `T::KillOrigin`.
|
||||
///
|
||||
/// # <weight>
|
||||
/// - O(1).
|
||||
/// - One unbalanced handler (probably a balance transfer)
|
||||
/// - One storage read/write.
|
||||
/// - One event.
|
||||
/// # </weight>
|
||||
#[weight = SimpleDispatchInfo::FreeOperational]
|
||||
fn kill_name(origin, target: <T::Lookup as StaticLookup>::Source) {
|
||||
T::KillOrigin::try_origin(origin)
|
||||
.map(|_| ())
|
||||
.or_else(ensure_root)
|
||||
.map_err(|_| "bad origin")?;
|
||||
|
||||
// Figure out who we're meant to be clearing.
|
||||
let target = T::Lookup::lookup(target)?;
|
||||
// Grab their deposit (and check that they have one).
|
||||
let deposit = <NameOf<T>>::take(&target).ok_or("Not named")?.1;
|
||||
// Slash their deposit from them.
|
||||
T::Slashed::on_unbalanced(T::Currency::slash_reserved(&target, deposit.clone()).0);
|
||||
|
||||
Self::deposit_event(RawEvent::NameKilled(target, deposit));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
use support::{assert_ok, assert_noop, impl_outer_origin, parameter_types};
|
||||
use primitives::H256;
|
||||
use system::EnsureSignedBy;
|
||||
// The testing primitives are very useful for avoiding having to work with signatures
|
||||
// or public keys. `u64` is used as the `AccountId` and no `Signature`s are required.
|
||||
use sr_primitives::{
|
||||
Perbill, testing::Header, traits::{BlakeTwo256, IdentityLookup},
|
||||
};
|
||||
|
||||
impl_outer_origin! {
|
||||
pub enum Origin for Test {}
|
||||
}
|
||||
|
||||
// For testing the module, we construct most of a mock runtime. This means
|
||||
// first constructing a configuration type (`Test`) which `impl`s each of the
|
||||
// configuration traits of modules we want to use.
|
||||
#[derive(Clone, Eq, PartialEq)]
|
||||
pub struct Test;
|
||||
parameter_types! {
|
||||
pub const BlockHashCount: u64 = 250;
|
||||
pub const MaximumBlockWeight: u32 = 1024;
|
||||
pub const MaximumBlockLength: u32 = 2 * 1024;
|
||||
pub const AvailableBlockRatio: Perbill = Perbill::one();
|
||||
}
|
||||
impl system::Trait for Test {
|
||||
type Origin = Origin;
|
||||
type Index = u64;
|
||||
type BlockNumber = u64;
|
||||
type Hash = H256;
|
||||
type Call = ();
|
||||
type Hashing = BlakeTwo256;
|
||||
type AccountId = u64;
|
||||
type Lookup = IdentityLookup<Self::AccountId>;
|
||||
type Header = Header;
|
||||
type Event = ();
|
||||
type BlockHashCount = BlockHashCount;
|
||||
type MaximumBlockWeight = MaximumBlockWeight;
|
||||
type MaximumBlockLength = MaximumBlockLength;
|
||||
type AvailableBlockRatio = AvailableBlockRatio;
|
||||
type Version = ();
|
||||
}
|
||||
parameter_types! {
|
||||
pub const ExistentialDeposit: u64 = 0;
|
||||
pub const TransferFee: u64 = 0;
|
||||
pub const CreationFee: u64 = 0;
|
||||
}
|
||||
impl balances::Trait for Test {
|
||||
type Balance = u64;
|
||||
type OnFreeBalanceZero = ();
|
||||
type OnNewAccount = ();
|
||||
type Event = ();
|
||||
type TransferPayment = ();
|
||||
type DustRemoval = ();
|
||||
type ExistentialDeposit = ExistentialDeposit;
|
||||
type TransferFee = TransferFee;
|
||||
type CreationFee = CreationFee;
|
||||
}
|
||||
parameter_types! {
|
||||
pub const ReservationFee: u64 = 2;
|
||||
pub const MinLength: usize = 3;
|
||||
pub const MaxLength: usize = 16;
|
||||
pub const One: u64 = 1;
|
||||
}
|
||||
impl Trait for Test {
|
||||
type Event = ();
|
||||
type Currency = Balances;
|
||||
type ReservationFee = ReservationFee;
|
||||
type Slashed = ();
|
||||
type KillOrigin = EnsureSignedBy<One, u64>;
|
||||
type MinLength = MinLength;
|
||||
type MaxLength = MaxLength;
|
||||
}
|
||||
type Balances = balances::Module<Test>;
|
||||
type Nicks = Module<Test>;
|
||||
|
||||
// This function basically just builds a genesis storage key/value store according to
|
||||
// our desired mockup.
|
||||
fn new_test_ext() -> runtime_io::TestExternalities {
|
||||
let mut t = system::GenesisConfig::default().build_storage::<Test>().unwrap();
|
||||
// We use default for brevity, but you can configure as desired if needed.
|
||||
balances::GenesisConfig::<Test> {
|
||||
balances: vec![
|
||||
(1, 10),
|
||||
(2, 10),
|
||||
],
|
||||
vesting: vec![],
|
||||
}.assimilate_storage(&mut t).unwrap();
|
||||
t.into()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn kill_names_should_work() {
|
||||
new_test_ext().execute_with(|| {
|
||||
assert_ok!(Nicks::set_name(Origin::signed(2), b"Dave".to_vec()));
|
||||
assert_eq!(Balances::total_balance(&2), 10);
|
||||
assert_ok!(Nicks::kill_name(Origin::signed(1), 2));
|
||||
assert_eq!(Balances::total_balance(&2), 8);
|
||||
assert_eq!(<NameOf<Test>>::get(2), None);
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn normal_operation_should_work() {
|
||||
new_test_ext().execute_with(|| {
|
||||
assert_ok!(Nicks::set_name(Origin::signed(1), b"Gav".to_vec()));
|
||||
assert_eq!(Balances::reserved_balance(&1), 2);
|
||||
assert_eq!(Balances::free_balance(&1), 8);
|
||||
assert_eq!(<NameOf<Test>>::get(1).unwrap().0, b"Gav".to_vec());
|
||||
|
||||
assert_ok!(Nicks::set_name(Origin::signed(1), b"Gavin".to_vec()));
|
||||
assert_eq!(Balances::reserved_balance(&1), 2);
|
||||
assert_eq!(Balances::free_balance(&1), 8);
|
||||
assert_eq!(<NameOf<Test>>::get(1).unwrap().0, b"Gavin".to_vec());
|
||||
|
||||
assert_ok!(Nicks::clear_name(Origin::signed(1)));
|
||||
assert_eq!(Balances::reserved_balance(&1), 0);
|
||||
assert_eq!(Balances::free_balance(&1), 10);
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn error_catching_should_work() {
|
||||
new_test_ext().execute_with(|| {
|
||||
assert_noop!(Nicks::clear_name(Origin::signed(1)), "Not named");
|
||||
|
||||
assert_noop!(Nicks::set_name(Origin::signed(3), b"Dave".to_vec()), "not enough free funds");
|
||||
|
||||
assert_noop!(Nicks::set_name(Origin::signed(1), b"Ga".to_vec()), "Name too short");
|
||||
assert_noop!(
|
||||
Nicks::set_name(Origin::signed(1), b"Gavin James Wood, Esquire".to_vec()),
|
||||
"Name too long"
|
||||
);
|
||||
assert_ok!(Nicks::set_name(Origin::signed(1), b"Dave".to_vec()));
|
||||
assert_noop!(Nicks::kill_name(Origin::signed(2), 1), "bad origin");
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user