Skip to main content

md_codec/
lib.rs

1//! # `md-codec`
2//!
3//! Reference implementation of the **Mnemonic Descriptor (MD)** format —
4//! an engravable backup format for [BIP 388 wallet policies][bip388].
5//!
6//! [bip388]: https://github.com/bitcoin/bips/blob/master/bip-0388.mediawiki
7//!
8//! v0.30 wire format: bit-aligned payload, sparse per-`@N` TLV overrides,
9//! 5-bit single-payload header (4-bit version=4 + `divergent_paths` flag),
10//! 6-bit bytecode tag space, decoder auto-dispatch between single and chunked
11//! payloads via the first 5-bit symbol's bit 0, symbol-aligned codex32
12//! wrapping with HRP `"md"`. See `design/SPEC_v0_30_wire_format.md` for the
13//! normative spec.
14
15pub mod bch;
16pub mod bch_decode;
17
18pub mod bitstream;
19pub mod canonical_origin;
20pub mod canonicalize;
21pub mod chunk;
22pub mod codex32;
23pub mod decode;
24pub mod derive;
25pub mod encode;
26pub mod error;
27pub mod header;
28pub mod identity;
29pub mod origin_path;
30pub mod phrase;
31pub mod tag;
32pub mod test_vectors;
33pub mod tlv;
34#[cfg(feature = "derive")]
35pub mod to_miniscript;
36pub mod tree;
37pub mod use_site_path;
38pub mod validate;
39pub mod varint;
40
41pub use canonicalize::canonicalize_placeholder_indices;
42pub use chunk::{
43    ChunkHeader, CorrectionDetail, decode_with_correction, derive_chunk_set_id, reassemble, split,
44};
45pub use decode::{decode_md1_string, decode_payload};
46pub use encode::{Descriptor, encode_md1_string, encode_payload};
47pub use error::Error;
48pub use header::Header;
49pub use identity::{
50    Md1EncodingId, WalletDescriptorTemplateId, WalletPolicyId, compute_md1_encoding_id,
51    compute_wallet_descriptor_template_id, compute_wallet_policy_id, validate_presence_byte,
52};
53pub use origin_path::{OriginPath, PathComponent, PathDecl, PathDeclPaths};
54pub use phrase::Phrase;
55pub use tag::Tag;
56pub use tlv::TlvSection;