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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
// 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/>.

//! Vapash params deserialization.

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

/// Deserializable doppelganger of block rewards for VapashParams
#[derive(Clone, Debug, PartialEq, Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(untagged)]
pub enum BlockReward {
	/// Single block reward
	Single(Uint),
	/// Several block rewards
	Multi(BTreeMap<Uint, Uint>),
}

/// Deserializable doppelganger of VapashParams.
#[derive(Clone, Debug, PartialEq, Deserialize)]
#[serde(deny_unknown_fields)]
#[serde(rename_all = "camelCase")]
pub struct VapashParams {
	/// See main VapashParams docs.
	#[serde(deserialize_with="uint::validate_non_zero")]
	pub minimum_difficulty: Uint,
	/// See main VapashParams docs.
	#[serde(deserialize_with="uint::validate_non_zero")]
	pub difficulty_bound_divisor: Uint,
	/// See main VapashParams docs.
	#[serde(default, deserialize_with="uint::validate_optional_non_zero")]
	pub difficulty_increment_divisor: Option<Uint>,
	/// See main VapashParams docs.
	#[serde(default, deserialize_with="uint::validate_optional_non_zero")]
	pub metropolis_difficulty_increment_divisor: Option<Uint>,
	/// See main VapashParams docs.
	pub duration_limit: Option<Uint>,

	/// See main VapashParams docs.
	pub homestead_transition: Option<Uint>,
	/// Reward per block in wei.
	pub block_reward: Option<BlockReward>,
	/// Block at which the block reward contract should start being used.
	pub block_reward_contract_transition: Option<Uint>,
	/// Block reward contract address (setting the block reward contract
	/// overrides all other block reward parameters).
	pub block_reward_contract_address: Option<Address>,
	/// Block reward code. This overrides the block reward contract address.
	pub block_reward_contract_code: Option<Bytes>,

	/// See main VapashParams docs.
	pub dao_hardfork_transition: Option<Uint>,
	/// See main VapashParams docs.
	pub dao_hardfork_beneficiary: Option<Address>,
	/// See main VapashParams docs.
	pub dao_hardfork_accounts: Option<Vec<Address>>,

	/// See main VapashParams docs.
	pub difficulty_hardfork_transition: Option<Uint>,
	/// See main VapashParams docs.
	#[serde(default, deserialize_with="uint::validate_optional_non_zero")]
	pub difficulty_hardfork_bound_divisor: Option<Uint>,
	/// See main VapashParams docs.
	pub bomb_defuse_transition: Option<Uint>,

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

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

	/// See main VapashParams docs.
	#[serde(default, deserialize_with="uint::validate_optional_non_zero")]
	pub ecip1017_era_rounds: Option<Uint>,

	/// Delays of difficulty bombs.
	pub difficulty_bomb_delays: Option<BTreeMap<Uint, Uint>>,

	/// EXPIP-2 block height
	pub expip2_transition: Option<Uint>,
	/// EXPIP-2 duration limit
	pub expip2_duration_limit: Option<Uint>,
	/// Block to transition to progpow
	pub progpow_transition: Option<Uint>,
}

/// Vapash engine deserialization.
#[derive(Debug, PartialEq, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Vapash {
	/// Vapash params.
	pub params: VapashParams,
}

#[cfg(test)]
mod tests {
	use std::str::FromStr;
	use super::{Address, BlockReward, Vapash, VapashParams, Uint};
	use vapory_types::{H160, U256};

	#[test]
	fn vapash_deserialization() {
		let s = r#"{
			"params": {
				"minimumDifficulty": "0x020000",
				"difficultyBoundDivisor": "0x0800",
				"durationLimit": "0x0d",
				"homesteadTransition": "0x42",
				"blockReward": "0x100",
				"daoHardforkTransition": "0x08",
				"daoHardforkBeneficiary": "0xabcabcabcabcabcabcabcabcabcabcabcabcabca",
				"daoHardforkAccounts": [
					"0x304a554a310c7e546dfe434669c62820b7d83490",
					"0x914d1b8b43e92723e64fd0a06f5bdb8dd9b10c79",
					"0xfe24cdd8648121a43a7c86d289be4dd2951ed49f",
					"0x17802f43a0137c506ba92291391a8a8f207f487d",
					"0xb136707642a4ea12fb4bae820f03d2562ebff487",
					"0xdbe9b615a3ae8709af8b93336ce9b477e4ac0940",
					"0xf14c14075d6c4ed84b86798af0956deef67365b5",
					"0xca544e5c4687d109611d0f8f928b53a25af72448",
					"0xaeeb8ff27288bdabc0fa5ebb731b6f409507516c",
					"0xcbb9d3703e651b0d496cdefb8b92c25aeb2171f7",
					"0xaccc230e8a6e5be9160b8cdf2864dd2a001c28b6",
					"0x2b3455ec7fedf16e646268bf88846bd7a2319bb2",
					"0x4613f3bca5c44ea06337a9e439fbc6d42e501d0a",
					"0xd343b217de44030afaa275f54d31a9317c7f441e",
					"0x84ef4b2357079cd7a7c69fd7a37cd0609a679106",
					"0xda2fef9e4a3230988ff17df2165440f37e8b1708",
					"0xf4c64518ea10f995918a454158c6b61407ea345c",
					"0x7602b46df5390e432ef1c307d4f2c9ff6d65cc97",
					"0xbb9bc244d798123fde783fcc1c72d3bb8c189413",
					"0x807640a13483f8ac783c557fcdf27be11ea4ac7a"
				],
				"difficultyHardforkTransition": "0x59d9",
				"difficultyHardforkBoundDivisor": "0x0200",
				"bombDefuseTransition": "0x41",
				"eip100bTransition": "0x42"
			}
		}"#;

		let deserialized: Vapash = serde_json::from_str(s).unwrap();

		assert_eq!(deserialized, Vapash {
			params: VapashParams {
				minimum_difficulty: Uint(U256::from(0x020000)),
				difficulty_bound_divisor: Uint(U256::from(0x0800)),
				difficulty_increment_divisor: None,
				metropolis_difficulty_increment_divisor: None,
				duration_limit: Some(Uint(U256::from(0x0d))),
				homestead_transition: Some(Uint(U256::from(0x42))),
				block_reward: Some(BlockReward::Single(Uint(U256::from(0x100)))),
				block_reward_contract_address: None,
				block_reward_contract_code: None,
				block_reward_contract_transition: None,
				dao_hardfork_transition: Some(Uint(U256::from(0x08))),
				dao_hardfork_beneficiary: Some(Address(H160::from_str("abcabcabcabcabcabcabcabcabcabcabcabcabca").unwrap())),
				dao_hardfork_accounts: Some(vec![
					Address(H160::from_str("304a554a310c7e546dfe434669c62820b7d83490").unwrap()),
					Address(H160::from_str("914d1b8b43e92723e64fd0a06f5bdb8dd9b10c79").unwrap()),
					Address(H160::from_str("fe24cdd8648121a43a7c86d289be4dd2951ed49f").unwrap()),
					Address(H160::from_str("17802f43a0137c506ba92291391a8a8f207f487d").unwrap()),
					Address(H160::from_str("b136707642a4ea12fb4bae820f03d2562ebff487").unwrap()),
					Address(H160::from_str("dbe9b615a3ae8709af8b93336ce9b477e4ac0940").unwrap()),
					Address(H160::from_str("f14c14075d6c4ed84b86798af0956deef67365b5").unwrap()),
					Address(H160::from_str("ca544e5c4687d109611d0f8f928b53a25af72448").unwrap()),
					Address(H160::from_str("aeeb8ff27288bdabc0fa5ebb731b6f409507516c").unwrap()),
					Address(H160::from_str("cbb9d3703e651b0d496cdefb8b92c25aeb2171f7").unwrap()),
					Address(H160::from_str("accc230e8a6e5be9160b8cdf2864dd2a001c28b6").unwrap()),
					Address(H160::from_str("2b3455ec7fedf16e646268bf88846bd7a2319bb2").unwrap()),
					Address(H160::from_str("4613f3bca5c44ea06337a9e439fbc6d42e501d0a").unwrap()),
					Address(H160::from_str("d343b217de44030afaa275f54d31a9317c7f441e").unwrap()),
					Address(H160::from_str("84ef4b2357079cd7a7c69fd7a37cd0609a679106").unwrap()),
					Address(H160::from_str("da2fef9e4a3230988ff17df2165440f37e8b1708").unwrap()),
					Address(H160::from_str("f4c64518ea10f995918a454158c6b61407ea345c").unwrap()),
					Address(H160::from_str("7602b46df5390e432ef1c307d4f2c9ff6d65cc97").unwrap()),
					Address(H160::from_str("bb9bc244d798123fde783fcc1c72d3bb8c189413").unwrap()),
					Address(H160::from_str("807640a13483f8ac783c557fcdf27be11ea4ac7a").unwrap()),
				]),
				difficulty_hardfork_transition: Some(Uint(U256::from(0x59d9))),
				difficulty_hardfork_bound_divisor: Some(Uint(U256::from(0x0200))),
				bomb_defuse_transition: Some(Uint(U256::from(0x41))),
				eip100b_transition: Some(Uint(U256::from(0x42))),
				ecip1010_pause_transition: None,
				ecip1010_continue_transition: None,
				ecip1017_era_rounds: None,
				expip2_transition: None,
				expip2_duration_limit: None,
				progpow_transition: None,
				difficulty_bomb_delays: None,
			}
		});
	}

	#[test]
	fn vapash_deserialization_missing_optionals() {
		let s = r#"{
			"params": {
				"difficultyBoundDivisor": "0x0800",
				"minimumDifficulty": "0x020000"
			}
		}"#;

		let deserialized: Vapash = serde_json::from_str(s).unwrap();
		assert_eq!(deserialized, Vapash {
			params: VapashParams {
				minimum_difficulty: Uint(U256::from(0x020000)),
				difficulty_bound_divisor: Uint(U256::from(0x0800)),
				difficulty_increment_divisor: None,
				metropolis_difficulty_increment_divisor: None,
				duration_limit: None,
				homestead_transition: None,
				block_reward: None,
				block_reward_contract_address: None,
				block_reward_contract_code: None,
				block_reward_contract_transition: None,
				dao_hardfork_transition: None,
				dao_hardfork_beneficiary: None,
				dao_hardfork_accounts: None,
				difficulty_hardfork_transition: None,
				difficulty_hardfork_bound_divisor: None,
				bomb_defuse_transition: None,
				eip100b_transition: None,
				ecip1010_pause_transition: None,
				ecip1010_continue_transition: None,
				ecip1017_era_rounds: None,
				expip2_transition: None,
				expip2_duration_limit: None,
				progpow_transition: None,
				difficulty_bomb_delays: None,
			}
		});
	}

	#[test]
	#[should_panic(expected = "a non-zero value")]
	fn test_zero_value_divisor() {
		let s = r#"{
			"params": {
				"difficultyBoundDivisor": "0x0",
				"minimumDifficulty": "0x020000"
			}
		}"#;

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