9 releases

Uses old Rust 2015

0.3.3 Mar 9, 2018
0.3.2 Mar 8, 2018
0.2.3 Feb 24, 2018
0.1.3 Feb 16, 2018

#3 in #loom

31 downloads per month

Apache-2.0

58KB
1.5K SLoC

Silk crate Silk documentation Build Status codecov

Disclaimer

All claims, content, designs, algorithms, estimates, roadmaps, specifications, and performance measurements described in this project are done with the author's best effort. It is up to the reader to check and validate their accuracy and truthfulness. Furthermore nothing in this project constitutes a solicitation for investment.

Silk, a silky smooth implementation of the Loom specification

Loom™ is a new architecture for a high performance blockchain. Its white paper boasts a theoretical throughput of 710k transactions per second on a 1 gbps network. The specification is implemented in two git repositories. Research is performed in the loom repository. That work drives the Loom specification forward. This repository, on the other hand, aims to implement the specification as-is. We care a great deal about quality, clarity and short learning curve. We avoid the use of unsafe Rust and write tests for everything. Optimizations are only added when corresponding benchmarks are also added that demonstrate real performance boosts. We expect the feature set here will always be a ways behind the loom repo, but that this is an implementation you can take to the bank, literally.

Running the demo

First, install Rust's package manager Cargo.

$ curl https://sh.rustup.rs -sSf | sh
$ source $HOME/.cargo/env

Install the silk executables:

    $ cargo install silk

The testnode server is initialized with a transaction log from stdin and generates new log entries on stdout. To create the input log, we'll need to create the mint and use it to generate a genesis log. It's done in two steps because the mint.json file contains a private key that will be used later in this demo.

    $ echo 500 | silk-mint > mint.json
    $ cat mint.json | silk-genesis > genesis.log

Now you can start the server:

    $ cat genesis.log | silk-testnode > transactions0.log

Then, in a separate shell, let's execute some transactions. Note we pass in the JSON configuration file here, not the genesis log.

    $ cat mint.json | silk-client-demo

Now kill the server with Ctrl-C, and take a look at the transaction log. You should see something similar to:

{"num_hashes":27,"id":[0, "..."],"event":"Tick"}
{"num_hashes":3,"id":[67, "..."],"event":{"Transaction":{"asset":42}}}
{"num_hashes":27,"id":[0, "..."],"event":"Tick"}

Now restart the server from where we left off. Pass it both the genesis log, and the transaction log.

    $ cat genesis.log transactions0.log | silk-testnode > transactions1.log

Lastly, run the client demo again, and verify that all funds were spent in the previous round, and so no additional transactions are added.

    $ cat mint.json | silk-client-demo

Stop the server again, and verify there are only Tick entries, and no Transaction entries.

Developing

Building

Install rustc, cargo and rustfmt:

$ curl https://sh.rustup.rs -sSf | sh
$ source $HOME/.cargo/env
$ rustup component add rustfmt-preview

Download the source code:

$ git clone https://github.com/loomprotocol/silk.git
$ cd silk

Testing

Run the test suite:

cargo test

Benchmarking

First install the nightly build of rustc. cargo bench requires unstable features:

$ rustup install nightly

Run the benchmarks:

$ cargo +nightly bench --features="asm,unstable"

Dependencies

~9–18MB
~331K SLoC