libbitcoinkernel-sys-covenants 0.0.22

Raw Rust bindings to libbitcoinkernel with added covenant op_codes
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
143
144
145
146
147
148
149
150
151
152
153
154
155

// Copyright (c) 2024-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <util/feefrac.h>
#include <random.h>

#include <boost/test/unit_test.hpp>

BOOST_AUTO_TEST_SUITE(feefrac_tests)

BOOST_AUTO_TEST_CASE(feefrac_operators)
{
    FeeFrac p1{1000, 100}, p2{500, 300};
    FeeFrac sum{1500, 400};
    FeeFrac diff{500, -200};
    FeeFrac empty{0, 0};
    FeeFrac zero_fee{0, 1}; // zero-fee allowed

    BOOST_CHECK_EQUAL(zero_fee.EvaluateFeeDown(0), 0);
    BOOST_CHECK_EQUAL(zero_fee.EvaluateFeeDown(1), 0);
    BOOST_CHECK_EQUAL(zero_fee.EvaluateFeeDown(1000000), 0);
    BOOST_CHECK_EQUAL(zero_fee.EvaluateFeeDown(0x7fffffff), 0);
    BOOST_CHECK_EQUAL(zero_fee.EvaluateFeeUp(0), 0);
    BOOST_CHECK_EQUAL(zero_fee.EvaluateFeeUp(1), 0);
    BOOST_CHECK_EQUAL(zero_fee.EvaluateFeeUp(1000000), 0);
    BOOST_CHECK_EQUAL(zero_fee.EvaluateFeeUp(0x7fffffff), 0);

    BOOST_CHECK_EQUAL(p1.EvaluateFeeDown(0), 0);
    BOOST_CHECK_EQUAL(p1.EvaluateFeeDown(1), 10);
    BOOST_CHECK_EQUAL(p1.EvaluateFeeDown(100000000), 1000000000);
    BOOST_CHECK_EQUAL(p1.EvaluateFeeDown(0x7fffffff), int64_t(0x7fffffff) * 10);
    BOOST_CHECK_EQUAL(p1.EvaluateFeeUp(0), 0);
    BOOST_CHECK_EQUAL(p1.EvaluateFeeUp(1), 10);
    BOOST_CHECK_EQUAL(p1.EvaluateFeeUp(100000000), 1000000000);
    BOOST_CHECK_EQUAL(p1.EvaluateFeeUp(0x7fffffff), int64_t(0x7fffffff) * 10);

    FeeFrac neg{-1001, 100};
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(0), 0);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(1), -11);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(2), -21);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(3), -31);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(100), -1001);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(101), -1012);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(100000000), -1001000000);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(100000001), -1001000011);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeDown(0x7fffffff), -21496311307);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(0), 0);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(1), -10);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(2), -20);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(3), -30);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(100), -1001);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(101), -1011);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(100000000), -1001000000);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(100000001), -1001000010);
    BOOST_CHECK_EQUAL(neg.EvaluateFeeUp(0x7fffffff), -21496311306);

    BOOST_CHECK(empty == FeeFrac{}); // same as no-args

    BOOST_CHECK(p1 == p1);
    BOOST_CHECK(p1 + p2 == sum);
    BOOST_CHECK(p1 - p2 == diff);

    FeeFrac p3{2000, 200};
    BOOST_CHECK(p1 != p3); // feefracs only equal if both fee and size are same
    BOOST_CHECK(p2 != p3);

    FeeFrac p4{3000, 300};
    BOOST_CHECK(p1 == p4-p3);
    BOOST_CHECK(p1 + p3 == p4);

    // Fee-rate comparison
    BOOST_CHECK(p1 > p2);
    BOOST_CHECK(p1 >= p2);
    BOOST_CHECK(p1 >= p4-p3);
    BOOST_CHECK(!(p1 >> p3)); // not strictly better
    BOOST_CHECK(p1 >> p2); // strictly greater feerate

    BOOST_CHECK(p2 < p1);
    BOOST_CHECK(p2 <= p1);
    BOOST_CHECK(p1 <= p4-p3);
    BOOST_CHECK(!(p3 << p1)); // not strictly worse
    BOOST_CHECK(p2 << p1); // strictly lower feerate

    // "empty" comparisons
    BOOST_CHECK(!(p1 >> empty)); // << will always result in false
    BOOST_CHECK(!(p1 << empty));
    BOOST_CHECK(!(empty >> empty));
    BOOST_CHECK(!(empty << empty));

    // empty is always bigger than everything else
    BOOST_CHECK(empty > p1);
    BOOST_CHECK(empty > p2);
    BOOST_CHECK(empty > p3);
    BOOST_CHECK(empty >= p1);
    BOOST_CHECK(empty >= p2);
    BOOST_CHECK(empty >= p3);

    // check "max" values for comparison
    FeeFrac oversized_1{4611686000000, 4000000};
    FeeFrac oversized_2{184467440000000, 100000};

    BOOST_CHECK(oversized_1 < oversized_2);
    BOOST_CHECK(oversized_1 <= oversized_2);
    BOOST_CHECK(oversized_1 << oversized_2);
    BOOST_CHECK(oversized_1 != oversized_2);

    BOOST_CHECK_EQUAL(oversized_1.EvaluateFeeDown(0), 0);
    BOOST_CHECK_EQUAL(oversized_1.EvaluateFeeDown(1), 1152921);
    BOOST_CHECK_EQUAL(oversized_1.EvaluateFeeDown(2), 2305843);
    BOOST_CHECK_EQUAL(oversized_1.EvaluateFeeDown(1548031267), 1784758530396540);
    BOOST_CHECK_EQUAL(oversized_1.EvaluateFeeUp(0), 0);
    BOOST_CHECK_EQUAL(oversized_1.EvaluateFeeUp(1), 1152922);
    BOOST_CHECK_EQUAL(oversized_1.EvaluateFeeUp(2), 2305843);
    BOOST_CHECK_EQUAL(oversized_1.EvaluateFeeUp(1548031267), 1784758530396541);

    // Test cases on the threshold where FeeFrac::Evaluate start using Mul/Div.
    BOOST_CHECK_EQUAL(FeeFrac(0x1ffffffff, 123456789).EvaluateFeeDown(98765432), 6871947728);
    BOOST_CHECK_EQUAL(FeeFrac(0x200000000, 123456789).EvaluateFeeDown(98765432), 6871947729);
    BOOST_CHECK_EQUAL(FeeFrac(0x200000001, 123456789).EvaluateFeeDown(98765432), 6871947730);
    BOOST_CHECK_EQUAL(FeeFrac(0x1ffffffff, 123456789).EvaluateFeeUp(98765432), 6871947729);
    BOOST_CHECK_EQUAL(FeeFrac(0x200000000, 123456789).EvaluateFeeUp(98765432), 6871947730);
    BOOST_CHECK_EQUAL(FeeFrac(0x200000001, 123456789).EvaluateFeeUp(98765432), 6871947731);

    // Tests paths that use double arithmetic
    FeeFrac busted{(static_cast<int64_t>(INT32_MAX)) + 1, INT32_MAX};
    BOOST_CHECK(!(busted < busted));

    FeeFrac max_fee{2100000000000000, INT32_MAX};
    BOOST_CHECK(!(max_fee < max_fee));
    BOOST_CHECK(!(max_fee > max_fee));
    BOOST_CHECK(max_fee <= max_fee);
    BOOST_CHECK(max_fee >= max_fee);

    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeDown(0), 0);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeDown(1), 977888);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeDown(2), 1955777);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeDown(3), 2933666);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeDown(1256796054), 1229006664189047);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeDown(INT32_MAX), 2100000000000000);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeUp(0), 0);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeUp(1), 977889);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeUp(2), 1955778);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeUp(3), 2933667);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeUp(1256796054), 1229006664189048);
    BOOST_CHECK_EQUAL(max_fee.EvaluateFeeUp(INT32_MAX), 2100000000000000);

    FeeFrac max_fee2{1, 1};
    BOOST_CHECK(max_fee >= max_fee2);

    // Test for integer overflow issue (https://github.com/bitcoin/bitcoin/issues/32294)
    BOOST_CHECK_EQUAL((FeeFrac{0x7ffffffdfffffffb, 0x7ffffffd}.EvaluateFeeDown(0x7fffffff)), 0x7fffffffffffffff);
}

BOOST_AUTO_TEST_SUITE_END()