jam-primitives 0.2.0

JAM protocol primitives
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

//! # Utilities for JAM Protocol
//!
//! This module provides utility functions and re-exports commonly used traits.

/// Codec module re-exporting parity-scale-codec traits
pub mod codec {
    pub use parity_scale_codec::{Compact, Decode, Encode, Input};

    /// Codec trait combining Encode and Decode (re-exported from parity-scale-codec)
    pub trait Codec: Encode + Decode {}

    /// Blanket impl for re-use where required
    impl<T: Encode + Decode> Codec for T {}

    /// Encode a compact u32 (using parity-scale-codec)
    pub fn encode_compact_u32(value: u32) -> Vec<u8> {
        Compact(value).encode()
    }

    /// Decode a compact u32 (using parity-scale-codec)
    pub fn decode_compact_u32<I: Input>(input: &mut I) -> anyhow::Result<u32> {
        let compact = Compact::<u32>::decode(input)?;
        Ok(compact.0)
    }
}

// Re-export commonly used codec traits at the utils level
pub use codec::{Codec, Decode, Encode};

// Basic tests for codec use
#[cfg(test)]
mod codec_tests {
    use super::codec::*;

    #[test]
    fn test_basic_codec() {
        let value = 42u32;
        let encoded = value.encode();
        let decoded = u32::decode(&mut &encoded[..]).unwrap();
        assert_eq!(decoded, value);
    }

    #[test]
    fn test_compact_codec() {
        let value = 42u32;
        let encoded = encode_compact_u32(value);
        let decoded = decode_compact_u32(&mut &encoded[..]).unwrap();
        assert_eq!(decoded, value);
    }
}