mirror of
https://github.com/aljazceru/python-teos.git
synced 2025-12-17 14:14:22 +01:00
aa12fa2cf8
The sleep flag was used to avoid doing useless work when no data was hold by the tower. However, from the implementation of the data persistence on, the Watcher and Responder should at least keep track of the last known block. The current apporach was making this harder.
490 lines
21 KiB
Python
490 lines
21 KiB
Python
import json
|
|
from queue import Queue
|
|
from threading import Thread
|
|
|
|
from pisa import LOG_PREFIX
|
|
from common.logger import Logger
|
|
from pisa.cleaner import Cleaner
|
|
from pisa.carrier import Carrier
|
|
from pisa.block_processor import BlockProcessor
|
|
|
|
CONFIRMATIONS_BEFORE_RETRY = 6
|
|
MIN_CONFIRMATIONS = 6
|
|
|
|
logger = Logger(actor="Responder", log_name_prefix=LOG_PREFIX)
|
|
|
|
|
|
class TransactionTracker:
|
|
"""
|
|
A :class:`TransactionTracker` is used to monitor a ``penalty_tx``. Once the dispute is seen by the
|
|
:obj:`Watcher <pisa.watcher.Watcher>` the penalty transaction is decrypted and the relevant appointment data is
|
|
passed along to the :obj:`Responder`.
|
|
|
|
Once the :obj:`Responder` has succeeded on broadcasting the penalty transaction it will create a
|
|
:obj:`TransactionTracker` and monitor the blockchain until the end of the appointment.
|
|
|
|
Args:
|
|
locator (:obj:`str`): A 16-byte hex-encoded value used by the tower to detect channel breaches. It serves as a
|
|
trigger for the tower to decrypt and broadcast the penalty transaction.
|
|
dispute_txid (:obj:`str`): the id of the transaction that created the channel breach and triggered the penalty.
|
|
penalty_txid (:obj:`str`): the id of the transaction that was encrypted under ``dispute_txid``.
|
|
penalty_rawtx (:obj:`str`): the raw transaction that was broadcast as a consequence of the channel breach.
|
|
appointment_end (:obj:`int`): the block at which the tower will stop monitoring the blockchain for this
|
|
appointment.
|
|
"""
|
|
|
|
def __init__(self, locator, dispute_txid, penalty_txid, penalty_rawtx, appointment_end):
|
|
self.locator = locator
|
|
self.dispute_txid = dispute_txid
|
|
self.penalty_txid = penalty_txid
|
|
self.penalty_rawtx = penalty_rawtx
|
|
self.appointment_end = appointment_end
|
|
|
|
@classmethod
|
|
def from_dict(cls, tx_tracker_data):
|
|
"""
|
|
Constructs a :obj:`TransactionTracker` instance from a dictionary. Requires that all the fields are populated
|
|
(``not None``).
|
|
|
|
Useful to load data from the database.
|
|
|
|
Args:
|
|
tx_tracker_data (:obj:`dict`): a dictionary with an entry per each field required to create the
|
|
:obj:`TransactionTracker`.
|
|
|
|
Returns:
|
|
:obj:`TransactionTracker`: A ``TransactionTracker`` instantiated with the provided data.
|
|
|
|
Raises:
|
|
ValueError: if any of the required fields is missing.
|
|
"""
|
|
|
|
locator = tx_tracker_data.get("locator")
|
|
dispute_txid = tx_tracker_data.get("dispute_txid")
|
|
penalty_txid = tx_tracker_data.get("penalty_txid")
|
|
penalty_rawtx = tx_tracker_data.get("penalty_rawtx")
|
|
appointment_end = tx_tracker_data.get("appointment_end")
|
|
|
|
if any(v is None for v in [locator, dispute_txid, penalty_txid, penalty_rawtx, appointment_end]):
|
|
raise ValueError("Wrong transaction tracker data, some fields are missing")
|
|
|
|
else:
|
|
tx_tracker = cls(locator, dispute_txid, penalty_txid, penalty_rawtx, appointment_end)
|
|
|
|
return tx_tracker
|
|
|
|
def to_dict(self):
|
|
"""
|
|
Exports a :obj:`TransactionTracker` as a dictionary.
|
|
|
|
Returns:
|
|
:obj:`dict`: A dictionary containing the :obj:`TransactionTracker` data.
|
|
"""
|
|
|
|
tx_tracker = {
|
|
"locator": self.locator,
|
|
"dispute_txid": self.dispute_txid,
|
|
"penalty_txid": self.penalty_txid,
|
|
"penalty_rawtx": self.penalty_rawtx,
|
|
"appointment_end": self.appointment_end,
|
|
}
|
|
|
|
return tx_tracker
|
|
|
|
def to_json(self):
|
|
"""
|
|
Exports a :obj:`TransactionTracker` as a json-encoded dictionary.
|
|
|
|
Returns:
|
|
:obj:`str`: A json-encoded dictionary containing the :obj:`TransactionTracker` data.
|
|
"""
|
|
|
|
return json.dumps(self.to_dict())
|
|
|
|
|
|
class Responder:
|
|
"""
|
|
The :class:`Responder` is the class in charge of ensuring that channel breaches are dealt with. It does so handling
|
|
the decrypted ``penalty_txs`` handed by the :obj:`Watcher <pisa.watcher.Watcher>` and ensuring the they make it to
|
|
the blockchain.
|
|
|
|
Args:
|
|
db_manager (:obj:`DBManager <pisa.db_manager.DBManager>`): a ``DBManager`` instance to interact with the
|
|
database.
|
|
|
|
Attributes:
|
|
trackers (:obj:`dict`): A dictionary containing the minimum information about the :obj:`TransactionTracker`
|
|
required by the :obj:`Responder` (``penalty_txid``, ``locator`` and ``end_time``).
|
|
Each entry is identified by a ``uuid``.
|
|
tx_tracker_map (:obj:`dict`): A ``penalty_txid:uuid`` map used to allow the :obj:`Responder` to deal with
|
|
several trackers triggered by the same ``penalty_txid``.
|
|
unconfirmed_txs (:obj:`list`): A list that keeps track of all unconfirmed ``penalty_txs``.
|
|
missed_confirmations (:obj:`dict`): A dictionary that keeps count of how many confirmations each ``penalty_tx``
|
|
has missed. Used to trigger rebroadcast if needed.
|
|
block_queue (:obj:`Queue`): A queue used by the :obj:`Responder` to receive block hashes from ``bitcoind``. It
|
|
is populated by the :obj:`ChainMonitor <pisa.chain_monitor.ChainMonitor>`.
|
|
db_manager (:obj:`DBManager <pisa.db_manager.DBManager>`): A ``DBManager`` instance to interact with the
|
|
database.
|
|
|
|
"""
|
|
|
|
def __init__(self, db_manager):
|
|
self.trackers = dict()
|
|
self.tx_tracker_map = dict()
|
|
self.unconfirmed_txs = []
|
|
self.missed_confirmations = dict()
|
|
self.block_queue = Queue()
|
|
self.db_manager = db_manager
|
|
self.carrier = Carrier()
|
|
self.last_known_block = db_manager.load_last_block_hash_responder()
|
|
|
|
def awake(self):
|
|
responder_thread = Thread(target=self.do_watch, daemon=True)
|
|
responder_thread.start()
|
|
|
|
return responder_thread
|
|
|
|
@staticmethod
|
|
def on_sync(block_hash):
|
|
"""
|
|
Whether the :obj:`Responder` is on sync with ``bitcoind`` or not. Used when recovering from a crash.
|
|
|
|
The Watchtower can be instantiated with fresh or with backed up data. In the later, some triggers may have been
|
|
missed. In order to go back on sync both the :obj:`Watcher <pisa.watcher.Watcher>` and the :obj:`Responder`
|
|
need to perform the state transitions until they catch up.
|
|
|
|
If a transaction is broadcast by the :obj:`Responder` and it is rejected (due to a double-spending for example)
|
|
and the :obj:`Responder` is off-sync then the :obj:`TransactionTracker` is abandoned.
|
|
|
|
This method helps making that decision.
|
|
|
|
Args:
|
|
block_hash (:obj:`str`): the block hash passed to the :obj:`Responder` in the ``handle_breach`` request.
|
|
|
|
Returns:
|
|
:obj:`bool`: Whether or not the :obj:`Responder` and ``bitcoind`` are on sync.
|
|
"""
|
|
|
|
block_processor = BlockProcessor()
|
|
distance_from_tip = block_processor.get_distance_to_tip(block_hash)
|
|
|
|
if distance_from_tip is not None and distance_from_tip > 1:
|
|
synchronized = False
|
|
|
|
else:
|
|
synchronized = True
|
|
|
|
return synchronized
|
|
|
|
def handle_breach(self, uuid, locator, dispute_txid, penalty_txid, penalty_rawtx, appointment_end, block_hash):
|
|
"""
|
|
Requests the :obj:`Responder` to handle a channel breach. This is the entry point of the :obj:`Responder`.
|
|
|
|
Args:
|
|
uuid (:obj:`str`): a unique identifier for the appointment.
|
|
locator (:obj:`str`): the appointment locator provided by the user (16-byte hex-encoded).
|
|
dispute_txid (:obj:`str`): the id of the transaction that created the channel breach.
|
|
penalty_txid (:obj:`str`): the id of the decrypted transaction included in the appointment.
|
|
penalty_rawtx (:obj:`str`): the raw transaction to be broadcast in response of the breach.
|
|
appointment_end (:obj:`int`): the block height at which the :obj:`Responder` will stop monitoring for this
|
|
penalty transaction.
|
|
block_hash (:obj:`str`): the block hash at which the breach was seen (used to see if we are on sync).
|
|
|
|
Returns:
|
|
:obj:`Receipt <pisa.carrier.Receipt>`: A ``Receipt`` indicating whether or not the ``penalty_tx`` made it
|
|
into the blockchain.
|
|
"""
|
|
|
|
receipt = self.carrier.send_transaction(penalty_rawtx, penalty_txid)
|
|
|
|
if receipt.delivered:
|
|
self.add_tracker(
|
|
uuid, locator, dispute_txid, penalty_txid, penalty_rawtx, appointment_end, receipt.confirmations
|
|
)
|
|
|
|
else:
|
|
# TODO: Add the missing reasons (e.g. RPC_VERIFY_REJECTED)
|
|
# TODO: Use self.on_sync(block_hash) to check whether or not we failed because we are out of sync
|
|
logger.warning(
|
|
"Tracker cannot be created", reason=receipt.reason, uuid=uuid, on_sync=self.on_sync(block_hash)
|
|
)
|
|
|
|
return receipt
|
|
|
|
def add_tracker(self, uuid, locator, dispute_txid, penalty_txid, penalty_rawtx, appointment_end, confirmations=0):
|
|
"""
|
|
Creates a :obj:`TransactionTracker` after successfully broadcasting a ``penalty_tx``.
|
|
|
|
A reduction of :obj:`TransactionTracker` is stored in ``trackers`` and ``tx_tracker_map`` and the
|
|
``penalty_txid`` added to ``unconfirmed_txs`` if ``confirmations=0``. Finally, all the data is stored in the
|
|
database.
|
|
|
|
Args:
|
|
uuid (:obj:`str`): a unique identifier for the appointment.
|
|
locator (:obj:`str`): the appointment locator provided by the user (16-byte hex-encoded).
|
|
dispute_txid (:obj:`str`): the id of the transaction that created the channel breach.
|
|
penalty_txid (:obj:`str`): the id of the decrypted transaction included in the appointment.
|
|
penalty_rawtx (:obj:`str`): the raw transaction to be broadcast.
|
|
appointment_end (:obj:`int`): the block height at which the :obj:`Responder` will stop monitoring for the
|
|
tracker.
|
|
confirmations (:obj:`int`): the confirmation count of the ``penalty_tx``. In normal conditions it will be
|
|
zero, but if the transaction is already on the blockchain this won't be the case.
|
|
"""
|
|
|
|
tracker = TransactionTracker(locator, dispute_txid, penalty_txid, penalty_rawtx, appointment_end)
|
|
|
|
# We only store the penalty_txid, locator and appointment_end in memory. The rest is dumped into the db.
|
|
self.trackers[uuid] = {
|
|
"penalty_txid": tracker.penalty_txid,
|
|
"locator": locator,
|
|
"appointment_end": appointment_end,
|
|
}
|
|
|
|
if penalty_txid in self.tx_tracker_map:
|
|
self.tx_tracker_map[penalty_txid].append(uuid)
|
|
|
|
else:
|
|
self.tx_tracker_map[penalty_txid] = [uuid]
|
|
|
|
# In the case we receive two trackers with the same penalty txid we only add it to the unconfirmed txs list once
|
|
if penalty_txid not in self.unconfirmed_txs and confirmations == 0:
|
|
self.unconfirmed_txs.append(penalty_txid)
|
|
|
|
self.db_manager.store_responder_tracker(uuid, tracker.to_json())
|
|
|
|
logger.info(
|
|
"New tracker added", dispute_txid=dispute_txid, penalty_txid=penalty_txid, appointment_end=appointment_end
|
|
)
|
|
|
|
def do_watch(self):
|
|
"""
|
|
Monitors the blockchain whilst there are pending trackers.
|
|
|
|
This is the main method of the :obj:`Responder` and triggers tracker cleaning, rebroadcasting, reorg managing,
|
|
etc.
|
|
"""
|
|
|
|
# Distinguish fresh bootstraps from bootstraps from db
|
|
if self.last_known_block is None:
|
|
self.last_known_block = BlockProcessor.get_best_block_hash()
|
|
|
|
while True:
|
|
block_hash = self.block_queue.get()
|
|
block = BlockProcessor.get_block(block_hash)
|
|
logger.info("New block received", block_hash=block_hash, prev_block_hash=block.get("previousblockhash"))
|
|
|
|
if len(self.trackers) > 0 and block is not None:
|
|
txids = block.get("tx")
|
|
logger.info("List of transactions", txids=txids)
|
|
|
|
if self.last_known_block == block.get("previousblockhash"):
|
|
self.check_confirmations(txids)
|
|
|
|
height = block.get("height")
|
|
completed_trackers = self.get_completed_trackers(height)
|
|
Cleaner.delete_completed_trackers(
|
|
completed_trackers, height, self.trackers, self.tx_tracker_map, self.db_manager
|
|
)
|
|
|
|
txs_to_rebroadcast = self.get_txs_to_rebroadcast()
|
|
self.rebroadcast(txs_to_rebroadcast)
|
|
|
|
# NOTCOVERED
|
|
else:
|
|
logger.warning(
|
|
"Reorg found",
|
|
local_prev_block_hash=self.last_known_block,
|
|
remote_prev_block_hash=block.get("previousblockhash"),
|
|
)
|
|
|
|
# ToDo: #24-properly-handle-reorgs
|
|
self.handle_reorgs(block_hash)
|
|
|
|
# Clear the receipts issued in this block
|
|
self.carrier.issued_receipts = {}
|
|
|
|
if len(self.trackers) is 0:
|
|
logger.info("No more pending trackers")
|
|
|
|
# Register the last processed block for the responder
|
|
self.db_manager.store_last_block_hash_responder(block_hash)
|
|
self.last_known_block = block.get("hash")
|
|
self.block_queue.task_done()
|
|
|
|
def check_confirmations(self, txs):
|
|
"""
|
|
Checks if any of the monitored ``penalty_txs`` has received it's first confirmation or keeps missing them.
|
|
|
|
This method manages ``unconfirmed_txs`` and ``missed_confirmations``.
|
|
|
|
Args:
|
|
txs (:obj:`list`): A list of confirmed tx ids (the list of transactions included in the last received
|
|
block).
|
|
"""
|
|
|
|
# If a new confirmed tx matches a tx we are watching, then we remove it from the unconfirmed txs map
|
|
for tx in txs:
|
|
if tx in self.tx_tracker_map and tx in self.unconfirmed_txs:
|
|
self.unconfirmed_txs.remove(tx)
|
|
|
|
logger.info("Confirmation received for transaction", tx=tx)
|
|
|
|
# We also add a missing confirmation to all those txs waiting to be confirmed that have not been confirmed in
|
|
# the current block
|
|
for tx in self.unconfirmed_txs:
|
|
if tx in self.missed_confirmations:
|
|
self.missed_confirmations[tx] += 1
|
|
|
|
else:
|
|
self.missed_confirmations[tx] = 1
|
|
|
|
logger.info("Transaction missed a confirmation", tx=tx, missed_confirmations=self.missed_confirmations[tx])
|
|
|
|
def get_txs_to_rebroadcast(self):
|
|
"""
|
|
Gets the transactions to be rebroadcast based on their ``missed_confirmation`` count.
|
|
|
|
Returns:
|
|
:obj:`list`: A list with all the ids of the transaction that have to be rebroadcast.
|
|
"""
|
|
|
|
txs_to_rebroadcast = []
|
|
|
|
for tx, missed_conf in self.missed_confirmations.items():
|
|
if missed_conf >= CONFIRMATIONS_BEFORE_RETRY:
|
|
# If a transactions has missed too many confirmations we add it to the rebroadcast list
|
|
txs_to_rebroadcast.append(tx)
|
|
|
|
return txs_to_rebroadcast
|
|
|
|
def get_completed_trackers(self, height):
|
|
"""
|
|
Gets the trackers that has already been fulfilled based on a given height (``end_time`` was reached with a
|
|
minimum confirmation count).
|
|
|
|
Args:
|
|
height (:obj:`int`): the height of the last received block.
|
|
|
|
Returns:
|
|
:obj:`dict`: a dict (``uuid:confirmations``) of the completed trackers.
|
|
"""
|
|
|
|
completed_trackers = {}
|
|
checked_txs = {}
|
|
|
|
for uuid, tracker_data in self.trackers.items():
|
|
appointment_end = tracker_data.get("appointment_end")
|
|
penalty_txid = tracker_data.get("penalty_txid")
|
|
if appointment_end <= height and penalty_txid not in self.unconfirmed_txs:
|
|
|
|
if penalty_txid not in checked_txs:
|
|
tx = Carrier.get_transaction(penalty_txid)
|
|
else:
|
|
tx = checked_txs.get(penalty_txid)
|
|
|
|
if tx is not None:
|
|
confirmations = tx.get("confirmations")
|
|
checked_txs[penalty_txid] = tx
|
|
|
|
if confirmations is not None and confirmations >= MIN_CONFIRMATIONS:
|
|
# The end of the appointment has been reached
|
|
completed_trackers[uuid] = confirmations
|
|
|
|
return completed_trackers
|
|
|
|
def rebroadcast(self, txs_to_rebroadcast):
|
|
"""
|
|
Rebroadcasts a ``penalty_tx`` that has missed too many confirmations. In the current approach this would loop
|
|
forever si the transaction keeps not getting it.
|
|
|
|
Potentially the fees could be bumped here if the transaction has some tower dedicated outputs (or allows it
|
|
trough ``ANYONECANPAY`` or something similar).
|
|
|
|
Args:
|
|
txs_to_rebroadcast (:obj:`list`): a list of transactions to be rebroadcast.
|
|
|
|
Returns:
|
|
:obj:`list`: A list of :obj:`Receipts <pisa.carrier.Receipt>` with information about whether or not every
|
|
transaction made it trough the network.
|
|
"""
|
|
|
|
# DISCUSS: #22-discuss-confirmations-before-retry
|
|
# ToDo: #23-define-behaviour-approaching-end
|
|
|
|
receipts = []
|
|
|
|
for txid in txs_to_rebroadcast:
|
|
self.missed_confirmations[txid] = 0
|
|
|
|
# FIXME: This would potentially grab multiple instances of the same transaction and try to send them.
|
|
# should we do it only once?
|
|
for uuid in self.tx_tracker_map[txid]:
|
|
tracker = TransactionTracker.from_dict(self.db_manager.load_responder_tracker(uuid))
|
|
logger.warning(
|
|
"Transaction has missed many confirmations. Rebroadcasting", penalty_txid=tracker.penalty_txid
|
|
)
|
|
|
|
receipt = self.carrier.send_transaction(tracker.penalty_rawtx, tracker.penalty_txid)
|
|
receipts.append((txid, receipt))
|
|
|
|
if not receipt.delivered:
|
|
# FIXME: Can this actually happen?
|
|
logger.warning("Transaction failed", penalty_txid=tracker.penalty_txid)
|
|
|
|
return receipts
|
|
|
|
# NOTCOVERED
|
|
def handle_reorgs(self, block_hash):
|
|
"""
|
|
Basic reorg handle. It deals with situations where a reorg has been found but the ``dispute_tx`` is still
|
|
on the chain. If the ``dispute_tx`` is reverted, it need to call the :obj:`ReorgManager` (Soon TM).
|
|
|
|
Args:
|
|
block_hash (:obj:`str`): the hash of the last block received (which triggered the reorg).
|
|
|
|
"""
|
|
|
|
for uuid in self.trackers.keys():
|
|
tracker = TransactionTracker.from_dict(self.db_manager.load_responder_tracker(uuid))
|
|
|
|
# First we check if the dispute transaction is known (exists either in mempool or blockchain)
|
|
dispute_tx = self.carrier.get_transaction(tracker.dispute_txid)
|
|
|
|
if dispute_tx is not None:
|
|
# If the dispute is there, we check the penalty
|
|
penalty_tx = self.carrier.get_transaction(tracker.penalty_txid)
|
|
|
|
if penalty_tx is not None:
|
|
# If the penalty exists we need to check is it's on the blockchain or not so we can update the
|
|
# unconfirmed transactions list accordingly.
|
|
if penalty_tx.get("confirmations") is None:
|
|
self.unconfirmed_txs.append(tracker.penalty_txid)
|
|
|
|
logger.info(
|
|
"Penalty transaction back in mempool. Updating unconfirmed transactions",
|
|
penalty_txid=tracker.penalty_txid,
|
|
)
|
|
|
|
else:
|
|
# If the penalty transaction is missing, we need to reset the tracker.
|
|
self.handle_breach(
|
|
tracker.locator,
|
|
uuid,
|
|
tracker.dispute_txid,
|
|
tracker.penalty_txid,
|
|
tracker.penalty_rawtx,
|
|
tracker.appointment_end,
|
|
block_hash,
|
|
)
|
|
|
|
logger.warning(
|
|
"Penalty transaction banished. Resetting the tracker", penalty_tx=tracker.penalty_txid
|
|
)
|
|
|
|
else:
|
|
# ToDo: #24-properly-handle-reorgs
|
|
# FIXME: if the dispute is not on chain (either in mempool or not there at all), we need to call the
|
|
# reorg manager
|
|
logger.warning("Dispute and penalty transaction missing. Calling the reorg manager")
|
|
logger.error("Reorg manager not yet implemented")
|