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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
use self::serialization::{HexNumber, HexType};
use crate::model::fuel_block::BlockHeight;
use fuel_types::{Address, Bytes32, Color, Salt};
use itertools::Itertools;
use serde::{Deserialize, Serialize};
use serde_with::{serde_as, skip_serializing_none};
use std::{io::ErrorKind, path::PathBuf, str::FromStr};
pub mod serialization;
pub const LOCAL_TESTNET: &str = "local_testnet";
pub const TESTNET_INITIAL_BALANCE: u64 = 10_000_000;
#[skip_serializing_none]
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
pub struct ChainConfig {
pub chain_name: String,
pub block_production: ProductionStrategy,
pub parent_network: BaseChainConfig,
#[serde(default)]
pub initial_state: Option<StateConfig>,
}
impl ChainConfig {
pub fn local_testnet() -> Self {
let initial_coins = (1..10)
.map(|idx| CoinConfig {
tx_id: None,
output_index: None,
block_created: None,
maturity: None,
owner: Address::new([idx; 32]),
amount: TESTNET_INITIAL_BALANCE,
color: Default::default(),
})
.collect_vec();
Self {
chain_name: LOCAL_TESTNET.to_string(),
block_production: ProductionStrategy::Instant,
parent_network: BaseChainConfig::LocalTest,
initial_state: Some(StateConfig {
coins: Some(initial_coins),
..StateConfig::default()
}),
}
}
}
impl FromStr for ChainConfig {
type Err = std::io::Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
LOCAL_TESTNET => Ok(Self::local_testnet()),
s => {
let path = PathBuf::from(s.to_string());
let contents = std::fs::read(path)?;
serde_json::from_slice(&contents)
.map_err(|e| std::io::Error::new(ErrorKind::InvalidData, e))
}
}
}
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
pub enum ProductionStrategy {
Instant,
Manual,
RoundRobin,
ProofOfStake,
}
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
#[serde(tag = "type")]
pub enum BaseChainConfig {
LocalTest,
Ethereum,
}
#[serde_as]
#[skip_serializing_none]
#[derive(Clone, Debug, Default, Deserialize, Serialize, PartialEq)]
pub struct StateConfig {
pub coins: Option<Vec<CoinConfig>>,
pub contracts: Option<Vec<ContractConfig>>,
#[serde_as(as = "Option<HexNumber>")]
#[serde(default)]
pub height: Option<BlockHeight>,
}
#[skip_serializing_none]
#[serde_as]
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
pub struct CoinConfig {
#[serde_as(as = "Option<HexType>")]
#[serde(default)]
pub tx_id: Option<Bytes32>,
#[serde_as(as = "Option<HexNumber>")]
#[serde(default)]
pub output_index: Option<u64>,
#[serde_as(as = "Option<HexNumber>")]
#[serde(default)]
pub block_created: Option<BlockHeight>,
#[serde_as(as = "Option<HexNumber>")]
#[serde(default)]
pub maturity: Option<BlockHeight>,
#[serde_as(as = "HexType")]
pub owner: Address,
#[serde_as(as = "HexNumber")]
pub amount: u64,
#[serde_as(as = "HexType")]
pub color: Color,
}
#[skip_serializing_none]
#[serde_as]
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
pub struct ContractConfig {
#[serde_as(as = "HexType")]
pub code: Vec<u8>,
#[serde_as(as = "HexType")]
pub salt: Salt,
#[serde_as(as = "Option<Vec<(HexType, HexType)>>")]
#[serde(default)]
pub state: Option<Vec<(Bytes32, Bytes32)>>,
#[serde_as(as = "Option<Vec<(HexType, HexNumber)>>")]
#[serde(default)]
pub balances: Option<Vec<(Color, u64)>>,
}
#[cfg(test)]
mod tests {
use super::*;
use fuel_asm::Opcode;
use fuel_vm::prelude::Contract;
use rand::prelude::StdRng;
use rand::{Rng, RngCore, SeedableRng};
use std::env::temp_dir;
use std::fs::write;
#[test]
fn from_str_loads_from_file() {
let tmp_file = tmp_path();
let disk_config = ChainConfig::local_testnet();
let json = serde_json::to_string_pretty(&disk_config).unwrap();
write(tmp_file.clone(), json).unwrap();
let load_config: ChainConfig = tmp_file.to_string_lossy().into_owned().parse().unwrap();
assert_eq!(disk_config, load_config);
}
#[test]
fn snapshot_local_testnet_config() {
let config = ChainConfig::local_testnet();
let json = serde_json::to_string_pretty(&config).unwrap();
insta::assert_snapshot!(json);
}
#[test]
fn can_roundtrip_serialize_local_testnet_config() {
let config = ChainConfig::local_testnet();
let json = serde_json::to_string(&config).unwrap();
let deserialized_config: ChainConfig = serde_json::from_str(json.as_str()).unwrap();
assert_eq!(config, deserialized_config);
}
#[test]
fn snapshot_configurable_block_height() {
let mut rng = StdRng::seed_from_u64(2);
let config = ChainConfig {
initial_state: Some(StateConfig {
height: Some(rng.next_u32().into()),
..Default::default()
}),
..ChainConfig::local_testnet()
};
let json = serde_json::to_string_pretty(&config).unwrap();
insta::assert_snapshot!(json);
}
#[test]
fn can_roundtrip_serialize_block_height_config() {
let mut rng = StdRng::seed_from_u64(2);
let config = ChainConfig {
initial_state: Some(StateConfig {
height: Some(rng.next_u32().into()),
..Default::default()
}),
..ChainConfig::local_testnet()
};
let json = serde_json::to_string(&config).unwrap();
let deserialized_config: ChainConfig = serde_json::from_str(json.as_str()).unwrap();
assert_eq!(config, deserialized_config);
}
#[test]
fn snapshot_simple_contract() {
let config = test_config_contract(false, false);
let json = serde_json::to_string_pretty(&config).unwrap();
insta::assert_snapshot!(json);
}
#[test]
fn can_roundtrip_simple_contract() {
let config = test_config_contract(false, false);
let json = serde_json::to_string(&config).unwrap();
let deserialized_config: ChainConfig = serde_json::from_str(json.as_str()).unwrap();
assert_eq!(config, deserialized_config);
}
#[test]
fn snapshot_contract_with_state() {
let config = test_config_contract(true, false);
let json = serde_json::to_string_pretty(&config).unwrap();
insta::assert_snapshot!(json);
}
#[test]
fn can_roundtrip_contract_with_state() {
let config = test_config_contract(true, false);
let json = serde_json::to_string(&config).unwrap();
let deserialized_config: ChainConfig = serde_json::from_str(json.as_str()).unwrap();
assert_eq!(config, deserialized_config);
}
#[test]
fn snapshot_contract_with_balances() {
let config = test_config_contract(false, true);
let json = serde_json::to_string_pretty(&config).unwrap();
insta::assert_snapshot!(json);
}
#[test]
fn can_roundtrip_contract_with_balances() {
let config = test_config_contract(false, true);
let json = serde_json::to_string(&config).unwrap();
let deserialized_config: ChainConfig = serde_json::from_str(json.as_str()).unwrap();
assert_eq!(config, deserialized_config);
}
#[test]
fn snapshot_simple_coin_state() {
let config = test_config_coin_state();
let json = serde_json::to_string_pretty(&config).unwrap();
insta::assert_snapshot!(json);
}
#[test]
fn can_roundtrip_simple_coin_state() {
let config = test_config_coin_state();
let json = serde_json::to_string(&config).unwrap();
let deserialized_config: ChainConfig = serde_json::from_str(json.as_str()).unwrap();
assert_eq!(config, deserialized_config);
}
fn test_config_contract(state: bool, balances: bool) -> ChainConfig {
let mut rng = StdRng::seed_from_u64(1);
let state = if state {
let test_key: Bytes32 = rng.gen();
let test_value: Bytes32 = rng.gen();
Some(vec![(test_key, test_value)])
} else {
None
};
let balances = if balances {
let test_color: Color = rng.gen();
let test_balance: u64 = rng.next_u64();
Some(vec![(test_color, test_balance)])
} else {
None
};
let contract = Contract::from(Opcode::RET(0x10).to_bytes().to_vec());
ChainConfig {
initial_state: Some(StateConfig {
contracts: Some(vec![ContractConfig {
code: contract.into(),
salt: Default::default(),
state,
balances,
}]),
..Default::default()
}),
..ChainConfig::local_testnet()
}
}
fn test_config_coin_state() -> ChainConfig {
let mut rng = StdRng::seed_from_u64(1);
let tx_id: Option<Bytes32> = Some(rng.gen());
let output_index: Option<u64> = Some(rng.gen());
let block_created = Some(rng.next_u32().into());
let maturity = Some(rng.next_u32().into());
let owner = rng.gen();
let amount = rng.gen();
let color = rng.gen();
ChainConfig {
initial_state: Some(StateConfig {
coins: Some(vec![CoinConfig {
tx_id,
output_index,
block_created,
maturity,
owner,
amount,
color,
}]),
..Default::default()
}),
..ChainConfig::local_testnet()
}
}
fn tmp_path() -> PathBuf {
let mut path = temp_dir();
path.push(rand::random::<u16>().to_string());
path
}
}