cicnet/cic-cli
5
1
Fork 0
Code Issues Pull Requests Projects Releases 18 Wiki Activity
Generic cli tooling for the CIC token network
62 Commits 5 Branches 19 Tags 403 KiB
Python 100%
429e3e0f99
Go to file
nolash 429e3e0f99
Try html readme
2021-11-30 10:47:59 +01:00
cic Add sphinx doc setup 2021-11-30 08:14:57 +01:00
doc/sphinx Add readme 2021-11-30 09:01:47 +01:00
tests docstrings for eth extension 2021-11-29 19:15:10 +01:00
.gitignore Initial commit 2021-10-09 18:50:43 +02:00
components.svg Add component diagram symlink 2021-11-30 10:34:46 +01:00
eth_requirements.txt Add writer to token index deploy in eth tests 2021-11-29 15:05:09 +01:00
LICENSE Initial commit 2021-10-09 18:50:43 +02:00
MANIFEST.in Add token deployment 2021-10-10 15:37:26 +02:00
README.html Try html readme 2021-11-30 10:47:59 +01:00
README.md Try html readme 2021-11-30 10:47:59 +01:00
requirements.txt Add writer to token index deploy in eth tests 2021-11-29 15:05:09 +01:00
run_tests.sh Add ciceth rpc tests 2021-10-10 13:48:32 +02:00
setup.cfg Add sphinx doc setup 2021-11-30 08:14:57 +01:00
setup.py Add eth initializer 2021-10-18 10:47:48 +02:00
test_requirements.txt Make tests pass 2021-10-15 12:48:14 +02:00

README.md

CIC token deployment tool

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

To install the project (replacing <VERSION> with the current version: 0.0.1):

python setup.py sdist
pip install --extra-index-url https://pip.grassrootseconomics.net:8433 dist/cic-<VERSION>.tar.gz

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.

Preparing for EVM token deployment

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