From d1a3d02bb32dbdefb640196e85cbf8ce1ef63b29 Mon Sep 17 00:00:00 2001 From: Nicolas Brugneaux Date: Tue, 30 Jan 2024 11:34:00 +0100 Subject: [PATCH 1/4] chore: add submodule --- .gitmodules | 3 +++ submodules/developer-tooling | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 submodules/developer-tooling diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000000..2fa44adf5c --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "submodules/developer-tooling"] + path = submodules/developer-tooling + url = https://github.com/celo-org/developer-tooling.git diff --git a/submodules/developer-tooling b/submodules/developer-tooling new file mode 160000 index 0000000000..cdba30e76e --- /dev/null +++ b/submodules/developer-tooling @@ -0,0 +1 @@ +Subproject commit cdba30e76e342949cc554ba5b6c1f2f9b6f7ace5 From bcfc4fb24e421153af6b1a73e2835e21effb577b Mon Sep 17 00:00:00 2001 From: Nicolas Brugneaux Date: Tue, 30 Jan 2024 11:35:01 +0100 Subject: [PATCH 2/4] chore: replace files by symlink to submodule --- docs/cli | 1 + docs/cli/account.md | 874 ------------------------------------- docs/cli/autocomplete.md | 31 -- docs/cli/commands.md | 29 -- docs/cli/config.md | 52 --- docs/cli/dkg.md | 131 ------ docs/cli/election.md | 181 -------- docs/cli/exchange.md | 223 ---------- docs/cli/governance.md | 401 ----------------- docs/cli/grandamento.md | 128 ------ docs/cli/help.md | 22 - docs/cli/identity.md | 152 ------- docs/cli/index.md | 119 ----- docs/cli/lockedgold.md | 84 ---- docs/cli/multisig.md | 66 --- docs/cli/network.md | 66 --- docs/cli/node.md | 36 -- docs/cli/oracle.md | 125 ------ docs/cli/plugins.md | 146 ------- docs/cli/releasegold.md | 472 -------------------- docs/cli/reserve.md | 52 --- docs/cli/rewards.md | 60 --- docs/cli/transfer.md | 195 --------- docs/cli/validator.md | 441 ------------------- docs/cli/validatorgroup.md | 200 --------- 25 files changed, 1 insertion(+), 4286 deletions(-) create mode 120000 docs/cli delete mode 100644 docs/cli/account.md delete mode 100644 docs/cli/autocomplete.md delete mode 100644 docs/cli/commands.md delete mode 100644 docs/cli/config.md delete mode 100644 docs/cli/dkg.md delete mode 100644 docs/cli/election.md delete mode 100644 docs/cli/exchange.md delete mode 100644 docs/cli/governance.md delete mode 100644 docs/cli/grandamento.md delete mode 100644 docs/cli/help.md delete mode 100644 docs/cli/identity.md delete mode 100644 docs/cli/index.md delete mode 100644 docs/cli/lockedgold.md delete mode 100644 docs/cli/multisig.md delete mode 100644 docs/cli/network.md delete mode 100644 docs/cli/node.md delete mode 100644 docs/cli/oracle.md delete mode 100644 docs/cli/plugins.md delete mode 100644 docs/cli/releasegold.md delete mode 100644 docs/cli/reserve.md delete mode 100644 docs/cli/rewards.md delete mode 100644 docs/cli/transfer.md delete mode 100644 docs/cli/validator.md delete mode 100644 docs/cli/validatorgroup.md diff --git a/docs/cli b/docs/cli new file mode 120000 index 0000000000..e65ece2707 --- /dev/null +++ b/docs/cli @@ -0,0 +1 @@ +../submodules/developer-tooling/packages/docs/command-line-interface \ No newline at end of file diff --git a/docs/cli/account.md b/docs/cli/account.md deleted file mode 100644 index 2574929f2a..0000000000 --- a/docs/cli/account.md +++ /dev/null @@ -1,874 +0,0 @@ -# `celocli account` - -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. - -``` -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. - -USAGE - $ celocli account:authorize - -OPTIONS - -r, --role=vote|validator|attestation (required) Role to delegate - - --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. - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address - - --globalHelp View all available global flags - - --signature=0x (required) Signature (a.k.a - proof-of-possession) of the - signer key - - --signer=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address - -EXAMPLES - authorize --from 0x5409ED021D9299bf6814279A6A1411A7e866A631 --role vote --signer - 0x6ecbe1db9ef729cbe972c83fb886247691fb6beb --signature - 0x1b9fca4bbb5bfb1dbe69ef1cddbd9b4202dcb6b134c5170611e1e36ecfa468d7b46c85328d504934fce6 - c2a1571603a50ae224d2b32685e84d4d1a1eebad8452eb - - authorize --from 0x5409ED021D9299bf6814279A6A1411A7e866A631 --role validator --signer - 0x6ecbe1db9ef729cbe972c83fb886247691fb6beb --signature - 0x1b9fca4bbb5bfb1dbe69ef1cddbd9b4202dcb6b134c5170611e1e36ecfa468d7b46c85328d504934fce6 - c2a1571603a50ae224d2b32685e84d4d1a1eebad8452eb --blsKey - 0x4fa3f67fc913878b068d1fa1cdddc54913d3bf988dbe5a36a20fa888f20d4894c408a6773f3d7bde1115 - 4f2a3076b700d345a42fd25a0e5e83f4db5586ac7979ac2053cd95d8f2efd3e959571ceccaa743e02cf4be - 3f5d7aaddb0b06fc9aff00 --blsPop - 0xcdb77255037eb68897cd487fdd85388cbda448f617f874449d4b11588b0b7ad8ddc20d9bb450b513bb35 - 664ea3923900 -``` - -_See code: [src/commands/account/authorize.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/authorize.ts)_ - -## `celocli account:balance ADDRESS` - -View Celo Stables and CELO balances for an address - -``` -View Celo Stables and CELO balances for an address - -USAGE - $ celocli account:balance ADDRESS - -OPTIONS - --erc20Address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Address of generic ERC-20 - token to also check balance - for - - --globalHelp View all available global - flags - -EXAMPLES - balance 0x5409ed021d9299bf6814279a6a1411a7e866a631 - - balance 0x5409ed021d9299bf6814279a6a1411a7e866a631 --erc20Address - 0x765DE816845861e75A25fCA122bb6898B8B1282a -``` - -_See code: [src/commands/account/balance.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/balance.ts)_ - -## `celocli account:claim-account FILE` - -Claim another account, and optionally its public key, and add the claim to a local metadata file - -``` -Claim another account, and optionally its public key, and add the claim to a local metadata file - -USAGE - $ celocli account:claim-account FILE - -ARGUMENTS - FILE Path of the metadata file - -OPTIONS - --address=address (required) The address of the - account you want to claim - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the account - to set metadata for or an - authorized signer for the address - in the metadata - - --globalHelp View all available global flags - - --publicKey=publicKey The public key of the account that - others may use to send you - encrypted messages - -EXAMPLE - claim-account ~/metadata.json --address 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/account/claim-account.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/claim-account.ts)_ - -## `celocli account:claim-attestation-service-url FILE` - -Claim the URL of the attestation service and add the claim to a local metadata file - -``` -Claim the URL of the attestation service and add the claim to a local metadata file - -USAGE - $ celocli account:claim-attestation-service-url FILE - -ARGUMENTS - FILE Path of the metadata file - -OPTIONS - --force Ignore URL validity checks - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the account - to set metadata for or an - authorized signer for the address - in the metadata - - --globalHelp View all available global flags - - --url=https://www.celo.org (required) The URL you want to - claim. Should begin http:// - -EXAMPLE - claim-attestation-service-url ~/metadata.json --url https://test.com/myurl --from - 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/account/claim-attestation-service-url.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/claim-attestation-service-url.ts)_ - -## `celocli account:claim-domain FILE` - -Claim a domain and add the claim to a local metadata file - -``` -Claim a domain and add the claim to a local metadata file - -USAGE - $ celocli account:claim-domain FILE - -ARGUMENTS - FILE Path of the metadata file - -OPTIONS - --domain=domain (required) The domain you want to - claim - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the account - to set metadata for or an - authorized signer for the address - in the metadata - - --globalHelp View all available global flags - -EXAMPLE - claim-domain ~/metadata.json --domain test.com --from - 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/account/claim-domain.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/claim-domain.ts)_ - -## `celocli account:claim-keybase FILE` - -Claim a keybase username and add the claim to a local metadata file - -``` -Claim a keybase username and add the claim to a local metadata file - -USAGE - $ celocli account:claim-keybase FILE - -ARGUMENTS - FILE Path of the metadata file - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the account - to set metadata for or an - authorized signer for the address - in the metadata - - --globalHelp View all available global flags - - --username=username (required) The keybase username you - want to claim - -EXAMPLE - claim-keybase ~/metadata.json --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 - --username myusername -``` - -_See code: [src/commands/account/claim-keybase.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/claim-keybase.ts)_ - -## `celocli account:claim-name FILE` - -Claim a name and add the claim to a local metadata file - -``` -Claim a name and add the claim to a local metadata file - -USAGE - $ celocli account:claim-name FILE - -ARGUMENTS - FILE Path of the metadata file - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the account - to set metadata for or an - authorized signer for the address - in the metadata - - --globalHelp View all available global flags - - --name=name (required) The name you want to - claim - -EXAMPLE - claim-name ~/metadata.json --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --name - myname -``` - -_See code: [src/commands/account/claim-name.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/claim-name.ts)_ - -## `celocli account:claim-storage FILE` - -Claim a storage root and add the claim to a local metadata file - -``` -Claim a storage root and add the claim to a local metadata file - -USAGE - $ celocli account:claim-storage FILE - -ARGUMENTS - FILE Path of the metadata file - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the account - to set metadata for or an - authorized signer for the address - in the metadata - - --globalHelp View all available global flags - - --url=https://www.celo.org (required) The URL of the storage - root you want to claim - -EXAMPLE - claim-storage ~/metadata.json --url http://test.com/myurl --from - 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/account/claim-storage.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/claim-storage.ts)_ - -## `celocli account:create-metadata FILE` - -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 - $ celocli account:create-metadata FILE - -ARGUMENTS - FILE Path where the metadata should be saved - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the account - to set metadata for or an - authorized signer for the address - in the metadata - - --globalHelp View all available global flags - -EXAMPLE - create-metadata ~/metadata.json --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/account/create-metadata.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/create-metadata.ts)_ - -## `celocli account:get-metadata ADDRESS` - -Show information about an address. Retreives the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able. - -``` -Show information about an address. Retreives the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able. - -USAGE - $ celocli account:get-metadata ADDRESS - -ARGUMENTS - ADDRESS Address to get metadata for - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) - -EXAMPLE - get-metadata 0x97f7333c51897469E8D98E7af8653aAb468050a3 -``` - -_See code: [src/commands/account/get-metadata.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/get-metadata.ts)_ - -## `celocli account:list` - -List the addresses from the node and the local instance - -``` -List the addresses from the node and the local instance - -USAGE - $ celocli account:list - -OPTIONS - --globalHelp View all available global flags - - --local If set, only show local and hardware wallet accounts. Use no-local to - only show keystore addresses. -``` - -_See code: [src/commands/account/list.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/list.ts)_ - -## `celocli account:lock ACCOUNT` - -Lock an account which was previously unlocked - -``` -Lock an account which was previously unlocked - -USAGE - $ celocli account:lock ACCOUNT - -ARGUMENTS - ACCOUNT Account address - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - lock 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/account/lock.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/lock.ts)_ - -## `celocli account:new` - -Creates a new account locally using the Celo Derivation Path (m/44'/52752'/0/changeIndex/addressIndex) and print out the key information. Save this information for local transaction signing or import into a Celo node. Ledger: this command has been tested swapping mnemonics with the Ledger successfully (only supports english) - -``` -Creates a new account locally using the Celo Derivation Path (m/44'/52752'/0/changeIndex/addressIndex) and print out the key information. Save this information for local transaction signing or import into a Celo node. Ledger: this command has been tested swapping mnemonics with the Ledger successfully (only supports english) - -USAGE - $ celocli account:new - -OPTIONS - --addressIndex=addressIndex - Choose the address index for the derivation path - - --changeIndex=changeIndex - Choose the change index for the derivation path - - --derivationPath=derivationPath - Choose a different derivation Path (Celo's default is "m/44'/52752'/0'"). Use "eth" - as an alias of the Ethereum derivation path ("m/44'/60'/0'"). Recreating the same - account requires knowledge of the mnemonic, passphrase (if any), and the derivation - path - - --globalHelp - View all available global flags - - --language=chinese_simplified|chinese_traditional|english|french|italian|japanese|kore - an|spanish - [default: english] Language for the mnemonic words. **WARNING**, some hardware - wallets don't support other languages - - --mnemonicPath=mnemonicPath - Instead of generating a new mnemonic (seed phrase), use the user-supplied mnemonic - instead. Path to a file that contains all the mnemonic words separated by a space - (example: "word1 word2 word3 ... word24"). If the words are a language other than - English, the --language flag must be used. Only BIP39 mnemonics are supported - - --passphrasePath=passphrasePath - Path to a file that contains the BIP39 passphrase to combine with the mnemonic - specified using the mnemonicPath flag and the index specified using the addressIndex - flag. Every passphrase generates a different private key and wallet address. - -EXAMPLES - new - - new --passphrasePath myFolder/my_passphrase_file - - new --language spanish - - new --passphrasePath some_folder/my_passphrase_file --language japanese --addressIndex - 5 - - new --passphrasePath some_folder/my_passphrase_file --mnemonicPath - some_folder/my_mnemonic_file --addressIndex 5 -``` - -_See code: [src/commands/account/new.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/new.ts)_ - -## `celocli account:offchain-read ADDRESS` - -DEV: Reads the name from offchain storage - -``` -DEV: Reads the name from offchain storage - -USAGE - $ celocli account:offchain-read ADDRESS - -OPTIONS - --bucket=bucket If using a GCP or AWS storage - bucket this parameter is required - - --directory=directory [default: .] To which directory - data should be written - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Account Address - - --globalHelp View all available global flags - - --privateDEK=privateDEK - - --provider=(git|aws|gcp) If the CLI should attempt to push - to the cloud - -EXAMPLES - offchain-read 0x... - - offchain-read 0x... --from 0x... --privateKey 0x... -``` - -_See code: [src/commands/account/offchain-read.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/offchain-read.ts)_ - -## `celocli account:offchain-write` - -DEV: Writes a name to offchain storage - -``` -DEV: Writes a name to offchain storage - -USAGE - $ celocli account:offchain-write - -OPTIONS - --bucket=bucket If using a GCP or AWS storage bucket this parameter is - required - - --directory=directory [default: .] To which directory data should be written - - --encryptTo=encryptTo - - --globalHelp View all available global flags - - --name=name (required) - - --privateDEK=privateDEK - - --privateKey=privateKey (required) - - --provider=(git|aws|gcp) If the CLI should attempt to push to the cloud - -EXAMPLES - offchain-write --name test-account --privateKey 0x... - - offchain-write --name test-account --privateKey 0x... privateDEK 0x... --encryptTo - 0x... -``` - -_See code: [src/commands/account/offchain-write.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/offchain-write.ts)_ - -## `celocli account:proof-of-possession` - -Generate proof-of-possession to be used to authorize a signer. See the "account:authorize" command for more details. - -``` -Generate proof-of-possession to be used to authorize a signer. See the "account:authorize" command for more details. - -USAGE - $ celocli account:proof-of-possession - -OPTIONS - --account=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - account that needs to prove - possession of the signer key. - - --globalHelp View all available global flags - - --signer=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the signer - key to prove possession of. - -EXAMPLE - proof-of-possession --account 0x5409ed021d9299bf6814279a6a1411a7e866a631 --signer - 0x6ecbe1db9ef729cbe972c83fb886247691fb6beb -``` - -_See code: [src/commands/account/proof-of-possession.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/proof-of-possession.ts)_ - -## `celocli account:recover-old` - -Recovers the Valora old account and print out the key information. The old Valora app (in a beta state) generated the user address using a seed of 32 bytes, instead of 64 bytes. As the app fixed that, some old accounts were left with some funds. This command allows the user to recover those funds. - -``` -Recovers the Valora old account and print out the key information. The old Valora app (in a beta state) generated the user address using a seed of 32 bytes, instead of 64 bytes. As the app fixed that, some old accounts were left with some funds. This command allows the user to recover those funds. - -USAGE - $ celocli account:recover-old - -OPTIONS - --addressIndex=addressIndex - Choose the address index for the derivation path - - --changeIndex=changeIndex - Choose the change index for the derivation path - - --derivationPath=derivationPath - Choose a different derivation Path (Celo's default is "m/44'/52752'/0'"). Use "eth" - as an alias of the Ethereum derivation path ("m/44'/60'/0'"). Recreating the same - account requires knowledge of the mnemonic, passphrase (if any), and the derivation - path - - --globalHelp - View all available global flags - - --language=chinese_simplified|chinese_traditional|english|french|italian|japanese|kore - an|spanish - [default: english] Language for the mnemonic words. **WARNING**, some hardware - wallets don't support other languages - - --mnemonicPath=mnemonicPath - (required) Path to a file that contains all the mnemonic words separated by a space - (example: "word1 word2 word3 ... word24"). If the words are a language other than - English, the --language flag must be used. Only BIP39 mnemonics are supported - - --passphrasePath=passphrasePath - Path to a file that contains the BIP39 passphrase to combine with the mnemonic - specified using the mnemonicPath flag and the index specified using the addressIndex - flag. Every passphrase generates a different private key and wallet address. - -EXAMPLES - recover-old --mnemonicPath some_folder/my_mnemonic_file - - recover-old --mnemonicPath some_folder/my_mnemonic_file --passphrasePath - myFolder/my_passphrase_file - - recover-old --mnemonicPath some_folder/my_mnemonic_file --language spanish - - recover-old --mnemonicPath some_folder/my_mnemonic_file --passphrasePath - some_folder/my_passphrase_file --language japanese --addressIndex 5 - - recover-old --mnemonicPath some_folder/my_mnemonic_file --passphrasePath - some_folder/my_passphrase_file --addressIndex 5 -``` - -_See code: [src/commands/account/recover-old.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/recover-old.ts)_ - -## `celocli account:register` - -Register an account on-chain. This allows you to lock Gold, which is a pre-requisite for registering a Validator or Group, participating in Validator elections and on-chain Governance, and earning epoch rewards. - -``` -Register an account on-chain. This allows you to lock Gold, which is a pre-requisite for registering a Validator or Group, participating in Validator elections and on-chain Governance, and earning epoch rewards. - -USAGE - $ celocli account:register - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address - --globalHelp View all available global flags - --name=name - -EXAMPLES - register --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 - - register --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 --name test-account -``` - -_See code: [src/commands/account/register.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/register.ts)_ - -## `celocli account:register-data-encryption-key` - -Register a data encryption key for an account on chain. This key can be used to encrypt data to you such as offchain metadata or transaction comments - -``` -Register a data encryption key for an account on chain. This key can be used to encrypt data to you such as offchain metadata or transaction comments - -USAGE - $ celocli account:register-data-encryption-key - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Addess of the account to - set the data encryption key for - - --globalHelp View all available global flags - - --publicKey=publicKey (required) The public key you want - to register - -EXAMPLE - register-data-encryption-key --publicKey 0x... --from - 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/account/register-data-encryption-key.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/register-data-encryption-key.ts)_ - -## `celocli account:register-metadata` - -Register metadata URL for an account where users will be able to retieve the metadata file and verify your claims - -``` -Register metadata URL for an account where users will be able to retieve the metadata file and verify your claims - -USAGE - $ celocli account:register-metadata - -OPTIONS - -x, --extended show extra columns - - --columns=columns only show provided columns - (comma-separated) - - --csv output is csv format [alias: - --output=csv] - - --filter=filter filter property by partial string - matching, ex: name=foo - - --force Ignore metadata validity checks - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Addess of the account to - set metadata for - - --globalHelp View all available global flags - - --no-header hide table header from output - - --no-truncate do not truncate output to fit - screen - - --output=csv|json|yaml output in a more machine friendly - format - - --sort=sort property to sort by (prepend '-' - for descending) - - --url=https://www.celo.org (required) The url to the metadata - you want to register - -EXAMPLE - register-metadata --url https://www.mywebsite.com/celo-metadata --from - 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/account/register-metadata.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/register-metadata.ts)_ - -## `celocli account:set-name` - -Sets the name of a registered account on-chain. An account's name is an optional human readable identifier - -``` -Sets the name of a registered account on-chain. An account's name is an optional human readable identifier - -USAGE - $ celocli account:set-name - -OPTIONS - --account=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address - --globalHelp View all available global flags - --name=name (required) - -EXAMPLE - set-name --account 0x5409ed021d9299bf6814279a6a1411a7e866a631 --name test-account -``` - -_See code: [src/commands/account/set-name.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/set-name.ts)_ - -## `celocli account:set-wallet` - -Sets the wallet of a registered account on-chain. An account's wallet is an optional wallet associated with an account. Can be set by the account or an account's signer. - -``` -Sets the wallet of a registered account on-chain. An account's wallet is an optional wallet associated with an account. Can be set by the account or an account's signer. - -USAGE - $ celocli account:set-wallet - -OPTIONS - --account=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address - --globalHelp View all available global flags - - --signature=0x Signature (a.k.a. - proof-of-possession) of the - signer key - - --signer=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Address of the signer key to - verify proof of possession. - - --wallet=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address - -EXAMPLES - set-wallet --account 0x5409ed021d9299bf6814279a6a1411a7e866a631 --wallet - 0x5409ed021d9299bf6814279a6a1411a7e866a631 - - set-wallet --account 0x5409ed021d9299bf6814279a6a1411a7e866a631 --wallet - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --signer - 0x0EdeDF7B1287f07db348997663EeEb283D70aBE7 --signature - 0x1c5efaa1f7ca6484d49ccce76217e2fba0552c0b23462cff7ba646473bc2717ffc4ce45be89bd5be9b5d - 23305e87fc2896808467c4081d9524a84c01b89ec91ca3 -``` - -_See code: [src/commands/account/set-wallet.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/set-wallet.ts)_ - -## `celocli account:show ADDRESS` - -Show information for an account, including name, authorized vote, validator, and attestation signers, the URL at which account metadata is hosted, the address the account is using with the mobile wallet, and a public key that can be used to encrypt information for the account. - -``` -Show information for an account, including name, authorized vote, validator, and attestation signers, the URL at which account metadata is hosted, the address the account is using with the mobile wallet, and a public key that can be used to encrypt information for the account. - -USAGE - $ celocli account:show ADDRESS - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - show 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/account/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/show.ts)_ - -## `celocli account:show-claimed-accounts ADDRESS` - -Show information about claimed accounts - -``` -Show information about claimed accounts - -USAGE - $ celocli account:show-claimed-accounts ADDRESS - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - show-claimed-accounts 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/account/show-claimed-accounts.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/show-claimed-accounts.ts)_ - -## `celocli account:show-metadata FILE` - -Show the data in a local metadata file - -``` -Show the data in a local metadata file - -USAGE - $ celocli account:show-metadata FILE - -ARGUMENTS - FILE Path of the metadata file - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) - -EXAMPLE - show-metadata ~/metadata.json -``` - -_See code: [src/commands/account/show-metadata.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/show-metadata.ts)_ - -## `celocli account:unlock ACCOUNT` - -Unlock an account address to send transactions or validate blocks - -``` -Unlock an account address to send transactions or validate blocks - -USAGE - $ celocli account:unlock ACCOUNT - -ARGUMENTS - ACCOUNT Account address - -OPTIONS - --duration=duration Duration in seconds to leave the account unlocked. Unlocks until - the node exits by default. - - --globalHelp View all available global flags - - --password=password Password used to unlock the account. If not specified, you will - be prompted for a password. - -EXAMPLES - unlock 0x5409ed021d9299bf6814279a6a1411a7e866a631 - - unlock 0x5409ed021d9299bf6814279a6a1411a7e866a631 --duration 600 -``` - -_See code: [src/commands/account/unlock.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/unlock.ts)_ - -## `celocli account:verify-proof-of-possession` - -Verify a proof-of-possession. See the "account:proof-of-possession" command for more details. - -``` -Verify a proof-of-possession. See the "account:proof-of-possession" command for more details. - -USAGE - $ celocli account:verify-proof-of-possession - -OPTIONS - --account=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - account that needs to prove - possession of the signer key. - - --globalHelp View all available global flags - - --signature=0x (required) Signature (a.k.a. - proof-of-possession) of the - signer key - - --signer=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the signer - key to verify proof of - possession. - -EXAMPLE - verify-proof-of-possession --account 0x199eDF79ABCa29A2Fa4014882d3C13dC191A5B58 - --signer 0x0EdeDF7B1287f07db348997663EeEb283D70aBE7 --signature - 0x1c5efaa1f7ca6484d49ccce76217e2fba0552c0b23462cff7ba646473bc2717ffc4ce45be89bd5be9b5d - 23305e87fc2896808467c4081d9524a84c01b89ec91ca3 -``` - -_See code: [src/commands/account/verify-proof-of-possession.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/account/verify-proof-of-possession.ts)_ diff --git a/docs/cli/autocomplete.md b/docs/cli/autocomplete.md deleted file mode 100644 index 637aea9f76..0000000000 --- a/docs/cli/autocomplete.md +++ /dev/null @@ -1,31 +0,0 @@ -# `celocli autocomplete` - -display autocomplete installation instructions - -## `celocli autocomplete [SHELL]` - -display autocomplete installation instructions - -``` -display autocomplete installation instructions - -USAGE - $ celocli autocomplete [SHELL] - -ARGUMENTS - SHELL shell type - -OPTIONS - -r, --refresh-cache Refresh cache (ignores displaying instructions) - -EXAMPLES - $ celocli autocomplete - - $ celocli autocomplete bash - - $ celocli autocomplete zsh - - $ celocli autocomplete --refresh-cache -``` - -_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.5/src/commands/autocomplete/index.ts)_ diff --git a/docs/cli/commands.md b/docs/cli/commands.md deleted file mode 100644 index 3f41eeb12b..0000000000 --- a/docs/cli/commands.md +++ /dev/null @@ -1,29 +0,0 @@ -# `celocli commands` - -list all the commands - -## `celocli commands` - -list all the commands - -``` -list all the commands - -USAGE - $ celocli commands - -OPTIONS - -h, --help show CLI help - -j, --json display unfiltered api data in json format - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --hidden show hidden commands - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) -``` - -_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v1.3.0/src/commands/commands.ts)_ diff --git a/docs/cli/config.md b/docs/cli/config.md deleted file mode 100644 index f12100b072..0000000000 --- a/docs/cli/config.md +++ /dev/null @@ -1,52 +0,0 @@ -# `celocli config` - -Configure CLI options which persist across commands - -## `celocli config:get` - -Output network node configuration - -``` -Output network node configuration - -USAGE - $ celocli config:get - -OPTIONS - --globalHelp View all available global flags -``` - -_See code: [src/commands/config/get.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/config/get.ts)_ - -## `celocli config:set` - -Configure running node information for propogating transactions to network - -``` -Configure running node information for propogating transactions to network - -USAGE - $ celocli config:set - -OPTIONS - -n, --node=node - URL of the node to run commands against (defaults to 'http://localhost:8545') - - --gasCurrency=(auto|Auto|CELO|celo|cUSD|cusd|cEUR|ceur|cREAL|creal) - Use a specific gas currency for transaction fees (defaults to 'auto' which uses - whatever feeCurrency is available) - - --globalHelp - View all available global flags - -EXAMPLES - set --node ws://localhost:2500 - - set --node /geth.ipc - - set --gasCurrency cUSD - - set --gasCurrency CELO -``` - -_See code: [src/commands/config/set.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/config/set.ts)_ diff --git a/docs/cli/dkg.md b/docs/cli/dkg.md deleted file mode 100644 index d8d6918956..0000000000 --- a/docs/cli/dkg.md +++ /dev/null @@ -1,131 +0,0 @@ -# `celocli dkg` - -Publish your locally computed DKG results to the blockchain - -## `celocli dkg:allowlist` - -Allowlist an address in the DKG - -``` -Allowlist an address in the DKG - -USAGE - $ celocli dkg:allowlist - -OPTIONS - --address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags - - --participantAddress=participantAddress (required) Address of the - participant to allowlist -``` - -_See code: [src/commands/dkg/allowlist.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/allowlist.ts)_ - -## `celocli dkg:deploy` - -Deploys the DKG smart contract - -``` -Deploys the DKG smart contract - -USAGE - $ celocli dkg:deploy - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags - - --phaseDuration=phaseDuration (required) Duration of each DKG - phase in blocks - - --threshold=threshold (required) The threshold to use for - the DKG -``` - -_See code: [src/commands/dkg/deploy.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/deploy.ts)_ - -## `celocli dkg:get` - -Gets data from the contract to run the next phase - -``` -Gets data from the contract to run the next phase - -USAGE - $ celocli dkg:get - -OPTIONS - --address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG - Contract Address - - --globalHelp View all - available global - flags - - --method=(shares|responses|justifications|participants|phase|group) (required) Getter - method to call -``` - -_See code: [src/commands/dkg/get.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/get.ts)_ - -## `celocli dkg:publish` - -Publishes data for each phase of the DKG - -``` -Publishes data for each phase of the DKG - -USAGE - $ celocli dkg:publish - -OPTIONS - --address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address - - --data=data (required) Path to the data - being published - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - - --globalHelp View all available global flags -``` - -_See code: [src/commands/dkg/publish.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/publish.ts)_ - -## `celocli dkg:register` - -Register a public key in the DKG - -``` -Register a public key in the DKG - -USAGE - $ celocli dkg:register - -OPTIONS - --address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address - --blsKey=blsKey (required) - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags -``` - -_See code: [src/commands/dkg/register.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/register.ts)_ - -## `celocli dkg:start` - -Starts the DKG - -``` -Starts the DKG - -USAGE - $ celocli dkg:start - -OPTIONS - --address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags -``` - -_See code: [src/commands/dkg/start.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/start.ts)_ diff --git a/docs/cli/election.md b/docs/cli/election.md deleted file mode 100644 index 989f2dbb51..0000000000 --- a/docs/cli/election.md +++ /dev/null @@ -1,181 +0,0 @@ -# `celocli election` - -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. - -``` -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. - -USAGE - $ celocli election:activate - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Voter's address - --globalHelp View all available global flags - - --wait Wait until all pending votes can be - activated - -EXAMPLES - activate --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 - - activate --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --wait -``` - -_See code: [src/commands/election/activate.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/election/activate.ts)_ - -## `celocli election:current` - -Outputs the set of validators currently participating in BFT to create blocks. An election is run to select the validator set at the end of every epoch. - -``` -Outputs the set of validators currently participating in BFT to create blocks. An election is run to select the validator set at the end of every epoch. - -USAGE - $ celocli election:current - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) - - --valset Show currently used signers from valset (by default the - authorized validator signers are shown). Useful for checking - if keys have been rotated. -``` - -_See code: [src/commands/election/current.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/election/current.ts)_ - -## `celocli election:list` - -Prints the list of validator groups, the number of votes they have received, the number of additional votes they are able to receive, and whether or not they are eligible to elect validators. - -``` -Prints the list of validator groups, the number of votes they have received, the number of additional votes they are able to receive, and whether or not they are eligible to elect validators. - -USAGE - $ celocli election:list - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) - -EXAMPLE - list -``` - -_See code: [src/commands/election/list.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/election/list.ts)_ - -## `celocli election:revoke` - -Revoke votes for a Validator Group in validator elections. - -``` -Revoke votes for a Validator Group in validator elections. - -USAGE - $ celocli election:revoke - -OPTIONS - --for=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) ValidatorGroup's address - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Voter's address - --globalHelp View all available global flags - --value=value (required) Value of votes to revoke - -EXAMPLE - revoke --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --for - 0x932fee04521f5fcb21949041bf161917da3f588b, --value 1000000 -``` - -_See code: [src/commands/election/revoke.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/election/revoke.ts)_ - -## `celocli election:run` - -Runs a "mock" election and prints out the validators that would be elected if the epoch ended right now. - -``` -Runs a "mock" election and prints out the validators that would be elected if the epoch ended right now. - -USAGE - $ celocli election:run - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) -``` - -_See code: [src/commands/election/run.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/election/run.ts)_ - -## `celocli election:show ADDRESS` - -Show election information about a voter or registered Validator Group - -``` -Show election information about a voter or registered Validator Group - -USAGE - $ celocli election:show ADDRESS - -ARGUMENTS - ADDRESS Voter or Validator Groups's address - -OPTIONS - --globalHelp View all available global flags - --group Show information about a group running in Validator elections - --voter Show information about an account voting in Validator elections - -EXAMPLES - show 0x97f7333c51897469E8D98E7af8653aAb468050a3 --voter - - show 0x97f7333c51897469E8D98E7af8653aAb468050a3 --group -``` - -_See code: [src/commands/election/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/election/show.ts)_ - -## `celocli election:vote` - -Vote for a Validator Group in validator elections. - -``` -Vote for a Validator Group in validator elections. - -USAGE - $ celocli election:vote - -OPTIONS - --for=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) ValidatorGroup's address - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Voter's address - --globalHelp View all available global flags - - --value=value (required) Amount of Gold used to - vote for group - -EXAMPLE - vote --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --for - 0x932fee04521f5fcb21949041bf161917da3f588b, --value 1000000 -``` - -_See code: [src/commands/election/vote.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/election/vote.ts)_ diff --git a/docs/cli/exchange.md b/docs/cli/exchange.md deleted file mode 100644 index 71a4a6aef4..0000000000 --- a/docs/cli/exchange.md +++ /dev/null @@ -1,223 +0,0 @@ -# `celocli exchange` - -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) - -``` -Exchange CELO for StableTokens via the stability mechanism. (Note: this is the equivalent of the old exchange:gold) - -USAGE - $ celocli exchange:celo - -OPTIONS - --forAtLeast=10000000000000000000000 [default: 0] Optional, the minimum - value of StableTokens to receive in - return - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with CELO to - exchange - - --globalHelp View all available global flags - - --stableToken=(cUSD|cusd|cEUR|ceur|cREAL|creal) [default: cUSD] Name of the stable - to receive - - --value=10000000000000000000000 (required) The value of CELO to - exchange for a StableToken - -EXAMPLES - celo --value 5000000000000 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - - celo --value 5000000000000 --forAtLeast 100000000000000 --from - 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d --stableToken cStableTokenSymbol -``` - -_See code: [src/commands/exchange/celo.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/exchange/celo.ts)_ - -## `celocli exchange:dollars` - -Exchange Celo Dollars for CELO via the stability mechanism - -``` -Exchange Celo Dollars for CELO via the stability mechanism - -USAGE - $ celocli exchange:dollars - -OPTIONS - --forAtLeast=10000000000000000000000 [default: 0] Optional, the minimum - value of CELO to receive in return - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with Celo - Dollars to exchange - - --globalHelp View all available global flags - - --value=10000000000000000000000 (required) The value of Celo - Dollars to exchange for CELO - -EXAMPLES - dollars --value 10000000000000 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - - dollars --value 10000000000000 --forAtLeast 50000000000000 --from - 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d -``` - -_See code: [src/commands/exchange/dollars.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/exchange/dollars.ts)_ - -## `celocli exchange:euros` - -Exchange Celo Euros for CELO via the stability mechanism - -``` -Exchange Celo Euros for CELO via the stability mechanism - -USAGE - $ celocli exchange:euros - -OPTIONS - --forAtLeast=10000000000000000000000 [default: 0] Optional, the minimum - value of CELO to receive in return - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with Celo - Euros to exchange - - --globalHelp View all available global flags - - --value=10000000000000000000000 (required) The value of Celo Euros - to exchange for CELO - -EXAMPLES - euros --value 10000000000000 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - - euros --value 10000000000000 --forAtLeast 50000000000000 --from - 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d -``` - -_See code: [src/commands/exchange/euros.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/exchange/euros.ts)_ - -## `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 - $ celocli exchange:gold - -OPTIONS - --forAtLeast=10000000000000000000000 [default: 0] Optional, the minimum - value of StableTokens to receive in - return - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with CELO to - exchange - - --globalHelp View all available global flags - - --stableToken=(cUSD|cusd|cEUR|ceur|cREAL|creal) [default: cUSD] Name of the stable - to receive - - --value=10000000000000000000000 (required) The value of CELO to - exchange for a StableToken - -EXAMPLES - gold --value 5000000000000 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - - gold --value 5000000000000 --forAtLeast 100000000000000 --from - 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d --stableToken cUSD -``` - -_See code: [src/commands/exchange/gold.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/exchange/gold.ts)_ - -## `celocli exchange:reals` - -Exchange Celo Brazilian Real (cBRL) for CELO via the stability mechanism - -``` -Exchange Celo Brazilian Real (cBRL) for CELO via the stability mechanism - -USAGE - $ celocli exchange:reals - -OPTIONS - --forAtLeast=10000000000000000000000 [default: 0] Optional, the minimum - value of CELO to receive in return - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with Celo - Brazilian Real to exchange - - --globalHelp View all available global flags - - --value=10000000000000000000000 (required) The value of Celo - Brazilian Real to exchange for CELO - -EXAMPLES - reals --value 10000000000000 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - - reals --value 10000000000000 --forAtLeast 50000000000000 --from - 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d -``` - -_See code: [src/commands/exchange/reals.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/exchange/reals.ts)_ - -## `celocli exchange:show` - -Show the current exchange rates offered by the Exchange - -``` -Show the current exchange rates offered by the Exchange - -USAGE - $ celocli exchange:show - -OPTIONS - --amount=amount [default: 1000000000000000000] Amount of the token being exchanged to - report rates for - - --globalHelp View all available global flags - -EXAMPLE - list -``` - -_See code: [src/commands/exchange/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/exchange/show.ts)_ - -## `celocli exchange:stable` - -Exchange Stable Token for CELO via the stability mechanism - -``` -Exchange Stable Token for CELO via the stability mechanism - -USAGE - $ celocli exchange:stable - -OPTIONS - --forAtLeast=10000000000000000000000 [default: 0] Optional, the minimum - value of CELO to receive in return - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with the - Stable Token to exchange - - --globalHelp View all available global flags - - --stableToken=(cUSD|cusd|cEUR|ceur|cREAL|creal) Name of the stable token to be - transfered - - --value=10000000000000000000000 (required) The value of Stable - Tokens to exchange for CELO - -EXAMPLES - stable --value 10000000000000 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - --stableToken cStableTokenSymbol - - stable --value 10000000000000 --forAtLeast 50000000000000 --from - 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d --stableToken cStableTokenSymbol -``` - -_See code: [src/commands/exchange/stable.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/exchange/stable.ts)_ diff --git a/docs/cli/governance.md b/docs/cli/governance.md deleted file mode 100644 index 18fd5707aa..0000000000 --- a/docs/cli/governance.md +++ /dev/null @@ -1,401 +0,0 @@ -# `celocli governance` - -Interact with on-chain governance proposals and hotfixes - -## `celocli governance:build-proposal` - -Interactively build a governance proposal - -``` -Interactively build a governance proposal - -USAGE - $ celocli governance:build-proposal - -OPTIONS - --afterExecutingID=afterExecutingID Governance proposal identifier which - will be executed prior to proposal - being built - - --afterExecutingProposal=afterExecutingProposal Path to proposal which will be - executed prior to proposal being - built - - --globalHelp View all available global flags - - --output=output [default: proposalTransactions.json] - Path to output - -EXAMPLE - build-proposal --output ./transactions.json -``` - -_See code: [src/commands/governance/build-proposal.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/build-proposal.ts)_ - -## `celocli governance:dequeue` - -Try to dequeue governance proposal - -``` -Try to dequeue governance proposal - -USAGE - $ celocli governance:dequeue - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) From address - --globalHelp View all available global flags - -EXAMPLE - dequeue --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/dequeue.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/dequeue.ts)_ - -## `celocli governance:execute` - -Execute a passing governance proposal - -``` -Execute a passing governance proposal - -USAGE - $ celocli governance:execute - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Executor's address - --globalHelp View all available global flags - - --proposalID=proposalID (required) UUID of proposal to - execute - -EXAMPLE - execute --proposalID 99 --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/execute.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/execute.ts)_ - -## `celocli governance:executehotfix` - -Execute a governance hotfix prepared for the current epoch - -``` -Execute a governance hotfix prepared for the current epoch - -USAGE - $ celocli governance:executehotfix - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Executors's address - --globalHelp View all available global flags - - --jsonTransactions=jsonTransactions (required) Path to json - transactions - - --salt=salt (required) Secret salt associated - with hotfix - -EXAMPLE - executehotfix --jsonTransactions ./transactions.json --salt - 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --from - 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/executehotfix.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/executehotfix.ts)_ - -## `celocli governance:hashhotfix` - -Hash a governance hotfix specified by JSON and a salt - -``` -Hash a governance hotfix specified by JSON and a salt - -USAGE - $ celocli governance:hashhotfix - -OPTIONS - --force Skip execution check - --globalHelp View all available global flags - - --jsonTransactions=jsonTransactions (required) Path to json transactions of the - hotfix - - --salt=salt (required) Secret salt associated with hotfix - -EXAMPLE - hashhotfix --jsonTransactions ./transactions.json --salt - 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 -``` - -_See code: [src/commands/governance/hashhotfix.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/hashhotfix.ts)_ - -## `celocli governance:list` - -List live governance proposals (queued and ongoing) - -``` -List live governance proposals (queued and ongoing) - -USAGE - $ celocli governance:list - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) - -EXAMPLE - list -``` - -_See code: [src/commands/governance/list.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/list.ts)_ - -## `celocli governance:preparehotfix` - -Prepare a governance hotfix for execution in the current epoch - -``` -Prepare a governance hotfix for execution in the current epoch - -USAGE - $ celocli governance:preparehotfix - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Preparer's address - --globalHelp View all available global flags - - --hash=hash (required) Hash of hotfix - transactions - -EXAMPLE - preparehotfix --hash - 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --from - 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/preparehotfix.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/preparehotfix.ts)_ - -## `celocli governance:propose` - -Submit a governance proposal - -``` -Submit a governance proposal - -USAGE - $ celocli governance:propose - -OPTIONS - --afterExecutingID=afterExecutingID Governance proposal identifier - which will be executed prior to - proposal - - --afterExecutingProposal=afterExecutingProposal Path to proposal which will be - executed prior to proposal - - --deposit=deposit (required) Amount of Gold to attach - to proposal - - --descriptionURL=descriptionURL (required) A URL where further - information about the proposal can - be viewed - - --force Skip execution check - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Proposer's address - - --globalHelp View all available global flags - - --jsonTransactions=jsonTransactions (required) Path to json - transactions - -EXAMPLE - propose --jsonTransactions ./transactions.json --deposit 10000 --from - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --descriptionURL - https://gist.github.com/yorhodes/46430eacb8ed2f73f7bf79bef9d58a33 -``` - -_See code: [src/commands/governance/propose.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/propose.ts)_ - -## `celocli governance:revokeupvote` - -Revoke upvotes for queued governance proposals - -``` -Revoke upvotes for queued governance proposals - -USAGE - $ celocli governance:revokeupvote - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Upvoter's address - --globalHelp View all available global flags - -EXAMPLE - revokeupvote --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/revokeupvote.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/revokeupvote.ts)_ - -## `celocli governance:show` - -Show information about a governance proposal, hotfix, or account. - -``` -Show information about a governance proposal, hotfix, or account. - -USAGE - $ celocli governance:show - -OPTIONS - --account=account Address of account or voter - - --afterExecutingID=afterExecutingID Governance proposal identifier which - will be executed prior to proposal - - --afterExecutingProposal=afterExecutingProposal Path to proposal which will be - executed prior to proposal - - --globalHelp View all available global flags - - --hotfix=hotfix Hash of hotfix proposal - - --jsonTransactions=jsonTransactions Output proposal JSON to provided file - - --nonwhitelisters If set, displays validators that have - not whitelisted the hotfix. - - --notwhitelisted List validators who have not - whitelisted the specified hotfix - - --proposalID=proposalID UUID of proposal to view - - --raw Display proposal in raw bytes format - - --whitelisters If set, displays validators that have - whitelisted the hotfix. - -ALIASES - $ celocli governance:show - $ celocli governance:showhotfix - $ celocli governance:showaccount - $ celocli governance:view - $ celocli governance:viewhotfix - $ celocli governance:viewaccount - -EXAMPLES - show --proposalID 99 - - show --proposalID 99 --raw - - show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 - - show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 - --whitelisters - - show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 - --nonwhitelisters - - show --account 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 -``` - -_See code: [src/commands/governance/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/show.ts)_ - -## `celocli governance:upvote` - -Upvote a queued governance proposal - -``` -Upvote a queued governance proposal - -USAGE - $ celocli governance:upvote - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Upvoter's address - --globalHelp View all available global flags - - --proposalID=proposalID (required) UUID of proposal to - upvote - -EXAMPLE - upvote --proposalID 99 --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/upvote.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/upvote.ts)_ - -## `celocli governance:vote` - -Vote on an approved governance proposal - -``` -Vote on an approved governance proposal - -USAGE - $ celocli governance:vote - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Voter's address - --globalHelp View all available global flags - - --proposalID=proposalID (required) UUID of proposal to vote - on - - --value=(Abstain|No|Yes) (required) Vote - -EXAMPLE - vote --proposalID 99 --value Yes --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/vote.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/vote.ts)_ - -## `celocli governance:whitelisthotfix` - -Whitelist a governance hotfix - -``` -Whitelist a governance hotfix - -USAGE - $ celocli governance:whitelisthotfix - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Whitelister's address - --globalHelp View all available global flags - - --hash=hash (required) Hash of hotfix - transactions - -EXAMPLE - whitelisthotfix --hash - 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --from - 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/whitelisthotfix.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/whitelisthotfix.ts)_ - -## `celocli governance:withdraw` - -Withdraw refunded governance proposal deposits. - -``` -Withdraw refunded governance proposal deposits. - -USAGE - $ celocli governance:withdraw - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Proposer's address - --globalHelp View all available global flags - -EXAMPLE - withdraw --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/governance/withdraw.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/governance/withdraw.ts)_ diff --git a/docs/cli/grandamento.md b/docs/cli/grandamento.md deleted file mode 100644 index bd9fc84ca9..0000000000 --- a/docs/cli/grandamento.md +++ /dev/null @@ -1,128 +0,0 @@ -# `celocli grandamento` - -Cancels a Granda Mento exchange proposal - -## `celocli grandamento:cancel` - -Cancels a Granda Mento exchange proposal - -``` -Cancels a Granda Mento exchange proposal - -USAGE - $ celocli grandamento:cancel - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address allowed to - cancel the proposal - - --globalHelp View all available global flags - - --proposalID=proposalID (required) UUID of proposal to view -``` - -_See code: [src/commands/grandamento/cancel.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/grandamento/cancel.ts)_ - -## `celocli grandamento:execute` - -Executes a Granda Mento exchange proposal - -``` -Executes a Granda Mento exchange proposal - -USAGE - $ celocli grandamento:execute - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address to execute - the exchange proposal - - --globalHelp View all available global flags - - --proposalID=proposalID (required) UUID of proposal to view -``` - -_See code: [src/commands/grandamento/execute.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/grandamento/execute.ts)_ - -## `celocli grandamento:get-buy-amount` - -Gets the buy amount for a prospective Granda Mento exchange - -``` -Gets the buy amount for a prospective Granda Mento exchange - -USAGE - $ celocli grandamento:get-buy-amount - -OPTIONS - --globalHelp View all available global flags - --sellCelo=(true|false) (required) Sell or buy CELO - - --stableToken=(cUSD|cusd|cEUR|ceur|cREAL|creal) (required) [default: cUSD] Name of - the stable to receive or send - - --value=10000000000000000000000 (required) The value of the tokens to - exchange -``` - -_See code: [src/commands/grandamento/get-buy-amount.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/grandamento/get-buy-amount.ts)_ - -## `celocli grandamento:list` - -List current active Granda Mento exchange proposals - -``` -List current active Granda Mento exchange proposals - -USAGE - $ celocli grandamento:list - -OPTIONS - --globalHelp View all available global flags -``` - -_See code: [src/commands/grandamento/list.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/grandamento/list.ts)_ - -## `celocli grandamento:propose` - -Proposes a Granda Mento exchange - -``` -Proposes a Granda Mento exchange - -USAGE - $ celocli grandamento:propose - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with tokens - to exchange - - --globalHelp View all available global flags - - --sellCelo=(true|false) (required) Sell or buy CELO - - --stableToken=(cUSD|cusd|cEUR|ceur|cREAL|creal) (required) [default: cUSD] Name of - the stable to receive or send - - --value=10000000000000000000000 (required) The value of the tokens - to exchange -``` - -_See code: [src/commands/grandamento/propose.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/grandamento/propose.ts)_ - -## `celocli grandamento:show` - -Shows details of a Granda Mento exchange proposal - -``` -Shows details of a Granda Mento exchange proposal - -USAGE - $ celocli grandamento:show - -OPTIONS - --globalHelp View all available global flags - --proposalID=proposalID (required) UUID of proposal to view -``` - -_See code: [src/commands/grandamento/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/grandamento/show.ts)_ diff --git a/docs/cli/help.md b/docs/cli/help.md deleted file mode 100644 index db356126ea..0000000000 --- a/docs/cli/help.md +++ /dev/null @@ -1,22 +0,0 @@ -# `celocli help` - -display help for celocli - -## `celocli help [COMMAND]` - -display help for celocli - -``` -display help for <%= config.bin %> - -USAGE - $ celocli help [COMMAND] - -ARGUMENTS - COMMAND command to show help for - -OPTIONS - --all see all commands in CLI -``` - -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v1.2.11/src/commands/help.ts)_ diff --git a/docs/cli/identity.md b/docs/cli/identity.md deleted file mode 100644 index bc077a1bf8..0000000000 --- a/docs/cli/identity.md +++ /dev/null @@ -1,152 +0,0 @@ -# `celocli identity` - -Interact with ODIS and the attestations service - -## `celocli identity:current-attestation-services` - -Outputs the set of validators currently participating in BFT and which ones are participating in Celo's lightweight identity protocol - -``` -Outputs the set of validators currently participating in BFT and which ones are participating in Celo's lightweight identity protocol - -USAGE - $ celocli identity:current-attestation-services - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) -``` - -_See code: [src/commands/identity/current-attestation-services.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/identity/current-attestation-services.ts)_ - -## `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. - -``` -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. - -USAGE - $ celocli identity:get-attestations - -OPTIONS - --from=from Account whose balance to use for querying ODIS for the - pepper lookup - - --globalHelp View all available global flags - - --identifier=identifier On-chain identifier - - --network=network The ODIS service to hit: mainnet, alfajores, - alfajoresstaging - - --pepper=pepper ODIS phone number pepper - - --phoneNumber=phoneNumber Phone number to check attestations for - -EXAMPLES - get-attestations --phoneNumber +15555555555 --from - 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 - - get-attestations --phoneNumber +15555555555 --pepper XgnKVpplZc0p1 - - get-attestations --identifier - 0x4952c9db9c283a62721b13f56c4b5e84a438e2569af3de21cb3440efa8840872 -``` - -_See code: [src/commands/identity/get-attestations.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/identity/get-attestations.ts)_ - -## `celocli identity:identifier` - -Queries ODIS for the on-chain identifier and pepper corresponding to a given phone number. - -``` -Queries ODIS for the on-chain identifier and pepper corresponding to a given phone number. - -USAGE - $ celocli identity:identifier - -OPTIONS - --context=context mainnet (default), alfajores, or - alfajoresstaging - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address from which - to perform the query - - --globalHelp View all available global flags - - --phoneNumber=+14152223333 (required) The phone number for - which to query the identifier. - Should be in e164 format with - country code. - -EXAMPLE - identifier --phoneNumber +14151231234 --from - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --context alfajores -``` - -_See code: [src/commands/identity/identifier.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/identity/identifier.ts)_ - -## `celocli identity:test-attestation-service` - -Tests whether the account has setup the attestation service properly by calling the test endpoint on it - -``` -Tests whether the account has setup the attestation service properly by calling the test endpoint on it - -USAGE - $ celocli identity:test-attestation-service - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Your validator's signer - or account address - - --globalHelp View all available global flags - - --message=message (required) The message of the SMS - - --phoneNumber=+14152223333 (required) The phone number to send - the test message to - - --provider=provider Test a specific provider (try - "twilio" or "nexmo") - -EXAMPLE - test-attestation-service --from 0x97f7333c51897469E8D98E7af8653aAb468050a3 -``` - -_See code: [src/commands/identity/test-attestation-service.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/identity/test-attestation-service.ts)_ - -## `celocli identity:withdraw-attestation-rewards` - -Withdraw accumulated attestation rewards for a given currency - -``` -Withdraw accumulated attestation rewards for a given currency - -USAGE - $ celocli identity:withdraw-attestation-rewards - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address to - withdraw from. Can be the - attestation signer address - or the underlying account - address - - --globalHelp View all available global - flags - - --tokenAddress=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d The address of the token - that will be withdrawn. - Defaults to cUSD -``` - -_See code: [src/commands/identity/withdraw-attestation-rewards.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/identity/withdraw-attestation-rewards.ts)_ diff --git a/docs/cli/index.md b/docs/cli/index.md deleted file mode 100644 index 58d3328840..0000000000 --- a/docs/cli/index.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Celo CLI -description: The Command Line Interface allows users to interact with the Celo Protocol smart contracts. -sidebar_position: 1 ---- - -# Celo CLI - -Introduction to the Celo Command Line Interface and installation instructions. - -## What is the Celo CLI - -The Command Line Interface allows users to interact with the Celo Protocol smart contracts. - -It’s a command-line interface around the ContractKit. It allows you to interact with the Celo Protocol and smart contracts using command-line tools rather than writing JavaScript. It provides modules for interacting with modules on the ContractKit and is an excellent code reference when defining your own modules. Some common features you may want to consider are helping users participate in elections or in on-chain governance, voting for validators, or helping users interact with multi-sig contracts. - -## 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 -``` - -:::info - -We are currently deploying the CLI with only Node.js v18.14.2 support. 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 18.14.2 && nvm use 18.14.2` - -::: - -:::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`. - -::: - -## Commands - -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. - -:::info - -All balances of CELO or Celo Dollars are expressed in units of 10^-18. - -::: - -You can find the Celo CLI package on NPM [here](https://www.npmjs.com/package/@celo/celocli). - -To see all available commands, run `celocli commands`. - -To see all available flags for a command, add the flag `--globalHelp` to the command. - -## Optional: Run a Full Node - -Commands need to connect to a Celo node to execute most functionality. You can either use [Forno](/network/node/forno) (this is the easiest way) or run your own full node if you prefer. See the [Running a Full Node](/network/mainnet/run-full-node) instructions for more details on running a full node. - -The easiest way to connect `celocli` to the Celo network is by running the following command in your terminal with `celocli` installed: - -```bash -celocli config:set --node=https://forno.celo.org -``` - -You can verify that `celocli` is connected by running - -```bash -celocli config:get -``` - -## Import Accounts - -If you are connecting to a remote node (like Forno), Celo CLI will need to sign transactions locally before sending them. To do this, Celo CLI needs access to a private key. There are a couple ways to sign transactions using Celo CLI. - -### Import Private Key (less secure) - -Add the `--privateKey` flag followed by the private key associated with the sending account. For example: - -```shell -celocli transfer:celo --from --to --value --privateKey --node https://forno.celo.org -``` - -Or you can use a Ledger hardware wallet. (preferred, see below) - -## Using a Ledger Wallet - -The Celo CLI supports using a [Ledger hardware wallet](/wallet/ledger/setup) to sign transactions. Just add the `--useLedger` flag to a command that requires a signature. - -You can specify the number of addresses to get for local signing with the `--ledgerAddresses` flag. - -You can specify an array of index addresses for local signing. Example `--ledgerCustomAddresses "[4,99]"`. - -For example: - -```shell -celocli transfer:celo --to --value 1000000 --from --useLedger -``` - -## 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. - -:::danger - -Installing a 3rd party plugin can be _dangerous_! Please always be sure that you trust the plugin provider. - -::: - -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/docs/cli/lockedgold.md b/docs/cli/lockedgold.md deleted file mode 100644 index 52a4c86f7d..0000000000 --- a/docs/cli/lockedgold.md +++ /dev/null @@ -1,84 +0,0 @@ -# `celocli lockedgold` - -View and manage locked CELO - -## `celocli lockedgold:lock` - -Locks CELO to be used in governance and validator elections. - -``` -Locks CELO to be used in governance and validator elections. - -USAGE - $ celocli lockedgold:lock - -OPTIONS - --from=from (required) - --globalHelp View all available global flags - --value=value (required) The unit amount of CELO - -EXAMPLE - lock --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --value 10000000000000000000000 -``` - -_See code: [src/commands/lockedgold/lock.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/lockedgold/lock.ts)_ - -## `celocli lockedgold:show ACCOUNT` - -Show Locked Gold information for a given account. This includes the total amount of locked gold, the amount being used for voting in Validator Elections, the Locked Gold balance this account is required to maintain due to a registered Validator or Validator Group, and any pending withdrawals that have been initiated via "lockedgold:unlock". - -``` -Show Locked Gold information for a given account. This includes the total amount of locked gold, the amount being used for voting in Validator Elections, the Locked Gold balance this account is required to maintain due to a registered Validator or Validator Group, and any pending withdrawals that have been initiated via "lockedgold:unlock". - -USAGE - $ celocli lockedgold:show ACCOUNT - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - show 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/lockedgold/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/lockedgold/show.ts)_ - -## `celocli lockedgold:unlock` - -Unlocks CELO, which can be withdrawn after the unlocking period. Unlocked gold will appear as a "pending withdrawal" until the unlocking period is over, after which it can be withdrawn via "lockedgold:withdraw". - -``` -Unlocks CELO, which can be withdrawn after the unlocking period. Unlocked gold will appear as a "pending withdrawal" until the unlocking period is over, after which it can be withdrawn via "lockedgold:withdraw". - -USAGE - $ celocli lockedgold:unlock - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address - --globalHelp View all available global flags - --value=value (required) The unit amount of CELO - -EXAMPLE - unlock --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --value 500000000 -``` - -_See code: [src/commands/lockedgold/unlock.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/lockedgold/unlock.ts)_ - -## `celocli lockedgold:withdraw` - -Withdraw any pending withdrawals created via "lockedgold:unlock" that have become available. - -``` -Withdraw any pending withdrawals created via "lockedgold:unlock" that have become available. - -USAGE - $ celocli lockedgold:withdraw - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address - --globalHelp View all available global flags - -EXAMPLE - withdraw --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 -``` - -_See code: [src/commands/lockedgold/withdraw.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/lockedgold/withdraw.ts)_ diff --git a/docs/cli/multisig.md b/docs/cli/multisig.md deleted file mode 100644 index 5e02fb98bf..0000000000 --- a/docs/cli/multisig.md +++ /dev/null @@ -1,66 +0,0 @@ -# `celocli multisig` - -Shows information about multi-sig contract - -## `celocli multisig:show ADDRESS` - -Shows information about multi-sig contract - -``` -Shows information about multi-sig contract - -USAGE - $ celocli multisig:show ADDRESS - -OPTIONS - --all Show info about all transactions - --globalHelp View all available global flags - --raw Do not attempt to parse transactions - --tx=tx Show info for a transaction - -EXAMPLES - show 0x5409ed021d9299bf6814279a6a1411a7e866a631 - - show 0x5409ed021d9299bf6814279a6a1411a7e866a631 --tx 3 - - show 0x5409ed021d9299bf6814279a6a1411a7e866a631 --all --raw -``` - -_See code: [src/commands/multisig/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/multisig/show.ts)_ - -## `celocli multisig:transfer ADDRESS` - -Ability to approve CELO transfers to and from multisig. Submit transaction or approve a matching existing transaction - -``` -Ability to approve CELO transfers to and from multisig. Submit transaction or approve a matching existing transaction - -USAGE - $ celocli multisig:transfer ADDRESS - -OPTIONS - --amount=amount (required) Amount to transfer, - e.g. 10e18 - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account transferring - value to the recipient - - --globalHelp View all available global flags - - --sender=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Identify sender if performing - transferFrom - - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Recipient of transfer - - --transferFrom Perform transferFrom instead of - transfer in the ERC-20 interface - -EXAMPLES - transfer --to 0x5409ed021d9299bf6814279a6a1411a7e866a631 --amount - 200000e18 --from 0x123abc - - transfer --transferFrom --sender 0x123abc --to - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --amount 200000e18 --from 0x123abc -``` - -_See code: [src/commands/multisig/transfer.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/multisig/transfer.ts)_ diff --git a/docs/cli/network.md b/docs/cli/network.md deleted file mode 100644 index e4feedaa91..0000000000 --- a/docs/cli/network.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: celocli network -description: View details about the network, like contracts and parameters ---- - -# `celocli network` - -View details about the network, like contracts and parameters - -## `celocli network:contracts` - -Lists Celo core contracts and their addesses. - -``` -Lists Celo core contracts and their addesses. - -USAGE - $ celocli network:contracts - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) -``` - -_See code: [src/commands/network/contracts.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/network/contracts.ts)_ - -## `celocli network:info` - -View general network information such as the current block number - -``` -View general network information such as the current block number - -USAGE - $ celocli network:info - -OPTIONS - -n, --lastN=lastN [default: 1] Fetch info about the last n epochs - --globalHelp View all available global flags -``` - -_See code: [src/commands/network/info.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/network/info.ts)_ - -## `celocli network:parameters` - -View parameters of the network, including but not limited to configuration for the various Celo core smart contracts. - -``` -View parameters of the network, including but not limited to configuration for the various Celo core smart contracts. - -USAGE - $ celocli network:parameters - -OPTIONS - --globalHelp View all available global flags - --raw Display raw numerical configuration -``` - -_See code: [src/commands/network/parameters.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/network/parameters.ts)_ diff --git a/docs/cli/node.md b/docs/cli/node.md deleted file mode 100644 index 659b4c7c65..0000000000 --- a/docs/cli/node.md +++ /dev/null @@ -1,36 +0,0 @@ -# `celocli node` - -Manage your Celo node - -## `celocli node:accounts` - -List the addresses that this node has the private keys for. - -``` -List the addresses that this node has the private keys for. - -USAGE - $ celocli node:accounts - -OPTIONS - --globalHelp View all available global flags -``` - -_See code: [src/commands/node/accounts.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/node/accounts.ts)_ - -## `celocli node:synced` - -Check if the node is synced - -``` -Check if the node is synced - -USAGE - $ celocli node:synced - -OPTIONS - --globalHelp View all available global flags - --verbose output the full status if syncing -``` - -_See code: [src/commands/node/synced.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/node/synced.ts)_ diff --git a/docs/cli/oracle.md b/docs/cli/oracle.md deleted file mode 100644 index 1b4dfefbc6..0000000000 --- a/docs/cli/oracle.md +++ /dev/null @@ -1,125 +0,0 @@ -# `celocli oracle` - -List oracle addresses for a given token - -## `celocli oracle:list TOKEN` - -List oracle addresses for a given token - -``` -List oracle addresses for a given token - -USAGE - $ celocli oracle:list TOKEN - -ARGUMENTS - TOKEN [default: StableToken] Token to list the oracles for - -OPTIONS - --globalHelp View all available global flags - -EXAMPLES - list StableToken - - list - - list StableTokenEUR -``` - -_See code: [src/commands/oracle/list.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/oracle/list.ts)_ - -## `celocli oracle:remove-expired-reports TOKEN` - -Remove expired oracle reports for a specified token - -``` -Remove expired oracle reports for a specified token - -USAGE - $ celocli oracle:remove-expired-reports TOKEN - -ARGUMENTS - TOKEN [default: StableToken] Token to remove expired reports for - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the account - removing oracle reports - - --globalHelp View all available global flags - -EXAMPLES - remove-expired-reports StableToken --from 0x8c349AAc7065a35B7166f2659d6C35D75A3893C1 - - remove-expired-reports --from 0x8c349AAc7065a35B7166f2659d6C35D75A3893C1 - - remove-expired-reports StableTokenEUR --from - 0x8c349AAc7065a35B7166f2659d6C35D75A3893C1 -``` - -_See code: [src/commands/oracle/remove-expired-reports.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/oracle/remove-expired-reports.ts)_ - -## `celocli oracle:report TOKEN` - -Report the price of CELO in a specified token - -``` -Report the price of CELO in a specified token - -USAGE - $ celocli oracle:report TOKEN - -ARGUMENTS - TOKEN [default: StableToken] Token to report on - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the oracle - account - - --globalHelp View all available global flags - - --value=value (required) Amount of the specified - token equal to 1 CELO - -EXAMPLES - report StableToken --value 1.02 --from 0x8c349AAc7065a35B7166f2659d6C35D75A3893C1 - - report --value 0.99 --from 0x8c349AAc7065a35B7166f2659d6C35D75A3893C1 - - report StableTokenEUR --value 1.02 --from 0x8c349AAc7065a35B7166f2659d6C35D75A3893C1 -``` - -_See code: [src/commands/oracle/report.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/oracle/report.ts)_ - -## `celocli oracle:reports TOKEN` - -List oracle reports for a given token - -``` -List oracle reports for a given token - -USAGE - $ celocli oracle:reports TOKEN - -ARGUMENTS - TOKEN [default: StableToken] Token to list the reports for - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) - -EXAMPLES - reports StableToken - - reports - - reports StableTokenEUR -``` - -_See code: [src/commands/oracle/reports.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/oracle/reports.ts)_ diff --git a/docs/cli/plugins.md b/docs/cli/plugins.md deleted file mode 100644 index 4ea94fd1bd..0000000000 --- a/docs/cli/plugins.md +++ /dev/null @@ -1,146 +0,0 @@ -# `celocli plugins` - -list installed plugins - -## `celocli plugins` - -list installed plugins - -``` -list installed plugins - -USAGE - $ celocli plugins - -OPTIONS - --core show core plugins - -EXAMPLE - $ celocli plugins -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.5/src/commands/plugins/index.ts)_ - -## `celocli plugins:install PLUGIN...` - -installs a plugin into the CLI - -``` -installs a plugin into the CLI -Can be installed from npm or a git url. - -Installation of a user-installed plugin will override a core plugin. - -e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI. - - -USAGE - $ celocli plugins:install PLUGIN... - -ARGUMENTS - PLUGIN plugin to install - -OPTIONS - -f, --force yarn install with force flag - -h, --help show CLI help - -v, --verbose - -DESCRIPTION - Can be installed from npm or a git url. - - Installation of a user-installed plugin will override a core plugin. - - e.g. If you have a core plugin that has a 'hello' command, installing a user-installed - plugin with a 'hello' command will override the core plugin implementation. This is - useful if a user needs to update core plugin functionality in the CLI without the need - to patch and update the whole CLI. - - -ALIASES - $ celocli plugins:add - -EXAMPLES - $ celocli plugins:install myplugin - - $ celocli plugins:install https://github.com/someuser/someplugin - - $ celocli plugins:install someuser/someplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.5/src/commands/plugins/install.ts)_ - -## `celocli plugins:link PLUGIN` - -links a plugin into the CLI for development - -``` -links a plugin into the CLI for development -Installation of a linked plugin will override a user-installed or core plugin. - -e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work. - - -USAGE - $ celocli plugins:link PLUGIN - -ARGUMENTS - PATH [default: .] path to plugin - -OPTIONS - -h, --help show CLI help - -v, --verbose - -DESCRIPTION - Installation of a linked plugin will override a user-installed or core plugin. - - e.g. If you have a user-installed or core plugin that has a 'hello' command, - installing a linked plugin with a 'hello' command will override the user-installed or - core plugin implementation. This is useful for development work. - - -EXAMPLE - $ celocli plugins:link myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.5/src/commands/plugins/link.ts)_ - -## `celocli plugins:uninstall PLUGIN...` - -removes a plugin from the CLI - -``` -removes a plugin from the CLI - -USAGE - $ celocli plugins:uninstall PLUGIN... - -ARGUMENTS - PLUGIN plugin to uninstall - -OPTIONS - -h, --help show CLI help - -v, --verbose - -ALIASES - $ celocli plugins:unlink - $ celocli plugins:remove -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.5/src/commands/plugins/uninstall.ts)_ - -## `celocli plugins:update` - -update installed plugins - -``` -update installed plugins - -USAGE - $ celocli plugins:update - -OPTIONS - -h, --help show CLI help - -v, --verbose -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.5/src/commands/plugins/update.ts)_ diff --git a/docs/cli/releasegold.md b/docs/cli/releasegold.md deleted file mode 100644 index dea1f6861c..0000000000 --- a/docs/cli/releasegold.md +++ /dev/null @@ -1,472 +0,0 @@ -# `celocli releasegold` - -View and manage Release Gold contracts - -## `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 gold - - --contract=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - ReleaseGold Contract - - --globalHelp View all available global flags - - --value=10000000000000000000000 (required) Amount of gold 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 gold for the given contract - -``` -Set the maximum distribution of gold 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 gold to the beneficiary address. Fails if `value` worth of gold has not been released yet. - -``` -Withdraws `value` released gold to the beneficiary address. Fails if `value` worth of gold 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 - gold (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/docs/cli/reserve.md b/docs/cli/reserve.md deleted file mode 100644 index 46ce07b5c7..0000000000 --- a/docs/cli/reserve.md +++ /dev/null @@ -1,52 +0,0 @@ -# `celocli reserve` - -Shows information about reserve - -## `celocli reserve:status` - -Shows information about reserve - -``` -Shows information about reserve - -USAGE - $ celocli reserve:status - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - status -``` - -_See code: [src/commands/reserve/status.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/reserve/status.ts)_ - -## `celocli reserve:transfergold` - -Transfers reserve gold to other reserve address - -``` -Transfers reserve gold to other reserve address - -USAGE - $ celocli reserve:transfergold - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Spender's address - --globalHelp View all available global flags - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Receiving address - - --useMultiSig True means the request will be sent - through multisig. - - --value=value (required) The unit amount of CELO - -EXAMPLES - transfergold --value 9000 --to 0x91c987bf62D25945dB517BDAa840A6c661374402 --from - 0x5409ed021d9299bf6814279a6a1411a7e866a631 - - transfergold --value 9000 --to 0x91c987bf62D25945dB517BDAa840A6c661374402 --from - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --useMultiSig -``` - -_See code: [src/commands/reserve/transfergold.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/reserve/transfergold.ts)_ diff --git a/docs/cli/rewards.md b/docs/cli/rewards.md deleted file mode 100644 index 4c64fe706c..0000000000 --- a/docs/cli/rewards.md +++ /dev/null @@ -1,60 +0,0 @@ -# `celocli rewards` - -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 - -``` -Show rewards information about a voter, registered Validator, or Validator Group - -USAGE - $ celocli rewards:show - -OPTIONS - -x, --extended show extra columns - - --columns=columns only show provided columns - (comma-separated) - - --csv output is csv format [alias: - --output=csv] - - --epochs=epochs [default: 1] Show results for - the last N epochs - - --estimate Estimate voter rewards from - current votes - - --filter=filter filter property by partial - string matching, ex: name=foo - - --globalHelp View all available global - flags - - --group=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Validator Group to show - rewards for - - --no-header hide table header from output - - --no-truncate do not truncate output to fit - screen - - --output=csv|json|yaml output in a more machine - friendly format - - --slashing Show rewards for slashing - - --sort=sort property to sort by (prepend - '-' for descending) - - --validator=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Validator to show rewards for - - --voter=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Voter to show rewards for - -EXAMPLE - show --address 0x5409ed021d9299bf6814279a6a1411a7e866a631 -``` - -_See code: [src/commands/rewards/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/rewards/show.ts)_ diff --git a/docs/cli/transfer.md b/docs/cli/transfer.md deleted file mode 100644 index 9b5f7fa043..0000000000 --- a/docs/cli/transfer.md +++ /dev/null @@ -1,195 +0,0 @@ -# `celocli transfer` - -Transfer CELO and Celo Dollars - -## `celocli transfer:celo` - -Transfer CELO to a specified address. (Note: this is the equivalent of the old transfer:gold) - -``` -Transfer CELO to a specified address. (Note: this is the equivalent of the old transfer:gold) - -USAGE - $ celocli transfer:celo - -OPTIONS - --comment=comment Transfer comment - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the receiver - - --value=value (required) Amount to transfer (in - wei) - -EXAMPLE - celo --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --value 10000000000000000000 -``` - -_See code: [src/commands/transfer/celo.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/transfer/celo.ts)_ - -## `celocli transfer:dollars` - -Transfer Celo Dollars (cUSD) to a specified address. - -``` -Transfer Celo Dollars (cUSD) to a specified address. - -USAGE - $ celocli transfer:dollars - -OPTIONS - --comment=comment Transfer comment - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the receiver - - --value=value (required) Amount to transfer (in - wei) - -EXAMPLE - dollars --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --value 1000000000000000000 -``` - -_See code: [src/commands/transfer/dollars.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/transfer/dollars.ts)_ - -## `celocli transfer:erc20` - -Transfer ERC20 to a specified address - -``` -Transfer ERC20 to a specified address - -USAGE - $ celocli transfer:erc20 - -OPTIONS - --erc20Address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Custom erc20 to - check it's balance too - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - sender - - --globalHelp View all available global - flags - - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the - receiver - - --value=value (required) Amount to - transfer (in wei) - -EXAMPLE - erc20 --erc20Address 0x765DE816845861e75A25fCA122bb6898B8B1282a --from - 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --value 10000000000000000000 -``` - -_See code: [src/commands/transfer/erc20.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/transfer/erc20.ts)_ - -## `celocli transfer:euros` - -Transfer Celo Euros (cEUR) to a specified address. - -``` -Transfer Celo Euros (cEUR) to a specified address. - -USAGE - $ celocli transfer:euros - -OPTIONS - --comment=comment Transfer comment - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the receiver - - --value=value (required) Amount to transfer (in - wei) - -EXAMPLE - euros --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --value 1000000000000000000 -``` - -_See code: [src/commands/transfer/euros.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/transfer/euros.ts)_ - -## `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 - $ celocli transfer:gold - -OPTIONS - --comment=comment Transfer comment - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the receiver - - --value=value (required) Amount to transfer (in - wei) - -EXAMPLE - gold --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --value 10000000000000000000 -``` - -_See code: [src/commands/transfer/gold.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/transfer/gold.ts)_ - -## `celocli transfer:reals` - -Transfer Celo Brazilian Real (cREAL) to a specified address. - -``` -Transfer Celo Brazilian Real (cREAL) to a specified address. - -USAGE - $ celocli transfer:reals - -OPTIONS - --comment=comment Transfer comment - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the receiver - - --value=value (required) Amount to transfer (in - wei) - -EXAMPLE - reals --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --value 1000000000000000000 -``` - -_See code: [src/commands/transfer/reals.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/transfer/reals.ts)_ - -## `celocli transfer:stable` - -Transfer a stable token to a specified address. - -``` -Transfer a stable token to a specified address. - -USAGE - $ celocli transfer:stable - -OPTIONS - --comment=comment Transfer comment - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender - --globalHelp View all available global flags - --stableToken=(cUSD|cusd|cEUR|ceur|cREAL|creal) Name of the stable to be transfered - --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the receiver - - --value=value (required) Amount to transfer (in - wei) - -EXAMPLE - stable --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to - 0x5409ed021d9299bf6814279a6a1411a7e866a631 --value 1000000000000000000 --stableToken - cStableTokenSymbol -``` - -_See code: [src/commands/transfer/stable.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/transfer/stable.ts)_ diff --git a/docs/cli/validator.md b/docs/cli/validator.md deleted file mode 100644 index 8fcbf0dc6e..0000000000 --- a/docs/cli/validator.md +++ /dev/null @@ -1,441 +0,0 @@ -# `celocli validator` - -View and manage Validators - -## `celocli validator:affiliate GROUPADDRESS` - -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. - -``` -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. - -USAGE - $ celocli validator:affiliate GROUPADDRESS - -ARGUMENTS - GROUPADDRESS ValidatorGroup's address - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Signer or Validator's - address - - --globalHelp View all available global flags - - --yes Answer yes to prompt - -EXAMPLE - affiliate --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 - 0x97f7333c51897469e8d98e7af8653aab468050a3 -``` - -_See code: [src/commands/validator/affiliate.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/affiliate.ts)_ - -## `celocli validator:deaffiliate` - -Deaffiliate a Validator from a Validator Group, and remove it from the Group if it is also a member. - -``` -Deaffiliate a Validator from a Validator Group, and remove it from the Group if it is also a member. - -USAGE - $ celocli validator:deaffiliate - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Signer or Validator's - address - - --globalHelp View all available global flags - -EXAMPLE - deaffiliate --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 -``` - -_See code: [src/commands/validator/deaffiliate.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/deaffiliate.ts)_ - -## `celocli validator:deregister` - -Deregister a Validator. Approximately 60 days after the validator is no longer part of any group, it will be possible to deregister the validator and start unlocking the CELO. If you wish to deregister your validator, you must first remove it from it's group, such as by deaffiliating it, then wait the required 60 days before running this command. - -``` -Deregister a Validator. Approximately 60 days after the validator is no longer part of any group, it will be possible to deregister the validator and start unlocking the CELO. If you wish to deregister your validator, you must first remove it from it's group, such as by deaffiliating it, then wait the required 60 days before running this command. - -USAGE - $ celocli validator:deregister - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Signer or Validator's - address - - --globalHelp View all available global flags - -EXAMPLE - deregister --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 -``` - -_See code: [src/commands/validator/deregister.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/deregister.ts)_ - -## `celocli validator:downtime-slash` - -Downtime slash a validator - -``` -Downtime slash a validator - -USAGE - $ celocli validator:downtime-slash - -OPTIONS - --beforeBlock=beforeBlock - Slash for slashable downtime window before provided block - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - (required) From address to perform the slash (reward recipient) - - --globalHelp - View all available global flags - - --intervals='[0:1], [1:2]' - Array of intervals, ordered by min start to max end - - --validator=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - Validator (signer or account) address - - --validators='["0xb7ef0985bdb4f19460A29d9829aA1514B181C4CD", - "0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95"]' - Validator (signer or account) address list - -EXAMPLES - downtime-slash --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 --validator - 0xb7ef0985bdb4f19460A29d9829aA1514B181C4CD --intervals "[100:150), [150:200)" - - downtime-slash --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 --validator - 0xb7ef0985bdb4f19460A29d9829aA1514B181C4CD --slashableDowntimeBeforeBlock 200 -``` - -_See code: [src/commands/validator/downtime-slash.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/downtime-slash.ts)_ - -## `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 - $ celocli validator:force-deaffiliate - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Initiator - - --globalHelp View all available global - flags - - --validator=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Validator's address - -EXAMPLE - force-deaffiliate --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 --validator - 0xb7ef0985bdb4f19460A29d9829aA1514B181C4CD -``` - -_See code: [src/commands/validator/force-deaffiliate.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/force-deaffiliate.ts)_ - -## `celocli validator:list` - -List registered Validators, their name (if provided), affiliation, uptime score, and public keys used for validating. - -``` -List registered Validators, their name (if provided), affiliation, uptime score, and public keys used for validating. - -USAGE - $ celocli validator:list - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) - -EXAMPLE - list -``` - -_See code: [src/commands/validator/list.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/list.ts)_ - -## `celocli validator:register` - -Register a new Validator - -``` -Register a new Validator - -USAGE - $ celocli validator:register - -OPTIONS - --blsKey=0x (required) BLS Public Key - --blsSignature=0x (required) BLS Proof-of-Possession - --ecdsaKey=0x (required) ECDSA Public Key - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address for the - Validator - - --globalHelp View all available global flags - - --yes Answer yes to prompt - -EXAMPLE - register --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --ecdsaKey - 0x049b7291ab8813a095d6b7913a7930ede5ea17466abd5e1a26c6c44f6df9a400a6f474080098b2c752c6 - c4871978ca977b90dcd3aed92bc9d564137c8dfa14ee72 --blsKey - 0x4fa3f67fc913878b068d1fa1cdddc54913d3bf988dbe5a36a20fa888f20d4894c408a6773f3d7bde1115 - 4f2a3076b700d345a42fd25a0e5e83f4db5586ac7979ac2053cd95d8f2efd3e959571ceccaa743e02cf4be - 3f5d7aaddb0b06fc9aff00 --blsSignature - 0xcdb77255037eb68897cd487fdd85388cbda448f617f874449d4b11588b0b7ad8ddc20d9bb450b513bb35 - 664ea3923900 -``` - -_See code: [src/commands/validator/register.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/register.ts)_ - -## `celocli validator:requirements` - -List the Locked Gold requirements for registering a Validator. This consists of a value, which is the amount of CELO that needs to be locked in order to register, and a duration, which is the amount of time that CELO must stay locked following the deregistration of the Validator. - -``` -List the Locked Gold requirements for registering a Validator. This consists of a value, which is the amount of CELO that needs to be locked in order to register, and a duration, which is the amount of time that CELO must stay locked following the deregistration of the Validator. - -USAGE - $ celocli validator:requirements - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - requirements -``` - -_See code: [src/commands/validator/requirements.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/requirements.ts)_ - -## `celocli validator:set-bitmaps` - -Set validator signature bitmaps for provided intervals - -``` -Set validator signature bitmaps for provided intervals - -USAGE - $ celocli validator:set-bitmaps - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) From address - to sign set bitmap - transactions - - --globalHelp View all available global - flags - - --intervals='[0:1], [1:2]' Array of intervals, - ordered by min start to - max end - - --slashableDowntimeBeforeBlock=slashableDowntimeBeforeBlock Set all bitmaps for - slashable downtime window - before provided block - - --slashableDowntimeBeforeLatest Set all bitmaps for - slashable downtime window - before latest block - -EXAMPLES - set-bitmaps --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 - --slashableDowntimeBeforeBlock 10000 - - set-bitmaps --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 --intervals "[0:100], - (100:200]" -``` - -_See code: [src/commands/validator/set-bitmaps.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/set-bitmaps.ts)_ - -## `celocli validator:show VALIDATORADDRESS` - -Show information about a registered Validator. - -``` -Show information about a registered Validator. - -USAGE - $ celocli validator:show VALIDATORADDRESS - -ARGUMENTS - VALIDATORADDRESS Validator's address - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - show 0x97f7333c51897469E8D98E7af8653aAb468050a3 -``` - -_See code: [src/commands/validator/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/show.ts)_ - -## `celocli validator:signed-blocks` - -Display a graph of blocks and whether the given signer's signature is included in each. A green '.' indicates the signature is present in that block, a red '✘' indicates the signature is not present. A yellow '~' indicates the signer is not elected for that block. - -``` -Display a graph of blocks and whether the given signer's signature is included in each. A green '.' indicates the signature is present in that block, a red '✘' indicates the signature is not present. A yellow '~' indicates the signer is not elected for that block. - -USAGE - $ celocli validator:signed-blocks - -OPTIONS - --at-block=at-block - latest block to examine for signer activity - - --globalHelp - View all available global flags - - --lookback=lookback - [default: 120] how many blocks to look back for signer activity - - --signer=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - address of the signer to check for signatures - - --signers='["0xb7ef0985bdb4f19460A29d9829aA1514B181C4CD", - "0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95"]' - list of signer addresses to check for signatures - - --slashableDowntimeLookback - lookback of slashableDowntime - - --wasDownWhileElected - indicate whether a validator was down while elected for range - - --width=width - [default: 40] line width for printing marks - -EXAMPLES - signed-blocks --signer 0x5409ED021D9299bf6814279A6A1411A7e866A631 - - signed-blocks --signer 0x5409ED021D9299bf6814279A6A1411A7e866A631 --follow - - signed-blocks --at-block 100000 --signer 0x5409ED021D9299bf6814279A6A1411A7e866A631 - - signed-blocks --lookback 500 --signer 0x5409ED021D9299bf6814279A6A1411A7e866A631 - - signed-blocks --lookback 50 --width 10 --signer - 0x5409ED021D9299bf6814279A6A1411A7e866A631 -``` - -_See code: [src/commands/validator/signed-blocks.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/signed-blocks.ts)_ - -## `celocli validator:status` - -Shows the consensus status of a validator. This command will show whether a validator is currently elected, would be elected if an election were to be run right now, and the percentage of blocks signed and number of blocks successfully proposed within a given window. - -``` -Shows the consensus status of a validator. This command will show whether a validator is currently elected, would be elected if an election were to be run right now, and the percentage of blocks signed and number of blocks successfully proposed within a given window. - -USAGE - $ celocli validator:status - -OPTIONS - -x, --extended show extra columns - - --all get the status of all - registered validators - - --columns=columns only show provided columns - (comma-separated) - - --csv output is csv format [alias: - --output=csv] - - --end=end [default: -1] what block to - end at when looking at signer - activity. defaults to the - latest block - - --filter=filter filter property by partial - string matching, ex: name=foo - - --globalHelp View all available global - flags - - --no-header hide table header from output - - --no-truncate do not truncate output to fit - screen - - --output=csv|json|yaml output in a more machine - friendly format - - --signer=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d address of the signer to check - if elected and validating - - --sort=sort property to sort by (prepend - '-' for descending) - - --start=start [default: -1] what block to - start at when looking at - signer activity. defaults to - the last 100 blocks - - --validator=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d address of the validator to - check if elected and - validating - -EXAMPLES - status --validator 0x5409ED021D9299bf6814279A6A1411A7e866A631 - - status --validator 0x5409ED021D9299bf6814279A6A1411A7e866A631 --start 1480000 - - status --all --start 1480000 --end 1490000 -``` - -_See code: [src/commands/validator/status.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/status.ts)_ - -## `celocli validator:update-bls-public-key` - -Update the BLS public key for a Validator to be used in consensus. - -``` -Update the BLS public key for a Validator to be used in consensus. - -Regular (ECDSA and BLS) key rotation is recommended for Validator operational security. - -WARNING: By default, the BLS key used by the validator node is derived from the ECDSA private key. As a result, rotating the BLS key without rotating the ECDSA key will result in validator downtime without special configuration. Use this method only if you know what you are doing. - -USAGE - $ celocli validator:update-bls-public-key - -OPTIONS - --blsKey=0x (required) BLS Public Key - --blsPop=0x (required) BLS Proof-of-Possession - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Validator's address - --globalHelp View all available global flags - -DESCRIPTION - - Regular (ECDSA and BLS) key rotation is recommended for Validator operational - security. - - WARNING: By default, the BLS key used by the validator node is derived from the ECDSA - private key. As a result, rotating the BLS key without rotating the ECDSA key will - result in validator downtime without special configuration. Use this method only if - you know what you are doing. - -EXAMPLE - update-bls-key --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --blsKey - 0x4fa3f67fc913878b068d1fa1cdddc54913d3bf988dbe5a36a20fa888f20d4894c408a6773f3d7bde1115 - 4f2a3076b700d345a42fd25a0e5e83f4db5586ac7979ac2053cd95d8f2efd3e959571ceccaa743e02cf4be - 3f5d7aaddb0b06fc9aff00 --blsPop - 0xcdb77255037eb68897cd487fdd85388cbda448f617f874449d4b11588b0b7ad8ddc20d9bb450b513bb35 - 664ea3923900 -``` - -_See code: [src/commands/validator/update-bls-public-key.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validator/update-bls-public-key.ts)_ diff --git a/docs/cli/validatorgroup.md b/docs/cli/validatorgroup.md deleted file mode 100644 index 6a7a0e3886..0000000000 --- a/docs/cli/validatorgroup.md +++ /dev/null @@ -1,200 +0,0 @@ -# `celocli validatorgroup` - -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 - -``` -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 - -USAGE - $ celocli validatorgroup:commission - -OPTIONS - --apply Applies a previously queued update. - Should be called after the update - delay. - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address for the - Validator Group or Validator Group - validator signer - - --globalHelp View all available global flags - - --queue-update=queue-update Queues an update to the commission, - which can be applied after the - update delay. - -EXAMPLES - commission --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --queue-update 0.1 - - commission --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --apply -``` - -_See code: [src/commands/validatorgroup/commission.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validatorgroup/commission.ts)_ - -## `celocli validatorgroup:deregister` - -Deregister a Validator Group. Approximately 180 days after the validator group is empty, it will be possible to deregister it start unlocking the CELO. If you wish to deregister your validator group, you must first remove all members, then wait the required 180 days before running this command. - -``` -Deregister a Validator Group. Approximately 180 days after the validator group is empty, it will be possible to deregister it start unlocking the CELO. If you wish to deregister your validator group, you must first remove all members, then wait the required 180 days before running this command. - -USAGE - $ celocli validatorgroup:deregister - -OPTIONS - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Signer or - ValidatorGroup's address - - --globalHelp View all available global flags - -EXAMPLE - deregister --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 -``` - -_See code: [src/commands/validatorgroup/deregister.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validatorgroup/deregister.ts)_ - -## `celocli validatorgroup:list` - -List registered Validator Groups, their names (if provided), commission, and members. - -``` -List registered Validator Groups, their names (if provided), commission, and members. - -USAGE - $ celocli validatorgroup:list - -OPTIONS - -x, --extended show extra columns - --columns=columns only show provided columns (comma-separated) - --csv output is csv format [alias: --output=csv] - --filter=filter filter property by partial string matching, ex: name=foo - --globalHelp View all available global flags - --no-header hide table header from output - --no-truncate do not truncate output to fit screen - --output=csv|json|yaml output in a more machine friendly format - --sort=sort property to sort by (prepend '-' for descending) - -EXAMPLE - list -``` - -_See code: [src/commands/validatorgroup/list.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validatorgroup/list.ts)_ - -## `celocli validatorgroup:member VALIDATORADDRESS` - -Add or remove members from a Validator Group - -``` -Add or remove members from a Validator Group - -USAGE - $ celocli validatorgroup:member VALIDATORADDRESS - -ARGUMENTS - VALIDATORADDRESS Validator's address - -OPTIONS - --accept Accept a validator whose - affiliation is already set to the - group - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) ValidatorGroup's address - - --globalHelp View all available global flags - - --remove Remove a validator from the members - list - - --reorder=reorder Reorder a validator within the - members list. Indices are 0 based - - --yes Answer yes to prompt - -EXAMPLES - member --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 --accept - 0x97f7333c51897469e8d98e7af8653aab468050a3 - - member --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 --remove - 0x97f7333c51897469e8d98e7af8653aab468050a3 - - member --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 --reorder 3 - 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 -``` - -_See code: [src/commands/validatorgroup/member.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validatorgroup/member.ts)_ - -## `celocli validatorgroup:register` - -Register a new Validator Group - -``` -Register a new Validator Group - -USAGE - $ celocli validatorgroup:register - -OPTIONS - --commission=commission (required) The share of the epoch - rewards given to elected Validators - that goes to the group. - - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address for the - Validator Group - - --globalHelp View all available global flags - - --yes Answer yes to prompt - -EXAMPLE - register --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --commission 0.1 -``` - -_See code: [src/commands/validatorgroup/register.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validatorgroup/register.ts)_ - -## `celocli validatorgroup:reset-slashing-multiplier GROUPADDRESS` - -Reset validator group slashing multiplier. - -``` -Reset validator group slashing multiplier. - -USAGE - $ celocli validatorgroup:reset-slashing-multiplier GROUPADDRESS - -ARGUMENTS - GROUPADDRESS ValidatorGroup's address - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - reset-slashing-multiplier 0x97f7333c51897469E8D98E7af8653aAb468050a3 -``` - -_See code: [src/commands/validatorgroup/reset-slashing-multiplier.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validatorgroup/reset-slashing-multiplier.ts)_ - -## `celocli validatorgroup:show GROUPADDRESS` - -Show information about an existing Validator Group - -``` -Show information about an existing Validator Group - -USAGE - $ celocli validatorgroup:show GROUPADDRESS - -ARGUMENTS - GROUPADDRESS ValidatorGroup's address - -OPTIONS - --globalHelp View all available global flags - -EXAMPLE - show 0x97f7333c51897469E8D98E7af8653aAb468050a3 -``` - -_See code: [src/commands/validatorgroup/show.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/validatorgroup/show.ts)_ From 01ff275d8c239d695cd9e3892eafcf943b993c3f Mon Sep 17 00:00:00 2001 From: Nicolas Brugneaux Date: Wed, 31 Jan 2024 18:38:40 +0100 Subject: [PATCH 3/4] fix: missing references --- docs/cli-index.md | 119 ++++++++++++++++++++++++++++++++++++++++++++++ sidebars.js | 12 +---- 2 files changed, 120 insertions(+), 11 deletions(-) create mode 100644 docs/cli-index.md diff --git a/docs/cli-index.md b/docs/cli-index.md new file mode 100644 index 0000000000..9c631a8b71 --- /dev/null +++ b/docs/cli-index.md @@ -0,0 +1,119 @@ +--- +title: Celo CLI +description: The Command Line Interface allows users to interact with the Celo Protocol smart contracts. +sidebar_position: 1 +--- + +# Celo CLI + +Introduction to the Celo Command Line Interface and installation instructions. + +## What is the Celo CLI + +The Command Line Interface allows users to interact with the Celo Protocol smart contracts. + +It’s a command-line interface around the ContractKit. It allows you to interact with the Celo Protocol and smart contracts using command-line tools rather than writing JavaScript. It provides modules for interacting with modules on the ContractKit and is an excellent code reference when defining your own modules. Some common features you may want to consider are helping users participate in elections or in on-chain governance, voting for validators, or helping users interact with multi-sig contracts. + +## 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 +``` + +:::info + +We are currently deploying the CLI with only Node.js v18.14.2 support. 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 18.14.2 && nvm use 18.14.2` + +::: + +:::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`. + +::: + +## Commands + +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. + +:::info + +All balances of CELO or Celo Dollars are expressed in units of 10^-18. + +::: + +You can find the Celo CLI package on NPM [here](https://www.npmjs.com/package/@celo/celocli). + +To see all available commands, run `celocli commands`. + +To see all available flags for a command, add the flag `--globalHelp` to the command. + +## Optional: Run a Full Node + +Commands need to connect to a Celo node to execute most functionality. You can either use [Forno](/network/node/forno) (this is the easiest way) or run your own full node if you prefer. See the [Running a Full Node](/network/mainnet/run-full-node) instructions for more details on running a full node. + +The easiest way to connect `celocli` to the Celo network is by running the following command in your terminal with `celocli` installed: + +```bash +celocli config:set --node=https://forno.celo.org +``` + +You can verify that `celocli` is connected by running + +```bash +celocli config:get +``` + +## Import Accounts + +If you are connecting to a remote node (like Forno), Celo CLI will need to sign transactions locally before sending them. To do this, Celo CLI needs access to a private key. There are a couple ways to sign transactions using Celo CLI. + +### Import Private Key (less secure) + +Add the `--privateKey` flag followed by the private key associated with the sending account. For example: + +```shell +celocli transfer:celo --from --to --value --privateKey --node https://forno.celo.org +``` + +Or you can use a Ledger hardware wallet. (preferred, see below) + +## Using a Ledger Wallet + +The Celo CLI supports using a [Ledger hardware wallet](/wallet/ledger/setup) to sign transactions. Just add the `--useLedger` flag to a command that requires a signature. + +You can specify the number of addresses to get for local signing with the `--ledgerAddresses` flag. + +You can specify an array of index addresses for local signing. Example `--ledgerCustomAddresses "[4,99]"`. + +For example: + +```shell +celocli transfer:celo --to --value 1000000 --from --useLedger +``` + +## 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. + +:::danger + +Installing a 3rd party plugin can be _dangerous_! Please always be sure that you trust the plugin provider. + +::: + +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. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 6475109b78..48ef2d79fd 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1369,7 +1369,7 @@ const sidebars = { { type: "doc", label: "Introduction", - id: "cli/index", + id: "cli-index", }, { type: "doc", label: "Account", id: "cli/account" }, { type: "doc", label: "Commands", id: "cli/commands" }, @@ -1382,11 +1382,6 @@ const sidebars = { label: "Governance", id: "cli/governance", }, - { - type: "doc", - label: "Grandamento", - id: "cli/grandamento", - }, { type: "doc", label: "Help", id: "cli/help" }, { type: "doc", label: "Identity", id: "cli/identity" }, { @@ -1399,11 +1394,6 @@ const sidebars = { { type: "doc", label: "Node", id: "cli/node" }, { type: "doc", label: "Oracle", id: "cli/oracle" }, { type: "doc", label: "Plugins", id: "cli/plugins" }, - { - type: "doc", - label: "ReleaseGold", - id: "cli/releasegold", - }, { type: "doc", label: "Reserve", id: "cli/reserve" }, { type: "doc", label: "Rewards", id: "cli/rewards" }, { type: "doc", label: "Transfer", id: "cli/transfer" }, From e35c468d3052002911900940af35b985d0246fd2 Mon Sep 17 00:00:00 2001 From: Nicolas Brugneaux Date: Thu, 1 Feb 2024 17:58:08 +0100 Subject: [PATCH 4/4] chore: replace symlinks by hardcopies --- docs/cli | 1 - docs/cli/account.md | 976 ++++++++++++++++++++++++++++ docs/cli/autocomplete.md | 37 ++ docs/cli/commands.md | 40 ++ docs/cli/config.md | 57 ++ docs/cli/dkg.md | 142 ++++ docs/cli/election.md | 209 ++++++ docs/cli/exchange.md | 224 +++++++ docs/cli/governance.md | 735 +++++++++++++++++++++ docs/cli/help.md | 26 + docs/cli/identity.md | 97 +++ docs/{cli-index.md => cli/index.md} | 2 +- docs/cli/lockedgold.md | 221 +++++++ docs/cli/multisig.md | 93 +++ docs/cli/network.md | 73 +++ docs/cli/node.md | 42 ++ docs/cli/oracle.md | 134 ++++ docs/cli/plugins.md | 293 +++++++++ docs/cli/releasecelo.md | 467 +++++++++++++ docs/cli/reserve.md | 55 ++ docs/cli/rewards.md | 58 ++ docs/cli/transfer.md | 203 ++++++ docs/cli/validator.md | 456 +++++++++++++ docs/cli/validatorgroup.md | 215 ++++++ package.json | 1 + scripts/copy-generated-docs.sh | 3 + sidebars.js | 2 +- 27 files changed, 4859 insertions(+), 3 deletions(-) delete mode 120000 docs/cli create mode 100644 docs/cli/account.md create mode 100644 docs/cli/autocomplete.md create mode 100644 docs/cli/commands.md create mode 100644 docs/cli/config.md create mode 100644 docs/cli/dkg.md create mode 100644 docs/cli/election.md create mode 100644 docs/cli/exchange.md create mode 100644 docs/cli/governance.md create mode 100644 docs/cli/help.md create mode 100644 docs/cli/identity.md rename docs/{cli-index.md => cli/index.md} (98%) create mode 100644 docs/cli/lockedgold.md create mode 100644 docs/cli/multisig.md create mode 100644 docs/cli/network.md create mode 100644 docs/cli/node.md create mode 100644 docs/cli/oracle.md create mode 100644 docs/cli/plugins.md create mode 100644 docs/cli/releasecelo.md create mode 100644 docs/cli/reserve.md create mode 100644 docs/cli/rewards.md create mode 100644 docs/cli/transfer.md create mode 100644 docs/cli/validator.md create mode 100644 docs/cli/validatorgroup.md create mode 100755 scripts/copy-generated-docs.sh diff --git a/docs/cli b/docs/cli deleted file mode 120000 index e65ece2707..0000000000 --- a/docs/cli +++ /dev/null @@ -1 +0,0 @@ -../submodules/developer-tooling/packages/docs/command-line-interface \ No newline at end of file diff --git a/docs/cli/account.md b/docs/cli/account.md new file mode 100644 index 0000000000..239e8409d9 --- /dev/null +++ b/docs/cli/account.md @@ -0,0 +1,976 @@ +`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` + +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. + +``` +USAGE + $ celocli account:authorize --from -r vote|validator|attestation --signature + --signer [--globalHelp] [--blsKey --blsPop ] + +FLAGS + -r, --role=