bystack

README

Bystack

Official golang implementation of the Bystack protocol.

Automated builds are available for stable releases and the unstable master branch. Binary archives are published at https://github.com/Bytom/bystack/releases.

What is Bystack?

Bystack is software designed to operate and connect to highly scalable blockchain networks confirming to the Bystack Blockchain Protocol, which allows partipicants to define, issue and transfer digitial assets on a multi-asset shared ledger. Please refer to the White Paper for more details.

In the current state bystack is able to:

• Manage key, account as well as asset
• Send transactions, i.e., issue, spend and retire asset

Installing with Homebrew

brew tap bytom/bystack && brew install bystack

Building from source

Requirements

• Go version 1.8 or higher, with $GOPATH set to your preferred directory

Installation

Ensure Go with the supported version is installed properly:

$ go version
$ go env GOROOT GOPATH

• Get the source code

$ git clone https://github.com/Bytom/bystack.git $GOPATH/src/github.com/bytom/bystack

• Build source code

$ cd $GOPATH/src/github.com/bytom/bystack
$ make bystackd    # build bystackd
$ make bystackcli  # build bystackcli

When successfully building the project, the bystackd and bystackcli binary should be present in cmd/bystackd and cmd/bystackcli directory, respectively.

Executables

The Bystack project comes with several executables found in the cmd directory.

Command	Description
bystackd	bystackd command can help to initialize and launch bystack domain by custom parameters. bystackd --help for command line options.
bystackcli	Our main Bystack CLI client. It is the entry point into the Bystack network (main-, test- or private net), capable of running as a full node archive node (retaining all historical state). It can be used by other processes as a gateway into the Bystack network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. bystackcli --help and the bystackd Wiki page for command line options.

Running bystack

Currently, bystack is still in active development and a ton of work needs to be done, but we also provide the following content for these eager to do something with bystack. This section won't cover all the commands of bystackd and bystackcli at length, for more information, please the help of every command, e.g., bystackd help.

Initialize

First of all, initialize the node:

$ cd ./cmd/bystackd
$ ./bystackd init --chain_id mainnet

There are three options for the flag --chain_id:

• mainnet: connect to the mainnet.
• testnet: connect to the testnet wisdom.
• solonet: standalone mode.

After that, you'll see config.toml generated, then launch the node.

launch

$ ./bystackd node

available flags for bystackd node:

Flags:
      --auth.disable                     Disable rpc access authenticate
      --chain_id string                  Select network type
  -h, --help                             help for node
      --log_file string                  Log output file (default "log")
      --log_level string                 Select log level(debug, info, warn, error or fatal)
      --p2p.dial_timeout int             Set dial timeout (default 3)
      --p2p.handshake_timeout int        Set handshake timeout (default 30)
      --p2p.keep_dial string             Peers addresses try keeping connecting to, separated by ',' (for example "1.1.1.1:46657;2.2.2.2:46658")
      --p2p.laddr string                 Node listen address. (0.0.0.0:0 means any interface, any port) (default "tcp://0.0.0.0:46656")
      --p2p.lan_discoverable             Whether the node can be discovered by nodes in the LAN (default true)
      --p2p.max_num_peers int            Set max num peers (default 50)
      --p2p.node_key string              Node key for p2p communication
      --p2p.proxy_address string         Connect via SOCKS5 proxy (eg. 127.0.0.1:1086)
      --p2p.proxy_password string        Password for proxy server
      --p2p.proxy_username string        Username for proxy server
      --p2p.seeds string                 Comma delimited host:port seed nodes
      --p2p.skip_upnp                    Skip UPNP configuration
      --prof_laddr string                Use http to profile bystackd programs
      --vault_mode                       Run in the offline enviroment
      --wallet.disable                   Disable wallet
      --wallet.rescan                    Rescan wallet
      --wallet.txindex                   Save global tx index
      --web.closed                       Lanch web browser or not
      --ws.max_num_concurrent_reqs int   Max number of concurrent websocket requests that may be processed concurrently (default 20)
      --ws.max_num_websockets int        Max number of websocket connections (default 25)

Global Flags:
      --home string   root directory for config and data
  -r, --root string   DEPRECATED. Use --home (default "/Users/zcc/Library/Application Support/Bystack")
      --trace         print out full stack trace on errors

Given the bystackd node is running, the general workflow is as follows:

• create key, then you can create account and asset.
• send transaction, i.e., build, sign and submit transaction.
• query all kinds of information, let's say, avaliable key, account, key, balances, transactions, etc.

Dashboard

Access the dashboard:

$ open http://localhost:9888/

In Docker

Ensure your Docker version is 17.05 or higher.

$ docker build -t bystack .

For the usage please refer to running-in-docker-wiki.

Contributing

Thank you for considering helping out with the source code! Any contributions are highly appreciated, and we are grateful for even the smallest of fixes!

If you run into an issue, feel free to bystack issues in this repository. We are glad to help!

License

AGPL v3