elements 0.27.0

Library with support for de/serialization, parsing and executing on data structures and network messages related to Elements
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

// Rust Elements Library
// Written in 2018 by
//   Andrew Poelstra <apoelstra@blockstream.com>
//
// To the extent possible under law, the author(s) have dedicated all
// copyright and related and neighboring rights to this software to
// the public domain worldwide. This software is distributed without
// any warranty.
//
// You should have received a copy of the CC0 Public Domain Dedication
// along with this software.
// If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
//

//! # Rust Elements Library
//!
//! Extensions to `rust-bitcoin` to support deserialization and serialization
//! of Elements transactions and blocks.
//!

// Coding conventions
#![deny(non_upper_case_globals)]
#![deny(non_camel_case_types)]
#![deny(non_snake_case)]
#![deny(unused_mut)]
#![deny(missing_docs)]
#![allow(clippy::manual_range_contains)] // this lint is bullshit

/// Re-export of bitcoin crate
pub extern crate bitcoin;
/// Re-export of bitcoin-consensus-encoding crate
pub extern crate encoding;
/// Re-export of `bitcoin_hashes` crate
pub extern crate hashes;
/// Re-export of hex crate
pub extern crate hex;
/// Re-export of secp256k1-zkp crate
pub extern crate secp256k1_zkp;
/// Re-export of serde crate
#[cfg(feature = "serde")]
pub extern crate serde;
#[cfg(all(test, feature = "serde"))]
extern crate serde_test;

#[cfg(test)]
extern crate bincode;
#[cfg(test)]
extern crate rand;
#[cfg(any(test, feature = "serde_json"))]
extern crate serde_json;

#[macro_use]
mod internal_macros;
pub mod address;
pub mod blech32;
mod blind;
mod block;
pub mod confidential;
pub mod dynafed;
pub mod encode;
mod error;
mod ext;
mod fast_merkle_root;
pub mod hash_types;
pub mod issuance;
pub mod locktime;
pub mod opcodes;
mod parse;
pub mod pset;
pub mod schnorr;
pub mod script;
pub mod sighash;
pub mod taproot;
mod transaction;
// consider making upstream public
mod endian;
pub mod genesis;

// export everything at the top level so it can be used as `elements::Transaction` etc.
use internals::array_vec::ArrayVec;

pub use crate::address::{Address, AddressError, AddressParams};
pub use crate::blind::{
    BlindError, ConfidentialTxOutError, CtLocation, CtLocationType, RangeProofMessage,
    SurjectionInput, TxOutError, TxOutSecrets, UnblindError, VerificationError,
};
pub use crate::block::{Block, BlockHeader, DynafedRoot, ExtData as BlockExtData};
pub use crate::confidential::{RangeProof, SurjectionProof};
pub use crate::ext::{ReadExt, WriteExt};
pub use crate::fast_merkle_root::fast_merkle_root;
pub use crate::hash_types::*;
pub use crate::issuance::{
    AssetBlindingNonce, AssetBlindingNonceDecoder, AssetBlindingNonceDecoderError,
    AssetBlindingNonceEncoder, AssetEntropy, AssetEntropyDecoder, AssetEntropyDecoderError,
    AssetEntropyEncoder, AssetId, AssetIdDecoder, AssetIdDecoderError, AssetIdEncoder,
    ContractHash,
};
pub use crate::locktime::LockTime;
pub use crate::schnorr::{SchnorrSig, SchnorrSigError};
pub use crate::script::Script;
pub use crate::sighash::SchnorrSighashType;
pub use crate::transaction::{
    AssetIssuance, AssetIssuanceDecoder, AssetIssuanceDecoderError, AssetIssuanceEncoder,
    EcdsaSighashType, OutPoint, PeginData, PeginDataDecoder, PeginDataEncoder, PeginWitness,
    PeginWitnessDecoder, PeginWitnessDecoderError, PeginWitnessEncoder, PegoutData, Sequence,
    SequenceDecoder, SequenceDecoderError, SequenceEncoder, Transaction, TransactionDecoder,
    TransactionDecoderError, TransactionEncoder, TxIn, TxInDecoder, TxInDecoderError, TxInEncoder,
    TxInWitness, TxInWitnessDecoder, TxInWitnessDecoderError, TxInWitnessEncoder, TxOut,
    TxOutDecoder, TxOutDecoderError, TxOutEncoder, TxOutWitness, TxOutWitnessDecoder,
    TxOutWitnessDecoderError, TxOutWitnessEncoder, Witness, WitnessDecoder, WitnessDecoderError,
    WitnessEncoder,
};

// Encode a compact size to a slice without allocating
pub(crate) fn compact_size_encode(value: usize) -> ArrayVec<u8, 9> {
    use crate::encoding::Encoder as _;

    let encoder = encoding::CompactSizeEncoder::new(value);
    ArrayVec::from_slice(encoder.current_chunk())
}