mirror/bitcoin
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(miniscript): Remove superfluous unique_ptr-indirection

Browse Source 
Functional parity is achieved through making Node move-able.

Unfortunately ~Node() now needs to have the recursion linter disabled, as it is unable to figure out that recursion stops 1 level down. The former smart pointers must have been circumventing the linter somehow.

NodeRef & MakeNodeRef() are deleted in the following commit (broken out to facilitate review).
This commit is contained in:
Hodlinator committed 2026-01-20 22:41:25 +01:00
1 parent e55b23c170
commit 15fb34de41
4 files changed
+189 -174
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

src/script/descriptor.cpp
+17 -15
View File
@@ -1584,13 +1584,13 @@ public:
class MiniscriptDescriptor final : public DescriptorImpl class MiniscriptDescriptor final : public DescriptorImpl
{ {
private: private:
miniscript::NodeRef<uint32_t> m_node; miniscript::Node<uint32_t> m_node;
protected: protected:
std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts, std::vector<CScript> MakeScripts(const std::vector<CPubKey>& keys, std::span<const CScript> scripts,
FlatSigningProvider& provider) const override FlatSigningProvider& provider) const override
{ {
const auto script_ctx{m_node->GetMsCtx()}; const auto script_ctx{m_node.GetMsCtx()};
for (const auto& key : keys) { for (const auto& key : keys) {
if (miniscript::IsTapscript(script_ctx)) { if (miniscript::IsTapscript(script_ctx)) {
provider.pubkeys.emplace(Hash160(XOnlyPubKey{key}), key); provider.pubkeys.emplace(Hash160(XOnlyPubKey{key}), key);
@@ -1598,15 +1598,15 @@ protected:
provider.pubkeys.emplace(key.GetID(), key); provider.pubkeys.emplace(key.GetID(), key);
} }
} }
return Vector(m_node->ToScript(ScriptMaker(keys, script_ctx))); return Vector(m_node.ToScript(ScriptMaker(keys, script_ctx)));
} }
public: public:
MiniscriptDescriptor(std::vector<std::unique_ptr<PubkeyProvider>> providers, miniscript::NodeRef<uint32_t> node) MiniscriptDescriptor(std::vector<std::unique_ptr<PubkeyProvider>> providers, miniscript::Node<uint32_t>&& node)
: DescriptorImpl(std::move(providers), "?"), m_node(std::move(node)) : DescriptorImpl(std::move(providers), "?"), m_node(std::move(node))
{ {
// Traverse miniscript tree for unsafe use of older() // Traverse miniscript tree for unsafe use of older()
miniscript::ForEachNode(*m_node, [&](const miniscript::Node<uint32_t>& node) { miniscript::ForEachNode(m_node, [&](const miniscript::Node<uint32_t>& node) {
if (node.Fragment() == miniscript::Fragment::OLDER) { if (node.Fragment() == miniscript::Fragment::OLDER) {
const uint32_t raw = node.K(); const uint32_t raw = node.K();
const uint32_t value_part = raw & ~CTxIn::SEQUENCE_LOCKTIME_TYPE_FLAG; const uint32_t value_part = raw & ~CTxIn::SEQUENCE_LOCKTIME_TYPE_FLAG;
@@ -1626,7 +1626,7 @@ public:
const DescriptorCache* cache = nullptr) const override const DescriptorCache* cache = nullptr) const override
{ {
bool has_priv_key{false}; bool has_priv_key{false};
auto res = m_node->ToString(StringMaker(arg, m_pubkey_args, type, cache), has_priv_key); auto res = m_node.ToString(StringMaker(arg, m_pubkey_args, type, cache), has_priv_key);
if (res) out = *res; if (res) out = *res;
if (type == StringType::PRIVATE) { if (type == StringType::PRIVATE) {
Assume(res.has_value()); Assume(res.has_value());
@@ -1639,15 +1639,17 @@ public:
bool IsSolvable() const override { return true; } bool IsSolvable() const override { return true; }
bool IsSingleType() const final { return true; } bool IsSingleType() const final { return true; }
std::optional<int64_t> ScriptSize() const override { return m_node->ScriptSize(); } std::optional<int64_t> ScriptSize() const override { return m_node.ScriptSize(); }
std::optional<int64_t> MaxSatSize(bool) const override { std::optional<int64_t> MaxSatSize(bool) const override
{
// For Miniscript we always assume high-R ECDSA signatures. // For Miniscript we always assume high-R ECDSA signatures.
return m_node->GetWitnessSize(); return m_node.GetWitnessSize();
} }
std::optional<int64_t> MaxSatisfactionElems() const override { std::optional<int64_t> MaxSatisfactionElems() const override
return m_node->GetStackSize(); {
return m_node.GetStackSize();
} }
std::unique_ptr<DescriptorImpl> Clone() const override std::unique_ptr<DescriptorImpl> Clone() const override
@@ -1657,7 +1659,7 @@ public:
for (const auto& arg : m_pubkey_args) { for (const auto& arg : m_pubkey_args) {
providers.push_back(arg->Clone()); providers.push_back(arg->Clone());
} }
return std::make_unique<MiniscriptDescriptor>(std::move(providers), m_node->Clone()); return std::make_unique<MiniscriptDescriptor>(std::move(providers), m_node.Clone());
} }
}; };
@@ -2566,7 +2568,7 @@ std::vector<std::unique_ptr<DescriptorImpl>> ParseScript(uint32_t& key_exp_index
} }
if (!node->IsSane() || node->IsNotSatisfiable()) { if (!node->IsSane() || node->IsNotSatisfiable()) {
// Try to find the first insane sub for better error reporting. // Try to find the first insane sub for better error reporting.
const decltype(node)::element_type* insane_node = node.get(); const auto* insane_node = &node.value();
if (const auto sub = node->FindInsaneSub()) insane_node = sub; if (const auto sub = node->FindInsaneSub()) insane_node = sub;
error = *insane_node->ToString(parser); error = *insane_node->ToString(parser);
if (!insane_node->IsValid()) { if (!insane_node->IsValid()) {
@@ -2575,7 +2577,7 @@ std::vector<std::unique_ptr<DescriptorImpl>> ParseScript(uint32_t& key_exp_index
error += " is not sane"; error += " is not sane";
if (!insane_node->IsNonMalleable()) { if (!insane_node->IsNonMalleable()) {
error += ": malleable witnesses exist"; error += ": malleable witnesses exist";
} else if (insane_node == node.get() && !insane_node->NeedsSignature()) { } else if (insane_node == &node.value() && !insane_node->NeedsSignature()) {
error += ": witnesses without signature exist"; error += ": witnesses without signature exist";
} else if (!insane_node->CheckTimeLocksMix()) { } else if (!insane_node->CheckTimeLocksMix()) {
error += ": contains mixes of timelocks expressed in blocks and seconds"; error += ": contains mixes of timelocks expressed in blocks and seconds";
@@ -2775,7 +2777,7 @@ std::unique_ptr<DescriptorImpl> InferScript(const CScript& script, ParseScriptCo
for (auto& key : parser.m_keys) { for (auto& key : parser.m_keys) {
keys.emplace_back(std::move(key.at(0))); keys.emplace_back(std::move(key.at(0)));
} }
return std::make_unique<MiniscriptDescriptor>(std::move(keys), std::move(node)); return std::make_unique<MiniscriptDescriptor>(std::move(keys), std::move(*node));
} }
} }
src/script/miniscript.h
+127 -116
View File
@@ -191,11 +191,11 @@ inline consteval Type operator""_mst(const char* c, size_t l)
using Opcode = std::pair<opcodetype, std::vector<unsigned char>>; using Opcode = std::pair<opcodetype, std::vector<unsigned char>>;
template<typename Key> class Node; template<typename Key> class Node;
template<typename Key> using NodeRef = std::unique_ptr<Node<Key>>; template<typename Key> using NodeRef = Node<Key>; // <- TODO: Remove in next commit.
//! Construct a miniscript node as a unique_ptr. //! Construct a miniscript node (TODO: remove in next commit).
template<typename Key, typename... Args> template<typename Key, typename... Args>
NodeRef<Key> MakeNodeRef(Args&&... args) { return std::make_unique<Node<Key>>(std::forward<Args>(args)...); } Node<Key> MakeNodeRef(Args&&... args) { return Node<Key>(std::forward<Args>(args)...); }
//! Unordered traversal of a miniscript node tree. //! Unordered traversal of a miniscript node tree.
template <typename Key, std::invocable<const Node<Key>&> Fn> template <typename Key, std::invocable<const Node<Key>&> Fn>
@@ -207,7 +207,7 @@ void ForEachNode(const Node<Key>& root, Fn&& fn)
std::invoke(fn, node); std::invoke(fn, node);
stack.pop_back(); stack.pop_back();
for (const auto& sub : node.Subs()) { for (const auto& sub : node.Subs()) {
stack.emplace_back(*sub); stack.emplace_back(sub);
} }
} }
} }
@@ -550,6 +550,8 @@ class Node
MiniscriptContext m_script_ctx; MiniscriptContext m_script_ctx;
public: public:
// Permit 1 level deep recursion since we own instances of our own type.
// NOLINTBEGIN(misc-no-recursion)
~Node() ~Node()
{ {
// Destroy the subexpressions iteratively after moving out their // Destroy the subexpressions iteratively after moving out their
@@ -558,23 +560,25 @@ public:
while (!subs.empty()) { while (!subs.empty()) {
auto node = std::move(subs.back()); auto node = std::move(subs.back());
subs.pop_back(); subs.pop_back();
while (!node->subs.empty()) { while (!node.subs.empty()) {
subs.push_back(std::move(node->subs.back())); subs.push_back(std::move(node.subs.back()));
node->subs.pop_back(); node.subs.pop_back();
} }
} }
} }
// NOLINTEND(misc-no-recursion)
NodeRef<Key> Clone() const Node<Key> Clone() const
{ {
// Use TreeEval() to avoid a stack-overflow due to recursion // Use TreeEval() to avoid a stack-overflow due to recursion
auto upfn = [](const Node& node, std::span<NodeRef<Key>> children) { auto upfn = [](const Node& node, std::span<NodeRef<Key>> children) {
std::vector<NodeRef<Key>> new_subs; std::vector<NodeRef<Key>> new_subs;
for (auto child = children.begin(); child != children.end(); ++child) { for (auto& child : children) {
new_subs.emplace_back(std::move(*child)); // It's fine to move from children as they are new nodes having
// been produced by calling this function one level down.
new_subs.push_back(std::move(child));
} }
// std::make_unique (and therefore MakeNodeRef) doesn't work on private constructors return Node{internal::NoDupCheck{}, node.m_script_ctx, node.fragment, std::move(new_subs), node.keys, node.data, node.k};
return std::unique_ptr<Node>{new Node{internal::NoDupCheck{}, node.m_script_ctx, node.fragment, std::move(new_subs), node.keys, node.data, node.k}};
}; };
return TreeEval<NodeRef<Key>>(upfn); return TreeEval<NodeRef<Key>>(upfn);
} }
@@ -610,12 +614,13 @@ private:
: fragment(nt), k(val), keys(key), data(std::move(arg)), subs(std::move(sub)), m_script_ctx{script_ctx}, ops(CalcOps()), ss(CalcStackSize()), ws(CalcWitnessSize()), typ(CalcType()), scriptlen(CalcScriptLen()) {} : fragment(nt), k(val), keys(key), data(std::move(arg)), subs(std::move(sub)), m_script_ctx{script_ctx}, ops(CalcOps()), ss(CalcStackSize()), ws(CalcWitnessSize()), typ(CalcType()), scriptlen(CalcScriptLen()) {}
//! Compute the length of the script for this miniscript (including children). //! Compute the length of the script for this miniscript (including children).
size_t CalcScriptLen() const { size_t CalcScriptLen() const
{
size_t subsize = 0; size_t subsize = 0;
for (const auto& sub : subs) { for (const auto& sub : subs) {
subsize += sub->ScriptSize(); subsize += sub.ScriptSize();
} }
Type sub0type = subs.size() > 0 ? subs[0]->GetType() : ""_mst; Type sub0type = subs.size() > 0 ? subs[0].GetType() : ""_mst;
return internal::ComputeScriptLen(fragment, sub0type, subsize, k, subs.size(), keys.size(), m_script_ctx); return internal::ComputeScriptLen(fragment, sub0type, subsize, k, subs.size(), keys.size(), m_script_ctx);
} }
@@ -686,7 +691,7 @@ private:
* that child (and all earlier children) will be at the end of `results`. */ * that child (and all earlier children) will be at the end of `results`. */
size_t child_index = stack.back().expanded++; size_t child_index = stack.back().expanded++;
State child_state = downfn(stack.back().state, node, child_index); State child_state = downfn(stack.back().state, node, child_index);
stack.emplace_back(*node.subs[child_index], 0, std::move(child_state)); stack.emplace_back(node.subs[child_index], 0, std::move(child_state));
continue; continue;
} }
// Invoke upfn with the last node.subs.size() elements of results as input. // Invoke upfn with the last node.subs.size() elements of results as input.
@@ -764,7 +769,7 @@ private:
if (b.subs.size() < a.subs.size()) return 1; if (b.subs.size() < a.subs.size()) return 1;
size_t n = a.subs.size(); size_t n = a.subs.size();
for (size_t i = 0; i < n; ++i) { for (size_t i = 0; i < n; ++i) {
queue.emplace_back(*a.subs[n - 1 - i], *b.subs[n - 1 - i]); queue.emplace_back(a.subs[n - 1 - i], b.subs[n - 1 - i]);
} }
} }
return 0; return 0;
@@ -777,12 +782,12 @@ private:
// THRESH has a variable number of subexpressions // THRESH has a variable number of subexpressions
std::vector<Type> sub_types; std::vector<Type> sub_types;
if (fragment == Fragment::THRESH) { if (fragment == Fragment::THRESH) {
for (const auto& sub : subs) sub_types.push_back(sub->GetType()); for (const auto& sub : subs) sub_types.push_back(sub.GetType());
} }
// All other nodes than THRESH can be computed just from the types of the 0-3 subexpressions. // All other nodes than THRESH can be computed just from the types of the 0-3 subexpressions.
Type x = subs.size() > 0 ? subs[0]->GetType() : ""_mst; Type x = subs.size() > 0 ? subs[0].GetType() : ""_mst;
Type y = subs.size() > 1 ? subs[1]->GetType() : ""_mst; Type y = subs.size() > 1 ? subs[1].GetType() : ""_mst;
Type z = subs.size() > 2 ? subs[2]->GetType() : ""_mst; Type z = subs.size() > 2 ? subs[2].GetType() : ""_mst;
return SanitizeType(ComputeType(fragment, x, y, z, sub_types, k, data.size(), subs.size(), keys.size(), m_script_ctx)); return SanitizeType(ComputeType(fragment, x, y, z, sub_types, k, data.size(), subs.size(), keys.size(), m_script_ctx));
} }
@@ -821,7 +826,7 @@ public:
case Fragment::WRAP_C: return BuildScript(std::move(subs[0]), verify ? OP_CHECKSIGVERIFY : OP_CHECKSIG); case Fragment::WRAP_C: return BuildScript(std::move(subs[0]), verify ? OP_CHECKSIGVERIFY : OP_CHECKSIG);
case Fragment::WRAP_D: return BuildScript(OP_DUP, OP_IF, subs[0], OP_ENDIF); case Fragment::WRAP_D: return BuildScript(OP_DUP, OP_IF, subs[0], OP_ENDIF);
case Fragment::WRAP_V: { case Fragment::WRAP_V: {
if (node.subs[0]->GetType() << "x"_mst) { if (node.subs[0].GetType() << "x"_mst) {
return BuildScript(std::move(subs[0]), OP_VERIFY); return BuildScript(std::move(subs[0]), OP_VERIFY);
} else { } else {
return std::move(subs[0]); return std::move(subs[0]);
@@ -883,9 +888,9 @@ public:
node.fragment == Fragment::WRAP_D || node.fragment == Fragment::WRAP_V || node.fragment == Fragment::WRAP_D || node.fragment == Fragment::WRAP_V ||
node.fragment == Fragment::WRAP_J || node.fragment == Fragment::WRAP_N || node.fragment == Fragment::WRAP_J || node.fragment == Fragment::WRAP_N ||
node.fragment == Fragment::WRAP_C || node.fragment == Fragment::WRAP_C ||
(node.fragment == Fragment::AND_V && node.subs[1]->fragment == Fragment::JUST_1) || (node.fragment == Fragment::AND_V && node.subs[1].fragment == Fragment::JUST_1) ||
(node.fragment == Fragment::OR_I && node.subs[0]->fragment == Fragment::JUST_0) || (node.fragment == Fragment::OR_I && node.subs[0].fragment == Fragment::JUST_0) ||
(node.fragment == Fragment::OR_I && node.subs[1]->fragment == Fragment::JUST_0)); (node.fragment == Fragment::OR_I && node.subs[1].fragment == Fragment::JUST_0));
}; };
auto toString = [&ctx, &has_priv_key](Key key) -> std::optional<std::string> { auto toString = [&ctx, &has_priv_key](Key key) -> std::optional<std::string> {
bool fragment_has_priv_key{false}; bool fragment_has_priv_key{false};
@@ -903,15 +908,15 @@ public:
case Fragment::WRAP_A: return "a" + std::move(subs[0]); case Fragment::WRAP_A: return "a" + std::move(subs[0]);
case Fragment::WRAP_S: return "s" + std::move(subs[0]); case Fragment::WRAP_S: return "s" + std::move(subs[0]);
case Fragment::WRAP_C: case Fragment::WRAP_C:
if (node.subs[0]->fragment == Fragment::PK_K) { if (node.subs[0].fragment == Fragment::PK_K) {
// pk(K) is syntactic sugar for c:pk_k(K) // pk(K) is syntactic sugar for c:pk_k(K)
auto key_str = toString(node.subs[0]->keys[0]); auto key_str = toString(node.subs[0].keys[0]);
if (!key_str) return {}; if (!key_str) return {};
return std::move(ret) + "pk(" + std::move(*key_str) + ")"; return std::move(ret) + "pk(" + std::move(*key_str) + ")";
} }
if (node.subs[0]->fragment == Fragment::PK_H) { if (node.subs[0].fragment == Fragment::PK_H) {
// pkh(K) is syntactic sugar for c:pk_h(K) // pkh(K) is syntactic sugar for c:pk_h(K)
auto key_str = toString(node.subs[0]->keys[0]); auto key_str = toString(node.subs[0].keys[0]);
if (!key_str) return {}; if (!key_str) return {};
return std::move(ret) + "pkh(" + std::move(*key_str) + ")"; return std::move(ret) + "pkh(" + std::move(*key_str) + ")";
} }
@@ -922,11 +927,11 @@ public:
case Fragment::WRAP_N: return "n" + std::move(subs[0]); case Fragment::WRAP_N: return "n" + std::move(subs[0]);
case Fragment::AND_V: case Fragment::AND_V:
// t:X is syntactic sugar for and_v(X,1). // t:X is syntactic sugar for and_v(X,1).
if (node.subs[1]->fragment == Fragment::JUST_1) return "t" + std::move(subs[0]); if (node.subs[1].fragment == Fragment::JUST_1) return "t" + std::move(subs[0]);
break; break;
case Fragment::OR_I: case Fragment::OR_I:
if (node.subs[0]->fragment == Fragment::JUST_0) return "l" + std::move(subs[1]); if (node.subs[0].fragment == Fragment::JUST_0) return "l" + std::move(subs[1]);
if (node.subs[1]->fragment == Fragment::JUST_0) return "u" + std::move(subs[0]); if (node.subs[1].fragment == Fragment::JUST_0) return "u" + std::move(subs[0]);
break; break;
default: break; default: break;
} }
@@ -957,7 +962,7 @@ public:
case Fragment::OR_I: return std::move(ret) + "or_i(" + std::move(subs[0]) + "," + std::move(subs[1]) + ")"; case Fragment::OR_I: return std::move(ret) + "or_i(" + std::move(subs[0]) + "," + std::move(subs[1]) + ")";
case Fragment::ANDOR: case Fragment::ANDOR:
// and_n(X,Y) is syntactic sugar for andor(X,Y,0). // and_n(X,Y) is syntactic sugar for andor(X,Y,0).
if (node.subs[2]->fragment == Fragment::JUST_0) return std::move(ret) + "and_n(" + std::move(subs[0]) + "," + std::move(subs[1]) + ")"; if (node.subs[2].fragment == Fragment::JUST_0) return std::move(ret) + "and_n(" + std::move(subs[0]) + "," + std::move(subs[1]) + ")";
return std::move(ret) + "andor(" + std::move(subs[0]) + "," + std::move(subs[1]) + "," + std::move(subs[2]) + ")"; return std::move(ret) + "andor(" + std::move(subs[0]) + "," + std::move(subs[1]) + "," + std::move(subs[2]) + ")";
case Fragment::MULTI: { case Fragment::MULTI: {
CHECK_NONFATAL(!is_tapscript); CHECK_NONFATAL(!is_tapscript);
@@ -1007,59 +1012,59 @@ private:
case Fragment::RIPEMD160: case Fragment::RIPEMD160:
case Fragment::HASH256: case Fragment::HASH256:
case Fragment::HASH160: return {4, 0, {}}; case Fragment::HASH160: return {4, 0, {}};
case Fragment::AND_V: return {subs[0]->ops.count + subs[1]->ops.count, subs[0]->ops.sat + subs[1]->ops.sat, {}}; case Fragment::AND_V: return {subs[0].ops.count + subs[1].ops.count, subs[0].ops.sat + subs[1].ops.sat, {}};
case Fragment::AND_B: { case Fragment::AND_B: {
const auto count{1 + subs[0]->ops.count + subs[1]->ops.count}; const auto count{1 + subs[0].ops.count + subs[1].ops.count};
const auto sat{subs[0]->ops.sat + subs[1]->ops.sat}; const auto sat{subs[0].ops.sat + subs[1].ops.sat};
const auto dsat{subs[0]->ops.dsat + subs[1]->ops.dsat}; const auto dsat{subs[0].ops.dsat + subs[1].ops.dsat};
return {count, sat, dsat}; return {count, sat, dsat};
} }
case Fragment::OR_B: { case Fragment::OR_B: {
const auto count{1 + subs[0]->ops.count + subs[1]->ops.count}; const auto count{1 + subs[0].ops.count + subs[1].ops.count};
const auto sat{(subs[0]->ops.sat + subs[1]->ops.dsat) | (subs[1]->ops.sat + subs[0]->ops.dsat)}; const auto sat{(subs[0].ops.sat + subs[1].ops.dsat) | (subs[1].ops.sat + subs[0].ops.dsat)};
const auto dsat{subs[0]->ops.dsat + subs[1]->ops.dsat}; const auto dsat{subs[0].ops.dsat + subs[1].ops.dsat};
return {count, sat, dsat}; return {count, sat, dsat};
} }
case Fragment::OR_D: { case Fragment::OR_D: {
const auto count{3 + subs[0]->ops.count + subs[1]->ops.count}; const auto count{3 + subs[0].ops.count + subs[1].ops.count};
const auto sat{subs[0]->ops.sat | (subs[1]->ops.sat + subs[0]->ops.dsat)}; const auto sat{subs[0].ops.sat | (subs[1].ops.sat + subs[0].ops.dsat)};
const auto dsat{subs[0]->ops.dsat + subs[1]->ops.dsat}; const auto dsat{subs[0].ops.dsat + subs[1].ops.dsat};
return {count, sat, dsat}; return {count, sat, dsat};
} }
case Fragment::OR_C: { case Fragment::OR_C: {
const auto count{2 + subs[0]->ops.count + subs[1]->ops.count}; const auto count{2 + subs[0].ops.count + subs[1].ops.count};
const auto sat{subs[0]->ops.sat | (subs[1]->ops.sat + subs[0]->ops.dsat)}; const auto sat{subs[0].ops.sat | (subs[1].ops.sat + subs[0].ops.dsat)};
return {count, sat, {}}; return {count, sat, {}};
} }
case Fragment::OR_I: { case Fragment::OR_I: {
const auto count{3 + subs[0]->ops.count + subs[1]->ops.count}; const auto count{3 + subs[0].ops.count + subs[1].ops.count};
const auto sat{subs[0]->ops.sat | subs[1]->ops.sat}; const auto sat{subs[0].ops.sat | subs[1].ops.sat};
const auto dsat{subs[0]->ops.dsat | subs[1]->ops.dsat}; const auto dsat{subs[0].ops.dsat | subs[1].ops.dsat};
return {count, sat, dsat}; return {count, sat, dsat};
} }
case Fragment::ANDOR: { case Fragment::ANDOR: {
const auto count{3 + subs[0]->ops.count + subs[1]->ops.count + subs[2]->ops.count}; const auto count{3 + subs[0].ops.count + subs[1].ops.count + subs[2].ops.count};
const auto sat{(subs[1]->ops.sat + subs[0]->ops.sat) | (subs[0]->ops.dsat + subs[2]->ops.sat)}; const auto sat{(subs[1].ops.sat + subs[0].ops.sat) | (subs[0].ops.dsat + subs[2].ops.sat)};
const auto dsat{subs[0]->ops.dsat + subs[2]->ops.dsat}; const auto dsat{subs[0].ops.dsat + subs[2].ops.dsat};
return {count, sat, dsat}; return {count, sat, dsat};
} }
case Fragment::MULTI: return {1, (uint32_t)keys.size(), (uint32_t)keys.size()}; case Fragment::MULTI: return {1, (uint32_t)keys.size(), (uint32_t)keys.size()};
case Fragment::MULTI_A: return {(uint32_t)keys.size() + 1, 0, 0}; case Fragment::MULTI_A: return {(uint32_t)keys.size() + 1, 0, 0};
case Fragment::WRAP_S: case Fragment::WRAP_S:
case Fragment::WRAP_C: case Fragment::WRAP_C:
case Fragment::WRAP_N: return {1 + subs[0]->ops.count, subs[0]->ops.sat, subs[0]->ops.dsat}; case Fragment::WRAP_N: return {1 + subs[0].ops.count, subs[0].ops.sat, subs[0].ops.dsat};
case Fragment::WRAP_A: return {2 + subs[0]->ops.count, subs[0]->ops.sat, subs[0]->ops.dsat}; case Fragment::WRAP_A: return {2 + subs[0].ops.count, subs[0].ops.sat, subs[0].ops.dsat};
case Fragment::WRAP_D: return {3 + subs[0]->ops.count, subs[0]->ops.sat, 0}; case Fragment::WRAP_D: return {3 + subs[0].ops.count, subs[0].ops.sat, 0};
case Fragment::WRAP_J: return {4 + subs[0]->ops.count, subs[0]->ops.sat, 0}; case Fragment::WRAP_J: return {4 + subs[0].ops.count, subs[0].ops.sat, 0};
case Fragment::WRAP_V: return {subs[0]->ops.count + (subs[0]->GetType() << "x"_mst), subs[0]->ops.sat, {}}; case Fragment::WRAP_V: return {subs[0].ops.count + (subs[0].GetType() << "x"_mst), subs[0].ops.sat, {}};
case Fragment::THRESH: { case Fragment::THRESH: {
uint32_t count = 0; uint32_t count = 0;
auto sats = Vector(internal::MaxInt<uint32_t>(0)); auto sats = Vector(internal::MaxInt<uint32_t>(0));
for (const auto& sub : subs) { for (const auto& sub : subs) {
count += sub->ops.count + 1; count += sub.ops.count + 1;
auto next_sats = Vector(sats[0] + sub->ops.dsat); auto next_sats = Vector(sats[0] + sub.ops.dsat);
for (size_t j = 1; j < sats.size(); ++j) next_sats.push_back((sats[j] + sub->ops.dsat) | (sats[j - 1] + sub->ops.sat)); for (size_t j = 1; j < sats.size(); ++j) next_sats.push_back((sats[j] + sub.ops.dsat) | (sats[j - 1] + sub.ops.sat));
next_sats.push_back(sats[sats.size() - 1] + sub->ops.sat); next_sats.push_back(sats[sats.size() - 1] + sub.ops.sat);
sats = std::move(next_sats); sats = std::move(next_sats);
} }
assert(k < sats.size()); assert(k < sats.size());
@@ -1086,48 +1091,48 @@ private:
{} {}
}; };
case Fragment::ANDOR: { case Fragment::ANDOR: {
const auto& x{subs[0]->ss}; const auto& x{subs[0].ss};
const auto& y{subs[1]->ss}; const auto& y{subs[1].ss};
const auto& z{subs[2]->ss}; const auto& z{subs[2].ss};
return { return {
(x.Sat() + SatInfo::If() + y.Sat()) | (x.Dsat() + SatInfo::If() + z.Sat()), (x.Sat() + SatInfo::If() + y.Sat()) | (x.Dsat() + SatInfo::If() + z.Sat()),
x.Dsat() + SatInfo::If() + z.Dsat() x.Dsat() + SatInfo::If() + z.Dsat()
}; };
} }
case Fragment::AND_V: { case Fragment::AND_V: {
const auto& x{subs[0]->ss}; const auto& x{subs[0].ss};
const auto& y{subs[1]->ss}; const auto& y{subs[1].ss};
return {x.Sat() + y.Sat(), {}}; return {x.Sat() + y.Sat(), {}};
} }
case Fragment::AND_B: { case Fragment::AND_B: {
const auto& x{subs[0]->ss}; const auto& x{subs[0].ss};
const auto& y{subs[1]->ss}; const auto& y{subs[1].ss};
return {x.Sat() + y.Sat() + SatInfo::BinaryOp(), x.Dsat() + y.Dsat() + SatInfo::BinaryOp()}; return {x.Sat() + y.Sat() + SatInfo::BinaryOp(), x.Dsat() + y.Dsat() + SatInfo::BinaryOp()};
} }
case Fragment::OR_B: { case Fragment::OR_B: {
const auto& x{subs[0]->ss}; const auto& x{subs[0].ss};
const auto& y{subs[1]->ss}; const auto& y{subs[1].ss};
return { return {
((x.Sat() + y.Dsat()) | (x.Dsat() + y.Sat())) + SatInfo::BinaryOp(), ((x.Sat() + y.Dsat()) | (x.Dsat() + y.Sat())) + SatInfo::BinaryOp(),
x.Dsat() + y.Dsat() + SatInfo::BinaryOp() x.Dsat() + y.Dsat() + SatInfo::BinaryOp()
}; };
} }
case Fragment::OR_C: { case Fragment::OR_C: {
const auto& x{subs[0]->ss}; const auto& x{subs[0].ss};
const auto& y{subs[1]->ss}; const auto& y{subs[1].ss};
return {(x.Sat() + SatInfo::If()) | (x.Dsat() + SatInfo::If() + y.Sat()), {}}; return {(x.Sat() + SatInfo::If()) | (x.Dsat() + SatInfo::If() + y.Sat()), {}};
} }
case Fragment::OR_D: { case Fragment::OR_D: {
const auto& x{subs[0]->ss}; const auto& x{subs[0].ss};
const auto& y{subs[1]->ss}; const auto& y{subs[1].ss};
return { return {
(x.Sat() + SatInfo::OP_IFDUP(true) + SatInfo::If()) | (x.Dsat() + SatInfo::OP_IFDUP(false) + SatInfo::If() + y.Sat()), (x.Sat() + SatInfo::OP_IFDUP(true) + SatInfo::If()) | (x.Dsat() + SatInfo::OP_IFDUP(false) + SatInfo::If() + y.Sat()),
x.Dsat() + SatInfo::OP_IFDUP(false) + SatInfo::If() + y.Dsat() x.Dsat() + SatInfo::OP_IFDUP(false) + SatInfo::If() + y.Dsat()
}; };
} }
case Fragment::OR_I: { case Fragment::OR_I: {
const auto& x{subs[0]->ss}; const auto& x{subs[0].ss};
const auto& y{subs[1]->ss}; const auto& y{subs[1].ss};
return {SatInfo::If() + (x.Sat() | y.Sat()), SatInfo::If() + (x.Dsat() | y.Dsat())}; return {SatInfo::If() + (x.Sat() | y.Sat()), SatInfo::If() + (x.Dsat() | y.Dsat())};
} }
// multi(k, key1, key2, ..., key_n) starts off with k+1 stack elements (a 0, plus k // multi(k, key1, key2, ..., key_n) starts off with k+1 stack elements (a 0, plus k
@@ -1141,18 +1146,18 @@ private:
case Fragment::MULTI_A: return {SatInfo(keys.size() - 1, keys.size())}; case Fragment::MULTI_A: return {SatInfo(keys.size() - 1, keys.size())};
case Fragment::WRAP_A: case Fragment::WRAP_A:
case Fragment::WRAP_N: case Fragment::WRAP_N:
case Fragment::WRAP_S: return subs[0]->ss; case Fragment::WRAP_S: return subs[0].ss;
case Fragment::WRAP_C: return { case Fragment::WRAP_C: return {
subs[0]->ss.Sat() + SatInfo::OP_CHECKSIG(), subs[0].ss.Sat() + SatInfo::OP_CHECKSIG(),
subs[0]->ss.Dsat() + SatInfo::OP_CHECKSIG() subs[0].ss.Dsat() + SatInfo::OP_CHECKSIG()
}; };
case Fragment::WRAP_D: return { case Fragment::WRAP_D: return {
SatInfo::OP_DUP() + SatInfo::If() + subs[0]->ss.Sat(), SatInfo::OP_DUP() + SatInfo::If() + subs[0].ss.Sat(),
SatInfo::OP_DUP() + SatInfo::If() SatInfo::OP_DUP() + SatInfo::If()
}; };
case Fragment::WRAP_V: return {subs[0]->ss.Sat() + SatInfo::OP_VERIFY(), {}}; case Fragment::WRAP_V: return {subs[0].ss.Sat() + SatInfo::OP_VERIFY(), {}};
case Fragment::WRAP_J: return { case Fragment::WRAP_J: return {
SatInfo::OP_SIZE() + SatInfo::OP_0NOTEQUAL() + SatInfo::If() + subs[0]->ss.Sat(), SatInfo::OP_SIZE() + SatInfo::OP_0NOTEQUAL() + SatInfo::If() + subs[0].ss.Sat(),
SatInfo::OP_SIZE() + SatInfo::OP_0NOTEQUAL() + SatInfo::If() SatInfo::OP_SIZE() + SatInfo::OP_0NOTEQUAL() + SatInfo::If()
}; };
case Fragment::THRESH: { case Fragment::THRESH: {
@@ -1163,13 +1168,13 @@ private:
// element i we need to add OP_ADD (if i>0). // element i we need to add OP_ADD (if i>0).
auto add = i ? SatInfo::BinaryOp() : SatInfo::Empty(); auto add = i ? SatInfo::BinaryOp() : SatInfo::Empty();
// Construct a variable that will become the next sats, starting with index 0. // Construct a variable that will become the next sats, starting with index 0.
auto next_sats = Vector(sats[0] + subs[i]->ss.Dsat() + add); auto next_sats = Vector(sats[0] + subs[i].ss.Dsat() + add);
// Then loop to construct next_sats[1..i]. // Then loop to construct next_sats[1..i].
for (size_t j = 1; j < sats.size(); ++j) { for (size_t j = 1; j < sats.size(); ++j) {
next_sats.push_back(((sats[j] + subs[i]->ss.Dsat()) | (sats[j - 1] + subs[i]->ss.Sat())) + add); next_sats.push_back(((sats[j] + subs[i].ss.Dsat()) | (sats[j - 1] + subs[i].ss.Sat())) + add);
} }
// Finally construct next_sats[i+1]. // Finally construct next_sats[i+1].
next_sats.push_back(sats[sats.size() - 1] + subs[i]->ss.Sat() + add); next_sats.push_back(sats[sats.size() - 1] + subs[i].ss.Sat() + add);
// Switch over. // Switch over.
sats = std::move(next_sats); sats = std::move(next_sats);
} }
@@ -1199,35 +1204,35 @@ private:
case Fragment::HASH256: case Fragment::HASH256:
case Fragment::HASH160: return {1 + 32, {}}; case Fragment::HASH160: return {1 + 32, {}};
case Fragment::ANDOR: { case Fragment::ANDOR: {
const auto sat{(subs[0]->ws.sat + subs[1]->ws.sat) | (subs[0]->ws.dsat + subs[2]->ws.sat)}; const auto sat{(subs[0].ws.sat + subs[1].ws.sat) | (subs[0].ws.dsat + subs[2].ws.sat)};
const auto dsat{subs[0]->ws.dsat + subs[2]->ws.dsat}; const auto dsat{subs[0].ws.dsat + subs[2].ws.dsat};
return {sat, dsat}; return {sat, dsat};
} }
case Fragment::AND_V: return {subs[0]->ws.sat + subs[1]->ws.sat, {}}; case Fragment::AND_V: return {subs[0].ws.sat + subs[1].ws.sat, {}};
case Fragment::AND_B: return {subs[0]->ws.sat + subs[1]->ws.sat, subs[0]->ws.dsat + subs[1]->ws.dsat}; case Fragment::AND_B: return {subs[0].ws.sat + subs[1].ws.sat, subs[0].ws.dsat + subs[1].ws.dsat};
case Fragment::OR_B: { case Fragment::OR_B: {
const auto sat{(subs[0]->ws.dsat + subs[1]->ws.sat) | (subs[0]->ws.sat + subs[1]->ws.dsat)}; const auto sat{(subs[0].ws.dsat + subs[1].ws.sat) | (subs[0].ws.sat + subs[1].ws.dsat)};
const auto dsat{subs[0]->ws.dsat + subs[1]->ws.dsat}; const auto dsat{subs[0].ws.dsat + subs[1].ws.dsat};
return {sat, dsat}; return {sat, dsat};
} }
case Fragment::OR_C: return {subs[0]->ws.sat | (subs[0]->ws.dsat + subs[1]->ws.sat), {}}; case Fragment::OR_C: return {subs[0].ws.sat | (subs[0].ws.dsat + subs[1].ws.sat), {}};
case Fragment::OR_D: return {subs[0]->ws.sat | (subs[0]->ws.dsat + subs[1]->ws.sat), subs[0]->ws.dsat + subs[1]->ws.dsat}; case Fragment::OR_D: return {subs[0].ws.sat | (subs[0].ws.dsat + subs[1].ws.sat), subs[0].ws.dsat + subs[1].ws.dsat};
case Fragment::OR_I: return {(subs[0]->ws.sat + 1 + 1) | (subs[1]->ws.sat + 1), (subs[0]->ws.dsat + 1 + 1) | (subs[1]->ws.dsat + 1)}; case Fragment::OR_I: return {(subs[0].ws.sat + 1 + 1) | (subs[1].ws.sat + 1), (subs[0].ws.dsat + 1 + 1) | (subs[1].ws.dsat + 1)};
case Fragment::MULTI: return {k * sig_size + 1, k + 1}; case Fragment::MULTI: return {k * sig_size + 1, k + 1};
case Fragment::MULTI_A: return {k * sig_size + static_cast<uint32_t>(keys.size()) - k, static_cast<uint32_t>(keys.size())}; case Fragment::MULTI_A: return {k * sig_size + static_cast<uint32_t>(keys.size()) - k, static_cast<uint32_t>(keys.size())};
case Fragment::WRAP_A: case Fragment::WRAP_A:
case Fragment::WRAP_N: case Fragment::WRAP_N:
case Fragment::WRAP_S: case Fragment::WRAP_S:
case Fragment::WRAP_C: return subs[0]->ws; case Fragment::WRAP_C: return subs[0].ws;
case Fragment::WRAP_D: return {1 + 1 + subs[0]->ws.sat, 1}; case Fragment::WRAP_D: return {1 + 1 + subs[0].ws.sat, 1};
case Fragment::WRAP_V: return {subs[0]->ws.sat, {}}; case Fragment::WRAP_V: return {subs[0].ws.sat, {}};
case Fragment::WRAP_J: return {subs[0]->ws.sat, 1}; case Fragment::WRAP_J: return {subs[0].ws.sat, 1};
case Fragment::THRESH: { case Fragment::THRESH: {
auto sats = Vector(internal::MaxInt<uint32_t>(0)); auto sats = Vector(internal::MaxInt<uint32_t>(0));
for (const auto& sub : subs) { for (const auto& sub : subs) {
auto next_sats = Vector(sats[0] + sub->ws.dsat); auto next_sats = Vector(sats[0] + sub.ws.dsat);
for (size_t j = 1; j < sats.size(); ++j) next_sats.push_back((sats[j] + sub->ws.dsat) | (sats[j - 1] + sub->ws.sat)); for (size_t j = 1; j < sats.size(); ++j) next_sats.push_back((sats[j] + sub.ws.dsat) | (sats[j - 1] + sub.ws.sat));
next_sats.push_back(sats[sats.size() - 1] + sub->ws.sat); next_sats.push_back(sats[sats.size() - 1] + sub.ws.sat);
sats = std::move(next_sats); sats = std::move(next_sats);
} }
assert(k < sats.size()); assert(k < sats.size());
@@ -1741,6 +1746,10 @@ public:
// Delete copy constructor and assignment operator, use Clone() instead // Delete copy constructor and assignment operator, use Clone() instead
Node(const Node&) = delete; Node(const Node&) = delete;
Node& operator=(const Node&) = delete; Node& operator=(const Node&) = delete;
// subs is movable, circumventing recursion, so these are permitted.
Node(Node&&) noexcept = default;
Node& operator=(Node&&) noexcept = default;
}; };
namespace internal { namespace internal {
@@ -1844,8 +1853,8 @@ void BuildBack(const MiniscriptContext script_ctx, Fragment nt, std::vector<Node
* This does not check whether the script is valid, let alone sane. The caller is expected to use * This does not check whether the script is valid, let alone sane. The caller is expected to use
* the `IsValidTopLevel()` and `IsSaneTopLevel()` to check for these properties on the node. * the `IsValidTopLevel()` and `IsSaneTopLevel()` to check for these properties on the node.
*/ */
template<typename Key, typename Ctx> template <typename Key, typename Ctx>
inline NodeRef<Key> Parse(std::span<const char> in, const Ctx& ctx) inline std::optional<Node<Key>> Parse(std::span<const char> in, const Ctx& ctx)
{ {
using namespace script; using namespace script;
@@ -2125,7 +2134,7 @@ inline NodeRef<Key> Parse(std::span<const char> in, const Ctx& ctx)
break; break;
} }
case ParseContext::VERIFY: { case ParseContext::VERIFY: {
script_size += (constructed.back()->GetType() << "x"_mst); script_size += (constructed.back().GetType() << "x"_mst);
constructed.back() = MakeNodeRef<Key>(internal::NoDupCheck{}, ctx.MsContext(), Fragment::WRAP_V, Vector(std::move(constructed.back()))); constructed.back() = MakeNodeRef<Key>(internal::NoDupCheck{}, ctx.MsContext(), Fragment::WRAP_V, Vector(std::move(constructed.back())));
break; break;
} }
@@ -2214,10 +2223,10 @@ inline NodeRef<Key> Parse(std::span<const char> in, const Ctx& ctx)
// Sanity checks on the produced miniscript // Sanity checks on the produced miniscript
assert(constructed.size() >= 1); assert(constructed.size() >= 1);
CHECK_NONFATAL(constructed.size() == 1); CHECK_NONFATAL(constructed.size() == 1);
assert(constructed[0]->ScriptSize() == script_size); assert(constructed[0].ScriptSize() == script_size);
if (in.size() > 0) return {}; if (in.size() > 0) return {};
NodeRef<Key> tl_node = std::move(constructed.front()); Node<Key> tl_node{std::move(constructed.front())};
tl_node->DuplicateKeyCheck(ctx); tl_node.DuplicateKeyCheck(ctx);
return tl_node; return tl_node;
} }
@@ -2303,8 +2312,8 @@ enum class DecodeContext {
}; };
//! Parse a miniscript from a bitcoin script //! Parse a miniscript from a bitcoin script
template<typename Key, typename Ctx, typename I> template <typename Key, typename Ctx, typename I>
inline NodeRef<Key> DecodeScript(I& in, I last, const Ctx& ctx) inline std::optional<Node<Key>> DecodeScript(I& in, I last, const Ctx& ctx)
{ {
// The two integers are used to hold state for thresh() // The two integers are used to hold state for thresh()
std::vector<std::tuple<DecodeContext, int64_t, int64_t>> to_parse; std::vector<std::tuple<DecodeContext, int64_t, int64_t>> to_parse;
@@ -2316,7 +2325,7 @@ inline NodeRef<Key> DecodeScript(I& in, I last, const Ctx& ctx)
while (!to_parse.empty()) { while (!to_parse.empty()) {
// Exit early if the Miniscript is not going to be valid. // Exit early if the Miniscript is not going to be valid.
if (!constructed.empty() && !constructed.back()->IsValid()) return {}; if (!constructed.empty() && !constructed.back().IsValid()) return {};
// Get the current context we are decoding within // Get the current context we are decoding within
auto [cur_context, n, k] = to_parse.back(); auto [cur_context, n, k] = to_parse.back();
@@ -2682,23 +2691,25 @@ inline NodeRef<Key> DecodeScript(I& in, I last, const Ctx& ctx)
} }
} }
if (constructed.size() != 1) return {}; if (constructed.size() != 1) return {};
NodeRef<Key> tl_node = std::move(constructed.front()); Node tl_node{std::move(constructed.front())};
tl_node->DuplicateKeyCheck(ctx); tl_node.DuplicateKeyCheck(ctx);
// Note that due to how ComputeType works (only assign the type to the node if the // Note that due to how ComputeType works (only assign the type to the node if the
// subs' types are valid) this would fail if any node of tree is badly typed. // subs' types are valid) this would fail if any node of tree is badly typed.
if (!tl_node->IsValidTopLevel()) return {}; if (!tl_node.IsValidTopLevel()) return {};
return tl_node; return tl_node;
} }
} // namespace internal } // namespace internal
template<typename Ctx> template <typename Ctx>
inline NodeRef<typename Ctx::Key> FromString(const std::string& str, const Ctx& ctx) { inline std::optional<Node<typename Ctx::Key>> FromString(const std::string& str, const Ctx& ctx)
{
return internal::Parse<typename Ctx::Key>(str, ctx); return internal::Parse<typename Ctx::Key>(str, ctx);
} }
template<typename Ctx> template <typename Ctx>
inline NodeRef<typename Ctx::Key> FromScript(const CScript& script, const Ctx& ctx) { inline std::optional<Node<typename Ctx::Key>> FromScript(const CScript& script, const Ctx& ctx)
{
using namespace internal; using namespace internal;
// A too large Script is necessarily invalid, don't bother parsing it. // A too large Script is necessarily invalid, don't bother parsing it.
if (script.size() > MaxScriptSize(ctx.MsContext())) return {}; if (script.size() > MaxScriptSize(ctx.MsContext())) return {};
src/test/fuzz/miniscript.cpp
+21 -19
View File
@@ -15,6 +15,7 @@
#include <util/strencodings.h> #include <util/strencodings.h>
#include <algorithm> #include <algorithm>
#include <optional>
namespace { namespace {
@@ -852,12 +853,13 @@ std::optional<NodeInfo> ConsumeNodeSmart(MsCtx script_ctx, FuzzedDataProvider& p
* Generate a Miniscript node based on the fuzzer's input. * Generate a Miniscript node based on the fuzzer's input.
* *
* - ConsumeNode is a function object taking a Type, and returning an std::optional<NodeInfo>. * - ConsumeNode is a function object taking a Type, and returning an std::optional<NodeInfo>.
* - root_type is the required type properties of the constructed NodeRef. * - root_type is the required type properties of the constructed Node.
* - strict_valid sets whether ConsumeNode is expected to guarantee a NodeInfo that results in * - strict_valid sets whether ConsumeNode is expected to guarantee a NodeInfo that results in
* a NodeRef whose Type() matches the type fed to ConsumeNode. * a Node whose Type() matches the type fed to ConsumeNode.
*/ */
template<typename F> template <typename F>
NodeRef GenNode(MsCtx script_ctx, F ConsumeNode, Type root_type, bool strict_valid = false) { std::optional<Node> GenNode(MsCtx script_ctx, F ConsumeNode, Type root_type, bool strict_valid = false)
{
/** A stack of miniscript Nodes being built up. */ /** A stack of miniscript Nodes being built up. */
std::vector<NodeRef> stack; std::vector<NodeRef> stack;
/** The queue of instructions. */ /** The queue of instructions. */
@@ -972,26 +974,26 @@ NodeRef GenNode(MsCtx script_ctx, F ConsumeNode, Type root_type, bool strict_val
sub.push_back(std::move(*(stack.end() - info.subtypes.size() + i))); sub.push_back(std::move(*(stack.end() - info.subtypes.size() + i)));
} }
stack.erase(stack.end() - info.subtypes.size(), stack.end()); stack.erase(stack.end() - info.subtypes.size(), stack.end());
// Construct new NodeRef. // Construct new Node.
NodeRef node; Node node{[&] {
if (info.keys.empty()) { if (info.keys.empty()) {
node = MakeNodeRef(script_ctx, info.fragment, std::move(sub), std::move(info.hash), info.k); return Node{miniscript::internal::NoDupCheck{}, script_ctx, info.fragment, std::move(sub), std::move(info.hash), info.k};
} else { }
assert(sub.empty()); assert(sub.empty());
assert(info.hash.empty()); assert(info.hash.empty());
node = MakeNodeRef(script_ctx, info.fragment, std::move(info.keys), info.k); return Node{miniscript::internal::NoDupCheck{}, script_ctx, info.fragment, std::move(info.keys), info.k};
} }()};
// Verify acceptability. // Verify acceptability.
if (!node || (node->GetType() & "KVWB"_mst) == ""_mst) { if ((node.GetType() & "KVWB"_mst) == ""_mst) {
assert(!strict_valid); assert(!strict_valid);
return {}; return {};
} }
if (!(type_needed == ""_mst)) { if (!(type_needed == ""_mst)) {
assert(node->GetType() << type_needed); assert(node.GetType() << type_needed);
} }
if (!node->IsValid()) return {}; if (!node.IsValid()) return {};
// Update resource predictions. // Update resource predictions.
if (node->Fragment() == Fragment::WRAP_V && node->Subs()[0]->GetType() << "x"_mst) { if (node.Fragment() == Fragment::WRAP_V && node.Subs()[0].GetType() << "x"_mst) {
ops += 1; ops += 1;
scriptsize += 1; scriptsize += 1;
} }
@@ -1005,9 +1007,9 @@ NodeRef GenNode(MsCtx script_ctx, F ConsumeNode, Type root_type, bool strict_val
} }
} }
assert(stack.size() == 1); assert(stack.size() == 1);
assert(stack[0]->GetStaticOps() == ops); assert(stack[0].GetStaticOps() == ops);
assert(stack[0]->ScriptSize() == scriptsize); assert(stack[0].ScriptSize() == scriptsize);
stack[0]->DuplicateKeyCheck(KEY_COMP); stack[0].DuplicateKeyCheck(KEY_COMP);
return std::move(stack[0]); return std::move(stack[0]);
} }
@@ -1032,7 +1034,7 @@ void SatisfactionToWitness(MsCtx ctx, CScriptWitness& witness, const CScript& sc
} }
/** Perform various applicable tests on a miniscript Node. */ /** Perform various applicable tests on a miniscript Node. */
void TestNode(const MsCtx script_ctx, const NodeRef& node, FuzzedDataProvider& provider) void TestNode(const MsCtx script_ctx, const std::optional<Node>& node, FuzzedDataProvider& provider)
{ {
if (!node) return; if (!node) return;
src/test/miniscript_tests.cpp
+24 -24
View File
@@ -297,11 +297,11 @@ using miniscript::operator""_mst;
using Node = miniscript::Node<CPubKey>; using Node = miniscript::Node<CPubKey>;
/** Compute all challenges (pubkeys, hashes, timelocks) that occur in a given Miniscript. */ /** Compute all challenges (pubkeys, hashes, timelocks) that occur in a given Miniscript. */
std::set<Challenge> FindChallenges(const Node* root) std::set<Challenge> FindChallenges(const Node& root)
{ {
std::set<Challenge> chal; std::set<Challenge> chal;
for (std::vector stack{root}; !stack.empty();) { for (std::vector stack{&root}; !stack.empty();) {
const auto* ref{stack.back()}; const auto* ref{stack.back()};
stack.pop_back(); stack.pop_back();
@@ -318,7 +318,7 @@ std::set<Challenge> FindChallenges(const Node* root)
default: break; default: break;
} }
for (const auto& sub : ref->Subs()) { for (const auto& sub : ref->Subs()) {
stack.push_back(sub.get()); stack.push_back(&sub);
} }
} }
return chal; return chal;
@@ -347,8 +347,8 @@ void SatisfactionToWitness(miniscript::MiniscriptContext ctx, CScriptWitness& wi
struct MiniScriptTest : BasicTestingSetup { struct MiniScriptTest : BasicTestingSetup {
/** Run random satisfaction tests. */ /** Run random satisfaction tests. */
void TestSatisfy(const KeyConverter& converter, const std::string& testcase, const NodeRef& node) { void TestSatisfy(const KeyConverter& converter, const std::string& testcase, const NodeRef& node) {
auto script = node->ToScript(converter); auto script = node.ToScript(converter);
const auto challenges{FindChallenges(node.get())}; // Find all challenges in the generated miniscript. const auto challenges{FindChallenges(node)}; // Find all challenges in the generated miniscript.
std::vector<Challenge> challist(challenges.begin(), challenges.end()); std::vector<Challenge> challist(challenges.begin(), challenges.end());
for (int iter = 0; iter < 3; ++iter) { for (int iter = 0; iter < 3; ++iter) {
std::shuffle(challist.begin(), challist.end(), m_rng); std::shuffle(challist.begin(), challist.end(), m_rng);
@@ -365,12 +365,12 @@ void TestSatisfy(const KeyConverter& converter, const std::string& testcase, con
// Run malleable satisfaction algorithm. // Run malleable satisfaction algorithm.
CScriptWitness witness_mal; CScriptWitness witness_mal;
const bool mal_success = node->Satisfy(satisfier, witness_mal.stack, false) == miniscript::Availability::YES; const bool mal_success = node.Satisfy(satisfier, witness_mal.stack, false) == miniscript::Availability::YES;
SatisfactionToWitness(converter.MsContext(), witness_mal, script, builder); SatisfactionToWitness(converter.MsContext(), witness_mal, script, builder);
// Run non-malleable satisfaction algorithm. // Run non-malleable satisfaction algorithm.
CScriptWitness witness_nonmal; CScriptWitness witness_nonmal;
const bool nonmal_success = node->Satisfy(satisfier, witness_nonmal.stack, true) == miniscript::Availability::YES; const bool nonmal_success = node.Satisfy(satisfier, witness_nonmal.stack, true) == miniscript::Availability::YES;
// Compute witness size (excluding script push, control block, and witness count encoding). // Compute witness size (excluding script push, control block, and witness count encoding).
const uint64_t wit_size{GetSerializeSize(witness_nonmal.stack) - GetSizeOfCompactSize(witness_nonmal.stack.size())}; const uint64_t wit_size{GetSerializeSize(witness_nonmal.stack) - GetSizeOfCompactSize(witness_nonmal.stack.size())};
SatisfactionToWitness(converter.MsContext(), witness_nonmal, script, builder); SatisfactionToWitness(converter.MsContext(), witness_nonmal, script, builder);
@@ -379,23 +379,23 @@ void TestSatisfy(const KeyConverter& converter, const std::string& testcase, con
// Non-malleable satisfactions are bounded by the satisfaction size plus: // Non-malleable satisfactions are bounded by the satisfaction size plus:
// - For P2WSH spends, the witness script // - For P2WSH spends, the witness script
// - For Tapscript spends, both the witness script and the control block // - For Tapscript spends, both the witness script and the control block
const size_t max_stack_size{*node->GetStackSize() + 1 + miniscript::IsTapscript(converter.MsContext())}; const size_t max_stack_size{*node.GetStackSize() + 1 + miniscript::IsTapscript(converter.MsContext())};
BOOST_CHECK(witness_nonmal.stack.size() <= max_stack_size); BOOST_CHECK(witness_nonmal.stack.size() <= max_stack_size);
// If a non-malleable satisfaction exists, the malleable one must also exist, and be identical to it. // If a non-malleable satisfaction exists, the malleable one must also exist, and be identical to it.
BOOST_CHECK(mal_success); BOOST_CHECK(mal_success);
BOOST_CHECK(witness_nonmal.stack == witness_mal.stack); BOOST_CHECK(witness_nonmal.stack == witness_mal.stack);
assert(wit_size <= *node->GetWitnessSize()); assert(wit_size <= *node.GetWitnessSize());
// Test non-malleable satisfaction. // Test non-malleable satisfaction.
ScriptError serror; ScriptError serror;
bool res = VerifyScript(CScript(), script_pubkey, &witness_nonmal, STANDARD_SCRIPT_VERIFY_FLAGS, checker, &serror); bool res = VerifyScript(CScript(), script_pubkey, &witness_nonmal, STANDARD_SCRIPT_VERIFY_FLAGS, checker, &serror);
// Non-malleable satisfactions are guaranteed to be valid if ValidSatisfactions(). // Non-malleable satisfactions are guaranteed to be valid if ValidSatisfactions().
if (node->ValidSatisfactions()) BOOST_CHECK(res); if (node.ValidSatisfactions()) BOOST_CHECK(res);
// More detailed: non-malleable satisfactions must be valid, or could fail with ops count error (if CheckOpsLimit failed), // More detailed: non-malleable satisfactions must be valid, or could fail with ops count error (if CheckOpsLimit failed),
// or with a stack size error (if CheckStackSize check fails). // or with a stack size error (if CheckStackSize check fails).
BOOST_CHECK(res || BOOST_CHECK(res ||
(!node->CheckOpsLimit() && serror == ScriptError::SCRIPT_ERR_OP_COUNT) || (!node.CheckOpsLimit() && serror == ScriptError::SCRIPT_ERR_OP_COUNT) ||
(!node->CheckStackSize() && serror == ScriptError::SCRIPT_ERR_STACK_SIZE)); (!node.CheckStackSize() && serror == ScriptError::SCRIPT_ERR_STACK_SIZE));
} }
if (mal_success && (!nonmal_success || witness_mal.stack != witness_nonmal.stack)) { if (mal_success && (!nonmal_success || witness_mal.stack != witness_nonmal.stack)) {
@@ -407,7 +407,7 @@ void TestSatisfy(const KeyConverter& converter, const std::string& testcase, con
BOOST_CHECK(res || serror == ScriptError::SCRIPT_ERR_OP_COUNT || serror == ScriptError::SCRIPT_ERR_STACK_SIZE); BOOST_CHECK(res || serror == ScriptError::SCRIPT_ERR_OP_COUNT || serror == ScriptError::SCRIPT_ERR_STACK_SIZE);
} }
if (node->IsSane()) { if (node.IsSane()) {
// For sane nodes, the two algorithms behave identically. // For sane nodes, the two algorithms behave identically.
BOOST_CHECK_EQUAL(mal_success, nonmal_success); BOOST_CHECK_EQUAL(mal_success, nonmal_success);
} }
@@ -417,7 +417,7 @@ void TestSatisfy(const KeyConverter& converter, const std::string& testcase, con
// For nonmalleable solutions this is only true if the added condition is PK; // For nonmalleable solutions this is only true if the added condition is PK;
// for other conditions, adding one may make an valid satisfaction become malleable. If the script // for other conditions, adding one may make an valid satisfaction become malleable. If the script
// is sane, this cannot happen however. // is sane, this cannot happen however.
if (node->IsSane() || add < 0 || challist[add].first == ChallengeType::PK) { if (node.IsSane() || add < 0 || challist[add].first == ChallengeType::PK) {
BOOST_CHECK(nonmal_success >= prev_nonmal_success); BOOST_CHECK(nonmal_success >= prev_nonmal_success);
} }
// Remember results for the next added challenge. // Remember results for the next added challenge.
@@ -425,11 +425,11 @@ void TestSatisfy(const KeyConverter& converter, const std::string& testcase, con
prev_nonmal_success = nonmal_success; prev_nonmal_success = nonmal_success;
} }
bool satisfiable = node->IsSatisfiable([](const Node&) { return true; }); bool satisfiable = node.IsSatisfiable([](const Node&) { return true; });
// If the miniscript was satisfiable at all, a satisfaction must be found after all conditions are added. // If the miniscript was satisfiable at all, a satisfaction must be found after all conditions are added.
BOOST_CHECK_EQUAL(prev_mal_success, satisfiable); BOOST_CHECK_EQUAL(prev_mal_success, satisfiable);
// If the miniscript is sane and satisfiable, a nonmalleable satisfaction must eventually be found. // If the miniscript is sane and satisfiable, a nonmalleable satisfaction must eventually be found.
if (node->IsSane()) BOOST_CHECK_EQUAL(prev_nonmal_success, satisfiable); if (node.IsSane()) BOOST_CHECK_EQUAL(prev_nonmal_success, satisfiable);
} }
} }
@@ -472,7 +472,7 @@ void Test(const std::string& ms, const std::string& hexscript, int mode, const K
if (stacklimit != -1) BOOST_CHECK_MESSAGE((int)*node->GetStackSize() == stacklimit, "Stack limit mismatch: " << ms << " (" << *node->GetStackSize() << " vs " << stacklimit << ")"); if (stacklimit != -1) BOOST_CHECK_MESSAGE((int)*node->GetStackSize() == stacklimit, "Stack limit mismatch: " << ms << " (" << *node->GetStackSize() << " vs " << stacklimit << ")");
if (max_wit_size) BOOST_CHECK_MESSAGE(*node->GetWitnessSize() == *max_wit_size, "Witness size limit mismatch: " << ms << " (" << *node->GetWitnessSize() << " vs " << *max_wit_size << ")"); if (max_wit_size) BOOST_CHECK_MESSAGE(*node->GetWitnessSize() == *max_wit_size, "Witness size limit mismatch: " << ms << " (" << *node->GetWitnessSize() << " vs " << *max_wit_size << ")");
if (stack_exec) BOOST_CHECK_MESSAGE(*node->GetExecStackSize() == *stack_exec, "Stack execution limit mismatch: " << ms << " (" << *node->GetExecStackSize() << " vs " << *stack_exec << ")"); if (stack_exec) BOOST_CHECK_MESSAGE(*node->GetExecStackSize() == *stack_exec, "Stack execution limit mismatch: " << ms << " (" << *node->GetExecStackSize() << " vs " << *stack_exec << ")");
TestSatisfy(converter, ms, node); TestSatisfy(converter, ms, *node);
} }
} }
@@ -600,11 +600,11 @@ BOOST_AUTO_TEST_CASE(fixed_tests)
constexpr KeyConverter tap_converter{miniscript::MiniscriptContext::TAPSCRIPT}; constexpr KeyConverter tap_converter{miniscript::MiniscriptContext::TAPSCRIPT};
constexpr KeyConverter wsh_converter{miniscript::MiniscriptContext::P2WSH}; constexpr KeyConverter wsh_converter{miniscript::MiniscriptContext::P2WSH};
const auto no_pubkey{"ac519c"_hex_u8}; const auto no_pubkey{"ac519c"_hex_u8};
BOOST_CHECK(miniscript::FromScript({no_pubkey.begin(), no_pubkey.end()}, tap_converter) == nullptr); BOOST_CHECK(miniscript::FromScript({no_pubkey.begin(), no_pubkey.end()}, tap_converter) == std::nullopt);
const auto incomplete_multi_a{"ba20c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5ba519c"_hex_u8}; const auto incomplete_multi_a{"ba20c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5ba519c"_hex_u8};
BOOST_CHECK(miniscript::FromScript({incomplete_multi_a.begin(), incomplete_multi_a.end()}, tap_converter) == nullptr); BOOST_CHECK(miniscript::FromScript({incomplete_multi_a.begin(), incomplete_multi_a.end()}, tap_converter) == std::nullopt);
const auto incomplete_multi_a_2{"ac2079be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798ac20c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5ba519c"_hex_u8}; const auto incomplete_multi_a_2{"ac2079be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798ac20c6047f9441ed7d6d3045406e95c07cd85c778e4b8cef3ca7abac09b95c709ee5ba519c"_hex_u8};
BOOST_CHECK(miniscript::FromScript({incomplete_multi_a_2.begin(), incomplete_multi_a_2.end()}, tap_converter) == nullptr); BOOST_CHECK(miniscript::FromScript({incomplete_multi_a_2.begin(), incomplete_multi_a_2.end()}, tap_converter) == std::nullopt);
// Can use multi_a under Tapscript but not P2WSH. // Can use multi_a under Tapscript but not P2WSH.
Test("and_v(v:multi_a(2,03d01115d548e7561b15c38f004d734633687cf4419620095bc5b0f47070afe85a,025601570cb47f238d2b0286db4a990fa0f3ba28d1a319f5e7cf55c2a2444da7cc),after(1231488000))", "?", "20d01115d548e7561b15c38f004d734633687cf4419620095bc5b0f47070afe85aac205601570cb47f238d2b0286db4a990fa0f3ba28d1a319f5e7cf55c2a2444da7ccba529d0400046749b1", TESTMODE_VALID | TESTMODE_NONMAL | TESTMODE_NEEDSIG | TESTMODE_P2WSH_INVALID, 4, 2, {}, {}, 3); Test("and_v(v:multi_a(2,03d01115d548e7561b15c38f004d734633687cf4419620095bc5b0f47070afe85a,025601570cb47f238d2b0286db4a990fa0f3ba28d1a319f5e7cf55c2a2444da7cc),after(1231488000))", "?", "20d01115d548e7561b15c38f004d734633687cf4419620095bc5b0f47070afe85aac205601570cb47f238d2b0286db4a990fa0f3ba28d1a319f5e7cf55c2a2444da7ccba529d0400046749b1", TESTMODE_VALID | TESTMODE_NONMAL | TESTMODE_NEEDSIG | TESTMODE_P2WSH_INVALID, 4, 2, {}, {}, 3);
// Can use more than 20 keys in a multi_a. // Can use more than 20 keys in a multi_a.
@@ -650,13 +650,13 @@ BOOST_AUTO_TEST_CASE(fixed_tests)
// A Script with a non minimal push is invalid // A Script with a non minimal push is invalid
constexpr auto nonminpush{"0000210232780000feff00ffffffffffff21ff005f00ae21ae00000000060602060406564c2102320000060900fe00005f00ae21ae00100000060606060606000000000000000000000000000000000000000000000000000000000000000000"_hex_u8}; constexpr auto nonminpush{"0000210232780000feff00ffffffffffff21ff005f00ae21ae00000000060602060406564c2102320000060900fe00005f00ae21ae00100000060606060606000000000000000000000000000000000000000000000000000000000000000000"_hex_u8};
const CScript nonminpush_script(nonminpush.begin(), nonminpush.end()); const CScript nonminpush_script(nonminpush.begin(), nonminpush.end());
BOOST_CHECK(miniscript::FromScript(nonminpush_script, wsh_converter) == nullptr); BOOST_CHECK(miniscript::FromScript(nonminpush_script, wsh_converter) == std::nullopt);
BOOST_CHECK(miniscript::FromScript(nonminpush_script, tap_converter) == nullptr); BOOST_CHECK(miniscript::FromScript(nonminpush_script, tap_converter) == std::nullopt);
// A non-minimal VERIFY (<key> CHECKSIG VERIFY 1) // A non-minimal VERIFY (<key> CHECKSIG VERIFY 1)
constexpr auto nonminverify{"2103a0434d9e47f3c86235477c7b1ae6ae5d3442d49b1943c2b752a68e2a47e247c7ac6951"_hex_u8}; constexpr auto nonminverify{"2103a0434d9e47f3c86235477c7b1ae6ae5d3442d49b1943c2b752a68e2a47e247c7ac6951"_hex_u8};
const CScript nonminverify_script(nonminverify.begin(), nonminverify.end()); const CScript nonminverify_script(nonminverify.begin(), nonminverify.end());
BOOST_CHECK(miniscript::FromScript(nonminverify_script, wsh_converter) == nullptr); BOOST_CHECK(miniscript::FromScript(nonminverify_script, wsh_converter) == std::nullopt);
BOOST_CHECK(miniscript::FromScript(nonminverify_script, tap_converter) == nullptr); BOOST_CHECK(miniscript::FromScript(nonminverify_script, tap_converter) == std::nullopt);
// A threshold as large as the number of subs is valid. // A threshold as large as the number of subs is valid.
Test("thresh(2,c:pk_k(03d30199d74fb5a22d47b6e054e2f378cedacffcb89904a61d75d0dbd407143e65),altv:after(100))", "2103d30199d74fb5a22d47b6e054e2f378cedacffcb89904a61d75d0dbd407143e65ac6b6300670164b16951686c935287", "20d30199d74fb5a22d47b6e054e2f378cedacffcb89904a61d75d0dbd407143e65ac6b6300670164b16951686c935287", TESTMODE_VALID | TESTMODE_NEEDSIG | TESTMODE_NONMAL); Test("thresh(2,c:pk_k(03d30199d74fb5a22d47b6e054e2f378cedacffcb89904a61d75d0dbd407143e65),altv:after(100))", "2103d30199d74fb5a22d47b6e054e2f378cedacffcb89904a61d75d0dbd407143e65ac6b6300670164b16951686c935287", "20d30199d74fb5a22d47b6e054e2f378cedacffcb89904a61d75d0dbd407143e65ac6b6300670164b16951686c935287", TESTMODE_VALID | TESTMODE_NEEDSIG | TESTMODE_NONMAL);
// A threshold of 1 is valid. // A threshold of 1 is valid.