diff --git a/packages/cli/generate_docs.sh b/packages/cli/generate_docs.sh
index dfe4dd29c..904996cd3 100755
--- a/packages/cli/generate_docs.sh
+++ b/packages/cli/generate_docs.sh
@@ -1,10 +1,6 @@
#!/usr/bin/env bash
set -e
export COLUMNS=88
-# must replace lib with src so docs link to source code
-sed -i -e 's@./lib/commands@./src/commands@g' package.json
yarn oclif readme --multi --dir=../docs/command-line-interface
sed -i.bak '/^- \[/d' ../docs/command-line-interface/*
rm -rf ../docs/command-line-interface/*.bak
-# reverse changes to package.json
-sed -i -e 's@./src/commands@./lib/commands@g' package.json
diff --git a/packages/cli/src/commands/account/get-metadata.ts b/packages/cli/src/commands/account/get-metadata.ts
index 2fbcf1627..8a7c1f597 100644
--- a/packages/cli/src/commands/account/get-metadata.ts
+++ b/packages/cli/src/commands/account/get-metadata.ts
@@ -7,7 +7,7 @@ import { displayMetadata } from '../../utils/identity'
export default class GetMetadata extends BaseCommand {
static description =
- '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. Retrieves the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able.'
static flags = {
...BaseCommand.flags,
diff --git a/packages/cli/src/commands/account/register-metadata.ts b/packages/cli/src/commands/account/register-metadata.ts
index 913622649..e884b52c6 100644
--- a/packages/cli/src/commands/account/register-metadata.ts
+++ b/packages/cli/src/commands/account/register-metadata.ts
@@ -9,13 +9,13 @@ import { displayMetadata } from '../../utils/identity'
export default class RegisterMetadata extends BaseCommand {
static description =
- '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 retrieve the metadata file and verify your claims'
static flags = {
...BaseCommand.flags,
from: CustomFlags.address({
required: true,
- description: 'Addess of the account to set metadata for',
+ description: 'Address of the account to set metadata for',
}),
url: Flags.url({
required: true,
diff --git a/packages/cli/src/commands/exchange/stable.ts b/packages/cli/src/commands/exchange/stable.ts
index d2f631e2d..dfebf5d5d 100644
--- a/packages/cli/src/commands/exchange/stable.ts
+++ b/packages/cli/src/commands/exchange/stable.ts
@@ -11,7 +11,7 @@ export default class ExchangeStable extends ExchangeStableBase {
...ExchangeStableBase.flags,
stableToken: Flags.option({
options: Object.keys(stableTokenOptions) as (StableToken | Lowercase<StableToken>)[],
- description: 'Name of the stable token to be transfered',
+ description: 'Name of the stable token to be transferred',
})(),
}
diff --git a/packages/cli/src/commands/network/contracts.ts b/packages/cli/src/commands/network/contracts.ts
index bfabc436e..02bc9208d 100644
--- a/packages/cli/src/commands/network/contracts.ts
+++ b/packages/cli/src/commands/network/contracts.ts
@@ -17,7 +17,7 @@ const UNVERSIONED_CONTRACTS = [
const UNPROXIED_CONTRACTS: CeloContract[] = []
export default class Contracts extends BaseCommand {
- static description = 'Lists Celo core contracts and their addesses.'
+ static description = 'Lists Celo core contracts and their addresses.'
static flags = {
...BaseCommand.flags,
diff --git a/packages/cli/src/commands/releasecelo/refund-and-finalize.ts b/packages/cli/src/commands/releasecelo/refund-and-finalize.ts
index b3322caa2..594acb69e 100644
--- a/packages/cli/src/commands/releasecelo/refund-and-finalize.ts
+++ b/packages/cli/src/commands/releasecelo/refund-and-finalize.ts
@@ -4,7 +4,7 @@ import { ReleaseGoldBaseCommand } from '../../utils/release-gold-base'
export default class RefundAndFinalize extends ReleaseGoldBaseCommand {
static description =
- "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 appropriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances."
static flags = {
...ReleaseGoldBaseCommand.flags,
diff --git a/packages/cli/src/commands/transfer/stable.ts b/packages/cli/src/commands/transfer/stable.ts
index e16f20b9b..1f6fc18bf 100644
--- a/packages/cli/src/commands/transfer/stable.ts
+++ b/packages/cli/src/commands/transfer/stable.ts
@@ -11,7 +11,7 @@ export default class TransferStable extends TransferStableBase {
...TransferStableBase.flags,
stableToken: Flags.option({
options: Object.keys(stableTokenOptions) as (StableToken | Lowercase<StableToken>)[],
- description: 'Name of the stable to be transfered',
+ description: 'Name of the stable to be transferred',
})(),
}
diff --git a/packages/docs/command-line-interface/account.md b/packages/docs/command-line-interface/account.md
index a52e6b2ce..db963d79d 100644
--- a/packages/docs/command-line-interface/account.md
+++ b/packages/docs/command-line-interface/account.md
@@ -408,7 +408,7 @@ _See code: [src/commands/account/delete-payment-delegation.ts](https://github.co
## `celocli account:get-metadata ARG1`
-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. Retrieves the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able.
```
USAGE
@@ -453,7 +453,7 @@ FLAGS
property to sort by (prepend '-' for descending)
DESCRIPTION
- Show information about an address. Retreives the metadata URL for an account from the
+ Show information about an address. Retrieves the metadata URL for an account from the
on-chain, then fetches the metadata file off-chain and verifies proofs as able.
EXAMPLES
@@ -897,7 +897,7 @@ _See code: [src/commands/account/register-data-encryption-key.ts](https://github
## `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 retrieve the metadata file and verify your claims
```
USAGE
@@ -922,7 +922,7 @@ FLAGS
Ignore metadata validity checks
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
- (required) Addess of the account to set metadata for
+ (required) Address of the account to set metadata for
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
@@ -948,7 +948,7 @@ FLAGS
(required) The url to the metadata you want to register
DESCRIPTION
- Register metadata URL for an account where users will be able to retieve the metadata
+ Register metadata URL for an account where users will be able to retrieve the metadata
file and verify your claims
EXAMPLES
diff --git a/packages/docs/command-line-interface/exchange.md b/packages/docs/command-line-interface/exchange.md
index f55782f25..58d997630 100644
--- a/packages/docs/command-line-interface/exchange.md
+++ b/packages/docs/command-line-interface/exchange.md
@@ -6,7 +6,6 @@ Exchange Celo Dollars and CELO via Mento
* [`celocli exchange:celo`](#celocli-exchangecelo)
* [`celocli exchange:dollars`](#celocli-exchangedollars)
* [`celocli exchange:euros`](#celocli-exchangeeuros)
-* [`celocli exchange:gold`](#celocli-exchangegold)
* [`celocli exchange:reals`](#celocli-exchangereals)
* [`celocli exchange:show`](#celocli-exchangeshow)
* [`celocli exchange:stable`](#celocli-exchangestable)
@@ -127,48 +126,6 @@ EXAMPLES
_See code: [src/commands/exchange/euros.ts](https://github.com/celo-org/developer-tooling/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
-
-```
-USAGE
- $ celocli exchange:gold --from <value> --value <value> [--gasCurrency <value>]
- [--globalHelp] [--forAtLeast <value>] [--stableToken
- cUSD|cusd|cEUR|ceur|cREAL|creal]
-
-FLAGS
- --forAtLeast=10000000000000000000000 [default: 0] Optional, the
- minimum value of
- StableTokens to receive in
- return
- --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with
- CELO to exchange
- --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
- --stableToken=<option> [default: cusd] Name of the
- stable to receive
- <options: cUSD|cusd|cEUR|ceu
- r|cREAL|creal>
- --value=10000000000000000000000 (required) The value of CELO
- to exchange for a
- StableToken
-
-DESCRIPTION
- Exchange CELO for StableTokens via the stability mechanism. *DEPRECATION WARNING* Use
- the "exchange:celo" command instead
-
-EXAMPLES
- gold --value 5000000000000 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
-
- gold --value 5000000000000 --forAtLeast 100000000000000 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d --stableToken cUSD
-```
-
## `celocli exchange:reals`
Exchange Celo Brazilian Real (cREAL) for CELO via Mento
@@ -261,7 +218,7 @@ FLAGS
--globalHelp View all available global
flags
--stableToken=<option> Name of the stable token to
- be transfered
+ be transferred
<options: cUSD|cusd|cEUR|ceu
r|cREAL|creal>
--value=10000000000000000000000 (required) The value of
diff --git a/packages/docs/command-line-interface/governance.md b/packages/docs/command-line-interface/governance.md
index 3cf712ea4..1ecf88de1 100644
--- a/packages/docs/command-line-interface/governance.md
+++ b/packages/docs/command-line-interface/governance.md
@@ -314,8 +314,9 @@ Submit a governance proposal
```
USAGE
$ celocli governance:propose --jsonTransactions <value> --deposit <value> --from
- <value> --descriptionURL <value> [--gasCurrency <value>] [--globalHelp] [--force]
- [--noInfo] [--afterExecutingProposal <value> | --afterExecutingID <value>]
+ <value> --descriptionURL <value> [--gasCurrency <value>] [--globalHelp] [--for
+ <value> --useMultiSig] [--force] [--noInfo] [--afterExecutingProposal <value> |
+ --afterExecutingID <value>]
FLAGS
--afterExecutingID=<value> Governance proposal
@@ -329,6 +330,8 @@ FLAGS
--descriptionURL=<value> (required) A URL where
further information about
the proposal can be viewed
+ --for=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Address of the multi-sig
+ contract
--force Skip execution check
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Proposer's
address
@@ -343,12 +346,16 @@ FLAGS
transactions
--noInfo Skip printing the proposal
info
+ --useMultiSig True means the request will
+ be sent through multisig.
DESCRIPTION
Submit a governance proposal
EXAMPLES
- propose --jsonTransactions ./transactions.json --deposit 10000 --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 --descriptionURL https://gist.github.com/yorhodes/46430eacb8ed2f73f7bf79bef9d58a33
+ propose --jsonTransactions ./transactions.json --deposit 10000e18 --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 --descriptionURL https://gist.github.com/yorhodes/46430eacb8ed2f73f7bf79bef9d58a33
+
+ propose --jsonTransactions ./transactions.json --deposit 10000e18 --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 --useMultiSig --for 0x6c3dDFB1A9e73B5F49eDD46624F4954Bf66CAe93 --descriptionURL https://gist.github.com/yorhodes/46430eacb8ed2f73f7bf79bef9d58a33
```
_See code: [src/commands/governance/propose.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/governance/propose.ts)_
diff --git a/packages/docs/command-line-interface/network.md b/packages/docs/command-line-interface/network.md
index e24f5744a..203cfbd5c 100644
--- a/packages/docs/command-line-interface/network.md
+++ b/packages/docs/command-line-interface/network.md
@@ -10,7 +10,7 @@ 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 addresses.
```
USAGE
@@ -52,7 +52,7 @@ FLAGS
property to sort by (prepend '-' for descending)
DESCRIPTION
- Lists Celo core contracts and their addesses.
+ Lists Celo core contracts and their addresses.
```
_See code: [src/commands/network/contracts.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/network/contracts.ts)_
diff --git a/packages/docs/command-line-interface/releasecelo.md b/packages/docs/command-line-interface/releasecelo.md
index 930f48d86..acc854416 100644
--- a/packages/docs/command-line-interface/releasecelo.md
+++ b/packages/docs/command-line-interface/releasecelo.md
@@ -148,7 +148,7 @@ _See code: [src/commands/releasecelo/locked-gold.ts](https://github.com/celo-org
## `celocli releasecelo: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 appropriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances.
```
USAGE
@@ -167,8 +167,8 @@ FLAGS
flags
DESCRIPTION
- 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 appropriate parties and destroy the
+ contact. Can only be called by the release owner of revocable ReleaseGold instances.
EXAMPLES
refund-and-finalize --contract 0x5409ED021D9299bf6814279A6A1411A7e866A631
diff --git a/packages/docs/command-line-interface/transfer.md b/packages/docs/command-line-interface/transfer.md
index ddd53bb2a..028592987 100644
--- a/packages/docs/command-line-interface/transfer.md
+++ b/packages/docs/command-line-interface/transfer.md
@@ -243,7 +243,7 @@ FLAGS
--globalHelp View all available global
flags
--stableToken=<option> Name of the stable to be
- transfered
+ transferred
<options: cUSD|cusd|cEUR|ceu
r|cREAL|creal>
--to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the