Documentation
¶
Overview ¶
Package errors implements custom error interfaces for cosmos-sdk.
Error declarations should be generic and cover broad range of cases. Each returned error instance can wrap a generic error declaration to provide more details.
This package provides a broad range of errors declared that fits all common cases. If an error is very specific for an extension it can be registered outside of the errors package. If it will be needed my many extensions, please consider registering it in the errors package. To create a new error instance use Register function. You must provide a unique, non zero error code and a short description, for example:
var ErrZeroDivision = errors.Register(9241, "zero division")
When returning an error, you can attach to it an additional context information by using Wrap function, for example:
func safeDiv(val, div int) (int, err) {
if div == 0 {
return 0, errors.Wrapf(ErrZeroDivision, "cannot divide %d", val)
}
return val / div, nil
}
The first time an error instance is wrapped a stacktrace is attached as well. Stacktrace information can be printed using %+v and %v formats.
%s is just the error message %+v is the full stack trace %v appends a compressed [filename:line] where the error was created
Index ¶
- Constants
- Variables
- func ABCIError(codespace string, code uint32, log string) error
- func ABCIInfo(err error, debug bool) (codespace string, code uint32, log string)
- func AssertNil(err error)
- func QueryResult(err error) abci.ResponseQuery
- func Recover(err *error)
- func Redact(err error) error
- func ResponseCheckTx(err error, gw, gu uint64, debug bool) abci.ResponseCheckTx
- func ResponseDeliverTx(err error, gw, gu uint64, debug bool) abci.ResponseDeliverTx
- func WithType(err error, obj interface{}) error
- func Wrap(err error, description string) error
- func Wrapf(err error, format string, args ...interface{}) error
- type Error
Constants ¶
const RootCodespace = "sdk"
RootCodespace is the codespace for all errors defined in this package
const ( // SuccessABCICode declares an ABCI response use 0 to signal that the // processing was successful and no error is returned. SuccessABCICode = 0 )
const UndefinedCodespace = "undefined"
UndefinedCodespace when we explicitly declare no codespace
Variables ¶
var ( // ErrInternal should never be exposed, but we reserve this code for non-specified errors //nolint ErrInternal = Register(UndefinedCodespace, 1, "internal") // ErrTxDecode is returned if we cannot parse a transaction ErrTxDecode = Register(RootCodespace, 2, "tx parse error") // ErrInvalidSequence is used the sequence number (nonce) is incorrect // for the signature ErrInvalidSequence = Register(RootCodespace, 3, "invalid sequence") // authorization is handled. ErrUnauthorized = Register(RootCodespace, 4, "unauthorized") // ErrInsufficientFunds is used when the account cannot pay requested amount. ErrInsufficientFunds = Register(RootCodespace, 5, "insufficient funds") // ErrUnknownRequest to doc ErrUnknownRequest = Register(RootCodespace, 6, "unknown request") // ErrInvalidAddress to doc ErrInvalidAddress = Register(RootCodespace, 7, "invalid address") // ErrInvalidPubKey to doc ErrInvalidPubKey = Register(RootCodespace, 8, "invalid pubkey") // ErrUnknownAddress to doc ErrUnknownAddress = Register(RootCodespace, 9, "unknown address") // ErrInvalidCoins to doc ErrInvalidCoins = Register(RootCodespace, 10, "invalid coins") // ErrOutOfGas to doc ErrOutOfGas = Register(RootCodespace, 11, "out of gas") // ErrMemoTooLarge to doc ErrMemoTooLarge = Register(RootCodespace, 12, "memo too large") // ErrInsufficientFee to doc ErrInsufficientFee = Register(RootCodespace, 13, "insufficient fee") // ErrTooManySignatures to doc ErrTooManySignatures = Register(RootCodespace, 14, "maximum number of signatures exceeded") // ErrNoSignatures to doc ErrNoSignatures = Register(RootCodespace, 15, "no signatures supplied") // ErrJSONMarshal defines an ABCI typed JSON marshalling error ErrJSONMarshal = Register(RootCodespace, 16, "failed to marshal JSON bytes") // ErrJSONUnmarshal defines an ABCI typed JSON unmarshalling error ErrJSONUnmarshal = Register(RootCodespace, 17, "failed to unmarshal JSON bytes") // ErrInvalidRequest defines an ABCI typed error where the request contains // invalid data. ErrInvalidRequest = Register(RootCodespace, 18, "invalid request") // ErrTxInMempoolCache defines an ABCI typed error where a tx already exists // in the mempool. ErrTxInMempoolCache = Register(RootCodespace, 19, "tx already in mempool") // ErrMempoolIsFull defines an ABCI typed error where the mempool is full. ErrMempoolIsFull = Register(RootCodespace, 20, "mempool is full") // ErrTxTooLarge defines an ABCI typed error where tx is too large. ErrTxTooLarge = Register(RootCodespace, 21, "tx too large") // ErrPanic is only set when we recover from a panic, so we know to // redact potentially sensitive system info ErrPanic = Register(UndefinedCodespace, 111222, "panic") ErrKeyNotFound = Register(RootCodespace, 3000, "key not found") ErrLogic = Register(RootCodespace, 35, "internal logic error") // ErrInvalidHeight defines an error for an invalid height ErrInvalidHeight = Register(RootCodespace, 26, "invalid height") ErrPackAny = Register(RootCodespace, 33, "failed packing protobuf message to Any") ErrUnpackAny = Register(RootCodespace, 34, "failed unpacking protobuf message from Any") ErrInvalidType = Register(RootCodespace, 29, "invalid type") // ErrInvalidVersion defines a general error for an invalid version ErrInvalidVersion = Register(RootCodespace, 27, "invalid version") // ErrInvalidChainID defines an error when the chain-id is invalid. ErrInvalidChainID = Register(RootCodespace, 28, "invalid chain-id") )
Functions ¶
func ABCIError ¶
ABCIError will resolve an error code/log from an abci result into an error message. If the code is registered, it will map it back to the canonical error, so we can do eg. ErrNotFound.Is(err) on something we get back from an external API.
This should *only* be used in clients, not in the server side. The server (abci app / blockchain) should only refer to registered errors
func ABCIInfo ¶
ABCIInfo returns the ABCI error information as consumed by the tendermint client. Returned codespace, code, and log message should be used as a ABCI response. Any error that does not provide ABCICode information is categorized as error with code 1, codespace UndefinedCodespace When not running in a debug mode all messages of errors that do not provide ABCICode information are replaced with generic "internal error". Errors without an ABCICode information as considered internal.
func AssertNil ¶ added in v1.6.0
func AssertNil(err error)
AssertNil panics on error Should be only used with interface methods, which require return error, but the error is always nil
func QueryResult ¶
func QueryResult(err error) abci.ResponseQuery
QueryResult returns a ResponseQuery from an error. It will try to parse ABCI info from the error.
func Recover ¶
func Recover(err *error)
Recover captures a panic and stop its propagation. If panic happens it is transformed into a ErrPanic instance and assigned to given error. Call this function using defer in order to work as expected.
func Redact ¶
Redact replace all errors that do not initialize with a weave error with a generic internal error instance. This function is supposed to hide implementation details errors and leave only those that weave framework originates.
func ResponseCheckTx ¶
func ResponseCheckTx(err error, gw, gu uint64, debug bool) abci.ResponseCheckTx
ResponseCheckTx returns an ABCI ResponseCheckTx object with fields filled in from the given error and gas values.
func ResponseDeliverTx ¶
func ResponseDeliverTx(err error, gw, gu uint64, debug bool) abci.ResponseDeliverTx
ResponseDeliverTx returns an ABCI ResponseDeliverTx object with fields filled in from the given error and gas values.
func Wrap ¶
Wrap extends given error with an additional information.
If the wrapped error does not provide ABCICode method (ie. stdlib errors), it will be labeled as internal error.
If err is nil, this returns nil, avoiding the need for an if statement when wrapping a error returned at the end of a function
Types ¶
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error represents a root error.
Weave framework is using root error to categorize issues. Each instance created during the runtime should wrap one of the declared root errors. This allows error tests and returning all errors to the client in a safe manner.
All popular root errors are declared in this package. If an extension has to declare a custom root error, always use Register function to ensure error code uniqueness.
func Register ¶
Register returns an error instance that should be used as the base for creating error instances during runtime.
Popular root errors are declared in this package, but extensions may want to declare custom codes. This function ensures that no error code is used twice. Attempt to reuse an error code results in panic.
Use this function only during a program startup phase.
Source Files