71 lines
1.7 KiB
Markdown
71 lines
1.7 KiB
Markdown
# CIC Token Deployment Tool
|
|
[](https://ci.grassecon.net/grassrootseconomics/cic)
|
|
[](https://pypi.org/project/cic/)
|
|
|
|
CIC-CLI provides tooling to generate and publish metadata in relation to
|
|
token deployments.
|
|
|
|
```shell
|
|
pip install --extra-index-url https://pip.grassrootseconomics.net cic[eth]
|
|
```
|
|
|
|
## 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:
|
|
|
|
```shell
|
|
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:
|
|
|
|
```shell
|
|
cic ext --registry <contract_registry_address> -d <settings_folder> -i <chain_spec> -p <rpc_endpoint> eth
|
|
```
|
|
|
|
|
|
## Structure of the components
|
|
|
|
|
|
|
|
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
|
|
- [poetry](https://python-poetry.org/docs/#installation)
|
|
### Setup
|
|
|
|
```
|
|
poetry install -E eth
|
|
```
|
|
|
|
### Running the CLI
|
|
|
|
```bash
|
|
poetry run cic -h
|
|
```
|
|
|
|
```bash
|
|
poetry run cic wizard ./somewhere -c ./config/dev-docker
|
|
```
|
|
### Tests
|
|
|
|
```
|
|
poetry run pytest
|
|
```
|