Vesting

crates/pallet-chain-start-moment/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "pallet-chain-start-moment"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
+frame-support = { default-features = false, git = "https://github.com/humanode-network/substrate", branch = "master" }
+frame-system = { default-features = false, git = "https://github.com/humanode-network/substrate", branch = "master" }
+scale-info = { version = "2.1.1", default-features = false, features = ["derive"] }
+
+[dev-dependencies]
+pallet-timestamp = { git = "https://github.com/humanode-network/substrate", branch = "master" }
+sp-core = { git = "https://github.com/humanode-network/substrate", branch = "master" }
+
+[features]
+default = ["std"]
+std = [
+  "codec/std",
+  "scale-info/std",
+  "frame-support/std",
+  "frame-system/std",
+]

crates/pallet-chain-start-moment/src/lib.rs

@@ -0,0 +1,69 @@
+//! A pallet that captures the moment of the chain start.
+
+#![cfg_attr(not(feature = "std"), no_std)]
+
+use frame_support::traits::{StorageVersion, Time};
+
+pub use self::pallet::*;
+
+#[cfg(test)]
+mod mock;
+#[cfg(test)]
+mod tests;
+
+/// The current storage version.
+const STORAGE_VERSION: StorageVersion = StorageVersion::new(0);
+
+// We have to temporarily allow some clippy lints. Later on we'll send patches to substrate to
+// fix them at their end.
+#[allow(clippy::missing_docs_in_private_items)]
+#[frame_support::pallet]
+pub mod pallet {
+    use frame_support::pallet_prelude::*;
+    use frame_system::pallet_prelude::*;
+
+    use super::*;
+
+    #[pallet::pallet]
+    #[pallet::storage_version(STORAGE_VERSION)]
+    #[pallet::generate_store(pub(super) trait Store)]
+    pub struct Pallet<T>(_);
+
+    #[pallet::config]
+    pub trait Config: frame_system::Config {
+        /// A type representing the time moment and providing the current time.
+        type Time: Time;
+    }
+
+    /// The captured chain start moment.
+    #[pallet::storage]
+    #[pallet::getter(fn chain_start)]
+    pub type ChainStart<T> = StorageValue<_, <<T as Config>::Time as Time>::Moment, OptionQuery>;
+
+    #[pallet::hooks]
+    impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
+        fn on_initialize(n: BlockNumberFor<T>) -> Weight {
+            if n != 1u8.into() {
+                return 0;
+            }
+            <T as frame_system::Config>::DbWeight::get().writes(1)
+        }
+
+        fn on_finalize(n: BlockNumberFor<T>) {
+            if n != 1u8.into() {
+                return;
+            }
+
+            let now = T::Time::now();
+
+            // Ensure that the chain start is properly initialized.
+            assert_ne!(
+                now,
+                0u8.into(),
+                "the chain start moment is zero, it is not right"
+            );
+
+            <ChainStart<T>>::put(now);
+        }
+    }
+}

crates/pallet-chain-start-moment/src/mock.rs

@@ -0,0 +1,83 @@
+//! The mock for the pallet.
+
+use frame_support::{
+    sp_io,
+    sp_runtime::{
+        testing::Header,
+        traits::{BlakeTwo256, IdentityLookup},
+        BuildStorage,
+    },
+    traits::{ConstU32, ConstU64},
+};
+use sp_core::H256;
+
+use crate::{self as pallet_chain_start_moment};
+
+pub type UnixMilliseconds = u64;
+
+type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;
+type Block = frame_system::mocking::MockBlock<Test>;
+
+frame_support::construct_runtime!(
+    pub enum Test where
+        Block = Block,
+        NodeBlock = Block,
+        UncheckedExtrinsic = UncheckedExtrinsic,
+    {
+        System: frame_system::{Pallet, Call, Config, Storage, Event<T>},
+        Timestamp: pallet_timestamp::{Pallet},
+        ChainStartMoment: pallet_chain_start_moment::{Pallet, Storage},
+    }
+);
+
+impl frame_system::Config for Test {
+    type BaseCallFilter = frame_support::traits::Everything;
+    type BlockWeights = ();
+    type BlockLength = ();
+    type DbWeight = ();
+    type Origin = Origin;
+    type Call = Call;
+    type Index = u64;
+    type BlockNumber = u64;
+    type Hash = H256;
+    type Hashing = BlakeTwo256;
+    type AccountId = u64;
+    type Lookup = IdentityLookup<u64>;
+    type Header = Header;
+    type Event = Event;
+    type BlockHashCount = ConstU64<250>;
+    type Version = ();
+    type PalletInfo = PalletInfo;
+    type AccountData = ();
+    type OnNewAccount = ();
+    type OnKilledAccount = ();
+    type SystemWeightInfo = ();
+    type SS58Prefix = ();
+    type OnSetCode = ();
+    type MaxConsumers = ConstU32<16>;
+}
+
+impl pallet_timestamp::Config for Test {
+    type Moment = UnixMilliseconds;
+    type OnTimestampSet = ();
+    type MinimumPeriod = ConstU64<5>;
+    type WeightInfo = ();
+}
+
+impl pallet_chain_start_moment::Config for Test {
+    type Time = Timestamp;
+}
+
+pub fn new_test_ext() -> sp_io::TestExternalities {
+    let genesis_config = GenesisConfig {
+        system: Default::default(),
+    };
+    new_test_ext_with(genesis_config)
+}
+
+// This function basically just builds a genesis storage key/value store according to
+// our desired mockup.
+pub fn new_test_ext_with(genesis_config: GenesisConfig) -> sp_io::TestExternalities {
+    let storage = genesis_config.build_storage().unwrap();
+    storage.into()
+}

crates/pallet-chain-start-moment/src/tests.rs

@@ -0,0 +1,96 @@
+use frame_support::traits::Hooks;
+
+use crate::mock::*;
+
+fn set_timestamp(inc: UnixMilliseconds) {
+    Timestamp::set(Origin::none(), inc).unwrap();
+}
+
+fn switch_block() {
+    if System::block_number() != 0 {
+        Timestamp::on_finalize(System::block_number());
+        ChainStartMoment::on_finalize(System::block_number());
+        System::on_finalize(System::block_number());
+    }
+    System::set_block_number(System::block_number() + 1);
+    System::on_initialize(System::block_number());
+    Timestamp::on_initialize(System::block_number());
+    ChainStartMoment::on_initialize(System::block_number());
+}
+
+/// This test verifies that the chain start moment is not set at genesis.
+#[test]
+fn value_is_not_set_at_genesis() {
+    // Build the state from the config.
+    new_test_ext().execute_with(move || {
+        // Assert the state.
+        assert_eq!(ChainStartMoment::chain_start(), None);
+    })
+}
+
+/// This test verifies that the chain start moment is set at the very first block.
+#[test]
+fn value_is_set_at_first_block() {
+    // Build the state from the config.
+    new_test_ext().execute_with(move || {
+        // Block 0.
+        // Ensure we don't have any timestamp set first.
+        assert_eq!(ChainStartMoment::chain_start(), None);
+
+        // Block 0 -> 1.
+        switch_block();
+        set_timestamp(100);
+        assert_eq!(ChainStartMoment::chain_start(), None,);
+
+        // Block 1 -> 2.
+        switch_block();
+        assert_eq!(
+            ChainStartMoment::chain_start(),
+            Some(100),
+            "the chain start must be set correctly right after the first block has been finalized"
+        );
+    })
+}
+
+/// This test verifies that the chain start moment is not written to after the first block.
+#[test]
+fn value_does_not_get_written_after_the_first_block() {
+    // Build the state from the config.
+    new_test_ext().execute_with(move || {
+        // Block 0 -> 1.
+        switch_block();
+
+        set_timestamp(100);
+
+        // Block 1 -> 2.
+        switch_block();
+
+        set_timestamp(106);
+
+        // Block 2 -> 3.
+        switch_block();
+
+        // Assert the state.
+        assert_eq!(
+            ChainStartMoment::chain_start(),
+            Some(100),
+            "the chain start moment must've been recorded at the first block"
+        );
+    })
+}
+
+/// This test verifies that the chain start moment is valid when capture it.
+#[test]
+#[should_panic = "the chain start moment is zero, it is not right"]
+fn value_is_properly_checked() {
+    // Build the state from the config.
+    new_test_ext().execute_with(move || {
+        // Block 0 -> 1.
+        switch_block();
+
+        set_timestamp(0);
+
+        // Block 1 -> 2.
+        switch_block();
+    })
+}

crates/pallet-vesting/Cargo.toml

@@ -0,0 +1,34 @@
+[package]
+name = "pallet-vesting"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
+frame-benchmarking = { default-features = false, git = "https://github.com/humanode-network/substrate", branch = "master", optional = true }
+frame-support = { default-features = false, git = "https://github.com/humanode-network/substrate", branch = "master" }
+frame-system = { default-features = false, git = "https://github.com/humanode-network/substrate", branch = "master" }
+scale-info = { version = "2.1.1", default-features = false, features = ["derive"] }
+serde = { version = "1", optional = true }
+
+[dev-dependencies]
+mockall = "0.11"
+once_cell = "1"
+pallet-balances = { git = "https://github.com/humanode-network/substrate", branch = "master" }
+sp-core = { git = "https://github.com/humanode-network/substrate", branch = "master" }
+
+[features]
+default = ["std"]
+runtime-benchmarks = [
+  "frame-benchmarking/runtime-benchmarks",
+  "frame-support/runtime-benchmarks",
+  "frame-system/runtime-benchmarks",
+]
+std = [
+  "codec/std",
+  "frame-benchmarking/std",
+  "frame-support/std",
+  "frame-system/std",
+  "serde",
+]