desub-json-resolver 0.0.1

Decode Substrate with Backwards-Compatible Metadata
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

// Copyright 2019-2021 Parity Technologies (UK) Ltd.
// substrate-desub 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.
//
// substrate-desub 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 substrate-desub.  If not, see <http://www.gnu.org/licenses/>.

use crate::{ModuleTypes, Result, TypeRange};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Types that are given priority over those defined in [Modules](struct.Modules.html)
#[derive(Debug, Serialize, Deserialize, Default, Eq, PartialEq, Clone)]
pub struct Overrides {
	/// Type Overrides for modules (where duplication between modules exist)
	#[serde(rename = "TYPES_MODULES")]
	types_modules: HashMap<String, ModuleTypes>,
	/// these are override types for Polkadot & Kusama chains
	/// NOTE The SessionKeys definition for Polkadot and Substrate (OpaqueKeys
	/// implementation) are different. Detect Polkadot and inject the `Keys`
	/// definition as applicable. (4 keys in substrate vs 5 in Polkadot/CC3).
	#[serde(rename = "TYPES_SPEC")]
	// chain(e.g kusama/polkadot) -> Vector of overrides
	types_spec: HashMap<String, Vec<TypeRange>>,
}

impl Overrides {
	/// Construct overrides from JSON
	pub fn new(raw_json: &str) -> Result<Self> {
		serde_json::from_str(raw_json).map_err(Into::into)
	}

	/// get a module types based upon spec
	pub fn get_chain_types(&self, chain: &str, spec: u32) -> Option<&ModuleTypes> {
		self.types_spec.get(chain)?.iter().find(|f| crate::is_in_range(spec, f)).map(|o| &o.types)
	}

	/// get types for a substrate module
	pub fn get_module_types(&self, module: &str) -> Option<&ModuleTypes> {
		self.types_modules.get(module)
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn should_deserialize_into_single_override() {
		let json = r#"
        {
            "minmax": [
                1020,
                1031
            ],
            "types": {
                "BalanceLock": "BalanceLockTo212",
                "DispatchError": "DispatchErrorTo198",
                "Keys": "SessionKeys5",
                "SlashingSpans": "SlashingSpansTo204"
            }
        }
        "#;

		let single_override: TypeRange = serde_json::from_str(json).unwrap();
		dbg!(single_override);
	}

	#[test]
	fn should_deserialize_into_spec() {
		let json = r#"
        {
        "kusama": [
            {
                "minmax": [
                1019,
                1031
                ],
                "types": {
                "BalanceLock": "BalanceLockTo212",
                "DispatchError": "DispatchErrorTo198",
                "Keys": "SessionKeys5",
                "SlashingSpans": "SlashingSpansTo204"
                }
            },
            {
                "minmax": [
                1032,
                1042
                ],
                "types": {
                "BalanceLock": "BalanceLockTo212",
                "Keys": "SessionKeys5",
                "SlashingSpans": "SlashingSpansTo204"
                }
            },
            {
                "minmax": [
                1043,
                null
                ],
                "types": {
                "BalanceLock": "BalanceLockTo212",
                "Keys": "SessionKeys5"
                }
            }
            ],
            "polkadot": [
            {
                "minmax": [
                1000,
                null
                ],
                "types": {
                "Keys": "SessionKeys5"
                }
            }
            ]
        }
        "#;

		let types_spec: HashMap<String, Vec<TypeRange>> = serde_json::from_str(json).unwrap();
		dbg!(types_spec);
	}
}