|
1 | | -This is a collection of libraries and utilities for [Ethereum](https://ethereum.org). |
2 | | - |
3 | | -## Use cases |
4 | | - |
5 | | -### Creating an online wallet? |
6 | | - |
7 | | -Check out [keythereum](https://github.com/ethereumjs/keythereum) or [ethereumjs-wallet](https://github.com/ethereumjs/ethereumjs-wallet) (with HD wallet support) for managing keys and [ethereumjs-tx](https://github.com/ethereumjs/ethereumjs-tx) for creating transactions with them. |
8 | | -[ethereumjs-icap](https://github.com/ethereumjs/ethereumjs-icap) might also come handy for dealing with the ICAP (Ethereum in IBAN) format. |
9 | | - |
10 | | -### Creating a Dapp? |
11 | | - |
12 | | -You will need to interface with the Ethereum network. [web3.js](https://github.com/ethereum/web3.js) provides a complete Javascript API to interact with the RPC interface. If looking for a more lightweight option, [ethereumjs-abi](https://github.com/ethereumjs/ethereumjs-abi) or [solidity.js](https://github.com/ethereumjs/solidity.js) can handle the ABI encoding. |
13 | | - |
14 | | -### Interested in running a node? |
15 | | - |
16 | | -See [node-blockchain-server](https://github.com/ethereumjs/node-blockchain-server). It is in a pretty rough state at the moment, but at least can download the blockchain. |
17 | | - |
18 | | -## Full list of repos |
19 | | - |
20 | | -* [browser-builds](https://github.com/ethereumjs/browser-builds): browser builds of ethereumjs libraries |
21 | | -* [common](https://github.com/ethereumjs/common): the genesis data for the blockchain |
22 | | -* [ethashjs](https://github.com/ethereumjs/ethashjs): [Ethash](https://github.com/ethereum/wiki/wiki/Ethash) in Javascript |
23 | | -* [ethereumjs-abi](https://github.com/ethereumjs/ethereumjs-abi): ABI encoding and decoding |
24 | | -* [ethereumjs-account](https://github.com/ethereumjs/ethereumjs-account): account schema encoding, decoding and validation |
25 | | -* [ethereumjs-block](https://github.com/ethereumjs/ethereumjs-block): block schema encoding, decoding and validation |
26 | | -* [ethereumjs-blockchain](https://github.com/ethereumjs/ethereumjs-blockchain): manage a blockchain |
27 | | -* [ethereumjs-codesim](https://github.com/axic/ethereumjs-codesim): run EVM or Solidity code and examine the output |
28 | | -* [ethereumjs-icap](https://github.com/ethereumjs/ethreumjs-icap): utilities for handling ICAP (Ethereum in IBAN) encoding |
29 | | -* [ethereumjs-lib](https://github.com/ethereumjs/ethereumjs-lib): meta package for loading the other ethereumjs- modules |
30 | | -* [ethereumjs-testing](https://github.com/ethereumjs/ethereumjs-testing): transforms the [official test vectors](https://github.com/ethereum/tests) to a format suitable for ethereumjs |
31 | | -* [ethereumjs-tx](https://github.com/ethereumjs/ethereumjs-tx): transaction creation, manipulation, signing and verification |
32 | | -* [ethereumjs-units](https://github.com/ethereumjs/ethereumjs-units): Ethereum unit conversion |
33 | | -* [ethereumjs-util](https://github.com/ethereumjs/ethereumjs-util): a collection of frequently used methods by the other libraries |
34 | | -* [ethereumjs-wallet](https://github.com/ethereumjs/ethereumjs-wallet): lightweight toolkit for managing Ethereum keys, including HD wallet support |
35 | | -* [ethereumjs-vm](https://github.com/ethereumjs/ethereumjs-vm): a complete EVM (Ethereum Virtual Machine) and state processing implementation |
36 | | -* [geth.js](https://github.com/ethereumjs/geth.js): start and stop geth from Node.js |
37 | | -* [helpeth](https://github.com/ethereumjs/helpeth): purists' commandline tool for key and transaction management |
38 | | -* [keythereum](https://github.com/ethereumjs/keythereum): create, import and export Ethereum keys |
39 | | -* [merkle-patricia-tree](https://github.com/ethereumjs/merkle-patricia-tree): This is an implementation of the modified merkle patricia tree as specified in the [Ethereum yellow paper](http://gavwood.com/Paper.pdf) |
40 | | -* [node-blockchain-server](https://github.com/ethereumjs/node-blockchain-server): aims to provide a full Ethereum node implementation |
41 | | -* [node-devp2p](https://github.com/ethereumjs/node-devp2p): implementation of the [RLPx](https://github.com/ethereum/devp2p/blob/master/rlpx.md) transport protocol for Ethereum (used between nodes) |
42 | | -* [node-devp2p-dpt](https://github.com/ethereumjs/node-devp2p-dpt): implementation of the [RLPx](https://github.com/ethereum/devp2p/blob/master/rlpx.md) DPT (peer table) protocol for Ethereum |
43 | | -* [node-devp2p-eth](https://github.com/ethereumjs/node-devp2p-eth): implementation of the Ethereum sub-protocol over RLPx |
44 | | -* [node-devp2p-manager](https://github.com/ethereumjs/node-devp2p-manager): peer manager for DPT & RLPx |
45 | | -* [organization](https://github.com/ethereumjs/organization) and [ideas](https://github.com/ethereumjs/ideas): plans and discussions |
46 | | -* [rlp](https://github.com/ethereumjs/rlp): [RLP (Recursive Length Prefix)](https://github.com/ethereum/wiki/wiki/RLP) encoding and decoding |
47 | | -* [testrpc](https://github.com/ethereumjs/testrpc): fast Ethereum RPC node for testing and development |
48 | | - |
49 | | - |
50 | | -## Ethereum JS projects not tracked here |
51 | | -* [web3.js](https://github.com/ethereum/web3.js): the complete API as seen in the [wiki](https://github.com/ethereum/wiki/wiki/JavaScript-API) |
52 | | -* [solidity.js](https://github.com/ethereum/solidity.js): ABI encoding and decoding (the relevant code split out from web3.js) |
53 | | - |
54 | | -## Contributing and contact |
55 | | - |
56 | | -Please check out [organization](https://github.com/ethereumjs/organization) and [ideas](https://github.com/ethereumjs/ideas) repos first. Contributing to each of the projects is preferably done via pull requests. |
57 | | - |
58 | | -You can also reach out on: |
59 | | -* [Gitter](https://gitter.im/ethereum/ethereumjs-lib) |
60 | | -* [#ethereumjs](https://webchat.freenode.net/?channels=ethereumjs) on freenode |
| 1 | +# SYNOPSIS |
| 2 | + |
| 3 | +[](https://gitter.im/ethereum/ethereumjs-lib) or #ethereumjs on freenode |
| 4 | + |
| 5 | +# INTRODUCTION |
| 6 | + |
| 7 | +Website to give an overview of the various ``EthereumJS`` projects and an |
| 8 | +introduction to the ecosystem and the community. |
| 9 | + |
| 10 | +Site is hosted at https://ethereumjs.github.io/ via [GitHub Pages](https://pages.github.com) and |
| 11 | +build with [Jekyll](https://jekyllrb.com/) (see also ["Jekyll and GH Pages"](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/)). |
| 12 | + |
| 13 | +You can update the site by editing the markdown in [./index.md](./index.md) (via PR), build will be |
| 14 | +triggered automatically on merge. |
| 15 | + |
| 16 | +# LOCAL BUILD |
| 17 | + |
| 18 | +To build the site locally you have to have a working [Ruby](https://www.ruby-lang.org) ``2.4.x`` environment (you can use the [RVM](https://rvm.io/) Ruby version manager for this) and ``bundle`` and ``Jekyll`` installed. |
| 19 | + |
| 20 | +Install the ``GitHub pages`` gem from the ``Gemfile`` with: |
| 21 | + |
| 22 | +``` |
| 23 | +bundle install |
| 24 | +``` |
| 25 | + |
| 26 | +See also [this article](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/) for further installation instructions. |
| 27 | + |
| 28 | +The site can then be build with: |
| 29 | + |
| 30 | +``` |
| 31 | +jekyll build |
| 32 | +``` |
| 33 | + |
| 34 | +And being served on http://127.0.0.1:4000 with: |
| 35 | + |
| 36 | +``` |
| 37 | +jekyll serve |
| 38 | +``` |
| 39 | + |
| 40 | + |
| 41 | + |
0 commit comments