d98fc8319f
The legacy ticket database, which was GOB serialized and stored on shut down, has been removed. Ticket state information is now held in a stake node, which acts as a modularized "black box" to contain all information about the state of the stake system. Stake nodes are now a component of the blockchain blockNode struct, and are updated with them. Stake nodes, like their internal treap primitives, are immutable objects that are created with their connect and disconnect node functions. The blockchain database now stores all information about the stake state of the best node in the block database. The blockchain makes the assumption that the stake state of the best node is known at any given time. If the states of former blocks or sidechains must be evaluated, this can be achieved by iterating backwards along the blockchain from the best node, and then connecting stake nodes iteratively if necessary. Performance improvements with this new module are dramatic. The long delays on start up and shut down are removed. Blockchain synchronization time is improved approximately 5-10x on the mainnet chain. The state of the database is atomic, so unexpected shut downs should no longer have the ability to disrupt the chain state. An upgrade path has been added for version 1 blockchain databases. Users with this blockchain database will automatically update when they start their clients.
96 lines
3.0 KiB
Go
96 lines
3.0 KiB
Go
// Copyright (c) 2015-2016 The Decred developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package ticketdb
|
|
|
|
import (
|
|
"fmt"
|
|
)
|
|
|
|
// ErrorCode identifies a kind of error.
|
|
type ErrorCode int
|
|
|
|
// These constants are used to identify a specific RuleError.
|
|
const (
|
|
// ErrUndoDataShortRead indicates that the given undo serialized data
|
|
// was took small.
|
|
ErrUndoDataShortRead = iota
|
|
|
|
// ErrUndoDataNoEntries indicates that the data for undoing ticket data
|
|
// in a serialized entry was corrupt.
|
|
ErrUndoDataCorrupt
|
|
|
|
// ErrTicketHashesShortRead indicates that the given ticket hashes
|
|
// serialized data was took small.
|
|
ErrTicketHashesShortRead
|
|
|
|
// ErrTicketHashesCorrupt indicates that the data for ticket hashes
|
|
// in a serialized entry was corrupt.
|
|
ErrTicketHashesCorrupt
|
|
|
|
// ErrUninitializedBucket indicates that a database bucket was not
|
|
// initialized and therefore could not be written to or read from.
|
|
ErrUninitializedBucket
|
|
|
|
// ErrMissingKey indicates that a key was not found in a bucket.
|
|
ErrMissingKey
|
|
|
|
// ErrChainStateShortRead indicates that the given chain state data
|
|
// was too small.
|
|
ErrChainStateShortRead
|
|
|
|
// ErrDatabaseInfoShortRead indicates that the given database information
|
|
// was too small.
|
|
ErrDatabaseInfoShortRead
|
|
|
|
// ErrLoadAllTickets indicates that there was an error loading the tickets
|
|
// from the database, presumably at startup.
|
|
ErrLoadAllTickets
|
|
)
|
|
|
|
// Map of ErrorCode values back to their constant names for pretty printing.
|
|
var errorCodeStrings = map[ErrorCode]string{
|
|
ErrUndoDataShortRead: "ErrUndoDataShortRead",
|
|
ErrUndoDataCorrupt: "ErrUndoDataCorrupt",
|
|
ErrTicketHashesShortRead: "ErrTicketHashesShortRead",
|
|
ErrTicketHashesCorrupt: "ErrTicketHashesCorrupt",
|
|
ErrUninitializedBucket: "ErrUninitializedBucket",
|
|
ErrMissingKey: "ErrMissingKey",
|
|
ErrChainStateShortRead: "ErrChainStateShortRead",
|
|
ErrDatabaseInfoShortRead: "ErrDatabaseInfoShortRead",
|
|
ErrLoadAllTickets: "ErrLoadAllTickets",
|
|
}
|
|
|
|
// String returns the ErrorCode as a human-readable name.
|
|
func (e ErrorCode) String() string {
|
|
if s := errorCodeStrings[e]; s != "" {
|
|
return s
|
|
}
|
|
return fmt.Sprintf("Unknown ErrorCode (%d)", int(e))
|
|
}
|
|
|
|
// DBError identifies a an error in the stake database for tickets.
|
|
// The caller can use type assertions to determine if a failure was
|
|
// specifically due to a rule violation and access the ErrorCode field to
|
|
// ascertain the specific reason for the rule violation.
|
|
type DBError struct {
|
|
ErrorCode ErrorCode // Describes the kind of error
|
|
Description string // Human readable description of the issue
|
|
}
|
|
|
|
// Error satisfies the error interface and prints human-readable errors.
|
|
func (e DBError) Error() string {
|
|
return e.Description
|
|
}
|
|
|
|
// GetCode satisfies the error interface and prints human-readable errors.
|
|
func (e DBError) GetCode() ErrorCode {
|
|
return e.ErrorCode
|
|
}
|
|
|
|
// DBError creates an DBError given a set of arguments.
|
|
func ticketDBError(c ErrorCode, desc string) DBError {
|
|
return DBError{ErrorCode: c, Description: desc}
|
|
}
|