Merge pull request #31 from PIVX-Project/2020_cold-staking

[Core] Add Cold-Staking support

Author: random-zebra

img/icon_coldstaking.png

@@ -14,8 +14,10 @@
 MPATH_TESTNET = "44'/1'/"
 WIF_PREFIX = 212 # 212 = d4
 MAGIC_BYTE = 30
+STAKE_MAGIC_BYTE = 63
 TESTNET_WIF_PREFIX = 239
 TESTNET_MAGIC_BYTE = 139
+TESTNET_STAKE_MAGIC_BYTE = 73
 DEFAULT_PROTOCOL_VERSION = 70915
 MINIMUM_FEE = 0.0001    # minimum PIV/kB
 starting_width = 933

src/constants.py

@@ -147,6 +147,7 @@ def initTables(self):
             cursor.execute("CREATE TABLE IF NOT EXISTS REWARDS("
                            " tx_hash TEXT, tx_ouput_n INTEGER,"
                            " satoshis INTEGER, confirmations INTEGER, script TEXT, mn_name TEXT, coinstake BOOLEAN,"
+                           " staker TEXT,"
                            " PRIMARY KEY (tx_hash, tx_ouput_n))")
 
             cursor.execute("CREATE TABLE IF NOT EXISTS RAWTXES("
@@ -476,6 +477,7 @@ def rewards_from_rows(self, rows):
             utxo['script'] = row[4]
             utxo['mn_name'] = row[5]
             utxo['coinstake'] = row[6]
+            utxo['staker'] = row[7]
             # add to list
             rewards.append(utxo)
 
@@ -489,9 +491,9 @@ def addReward(self, utxo):
             cursor = self.getCursor()
 
             cursor.execute("INSERT OR REPLACE INTO REWARDS "
-                           "VALUES (?, ?, ?, ?, ?, ?, ?)",
+                           "VALUES (?, ?, ?, ?, ?, ?, ?, ?)",
                            (utxo['txid'], utxo['vout'], utxo['satoshis'],
-                            utxo['confirmations'], utxo['script'], utxo['mn_name'], utxo['coinstake'])
+                            utxo['confirmations'], utxo['script'], utxo['mn_name'], utxo['coinstake'], utxo['staker'])
                            )
 
         except Exception as e:

src/database.py

@@ -128,16 +128,3 @@ def signMess(self, caller, path, message, isTestnet=False):
         printDbg("HW: Signing message...")
         self.api.signMess(caller, path, message, isTestnet)
         printOK("HW: Message signed")
-
-
-    @check_api_init
-    def signTxSign(self, ctrl):
-        printDbg("HW: Signing TX...")
-        self.api.signTxSign(ctrl)
-
-
-    @check_api_init
-    def signTxFinish(self):
-        printDbg("HW: Finishing TX signature...")
-        self.api.signTxFinish()
-        printDbg("HW: TX signed")

src/hwdevice.py

@@ -148,7 +148,8 @@ def append_inputs_to_TX(self, utxo, bip32_path):
             'pubkey': curr_pubkey,
             'bip32_path': bip32_path,
             'outputIndex': utxo['vout'],
-            'txid': utxo['txid']
+            'txid': utxo['txid'],
+            'p2cs': (utxo['staker'] != "")
         })
 
 
@@ -370,7 +371,10 @@ def signTxSign(self, ctrl):
                 inputTx.prevOut = bytearray.fromhex(new_input['txid'])[::-1] + int.to_bytes(new_input['outputIndex'], 4,
                                                                                             byteorder='little')
 
-                inputTx.script = bytearray([len(sig)]) + sig + bytearray([0x21]) + new_input['pubkey']
+                inputTx.script = bytearray([len(sig)]) + sig
+                if new_input['p2cs']:
+                    inputTx.script += bytearray([0x00])
+                inputTx.script += bytearray([0x21]) + new_input['pubkey']
 
                 inputTx.sequence = bytearray([0xFF, 0xFF, 0xFF, 0xFF])
 

src/ledgerClient.py

@@ -9,7 +9,8 @@
 import bitcoin
 import hashlib
 
-from constants import WIF_PREFIX, MAGIC_BYTE, TESTNET_WIF_PREFIX, TESTNET_MAGIC_BYTE
+from constants import WIF_PREFIX, MAGIC_BYTE, TESTNET_WIF_PREFIX, TESTNET_MAGIC_BYTE, \
+    STAKE_MAGIC_BYTE, TESTNET_STAKE_MAGIC_BYTE
 from pivx_b58 import b58encode, b58decode
 
 def double_sha256(data):
@@ -42,16 +43,19 @@ def base58fromhex(hexstr, isTestnet):
     return b58encode(data + checksum)
 
 
-def pubkey_to_address(pubkey, isTestnet=False):
+def pubkey_to_address(pubkey, isTestnet=False, isCold=False):
     pubkey_bin = bytes.fromhex(pubkey)
     pkey_hash = bitcoin.bin_hash160(pubkey_bin)
-    return pubkeyhash_to_address(pkey_hash, isTestnet)
+    return pubkeyhash_to_address(pkey_hash, isTestnet, isCold)
 
 
 
-def pubkeyhash_to_address(pkey_hash, isTestnet=False):
-    base58_pubkey = TESTNET_MAGIC_BYTE if isTestnet else MAGIC_BYTE
-    data = bytes([base58_pubkey]) + pkey_hash
+def pubkeyhash_to_address(pkey_hash, isTestnet=False, isCold=False):
+    if isCold:
+        base58_secret = TESTNET_STAKE_MAGIC_BYTE if isTestnet else STAKE_MAGIC_BYTE
+    else:
+        base58_secret = TESTNET_MAGIC_BYTE if isTestnet else MAGIC_BYTE
+    data = bytes([base58_secret]) + pkey_hash
     checksum = bitcoin.bin_dbl_sha256(data)[0:4]
     return b58encode(data + checksum)
 

src/pivx_hashlib.py

@@ -5,7 +5,7 @@
 # file LICENSE.txt or http://www.opensource.org/licenses/mit-license.php.
 
 from misc import getCallerName, getFunctionName, printException
-from utils import extract_pkh_from_locking_script
+import utils
 from pivx_hashlib import pubkeyhash_to_address
 
 class HexParser():
@@ -72,9 +72,11 @@ def ParseTxOutput(p, isTestnet=False):
     vout["scriptPubKey"]["addresses"] = []
     try:
         locking_script = bytes.fromhex(vout["scriptPubKey"]["hex"])
-        # add addresses only if P2PKH or P2PK
-        if len(locking_script) in [25, 35]:
-            add_bytes = extract_pkh_from_locking_script(locking_script)
+
+        # add addresses only if P2PKH, P2PK or P2CS
+        if len(locking_script) in [25, 35, 51]:
+            add_bytes = utils.extract_pkh_from_locking_script(locking_script)
+
             address = pubkeyhash_to_address(add_bytes, isTestnet)
             vout["scriptPubKey"]["addresses"].append(address)
     except Exception as e:
@@ -102,6 +104,20 @@ def ParseTx(hex_string, isTestnet=False):
     return tx
 
 
-def IsCoinStake(rawtx):
-    json_tx = ParseTx(rawtx)
-    return json_tx['vout'][0]["scriptPubKey"]["hex"] == ""
+def IsCoinStake(tx):
+    return tx['vout'][0]["scriptPubKey"]["hex"] == ""
+
+
+def IsPayToColdStaking(rawtx, out_n):
+    tx = ParseTx(rawtx)
+    script = tx['vout'][out_n]["scriptPubKey"]["hex"]
+    return utils.IsPayToColdStaking(bytes.fromhex(script)), IsCoinStake(tx)
+
+
+def GetDelegatedStaker(rawtx, out_n, isTestnet):
+    tx = ParseTx(rawtx)
+    script = tx['vout'][out_n]["scriptPubKey"]["hex"]
+    if not utils.IsPayToColdStaking(bytes.fromhex(script)):
+        return ""
+    pkh = utils.GetDelegatedStaker(bytes.fromhex(script))
+    return pubkeyhash_to_address(pkh, isTestnet, isCold=True)

src/pivx_parser.py

@@ -178,4 +178,5 @@ def loadIcons(self):
         self.ledgerImg = QPixmap(os.path.join(self.caller.imgDir, 'ledger.png'))
         self.trezorImg = QPixmap(os.path.join(self.caller.imgDir, 'trezorModT.png'))
         self.trezorOneImg = QPixmap(os.path.join(self.caller.imgDir, 'trezorOne.png'))
+        self.coldStaking_icon = QIcon(os.path.join(self.caller.imgDir, 'icon_coldstaking.png'))
         self.threeDots_icon = QPixmap(os.path.join(self.caller.imgDir, 'icon_3dots.png'))

src/qt/gui_tabMain.py

@@ -15,7 +15,7 @@
 from constants import MINIMUM_FEE
 from misc import printDbg, printError, printException, getCallerName, getFunctionName, \
     persistCacheSetting, myPopUp, myPopUp_sb, DisconnectedException, checkTxInputs
-from pivx_parser import ParseTx, IsCoinStake
+from pivx_parser import ParseTx, IsPayToColdStaking, GetDelegatedStaker
 from qt.gui_tabRewards import TabRewards_gui
 from threads import ThreadFuns
 from txCache import TxCache
@@ -100,6 +100,11 @@ def item(value):
                 self.ui.rewardsList.box.setItem(row, 2, item(txId))
                 self.ui.rewardsList.box.setItem(row, 3, item(str(utxo.get('vout', None))))
                 self.ui.rewardsList.box.showRow(row)
+                # mark cold utxos
+                if utxo['staker'] != "":
+                    self.ui.rewardsList.box.item(row, 2).setIcon(self.caller.tabMain.coldStaking_icon)
+                    self.ui.rewardsList.box.item(row, 2).setToolTip("Staked by <b>%s</b>" % utxo['staker'])
+
                 # MARK COLLATERAL UTXO
                 if txId == self.curr_txid:
                     for i in range(0,4):
@@ -112,8 +117,9 @@ def item(value):
                     if utxo['confirmations'] < required:
                         for i in range(0,4):
                             self.ui.rewardsList.box.item(row, i).setFlags(Qt.NoItemFlags)
+                            ttip = self.ui.rewardsList.box.item(row, i).toolTip()
                             self.ui.rewardsList.box.item(row, i).setToolTip(
-                                "Immature - 100 confirmations required")
+                                ttip + "\n(Immature - %d confirmations required)" % required)
 
             self.ui.rewardsList.box.resizeColumnsToContents()
 
@@ -217,7 +223,10 @@ def load_utxos_thread(self, ctrl):
                         mn_rewards[mn].remove(utxo)
                         continue
                     utxo['raw_tx'] = rawtx
-                    utxo['coinstake'] = IsCoinStake(rawtx)
+                    utxo['staker'] = ""
+                    p2cs, utxo['coinstake'] = IsPayToColdStaking(rawtx, utxo['vout'])
+                    if p2cs:
+                        utxo['staker'] = GetDelegatedStaker(rawtx, utxo['vout'], self.caller.isTestnetRPC)
                     # Add utxo to database
                     self.caller.parent.db.addReward(utxo)
 

src/tabRewards.py

@@ -84,6 +84,9 @@ def __init__(self, model, main_wnd, *args, **kwargs):
 
     @process_trezor_exceptions
     def append_inputs_to_TX(self, utxo, bip32_path, inputs):
+        if utxo['staker'] != "":
+            printException(getCallerName(), getFunctionName(), "Unable to sing P2CS on Trezor", "")
+            return
         # Update amount
         self.amount += int(utxo['satoshis'])
         # Add input