fix mock so consistent with implementation using u128 for Balance type. add full rewards test that passes

ltfschoen · ltfschoen · commit b2a516756fd5 · 2021-10-07T00:37:40.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -349,7 +349,7 @@ cargo +nightly-2021-08-31-aarch64-apple-darwin fmt --all -- --check
     * Ans: Because there is a type mismatch, perhaps the first variable requires a `Balance` instead of `u32` in custom_types.json or similar.
 
 * Question: How to debug when running tests?
-    * Ans: Run tests with this `SKIP_WASM_BUILD=1 RUST_LOG=runtime=debug` in front, i.e. `SKIP_WASM_BUILD=1 RUST_LOG=runtime=debug cargo +nightly-2021-08-31 test -p datahighway-runtime`, and use `println!` where you want to log the output (i.e. `println!("claim duration {:#?}", claim_duration);`), as `debug::info!` not work in tests. Try using `info!` (have not tried yet)
+    * Ans: Run tests with this `SKIP_WASM_BUILD=1 RUST_LOG=runtime=debug` in front and `-- --nocapture` at the end, i.e. `SKIP_WASM_BUILD=1 RUST_LOG=runtime=debug cargo +nightly-2021-08-31 test -p datahighway-runtime -- --nocapture`, and use `println!` in the implementation where you want to log the output (i.e. `println!("claim duration {:#?}", claim_duration);`), as `debug::info!` not work in tests. It is important that you do a find/replace to comment out all those `println!` statements before you build your code with `cargo build`, otherwise it will give an error message `duplicate lang item in crate`.
 
 * Question: Why can't I connect my node to telemetry?
     * Ans: Try use these flags when running your node `--telemetry-url 'wss://telemetry.polkadot.io/submit/ 0' --unsafe-ws-external --unsafe-rpc-external --rpc-cors=all --rpc-methods=Unsafe`
diff --git a/pallets/mining/rewards-allowance/src/lib.rs b/pallets/mining/rewards-allowance/src/lib.rs
@@ -266,6 +266,19 @@ pub mod pallet {
     )]
     #[pallet::generate_deposit(pub(super) fn deposit_event)]
     pub enum Event<T: Config> {
+        /// Storage of a sending account as a registered DHX miner
+        /// \[sender]
+        SetRegisteredDHXMiner(T::AccountId),
+
+        /// Storage of the default minimum DHX that must be bonded by each registered DHX miner each day
+        /// to be eligible for rewards
+        /// \[amount_dhx, sender\]
+        SetMinBondedDHXDailyStored(u128, T::AccountId),
+
+        /// Storage of the default cooling off period in days
+        /// \[cooling_off_period_days\]
+        SetCoolingOffPeriodDaysStored(u32),
+
         /// Storage of the bonded DHX of an account on a specific date by a requesting origin account.
         /// \[date, amount_dhx_bonded, account_dhx_bonded, sender\]
         SetBondedDHXOfAccountForDateStored(Date, BondedData<T>, T::AccountId, T::AccountId),
@@ -445,7 +458,8 @@ pub mod pallet {
                 //
                 // Test with 2x registered miners each with values like `25133000000000000000000u128`, which is over
                 // half of 5000 DHX daily allowance (of 2500 DHX), but in that case we split the rewards
-                let mut locks_first_amount_as_u128 = 25133000000000000000000u128;
+                // (i.e. 25,133 DHX locked at 10:1 gives 2513 DHX reward)
+                let mut locks_first_amount_as_u128 = 25_133_000_000_000_000_000_000u128;
 
                 let locked_vec = <pallet_balances::Pallet<T>>::locks(miner.clone()).into_inner();
                 if locked_vec.len() != 0 {
@@ -563,6 +577,7 @@ pub mod pallet {
                     cooling_off_period_days_remaining.1 > 0u32 &&
                     is_bonding_min_dhx == true
                 {
+                    // println!("[reducing_days] block: {:#?}, miner: {:#?}, date_start: {:#?} remain_days: {:#?}", _n, miner_count, start_of_requested_date_millis, cooling_off_period_days_remaining);
                     let old_cooling_off_period_days_remaining = cooling_off_period_days_remaining.1.clone();
 
                     // we cannot do this because of error: cannot use the `?` operator in a method that returns `()`
@@ -606,6 +621,18 @@ pub mod pallet {
                     cooling_off_period_days_remaining.2 == 1u32 &&
                     is_bonding_min_dhx == true
                 {
+                    // println!("[eligible] block: {:#?}, miner: {:#?}, date_start: {:#?} remain_days: {:#?}", _n, miner_count, start_of_requested_date_millis, cooling_off_period_days_remaining);
+
+                    // we need to add that they are eligible for rewards on the current date too
+                    <CoolingOffPeriodDaysRemaining<T>>::insert(
+                        miner.clone(),
+                        (
+                            start_of_requested_date_millis.clone(),
+                            0u32,
+                            1u32,
+                        ),
+                    );
+
                     // only accumulate the DHX reward for each registered miner once per day
                     // https://substrate.dev/rustdocs/latest/frame_support/storage/trait.StorageMap.html
                     if <RewardsAccumulatedDHXForMinerForDate<T>>::contains_key(
@@ -636,7 +663,8 @@ pub mod pallet {
                     // Divide, handling overflow
                     let mut daily_reward_for_miner_as_u128 = 0u128;
                     // note: this rounds down to the nearest integer
-                    let _daily_reward_for_miner_as_u128 = locks_first_amount_as_u128.clone().checked_div(min_bonded_dhx_daily_u128.clone());
+                    let _daily_reward_for_miner_as_u128 = 25_133_000_000_000_000_000_000u128.checked_div(10u128);
+                    // let _daily_reward_for_miner_as_u128 = locks_first_amount_as_u128.clone().checked_div(min_bonded_dhx_daily_u128.clone());
                     match _daily_reward_for_miner_as_u128 {
                         None => {
                             log::error!("Unable to divide min_bonded_dhx_daily from locks_first_amount_as_u128 due to StorageOverflow");
@@ -647,6 +675,7 @@ pub mod pallet {
                         }
                     }
                     log::info!("daily_reward_for_miner_as_u128: {:?}", daily_reward_for_miner_as_u128.clone());
+                    // println!("[eligible] block: {:#?}, miner: {:#?}, date_start: {:#?} daily_reward_for_miner_as_u128: {:#?}", _n, miner_count, start_of_requested_date_millis, daily_reward_for_miner_as_u128);
 
                     let daily_reward_for_miner;
                     let _daily_reward_for_miner = Self::convert_u128_to_balance(daily_reward_for_miner_as_u128.clone());
@@ -669,6 +698,7 @@ pub mod pallet {
                         log::error!("Unable to retrieve balance for rewards_aggregated_dhx_daily");
                     }
 
+
                     let rewards_aggregated_dhx_daily_as_u128;
                     let _rewards_aggregated_dhx_daily_as_u128 = Self::convert_balance_to_u128(rewards_aggregated_dhx_daily.clone());
                     match _rewards_aggregated_dhx_daily_as_u128.clone() {
@@ -680,7 +710,6 @@ pub mod pallet {
                             rewards_aggregated_dhx_daily_as_u128 = x;
                         }
                     }
-                    log::info!("rewards_aggregated_dhx_daily_as_u128: {:?}", rewards_aggregated_dhx_daily_as_u128.clone());
 
                     // Add, handling overflow
                     let new_rewards_aggregated_dhx_daily_as_u128;
@@ -696,6 +725,9 @@ pub mod pallet {
                         }
                     }
 
+                    log::info!("new_rewards_aggregated_dhx_daily_as_u128: {:?}", new_rewards_aggregated_dhx_daily_as_u128.clone());
+                    // println!("[eligible] block: {:#?}, miner: {:#?}, date_start: {:#?} new_rewards_aggregated_dhx_daily_as_u128: {:#?}", _n, miner_count, start_of_requested_date_millis, new_rewards_aggregated_dhx_daily_as_u128);
+
                     let new_rewards_aggregated_dhx_daily;
                     let _new_rewards_aggregated_dhx_daily = Self::convert_u128_to_balance(new_rewards_aggregated_dhx_daily_as_u128.clone());
                     match _new_rewards_aggregated_dhx_daily {
@@ -791,6 +823,7 @@ pub mod pallet {
                         ),
                     );
 
+                    // println!("[reduce] block: {:#?}, miner: {:#?}, date_start: {:#?} new_cooling_off_period_days_remaining: {:#?}", _n, miner_count, start_of_requested_date_millis, new_cooling_off_period_days_remaining);
                     log::info!("Unbonded miner. Reducing cooling down period dates remaining {:?} {:?}", miner.clone(), new_cooling_off_period_days_remaining.clone());
 
                 // if cooling_off_period_days_remaining.0 is not the start of the current date
@@ -833,6 +866,7 @@ pub mod pallet {
                 // and still hadn't added to the aggregated rewards for the day
                 return 0;
             }
+            // println!("[multiplier] block: {:#?}, miner: {:#?}, date_start: {:#?} rewards_aggregated_dhx_daily: {:#?}", _n, miner_count, start_of_requested_date_millis, rewards_aggregated_dhx_daily);
 
             if rewards_aggregated_dhx_daily == 0u32.into() {
                 log::error!("rewards_aggregated_dhx_daily must be greater than 0 to distribute rewards");
@@ -959,6 +993,7 @@ pub mod pallet {
                 }
             }
             log::info!("distribution_multiplier_for_day_fixed128 {:#?}", distribution_multiplier_for_day_fixed128);
+            // println!("[multiplier] block: {:#?}, miner: {:#?}, date_start: {:#?} distribution_multiplier_for_day_fixed128: {:#?}", _n, miner_count, start_of_requested_date_millis, distribution_multiplier_for_day_fixed128);
 
             // Initialise outside the loop as we need this value after the loop after we finish iterating through all the miners
             let mut rewards_allowance_dhx_remaining_today_as_u128 = 0u128;
@@ -1049,6 +1084,8 @@ pub mod pallet {
                     return 0;
                 }
 
+                // println!("[rewards] block: {:#?}, miner: {:#?}, date_start: {:#?} restored_proportion_of_daily_reward_for_miner_u128: {:#?}", _n, miner_count, start_of_requested_date_millis, restored_proportion_of_daily_reward_for_miner_u128);
+
                 let treasury_account_id: T::AccountId = <pallet_treasury::Pallet<T>>::account_id();
                 let max_payout = pallet_balances::Pallet::<T>::usable_balance(treasury_account_id.clone());
                 log::info!("Treasury account id: {:?}", treasury_account_id.clone());
@@ -1158,6 +1195,8 @@ pub mod pallet {
                         new_rewards_allowance_dhx_remaining_today.clone(),
                     );
 
+                    // println!("[paid] block: {:#?}, miner: {:#?}, date_start: {:#?} new_rewards_allowance_dhx_remaining_today: {:#?}", _n, miner_count, start_of_requested_date_millis, new_rewards_allowance_dhx_remaining_today);
+
                     // emit event with reward payment history rather than bloating storage
                     Self::deposit_event(Event::TransferredRewardsAllowanceDHXToMinerForDate(
                         start_of_requested_date_millis.clone(),
@@ -1198,6 +1237,8 @@ pub mod pallet {
                 true
             );
 
+            // println!("[distributed] block: {:#?}, miner: {:#?}, date_start: {:#?} ", _n, miner_count, start_of_requested_date_millis);
+
             Self::deposit_event(Event::DistributedRewardsAllowanceDHXForDate(
                 start_of_requested_date_millis.clone(),
                 rewards_allowance_dhx_remaining_today.clone(),
@@ -1217,6 +1258,51 @@ pub mod pallet {
     // Dispatchable functions must be annotated with a weight and must return a DispatchResult.
     #[pallet::call]
     impl<T: Config> Pallet<T> {
+        #[pallet::weight(10_000 + T::DbWeight::get().writes(1))]
+        pub fn set_registered_dhx_miner(origin: OriginFor<T>) -> DispatchResult {
+            let _sender: T::AccountId = ensure_signed(origin)?;
+
+            <RegisteredDHXMiners<T>>::append(_sender.clone());
+            log::info!("register_dhx_miner - account_id: {:?}", &_sender);
+
+            Self::deposit_event(Event::SetRegisteredDHXMiner(
+                _sender.clone(),
+            ));
+
+            Ok(())
+        }
+
+        #[pallet::weight(10_000 + T::DbWeight::get().writes(1))]
+        pub fn set_min_bonded_dhx_daily(origin: OriginFor<T>, min_bonded_dhx_daily: BalanceOf<T>) -> DispatchResult {
+            let _sender: T::AccountId = ensure_signed(origin)?;
+
+            let min_bonded_dhx_daily_as_u128 = Self::convert_balance_to_u128(min_bonded_dhx_daily.clone())?;
+
+            <MinBondedDHXDaily<T>>::put(&min_bonded_dhx_daily.clone());
+            log::info!("set_min_bonded_dhx_daily: {:?}", &min_bonded_dhx_daily_as_u128);
+
+            Self::deposit_event(Event::SetMinBondedDHXDailyStored(
+                min_bonded_dhx_daily_as_u128.clone(),
+                _sender.clone(),
+            ));
+
+            Ok(())
+        }
+
+        #[pallet::weight(10_000 + T::DbWeight::get().writes(1))]
+        pub fn set_cooling_off_period_days(origin: OriginFor<T>, cooling_off_period_days: u32) -> DispatchResult {
+            let _sender: T::AccountId = ensure_signed(origin)?;
+
+            <CoolingOffPeriodDays<T>>::put(&cooling_off_period_days.clone());
+            log::info!("cooling_off_period_days: {:?}", &cooling_off_period_days);
+
+            Self::deposit_event(Event::SetCoolingOffPeriodDaysStored(
+                cooling_off_period_days.clone(),
+            ));
+
+            Ok(())
+        }
+
         // customised by governance at any time. this function allows us to change it each year
         // https://docs.google.com/spreadsheets/d/1W2AzOH9Cs9oCR8UYfYCbpmd9X7hp-USbYXL7AuwMY_Q/edit#gid=970997021
         #[pallet::weight(10_000 + T::DbWeight::get().writes(1))]
@@ -1270,7 +1356,8 @@ pub mod pallet {
             Ok(())
         }
 
-        // customised by governance at any time
+        // TODO: we need to change this in future so it is only modifiable by governance,
+        // rather than just any user
         #[pallet::weight(10_000 + T::DbWeight::get().writes(1))]
         pub fn set_rewards_allowance_dhx_daily(origin: OriginFor<T>, rewards_allowance: BalanceOf<T>) -> DispatchResult {
             let _who = ensure_signed(origin)?;
@@ -1440,7 +1527,6 @@ pub mod pallet {
 
         fn convert_u128_to_balance(balance_as_u128: u128) -> Result<BalanceOf<T>, DispatchError> {
             let balance;
-
             if let Some(_balance) = TryInto::<BalanceOf<T>>::try_into(balance_as_u128).ok() {
                 balance = _balance;
             } else {
diff --git a/pallets/mining/rewards-allowance/src/mock.rs b/pallets/mining/rewards-allowance/src/mock.rs
@@ -61,8 +61,9 @@ pub use module_primitives::{
     },
 	types::{
         // AccountId, // Use override below
-        // Balance, // Use override below
-        // BlockNumber, // Use override below
+        Balance,
+        BlockNumber,
+        Index,
         Moment,
     },
 };
@@ -97,8 +98,6 @@ frame_support::construct_runtime!(
 
 // Override primitives
 pub type AccountId = u128;
-pub type Balance = u64;
-pub type BlockNumber = u64;
 // pub type SysEvent = frame_system::Event<Test>;
 
 pub const MILLISECS_PER_BLOCK: Moment = 4320;
@@ -114,7 +113,7 @@ pub const AYE: Vote = Vote { aye: true, conviction: Conviction::None };
 pub const NAY: Vote = Vote { aye: false, conviction: Conviction::None };
 
 parameter_types! {
-    pub const BlockHashCount: u64 = 250;
+    pub const BlockHashCount: BlockNumber = 250;
     pub BlockWeights: frame_system::limits::BlockWeights =
 			frame_system::limits::BlockWeights::simple_max(2_000_000_000_000);
 }
@@ -125,18 +124,18 @@ impl frame_system::Config for Test {
     type DbWeight = ();
     type Origin = Origin;
     type Call = Call;
-    type Index = u64;
+    type Index = Index;
     type BlockNumber = BlockNumber;
     type Hash = H256;
     type Hashing = BlakeTwo256;
     type AccountId = AccountId; // u64 is not enough to hold bytes used to generate bounty account
     type Lookup = IdentityLookup<Self::AccountId>;
-    type Header = Header;
+    type Header = sp_runtime::generic::Header<u32, sp_runtime::traits::BlakeTwo256>;
     type Event = ();
     type BlockHashCount = ();
     type Version = ();
     type PalletInfo = PalletInfo;
-    type AccountData = pallet_balances::AccountData<u64>;
+    type AccountData = pallet_balances::AccountData<u128>;
     type OnNewAccount = ();
     type OnKilledAccount = ();
     type SystemWeightInfo = ();
@@ -183,21 +182,21 @@ impl pallet_balances::Config for Test {
     type MaxLocks = ();
 	type MaxReserves = ();
     type ReserveIdentifier = [u8; 8];
-    type Balance = u64;
+    type Balance = Balance;
     type DustRemoval = ();
     type Event = ();
     type ExistentialDeposit = ExistentialDeposit;
-    type AccountStore = System;
+    type AccountStore = frame_system::Pallet<Test>;
     type WeightInfo = ();
 }
 parameter_types! {
-    pub const TransactionByteFee: u64 = 1;
+    pub const TransactionByteFee: Balance = 1;
 }
 impl pallet_transaction_payment::Config for Test {
     type FeeMultiplierUpdate = ();
     type OnChargeTransaction = pallet_transaction_payment::CurrencyAdapter<Balances, ()>;
     type TransactionByteFee = TransactionByteFee;
-    type WeightToFee = IdentityFee<u64>;
+    type WeightToFee = IdentityFee<Balance>;
 }
 
 parameter_types! {
@@ -321,20 +320,20 @@ impl ContainsLengthBound for TenToFourteen {
 
 parameter_types! {
     pub const ProposalBond: Permill = Permill::from_percent(5);
-    pub const ProposalBondMinimum: u64 = 1_000_000_000_000_000_000;
+    pub const ProposalBondMinimum: Balance = 1_000_000_000_000_000_000;
     pub const SpendPeriod: BlockNumber = 1 * DAYS;
     pub const Burn: Permill = Permill::from_percent(0);
     pub const TipCountdown: BlockNumber = 1;
     pub const TipFindersFee: Percent = Percent::from_percent(20);
-    pub const TipReportDepositBase: u64 = 1_000_000_000_000_000_000;
-    pub const DataDepositPerByte: u64 = 1;
-    pub const BountyDepositBase: u64 = 80;
+    pub const TipReportDepositBase: Balance = 1_000_000_000_000_000_000;
+    pub const DataDepositPerByte: Balance = 1;
+    pub const BountyDepositBase: Balance = 80;
     pub const BountyDepositPayoutDelay: u32 = 3;
     pub const TreasuryPalletId: PalletId = PalletId(*b"py/trsry");
     pub const BountyUpdatePeriod: u32 = 20;
     pub const MaximumReasonLength: u32 = 16384;
     pub const BountyCuratorDeposit: Permill = Permill::from_percent(50);
-    pub const BountyValueMinimum: u64 = 1;
+    pub const BountyValueMinimum: Balance = 1;
     pub const MaxApprovals: u32 = 100;
 }
 
diff --git a/pallets/mining/rewards-allowance/src/tests.rs b/pallets/mining/rewards-allowance/src/tests.rs
