Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(storage): cleanup
NotFounderrors #2065base: main
Are you sure you want to change the base?
chore(storage): cleanup
NotFounderrors #2065Changes from 24 commits
a19b0d106aee0d7bfea6bbba50713afed773917a9a64d2f3edc50cc1034f7d1b0f905055ce71eb32f9d886da4a8c9b579ab998227ec89f977c5e4ad23e5a1335e893c30b680ffbd97724acb8933e88d11db3bee6c2d9108c1a1986File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the placeholder version for the storage module.
The
github.com/berachain/beacon-kit/mod/storagemodule is added with a placeholder version (v0.0.0-00010101000000-000000000000). This is likely due to the local replacement directive. Before merging, ensure that this is replaced with a proper version or commit hash to maintain reproducible builds.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codebase verification
SetActiveForkVersion Does Not Validate Version Inputs
The
SetActiveForkVersionmethod inmod/storage/pkg/encoding/ssz.goassigns the provided version directly without validating whether it is valid or supported. This lack of validation may lead to unexpected behavior if an invalid or unsupported version is set.mod/storage/pkg/encoding/ssz.goSetActiveForkVersionlacks error handling for invalid versions.🔗 Analysis chain
Ensure
SetActiveForkVersionhandles invalid versionsWhen setting the active fork version with
kv.latestExecutionPayloadCodec.SetActiveForkVersion(v), it's important to verify that invalid or unsupported versions are properly handled. Lack of validation may lead to unexpected behavior elsewhere in the code.Run the following script to check the implementation of
SetActiveForkVersion:🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
Length of output: 1081
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Simplify
SetLatestExecutionPayloadHeaderby removing unnecessary variableThe variable
ctxis assignedkv.ctxbut is used only once. You can simplify the code by usingkv.ctxdirectly, eliminating the need for the extra variable.Apply this diff to streamline the function:
func (kv *KVStore[ BeaconBlockHeaderT, Eth1DataT, ExecutionPayloadHeaderT, ForkT, ValidatorT, ValidatorsT, ]) SetLatestExecutionPayloadHeader( payloadHeader ExecutionPayloadHeaderT, ) error { - var ( - ctx = kv.ctx - version = payloadHeader.Version() - ) + version := payloadHeader.Version() - if err := kv.latestExecutionPayloadVersion.Set(ctx, version); err != nil { + if err := kv.latestExecutionPayloadVersion.Set(kv.ctx, version); err != nil { return err } kv.latestExecutionPayloadCodec.SetActiveForkVersion(payloadHeader.Version()) return kv.latestExecutionPayloadHeader.Set(kv.ctx, payloadHeader) }📝 Committable suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Avoid including uninitialized variables in error messages
In the
GetEth1DepositIndexmethod, includingidxin the error message before it's successfully retrieved could be misleading, as it may contain a default value (e.g., zero). For clarity, consider modifying the error message to excludeidx.Apply this diff to adjust the error message:
if err != nil { - return 0, fmt.Errorf( - "failed retrieving eth1 deposit index %d, %w", - idx, - err, - ) + return 0, fmt.Errorf( + "failed retrieving eth1 deposit index: %w", + err, + ) }📝 Committable suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
LGTM with a minor suggestion for consistency.
The error handling improvements in
GetBlockRootAtIndexalign well with the PR objectives. The use oferrors.MapErrorlikely handles the mapping to the newErrNotFoundtype, and the error message now includes the index, providing more context.For consistency with other error messages, consider updating the error message:
This minor change would make the error messages more uniform across the file.
📝 Committable suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
LGTM with a minor suggestion for consistency.
The error handling improvements in
GetLatestBlockHeaderare well-aligned with the PR objectives. The use oferrors.MapErrorlikely handles the mapping to the newErrNotFoundtype, and the error message is now more descriptive.For consistency with the suggested changes in other methods, consider updating the error message:
This minor change would make the error messages more uniform across the file.
📝 Committable suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
LGTM with minor suggestions for consistency and clarity.
The error handling improvements in
StateRootAtIndexalign well with the PR objectives. The use oferrors.MapErrorlikely handles the mapping to the newErrNotFoundtype, and the error message now includes the index, providing more context.For consistency with other error messages and to improve clarity, consider the following changes:
Apply this diff to implement these changes:
These changes will make the error messages more uniform and clear across the file.
📝 Committable suggestion
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Improved error handling, but consider explicit ErrNotFound check
The changes improve error handling by using
errors.MapErrorand providing a formatted error message. This aligns with the PR objectives to enhance error reporting.However, to fully meet the PR objectives, consider explicitly checking for
collections.ErrNotFoundand returningbeacondb.ErrNotFound. This would ensure thatcollections.ErrNotFoundis never returned to clients, as specified in the PR summary.Here's a suggested implementation:
This change would make the use of
beacondb.ErrNotFoundexplicit and ensure thatcollections.ErrNotFoundis never returned to clients.