chore(storage): cleanup NotFound errors

mod/storage/pkg/beacondb/errors.go

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2024, Berachain Foundation. All rights reserved.
+// Use of this software is governed by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+package beacondb
+
+import (
+	"errors"
+
+	"cosmossdk.io/collections"
+)
+
+var ErrNotFound = errors.New("beacondb: not found")
+
+// mapErrors ensure that we replace collections.ErrNotFound error
+// with ErrNotFound. This allows beacond clients to implement custom
+// logic when items they were quering are not available, while loosening
+// dependencies on cosmos sdk package.
+func mapErrors(err error) error {
+	switch {
+	case err == nil:
+		return nil
+	case errors.Is(err, collections.ErrNotFound):
+		return ErrNotFound
+	default:
+		return err
+	}
+}

mod/storage/pkg/beacondb/eth1.go

@@ -20,6 +20,10 @@
 
 package beacondb
 
+import (
+	"fmt"
+)
+
 // GetLatestExecutionPayloadHeader retrieves the latest execution payload
 // header from the BeaconStore.
 func (kv *KVStore[
@@ -28,13 +32,40 @@ func (kv *KVStore[
 ]) GetLatestExecutionPayloadHeader() (
 	ExecutionPayloadHeaderT, error,
 ) {
-	forkVersion, err := kv.latestExecutionPayloadVersion.Get(kv.ctx)
+	var h ExecutionPayloadHeaderT
+	v, err := kv.getLatestExecutionPayloadVersion()
+	if err != nil {
+		return h, fmt.Errorf(
+			"failed retrieving latest execution payload header: %w",
+			err,
+		)
+	}
+
+	kv.latestExecutionPayloadCodec.SetActiveForkVersion(v)
+	h, err = kv.latestExecutionPayloadHeader.Get(kv.ctx)
+	err = mapErrors(err)
 	if err != nil {
-		var t ExecutionPayloadHeaderT
-		return t, err
+		return h, fmt.Errorf(
+			"failed retrieving latest execution payload header: %w",
+			err,
+		)
 	}
-	kv.latestExecutionPayloadCodec.SetActiveForkVersion(forkVersion)
-	return kv.latestExecutionPayloadHeader.Get(kv.ctx)
+	return h, nil
+}
+
+func (kv *KVStore[
+	BeaconBlockHeaderT, Eth1DataT, ExecutionPayloadHeaderT,
+	ForkT, ValidatorT, ValidatorsT,
+]) getLatestExecutionPayloadVersion() (uint32, error) {
+	v, err := kv.latestExecutionPayloadVersion.Get(kv.ctx)
+	err = mapErrors(err)
+	if err != nil {
+		return 0, fmt.Errorf(
+			"failed retrieving latest execution payload version: %w",
+			err,
+		)
+	}
+	return v, nil
 }
 
 // SetLatestExecutionPayloadHeader sets the latest execution payload header in
@@ -45,9 +76,11 @@ func (kv *KVStore[
 ]) SetLatestExecutionPayloadHeader(
 	payloadHeader ExecutionPayloadHeaderT,
 ) error {
-	if err := kv.latestExecutionPayloadVersion.Set(
-		kv.ctx, payloadHeader.Version(),
-	); err != nil {
+	var (
+		ctx     = kv.ctx
+		version = payloadHeader.Version()
+	)
+	if err := kv.latestExecutionPayloadVersion.Set(ctx, version); err != nil {
 		return err
 	}
 	kv.latestExecutionPayloadCodec.SetActiveForkVersion(payloadHeader.Version())
@@ -59,7 +92,16 @@ func (kv *KVStore[
 	BeaconBlockHeaderT, Eth1DataT, ExecutionPayloadHeaderT,
 	ForkT, ValidatorT, ValidatorsT,
 ]) GetEth1DepositIndex() (uint64, error) {
-	return kv.eth1DepositIndex.Get(kv.ctx)
+	idx, err := kv.eth1DepositIndex.Get(kv.ctx)
+	err = mapErrors(err)
+	if err != nil {
+		return 0, fmt.Errorf(
+			"failed retrieving eth1 deposit index %d, %w",
+			idx,
+			err,
+		)
+	}
+	return idx, nil
 }
 
 // SetEth1DepositIndex sets the eth1 deposit index in the beacon state.
@@ -77,7 +119,15 @@ func (kv *KVStore[
 	BeaconBlockHeaderT, Eth1DataT, ExecutionPayloadHeaderT,
 	ForkT, ValidatorT, ValidatorsT,
 ]) GetEth1Data() (Eth1DataT, error) {
-	return kv.eth1Data.Get(kv.ctx)
+	d, err := kv.eth1Data.Get(kv.ctx)
+	err = mapErrors(err)
+	if err != nil {
+		return d, fmt.Errorf(
+			"failed retrieving eth1 data: %w",
+			err,
+		)
+	}
+	return d, nil
 }
 
 // SetEth1Data sets the eth1 data in the beacon state.

mod/storage/pkg/beacondb/fork.go

@@ -20,6 +20,10 @@
 
 package beacondb
 
+import (
+	"fmt"
+)
+
 // SetFork sets the fork version for the given epoch.
 func (kv *KVStore[
 	BeaconBlockHeaderT, Eth1DataT, ExecutionPayloadHeaderT,
@@ -35,5 +39,10 @@ func (kv *KVStore[
 	BeaconBlockHeaderT, Eth1DataT, ExecutionPayloadHeaderT,
 	ForkT, ValidatorT, ValidatorsT,
 ]) GetFork() (ForkT, error) {
-	return kv.fork.Get(kv.ctx)
+	f, err := kv.fork.Get(kv.ctx)
+	err = mapErrors(err)
+	if err != nil {
+		return f, fmt.Errorf("failed retrieving fork: %w", err)
+	}
+	return f, nil
 }

mod/storage/pkg/beacondb/history.go

@@ -20,7 +20,11 @@
 
 package beacondb
 
-import "github.com/berachain/beacon-kit/mod/primitives/pkg/common"
+import (
+	"fmt"
+
+	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
+)
 
 // UpdateBlockRootAtIndex sets a block root in the BeaconStore.
 func (kv *KVStore[
@@ -41,8 +45,13 @@ func (kv *KVStore[
 	index uint64,
 ) (common.Root, error) {
 	bz, err := kv.blockRoots.Get(kv.ctx, index)
+	err = mapErrors(err)
 	if err != nil {
-		return common.Root{}, err
+		return common.Root{}, fmt.Errorf(
+			"failed retrieving block root at index %d: %w",
+			index,
+			err,
+		)
 	}
 	return common.Root(bz), nil
 }
@@ -64,7 +73,15 @@ func (kv *KVStore[
 ]) GetLatestBlockHeader() (
 	BeaconBlockHeaderT, error,
 ) {
-	return kv.latestBlockHeader.Get(kv.ctx)
+	h, err := kv.latestBlockHeader.Get(kv.ctx)
+	err = mapErrors(err)
+	if err != nil {
+		return h, fmt.Errorf(
+			"failed retrieving latest block header: %w",
+			err,
+		)
+	}
+	return h, nil
 }
 
 // UpdateStateRootAtIndex updates the state root at the given slot.
@@ -86,8 +103,13 @@ func (kv *KVStore[
 	idx uint64,
 ) (common.Root, error) {
 	bz, err := kv.stateRoots.Get(kv.ctx, idx)
+	err = mapErrors(err)
 	if err != nil {
-		return common.Root{}, err
+		return common.Root{}, fmt.Errorf(
+			"failed retrieving state root at index %d: %w",
+			idx,
+			err,
+		)
 	}
 	return common.Root(bz), nil
 }

mod/storage/pkg/beacondb/randao.go

@@ -20,7 +20,11 @@
 
 package beacondb
 
-import "github.com/berachain/beacon-kit/mod/primitives/pkg/common"
+import (
+	"fmt"
+
+	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
+)
 
 // UpdateRandaoMixAtIndex sets the current RANDAO mix in the store.
 func (kv *KVStore[
@@ -41,8 +45,13 @@ func (kv *KVStore[
 	index uint64,
 ) (common.Bytes32, error) {
 	bz, err := kv.randaoMix.Get(kv.ctx, index)
+	err = mapErrors(err)
 	if err != nil {
-		return common.Bytes32{}, err
+		return common.Bytes32{}, fmt.Errorf(
+			"failed retrieving randao mix at index %d: %w",
+			index,
+			err,
+		)
 	}
 	return common.Bytes32(bz), nil
 }