types

package
v0.1.3 Latest Latest
Warning

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

 Go to latest Published: Nov 25, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

To prevent namespace collision between consumer modules, we define a type Subspace. A Subspace can only be generated by the keeper, and the keeper checks the existence of the Subspace having the same name before generating the Subspace.

Consumer modules must take a Subspace (via Keeper.Subspace), not the keeper itself. This isolates each modules from the others and make them modify their respective parameters safely. Keeper can be treated as master permission for all Subspaces (via Keeper.GetSubspace), so should be passed to proper modules (ex. x/governance).

Index

Constants

View Source 
const (
	// ModuleName defines the name of the module
	ModuleName = "params"

	// RouterKey defines the routing key for a ParameterChangeProposal
	RouterKey = "params"
)
View Source 
const (
	// StoreKey is the string store key for the param store
	StoreKey = "params"

	// TStoreKey is the string store key for the param transient store
	TStoreKey = "transient_params"
)
View Source 
const (
	// ProposalTypeChange defines the type for a ParameterChangeProposal
	ProposalTypeChange = "ParameterChange"
)
View Source 
const (
	QueryParams = "params"
)

Querier path constants

Variables

View Source 
var (
	ErrUnknownSubspace  = sdkerrors.Register(ModuleName, 1, "unknown subspace")
	ErrSettingParameter = sdkerrors.Register(ModuleName, 2, "failed to set parameter")
	ErrEmptyChanges     = sdkerrors.Register(ModuleName, 3, "submitted parameter changes are empty")
	ErrEmptySubspace    = sdkerrors.Register(ModuleName, 4, "parameter subspace is empty")
	ErrEmptyKey         = sdkerrors.Register(ModuleName, 5, "parameter key is empty")
	ErrEmptyValue       = sdkerrors.Register(ModuleName, 6, "parameter value is empty")
)

x/params module sentinel errors

View Source 
var ModuleCdc *codec.Codec

Functions

func RegisterCodec added in v0.1.3 

func RegisterCodec(cdc *codec.Codec)

RegisterCodec registers all necessary param module types with a given codec.

func ValidateChanges added in v0.1.3 

func ValidateChanges(changes []ParamChange) error

ValidateChanges performs basic validation checks over a set of ParamChange. It returns an error if any ParamChange is invalid.

Types

type KeyTable 

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

KeyTable subspaces appropriate type for each parameter key

func NewKeyTable 

func NewKeyTable(pairs ...ParamSetPair) KeyTable

func (KeyTable) RegisterParamSet 

func (t KeyTable) RegisterParamSet(ps ParamSet) KeyTable

RegisterParamSet registers multiple ParamSetPairs from a ParamSet in a KeyTable.

func (KeyTable) RegisterType 

func (t KeyTable) RegisterType(psp ParamSetPair) KeyTable

RegisterType registers a single ParamSetPair (key-type pair) in a KeyTable.

type ParamChange added in v0.1.3 

type ParamChange struct {
	Subspace string `json:"subspace" yaml:"subspace"`
	Key      string `json:"key" yaml:"key"`
	Value    string `json:"value" yaml:"value"`
}

ParamChange defines a parameter change.

func NewParamChange added in v0.1.3 

func NewParamChange(subspace, key, value string) ParamChange

func (ParamChange) String added in v0.1.3 

func (pc ParamChange) String() string

String implements the Stringer interface.

type ParamSet 

type ParamSet interface {
	ParamSetPairs() ParamSetPairs
}

ParamSet defines an interface for structs containing parameters for a module

type ParamSetPair 

type ParamSetPair struct {
	Key         []byte
	Value       interface{}
	ValidatorFn ValueValidatorFn
}

ParamSetPair is used for associating paramsubspace key and field of param structs.

func NewParamSetPair 

func NewParamSetPair(key []byte, value interface{}, vfn ValueValidatorFn) ParamSetPair

NewParamSetPair creates a new ParamSetPair instance.

type ParamSetPairs 

type ParamSetPairs []ParamSetPair

ParamSetPairs Slice of KeyFieldPair

type ParameterChangeProposal added in v0.1.3 

type ParameterChangeProposal struct {
	Title       string        `json:"title" yaml:"title"`
	Description string        `json:"description" yaml:"description"`
	Changes     []ParamChange `json:"changes" yaml:"changes"`
}

ParameterChangeProposal defines a proposal which contains multiple parameter changes.

func NewParameterChangeProposal added in v0.1.3 

func NewParameterChangeProposal(title, description string, changes []ParamChange) ParameterChangeProposal

func (ParameterChangeProposal) GetDescription added in v0.1.3 

func (pcp ParameterChangeProposal) GetDescription() string

GetDescription returns the description of a parameter change proposal.

func (ParameterChangeProposal) GetTitle added in v0.1.3 

func (pcp ParameterChangeProposal) GetTitle() string

GetTitle returns the title of a parameter change proposal.

func (ParameterChangeProposal) ProposalRoute added in v0.1.3 

func (pcp ParameterChangeProposal) ProposalRoute() string

ProposalRoute returns the routing key of a parameter change proposal.

func (ParameterChangeProposal) ProposalType added in v0.1.3 

func (pcp ParameterChangeProposal) ProposalType() string

ProposalType returns the type of a parameter change proposal.

func (ParameterChangeProposal) String added in v0.1.3 

func (pcp ParameterChangeProposal) String() string

String implements the Stringer interface.

func (ParameterChangeProposal) ValidateBasic added in v0.1.3 

func (pcp ParameterChangeProposal) ValidateBasic() error

ValidateBasic validates the parameter change proposal

type QuerySubspaceParams 

type QuerySubspaceParams struct {
	Subspace string
	Key      string
}

QuerySubspaceParams defines the params for querying module params by a given subspace and key.

func NewQuerySubspaceParams 

func NewQuerySubspaceParams(ss, key string) QuerySubspaceParams

type ReadOnlySubspace 

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

Wrapper of Subspace, provides immutable functions only

func (ReadOnlySubspace) Get 

func (ros ReadOnlySubspace) Get(ctx sdk.Context, key []byte, ptr interface{})

Get delegates a read-only Get call to the Subspace.

func (ReadOnlySubspace) GetRaw 

func (ros ReadOnlySubspace) GetRaw(ctx sdk.Context, key []byte) []byte

GetRaw delegates a read-only GetRaw call to the Subspace.

func (ReadOnlySubspace) Has 

func (ros ReadOnlySubspace) Has(ctx sdk.Context, key []byte) bool

Has delegates a read-only Has call to the Subspace.

func (ReadOnlySubspace) Modified 

func (ros ReadOnlySubspace) Modified(ctx sdk.Context, key []byte) bool

Modified delegates a read-only Modified call to the Subspace.

func (ReadOnlySubspace) Name 

func (ros ReadOnlySubspace) Name() string

Name delegates a read-only Name call to the Subspace.

type Subspace 

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

Individual parameter store for each keeper Transient store persists for a block, so we use it for recording whether the parameter has been changed or not

func NewSubspace 

func NewSubspace(cdc codec.Marshaler, key sdk.StoreKey, tkey sdk.StoreKey, name string) Subspace

NewSubspace constructs a store with namestore

func (Subspace) Get 

func (s Subspace) Get(ctx sdk.Context, key []byte, ptr interface{})

Get queries for a parameter by key from the Subspace's KVStore and sets the value to the provided pointer. If the value does not exist, it will panic.

func (Subspace) GetIfExists 

func (s Subspace) GetIfExists(ctx sdk.Context, key []byte, ptr interface{})

GetIfExists queries for a parameter by key from the Subspace's KVStore and sets the value to the provided pointer. If the value does not exist, it will perform a no-op.

func (Subspace) GetParamSet 

func (s Subspace) GetParamSet(ctx sdk.Context, ps ParamSet)

GetParamSet iterates through each ParamSetPair where for each pair, it will retrieve the value and set it to the corresponding value pointer provided in the ParamSetPair by calling Subspace#Get.

func (Subspace) GetRaw 

func (s Subspace) GetRaw(ctx sdk.Context, key []byte) []byte

GetRaw queries for the raw values bytes for a parameter by key.

func (Subspace) Has 

func (s Subspace) Has(ctx sdk.Context, key []byte) bool

Has returns if a parameter key exists or not in the Subspace's KVStore.

func (Subspace) HasKeyTable 

func (s Subspace) HasKeyTable() bool

HasKeyTable returns if the Subspace has a KeyTable registered.

func (Subspace) Modified 

func (s Subspace) Modified(ctx sdk.Context, key []byte) bool

Modified returns true if the parameter key is set in the Subspace's transient KVStore.

func (Subspace) Name 

func (s Subspace) Name() string

Name returns the name of the Subspace.

func (Subspace) Set 

func (s Subspace) Set(ctx sdk.Context, key []byte, value interface{})

Set stores a value for given a parameter key assuming the parameter type has been registered. It will panic if the parameter type has not been registered or if the value cannot be encoded. A change record is also set in the Subspace's transient KVStore to mark the parameter as modified.

func (Subspace) SetParamSet 

func (s Subspace) SetParamSet(ctx sdk.Context, ps ParamSet)

SetParamSet iterates through each ParamSetPair and sets the value with the corresponding parameter key in the Subspace's KVStore.

func (Subspace) Update 

func (s Subspace) Update(ctx sdk.Context, key, value []byte) error

Update stores an updated raw value for a given parameter key assuming the parameter type has been registered. It will panic if the parameter type has not been registered or if the value cannot be encoded. An error is returned if the raw value is not compatible with the registered type for the parameter key or if the new value is invalid as determined by the registered type's validation function.

func (Subspace) Validate 

func (s Subspace) Validate(ctx sdk.Context, key []byte, value interface{}) error

Validate attempts to validate a parameter value by its key. If the key is not registered or if the validation of the value fails, an error is returned.

func (Subspace) WithKeyTable 

func (s Subspace) WithKeyTable(table KeyTable) Subspace

WithKeyTable initializes KeyTable and returns modified Subspace

type SubspaceParamsResponse 

type SubspaceParamsResponse struct {
	Subspace string
	Key      string
	Value    string
}

SubspaceParamsResponse defines the response for quering parameters by subspace.

func NewSubspaceParamsResponse 

func NewSubspaceParamsResponse(ss, key, value string) SubspaceParamsResponse

type ValueValidatorFn 

type ValueValidatorFn func(value interface{}) error

Source Files

View all Source files

Directories

Path Synopsis

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.