Make relayFee an integer everywhere.

Because an atom cannot be divided, and we convert it to an integer
already in a few places, it should be an integer and not a float from
the beginning.

Also fix docstrings.

Author: JoeGruffins

decred/decred/dcr/dcrdata.py

@@ -852,13 +852,25 @@ def saveBlockHeader(self, header):
         self.heightMap[header.height] = bHash
         self.headerDB[bHash] = header
 
-    def sendToAddress(self, value, address, keysource, utxosource, relayFee):
+    def checkFeeRate(self, relayFee):
+        """
+        Check that the relay fee is lower than the allowed max of
+        txscript.HighFeeRate.
+        """
+        if relayFee > txscript.HighFeeRate:
+            raise DecredError(
+                f"relay fee of {relayFee} is above the allowed max of {txscript.HighFeeRate}"
+            )
+
+    def sendToAddress(
+        self, value, address, keysource, utxosource, relayFee, allowHighFees=False
+    ):
         """
         Send the amount in atoms to the specified address.
 
         Args:
-            value int: The amount to send, in atoms.
-            address str: The base-58 encoded address.
+            value (int): The amount to send, in atoms.
+            address (str): The base-58 encoded address.
             keysource func(str) -> PrivateKey: A function that returns the
                 private key for an address.
             utxosource func(int, func(UTXO) -> bool) -> list(UTXO): A function
@@ -867,11 +879,18 @@ def sendToAddress(self, value, address, keysource, utxosource, relayFee):
                 amount. If the filtering function is provided, UTXOs for which
                 the  function return a falsey value will not be included in the
                 returned UTXO list.
-            MsgTx: The newly created transaction on success, `False` on failure.
+            relayFee (int): Transaction fees in atoms per kb.
+            allowHighFees (bool): Optional. Default is False. Whether to allow
+              fees higher than txscript.HighFeeRate.
+
+        Returns:
+            MsgTx: The newly created transaction. Raises an exception on error.
         """
+        if not allowHighFees:
+            self.checkFeeRate(relayFee)
         self.updateTip()
         outputs = makeOutputs([(address, value)], self.netParams)
-        return self.sendOutputs(outputs, keysource, utxosource, relayFee)
+        return self.sendOutputs(outputs, keysource, utxosource, relayFee, allowHighFees)
 
     def broadcast(self, txHex):
         """
@@ -953,7 +972,9 @@ def confirmUTXO(self, utxo, block=None, tx=None):
             pass
         return False
 
-    def sendOutputs(self, outputs, keysource, utxosource, relayFee):
+    def sendOutputs(
+        self, outputs, keysource, utxosource, relayFee, allowHighFees=False
+    ):
         """
         Send the `TxOut`s to the address.
 
@@ -973,12 +994,17 @@ def sendOutputs(self, outputs, keysource, utxosource, relayFee):
                 sufficient to complete the transaction. If the filtering
                 function is provided, UTXOs for which the  function return a
                 falsey value will not be included in the returned UTXO list.
+            relayFee (int): Transaction fees in atoms per kb.
+            allowHighFees (bool): Optional. Default is False. Whether to allow
+              fees higher than txscript.HighFeeRate.
 
         Returns:
             newTx MsgTx: The sent transaction.
             utxos list(UTXO): The spent UTXOs.
             newUTXOs list(UTXO): Length 1 array containing the new change UTXO.
         """
+        if not allowHighFees:
+            self.checkFeeRate(relayFee)
         total = 0
         inputs = []
         scripts = []
@@ -1100,7 +1126,9 @@ def sendOutputs(self, outputs, keysource, utxosource, relayFee):
 
             return newTx, utxos, newUTXOs
 
-    def purchaseTickets(self, keysource, utxosource, req, relayFee):
+    def purchaseTickets(
+        self, keysource, utxosource, req, relayFee, allowHighFees=False
+    ):
         """
         Based on dcrwallet (*Wallet).purchaseTickets.
         purchaseTickets indicates to the wallet that a ticket should be
@@ -1115,6 +1143,9 @@ def purchaseTickets(self, keysource, utxosource, req, relayFee):
                 UTXOs. The filterFunc is an optional function to filter UTXOs,
                 and is of the form func(UTXO) -> bool.
             req account.TicketRequest: the ticket data.
+            relayFee (int): Transaction fees in atoms per kb.
+            allowHighFees (bool): Optional. Default is False. Whether to allow
+              fees higher than txscript.HighFeeRate.
 
         Returns:
             (splitTx, tickets) tuple: first element is the split transaction.
@@ -1125,6 +1156,8 @@ def purchaseTickets(self, keysource, utxosource, req, relayFee):
                 addresses.
 
         """
+        if not allowHighFees:
+            self.checkFeeRate(relayFee)
         self.updateTip()
         # account minConf is zero for regular outputs for now. Need to make that
         # adjustable.
@@ -1267,7 +1300,7 @@ def purchaseTickets(self, keysource, utxosource, req, relayFee):
         # Send the split transaction.
         # sendOutputs takes the fee rate in atoms/byte
         splitTx, splitSpent, internalOutputs = self.sendOutputs(
-            splitOuts, keysource, utxosource, int(txFeeIncrement / 1000)
+            splitOuts, keysource, utxosource, txFeeIncrement // 1000, allowHighFees
         )
 
         # Generate the tickets individually.
@@ -1363,7 +1396,7 @@ def purchaseTickets(self, keysource, utxosource, req, relayFee):
             )
         return (splitTx, tickets), splitSpent, internalOutputs
 
-    def revokeTicket(self, tx, keysource, redeemScript, relayFee):
+    def revokeTicket(self, tx, keysource, redeemScript, relayFee, allowHighFees=False):
         """
         Revoke a ticket by signing the supplied redeem script and broadcasting
         the raw transaction.
@@ -1374,10 +1407,15 @@ def revokeTicket(self, tx, keysource, redeemScript, relayFee):
                 the private key used for signing.
             redeemScript (byte-like): the 1-of-2 multisig script that delegates
                 voting rights for the ticket.
+            relayFee (int): Transaction fees in atoms per kb.
+            allowHighFees (bool): Optional. Default is False. Whether to allow
+              fees higher than txscript.HighFeeRate.
 
         Returns:
             MsgTx: the signed revocation.
         """
+        if not allowHighFees:
+            self.checkFeeRate(relayFee)
 
         revocation = txscript.makeRevocation(tx, relayFee)
 

decred/decred/dcr/txscript.py

@@ -154,7 +154,10 @@
 # to maintain reference.
 
 # DefaultRelayFeePerKb is the default minimum relay fee policy for a mempool.
-DefaultRelayFeePerKb = 1e4
+DefaultRelayFeePerKb = int(1e4)
+
+# HighFeeRate is the atoms/kb rate that is considered too high.
+HighFeeRate = DefaultRelayFeePerKb * 1000
 
 # MaxStandardTxSize is the maximum size allowed for transactions that are
 # considered standard and will therefore be relayed and considered for mining.
@@ -2605,7 +2608,7 @@ def paysHighFees(totalInput, tx):
         # Impossible to determine
         return False
 
-    maxFee = calcMinRequiredTxRelayFee(1000 * DefaultRelayFeePerKb, tx.serializeSize())
+    maxFee = calcMinRequiredTxRelayFee(HighFeeRate, tx.serializeSize())
     return fee > maxFee
 
 
@@ -3406,7 +3409,7 @@ def calcMinRequiredTxRelayFee(relayFeePerKb, txSerializeSize):
     pool and relayed.
 
     Args:
-        relayFeePerKb (float): The fee per kilobyte.
+        relayFeePerKb (int): The fee in atoms per kilobyte.
         txSerializeSize int: (Size) of the byte-encoded transaction.
 
     Returns:
@@ -3436,7 +3439,7 @@ def isDustAmount(amount, scriptSize, relayFeePerKb):
     Args:
         amount (int): Atoms.
         scriptSize (int): Byte-size of the script.
-        relayFeePerKb (float): Fees paid per kilobyte.
+        relayFeePerKb (int): Fees paid in atoms per kilobyte.
 
     Returns:
         bool: True if the amount is considered dust.
@@ -3495,7 +3498,7 @@ def isDustOutput(output, relayFeePerKb):
 
     Args:
         output (wire.TxOut): The transaction output.
-        relayFeePerKb: Minimum transaction fee allowable.
+        relayFeePerKb (int): The transaction fee in atoms per kb.
 
     Returns:
         bool: True if output is a dust output.
@@ -3770,7 +3773,7 @@ def stakePoolTicketFee(stakeDiff, relayFee, height, poolFee, subsidyCache, netPa
 
     Args:
         stakeDiff (int): The ticket price.
-        relayFee (int): Transaction fees.
+        relayFee (int): Transaction fees in atoms per kb.
         height (int): Current block height.
         poolFee (int): The pools fee, as percent.
         subsidyCache (calc.SubsidyCache): A subsidy cache.
@@ -3805,8 +3808,8 @@ def stakePoolTicketFee(stakeDiff, relayFee, height, poolFee, subsidyCache, netPa
     # The numerator is (p*10000*s*(v+z)) << 64.
     shift = 64
     s = subsidy
-    v = int(stakeDiff)
-    z = int(relayFee)
+    v = stakeDiff
+    z = relayFee
     num = poolFeeInt
     num *= s
     vPlusZ = v + z