From af52ed70bb174c39efc39d80908b5a27107b9d91 Mon Sep 17 00:00:00 2001 From: Aleksandr Bezobchuk Date: Fri, 6 Aug 2021 10:23:13 -0400 Subject: [PATCH] refactor: update default pruning strategy (#9859) The `default` pruning strategy, specifically the total number of recent blocks to keep (currently 100), was decided on completely arbitrary. I propose we change it to be enough blocks given that the typical block time is 5s and typical unbonding period is 21 days: (3600*(24/5)) * 21 = 362880. I propose this because anyone wishing to run an IBC relayer, which will be most chains, will have to be required to use `custom` to set it to this value anyway. So why not just make it the default and make it easier for operators. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable) (cherry picked from commit 6b24ada74355a1e28b20ab45d9637c3b23485d36) --- store/types/pruning.go | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/store/types/pruning.go b/store/types/pruning.go index 823da76c6585..4419acb950d8 100644 --- a/store/types/pruning.go +++ b/store/types/pruning.go @@ -11,10 +11,12 @@ const ( ) var ( - // PruneDefault defines a pruning strategy where the last 100 heights are kept - // in addition to every 100th and where to-be pruned heights are pruned at - // every 10th height. - PruneDefault = NewPruningOptions(100, 100, 10) + // PruneDefault defines a pruning strategy where the last 362880 heights are + // kept in addition to every 100th and where to-be pruned heights are pruned + // at every 10th height. The last 362880 heights are kept assuming the typical + // block time is 5s and typical unbonding period is 21 days. If these values + // do not match the applications' requirements, use the "custom" option. + PruneDefault = NewPruningOptions(362880, 100, 10) // PruneEverything defines a pruning strategy where all committed heights are // deleted, storing only the current height and where to-be pruned heights are