Token claims

crates/pallet-token-claims/Cargo.toml

@@ -0,0 +1,41 @@
+[package]
+name = "pallet-token-claims"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+primitives-ethereum = { version = "0.1", path = "../primitives-ethereum", default-features = false }
+
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
+frame-benchmarking = { default-features = false, git = "https://github.com/humanode-network/substrate", branch = "master", optional = true }
+frame-support = { default-features = false, git = "https://github.com/humanode-network/substrate", branch = "master" }
+frame-system = { default-features = false, git = "https://github.com/humanode-network/substrate", branch = "master" }
+scale-info = { version = "2.1.1", default-features = false, features = ["derive"] }
+serde = { version = "1", optional = true }
+
+[dev-dependencies]
+pallet-pot = { version = "0.1", path = "../pallet-pot" }
+
+mockall = "0.11"
+once_cell = "1"
+pallet-balances = { git = "https://github.com/humanode-network/substrate", branch = "master" }
+serde_json = "1"
+sp-core = { git = "https://github.com/humanode-network/substrate", branch = "master" }
+sp-runtime = { git = "https://github.com/humanode-network/substrate", branch = "master" }
+
+[features]
+default = ["std"]
+runtime-benchmarks = [
+  "frame-benchmarking/runtime-benchmarks",
+  "frame-support/runtime-benchmarks",
+  "frame-system/runtime-benchmarks",
+]
+std = [
+  "codec/std",
+  "frame-benchmarking/std",
+  "frame-support/std",
+  "frame-system/std",
+  "primitives-ethereum/std",
+  "serde",
+]

crates/pallet-token-claims/src/benchmarking.rs

@@ -0,0 +1,109 @@
+//! The benchmarks for the pallet.
+
+use frame_benchmarking::benchmarks;
+use frame_system::RawOrigin;
+use primitives_ethereum::{EcdsaSignature, EthereumAddress};
+
+use crate::*;
+
+/// The benchmark interface into the environment.
+pub trait Interface: super::Config {
+    /// Obtain an Account ID.
+    ///
+    /// This is an account to claim the funds to.
+    fn account_id_to_claim_to() -> <Self as frame_system::Config>::AccountId;
+
+    /// Obtain an ethereum address.
+    ///
+    /// This is an ethereum account that is supposed to have a valid calim associated with it
+    /// in the runtime genesis.
+    fn ethereum_address() -> EthereumAddress;
+
+    /// Obtain an ECDSA signature that would fit the provided Account ID and the Ethereum address
+    /// under the associated runtime.
+    fn create_ecdsa_signature(
+        account_id: &<Self as frame_system::Config>::AccountId,
+        ethereum_address: &EthereumAddress,
+    ) -> EcdsaSignature;
+}
+
+benchmarks! {
+    where_clause {
+        where
+            T: Interface
+    }
+
+    claim {
+        let account_id = <T as Interface>::account_id_to_claim_to();
+        let ethereum_address = <T as  Interface>::ethereum_address();
+        let ethereum_signature = <T as  Interface>::create_ecdsa_signature(&account_id, &ethereum_address);
+
+        // We assume the genesis has the corresponding claim; crash the bench if it doesn't.
+        let claim_info = Claims::<T>::get(ethereum_address).unwrap();
+
+        let account_balance_before = <CurrencyOf<T>>::total_balance(&account_id);
+        let currency_total_issuance_before = <CurrencyOf<T>>::total_issuance();
+
+        #[cfg(test)]
+        let test_data = {
+            use crate::mock;
+
+            let mock_runtime_guard = mock::runtime_lock();
+
+            let recover_signer_ctx = mock::MockEthereumSignatureVerifier::recover_signer_context();
+            recover_signer_ctx.expect().times(1..).return_const(Some(ethereum_address));
+
+            let lock_under_vesting_ctx = mock::MockVestingInterface::lock_under_vesting_context();
+            lock_under_vesting_ctx.expect().times(1..).return_const(Ok(()));
+
+            (mock_runtime_guard, recover_signer_ctx, lock_under_vesting_ctx)
+        };
+
+        let origin = RawOrigin::Signed(account_id.clone());
+
+    }: _(origin, ethereum_address, ethereum_signature)
+    verify {
+        assert_eq!(Claims::<T>::get(ethereum_address), None);
+
+        let account_balance_after = <CurrencyOf<T>>::total_balance(&account_id);
+        assert_eq!(account_balance_after - account_balance_before, claim_info.balance);
+        assert_eq!(
+            currency_total_issuance_before,
+            <CurrencyOf<T>>::total_issuance(),
+        );
+
+        #[cfg(test)]
+        {
+            let (mock_runtime_guard, recover_signer_ctx, lock_under_vesting_ctx) = test_data;
+
+            recover_signer_ctx.checkpoint();
+            lock_under_vesting_ctx.checkpoint();
+
+            drop(mock_runtime_guard);
+        }
+    }
+
+    impl_benchmark_test_suite!(
+        Pallet,
+        crate::mock::new_test_ext(),
+        crate::mock::Test,
+    );
+}
+
+#[cfg(test)]
+impl Interface for crate::mock::Test {
+    fn account_id_to_claim_to() -> <Self as frame_system::Config>::AccountId {
+        42
+    }
+
+    fn ethereum_address() -> EthereumAddress {
+        mock::eth(mock::EthAddr::WithVesting)
+    }
+
+    fn create_ecdsa_signature(
+        _account_id: &<Self as frame_system::Config>::AccountId,
+        _ethereum_address: &EthereumAddress,
+    ) -> EcdsaSignature {
+        EcdsaSignature::default()
+    }
+}