Aleth – Ethereum C++ client, tools and libraries
Clone or download
Permalink
Failed to load latest commit information.
aleth-key Upgrade EVMC to ABIv3 Jul 26, 2018
aleth-vm Rename StandardTrace::json() to multilineTrace(). Aug 9, 2018
aleth fix data races in JsonRpcSuite Nov 5, 2018
cmake CMake: Move ProjectBinaryen from Hera Nov 8, 2018
doc Replaced test generation docs with references to the central testing … Nov 6, 2018
evmc @ 354ba6f Upgrade EVMC to version 6.0.0 Oct 24, 2018
homebrew Additional paths for dylib path fixup for macOS ZIP builds. Jul 18, 2016
libaleth-interpreter Upgrade EVMC to version 6.0.0 Oct 24, 2018
libdevcore Install leveldb using hunter package manager Nov 6, 2018
libdevcrypto Update address in SecretStore Mar 6, 2018
libethashseal ethash: Optimize difficulty to boundary implementation Oct 16, 2018
libethcore Remove zero bytes cost change from EWASMSchedule Oct 25, 2018
libethereum Made randomSelection() optimization, and fixed two bugs. Nov 14, 2018
libevm EVMC: Fix setting options Nov 2, 2018
libp2p Update required node URL format (#5338) Nov 4, 2018
libweb3jsonrpc Fixed indentation Aug 30, 2018
libwebthree Add support for database selection at runtime Oct 4, 2018
rlp Reformat program_options setup code with clang-format Jan 31, 2018
scripts dockerfile for testeth Nov 14, 2018
test unittests: Normalize test names Nov 13, 2018
utils/json_spirit Use libscrypt from Hunter Mar 6, 2018
.bumpversion.cfg Aleth 1.5.0-alpha.6 Nov 8, 2018
.clang-format Add clang-format config file Dec 18, 2017
.dockerignore dockerfile for testeth Nov 14, 2018
.editorconfig Add .editorconfig file Dec 19, 2017
.gitignore Scripts for external projects Mar 3, 2017
.gitmodules Remove Hera submodule Nov 8, 2018
.travis.yml Removed scripts/install_deps.sh script Nov 6, 2018
.ycm_extra_conf.py Add YCM config Dec 10, 2017
CMakeLists.txt CMake: Bump minimal CMake version to 3.9 Nov 13, 2018
CODING_STYLE.md Replace "C++ Ethereum" with "Aleth" in doc title Sep 23, 2018
CONTRIBUTING.md docs: Rename cpp-ethereum to Aleth in CONTRIBUTING.md Jul 3, 2018
LICENSE Added missing GPLv3 LICENSE file. Aug 7, 2016
README.md CMake: Bump minimal CMake version to 3.9 Nov 13, 2018
appveyor.yml Fix running tests on AppVeyor Oct 15, 2018
circle.yml Circle CI: Use cpp-build-env:7 Nov 13, 2018
codecov.yml Codecov: Change branch to master Aug 14, 2018
refilltests refill tests Jan 4, 2017
sanitizer-blacklist.txt Added stray README.md and sanitizizer-blacklist.txt files. Aug 12, 2016
snapcraft.yaml Removed libleveldb-dev dependency from snapcraft.yaml Nov 6, 2018

README.md

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.

Contact

Gitter GitHub Issues

Getting Started

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

Operating system Status
Ubuntu and macOS TravisCI
Windows AppVeyor

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.

Install dependencies (Windows)

We provide prebuilt dependencies to build the project. Download them with the scripts\install_deps.bat script.

scripts\install_deps.bat

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 Visual Studio 2015 is required. You should generate Visual Studio solution file (.sln) for 64-bit architecture by adding -G "Visual Studio 14 2015 Win64" argument to the CMake configure command. After configuration is completed, the aleth.sln can be found in the build directory.

cmake .. -G "Visual Studio 14 2015 Win64"

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 hestitate 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.exe -h [--help]

NAME:
   aleth 1.4.0
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
  --private <name>                        Use a private chain
  --test                                  Testing mode; disable PoW and provide test rpc interface
  --config <file>                         Configure specialised blockchain using given JSON information

  -o [ --mode ] <full/peer>               Start a full node or a peer node (default: full)

  --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 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

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
  --peerset <list>                Space delimited list of peers; element format: type:publickey@ipAddress[:port]
                                          Types:
                                          default     Attempt connection when no other peers are available and pinning is disabled
                                          required    Keep connected at all times

  --no-discovery                  Disable node discovery; implies --no-bootstrap
  --pin                           Only accept or connect to trusted peers

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            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

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).
  --log-exclude-channels <channel_list> Space-separated list of the log channels to hide.

GENERAL OPTIONS:
  -d [ --db-path ] <path> Load database from path (default: C:\Users\nilse\AppData\Roaming\Ethereum)
  -V [ --version ]        Show the version and exit
  -h [ --help ]           Show this help message and exit

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.