-
Notifications
You must be signed in to change notification settings - Fork 8
/
index.html
363 lines (278 loc) · 18.8 KB
/
index.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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="CryptoCoinJS Bitcoin and Crypto Currency JavaScript Library">
<link rel="canonical" href="http://cryptocoinjs.com/">
<link rel="shortcut icon" href="./img/favicon.ico">
<title>CryptoCoinJS</title>
<link href="./css/bootstrap-custom.min.css" rel="stylesheet">
<link href="./css/font-awesome-4.0.3.css" rel="stylesheet">
<link href="./css/prettify-1.0.css" rel="stylesheet">
<link href="./css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href=".">CryptoCoinJS</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="dropdown active">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
<ul class="dropdown-menu">
<li class="active">
<a href=".">Main</a>
</li>
<li >
<a href="about/contributing/">Contributing</a>
</li>
<li >
<a href="about/faq/">FAQ</a>
</li>
<li >
<a href="about/team/">Team</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Guide <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="guide/getting-started/">Getting Started</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Currency Modules <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="modules/currency/bip38/">bip38 - Password encrypted private keys</a>
</li>
<li >
<a href="modules/currency/btc-p2p/">btc-p2p - Manage a network of peers in a Bitcoin p2p network</a>
</li>
<li >
<a href="modules/currency/coininfo/">coininfo - Crypto Currency Specific Information</a>
</li>
<li >
<a href="modules/currency/coinkey/">coinkey - Private Keys / Addresses</a>
</li>
<li >
<a href="modules/currency/coinstring/">coinstring - Create & Parse Addresses / WIF / Base58</a>
</li>
<li >
<a href="modules/currency/eckey/">eckey - Private Keys / Elliptic Curve</a>
</li>
<li >
<a href="modules/currency/hdkey/">hdkey - Deterministic Keys / BIP32</a>
</li>
<li >
<a href="modules/currency/p2p-manager/">p2p-manager - Manage a network of peers in a p2p network</a>
</li>
<li >
<a href="modules/currency/p2p-node/">p2p-node - Handle p2p traffic on crypto currency networks</a>
</li>
<li >
<a href="modules/currency/btc-address/">btc-address - Bitcoin Address Handling</a>
</li>
<li >
<a href="modules/currency/btc-opcode/">btc-opcode - Bitcoin Opcodes</a>
</li>
<li >
<a href="modules/currency/btc-script/">btc-script - Bitcoin Script</a>
</li>
<li >
<a href="modules/currency/btc-scriptinterpreter/">btc-scriptinterpreter - Bitcoin Script Interpreter</a>
</li>
<li >
<a href="modules/currency/btc-transaction/">btc-transaction - Bitcon Transaction Creation / Parsing</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Crypto Modules <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="modules/crypto/aes/">aes - Advanced Encryption Standard</a>
</li>
<li >
<a href="modules/crypto/crypto-hashing/">crypto-hashing - Normalized interface to hash functions</a>
</li>
<li >
<a href="modules/crypto/ecdsa/">ecdsa - Elliptic Curve Signing / Verification</a>
</li>
<li >
<a href="modules/crypto/ecurve/">ecurve - Elliptic Curve Cryptography</a>
</li>
<li >
<a href="modules/crypto/pbkdf2-sha256/">pbkdf2-sha256 - PBKDF2 using SHA256 HMAC</a>
</li>
<li >
<a href="modules/crypto/ripemd160/">ripemd160 - RIPEMD160 hash</a>
</li>
<li >
<a href="modules/crypto/scryptsy/">scryptsy - Scrypt Key Derivation</a>
</li>
<li >
<a href="modules/crypto/sha512/">sha512 - SHA 512 Secure Hashing Algorithm</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Misc Modules <b class="caret"></b></a>
<ul class="dropdown-menu">
<li >
<a href="modules/misc/bigi/">bigi - Big Integers</a>
</li>
<li >
<a href="modules/misc/binstring/">binstring - Convert data types</a>
</li>
<li >
<a href="modules/misc/bs58/">bs58 - BASE58 encoding / decoding</a>
</li>
<li >
<a href="modules/misc/qr-encode/">qr-encode - Encode data into QR</a>
</li>
</ul>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li class="disabled">
<a rel="next" >
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="about/contributing/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li>
<a href="https://github.com/cryptocoinjs/">
<i class="fa fa-github"></i>
GitHub
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#cryptocoinjs">CryptoCoinJS</a></li>
<li><a href="#principles">Principles</a></li>
<li><a href="#platforms">Platforms</a></li>
<li><a href="#guide">Guide</a></li>
<li><a href="#modules">Modules</a></li>
<li><a href="#use-in-production">Use In Production</a></li>
<li><a href="#have-questions">Have Questions?</a></li>
<li><a href="#want-to-contribute">Want to Contribute?</a></li>
<li><a href="#thanks">Thanks</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<h1 id="cryptocoinjs">CryptoCoinJS</h1>
<p>CryptoCoinJS is a JavaScript project that helps you to interface with many of the crypto currencies such as Bitcoin, Litecoin, Dogecoin, and more. Most of the modules are fully compatible with the browser and Node.js. Naturally, the modules that interface directly with peer nodes won't run in the browser.</p>
<h2 id="principles">Principles</h2>
<p>We believe in the Node.js and UNIX philosophy - the idea of building small components that do one thing and do it well. Writing software in this manner allows individuals to use and contribute much more effectively than writing one monolithic library.</p>
<p>We believe that people are more important than code and therefore it's critical to write code that is easy to read, document each module with the API and examples, and that code is the enemy <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/">1</a> <a href="http://blog.codinghorror.com/size-is-the-enemy/">2</a>.</p>
<p>We believe that writing tests is one of the best ways to communicate expectations between developers. If documentation is a way to commuincate for a consumer of your module, then tests are a way to communicate between developers.</p>
<p>We have our work cut out for us.</p>
<h2 id="platforms">Platforms</h2>
<p>CryptoCoinJS is focused on Node.js and the browser using <a href="https://github.com/substack/node-browserify">Browserify</a>. We have made an active decision to NOT support legacy browsers. i.e. if your browser does not support <a href="http://en.wikipedia.org/wiki/ECMAScript">ECMAScript 5</a> (2009-2010) and it doesn't support <a href="https://developer.mozilla.org/en-US/docs/Web/API/window.crypto.getRandomValues">window.crypto.getRandomValues()</a> some of the modules may not work.</p>
<h2 id="guide">Guide</h2>
<ul>
<li><a href="guide/getting-started">Getting Started</a></li>
</ul>
<h2 id="modules">Modules</h2>
<p>Note: If a component won't work on the client (browser), then it'll be marked as <strong>server only</strong>.</p>
<h3 id="active">Active</h3>
<h4 id="crypto-currency">Crypto Currency</h4>
<ul>
<li><a href="modules/currency/bip38">bip38</a> - Password encrypted private keys</li>
<li><a href="modules/currency/btc-p2p">btc-p2p</a> - Manage a network of Bitcoin peers. <strong>(server only)</strong></li>
<li><a href="modules/currency/coininfo">coininfo</a> - Fetch currency specific information such as ports and version numbers</li>
<li><a href="modules/currency/coinkey">coinkey</a> - Create private keys, public keys, and addresses. (Inherits from <a href="modules/currency/eckey/">eckey</a>)</li>
<li><a href="modules/currency/coinstring">coinstring</a> - Create, parse, or validate addresses a wallet import format strings</li>
<li><a href="modules/currency/eckey">eckey</a> - Super class for <a href="modules/currency/coinkey">coinkey</a> used for private and public elliptic curve keys</li>
<li><a href="modules/currency/hdkey">hdkey</a> - <a href="https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki">BIP32</a>(hierarchical deterministic keys)</li>
<li><a href="modules/currency/p2p-node">p2p-manager</a> - Manage a network of peers in a p2p network. <strong>(server only)</strong></li>
<li><a href="modules/currency/p2p-node">p2p-node</a> - Low-level library to handle p2p traffic on crypto currency networks. <strong>(server only)</strong></li>
</ul>
<p>(the following are poorly documented and need some TLC)</p>
<ul>
<li><a href="modules/currency/btc-address">btc-address</a> - Address handling library for Bitcoin. Possibly irrelevant by <a href="modules/currency/coinkey">coinkey</a> or <a href="modules/currency/coinstring">coinstring</a></li>
<li><a href="modules/currency/btc-opcode">btc-opcode</a> - Bitcoin opcodes</li>
<li><a href="modules/currency/btc-script">btc-script</a> - Bitcoin Script</li>
<li><a href="modules/currency/btc-scriptinterpreter">btc-scriptinterpreter</a> - btc-scriptinterpreter - Bitcoin Script Interpreter</li>
<li><a href="modules/currency/btc-transaction">btc-transaction</a> - Bitcon Transaction Creation / Parsing</li>
</ul>
<h4 id="cryptography">Cryptography</h4>
<ul>
<li><a href="modules/crypto/aes/">aes</a> - Implementation of the Advanced Encryption Standard</li>
<li><a href="modules/crypto/crypto-hashing">crypto-hashing</a> - Normalize interfaces to crypto hashing routines such as SHA256 / RIPEMD160</li>
<li><a href="modules/crypto/ecdsa/">ecdsa</a> - Signing & verfication for Elliptic Curve Cryptography</li>
<li><a href="modules/crypto/ecurve">ecurve</a> - Main module for Elliptic Curve Cryptography</li>
<li><a href="modules/crypto/pbkdf2-sha256">pbkdf2-sha256</a> - PBKDF2 using SHA256 HMAC</li>
<li><a href="modules/crypto/ripemd160">ripemd160</a> - RIPEMD160 hash</li>
<li><a href="modules/crypto/scrypt">scryptsy</a> - Scrypt key derivation</li>
</ul>
<h4 id="misc">Misc</h4>
<ul>
<li><a href="modules/misc/bigi">bigi</a> - BigInteger library (port of Tom Wu's library)</li>
<li><a href="modules/misc/binstring">binstring</a> - Convert data types. i.e. convert between <code>Array</code>, <code>Buffer</code>, <code>UTF8</code>, <code>Hex</code>, etc</li>
<li><a href="modules/misc/bs58">bs58</a> - BASE58 encoding / decoding</li>
<li><a href="modules/misc/qr-encode">qr-encode</a> - Encode data into QR codes </li>
</ul>
<h3 id="deprecated">Deprecated</h3>
<ul>
<li><a href="https://github.com/cryptocoinjs/ecurve-names">ecurve-names</a> - Moving curves to ecurve</li>
<li><a href="https://github.com/cryptocoinjs/sha256">sha256</a> - Outsourced to <a href="https://github.com/dominictarr/crypto-browserify">crypto-browserify</a> through <a href="modules/crypto/crypto-hashing">crypto-hashing</a></li>
</ul>
<h3 id="unknown">Unknown</h3>
<p>The library that bundles everything is located here: <a href="https://github.com/cryptocoinjs/cryptocoin">https://github.com/cryptocoinjs/cryptocoin</a>. The NPM module is <a href="https://www.npmjs.org/package/cryptocoin">cryptocoin</a>.</p>
<p>Development moves quickly with each individual module and packaging up a release in the larger module is tedious and error prone. So, the state of the large bundle is unknown. </p>
<h2 id="use-in-production">Use In Production</h2>
<ul>
<li><a href="https://www.coinbolt.com">Coinbolt</a> - Simple & Secure Wallet</li>
<li><a href="https://helloblock.io">Helloblock</a> - Block Explorer with Mainnet and Testnet API</li>
<li><a href="https://www.bitrated.com">Bitrated</a> - Arbitration Marketplace</li>
</ul>
<p>Do you use any of CryptoCoinJS? If so, let us know by emailing us or opening a <a href="https://github.com/cryptocoinjs/cryptocoinjs.com/issues">issue/pull request</a>.</p>
<h2 id="have-questions">Have Questions?</h2>
<p>Please see our <a href="./faq">FAQ</a>. If it's not answered on the FAQ, then <a href="./team">email us</a>.</p>
<h2 id="want-to-contribute">Want to Contribute?</h2>
<p>Please read: <a href="https://github.com/cryptocoinjs/cryptocoin/wiki/Contributor-Guidelines">https://github.com/cryptocoinjs/cryptocoin/wiki/Contributor-Guidelines</a></p>
<h2 id="thanks">Thanks</h2>
<p>This library wouldn't be possible without some of the great work of <a href="https://github.com/justmoon">Stefan Thomas</a>, <a href="http://www-cs-students.stanford.edu/~tjw/">Tom Wu</a>, authors of <a href="https://code.google.com/p/crypto-js/">CryptoJS</a>, and authors of <a href="https://github.com/bitwiseshiftleft/sjcl/graphs/contributors">SJCL</a>. Also, recent contributions to BitcoinJS by <a href="https://github.com/kyledrake">Kyle Drake</a>, <a href="https://github.com/dcousens">Daniel Cousens</a>, and <a href="https://github.com/weilu">Wei Lu</a> have helped tremendously. We owe all of the aforementioned a heartfelt thank you for building the foundation for all of this.</p>
<p>Last, but surely not least, we owe <a href="http://en.wikipedia.org/wiki/Satoshi_Nakamoto">Satoshi Nakamoto</a> a heartfelt thank you for inventing what will surely be one of the greatest inventions of mankind.</p>
</div>
</div>
<script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="./js/bootstrap-3.0.3.min.js"></script>
<script src="./js/prettify-1.0.min.js"></script>
<script src="./js/base.js"></script>
</body>
</html>