57
58
59
60
61
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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
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
738
739
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
811
812
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
876
877
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
947
948
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
976
977
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
1022
1023
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
1054
1055
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
1106
1107
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
1157
1158
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
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702 | class WalletSyncMixin:
"""Mixin providing wallet synchronization capabilities.
Expects the host class to provide the attributes and methods defined
on ``WalletService`` (backend, address_cache, utxo_cache, etc.).
"""
# Declared for mypy -- actually set by the host class __init__
backend: BlockchainBackend
master_key: HDKey
root_path: str
network: str
mixdepth_count: int
gap_limit: int
scan_range: int
data_dir: Path | None
wallet_fingerprint: str
address_cache: dict[str, tuple[int, int, int]]
utxo_cache: dict[int, list[UTXOInfo]]
addresses_with_history: set[str]
metadata_store: Any # UTXOMetadataStore | None (deferred import)
fidelity_bond_locktime_cache: dict[str, int]
# Methods provided by the host class
def get_address(self, mixdepth: int, change: int, index: int) -> str:
raise NotImplementedError
def get_account_xpub(self, mixdepth: int) -> str:
raise NotImplementedError
def get_fidelity_bond_address(self, index: int, locktime: int) -> str:
raise NotImplementedError
def _apply_frozen_state(self) -> None:
raise NotImplementedError
# -- Persistent address-history tracking --------------------------------
def _record_history_address(self, address: str, origin: str | None = None) -> None:
"""Mark ``address`` as having on-chain history (current or spent).
Updates both the in-memory ``addresses_with_history`` set and the
persistent BIP-329 metadata store (when configured). This is the
single entry point used by every sync path; calling ``set.add()``
directly would skip persistence and reintroduce the deposit-address
reuse bug after the funded UTXO is spent.
"""
if not address:
return
already_in_memory = address in self.addresses_with_history
self.addresses_with_history.add(address)
store = getattr(self, "metadata_store", None)
if store is None or already_in_memory:
return
try:
store.mark_address_used(address, origin)
except Exception as exc: # pragma: no cover - defensive
logger.warning(f"Could not persist used address {address[:12]}...: {exc}")
def _record_history_addresses(
self, addresses: Iterable[str], origin: str | None = None
) -> None:
"""Batched variant of :meth:`_record_history_address` for hot loops."""
new_addresses: list[str] = []
for address in addresses:
if address and address not in self.addresses_with_history:
self.addresses_with_history.add(address)
new_addresses.append(address)
if not new_addresses:
return
store = getattr(self, "metadata_store", None)
if store is None:
return
try:
store.mark_addresses_used(new_addresses, origin)
except Exception as exc: # pragma: no cover - defensive
logger.warning(f"Could not persist {len(new_addresses)} used addresses: {exc}")
# -- Address-by-address sync (Groups B+C) --------------------------------
async def sync_mixdepth(self, mixdepth: int) -> list[UTXOInfo]:
"""
Sync a mixdepth with the blockchain.
Scans addresses up to gap limit.
"""
utxos: list[UTXOInfo] = []
for change in [0, 1]:
consecutive_empty = 0
index = 0
while consecutive_empty < self.gap_limit:
# Scan in batches of gap_limit size for performance
batch_size = self.gap_limit
addresses = []
for i in range(batch_size):
address = self.get_address(mixdepth, change, index + i)
addresses.append(address)
# Fetch UTXOs for the whole batch
backend_utxos = await self.backend.get_utxos(addresses)
# Group results by address
utxos_by_address: dict[str, list] = {addr: [] for addr in addresses}
for utxo in backend_utxos:
if utxo.address in utxos_by_address:
utxos_by_address[utxo.address].append(utxo)
# Process batch results in order
for i, address in enumerate(addresses):
addr_utxos = utxos_by_address[address]
if addr_utxos:
consecutive_empty = 0
# Track that this address has had UTXOs
self._record_history_address(address)
for utxo in addr_utxos:
path = f"{self.root_path}/{mixdepth}'/{change}/{index + i}"
utxos.append(
_make_utxo_info(
txid=utxo.txid,
vout=utxo.vout,
value=utxo.value,
address=address,
confirmations=utxo.confirmations,
scriptpubkey=utxo.scriptpubkey,
path=path,
mixdepth=mixdepth,
height=utxo.height,
)
)
else:
consecutive_empty += 1
if consecutive_empty >= self.gap_limit:
break
index += batch_size
logger.debug(
f"Synced mixdepth {mixdepth} change {change}: "
f"scanned ~{index} addresses, found "
f"{len([u for u in utxos if u.path.split('/')[-2] == str(change)])} UTXOs"
)
self.utxo_cache[mixdepth] = utxos
return utxos
async def sync_fidelity_bonds(self, locktimes: list[int]) -> list[UTXOInfo]:
"""
Sync fidelity bond UTXOs with specific locktimes.
Fidelity bonds use mixdepth 0, branch 2, with path format:
m/84'/coin'/0'/2/timenumber:locktime
Each locktime maps to exactly one timenumber (BIP32 child index).
Args:
locktimes: List of Unix timestamps to scan for
Returns:
List of fidelity bond UTXOs found
"""
from jmcore.timenumber import timestamp_to_timenumber
utxos: list[UTXOInfo] = []
if not locktimes:
logger.debug("No locktimes provided for fidelity bond sync")
return utxos
# Each locktime has exactly one address (timenumber = BIP32 child index)
addresses: list[str] = []
address_to_info: dict[str, tuple[int, int]] = {} # addr -> (locktime, timenumber)
for locktime in locktimes:
timenumber = timestamp_to_timenumber(locktime)
address = self.get_fidelity_bond_address(timenumber, locktime)
addresses.append(address)
address_to_info[address] = (locktime, timenumber)
# Fetch UTXOs for all addresses at once
backend_utxos = await self.backend.get_utxos(addresses)
# Group by address
utxos_by_address: dict[str, list] = {addr: [] for addr in addresses}
for utxo in backend_utxos:
if utxo.address in utxos_by_address:
utxos_by_address[utxo.address].append(utxo)
# Process results
for address in addresses:
addr_utxos = utxos_by_address[address]
if addr_utxos:
locktime, timenumber = address_to_info[address]
self._record_history_address(address)
for utxo in addr_utxos:
path = f"{self.root_path}/0'/{FIDELITY_BOND_BRANCH}/{timenumber}:{locktime}"
utxo_info = _make_utxo_info(
txid=utxo.txid,
vout=utxo.vout,
value=utxo.value,
address=address,
confirmations=utxo.confirmations,
scriptpubkey=utxo.scriptpubkey,
path=path,
mixdepth=0, # Fidelity bonds always in mixdepth 0
height=utxo.height,
locktime=locktime, # Store locktime for P2WSH signing
)
utxos.append(utxo_info)
logger.info(
f"Found fidelity bond UTXO: {utxo.txid}:{utxo.vout} "
f"value={utxo.value} locktime={locktime}"
)
# Add fidelity bond UTXOs to mixdepth 0 cache
if utxos:
if 0 not in self.utxo_cache:
self.utxo_cache[0] = []
existing_outpoints = {(u.txid, u.vout) for u in self.utxo_cache[0]}
for utxo_info in utxos:
outpoint = (utxo_info.txid, utxo_info.vout)
if outpoint not in existing_outpoints:
self.utxo_cache[0].append(utxo_info)
existing_outpoints.add(outpoint)
logger.info(f"Found {len(utxos)} fidelity bond UTXOs")
return utxos
async def discover_fidelity_bonds(
self,
progress_callback: Any | None = None,
rescan_progress_callback: Any | None = None,
) -> list[UTXOInfo]:
"""
Discover fidelity bonds by scanning all 960 possible locktimes.
This is used during wallet recovery when the user doesn't know which
locktimes they used. It generates addresses for all valid timenumbers
(0-959, representing Jan 2020 through Dec 2099) and scans for UTXOs.
For descriptor_wallet backend, this method will import addresses into
the wallet as it scans in batches, then clean up addresses that had no UTXOs.
Each timenumber maps to exactly one BIP32 child index and one locktime,
matching the reference JoinMarket implementation.
Args:
progress_callback: Optional callback(current, total) for progress updates
rescan_progress_callback: Optional callback(progress) with 0.0-1.0 for rescan
Returns:
List of discovered fidelity bond UTXOs
"""
from jmcore.timenumber import TIMENUMBER_COUNT, timenumber_to_timestamp
logger.info(f"Starting fidelity bond discovery scan ({TIMENUMBER_COUNT} timelocks)")
discovered_utxos: list[UTXOInfo] = []
batch_size = 100 # Process timenumbers in batches
descriptor_backend: DescriptorWalletBackend | None = (
self.backend if isinstance(self.backend, DescriptorWalletBackend) else None
)
# Build the full address map across all timenumbers.
# Each timenumber has exactly one address (timenumber = BIP32 child index).
all_address_to_locktime: dict[str, tuple[int, int]] = {}
for timenumber in range(TIMENUMBER_COUNT):
locktime = timenumber_to_timestamp(timenumber)
address = self.get_fidelity_bond_address(timenumber, locktime)
all_address_to_locktime[address] = (locktime, timenumber)
# For descriptor wallets, import all addresses in batches WITHOUT triggering
# a per-batch rescan. A single blockchain rescan is run after all descriptors
# are imported so Bitcoin Core never rejects a batch with RPC -4
# "Wallet is currently rescanning".
if descriptor_backend is not None:
# ``discover_fidelity_bonds`` can be called directly on a fresh
# ``WalletService`` (without a prior ``sync_all``). Ensure the
# descriptor wallet is initialised before importing address
# descriptors, otherwise backend calls fail with RPC -18 / "wallet
# not loaded".
expected_count = self.mixdepth_count * 2
if not await descriptor_backend.is_wallet_setup(
expected_descriptor_count=expected_count
):
logger.info(
"Descriptor wallet not initialised; running setup before bond discovery"
)
await self.setup_descriptor_wallet(rescan=False)
all_bond_addrs = [
(addr, lt, idx) for addr, (lt, idx) in all_address_to_locktime.items()
]
total_addrs = len(all_bond_addrs)
for batch_start in range(0, total_addrs, batch_size):
batch = all_bond_addrs[batch_start : batch_start + batch_size]
batch_end = batch_start + len(batch)
try:
await self.import_fidelity_bond_addresses(
fidelity_bond_addresses=batch,
rescan=False,
)
except Exception as e:
logger.error(f"Failed to import batch {batch_start}-{batch_end}: {e}")
if progress_callback:
progress_callback(batch_end, total_addrs)
# Single rescan after all descriptors are registered. The backend
# floors the start height at the wallet creation height when one is
# configured, so this does not always scan from genesis.
logger.info(
"All fidelity bond addresses imported, starting blockchain rescan "
"(from the wallet creation height when configured, otherwise genesis). "
"This may take a long time on mainnet (1-2+ hours with HDD)..."
)
await descriptor_backend.start_background_rescan(0)
await descriptor_backend.wait_for_rescan_complete(
poll_interval=5.0,
progress_callback=rescan_progress_callback,
)
# Query all UTXOs in a single call after rescan completes.
all_addresses = list(all_address_to_locktime.keys())
address_to_locktime = all_address_to_locktime
try:
backend_utxos = await self.backend.get_utxos(all_addresses)
except Exception as e:
logger.error(f"Failed to fetch UTXOs after rescan: {e}")
backend_utxos = []
else:
# Non-descriptor backends: scan in batches and query UTXOs per batch.
backend_utxos = []
address_to_locktime = all_address_to_locktime
all_addresses_list = list(all_address_to_locktime.keys())
total_addrs = len(all_addresses_list)
for batch_start in range(0, total_addrs, batch_size):
batch_addrs = all_addresses_list[batch_start : batch_start + batch_size]
batch_end = batch_start + len(batch_addrs)
try:
batch_utxos = await self.backend.get_utxos(batch_addrs)
backend_utxos.extend(batch_utxos)
except Exception as e:
logger.error(f"Failed to scan batch {batch_start}-{batch_end}: {e}")
if progress_callback:
progress_callback(batch_end, total_addrs)
from jmcore.timenumber import format_locktime_date
# Process found UTXOs
for utxo in backend_utxos:
if utxo.address in address_to_locktime:
locktime, idx = address_to_locktime[utxo.address]
path = f"{self.root_path}/0'/{FIDELITY_BOND_BRANCH}/{idx}:{locktime}"
utxo_info = _make_utxo_info(
txid=utxo.txid,
vout=utxo.vout,
value=utxo.value,
address=utxo.address,
confirmations=utxo.confirmations,
scriptpubkey=utxo.scriptpubkey,
path=path,
mixdepth=0,
height=utxo.height,
locktime=locktime,
)
discovered_utxos.append(utxo_info)
logger.info(
f"Discovered fidelity bond: {utxo.txid}:{utxo.vout} "
f"value={utxo.value:,} sats, locktime={format_locktime_date(locktime)}"
)
# Add discovered UTXOs to mixdepth 0 cache
if discovered_utxos:
if 0 not in self.utxo_cache:
self.utxo_cache[0] = []
# Avoid duplicates
existing_outpoints = {(u.txid, u.vout) for u in self.utxo_cache[0]}
for utxo_info in discovered_utxos:
if (utxo_info.txid, utxo_info.vout) not in existing_outpoints:
self.utxo_cache[0].append(utxo_info)
logger.info(f"Discovery complete: found {len(discovered_utxos)} fidelity bond(s)")
else:
logger.info("Discovery complete: no fidelity bonds found")
return discovered_utxos
async def sync_all(
self,
fidelity_bond_addresses: list[tuple[str, int, int]] | None = None,
) -> dict[int, list[UTXOInfo]]:
"""
Sync all mixdepths, optionally including fidelity bond addresses.
Args:
fidelity_bond_addresses: Optional list of (address, locktime, index) tuples
for fidelity bonds to scan with wallet descriptors
Returns:
Dictionary mapping mixdepth to list of UTXOs
"""
logger.info("Syncing all mixdepths...")
# Lazy-init: ensure descriptor wallet is loaded and seeded with our
# descriptors before scanning. Production paths call
# ``setup_descriptor_wallet`` explicitly (jmwalletd.wallet_ops); this
# guard makes ``WalletService(...).sync()`` work directly in tests and
# ad-hoc usage without each caller having to remember the setup step.
if isinstance(self.backend, DescriptorWalletBackend):
expected_count = self.mixdepth_count * 2
if fidelity_bond_addresses:
expected_count += len(fidelity_bond_addresses)
needs_setup = not await self.backend.is_wallet_setup(
expected_descriptor_count=expected_count
)
if not needs_setup:
expected_bases: set[str] = set()
for mixdepth in range(self.mixdepth_count):
xpub = self.get_account_xpub(mixdepth)
expected_bases.add(f"wpkh({xpub}/0/*)")
expected_bases.add(f"wpkh({xpub}/1/*)")
descriptors = await self.backend.list_descriptors()
actual_bases = {str(item.get("desc", "")).split("#", 1)[0] for item in descriptors}
if not expected_bases.issubset(actual_bases):
logger.info(
"Descriptor wallet loaded but does not contain this wallet's descriptors; "
"running setup before sync"
)
needs_setup = True
if needs_setup:
logger.info("Descriptor wallet not initialised; running setup before sync")
await self.setup_descriptor_wallet(
fidelity_bond_addresses=fidelity_bond_addresses,
rescan=False,
check_existing=False,
)
# Try efficient descriptor-based sync if backend supports it
if self.backend.supports_descriptor_scan:
result = await self._sync_all_with_descriptors(fidelity_bond_addresses)
if result is not None:
self._apply_frozen_state()
return result
# Fall back to address-by-address sync on failure
logger.warning("Descriptor scan failed, falling back to address scan")
# Legacy address-by-address scanning
# Pre-register ALL wallet addresses (all mixdepths × both branches × gap_limit)
# with the backend before the first get_utxos call triggers any rescan.
# Without this, light-client backends (Neutrino) fire the initial rescan on the
# first get_utxos call with only the *external* addresses registered, causing
# change (internal) addresses to be missed entirely.
if self.backend.supports_watch_address:
for pre_mixdepth in range(self.mixdepth_count):
for pre_change in [0, 1]:
for pre_index in range(self.gap_limit):
addr = self.get_address(pre_mixdepth, pre_change, pre_index)
await self.backend.add_watch_address(addr)
logger.debug(
f"Pre-registered {self.mixdepth_count * 2 * self.gap_limit} addresses "
"with backend before initial rescan"
)
result = {}
for mixdepth in range(self.mixdepth_count):
utxos = await self.sync_mixdepth(mixdepth)
result[mixdepth] = utxos
logger.info(f"Sync complete: {sum(len(u) for u in result.values())} total UTXOs")
self._apply_frozen_state()
return result
# -- Descriptor-based sync (Group D) ------------------------------------
async def _sync_all_with_descriptors(
self,
fidelity_bond_addresses: list[tuple[str, int, int]] | None = None,
) -> dict[int, list[UTXOInfo]] | None:
"""
Sync all mixdepths using efficient descriptor scanning.
This scans the entire wallet in a single UTXO set pass using xpub descriptors,
which is much faster than scanning addresses individually (especially on mainnet
where a full UTXO set scan takes ~90 seconds).
Args:
fidelity_bond_addresses: Optional list of (address, locktime, index) tuples to scan
in the same pass as wallet descriptors
Returns:
Dictionary mapping mixdepth to list of UTXOInfo, or None on failure
"""
# Generate descriptors for all mixdepths and build a lookup table.
# ``scan_range`` is the explicit descriptor lookahead set on the
# service (default 1000). The old ``max(1000, gap_limit * 10)``
# formula was dropped in favor of an explicit setting (issue #475).
scan_range = self.scan_range
descriptors: list[str | dict[str, Any]] = []
# Map descriptor string (without checksum) -> (mixdepth, change)
desc_to_path: dict[str, tuple[int, int]] = {}
# Map fidelity bond address -> (locktime, index)
bond_address_to_info: dict[str, tuple[int, int]] = {}
for mixdepth in range(self.mixdepth_count):
xpub = self.get_account_xpub(mixdepth)
# External (receive) addresses: .../0/*
desc_ext = f"wpkh({xpub}/0/*)"
descriptors.append({"desc": desc_ext, "range": [0, scan_range - 1]})
desc_to_path[desc_ext] = (mixdepth, 0)
# Internal (change) addresses: .../1/*
desc_int = f"wpkh({xpub}/1/*)"
descriptors.append({"desc": desc_int, "range": [0, scan_range - 1]})
desc_to_path[desc_int] = (mixdepth, 1)
# Add fidelity bond addresses to the scan
if fidelity_bond_addresses:
expected_hrp = get_hrp(self.network)
valid_bonds = []
for address, locktime, index in fidelity_bond_addresses:
# Skip addresses whose bech32 HRP doesn't match the current network
# (e.g. mainnet bc1q... addresses loaded into a regtest/signet wallet)
addr_hrp = address.split("1")[0].lower() if "1" in address else ""
if addr_hrp != expected_hrp:
logger.warning(
f"Skipping fidelity bond address {address!r}: network mismatch "
f"(expected HRP {expected_hrp!r}, got {addr_hrp!r})"
)
continue
valid_bonds.append((address, locktime, index))
if valid_bonds:
logger.info(f"Including {len(valid_bonds)} fidelity bond address(es) in scan")
for address, locktime, index in valid_bonds:
descriptors.append(f"addr({address})")
bond_address_to_info[address] = (locktime, index)
# Cache the address with the correct index from registry
self.address_cache[address] = (0, FIDELITY_BOND_BRANCH, index)
self.fidelity_bond_locktime_cache[address] = locktime
# Get current block height for confirmation calculation
try:
tip_height = await self.backend.get_block_height()
except Exception as e:
logger.error(f"Failed to get block height for descriptor scan: {e}")
return None
# Perform the scan
scan_result = await self.backend.scan_descriptors(descriptors)
if not scan_result or not scan_result.get("success", False):
return None
# Parse results and organize by mixdepth
result: dict[int, list[UTXOInfo]] = {md: [] for md in range(self.mixdepth_count)}
fidelity_bond_utxos: list[UTXOInfo] = []
for utxo_data in scan_result.get("unspents", []):
desc = utxo_data.get("desc", "")
# Check if this is a fidelity bond address result
# Fidelity bond descriptors are returned as: addr(bc1q...)#checksum
if "#" in desc:
desc_base = desc.split("#")[0]
else:
desc_base = desc
if desc_base.startswith("addr(") and desc_base.endswith(")"):
bond_address = desc_base[5:-1]
if bond_address in bond_address_to_info:
# This is a fidelity bond UTXO
locktime, index = bond_address_to_info[bond_address]
confirmations = 0
utxo_height = utxo_data.get("height", 0)
if utxo_height > 0:
confirmations = tip_height - utxo_height + 1
# Path format for fidelity bonds: m/84'/0'/0'/2/index:locktime
path = f"{self.root_path}/0'/{FIDELITY_BOND_BRANCH}/{index}:{locktime}"
utxo_info = _make_utxo_info(
txid=utxo_data["txid"],
vout=utxo_data["vout"],
value=btc_to_sats(utxo_data["amount"]),
address=bond_address,
confirmations=confirmations,
scriptpubkey=utxo_data.get("scriptPubKey", ""),
path=path,
mixdepth=0, # Fidelity bonds in mixdepth 0
height=utxo_height if utxo_height > 0 else None,
locktime=locktime,
)
fidelity_bond_utxos.append(utxo_info)
logger.info(
f"Found fidelity bond UTXO: {utxo_info.txid}:{utxo_info.vout} "
f"value={utxo_info.value} locktime={locktime} index={index}"
)
continue
# Parse the descriptor to extract change and index for regular wallet UTXOs
# Descriptor format from Bitcoin Core when using xpub:
# wpkh([fingerprint/change/index]pubkey)#checksum
# The fingerprint is the parent xpub's fingerprint
path_info = self._parse_descriptor_path(desc, desc_to_path)
source_address = str(utxo_data.get("address", ""))
if path_info is None and source_address:
source_address_lower = source_address.lower()
path_info = self.address_cache.get(source_address_lower) or self._find_address_path(
source_address_lower
)
if path_info is None:
logger.warning(f"Could not parse path from descriptor: {desc}")
continue
mixdepth, change, index = path_info
# Calculate confirmations
confirmations = 0
utxo_height = utxo_data.get("height", 0)
if utxo_height > 0:
confirmations = tip_height - utxo_height + 1
# Generate the address and cache it
address = (
source_address if source_address else self.get_address(mixdepth, change, index)
)
# Track that this address has had UTXOs
self._record_history_address(address)
# Build path string
path = f"{self.root_path}/{mixdepth}'/{change}/{index}"
utxo_info = _make_utxo_info(
txid=utxo_data["txid"],
vout=utxo_data["vout"],
value=btc_to_sats(utxo_data["amount"]),
address=address,
confirmations=confirmations,
scriptpubkey=utxo_data.get("scriptPubKey", ""),
path=path,
mixdepth=mixdepth,
height=utxo_height if utxo_height > 0 else None,
)
result[mixdepth].append(utxo_info)
# Add fidelity bond UTXOs to mixdepth 0
if fidelity_bond_utxos:
result[0].extend(fidelity_bond_utxos)
# Update cache
self.utxo_cache = result
total_utxos = sum(len(u) for u in result.values())
total_value = sum(sum(u.value for u in utxos) for utxos in result.values())
bond_count = len(fidelity_bond_utxos)
if bond_count > 0:
logger.info(
f"Descriptor sync complete: {total_utxos} UTXOs "
f"({bond_count} fidelity bond(s)), {format_amount(total_value)} total"
)
else:
logger.info(
f"Descriptor sync complete: {total_utxos} UTXOs, {format_amount(total_value)} total"
)
return result
async def setup_descriptor_wallet(
self,
scan_range: int | None = None,
fidelity_bond_addresses: list[tuple[str, int, int]] | None = None,
rescan: bool = True,
check_existing: bool = True,
smart_scan: bool = True,
background_full_rescan: bool = True,
) -> bool:
"""
Setup descriptor wallet backend for efficient UTXO tracking.
This imports wallet descriptors into Bitcoin Core's descriptor wallet,
enabling fast UTXO queries via listunspent instead of slow scantxoutset.
By default, uses smart scan for fast startup (~1 minute instead of 20+ minutes)
with a background full rescan to catch any older transactions.
Should be called once on first use or when restoring a wallet.
Subsequent operations will be much faster.
Args:
scan_range: Address index range to import. When ``None`` (default),
resolves to ``self.scan_range`` (configured via
``[wallet].scan_range``, default 1000). Distinct from
``gap_limit`` which is the BIP44 trailing-empty threshold.
The legacy ``max(DEFAULT_SCAN_RANGE, gap_limit * 10)`` formula
was removed (issue #475).
fidelity_bond_addresses: Optional list of (address, locktime, index) tuples
rescan: Whether to rescan blockchain
check_existing: If True, checks if wallet is already set up and skips import
smart_scan: If True and rescan=True, scan from ~1 year ago for fast startup.
A full rescan runs in background to catch older transactions.
background_full_rescan: If True and smart_scan=True, run full rescan in background
Returns:
True if setup completed successfully
Raises:
RuntimeError: If backend is not DescriptorWalletBackend
Example:
# Fast setup with smart scan (default) - starts quickly, full scan in background
await wallet.setup_descriptor_wallet(rescan=True)
# Full scan from genesis (slow but complete) - use for wallet recovery
await wallet.setup_descriptor_wallet(rescan=True, smart_scan=False)
# No rescan (for brand new wallets with no history)
await wallet.setup_descriptor_wallet(rescan=False)
"""
if not isinstance(self.backend, DescriptorWalletBackend):
raise RuntimeError(
"setup_descriptor_wallet() requires DescriptorWalletBackend. "
"Current backend does not support descriptor wallets."
)
if scan_range is None:
scan_range = self.scan_range
# Check if already set up (unless explicitly disabled)
if check_existing:
expected_count = self.mixdepth_count * 2 # external + internal per mixdepth
if fidelity_bond_addresses:
expected_count += len(fidelity_bond_addresses)
if await self.backend.is_wallet_setup(expected_descriptor_count=expected_count):
logger.info("Descriptor wallet already set up, skipping import")
return True
# Generate descriptors for all mixdepths
descriptors = self._generate_import_descriptors(scan_range)
# Add fidelity bond addresses
if fidelity_bond_addresses:
logger.info(f"Including {len(fidelity_bond_addresses)} fidelity bond addresses")
for address, locktime, index in fidelity_bond_addresses:
descriptors.append(
{
"desc": f"addr({address})",
"internal": False,
}
)
# Cache the address info
self.address_cache[address] = (0, FIDELITY_BOND_BRANCH, index)
self.fidelity_bond_locktime_cache[address] = locktime
# Setup wallet and import descriptors
logger.info("Setting up descriptor wallet...")
await self.backend.setup_wallet(
descriptors,
rescan=rescan,
smart_scan=smart_scan,
background_full_rescan=background_full_rescan,
)
logger.info("Descriptor wallet setup complete")
return True
async def is_descriptor_wallet_ready(self, fidelity_bond_count: int = 0) -> bool:
"""
Check if descriptor wallet is already set up and ready to use.
Args:
fidelity_bond_count: Expected number of fidelity bond addresses
Returns:
True if wallet is set up with all expected descriptors
Example:
if await wallet.is_descriptor_wallet_ready():
# Just sync
utxos = await wallet.sync_with_descriptor_wallet()
else:
# First time - import descriptors
await wallet.setup_descriptor_wallet(rescan=True)
"""
if not isinstance(self.backend, DescriptorWalletBackend):
return False
expected_count = self.mixdepth_count * 2 # external + internal per mixdepth
if fidelity_bond_count > 0:
expected_count += fidelity_bond_count
return await self.backend.is_wallet_setup(expected_descriptor_count=expected_count)
async def import_fidelity_bond_addresses(
self,
fidelity_bond_addresses: list[tuple[str, int, int]],
rescan: bool = True,
) -> bool:
"""
Import fidelity bond addresses into the descriptor wallet.
This is used to add fidelity bond addresses that weren't included
in the initial wallet setup. Fidelity bonds use P2WSH addresses
(timelocked scripts) that are not part of the standard BIP84 derivation,
so they must be explicitly imported.
Args:
fidelity_bond_addresses: List of (address, locktime, index) tuples
rescan: Whether to rescan the blockchain for these addresses
Returns:
True if import succeeded
Raises:
RuntimeError: If backend is not DescriptorWalletBackend
"""
if not isinstance(self.backend, DescriptorWalletBackend):
raise RuntimeError("import_fidelity_bond_addresses() requires DescriptorWalletBackend")
if not fidelity_bond_addresses:
return True
# Build descriptors for the bond addresses
descriptors = []
for address, locktime, index in fidelity_bond_addresses:
descriptors.append(
{
"desc": f"addr({address})",
"internal": False,
}
)
# Cache the address info
self.address_cache[address] = (0, FIDELITY_BOND_BRANCH, index)
self.fidelity_bond_locktime_cache[address] = locktime
logger.info(f"Importing {len(descriptors)} fidelity bond address(es)...")
await self.backend.import_descriptors(descriptors, rescan=rescan)
logger.info("Fidelity bond addresses imported")
return True
def _generate_import_descriptors(
self, scan_range: int = DEFAULT_SCAN_RANGE
) -> list[dict[str, Any]]:
"""
Generate descriptors for importdescriptors RPC.
Creates descriptors for all mixdepths (external and internal addresses)
with proper formatting for Bitcoin Core's importdescriptors.
Args:
scan_range: Maximum index to import
Returns:
List of descriptor dicts for importdescriptors
"""
if scan_range > MAX_DESCRIPTOR_RANGE:
logger.warning(
f"Requested scan_range {scan_range} exceeds Bitcoin Core's "
f"per-descriptor range limit of {MAX_DESCRIPTOR_RANGE}; "
f"clamping to {MAX_DESCRIPTOR_RANGE}. Bitcoin Core would "
"otherwise reject importdescriptors with 'Range is too large'. "
"See docs/technical/wallet-scanning.md."
)
scan_range = MAX_DESCRIPTOR_RANGE
descriptors = []
for mixdepth in range(self.mixdepth_count):
xpub = self.get_account_xpub(mixdepth)
# External (receive) addresses: .../0/*
descriptors.append(
{
"desc": f"wpkh({xpub}/0/*)",
"range": [0, scan_range - 1],
"internal": False,
}
)
# Internal (change) addresses: .../1/*
descriptors.append(
{
"desc": f"wpkh({xpub}/1/*)",
"range": [0, scan_range - 1],
"internal": True,
}
)
logger.debug(
f"Generated {len(descriptors)} import descriptors for "
f"{self.mixdepth_count} mixdepths with range [0, {scan_range - 1}]"
)
return descriptors
# -- Descriptor wallet fast path (Group E) ------------------------------
async def sync_with_descriptor_wallet(
self,
fidelity_bond_addresses: list[tuple[str, int, int]] | None = None,
) -> dict[int, list[UTXOInfo]]:
"""
Sync wallet using descriptor wallet backend (fast listunspent).
This is MUCH faster than scantxoutset because it only queries the
wallet's tracked UTXOs, not the entire UTXO set.
Args:
fidelity_bond_addresses: Optional fidelity bond addresses to include
Returns:
Dictionary mapping mixdepth to list of UTXOs
Raises:
RuntimeError: If backend is not DescriptorWalletBackend
"""
if not isinstance(self.backend, DescriptorWalletBackend):
raise RuntimeError("sync_with_descriptor_wallet() requires DescriptorWalletBackend")
logger.info("Syncing via descriptor wallet (listunspent)...")
# Get the current descriptor range from Bitcoin Core and cache it
# This is used by _find_address_path to know how far to scan
current_range = await self.backend.get_max_descriptor_range()
self._current_descriptor_range = current_range
logger.debug(f"Current descriptor range: [0, {current_range}]")
# Pre-populate address cache for the entire descriptor range
# This is more efficient than deriving addresses one by one during lookup
await self._populate_address_cache(current_range)
# Get all wallet UTXOs at once
all_utxos = await self.backend.get_all_utxos()
# Organize UTXOs by mixdepth
result: dict[int, list[UTXOInfo]] = {md: [] for md in range(self.mixdepth_count)}
fidelity_bond_utxos: list[UTXOInfo] = []
# Build fidelity bond address lookup
# Note: Normalize addresses to lowercase for consistent comparison
# (bech32 addresses are case-insensitive but Python string comparison is not)
bond_address_to_info: dict[str, tuple[int, int]] = {}
if fidelity_bond_addresses:
for address, locktime, index in fidelity_bond_addresses:
addr_lower = address.lower()
bond_address_to_info[addr_lower] = (locktime, index)
self.address_cache[addr_lower] = (0, FIDELITY_BOND_BRANCH, index)
self.fidelity_bond_locktime_cache[addr_lower] = locktime
logger.debug(f"Registered {len(bond_address_to_info)} fidelity bond addresses for sync")
for utxo in all_utxos:
# Normalize address to lowercase for consistent comparison
# (bech32 addresses are case-insensitive but Python string comparison is not)
original_address = utxo.address
address = original_address.lower()
# Check if this is a fidelity bond
if address in bond_address_to_info:
locktime, index = bond_address_to_info[address]
path = f"{self.root_path}/0'/{FIDELITY_BOND_BRANCH}/{index}:{locktime}"
# Track that this address has had UTXOs
self._record_history_address(address)
utxo_info = _make_utxo_info(
txid=utxo.txid,
vout=utxo.vout,
value=utxo.value,
address=original_address, # Preserve original case
confirmations=utxo.confirmations,
scriptpubkey=utxo.scriptpubkey,
path=path,
mixdepth=0,
height=utxo.height,
locktime=locktime,
)
fidelity_bond_utxos.append(utxo_info)
logger.debug(
f"Recognized fidelity bond UTXO: {address[:20]}... "
f"value={utxo.value} locktime={locktime}"
)
continue
# Try to find address in cache (should be pre-populated now)
path_info = self.address_cache.get(address)
if path_info is None:
# Fallback to derivation scan (shouldn't happen often now)
path_info = self._find_address_path(address)
if path_info is None:
# Check if this is a P2WSH address (likely a fidelity bond we don't know about)
# P2WSH: OP_0 (0x00) + PUSH32 (0x20) + 32-byte hash = 68 hex chars
if len(utxo.scriptpubkey) == 68 and utxo.scriptpubkey.startswith("0020"):
# Check if this P2WSH address is a known fidelity bond from the registry
# This handles external bonds that may have been imported but not matched above
cached_locktime = self.fidelity_bond_locktime_cache.get(address)
if cached_locktime is not None:
# This is a known fidelity bond from the registry
# Get index from address_cache (should have been set during import)
cached = self.address_cache.get(address)
index = cached[2] if cached else -1
path = (
f"{self.root_path}/0'/{FIDELITY_BOND_BRANCH}/{index}:{cached_locktime}"
)
self._record_history_address(address)
utxo_info = _make_utxo_info(
txid=utxo.txid,
vout=utxo.vout,
value=utxo.value,
address=original_address, # Preserve original case
confirmations=utxo.confirmations,
scriptpubkey=utxo.scriptpubkey,
path=path,
mixdepth=0,
height=utxo.height,
locktime=cached_locktime,
)
fidelity_bond_utxos.append(utxo_info)
logger.debug(
f"Recognized P2WSH as fidelity bond from registry: "
f"{address[:20]}... locktime={cached_locktime}"
)
continue
# Unknown P2WSH - silently skip (fidelity bonds we don't know about)
logger.trace(f"Skipping unknown P2WSH address {address}")
continue
logger.debug(f"Unknown address {address}, skipping")
continue
mixdepth, change, index = path_info
# Check if this is a fidelity bond address (branch 2)
# This handles cases where the address was added to address_cache but
# the UTXO wasn't matched in bond_address_to_info (e.g., external bonds)
if change == FIDELITY_BOND_BRANCH:
# Get locktime from cache
bond_locktime: int | None = None
bond_locktime = self.fidelity_bond_locktime_cache.get(address)
if bond_locktime is not None:
path = f"{self.root_path}/0'/{FIDELITY_BOND_BRANCH}/{index}:{bond_locktime}"
self._record_history_address(address)
utxo_info = _make_utxo_info(
txid=utxo.txid,
vout=utxo.vout,
value=utxo.value,
address=original_address, # Preserve original case
confirmations=utxo.confirmations,
scriptpubkey=utxo.scriptpubkey,
path=path,
mixdepth=0,
height=utxo.height,
locktime=bond_locktime,
)
fidelity_bond_utxos.append(utxo_info)
logger.debug(
f"Recognized fidelity bond from cache: "
f"{address[:20]}... locktime={bond_locktime} index={index}"
)
continue
else:
# Fidelity bond address without locktime - skip with warning
logger.warning(
f"Fidelity bond address {address[:20]}... found without locktime, skipping"
)
continue
path = f"{self.root_path}/{mixdepth}'/{change}/{index}"
# Track that this address has had UTXOs
self._record_history_address(address)
utxo_info = _make_utxo_info(
txid=utxo.txid,
vout=utxo.vout,
value=utxo.value,
address=original_address, # Preserve original case
confirmations=utxo.confirmations,
scriptpubkey=utxo.scriptpubkey,
path=path,
mixdepth=mixdepth,
height=utxo.height,
)
result[mixdepth].append(utxo_info)
# Add fidelity bonds to mixdepth 0
if fidelity_bond_utxos:
result[0].extend(fidelity_bond_utxos)
# Update cache
self.utxo_cache = result
# Fetch all addresses with transaction history (including spent)
# This is important to track addresses that have been used but are now empty
addresses_beyond_range: list[str] = []
try:
if hasattr(self.backend, "get_addresses_with_history"):
history_addresses = await self.backend.get_addresses_with_history()
for address in history_addresses:
# Check if this address belongs to our wallet
# Use _find_address_path which checks cache first, then derives if needed
path_info = self._find_address_path(address)
if path_info is not None:
self._record_history_address(address)
else:
# Address not found in current range - may be beyond descriptor range
addresses_beyond_range.append(address)
logger.debug(f"Tracked {len(self.addresses_with_history)} addresses with history")
if addresses_beyond_range:
logger.debug(
f"Found {len(addresses_beyond_range)} address(es) from history "
f"not in current range [0, {current_range}]; will filter and "
f"search extended range if any are ours"
)
except Exception as e:
# Address-history enumeration failure is a privacy-critical
# event: if we silently continue, the descriptor-range upgrade
# path and the deposit-address picker will operate on a
# partial view and may propose a previously funded address as
# a fresh deposit. Log loudly. The persisted BIP-329 store
# still holds whatever was learned previously (we never
# downgrade it), so subsequent ``info``/``send`` runs that
# don't trip the same RPC failure will recover.
logger.error(
f"Could not fetch addresses with history: {e}. "
f"Proposed deposit addresses will be checked against "
f"the persisted used-address store, but the in-memory "
f"enumeration is incomplete for this run."
)
# Resolve addresses beyond the current descriptor range.
#
# The Bitcoin Core wallet holds two kinds of descriptors for us:
# ranged ``wpkh(xpub/0/*)`` / ``wpkh(xpub/1/*)`` descriptors per
# mixdepth, and standalone ``addr(<bech32>)`` descriptors for our
# fidelity bond addresses. Any of those addresses can show up in
# ``listreceivedbyaddress`` (used by get_addresses_with_history) once
# they have transaction history. That RPC is ismine-only by
# construction, so external counterparties from CoinJoin co-spends do
# not appear; defensive checks below keep the sync robust if a future
# backend ever leaks a non-ours address through.
#
# Naively running _find_address_path_extended on each missing address
# is a ~50,000-derivation BIP32 scan per address and, for anything not
# actually reachable via our wpkh derivation (fidelity bonds, external
# counterparties), runs to completion. That easily blocks MakerBot
# startup past test timeouts before the bot connects to directories.
#
# Instead, ask Bitcoin Core via getaddressinfo:
# - ismine=False -> external (e.g. counterparty); skip.
# - desc is wpkh -> parse the embedded (change, index) and verify
# the pubkey derives from this wallet's master
# key. Match -> exact path in O(mixdepths).
# - desc is addr() or other non-wpkh -> our fidelity bonds and any
# other non-ranged imports live here. They have
# no BIP32 path to recover; skip the extended
# scan rather than spending tens of seconds on
# it. UTXOs at fidelity bond addresses are still
# resolved via the bond_address_to_info path
# above when the caller passes the registry.
# - desc missing -> skip. ismine descriptor wallets always emit a
# desc; absence means it isn't one of our ranged
# wpkh derivations and the BIP32 fallback would
# not find it anyway. Avoids a multi-second stall
# on MakerBot startup. The legacy BIP32 fallback
# below only runs when the backend lacks
# getaddressinfo entirely (older Core / test
# mocks).
backend_has_get_address_info = getattr(self.backend, "get_address_info", None) is not None
if addresses_beyond_range and backend_has_get_address_info:
get_address_info = self.backend.get_address_info # type: ignore[attr-defined]
# Prefer the JSON-RPC batch path when the backend exposes it
# (DescriptorWalletBackend does). Batching collapses N HTTP
# round-trips into ceil(N/chunk) and is ~20x faster on localhost
# and dramatically more on remote / Tor-fronted Core endpoints.
# Falls back to a sequential loop for backends/test mocks that
# don't implement ``batch_get_address_info``.
batch_lookup = getattr(self.backend, "batch_get_address_info", None)
addresses_list = list(addresses_beyond_range)
if batch_lookup is not None:
try:
infos: list[dict | None] = await batch_lookup(addresses_list)
except Exception as e:
logger.debug(f"batch_get_address_info failed, falling back to serial: {e}")
infos = []
for address in addresses_list:
try:
infos.append(await get_address_info(address))
except Exception as inner:
logger.trace(f"getaddressinfo failed for {address[:20]}...: {inner}")
infos.append(None)
else:
infos = []
for address in addresses_list:
try:
infos.append(await get_address_info(address))
except Exception as e:
logger.trace(f"getaddressinfo failed for {address[:20]}...: {e}")
infos.append(None)
resolved = 0
skipped_external = 0
skipped_non_wpkh = 0
skipped_no_desc = 0
for address, info in zip(addresses_list, infos):
if info is None:
# RPC failed entirely; we can't tell if this is ours.
# Skip rather than spend tens of seconds on a BIP32 scan
# that would almost always come up empty for addresses
# we couldn't even getaddressinfo on.
skipped_no_desc += 1
continue
if not info.get("ismine"):
skipped_external += 1
continue
desc = info.get("desc", "")
if not desc:
# ismine=True but no descriptor returned. For descriptor
# wallets Core always returns a desc for ismine addresses;
# absence means this isn't one of our ranged wpkh
# derivations (or Core is too old to report it). Skip the
# multi-second BIP32 fallback either way: if it WERE one
# of ours the desc would have been present.
skipped_no_desc += 1
continue
path_info = self._resolve_descriptor_path(desc)
if path_info is None:
# Descriptor doesn't decode into one of our wpkh
# derivations: typically an addr() import for a
# fidelity bond, or some other non-ranged descriptor.
# Nothing more to do here.
skipped_non_wpkh += 1
continue
self.address_cache[address] = path_info
self._record_history_address(address)
resolved += 1
if skipped_external:
logger.debug(
f"Skipped {skipped_external} external address(es) beyond range "
f"(not ismine - e.g., CoinJoin counterparties)"
)
if skipped_non_wpkh:
logger.debug(
f"Skipped {skipped_non_wpkh} ismine address(es) with non-wpkh "
f"descriptor (e.g., addr() imports for fidelity bonds)"
)
if skipped_no_desc:
logger.debug(
f"Skipped {skipped_no_desc} address(es) beyond range with no "
f"resolvable descriptor (would not be reachable via BIP32 scan)"
)
if resolved:
logger.debug(f"Resolved {resolved} address(es) beyond range via getaddressinfo")
elif addresses_beyond_range:
# Fallback BIP32 derivation scan. Only reached when the backend
# doesn't expose get_address_info at all (older Core / test mocks).
# We deliberately do NOT fall back here when get_address_info
# exists but returned None/empty desc: that scan is O(mixdepths *
# 2 * 5000) derivations per address and can stall MakerBot startup
# past test timeouts; if the address were one of our wpkh
# derivations, Core would have returned its descriptor.
extended_addresses_found = 0
for address in addresses_beyond_range:
path_info = self._find_address_path_extended(address)
if path_info is not None:
self._record_history_address(address)
extended_addresses_found += 1
if extended_addresses_found > 0:
logger.info(
f"Found {extended_addresses_found} address(es) in extended range search"
)
# Check if descriptor range needs to be upgraded. This keeps the
# descriptor lookahead window ahead of the highest used address as
# the wallet grows, using the configured BIP44 ``gap_limit`` as the
# trailing buffer (see docs/technical/wallet-scanning.md).
try:
upgraded = await self.check_and_upgrade_descriptor_range(gap_limit=self.gap_limit)
if upgraded:
# Re-populate address cache with the new range
new_range = await self.backend.get_max_descriptor_range()
await self._populate_address_cache(new_range)
except Exception as e:
logger.warning(f"Could not check/upgrade descriptor range: {e}")
total_utxos = sum(len(u) for u in result.values())
total_value = sum(sum(u.value for u in utxos) for utxos in result.values())
logger.info(
f"Descriptor wallet sync complete: {total_utxos} UTXOs, "
f"{format_amount(total_value)} total"
)
self._apply_frozen_state()
return result
async def check_and_upgrade_descriptor_range(
self,
gap_limit: int = 20,
) -> bool:
"""
Check if descriptor range needs upgrading and upgrade if necessary.
This method detects if the wallet has used addresses beyond the current
descriptor range and automatically upgrades the range if needed.
The algorithm:
1. Get the current descriptor range from Bitcoin Core
2. Check addresses with history to find the highest used index
3. If highest used index + gap_limit > current range, upgrade
Args:
gap_limit: BIP44 trailing-empty buffer to keep beyond the highest
used address (defaults to the wallet's configured gap_limit).
Returns:
True if upgrade was performed, False otherwise
Raises:
RuntimeError: If backend is not DescriptorWalletBackend
"""
if not isinstance(self.backend, DescriptorWalletBackend):
raise RuntimeError(
"check_and_upgrade_descriptor_range() requires DescriptorWalletBackend"
)
# Get current range
current_range = await self.backend.get_max_descriptor_range()
logger.debug(f"Current descriptor range: [0, {current_range}]")
# Find highest used index across all mixdepths/branches
highest_used = await self._find_highest_used_index_from_history()
# Calculate required range
required_range = highest_used + gap_limit + 1
# Bitcoin Core rejects descriptor ranges spanning more than
# MAX_DESCRIPTOR_RANGE indices ("Range is too large"). If a wallet has
# used addresses beyond that, we can only track up to the limit; clamp
# so the upgrade succeeds rather than failing wholesale.
if required_range > MAX_DESCRIPTOR_RANGE:
logger.warning(
f"Required descriptor range {required_range} (highest used "
f"{highest_used} + gap_limit {gap_limit}) exceeds Bitcoin Core's "
f"limit of {MAX_DESCRIPTOR_RANGE}; clamping to "
f"{MAX_DESCRIPTOR_RANGE}. Addresses beyond index "
f"{MAX_DESCRIPTOR_RANGE - 1} cannot be tracked. See "
"docs/technical/wallet-scanning.md."
)
required_range = MAX_DESCRIPTOR_RANGE
if required_range <= current_range:
logger.debug(
f"Descriptor range sufficient: highest used={highest_used}, "
f"current range={current_range}"
)
return False
# Need to upgrade
logger.info(
f"Upgrading descriptor range: highest used={highest_used}, "
f"current={current_range}, new={required_range}"
)
# Generate descriptors with new range
descriptors = self._generate_import_descriptors(required_range)
# Upgrade (no rescan needed - addresses already exist in blockchain)
await self.backend.upgrade_descriptor_ranges(descriptors, required_range, rescan=False)
# Update our cached range
self._current_descriptor_range = required_range
logger.info(f"Descriptor range upgraded to [0, {required_range}]")
return True
async def _find_highest_used_index_from_history(self) -> int:
"""
Find the highest address index that has ever been used.
Uses addresses_with_history which is populated from Bitcoin Core's
transaction history.
Returns:
Highest used address index, or -1 if no addresses used
"""
highest_index = -1
# Check addresses from blockchain history
for address in self.addresses_with_history:
if address in self.address_cache:
_, _, index = self.address_cache[address]
if index > highest_index:
highest_index = index
# Also check current UTXOs
for mixdepth in range(self.mixdepth_count):
utxos = self.utxo_cache.get(mixdepth, [])
for utxo in utxos:
if utxo.address in self.address_cache:
_, _, index = self.address_cache[utxo.address]
if index > highest_index:
highest_index = index
return highest_index
async def _populate_address_cache(self, max_index: int) -> None:
"""
Pre-populate the address cache for efficient address lookups.
This derives addresses for all mixdepths and branches up to max_index,
storing them in the address_cache for O(1) lookups during sync.
Args:
max_index: Maximum address index to derive (typically the descriptor range)
"""
import time
# Only populate if we haven't already cached enough addresses
current_cache_size = len(self.address_cache)
expected_size = self.mixdepth_count * 2 * max_index # mixdepths * branches * indices
# If cache already has enough entries, skip
if current_cache_size >= expected_size * 0.9: # 90% threshold
logger.debug(f"Address cache already populated ({current_cache_size} entries)")
return
total_addresses = expected_size
logger.info(
f"Populating address cache for range [0, {max_index}] "
f"({total_addresses:,} addresses)..."
)
start_time = time.time()
count = 0
last_log_time = start_time
for mixdepth in range(self.mixdepth_count):
for change in [0, 1]:
for index in range(max_index):
# get_address automatically caches
self.get_address(mixdepth, change, index)
count += 1
# Log progress every 5 seconds for large caches
current_time = time.time()
if current_time - last_log_time >= 5.0:
progress = count / total_addresses * 100
elapsed = current_time - start_time
rate = count / elapsed if elapsed > 0 else 0
remaining = (total_addresses - count) / rate if rate > 0 else 0
logger.info(
f"Address cache progress: {count:,}/{total_addresses:,} "
f"({progress:.1f}%) - ETA: {remaining:.0f}s"
)
last_log_time = current_time
elapsed = time.time() - start_time
logger.info(
f"Address cache populated with {len(self.address_cache):,} entries in {elapsed:.1f}s"
)
# -- Address path resolution (Group F) ----------------------------------
def _find_address_path(
self, address: str, max_scan: int | None = None
) -> tuple[int, int, int] | None:
"""
Find the derivation path for an address.
First checks the cache, then checks the fidelity bond registry,
then tries to derive and match.
Args:
address: Bitcoin address
max_scan: Maximum index to scan per branch. If None, uses the current
descriptor range from _current_descriptor_range or DEFAULT_SCAN_RANGE.
Returns:
Tuple of (mixdepth, change, index) or None if not found
"""
# Check cache first
if address in self.address_cache:
return self.address_cache[address]
# Check fidelity bond registry if data_dir is available
# Fidelity bond addresses use branch 2 and aren't in the normal cache
if self.data_dir:
try:
from jmwallet.wallet.bond_registry import load_registry
registry = load_registry(self.data_dir, self.wallet_fingerprint)
bond = registry.get_bond_by_address(address)
if bond is not None:
# Found in fidelity bond registry - cache it and return
path_info = (0, FIDELITY_BOND_BRANCH, bond.index)
self.address_cache[address] = path_info
# Also cache the locktime
self.fidelity_bond_locktime_cache[address] = bond.locktime
logger.debug(
f"Found address {address[:20]}... in fidelity bond registry "
f"(index={bond.index}, locktime={bond.locktime})"
)
return path_info
except Exception as e:
logger.trace(f"Could not check bond registry: {e}")
# Determine scan range - use the current descriptor range if available
if max_scan is None:
max_scan = int(getattr(self, "_current_descriptor_range", DEFAULT_SCAN_RANGE))
# Try to find by deriving addresses (expensive but necessary)
# We must scan up to the descriptor range to find all addresses
for mixdepth in range(self.mixdepth_count):
for change in [0, 1]:
for index in range(max_scan):
derived_addr = self.get_address(mixdepth, change, index)
if derived_addr == address:
return (mixdepth, change, index)
return None
def _find_address_path_extended(
self, address: str, extend_by: int = 5000
) -> tuple[int, int, int] | None:
"""
Find the derivation path for an address, searching beyond the current range.
This is used for addresses from transaction history that might be at
indices beyond the current descriptor range (e.g., from previous use
with a different wallet software).
Args:
address: Bitcoin address
extend_by: How far beyond the current range to search
Returns:
Tuple of (mixdepth, change, index) or None if not found
"""
# Check cache first
if address in self.address_cache:
return self.address_cache[address]
current_range = int(getattr(self, "_current_descriptor_range", DEFAULT_SCAN_RANGE))
extended_max = current_range + extend_by
# Search from current_range to extended_max (the normal range was already searched)
for mixdepth in range(self.mixdepth_count):
for change in [0, 1]:
for index in range(current_range, extended_max):
derived_addr = self.get_address(mixdepth, change, index)
if derived_addr == address:
logger.info(
f"Found address at extended index {index} "
f"(beyond current range {current_range})"
)
return (mixdepth, change, index)
return None
def _resolve_descriptor_path(self, desc: str) -> tuple[int, int, int] | None:
"""
Parse a ``wpkh`` descriptor and resolve ``(mixdepth, change, index)``.
Used to translate Bitcoin Core's ``getaddressinfo`` descriptor for an
address into a wallet path without scanning derivations. Verifies the
descriptor's pubkey against this wallet's master key. Returns ``None``
if the descriptor is not a ranged ``wpkh`` (e.g., an ``addr(...)``
import for a fidelity bond) or if no mixdepth derives the same pubkey
— in either case the address has no BIP32 path here for us to record.
"""
if "#" in desc:
desc = desc.split("#")[0]
match = re.search(r"wpkh\(\[[\da-f]+/(\d+)/(\d+)\]([\da-f]+)\)", desc, re.I)
if not match:
return None
change_from_desc = int(match.group(1))
index = int(match.group(2))
pubkey = match.group(3).lower()
for mixdepth in range(self.mixdepth_count):
try:
derived_key = self.master_key.derive(
f"{self.root_path}/{mixdepth}'/{change_from_desc}/{index}"
)
except Exception:
continue
derived_pubkey = derived_key.get_public_key_bytes(compressed=True).hex().lower()
if derived_pubkey == pubkey:
return (mixdepth, change_from_desc, index)
return None
def _parse_descriptor_path(
self,
desc: str,
desc_to_path: dict[str, tuple[int, int]],
) -> tuple[int, int, int] | None:
"""
Parse a descriptor to extract mixdepth, change, and index.
When using xpub descriptors, Bitcoin Core returns a descriptor showing
the path RELATIVE to the xpub we provided:
wpkh([fingerprint/change/index]pubkey)#checksum
We need to match this back to the original descriptor to determine mixdepth.
Args:
desc: Descriptor string from scantxoutset result
desc_to_path: Mapping of descriptor (without checksum) to (mixdepth, change)
Returns:
Tuple of (mixdepth, change, index) or None if parsing fails
"""
# Remove checksum
if "#" in desc:
desc_base = desc.split("#")[0]
else:
desc_base = desc
# Extract the relative path [fingerprint/change/index] and pubkey
# Pattern: wpkh([fingerprint/change/index]pubkey)
match = re.search(r"wpkh\(\[[\da-f]+/(\d+)/(\d+)\]([\da-f]+)\)", desc_base, re.I)
if not match:
return None
change_from_desc = int(match.group(1))
index = int(match.group(2))
pubkey = match.group(3)
# Find which descriptor this matches by checking all our descriptors
# We need to derive the key and check if it matches the pubkey
for base_desc, (mixdepth, change) in desc_to_path.items():
if change == change_from_desc:
# Verify by deriving the key and comparing pubkeys
try:
derived_key = self.master_key.derive(
f"{self.root_path}/{mixdepth}'/{change}/{index}"
)
derived_pubkey = derived_key.get_public_key_bytes(compressed=True).hex()
if derived_pubkey == pubkey:
return (mixdepth, change, index)
except Exception:
continue
return None
|