cmds

Documentation

Overview

Package cmds provides command line tools.

Index

• Variables
• func DefaultImportPS() *ps.PS
• func IsSupportedProposalOperationFactHintFunc() func(hint.Hint) bool
• func LoadHinters(encs *encoder.Encoders) error
• func PAddHinters(pctx context.Context) (context.Context, error)
• func PDigesterFollowUp(ctx context.Context) (context.Context, error)
• func POperationProcessorsMap(pctx context.Context) (context.Context, error)
• func ProcessDigester(ctx context.Context) (context.Context, error)
• func ProcessStartDigester(ctx context.Context) (context.Context, error)
• type BaseCommand
• type BaseNetworkClientCommand
  • func (cmd *BaseNetworkClientCommand) Prepare(pctx context.Context) error
  • func (cmd *BaseNetworkClientCommand) Print(v interface{}, out io.Writer) error
• type ImportCommand
  • func (cmd *ImportCommand) Run(pctx context.Context) error
• type IssueCommand
  • func (cmd *IssueCommand) Run(pctx context.Context) error
• type NetworkClientCommand
• type NetworkClientSendOperationCommand
  • func (cmd *NetworkClientSendOperationCommand) Run(pctx context.Context) error
• type RegisterModelCommand
  • func (cmd *RegisterModelCommand) Run(pctx context.Context) error
• type RunCommand
  • func (cmd *RunCommand) Run(pctx context.Context) error
• type Storage
• type TimestampCommand
• type ValidateBlocksCommand
  • func (cmd *ValidateBlocksCommand) Run(pctx context.Context) error

Variables

var AddedHinters = []encoder.DecodeDetail{

	{Hint: types.DesignHint, Instance: types.Design{}},
	{Hint: types.ItemHint, Instance: types.Item{}},

	{Hint: timestamp.IssueHint, Instance: timestamp.Issue{}},
	{Hint: timestamp.RegisterModelHint, Instance: timestamp.RegisterModel{}},

	{Hint: state.ItemStateValueHint, Instance: state.ItemStateValue{}},
	{Hint: state.DesignStateValueHint, Instance: state.DesignStateValue{}},
	{Hint: state.LastIdxStateValueHint, Instance: state.LastIdxStateValue{}},
}

var AddedSupportedHinters = []encoder.DecodeDetail{
	{Hint: timestamp.IssueFactHint, Instance: timestamp.IssueFact{}},
	{Hint: timestamp.RegisterModelFactHint, Instance: timestamp.RegisterModelFact{}},
}

var Hinters []encoder.DecodeDetail

var PNameOperationProcessorsMap = ps.Name("mitum-timestamp-operation-processors-map")

var PNameValidateBlocks = ps.Name("validate-blocks")

var SupportedProposalOperationFactHinters []encoder.DecodeDetail

Functions

func DefaultImportPS

func DefaultImportPS() *ps.PS

func IsSupportedProposalOperationFactHintFunc

func IsSupportedProposalOperationFactHintFunc() func(hint.Hint) bool

func LoadHinters

func LoadHinters(encs *encoder.Encoders) error

func PAddHinters

func PAddHinters(pctx context.Context) (context.Context, error)

func PDigesterFollowUp

func PDigesterFollowUp(ctx context.Context) (context.Context, error)

func POperationProcessorsMap

func POperationProcessorsMap(pctx context.Context) (context.Context, error)

func ProcessDigester

func ProcessDigester(ctx context.Context) (context.Context, error)

func ProcessStartDigester

func ProcessStartDigester(ctx context.Context) (context.Context, error)

Types

type BaseCommand

type BaseCommand struct {
	Encoder  encoder.Encoder   `kong:"-"`
	Encoders *encoder.Encoders `kong:"-"`
	Log      *zerolog.Logger   `kong:"-"`
	Out      io.Writer         `kong:"-"`
}

type BaseNetworkClientCommand

type BaseNetworkClientCommand struct {
	BaseCommand
	launchcmd.BaseNetworkClientNodeInfoFlags
	Client   *isaacnetwork.BaseClient `kong:"-"`
	ClientID string                   `name:"client-id" help:"client id"`
}

func (*BaseNetworkClientCommand) Prepare

func (cmd *BaseNetworkClientCommand) Prepare(pctx context.Context) error

func (*BaseNetworkClientCommand) Print

func (cmd *BaseNetworkClientCommand) Print(v interface{}, out io.Writer) error

type ImportCommand

type ImportCommand struct {
	// revive:disable:line-length-limit
	launch.DesignFlag
	Source      string           `arg:"" name:"source directory" help:"block data directory to import" type:"existingdir"`
	HeightRange launch.RangeFlag `name:"range" help:"<from>-<to>" default:""`
	launch.PrivatekeyFlags
	Do             bool   `name:"do" help:"really do import"`
	CacheDirectory string `name:"cache-directory" help:"directory for remote block item file"`

	launch.DevFlags `embed:"" prefix:"dev."`
	// contains filtered or unexported fields
}

func (*ImportCommand) Run

func (cmd *ImportCommand) Run(pctx context.Context) error

type IssueCommand

type IssueCommand struct {
	BaseCommand
	currencycmds.OperationFlags
	Sender           currencycmds.AddressFlag    `arg:"" name:"sender" help:"sender address" required:"true"`
	Contract         currencycmds.AddressFlag    `arg:"" name:"contract" help:"contract address" required:"true"`
	ProjectID        string                      `arg:"" name:"project id" help:"project id" required:"true"`
	RequestTimeStamp uint64                      `arg:"" name:"request timestamp" help:"request timestamp" required:"true"`
	Data             string                      `arg:"" name:"data" help:"data" required:"true"`
	Currency         currencycmds.CurrencyIDFlag `arg:"" name:"currency" help:"currency id" required:"true"`
	// contains filtered or unexported fields
}

func (*IssueCommand) Run

func (cmd *IssueCommand) Run(pctx context.Context) error

type NetworkClientCommand

type NetworkClientCommand struct {
	//revive:disable:line-length-limit
	//revive:disable:nested-structs
	NodeInfo      launchcmd.NetworkClientNodeInfoCommand     `cmd:"" name:"node-info" help:"remote node info"`
	SendOperation NetworkClientSendOperationCommand          `cmd:"" name:"send-operation" help:"send operation"`
	State         launchcmd.NetworkClientStateCommand        `cmd:"" name:"state" help:"get state"`
	LastBlockMap  launchcmd.NetworkClientLastBlockMapCommand `cmd:"" name:"last-blockmap" help:"get last blockmap"`
	Design        struct {
		Read  launchcmd.NetworkClientReadNodeCommand  `cmd:"" name:"read" help:"read design value"`
		Write launchcmd.NetworkClientWriteNodeCommand `cmd:"" name:"write" help:"write design value"`
	} `cmd:"" name:"design" help:""`
	Event launchcmd.NetworkClientEventLoggingCommand `cmd:"" name:"event" help:"event log"`
}

type NetworkClientSendOperationCommand

type NetworkClientSendOperationCommand struct {
	BaseNetworkClientCommand
	Input    string `arg:"" name:"input" help:"input; default is stdin" default:"-"`
	IsString bool   `name:"input.is-string" help:"input is string, not file"`
}

func (*NetworkClientSendOperationCommand) Run

func (cmd *NetworkClientSendOperationCommand) Run(pctx context.Context) error

type RegisterModelCommand

type RegisterModelCommand struct {
	BaseCommand
	currencycmds.OperationFlags
	Sender   currencycmds.AddressFlag    `arg:"" name:"sender" help:"sender address" required:"true"`
	Contract currencycmds.AddressFlag    `arg:"" name:"contract" help:"contract account to register policy" required:"true"`
	Currency currencycmds.CurrencyIDFlag `arg:"" name:"currency" help:"currency id" required:"true"`
	// contains filtered or unexported fields
}

func (*RegisterModelCommand) Run

func (cmd *RegisterModelCommand) Run(pctx context.Context) error

type RunCommand

type RunCommand struct {
	//revive:disable:line-length-limit
	launch.DesignFlag
	launch.DevFlags `embed:"" prefix:"dev."`
	launch.PrivatekeyFlags
	Discovery []launch.ConnInfoFlag `help:"member discovery" placeholder:"ConnInfo"`
	Hold      launch.HeightFlag     `help:"hold consensus states"`
	HTTPState string                `name:"http-state" help:"runtime statistics thru https" placeholder:"bind address"`
	launch.ACLFlags
	// contains filtered or unexported fields
}

func (*RunCommand) Run

func (cmd *RunCommand) Run(pctx context.Context) error

type Storage

type Storage struct {
	Import         ImportCommand                  `cmd:"" help:"import block data files"`
	Clean          launchcmd.CleanCommand         `cmd:"" help:"clean storage"`
	ValidateBlocks ValidateBlocksCommand          `cmd:"" help:"validate blocks in storage"`
	Status         launchcmd.StorageStatusCommand `cmd:"" help:"storage status"`
	Database       launchcmd.DatabaseCommand      `cmd:"" help:""`
}

type TimestampCommand

type TimestampCommand struct {
	Issue         IssueCommand         `cmd:"" name:"issue" help:"issue new timestamp item"`
	RegisterModel RegisterModelCommand `cmd:"" name:"register-model" help:"register timestamp model"`
}

type ValidateBlocksCommand

type ValidateBlocksCommand struct {
	launch.DesignFlag
	launch.PrivatekeyFlags
	HeightRange launch.RangeFlag `name:"range" help:"<from>-<to>" default:""`

	launch.DevFlags `embed:"" prefix:"dev."`
	// contains filtered or unexported fields
}

func (*ValidateBlocksCommand) Run

func (cmd *ValidateBlocksCommand) Run(pctx context.Context) error