-
Notifications
You must be signed in to change notification settings - Fork 328
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
IOTEX-284 Simplify README documentation (#612)
- Loading branch information
Showing
2 changed files
with
53 additions
and
381 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,19 +13,31 @@ | |
| ---- | ||
|
|
||
| Welcome to the official Go implementation of IoTeX protocol! IoTeX is building the next generation of the decentralized | ||
| network for IoT powered by scalability- and privacy-centric blockchains. Please refer to | ||
| IoTeX [whitepaper](https://iotex.io/academics) for details. | ||
| network for IoT powered by scalability- and privacy-centric blockchains. Please refer to IoTeX | ||
| [whitepaper](https://iotex.io/academics) for details. | ||
|
|
||
| Currently, This repo is of alpha-quality with limited features supported and it is subjected to rapid change. Please | ||
| contact us if you intend to run it in production. | ||
|
|
||
| ## Minimum requirements | ||
| ## Contact | ||
|
|
||
| - Mailing list: [iotex-dev]([email protected]) | ||
| - IRC: [gitter](https://gitter.im/iotex-dev-community/Lobby) | ||
|
|
||
| ### Minimum requirements | ||
|
|
||
| | Components | Version | Description | | ||
| |----------|-------------|-------------| | ||
| |[Golang](https://golang.org) | >= 1.11.5 | The Go Programming Language | | ||
| | [Golang](https://golang.org) | ≥ 1.11.5 | Go programming language | | ||
| | [Dep](https://golang.github.io/dep/) | ≥ 0.5.0 | Dependency management tool, required only when you update dependencies | | ||
| | [Protoc](https://developers.google.com/protocol-buffers/) | ≥ 3.6.0 | Protocol buffers, required only when you rebuild protobuf messages | | ||
|
|
||
| ### Get iotex-core | ||
|
|
||
| The easiest way to get iotex-core is to use one of release packages which are available for OSX, Linux on the | ||
| [release page](https://github.com/iotexproject/iotex-core/releases). Iotex-core is also distributed via docker image | ||
| on [docker hub](https://hub.docker.com/r/iotex/iotex-core). | ||
|
|
||
|
|
||
| ## Setup Dev Environment | ||
| ### Build iotex-core from code | ||
|
|
||
| Download the code by | ||
| ``` | ||
|
|
@@ -37,200 +49,61 @@ cd iotex-core | |
|
|
||
| Build the project by | ||
|
|
||
| ```make``` | ||
|
|
||
| ``` | ||
| make | ||
| ``` | ||
|
|
||
| If you need to update the dependency, install Go dependency management tool from | ||
| [golang dep](https://github.com/golang/dep). Then, run | ||
| If the dependency needs to be updated, run | ||
|
|
||
| ```dep ensure``` | ||
| ``` | ||
| dep ensure [--vendor-only] | ||
| ``` | ||
|
|
||
| Note: If your Dev Environment is in Ubuntu, you need to export the following Path: | ||
|
|
||
| ```LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$GOPATH/src/github.com/iotexproject/iotex-core/crypto/lib:$GOPATH/src/github.com/iotexproject/iotex-core/crypto/lib/blslib``` | ||
| Run unit tests only by | ||
|
|
||
| ### Run Unit Tests | ||
| ```make test``` | ||
|
|
||
| ### Reboot | ||
| ```make reboot``` reboots blockchain from fresh database. | ||
|
|
||
| You will see log message output like: | ||
| ``` | ||
| 2018-08-28T09:54:02-07:00 |INFO| commit a block height=0 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:02-07:00 |INFO| Starting dispatcher iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:02-07:00 |INFO| Starting IotxConsensus scheme iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate scheme=STANDALONE | ||
| 2018-08-28T09:54:02-07:00 |INFO| start RPC server on 127.0.0.1:4689 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:02-07:00 |INFO| Starting Explorer JSON-RPC server on [::]:14004 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:03-07:00 |INFO| No peer exist to sync with. iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:03-07:00 |INFO| created a new block at="2018-08-28 09:54:03.210120086 -0700 PDT m=+1.047466065" iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:03-07:00 |INFO| created a new block height=1 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y length=1 networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:03-07:00 |INFO| commit a block height=1 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:04-07:00 |INFO| No peer exist to sync with. iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:04-07:00 |INFO| created a new block at="2018-08-28 09:54:04.213299491 -0700 PDT m=+2.050689454" iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:04-07:00 |INFO| created a new block height=2 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y length=1 networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T09:54:04-07:00 |INFO| commit a block height=2 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| ``` | ||
|
|
||
| ### Run | ||
| ```make run``` restarts blockchain with existing database. | ||
|
|
||
| You will see log message output like: | ||
| ``` | ||
| 2018-08-28T10:03:40-07:00 |INFO| Restarting blockchain blockchain height=3 factory height=3 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:40-07:00 |INFO| Starting dispatcher iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:40-07:00 |INFO| Starting IotxConsensus scheme iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate scheme=STANDALONE | ||
| 2018-08-28T10:03:40-07:00 |INFO| start RPC server on 127.0.0.1:4689 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:40-07:00 |INFO| Starting Explorer JSON-RPC server on [::]:14004 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:41-07:00 |INFO| created a new block at="2018-08-28 10:03:41.17804365 -0700 PDT m=+1.034361469" iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:41-07:00 |INFO| No peer exist to sync with. iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:41-07:00 |INFO| created a new block height=4 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y length=1 networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:41-07:00 |INFO| commit a block height=4 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:42-07:00 |INFO| No peer exist to sync with. iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:42-07:00 |INFO| created a new block at="2018-08-28 10:03:42.175542402 -0700 PDT m=+2.031857345" iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:42-07:00 |INFO| created a new block height=5 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y length=1 networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| 2018-08-28T10:03:42-07:00 |INFO| commit a block height=5 iotexAddr=io1qyqsyqcy8uhx9jtdc2xp5wx7nxyq3xf4c3jmxknzkuej8y networkAddress=127.0.0.1:4689 nodeType=delegate | ||
| ``` | ||
|
|
||
| ### Minicluster | ||
| ```make minicluster``` runs a cluster of 4 delegate nodes with RollDPoS consensus scheme while actions are automatically injected to one of the nodes. | ||
|
|
||
| You will see log message output like: | ||
| ``` | ||
| 2018-10-18T14:23:18-07:00 |INFO| commit a block height=0 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting IotxConsensus scheme scheme=ROLLDPOS | ||
| 2018-10-18T14:23:18-07:00 |INFO| commit a block height=0 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting IotxConsensus scheme scheme=ROLLDPOS | ||
| 2018-10-18T14:23:18-07:00 |INFO| commit a block height=0 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting IotxConsensus scheme scheme=ROLLDPOS | ||
| 2018-10-18T14:23:18-07:00 |INFO| commit a block height=0 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting IotxConsensus scheme scheme=ROLLDPOS | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting Explorer JSON-RPC server on [::]:14004 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting dispatcher | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting Explorer JSON-RPC server on [::]:14006 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting dispatcher | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting Explorer JSON-RPC server on [::]:14005 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting dispatcher | ||
| 2018-10-18T14:23:18-07:00 |INFO| start RPC server on 127.0.0.1:4689 | ||
| 2018-10-18T14:23:18-07:00 |INFO| start RPC server on 127.0.0.1:4691 | ||
| 2018-10-18T14:23:18-07:00 |INFO| start RPC server on 127.0.0.1:4690 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting Explorer JSON-RPC server on [::]:14007 | ||
| 2018-10-18T14:23:18-07:00 |INFO| Starting dispatcher | ||
| 2018-10-18T14:23:18-07:00 |INFO| start RPC server on 127.0.0.1:4692 | ||
| ``` | ||
|
|
||
| ### Deploy w/ Docker Image | ||
|
|
||
| ```make docker``` | ||
|
|
||
| ## Dev Tools | ||
| ### Use actioninjector to inject actions | ||
| Open one terminal window and run the command below to compile and start the test chain server. (This is optional, just | ||
| in case you don't have a node running). | ||
| ``` | ||
| make test | ||
| ``` | ||
|
|
||
| `make reboot` | ||
| Build the docker image by | ||
|
|
||
| Open a new terminal window and start running actioninjector. | ||
| ``` | ||
| make docker | ||
| ``` | ||
|
|
||
| `./bin/actioninjector` | ||
| ### Run iotex-core | ||
|
|
||
| You can use command line flags to customize the injector. | ||
| Start (or resume) a standalone server to operate on an blockchain by | ||
|
|
||
| ``` | ||
| -injector-config-path=path_of_config_file_of_genesis_transfer_addresses | ||
| -chain=id_of_target_chain | ||
| -addr=target_address_for_jrpc_connection | ||
| -transfer-num=number_of_transfers | ||
| -transfer-gas-limit=transfer_gas_limit | ||
| -transfer-gas-price=transfer_gas_price | ||
| -transfer-payload=transfer_payload | ||
| -vote-num=number_of_votes | ||
| -vote-gas-limit=vote_gas_limit | ||
| -vote-gas-price=vote_gas_price | ||
| -execution-num=number_of_executions | ||
| -contract=smart_contract_address | ||
| -execution-amount=execution_amount | ||
| -execution-gas-limit=execution_gas_limit | ||
| -execution-gas-price=execution_gas_price | ||
| -execution-data=execution_data | ||
| -interval=sleeping_interval_in_seconds | ||
| -retry-num=maximum_number_of_rpc_retries | ||
| -retry-interval=sleeping_interval_between_two_consecutive_rpc_retries_in_seconds | ||
| -aps=actions_to_be_injected_per_second_APS_MODE_ONLY | ||
| -duration=duration_of_injector_running_in_seconds_APS_MODE_ONLY | ||
| -reset-interval=time_interval_to_reset_nonce_counter_in_seconds | ||
| ``` | ||
|
|
||
| Default flag values: | ||
| * injector-config-path="./tools/actioninjector.v2/gentsfaddrs.yaml" | ||
| * chain=1 | ||
| * addr="127.0.0.1:14004" | ||
| * transfer-num=50 | ||
| * transfer-gas-limit=1000000 | ||
| * transfer-gas-price=10 | ||
| * transfer-payload="" | ||
| * vote-num=50 | ||
| * vote-gas-limit=1000000 | ||
| * vote-gas-price=10 | ||
| * execution-num=50 | ||
| * contract="io1pmjhyksxmz2xpxn2qmz4gx9qq2kn2gdr8un4xq" | ||
| * execution-amount=0 | ||
| * execution-gas-limit=1200000 | ||
| * execution-gas-price=10 | ||
| * execution-data="2885ad2c" | ||
| * interval=5 | ||
| * retry-num=5 | ||
| * retry-interval=1 | ||
| * aps=0 | ||
| * duration=60 | ||
| * reset-interval=10 | ||
|
|
||
| Note: APS is a running mode option which is disabled by default. When aps > 0, APS mode is enabled and the injector alternates to inject transfers and votes within the time frame specified by duration. | ||
|
|
||
| ### Use addrgen to generate addresses | ||
| Open a terminal window and run the command below to start running addrgen. | ||
| make run | ||
| ``` | ||
|
|
||
| `make build; ./bin/addrgen` | ||
|
|
||
| You can use command line flag to customize the address generator. | ||
|
|
||
| `-number=numer_of_addresses_to_be_generated` | ||
|
|
||
| Default flag value: | ||
| * number=10 | ||
|
|
||
| ### Use iotc to query the blockchain | ||
| Open a terminal window and run the command below to compile and start the test chain server with the configuration specified in "config_local_delegate.yaml" (This is optional, just in case you don't have a node running). | ||
|
|
||
| `make; make run` | ||
|
|
||
| Open a new terminal window and run iotc with the following command. | ||
| Restart the server from a clean state by | ||
|
|
||
| `./bin/iotc [commands] [flags]` | ||
| ``` | ||
| make reboot | ||
| ``` | ||
|
|
||
| The following is the complete current usage of iotc. More commands will be added in the future. | ||
| Note that if your enviroment is in Linux, you need to add the share libraries into `$LD_LIBRARY_PATH` by | ||
|
|
||
| ``` | ||
| Usage: | ||
| iotc [command] [flags] | ||
| LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$GOPATH/src/github.com/iotexproject/iotex-core/crypto/lib:$GOPATH/src/github.com/iotexproject/iotex-core/crypto/lib/blslib | ||
| ``` | ||
|
|
||
| Available Commands: | ||
| balance Returns the current balance of given address | ||
| details Returns the details of given account | ||
| height Returns the current height of the blockchain | ||
| help Help about any command | ||
| self Returns this node's address | ||
| transfers Returns the transfers associated with a given address | ||
| ## Contact | ||
|
|
||
| Flags: | ||
| -h, --help help for iotc | ||
| - Mailing list: [iotex-dev]([email protected]) | ||
| - IRC: [gitter](https://gitter.im/iotex-dev-community/Lobby) | ||
| - Bugs: [issues](https://github.com/iotexproject/iotex-core/issues) | ||
|
|
||
| Use "iotc [command] --help" for more information about a command. | ||
| ``` | ||
|
|
||
| ## Contribution | ||
| We are glad to have contributors out of the core team; contributions, including (but not limited to) style/bug fixes, implementation of features, proposals of schemes/algorithms, and thorough documentation, are | ||
| welcomed. Please refer to our [contribution guideline](https://github.com/iotexproject/iotex-core/blob/master/CONTRIBUTING.md) for more information. | ||
| We are glad to have contributors out of the core team; contributions, including (but not limited to) style/bug fixes, | ||
| implementation of features, proposals of schemes/algorithms, and thorough documentation, are welcomed. Please refer to | ||
| our [contribution guideline](https://github.com/iotexproject/iotex-core/blob/master/CONTRIBUTING.md) for more | ||
| information. Development guide documentation is [here](https://github.com/iotexproject/iotex-core/wiki/Developers%27-Guide). | ||
|
|
||
| ## License | ||
| This project is licensed under the [Apache License 2.0](https://github.com/iotexproject/iotex-core/blob/master/LICENSE). | ||
Oops, something went wrong.