• This repository has been archived on 28/Oct/2021
  • Stars
    star
    3,963
  • Rank 11,017 (Top 0.3 %)
  • Language
    C++
  • License
    GNU General Publi...
  • Created almost 11 years ago
  • Updated 9 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Aleth – Ethereum C++ client, tools and libraries

Aleth – Ethereum C++ client, tools and libraries

The collection of C++ libraries and tools for Ethereum, formerly known as cpp-ethereum project. This includes the full Ethereum client aleth.

⚠️ This project has been discontinued and is no longer maintained.

Contact

Gitter GitHub Issues

Usage

The Ethereum Documentation site hosts the aleth homepage, which has a Quick Start section.

Operating system Status
Ubuntu and macOS TravisCI
Windows AppVeyor

Install

Download release binaries

https://github.com/ethereum/aleth/releases

Using docker images

Aleth:

docker run ethereum/aleth --help

Testeth:

docker run ethereum/testeth --help

Building from source

Get the source code

Git and GitHub are used to maintain the source code. Clone the repository by:

git clone --recursive https://github.com/ethereum/aleth.git
cd aleth

The --recursive option is important. It orders git to clone additional submodules to build the project. If you missed --recursive option, you are able to correct your mistake with command git submodule update --init.

Install CMake

CMake is used to control the build configuration of the project. Latest version of CMake is required (at the time of writing 3.9.3 is the minimum). We strongly recommend you to install CMake by downloading and unpacking the binary distribution of the latest version available on the CMake download page.

The CMake package available in your operating system can also be installed and used if it meets the minimum version requirement.

Alternative method

The repository contains the scripts/install_cmake.sh script that downloads a fixed version of CMake and unpacks it to the given directory prefix. Example usage: scripts/install_cmake.sh --prefix /usr/local.

Build

Configure the project build with the following command to create the build directory with the configuration.

mkdir build; cd build  # Create a build directory.
cmake ..               # Configure the project.
cmake --build .        # Build all default targets.

On Windows we support Visual Studio 2017, and 2019. You should generate a Visual Studio solution file (.sln) for the 64-bit architecture via the following command:

  • Visual Studio 2017: cmake .. -G "Visual Studio 15 2017 Win64"
  • Visual Studio 2019: cmake .. -G "Visual Studio 16 2019" -A x64

After the necessary dependencies have been downloaded and built and the solution has been generated, aleth.sln can be found in the build directory.

Common Issues Building on Windows

LINK : fatal error LNK1158: cannot run 'rc.exe'

Rc.exe is the Microsoft Resource Compiler. It's distributed with the Windows SDK and is required for generating the Visual Studio solution file. It can be found in the following directory: %ProgramFiles(x86)%\Windows Kits\<OS major version>\bin\<OS full version>\<arch>\

If you hit this error, adding the directory to your path (and launching a new command prompt) should fix the issue.

Contribute

Contributors Gitter up-for-grabs

The current codebase is the work of many, many hands, with over 100 individual contributors over the course of its development.

Our day-to-day development chat happens on the aleth Gitter channel.

All contributions are welcome! We try to keep a list of tasks that are suitable for newcomers under the tag help wanted. If you have any questions, please do not hesitate to ask us about more information.

Please read CONTRIBUTING and CODING_STYLE thoroughly before making alterations to the code base.

All development goes in develop branch.

Usage

Note: The following is the output of ./aleth -h [--help] on Linux

NAME:
   aleth 1.7.2
USAGE:
   aleth [options]

WALLET USAGE:
   account list                                List all keys available in wallet
   account new                                 Create a new key and add it to wallet
   account update [<uuid>|<address> , ... ]    Decrypt and re-encrypt keys
   account import [<uuid>|<file>|<secret-hex>] Import keys from given source and place in wallet
   wallet import <file>                        Import a presale wallet

CLIENT MODE (default):
  --mainnet                               Use the main network protocol
  --ropsten                               Use the Ropsten testnet
  --test                                  Testing mode; disable PoW and provide test rpc interface
  --config <file>                         Configure specialised blockchain using given JSON information

  --ipc                                   Enable IPC server (default: on)
  --ipcpath <path>                        Set .ipc socket path (default: data directory)
  --no-ipc                                Disable IPC server
  --admin <password>                      Specify admin session key for JSON-RPC (default: auto-generated and printed at start-up)
  -K [ --kill ]                           Kill the blockchain first
  -R [ --rebuild ]                        Rebuild the blockchain from the existing database
  --rescue                                Attempt to rescue a corrupt database

  --import-presale <file>                 Import a pre-sale key; you'll need to specify the password to this key
  -s [ --import-secret ] <secret>         Import a secret key into the key store
  -S [ --import-session-secret ] <secret> Import a secret session into the key store
  --master <password>                     Give the master password for the key store; use --master "" to show a prompt
  --password <password>                   Give a password for a private key

CLIENT TRANSACTING:
  --ask <wei>            Set the minimum ask gas price under which no transaction will be mined (default: 20000000000)
  --bid <wei>            Set the bid gas price to pay for transactions (default: 20000000000)
  --unsafe-transactions  Allow all transactions to proceed without verification; EXTREMELY UNSAFE

CLIENT NETWORKING:
  -b [ --bootstrap ]              Connect to the default Ethereum peer servers (default unless --no-discovery used)
  --no-bootstrap                  Do not connect to the default Ethereum peer servers (default only when --no-discovery is used)
  -x [ --peers ] <number>         Attempt to connect to a given number of peers (default: 11)
  --peer-stretch <number>         Give the accepted connection multiplier (default: 7)
  --public-ip <ip>                Force advertised public IP to the given IP (default: auto)
  --listen-ip <ip>(:<port>)       Listen on the given IP for incoming connections (default: 0.0.0.0)
  --listen <port>                 Listen on the given port for incoming connections (default: 30303)
  -r [ --remote ] <host>(:<port>) Connect to the given remote host (default: none)
  --port <port>                   Connect to the given remote port (default: 30303)
  --network-id <n>                Only connect to other hosts with this network id
  --allow-local-discovery         Include local addresses in the discovery process. Used for testing purposes.
  --peerset <list>                Comma delimited list of peers; element format: type:enode://publickey@ipAddress[:port[?discport=port]]
                                          Types:
                                          default     Attempt connection when no other peers are available and pinning is disabled
                                          required    Keep connected at all times

                                          Ports:
                                          The first port argument is the tcp port used for direct communication among peers. If the second port
                                          argument isn't supplied, the first port argument will also be the udp port used for node discovery.
                                          If neither the first nor second port arguments are supplied, a default port of 30303 will be used for
                                          both peer communication and node discovery.
  --no-discovery                  Disable node discovery; implies --no-bootstrap
  --pin                           Only accept or connect to trusted peers

CLIENT MINING:
  -a [ --address ] <addr>         Set the author (mining payout) address (default: auto)
  -m [ --mining ] <on/off/number> Enable mining; optionally for a specified number of blocks (default: off)
  --extra-data arg                Set extra data for the sealed blocks

BENCHMARKING MODE:
  -M [ --benchmark ]           Benchmark for mining and exit
  --benchmark-warmup <seconds> Set the duration of warmup for the benchmark tests (default: 3)
  --benchmark-trial <seconds>  Set the duration for each trial for the benchmark tests (default: 3)
  --benchmark-trials <n>       Set the number of trials for the benchmark tests (default: 5)

MINING CONFIGURATION:
  -C [ --cpu ]                 When mining, use the CPU
  -t [ --mining-threads ] <n>  Limit number of CPU/GPU miners to n (default: use everything available on selected platform)
  --current-block <n>          Let the miner know the current block number at configuration time. Will help determine DAG size and required GPU memory
  --disable-submit-hashrate    When mining, don't submit hashrate to node

IMPORT/EXPORT MODES:
  -I [ --import ] <file>      Import blocks from file
  -E [ --export ] <file>      Export blocks to file
  --from <n>                  Export only from block n; n may be a decimal, a '0x' prefixed hash, or 'latest'
  --to <n>                    Export only to block n (inclusive); n may be a decimal, a '0x' prefixed hash, or 'latest'
  --only <n>                  Equivalent to --export-from n --export-to n
  --format <binary/hex/human> Set export format
  --dont-check                Prevent checking some block aspects. Faster importing, but to apply only when the data is known to be valid
  --download-snapshot <path>  Download Parity Warp Sync snapshot data to the specified path
  --import-snapshot <path>    Import blockchain and state data from the Parity Warp Sync snapshot

DATABASE OPTIONS:
  --db <name> (=leveldb)      Select database implementation. Available options are: leveldb, memorydb.
  --db-path <path> (=$HOME/.ethereum) Database path (for non-memory database options)

VM OPTIONS:
  --vm <name>|<path> (=legacy) Select VM implementation. Available options are: interpreter, legacy.
  --evmc  <option>=<value>     EVMC option

LOGGING OPTIONS:
  -v [ --log-verbosity ] <0 - 4>        Set the log verbosity from 0 to 4 (default: 2).
  --log-channels <channel_list>         Space-separated list of the log channels to show (default: show all channels).
                                        Channels: block blockhdr bq chain client debug discov error ethcap exec host impolite info net overlaydb p2pcap peer
                                        rlpx rpc snap statedb sync timer tq trace vmtrace warn warpcap watch
  --log-exclude-channels <channel_list> Space-separated list of the log channels to hide.

  --log-vmtrace                         Enable VM trace log (requires log-verbosity 4).

GENERAL OPTIONS:
  -d [ --data-dir ] <path> Load configuration files and keystore from path (default: $HOME/.ethereum)
  -V [ --version ]         Show the version and exit
  -h [ --help ]            Show this help message and exit

Tools

The Aleth project includes the following tools in addition to the Aleth client:

  • aleth-bootnode: A C++ Ethereum discovery bootnode implementation
  • aleth-key: A rudimentary wallet
  • aleth-vm: An EVM bytecode runner tool
  • rlp: A RLP encoder/decoder tool
  • testeth: A consensus test generator/runner tool

Mining

This project is not suitable for Ethereum mining because the support for GPU mining has been dropped some time ago including the ethminer tool. Use the ethminer tool from https://github.com/ethereum-mining/ethminer.

Testing

Details on how to run and debug the tests can be found here

Documentation

License

License

All contributions are made under the GNU General Public License v3. See LICENSE.

More Repositories

1

go-ethereum

Go implementation of the Ethereum protocol
Go
47,050
star
2

solidity

Solidity, the Smart Contract Programming Language
C++
23,106
star
3

wiki

The Ethereum Wiki
14,759
star
4

EIPs

The Ethereum Improvement Proposal repository
Python
12,522
star
5

mist

[DEPRECATED] Mist. Browse and use Ðapps on the Ethereum network.
JavaScript
7,442
star
6

web3.py

A python interface for interacting with the Ethereum blockchain and ecosystem.
Python
4,941
star
7

ethereum-org-website

Ethereum.org is a primary online resource for the Ethereum community.
Markdown
4,230
star
8

consensus-specs

Ethereum Proof-of-Stake Consensus Specifications
Python
3,514
star
9

pyethereum

Next generation cryptocurrency network
2,667
star
10

remix-project

Remix is a browser-based compiler and IDE that enables users to build Ethereum contracts with Solidity language and to debug transactions.
TypeScript
2,442
star
11

py-evm

A Python implementation of the Ethereum Virtual Machine
Python
2,262
star
12

remix-ide

Documentation for Remix IDE
2,260
star
13

ethereumj

DEPRECATED! Java implementation of the Ethereum yellowpaper. For JSON-RPC and other client features check Ethereum Harmony
Java
2,181
star
14

research

Python
1,798
star
15

yellowpaper

The "Yellow Paper": Ethereum's formal specification
TeX
1,644
star
16

fe

Emerging smart contract language for the Ethereum blockchain.
Rust
1,611
star
17

pm

Project Management: Meeting notes and agenda items
Python
1,587
star
18

solc-js

Javascript bindings for the Solidity compiler
TypeScript
1,449
star
19

remix

This has been moved to https://github.com/ethereum/remix-project
JavaScript
1,177
star
20

remix-desktop

Remix IDE desktop
JavaScript
1,025
star
21

dapp-bin

A place for all the ÐApps to live
JavaScript
1,023
star
22

execution-apis

Collection of APIs provided by Ethereum execution layer clients
Io
949
star
23

devp2p

Ethereum peer-to-peer networking specifications
JavaScript
910
star
24

evmone

Fast Ethereum Virtual Machine implementation
C++
841
star
25

execution-specs

Specification for the Execution Layer. Tracking network upgrades.
Python
839
star
26

kzg-ceremony

Resources and documentation related to the ongoing Ethereum KZG Ceremony.
820
star
27

sourcify

Decentralized Solidity contract source code verification service
TypeScript
779
star
28

js-ethereum-cryptography

Every cryptographic primitive needed to work on Ethereum, for the browser and Node.js
TypeScript
702
star
29

casper

Casper contract, and related software and tests
Python
685
star
30

btcrelay

Ethereum contract for Bitcoin SPV: Live on https://etherscan.io/address/0x41f274c0023f83391de4e0733c609df5a124c3d4
Python
612
star
31

meteor-dapp-wallet

This is an archived repository of one of the early Ethereum wallets.
JavaScript
598
star
32

tests

Common tests for all Ethereum implementations
Python
550
star
33

solidity-examples

Loose collection of Solidity example code
Solidity
532
star
34

staking-deposit-cli

Secure key generation for deposits
Python
528
star
35

webthree-umbrella

Former home of cpp-ethereum (Oct 2015 to Aug 2016)
492
star
36

sharding

Sharding manager contract, and related software and tests
Python
480
star
37

homebrew-ethereum

Homebrew Tap for Ethereum
Ruby
478
star
38

trinity

The Trinity client for the Ethereum network
Python
476
star
39

ethereum-org

[ARCHIVED] ethereum.org website from 2016-2019. See https://github.com/ethereum/ethereum-org-website for current version.
HTML
407
star
40

hive

Ethereum end-to-end test harness
Go
399
star
41

solc-bin

This repository contains current and historical builds of the Solidity Compiler.
JavaScript
397
star
42

lahja

Lahja is a generic multi process event bus implementation written in Python 3.6+ to enable lightweight inter-process communication, based on non-blocking asyncio
Python
392
star
43

trin

An Ethereum portal client: a json-rpc server with nearly instant sync, and low CPU & storage usage
Rust
371
star
44

evmlab

Utilities for interacting with the Ethereum virtual machine
Python
361
star
45

serpent

C++
360
star
46

eth-tester

Tool suite for testing ethereum applications.
Python
350
star
47

evmc

EVMC – Ethereum Client-VM Connector API
C
346
star
48

ERCs

The Ethereum Request for Comment repository
Solidity
339
star
49

beacon-APIs

Collection of RESTful APIs provided by Ethereum Beacon nodes
HTML
328
star
50

annotated-spec

Vitalik's annotated eth2 spec. Not intended to be "the" annotated spec; other documents like Ben Edgington's https://benjaminion.xyz/eth2-annotated-spec/ also exist. This one is intended to focus more on design rationale.
318
star
51

populus

The Ethereum development framework with the most cute animal pictures
316
star
52

eth-utils

Utility functions for working with ethereum related codebases.
Python
306
star
53

homestead-guide

Python
292
star
54

portal-network-specs

Official repository for specifications for the Portal Network
JavaScript
290
star
55

staking-launchpad

The deposit launchpad for staking on Ethereum 🦏
TypeScript
271
star
56

eth-account

Account abstraction library for web3.py
Python
268
star
57

eth2.0-pm

ETH2.0 project management
Python
261
star
58

ropsten

Ropsten public testnet PoW chain
Jupyter Notebook
260
star
59

remix-live

Live deployment of the remix IDE
JavaScript
230
star
60

hevm

symbolic EVM evaluator
Haskell
228
star
61

cbc-casper

Python
228
star
62

eth-abi

Ethereum ABI utilities for python
Python
223
star
63

act

Smart contract specification language
Haskell
216
star
64

beacon_chain

Python
208
star
65

go-verkle

A go implementation of Verkle trees
Go
207
star
66

emacs-solidity

The official solidity-mode for EMACS
Emacs Lisp
201
star
67

moon-lang

Minimal code-interchange format
MoonScript
193
star
68

ethash

C
189
star
69

py_ecc

Python implementation of ECC pairing and bn_128 and bls12_381 curve operations
Python
186
star
70

remixd

remix server
TypeScript
182
star
71

py-solc

Python wrapper around the solc Solidity compiler.
Python
181
star
72

browser-solidity

Fomer location of remix-ide => https://github.com/ethereum/remix-ide
JavaScript
179
star
73

builder-specs

Specification for the external block builders.
HTML
177
star
74

grid

[DEPRECATED] Download, configure, and run Ethereum nodes and tools
JavaScript
175
star
75

pos-evolution

Evolution of the Ethereum Proof-of-Stake Consensus Protocol
168
star
76

evmjit

The Ethereum EVM JIT
C++
166
star
77

mix

The Mix Ethereum Dapp Development Tool
JavaScript
164
star
78

eth-keys

A common API for Ethereum key operations.
Python
162
star
79

solidity-underhanded-contest

Website for the Underhanded Solidity Contest
Solidity
162
star
80

remix-plugin

TypeScript
161
star
81

meteor-dapp-whisper-chat-client

JavaScript
151
star
82

rig

Robust Incentives Group
HTML
121
star
83

public-disclosures

117
star
84

economic-modeling

Python
117
star
85

snake-charmers-tactical-manual

Development *stuff* for the Snake Charmers EF team
114
star
86

node-crawler

Attempts to crawl the Ethereum network of valid Ethereum execution nodes and visualizes them in a nice web dashboard.
Go
112
star
87

c-kzg-4844

A minimal implementation of the Polynomial Commitments API for EIP-4844 and EIP-7594, written in C.
C
111
star
88

kzg-ceremony-specs

Specs for Ethereum's KZG Powers of Tau Ceremony
108
star
89

py-trie

Python library which implements the Ethereum Trie structure.
Python
104
star
90

py-wasm

A python implementation of the web assembly interpreter
Python
103
star
91

eth-hash

The Ethereum hashing function, keccak256, sometimes (erroneously) called sha256 or sha3
Python
103
star
92

execution-spec-tests

A Python framework and collection of test cases to generate test vectors for Ethereum execution clients
Python
102
star
93

remix-workshops

Solidity
100
star
94

py-geth

Python wrapping for running Go-Ethereum as a subprocess
Python
99
star
95

swarm-dapps

Swarm Đapp Examples
JavaScript
98
star
96

remix-vscode

Remix VS Code extension
TypeScript
96
star
97

pyrlp

The python RLP serialization library
Python
96
star
98

ens-registrar-dapp

Registrar DApp for the Ethereum Name Service
JavaScript
94
star
99

dapp-styles

HTML
93
star
100

retesteth

testeth via RPC. Test run, generation by t8ntool protocol
C++
93
star