chore: deprecate types/errors aliases (#11380)

## Description

Closes: #11379

### 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...

- [ ] 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
- [ ] 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
- [ ] 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)
This commit is contained in:
Robert Zaremba 2022-03-16 11:16:50 +01:00 committed by GitHub
parent 18635761d5
commit 6f16d01de7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 11 deletions

9
types/errors/doc.go Normal file
View File

@ -0,0 +1,9 @@
// Package errors provides a shared set of errors for use in the SDK,
// aliases functionality in the github.com/cosmos/cosmos-sdk/errors module
// that used to be in this package, and provides some helpers for converting
// errors to ABCI response code.
//
// New code should generally import github.com/cosmos/cosmos-sdk/errors directly
// and define a custom set of errors in custom codespace, rather than importing
// this package.
package errors

View File

@ -1,17 +1,14 @@
//Package errors provides a shared set of errors for use in the SDK,
//aliases functionality in the github.com/cosmos/cosmos-sdk/errors module
//that used to be in this package, and provides some helpers for converting
//errors to ABCI response code.
//
//New code should generally import github.com/cosmos/cosmos-sdk/errors directly
//and define a custom set of errors in custom codespace, rather than importing
//this package.
package errors
import (
errorsmod "github.com/cosmos/cosmos-sdk/errors"
)
// Type Aliases to errors module
//
// Deprecated: functionality of this package has been moved to it's own module:
// github.com/cosmos/cosmos-sdk/errors
// Please use the above module instead of this package.
var (
SuccessABCICode = errorsmod.SuccessABCICode
ABCIInfo = errorsmod.ABCIInfo
@ -28,9 +25,11 @@ var (
AssertNil = errorsmod.AssertNil
)
type (
Error = errorsmod.Error
)
// Error type alias for errorsmod.Error
//
// Deprecated: the type has been moved to github.com/cosmos/cosmos-sdk/errors
// module. Please use the above module instead of this package.
type Error = errorsmod.Error
// RootCodespace is the codespace for all errors defined in this package
const RootCodespace = "sdk"