configuration

package
Version: v0.9.8 Latest Latest
Warning

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

Go to latest
Published: Nov 12, 2020 License: Apache-2.0 Imports: 21 Imported by: 0

README

TODO PLEASE FILL.

Documentation

Overview

Package configuration contains the iovns module for handling state configuration such as account

Index

Constants

View Source
const (
	ModuleName        = types.ModuleName   // ModuleName aliases types.ModuleName
	RouterKey         = types.RouterKey    // RouterKey aliases types.RouterKey
	QuerierRoute      = types.QuerierRoute // QuerierRoute aliases types.QuerierRoute
	QueryConfig       = types.QueryConfig  // QueryConfig aliases types.QueryConfig
	StoreKey          = types.StoreKey     // StoreKey aliases types.StoreKey
	DefaultParamSpace = types.DefaultParamSpace
)

alias for consts

View Source
const RegexMatchAll = "^(.*?)?"
View Source
const RegexMatchNothing = "$^"

Variables

View Source
var (
	// NewFees aliases types.NewFees
	NewFees = types.NewFees
	// RegisterCodec aliases types.RegisterCodec
	RegisterCodec = types.RegisterCodec
)
View Source
var AliceKey types.AccAddress = addrs[0]
View Source
var BobKey types.AccAddress = addrs[1]
View Source
var CharlieKey types.AccAddress = addrs[2]

Functions

func AvailableQueries added in v0.4.3

func AvailableQueries() []queries.QueryHandler

AvailableQueries returns the list of available queries in the module

func InitGenesis

func InitGenesis(ctx sdk.Context, k Keeper, data GenesisState)

InitGenesis sets the initial state of the configuration module

func NewHandler

func NewHandler(k Keeper) sdk.Handler

NewHandler returns the handlers for the configuration module

func NewQuerier

func NewQuerier(k Keeper) sdk.Querier

NewQuerier builds the query handler for the module

func NewTestCodec added in v0.4.5

func NewTestCodec() *codec.Codec

NewTestCodec generates aliceAddr mock codec for keeper module

func RunTests added in v0.4.5

func RunTests(t *testing.T, tests map[string]SubTest)

runTests run tests cases after generating a new keeper and context for each test case

func ValidateGenesis

func ValidateGenesis(data GenesisState) error

ValidateGenesis makes sure that the genesis state is valid

Types

type AppModule

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

- - FILL APP MODULE - -

func NewAppModule

func NewAppModule(k Keeper) AppModule

func (AppModule) BeginBlock

func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock)

func (AppModule) EndBlock

func (AppModule) ExportGenesis

func (a AppModule) ExportGenesis(ctx sdk.Context) json.RawMessage

func (AppModule) InitGenesis

func (a AppModule) InitGenesis(ctx sdk.Context, data json.RawMessage) []abci.ValidatorUpdate

func (AppModule) Name

func (AppModule) Name() string

func (AppModule) NewHandler

func (a AppModule) NewHandler() sdk.Handler

func (AppModule) NewQuerierHandler

func (a AppModule) NewQuerierHandler() sdk.Querier

func (AppModule) QuerierRoute

func (AppModule) QuerierRoute() string

func (AppModule) RegisterInvariants

func (AppModule) RegisterInvariants(_ sdk.InvariantRegistry)

func (AppModule) Route

func (AppModule) Route() string

type AppModuleBasic

type AppModuleBasic struct{}

nolint - - - FILL APP MODULE BASIC -- // AppModuleBasic implements the AppModuleBasic interface of the cosmos-sdk

func (AppModuleBasic) DefaultGenesis

func (AppModuleBasic) DefaultGenesis() json.RawMessage

func (AppModuleBasic) GetQueryCmd

func (AppModuleBasic) GetQueryCmd(cdc *codec.Codec) *cobra.Command

func (AppModuleBasic) GetTxCmd

func (AppModuleBasic) GetTxCmd(cdc *codec.Codec) *cobra.Command

func (AppModuleBasic) Name

func (AppModuleBasic) Name() string

func (AppModuleBasic) RegisterCodec

func (AppModuleBasic) RegisterCodec(cdc *codec.Codec)

func (AppModuleBasic) RegisterRESTRoutes

func (AppModuleBasic) RegisterRESTRoutes(ctx context.CLIContext, router *mux.Router)

func (AppModuleBasic) ValidateGenesis

func (AppModuleBasic) ValidateGenesis(b json.RawMessage) (err error)

type Config

type Config = types.Config

Config aliases types.Config

type Fees added in v0.2.0

type Fees = types.Fees

Fees aliases types.Fees

type GenesisState

type GenesisState struct {
	// Config contains the configuration
	Config types.Config `json:"config"`
	// Fees contains the fees
	Fees *types.Fees `json:"fees"`
}

GenesisState is used to unmarshal the genesis state when the app is initialized, and it is used to marshal the state when it needs to be exported.

func DefaultGenesisState

func DefaultGenesisState() GenesisState

DefaultGenesisState returns the default genesis state TODO this needs to be updated, although it will be imported from iovns chain

func ExportGenesis

func ExportGenesis(ctx sdk.Context, k Keeper) GenesisState

ExportGenesis saves the state of the configuration module

func NewGenesisState

func NewGenesisState(conf types.Config, fees *types.Fees) GenesisState

NewGenesisState is GenesisState constructor

type Keeper

type Keeper struct {
	// contains filtered or unexported fields
}

Keeper is the key value store handler for the configuration module

func NewKeeper

func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, paramspace ParamSubspace) Keeper

NewKeeper is Keeper constructor

func NewTestKeeper added in v0.4.5

func NewTestKeeper(t testing.TB, isCheckTx bool) (Keeper, sdk.Context)

NewTestKeeper generates aliceAddr keeper and aliceAddr context from it

func (Keeper) GetConfiguration

func (k Keeper) GetConfiguration(ctx sdk.Context) types.Config

GetConfiguration returns the configuration of the blockchain

func (Keeper) GetConfigurer added in v0.2.4

func (k Keeper) GetConfigurer(ctx sdk.Context) sdk.AccAddress

GetConfigurer returns the owner of domains with no superuser

func (Keeper) GetDomainGracePeriod

func (k Keeper) GetDomainGracePeriod(ctx sdk.Context) time.Duration

GetDomainGracePeriod returns the default grace period before domains can be deleted by someone other than the owner him/herself

func (Keeper) GetDomainRenewDuration

func (k Keeper) GetDomainRenewDuration(ctx sdk.Context) time.Duration

GetDomainRenewDuration returns the duration of a domain renewal period

func (Keeper) GetFees added in v0.2.0

func (k Keeper) GetFees(ctx sdk.Context) *types.Fees

GetFees returns the network fees

func (Keeper) GetValidDomainNameRegexp added in v0.3.0

func (k Keeper) GetValidDomainNameRegexp(ctx sdk.Context) string

GetValidDomainNameRegexp returns the regular expression used to match valid domain names

func (Keeper) IsOwner added in v0.2.0

func (k Keeper) IsOwner(ctx sdk.Context, addr sdk.AccAddress) bool

IsOwner checks if the provided address is an owner or not

func (Keeper) Logger

func (k Keeper) Logger(ctx sdk.Context) log.Logger

Logger provides logging facilities for Keeper

func (Keeper) SetConfig

func (k Keeper) SetConfig(ctx sdk.Context, conf types.Config)

SetConfig updates or saves a new config in the store

func (Keeper) SetFees added in v0.2.0

func (k Keeper) SetFees(ctx sdk.Context, fees *types.Fees)

type ParamSubspace added in v0.4.5

type ParamSubspace interface {
}

ParamSubspace is a placeholder

type QueryConfiguration added in v0.4.3

type QueryConfiguration struct{}

QueryConfiguration is the request model used to get the configuration

func (*QueryConfiguration) Description added in v0.4.3

func (q *QueryConfiguration) Description() string

Description is a placeholder

func (*QueryConfiguration) Handler added in v0.4.3

func (q *QueryConfiguration) Handler() QueryHandlerFunc

Handler implements QueryHandler

func (*QueryConfiguration) QueryPath added in v0.4.3

func (q *QueryConfiguration) QueryPath() string

QueryPath implements QueryHandler

func (*QueryConfiguration) Use added in v0.4.3

func (q *QueryConfiguration) Use() string

Use is a placeholder

func (*QueryConfiguration) Validate added in v0.4.3

func (q *QueryConfiguration) Validate() error

Validate implements QueryHandler

type QueryConfigurationResponse added in v0.4.3

type QueryConfigurationResponse struct {
	// Config represents the current configurations
	Config Config `json:"configuration"`
}

QueryConfigurationResponse is the response returned after querying the configuration

type QueryFees added in v0.4.3

type QueryFees struct{}

QueryFees is the request model used to get the current fees

func (*QueryFees) Description added in v0.4.3

func (q *QueryFees) Description() string

Description is a placeholder

func (*QueryFees) Handler added in v0.4.3

func (q *QueryFees) Handler() QueryHandlerFunc

Handler implements QueryHandler

func (*QueryFees) QueryPath added in v0.4.3

func (q *QueryFees) QueryPath() string

QueryPath implements QueryHandler

func (*QueryFees) Use added in v0.4.3

func (q *QueryFees) Use() string

Use is a placeholder

func (*QueryFees) Validate added in v0.4.3

func (q *QueryFees) Validate() error

Validate implements QueryHandler

type QueryFeesResponse added in v0.4.3

type QueryFeesResponse struct {
	// Fees represents the current fees of the network
	Fees Fees `json:"fees"`
}

QueryFeesResponse is returned after querying fees

type QueryHandlerFunc added in v0.4.3

type QueryHandlerFunc func(ctx sdk.Context, path []string, query abci.RequestQuery, k Keeper) ([]byte, error)

QueryHandlerFunc defines the query handler for this module

type SubTest added in v0.4.5

type SubTest struct {
	// BeforeTestBlockTime is the block time during before test in unix seconds
	// WARNING: if block time is given 0, it will be accepted as time.Now()
	BeforeTestBlockTime int64
	// BeforeTest is the function run before doing the test,
	// used for example to store state, like configurations etc.
	// Ignored if nil
	BeforeTest func(t *testing.T, k Keeper, ctx types.Context)
	// TestBlockTime is the block time during test in unix seconds
	// WARNING: if block time is given 0, it will be accepted as time.Now()
	TestBlockTime int64
	// Test is the function that runs the actual test
	Test func(t *testing.T, k Keeper, ctx types.Context)
	// AfterTestBlockTime is the block time during after test in unix seconds
	// WARNING: if block time is given 0, it will be accepted as time.Now()
	AfterTestBlockTime int64
	// AfterTest performs actions after the test is run, it can
	// be used to check if the state after Test is run matches
	// the result we expect.
	// Ignored if nil
	AfterTest func(t *testing.T, k Keeper, ctx types.Context)
}

subTest defines a test runner

Directories

Path Synopsis
client
cli
Package cli contains the cobra commands used to interact with the configuration module via CLI
Package cli contains the cobra commands used to interact with the configuration module via CLI
rest
Package rest contains the handlers used to interact with the configuration module via REST
Package rest contains the handlers used to interact with the configuration module via REST
Package types contains all the types used by the configuration module
Package types contains all the types used by the configuration module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL