cliutil

Documentation

Index

• Variables
• func DaemonContext(cctx *cli.Context) context.Context
• func EnvsForAPIInfos(t repo.RepoType) (primary string, fallbacks []string, deprecated []string)
• func GetCommonAPI(ctx *cli.Context) (api.CommonNet, jsonrpc.ClientCloser, error)
• func GetFullNodeAPI(ctx *cli.Context) (v0api.FullNode, jsonrpc.ClientCloser, error)
• func GetFullNodeAPIV1(ctx *cli.Context) (v1api.FullNode, jsonrpc.ClientCloser, error)
• func GetGatewayAPI(ctx *cli.Context) (api.Gateway, jsonrpc.ClientCloser, error)
• func GetGatewayAPIV0(ctx *cli.Context) (v0api.Gateway, jsonrpc.ClientCloser, error)
• func GetMarketsAPI(ctx *cli.Context) (api.StorageMiner, jsonrpc.ClientCloser, error)
• func GetRawAPI(ctx *cli.Context, t repo.RepoType, version string) (string, http.Header, error)
• func GetStorageMinerAPI(ctx *cli.Context, opts ...GetStorageMinerOption) (api.StorageMiner, jsonrpc.ClientCloser, error)
• func GetWorkerAPI(ctx *cli.Context) (api.Worker, jsonrpc.ClientCloser, error)
• func ReqContext(cctx *cli.Context) context.Context
• func StorageMinerUseHttp(opts *GetStorageMinerOptions)
• type APIInfo
  • func GetAPIInfo(ctx *cli.Context, t repo.RepoType) (APIInfo, error)
  • func ParseApiInfo(s string) APIInfo
  • func (a APIInfo) AuthHeader() http.Header
  • func (a APIInfo) DialArgs(version string) (string, error)
  • func (a APIInfo) Host() (string, error)
• type GetStorageMinerOption
• type GetStorageMinerOptions

Variables

var FlagVeryVerbose = &cli.BoolFlag{
	Name:        "vv",
	Usage:       "enables very verbose mode, useful for debugging the CLI",
	Destination: &IsVeryVerbose,
}

FlagVeryVerbose enables very verbose mode, which is useful when debugging the CLI itself. It should be included as a flag on the top-level command (e.g. lotus -vv, lotus-miner -vv).

var IsVeryVerbose bool

IsVeryVerbose is a global var signalling if the CLI is running in very verbose mode or not (default: false).

Functions

func DaemonContext

func DaemonContext(cctx *cli.Context) context.Context

func EnvsForAPIInfos

func EnvsForAPIInfos(t repo.RepoType) (primary string, fallbacks []string, deprecated []string)

EnvsForAPIInfos returns the environment variables to use in order of precedence to determine the API endpoint of the specified node type.

It returns the current variables and deprecated ones separately, so that the user can log a warning when deprecated ones are found to be in use.

func GetCommonAPI

func GetCommonAPI(ctx *cli.Context) (api.CommonNet, jsonrpc.ClientCloser, error)

func GetFullNodeAPI

func GetFullNodeAPI(ctx *cli.Context) (v0api.FullNode, jsonrpc.ClientCloser, error)

func GetFullNodeAPIV1

func GetFullNodeAPIV1(ctx *cli.Context) (v1api.FullNode, jsonrpc.ClientCloser, error)

func GetGatewayAPI

func GetGatewayAPI(ctx *cli.Context) (api.Gateway, jsonrpc.ClientCloser, error)

func GetGatewayAPIV0

func GetGatewayAPIV0(ctx *cli.Context) (v0api.Gateway, jsonrpc.ClientCloser, error)

func GetMarketsAPI

func GetMarketsAPI(ctx *cli.Context) (api.StorageMiner, jsonrpc.ClientCloser, error)

func GetRawAPI

func GetRawAPI(ctx *cli.Context, t repo.RepoType, version string) (string, http.Header, error)

func GetStorageMinerAPI

func GetStorageMinerAPI(ctx *cli.Context, opts ...GetStorageMinerOption) (api.StorageMiner, jsonrpc.ClientCloser, error)

func GetWorkerAPI

func GetWorkerAPI(ctx *cli.Context) (api.Worker, jsonrpc.ClientCloser, error)

func ReqContext

func ReqContext(cctx *cli.Context) context.Context

ReqContext returns context for cli execution. Calling it for the first time installs SIGTERM handler that will close returned context. Not safe for concurrent execution.

func StorageMinerUseHttp

func StorageMinerUseHttp(opts *GetStorageMinerOptions)

Types

type APIInfo

type APIInfo struct {
	Addr  string
	Token []byte
}

func GetAPIInfo

func GetAPIInfo(ctx *cli.Context, t repo.RepoType) (APIInfo, error)

GetAPIInfo returns the API endpoint to use for the specified kind of repo.

The order of precedence is as follows:

1. *-api-url command line flags.
2. *_API_INFO environment variables
3. deprecated *_API_INFO environment variables
4. *-repo command line flags.

func ParseApiInfo

func ParseApiInfo(s string) APIInfo

func (APIInfo) AuthHeader

func (a APIInfo) AuthHeader() http.Header

func (APIInfo) DialArgs

func (a APIInfo) DialArgs(version string) (string, error)

func (APIInfo) Host

func (a APIInfo) Host() (string, error)

type GetStorageMinerOption

type GetStorageMinerOption func(*GetStorageMinerOptions)

type GetStorageMinerOptions

type GetStorageMinerOptions struct {
	PreferHttp bool
}