Documentation
¶
Index ¶
- Variables
- func DaemonContext(cctx *cli.Context) context.Context
- func EpochTime(curr, e abi.ChainEpoch) string
- func EpochTimeTs(curr, e abi.ChainEpoch, ts *types.TipSet) string
- func FullNodeProxy[T api.FullNode](ins []T, outstr *api.FullNodeStruct)
- func GetCommonAPI(ctx *cli.Context) (api.Common, jsonrpc.ClientCloser, error)
- func GetFullNodeAPI(ctx *cli.Context) (v0api.FullNode, jsonrpc.ClientCloser, error)
- func GetFullNodeAPIV1(ctx *cli.Context, opts ...GetFullNodeOption) (v1api.FullNode, jsonrpc.ClientCloser, error)
- func GetFullNodeAPIV1Single(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 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 OnSingleNode(ctx context.Context) context.Context
- func ReqContext(cctx *cli.Context) context.Context
- func StorageMinerUseHttp(opts *GetStorageMinerOptions)
- type APIInfo
- type ETA
- type GetFullNodeOption
- type GetFullNodeOptions
- type GetStorageMinerOption
- type GetStorageMinerOptions
- type HttpHead
Constants ¶
This section is empty.
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 ¶ added in v1.5.1
func EpochTime ¶ added in v1.19.0
func EpochTime(curr, e abi.ChainEpoch) string
func EpochTimeTs ¶ added in v1.19.0
func EpochTimeTs(curr, e abi.ChainEpoch, ts *types.TipSet) string
EpochTimeTs is like EpochTime, but also outputs absolute time. `ts` is only used to provide a timestamp at some epoch to calculate time from. It can be a genesis tipset.
Example output: `1944975 (01 Jul 22 08:07 CEST, 10 hours 29 minutes ago)`
func FullNodeProxy ¶ added in v1.19.0
func FullNodeProxy[T api.FullNode](ins []T, outstr *api.FullNodeStruct)
func GetCommonAPI ¶ added in v1.11.1
func GetFullNodeAPI ¶ added in v1.5.1
func GetFullNodeAPIV1 ¶ added in v1.9.0
func GetFullNodeAPIV1(ctx *cli.Context, opts ...GetFullNodeOption) (v1api.FullNode, jsonrpc.ClientCloser, error)
func GetFullNodeAPIV1Single ¶ added in v1.19.0
func GetGatewayAPI ¶ added in v1.5.1
func GetGatewayAPIV0 ¶ added in v1.9.0
func GetStorageMinerAPI ¶ added in v1.5.1
func GetStorageMinerAPI(ctx *cli.Context, opts ...GetStorageMinerOption) (api.StorageMiner, jsonrpc.ClientCloser, error)
func GetWorkerAPI ¶ added in v1.5.1
func OnSingleNode ¶ added in v1.19.0
Not thread safe
func ReqContext ¶ added in v1.5.1
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 ¶ added in v1.5.1
func StorageMinerUseHttp(opts *GetStorageMinerOptions)
Types ¶
type APIInfo ¶
func GetAPIInfo ¶ added in v1.5.1
func GetAPIInfoFromRepoPath ¶ added in v1.27.0
func GetAPIInfoMulti ¶ added in v1.19.0
GetAPIInfo returns the API endpoint to use for the specified kind of repo.
The order of precedence is as follows:
- *-api-url command line flags.
- *_API_INFO environment variables
- deprecated *_API_INFO environment variables
- *-repo command line flags.
func ParseApiInfo ¶
func ParseApiInfoMulti ¶ added in v1.19.0
func (APIInfo) AuthHeader ¶
type ETA ¶ added in v1.25.2
type ETA struct {
// contains filtered or unexported fields
}
ETA implements a very simple eta calculator based on the number of remaining items. It does not require knowing the work size in advance and is therefore suitable for streaming workloads and also does not require that consecutive updates have a monotonically decreasing remaining value.
type GetFullNodeOption ¶ added in v1.20.0
type GetFullNodeOption func(*GetFullNodeOptions)
func FullNodeWithEthSubscribtionHandler ¶ added in v1.20.0
func FullNodeWithEthSubscribtionHandler(sh api.EthSubscriber) GetFullNodeOption
type GetFullNodeOptions ¶ added in v1.20.0
type GetFullNodeOptions struct {
EthSubHandler api.EthSubscriber
}
type GetStorageMinerOption ¶ added in v1.5.1
type GetStorageMinerOption func(*GetStorageMinerOptions)
type GetStorageMinerOptions ¶ added in v1.5.1
type GetStorageMinerOptions struct {
PreferHttp bool
}