XVM MVP v2 (#92)

* XVM interface refactoring * Switch precompiles & chain-extension to XVMv2 * XVM gas handling prototype (#94) * Init commit * Small fixes * Chain extension & precompile modifications * TODO handling * Traces, improved gas tracking, fixed issues * Doc to placeholder weight * Doc & typos * Change base * Fix UT * Update TODOs, cleanup * Fix contract issues * Remove chain-extension-trait package (#109) * Remove chain-extension-trait package * Dapps Staking CE optimizations * Dapps Staking CE optimizations * Rename dapps-staking CE in general way * Derive Default for chain extension structs * Implement Default trait for CEs * Fix typo * XVM types cargo deps fix * Build fixes * Compilation fixes * Fix formatting * Fix formatting * Fix compilation issues * Fix cargo fmt * Fix clippy errors * Fix weight estimation
AstarNetwork · Nov 8, 2022 · 772d63c · 772d63c
1 parent 677ba53
commit 772d63c
Show file tree

Hide file tree

Showing 28 changed files with 391 additions and 358 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,7 +19,4 @@ members = [
 	"precompiles/utils",
 	"precompiles/xcm",
 	"precompiles/xvm",
-
-	# Disabled due to incorrect nightly channel usage
-	# "contracts/*",
 ]
diff --git a/chain-extensions/types/xvm/Cargo.toml b/chain-extensions/types/xvm/Cargo.toml
@@ -10,19 +10,15 @@ description = "Types definitions for contracts using xvm chain-extension."
 
 [dependencies]
 codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false }
-frame-support = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.30", default-features = false }
 scale-info = { version = "2.1.0", default-features = false, features = ["derive"] }
-sp-core = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.30", default-features = false }
 sp-runtime = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.30", default-features = false }
 sp-std = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.30", default-features = false }
 
 [features]
 default = ["std"]
 std = [
 	"codec/std",
-	"frame-support/std",
 	"scale-info/std",
-	"sp-core/std",
 	"sp-runtime/std",
 	"sp-std/std",
 ]
diff --git a/chain-extensions/types/xvm/src/lib.rs b/chain-extensions/types/xvm/src/lib.rs
@@ -1,7 +1,8 @@
 #![cfg_attr(not(feature = "std"), no_std)]
+
 use codec::{Decode, Encode};
 use sp_runtime::{DispatchError, ModuleError};
-use sp_std::vec::Vec; // TODO use ink_prelude::vec::Vec; ?
+use sp_std::vec::Vec;
 
 #[cfg_attr(feature = "std", derive(scale_info::TypeInfo))]
 #[derive(PartialEq, Eq, Copy, Clone, Encode, Decode, Debug)]
@@ -35,8 +36,6 @@ pub struct XvmCallArgs {
     pub to: Vec<u8>,
     /// Encoded call params
     pub input: Vec<u8>,
-    /// Metadata for the encoded params
-    pub metadata: Vec<u8>,
 }
 
 pub const FRONTIER_VM_ID: u8 = 0x0F;

diff --git a/chain-extensions/xvm/src/lib.rs b/chain-extensions/xvm/src/lib.rs
@@ -1,6 +1,5 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 
-use frame_support::weights::Weight;
 use frame_system::RawOrigin;
 use pallet_contracts::chain_extension::{
     ChainExtension, Environment, Ext, InitState, RetVal, SysConfig, UncheckedFrom,
@@ -52,27 +51,19 @@ where
 
         match func_id {
             XvmFuncId::XvmCall => {
-                // TODO: correct weight calculation directly from pallet!
-                let weight = Weight::from_ref_time(1_000_000_000);
-                env.charge_weight(weight)?;
+                // We need to immediately charge for the worst case scenario. Gas equals Weight in pallet-contracts context.
+                let remaining_weight = env.ext().gas_meter().gas_left();
+                let charged_weight = env.charge_weight(remaining_weight)?;
 
-                // Prepare parameters
                 let caller = env.ext().caller().clone();
 
-                let XvmCallArgs {
-                    vm_id,
-                    to,
-                    input,
-                    metadata,
-                } = env.read_as_unbounded(env.in_len())?;
+                let XvmCallArgs { vm_id, to, input } = env.read_as_unbounded(env.in_len())?;
 
-                // TODO: rethink this? How do we get valid env in chain extension? Need to know which data to encode.
-                // gas limit, taking into account used gas so far?
                 let _origin_address = env.ext().address().clone();
                 let _value = env.ext().value_transferred();
-                let _gas_limit = env.ext().gas_meter().gas_left();
                 let xvm_context = XvmContext {
-                    id: T::VmId::from(vm_id),
+                    id: vm_id,
+                    max_weight: remaining_weight,
                     env: None,
                 };
 
@@ -81,12 +72,16 @@ where
                     xvm_context,
                     to,
                     input,
-                    metadata,
                 );
 
-                // TODO: We need to know how much of gas was spent in the other call and update the gas meter!
-                // let consumed_xvm_weight = ...;
-                // env.charge_weight(consumed_xvm_weight)?;
+                // Adjust the actual weight used by the call if needed.
+                let actual_weight = match call_result {
+                    Ok(e) => e.actual_weight,
+                    Err(e) => e.post_info.actual_weight,
+                };
+                if let Some(actual_weight) = actual_weight {
+                    env.adjust_weight(charged_weight, actual_weight);
+                }
 
                 return match call_result {
                     Err(e) => {

diff --git a/contracts/xvm/Cargo.toml b/contracts/xvm/Cargo.toml
diff --git a/contracts/xvm/src/lib.rs b/contracts/xvm/src/lib.rs
diff --git a/frame/collator-selection/src/tests.rs b/frame/collator-selection/src/tests.rs
@@ -117,7 +117,9 @@ fn cannot_register_candidate_if_too_many() {
 
         // reset desired candidates:
         <crate::DesiredCandidates<Test>>::put(1);
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(4)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(4)
+        ));
 
         // but no more
         assert_noop!(
@@ -132,7 +134,9 @@ fn cannot_unregister_candidate_if_too_few() {
     new_test_ext().execute_with(|| {
         // reset desired candidates:
         <crate::DesiredCandidates<Test>>::put(1);
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(4)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(4)
+        ));
 
         // can not remove too few
         assert_noop!(
@@ -170,7 +174,9 @@ fn cannot_register_as_candidate_if_keys_not_registered() {
 fn cannot_register_dupe_candidate() {
     new_test_ext().execute_with(|| {
         // can add 3 as candidate
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(3)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(3)
+        ));
         let addition = CandidateInfo {
             who: 3,
             deposit: 10,
@@ -194,7 +200,9 @@ fn cannot_register_as_candidate_if_poor() {
         assert_eq!(Balances::free_balance(&33), 0);
 
         // works
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(3)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(3)
+        ));
 
         // poor
         assert_noop!(
@@ -217,8 +225,12 @@ fn register_as_candidate_works() {
         assert_eq!(Balances::free_balance(&3), 100);
         assert_eq!(Balances::free_balance(&4), 100);
 
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(3)));
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(4)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(3)
+        ));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(4)
+        ));
 
         assert_eq!(Balances::free_balance(&3), 90);
         assert_eq!(Balances::free_balance(&4), 90);
@@ -231,11 +243,15 @@ fn register_as_candidate_works() {
 fn leave_intent() {
     new_test_ext().execute_with(|| {
         // register a candidate.
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(3)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(3)
+        ));
         assert_eq!(Balances::free_balance(3), 90);
 
         // register too so can leave above min candidates
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(5)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(5)
+        ));
         assert_eq!(Balances::free_balance(5), 90);
 
         // cannot leave if not candidate.
@@ -259,7 +275,9 @@ fn authorship_event_handler() {
 
         // 4 is the default author.
         assert_eq!(Balances::free_balance(4), 100);
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(4)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(4)
+        ));
         // triggers `note_author`
         Authorship::on_initialize(1);
 
@@ -287,7 +305,9 @@ fn fees_edgecases() {
         Balances::make_free_balance_be(&CollatorSelection::account_id(), 5);
         // 4 is the default author.
         assert_eq!(Balances::free_balance(4), 100);
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(4)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(4)
+        ));
         // triggers `note_author`
         Authorship::on_initialize(1);
 
@@ -319,7 +339,9 @@ fn session_management_works() {
         assert_eq!(SessionHandlerCollators::get(), vec![1, 2]);
 
         // add a new collator
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(3)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(3)
+        ));
 
         // session won't see this.
         assert_eq!(SessionHandlerCollators::get(), vec![1, 2]);
@@ -348,8 +370,12 @@ fn kick_and_slash_mechanism() {
         // Define slash destination account
         <crate::SlashDestination<Test>>::put(5);
         // add a new collator
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(3)));
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(4)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(3)
+        ));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(4)
+        ));
         initialize_to_block(10);
         assert_eq!(CollatorSelection::candidates().len(), 2);
         initialize_to_block(20);
@@ -377,8 +403,12 @@ fn kick_and_slash_mechanism() {
 fn should_not_kick_mechanism_too_few() {
     new_test_ext().execute_with(|| {
         // add a new collator
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(3)));
-        assert_ok!(CollatorSelection::register_as_candidate(RuntimeOrigin::signed(5)));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(3)
+        ));
+        assert_ok!(CollatorSelection::register_as_candidate(
+            RuntimeOrigin::signed(5)
+        ));
         initialize_to_block(10);
         assert_eq!(CollatorSelection::candidates().len(), 2);
         initialize_to_block(20);