Bitcoin Core 22.99.0
P2P Digital Currency
tx_verify.cpp
Go to the documentation of this file.
1// Copyright (c) 2017-2020 The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
6
7#include <consensus/amount.h>
10#include <script/interpreter.h>
12
13// TODO remove the following dependencies
14#include <chain.h>
15#include <coins.h>
16#include <util/moneystr.h>
17
18bool IsFinalTx(const CTransaction &tx, int nBlockHeight, int64_t nBlockTime)
19{
20 if (tx.nLockTime == 0)
21 return true;
22 if ((int64_t)tx.nLockTime < ((int64_t)tx.nLockTime < LOCKTIME_THRESHOLD ? (int64_t)nBlockHeight : nBlockTime))
23 return true;
24
25 // Even if tx.nLockTime isn't satisfied by nBlockHeight/nBlockTime, a
26 // transaction is still considered final if all inputs' nSequence ==
27 // SEQUENCE_FINAL (0xffffffff), in which case nLockTime is ignored.
28 //
29 // Because of this behavior OP_CHECKLOCKTIMEVERIFY/CheckLockTime() will
30 // also check that the spending input's nSequence != SEQUENCE_FINAL,
31 // ensuring that an unsatisfied nLockTime value will actually cause
32 // IsFinalTx() to return false here:
33 for (const auto& txin : tx.vin) {
34 if (!(txin.nSequence == CTxIn::SEQUENCE_FINAL))
35 return false;
36 }
37 return true;
38}
39
40std::pair<int, int64_t> CalculateSequenceLocks(const CTransaction &tx, int flags, std::vector<int>& prevHeights, const CBlockIndex& block)
41{
42 assert(prevHeights.size() == tx.vin.size());
43
44 // Will be set to the equivalent height- and time-based nLockTime
45 // values that would be necessary to satisfy all relative lock-
46 // time constraints given our view of block chain history.
47 // The semantics of nLockTime are the last invalid height/time, so
48 // use -1 to have the effect of any height or time being valid.
49 int nMinHeight = -1;
50 int64_t nMinTime = -1;
51
52 // tx.nVersion is signed integer so requires cast to unsigned otherwise
53 // we would be doing a signed comparison and half the range of nVersion
54 // wouldn't support BIP 68.
55 bool fEnforceBIP68 = static_cast<uint32_t>(tx.nVersion) >= 2
57
58 // Do not enforce sequence numbers as a relative lock time
59 // unless we have been instructed to
60 if (!fEnforceBIP68) {
61 return std::make_pair(nMinHeight, nMinTime);
62 }
63
64 for (size_t txinIndex = 0; txinIndex < tx.vin.size(); txinIndex++) {
65 const CTxIn& txin = tx.vin[txinIndex];
66
67 // Sequence numbers with the most significant bit set are not
68 // treated as relative lock-times, nor are they given any
69 // consensus-enforced meaning at this point.
71 // The height of this input is not relevant for sequence locks
72 prevHeights[txinIndex] = 0;
73 continue;
74 }
75
76 int nCoinHeight = prevHeights[txinIndex];
77
79 int64_t nCoinTime = block.GetAncestor(std::max(nCoinHeight-1, 0))->GetMedianTimePast();
80 // NOTE: Subtract 1 to maintain nLockTime semantics
81 // BIP 68 relative lock times have the semantics of calculating
82 // the first block or time at which the transaction would be
83 // valid. When calculating the effective block time or height
84 // for the entire transaction, we switch to using the
85 // semantics of nLockTime which is the last invalid block
86 // time or height. Thus we subtract 1 from the calculated
87 // time or height.
88
89 // Time-based relative lock-times are measured from the
90 // smallest allowed timestamp of the block containing the
91 // txout being spent, which is the median time past of the
92 // block prior.
93 nMinTime = std::max(nMinTime, nCoinTime + (int64_t)((txin.nSequence & CTxIn::SEQUENCE_LOCKTIME_MASK) << CTxIn::SEQUENCE_LOCKTIME_GRANULARITY) - 1);
94 } else {
95 nMinHeight = std::max(nMinHeight, nCoinHeight + (int)(txin.nSequence & CTxIn::SEQUENCE_LOCKTIME_MASK) - 1);
96 }
97 }
98
99 return std::make_pair(nMinHeight, nMinTime);
100}
101
102bool EvaluateSequenceLocks(const CBlockIndex& block, std::pair<int, int64_t> lockPair)
103{
104 assert(block.pprev);
105 int64_t nBlockTime = block.pprev->GetMedianTimePast();
106 if (lockPair.first >= block.nHeight || lockPair.second >= nBlockTime)
107 return false;
108
109 return true;
110}
111
112bool SequenceLocks(const CTransaction &tx, int flags, std::vector<int>& prevHeights, const CBlockIndex& block)
113{
114 return EvaluateSequenceLocks(block, CalculateSequenceLocks(tx, flags, prevHeights, block));
115}
116
117unsigned int GetLegacySigOpCount(const CTransaction& tx)
118{
119 unsigned int nSigOps = 0;
120 for (const auto& txin : tx.vin)
121 {
122 nSigOps += txin.scriptSig.GetSigOpCount(false);
123 }
124 for (const auto& txout : tx.vout)
125 {
126 nSigOps += txout.scriptPubKey.GetSigOpCount(false);
127 }
128 return nSigOps;
129}
130
131unsigned int GetP2SHSigOpCount(const CTransaction& tx, const CCoinsViewCache& inputs)
132{
133 if (tx.IsCoinBase())
134 return 0;
135
136 unsigned int nSigOps = 0;
137 for (unsigned int i = 0; i < tx.vin.size(); i++)
138 {
139 const Coin& coin = inputs.AccessCoin(tx.vin[i].prevout);
140 assert(!coin.IsSpent());
141 const CTxOut &prevout = coin.out;
142 if (prevout.scriptPubKey.IsPayToScriptHash())
143 nSigOps += prevout.scriptPubKey.GetSigOpCount(tx.vin[i].scriptSig);
144 }
145 return nSigOps;
146}
147
148int64_t GetTransactionSigOpCost(const CTransaction& tx, const CCoinsViewCache& inputs, uint32_t flags)
149{
150 int64_t nSigOps = GetLegacySigOpCount(tx) * WITNESS_SCALE_FACTOR;
151
152 if (tx.IsCoinBase())
153 return nSigOps;
154
156 nSigOps += GetP2SHSigOpCount(tx, inputs) * WITNESS_SCALE_FACTOR;
157 }
158
159 for (unsigned int i = 0; i < tx.vin.size(); i++)
160 {
161 const Coin& coin = inputs.AccessCoin(tx.vin[i].prevout);
162 assert(!coin.IsSpent());
163 const CTxOut &prevout = coin.out;
164 nSigOps += CountWitnessSigOps(tx.vin[i].scriptSig, prevout.scriptPubKey, &tx.vin[i].scriptWitness, flags);
165 }
166 return nSigOps;
167}
168
169bool Consensus::CheckTxInputs(const CTransaction& tx, TxValidationState& state, const CCoinsViewCache& inputs, int nSpendHeight, CAmount& txfee)
170{
171 // are the actual inputs available?
172 if (!inputs.HaveInputs(tx)) {
173 return state.Invalid(TxValidationResult::TX_MISSING_INPUTS, "bad-txns-inputs-missingorspent",
174 strprintf("%s: inputs missing/spent", __func__));
175 }
176
177 CAmount nValueIn = 0;
178 for (unsigned int i = 0; i < tx.vin.size(); ++i) {
179 const COutPoint &prevout = tx.vin[i].prevout;
180 const Coin& coin = inputs.AccessCoin(prevout);
181 assert(!coin.IsSpent());
182
183 // If prev is coinbase, check that it's matured
184 if (coin.IsCoinBase() && nSpendHeight - coin.nHeight < COINBASE_MATURITY) {
185 return state.Invalid(TxValidationResult::TX_PREMATURE_SPEND, "bad-txns-premature-spend-of-coinbase",
186 strprintf("tried to spend coinbase at depth %d", nSpendHeight - coin.nHeight));
187 }
188
189 // Check for negative or overflow input values
190 nValueIn += coin.out.nValue;
191 if (!MoneyRange(coin.out.nValue) || !MoneyRange(nValueIn)) {
192 return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-txns-inputvalues-outofrange");
193 }
194 }
195
196 const CAmount value_out = tx.GetValueOut();
197 if (nValueIn < value_out) {
198 return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-txns-in-belowout",
199 strprintf("value in (%s) < value out (%s)", FormatMoney(nValueIn), FormatMoney(value_out)));
200 }
201
202 // Tally transaction fees
203 const CAmount txfee_aux = nValueIn - value_out;
204 if (!MoneyRange(txfee_aux)) {
205 return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-txns-fee-outofrange");
206 }
207
208 txfee = txfee_aux;
209 return true;
210}
bool MoneyRange(const CAmount &nValue)
Definition: amount.h:27
int64_t CAmount
Amount in satoshis (Can be negative)
Definition: amount.h:12
int flags
Definition: bitcoin-tx.cpp:525
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:146
CBlockIndex * pprev
pointer to the index of the predecessor of this block
Definition: chain.h:152
int64_t GetMedianTimePast() const
Definition: chain.h:280
CBlockIndex * GetAncestor(int height)
Efficiently find an ancestor of this block.
Definition: chain.cpp:111
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:158
CCoinsView that adds a memory cache for transactions to another CCoinsView.
Definition: coins.h:214
bool HaveInputs(const CTransaction &tx) const
Check whether all prevouts of the transaction are present in the UTXO set represented by this view.
Definition: coins.cpp:242
const Coin & AccessCoin(const COutPoint &output) const
Return a reference to Coin in the cache, or coinEmpty if not found.
Definition: coins.cpp:137
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:27
bool IsPayToScriptHash() const
Definition: script.cpp:201
unsigned int GetSigOpCount(bool fAccurate) const
Pre-version-0.6, Bitcoin always counted CHECKMULTISIGs as 20 sigops.
Definition: script.cpp:153
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:260
const uint32_t nLockTime
Definition: transaction.h:273
const std::vector< CTxOut > vout
Definition: transaction.h:271
bool IsCoinBase() const
Definition: transaction.h:315
CAmount GetValueOut() const
Definition: transaction.cpp:84
const int32_t nVersion
Definition: transaction.h:272
const std::vector< CTxIn > vin
Definition: transaction.h:270
An input of a transaction.
Definition: transaction.h:66
static const uint32_t SEQUENCE_LOCKTIME_DISABLE_FLAG
Definition: transaction.h:80
uint32_t nSequence
Definition: transaction.h:70
static const uint32_t SEQUENCE_LOCKTIME_MASK
Definition: transaction.h:89
static const uint32_t SEQUENCE_FINAL
Definition: transaction.h:75
static const uint32_t SEQUENCE_LOCKTIME_TYPE_FLAG
Definition: transaction.h:85
static const int SEQUENCE_LOCKTIME_GRANULARITY
Definition: transaction.h:98
An output of a transaction.
Definition: transaction.h:129
CScript scriptPubKey
Definition: transaction.h:132
CAmount nValue
Definition: transaction.h:131
A UTXO entry.
Definition: coins.h:31
bool IsCoinBase() const
Definition: coins.h:55
CTxOut out
unspent transaction output
Definition: coins.h:34
bool IsSpent() const
Either this coin never existed (see e.g.
Definition: coins.h:79
uint32_t nHeight
at which height this containing transaction was included in the active block chain
Definition: coins.h:40
bool Invalid(Result result, const std::string &reject_reason="", const std::string &debug_message="")
Definition: validation.h:102
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
@ TX_PREMATURE_SPEND
transaction spends a coinbase too early, or violates locktime/sequence locks
@ TX_CONSENSUS
invalid by consensus rules
static constexpr unsigned int LOCKTIME_VERIFY_SEQUENCE
Flags for nSequence and nLockTime locks.
Definition: consensus.h:28
static const int COINBASE_MATURITY
Coinbase transaction outputs can only be spent after this number of new blocks (network rule)
Definition: consensus.h:19
static const int WITNESS_SCALE_FACTOR
Definition: consensus.h:21
size_t CountWitnessSigOps(const CScript &scriptSig, const CScript &scriptPubKey, const CScriptWitness *witness, unsigned int flags)
@ SCRIPT_VERIFY_P2SH
Definition: interpreter.h:46
std::string FormatMoney(const CAmount n)
Money parsing/formatting utilities.
Definition: moneystr.cpp:15
bool CheckTxInputs(const CTransaction &tx, TxValidationState &state, const CCoinsViewCache &inputs, int nSpendHeight, CAmount &txfee)
Check whether all inputs of this transaction are valid (no double spends and amounts) This does not m...
Definition: tx_verify.cpp:169
static const unsigned int LOCKTIME_THRESHOLD
Definition: script.h:40
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1164
bool EvaluateSequenceLocks(const CBlockIndex &block, std::pair< int, int64_t > lockPair)
Definition: tx_verify.cpp:102
std::pair< int, int64_t > CalculateSequenceLocks(const CTransaction &tx, int flags, std::vector< int > &prevHeights, const CBlockIndex &block)
Calculates the block height and previous block's median time past at which the transaction will be co...
Definition: tx_verify.cpp:40
int64_t GetTransactionSigOpCost(const CTransaction &tx, const CCoinsViewCache &inputs, uint32_t flags)
Compute total signature operation cost of a transaction.
Definition: tx_verify.cpp:148
unsigned int GetLegacySigOpCount(const CTransaction &tx)
Auxiliary functions for transaction validation (ideally should not be exposed)
Definition: tx_verify.cpp:117
bool SequenceLocks(const CTransaction &tx, int flags, std::vector< int > &prevHeights, const CBlockIndex &block)
Check if transaction is final per BIP 68 sequence numbers and can be included in a block.
Definition: tx_verify.cpp:112
unsigned int GetP2SHSigOpCount(const CTransaction &tx, const CCoinsViewCache &inputs)
Count ECDSA signature operations in pay-to-script-hash inputs.
Definition: tx_verify.cpp:131
bool IsFinalTx(const CTransaction &tx, int nBlockHeight, int64_t nBlockTime)
Check if transaction is final and can be included in a block with the specified height and time.
Definition: tx_verify.cpp:18
assert(!tx.IsCoinBase())