From eaeaf9e6ba21c28f057fbe18c7fbd98bd4fa31af Mon Sep 17 00:00:00 2001 From: dayou5168 <1368615390@qq.com> Date: Fri, 10 Sep 2021 17:36:38 +0800 Subject: [PATCH 1/4] Add documentation for the new version 1.11.2 features --- docs/mine/lotus/message-pool.md | 5 +++- docs/mine/lotus/miner-addresses.md | 5 ++++ docs/mine/lotus/miner-configuration.md | 17 +++++++++++ docs/mine/lotus/sector-pledging.md | 40 +++++++++++++++++++++++++ docs/mine/lotus/split-markets-miners.md | 6 ++-- 5 files changed, 69 insertions(+), 4 deletions(-) diff --git a/docs/mine/lotus/message-pool.md b/docs/mine/lotus/message-pool.md index ead4eb652..2133309e8 100644 --- a/docs/mine/lotus/message-pool.md +++ b/docs/mine/lotus/message-pool.md @@ -69,7 +69,10 @@ You can replace messages in the pool by pushing a new message with the same `Non lotus mpool replace --auto ``` -The above command will replace the associated message in the pool and automatically reprice it with a new _GasPremium_ and _GasFeeCap_ as estimated from the current network conditions. You can also set `--max-fee` if you wish to limit the total amount to spend for the message. All other flags are ignored. +The above command will replace the associated message in the pool and automatically reprice it with a new _GasPremium_ and _GasFeeCap_ as estimated from the current network conditions. You can also set `--fee-limit` if you wish to limit the total amount to spend for the message. All other flags are ignored. +::: warning +There is an important difference between --fee-limit and the previous --max-fee, --fee-limit is in units of FIL with decimals support, Previously when flag was max-fee units were in attoFIL. +::: Alternatively, the _GasPremium_, _GasFeeCap_ can be set manually with their respective flags: diff --git a/docs/mine/lotus/miner-addresses.md b/docs/mine/lotus/miner-addresses.md index e4dd4051b..c986cd155 100644 --- a/docs/mine/lotus/miner-addresses.md +++ b/docs/mine/lotus/miner-addresses.md @@ -113,6 +113,11 @@ To set up a _control address_: Repeat this procedure to add additional addresses. +5. You can Specify other actor to check control address: +```sh +lotus-miner --actor f01000 actor control list +``` + ### Use control addresses for commits Clean up the tasks required for your worker address by setting your control addresses to perform pre-commits and commits. With this, only market messages are sent from the worker address. If the basefee is high, then you can still put sectors on chain without those messages being blocked by things like publishing deals. diff --git a/docs/mine/lotus/miner-configuration.md b/docs/mine/lotus/miner-configuration.md index ea11f9e8f..3809704ca 100644 --- a/docs/mine/lotus/miner-configuration.md +++ b/docs/mine/lotus/miner-configuration.md @@ -189,6 +189,13 @@ This section controls some of the behavior around sector sealing: MaxSealingSectors = 0 # Upper bound on how many sectors can be sealing at the same time when creating new sectors with deals (0 = unlimited) MaxSealingSectorsForDeals = 0 + # CommittedCapacitySectorLifetime is the duration a Committed Capacity (CC) sector will + # live before it must be extended or converted into sector containing deals before it is + # terminated. Value must be between 180-540 days inclusive + # + # type: Duration + CommittedCapacitySectorLifetime = "12960h0m0s" + # Period of time that a newly created sector will wait for more deals to be packed in to before it starts to seal. # Sectors which are fully filled will start sealing immediately WaitDealsDelay = "6h0m0s" @@ -347,6 +354,16 @@ Batch 1: 19 OK ``` +### CommittedCapacitySectorLifetime +The available units are as follows. + +> "ms": int64(Millisecond), + "s": int64(Second), + "m": int64(Minute), + "h": int64(Hour), + +For example if you want to set the sector lifecycle to 180 days, you can multiply 180 days by 24 hours per day to get 4320 hours and set this value to "4320h0m0s" + ## Storage section The storage sector controls whether the miner can perform certain sealing actions. Depending on the setup and the use of additional [seal workers](seal-workers.md), you may want to modify some of the options. diff --git a/docs/mine/lotus/sector-pledging.md b/docs/mine/lotus/sector-pledging.md index a0cf4a6d2..5145f7116 100644 --- a/docs/mine/lotus/sector-pledging.md +++ b/docs/mine/lotus/sector-pledging.md @@ -75,3 +75,43 @@ lotus-miner sectors mark-for-upgrade ``` The sector should become inactive within 24 hours after a new replacement sector has sealed. From that point, the pledged storage can be re-used for new sectors. + +## Inspect expiring sectors +First you can check the sectors that are about to expire. Sectors that will expire within 60 days can be checked by default with the following command. +```sh +lotus-miner sectors check-expire +``` +If you want to check for sectors that will expire within six months, add the --cutoff option, timing in epoch, here is an example: +```sh +lotus-miner sectors check-expire --cutoff 518400 +``` + +## Extend sectors +You can extend the lifecycle of a sector with the command. +```sh +lotus-miner sectors extend [command options] +``` +This is an example of extending the lifecycle of sectors sector-a and sector-b to 1555200 epoch. +```sh +lotus-miner sectors extend --new-expiration 1555200 +``` +In addition, you can also renew sectors,a more practical and flexible tool. +```sh +lotus-miner sectors renew [command options] [arguments...] +``` +This is an example of selecting sectors with a lifecycle between epochnumber-a epoch and epochnumber-b epoch and updating it to 1555200 epoch. +```sh +lotus-miner sectors renew --from --to --new-expiration 1555200 +``` +This is an example of updating the lifecycle of a sector read from a file to 1555200 epoch +```sh +lotus-miner sectors renew --sector-file --new-expiration 1555200 +``` +::: warning +You have to select the sector to renew. That means you have to specify the --from --to option, or specify the sector file, if no sector is selected this command will have no effect. +Format of sectorfile: + 1 + 2 + ...... +::: + diff --git a/docs/mine/lotus/split-markets-miners.md b/docs/mine/lotus/split-markets-miners.md index d20b6670b..565ea7282 100644 --- a/docs/mine/lotus/split-markets-miners.md +++ b/docs/mine/lotus/split-markets-miners.md @@ -487,10 +487,10 @@ lotus-miner actor set-addrs ```toml [Addresses] - \#PreCommitControl = ["f00XX1"] - \# CommitControl = ["f00XX2"] + PreCommitControl = ["f00XX1"] + CommitControl = ["f00XX2"] TerminateControl = [] - \# DealPublishControl = ["f00XX3"] + DealPublishControl = ["f00XX3"] DisableOwnerFallback = false DisableWorkerFallback = false ``` From 6ce9de9448201e9fbbddd6b33799b2b0be27d8d4 Mon Sep 17 00:00:00 2001 From: dayou5168 <1368615390@qq.com> Date: Wed, 22 Sep 2021 17:36:12 +0800 Subject: [PATCH 2/4] modify format with VSCode Markdownlint. and update some content --- docs/mine/lotus/message-pool.md | 5 ++- docs/mine/lotus/miner-addresses.md | 3 +- docs/mine/lotus/miner-configuration.md | 15 ++++--- docs/mine/lotus/sector-pledging.md | 57 ++++++++++++++++---------- 4 files changed, 49 insertions(+), 31 deletions(-) diff --git a/docs/mine/lotus/message-pool.md b/docs/mine/lotus/message-pool.md index 2133309e8..4f55890e3 100644 --- a/docs/mine/lotus/message-pool.md +++ b/docs/mine/lotus/message-pool.md @@ -69,9 +69,10 @@ You can replace messages in the pool by pushing a new message with the same `Non lotus mpool replace --auto ``` -The above command will replace the associated message in the pool and automatically reprice it with a new _GasPremium_ and _GasFeeCap_ as estimated from the current network conditions. You can also set `--fee-limit` if you wish to limit the total amount to spend for the message. All other flags are ignored. +The above command will replace the associated message in the pool and automatically reprice it with a new _GasPremium_ and _GasFeeCap_ as estimated from the current network conditions. You can also set `--fee-limit` if you wish to limit the total amount to spend for the message. All other flags are ignored. + ::: warning -There is an important difference between --fee-limit and the previous --max-fee, --fee-limit is in units of FIL with decimals support, Previously when flag was max-fee units were in attoFIL. +`--fee-limit` uses units of FIL with decimals support, whereas `--max-fee` uses `attoFIL`. ::: Alternatively, the _GasPremium_, _GasFeeCap_ can be set manually with their respective flags: diff --git a/docs/mine/lotus/miner-addresses.md b/docs/mine/lotus/miner-addresses.md index c986cd155..e27e74b5b 100644 --- a/docs/mine/lotus/miner-addresses.md +++ b/docs/mine/lotus/miner-addresses.md @@ -114,7 +114,8 @@ To set up a _control address_: Repeat this procedure to add additional addresses. 5. You can Specify other actor to check control address: -```sh + +```shell lotus-miner --actor f01000 actor control list ``` diff --git a/docs/mine/lotus/miner-configuration.md b/docs/mine/lotus/miner-configuration.md index 3809704ca..9f9f5894d 100644 --- a/docs/mine/lotus/miner-configuration.md +++ b/docs/mine/lotus/miner-configuration.md @@ -355,14 +355,17 @@ Batch 1: ``` ### CommittedCapacitySectorLifetime -The available units are as follows. -> "ms": int64(Millisecond), - "s": int64(Second), - "m": int64(Minute), - "h": int64(Hour), +The available units are: -For example if you want to set the sector lifecycle to 180 days, you can multiply 180 days by 24 hours per day to get 4320 hours and set this value to "4320h0m0s" +``` +"ms": int64(Millisecond), + "s": int64(Second), + "m": int64(Minute), + "h": int64(Hour), +``` + +For example if you want to set the sector lifecycle to 180 days, you can multiply 180 days by 24 hours per day to get 4320 hours and set this value to "4320h0m0s". ## Storage section diff --git a/docs/mine/lotus/sector-pledging.md b/docs/mine/lotus/sector-pledging.md index 5145f7116..c8826e278 100644 --- a/docs/mine/lotus/sector-pledging.md +++ b/docs/mine/lotus/sector-pledging.md @@ -77,41 +77,54 @@ lotus-miner sectors mark-for-upgrade The sector should become inactive within 24 hours after a new replacement sector has sealed. From that point, the pledged storage can be re-used for new sectors. ## Inspect expiring sectors -First you can check the sectors that are about to expire. Sectors that will expire within 60 days can be checked by default with the following command. -```sh + +First you can check the sectors that are about to expire. Sectors that will expire within 60 days can be checked by default with the following command: + +```shell lotus-miner sectors check-expire ``` -If you want to check for sectors that will expire within six months, add the --cutoff option, timing in epoch, here is an example: -```sh -lotus-miner sectors check-expire --cutoff 518400 + +If you want to check for sectors that will expire within 33 days (669600 epoch in devnet) , add the `--cutoff` option, timing in epoch, here is an example in devnet: + +```shell with-output +lotus-miner sectors check-expire --cutoff 669600 ``` -## Extend sectors -You can extend the lifecycle of a sector with the command. -```sh -lotus-miner sectors extend [command options] ``` -This is an example of extending the lifecycle of sectors sector-a and sector-b to 1555200 epoch. -```sh -lotus-miner sectors extend --new-expiration 1555200 +ID SealProof InitialPledge Activation Expiration MaxExpiration MaxExtendNow +5 5 59.605 nFIL 1519 (1 day 9 hours ago) 691857 (in 4 weeks 2 days) 5257519 (in 34 weeks 3 days) 1587303 (in 10 weeks 2 days) +10 5 59.605 nFIL 3588 (1 day 7 hours ago) 697617 (in 4 weeks 2 days) 5259588 (in 34 weeks 4 days) 1587303 (in 10 weeks 2 days) +11 5 59.605 nFIL 4695 (1 day 6 hours ago) 697617 (in 4 weeks 2 days) 5260695 (in 34 weeks 4 days) 1587303 (in 10 weeks 2 days) +15 5 59.605 nFIL 6891 (1 day 4 hours ago) 700497 (in 4 weeks 2 days) 5262891 (in 34 weeks 4 days) 1587303 (in 10 weeks 2 days) +17 5 59.605 nFIL 7004 (1 day 3 hours ago) 700497 (in 4 weeks 2 days) 5263004 (in 34 weeks 4 days) 1587303 (in 10 weeks 2 days) ``` -In addition, you can also renew sectors,a more practical and flexible tool. -```sh + +## Extend sectors + +You can extend the lifecycle of a sector with the command: + +```shell practical and flexible tool: + +```shell lotus-miner sectors renew [command options] [arguments...] ``` -This is an example of selecting sectors with a lifecycle between epochnumber-a epoch and epochnumber-b epoch and updating it to 1555200 epoch. -```sh + +This is an example of selecting sectors with a lifecycle between `epochnumber-a` epoch and `epochnumber-b` epoch and updating it to 1555200 epoch: + +```shell lotus-miner sectors renew --from --to --new-expiration 1555200 ``` -This is an example of updating the lifecycle of a sector read from a file to 1555200 epoch -```sh + +This is an example of updating the lifecycle of a sector read from a file to 1555200 epoch: + +```shell lotus-miner sectors renew --sector-file --new-expiration 1555200 ``` + ::: warning -You have to select the sector to renew. That means you have to specify the --from --to option, or specify the sector file, if no sector is selected this command will have no effect. -Format of sectorfile: +You have to select the sectors to renew. That means you have to specify the `--from` and `--to` option, or specify the sector file, if no sector is selected this command will have no effect. +Format of sectorfile: 1 2 - ...... + ... ::: - From 86f2bd6c6139d3614c19a3854ebccc46de8e7f52 Mon Sep 17 00:00:00 2001 From: Johnny <9611008+johnnymatthews@users.noreply.github.com> Date: Tue, 5 Oct 2021 11:27:20 -0400 Subject: [PATCH 3/4] Apply suggestions from code review --- docs/mine/lotus/miner-addresses.md | 2 +- docs/mine/lotus/miner-configuration.md | 2 +- docs/mine/lotus/sector-pledging.md | 22 ++++++++++++---------- 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/mine/lotus/miner-addresses.md b/docs/mine/lotus/miner-addresses.md index e27e74b5b..ad8f9b4a9 100644 --- a/docs/mine/lotus/miner-addresses.md +++ b/docs/mine/lotus/miner-addresses.md @@ -113,7 +113,7 @@ To set up a _control address_: Repeat this procedure to add additional addresses. -5. You can Specify other actor to check control address: +5. You can specify other actor to check control address: ```shell lotus-miner --actor f01000 actor control list diff --git a/docs/mine/lotus/miner-configuration.md b/docs/mine/lotus/miner-configuration.md index 9f9f5894d..63269b57c 100644 --- a/docs/mine/lotus/miner-configuration.md +++ b/docs/mine/lotus/miner-configuration.md @@ -365,7 +365,7 @@ The available units are: "h": int64(Hour), ``` -For example if you want to set the sector lifecycle to 180 days, you can multiply 180 days by 24 hours per day to get 4320 hours and set this value to "4320h0m0s". +For example, if you want to set the sector lifecycle to 180 days, you can multiply 180 days by 24 hours per day to get 4320 hours and set this value to `"4320h0m0s"`. ## Storage section diff --git a/docs/mine/lotus/sector-pledging.md b/docs/mine/lotus/sector-pledging.md index c8826e278..8a21e900a 100644 --- a/docs/mine/lotus/sector-pledging.md +++ b/docs/mine/lotus/sector-pledging.md @@ -78,19 +78,19 @@ The sector should become inactive within 24 hours after a new replacement sector ## Inspect expiring sectors -First you can check the sectors that are about to expire. Sectors that will expire within 60 days can be checked by default with the following command: +You can check which sectors are about to expire. Sectors that will expire within 60 days can be checked by default with the following command: ```shell lotus-miner sectors check-expire ``` -If you want to check for sectors that will expire within 33 days (669600 epoch in devnet) , add the `--cutoff` option, timing in epoch, here is an example in devnet: +If you want to check for sectors that will expire within 33 days (669600 epoch in devnet) , add the `--cutoff` option along with your desired epoch: -```shell with-output +```shell lotus-miner sectors check-expire --cutoff 669600 ``` -``` +```shell output ID SealProof InitialPledge Activation Expiration MaxExpiration MaxExtendNow 5 5 59.605 nFIL 1519 (1 day 9 hours ago) 691857 (in 4 weeks 2 days) 5257519 (in 34 weeks 3 days) 1587303 (in 10 weeks 2 days) 10 5 59.605 nFIL 3588 (1 day 7 hours ago) 697617 (in 4 weeks 2 days) 5259588 (in 34 weeks 4 days) 1587303 (in 10 weeks 2 days) @@ -103,8 +103,6 @@ ID SealProof InitialPledge Activation Expiration You can extend the lifecycle of a sector with the command: -```shell practical and flexible tool: - ```shell lotus-miner sectors renew [command options] [arguments...] ``` @@ -123,8 +121,12 @@ lotus-miner sectors renew --sector-file --new-expiration 1555 ::: warning You have to select the sectors to renew. That means you have to specify the `--from` and `--to` option, or specify the sector file, if no sector is selected this command will have no effect. -Format of sectorfile: - 1 - 2 - ... + +Format of sector file: + +``` +1 +2 +... +``` ::: From 9131c654e4a8c4a2e872f707105a19f44d0a7d7b Mon Sep 17 00:00:00 2001 From: Johnny <9611008+johnnymatthews@users.noreply.github.com> Date: Tue, 5 Oct 2021 12:04:32 -0400 Subject: [PATCH 4/4] Apply suggestions from code review --- docs/mine/lotus/sector-pledging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mine/lotus/sector-pledging.md b/docs/mine/lotus/sector-pledging.md index 8a21e900a..7d854ae5f 100644 --- a/docs/mine/lotus/sector-pledging.md +++ b/docs/mine/lotus/sector-pledging.md @@ -86,7 +86,7 @@ lotus-miner sectors check-expire If you want to check for sectors that will expire within 33 days (669600 epoch in devnet) , add the `--cutoff` option along with your desired epoch: -```shell +```shell with-output lotus-miner sectors check-expire --cutoff 669600 ```