feat(errors): Add ErrStopIterating (#15989)

errors/CHANGELOG.md

@@ -31,6 +31,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
+### Features
+
+* [#15989](https://github.com/cosmos/cosmos-sdk/pull/15989) Add `ErrStopIterating` for modules to use for breaking out of iteration.
+
 ## v1.0.0
 
 ### Features

errors/errors.go

@@ -16,6 +16,9 @@ var (
 	// errInternal should never be exposed, but we reserve this code for non-specified errors
 	errInternal = Register(UndefinedCodespace, 1, "internal")
 
+	// ErrStopIterating is used to break out of an iteration
+	ErrStopIterating = Register(UndefinedCodespace, 2, "stop iterating")
+
 	// ErrPanic should only be set when we recovering from a panic
 	ErrPanic = Register(UndefinedCodespace, 111222, "panic")
 )