2021-05-18 17:47:30 +00:00
# lotus-miner
```
NAME:
lotus-miner - Filecoin decentralized storage network miner
USAGE:
lotus-miner [global options] command [command options] [arguments...]
VERSION:
2023-05-03 21:01:13 +00:00
1.23.2-dev
2021-05-18 17:47:30 +00:00
COMMANDS:
init Initialize a lotus miner repo
run Start a lotus miner process
stop Stop a running lotus miner
2021-07-23 13:44:52 +00:00
config Manage node config
2021-05-18 17:47:30 +00:00
backup Create node metadata backup
version Print version
help, h Shows a list of commands or help for one command
CHAIN:
actor manipulate the miner actor
info Print miner info
DEVELOPER:
auth Manage RPC permissions
log Manage logging
wait-api Wait for lotus api to come online
fetch-params Fetch proving parameters
STORAGE:
sectors interact with sector store
proving View proving information
storage manage sector storage
sealing interact with sealing pipeline
GLOBAL OPTIONS:
2021-09-14 09:29:58 +00:00
--actor value, -a value specify other actor to query / manipulate
2022-06-29 15:17:48 +00:00
--color use color in display output (default: depends on output being a TTY)
2021-05-18 17:47:30 +00:00
--help, -h show help (default: false)
2022-06-29 15:17:48 +00:00
--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]
2021-05-18 17:47:30 +00:00
--version, -v print the version (default: false)
2022-06-29 15:17:48 +00:00
--vv enables very verbose mode, useful for debugging the CLI (default: false)
2021-05-18 17:47:30 +00:00
```
## lotus-miner init
```
NAME:
lotus-miner init - Initialize a lotus miner repo
USAGE:
lotus-miner init command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
restore Initialize a lotus miner repo from a backup
service Initialize a lotus miner sub-service
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2022-11-19 01:16:12 +00:00
--actor value specify the address of an already created miner actor
--create-worker-key create separate worker key (default: false)
--worker value, -w value worker key to use (overrides --create-worker-key)
--owner value, -o value owner key to use
--sector-size value specify sector size to use
--pre-sealed-sectors value [ --pre-sealed-sectors value ] specify set of presealed sectors for starting as a genesis miner
--pre-sealed-metadata value specify the metadata file for the presealed sectors
--nosync don't check full-node sync status (default: false)
--symlink-imported-sectors attempt to symlink to presealed sectors instead of copying them into place (default: false)
--no-local-storage don't use storageminer repo for sector storage (default: false)
--gas-premium value set gas premium for initialization messages in AttoFIL (default: "0")
--from value select which address to send actor creation message from
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner init restore
```
NAME:
lotus-miner init restore - Initialize a lotus miner repo from a backup
USAGE:
lotus-miner init restore [command options] [backupFile]
OPTIONS:
--config value config file (config.toml)
2022-06-29 15:17:48 +00:00
--nosync don't check full-node sync status (default: false)
2021-05-18 17:47:30 +00:00
--storage-config value storage paths config (storage.json)
```
2021-06-04 15:06:55 +00:00
### lotus-miner init service
```
NAME:
lotus-miner init service - Initialize a lotus miner sub-service
USAGE:
lotus-miner init service [command options] [backupFile]
OPTIONS:
2022-11-19 01:16:12 +00:00
--api-sealer value sealer API info (lotus-miner auth api-info --perm=admin)
--api-sector-index value sector Index API info (lotus-miner auth api-info --perm=admin)
--config value config file (config.toml)
--nosync don't check full-node sync status (default: false)
--type value [ --type value ] type of service to be enabled
2021-06-04 15:06:55 +00:00
```
2021-05-18 17:47:30 +00:00
## lotus-miner run
```
NAME:
lotus-miner run - Start a lotus miner process
USAGE:
lotus-miner run [command options] [arguments...]
OPTIONS:
--enable-gpu-proving enable use of GPU for mining operations (default: true)
--manage-fdlimit manage open file limit (default: true)
2022-06-29 15:17:48 +00:00
--miner-api value 2345
--nosync don't check full-node sync status (default: false)
2021-05-18 17:47:30 +00:00
```
## lotus-miner stop
```
NAME:
lotus-miner stop - Stop a running lotus miner
USAGE:
lotus-miner stop [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
## lotus-miner config
```
NAME:
2021-07-23 13:44:52 +00:00
lotus-miner config - Manage node config
2021-05-18 17:47:30 +00:00
USAGE:
2021-07-23 13:44:52 +00:00
lotus-miner config command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
default Print default node config
updated Print updated node config
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-07-23 13:44:52 +00:00
```
### lotus-miner config default
```
NAME:
lotus-miner config default - Print default node config
USAGE:
lotus-miner config default [command options] [arguments...]
OPTIONS:
--no-comment don't comment default values (default: false)
```
### lotus-miner config updated
```
NAME:
lotus-miner config updated - Print updated node config
USAGE:
lotus-miner config updated [command options] [arguments...]
OPTIONS:
--no-comment don't comment default values (default: false)
2021-05-18 17:47:30 +00:00
```
## lotus-miner backup
```
NAME:
lotus-miner backup - Create node metadata backup
USAGE:
lotus-miner backup [command options] [backup file path]
DESCRIPTION:
The backup command writes a copy of node metadata under the specified path
2021-09-20 11:26:55 +00:00
Online backups:
For security reasons, the daemon must be have LOTUS_BACKUP_BASE_PATH env var set
to a path where backup files are supposed to be saved, and the path specified in
this command must be within this base path
2021-05-18 17:47:30 +00:00
OPTIONS:
2022-06-29 15:17:48 +00:00
--offline create backup without the node running (default: false)
2021-05-18 17:47:30 +00:00
```
## lotus-miner version
```
NAME:
lotus-miner version - Print version
USAGE:
lotus-miner version [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
## lotus-miner actor
```
NAME:
lotus-miner actor - manipulate the miner actor
USAGE:
lotus-miner actor command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
set-addresses, set-addrs set addresses that your miner can be publicly dialed on
withdraw withdraw available balance to beneficiary
repay-debt pay down a miner's debt
set-peer-id set the peer id of your miner
set-owner Set owner address (this command should be invoked twice, first with the old owner as the senderAddress, and then with the new owner)
control Manage control addresses
propose-change-worker Propose a worker address change
confirm-change-worker Confirm a worker address change
compact-allocated compact allocated sectors bitfield
propose-change-beneficiary Propose a beneficiary address change
confirm-change-beneficiary Confirm a beneficiary address change
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
2022-05-03 18:42:13 +00:00
#### lotus-miner actor set-addresses, set-addrs
2021-05-18 17:47:30 +00:00
```
```
### lotus-miner actor withdraw
```
NAME:
2022-09-14 04:19:47 +00:00
lotus-miner actor withdraw - withdraw available balance to beneficiary
2021-05-18 17:47:30 +00:00
USAGE:
lotus-miner actor withdraw [command options] [amount (FIL)]
OPTIONS:
2022-09-14 04:19:47 +00:00
--beneficiary send withdraw message from the beneficiary address (default: false)
2021-09-29 20:16:19 +00:00
--confidence value number of block confirmations to wait for (default: 5)
2021-05-18 17:47:30 +00:00
```
### lotus-miner actor repay-debt
```
NAME:
lotus-miner actor repay-debt - pay down a miner's debt
USAGE:
lotus-miner actor repay-debt [command options] [amount (FIL)]
OPTIONS:
--from value optionally specify the account to send funds from
```
### lotus-miner actor set-peer-id
```
NAME:
lotus-miner actor set-peer-id - set the peer id of your miner
USAGE:
2023-01-31 10:56:55 +00:00
lotus-miner actor set-peer-id [command options] < peer id >
2021-05-18 17:47:30 +00:00
OPTIONS:
--gas-limit value set gas limit (default: 0)
```
### lotus-miner actor set-owner
```
NAME:
lotus-miner actor set-owner - Set owner address (this command should be invoked twice, first with the old owner as the senderAddress, and then with the new owner)
USAGE:
lotus-miner actor set-owner [command options] [newOwnerAddress senderAddress]
OPTIONS:
--really-do-it Actually send transaction performing the action (default: false)
```
### lotus-miner actor control
```
NAME:
lotus-miner actor control - Manage control addresses
USAGE:
lotus-miner actor control command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
list Get currently set control addresses
set Set control address(-es)
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
#### lotus-miner actor control list
```
NAME:
lotus-miner actor control list - Get currently set control addresses
USAGE:
lotus-miner actor control list [command options] [arguments...]
OPTIONS:
2022-06-29 15:17:48 +00:00
--verbose (default: false)
2021-05-18 17:47:30 +00:00
```
#### lotus-miner actor control set
```
NAME:
lotus-miner actor control set - Set control address(-es)
USAGE:
lotus-miner actor control set [command options] [...address]
OPTIONS:
--really-do-it Actually send transaction performing the action (default: false)
```
### lotus-miner actor propose-change-worker
```
NAME:
lotus-miner actor propose-change-worker - Propose a worker address change
USAGE:
lotus-miner actor propose-change-worker [command options] [address]
OPTIONS:
--really-do-it Actually send transaction performing the action (default: false)
```
### lotus-miner actor confirm-change-worker
```
NAME:
lotus-miner actor confirm-change-worker - Confirm a worker address change
USAGE:
lotus-miner actor confirm-change-worker [command options] [address]
OPTIONS:
--really-do-it Actually send transaction performing the action (default: false)
```
2021-07-22 14:18:55 +00:00
### lotus-miner actor compact-allocated
```
NAME:
lotus-miner actor compact-allocated - compact allocated sectors bitfield
USAGE:
lotus-miner actor compact-allocated [command options] [arguments...]
OPTIONS:
--mask-last-offset value Mask sector IDs from 0 to 'higest_allocated - offset' (default: 0)
--mask-upto-n value Mask sector IDs from 0 to 'n' (default: 0)
--really-do-it Actually send transaction performing the action (default: false)
```
2022-09-14 20:12:01 +00:00
### lotus-miner actor propose-change-beneficiary
```
NAME:
lotus-miner actor propose-change-beneficiary - Propose a beneficiary address change
USAGE:
lotus-miner actor propose-change-beneficiary [command options] [beneficiaryAddress quota expiration]
OPTIONS:
--actor value specify the address of miner actor
--overwrite-pending-change Overwrite the current beneficiary change proposal (default: false)
--really-do-it Actually send transaction performing the action (default: false)
```
### lotus-miner actor confirm-change-beneficiary
```
NAME:
lotus-miner actor confirm-change-beneficiary - Confirm a beneficiary address change
USAGE:
2023-05-04 13:21:05 +00:00
lotus-miner actor confirm-change-beneficiary [command options] [minerID]
2022-09-14 20:12:01 +00:00
OPTIONS:
--existing-beneficiary send confirmation from the existing beneficiary address (default: false)
--new-beneficiary send confirmation from the new beneficiary address (default: false)
--really-do-it Actually send transaction performing the action (default: false)
```
2021-05-18 17:47:30 +00:00
## lotus-miner info
```
NAME:
lotus-miner info - Print miner info
USAGE:
lotus-miner info command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
all dump all related miner info
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
--hide-sectors-info hide sectors info (default: false)
2021-08-27 11:36:40 +00:00
--blocks value Log of produced < blocks > newest blocks and rewards(Miner Fee excluded) (default: 0)
2021-05-18 17:47:30 +00:00
--help, -h show help (default: false)
```
### lotus-miner info all
```
NAME:
lotus-miner info all - dump all related miner info
USAGE:
lotus-miner info all [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
## lotus-miner auth
```
NAME:
lotus-miner auth - Manage RPC permissions
USAGE:
lotus-miner auth command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
create-token Create token
api-info Get token with API info required to connect to this node
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner auth create-token
```
NAME:
lotus-miner auth create-token - Create token
USAGE:
lotus-miner auth create-token [command options] [arguments...]
OPTIONS:
--perm value permission to assign to the token, one of: read, write, sign, admin
```
### lotus-miner auth api-info
```
NAME:
lotus-miner auth api-info - Get token with API info required to connect to this node
USAGE:
lotus-miner auth api-info [command options] [arguments...]
OPTIONS:
--perm value permission to assign to the token, one of: read, write, sign, admin
```
## lotus-miner log
```
NAME:
lotus-miner log - Manage logging
USAGE:
lotus-miner log command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
list List log systems
set-level Set log level
alerts Get alert states
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner log list
```
NAME:
lotus-miner log list - List log systems
USAGE:
lotus-miner log list [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
### lotus-miner log set-level
```
NAME:
lotus-miner log set-level - Set log level
USAGE:
lotus-miner log set-level [command options] [level]
DESCRIPTION:
Set the log level for logging systems:
2021-09-20 11:26:55 +00:00
The system flag can be specified multiple times.
eg) log set-level --system chain --system chainxchg debug
Available Levels:
debug
info
warn
error
Environment Variables:
GOLOG_LOG_LEVEL - Default log level for all log systems
GOLOG_LOG_FMT - Change output log format (json, nocolor)
GOLOG_FILE - Write logs to file
GOLOG_OUTPUT - Specify whether to output to file, stderr, stdout or a combination, i.e. file+stderr
2022-11-19 01:16:12 +00:00
2021-05-18 17:47:30 +00:00
OPTIONS:
2022-11-19 01:16:12 +00:00
--system value [ --system value ] limit to log system
2021-05-18 17:47:30 +00:00
```
2021-08-17 13:15:36 +00:00
### lotus-miner log alerts
```
NAME:
lotus-miner log alerts - Get alert states
USAGE:
lotus-miner log alerts [command options] [arguments...]
OPTIONS:
2022-06-29 15:17:48 +00:00
--all get all (active and inactive) alerts (default: false)
2021-08-17 13:15:36 +00:00
```
2021-05-18 17:47:30 +00:00
## lotus-miner wait-api
```
NAME:
lotus-miner wait-api - Wait for lotus api to come online
USAGE:
lotus-miner wait-api [command options] [arguments...]
CATEGORY:
DEVELOPER
OPTIONS:
2021-11-02 15:49:50 +00:00
--timeout value duration to wait till fail (default: 30s)
2021-05-18 17:47:30 +00:00
```
## lotus-miner fetch-params
```
NAME:
lotus-miner fetch-params - Fetch proving parameters
USAGE:
lotus-miner fetch-params [command options] [sectorSize]
CATEGORY:
DEVELOPER
OPTIONS:
--help, -h show help (default: false)
```
## lotus-miner sectors
```
NAME:
lotus-miner sectors - interact with sector store
USAGE:
lotus-miner sectors command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
status Get the seal status of a sector by its number
list List sectors
refs List References to sectors
update-state ADVANCED: manually update the state of a sector, this may aid in error recovery
pledge store random data in a sector
numbers manage sector number assignments
precommits Print on-chain precommit info
check-expire Inspect expiring sectors
expired Get or cleanup expired sectors
2022-12-20 17:01:22 +00:00
extend Extend expiring sectors while not exceeding each sector's max life
2022-11-19 01:16:12 +00:00
terminate Terminate sector on-chain then remove (WARNING: This means losing power and collateral for the removed sector)
remove Forcefully remove a sector (WARNING: This means losing power and collateral for the removed sector (use 'terminate' for lower penalty))
snap-up Mark a committed capacity sector to be filled with deals
abort-upgrade Abort the attempted (SnapDeals) upgrade of a CC sector, reverting it to as before
seal Manually start sealing a sector (filling any unused space with junk)
2023-02-08 08:36:52 +00:00
set-seal-delay Set the time (in minutes) that a new sector waits for deals before sealing starts
2022-11-19 01:16:12 +00:00
get-cc-collateral Get the collateral required to pledge a committed capacity sector
batching manage batch sector operations
match-pending-pieces force a refreshed match of pending pieces to open sectors without manually waiting for more deals
compact-partitions removes dead sectors from partitions and reduces the number of partitions used if possible
2023-04-17 16:12:15 +00:00
unseal unseal a sector
2022-11-19 01:16:12 +00:00
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner sectors status
```
NAME:
lotus-miner sectors status - Get the seal status of a sector by its number
USAGE:
lotus-miner sectors status [command options] < sectorNum >
OPTIONS:
2021-09-01 09:59:47 +00:00
--log, -l display event log (default: false)
--on-chain-info, -c show sector on chain info (default: false)
--partition-info, -p show partition related info (default: false)
--proof print snark proof bytes as hex (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner sectors list
```
NAME:
lotus-miner sectors list - List sectors
USAGE:
lotus-miner sectors list [command options] [arguments...]
OPTIONS:
2023-02-07 10:51:04 +00:00
--check-parallelism value number of parallel requests to make for checking sector states (default: 300)
--events, -e display number of events the sector has received (default: false)
--fast, -f don't show on-chain info for better performance (default: false)
--initial-pledge, -p display initial pledge (default: false)
--seal-time, -t display how long it took for the sector to be sealed (default: false)
--show-removed, -r show removed sectors (default: false)
--states value filter sectors by a comma-separated list of states
--unproven, -u only show sectors which aren't in the 'Proving' state (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner sectors refs
```
NAME:
lotus-miner sectors refs - List References to sectors
USAGE:
lotus-miner sectors refs [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
### lotus-miner sectors update-state
```
NAME:
lotus-miner sectors update-state - ADVANCED: manually update the state of a sector, this may aid in error recovery
USAGE:
lotus-miner sectors update-state [command options] < sectorNum > < newState >
OPTIONS:
--really-do-it pass this flag if you know what you are doing (default: false)
```
### lotus-miner sectors pledge
```
NAME:
lotus-miner sectors pledge - store random data in a sector
USAGE:
lotus-miner sectors pledge [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
2022-08-18 14:37:22 +00:00
### lotus-miner sectors numbers
```
NAME:
lotus-miner sectors numbers - manage sector number assignments
USAGE:
lotus-miner sectors numbers command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
info view sector assigner state
reservations list sector number reservations
reserve create sector number reservations
free remove sector number reservations
help, h Shows a list of commands or help for one command
2022-08-18 14:37:22 +00:00
OPTIONS:
--help, -h show help (default: false)
```
#### lotus-miner sectors numbers info
```
NAME:
lotus-miner sectors numbers info - view sector assigner state
USAGE:
lotus-miner sectors numbers info [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
#### lotus-miner sectors numbers reservations
```
NAME:
lotus-miner sectors numbers reservations - list sector number reservations
USAGE:
lotus-miner sectors numbers reservations [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
#### lotus-miner sectors numbers reserve
```
NAME:
lotus-miner sectors numbers reserve - create sector number reservations
USAGE:
lotus-miner sectors numbers reserve [command options] [reservation name] [reserved ranges]
OPTIONS:
--force skip duplicate reservation checks (note: can lead to damaging other reservations on free) (default: false)
```
#### lotus-miner sectors numbers free
```
NAME:
lotus-miner sectors numbers free - remove sector number reservations
USAGE:
lotus-miner sectors numbers free [command options] [reservation name]
OPTIONS:
--help, -h show help (default: false)
```
2022-05-23 16:17:38 +00:00
### lotus-miner sectors precommits
2022-05-23 06:28:47 +00:00
```
NAME:
2022-05-23 16:17:38 +00:00
lotus-miner sectors precommits - Print on-chain precommit info
2022-05-23 06:28:47 +00:00
USAGE:
2022-05-23 16:17:38 +00:00
lotus-miner sectors precommits [command options] [arguments...]
2022-05-23 06:28:47 +00:00
OPTIONS:
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
2021-08-16 13:31:21 +00:00
### lotus-miner sectors check-expire
```
NAME:
lotus-miner sectors check-expire - Inspect expiring sectors
USAGE:
lotus-miner sectors check-expire [command options] [arguments...]
OPTIONS:
--cutoff value skip sectors whose current expiration is more than < cutoff > epochs from now, defaults to 60 days (default: 172800)
```
2021-08-19 15:05:34 +00:00
### lotus-miner sectors expired
```
NAME:
lotus-miner sectors expired - Get or cleanup expired sectors
USAGE:
lotus-miner sectors expired [command options] [arguments...]
OPTIONS:
--expired-epoch value epoch at which to check sector expirations (default: WinningPoSt lookback epoch)
2022-06-29 15:17:48 +00:00
--remove-expired remove expired sectors (default: false)
--show-removed show removed sectors (default: false)
2021-08-19 15:05:34 +00:00
```
2022-12-20 17:01:22 +00:00
### lotus-miner sectors extend
2021-08-16 13:31:21 +00:00
```
NAME:
2022-12-20 17:01:22 +00:00
lotus-miner sectors extend - Extend expiring sectors while not exceeding each sector's max life
2021-08-16 13:31:21 +00:00
USAGE:
2022-12-20 17:01:22 +00:00
lotus-miner sectors extend [command options] < sectorNumbers... ( optional ) >
2021-08-16 13:31:21 +00:00
OPTIONS:
2023-02-22 20:01:55 +00:00
--drop-claims drop claims for sectors that can be extended, but only by dropping some of their verified power claims (default: false)
2021-08-16 13:31:21 +00:00
--exclude value optionally provide a file containing excluding sectors
--extension value try to extend selected sectors by this number of epochs, defaults to 540 days (default: 1555200)
2022-06-29 15:17:48 +00:00
--from value only consider sectors whose current expiration epoch is in the range of [from, to], < from > defaults to: now + 120 (1 hour) (default: 0)
2021-08-16 13:31:21 +00:00
--max-fee value use up to this amount of FIL for one message. pass this flag to avoid message congestion. (default: "0")
2023-02-22 20:01:55 +00:00
--max-sectors value the maximum number of sectors contained in each message (default: 0)
2022-06-29 15:17:48 +00:00
--new-expiration value try to extend selected sectors to this epoch, ignoring extension (default: 0)
2022-08-18 15:03:26 +00:00
--only-cc only extend CC sectors (useful for making sector ready for snap upgrade) (default: false)
2022-12-20 17:01:22 +00:00
--really-do-it pass this flag to really extend sectors, otherwise will only print out json representation of parameters (default: false)
2022-06-29 15:17:48 +00:00
--sector-file value provide a file containing one sector number in each line, ignoring above selecting criteria
--to value only consider sectors whose current expiration epoch is in the range of [from, to], < to > defaults to: now + 92160 (32 days) (default: 0)
--tolerance value don't try to extend sectors by fewer than this number of epochs, defaults to 7 days (default: 20160)
2021-08-16 13:31:21 +00:00
```
2021-05-18 17:47:30 +00:00
### lotus-miner sectors terminate
```
NAME:
lotus-miner sectors terminate - Terminate sector on-chain then remove (WARNING: This means losing power and collateral for the removed sector)
USAGE:
lotus-miner sectors terminate command [command options] < sectorNum >
COMMANDS:
2022-11-19 01:16:12 +00:00
flush Send a terminate message if there are sectors queued for termination
pending List sector numbers of sectors pending termination
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
--really-do-it pass this flag if you know what you are doing (default: false)
--help, -h show help (default: false)
```
#### lotus-miner sectors terminate flush
```
NAME:
lotus-miner sectors terminate flush - Send a terminate message if there are sectors queued for termination
USAGE:
lotus-miner sectors terminate flush [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
#### lotus-miner sectors terminate pending
```
NAME:
lotus-miner sectors terminate pending - List sector numbers of sectors pending termination
USAGE:
lotus-miner sectors terminate pending [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
### lotus-miner sectors remove
```
NAME:
lotus-miner sectors remove - Forcefully remove a sector (WARNING: This means losing power and collateral for the removed sector (use 'terminate' for lower penalty))
USAGE:
lotus-miner sectors remove [command options] < sectorNum >
OPTIONS:
--really-do-it pass this flag if you know what you are doing (default: false)
```
2021-12-08 17:11:19 +00:00
### lotus-miner sectors snap-up
```
NAME:
lotus-miner sectors snap-up - Mark a committed capacity sector to be filled with deals
USAGE:
lotus-miner sectors snap-up [command options] < sectorNum >
OPTIONS:
--help, -h show help (default: false)
```
2022-01-21 17:39:18 +00:00
### lotus-miner sectors abort-upgrade
```
NAME:
lotus-miner sectors abort-upgrade - Abort the attempted (SnapDeals) upgrade of a CC sector, reverting it to as before
USAGE:
lotus-miner sectors abort-upgrade [command options] < sectorNum >
OPTIONS:
2022-02-25 15:48:08 +00:00
--really-do-it pass this flag if you know what you are doing (default: false)
2021-12-08 17:11:19 +00:00
```
2021-12-08 17:11:19 +00:00
2021-05-18 17:47:30 +00:00
### lotus-miner sectors seal
```
NAME:
lotus-miner sectors seal - Manually start sealing a sector (filling any unused space with junk)
USAGE:
lotus-miner sectors seal [command options] < sectorNum >
OPTIONS:
--help, -h show help (default: false)
```
### lotus-miner sectors set-seal-delay
```
NAME:
2023-02-08 08:36:52 +00:00
lotus-miner sectors set-seal-delay - Set the time (in minutes) that a new sector waits for deals before sealing starts
2021-05-18 17:47:30 +00:00
USAGE:
2023-02-08 08:36:52 +00:00
lotus-miner sectors set-seal-delay [command options] < time >
2021-05-18 17:47:30 +00:00
OPTIONS:
2023-02-08 08:36:52 +00:00
--seconds Specifies that the time argument should be in seconds (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner sectors get-cc-collateral
```
NAME:
lotus-miner sectors get-cc-collateral - Get the collateral required to pledge a committed capacity sector
USAGE:
lotus-miner sectors get-cc-collateral [command options] [arguments...]
OPTIONS:
--expiration value the epoch when the sector will expire (default: 0)
```
### lotus-miner sectors batching
```
NAME:
lotus-miner sectors batching - manage batch sector operations
USAGE:
lotus-miner sectors batching command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
commit list sectors waiting in commit batch queue
precommit list sectors waiting in precommit batch queue
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
2021-06-01 21:39:45 +00:00
#### lotus-miner sectors batching commit
2021-05-18 17:47:30 +00:00
```
NAME:
2021-06-01 21:39:45 +00:00
lotus-miner sectors batching commit - list sectors waiting in commit batch queue
2021-05-18 17:47:30 +00:00
USAGE:
2021-06-01 21:39:45 +00:00
lotus-miner sectors batching commit [command options] [arguments...]
2021-05-18 17:47:30 +00:00
OPTIONS:
--publish-now send a batch now (default: false)
```
2021-06-01 21:39:45 +00:00
#### lotus-miner sectors batching precommit
2021-05-18 17:47:30 +00:00
```
NAME:
2021-06-01 21:39:45 +00:00
lotus-miner sectors batching precommit - list sectors waiting in precommit batch queue
2021-05-18 17:47:30 +00:00
USAGE:
2021-06-01 21:39:45 +00:00
lotus-miner sectors batching precommit [command options] [arguments...]
2021-05-18 17:47:30 +00:00
OPTIONS:
--publish-now send a batch now (default: false)
```
2022-01-09 03:42:00 +00:00
### lotus-miner sectors match-pending-pieces
```
NAME:
lotus-miner sectors match-pending-pieces - force a refreshed match of pending pieces to open sectors without manually waiting for more deals
USAGE:
lotus-miner sectors match-pending-pieces [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
2022-05-23 16:25:51 +00:00
### lotus-miner sectors compact-partitions
```
NAME:
lotus-miner sectors compact-partitions - removes dead sectors from partitions and reduces the number of partitions used if possible
USAGE:
lotus-miner sectors compact-partitions [command options] [arguments...]
OPTIONS:
2022-11-19 01:16:12 +00:00
--actor value Specify the address of the miner to run this command
--deadline value the deadline to compact the partitions in (default: 0)
--partitions value [ --partitions value ] list of partitions to compact sectors in
--really-do-it Actually send transaction performing the action (default: false)
2022-05-23 16:25:51 +00:00
```
2023-04-17 16:12:15 +00:00
### lotus-miner sectors unseal
```
NAME:
lotus-miner sectors unseal - unseal a sector
USAGE:
lotus-miner sectors unseal [command options] [sector number]
OPTIONS:
--help, -h show help (default: false)
```
2021-05-18 17:47:30 +00:00
## lotus-miner proving
```
NAME:
lotus-miner proving - View proving information
USAGE:
lotus-miner proving command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
info View current state information
deadlines View the current proving period deadlines information
deadline View the current proving period deadline information by its index
faults View the currently known proving faulty sectors information
check Check sectors provable
workers list workers
compute Compute simulated proving tasks
recover-faults Manually recovers faulty sectors on chain
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner proving info
```
NAME:
lotus-miner proving info - View current state information
USAGE:
lotus-miner proving info [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
### lotus-miner proving deadlines
```
NAME:
lotus-miner proving deadlines - View the current proving period deadlines information
USAGE:
lotus-miner proving deadlines [command options] [arguments...]
OPTIONS:
2022-08-02 08:45:20 +00:00
--all, -a Count all sectors (only live sectors are counted by default) (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner proving deadline
```
NAME:
2022-07-01 16:15:35 +00:00
lotus-miner proving deadline - View the current proving period deadline information by its index
2021-05-18 17:47:30 +00:00
USAGE:
lotus-miner proving deadline [command options] < deadlineIdx >
OPTIONS:
2022-08-03 09:06:05 +00:00
--bitfield, -b Print partition bitfield stats (default: false)
2022-07-01 16:15:35 +00:00
--sector-nums, -n Print sector/fault numbers belonging to this deadline (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner proving faults
```
NAME:
lotus-miner proving faults - View the currently known proving faulty sectors information
USAGE:
lotus-miner proving faults [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
### lotus-miner proving check
```
NAME:
lotus-miner proving check - Check sectors provable
USAGE:
lotus-miner proving check [command options] < deadlineIdx >
OPTIONS:
2022-06-29 15:17:48 +00:00
--faulty only check faulty sectors (default: false)
2021-10-08 12:54:02 +00:00
--only-bad print only bad sectors (default: false)
--slow run slower checks (default: false)
--storage-id value filter sectors by storage path (path id)
2021-05-18 17:47:30 +00:00
```
2022-03-26 20:16:12 +00:00
### lotus-miner proving workers
```
NAME:
lotus-miner proving workers - list workers
USAGE:
lotus-miner proving workers [command options] [arguments...]
OPTIONS:
2023-01-19 04:09:10 +00:00
--help, -h show help (default: false)
2022-03-26 20:16:12 +00:00
```
2022-03-28 20:54:22 +00:00
### lotus-miner proving compute
```
NAME:
2022-07-03 09:51:50 +00:00
lotus-miner proving compute - Compute simulated proving tasks
2022-03-28 20:54:22 +00:00
USAGE:
lotus-miner proving compute command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
windowed-post, window-post Compute WindowPoSt for a specific deadline
help, h Shows a list of commands or help for one command
2022-03-28 20:54:22 +00:00
OPTIONS:
--help, -h show help (default: false)
```
2022-05-03 18:42:13 +00:00
##### lotus-miner proving compute windowed-post, window-post
2022-03-28 20:54:22 +00:00
```
```
2022-09-06 15:47:30 +00:00
### lotus-miner proving recover-faults
```
NAME:
lotus-miner proving recover-faults - Manually recovers faulty sectors on chain
USAGE:
lotus-miner proving recover-faults [command options] < faulty sectors >
OPTIONS:
--confidence value number of block confirmations to wait for (default: 5)
```
2021-05-18 17:47:30 +00:00
## lotus-miner storage
```
NAME:
lotus-miner storage - manage sector storage
USAGE:
lotus-miner storage command [command options] [arguments...]
DESCRIPTION:
Sectors can be stored across many filesystem paths. These
2021-09-20 11:26:55 +00:00
commands provide ways to manage the storage the miner will used to store sectors
long term for proving (references as 'store') as well as how sectors will be
stored while moving through the sealing pipeline (references as 'seal').
2021-05-18 17:47:30 +00:00
COMMANDS:
2022-11-19 01:16:12 +00:00
attach attach local storage path
detach detach local storage path
redeclare redeclare sectors in a local storage path
list list local storage paths
find find sector in the storage system
cleanup trigger cleanup actions
locks show active sector locks
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner storage attach
```
NAME:
lotus-miner storage attach - attach local storage path
USAGE:
2023-01-31 10:56:55 +00:00
lotus-miner storage attach [command options] [path]
2021-05-18 17:47:30 +00:00
DESCRIPTION:
Storage can be attached to the miner using this command. The storage volume
2021-09-20 11:26:55 +00:00
list is stored local to the miner in $LOTUS_MINER_PATH/storage.json. We do not
recommend manually modifying this value without further understanding of the
storage system.
Each storage volume contains a configuration file which describes the
capabilities of the volume. When the '--init' flag is provided, this file will
be created using the additional flags.
2021-05-18 17:47:30 +00:00
2021-09-20 11:26:55 +00:00
Weight
A high weight value means data will be more likely to be stored in this path
Seal
Data for the sealing process will be stored here
Store
Finalized sectors that will be moved here for long term storage and be proven
over time
2022-11-19 01:16:12 +00:00
2021-05-18 17:47:30 +00:00
OPTIONS:
2022-11-19 01:16:12 +00:00
--allow-to value [ --allow-to value ] path groups allowed to pull data from this path (allow all if not specified)
--groups value [ --groups value ] path group names
--init initialize the path first (default: false)
--max-storage value (for init) limit storage space for sectors (expensive for very large paths!)
--seal (for init) use path for sealing (default: false)
--store (for init) use path for long-term storage (default: false)
--weight value (for init) path weight (default: 10)
2021-05-18 17:47:30 +00:00
```
2022-07-15 10:44:05 +00:00
### lotus-miner storage detach
```
NAME:
lotus-miner storage detach - detach local storage path
USAGE:
lotus-miner storage detach [command options] [path]
OPTIONS:
--really-do-it (default: false)
```
### lotus-miner storage redeclare
```
NAME:
lotus-miner storage redeclare - redeclare sectors in a local storage path
USAGE:
2023-01-31 10:56:55 +00:00
lotus-miner storage redeclare [command options] [path]
2022-07-15 10:44:05 +00:00
OPTIONS:
--all redeclare all storage paths (default: false)
--drop-missing Drop index entries with missing files (default: false)
--id value storage path ID
```
2021-05-18 17:47:30 +00:00
### lotus-miner storage list
```
NAME:
lotus-miner storage list - list local storage paths
USAGE:
lotus-miner storage list command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
sectors get list of all sector files
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
#### lotus-miner storage list sectors
```
NAME:
lotus-miner storage list sectors - get list of all sector files
USAGE:
lotus-miner storage list sectors [command options] [arguments...]
OPTIONS:
2023-01-19 04:09:10 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner storage find
```
NAME:
lotus-miner storage find - find sector in the storage system
USAGE:
lotus-miner storage find [command options] [sector number]
OPTIONS:
--help, -h show help (default: false)
```
### lotus-miner storage cleanup
```
NAME:
lotus-miner storage cleanup - trigger cleanup actions
USAGE:
lotus-miner storage cleanup [command options] [arguments...]
OPTIONS:
2022-06-29 15:17:48 +00:00
--removed cleanup remaining files from removed sectors (default: true)
2021-05-18 17:47:30 +00:00
```
2021-12-03 11:33:23 +00:00
### lotus-miner storage locks
```
NAME:
lotus-miner storage locks - show active sector locks
USAGE:
lotus-miner storage locks [command options] [arguments...]
OPTIONS:
--help, -h show help (default: false)
```
2021-05-18 17:47:30 +00:00
## lotus-miner sealing
```
NAME:
lotus-miner sealing - interact with sealing pipeline
USAGE:
lotus-miner sealing command [command options] [arguments...]
COMMANDS:
2022-11-19 01:16:12 +00:00
jobs list running jobs
workers list workers
sched-diag Dump internal scheduler state
abort Abort a running job
data-cid Compute data CID using workers
help, h Shows a list of commands or help for one command
2021-05-18 17:47:30 +00:00
OPTIONS:
2021-09-20 11:26:55 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner sealing jobs
```
NAME:
lotus-miner sealing jobs - list running jobs
USAGE:
lotus-miner sealing jobs [command options] [arguments...]
OPTIONS:
--show-ret-done show returned but not consumed calls (default: false)
```
### lotus-miner sealing workers
```
NAME:
lotus-miner sealing workers - list workers
USAGE:
lotus-miner sealing workers [command options] [arguments...]
OPTIONS:
2023-01-19 04:09:10 +00:00
--help, -h show help (default: false)
2021-05-18 17:47:30 +00:00
```
### lotus-miner sealing sched-diag
```
NAME:
lotus-miner sealing sched-diag - Dump internal scheduler state
USAGE:
lotus-miner sealing sched-diag [command options] [arguments...]
OPTIONS:
--force-sched (default: false)
```
### lotus-miner sealing abort
```
NAME:
lotus-miner sealing abort - Abort a running job
USAGE:
lotus-miner sealing abort [command options] [callid]
OPTIONS:
2022-08-02 09:47:30 +00:00
--sched Specifies that the argument is UUID of the request to be removed from scheduler (default: false)
2021-05-18 17:47:30 +00:00
```
2022-05-24 13:07:53 +00:00
### lotus-miner sealing data-cid
```
NAME:
2022-05-24 14:01:54 +00:00
lotus-miner sealing data-cid - Compute data CID using workers
2022-05-24 13:07:53 +00:00
USAGE:
2022-05-24 14:01:54 +00:00
lotus-miner sealing data-cid [command options] [file/url] < padded piece size >
2022-05-24 13:07:53 +00:00
OPTIONS:
2022-05-24 14:01:54 +00:00
--file-size value real file size (default: 0)
2022-05-24 13:07:53 +00:00
```
