Merge pull request #1695 from evoskuil/master

evoskuil · web-flow · commit 556716c81ba3 · 2025-06-01T18:56:51.000-04:00
Don't validate clean stack for taproot prevalid, refactor.
diff --git a/Makefile.am b/Makefile.am
@@ -237,6 +237,7 @@ test_libbitcoin_system_test_SOURCES = \
     test/chain/script.hpp \
     test/chain/stripper.cpp \
     test/chain/taproot.cpp \
+    test/chain/tapscript.cpp \
     test/chain/transaction.cpp \
     test/chain/witness.cpp \
     test/chain/enums/opcode.cpp \
@@ -476,6 +477,7 @@ include_bitcoin_system_chain_HEADERS = \
     include/bitcoin/system/chain/script.hpp \
     include/bitcoin/system/chain/stripper.hpp \
     include/bitcoin/system/chain/taproot.hpp \
+    include/bitcoin/system/chain/tapscript.hpp \
     include/bitcoin/system/chain/transaction.hpp \
     include/bitcoin/system/chain/witness.hpp
 
@@ -607,6 +609,7 @@ include_bitcoin_system_impl_chain_HEADERS = \
     include/bitcoin/system/impl/chain/compact.ipp \
     include/bitcoin/system/impl/chain/operation_patterns.ipp \
     include/bitcoin/system/impl/chain/script_patterns.ipp \
+    include/bitcoin/system/impl/chain/tapscript.ipp \
     include/bitcoin/system/impl/chain/transaction_patterns.ipp \
     include/bitcoin/system/impl/chain/witness_patterns.ipp
 
diff --git a/builds/cmake/CMakeLists.txt b/builds/cmake/CMakeLists.txt
@@ -712,6 +712,7 @@ if (with-tests)
         "../../test/chain/script.hpp"
         "../../test/chain/stripper.cpp"
         "../../test/chain/taproot.cpp"
+        "../../test/chain/tapscript.cpp"
         "../../test/chain/transaction.cpp"
         "../../test/chain/witness.cpp"
         "../../test/chain/enums/opcode.cpp"
diff --git a/builds/msvc/vs2022/libbitcoin-system-test/libbitcoin-system-test.vcxproj b/builds/msvc/vs2022/libbitcoin-system-test/libbitcoin-system-test.vcxproj
@@ -141,6 +141,7 @@
     <ClCompile Include="..\..\..\..\test\chain\script.cpp" />
     <ClCompile Include="..\..\..\..\test\chain\stripper.cpp" />
     <ClCompile Include="..\..\..\..\test\chain\taproot.cpp" />
+    <ClCompile Include="..\..\..\..\test\chain\tapscript.cpp" />
     <ClCompile Include="..\..\..\..\test\chain\transaction.cpp" />
     <ClCompile Include="..\..\..\..\test\chain\witness.cpp" />
     <ClCompile Include="..\..\..\..\test\config\base16.cpp" />
diff --git a/builds/msvc/vs2022/libbitcoin-system-test/libbitcoin-system-test.vcxproj.filters b/builds/msvc/vs2022/libbitcoin-system-test/libbitcoin-system-test.vcxproj.filters
@@ -165,6 +165,9 @@
     <ClCompile Include="..\..\..\..\test\chain\taproot.cpp">
       <Filter>src\chain</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\..\test\chain\tapscript.cpp">
+      <Filter>src\chain</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\..\test\chain\transaction.cpp">
       <Filter>src\chain</Filter>
     </ClCompile>
diff --git a/builds/msvc/vs2022/libbitcoin-system/libbitcoin-system.vcxproj b/builds/msvc/vs2022/libbitcoin-system/libbitcoin-system.vcxproj
@@ -325,6 +325,7 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\script.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\stripper.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\taproot.hpp" />
+    <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\tapscript.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\transaction.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\witness.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\system\config\base16.hpp" />
@@ -584,6 +585,7 @@
     <None Include="..\..\..\..\include\bitcoin\system\impl\chain\compact.ipp" />
     <None Include="..\..\..\..\include\bitcoin\system\impl\chain\operation_patterns.ipp" />
     <None Include="..\..\..\..\include\bitcoin\system\impl\chain\script_patterns.ipp" />
+    <None Include="..\..\..\..\include\bitcoin\system\impl\chain\tapscript.ipp" />
     <None Include="..\..\..\..\include\bitcoin\system\impl\chain\transaction_patterns.ipp" />
     <None Include="..\..\..\..\include\bitcoin\system\impl\chain\witness_patterns.ipp" />
     <None Include="..\..\..\..\include\bitcoin\system\impl\data\array_cast.ipp" />
diff --git a/builds/msvc/vs2022/libbitcoin-system/libbitcoin-system.vcxproj.filters b/builds/msvc/vs2022/libbitcoin-system/libbitcoin-system.vcxproj.filters
@@ -722,6 +722,9 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\taproot.hpp">
       <Filter>include\bitcoin\system\chain</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\tapscript.hpp">
+      <Filter>include\bitcoin\system\chain</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\..\include\bitcoin\system\chain\transaction.hpp">
       <Filter>include\bitcoin\system\chain</Filter>
     </ClInclude>
@@ -1495,6 +1498,9 @@
     <None Include="..\..\..\..\include\bitcoin\system\impl\chain\script_patterns.ipp">
       <Filter>include\bitcoin\system\impl\chain</Filter>
     </None>
+    <None Include="..\..\..\..\include\bitcoin\system\impl\chain\tapscript.ipp">
+      <Filter>include\bitcoin\system\impl\chain</Filter>
+    </None>
     <None Include="..\..\..\..\include\bitcoin\system\impl\chain\transaction_patterns.ipp">
       <Filter>include\bitcoin\system\impl\chain</Filter>
     </None>
diff --git a/include/bitcoin/system.hpp b/include/bitcoin/system.hpp
@@ -48,6 +48,7 @@
 #include <bitcoin/system/chain/script.hpp>
 #include <bitcoin/system/chain/stripper.hpp>
 #include <bitcoin/system/chain/taproot.hpp>
+#include <bitcoin/system/chain/tapscript.hpp>
 #include <bitcoin/system/chain/transaction.hpp>
 #include <bitcoin/system/chain/witness.hpp>
 #include <bitcoin/system/chain/enums/coverage.hpp>
diff --git a/include/bitcoin/system/chain/annex.hpp b/include/bitcoin/system/chain/annex.hpp
@@ -42,6 +42,9 @@ class BC_API annex
     inline const hash_digest hash() const NOEXCEPT;
     inline operator bool() const NOEXCEPT;
 
+    /// The stack adheres to the annex pattern [bip341].
+    static constexpr bool is_annex_pattern(const chunk_cptrs& stack) NOEXCEPT;
+
 protected:
     static inline chunk_cptr from_stack(const chunk_cptrs& stack) NOEXCEPT;
 
@@ -55,4 +58,6 @@ class BC_API annex
 } // namespace system
 } // namespace libbitcoin
 
+#include <bitcoin/system/impl/chain/annex.ipp>
+
 #endif
diff --git a/include/bitcoin/system/chain/block.hpp b/include/bitcoin/system/chain/block.hpp
@@ -32,7 +32,6 @@
 
 namespace libbitcoin {
 namespace system {
-
 namespace chain {
 
 class BC_API block
diff --git a/include/bitcoin/system/chain/chain.hpp b/include/bitcoin/system/chain/chain.hpp
@@ -46,6 +46,7 @@
 #include <bitcoin/system/chain/script.hpp>
 #include <bitcoin/system/chain/stripper.hpp>
 #include <bitcoin/system/chain/taproot.hpp>
+#include <bitcoin/system/chain/tapscript.hpp>
 #include <bitcoin/system/chain/transaction.hpp>
 #include <bitcoin/system/chain/witness.hpp>
 
diff --git a/include/bitcoin/system/chain/header.hpp b/include/bitcoin/system/chain/header.hpp
@@ -29,7 +29,6 @@
 
 namespace libbitcoin {
 namespace system {
-
 namespace chain {
 
 class BC_API header
diff --git a/include/bitcoin/system/chain/taproot.hpp b/include/bitcoin/system/chain/taproot.hpp
@@ -20,6 +20,7 @@
 #define LIBBITCOIN_SYSTEM_CHAIN_TAPROOT_HPP
 
 #include <bitcoin/system/chain/script.hpp>
+#include <bitcoin/system/chain/tapscript.hpp>
 #include <bitcoin/system/crypto/crypto.hpp>
 #include <bitcoin/system/data/data.hpp>
 #include <bitcoin/system/define.hpp>
@@ -32,40 +33,25 @@ namespace chain {
 class BC_API taproot
 {
 public:
-    struct tap
-    {
-        INLINE operator bool() const NOEXCEPT
-        {
-            return version == tapscript_version;
-        }
-
-        uint8_t version;
-        bool parity;
-    };
-
-    static tap parse(const data_chunk& control) NOEXCEPT;
-    static bool is_control_block(const data_chunk& control) NOEXCEPT;
-    static bool drop_annex(chunk_cptrs& stack) NOEXCEPT;
     static hash_digest leaf_hash(uint8_t version,
         const script& script) NOEXCEPT;
-
-    static bool verify_commitment(const data_chunk& control,
-        const data_chunk& program, const hash_digest& hash,
-        bool parity) NOEXCEPT;
+    static bool drop_annex(chunk_cptrs& stack) NOEXCEPT;
+    static bool verify_commit(const tapscript& control,
+        const ec_xonly& out_key, const hash_digest& leaf) NOEXCEPT;
 
 protected:
-    static hash_digest merkle_root(const data_chunk& control,
-        const hash_digest& tapleaf_hash) NOEXCEPT;
+    static hash_digest merkle_root(const tapscript::keys_t& keys,
+        size_t count, const hash_digest& tapleaf_hash) NOEXCEPT;
     static hash_digest sorted_branch_hash(const hash_digest& left,
         const hash_digest& right) NOEXCEPT;
     static hash_digest branch_hash(const hash_digest& first,
         const hash_digest& second) NOEXCEPT;
     static hash_digest tweak_hash(const ec_xonly& key,
         const hash_digest& merkle) NOEXCEPT;
 };
+
 } // namespace chain
 } // namespace system
 } // namespace libbitcoin
 
-
 #endif
diff --git a/include/bitcoin/system/chain/tapscript.hpp b/include/bitcoin/system/chain/tapscript.hpp
@@ -0,0 +1,61 @@
+/**
+ * Copyright (c) 2011-2025 libbitcoin developers (see AUTHORS)
+ *
+ * This file is part of libbitcoin.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef LIBBITCOIN_SYSTEM_CHAIN_TAPSCRIPT_HPP
+#define LIBBITCOIN_SYSTEM_CHAIN_TAPSCRIPT_HPP
+
+#include <bitcoin/system/chain/enums/magic_numbers.hpp>
+#include <bitcoin/system/crypto/crypto.hpp>
+#include <bitcoin/system/data/data.hpp>
+#include <bitcoin/system/define.hpp>
+
+namespace libbitcoin {
+namespace system {
+namespace chain {
+
+class BC_API tapscript
+{
+public:
+    using keys_t = std::array<ec_xonly, taproot_max_keys>;
+
+    DEFAULT_COPY_MOVE_DESTRUCT(tapscript);
+    
+    inline static bool is_control(const data_chunk& control) NOEXCEPT;
+
+    inline tapscript(chunk_cptr&& control) NOEXCEPT;
+    inline tapscript(const chunk_cptr& control) NOEXCEPT;
+
+    inline bool is_valid() const NOEXCEPT;
+    inline bool is_tapscript() const NOEXCEPT;
+    inline bool parity() const NOEXCEPT;
+    inline size_t count() const NOEXCEPT;
+    inline uint8_t version() const NOEXCEPT;
+    inline const ec_xonly& key() const NOEXCEPT;
+    inline const keys_t& keys() const NOEXCEPT;
+
+private:
+    chunk_cptr control_;
+};
+
+} // namespace chain
+} // namespace system
+} // namespace libbitcoin
+
+#include <bitcoin/system/impl/chain/tapscript.ipp>
+
+#endif
diff --git a/include/bitcoin/system/chain/witness.hpp b/include/bitcoin/system/chain/witness.hpp
@@ -21,7 +21,6 @@
 
 #include <memory>
 #include <bitcoin/system/chain/annex.hpp>
-#include <bitcoin/system/chain/enums/magic_numbers.hpp>
 #include <bitcoin/system/chain/operation.hpp>
 #include <bitcoin/system/chain/script.hpp>
 #include <bitcoin/system/data/data.hpp>
@@ -100,9 +99,6 @@ class BC_API witness
     /// Patterns.
     /// -----------------------------------------------------------------------
 
-    /// The stack adheres to the annex pattern [bip341].
-    static constexpr bool is_annex_pattern(const chunk_cptrs& stack) NOEXCEPT;
-
     /// Verify the push size of each stack element [bip141].
     static constexpr bool is_push_size(const chunk_cptrs& stack) NOEXCEPT;
 
diff --git a/include/bitcoin/system/impl/chain/annex.ipp b/include/bitcoin/system/impl/chain/annex.ipp
@@ -16,16 +16,18 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#include <bitcoin/system/chain/annex.hpp>
+#ifndef LIBBITCOIN_SYSTEM_CHAIN_ANNEX_IPP
+#define LIBBITCOIN_SYSTEM_CHAIN_ANNEX_IPP
 
-#include <bitcoin/system/chain/witness.hpp>
+#include <bitcoin/system/chain/enums/magic_numbers.hpp>
 #include <bitcoin/system/data/data.hpp>
 #include <bitcoin/system/define.hpp>
 #include <bitcoin/system/hash/hash.hpp>
 
 namespace libbitcoin {
 namespace system {
 namespace chain {
+
 inline annex::annex() NOEXCEPT
   : data_(nullptr)
 {
@@ -45,7 +47,7 @@ inline annex::annex(const chunk_cptrs& stack) NOEXCEPT
 // static/protected
 inline chunk_cptr annex::from_stack(const chunk_cptrs& stack) NOEXCEPT
 {
-    return witness::is_annex_pattern(stack) ? stack.back() : nullptr;
+    return is_annex_pattern(stack) ? stack.back() : nullptr;
 }
 
 // static/private
@@ -75,6 +77,21 @@ inline const hash_digest annex::hash() const NOEXCEPT
     return sha256_hash(data());
 }
 
+// static
+constexpr bool annex::is_annex_pattern(const chunk_cptrs& stack) NOEXCEPT
+{
+    // If at least two elements, discard annex if present.
+    if (stack.size() <= one)
+        return false;
+
+    // If first byte of stack top is 0x50 it is the annex [bip341].
+    const auto& top = stack.back();
+    return !top->empty() && (top->front() == taproot_annex_prefix);
+}
+
 } // namespace chain
 } // namespace system
 } // namespace libbitcoin
+
+#endif
+
diff --git a/include/bitcoin/system/impl/chain/compact.ipp b/include/bitcoin/system/impl/chain/compact.ipp
@@ -16,8 +16,8 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-#ifndef LIBBITCOIN_SYSTEM_CHAIN_COMPACT_NUMBER_IPP
-#define LIBBITCOIN_SYSTEM_CHAIN_COMPACT_NUMBER_IPP
+#ifndef LIBBITCOIN_SYSTEM_CHAIN_COMPACT_IPP
+#define LIBBITCOIN_SYSTEM_CHAIN_COMPACT_IPP
 
 #include <bitcoin/system/define.hpp>
 #include <bitcoin/system/math/math.hpp>
diff --git a/include/bitcoin/system/impl/chain/tapscript.ipp b/include/bitcoin/system/impl/chain/tapscript.ipp
diff --git a/include/bitcoin/system/impl/chain/witness_patterns.ipp b/include/bitcoin/system/impl/chain/witness_patterns.ipp
diff --git a/include/bitcoin/system/impl/machine/interpreter_connect.ipp b/include/bitcoin/system/impl/machine/interpreter_connect.ipp
diff --git a/include/bitcoin/system/impl/machine/interpreter_run.ipp b/include/bitcoin/system/impl/machine/interpreter_run.ipp
diff --git a/src/chain/taproot.cpp b/src/chain/taproot.cpp
diff --git a/src/chain/witness.cpp b/src/chain/witness.cpp
diff --git a/src/chain/witness_extract.cpp b/src/chain/witness_extract.cpp
diff --git a/test/chain/tapscript.cpp b/test/chain/tapscript.cpp
