vapjson/spec/
params.rs

1// Copyright 2015-2020 Parity Technologies (UK) Ltd.
2// This file is part of Tetsy Vapory.
3
4// Tetsy Vapory is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8
9// Tetsy Vapory is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12// GNU General Public License for more details.
13
14// You should have received a copy of the GNU General Public License
15// along with Tetsy Vapory.  If not, see <http://www.gnu.org/licenses/>.
16
17//! Spec params deserialization.
18
19use crate::{
20	bytes::Bytes,
21	hash::{H256, Address},
22	uint::{self, Uint}
23};
24use serde::Deserialize;
25
26/// Spec params.
27#[derive(Debug, PartialEq, Deserialize)]
28#[serde(deny_unknown_fields)]
29#[serde(rename_all = "camelCase")]
30pub struct Params {
31	/// Account start nonce, defaults to 0.
32	pub account_start_nonce: Option<Uint>,
33	/// Maximum size of extra data.
34	pub maximum_extra_data_size: Uint,
35	/// Minimum gas limit.
36	pub min_gas_limit: Uint,
37
38	/// Network id.
39	#[serde(rename = "networkID")]
40	pub network_id: Uint,
41	/// Chain id.
42	#[serde(rename = "chainID")]
43	pub chain_id: Option<Uint>,
44
45	/// Name of the main ("vap") subprotocol.
46	pub subprotocol_name: Option<String>,
47
48	/// Option fork block number to check.
49	pub fork_block: Option<Uint>,
50	/// Expected fork block hash.
51	#[serde(rename = "forkCanonHash")]
52	pub fork_hash: Option<H256>,
53
54	/// See main VapashParams docs.
55	pub eip150_transition: Option<Uint>,
56
57	/// See main VapashParams docs.
58	pub eip160_transition: Option<Uint>,
59
60	/// See main VapashParams docs.
61	pub eip161abc_transition: Option<Uint>,
62	/// See main VapashParams docs.
63	pub eip161d_transition: Option<Uint>,
64
65	/// See `CommonParams` docs.
66	pub eip98_transition: Option<Uint>,
67	/// See `CommonParams` docs.
68	pub eip155_transition: Option<Uint>,
69	/// See `CommonParams` docs.
70	pub validate_chain_id_transition: Option<Uint>,
71	/// See `CommonParams` docs.
72	pub validate_receipts_transition: Option<Uint>,
73	/// See `CommonParams` docs.
74	pub eip140_transition: Option<Uint>,
75	/// See `CommonParams` docs.
76	pub eip210_transition: Option<Uint>,
77	/// See `CommonParams` docs.
78	pub eip210_contract_address: Option<Address>,
79	/// See `CommonParams` docs.
80	pub eip210_contract_code: Option<Bytes>,
81	/// See `CommonParams` docs.
82	pub eip210_contract_gas: Option<Uint>,
83	/// See `CommonParams` docs.
84	pub eip211_transition: Option<Uint>,
85	/// See `CommonParams` docs.
86	pub eip145_transition: Option<Uint>,
87	/// See `CommonParams` docs.
88	pub eip214_transition: Option<Uint>,
89	/// See `CommonParams` docs.
90	pub eip658_transition: Option<Uint>,
91	/// See `CommonParams` docs.
92	pub eip1052_transition: Option<Uint>,
93	/// See `CommonParams` docs.
94	pub eip1283_transition: Option<Uint>,
95	/// See `CommonParams` docs.
96	pub eip1283_disable_transition: Option<Uint>,
97	/// See `CommonParams` docs.
98	pub eip1283_reenable_transition: Option<Uint>,
99	/// See `CommonParams` docs.
100	pub eip1014_transition: Option<Uint>,
101	/// See `CommonParams` docs.
102	pub eip1706_transition: Option<Uint>,
103	/// See `CommonParams` docs.
104	pub eip1344_transition: Option<Uint>,
105	/// See `CommonParams` docs.
106	pub eip1884_transition: Option<Uint>,
107	/// See `CommonParams` docs.
108	pub eip2028_transition: Option<Uint>,
109	/// See `CommonParams` docs.
110	pub eip2200_advance_transition: Option<Uint>,
111	/// See `CommonParams` docs.
112	pub dust_protection_transition: Option<Uint>,
113	/// See `CommonParams` docs.
114	pub nonce_cap_increment: Option<Uint>,
115	/// See `CommonParams` docs.
116	pub remove_dust_contracts : Option<bool>,
117	/// See `CommonParams` docs.
118	#[serde(deserialize_with="uint::validate_non_zero")]
119	pub gas_limit_bound_divisor: Uint,
120	/// See `CommonParams` docs.
121	pub tetsy_registrar: Option<Address>,
122	/// Apply reward flag
123	pub apply_reward: Option<bool>,
124	/// Node permission contract address.
125	pub node_permission_contract: Option<Address>,
126	/// See main VapashParams docs.
127	pub max_code_size: Option<Uint>,
128	/// Maximum size of transaction RLP payload.
129	pub max_transaction_size: Option<Uint>,
130	/// See main VapashParams docs.
131	pub max_code_size_transition: Option<Uint>,
132	/// Transaction permission contract address.
133	pub transaction_permission_contract: Option<Address>,
134	/// Block at which the transaction permission contract should start being used.
135	pub transaction_permission_contract_transition: Option<Uint>,
136	/// Wasm activation block height, if not activated from start.
137	pub wasm_activation_transition: Option<Uint>,
138	/// Define a separate wasm version instead of using the prefix.
139	pub wasm_version: Option<Uint>,
140	/// KIP4 activiation block height.
141	pub kip4_transition: Option<Uint>,
142	/// KIP6 activiation block height.
143	pub kip6_transition: Option<Uint>,
144}
145
146#[cfg(test)]
147mod tests {
148	use super::{Params, Uint};
149	use vapory_types::U256;
150
151	#[test]
152	fn params_deserialization() {
153		let s = r#"{
154			"maximumExtraDataSize": "0x20",
155			"networkID": "0x1",
156			"chainID": "0x15",
157			"subprotocolName": "exp",
158			"minGasLimit": "0x1388",
159			"accountStartNonce": "0x01",
160			"gasLimitBoundDivisor": "0x20",
161			"maxCodeSize": "0x1000",
162			"wasmActivationTransition": "0x1010"
163		}"#;
164
165		let deserialized: Params = serde_json::from_str(s).unwrap();
166		assert_eq!(deserialized.maximum_extra_data_size, Uint(U256::from(0x20)));
167		assert_eq!(deserialized.network_id, Uint(U256::from(0x1)));
168		assert_eq!(deserialized.chain_id, Some(Uint(U256::from(0x15))));
169		assert_eq!(deserialized.subprotocol_name, Some("exp".to_owned()));
170		assert_eq!(deserialized.min_gas_limit, Uint(U256::from(0x1388)));
171		assert_eq!(deserialized.account_start_nonce, Some(Uint(U256::from(0x01))));
172		assert_eq!(deserialized.gas_limit_bound_divisor, Uint(U256::from(0x20)));
173		assert_eq!(deserialized.max_code_size, Some(Uint(U256::from(0x1000))));
174		assert_eq!(deserialized.wasm_activation_transition, Some(Uint(U256::from(0x1010))));
175	}
176
177	#[test]
178	#[should_panic(expected = "a non-zero value")]
179	fn test_zero_value_divisor() {
180		let s = r#"{
181			"maximumExtraDataSize": "0x20",
182			"networkID" : "0x1",
183			"chainID" : "0x15",
184			"subprotocolName" : "exp",
185			"minGasLimit": "0x1388",
186			"accountStartNonce": "0x01",
187			"gasLimitBoundDivisor": "0x0",
188			"maxCodeSize": "0x1000"
189		}"#;
190
191		let _deserialized: Params = serde_json::from_str(s).unwrap();
192	}
193}