waddrmgr/db: add birthday block within syncBucket

In this commit, we add a new key/value pair within the waddrmgr's
syncBucket that will represent the birthday block of the wallet. This
can then be used to force rescans from this point, rather than from the
genesis block.
This commit is contained in:
Wilmer Paulino 2018-11-05 17:02:26 -08:00
parent 9eec895db8
commit e9d24382d6
No known key found for this signature in database
GPG key ID: 6DF57B9F9514972F
2 changed files with 67 additions and 14 deletions

View file

@ -255,6 +255,7 @@ var (
syncedToName = []byte("syncedto") syncedToName = []byte("syncedto")
startBlockName = []byte("startblock") startBlockName = []byte("startblock")
birthdayName = []byte("birthday") birthdayName = []byte("birthday")
birthdayBlockName = []byte("birthdayblock")
) )
// uint32ToBytes converts a 32 bit unsigned integer into a 4-byte slice in // uint32ToBytes converts a 32 bit unsigned integer into a 4-byte slice in
@ -1929,32 +1930,80 @@ func putStartBlock(ns walletdb.ReadWriteBucket, bs *BlockStamp) error {
// fetchBirthday loads the manager's bithday timestamp from the database. // fetchBirthday loads the manager's bithday timestamp from the database.
func fetchBirthday(ns walletdb.ReadBucket) (time.Time, error) { func fetchBirthday(ns walletdb.ReadBucket) (time.Time, error) {
bucket := ns.NestedReadBucket(syncBucketName)
var t time.Time var t time.Time
buf := bucket.Get(birthdayName) bucket := ns.NestedReadBucket(syncBucketName)
if len(buf) != 8 { birthdayTimestamp := bucket.Get(birthdayName)
if len(birthdayTimestamp) != 8 {
str := "malformed birthday stored in database" str := "malformed birthday stored in database"
return t, managerError(ErrDatabase, str, nil) return t, managerError(ErrDatabase, str, nil)
} }
t = time.Unix(int64(binary.BigEndian.Uint64(buf)), 0) t = time.Unix(int64(binary.BigEndian.Uint64(birthdayTimestamp)), 0)
return t, nil return t, nil
} }
// putBirthday stores the provided birthday timestamp to the database. // putBirthday stores the provided birthday timestamp to the database.
func putBirthday(ns walletdb.ReadWriteBucket, t time.Time) error { func putBirthday(ns walletdb.ReadWriteBucket, t time.Time) error {
var birthdayTimestamp [8]byte
binary.BigEndian.PutUint64(birthdayTimestamp[:], uint64(t.Unix()))
bucket := ns.NestedReadWriteBucket(syncBucketName) bucket := ns.NestedReadWriteBucket(syncBucketName)
if err := bucket.Put(birthdayName, birthdayTimestamp[:]); err != nil {
buf := make([]byte, 8)
binary.BigEndian.PutUint64(buf, uint64(t.Unix()))
err := bucket.Put(birthdayName, buf)
if err != nil {
str := "failed to store birthday" str := "failed to store birthday"
return managerError(ErrDatabase, str, err) return managerError(ErrDatabase, str, err)
} }
return nil
}
// fetchBirthdayBlock retrieves the birthday block from the database.
//
// The block is serialized as follows:
// [0:4] block height
// [4:36] block hash
// [36:44] block timestamp
func fetchBirthdayBlock(ns walletdb.ReadBucket) (BlockStamp, error) {
var block BlockStamp
bucket := ns.NestedReadBucket(syncBucketName)
birthdayBlock := bucket.Get(birthdayBlockName)
if birthdayBlock == nil {
str := "birthday block not set"
return block, managerError(ErrBirthdayBlockNotSet, str, nil)
}
if len(birthdayBlock) != 44 {
str := "malformed birthday block stored in database"
return block, managerError(ErrDatabase, str, nil)
}
block.Height = int32(binary.BigEndian.Uint32(birthdayBlock[:4]))
copy(block.Hash[:], birthdayBlock[4:36])
t := int64(binary.BigEndian.Uint64(birthdayBlock[36:]))
block.Timestamp = time.Unix(t, 0)
return block, nil
}
// putBirthdayBlock stores the provided birthday block to the database.
//
// The block is serialized as follows:
// [0:4] block height
// [4:36] block hash
// [36:44] block timestamp
func putBirthdayBlock(ns walletdb.ReadWriteBucket, block BlockStamp) error {
var birthdayBlock [44]byte
binary.BigEndian.PutUint32(birthdayBlock[:4], uint32(block.Height))
copy(birthdayBlock[4:36], block.Hash[:])
binary.BigEndian.PutUint64(birthdayBlock[36:], uint64(block.Timestamp.Unix()))
bucket := ns.NestedReadWriteBucket(syncBucketName)
if err := bucket.Put(birthdayBlockName, birthdayBlock[:]); err != nil {
str := "failed to store birthday block"
return managerError(ErrDatabase, str, err)
}
return nil return nil
} }

View file

@ -131,6 +131,10 @@ const (
// ErrScopeNotFound is returned when a target scope cannot be found // ErrScopeNotFound is returned when a target scope cannot be found
// within the database. // within the database.
ErrScopeNotFound ErrScopeNotFound
// ErrBirthdayBlockNotSet is returned when we attempt to retrieve the
// wallet's birthday but it has not been set yet.
ErrBirthdayBlockNotSet
) )
// Map of ErrorCode values back to their constant names for pretty printing. // Map of ErrorCode values back to their constant names for pretty printing.