miden-objects 0.17.0-rc.6

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

#![no_std]

extern crate alloc;
#[cfg(feature = "std")]
extern crate std;

pub mod account_file;
pub mod conversion;
pub mod decoded;
pub mod error;
pub mod note_file;

#[cfg(test)]
pub(crate) mod test_utils;

pub use error::{ConversionError, ConversionResultExt};
pub use miden_protobuf::{
    BuildUnchecked,
    DecodeMessage,
    DecodeMessageExt,
    Decoded,
    Verify,
    VerifyWith,
};
pub use prost;

/// Generated canonical Protobuf messages.
pub mod proto {
    pub mod account {
        include!(concat!(env!("OUT_DIR"), "/account.rs"));
    }

    #[expect(clippy::module_inception)]
    pub mod account_file {
        include!(concat!(env!("OUT_DIR"), "/account_file.rs"));
    }

    pub mod asset {
        include!(concat!(env!("OUT_DIR"), "/asset.rs"));
    }

    pub mod blockchain {
        include!(concat!(env!("OUT_DIR"), "/blockchain.rs"));
    }

    pub mod note {
        include!(concat!(env!("OUT_DIR"), "/note.rs"));
    }

    #[expect(clippy::module_inception)]
    pub mod note_file {
        include!(concat!(env!("OUT_DIR"), "/note_file.rs"));
    }

    pub mod primitives {
        include!(concat!(env!("OUT_DIR"), "/primitives.rs"));
    }

    pub mod protocol_config {
        include!(concat!(env!("OUT_DIR"), "/protocol_config.rs"));
    }

    pub mod transaction {
        include!(concat!(env!("OUT_DIR"), "/transaction.rs"));
    }
}

/// Self-contained descriptor set for the canonical object schemas.
pub const FILE_DESCRIPTOR_SET: &[u8] =
    include_bytes!(concat!(env!("OUT_DIR"), "/miden_objects_descriptor.bin"));

/// Protobuf paths and their canonical generated Rust paths.
///
/// Service-binding build scripts should configure these as Prost external paths so that messages
/// imported from this descriptor are represented by this crate's generated Rust types.
pub const EXTERN_PATHS: &[(&str, &str)] = &[
    (".account", "::miden_objects::proto::account"),
    (".asset", "::miden_objects::proto::asset"),
    (".blockchain", "::miden_objects::proto::blockchain"),
    (".note", "::miden_objects::proto::note"),
    (".primitives", "::miden_objects::proto::primitives"),
    (".protocol_config", "::miden_objects::proto::protocol_config"),
    (".transaction", "::miden_objects::proto::transaction"),
];