From d39dd9413f06d40a6f109aa3fa0f388079f80c76 Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 9 Jan 2024 11:12:26 +0200 Subject: [PATCH] dont pretty --- .github/workflows/ci.yml | 6 ++-- packages/cli/generate_docs.sh | 1 - .../docs/command-line-interface/account.md | 35 +++++++++++++++++-- .../command-line-interface/autocomplete.md | 4 ++- .../docs/command-line-interface/commands.md | 4 ++- .../docs/command-line-interface/config.md | 5 ++- packages/docs/command-line-interface/dkg.md | 9 ++++- .../docs/command-line-interface/election.md | 10 +++++- .../docs/command-line-interface/exchange.md | 12 +++++-- .../docs/command-line-interface/governance.md | 24 ++++++++++++- .../command-line-interface/grandamento.md | 9 ++++- packages/docs/command-line-interface/help.md | 4 ++- .../docs/command-line-interface/identity.md | 6 +++- .../docs/command-line-interface/lockedgold.md | 12 ++++++- .../docs/command-line-interface/multisig.md | 6 +++- .../docs/command-line-interface/network.md | 6 +++- packages/docs/command-line-interface/node.md | 5 ++- .../docs/command-line-interface/oracle.md | 7 +++- .../docs/command-line-interface/plugins.md | 17 +++++++-- .../command-line-interface/releasecelo.md | 18 +++++++++- .../docs/command-line-interface/reserve.md | 5 ++- .../docs/command-line-interface/rewards.md | 4 ++- .../docs/command-line-interface/transfer.md | 12 +++++-- .../docs/command-line-interface/validator.md | 18 ++++++++-- .../command-line-interface/validatorgroup.md | 10 +++++- 25 files changed, 216 insertions(+), 33 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b1532e7af..302c2600a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -221,9 +221,6 @@ jobs: uses: ./.github/actions/sync-workspace with: artifacts_to_cache: ${{ needs.install-dependencies.outputs.artifacts_to_cache }} - - name: Run tests - run: | - yarn workspace @celo/celocli test - name: Fail if someone forgot to commit CLI docs run: | yarn workspace @celo/celocli docs @@ -234,6 +231,9 @@ jobs: git diff exit 1 fi + - name: Run tests + run: | + yarn workspace @celo/celocli test - name: Verify that a new account can be created run: | yarn workspace @celo/celocli run celocli account:new diff --git a/packages/cli/generate_docs.sh b/packages/cli/generate_docs.sh index f6f2eac30..dfe4dd29c 100755 --- a/packages/cli/generate_docs.sh +++ b/packages/cli/generate_docs.sh @@ -4,7 +4,6 @@ export COLUMNS=88 # must replace lib with src so docs link to source code sed -i -e 's@./lib/commands@./src/commands@g' package.json yarn oclif readme --multi --dir=../docs/command-line-interface -yarn prettier --write ../docs/command-line-interface/* sed -i.bak '/^- \[/d' ../docs/command-line-interface/* rm -rf ../docs/command-line-interface/*.bak # reverse changes to package.json diff --git a/packages/docs/command-line-interface/account.md b/packages/docs/command-line-interface/account.md index 5c4078740..239e8409d 100644 --- a/packages/docs/command-line-interface/account.md +++ b/packages/docs/command-line-interface/account.md @@ -1,7 +1,38 @@ -# `celocli account` +`celocli account` +================= Manage your account, keys, and metadata +* [`celocli account:authorize`](#celocli-accountauthorize) +* [`celocli account:balance ARG1`](#celocli-accountbalance-arg1) +* [`celocli account:claim-account ARG1`](#celocli-accountclaim-account-arg1) +* [`celocli account:claim-domain ARG1`](#celocli-accountclaim-domain-arg1) +* [`celocli account:claim-keybase ARG1`](#celocli-accountclaim-keybase-arg1) +* [`celocli account:claim-name ARG1`](#celocli-accountclaim-name-arg1) +* [`celocli account:claim-storage ARG1`](#celocli-accountclaim-storage-arg1) +* [`celocli account:create-metadata ARG1`](#celocli-accountcreate-metadata-arg1) +* [`celocli account:deauthorize`](#celocli-accountdeauthorize) +* [`celocli account:delete-payment-delegation`](#celocli-accountdelete-payment-delegation) +* [`celocli account:get-metadata ARG1`](#celocli-accountget-metadata-arg1) +* [`celocli account:get-payment-delegation`](#celocli-accountget-payment-delegation) +* [`celocli account:list`](#celocli-accountlist) +* [`celocli account:lock ARG1`](#celocli-accountlock-arg1) +* [`celocli account:new`](#celocli-accountnew) +* [`celocli account:offchain-read ARG1`](#celocli-accountoffchain-read-arg1) +* [`celocli account:offchain-write`](#celocli-accountoffchain-write) +* [`celocli account:proof-of-possession`](#celocli-accountproof-of-possession) +* [`celocli account:recover-old`](#celocli-accountrecover-old) +* [`celocli account:register`](#celocli-accountregister) +* [`celocli account:register-data-encryption-key`](#celocli-accountregister-data-encryption-key) +* [`celocli account:register-metadata`](#celocli-accountregister-metadata) +* [`celocli account:set-name`](#celocli-accountset-name) +* [`celocli account:set-payment-delegation`](#celocli-accountset-payment-delegation) +* [`celocli account:set-wallet`](#celocli-accountset-wallet) +* [`celocli account:show ARG1`](#celocli-accountshow-arg1) +* [`celocli account:show-claimed-accounts ARG1`](#celocli-accountshow-claimed-accounts-arg1) +* [`celocli account:show-metadata ARG1`](#celocli-accountshow-metadata-arg1) +* [`celocli account:unlock ARG1`](#celocli-accountunlock-arg1) +* [`celocli account:verify-proof-of-possession`](#celocli-accountverify-proof-of-possession) ## `celocli account:authorize` @@ -226,7 +257,7 @@ _See code: [src/commands/account/claim-storage.ts](https://github.com/celo-org/d ## `celocli account:create-metadata ARG1` -Create an empty identity metadata file. Use this metadata file to store claims attesting to ownership of off-chain resources. Claims can be generated with the account:claim-\* commands. +Create an empty identity metadata file. Use this metadata file to store claims attesting to ownership of off-chain resources. Claims can be generated with the account:claim-* commands. ``` USAGE diff --git a/packages/docs/command-line-interface/autocomplete.md b/packages/docs/command-line-interface/autocomplete.md index b35e69383..56d9d9903 100644 --- a/packages/docs/command-line-interface/autocomplete.md +++ b/packages/docs/command-line-interface/autocomplete.md @@ -1,7 +1,9 @@ -# `celocli autocomplete` +`celocli autocomplete` +====================== Display autocomplete installation instructions. +* [`celocli autocomplete [SHELL]`](#celocli-autocomplete-shell) ## `celocli autocomplete [SHELL]` diff --git a/packages/docs/command-line-interface/commands.md b/packages/docs/command-line-interface/commands.md index b19ffb2f5..8c7279189 100644 --- a/packages/docs/command-line-interface/commands.md +++ b/packages/docs/command-line-interface/commands.md @@ -1,7 +1,9 @@ -# `celocli commands` +`celocli commands` +================== list all the commands +* [`celocli commands`](#celocli-commands) ## `celocli commands` diff --git a/packages/docs/command-line-interface/config.md b/packages/docs/command-line-interface/config.md index 46ef078df..616e14abd 100644 --- a/packages/docs/command-line-interface/config.md +++ b/packages/docs/command-line-interface/config.md @@ -1,7 +1,10 @@ -# `celocli config` +`celocli config` +================ Configure CLI options which persist across commands +* [`celocli config:get`](#celocli-configget) +* [`celocli config:set`](#celocli-configset) ## `celocli config:get` diff --git a/packages/docs/command-line-interface/dkg.md b/packages/docs/command-line-interface/dkg.md index 8d4151eb6..5ac46d148 100644 --- a/packages/docs/command-line-interface/dkg.md +++ b/packages/docs/command-line-interface/dkg.md @@ -1,7 +1,14 @@ -# `celocli dkg` +`celocli dkg` +============= Publish your locally computed DKG results to the blockchain +* [`celocli dkg:allowlist`](#celocli-dkgallowlist) +* [`celocli dkg:deploy`](#celocli-dkgdeploy) +* [`celocli dkg:get`](#celocli-dkgget) +* [`celocli dkg:publish`](#celocli-dkgpublish) +* [`celocli dkg:register`](#celocli-dkgregister) +* [`celocli dkg:start`](#celocli-dkgstart) ## `celocli dkg:allowlist` diff --git a/packages/docs/command-line-interface/election.md b/packages/docs/command-line-interface/election.md index 4c8279024..0c1f51b75 100644 --- a/packages/docs/command-line-interface/election.md +++ b/packages/docs/command-line-interface/election.md @@ -1,7 +1,15 @@ -# `celocli election` +`celocli election` +================== Participate in and view the state of Validator Elections +* [`celocli election:activate`](#celocli-electionactivate) +* [`celocli election:current`](#celocli-electioncurrent) +* [`celocli election:list`](#celocli-electionlist) +* [`celocli election:revoke`](#celocli-electionrevoke) +* [`celocli election:run`](#celocli-electionrun) +* [`celocli election:show ARG1`](#celocli-electionshow-arg1) +* [`celocli election:vote`](#celocli-electionvote) ## `celocli election:activate` diff --git a/packages/docs/command-line-interface/exchange.md b/packages/docs/command-line-interface/exchange.md index 7a0f61c43..7685bcd0c 100644 --- a/packages/docs/command-line-interface/exchange.md +++ b/packages/docs/command-line-interface/exchange.md @@ -1,7 +1,15 @@ -# `celocli exchange` +`celocli exchange` +================== Exchange Celo Dollars and CELO via the stability mechanism +* [`celocli exchange:celo`](#celocli-exchangecelo) +* [`celocli exchange:dollars`](#celocli-exchangedollars) +* [`celocli exchange:euros`](#celocli-exchangeeuros) +* [`celocli exchange:gold`](#celocli-exchangegold) +* [`celocli exchange:reals`](#celocli-exchangereals) +* [`celocli exchange:show`](#celocli-exchangeshow) +* [`celocli exchange:stable`](#celocli-exchangestable) ## `celocli exchange:celo` @@ -98,7 +106,7 @@ _See code: [src/commands/exchange/euros.ts](https://github.com/celo-org/develope ## `celocli exchange:gold` -Exchange CELO for StableTokens via the stability mechanism. _DEPRECATION WARNING_ Use the "exchange:celo" command instead +Exchange CELO for StableTokens via the stability mechanism. *DEPRECATION WARNING* Use the "exchange:celo" command instead ``` USAGE diff --git a/packages/docs/command-line-interface/governance.md b/packages/docs/command-line-interface/governance.md index e29b4d4bf..d24fe2e33 100644 --- a/packages/docs/command-line-interface/governance.md +++ b/packages/docs/command-line-interface/governance.md @@ -1,7 +1,29 @@ -# `celocli governance` +`celocli governance` +==================== Interact with on-chain governance proposals and hotfixes +* [`celocli governance:approvehotfix`](#celocli-governanceapprovehotfix) +* [`celocli governance:build-proposal`](#celocli-governancebuild-proposal) +* [`celocli governance:dequeue`](#celocli-governancedequeue) +* [`celocli governance:execute`](#celocli-governanceexecute) +* [`celocli governance:executehotfix`](#celocli-governanceexecutehotfix) +* [`celocli governance:hashhotfix`](#celocli-governancehashhotfix) +* [`celocli governance:list`](#celocli-governancelist) +* [`celocli governance:preparehotfix`](#celocli-governancepreparehotfix) +* [`celocli governance:propose`](#celocli-governancepropose) +* [`celocli governance:revokeupvote`](#celocli-governancerevokeupvote) +* [`celocli governance:show`](#celocli-governanceshow) +* [`celocli governance:showaccount`](#celocli-governanceshowaccount) +* [`celocli governance:showhotfix`](#celocli-governanceshowhotfix) +* [`celocli governance:upvote`](#celocli-governanceupvote) +* [`celocli governance:view`](#celocli-governanceview) +* [`celocli governance:viewaccount`](#celocli-governanceviewaccount) +* [`celocli governance:viewhotfix`](#celocli-governanceviewhotfix) +* [`celocli governance:vote`](#celocli-governancevote) +* [`celocli governance:votePartially`](#celocli-governancevotepartially) +* [`celocli governance:whitelisthotfix`](#celocli-governancewhitelisthotfix) +* [`celocli governance:withdraw`](#celocli-governancewithdraw) ## `celocli governance:approvehotfix` diff --git a/packages/docs/command-line-interface/grandamento.md b/packages/docs/command-line-interface/grandamento.md index 05b145c82..2963beccb 100644 --- a/packages/docs/command-line-interface/grandamento.md +++ b/packages/docs/command-line-interface/grandamento.md @@ -1,7 +1,14 @@ -# `celocli grandamento` +`celocli grandamento` +===================== Cancels a Granda Mento exchange proposal +* [`celocli grandamento:cancel`](#celocli-grandamentocancel) +* [`celocli grandamento:execute`](#celocli-grandamentoexecute) +* [`celocli grandamento:get-buy-amount`](#celocli-grandamentoget-buy-amount) +* [`celocli grandamento:list`](#celocli-grandamentolist) +* [`celocli grandamento:propose`](#celocli-grandamentopropose) +* [`celocli grandamento:show`](#celocli-grandamentoshow) ## `celocli grandamento:cancel` diff --git a/packages/docs/command-line-interface/help.md b/packages/docs/command-line-interface/help.md index f960c5654..78b8deb1e 100644 --- a/packages/docs/command-line-interface/help.md +++ b/packages/docs/command-line-interface/help.md @@ -1,7 +1,9 @@ -# `celocli help` +`celocli help` +============== Display help for celocli. +* [`celocli help [COMMANDS]`](#celocli-help-commands) ## `celocli help [COMMANDS]` diff --git a/packages/docs/command-line-interface/identity.md b/packages/docs/command-line-interface/identity.md index 07f27265c..4d4899bc3 100644 --- a/packages/docs/command-line-interface/identity.md +++ b/packages/docs/command-line-interface/identity.md @@ -1,7 +1,11 @@ -# `celocli identity` +`celocli identity` +================== Interact with ODIS and the attestations service +* [`celocli identity:get-attestations`](#celocli-identityget-attestations) +* [`celocli identity:identifier`](#celocli-identityidentifier) +* [`celocli identity:withdraw-attestation-rewards`](#celocli-identitywithdraw-attestation-rewards) ## `celocli identity:get-attestations` diff --git a/packages/docs/command-line-interface/lockedgold.md b/packages/docs/command-line-interface/lockedgold.md index 94a2a1492..ee51f6e48 100644 --- a/packages/docs/command-line-interface/lockedgold.md +++ b/packages/docs/command-line-interface/lockedgold.md @@ -1,7 +1,17 @@ -# `celocli lockedgold` +`celocli lockedgold` +==================== View and manage locked CELO +* [`celocli lockedgold:delegate`](#celocli-lockedgolddelegate) +* [`celocli lockedgold:delegate-info`](#celocli-lockedgolddelegate-info) +* [`celocli lockedgold:lock`](#celocli-lockedgoldlock) +* [`celocli lockedgold:max-delegatees-count`](#celocli-lockedgoldmax-delegatees-count) +* [`celocli lockedgold:revoke-delegate`](#celocli-lockedgoldrevoke-delegate) +* [`celocli lockedgold:show ARG1`](#celocli-lockedgoldshow-arg1) +* [`celocli lockedgold:unlock`](#celocli-lockedgoldunlock) +* [`celocli lockedgold:update-delegated-amount`](#celocli-lockedgoldupdate-delegated-amount) +* [`celocli lockedgold:withdraw`](#celocli-lockedgoldwithdraw) ## `celocli lockedgold:delegate` diff --git a/packages/docs/command-line-interface/multisig.md b/packages/docs/command-line-interface/multisig.md index 1b6049de1..de7a261eb 100644 --- a/packages/docs/command-line-interface/multisig.md +++ b/packages/docs/command-line-interface/multisig.md @@ -1,7 +1,11 @@ -# `celocli multisig` +`celocli multisig` +================== Approves an existing transaction on a multi-sig contract +* [`celocli multisig:approve`](#celocli-multisigapprove) +* [`celocli multisig:show ARG1`](#celocli-multisigshow-arg1) +* [`celocli multisig:transfer ARG1`](#celocli-multisigtransfer-arg1) ## `celocli multisig:approve` diff --git a/packages/docs/command-line-interface/network.md b/packages/docs/command-line-interface/network.md index 92e496715..501a6cb65 100644 --- a/packages/docs/command-line-interface/network.md +++ b/packages/docs/command-line-interface/network.md @@ -1,7 +1,11 @@ -# `celocli network` +`celocli network` +================= View details about the network, like contracts and parameters +* [`celocli network:contracts`](#celocli-networkcontracts) +* [`celocli network:info`](#celocli-networkinfo) +* [`celocli network:parameters`](#celocli-networkparameters) ## `celocli network:contracts` diff --git a/packages/docs/command-line-interface/node.md b/packages/docs/command-line-interface/node.md index b71621650..41504b5ea 100644 --- a/packages/docs/command-line-interface/node.md +++ b/packages/docs/command-line-interface/node.md @@ -1,7 +1,10 @@ -# `celocli node` +`celocli node` +============== Manage your Celo node +* [`celocli node:accounts`](#celocli-nodeaccounts) +* [`celocli node:synced`](#celocli-nodesynced) ## `celocli node:accounts` diff --git a/packages/docs/command-line-interface/oracle.md b/packages/docs/command-line-interface/oracle.md index 194ddd012..ae786714b 100644 --- a/packages/docs/command-line-interface/oracle.md +++ b/packages/docs/command-line-interface/oracle.md @@ -1,7 +1,12 @@ -# `celocli oracle` +`celocli oracle` +================ List oracle addresses for a given token +* [`celocli oracle:list ARG1`](#celocli-oraclelist-arg1) +* [`celocli oracle:remove-expired-reports ARG1`](#celocli-oracleremove-expired-reports-arg1) +* [`celocli oracle:report ARG1`](#celocli-oraclereport-arg1) +* [`celocli oracle:reports ARG1`](#celocli-oraclereports-arg1) ## `celocli oracle:list ARG1` diff --git a/packages/docs/command-line-interface/plugins.md b/packages/docs/command-line-interface/plugins.md index e5f384166..6f498b911 100644 --- a/packages/docs/command-line-interface/plugins.md +++ b/packages/docs/command-line-interface/plugins.md @@ -1,7 +1,18 @@ -# `celocli plugins` +`celocli plugins` +================= List installed plugins. +* [`celocli plugins`](#celocli-plugins) +* [`celocli plugins:install PLUGIN...`](#celocli-pluginsinstall-plugin) +* [`celocli plugins:inspect PLUGIN...`](#celocli-pluginsinspect-plugin) +* [`celocli plugins:install PLUGIN...`](#celocli-pluginsinstall-plugin-1) +* [`celocli plugins:link PLUGIN`](#celocli-pluginslink-plugin) +* [`celocli plugins:uninstall PLUGIN...`](#celocli-pluginsuninstall-plugin) +* [`celocli plugins:reset`](#celocli-pluginsreset) +* [`celocli plugins:uninstall PLUGIN...`](#celocli-pluginsuninstall-plugin-1) +* [`celocli plugins:uninstall PLUGIN...`](#celocli-pluginsuninstall-plugin-2) +* [`celocli plugins:update`](#celocli-pluginsupdate) ## `celocli plugins` @@ -62,7 +73,7 @@ ALIASES $ celocli plugins:add EXAMPLES - $ celocli plugins:add myplugin + $ celocli plugins:add myplugin $ celocli plugins:add https://github.com/someuser/someplugin @@ -132,7 +143,7 @@ ALIASES $ celocli plugins:add EXAMPLES - $ celocli plugins:install myplugin + $ celocli plugins:install myplugin $ celocli plugins:install https://github.com/someuser/someplugin diff --git a/packages/docs/command-line-interface/releasecelo.md b/packages/docs/command-line-interface/releasecelo.md index 5bdfa5881..d99e458ae 100644 --- a/packages/docs/command-line-interface/releasecelo.md +++ b/packages/docs/command-line-interface/releasecelo.md @@ -1,7 +1,23 @@ -# `celocli releasecelo` +`celocli releasecelo` +===================== View and manage ReleaseGold contracts +* [`celocli releasecelo:authorize`](#celocli-releaseceloauthorize) +* [`celocli releasecelo:create-account`](#celocli-releasecelocreate-account) +* [`celocli releasecelo:locked-gold`](#celocli-releasecelolocked-gold) +* [`celocli releasecelo:refund-and-finalize`](#celocli-releasecelorefund-and-finalize) +* [`celocli releasecelo:revoke`](#celocli-releasecelorevoke) +* [`celocli releasecelo:revoke-votes`](#celocli-releasecelorevoke-votes) +* [`celocli releasecelo:set-account`](#celocli-releaseceloset-account) +* [`celocli releasecelo:set-account-wallet-address`](#celocli-releaseceloset-account-wallet-address) +* [`celocli releasecelo:set-beneficiary`](#celocli-releaseceloset-beneficiary) +* [`celocli releasecelo:set-can-expire`](#celocli-releaseceloset-can-expire) +* [`celocli releasecelo:set-liquidity-provision`](#celocli-releaseceloset-liquidity-provision) +* [`celocli releasecelo:set-max-distribution`](#celocli-releaseceloset-max-distribution) +* [`celocli releasecelo:show`](#celocli-releaseceloshow) +* [`celocli releasecelo:transfer-dollars`](#celocli-releasecelotransfer-dollars) +* [`celocli releasecelo:withdraw`](#celocli-releasecelowithdraw) ## `celocli releasecelo:authorize` diff --git a/packages/docs/command-line-interface/reserve.md b/packages/docs/command-line-interface/reserve.md index 54ed71c98..f0651a004 100644 --- a/packages/docs/command-line-interface/reserve.md +++ b/packages/docs/command-line-interface/reserve.md @@ -1,7 +1,10 @@ -# `celocli reserve` +`celocli reserve` +================= Shows information about reserve +* [`celocli reserve:status`](#celocli-reservestatus) +* [`celocli reserve:transfergold`](#celocli-reservetransfergold) ## `celocli reserve:status` diff --git a/packages/docs/command-line-interface/rewards.md b/packages/docs/command-line-interface/rewards.md index 11e89e716..153522e18 100644 --- a/packages/docs/command-line-interface/rewards.md +++ b/packages/docs/command-line-interface/rewards.md @@ -1,7 +1,9 @@ -# `celocli rewards` +`celocli rewards` +================= Show rewards information about a voter, registered Validator, or Validator Group +* [`celocli rewards:show`](#celocli-rewardsshow) ## `celocli rewards:show` diff --git a/packages/docs/command-line-interface/transfer.md b/packages/docs/command-line-interface/transfer.md index aa1ab2016..4cb913acf 100644 --- a/packages/docs/command-line-interface/transfer.md +++ b/packages/docs/command-line-interface/transfer.md @@ -1,7 +1,15 @@ -# `celocli transfer` +`celocli transfer` +================== Transfer CELO and Celo Dollars +* [`celocli transfer:celo`](#celocli-transfercelo) +* [`celocli transfer:dollars`](#celocli-transferdollars) +* [`celocli transfer:erc20`](#celocli-transfererc20) +* [`celocli transfer:euros`](#celocli-transfereuros) +* [`celocli transfer:gold`](#celocli-transfergold) +* [`celocli transfer:reals`](#celocli-transferreals) +* [`celocli transfer:stable`](#celocli-transferstable) ## `celocli transfer:celo` @@ -114,7 +122,7 @@ _See code: [src/commands/transfer/euros.ts](https://github.com/celo-org/develope ## `celocli transfer:gold` -Transfer CELO to a specified address. _DEPRECATION WARNING_ Use the "transfer:celo" command instead +Transfer CELO to a specified address. *DEPRECATION WARNING* Use the "transfer:celo" command instead ``` USAGE diff --git a/packages/docs/command-line-interface/validator.md b/packages/docs/command-line-interface/validator.md index f5c6a117d..4595a8f24 100644 --- a/packages/docs/command-line-interface/validator.md +++ b/packages/docs/command-line-interface/validator.md @@ -1,7 +1,21 @@ -# `celocli validator` +`celocli validator` +=================== View and manage Validators +* [`celocli validator:affiliate ARG1`](#celocli-validatoraffiliate-arg1) +* [`celocli validator:deaffiliate`](#celocli-validatordeaffiliate) +* [`celocli validator:deregister`](#celocli-validatorderegister) +* [`celocli validator:downtime-slash`](#celocli-validatordowntime-slash) +* [`celocli validator:force-deaffiliate`](#celocli-validatorforce-deaffiliate) +* [`celocli validator:list`](#celocli-validatorlist) +* [`celocli validator:register`](#celocli-validatorregister) +* [`celocli validator:requirements`](#celocli-validatorrequirements) +* [`celocli validator:set-bitmaps`](#celocli-validatorset-bitmaps) +* [`celocli validator:show ARG1`](#celocli-validatorshow-arg1) +* [`celocli validator:signed-blocks`](#celocli-validatorsigned-blocks) +* [`celocli validator:status`](#celocli-validatorstatus) +* [`celocli validator:update-bls-public-key`](#celocli-validatorupdate-bls-public-key) ## `celocli validator:affiliate ARG1` @@ -123,7 +137,7 @@ _See code: [src/commands/validator/downtime-slash.ts](https://github.com/celo-or ## `celocli validator:force-deaffiliate` -Force deaffiliate a Validator from a Validator Group, and remove it from the Group if it is also a member. Used by stake-off admins in order to remove validators from the next epoch's validator set if they are down and consistently unresponsive, in order to preserve the health of the network. This feature will be removed once slashing for downtime is implemented. +Force deaffiliate a Validator from a Validator Group, and remove it from the Group if it is also a member. Used by stake-off admins in order to remove validators from the next epoch's validator set if they are down and consistently unresponsive, in order to preserve the health of the network. This feature will be removed once slashing for downtime is implemented. ``` USAGE diff --git a/packages/docs/command-line-interface/validatorgroup.md b/packages/docs/command-line-interface/validatorgroup.md index 80d98f32b..0e4d8189f 100644 --- a/packages/docs/command-line-interface/validatorgroup.md +++ b/packages/docs/command-line-interface/validatorgroup.md @@ -1,7 +1,15 @@ -# `celocli validatorgroup` +`celocli validatorgroup` +======================== View and manage Validator Groups +* [`celocli validatorgroup:commission`](#celocli-validatorgroupcommission) +* [`celocli validatorgroup:deregister`](#celocli-validatorgroupderegister) +* [`celocli validatorgroup:list`](#celocli-validatorgrouplist) +* [`celocli validatorgroup:member ARG1`](#celocli-validatorgroupmember-arg1) +* [`celocli validatorgroup:register`](#celocli-validatorgroupregister) +* [`celocli validatorgroup:reset-slashing-multiplier ARG1`](#celocli-validatorgroupreset-slashing-multiplier-arg1) +* [`celocli validatorgroup:show ARG1`](#celocli-validatorgroupshow-arg1) ## `celocli validatorgroup:commission`