types

Documentation

Index

• Constants
• Variables
• func ParamKeyTable() params.KeyTable
• func RegisterCodec(cdc *codec.Codec)
• func ValidateGenesis(data GenesisState) error
• type GenesisState
  • func DefaultGenesisState() GenesisState
  • func NewGenesisState() GenesisState
• type MsgCreatePoll
  • func NewMsgCreatePoll(creator sdk.AccAddress, title string, options []string) MsgCreatePoll
  • func (msg MsgCreatePoll) GetSignBytes() []byte
  • func (msg MsgCreatePoll) GetSigners() []sdk.AccAddress
  • func (msg MsgCreatePoll) Route() string
  • func (msg MsgCreatePoll) Type() string
  • func (msg MsgCreatePoll) ValidateBasic() error
• type MsgCreateVote
  • func NewMsgCreateVote(creator sdk.AccAddress, pollID string, value string) MsgCreateVote
  • func (msg MsgCreateVote) GetSignBytes() []byte
  • func (msg MsgCreateVote) GetSigners() []sdk.AccAddress
  • func (msg MsgCreateVote) Route() string
  • func (msg MsgCreateVote) Type() string
  • func (msg MsgCreateVote) ValidateBasic() error
• type ParamSubspace
• type Params
  • func DefaultParams() Params
  • func NewParams() Params
  • func (p *Params) ParamSetPairs() params.ParamSetPairs
  • func (p Params) String() string
• type Poll
• type Vote

Constants

const (
	// ModuleName is the name of the module
	ModuleName = "voter"

	// StoreKey to be used when creating the KVStore
	StoreKey = ModuleName

	// RouterKey to be used for routing msgs
	RouterKey = ModuleName

	// QuerierRoute to be used for querier msgs
	QuerierRoute = ModuleName
)

const (
	AttributeValueCategory = ModuleName
)

voter module event types

const (
	DefaultParamspace = ModuleName
)

Default parameter namespace

const (
	PollPrefix = "poll-"
)

const (
	QueryListPoll = "list-poll"
)

const (
	QueryListVote = "list-vote"
)

const (
	VotePrefix = "vote-"
)

Variables

var (
	ErrInvalid = sdkerrors.Register(ModuleName, 1, "custom error message")
)

var ModuleCdc *codec.Codec

ModuleCdc defines the module codec

Functions

func ParamKeyTable

func ParamKeyTable() params.KeyTable

ParamKeyTable for voter module

func RegisterCodec

func RegisterCodec(cdc *codec.Codec)

RegisterCodec registers concrete types on codec

func ValidateGenesis

func ValidateGenesis(data GenesisState) error

ValidateGenesis validates the voter genesis parameters

Types

type GenesisState

type GenesisState struct {
}

GenesisState - all voter state that must be provided at genesis

func DefaultGenesisState

func DefaultGenesisState() GenesisState

DefaultGenesisState - default GenesisState used by Cosmos Hub

func NewGenesisState

func NewGenesisState() GenesisState

NewGenesisState creates a new GenesisState object

type MsgCreatePoll

type MsgCreatePoll struct {
	ID      string
	Creator sdk.AccAddress `json:"creator" yaml:"creator"`
	Title   string         `json:"title" yaml:"title"`
	Options []string       `json:"options" yaml:"options"`
}

func NewMsgCreatePoll

func NewMsgCreatePoll(creator sdk.AccAddress, title string, options []string) MsgCreatePoll

func (MsgCreatePoll) GetSignBytes

func (msg MsgCreatePoll) GetSignBytes() []byte

func (MsgCreatePoll) GetSigners

func (msg MsgCreatePoll) GetSigners() []sdk.AccAddress

func (MsgCreatePoll) Route

func (msg MsgCreatePoll) Route() string

func (MsgCreatePoll) Type

func (msg MsgCreatePoll) Type() string

func (MsgCreatePoll) ValidateBasic

func (msg MsgCreatePoll) ValidateBasic() error

type MsgCreateVote

type MsgCreateVote struct {
	ID      string
	Creator sdk.AccAddress `json:"creator" yaml:"creator"`
	PollID  string         `json:"pollID" yaml:"pollID"`
	Value   string         `json:"value" yaml:"value"`
}

func NewMsgCreateVote

func NewMsgCreateVote(creator sdk.AccAddress, pollID string, value string) MsgCreateVote

func (MsgCreateVote) GetSignBytes

func (msg MsgCreateVote) GetSignBytes() []byte

func (MsgCreateVote) GetSigners

func (msg MsgCreateVote) GetSigners() []sdk.AccAddress

func (MsgCreateVote) Route

func (msg MsgCreateVote) Route() string

func (MsgCreateVote) Type

func (msg MsgCreateVote) Type() string

func (MsgCreateVote) ValidateBasic

func (msg MsgCreateVote) ValidateBasic() error

type ParamSubspace

type ParamSubspace interface {
	WithKeyTable(table params.KeyTable) params.Subspace
	Get(ctx sdk.Context, key []byte, ptr interface{})
	GetParamSet(ctx sdk.Context, ps params.ParamSet)
	SetParamSet(ctx sdk.Context, ps params.ParamSet)
}

ParamSubspace defines the expected Subspace interfacace

type Params

type Params struct {
}

Params - used for initializing default parameter for voter at genesis

func DefaultParams

func DefaultParams() Params

DefaultParams defines the parameters for this module

func NewParams

func NewParams() Params

NewParams creates a new Params object

func (*Params) ParamSetPairs

func (p *Params) ParamSetPairs() params.ParamSetPairs

ParamSetPairs - Implements params.ParamSet

func (Params) String

func (p Params) String() string

String implements the stringer interface for Params

type Poll

type Poll struct {
	Creator sdk.AccAddress `json:"creator" yaml:"creator"`
	ID      string         `json:"id" yaml:"id"`
	Title   string         `json:"title" yaml:"title"`
	Options []string       `json:"options" yaml:"options"`
}

type Vote

type Vote struct {
	Creator sdk.AccAddress `json:"creator" yaml:"creator"`
	ID      string         `json:"id" yaml:"id"`
	PollID  string         `json:"pollID" yaml:"pollID"`
	Value   string         `json:"value" yaml:"value"`
}