|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en-us"> |
| 3 | + <head> |
| 4 | + <meta charset="UTF-8"> |
| 5 | + <title>ethereumjs by ethereumjs</title> |
| 6 | + <meta name="viewport" content="width=device-width, initial-scale=1"> |
| 7 | + <link rel="stylesheet" type="text/css" href="stylesheets/normalize.css" media="screen"> |
| 8 | + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'> |
| 9 | + <link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen"> |
| 10 | + <link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen"> |
| 11 | + </head> |
| 12 | + <body> |
| 13 | + <section class="page-header"> |
| 14 | + <h1 class="project-name">ethereumjs</h1> |
| 15 | + <h2 class="project-tagline">Your Javascript gateway to Ethereum</h2> |
| 16 | + </section> |
| 17 | + |
| 18 | + <section class="main-content"> |
| 19 | + <p>This is a collection of libraries and utilities for Ethereum.</p> |
| 20 | + |
| 21 | +<h2> |
| 22 | +<a id="use-cases" class="anchor" href="#use-cases" aria-hidden="true"><span class="octicon octicon-link"></span></a>Use cases</h2> |
| 23 | + |
| 24 | +<h3> |
| 25 | +<a id="creating-an-online-wallet" class="anchor" href="#creating-an-online-wallet" aria-hidden="true"><span class="octicon octicon-link"></span></a>Creating an online wallet?</h3> |
| 26 | + |
| 27 | +<p>Check out <a href="https://github.com/ethereumjs/keythereum">keythereum</a> for managing keys and <a href="https://github.com/ethereumjs/ethereumjs-tx">ethereumjs-tx</a> for creating transactions with them.</p> |
| 28 | + |
| 29 | +<h3> |
| 30 | +<a id="creating-a-dapp" class="anchor" href="#creating-a-dapp" aria-hidden="true"><span class="octicon octicon-link"></span></a>Creating a Dapp?</h3> |
| 31 | + |
| 32 | +<p>You will need to interface with the Ethereum network. <a href="https://github.com/ethereumjs/web3.js">web3.js</a> provides a complete RPC interface from Javascript. If looking for a more lightweight option, <a href="https://github.com/axic/ethereumjs-abi">ethereumjs-abi</a> or <a href="https://github.com/ethereumjs/solidity.js">solidity.js</a> can handle the ABI encoding.</p> |
| 33 | + |
| 34 | +<h3> |
| 35 | +<a id="interested-in-running-a-node" class="anchor" href="#interested-in-running-a-node" aria-hidden="true"><span class="octicon octicon-link"></span></a>Interested in running a node?</h3> |
| 36 | + |
| 37 | +<p>See <a href="https://github.com/ethereumjs/node-blockchain-server">node-blockchain-server</a>. It is in a pretty rough state at the moment, but at least can download the blockchain.</p> |
| 38 | + |
| 39 | +<h2> |
| 40 | +<a id="full-list-of-repos" class="anchor" href="#full-list-of-repos" aria-hidden="true"><span class="octicon octicon-link"></span></a>Full list of repos</h2> |
| 41 | + |
| 42 | +<ul> |
| 43 | +<li> |
| 44 | +<a href="https://github.com/ethereumjs/common">common</a>: the genesis data for the blockchain</li> |
| 45 | +<li> |
| 46 | +<a href="https://github.com/ethereumjs/ethashjs">ethashjs</a>: <a href="https://github.com/ethereum/wiki/wiki/Ethash">Ethash</a> in Javascript</li> |
| 47 | +<li> |
| 48 | +<a href="https://github.com/axic/ethereumjs-abi">ethereumjs-abi</a>: ABI encoding and decoding</li> |
| 49 | +<li> |
| 50 | +<a href="https://github.com/ethereumjs/ethereumjs-account">ethereumjs-account</a>: account schema ecndogin, decoding and validation</li> |
| 51 | +<li> |
| 52 | +<a href="https://github.com/ethereumjs/ethereumjs-block">ethereumjs-block</a>: block schema encoding, decoding and validation</li> |
| 53 | +<li> |
| 54 | +<a href="https://github.com/ethereumjs/ethereumjs-blockchain">ethereumjs-blockchain</a>: manage a blockchain</li> |
| 55 | +<li> |
| 56 | +<a href="https://github.com/axic/ethereumjs-codesim">ethereumjs-codesim</a>: run EVM or Solidity code and examine the output</li> |
| 57 | +<li> |
| 58 | +<a href="https://github.com/ethereumjs/ethereumjs-lib">ethereumjs-lib</a>: meta package </li> |
| 59 | +<li> |
| 60 | +<a href="https://github.com/ethereumjs/ethereumjs-testing">ethereumjs-testing</a>: transforms the <a href="https://github.com/ethereum/tests">official test vectors</a> to a format suitable for ethereumjs</li> |
| 61 | +<li> |
| 62 | +<a href="https://github.com/ethereumjs/ethereumjs-tx">ethereumjs-tx</a>: transaction creation, manipulation, signing and verification</li> |
| 63 | +<li> |
| 64 | +<a href="https://github.com/ethereumjs/ethereumjs-util">ethereumjs-util</a>: a collection of frequently used methods by the other libraries</li> |
| 65 | +<li> |
| 66 | +<a href="https://github.com/ethereumjs/ethereumjs-vm">ethereumjs-vm</a>: a complete EVM (Ethereum Virtual Machine) and state processing implementation</li> |
| 67 | +<li> |
| 68 | +<a href="https://github.com/ethereumjs/geth.js">geth.js</a>: start and stop geth from Node.js</li> |
| 69 | +<li> |
| 70 | +<a href="https://github.com/ethereumjs/keythereum">keythereum</a>: create, import and export Ethereum keys</li> |
| 71 | +<li> |
| 72 | +<a href="https://github.com/ethereumjs/merkle-patricia-tree">merkle-patricia-tree</a>: This is an implementation of the modified merkle patricia tree as specified in the <a href="http://gavwood.com/Paper.pdf">Ethereum yellow paper</a> |
| 73 | +</li> |
| 74 | +<li> |
| 75 | +<a href="https://github.com/ethereumjs/node-blockchain-server">node-blockchain-server</a>: aims to provide a full Ethereum node implementation</li> |
| 76 | +<li> |
| 77 | +<a href="https://github.com/ethereumjs/node-devp2p">node-devp2p</a>: implementation of the <a href="https://github.com/ethereum/devp2p/blob/master/rlpx.md">RLPx</a> transport protocol for Ethereum (used between nodes)</li> |
| 78 | +<li> |
| 79 | +<a href="https://github.com/ethereumjs/node-devp2p-dpt">node-devp2p-dpt</a>: implementation of the <a href="https://github.com/ethereum/devp2p/blob/master/rlpx.md">RLPx</a> DPT (peer table) protocol for Ethereum</li> |
| 80 | +<li> |
| 81 | +<a href="https://github.com/ethereumjs/organization">organization</a> and <a href="https://github.com/ethereumjs/ideas">ideas</a>: plans and discussions</li> |
| 82 | +<li> |
| 83 | +<a href="https://github.com/ethereumjs/rlp">rlp</a>: <a href="https://github.com/ethereum/wiki/wiki/RLP">RLP (Recursive Length Prefix)</a> encoding and decoding</li> |
| 84 | +<li> |
| 85 | +<a href="https://github.com/ethereumjs/solidity.js">solidity.js</a>: ABI encoding and decoding (the relevant code split out form web3.js)</li> |
| 86 | +<li> |
| 87 | +<a href="https://github.com/ethereumjs/web3.js">web3.js</a>: the complete API as seen in <a href="https://github.com/ethereum/go-ethereum">geth</a> |
| 88 | +</li> |
| 89 | +</ul> |
| 90 | + |
| 91 | +<h2> |
| 92 | +<a id="contributing-and-contact" class="anchor" href="#contributing-and-contact" aria-hidden="true"><span class="octicon octicon-link"></span></a>Contributing and contact</h2> |
| 93 | + |
| 94 | +<p>Please check out <a href="https://github.com/ethereumjs/organization">organization</a> and <a href="https://github.com/ethereumjs/ideas">ideas</a> repos first. Contributing to each of the projects is preferably done via pull requests.</p> |
| 95 | + |
| 96 | +<p>You can also reach out on:</p> |
| 97 | + |
| 98 | +<ul> |
| 99 | +<li><a href="https://gitter.im/ethereum/ethereumjs-lib">Gitter</a></li> |
| 100 | +<li>#ethereumjs on freenode</li> |
| 101 | +<li>and <a href="https://scrollback.io/ethereumjs/all/all-messages">Scrollback</a> |
| 102 | +</li> |
| 103 | +</ul> |
| 104 | + |
| 105 | + <footer class="site-footer"> |
| 106 | + |
| 107 | + <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the <a href="https://github.com/jasonlong/cayman-theme">Cayman theme</a> by <a href="https://twitter.com/jasonlong">Jason Long</a>.</span> |
| 108 | + </footer> |
| 109 | + |
| 110 | + </section> |
| 111 | + |
| 112 | + |
| 113 | + </body> |
| 114 | +</html> |
0 commit comments