README.md

   1 Bytom
   2 =====
   3 [![Build Status](https://travis-ci.org/Bytom/bytom.svg)](https://travis-ci.org/Bytom/bytom)
   4 [![AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-brightgreen.svg)](./LICENSE)
   5
   6 ## Table of Contents
   7 <!-- vim-markdown-toc GFM -->
   8
   9 * [What is Bytom?](#what-is-bytom)
  10 * [Build from source](#build-from-source)
  11   * [Requirements](#requirements)
  12   * [Installation](#installation)
  13     * [Get the source code](#get-the-source-code)
  14     * [Build](#build)
  15 * [Example](#example)
  16   * [Create and launch a single node](#create-and-launch-a-single-node)
  17     * [Create an account](#create-an-account)
  18     * [Create an asset](#create-an-asset)
  19     * [Asset issuance test](#asset-issuance-test)
  20     * [Expenditure test](#expenditure-test)
  21   * [Set up a wallet and manage the key](#set-up-a-wallet-and-manage-the-key)
  22   * [Multiple node](#multiple-node)
  23 * [Running Bytom in Docker](#running-bytom-in-docker)
  24 * [Contributing](#contributing)
  25 * [License](#license)
  26
  27 <!-- vim-markdown-toc -->
  28
  29 ## What is Bytom?
  30
  31 Bytom is software designed to operate and connect to highly scalable blockchain networks confirming to the Bytom Blockchain Protocol, which allows partipicants to define, issue and transfer digitial assets on a multi-asset shared ledger. Please refer to the [White Paper](https://github.com/Bytom/wiki/blob/master/White-Paper/%E6%AF%94%E5%8E%9F%E9%93%BE%E6%8A%80%E6%9C%AF%E7%99%BD%E7%9A%AE%E4%B9%A6-%E8%8B%B1%E6%96%87%E7%89%88.md) for more details.
  32
  33 In the current state `bytom` is able to:
  34
  35 - Issue assets
  36 - Manage account as well as asset
  37 - Spend assets
  38
  39 ## Build from source
  40
  41 ### Requirements
  42
  43 - [Go](https://golang.org/doc/install) version 1.8 or higher, with `$GOPATH` set to your preferred directory
  44
  45 ### Installation
  46
  47 Ensure Go with the supported version is installed properly:
  48
  49 ```bash
  50 $ go version
  51 $ go env GOROOT GOPATH
  52 ```
  53
  54 #### Get the source code
  55
  56 ``` bash
  57 $ git clone https://github.com/Bytom/bytom $GOPATH/src/github.com/bytom
  58 ```
  59
  60 #### Build
  61
  62 ``` bash
  63 $ cd $GOPATH/src/github.com/bytom
  64 $ make bytomd    # build bytomd
  65 $ make bytomcli  # build bytomcli
  66 ```
  67
  68 ## Example
  69
  70 Currently, bytom 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 `bytom`.
  71
  72 ### Create and launch a single node
  73
  74 When successfully building the project, the `bytom` and `bytomcli` binary should be present in `cmd/bytomd` and `cmd/bytomcli` directory, respectively. The next step is to initialize the node:
  75
  76 ```bash
  77 $ cd ./cmd/bytomd
  78 $ ./bytomd init
  79 ```
  80
  81 After that, you'll see `.bytom` generated in current directory, then launch the single node:
  82
  83 ``` bash
  84 $ ./bytomd node --wallet.enable
  85 ```
  86
  87 Given the `bytom` node is running, the general workflow is as follows:
  88
  89 - create an account
  90 - create an asset
  91 - create/sign/submit a transaction to transfer an asset
  92 - query the assets on-chain
  93
  94
  95 #### Create an account
  96
  97 Create an account named `alice`:
  98
  99 ```bash
 100 $ ./bytomcli create-account alice
 101 xprv:<alice_account_private_key>
 102 responses:<create-account-responses>
 103 account id:<alice_account_id>
 104 ```
 105
 106 Check out the new created account:
 107
 108 ```bash
 109 $ ./bytomcli list-accounts
 110 ```
 111
 112 #### Create an asset
 113
 114 Create an asset named `gold`:
 115
 116 ```bash
 117 $ ./bytomcli create-asset gold
 118 xprv:<gold_asset_private_key>
 119 xpub:<gold_asset_public_key>
 120 responses:<create-asset-responses>
 121 asset id:<gold_asset_id>
 122 ```
 123
 124 Check out the new created asset:
 125
 126 ```bash
 127 $ ./bytomcli list-assets
 128 ```
 129
 130 #### Asset issuance test
 131
 132 Since the account `alice` and the asset `gold` are ready, we need to create another account `bob`, which is also neccessary for the following Expenditure test:
 133
 134 ```bash
 135 $ ./bytomcli create-account bob
 136 ```
 137
 138 Firstly, Alice issue `<issue_amount>`, e.g., 10000, `gold`:
 139
 140 ```bash
 141 $ ./bytomcli sub-create-issue-tx <alice_account_id> <bob_account_id> <gold_asset_id> <gold_asset_private_key> <issue_amount>
 142 ```
 143
 144 When the transaction above is mined, query the balances:
 145
 146 ```bash
 147 # Alice should have 10000 gold now
 148 $ ./bytomcli list-balances
 149 ```
 150
 151 #### Expenditure test
 152
 153 - Alice -> Bob
 154
 155 Alice pays Bob `<payment_amount>`, e.g., 1000, `gold`:
 156
 157 ```bash
 158 $ ./bytomcli sub-spend-account-tx <alice_account_id> <bob_account_id> <gold_asset_id> <alice_private_key> <payment_amount>
 159 # In our case, after Alice pays Bob 1000 gold, the amount of Alice's gold should be 9000, Bob's balances should be 1000
 160 $ ./bytomcli list-balances
 161 ```
 162
 163 - Bob -> Alice
 164
 165 Bob pays Alice `<payment_amount>`, e.g., 500, `gold`:
 166
 167 ```bash
 168 $ ./bytomcli sub-spend-account-tx <bob_account_id> <alice_account_id> <gold_asset_id> <bob_private_key> <payment_amount>
 169 # In our case, after Bob pays Alice 500 gold, the amount of Alice's gold should be 9500, Bob's balances should be 500
 170 $ ./bytomcli list-balances
 171 ```
 172
 173 ### Set up a wallet and manage the key
 174
 175 If you have started a bytom node, then you can create an account via `create-key password`, which will generate a `keystore` directory containing the keys under the project directory.
 176
 177 ```bash
 178 $ ./bytomcli create-key account_name password   # Create an account named account_name using password
 179 $ ./bytomcli delete-key password pubkey         # Delete account pubkey
 180 $ ./bytomcli reset-password oldpassword newpassword pubkey  # Update password
 181 ```
 182
 183 ### Multiple node
 184
 185 Get the submodule depenency for the two-node test:
 186
 187 ```bash
 188 $ git submodule update --init --recursive
 189 ```
 190
 191 Create the first node `bytomd0` and second node `bytomd1`:
 192
 193 ```bash
 194 $ cd cmd/bytomd/2node-test
 195 $ ./test.sh bytomd0  # Start the first node
 196 $ ./test.sh bytomd1  # Start the second node
 197 ```
 198
 199 Then we have two nodes:
 200
 201 ```bash
 202 $ ./bytomcli net-info
 203 net-info:map[listening:true listeners:[Listener(@192.168.199.43:3332)] peers:[map[node_info:map[listen_addr:192.168.199.43:3333 version:0.1.2 other:[wire_version=0.6.2 p2p_version=0.5.0] pub_key:D6B76D1B4E9D7E4D81BA5FAAE9359302446488495A29D7E70AF84CDFEA186D66 moniker:anonymous network:bytom remote_addr:127.0.0.1:51036] is_outbound:false connection_status:map[RecvMonitor:map[Start:2017-10-30T13:45:47.18+08:00 Bytes:425130 AvgRate:27010 Progress:0 Active:true Idle:1.04e+09 Samples:42 InstRate:4591 CurRate:3540 PeakRate:114908 BytesRem:0 TimeRem:0 Duration:1.574e+10] Channels:[map[RecentlySent:5332 ID:64 SendQueueCapacity:100 SendQueueSize:0 Priority:5]] SendMonitor:map[Active:true Idle:1.24e+09 Bytes:16240 Samples:41 CurRate:125 AvgRate:1032 Progress:0 Start:2017-10-30T13:45:47.18+08:00 Duration:1.574e+10 InstRate:147 PeakRate:4375 BytesRem:0 TimeRem:0]]]]]
 204 ```
 205
 206 ## Running Bytom in Docker
 207
 208 Ensure your [Docker](https://www.docker.com/) version is 17.05 or higher.
 209
 210 ```bash
 211 $ docker build -t bytom .
 212 ```
 213
 214 ## Contributing
 215
 216 Thank you for considering to help out with the source code! Any contributions are highly appreciated, and we are grateful for even the smallest of fixes!
 217
 218 If you run into an issue, feel free to [file one](https://github.com/Bytom/bytom/issues/) in this repository. We are glad to help!
 219
 220 ## License
 221
 222 [AGPL v3](./LICENSE)