feat(benchmarks): add benchmarks and specific weights to all pallets

node/Cargo.toml

@@ -17,6 +17,7 @@ version = '3.0.0'
 git = 'https://github.com/paritytech/substrate.git'
 branch = 'rococo-v1'
 version = '3.0.0'
+optional = true
 
 [dependencies.parachain-runtime]
 path = '../runtime'
@@ -217,6 +218,7 @@ targets = ['x86_64-unknown-linux-gnu']
 [features]
 default = []
 runtime-benchmarks = [
+  'frame-benchmarking-cli',
   'parachain-runtime/runtime-benchmarks',
   'polkadot-service/runtime-benchmarks'
 ]

node/src/cli.rs

@@ -36,6 +36,11 @@ pub enum Subcommand {
 
     /// Revert the chain to a previous state.
     Revert(sc_cli::RevertCmd),
+
+    #[cfg(feature = "runtime-benchmarks")]
+    /// The custom benchmark subcommmand benchmarking runtime pallets.
+    #[structopt(name = "benchmark", about = "Benchmark runtime pallets.")]
+    Benchmark(frame_benchmarking_cli::BenchmarkCmd),
 }
 
 /// Command for exporting the genesis state of the parachain

node/src/command.rs

@@ -30,11 +30,12 @@ fn load_spec(
     para_id: ParaId,
 ) -> std::result::Result<Box<dyn sc_service::ChainSpec>, String> {
     Ok(match id {
-        "pint-dev" => Box::new(chain_spec::pint_development_config(para_id)),
         "pint-local" => Box::new(chain_spec::pint_local_config(para_id)),
-        path => Box::new(chain_spec::ChainSpec::from_json_file(
-            std::path::PathBuf::from(path),
-        )?),
+        "pint-dev" => Box::new(chain_spec::pint_development_config(para_id)),
+        path => Box::new(
+            chain_spec::ChainSpec::from_json_file(std::path::PathBuf::from(path))
+                .unwrap_or(chain_spec::pint_development_config(para_id)),
+        ),
     })
 }
 
@@ -258,6 +259,18 @@ pub fn run() -> Result<()> {
 
             Ok(())
         }
+        #[cfg(feature = "runtime-benchmarks")]
+        Some(Subcommand::Benchmark(params)) => {
+            if cfg!(feature = "runtime-benchmarks") {
+                let runner = cli.create_runner(params)?;
+
+                runner.sync_run(|config| params.run::<Block, crate::service::Executor>(config))
+            } else {
+                Err("Benchmarking wasn't enabled when building the node. \
+                     You can enable it with `--features runtime-benchmarks`."
+                    .into())
+            }
+        }
         None => {
             let runner = cli.create_runner(&*cli.run)?;
 

node/src/service.rs

@@ -24,6 +24,7 @@ native_executor_instance!(
     pub Executor,
     parachain_runtime::api::dispatch,
     parachain_runtime::native_version,
+    frame_benchmarking::benchmarking::HostFunctions,
 );
 
 /// Starts a `ServiceBuilder` for a full service.

pallets/asset-depository/Cargo.toml

@@ -15,6 +15,12 @@ std = [
     'frame-support/std',
     'frame-system/std',
 ]
+runtime-benchmarks = [
+    'frame-benchmarking',
+    'frame-support/runtime-benchmarks',
+    'frame-system/runtime-benchmarks',
+]
+
 [dependencies.codec]
 default-features = false
 features = ['derive']
@@ -33,6 +39,13 @@ git = 'https://github.com/paritytech/substrate.git'
 branch = 'rococo-v1'
 version = '3.0.0'
 
+[dependencies.frame-benchmarking]
+default-features = false
+git = 'https://github.com/paritytech/substrate.git'
+branch = 'rococo-v1'
+version = '3.0.0'
+optional = true
+
 [dev-dependencies]
 serde = { version = "1.0.101" }
 

pallets/asset-depository/src/benchmarking.rs

@@ -0,0 +1,7 @@
+// Copyright 2021 ChainSafe Systems
+// SPDX-License-Identifier: LGPL-3.0-only
+//! Benchmarks
+//!
+//! TODO:
+//!
+//! This pallet contains no calls currently.

pallets/asset-index/Cargo.toml

@@ -21,6 +21,15 @@ std = [
     'xcm/std',
     'xcm-executor/std',
 ]
+runtime-benchmarks = [
+    'frame-benchmarking',
+    'frame-support/runtime-benchmarks',
+    'pallet-remote-asset-manager/runtime-benchmarks',
+    'pallet-asset-depository/runtime-benchmarks',
+    'pallet-price-feed/runtime-benchmarks',
+    'pallet-chainlink-feed/runtime-benchmarks',
+]
+
 [dependencies.codec]
 default-features = false
 features = ['derive']
@@ -45,6 +54,18 @@ git = 'https://github.com/paritytech/substrate.git'
 branch = 'rococo-v1'
 version = '3.0.0'
 
+[dependencies.frame-benchmarking]
+default-features = false
+git = 'https://github.com/paritytech/substrate'
+branch = 'rococo-v1'
+optional = true
+
+[dependencies.pallet-chainlink-feed]
+default_features = false
+package = 'pallet-chainlink-feed'
+git = "https://github.com/ChainSafe/chainlink-polkadot"
+optional = true
+
 [dependencies.xcm]
 git = "https://github.com/paritytech/polkadot"
 branch = 'rococo-v1'

pallets/asset-index/src/benchmarking.rs

@@ -0,0 +1,31 @@
+// Copyright 2021 ChainSafe Systems
+// SPDX-License-Identifier: LGPL-3.0-only
+use super::*;
+use crate::types::{AssetAvailability, IndexAssetData};
+use frame_benchmarking::{benchmarks, whitelisted_caller};
+use frame_support::traits::Currency;
+use frame_system::RawOrigin;
+use xcm::v0::MultiLocation;
+
+benchmarks! {
+    add_asset {
+        let asset_id = 42.into();
+        let caller: T::AccountId = whitelisted_caller();
+        let million = 1_000_000u32.into();
+        T::IndexToken::deposit_creating(&caller, million);
+    }: _(
+        RawOrigin::Signed(caller.clone()),
+        asset_id,
+        million,
+        AssetAvailability::Liquid(MultiLocation::Null),
+        million
+    ) verify {
+        assert_eq!(
+            <Holdings<T>>::get(asset_id),
+            Some(IndexAssetData::new(
+                million,
+                AssetAvailability::Liquid(MultiLocation::Null)
+            ))
+        );
+    }
+}

pallets/asset-index/src/lib.rs

@@ -15,6 +15,8 @@ mod mock;
 #[cfg(test)]
 mod tests;
 
+#[cfg(feature = "runtime-benchmarks")]
+mod benchmarking;
 pub mod traits;
 mod types;
 
@@ -87,7 +89,7 @@ pub mod pallet {
             Self::Balance,
         >;
         /// Type used to identify assets
-        type AssetId: Parameter + Member;
+        type AssetId: Parameter + Member + From<u32> + Copy;
         /// Handles asset depositing and withdrawing from sovereign user accounts
         type MultiAssetDepository: MultiAssetDepository<
             Self::AssetId,
@@ -102,6 +104,9 @@ pub mod pallet {
         #[pallet::constant]
         type TreasuryPalletId: Get<PalletId>;
         type Event: From<Event<Self>> + IsType<<Self as frame_system::Config>::Event>;
+
+        /// The weight for this pallet's extrinsics.
+        type WeightInfo: WeightInfo;
     }
 
     #[pallet::pallet]
@@ -159,7 +164,7 @@ pub mod pallet {
 
     #[pallet::call]
     impl<T: Config> Pallet<T> {
-        #[pallet::weight(10_000)] // TODO: Set weights
+        #[pallet::weight(T::WeightInfo::add_asset())]
         /// Callable by an admin to add new assets to the index and mint some IndexToken
         /// Caller balance is updated to allocate the correct amount of the IndexToken
         /// Creates IndexAssetData if it doesn’t exist, otherwise adds to list of deposits
@@ -472,4 +477,16 @@ pub mod pallet {
                 .unwrap_or_default()
         }
     }
+
+    /// Trait for the asset-index pallet extrinsic weights.
+    pub trait WeightInfo {
+        fn add_asset() -> Weight;
+    }
+
+    /// For backwards compatibility and tests
+    impl WeightInfo for () {
+        fn add_asset() -> Weight {
+            Default::default()
+        }
+    }
 }

pallets/asset-index/src/mock.rs

@@ -140,6 +140,7 @@ impl pallet_asset_index::Config for Test {
     type PriceFeed = MockPriceFeed;
     type TreasuryPalletId = TreasuryPalletId;
     type WithdrawalFee = ();
+    type WeightInfo = ();
 }
 
 pub struct MockRemoteAssetManager;

pallets/committee/Cargo.toml

@@ -17,8 +17,12 @@ std = [
     'frame-system/std',
     'sp-runtime/std',
 ]
-# this feature is only for compilation now
-runtime-benchmarks = []
+runtime-benchmarks = [
+    'frame-benchmarking',
+    'frame-support/runtime-benchmarks',
+    'frame-system/runtime-benchmarks',
+    'sp-runtime/runtime-benchmarks',
+]
 
 [dependencies.codec]
 default-features = false
@@ -38,6 +42,13 @@ git = 'https://github.com/paritytech/substrate.git'
 branch = 'rococo-v1'
 version = '3.0.0'
 
+[dependencies.frame-benchmarking]
+default-features = false
+git = 'https://github.com/paritytech/substrate.git'
+branch = 'rococo-v1'
+version = '3.0.0'
+optional = true
+
 [dependencies.sp-runtime]
 default-features = false
 git = 'https://github.com/paritytech/substrate.git'

pallets/committee/src/benchmarking.rs

@@ -0,0 +1,98 @@
+// Copyright 2021 ChainSafe Systems
+// SPDX-License-Identifier: LGPL-3.0-only
+use super::*;
+use frame_benchmarking::{account, benchmarks, vec, whitelisted_caller, Box};
+use frame_support::{assert_noop, assert_ok, traits::Get};
+use frame_system::{Call as SystemCall, Pallet as System, RawOrigin as SystemOrigin};
+
+fn submit_proposal<T: Config>(caller: T::AccountId) -> pallet::Proposal<T> {
+    let action: T::Action = <SystemCall<T>>::remark(vec![0; 0]).into();
+    let expected_nonce = pallet::ProposalCount::<T>::get();
+    assert_ok!(<Pallet<T>>::propose(
+        SystemOrigin::Signed(caller).into(),
+        Box::new(action.clone())
+    ));
+    pallet::Proposal::<T>::new(expected_nonce, action)
+}
+
+benchmarks! {
+    propose {
+        let caller: T::AccountId = whitelisted_caller();
+        let proposal = submit_proposal::<T>(caller.clone());
+    }: _(
+        SystemOrigin::Signed(caller.clone()),
+        Box::new(<SystemCall<T>>::remark(vec![0; 0]).into())
+    ) verify {
+        assert!(<Pallet<T>>::get_proposal(&proposal.hash()) == Some(proposal));
+    }
+
+    vote {
+        let caller: T::AccountId = whitelisted_caller();
+        let proposal = submit_proposal::<T>(caller.clone());
+        assert_ok!(<Pallet<T>>::add_constituent(SystemOrigin::Root.into(), caller.clone()));
+
+        // run to voting period
+        <System<T>>::set_block_number(
+            <System<T>>::block_number()
+                + <T as Config>::VotingPeriod::get()
+                + <T as Config>::ProposalSubmissionPeriod::get() + 1_u32.into(),
+        );
+    }: _(
+        SystemOrigin::Signed(caller.clone()),
+        proposal.hash(),
+        Vote::Abstain
+    ) verify {
+        assert_eq!(
+            <Pallet<T>>::get_votes_for(&proposal.hash()).unwrap().votes.len(),
+            1,
+        );
+    }
+
+    close {
+        let caller: T::AccountId = whitelisted_caller();
+        let proposal: pallet::Proposal<T> = submit_proposal::<T>(caller.clone());
+        assert_ok!(<Pallet<T>>::add_constituent(SystemOrigin::Root.into(), caller.clone()));
+        let voters = ["a", "b", "c", "d", "e"];
+
+        // run to voting period
+        <System<T>>::set_block_number(<System<T>>::block_number() + <T as Config>::VotingPeriod::get() + <T as Config>::ProposalSubmissionPeriod::get() + 1_u32.into());
+
+        // generate members
+        for i in &voters {
+            let voter: T::AccountId = account(i, 0, 0);
+            <Members<T>>::insert(voter.clone(), MemberType::Council);
+
+            // vote aye
+            assert_ok!(<Pallet<T>>::vote(
+                SystemOrigin::Signed(voter).into(),
+                proposal.hash(),
+                Vote::Aye,
+            ));
+        }
+
+        // run out of voting period
+        <System<T>>::set_block_number(
+            <System<T>>::block_number()
+                + <T as Config>::VotingPeriod::get() * 2_u32.into()
+                + <T as Config>::ProposalSubmissionPeriod::get()
+                + 1_u32.into()
+        );
+    }: _(
+        SystemOrigin::Signed(caller.clone()),
+        proposal.hash()
+    ) verify {
+        assert_noop!(
+            <Pallet<T>>::close(SystemOrigin::Signed(caller.clone()).into(), proposal.hash()),
+            <Error<T>>::ProposalAlreadyExecuted
+        );
+    }
+
+    add_constituent {
+        let constituent: T::AccountId = account("constituent", 0, 0);
+    }: _(
+        SystemOrigin::Root,
+        constituent.clone()
+    ) verify {
+        assert!(<pallet::Members<T>>::contains_key(constituent));
+    }
+}