0.0.1 • Published 4 years ago

cbase-shell v0.0.1

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

cbase Shell command line interface

CBase Shell is a Node.js application that to generate secure keys, connect to the cbase platform and send transactions to the network on your behalf.

note that Node.js version 10+ is required to run CBase Shell

Installation

npm install -g cbase-shell

Usage

In command line, from directory with your project:

cbase <command>

Commands

For account:

  cbase login                                       # logging in through cbase protocol wallet
  cbase create_account <accountId>                  # create a developer account with --masterAccount(required), publicKey and initialBalance
  cbase state <accountId>                           # view account state
  cbase keys <accountId>                            # view account public keys
  cbase send <sender> <receiver> <amount>           # send tokens to given receiver
  cbase stake <accountId> <stakingKey> <amount>     # create staking transaction (stakingKey is base58 encoded)
  cbase delete <accountId> <beneficiaryId>          # delete an account and transfer funds to beneficiary account

For smart contract:

  cbase build                                       # build your smart contract
  cbase deploy                                      # deploy your smart contract
  cbase call <contractName> <methodName> [args]     # schedule smart contract call which can modify state
  cbase view <contractName> <methodName> [args]     # make smart contract call which can view state
  cbase clean                                       # clean the smart contract build locally (remove ./out )

For transactions:

  cbase tx-status <hash>                            # lookup transaction status by hash

Misc:

  cbase repl                                        # launch interactive Node.js shell with cbase connection available to use
  cbase generate-key <account-id>                   # generate key

Options

OptionDescriptionTypeDefault
--helpShow helpboolean
--versionShow version numberboolean
--nodeUrlcbase node URLstring"http://localhost:3030"
--networkIdcbase network ID for different keys by networkstring"default"
--helperUrlcbase contract helper URLstring
--keyPathPath to master account keystring
--accountIdUnique identifier for the accountstring
--masterAccountAccount used to create requested account.string
--publicKeyPublic key to initialize the account withstring
--initialBalanceNumber of tokens to transfer to newly accountstring

License

This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE and LICENSE-APACHE for details.