jmwalletd.routers.wallet_data
jmwalletd.routers.wallet_data
Wallet data endpoints: display, UTXOs, addresses, seed, freeze, config, rescan, sign.
Attributes
router = APIRouter()
module-attribute
Classes
Functions:
config_get(walletname: str, body: ConfigGetRequest, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> ConfigGetResponse
async
Read a config variable (in-memory override takes priority).
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |
config_set(walletname: str, body: ConfigSetRequest, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> dict[str, str]
async
Set a config variable (in-memory only, not persisted).
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 | |
freeze_utxo(walletname: str, body: FreezeRequest, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> dict[str, str]
async
Freeze or unfreeze a UTXO.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | |
freeze_utxos_batch(walletname: str, body: FreezeBatchRequest, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> dict[str, str]
async
Freeze and/or unfreeze several UTXOs in one atomic request (issue #596).
Mixed directions are allowed in the same batch. Every entry is validated before anything is written; if any outpoint is malformed or repeated, the whole request is rejected and nothing on disk changes.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |
get_new_address(walletname: str, mixdepth: str, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> GetAddressResponse
async
Get a new receive address for the specified mixdepth.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | |
get_rescan_info(walletname: str, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> RescanInfoResponse
async
Get rescan progress information (Bitcoin Core is the source of truth).
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
719 720 721 722 723 724 725 726 727 728 729 730 | |
get_seed(walletname: str, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> GetSeedResponse
async
Return the wallet's BIP39 mnemonic seed phrase.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
387 388 389 390 391 392 393 394 395 396 397 | |
get_timelock_address(walletname: str, lockdate: str, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> GetAddressResponse
async
Get a new timelocked (fidelity bond) address.
The lockdate should be in YYYY-mm format (e.g., "2025-06").
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |
list_utxos(walletname: str, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> ListUtxosResponse
async
List all UTXOs in the wallet.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |
rescan_blockchain(walletname: str, blockheight: int, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> RescanBlockchainResponse
async
Trigger a blockchain rescan from the given block height.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |
sign_message(walletname: str, body: SignMessageRequest, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> SignMessageResponse
async
Sign a message with a wallet key at the given HD path.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |
wallet_display(walletname: str, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> WalletDisplayResponse
async
Return full wallet display with accounts, branches, and entries.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |
wallet_history(walletname: str, limit: int | None = None, _auth: dict[str, Any] = Depends(require_auth), _wallet: None = Depends(require_wallet_match), state: DaemonState = Depends(get_daemon_state)) -> WalletHistoryResponse
async
Return the active wallet's CoinJoin/spend history (from history.csv).
Entries are scoped to the active wallet's master fingerprint and returned
most-recent first. Pass ?limit=N to cap the number of entries. This is
the same data the jm-wallet history CLI reads; it is read-only.
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |
yieldgen_report(_auth: dict[str, Any] = Depends(require_auth), state: DaemonState = Depends(get_daemon_state)) -> YieldGenReportResponse
async
Return the yield generator (maker earnings) report.
The joinmarket-ng maker logs its activity to history.csv (its single
source of truth) rather than the legacy yigen-statement.csv file, so the
report is synthesized from the successful maker rows of history.csv in
the reference comma-separated format the Earn report UI expects (a header
row followed by one row per CoinJoin).
Source code in jmwalletd/src/jmwalletd/routers/wallet_data.py
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 | |