Skip to content
Modular blockchain framework. Public domain
JavaScript Scala CSS Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
project
scorex-basics Merge branch 'master' into devel Jun 9, 2016
scorex-consensus
scorex-transaction fix merge problems Jun 9, 2016
src/test 1.2.8 in test, release-notes small fixes Jun 9, 2016
.gitignore Utils API route Apr 29, 2016
COPYING license / COPYING Jun 27, 2015
README.md Update README.md Aug 27, 2017
build-submodules.sh BaseTarget calculation algorithm fixing the blocktimes. See details h… Jun 1, 2016
build.sbt
cli.sh cli.sh fix Mar 27, 2016
lock.sbt Update dependencies Apr 22, 2016
release-notes.md fuzzingDelay note in release-notes Jun 9, 2016
scalastyle-config.xml BigDecima type usage was removed from GenesisTransaction.generateSign… May 19, 2016
version.sbt v 1.2.8 Jun 9, 2016

README.md

Scorex - The modular blockchain framework

IMPORTANT: This is repository of outdated version 1 of Scorex framework that is not supported anymore. Second version of Scorex may be found at https://github.com/ScorexFoundation/Scorex.

Motivation

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

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

In opposite, Scorex is less than 4K lines of Scala code. Transactional 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!)

  • New coins are trying to make money immediately, often having just one or two pretty controversial feature. Scorex is the free and open tool aiming to make other systems development easier.

Features

  • Compact, functional code
  • Modular design
  • Scala language
  • 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.
  • Additional consensus module Proof-of-Work consensus algo is available as separate module
  • Simplest transactional model
  • Asynchronous network layer on top of TCP
  • JSON API
  • Command line client for the JSON API
  • Cryptographic primitives externalized into separate scrypto framework

Getting Started

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

More reading

Besides of documentation there are other resources describing Scorex:

Articles:

The Architecture Of A Cryptocurrency

On the Way to a Modular Cryptocurrency, Part 1: Generic Block Structure

On the Way to a Modular Cryptocurrency, Part 2: Stackable API

On Private Blockchains, Technically

Readmes:

Scorex-Basics Sub-Module

Others:

API Description

Please join our mail-list: https://groups.io/g/scorex-dev .

Contributions

Contributions are welcome! Please take a look into issues. Testing codebase is very small at the moment, so writing a test is not just good for start, but useful as well.

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

You can’t perform that action at this time.