pallet-revive 0.15.0

FRAME pallet for PolkaVM contracts.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

// 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::{Config, DebugSettingsOf};
use Debug;
use codec::{Decode, Encode, MaxEncodedLen};
use scale_info::TypeInfo;
use serde::{Deserialize, Serialize};
use sp_core::Get;

/// Debugging settings that can be configured when DebugEnabled config is true.
#[derive(
	Encode,
	Decode,
	Default,
	Clone,
	PartialEq,
	Debug,
	TypeInfo,
	MaxEncodedLen,
	Serialize,
	Deserialize,
)]
pub struct DebugSettings {
	/// Whether to allow unlimited contract size.
	allow_unlimited_contract_size: bool,
	/// Whether to allow bypassing EIP-3607 (allowing transactions coming from contract or
	/// precompile accounts).
	bypass_eip_3607: bool,
	/// Whether to enable PolkaVM logs.
	pvm_logs: bool,
	/// Whether to disable execution tracing.
	disable_execution_tracing: bool,
}

impl DebugSettings {
	pub fn set_bypass_eip_3607(mut self, value: bool) -> Self {
		self.bypass_eip_3607 = value;
		self
	}

	pub fn set_allow_unlimited_contract_size(mut self, value: bool) -> Self {
		self.allow_unlimited_contract_size = value;
		self
	}

	pub fn set_enable_pvm_logs(mut self, value: bool) -> Self {
		self.pvm_logs = value;
		self
	}

	pub fn is_execution_tracing_enabled<T: Config>() -> bool {
		T::DebugEnabled::get() && !DebugSettingsOf::<T>::get().disable_execution_tracing
	}

	/// Returns true if unlimited contract size is allowed.
	pub fn is_unlimited_contract_size_allowed<T: Config>() -> bool {
		T::DebugEnabled::get() && DebugSettingsOf::<T>::get().allow_unlimited_contract_size
	}

	/// Returns true if transactions coming from contract or precompile accounts are allowed
	/// (bypassing EIP-3607)
	pub fn bypass_eip_3607<T: Config>() -> bool {
		T::DebugEnabled::get() && DebugSettingsOf::<T>::get().bypass_eip_3607
	}

	/// Returns true if PolkaVM logs are enabled.
	pub fn is_pvm_logs_enabled<T: Config>() -> bool {
		T::DebugEnabled::get() && DebugSettingsOf::<T>::get().pvm_logs
	}

	/// Write the debug settings to storage.
	pub fn write_to_storage<T: Config>(&self) {
		DebugSettingsOf::<T>::put(self);
		if !T::DebugEnabled::get() {
			log::warn!(
				target: crate::LOG_TARGET,
				"Debug settings changed, but debug features are disabled in the runtime configuration."
			);
		}
	}
}