feat(bank): Allow injectable restrictions on bank transfers

CHANGELOG.md

@@ -63,6 +63,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (x/groups) [#14879](https://github.com/cosmos/cosmos-sdk/pull/14879) Add `Query/Groups` query to get all the groups.
 * (x/genutil,cli) [#15147](https://github.com/cosmos/cosmos-sdk/pull/15147) Add `--initial-height` flag to cli init cmd to provide `genesis.json` with user defined initial block height
 * (x/gov) [#15151](https://github.com/cosmos/cosmos-sdk/pull/15151) Add `burn_vote_quorum`, `burn_proposal_deposit_prevote` and `burn_vote_veto` params to allow applications to decide if they would like to burn deposits
+* (x/bank) [#14224](https://github.com/cosmos/cosmos-sdk/pull/14224) Allow injection of restrictions on transfers using `AppendSendRestriction` or `PrependSendRestriction`.
 
 ### Improvements
 
@@ -135,6 +136,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (x/bank) [#14894](https://github.com/cosmos/cosmos-sdk/pull/14894) Allow a human readable denomination for coins when querying bank balances. Added a `ResolveDenom` parameter to `types.QueryAllBalancesRequest`.
 * (crypto) [#15070](https://github.com/cosmos/cosmos-sdk/pull/15070) `GenerateFromPassword` and `Cost` from `bcrypt.go` now take a `uint32` instead of a `int` type. 
 * (client) [#15123](https://github.com/cosmos/cosmos-sdk/pull/15123) `NewFactoryCLI` now returns an error, in addition to the `Factory`.
+* (x/bank) [#14224](https://github.com/cosmos/cosmos-sdk/pull/14224) `InputOutputCoins` now only allows for a single `Input`.
 
 ### Client Breaking Changes
 

tests/integration/bank/keeper/keeper_test.go

@@ -426,14 +426,12 @@ func TestInputOutputNewAccount(t *testing.T) {
  assert.Assert(t, f.accountKeeper.GetAccount(ctx, addr2) == nil)
  assert.Assert(t, f.bankKeeper.GetAllBalances(ctx, addr2).Empty())
 
- inputs := []types.Input{
- {Address: addr1.String(), Coins: sdk.NewCoins(newFooCoin(30), newBarCoin(10))},
- }
+ input := types.Input{Address: addr1.String(), Coins: sdk.NewCoins(newFooCoin(30), newBarCoin(10))}
  outputs := []types.Output{
  {Address: addr2.String(), Coins: sdk.NewCoins(newFooCoin(30), newBarCoin(10))},
  }
 
- assert.NilError(t, f.bankKeeper.InputOutputCoins(ctx, inputs, outputs))
+ assert.NilError(t, f.bankKeeper.InputOutputCoins(ctx, input, outputs))
 
  expected := sdk.NewCoins(newFooCoin(30), newBarCoin(10))
  acc2Balances := f.bankKeeper.GetAllBalances(ctx, addr2)
@@ -460,9 +458,7 @@ func TestInputOutputCoins(t *testing.T) {
  acc3 := f.accountKeeper.NewAccountWithAddress(ctx, addr3)
  f.accountKeeper.SetAccount(ctx, acc3)
 
- input := []types.Input{
- {Address: addr1.String(), Coins: sdk.NewCoins(newFooCoin(60), newBarCoin(20))},
- }
+ input := types.Input{Address: addr1.String(), Coins: sdk.NewCoins(newFooCoin(60), newBarCoin(20))}
  outputs := []types.Output{
  {Address: addr2.String(), Coins: sdk.NewCoins(newFooCoin(30), newBarCoin(10))},
  {Address: addr3.String(), Coins: sdk.NewCoins(newFooCoin(30), newBarCoin(10))},
@@ -473,11 +469,9 @@ func TestInputOutputCoins(t *testing.T) {
 
  assert.NilError(t, banktestutil.FundAccount(f.bankKeeper, ctx, addr1, balances))
 
- insufficientInput := []types.Input{
- {
- Address: addr1.String(),
- Coins: sdk.NewCoins(newFooCoin(300), newBarCoin(100)),
- },
+ insufficientInput := types.Input{
+ Address: addr1.String(),
+ Coins: sdk.NewCoins(newFooCoin(300), newBarCoin(100)),
  }
  insufficientOutputs := []types.Output{
  {Address: addr2.String(), Coins: sdk.NewCoins(newFooCoin(300), newBarCoin(100))},
@@ -722,11 +716,9 @@ func TestMsgMultiSendEvents(t *testing.T) {
  coins := sdk.NewCoins(sdk.NewInt64Coin(fooDenom, 50), sdk.NewInt64Coin(barDenom, 100))
  newCoins := sdk.NewCoins(sdk.NewInt64Coin(fooDenom, 50))
  newCoins2 := sdk.NewCoins(sdk.NewInt64Coin(barDenom, 100))
- input := []types.Input{
- {
- Address: addr.String(),
- Coins: coins,
- },
+ input := types.Input{
+ Address: addr.String(),
+ Coins: coins,
  }
  outputs := []types.Output{
  {Address: addr3.String(), Coins: newCoins},

x/bank/README.md

@@ -236,6 +236,9 @@ accounts. The send keeper does not alter the total supply (mint or burn coins).
 type SendKeeper interface {
  ViewKeeper
 
+ AppendSendRestriction(restriction SendRestrictionFn)
+ PrependSendRestriction(restriction SendRestrictionFn)
+
  InputOutputCoins(ctx sdk.Context, inputs []types.Input, outputs []types.Output) error
  SendCoins(ctx sdk.Context, fromAddr sdk.AccAddress, toAddr sdk.AccAddress, amt sdk.Coins) error
 

x/bank/keeper/export_test.go

@@ -0,0 +1,12 @@
+package keeper
+
+// This file exists in the keeper package to expose some private things
+// for the purpose of testing in the keeper_test package.
+
+func (k BaseSendKeeper) SetSendRestriction(restriction SendRestrictionFn) {
+ k.sendRestriction.Fn = restriction
+}
+
+func (k BaseSendKeeper) GetSendRestrictionFn() SendRestrictionFn {
+ return k.sendRestriction.Fn
+}

x/bank/keeper/keeper.go

@@ -63,8 +63,6 @@ type BaseKeeper struct {
  mintCoinsRestrictionFn MintingRestrictionFn
 }
 
-type MintingRestrictionFn func(ctx sdk.Context, coins sdk.Coins) error
-
 // GetPaginatedTotalSupply queries for the supply, ignoring 0 coins, with a given pagination
 func (k BaseKeeper) GetPaginatedTotalSupply(ctx sdk.Context, pagination *query.PageRequest) (sdk.Coins, *query.PageResponse, error) {
  store := ctx.KVStore(k.storeKey)
@@ -112,7 +110,7 @@ func NewBaseKeeper(
  ak: ak,
  cdc: cdc,
  storeKey: storeKey,
- mintCoinsRestrictionFn: func(ctx sdk.Context, coins sdk.Coins) error { return nil },
+ mintCoinsRestrictionFn: NoOpMintingRestrictionFn,
  }
 }
 
@@ -122,18 +120,7 @@ func NewBaseKeeper(
 //
 // bankKeeper.WithMintCoinsRestriction(restriction1).WithMintCoinsRestriction(restriction2)
 func (k BaseKeeper) WithMintCoinsRestriction(check MintingRestrictionFn) BaseKeeper {
- oldRestrictionFn := k.mintCoinsRestrictionFn
- k.mintCoinsRestrictionFn = func(ctx sdk.Context, coins sdk.Coins) error {
- err := check(ctx, coins)
- if err != nil {
- return err
- }
- err = oldRestrictionFn(ctx, coins)
- if err != nil {
- return err
- }
- return nil
- }
+ k.mintCoinsRestrictionFn = check.Then(k.mintCoinsRestrictionFn)
  return k
 }