Files
pezkuwi-subxt/substrate/frame/recovery/src/tests.rs
T
Juan 878c562cd4 Restructure frame_support macro related exports (#14745)
* make reexports private

* make reexports private 2

* make reexports private for runtime-benchmarking

* make reexports private for try-runtime

* fix for try-runtime

* make reexports private for tests

* fmt

* make reexports private for tests

* make reexports private for experimental

* fix beefy

* fix ui test

* fix ui test

* fix benches

* ".git/.scripts/commands/fmt/fmt.sh"

* fix contracts use

* wip

* wip

* do not reexport sp_api::metadata_ir

* fix CI checks

* fix support tests

* ".git/.scripts/commands/fmt/fmt.sh"

* Update frame/support/src/lib.rs

Co-authored-by: Bastian Köcher <git@kchr.de>

* import codec directly

* fmt

* fix node-cli tests

---------

Co-authored-by: command-bot <>
Co-authored-by: Bastian Köcher <git@kchr.de>
2023-08-23 12:30:12 +00:00

498 lines
16 KiB
Rust

// This file is part of Substrate.
// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Tests for the module.
use super::*;
use frame_support::{assert_noop, assert_ok, traits::Currency};
use mock::{
new_test_ext, run_to_block, Balances, BalancesCall, MaxFriends, Recovery, RecoveryCall,
RuntimeCall, RuntimeOrigin, Test,
};
use sp_runtime::{bounded_vec, traits::BadOrigin};
#[test]
fn basic_setup_works() {
new_test_ext().execute_with(|| {
// Nothing in storage to start
assert_eq!(Recovery::proxy(&2), None);
assert_eq!(Recovery::active_recovery(&1, &2), None);
assert_eq!(Recovery::recovery_config(&1), None);
// Everyone should have starting balance of 100
assert_eq!(Balances::free_balance(1), 100);
});
}
#[test]
fn set_recovered_works() {
new_test_ext().execute_with(|| {
// Not accessible by a normal user
assert_noop!(Recovery::set_recovered(RuntimeOrigin::signed(1), 5, 1), BadOrigin);
// Root can set a recovered account though
assert_ok!(Recovery::set_recovered(RuntimeOrigin::root(), 5, 1));
// Account 1 should now be able to make a call through account 5
let call = Box::new(RuntimeCall::Balances(BalancesCall::transfer_allow_death {
dest: 1,
value: 100,
}));
assert_ok!(Recovery::as_recovered(RuntimeOrigin::signed(1), 5, call));
// Account 1 has successfully drained the funds from account 5
assert_eq!(Balances::free_balance(1), 200);
assert_eq!(Balances::free_balance(5), 0);
});
}
#[test]
fn recovery_life_cycle_works() {
new_test_ext().execute_with(|| {
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
// Account 5 sets up a recovery configuration on their account
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends,
threshold,
delay_period
));
// Some time has passed, and the user lost their keys!
run_to_block(10);
// Using account 1, the user begins the recovery process to recover the lost account
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
// Off chain, the user contacts their friends and asks them to vouch for the recovery
// attempt
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(3), 5, 1));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(4), 5, 1));
// We met the threshold, lets try to recover the account...?
assert_noop!(
Recovery::claim_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::DelayPeriod
);
// We need to wait at least the delay_period number of blocks before we can recover
run_to_block(20);
assert_ok!(Recovery::claim_recovery(RuntimeOrigin::signed(1), 5));
// Account 1 can use account 5 to close the active recovery process, claiming the deposited
// funds used to initiate the recovery process into account 5.
let call = Box::new(RuntimeCall::Recovery(RecoveryCall::close_recovery { rescuer: 1 }));
assert_ok!(Recovery::as_recovered(RuntimeOrigin::signed(1), 5, call));
// Account 1 can then use account 5 to remove the recovery configuration, claiming the
// deposited funds used to create the recovery configuration into account 5.
let call = Box::new(RuntimeCall::Recovery(RecoveryCall::remove_recovery {}));
assert_ok!(Recovery::as_recovered(RuntimeOrigin::signed(1), 5, call));
// Account 1 should now be able to make a call through account 5 to get all of their funds
assert_eq!(Balances::free_balance(5), 110);
let call = Box::new(RuntimeCall::Balances(BalancesCall::transfer_allow_death {
dest: 1,
value: 110,
}));
assert_ok!(Recovery::as_recovered(RuntimeOrigin::signed(1), 5, call));
// All funds have been fully recovered!
assert_eq!(Balances::free_balance(1), 200);
assert_eq!(Balances::free_balance(5), 0);
// Remove the proxy link.
assert_ok!(Recovery::cancel_recovered(RuntimeOrigin::signed(1), 5));
// All storage items are removed from the module
assert!(!<ActiveRecoveries<Test>>::contains_key(&5, &1));
assert!(!<Recoverable<Test>>::contains_key(&5));
assert!(!<Proxy<Test>>::contains_key(&1));
});
}
#[test]
fn malicious_recovery_fails() {
new_test_ext().execute_with(|| {
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
// Account 5 sets up a recovery configuration on their account
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends,
threshold,
delay_period
));
// Some time has passed, and account 1 wants to try and attack this account!
run_to_block(10);
// Using account 1, the malicious user begins the recovery process on account 5
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
// Off chain, the user **tricks** their friends and asks them to vouch for the recovery
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1));
// shame on you
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(3), 5, 1));
// shame on you
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(4), 5, 1));
// shame on you
// We met the threshold, lets try to recover the account...?
assert_noop!(
Recovery::claim_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::DelayPeriod
);
// Account 1 needs to wait...
run_to_block(19);
// One more block to wait!
assert_noop!(
Recovery::claim_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::DelayPeriod
);
// Account 5 checks their account every `delay_period` and notices the malicious attack!
// Account 5 can close the recovery process before account 1 can claim it
assert_ok!(Recovery::close_recovery(RuntimeOrigin::signed(5), 1));
// By doing so, account 5 has now claimed the deposit originally reserved by account 1
assert_eq!(Balances::total_balance(&1), 90);
// Thanks for the free money!
assert_eq!(Balances::total_balance(&5), 110);
// The recovery process has been closed, so account 1 can't make the claim
run_to_block(20);
assert_noop!(
Recovery::claim_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::NotStarted
);
// Account 5 can remove their recovery config and pick some better friends
assert_ok!(Recovery::remove_recovery(RuntimeOrigin::signed(5)));
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
vec![22, 33, 44],
threshold,
delay_period
));
});
}
#[test]
fn create_recovery_handles_basic_errors() {
new_test_ext().execute_with(|| {
// No friends
assert_noop!(
Recovery::create_recovery(RuntimeOrigin::signed(5), vec![], 1, 0),
Error::<Test>::NotEnoughFriends
);
// Zero threshold
assert_noop!(
Recovery::create_recovery(RuntimeOrigin::signed(5), vec![2], 0, 0),
Error::<Test>::ZeroThreshold
);
// Threshold greater than friends length
assert_noop!(
Recovery::create_recovery(RuntimeOrigin::signed(5), vec![2, 3, 4], 4, 0),
Error::<Test>::NotEnoughFriends
);
// Too many friends
assert_noop!(
Recovery::create_recovery(
RuntimeOrigin::signed(5),
vec![1; (MaxFriends::get() + 1) as usize],
1,
0
),
Error::<Test>::MaxFriends
);
// Unsorted friends
assert_noop!(
Recovery::create_recovery(RuntimeOrigin::signed(5), vec![3, 2, 4], 3, 0),
Error::<Test>::NotSorted
);
// Duplicate friends
assert_noop!(
Recovery::create_recovery(RuntimeOrigin::signed(5), vec![2, 2, 4], 3, 0),
Error::<Test>::NotSorted
);
// Already configured
assert_ok!(Recovery::create_recovery(RuntimeOrigin::signed(5), vec![2, 3, 4], 3, 10));
assert_noop!(
Recovery::create_recovery(RuntimeOrigin::signed(5), vec![2, 3, 4], 3, 10),
Error::<Test>::AlreadyRecoverable
);
});
}
#[test]
fn create_recovery_works() {
new_test_ext().execute_with(|| {
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
// Account 5 sets up a recovery configuration on their account
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends.clone(),
threshold,
delay_period
));
// Deposit is taken, and scales with the number of friends they pick
// Base 10 + 1 per friends = 13 total reserved
assert_eq!(Balances::reserved_balance(5), 13);
// Recovery configuration is correctly stored
let recovery_config = RecoveryConfig {
delay_period,
deposit: 13,
friends: friends.try_into().unwrap(),
threshold,
};
assert_eq!(Recovery::recovery_config(5), Some(recovery_config));
});
}
#[test]
fn initiate_recovery_handles_basic_errors() {
new_test_ext().execute_with(|| {
// No recovery process set up for the account
assert_noop!(
Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::NotRecoverable
);
// Create a recovery process for next test
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends.clone(),
threshold,
delay_period
));
// Same user cannot recover same account twice
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
assert_noop!(
Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::AlreadyStarted
);
// No double deposit
assert_eq!(Balances::reserved_balance(1), 10);
});
}
#[test]
fn initiate_recovery_works() {
new_test_ext().execute_with(|| {
// Create a recovery process for the test
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends.clone(),
threshold,
delay_period
));
// Recovery can be initiated
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
// Deposit is reserved
assert_eq!(Balances::reserved_balance(1), 10);
// Recovery status object is created correctly
let recovery_status =
ActiveRecovery { created: 0, deposit: 10, friends: Default::default() };
assert_eq!(<ActiveRecoveries<Test>>::get(&5, &1), Some(recovery_status));
// Multiple users can attempt to recover the same account
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(2), 5));
});
}
#[test]
fn vouch_recovery_handles_basic_errors() {
new_test_ext().execute_with(|| {
// Cannot vouch for non-recoverable account
assert_noop!(
Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1),
Error::<Test>::NotRecoverable
);
// Create a recovery process for next tests
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends.clone(),
threshold,
delay_period
));
// Cannot vouch a recovery process that has not started
assert_noop!(
Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1),
Error::<Test>::NotStarted
);
// Initiate a recovery process
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
// Cannot vouch if you are not a friend
assert_noop!(
Recovery::vouch_recovery(RuntimeOrigin::signed(22), 5, 1),
Error::<Test>::NotFriend
);
// Cannot vouch twice
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1));
assert_noop!(
Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1),
Error::<Test>::AlreadyVouched
);
});
}
#[test]
fn vouch_recovery_works() {
new_test_ext().execute_with(|| {
// Create and initiate a recovery process for the test
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends.clone(),
threshold,
delay_period
));
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
// Vouching works
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1));
// Handles out of order vouches
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(4), 5, 1));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(3), 5, 1));
// Final recovery status object is updated correctly
let recovery_status =
ActiveRecovery { created: 0, deposit: 10, friends: bounded_vec![2, 3, 4] };
assert_eq!(<ActiveRecoveries<Test>>::get(&5, &1), Some(recovery_status));
});
}
#[test]
fn claim_recovery_handles_basic_errors() {
new_test_ext().execute_with(|| {
// Cannot claim a non-recoverable account
assert_noop!(
Recovery::claim_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::NotRecoverable
);
// Create a recovery process for the test
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends.clone(),
threshold,
delay_period
));
// Cannot claim an account which has not started the recovery process
assert_noop!(
Recovery::claim_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::NotStarted
);
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
// Cannot claim an account which has not passed the delay period
assert_noop!(
Recovery::claim_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::DelayPeriod
);
run_to_block(11);
// Cannot claim an account which has not passed the threshold number of votes
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(3), 5, 1));
// Only 2/3 is not good enough
assert_noop!(
Recovery::claim_recovery(RuntimeOrigin::signed(1), 5),
Error::<Test>::Threshold
);
});
}
#[test]
fn claim_recovery_works() {
new_test_ext().execute_with(|| {
// Create, initiate, and vouch recovery process for the test
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends.clone(),
threshold,
delay_period
));
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 1));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(3), 5, 1));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(4), 5, 1));
run_to_block(11);
// Account can be recovered.
assert_ok!(Recovery::claim_recovery(RuntimeOrigin::signed(1), 5));
// Recovered storage item is correctly created
assert_eq!(<Proxy<Test>>::get(&1), Some(5));
// Account could be re-recovered in the case that the recoverer account also gets lost.
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(4), 5));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(2), 5, 4));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(3), 5, 4));
assert_ok!(Recovery::vouch_recovery(RuntimeOrigin::signed(4), 5, 4));
run_to_block(21);
// Account is re-recovered.
assert_ok!(Recovery::claim_recovery(RuntimeOrigin::signed(4), 5));
// Recovered storage item is correctly updated
assert_eq!(<Proxy<Test>>::get(&4), Some(5));
});
}
#[test]
fn close_recovery_handles_basic_errors() {
new_test_ext().execute_with(|| {
// Cannot close a non-active recovery
assert_noop!(
Recovery::close_recovery(RuntimeOrigin::signed(5), 1),
Error::<Test>::NotStarted
);
});
}
#[test]
fn remove_recovery_works() {
new_test_ext().execute_with(|| {
// Cannot remove an unrecoverable account
assert_noop!(
Recovery::remove_recovery(RuntimeOrigin::signed(5)),
Error::<Test>::NotRecoverable
);
// Create and initiate a recovery process for the test
let friends = vec![2, 3, 4];
let threshold = 3;
let delay_period = 10;
assert_ok!(Recovery::create_recovery(
RuntimeOrigin::signed(5),
friends.clone(),
threshold,
delay_period
));
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(1), 5));
assert_ok!(Recovery::initiate_recovery(RuntimeOrigin::signed(2), 5));
// Cannot remove a recovery when there are active recoveries.
assert_noop!(
Recovery::remove_recovery(RuntimeOrigin::signed(5)),
Error::<Test>::StillActive
);
assert_ok!(Recovery::close_recovery(RuntimeOrigin::signed(5), 1));
// Still need to remove one more!
assert_noop!(
Recovery::remove_recovery(RuntimeOrigin::signed(5)),
Error::<Test>::StillActive
);
assert_ok!(Recovery::close_recovery(RuntimeOrigin::signed(5), 2));
// Finally removed
assert_ok!(Recovery::remove_recovery(RuntimeOrigin::signed(5)));
});
}