Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@celo/celocli

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@celo/celocli

CLI Tool for transacting with the Celo protocol

0.0.6
Source
npm

Version published: 5 years ago

Weekly downloads: 256; increased by42.22%

Maintainers: 5

Weekly downloads

Created: 5 years ago

Source

celo-cli

Tool for transacting with the Celo protocol

Usage

$ npm install -g @celo/celocli
$ celocli COMMAND
running command...
$ celocli (-v|--version|version)
@celo/celocli/0.0.6 darwin-x64 node-v8.15.0
$ celocli --help [COMMAND]
USAGE
  $ celocli COMMAND
...

Commands

`celocli account:balance ACCOUNT`

View token balances given account address

USAGE
  $ celocli account:balance ACCOUNT

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  balance 0x5409ed021d9299bf6814279a6a1411a7e866a631

See code: src/commands/account/balance.ts

`celocli account:new`

Creates a new account

USAGE
  $ celocli account:new

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  new

See code: src/commands/account/new.ts

`celocli account:transferdollar`

Transfer dollar

USAGE
  $ celocli account:transferdollar

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --amountInWei=amountInWei                          (required) Amount to transfer (in wei)
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Address of the sender
  --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d    (required) Address of the receiver

EXAMPLE
  transfer --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to 0x5409ed021d9299bf6814279a6a1411a7e866a631 
  --amountInWei 1

See code: src/commands/account/transferdollar.ts

`celocli account:transfergold`

Transfer gold

USAGE
  $ celocli account:transfergold

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --amountInWei=amountInWei                          (required) Amount to transfer (in wei)
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Address of the sender
  --to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d    (required) Address of the receiver

EXAMPLE
  transfer --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to 0x5409ed021d9299bf6814279a6a1411a7e866a631 
  --amountInWei 1

See code: src/commands/account/transfergold.ts

`celocli account:unlock`

Unlock an account address to send transactions

USAGE
  $ celocli account:unlock

OPTIONS
  -h, --help                                            show CLI help
  -l, --logLevel=logLevel
  --account=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Account Address
  --password=password                                   (required)

EXAMPLE
  unlock --account 0x5409ed021d9299bf6814279a6a1411a7e866a631 --password 1234

See code: src/commands/account/unlock.ts

`celocli bonds:deposit`

Create a bonded deposit given notice period and gold amount

USAGE
  $ celocli bonds:deposit

OPTIONS
  -h, --help                   show CLI help
  -l, --logLevel=logLevel
  --from=from                  (required)
  --goldAmount=goldAmount      (required) unit amount of gold token (cGLD)

  --noticePeriod=noticePeriod  (required) duration (seconds) from notice to withdrawable; doubles as ID of a bonded
                               deposit;

EXAMPLE
  deposit --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --noticePeriod 8640 --goldAmount 1000000000000000000

See code: src/commands/bonds/deposit.ts

`celocli bonds:list ACCOUNT`

View information about all of the account's deposits

USAGE
  $ celocli bonds:list ACCOUNT

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  list 0x5409ed021d9299bf6814279a6a1411a7e866a631

See code: src/commands/bonds/list.ts

`celocli bonds:notify`

Notify a bonded deposit given notice period and gold amount

USAGE
  $ celocli bonds:notify

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Account Address
  --goldAmount=goldAmount                            (required) unit amount of gold token (cGLD)

  --noticePeriod=noticePeriod                        (required) duration (seconds) from notice to withdrawable; doubles
                                                     as ID of a bonded deposit;

EXAMPLE
  notify --noticePeriod=3600 --goldAmount=500

See code: src/commands/bonds/notify.ts

`celocli bonds:register`

USAGE
  $ celocli bonds:register

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Account Address

EXAMPLE
  register

See code: src/commands/bonds/register.ts

`celocli bonds:rewards`

Manage rewards for bonded deposit account

USAGE
  $ celocli bonds:rewards

OPTIONS
  -d, --delegate=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  Delegate rewards to provided account
  -h, --help                                                 show CLI help
  -l, --logLevel=logLevel
  -r, --redeem                                               Redeem accrued rewards from bonded deposits
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d          (required) Account Address

EXAMPLES
  rewards --redeem
  rewards --delegate=0x56e172F6CfB6c7D01C1574fa3E2Be7CC73269D95

See code: src/commands/bonds/rewards.ts

`celocli bonds:show ACCOUNT`

View bonded gold and corresponding account weight of a deposit given ID

USAGE
  $ celocli bonds:show ACCOUNT

OPTIONS
  -h, --help                           show CLI help
  -l, --logLevel=logLevel
  --availabilityTime=availabilityTime  unix timestamp at which withdrawable; doubles as ID of a notified deposit

  --noticePeriod=noticePeriod          duration (seconds) from notice to withdrawable; doubles as ID of a bonded
                                       deposit;

EXAMPLES
  show 0x5409ed021d9299bf6814279a6a1411a7e866a631 --noticePeriod=3600
  show 0x5409ed021d9299bf6814279a6a1411a7e866a631 --availabilityTime=1562206887

See code: src/commands/bonds/show.ts

`celocli bonds:withdraw AVAILABILITYTIME`

Withdraw notified deposit given availability time

USAGE
  $ celocli bonds:withdraw AVAILABILITYTIME

ARGUMENTS
  AVAILABILITYTIME  unix timestamp at which withdrawable; doubles as ID of a notified deposit

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Account Address

EXAMPLE
  withdraw 3600

See code: src/commands/bonds/withdraw.ts

`celocli config:get`

Output network node configuration

USAGE
  $ celocli config:get

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

See code: src/commands/config/get.ts

`celocli config:set`

Configure running node information for propogating transactions to network

USAGE
  $ celocli config:set

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel
  --node=node              (required) [default: ws://localhost:8546] Node URL

See code: src/commands/config/set.ts

`celocli exchange:list`

List information about tokens on the exchange (all amounts in wei)

USAGE
  $ celocli exchange:list

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel
  --amount=amount          [default: 1000000000000000000] Amount of sellToken (in wei) to report rates for

EXAMPLE
  list

See code: src/commands/exchange/list.ts

`celocli exchange:selldollar SELLAMOUNT MINBUYAMOUNT FROM`

Sell Celo dollars for Celo gold on the exchange

USAGE
  $ celocli exchange:selldollar SELLAMOUNT MINBUYAMOUNT FROM

ARGUMENTS
  SELLAMOUNT    the amount of sellToken (in wei) to sell
  MINBUYAMOUNT  the minimum amount of buyToken (in wei) expected
  FROM

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  selldollar 100 300 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d

See code: src/commands/exchange/selldollar.ts

`celocli exchange:sellgold SELLAMOUNT MINBUYAMOUNT FROM`

Sell Celo gold for Celo dollars on the exchange

USAGE
  $ celocli exchange:sellgold SELLAMOUNT MINBUYAMOUNT FROM

ARGUMENTS
  SELLAMOUNT    the amount of sellToken (in wei) to sell
  MINBUYAMOUNT  the minimum amount of buyToken (in wei) expected
  FROM

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  sellgold 100 300 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d

See code: src/commands/exchange/sellgold.ts

`celocli help [COMMAND]`

display help for celocli

USAGE
  $ celocli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`celocli node:accounts`

List node accounts

USAGE
  $ celocli node:accounts

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

See code: src/commands/node/accounts.ts

`celocli validator:affiliation`

Manage affiliation to a ValidatorGroup

USAGE
  $ celocli validator:affiliation

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Validator's address
  --set=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d   set affiliation to given address
  --unset                                            clear affiliation field

EXAMPLES
  affiliation --set 0x97f7333c51897469e8d98e7af8653aab468050a3 --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
  affiliation --unset --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95

See code: src/commands/validator/affiliation.ts

`celocli validator:list`

List existing Validators

USAGE
  $ celocli validator:list

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  list

See code: src/commands/validator/list.ts

`celocli validator:register`

USAGE
  $ celocli validator:register

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Address for the Validator
  --id=id                                            (required)
  --name=name                                        (required)
  --noticePeriod=noticePeriod                        (required) Notice Period for the Bonded deposit to use
  --publicKey=0x                                     (required) Public Key
  --url=url                                          (required)

EXAMPLE
  register --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --id myID --name myNAme --noticePeriod 5184000 --url 
  "http://validator.com" --publicKey 
  0xc52f3fab06e22a54915a8765c4f6826090cfac5e40282b43844bf1c0df83aaa632e55b67869758f2291d1aabe0ebecc7cbf4236aaa45e3e0cfbf
  997eda082ae1

See code: src/commands/validator/register.ts

`celocli validator:show VALIDATORADDRESS`

Show information about an existing Validator

USAGE
  $ celocli validator:show VALIDATORADDRESS

ARGUMENTS
  VALIDATORADDRESS  Validator's address

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  show 0x97f7333c51897469E8D98E7af8653aAb468050a3

See code: src/commands/validator/show.ts

`celocli validatorgroup:list`

List existing Validator Groups

USAGE
  $ celocli validatorgroup:list

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  list

See code: src/commands/validatorgroup/list.ts

`celocli validatorgroup:member VALIDATORADDRESS`

USAGE
  $ celocli validatorgroup:member VALIDATORADDRESS

ARGUMENTS
  VALIDATORADDRESS  Validator's address

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --accept                                           Accept a validatior whose affiliation is already set to the vgroup
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) ValidatorGroup's address
  --remove                                           Remove a validatior from the members list

EXAMPLES
  member --accept 0x97f7333c51897469e8d98e7af8653aab468050a3 
  member --remove 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95

See code: src/commands/validatorgroup/member.ts

`celocli validatorgroup:register`

USAGE
  $ celocli validatorgroup:register

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Address for the Validator Group
  --id=id                                            (required)
  --name=name                                        (required)
  --noticePeriod=noticePeriod                        (required) Notice Period for the Bonded deposit to use
  --url=url                                          (required)

EXAMPLE
  register --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --id myID --name myNAme --noticePeriod 5184000 --url 
  "http://vgroup.com"

See code: src/commands/validatorgroup/register.ts

`celocli validatorgroup:show GROUPADDRESS`

Show information about an existing Validator Group

USAGE
  $ celocli validatorgroup:show GROUPADDRESS

ARGUMENTS
  GROUPADDRESS  ValidatorGroup's address

OPTIONS
  -h, --help               show CLI help
  -l, --logLevel=logLevel

EXAMPLE
  show 0x97f7333c51897469E8D98E7af8653aAb468050a3

See code: src/commands/validatorgroup/show.ts

`celocli validatorgroup:vote`

Vote for a Validator Group

USAGE
  $ celocli validatorgroup:vote

OPTIONS
  -h, --help                                         show CLI help
  -l, --logLevel=logLevel
  --current                                          Show voter's current vote
  --for=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d   Set vote for ValidatorGroup's address
  --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d  (required) Voter's address
  --revoke                                           Revoke voter's current vote

EXAMPLES
  vote --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --for 0x932fee04521f5fcb21949041bf161917da3f588b
  vote --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --revoke
  vote --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --current

See code: src/commands/validatorgroup/vote.ts

Keywords

FAQs

What is @celo/celocli?

Is @celo/celocli popular?

Is @celo/celocli well maintained?

Package last updated on 16 Jul 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@celo/celocli

celo-cli

Usage

Commands

celocli account:balance ACCOUNT

celocli account:new

celocli account:transferdollar

celocli account:transfergold

celocli account:unlock

celocli bonds:deposit

celocli bonds:list ACCOUNT

celocli bonds:notify

celocli bonds:register

celocli bonds:rewards

celocli bonds:show ACCOUNT

celocli bonds:withdraw AVAILABILITYTIME

celocli config:get

celocli config:set

celocli exchange:list

celocli exchange:selldollar SELLAMOUNT MINBUYAMOUNT FROM

celocli exchange:sellgold SELLAMOUNT MINBUYAMOUNT FROM

celocli help [COMMAND]

celocli node:accounts

celocli validator:affiliation

celocli validator:list

celocli validator:register

celocli validator:show VALIDATORADDRESS

celocli validatorgroup:list

celocli validatorgroup:member VALIDATORADDRESS

celocli validatorgroup:register

celocli validatorgroup:show GROUPADDRESS

celocli validatorgroup:vote

Keywords

Related posts

NVD Backlog Tops 20,000 CVEs Awaiting Analysis as NIST Prepares System Updates

Malicious npm Package Exploits WhatsApp Authentication with Remote Kill Switch for File Destruction

`celocli account:balance ACCOUNT`

`celocli account:new`

`celocli account:transferdollar`

`celocli account:transfergold`

`celocli account:unlock`

`celocli bonds:deposit`

`celocli bonds:list ACCOUNT`

`celocli bonds:notify`

`celocli bonds:register`

`celocli bonds:rewards`

`celocli bonds:show ACCOUNT`

`celocli bonds:withdraw AVAILABILITYTIME`

`celocli config:get`

`celocli config:set`

`celocli exchange:list`

`celocli exchange:selldollar SELLAMOUNT MINBUYAMOUNT FROM`

`celocli exchange:sellgold SELLAMOUNT MINBUYAMOUNT FROM`

`celocli help [COMMAND]`

`celocli node:accounts`

`celocli validator:affiliation`

`celocli validator:list`

`celocli validator:register`

`celocli validator:show VALIDATORADDRESS`

`celocli validatorgroup:list`

`celocli validatorgroup:member VALIDATORADDRESS`

`celocli validatorgroup:register`

`celocli validatorgroup:show GROUPADDRESS`

`celocli validatorgroup:vote`