laconicd/x/registry/module/module.go

package module

import (
	"context"
	"encoding/json"
	"fmt"

	"cosmossdk.io/client/v2/autocli"
	appmodule "cosmossdk.io/core/appmodule/v2"
	"cosmossdk.io/core/registry"
	"github.com/cosmos/cosmos-sdk/client"
	"github.com/cosmos/cosmos-sdk/codec"
	sdk "github.com/cosmos/cosmos-sdk/types"
	"github.com/cosmos/cosmos-sdk/types/module"
	gwruntime "github.com/grpc-ecosystem/grpc-gateway/runtime"
	"github.com/spf13/cobra"

	registrytypes "git.vdb.to/cerc-io/laconicd/x/registry"
	"git.vdb.to/cerc-io/laconicd/x/registry/client/cli"
	"git.vdb.to/cerc-io/laconicd/x/registry/keeper"
)

var (
	_ appmodule.AppModule             = AppModule{}
	_ appmodule.HasConsensusVersion   = AppModule{}
	_ appmodule.HasEndBlocker         = AppModule{}
	_ appmodule.HasGenesis            = AppModule{}
	_ appmodule.HasMsgHandlers        = AppModule{}
	_ appmodule.HasQueryHandlers      = AppModule{}
	_ appmodule.HasRegisterInterfaces = AppModule{}

	_ module.HasGRPCGateway = AppModule{}
	// _ module.HasServices    = AppModule{}
	_ module.HasInvariants = AppModule{}
	// _ module.HasAminoCodec = AppModule{} // TODO

	_ autocli.HasCustomTxCommand = AppModule{}
)

// ConsensusVersion defines the current module consensus version.
const ConsensusVersion = 1

type AppModule struct {
	cdc    codec.Codec
	keeper keeper.Keeper
}

// NewAppModule creates a new AppModule object
func NewAppModule(cdc codec.Codec, keeper keeper.Keeper) AppModule {
	return AppModule{
		cdc:    cdc,
		keeper: keeper,
	}
}

// module.AppModule

// Name returns the registry module's name.
func (AppModule) Name() string { return registrytypes.ModuleName }

// module.HasGRPCGateway

// RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the registry module.
func (AppModule) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *gwruntime.ServeMux) {
	if err := registrytypes.RegisterQueryHandlerClient(context.Background(), mux, registrytypes.NewQueryClient(clientCtx)); err != nil {
		panic(err)
	}
}

// appmodule.HasRegisterInterfaces

// RegisterInterfaces registers interfaces and implementations of the registry module.
func (AppModule) RegisterInterfaces(registry registry.InterfaceRegistrar) {
	registrytypes.RegisterInterfaces(registry)
}

// ConsensusVersion implements AppModule/ConsensusVersion.
func (AppModule) ConsensusVersion() uint64 { return ConsensusVersion }

// appmodule.HasGenesis

// DefaultGenesis returns default genesis state as raw bytes for the module.
func (am AppModule) DefaultGenesis() json.RawMessage {
	return am.cdc.MustMarshalJSON(registrytypes.DefaultGenesisState())
}

// ValidateGenesis performs genesis state validation for the circuit module.
func (am AppModule) ValidateGenesis(bz json.RawMessage) error {
	var data registrytypes.GenesisState
	if err := am.cdc.UnmarshalJSON(bz, &data); err != nil {
		return fmt.Errorf("failed to unmarshal %s genesis state: %w", registrytypes.ModuleName, err)
	}

	return data.Validate()
}

// InitGenesis performs genesis initialization for the registry module.
// It returns no validator updates.
func (am AppModule) InitGenesis(ctx context.Context, data json.RawMessage) error {
	var genesisState registrytypes.GenesisState
	am.cdc.MustUnmarshalJSON(data, &genesisState)

	if err := am.keeper.InitGenesis(ctx, &genesisState); err != nil {
		return fmt.Errorf("failed to initialize %s genesis state: %w", registrytypes.ModuleName, err)
	}
	return nil
}

// ExportGenesis returns the exported genesis state as raw bytes for the circuit
// module.
func (am AppModule) ExportGenesis(ctx context.Context) (json.RawMessage, error) {
	gs, err := am.keeper.ExportGenesis(ctx)
	if err != nil {
		return nil, fmt.Errorf("failed to export %s genesis state: %w", registrytypes.ModuleName, err)
	}

	return am.cdc.MustMarshalJSON(gs), nil
}

// HasMsgHandlers

func (am AppModule) RegisterMsgHandlers(router appmodule.MsgRouter) {
	handlers := keeper.NewMsgServerImpl(am.keeper)

	appmodule.RegisterMsgHandler(router, handlers.AssociateBond)
	appmodule.RegisterMsgHandler(router, handlers.DeleteName)
	appmodule.RegisterMsgHandler(router, handlers.DissociateBond)
	appmodule.RegisterMsgHandler(router, handlers.DissociateRecords)
	appmodule.RegisterMsgHandler(router, handlers.ReassociateRecords)
	appmodule.RegisterMsgHandler(router, handlers.RenewRecord)
	appmodule.RegisterMsgHandler(router, handlers.ReserveAuthority)
	appmodule.RegisterMsgHandler(router, handlers.SetAuthorityBond)
	appmodule.RegisterMsgHandler(router, handlers.SetName)
	appmodule.RegisterMsgHandler(router, handlers.SetRecord)
	appmodule.RegisterMsgHandler(router, handlers.UpdateParams)
}

// HasQueryHandlers

func (am AppModule) RegisterQueryHandlers(router appmodule.QueryRouter) {
	handlers := keeper.NewQueryServerImpl(am.keeper)

	appmodule.RegisterMsgHandler(router, handlers.Authorities)
	appmodule.RegisterMsgHandler(router, handlers.GetRecord)
	appmodule.RegisterMsgHandler(router, handlers.GetRecordsByBondId)
	appmodule.RegisterMsgHandler(router, handlers.GetRegistryModuleBalance)
	appmodule.RegisterMsgHandler(router, handlers.LookupLrn)
	appmodule.RegisterMsgHandler(router, handlers.NameRecords)
	appmodule.RegisterMsgHandler(router, handlers.Params)
	appmodule.RegisterMsgHandler(router, handlers.Records)
	appmodule.RegisterMsgHandler(router, handlers.ResolveLrn)
	appmodule.RegisterMsgHandler(router, handlers.Whois)
}

// appmodule.HasEndBlocker

func (am AppModule) EndBlock(ctx context.Context) error {
	return EndBlocker(ctx, am.keeper)
}

// module.HasInvariants

func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry) {
	keeper.RegisterInvariants(ir, am.keeper)
}

// autocli.HasCustomTxCommand

// Get the root tx command of this module
func (AppModule) GetTxCmd() *cobra.Command {
	return cli.GetTxCmd()
}