Add utxo locks

counterparty-core/counterpartycore/lib/composer.py

@@ -1,4 +1,6 @@
 import binascii
+import time
+from collections import OrderedDict
 
 from bitcoinutils.keys import P2pkhAddress, P2wpkhAddress, PublicKey
 from bitcoinutils.script import Script, b_to_h
@@ -51,7 +53,7 @@
             encoding = "opreturn"
         else:
             encoding = "multisig"
     if encoding not in ("multisig", "opreturn"):
         raise exceptions.TransactionError(f"Not supported encoding: {encoding}")
     return encoding
 
@@ -73,7 +75,7 @@
     try:
         PublicKey.from_hex(pubkey).get_address(compressed=True).to_string()
         return True
     except Exception:
         return False
 
 
@@ -158,6 +160,33 @@
 ################
 
 
+class UTXOLocks(metaclass=util.SingletonMeta):
+    def __init__(self):
+        self.locks = OrderedDict()
+        self.max_age = config.UTXO_LOCKS_MAX_AGE
+        self.max_size = config.UTXO_LOCKS_MAX_ADDRESSES
+
+    def lock(self, utxo):
+        self.locks[utxo] = time.time()
+        if len(self.locks) > self.max_size:
+            self.locks.popitem(last=False)
+
+    def locked(self, utxo):
+        if utxo not in self.locks:
+            return False
+        if time.time() - self.locks[utxo] > self.max_age:
+            del self.locks[utxo]
+            return False
+        return True
+
+    def filter_unspent_list(self, unspent_list):
+        return [utxo for utxo in unspent_list if not self.locked(f"{utxo['txid']}:{utxo['vout']}")]
+
+    def lock_inputs(self, inputs):
+        for input in inputs:
+            self.lock(f"{input.txid}:{input.txout_index}")
+
+
 def list_unspent(source, allow_unconfirmed_inputs):
     min_conf = 0 if allow_unconfirmed_inputs else 1
 
@@ -169,7 +198,7 @@
         pass
 
     # then try with Electrs
     if len(unspent_list) == 0 and config.ELECTRS_URL is None:
         raise exceptions.ComposeError(
             "No UTXOs found with Bitcoin Core and Electr is not configured, use the `inputs_set` parameter to provide UTXOs"
         )
@@ -258,7 +287,7 @@
     return new_unspent_list
 
 
 def filter_utxos_with_balances(db, unspent_list, construct_params):
     use_utxos_with_balances = construct_params.get("use_utxos_with_balances", False)
     if use_utxos_with_balances:
         return unspent_list
@@ -268,7 +297,7 @@
     for utxo in unspent_list:
         str_input = f"{utxo['txid']}:{utxo['vout']}"
         utxo_balances = ledger.get_utxo_balances(db, str_input)
         with_balances = len(utxo_balances) > 0 and any(
             [balance["quantity"] > 0 for balance in utxo_balances]
         )
         if exclude_utxos_with_balances and with_balances:
@@ -303,6 +332,10 @@
             if f"{utxo['txid']}:{utxo['vout']}" not in exclude_utxos_list
         ]
 
+    # excluded locked utxos
+    if not construct_params.get("disable_utxo_lock", False):
+        unspent_list = UTXOLocks().filter_unspent_list(unspent_list)
+
     # exclude utxos with balances if needed
     filter_utxos_with_balances(db, unspent_list, construct_params)
 
@@ -395,7 +428,7 @@
         # if change is enough for exact_fee, add change output and break
         if exact_fee is not None:
             change_amount = change_amount - exact_fee
             if change_amount > config.REGULAR_DUST_SIZE:
                 change_outputs.append(TxOutput(change_amount, get_script(source)))
             break
 
@@ -407,7 +440,7 @@
         # if change is enough for needed fee, add change output and break
         if change_amount > needed_fee:
             change_amount = change_amount - needed_fee
             if change_amount > config.REGULAR_DUST_SIZE:
                 change_outputs.append(TxOutput(change_amount, get_script(source)))
             break
         # else try with more inputs
@@ -416,7 +449,7 @@
     return inputs, btc_in, change_outputs
 
 
 """
 +encoding
 +validate
 +verbose
@@ -431,11 +464,11 @@
 +exclude_utxos
 +use_utxos_with_balances
 +exclude_utxos_with_balances
-disable_utxo_lock
++disable_utxo_lock
 
 +mutlisig_pubkey
 
-more_outputs
+-more_outputs
 
 regular_dust_size (removed)
 multisig_dust_size (removed)
@@ -471,13 +504,16 @@
         source, outputs, unspent_list, construct_params
     )
 
+    if not construct_params.get("disable_utxo_lock", False):
+        UTXOLocks().lock_inputs(inputs)
+
     # construct transaction
     tx = Transaction(inputs, outputs + change_outputs)
     btc_out = sum(output.nValue for output in outputs)
     btc_change = sum(change_output.nValue for change_output in change_outputs)
     verbose = construct_params.get("validate", False)
 
     if verbose:
         unsigned_tx_hex = tx.serialize().hex()
         return {
             "btc_in": btc_in,