Reduce gas/storage limits in nested calls #6890

rockbmb · 2024-12-13T17:45:04Z

Closes #6846 .

Also, a limit of 0 when determining a nested call's metering limit would mean it was free to use all of the callee's resources. Now, a limit of 0 means that the nested call will have an empty storage meter.

In particular, this commit removes the usage of `0` as unlimited metering in the following tests: - `nonce` - `last_frame_output_works_on_instantiate` - `instantiation_from_contract` - `immutable_data_set_works_only_once` - `immutable_data_set_errors_with_empty_data` - `immutable_data_access_checks_work`

xermicus

The basic idea of the 63/64 rule looks correct to me but there are many failing tests. I left some nits.

xermicus · 2024-12-18T07:39:17Z

substrate/frame/revive/src/gas.rs

-		.min(self.gas_left);
-		self.gas_left -= amount;
-		GasMeter::new(amount)
+		// The reduction to 63/64 is to emulate EIP-150


This should be a doc-comment

substrate/frame/revive/src/storage/meter.rs

xermicus · 2024-12-18T09:31:53Z

substrate/frame/revive/src/storage/meter.rs

 		debug_assert!(matches!(self.contract_state(), ContractState::Alive));
+
+		// Limit gas for nested call, per EIP-150.


This could go into the doc-comment (which is no no-longer correct I think)

This fixes, among other tests: * `tests::gas_consumed_is_linear_for_nested_calls` test * `tests::deposit_limit_in_nested_calls` * `tests::transient_storage_limit_in_call` * `tests::call_return_code` * `test::chain_extension_temp_storage_works` * `tests::origin_api_works` * `tests::read_only_call_works`

rockbmb · 2024-12-19T00:57:44Z

@xermicus the meters in frame::contracts::{gas, storage::meter} also need to reflect this, correct?

athei · 2024-12-19T09:12:35Z

Sorry if this wasn't clear: Only pallet_revive and its supporting crates should be changed. pallet_contracts should remain untouched. It does't receive any updates beyond critical bug fixes anymore. Can you roll back the changes there? Will have a deeper look then.

rockbmb · 2024-12-19T10:14:13Z

@athei frame/contracts changes have been reverted, thanks for explaining this.

Most of the previously failing tests were caused by the contract code of those tests using the now-removed '0 means "use all available gas"' semantic.

After fixing this, cargo test --package pallet-revive:0.1.0 --lib --all-features yields:

failures:
    benchmarking::benchmarks::bench_seal_instantiate
    tests::call_diverging_out_len_works
    tests::create1_with_value_works
    tests::delegate_call
    tests::deploy_and_call_other_contract
    tests::deposit_limit_in_nested_calls
    tests::deposit_limit_in_nested_instantiate
    tests::destroy_contract_and_transfer_funds
    tests::failed_deposit_charge_should_roll_back_call
    tests::gas_estimation_call_runtime
    tests::gas_estimation_for_subcalls
    tests::return_data_api_works
    tests::skip_transfer_works
    tests::storage_deposit_callee_works
    tests::test_debug::debugging_works

The contracts the above tests rely on have removed usages of 0 as "use all", so their failures are somewhere else.

rockbmb · 2024-12-19T10:29:52Z

/bot fmt

athei

Due to the changes here you can get rid of the fn enforce_subcall_limit() and enum Nested. They are no longer needed because we now always enforce the limit at the sub call boundry (calling fn enforce_limit unconditionally).

Apart from a few other comments it looks pretty much like what I expect. Thanks.

athei · 2024-12-19T10:18:06Z

substrate/frame/revive/src/gas.rs

+		let amt = amount.min(self.gas_left - self.gas_left / 64);
+		self.gas_left -= amt;


Please use amount and not amt. No need to introduce a less readable identifier when we can just shadow.

athei · 2024-12-19T10:21:10Z

substrate/frame/revive/src/gas.rs

+	#[test]
+	/// Previously, passing a `Weight` of 0 to `nested` would consume all of the meter's current gas.
+	///
+	/// Now, a `Weight` of 0 means no gas for the nested call.


Suggested change

#[test]

/// Previously, passing a `Weight` of 0 to `nested` would consume all of the meter's current gas.

///

/// Now, a `Weight` of 0 means no gas for the nested call.

/// Previously, passing a `Weight` of 0 to `nested` would consume all of the meter's current gas.

///

/// Now, a `Weight` of 0 means no gas for the nested call.

#[test]

athei · 2024-12-19T10:34:28Z

substrate/frame/contracts/src/benchmarking/mod.rs

Still some left over changes in the wrong pallet to roll back.

Thanks for pointing this out.

...us/parachains/integration-tests/emulated/tests/people/people-westend/src/tests/governance.rs

athei · 2024-12-19T10:37:33Z

substrate/frame/revive/src/exec.rs

-			Weight::zero(),
+			Weight::max_value(),
 			storage_meter,
-			BalanceOf::<T>::zero(),
+			BalanceOf::<T>::max_value(),


The first frame is also created by nested and will be limited to 63/64. We need to make sure the first one can use the full resources.

We need to make sure the first one can use the full resources.

I did not understand this; may you elaborate on what exactly that would mean here?

In the current code the overall transaction will be limited to 63/64. We don't want this. We only want sub calls to be limited. But not the first contract called by the externally owned account. That one should be allowed to use all the gas.

rockbmb · 2024-12-20T01:24:49Z

Due to the changes here you can get rid of the fn enforce_subcall_limit() and enum Nested. They are no longer needed because we now always enforce the limit at the sub call boundry (calling fn enforce_limit unconditionally).

If I raze enum Nested, does it make sense to

Remove RawMeter's 3rd type parameter S, so it becomes pub struct RawMeter<T: Config, E>
move all methods in impl<T: Config, E: Ext<T>> RawMeter<T, E, Nested> into impl<T, E> RawMeter<T, E, Root>

?

athei · 2024-12-20T07:27:41Z

The type stating is still useful for other functions than enforce_subcall_limit that are exist on the nested meter. I wasn't aware the enum I told you to delete was also for used that. So no, keep the third type parameter.

Just remove the variants of Nested (or convert to unit structure like Root) and removed the nested field from RawMeter. Just add S to the _phantom.

paritytech-workflow-stopper · 2024-12-21T00:16:39Z

All GitHub workflows were cancelled due to failure one of the required jobs.
Failed workflow url: https://github.com/paritytech/polkadot-sdk/actions/runs/12440165471
Failed job name: quick-benchmarks-omni

rockbmb · 2024-12-21T00:47:21Z

14 unit tests are still failing, among them

these 2 tests fail because of a ContractReverted error where StorageDepositLimitExhausted was expected.

The remaining tests fail with ContractTrapped when assert_oking the result of CallBuilder::build.
E.g. for tests::delegate_call:

assert_ok!(builder::call(caller_addr) <-- assert fails!
	.value(1337)
	.data((callee_addr, 0u64, 0u64).encode())
	.build());

⬆️ is context in case you have any insights to share - the tests all failing for the same reason must be a clue to the underlying problem.

I'll move fast so paritytech/revive#117 can continue.

rockbmb added T2-pallets This PR/Issue is related to a particular pallet. T7-smart_contracts This PR/Issue is related to smart contracts. T10-tests This PR/Issue is related to tests. labels Dec 13, 2024

rockbmb self-assigned this Dec 13, 2024

rockbmb force-pushed the evm-contracts-limit-nested-calls-gas branch 2 times, most recently from 376e944 to 4832380 Compare December 17, 2024 02:17

rockbmb added 11 commits December 17, 2024 19:15

Fix typo in integration test

fadb396

Add unit tests to current behavior of GasMeter.nested

db02307

Add unit tests to simplest behavior of RawMeter

2c2a7f7

Add PRDoc

11dd382

Limit gas for nested calls per EIP-150

5a8312a

Reflect EIP-150 change in some unit tests

a7781c4

Address missing EIP-150 fix in one gas meter unit test

b6e7290

Apply EIP-150 to storage metering

8d7be23

Also, a limit of 0 when determining a nested call's metering limit would mean it was free to use all of the callee's resources. Now, a limit of 0 means that the nested call will have an empty storage meter.

Fix storage meter unit test for fn nested

ee2a183

Remove usage of 0 as unlimited storage meter in test

b89495f

rockbmb force-pushed the evm-contracts-limit-nested-calls-gas branch from ed1f312 to 8e66f50 Compare December 17, 2024 19:15

rockbmb marked this pull request as ready for review December 17, 2024 19:31

athei requested review from athei and xermicus December 17, 2024 20:08

xermicus reviewed Dec 18, 2024

View reviewed changes

rockbmb added 2 commits December 19, 2024 10:52

Rollback changes in frame/contracts

f5e6b2b

Add EIP-150 note to doc comment

33758aa

Run fmt

d1b40ed

xermicus mentioned this pull request Dec 19, 2024

Gas limits for calls paritytech/revive#117

Open

athei reviewed Dec 19, 2024

View reviewed changes

rockbmb added 3 commits December 20, 2024 15:45

Address latest PR comments (enum Nested)

36690cd

Refactor RawMeter/Nested

2c8f492

Run fmt

12473b4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reduce gas/storage limits in nested calls #6890

Reduce gas/storage limits in nested calls #6890

rockbmb commented Dec 13, 2024 •

edited by athei

Loading

xermicus left a comment

xermicus Dec 18, 2024

xermicus Dec 18, 2024

rockbmb commented Dec 19, 2024

athei commented Dec 19, 2024 •

edited

Loading

rockbmb commented Dec 19, 2024

rockbmb commented Dec 19, 2024

athei left a comment

athei Dec 19, 2024

athei Dec 19, 2024

athei Dec 19, 2024

rockbmb Dec 19, 2024

athei Dec 19, 2024

rockbmb Dec 20, 2024 •

edited

Loading

athei Dec 20, 2024

rockbmb commented Dec 20, 2024

athei commented Dec 20, 2024 •

edited

Loading

paritytech-workflow-stopper bot commented Dec 21, 2024

rockbmb commented Dec 21, 2024 •

edited

Loading

		debug_assert!(matches!(self.contract_state(), ContractState::Alive));

		// Limit gas for nested call, per EIP-150.

		let amt = amount.min(self.gas_left - self.gas_left / 64);
		self.gas_left -= amt;

Reduce gas/storage limits in nested calls #6890

Are you sure you want to change the base?

Reduce gas/storage limits in nested calls #6890

Conversation

rockbmb commented Dec 13, 2024 • edited by athei Loading

xermicus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rockbmb commented Dec 19, 2024

athei commented Dec 19, 2024 • edited Loading

rockbmb commented Dec 19, 2024

rockbmb commented Dec 19, 2024

athei left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rockbmb Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rockbmb commented Dec 20, 2024

athei commented Dec 20, 2024 • edited Loading

paritytech-workflow-stopper bot commented Dec 21, 2024

rockbmb commented Dec 21, 2024 • edited Loading

rockbmb commented Dec 13, 2024 •

edited by athei

Loading

athei commented Dec 19, 2024 •

edited

Loading

rockbmb Dec 20, 2024 •

edited

Loading

athei commented Dec 20, 2024 •

edited

Loading

rockbmb commented Dec 21, 2024 •

edited

Loading