From 6f16d01de7e205aca4156a120344c139b009f078 Mon Sep 17 00:00:00 2001
From: Robert Zaremba <robert@zaremba.ch>
Date: Wed, 16 Mar 2022 11:16:50 +0100
Subject: [PATCH] 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)
---
 types/errors/doc.go    |  9 +++++++++
 types/errors/errors.go | 21 ++++++++++-----------
 2 files changed, 19 insertions(+), 11 deletions(-)
 create mode 100644 types/errors/doc.go

diff --git a/types/errors/doc.go b/types/errors/doc.go
new file mode 100644
index 000000000..31f9e6cda
--- /dev/null
+++ b/types/errors/doc.go
@@ -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
diff --git a/types/errors/errors.go b/types/errors/errors.go
index 8f98a1910..aa6bffe06 100644
--- a/types/errors/errors.go
+++ b/types/errors/errors.go
@@ -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"