/Scorex-Lagonaki

Ultra-compact cryptocurrency engine for hacking around within just 4K lines of Scala code

Primary LanguageScalaCreative Commons Zero v1.0 UniversalCC0-1.0

Scorex - Lagonaki Release

This is the pretty buggy initial release version! Please report bugs found, and contribute with fixes, if possible.

Motivation

There are two huge problems around cryptocurrencies development project Scorex aims to weaken:

  • Bitcoin source code contains more 100K lines of code(80K of C++ only), Nxt is about more than 45K line of Java code. All parts of the design(network/transactions/consensus layers) are mixed in a hard way. So researchers & developers are not in good start positions to make experiments.

In opposite, Scorex is less than 4K lines of Scala code. Transactions layer is as simple as that. Consensus algo could be switched easily(with two consensus algos out of the box, one could be replaced with an another with just one line of code edited!)

  • Major coins forks are trying to make IPO immediately, often having just one or two pretty controversial feature. Scorex is intentionally not production-ready, so please participate in experiments built on top of it, but don't buy tokens unless you are 100% sure what are you doing.

Features

  • Compact, functional, actors-powered code
  • Two 100% Proof-of-Stake consensus algos out of the box, Nxt-like and Qora-like. One algo could be replaced with an another with just one line of code edited (in Constants.scala)
  • Simplest transactions model
  • Asynchronous network layer on top of TCP
  • JSON API
  • Command line client for the JSON API
  • Curve25519 for signatures

Installation

  • Ubuntu Server

Install Oracle Java8 JDK:

echo "deb http://ppa.launchpad.net/webupd8team/java/ubuntu precise main" | tee -a /etc/apt/sources.list

echo "deb-src http://ppa.launchpad.net/webupd8team/java/ubuntu precise main" | tee -a /etc/apt/sources.list

apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys EEA14886

apt-get update

apt-get install oracle-java8-installer

and agree with license terms

Install SBT(Scala Build Tool):

echo "deb http://dl.bintray.com/sbt/debian /" | sudo tee -a /etc/apt/sources.list.d/sbt.list apt-get update apt-get install sbt

Run

Run one or two peers on the local machine:

  • run ./recompile.sh to (re-)build .jar file
  • run ./start-local1.sh to run first local peer binded to 127.0.0.1:9084 . Edit settings in settings-local1.json if needed
  • run ./start-local2.sh to run second local peer binded to 127.0.0.2:9084 . Edit settings in settings-local2.json if needed
  • You can run both peers simultaneously by running ./start-local.sh

You can also run start.sh script to connect to the network, but network is down now :) You can edit folders / other settings in settings.json file before running ./start.sh.

Command-Line Client

Run ./cli.sh after launching server to issue API requests to it via command-line client. See API section below. Some examples of CLI commands:

  • GET blocks/first
  • POST payment {"amount":400, "fee":1, "sender":"2kx3DyWJpYYfLErWpRMLHwkL1ZGyKHAPNKr","recipient":"Y2BXLjiAhPUMSo8iBbDEhv81VwKnytTXsH"}

API

There's separate API.md file with API description

Current Limitations

todo: current glitches / limitations list

Contributions

Contributions are welcome!

License

To the extent possible under law, the authors have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty. You can find applied CC0 license legalcode in the COPYING