From 0c96ecdeca9368b92fa06648b63d1485c2961c9f Mon Sep 17 00:00:00 2001 From: Laurent Senta Date: Tue, 9 Jul 2024 10:13:09 +0200 Subject: [PATCH 01/13] feat: use a version data for go and lotus --- content/en/lotus/install/linux.md | 15 +++++++-------- .../en/tutorials/lotus-miner/supra-seal-pc2.md | 4 ++-- .../tutorials/lotus/store-and-retrieve/set-up.md | 6 +++--- data/version.json | 4 ++++ layouts/shortcodes/version.html | 3 +++ 5 files changed, 19 insertions(+), 13 deletions(-) create mode 100644 data/version.json create mode 100644 layouts/shortcodes/version.html diff --git a/content/en/lotus/install/linux.md b/content/en/lotus/install/linux.md index 808f2583..467b8519 100644 --- a/content/en/lotus/install/linux.md +++ b/content/en/lotus/install/linux.md @@ -55,23 +55,22 @@ Amazon Linux 2: sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm; sudo yum install -y hwloc-devel ``` - 1. Download the latest Linux bundle from the [Lotus GitHub releases page](https://github.com/filecoin-project/lotus/releases/latest): ```shell - wget https://github.com/filecoin-project/lotus/releases/download/v1.28.1/lotus_v1.28.1_linux_amd64.tar.gz + wget https://github.com/filecoin-project/lotus/releases/download/v{{< version >}}/lotus_v{{< version >}}_linux_amd64.tar.gz ``` -1. Extract tar -xvf archive.tar.gz executable: +2. Extract tar -xvf archive.tar.gz executable: ```shell - tar -xvf lotus_v1.28.1_linux_amd64.tar.gz + tar -xvf lotus_v{{< version >}}_linux_amd64.tar.gz ``` -1. Move the `lotus` binary to `/usr/local/bin`: +3. Move the `lotus` binary to `/usr/local/bin`: ```shell - sudo mv lotus_1.28.1_linux_amd64/lotus /usr/local/bin/lotus + sudo mv lotus_{{< version >}}_linux_amd64/lotus /usr/local/bin/lotus ``` ## Building from source @@ -126,10 +125,10 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ### Go -To build Lotus, you need a working installation of [Go 1.21.7 or higher](https://golang.org/dl/): +To build Lotus, you need a working installation of [Go {{< version "go" >}} or higher](https://golang.org/dl/): ```shell -wget -c https://golang.org/dl/go1.21.7.linux-amd64.tar.gz -O - | sudo tar -xz -C /usr/local +wget -c https://golang.org/dl/go{{< version "go" >}}.linux-amd64.tar.gz -O - | sudo tar -xz -C /usr/local ``` {{< alert icon="tip">}} diff --git a/content/en/tutorials/lotus-miner/supra-seal-pc2.md b/content/en/tutorials/lotus-miner/supra-seal-pc2.md index b6e6de7c..0ae59821 100644 --- a/content/en/tutorials/lotus-miner/supra-seal-pc2.md +++ b/content/en/tutorials/lotus-miner/supra-seal-pc2.md @@ -42,7 +42,7 @@ Please note that the `FFI_USE_FIXED_ROWS_TO_DISCARD=1` environment variable must sudo apt install build-essential libconfig++-dev libgmp-dev wget git curl ``` -2. Checkout [Lotus v1.28.1](https://github.com/filecoin-project/lotus/releases/tag/v1.28.1). +2. Checkout [Lotus v{{< version >}}](https://github.com/filecoin-project/lotus/releases/tag/v{{< version >}}). 3. [Build from source]({{< relref "../../lotus/install/linux/#native-filecoin-ffi" >}}) with the environment variable `FFI_USE_FIXED_ROWS_TO_DISCARD=1` exported. **Please note that you also need to export and build with this enviroment variable across the lotus-miner stack of machines. Else the SupraSeal PC2 will fail!** @@ -123,4 +123,4 @@ In the `--external-pc2` flag, the parameters are as follows: - `-o "${EXTSEAL_PC2_CACHE}"`: This is the output directory for the cache. It also uses the `EXTSEAL_PC2_CACHE` environment variable. - `-d "${EXTSEAL_PC2_UNSEALED}"`: This is the directory for the unsealed sectors. It uses the `EXTSEAL_PC2_UNSEALED` environment variable. - `rm -f "${EXTSEAL_PC2_SEALED}"`: This command removes the existing sealed file if it exists. -- `mv "${EXTSEAL_PC2_CACHE}/sealed-file" "${EXTSEAL_PC2_SEALED}"`: This command moves the newly sealed file to the sealed directory. \ No newline at end of file +- `mv "${EXTSEAL_PC2_CACHE}/sealed-file" "${EXTSEAL_PC2_SEALED}"`: This command moves the newly sealed file to the sealed directory. diff --git a/content/en/tutorials/lotus/store-and-retrieve/set-up.md b/content/en/tutorials/lotus/store-and-retrieve/set-up.md index 4fb82803..da1595b0 100644 --- a/content/en/tutorials/lotus/store-and-retrieve/set-up.md +++ b/content/en/tutorials/lotus/store-and-retrieve/set-up.md @@ -215,19 +215,19 @@ sudo yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7. 1. Download the latest Linux bundle from the [Lotus GitHub releases page](https://github.com/filecoin-project/lotus/releases/latest): ```shell - wget https://github.com/filecoin-project/lotus/releases/download/v1.28.1/lotus_v1.28.1_linux_amd64.tar.gz + wget https://github.com/filecoin-project/lotus/releases/download/v{{< version >}}/lotus_v{{< version >}}_linux_amd64.tar.gz ``` 1. Extract tar -xvf archive.tar.gz executable: ```shell - tar -xvf lotus_1.28.1_linux_amd64.tar.gz + tar -xvf lotus_{{< version >}}_linux_amd64.tar.gz ``` 1. Move the `lotus` binary to `/usr/local/bin`: ```shell - sudo mv lotus_1.28.1_linux_amd64/lotus /usr/local/bin/lotus + sudo mv lotus_{{< version >}}_linux_amd64/lotus /usr/local/bin/lotus ``` [Head onto the next section to run your Lotus lite-node ↓](#run-a-lotus-lite-node) diff --git a/data/version.json b/data/version.json new file mode 100644 index 00000000..eff1be32 --- /dev/null +++ b/data/version.json @@ -0,0 +1,4 @@ +{ + "lotus": "1.27.1", + "go": "1.21.7" +} diff --git a/layouts/shortcodes/version.html b/layouts/shortcodes/version.html new file mode 100644 index 00000000..345924b2 --- /dev/null +++ b/layouts/shortcodes/version.html @@ -0,0 +1,3 @@ +{{ $param := .Get 0 | default "lotus" -}} +{{- $version := index .Site.Data.version $param -}} +{{- $version -}} From c885607a952e3942c85951fb0af7eac4ddc5c970 Mon Sep 17 00:00:00 2001 From: Laurent Senta Date: Tue, 9 Jul 2024 10:25:11 +0200 Subject: [PATCH 02/13] feat: pull cli content from API --- content/en/lotus/manage/lotus-cli.md | 2740 +---------------- .../operate/lotus-miner-cli.md | 1427 +-------- layouts/shortcodes/remote-markdown.html | 8 + 3 files changed, 12 insertions(+), 4163 deletions(-) create mode 100644 layouts/shortcodes/remote-markdown.html diff --git a/content/en/lotus/manage/lotus-cli.md b/content/en/lotus/manage/lotus-cli.md index b04737a7..50b5644a 100644 --- a/content/en/lotus/manage/lotus-cli.md +++ b/content/en/lotus/manage/lotus-cli.md @@ -1,7 +1,7 @@ --- title: "Lotus CLI" description: "Reference documentation for the Lotus command-line interface." -lead: "Reference documentation for the Lotus command-line interface. This documentation was automatically generated using Lotus v1.28.1." +lead: "Reference documentation for the Lotus command-line interface. This documentation was automatically generated using Lotus latest release." draft: false menu: lotus: @@ -12,2740 +12,4 @@ weight: 445 toc: true --- - - -# lotus -``` -NAME: - lotus - Filecoin decentralized storage network client - -USAGE: - lotus [global options] command [command options] [arguments...] - -VERSION: - 1.28.1 - -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 - 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 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) - extend-claim extends claim expiration (TermMax) - 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) - --json output results in json format (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 filplus extend-claim -``` -NAME: - lotus filplus extend-claim - extends claim expiration (TermMax) - -USAGE: - Extends claim expiration (TermMax). - If the client is original client then claim can be extended to maximum 5 years and no Datacap is required. - If the client id different then claim can be extended up to maximum 5 years from now and Datacap is required. - - -OPTIONS: - --term-max value, --tmax value The maximum period for which a provider can earn quality-adjusted power for the piece (epochs). Default is 5 years. (default: 5256000) - --client value the client address that will used to send the message - --all automatically extend TermMax of all claims for specified miner[s] to --term-max (default: 5 years from claim start epoch) (default: false) - --miner value, -m value, --provider value, -p value [ --miner value, -m value, --provider value, -p value ] storage provider address[es] - --assume-yes, -y, --yes automatic yes to prompts; assume 'yes' as answer to all prompts and run non-interactively (default: false) - --confidence value number of block confirmations to wait for (default: 5) - --batch-size value number of extend requests per batch. If set incorrectly, this will lead to out of gas error (default: 500) - --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: - --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: ": (