Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

migrate asset-registry benchmark #2767

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 17 additions & 3 deletions modules/asset-registry/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,28 @@ primitives = { workspace = true }
xcm = { workspace = true }

module-support = { workspace = true }
module-evm = { workspace = true }
serde_json = { workspace = true }
hex = { workspace = true }
Comment on lines +20 to +22
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new benchmark requires importing the associated module as a dependency, which I’m not sure is what we want.

set_block_number_timestamp(1, 24000);
DexOracle::on_initialize(1)

the dex-oracle need to import the module-currencies, module-dex, pallet-aura, pallet-balances, pallet-timestamp, sp-consensus-aura, it feels too bulky

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we mock it?



# Benchmarks
frame-benchmarking = { workspace = true, optional = true }

[dev-dependencies]
serde_json = { workspace = true, features = ["std"] }
hex = { workspace = true, features = ["std"] }
sp-core = { workspace = true, features = ["std"] }
sp-io = { workspace = true, features = ["std"] }
pallet-balances = { workspace = true, features = ["std"] }
pallet-timestamp = { workspace = true, features = ["std"] }
xcm-builder = { workspace = true, features = ["std"] }

module-evm = { workspace = true, features = ["std"] }
module-evm-bridge = { workspace = true, features = ["std"] }

[features]
default = ["std"]
std = [
"hex/std",
"serde_json/std",
"log/std",
"parity-scale-codec/std",
"scale-info/std",
Expand All @@ -41,8 +48,15 @@ std = [
"frame-system/std",
"primitives/std",
"xcm/std",
"module-evm/std",
"module-support/std",
]
runtime-benchmarks = [
"frame-benchmarking/runtime-benchmarks",
"frame-support/runtime-benchmarks",
"frame-system/runtime-benchmarks",
"xcm-builder/runtime-benchmarks",
]
try-runtime = [
"frame-support/try-runtime",
"frame-system/try-runtime",
Expand Down
201 changes: 201 additions & 0 deletions modules/asset-registry/src/benchmarks.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
// This file is part of Acala.

// Copyright (C) 2020-2024 Acala Foundation.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program 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.

// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.

#![cfg(feature = "runtime-benchmarks")]

use crate::{
AssetIds, AssetMetadata, BalanceOf, Call, Config, CurrencyId, EvmAddress, Location, Pallet, Parachain,
VersionedLocation,
};
use frame_benchmarking::{benchmarks, impl_benchmark_test_suite, BenchmarkError};
use frame_support::{assert_ok, traits::Currency};
use frame_system::RawOrigin;
use module_support::AddressMapping;
use sp_runtime::traits::One;
use sp_std::{boxed::Box, str::FromStr, vec};

pub fn alice<T: Config + module_evm::Config>() -> T::AccountId {
<T as module_evm::Config>::AddressMapping::get_account_id(&alice_evm_addr())
}
pub fn alice_evm_addr() -> EvmAddress {
EvmAddress::from_str("1000000000000000000000000000000000000001").unwrap()
}

pub fn erc20_address() -> EvmAddress {
EvmAddress::from_str("0x5dddfce53ee040d9eb21afbc0ae1bb4dbb0ba643").unwrap()
}

pub fn dollar<T: Config>(amount: u32) -> BalanceOf<T> {
BalanceOf::<T>::one() * 1_000_000u32.into() * 1_000_000u32.into() * amount.into()
}

pub fn deploy_contract<T: Config + module_evm::Config>() {
<T as Config>::Currency::make_free_balance_be(&alice::<T>(), dollar::<T>(1000));

let json: serde_json::Value =
serde_json::from_str(include_str!("../../../ts-tests/build/Erc20DemoContract2.json")).unwrap();
let code = hex::decode(json.get("bytecode").unwrap().as_str().unwrap()).unwrap();

assert_ok!(module_evm::Pallet::<T>::create(
RawOrigin::Signed(alice::<T>()).into(),
code,
0,
2_100_000,
1_000_000,
vec![]
));
}

benchmarks! {
where_clause { where T: Config + module_evm::Config }
register_foreign_asset {
let location = VersionedLocation::V4(Location::new(
0,
[Parachain(1000)],
));
let asset_metadata = AssetMetadata {
name: b"Token Name".to_vec(),
symbol: b"TN".to_vec(),
decimals: 12,
minimal_balance: BalanceOf::<T>::one(),
};
let v3_location = xcm::v3::Location::try_from(location.clone()).map_err(|()| BenchmarkError::Weightless)?;
let foreign_asset_id = 0;
}: _(RawOrigin::Root, Box::new(location), Box::new(asset_metadata.clone()))
verify {
assert_eq!(Pallet::<T>::location_to_currency_ids(v3_location), Some(CurrencyId::ForeignAsset(foreign_asset_id)));
assert_eq!(Pallet::<T>::foreign_asset_locations(foreign_asset_id), Some(v3_location));
assert_eq!(Pallet::<T>::asset_metadatas(AssetIds::ForeignAssetId(foreign_asset_id)), Some(asset_metadata));
}

update_foreign_asset {
let location = VersionedLocation::V4(Location::new(
0,
[Parachain(1000)],
));
let asset_metadata = AssetMetadata {
name: b"Token Name".to_vec(),
symbol: b"TN".to_vec(),
decimals: 12,
minimal_balance: BalanceOf::<T>::one(),
};
let v3_location = xcm::v3::Location::try_from(location.clone()).map_err(|()| BenchmarkError::Weightless)?;
let foreign_asset_id = 0;

Pallet::<T>::register_foreign_asset(RawOrigin::Root.into(), Box::new(location.clone()), Box::new(asset_metadata.clone()))?;
}: _(RawOrigin::Root, 0, Box::new(location), Box::new(asset_metadata.clone()))
verify {
assert_eq!(Pallet::<T>::location_to_currency_ids(v3_location), Some(CurrencyId::ForeignAsset(foreign_asset_id)));
assert_eq!(Pallet::<T>::foreign_asset_locations(foreign_asset_id), Some(v3_location));
assert_eq!(Pallet::<T>::asset_metadatas(AssetIds::ForeignAssetId(foreign_asset_id)), Some(asset_metadata));
}

register_stable_asset {
let asset_metadata = AssetMetadata {
name: b"Token Name".to_vec(),
symbol: b"TN".to_vec(),
decimals: 12,
minimal_balance: BalanceOf::<T>::one(),
};
let stable_asset_id = 0;
}: _(RawOrigin::Root, Box::new(asset_metadata.clone()))
verify {
assert_eq!(Pallet::<T>::asset_metadatas(AssetIds::StableAssetId(stable_asset_id)), Some(asset_metadata));
}

update_stable_asset {
let asset_metadata = AssetMetadata {
name: b"Token Name".to_vec(),
symbol: b"TN".to_vec(),
decimals: 12,
minimal_balance: BalanceOf::<T>::one(),
};
let stable_asset_id = 0;

Pallet::<T>::register_stable_asset(RawOrigin::Root.into(), Box::new(asset_metadata.clone()))?;
}: _(RawOrigin::Root, 0, Box::new(asset_metadata.clone()))
verify {
assert_eq!(Pallet::<T>::asset_metadatas(AssetIds::StableAssetId(stable_asset_id)), Some(asset_metadata));
}

register_erc20_asset {
deploy_contract::<T>();
}: _(RawOrigin::Root, erc20_address(), BalanceOf::<T>::one())
verify {
assert!(Pallet::<T>::asset_metadatas(AssetIds::Erc20(erc20_address())).is_some());
}

update_erc20_asset {
let asset_metadata = AssetMetadata {
name: b"Token Name".to_vec(),
symbol: b"TN".to_vec(),
decimals: 12,
minimal_balance: BalanceOf::<T>::one(),
};

deploy_contract::<T>();
Pallet::<T>::register_erc20_asset(RawOrigin::Root.into(), erc20_address(), BalanceOf::<T>::one())?;
}: _(RawOrigin::Root, erc20_address(), Box::new(asset_metadata.clone()))
verify {
assert_eq!(Pallet::<T>::asset_metadatas(AssetIds::Erc20(erc20_address())), Some(asset_metadata));
}

register_native_asset {
let currency_id = CurrencyId::LiquidCrowdloan(0);
let asset_metadata = AssetMetadata {
name: b"Token Name".to_vec(),
symbol: b"TN".to_vec(),
decimals: 12,
minimal_balance: BalanceOf::<T>::one(),
};
}: _(RawOrigin::Root, currency_id, Box::new(asset_metadata.clone()))
verify {
assert_eq!(Pallet::<T>::asset_metadatas(AssetIds::NativeAssetId(currency_id)), Some(asset_metadata));
}

update_native_asset {
let currency_id = CurrencyId::LiquidCrowdloan(0);
let asset_metadata = AssetMetadata {
name: b"Token Name".to_vec(),
symbol: b"TN".to_vec(),
decimals: 12,
minimal_balance: BalanceOf::<T>::one(),
};

Pallet::<T>::register_native_asset(RawOrigin::Root.into(), currency_id, Box::new(asset_metadata.clone()))?;
}: _(RawOrigin::Root, currency_id, Box::new(asset_metadata.clone()))
verify {
assert_eq!(Pallet::<T>::asset_metadatas(AssetIds::NativeAssetId(currency_id)), Some(asset_metadata));
}
}

#[cfg(test)]
mod tests {
use crate::mock::Runtime;
use sp_io::TestExternalities;
use sp_runtime::BuildStorage;

pub fn new_test_ext() -> TestExternalities {
let t = frame_system::GenesisConfig::<Runtime>::default()
.build_storage()
.unwrap();
TestExternalities::new(t)
}
}

impl_benchmark_test_suite!(Pallet, crate::benchmarks::tests::new_test_ext(), crate::mock::Runtime);
2 changes: 2 additions & 0 deletions modules/asset-registry/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ use sp_std::{boxed::Box, vec::Vec};

use xcm::{v3, v4::prelude::*, VersionedLocation};

#[cfg(feature = "runtime-benchmarks")]
mod benchmarks;
mod mock;
mod tests;
mod weights;
Expand Down
7 changes: 3 additions & 4 deletions modules/asset-registry/src/mock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ use frame_support::{
assert_ok, construct_runtime, derive_impl, ord_parameter_types, parameter_types,
traits::{ConstU128, ConstU32, ConstU64},
};
use frame_system::EnsureSignedBy;
use frame_system::{EnsureRoot, EnsureSignedBy};
use module_support::{
mocks::{MockAddressMapping, TestRandomness},
AddressMapping,
Expand Down Expand Up @@ -73,7 +73,6 @@ parameter_types! {
}

ord_parameter_types! {
pub const CouncilAccount: AccountId = AccountId::from([1u8; 32]);
pub const TreasuryAccount: AccountId = AccountId::from([2u8; 32]);
pub const NetworkContractAccount: AccountId = AccountId::from([0u8; 32]);
pub const StorageDepositPerByte: u128 = convert_decimals_to_evm(10);
Expand All @@ -97,7 +96,7 @@ impl module_evm::Config for Runtime {
type DeveloperDeposit = ConstU128<1000>;
type PublicationFee = ConstU128<200>;
type TreasuryAccount = TreasuryAccount;
type FreePublicationOrigin = EnsureSignedBy<CouncilAccount, AccountId>;
type FreePublicationOrigin = EnsureRoot<AccountId>;

type Runner = module_evm::runner::stack::Runner<Self>;
type FindAuthor = ();
Expand All @@ -119,7 +118,7 @@ impl asset_registry::Config for Runtime {
type Currency = Balances;
type StakingCurrencyId = KSMCurrencyId;
type EVMBridge = module_evm_bridge::EVMBridge<Runtime>;
type RegisterOrigin = EnsureSignedBy<CouncilAccount, AccountId>;
type RegisterOrigin = EnsureRoot<AccountId>;
type WeightInfo = ();
}

Expand Down
Loading
Loading