libkeri 0.1.0

A Rust library for KERI (Key Event Receipt Infrastructure)
Documentation
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
use crate::keri::core::serdering::SadValue;
use crate::keri::KERIError;
use indexmap::IndexMap;
use serde::{Deserialize, Serialize};
use std::default::Default;

/// Corresponds to StateEstEvent namedtuple used as sub record in KeyStateRecord
/// for latest establishment event associated with current key state
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StateEERecord {
    /// Sequence number of latest est evt lowercase hex no leading zeros
    #[serde(default = "default_sequence_number")]
    pub s: String,

    /// SAID qb64 of latest est evt
    #[serde(default)]
    pub d: String,

    /// Backer aids qb64 remove list (cuts) from latest est event
    #[serde(default)]
    pub br: Option<Vec<String>>,

    /// Backer aids qb64 add list (adds) from latest est event
    #[serde(default)]
    pub ba: Option<Vec<String>>,
}

/// Key State information keyed by Identifier Prefix of associated KEL.
/// For local AIDs that correspond to Habs this is the Hab AID.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct KeyStateRecord {
    /// Version number [major, minor]
    #[serde(default)]
    pub vn: Vec<u8>,

    /// Identifier prefix qb64
    #[serde(default)]
    pub i: String,

    /// Sequence number of latest event in KEL as hex str
    #[serde(default = "default_sequence_number")]
    pub s: String,

    /// Prior event digest qb64
    #[serde(default)]
    pub p: String,

    /// Latest event digest qb64
    #[serde(default)]
    pub d: String,

    /// First seen ordinal number of latest event in KEL as hex str
    #[serde(default = "default_sequence_number")]
    pub f: String,

    /// Datetime iso-8601 of key state record update, usually now
    #[serde(default)]
    pub dt: String,

    /// Latest event packet type (ilk)
    #[serde(default)]
    pub et: String,

    /// Signing threshold sith
    #[serde(default = "default_threshold")]
    pub kt: String,

    /// Signing keys qb64
    #[serde(default)]
    pub k: Vec<String>,

    /// Next prerotated threshold sith
    #[serde(default = "default_threshold")]
    pub nt: String,

    /// Pre-rotation keys qb64
    #[serde(default)]
    pub n: Vec<String>,

    /// Backer threshold hex num
    #[serde(default = "default_threshold")]
    pub bt: String,

    /// Backer aids qb64
    #[serde(default)]
    pub b: Vec<String>,

    /// Config traits
    #[serde(default)]
    pub c: Vec<String>,

    /// Establishment event record
    #[serde(default)]
    pub ee: StateEERecord,

    /// Delegator aid qb64 or empty str if not delegated
    #[serde(default)]
    pub di: String,
}

impl Default for StateEERecord {
    fn default() -> Self {
        StateEERecord {
            s: "0".to_string(),
            d: "".to_string(),
            br: None,
            ba: None,
        }
    }
}

impl Default for KeyStateRecord {
    fn default() -> Self {
        KeyStateRecord {
            vn: Vec::new(),
            i: "".to_string(),
            s: "0".to_string(),
            p: "".to_string(),
            d: "".to_string(),
            f: "0".to_string(),
            dt: "".to_string(),
            et: "".to_string(),
            kt: "0".to_string(),
            k: Vec::new(),
            nt: "0".to_string(),
            n: Vec::new(),
            bt: "0".to_string(),
            b: Vec::new(),
            c: Vec::new(),
            ee: StateEERecord::default(),
            di: "".to_string(),
        }
    }
}

/// Helper function to provide default value for sequence numbers
fn default_sequence_number() -> String {
    "0".to_string()
}

/// Helper function to provide default value for thresholds
fn default_threshold() -> String {
    "0".to_string()
}

impl StateEERecord {
    /// Create a new StateEERecord from a StateEstEvent
    pub fn from_state_est_event(event: &StateEstEvent) -> Result<Self, KERIError> {
        Ok(StateEERecord {
            s: event.s.clone(),
            d: event.d.clone(),
            br: event.br.clone(),
            ba: event.ba.clone(),
        })
    }

    /// Convert to a map representation
    pub fn to_map(&self) -> IndexMap<String, SadValue> {
        let mut map = IndexMap::new();
        map.insert("s".to_string(), SadValue::String(self.s.clone()));
        map.insert("d".to_string(), SadValue::String(self.d.clone()));
        map.insert(
            "br".to_string(),
            SadValue::Array(
                self.br
                    .clone()
                    .unwrap()
                    .iter()
                    .map(|s| SadValue::String(s.to_string()))
                    .collect(),
            ),
        );
        map.insert(
            "ba".to_string(),
            SadValue::Array(
                self.ba
                    .clone()
                    .unwrap()
                    .iter()
                    .map(|s| SadValue::String(s.to_string()))
                    .collect(),
            ),
        );

        map
    }

    /// Create from a map representation
    pub fn from_map(map: &IndexMap<String, SadValue>) -> Result<Self, KERIError> {
        let s = match map.get("s") {
            Some(SadValue::String(s)) => s.clone(),
            _ => "0".to_string(),
        };

        let d = match map.get("d") {
            Some(SadValue::String(d)) => d.clone(),
            _ => "".to_string(),
        };

        let br = match map.get("br") {
            Some(SadValue::Array(arr)) => {
                let mut br_vec = Vec::new();
                for item in arr {
                    if let SadValue::String(s) = item {
                        br_vec.push(s.clone());
                    }
                }
                Some(br_vec)
            }
            _ => None,
        };

        let ba = match map.get("ba") {
            Some(SadValue::Array(arr)) => {
                let mut ba_vec = Vec::new();
                for item in arr {
                    if let SadValue::String(s) = item {
                        ba_vec.push(s.clone());
                    }
                }
                Some(ba_vec)
            }
            _ => None,
        };

        Ok(StateEERecord { s, d, br, ba })
    }
}

impl KeyStateRecord {
    /// Convert to a map representation
    pub fn to_map(&self) -> IndexMap<String, SadValue> {
        let mut map = IndexMap::new();
        map.insert(
            "vn".to_string(),
            SadValue::Array(
                self.vn
                    .iter()
                    .map(|n| SadValue::Number(serde_json::Number::from(*n)))
                    .collect(),
            ),
        );
        map.insert("i".to_string(), SadValue::String(self.i.clone()));
        map.insert("s".to_string(), SadValue::String(self.s.clone()));
        map.insert("p".to_string(), SadValue::String(self.p.clone()));
        map.insert("d".to_string(), SadValue::String(self.d.clone()));
        map.insert("f".to_string(), SadValue::String(self.f.clone()));
        map.insert("dt".to_string(), SadValue::String(self.dt.clone()));
        map.insert("et".to_string(), SadValue::String(self.et.clone()));
        map.insert("kt".to_string(), SadValue::String(self.kt.clone()));
        map.insert(
            "k".to_string(),
            SadValue::Array(
                self.k
                    .iter()
                    .map(|s| SadValue::String(s.to_string()))
                    .collect(),
            ),
        );
        map.insert("nt".to_string(), SadValue::String(self.nt.clone()));
        map.insert(
            "n".to_string(),
            SadValue::Array(
                self.n
                    .iter()
                    .map(|s| SadValue::String(s.to_string()))
                    .collect(),
            ),
        );
        map.insert("bt".to_string(), SadValue::String(self.bt.clone()));
        map.insert(
            "b".to_string(),
            SadValue::Array(
                self.b
                    .iter()
                    .map(|s| SadValue::String(s.to_string()))
                    .collect(),
            ),
        );
        map.insert(
            "c".to_string(),
            SadValue::Array(
                self.c
                    .iter()
                    .map(|s| SadValue::String(s.to_string()))
                    .collect(),
            ),
        );
        map.insert("ee".to_string(), SadValue::Object(self.ee.to_map()));
        map.insert("di".to_string(), SadValue::String(self.di.clone()));

        map
    }

    /// Create from a map representation
    pub fn from_map(map: &IndexMap<String, SadValue>) -> Result<Self, KERIError> {
        let vn = match map.get("vn") {
            Some(SadValue::Array(arr)) => {
                let mut vn_vec = Vec::new();
                for item in arr {
                    if let SadValue::Number(n) = item {
                        if let Some(n) = n.as_u64() {
                            vn_vec.push(n as u8);
                        }
                    }
                }
                vn_vec
            }
            _ => Vec::new(),
        };

        let i = match map.get("i") {
            Some(SadValue::String(i)) => i.clone(),
            _ => "".to_string(),
        };

        let s = match map.get("s") {
            Some(SadValue::String(s)) => s.clone(),
            _ => "0".to_string(),
        };

        let p = match map.get("p") {
            Some(SadValue::String(p)) => p.clone(),
            _ => "".to_string(),
        };

        let d = match map.get("d") {
            Some(SadValue::String(d)) => d.clone(),
            _ => "".to_string(),
        };

        let f = match map.get("f") {
            Some(SadValue::String(f)) => f.clone(),
            _ => "0".to_string(),
        };

        let dt = match map.get("dt") {
            Some(SadValue::String(dt)) => dt.clone(),
            _ => "".to_string(),
        };

        let et = match map.get("et") {
            Some(SadValue::String(et)) => et.clone(),
            _ => "".to_string(),
        };

        let kt = match map.get("kt") {
            Some(SadValue::String(kt)) => kt.clone(),
            _ => "0".to_string(),
        };

        let k = match map.get("k") {
            Some(SadValue::Array(arr)) => {
                let mut k_vec = Vec::new();
                for item in arr {
                    if let SadValue::String(s) = item {
                        k_vec.push(s.clone());
                    }
                }
                k_vec
            }
            _ => Vec::new(),
        };

        let nt = match map.get("nt") {
            Some(SadValue::String(nt)) => nt.clone(),
            _ => "0".to_string(),
        };

        let n = match map.get("n") {
            Some(SadValue::Array(arr)) => {
                let mut n_vec = Vec::new();
                for item in arr {
                    if let SadValue::String(s) = item {
                        n_vec.push(s.clone());
                    }
                }
                n_vec
            }
            _ => Vec::new(),
        };

        let bt = match map.get("bt") {
            Some(SadValue::String(bt)) => bt.clone(),
            _ => "0".to_string(),
        };

        let b = match map.get("b") {
            Some(SadValue::Array(arr)) => {
                let mut b_vec = Vec::new();
                for item in arr {
                    if let SadValue::String(s) = item {
                        b_vec.push(s.clone());
                    }
                }
                b_vec
            }
            _ => Vec::new(),
        };

        let c = match map.get("c") {
            Some(SadValue::Array(arr)) => {
                let mut c_vec = Vec::new();
                for item in arr {
                    if let SadValue::String(s) = item {
                        c_vec.push(s.clone());
                    }
                }
                c_vec
            }
            _ => Vec::new(),
        };

        let ee = match map.get("ee") {
            Some(SadValue::Object(obj)) => {
                let ee_map: IndexMap<String, SadValue> =
                    obj.iter().map(|(k, v)| (k.clone(), v.clone())).collect();
                StateEERecord::from_map(&ee_map)?
            }
            _ => StateEERecord::default(),
        };

        let di = match map.get("di") {
            Some(SadValue::String(di)) => di.clone(),
            _ => "".to_string(),
        };

        Ok(KeyStateRecord {
            vn,
            i,
            s,
            p,
            d,
            f,
            dt,
            et,
            kt,
            k,
            nt,
            n,
            bt,
            b,
            c,
            ee,
            di,
        })
    }
}

/// StateEstEvent namedtuple equivalent for latest establishment event
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct StateEstEvent {
    /// Sequence number of latest est evt lowercase hex no leading zeros
    pub s: String,

    /// SAID qb64 of latest est evt
    pub d: String,

    /// Backer aids qb64 remove list (cuts) from latest est event
    #[serde(default)]
    pub br: Option<Vec<String>>,

    /// Backer aids qb64 add list (adds) from latest est event
    #[serde(default)]
    pub ba: Option<Vec<String>>,
}

impl Default for StateEstEvent {
    fn default() -> Self {
        StateEstEvent {
            s: "0".to_string(),
            d: "".to_string(),
            br: None,
            ba: None,
        }
    }
}