pallet-revive 0.16.0

// 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.

use crate::{
	metering::TransactionLimits,
	test_utils::{builder::Contract, ALICE},
	tests::{builder, sol::make_initcode_from_runtime_code, ExtBuilder, Test},
	Code, Config, Error, U256,
};
use frame_support::{assert_err, traits::fungible::Mutate};
use pallet_revive_uapi::ReturnFlags;
use pretty_assertions::assert_eq;
use revm::bytecode::opcode::*;

#[test]
fn jump_works() {
	let expected_value = 0xfefefefe_u64;
	let runtime_code: Vec<u8> = vec![
		// store 0xfefefefe at memory location 0
		// This is the value we will return
		vec![PUSH4, 0xfe, 0xfe, 0xfe, 0xfe],
		vec![PUSH0],
		vec![MSTORE],
		vec![PUSH1, 0x11_u8],
		// jump over storing 0xdeadbeef
		// this is the value we will return if JUMP is not executed
		vec![JUMP],
		vec![PUSH4, 0xde, 0xad, 0xbe, 0xef],
		vec![PUSH0],
		vec![MSTORE],
		// return whatever is in memory at location 0
		vec![JUMPDEST],
		vec![PUSH1, 0x20_u8],
		vec![PUSH0],
		vec![RETURN],
	]
	.into_iter()
	.flatten()
	.collect();
	let code = make_initcode_from_runtime_code(&runtime_code);

	ExtBuilder::default().build().execute_with(|| {
		<Test as Config>::Currency::set_balance(&ALICE, 100_000_000_000);
		let Contract { addr, .. } =
			builder::bare_instantiate(Code::Upload(code)).build_and_unwrap_contract();

		let result = builder::bare_call(addr).build_and_unwrap_result();

		assert!(!result.did_revert(), "test reverted");
		assert_eq!(
			U256::from_big_endian(&result.data),
			U256::from(expected_value),
			"memory test should return {expected_value}"
		);
	});
}
#[test]
fn jumpdest_works() {
	// Test invalid jumpdest
	let runtime_code: Vec<u8> = vec![
		// This will jump to the MSTORE instruction, should give an error
		vec![PUSH1, 0x00_u8],
		vec![JUMP],
		// return whatever is in memory at location 0
		vec![JUMPDEST],
		vec![PUSH1, 0x20_u8],
		vec![PUSH0],
		vec![RETURN],
	]
	.into_iter()
	.flatten()
	.collect();
	let code = make_initcode_from_runtime_code(&runtime_code);

	ExtBuilder::default().build().execute_with(|| {
		<Test as Config>::Currency::set_balance(&ALICE, 100_000_000_000);
		let Contract { addr, .. } =
			builder::bare_instantiate(Code::Upload(code)).build_and_unwrap_contract();

		let result = builder::bare_call(addr).build().result;
		assert_err!(result, Error::<Test>::InvalidJump);
	});
}

#[test]
fn jumpi_works() {
	let expected_value = 0xfefefefe_u64;
	let unexpected_value = 0xaabbccdd_u64;
	let runtime_code: Vec<u8> = vec![
		vec![PUSH0],
		vec![CALLDATALOAD],
		// Compare argument to 0xfefefefe and jump is they do not match
		vec![PUSH4, 0xfe, 0xfe, 0xfe, 0xfe],
		vec![SUB],
		vec![PUSH1, 0x16_u8],
		vec![JUMPI],
		// argument was 0xfefefefe, we did not jump so we return 0xfefefefe
		vec![PUSH4, 0xfe, 0xfe, 0xfe, 0xfe],
		vec![PUSH0],
		vec![MSTORE],
		vec![PUSH1, 0x20_u8],
		vec![PUSH0],
		vec![RETURN],
		// argument was *NOT* 0xfefefefe so we return 0xdeadbeef
		vec![JUMPDEST],
		vec![PUSH4, 0xde, 0xad, 0xbe, 0xef],
		vec![PUSH0],
		vec![MSTORE],
		vec![PUSH1, 0x20_u8],
		vec![PUSH0],
		vec![RETURN],
	]
	.into_iter()
	.flatten()
	.collect();
	let code = make_initcode_from_runtime_code(&runtime_code);

	ExtBuilder::default().build().execute_with(|| {
		<Test as Config>::Currency::set_balance(&ALICE, 100_000_000_000);
		let Contract { addr, .. } =
			builder::bare_instantiate(Code::Upload(code)).build_and_unwrap_contract();

		{
			// JUMPI was *not* triggered, contract returns 0xfefefefe
			let argument = U256::from(expected_value).to_big_endian().to_vec();

			let result = builder::bare_call(addr).data(argument).build_and_unwrap_result();
			assert!(!result.did_revert(), "test reverted");
			assert_eq!(
				U256::from_big_endian(&result.data),
				U256::from(expected_value),
				"memory test should return {expected_value}"
			);
		}

		{
			// JUMPI was triggered, contract returns 0xdeadbeef
			let argument = U256::from(unexpected_value).to_big_endian().to_vec();

			let result = builder::bare_call(addr).data(argument).build_and_unwrap_result();
			assert!(!result.did_revert(), "test reverted");

			assert_eq!(
				U256::from_big_endian(&result.data),
				U256::from(0xdeadbeef_u64),
				"memory test should return 0xdeadbeef"
			);
		}
	});
}

#[test]
fn ret_works() {
	let expected_value = 0xfefefefe_u64;
	let runtime_code: Vec<u8> = vec![
		vec![PUSH4, 0xfe, 0xfe, 0xfe, 0xfe],
		vec![PUSH0],
		vec![MSTORE],
		vec![PUSH1, 0x20_u8],
		vec![PUSH0],
		vec![RETURN],
	]
	.into_iter()
	.flatten()
	.collect();
	let code = make_initcode_from_runtime_code(&runtime_code);

	ExtBuilder::default().build().execute_with(|| {
		<Test as Config>::Currency::set_balance(&ALICE, 100_000_000_000);
		let Contract { addr, .. } =
			builder::bare_instantiate(Code::Upload(code)).build_and_unwrap_contract();

		let result = builder::bare_call(addr).build_and_unwrap_result();

		assert!(!result.did_revert(), "test reverted");
		assert_eq!(
			U256::from_big_endian(&result.data),
			U256::from(expected_value),
			"memory test should return {expected_value}"
		);
	});
}

#[test]
fn revert_works() {
	let expected_value = 0xfefefefe_u64;
	let runtime_code: Vec<u8> = vec![
		vec![PUSH4, 0xfe, 0xfe, 0xfe, 0xfe],
		vec![PUSH0],
		vec![MSTORE],
		vec![PUSH1, 0x20_u8],
		vec![PUSH0],
		vec![REVERT],
	]
	.into_iter()
	.flatten()
	.collect();
	let code = make_initcode_from_runtime_code(&runtime_code);

	ExtBuilder::default().build().execute_with(|| {
		<Test as Config>::Currency::set_balance(&ALICE, 100_000_000_000);
		let Contract { addr, .. } =
			builder::bare_instantiate(Code::Upload(code)).build_and_unwrap_contract();

		let result = builder::bare_call(addr).build_and_unwrap_result();

		assert!(result.flags == ReturnFlags::REVERT, "test did not revert");
		assert_eq!(
			U256::from_big_endian(&result.data),
			U256::from(expected_value),
			"memory test should return {expected_value}"
		);
	});
}

#[test]
fn stop_works() {
	let runtime_code: Vec<u8> = vec![vec![STOP]].into_iter().flatten().collect();
	let code = make_initcode_from_runtime_code(&runtime_code);

	ExtBuilder::default().build().execute_with(|| {
		<Test as Config>::Currency::set_balance(&ALICE, 100_000_000_000);
		let Contract { addr, .. } =
			builder::bare_instantiate(Code::Upload(code)).build_and_unwrap_contract();

		let result = builder::bare_call(addr).build_and_unwrap_result();

		assert!(!result.did_revert(), "test reverted");
	});
}

#[test]
fn invalid_works() {
	let expected_gas = 12_345_000_u64;
	let runtime_code: Vec<u8> = vec![vec![INVALID]].into_iter().flatten().collect();
	let code = make_initcode_from_runtime_code(&runtime_code);

	ExtBuilder::default().build().execute_with(|| {
		<Test as Config>::Currency::set_balance(&ALICE, 100_000_000_000);
		let Contract { addr, .. } =
			builder::bare_instantiate(Code::Upload(code)).build_and_unwrap_contract();

		let output = builder::bare_call(addr)
			.transaction_limits(TransactionLimits::WeightAndDeposit {
				weight_limit: expected_gas.into(),
				deposit_limit: Default::default(),
			})
			.data(vec![])
			.build();

		let result = output.result;
		assert_err!(result, Error::<Test>::InvalidInstruction);
		assert_eq!(
			output.weight_consumed.ref_time(),
			expected_gas,
			"Gas consumed does not match expected gas"
		);
		assert_eq!(
			output.weight_consumed.proof_size(),
			expected_gas,
			"Gas consumed does not match expected gas"
		);
	});
}