feat(x/bank): support depinject for send restrictions (#20014)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

x/bank/CHANGELOG.md

@@ -28,6 +28,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### Features
 
 * [#17569](https://github.com/cosmos/cosmos-sdk/pull/17569) Introduce a new message type, `MsgBurn`, to burn coins.
+* [#20014](https://github.com/cosmos/cosmos-sdk/pull/20014) Support app wiring for `SendRestrictionFn`.
 
 ### Improvements
 

x/bank/depinject.go

@@ -1,6 +1,11 @@
 package bank
 
 import (
+	"fmt"
+	"sort"
+
+	"golang.org/x/exp/maps"
+
 	modulev1 "cosmossdk.io/api/cosmos/bank/module/v1"
 	"cosmossdk.io/core/appmodule"
 	"cosmossdk.io/depinject"
@@ -18,8 +23,10 @@ var _ depinject.OnePerModuleType = AppModule{}
 func (am AppModule) IsOnePerModuleType() {}
 
 func init() {
-	appconfig.RegisterModule(&modulev1.Module{},
+	appconfig.RegisterModule(
+		&modulev1.Module{},
 		appconfig.Provide(ProvideModule),
+		appconfig.Invoke(InvokeSetSendRestrictions),
 	)
 }
 
@@ -86,3 +93,39 @@ func ProvideModule(in ModuleInputs) ModuleOutputs {
 
 	return ModuleOutputs{BankKeeper: bankKeeper, Module: m}
 }
+
+func InvokeSetSendRestrictions(
+	config *modulev1.Module,
+	keeper keeper.BaseKeeper,
+	restrictions map[string]types.SendRestrictionFn,
+) error {
+	if config == nil {
+		return nil
+	}
+
+	modules := maps.Keys(restrictions)
+	order := config.RestrictionsOrder
+	if len(order) == 0 {
+		order = modules
+		sort.Strings(order)
+	}
+
+	if len(order) != len(modules) {
+		return fmt.Errorf("len(restrictions order: %v) != len(restriction modules: %v)", order, modules)
+	}
+
+	if len(modules) == 0 {
+		return nil
+	}
+
+	for _, module := range order {
+		restriction, ok := restrictions[module]
+		if !ok {
+			return fmt.Errorf("can't find send restriction for module %s", module)
+		}
+
+		keeper.AppendSendRestriction(restriction)
+	}
+
+	return nil
+}

x/bank/proto/cosmos/bank/module/v1/module.proto

@@ -17,4 +17,10 @@ message Module {
 
   // authority defines the custom module authority. If not set, defaults to the governance module.
   string authority = 2;
+
+  // restrictions_order specifies the order of send restrictions and should be
+  // a list of module names which provide a send restriction instance. If no
+  // order is provided, then restrictions will be applied in alphabetical order
+  // of module names.
+  repeated string restrictions_order = 3;
 }

x/bank/types/restrictions.go

@@ -54,6 +54,9 @@ func ComposeMintingRestrictions(restrictions ...MintingRestrictionFn) MintingRes
 // A SendRestrictionFn can restrict sends and/or provide a new receiver address.
 type SendRestrictionFn func(ctx context.Context, fromAddr, toAddr sdk.AccAddress, amt sdk.Coins) (newToAddr sdk.AccAddress, err error)
 
+// IsOnePerModuleType implements the depinject.OnePerModuleType interface.
+func (SendRestrictionFn) IsOnePerModuleType() {}
+
 var _ SendRestrictionFn = NoOpSendRestrictionFn
 
 // NoOpSendRestrictionFn is a no-op SendRestrictionFn.