Skip to content

Latest commit

 

History

History
126 lines (92 loc) · 3.25 KB

README.md

File metadata and controls

126 lines (92 loc) · 3.25 KB
Raw

Chainlink logo


npm GitHub license npm downloads

Chainlink Belt is a toolbelt for performing various commands on Chainlink smart contracts. This cli tool is currently used within @chainlink/contracts for the usage of running build and development tools across multiple solidity contract versions.

Usage

$ npm install -g @chainlink/belt
$ belt COMMAND
running command...
$ belt (-v|--version|version)
@chainlink/belt/0.0.3 darwin-x64 node-v12.18.4
$ belt --help [COMMAND]
USAGE
  $ belt COMMAND
...

Commands

belt box [PATH]

Modify a truffle box to a specified solidity version

USAGE
  $ belt box [PATH]

ARGUMENTS
  PATH  the path to the truffle box

OPTIONS
  -d, --dryRun         output the replaced strings, but dont change them
  -h, --help           show CLI help
  -i, --interactive    run this command in interactive mode
  -l, --list           list the available solidity versions

  -s, --solVer=solVer  the solidity version to change the truffle box to
                       either a solidity version alias "v0.6" | "0.6" or its full version "0.6.2"

EXAMPLES
  belt box --solVer 0.6 -d path/to/box
  belt box --interactive path/to/box
  belt box -l

See code: src/src/commands/box.ts

belt compile [COMPILER]

Run various compilers and/or codegenners that target solidity smart contracts.

USAGE
  $ belt compile [COMPILER]

ARGUMENTS
  COMPILER  (solc|ethers|truffle|all) Compile solidity smart contracts and output their artifacts

OPTIONS
  -c, --config=config  [default: app.config.json] Location of the configuration file
  -h, --help           show CLI help

EXAMPLE
  $ belt compile all

  Creating directory at abi/v0.4...
  Creating directory at abi/v0.5...
  Creating directory at abi/v0.6...
  Compiling 35 contracts...
  ...
  ...
  Aggregator artifact saved!
  AggregatorProxy artifact saved!
  Chainlink artifact saved!
  ...

See code: src/src/commands/compile.ts

belt help [COMMAND]

display help for belt

USAGE
  $ belt help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help