From 3ee8242364e4dc0d20d0bba04711ccd37091318a Mon Sep 17 00:00:00 2001 From: Facundo Medica <14063057+facundomedica@users.noreply.github.com> Date: Sat, 29 Apr 2023 12:56:54 -0300 Subject: [PATCH] feat(errors): Add ErrStopIterating (#15989) --- errors/CHANGELOG.md | 4 ++++ errors/errors.go | 3 +++ 2 files changed, 7 insertions(+) diff --git a/errors/CHANGELOG.md b/errors/CHANGELOG.md index a1602a6fa0..f92b514837 100644 --- a/errors/CHANGELOG.md +++ b/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 diff --git a/errors/errors.go b/errors/errors.go index 088476c81d..2e5140d728 100644 --- a/errors/errors.go +++ b/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") )