cic-cli/README.md
William Luke be5d988fa4
Some checks failed
continuous-integration/drone/push Build is failing
continuous-integration/drone/pr Build is failing
docs: add badge
2022-03-01 11:22:14 +03:00

1.6 KiB

CIC Token Deployment Tool

Status Version

CIC-CLI provides tooling to generate and publish metadata in relation to token deployments.

pip install --extra-index-url https://pip.grassrootseconomics.net cic

Usage

Using the wizard

# Local
cic wizard ./somewhere -c ./config/dev-docker

# Production
cic wizard ./somewhere -c ./config/prod

Modular

Some of the concepts described below assume familiarity with base concepts of the CIC architecture. Please refer to the appropriate documentation for more information.

To initialize a new token deployment for the EVM:

cic init --target eth --name <token_name> --symbol <token_symbol> --precision <token_value_precision> <settings_folder>

To automatically fill in settings detected in the network for the EVM:

cic ext --registry <contract_registry_address> -d <settings_folder> -i <chain_spec> -p <rpc_endpoint> eth

Structure of the components

image

CIC-CLI is designed to interface any network type backend. The current state of the package contains interface to EVM only. Thus, the examples below are limited to the context of the EVM.

Development

Requirements

Setup

 poetry install

Running the CLI

 poetry run cic -h

Tests

poetry run pytest