Release v0.1.0

vendor/github.com/btcsuite/btcwallet/waddrmgr/error.go

@@ -0,0 +1,219 @@
+// Copyright (c) 2014 The btcsuite developers
+// Use of this source code is governed by an ISC
+// license that can be found in the LICENSE file.
+
+package waddrmgr
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/btcsuite/btcutil/hdkeychain"
+)
+
+var (
+	// errAlreadyExists is the common error description used for the
+	// ErrAlreadyExists error code.
+	errAlreadyExists = "the specified address manager already exists"
+
+	// errCoinTypeTooHigh is the common error description used for the
+	// ErrCoinTypeTooHigh error code.
+	errCoinTypeTooHigh = "coin type may not exceed " +
+		strconv.FormatUint(hdkeychain.HardenedKeyStart-1, 10)
+
+	// errAcctTooHigh is the common error description used for the
+	// ErrAccountNumTooHigh error code.
+	errAcctTooHigh = "account number may not exceed " +
+		strconv.FormatUint(hdkeychain.HardenedKeyStart-1, 10)
+
+	// errLocked is the common error description used for the ErrLocked
+	// error code.
+	errLocked = "address manager is locked"
+
+	// errWatchingOnly is the common error description used for the
+	// ErrWatchingOnly error code.
+	errWatchingOnly = "address manager is watching-only"
+)
+
+// ErrorCode identifies a kind of error.
+type ErrorCode int
+
+// These constants are used to identify a specific ManagerError.
+const (
+	// ErrDatabase indicates an error with the underlying database.  When
+	// this error code is set, the Err field of the ManagerError will be
+	// set to the underlying error returned from the database.
+	ErrDatabase ErrorCode = iota
+
+	// ErrUpgrade indicates the manager needs to be upgraded.  This should
+	// not happen in practice unless the version number has been increased
+	// and there is not yet any code written to upgrade.
+	ErrUpgrade
+
+	// ErrKeyChain indicates an error with the key chain typically either
+	// due to the inability to create an extended key or deriving a child
+	// extended key.  When this error code is set, the Err field of the
+	// ManagerError will be set to the underlying error.
+	ErrKeyChain
+
+	// ErrCrypto indicates an error with the cryptography related operations
+	// such as decrypting or encrypting data, parsing an EC public key,
+	// or deriving a secret key from a password.  When this error code is
+	// set, the Err field of the ManagerError will be set to the underlying
+	// error.
+	ErrCrypto
+
+	// ErrInvalidKeyType indicates an error where an invalid crypto
+	// key type has been selected.
+	ErrInvalidKeyType
+
+	// ErrNoExist indicates that the specified database does not exist.
+	ErrNoExist
+
+	// ErrAlreadyExists indicates that the specified database already exists.
+	ErrAlreadyExists
+
+	// ErrCoinTypeTooHigh indicates that the coin type specified in the provided
+	// network parameters is higher than the max allowed value as defined
+	// by the maxCoinType constant.
+	ErrCoinTypeTooHigh
+
+	// ErrAccountNumTooHigh indicates that the specified account number is higher
+	// than the max allowed value as defined by the MaxAccountNum constant.
+	ErrAccountNumTooHigh
+
+	// ErrLocked indicates that an operation, which requires the account
+	// manager to be unlocked, was requested on a locked account manager.
+	ErrLocked
+
+	// ErrWatchingOnly indicates that an operation, which requires the
+	// account manager to have access to private data, was requested on
+	// a watching-only account manager.
+	ErrWatchingOnly
+
+	// ErrInvalidAccount indicates that the requested account is not valid.
+	ErrInvalidAccount
+
+	// ErrAddressNotFound indicates that the requested address is not known to
+	// the account manager.
+	ErrAddressNotFound
+
+	// ErrAccountNotFound indicates that the requested account is not known to
+	// the account manager.
+	ErrAccountNotFound
+
+	// ErrDuplicateAddress indicates an address already exists.
+	ErrDuplicateAddress
+
+	// ErrDuplicateAccount indicates an account already exists.
+	ErrDuplicateAccount
+
+	// ErrTooManyAddresses indicates that more than the maximum allowed number of
+	// addresses per account have been requested.
+	ErrTooManyAddresses
+
+	// ErrWrongPassphrase indicates that the specified passphrase is incorrect.
+	// This could be for either public or private master keys.
+	ErrWrongPassphrase
+
+	// ErrWrongNet indicates that the private key to be imported is not for the
+	// the same network the account manager is configured for.
+	ErrWrongNet
+
+	// ErrCallBackBreak is used to break from a callback function passed
+	// down to the manager.
+	ErrCallBackBreak
+
+	// ErrEmptyPassphrase indicates that the private passphrase was refused
+	// due to being empty.
+	ErrEmptyPassphrase
+
+	// ErrScopeNotFound is returned when a target scope cannot be found
+	// within the database.
+	ErrScopeNotFound
+
+	// ErrBirthdayBlockNotSet is returned when we attempt to retrieve the
+	// wallet's birthday but it has not been set yet.
+	ErrBirthdayBlockNotSet
+
+	// ErrBlockNotFound is returned when we attempt to retrieve the hash for
+	// a block that we do not know of.
+	ErrBlockNotFound
+)
+
+// Map of ErrorCode values back to their constant names for pretty printing.
+var errorCodeStrings = map[ErrorCode]string{
+	ErrDatabase:          "ErrDatabase",
+	ErrUpgrade:           "ErrUpgrade",
+	ErrKeyChain:          "ErrKeyChain",
+	ErrCrypto:            "ErrCrypto",
+	ErrInvalidKeyType:    "ErrInvalidKeyType",
+	ErrNoExist:           "ErrNoExist",
+	ErrAlreadyExists:     "ErrAlreadyExists",
+	ErrCoinTypeTooHigh:   "ErrCoinTypeTooHigh",
+	ErrAccountNumTooHigh: "ErrAccountNumTooHigh",
+	ErrLocked:            "ErrLocked",
+	ErrWatchingOnly:      "ErrWatchingOnly",
+	ErrInvalidAccount:    "ErrInvalidAccount",
+	ErrAddressNotFound:   "ErrAddressNotFound",
+	ErrAccountNotFound:   "ErrAccountNotFound",
+	ErrDuplicateAddress:  "ErrDuplicateAddress",
+	ErrDuplicateAccount:  "ErrDuplicateAccount",
+	ErrTooManyAddresses:  "ErrTooManyAddresses",
+	ErrWrongPassphrase:   "ErrWrongPassphrase",
+	ErrWrongNet:          "ErrWrongNet",
+	ErrCallBackBreak:     "ErrCallBackBreak",
+	ErrEmptyPassphrase:   "ErrEmptyPassphrase",
+	ErrScopeNotFound:     "ErrScopeNotFound",
+}
+
+// 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))
+}
+
+// ManagerError provides a single type for errors that can happen during address
+// manager operation.  It is used to indicate several types of failures
+// including errors with caller requests such as invalid accounts or requesting
+// private keys against a locked address manager, errors with the database
+// (ErrDatabase), errors with key chain derivation (ErrKeyChain), and errors
+// related to crypto (ErrCrypto).
+//
+// The caller can use type assertions to determine if an error is a ManagerError
+// and access the ErrorCode field to ascertain the specific reason for the
+// failure.
+//
+// The ErrDatabase, ErrKeyChain, and ErrCrypto error codes will also have the
+// Err field set with the underlying error.
+type ManagerError struct {
+	ErrorCode   ErrorCode // Describes the kind of error
+	Description string    // Human readable description of the issue
+	Err         error     // Underlying error
+}
+
+// Error satisfies the error interface and prints human-readable errors.
+func (e ManagerError) Error() string {
+	if e.Err != nil {
+		return e.Description + ": " + e.Err.Error()
+	}
+	return e.Description
+}
+
+// managerError creates a ManagerError given a set of arguments.
+func managerError(c ErrorCode, desc string, err error) ManagerError {
+	return ManagerError{ErrorCode: c, Description: desc, Err: err}
+}
+
+// Break is a global err used to signal a break from the callback
+// function by returning an error with the code ErrCallBackBreak
+var Break = managerError(ErrCallBackBreak, "callback break", nil)
+
+// IsError returns whether the error is a ManagerError with a matching error
+// code.
+func IsError(err error, code ErrorCode) bool {
+	e, ok := err.(ManagerError)
+	return ok && e.ErrorCode == code
+}