cli

Documentation

Index

• Constants
• func FlagSetLockTokens() *flag.FlagSet
• func FlagSetMinDuration() *flag.FlagSet
• func FlagSetUnlockTokens() *flag.FlagSet
• func GetCmdAccountLockedCoins() *cobra.Command
• func GetCmdAccountLockedDuration() *cobra.Command
• func GetCmdAccountLockedLongerDuration() *cobra.Command
• func GetCmdAccountLockedLongerDurationDenom() *cobra.Command
• func GetCmdAccountLockedLongerDurationNotUnlockingOnly() *cobra.Command
• func GetCmdAccountLockedPastTime() (*osmocli.QueryDescriptor, *types.AccountLockedPastTimeRequest)
• func GetCmdAccountLockedPastTimeDenom() *cobra.Command
• func GetCmdAccountLockedPastTimeNotUnlockingOnly() (*osmocli.QueryDescriptor, *types.AccountLockedPastTimeNotUnlockingOnlyRequest)
• func GetCmdAccountUnlockableCoins() *cobra.Command
• func GetCmdAccountUnlockedBeforeTime() *cobra.Command
• func GetCmdAccountUnlockingCoins() (*osmocli.QueryDescriptor, *types.AccountUnlockingCoinsRequest)
• func GetCmdLockRewardReceiver() *cobra.Command
• func GetCmdLockedByID() *cobra.Command
• func GetCmdModuleBalance() (*osmocli.QueryDescriptor, *types.ModuleBalanceRequest)
• func GetCmdModuleLockedAmount() (*osmocli.QueryDescriptor, *types.ModuleLockedAmountRequest)
• func GetCmdNextLockID() *cobra.Command
• func GetCmdOutputLocksJson() *cobra.Command
• func GetCmdSyntheticLockupByLockupID() *cobra.Command
• func GetCmdSyntheticLockupsByLockupID() *cobra.Command
• func GetCmdTotalLockedByDenom() (*osmocli.QueryDescriptor, *types.LockedDenomRequest)
• func GetQueryCmd() *cobra.Command
• func GetTxCmd() *cobra.Command
• func NewBeginUnlockByIDCmd() (*osmocli.TxCliDesc, *types.MsgBeginUnlocking)
• func NewBeginUnlockingAllCmd() (*osmocli.TxCliDesc, *types.MsgBeginUnlockingAll)
• func NewForceUnlockByIdCmd() (*osmocli.TxCliDesc, *types.MsgForceUnlock)
• func NewLockTokensCmd() (*osmocli.TxCliDesc, *types.MsgLockTokens)
• func NewSetRewardReceiverAddress() (*osmocli.TxCliDesc, *types.MsgSetRewardReceiverAddress)

Constants

const (
	FlagDuration    = "duration"
	FlagMinDuration = "min-duration"
	FlagAmount      = "amount"
)

flags for lockup module tx commands.

Functions

func FlagSetLockTokens

func FlagSetLockTokens() *flag.FlagSet

FlagSetLockTokens returns flags for LockTokens msg builder.

func FlagSetMinDuration

func FlagSetMinDuration() *flag.FlagSet

func FlagSetUnlockTokens

func FlagSetUnlockTokens() *flag.FlagSet

func GetCmdAccountLockedCoins

func GetCmdAccountLockedCoins() *cobra.Command

GetCmdAccountLockedCoins returns locked coins that that are still in a locked state from the specified account.

func GetCmdAccountLockedDuration

func GetCmdAccountLockedDuration() *cobra.Command

GetCmdAccountLockedLongerDuration returns account locked records with longer duration.

func GetCmdAccountLockedLongerDuration

func GetCmdAccountLockedLongerDuration() *cobra.Command

GetCmdAccountLockedLongerDuration returns account locked records with longer duration.

func GetCmdAccountLockedLongerDurationDenom

func GetCmdAccountLockedLongerDurationDenom() *cobra.Command

GetCmdAccountLockedLongerDurationDenom returns account's locks for a specific denom with longer duration than the given duration.

func GetCmdAccountLockedLongerDurationNotUnlockingOnly

func GetCmdAccountLockedLongerDurationNotUnlockingOnly() *cobra.Command

GetCmdAccountLockedLongerDurationNotUnlockingOnly returns account locked records with longer duration from unlocking only queue.

func GetCmdAccountLockedPastTime

func GetCmdAccountLockedPastTime() (*osmocli.QueryDescriptor, *types.AccountLockedPastTimeRequest)

GetCmdAccountLockedPastTime returns locks of an account with unlock time beyond timestamp.

func GetCmdAccountLockedPastTimeDenom

func GetCmdAccountLockedPastTimeDenom() *cobra.Command

GetCmdAccountLockedPastTimeDenom returns locks of an account whose unlock time is beyond given timestamp, and locks with the specified denom.

func GetCmdAccountLockedPastTimeNotUnlockingOnly

func GetCmdAccountLockedPastTimeNotUnlockingOnly() (*osmocli.QueryDescriptor, *types.AccountLockedPastTimeNotUnlockingOnlyRequest)

GetCmdAccountLockedPastTimeNotUnlockingOnly returns locks of an account with unlock time beyond provided timestamp amongst the locks that are in the unlocking queue.

func GetCmdAccountUnlockableCoins

func GetCmdAccountUnlockableCoins() *cobra.Command

GetCmdAccountUnlockableCoins returns unlockable coins which has finsihed unlocking. TODO: DELETE THIS + Actual query in subsequent PR

func GetCmdAccountUnlockedBeforeTime

func GetCmdAccountUnlockedBeforeTime() *cobra.Command

GetCmdAccountUnlockedBeforeTime returns locks with unlock time before the provided timestamp.

func GetCmdAccountUnlockingCoins

func GetCmdAccountUnlockingCoins() (*osmocli.QueryDescriptor, *types.AccountUnlockingCoinsRequest)

GetCmdAccountUnlockingCoins returns unlocking coins of a specific account.

func GetCmdLockRewardReceiver

func GetCmdLockRewardReceiver() *cobra.Command

GetCmdLockRewardReceiver returns reward receiver for the given lock id

func GetCmdLockedByID

func GetCmdLockedByID() *cobra.Command

GetCmdLockedByID returns lock by id.

func GetCmdModuleBalance

func GetCmdModuleBalance() (*osmocli.QueryDescriptor, *types.ModuleBalanceRequest)

GetCmdModuleBalance returns full balance of the lockup module. Lockup module is where coins of locks are held. This includes locked balance and unlocked balance of the module.

func GetCmdModuleLockedAmount

func GetCmdModuleLockedAmount() (*osmocli.QueryDescriptor, *types.ModuleLockedAmountRequest)

GetCmdModuleLockedAmount returns locked balance of the module, which are all the tokens not unlocking + tokens that are not finished unlocking.

func GetCmdNextLockID

func GetCmdNextLockID() *cobra.Command

GetCmdNextLockID returns next lock id to be created.

func GetCmdOutputLocksJson

func GetCmdOutputLocksJson() *cobra.Command

GetCmdOutputLocksJson outputs all locks into a file called lock_export.json.

func GetCmdSyntheticLockupByLockupID

func GetCmdSyntheticLockupByLockupID() *cobra.Command

GetCmdSyntheticLockupByLockupID returns synthetic lockup by lockup id.

func GetCmdSyntheticLockupsByLockupID

func GetCmdSyntheticLockupsByLockupID() *cobra.Command

GetCmdSyntheticLockupsByLockupID returns synthetic lockups by lockup id. nolint: staticcheck

func GetCmdTotalLockedByDenom

func GetCmdTotalLockedByDenom() (*osmocli.QueryDescriptor, *types.LockedDenomRequest)

func GetQueryCmd

func GetQueryCmd() *cobra.Command

GetQueryCmd returns the cli query commands for this module.

func GetTxCmd

func GetTxCmd() *cobra.Command

GetTxCmd returns the transaction commands for this module.

func NewBeginUnlockByIDCmd

func NewBeginUnlockByIDCmd() (*osmocli.TxCliDesc, *types.MsgBeginUnlocking)

NewBeginUnlockByIDCmd unlocks individual period lock by ID.

func NewBeginUnlockingAllCmd

func NewBeginUnlockingAllCmd() (*osmocli.TxCliDesc, *types.MsgBeginUnlockingAll)

TODO: We should change the Use string to be unlock-all

func NewForceUnlockByIdCmd

func NewForceUnlockByIdCmd() (*osmocli.TxCliDesc, *types.MsgForceUnlock)

NewForceUnlockByIdCmd force unlocks individual period lock by ID if proper permissions exist.

func NewLockTokensCmd

func NewLockTokensCmd() (*osmocli.TxCliDesc, *types.MsgLockTokens)

func NewSetRewardReceiverAddress

func NewSetRewardReceiverAddress() (*osmocli.TxCliDesc, *types.MsgSetRewardReceiverAddress)

NewSetRewardReceiverAddress sets the reward receiver address.