/
walletbase.go
258 lines (216 loc) · 7.39 KB
/
walletbase.go
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
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
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
package asset
import (
"bytes"
"fmt"
"sync"
"decred.org/dcrwallet/v3/walletseed"
"github.com/decred/slog"
"github.com/itswisdomagain/libwallet/walletdata"
)
const (
walletTraitsDBKey = "traits"
encryptedSeedDBKey = "encryptedSeed"
accountDiscoveryRequiredDBKey = "accountDiscoveryRequired"
)
type WalletBase[Tx any] struct {
// UserConfigDB is publicly embedded, so consumers can directly read from or
// write to the user config db.
walletdata.UserConfigDB
// TxIndexDB is embedded so consumers can call tx indexing methods directly.
// TxIndexDB may be nil and calling tx indexing methods when this field is
// nil may panic.
walletdata.TxIndexDB[Tx]
// db is private, for internal use only.
db walletdata.WalletConfigDB
log slog.Logger
dataDir string
network Network
mtx sync.Mutex
traits WalletTrait
encryptedSeed []byte
accountDiscoveryRequired bool
*syncHelper
}
// NewWalletBase initializes a WalletBase using the information provided. The
// wallet's seed is encrypted and saved, along with other basic wallet info.
func NewWalletBase[Tx any](params OpenWalletParams[Tx], seed, walletPass []byte, traits WalletTrait) (*WalletBase[Tx], error) {
isWatchOnly, isRestored := isWatchOnly(traits), isRestored(traits)
if isWatchOnly && isRestored {
return nil, fmt.Errorf("invalid wallet traits: restored wallet cannot be watch only")
}
hasSeedAndWalletPass := len(seed) > 0 || len(walletPass) > 0
switch {
case isWatchOnly && hasSeedAndWalletPass:
return nil, fmt.Errorf("invalid arguments for watch only wallet")
case !isWatchOnly && !hasSeedAndWalletPass:
return nil, fmt.Errorf("seed AND private passphrase are required")
}
var encryptedSeed []byte
var err error
if !isWatchOnly {
encryptedSeed, err = EncryptData(seed, walletPass)
if err != nil {
return nil, fmt.Errorf("seed encryption error: %v", err)
}
}
// Account discovery is only required for restored wallets.
accountDiscoveryRequired := isRestored
// Save the initial data to db.
dbData := map[string]any{
walletTraitsDBKey: traits,
accountDiscoveryRequiredDBKey: accountDiscoveryRequired,
}
if len(encryptedSeed) > 0 {
dbData[encryptedSeedDBKey] = encryptedSeed
}
for key, value := range dbData {
if err := params.WalletConfigDB.SaveWalletConfigValue(key, value); err != nil {
return nil, fmt.Errorf("error saving wallet.%s to db: %v", key, err)
}
}
return &WalletBase[Tx]{
UserConfigDB: params.UserConfigDB,
TxIndexDB: params.TxIndexDB,
db: params.WalletConfigDB,
log: params.Logger,
dataDir: params.DataDir,
network: params.Net,
traits: traits,
encryptedSeed: encryptedSeed,
accountDiscoveryRequired: accountDiscoveryRequired,
syncHelper: &syncHelper{log: params.Logger},
}, nil
}
// OpenWalletBase loads basic information for an existing wallet from the
// provided params.
func OpenWalletBase[Tx any](params OpenWalletParams[Tx]) (*WalletBase[Tx], error) {
w := &WalletBase[Tx]{
UserConfigDB: params.UserConfigDB,
TxIndexDB: params.TxIndexDB,
db: params.WalletConfigDB,
log: params.Logger,
dataDir: params.DataDir,
network: params.Net,
syncHelper: &syncHelper{log: params.Logger},
}
readFromDB := func(key string, wFieldPtr any) error {
if err := params.WalletConfigDB.ReadWalletConfigValue(key, wFieldPtr); err != nil {
return fmt.Errorf("error reading wallet.%s from db: %v", key, err)
}
return nil
}
if err := readFromDB(encryptedSeedDBKey, &w.encryptedSeed); err != nil {
return nil, err
}
if err := readFromDB(walletTraitsDBKey, &w.traits); err != nil {
return nil, err
}
if err := readFromDB(accountDiscoveryRequiredDBKey, &w.accountDiscoveryRequired); err != nil {
return nil, err
}
return w, nil
}
func (w *WalletBase[_]) DataDir() string {
return w.dataDir
}
func (w *WalletBase[_]) Network() Network {
return w.network
}
// DecryptSeed decrypts the encrypted wallet seed using the provided passphrase.
func (w *WalletBase[_]) DecryptSeed(passphrase []byte) (string, error) {
w.mtx.Lock()
defer w.mtx.Unlock()
if w.encryptedSeed == nil {
return "", fmt.Errorf("seed has been verified")
}
seed, err := DecryptData(w.encryptedSeed, passphrase)
if err != nil {
return "", err
}
return walletseed.EncodeMnemonic(seed), nil
}
func (w *WalletBase[_]) ReEncryptSeed(oldPass, newPass []byte) error {
w.mtx.Lock()
defer w.mtx.Unlock()
if w.encryptedSeed == nil {
return nil
}
reEncryptedSeed, err := ReEncryptData(w.encryptedSeed, oldPass, newPass)
if err != nil {
return err
}
if err = w.db.SaveWalletConfigValue(encryptedSeedDBKey, reEncryptedSeed); err != nil {
w.log.Errorf("db.SaveWalletConfigValue(encryptedSeed) error: %v", err)
return fmt.Errorf("database error")
}
w.encryptedSeed = reEncryptedSeed
return nil
}
// SeedVerificationRequired is true if the seed for this wallet is yet to be
// verified by the owner. The wallet's seed is saved in an encrypted form until
// it is verified.
func (w *WalletBase[_]) SeedVerificationRequired() bool {
w.mtx.Lock()
defer w.mtx.Unlock()
return len(w.encryptedSeed) > 0
}
// VerifySeed decrypts the encrypted wallet seed using the provided passphrase
// and compares it with the provided seedMnemonic. If it's a match, the wallet
// seed will no longer be saved.
func (w *WalletBase[_]) VerifySeed(seedMnemonic string, passphrase []byte) (bool, error) {
seedToCompare, err := walletseed.DecodeUserInput(seedMnemonic)
if err != nil {
return false, fmt.Errorf("invalid seed provided")
}
w.mtx.Lock()
defer w.mtx.Unlock()
if w.encryptedSeed == nil {
return false, fmt.Errorf("seed has been verified")
}
seed, err := DecryptData(w.encryptedSeed, passphrase)
if err != nil {
return false, err
}
if !bytes.Equal(seed, seedToCompare) {
return false, fmt.Errorf("incorrect seed provided")
}
if err = w.db.DeleteWalletConfigValue(encryptedSeedDBKey); err != nil {
w.log.Errorf("db.DeleteWalletConfigValue(encryptedSeed) error: %v", err)
return false, fmt.Errorf("database error")
}
w.encryptedSeed = nil
return true, nil
}
func (w *WalletBase[_]) IsWatchOnly() bool {
w.mtx.Lock()
defer w.mtx.Unlock()
return isWatchOnly(w.traits)
}
func (w *WalletBase[_]) IsRestored() bool {
w.mtx.Lock()
defer w.mtx.Unlock()
return isRestored(w.traits)
}
func (w *WalletBase[_]) AccountDiscoveryRequired() bool {
w.mtx.Lock()
defer w.mtx.Unlock()
return w.accountDiscoveryRequired
}
func (w *WalletBase[_]) MarkAccountDiscoveryComplete() {
w.mtx.Lock()
defer w.mtx.Unlock()
w.accountDiscoveryRequired = false
if err := w.db.SaveWalletConfigValue(accountDiscoveryRequiredDBKey, w.accountDiscoveryRequired); err != nil {
w.log.Errorf("error marking wallet discovery complete: %v", err)
}
}
// ReadUserConfigBoolValue is a helper method for reading a bool user config
// value from the wallet's config db.
func (w *WalletBase[_]) ReadUserConfigBoolValue(key string, defaultValue ...bool) bool {
return walletdata.ReadUserConfigValue(w, key, defaultValue...)
}
// ReadUserConfigStringValue is a helper method for reading a string user config
// value from the wallet's config db.
func (w *WalletBase[_]) ReadUserConfigStringValue(key string, defaultValue ...string) string {
return walletdata.ReadUserConfigValue(w, key, defaultValue...)
}