clvmr 0.18.0

Implementation of `clvm` for Chia Network's cryptocurrency
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

use crate::allocator::{Allocator, NodePtr};
use crate::error::Result;
use crate::serde::bytes32::Bytes32;
use crate::serde::intern::intern_tree;
use crate::serde::node_from_bytes_backrefs;
use crate::serde::node_to_bytes;
use crate::serde::object_cache::{ObjectCache, treehash};
use rstest::rstest;

fn treehash_for_node(allocator: &Allocator, node: NodePtr) -> Bytes32 {
    let mut object_cache = ObjectCache::new(treehash);
    *object_cache
        .get_or_calculate(allocator, &node, None)
        .unwrap()
}

/// Helper to convert hex string directly to a node
fn hex_to_node(allocator: &mut Allocator, hex: &str) -> Result<crate::allocator::NodePtr> {
    let bytes = hex::decode(hex.trim().replace([' ', '\n'], "")).expect("invalid hex");
    node_from_bytes_backrefs(allocator, &bytes)
}

/// Helper to deserialize hex and create interned version, returning intern stats
fn test_hex_interning(hex: &str, expected_atoms: usize, expected_pairs: usize) -> Result<()> {
    let mut allocator = Allocator::new();

    // Deserialize from hex
    let node = hex_to_node(&mut allocator, hex)?;

    // Create interned version using the new API
    let tree = intern_tree(&allocator, node)?;

    // Ensure interned node serializes to same bytes
    let original_serialized = node_to_bytes(&allocator, node)?;
    let new_serialized = node_to_bytes(&tree.allocator, tree.root)?;
    assert_eq!(
        original_serialized, new_serialized,
        "Serialized bytes do not match after interning."
    );

    // Ensure treehashes match
    let original_treehash = treehash_for_node(&allocator, node);
    let new_treehash = tree.tree_hash();
    assert_eq!(
        original_treehash, new_treehash,
        "Treehashes do not match after interning."
    );

    // Verify unique atom and pair counts
    assert_eq!(
        tree.atoms.len(),
        expected_atoms,
        "Atom count doesn't match expected.\nGot:      {:?}\nExpected: {:?}",
        tree.atoms.len(),
        expected_atoms
    );
    assert_eq!(
        tree.pairs.len(),
        expected_pairs,
        "Pair count doesn't match expected.\nGot:      {:?}\nExpected: {:?}",
        tree.pairs.len(),
        expected_pairs
    );

    Ok(())
}

// ========================================================
// Hex-based test cases with intern statistics verification
// ========================================================

#[rstest]
#[case("01", 1, 0)] // Simple atom 1: 1 atom, 0 pairs
#[case("0a", 1, 0)] // Atom 10: 1 atom, 0 pairs
#[case("ff0101", 1, 1)] // (1 . 1): 1 atom (deduplicated), 1 pair
#[case("ff010a", 2, 1)] // (1 . 10): 2 atoms, 1 pair
#[case("ff01ff0101", 1, 2)] // (1 . (1 . 1)): 1 atom (deduplicated), 2 pairs
#[case("ffff2a2a2a", 1, 2)] // ((42 . 42) . 42): 1 atom (deduplicated), 2 pairs
#[case("ff01ff02ff0301", 3, 3)] // (1 . (2 . (3 . 1))): 3 atoms, 3 pairs
#[case("ff01ff02ff0300", 4, 3)] // (1 . (2 . (3 . nil))): 4 atoms (1,2,3,nil), 3 pairs
#[case("ff01ff02ff0304", 4, 3)] // (1 . (2 . (3 . 4))): 4 atoms, 3 pairs
#[case("ff01ff02ff0103", 3, 3)] // (1 . (2 . (1 . 3))): 3 atoms (1 repeated), 3 pairs
#[case("ffff0102ff0102", 2, 2)] // ((1 . 2) . (1 . 2)): repeated pair, 2 atoms, 2 pairs
#[case("ffff0102ffff0102ff0102", 2, 3)] // ((1 . 2) . ((1 . 2) . (1 . 2))): same pair 3×, 2 atoms, 3 pairs
#[case("ffff0102ffff010200", 3, 3)] // ((1 . 2) . ((1 . 2) . nil)): list with repeated pair, 3 atoms, 3 pairs
#[case("ffff010aff010a", 2, 2)] // ((1 . 10) . (1 . 10)): repeated pair (different atoms), 2 atoms, 2 pairs
#[case("00", 1, 0)] // nil: single nil atom, 0 pairs
#[case("ff0100", 2, 1)] // (1 . nil): minimal list of one element, 2 atoms, 1 pair
#[case("ff0000", 1, 1)] // (nil . nil): pair of nils, 1 atom (nil), 1 pair
#[case("ff01ff01ff0100", 2, 3)] // (1 . (1 . (1 . nil))): list [1,1,1], 2 atoms, 3 pairs
#[case("ff01ff01ff0101", 1, 3)] // (1 . (1 . (1 . 1))): atom 1 repeated 3× in pairs, 1 atom, 3 pairs
#[case("ffff01ff0203ff01ff0203", 3, 3)] // ((1.(2.3)) . (1.(2.3))): nested pair repeated, 3 atoms, 3 pairs
#[case("ffff0102ffff0102ffff010200", 3, 4)] // ((1.2) . ((1.2) . ((1.2) . nil))): list of 3× (1.2); 3 atoms (1, 2, nil), 4 unique pairs
fn test_interning(
    #[case] hex: &str,
    #[case] expected_atoms: usize,
    #[case] expected_pairs: usize,
) -> Result<()> {
    test_hex_interning(hex, expected_atoms, expected_pairs)
}