genutil

package module
v0.0.0-...-2fe96dc Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 25, 2024 License: Apache-2.0 Imports: 34 Imported by: 0

Documentation

Overview

nolint autogenerated code using github.com/rigelrozanski/multitool aliases generated for the following subdirectories: ALIASGEN: cschain/modules/genutil/types

Package genutil contains a variety of genesis utility functionality for usage within a blockchain application. Namely:

  • Genesis transactions related (gentx)
  • commands for collection and creation of gentxs
  • initchain processing of gentxs
  • Genesis file validation
  • Tendermint related initialization

Index

Constants

View Source 
const (
	ModuleName = types.ModuleName
)

Variables

View Source 
var (
	// functions aliases
	NewGenesisState             = types.NewGenesisState
	NewInitConfig               = types.NewInitConfig
	GetGenesisStateFromAppState = types.GetGenesisStateFromAppState
	SetGenesisStateInAppState   = types.SetGenesisStateInAppState
	GenesisStateFromGenDoc      = types.GenesisStateFromGenDoc
	GenesisStateFromGenFile     = types.GenesisStateFromGenFile
	ValidateGenesis             = types.ValidateGenesis

	// variable aliases
	ModuleCdc = types.ModuleCdc
)

Functions

func AddGenTxsInAppGenesisState 

func AddGenTxsInAppGenesisState(
	cdc codec.JSONCodec, txJSONEncoder sdk.TxEncoder,
	appGenesisState map[string]json.RawMessage, genTxs []sdk.Tx,
) (map[string]json.RawMessage, error)

AddGenTxsInAppGenesisState - add the genesis transactions in the app genesis state

func CollectTxs 

func CollectTxs(
	cdc codec.JSONCodec, txJSONDecoder sdk.TxDecoder,
	moniker, genTxsDir string, genDoc tmtypes.GenesisDoc,
) (
	appGenTxs []sdk.Tx, persistentPeers string, err error,
)

CollectTxs processes and validates application's genesis Txs and returns the list of appGenTxs, and persistent peers required to generate genesis.json.

func DeliverGenTxs 

func DeliverGenTxs(
	ctx sdk.Context, genTxs []json.RawMessage,
	nodeKeeper types.NodeKeeper, deliverTx deliverTxfn,
	txEncodingConfig client.TxEncodingConfig,
) []abci.ValidatorUpdate

DeliverGenTxs iterates over all genesis txs, decodes each into a StdTx and invokes the provided deliverTxfn with the decoded StdTx. It returns the result of the node module's ApplyAndReturnValidatorSetUpdates.

func ExportGenesisFile 

func ExportGenesisFile(genDoc *tmtypes.GenesisDoc, genFile string) error

ExportGenesisFile creates and writes the genesis configuration to disk. An error is returned if building or writing the configuration to file fails.

func ExportGenesisFileWithTime 

func ExportGenesisFileWithTime(
	genFile, chainID string, validators []tmtypes.GenesisValidator,
	appState json.RawMessage, genTime time.Time,
) error

ExportGenesisFileWithTime creates and writes the genesis configuration to disk. An error is returned if building or writing the configuration to file fails.

func GenAppStateFromConfig 

func GenAppStateFromConfig(
	cdc codec.JSONCodec, txEncodingConfig client.TxEncodingConfig,
	config *cfg.Config, initCfg InitConfig, genDoc tmtypes.GenesisDoc,
) (appState json.RawMessage, err error)

GenAppStateFromConfig gets the genesis app state from the config

func Genkey 

func Genkey(privKey crypto.PrivKey) ([]byte, error)

func InitGenesis 

func InitGenesis(
	ctx sdk.Context, nodeKeeper types.NodeKeeper,
	deliverTx deliverTxfn, genesisState types.GenesisState,
	txEncodingConfig client.TxEncodingConfig,
) []abci.ValidatorUpdate

InitGenesis - initialize accounts and deliver genesis transactions

func InitializeNodeValidatorFiles 

func InitializeNodeValidatorFiles(config *cfg.Config) (nodeKey *p2p.NodeKey, pv *privval.FilePV, err error)

InitializeNodeValidatorFiles creates private validator and p2p configuration files.

func NewAppModule 

func NewAppModule(
	accountKeeper types.AccountKeeper,
	nodeKeeper types.NodeKeeper,
	deliverTx deliverTxfn,
	txEncodingConfig client.TxEncodingConfig,
) module.GenesisOnlyAppModule

NewAppModule creates a new AppModule object

func ProvideModule 

func ProvideModule(in GenutilInputs) appmodule.AppModule

Types

type AppMap 

type AppMap = types.AppMap

type AppModule 

type AppModule struct {
	AppModuleBasic
	// contains filtered or unexported fields
}

AppModule implements an application module for the genutil module.

func (AppModule) ConsensusVersion 

func (am AppModule) ConsensusVersion() uint64

ConsensusVersion implements AppModule/ConsensusVersion.

func (AppModule) ExportGenesis 

func (am AppModule) ExportGenesis(_ sdk.Context, cdc codec.JSONCodec) json.RawMessage

ExportGenesis returns the exported genesis state as raw bytes for the genutil module.

func (AppModule) InitGenesis 

func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, data json.RawMessage) []abci.ValidatorUpdate

InitGenesis performs genesis initialization for the genutil module. It returns no validator updates.

func (AppModule) IsAppModule 

func (am AppModule) IsAppModule()

func (AppModule) IsOnePerModuleType 

func (am AppModule) IsOnePerModuleType()

type AppModuleBasic 

type AppModuleBasic struct{}

AppModuleBasic defines the basic application module used by the genutil module.

func (AppModuleBasic) DefaultGenesis 

func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage

DefaultGenesis returns default genesis state as raw bytes for the genutil module.

func (AppModuleBasic) GetQueryCmd 

func (AppModuleBasic) GetQueryCmd() *cobra.Command

GetQueryCmd returns no root query command for the genutil module.

func (AppModuleBasic) GetTxCmd 

func (AppModuleBasic) GetTxCmd() *cobra.Command

GetTxCmd returns no root tx command for the genutil module.

func (AppModuleBasic) Name 

func (AppModuleBasic) Name() string

Name returns the genutil module's name.

func (AppModuleBasic) RegisterGRPCGatewayRoutes 

func (a AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux)

RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the genutil module.

func (AppModuleBasic) RegisterInterfaces 

func (AppModuleBasic) RegisterInterfaces(registry codectypes.InterfaceRegistry)

RegisterInterfaces registers interfaces and implementations of the genutil module.

func (AppModuleBasic) RegisterLegacyAminoCodec 

func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

RegisterLegacyAminoCodec registers the genutil module's types for the given codec.

func (AppModuleBasic) RegisterRESTRoutes 

func (AppModuleBasic) RegisterRESTRoutes(clientCtx client.Context, rtr *mux.Router)

RegisterRESTRoutes registers the REST routes for the genutil module.

func (AppModuleBasic) ValidateGenesis 

func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error

ValidateGenesis performs genesis state validation for the genutil module.

type GenesisState 

type GenesisState = types.GenesisState

type GenutiOutputs 

type GenutiOutputs struct {
	depinject.Out
	Module appmodule.AppModule
}

type GenutilInputs 

type GenutilInputs struct {
	depinject.In
	AccountKeeper types.AccountKeeper
	NodeKeeper    types.NodeKeeper
	DeliverTx     func(abci.RequestDeliverTx) abci.ResponseDeliverTx
	TxConfig      client.TxConfig
}

type InitConfig 

type InitConfig = types.InitConfig

type MigrationCallback 

type MigrationCallback = types.MigrationCallback

type MigrationMap 

type MigrationMap = types.MigrationMap

Source Files

View all Source files

Directories

Path Synopsis
client
cli
rest
ca

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.