Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2022 The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #ifndef BITCOIN_POLICY_POLICY_H
7 : : #define BITCOIN_POLICY_POLICY_H
8 : :
9 : : #include <consensus/amount.h>
10 : : #include <consensus/consensus.h>
11 : : #include <primitives/transaction.h>
12 : : #include <script/interpreter.h>
13 : : #include <script/solver.h>
14 : :
15 : : #include <cstdint>
16 : : #include <string>
17 : :
18 : : class CCoinsViewCache;
19 : : class CFeeRate;
20 : : class CScript;
21 : :
22 : : /** Default for -blockmaxweight, which controls the range of block weights the mining code will create **/
23 : : static constexpr unsigned int DEFAULT_BLOCK_MAX_WEIGHT{MAX_BLOCK_WEIGHT};
24 : : /** Default for -blockreservedweight **/
25 : : static constexpr unsigned int DEFAULT_BLOCK_RESERVED_WEIGHT{8000};
26 : : /** This accounts for the block header, var_int encoding of the transaction count and a minimally viable
27 : : * coinbase transaction. It adds an additional safety margin, because even with a thorough understanding
28 : : * of block serialization, it's easy to make a costly mistake when trying to squeeze every last byte.
29 : : * Setting a lower value is prevented at startup. */
30 : : static constexpr unsigned int MINIMUM_BLOCK_RESERVED_WEIGHT{2000};
31 : : /** Default for -blockmintxfee, which sets the minimum feerate for a transaction in blocks created by mining code **/
32 : : static constexpr unsigned int DEFAULT_BLOCK_MIN_TX_FEE{1000};
33 : : /** The maximum weight for transactions we're willing to relay/mine */
34 : : static constexpr int32_t MAX_STANDARD_TX_WEIGHT{400000};
35 : : /** The minimum non-witness size for transactions we're willing to relay/mine: one larger than 64 */
36 : : static constexpr unsigned int MIN_STANDARD_TX_NONWITNESS_SIZE{65};
37 : : /** Maximum number of signature check operations in an IsStandard() P2SH script */
38 : : static constexpr unsigned int MAX_P2SH_SIGOPS{15};
39 : : /** The maximum number of sigops we're willing to relay/mine in a single tx */
40 : : static constexpr unsigned int MAX_STANDARD_TX_SIGOPS_COST{MAX_BLOCK_SIGOPS_COST/5};
41 : : /** Default for -incrementalrelayfee, which sets the minimum feerate increase for mempool limiting or replacement **/
42 : : static constexpr unsigned int DEFAULT_INCREMENTAL_RELAY_FEE{1000};
43 : : /** Default for -bytespersigop */
44 : : static constexpr unsigned int DEFAULT_BYTES_PER_SIGOP{20};
45 : : /** Default for -permitbaremultisig */
46 : : static constexpr bool DEFAULT_PERMIT_BAREMULTISIG{true};
47 : : /** The maximum number of witness stack items in a standard P2WSH script */
48 : : static constexpr unsigned int MAX_STANDARD_P2WSH_STACK_ITEMS{100};
49 : : /** The maximum size in bytes of each witness stack item in a standard P2WSH script */
50 : : static constexpr unsigned int MAX_STANDARD_P2WSH_STACK_ITEM_SIZE{80};
51 : : /** The maximum size in bytes of each witness stack item in a standard BIP 342 script (Taproot, leaf version 0xc0) */
52 : : static constexpr unsigned int MAX_STANDARD_TAPSCRIPT_STACK_ITEM_SIZE{80};
53 : : /** The maximum size in bytes of a standard witnessScript */
54 : : static constexpr unsigned int MAX_STANDARD_P2WSH_SCRIPT_SIZE{3600};
55 : : /** The maximum size of a standard ScriptSig */
56 : : static constexpr unsigned int MAX_STANDARD_SCRIPTSIG_SIZE{1650};
57 : : /** Min feerate for defining dust.
58 : : * Changing the dust limit changes which transactions are
59 : : * standard and should be done with care and ideally rarely. It makes sense to
60 : : * only increase the dust limit after prior releases were already not creating
61 : : * outputs below the new threshold */
62 : : static constexpr unsigned int DUST_RELAY_TX_FEE{3000};
63 : : /** Default for -minrelaytxfee, minimum relay fee for transactions */
64 : : static constexpr unsigned int DEFAULT_MIN_RELAY_TX_FEE{1000};
65 : : /** Default for -limitancestorcount, max number of in-mempool ancestors */
66 : : static constexpr unsigned int DEFAULT_ANCESTOR_LIMIT{25};
67 : : /** Default for -limitancestorsize, maximum kilobytes of tx + all in-mempool ancestors */
68 : : static constexpr unsigned int DEFAULT_ANCESTOR_SIZE_LIMIT_KVB{101};
69 : : /** Default for -limitdescendantcount, max number of in-mempool descendants */
70 : : static constexpr unsigned int DEFAULT_DESCENDANT_LIMIT{25};
71 : : /** Default for -limitdescendantsize, maximum kilobytes of in-mempool descendants */
72 : : static constexpr unsigned int DEFAULT_DESCENDANT_SIZE_LIMIT_KVB{101};
73 : : /** Default for -datacarrier */
74 : : static const bool DEFAULT_ACCEPT_DATACARRIER = true;
75 : : /**
76 : : * Default setting for -datacarriersize in vbytes.
77 : : */
78 : : static const unsigned int MAX_OP_RETURN_RELAY = MAX_STANDARD_TX_WEIGHT / WITNESS_SCALE_FACTOR;
79 : : /**
80 : : * An extra transaction can be added to a package, as long as it only has one
81 : : * ancestor and is no larger than this. Not really any reason to make this
82 : : * configurable as it doesn't materially change DoS parameters.
83 : : */
84 : : static constexpr unsigned int EXTRA_DESCENDANT_TX_SIZE_LIMIT{10000};
85 : :
86 : : /**
87 : : * Maximum number of ephemeral dust outputs allowed.
88 : : */
89 : : static constexpr unsigned int MAX_DUST_OUTPUTS_PER_TX{1};
90 : :
91 : : /**
92 : : * Mandatory script verification flags that all new transactions must comply with for
93 : : * them to be valid. Failing one of these tests may trigger a DoS ban;
94 : : * see CheckInputScripts() for details.
95 : : *
96 : : * Note that this does not affect consensus validity; see GetBlockScriptFlags()
97 : : * for that.
98 : : */
99 : : static constexpr unsigned int MANDATORY_SCRIPT_VERIFY_FLAGS{SCRIPT_VERIFY_P2SH |
100 : : SCRIPT_VERIFY_DERSIG |
101 : : SCRIPT_VERIFY_NULLDUMMY |
102 : : SCRIPT_VERIFY_CHECKLOCKTIMEVERIFY |
103 : : SCRIPT_VERIFY_CHECKSEQUENCEVERIFY |
104 : : SCRIPT_VERIFY_WITNESS |
105 : : SCRIPT_VERIFY_TAPROOT};
106 : :
107 : : /**
108 : : * Standard script verification flags that standard transactions will comply
109 : : * with. However we do not ban/disconnect nodes that forward txs violating
110 : : * the additional (non-mandatory) rules here, to improve forwards and
111 : : * backwards compatibility.
112 : : */
113 : : static constexpr unsigned int STANDARD_SCRIPT_VERIFY_FLAGS{MANDATORY_SCRIPT_VERIFY_FLAGS |
114 : : SCRIPT_VERIFY_STRICTENC |
115 : : SCRIPT_VERIFY_MINIMALDATA |
116 : : SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_NOPS |
117 : : SCRIPT_VERIFY_CLEANSTACK |
118 : : SCRIPT_VERIFY_MINIMALIF |
119 : : SCRIPT_VERIFY_NULLFAIL |
120 : : SCRIPT_VERIFY_LOW_S |
121 : : SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_WITNESS_PROGRAM |
122 : : SCRIPT_VERIFY_WITNESS_PUBKEYTYPE |
123 : : SCRIPT_VERIFY_CONST_SCRIPTCODE |
124 : : SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_TAPROOT_VERSION |
125 : : SCRIPT_VERIFY_DISCOURAGE_OP_SUCCESS |
126 : : SCRIPT_VERIFY_DISCOURAGE_UPGRADABLE_PUBKEYTYPE};
127 : :
128 : : /** For convenience, standard but not mandatory verify flags. */
129 : : static constexpr unsigned int STANDARD_NOT_MANDATORY_VERIFY_FLAGS{STANDARD_SCRIPT_VERIFY_FLAGS & ~MANDATORY_SCRIPT_VERIFY_FLAGS};
130 : :
131 : : /** Used as the flags parameter to sequence and nLocktime checks in non-consensus code. */
132 : : static constexpr unsigned int STANDARD_LOCKTIME_VERIFY_FLAGS{LOCKTIME_VERIFY_SEQUENCE};
133 : :
134 : : CAmount GetDustThreshold(const CTxOut& txout, const CFeeRate& dustRelayFee);
135 : :
136 : : bool IsDust(const CTxOut& txout, const CFeeRate& dustRelayFee);
137 : :
138 : : bool IsStandard(const CScript& scriptPubKey, TxoutType& whichType);
139 : :
140 : : /** Get the vout index numbers of all dust outputs */
141 : : std::vector<uint32_t> GetDust(const CTransaction& tx, CFeeRate dust_relay_rate);
142 : :
143 : : // Changing the default transaction version requires a two step process: first
144 : : // adapting relay policy by bumping TX_MAX_STANDARD_VERSION, and then later
145 : : // allowing the new transaction version in the wallet/RPC.
146 : : static constexpr decltype(CTransaction::version) TX_MAX_STANDARD_VERSION{3};
147 : :
148 : : /**
149 : : * Check for standard transaction types
150 : : * @return True if all outputs (scriptPubKeys) use only standard transaction forms
151 : : */
152 : : bool IsStandardTx(const CTransaction& tx, const std::optional<unsigned>& max_datacarrier_bytes, bool permit_bare_multisig, const CFeeRate& dust_relay_fee, std::string& reason);
153 : : /**
154 : : * Check for standard transaction types
155 : : * @param[in] mapInputs Map of previous transactions that have outputs we're spending
156 : : * @return True if all inputs (scriptSigs) use only standard transaction forms
157 : : */
158 : : bool AreInputsStandard(const CTransaction& tx, const CCoinsViewCache& mapInputs);
159 : : /**
160 : : * Check if the transaction is over standard P2WSH resources limit:
161 : : * 3600bytes witnessScript size, 80bytes per witness stack element, 100 witness stack elements
162 : : * These limits are adequate for multisignatures up to n-of-100 using OP_CHECKSIG, OP_ADD, and OP_EQUAL.
163 : : *
164 : : * Also enforce a maximum stack item size limit and no annexes for tapscript spends.
165 : : */
166 : : bool IsWitnessStandard(const CTransaction& tx, const CCoinsViewCache& mapInputs);
167 : :
168 : : /** Compute the virtual transaction size (weight reinterpreted as bytes). */
169 : : int64_t GetVirtualTransactionSize(int64_t nWeight, int64_t nSigOpCost, unsigned int bytes_per_sigop);
170 : : int64_t GetVirtualTransactionSize(const CTransaction& tx, int64_t nSigOpCost, unsigned int bytes_per_sigop);
171 : : int64_t GetVirtualTransactionInputSize(const CTxIn& tx, int64_t nSigOpCost, unsigned int bytes_per_sigop);
172 : :
173 : 30269 : static inline int64_t GetVirtualTransactionSize(const CTransaction& tx)
174 : : {
175 [ # # # # : 30269 : return GetVirtualTransactionSize(tx, 0, 0);
# # ][ + - ]
[ - - + - ]
176 : : }
177 : :
178 : 66 : static inline int64_t GetVirtualTransactionInputSize(const CTxIn& tx)
179 : : {
180 [ + - ]: 66 : return GetVirtualTransactionInputSize(tx, 0, 0);
181 : : }
182 : :
183 : : #endif // BITCOIN_POLICY_POLICY_H
|
