md-codec 0.34.0

Reference implementation of the Mnemonic Descriptor (MD) format for engravable BIP 388 wallet policy backups
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

//! # `md-codec`
//!
//! Reference implementation of the **Mnemonic Descriptor (MD)** format —
//! an engravable backup format for [BIP 388 wallet policies][bip388].
//!
//! [bip388]: https://github.com/bitcoin/bips/blob/master/bip-0388.mediawiki
//!
//! v0.30 wire format: bit-aligned payload, sparse per-`@N` TLV overrides,
//! 5-bit single-payload header (4-bit version=4 + `divergent_paths` flag),
//! 6-bit bytecode tag space, decoder auto-dispatch between single and chunked
//! payloads via the first 5-bit symbol's bit 0, symbol-aligned codex32
//! wrapping with HRP `"md"`. See `design/SPEC_v0_30_wire_format.md` for the
//! normative spec.

pub mod bch;
pub mod bch_decode;

pub mod bitstream;
pub mod canonical_origin;
pub mod canonicalize;
pub mod chunk;
pub mod codex32;
pub mod decode;
pub mod derive;
pub mod encode;
pub mod error;
pub mod header;
pub mod identity;
pub mod origin_path;
pub mod phrase;
pub mod tag;
pub mod test_vectors;
pub mod tlv;
#[cfg(feature = "derive")]
pub mod to_miniscript;
pub mod tree;
pub mod use_site_path;
pub mod validate;
pub mod varint;

pub use canonicalize::canonicalize_placeholder_indices;
pub use chunk::{
    ChunkHeader, CorrectionDetail, decode_with_correction, derive_chunk_set_id, reassemble, split,
};
pub use decode::{decode_md1_string, decode_payload};
pub use encode::{Descriptor, encode_md1_string, encode_payload};
pub use error::Error;
pub use header::Header;
pub use identity::{
    Md1EncodingId, WalletDescriptorTemplateId, WalletPolicyId, compute_md1_encoding_id,
    compute_wallet_descriptor_template_id, compute_wallet_policy_id, validate_presence_byte,
};
pub use origin_path::{OriginPath, PathComponent, PathDecl, PathDeclPaths};
pub use phrase::Phrase;
pub use tag::Tag;
pub use tlv::TlvSection;