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/

• Memory-hard non-outsourceable Proof-of-Work function Autolykos
• New modes of operation: light-fullnode, light-SPV, hybrid modes
• Alternative transactional language, which is more powerful that Bitcoin Script but also safe against heavy validation attacks
• Alternative fee model with mandatory storage-rent component

It will be a White Paper with a brief description, and also a Yellow Paper with detailed specification. At the moment, there is only Yellow Paper drafts, and currently the reference implementation code should be considered as a specification.

You can check our Wiki page for node installation and configuration guide.

Also, reference with Node Configuration File wiki page for creating your own configuration file.

In order to build the Ergo node from sources you need JDK (>= 1.8) and SBT to be installed on your machine.

In order to simply get a single jar run: sbt assembly - assembly would appear in target/scala-2.12/ directory.

If you want to create a package for a specific platform with launching scripts the one of the following packager commands could be chosen (depending on desired system type you want to build for):

• universal:packageBin - Generates a universal zip file
• universal:packageZipTarball - Generates a universal tgz file
• debian:packageBin - Generates a deb
• docker:publishLocal - Builds a Docker image using the local Docker server
• rpm:packageBin - Generates an rpm
• universal:packageOsxDmg - Generates a DMG file with the same contents as the universal zip/tgz.
• windows:packageBin - Generates an MSI

The final build command should look like: sbt <packager_command>, example: sbt universal:packageBin. A resulted package could be found in the target/scala-2.12/<platform_type> directory.

The node could be started in a few different ways:

• In case you have only a jar: java -jar /path/to/ergo-<version>.jar --<networkId> -c /path/to/local.conf
• Using start script from sbt-native-packager: sh /path/to/bin/ergo --<networkId> -c /path/to/local.conf

Available networkId options: mainnet, testnet, devnet.

Ergo has officially supported Docker package. To run Ergo as a console application with logs in console:

sudo docker run --rm -p 9020:9020 -p 9052:9052 -v ergo-testnet:/home/ergo/.ergo ergoplatform/ergo

This will connect to Ergo testnet with default config and open ports 9020 and 9052 on host system. All data will be stored in your named Docker volume ergo-testnet.

To run specific Ergo version as a service with custom config:

sudo docker run -d \
    -p 9020:9020 \
    -p 9052:9052 \
    -v ergo:/home/ergo/.ergo \
    -v /path/on/host/system/to/myergo.conf:/etc/myergo.conf \
    ergoplatform/ergo:v2.0.3 --<networkId> -c /etc/myergo.conf

This will connect to Ergo mainnet or testnet respecting your configuration passed in myergo.conf. Every default config value would be overwritten with corresponding value in myergo.conf. This also would store your data in named Docker volume ergo (if you change default data location in your config file, do not forget mount ergo volume to new location in container) and open ports 9007 and 9052 on host system. Note that 9052 is used for API, so it is ok not to open it into whole Internet. Also, Ergo node works normally under NAT, so you can keep closed your 9007 port too, hence other nodes could not discover and connect to yours one, only your node could initiate connections.

YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.