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.

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

refactor!: use KVStoreService and context.Context in x/bank #15891

Merged
merged 55 commits into from
Apr 26, 2023

Conversation

facundomedica
Copy link
Member

@facundomedica facundomedica commented Apr 19, 2023

Description

  • Use KVStoreService
  • Reduce usage of sdk.Context

We are still using runtime.KVStoreAdapter in cases we use prefix.Store.

Also because there were a couple of functions that had the context as the 2nd argument, now that it's a context.Context the linter picked it up as an error, so there are a lot of changes like this:

-		s.Require().NoError(banktestutil.FundAccount(bankKeeper, ctx, account.Address, initCoins))
+		s.Require().NoError(banktestutil.FundAccount(ctx, bankKeeper, account.Address, initCoins))

Ref: #14683


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 in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • 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 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)

@facundomedica facundomedica changed the title refactor!: use KVStoreService in x/bank refactor!: use Core API in x/bank Apr 19, 2023
@facundomedica facundomedica changed the title refactor!: use Core API in x/bank refactor!: use KVStoreService and context.Context in x/bank Apr 19, 2023
@facundomedica facundomedica marked this pull request as ready for review April 25, 2023 14:49
@facundomedica facundomedica requested a review from a team as a code owner April 25, 2023 14:49
@github-prbot github-prbot requested review from a team, mark-rushakoff and samricotta and removed request for a team April 25, 2023 14:49
@@ -12,7 +14,7 @@ import (
//
// TODO: Instead of using the mint module account, which has the
// permission of minting, create a "faucet" account. (@fdymylja)
func FundAccount(bankKeeper bankkeeper.Keeper, ctx sdk.Context, addr sdk.AccAddress, amounts sdk.Coins) error {
func FundAccount(ctx context.Context, bankKeeper bankkeeper.Keeper, addr sdk.AccAddress, amounts sdk.Coins) error {
Copy link
Member

Choose a reason for hiding this comment

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

changelog for this as well, it might be used by others

Copy link
Member

Choose a reason for hiding this comment

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

This changelog entry is still missing.

Copy link
Member Author

Choose a reason for hiding this comment

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

I misread, now I've added:

`NewKeeper` now takes a `KVStoreService` instead of a `StoreKey` and methods in the `Keeper` now take a `context.Context` instead of a `sdk.Context`. Also `FundAccount` and `FundModuleAccount` from the `testutil` package accept a `context.Context` instead of a `sdk.Context`, and it's position was moved to the first place.

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

left a few comments for changelogs otherwise looks good, nice job

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm! one tiny nit.

@@ -134,7 +135,8 @@ func (k BaseSendKeeper) InputOutputCoins(ctx sdk.Context, input types.Input, out
return err
}

ctx.EventManager().EmitEvent(
c := sdk.UnwrapSDKContext(ctx)
Copy link
Member

Choose a reason for hiding this comment

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

nit, sdkCtx is usually how we call it.

Copy link
Member Author

Choose a reason for hiding this comment

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

whoops, ty

@@ -249,7 +252,8 @@ func (k BaseSendKeeper) subUnlockedCoins(ctx sdk.Context, addr sdk.AccAddress, a
}
}

ctx.EventManager().EmitEvent(
c := sdk.UnwrapSDKContext(ctx)
Copy link
Member

Choose a reason for hiding this comment

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

ditto

@tac0turtle tac0turtle added this pull request to the merge queue Apr 26, 2023
Merged via the queue into main with commit 6dfe735 Apr 26, 2023
@tac0turtle tac0turtle deleted the facu/bank-kvservice branch April 26, 2023 10:14
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants