From 170cfb16c30dc8542d75bd5df00f4f8ffdeb4e0e Mon Sep 17 00:00:00 2001 From: Aaron Date: Tue, 9 Jan 2024 10:59:55 +0200 Subject: [PATCH] lets go --- .../docs/command-line-interface/account.md | 1 + .../command-line-interface/autocomplete.md | 1 + .../docs/command-line-interface/commands.md | 1 + .../docs/command-line-interface/config.md | 1 + packages/docs/command-line-interface/dkg.md | 1 + .../docs/command-line-interface/election.md | 1 + .../docs/command-line-interface/exchange.md | 1 + .../docs/command-line-interface/governance.md | 1 + .../command-line-interface/grandamento.md | 1 + packages/docs/command-line-interface/help.md | 1 + .../docs/command-line-interface/identity.md | 1 + .../command-line-interface/introduction.md | 65 --- .../docs/command-line-interface/lockedgold.md | 1 + .../docs/command-line-interface/multisig.md | 1 + .../docs/command-line-interface/network.md | 1 + packages/docs/command-line-interface/node.md | 1 + .../docs/command-line-interface/oracle.md | 1 + .../docs/command-line-interface/plugins.md | 1 + .../docs/command-line-interface/registry.md | 34 -- .../command-line-interface/releasecelo.md | 1 + .../command-line-interface/releasegold.md | 472 ------------------ .../docs/command-line-interface/reserve.md | 1 + .../docs/command-line-interface/rewards.md | 1 + .../docs/command-line-interface/transfer.md | 1 + .../docs/command-line-interface/validator.md | 1 + .../command-line-interface/validatorgroup.md | 1 + 26 files changed, 23 insertions(+), 571 deletions(-) delete mode 100644 packages/docs/command-line-interface/introduction.md delete mode 100644 packages/docs/command-line-interface/registry.md delete mode 100644 packages/docs/command-line-interface/releasegold.md diff --git a/packages/docs/command-line-interface/account.md b/packages/docs/command-line-interface/account.md index e6d48ddf2..5c4078740 100644 --- a/packages/docs/command-line-interface/account.md +++ b/packages/docs/command-line-interface/account.md @@ -2,6 +2,7 @@ Manage your account, keys, and metadata + ## `celocli account:authorize` Keep your locked Gold more secure by authorizing alternative keys to be used for signing attestations, voting, or validating. By doing so, you can continue to participate in the protocol while keeping the key with access to your locked Gold in cold storage. You must include a "proof-of-possession" of the key being authorized, which can be generated with the "account:proof-of-possession" command. diff --git a/packages/docs/command-line-interface/autocomplete.md b/packages/docs/command-line-interface/autocomplete.md index a0d288bb7..b35e69383 100644 --- a/packages/docs/command-line-interface/autocomplete.md +++ b/packages/docs/command-line-interface/autocomplete.md @@ -2,6 +2,7 @@ Display autocomplete installation instructions. + ## `celocli autocomplete [SHELL]` Display autocomplete installation instructions. diff --git a/packages/docs/command-line-interface/commands.md b/packages/docs/command-line-interface/commands.md index aa843316d..b19ffb2f5 100644 --- a/packages/docs/command-line-interface/commands.md +++ b/packages/docs/command-line-interface/commands.md @@ -2,6 +2,7 @@ list all the commands + ## `celocli commands` list all the commands diff --git a/packages/docs/command-line-interface/config.md b/packages/docs/command-line-interface/config.md index 36288939d..46ef078df 100644 --- a/packages/docs/command-line-interface/config.md +++ b/packages/docs/command-line-interface/config.md @@ -2,6 +2,7 @@ Configure CLI options which persist across commands + ## `celocli config:get` Output network node configuration diff --git a/packages/docs/command-line-interface/dkg.md b/packages/docs/command-line-interface/dkg.md index 7f9971aec..8d4151eb6 100644 --- a/packages/docs/command-line-interface/dkg.md +++ b/packages/docs/command-line-interface/dkg.md @@ -2,6 +2,7 @@ Publish your locally computed DKG results to the blockchain + ## `celocli dkg:allowlist` Allowlist an address in the DKG diff --git a/packages/docs/command-line-interface/election.md b/packages/docs/command-line-interface/election.md index baedc1087..4c8279024 100644 --- a/packages/docs/command-line-interface/election.md +++ b/packages/docs/command-line-interface/election.md @@ -2,6 +2,7 @@ Participate in and view the state of Validator Elections + ## `celocli election:activate` Activate pending votes in validator elections to begin earning rewards. To earn rewards as a voter, it is required to activate your pending votes at some point after the end of the epoch in which they were made. diff --git a/packages/docs/command-line-interface/exchange.md b/packages/docs/command-line-interface/exchange.md index 9b30a9b3c..7a0f61c43 100644 --- a/packages/docs/command-line-interface/exchange.md +++ b/packages/docs/command-line-interface/exchange.md @@ -2,6 +2,7 @@ Exchange Celo Dollars and CELO via the stability mechanism + ## `celocli exchange:celo` Exchange CELO for StableTokens via the stability mechanism. (Note: this is the equivalent of the old exchange:gold) diff --git a/packages/docs/command-line-interface/governance.md b/packages/docs/command-line-interface/governance.md index 33c785500..e29b4d4bf 100644 --- a/packages/docs/command-line-interface/governance.md +++ b/packages/docs/command-line-interface/governance.md @@ -2,6 +2,7 @@ Interact with on-chain governance proposals and hotfixes + ## `celocli governance:approvehotfix` Approve a dequeued governance proposal (or hotfix) diff --git a/packages/docs/command-line-interface/grandamento.md b/packages/docs/command-line-interface/grandamento.md index 0ff8bb440..05b145c82 100644 --- a/packages/docs/command-line-interface/grandamento.md +++ b/packages/docs/command-line-interface/grandamento.md @@ -2,6 +2,7 @@ Cancels a Granda Mento exchange proposal + ## `celocli grandamento:cancel` Cancels a Granda Mento exchange proposal diff --git a/packages/docs/command-line-interface/help.md b/packages/docs/command-line-interface/help.md index 04af8aeec..f960c5654 100644 --- a/packages/docs/command-line-interface/help.md +++ b/packages/docs/command-line-interface/help.md @@ -2,6 +2,7 @@ Display help for celocli. + ## `celocli help [COMMANDS]` Display help for celocli. diff --git a/packages/docs/command-line-interface/identity.md b/packages/docs/command-line-interface/identity.md index 27aca090b..07f27265c 100644 --- a/packages/docs/command-line-interface/identity.md +++ b/packages/docs/command-line-interface/identity.md @@ -2,6 +2,7 @@ Interact with ODIS and the attestations service + ## `celocli identity:get-attestations` Looks up attestations associated with the provided phone number. If a pepper is not provided, it uses the --from account's balance to query the pepper. diff --git a/packages/docs/command-line-interface/introduction.md b/packages/docs/command-line-interface/introduction.md deleted file mode 100644 index 7e20a30dc..000000000 --- a/packages/docs/command-line-interface/introduction.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -description: >- - This Command Line Interface allows users to interact with the Celo Protocol - smart contracts. ---- - -# Introduction - -## Getting Started - -### **Optional** - -- **Run a Celo node full node.** Commands will connect to a Celo node to execute most functionality. You can either use [Forno](../developer-resources/forno/README.md) (this is the easiest way) or run your own full node if you prefer. See the [Running a Full Node](../getting-started/running-a-full-node-in-mainnet.md) instructions for more details on running a full node. - -### NPM Package - -The Celo CLI is published as a node module on NPM. Assuming you have [npm](https://www.npmjs.com/get-npm) and [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) both installed, you can install the Celo CLI using the following command: - -```bash -npm install -g @celo/celocli -``` - -{% hint style="info" %} -We are currently deploying the CLI with only Node.js v18.14.2. If you are running a different version of Node.js, consider using [NVM](https://github.com/nvm-sh/nvm#installation-and-update) to manage your node versions. e.g. with: `nvm install 12 && nvm use 12` -{% endhint %} - -{% hint style="info" %} -If you have trouble installing globally \(i.e. with the `-g` flag\), try installing to a local directory instead with `npm install @celo/celocli` and run with `npx celocli`. -{% endhint %} - -### Overview - -The tool is broken down into modules and commands with the following pattern: - -```text -celocli : <...args> <...flags?> -``` - -The `celocli` tool assumes that users are running a node which they have access to signing transactions on, or have another mechanism for signing transactions (such as a Ledger wallet or supplying the private key as an argument to the command). See the documentation on the [config](config.md) module for information about how to set which node commands are sent to. - -{% hint style="info" %} -**All balances of CELO or Celo Dollars are expressed in units of 10^-18** -{% endhint %} - -{% embed url="https://www.npmjs.com/package/@celo/celocli" caption="" %} - -### Using a Ledger Wallet - -The Celo CLI supports using a [Ledger hardware wallet](../celo-holder-guide/ledger.md) to sign transactions. - -### Plugins - -Additional plugins can be installed which make the CLI experience smoother. Currently, `celocli` only supports installing plugins published on NPM within the `@celo/*` and `@clabs/*` scopes. - -{% hint style="danger" %} -Installing a 3rd party plugin can be _dangerous_! Please always be sure that you trust the plugin provider. -{% endhint %} - -The autocomplete plugin adds an interactive autocomplete for `bash` and `zsh` shells. To enable the autocomplete plugin, follow the instructions provided at: - -```text -celocli autocomplete -``` - -The update warning plugin notifies the user if they are using an oudated version of the CLI. This plugin is enabled by default. diff --git a/packages/docs/command-line-interface/lockedgold.md b/packages/docs/command-line-interface/lockedgold.md index 1cc97f459..94a2a1492 100644 --- a/packages/docs/command-line-interface/lockedgold.md +++ b/packages/docs/command-line-interface/lockedgold.md @@ -2,6 +2,7 @@ View and manage locked CELO + ## `celocli lockedgold:delegate` Delegate locked celo. diff --git a/packages/docs/command-line-interface/multisig.md b/packages/docs/command-line-interface/multisig.md index cc1bbaa1f..1b6049de1 100644 --- a/packages/docs/command-line-interface/multisig.md +++ b/packages/docs/command-line-interface/multisig.md @@ -2,6 +2,7 @@ Approves an existing transaction on a multi-sig contract + ## `celocli multisig:approve` Approves an existing transaction on a multi-sig contract diff --git a/packages/docs/command-line-interface/network.md b/packages/docs/command-line-interface/network.md index 20028e0d7..92e496715 100644 --- a/packages/docs/command-line-interface/network.md +++ b/packages/docs/command-line-interface/network.md @@ -2,6 +2,7 @@ View details about the network, like contracts and parameters + ## `celocli network:contracts` Lists Celo core contracts and their addesses. diff --git a/packages/docs/command-line-interface/node.md b/packages/docs/command-line-interface/node.md index bc6904fa1..b71621650 100644 --- a/packages/docs/command-line-interface/node.md +++ b/packages/docs/command-line-interface/node.md @@ -2,6 +2,7 @@ Manage your Celo node + ## `celocli node:accounts` List the addresses that this node has the private keys for. diff --git a/packages/docs/command-line-interface/oracle.md b/packages/docs/command-line-interface/oracle.md index 3e6a2417e..194ddd012 100644 --- a/packages/docs/command-line-interface/oracle.md +++ b/packages/docs/command-line-interface/oracle.md @@ -2,6 +2,7 @@ List oracle addresses for a given token + ## `celocli oracle:list ARG1` List oracle addresses for a given token diff --git a/packages/docs/command-line-interface/plugins.md b/packages/docs/command-line-interface/plugins.md index afafb19a0..e5f384166 100644 --- a/packages/docs/command-line-interface/plugins.md +++ b/packages/docs/command-line-interface/plugins.md @@ -2,6 +2,7 @@ List installed plugins. + ## `celocli plugins` List installed plugins. diff --git a/packages/docs/command-line-interface/registry.md b/packages/docs/command-line-interface/registry.md deleted file mode 100644 index 4d4e015aa..000000000 --- a/packages/docs/command-line-interface/registry.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -description: Interact with the contract registry ---- - -## Commands - -### List - -List contracts and their addresses in the registry - -``` -USAGE - $ celocli registry:list - -OPTIONS - --gasCurrency=(celo|CELO|cusd|cUSD|auto|Auto) Use a specific gas currency for transaction fees (defaults to 'auto' - which uses whatever feeCurrency is available) - - --ledgerAddresses=ledgerAddresses [default: 1] If --useLedger is set, this will get the first N addresses - for local signing - - --ledgerConfirmAddress Set it to ask confirmation for the address of the transaction from the - ledger - - --ledgerCustomAddresses=ledgerCustomAddresses [default: [0]] If --useLedger is set, this will get the array of index - addresses for local signing. Example --ledgerCustomAddresses "[4,99]" - - --useLedger Set it to use a ledger wallet - -EXAMPLE - list -``` - -_See code: [packages/cli/src/commands/registry/list.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/registry/list.ts)_ diff --git a/packages/docs/command-line-interface/releasecelo.md b/packages/docs/command-line-interface/releasecelo.md index 6928ba11b..5bdfa5881 100644 --- a/packages/docs/command-line-interface/releasecelo.md +++ b/packages/docs/command-line-interface/releasecelo.md @@ -2,6 +2,7 @@ View and manage ReleaseGold contracts + ## `celocli releasecelo:authorize` Authorize an alternative key to be used for a given action (Vote, Validate, Attest) on behalf of the ReleaseGold instance contract. diff --git a/packages/docs/command-line-interface/releasegold.md b/packages/docs/command-line-interface/releasegold.md deleted file mode 100644 index 791ecfe14..000000000 --- a/packages/docs/command-line-interface/releasegold.md +++ /dev/null @@ -1,472 +0,0 @@ -# `celocli releasegold` - -Alias for releasecelo - -## `celocli releasegold:authorize` - -Authorize an alternative key to be used for a given action (Vote, Validate, Attest) on behalf of the ReleaseGold instance contract. - -``` -Authorize an alternative key to be used for a given action (Vote, Validate, Attest) on behalf of the ReleaseGold instance contract. - -USAGE - $ celocli releasegold:authorize - -OPTIONS - --blsKey=0x The BLS public key that the - validator is using for - consensus, should pass proof of - possession. 96 bytes. - - --blsPop=0x The BLS public key - proof-of-possession, which - consists of a signature on the - account address. 48 bytes. - - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --role=vote|validator|attestation (required) - - --signature=0x (required) Signature (a.k.a. - proof-of-possession) of the - signer key - - --signer=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The signer key that - is to be used for voting - through the ReleaseGold - instance - -EXAMPLES - authorize --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 --role vote --signer - 0x6ecbe1db9ef729cbe972c83fb886247691fb6beb --signature - 0x1b9fca4bbb5bfb1dbe69ef1cddbd9b4202dcb6b134c5170611e1e36ecfa468d7b46c85328d504934fce6 - c2a1571603a50ae224d2b32685e84d4d1a1eebad8452eb - - authorize --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 --role validator - --signer 0x6ecbe1db9ef729cbe972c83fb886247691fb6beb --signature - 0x1b9fca4bbb5bfb1dbe69ef1cddbd9b4202dcb6b134c5170611e1e36ecfa468d7b46c85328d504934fce6 - c2a1571603a50ae224d2b32685e84d4d1a1eebad8452eb --blsKey - 0x4fa3f67fc913878b068d1fa1cdddc54913d3bf988dbe5a36a20fa888f20d4894c408a6773f3d7bde1115 - 4f2a3076b700d345a42fd25a0e5e83f4db5586ac7979ac2053cd95d8f2efd3e959571ceccaa743e02cf4be - 3f5d7aaddb0b06fc9aff00 --blsPop - 0xcdb77255037eb68897cd487fdd85388cbda448f617f874449d4b11588b0b7ad8ddc20d9bb450b513bb35 - 664ea3923900 - - authorize --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 --role attestation - --signer 0x6ecbe1db9ef729cbe972c83fb886247691fb6beb --signature - 0x1b9fca4bbb5bfb1dbe69ef1cddbd9b4202dcb6b134c5170611e1e36ecfa468d7b46c85328d504934fce6 - c2a1571603a50ae224d2b32685e84d4d1a1eebad8452eb -``` - -_See code: [src/commands/releasegold/authorize.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/authorize.ts)_ - -## `celocli releasegold:create-account` - -Creates a new account for the ReleaseGold instance - -``` -Creates a new account for the ReleaseGold instance - -USAGE - $ celocli releasegold:create-account - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - -EXAMPLE - create-account --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 -``` - -_See code: [src/commands/releasegold/create-account.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/create-account.ts)_ - -## `celocli releasegold:locked-gold` - -Perform actions [lock, unlock, withdraw] on CELO that has been locked via the provided ReleaseGold contract. - -``` -Perform actions [lock, unlock, withdraw] on CELO that has been locked via the provided ReleaseGold contract. - -USAGE - $ celocli releasegold:locked-gold - -OPTIONS - -a, --action=lock|unlock|withdraw (required) Action to perform on - contract's celo - - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --value=10000000000000000000000 (required) Amount of celo to - perform `action` with - - --yes Answer yes to prompt - -EXAMPLES - locked-gold --contract 0xCcc8a47BE435F1590809337BB14081b256Ae26A8 --action lock - --value 10000000000000000000000 - - locked-gold --contract 0xCcc8a47BE435F1590809337BB14081b256Ae26A8 --action unlock - --value 10000000000000000000000 - - locked-gold --contract 0xCcc8a47BE435F1590809337BB14081b256Ae26A8 --action withdraw - --value 10000000000000000000000 -``` - -_See code: [src/commands/releasegold/locked-gold.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/locked-gold.ts)_ - -## `celocli releasegold:refund-and-finalize` - -Refund the given contract's balance to the appopriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances. - -``` -Refund the given contract's balance to the appopriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances. - -USAGE - $ celocli releasegold:refund-and-finalize - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - -EXAMPLE - refund-and-finalize --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 -``` - -_See code: [src/commands/releasegold/refund-and-finalize.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/refund-and-finalize.ts)_ - -## `celocli releasegold:revoke` - -Revoke the given contract instance. Once revoked, any Locked Gold can be unlocked by the release owner. The beneficiary will then be able to withdraw any released Gold that had yet to be withdrawn, and the remainder can be transferred by the release owner to the refund address. Note that not all ReleaseGold instances are revokable. - -``` -Revoke the given contract instance. Once revoked, any Locked Gold can be unlocked by the release owner. The beneficiary will then be able to withdraw any released Gold that had yet to be withdrawn, and the remainder can be transferred by the release owner to the refund address. Note that not all ReleaseGold instances are revokable. - -USAGE - $ celocli releasegold:revoke - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --yesreally Override prompt to set - liquidity (be careful!) - -EXAMPLE - revoke --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 -``` - -_See code: [src/commands/releasegold/revoke.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/revoke.ts)_ - -## `celocli releasegold:revoke-votes` - -Revokes `votes` for the given contract's account from the given group's account - -``` -Revokes `votes` for the given contract's account from the given group's account - -USAGE - $ celocli releasegold:revoke-votes - -OPTIONS - --allGroups Revoke all votes from all - groups - - --allVotes Revoke all votes - - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --group=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Address of the group to revoke - votes from - - --votes=votes The number of votes to revoke - -EXAMPLES - revoke-votes --contract 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --group - 0x5409ED021D9299bf6814279A6A1411A7e866A631 --votes 100 - - revoke-votes --contract 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --allVotes - --allGroups -``` - -_See code: [src/commands/releasegold/revoke-votes.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/revoke-votes.ts)_ - -## `celocli releasegold:set-account` - -Set account properties of the ReleaseGold instance account such as name, data encryption key, and the metadata URL - -``` -Set account properties of the ReleaseGold instance account such as name, data encryption key, and the metadata URL - -USAGE - $ celocli releasegold:set-account - -OPTIONS - -p, --property=name|dataEncryptionKey|metaURL (required) Property type to set - - -v, --value=value (required) Property value to - set - - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - -EXAMPLES - set-account --contract 0x5719118266779B58D0f9519383A4A27aA7b829E5 --property name - --value mywallet - - set-account --contract 0x5719118266779B58D0f9519383A4A27aA7b829E5 --property - dataEncryptionKey --value - 0x041bb96e35f9f4b71ca8de561fff55a249ddf9d13ab582bdd09a09e75da68ae4cd0ab7038030f41b2374 - 98b4d76387ae878dc8d98fd6f6db2c15362d1a3bf11216 - - set-account --contract 0x5719118266779B58D0f9519383A4A27aA7b829E5 --property metaURL - --value www.test.com -``` - -_See code: [src/commands/releasegold/set-account.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/set-account.ts)_ - -## `celocli releasegold:set-account-wallet-address` - -Set the ReleaseGold contract account's wallet address - -``` -Set the ReleaseGold contract account's wallet address - -USAGE - $ celocli releasegold:set-account-wallet-address - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - (required) Address of the ReleaseGold Contract - - --globalHelp - View all available global flags - - --pop=pop - ECDSA PoP for signer over contract's account - - --walletAddress=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - (required) Address of wallet to set for contract's account and signer of PoP. 0x0 if - owner wants payers to contact them directly. - -EXAMPLE - set-account-wallet-address --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 - --walletAddress 0xE36Ea790bc9d7AB70C55260C66D52b1eca985f84 --pop - 0x1b3e611d05e46753c43444cdc55c2cc3d95c54da0eba2464a8cc8cb01bd57ae8bb3d82a0e293ca97e581 - 3e7fb9b624127f42ef0871d025d8a56fe2f8f08117e25b -``` - -_See code: [src/commands/releasegold/set-account-wallet-address.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/set-account-wallet-address.ts)_ - -## `celocli releasegold:set-beneficiary` - -Set the beneficiary of the ReleaseGold contract. This command is gated via a multi-sig, so this is expected to be called twice: once by the contract's beneficiary and once by the contract's releaseOwner. Once both addresses call this command with the same parameters, the tx will execute. - -``` -Set the beneficiary of the ReleaseGold contract. This command is gated via a multi-sig, so this is expected to be called twice: once by the contract's beneficiary and once by the contract's releaseOwner. Once both addresses call this command with the same parameters, the tx will execute. - -USAGE - $ celocli releasegold:set-beneficiary - -OPTIONS - --beneficiary=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - new beneficiary - - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address to submit - multisig transaction from - (one of the owners) - - --globalHelp View all available global - flags - - --yesreally Override prompt to set new - beneficiary (be careful!) - -EXAMPLE - set-beneficiary --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 --from - 0xE36Ea790bc9d7AB70C55260C66D52b1eca985f84 --beneficiary - 0x6Ecbe1DB9EF729CBe972C83Fb886247691Fb6beb -``` - -_See code: [src/commands/releasegold/set-beneficiary.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/set-beneficiary.ts)_ - -## `celocli releasegold:set-can-expire` - -Set the canExpire flag for the given ReleaseGold contract - -``` -Set the canExpire flag for the given ReleaseGold contract - -USAGE - $ celocli releasegold:set-can-expire - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --value=(true|false|True|False) (required) canExpire value - - --yesreally Override prompt to set - expiration flag (be careful!) - -EXAMPLE - set-can-expire --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 --value true -``` - -_See code: [src/commands/releasegold/set-can-expire.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/set-can-expire.ts)_ - -## `celocli releasegold:set-liquidity-provision` - -Set the liquidity provision to true, allowing the beneficiary to withdraw released gold. - -``` -Set the liquidity provision to true, allowing the beneficiary to withdraw released gold. - -USAGE - $ celocli releasegold:set-liquidity-provision - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --yesreally Override prompt to set - liquidity (be careful!) - -EXAMPLE - set-liquidity-provision --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 -``` - -_See code: [src/commands/releasegold/set-liquidity-provision.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/set-liquidity-provision.ts)_ - -## `celocli releasegold:set-max-distribution` - -Set the maximum distribution of celo for the given contract - -``` -Set the maximum distribution of celo for the given contract - -USAGE - $ celocli releasegold:set-max-distribution - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --distributionRatio=distributionRatio (required) Amount in range [0, - 1000] (3 significant figures) - indicating % of total balance - available for distribution. - - --globalHelp View all available global flags - - --yesreally Override prompt to set new - maximum distribution (be - careful!) - -EXAMPLE - set-max-distribution --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 - --distributionRatio 1000 -``` - -_See code: [src/commands/releasegold/set-max-distribution.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/set-max-distribution.ts)_ - -## `celocli releasegold:show` - -Show info on a ReleaseGold instance contract. - -``` -Show info on a ReleaseGold instance contract. - -USAGE - $ celocli releasegold:show - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - -EXAMPLE - show --contract 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/releasegold/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/show.ts)_ - -## `celocli releasegold:transfer-dollars` - -Transfer Celo Dollars from the given contract address. Dollars may be accrued to the ReleaseGold contract via validator epoch rewards. - -``` -Transfer Celo Dollars from the given contract address. Dollars may be accrued to the ReleaseGold contract via validator epoch rewards. - -USAGE - $ celocli releasegold:transfer-dollars - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - recipient of Celo Dollars - transfer - - --value=10000000000000000000000 (required) Value (in Wei) of - Celo Dollars to transfer - -EXAMPLE - transfer-dollars --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 --to - 0x6Ecbe1DB9EF729CBe972C83Fb886247691Fb6beb --value 10000000000000000000000 -``` - -_See code: [src/commands/releasegold/transfer-dollars.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/transfer-dollars.ts)_ - -## `celocli releasegold:withdraw` - -Withdraws `value` released celo to the beneficiary address. Fails if `value` worth of celo has not been released yet. - -``` -Withdraws `value` released celo to the beneficiary address. Fails if `value` worth of celo has not been released yet. - -USAGE - $ celocli releasegold:withdraw - -OPTIONS - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --value=10000000000000000000000 (required) Amount of released - celo (in wei) to withdraw - -EXAMPLE - withdraw --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631 --value - 10000000000000000000000 -``` - -_See code: [src/commands/releasegold/withdraw.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/releasegold/withdraw.ts)_ diff --git a/packages/docs/command-line-interface/reserve.md b/packages/docs/command-line-interface/reserve.md index 609a3ef61..54ed71c98 100644 --- a/packages/docs/command-line-interface/reserve.md +++ b/packages/docs/command-line-interface/reserve.md @@ -2,6 +2,7 @@ Shows information about reserve + ## `celocli reserve:status` Shows information about reserve diff --git a/packages/docs/command-line-interface/rewards.md b/packages/docs/command-line-interface/rewards.md index e7749a5d7..11e89e716 100644 --- a/packages/docs/command-line-interface/rewards.md +++ b/packages/docs/command-line-interface/rewards.md @@ -2,6 +2,7 @@ Show rewards information about a voter, registered Validator, or Validator Group + ## `celocli rewards:show` Show rewards information about a voter, registered Validator, or Validator Group diff --git a/packages/docs/command-line-interface/transfer.md b/packages/docs/command-line-interface/transfer.md index 5668c3a34..aa1ab2016 100644 --- a/packages/docs/command-line-interface/transfer.md +++ b/packages/docs/command-line-interface/transfer.md @@ -2,6 +2,7 @@ Transfer CELO and Celo Dollars + ## `celocli transfer:celo` Transfer CELO to a specified address. (Note: this is the equivalent of the old transfer:gold) diff --git a/packages/docs/command-line-interface/validator.md b/packages/docs/command-line-interface/validator.md index 9b48e637e..f5c6a117d 100644 --- a/packages/docs/command-line-interface/validator.md +++ b/packages/docs/command-line-interface/validator.md @@ -2,6 +2,7 @@ View and manage Validators + ## `celocli validator:affiliate ARG1` Affiliate a Validator with a Validator Group. This allows the Validator Group to add that Validator as a member. If the Validator is already a member of a Validator Group, affiliating with a different Group will remove the Validator from the first group's members. diff --git a/packages/docs/command-line-interface/validatorgroup.md b/packages/docs/command-line-interface/validatorgroup.md index 86005d618..80d98f32b 100644 --- a/packages/docs/command-line-interface/validatorgroup.md +++ b/packages/docs/command-line-interface/validatorgroup.md @@ -2,6 +2,7 @@ View and manage Validator Groups + ## `celocli validatorgroup:commission` Manage the commission for a registered Validator Group. This represents the share of the epoch rewards given to elected Validators that goes to the group they are a member of. Updates must be made in a two step process where the group owner first calls uses the queue-update option, then after the required update delay, the apply option. The commission update delay, in blocks, can be viewed with the network:parameters command. A groups next commission update block can be checked with validatorgroup:show