X-Git-Url: http://git.osdn.net/view?p=bytom%2Fvapor.git;a=blobdiff_plain;f=README.md;h=7879982f8920f8f0ac5f7dcfd1f4be3c7b8b43e6;hp=981b20fc22d56b5f9a36050d12fac563e68a471e;hb=36edaa7cf5d7c85a64f072707523504009af1aae;hpb=08281341c2cb02ba11d4218576256688854790fc diff --git a/README.md b/README.md index 981b20fc..7879982f 100644 --- a/README.md +++ b/README.md @@ -1,138 +1,111 @@ Vapor -==== +====== -[![Build Status](https://travis-ci.org/Bytom/bytom.svg)](https://travis-ci.org/Bytom/vapor) [![AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-brightgreen.svg)](./LICENSE) +[![Build Status](https://travis-ci.org/Bytom/vapor.svg)](https://travis-ci.org/Bytom/vapor) [![AGPL v3](https://img.shields.io/badge/license-AGPL%20v3-brightgreen.svg)](./LICENSE) **Golang implemented sidechain for Bytom.** -## What is Vapor? +## Requirements -Vapor is software designed to extensions to the Bytom protocol, which allows partipicants to define, issue and transfer digitial assets on a multi-asset shared ledger or networks pegged to Bytom as a sidechain or run as a standalone blockchain. +- [Go](https://golang.org/doc/install) version 1.11 or higher, with `$GOPATH` set to your preferred directory +## Get source code -## Building from source - -### Requirements +``` +$ git clone https://github.com/Bytom/vapor.git $GOPATH/src/github.com/vapor +``` -- [Go](https://golang.org/doc/install) version 1.8 or higher, with `$GOPATH` set to your preferred directory +Then, you have two ways to get vapor executable file: -### Installation +1. compile source code +2. build it using Docker -Ensure Go with the supported version is installed properly: +## Installation -```bash -$ go version -$ go env GOROOT GOPATH ``` - -- Get the source code - -``` bash -$ git clone https://github.com/bytom/vapor.git $GOPATH/src/github.com/vapor +$ cd $GOPATH/src/github.com/vapor +$ make install ``` -- Build source code +## Run Directly -``` bash -$ cd $GOPATH/src/github.com/vapor -$ make vapor # build vapor -$ make vaporcli # build vaporcli -``` +Firstly, you need initialize node: -When successfully building the project, the `vapor` and `vaporcli` binary should be present in `cmd/vapor` and `cmd/vaporcli` directory, respectively. +``` +$ vapord init --chain_id=vapor --home +``` -### Executables +The default vapor data path (on the host) is: ++ Mac: `~/Library/Application Support/Vapor` ++ Linux: `~/.vapor` ++ Windows: `%APPDATA%\Vapor` -The Vapor project comes with several executables found in the `cmd` directory. +Then, start your node: -| Command | Description | -| ------------ | ------------------------------------------------------------ | -| **vapor** | vapor command can help to initialize and launch vapor domain by custom parameters. `vapor --help` for command line options. | -| **vaporcli** | Our main Vapor CLI client. It is the entry point into the Vapor 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 Vapor network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `vaporcli --help`. | +``` +$ vapord node --home +``` -## Running vapor +## Running in Docker -Currently, vapor 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 `vapor`. This section won't cover all the commands of `vapor` and `vaporcli` at length, for more information, please the help of every command, e.g., `vaporcli help`. +### Build the image -### Initialize +``` +$ cd $GOPATH/src/github.com/vapor +$ docker build -t vapor . +``` -First of all, initialize the node: +### Enter the iterative mode -```bash -$ cd ./cmd/vapor -$ ./vapor init --chain_id mainnet ``` +$ docker run -it --net=host -v :/root/.vapor vapor:latest +``` + +vapor data directory has three config files: -There are three options for the flag `--chain_id`: +- `config.toml` +- `federation.json` +- `node_key.txt` -- `mainnet`: connect to the mainnet. -- `testnet`: connect to the testnet wisdom. -- `solonet`: standalone mode. +Use `exit` to exit Docker's iterative mode. -After that, you'll see `config.toml` generated, then launch the node. +### Daemon mode -### launch +For example, -``` bash -$ ./vapor node +```bash +$ docker run -d --net=host -v :/root/.vapor vapor:latest vapord node --web.closed --auth.disable ``` -available flags for `vapor node`: +To list the running containners and check their container id, image, corresponding command, created time, status, name and ports being used: ``` - --auth.disable Disable rpc access authenticate - --chain_id string Select network type - -h, --help help for node - --log_file string Log output file - --log_level string Select log level(debug, info, warn, error or fatal - --mainchain.mainchain_rpc_host string The address which the daemon will try to connect to validate peg-ins, if enabled. (default "127.0.0.1") - --mainchain.mainchain_rpc_port string The port which the daemon will try to connect to validate peg-ins, if enabled. (default "9888") - --mainchain.mainchain_token string The rpc token that the daemon will use to connect to validate peg-ins, if enabled. - --mining Enable mining - --p2p.dial_timeout int Set dial timeout (default 3) - --p2p.handshake_timeout int Set handshake timeout (default 30) - --p2p.laddr string Node listen address. (0.0.0.0:0 means any interface, any port) (default "tcp://0.0.0.0:46656") - --p2p.max_num_peers int Set max num peers (default 50) - --p2p.pex Enable Peer-Exchange (default true) - --p2p.seeds string Comma delimited host:port seed nodes - --p2p.skip_upnp Skip UPNP configuration - --prof_laddr string Use http to profile bytomd programs - --side.fedpeg_xpubs string Change federated peg to use a different xpub. - --side.parent_genesis_block_hash string (default "a75483474799ea1aa6bb910a1a5025b4372bf20bef20f246a2c2dc5e12e8a053") - --side.pegin_confirmation_depth uint Pegin claims must be this deep to be considered valid. (default: 6) (default 6) - --side.sign_block_xpubs string Change federated peg to use a different xpub. - --signer string The signer corresponds to xpub of signblock - --validate_pegin Validate pegin claims. All functionaries must run this. - --vault_mode Run in the offline enviroment - --wallet.disable Disable wallet - --wallet.rescan Rescan wallet - --web.closed Lanch web browser or not - +$ docker container ls ``` -Given the `vapor` node is running, the general workflow is as follows: - -- create key, then you can create account. -- send transaction, i.e., build, sign and submit transaction. -- query all kinds of information, let's say, avaliable key, account, key, balances, transactions, etc. +or -### Dashboard +``` +$ docker ps +``` -Access the dashboard: +To execute a command inside a containner, for example: ``` -$ open http://localhost:8888/ +$ docker exec -it vaporcli create-access-token ``` -### Sidechain +To stop a running containner: -* [Sidechain deployment](docs/vapor-deployment.md) - -## Contributing +``` +$ docker stop +``` -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! +To remove a containner: -If you run into an issue, feel free to [vapor issues](https://github.com/bytom/vapor/issues/) in this repository. We are glad to help! +``` +$ docker rm +``` ## License