Merge pull request #1808 from evoskuil/master

Generalize payment_address script derivation.

Author: evoskuil

include/bitcoin/system/wallet/addresses/payment_address.hpp

@@ -41,11 +41,11 @@ class BC_API payment_address
 public:
     DEFAULT_COPY_MOVE_DESTRUCT(payment_address);
 
-    static const uint8_t mainnet_p2kh;
-    static const uint8_t mainnet_p2sh;
+    static constexpr uint8_t mainnet_p2kh = 0x00;
+    static constexpr uint8_t mainnet_p2sh = 0x05;
 
-    static const uint8_t testnet_p2kh;
-    static const uint8_t testnet_p2sh;
+    static constexpr uint8_t testnet_p2kh = 0x6f;
+    static constexpr uint8_t testnet_p2sh = 0xc4;
 
     typedef std_vector<payment_address> list;
     typedef std::shared_ptr<payment_address> ptr;
@@ -90,7 +90,12 @@ class BC_API payment_address
     /// Properties.
     uint8_t prefix() const NOEXCEPT;
     short_hash hash() const NOEXCEPT;
-    chain::script output_script() const NOEXCEPT;
+
+    /// Script is extracted to p2pk or p2sh by matching its prefix to the
+    /// args provided here. So for testnet and other alts these are required.
+    chain::script output_script(
+        uint8_t p2kh_prefix=mainnet_p2kh,
+        uint8_t p2sh_prefix=mainnet_p2sh) const NOEXCEPT;
 
     /// Methods.
     const payment& to_payment() const NOEXCEPT;

include/bitcoin/system/wallet/neutrino.hpp

@@ -53,11 +53,17 @@ BC_API bool match_filter(const block_filter& filter,
 BC_API bool match_filter(const block_filter& filter,
     const chain::scripts& scripts) NOEXCEPT;
 
+/// Prefix values indicate how to convert the address if not btc mainnet.
 BC_API bool match_filter(const block_filter& filter,
-    const wallet::payment_address& address) NOEXCEPT;
+    const wallet::payment_address& address,
+    uint8_t p2kh_prefix=wallet::payment_address::mainnet_p2kh,
+    uint8_t p2sh_prefix=wallet::payment_address::mainnet_p2sh) NOEXCEPT;
 
+/// Prefix values indicate how to convert the address if not btc mainnet.
 BC_API bool match_filter(const block_filter& filter,
-    const wallet::payment_address::list& addresses) NOEXCEPT;
+    const wallet::payment_address::list& addresses,
+    uint8_t p2kh_prefix=wallet::payment_address::mainnet_p2kh,
+    uint8_t p2sh_prefix=wallet::payment_address::mainnet_p2sh) NOEXCEPT;
 
 } // namespace neutrino
 } // namespace system

src/wallet/addresses/payment_address.cpp

@@ -31,12 +31,6 @@ namespace libbitcoin {
 namespace system {
 namespace wallet {
 
-const uint8_t payment_address::mainnet_p2kh = 0x00;
-const uint8_t payment_address::mainnet_p2sh = 0x05;
-
-const uint8_t payment_address::testnet_p2kh = 0x6f;
-const uint8_t payment_address::testnet_p2sh = 0xc4;
-
 payment_address::payment_address() NOEXCEPT
   : payment_()
 {
@@ -159,19 +153,17 @@ short_hash payment_address::hash() const NOEXCEPT
     return payment_.payload();
 }
 
-chain::script payment_address::output_script() const NOEXCEPT
+chain::script payment_address::output_script(uint8_t p2kh_prefix,
+    uint8_t p2sh_prefix) const NOEXCEPT
 {
-    switch (prefix())
-    {
-        case mainnet_p2kh:
-        case testnet_p2kh:
-            return chain::script::to_pay_key_hash_pattern(hash());
+    const auto byte = prefix();
 
-        case mainnet_p2sh:
-        case testnet_p2sh:
-            return chain::script::to_pay_script_hash_pattern(hash());
-    }
+    if (byte == p2kh_prefix)
+        return chain::script::to_pay_key_hash_pattern(hash());
 
+    if (byte == p2sh_prefix)
+        return chain::script::to_pay_script_hash_pattern(hash());
+    
     return {};
 }
 

src/wallet/neutrino.cpp

@@ -147,23 +147,24 @@ bool match_filter(const block_filter& filter,
 }
 
 bool match_filter(const block_filter& filter,
-    const wallet::payment_address& address) NOEXCEPT
+    const wallet::payment_address& address, uint8_t p2kh_prefixh,
+    uint8_t p2sh_prefix) NOEXCEPT
 {
-    return match_filter(filter, address.output_script());
+    return match_filter(filter, address.output_script(p2kh_prefixh, p2sh_prefix));
 }
 
 bool match_filter(const block_filter& filter,
-    const wallet::payment_address::list& addresses) NOEXCEPT
+    const wallet::payment_address::list& addresses, uint8_t p2kh_prefixh,
+    uint8_t p2sh_prefix) NOEXCEPT
 {
     if (addresses.empty())
         return false;
 
     chain::scripts stack(addresses.size());
-
     std::transform(addresses.begin(), addresses.end(), stack.begin(),
-        [](const wallet::payment_address& address) NOEXCEPT
+        [=](const wallet::payment_address& address) NOEXCEPT
         {
-            return address.output_script();
+            return address.output_script(p2kh_prefixh, p2sh_prefix);
         });
 
     return match_filter(filter, stack);

test/wallet/neutrino.cpp

@@ -3529,7 +3529,7 @@ BOOST_AUTO_TEST_CASE(neutrino__match_filter_1__input_prevout__true)
     const wallet::payment_address address
     {
         base16_array("001fa7459a6cfc64bdc178ba7e7a21603bb2568f"),
-        wallet::payment_address::testnet_p2kh
+        wallet::payment_address::mainnet_p2kh
     };
 
     BOOST_REQUIRE(neutrino::match_filter(filter, address));
@@ -3546,7 +3546,7 @@ BOOST_AUTO_TEST_CASE(neutrino__match_filter_1__unrelated_address__false)
     const wallet::payment_address address
     {
         base16_array("001fa005900cf004b00100ba700021000b00500f"),
-        wallet::payment_address::testnet_p2kh
+        wallet::payment_address::mainnet_p2kh
     };
 
     BOOST_REQUIRE(!neutrino::match_filter(filter, address));
@@ -3560,19 +3560,19 @@ BOOST_AUTO_TEST_CASE(neutrino__match_filter_2__input_prevout__true)
         base16_chunk("0db414c859a07e8205876354a210a75042d0463404913d61a8e068e58a3ae2aa080026")
     };
 
+    constexpr auto testnet_p2kh = wallet::payment_address::testnet_p2kh;
+    constexpr auto testnet_p2sh = wallet::payment_address::testnet_p2kh;
     const wallet::payment_address::list addresses
     {
         {
-            base16_array("001fa7459a6cfc64bdc100ba700a21003b005000"),
-            wallet::payment_address::testnet_p2kh
+            base16_array("001fa7459a6cfc64bdc100ba700a21003b005000"), testnet_p2kh
         },
         {
-            base16_array("001fa7459a6cfc64bdc178ba7e7a21603bb2568f"),
-            wallet::payment_address::testnet_p2kh
+            base16_array("001fa7459a6cfc64bdc178ba7e7a21603bb2568f"), testnet_p2kh
         }
     };
 
-    BOOST_REQUIRE(neutrino::match_filter(filter, addresses));
+    BOOST_REQUIRE(neutrino::match_filter(filter, addresses, testnet_p2kh, testnet_p2sh));
 }
 
 BOOST_AUTO_TEST_CASE(neutrino__match_filter_2__unrelated_address__false)
@@ -3587,7 +3587,7 @@ BOOST_AUTO_TEST_CASE(neutrino__match_filter_2__unrelated_address__false)
     {
         {
             base16_array("001fa7459a6cfc64bdc100ba700a21003b005000"),
-            wallet::payment_address::testnet_p2kh
+            wallet::payment_address::mainnet_p2kh
         }
     };