Add tests for XVM precompile gas limit.

AstarNetwork · Aug 10, 2023 · be43e09 · be43e09
1 parent 5907746
commit be43e09
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/precompiles/utils/src/testing.rs b/precompiles/utils/src/testing.rs
@@ -303,6 +303,11 @@ impl<'p, P: PrecompileSet> PrecompilesTester<'p, P> {
         self
     }
 
+    pub fn with_gas_limit(mut self, gas_limit: u64) -> Self {
+        self.handle.gas_limit = gas_limit;
+        self
+    }
+
     pub fn expect_cost(mut self, cost: u64) -> Self {
         self.expected_cost = Some(cost);
         self

diff --git a/precompiles/xvm/Cargo.toml b/precompiles/xvm/Cargo.toml
@@ -8,6 +8,7 @@ homepage.workspace = true
 repository.workspace = true
 
 [dependencies]
+hex = { workspace = true }
 log = { workspace = true }
 num_enum = { workspace = true }
 precompile-utils = { workspace = true }

diff --git a/precompiles/xvm/src/mock.rs b/precompiles/xvm/src/mock.rs
@@ -38,6 +38,7 @@ use sp_runtime::{
     testing::Header,
     traits::{BlakeTwo256, IdentityLookup},
 };
+use sp_std::cell::RefCell;
 
 use astar_primitives::xvm::{CallError::*, CallErrorWithWeight, CallInfo, CallResult};
 
@@ -236,10 +237,29 @@ impl pallet_evm::Config for Runtime {
     type GasLimitPovSizeRatio = ConstU64<4>;
 }
 
+thread_local! {
+    static WEIGHT_LIMIT: RefCell<Weight> = RefCell::new(Weight::zero());
+}
+
+pub(crate) struct WeightLimitCalledWith;
+impl WeightLimitCalledWith {
+    pub(crate) fn get() -> Weight {
+        WEIGHT_LIMIT.with(|gas_limit| *gas_limit.borrow())
+    }
+
+    pub(crate) fn set(value: Weight) {
+        WEIGHT_LIMIT.with(|gas_limit| *gas_limit.borrow_mut() = value)
+    }
+
+    pub(crate) fn reset() {
+        Self::set(Weight::zero());
+    }
+}
+
 struct MockXvmWithArgsCheck;
 impl XvmCall<AccountId> for MockXvmWithArgsCheck {
     fn call(
-        _context: Context,
+        context: Context,
         vm_id: VmId,
         _source: AccountId,
         target: Vec<u8>,
@@ -267,6 +287,9 @@ impl XvmCall<AccountId> for MockXvmWithArgsCheck {
                 used_weight: Weight::zero()
             }
         );
+
+        WeightLimitCalledWith::set(context.weight_limit);
+
         Ok(CallInfo {
             output: vec![],
             used_weight: Weight::zero(),
@@ -297,6 +320,8 @@ impl ExtBuilder {
             .build_storage::<Runtime>()
             .expect("Frame system builds valid default genesis config");
 
+        WeightLimitCalledWith::reset();
+
         let mut ext = sp_io::TestExternalities::new(t);
         ext.execute_with(|| System::set_block_number(1));
         ext

diff --git a/precompiles/xvm/src/tests.rs b/precompiles/xvm/src/tests.rs
@@ -82,3 +82,54 @@ fn correct_arguments_works() {
             );
     })
 }
+
+#[test]
+fn weight_limit_is_min_of_remaining_and_user_limit() {
+    ExtBuilder::default().build().execute_with(|| {
+        // The caller didn't set a limit.
+        precompiles()
+            .prepare_test(
+                TestAccount::Alice,
+                PRECOMPILE_ADDRESS,
+                EvmDataWriter::new_with_selector(Action::XvmCall)
+                    .write(0x1Fu8)
+                    .write(Bytes(
+                        hex::decode("0000000000000000000000000000000000000000")
+                            .expect("invalid hex"),
+                    ))
+                    .write(Bytes(b"".to_vec()))
+                    .write(U256::one())
+                    .build(),
+            )
+            .expect_no_logs()
+            .execute_some();
+        assert_eq!(
+            WeightLimitCalledWith::get(),
+            <Runtime as pallet_evm::Config>::GasWeightMapping::gas_to_weight(u64::MAX, true)
+        );
+
+        // The caller set a limit.
+        let gas_limit = 1_000;
+        precompiles()
+            .prepare_test(
+                TestAccount::Alice,
+                PRECOMPILE_ADDRESS,
+                EvmDataWriter::new_with_selector(Action::XvmCall)
+                    .write(0x1Fu8)
+                    .write(Bytes(
+                        hex::decode("0000000000000000000000000000000000000000")
+                            .expect("invalid hex"),
+                    ))
+                    .write(Bytes(b"".to_vec()))
+                    .write(U256::one())
+                    .build(),
+            )
+            .with_gas_limit(gas_limit)
+            .expect_no_logs()
+            .execute_some();
+        assert_eq!(
+            WeightLimitCalledWith::get(),
+            <Runtime as pallet_evm::Config>::GasWeightMapping::gas_to_weight(gas_limit, true)
+        );
+    });
+}