-
Notifications
You must be signed in to change notification settings - Fork 0
/
guides.html
167 lines (138 loc) · 9.61 KB
/
guides.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Chromawallet</title>
<link rel="stylesheet" type="text/css" href="style.css">
<link rel="shortcut icon" type="image/png" href="favicon.ico" />
<meta property="og:title" content="A unique bitcoin wallet that can transfer gold, art or anything else" />
<meta property="og:site_name" content="ChromaWallet" />
<meta property="og:url" content="http://www.chromawallet.com" />
<meta property="og:description" content="ChromaWallet functions just like a normal Bitcoin wallet, but additionally it allows one to work with assets which are represented with colored coins, particularly to Issue, Send, Receive and Trade securities/tokens of any kind: shares, bonds, tickets, private currencies." />
<meta property="og:image" content="http://www.chromawallet.com/pic/issuing_an_asset.gif" />
<meta property="fb:app_id" content="799373163435436" />
</head>
<div class="fullpage">
<div class="body">
<div class="header">
<ul>
<li><a href="/">About</a></li>
<li><a href="/#resources">Resources</a></li>
<li><a href="/#contact">Contact</a></li>
<li><a href="/guides.html">Guides</a></li>
<li><a href="/#download">Download</a></li>
</ul>
<div class="fb-like" data-href="https://developers.facebook.com/docs/plugins/" data-layout="button" data-action="like" data-show-faces="false" data-share="true"></div>
</div>
<div class="guides">
<h1>ChromaWallet user's guide</h1>
<img src="images/guides/guides.png" alt="guides picture" align="right">
<h2>Table of contents</h2>
<ol>
<li><a href="#installation">Installation</a></li>
<li><a href="#asset">Asset Management</a></li>
<li><a href="#sendreceive">Sending and Receiving Assets</a></li>
<li><a href="#p2ptrade">P2P Trade</a></li>
</ol>
<a id='installation'><h2>Installation</h2></a>
<p>Download the latest version of ChromaWallet from <a href="http://ChromaWallet.com/#download" target="_blank">here</a>, extract it to a location of your choosing. In the unpacked directory you can find two programs:
<ul>
<li><code>chromawallet</code> is graphical user interface</li>
<li> <code>cw-cli</code> provides command-line interface</li>
</ul>
Most actions can be performed through either of interfaces, but command-line application also provides low-level functions. You can find a list of commands which are accepted by cw-cli by running <code>cw-cli --help</code></p>
<p>You can use <code>--testnet</code> command-line switch to run client in testnet mode, in that case a separate testnet wallet will be used. E.g.:
<ul>
<li><code>chromawallet</code> will use <code>mainnet.wallet</code> (in the current directory) </li>
<li><code>chromawallet --testnet</code> will use <code>testnet.wallet</code></li>
</ul></p>
<h3>Running Multiple Clients on One Machine</h3>
<ol>
<li>You can run as many clients as you want, to do this you will simply need to copy the chromawallet directory, delete the *.wallet in the copied directory, and then run chromawallet from the new directory. A new wallet will be created.</li>
<li>You can now send bitcoins and assets between the two wallets.</li></br>
</ol>
<a id='asset'><h2>Asset Management</h2></a>
<h3>Issuing an Asset</h3>
<p><em>Note:</em> you need bitcoins in your wallet to be able to issue an asset.
If you just want to try it out, you can run wallet in testnet mode and obtain testnet bitcoins from a faucet.</p>
<ol>
<li>Click on the <em>Assets</em> tab, and then click on the <em>issue new asset</em> button.</li>
<img src="images/guides/assetissuing.png" alt="issuing an asset">
<li>Enter a moniker (name of the asset) of your choosing, select a color scheme (epobc is the recommened one), quantity, and number of atoms in one unit (1 if unit is undivisible, 100 if unit is divisible down to 0.01, etc.) and then click OK. </li>
<li>The asset should appear in your asset tab. If you go to the overview tab, your asset should be listed along with its balance and address.</li>
<img src="images/guides/listedasset.png" alt="asset listed on overview tab">
</ol>
<h3>Publishing the Asset you Created</h3>
You need to share information about the asset you have created (<em>asset definition</em>) with others if you want them to be able to interact with it.
<ol>
<li>Go to <em>Assets</em> tab.</li>
<li>Right-click the asset you want to share and select <em>Copy as JSON</em></li>
<img src="images/guides/copyingjson.png" alt="copying the json">
<li>Now you can paste this JSON asset definition into a document, web page or forum post you will use to announce and describe the asset.</li>
<li>Optional: If asset represents something of value (for example, if it is a bond, i.e. a debt you agree to repay at some point), you should write a contract which describes terms associated with this asset (for example, details about issuer, conditions of repayment and so on), add asset definition to it, and sign it by some means, for example, using PGP. Signature will be used to check the identity of issuer. (<em>Note:</em> We do not know anything about legality of bonds created by this method, please consult your lawyer.)</li>
</ol>
(Alternatively you can copy individual parts of asset definition: name, color set (color identifiers), unit (number of satoshi in one unit).
<h3>Adding an Existing Asset</h3>
<h4>Method One: Import Asset via JSON (Recommended)</h4>
If you have access to asset definition in JSON format (it might be obtained from asset's description, contract, or from other client running on same machine), you can:
<ol>
<li>Copy JSON asset definition</li>
<li>In the client that you wish to contain this new asset, open <em>Assets</em> tab, and then click on the <em>Import asset from JSON</em> button.</li>
<li>Paste the JSON that you previously copied, and then click OK.</li>
<img src="images/guides/importingjson.png" alt="importing json">
<li>You will see details of the asset you're about to add. Please make sure that its name matches your expectations. You can edit name if you wish.</li>
<li>After you click OK the asset should appear in your <em>Assets</em> tab and in your <em>Overview</em> tab. </li>
<img src="images/guides/overview.png" alt="overview">
</ol>
<h4>Method Two: Manual entry</h4>
<ol>
<li>Open <em>Assets</em> tab, and then click on the <em>add existing asset</em> button.</li>
<li>Enter the moniker, color description, and unit of the asset you want add.</li>
<li>After you click OK the asset should appear in your <em>Assets</em> tab and in your <em>Overview</em> tab. </li>
</ol>
<a id='sendreceive'><h2>Sending and Receiving assets</h2></a>
<ul>
<li>You need to make sure that asset definition is known to your wallet before you can send/receive units of that asset. If you aren't an issuer, please consult <a href='#asset'>asset management section</a>.</li>
<li>The process is very similar to sending and receiving bitcoins, but special <em>color addresses</em> are used for that. <em>Color address</em> for each asset wallet is aware of is available on <em>Overview</em> tab. <em>Receive</em> tab provides a list of all addresses for each asset and gives you an ability to create new ones</li>
<li>You can send a specific asset by choosing it in a drop-down list on the <em>Send</em> tab.<br/>
<em>Note:</em> that you need to obtain address for this specific asset, wallet will report an error if color of an address doesn't match the asset name you have chosen in the drop-down menu.<br />
<em>Note:</em> You need bitcoins to pay a transaction fee. (In case with testnet mode, You can obtain some from a faucet.)</li>
</ul>
<a id='p2ptrade'><h2>P2P Trade</h2></a>
<ol>
<li>Click on the P2P Trade Tab.</li>
<li>Select the asset you wish to buy or sell.</li>
<li>Enter the quantity and price of the asset you wish to buy or sell, and then click the buy or sell button.</li>
<li>When matching offer will be found, a trade will occur. Note that offers need to match price and quantity <em>exactly</em>. (More advanced matchmaking engine is currently under development.)</li>
<li>To fill a specific offer, double-click it.</li>
<li>To delete your order (distinguished by dark grey in the list), double-click it.</li>
</ol>
</div>
</div>
</div>
<script>
window.fbAsyncInit = function() {
FB.init({
appId : '799373163435436',
xfbml : true,
version : 'v2.1'
});
};
(function(d, s, id){
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) {return;}
js = d.createElement(s); js.id = id;
js.src = "//connect.facebook.net/en_US/sdk.js";
fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));
</script>
<!--------------------GOOGLE ANALYTICS---------------------------------->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-46669109-1', 'chromawallet.com');
ga('send', 'pageview');
</script>
</html>