cli

Documentation

Index

• Constants
• func GetCmdQueryCurrentEpochDays() *cobra.Command
• func GetCmdQueryHistoricalRewards() *cobra.Command
• func GetCmdQueryParams() *cobra.Command
• func GetCmdQueryPlan() *cobra.Command
• func GetCmdQueryPlans() *cobra.Command
• func GetCmdQueryPosition() *cobra.Command
• func GetCmdQueryQueuedStakings() *cobra.Command
• func GetCmdQueryRewards() *cobra.Command
• func GetCmdQueryStakings() *cobra.Command
• func GetCmdQueryTotalStakings() *cobra.Command
• func GetCmdQueryUnharvestedRewards() *cobra.Command
• func GetCmdSubmitPublicPlanProposal() *cobra.Command
• func GetQueryCmd() *cobra.Command
• func GetTxCmd() *cobra.Command
• func NewAdvanceEpochCmd() *cobra.Command
• func NewCreateFixedAmountPlanCmd() *cobra.Command
• func NewCreateRatioPlanCmd() *cobra.Command
• func NewHarvestCmd() *cobra.Command
• func NewRemovePlanCmd() *cobra.Command
• func NewStakeCmd() *cobra.Command
• func NewUnstakeCmd() *cobra.Command
• func ParsePublicPlanProposal(cdc codec.JSONCodec, proposalFile string) (types.PublicPlanProposal, error)
• type PrivateFixedPlanRequest
  • func ParsePrivateFixedPlan(file string) (PrivateFixedPlanRequest, error)
  • func (req PrivateFixedPlanRequest) String() string
• type PrivateRatioPlanRequest
  • func ParsePrivateRatioPlan(file string) (PrivateRatioPlanRequest, error)
  • func (req PrivateRatioPlanRequest) String() string

Constants

const (
	FlagPlanType         = "plan-type"
	FlagFarmingPoolAddr  = "farming-pool-addr"
	FlagTerminationAddr  = "termination-addr"
	FlagStakingCoinDenom = "staking-coin-denom"
	FlagTerminated       = "terminated"
	FlagAll              = "all"
)

Functions

func GetCmdQueryCurrentEpochDays

func GetCmdQueryCurrentEpochDays() *cobra.Command

GetCmdQueryCurrentEpochDays implements the query current epoch days command.

func GetCmdQueryHistoricalRewards

func GetCmdQueryHistoricalRewards() *cobra.Command

GetCmdQueryHistoricalRewards implements the query historical rewards command.

func GetCmdQueryParams

func GetCmdQueryParams() *cobra.Command

GetCmdQueryParams implements the query params command.

func GetCmdQueryPlan

func GetCmdQueryPlan() *cobra.Command

GetCmdQueryPlan implements the query the particular plan command.

func GetCmdQueryPlans

func GetCmdQueryPlans() *cobra.Command

GetCmdQueryPlans implements the query all plans command.

func GetCmdQueryPosition

func GetCmdQueryPosition() *cobra.Command

GetCmdQueryPosition implements the query farming position command.

func GetCmdQueryQueuedStakings

func GetCmdQueryQueuedStakings() *cobra.Command

GetCmdQueryQueuedStakings implements the query queued stakings command.

func GetCmdQueryRewards

func GetCmdQueryRewards() *cobra.Command

GetCmdQueryRewards implements the query all rewards for a farmer command.

func GetCmdQueryStakings

func GetCmdQueryStakings() *cobra.Command

GetCmdQueryStakings implements the query stakings command.

func GetCmdQueryTotalStakings

func GetCmdQueryTotalStakings() *cobra.Command

GetCmdQueryTotalStakings implements the query total staking amounts for a staking coin denom command.

func GetCmdQueryUnharvestedRewards

func GetCmdQueryUnharvestedRewards() *cobra.Command

GetCmdQueryUnharvestedRewards implements the query unharvested rewards command.

func GetCmdSubmitPublicPlanProposal

func GetCmdSubmitPublicPlanProposal() *cobra.Command

GetCmdSubmitPublicPlanProposal implements the create/update/delete public farming plan command handler.

func GetQueryCmd

func GetQueryCmd() *cobra.Command

GetQueryCmd returns a root CLI command handler for all x/farming query commands.

func GetTxCmd

func GetTxCmd() *cobra.Command

GetTxCmd returns a root CLI command handler for all x/farming transaction commands.

func NewAdvanceEpochCmd

func NewAdvanceEpochCmd() *cobra.Command

NewAdvanceEpochCmd implements the advance epoch by 1 command handler.

func NewCreateFixedAmountPlanCmd

func NewCreateFixedAmountPlanCmd() *cobra.Command

NewCreateFixedAmountPlanCmd implements the create a fixed amount plan command handler.

func NewCreateRatioPlanCmd

func NewCreateRatioPlanCmd() *cobra.Command

NewCreateRatioPlanCmd implements the create a ratio plan command handler.

func NewHarvestCmd

func NewHarvestCmd() *cobra.Command

NewHarvestCmd implements the harvest rewards command handler.

func NewRemovePlanCmd

func NewRemovePlanCmd() *cobra.Command

NewRemovePlanCmd implements the remove plan handler.

func NewStakeCmd

func NewStakeCmd() *cobra.Command

NewStakeCmd implements the stake coin(s) command handler.

func NewUnstakeCmd

func NewUnstakeCmd() *cobra.Command

NewUnstakeCmd implements the unstake coin(s) command handler.

func ParsePublicPlanProposal

func ParsePublicPlanProposal(cdc codec.JSONCodec, proposalFile string) (types.PublicPlanProposal, error)

ParsePublicPlanProposal reads and parses a PublicPlanProposal from a file.

Types

type PrivateFixedPlanRequest

type PrivateFixedPlanRequest struct {
	Name               string       `json:"name"`
	StakingCoinWeights sdk.DecCoins `json:"staking_coin_weights"`
	StartTime          time.Time    `json:"start_time"`
	EndTime            time.Time    `json:"end_time"`
	EpochAmount        sdk.Coins    `json:"epoch_amount"`
}

PrivateFixedPlanRequest defines CLI request for a private fixed plan.

func ParsePrivateFixedPlan

func ParsePrivateFixedPlan(file string) (PrivateFixedPlanRequest, error)

ParsePrivateFixedPlan reads and parses a PrivateFixedPlanRequest from a file.

func (PrivateFixedPlanRequest) String

func (req PrivateFixedPlanRequest) String() string

String returns a human readable string representation of the request.

type PrivateRatioPlanRequest

type PrivateRatioPlanRequest struct {
	Name               string       `json:"name"`
	StakingCoinWeights sdk.DecCoins `json:"staking_coin_weights"`
	StartTime          time.Time    `json:"start_time"`
	EndTime            time.Time    `json:"end_time"`
	EpochRatio         sdk.Dec      `json:"epoch_ratio"`
}

PrivateRatioPlanRequest defines CLI request for a private ratio plan.

func ParsePrivateRatioPlan

func ParsePrivateRatioPlan(file string) (PrivateRatioPlanRequest, error)

ParsePrivateRatioPlan reads and parses a PrivateRatioPlanRequest from a file.

func (PrivateRatioPlanRequest) String

func (req PrivateRatioPlanRequest) String() string

String returns a human readable string representation of the request.