Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing temp commands from cli #407

Merged
merged 2 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/chilled-cycles-smell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@celo/celocli': major
---

Remove transfer:gold -- this was an old alias for transfer:celo which has the same functionality
6 changes: 6 additions & 0 deletions .changeset/good-trees-reply.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@celo/celocli': major
---
Remove account:recover-old

This was meant to be a temporary command for migrating account from a beta version of Valora to the release version. Please use a previous version of celocli if you need to make this one time recovery.
69 changes: 0 additions & 69 deletions docs/command-line-interface/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Manage your account, keys, and metadata
* [`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)
Expand Down Expand Up @@ -781,74 +780,6 @@ EXAMPLES

_See code: [src/commands/account/proof-of-possession.ts](https://github.com/celo-org/developer-tooling/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.

```
USAGE
$ celocli account:recover-old --mnemonicPath <value> [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--passphrasePath
<value>] [--changeIndex <value>] [--addressIndex <value>] [--language chinese_simpli
fied|chinese_traditional|english|french|italian|japanese|korean|spanish]
[--derivationPath <value>]

FLAGS
--addressIndex=<value>
Choose the address index for the derivation path

--changeIndex=<value>
Choose the change index for the derivation path

--derivationPath=<value>
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

--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.

--globalHelp
View all available global flags

--language=<option>
[default: english] Language for the mnemonic words. **WARNING**, some hardware
wallets don't support other languages
<options: chinese_simplified|chinese_traditional|english|french|italian|japanese|kor
ean|spanish>

--mnemonicPath=<value>
(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=<value>
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.

DESCRIPTION
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.

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/developer-tooling/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.
Expand Down
37 changes: 0 additions & 37 deletions docs/command-line-interface/transfer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Transfer CELO and Celo Dollars
* [`celocli transfer:dollars`](#celocli-transferdollars)
* [`celocli transfer:erc20`](#celocli-transfererc20)
* [`celocli transfer:euros`](#celocli-transfereuros)
* [`celocli transfer:gold`](#celocli-transfergold)
* [`celocli transfer:reals`](#celocli-transferreals)
* [`celocli transfer:stable`](#celocli-transferstable)

Expand Down Expand Up @@ -157,42 +156,6 @@ EXAMPLES

_See code: [src/commands/transfer/euros.ts](https://github.com/celo-org/developer-tooling/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

```
USAGE
$ celocli transfer:gold --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d --to
0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d --value <value> [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--comment <value>]

FLAGS
--comment=<value> Transfer comment
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the
sender
--gasCurrency=0x1234567890123456789012345678901234567890 Use a specific gas currency
for transaction fees
(defaults to CELO if no gas
currency is supplied). It
must be a whitelisted token.
--globalHelp View all available global
flags
--to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the
receiver
--value=<value> (required) Amount to
transfer (in wei)

DESCRIPTION
Transfer CELO to a specified address. *DEPRECATION WARNING* Use the "transfer:celo"
command instead

EXAMPLES
gold --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to 0x5409ed021d9299bf6814279a6a1411a7e866a631 --value 10000000000000000000
```

_See code: [src/commands/transfer/gold.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/transfer/gold.ts)_

## `celocli transfer:reals`

Transfer Celo Brazilian Real (cREAL) to a specified address.
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"node": ">=16"
},
"scripts": {
"clean": "yarn run --top-level tsc -b . --clean",
"clean": "rm tsconfig.tsbuildinfo && yarn run --top-level tsc -b . --clean",
"dev": "yarn build && ts-node ./bin/dev.js",
"build": "yarn run --top-level tsc -b .",
"docs": "./generate_docs.sh",
Expand Down
60 changes: 0 additions & 60 deletions packages/cli/src/commands/account/recover-old.ts

This file was deleted.

14 changes: 0 additions & 14 deletions packages/cli/src/commands/transfer/gold.ts

This file was deleted.

Loading