Setup hooks between laconic modules (#9)

- Implement auction and bond module hooks in registry module
- Code cleanup

Reviewed-on: deep-stack/laconic2d#9
Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
Co-committed-by: Prathamesh Musale <prathamesh.musale0@gmail.com>

x/bond/expected_keeper.go

@@ -0,0 +1,19 @@
+package bond
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+// BondUsageKeeper keep track of bond usage in other modules.
+// Used to, for example, prevent deletion of a bond that's in use.
+type BondUsageKeeper interface {
+	ModuleName() string
+	UsesBond(ctx sdk.Context, bondId string) bool
+}
+
+// BondHooksWrapper is a wrapper for modules to inject BondUsageKeeper using depinject.
+// Reference: https://github.com/cosmos/cosmos-sdk/tree/v0.50.3/core/appmodule#resolving-circular-dependencies
+type BondHooksWrapper struct{ BondUsageKeeper }
+
+// IsOnePerModuleType implements the depinject.OnePerModuleType interface.
+func (BondHooksWrapper) IsOnePerModuleType() {}

x/bond/keeper/keeper.go

@@ -49,7 +49,7 @@ type Keeper struct {
 	bankKeeper    bank.Keeper
 
 	// Track bond usage in other cosmos-sdk modules (more like a usage tracker).
-	// usageKeepers []types.BondUsageKeeper
+	usageKeepers []bondtypes.BondUsageKeeper
 
 	// State management
 	Schema collections.Schema
@@ -63,8 +63,7 @@ func NewKeeper(
 	storeService store.KVStoreService,
 	accountKeeper auth.AccountKeeper,
 	bankKeeper bank.Keeper,
-	// usageKeepers []types.BondUsageKeeper,
-) Keeper {
+) *Keeper {
 	sb := collections.NewSchemaBuilder(storeService)
 	k := Keeper{
 		cdc:           cdc,
@@ -72,7 +71,7 @@ func NewKeeper(
 		bankKeeper:    bankKeeper,
 		Params:        collections.NewItem(sb, bondtypes.ParamsPrefix, "params", codec.CollValue[bondtypes.Params](cdc)),
 		Bonds:         collections.NewIndexedMap(sb, bondtypes.BondsPrefix, "bonds", collections.StringKey, codec.CollValue[bondtypes.Bond](cdc), newBondIndexes(sb)),
-		// usageKeepers:  usageKeepers,
+		usageKeepers:  nil,
 	}
 
 	schema, err := sb.Build()
@@ -82,7 +81,15 @@ func NewKeeper(
 
 	k.Schema = schema
 
-	return k
+	return &k
+}
+
+func (k *Keeper) SetUsageKeepers(usageKeepers []bondtypes.BondUsageKeeper) {
+	if k.usageKeepers != nil {
+		panic("cannot set bond hooks twice")
+	}
+
+	k.usageKeepers = usageKeepers
 }
 
 // BondId simplifies generation of bond Ids.
@@ -318,13 +325,12 @@ func (k Keeper) CancelBond(ctx sdk.Context, id string, ownerAddress sdk.AccAddre
 		return nil, errorsmod.Wrap(sdkerrors.ErrUnauthorized, "Bond owner mismatch.")
 	}
 
-	// TODO
 	// Check if bond is used in other modules.
-	// for _, usageKeeper := range k.usageKeepers {
-	// 	if usageKeeper.UsesBond(ctx, id) {
-	// 		return nil, errorsmod.Wrap(sdkerrors.ErrUnauthorized, fmt.Sprintf("Bond in use by the '%s' module.", usageKeeper.ModuleName()))
-	// 	}
-	// }
+	for _, usageKeeper := range k.usageKeepers {
+		if usageKeeper.UsesBond(ctx, id) {
+			return nil, errorsmod.Wrap(sdkerrors.ErrUnauthorized, fmt.Sprintf("Bond in use by the '%s' module.", usageKeeper.ModuleName()))
+		}
+	}
 
 	// Move funds from the bond into the account.
 	err = k.bankKeeper.SendCoinsFromModuleToAccount(ctx, bondtypes.ModuleName, ownerAddress, bond.Balance)

x/bond/keeper/msg_server.go

@@ -11,11 +11,11 @@ import (
 var _ bond.MsgServer = msgServer{}
 
 type msgServer struct {
-	k Keeper
+	k *Keeper
 }
 
 // NewMsgServerImpl returns an implementation of the module MsgServer interface.
-func NewMsgServerImpl(keeper Keeper) bond.MsgServer {
+func NewMsgServerImpl(keeper *Keeper) bond.MsgServer {
 	return &msgServer{k: keeper}
 }
 

x/bond/keeper/query_server.go

@@ -13,11 +13,11 @@ import (
 var _ bondtypes.QueryServer = queryServer{}
 
 type queryServer struct {
-	k Keeper
+	k *Keeper
 }
 
 // NewQueryServerImpl returns an implementation of the module QueryServer.
-func NewQueryServerImpl(k Keeper) bondtypes.QueryServer {
+func NewQueryServerImpl(k *Keeper) bondtypes.QueryServer {
 	return queryServer{k}
 }
 

x/bond/module/depinject.go

@@ -4,12 +4,14 @@ import (
 	"cosmossdk.io/core/appmodule"
 	"cosmossdk.io/core/store"
 	"cosmossdk.io/depinject"
+	"golang.org/x/exp/maps"
 
 	"github.com/cosmos/cosmos-sdk/codec"
 	auth "github.com/cosmos/cosmos-sdk/x/auth/keeper"
 	bank "github.com/cosmos/cosmos-sdk/x/bank/keeper"
 
 	modulev1 "git.vdb.to/cerc-io/laconic2d/api/cerc/bond/module/v1"
+	"git.vdb.to/cerc-io/laconic2d/x/bond"
 	"git.vdb.to/cerc-io/laconic2d/x/bond/keeper"
 )
 
@@ -25,6 +27,7 @@ func init() {
 	appmodule.Register(
 		&modulev1.Module{},
 		appmodule.Provide(ProvideModule),
+		appmodule.Invoke(InvokeSetBondHooks),
 	)
 }
 
@@ -41,7 +44,7 @@ type ModuleInputs struct {
 type ModuleOutputs struct {
 	depinject.Out
 
-	Keeper keeper.Keeper
+	Keeper *keeper.Keeper
 	Module appmodule.AppModule
 }
 
@@ -51,3 +54,25 @@ func ProvideModule(in ModuleInputs) ModuleOutputs {
 
 	return ModuleOutputs{Module: m, Keeper: k}
 }
+
+func InvokeSetBondHooks(
+	config *modulev1.Module,
+	keeper *keeper.Keeper,
+	bondHooks map[string]bond.BondHooksWrapper,
+) error {
+	// all arguments to invokers are optional
+	if keeper == nil || config == nil {
+		return nil
+	}
+
+	var usageKeepers []bond.BondUsageKeeper
+
+	for _, modName := range maps.Keys(bondHooks) {
+		hook := bondHooks[modName]
+		usageKeepers = append(usageKeepers, hook)
+	}
+
+	keeper.SetUsageKeepers(usageKeepers)
+
+	return nil
+}

x/bond/module/module.go

@@ -18,8 +18,6 @@ import (
 	"git.vdb.to/cerc-io/laconic2d/x/bond/keeper"
 )
 
-// TODO: Port remaining AppModule methods
-
 var (
 	_ module.AppModuleBasic      = AppModule{}
 	_ appmodule.AppModule        = AppModule{}
@@ -33,11 +31,11 @@ const ConsensusVersion = 1
 
 type AppModule struct {
 	cdc    codec.Codec
-	keeper keeper.Keeper
+	keeper *keeper.Keeper
 }
 
 // NewAppModule creates a new AppModule object
-func NewAppModule(cdc codec.Codec, keeper keeper.Keeper) AppModule {
+func NewAppModule(cdc codec.Codec, keeper *keeper.Keeper) AppModule {
 	return AppModule{
 		cdc:    cdc,
 		keeper: keeper,