Skip to content

jmwalletd.wallet_ops

jmwalletd.wallet_ops

Wallet operations bridge.

Thin adapter layer between the HTTP API and our jmwallet.WalletService. These functions handle wallet creation, opening, and recovery, returning the initialised WalletService instances that the daemon state holds.

The actual wallet implementation lives in the jmwallet package; this module only wires things together in the way the HTTP daemon needs.

Functions:

create_wallet(*, wallet_path: Path, password: str, wallet_type: str, data_dir: Path) -> tuple[Any, str] async

Create a new wallet and return (wallet_service, seedphrase).

Args: wallet_path: Full path for the new .jmdat wallet file. password: Encryption password. wallet_type: One of "sw", "sw-legacy", "sw-fb". data_dir: Application data directory.

Returns: Tuple of (WalletService, seed_phrase_string).

Raises: FileExistsError: If the wallet file already exists. ValueError: If the wallet type is invalid.

Source code in jmwalletd/src/jmwalletd/wallet_ops.py 
 56
 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
async def create_wallet(
    *,
    wallet_path: Path,
    password: str,
    wallet_type: str,
    data_dir: Path,
) -> tuple[Any, str]:
    """Create a new wallet and return ``(wallet_service, seedphrase)``.

    Args:
        wallet_path: Full path for the new .jmdat wallet file.
        password: Encryption password.
        wallet_type: One of ``"sw"``, ``"sw-legacy"``, ``"sw-fb"``.
        data_dir: Application data directory.

    Returns:
        Tuple of (WalletService, seed_phrase_string).

    Raises:
        FileExistsError: If the wallet file already exists.
        ValueError: If the wallet type is invalid.
    """
    from jmwallet.wallet.service import WalletService
    from jmwalletd._backend import get_backend

    if wallet_path.exists():
        raise FileExistsError(f"Wallet file already exists: {wallet_path}")

    valid_types = {"sw", "sw-legacy", "sw-fb"}
    if wallet_type not in valid_types:
        msg = f"Invalid wallet type: {wallet_type}. Must be one of {valid_types}"
        raise ValueError(msg)

    from mnemonic import Mnemonic

    mnemo = Mnemonic("english")
    seedphrase = mnemo.generate(strength=128)

    backend = await get_backend(
        data_dir=data_dir,
        mnemonic=seedphrase,
        network=_get_network(),
    )

    # Record current block height as the wallet birthday.  Since this is a
    # brand-new wallet, it cannot have received any funds before this point,
    # so future rescans can safely start from this height.
    creation_height: int | None = None
    try:
        creation_height = await backend.get_block_height()
        logger.info(f"Recording wallet creation height: {creation_height}")
    except Exception as exc:
        logger.warning(f"Could not fetch block height for wallet birthday: {exc}")

    ws = WalletService(
        mnemonic=seedphrase,
        backend=backend,
        data_dir=data_dir,
        network=_get_network(),
        max_sats_freeze_reuse=_get_max_sats_freeze_reuse(),
    )

    # Persist the wallet file (encrypted with the password).
    _save_wallet_file(
        wallet_path=wallet_path,
        mnemonic=seedphrase,
        password=password,
        wallet_type=wallet_type,
        creation_height=creation_height,
    )

    # Ensure the watch-only descriptor wallet is loaded in Bitcoin Core
    # and import HD descriptors.  No rescan needed for a brand-new wallet.
    # Skipped for non-descriptor backends (e.g. neutrino).
    if _is_descriptor_backend(backend):
        await ws.setup_descriptor_wallet(rescan=False)

    # Initial sync to populate caches.
    await ws.sync()

    logger.info("Created wallet: {}", wallet_path.name)
    return ws, seedphrase

open_wallet(*, wallet_path: Path, password: str, data_dir: Path, sync_on_open: bool = True) -> Any async

Open (unlock) an existing wallet file.

Returns: WalletService instance.

Raises: FileNotFoundError: If the wallet file doesn't exist. ValueError: If the password is wrong.

Source code in jmwalletd/src/jmwalletd/wallet_ops.py 
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
async def open_wallet(
    *,
    wallet_path: Path,
    password: str,
    data_dir: Path,
    sync_on_open: bool = True,
) -> Any:
    """Open (unlock) an existing wallet file.

    Returns:
        WalletService instance.

    Raises:
        FileNotFoundError: If the wallet file doesn't exist.
        ValueError: If the password is wrong.
    """
    ws, _ = await open_wallet_with_mnemonic(
        wallet_path=wallet_path,
        password=password,
        data_dir=data_dir,
        sync_on_open=sync_on_open,
    )
    return ws

open_wallet_with_mnemonic(*, wallet_path: Path, password: str, data_dir: Path, sync_on_open: bool = True) -> tuple[Any, str] async

Open (unlock) an existing wallet file and return mnemonic.

Returns: Tuple of (WalletService, seedphrase).

Raises: FileNotFoundError: If the wallet file doesn't exist. ValueError: If the password is wrong.

Source code in jmwalletd/src/jmwalletd/wallet_ops.py 
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
async def open_wallet_with_mnemonic(
    *,
    wallet_path: Path,
    password: str,
    data_dir: Path,
    sync_on_open: bool = True,
) -> tuple[Any, str]:
    """Open (unlock) an existing wallet file and return mnemonic.

    Returns:
        Tuple of (WalletService, seedphrase).

    Raises:
        FileNotFoundError: If the wallet file doesn't exist.
        ValueError: If the password is wrong.
    """
    from jmwallet.wallet.service import WalletService
    from jmwalletd._backend import get_backend

    if not wallet_path.exists():
        raise FileNotFoundError(f"Wallet file not found: {wallet_path}")

    seedphrase, creation_height = _load_wallet_file(wallet_path=wallet_path, password=password)

    backend = await get_backend(
        data_dir=data_dir,
        mnemonic=seedphrase,
        network=_get_network(),
    )

    # Propagate wallet creation height hint to the backend.  Passing None
    # clears any stale hint from a previously opened wallet when backend
    # instances are reused.
    backend.set_wallet_creation_height(creation_height)

    ws = WalletService(
        mnemonic=seedphrase,
        backend=backend,
        data_dir=data_dir,
        network=_get_network(),
        max_sats_freeze_reuse=_get_max_sats_freeze_reuse(),
    )

    # Ensure the watch-only descriptor wallet is loaded in Bitcoin Core
    # and import HD descriptors.  Idempotent — skips if already set up.
    # Skipped for non-descriptor backends (e.g. neutrino).
    if _is_descriptor_backend(backend):
        await ws.setup_descriptor_wallet()

    if sync_on_open:
        # Bond-aware sync so funded fidelity bonds from the registry are
        # imported and surfaced in /utxos and /display.
        await ws.sync_with_registered_bonds()

    logger.info("Opened wallet: {}", wallet_path.name)
    return ws, seedphrase

recover_wallet(*, wallet_path: Path, password: str, wallet_type: str, seedphrase: str, data_dir: Path) -> Any async

Recover a wallet from a BIP39 seed phrase.

Returns: WalletService instance.

Raises: FileExistsError: If the wallet file already exists. ValueError: If the seed phrase or wallet type is invalid.

Source code in jmwalletd/src/jmwalletd/wallet_ops.py 
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
async def recover_wallet(
    *,
    wallet_path: Path,
    password: str,
    wallet_type: str,
    seedphrase: str,
    data_dir: Path,
) -> Any:
    """Recover a wallet from a BIP39 seed phrase.

    Returns:
        WalletService instance.

    Raises:
        FileExistsError: If the wallet file already exists.
        ValueError: If the seed phrase or wallet type is invalid.
    """
    from mnemonic import Mnemonic

    from jmwallet.wallet.service import WalletService
    from jmwalletd._backend import get_backend

    if wallet_path.exists():
        raise FileExistsError(f"Wallet file already exists: {wallet_path}")

    mnemo = Mnemonic("english")
    if not mnemo.check(seedphrase):
        msg = "Invalid BIP39 mnemonic seed phrase."
        raise ValueError(msg)

    valid_types = {"sw", "sw-legacy", "sw-fb"}
    if wallet_type not in valid_types:
        msg = f"Invalid wallet type: {wallet_type}. Must be one of {valid_types}"
        raise ValueError(msg)

    backend = await get_backend(
        data_dir=data_dir,
        mnemonic=seedphrase,
        network=_get_network(),
    )

    ws = WalletService(
        mnemonic=seedphrase,
        backend=backend,
        data_dir=data_dir,
        network=_get_network(),
        max_sats_freeze_reuse=_get_max_sats_freeze_reuse(),
    )

    _save_wallet_file(
        wallet_path=wallet_path,
        mnemonic=seedphrase,
        password=password,
        wallet_type=wallet_type,
    )

    # Ensure the watch-only descriptor wallet is loaded in Bitcoin Core
    # and import HD descriptors so sync can find existing UTXOs.
    # Skipped for non-descriptor backends (e.g. neutrino).
    if _is_descriptor_backend(backend):
        await ws.setup_descriptor_wallet()

    # Bond-aware sync so any fidelity bonds recorded in the per-wallet
    # registry are imported and their UTXOs scanned (otherwise recovered
    # bonds would be invisible in /utxos and /display).
    await ws.sync_with_registered_bonds()

    logger.info("Recovered wallet: {}", wallet_path.name)
    return ws