v0_15

Documentation

Index

• Constants
• func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)
• type CommunityPoolMultiSpendProposal
  • func (csp CommunityPoolMultiSpendProposal) GetDescription() string
  • func (csp CommunityPoolMultiSpendProposal) GetTitle() string
  • func (csp CommunityPoolMultiSpendProposal) ProposalRoute() string
  • func (csp CommunityPoolMultiSpendProposal) ProposalType() string
  • func (csp CommunityPoolMultiSpendProposal) String() string
  • func (csp CommunityPoolMultiSpendProposal) ValidateBasic() error
• type GenesisState
• type MultiSpendRecipient
  • func (msr MultiSpendRecipient) Validate() error
• type MultiSpendRecipients
  • func (msrs MultiSpendRecipients) Validate() error
• type Params
• type Period
• type Periods

Constants

const (
	// ModuleName name that will be used throughout the module
	ModuleName = "kavadist"

	// RouterKey Top level router key
	RouterKey = ModuleName

	// ProposalTypeCommunityPoolMultiSpend defines the type for a CommunityPoolMultiSpendProposal
	ProposalTypeCommunityPoolMultiSpend = "CommunityPoolMultiSpend"
)

Functions

func RegisterLegacyAminoCodec

func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

Types

type CommunityPoolMultiSpendProposal

type CommunityPoolMultiSpendProposal struct {
	Title         string               `json:"title" yaml:"title"`
	Description   string               `json:"description" yaml:"description"`
	RecipientList MultiSpendRecipients `json:"recipient_list" yaml:"recipient_list"`
}

CommunityPoolMultiSpendProposal spends from the community pool by sending to one or more addresses

func (CommunityPoolMultiSpendProposal) GetDescription

func (csp CommunityPoolMultiSpendProposal) GetDescription() string

GetDescription returns the description of a community pool multi-spend proposal.

func (CommunityPoolMultiSpendProposal) GetTitle

func (csp CommunityPoolMultiSpendProposal) GetTitle() string

GetTitle returns the title of a community pool multi-spend proposal.

func (CommunityPoolMultiSpendProposal) ProposalRoute

func (csp CommunityPoolMultiSpendProposal) ProposalRoute() string

GetDescription returns the routing key of a community pool multi-spend proposal.

func (CommunityPoolMultiSpendProposal) ProposalType

func (csp CommunityPoolMultiSpendProposal) ProposalType() string

ProposalType returns the type of a community pool multi-spend proposal.

func (CommunityPoolMultiSpendProposal) String

func (csp CommunityPoolMultiSpendProposal) String() string

String implements fmt.Stringer

func (CommunityPoolMultiSpendProposal) ValidateBasic

func (csp CommunityPoolMultiSpendProposal) ValidateBasic() error

ValidateBasic stateless validation of a community pool multi-spend proposal.

type GenesisState

type GenesisState struct {
	Params            Params    `json:"params" yaml:"params"`
	PreviousBlockTime time.Time `json:"previous_block_time" yaml:"previous_block_time"`
}

GenesisState is the state that must be provided at genesis.

type MultiSpendRecipient

type MultiSpendRecipient struct {
	Address sdk.AccAddress `json:"address" yaml:"address"`
	Amount  sdk.Coins      `json:"amount" yaml:"amount"`
}

MultiSpendRecipient defines a recipient and the amount of coins they are receiving

func (MultiSpendRecipient) Validate

func (msr MultiSpendRecipient) Validate() error

Validate stateless validation of MultiSpendRecipient

type MultiSpendRecipients

type MultiSpendRecipients []MultiSpendRecipient

MultiSpendRecipients slice of MultiSpendRecipient

func (MultiSpendRecipients) Validate

func (msrs MultiSpendRecipients) Validate() error

Validate stateless validation of MultiSpendRecipients

type Params

type Params struct {
	Active  bool    `json:"active" yaml:"active"`
	Periods Periods `json:"periods" yaml:"periods"`
}

Params governance parameters for kavadist module

type Period

type Period struct {
	Start     time.Time `json:"start" yaml:"start"`         // example "2020-03-01T15:20:00Z"
	End       time.Time `json:"end" yaml:"end"`             // example "2020-06-01T15:20:00Z"
	Inflation sdk.Dec   `json:"inflation" yaml:"inflation"` // example "1.000000003022265980"  - 10% inflation
}

Period stores the specified start and end dates, and the inflation, expressed as a decimal representing the yearly APR of KAVA tokens that will be minted during that period

type Periods

type Periods []Period

Periods array of Period