Persist the payout before broadcasting it (B-25)
_trigger_payout used to broadcast the payout transaction and only afterwards write payout_txid and its PendingTransaction. A crash in that window (docker-compose.yml auto-restarts on crash) left a payout on-chain with zero record: the round stuck in paying_out, nothing for the reconciler to resolve, and a manual retry that would have paid the winner a second time. This mirrors B-08, which already fixed the same gap for place_bet/request_withdrawal. _trigger_payout now has four phases: read, build (network read only, no write), persist the intent as a PendingTransaction(kind="payout", status="building") and commit, then broadcast and promote to "pending". A rejected broadcast now leaves that "building" row for tx/reconcile.py to resolve — its existing building/pending handling already covers a payout kind correctly, including clearing payout_txid on abandonment, so reconcile.py needed no changes. Since pool UTXOs aren't tracked in utxo_events and so can never be reserved/released the way a user's own UTXOs are, two guards go along with the two-phase write: _trigger_payout now refuses to build a second payout for a round that already has a non-terminal PendingTransaction, and the payout builder excludes any UTXO already referenced by any non-terminal payout transaction (_reserved_payout_outpoints) so a stale payout from an earlier round the reconciler hasn't abandoned yet can't be double-spent by a fresh attempt. This makes a payout retry safe; making one happen automatically is B-26, still open. BUGS.md moves B-25 to "Previously fixed" with the fix description; the suite grows from 139 to 143 tests. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
43d2321e0f
commit
f13f6850b7
3 files changed
+342
-57
No files matched your search
+96
-22
@@ -3,8 +3,9 @@ import logging
|
||||
from datetime import datetime, timedelta, timezone
|
||||
|
||||
from embit import script
|
||||
from embit.transaction import Transaction
|
||||
from sqlalchemy import func, select
|
||||
from sqlalchemy.ext.asyncio import async_sessionmaker
|
||||
from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker
|
||||
|
||||
from app.audit.log import write_audit_log
|
||||
from app.db.models import PendingTransaction, Round, RoundParticipant, User
|
||||
@@ -161,8 +162,18 @@ class RoundScheduler:
|
||||
return self._listener.tip_height, header_hex_to_block_hash(self._listener.tip_header_hex)
|
||||
|
||||
async def _trigger_payout(self, round_id: int) -> None:
|
||||
"""Three phases, so no DB session is held across a network call (B-18): read
|
||||
what's needed, do the chain work, then persist the outcome."""
|
||||
"""Four phases, so no DB session is held across a network call (B-18): read
|
||||
what's needed, build the tx, persist the intent, then broadcast.
|
||||
|
||||
The persist happens *before* the broadcast (B-25) — the same two-phase shape
|
||||
as place_bet/request_withdrawal (B-08): a crash between building the payout
|
||||
and recording it used to leave money on-chain with zero trace in the DB (no
|
||||
payout_txid, no PendingTransaction), so a manual retry would have paid the
|
||||
winner a second time. Now the worst case is a "building" PendingTransaction
|
||||
the reconciler (app/tx/reconcile.py) can resolve either way by asking the
|
||||
chain whether the tx exists, exactly like it already does for bets and
|
||||
withdrawals.
|
||||
"""
|
||||
client = self._listener.client
|
||||
if client is None:
|
||||
logger.error("round %s payout deferred: not connected", round_id)
|
||||
@@ -171,6 +182,25 @@ class RoundScheduler:
|
||||
# --- Phase 1: read (session closed before any network I/O) ---------------
|
||||
async with self._session_factory() as session:
|
||||
round_ = await session.get(Round, round_id)
|
||||
already_in_flight = await session.scalar(
|
||||
select(PendingTransaction).where(
|
||||
PendingTransaction.round_id == round_id,
|
||||
PendingTransaction.kind == "payout",
|
||||
PendingTransaction.status.in_(("building", "pending")),
|
||||
)
|
||||
)
|
||||
if already_in_flight is not None:
|
||||
# A payout for this round is already building or broadcast — this
|
||||
# must not build a second one, or a retry (manual, or a future
|
||||
# automatic one) would pay the winner twice. Confirmation/
|
||||
# reconciliation already owns resolving that row.
|
||||
logger.info(
|
||||
"round %s payout already in flight (pending_transaction %s), skipping",
|
||||
round_id,
|
||||
already_in_flight.id,
|
||||
)
|
||||
return
|
||||
reserved_outpoints = await _reserved_payout_outpoints(session)
|
||||
config = await get_round_config(session)
|
||||
fee_address = config.fee_address
|
||||
fee_rate = config.fee_rate_sat_vb
|
||||
@@ -192,13 +222,17 @@ class RoundScheduler:
|
||||
winner_share = pool_amount_sats * 70 // 100
|
||||
commission_share = pool_amount_sats - winner_share # remainder from rounding goes to fees
|
||||
|
||||
# --- Phase 2: build and broadcast ----------------------------------------
|
||||
# --- Phase 2: build (network read only, no DB write yet) -----------------
|
||||
try:
|
||||
pool_key = derive_pool_key()
|
||||
pool_script_obj = script.p2wpkh(pool_key.to_public())
|
||||
pool_address = pool_script_obj.address(network=PLM_MAINNET)
|
||||
entries = await client.listunspent(address_to_scripthash(pool_address))
|
||||
utxos = [Utxo(e["tx_hash"], e["tx_pos"], e["value"]) for e in entries if e["height"] > 0]
|
||||
utxos = [
|
||||
Utxo(e["tx_hash"], e["tx_pos"], e["value"])
|
||||
for e in entries
|
||||
if e["height"] > 0 and (e["tx_hash"], e["tx_pos"]) not in reserved_outpoints
|
||||
]
|
||||
|
||||
built = build_payout_transaction(
|
||||
signing_key=pool_key,
|
||||
@@ -211,36 +245,54 @@ class RoundScheduler:
|
||||
change_address=pool_address,
|
||||
fee_rate_sat_vb=fee_rate,
|
||||
)
|
||||
await client.broadcast(built.raw_hex)
|
||||
except InsufficientFundsError:
|
||||
logger.exception("round %s payout failed: insufficient pool UTXOs", round_id)
|
||||
return
|
||||
except Exception:
|
||||
# Anything else — a malformed fee_address (EmbitError), a rejected
|
||||
# broadcast, a dead connection. This used to escape all the way to
|
||||
# run()'s catch-all, which logged it without recording anything, leaving
|
||||
# no trace of *why* the round was stuck (B-05). The round stays in
|
||||
# "paying_out" either way: automatic payout retry is still an open gap.
|
||||
logger.exception("round %s payout failed", round_id)
|
||||
# Anything else — a malformed fee_address (EmbitError) or similar. This
|
||||
# used to escape all the way to run()'s catch-all, which logged it
|
||||
# without recording anything, leaving no trace of *why* the round was
|
||||
# stuck (B-05). The round stays in "paying_out" either way: automatic
|
||||
# payout retry is still an open gap.
|
||||
logger.exception("round %s payout build failed", round_id)
|
||||
await self._log_payout_failure(round_id, winner_user_id)
|
||||
return
|
||||
|
||||
# --- Phase 3: persist -----------------------------------------------------
|
||||
# --- Phase 3: persist the intent, *then* broadcast (B-25) -----------------
|
||||
async with self._session_factory() as session:
|
||||
round_ = await session.get(Round, round_id)
|
||||
round_.winner_amount_sats = built.winner_sats
|
||||
round_.fee_amount_sats = built.commission_sats
|
||||
round_.payout_txid = built.txid
|
||||
session.add(
|
||||
PendingTransaction(
|
||||
kind="payout",
|
||||
round_id=round_id,
|
||||
current_txid=built.txid,
|
||||
fee_rate_sat_vb=fee_rate,
|
||||
raw_tx_hex=built.raw_hex,
|
||||
status="pending",
|
||||
)
|
||||
pending = PendingTransaction(
|
||||
kind="payout",
|
||||
round_id=round_id,
|
||||
current_txid=built.txid,
|
||||
fee_rate_sat_vb=fee_rate,
|
||||
raw_tx_hex=built.raw_hex,
|
||||
# "building" until the broadcast succeeds, exactly like place_bet's
|
||||
# two phases — see the reconciler, which gives this a short grace
|
||||
# period before asking the chain whether it made it out after all.
|
||||
status="building",
|
||||
)
|
||||
session.add(pending)
|
||||
await session.commit()
|
||||
pending_id = pending.id
|
||||
|
||||
# --- Phase 4: broadcast, then promote the pending row --------------------
|
||||
try:
|
||||
await client.broadcast(built.raw_hex)
|
||||
except Exception:
|
||||
# The row stays "building": the reconciler will ask the chain about it
|
||||
# and, finding nothing, abandon it and clear payout_txid (B-25) — instead
|
||||
# of the round being stuck with a payout_txid that never went anywhere.
|
||||
logger.exception("round %s payout broadcast failed", round_id)
|
||||
await self._log_payout_failure(round_id, winner_user_id)
|
||||
return
|
||||
|
||||
async with self._session_factory() as session:
|
||||
pending = await session.get(PendingTransaction, pending_id)
|
||||
pending.status = "pending"
|
||||
await write_audit_log(
|
||||
session,
|
||||
"payout_sent",
|
||||
@@ -267,3 +319,25 @@ class RoundScheduler:
|
||||
await session.commit()
|
||||
except Exception:
|
||||
logger.exception("could not record the payout failure of round %s", round_id)
|
||||
|
||||
|
||||
async def _reserved_payout_outpoints(session: AsyncSession) -> set[tuple[str, int]]:
|
||||
"""Pool UTXOs already claimed by a payout that hasn't resolved yet — this
|
||||
round's own in-flight payout (guarded against separately in _trigger_payout) or
|
||||
a stale one from an earlier round the reconciler hasn't abandoned yet (B-25).
|
||||
These must be excluded from selection, or a retry would double-spend the same
|
||||
coins into two payouts before the reconciler gets a chance to release them."""
|
||||
rows = (
|
||||
await session.scalars(
|
||||
select(PendingTransaction).where(
|
||||
PendingTransaction.kind == "payout",
|
||||
PendingTransaction.status.in_(("building", "pending")),
|
||||
)
|
||||
)
|
||||
).all()
|
||||
reserved: set[tuple[str, int]] = set()
|
||||
for row in rows:
|
||||
tx = Transaction.parse(bytes.fromhex(row.raw_tx_hex))
|
||||
for vin in tx.vin:
|
||||
reserved.add((vin.txid.hex(), vin.vout))
|
||||
return reserved
|
||||
Reference in new issue
Block a user