This repository contains the reference implementation of the Ergo Platform protocol, which is an alternative to the Bitcoin protocol.
Ergo Platform website: https://ergoplatform.org/
- Powerful contracts in the multi-stage extended UTXO model (see ErgoScript whitepaper)
- Memory-hard Proof-of-Work function Autolykos2
- Support for stateless clients (asymmetric, based on https://eprint.iacr.org/2016/994), NiPoPoWs, hybrid modes
- Alternative transactional language, which is more powerful than Bitcoin Script but also safe against heavy validation attacks
- Alternative fee model with mandatory storage-rent component
A White Paper with a brief description is available. A Yellow Paper with detailed specification is underway and will be available shortly. At the moment, there are drafts of the Yellow Paper available, and currently the reference implementation code should be considered as the specification.
This client relies on some assumptions in regards with its environment:
- execution environment is trusted. While seed is stored in encrypted files, and the client's wallet tries to remove secret key from memory as soon as possible when it is not needed, the client has no protection from side-channel attacks, memory scans etc.
- clocks should be more or less synchronized. If timestamp of a block is more than 20 minutes in future, the block will be temporarily rejected. The client does not use NTP or other time syncing protocols.
See documentation
There are three kinds of tests:
- Unit and property tests, run them with
sbt testcommand. - Integration tests, they require for Docker to be installed, then run
sudo sbt it:test. - Bootstrapping tests, very slow as they are checking that the node is indeed catching up with the main network in
different regimes, they require for Docker too, run as
sudo sbt it2:test.
Your can use IntelliJ IDEA (Community or Ultimate edition) or VSCode + Metals. Before opening the project in IDE make sure it can be built with sbt. You may need to fix dependency resolution errors first.
After that you can open the project folder in Idea (File / Open)
which will run Project Import Wizard. The wizard will use SBT configuration
(build.sbt file) to generate Idea's project configuration files.
You can open File / Project Structure... dialog to see project configuration.
If everything is successful you can compile the project in IDE.
Ergo is open-source and open movement, always in need for testers and developers! Please feel free to discuss development in Ergo Discord, #development channel.