/
config_store.rs
260 lines (226 loc) · 10.7 KB
/
config_store.rs
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
use crate::runtime::config::RuntimeConfig;
use crate::runtime::parameter_table::{ParameterTable, ParameterTableDiff};
use crate::types::ProtocolVersion;
use std::collections::BTreeMap;
use std::ops::Bound;
use std::sync::Arc;
macro_rules! include_config {
($file:expr) => {
include_str!(concat!("../../res/runtime_configs/", $file))
};
}
/// The base config file with all initial parameter values defined.
/// Later version are calculated by applying diffs to this base.
static BASE_CONFIG: &str = include_config!("parameters.txt");
/// Stores pairs of protocol versions for which runtime config was updated and
/// the file containing the diffs in bytes.
static CONFIG_DIFFS: &[(ProtocolVersion, &str)] = &[
(42, include_config!("42.txt")),
(48, include_config!("48.txt")),
(49, include_config!("49.txt")),
(50, include_config!("50.txt")),
// max_gas_burnt increased to 300 TGas
(52, include_config!("52.txt")),
// Increased deployment costs, increased wasmer2 stack_limit, added limiting of contract locals,
// set read_cached_trie_node cost, decrease storage key limit
(53, include_config!("53.txt")),
(57, include_config!("57.txt")),
];
/// Testnet parameters for versions <= 29, which (incorrectly) differed from mainnet parameters
pub static INITIAL_TESTNET_CONFIG: &str = include_config!("parameters_testnet.txt");
/// Stores runtime config for each protocol version where it was updated.
#[derive(Debug)]
pub struct RuntimeConfigStore {
/// Maps protocol version to the config.
store: BTreeMap<ProtocolVersion, Arc<RuntimeConfig>>,
}
impl RuntimeConfigStore {
/// Constructs a new store.
///
/// If genesis_runtime_config is Some, configs for protocol versions 0 and 42 are overridden by
/// this config and config with lowered storage cost, respectively.
/// This is done to preserve compatibility with previous implementation, where we updated
/// runtime config by sequential modifications to the genesis runtime config.
/// TODO #4775: introduce new protocol version to have the same runtime config for all chains
pub fn new(genesis_runtime_config: Option<&RuntimeConfig>) -> Self {
let mut params: ParameterTable =
BASE_CONFIG.parse().expect("Failed parsing base parameter file.");
let mut store = BTreeMap::new();
let initial_config = RuntimeConfig::new(¶ms).unwrap_or_else(|err| panic!("Failed generating `RuntimeConfig` from parameters for base parameter file. Error: {err}"));
store.insert(0, Arc::new(initial_config));
for (protocol_version, diff_bytes) in CONFIG_DIFFS {
let diff :ParameterTableDiff= diff_bytes.parse().unwrap_or_else(|err| panic!("Failed parsing runtime parameters diff for version {protocol_version}. Error: {err}"));
params.apply_diff(diff).unwrap_or_else(|err| panic!("Failed applying diff to `RuntimeConfig` for version {protocol_version}. Error: {err}"));
store.insert(
*protocol_version,
Arc::new(RuntimeConfig::new(¶ms).unwrap_or_else(|err| panic!("Failed generating `RuntimeConfig` from parameters for version {protocol_version}. Error: {err}"))),
);
}
if let Some(runtime_config) = genesis_runtime_config {
let mut config = runtime_config.clone();
store.insert(0, Arc::new(config.clone()));
config.storage_amount_per_byte = 10u128.pow(19);
store.insert(42, Arc::new(config));
}
Self { store }
}
/// Constructs test store.
pub fn with_one_config(runtime_config: RuntimeConfig) -> Self {
Self { store: BTreeMap::from_iter([(0, Arc::new(runtime_config))].iter().cloned()) }
}
/// Constructs test store.
pub fn test() -> Self {
Self::with_one_config(RuntimeConfig::test())
}
/// Constructs store with a single config with zero costs.
pub fn free() -> Self {
Self::with_one_config(RuntimeConfig::free())
}
/// Returns a `RuntimeConfig` for the corresponding protocol version.
pub fn get_config(&self, protocol_version: ProtocolVersion) -> &Arc<RuntimeConfig> {
self.store
.range((Bound::Unbounded, Bound::Included(protocol_version)))
.next_back()
.unwrap_or_else(|| {
panic!("Not found RuntimeConfig for protocol version {}", protocol_version)
})
.1
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::version::ProtocolFeature::{
LowerDataReceiptAndEcrecoverBaseCost, LowerStorageCost, LowerStorageKeyLimit,
};
const GENESIS_PROTOCOL_VERSION: ProtocolVersion = 29;
const RECEIPTS_DEPTH: u64 = 63;
#[test]
fn test_max_prepaid_gas() {
let store = RuntimeConfigStore::new(None);
for (protocol_version, config) in store.store.iter() {
assert!(
config.wasm_config.limit_config.max_total_prepaid_gas
/ config.transaction_costs.min_receipt_with_function_call_gas()
<= 63,
"The maximum desired depth of receipts for protocol version {} should be at most {}",
protocol_version,
RECEIPTS_DEPTH
);
}
}
#[test]
fn test_lower_storage_cost() {
let store = RuntimeConfigStore::new(None);
let base_cfg = store.get_config(GENESIS_PROTOCOL_VERSION);
let new_cfg = store.get_config(LowerStorageCost.protocol_version());
assert!(base_cfg.storage_amount_per_byte > new_cfg.storage_amount_per_byte);
}
#[test]
fn test_override_account_length() {
// Check that default value is 32.
let base_store = RuntimeConfigStore::new(None);
let base_cfg = base_store.get_config(GENESIS_PROTOCOL_VERSION);
assert_eq!(base_cfg.account_creation_config.min_allowed_top_level_account_length, 32);
let mut cfg = base_cfg.as_ref().clone();
cfg.account_creation_config.min_allowed_top_level_account_length = 0;
// Check that length was changed.
let new_store = RuntimeConfigStore::new(Some(&cfg));
let new_cfg = new_store.get_config(GENESIS_PROTOCOL_VERSION);
assert_eq!(new_cfg.account_creation_config.min_allowed_top_level_account_length, 0);
}
#[test]
fn test_lower_data_receipt_cost() {
let store = RuntimeConfigStore::new(None);
let base_cfg = store.get_config(LowerStorageCost.protocol_version());
let new_cfg = store.get_config(LowerDataReceiptAndEcrecoverBaseCost.protocol_version());
assert!(
base_cfg.transaction_costs.data_receipt_creation_config.base_cost.send_sir
> new_cfg.transaction_costs.data_receipt_creation_config.base_cost.send_sir
);
assert!(
base_cfg.transaction_costs.data_receipt_creation_config.cost_per_byte.send_sir
> new_cfg.transaction_costs.data_receipt_creation_config.cost_per_byte.send_sir
);
}
// Check that for protocol version with lowered data receipt cost, runtime config passed to
// config store is overridden.
#[test]
fn test_override_runtime_config() {
let store = RuntimeConfigStore::new(None);
let config = store.get_config(0);
let mut base_params = BASE_CONFIG.parse().unwrap();
let base_config = RuntimeConfig::new(&base_params).unwrap();
assert_eq!(config.as_ref(), &base_config);
let config = store.get_config(LowerStorageCost.protocol_version());
assert_eq!(base_config.storage_amount_per_byte, 100_000_000_000_000_000_000u128);
assert_eq!(config.storage_amount_per_byte, 10_000_000_000_000_000_000u128);
assert_eq!(
config.transaction_costs.data_receipt_creation_config.base_cost.send_sir,
4_697_339_419_375
);
assert_ne!(config.as_ref(), &base_config);
assert_ne!(
config.as_ref(),
store.get_config(LowerStorageCost.protocol_version() - 1).as_ref()
);
let expected_config = {
let first_diff = CONFIG_DIFFS[0].1.parse().unwrap();
base_params.apply_diff(first_diff).unwrap();
RuntimeConfig::new(&base_params).unwrap()
};
assert_eq!(**config, expected_config);
let config = store.get_config(LowerDataReceiptAndEcrecoverBaseCost.protocol_version());
assert_eq!(
config.transaction_costs.data_receipt_creation_config.base_cost.send_sir,
36_486_732_312
);
let expected_config = {
let second_diff = CONFIG_DIFFS[1].1.parse().unwrap();
base_params.apply_diff(second_diff).unwrap();
RuntimeConfig::new(&base_params).unwrap()
};
assert_eq!(config.as_ref(), &expected_config);
}
#[test]
fn test_lower_ecrecover_base_cost() {
let store = RuntimeConfigStore::new(None);
let base_cfg = store.get_config(LowerStorageCost.protocol_version());
let new_cfg = store.get_config(LowerDataReceiptAndEcrecoverBaseCost.protocol_version());
assert!(
base_cfg.wasm_config.ext_costs.ecrecover_base
> new_cfg.wasm_config.ext_costs.ecrecover_base
);
}
#[test]
fn test_lower_max_length_storage_key() {
let store = RuntimeConfigStore::new(None);
let base_cfg = store.get_config(LowerStorageKeyLimit.protocol_version() - 1);
let new_cfg = store.get_config(LowerStorageKeyLimit.protocol_version());
assert!(
base_cfg.wasm_config.limit_config.max_length_storage_key
> new_cfg.wasm_config.limit_config.max_length_storage_key
);
}
/// Use snapshot testing to check that the JSON representation of the
/// configurations of each version is unchanged.
/// If tests fail after an intended change, run `cargo insta review` accept
/// the new snapshot if it looks right.
#[test]
#[cfg(not(feature = "nightly"))]
fn test_json_unchanged() {
let store = RuntimeConfigStore::new(None);
for version in store.store.keys() {
let snapshot_name = format!("{version}.json");
insta::assert_json_snapshot!(snapshot_name, store.get_config(*version));
}
// Testnet initial config for old version was different, thus needs separate testing
let params = INITIAL_TESTNET_CONFIG.parse().unwrap();
let new_genesis_runtime_config = RuntimeConfig::new(¶ms).unwrap();
let testnet_store = RuntimeConfigStore::new(Some(&new_genesis_runtime_config));
for version in testnet_store.store.keys() {
let snapshot_name = format!("testnet_{version}.json");
insta::assert_json_snapshot!(snapshot_name, store.get_config(*version));
}
}
}