chore(node-api): consolidate error handling

node-api/backend/getters.go

@@ -28,9 +28,11 @@ import (
 	"cosmossdk.io/log"
 	cometbft "github.com/berachain/beacon-kit/consensus/cometbft/service"
 	datypes "github.com/berachain/beacon-kit/da/types"
+	"github.com/berachain/beacon-kit/node-api/middleware"
 	"github.com/berachain/beacon-kit/primitives/common"
 	"github.com/berachain/beacon-kit/primitives/math"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 	"github.com/cosmos/cosmos-sdk/version"
 )
 
@@ -52,7 +54,8 @@ func (b *Backend) StateAndSlotFromHeight(height int64) (ReadOnlyBeaconState, mat
 				return nil, 0, fmt.Errorf("failed loading genesis state: %w", err)
 			}
 		case errors.Is(err, cometbft.ErrAppNotReady):
-			return nil, 0, cometbft.ErrAppNotReady
+			// chain not ready, like when genesis time is set in the future
+			return nil, 0, middleware.ErrNotFound
 		default:
 			return nil, 0, fmt.Errorf("unable to check whether app is ready: %w", err)
 		}
@@ -71,6 +74,14 @@ func (b *Backend) StateAndSlotFromHeight(height int64) (ReadOnlyBeaconState, mat
 	height = max(0, height) // CreateQueryContext uses 0 to pick latest height.
 	queryCtx, err := b.node.CreateQueryContext(height, false)
 	if err != nil {
+		if errors.Is(err, cometbft.ErrAppNotReady) {
+			// chain not ready, like when genesis time is set in the future
+			return nil, 0, middleware.ErrNotFound
+		}
+		if errors.Is(err, sdkerrors.ErrInvalidHeight) {
+			// height requested too high
+			return nil, 0, middleware.ErrNotFound
+		}
 		return nil, 0, fmt.Errorf("CreateQueryContext failed: %w", err)
 	}
 	st := b.sb.StateFromContext(queryCtx)

node-api/handlers/beacon/blob_test.go

@@ -35,8 +35,8 @@ import (
 	"github.com/berachain/beacon-kit/node-api/handlers/beacon"
 	"github.com/berachain/beacon-kit/node-api/handlers/beacon/mocks"
 	beacontypes "github.com/berachain/beacon-kit/node-api/handlers/beacon/types"
+	"github.com/berachain/beacon-kit/node-api/handlers/mapping"
 	handlertypes "github.com/berachain/beacon-kit/node-api/handlers/types"
-	"github.com/berachain/beacon-kit/node-api/handlers/utils"
 	"github.com/berachain/beacon-kit/node-api/middleware"
 	"github.com/berachain/beacon-kit/primitives/common"
 	"github.com/berachain/beacon-kit/primitives/math"
@@ -77,7 +77,7 @@ func TestGetBlobSidecars(t *testing.T) {
 			inputs: func() beacontypes.GetBlobSidecarsRequest {
 				return beacontypes.GetBlobSidecarsRequest{
 					BlockIDRequest: handlertypes.BlockIDRequest{
-						BlockID: utils.StateIDHead,
+						BlockID: mapping.StateIDHead,
 					},
 					Indices: nil,
 				}

node-api/handlers/beacon/blobs.go

@@ -26,6 +26,7 @@ import (
 
 	"github.com/berachain/beacon-kit/node-api/handlers"
 	"github.com/berachain/beacon-kit/node-api/handlers/beacon/types"
+	"github.com/berachain/beacon-kit/node-api/handlers/mapping"
 	"github.com/berachain/beacon-kit/node-api/handlers/utils"
 	"github.com/berachain/beacon-kit/primitives/math"
 )
@@ -43,13 +44,13 @@ func (h *Handler) GetBlobSidecars(c handlers.Context) (any, error) {
 	}
 
 	// Map requested blockID to slot
-	slotID, err := utils.BlockIDToHeight(req.BlockID, h.backend)
+	slotID, err := mapping.BlockIDToHeight(req.BlockID, h.backend)
 	if err != nil {
 		return nil, err
 	}
 
 	var slot math.Slot
-	if slotID == utils.Head {
+	if slotID == mapping.Head {
 		latestHeight, _ := h.backend.GetSyncData()
 		if latestHeight < 0 {
 			return nil, errors.New("invalid negative block height")

node-api/handlers/beacon/genesis.go

@@ -21,23 +21,16 @@
 package beacon
 
 import (
-	"errors"
 	"fmt"
 
-	cometbft "github.com/berachain/beacon-kit/consensus/cometbft/service"
 	"github.com/berachain/beacon-kit/node-api/handlers"
 	beacontypes "github.com/berachain/beacon-kit/node-api/handlers/beacon/types"
-	handlertypes "github.com/berachain/beacon-kit/node-api/handlers/types"
-	"github.com/berachain/beacon-kit/node-api/handlers/utils"
+	"github.com/berachain/beacon-kit/node-api/handlers/mapping"
 )
 
 func (h *Handler) GetGenesis(handlers.Context) (any, error) {
-	st, _, err := h.backend.StateAndSlotFromHeight(utils.Genesis)
+	st, _, err := h.backend.StateAndSlotFromHeight(mapping.Genesis)
 	if err != nil {
-		if errors.Is(err, cometbft.ErrAppNotReady) {
-			// chain not ready, like when genesis time is set in the future
-			return nil, handlertypes.ErrNotFound
-		}
 		return nil, fmt.Errorf("failed to get state from genesis: %w", err)
 	}
 

node-api/handlers/beacon/genesis_test.go

@@ -32,13 +32,11 @@ import (
 	"github.com/berachain/beacon-kit/chain"
 	"github.com/berachain/beacon-kit/config/spec"
 	ctypes "github.com/berachain/beacon-kit/consensus-types/types"
-	cometbft "github.com/berachain/beacon-kit/consensus/cometbft/service"
 	beaconlog "github.com/berachain/beacon-kit/log"
 	"github.com/berachain/beacon-kit/log/noop"
 	"github.com/berachain/beacon-kit/node-api/handlers/beacon"
 	"github.com/berachain/beacon-kit/node-api/handlers/beacon/mocks"
 	beacontypes "github.com/berachain/beacon-kit/node-api/handlers/beacon/types"
-	"github.com/berachain/beacon-kit/node-api/handlers/types"
 	"github.com/berachain/beacon-kit/node-api/middleware"
 	"github.com/berachain/beacon-kit/node-core/components/metrics"
 	"github.com/berachain/beacon-kit/primitives/common"
@@ -104,12 +102,12 @@ func TestGetGenesis(t *testing.T) {
 		{
 			name: "genesis not ready",
 			setMockExpectations: func(b *mocks.Backend) {
-				b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(nil, 0, cometbft.ErrAppNotReady)
+				b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(nil, 0, middleware.ErrNotFound)
 			},
 			check: func(t *testing.T, res any, err error) {
 				t.Helper()
 
-				require.ErrorIs(t, err, types.ErrNotFound)
+				require.ErrorIs(t, err, middleware.ErrNotFound)
 				require.Nil(t, res)
 			},
 		},

node-api/handlers/beacon/header.go

@@ -27,8 +27,9 @@ import (
 
 	"github.com/berachain/beacon-kit/node-api/handlers"
 	beacontypes "github.com/berachain/beacon-kit/node-api/handlers/beacon/types"
-	handlertypes "github.com/berachain/beacon-kit/node-api/handlers/types"
+	"github.com/berachain/beacon-kit/node-api/handlers/mapping"
 	"github.com/berachain/beacon-kit/node-api/handlers/utils"
+	"github.com/berachain/beacon-kit/node-api/middleware"
 	"github.com/berachain/beacon-kit/primitives/math"
 )
 
@@ -44,7 +45,7 @@ func (h *Handler) GetBlockHeaders(c handlers.Context) (any, error) {
 	case len(req.Slot) == 0 && len(req.ParentRoot) == 0:
 		// no parameter specified, pick chain HEAD
 		// by requesting special height -1.
-		height := utils.Head
+		height := mapping.Head
 		return h.makeBlockHeaderResponse(height, true /*resultsInList*/)
 
 	case len(req.Slot) != 0 && len(req.ParentRoot) == 0:
@@ -54,32 +55,32 @@ func (h *Handler) GetBlockHeaders(c handlers.Context) (any, error) {
 			return nil, fmt.Errorf("failed retrieving slot from input parameters: %w", errSlot)
 		}
 		if slot > stdmath.MaxInt64 { // appease linters
-			return 0, fmt.Errorf("%w: slot %d", utils.ErrFailedMappingHeightTooHigh, slot)
+			return 0, fmt.Errorf("%w: slot %d", mapping.ErrFailedMappingHeightTooHigh, slot)
 		}
 		return h.makeBlockHeaderResponse(int64(slot), true /*resultsInList*/) //#nosec: G115 // safe
 
 	case len(req.Slot) == 0 && len(req.ParentRoot) != 0:
-		parentHeight, errParent := utils.BlockIDToHeight(req.ParentRoot, h.backend)
+		parentHeight, errParent := mapping.BlockIDToHeight(req.ParentRoot, h.backend)
 		if errParent != nil {
-			return nil, fmt.Errorf("%w, failed retrieving parent root with error: %w", handlertypes.ErrNotFound, errParent)
+			return nil, fmt.Errorf("%w, failed retrieving parent root with error: %w", middleware.ErrNotFound, errParent)
 		}
-		if parentHeight == utils.Head {
-			return nil, fmt.Errorf("%w, requested header of tip's child", handlertypes.ErrNotFound)
+		if parentHeight == mapping.Head {
+			return nil, fmt.Errorf("%w, requested header of tip's child", middleware.ErrNotFound)
 		}
 		height := parentHeight + 1
 		return h.makeBlockHeaderResponse(height, true /*resultsInList*/)
 
 	default:
 		var (
 			slot, errSlot         = math.U64FromString(req.Slot)
-			parentSlot, errParent = utils.BlockIDToHeight(req.ParentRoot, h.backend)
+			parentSlot, errParent = mapping.BlockIDToHeight(req.ParentRoot, h.backend)
 		)
 		if err := errors.Join(errSlot, errParent); err != nil {
 			return nil, err
 		}
 
 		if slot > stdmath.MaxInt64 { // appease linters
-			return 0, fmt.Errorf("%w: slot %d", utils.ErrFailedMappingHeightTooHigh, slot)
+			return 0, fmt.Errorf("%w: slot %d", mapping.ErrFailedMappingHeightTooHigh, slot)
 		}
 		height := int64(slot) //#nosec: G115 // safe
 		if height != parentSlot+1 {
@@ -94,7 +95,7 @@ func (h *Handler) GetBlockHeaderByID(c handlers.Context) (any, error) {
 	if err != nil {
 		return nil, err
 	}
-	slot, err := utils.BlockIDToHeight(req.BlockID, h.backend)
+	slot, err := mapping.BlockIDToHeight(req.BlockID, h.backend)
 	if err != nil {
 		return nil, fmt.Errorf("failed retrieving slot from block ID %s: %w", req.BlockID, err)
 	}
@@ -104,7 +105,7 @@ func (h *Handler) GetBlockHeaderByID(c handlers.Context) (any, error) {
 func (h *Handler) makeBlockHeaderResponse(height int64, resultsInList bool) (any, error) {
 	st, _, err := h.backend.StateAndSlotFromHeight(height)
 	if err != nil {
-		return nil, fmt.Errorf("%w: failed to get state from height %d, %s", handlertypes.ErrNotFound, height, err.Error())
+		return nil, fmt.Errorf("failed to get state from height %d, %w", height, err)
 	}
 	// Return after updating the state root in the block header.
 	header, err := st.GetLatestBlockHeader()

node-api/handlers/beacon/header_test.go

@@ -172,7 +172,7 @@ func TestGetBlockHeaders(t *testing.T) {
 			},
 			check: func(t *testing.T, _ common.Root, _ any, err error) {
 				t.Helper()
-				require.ErrorIs(t, err, handlertypes.ErrInvalidRequest)
+				require.ErrorIs(t, err, middleware.ErrInvalidRequest)
 			},
 		},
 		{
@@ -187,14 +187,14 @@ func TestGetBlockHeaders(t *testing.T) {
 			},
 			setMockExpectations: func(t *testing.T, b *mocks.Backend) common.Root {
 				t.Helper()
-				b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(nil, math.Slot(0), errTestHeaderNotFound)
+				b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(nil, math.Slot(0), middleware.ErrNotFound)
 				return common.Root{}
 			},
 			check: func(t *testing.T, _ common.Root, _ any, err error) {
 				t.Helper()
 				// Implicitly ensuring that 404 error code is returned
 				// (see responseFromError implementation)
-				require.ErrorIs(t, err, handlertypes.ErrNotFound)
+				require.ErrorIs(t, err, middleware.ErrNotFound)
 			},
 		},
 		{
@@ -250,7 +250,7 @@ func TestGetBlockHeaders(t *testing.T) {
 			},
 			check: func(t *testing.T, _ common.Root, _ any, err error) {
 				t.Helper()
-				require.ErrorIs(t, err, handlertypes.ErrInvalidRequest)
+				require.ErrorIs(t, err, middleware.ErrInvalidRequest)
 			},
 		},
 		{
@@ -270,7 +270,7 @@ func TestGetBlockHeaders(t *testing.T) {
 				t.Helper()
 				// Implicitly ensuring that 404 error code is returned
 				// (see responseFromError implementation)
-				require.ErrorIs(t, err, handlertypes.ErrNotFound)
+				require.ErrorIs(t, err, middleware.ErrNotFound)
 			},
 		},
 		{
@@ -444,7 +444,7 @@ func TestGetBlockHeaderByID(t *testing.T) {
 			},
 			check: func(t *testing.T, _ common.Root, _ any, err error) {
 				t.Helper()
-				require.ErrorIs(t, err, handlertypes.ErrInvalidRequest)
+				require.ErrorIs(t, err, middleware.ErrInvalidRequest)
 			},
 		},
 		{
@@ -458,15 +458,15 @@ func TestGetBlockHeaderByID(t *testing.T) {
 			},
 			setMockExpectations: func(t *testing.T, b *mocks.Backend) common.Root {
 				t.Helper()
-				b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(nil, math.Slot(0), errTestHeaderNotFound)
+				b.EXPECT().StateAndSlotFromHeight(mock.Anything).Return(nil, math.Slot(0), middleware.ErrNotFound)
 				return common.Root{}
 			},
 			check: func(t *testing.T, _ common.Root, _ any, err error) {
 				t.Helper()
 
 				// Implicitly ensuring that 404 error code is returned
 				// (see responseFromError implementation)
-				require.ErrorIs(t, err, handlertypes.ErrNotFound)
+				require.ErrorIs(t, err, middleware.ErrNotFound)
 			},
 		},
 		{
@@ -523,7 +523,7 @@ func TestGetBlockHeaderByID(t *testing.T) {
 			},
 			check: func(t *testing.T, _ common.Root, _ any, err error) {
 				t.Helper()
-				require.ErrorIs(t, err, handlertypes.ErrInvalidRequest)
+				require.ErrorIs(t, err, middleware.ErrInvalidRequest)
 			},
 		},
 		{

node-api/handlers/beacon/historical.go

@@ -23,6 +23,7 @@ package beacon
 import (
 	"github.com/berachain/beacon-kit/node-api/handlers"
 	beacontypes "github.com/berachain/beacon-kit/node-api/handlers/beacon/types"
+	"github.com/berachain/beacon-kit/node-api/handlers/mapping"
 	"github.com/berachain/beacon-kit/node-api/handlers/utils"
 )
 
@@ -33,7 +34,7 @@ func (h *Handler) GetStateRoot(c handlers.Context) (any, error) {
 	if err != nil {
 		return nil, err
 	}
-	slot, err := utils.StateIDToHeight(req.StateID, h.backend)
+	slot, err := mapping.StateIDToHeight(req.StateID, h.backend)
 	if err != nil {
 		return nil, err
 	}
@@ -51,7 +52,7 @@ func (h *Handler) GetStateFork(c handlers.Context) (any, error) {
 	if err != nil {
 		return nil, err
 	}
-	slot, err := utils.StateIDToHeight(req.StateID, h.backend)
+	slot, err := mapping.StateIDToHeight(req.StateID, h.backend)
 	if err != nil {
 		return nil, err
 	}

node-api/handlers/beacon/randao.go

@@ -24,6 +24,7 @@ import (
 	"github.com/berachain/beacon-kit/errors"
 	"github.com/berachain/beacon-kit/node-api/handlers"
 	beacontypes "github.com/berachain/beacon-kit/node-api/handlers/beacon/types"
+	"github.com/berachain/beacon-kit/node-api/handlers/mapping"
 	"github.com/berachain/beacon-kit/node-api/handlers/utils"
 	"github.com/berachain/beacon-kit/primitives/math"
 )
@@ -38,7 +39,7 @@ func (h *Handler) GetRandao(c handlers.Context) (any, error) {
 	}
 
 	// Get slot and associated state
-	height, err := utils.StateIDToHeight(req.StateID, h.backend)
+	height, err := mapping.StateIDToHeight(req.StateID, h.backend)
 	if err != nil {
 		return nil, err
 	}

node-api/handlers/beacon/randao_test.go

@@ -34,8 +34,8 @@ import (
 	"github.com/berachain/beacon-kit/node-api/handlers/beacon"
 	"github.com/berachain/beacon-kit/node-api/handlers/beacon/mocks"
 	beacontypes "github.com/berachain/beacon-kit/node-api/handlers/beacon/types"
+	"github.com/berachain/beacon-kit/node-api/handlers/mapping"
 	handlertypes "github.com/berachain/beacon-kit/node-api/handlers/types"
-	"github.com/berachain/beacon-kit/node-api/handlers/utils"
 	"github.com/berachain/beacon-kit/node-api/middleware"
 	"github.com/berachain/beacon-kit/primitives/common"
 	"github.com/berachain/beacon-kit/primitives/math"
@@ -66,7 +66,7 @@ func TestGetRandao(t *testing.T) {
 		{
 			name: "randao request - specified epoch",
 			inputs: func() beacontypes.GetRandaoRequest {
-				stateID := utils.StateIDHead
+				stateID := mapping.StateIDHead
 				epoch := strconv.Itoa(int(testEpoch.Unwrap()))
 				return beacontypes.GetRandaoRequest{
 					StateIDRequest: handlertypes.StateIDRequest{
@@ -98,7 +98,7 @@ func TestGetRandao(t *testing.T) {
 		{
 			name: "randao request - unspecified epoch",
 			inputs: func() beacontypes.GetRandaoRequest {
-				stateID := utils.StateIDHead
+				stateID := mapping.StateIDHead
 				return beacontypes.GetRandaoRequest{
 					StateIDRequest: handlertypes.StateIDRequest{
 						StateID: stateID,