mesg-foundation/core

View on GitHub
x/service/module.go

Summary

Maintainability
D
1 day
Test Coverage
package service

import (
    "encoding/json"

    "github.com/cosmos/cosmos-sdk/client/context"
    "github.com/cosmos/cosmos-sdk/codec"
    sdk "github.com/cosmos/cosmos-sdk/types"
    "github.com/cosmos/cosmos-sdk/types/module"
    "github.com/gorilla/mux"
    "github.com/mesg-foundation/engine/x/service/client/cli"
    "github.com/mesg-foundation/engine/x/service/client/rest"
    "github.com/mesg-foundation/engine/x/service/internal/types"
    "github.com/spf13/cobra"
    abci "github.com/tendermint/tendermint/abci/types"
)

var (
    _ module.AppModule      = AppModule{}
    _ module.AppModuleBasic = AppModuleBasic{}
)

// AppModuleBasic defines the basic application module used by the service module.
type AppModuleBasic struct{}

var _ module.AppModuleBasic = AppModuleBasic{}

// Name returns the service module's name.
func (AppModuleBasic) Name() string {
    return types.ModuleName
}

// RegisterCodec registers the service module's types for the given codec.
func (AppModuleBasic) RegisterCodec(cdc *codec.Codec) {
    RegisterCodec(cdc)
}

// DefaultGenesis returns default genesis state as raw bytes for the service
// module.
func (AppModuleBasic) DefaultGenesis() json.RawMessage {
    return ModuleCdc.MustMarshalJSON(DefaultGenesisState())
}

// ValidateGenesis performs genesis state validation for the service module.
func (AppModuleBasic) ValidateGenesis(bz json.RawMessage) error {
    var data GenesisState
    err := ModuleCdc.UnmarshalJSON(bz, &data)
    if err != nil {
        return err
    }
    return ValidateGenesis(data)
}

// RegisterRESTRoutes registers the REST routes for the service module.
func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, rtr *mux.Router) {
    rest.RegisterRoutes(ctx, rtr)
}

// GetTxCmd returns the root tx command for the service module.
func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command {
    return cli.GetTxCmd(cdc)
}

// GetQueryCmd returns no root query command for the service module.
func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command {
    return cli.GetQueryCmd(StoreKey, cdc)
}

//____________________________________________________________________________

// AppModule implements an application module for the service module.
type AppModule struct {
    AppModuleBasic

    keeper Keeper
}

// NewAppModule creates a new AppModule object
func NewAppModule(k Keeper) AppModule {
    return AppModule{
        AppModuleBasic: AppModuleBasic{},
        keeper:         k,
    }
}

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

// RegisterInvariants registers the service module invariants.
func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry) {}

// Route returns the message routing key for the service module.
func (AppModule) Route() string {
    return RouterKey
}

// NewHandler returns an sdk.Handler for the service module.
func (am AppModule) NewHandler() sdk.Handler {
    return NewHandler(am.keeper)
}

// QuerierRoute returns the service module's querier route name.
func (AppModule) QuerierRoute() string {
    return QuerierRoute
}

// NewQuerierHandler returns the service module sdk.Querier.
func (am AppModule) NewQuerierHandler() sdk.Querier {
    return NewQuerier(am.keeper)
}

// InitGenesis performs genesis initialization for the service module. It returns
// no validator updates.
func (am AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate {
    var genesisState GenesisState
    ModuleCdc.MustUnmarshalJSON(data, &genesisState)
    InitGenesis(ctx, am.keeper, genesisState)
    return []abci.ValidatorUpdate{}
}

// ExportGenesis returns the exported genesis state as raw bytes for the service
// module.
func (am AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage {
    gs := ExportGenesis(ctx, am.keeper)
    return ModuleCdc.MustMarshalJSON(gs)
}

// BeginBlock returns the begin blocker for the service module.
func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {
    BeginBlocker(ctx, req, am.keeper)
}

// EndBlock returns the end blocker for the service module. It returns no validator
// updates.
func (am AppModule) EndBlock(ctx sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate {
    EndBlocker(ctx, am.keeper)
    return []abci.ValidatorUpdate{}
}