Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

@titan-suite/cli

0.1.7 • Public • Published

Titan CLI

The complete Smart Contract development CLI

oclif Version CircleCI

Downloads/week License Chat

Usage

  • yarn add global @titan-suite/cli or npm i -g @titan-suite/cli
  • In your project root, create a titanrc.js file and specify the following:
    • host: the URL of your aion-web3 provider
    • port: the port exposing an aion-web3 instance, usually 8545
    • defaultAccount [optional]: the default address to call functions with
    • password [optional]: the password of this account
   module.exports = {
       "host": "http://127.0.0.1",
       "port": 8545,
       "defaultAccount": "",
       "password": ""
   }

Commands

Help

  • titan --help

titan init

Generate an empty Titan project

  • in the current directory: titan init
  • in a new directory: titan init <name>

titan unpack

Start a new project with a pre-built dApp

  • titan unpack
    • choose a pack from the options
  • titan unpack <name>

titan compile

Compile a Solidity smart contract

  • titan compile path/to/contracts/Example.sol
  • Compile a specific contract withing a file
    • titan compile -n SpecificContract path/to/contracts/ManyContracts.sol
  • Output more details about the contract
    • titan compile -d path/to/contracts/Example.sol

titan deploy

Deploy a smart contract to an AION node

  • titan deploy path/to/contracts/Example.sol
  • Deploy a specific contract within a contract file:
    • titan deploy -n Test path/to/contracts/Example.sol
  • Pass parameters:
    • titan deploy -p 5 path/to/contracts/Example.sol The details of the deployed contract will be stored as ./build/bots/<contractName>.json

titan lint

Lint a smart contract

  • titan lint path/to/contracts/Example.sol
  • lint multiple files within a directory
    • titan lint path/to/contracts/**/*.sol

titan test

Run unit tests

  • titan test path/to/contracts/testExample.js

titan unlock

Unlock an account

You may be prompted to enter an AION address and/or password

  • titan unlock
  • with the account specified
    • titan unlock -a <0x..>
  • with both the account and password specified
    • titan unlock -a <0x...> -p <pwd>

titan console

Interact with an AION node with an injected aion-web3 instance

  • titan console

Test

  • Create a titanrc.js as specified above
  • yarn test

Community

Join us on Gitter

install

npm i @titan-suite/cli

Downloadsweekly downloads

60

version

0.1.7

license

Apache-2.0

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability