Skip to content
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.

Sign up for GitHub

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

docs: Documented error handling in OfferSnapshot method #20380

Merged
merged 5 commits into from
May 15, 2024
Merged

docs: Documented error handling in OfferSnapshot method #20380

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e563c88
Documented error handling in OfferSnapshot method
lucaslopezf May 14, 2024
4b42158
Merge branch 'main' into lucas/handle-snapshot-timeout-error
lucaslopezf May 14, 2024
1f070d5
update changelog
lucaslopezf May 14, 2024
18a2bbf
Merge branch 'main' into lucas/handle-snapshot-timeout-error
cool-develope May 14, 2024
a81a136
Merge branch 'main' into lucas/handle-snapshot-timeout-error
lucaslopezf May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Every module contains its own CHANGELOG.md. Please refer to the module you are i
* (server) [#19966](https://github.com/cosmos/cosmos-sdk/pull/19966) Return BlockHeader by shallow copy in server Context.
* (proto) [#20098](https://github.com/cosmos/cosmos-sdk/pull/20098) Use cosmos_proto added_in annotation instead of // Since comments.
* (baseapp) [#20208](https://github.com/cosmos/cosmos-sdk/pull/20208) Skip running validateBasic for rechecking txs.
* (baseapp) [#20380](https://github.com/cosmos/cosmos-sdk/pull/20380) Enhanced OfferSnapshot documentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure consistency in the changelog entry format.

To maintain consistency with other entries, consider rephrasing to match the style used in previous entries. For example:

- * (baseapp) [#20380](https://github.com/cosmos/cosmos-sdk/pull/20380) Enhanced OfferSnapshot documentation.
+ * (baseapp) [#20380](https://github.com/cosmos/cosmos-sdk/pull/20380): Enhanced documentation for the OfferSnapshot method.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
* (baseapp) [#20380](https://github.com/cosmos/cosmos-sdk/pull/20380) Enhanced OfferSnapshot documentation.
* (baseapp) [#20380](https://github.com/cosmos/cosmos-sdk/pull/20380): Enhanced documentation for the OfferSnapshot method.


### Bug Fixes

Expand Down
4 changes: 4 additions & 0 deletions baseapp/abci.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,10 @@ func (app *BaseApp) OfferSnapshot(req *abci.OfferSnapshotRequest) (*abci.OfferSn
return &abci.OfferSnapshotResponse{Result: abci.OFFER_SNAPSHOT_RESULT_REJECT}, nil

default:
// CometBFT errors are defined here: https://github.com/cometbft/cometbft/blob/main/statesync/syncer.go
// It may happen that in case of a CometBFT error, such as a timeout (which occurs after two minutes),
// the process is aborted. This is done intentionally because deleting the database programmatically
// can lead to more complicated situations.
app.logger.Error(
"failed to restore snapshot",
"height", req.Snapshot.Height,
Expand Down
Loading