remove short constants, should follow upstream

Author: Thomas Kerin

Diff for: README.md

@@ -14,39 +14,46 @@ get a trusted copy.
 
 ## Requirements
 
-Version v2.0.0 can run on PHP versions 5.3 - 5.6, and PHP 7.0 - 7.1.
+Version v3.0.0 can be run on PHP versions > 7.0.
+ - In theory can be built with versions before Bitcoin Core v0.13.0.
 
-It must be built against Bitcoin Core v0.13.0 upwards. 
+Version v2.0.0 can run on PHP versions 5.3 - 5.6, and PHP 7.0 - 7.2, 7.3-RC
+ - It must be built against Bitcoin Core v0.13.0 upwards.
+
+See how to install a certain branch in the installation section.
 
 ## Supported features
 
-    BITCOINCONSENSUS_VERIFY_NONE 
-    BITCOINCONSENSUS_VERIFY_P2SH
-    BITCOINCONSENSUS_VERIFY_DERSIG
-    BITCOINCONSENSUS_VERIFY_CHECKLOCKTIMEVERIFY
-    BITCOINCONSENSUS_VERIFY_CHECKSEQUENCEVERIFY
-    BITCOINCONSENSUS_VERIFY_WITNESS
+
+Script verification flags:
+
+    BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NONE
+    BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_P2SH
+    BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_DERSIG
 
     Optional (depends on bitcoinconsensus.h build):
-    BITCOINCONSENSUS_VERIFY_NULLDUMMY
+    BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY
+    BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY
+    BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_WITNESS
+    BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY
 
-## Compatibility
+Error codes for bitcoinconsensus_verify_script{,with_amount}
 
-v2.0.0 brings the library in line with the expectations upstream. It only
-exposes a minimal set of network activated script validation flags in 
-[bitcoinconsensus.h](https://github.com/bitcoin/bitcoin/blob/master/src/script/bitcoinconsensus.h).
+    BITCOINCONSENSUS_ERR_OK                   no error
+    BITCOINCONSENSUS_ERR_TX_INDEX             input index not set in transaction
+    BITCOINCONSENSUS_ERR_TX_SIZE_MISMATCH     (not possible)
+    BITCOINCONSENSUS_ERR_TX_DESERIALIZE       invalid transaction serialization
+    BITCOINCONSENSUS_ERR_AMOUNT_REQUIRED      used segwit flag with old function
+    BITCOINCONSENSUS_ERR_INVALID_FLAGS        invalid script verification flags used
 
-The BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_* constants have been removed in 
-favor of BITCOINCONSENSUS_VERIFY_*. 
+## Compatibility
 
-At build time, it will check if newer (opt-in) flags are exported (such as 
-NULLDUMMY) by the bitcoinconsensus.h. If so, the flags for these will be compiled
-in. 
+Script verification constants following the naming `BITCOINCONSENSUS_VERIFY_x`
+were removed in favor of those following upstreams naming.
 
 ## To Install:
 ```
-    git clone [email protected]:bitwasp/bitcoinconsensus-php
-    cd bitcoinconsensus-php
+    git clone -b v3.0.0 [email protected]:bit-wasp/bitcoinconsensus-php
     cd bitcoinconsensus-php/bitcoinconsensus
     phpize && ./configure --with-bitcoinconsensus && make && sudo make install
 ```

Diff for: bitcoinconsensus/bitcoinconsensus.c

@@ -114,48 +114,40 @@ PHP_MINIT_FUNCTION(bitcoinconsensus)
     REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_ERR_INVALID_FLAGS", bitcoinconsensus_ERR_INVALID_FLAGS, CONST_CS | CONST_PERSISTENT);
 #endif
 
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NONE", 0, CONST_CS | CONST_PERSISTENT);
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_P2SH", (1U << 0), CONST_CS | CONST_PERSISTENT);
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_DERSIG", (1U << 2), CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NONE", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_NONE, CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_P2SH", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_P2SH, CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_DERSIG", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_DERSIG, CONST_CS | CONST_PERSISTENT);
 
     unsigned int flags = bitcoinconsensus_SCRIPT_FLAGS_VERIFY_NONE |
         bitcoinconsensus_SCRIPT_FLAGS_VERIFY_P2SH | bitcoinconsensus_SCRIPT_FLAGS_VERIFY_DERSIG;
 
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_VERIFY_NONE", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_NONE, CONST_CS | CONST_PERSISTENT);
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_VERIFY_P2SH", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_P2SH, CONST_CS | CONST_PERSISTENT);
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_VERIFY_DERSIG", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_DERSIG, CONST_CS | CONST_PERSISTENT);
-
 #if HAVE_DECL_BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY == 1
     REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY, CONST_CS | CONST_PERSISTENT);
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_VERIFY_CHECKLOCKTIMEVERIFY", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY, CONST_CS | CONST_PERSISTENT);
     flags |= bitcoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY;
 #endif
 
 #if HAVE_DECL_BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY == 1
     REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY, CONST_CS | CONST_PERSISTENT);
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_VERIFY_CHECKSEQUENCEVERIFY", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY, CONST_CS | CONST_PERSISTENT);
     flags |= bitcoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY;
 #endif
 
 #if HAVE_DECL_BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_WITNESS == 1
     REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_WITNESS", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_WITNESS, CONST_CS | CONST_PERSISTENT);
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_VERIFY_WITNESS", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_WITNESS, CONST_CS | CONST_PERSISTENT);
     flags |= bitcoinconsensus_SCRIPT_FLAGS_VERIFY_WITNESS;
 #endif
 
 #if HAVE_DECL_BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY == 1
     REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY, CONST_CS | CONST_PERSISTENT);
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_VERIFY_NULLDUMMY", bitcoinconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY, CONST_CS | CONST_PERSISTENT);
     flags |= bitcoinconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY;
 #endif
 
 #if HAVE_DECL_BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL == 1
     flags = bitcoinconsensus_SCRIPT_FLAGS_VERIFY_ALL;
 #endif
 
-    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_VERIFY_ALL", flags, CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL", flags, CONST_CS | CONST_PERSISTENT);
 
-	return SUCCESS;
+    return SUCCESS;
 }
 
 PHP_MSHUTDOWN_FUNCTION(bitcoinconsensus)
@@ -173,7 +165,9 @@ PHP_MINFO_FUNCTION(bitcoinconsensus)
 const zend_function_entry bitcoinconsensus_functions[] = {
     PHP_FE(bitcoinconsensus_version, NULL)
     PHP_FE(bitcoinconsensus_verify_script, arginfo_bitcoinconsensus_verify_script)
+#if HAVE_DECL_BITCOINCONSENSUS_VERIFY_SCRIPT_WITH_AMOUNT == 1
     PHP_FE(bitcoinconsensus_verify_script_with_amount, arginfo_bitcoinconsensus_verify_script_with_amount)
+#endif
 	PHP_FE_END	/* Must be the last line in bitcoinconsensus_functions[] */
 };
 

Diff for: bitcoinconsensus/tests/bitcoinconsensus_verify_script_error3.phpt

@@ -9,7 +9,7 @@ if (!extension_loaded("bitcoinconsensus")) print "skip extension not loaded";
 $scriptPubKey = hex2bin("00140102030401020304010203040102030401020304");
 $tx = hex2bin("010000000100000000000000000000000000000000000000000000000000000000000000000000000000ffffffff010065cd1d0000000017a91400000000000000000000000000000000000000008700000000");
 $nIn = 0;
-$flags = BITCOINCONSENSUS_VERIFY_ALL;
+$flags = BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL;
 $error = 0;
 
 $result = bitcoinconsensus_verify_script($scriptPubKey, $tx, $nIn, $flags, $error);

Diff for: bitcoinconsensus/tests/bitcoinconsensus_verify_script_with_amount_basic1.phpt

@@ -11,7 +11,7 @@ $scriptPubKey = hex2bin("51");
 $tx = hex2bin("010000000100000000000000000000000000000000000000000000000000000000000000000000000000ffffffff010065cd1d0000000017a91400000000000000000000000000000000000000008700000000");
 $nIn = 0;
 $amount = 0;
-$flags = BITCOINCONSENSUS_VERIFY_WITNESS | BITCOINCONSENSUS_VERIFY_P2SH;
+$flags = BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_WITNESS | BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_P2SH;
 $error = 0;
 
 $result = bitcoinconsensus_verify_script_with_amount($scriptPubKey, $amount, $tx, $nIn, $flags, $error);

Diff for: bitcoinconsensus/tests/bitcoinconsensus_verify_script_with_amount_basic2.phpt

@@ -11,7 +11,7 @@ $scriptPubKey = hex2bin("00");
 $tx = hex2bin("010000000100000000000000000000000000000000000000000000000000000000000000000000000000ffffffff010065cd1d0000000017a91400000000000000000000000000000000000000008700000000");
 $nIn = 0;
 $amount = 0;
-$flags = BITCOINCONSENSUS_VERIFY_WITNESS | BITCOINCONSENSUS_VERIFY_P2SH;
+$flags = BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_WITNESS | BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_P2SH;
 $error = 0;
 
 $result = bitcoinconsensus_verify_script_with_amount($scriptPubKey, $amount, $tx, $nIn, $flags, $error);

Diff for: stubs/const.php

@@ -11,15 +11,8 @@
 const BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NONE = 0;
 const BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_P2SH = 1;
 const BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_DERSIG = 4;
-const BITCOINCONSENSUS_VERIFY_NONE = 0;
-const BITCOINCONSENSUS_VERIFY_P2SH = 1;
-const BITCOINCONSENSUS_VERIFY_DERSIG = 4;
 const BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY = 512;
-const BITCOINCONSENSUS_VERIFY_CHECKLOCKTIMEVERIFY = 512;
 const BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY = 1024;
-const BITCOINCONSENSUS_VERIFY_CHECKSEQUENCEVERIFY = 1024;
 const BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_WITNESS = 2048;
-const BITCOINCONSENSUS_VERIFY_WITNESS = 2048;
 const BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY = 16;
-const BITCOINCONSENSUS_VERIFY_NULLDUMMY = 16;
-const BITCOINCONSENSUS_VERIFY_ALL = 3605;
+const BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL = 3605;

Diff for: tests/BitcoinConsensusTest.php

@@ -10,31 +10,31 @@ public function testNullDummy()
     {
         $nullDummyBit = 1 << 4;
         $expectFindInALL = false;
-        if (defined('BITCOINCONSENSUS_VERIFY_NULLDUMMY')) {
+        if (defined('BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY')) {
             $expectFindInALL = true;
 
-            $this->assertEquals($nullDummyBit, BITCOINCONSENSUS_VERIFY_NULLDUMMY);
-            $this->assertEquals($nullDummyBit, BITCOINCONSENSUS_VERIFY_ALL & (BITCOINCONSENSUS_VERIFY_NULLDUMMY));
+            $this->assertEquals($nullDummyBit, BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY);
+            $this->assertEquals($nullDummyBit, BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL & (BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY));
         }
 
-        $this->assertEquals($expectFindInALL, (BITCOINCONSENSUS_VERIFY_ALL & ($nullDummyBit)) != 0);
+        $this->assertEquals($expectFindInALL, (BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL & ($nullDummyBit)) != 0);
     }
 
     public function testFlagsAll()
     {
         $expectFlags =
-            BITCOINCONSENSUS_VERIFY_NONE |
-            BITCOINCONSENSUS_VERIFY_P2SH |
-            BITCOINCONSENSUS_VERIFY_DERSIG |
-            BITCOINCONSENSUS_VERIFY_CHECKLOCKTIMEVERIFY |
-            BITCOINCONSENSUS_VERIFY_CHECKSEQUENCEVERIFY |
-            BITCOINCONSENSUS_VERIFY_WITNESS;
-
-        if (defined('BITCOINCONSENSUS_VERIFY_NULLDUMMY')) {
-            $expectFlags = $expectFlags | BITCOINCONSENSUS_VERIFY_NULLDUMMY;
+            BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NONE |
+            BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_P2SH |
+            BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_DERSIG |
+            BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY |
+            BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY |
+            BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_WITNESS;
+
+        if (defined('BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY')) {
+            $expectFlags = $expectFlags | BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_NULLDUMMY;
         }
 
-        $this->assertEquals($expectFlags, BITCOINCONSENSUS_VERIFY_ALL);
+        $this->assertEquals($expectFlags, BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL);
     }
 
     public function testVersion()
@@ -55,7 +55,7 @@ public function getSignerScriptTests()
 
             foreach ($vector['raw']['ins'] as $nIn => $input) {
                 $results[] = array(
-                    $input['scriptPubKey'], $input['value'], $tx, $nIn, BITCOINCONSENSUS_VERIFY_ALL, true, $vector
+                    $input['scriptPubKey'], $input['value'], $tx, $nIn, BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL, true, $vector
                 );
             }
         }
@@ -70,7 +70,7 @@ public function getBitcoinScriptTests()
         foreach ($vectors as $vector) {
             if ($vector === null) break;
 
-            if ($vector['flags'] == ($vector['flags']&BITCOINCONSENSUS_VERIFY_ALL)) {
+            if ($vector['flags'] == ($vector['flags']&BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_ALL)) {
                 $results[] = array(
                     $vector['scriptPubKey'], (int) $vector['amount'], $vector['tx'], $vector['nIn'], $vector['flags'], $vector['result'], $vector
                 );
@@ -106,8 +106,7 @@ public function testValidOk($scriptHex, $amount, $txHex, $nInput, $flags, $eResu
         $tx = pack("H*", $txHex);
 
         $error = 0;
-
-        if ($flags & (BITCOINCONSENSUS_VERIFY_P2SH | BITCOINCONSENSUS_VERIFY_WITNESS)) {
+        if ($flags & (BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_P2SH | BITCOINCONSENSUS_SCRIPT_FLAGS_VERIFY_WITNESS)) {
             $result = (bool)\bitcoinconsensus_verify_script_with_amount($script, $amount, $tx, $nInput, $flags, $error);
         } else {
             $result = (bool) \bitcoinconsensus_verify_script($script, $tx, $nInput, $flags, $error);

Diff for: tools/phpqa/Dockerfile

@@ -74,7 +74,7 @@ RUN set -xe; \
 		wget -O php.tar.xz.asc "$PHP_ASC_URL"; \
 		export GNUPGHOME="$(mktemp -d)"; \
 		for key in $GPG_KEYS; do \
-			gpg --keyserver ha.pool.sks-keyservers.net --recv-keys "$key"; \
+			gpg --keyserver pool.sks-keyservers.net --recv-keys "$key"; \
 		done; \
 		gpg --batch --verify php.tar.xz.asc php.tar.xz; \
 		rm -r "$GNUPGHOME"; \