Skip to main content

Generic cli tooling for the CIC token network

Project description

CIC Token Deployment Tool

Status Version

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

pip install cic-cli[eth]

Usage

Using the wizard

First make sure that you edit the configs below to add your paths for [auth]keyfile_path and [wallet]keyfile The configs are located in ~/.config/cic/cli/config/

# Local
cic wizard ./somewhere -c ~/.config/cic/cli/config/docker

# Test Net
cic wizard ./somewhere -c ~/.config/cic/cli/config/testnet

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 -E eth

Running the CLI

 poetry run cic -h
 poetry run cic wizard ./somewhere -c ./config/docker

Importing a wallet from metamask

  • Export the accounts private key Instructions
  • Save the private key to a file
  • Run eth-keyfile -k <file> > ~/.config/cic/keystore/keyfile.json

Port Forwarding

Install Kubectl
sudo apt-get update
sudo apt-get install -y apt-transport-https ca-certificates curl
sudo curl -fsSLo /usr/share/keyrings/kubernetes-archive-keyring.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg
echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee /etc/apt/sources.list.d/kubernetes.list
sudo apt-get update
sudo apt-get install -y kubectl
  • Download testnet cluster config from https://cloud.digitalocean.com/kubernetes/clusters
  • Move the config to $HOME/.kube/
  • Run kubectl -n grassroots --kubeconfig=$HOME/.kube/<config_file_name>.yaml get pods
  • Copy the name of the meta pod (e.g cic-meta-server-67dc7c6468-8rhdq)
  • Port foward the meta pod to the local machine using kubectl port-forward pods/<name_of_meta_pod> 6700:8000 -n grassroots --kubeconfig=$HOME/.kube/<config_file_name>.yaml
  • Clone this repository to your local machine
  • Run poetry install -E eth in the repo root
  • Open ./cic/config/testnet/config.ini and change
    • [auth]keyfile_path
    • [wallet]key_file
  • Open a new terminal and run poetry run cic wizard -c ./cic/config/testnet ./somewhere

Tests

poetry run pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cic_cli-0.5.5.tar.gz (40.1 kB view details)

Uploaded Source

Built Distribution

cic_cli-0.5.5-py3-none-any.whl (50.7 kB view details)

Uploaded Python 3

File details

Details for the file cic_cli-0.5.5.tar.gz.

File metadata

  • Download URL: cic_cli-0.5.5.tar.gz
  • Upload date:
  • Size: 40.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.10.5 Linux/5.15.0-60-generic

File hashes

Hashes for cic_cli-0.5.5.tar.gz
Algorithm Hash digest
SHA256 2d536bb56bef45c07fe2003d1f12c897cfb27b0e64a2b41698c9ad292ea6634f
MD5 e87cd60e36db039063e28c726b91436e
BLAKE2b-256 6ca4630d5b5734721f72749ac4c2e623852287ddb7c85b45b2502cde1f2d4da9

See more details on using hashes here.

File details

Details for the file cic_cli-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: cic_cli-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 50.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.10.5 Linux/5.15.0-60-generic

File hashes

Hashes for cic_cli-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ced3f1c2d7d64ebcb191d763d314aa28f969ce0c2b12df2730c74c9a212485e5
MD5 38088be80cf4574d6c30c97866bedbeb
BLAKE2b-256 ba2e9c1f41fc0b6aeda6ae21daf15a0567c660e5a971a505904eadca111080d3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page