[pallet-revive] Migrate various getters to System pre-compile

prdoc/pr_9517.prdoc

@@ -0,0 +1,13 @@
+title: '[pallet-revive] Migrate various getters to `System` pre-compile'
+doc:
+- audience: Runtime Dev
+  description: Migrates `own_code_hash`, `caller_is_origin`, `caller_is_root`, 
+    `weight_left`, `minimum_balance`. Contains minor other fixes (removing leftovers 
+    from deprecating chain extensions, stabilizing `block_hash` in overlooked crates, …).
+crates:
+- name: pallet-revive
+  bump: patch
+- name: pallet-revive-fixtures
+  bump: major
+- name: pallet-revive-uapi
+  bump: major

substrate/frame/contracts/src/chain_extension.rs

@@ -67,7 +67,7 @@
 //! # Example
 //!
 //! The ink-examples repository maintains an
-//! [end-to-end example](https://github.com/paritytech/ink-examples/tree/main/rand-extension)
+//! [end-to-end example](https://github.com/use-ink/ink-examples/tree/v5.x.x/rand-extension)
 //! on how to use a chain extension in order to provide new features to ink! contracts.
 
 use crate::{

substrate/frame/revive/Cargo.toml

@@ -47,7 +47,7 @@ frame-support = { workspace = true }
 frame-system = { workspace = true }
 pallet-revive-fixtures = { workspace = true, optional = true }
 pallet-revive-proc-macro = { workspace = true }
-pallet-revive-uapi = { workspace = true, features = ["scale"] }
+pallet-revive-uapi = { workspace = true, features = ["precompiles-sol-interfaces", "scale"] }
 pallet-transaction-payment = { workspace = true }
 ripemd = { workspace = true }
 sp-api = { workspace = true }

substrate/frame/revive/fixtures/contracts/call_caller_is_origin.rs

@@ -0,0 +1,47 @@
+// This file is part of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! This fixture calls the `callerIsOrigin` function on the
+//! `System` pre-compile.
+
+#![no_std]
+#![no_main]
+include!("../panic_handler.rs");
+
+use uapi::{HostFn, HostFnImpl as api};
+
+#[no_mangle]
+#[polkavm_derive::polkavm_export]
+pub extern "C" fn deploy() {}
+
+#[no_mangle]
+#[polkavm_derive::polkavm_export]
+pub extern "C" fn call() {
+	let mut output = [0u8; 32];
+	let _ = api::call(
+		uapi::CallFlags::READ_ONLY,
+		&uapi::SYSTEM_PRECOMPILE_ADDR,
+		u64::MAX,       // How much ref_time to devote for the execution. u64::MAX = use all.
+		u64::MAX,       // How much proof_size to devote for the execution. u64::MAX = use all.
+		&[u8::MAX; 32], // No deposit limit.
+		&[0u8; 32],     // Value transferred to the contract.
+		&uapi::solidity_selector("callerIsOrigin()"),
+		Some(&mut &mut output[..]),
+	).unwrap();
+
+	api::return_value(uapi::ReturnFlags::empty(), &output);
+}

substrate/frame/revive/fixtures/contracts/call_caller_is_root.rs

@@ -0,0 +1,47 @@
+// This file is part of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! This fixture calls the `callerIsRoot` function on the
+//! `System` pre-compile.
+
+#![no_std]
+#![no_main]
+include!("../panic_handler.rs");
+
+use uapi::{HostFn, HostFnImpl as api};
+
+#[no_mangle]
+#[polkavm_derive::polkavm_export]
+pub extern "C" fn deploy() {}
+
+#[no_mangle]
+#[polkavm_derive::polkavm_export]
+pub extern "C" fn call() {
+	let mut output = [0u8; 32];
+	let _ = api::call(
+		uapi::CallFlags::READ_ONLY,
+		&uapi::SYSTEM_PRECOMPILE_ADDR,
+		u64::MAX,       // How much ref_time to devote for the execution. u64::MAX = use all.
+		u64::MAX,       // How much proof_size to devote for the execution. u64::MAX = use all.
+		&[u8::MAX; 32], // No deposit limit.
+		&[0u8; 32],     // Value transferred to the contract.
+		&uapi::solidity_selector("callerIsRoot()"),
+		Some(&mut &mut output[..]),
+	).unwrap();
+
+	api::return_value(uapi::ReturnFlags::empty(), &output);
+}

substrate/frame/revive/fixtures/contracts/call_diverging_out_len.rs

@@ -27,7 +27,7 @@
 #![no_main]
 include!("../panic_handler.rs");
 
-use uapi::{HostFn, HostFnImpl as api};
+use uapi::{HostFn, HostFnImpl as api, u256_bytes};
 
 const BUF_SIZE: usize = 8;
 static DATA: [u8; BUF_SIZE] = [1, 2, 3, 4, 5, 6, 7, 8];
@@ -58,8 +58,19 @@ fn assert_call<const N: usize>(callee_address: &[u8; 20], expected_output: [u8;
 /// Instantiate this contract with an output buf of size `N`
 /// and expect the instantiate output to match `expected_output`.
 fn assert_instantiate<const N: usize>(expected_output: [u8; BUF_SIZE]) {
-	let mut code_hash = [0; 32];
-	api::own_code_hash(&mut code_hash);
+	let mut output_buf1 = [0u8; 32];
+	let output1 = &mut &mut output_buf1[..];
+	let _ = api::call(
+		uapi::CallFlags::READ_ONLY,
+		&uapi::SYSTEM_PRECOMPILE_ADDR,
+		u64::MAX,       // How much ref_time to devote for the execution. u64::MAX = use all.
+		u64::MAX,       // How much proof_size to devote for the execution. u64::MAX = use all.
+		&[u8::MAX; 32], // No deposit limit.
+		&[0u8; 32],     // Value transferred to the contract.
+		&uapi::solidity_selector("ownCodeHash()"),
+		Some(output1),
+	).unwrap();
+	assert_ne!(output_buf1, [0u8; 32]);
 
 	let mut output_buf = [0u8; BUF_SIZE];
 	let output_buf_capped = &mut &mut output_buf[..N];
@@ -68,8 +79,8 @@ fn assert_instantiate<const N: usize>(expected_output: [u8; BUF_SIZE]) {
 		u64::MAX,
 		u64::MAX,
 		&[u8::MAX; 32],
-		&[0; 32],
-		&code_hash,
+		&u256_bytes(0),
+		output_buf1.clone().as_slice(),
 		None,
 		Some(output_buf_capped),
 		None,

substrate/frame/revive/fixtures/contracts/call_own_code_hash.rs

@@ -0,0 +1,51 @@
+// This file is part of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! This fixture calls the `ownCodeHash` function on the
+//! `System` pre-compile.
+
+#![allow(unused_imports)]
+#![no_std]
+#![no_main]
+include!("../panic_handler.rs");
+
+use core::num::NonZero;
+use uapi::{HostFn, HostFnImpl as api, u256_bytes};
+use hex_literal::hex;
+
+#[no_mangle]
+#[polkavm_derive::polkavm_export]
+pub extern "C" fn deploy() { }
+
+#[no_mangle]
+#[polkavm_derive::polkavm_export]
+pub extern "C" fn call() {
+	let mut output_buf = [0u8; 32];
+	let output = &mut &mut output_buf[..];
+	let _ = api::call(
+		uapi::CallFlags::READ_ONLY,
+		&uapi::SYSTEM_PRECOMPILE_ADDR,
+		u64::MAX,       // How much ref_time to devote for the execution. u64::MAX = use all.
+		u64::MAX,       // How much proof_size to devote for the execution. u64::MAX = use all.
+		&[u8::MAX; 32], // No deposit limit.
+		&[0u8; 32],     // Value transferred to the contract.
+		&uapi::solidity_selector("ownCodeHash()"),
+		Some(output),
+	).unwrap();
+	assert_ne!(output_buf, [0u8; 32]);
+	api::return_value(uapi::ReturnFlags::empty(), &output_buf);
+}

substrate/frame/revive/fixtures/contracts/caller_is_origin_n.rs

@@ -33,6 +33,15 @@ pub extern "C" fn call() {
 	input!(n: u32, );
 
 	for _ in 0..n {
-		let _ = api::caller_is_origin();
+		let _ = api::call(
+			uapi::CallFlags::READ_ONLY,
+			&uapi::SYSTEM_PRECOMPILE_ADDR,
+			u64::MAX,       // How much ref_time to devote for the execution. u64::MAX = use all.
+			u64::MAX,       // How much proof_size to devote for the execution. u64::MAX = use all.
+			&[u8::MAX; 32], // No deposit limit.
+			&[0u8; 32],     // Value transferred to the contract.
+			&uapi::solidity_selector("callerIsOrigin()"),
+			None,
+		).unwrap();
 	}
 }

substrate/frame/revive/fixtures/contracts/drain.rs

@@ -29,7 +29,24 @@ pub extern "C" fn deploy() {}
 #[polkavm_derive::polkavm_export]
 pub extern "C" fn call() {
 	let balance = u64_output!(api::balance,);
-	let minimum_balance = u64_output!(api::minimum_balance,);
+
+	let mut output_buf = [0u8; 32];
+	let output = &mut &mut output_buf[..];
+	let _ = api::call(
+		uapi::CallFlags::READ_ONLY,
+		&uapi::SYSTEM_PRECOMPILE_ADDR,
+		u64::MAX,       // How much ref_time to devote for the execution. u64::MAX = use all.
+		u64::MAX,       // How much proof_size to devote for the execution. u64::MAX = use all.
+		&[u8::MAX; 32], // No deposit limit.
+		&[0u8; 32],     // Value transferred to the contract.
+		&uapi::solidity_selector("minimumBalance()"),
+		Some(output),
+	).unwrap();
+	assert_ne!(output_buf, [0u8; 32]);
+
+	let mut u64_buf = [0u8; 8];
+	u64_buf[..8].copy_from_slice(&output_buf[24..32]);
+	let minimum_balance = u64::from_be_bytes(u64_buf);
 
 	// Make the transferred value exceed the balance by adding the minimum balance.
 	let balance = balance + minimum_balance;