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
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of Tetsy Vapory.

// Tetsy Vapory is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Tetsy Vapory is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Tetsy Vapory.  If not, see <http://www.gnu.org/licenses/>.

//! Spec params deserialization.

use crate::{
	bytes::Bytes,
	hash::{H256, Address},
	uint::{self, Uint}
};
use serde::Deserialize;

/// Spec params.
#[derive(Debug, PartialEq, Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(rename_all = "camelCase")]
pub struct Params {
	/// Account start nonce, defaults to 0.
	pub account_start_nonce: Option<Uint>,
	/// Maximum size of extra data.
	pub maximum_extra_data_size: Uint,
	/// Minimum gas limit.
	pub min_gas_limit: Uint,

	/// Network id.
	#[serde(rename = "networkID")]
	pub network_id: Uint,
	/// Chain id.
	#[serde(rename = "chainID")]
	pub chain_id: Option<Uint>,

	/// Name of the main ("vap") subprotocol.
	pub subprotocol_name: Option<String>,

	/// Option fork block number to check.
	pub fork_block: Option<Uint>,
	/// Expected fork block hash.
	#[serde(rename = "forkCanonHash")]
	pub fork_hash: Option<H256>,

	/// See main VapashParams docs.
	pub eip150_transition: Option<Uint>,

	/// See main VapashParams docs.
	pub eip160_transition: Option<Uint>,

	/// See main VapashParams docs.
	pub eip161abc_transition: Option<Uint>,
	/// See main VapashParams docs.
	pub eip161d_transition: Option<Uint>,

	/// See `CommonParams` docs.
	pub eip98_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip155_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub validate_chain_id_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub validate_receipts_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip140_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip210_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip210_contract_address: Option<Address>,
	/// See `CommonParams` docs.
	pub eip210_contract_code: Option<Bytes>,
	/// See `CommonParams` docs.
	pub eip210_contract_gas: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip211_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip145_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip214_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip658_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip1052_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip1283_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip1283_disable_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip1283_reenable_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip1014_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip1706_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip1344_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip1884_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip2028_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub eip2200_advance_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub dust_protection_transition: Option<Uint>,
	/// See `CommonParams` docs.
	pub nonce_cap_increment: Option<Uint>,
	/// See `CommonParams` docs.
	pub remove_dust_contracts : Option<bool>,
	/// See `CommonParams` docs.
	#[serde(deserialize_with="uint::validate_non_zero")]
	pub gas_limit_bound_divisor: Uint,
	/// See `CommonParams` docs.
	pub tetsy_registrar: Option<Address>,
	/// Apply reward flag
	pub apply_reward: Option<bool>,
	/// Node permission contract address.
	pub node_permission_contract: Option<Address>,
	/// See main VapashParams docs.
	pub max_code_size: Option<Uint>,
	/// Maximum size of transaction RLP payload.
	pub max_transaction_size: Option<Uint>,
	/// See main VapashParams docs.
	pub max_code_size_transition: Option<Uint>,
	/// Transaction permission contract address.
	pub transaction_permission_contract: Option<Address>,
	/// Block at which the transaction permission contract should start being used.
	pub transaction_permission_contract_transition: Option<Uint>,
	/// Wasm activation block height, if not activated from start.
	pub wasm_activation_transition: Option<Uint>,
	/// Define a separate wasm version instead of using the prefix.
	pub wasm_version: Option<Uint>,
	/// KIP4 activiation block height.
	pub kip4_transition: Option<Uint>,
	/// KIP6 activiation block height.
	pub kip6_transition: Option<Uint>,
}

#[cfg(test)]
mod tests {
	use super::{Params, Uint};
	use vapory_types::U256;

	#[test]
	fn params_deserialization() {
		let s = r#"{
			"maximumExtraDataSize": "0x20",
			"networkID": "0x1",
			"chainID": "0x15",
			"subprotocolName": "exp",
			"minGasLimit": "0x1388",
			"accountStartNonce": "0x01",
			"gasLimitBoundDivisor": "0x20",
			"maxCodeSize": "0x1000",
			"wasmActivationTransition": "0x1010"
		}"#;

		let deserialized: Params = serde_json::from_str(s).unwrap();
		assert_eq!(deserialized.maximum_extra_data_size, Uint(U256::from(0x20)));
		assert_eq!(deserialized.network_id, Uint(U256::from(0x1)));
		assert_eq!(deserialized.chain_id, Some(Uint(U256::from(0x15))));
		assert_eq!(deserialized.subprotocol_name, Some("exp".to_owned()));
		assert_eq!(deserialized.min_gas_limit, Uint(U256::from(0x1388)));
		assert_eq!(deserialized.account_start_nonce, Some(Uint(U256::from(0x01))));
		assert_eq!(deserialized.gas_limit_bound_divisor, Uint(U256::from(0x20)));
		assert_eq!(deserialized.max_code_size, Some(Uint(U256::from(0x1000))));
		assert_eq!(deserialized.wasm_activation_transition, Some(Uint(U256::from(0x1010))));
	}

	#[test]
	#[should_panic(expected = "a non-zero value")]
	fn test_zero_value_divisor() {
		let s = r#"{
			"maximumExtraDataSize": "0x20",
			"networkID" : "0x1",
			"chainID" : "0x15",
			"subprotocolName" : "exp",
			"minGasLimit": "0x1388",
			"accountStartNonce": "0x01",
			"gasLimitBoundDivisor": "0x0",
			"maxCodeSize": "0x1000"
		}"#;

		let _deserialized: Params = serde_json::from_str(s).unwrap();
	}
}