4d0d376c4b
## Description This PR: * moves all of the `types/errors` code to a new `errors` go module, except: * the `RootCodespace` errors in `types/errors` stay there * ABCI stuff that depends on tendermint stays in `types/errors * adds aliases to everything in `types/errors` referencing `errors` so **this is not a breaking change** This will allow standalone go modules to use the same error types as the SDK. In particular, I want the `orm` to reference `errors` and then the SDK will be able to import `orm` and it can stay standalone. The same could apply to the `db` module. After this PR the plan is to: * tag `github.com/cosmos/cosmos-sdk/errors` as `v1.0` 🎉 * remove the `replace` directive for `errors` in the main SDK `go.mod` --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
35 lines
1.3 KiB
Go
35 lines
1.3 KiB
Go
/*
|
|
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
|
|
|
|
*/
|
|
package errors
|