X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=README.md;h=3e8b16545403d60cad4a8d8bbf2597a41fc288fe;hb=refs%2Fheads%2Ftele_test;hp=8c7125777b9d04b501350cdaa2919e21eb264dc0;hpb=75d02ecbd7601008acb41ef8e2dd648b045af113;p=bytom%2Fvapor.git diff --git a/README.md b/README.md index 8c712577..3e8b1654 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,8 @@ Vapor ## Get source code ``` -$ git clone https://github.com/Bytom/vapor.git $GOPATH/src/github.com/vapor +$ cd $GOPATH/src/github.com/bytom +$ git clone https://github.com/Bytom/vapor.git ``` Then, you have two ways to get vapor executable file: @@ -23,7 +24,7 @@ Then, you have two ways to get vapor executable file: ## Installation ``` -$ cd $GOPATH/src/github.com/vapor +$ cd $GOPATH/src/github.com/bytom/vapor $ make install ``` @@ -32,19 +33,18 @@ $ make install Firstly, you need initialize node: ``` -$ bytomd init --chain_id=vapor --home +$ vapord init --chain_id=mainnet --home ``` -For example, you can store vapor data in `$HOME/bytom/vapor`: - -``` -$ bytomd init --chain_id=vapor --home $HOME/bytom/vapor -``` +The default vapor data path (on the host) is: ++ Mac: `~/Library/Application Support/Vapor` ++ Linux: `~/.vapor` ++ Windows: `%APPDATA%\Vapor` Then, start your node: ``` -$ bytomd node --home +$ vapord node --home ``` ## Running in Docker @@ -52,7 +52,7 @@ $ bytomd node --home ### Build the image ``` -$ cd $GOPATH/src/github.com/vapor +$ cd $GOPATH/src/github.com/bytom/vapor $ docker build -t vapor . ``` @@ -68,8 +68,6 @@ vapor data directory has three config files: - `federation.json` - `node_key.txt` -Then you can use bytomd and bytomcli following [Bytom Wiki](https://github.com/Bytom/bytom/wiki/Command-Line-Options). - Use `exit` to exit Docker's iterative mode. ### Daemon mode @@ -77,7 +75,7 @@ Use `exit` to exit Docker's iterative mode. For example, ```bash -$ docker run -d --net=host -v :/root/.vapor vapor:latest bytomd node --web.closed --auth.disable +$ docker run -d --net=host -v :/root/.vapor vapor:latest vapord node --web.closed --auth.disable ``` To list the running containners and check their container id, image, corresponding command, created time, status, name and ports being used: @@ -95,7 +93,7 @@ $ docker ps To execute a command inside a containner, for example: ``` -$ docker exec -it bytomcli create-access-token +$ docker exec -it vaporcli create-access-token ``` To stop a running containner: @@ -110,6 +108,25 @@ To remove a containner: $ docker rm ``` +### Reward distribution tool + +After the supernode and alternative node receive the reward from the node, they will allocate the reward + +according to the interest rate. + +The reward calculation rules: + + calculate the reward (consensus reward * interest rate * voting weight) according to the weight of votes + +cast in consensus around, and choose how many rounds of consensus to allocate the reward flexibly. + +[Tool usage details](./cmd/votereward/README.md) + + +### Merger utxo +UTXO has been merged to solve the problem that too much UTXO input causes a failed send transaction to fail. +[details](./cmd/utxomerge/README.md) + ## License [AGPL v3](./LICENSE)