Mana-Ethereum is an open-source Ethereum blockchain client built using Elixir. Elixir runs on the Erlang Virtual Machine, which is used for distributed systems and offers massive scalability and high visibility. These properties make Elixir a perfect candidate for blockchain network development.
In the current Ethereum ecosystem, a majority of active nodes on the network are Geth or Parity nodes. Mana-Ethereum provides an additional open-source alternative. Our aim is to create an open, well-documented implementation that closely matches the protocols described in the Ethereum yellow paper.
Mana-Ethereum is currently in development. See the Project Status for more information.
- Elixir ~> 1.7.3
- Rust ~> 1.26.0 (as a dependency of Rox)
- Clone repo with submodules (to access the Ethereum common tests)
git clone --recurse-submodules https://github.com/mana-ethereum/mana.git
-
Go to the mana subdirectory
cd mana -
Run
bin/setup
Currently, peer-to-peer communication is incomplete, but if you would like to partially sync blocks, you can use an experimental script to sync with Infura. This script downloads blocks from Infura, runs the transactions inside them then verifies the block.
To sync a chain from an RPC Client (e.g. Infura) or a local client, run the following command:
mix sync --chain ropstenYou can sign up for an Infura API key here. This will ensure your requests are not throttled.
mix sync --chain ropsten --provider-url https://ropsten.infura.io/v3/<api_key>Alternatively, you can sync via IPC to a local node (like Parity or Geth running locally):
mix sync --chain ropsten --provider-url ipc://~/Library/Application\ Support/io.parity.ethereum/jsonrpc.ipcYou can begin syncing, you will see a timestamp and a running list of verified blocks.
- When running the script mainnet fails due to an as of yet undiagnoised issue (see this issue). The current highest block we've reached is 1660868.
- Ropsten fails on block 295311 with
receipts_root_mismatch,gas_used_mismatchandstate_root_mismatcherrors.
When trying to debug why the sync_with_infura script is failing to verify a
block, we have found etherscan to be very helpful. Take block 177610 for
example,
We can look at the block information, and dive into the transaction information. From that page, the "Tools & Utilities" dropdown provides very helpful debugging tools. Two of the most valuable are Geth DebugTrace and Remix Debugger,
-
Geth DebugTraceallows us to compare each operation and its gas consumption against our implementation. -
Remix Debuggerallows us to compare the stack against our implementation's stack for each cycle of the virtual machine.
NOTE: for the Remix Debugger, you may want to add the block number at the top
before pressing the play button.
To log the operation, gas consumption, and stack in our application, please see the EVM README's example setup.
Run:
mix test --exclude network
Tests tagged with network integrate with other nodes and cannot run unless another node is running in parallel. Use the --exclude network flag to exclude these tests.
If you want to only run Ethereum common tests, we currently have:
# Ethereum Virtual Machine tests
cd apps/evm && mix test test/evm_test.exs
# Ethereum Blockchain tests
cd apps/blockchain && mix test test/blockchain_test.exs
# Ethereum General State tests
cd apps/blockchain && mix test test/blockchain/state_test.exs
# Ethereum Transaction tests
cd apps/blockchain && mix test test/blockchain/transaction_test.exs
Ethereum common tests are created for all clients to test against. We plan to progress through supported hard fork test protocols, and are currently working on the Homestead tests. See the common test documentation for more information.
VMTests = 100% passing
| Hardfork | BlockchainTests passing | GeneralStateTests passing | Complete? |
|---|---|---|---|
| Frontier | 100% (1320/1320) | 100% (1033/1033) | ✓ |
| Homestead | 100% (2203/2203) | 100% (2061/2061) | ✓ |
| HomesteadToDaoAt5 | 100% (4/4) | N/A | ✓ |
| TangerineWhistle | 100% (1262/1262) | 100% (1112/1112) | ✓ |
| SpuriousDragon | 100% (1193/1193) | 100% (1172/1172) | ✓ |
| Byzantium | 100% (4945/4945) | 100% (4790/4790) | ✓ |
| Constantinople | 100% (5369/5369) | 100% (5331/5331) | ✓ |
View the community Constantinople Project Tracker.
The Ethereum common tests are in a submodule. To update you'll want to:
% cd ethereum_common_tests
% git checkout develop
% git pull| Functionality | Status |
|---|---|
| Encoding and Hashing | The RLP encoding protocol and the Merkle Patricia Tree data structure are fully implemented. |
| Ethereum Virtual Machine | Our EVM currently passes 100% of the common VM tests. We are still discovering subtle differences in our implementation such as the “vanishing Ether” issue. This component is for the most part complete. |
| Peer to Peer Networking | Currently we can connect to one of the Ethereum bootnodes, get a list of peers, and add them to a list of known peers. We have fully implemented the modified kademlia DHT. We can also successfully perform the encrypted handshake with peer nodes and derive secrets to frame the rest of the messages. We have not yet implemented the ability to send multi-frame packets. See Issue #97. |
| DEVp2p Protocol and Ethereum Wire Protocol | These are partially implemented but need to be completed. See Issue #166 and Issue #167. |
To view module and reference documentation:
-
Generate documentation.
mix docs -
View the generated docs.
open doc/index.html
Licensed under either of:
- Apache License, Version 2.0, (LICENSE_APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE_MIT or http://opensource.org/licenses/MIT)
at your option.
See the CONTRIBUTING document for contribution, testing and pull request protocol.
-
Ethereum yellow paper(Ethereum: A Secure Decentralised Generalised Transaction Ledger Byzantium Version)
Additional Ethereum Implementations