forked from decred/vspd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
database: Store xpub keys in a bucket.
**Warning: This commit contains a database upgrade.** In order to add future support for retiring xpub keys, the database is upgraded such that the keys are now stored in a dedicated bucket which can hold multiple values rather than storing a single key as individual values in the root bucket. A new ID field is added to distinguish between keys. This ID is added to every ticket record in the database in order to track which pubkey was used for each ticket. A new field named "Retired" has also been added to pubkeys. It is a unix timestamp representing the moment the key was retired, or zero for the currently active key.
- Loading branch information
1 parent
1fa81d3
commit 4e41213
Showing
9 changed files
with
208 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| // Copyright (c) 2024 The Decred developers | ||
| // Use of this source code is governed by an ISC | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package database | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
|
|
||
| "github.com/decred/slog" | ||
| bolt "go.etcd.io/bbolt" | ||
| ) | ||
|
|
||
| func xPubBucketUpgrade(db *bolt.DB, log slog.Logger) error { | ||
| log.Infof("Upgrading database to version %d", xPubBucketVersion) | ||
|
|
||
| // feeXPub is the key which was used prior to this upgrade to store the xpub | ||
| // in the root bucket. | ||
| feeXPubK := []byte("feeXPub") | ||
|
|
||
| // lastaddressindex is the key which was used prior to this upgrade to store | ||
| // the index of the last used address in the root bucket. | ||
| lastAddressIndexK := []byte("lastaddressindex") | ||
|
|
||
| // Run the upgrade in a single database transaction so it can be safely | ||
| // rolled back if an error is encountered. | ||
| err := db.Update(func(tx *bolt.Tx) error { | ||
| vspBkt := tx.Bucket(vspBktK) | ||
| ticketBkt := vspBkt.Bucket(ticketBktK) | ||
|
|
||
| // Retrieve the current xpub. | ||
| xpubBytes := vspBkt.Get(feeXPubK) | ||
| if xpubBytes == nil { | ||
| return errors.New("xpub not found") | ||
| } | ||
| feeXPub := string(xpubBytes) | ||
|
|
||
| // Retrieve the current last addr index. Could be nil if this xpub was | ||
| // never used. | ||
| idxBytes := vspBkt.Get(lastAddressIndexK) | ||
| var idx uint32 | ||
| if idxBytes != nil { | ||
| idx = bytesToUint32(idxBytes) | ||
| } | ||
|
|
||
| // Delete the old values from the database. | ||
| err := vspBkt.Delete(feeXPubK) | ||
| if err != nil { | ||
| return fmt.Errorf("could not delete xpub: %w", err) | ||
| } | ||
| err = vspBkt.Delete(lastAddressIndexK) | ||
| if err != nil { | ||
| return fmt.Errorf("could not delete last addr idx: %w", err) | ||
| } | ||
|
|
||
| // Insert the key into the bucket. | ||
| newXpub := FeeXPub{ | ||
| ID: 0, | ||
| Key: feeXPub, | ||
| LastUsedIdx: idx, | ||
| Retired: 0, | ||
| } | ||
| err = insertFeeXPub(tx, newXpub) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to store xpub in new bucket: %w", err) | ||
| } | ||
|
|
||
| // Update all existing tickets with xpub key ID 0. | ||
| err = ticketBkt.ForEachBucket(func(k []byte) error { | ||
| return ticketBkt.Bucket(k).Put(feeAddressXPubIDK, uint32ToBytes(0)) | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("setting ticket xpub ID to 0 failed: %w", err) | ||
| } | ||
|
|
||
| // Update database version. | ||
| err = vspBkt.Put(versionK, uint32ToBytes(xPubBucketVersion)) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to update db version: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| log.Info("Upgrade completed") | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.