Skip to main content

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

Metadata

Release files for cic-cli 0.5.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cic-cli 0.5.5
File Size Uploaded Provenance Actions
cic_cli-0.5.5.tar.gz 40.1 kB Without provenance Details for cic_cli-0.5.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cic-cli 0.5.5
File Interpreter ABI Platform Actions
cic_cli-0.5.5-py3-none-any.whl Python 3 none any Details for cic_cli-0.5.5-py3-none-any.whl

Total release size: 90.8 kB

Release files / cic_cli-0.5.5.tar.gz

Download URL cic_cli-0.5.5.tar.gz
Size 40.1 kB
Tags Source
SHA-256 checksum
How to use checksums
2d536bb56bef45c07fe2003d1f12c897cfb27b0e64a2b41698c9ad292ea6634f
BLAKE2b-256 checksum
How to use checksums
6ca4630d5b5734721f72749ac4c2e623852287ddb7c85b45b2502cde1f2d4da9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.1 CPython/3.10.5 Linux/5.15.0-60-generic

Release files / cic_cli-0.5.5-py3-none-any.whl

Download URL cic_cli-0.5.5-py3-none-any.whl
Size 50.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ced3f1c2d7d64ebcb191d763d314aa28f969ce0c2b12df2730c74c9a212485e5
BLAKE2b-256 checksum
How to use checksums
ba2e9c1f41fc0b6aeda6ae21daf15a0567c660e5a971a505904eadca111080d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.1 CPython/3.10.5 Linux/5.15.0-60-generic

Security for cic-cli 0.5.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page