bp-consensus 0.12.0

Bitcoin protocol consensus library
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

// Bitcoin protocol consensus library.
//
// SPDX-License-Identifier: Apache-2.0
//
// Written in 2019-2024 by
//     Dr Maxim Orlovsky <orlovsky@lnp-bp.org>
//
// Copyright (C) 2019-2024 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.

use std::iter::Sum;
use std::ops::{Add, AddAssign};

use crate::{LenVarInt, ScriptPubkey, SigScript, Tx, TxIn, TxOut, Witness, LIB_NAME_BITCOIN};

#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug, Display)]
#[derive(StrictType, StrictEncode, StrictDecode, StrictDumb)]
#[strict_type(lib = LIB_NAME_BITCOIN)]
#[display("{0} vbytes")]
pub struct VBytes(u32);

impl Add for VBytes {
    type Output = Self;
    fn add(self, rhs: Self) -> Self::Output { Self(self.0 + rhs.0) }
}

impl AddAssign for VBytes {
    fn add_assign(&mut self, rhs: Self) { self.0.add_assign(rhs.0) }
}

impl Sum for VBytes {
    fn sum<I: Iterator<Item = Self>>(iter: I) -> Self { Self(iter.map(Self::into_u32).sum()) }
}

impl VBytes {
    pub fn to_u32(&self) -> u32 { self.0 }
    pub fn into_u32(self) -> u32 { self.0 }
}

#[derive(Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Debug, Display)]
#[derive(StrictType, StrictEncode, StrictDecode, StrictDumb)]
#[strict_type(lib = LIB_NAME_BITCOIN)]
#[display("{0} WU")]
pub struct WeightUnits(u32);

impl Add for WeightUnits {
    type Output = Self;
    fn add(self, rhs: Self) -> Self::Output { Self(self.0 + rhs.0) }
}

impl AddAssign for WeightUnits {
    fn add_assign(&mut self, rhs: Self) { self.0.add_assign(rhs.0) }
}

impl Sum for WeightUnits {
    fn sum<I: Iterator<Item = Self>>(iter: I) -> Self { Self(iter.map(Self::into_u32).sum()) }
}

impl From<WeightUnits> for VBytes {
    fn from(wu: WeightUnits) -> Self { Self((wu.0 as f32 / 4.0).ceil() as u32) }
}

impl WeightUnits {
    pub fn no_discount(bytes: usize) -> Self { WeightUnits(bytes as u32 * 4) }
    pub fn witness_discount(bytes: usize) -> Self { WeightUnits(bytes as u32) }
    pub fn to_u32(&self) -> u32 { self.0 }
    pub fn into_u32(self) -> u32 { self.0 }
}

pub trait Weight {
    fn weight_units(&self) -> WeightUnits;

    #[inline]
    fn vbytes(&self) -> VBytes { VBytes::from(self.weight_units()) }
}

impl Weight for Tx {
    fn weight_units(&self) -> WeightUnits {
        let bytes = 4 // version
        + self.inputs.len_var_int().len()
        + self.outputs.len_var_int().len()
        + 4; // lock time

        let mut weight = WeightUnits::no_discount(bytes)
            + self.inputs().map(TxIn::weight_units).sum()
            + self.outputs().map(TxOut::weight_units).sum();
        if self.is_segwit() {
            weight += WeightUnits::witness_discount(2); // marker and flag bytes
            weight += self.inputs().map(|txin| &txin.witness).map(Witness::weight_units).sum();
        }
        weight
    }
}

impl Weight for TxIn {
    fn weight_units(&self) -> WeightUnits {
        WeightUnits::no_discount(
            32 // txid
            + 4 // vout
            + 4, // nseq
        ) + self.sig_script.weight_units()
    }
}

impl Weight for TxOut {
    fn weight_units(&self) -> WeightUnits {
        WeightUnits::no_discount(8) // value
        + self.script_pubkey.weight_units()
    }
}

impl Weight for ScriptPubkey {
    fn weight_units(&self) -> WeightUnits {
        WeightUnits::no_discount(self.len_var_int().len() + self.len())
    }
}

impl Weight for SigScript {
    fn weight_units(&self) -> WeightUnits {
        WeightUnits::no_discount(self.len_var_int().len() + self.len())
    }
}

impl Weight for Witness {
    fn weight_units(&self) -> WeightUnits {
        WeightUnits::witness_discount(
            self.len_var_int().len()
                + self.iter().map(|item| item.len_var_int().len() + item.len()).sum::<usize>(),
        )
    }
}