feat: standalone errors go.mod

.gitignore

@@ -55,3 +55,5 @@ dependency-graph.png
 *.aux
 *.out
 *.synctex.gz
+/x/genutil/config/priv_validator_key.json
+/x/genutil/data/priv_validator_state.json

CHANGELOG.md

@@ -150,6 +150,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (types) [\#10630](https://github.com/cosmos/cosmos-sdk/pull/10630) Add an `Events` field to the `TxResponse` type that captures _all_ events emitted by a transaction, unlike `Logs` which only contains events emitted during message execution.
 * (deps) [\#10706](https://github.com/cosmos/cosmos-sdk/issues/10706) Bump rosetta-sdk-go to v0.7.2 and rosetta-cli to v0.7.3
 * (module) [\#10711](https://github.com/cosmos/cosmos-sdk/pull/10711) Panic at startup if the app developer forgot to add modules in the `SetOrder{BeginBlocker, EndBlocker, InitGenesis, ExportGenesis}` functions. This means that all modules, even those who have empty implementations for those methods, need to be added to `SetOrder*`.
+* (types/errors) [\#10779](https://github.com/cosmos/cosmos-sdk/pull/10779) Move most functionality in `types/errors` to a standalone `errors` go module, except the `RootCodespace` errors and ABCI response helpers. All functions and types that used to live in `types/errors` are now aliased so this is not a breaking change.
 
 ### Bug Fixes
 

errors/CHANGELOG.md

@@ -0,0 +1,40 @@
+<!--
+Guiding Principles:
+
+Changelogs are for humans, not machines.
+There should be an entry for every single version.
+The same types of changes should be grouped.
+Versions and sections should be linkable.
+The latest version comes first.
+The release date of each version is displayed.
+Mention whether you follow Semantic Versioning.
+
+Usage:
+
+Change log entries are to be added to the Unreleased section under the
+appropriate stanza (see below). Each entry should ideally include a tag and
+the Github issue reference in the following format:
+
+* (<tag>) \#<issue-number> message
+
+The issue numbers will later be link-ified during the release process so you do
+not have to worry about including a link manually, but you can if you wish.
+
+Types of changes (Stanzas):
+
+"Features" for new features.
+"Improvements" for changes in existing functionality.
+"Deprecated" for soon-to-be removed features.
+"Bug Fixes" for any bug fixes.
+"Client Breaking" for breaking Protobuf, gRPC and REST routes used by end-users.
+"CLI Breaking" for breaking CLI commands.
+"API Breaking" for breaking exported APIs used by developers building on SDK.
+Ref: https://keepachangelog.com/en/1.0.0/
+-->
+
+# Changelog
+
+## v1.0.0
+
+### Features
+* [\#10779](https://github.com/cosmos/cosmos-sdk/pull/10779) Import code from the `github.com/cosmos/cosmos-sdk/types/errors` package.

errors/abci.go

@@ -0,0 +1,129 @@
+package errors
+
+import (
+	"fmt"
+	"reflect"
+)
+
+const (
+	// SuccessABCICode declares an ABCI response use 0 to signal that the
+	// processing was successful and no error is returned.
+	SuccessABCICode uint32 = 0
+
+	// All unclassified errors that do not provide an ABCI code are clubbed
+	// under an internal error code and a generic message instead of
+	// detailed error string.
+	internalABCICodespace        = UndefinedCodespace
+	internalABCICode      uint32 = 1
+)
+
+// 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 ABCIInfo(err error, debug bool) (codespace string, code uint32, log string) {
+	if errIsNil(err) {
+		return "", SuccessABCICode, ""
+	}
+
+	encode := defaultErrEncoder
+	if debug {
+		encode = debugErrEncoder
+	}
+
+	return abciCodespace(err), abciCode(err), encode(err)
+}
+
+// The debugErrEncoder encodes the error with a stacktrace.
+func debugErrEncoder(err error) string {
+	return fmt.Sprintf("%+v", err)
+}
+
+// The defaultErrEncoder applies Redact on the error before encoding it with its internal error message.
+func defaultErrEncoder(err error) string {
+	return Redact(err).Error()
+}
+
+type coder interface {
+	ABCICode() uint32
+}
+
+// abciCode tests if given error contains an ABCI code and returns the value of
+// it if available. This function is testing for the causer interface as well
+// and unwraps the error.
+func abciCode(err error) uint32 {
+	if errIsNil(err) {
+		return SuccessABCICode
+	}
+
+	for {
+		if c, ok := err.(coder); ok {
+			return c.ABCICode()
+		}
+
+		if c, ok := err.(causer); ok {
+			err = c.Cause()
+		} else {
+			return internalABCICode
+		}
+	}
+}
+
+type codespacer interface {
+	Codespace() string
+}
+
+// abciCodespace tests if given error contains a codespace and returns the value of
+// it if available. This function is testing for the causer interface as well
+// and unwraps the error.
+func abciCodespace(err error) string {
+	if errIsNil(err) {
+		return ""
+	}
+
+	for {
+		if c, ok := err.(codespacer); ok {
+			return c.Codespace()
+		}
+
+		if c, ok := err.(causer); ok {
+			err = c.Cause()
+		} else {
+			return internalABCICodespace
+		}
+	}
+}
+
+// errIsNil returns true if value represented by the given error is nil.
+//
+// Most of the time a simple == check is enough. There is a very narrowed
+// spectrum of cases (mostly in tests) where a more sophisticated check is
+// required.
+func errIsNil(err error) bool {
+	if err == nil {
+		return true
+	}
+	if val := reflect.ValueOf(err); val.Kind() == reflect.Ptr {
+		return val.IsNil()
+	}
+	return false
+}
+
+var errPanicWithMsg = Wrapf(ErrPanic, "panic message redacted to hide potentially sensitive system info")
+
+// Redact replaces an error that is not initialized as an ABCI Error with a
+// generic internal error instance. If the error is an ABCI Error, that error is
+// simply returned.
+func Redact(err error) error {
+	if ErrPanic.Is(err) {
+		return errPanicWithMsg
+	}
+	if abciCode(err) == internalABCICode {
+		return errInternal
+	}
+
+	return err
+}

types/errors/abci_test.go → errors/abci_test.go

@@ -30,18 +30,18 @@ func (s *abciTestSuite) TestABCInfo() {
 		wantLog   string
 	}{
 		"plain SDK error": {
-			err:       ErrUnauthorized,
+			err:       errUnauthorized,
 			debug:     false,
 			wantLog:   "unauthorized",
-			wantCode:  ErrUnauthorized.code,
-			wantSpace: RootCodespace,
+			wantCode:  errUnauthorized.code,
+			wantSpace: testCodespace,
 		},
 		"wrapped SDK error": {
-			err:       Wrap(Wrap(ErrUnauthorized, "foo"), "bar"),
+			err:       Wrap(Wrap(errUnauthorized, "foo"), "bar"),
 			debug:     false,
 			wantLog:   "bar: foo: unauthorized",
-			wantCode:  ErrUnauthorized.code,
-			wantSpace: RootCodespace,
+			wantCode:  errUnauthorized.code,
+			wantSpace: testCodespace,
 		},
 		"nil is empty message": {
 			err:       nil,
@@ -118,13 +118,13 @@ func (s *abciTestSuite) TestABCIInfoStacktrace() {
 		wantErrMsg     string
 	}{
 		"wrapped SDK error in debug mode provides stacktrace": {
-			err:            Wrap(ErrUnauthorized, "wrapped"),
+			err:            Wrap(errUnauthorized, "wrapped"),
 			debug:          true,
 			wantStacktrace: true,
 			wantErrMsg:     "wrapped: unauthorized",
 		},
 		"wrapped SDK error in non-debug mode does not have stacktrace": {
-			err:            Wrap(ErrUnauthorized, "wrapped"),
+			err:            Wrap(errUnauthorized, "wrapped"),
 			debug:          false,
 			wantStacktrace: false,
 			wantErrMsg:     "wrapped: unauthorized",
@@ -158,7 +158,7 @@ func (s *abciTestSuite) TestABCIInfoStacktrace() {
 }
 
 func (s *abciTestSuite) TestABCIInfoHidesStacktrace() {
-	err := Wrap(ErrUnauthorized, "wrapped")
+	err := Wrap(errUnauthorized, "wrapped")
 	_, _, log := ABCIInfo(err, false)
 	s.Require().Equal("wrapped: unauthorized", log)
 }
@@ -174,7 +174,7 @@ func (s *abciTestSuite) TestRedact() {
 			changed: errPanicWithMsg,
 		},
 		"sdk errors untouched": {
-			err:       Wrap(ErrUnauthorized, "cannot drop db"),
+			err:       Wrap(errUnauthorized, "cannot drop db"),
 			untouched: true,
 		},
 		"pass though custom errors with ABCI code": {
@@ -206,8 +206,8 @@ func (s *abciTestSuite) TestRedact() {
 func (s *abciTestSuite) TestABCIInfoSerializeErr() {
 	var (
 		// Create errors with stacktrace for equal comparison.
-		myErrDecode = Wrap(ErrTxDecode, "test")
-		myErrAddr   = Wrap(ErrInvalidAddress, "tester")
+		myErrDecode = Wrap(errTxDecode, "test")
+		myErrAddr   = Wrap(errInvalidAddress, "tester")
 		myPanic     = ErrPanic
 	)