refactor(gov)!: use collections for deposit state management #16127
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…' into tip/gov/coll-params-constitution
added 2 commits
May 12, 2023 10:54
# Conflicts: # x/gov/keeper/keeper.go
testinginprod
commented
May 12, 2023
| return nil | ||
| coinsToBurn := sdk.NewCoins() | ||
| err := keeper.IterateDeposits(ctx, proposalID, func(key collections.Pair[uint64, sdk.AccAddress], deposit v1.Deposit) bool { | ||
| coinsToBurn = coinsToBurn.Add(deposit.Amount...) |
There was a problem hiding this comment.
this is a behavioural change, for which we compute the total amount of coins to burn and then we burn them all in a single batch
testinginprod
commented
May 12, 2023
| @@ -91,9 +92,9 @@ func (q queryServer) Proposals(ctx context.Context, req *v1.QueryProposalsReques | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| _, err = q.k.GetDeposit(ctx, p.Id, depositor) | |||
| has, err := q.k.Deposits.Has(ctx, collections.Join(p.Id, sdk.AccAddress(depositor))) | |||
There was a problem hiding this comment.
behavioural change, perf improvement: uses Has instead of Get in order to avoid getting the value from store and decoding it
added 2 commits
May 12, 2023 11:12
testinginprod
commented
May 12, 2023
| @@ -353,7 +353,7 @@ func (AppModule) ProposalMsgs(simState module.SimulationState) []simtypes.Weight | |||
|
|
|||
| // RegisterStoreDecoder registers a decoder for gov module's types | |||
| func (am AppModule) RegisterStoreDecoder(sdr simtypes.StoreDecoderRegistry) { | |||
| sdr[govtypes.StoreKey] = simulation.NewDecodeStore(am.cdc) | |||
| sdr[govtypes.StoreKey] = simtypes.NewStoreDecoderFuncFromCollectionsSchema(am.keeper.Schema) | |||
There was a problem hiding this comment.
This does not support all gov states object currently because we haven't migrated all states objects to use collections
testinginprod
commented
May 13, 2023
| @@ -127,7 +127,7 @@ func (m Map[K, V]) Iterate(ctx context.Context, ranger Ranger[K]) (Iterator[K, V | |||
| // walk function with the decoded key and value. If the callback function | |||
| // returns true then the walking is stopped. | |||
| // A nil ranger equals to walking over the entire key and value set. | |||
| func (m Map[K, V]) Walk(ctx context.Context, ranger Ranger[K], walkFunc func(K, V) bool) error { | |||
| func (m Map[K, V]) Walk(ctx context.Context, ranger Ranger[K], walkFunc func(key K, value V) (stop bool, err error)) error { | |||
There was a problem hiding this comment.
added the possibility to make walkFunc error, this plays well with gov and generally is better to allow for a straightforward way to error during iterations and propagate errors back.
testinginprod
commented
May 13, 2023
| @@ -256,9 +258,12 @@ func (k BaseKeeper) GetAllDenomMetaData(ctx context.Context) []types.Metadata { | |||
| // provides the metadata to a callback. If true is returned from the | |||
| // callback, iteration is halted. | |||
| func (k BaseKeeper) IterateAllDenomMetaData(ctx context.Context, cb func(types.Metadata) bool) { | |||
| _ = k.BaseViewKeeper.DenomMetadata.Walk(ctx, nil, func(_ string, metadata types.Metadata) bool { | |||
| return cb(metadata) | |||
| err := k.BaseViewKeeper.DenomMetadata.Walk(ctx, nil, func(_ string, metadata types.Metadata) (stop bool, err error) { | |||
There was a problem hiding this comment.
adjusts to match the collections API breaking change.
testinginprod
commented
May 13, 2023
| @@ -474,7 +479,10 @@ func (k BaseKeeper) trackUndelegation(ctx context.Context, addr sdk.AccAddress, | |||
| // with the balance of each coin. | |||
| // The iteration stops if the callback returns true. | |||
| func (k BaseViewKeeper) IterateTotalSupply(ctx context.Context, cb func(sdk.Coin) bool) { | |||
| _ = k.Supply.Walk(ctx, nil, func(s string, m math.Int) bool { | |||
| return cb(sdk.NewCoin(s, m)) | |||
| err := k.Supply.Walk(ctx, nil, func(s string, m math.Int) (bool, error) { | |||
There was a problem hiding this comment.
adjusts to match the collections API breaking change.
testinginprod
commented
May 13, 2023
| @@ -376,7 +377,12 @@ func (k BaseSendKeeper) DeleteSendEnabled(ctx context.Context, denoms ...string) | |||
|
|
|||
| // IterateSendEnabledEntries iterates over all the SendEnabled entries. | |||
| func (k BaseSendKeeper) IterateSendEnabledEntries(ctx context.Context, cb func(denom string, sendEnabled bool) bool) { | |||
There was a problem hiding this comment.
adjusts to match the collections API breaking change.
tac0turtle
reviewed
May 15, 2023
julienrbrt
reviewed
May 15, 2023
julienrbrt
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Closes: #16126
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...
!to the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
!in the type prefix if API or client breaking change