miden-node-persistence 0.17.1

Protobuf persistence codecs for Miden node
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

use std::sync::Arc;

use miden_objects::proto;
use miden_protobuf::{DecodeMessage, DecodeMessageExt};
use miden_protocol::MastForest;
use miden_protocol::account::{AccountCode, AccountProcedureRoot};
use miden_protocol::utils::serde::{Deserializable, Serializable};

use crate::{PersistenceError, ProtobufValue, generated};

macro_rules! codec {
    ($domain:ty, $message:ty, $build:ident, $encode:expr) => {
        impl ProtobufValue for $domain {
            type Message = $message;
            fn to_proto(&self) -> Self::Message {
                ($encode)(self)
            }
            fn from_proto(message: Self::Message) -> Result<Self, PersistenceError> {
                Ok(message.$build()?)
            }
        }
    };
}

codec!(
    miden_protocol::account::Account,
    proto::account::Account,
    decode_and_verify,
    |value: &miden_protocol::account::Account| value.into()
);
codec!(
    miden_protocol::account::AccountStorageHeader,
    proto::account::AccountStorageHeader,
    decode_and_verify,
    |value: &miden_protocol::account::AccountStorageHeader| value.into()
);
codec!(
    miden_protocol::asset::Asset,
    proto::asset::Asset,
    decode_and_verify,
    |value: &miden_protocol::asset::Asset| value.into()
);
codec!(
    miden_protocol::note::Note,
    proto::note::Note,
    decode_and_verify,
    |value: &miden_protocol::note::Note| value.into()
);
codec!(
    miden_protocol::note::NoteHeader,
    proto::note::NoteHeader,
    decode_and_verify,
    |value: &miden_protocol::note::NoteHeader| (*value).into()
);
codec!(
    miden_protocol::note::NoteDetails,
    proto::note::NoteDetails,
    decode_and_verify,
    |value: &miden_protocol::note::NoteDetails| value.into()
);
codec!(
    miden_protocol::note::NoteScript,
    proto::note::NoteScript,
    decode_and_verify,
    |value: &miden_protocol::note::NoteScript| value.into()
);
codec!(
    miden_protocol::note::NoteStorage,
    proto::note::NoteStorage,
    decode_and_verify,
    |value: &miden_protocol::note::NoteStorage| value.into()
);
codec!(
    miden_protocol::note::NoteAttachments,
    proto::note::NoteAttachments,
    decode_and_verify,
    |value: &miden_protocol::note::NoteAttachments| value.into()
);
codec!(
    miden_protocol::protocol_config::ProtocolConfig,
    proto::protocol_config::ProtocolConfig,
    decode_and_verify,
    |value: &miden_protocol::protocol_config::ProtocolConfig| value.into()
);
codec!(
    miden_protocol::crypto::merkle::SparseMerklePath,
    proto::primitives::SparseMerklePath,
    decode_and_verify,
    |value: &miden_protocol::crypto::merkle::SparseMerklePath| value.clone().into()
);
codec!(
    miden_protocol::crypto::merkle::mmr::PartialMmr,
    proto::primitives::PartialMmr,
    decode_and_verify,
    |value: &miden_protocol::crypto::merkle::mmr::PartialMmr| value.into()
);
codec!(
    miden_protocol::block::BlockHeader,
    proto::blockchain::BlockHeader,
    decode_and_build_unchecked,
    |value: &miden_protocol::block::BlockHeader| value.into()
);
codec!(
    miden_protocol::block::SignedBlock,
    proto::blockchain::SignedBlock,
    decode_and_build_unchecked,
    |value: &miden_protocol::block::SignedBlock| value.into()
);
codec!(
    miden_protocol::transaction::TransactionInputs,
    proto::transaction::TransactionInputs,
    decode_and_build_unchecked,
    |value: &miden_protocol::transaction::TransactionInputs| value.into()
);
codec!(
    miden_protocol::transaction::ProvenTransaction,
    proto::transaction::ProvenTransaction,
    decode_and_build_unchecked,
    |value: &miden_protocol::transaction::ProvenTransaction| value.into()
);

// The miden-objects protobuf conversion can omit MAST node hashes for untrusted validation. Stored
// code keeps these hashes so MastForest::read_from_bytes can restore it as trusted data.
impl ProtobufValue for AccountCode {
    type Message = generated::AccountCode;

    fn to_proto(&self) -> Self::Message {
        generated::AccountCode {
            mast: Some(generated::MastForest { encoded: self.mast().to_bytes() }),
            procedure_roots: self.procedure_roots().map(Into::into).collect(),
        }
    }

    fn from_proto(message: Self::Message) -> Result<Self, PersistenceError> {
        let mast = message.mast.ok_or_else(|| {
            miden_protobuf::ConversionError::missing_field::<generated::AccountCode>("mast")
        })?;
        let mast = Arc::new(MastForest::read_from_bytes(&mast.encoded)?);
        let roots = message
            .procedure_roots
            .into_iter()
            .map(|root| root.decode_fields().map(AccountProcedureRoot::from_raw))
            .collect::<Result<Vec<_>, _>>()?;
        Ok(AccountCode::from_parts(mast, roots)?)
    }
}