helper

Documentation

Index

• func FormatKV(in []string) string
• func FormatList(in []string) string
• func GetGRPCAddress(cmd *cobra.Command) string
• func GetGRPCConnection(address string) (*grpc.ClientConn, error)
• func GetIBFTOperatorClientConnection(address string) (ibftOp.IbftOperatorClient, error)
• func GetJSONLogFormat(cmd *cobra.Command) bool
• func GetJSONRPCAddress(cmd *cobra.Command) string
• func GetSystemClientConnection(address string) (proto.SystemClient, error)
• func GetTxPoolClientConnection(address string) (txpoolOp.TxnPoolOperatorClient, error)
• func HandleSignals(closeFn func(), outputter command.OutputFormatter) error
• func ParseGRPCAddress(grpcAddress string) (*net.TCPAddr, error)
• func ParseJSONRPCAddress(jsonrpcAddress string) (*url.URL, error)
• func RegisterGRPCAddressFlag(cmd *cobra.Command)
• func RegisterJSONOutputFlag(cmd *cobra.Command)
• func RegisterJSONRPCFlag(cmd *cobra.Command)
• func RegisterLegacyGRPCAddressFlag(cmd *cobra.Command)
• func ResolveAddr(address string, defaultIP IPBinding) (*net.TCPAddr, error)
• func SetRequiredFlags(cmd *cobra.Command, requiredFlags []string)
• func WriteGenesisConfigToDisk(genesisConfig *chain.Chain, genesisPath string) error
• type ClientCloseResult
  • func (r *ClientCloseResult) GetOutput() string
• type IPBinding

Functions

func FormatKV

func FormatKV(in []string) string

FormatKV formats key value pairs:

Key = Value

Key = <none>

func FormatList

func FormatList(in []string) string

FormatList formats a list, using a specific blank value replacement

func GetGRPCAddress

func GetGRPCAddress(cmd *cobra.Command) string

GetGRPCAddress extracts the set GRPC address

func GetGRPCConnection

func GetGRPCConnection(address string) (*grpc.ClientConn, error)

GetGRPCConnection returns a grpc client connection

func GetIBFTOperatorClientConnection

func GetIBFTOperatorClientConnection(address string) (
	ibftOp.IbftOperatorClient,
	error,
)

GetIBFTOperatorClientConnection returns the IBFT operator client connection

func GetJSONLogFormat

func GetJSONLogFormat(cmd *cobra.Command) bool

GetJSONLogFormat extracts the set JSON Format flag

func GetJSONRPCAddress

func GetJSONRPCAddress(cmd *cobra.Command) string

GetJSONRPCAddress extracts the set JSON-RPC address

func GetSystemClientConnection

func GetSystemClientConnection(address string) (
	proto.SystemClient,
	error,
)

GetSystemClientConnection returns the System operator client connection

func GetTxPoolClientConnection

func GetTxPoolClientConnection(address string) (
	txpoolOp.TxnPoolOperatorClient,
	error,
)

GetTxPoolClientConnection returns the TxPool operator client connection

func HandleSignals

func HandleSignals(
	closeFn func(),
	outputter command.OutputFormatter,
) error

HandleSignals is a helper method for handling signals sent to the console Like stop, error, etc.

func ParseGRPCAddress

func ParseGRPCAddress(grpcAddress string) (*net.TCPAddr, error)

ParseGRPCAddress parses the passed in GRPC address

func ParseJSONRPCAddress

func ParseJSONRPCAddress(jsonrpcAddress string) (*url.URL, error)

ParseJSONRPCAddress parses the passed in JSONRPC address

func RegisterGRPCAddressFlag

func RegisterGRPCAddressFlag(cmd *cobra.Command)

RegisterGRPCAddressFlag registers the base GRPC address flag for all child commands

func RegisterJSONOutputFlag

func RegisterJSONOutputFlag(cmd *cobra.Command)

RegisterJSONOutputFlag registers the --json output setting for all child commands

func RegisterJSONRPCFlag

func RegisterJSONRPCFlag(cmd *cobra.Command)

RegisterJSONRPCFlag registers the base JSON-RPC address flag for all child commands

func RegisterLegacyGRPCAddressFlag

func RegisterLegacyGRPCAddressFlag(cmd *cobra.Command)

RegisterLegacyGRPCAddressFlag registers the legacy GRPC address flag for all child commands

func ResolveAddr

func ResolveAddr(address string, defaultIP IPBinding) (*net.TCPAddr, error)

ResolveAddr resolves the passed in TCP address The second param is the default ip to bind to, if no ip address is specified

func SetRequiredFlags

func SetRequiredFlags(cmd *cobra.Command, requiredFlags []string)

func WriteGenesisConfigToDisk

func WriteGenesisConfigToDisk(genesisConfig *chain.Chain, genesisPath string) error

WriteGenesisConfigToDisk writes the passed in configuration to a genesis file at the specified path

Types

type ClientCloseResult

type ClientCloseResult struct {
	Message string `json:"message"`
}

func (*ClientCloseResult) GetOutput

func (r *ClientCloseResult) GetOutput() string

type IPBinding

type IPBinding string

const (
	LocalHostBinding     IPBinding = "127.0.0.1"
	AllInterfacesBinding IPBinding = "0.0.0.0"
)