Jg/13643 contracts migrate to fungible traits (#14020)

* contracts: refactor currency to use fungible traits

* contracts: refactor currency to use fungible traits

* contracts: add minor improvements

* contracts: max holds config set

* contracts: fix some typos

* contracts: map token errors

* fix typo

* contracts: add 0 balance transfer to test

* contracts: not transfer if value is zero

* contracts: [WIP] add StorageDepositHold

* contracts: add storage deposit held event

* contracts: clean up some code and comments

* contracts: add deposit storage released event

* contracts: update comment

* contracts: update slash cannot kill account test

* contracts: fix tests

* contracts: add some comments to the slashing test

* contracts: add some comments to the slashing test

* contracts: remove references to Currency

* contracts: do not transfer if from equals to

* bound BalanceOf<T>

* added FixedPointOperand to Balance trait

* move migrate sequence to config

* remove commented out code

* Update frame/contracts/src/lib.rs

Co-authored-by: PG Herveou <pgherveou@gmail.com>

* remove Migrations generic

* make runtime use noop migrations

* restrict is_upgrade_supported

* undo is_upgrade_supported change

* Update bin/node/runtime/src/lib.rs

Co-authored-by: PG Herveou <pgherveou@gmail.com>

* add rust doc example for `Migrations`

* feature gate NoopMigration

* fix example code

* improve example

* wip

* remove FixedPointOperand from trait

* trait bound BalanceOf

* more trait bound BalanceOf

* update to use RuntimeHoldReason

* replace Fungible for Currency

* update runtime

* WIP

* make v10 benchmark generic over currency

* solve merge conflicts

* make v12 migration benchmarking generic over DepositPerItem and DepositPerByte

* give some format

* fix tests and old migrations

* add migration v13 placholder

* wip

* wip

* add benchmarking

* add weights

* wip

* [pallet_collective] Enforce prime is a valid member of collective in set_members extrinsic (#14354)

* Updated set_members extrinsic to enforce prime is valid member of collective

* Added additional tests for set_members extrinsic

* applied the code review suggestions

* update to docify 0.2.0 / crate-relative embed paths (#14570)

* Fix Society v2 migration (#14421)

* fix society v2 migration

* Update frame/society/src/migrations.rs

* Update frame/society/src/migrations.rs

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

* Update frame/society/src/migrations.rs

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

* update for versioned upgrade

* fix society v2 migration

* remove references to members being sorted from commnets

* fix type

* fix can_migrate check

* add sanity log

* fix sanity check

* kick ci

* kick ci

* run tests with --experimental flag

* versioned migration cleanup

* revert pipeline change

* use defensive!

* semicolons

* defensive and doc comment

* address pr comment

* feature gate the versioned migration

* defensive_unwrap_or

* fix test

* fix doc comment

* change defensive to a log warning

* remove can_migrate anti-pattern

* Update frame/society/Cargo.toml

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

* add experimental feature warning to doc comment

* update doc comment

* bump ci

* kick ci

* kick ci

* kick ci

---------

Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Bastian Köcher <git@kchr.de>

* Moves `Block` to `frame_system` instead of `construct_runtime` and removes `Header` and `BlockNumber` (#14437)

* Initial setup

* Adds node block

* Uses UncheckedExtrinsic and removes Where section

* Updates frame_system to use Block

* Adds deprecation warning

* Fixes pallet-timestamp

* Removes Header and BlockNumber

* Addresses review comments

* Addresses review comments

* Adds comment about compiler bug

* Removes where clause

* Refactors code

* Fixes errors in cargo check

* Fixes errors in cargo check

* Fixes warnings in cargo check

* Formatting

* Fixes construct_runtime tests

* Uses import instead of full path for BlockNumber

* Uses import instead of full path for Header

* Formatting

* Fixes construct_runtime tests

* Fixes imports in benchmarks

* Formatting

* Fixes construct_runtime tests

* Formatting

* Minor updates

* Fixes construct_runtime ui tests

* Fixes construct_runtime ui tests with 1.70

* Fixes docs

* Fixes docs

* Adds u128 mock block type

* Fixes split example

* fixes for cumulus

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

* Updates new tests

* Fixes fully-qualified path in few places

* Formatting

* Update frame/examples/default-config/src/lib.rs

Co-authored-by: Juan <juangirini@gmail.com>

* Update frame/support/procedural/src/construct_runtime/mod.rs

Co-authored-by: Juan <juangirini@gmail.com>

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

* Addresses some review comments

* Fixes build

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

* Update frame/democracy/src/lib.rs

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Update frame/democracy/src/lib.rs

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Update frame/support/procedural/src/construct_runtime/mod.rs

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Update frame/support/procedural/src/construct_runtime/mod.rs

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>

* Addresses review comments

* Updates trait bounds

* Minor fix

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

* Removes unnecessary bound

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

* Updates test

* Fixes build

* Adds a bound for header

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

* Removes where block

* Minor fix

* Minor fix

* Fixes tests

* ".git/.scripts/commands/update-ui/update-ui.sh" 1.70

* Updates test

* Update primitives/runtime/src/traits.rs

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

* Update primitives/runtime/src/traits.rs

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

* Updates doc

* Updates doc

---------

Co-authored-by: command-bot <>
Co-authored-by: Juan <juangirini@gmail.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Bastian Köcher <git@kchr.de>

* Refactor the asset-conversion-tx-payment pallet (#14558)

* Code refactoring

* Fix imports

* Typo

* Update frame/asset-conversion/src/types.rs

Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>

* Sync docs

---------

Co-authored-by: parity-processbot <>
Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>

* wip

* wip

* wip

* improve try-runtime imports

* fix benchmark test

* improved rustdocs

* improved rustdocs

* remove log

* ignore variable

* reduce caller funding

* move v13 out

* update v13 migration

* v13 migration

* benchmark v13_migration

* fix broken compilation

* ".git/.scripts/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts

* remove all the `where BalanceOf`

* add Balance to Config

* improve docs

* add new deposit storage error

* remove todo message

* rename migration v13 pre rebase

* fix tests

* add missing migration;

* bump storage version

* apply review suggestions

* improved comment

* remove unnecessary code

* simplify migrations

* mock balance

* mock more for benchmarks

* fix benchmarking tests

* fix benchmarking tests with caller

* improve cargo toml

* solve nit

* Update frame/contracts/src/lib.rs

Co-authored-by: Alexander Theißen <alex.theissen@me.com>

* Update frame/contracts/src/exec.rs

Co-authored-by: Alexander Theißen <alex.theissen@me.com>

* Update frame/contracts/src/exec.rs

Co-authored-by: Alexander Theißen <alex.theissen@me.com>

* Update frame/contracts/src/storage/meter.rs

Co-authored-by: Alexander Theißen <alex.theissen@me.com>

* review improvements

* remove extra events

* update cargo

* undo update cargo

* review updates

* remove type Balance

* add extra fields to events

* fix zepter ci

---------

Co-authored-by: PG Herveou <pgherveou@gmail.com>
Co-authored-by: Toufeeq Pasha <47236805+ToufeeqP@users.noreply.github.com>
Co-authored-by: Sam Johnson <sam@durosoft.com>
Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Bastian Köcher <git@kchr.de>
Co-authored-by: gupnik <17176722+gupnik@users.noreply.github.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Jegor Sidorenko <5252494+jsidorenko@users.noreply.github.com>
Co-authored-by: joe petrowski <25483142+joepetrowski@users.noreply.github.com>
Co-authored-by: command-bot <>
Co-authored-by: Alexander Theißen <alex.theissen@me.com>
This commit is contained in:
Juan
2023-08-02 15:51:31 +02:00
committed by GitHub
parent 3fef703e30
commit fef9723d65
17 changed files with 797 additions and 371 deletions
+66 -40
View File
@@ -23,7 +23,7 @@ use crate::{
exec::AccountIdOf,
migration::{IsFinished, MigrationStep},
weights::WeightInfo,
BalanceOf, CodeHash, Config, Pallet, TrieId, Weight, LOG_TARGET,
CodeHash, Config, Pallet, TrieId, Weight, LOG_TARGET,
};
use codec::{Decode, Encode};
use core::cmp::{max, min};
@@ -32,9 +32,8 @@ use frame_support::{
pallet_prelude::*,
storage_alias,
traits::{
fungible::Inspect,
tokens::{Fortitude::Polite, Preservation::Preserve},
Currency, ExistenceRequirement, ReservableCurrency,
tokens::{fungible::Inspect, Fortitude::Polite, Preservation::Preserve},
ExistenceRequirement, ReservableCurrency,
},
DefaultNoBound,
};
@@ -47,29 +46,41 @@ use sp_std::{ops::Deref, prelude::*};
mod old {
use super::*;
pub type BalanceOf<T, OldCurrency> = <OldCurrency as frame_support::traits::Currency<
<T as frame_system::Config>::AccountId,
>>::Balance;
#[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo, MaxEncodedLen)]
#[scale_info(skip_type_params(T))]
pub struct ContractInfo<T: Config> {
#[scale_info(skip_type_params(T, OldCurrency))]
pub struct ContractInfo<T: Config, OldCurrency>
where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>,
{
pub trie_id: TrieId,
pub code_hash: CodeHash<T>,
pub storage_bytes: u32,
pub storage_items: u32,
pub storage_byte_deposit: BalanceOf<T>,
pub storage_item_deposit: BalanceOf<T>,
pub storage_base_deposit: BalanceOf<T>,
pub storage_byte_deposit: BalanceOf<T, OldCurrency>,
pub storage_item_deposit: BalanceOf<T, OldCurrency>,
pub storage_base_deposit: BalanceOf<T, OldCurrency>,
}
#[storage_alias]
pub type ContractInfoOf<T: Config> = StorageMap<
pub type ContractInfoOf<T: Config, OldCurrency> = StorageMap<
Pallet<T>,
Twox64Concat,
<T as frame_system::Config>::AccountId,
ContractInfo<T>,
ContractInfo<T, OldCurrency>,
>;
}
#[cfg(feature = "runtime-benchmarks")]
pub fn store_old_contract_info<T: Config>(account: T::AccountId, info: crate::ContractInfo<T>) {
pub fn store_old_contract_info<T: Config, OldCurrency>(
account: T::AccountId,
info: crate::ContractInfo<T>,
) where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId> + 'static,
{
let info = old::ContractInfo {
trie_id: info.trie_id,
code_hash: info.code_hash,
@@ -79,7 +90,7 @@ pub fn store_old_contract_info<T: Config>(account: T::AccountId, info: crate::Co
storage_item_deposit: Default::default(),
storage_base_deposit: Default::default(),
};
old::ContractInfoOf::<T>::insert(account, info);
old::ContractInfoOf::<T, OldCurrency>::insert(account, info);
}
#[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebugNoBound, TypeInfo, MaxEncodedLen)]
@@ -95,28 +106,40 @@ impl<T: Config> Deref for DepositAccount<T> {
}
#[derive(Encode, Decode, Clone, PartialEq, Eq, RuntimeDebug, TypeInfo, MaxEncodedLen)]
#[scale_info(skip_type_params(T))]
pub struct ContractInfo<T: Config> {
#[scale_info(skip_type_params(T, OldCurrency))]
pub struct ContractInfo<T: Config, OldCurrency>
where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>,
{
pub trie_id: TrieId,
deposit_account: DepositAccount<T>,
pub code_hash: CodeHash<T>,
storage_bytes: u32,
storage_items: u32,
pub storage_byte_deposit: BalanceOf<T>,
storage_item_deposit: BalanceOf<T>,
storage_base_deposit: BalanceOf<T>,
pub storage_byte_deposit: old::BalanceOf<T, OldCurrency>,
storage_item_deposit: old::BalanceOf<T, OldCurrency>,
storage_base_deposit: old::BalanceOf<T, OldCurrency>,
}
#[derive(Encode, Decode, MaxEncodedLen, DefaultNoBound)]
pub struct Migration<T: Config> {
pub struct Migration<T: Config, OldCurrency = ()> {
last_account: Option<T::AccountId>,
_phantom: PhantomData<(T, OldCurrency)>,
}
#[storage_alias]
type ContractInfoOf<T: Config> =
StorageMap<Pallet<T>, Twox64Concat, <T as frame_system::Config>::AccountId, ContractInfo<T>>;
type ContractInfoOf<T: Config, OldCurrency> = StorageMap<
Pallet<T>,
Twox64Concat,
<T as frame_system::Config>::AccountId,
ContractInfo<T, OldCurrency>,
>;
impl<T: Config> MigrationStep for Migration<T> {
impl<T: Config, OldCurrency: 'static> MigrationStep for Migration<T, OldCurrency>
where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>
+ Inspect<<T as frame_system::Config>::AccountId, Balance = old::BalanceOf<T, OldCurrency>>,
{
const VERSION: u16 = 10;
fn max_step_weight() -> Weight {
@@ -125,15 +148,17 @@ impl<T: Config> MigrationStep for Migration<T> {
fn step(&mut self) -> (IsFinished, Weight) {
let mut iter = if let Some(last_account) = self.last_account.take() {
old::ContractInfoOf::<T>::iter_from(old::ContractInfoOf::<T>::hashed_key_for(
last_account,
))
old::ContractInfoOf::<T, OldCurrency>::iter_from(
old::ContractInfoOf::<T, OldCurrency>::hashed_key_for(last_account),
)
} else {
old::ContractInfoOf::<T>::iter()
old::ContractInfoOf::<T, OldCurrency>::iter()
};
if let Some((account, contract)) = iter.next() {
let min_balance = Pallet::<T>::min_balance();
let min_balance = <OldCurrency as frame_support::traits::Currency<
<T as frame_system::Config>::AccountId,
>>::minimum_balance();
log::debug!(target: LOG_TARGET, "Account: 0x{} ", HexDisplay::from(&account.encode()));
// Get the new deposit account address
@@ -148,7 +173,7 @@ impl<T: Config> MigrationStep for Migration<T> {
// Unreserve the existing deposit
// Note we can't use repatriate_reserve, because it only works with existing accounts
let remaining = T::Currency::unreserve(&account, old_deposit);
let remaining = OldCurrency::unreserve(&account, old_deposit);
if !remaining.is_zero() {
log::warn!(
target: LOG_TARGET,
@@ -161,9 +186,9 @@ impl<T: Config> MigrationStep for Migration<T> {
// Attempt to transfer the old deposit to the deposit account.
let amount = old_deposit
.saturating_sub(min_balance)
.min(T::Currency::reducible_balance(&account, Preserve, Polite));
.min(OldCurrency::reducible_balance(&account, Preserve, Polite));
let new_deposit = T::Currency::transfer(
let new_deposit = OldCurrency::transfer(
&account,
&deposit_account,
amount,
@@ -184,7 +209,7 @@ impl<T: Config> MigrationStep for Migration<T> {
"Failed to transfer the base deposit, reason: {:?}",
err
);
T::Currency::deposit_creating(&deposit_account, min_balance);
OldCurrency::deposit_creating(&deposit_account, min_balance);
min_balance
});
@@ -224,7 +249,7 @@ impl<T: Config> MigrationStep for Migration<T> {
storage_base_deposit,
};
ContractInfoOf::<T>::insert(&account, new_contract_info);
ContractInfoOf::<T, OldCurrency>::insert(&account, new_contract_info);
// Store last key for next migration step
self.last_account = Some(account);
@@ -238,7 +263,7 @@ impl<T: Config> MigrationStep for Migration<T> {
#[cfg(feature = "try-runtime")]
fn pre_upgrade_step() -> Result<Vec<u8>, TryRuntimeError> {
let sample: Vec<_> = old::ContractInfoOf::<T>::iter().take(10).collect();
let sample: Vec<_> = old::ContractInfoOf::<T, OldCurrency>::iter().take(10).collect();
log::debug!(target: LOG_TARGET, "Taking sample of {} contracts", sample.len());
Ok(sample.encode())
@@ -246,23 +271,24 @@ impl<T: Config> MigrationStep for Migration<T> {
#[cfg(feature = "try-runtime")]
fn post_upgrade_step(state: Vec<u8>) -> Result<(), TryRuntimeError> {
let sample = <Vec<(T::AccountId, old::ContractInfo<T>)> as Decode>::decode(&mut &state[..])
.expect("pre_upgrade_step provides a valid state; qed");
let sample = <Vec<(T::AccountId, old::ContractInfo<T, OldCurrency>)> as Decode>::decode(
&mut &state[..],
)
.expect("pre_upgrade_step provides a valid state; qed");
log::debug!(target: LOG_TARGET, "Validating sample of {} contracts", sample.len());
for (account, old_contract) in sample {
log::debug!(target: LOG_TARGET, "===");
log::debug!(target: LOG_TARGET, "Account: 0x{} ", HexDisplay::from(&account.encode()));
let contract = ContractInfoOf::<T>::get(&account).unwrap();
let contract = ContractInfoOf::<T, OldCurrency>::get(&account).unwrap();
ensure!(old_contract.trie_id == contract.trie_id, "invalid trie_id");
ensure!(old_contract.code_hash == contract.code_hash, "invalid code_hash");
ensure!(old_contract.storage_bytes == contract.storage_bytes, "invalid storage_bytes");
ensure!(old_contract.storage_items == contract.storage_items, "invalid storage_items");
let deposit =
<<T as Config>::Currency as frame_support::traits::Currency<_>>::total_balance(
&contract.deposit_account,
);
let deposit = <OldCurrency as frame_support::traits::Currency<_>>::total_balance(
&contract.deposit_account,
);
ensure!(
deposit ==
contract
+61 -31
View File
@@ -37,13 +37,20 @@ use sp_std::prelude::*;
mod old {
use super::*;
pub type BalanceOf<T, OldCurrency> = <OldCurrency as frame_support::traits::Currency<
<T as frame_system::Config>::AccountId,
>>::Balance;
#[derive(Encode, Decode, scale_info::TypeInfo, MaxEncodedLen)]
#[codec(mel_bound())]
#[scale_info(skip_type_params(T))]
pub struct OwnerInfo<T: Config> {
#[scale_info(skip_type_params(T, OldCurrency))]
pub struct OwnerInfo<T: Config, OldCurrency>
where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>,
{
pub owner: AccountIdOf<T>,
#[codec(compact)]
pub deposit: BalanceOf<T>,
pub deposit: BalanceOf<T, OldCurrency>,
#[codec(compact)]
pub refcount: u64,
}
@@ -63,7 +70,8 @@ mod old {
}
#[storage_alias]
pub type OwnerInfoOf<T: Config> = StorageMap<Pallet<T>, Identity, CodeHash<T>, OwnerInfo<T>>;
pub type OwnerInfoOf<T: Config, OldCurrency> =
StorageMap<Pallet<T>, Identity, CodeHash<T>, OwnerInfo<T, OldCurrency>>;
#[storage_alias]
pub type CodeStorage<T: Config> =
@@ -72,11 +80,14 @@ mod old {
#[derive(Encode, Decode, scale_info::TypeInfo, MaxEncodedLen)]
#[codec(mel_bound())]
#[scale_info(skip_type_params(T))]
pub struct CodeInfo<T: Config> {
#[scale_info(skip_type_params(T, OldCurrency))]
pub struct CodeInfo<T: Config, OldCurrency>
where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>,
{
owner: AccountIdOf<T>,
#[codec(compact)]
deposit: BalanceOf<T>,
deposit: old::BalanceOf<T, OldCurrency>,
#[codec(compact)]
refcount: u64,
determinism: Determinism,
@@ -84,13 +95,17 @@ pub struct CodeInfo<T: Config> {
}
#[storage_alias]
pub type CodeInfoOf<T: Config> = StorageMap<Pallet<T>, Twox64Concat, CodeHash<T>, CodeInfo<T>>;
pub type CodeInfoOf<T: Config, OldCurrency> =
StorageMap<Pallet<T>, Twox64Concat, CodeHash<T>, CodeInfo<T, OldCurrency>>;
#[storage_alias]
pub type PristineCode<T: Config> = StorageMap<Pallet<T>, Identity, CodeHash<T>, Vec<u8>>;
#[cfg(feature = "runtime-benchmarks")]
pub fn store_old_dummy_code<T: Config>(len: usize, account: T::AccountId) {
pub fn store_old_dummy_code<T: Config, OldCurrency>(len: usize, account: T::AccountId)
where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId> + 'static,
{
use sp_runtime::traits::Hash;
let code = vec![42u8; len];
@@ -107,15 +122,24 @@ pub fn store_old_dummy_code<T: Config>(len: usize, account: T::AccountId) {
old::CodeStorage::<T>::insert(hash, module);
let info = old::OwnerInfo { owner: account, deposit: u32::MAX.into(), refcount: u64::MAX };
old::OwnerInfoOf::<T>::insert(hash, info);
old::OwnerInfoOf::<T, OldCurrency>::insert(hash, info);
}
#[derive(Encode, Decode, MaxEncodedLen, DefaultNoBound)]
pub struct Migration<T: Config> {
pub struct Migration<T: Config, OldCurrency>
where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>,
OldCurrency::Balance: From<BalanceOf<T>>,
{
last_code_hash: Option<CodeHash<T>>,
_phantom: PhantomData<OldCurrency>,
}
impl<T: Config> MigrationStep for Migration<T> {
impl<T: Config, OldCurrency> MigrationStep for Migration<T, OldCurrency>
where
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId> + 'static,
OldCurrency::Balance: From<BalanceOf<T>>,
{
const VERSION: u16 = 12;
fn max_step_weight() -> Weight {
@@ -124,9 +148,11 @@ impl<T: Config> MigrationStep for Migration<T> {
fn step(&mut self) -> (IsFinished, Weight) {
let mut iter = if let Some(last_key) = self.last_code_hash.take() {
old::OwnerInfoOf::<T>::iter_from(old::OwnerInfoOf::<T>::hashed_key_for(last_key))
old::OwnerInfoOf::<T, OldCurrency>::iter_from(
old::OwnerInfoOf::<T, OldCurrency>::hashed_key_for(last_key),
)
} else {
old::OwnerInfoOf::<T>::iter()
old::OwnerInfoOf::<T, OldCurrency>::iter()
};
if let Some((hash, old_info)) = iter.next() {
log::debug!(target: LOG_TARGET, "Migrating OwnerInfo for code_hash {:?}", hash);
@@ -158,7 +184,8 @@ impl<T: Config> MigrationStep for Migration<T> {
let bytes_before = module
.encoded_size()
.saturating_add(code_len)
.saturating_add(old::OwnerInfo::<T>::max_encoded_len()) as u32;
.saturating_add(old::OwnerInfo::<T, OldCurrency>::max_encoded_len())
as u32;
let items_before = 3u32;
let deposit_expected_before = price_per_byte
.saturating_mul(bytes_before.into())
@@ -166,24 +193,25 @@ impl<T: Config> MigrationStep for Migration<T> {
let ratio = FixedU128::checked_from_rational(old_info.deposit, deposit_expected_before)
.unwrap_or_default()
.min(FixedU128::from_u32(1));
let bytes_after = code_len.saturating_add(CodeInfo::<T>::max_encoded_len()) as u32;
let bytes_after =
code_len.saturating_add(CodeInfo::<T, OldCurrency>::max_encoded_len()) as u32;
let items_after = 2u32;
let deposit_expected_after = price_per_byte
.saturating_mul(bytes_after.into())
.saturating_add(price_per_item.saturating_mul(items_after.into()));
let deposit = ratio.saturating_mul_int(deposit_expected_after);
let info = CodeInfo::<T> {
let info = CodeInfo::<T, OldCurrency> {
determinism: module.determinism,
owner: old_info.owner,
deposit,
deposit: deposit.into(),
refcount: old_info.refcount,
code_len: code_len as u32,
};
let amount = old_info.deposit.saturating_sub(info.deposit);
if !amount.is_zero() {
T::Currency::unreserve(&info.owner, amount);
OldCurrency::unreserve(&info.owner, amount);
log::debug!(
target: LOG_TARGET,
"Deposit refunded: {:?} Balance, to: {:?}",
@@ -198,7 +226,7 @@ impl<T: Config> MigrationStep for Migration<T> {
&old_info.deposit
);
}
CodeInfoOf::<T>::insert(hash, info);
CodeInfoOf::<T, OldCurrency>::insert(hash, info);
self.last_code_hash = Some(hash);
@@ -213,12 +241,12 @@ impl<T: Config> MigrationStep for Migration<T> {
fn pre_upgrade_step() -> Result<Vec<u8>, TryRuntimeError> {
let len = 100;
log::debug!(target: LOG_TARGET, "Taking sample of {} OwnerInfo(s)", len);
let sample: Vec<_> = old::OwnerInfoOf::<T>::iter()
let sample: Vec<_> = old::OwnerInfoOf::<T, OldCurrency>::iter()
.take(len)
.map(|(k, v)| {
let module = old::CodeStorage::<T>::get(k)
.expect("No PrefabWasmModule found for code_hash: {:?}");
let info: CodeInfo<T> = CodeInfo {
let info: CodeInfo<T, OldCurrency> = CodeInfo {
determinism: module.determinism,
deposit: v.deposit,
refcount: v.refcount,
@@ -231,22 +259,24 @@ impl<T: Config> MigrationStep for Migration<T> {
let storage: u32 =
old::CodeStorage::<T>::iter().map(|(_k, v)| v.encoded_size() as u32).sum();
let mut deposit: BalanceOf<T> = Default::default();
old::OwnerInfoOf::<T>::iter().for_each(|(_k, v)| deposit += v.deposit);
let mut deposit: old::BalanceOf<T, OldCurrency> = Default::default();
old::OwnerInfoOf::<T, OldCurrency>::iter().for_each(|(_k, v)| deposit += v.deposit);
Ok((sample, deposit, storage).encode())
}
#[cfg(feature = "try-runtime")]
fn post_upgrade_step(state: Vec<u8>) -> Result<(), TryRuntimeError> {
let state = <(Vec<(CodeHash<T>, CodeInfo<T>)>, BalanceOf<T>, u32) as Decode>::decode(
&mut &state[..],
)
let state = <(
Vec<(CodeHash<T>, CodeInfo<T, OldCurrency>)>,
old::BalanceOf<T, OldCurrency>,
u32,
) as Decode>::decode(&mut &state[..])
.unwrap();
log::debug!(target: LOG_TARGET, "Validating state of {} Codeinfo(s)", state.0.len());
for (hash, old) in state.0 {
let info = CodeInfoOf::<T>::get(&hash)
let info = CodeInfoOf::<T, OldCurrency>::get(&hash)
.expect(format!("CodeInfo for code_hash {:?} not found!", hash).as_str());
ensure!(info.determinism == old.determinism, "invalid determinism");
ensure!(info.owner == old.owner, "invalid owner");
@@ -262,7 +292,7 @@ impl<T: Config> MigrationStep for Migration<T> {
} else {
log::debug!(target: LOG_TARGET, "CodeStorage is empty.");
}
if let Some((k, _)) = old::OwnerInfoOf::<T>::iter().next() {
if let Some((k, _)) = old::OwnerInfoOf::<T, OldCurrency>::iter().next() {
log::warn!(
target: LOG_TARGET,
"OwnerInfoOf is still NOT empty, found code_hash: {:?}",
@@ -272,10 +302,10 @@ impl<T: Config> MigrationStep for Migration<T> {
log::debug!(target: LOG_TARGET, "OwnerInfoOf is empty.");
}
let mut deposit: BalanceOf<T> = Default::default();
let mut deposit: old::BalanceOf<T, OldCurrency> = Default::default();
let mut items = 0u32;
let mut storage_info = 0u32;
CodeInfoOf::<T>::iter().for_each(|(_k, v)| {
CodeInfoOf::<T, OldCurrency>::iter().for_each(|(_k, v)| {
deposit += v.deposit;
items += 1;
storage_info += v.encoded_size() as u32;
@@ -0,0 +1,269 @@
// 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.
//! Update the code owner balance, make the storage deposit reserved balance to be held instead.
use crate::{
exec::AccountIdOf,
migration::{IsFinished, MigrationStep},
weights::WeightInfo,
BalanceOf, CodeHash, Config, Determinism, HoldReason, Pallet, Weight, LOG_TARGET,
};
use codec::{Decode, Encode};
#[cfg(feature = "try-runtime")]
use environmental::Vec;
#[cfg(feature = "try-runtime")]
use frame_support::traits::fungible::{Inspect, InspectHold};
use frame_support::{
codec,
pallet_prelude::*,
storage_alias,
traits::{fungible::MutateHold, ReservableCurrency},
DefaultNoBound,
};
use sp_core::hexdisplay::HexDisplay;
#[cfg(feature = "try-runtime")]
use sp_runtime::TryRuntimeError;
use sp_runtime::{traits::Zero, Saturating};
#[cfg(feature = "try-runtime")]
use sp_std::collections::btree_map::BTreeMap;
mod old {
use super::*;
pub type BalanceOf<T, OldCurrency> = <OldCurrency as frame_support::traits::Currency<
<T as frame_system::Config>::AccountId,
>>::Balance;
#[derive(Encode, Decode, scale_info::TypeInfo, MaxEncodedLen)]
#[codec(mel_bound())]
#[scale_info(skip_type_params(T, OldCurrency))]
pub struct CodeInfo<T, OldCurrency>
where
T: Config,
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>,
{
pub owner: AccountIdOf<T>,
#[codec(compact)]
pub deposit: old::BalanceOf<T, OldCurrency>,
#[codec(compact)]
pub refcount: u64,
pub determinism: Determinism,
pub code_len: u32,
}
#[storage_alias]
pub type CodeInfoOf<T: Config, OldCurrency> =
StorageMap<Pallet<T>, Twox64Concat, CodeHash<T>, CodeInfo<T, OldCurrency>>;
}
#[cfg(feature = "runtime-benchmarks")]
pub fn store_dummy_code<T: Config, OldCurrency>(account: T::AccountId)
where
T: Config,
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId> + 'static,
{
use sp_runtime::traits::Hash;
use sp_std::vec;
let len = T::MaxCodeLen::get();
let code = vec![42u8; len as usize];
let hash = T::Hashing::hash(&code);
let info = old::CodeInfo {
owner: account,
deposit: 10_000u32.into(),
refcount: u64::MAX,
determinism: Determinism::Enforced,
code_len: len,
};
old::CodeInfoOf::<T, OldCurrency>::insert(hash, info);
}
#[cfg(feature = "try-runtime")]
#[derive(Encode, Decode)]
/// Accounts for the balance allocation of a code owner.
struct BalanceAllocation<T, OldCurrency>
where
T: Config,
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>,
{
/// Total reserved balance as storage deposit for the owner.
reserved: old::BalanceOf<T, OldCurrency>,
/// Total balance of the owner.
total: old::BalanceOf<T, OldCurrency>,
}
#[derive(Encode, Decode, MaxEncodedLen, DefaultNoBound)]
pub struct Migration<T, OldCurrency>
where
T: Config,
OldCurrency: ReservableCurrency<<T as frame_system::Config>::AccountId>,
{
last_code_hash: Option<CodeHash<T>>,
_phantom: PhantomData<(T, OldCurrency)>,
}
impl<T, OldCurrency> MigrationStep for Migration<T, OldCurrency>
where
T: Config,
OldCurrency: 'static + ReservableCurrency<<T as frame_system::Config>::AccountId>,
BalanceOf<T>: From<OldCurrency::Balance>,
{
const VERSION: u16 = 14;
fn max_step_weight() -> Weight {
T::WeightInfo::v14_migration_step()
}
fn step(&mut self) -> (IsFinished, Weight) {
let mut iter = if let Some(last_hash) = self.last_code_hash.take() {
old::CodeInfoOf::<T, OldCurrency>::iter_from(
old::CodeInfoOf::<T, OldCurrency>::hashed_key_for(last_hash),
)
} else {
old::CodeInfoOf::<T, OldCurrency>::iter()
};
if let Some((hash, code_info)) = iter.next() {
log::debug!(target: LOG_TARGET, "Migrating storage deposit for 0x{:?}", HexDisplay::from(&code_info.owner.encode()));
let remaining = OldCurrency::unreserve(&code_info.owner, code_info.deposit);
if remaining > Zero::zero() {
log::warn!(
target: LOG_TARGET,
"Code owner's account 0x{:?} for code {:?} has some non-unreservable deposit {:?} from a total of {:?} that will remain in reserved.",
HexDisplay::from(&code_info.owner.encode()),
hash,
remaining,
code_info.deposit
);
}
let unreserved = code_info.deposit.saturating_sub(remaining);
let amount = BalanceOf::<T>::from(unreserved);
log::debug!(
target: LOG_TARGET,
"Holding {:?} on the code owner's account 0x{:?} for code {:?}.",
amount,
HexDisplay::from(&code_info.owner.encode()),
hash,
);
T::Currency::hold(
&HoldReason::CodeUploadDepositReserve.into(),
&code_info.owner,
amount,
)
.unwrap_or_else(|err| {
log::error!(
target: LOG_TARGET,
"Failed to hold {:?} from the code owner's account 0x{:?} for code {:?}, reason: {:?}.",
amount,
HexDisplay::from(&code_info.owner.encode()),
hash,
err
);
});
self.last_code_hash = Some(hash);
(IsFinished::No, T::WeightInfo::v14_migration_step())
} else {
log::debug!(target: LOG_TARGET, "No more storage deposit to migrate");
(IsFinished::Yes, T::WeightInfo::v14_migration_step())
}
}
#[cfg(feature = "try-runtime")]
fn pre_upgrade_step() -> Result<Vec<u8>, TryRuntimeError> {
let info: Vec<_> = old::CodeInfoOf::<T, OldCurrency>::iter().collect();
let mut owner_balance_allocation =
BTreeMap::<AccountIdOf<T>, BalanceAllocation<T, OldCurrency>>::new();
// Calculates the balance allocation by accumulating the storage deposits of all codes owned
// by an owner.
for (_, code_info) in info {
owner_balance_allocation
.entry(code_info.owner.clone())
.and_modify(|alloc| {
alloc.reserved = alloc.reserved.saturating_add(code_info.deposit);
})
.or_insert(BalanceAllocation {
reserved: code_info.deposit,
total: OldCurrency::total_balance(&code_info.owner),
});
}
Ok(owner_balance_allocation.encode())
}
#[cfg(feature = "try-runtime")]
fn post_upgrade_step(state: Vec<u8>) -> Result<(), TryRuntimeError> {
let owner_balance_allocation =
<BTreeMap<AccountIdOf<T>, BalanceAllocation<T, OldCurrency>> as Decode>::decode(
&mut &state[..],
)
.expect("pre_upgrade_step provides a valid state; qed");
let mut total_held: BalanceOf<T> = Zero::zero();
let count = owner_balance_allocation.len();
for (owner, old_balance_allocation) in owner_balance_allocation {
let held =
T::Currency::balance_on_hold(&HoldReason::CodeUploadDepositReserve.into(), &owner);
log::debug!(
target: LOG_TARGET,
"Validating storage deposit for owner 0x{:?}, reserved: {:?}, held: {:?}",
HexDisplay::from(&owner.encode()),
old_balance_allocation.reserved,
held
);
ensure!(held == old_balance_allocation.reserved.into(), "Held amount mismatch");
log::debug!(
target: LOG_TARGET,
"Validating total balance for owner 0x{:?}, new: {:?}, old: {:?}",
HexDisplay::from(&owner.encode()),
T::Currency::total_balance(&owner),
old_balance_allocation.total
);
ensure!(
T::Currency::total_balance(&owner) ==
BalanceOf::<T>::decode(&mut &old_balance_allocation.total.encode()[..])
.unwrap(),
"Balance mismatch "
);
total_held += held;
}
log::info!(
target: LOG_TARGET,
"Code owners processed: {:?}.",
count
);
log::info!(
target: LOG_TARGET,
"Total held amount for storage deposit: {:?}",
total_held
);
Ok(())
}
}