Add READ_ONLY flag to contract call function #4418

smiasojed · 2024-05-08T20:21:51Z

This PR implements the READ_ONLY flag to be used as a Callflag in the call function.
The flag indicates that the callee is restricted from modifying the state during call execution.
It is equivalent to Ethereum's STATICCALL.

smiasojed · 2024-05-08T22:00:06Z

bot bench substrate-pallet --pallet=pallet_contracts

command-bot · 2024-05-08T22:00:10Z

@smiasojed https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6163849 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts. Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 4-e1cd379c-2ad8-4462-ad01-76ff89dbf800 to cancel this command or bot cancel to cancel all commands in this pull request.

command-bot · 2024-05-08T23:37:55Z

@smiasojed Command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6163849 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6163849/artifacts/download.

…call

smiasojed · 2024-05-09T09:05:21Z

bot bench substrate-pallet --pallet=pallet_contracts

command-bot · 2024-05-09T09:05:26Z

@smiasojed "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts (https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6165184) was cancelled in #4418 (comment)

smiasojed · 2024-05-09T10:05:59Z

bot cancel 5-a1be7227-1f82-4a82-9891-dfc753222de3

command-bot · 2024-05-09T10:06:19Z

@smiasojed Command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6165184 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6165184/artifacts/download.

smiasojed · 2024-05-09T11:05:15Z

@athei I assumed that chain_extension calls the API over the Ext trait, so read-only protection in the Ext implementation is good enough, please comment
Another option is to extend Ext trait with fn is_read_only(&self) -> bool so the chain_extension is aware of the read_only context.

substrate/frame/contracts/src/exec.rs

smiasojed · 2024-05-09T18:47:17Z

bot bench substrate-pallet --pallet=pallet_contracts

command-bot · 2024-05-09T18:47:22Z

@smiasojed https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6168456 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts. Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 1-461002b6-0e9a-417d-86f9-dad7ecaae79a to cancel this command or bot cancel to cancel all commands in this pull request.

…=dev --target_dir=substrate --pallet=pallet_contracts

command-bot · 2024-05-09T20:21:50Z

@smiasojed Command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6168456 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6168456/artifacts/download.

athei

Some further ideas:

Maybe move the checks from Ext to Runtime. I think it is easier to understand because the checks are per host function and that way we error out as early as possible. You could even implement this as attribute on the macro making it declarative. Having checks sprinkled around Ext seems not the best approach.
I think there is no difference in how reentrancy and read_only is inherited. Can you unify them in one bit field? You may need to invert allow_reentrancy to make this happen.

substrate/frame/contracts/src/exec.rs

athei · 2024-05-10T10:54:11Z

@athei I assumed that chain_extension calls the API over the Ext trait, so read-only protection in the Ext implementation is good enough, please comment Another option is to extend Ext trait with fn is_read_only(&self) -> bool so the chain_extension is aware of the read_only context.

Yes it needs to be exposed on the Ext and chain extensions need to check it. With my comment above you need to expose it anyways if we move checks to the Runtime.

substrate/frame/contracts/src/wasm/runtime.rs

xermicus

Another detail if we want to mimic EVM STATICCALL semantics in full: STATICCALLs to accounts without code (e.g. call with the static flag set and no value) should succeed.

Note that an account with no code will return success as true (1).

(To clarify, EVM does balance transfers via calls to EOA. So in general, calls to EOA don't fail)

athei · 2024-05-24T11:02:49Z

This is a general difference we have to Ethereum that is independent of STATICCCAL. We don't allow balance transfers to plain account via seal_call. We need to add this behaviour in order to support revive. But not on this PR and probably only after the fork since it is not needed for ink!.

pgherveou · 2024-05-27T07:30:00Z

@smiasojed sorry for the new merge conflicts 😅
Let me know when this is ready for a final review

…call

smiasojed · 2024-05-28T13:10:53Z

@smiasojed sorry for the new merge conflicts 😅 Let me know when this is ready for a final review

@pgherveou conflicts resolved

pgherveou

lgtm

pgherveou · 2024-05-28T14:10:11Z

substrate/frame/contracts/src/exec.rs

@@ -2125,7 +2134,15 @@ mod tests {
 		let value = Default::default();
 		let recurse_ch = MockLoader::insert(Call, |ctx, _| {
 			// Try to call into yourself.
-			let r = ctx.ext.call(Weight::zero(), BalanceOf::<Test>::zero(), BOB, 0, vec![], true);
+			let r = ctx.ext.call(


all these diffs added every time we add a parameter are a bit annoying,
when we get a chance, we should add builder, like we did in test_utils/builder.rs,

smiasojed · 2024-05-28T19:54:34Z

bot bench substrate-pallet --pallet=pallet_contracts

command-bot · 2024-05-28T19:54:39Z

@smiasojed https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6328539 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts. Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 2-edb30dc9-0c17-49be-bbbc-50a7061cbb08 to cancel this command or bot cancel to cancel all commands in this pull request.

…nto HEAD

…=dev --target_dir=substrate --pallet=pallet_contracts

command-bot · 2024-05-28T20:48:04Z

@smiasojed Command "$PIPELINE_SCRIPTS_DIR/commands/bench/bench.sh" --subcommand=pallet --runtime=dev --target_dir=substrate --pallet=pallet_contracts has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6328539 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/6328539/artifacts/download.

athei · 2024-05-29T07:15:19Z

substrate/frame/contracts/proc-macro/src/lib.rs

+
+		if mutating {
+			let stmt = syn::parse_quote! {
+				if ctx.ext().is_read_only() {
+					return Err(Error::<E::T>::StateChangeDenied.into());
+				}
+			};
+			item.block.stmts.insert(0, stmt);
+		}


As stated before: We can't return that early here. This codes runs before we charge the gas for the host function call invocation itself. This has to be charged even if no work has been performed. You have to move down this statement after:

polkadot-sdk/substrate/frame/contracts/proc-macro/src/lib.rs

Lines 708 to 711 in 89604da

// Charge gas for host function execution.

__caller__.data_mut().charge_gas(crate::wasm::RuntimeCosts::HostFn)

.map_err(TrapReason::from)

.map_err(#into_host)?;

I agree, but my understanding is that the gas charge charge_gas(crate::wasm::RuntimeCosts::HostFn) is added before function body (mutating check is added to the function body)
Expanded:

__caller__ .data_mut() .charge_gas(crate::wasm::RuntimeCosts::HostFn) .map_err(TrapReason::from) .map_err(|reason| { ::wasmi::core::Trap::from(reason) })?; let mut func = || -> Result<(), TrapReason> { let (memory, ctx) = __caller__ .data() .memory() .expect("Memory must be set when setting up host data; qed") .data_and_store_mut(&mut __caller__); let result = { if ctx.ext().is_read_only() { return Err(Error::<E::T>::StateChangeDenied.into()); } ctx.set_storage( memory, KeyType::Fix, key_ptr, value_ptr, value_len, ) .map(|_| ()) };

Ahh yes. Can you add a test that makes sure this weight is charged when erroring out early?

I tried to test it using fixture:

pub extern "C" fn call() { input!(n: u32, ); match n { 0 => unsafe {core::ptr::read_volatile(core::ptr::null())}, _ => api::set_storage(&[1u8; 32], &[1u8; 1]), } }

The fixture is called with n equal to 0 and 1. Both calls result in a trap, but the difference is more significant than just the host function call cost because (I assume) the WASMI execution time differs for both cases. The difference is the host function call cost plus 15%.
HostFn ref_time is 72994

You can call the tokens function on the gas meter to check which tokens were charged.

As discussed in priv, we do not have access to gas_meter in our tests. We could add such functionality to our tests to trace gas metering more deeply during testing. This will be implemented as a separate PR.

athei

You have to bump the ApiVersion and then we are good to go.

…call

* master: Add READ_ONLY flag to contract call function (#4418) Format the README.md files (#4688) Typos in template README (#4687) [ci] Increase timeout for check-runtime-migration workflow (#4674)

This PR implements the `READ_ONLY` flag to be used as a `Callflag` in the `call` function. The flag indicates that the callee is restricted from modifying the state during call execution. It is equivalent to Ethereum's [STATICCALL](https://eips.ethereum.org/EIPS/eip-214). --------- Co-authored-by: command-bot <> Co-authored-by: Andrew Jones <[email protected]> Co-authored-by: Alexander Theißen <[email protected]>

smiasojed added 6 commits May 7, 2024 17:36

Add static_call flag to contracts call function

6847f88

Refactoring

b19bc77

Unit test added

161d4ac

Cleanup

a96a4aa

Fmt

ae1151e

Add prdoc

41d753e

smiasojed added the T7-smart_contracts This PR/Issue is related to smart contracts. label May 8, 2024

Fix prdoc

5278c7a

smiasojed force-pushed the sm/contracts-staticcall branch from 315819c to 5278c7a Compare May 9, 2024 07:57

smiasojed added 3 commits May 9, 2024 10:23

Update description

15fca3c

Merge remote-tracking branch 'origin/master' into sm/contracts-static…

5f9d957

…call

Update prdoc

7169214

Add read-only protection to call_runtime

cfd4198

smiasojed commented May 9, 2024

View reviewed changes

substrate/frame/contracts/src/exec.rs Outdated Show resolved Hide resolved

".git/.scripts/commands/bench/bench.sh" --subcommand=pallet --runtime…

0a708a0

…=dev --target_dir=substrate --pallet=pallet_contracts

smiasojed added 2 commits May 10, 2024 10:26

Add test

3369de6

Fix fixture description

6ebfafc

athei reviewed May 10, 2024

View reviewed changes

substrate/frame/contracts/src/exec.rs Outdated Show resolved Hide resolved

Address comments

08b4ca7

smiasojed marked this pull request as ready for review May 15, 2024 20:28

Move read-only condition to runtime

b3571d7

athei reviewed May 17, 2024

View reviewed changes

substrate/frame/contracts/src/wasm/runtime.rs Show resolved Hide resolved

xermicus reviewed May 23, 2024

View reviewed changes

Merge remote-tracking branch 'origin/master' into sm/contracts-static…

c7fa16e

…call

pgherveou approved these changes May 28, 2024

View reviewed changes

command-bot added 2 commits May 28, 2024 19:56

Merge branch 'master' of https://github.com/paritytech/polkadot-sdk i…

48e907b

…nto HEAD

".git/.scripts/commands/bench/bench.sh" --subcommand=pallet --runtime…

2cb8084

…=dev --target_dir=substrate --pallet=pallet_contracts

athei reviewed May 29, 2024

View reviewed changes

athei reviewed Jun 3, 2024

View reviewed changes

smiasojed added 2 commits June 3, 2024 21:05

Bump API verision for contracts pallet

d5f8d15

Merge remote-tracking branch 'origin/master' into sm/contracts-static…

21aaa70

…call

athei approved these changes Jun 4, 2024

View reviewed changes

athei added this pull request to the merge queue Jun 4, 2024

Merged via the queue into master with commit 3e84164 Jun 4, 2024
156 of 158 checks passed

athei deleted the sm/contracts-staticcall branch June 4, 2024 08:23

chungquantin mentioned this pull request Aug 15, 2024

chore: upgrade to 1.13.0 r0gue-io/pop-node#194

Merged

This was referenced Aug 21, 2024

Update polkadot-sdk from v1.11.0 to stable2407 moondance-labs/tanssi#659

Closed

Update polkadot-sdk from v1.11.0 to stable2407 moonbeam-foundation/moonbeam#2912

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add READ_ONLY flag to contract call function #4418

Add READ_ONLY flag to contract call function #4418

smiasojed commented May 8, 2024 •

edited

Loading

smiasojed commented May 8, 2024

command-bot bot commented May 8, 2024 •

edited

Loading

command-bot bot commented May 8, 2024

smiasojed commented May 9, 2024

command-bot bot commented May 9, 2024 •

edited

Loading

smiasojed commented May 9, 2024

command-bot bot commented May 9, 2024

smiasojed commented May 9, 2024 •

edited

Loading

smiasojed commented May 9, 2024

command-bot bot commented May 9, 2024 •

edited

Loading

command-bot bot commented May 9, 2024

athei left a comment

athei commented May 10, 2024

xermicus left a comment •

edited

Loading

athei commented May 24, 2024

pgherveou commented May 27, 2024

smiasojed commented May 28, 2024

pgherveou left a comment

pgherveou May 28, 2024

smiasojed commented May 28, 2024

command-bot bot commented May 28, 2024 •

edited

Loading

command-bot bot commented May 28, 2024

athei May 29, 2024 •

edited

Loading

smiasojed May 29, 2024 •

edited

Loading

athei May 29, 2024

smiasojed May 29, 2024 •

edited

Loading

athei May 30, 2024

smiasojed May 31, 2024 •

edited

Loading

athei left a comment

	// Charge gas for host function execution.
	__caller__.data_mut().charge_gas(crate::wasm::RuntimeCosts::HostFn)
	.map_err(TrapReason::from)
	.map_err(#into_host)?;

Add READ_ONLY flag to contract call function #4418

Add READ_ONLY flag to contract call function #4418

Conversation

smiasojed commented May 8, 2024 • edited Loading

smiasojed commented May 8, 2024

command-bot bot commented May 8, 2024 • edited Loading

command-bot bot commented May 8, 2024

smiasojed commented May 9, 2024

command-bot bot commented May 9, 2024 • edited Loading

smiasojed commented May 9, 2024

command-bot bot commented May 9, 2024

smiasojed commented May 9, 2024 • edited Loading

smiasojed commented May 9, 2024

command-bot bot commented May 9, 2024 • edited Loading

command-bot bot commented May 9, 2024

athei left a comment

Choose a reason for hiding this comment

athei commented May 10, 2024

xermicus left a comment • edited Loading

Choose a reason for hiding this comment

athei commented May 24, 2024

pgherveou commented May 27, 2024

smiasojed commented May 28, 2024

pgherveou left a comment

Choose a reason for hiding this comment

pgherveou May 28, 2024

Choose a reason for hiding this comment

smiasojed commented May 28, 2024

command-bot bot commented May 28, 2024 • edited Loading

command-bot bot commented May 28, 2024

athei May 29, 2024 • edited Loading

Choose a reason for hiding this comment

smiasojed May 29, 2024 • edited Loading

Choose a reason for hiding this comment

athei May 29, 2024

Choose a reason for hiding this comment

smiasojed May 29, 2024 • edited Loading

Choose a reason for hiding this comment

athei May 30, 2024

Choose a reason for hiding this comment

smiasojed May 31, 2024 • edited Loading

Choose a reason for hiding this comment

athei left a comment

Choose a reason for hiding this comment

smiasojed commented May 8, 2024 •

edited

Loading

command-bot bot commented May 8, 2024 •

edited

Loading

command-bot bot commented May 9, 2024 •

edited

Loading

smiasojed commented May 9, 2024 •

edited

Loading

command-bot bot commented May 9, 2024 •

edited

Loading

xermicus left a comment •

edited

Loading

command-bot bot commented May 28, 2024 •

edited

Loading

athei May 29, 2024 •

edited

Loading

smiasojed May 29, 2024 •

edited

Loading

smiasojed May 29, 2024 •

edited

Loading

smiasojed May 31, 2024 •

edited

Loading