Skip to content
This repository has been archived by the owner on May 17, 2022. It is now read-only.

Commit

Permalink
Merge pull request #305 from bobsummerwill/master
Browse files Browse the repository at this point in the history
Full revamp of cpp-ethereum docs.
  • Loading branch information
bobsummerwill authored Aug 16, 2016
2 parents cb09840 + ea5d617 commit dee71ed
Show file tree
Hide file tree
Showing 19 changed files with 589 additions and 1,209 deletions.
35 changes: 35 additions & 0 deletions source/ethereum-clients/cpp-ethereum/architecture.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

################################################################################
Architecture
################################################################################

.. image:: ../../img/dependency_graph.svg

- bench: trie benchmarking
- cmake: cmake files for build system, contains specification of inter-dependencies
- eth A command-line Ethereum full-node that can be controlled via RPC.
- ethkey: stand-alone key management
- ethminer: stand-alone ethash miner
- ethvm: stand-alone EVM execution utility
- evmjit: library for the EVM just-in-time compiler
- libdevcore: data structures, utilities, rlp, trie, memory db
- libdevcrypto: crypto primitives. Depends on libsecp256k1 and libcrypto++.
- libp2p: core peer to peer networking implementation (excluding specific sub-protocols)
- libethash: ethash mining POW algorithm implementation
- libethash-cl: ethash mining code for GPU mining (OpenCL)
- libethashseal: generic wrapper around the POW block seal engine. Also contains the genesis states for all ethash-based chains.
- libethcore: collection of core data structures and concepts
- libethereum: main consensus engine (minus EVM). Includes the State and BlockChain classes.
- libevm: Ethereum Virtual Machine implementation (interpreter).
- libevmasm: EVM assembly tools, also contains the optimizer.
- libevmcore: elementary data structures of the EVM, opcodes, gas costs, ...
- libweb3jsonrpc: json-rpc server-side endpoint, provides http and IPC (unix socket, windows pipe) connectors
- libwebthree: service connectors for ethereum, swarm/ipfs and whisper.
- libwhisper: whisper implementation
- rlp: stand-alone rlp en-/decoder
- testeth: tests for the modules formerly within the **libethereum** repo
- testweb3core: tests for the modules formerly within the **libweb3core** repo
- testweb3: tests for the modules formerly within the **webthree** repo
- utils/json_spirit: JSON parser written for Boost's Spirit library.
- utils/libscrypt: scrypt implementation
- utils/secp256k1: implementation of the SECP 256k1 ECDSA signing algorithm.
134 changes: 0 additions & 134 deletions source/ethereum-clients/cpp-ethereum/automation.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Building from source
Overview
--------------------------------------------------------------------------------

The **cpp-ethereum** codebase is is mid-transition from several
Git repositories which are all grouped as sub-modules under the
`webthree-umbrella <http://github.com/ethereum/webthree-umbrella>`_ repo
on Github back to `cpp-ethereum <http://github.com/ethereum/cpp-ethereum>`_.

As of right now (only for the v1.3.0 release), the canonical mainline is at:

https://github.com/bobsummerwill/cpp-ethereum/tree/merge_repos
The **cpp-ethereum** codebase lives on Github.com in the
`cpp-ethereum <http://github.com/ethereum/cpp-ethereum>`_ repository.

Between October 2015 and August 2016 it was split into various repositories
which were grouped as sub-modules under the
`webthree-umbrella <http://github.com/ethereum/webthree-umbrella>`_ repository,
and you will likely see many references to **webthree-umbrella** online. Those
all refer to the **cpp-ethereum** codebase during that period of its development.

We use a common `CMake <https://cmake.org/>`_ build system to generate
platform-specific build files, meaning that the workflow is very similar
Expand Down

This file was deleted.

Loading

0 comments on commit dee71ed

Please sign in to comment.