forked from decred/dcrdex
-
Notifications
You must be signed in to change notification settings - Fork 0
/
db.go
2453 lines (2234 loc) · 76 KB
/
db.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
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
// This code is available on the terms of the project LICENSE.md file,
// also available online at https://blueoakcouncil.org/license/1.0.0.
package bolt
import (
"bytes"
"context"
"errors"
"fmt"
"io/fs"
"os"
"path/filepath"
"sort"
"strings"
"time"
"decred.org/dcrdex/client/db"
dexdb "decred.org/dcrdex/client/db"
"decred.org/dcrdex/dex"
"decred.org/dcrdex/dex/config"
"decred.org/dcrdex/dex/encode"
"decred.org/dcrdex/dex/encrypt"
"decred.org/dcrdex/dex/order"
"go.etcd.io/bbolt"
)
// getCopy returns a copy of the value for the given key and provided bucket. If
// the key is not found or if an empty slice was loaded, nil is returned. Thus,
// use bkt.Get(key) == nil directly to test for existence of the key. This
// function should be used instead of bbolt.(*Bucket).Get when the read value
// needs to be kept after the transaction, at which time the buffer from Get is
// no longer safe to use.
func getCopy(bkt *bbolt.Bucket, key []byte) []byte {
b := bkt.Get(key)
if len(b) == 0 {
return nil
}
val := make([]byte, len(b))
copy(val, b)
return val
}
// Short names for some commonly used imported functions.
var (
intCoder = encode.IntCoder
bEqual = bytes.Equal
uint16Bytes = encode.Uint16Bytes
uint32Bytes = encode.Uint32Bytes
uint64Bytes = encode.Uint64Bytes
)
// Bolt works on []byte keys and values. These are some commonly used key and
// value encodings.
var (
// bucket keys
appBucket = []byte("appBucket")
accountsBucket = []byte("accounts")
bondIndexesBucket = []byte("bondIndexes")
bondsSubBucket = []byte("bonds") // sub bucket of accounts
disabledAccountsBucket = []byte("disabledAccounts")
activeOrdersBucket = []byte("activeOrders")
archivedOrdersBucket = []byte("orders")
activeMatchesBucket = []byte("activeMatches")
archivedMatchesBucket = []byte("matches")
botProgramsBucket = []byte("botPrograms")
walletsBucket = []byte("wallets")
notesBucket = []byte("notes")
credentialsBucket = []byte("credentials")
// value keys
versionKey = []byte("version")
linkedKey = []byte("linked")
feeProofKey = []byte("feecoin")
statusKey = []byte("status")
baseKey = []byte("base")
quoteKey = []byte("quote")
orderKey = []byte("order")
matchKey = []byte("match")
orderIDKey = []byte("orderID")
matchIDKey = []byte("matchID")
proofKey = []byte("proof")
activeKey = []byte("active")
bondKey = []byte("bond")
confirmedKey = []byte("confirmed")
refundedKey = []byte("refunded")
lockTimeKey = []byte("lockTime")
dexKey = []byte("dex")
updateTimeKey = []byte("utime")
accountKey = []byte("account")
balanceKey = []byte("balance")
walletKey = []byte("wallet")
changeKey = []byte("change")
noteKey = []byte("note")
stampKey = []byte("stamp")
severityKey = []byte("severity")
ackKey = []byte("ack")
swapFeesKey = []byte("swapFees")
maxFeeRateKey = []byte("maxFeeRate")
redeemMaxFeeRateKey = []byte("redeemMaxFeeRate")
redemptionFeesKey = []byte("redeemFees")
accelerationsKey = []byte("accelerations")
typeKey = []byte("type")
seedGenTimeKey = []byte("seedGenTime")
encSeedKey = []byte("encSeed")
encInnerKeyKey = []byte("encInnerKey")
innerKeyParamsKey = []byte("innerKeyParams")
outerKeyParamsKey = []byte("outerKeyParams")
legacyKeyParamsKey = []byte("keyParams")
epochDurKey = []byte("epochDur")
fromVersionKey = []byte("fromVersion")
toVersionKey = []byte("toVersion")
fromSwapConfKey = []byte("fromSwapConf")
toSwapConfKey = []byte("toSwapConf")
optionsKey = []byte("options")
redemptionReservesKey = []byte("redemptionReservesKey")
refundReservesKey = []byte("refundReservesKey")
disabledRateSourceKey = []byte("disabledRateSources")
walletDisabledKey = []byte("walletDisabled")
programKey = []byte("program")
// values
byteTrue = encode.ByteTrue
byteFalse = encode.ByteFalse
byteEpoch = uint16Bytes(uint16(order.OrderStatusEpoch))
byteBooked = uint16Bytes(uint16(order.OrderStatusBooked))
backupDir = "backup"
)
// Opts is a set of options for the DB.
type Opts struct {
BackupOnShutdown bool // default is true
}
var defaultOpts = Opts{
BackupOnShutdown: true,
}
// BoltDB is a bbolt-based database backend for a DEX client. BoltDB satisfies
// the db.DB interface defined at decred.org/dcrdex/client/db.
type BoltDB struct {
*bbolt.DB
opts Opts
log dex.Logger
}
// Check that BoltDB satisfies the db.DB interface.
var _ dexdb.DB = (*BoltDB)(nil)
// NewDB is a constructor for a *BoltDB.
func NewDB(dbPath string, logger dex.Logger, opts ...Opts) (dexdb.DB, error) {
_, err := os.Stat(dbPath)
isNew := os.IsNotExist(err)
db, err := bbolt.Open(dbPath, 0600, &bbolt.Options{Timeout: 3 * time.Second})
if err != nil {
return nil, err
}
// Release the file lock on exit.
bdb := &BoltDB{
DB: db,
opts: defaultOpts,
log: logger,
}
if len(opts) > 0 {
bdb.opts = opts[0]
}
if err = bdb.makeTopLevelBuckets([][]byte{
appBucket, accountsBucket, bondIndexesBucket, disabledAccountsBucket,
activeOrdersBucket, archivedOrdersBucket,
activeMatchesBucket, archivedMatchesBucket,
walletsBucket, notesBucket, credentialsBucket,
botProgramsBucket,
}); err != nil {
return nil, err
}
// If the db is a new one, initialize it with the current DB version.
if isNew {
err := bdb.DB.Update(func(dbTx *bbolt.Tx) error {
bkt := dbTx.Bucket(appBucket)
if bkt == nil {
return fmt.Errorf("app bucket not found")
}
versionB := encode.Uint32Bytes(DBVersion)
err := bkt.Put(versionKey, versionB)
if err != nil {
return err
}
return nil
})
if err != nil {
return nil, err
}
bdb.log.Infof("Created and started database (version = %d, file = %s)", DBVersion, dbPath)
return bdb, nil
}
err = bdb.upgradeDB()
if err != nil {
return nil, err
}
bdb.log.Infof("Started database (version = %d, file = %s)", DBVersion, dbPath)
return bdb, nil
}
func (db *BoltDB) fileSize(path string) int64 {
stat, err := os.Stat(path)
if err != nil {
db.log.Errorf("Failed to stat %v: %v", path, err)
return 0
}
return stat.Size()
}
// Run waits for context cancellation and closes the database.
func (db *BoltDB) Run(ctx context.Context) {
<-ctx.Done() // wait for shutdown to backup and compact
// Create a backup in the backups folder.
if db.opts.BackupOnShutdown {
db.log.Infof("Backing up database...")
if err := db.Backup(); err != nil {
db.log.Errorf("Unable to backup database: %v", err)
}
}
// Only compact the current DB file if there is excessive free space, in
// terms of bytes AND relative to total DB size.
const byteThresh = 1 << 18 // 256 KiB free
const pctThresh = 0.05 // 5% free
var dbSize int64
_ = db.View(func(tx *bbolt.Tx) error {
dbSize = tx.Size() // db size including free bytes
return nil
})
dbStats := db.Stats()
// FreeAlloc is (FreePageN + PendingPageN) * db.Info().PageSize
// FreelistInuse seems to be page header overhead (much smaller). Add them.
// https://github.com/etcd-io/bbolt/blob/020684ea1eb7b5574a8007c8d69605b1de8d9ec4/tx.go#L308-L309
freeBytes := int64(dbStats.FreeAlloc + dbStats.FreelistInuse)
pctFree := float64(freeBytes) / float64(dbSize)
db.log.Debugf("Total DB size %d bytes, %d bytes unused (%.2f%%)",
dbSize, freeBytes, 100*pctFree)
// Only compact if free space is at least the byte threshold AND that fee
// space accounts for a significant percent of the file.
if freeBytes < byteThresh || pctFree < pctThresh {
db.Close()
return
}
// TODO: If we never see trouble with the compacted DB files when dexc
// starts up, we can just compact to the backups folder and copy that backup
// file back on top of the main DB file after it is closed. For now, the
// backup above is a direct (not compacted) copy.
// Compact the database by writing into a temporary file, closing the source
// DB, and overwriting the original with the compacted temporary file.
db.log.Infof("Compacting database to reclaim at least %d bytes...", freeBytes)
srcPath := db.Path() // before db.Close
compFile := srcPath + ".tmp" // deterministic on *same fs*
err := db.BackupTo(compFile, true, true) // overwrite and compact
if err != nil {
db.Close()
db.log.Errorf("Unable to compact database: %v", err)
return
}
db.Close() // close db file at srcPath
initSize, compSize := db.fileSize(srcPath), db.fileSize(compFile)
db.log.Infof("Compacted database file from %v => %v bytes (%.2f%% reduction)",
initSize, compSize, 100*float64(initSize-compSize)/float64(initSize))
err = os.Rename(compFile, srcPath) // compFile => srcPath
if err != nil {
db.log.Errorf("Unable to switch to compacted database: %v", err)
return
}
}
// Recrypt re-encrypts the wallet passwords and account private keys. As a
// convenience, the provided *PrimaryCredentials are stored under the same
// transaction.
func (db *BoltDB) Recrypt(creds *dexdb.PrimaryCredentials, oldCrypter, newCrypter encrypt.Crypter) (walletUpdates map[uint32][]byte, acctUpdates map[string][]byte, err error) {
if err := validateCreds(creds); err != nil {
return nil, nil, err
}
walletUpdates = make(map[uint32][]byte)
acctUpdates = make(map[string][]byte)
return walletUpdates, acctUpdates, db.Update(func(tx *bbolt.Tx) error {
// Updates accounts and wallets.
wallets := tx.Bucket(walletsBucket)
if wallets == nil {
return fmt.Errorf("no wallets bucket")
}
accounts := tx.Bucket(accountsBucket)
if accounts == nil {
return fmt.Errorf("no accounts bucket")
}
if err := wallets.ForEach(func(wid, _ []byte) error {
wBkt := wallets.Bucket(wid)
w, err := makeWallet(wBkt)
if err != nil {
return err
}
if len(w.EncryptedPW) == 0 {
return nil
}
pw, err := oldCrypter.Decrypt(w.EncryptedPW)
if err != nil {
return fmt.Errorf("Decrypt error: %w", err)
}
w.EncryptedPW, err = newCrypter.Encrypt(pw)
if err != nil {
return fmt.Errorf("Encrypt error: %w", err)
}
err = wBkt.Put(walletKey, w.Encode())
if err != nil {
return err
}
walletUpdates[w.AssetID] = w.EncryptedPW
return nil
}); err != nil {
return fmt.Errorf("wallets update error: %w", err)
}
err = accounts.ForEach(func(hostB, _ []byte) error {
acct := accounts.Bucket(hostB)
if acct == nil {
return fmt.Errorf("account bucket %s value not a nested bucket", string(hostB))
}
acctB := getCopy(acct, accountKey)
if acctB == nil {
return fmt.Errorf("empty account found for %s", string(hostB))
}
acctInfo, err := dexdb.DecodeAccountInfo(acctB)
if err != nil {
return err
}
if len(acctInfo.LegacyEncKey) == 0 {
db.log.Warnf("no LegacyEncKey for %s during Recrypt?", string(hostB))
return nil
}
privB, err := oldCrypter.Decrypt(acctInfo.LegacyEncKey)
if err != nil {
return err
}
acctInfo.LegacyEncKey, err = newCrypter.Encrypt(privB)
if err != nil {
return err
}
acctUpdates[acctInfo.Host] = acctInfo.LegacyEncKey
return acct.Put(accountKey, acctInfo.Encode())
})
if err != nil {
return fmt.Errorf("accounts update error: %w", err)
}
// Store the new credentials.
return db.setCreds(tx, creds)
})
}
// SetPrimaryCredentials validates and stores the PrimaryCredentials.
func (db *BoltDB) SetPrimaryCredentials(creds *dexdb.PrimaryCredentials) error {
if err := validateCreds(creds); err != nil {
return err
}
return db.Update(func(tx *bbolt.Tx) error {
return db.setCreds(tx, creds)
})
}
// validateCreds checks that the PrimaryCredentials fields are properly
// populated.
func validateCreds(creds *dexdb.PrimaryCredentials) error {
if len(creds.EncSeed) == 0 {
return errors.New("EncSeed not set")
}
if len(creds.EncInnerKey) == 0 {
return errors.New("EncInnerKey not set")
}
if len(creds.InnerKeyParams) == 0 {
return errors.New("InnerKeyParams not set")
}
if len(creds.OuterKeyParams) == 0 {
return errors.New("OuterKeyParams not set")
}
return nil
}
// primaryCreds reconstructs the *PrimaryCredentials.
func (db *BoltDB) primaryCreds() (creds *dexdb.PrimaryCredentials, err error) {
return creds, db.View(func(tx *bbolt.Tx) error {
bkt := tx.Bucket(credentialsBucket)
if bkt == nil {
return errors.New("no credentials bucket")
}
if bkt.Stats().KeyN == 0 {
return dexdb.ErrNoCredentials
}
creds = &dexdb.PrimaryCredentials{
EncSeed: getCopy(bkt, encSeedKey),
EncInnerKey: getCopy(bkt, encInnerKeyKey),
InnerKeyParams: getCopy(bkt, innerKeyParamsKey),
OuterKeyParams: getCopy(bkt, outerKeyParamsKey),
}
return nil
})
}
// setCreds stores the *PrimaryCredentials.
func (db *BoltDB) setCreds(tx *bbolt.Tx, creds *dexdb.PrimaryCredentials) error {
bkt := tx.Bucket(credentialsBucket)
if bkt == nil {
return errors.New("no credentials bucket")
}
return newBucketPutter(bkt).
put(encSeedKey, creds.EncSeed).
put(encInnerKeyKey, creds.EncInnerKey).
put(innerKeyParamsKey, creds.InnerKeyParams).
put(outerKeyParamsKey, creds.OuterKeyParams).
err()
}
// PrimaryCredentials retrieves the *PrimaryCredentials, if they are stored. It
// is an error if none have been stored.
func (db *BoltDB) PrimaryCredentials() (creds *dexdb.PrimaryCredentials, err error) {
return db.primaryCreds()
}
// SetSeedGenerationTime stores the time the app seed was generated.
func (db *BoltDB) SetSeedGenerationTime(time uint64) error {
return db.Update(func(tx *bbolt.Tx) error {
bkt := tx.Bucket(credentialsBucket)
if bkt == nil {
return errors.New("no credentials bucket")
}
return newBucketPutter(bkt).
put(seedGenTimeKey, uint64Bytes(time)).
err()
})
}
// SeedGenerationTime returns the time the app seed was generated, if it was
// stored. It returns dexdb.ErrNoSeedGenTime if it was not stored.
func (db *BoltDB) SeedGenerationTime() (uint64, error) {
var seedGenTime uint64
return seedGenTime, db.View(func(tx *bbolt.Tx) error {
bkt := tx.Bucket(credentialsBucket)
if bkt == nil {
return errors.New("no credentials bucket")
}
seedGenTimeBytes := bkt.Get(seedGenTimeKey)
if seedGenTimeBytes == nil {
return dexdb.ErrNoSeedGenTime
}
if len(seedGenTimeBytes) != 8 {
return fmt.Errorf("seed generation time length %v, expected 8", len(seedGenTimeBytes))
}
seedGenTime = intCoder.Uint64(seedGenTimeBytes)
return nil
})
}
// ListAccounts returns a list of DEX URLs. The DB is designed to have a single
// account per DEX, so the account itself is identified by the DEX URL.
func (db *BoltDB) ListAccounts() ([]string, error) {
var urls []string
return urls, db.acctsView(func(accts *bbolt.Bucket) error {
c := accts.Cursor()
for acct, _ := c.First(); acct != nil; acct, _ = c.Next() {
acctBkt := accts.Bucket(acct)
if acctBkt == nil {
return fmt.Errorf("account bucket %s value not a nested bucket", string(acct))
}
if bEqual(acctBkt.Get(activeKey), byteTrue) {
urls = append(urls, string(acct))
}
}
return nil
})
}
func loadAccountInfo(acct *bbolt.Bucket, log dex.Logger) (*db.AccountInfo, error) {
acctB := getCopy(acct, accountKey)
if acctB == nil {
return nil, fmt.Errorf("empty account")
}
acctInfo, err := dexdb.DecodeAccountInfo(acctB)
if err != nil {
return nil, err
}
acctInfo.LegacyFeePaid = len(acct.Get(feeProofKey)) > 0
bondsBkt := acct.Bucket(bondsSubBucket)
if bondsBkt == nil {
return acctInfo, nil // no bonds, OK for legacy account
}
c := bondsBkt.Cursor()
for bondUID, _ := c.First(); bondUID != nil; bondUID, _ = c.Next() {
bond := bondsBkt.Bucket(bondUID)
if acct == nil {
return nil, fmt.Errorf("bond sub-bucket %x not a nested bucket", bondUID)
}
dbBond, err := dexdb.DecodeBond(getCopy(bond, bondKey))
if err != nil {
log.Errorf("Invalid bond data encoding: %v", err)
continue
}
dbBond.Confirmed = bEqual(bond.Get(confirmedKey), byteTrue)
dbBond.Refunded = bEqual(bond.Get(refundedKey), byteTrue)
acctInfo.Bonds = append(acctInfo.Bonds, dbBond)
}
return acctInfo, nil
}
// Accounts returns a list of DEX Accounts. The DB is designed to have a single
// account per DEX, so the account itself is identified by the DEX host. TODO:
// allow bonds filter based on lockTime.
func (db *BoltDB) Accounts() ([]*dexdb.AccountInfo, error) {
var accounts []*dexdb.AccountInfo
return accounts, db.acctsView(func(accts *bbolt.Bucket) error {
c := accts.Cursor()
for acctKey, _ := c.First(); acctKey != nil; acctKey, _ = c.Next() {
acct := accts.Bucket(acctKey)
if acct == nil {
return fmt.Errorf("account bucket %s value not a nested bucket", string(acctKey))
}
acctInfo, err := loadAccountInfo(acct, db.log)
if err != nil {
return err
}
accounts = append(accounts, acctInfo)
}
return nil
})
}
// Account gets the AccountInfo associated with the specified DEX address.
func (db *BoltDB) Account(url string) (*dexdb.AccountInfo, error) {
var acctInfo *dexdb.AccountInfo
acctKey := []byte(url)
return acctInfo, db.acctsView(func(accts *bbolt.Bucket) (err error) {
acct := accts.Bucket(acctKey)
if acct == nil {
return dexdb.ErrAcctNotFound
}
acctInfo, err = loadAccountInfo(acct, db.log)
return
})
}
// CreateAccount saves the AccountInfo. If an account already exists for this
// DEX, it will return an error.
func (db *BoltDB) CreateAccount(ai *dexdb.AccountInfo) error {
if ai.Host == "" {
return fmt.Errorf("empty host not allowed")
}
if ai.DEXPubKey == nil {
return fmt.Errorf("nil DEXPubKey not allowed")
}
if len(ai.EncKey()) == 0 {
return fmt.Errorf("zero-length EncKey not allowed")
}
return db.acctsUpdate(func(accts *bbolt.Bucket) error {
acct, err := accts.CreateBucket([]byte(ai.Host))
if err != nil {
return fmt.Errorf("failed to create account bucket")
}
err = acct.Put(accountKey, ai.Encode())
if err != nil {
return fmt.Errorf("accountKey put error: %w", err)
}
err = acct.Put(activeKey, byteTrue) // huh?
if err != nil {
return fmt.Errorf("activeKey put error: %w", err)
}
bonds, err := acct.CreateBucket(bondsSubBucket)
if err != nil {
return fmt.Errorf("unable to create bonds sub-bucket for account for %s: %w", ai.Host, err)
}
for _, bond := range ai.Bonds {
bondUID := bond.UniqueID()
bondBkt, err := bonds.CreateBucketIfNotExists(bondUID)
if err != nil {
return fmt.Errorf("failed to create bond %x bucket: %w", bondUID, err)
}
err = db.storeBond(bondBkt, bond)
if err != nil {
return err
}
}
return nil
})
}
// NextBondKeyIndex returns the next bond key index and increments the stored
// value so that subsequent calls will always return a higher index.
func (db *BoltDB) NextBondKeyIndex(assetID uint32) (uint32, error) {
var bondIndex uint32
return bondIndex, db.Update(func(tx *bbolt.Tx) error {
bkt := tx.Bucket(bondIndexesBucket)
if bkt == nil {
return errors.New("no bond indexes bucket")
}
thisBondIdxKey := uint32Bytes(assetID)
bondIndexB := bkt.Get(thisBondIdxKey)
if len(bondIndexB) != 0 {
bondIndex = intCoder.Uint32(bondIndexB)
}
return bkt.Put(thisBondIdxKey, uint32Bytes(bondIndex+1))
})
}
// UpdateAccountInfo updates the account info for an existing account with
// the same Host as the parameter. If no account exists with this host,
// an error is returned.
func (db *BoltDB) UpdateAccountInfo(ai *dexdb.AccountInfo) error {
return db.acctsUpdate(func(accts *bbolt.Bucket) error {
acct := accts.Bucket([]byte(ai.Host))
if acct == nil {
return fmt.Errorf("account not found for %s", ai.Host)
}
return acct.Put(accountKey, ai.Encode())
})
}
// deleteAccount removes the account by host.
func (db *BoltDB) deleteAccount(host string) error {
acctKey := []byte(host)
return db.acctsUpdate(func(accts *bbolt.Bucket) error {
return accts.DeleteBucket(acctKey)
})
}
// DisableAccount disables the account associated with the given host
// and archives it. The Accounts and Account methods will no longer find
// the disabled account.
//
// TODO: Add disabledAccounts method for retrieval of a disabled account and
// possible recovery of the account data.
func (db *BoltDB) DisableAccount(url string) error {
// Get account's info.
ai, err := db.Account(url)
if err != nil {
return err
}
// Copy AccountInfo to disabledAccounts.
err = db.disabledAcctsUpdate(func(disabledAccounts *bbolt.Bucket) error {
return disabledAccounts.Put(ai.EncKey(), ai.Encode())
})
if err != nil {
return err
}
// WARNING/TODO: account proof (fee paid info) not saved!
err = db.deleteAccount(ai.Host)
if err != nil {
if errors.Is(err, bbolt.ErrBucketNotFound) {
db.log.Warnf("Cannot delete account from active accounts"+
" table. Host: not found. %s err: %v", ai.Host, err)
} else {
return err
}
}
return nil
}
// disabledAccount gets the AccountInfo from disabledAccount associated with
// the specified EncKey.
func (db *BoltDB) disabledAccount(encKey []byte) (*dexdb.AccountInfo, error) {
var acctInfo *dexdb.AccountInfo
return acctInfo, db.disabledAcctsView(func(accts *bbolt.Bucket) error {
acct := accts.Get(encKey)
if acct == nil {
return fmt.Errorf("account not found for key")
}
var err error
acctInfo, err = dexdb.DecodeAccountInfo(acct)
if err != nil {
return err
}
return nil
})
}
func (db *BoltDB) AccountProof(url string) (*dexdb.AccountProof, error) {
var acctProof *dexdb.AccountProof
acctKey := []byte(url)
return acctProof, db.acctsView(func(accts *bbolt.Bucket) error {
acct := accts.Bucket(acctKey)
if acct == nil {
return fmt.Errorf("account not found for %s", url)
}
var err error
acctProof, err = dexdb.DecodeAccountProof(getCopy(acct, feeProofKey))
if err != nil {
return err
}
return nil
})
}
// StoreAccountProof marks the account as paid with the legacy registration fee
// by setting the "fee proof".
func (db *BoltDB) StoreAccountProof(proof *dexdb.AccountProof) error {
acctKey := []byte(proof.Host)
return db.acctsUpdate(func(accts *bbolt.Bucket) error {
acct := accts.Bucket(acctKey)
if acct == nil {
return fmt.Errorf("account not found for %s", proof.Host)
}
return acct.Put(feeProofKey, proof.Encode())
})
}
// acctsView is a convenience function for reading from the account bucket.
func (db *BoltDB) acctsView(f bucketFunc) error {
return db.withBucket(accountsBucket, db.View, f)
}
// acctsUpdate is a convenience function for updating the account bucket.
func (db *BoltDB) acctsUpdate(f bucketFunc) error {
return db.withBucket(accountsBucket, db.Update, f)
}
// disabledAcctsView is a convenience function for reading from the disabledAccounts bucket.
func (db *BoltDB) disabledAcctsView(f bucketFunc) error {
return db.withBucket(disabledAccountsBucket, db.View, f)
}
// disabledAcctsUpdate is a convenience function for inserting into the disabledAccounts bucket.
func (db *BoltDB) disabledAcctsUpdate(f bucketFunc) error {
return db.withBucket(disabledAccountsBucket, db.Update, f)
}
func (db *BoltDB) storeBond(bondBkt *bbolt.Bucket, bond *db.Bond) error {
err := bondBkt.Put(bondKey, bond.Encode())
if err != nil {
return fmt.Errorf("bondKey put error: %w", err)
}
confirmed := encode.ByteFalse
if bond.Confirmed {
confirmed = encode.ByteTrue
}
err = bondBkt.Put(confirmedKey, confirmed)
if err != nil {
return fmt.Errorf("confirmedKey put error: %w", err)
}
refunded := encode.ByteFalse
if bond.Refunded {
refunded = encode.ByteTrue
}
err = bondBkt.Put(refundedKey, refunded)
if err != nil {
return fmt.Errorf("refundedKey put error: %w", err)
}
err = bondBkt.Put(lockTimeKey, uint64Bytes(bond.LockTime)) // also in bond encoding
if err != nil {
return fmt.Errorf("lockTimeKey put error: %w", err)
}
return nil
}
// AddBond saves a new Bond for an existing DEX account.
func (db *BoltDB) AddBond(host string, bond *db.Bond) error {
acctKey := []byte(host)
return db.acctsUpdate(func(accts *bbolt.Bucket) error {
acct := accts.Bucket(acctKey)
if acct == nil {
return fmt.Errorf("account not found for %s", host)
}
bonds, err := acct.CreateBucketIfNotExists(bondsSubBucket)
if err != nil {
return fmt.Errorf("unable to access bonds sub-bucket for account for %s: %w", host, err)
}
bondUID := bond.UniqueID()
bondBkt, err := bonds.CreateBucketIfNotExists(bondUID)
if err != nil {
return fmt.Errorf("failed to create bond %x bucket: %w", bondUID, err)
}
return db.storeBond(bondBkt, bond)
})
}
func (db *BoltDB) setBondFlag(host string, assetID uint32, bondCoinID []byte, flagKey []byte) error {
acctKey := []byte(host)
return db.acctsUpdate(func(accts *bbolt.Bucket) error {
acct := accts.Bucket(acctKey)
if acct == nil {
return fmt.Errorf("account not found for %s", host)
}
bonds := acct.Bucket(bondsSubBucket)
if bonds == nil {
return fmt.Errorf("bonds sub-bucket not found for account for %s", host)
}
bondUID := dexdb.BondUID(assetID, bondCoinID)
bondBkt := bonds.Bucket(bondUID)
if bondBkt == nil {
return fmt.Errorf("bond bucket does not exist: %x", bondUID)
}
return bondBkt.Put(flagKey, byteTrue)
})
}
// ConfirmBond marks a DEX account bond as confirmed by the DEX.
func (db *BoltDB) ConfirmBond(host string, assetID uint32, bondCoinID []byte) error {
return db.setBondFlag(host, assetID, bondCoinID, confirmedKey)
}
// BondRefunded marks a DEX account bond as refunded by the client wallet.
func (db *BoltDB) BondRefunded(host string, assetID uint32, bondCoinID []byte) error {
return db.setBondFlag(host, assetID, bondCoinID, refundedKey)
}
// UpdateOrder saves the order information in the database. Any existing order
// info for the same order ID will be overwritten without indication.
func (db *BoltDB) UpdateOrder(m *dexdb.MetaOrder) error {
ord, md := m.Order, m.MetaData
if md.Status == order.OrderStatusUnknown {
return fmt.Errorf("cannot set order %s status to unknown", ord.ID())
}
if md.Host == "" {
return fmt.Errorf("empty DEX not allowed")
}
if len(md.Proof.DEXSig) == 0 {
return fmt.Errorf("cannot save order without DEX signature")
}
return db.ordersUpdate(func(ob, archivedOB *bbolt.Bucket) error {
oid := ord.ID()
// Create or move an order bucket based on order status. Active
// orders go in the activeOrdersBucket. Inactive orders go in the
// archivedOrdersBucket.
bkt := ob
whichBkt := "active"
inactive := !md.Status.IsActive()
if inactive {
// No order means that it was never added to the active
// orders bucket, or UpdateOrder was already called on
// this order after it became inactive.
if ob.Bucket(oid[:]) != nil {
// This order now belongs in the archived orders
// bucket. Delete it from active orders.
if err := ob.DeleteBucket(oid[:]); err != nil {
return fmt.Errorf("archived order bucket delete error: %w", err)
}
}
bkt = archivedOB
whichBkt = "archived"
}
oBkt, err := bkt.CreateBucketIfNotExists(oid[:])
if err != nil {
return fmt.Errorf("%s bucket error: %w", whichBkt, err)
}
err = newBucketPutter(oBkt).
put(baseKey, uint32Bytes(ord.Base())).
put(quoteKey, uint32Bytes(ord.Quote())).
put(dexKey, []byte(md.Host)).
put(typeKey, []byte{byte(ord.Type())}).
put(orderKey, order.EncodeOrder(ord)).
put(epochDurKey, uint64Bytes(md.EpochDur)).
put(fromVersionKey, uint32Bytes(md.FromVersion)).
put(toVersionKey, uint32Bytes(md.ToVersion)).
put(fromSwapConfKey, uint32Bytes(md.FromSwapConf)).
put(toSwapConfKey, uint32Bytes(md.ToSwapConf)).
put(redeemMaxFeeRateKey, uint64Bytes(md.RedeemMaxFeeRate)).
put(maxFeeRateKey, uint64Bytes(md.MaxFeeRate)).
err()
if err != nil {
return err
}
return updateOrderMetaData(oBkt, md)
})
}
// ActiveOrders retrieves all orders which appear to be in an active state,
// which is either in the epoch queue or in the order book.
func (db *BoltDB) ActiveOrders() ([]*dexdb.MetaOrder, error) {
return db.filteredOrders(func(_ *bbolt.Bucket) bool {
return true
}, false)
}
// AccountOrders retrieves all orders associated with the specified DEX. n = 0
// applies no limit on number of orders returned. since = 0 is equivalent to
// disabling the time filter, since no orders were created before 1970.
func (db *BoltDB) AccountOrders(dex string, n int, since uint64) ([]*dexdb.MetaOrder, error) {
dexB := []byte(dex)
if n == 0 && since == 0 {
return db.filteredOrders(func(oBkt *bbolt.Bucket) bool {
return bEqual(dexB, oBkt.Get(dexKey))
}, true)
}
sinceB := uint64Bytes(since)
return db.newestOrders(n, func(_ []byte, oBkt *bbolt.Bucket) bool {
timeB := oBkt.Get(updateTimeKey)
return bEqual(dexB, oBkt.Get(dexKey)) && bytes.Compare(timeB, sinceB) >= 0
}, true)
}
// MarketOrders retrieves all orders for the specified DEX and market. n = 0
// applies no limit on number of orders returned. since = 0 is equivalent to
// disabling the time filter, since no orders were created before 1970.
func (db *BoltDB) MarketOrders(dex string, base, quote uint32, n int, since uint64) ([]*dexdb.MetaOrder, error) {
dexB := []byte(dex)
baseB := uint32Bytes(base)
quoteB := uint32Bytes(quote)
if n == 0 && since == 0 {
return db.marketOrdersAll(dexB, baseB, quoteB)
}
return db.marketOrdersSince(dexB, baseB, quoteB, n, since)
}
// ActiveDEXOrders retrieves all orders for the specified DEX.
func (db *BoltDB) ActiveDEXOrders(dex string) ([]*dexdb.MetaOrder, error) {
dexB := []byte(dex)
return db.filteredOrders(func(oBkt *bbolt.Bucket) bool {
return bEqual(dexB, oBkt.Get(dexKey))
}, false)
}
// marketOrdersAll retrieves all orders for the specified DEX and market.
func (db *BoltDB) marketOrdersAll(dexB, baseB, quoteB []byte) ([]*dexdb.MetaOrder, error) {
return db.filteredOrders(func(oBkt *bbolt.Bucket) bool {
return bEqual(dexB, oBkt.Get(dexKey)) && bEqual(baseB, oBkt.Get(baseKey)) &&
bEqual(quoteB, oBkt.Get(quoteKey))
}, true)
}
// marketOrdersSince grabs market orders with optional filters for maximum count
// and age. The sort order is always newest first. If n is 0, there is no limit
// to the number of orders returned. If using with both n = 0, and since = 0,
// use marketOrdersAll instead.
func (db *BoltDB) marketOrdersSince(dexB, baseB, quoteB []byte, n int, since uint64) ([]*dexdb.MetaOrder, error) {
sinceB := uint64Bytes(since)
return db.newestOrders(n, func(_ []byte, oBkt *bbolt.Bucket) bool {
timeB := oBkt.Get(updateTimeKey)
return bEqual(dexB, oBkt.Get(dexKey)) && bEqual(baseB, oBkt.Get(baseKey)) &&
bEqual(quoteB, oBkt.Get(quoteKey)) && bytes.Compare(timeB, sinceB) >= 0
}, true)
}
// newestOrders returns the n newest orders, filtered with a supplied filter
// function. Each order's bucket is provided to the filter, and a boolean true
// return value indicates the order should is eligible to be decoded and
// returned.
func (db *BoltDB) newestOrders(n int, filter func([]byte, *bbolt.Bucket) bool, includeArchived bool) ([]*dexdb.MetaOrder, error) {
orders := make([]*dexdb.MetaOrder, 0, n)
return orders, db.ordersView(func(ob, archivedOB *bbolt.Bucket) error {
buckets := []*bbolt.Bucket{ob}
if includeArchived {
buckets = append(buckets, archivedOB)
}
trios := newestBuckets(buckets, n, updateTimeKey, filter)
for _, trio := range trios {
o, err := decodeOrderBucket(trio.k, trio.b)