From 426bfb795a5235d53db67f70137f0ef13f856926 Mon Sep 17 00:00:00 2001 From: Phi Date: Mon, 8 May 2023 13:13:18 +0200 Subject: [PATCH 1/2] Hide lotus-miner legacy markets cmds Hide lotus-miner legacy markets cmds --- cmd/lotus-miner/main.go | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/cmd/lotus-miner/main.go b/cmd/lotus-miner/main.go index 3cc796168..911e98e26 100644 --- a/cmd/lotus-miner/main.go +++ b/cmd/lotus-miner/main.go @@ -43,16 +43,16 @@ func main() { backupCmd, lcli.WithCategory("chain", actorCmd), lcli.WithCategory("chain", infoCmd), - lcli.WithCategory("market", storageDealsCmd), - lcli.WithCategory("market", retrievalDealsCmd), - lcli.WithCategory("market", dataTransfersCmd), - lcli.WithCategory("market", dagstoreCmd), - lcli.WithCategory("market", indexProvCmd), + lcli.WithCategory("market", setHidden(storageDealsCmd)), + lcli.WithCategory("market", setHidden(retrievalDealsCmd)), + lcli.WithCategory("market", setHidden(dataTransfersCmd)), + lcli.WithCategory("market", setHidden(dagstoreCmd)), + lcli.WithCategory("market", setHidden(indexProvCmd)), lcli.WithCategory("storage", sectorsCmd), lcli.WithCategory("storage", provingCmd), lcli.WithCategory("storage", storageCmd), lcli.WithCategory("storage", sealingCmd), - lcli.WithCategory("retrieval", piecesCmd), + lcli.WithCategory("retrieval", setHidden(piecesCmd)), } jaeger := tracing.SetupJaegerTracing("lotus") @@ -86,6 +86,7 @@ func main() { // adapt the Net* commands to always hit the node running the markets // subsystem, as that is the only one that runs a libp2p node. netCmd := *lcli.NetCmd // make a copy. + netCmd.Hidden = true prev := netCmd.Before netCmd.Before = func(c *cli.Context) error { if prev != nil { @@ -137,11 +138,12 @@ func main() { &cli.StringFlag{ Name: FlagMarketsRepo, EnvVars: []string{"LOTUS_MARKETS_PATH"}, - Usage: fmt.Sprintf("Markets repo path"), + Hidden: true, }, &cli.BoolFlag{ - Name: "call-on-markets", - Usage: "(experimental; may be removed) call this command against a markets node; use only with common commands like net, auth, pprof, etc. whose target may be ambiguous", + Name: "call-on-markets", + Usage: "(experimental; may be removed) call this command against a markets node; use only with common commands like net, auth, pprof, etc. whose target may be ambiguous", + Hidden: true, }, cliutil.FlagVeryVerbose, }, @@ -190,3 +192,8 @@ func getActorAddress(ctx context.Context, cctx *cli.Context) (maddr address.Addr return maddr, nil } + +func setHidden(cmd *cli.Command) *cli.Command { + cmd.Hidden = true + return cmd +} From 55a8cbd22ca2cd939dd81dbbb898b6141d098554 Mon Sep 17 00:00:00 2001 From: Phi Date: Mon, 8 May 2023 13:42:53 +0200 Subject: [PATCH 2/2] Make docsgen-cli Make docsgen-cli --- documentation/en/cli-lotus-miner.md | 1047 --------------------------- 1 file changed, 1047 deletions(-) diff --git a/documentation/en/cli-lotus-miner.md b/documentation/en/cli-lotus-miner.md index f6290efbc..7c646a3b4 100644 --- a/documentation/en/cli-lotus-miner.md +++ b/documentation/en/cli-lotus-miner.md @@ -25,16 +25,6 @@ COMMANDS: log Manage logging wait-api Wait for lotus api to come online fetch-params Fetch proving parameters - MARKET: - storage-deals Manage storage deals and related configuration - retrieval-deals Manage retrieval deals and related configuration - data-transfers Manage data transfers - dagstore Manage the dagstore on the markets subsystem - index Manage the index provider on the markets subsystem - NETWORK: - net Manage P2P Network - RETRIEVAL: - pieces interact with the piecestore STORAGE: sectors interact with sector store proving View proving information @@ -43,10 +33,8 @@ COMMANDS: GLOBAL OPTIONS: --actor value, -a value specify other actor to query / manipulate - --call-on-markets (experimental; may be removed) call this command against a markets node; use only with common commands like net, auth, pprof, etc. whose target may be ambiguous (default: false) --color use color in display output (default: depends on output being a TTY) --help, -h show help (default: false) - --markets-repo value Markets repo path [$LOTUS_MARKETS_PATH] --miner-repo value, --storagerepo value Specify miner repo path. flag(storagerepo) and env(LOTUS_STORAGE_PATH) are DEPRECATION, will REMOVE SOON (default: "~/.lotusminer") [$LOTUS_MINER_PATH, $LOTUS_STORAGE_PATH] --version, -v print the version (default: false) --vv enables very verbose mode, useful for debugging the CLI (default: false) @@ -607,1041 +595,6 @@ OPTIONS: ``` -## lotus-miner storage-deals -``` -NAME: - lotus-miner storage-deals - Manage storage deals and related configuration - -USAGE: - lotus-miner storage-deals command [command options] [arguments...] - -COMMANDS: - import-data Manually import data for a deal - list List all deals for this miner - selection Configure acceptance criteria for storage deal proposals - set-ask Configure the miner's ask - get-ask Print the miner's ask - set-blocklist Set the miner's list of blocklisted piece CIDs - get-blocklist List the contents of the miner's piece CID blocklist - reset-blocklist Remove all entries from the miner's piece CID blocklist - set-seal-duration Set the expected time, in minutes, that you expect sealing sectors to take. Deals that start before this duration will be rejected. - pending-publish list deals waiting in publish queue - retry-publish retry publishing a deal - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner storage-deals import-data -``` -NAME: - lotus-miner storage-deals import-data - Manually import data for a deal - -USAGE: - lotus-miner storage-deals import-data [command options] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner storage-deals list -``` -NAME: - lotus-miner storage-deals list - List all deals for this miner - -USAGE: - lotus-miner storage-deals list [command options] [arguments...] - -OPTIONS: - --format value output format of data, supported: table, json (default: "table") - --verbose, -v (default: false) - --watch watch deal updates in real-time, rather than a one time list (default: false) - -``` - -### lotus-miner storage-deals selection -``` -NAME: - lotus-miner storage-deals selection - Configure acceptance criteria for storage deal proposals - -USAGE: - lotus-miner storage-deals selection command [command options] [arguments...] - -COMMANDS: - list List storage deal proposal selection criteria - reset Reset storage deal proposal selection criteria to default values - reject Configure criteria which necessitate automatic rejection - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner storage-deals selection list -``` -NAME: - lotus-miner storage-deals selection list - List storage deal proposal selection criteria - -USAGE: - lotus-miner storage-deals selection list [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner storage-deals selection reset -``` -NAME: - lotus-miner storage-deals selection reset - Reset storage deal proposal selection criteria to default values - -USAGE: - lotus-miner storage-deals selection reset [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner storage-deals selection reject -``` -NAME: - lotus-miner storage-deals selection reject - Configure criteria which necessitate automatic rejection - -USAGE: - lotus-miner storage-deals selection reject [command options] [arguments...] - -OPTIONS: - --offline (default: false) - --online (default: false) - --unverified (default: false) - --verified (default: false) - -``` - -### lotus-miner storage-deals set-ask -``` -NAME: - lotus-miner storage-deals set-ask - Configure the miner's ask - -USAGE: - lotus-miner storage-deals set-ask [command options] [arguments...] - -OPTIONS: - --max-piece-size SIZE Set maximum piece size (w/bit-padding, in bytes) in ask to SIZE (default: miner sector size) - --min-piece-size SIZE Set minimum piece size (w/bit-padding, in bytes) in ask to SIZE (default: 256B) - --price PRICE Set the price of the ask for unverified deals (specified as FIL / GiB / Epoch) to PRICE. - --verified-price PRICE Set the price of the ask for verified deals (specified as FIL / GiB / Epoch) to PRICE - -``` - -### lotus-miner storage-deals get-ask -``` -NAME: - lotus-miner storage-deals get-ask - Print the miner's ask - -USAGE: - lotus-miner storage-deals get-ask [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner storage-deals set-blocklist -``` -NAME: - lotus-miner storage-deals set-blocklist - Set the miner's list of blocklisted piece CIDs - -USAGE: - lotus-miner storage-deals set-blocklist [command options] [ (optional, will read from stdin if omitted)] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner storage-deals get-blocklist -``` -NAME: - lotus-miner storage-deals get-blocklist - List the contents of the miner's piece CID blocklist - -USAGE: - lotus-miner storage-deals get-blocklist [command options] [arguments...] - -OPTIONS: - -``` - -### lotus-miner storage-deals reset-blocklist -``` -NAME: - lotus-miner storage-deals reset-blocklist - Remove all entries from the miner's piece CID blocklist - -USAGE: - lotus-miner storage-deals reset-blocklist [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner storage-deals set-seal-duration -``` -NAME: - lotus-miner storage-deals set-seal-duration - Set the expected time, in minutes, that you expect sealing sectors to take. Deals that start before this duration will be rejected. - -USAGE: - lotus-miner storage-deals set-seal-duration [command options] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner storage-deals pending-publish -``` -NAME: - lotus-miner storage-deals pending-publish - list deals waiting in publish queue - -USAGE: - lotus-miner storage-deals pending-publish [command options] [arguments...] - -OPTIONS: - --publish-now send a publish message now (default: false) - -``` - -### lotus-miner storage-deals retry-publish -``` -NAME: - lotus-miner storage-deals retry-publish - retry publishing a deal - -USAGE: - lotus-miner storage-deals retry-publish [command options] - -OPTIONS: - --help, -h show help (default: false) - -``` - -## lotus-miner retrieval-deals -``` -NAME: - lotus-miner retrieval-deals - Manage retrieval deals and related configuration - -USAGE: - lotus-miner retrieval-deals command [command options] [arguments...] - -COMMANDS: - selection Configure acceptance criteria for retrieval deal proposals - set-ask Configure the provider's retrieval ask - get-ask Get the provider's current retrieval ask configured by the provider in the ask-store using the set-ask CLI command - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner retrieval-deals selection -``` -NAME: - lotus-miner retrieval-deals selection - Configure acceptance criteria for retrieval deal proposals - -USAGE: - lotus-miner retrieval-deals selection command [command options] [arguments...] - -COMMANDS: - list List retrieval deal proposal selection criteria - reset Reset retrieval deal proposal selection criteria to default values - reject Configure criteria which necessitate automatic rejection - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner retrieval-deals selection list -``` -NAME: - lotus-miner retrieval-deals selection list - List retrieval deal proposal selection criteria - -USAGE: - lotus-miner retrieval-deals selection list [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner retrieval-deals selection reset -``` -NAME: - lotus-miner retrieval-deals selection reset - Reset retrieval deal proposal selection criteria to default values - -USAGE: - lotus-miner retrieval-deals selection reset [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner retrieval-deals selection reject -``` -NAME: - lotus-miner retrieval-deals selection reject - Configure criteria which necessitate automatic rejection - -USAGE: - lotus-miner retrieval-deals selection reject [command options] [arguments...] - -OPTIONS: - --offline (default: false) - --online (default: false) - -``` - -### lotus-miner retrieval-deals set-ask -``` -NAME: - lotus-miner retrieval-deals set-ask - Configure the provider's retrieval ask - -USAGE: - lotus-miner retrieval-deals set-ask [command options] [arguments...] - -OPTIONS: - --payment-interval value Set the payment interval (in bytes) for retrieval (default: 1MiB) - --payment-interval-increase value Set the payment interval increase (in bytes) for retrieval (default: 1MiB) - --price value Set the price of the ask for retrievals (FIL/GiB) - --unseal-price value Set the price to unseal - -``` - -### lotus-miner retrieval-deals get-ask -``` -NAME: - lotus-miner retrieval-deals get-ask - Get the provider's current retrieval ask configured by the provider in the ask-store using the set-ask CLI command - -USAGE: - lotus-miner retrieval-deals get-ask [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -## lotus-miner data-transfers -``` -NAME: - lotus-miner data-transfers - Manage data transfers - -USAGE: - lotus-miner data-transfers command [command options] [arguments...] - -COMMANDS: - list List ongoing data transfers for this miner - restart Force restart a stalled data transfer - cancel Force cancel a data transfer - diagnostics Get detailed diagnostics on active transfers with a specific peer - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner data-transfers list -``` -NAME: - lotus-miner data-transfers list - List ongoing data transfers for this miner - -USAGE: - lotus-miner data-transfers list [command options] [arguments...] - -OPTIONS: - --completed show completed data transfers (default: false) - --show-failed show failed/cancelled transfers (default: false) - --verbose, -v print verbose transfer details (default: false) - --watch watch deal updates in real-time, rather than a one time list (default: false) - -``` - -### lotus-miner data-transfers restart -``` -NAME: - lotus-miner data-transfers restart - Force restart a stalled data transfer - -USAGE: - lotus-miner data-transfers restart [command options] [arguments...] - -OPTIONS: - --initiator specify only transfers where peer is/is not initiator (default: false) - --peerid value narrow to transfer with specific peer - -``` - -### lotus-miner data-transfers cancel -``` -NAME: - lotus-miner data-transfers cancel - Force cancel a data transfer - -USAGE: - lotus-miner data-transfers cancel [command options] [arguments...] - -OPTIONS: - --cancel-timeout value time to wait for cancel to be sent to client (default: 5s) - --initiator specify only transfers where peer is/is not initiator (default: false) - --peerid value narrow to transfer with specific peer - -``` - -### lotus-miner data-transfers diagnostics -``` -NAME: - lotus-miner data-transfers diagnostics - Get detailed diagnostics on active transfers with a specific peer - -USAGE: - lotus-miner data-transfers diagnostics [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -## lotus-miner dagstore -``` -NAME: - lotus-miner dagstore - Manage the dagstore on the markets subsystem - -USAGE: - lotus-miner dagstore command [command options] [arguments...] - -COMMANDS: - list-shards List all shards known to the dagstore, with their current status - register-shard Register a shard - initialize-shard Initialize the specified shard - recover-shard Attempt to recover a shard in errored state - initialize-all Initialize all uninitialized shards, streaming results as they're produced; only shards for unsealed pieces are initialized by default - gc Garbage collect the dagstore - lookup-pieces Lookup pieces that a given CID belongs to - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner dagstore list-shards -``` -NAME: - lotus-miner dagstore list-shards - List all shards known to the dagstore, with their current status - -USAGE: - lotus-miner dagstore list-shards [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner dagstore register-shard -``` -NAME: - lotus-miner dagstore register-shard - Register a shard - -USAGE: - lotus-miner dagstore register-shard [command options] [key] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner dagstore initialize-shard -``` -NAME: - lotus-miner dagstore initialize-shard - Initialize the specified shard - -USAGE: - lotus-miner dagstore initialize-shard [command options] [key] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner dagstore recover-shard -``` -NAME: - lotus-miner dagstore recover-shard - Attempt to recover a shard in errored state - -USAGE: - lotus-miner dagstore recover-shard [command options] [key] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner dagstore initialize-all -``` -NAME: - lotus-miner dagstore initialize-all - Initialize all uninitialized shards, streaming results as they're produced; only shards for unsealed pieces are initialized by default - -USAGE: - lotus-miner dagstore initialize-all [command options] [arguments...] - -OPTIONS: - --concurrency value maximum shards to initialize concurrently at a time; use 0 for unlimited (default: 0) - --include-sealed initialize sealed pieces as well (default: false) - -``` - -### lotus-miner dagstore gc -``` -NAME: - lotus-miner dagstore gc - Garbage collect the dagstore - -USAGE: - lotus-miner dagstore gc [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner dagstore lookup-pieces -``` -NAME: - lotus-miner dagstore lookup-pieces - Lookup pieces that a given CID belongs to - -USAGE: - lotus-miner dagstore lookup-pieces [command options] - -OPTIONS: - --help, -h show help (default: false) - -``` - -## lotus-miner index -``` -NAME: - lotus-miner index - Manage the index provider on the markets subsystem - -USAGE: - lotus-miner index command [command options] [arguments...] - -COMMANDS: - announce Announce a deal to indexers so they can download its index - announce-all Announce all active deals to indexers so they can download the indices - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner index announce -``` -NAME: - lotus-miner index announce - Announce a deal to indexers so they can download its index - -USAGE: - lotus-miner index announce [command options] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner index announce-all -``` -NAME: - lotus-miner index announce-all - Announce all active deals to indexers so they can download the indices - -USAGE: - lotus-miner index announce-all [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -## lotus-miner net -``` -NAME: - lotus-miner net - Manage P2P Network - -USAGE: - lotus-miner net command [command options] [arguments...] - -COMMANDS: - peers Print peers - ping Ping peers - connect Connect to a peer - disconnect Disconnect from a peer - listen List listen addresses - id Get node identity - find-peer, findpeer Find the addresses of a given peerID - scores Print peers' pubsub scores - reachability Print information about reachability from the internet - bandwidth Print bandwidth usage information - block Manage network connection gating rules - stat Report resource usage for a scope - limit Get or set resource limits for a scope - protect Add one or more peer IDs to the list of protected peer connections - unprotect Remove one or more peer IDs from the list of protected peer connections. - list-protected List the peer IDs with protected connection. - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner net peers -``` -NAME: - lotus-miner net peers - Print peers - -USAGE: - lotus-miner net peers [command options] [arguments...] - -OPTIONS: - --agent, -a Print agent name (default: false) - --extended, -x Print extended peer information in json (default: false) - -``` - -### lotus-miner net ping -``` -NAME: - lotus-miner net ping - Ping peers - -USAGE: - lotus-miner net ping [command options] [peerMultiaddr] - -OPTIONS: - --count value, -c value specify the number of times it should ping (default: 10) - --interval value, -i value minimum time between pings (default: 1s) - -``` - -### lotus-miner net connect -``` -NAME: - lotus-miner net connect - Connect to a peer - -USAGE: - lotus-miner net connect [command options] [peerMultiaddr|minerActorAddress] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner net disconnect -``` -NAME: - lotus-miner net disconnect - Disconnect from a peer - -USAGE: - lotus-miner net disconnect [command options] [peerID] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner net listen -``` -NAME: - lotus-miner net listen - List listen addresses - -USAGE: - lotus-miner net listen [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner net id -``` -NAME: - lotus-miner net id - Get node identity - -USAGE: - lotus-miner net id [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner net find-peer, findpeer -``` -``` - -### lotus-miner net scores -``` -NAME: - lotus-miner net scores - Print peers' pubsub scores - -USAGE: - lotus-miner net scores [command options] [arguments...] - -OPTIONS: - --extended, -x print extended peer scores in json (default: false) - -``` - -### lotus-miner net reachability -``` -NAME: - lotus-miner net reachability - Print information about reachability from the internet - -USAGE: - lotus-miner net reachability [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner net bandwidth -``` -NAME: - lotus-miner net bandwidth - Print bandwidth usage information - -USAGE: - lotus-miner net bandwidth [command options] [arguments...] - -OPTIONS: - --by-peer list bandwidth usage by peer (default: false) - --by-protocol list bandwidth usage by protocol (default: false) - -``` - -### lotus-miner net block -``` -NAME: - lotus-miner net block - Manage network connection gating rules - -USAGE: - lotus-miner net block command [command options] [arguments...] - -COMMANDS: - add Add connection gating rules - remove Remove connection gating rules - list list connection gating rules - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner net block add -``` -NAME: - lotus-miner net block add - Add connection gating rules - -USAGE: - lotus-miner net block add command [command options] [arguments...] - -COMMANDS: - peer Block a peer - ip Block an IP address - subnet Block an IP subnet - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -##### lotus-miner net block add peer -``` -NAME: - lotus-miner net block add peer - Block a peer - -USAGE: - lotus-miner net block add peer [command options] ... - -OPTIONS: - --help, -h show help (default: false) - -``` - -##### lotus-miner net block add ip -``` -NAME: - lotus-miner net block add ip - Block an IP address - -USAGE: - lotus-miner net block add ip [command options] ... - -OPTIONS: - --help, -h show help (default: false) - -``` - -##### lotus-miner net block add subnet -``` -NAME: - lotus-miner net block add subnet - Block an IP subnet - -USAGE: - lotus-miner net block add subnet [command options] ... - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner net block remove -``` -NAME: - lotus-miner net block remove - Remove connection gating rules - -USAGE: - lotus-miner net block remove command [command options] [arguments...] - -COMMANDS: - peer Unblock a peer - ip Unblock an IP address - subnet Unblock an IP subnet - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -##### lotus-miner net block remove peer -``` -NAME: - lotus-miner net block remove peer - Unblock a peer - -USAGE: - lotus-miner net block remove peer [command options] ... - -OPTIONS: - --help, -h show help (default: false) - -``` - -##### lotus-miner net block remove ip -``` -NAME: - lotus-miner net block remove ip - Unblock an IP address - -USAGE: - lotus-miner net block remove ip [command options] ... - -OPTIONS: - --help, -h show help (default: false) - -``` - -##### lotus-miner net block remove subnet -``` -NAME: - lotus-miner net block remove subnet - Unblock an IP subnet - -USAGE: - lotus-miner net block remove subnet [command options] ... - -OPTIONS: - --help, -h show help (default: false) - -``` - -#### lotus-miner net block list -``` -NAME: - lotus-miner net block list - list connection gating rules - -USAGE: - lotus-miner net block list [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner net stat -``` -NAME: - lotus-miner net stat - Report resource usage for a scope - -USAGE: - lotus-miner net stat [command options] scope - -DESCRIPTION: - Report resource usage for a scope. - - The scope can be one of the following: - - system -- reports the system aggregate resource usage. - - transient -- reports the transient resource usage. - - svc: -- reports the resource usage of a specific service. - - proto: -- reports the resource usage of a specific protocol. - - peer: -- reports the resource usage of a specific peer. - - all -- reports the resource usage for all currently active scopes. - - -OPTIONS: - --json (default: false) - -``` - -### lotus-miner net limit -``` -NAME: - lotus-miner net limit - Get or set resource limits for a scope - -USAGE: - lotus-miner net limit [command options] scope [limit] - -DESCRIPTION: - Get or set resource limits for a scope. - - The scope can be one of the following: - - system -- reports the system aggregate resource usage. - - transient -- reports the transient resource usage. - - svc: -- reports the resource usage of a specific service. - - proto: -- reports the resource usage of a specific protocol. - - peer: -- reports the resource usage of a specific peer. - - The limit is json-formatted, with the same structure as the limits file. - - -OPTIONS: - --set set the limit for a scope (default: false) - -``` - -### lotus-miner net protect -``` -NAME: - lotus-miner net protect - Add one or more peer IDs to the list of protected peer connections - -USAGE: - lotus-miner net protect [command options] [...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner net unprotect -``` -NAME: - lotus-miner net unprotect - Remove one or more peer IDs from the list of protected peer connections. - -USAGE: - lotus-miner net unprotect [command options] [...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner net list-protected -``` -NAME: - lotus-miner net list-protected - List the peer IDs with protected connection. - -USAGE: - lotus-miner net list-protected [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -## lotus-miner pieces -``` -NAME: - lotus-miner pieces - interact with the piecestore - -USAGE: - lotus-miner pieces command [command options] [arguments...] - -DESCRIPTION: - The piecestore is a database that tracks and manages data that is made available to the retrieval market - -COMMANDS: - list-pieces list registered pieces - list-cids list registered payload CIDs - piece-info get registered information for a given piece CID - cid-info get registered information for a given payload CID - help, h Shows a list of commands or help for one command - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner pieces list-pieces -``` -NAME: - lotus-miner pieces list-pieces - list registered pieces - -USAGE: - lotus-miner pieces list-pieces [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner pieces list-cids -``` -NAME: - lotus-miner pieces list-cids - list registered payload CIDs - -USAGE: - lotus-miner pieces list-cids [command options] [arguments...] - -OPTIONS: - --verbose, -v (default: false) - -``` - -### lotus-miner pieces piece-info -``` -NAME: - lotus-miner pieces piece-info - get registered information for a given piece CID - -USAGE: - lotus-miner pieces piece-info [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - -### lotus-miner pieces cid-info -``` -NAME: - lotus-miner pieces cid-info - get registered information for a given payload CID - -USAGE: - lotus-miner pieces cid-info [command options] [arguments...] - -OPTIONS: - --help, -h show help (default: false) - -``` - ## lotus-miner sectors ``` NAME: