Skip to content

maker.maker_session

maker.maker_session

Per-taker CoinJoin orchestration session for a maker.

MakerSession is the per-taker_nick container that the maker bot creates when a !fill arrives and discards when a CoinJoin completes, fails, or times out. It owns:

  • an inner CoinJoinSession (the protocol state machine: amount, address selections, PoDLE state, encryption context, our_utxos, etc.)
  • an asyncio.Lock that serializes processing of duplicate messages that arrive via multiple directory servers / direct connections
  • the per-taker protocol logic for !auth, !tx, and signed-response encoding/encryption (relocated from ProtocolHandlersMixin so that the maker bot acts as a thin dispatcher)

Mirrors taker/src/taker/coinjoin_session.py on the taker side.

Classes

MakerSession

One CoinJoin session with a single taker.

Owns the per-taker protocol state machine (inner: CoinJoinSession) plus the per-taker lock that serializes duplicate-message processing. Per-taker handler logic (on_auth, on_tx, send_response) lives on the session itself; MakerBot only routes incoming messages.

Source code in maker/src/maker/maker_session.py
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
class MakerSession:
    """One CoinJoin session with a single taker.

    Owns the per-taker protocol state machine (`inner: CoinJoinSession`)
    plus the per-taker lock that serializes duplicate-message processing.
    Per-taker handler logic (`on_auth`, `on_tx`, `send_response`) lives on
    the session itself; `MakerBot` only routes incoming messages.
    """

    def __init__(self, inner: CoinJoinSession) -> None:
        self.inner = inner
        self.lock = asyncio.Lock()
        # This is deliberately independent of an event loop so sessions remain
        # safe to construct in synchronous tests and embedding contexts.
        self.deadline = time.monotonic() + inner.session_timeout_sec
        self.inner.deadline = self.deadline
        self.handler_task: asyncio.Task[None] | None = None
        self.expired = False
        self.detached = False
        self.cleanup_started = False
        self.detached_event = asyncio.Event()

    # -- Identity -----------------------------------------------------------

    @property
    def taker_nick(self) -> str:
        return self.inner.taker_nick

    @property
    def offer(self) -> Offer:
        return self.inner.offer

    # -- State machine -----------------------------------------------------

    @property
    def state(self) -> CoinJoinState:
        return self.inner.state

    @state.setter
    def state(self, value: CoinJoinState) -> None:
        self.inner.state = value

    @property
    def crypto(self) -> CryptoSession:
        return self.inner.crypto

    @property
    def commitment(self) -> bytes:
        return self.inner.commitment

    @property
    def commitment_authenticated(self) -> bool:
        return self.inner.commitment_authenticated

    @property
    def signing_boundary_crossed(self) -> bool:
        return self.inner.signing_boundary_crossed is True or self.inner.state in {
            CoinJoinState.SIG_SENT,
            CoinJoinState.COMPLETE,
        }

    @property
    def ioauth_boundary_crossed(self) -> bool:
        """Whether sending maker inputs and addresses may have disclosed them."""
        return self.inner.state in {
            CoinJoinState.IOAUTH_SEND_STARTED,
            CoinJoinState.IOAUTH_SENT,
            CoinJoinState.TX_RECEIVED,
            CoinJoinState.SIG_SENT,
            CoinJoinState.COMPLETE,
        }

    @property
    def amount(self) -> int:
        return self.inner.amount

    @property
    def our_utxos(self) -> dict[tuple[str, int], UTXOInfo]:
        return self.inner.our_utxos

    def release_input_locks(self) -> None:
        """Release the persisted CoinJoin locks on our committed inputs.

        Called on terminal *failure* paths so the inputs become selectable
        again promptly instead of waiting for the lock TTL to expire. On
        success the inputs are spent, so the lock is left to auto-expire after
        the broadcast propagates. Safe to call when nothing was reserved.
        """
        try:
            self.inner.wallet.release_coinjoin_inputs(
                set(self.our_utxos.keys()), owner=self.inner.input_lock_owner
            )
        except Exception as e:  # pragma: no cover - best-effort cleanup
            logger.debug(f"Failed to release input locks for {self.taker_nick}: {e}")

    def retain_input_locks(self) -> None:
        """Best-effort renewal once maker signatures may exist."""
        try:
            renewed = self.inner.wallet.renew_coinjoin_inputs(
                set(self.our_utxos),
                owner=self.inner.input_lock_owner,
                ttl=self.inner.input_lock_ttl_sec,
            )
        except Exception as exc:  # pragma: no cover - best-effort retention
            logger.error(f"Failed to retain signed input locks for {self.taker_nick}: {exc}")
            return
        if not renewed:
            logger.error(f"Signed input lock ownership was lost for {self.taker_nick}")

    @property
    def cj_address(self) -> str:
        return self.inner.cj_address

    @property
    def change_address(self) -> str:
        return self.inner.change_address

    @property
    def created_at(self) -> float:
        return self.inner.created_at

    @property
    def comm_channel(self) -> str:
        return self.inner.comm_channel

    @property
    def peer_neutrino_compat(self) -> bool:
        return self.inner.peer_neutrino_compat

    # -- Lifecycle helpers -------------------------------------------------

    def is_timed_out(self) -> bool:
        return time.monotonic() >= self.deadline

    def remaining_timeout(self) -> float:
        """Return the time left before the session's absolute deadline."""
        return max(0.0, self.deadline - time.monotonic())

    def is_active(self, bot: MakerBotProtocol) -> bool:
        """Return whether this exact session may still progress."""
        return not self.expired and bot.active_sessions.get(self.taker_nick) is self

    async def run_handler(
        self,
        bot: MakerBotProtocol,
        handler: Callable[[], Awaitable[None]],
    ) -> None:
        """Serialize and track one auth/tx handler for deadline cancellation."""
        async with self.lock:
            if not self.is_active(bot) or self.is_timed_out():
                return
            task = asyncio.current_task()
            if task is None:  # pragma: no cover - asyncio always supplies one here
                return
            self.handler_task = task
            try:
                await handler()
            finally:
                if self.handler_task is task:
                    self.handler_task = None

    def validate_channel(self, source: str) -> bool:
        return self.inner.validate_channel(source)

    # -- Protocol phase pass-throughs --------------------------------------

    async def handle_fill(
        self, amount: int, commitment: str, taker_pk: str
    ) -> tuple[bool, dict[str, Any]]:
        return await self.inner.handle_fill(amount, commitment, taker_pk)

    async def handle_auth(
        self,
        commitment: str,
        revelation: dict[str, Any],
        kphex: str,
        exclude_utxos: set[tuple[str, int]] | None = None,
        active_check: Callable[[], bool] | None = None,
    ) -> tuple[bool, dict[str, Any]]:
        return await self.inner.handle_auth(
            commitment,
            revelation,
            kphex,
            exclude_utxos=exclude_utxos,
            active_check=active_check,
        )

    async def handle_tx(
        self, tx_hex: str, active_check: Callable[[], bool] | None = None
    ) -> tuple[bool, dict[str, Any]]:
        return await self.inner.handle_tx(tx_hex, active_check=active_check)

    # -- Per-taker handler bodies (moved from ProtocolHandlersMixin) -------

    async def on_auth(self, bot: MakerBotProtocol, msg: str, source: str) -> None:
        """Process a decrypted !auth message and emit !ioauth or !error.

        Acquires no locks of its own; the dispatcher in
        `ProtocolHandlersMixin._handle_auth` holds `self.lock` for the
        duration of this call. Removes the session entry from
        `bot.active_sessions` on terminal failure paths.
        """
        taker_nick = self.taker_nick
        try:
            if not self.is_active(bot):
                return
            # Record the channel (always accepted; takers may switch
            # direct<->directory mid-session, see validate_channel).
            self.validate_channel(source)

            if self.state != CoinJoinState.PUBKEY_SENT:
                logger.debug(
                    f"Ignoring duplicate !auth from {taker_nick} "
                    f"(state={self.state}, expected=PUBKEY_SENT)"
                )
                return

            logger.info(f"Received !auth from {taker_nick}, decrypting and verifying PoDLE...")

            parts = msg.split()
            if len(parts) < 2:
                logger.error("Invalid !auth format: missing encrypted data")
                return

            encrypted_data = parts[1]

            if not self.crypto.is_encrypted:
                logger.error("Encryption not set up for this session")
                return

            try:
                decrypted = self.crypto.decrypt(encrypted_data)
                logger.debug(f"Decrypted auth message length: {len(decrypted)}")
            except Exception as e:
                logger.error(f"Failed to decrypt auth message: {e}")
                return

            try:
                revelation_parts = decrypted.split("|")
                if len(revelation_parts) != 5:
                    logger.error(
                        f"Invalid revelation format: expected 5 parts, got {len(revelation_parts)}"
                    )
                    return

                utxo_str, p_hex, p2_hex, sig_hex, e_hex = revelation_parts

                if ":" not in utxo_str:
                    logger.error(f"Invalid utxo format: {utxo_str}")
                    return

                if not utxo_str.rsplit(":", 1)[1].isdigit():
                    logger.error(f"Invalid vout in utxo: {utxo_str}")
                    return

                try:
                    UTXOMetadata.from_str(utxo_str)
                except (ValueError, ValidationError) as e:
                    logger.error(f"Invalid UTXO in PoDLE revelation: {e}")
                    return

                revelation: dict[str, Any] = {
                    "utxo": utxo_str,
                    "P": p_hex,
                    "P2": p2_hex,
                    "sig": sig_hex,
                    "e": e_hex,
                }
                logger.debug(f"Parsed revelation: utxo={utxo_str}, P={p_hex[:16]}...")
            except Exception as e:
                logger.error(f"Failed to parse revelation: {e}")
                return

            commitment = self.commitment.hex()
            kphex = ""

            # UTXO selection excludes inputs already committed to other
            # in-flight rounds via persisted, self-expiring locks (see
            # WalletService.reserve_coinjoin_inputs / CoinJoinSession.
            # _select_our_utxos), so the same input is never signed into two
            # concurrent CoinJoins.
            success, response = await self.handle_auth(
                commitment,
                revelation,
                kphex,
                active_check=lambda: self.is_active(bot),
            )
            if not self.is_active(bot):
                return

            if success:
                # CRITICAL: Record addresses to history BEFORE revealing them to taker
                # so they are never reused even if the taker vanishes or we crash.
                try:
                    our_utxos = list(self.our_utxos.keys())
                    our_input_addresses = [u.address for u in self.our_utxos.values()]
                    input_value = sum(u.value for u in self.our_utxos.values())
                    history_entry = create_maker_history_entry(
                        taker_nick=taker_nick,
                        cj_amount=self.amount,
                        fee_received=0,
                        txfee_contribution=0,
                        cj_address=self.cj_address,
                        change_address=self.change_address,
                        our_utxos=our_utxos,
                        txid=None,
                        network=bot.config.network.value,
                        wallet_fingerprint=bot.wallet.wallet_fingerprint,
                        source_addresses=our_input_addresses,
                        input_value=input_value,
                    )
                    history_entry.failure_reason = "Awaiting transaction"
                    append_history_entry(history_entry, data_dir=bot.config.data_dir)
                    logger.debug(
                        f"Recorded revealed addresses for {taker_nick} in history "
                        f"(cj={self.cj_address[:12]}..., "
                        f"change={self.change_address[:12]}...)"
                    )
                except Exception as e:
                    logger.error(
                        f"Refusing to reveal addresses because history persistence failed: {e}"
                    )
                    if bot.active_sessions.get(taker_nick) is self:
                        bot.active_sessions.pop(taker_nick)
                        self.release_input_locks()
                        bot._release_commitment_reservation(commitment)
                    return

                if not self.is_active(bot):
                    return
                sent = await self.send_response(bot, "ioauth", response)
                if not self.is_active(bot):
                    return
                if not sent:
                    return
                self.state = CoinJoinState.IOAUTH_SENT

                # Broadcast the commitment via hp2 so other makers can blacklist it.
                persisted = await bot._broadcast_commitment(commitment)
                if not self.is_active(bot):
                    return
                if persisted:
                    bot._release_commitment_reservation(commitment)
            else:
                error_msg = response.get("error", "unknown error")
                error_code = response.get("error_code", "")
                logger.error(f"Auth failed: {error_msg}")

                try:
                    for client in bot.directory_clients.values():
                        await client.send_private_message(taker_nick, "error", error_msg)
                        if not self.is_active(bot):
                            return
                    logger.debug(f"Sent !error to {taker_nick}: {error_msg}")
                except Exception as e:
                    logger.warning(f"Failed to send !error to {taker_nick}: {e}")

                # Release protocol resources before best-effort notification
                # work so notifier failures cannot extend the reservation.
                if bot.active_sessions.get(taker_nick) is self:
                    bot.active_sessions.pop(taker_nick)
                    self.release_input_locks()
                    bot._release_commitment_reservation(commitment)

                spawn_task(
                    get_notifier().notify_rejection(
                        taker_nick,
                        error_code or "PoDLE verification failed",
                        error_msg,
                    )
                )

        except Exception as e:
            logger.error(f"Failed to handle !auth: {e}")

    async def on_tx(self, bot: MakerBotProtocol, msg: str, source: str) -> None:
        """Process a decrypted !tx message and emit !sig signatures.

        Acquires no locks; the dispatcher holds `self.lock`. Removes the
        session entry from `bot.active_sessions` on terminal paths.
        """
        taker_nick = self.taker_nick
        try:
            if not self.is_active(bot):
                return
            # Record the channel (always accepted; takers may switch
            # direct<->directory mid-session, see validate_channel).
            self.validate_channel(source)

            if self.state != CoinJoinState.IOAUTH_SENT:
                logger.debug(
                    f"Ignoring duplicate !tx from {taker_nick} "
                    f"(state={self.state}, expected=IOAUTH_SENT)"
                )
                return

            logger.info(f"Received !tx from {taker_nick}, decrypting and verifying transaction...")

            parts = msg.split()
            if len(parts) < 2:
                logger.warning("Invalid !tx format")
                return

            encrypted_data = parts[1]

            if not self.crypto.is_encrypted:
                logger.error("Encryption not set up for this session")
                return

            try:
                decrypted = self.crypto.decrypt(encrypted_data)
                logger.debug(f"Decrypted tx message length: {len(decrypted)}")
            except Exception as e:
                logger.error(f"Failed to decrypt tx message: {e}")
                return

            try:
                tx_bytes = base64.b64decode(decrypted)
                tx_hex = tx_bytes.hex()
                logger.debug(f"Decoded transaction hex ({len(tx_bytes)} bytes): {tx_hex}")
            except Exception as e:
                logger.error(f"Failed to decode transaction: {e}")
                return

            success, response = await self.handle_tx(
                tx_hex, active_check=lambda: self.is_active(bot)
            )
            if not self.is_active(bot):
                return

            if success:
                signatures = response.get("signatures", [])
                txid = response.get("txid", "")
                destination_vout = response.get("destination_vout", -1)
                if not isinstance(destination_vout, int):
                    destination_vout = -1
                if not await bot._register_pending_signed_round(self, txid):
                    logger.error(
                        f"Cannot retain signed round for {taker_nick}; withholding signatures"
                    )
                    if bot.active_sessions.get(taker_nick) is self:
                        bot.active_sessions.pop(taker_nick)
                    self.retain_input_locks()
                    return
                for sig in signatures:
                    if not self.is_active(bot):
                        return
                    await self.send_response(bot, "sig", {"signature": sig})
                    if not self.is_active(bot):
                        return
                logger.info(f"CoinJoin with {taker_nick} COMPLETE (sent {len(signatures)} sigs)")

                fee_received = self.offer.calculate_fee(self.amount)
                txfee_contribution = self.offer.txfee

                try:
                    updated = update_awaiting_transaction_signed(
                        destination_address=self.cj_address,
                        txid=txid,
                        fee_received=fee_received,
                        txfee_contribution=txfee_contribution,
                        destination_vout=destination_vout,
                        data_dir=bot.config.data_dir,
                        wallet_fingerprint=bot.wallet.wallet_fingerprint,
                    )
                    net = fee_received - txfee_contribution
                    if updated:
                        logger.debug(f"Updated CoinJoin history with txid: net fee {net} sats")
                    else:
                        logger.warning(
                            "No 'Awaiting transaction' entry found, creating new history entry"
                        )
                        our_utxos = list(self.our_utxos.keys())
                        our_input_addresses = [u.address for u in self.our_utxos.values()]
                        input_value = sum(u.value for u in self.our_utxos.values())
                        history_entry = create_maker_history_entry(
                            taker_nick=taker_nick,
                            cj_amount=self.amount,
                            fee_received=fee_received,
                            txfee_contribution=txfee_contribution,
                            cj_address=self.cj_address,
                            change_address=self.change_address,
                            our_utxos=our_utxos,
                            txid=txid,
                            network=bot.config.network.value,
                            wallet_fingerprint=bot.wallet.wallet_fingerprint,
                            source_addresses=our_input_addresses,
                            input_value=input_value,
                            destination_vout=destination_vout,
                        )
                        append_history_entry(history_entry, data_dir=bot.config.data_dir)
                        logger.debug(f"Created new CoinJoin history: net fee {net} sats")
                except Exception as e:
                    logger.warning(f"Failed to update CoinJoin history: {e}")

                spawn_task(
                    get_notifier().notify_tx_signed(
                        taker_nick,
                        self.amount,
                        len(signatures),
                        fee_received,
                    )
                )

                if bot.active_sessions.get(taker_nick) is self:
                    self.state = CoinJoinState.COMPLETE
                    bot.active_sessions.pop(taker_nick)

                # Schedule wallet re-sync in background to avoid blocking !push handling
                spawn_task(bot._deferred_wallet_resync())
            else:
                logger.error(f"TX verification failed: {response.get('error')}")
                spawn_task(
                    get_notifier().notify_rejection(
                        taker_nick, "TX verification failed", response.get("error", "")
                    )
                )
                # Before signing starts, a failed transaction cannot conflict
                # with a later use of these inputs. Once signing starts, retain
                # the persisted locks through their TTL.
                if bot.active_sessions.get(taker_nick) is self:
                    bot.active_sessions.pop(taker_nick)
                    if self.signing_boundary_crossed:
                        self.retain_input_locks()
                    else:
                        self.release_input_locks()

        except Exception as e:
            logger.error(f"Failed to handle !tx: {e}")

    async def send_response(
        self, bot: MakerBotProtocol, command: str, data: dict[str, Any]
    ) -> bool:
        """Send a signed response (`!ioauth` or `!sig`) encrypted via this
        session's NaCl box, fanned out to all of the bot's directory clients.

        The `pubkey` response is sent unencrypted via
        :func:`MakerSession.send_pubkey_response` because it doesn't require
        an active session's `crypto` (the response IS the public key).
        """
        try:
            if not self.is_active(bot):
                return False
            if command == "ioauth":
                plaintext = " ".join(
                    [
                        data["utxo_list"],
                        data["auth_pub"],
                        data["cj_addr"],
                        data["change_addr"],
                        data["btc_sig"],
                    ]
                )
                msg_content = self.crypto.encrypt(plaintext)
                logger.debug(f"Encrypted ioauth message, plaintext_len={len(plaintext)}")
            elif command == "sig":
                plaintext = data["signature"]
                msg_content = self.crypto.encrypt(plaintext)
                logger.debug(f"Encrypted sig: plaintext_len={len(plaintext)}")
            else:
                msg_content = json.dumps(data)

            clients = list(bot.directory_clients.values())
            if not clients:
                logger.warning(f"No directory client available to send {command}")
                return False

            for index, client in enumerate(clients):
                if not self.is_active(bot):
                    return False
                if command == "ioauth" and index == 0:
                    if self.state != CoinJoinState.AUTH_RECEIVED:
                        logger.error(f"Cannot send !ioauth from state {self.state}")
                        return False
                    # From this point a transport error or cancellation cannot
                    # prove the encrypted maker details were not disclosed.
                    self.state = CoinJoinState.IOAUTH_SEND_STARTED
                await client.send_private_message(self.taker_nick, command, msg_content)
                if not self.is_active(bot):
                    return False

            logger.debug(f"Sent signed {command} to {self.taker_nick}")
            if command == "ioauth":
                self.state = CoinJoinState.IOAUTH_SENT
            return True

        except Exception as e:
            logger.error(f"Failed to send response: {e}")
            return False
Attributes
amount: int property
change_address: str property
cj_address: str property
cleanup_started = False instance-attribute
comm_channel: str property
commitment: bytes property
commitment_authenticated: bool property
created_at: float property
crypto: CryptoSession property
deadline = time.monotonic() + inner.session_timeout_sec instance-attribute
detached = False instance-attribute
detached_event = asyncio.Event() instance-attribute
expired = False instance-attribute
handler_task: asyncio.Task[None] | None = None instance-attribute
inner = inner instance-attribute
ioauth_boundary_crossed: bool property

Whether sending maker inputs and addresses may have disclosed them.

lock = asyncio.Lock() instance-attribute
offer: Offer property
our_utxos: dict[tuple[str, int], UTXOInfo] property
peer_neutrino_compat: bool property
signing_boundary_crossed: bool property
state: CoinJoinState property writable
taker_nick: str property
Methods:
__init__(inner: CoinJoinSession) -> None
Source code in maker/src/maker/maker_session.py
71
72
73
74
75
76
77
78
79
80
81
82
def __init__(self, inner: CoinJoinSession) -> None:
    self.inner = inner
    self.lock = asyncio.Lock()
    # This is deliberately independent of an event loop so sessions remain
    # safe to construct in synchronous tests and embedding contexts.
    self.deadline = time.monotonic() + inner.session_timeout_sec
    self.inner.deadline = self.deadline
    self.handler_task: asyncio.Task[None] | None = None
    self.expired = False
    self.detached = False
    self.cleanup_started = False
    self.detached_event = asyncio.Event()
handle_auth(commitment: str, revelation: dict[str, Any], kphex: str, exclude_utxos: set[tuple[str, int]] | None = None, active_check: Callable[[], bool] | None = None) -> tuple[bool, dict[str, Any]] async
Source code in maker/src/maker/maker_session.py
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
async def handle_auth(
    self,
    commitment: str,
    revelation: dict[str, Any],
    kphex: str,
    exclude_utxos: set[tuple[str, int]] | None = None,
    active_check: Callable[[], bool] | None = None,
) -> tuple[bool, dict[str, Any]]:
    return await self.inner.handle_auth(
        commitment,
        revelation,
        kphex,
        exclude_utxos=exclude_utxos,
        active_check=active_check,
    )
handle_fill(amount: int, commitment: str, taker_pk: str) -> tuple[bool, dict[str, Any]] async
Source code in maker/src/maker/maker_session.py
228
229
230
231
async def handle_fill(
    self, amount: int, commitment: str, taker_pk: str
) -> tuple[bool, dict[str, Any]]:
    return await self.inner.handle_fill(amount, commitment, taker_pk)
handle_tx(tx_hex: str, active_check: Callable[[], bool] | None = None) -> tuple[bool, dict[str, Any]] async
Source code in maker/src/maker/maker_session.py
249
250
251
252
async def handle_tx(
    self, tx_hex: str, active_check: Callable[[], bool] | None = None
) -> tuple[bool, dict[str, Any]]:
    return await self.inner.handle_tx(tx_hex, active_check=active_check)
is_active(bot: MakerBotProtocol) -> bool

Return whether this exact session may still progress.

Source code in maker/src/maker/maker_session.py
200
201
202
def is_active(self, bot: MakerBotProtocol) -> bool:
    """Return whether this exact session may still progress."""
    return not self.expired and bot.active_sessions.get(self.taker_nick) is self
is_timed_out() -> bool
Source code in maker/src/maker/maker_session.py
193
194
def is_timed_out(self) -> bool:
    return time.monotonic() >= self.deadline
on_auth(bot: MakerBotProtocol, msg: str, source: str) -> None async

Process a decrypted !auth message and emit !ioauth or !error.

Acquires no locks of its own; the dispatcher in ProtocolHandlersMixin._handle_auth holds self.lock for the duration of this call. Removes the session entry from bot.active_sessions on terminal failure paths.

Source code in maker/src/maker/maker_session.py
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
async def on_auth(self, bot: MakerBotProtocol, msg: str, source: str) -> None:
    """Process a decrypted !auth message and emit !ioauth or !error.

    Acquires no locks of its own; the dispatcher in
    `ProtocolHandlersMixin._handle_auth` holds `self.lock` for the
    duration of this call. Removes the session entry from
    `bot.active_sessions` on terminal failure paths.
    """
    taker_nick = self.taker_nick
    try:
        if not self.is_active(bot):
            return
        # Record the channel (always accepted; takers may switch
        # direct<->directory mid-session, see validate_channel).
        self.validate_channel(source)

        if self.state != CoinJoinState.PUBKEY_SENT:
            logger.debug(
                f"Ignoring duplicate !auth from {taker_nick} "
                f"(state={self.state}, expected=PUBKEY_SENT)"
            )
            return

        logger.info(f"Received !auth from {taker_nick}, decrypting and verifying PoDLE...")

        parts = msg.split()
        if len(parts) < 2:
            logger.error("Invalid !auth format: missing encrypted data")
            return

        encrypted_data = parts[1]

        if not self.crypto.is_encrypted:
            logger.error("Encryption not set up for this session")
            return

        try:
            decrypted = self.crypto.decrypt(encrypted_data)
            logger.debug(f"Decrypted auth message length: {len(decrypted)}")
        except Exception as e:
            logger.error(f"Failed to decrypt auth message: {e}")
            return

        try:
            revelation_parts = decrypted.split("|")
            if len(revelation_parts) != 5:
                logger.error(
                    f"Invalid revelation format: expected 5 parts, got {len(revelation_parts)}"
                )
                return

            utxo_str, p_hex, p2_hex, sig_hex, e_hex = revelation_parts

            if ":" not in utxo_str:
                logger.error(f"Invalid utxo format: {utxo_str}")
                return

            if not utxo_str.rsplit(":", 1)[1].isdigit():
                logger.error(f"Invalid vout in utxo: {utxo_str}")
                return

            try:
                UTXOMetadata.from_str(utxo_str)
            except (ValueError, ValidationError) as e:
                logger.error(f"Invalid UTXO in PoDLE revelation: {e}")
                return

            revelation: dict[str, Any] = {
                "utxo": utxo_str,
                "P": p_hex,
                "P2": p2_hex,
                "sig": sig_hex,
                "e": e_hex,
            }
            logger.debug(f"Parsed revelation: utxo={utxo_str}, P={p_hex[:16]}...")
        except Exception as e:
            logger.error(f"Failed to parse revelation: {e}")
            return

        commitment = self.commitment.hex()
        kphex = ""

        # UTXO selection excludes inputs already committed to other
        # in-flight rounds via persisted, self-expiring locks (see
        # WalletService.reserve_coinjoin_inputs / CoinJoinSession.
        # _select_our_utxos), so the same input is never signed into two
        # concurrent CoinJoins.
        success, response = await self.handle_auth(
            commitment,
            revelation,
            kphex,
            active_check=lambda: self.is_active(bot),
        )
        if not self.is_active(bot):
            return

        if success:
            # CRITICAL: Record addresses to history BEFORE revealing them to taker
            # so they are never reused even if the taker vanishes or we crash.
            try:
                our_utxos = list(self.our_utxos.keys())
                our_input_addresses = [u.address for u in self.our_utxos.values()]
                input_value = sum(u.value for u in self.our_utxos.values())
                history_entry = create_maker_history_entry(
                    taker_nick=taker_nick,
                    cj_amount=self.amount,
                    fee_received=0,
                    txfee_contribution=0,
                    cj_address=self.cj_address,
                    change_address=self.change_address,
                    our_utxos=our_utxos,
                    txid=None,
                    network=bot.config.network.value,
                    wallet_fingerprint=bot.wallet.wallet_fingerprint,
                    source_addresses=our_input_addresses,
                    input_value=input_value,
                )
                history_entry.failure_reason = "Awaiting transaction"
                append_history_entry(history_entry, data_dir=bot.config.data_dir)
                logger.debug(
                    f"Recorded revealed addresses for {taker_nick} in history "
                    f"(cj={self.cj_address[:12]}..., "
                    f"change={self.change_address[:12]}...)"
                )
            except Exception as e:
                logger.error(
                    f"Refusing to reveal addresses because history persistence failed: {e}"
                )
                if bot.active_sessions.get(taker_nick) is self:
                    bot.active_sessions.pop(taker_nick)
                    self.release_input_locks()
                    bot._release_commitment_reservation(commitment)
                return

            if not self.is_active(bot):
                return
            sent = await self.send_response(bot, "ioauth", response)
            if not self.is_active(bot):
                return
            if not sent:
                return
            self.state = CoinJoinState.IOAUTH_SENT

            # Broadcast the commitment via hp2 so other makers can blacklist it.
            persisted = await bot._broadcast_commitment(commitment)
            if not self.is_active(bot):
                return
            if persisted:
                bot._release_commitment_reservation(commitment)
        else:
            error_msg = response.get("error", "unknown error")
            error_code = response.get("error_code", "")
            logger.error(f"Auth failed: {error_msg}")

            try:
                for client in bot.directory_clients.values():
                    await client.send_private_message(taker_nick, "error", error_msg)
                    if not self.is_active(bot):
                        return
                logger.debug(f"Sent !error to {taker_nick}: {error_msg}")
            except Exception as e:
                logger.warning(f"Failed to send !error to {taker_nick}: {e}")

            # Release protocol resources before best-effort notification
            # work so notifier failures cannot extend the reservation.
            if bot.active_sessions.get(taker_nick) is self:
                bot.active_sessions.pop(taker_nick)
                self.release_input_locks()
                bot._release_commitment_reservation(commitment)

            spawn_task(
                get_notifier().notify_rejection(
                    taker_nick,
                    error_code or "PoDLE verification failed",
                    error_msg,
                )
            )

    except Exception as e:
        logger.error(f"Failed to handle !auth: {e}")
on_tx(bot: MakerBotProtocol, msg: str, source: str) -> None async

Process a decrypted !tx message and emit !sig signatures.

Acquires no locks; the dispatcher holds self.lock. Removes the session entry from bot.active_sessions on terminal paths.

Source code in maker/src/maker/maker_session.py
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
async def on_tx(self, bot: MakerBotProtocol, msg: str, source: str) -> None:
    """Process a decrypted !tx message and emit !sig signatures.

    Acquires no locks; the dispatcher holds `self.lock`. Removes the
    session entry from `bot.active_sessions` on terminal paths.
    """
    taker_nick = self.taker_nick
    try:
        if not self.is_active(bot):
            return
        # Record the channel (always accepted; takers may switch
        # direct<->directory mid-session, see validate_channel).
        self.validate_channel(source)

        if self.state != CoinJoinState.IOAUTH_SENT:
            logger.debug(
                f"Ignoring duplicate !tx from {taker_nick} "
                f"(state={self.state}, expected=IOAUTH_SENT)"
            )
            return

        logger.info(f"Received !tx from {taker_nick}, decrypting and verifying transaction...")

        parts = msg.split()
        if len(parts) < 2:
            logger.warning("Invalid !tx format")
            return

        encrypted_data = parts[1]

        if not self.crypto.is_encrypted:
            logger.error("Encryption not set up for this session")
            return

        try:
            decrypted = self.crypto.decrypt(encrypted_data)
            logger.debug(f"Decrypted tx message length: {len(decrypted)}")
        except Exception as e:
            logger.error(f"Failed to decrypt tx message: {e}")
            return

        try:
            tx_bytes = base64.b64decode(decrypted)
            tx_hex = tx_bytes.hex()
            logger.debug(f"Decoded transaction hex ({len(tx_bytes)} bytes): {tx_hex}")
        except Exception as e:
            logger.error(f"Failed to decode transaction: {e}")
            return

        success, response = await self.handle_tx(
            tx_hex, active_check=lambda: self.is_active(bot)
        )
        if not self.is_active(bot):
            return

        if success:
            signatures = response.get("signatures", [])
            txid = response.get("txid", "")
            destination_vout = response.get("destination_vout", -1)
            if not isinstance(destination_vout, int):
                destination_vout = -1
            if not await bot._register_pending_signed_round(self, txid):
                logger.error(
                    f"Cannot retain signed round for {taker_nick}; withholding signatures"
                )
                if bot.active_sessions.get(taker_nick) is self:
                    bot.active_sessions.pop(taker_nick)
                self.retain_input_locks()
                return
            for sig in signatures:
                if not self.is_active(bot):
                    return
                await self.send_response(bot, "sig", {"signature": sig})
                if not self.is_active(bot):
                    return
            logger.info(f"CoinJoin with {taker_nick} COMPLETE (sent {len(signatures)} sigs)")

            fee_received = self.offer.calculate_fee(self.amount)
            txfee_contribution = self.offer.txfee

            try:
                updated = update_awaiting_transaction_signed(
                    destination_address=self.cj_address,
                    txid=txid,
                    fee_received=fee_received,
                    txfee_contribution=txfee_contribution,
                    destination_vout=destination_vout,
                    data_dir=bot.config.data_dir,
                    wallet_fingerprint=bot.wallet.wallet_fingerprint,
                )
                net = fee_received - txfee_contribution
                if updated:
                    logger.debug(f"Updated CoinJoin history with txid: net fee {net} sats")
                else:
                    logger.warning(
                        "No 'Awaiting transaction' entry found, creating new history entry"
                    )
                    our_utxos = list(self.our_utxos.keys())
                    our_input_addresses = [u.address for u in self.our_utxos.values()]
                    input_value = sum(u.value for u in self.our_utxos.values())
                    history_entry = create_maker_history_entry(
                        taker_nick=taker_nick,
                        cj_amount=self.amount,
                        fee_received=fee_received,
                        txfee_contribution=txfee_contribution,
                        cj_address=self.cj_address,
                        change_address=self.change_address,
                        our_utxos=our_utxos,
                        txid=txid,
                        network=bot.config.network.value,
                        wallet_fingerprint=bot.wallet.wallet_fingerprint,
                        source_addresses=our_input_addresses,
                        input_value=input_value,
                        destination_vout=destination_vout,
                    )
                    append_history_entry(history_entry, data_dir=bot.config.data_dir)
                    logger.debug(f"Created new CoinJoin history: net fee {net} sats")
            except Exception as e:
                logger.warning(f"Failed to update CoinJoin history: {e}")

            spawn_task(
                get_notifier().notify_tx_signed(
                    taker_nick,
                    self.amount,
                    len(signatures),
                    fee_received,
                )
            )

            if bot.active_sessions.get(taker_nick) is self:
                self.state = CoinJoinState.COMPLETE
                bot.active_sessions.pop(taker_nick)

            # Schedule wallet re-sync in background to avoid blocking !push handling
            spawn_task(bot._deferred_wallet_resync())
        else:
            logger.error(f"TX verification failed: {response.get('error')}")
            spawn_task(
                get_notifier().notify_rejection(
                    taker_nick, "TX verification failed", response.get("error", "")
                )
            )
            # Before signing starts, a failed transaction cannot conflict
            # with a later use of these inputs. Once signing starts, retain
            # the persisted locks through their TTL.
            if bot.active_sessions.get(taker_nick) is self:
                bot.active_sessions.pop(taker_nick)
                if self.signing_boundary_crossed:
                    self.retain_input_locks()
                else:
                    self.release_input_locks()

    except Exception as e:
        logger.error(f"Failed to handle !tx: {e}")
release_input_locks() -> None

Release the persisted CoinJoin locks on our committed inputs.

Called on terminal failure paths so the inputs become selectable again promptly instead of waiting for the lock TTL to expire. On success the inputs are spent, so the lock is left to auto-expire after the broadcast propagates. Safe to call when nothing was reserved.

Source code in maker/src/maker/maker_session.py
142
143
144
145
146
147
148
149
150
151
152
153
154
155
def release_input_locks(self) -> None:
    """Release the persisted CoinJoin locks on our committed inputs.

    Called on terminal *failure* paths so the inputs become selectable
    again promptly instead of waiting for the lock TTL to expire. On
    success the inputs are spent, so the lock is left to auto-expire after
    the broadcast propagates. Safe to call when nothing was reserved.
    """
    try:
        self.inner.wallet.release_coinjoin_inputs(
            set(self.our_utxos.keys()), owner=self.inner.input_lock_owner
        )
    except Exception as e:  # pragma: no cover - best-effort cleanup
        logger.debug(f"Failed to release input locks for {self.taker_nick}: {e}")
remaining_timeout() -> float

Return the time left before the session's absolute deadline.

Source code in maker/src/maker/maker_session.py
196
197
198
def remaining_timeout(self) -> float:
    """Return the time left before the session's absolute deadline."""
    return max(0.0, self.deadline - time.monotonic())
retain_input_locks() -> None

Best-effort renewal once maker signatures may exist.

Source code in maker/src/maker/maker_session.py
157
158
159
160
161
162
163
164
165
166
167
168
169
def retain_input_locks(self) -> None:
    """Best-effort renewal once maker signatures may exist."""
    try:
        renewed = self.inner.wallet.renew_coinjoin_inputs(
            set(self.our_utxos),
            owner=self.inner.input_lock_owner,
            ttl=self.inner.input_lock_ttl_sec,
        )
    except Exception as exc:  # pragma: no cover - best-effort retention
        logger.error(f"Failed to retain signed input locks for {self.taker_nick}: {exc}")
        return
    if not renewed:
        logger.error(f"Signed input lock ownership was lost for {self.taker_nick}")
run_handler(bot: MakerBotProtocol, handler: Callable[[], Awaitable[None]]) -> None async

Serialize and track one auth/tx handler for deadline cancellation.

Source code in maker/src/maker/maker_session.py
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
async def run_handler(
    self,
    bot: MakerBotProtocol,
    handler: Callable[[], Awaitable[None]],
) -> None:
    """Serialize and track one auth/tx handler for deadline cancellation."""
    async with self.lock:
        if not self.is_active(bot) or self.is_timed_out():
            return
        task = asyncio.current_task()
        if task is None:  # pragma: no cover - asyncio always supplies one here
            return
        self.handler_task = task
        try:
            await handler()
        finally:
            if self.handler_task is task:
                self.handler_task = None
send_response(bot: MakerBotProtocol, command: str, data: dict[str, Any]) -> bool async

Send a signed response (!ioauth or !sig) encrypted via this session's NaCl box, fanned out to all of the bot's directory clients.

The pubkey response is sent unencrypted via :func:MakerSession.send_pubkey_response because it doesn't require an active session's crypto (the response IS the public key).

Source code in maker/src/maker/maker_session.py
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
async def send_response(
    self, bot: MakerBotProtocol, command: str, data: dict[str, Any]
) -> bool:
    """Send a signed response (`!ioauth` or `!sig`) encrypted via this
    session's NaCl box, fanned out to all of the bot's directory clients.

    The `pubkey` response is sent unencrypted via
    :func:`MakerSession.send_pubkey_response` because it doesn't require
    an active session's `crypto` (the response IS the public key).
    """
    try:
        if not self.is_active(bot):
            return False
        if command == "ioauth":
            plaintext = " ".join(
                [
                    data["utxo_list"],
                    data["auth_pub"],
                    data["cj_addr"],
                    data["change_addr"],
                    data["btc_sig"],
                ]
            )
            msg_content = self.crypto.encrypt(plaintext)
            logger.debug(f"Encrypted ioauth message, plaintext_len={len(plaintext)}")
        elif command == "sig":
            plaintext = data["signature"]
            msg_content = self.crypto.encrypt(plaintext)
            logger.debug(f"Encrypted sig: plaintext_len={len(plaintext)}")
        else:
            msg_content = json.dumps(data)

        clients = list(bot.directory_clients.values())
        if not clients:
            logger.warning(f"No directory client available to send {command}")
            return False

        for index, client in enumerate(clients):
            if not self.is_active(bot):
                return False
            if command == "ioauth" and index == 0:
                if self.state != CoinJoinState.AUTH_RECEIVED:
                    logger.error(f"Cannot send !ioauth from state {self.state}")
                    return False
                # From this point a transport error or cancellation cannot
                # prove the encrypted maker details were not disclosed.
                self.state = CoinJoinState.IOAUTH_SEND_STARTED
            await client.send_private_message(self.taker_nick, command, msg_content)
            if not self.is_active(bot):
                return False

        logger.debug(f"Sent signed {command} to {self.taker_nick}")
        if command == "ioauth":
            self.state = CoinJoinState.IOAUTH_SENT
        return True

    except Exception as e:
        logger.error(f"Failed to send response: {e}")
        return False
validate_channel(source: str) -> bool
Source code in maker/src/maker/maker_session.py
223
224
def validate_channel(self, source: str) -> bool:
    return self.inner.validate_channel(source)

PendingSignedRound dataclass

Minimal post-sign state required to authenticate a later !push.

Source code in maker/src/maker/maker_session.py
50
51
52
53
54
55
56
57
58
59
@dataclass(frozen=True, slots=True)
class PendingSignedRound:
    """Minimal post-sign state required to authenticate a later ``!push``."""

    taker_nick: str
    txid: str
    input_lock_owner: str
    outpoints: frozenset[tuple[str, int]]
    expires_at: float
    lock_ttl_sec: float
Attributes
expires_at: float instance-attribute
input_lock_owner: str instance-attribute
lock_ttl_sec: float instance-attribute
outpoints: frozenset[tuple[str, int]] instance-attribute
taker_nick: str instance-attribute
txid: str instance-attribute

Functions: