jmwallet.history
jmwallet.history
Transaction history tracking for CoinJoin operations.
Stores a simple CSV log of all CoinJoin transactions with key metadata: - Role (maker/taker) - Fees (paid/received) - Peer count (only known by takers; None for makers) - Transaction details
Classes
TransactionHistoryEntry
A single CoinJoin transaction record.
Source code in jmwallet/src/jmwallet/history.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | |
Attributes
broadcast_method: str = ''
class-attribute
instance-attribute
change_address: str = ''
class-attribute
instance-attribute
cj_amount: int = 0
class-attribute
instance-attribute
completed_at: str = ''
class-attribute
instance-attribute
confirmations: int = 0
class-attribute
instance-attribute
confirmed_at: str = ''
class-attribute
instance-attribute
counterparty_nicks: str = ''
class-attribute
instance-attribute
destination_address: str = ''
class-attribute
instance-attribute
failure_reason: str = ''
class-attribute
instance-attribute
fee_received: int = 0
class-attribute
instance-attribute
mining_fee_paid: int = 0
class-attribute
instance-attribute
net_fee: int = 0
class-attribute
instance-attribute
network: str = 'mainnet'
class-attribute
instance-attribute
peer_count: int | None = None
class-attribute
instance-attribute
role: Literal['maker', 'taker'] = 'taker'
class-attribute
instance-attribute
source_mixdepth: int = 0
class-attribute
instance-attribute
success: bool = True
class-attribute
instance-attribute
timestamp: str
instance-attribute
total_maker_fees_paid: int = 0
class-attribute
instance-attribute
txfee_contribution: int = 0
class-attribute
instance-attribute
txid: str = ''
class-attribute
instance-attribute
utxos_used: str = ''
class-attribute
instance-attribute
Functions
append_history_entry(entry: TransactionHistoryEntry, data_dir: Path | None = None) -> None
Append a transaction history entry to the CSV file.
Args: entry: The transaction history entry to append data_dir: Optional data directory (defaults to get_default_data_dir())
Source code in jmwallet/src/jmwallet/history.py
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 | |
cleanup_stale_pending_transactions(max_age_minutes: int = 60, data_dir: Path | None = None) -> int
Mark all stale pending transactions as failed.
This is a cleanup function for entries that got stuck in pending state (e.g., from before the timeout feature was implemented, or due to bugs).
Args: max_age_minutes: Mark entries older than this as failed (default: 60) data_dir: Optional data directory
Returns: Number of entries marked as failed
Source code in jmwallet/src/jmwallet/history.py
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 | |
create_maker_history_entry(taker_nick: str, cj_amount: int, fee_received: int, txfee_contribution: int, cj_address: str, change_address: str, our_utxos: list[tuple[str, int]], txid: str | None = None, network: str = 'mainnet') -> TransactionHistoryEntry
Create a history entry for a maker CoinJoin (initially marked as pending).
The transaction is created with success=False and confirmations=0 to indicate it's pending confirmation. A background task should later update this entry once the transaction is confirmed on-chain.
Args: taker_nick: The taker's nick cj_amount: CoinJoin amount in sats fee_received: CoinJoin fee received txfee_contribution: Mining fee contribution cj_address: Our CoinJoin output address change_address: Our change output address our_utxos: List of (txid, vout) tuples for our inputs txid: Transaction ID (may not be known by maker) network: Network name
Returns: TransactionHistoryEntry ready to be appended (marked as pending)
Source code in jmwallet/src/jmwallet/history.py
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 | |
create_taker_history_entry(maker_nicks: list[str], cj_amount: int, total_maker_fees: int, mining_fee: int, destination: str, change_address: str, source_mixdepth: int, selected_utxos: list[tuple[str, int]], txid: str = '', broadcast_method: str = 'self', network: str = 'mainnet', success: bool = False, failure_reason: str = 'Awaiting transaction') -> TransactionHistoryEntry
Create a history entry for a taker CoinJoin.
This should be called BEFORE sending !tx to makers, to ensure addresses are recorded before they're revealed. Initially created with failure_reason="Awaiting transaction", then updated after broadcast.
The transaction is created with success=False and confirmations=0 by default to indicate it's pending confirmation. A background task should later update this entry once the transaction is confirmed on-chain.
Args: maker_nicks: List of maker nicks cj_amount: CoinJoin amount in sats total_maker_fees: Total maker fees paid mining_fee: Mining fee paid (may be 0 initially, updated after signing) destination: Destination address (CoinJoin output) change_address: Change output address (must be recorded for privacy!) source_mixdepth: Source mixdepth selected_utxos: List of (txid, vout) tuples for our inputs txid: Transaction ID (empty string if not yet known) broadcast_method: How the tx was/will be broadcast network: Network name success: Whether the CoinJoin succeeded (default False for pending) failure_reason: Reason for failure if any (default "Awaiting transaction")
Returns: TransactionHistoryEntry ready to be appended
Source code in jmwallet/src/jmwallet/history.py
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 | |
detect_coinjoin_peer_count(backend: BlockchainBackend | Any, txid: str, cj_amount: int) -> int | None
async
Detect the number of CoinJoin participants by counting equal-amount outputs.
When makers participate in a CoinJoin, they don't know the total number of participants. However, once the transaction confirms, we can analyze it to count outputs with the CoinJoin amount.
Args: backend: Blockchain backend to fetch transaction data txid: Transaction ID to analyze cj_amount: The CoinJoin amount in satoshis
Returns: Number of equal-amount outputs (peer count), or None if detection fails
Source code in jmwallet/src/jmwallet/history.py
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 | |
get_address_history_types(data_dir: Path | None = None) -> dict[str, str]
Get the history type for each address used in CoinJoin history.
This maps addresses to their role in CoinJoin transactions: - "cj_out": CoinJoin output address (destination) - from successful CJ - "change": Change address - from successful CJ - "flagged": Address was shared but ALL transactions using it failed
Priority: successful transactions take precedence over failed ones. Once an address is used in a successful CoinJoin, it remains cj_out/change even if later transactions using the same address failed.
Args: data_dir: Optional data directory (defaults to get_default_data_dir())
Returns: Dict mapping address -> type string
Source code in jmwallet/src/jmwallet/history.py
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 | |
get_history_stats(data_dir: Path | None = None) -> dict[str, int | float]
Get aggregate statistics from transaction history.
Returns: Dict with statistics (see _compute_stats for full list).
Source code in jmwallet/src/jmwallet/history.py
276 277 278 279 280 281 282 283 284 | |
get_history_stats_for_period(hours: float, role_filter: Literal['maker', 'taker'] | None = None, data_dir: Path | None = None) -> dict[str, int | float]
Get aggregate statistics for a specific time period.
Filters history entries to only include those within the last hours hours,
then computes the same aggregate statistics as get_history_stats().
This is used by the periodic summary notification to report daily/weekly stats.
Args: hours: Number of hours to look back (e.g., 24 for daily, 168 for weekly) role_filter: Optional filter by role ("maker" or "taker") data_dir: Optional data directory
Returns: Dict with statistics (see _compute_stats for full list).
Source code in jmwallet/src/jmwallet/history.py
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 | |
get_pending_transactions(data_dir: Path | None = None) -> list[TransactionHistoryEntry]
Get all pending (unconfirmed) transactions from history.
Returns entries that are: - Not yet confirmed (success=False, confirmations=0) - Not yet completed (completed_at is empty) - excludes failed transactions - Either have a txid waiting for confirmation, or no txid yet (needs discovery)
Returns: List of pending entries (includes entries without txid)
Source code in jmwallet/src/jmwallet/history.py
385 386 387 388 389 390 391 392 393 394 395 396 397 398 | |
get_used_addresses(data_dir: Path | None = None) -> set[str]
Get all addresses that have been used in CoinJoin history.
Returns both destination addresses (CoinJoin outputs) and change addresses from all history entries, regardless of success or confirmation status.
This is critical for privacy: once an address has been shared with peers (even if the transaction failed or wasn't confirmed), it should never be reused.
Args: data_dir: Optional data directory
Returns: Set of addresses that should not be reused
Source code in jmwallet/src/jmwallet/history.py
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 | |
get_utxo_label(address: str, data_dir: Path | None = None) -> str
Get a human-readable label for a UTXO based on its address history.
Labels are derived from CoinJoin history: - "cj-out": CoinJoin output (equal-amount output from successful CJ) - "cj-change": CoinJoin change output (change from successful CJ) - "deposit": External deposit (not from CoinJoin) - "flagged": Address was shared but transaction failed
Args: address: The address to get a label for data_dir: Optional data directory (defaults to get_default_data_dir())
Returns: Human-readable label for the UTXO
Source code in jmwallet/src/jmwallet/history.py
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 | |
mark_pending_transaction_failed(destination_address: str, failure_reason: str, data_dir: Path | None = None, txid: str | None = None) -> bool
Mark a pending transaction as failed by matching the destination address and optionally txid.
This is used when a pending CoinJoin times out - the taker never broadcast the transaction, so we mark it as failed rather than leaving it pending indefinitely.
Args: destination_address: The CoinJoin destination address to match failure_reason: Reason for marking as failed (e.g., "Timed out after 60 minutes") data_dir: Optional data directory txid: Optional transaction ID for more precise matching (when multiple entries share the same destination address)
Returns: True if a matching entry was found and updated, False otherwise
Source code in jmwallet/src/jmwallet/history.py
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 | |
read_history(data_dir: Path | None = None, limit: int | None = None, role_filter: Literal['maker', 'taker'] | None = None) -> list[TransactionHistoryEntry]
Read transaction history from the CSV file.
Args: data_dir: Optional data directory (defaults to get_default_data_dir()) limit: Maximum number of entries to return (most recent first) role_filter: Filter by role (maker/taker)
Returns: List of TransactionHistoryEntry objects
Source code in jmwallet/src/jmwallet/history.py
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 | |
update_all_pending_transactions(backend: BlockchainBackend | Any, data_dir: Path | None = None) -> int
async
Update the status of all pending transactions using the blockchain backend.
This function is called when displaying wallet info or history to ensure pending transactions are updated with their current confirmation status. Particularly important for one-shot coinjoin commands that exit before the background monitor can update the status.
Args: backend: Blockchain backend to query transaction status data_dir: Optional data directory
Returns: Number of transactions that were updated
Source code in jmwallet/src/jmwallet/history.py
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 | |
update_awaiting_transaction_signed(destination_address: str, txid: str, fee_received: int, txfee_contribution: int, data_dir: Path | None = None) -> bool
Update a pending "Awaiting transaction" entry when the maker signs the tx.
This is called after the maker successfully signs a transaction. The entry was created earlier (during !ioauth) with failure_reason="Awaiting transaction" to ensure the addresses were recorded before revealing them.
Args: destination_address: The CoinJoin destination address to match txid: The transaction ID fee_received: CoinJoin fee earned txfee_contribution: Mining fee contribution data_dir: Optional data directory
Returns: True if a matching entry was found and updated, False otherwise
Source code in jmwallet/src/jmwallet/history.py
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 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 | |
update_pending_transaction_txid(destination_address: str, txid: str, data_dir: Path | None = None) -> bool
Update a pending transaction's txid by matching the destination address.
This is used when a maker doesn't initially know the txid (didn't receive !push), but can discover it later by finding which transaction paid to the CoinJoin address.
Args: destination_address: The CoinJoin destination address to match txid: The discovered transaction ID data_dir: Optional data directory
Returns: True if a matching entry was found and updated, False otherwise
Source code in jmwallet/src/jmwallet/history.py
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 | |
update_taker_awaiting_transaction_broadcast(destination_address: str, change_address: str, txid: str, mining_fee: int, data_dir: Path | None = None) -> bool
Update a pending "Awaiting transaction" entry when the taker broadcasts the tx.
This is called after the taker successfully broadcasts a transaction. The entry was created earlier (before sending !tx) with failure_reason="Awaiting transaction" to ensure the addresses were recorded before revealing them.
Args: destination_address: The CoinJoin destination address to match change_address: The change address to match (for extra precision) txid: The transaction ID mining_fee: Actual mining fee paid (may differ from estimate) data_dir: Optional data directory
Returns: True if a matching entry was found and updated, False otherwise
Source code in jmwallet/src/jmwallet/history.py
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 | |
update_transaction_confirmation(txid: str, confirmations: int, data_dir: Path | None = None) -> bool
Update a transaction's confirmation status in the history file.
This function rewrites the entire CSV file with the updated entry. If confirmations > 0, marks the transaction as successful.
Note: This is the synchronous version. For makers who want automatic peer count detection, use update_transaction_confirmation_with_detection().
Args: txid: Transaction ID to update confirmations: Current number of confirmations data_dir: Optional data directory
Returns: True if transaction was found and updated, False otherwise
Source code in jmwallet/src/jmwallet/history.py
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 | |
update_transaction_confirmation_with_detection(txid: str, confirmations: int, backend: BlockchainBackend | Any | None = None, data_dir: Path | None = None) -> bool
async
Update transaction confirmation and detect peer count for makers.
This async version can detect the CoinJoin peer count by analyzing the transaction outputs when it confirms. This is useful for makers who don't know the peer count during the CoinJoin.
Args: txid: Transaction ID to update confirmations: Current number of confirmations backend: Blockchain backend for fetching transaction (optional, for peer detection) data_dir: Optional data directory
Returns: True if transaction was found and updated, False otherwise
Source code in jmwallet/src/jmwallet/history.py
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 | |
update_transaction_peer_count(txid: str, peer_count: int, data_dir: Path | None = None) -> bool
Update a transaction's peer count in the history file.
This is used for makers to update the peer count after detecting it from the confirmed transaction's equal-amount outputs.
Args: txid: Transaction ID to update peer_count: Detected peer count data_dir: Optional data directory
Returns: True if transaction was found and updated, False otherwise
Source code in jmwallet/src/jmwallet/history.py
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 | |