Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 2.51 KB

getting-started.md

File metadata and controls

88 lines (63 loc) · 2.51 KB
Raw

Getting started - Building and running a Stratis Full Node

Supported Platforms

  • Windows - works from Windows 7 and later, on both x86 and x64 architecture. Most of the development and testing is happening here.
  • Linux - works and Ubuntu 14.04 and later (x64). It's been known to run on some other distros so your mileage may vary.
  • MacOS - works from OSX 10.12 and later.

Prerequisites

To install and run the node, you need

Build instructions

Get the repository and its dependencies

git clone https://github.com/stratisproject/StratisBitcoinFullNode.git  
cd StratisBitcoinFullNode/src

Build and run the code

With this node, you can connect to either the Stratis network or the Bitcoin network, either on MainNet or TestNet. So you have 4 options:

  1. To run a Stratis node on MainNet, do
cd Stratis.StratisD
dotnet run
  1. To run a Stratis node on TestNet, do
cd Stratis.StratisD
dotnet run -testnet
  1. To run a Bitcoin node on MainNet, do
cd Stratis.BitcoinD
dotnet run
  1. To run a Bitcoin node on TestNet, do
cd Stratis.BitcoinD
dotnet run -testnet

Advanced options

You can get a list of command line arguments to pass to the node with the -help command line argument. For example:

cd Stratis.StratisD
dotnet run -help

Script

We have a nifty little script that can execute all the previous commands for you, including starting the node.
You just need to edit the file and specify whether you want to run a Stratis or a Bitcoin node, on MainNet or Testnet.
It's located here.

Faucet

If you need testnet funds (TSTRAT) for testing there is a faucet located here.

Docker Containers

Two containers are available here

  • stratis-node: Run on the Bitcoin Main or Test networks
  • stratis-node-sim: Join our simulation network

Swagger Endpoints

Once the node is running, a Swagger interface (web UI for testing an API) is available.