Skip to content

CharlieC3/stacks-blockchain

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stacks

Stacks Blockchain

Reference implementation of the Stacks blockchain in Rust.

Stacks is a layer-2 blockchain that uses Bitcoin as a base layer for security and enables decentralized apps and predictable smart contracts using the Clarity language. Stacks implements Proof of Transfer (PoX) mining that anchors to Bitcoin security. Leader election happens at the Bitcoin blockchain and Stacks (STX) miners write new blocks on the separate Stacks blockchain. With PoX there is no need to modify Bitcoin to enable smart contracts and decentralized apps.

License: GPL v3 Release Build Status Discord Chat

Building

1. Download and install Rust

For building on Windows, follow the rustup installer instructions at https://rustup.rs/.

$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
$ source $HOME/.cargo/env
$ rustup component add rustfmt
  • When building the master branch, ensure you are using the latest stable release:
$ rustup update

2. Clone the source repository:

$ git clone --depth=1 https://github.com/stacks-network/stacks-blockchain.git
$ cd stacks-blockchain

3. Build the project

$ cargo build

Testing

Run the tests:

$ cargo test testnet  -- --test-threads=1

Run all unit tests in parallel using nextest:

Warning, this typically takes a few minutes

$ cargo nextest run

Run the testnet

You can observe the state machine in action locally by running:

$ cd testnet/stacks-node
$ cargo run --bin stacks-node -- start --config=./conf/testnet-follower-conf.toml

On Windows, many tests will fail if the line endings aren't LF. Please ensure that you are have git's core.autocrlf set to input when you clone the repository to avoid any potential issues. This is due to the Clarity language currently being sensitive to line endings.

Additional testnet documentation is available here and here

Release Process

The release process for the stacks blockchain is defined here

Further Reading

You can learn more by visiting the Stacks Website and checking out the documentation:

You can also read the technical papers:

Copyright and License

The code and documentation copyright are attributed to stacks.org.

This code is released under the GPL v3 license, and the docs are released under the Creative Commons license.

About

The Stacks 2.0 blockchain implementation

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 90.3%
  • TypeScript 7.3%
  • Clarity 1.8%
  • Shell 0.6%
  • Dockerfile 0.0%
  • Mustache 0.0%