upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/src/walletcmd.h
blob: 89834d8c42490de9ccd7731bb7b40d1f4e4222f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// Copyright (c) 2026 Bitflash developers
// Distributed under the MIT/X11 software license.
//
// Recovery-phrase commands. Both run against a loaded wallet and then exit;
// neither starts the node.

#ifndef BITFLASH_WALLETCMD_H
#define BITFLASH_WALLETCMD_H

#include <string>

// Create a phrase for a wallet that does not have one, install the seed, and
// show the words once. Refuses if a phrase already exists. Returns 0 on success.
int CmdNewPhrase();

// Install the seed a phrase describes, derive forward looking for used
// addresses, and rescan the chain so their coins appear. Returns 0 on success.
int CmdRestorePhrase(const std::string& strMnemonic, int nMinDepth = 0);

// Called once per batch with how many addresses have been derived so far and
// how many transactions the wallet now holds.
typedef void (*RestoreProgressFn)(void* pArg, int nDerived, int nRecovered);

// The restore itself, shared by the command and the GUI so the two cannot
// drift apart. Returns false without touching the wallet if the chain is not
// loaded or the phrase is not valid.
bool RestoreFromPhrase(const std::string& strMnemonic,
                       int nMinDepth,
                       RestoreProgressFn fnProgress,
                       void* pArg,
                       std::string& strErrorRet,
                       int& nRecoveredRet,
                       int& nDerivedRet);

// Take the next address from the key pool and print it. With a recovery phrase
// installed the address is derived, so the phrase can bring back whatever is
// paid to it.
int CmdNewAddress();

// Diagnostic: print the first nCount addresses this wallet's phrase derives.
int CmdShowDerived(int nCount);

#endif