miden-objects 0.17.0-rc.4

Canonical Protobuf representations for Miden 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
95
96

use miden_protobuf::unwrap_infallible;
pub use proto::primitives::DecodedMerkleStoreNode as MerkleStoreNode;

use crate::{Verify, proto};

#[cfg(test)]
mod tests;

impl Verify for MerkleStoreNode {
    type Verified = miden_protocol::crypto::merkle::InnerNodeInfo;
    type Error = core::convert::Infallible;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        Ok(Self::Verified {
            value: self.value,
            left: self.left,
            right: self.right,
        })
    }
}

pub use proto::primitives::DecodedAdviceMapEntry as AdviceMapEntry;

impl Verify for AdviceMapEntry {
    type Verified = (miden_protocol::Word, alloc::vec::Vec<miden_protocol::Felt>);
    type Error = core::convert::Infallible;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        Ok((self.key, self.values))
    }
}

pub use proto::primitives::DecodedAdviceStack as AdviceStack;

impl Verify for AdviceStack {
    type Verified = miden_protocol::vm::AdviceStack;
    type Error = core::convert::Infallible;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        Ok(self.values.into_iter().collect())
    }
}

pub use proto::primitives::DecodedAdviceMap as AdviceMap;

impl Verify for AdviceMap {
    type Verified = miden_protocol::vm::AdviceMap;
    type Error = AdviceError;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        let mut entries = alloc::collections::BTreeMap::new();
        for entry in self.entries {
            if entries.insert(entry.key, entry.values).is_some() {
                return Err(AdviceError::DuplicateMapKey(entry.key));
            }
        }
        Ok(entries.into())
    }
}

#[derive(Debug, thiserror::Error)]
pub enum AdviceError {
    #[error("duplicate advice map key {0}")]
    DuplicateMapKey(miden_protocol::Word),
    #[error("duplicate Merkle store parent {0}")]
    DuplicateMerkleParent(miden_protocol::Word),
}

pub use proto::primitives::DecodedMerkleStore as MerkleStore;

impl Verify for MerkleStore {
    type Verified = miden_protocol::crypto::merkle::store::MerkleStore;
    type Error = AdviceError;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        let mut nodes = alloc::collections::BTreeMap::new();
        for node in self.nodes {
            let node = unwrap_infallible(node.verify());
            if nodes.insert(node.value, node.clone()).is_some() {
                return Err(AdviceError::DuplicateMerkleParent(node.value));
            }
        }
        let mut store = Self::Verified::new();
        store.extend(nodes.into_values());
        Ok(store)
    }
}

pub use proto::primitives::DecodedAdviceInputs as AdviceInputs;

impl Verify for AdviceInputs {
    type Verified = miden_protocol::vm::AdviceInputs;
    type Error = AdviceError;
    fn verify(self) -> Result<Self::Verified, Self::Error> {
        Ok(Self::Verified::new(
            unwrap_infallible(self.advice_stack.verify()),
            self.advice_map.verify()?,
            self.merkle_store.verify()?,
        ))
    }
}