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
334
335
use alloc::{
collections::{btree_map::Entry, BTreeMap, BTreeSet},
vec::Vec,
};
use serde::{Deserialize, Serialize};
use crate::{
account::{AccountHash, AddKeyFailure, RemoveKeyFailure, UpdateKeyFailure, Weight},
bytesrepr::{Error, FromBytes, ToBytes},
};
#[derive(Default, PartialOrd, Ord, PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct AssociatedKeys(BTreeMap<AccountHash, Weight>);
impl AssociatedKeys {
pub fn new(key: AccountHash, weight: Weight) -> AssociatedKeys {
let mut bt: BTreeMap<AccountHash, Weight> = BTreeMap::new();
bt.insert(key, weight);
AssociatedKeys(bt)
}
pub fn add_key(&mut self, key: AccountHash, weight: Weight) -> Result<(), AddKeyFailure> {
match self.0.entry(key) {
Entry::Vacant(entry) => {
entry.insert(weight);
}
Entry::Occupied(_) => return Err(AddKeyFailure::DuplicateKey),
}
Ok(())
}
pub fn remove_key(&mut self, key: &AccountHash) -> Result<(), RemoveKeyFailure> {
self.0
.remove(key)
.map(|_| ())
.ok_or(RemoveKeyFailure::MissingKey)
}
pub fn update_key(&mut self, key: AccountHash, weight: Weight) -> Result<(), UpdateKeyFailure> {
match self.0.entry(key) {
Entry::Vacant(_) => {
return Err(UpdateKeyFailure::MissingKey);
}
Entry::Occupied(mut entry) => {
*entry.get_mut() = weight;
}
}
Ok(())
}
pub fn get(&self, key: &AccountHash) -> Option<&Weight> {
self.0.get(key)
}
pub fn contains_key(&self, key: &AccountHash) -> bool {
self.0.contains_key(key)
}
pub fn iter(&self) -> impl Iterator<Item = (&AccountHash, &Weight)> {
self.0.iter()
}
pub fn len(&self) -> usize {
self.0.len()
}
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
fn calculate_any_keys_weight<'a>(&self, keys: impl Iterator<Item = &'a AccountHash>) -> Weight {
let total = keys
.filter_map(|key| self.0.get(key))
.fold(0u8, |acc, w| acc.saturating_add(w.value()));
Weight::new(total)
}
pub fn calculate_keys_weight(&self, authorization_keys: &BTreeSet<AccountHash>) -> Weight {
self.calculate_any_keys_weight(authorization_keys.iter())
}
pub fn total_keys_weight(&self) -> Weight {
self.calculate_any_keys_weight(self.0.keys())
}
pub fn total_keys_weight_excluding(&self, account_hash: AccountHash) -> Weight {
self.calculate_any_keys_weight(self.0.keys().filter(|&&element| element != account_hash))
}
}
impl From<BTreeMap<AccountHash, Weight>> for AssociatedKeys {
fn from(associated_keys: BTreeMap<AccountHash, Weight>) -> Self {
Self(associated_keys)
}
}
impl ToBytes for AssociatedKeys {
fn to_bytes(&self) -> Result<Vec<u8>, Error> {
self.0.to_bytes()
}
fn serialized_length(&self) -> usize {
self.0.serialized_length()
}
}
impl FromBytes for AssociatedKeys {
fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error> {
let (associated_keys, rem) = FromBytes::from_bytes(bytes)?;
Ok((AssociatedKeys(associated_keys), rem))
}
}
#[doc(hidden)]
#[cfg(any(feature = "gens", test))]
pub mod gens {
use proptest::prelude::*;
use crate::gens::{account_hash_arb, weight_arb};
use super::AssociatedKeys;
pub fn associated_keys_arb() -> impl Strategy<Value = AssociatedKeys> {
proptest::collection::btree_map(account_hash_arb(), weight_arb(), 10).prop_map(|keys| {
let mut associated_keys = AssociatedKeys::default();
keys.into_iter().for_each(|(k, v)| {
associated_keys.add_key(k, v).unwrap();
});
associated_keys
})
}
}
#[cfg(test)]
mod tests {
use std::{collections::BTreeSet, iter::FromIterator};
use crate::{
account::{AccountHash, AddKeyFailure, Weight, ACCOUNT_HASH_LENGTH},
bytesrepr,
};
use super::*;
#[test]
fn associated_keys_add() {
let mut keys =
AssociatedKeys::new(AccountHash::new([0u8; ACCOUNT_HASH_LENGTH]), Weight::new(1));
let new_pk = AccountHash::new([1u8; ACCOUNT_HASH_LENGTH]);
let new_pk_weight = Weight::new(2);
assert!(keys.add_key(new_pk, new_pk_weight).is_ok());
assert_eq!(keys.get(&new_pk), Some(&new_pk_weight))
}
#[test]
fn associated_keys_add_duplicate() {
let pk = AccountHash::new([0u8; ACCOUNT_HASH_LENGTH]);
let weight = Weight::new(1);
let mut keys = AssociatedKeys::new(pk, weight);
assert_eq!(
keys.add_key(pk, Weight::new(10)),
Err(AddKeyFailure::DuplicateKey)
);
assert_eq!(keys.get(&pk), Some(&weight));
}
#[test]
fn associated_keys_remove() {
let pk = AccountHash::new([0u8; ACCOUNT_HASH_LENGTH]);
let weight = Weight::new(1);
let mut keys = AssociatedKeys::new(pk, weight);
assert!(keys.remove_key(&pk).is_ok());
assert!(keys
.remove_key(&AccountHash::new([1u8; ACCOUNT_HASH_LENGTH]))
.is_err());
}
#[test]
fn associated_keys_update() {
let pk1 = AccountHash::new([0u8; ACCOUNT_HASH_LENGTH]);
let pk2 = AccountHash::new([1u8; ACCOUNT_HASH_LENGTH]);
let weight = Weight::new(1);
let mut keys = AssociatedKeys::new(pk1, weight);
assert!(matches!(
keys.update_key(pk2, Weight::new(2))
.expect_err("should get error"),
UpdateKeyFailure::MissingKey
));
keys.add_key(pk2, Weight::new(1)).unwrap();
assert_eq!(keys.get(&pk2), Some(&Weight::new(1)));
keys.update_key(pk2, Weight::new(2)).unwrap();
assert_eq!(keys.get(&pk2), Some(&Weight::new(2)));
}
#[test]
fn associated_keys_calculate_keys_once() {
let key_1 = AccountHash::new([0; 32]);
let key_2 = AccountHash::new([1; 32]);
let key_3 = AccountHash::new([2; 32]);
let mut keys = AssociatedKeys::default();
keys.add_key(key_2, Weight::new(2))
.expect("should add key_1");
keys.add_key(key_1, Weight::new(1))
.expect("should add key_1");
keys.add_key(key_3, Weight::new(3))
.expect("should add key_1");
assert_eq!(
keys.calculate_keys_weight(&BTreeSet::from_iter(vec![
key_1, key_2, key_3, key_1, key_2, key_3,
])),
Weight::new(1 + 2 + 3)
);
}
#[test]
fn associated_keys_total_weight() {
let associated_keys = {
let mut res = AssociatedKeys::new(AccountHash::new([1u8; 32]), Weight::new(1));
res.add_key(AccountHash::new([2u8; 32]), Weight::new(11))
.expect("should add key 1");
res.add_key(AccountHash::new([3u8; 32]), Weight::new(12))
.expect("should add key 2");
res.add_key(AccountHash::new([4u8; 32]), Weight::new(13))
.expect("should add key 3");
res
};
assert_eq!(
associated_keys.total_keys_weight(),
Weight::new(1 + 11 + 12 + 13)
);
}
#[test]
fn associated_keys_total_weight_excluding() {
let identity_key = AccountHash::new([1u8; 32]);
let identity_key_weight = Weight::new(1);
let key_1 = AccountHash::new([2u8; 32]);
let key_1_weight = Weight::new(11);
let key_2 = AccountHash::new([3u8; 32]);
let key_2_weight = Weight::new(12);
let key_3 = AccountHash::new([4u8; 32]);
let key_3_weight = Weight::new(13);
let associated_keys = {
let mut res = AssociatedKeys::new(identity_key, identity_key_weight);
res.add_key(key_1, key_1_weight).expect("should add key 1");
res.add_key(key_2, key_2_weight).expect("should add key 2");
res.add_key(key_3, key_3_weight).expect("should add key 3");
res
};
assert_eq!(
associated_keys.total_keys_weight_excluding(key_2),
Weight::new(identity_key_weight.value() + key_1_weight.value() + key_3_weight.value())
);
}
#[test]
fn overflowing_keys_weight() {
let identity_key = AccountHash::new([1u8; 32]);
let key_1 = AccountHash::new([2u8; 32]);
let key_2 = AccountHash::new([3u8; 32]);
let key_3 = AccountHash::new([4u8; 32]);
let identity_key_weight = Weight::new(250);
let weight_1 = Weight::new(1);
let weight_2 = Weight::new(2);
let weight_3 = Weight::new(3);
let saturated_weight = Weight::new(u8::max_value());
let associated_keys = {
let mut res = AssociatedKeys::new(identity_key, identity_key_weight);
res.add_key(key_1, weight_1).expect("should add key 1");
res.add_key(key_2, weight_2).expect("should add key 2");
res.add_key(key_3, weight_3).expect("should add key 3");
res
};
assert_eq!(
associated_keys.calculate_keys_weight(&BTreeSet::from_iter(vec![
identity_key,
key_1,
key_2,
key_3,
])),
saturated_weight,
);
}
#[test]
fn serialization_roundtrip() {
let mut keys = AssociatedKeys::default();
keys.add_key(AccountHash::new([1; 32]), Weight::new(1))
.unwrap();
keys.add_key(AccountHash::new([2; 32]), Weight::new(2))
.unwrap();
keys.add_key(AccountHash::new([3; 32]), Weight::new(3))
.unwrap();
bytesrepr::test_serialization_roundtrip(&keys);
}
}