# lotus ``` NAME: lotus - Filecoin decentralized storage network client USAGE: lotus [global options] command [command options] [arguments...] VERSION: 1.26.0 COMMANDS: daemon Start a lotus daemon process backup Create node metadata backup config Manage node config version Print version help, h Shows a list of commands or help for one command BASIC: send Send funds between accounts wallet Manage wallet info Print node info client Make deals, store data, retrieve data msig Interact with a multisig wallet filplus Interact with the verified registry actor used by Filplus paych Manage payment channels DEVELOPER: auth Manage RPC permissions mpool Manage message pool state Interact with and query filecoin chain state chain Interact with filecoin blockchain log Manage logging wait-api Wait for lotus api to come online fetch-params Fetch proving parameters evm Commands related to the Filecoin EVM runtime NETWORK: net Manage P2P Network sync Inspect or interact with the chain syncer STATUS: status Check node status GLOBAL OPTIONS: --color use color in display output (default: depends on output being a TTY) --interactive setting to false will disable interactive functionality of commands (default: false) --force-send if true, will ignore pre-send checks (default: false) --vv enables very verbose mode, useful for debugging the CLI (default: false) --help, -h show help --version, -v print the version ``` ## lotus daemon ``` NAME: lotus daemon - Start a lotus daemon process USAGE: lotus daemon command [command options] [arguments...] COMMANDS: stop Stop a running lotus daemon help, h Shows a list of commands or help for one command OPTIONS: --api value (default: "1234") --genesis value genesis file to use for first node run --bootstrap (default: true) --import-chain value on first run, load chain from given file or url and validate --import-snapshot value import chain state from a given chain export file or url --remove-existing-chain remove existing chain and splitstore data on a snapshot-import (default: false) --halt-after-import halt the process after importing chain from file (default: false) --lite start lotus in lite mode (default: false) --pprof value specify name of file for writing cpu profile to --profile value specify type of node --manage-fdlimit manage open file limit (default: true) --config value specify path of config file to use --api-max-req-size value maximum API request size accepted by the JSON RPC server (default: 0) --restore value restore from backup file --restore-config value config file to use when restoring from backup --help, -h show help ``` ### lotus daemon stop ``` NAME: lotus daemon stop - Stop a running lotus daemon USAGE: lotus daemon stop [command options] [arguments...] OPTIONS: --help, -h show help ``` ## lotus backup ``` NAME: lotus backup - Create node metadata backup USAGE: lotus backup [command options] [backup file path] DESCRIPTION: The backup command writes a copy of node metadata under the specified path 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 OPTIONS: --offline create backup without the node running (default: false) --help, -h show help ``` ## lotus config ``` NAME: lotus config - Manage node config USAGE: lotus config command [command options] [arguments...] COMMANDS: default Print default node config updated Print updated node config help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` ### lotus config default ``` NAME: lotus config default - Print default node config USAGE: lotus config default [command options] [arguments...] OPTIONS: --no-comment don't comment default values (default: false) --help, -h show help ``` ### lotus config updated ``` NAME: lotus config updated - Print updated node config USAGE: lotus config updated [command options] [arguments...] OPTIONS: --no-comment don't comment default values (default: false) --help, -h show help ``` ## lotus version ``` NAME: lotus version - Print version USAGE: lotus version [command options] [arguments...] OPTIONS: --help, -h show help ``` ## lotus send ``` NAME: lotus send - Send funds between accounts USAGE: lotus send [command options] [targetAddress] [amount] CATEGORY: BASIC OPTIONS: --from value optionally specify the account to send funds from --from-eth-addr value optionally specify the eth addr to send funds from --gas-premium value specify gas price to use in AttoFIL (default: "0") --gas-feecap value specify gas fee cap to use in AttoFIL (default: "0") --gas-limit value specify gas limit (default: 0) --nonce value specify the nonce to use (default: 0) --method value specify method to invoke (default: 0) --params-json value specify invocation parameters in json --params-hex value specify invocation parameters in hex --force Deprecated: use global 'force-send' (default: false) --help, -h show help ``` ## lotus wallet ``` NAME: lotus wallet - Manage wallet USAGE: lotus wallet command [command options] [arguments...] COMMANDS: new Generate a new key of the given type list List wallet address balance Get account balance export export keys import import keys default Get default wallet address set-default Set default wallet address sign sign a message verify verify the signature of a message delete Soft delete an address from the wallet - hard deletion needed for permanent removal market Interact with market balances help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` ### lotus wallet new ``` NAME: lotus wallet new - Generate a new key of the given type USAGE: lotus wallet new [command options] [bls|secp256k1 (default secp256k1)] OPTIONS: --help, -h show help ``` ### lotus wallet list ``` NAME: lotus wallet list - List wallet address USAGE: lotus wallet list [command options] [arguments...] OPTIONS: --addr-only, -a Only print addresses (default: false) --id, -i Output ID addresses (default: false) --market, -m Output market balances (default: false) --help, -h show help ``` ### lotus wallet balance ``` NAME: lotus wallet balance - Get account balance USAGE: lotus wallet balance [command options] [address] OPTIONS: --help, -h show help ``` ### lotus wallet export ``` NAME: lotus wallet export - export keys USAGE: lotus wallet export [command options] [address] OPTIONS: --help, -h show help ``` ### lotus wallet import ``` NAME: lotus wallet import - import keys USAGE: lotus wallet import [command options] [ (optional, will read from stdin if omitted)] OPTIONS: --format value specify input format for key (default: "hex-lotus") --as-default import the given key as your new default key (default: false) --help, -h show help ``` ### lotus wallet default ``` NAME: lotus wallet default - Get default wallet address USAGE: lotus wallet default [command options] [arguments...] OPTIONS: --help, -h show help ``` ### lotus wallet set-default ``` NAME: lotus wallet set-default - Set default wallet address USAGE: lotus wallet set-default [command options] [address] OPTIONS: --help, -h show help ``` ### lotus wallet sign ``` NAME: lotus wallet sign - sign a message USAGE: lotus wallet sign [command options] OPTIONS: --help, -h show help ``` ### lotus wallet verify ``` NAME: lotus wallet verify - verify the signature of a message USAGE: lotus wallet verify [command options] OPTIONS: --help, -h show help ``` ### lotus wallet delete ``` NAME: lotus wallet delete - Soft delete an address from the wallet - hard deletion needed for permanent removal USAGE: lotus wallet delete [command options]
OPTIONS: --help, -h show help ``` ### lotus wallet market ``` NAME: lotus wallet market - Interact with market balances USAGE: lotus wallet market command [command options] [arguments...] COMMANDS: withdraw Withdraw funds from the Storage Market Actor add Add funds to the Storage Market Actor help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` #### lotus wallet market withdraw ``` NAME: lotus wallet market withdraw - Withdraw funds from the Storage Market Actor USAGE: lotus wallet market withdraw [command options] [amount (FIL) optional, otherwise will withdraw max available] OPTIONS: --wallet value, -w value Specify address to withdraw funds to, otherwise it will use the default wallet address --address value, -a value Market address to withdraw from (account or miner actor address, defaults to --wallet address) --confidence value number of block confirmations to wait for (default: 5) --help, -h show help ``` #### lotus wallet market add ``` NAME: lotus wallet market add - Add funds to the Storage Market Actor USAGE: lotus wallet market add [command options] OPTIONS: --from value, -f value Specify address to move funds from, otherwise it will use the default wallet address --address value, -a value Market address to move funds to (account or miner actor address, defaults to --from address) --help, -h show help ``` ## lotus info ``` NAME: lotus info - Print node info USAGE: lotus info [command options] [arguments...] CATEGORY: BASIC OPTIONS: --help, -h show help ``` ## lotus client ``` NAME: lotus client - Make deals, store data, retrieve data USAGE: lotus client command [command options] [arguments...] COMMANDS: help, h Shows a list of commands or help for one command DATA: import Import data drop Remove import local List locally imported data stat Print information about a locally stored file (piece size, etc) RETRIEVAL: find Find data in the network retrieval-ask Get a miner's retrieval ask retrieve Retrieve data from network cat Show data from network ls List object links cancel-retrieval Cancel a retrieval deal by deal ID; this also cancels the associated transfer list-retrievals List retrieval market deals STORAGE: deal Initialize storage deal with a miner query-ask Find a miners ask list-deals List storage market deals get-deal Print detailed deal information list-asks List asks for top miners deal-stats Print statistics about local storage deals inspect-deal Inspect detailed information about deal's lifecycle and the various stages it goes through UTIL: commP Calculate the piece-cid (commP) of a CAR file generate-car Generate a car file from input balances Print storage market client balances list-transfers List ongoing data transfers for deals restart-transfer Force restart a stalled data transfer cancel-transfer Force cancel a data transfer OPTIONS: --help, -h show help ``` ### lotus client import ``` NAME: lotus client import - Import data USAGE: lotus client import [command options] [inputPath] CATEGORY: DATA OPTIONS: --car import from a car file instead of a regular file (default: false) --quiet, -q Output root CID only (default: false) --help, -h show help ``` ### lotus client drop ``` NAME: lotus client drop - Remove import USAGE: lotus client drop [command options] [import ID...] CATEGORY: DATA OPTIONS: --help, -h show help ``` ### lotus client local ``` NAME: lotus client local - List locally imported data USAGE: lotus client local [command options] [arguments...] CATEGORY: DATA OPTIONS: --help, -h show help ``` ### lotus client stat ``` NAME: lotus client stat - Print information about a locally stored file (piece size, etc) USAGE: lotus client stat [command options] CATEGORY: DATA OPTIONS: --help, -h show help ``` ### lotus client find ``` NAME: lotus client find - Find data in the network USAGE: lotus client find [command options] [dataCid] CATEGORY: RETRIEVAL OPTIONS: --pieceCid value require data to be retrieved from a specific Piece CID --help, -h show help ``` ### lotus client retrieval-ask ``` NAME: lotus client retrieval-ask - Get a miner's retrieval ask USAGE: lotus client retrieval-ask [command options] [minerAddress] [data CID] CATEGORY: RETRIEVAL OPTIONS: --size value data size in bytes (default: 0) --help, -h show help ``` ### lotus client retrieve ``` NAME: lotus client retrieve - Retrieve data from network USAGE: lotus client retrieve [command options] [dataCid outputPath] CATEGORY: RETRIEVAL DESCRIPTION: Retrieve data from the Filecoin network. The retrieve command will attempt to find a provider make a retrieval deal with them. In case a provider can't be found, it can be specified with the --provider flag. By default the data will be interpreted as DAG-PB UnixFSv1 File. Alternatively a CAR file containing the raw IPLD graph can be exported by setting the --car flag. Partial Retrieval: The --data-selector flag can be used to specify a sub-graph to fetch. The selector can be specified as either IPLD datamodel text-path selector, or IPLD json selector. In case of unixfs retrieval, the selector must point at a single root node, and match the entire graph under that node. In case of CAR retrieval, the selector must have one common "sub-root" node. Examples: - Retrieve a file by CID $ lotus client retrieve Qm... my-file.txt - Retrieve a file by CID from f0123 $ lotus client retrieve --provider f0123 Qm... my-file.txt - Retrieve a first file from a specified directory $ lotus client retrieve --data-selector /Links/0/Hash Qm... my-file.txt OPTIONS: --car Export to a car file instead of a regular file (default: false) --data-selector value, --datamodel-path-selector value IPLD datamodel text-path selector, or IPLD json selector --car-export-merkle-proof (requires --data-selector and --car) Export data-selector merkle proof (default: false) --from value address to send transactions from --provider value, --miner value provider to use for retrieval, if not present it'll use local discovery --maxPrice value maximum price the client is willing to consider (default: 0 FIL) --pieceCid value require data to be retrieved from a specific Piece CID --allow-local (default: false) --help, -h show help ``` ### lotus client cat ``` NAME: lotus client cat - Show data from network USAGE: lotus client cat [command options] [dataCid] CATEGORY: RETRIEVAL OPTIONS: --ipld list IPLD datamodel links (default: false) --data-selector value IPLD datamodel text-path selector, or IPLD json selector --from value address to send transactions from --provider value, --miner value provider to use for retrieval, if not present it'll use local discovery --maxPrice value maximum price the client is willing to consider (default: 0 FIL) --pieceCid value require data to be retrieved from a specific Piece CID --allow-local (default: false) --help, -h show help ``` ### lotus client ls ``` NAME: lotus client ls - List object links USAGE: lotus client ls [command options] [dataCid] CATEGORY: RETRIEVAL OPTIONS: --ipld list IPLD datamodel links (default: false) --depth value list links recursively up to the specified depth (default: 1) --data-selector value IPLD datamodel text-path selector, or IPLD json selector --from value address to send transactions from --provider value, --miner value provider to use for retrieval, if not present it'll use local discovery --maxPrice value maximum price the client is willing to consider (default: 0 FIL) --pieceCid value require data to be retrieved from a specific Piece CID --allow-local (default: false) --help, -h show help ``` ### lotus client cancel-retrieval ``` NAME: lotus client cancel-retrieval - Cancel a retrieval deal by deal ID; this also cancels the associated transfer USAGE: lotus client cancel-retrieval [command options] [arguments...] CATEGORY: RETRIEVAL OPTIONS: --deal-id value specify retrieval deal by deal ID (default: 0) --help, -h show help ``` ### lotus client list-retrievals ``` NAME: lotus client list-retrievals - List retrieval market deals USAGE: lotus client list-retrievals [command options] [arguments...] CATEGORY: RETRIEVAL OPTIONS: --verbose, -v print verbose deal details (default: false) --show-failed show failed/failing deals (default: true) --completed show completed retrievals (default: false) --watch watch deal updates in real-time, rather than a one time list (default: false) --help, -h show help ``` ### lotus client deal ``` NAME: lotus client deal - Initialize storage deal with a miner USAGE: lotus client deal [command options] [dataCid miner price duration] CATEGORY: STORAGE DESCRIPTION: Make a deal with a miner. dataCid comes from running 'lotus client import'. miner is the address of the miner you wish to make a deal with. price is measured in FIL/Epoch. Miners usually don't accept a bid lower than their advertised ask (which is in FIL/GiB/Epoch). You can check a miners listed price with 'lotus client query-ask '. duration is how long the miner should store the data for, in blocks. The minimum value is 518400 (6 months). OPTIONS: --manual-piece-cid value manually specify piece commitment for data (dataCid must be to a car file) --manual-piece-size value if manually specifying piece cid, used to specify size (dataCid must be to a car file) (default: 0) --manual-stateless-deal instructs the node to send an offline deal without registering it with the deallist/fsm (default: false) --from value specify address to fund the deal with --start-epoch value specify the epoch that the deal should start at (default: -1) --fast-retrieval indicates that data should be available for fast retrieval (default: true) --verified-deal indicate that the deal counts towards verified client total (default: true if client is verified, false otherwise) --provider-collateral value specify the requested provider collateral the miner should put up --help, -h show help ``` ### lotus client query-ask ``` NAME: lotus client query-ask - Find a miners ask USAGE: lotus client query-ask [command options] [minerAddress] CATEGORY: STORAGE OPTIONS: --peerid value specify peer ID of node to make query against --size value data size in bytes (default: 0) --duration value deal duration (default: 0) --help, -h show help ``` ### lotus client list-deals ``` NAME: lotus client list-deals - List storage market deals USAGE: lotus client list-deals [command options] [arguments...] CATEGORY: STORAGE OPTIONS: --verbose, -v print verbose deal details (default: false) --show-failed show failed/failing deals (default: false) --watch watch deal updates in real-time, rather than a one time list (default: false) --help, -h show help ``` ### lotus client get-deal ``` NAME: lotus client get-deal - Print detailed deal information USAGE: lotus client get-deal [command options] [proposalCID] CATEGORY: STORAGE OPTIONS: --help, -h show help ``` ### lotus client list-asks ``` NAME: lotus client list-asks - List asks for top miners USAGE: lotus client list-asks [command options] [arguments...] CATEGORY: STORAGE OPTIONS: --by-ping sort by ping (default: false) --output-format value Either 'text' or 'csv' (default: "text") --protocols Output supported deal protocols (default: false) --help, -h show help ``` ### lotus client deal-stats ``` NAME: lotus client deal-stats - Print statistics about local storage deals USAGE: lotus client deal-stats [command options] [arguments...] CATEGORY: STORAGE OPTIONS: --newer-than value (default: 0s) --help, -h show help ``` ### lotus client inspect-deal ``` NAME: lotus client inspect-deal - Inspect detailed information about deal's lifecycle and the various stages it goes through USAGE: lotus client inspect-deal [command options] [arguments...] CATEGORY: STORAGE OPTIONS: --deal-id value (default: 0) --proposal-cid value --help, -h show help ``` ### lotus client commP ``` NAME: lotus client commP - Calculate the piece-cid (commP) of a CAR file USAGE: lotus client commP [command options] [inputFile] CATEGORY: UTIL OPTIONS: --help, -h show help ``` ### lotus client generate-car ``` NAME: lotus client generate-car - Generate a car file from input USAGE: lotus client generate-car [command options] [inputPath outputPath] CATEGORY: UTIL OPTIONS: --help, -h show help ``` ### lotus client balances ``` NAME: lotus client balances - Print storage market client balances USAGE: lotus client balances [command options] [arguments...] CATEGORY: UTIL OPTIONS: --client value specify storage client address --help, -h show help ``` ### lotus client list-transfers ``` NAME: lotus client list-transfers - List ongoing data transfers for deals USAGE: lotus client list-transfers [command options] [arguments...] CATEGORY: UTIL OPTIONS: --verbose, -v print verbose transfer details (default: false) --completed show completed data transfers (default: false) --watch watch deal updates in real-time, rather than a one time list (default: false) --show-failed show failed/cancelled transfers (default: false) --help, -h show help ``` ### lotus client restart-transfer ``` NAME: lotus client restart-transfer - Force restart a stalled data transfer USAGE: lotus client restart-transfer [command options] [transferID] CATEGORY: UTIL OPTIONS: --peerid value narrow to transfer with specific peer --initiator specify only transfers where peer is/is not initiator (default: true) --help, -h show help ``` ### lotus client cancel-transfer ``` NAME: lotus client cancel-transfer - Force cancel a data transfer USAGE: lotus client cancel-transfer [command options] [transferID] CATEGORY: UTIL OPTIONS: --peerid value narrow to transfer with specific peer --initiator specify only transfers where peer is/is not initiator (default: true) --cancel-timeout value time to wait for cancel to be sent to storage provider (default: 5s) --help, -h show help ``` ## lotus msig ``` NAME: lotus msig - Interact with a multisig wallet USAGE: lotus msig command [command options] [arguments...] COMMANDS: create Create a new multisig wallet inspect Inspect a multisig wallet propose Propose a multisig transaction propose-remove Propose to remove a signer approve Approve a multisig message cancel Cancel a multisig message add-propose Propose to add a signer add-approve Approve a message to add a signer add-cancel Cancel a message to add a signer swap-propose Propose to swap signers swap-approve Approve a message to swap signers swap-cancel Cancel a message to swap signers lock-propose Propose to lock up some balance lock-approve Approve a message to lock up some balance lock-cancel Cancel a message to lock up some balance vested Gets the amount vested in an msig between two epochs propose-threshold Propose setting a different signing threshold on the account help, h Shows a list of commands or help for one command OPTIONS: --confidence value number of block confirmations to wait for (default: 5) --help, -h show help ``` ### lotus msig create ``` NAME: lotus msig create - Create a new multisig wallet USAGE: lotus msig create [command options] [address1 address2 ...] OPTIONS: --required value number of required approvals (uses number of signers provided if omitted) (default: 0) --value value initial funds to give to multisig (default: "0") --duration value length of the period over which funds unlock (default: "0") --from value account to send the create message from --help, -h show help ``` ### lotus msig inspect ``` NAME: lotus msig inspect - Inspect a multisig wallet USAGE: lotus msig inspect [command options] [address] OPTIONS: --vesting Include vesting details (default: false) --decode-params Decode parameters of transaction proposals (default: false) --help, -h show help ``` ### lotus msig propose ``` NAME: lotus msig propose - Propose a multisig transaction USAGE: lotus msig propose [command options] [multisigAddress destinationAddress value (optional)] OPTIONS: --from value account to send the propose message from --help, -h show help ``` ### lotus msig propose-remove ``` NAME: lotus msig propose-remove - Propose to remove a signer USAGE: lotus msig propose-remove [command options] [multisigAddress signer] OPTIONS: --decrease-threshold whether the number of required signers should be decreased (default: false) --from value account to send the propose message from --help, -h show help ``` ### lotus msig approve ``` NAME: lotus msig approve - Approve a multisig message USAGE: lotus msig approve [command options] [proposerAddress destination value [methodId methodParams]] OPTIONS: --from value account to send the approve message from --help, -h show help ``` ### lotus msig cancel ``` NAME: lotus msig cancel - Cancel a multisig message USAGE: lotus msig cancel [command options] [destination value [methodId methodParams]] OPTIONS: --from value account to send the cancel message from --help, -h show help ``` ### lotus msig add-propose ``` NAME: lotus msig add-propose - Propose to add a signer USAGE: lotus msig add-propose [command options] [multisigAddress signer] OPTIONS: --increase-threshold whether the number of required signers should be increased (default: false) --from value account to send the propose message from --help, -h show help ``` ### lotus msig add-approve ``` NAME: lotus msig add-approve - Approve a message to add a signer USAGE: lotus msig add-approve [command options] [multisigAddress proposerAddress txId newAddress increaseThreshold] OPTIONS: --from value account to send the approve message from --help, -h show help ``` ### lotus msig add-cancel ``` NAME: lotus msig add-cancel - Cancel a message to add a signer USAGE: lotus msig add-cancel [command options] [multisigAddress txId newAddress increaseThreshold] OPTIONS: --from value account to send the approve message from --help, -h show help ``` ### lotus msig swap-propose ``` NAME: lotus msig swap-propose - Propose to swap signers USAGE: lotus msig swap-propose [command options] [multisigAddress oldAddress newAddress] OPTIONS: --from value account to send the approve message from --help, -h show help ``` ### lotus msig swap-approve ``` NAME: lotus msig swap-approve - Approve a message to swap signers USAGE: lotus msig swap-approve [command options] [multisigAddress proposerAddress txId oldAddress newAddress] OPTIONS: --from value account to send the approve message from --help, -h show help ``` ### lotus msig swap-cancel ``` NAME: lotus msig swap-cancel - Cancel a message to swap signers USAGE: lotus msig swap-cancel [command options] [multisigAddress txId oldAddress newAddress] OPTIONS: --from value account to send the approve message from --help, -h show help ``` ### lotus msig lock-propose ``` NAME: lotus msig lock-propose - Propose to lock up some balance USAGE: lotus msig lock-propose [command options] [multisigAddress startEpoch unlockDuration amount] OPTIONS: --from value account to send the propose message from --help, -h show help ``` ### lotus msig lock-approve ``` NAME: lotus msig lock-approve - Approve a message to lock up some balance USAGE: lotus msig lock-approve [command options] [multisigAddress proposerAddress txId startEpoch unlockDuration amount] OPTIONS: --from value account to send the approve message from --help, -h show help ``` ### lotus msig lock-cancel ``` NAME: lotus msig lock-cancel - Cancel a message to lock up some balance USAGE: lotus msig lock-cancel [command options] [multisigAddress txId startEpoch unlockDuration amount] OPTIONS: --from value account to send the cancel message from --help, -h show help ``` ### lotus msig vested ``` NAME: lotus msig vested - Gets the amount vested in an msig between two epochs USAGE: lotus msig vested [command options] [multisigAddress] OPTIONS: --start-epoch value start epoch to measure vesting from (default: 0) --end-epoch value end epoch to stop measure vesting at (default: -1) --help, -h show help ``` ### lotus msig propose-threshold ``` NAME: lotus msig propose-threshold - Propose setting a different signing threshold on the account USAGE: lotus msig propose-threshold [command options] OPTIONS: --from value account to send the proposal from --help, -h show help ``` ## lotus filplus ``` NAME: lotus filplus - Interact with the verified registry actor used by Filplus USAGE: lotus filplus command [command options] [arguments...] COMMANDS: grant-datacap give allowance to the specified verified client address list-notaries list all notaries list-clients list all verified clients check-client-datacap check verified client remaining bytes check-notary-datacap check a notary's remaining bytes sign-remove-data-cap-proposal allows a notary to sign a Remove Data Cap Proposal list-allocations List allocations available in verified registry actor or made by a client if specified list-claims List claims available in verified registry actor or made by provider if specified remove-expired-allocations remove expired allocations (if no allocations are specified all eligible allocations are removed) remove-expired-claims remove expired claims (if no claims are specified all eligible claims are removed) help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` ### lotus filplus grant-datacap ``` NAME: lotus filplus grant-datacap - give allowance to the specified verified client address USAGE: lotus filplus grant-datacap [command options] [clientAddress datacap] OPTIONS: --from value specify your notary address to send the message from --help, -h show help ``` ### lotus filplus list-notaries ``` NAME: lotus filplus list-notaries - list all notaries USAGE: lotus filplus list-notaries [command options] [arguments...] OPTIONS: --help, -h show help ``` ### lotus filplus list-clients ``` NAME: lotus filplus list-clients - list all verified clients USAGE: lotus filplus list-clients [command options] [arguments...] OPTIONS: --help, -h show help ``` ### lotus filplus check-client-datacap ``` NAME: lotus filplus check-client-datacap - check verified client remaining bytes USAGE: lotus filplus check-client-datacap [command options] clientAddress OPTIONS: --help, -h show help ``` ### lotus filplus check-notary-datacap ``` NAME: lotus filplus check-notary-datacap - check a notary's remaining bytes USAGE: lotus filplus check-notary-datacap [command options] notaryAddress OPTIONS: --help, -h show help ``` ### lotus filplus sign-remove-data-cap-proposal ``` NAME: lotus filplus sign-remove-data-cap-proposal - allows a notary to sign a Remove Data Cap Proposal USAGE: lotus filplus sign-remove-data-cap-proposal [command options] [verifierAddress clientAddress allowanceToRemove] OPTIONS: --id value specify the RemoveDataCapProposal ID (will look up on chain if unspecified) (default: 0) --help, -h show help ``` ### lotus filplus list-allocations ``` NAME: lotus filplus list-allocations - List allocations available in verified registry actor or made by a client if specified USAGE: lotus filplus list-allocations [command options] clientAddress OPTIONS: --expired list only expired allocations (default: false) --json output results in json format (default: false) --help, -h show help ``` ### lotus filplus list-claims ``` NAME: lotus filplus list-claims - List claims available in verified registry actor or made by provider if specified USAGE: lotus filplus list-claims [command options] providerAddress OPTIONS: --expired list only expired claims (default: false) --help, -h show help ``` ### lotus filplus remove-expired-allocations ``` NAME: lotus filplus remove-expired-allocations - remove expired allocations (if no allocations are specified all eligible allocations are removed) USAGE: lotus filplus remove-expired-allocations [command options] clientAddress Optional[...allocationId] OPTIONS: --from value optionally specify the account to send the message from --help, -h show help ``` ### lotus filplus remove-expired-claims ``` NAME: lotus filplus remove-expired-claims - remove expired claims (if no claims are specified all eligible claims are removed) USAGE: lotus filplus remove-expired-claims [command options] providerAddress Optional[...claimId] OPTIONS: --from value optionally specify the account to send the message from --help, -h show help ``` ## lotus paych ``` NAME: lotus paych - Manage payment channels USAGE: lotus paych command [command options] [arguments...] COMMANDS: add-funds Add funds to the payment channel between fromAddress and toAddress. Creates the payment channel if it doesn't already exist. list List all locally registered payment channels voucher Interact with payment channel vouchers settle Settle a payment channel status Show the status of an outbound payment channel status-by-from-to Show the status of an active outbound payment channel by from/to addresses collect Collect funds for a payment channel help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` ### lotus paych add-funds ``` NAME: lotus paych add-funds - Add funds to the payment channel between fromAddress and toAddress. Creates the payment channel if it doesn't already exist. USAGE: lotus paych add-funds [command options] [fromAddress toAddress amount] OPTIONS: --restart-retrievals restart stalled retrieval deals on this payment channel (default: true) --reserve mark funds as reserved (default: false) --help, -h show help ``` ### lotus paych list ``` NAME: lotus paych list - List all locally registered payment channels USAGE: lotus paych list [command options] [arguments...] OPTIONS: --help, -h show help ``` ### lotus paych voucher ``` NAME: lotus paych voucher - Interact with payment channel vouchers USAGE: lotus paych voucher command [command options] [arguments...] COMMANDS: create Create a signed payment channel voucher check Check validity of payment channel voucher add Add payment channel voucher to local datastore list List stored vouchers for a given payment channel best-spendable Print vouchers with highest value that is currently spendable for each lane submit Submit voucher to chain to update payment channel state help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` #### lotus paych voucher create ``` NAME: lotus paych voucher create - Create a signed payment channel voucher USAGE: lotus paych voucher create [command options] [channelAddress amount] OPTIONS: --lane value specify payment channel lane to use (default: 0) --help, -h show help ``` #### lotus paych voucher check ``` NAME: lotus paych voucher check - Check validity of payment channel voucher USAGE: lotus paych voucher check [command options] [channelAddress voucher] OPTIONS: --help, -h show help ``` #### lotus paych voucher add ``` NAME: lotus paych voucher add - Add payment channel voucher to local datastore USAGE: lotus paych voucher add [command options] [channelAddress voucher] OPTIONS: --help, -h show help ``` #### lotus paych voucher list ``` NAME: lotus paych voucher list - List stored vouchers for a given payment channel USAGE: lotus paych voucher list [command options] [channelAddress] OPTIONS: --export Print voucher as serialized string (default: false) --help, -h show help ``` #### lotus paych voucher best-spendable ``` NAME: lotus paych voucher best-spendable - Print vouchers with highest value that is currently spendable for each lane USAGE: lotus paych voucher best-spendable [command options] [channelAddress] OPTIONS: --export Print voucher as serialized string (default: false) --help, -h show help ``` #### lotus paych voucher submit ``` NAME: lotus paych voucher submit - Submit voucher to chain to update payment channel state USAGE: lotus paych voucher submit [command options] [channelAddress voucher] OPTIONS: --help, -h show help ``` ### lotus paych settle ``` NAME: lotus paych settle - Settle a payment channel USAGE: lotus paych settle [command options] [channelAddress] OPTIONS: --help, -h show help ``` ### lotus paych status ``` NAME: lotus paych status - Show the status of an outbound payment channel USAGE: lotus paych status [command options] [channelAddress] OPTIONS: --help, -h show help ``` ### lotus paych status-by-from-to ``` NAME: lotus paych status-by-from-to - Show the status of an active outbound payment channel by from/to addresses USAGE: lotus paych status-by-from-to [command options] [fromAddress toAddress] OPTIONS: --help, -h show help ``` ### lotus paych collect ``` NAME: lotus paych collect - Collect funds for a payment channel USAGE: lotus paych collect [command options] [channelAddress] OPTIONS: --help, -h show help ``` ## lotus auth ``` NAME: lotus auth - Manage RPC permissions USAGE: lotus auth command [command options] [arguments...] COMMANDS: 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 OPTIONS: --help, -h show help ``` ### lotus auth create-token ``` NAME: lotus auth create-token - Create token USAGE: lotus auth create-token [command options] [arguments...] OPTIONS: --perm value permission to assign to the token, one of: read, write, sign, admin --help, -h show help ``` ### lotus auth api-info ``` NAME: lotus auth api-info - Get token with API info required to connect to this node USAGE: lotus auth api-info [command options] [arguments...] OPTIONS: --perm value permission to assign to the token, one of: read, write, sign, admin --help, -h show help ``` ## lotus mpool ``` NAME: lotus mpool - Manage message pool USAGE: lotus mpool command [command options] [arguments...] COMMANDS: pending Get pending messages sub Subscribe to mpool changes stat print mempool stats replace replace a message in the mempool find find a message in the mempool config get or set current mpool configuration gas-perf Check gas performance of messages in mempool manage help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` ### lotus mpool pending ``` NAME: lotus mpool pending - Get pending messages USAGE: lotus mpool pending [command options] [arguments...] OPTIONS: --local print pending messages for addresses in local wallet only (default: false) --cids only print cids of messages in output (default: false) --to value return messages to a given address --from value return messages from a given address --help, -h show help ``` ### lotus mpool sub ``` NAME: lotus mpool sub - Subscribe to mpool changes USAGE: lotus mpool sub [command options] [arguments...] OPTIONS: --help, -h show help ``` ### lotus mpool stat ``` NAME: lotus mpool stat - print mempool stats USAGE: lotus mpool stat [command options] [arguments...] OPTIONS: --local print stats for addresses in local wallet only (default: false) --basefee-lookback value number of blocks to look back for minimum basefee (default: 60) --help, -h show help ``` ### lotus mpool replace ``` NAME: lotus mpool replace - replace a message in the mempool USAGE: lotus mpool replace [command options] | OPTIONS: --gas-feecap value gas feecap for new message (burn and pay to miner, attoFIL/GasUnit) --gas-premium value gas price for new message (pay to miner, attoFIL/GasUnit) --gas-limit value gas limit for new message (GasUnit) (default: 0) --auto automatically reprice the specified message (default: false) --fee-limit max-fee Spend up to X FIL for this message in units of FIL. Previously when flag was max-fee units were in attoFIL. Applicable for auto mode --help, -h show help ``` ### lotus mpool find ``` NAME: lotus mpool find - find a message in the mempool USAGE: lotus mpool find [command options] [arguments...] OPTIONS: --from value search for messages with given 'from' address --to value search for messages with given 'to' address --method value search for messages with given method (default: 0) --help, -h show help ``` ### lotus mpool config ``` NAME: lotus mpool config - get or set current mpool configuration USAGE: lotus mpool config [command options] [new-config] OPTIONS: --help, -h show help ``` ### lotus mpool gas-perf ``` NAME: lotus mpool gas-perf - Check gas performance of messages in mempool USAGE: lotus mpool gas-perf [command options] [arguments...] OPTIONS: --all print gas performance for all mempool messages (default only prints for local) (default: false) --help, -h show help ``` ### lotus mpool manage ``` NAME: lotus mpool manage USAGE: lotus mpool manage [command options] [arguments...] OPTIONS: --help, -h show help ``` ## lotus state ``` NAME: lotus state - Interact with and query filecoin chain state USAGE: lotus state command [command options] [arguments...] COMMANDS: power Query network or miner power sectors Query the sector set of a miner active-sectors Query the active sector set of a miner list-actors list all actors in the network list-miners list all miners in the network circulating-supply Get the exact current circulating supply of Filecoin sector, sector-info Get miner sector info get-actor Print actor information lookup Find corresponding ID address replay Replay a particular message sector-size Look up miners sector size read-state View a json representation of an actors state list-messages list messages on chain matching given criteria compute-state Perform state computations call Invoke a method on an actor locally get-deal View on-chain deal info wait-msg, wait-message Wait for a message to appear on chain search-msg, search-message Search to see whether a message has appeared on chain miner-info Retrieve miner information market Inspect the storage market actor exec-trace Get the execution trace of a given message network-version Returns the network version miner-proving-deadline Retrieve information about a given miner's proving deadline actor-cids Returns the built-in actor bundle manifest ID & system actor cids help, h Shows a list of commands or help for one command OPTIONS: --tipset value specify tipset to call method on (pass comma separated array of cids) --help, -h show help ``` ### lotus state power ``` NAME: lotus state power - Query network or miner power USAGE: lotus state power [command options] [ (optional)] OPTIONS: --help, -h show help ``` ### lotus state sectors ``` NAME: lotus state sectors - Query the sector set of a miner USAGE: lotus state sectors [command options] [minerAddress] OPTIONS: --help, -h show help ``` ### lotus state active-sectors ``` NAME: lotus state active-sectors - Query the active sector set of a miner USAGE: lotus state active-sectors [command options] [minerAddress] OPTIONS: --help, -h show help ``` ### lotus state list-actors ``` NAME: lotus state list-actors - list all actors in the network USAGE: lotus state list-actors [command options] [arguments...] OPTIONS: --help, -h show help ``` ### lotus state list-miners ``` NAME: lotus state list-miners - list all miners in the network USAGE: lotus state list-miners [command options] [arguments...] OPTIONS: --sort-by value criteria to sort miners by (none, num-deals) --help, -h show help ``` ### lotus state circulating-supply ``` NAME: lotus state circulating-supply - Get the exact current circulating supply of Filecoin USAGE: lotus state circulating-supply [command options] [arguments...] OPTIONS: --vm-supply calculates the approximation of the circulating supply used internally by the VM (instead of the exact amount) (default: false) --help, -h show help ``` ### lotus state sector ``` NAME: lotus state sector - Get miner sector info USAGE: lotus state sector [command options] [minerAddress] [sectorNumber] OPTIONS: --help, -h show help ``` ### lotus state get-actor ``` NAME: lotus state get-actor - Print actor information USAGE: lotus state get-actor [command options] [actorAddress] OPTIONS: --help, -h show help ``` ### lotus state lookup ``` NAME: lotus state lookup - Find corresponding ID address USAGE: lotus state lookup [command options] [address] OPTIONS: --reverse, -r Perform reverse lookup (default: false) --help, -h show help ``` ### lotus state replay ``` NAME: lotus state replay - Replay a particular message USAGE: lotus state replay [command options] OPTIONS: --show-trace print out full execution trace for given message (default: false) --detailed-gas print out detailed gas costs for given message (default: false) --help, -h show help ``` ### lotus state sector-size ``` NAME: lotus state sector-size - Look up miners sector size USAGE: lotus state sector-size [command options] [minerAddress] OPTIONS: --help, -h show help ``` ### lotus state read-state ``` NAME: lotus state read-state - View a json representation of an actors state USAGE: lotus state read-state [command options] [actorAddress] OPTIONS: --help, -h show help ``` ### lotus state list-messages ``` NAME: lotus state list-messages - list messages on chain matching given criteria USAGE: lotus state list-messages [command options] [arguments...] OPTIONS: --to value return messages to a given address --from value return messages from a given address --toheight value don't look before given block height (default: 0) --cids print message CIDs instead of messages (default: false) --help, -h show help ``` ### lotus state compute-state ``` NAME: lotus state compute-state - Perform state computations USAGE: lotus state compute-state [command options] [arguments...] OPTIONS: --vm-height value set the height that the vm will see (default: 0) --apply-mpool-messages apply messages from the mempool to the computed state (default: false) --show-trace print out full execution trace for given tipset (default: false) --html generate html report (default: false) --json generate json output (default: false) --compute-state-output value a json file containing pre-existing compute-state output, to generate html reports without rerunning state changes --no-timing don't show timing information in html traces (default: false) --help, -h show help ``` ### lotus state call ``` NAME: lotus state call - Invoke a method on an actor locally USAGE: lotus state call [command options] [toAddress methodId params (optional)] OPTIONS: --from value (default: "f00") --value value specify value field for invocation (default: "0") --ret value specify how to parse output (raw, decoded, base64, hex) (default: "decoded") --encoding value specify params encoding to parse (base64, hex) (default: "base64") --help, -h show help ``` ### lotus state get-deal ``` NAME: lotus state get-deal - View on-chain deal info USAGE: lotus state get-deal [command options] [dealId] OPTIONS: --help, -h show help ``` ### lotus state wait-msg ``` NAME: lotus state wait-msg - Wait for a message to appear on chain USAGE: lotus state wait-msg [command options] [messageCid] OPTIONS: --timeout value (default: "10m") --help, -h show help ``` ### lotus state search-msg ``` NAME: lotus state search-msg - Search to see whether a message has appeared on chain USAGE: lotus state search-msg [command options] [messageCid] OPTIONS: --help, -h show help ``` ### lotus state miner-info ``` NAME: lotus state miner-info - Retrieve miner information USAGE: lotus state miner-info [command options] [minerAddress] OPTIONS: --help, -h show help ``` ### lotus state market ``` NAME: lotus state market - Inspect the storage market actor USAGE: lotus state market command [command options] [arguments...] COMMANDS: balance Get the market balance (locked and escrowed) for a given account help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` #### lotus state market balance ``` NAME: lotus state market balance - Get the market balance (locked and escrowed) for a given account USAGE: lotus state market balance [command options] [address] OPTIONS: --help, -h show help ``` ### lotus state exec-trace ``` NAME: lotus state exec-trace - Get the execution trace of a given message USAGE: lotus state exec-trace [command options] OPTIONS: --help, -h show help ``` ### lotus state network-version ``` NAME: lotus state network-version - Returns the network version USAGE: lotus state network-version [command options] [arguments...] OPTIONS: --help, -h show help ``` ### lotus state miner-proving-deadline ``` NAME: lotus state miner-proving-deadline - Retrieve information about a given miner's proving deadline USAGE: lotus state miner-proving-deadline [command options] [minerAddress] OPTIONS: --help, -h show help ``` ### lotus state actor-cids ``` NAME: lotus state actor-cids - Returns the built-in actor bundle manifest ID & system actor cids USAGE: lotus state actor-cids [command options] [arguments...] OPTIONS: --network-version value specify network version (default: 0) --help, -h show help ``` ## lotus chain ``` NAME: lotus chain - Interact with filecoin blockchain USAGE: lotus chain command [command options] [arguments...] COMMANDS: head Print chain head get-block, getblock Get a block and print its details read-obj Read the raw bytes of an object delete-obj Delete an object from the chain blockstore stat-obj Collect size and ipld link counts for objs getmessage, get-message, get-msg Get and print a message by its cid sethead, set-head manually set the local nodes head tipset (Caution: normally only used for recovery) list, love View a segment of the chain get Get chain DAG node by path bisect bisect chain for an event export export chain to a car file export-range export chain to a car file slash-consensus Report consensus fault gas-price Estimate gas prices inspect-usage Inspect block space usage of a given tipset decode decode various types encode encode various types disputer interact with the window post disputer prune splitstore gc help, h Shows a list of commands or help for one command OPTIONS: --help, -h show help ``` ### lotus chain head ``` NAME: lotus chain head - Print chain head USAGE: lotus chain head [command options] [arguments...] OPTIONS: --help, -h show help ``` ### lotus chain get-block ``` NAME: lotus chain get-block - Get a block and print its details USAGE: lotus chain get-block [command options] [blockCid] OPTIONS: --raw print just the raw block header (default: false) --help, -h show help ``` ### lotus chain read-obj ``` NAME: lotus chain read-obj - Read the raw bytes of an object USAGE: lotus chain read-obj [command options] [objectCid] OPTIONS: --help, -h show help ``` ### lotus chain delete-obj ``` NAME: lotus chain delete-obj - Delete an object from the chain blockstore USAGE: lotus chain delete-obj [command options] [objectCid] DESCRIPTION: WARNING: Removing wrong objects from the chain blockstore may lead to sync issues OPTIONS: --really-do-it (default: false) --help, -h show help ``` ### lotus chain stat-obj ``` NAME: lotus chain stat-obj - Collect size and ipld link counts for objs USAGE: lotus chain stat-obj [command options] [cid] DESCRIPTION: Collect object size and ipld link count for an object. When a base is provided it will be walked first, and all links visisted will be ignored when the passed in object is walked. OPTIONS: --base value ignore links found in this obj --help, -h show help ``` ### lotus chain getmessage ``` NAME: lotus chain getmessage - Get and print a message by its cid USAGE: lotus chain getmessage [command options] [messageCid] OPTIONS: --help, -h show help ``` ### lotus chain sethead ``` NAME: lotus chain sethead - manually set the local nodes head tipset (Caution: normally only used for recovery) USAGE: lotus chain sethead [command options] [tipsetkey] OPTIONS: --genesis reset head to genesis (default: false) --epoch value reset head to given epoch (default: 0) --help, -h show help ``` ### lotus chain list ``` NAME: lotus chain list - View a segment of the chain USAGE: lotus chain list [command options] [arguments...] OPTIONS: --height value (default: current head) --count value (default: 30) --format value specify the format to print out tipsets (default: ": (