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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

// Bitcoin protocol primitives library.
//
// SPDX-License-Identifier: Apache-2.0
//
// Written in 2019-2023 by
//     Dr Maxim Orlovsky <orlovsky@lnp-bp.org>
//
// Copyright (C) 2019-2023 LNP/BP Standards Association. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Coding conventions
#![deny(
    non_upper_case_globals,
    non_camel_case_types,
    non_snake_case,
    unused_mut,
    unused_imports,
    dead_code,
    // TODO: Uncomment missing_docs
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

#[macro_use]
extern crate amplify;
#[macro_use]
extern crate strict_encoding;
#[macro_use]
extern crate commit_verify;
#[cfg(feature = "serde")]
#[macro_use]
extern crate serde_crate as serde;

/// Re-export of `secp256k1` crate.
pub extern crate secp256k1;

#[macro_use]
mod macros;
mod block;
pub mod opcodes;
mod script;
mod segwit;
mod taproot;
mod tx;
mod util;
#[cfg(feature = "stl")]
pub mod stl;

pub use block::{BlockHash, BlockHeader};
pub use script::{OpCode, ScriptPubkey, SigScript};
pub use segwit::*;
pub use taproot::*;
pub use tx::{LockTime, Outpoint, Sats, SeqNo, Tx, TxIn, TxOut, TxVer, Txid, Vout, Witness};
pub use types::{ScriptBytes, VarIntArray};
pub use util::{Chain, NonStandardValue};

pub const LIB_NAME_BITCOIN: &str = "Bitcoin";

mod types {
    use std::fmt::{Formatter, LowerHex, UpperHex};

    use amplify::confinement::{Confined, U32};
    use amplify::hex::ToHex;

    use super::LIB_NAME_BITCOIN;
    use crate::opcodes::*;

    pub type VarIntArray<T> = Confined<Vec<T>, 0, U32>;

    #[derive(
        Wrapper, WrapperMut, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Default, Debug, From
    )]
    #[derive(StrictType, StrictEncode, StrictDecode)]
    #[strict_type(lib = LIB_NAME_BITCOIN)]
    #[cfg_attr(
        feature = "serde",
        derive(Serialize, Deserialize),
        serde(crate = "serde_crate", transparent)
    )]
    #[wrapper(Deref, Index, RangeOps, BorrowSlice)]
    #[wrapper_mut(DerefMut, IndexMut, RangeMut, BorrowSliceMut)]
    pub struct ScriptBytes(VarIntArray<u8>);

    impl From<Vec<u8>> for ScriptBytes {
        fn from(value: Vec<u8>) -> Self { Self(Confined::try_from(value).expect("u64 >= usize")) }
    }

    impl LowerHex for ScriptBytes {
        fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
            f.write_str(&self.0.as_inner().to_hex())
        }
    }

    impl UpperHex for ScriptBytes {
        fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
            f.write_str(&self.0.as_inner().to_hex().to_uppercase())
        }
    }

    impl ScriptBytes {
        /// Adds instructions to push some arbitrary data onto the stack.
        ///
        /// ## Panics
        ///
        /// The method panics if `data` length is greater or equal to
        /// 0x100000000.
        pub fn push_slice(&mut self, data: &[u8]) {
            // Start with a PUSH opcode
            match data.len() as u64 {
                n if n < OP_PUSHDATA1 as u64 => {
                    self.push(n as u8);
                }
                n if n < 0x100 => {
                    self.push(OP_PUSHDATA1);
                    self.push(n as u8);
                }
                n if n < 0x10000 => {
                    self.push(OP_PUSHDATA2);
                    self.push((n % 0x100) as u8);
                    self.push((n / 0x100) as u8);
                }
                n if n < 0x100000000 => {
                    self.push(OP_PUSHDATA4);
                    self.push((n % 0x100) as u8);
                    self.push(((n / 0x100) % 0x100) as u8);
                    self.push(((n / 0x10000) % 0x100) as u8);
                    self.push((n / 0x1000000) as u8);
                }
                _ => panic!("tried to put a 4bn+ sized object into a script!"),
            }
            // Then push the raw bytes
            self.extend(data);
        }

        #[inline]
        fn push(&mut self, data: u8) { self.0.push(data).expect("script exceeds 4GB") }

        #[inline]
        fn extend(&mut self, data: &[u8]) {
            self.0
                .extend(data.iter().copied())
                .expect("script exceeds 4GB")
        }

        /// Computes the sum of `len` and the lenght of an appropriate push
        /// opcode.
        pub fn len_for_slice(len: usize) -> usize {
            len + match len {
                0..=0x4b => 1,
                0x4c..=0xff => 2,
                0x100..=0xffff => 3,
                // we don't care about oversized, the other fn will panic anyway
                _ => 5,
            }
        }
    }
}