170 lines
13 KiB
HTML
170 lines
13 KiB
HTML
|
<!DOCTYPE html>
|
||
|
<html xmlns="http://www.w3.org/1999/xhtml" lang xml:lang>
|
||
|
<head>
|
||
|
<meta charset="utf-8" />
|
||
|
<meta name="generator" content="pandoc" />
|
||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
|
||
|
<title>CIC token deployment tool</title>
|
||
|
<style>
|
||
|
html {
|
||
|
line-height: 1.5;
|
||
|
font-family: Georgia, serif;
|
||
|
font-size: 20px;
|
||
|
color: #1a1a1a;
|
||
|
background-color: #fdfdfd;
|
||
|
}
|
||
|
body {
|
||
|
margin: 0 auto;
|
||
|
max-width: 36em;
|
||
|
padding-left: 50px;
|
||
|
padding-right: 50px;
|
||
|
padding-top: 50px;
|
||
|
padding-bottom: 50px;
|
||
|
hyphens: auto;
|
||
|
word-wrap: break-word;
|
||
|
text-rendering: optimizeLegibility;
|
||
|
font-kerning: normal;
|
||
|
}
|
||
|
@media (max-width: 600px) {
|
||
|
body {
|
||
|
font-size: 0.9em;
|
||
|
padding: 1em;
|
||
|
}
|
||
|
}
|
||
|
@media print {
|
||
|
body {
|
||
|
background-color: transparent;
|
||
|
color: black;
|
||
|
font-size: 12pt;
|
||
|
}
|
||
|
p, h2, h3 {
|
||
|
orphans: 3;
|
||
|
widows: 3;
|
||
|
}
|
||
|
h2, h3, h4 {
|
||
|
page-break-after: avoid;
|
||
|
}
|
||
|
}
|
||
|
p {
|
||
|
margin: 1em 0;
|
||
|
}
|
||
|
a {
|
||
|
color: #1a1a1a;
|
||
|
}
|
||
|
a:visited {
|
||
|
color: #1a1a1a;
|
||
|
}
|
||
|
img {
|
||
|
max-width: 100%;
|
||
|
}
|
||
|
h1, h2, h3, h4, h5, h6 {
|
||
|
margin-top: 1.4em;
|
||
|
}
|
||
|
h5, h6 {
|
||
|
font-size: 1em;
|
||
|
font-style: italic;
|
||
|
}
|
||
|
h6 {
|
||
|
font-weight: normal;
|
||
|
}
|
||
|
ol, ul {
|
||
|
padding-left: 1.7em;
|
||
|
margin-top: 1em;
|
||
|
}
|
||
|
li > ol, li > ul {
|
||
|
margin-top: 0;
|
||
|
}
|
||
|
blockquote {
|
||
|
margin: 1em 0 1em 1.7em;
|
||
|
padding-left: 1em;
|
||
|
border-left: 2px solid #e6e6e6;
|
||
|
color: #606060;
|
||
|
}
|
||
|
code {
|
||
|
font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
|
||
|
font-size: 85%;
|
||
|
margin: 0;
|
||
|
}
|
||
|
pre {
|
||
|
margin: 1em 0;
|
||
|
overflow: auto;
|
||
|
}
|
||
|
pre code {
|
||
|
padding: 0;
|
||
|
overflow: visible;
|
||
|
}
|
||
|
.sourceCode {
|
||
|
background-color: transparent;
|
||
|
overflow: visible;
|
||
|
}
|
||
|
hr {
|
||
|
background-color: #1a1a1a;
|
||
|
border: none;
|
||
|
height: 1px;
|
||
|
margin: 1em 0;
|
||
|
}
|
||
|
table {
|
||
|
margin: 1em 0;
|
||
|
border-collapse: collapse;
|
||
|
width: 100%;
|
||
|
overflow-x: auto;
|
||
|
display: block;
|
||
|
font-variant-numeric: lining-nums tabular-nums;
|
||
|
}
|
||
|
table caption {
|
||
|
margin-bottom: 0.75em;
|
||
|
}
|
||
|
tbody {
|
||
|
margin-top: 0.5em;
|
||
|
border-top: 1px solid #1a1a1a;
|
||
|
border-bottom: 1px solid #1a1a1a;
|
||
|
}
|
||
|
th {
|
||
|
border-top: 1px solid #1a1a1a;
|
||
|
padding: 0.25em 0.5em 0.25em 0.5em;
|
||
|
}
|
||
|
td {
|
||
|
padding: 0.125em 0.5em 0.25em 0.5em;
|
||
|
}
|
||
|
header {
|
||
|
margin-bottom: 4em;
|
||
|
text-align: center;
|
||
|
}
|
||
|
#TOC li {
|
||
|
list-style: none;
|
||
|
}
|
||
|
#TOC a:not(:hover) {
|
||
|
text-decoration: none;
|
||
|
}
|
||
|
code{white-space: pre-wrap;}
|
||
|
span.smallcaps{font-variant: small-caps;}
|
||
|
span.underline{text-decoration: underline;}
|
||
|
div.column{display: inline-block; vertical-align: top; width: 50%;}
|
||
|
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
|
||
|
ul.task-list{list-style: none;}
|
||
|
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
|
||
|
</style>
|
||
|
<!--[if lt IE 9]>
|
||
|
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
|
||
|
<![endif]-->
|
||
|
</head>
|
||
|
<body>
|
||
|
<header id="title-block-header">
|
||
|
<h1 class="title">CIC token deployment tool</h1>
|
||
|
</header>
|
||
|
<p>CIC-CLI provides tooling to generate and publish metadata in relation to token deployments.</p>
|
||
|
<p>To install the project (replacing <VERSION> with the current version: 0.0.1):</p>
|
||
|
<pre class="shell"><code>python setup.py sdist
|
||
|
pip install --extra-index-url https://pip.grassrootseconomics.net:8433 dist/cic-<VERSION>.tar.gz</code></pre>
|
||
|
<h1 id="structure-of-the-components">Structure of the components</h1>
|
||
|
<p><img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhRE9DVFlQRSBzdmcgUFVCTElDICItLy9XM0MvL0RURCBTVkcgMS4xLy9FTiIKICJodHRwOi8vd3d3LnczLm9yZy9HcmFwaGljcy9TVkcvMS4xL0RURC9zdmcxMS5kdGQiPgo8IS0tIEdlbmVyYXRlZCBieSBncmFwaHZpeiB2ZXJzaW9uIDIuNDkuMCAoMCkKIC0tPgo8IS0tIFBhZ2VzOiAxIC0tPgo8c3ZnIHdpZHRoPSI0NTZwdCIgaGVpZ2h0PSIyNjBwdCIKIHZpZXdCb3g9IjAuMDAgMC4wMCA0NTUuNTAgMjYwLjAwIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIj4KPGcgaWQ9ImdyYXBoMCIgY2xhc3M9ImdyYXBoIiB0cmFuc2Zvcm09InNjYWxlKDEgMSkgcm90YXRlKDApIHRyYW5zbGF0ZSg0IDI1NikiPgo8cG9seWdvbiBmaWxsPSJ3aGl0ZSIgc3Ryb2tlPSJ0cmFuc3BhcmVudCIgcG9pbnRzPSItNCw0IC00LC0yNTYgNDUxLjUsLTI1NiA0NTEuNSw0IC00LDQiLz4KPCEtLSBpbW11dGFibGVfZGF0YSAtLT4KPGcgaWQ9Im5vZGUxIiBjbGFzcz0ibm9kZSI+Cjx0aXRsZT5pbW11dGFibGVfZGF0YTwvdGl0bGU+Cjxwb2x5Z29uIGZpbGw9Im5vbmUiIHN0cm9rZT0iYmxhY2siIHBvaW50cz0iNDQ3LjUsLTM2IDI4MS41LC0zNiAyODEuNSwwIDQ0Ny41LDAgNDQ3LjUsLTM2Ii8+Cjx0ZXh0IHRleHQtYW5jaG9yPSJtaWRkbGUiIHg9IjM2NC41IiB5PSItMTQuMyIgZm9udC1mYW1pbHk9IlRpbWVzLHNlcmlmIiBmb250LXNpemU9IjE0LjAwIj5JbW11dGFibGUgbWV0YWRhdGE8L3RleHQ+CjwvZz4KPCEtLSBtdXRhYmxlX2RhdGEgLS0+CjxnIGlkPSJub2RlMiIgY2xhc3M9Im5vZGUiPgo8dGl0bGU+bXV0YWJsZV9kYXRhPC90aXRsZT4KPHBvbHlnb24gZmlsbD0ibm9uZSIgc3Ryb2tlPSJibGFjayIgcG9pbnRzPSIyNjMuNSwtMzYgMTE1LjUsLTM2IDExNS41LDAgMjYzLjUsMCAyNjMuNSwtMzYiLz4KPHRleHQgdGV4dC1hbmNob3I9Im1pZGRsZSIgeD0iMTg5LjUiIHk9Ii0xNC4zIiBmb250LWZhbWlseT0iVGltZXMsc2VyaWYiIGZvbnQtc2l6ZT0iMTQuMDAiPk11dGFibGUgbWV0YWRhdGE8L3RleHQ+CjwvZz4KPCEtLSB0b2tlbl9zbWFydF9jb250cmFjdCAtLT4KPGcgaWQ9Im5vZGUzIiBjbGFzcz0ibm9kZSI+Cjx0aXRsZT50b2tlbl9zbWFydF9jb250cmFjdDwvdGl0bGU+Cjxwb2x5Z29uIGZpbGw9Im5vbmUiIHN0cm9rZT0iYmxhY2siIHBvaW50cz0iOTcsLTM2IDAsLTM2IDAsMCA5NywwIDk3LC0zNiIvPgo8dGV4dCB0ZXh0LWFuY2hvcj0ibWlkZGxlIiB4PSI0OC41IiB5PSItMTQuMyIgZm9udC1mYW1pbHk9IlRpbWVzLHNlcmlmIiBmb250LXNpemU9IjE0LjAwIj5Ub2tlbiBjb2RlPC90ZXh0Pgo8L2c+CjwhLS0gbmV0d29yayAtLT4KPGcgaWQ9Im5vZGU0IiBjbGFzcz0ibm9kZSI+Cjx0aXRsZT5uZXR3b3JrPC90aXRsZT4KPGVsbGlwc2UgZmlsbD0ibm9uZSIgc3Ryb2tlPSJibGFjayIgY3g9IjEyOC41IiBjeT0iLTIzNCIgcng9IjQ4Ljk5IiByeT0iMTgiLz4KPHRleHQgdGV4dC1hbmNob3I9Im1pZGRsZSIgeD0iMTI4LjUiIHk9Ii0yMzAuMyIgZm9udC1mYW1pbHk9IlRpbWVzLHNlcmlmIiBmb250LXNpemU9IjE0LjAwIj5uZXR3b3JrPC90ZXh0Pgo8L2c+CjwhLS0gZXh0ZW5zaW9uIC0tPgo8ZyBpZD0ibm9kZTUiIGNsYXNzPSJub2RlIj4KPHRpdGxlPmV4dGVuc2lvbjwvdGl0bGU+CjxlbGxpcHNlIGZpbGw9Im5vbmUiIHN0cm9rZT0iYmxhY2siIGN4PSIxODkuNSIgY3k9Ii0xNjIiIHJ4PSI1NS43OSIgcnk9IjE4Ii8+Cjx0ZXh0IHRleHQtYW5jaG9yPSJtaWRkbGUiIHg9IjE4OS41IiB5PSItMTU4LjMiIGZvbnQtZmFtaWx5PSJUaW1lcyxzZXJpZiIgZm9udC1zaXplPSIxNC4wMCI+ZXh0ZW5zaW9uPC90ZXh0Pgo8L2c+CjwhLS0gbmV0d29yayYjNDU7Jmd0O2V4dGVuc2lvbiAtLT4KPGcgaWQ9ImVkZ2UxIiBjbGFzcz0iZWRnZSI+Cjx0aXRsZT5uZXR3b3JrJiM0NTsmZ3Q7ZXh0ZW5zaW9uPC90aXRsZT4KPHBhdGggZmlsbD0ibm9uZSIgc3Ryb2tlPSJibGFjayIgZD0iTTE0Mi42NSwtMjE2Ljc2QzE1MC4yNCwtMjA4LjA2IDE1OS43NCwtMTk3LjE1IDE2OC4yMSwtMTg3LjQzIi8+Cjxwb2x5Z29uIGZpbGw9ImJsYWNrIiBzdHJva2U9ImJsYWNrIiBwb2ludHM9IjE3MS4wNywtMTg5LjQ3IDE3NS4wMSwtMTc5LjYzIDE2NS44LC0xODQuODcgMTcxLjA3LC0xODkuNDciLz4KPC9nPgo8IS0tIHRva2VuIC0tPgo8ZyBpZD0ibm9kZTYiIGNsYXNzPSJub2RlIj4KPHRpdGxlPnRva2VuPC90aXRsZT4KPGVsbGlwc2UgZmlsbD0ibm9uZSIgc3Ryb2tlPSJibGFjayIgY3g9Ijc0LjUiIGN5PSItOTAiIHJ4PSIzNi4yOSIgcnk9IjE4Ii8+Cjx0ZXh0IHRleHQtYW5jaG9yPSJtaWRkbGUiIHg9Ijc0LjUiIHk9Ii04Ni4zIiBmb250LWZhbWlseT0iVGltZXMsc2VyaWYiIGZvbnQtc2l6ZT0iMTQuMDAiPnRva2VuPC90ZXh0Pgo8L2c+CjwhLS0gZXh0ZW5zaW9uJiM0NTsmZ3Q7dG9rZW4gLS0+CjxnIGlkPSJlZGdlMiIgY2xhc3M9ImVkZ2UiPgo8dGl0bGU+ZXh0ZW5zaW9uJiM0NTsmZ3Q7dG9rZW48L3RpdGxlPgo8cGF0aCBmaWxsPSJub25lIiBzdHJva2U9ImJsYWNrIiBkPSJNMTY0LjU1LC0xNDUuODFDMTQ3LjE4LC0xMzUuMjQgMTIzLjg5LC0xMjEuMDcgMTA1LjM2LC0xMDkuNzgiLz4KPHBvbHlnb24gZmlsbD0iYmxhY2siIHN0cm9rZT0iYmxhY2siIHBvaW50cz0iMTA3LjA1LC0xMDYuNzEgOTYuNjgsLTEwNC41IDEwMy40MSwtMTEyLjY5IDEwNy4wNSwtMTA2LjcxIi8+CjwvZz4KPCEtLSBwcm9vZiAtLT4KPGcgaWQ9Im5vZGU4IiBjbGFzcz0ibm9kZSI+Cjx0aXRsZT5wcm9vZjwvdGl0bGU+CjxlbGxpcHNlIGZpbGw9Im5vbmUiIHN0cm9rZT0iYmxhY2siIGN4PSIzNDUuNSIgY3k9Ii05MCIgcng9IjM1LjE5IiByeT0iMTgiLz4KPHRleHQgdGV4dC1hbmNob3I9Im1pZGRsZSIgeD0iMzQ1LjUiIHk9Ii04Ni4zIiBmb250LWZhbWlseT0iVGltZXMsc2VyaWYiIGZvbnQtc2l6ZT0iMTQuMDAi
|
||
|
<p>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.</p>
|
||
|
<h1 id="preparing-for-evm-token-deployment">Preparing for EVM token deployment</h1>
|
||
|
<p>Some of the concepts described below assume familiarity with base concepts of the CIC architecture. Please refer to the appropriate documentation for more information.</p>
|
||
|
<p>To initialize a new token deployment for the EVM:</p>
|
||
|
<pre class="shell"><code>cic init --target eth --name <token_name> --symbol <token_symbol> --precision <token_value_precision> <settings_folder></code></pre>
|
||
|
<p>To automatically fill in settings detected in the network for the EVM:</p>
|
||
|
<pre class="shell"><code>cic ext --registry <contract_registry_address> -d <settings_folder> -i <chain_spec> -p <rpc_endpoint> eth</code></pre>
|
||
|
</body>
|
||
|
</html>
|