xrpl_binary_codec 0.16.7

Binary serialization for XRPL Protocol objects
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

use super::field_info::FieldInfo;
use crate::serializer::Vec;
use core::fmt;

/// Field data type codes <https://xrpl.org/serialization.html#type-list>
#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd)]
#[repr(u8)]
pub enum TypeCode {
    // Discriminant values can be found at https://xrpl.org/serialization.html#type-list and also at https://github.com/XRPLF/xrpl.js/blob/main/packages/ripple-binary-codec/src/enums/definitions.json
    AccountId = 8,
    Amount = 6,
    Blob = 7,
    Hash128 = 4,
    Hash160 = 17,
    Hash256 = 5,
    UInt8 = 16,
    UInt16 = 1,
    UInt32 = 2,
    UInt64 = 3,
    Array = 15,
    Object = 14,
}

impl fmt::Display for TypeCode {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{:?}", self)
    }
}

/// Field code <https://xrpl.org/serialization.html#field-codes>. The code for a given field can be found at
/// <https://github.com/XRPLF/xrpl.js/blob/main/packages/ripple-binary-codec/src/enums/definitions.json> or
/// <https://github.com/XRPLF/rippled/blob/72e6005f562a8f0818bc94803d222ac9345e1e40/src/ripple/protocol/impl/SField.cpp#L72-L266>
#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd)]
pub struct FieldCode(pub u8);

impl fmt::Display for FieldCode {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

/// Ordered field id <https://xrpl.org/serialization.html#canonical-field-order>
#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd)]
pub struct FieldId {
    /// Type code <https://xrpl.org/serialization.html#type-codes>
    pub type_code: TypeCode,
    /// Field code <https://xrpl.org/serialization.html#field-codes>
    pub field_code: FieldCode,
}

impl FieldId {
    pub fn from_type_field(type_code: TypeCode, field_code: FieldCode) -> Self {
        Self {
            type_code,
            field_code,
        }
    }
}

impl From<FieldInfo> for FieldId {
    fn from(field_info: FieldInfo) -> Self {
        Self {
            type_code: field_info.field_type,
            field_code: field_info.field_code,
        }
    }
}

// #todo temporarily disabled the following clippy warning, implement From instead of Into.
#[allow(clippy::from_over_into)]
// rippled implementation: https://github.com/seelabs/rippled/blob/cecc0ad75849a1d50cc573188ad301ca65519a5b/src/ripple/protocol/impl/Serializer.cpp#L117-L148
impl Into<Vec<u8>> for FieldId {
    fn into(self) -> Vec<u8> {
        let mut header = Vec::new();

        let type_code = self.type_code as u8;
        let field_code = self.field_code.0;

        if type_code < 16 && field_code < 16 {
            header.push(type_code << 4 | field_code);
        } else if type_code < 16 {
            header.push(type_code << 4);
            header.push(field_code);
        } else if field_code < 16 {
            header.push(field_code);
            header.push(type_code);
        } else {
            header.push(0);
            header.push(type_code);
            header.push(field_code);
        }
        header
    }
}