Quickstart-from-Source
Contents
Install Bazel
Bazel is a build system that is pretty fun.
Git Clone
git clone https://github.com/snowblossomcoin/snowblossom.git
Build it
cd snowblossom bazel build :all
Testing
bazel test :all
Stand alone jars
bazel build :SnowBlossomMiner_deploy.jar :SnowBlossomNode_deploy.jar :SnowBlossomClient_deploy.jar :Shackleton_deploy.jar
The jars will then be in bazel-bin and can be copied to other platforms (even windows).
Run it
Some people like to run it under screen or tmux or whatever.
The setup for each binary is the same, the first option is a config file. See the examples/configs for examples.
Node
Acts as a p2p node, downloads and verifies the blockchain. Acts as a server for miner, client and shackleton.
bazel-bin/SnowBlossomNode node.conf
Miner
Generates new blocks. Requires snow fields, which be either downloaded or generated by the miner directly (can be slow).
bazel-bin/SnowBlossomMiner miner.conf
You can check the Explorer to see which field is currently being used.
Client
Creates and manages a wallet.
bazel-bin/SnowBlossomClient client.conf [command]
Commands:
- send <amt> <dest> (sends funds)
- monitor (displays balance, repeats)
- loadtest (fun)
No command will display the addresses and balances and then exit.
Shackleton (block explorer)
bazel-bin/Shackleton explorer.conf
Answers http requests for information about the blockchain. Recommended to run node with tx_index=true so that shackleton can find all the transactions.
