Rename CTransaction/CMutableTransaction GetHash() to GetTxid()

Preparation for a future segwit-enabled release.

Author: petertodd

bitcoin/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2016 The python-bitcoinlib developers
+# Copyright (C) 2012-2017 The python-bitcoinlib developers
 #
 # This file is part of python-bitcoinlib.
 #
@@ -16,7 +16,7 @@
 # Note that setup.py can break if __init__.py imports any external
 # dependencies, as these might not be installed when setup.py runs. In this
 # case __version__ could be moved to a separate version.py and imported here.
-__version__ = '0.7.1-SNAPSHOT'
+__version__ = '0.8.0-SNAPSHOT'
 
 class MainParams(bitcoin.core.CoreMainParams):
     MESSAGE_START = b'\xf9\xbe\xb4\xd9'

bitcoin/core/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2015 The python-bitcoinlib developers
+# Copyright (C) 2012-2017 The python-bitcoinlib developers
 #
 # This file is part of python-bitcoinlib.
 #
@@ -356,8 +356,21 @@ def from_tx(cls, tx):
         else:
             return cls(tx.vin, tx.vout, tx.nLockTime, tx.nVersion)
 
+    def GetTxid(self):
+        return super(CTransaction, self).GetHash()
 
-@__make_mutable
+    def GetHash(self):
+        raise AttributeError("CTransaction.GetHash() has been removed; use GetTxid() instead")
+
+
+# preserve GetHash so our AttributeError-raising stub works
+def __make_CMutableTransaction_mutable(cls):
+    get_hash_fn = cls.GetHash
+    cls = __make_mutable(cls)
+    cls.GetHash = get_hash_fn
+    return cls
+
+@__make_CMutableTransaction_mutable
 class CMutableTransaction(CTransaction):
     """A mutable transaction"""
     __slots__ = []
@@ -384,7 +397,11 @@ def from_tx(cls, tx):
 
         return cls(vin, vout, tx.nLockTime, tx.nVersion)
 
+    def GetTxid(self):
+        return Serializable.GetHash(self)
 
+    def GetHash(self):
+        raise AttributeError("CMutableTransaction.GetHash() has been removed; use GetTxid() instead")
 
 
 class CBlockHeader(ImmutableSerializable):
@@ -478,7 +495,7 @@ def build_merkle_tree_from_txids(txids):
     @staticmethod
     def build_merkle_tree_from_txs(txs):
         """Build a full merkle tree from transactions"""
-        txids = [tx.GetHash() for tx in txs]
+        txids = [tx.GetTxid() for tx in txs]
         return CBlock.build_merkle_tree_from_txids(txids)
 
     def calc_merkle_root(self):
@@ -730,7 +747,7 @@ def CheckBlock(block, fCheckPoW = True, fCheckMerkleRoot = True, cur_time=None):
 
         CheckTransaction(tx)
 
-        txid = tx.GetHash()
+        txid = tx.GetTxid()
         if txid in unique_txids:
             raise CheckBlockError("CheckBlock() : duplicate transaction")
         unique_txids.add(txid)

bitcoin/core/scripteval.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2014 The python-bitcoinlib developers
+# Copyright (C) 2012-2017 The python-bitcoinlib developers
 #
 # This file is part of python-bitcoinlib.
 #
@@ -816,7 +816,7 @@ def VerifySignature(txFrom, txTo, inIdx):
         raise VerifySignatureError("txin prevout.n >= len(txFrom.vout)")
     txout = txFrom.vout[txin.prevout.n]
 
-    if txin.prevout.hash != txFrom.GetHash():
+    if txin.prevout.hash != txFrom.GetTxid():
         raise VerifySignatureError("prevout hash does not match txFrom")
 
     VerifyScript(txin.scriptSig, txout.scriptPubKey, txTo, inIdx)

bitcoin/tests/test_scripteval.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2014 The python-bitcoinlib developers
+# Copyright (C) 2013-2017 The python-bitcoinlib developers
 #
 # This file is part of python-bitcoinlib.
 #
@@ -89,7 +89,7 @@ def create_test_txs(self, scriptSig, scriptPubKey):
         txCredit = CTransaction([CTxIn(COutPoint(), CScript([OP_0, OP_0]), nSequence=0xFFFFFFFF)],
                                 [CTxOut(0, scriptPubKey)],
                                 nLockTime=0)
-        txSpend = CTransaction([CTxIn(COutPoint(txCredit.GetHash(), 0), scriptSig, nSequence=0xFFFFFFFF)],
+        txSpend = CTransaction([CTxIn(COutPoint(txCredit.GetTxid(), 0), scriptSig, nSequence=0xFFFFFFFF)],
                                [CTxOut(0, CScript())],
                                nLockTime=0)
         return (txCredit, txSpend)

bitcoin/tests/test_transactions.py

@@ -104,6 +104,15 @@ def test_GetHash(self):
         self.assertNotEqual(h1, txin.GetHash())
 
 class Test_CTransaction(unittest.TestCase):
+    def test_GetHash_removed(self):
+        tx = CTransaction()
+        with self.assertRaises(AttributeError):
+            tx.GetHash()
+
+        tx = CMutableTransaction()
+        with self.assertRaises(AttributeError):
+            tx.GetHash()
+
     def test_is_coinbase(self):
         tx = CMutableTransaction()
         self.assertFalse(tx.is_coinbase())

release-notes.md

@@ -1,5 +1,22 @@
 # python-bitcoinlib release notes
 
+## v0.8.0-PENDING
+
+Major breaking API change!
+
+While this interm release changes doesn't by itself include segwit support, it
+does change the name of the `CTransaction/CMutableTransaction` method
+`GetHash()` to `GetTxid()` to prepare for a future segwit-enabled release.
+Incorrect calls to `GetHash()` will now raise a `AttributeError` exception with
+an explanation.
+
+Since this release doesn't yet include segwit support, you will need to set the
+Bitcoin Core `-rpcserialversion=0` option, either as a command line argument,
+or in your `bitcoin.conf` file. Otherwise the RPC interface will return
+segwit-serialized transactions that this release's RPC support doesn't
+understand.
+
+
 ## v0.7.0
 
 Breaking API changes: