From 1f1f253c5c2a8e6ace02ad05125e1f710b5eeb47 Mon Sep 17 00:00:00 2001 From: kidinamoto01 Date: Thu, 8 Nov 2018 00:26:13 +0800 Subject: [PATCH 001/100] IRISHUB-537:edit install (cherry picked from commit 9ba6b789845b090f6c9c83a5ebce2bdc4c624282) --- docs/get-started/README.md | 2 ++ docs/get-started/Validator-Node.md | 5 +++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/get-started/README.md b/docs/get-started/README.md index 451dd7933..c7a259df6 100644 --- a/docs/get-started/README.md +++ b/docs/get-started/README.md @@ -46,3 +46,5 @@ Task List for Fuxi-3001: https://github.com/irisnet/testnets/blob/master/fuxi/fu ## Useful Links * Riot chat: #irisvalidators:matrix.org + +* Explorer: https://testnet.irisplorer.io/#/home \ No newline at end of file diff --git a/docs/get-started/Validator-Node.md b/docs/get-started/Validator-Node.md index 4a30c5c89..c48493e52 100644 --- a/docs/get-started/Validator-Node.md +++ b/docs/get-started/Validator-Node.md @@ -72,7 +72,9 @@ Next, use the output as `` field and the account you created as `iris --pubkey= --address-delegator= --moniker= --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --name= --node=http://localhost:26657 ``` -Please note the **fee** can be the **decimal** of IRIS token, like `0.01iris`. +Please note the **fee** can be the **decimal** of IRIS token, like `0.01iris`. And you could also use other coin-type like `iris-milli` + +To read more about fee mechanism in IRISHub, go to this [doc](../modules/fee-token/Fee.md) In this way, to stake 1IRIS, you need to do: @@ -82,7 +84,6 @@ iriscli stake create-validator --pubkey=pubkey --address-delegator=account --fee ``` Don't forget the `fee` and `gas` field. To read more about coin-type in IRISHub, you should read [this](../zh/modules/coin/README.md) -To read more about fee mechanism in IRISHub, go to this [doc](../modules/fee-token/Fee.md) ### View Validator Info From f0743f97f38a7b8505344867057f8759cc89dca7 Mon Sep 17 00:00:00 2001 From: kidinamoto01 Date: Thu, 8 Nov 2018 00:21:22 +0800 Subject: [PATCH 002/100] IRISHUB-537:edit install (cherry picked from commit e0bfcf2c0436ee345e61038dc939a3a1eadbd959) --- docs/get-started/Install-Iris.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/get-started/Install-Iris.md b/docs/get-started/Install-Iris.md index ea8c0331f..13fbea7a9 100644 --- a/docs/get-started/Install-Iris.md +++ b/docs/get-started/Install-Iris.md @@ -18,7 +18,13 @@ There are two ways to get Iris running on your server. You can download the bina #### Download Binary Directly -Go to the download page: https://github.com/irisnet/irishub/releases/ then get the release v0.5.0 on your computer. + +Go to the download page: + +https://github.com/irisnet/irishub/releases/ + +then get the release v0.6.0 on your computer. + `unzip -C /usr/local/bin iris$VERSION.$OS-$ARCH.zip` to `/usr/local/bin/ ` You can verify you have the right version installed by running the following commands: @@ -91,7 +97,7 @@ Make sure that you can access to google.com for that our project used some libra mkdir -p $GOPATH/src/github.com/irisnet cd $GOPATH/src/github.com/irisnet git clone https://github.com/irisnet/irishub -cd irishub && git checkout v0.5.0 +cd irishub && git checkout v0.6.0 curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh make get_vendor_deps && make install ``` @@ -117,9 +123,4 @@ rm Gopkg.lock git checkout v0.6.0 make get_vendor_deps make install -``` - -## Use BaaS - -* https://irisnet.wancloud.cloud/#/ -* https://baas.zhigui.com/IRISnet \ No newline at end of file +``` \ No newline at end of file From cdd77f74520e83beb894abfc46ae2c8327a10d14 Mon Sep 17 00:00:00 2001 From: kidinamoto01 Date: Thu, 8 Nov 2018 10:48:53 +0800 Subject: [PATCH 003/100] IRISHUB-537:edit install --- docs/get-started/Full-Node.md | 10 +- .../get-started/Genesis-Generation-Process.md | 5 +- docs/get-started/Install-Iris.md | 158 ++++++------------ docs/get-started/README.md | 10 +- docs/get-started/Validator-Node.md | 19 ++- docs/tools/Deploy-IRIS-Monitor.md | 80 ++++----- docs/validators/README.md | 18 +- docs/zh/get-started/Full-Node.md | 14 +- .../get-started/Genesis-Generation-Process.md | 15 +- docs/zh/get-started/Install-Iris.md | 5 +- docs/zh/get-started/Validator-Node.md | 22 ++- docs/zh/tools/Deploy-IRIS-Monitor.md | 69 ++++---- 12 files changed, 187 insertions(+), 238 deletions(-) diff --git a/docs/get-started/Full-Node.md b/docs/get-started/Full-Node.md index 8f69a5489..419a56454 100644 --- a/docs/get-started/Full-Node.md +++ b/docs/get-started/Full-Node.md @@ -27,8 +27,8 @@ After intializing your node, please download the genesis file and the config fil cd $IRISHOME/config/ rm genesis.json rm config.toml -wget https://raw.githubusercontent.com/irisnet/testnets/master/testnets/fuxi-3001/config/config.toml -wget https://raw.githubusercontent.com/irisnet/testnets/master/testnets/fuxi-3001/config/genesis.json +wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/config.toml +wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/genesis.json ``` ## Edit Your Config File @@ -54,8 +54,8 @@ addr_book_strict = false Your node needs to know how to find more peers. You'll need to add healthy seed nodes to `$IRISHOME/config/config.toml`. Here are some seed nodes you can use: ``` -c16700520a810b270206d59f0f02ea9abd85a4fe@35.165.232.141:26656 -a12cfb2f535210ea12731f94a76b691832056156@120.79.226.163:26656 +c16700520a810b270206d59f0f02ea9abd85a4fe@ts-1.bianjie.ai:26656 +a12cfb2f535210ea12731f94a76b691832056156@ts-2.bianjie.ai:26656 ``` Meanwhile, you could add some known full node as `Persistent Peer`. Your node could connect to `sentry node` as `persistent peers`. @@ -82,4 +82,4 @@ You could see the following ``` {"node_info":{"id":"1c40d19d695721fc3e3ce44cbc3f446f038b36e4","listen_addr":"172.31.0.190:46656","network":"iris-stage-4","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:46657"]},"sync_info":{"latest_block_hash":"41117D8CB54FA54EFD8DEAD81D6D83BDCE0E63AC","latest_app_hash":"95D82B8AC8B64C4CD6F85C1D91F999C2D1DA4F0A","latest_block_height":"1517","latest_block_time":"2018-09-07T05:44:27.810641328Z","catching_up":false},"validator_info":{"address":"3FCCECF1A27A9CEBD394F3A0C5253ADAA8392EB7","pub_key":{"type":"tendermint/PubKeyEd25519","value":"wZp1blOEwJu4UuqbEmivzjUMO1UwUK4C0jRH96HhV90="},"voting_power":"100"}} ``` -If you see the `catching_up` is `false`, it means your node is fully synced with the network, otherwise your node is still downloading blocks. Once fully synced, you could upgrade your node to a validator node. The instructions is in [here](Validator-Node.md). +If you see the `catching_up` is `false`, it means your node is fully synced with the network, otherwise your node is still downloading blocks. Once fully synced, you could upgrade your node to a validator node. The instructions is in [here](Validator-Node.md). \ No newline at end of file diff --git a/docs/get-started/Genesis-Generation-Process.md b/docs/get-started/Genesis-Generation-Process.md index 871472e8a..3b8a1ca3f 100644 --- a/docs/get-started/Genesis-Generation-Process.md +++ b/docs/get-started/Genesis-Generation-Process.md @@ -67,9 +67,8 @@ validator is generated by \$IRISHOME/config/priv_validator.json ## Submit Gentx -Submit your `gentx-.json` to `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gen-tx/` by createing a pull request. +Submit your `gentx-.json` to `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gentx/` by createing a pull request. -After the team has collected all the gen-tx transactions, we will publish the genesis file in the following folder: `https://github.com/irisnet/testnets/tree/master/testnets/fuxi-3001/config/` +After the team has collected all the gen-tx transactions, we will publish the genesis file in the following folder: `https://github.com/irisnet/testnets/tree/master/testnets/fuxi-4000/config/` You could then download the final genesis file and start a node. - diff --git a/docs/get-started/Install-Iris.md b/docs/get-started/Install-Iris.md index 13fbea7a9..3b8a1ca3f 100644 --- a/docs/get-started/Install-Iris.md +++ b/docs/get-started/Install-Iris.md @@ -1,126 +1,74 @@ -# Install Iris +# How To Participate in Genesis Process -### Step 1: Configure Your Server +## Requirements -All the blockchains in IRISnet is based on Cosmos-SDK, which is a framework for building blockchain applications in Golang. It is being used to build [Cosmos Hub](https://cosmos.network/). It's recommended to run a validator node on Linux server. +You must have follow this [guide](Install-Iris.md) to install the correct version of **Iris**. -**Recommanded Configurations:** +## Gentx -1. 2 CPU -2. Memory: 4GB -3. Disk: 60GB SSD -4. OS: Ubuntu 16.04 LTS -5. Allow all incoming connections on TCP port 26656 and 26657 +Please run the `gen-tx` command to generate files. -### Step 2: Install Iris - -There are two ways to get Iris running on your server. You can download the binary files from our release pages, or you can download the source code and compile it locally. - -#### Download Binary Directly - - -Go to the download page: - -https://github.com/irisnet/irishub/releases/ - -then get the release v0.6.0 on your computer. - -`unzip -C /usr/local/bin iris$VERSION.$OS-$ARCH.zip` to `/usr/local/bin/ ` - -You can verify you have the right version installed by running the following commands: - -``` -$ iris version -v0.6.0 - -$ iriscli version -v0.6.0 -``` - -#### Compile Source Code - -- Install Go 1.10+ - -``` -$ sudo add-apt-repository ppa:gophers/archive -$ sudo apt-get update -$ sudo apt-get install golang-1.10-go -``` - -> Note that golang-1.10-go puts binaries in /usr/lib/go-1.10/bin. If you want them on your PATH, you need to make that change yourself. - -Using snaps also works quite well: - -``` -This will give you the latest version of go -$ sudo snap install --classic go -``` - -> A restart is required for the command to be recognized. - -Then you need to verify the versions of Go: - -``` -$ go version -go version go1.10.3 darwin/amd64 -``` - -Then, you need to add `GOPATH` to system `PATH` , then your system could correctly compile the code. - -Open your `.profile` in your home directory. Add the following lines at the end of file: ``` -GOPATH=$HOME/go -PATH=$GOPATH/bin:$PATH +iris init gen-tx --name=your_name --home=path_to_home --ip=Your_public_IP ``` -Save the file and exit the editor. Then run the following to make your bash reload your profile configurations. +You could see the following output: ``` -$ source $HOME/.profile +{ + "app_message": { + "secret": "artist green between expand license credit dinner link confirm web tell trip north web crouch february item level crop bullet fancy mixed behind anxiety" + }, + "gen_tx_file": { + "node_id": "b272ea8a29f5b21dfb4587968f22a5612c6b120a", + "ip": "192.168.1.7", + "validator": { + "pub_key": { + "type": "tendermint/PubKeyEd25519", + "value": "0CtwpyEviDneH7uQUL5a+e+cTqJC0sciZSJk21moH8Y=" + }, + "power": "100", + "name": "" + }, + "app_gen_tx": { + "name": "name", + "address": "faa1nnlmkvfmdvn7efwqz7eyur9rszdw723adx2mcx", + "pub_key": "fap1zcjduepq6q4hpfep97yrnhslhwg9p0j6l8hecn4zgtfvwgn9yfjdkkdgrlrqftg82c" + } + } +} ``` -Now you should see something like this if you echo your\$GOPATH and \$PATH variables - -``` -$ echo $GOPATH -/home/iris/go -$ echo $PATH -/home/isir/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin -``` +The `app_message` contains the seed phrase to recover the account of `address` field you just created. +There will be a gentx-node-ID.json a file at `$IRISHOME/config/gentx/`. -- Get the code and compile Iris +The content of the file will be: -After setup Go correctly, you should be able to compile and run **Iris**. -Make sure that you can access to google.com for that our project used some libraries provided by google. ``` -mkdir -p $GOPATH/src/github.com/irisnet -cd $GOPATH/src/github.com/irisnet -git clone https://github.com/irisnet/irishub -cd irishub && git checkout v0.6.0 -curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh -make get_vendor_deps && make install +{ + "node_id": "b272ea8a29f5b21dfb4587968f22a5612c6b120a", + "ip": "192.168.1.7", + "validator": { + "pub_key": { + "type": "tendermint/PubKeyEd25519", + "value": "0CtwpyEviDneH7uQUL5a+e+cTqJC0sciZSJk21moH8Y=" + }, + "power": "100", + "name": "" + }, + "app_gen_tx": { + "name": "name", + "address": "faa1nnlmkvfmdvn7efwqz7eyur9rszdw723adx2mcx", + "pub_key": "fap1zcjduepq6q4hpfep97yrnhslhwg9p0j6l8hecn4zgtfvwgn9yfjdkkdgrlrqftg82c" + } ``` +validator is generated by \$IRISHOME/config/priv_validator.json -If your environment variables have set up correctly, you should not get any errors by running the above commands. -Now check your **Iris** version. +## Submit Gentx -``` -$ iris version -v0.6.0 -$ iriscli version -v0.6.0 -``` +Submit your `gentx-.json` to `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gentx/` by createing a pull request. -### How to Update +After the team has collected all the gen-tx transactions, we will publish the genesis file in the following folder: `https://github.com/irisnet/testnets/tree/master/testnets/fuxi-4000/config/` -Get latest code (you can also `git fetch` only the version desired), ensure the dependencies are up to date, then recompile. - -``` -cd $GOPATH/src/github.com/irisnet/irishub -git fetch -a origin -rm Gopkg.lock -git checkout v0.6.0 -make get_vendor_deps -make install -``` \ No newline at end of file +You could then download the final genesis file and start a node. diff --git a/docs/get-started/README.md b/docs/get-started/README.md index c7a259df6..5ca83a259 100644 --- a/docs/get-started/README.md +++ b/docs/get-started/README.md @@ -37,11 +37,11 @@ If you miss the genesis file generation process, you can still upgrade your full A validator is under the risk of being attacked. You could follow this [guide](../validators/Setup-Sentry-Node.md) to setup a sentry node to protect yourself. ## Fuxi Incentivized Testnet -IRIS foundation plans to reward all the testnet participants who took part in the testnet. In Fuxi-2000 testnet, we invited several Chinese community members to join the incentivized testnet by completing tasks. In summary, 14 people finished the tasks and they will receive their rewards in genesis allocation. -Task List for Fuxi-2000： https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-2000/README.md -Results：https://github.com/irisnet/testnets/issues/51 -To get more people involved, IRIS foundation decides to send out more tasks in the latest iteration of testnet:Fuxi-3001. -Task List for Fuxi-3001: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-3001/README.md +IRIS foundation plans to reward all the testnet participants who took part in the testnet. In Fuxi-3001 testnet,the community members have finished the tasks and they will receive their rewards in genesis allocation. +* Task List for Fuxi-3001： https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-3001/README.md +* Results：https://github.com/irisnet/testnets/issues/125 +To get more people involved, IRIS foundation decides to send out more tasks in the latest iteration of testnet:Fuxi-4001. +* Task List for Fuxi-4000: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-4000/README.md ## Useful Links diff --git a/docs/get-started/Validator-Node.md b/docs/get-started/Validator-Node.md index c48493e52..f079481aa 100644 --- a/docs/get-started/Validator-Node.md +++ b/docs/get-started/Validator-Node.md @@ -55,7 +55,9 @@ iriscli status --node=tcp://localhost:26657 You should also be able to see `catching_up` is `false`. -You need to get the public key of your node before upgrade your node to a validator node. The public key of your node starts with `fvp`, it can be used to create a new validator by staking tokens. To understand more about the address encoding in IRISHub, please read this [doc](Bech32-on-IRISnet.md) +You need to get the public key of your node before upgrade your node to a validator node. The public key of your node starts with `fvp`, +it can be used to create a new validator by staking tokens. To understand more about the address encoding in IRISHub, +please read this [doc](Bech32-on-IRISnet.md) You can find your validator's pubkey by running: @@ -66,11 +68,11 @@ Example output: ``` fvp1zcjduepqv7z2kgussh7ufe8e0prupwcm7l9jcn2fp90yeupaszmqjk73rjxq8yzw85 ``` -Next, use the output as `` field and the account you created as `` field for `iriscli stake create-validator` command: +Next, use the output as `` field for `iriscli stake create-validator` command: ``` -iriscli stake create-validator --amount=iris --pubkey= --address-delegator= --moniker= --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --name= --node=http://localhost:26657 +iriscli stake create-validator --amount=XXiris --pubkey= --moniker= --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --node=http://localhost:26657 ``` Please note the **fee** can be the **decimal** of IRIS token, like `0.01iris`. And you could also use other coin-type like `iris-milli` @@ -80,7 +82,7 @@ To read more about fee mechanism in IRISHub, go to this [doc](../modules/fee-tok In this way, to stake 1IRIS, you need to do: ``` -iriscli stake create-validator --pubkey=pubkey --address-delegator=account --fee=0.05iris --gas=2000000 --from= --chain-id=fuxi-4000 --node=tcp://localhost:26657 --amount=1iris +iriscli stake create-validator --pubkey=pubkey --fee=0.05iris --gas=2000000 --from= --chain-id=fuxi-4000 --node=tcp://localhost:26657 --amount=1iris ``` Don't forget the `fee` and `gas` field. To read more about coin-type in IRISHub, you should read [this](../zh/modules/coin/README.md) @@ -91,10 +93,10 @@ Don't forget the `fee` and `gas` field. To read more about coin-type in IRISHub View the validator's information with this command: ``` -iriscli stake validator --chain-id=fuxi-4000 --node=tcp://localhost:26657 +iriscli stake validator --chain-id=fuxi-4000 --node=tcp://localhost:26657 ``` -The `` is your account address that starts with 'faa' +The `` is your account address that starts with 'faa1' ### Confirm Your Validator is Running @@ -115,8 +117,8 @@ You can edit your validator's public description. This info is to identify your You should put your name of your team in `details`. ``` -iriscli stake edit-validator --address-delegator=account --moniker="choose a moniker" --website="https://irisnet.org" --details="team" --chain-id=fuxi-4000 - --name=key_name --node=tcp://localhost:26657 --fee=0.04iris --gas=2000000 +iriscli stake edit-validator --from= < name > --moniker="choose a moniker" --website="https://irisnet.org" --details="team" --chain-id=fuxi-4000 + --details="details"--node=tcp://localhost:26657 --fee=0.04iris --gas=2000000 ``` ### View Validator Description @@ -129,4 +131,3 @@ iriscli stake validator --chain-id=fuxi-4000 ### Use IRISPlorer You should also be able to see your validator on the [Explorer](https://testnet.irisplorer.io). You are looking for the `bech32` encoded `address` in the `~/.iris/config/priv_validator.json` file. - diff --git a/docs/tools/Deploy-IRIS-Monitor.md b/docs/tools/Deploy-IRIS-Monitor.md index 939a69f89..a2f598566 100644 --- a/docs/tools/Deploy-IRIS-Monitor.md +++ b/docs/tools/Deploy-IRIS-Monitor.md @@ -2,67 +2,61 @@ Please make sure that iris is installed in your computer and added to $PATH.You can see this page for insturcion https://github.com/irisnet/irishub. You also need /bin/bash, wc, ps to ensure the monitor work properly. -1. Download the monitoring tools +### Get Monitor Info + +* Address of validator + ``` -wget https://raw.githubusercontent.com/programokey/monitor/master/monitor.tar.gz +-a= < hex-encoded-address-of-validator > ``` -2. Uncompress the monitoring tools: +* Chain-ID ``` -tar -xzvf monitor.tar.gz +--chain-id= < id-of-blockchain > ``` -3. Edit the running parameters +* Node + ``` -cd monitor -vim start.sh +--node= < localhost:26657 > ``` - -4. Edit the third command in `start.sh` - -You could get hex encoded validator address by running: +### Start IRIS Monitor +Example: ``` -iriscli status +irismon --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --chain-id=irishub-stage --node=http://localhost:26657& ``` -It corresponds to `validator_info.address` field. +then, you can visit http://localhost:3660/ to see the metrics page. -modify -``` --a=378E63271D5BE927443E17CBAAFE68DEFF383DA7 -``` +### Start Prometheus -to -``` --a= -``` +First, you need to edit the configuration file of prometheus. Add `jobs` : +```$xslt +- job_name: fuxi-4000 -modify -``` ---chain-id=fuxi-3001 -``` -to -``` ---chain-id= -``` -modify -``` ---node="tcp://localhost:26657" -``` -to -``` ---node= -``` -5. start the monitoring tools + static_configs: + + - targets: ['localhost:36660'] + + labels: + + instance: fuxi-4000 ``` -./start.sh +Then, you could see in your browser that there are some data available at port 36660. + +### Start Grafana + +You could start grafana with docker by running: +```$xslt +sudo docker run -p 3000:3000 grafana/grafana 1>grafana.log 2>grafana.error & ``` -then, you can visit http://localhost:3000/ to see the grafana monitoring page. The default username and password are both admin. We strongly recommend immediately changing your username & password after login. -Click the Home button, and open the IRIS HUB. Then you can see all the monitoring parameters. +The default username and password are both admin. We strongly recommend immediately changing your username & password after login. + +Then you could create your own dashboard. -6. stop the monitor +### Stop IRIS Monitor ``` -./stop.sh +kill -9 ``` \ No newline at end of file diff --git a/docs/validators/README.md b/docs/validators/README.md index 6133655f5..cb4952187 100644 --- a/docs/validators/README.md +++ b/docs/validators/README.md @@ -87,9 +87,9 @@ fvp1zcjduepqcxd82mjnsnqfhwzja2d3y690ec6scw64xpg2uqkjx3rl0g0p2lwsprxnnf In summary, an example of the `create-validator` command to bond 10IRIS is the following: ``` -iriscli stake create-validator --address-delegator={address1} --address-validator={address1} --name={name} --chain-id=fuxi-3001 --from=name --pubkey={pubkey} --gas=2000000 --fee=40000000000000000iris --amount=10000000000000000000iris +iriscli stake create-validator --pubkey=pub-key --amount=XXiris --fee=0.05iris --gas=2000000 --node=tcp://localhost:26657 --chain-id=fuxi-4000 --from=name --moniker=name ``` -* Edit Validator Information +### Edit Validator Information Validators could edit its information. @@ -102,28 +102,28 @@ The following parameters are optional: The command is the following: ```$xslt -iriscli stake edit-validator --address-validator={address-validator} --chain-id=fuxi-3001 --from=name --details=details --gas=2000000 --fee=40000000000000000iris +iriscli stake edit-validator --chain-id=fuxi-4000 --from=name --details=details --gas=2000000 --fee=0.04iris ``` For each validator, the voting power is the sum of self-bonded token and delegated tokens. -* View Validator Description +### View Validator Description Anyone can view certain validator's information with the following command: ```$xslt -iriscli stake validator --address-validator={address-validator} --chain-id=fuxi-3001 +iriscli stake validator --address-validator={address-validator} --chain-id=fuxi-4000 ``` -* Track Validator Signing Information +### Track Validator Signing Information In order to keep track of a validator's signatures in the past you can do so by using the signing-info command: The command is the following: ``` -iriscli stake signing-information --chain-id=fuxi-3001 +iriscli stake signing-information --chain-id=fuxi-4000 ``` -* Unrevoke Validator +### Unrevoke Validator When a validator is Revoked for downtime, you must submit an Unrevoke transaction in order to be able to get block rewards again. In fuxi-3001, if your node missed the previous 5000 blocks in the last 10000 blocks, you will get revoked. To query your validator's info: @@ -150,5 +150,5 @@ The `Revoked` field of an offline validator will be `true`. To unrevoke your validator node, the command is the following: ``` -iriscli stake unrevoke {address-validator} --from=name --chain-id=fuxi-3001 +iriscli stake unrevoke --from=name --chain-id=fuxi-4000 ``` \ No newline at end of file diff --git a/docs/zh/get-started/Full-Node.md b/docs/zh/get-started/Full-Node.md index ad9e52021..be996147c 100644 --- a/docs/zh/get-started/Full-Node.md +++ b/docs/zh/get-started/Full-Node.md @@ -17,16 +17,16 @@ genesis文件中定义了区块链网络的初始状态，而config.toml指定 ``` cd $IRISHOME/config/ -wget https://raw.githubusercontent.com/irisnet/testnets/master/testnets/fuxi-4000/config/config.toml -wget https://raw.githubusercontent.com/irisnet/testnets/master/testnets/fuxi-4000/config/genesis.json +wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/config.toml +wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/genesis.json ``` ### 修改配置文件 在config.toml文件中可以配置以下信息： * 将`moniker`字段配置称为自定义的名称，这样便于区分不同的节点 * `seed`字段用语设置种子节点，在fuxi-4000中的官方中字节点为： ``` -c16700520a810b270206d59f0f02ea9abd85a4fe@35.165.232.141:26656 -a12cfb2f535210ea12731f94a76b691832056156@120.79.226.163:26656 +c16700520a810b270206d59f0f02ea9abd85a4fe@ts-1.bianjie.ai:26656 +a12cfb2f535210ea12731f94a76b691832056156@ts-2.bianjie.ai:26656 ``` 你也可以配置 `moniker` 和 `external_address` 字段. @@ -56,7 +56,7 @@ iriscli status ``` 示例输出： ```json -{"node_info":{"id":"3fb472c641078eaaee4a4acbe32841f18967672c","listen_addr":"172.31.0.190:26656","network":"fuxi-3001","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:26657"]},"sync_info":{"latest_block_hash":"7B1168B2055B19F811773EEE56BB3C9ECB6F3B37","latest_app_hash":"B8F7F8BF18E3F1829CCDE26897DB905A51AF4372","latest_block_height":12567,"latest_block_time":"2018-08-25T11:33:13.164432273Z","catching_up":false},"validator_info":{"address":"CAF80DAEC0F4A7036DD2116B56F89B07F43A133E","pub_key":{"type":"AC26791624DE60","value":"Cl6Yq+gqZZY14QxrguOaZqAswPhluv7bDfcyQx2uSRc="},"voting_power":0}} +{"node_info":{"id":"3fb472c641078eaaee4a4acbe32841f18967672c","listen_addr":"172.31.0.190:26656","network":"fuxi-4000","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:26657"]},"sync_info":{"latest_block_hash":"7B1168B2055B19F811773EEE56BB3C9ECB6F3B37","latest_app_hash":"B8F7F8BF18E3F1829CCDE26897DB905A51AF4372","latest_block_height":12567,"latest_block_time":"2018-08-25T11:33:13.164432273Z","catching_up":false},"validator_info":{"address":"CAF80DAEC0F4A7036DD2116B56F89B07F43A133E","pub_key":{"type":"AC26791624DE60","value":"Cl6Yq+gqZZY14QxrguOaZqAswPhluv7bDfcyQx2uSRc="},"voting_power":0}} ``` 通过以上命令可以查看状态： @@ -99,10 +99,10 @@ iriscli status ``` 示例输出： ```json -{"node_info":{"id":"3fb472c641078eaaee4a4acbe32841f18967672c","listen_addr":"172.31.0.190:26656","network":"fuxi-3001","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:26657"]},"sync_info":{"latest_block_hash":"7B1168B2055B19F811773EEE56BB3C9ECB6F3B37","latest_app_hash":"B8F7F8BF18E3F1829CCDE26897DB905A51AF4372","latest_block_height":12567,"latest_block_time":"2018-08-25T11:33:13.164432273Z","catching_up":false},"validator_info":{"address":"CAF80DAEC0F4A7036DD2116B56F89B07F43A133E","pub_key":{"type":"AC26791624DE60","value":"Cl6Yq+gqZZY14QxrguOaZqAswPhluv7bDfcyQx2uSRc="},"voting_power":100}} +{"node_info":{"id":"3fb472c641078eaaee4a4acbe32841f18967672c","listen_addr":"172.31.0.190:26656","network":"fuxi-4000","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:26657"]},"sync_info":{"latest_block_hash":"7B1168B2055B19F811773EEE56BB3C9ECB6F3B37","latest_app_hash":"B8F7F8BF18E3F1829CCDE26897DB905A51AF4372","latest_block_height":12567,"latest_block_time":"2018-08-25T11:33:13.164432273Z","catching_up":false},"validator_info":{"address":"CAF80DAEC0F4A7036DD2116B56F89B07F43A133E","pub_key":{"type":"AC26791624DE60","value":"Cl6Yq+gqZZY14QxrguOaZqAswPhluv7bDfcyQx2uSRc="},"voting_power":100}} ``` 通过以上命令可以查看状态： * `"catching_up":false`: 表示节点与网络保持同步 -* `"latest_block_height"`: 表示最新的区块高度 +* `"latest_block_height"`: 表示最新的区块高度 \ No newline at end of file diff --git a/docs/zh/get-started/Genesis-Generation-Process.md b/docs/zh/get-started/Genesis-Generation-Process.md index 15822c57d..500b95d3b 100644 --- a/docs/zh/get-started/Genesis-Generation-Process.md +++ b/docs/zh/get-started/Genesis-Generation-Process.md @@ -1,16 +1,16 @@ -# 参与到Genesis文件生成流程中 +# 参与Genesis文件生成 -1. 每个希望成为验证人的参与者确保安装了对应版本的软件：iris v0.4.2 +1. 每个希望成为验证人的参与者确保请根据一下[教程](Install-Iris.md) 在服务器上完成**Iris**的安装。 2. 执行gentx命令，获得一个node-id.json的文件。这个操作将默认生成一个余额为200IRIS的账户，该账户默认绑定100IRIS成为一个验证人候选人。 ``` - iris init gen-tx --name=your_name --home= --ip=Your_public_IP +iris init gen-tx --name=your_name --home= --ip=Your_public_IP ``` - 代码示例： +* 代码示例： ``` - iris init gen-tx --name=alice +iris init gen-tx --name=alice ``` ``` @@ -64,8 +64,7 @@ validator字段对应了home/config下的节点信息 3. 将上述提到的json文件以提交Pull Request的形式上传到`https://github.com/irisnet/testnets/tree/master/testnets/fuxi-4000/config/gentx`目录下： - 注意⚠️：json文中的IP改成公网IP - - +> 注意:json文中的IP改成公网IP +4. 在收集完参与者的gentx文件后，团队将在一下目录公布fuxi-4000测试网的配置文件：`https://github.com/irisnet/testnets/tree/master/testnets/fuxi-4000/config`。然后你就可以下载genesis.json和config.toml文件了。 diff --git a/docs/zh/get-started/Install-Iris.md b/docs/zh/get-started/Install-Iris.md index da19bcca7..5ee496b9d 100644 --- a/docs/zh/get-started/Install-Iris.md +++ b/docs/zh/get-started/Install-Iris.md @@ -90,7 +90,7 @@ cd $GOPATH/src/github.com/irisnet git clone https://github.com/irisnet/irishub cd irishub && git checkout v0.5.0 curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh -make get_vendor_deps && make install +make get_tools && get_vendor_deps && make install ``` 以上命令将完成 iris 和 iriscli的安装. 若出现对应的版本号则说明安装成功。 @@ -104,13 +104,14 @@ v0.6.0 ``` ### 如何升级IRISHub -通过执行一下命令可以完成IRISHub从v0.3.4到v0.4.2的升级 +通过执行一下命令可以完成IRISHub从v0.4.2到v0.6.0的升级 ``` cd $GOPATH/src/github.com/irisnet/irishub git fetch -a origin rm Gopkg.lock git checkout v0.6.0 +make get_tools make get_vendor_deps make install ``` \ No newline at end of file diff --git a/docs/zh/get-started/Validator-Node.md b/docs/zh/get-started/Validator-Node.md index dc913281c..f837b7291 100644 --- a/docs/zh/get-started/Validator-Node.md +++ b/docs/zh/get-started/Validator-Node.md @@ -37,7 +37,7 @@ iriscli keys add --recover ### Claim tokens -一旦你完成了账户的创建，你可以通过[水龙头](https://testnet.irisplorer.io/#/faucet)获得用于测试网的IRIS token。ese tokens to stake as a validator. +一旦你完成了账户的创建，你可以通过[水龙头](https://testnet.irisplorer.io/#/faucet)获得用于测试网的IRIS token,然后你就可以将这部分IRIS用于绑定成为验证人。 水龙头每次将发送10IRIS，请按需使用！ 以下命令将查询你的账户的余额： @@ -61,7 +61,7 @@ iriscli status --node=tcp://localhost:26657 通过执行以下命令获得节点的公钥信息，公钥信息将以`fvp1`开头： ``` -iris tendermint show_validator --home= +iris tendermint show_validator --home= < IRIS-HOME > ``` 示例输出: ``` @@ -70,14 +70,14 @@ fvp1zcjduepqv7z2kgussh7ufe8e0prupwcm7l9jcn2fp90yeupaszmqjk73rjxq8yzw85 然后，使用以上输出作为`iriscli stake create-validator`命令的 `` 字段： ``` -iriscli stake create-validator --amount=iris --pubkey= --address-delegator= --moniker= --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --name= --node=http://localhost:26657 +iriscli stake create-validator --from= < name > --amount= < amount >iris --pubkey= < pubkey > --moniker= < moniker > --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --node=http://localhost:26657 ``` > 注意：**amount** 应为整数， **Fee** 字段可以使用小数，例如`0。01iris` 。 也就是说，如果你想要抵押1IRIS,你可以执行以下操作： ``` -iriscli stake create-validator --pubkey=pubkey --address-delegator= --fee=0.04iris --gas=2000000 --from= --chain-id=fuxi-4000 --node=tcp://localhost:26657 --amount=1iris +iriscli stake create-validator --pubkey=pubkey --fee=0.04iris --gas=2000000 --from= < name > --chain-id=fuxi-4000 --node=tcp://localhost:26657 --amount=1iris ``` ### 查询验证人信息 @@ -85,7 +85,7 @@ iriscli stake create-validator --pubkey=pubkey --address-delegator= --f 你可以通过以下命令查询验证人的信息： ``` -iriscli stake validator --chain-id=fuxi-4000 --node=tcp://localhost:26657 +iriscli stake validator < address-validator-operator > --chain-id=fuxi-4000 --node=tcp://localhost:26657 ``` 请注意 `` 字段是以`faa1`为首字母。 @@ -107,17 +107,21 @@ iriscli status --node=tcp://localhost:26657 你应该在`details`字段注明自定义的信息。 ``` -iriscli stake edit-validator --address-delegator=account --moniker="choose a moniker" --website="https://irisnet.org" --details="team" --chain-id=fuxi-4000 - --name=key_name --node=tcp://localhost:26657 --fee=0.04iris --gas=2000000 +iriscli stake edit-validator --from= < name > --moniker="choose a moniker" --website="https://irisnet.org" --details="team" --chain-id=fuxi-4000 + --details="details"--node=tcp://localhost:26657 --fee=0.04iris --gas=2000000 ``` ### 查询验证人信息 你可以通过以下命令查询验证人的信息： ``` -iriscli stake validator --chain-id=fuxi-4000 +iriscli stake validator < address-validator-operator > --chain-id=fuxi-4000 ``` ### 使用浏览器：IRISPlorer -你可以通过[浏览器](https://testnet.irisplorer.io)确认验证人节点的运行状况。 \ No newline at end of file +你可以通过[浏览器](https://testnet.irisplorer.io)确认验证人节点的运行状况。 + +### 部署IRISHub Monitor监控 + +请根据以下[链接](../tools/Deploy-IRIS-Monitor.md) 部署一个Monitor监控验证人。 diff --git a/docs/zh/tools/Deploy-IRIS-Monitor.md b/docs/zh/tools/Deploy-IRIS-Monitor.md index be0d5395f..7e1c7cd2a 100644 --- a/docs/zh/tools/Deploy-IRIS-Monitor.md +++ b/docs/zh/tools/Deploy-IRIS-Monitor.md @@ -2,58 +2,61 @@ 确保已经安装了iris等工具，系统中需要有/bin/bash、wc、ps等命令。 你可以参考这个页面来安装iris工具:https://github.com/irisnet/irishub -1. 下载打包好的监控工具。 -``` -wget https://raw.githubusercontent.com/programokey/monitor/master/monitor.tar.gz -``` +## 获得修改运行参数 -2. 解压监控工具包 +* 验证人地址的hex编码 ``` -tar -xzvf monitor.tar.gz +-a=<你的验证人地址的hex编码> ``` -3. 修改运行参数 +* 确定Chain-ID ``` -cd monitor -vim start.sh +--chain-id=<你要监控的网络的ID> ``` -将第三条命令中的 +* 确定监控的节点 -``` --a=378E63271D5BE927443E17CBAAFE68DEFF383DA7 -``` -修改为 -``` --a=<你的验证人地址的hex编码> -``` ``` ---chain-id=fuxi-test -``` -修改为 -``` ---chain-id=<你要监控的网络的ID> +--node=<你要监控的节点监听的rpc端口(默认为26657)> ``` +## 启动IRIS Monitor + ``` ---node="tcp://localhost:26657" -``` -修改为 -``` ---node=<你要监控的节点监听的rpc端口(默认为26657)> +irismon --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --chain-id=irishub-stage --node=http://localhost:36657& ``` -4. 启动监控工具 + +### 启动Prometheus + +在配置文件中添加 `jobs` : +```$xslt + - job_name: fuxi-4000 + + static_configs: + + - targets: ['localhost:36660'] + + labels: + + instance: fuxi-4000 ``` -./start.sh + +启动Prometheus后可以在本地36660端口看到监控数据。 + +### 启动Grafana + +通过Docker启动Grafana +```$xslt +sudo docker run -p 3000:3000 grafana/grafana 1>grafana.log 2>grafana.error & ``` + 接下来就可以访问localhost:3000来查看grafana监控。打开网页后使用默认用户名admin，默认密码admin登录。建议登录之后立即修改密码。 -点击Home按钮，然后在general栏中打开IRIS HUB即可看到监控项。 5. 关闭监控 -``` -./stop.sh -``` +```$xslt +killl -9 +``` \ No newline at end of file From 82a65745433147445f1d8df09afda892252a6a12 Mon Sep 17 00:00:00 2001 From: kidinamoto01 Date: Thu, 8 Nov 2018 10:50:46 +0800 Subject: [PATCH 004/100] IRISHUB-537:edit install --- docs/get-started/Install-Iris.md | 156 ++++++++++++++++++++----------- 1 file changed, 103 insertions(+), 53 deletions(-) diff --git a/docs/get-started/Install-Iris.md b/docs/get-started/Install-Iris.md index 3b8a1ca3f..4e80d1861 100644 --- a/docs/get-started/Install-Iris.md +++ b/docs/get-started/Install-Iris.md @@ -1,74 +1,124 @@ -# How To Participate in Genesis Process +# Install Iris -## Requirements +### Step 1: Configure Your Server -You must have follow this [guide](Install-Iris.md) to install the correct version of **Iris**. +All the blockchains in IRISnet is based on Cosmos-SDK, which is a framework for building blockchain applications in Golang. It is being used to build [Cosmos Hub](https://cosmos.network/). It's recommended to run a validator node on Linux server. -## Gentx +**Recommanded Configurations:** -Please run the `gen-tx` command to generate files. +1. 2 CPU +2. Memory: 4GB +3. Disk: 60GB SSD +4. OS: Ubuntu 16.04 LTS +5. Allow all incoming connections on TCP port 26656 and 26657 +### Step 2: Install Iris + +There are two ways to get Iris running on your server. You can download the binary files from our release pages, or you can download the source code and compile it locally. + +#### Download Binary Directly + +Go to the download page: + +https://github.com/irisnet/irishub/releases/ + +then get the release v0.6.0 on your computer. +`unzip -C /usr/local/bin iris$VERSION.$OS-$ARCH.zip` to `/usr/local/bin/ ` + +You can verify you have the right version installed by running the following commands: + +``` +$ iris version +v0.6.0 + +$ iriscli version +v0.6.0 +``` + +#### Compile Source Code + +- Install Go 1.10+ + +``` +$ sudo add-apt-repository ppa:gophers/archive +$ sudo apt-get update +$ sudo apt-get install golang-1.10-go +``` + +> Note that golang-1.10-go puts binaries in /usr/lib/go-1.10/bin. If you want them on your PATH, you need to make that change yourself. + +Using snaps also works quite well: ``` -iris init gen-tx --name=your_name --home=path_to_home --ip=Your_public_IP +This will give you the latest version of go +$ sudo snap install --classic go ``` -You could see the following output: +> A restart is required for the command to be recognized. + +Then you need to verify the versions of Go: ``` -{ - "app_message": { - "secret": "artist green between expand license credit dinner link confirm web tell trip north web crouch february item level crop bullet fancy mixed behind anxiety" - }, - "gen_tx_file": { - "node_id": "b272ea8a29f5b21dfb4587968f22a5612c6b120a", - "ip": "192.168.1.7", - "validator": { - "pub_key": { - "type": "tendermint/PubKeyEd25519", - "value": "0CtwpyEviDneH7uQUL5a+e+cTqJC0sciZSJk21moH8Y=" - }, - "power": "100", - "name": "" - }, - "app_gen_tx": { - "name": "name", - "address": "faa1nnlmkvfmdvn7efwqz7eyur9rszdw723adx2mcx", - "pub_key": "fap1zcjduepq6q4hpfep97yrnhslhwg9p0j6l8hecn4zgtfvwgn9yfjdkkdgrlrqftg82c" - } - } -} +$ go version +go version go1.10.3 darwin/amd64 ``` -The `app_message` contains the seed phrase to recover the account of `address` field you just created. -There will be a gentx-node-ID.json a file at `$IRISHOME/config/gentx/`. +Then, you need to add `GOPATH` to system `PATH` , then your system could correctly compile the code. -The content of the file will be: +Open your `.profile` in your home directory. Add the following lines at the end of file: ``` -{ - "node_id": "b272ea8a29f5b21dfb4587968f22a5612c6b120a", - "ip": "192.168.1.7", - "validator": { - "pub_key": { - "type": "tendermint/PubKeyEd25519", - "value": "0CtwpyEviDneH7uQUL5a+e+cTqJC0sciZSJk21moH8Y=" - }, - "power": "100", - "name": "" - }, - "app_gen_tx": { - "name": "name", - "address": "faa1nnlmkvfmdvn7efwqz7eyur9rszdw723adx2mcx", - "pub_key": "fap1zcjduepq6q4hpfep97yrnhslhwg9p0j6l8hecn4zgtfvwgn9yfjdkkdgrlrqftg82c" - } +GOPATH=$HOME/go +PATH=$GOPATH/bin:$PATH ``` -validator is generated by \$IRISHOME/config/priv_validator.json -## Submit Gentx +Save the file and exit the editor. Then run the following to make your bash reload your profile configurations. -Submit your `gentx-.json` to `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gentx/` by createing a pull request. +``` +$ source $HOME/.profile +``` -After the team has collected all the gen-tx transactions, we will publish the genesis file in the following folder: `https://github.com/irisnet/testnets/tree/master/testnets/fuxi-4000/config/` +Now you should see something like this if you echo your\$GOPATH and \$PATH variables -You could then download the final genesis file and start a node. +``` +$ echo $GOPATH +/home/iris/go +$ echo $PATH +/home/isir/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin +``` + +- Get the code and compile Iris + +After setup Go correctly, you should be able to compile and run **Iris**. +Make sure that you can access to google.com for that our project used some libraries provided by google. +``` +mkdir -p $GOPATH/src/github.com/irisnet +cd $GOPATH/src/github.com/irisnet +git clone https://github.com/irisnet/irishub +cd irishub && git checkout v0.6.0 +curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh +make get_tools && get_vendor_deps && make install +``` + +If your environment variables have set up correctly, you should not get any errors by running the above commands. +Now check your **Iris** version. + +``` +$ iris version +v0.6.0 +$ iriscli version +v0.6.0 +``` + +### How to Update + +Get latest code (you can also `git fetch` only the version desired), ensure the dependencies are up to date, then recompile. + +``` +cd $GOPATH/src/github.com/irisnet/irishub +git fetch -a origin +rm Gopkg.lock +git checkout v0.6.0 +make get_vendor_deps +make install +``` \ No newline at end of file From 023892d0a4f0b46ec57e923a21a067f43c5d6c48 Mon Sep 17 00:00:00 2001 From: kidinamoto01 Date: Thu, 8 Nov 2018 10:53:12 +0800 Subject: [PATCH 005/100] IRISHUB-537:edit install --- docs/get-started/Genesis-Generation-Process.md | 2 +- docs/zh/get-started/Genesis-Generation-Process.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/get-started/Genesis-Generation-Process.md b/docs/get-started/Genesis-Generation-Process.md index 3b8a1ca3f..9cf6282d1 100644 --- a/docs/get-started/Genesis-Generation-Process.md +++ b/docs/get-started/Genesis-Generation-Process.md @@ -69,6 +69,6 @@ validator is generated by \$IRISHOME/config/priv_validator.json Submit your `gentx-.json` to `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gentx/` by createing a pull request. -After the team has collected all the gen-tx transactions, we will publish the genesis file in the following folder: `https://github.com/irisnet/testnets/tree/master/testnets/fuxi-4000/config/` +After the team has collected all the gen-tx transactions, we will publish the genesis file in the following folder: `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/` You could then download the final genesis file and start a node. diff --git a/docs/zh/get-started/Genesis-Generation-Process.md b/docs/zh/get-started/Genesis-Generation-Process.md index 500b95d3b..367a75e74 100644 --- a/docs/zh/get-started/Genesis-Generation-Process.md +++ b/docs/zh/get-started/Genesis-Generation-Process.md @@ -62,9 +62,9 @@ validator字段对应了home/config下的节点信息 `app_gen_tx`中说明了拥有这个节点的账户信息。这个账户的助记词就是刚刚的secret -3. 将上述提到的json文件以提交Pull Request的形式上传到`https://github.com/irisnet/testnets/tree/master/testnets/fuxi-4000/config/gentx`目录下： +3. 将上述提到的json文件以提交Pull Request的形式上传到`https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gentx`目录下： > 注意:json文中的IP改成公网IP -4. 在收集完参与者的gentx文件后，团队将在一下目录公布fuxi-4000测试网的配置文件：`https://github.com/irisnet/testnets/tree/master/testnets/fuxi-4000/config`。然后你就可以下载genesis.json和config.toml文件了。 +4. 在收集完参与者的gentx文件后，团队将在一下目录公布fuxi-4000测试网的配置文件：`https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config`。然后你就可以下载genesis.json和config.toml文件了。 From ac2fb8eb6c8cb693e858a1e1cb80493d0db72c36 Mon Sep 17 00:00:00 2001 From: kidinamoto01 Date: Thu, 8 Nov 2018 17:24:40 +0800 Subject: [PATCH 006/100] IRISHUB-537:edit version --- docs/zh/get-started/Install-Iris.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh/get-started/Install-Iris.md b/docs/zh/get-started/Install-Iris.md index 5ee496b9d..a1a5f0306 100644 --- a/docs/zh/get-started/Install-Iris.md +++ b/docs/zh/get-started/Install-Iris.md @@ -88,7 +88,7 @@ source ~/.bash_profile mkdir -p $GOPATH/src/github.com/irisnet cd $GOPATH/src/github.com/irisnet git clone https://github.com/irisnet/irishub -cd irishub && git checkout v0.5.0 +cd irishub && git checkout v0.6.0 curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh make get_tools && get_vendor_deps && make install ``` From 00f5e1f40ccf9fcc547f59e222fb090ca6a8c02d Mon Sep 17 00:00:00 2001 From: zhangyelong Date: Sun, 11 Nov 2018 12:49:02 +0800 Subject: [PATCH 007/100] Refactor docs --- docs/cli-client/README.md | 0 docs/cli-client/keys/README.md | 30 ++ docs/cli-client/keys/add.md | 69 +++++ docs/features/bank.md | 0 docs/features/distribution.md | 0 docs/features/governance.md | 260 ++++++++++++++++++ docs/features/iservice/README.md | 168 +++++++++++ docs/features/iservice/test.proto | 21 ++ docs/features/keys/README.md | 30 ++ docs/features/keys/add.md | 69 +++++ docs/features/record.md | 85 ++++++ docs/features/stake.md | 94 +++++++ docs/features/upgrade.md | 113 ++++++++ docs/light-client/README.md | 0 docs/resources/README.md | 0 docs/software/basic-concepts/bech32-prefix.md | 0 .../basic-concepts/key-types/coin-type.md | 111 ++++++++ docs/software/basic-concepts/key-types/fee.md | 23 ++ .../basic-concepts/key-types/genesis.md | 0 .../basic-concepts/key-types/gov-params.md | 0 .../basic-concepts/key-types/inflation.md | 0 docs/software/cli-client.md | 0 docs/software/light-client.md | 0 docs/software/monitor.md | 0 docs/software/node.md | 0 25 files changed, 1073 insertions(+) create mode 100644 docs/cli-client/README.md create mode 100644 docs/cli-client/keys/README.md create mode 100644 docs/cli-client/keys/add.md create mode 100644 docs/features/bank.md create mode 100644 docs/features/distribution.md create mode 100644 docs/features/governance.md create mode 100644 docs/features/iservice/README.md create mode 100644 docs/features/iservice/test.proto create mode 100644 docs/features/keys/README.md create mode 100644 docs/features/keys/add.md create mode 100644 docs/features/record.md create mode 100644 docs/features/stake.md create mode 100644 docs/features/upgrade.md create mode 100644 docs/light-client/README.md create mode 100644 docs/resources/README.md create mode 100644 docs/software/basic-concepts/bech32-prefix.md create mode 100644 docs/software/basic-concepts/key-types/coin-type.md create mode 100644 docs/software/basic-concepts/key-types/fee.md create mode 100644 docs/software/basic-concepts/key-types/genesis.md create mode 100644 docs/software/basic-concepts/key-types/gov-params.md create mode 100644 docs/software/basic-concepts/key-types/inflation.md create mode 100644 docs/software/cli-client.md create mode 100644 docs/software/light-client.md create mode 100644 docs/software/monitor.md create mode 100644 docs/software/node.md diff --git a/docs/cli-client/README.md b/docs/cli-client/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/cli-client/keys/README.md b/docs/cli-client/keys/README.md new file mode 100644 index 000000000..410208962 --- /dev/null +++ b/docs/cli-client/keys/README.md @@ -0,0 +1,30 @@ +# iriscli keys + +## Description + +Keys allows you to manage your local keystore for tendermint. + +## Usage + +```shell +iriscli keys [command] +``` + +## Available Commands + +| Name | Description | +| ------------- | ------------------------------------- | +| [add](add.md) | Create a new key, or import from seed | +| list | List all keys | +| show | Show key info for the given name | +| delete | Delete the given key | + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | ------- | ------------- | -------- | +| --help, -h | | help for keys | | + +## Extended description + +These keys may be in any format supported by go-crypto and can be used by light-clients, full nodes, or any other application that needs to sign with a private key. diff --git a/docs/cli-client/keys/add.md b/docs/cli-client/keys/add.md new file mode 100644 index 000000000..2174b8c7c --- /dev/null +++ b/docs/cli-client/keys/add.md @@ -0,0 +1,69 @@ +# iriscli keys add + +## Description + +Create a new key, or import from seed + +## Usage + +``` +iriscli keys add [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --account | | [uint32] Account number for HD derivation | | +| --dry-run | | Perform action, but don't add key to local keystore | | +| --help, -h | | help for add | | +| --index | | [uint32] Index number for HD derivation | | +| --ledger | | Store a local reference to a private key on a Ledger device | | +| --no-backup | | Don't print out seed phrase (if others are watching the terminal) | | +| --recover | | Provide seed phrase to recover existing key instead of creating | | +| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | + +## Examples + +### Create a new key + +```shell +iriscli keys add MyKey +``` + +You'll be asked to enter a password for your key, note: password must be at least 8 characters. + +```txt +Enter a passphrase for your key: +Repeat the passphrase: +``` + +After that, you're done with creating a new key, but remember to backup your seed phrase, it is the only way to recover your account if you ever forget your password or lose your key. + +```txt +NAME: TYPE: ADDRESS: PUBKEY: +MyKey local faa1mmsm487rqkgktl2qgrjad0z3yaf9n8t5pkp33m fap1addwnpepq2g0u7cnxp5ew0yhqep8j4rth5ugq8ky7gjmunk8tkpze95ss23ak4svkjq +**Important** write this seed phrase in a safe place. +It is the only way to recover your account if you ever forget your password. + +oval green shrug term already arena pilot spirit jump gain useful symbol hover grid item concert kiss zero bleak farm capable peanut snack basket +``` + +The 24 words above is a seed phrase just for example, **DO NOT** use it in production. + +### Recover an existing key + +If you forget your password or lose your key, or you wanna use your key in another place, you can recover your key by your seed phrase. + +```txt +iriscli keys add MyKey --recover +``` + +You'll be asked to enter a new password for your key, and enter the seed phrase. Then you get your key back. + +```txt +Enter a passphrase for your key: +Repeat the passphrase: +Enter your recovery seed phrase: +``` + diff --git a/docs/features/bank.md b/docs/features/bank.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/features/distribution.md b/docs/features/distribution.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/features/governance.md b/docs/features/governance.md new file mode 100644 index 000000000..7961541cc --- /dev/null +++ b/docs/features/governance.md @@ -0,0 +1,260 @@ +# Gov/Iparam User Guide + +## Basic Function Description + +1. On-chain governance proposals on text +2. On-chain governance proposals on parameter change +3. On-chain governance proposals on software upgrade + +## Interactive process + +### governance process + +1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value `min_deposit`, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches `min_deposit`, enter voting period. However, if the block-time exceeds `max_deposit_period` in the deposit period, the proposal will be closed. +2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. +3. More details about voting for proposals: +[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) + +## Usage Scenario +### Create an environment + +``` +rm -rf iris +rm -rf .iriscli +iris init gen-tx --name=x --home=iris +iris init --gen-txs --chain-id=gov-test -o --home=iris +iris start --home=iris +``` + +### Usage scenario of parameter change + +Scenario 1：Change the parameters through the command lines + +``` +# Query parameters can be changed by the modules'name in gov +iriscli gov query-params --module=gov --trust-node + +# Results +[ + "Gov/gov/DepositProcedure", + "Gov/gov/TallyingProcedure", + "Gov/gov/VotingProcedure" +] + +# Query parameters can be modified by "key” +iriscli gov query-params --key=Gov/gov/DepositProcedure --trust-node + +# Results +{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":10}","op":""} + +# Send proposals, return changed parameters +echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 + +# Deposit for a proposal +echo 1234567890 | iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 + +# Vote for a proposal +echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 + +# Query the state of a proposal +iriscli gov query-proposal --proposal-id=1 --trust-node + +``` + +Scenario 2: Change the parameters by the files + +``` +# Export profiles +iriscli gov pull-params --path=iris --trust-node + +# Query profiles' info +cat iris/config/params.json +{ + "gov": { + "Gov/gov/DepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "10000000000000000000" + } + ], + "max_deposit_period": "10" + }, + "Gov/gov/VotingProcedure": { + "voting_period": "10" + }, + "Gov/gov/TallyingProcedure": { + "threshold": "1/2", + "veto": "1/3", + "governance_penalty": "1/100" + } + } +} +# Modify profiles (TallyingProcedure的governance_penalty) +vi iris/config/params.json +{ + "gov": { + "Gov/gov/DepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "10000000000000000000" + } + ], + "max_deposit_period": "10" + }, + "Gov/gov/VotingProcedure": { + "voting_period": "10" + }, + "Gov/gov/TallyingProcedure": { + "threshold": "1/2", + "veto": "1/3", + "governance_penalty": "20/100" + } + } +} + +# Change the parameters through files, return changed parameters +echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/gov/TallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 + +# Deposit for a proposal +echo 1234567890 | iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 + +# Vote for a proposal +echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 + +# Query the state of a proposal +iriscli gov query-proposal --proposal-id=1 --trust-node +``` + +## CLI Command Details + +### Basic method of gov modules + +``` +# Text proposals +iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="Text" --deposit="10iris" --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +``` + +* `--title` The title of a proposal +* `--description` The description of a proposal +* `--type` The type of a proposal {'Text','ParameterChange','SoftwareUpgrade'} +* `--deposit` The number of the tokens deposited +* The basic text proposals are as below + +``` +iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +``` + +* `--propsal-id` The ID of the proposal deposited +* `--deposit` The number of the tokens deposited + +``` +iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +``` + +* `--proposal-id` The ID of the proposal in voting period +* `--option` Vote option{'Yes'-agree,'Abstain'-abstain,'No'-disagree,'nowithVeto'-strongly disagree } + + +``` +# Query the state of a proposal +iriscli gov query-proposal --proposal-id=1 --trust-node +``` + +* `--proposal-id` Query the ID of a proposal + + + +### The proposals on parameters modification + +``` +# Query parameters can be modified by the modules'name in gov +iriscli gov query-params --module=gov --trust-node +``` + +* `--module` Query the list of "key" of the parameters can be changed in the module + + +``` +# Query the parameters can be modified by "key" +iriscli gov query-params --key=Gov/gov/DepositProcedure --trust-node +``` + +* `--key` Query the parameter corresponding to the "key" + +``` +# Export profiles +iriscli gov pull-params --path=iris --trust-node +``` + +* `--path` The folder of node initialization + + + +``` +# Modify the parameters through the command lines +iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +``` + +* `--param` The details of changed parameters （get parameters through query-params, modify it and then add "update" on the "op", more details in usage scenarios） +* Other fields' proposals are similar with text proposal + +``` +# Change the parameters through files, return modified parameters +echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/gov/TallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +``` + +* `--path` The folder of node initialization +* `--key` The key of the parameter to be modified +* `--op` The type of changed parameters; only 'update' is implemented at present +* Other fields' proposals are similar with text proposal + +### Proposals on software upgrade + +## Basic parameters + +``` +# DepositProcedure（The parameters in deposit period） +"Gov/gov/DepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "10000000000000000000" + } + ], + "max_deposit_period": "10" +} +``` + +* Parameters can be changed +* The key of parameters:"Gov/gov/DepositProcedure" +* `min_deposit[0].denom` The minimum tokens deposited are counted by iris-atto. +* `min_deposit[0].amount` The number of minimum tokens and the default scope：10iris,（1iris，200iris） +* `max_deposit_period` Window period for repaying deposit, default :10， scope（0，1） + +``` +# VotingProcedure（The parameters in voting period） +"Gov/gov/VotingProcedure": { + "voting_period": "10" +}, +``` + +* Parameters can be changed +* `voting_perid` Window period for vote, default：10, scope（20，20000） + +``` +# TallyingProcedure (The parameters in Tallying period) +"Gov/gov/TallyingProcedure": { + "threshold": "1/2", + "veto": "1/3", + "governance_penalty": "1/100" +} +``` + +* Parameters can be changed +* `veto` default: 1/3, scope（0，1） +* `threshold` default 1/2, scope（0，1） +* `governance_penalty` The default ratio of slashing tokens of validators who didn't vote: 1/100, scope（0，1） +* Vote rules: If the ratio of voting power of "strongly disagree" over "veto", the proposal won't be passed. If the ratio of voting_power of "agree" over "veto", the proposal won't be passed. Otherwise, it will be passed. + diff --git a/docs/features/iservice/README.md b/docs/features/iservice/README.md new file mode 100644 index 000000000..6ee46fffa --- /dev/null +++ b/docs/features/iservice/README.md @@ -0,0 +1,168 @@ +# IService User Guide + +## Basic Function Description +IRIS Services (a.k.a. "iServices") intend to bridge the gap between the blockchain world and the conventional business application world, by mediating a complete lifecycle of off-chain services -- from their definition, binding (provider registration), invocation, to their governance (profiling and dispute resolution). By enhancing the IBC processing logic to support service semantics, the IRIS SDK is intended to allow distributed business services to be available across the internet of blockchains. The [Interface description language](https://en.wikipedia.org/wiki/Interface_description_language) (IDL) we introduced is +to work with the service standardized definitions to satisfy service invocations across different programming languages. +The currently supported IDL language is [protobuf](https://developers.google.com/protocol-buffers/). The main functions of this module are as follows: +1. Service Definition +2. Service Binding +3. Service Invocation (TODO) +4. Dispute Resolution (TODO) +5. Service Analysis (TODO) + +## Interactive process + +### Service definition process + +1. Any users can define a service. In service definition，use `protobuf` to standardize the definition of the service's method, its input and output parameters. + +## Usage Scenario +### Create an environment + +``` +rm -rf iris +rm -rf .iriscli +iris init gen-tx --name=x --home=iris +iris init --gen-txs --chain-id=service-test -o --home=iris +iris start --home=iris +``` + +### Service Definition + +``` +# Service definition +iriscli iservice define --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags tag1,tag2 --messaging=Unicast --idl-content= --file=test.proto + +# Result +Committed at block 92 (tx hash: A63241AA6666B8CFE6B1C092B707AB0FA350F108, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:8007 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 101 102 105 110 101]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 54 48 49 52 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-define", + "completeConsumedTxFee-iris-atto": "160140000000000" + } +} + +# Query service definition +iriscli iservice definition --def-chain-id=service-test --service-name=test-service + +``` + +### Service Binding +``` +# Service Binding +iriscli iservice bind --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 --expiration=-1 + +# Result +Committed at block 168 (tx hash: 02CAC60E75CD93465CAE10CE35F30B53C8A95574, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5437 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 98 105 110 100]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 48 56 55 52 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-bind", + "completeConsumedTxFee-iris-atto": "108740000000000" + } +} + +# Query service binding +iriscli iservice binding --def-chain-id=service-test --service-name=test-service --bind-chain-id=service-test --provider= + +# Query service binding list +iriscli iservice bindings --def-chain-id=service-test --service-name=test-service + +# Service binding update +iriscli iservice update-binding --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris,2iris --avg-rsp-time=10000 --usable-time=100 --expiration=-1 + +# Result +Committed at block 233 (tx hash: 2F5F44BAF09981D137EA667F9E872EB098A9B619, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:4989 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 98 105 110 100 105 110 103 45 117 112 100 97 116 101]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[57 57 55 56 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-binding-update", + "completeConsumedTxFee-iris-atto": "99780000000000" + } +} + +# Refund Deposit +iriscli iservice refund-deposit --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service + +# Result +Committed at block 1563 (tx hash: 748CEA6EA9DEFB384FFCFBE68A3CB6D8B643361B, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5116 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 114 101 102 117 110 100 45 100 101 112 111 115 105 116]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 48 50 51 50 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-refund-deposit", + "completeConsumedTxFee-iris-atto": "102320000000000" + } +} +``` + +## CLI Command Details + +``` +iriscli iservice define --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags "tag1 tag2" --messaging=Unicast --idl-content= --file=test.proto +``` +* `--service-name` The name of iService +* `--service-description` The description of this iService +* `--author-description` The self-description of the iService creator which is optional +* `--tags` The keywords of this iService +* `--messaging` The transfer type of this iService{`Unicast`,`Multicast`} +* `--idl-content` The standardized definition of the methods for this iService +* `--file` Idl-content can be replaced by files,if the item is not empty. + +``` +iriscli iservice definition --def-chain-id=service-test --service-name=test-service +``` +* `--def-chain-id` The ID of the blockchain defined of the iService +* `--service-name` The name of iService + +``` +iriscli iservice bind --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 --expiration=-1 +``` +* `--def-chain-id` The ID of the blockchain defined of the iService +* `--service-name` The name of iService +* `--bind-type` Set whether the service is local or global +* `--deposit` The deposit of service provider +* `--prices` Service prices, a list sorted by service method +* `--avg-rsp-time` The average service response time in milliseconds +* `--usable-time` An integer represents the number of usable service invocations per 10,000 +* `--expiration` Negative number used here means the unbonded blockchain height "never expire" + +``` +iriscli iservice binding --def-chain-id=service-test --service-name=test-service --bind-chain-id=service-test --provider= +``` +* `--def-chain-id` The ID of the blockchain defined of the iService +* `--service-name` The name of iService +* `--bind-chain-id` The ID of the blockchain bound of the iService +* `--provider` The blockchain address of bech32 encoded account + +``` +iriscli iservice bindings --def-chain-id=service-test --service-name=test-service +``` +* Refer to iriscli iservice binding + +``` +iriscli iservice update-binding --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris,2iris --avg-rsp-time=10000 --usable-time=100 --expiration=-1 +``` +* Refer to iriscli iservice bind + +``` +iriscli iservice refund-deposit --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service +``` +* `--def-chain-id` The ID of the blockchain defined of the iService +* `--service-name` The name of iService + +## IDL extension +When using proto file to standardize the definition of the service's method, its input and output parameters, the method attributes can be added through annotations. + +### Annotation standard +* If `//@Attribute attribute： value` wrote on top of `rpc method`，it will be added to the method attributes. Eg. +> //@Attribute description: sayHello + +### Currently supported attributes +* `description` The name of this method in the iService +* `output_privacy` Whether the output of the method is encrypted，{`NoPrivacy`,`PubKeyEncryption`} +* `output_cached` Whether the output of the method is cached，{`OffChainCached`，`NoCached`} + +### IDL content example +* idl-content example +> syntax = \"proto3\";\n\npackage helloworld;\n\n// The greeting service definition.\nservice Greeter {\n //@Attribute description: sayHello\n //@Attribute output_privacy: NoPrivacy\n //@Attribute output_cached: NoCached\n rpc SayHello (HelloRequest) returns (HelloReply) {}\n}\n\n// The request message containing the user's name.\nmessage HelloRequest {\n string name = 1;\n}\n\n// The response message containing the greetings\nmessage HelloReply {\n string message = 1;\n}\n + +* IDL file example + +[test.proto](./test.proto) diff --git a/docs/features/iservice/test.proto b/docs/features/iservice/test.proto new file mode 100644 index 000000000..ccb70ab00 --- /dev/null +++ b/docs/features/iservice/test.proto @@ -0,0 +1,21 @@ +syntax = "proto3"; + +package helloworld; + +// The greeting service definition. +service Greeter { + //@Attribute description: sayHello + //@Attribute output_privacy: NoPrivacy + //@Attribute output_cached: NoCached + rpc SayHello (HelloRequest) returns (HelloReply) {} +} + +// The request message containing the user's name. +message HelloRequest { + string name = 1; +} + +// The response message containing the greetings +message HelloReply { + string message = 1; +} diff --git a/docs/features/keys/README.md b/docs/features/keys/README.md new file mode 100644 index 000000000..51c22cb03 --- /dev/null +++ b/docs/features/keys/README.md @@ -0,0 +1,30 @@ +# iriscli keys + +## Description + +Keys allows you to manage your local keystore for tendermint. + +## Usage + +```shell +iriscli keys [command] +``` + +## Available Commands + +| Name | Description | +| ------------- | ------------------------------------- | +| [add](add.md) | Create a new key, or import from seed | +| list | List all keys | +| show | Show key info for the given name | +| delete | Delete the given key | + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | ------- | ------------- | -------- | +| --help, -h | | help for keys | | + +## Extended description + +These keys may be in any format supported by go-crypto and can be used by light-clients, full nodes, or any other application that needs to sign with a private key. \ No newline at end of file diff --git a/docs/features/keys/add.md b/docs/features/keys/add.md new file mode 100644 index 000000000..2174b8c7c --- /dev/null +++ b/docs/features/keys/add.md @@ -0,0 +1,69 @@ +# iriscli keys add + +## Description + +Create a new key, or import from seed + +## Usage + +``` +iriscli keys add [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --account | | [uint32] Account number for HD derivation | | +| --dry-run | | Perform action, but don't add key to local keystore | | +| --help, -h | | help for add | | +| --index | | [uint32] Index number for HD derivation | | +| --ledger | | Store a local reference to a private key on a Ledger device | | +| --no-backup | | Don't print out seed phrase (if others are watching the terminal) | | +| --recover | | Provide seed phrase to recover existing key instead of creating | | +| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | + +## Examples + +### Create a new key + +```shell +iriscli keys add MyKey +``` + +You'll be asked to enter a password for your key, note: password must be at least 8 characters. + +```txt +Enter a passphrase for your key: +Repeat the passphrase: +``` + +After that, you're done with creating a new key, but remember to backup your seed phrase, it is the only way to recover your account if you ever forget your password or lose your key. + +```txt +NAME: TYPE: ADDRESS: PUBKEY: +MyKey local faa1mmsm487rqkgktl2qgrjad0z3yaf9n8t5pkp33m fap1addwnpepq2g0u7cnxp5ew0yhqep8j4rth5ugq8ky7gjmunk8tkpze95ss23ak4svkjq +**Important** write this seed phrase in a safe place. +It is the only way to recover your account if you ever forget your password. + +oval green shrug term already arena pilot spirit jump gain useful symbol hover grid item concert kiss zero bleak farm capable peanut snack basket +``` + +The 24 words above is a seed phrase just for example, **DO NOT** use it in production. + +### Recover an existing key + +If you forget your password or lose your key, or you wanna use your key in another place, you can recover your key by your seed phrase. + +```txt +iriscli keys add MyKey --recover +``` + +You'll be asked to enter a new password for your key, and enter the seed phrase. Then you get your key back. + +```txt +Enter a passphrase for your key: +Repeat the passphrase: +Enter your recovery seed phrase: +``` + diff --git a/docs/features/record.md b/docs/features/record.md new file mode 100644 index 000000000..a7ea515fe --- /dev/null +++ b/docs/features/record.md @@ -0,0 +1,85 @@ +# Record User Guide + +## Basic Function Description + +1. On-Chain record for the text data +2. On-Chain record for the text file (TODO) +3. On-Chain governance for the record params (TODO) + +## Interaction Process + +### Record process + +1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. +2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. +3. Any users can search/download onchain based on the record ID. +4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. + +## Usage Scenarios + +### Build Usage Scenarios + +``` +rm -rf iris +rm -rf .iriscli +iris init gen-tx --name=x --home=iris +iris init --gen-txs --chain-id=record-test -o --home=iris +iris start --home=iris +``` + +### Usage Scenarios of Record on Chains + +Scenario 1: Record the data through cli + +``` +# Specify the text data which needs to be recorded by --onchain-data + +iriscli record submit --description="test" --onchain-data=x --from=x --fee=0.04iris + +# Result +Committed at block 4 (tx hash: F649D5465A28842B50CAE1EE5950890E33379C45, response: {Code:0 Data:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98] Log:Msg 0: Info: GasWanted:200000 GasUsed:3857 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100]} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 109 57 51 99 103 57 54 51 56 121 115 104 116 116 100 109 119 54 57 97 121 118 51 103 106 53 102 116 116 109 108 120 51 99 102 121 107 109]} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[2 189 149 142 250 208 0]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "submit-record", + "completeConsumedTxFee-iris-atto": "\u0002\ufffd\ufffd\ufffd\ufffd\ufffd\u0000", + "ownerAddress": "faa1m93cg9638yshttdmw69ayv3gj5fttmlx3cfykm", + "record-id": "record:ab9d99d0cff653dc6e8545c8cc72e5533deaaa1255254adfd6b0074e2869661b" + } + } + +# Query the Status of the Records +iriscli record query --record-id=x + +# Download the Record +iriscli record download --record-id=x --file-name="download" + +``` + +Scenario 2: Query the transactions including recorded data onchain through cli + +``` +# Query the status of the records onchain +iriscli tendermint txs --tag "action='submit-record'" +``` + +## Details of cli + +``` +iriscli record submit --description="test" --onchain-data=x --chain-id="record-test" --from=x --fee=0.04iris +``` + +* `--onchain-data` The data needs to be recorded + + +``` +iriscli record query --record-id=x --chain-id="record-test" +``` + +* `--record-id` Record ID to be queried + + +``` +iriscli record download --record-id=x --file-name="download" --chain-id="record-test" +``` + +* `--file-name` The filename of recorded data, in the directory specified by `--home` diff --git a/docs/features/stake.md b/docs/features/stake.md new file mode 100644 index 000000000..2189c8edd --- /dev/null +++ b/docs/features/stake.md @@ -0,0 +1,94 @@ +# Delegators + +## What is a delegator? +People that cannot, or do not want to run validator operations, can still participate in the staking process as delegators. Indeed, validators are not chosen based on their own stake +but based on their total stake, which is the sum of their own stake and of the stake that is delegated to them. This is an important property, as it makes delegators a safeguard against + validators that exhibit bad behavior. If a validator misbehaves, its delegators will move their Atoms away from it, thereby reducing its stake. Eventually, if a validator's stake falls + under the top 100 addresses with highest stake, it will exit the validator set. + +## States for a Delegator + +Delegators have the same state as their validator. + + +Note that delegation are not necessarily bonded. Tokens of each delegator can be delegated and bonded, delegated and unbonding, delegated and unbonded, or loose. + +## Common operation for Delegators + +* Delegation + +To delegate some IRIS token to a validator, you could run the following command: +```$xslt +iriscli stake delegate --address-delegator= --address-validator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --amount=10000000000000000000iris +``` +> Please notice that the amount is under unit iris-atto, 1iris=10^18 iris-atto + +* Query Delegations + +You could query your delegation amount with the following command: + +```$xslt +iriscli stake delegation --address-delegator= --address-validator= --chain-id=fuxi-3001 +``` + +The example output is the following: +```$xslt +Delegation +Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 +Validator: faa1dmp6eyjw94u0wzc67qa03cmgl92qwqaph28lxq +Shares: 10000000000000000000/1Height: 215307 +``` + +> Please notice that the share amount is also correspond to iris-atto, 1iris=10^18 iris-atto + + +* Re-delegate + +Once a delegator has delegated his own IRIS to certain validator, he/she could change the destination of delegation at anytime. If the transaction is executed, the +delegation will be placed at the other's pool after 10 minutes. + +The redelegation operation is composed of two phases: + * redelegate begin + * redelegate complete + + To start, you should run the following command: +```$xslt +iriscli stake redelegate begin --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 +``` + +Please note that you have to wait 10 minute to run the next command: + +```$xslt +iriscli stake redelegate complete --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris +``` + +The example output is the following: +```$xslt +Delegation +Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 +Validator: faa1kepndxvjr6gnc8tjcnelp9hqz8jdcs8mvz7m86 +Shares: 10000000000000000000/1Height: 215459 +``` + +* Unbond Delegation + + +Once a delegator has delegated his own IRIS to certain validator, he/she could withdraw the delegation at anytime. If the transaction is executed, the +delegation will become liquid after 10 minutes. + +The redelegation operation is composed of two phases: + * unbond begin + * unbond complete + + To start, you should run the following command: +```$xslt +iriscli stake unbond begin --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 +``` + +Please note that you have to wait 10 minute to run the next command: + +```$xslt +iriscli stake unbond complete --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris +``` + +You could check that the balance of delegator has increased. \ No newline at end of file diff --git a/docs/features/upgrade.md b/docs/features/upgrade.md new file mode 100644 index 000000000..06a1035b8 --- /dev/null +++ b/docs/features/upgrade.md @@ -0,0 +1,113 @@ +# Software Upgrade User Guide + +## Basic Function Description + +The module supports the infrastructure of the blockchain software upgrade. It will be upgraded to the new version through voting at UpgradeProposal and switch stage within specific time, and is fully compatible with the historical data on the blockchain. + +## Interaction Process + +### Governance process of software upgrade proposal +1. Submit a software upgrade proposal +2. More details about governance process is in GOV [User Guide](../gov/README.md) + +### The process of software upgrade +1. Install a new software, send a switch message, and broadcast to the whole network. +2. Once reach the limited time, it will be counted whether the proportion of voting power of upgraded software exceeds 95%. +3. If it exceeds 95%, the software will be upgraded, otherwise the upgrade fails. +4. The validators who didn't upgrade in time need to re-download the new software and blocks synchronized. + +## Usage Scenarios + +### Create an environment + +``` +rm -rf iris +rm -rf .iriscli +iris init gen-tx --name=x --home=iris +iris init --gen-txs --chain-id=upgrade-test -o --home=iris +iris start --home=iris +``` + +### Submit a software upgrade proposal + +``` +# Send an upgrade proposal +iriscli gov submit-proposal --title=Upgrade --description="SoftwareUpgrade" --type="SoftwareUpgrade" --deposit=10iris --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 + +# Deposit for a proposal +iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 + +# Vote for a proposal +iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 + +# Query the state of a proposal +iriscli gov query-proposal --proposal-id=1 --trust-node +``` + +### Upgrade software + +* Scenario 1 + +Implement following operations within limited time（2days, 57600 block height）： + +``` +# 1. Download the new version:iris1 + +# 2. Close the old one +kill -f iris + +# 3. Install the new version，iris1 and start it（copy to bin） +iris1 start --home=iris + +# 4. Send a switch message, and broadcast to the whole network that the new software has been installed. +iriscli1 upgrade submit-switch --from=x --proposalID=1 --chain-id=upgrade-test --fee=0.05iris --gas=20000 + +# 5. Upgrade automatically when reach the preset time + +# 6. Query whether the current version has been successfully upgraded +iriscli upgrade info --trust-node +``` + +* Scenario 2 + +The operations in Scenario 1 haven't been implemented in the limited time (2 days, 57600 block height), report errors after the new version become valid: + +``` +# 1. Download the new version, iris1 + +# 2. Close the old one +kill -f iris + +# 3. Install the new version, iris1 and start it with following command lines（copy to bin） +iris1 start --replay --home=iris + +# 4. Query whether the current version has been successfully upgraded +iriscli upgrade info --trust-node +``` + +## Command details + +``` +iriscli gov submit-proposal --title=Upgrade --description="SoftwareUpgrade" --type="SoftwareUpgrade" --deposit=10iris --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 +``` + +* `--type` "SoftwareUpgrade" The type of Software upgrade proposals +* Other parameters can be referrenced in [Gov User Guide](../gov/README.md) + +``` +iriscli upgrade submit-switch --name=x --from=$VADDR --proposalID=1 --chain-id=upgrade-test --fee=0.05iris --gas=20000 +``` + +* `--proposalID` The ID of passed software upgrade proposals + +``` +iris start --replay +``` + +* Resynchronize the block, clean the dirty AppHash + +``` +iriscli upgrade info --trust-node +``` + +* Query the version details of current software diff --git a/docs/light-client/README.md b/docs/light-client/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/resources/README.md b/docs/resources/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/basic-concepts/bech32-prefix.md b/docs/software/basic-concepts/bech32-prefix.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/basic-concepts/key-types/coin-type.md b/docs/software/basic-concepts/key-types/coin-type.md new file mode 100644 index 000000000..3656537eb --- /dev/null +++ b/docs/software/basic-concepts/key-types/coin-type.md @@ -0,0 +1,111 @@ +# Coin_Type + +## Definitions + +Coin_type defines the available units of a kind of token in IRISnet. The developers can specify different coin_type for their tokens. The native token in IRIShub is `iris`, which has following available units: `iris-milli`, `iris-micro`, `iris-nano`, `iris-pico`, `iris-femto` and `iris-atto`. The conversion relationship between them are as follows: + +``` +1 iris = 10^3 iris-milli +1 iris = 10^6 iris-micro +1 iris = 10^9 iris-nano +1 iris = 10^12 iris-pico +1 iris = 10^15 iris-femto +1 iris = 10^18 iris-atto +``` + +All the registered types of `iris` in the system can be used with transactions. + +## Data Structure of coin_type + +```golang +type CoinType struct { + Name string `json:"name"` + MinUnit Unit `json:"min_unit"` + Units Units `json:"units"` + Origin Origin `json:"origin"` + Desc string `json:"desc"` +} +``` + +## Structure definition of Unit + +```golang +type Unit struct { + Denom string `json:"denom"` + Decimal int `json:"decimal"` +} +``` + +* Name : The name of a token, which is also its default unit；for instance,the default unit of `iris` is `iris`. +* MinUnit：The minimum unit of coin_type. + +The tokens in the system are all stored in the form of minimum unit, +such as `iris-atto`. You could choose to use the minimum unit of the tokens when sending a transaction to the IRIShub. +If you use the command line client, aka `iriscli`, you can use any system-recognized unit and the system +will automatically convert to the minimum unit of this corresponding token. For example, if you execute `send`command +to transfer 1iris, the command line will be processed as 10^18 iris-attos in the backend, and you will only +see 10^18 `iris-attos` when searching the transaction details by transaction hash. + + + +`Denom` is defined as the name of this unit, and `Decimal` is defined as the precision of the unit. + +For example, the precision of iris-atto is 18. + +* `Unit` defines a set of units available under coin_type. +* `Origin` defines the source of the coin_type, with the value `Native` (inner system, iris for IRIShub), +`External` (external system, such as eth for Ethereum, etc.), and `UserIssued` (user-defined). +* `Desc`：Description of the coin_type. + +## Query of coin_type + +If you want to query the coin_type configuration of a certain token, you can use the following command: + +```golang +iriscli bank coin-type [coin_name] +``` + +If you query the `coin-type` of `iris` with `iriscli bank coin-type iris` + +Example output: +```$xslt +{ + "name": "iris", + "min_unit": { + "denom": "iris-atto", + "decimal": "18" + }, + "units": [ + { + "denom": "iris", + "decimal": "0" + }, + { + "denom": "iris-milli", + "decimal": "3" + }, + { + "denom": "iris-micro", + "decimal": "6" + }, + { + "denom": "iris-nano", + "decimal": "9" + }, + { + "denom": "iris-pico", + "decimal": "12" + }, + { + "denom": "iris-femto", + "decimal": "15" + }, + { + "denom": "iris-atto", + "decimal": "18" + } + ], + "origin": 1, + "desc": "IRIS Network" +} +``` \ No newline at end of file diff --git a/docs/software/basic-concepts/key-types/fee.md b/docs/software/basic-concepts/key-types/fee.md new file mode 100644 index 000000000..64b2587f2 --- /dev/null +++ b/docs/software/basic-concepts/key-types/fee.md @@ -0,0 +1,23 @@ +# Introduction + +Specify the maximum fee you want to pay by `--fee`. Gas is the unit used to measure how much resource needed to execute the transaction. Specify the maximum gas limit by --gas. If maximum gas is too small, it won't be enough for executing the transaction. If the fee is too low, fee paid for each unit of gas will be low & validator won't execute the transaction too. The fee(minimum unit)/gas must be large than 2*10^10. We recommend that you set your maximum gas to 20000 and set your maximum fee to 400000000000000iris. Fee will be deduct according to the gas used and lefted fee will be returned to user. + +## Fee + +To secure their own validator node and maintain the avalibility of blockchain network, validators in IRISnet need a lot of equipments and works. Thus, every transactions in IRISnet should pay some fee to validators. The parameter in commands is used to specify the maximum fee the user want to pay for their transaction. + +## Gas + +The resource needed for every transactions are varied for different type of transactions. For example, only a few computations, queries & modifies is needed for sending some token to other peolpe. But a lot of computations, queries & modifies is needed for creating a validator. Gas is the unit used to measure how much resource needed to execute the transaction. We list the gas needed for some typical operactions in the below: + +- gas needed for reading some data from database: 10 + data length(in bytes) +- gas needed for writing some data to database: 10 + 10 * data length(in bytes) +- sign or verify a signature + +The total gas needed for executing the transaction is the sum of gas needed for every operations performed during executing the transaction. User should specify the maximum gas by --gas parameter. If maximum gas is not enough for executing the transcation, the transaction won't be executed successfully and all the fee will be returned to user's account. After the transaction being executed successfully, fee will deduct according to gas used, deducted fee will be maximum fee * gas used / maximum gas and left fee will be returned to user. Gas price is equal to maximum fee / maximum gas and stands for fee that user want to pay for each unit of gas. To keep the fee is set in a resonable range, we set a minimum limit for gas price, 2^(-8) iris/gas, transaction won't be executed if the gas price is less than this value. + +Example +``` + iriscli stake unbond complete --from=test --address-validator=faa1mahw6ymzvt2q3lu4pjj5pau2e8krntklgarrxy --address-delegator=faa1mahw6ymzvt2q3lu4pjj5pau2e8krntklgarrxy --fee=2000000000000000iris --gas=20000 --chain-id=test +``` +This example is a transaction to complete the unbond operation. The maximum fee(--fee) is set to be 2000000000000000iris(2*10^15) and the maximum(--gas) gas is set to be 20000. Therefore, the gas price here is 10^11iris/gas. Suppose that 1500 gas is used to execute the transaction, then 1500000000000000 iris will be paid to validators and lefted 500000000000000 iris will be returned to user. diff --git a/docs/software/basic-concepts/key-types/genesis.md b/docs/software/basic-concepts/key-types/genesis.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/basic-concepts/key-types/gov-params.md b/docs/software/basic-concepts/key-types/gov-params.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/basic-concepts/key-types/inflation.md b/docs/software/basic-concepts/key-types/inflation.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/cli-client.md b/docs/software/cli-client.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/light-client.md b/docs/software/light-client.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/monitor.md b/docs/software/monitor.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/node.md b/docs/software/node.md new file mode 100644 index 000000000..e69de29bb From c211e8ef2af7694624da5166f3e12b23f94f2384 Mon Sep 17 00:00:00 2001 From: zhangyelong Date: Sun, 11 Nov 2018 13:00:13 +0800 Subject: [PATCH 008/100] Move keys docs to cli-client --- docs/features/keys/README.md | 30 ---------------- docs/features/keys/add.md | 69 ------------------------------------ 2 files changed, 99 deletions(-) delete mode 100644 docs/features/keys/README.md delete mode 100644 docs/features/keys/add.md diff --git a/docs/features/keys/README.md b/docs/features/keys/README.md deleted file mode 100644 index 51c22cb03..000000000 --- a/docs/features/keys/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# iriscli keys - -## Description - -Keys allows you to manage your local keystore for tendermint. - -## Usage - -```shell -iriscli keys [command] -``` - -## Available Commands - -| Name | Description | -| ------------- | ------------------------------------- | -| [add](add.md) | Create a new key, or import from seed | -| list | List all keys | -| show | Show key info for the given name | -| delete | Delete the given key | - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | ------- | ------------- | -------- | -| --help, -h | | help for keys | | - -## Extended description - -These keys may be in any format supported by go-crypto and can be used by light-clients, full nodes, or any other application that needs to sign with a private key. \ No newline at end of file diff --git a/docs/features/keys/add.md b/docs/features/keys/add.md deleted file mode 100644 index 2174b8c7c..000000000 --- a/docs/features/keys/add.md +++ /dev/null @@ -1,69 +0,0 @@ -# iriscli keys add - -## Description - -Create a new key, or import from seed - -## Usage - -``` -iriscli keys add [flags] -``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | --------- | ------------------------------------------------------------ | -------- | -| --account | | [uint32] Account number for HD derivation | | -| --dry-run | | Perform action, but don't add key to local keystore | | -| --help, -h | | help for add | | -| --index | | [uint32] Index number for HD derivation | | -| --ledger | | Store a local reference to a private key on a Ledger device | | -| --no-backup | | Don't print out seed phrase (if others are watching the terminal) | | -| --recover | | Provide seed phrase to recover existing key instead of creating | | -| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | - -## Examples - -### Create a new key - -```shell -iriscli keys add MyKey -``` - -You'll be asked to enter a password for your key, note: password must be at least 8 characters. - -```txt -Enter a passphrase for your key: -Repeat the passphrase: -``` - -After that, you're done with creating a new key, but remember to backup your seed phrase, it is the only way to recover your account if you ever forget your password or lose your key. - -```txt -NAME: TYPE: ADDRESS: PUBKEY: -MyKey local faa1mmsm487rqkgktl2qgrjad0z3yaf9n8t5pkp33m fap1addwnpepq2g0u7cnxp5ew0yhqep8j4rth5ugq8ky7gjmunk8tkpze95ss23ak4svkjq -**Important** write this seed phrase in a safe place. -It is the only way to recover your account if you ever forget your password. - -oval green shrug term already arena pilot spirit jump gain useful symbol hover grid item concert kiss zero bleak farm capable peanut snack basket -``` - -The 24 words above is a seed phrase just for example, **DO NOT** use it in production. - -### Recover an existing key - -If you forget your password or lose your key, or you wanna use your key in another place, you can recover your key by your seed phrase. - -```txt -iriscli keys add MyKey --recover -``` - -You'll be asked to enter a new password for your key, and enter the seed phrase. Then you get your key back. - -```txt -Enter a passphrase for your key: -Repeat the passphrase: -Enter your recovery seed phrase: -``` - From 9031910afbe34b3ca7fbc60b4c8b477e53b0c653 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Mon, 12 Nov 2018 15:02:14 +0800 Subject: [PATCH 009/100] Correct command for compile irishub --- docs/get-started/Install-Iris.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/get-started/Install-Iris.md b/docs/get-started/Install-Iris.md index 4e80d1861..bf871a7f0 100644 --- a/docs/get-started/Install-Iris.md +++ b/docs/get-started/Install-Iris.md @@ -97,7 +97,7 @@ cd $GOPATH/src/github.com/irisnet git clone https://github.com/irisnet/irishub cd irishub && git checkout v0.6.0 curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh -make get_tools && get_vendor_deps && make install +make get_tools get_vendor_deps install ``` If your environment variables have set up correctly, you should not get any errors by running the above commands. From c53b82489b43848fe584e65d56c4fdddd6dfd6d8 Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Tue, 13 Nov 2018 16:16:12 +0800 Subject: [PATCH 010/100] Update English doc for record module --- docs/modules/record/README.md | 95 ++++++++------------------------- docs/modules/record/download.md | 40 ++++++++++++++ docs/modules/record/query.md | 46 ++++++++++++++++ docs/modules/record/submit.md | 61 +++++++++++++++++++++ 4 files changed, 168 insertions(+), 74 deletions(-) create mode 100644 docs/modules/record/download.md create mode 100644 docs/modules/record/query.md create mode 100644 docs/modules/record/submit.md diff --git a/docs/modules/record/README.md b/docs/modules/record/README.md index a7ea515fe..1ea99852d 100644 --- a/docs/modules/record/README.md +++ b/docs/modules/record/README.md @@ -1,85 +1,32 @@ -# Record User Guide +# iriscli record -## Basic Function Description +## Description -1. On-Chain record for the text data -2. On-Chain record for the text file (TODO) -3. On-Chain governance for the record params (TODO) +Record allows you to submit, query and download your records on chain. -## Interaction Process - -### Record process - -1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. -2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. -3. Any users can search/download onchain based on the record ID. -4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. - -## Usage Scenarios - -### Build Usage Scenarios - -``` -rm -rf iris -rm -rf .iriscli -iris init gen-tx --name=x --home=iris -iris init --gen-txs --chain-id=record-test -o --home=iris -iris start --home=iris -``` - -### Usage Scenarios of Record on Chains - -Scenario 1: Record the data through cli - -``` -# Specify the text data which needs to be recorded by --onchain-data - -iriscli record submit --description="test" --onchain-data=x --from=x --fee=0.04iris - -# Result -Committed at block 4 (tx hash: F649D5465A28842B50CAE1EE5950890E33379C45, response: {Code:0 Data:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98] Log:Msg 0: Info: GasWanted:200000 GasUsed:3857 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100]} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 109 57 51 99 103 57 54 51 56 121 115 104 116 116 100 109 119 54 57 97 121 118 51 103 106 53 102 116 116 109 108 120 51 99 102 121 107 109]} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[2 189 149 142 250 208 0]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "submit-record", - "completeConsumedTxFee-iris-atto": "\u0002\ufffd\ufffd\ufffd\ufffd\ufffd\u0000", - "ownerAddress": "faa1m93cg9638yshttdmw69ayv3gj5fttmlx3cfykm", - "record-id": "record:ab9d99d0cff653dc6e8545c8cc72e5533deaaa1255254adfd6b0074e2869661b" - } - } - -# Query the Status of the Records -iriscli record query --record-id=x - -# Download the Record -iriscli record download --record-id=x --file-name="download" +## Usage +```shell +iriscli record [command] ``` -Scenario 2: Query the transactions including recorded data onchain through cli +## Available Commands -``` -# Query the status of the records onchain -iriscli tendermint txs --tag "action='submit-record'" -``` +| Name | Description | +| ------------------------| --------------------------------------------------------------| +| [query](query.md) | Query specified record | +| [download](download.md) | Download related data with unique record ID to specified file | +| [submit](submit.md) | Submit a new record | -## Details of cli +## Flags -``` -iriscli record submit --description="test" --onchain-data=x --chain-id="record-test" --from=x --fee=0.04iris -``` +| Name, shorthand | Default | Description | Required | +| --------------- | ------- | --------------- | -------- | +| --help, -h | | help for record | | -* `--onchain-data` The data needs to be recorded - - -``` -iriscli record query --record-id=x --chain-id="record-test" -``` +## Extended description -* `--record-id` Record ID to be queried - - -``` -iriscli record download --record-id=x --file-name="download" --chain-id="record-test" -``` - -* `--file-name` The filename of recorded data, in the directory specified by `--home` +1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. +2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. +3. Any users can search/download on chain based on the record ID. +4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. diff --git a/docs/modules/record/download.md b/docs/modules/record/download.md new file mode 100644 index 000000000..f912c6e2d --- /dev/null +++ b/docs/modules/record/download.md @@ -0,0 +1,40 @@ +# iriscli record download + +## Description + +Download related data with unique record ID to specified file + +## Usage + +``` +iriscli record download [record ID] [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --file-name | | [string] Download file name | Yes | +| --height | most recent provable block | [int] block height to query | | +| --help, -h | | help for download | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --record-id | | [string] record ID | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Download a record + +```shell +iriscli record download --chain-id=test --record-id=MyRecordID --file-name="download.txt" +``` + +After that, you will get download file under iriscli home directory with the specfied record ID info. + +```txt +[ONCHAIN] Downloading ~/.iriscli/download.txt from blockchain directly... +[ONCHAIN] Download file from blockchain complete. +``` diff --git a/docs/modules/record/query.md b/docs/modules/record/query.md new file mode 100644 index 000000000..40f8c8fef --- /dev/null +++ b/docs/modules/record/query.md @@ -0,0 +1,46 @@ +# iriscli record query + +## Description + +Query details of the existing record + +## Usage + +``` +iriscli record query [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for query | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --record-id | | [string] Record ID for query | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query a record + +```shell +iriscli record query --chain-id=test --record-id=MyRecordID +``` + +After that, you will get detail info for the record which has the specfied record ID. + +```txt +{ + "submit_time": "2018-11-13 15:31:36", + "owner_addr": "faa122uzzpugtrzs09nf3uh8xfjaza59xvf9rvthdl", + "record_id": "record:ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6", + "description": "description", + "data_hash": "ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6", + "data_size": "24", + "data": "this is my on chain data" +} +``` diff --git a/docs/modules/record/submit.md b/docs/modules/record/submit.md new file mode 100644 index 000000000..31d531603 --- /dev/null +++ b/docs/modules/record/submit.md @@ -0,0 +1,61 @@ +# iriscli record submit + +## Description + +Submit a record on chain + +## Usage + +``` +iriscli record submit [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | Broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --description | description | [string] Uploaded file description | | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas string | 200000 | Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| -h, --help | | help for submit | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --onchain-data | | [string] on chain data source | Yes | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Submit a record + +```shell +iriscli record submit --chain-id="test" --onchain-data="this is my on chain data" --from=node0 --fee=0.1iris +``` + +After that, you're done with submitting a new record, but remember to back up your record id, it's the only way to retrieve your on chain record. + +```txt +Password to sign with 'node0': +Committed at block 72 (tx hash: 7CCC8B4018D4447E6A496923944870E350A1A3AF9E15DB15B8943DAD7B5D782B, response: {Code:0 Data:[114 101 99 111 114 100 58 97 98 53 54 48 50 98 97 99 49 51 102 49 49 55 51 55 101 56 55 57 56 100 100 53 55 56 54 57 99 52 54 56 49 57 52 101 102 97 100 50 100 98 51 55 54 50 53 55 57 53 102 49 101 102 100 56 100 57 100 54 51 99 54] Log:Msg 0: Info: GasWanted:200000 GasUsed:4090 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 50 50 117 122 122 112 117 103 116 114 122 115 48 57 110 102 51 117 104 56 120 102 106 97 122 97 53 57 120 118 102 57 114 118 116 104 100 108] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 97 98 53 54 48 50 98 97 99 49 51 102 49 49 55 51 55 101 56 55 57 56 100 100 53 55 56 54 57 99 52 54 56 49 57 52 101 102 97 100 50 100 98 51 55 54 50 53 55 57 53 102 49 101 102 100 56 100 57 100 54 51 99 54] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 50 48 52 53 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "submit-record", + "completeConsumedTxFee-iris-atto": "\"2045000000000000\"", + "ownerAddress": "faa122uzzpugtrzs09nf3uh8xfjaza59xvf9rvthdl", + "record-id": "record:ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6" + } + } +``` + From d0c865eb2790ff836a0eafbc741689a5cd1adbec Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Tue, 13 Nov 2018 18:18:05 +0800 Subject: [PATCH 011/100] Refresh English doc for record module --- docs/modules/record/README.md | 8 ++++---- docs/modules/record/query.md | 2 +- docs/modules/record/submit.md | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/modules/record/README.md b/docs/modules/record/README.md index 1ea99852d..2c81c2185 100644 --- a/docs/modules/record/README.md +++ b/docs/modules/record/README.md @@ -2,7 +2,7 @@ ## Description -Record allows you to submit, query and download your records on chain. +Record allows you to submit, query and download your records on the chain. ## Usage @@ -26,7 +26,7 @@ iriscli record [command] ## Extended description -1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. +1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the chain, the request will be completed successfully and the relevant metadata will be recorded on the chain. And you will be returned a record ID to confirm your ownership of the data. 2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. -3. Any users can search/download on chain based on the record ID. -4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. +3. Any users can search/download on the chain based on the record ID. +4. At present, the maximum amount of stored data is 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. diff --git a/docs/modules/record/query.md b/docs/modules/record/query.md index 40f8c8fef..766e06f53 100644 --- a/docs/modules/record/query.md +++ b/docs/modules/record/query.md @@ -33,7 +33,7 @@ iriscli record query --chain-id=test --record-id=MyRecordID After that, you will get detail info for the record which has the specfied record ID. -```txt +```json { "submit_time": "2018-11-13 15:31:36", "owner_addr": "faa122uzzpugtrzs09nf3uh8xfjaza59xvf9rvthdl", diff --git a/docs/modules/record/submit.md b/docs/modules/record/submit.md index 31d531603..87f2c1ad2 100644 --- a/docs/modules/record/submit.md +++ b/docs/modules/record/submit.md @@ -2,7 +2,7 @@ ## Description -Submit a record on chain +Submit a record on the chain ## Usage @@ -44,7 +44,7 @@ iriscli record submit [flags] iriscli record submit --chain-id="test" --onchain-data="this is my on chain data" --from=node0 --fee=0.1iris ``` -After that, you're done with submitting a new record, but remember to back up your record id, it's the only way to retrieve your on chain record. +After that, you're done with submitting a new record, but remember to back up your record id, it's the only way to retrieve your record. ```txt Password to sign with 'node0': From 8bbcbadfe081a1db3695deda3dd771c489ceabf5 Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Wed, 14 Nov 2018 14:11:46 +0800 Subject: [PATCH 012/100] CI Test From 45aa8472f64f573b301be43db7ce363d8f642ef3 Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Wed, 14 Nov 2018 14:12:27 +0800 Subject: [PATCH 013/100] DEVOPS-281 CI Test --- docs/.vuepress/config.js | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index ab504bbb6..5ae9e920e 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -53,3 +53,4 @@ module.exports = { ] } } + From deda227d6e9fdc6b1dcb711ebd5c6f3c6584312e Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Wed, 14 Nov 2018 18:18:47 +0800 Subject: [PATCH 014/100] Rename docs/modules/record -> docs/cli-client/record --- docs/{modules => cli-client}/record/README.md | 0 docs/{modules => cli-client}/record/download.md | 0 docs/{modules => cli-client}/record/query.md | 0 docs/{modules => cli-client}/record/submit.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename docs/{modules => cli-client}/record/README.md (100%) rename docs/{modules => cli-client}/record/download.md (100%) rename docs/{modules => cli-client}/record/query.md (100%) rename docs/{modules => cli-client}/record/submit.md (100%) diff --git a/docs/modules/record/README.md b/docs/cli-client/record/README.md similarity index 100% rename from docs/modules/record/README.md rename to docs/cli-client/record/README.md diff --git a/docs/modules/record/download.md b/docs/cli-client/record/download.md similarity index 100% rename from docs/modules/record/download.md rename to docs/cli-client/record/download.md diff --git a/docs/modules/record/query.md b/docs/cli-client/record/query.md similarity index 100% rename from docs/modules/record/query.md rename to docs/cli-client/record/query.md diff --git a/docs/modules/record/submit.md b/docs/cli-client/record/submit.md similarity index 100% rename from docs/modules/record/submit.md rename to docs/cli-client/record/submit.md From 1a4e5102b9cd7b9826eed99627d5cfb465d83c29 Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Wed, 14 Nov 2018 18:41:25 +0800 Subject: [PATCH 015/100] Update Chinese doc for record module --- docs/zh/cli-client/record/README.md | 32 ++++++++++++++ docs/zh/cli-client/record/download.md | 40 ++++++++++++++++++ docs/zh/cli-client/record/query.md | 46 ++++++++++++++++++++ docs/zh/cli-client/record/submit.md | 61 +++++++++++++++++++++++++++ 4 files changed, 179 insertions(+) create mode 100644 docs/zh/cli-client/record/README.md create mode 100644 docs/zh/cli-client/record/download.md create mode 100644 docs/zh/cli-client/record/query.md create mode 100644 docs/zh/cli-client/record/submit.md diff --git a/docs/zh/cli-client/record/README.md b/docs/zh/cli-client/record/README.md new file mode 100644 index 000000000..2294c5a49 --- /dev/null +++ b/docs/zh/cli-client/record/README.md @@ -0,0 +1,32 @@ +# iriscli record + +## 描述 + +存证模块允许你来提交，查询和下载链上存证。 + +## 用法 + +```shell +iriscli record [command] +``` + +## 相关命令 + +| 命令 | 描述 | +| ------------------------| -------------------------------------------------- | +| [query](query.md) | 查询特定的存证 | +| [download](download.md) | 根据record ID下载相关存证到指定的文件 | +| [submit](submit.md) | 提交一个新的存证 | + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | ------- | --------------- | -------- | +| --help, -h | | 存证命令帮助 | | + +## 扩展描述 + +1. 任何用户可以发起存证请求，存证过程会花费用户一部分token，如果该数据的存证之前在链上并不存在,则该请求可以成功完成，并且链上会记录相关元数据，并返还给用户一个存证ID以确认该用户对这份数据的所有权。 +2. 其他人若对完全相同的数据发起存证请求，则该请求会被直接否决，并提示相关存证数据已经存在。 +3. 任何用户都可以根据存证ID在链上进行检索/下载操作。 +4. 目前每次存证数据最大不超过1K，未来将结合治理模块实现参数的动态调整。 diff --git a/docs/zh/cli-client/record/download.md b/docs/zh/cli-client/record/download.md new file mode 100644 index 000000000..291c8b6a5 --- /dev/null +++ b/docs/zh/cli-client/record/download.md @@ -0,0 +1,40 @@ +# iriscli record download + +## 描述 + +下载存证ID指定的存证 + +## 用法 + +``` +iriscli record download [record ID] [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | -------------------------- | --------------------------------------------------------- | -------- | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --file-name | | [string] 下载文件名 | 是 | +| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | +| --help, -h | | 下载命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --record-id | | [string] 存证ID | 是 | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 下载存证 + +```shell +iriscli record download --chain-id=test --record-id=MyRecordID --file-name="download.txt" +``` + +在这之后，你将在iriscli的home目录下得到指定存证ID的下载文件。 + +```txt +[ONCHAIN] Downloading ~/.iriscli/download.txt from blockchain directly... +[ONCHAIN] Download file from blockchain complete. +``` diff --git a/docs/zh/cli-client/record/query.md b/docs/zh/cli-client/record/query.md new file mode 100644 index 000000000..dd6d6de4c --- /dev/null +++ b/docs/zh/cli-client/record/query.md @@ -0,0 +1,46 @@ +# iriscli record query + +## 描述 + +查询存证信息 + +## 用法 + +``` +iriscli record query [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | -------------------------- | ---------------------------------------------------------- | -------- | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON格式的应答中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --record-id | | [string] 存证ID | 是 | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询存证 + +```shell +iriscli record query --chain-id=test --record-id=MyRecordID +``` + +在这之后，你将得到存证ID指定的存证的详细信息。 + +```json +{ + "submit_time": "2018-11-13 15:31:36", + "owner_addr": "faa122uzzpugtrzs09nf3uh8xfjaza59xvf9rvthdl", + "record_id": "record:ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6", + "description": "description", + "data_hash": "ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6", + "data_size": "24", + "data": "this is my on chain data" +} +``` diff --git a/docs/zh/cli-client/record/submit.md b/docs/zh/cli-client/record/submit.md new file mode 100644 index 000000000..d818272e4 --- /dev/null +++ b/docs/zh/cli-client/record/submit.md @@ -0,0 +1,61 @@ +# iriscli record submit + +## 描述 + +向链上提交一个存证 + +## 用法 + +``` +iriscli record submit [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --description | description | [string] 上传文件的描述信息 | | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | 是 | +| --from | | [string] 用来签名的私钥名 | 是 | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| -h, --help | | 提交命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --onchain-data | | [string] 上链数据 | 是 | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 提交存证 + +```shell +iriscli record submit --chain-id="test" --onchain-data="this is my on chain data" --from=node0 --fee=0.1iris +``` + +在这之后你已经成功提交了一个存证，但是请记得备份你的存证ID，它是可以用来检索你的存证的唯一方法。 + +```txt +Password to sign with 'node0': +Committed at block 72 (tx hash: 7CCC8B4018D4447E6A496923944870E350A1A3AF9E15DB15B8943DAD7B5D782B, response: {Code:0 Data:[114 101 99 111 114 100 58 97 98 53 54 48 50 98 97 99 49 51 102 49 49 55 51 55 101 56 55 57 56 100 100 53 55 56 54 57 99 52 54 56 49 57 52 101 102 97 100 50 100 98 51 55 54 50 53 55 57 53 102 49 101 102 100 56 100 57 100 54 51 99 54] Log:Msg 0: Info: GasWanted:200000 GasUsed:4090 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 50 50 117 122 122 112 117 103 116 114 122 115 48 57 110 102 51 117 104 56 120 102 106 97 122 97 53 57 120 118 102 57 114 118 116 104 100 108] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 97 98 53 54 48 50 98 97 99 49 51 102 49 49 55 51 55 101 56 55 57 56 100 100 53 55 56 54 57 99 52 54 56 49 57 52 101 102 97 100 50 100 98 51 55 54 50 53 55 57 53 102 49 101 102 100 56 100 57 100 54 51 99 54] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 50 48 52 53 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "submit-record", + "completeConsumedTxFee-iris-atto": "\"2045000000000000\"", + "ownerAddress": "faa122uzzpugtrzs09nf3uh8xfjaza59xvf9rvthdl", + "record-id": "record:ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6" + } + } +``` + From d772a1dfde6f040522b789f9adc497fb0686151e Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Wed, 14 Nov 2018 18:42:18 +0800 Subject: [PATCH 016/100] Recover docs/modules/record/README.md --- docs/modules/record/README.md | 85 +++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 docs/modules/record/README.md diff --git a/docs/modules/record/README.md b/docs/modules/record/README.md new file mode 100644 index 000000000..a7ea515fe --- /dev/null +++ b/docs/modules/record/README.md @@ -0,0 +1,85 @@ +# Record User Guide + +## Basic Function Description + +1. On-Chain record for the text data +2. On-Chain record for the text file (TODO) +3. On-Chain governance for the record params (TODO) + +## Interaction Process + +### Record process + +1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. +2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. +3. Any users can search/download onchain based on the record ID. +4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. + +## Usage Scenarios + +### Build Usage Scenarios + +``` +rm -rf iris +rm -rf .iriscli +iris init gen-tx --name=x --home=iris +iris init --gen-txs --chain-id=record-test -o --home=iris +iris start --home=iris +``` + +### Usage Scenarios of Record on Chains + +Scenario 1: Record the data through cli + +``` +# Specify the text data which needs to be recorded by --onchain-data + +iriscli record submit --description="test" --onchain-data=x --from=x --fee=0.04iris + +# Result +Committed at block 4 (tx hash: F649D5465A28842B50CAE1EE5950890E33379C45, response: {Code:0 Data:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98] Log:Msg 0: Info: GasWanted:200000 GasUsed:3857 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100]} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 109 57 51 99 103 57 54 51 56 121 115 104 116 116 100 109 119 54 57 97 121 118 51 103 106 53 102 116 116 109 108 120 51 99 102 121 107 109]} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[2 189 149 142 250 208 0]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "submit-record", + "completeConsumedTxFee-iris-atto": "\u0002\ufffd\ufffd\ufffd\ufffd\ufffd\u0000", + "ownerAddress": "faa1m93cg9638yshttdmw69ayv3gj5fttmlx3cfykm", + "record-id": "record:ab9d99d0cff653dc6e8545c8cc72e5533deaaa1255254adfd6b0074e2869661b" + } + } + +# Query the Status of the Records +iriscli record query --record-id=x + +# Download the Record +iriscli record download --record-id=x --file-name="download" + +``` + +Scenario 2: Query the transactions including recorded data onchain through cli + +``` +# Query the status of the records onchain +iriscli tendermint txs --tag "action='submit-record'" +``` + +## Details of cli + +``` +iriscli record submit --description="test" --onchain-data=x --chain-id="record-test" --from=x --fee=0.04iris +``` + +* `--onchain-data` The data needs to be recorded + + +``` +iriscli record query --record-id=x --chain-id="record-test" +``` + +* `--record-id` Record ID to be queried + + +``` +iriscli record download --record-id=x --file-name="download" --chain-id="record-test" +``` + +* `--file-name` The filename of recorded data, in the directory specified by `--home` From 4f3e24a262818e46902b8fea6397edd9095bfe3d Mon Sep 17 00:00:00 2001 From: kaifei Date: Thu, 15 Nov 2018 10:29:08 +0800 Subject: [PATCH 017/100] =?UTF-8?q?IRISHUB-676=EF=BC=9Adoc=20of=20IRIS=20M?= =?UTF-8?q?onitor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/tools/Deploy-IRIS-Monitor.md | 72 +++++++++++++--------------- docs/zh/tools/Deploy-IRIS-Monitor.md | 68 ++++++++++++-------------- 2 files changed, 64 insertions(+), 76 deletions(-) diff --git a/docs/tools/Deploy-IRIS-Monitor.md b/docs/tools/Deploy-IRIS-Monitor.md index a2f598566..574e6e2ee 100644 --- a/docs/tools/Deploy-IRIS-Monitor.md +++ b/docs/tools/Deploy-IRIS-Monitor.md @@ -1,62 +1,56 @@ -# How to deploy IRIShub Monitor +# How to deploy IRIS Monitor Please make sure that iris is installed in your computer and added to $PATH.You can see this page for insturcion https://github.com/irisnet/irishub. You also need /bin/bash, wc, ps to ensure the monitor work properly. -### Get Monitor Info - -* Address of validator +## Start IRIS Monitor ``` --a= < hex-encoded-address-of-validator > +irismon --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --chain-id=irishub-stage --node=http://localhost:36657 ``` -* Chain-ID -``` ---chain-id= < id-of-blockchain > -``` +Parameters： -* Node +- `address`：hex encoded validator address +- `account-address`：bech32 encoded account address +- `chain-id`：blockchain id that you want to monitor +- `node`：listening address of the node that you want to monitor ("tcp://localhost:26657" by default, you should not change this if you didn't modify your rpc port) +Then you can visit `http://localhost:36660/` to see metrics data。 -``` ---node= < localhost:26657 > -``` -### Start IRIS Monitor -Example: -``` -irismon --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --chain-id=irishub-stage --node=http://localhost:26657& -``` +## Start Prometheus -then, you can visit http://localhost:3660/ to see the metrics page. +### Edit Prometheus config file -### Start Prometheus +You can visit [prometheus.yml](https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus.yml) to download default `prometheus.yml` and save it. -First, you need to edit the configuration file of prometheus. Add `jobs` : -```$xslt -- job_name: fuxi-4000 +Then edit `prometheus.yml` and add `jobs` : - static_configs: +```yaml + - job_name: fuxi-4000 + static_configs: + - targets: ['localhost:36660'] + labels: + instance: fuxi-4000 +``` - - targets: ['localhost:36660'] +> Note：value of targets is ip:port which used by IRIS monitor - labels: +### Start Prometheus - instance: fuxi-4000 +```bash +docker run -d --name=prometheus -p 9090:9090 -v ~/volumes/prometheus:/etc/prometheus prom/prometheus ``` -Then, you could see in your browser that there are some data available at port 36660. -### Start Grafana - -You could start grafana with docker by running: -```$xslt -sudo docker run -p 3000:3000 grafana/grafana 1>grafana.log 2>grafana.error & -``` +> The above example, the path of `prometheus.yml` is `~/volumes/prometheus` on host machine -The default username and password are both admin. We strongly recommend immediately changing your username & password after login. +You can visit `http://localhost:9090` to see prometheus data. -Then you could create your own dashboard. +## Start Grafana -### Stop IRIS Monitor ``` -kill -9 -``` \ No newline at end of file +docker run -d --name=grafana -p 3000:3000 grafana/grafana +``` + +You can visit `http://localhost:3000/` to open grafana and create your own dashboard. + +> Tips: The default username and password are both admin. We strongly recommend immediately changing your username & password after login. \ No newline at end of file diff --git a/docs/zh/tools/Deploy-IRIS-Monitor.md b/docs/zh/tools/Deploy-IRIS-Monitor.md index 7e1c7cd2a..ca3f91488 100644 --- a/docs/zh/tools/Deploy-IRIS-Monitor.md +++ b/docs/zh/tools/Deploy-IRIS-Monitor.md @@ -1,62 +1,56 @@ -# 如何部署monitor +# 如何部署 IRIS Monitor -确保已经安装了iris等工具，系统中需要有/bin/bash、wc、ps等命令。 你可以参考这个页面来安装iris工具:https://github.com/irisnet/irishub +确保已经安装了iris等工具，系统中需要有/bin/bash、wc、ps等命令。 你可以参考这个页面来安装iris工具: https://github.com/irisnet/irishub -## 获得修改运行参数 - -* 验证人地址的hex编码 +## 启动 IRIS Monitor ``` --a=<你的验证人地址的hex编码> +irismon --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --chain-id=irishub-stage --node=http://localhost:36657 ``` -* 确定Chain-ID - -``` ---chain-id=<你要监控的网络的ID> -``` +参数说明： -* 确定监控的节点 +- `address`：要监测的验证人地址（hex编码） +- `account-address`：要监测的账户地址（bech32 编码） +- `chain-id`：要监测的链 id +- `node`：要监控的节点地址（默认为 tcp://localhost:26657） +启动之后, 你可以通过 `http://localhost:36660/` 能看到 Metrics 数据页面。 -``` ---node=<你要监控的节点监听的rpc端口(默认为26657)> -``` +## 启动 Prometheus -## 启动IRIS Monitor +### 编辑配置文件 -``` -irismon --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --chain-id=irishub-stage --node=http://localhost:36657& -``` +从 [https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus.yml](https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus.yml) 下载默认配置文件到本地： +在配置文件 `prometheus.yml` 中添加以下 `jobs` : -### 启动Prometheus - -在配置文件中添加 `jobs` : -```$xslt +```yaml - job_name: fuxi-4000 - static_configs: - - targets: ['localhost:36660'] - labels: - instance: fuxi-4000 ``` -启动Prometheus后可以在本地36660端口看到监控数据。 +> Note：targets 配置项的值为 IRIS Monitor 启动后所占用的 ip 和 port。 + +### 启动 Prometheus + +```bashg +docker run -d --name=prometheus -p 9090:9090 -v ~/volumes/prometheus:/etc/prometheus prom/prometheus +``` -### 启动Grafana +将编辑好的配置文件 `prometheus.yml` 放在宿主机的目录下并映射到容器中。 +例如在上例中配置文件位于宿主机的 `~/volumes/prometheus` 中。 -通过Docker启动Grafana -```$xslt -sudo docker run -p 3000:3000 grafana/grafana 1>grafana.log 2>grafana.error & + +## 启动 Grafana + +``` +docker run -d --name=grafana -p 3000:3000 grafana/grafana ``` -接下来就可以访问localhost:3000来查看grafana监控。打开网页后使用默认用户名admin，默认密码admin登录。建议登录之后立即修改密码。 +接下来就可以访问 `http://localhost:3000/` 来查看 grafana 监控。 -5. 关闭监控 -```$xslt -killl -9 -``` \ No newline at end of file +> Tips: 打开网页后使用默认用户名 admin，默认密码 admin 登录。建议登录之后立即修改密码。 \ No newline at end of file From f55a66032fef38b01ef8319317521bc20027e4b9 Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Thu, 15 Nov 2018 14:40:23 +0800 Subject: [PATCH 018/100] Update record doc --- docs/cli-client/record/README.md | 14 +++++++------- docs/zh/cli-client/record/README.md | 14 +++++++------- docs/zh/cli-client/record/download.md | 2 +- docs/zh/cli-client/record/query.md | 2 +- docs/zh/cli-client/record/submit.md | 9 ++++++++- 5 files changed, 24 insertions(+), 17 deletions(-) diff --git a/docs/cli-client/record/README.md b/docs/cli-client/record/README.md index 1ea99852d..078dfcc66 100644 --- a/docs/cli-client/record/README.md +++ b/docs/cli-client/record/README.md @@ -10,6 +10,13 @@ Record allows you to submit, query and download your records on chain. iriscli record [command] ``` +## Record Introduction + +1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. +2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. +3. Any users can search/download on chain based on the record ID. +4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. + ## Available Commands | Name | Description | @@ -23,10 +30,3 @@ iriscli record [command] | Name, shorthand | Default | Description | Required | | --------------- | ------- | --------------- | -------- | | --help, -h | | help for record | | - -## Extended description - -1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. -2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. -3. Any users can search/download on chain based on the record ID. -4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. diff --git a/docs/zh/cli-client/record/README.md b/docs/zh/cli-client/record/README.md index 2294c5a49..920233f89 100644 --- a/docs/zh/cli-client/record/README.md +++ b/docs/zh/cli-client/record/README.md @@ -10,6 +10,13 @@ iriscli record [command] ``` +## 存证模块的介绍 + +1. 任何用户可以发起存证请求，存证过程会花费用户一部分token，如果该数据的存证之前在链上并不存在,则该请求可以成功完成，并且链上会记录相关元数据，并返还给用户一个存证ID以确认该用户对这份数据的所有权。 +2. 其他人若对完全相同的数据发起存证请求，则该请求会被直接否决，并提示相关存证数据已经存在。 +3. 任何用户都可以根据存证ID在链上进行检索/下载操作。 +4. 目前每次存证数据最大不超过1K，未来将结合治理模块实现参数的动态调整。 + ## 相关命令 | 命令 | 描述 | @@ -23,10 +30,3 @@ iriscli record [command] | 名称, 速记 | 默认值 | 描述 | 必需 | | --------------- | ------- | --------------- | -------- | | --help, -h | | 存证命令帮助 | | - -## 扩展描述 - -1. 任何用户可以发起存证请求，存证过程会花费用户一部分token，如果该数据的存证之前在链上并不存在,则该请求可以成功完成，并且链上会记录相关元数据，并返还给用户一个存证ID以确认该用户对这份数据的所有权。 -2. 其他人若对完全相同的数据发起存证请求，则该请求会被直接否决，并提示相关存证数据已经存在。 -3. 任何用户都可以根据存证ID在链上进行检索/下载操作。 -4. 目前每次存证数据最大不超过1K，未来将结合治理模块实现参数的动态调整。 diff --git a/docs/zh/cli-client/record/download.md b/docs/zh/cli-client/record/download.md index 291c8b6a5..f66acd8f4 100644 --- a/docs/zh/cli-client/record/download.md +++ b/docs/zh/cli-client/record/download.md @@ -32,7 +32,7 @@ iriscli record download [record ID] [flags] iriscli record download --chain-id=test --record-id=MyRecordID --file-name="download.txt" ``` -在这之后，你将在iriscli的home目录下得到指定存证ID的下载文件。 +iriscli会先在home目录(default: ~/.irislci)中创建一个用户指定的文件(download.txt)，然后把从链上下载的数据保存在此文件中。 ```txt [ONCHAIN] Downloading ~/.iriscli/download.txt from blockchain directly... diff --git a/docs/zh/cli-client/record/query.md b/docs/zh/cli-client/record/query.md index dd6d6de4c..3ccd4ebed 100644 --- a/docs/zh/cli-client/record/query.md +++ b/docs/zh/cli-client/record/query.md @@ -31,7 +31,7 @@ iriscli record query [flags] iriscli record query --chain-id=test --record-id=MyRecordID ``` -在这之后，你将得到存证ID指定的存证的详细信息。 +查询到的结果如下所示： ```json { diff --git a/docs/zh/cli-client/record/submit.md b/docs/zh/cli-client/record/submit.md index d818272e4..6efd72a65 100644 --- a/docs/zh/cli-client/record/submit.md +++ b/docs/zh/cli-client/record/submit.md @@ -44,7 +44,7 @@ iriscli record submit [flags] iriscli record submit --chain-id="test" --onchain-data="this is my on chain data" --from=node0 --fee=0.1iris ``` -在这之后你已经成功提交了一个存证，但是请记得备份你的存证ID，它是可以用来检索你的存证的唯一方法。 +运行成功以后，返回的结果如下： ```txt Password to sign with 'node0': @@ -59,3 +59,10 @@ Committed at block 72 (tx hash: 7CCC8B4018D4447E6A496923944870E350A1A3AF9E15DB15 } ``` +本次存证操作的record-id如下: + +```txt +"record-id": "record:ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6" +``` + +请务必备份record-id，以备将来查询本次存证。若丢失record-id，本次存证再也无法查询到。 From 0ff0102927ea6548becfd17b69cf9893eadb5d89 Mon Sep 17 00:00:00 2001 From: kaifei Date: Thu, 15 Nov 2018 16:27:42 +0800 Subject: [PATCH 019/100] =?UTF-8?q?IRISHUB-676=EF=BC=9Adoc=20of=20IRIS=20M?= =?UTF-8?q?onitor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/tools/Deploy-IRIS-Monitor.md | 12 +++++++----- docs/zh/tools/Deploy-IRIS-Monitor.md | 4 +++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/tools/Deploy-IRIS-Monitor.md b/docs/tools/Deploy-IRIS-Monitor.md index 574e6e2ee..2b62a9e2c 100644 --- a/docs/tools/Deploy-IRIS-Monitor.md +++ b/docs/tools/Deploy-IRIS-Monitor.md @@ -1,11 +1,13 @@ # How to deploy IRIS Monitor -Please make sure that iris is installed in your computer and added to $PATH.You can see this page for insturcion https://github.com/irisnet/irishub. You also need /bin/bash, wc, ps to ensure the monitor work properly. +Please refer to [Install-IRIS](https://github.com/irisnet/irishub/blob/master/docs/get-started/Install-Iris.md) for deatiled instructions. Besides, please make sure your machine has these commands(bash, wc, ps) installed. ## Start IRIS Monitor ``` -irismon --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --chain-id=irishub-stage --node=http://localhost:36657 +irismon --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 \ +--account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st \ +--chain-id=irishub-stage --node=http://localhost:26657 ``` Parameters： @@ -13,7 +15,7 @@ Parameters： - `address`：hex encoded validator address - `account-address`：bech32 encoded account address - `chain-id`：blockchain id that you want to monitor -- `node`：listening address of the node that you want to monitor ("tcp://localhost:26657" by default, you should not change this if you didn't modify your rpc port) +- `node`：listening address of the node that you want to monitor (The rpc url of a irishub node, default value is tcp://localhost:26657. If you want to monitor other irishub nodes, please change this value) Then you can visit `http://localhost:36660/` to see metrics data。 @@ -21,7 +23,7 @@ Then you can visit `http://localhost:36660/` to see metrics data。 ### Edit Prometheus config file -You can visit [prometheus.yml](https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus.yml) to download default `prometheus.yml` and save it. +You can visit [prometheus.yml](https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus.yml) to download default `prometheus.yml`. Then edit `prometheus.yml` and add `jobs` : @@ -41,7 +43,7 @@ Then edit `prometheus.yml` and add `jobs` : docker run -d --name=prometheus -p 9090:9090 -v ~/volumes/prometheus:/etc/prometheus prom/prometheus ``` -> The above example, the path of `prometheus.yml` is `~/volumes/prometheus` on host machine +> The above example, you can save `prometheus.yml` at `~/volumes/prometheus` on your host machine You can visit `http://localhost:9090` to see prometheus data. diff --git a/docs/zh/tools/Deploy-IRIS-Monitor.md b/docs/zh/tools/Deploy-IRIS-Monitor.md index ca3f91488..3bc7f4c96 100644 --- a/docs/zh/tools/Deploy-IRIS-Monitor.md +++ b/docs/zh/tools/Deploy-IRIS-Monitor.md @@ -5,7 +5,9 @@ ## 启动 IRIS Monitor ``` -irismon --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --chain-id=irishub-stage --node=http://localhost:36657 +irismon --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 \ +--account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st \ +--chain-id=irishub-stage --node=http://localhost:36657 ``` 参数说明： From 3cdad78397ea9437ac479099ce503824b1d8d3bb Mon Sep 17 00:00:00 2001 From: kaifei Date: Thu, 15 Nov 2018 16:41:01 +0800 Subject: [PATCH 020/100] =?UTF-8?q?IRISHUB-676=EF=BC=9Aupdate=20doc=20of?= =?UTF-8?q?=20IRIS=20Monitor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/tools/Deploy-IRIS-Monitor.md | 5 +++-- docs/zh/tools/Deploy-IRIS-Monitor.md | 5 ++++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/tools/Deploy-IRIS-Monitor.md b/docs/tools/Deploy-IRIS-Monitor.md index 2b62a9e2c..6164b8f50 100644 --- a/docs/tools/Deploy-IRIS-Monitor.md +++ b/docs/tools/Deploy-IRIS-Monitor.md @@ -1,6 +1,7 @@ # How to deploy IRIS Monitor -Please refer to [Install-IRIS](https://github.com/irisnet/irishub/blob/master/docs/get-started/Install-Iris.md) for deatiled instructions. Besides, please make sure your machine has these commands(bash, wc, ps) installed. +## Install IRIS Monitor +Please refer to this [document](https://github.com/irisnet/irishub/blob/master/docs/get-started/Install-Iris.md) for deatiled instructions. Besides, please make sure your machine has these commands(bash, wc, ps) installed. ## Start IRIS Monitor @@ -15,7 +16,7 @@ Parameters： - `address`：hex encoded validator address - `account-address`：bech32 encoded account address - `chain-id`：blockchain id that you want to monitor -- `node`：listening address of the node that you want to monitor (The rpc url of a irishub node, default value is tcp://localhost:26657. If you want to monitor other irishub nodes, please change this value) +- `node`：listening address of the node that you want to monitor (The rpc url of a irishub node, default value is tcp://localhost:26657) Then you can visit `http://localhost:36660/` to see metrics data。 diff --git a/docs/zh/tools/Deploy-IRIS-Monitor.md b/docs/zh/tools/Deploy-IRIS-Monitor.md index 3bc7f4c96..0edf5e241 100644 --- a/docs/zh/tools/Deploy-IRIS-Monitor.md +++ b/docs/zh/tools/Deploy-IRIS-Monitor.md @@ -1,6 +1,9 @@ # 如何部署 IRIS Monitor -确保已经安装了iris等工具，系统中需要有/bin/bash、wc、ps等命令。 你可以参考这个页面来安装iris工具: https://github.com/irisnet/irishub +## 安装 IRIS Monitor + +你可以参考这个页面来安装 IRIS 及 IRIS Monitor : https://github.com/irisnet/irishub/blob/master/docs/get-started/Install-Iris.md。 +另外，系统中需要有/bin/bash、wc、ps等命令。 ## 启动 IRIS Monitor From f01b97d5497817355fd63cd2261cbca4808a128b Mon Sep 17 00:00:00 2001 From: kaifei Date: Thu, 15 Nov 2018 16:43:25 +0800 Subject: [PATCH 021/100] =?UTF-8?q?IRISHUB-676=EF=BC=9Aupdate=20doc=20of?= =?UTF-8?q?=20IRIS=20Monitor=20again?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/tools/Deploy-IRIS-Monitor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/Deploy-IRIS-Monitor.md b/docs/tools/Deploy-IRIS-Monitor.md index 6164b8f50..2150be6cc 100644 --- a/docs/tools/Deploy-IRIS-Monitor.md +++ b/docs/tools/Deploy-IRIS-Monitor.md @@ -16,7 +16,7 @@ Parameters： - `address`：hex encoded validator address - `account-address`：bech32 encoded account address - `chain-id`：blockchain id that you want to monitor -- `node`：listening address of the node that you want to monitor (The rpc url of a irishub node, default value is tcp://localhost:26657) +- `node`：listening address of the node that you want to monitor (The rpc url of a irishub node, default value is tcp://localhost:26657. If you want to monitor other irishub nodes, please change this value.) Then you can visit `http://localhost:36660/` to see metrics data。 From 763b6093357ce12d8aac78cf0b7187c0729afce6 Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Thu, 15 Nov 2018 17:16:30 +0800 Subject: [PATCH 022/100] Update docs/modules/record/README.md --- docs/modules/record/README.md | 43 +++++++++++++++++++---------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/docs/modules/record/README.md b/docs/modules/record/README.md index a7ea515fe..e71ffe356 100644 --- a/docs/modules/record/README.md +++ b/docs/modules/record/README.md @@ -6,26 +6,29 @@ 2. On-Chain record for the text file (TODO) 3. On-Chain governance for the record params (TODO) -## Interaction Process +## Interaction -### Record process +### Record Introduction -1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. -2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. -3. Any users can search/download onchain based on the record ID. -4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. +Record metadata components -## Usage Scenarios +| Fields in record metadata | Description | +| ---------------------------- | ---------------------------------------- | +| record submit time | data submit time | +| record owner address | data owner's address on the target chain | +| record ID | record index ID | +| record description | data description | +| data hash | uploaded data hash | +| data size | uploaded data size | +| data | uploaded data itself | -### Build Usage Scenarios +1. Record module generates related metadata from uploaded data on the target chain, and it has the obvious advantages such as efficiency, auditability and traceability over the traditional record technologies. +2. Any users can initiate a record request. It will cost you some tokens. If there’s no identical data on the targt chain, the request will be completed successfully and the metadata of record payload will be recorded on the target chain. And you will be returned a record ID to confirm your ownership of the data. +3. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. +4. Any users can search/download onchain based on the record ID. +5. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. -``` -rm -rf iris -rm -rf .iriscli -iris init gen-tx --name=x --home=iris -iris init --gen-txs --chain-id=record-test -o --home=iris -iris start --home=iris -``` +## Usage Scenarios ### Usage Scenarios of Record on Chains @@ -37,15 +40,15 @@ Scenario 1: Record the data through cli iriscli record submit --description="test" --onchain-data=x --from=x --fee=0.04iris # Result -Committed at block 4 (tx hash: F649D5465A28842B50CAE1EE5950890E33379C45, response: {Code:0 Data:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98] Log:Msg 0: Info: GasWanted:200000 GasUsed:3857 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100]} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 109 57 51 99 103 57 54 51 56 121 115 104 116 116 100 109 119 54 57 97 121 118 51 103 106 53 102 116 116 109 108 120 51 99 102 121 107 109]} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[2 189 149 142 250 208 0]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +Committed at block 1845 (tx hash: E620F3CD62BD9128443BA168296FFECC9BE2AF8F45CF21FD8FDA609DEFA253ED, response: {Code:0 Data:[114 101 99 111 114 100 58 101 56 51 102 57 102 50 55 55 100 101 99 102 54 98 57 52 102 100 55 50 55 100 52 54 53 99 49 51 52 54 57 102 53 53 50 48 51 57 56 56 57 102 98 101 102 99 56 97 49 99 55 52 101 48 54 99 54 56 48 57 98 48 101] Log:Msg 0: Info: GasWanted:200000 GasUsed:3978 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 48 117 115 121 50 50] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 101 56 51 102 57 102 50 55 55 100 101 99 102 54 98 57 52 102 100 55 50 55 100 52 54 53 99 49 51 52 54 57 102 53 53 50 48 51 57 56 56 57 102 98 101 102 99 56 97 49 99 55 52 101 48 54 99 54 56 48 57 98 48 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 57 53 54 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) { "tags": { "action": "submit-record", - "completeConsumedTxFee-iris-atto": "\u0002\ufffd\ufffd\ufffd\ufffd\ufffd\u0000", - "ownerAddress": "faa1m93cg9638yshttdmw69ayv3gj5fttmlx3cfykm", - "record-id": "record:ab9d99d0cff653dc6e8545c8cc72e5533deaaa1255254adfd6b0074e2869661b" + "completeConsumedTxFee-iris-atto": "\"795600000000000\"", + "ownerAddress": "faa15grv3xg3ekxh9xrf79zd0w077krgv5xf0usy22", + "record-id": "record:e83f9f277decf6b94fd727d465c13469f552039889fbefc8a1c74e06c6809b0e" } - } +} # Query the Status of the Records iriscli record query --record-id=x From 2996ec1f8651665993f9960125ab63a41a79ad43 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Thu, 15 Nov 2018 17:19:47 +0800 Subject: [PATCH 023/100] Refactor the irisnet docs --- docs/.vuepress/config.js | 183 ++++++++++-- docs/cli-client/README.md | 1 + docs/cli-client/bank/README.md | 1 + docs/cli-client/gov/README.md | 1 + docs/cli-client/record/README.md | 1 + docs/cli-client/service/README.md | 1 + docs/cli-client/stake/README.md | 1 + docs/cli-client/status/README.md | 1 + docs/cli-client/tendermint/README.md | 1 + docs/cli-client/upgrade/README.md | 1 + docs/features/README.md | 13 + .../{iservice/README.md => service.md} | 0 docs/features/{iservice => }/test.proto | 0 docs/get-started/Bech32-on-IRISnet.md | 36 --- docs/get-started/Download-Rainbow.md | 5 + docs/get-started/Full-Node.md | 85 ------ .../get-started/Genesis-Generation-Process.md | 74 ----- docs/get-started/Install-Iris.md | 124 --------- docs/get-started/Install-the-Software.md | 2 + docs/get-started/Join-the-Testnet.md | 5 + docs/get-started/README.md | 45 --- docs/get-started/Validator-Node.md | 133 --------- docs/get-started/irislcd.md | 36 --- docs/introduction/README.md | 8 + docs/introduction/The-IRIS-Hub/Delegators.md | 1 + docs/introduction/The-IRIS-Hub/IRIS-Tokens.md | 1 + .../The-IRIS-Hub/Proof-of-Stake.md | 1 + docs/introduction/The-IRIS-Hub/Validators.md | 1 + docs/introduction/The-IRIS-Network/README.md | 1 + .../The-IRIS-Service/Consumers.md | 1 + .../The-IRIS-Service/Lifecycle.md | 1 + .../The-IRIS-Service/Providers.md | 1 + docs/modules/coin/README.md | 111 -------- docs/modules/fee-token/Fee.md | 23 -- docs/modules/fee-token/README.md | 58 ---- docs/modules/gov/README.md | 260 ------------------ docs/modules/iservice/README.md | 86 ------ docs/modules/iservice/test.proto | 21 -- docs/modules/record/README.md | 32 --- docs/modules/record/download.md | 40 --- docs/modules/record/query.md | 46 ---- docs/modules/record/submit.md | 61 ---- docs/modules/upgrade/README.md | 112 -------- docs/resources/README.md | 1 + .../README.md => resources/delegator-faq.md} | 0 docs/resources/validator-faq.md | 3 + .../whitepaper-en.md} | 0 docs/resources/whitepaper-kr.md | 1 + .../whitepaper-zh.md} | 0 .../key-types/genesis.md => README.md} | 0 .../{key-types => }/coin-type.md | 0 .../basic-concepts/{key-types => }/fee.md | 0 .../gov-params.md => genesis-file.md} | 0 .../{key-types/inflation.md => gov-params.md} | 0 docs/software/basic-concepts/inflation.md | 0 docs/software/monitor.md | 62 +++++ docs/tools/Deploy-IRIS-Monitor.md | 62 ----- docs/validators/FAQ.md | 58 ---- ...ow-to-participate-in-onchain-governance.md | 198 ------------- docs/validators/README.md | 154 ----------- docs/validators/Setup-Sentry-Node.md | 59 ---- 61 files changed, 273 insertions(+), 1941 deletions(-) create mode 100644 docs/cli-client/bank/README.md create mode 100644 docs/cli-client/gov/README.md create mode 100644 docs/cli-client/record/README.md create mode 100644 docs/cli-client/service/README.md create mode 100644 docs/cli-client/stake/README.md create mode 100644 docs/cli-client/status/README.md create mode 100644 docs/cli-client/tendermint/README.md create mode 100644 docs/cli-client/upgrade/README.md create mode 100644 docs/features/README.md rename docs/features/{iservice/README.md => service.md} (100%) rename docs/features/{iservice => }/test.proto (100%) delete mode 100644 docs/get-started/Bech32-on-IRISnet.md create mode 100644 docs/get-started/Download-Rainbow.md delete mode 100644 docs/get-started/Full-Node.md delete mode 100644 docs/get-started/Genesis-Generation-Process.md delete mode 100644 docs/get-started/Install-Iris.md create mode 100644 docs/get-started/Install-the-Software.md create mode 100644 docs/get-started/Join-the-Testnet.md delete mode 100644 docs/get-started/Validator-Node.md delete mode 100644 docs/get-started/irislcd.md create mode 100644 docs/introduction/README.md create mode 100644 docs/introduction/The-IRIS-Hub/Delegators.md create mode 100644 docs/introduction/The-IRIS-Hub/IRIS-Tokens.md create mode 100644 docs/introduction/The-IRIS-Hub/Proof-of-Stake.md create mode 100644 docs/introduction/The-IRIS-Hub/Validators.md create mode 100644 docs/introduction/The-IRIS-Network/README.md create mode 100644 docs/introduction/The-IRIS-Service/Consumers.md create mode 100644 docs/introduction/The-IRIS-Service/Lifecycle.md create mode 100644 docs/introduction/The-IRIS-Service/Providers.md delete mode 100644 docs/modules/coin/README.md delete mode 100644 docs/modules/fee-token/Fee.md delete mode 100644 docs/modules/fee-token/README.md delete mode 100644 docs/modules/gov/README.md delete mode 100644 docs/modules/iservice/README.md delete mode 100644 docs/modules/iservice/test.proto delete mode 100644 docs/modules/record/README.md delete mode 100644 docs/modules/record/download.md delete mode 100644 docs/modules/record/query.md delete mode 100644 docs/modules/record/submit.md delete mode 100644 docs/modules/upgrade/README.md rename docs/{delegators/README.md => resources/delegator-faq.md} (100%) create mode 100644 docs/resources/validator-faq.md rename docs/{introduction/Whitepaper.md => resources/whitepaper-en.md} (100%) create mode 100644 docs/resources/whitepaper-kr.md rename docs/{introduction/Whitepaper_CN.md => resources/whitepaper-zh.md} (100%) rename docs/software/{basic-concepts/key-types/genesis.md => README.md} (100%) rename docs/software/basic-concepts/{key-types => }/coin-type.md (100%) rename docs/software/basic-concepts/{key-types => }/fee.md (100%) rename docs/software/basic-concepts/{key-types/gov-params.md => genesis-file.md} (100%) rename docs/software/basic-concepts/{key-types/inflation.md => gov-params.md} (100%) create mode 100644 docs/software/basic-concepts/inflation.md delete mode 100644 docs/tools/Deploy-IRIS-Monitor.md delete mode 100644 docs/validators/FAQ.md delete mode 100644 docs/validators/How-to-participate-in-onchain-governance.md delete mode 100644 docs/validators/README.md delete mode 100644 docs/validators/Setup-Sentry-Node.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 5ae9e920e..d1fcd7145 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -5,52 +5,181 @@ module.exports = { themeConfig: { displayAllHeaders: false, nav: [ - { text: 'Back to IRISnet', link: 'https://www.irisnet.org' } + { text: 'Back to IRISnet', link: 'https://www.irisnet.org' }, + { text: 'Introduction', link:'/introduction/' }, + { text: 'Software', link:'/software/' }, + { text: 'Getting Started', link:'/get-started/' }, + { text: 'Features', link:'/features/' }, + { text: 'CLI Client', link:'/cli-client/' }, + { text: 'Light Client', link:'/light-client/' }, + { text: 'Resources', link:'/resources/' }, ], - sidebar: [ + sidebar: { + '/introduction/':[{ + title: 'The IRIS Hub', + collapsable: false, + children: [ + 'The-IRIS-Hub/Proof-of-Stake.md', + 'The-IRIS-Hub/IRIS-Tokens.md', + 'The-IRIS-Hub/Validators.md', + 'The-IRIS-Hub/Delegators.md' + ] + }, + { + title: 'The IRIS Service', + collapsable: false, + children: [ + 'The-IRIS-Service/Lifecycle.md', + 'The-IRIS-Service/Providers.md', + 'The-IRIS-Service/Consumers.md', + ] + }, { - title: 'Introduction', + title: 'The IRIS Network', collapsable: false, children: [ - ['/introduction/Whitepaper.md', 'Whitepaper - English'], - ['/introduction/Whitepaper_CN.md', 'Whitepaper - 中文'] + 'The-IRIS-Network/' + ] + }], + '/software/':[{ + title: 'Basic Concepts', + collapsable: false, + children: [ + ["basic-concepts/coin-type.md",'Coin Type'], + ["basic-concepts/fee.md",'Fee'], + ["basic-concepts/inflation.md",'Infation'], + ["basic-concepts/bech32-prefix.md",'Bech32 Prefix'], + ["basic-concepts/genesis-file.md", 'Genesis File'], + ["basic-concepts/gov-params.md",'Gov Params'] ] },{ - title: 'Getting Started', + title: 'Node', collapsable: false, children: [ - ['/get-started/', 'Join the Testnet'], - ['/get-started/Install-Iris.md', 'Install'], - ['/get-started/Full-Node.md', 'Run a Full Node'], - ['/get-started/Validator-Node.md', 'Run a Validator Node'], - ['/get-started/Genesis-Generation-Process.md', 'Genesis Generation'], - ['/get-started/Bech32-on-IRISnet.md', 'Bech32 on IRISnet'], + ['node.md','Node'] ] },{ - title: 'Modules', + title: 'CLI Client', collapsable: false, children: [ - // ['/modules/coin/README.md', 'Coin Type'], - ['/modules/fee-token/', 'Fee Token'] - // ['/modules/gov/README.md', 'Governance'] + ['cli-client.md','CLI Client'] ] },{ - title: 'Tools', + title: 'Light Client', collapsable: false, children: [ - ['/tools/Deploy-IRIS-Monitor.md', 'Monitor'] + ['light-client.md', 'Light Client'] ] },{ - title: 'Validators', + title: 'Monitor', + collapsable: false, + children: [ + ['monitor.md', 'Monitor'] + ] + }], + '/get-started/':[{ + title: 'Getting Started', + collapsable: false, + children: [ + ['Download-Rainbow.md','Download Rainbow'], + ['Install-the-Software.md', 'Install the Software'], + ['Join-the-Testnet.md','Join the Testnet'] + ] + }], + '/features/':[{ + title: 'Features', + collapsable: false, + children: [ + ['bank.md','Bank'], + ['stake.md','Stake'], + ['service.md','Service'], + ['record.md','Record'], + ['governance.md','Governance'], + ['upgrade.md','Upgrade'], + ['distribution.md','Distribution'], + ] + }], + '/cli-client/':[{ + title: 'Status', + collapsable: false, + children: [ + ['status/', 'iriscli status'] + ] + }, + { + title: 'Tendermint', + collapsable: false, + children: [ + ['tendermint/', 'iriscli tendermint'] + ] + }, + { + title: 'Keys', + collapsable: false, + children: [ + ['keys/','iriscli keys'] + ] + }, + { + title: 'Bank', + collapsable: false, + children: [ + ['bank/','iriscli bank'] + ] + }, + { + title: 'Stake', + collapsable: false, + children: [ + ['stake/','iriscli stake'] + ] + }, + { + title: 'Gov', + collapsable: false, + children: [ + ['gov/','iriscli gov'] + ] + }, + { + title: 'Record', + collapsable: false, + children: [ + ['record/', 'iriscli record'] + ] + }, + { + title: 'Upgrade', + collapsable: false, + children: [ + ['upgrade/', 'iriscli upgrade'] + ] + }, + { + title: 'Service', + collapsable: false, + children: [ + ['service/', 'iriscli service'] + ] + }], + '/light-client/':[{ + title: 'Light Client', + collapsable: false, + children: [ + ['','Light Client'] + ] + }], + '/resources/':[{ + title: 'Resources', collapsable: false, children: [ - ['/validators/', 'Overview'], - ['/validators/Setup-Sentry-Node.md', 'Sentry Node'], - ['/validators/How-to-participate-in-onchain-governance.md', 'Onchain Governance'], - ['/validators/FAQ.md', 'FAQ'] + ['validator-faq.md','Validator FAQ'], + ['delegator-faq.md','Delegator FAQ'], + ['whitepaper-zh.md','Whitepaper ZH'], + ['whitepaper-en.md','Whitepaper EN'], + ['whitepaper-kr.md','Whitepaper KR'], ] - } - ] + }] + } } -} - +} \ No newline at end of file diff --git a/docs/cli-client/README.md b/docs/cli-client/README.md index e69de29bb..c1901202e 100644 --- a/docs/cli-client/README.md +++ b/docs/cli-client/README.md @@ -0,0 +1 @@ +# CLi Client diff --git a/docs/cli-client/bank/README.md b/docs/cli-client/bank/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/cli-client/bank/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/cli-client/gov/README.md b/docs/cli-client/gov/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/cli-client/gov/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/cli-client/record/README.md b/docs/cli-client/record/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/cli-client/record/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/cli-client/service/README.md b/docs/cli-client/service/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/cli-client/service/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/cli-client/stake/README.md b/docs/cli-client/stake/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/cli-client/stake/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/cli-client/status/README.md b/docs/cli-client/status/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/cli-client/status/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/cli-client/tendermint/README.md b/docs/cli-client/tendermint/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/cli-client/tendermint/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/cli-client/upgrade/README.md b/docs/cli-client/upgrade/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/cli-client/upgrade/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/features/README.md b/docs/features/README.md new file mode 100644 index 000000000..74212951c --- /dev/null +++ b/docs/features/README.md @@ -0,0 +1,13 @@ +# Features + +## Bank + +## Stake + +## Service + +## Record + +## Governance + +## Distribution \ No newline at end of file diff --git a/docs/features/iservice/README.md b/docs/features/service.md similarity index 100% rename from docs/features/iservice/README.md rename to docs/features/service.md diff --git a/docs/features/iservice/test.proto b/docs/features/test.proto similarity index 100% rename from docs/features/iservice/test.proto rename to docs/features/test.proto diff --git a/docs/get-started/Bech32-on-IRISnet.md b/docs/get-started/Bech32-on-IRISnet.md deleted file mode 100644 index a62927bb4..000000000 --- a/docs/get-started/Bech32-on-IRISnet.md +++ /dev/null @@ -1,36 +0,0 @@ -# Bech32 on IRISnet - -Bech32 is a new Bitcoin address format proposed by Pieter Wuille and Greg Maxwell. Besides Bitcoin addresses, Bech32 can encode any short binary data. In the IRIS network, keys and addresses may refer to a number of different roles in the network like accounts, validators etc. The IRIS network is designed to use the Bech32 address format to provide robust integrity checks on data. The human readable part(HRP) makes it more efficient to read and the users could see error messages. - - -## Human Readable Part Table - - -| HRP | Definition | -| ------------- |:-------------:| -|faa |IRISnet Account Address| -|fap| IRISnet Account Public Key| -|fva |IRISnet Consensus Address| -|fvp| IRISnet Consensus Public Key| - -## Separator - -Why include a separator in addresses? That way the human-readable part is unambiguously separated from the data part, avoiding potential collisions with other human-readable parts that share a prefix. It also allows us to avoid having character-set restrictions on the human-readable part. The separator is 1 because using a non-alphanumeric character would complicate copy-pasting of addresses (with no double-click selection in several applications). Therefore an alphanumeric character outside the normal character set was chosen. - -## Encoding - -Not all interfaces to users IRISnet should be exposed as bech32 interfaces. Many address are still in hex or base64 encoded form. - -To covert between other binary reprsentation of addresses and keys, it is important to first apply the Amino enocoding process before bech32 encoding. - - -## Example - -Once you create a new address, you should see the following: - -` -NAME: TYPE: ADDRESS: PUBKEY: -test1 local faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv -` - -This means you have created a new address `faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl`, its hrp is `faa`. And its public key could be encoded into `fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv`, its hrp is `fap`. \ No newline at end of file diff --git a/docs/get-started/Download-Rainbow.md b/docs/get-started/Download-Rainbow.md new file mode 100644 index 000000000..dd91119ee --- /dev/null +++ b/docs/get-started/Download-Rainbow.md @@ -0,0 +1,5 @@ +# IRISnet Testnet Codename Fuxi + +## What is IRISnet + +IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. diff --git a/docs/get-started/Full-Node.md b/docs/get-started/Full-Node.md deleted file mode 100644 index 419a56454..000000000 --- a/docs/get-started/Full-Node.md +++ /dev/null @@ -1,85 +0,0 @@ -# Setup A Full-node - -Before setting up your validator node, make sure you already had **Iris** installed by following this [guide](Install-Iris.md) - -## Init Your Node - -These instructions are for setting up a brand new full node from scratch. - -First, initialize the node and create the necessary config files: - -``` -iris init --name= --home=$IRISHOME -``` - -> Note: Only ASCII characters are supported for the `--name`. Using Unicode characters will render your node unreachable. - -The default \$IRISHOME is `~/.iris` , You can edit this `name` later, in the `~/.iris/config/config.toml` file: - -Your full node has been initialized! - -## Get Configuration Files - - -After intializing your node, please download the genesis file and the config file to join in the testnet. - -``` -cd $IRISHOME/config/ -rm genesis.json -rm config.toml -wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/config.toml -wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/genesis.json -``` -## Edit Your Config File - -You could customized the `moniker` and `external_address` fields. - -``` -# A custom human readable name for this node -moniker = "" -external_address = "your-public-IP:26656" -``` - - -Optional: -Set `addr_book_strict` to `false` to make peering more easily. - -``` -addr_book_strict = false -``` - - -### Add Seed Nodes - -Your node needs to know how to find more peers. You'll need to add healthy seed nodes to `$IRISHOME/config/config.toml`. Here are some seed nodes you can use: - -``` -c16700520a810b270206d59f0f02ea9abd85a4fe@ts-1.bianjie.ai:26656 -a12cfb2f535210ea12731f94a76b691832056156@ts-2.bianjie.ai:26656 -``` - -Meanwhile, you could add some known full node as `Persistent Peer`. Your node could connect to `sentry node` as `persistent peers`. - - -### Enable Port - -You will need to set `26656` port to get connected with other peers and `26657` to query information of Tendermint. - -## Run a Full Node - -Start the full node with this command: - -``` -iris start --home=$IRISHOME > iris.log -``` - -Check that everything is running smoothly: - -``` -iriscli status -``` -You could see the following -``` -{"node_info":{"id":"1c40d19d695721fc3e3ce44cbc3f446f038b36e4","listen_addr":"172.31.0.190:46656","network":"iris-stage-4","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:46657"]},"sync_info":{"latest_block_hash":"41117D8CB54FA54EFD8DEAD81D6D83BDCE0E63AC","latest_app_hash":"95D82B8AC8B64C4CD6F85C1D91F999C2D1DA4F0A","latest_block_height":"1517","latest_block_time":"2018-09-07T05:44:27.810641328Z","catching_up":false},"validator_info":{"address":"3FCCECF1A27A9CEBD394F3A0C5253ADAA8392EB7","pub_key":{"type":"tendermint/PubKeyEd25519","value":"wZp1blOEwJu4UuqbEmivzjUMO1UwUK4C0jRH96HhV90="},"voting_power":"100"}} -``` -If you see the `catching_up` is `false`, it means your node is fully synced with the network, otherwise your node is still downloading blocks. Once fully synced, you could upgrade your node to a validator node. The instructions is in [here](Validator-Node.md). \ No newline at end of file diff --git a/docs/get-started/Genesis-Generation-Process.md b/docs/get-started/Genesis-Generation-Process.md deleted file mode 100644 index 9cf6282d1..000000000 --- a/docs/get-started/Genesis-Generation-Process.md +++ /dev/null @@ -1,74 +0,0 @@ -# How To Participate in Genesis Process - -## Requirements - -You must have follow this [guide](Install-Iris.md) to install the correct version of **Iris**. - -## Gentx - -Please run the `gen-tx` command to generate files. - - -``` -iris init gen-tx --name=your_name --home=path_to_home --ip=Your_public_IP -``` - -You could see the following output: - -``` -{ - "app_message": { - "secret": "artist green between expand license credit dinner link confirm web tell trip north web crouch february item level crop bullet fancy mixed behind anxiety" - }, - "gen_tx_file": { - "node_id": "b272ea8a29f5b21dfb4587968f22a5612c6b120a", - "ip": "192.168.1.7", - "validator": { - "pub_key": { - "type": "tendermint/PubKeyEd25519", - "value": "0CtwpyEviDneH7uQUL5a+e+cTqJC0sciZSJk21moH8Y=" - }, - "power": "100", - "name": "" - }, - "app_gen_tx": { - "name": "name", - "address": "faa1nnlmkvfmdvn7efwqz7eyur9rszdw723adx2mcx", - "pub_key": "fap1zcjduepq6q4hpfep97yrnhslhwg9p0j6l8hecn4zgtfvwgn9yfjdkkdgrlrqftg82c" - } - } -} -``` - -The `app_message` contains the seed phrase to recover the account of `address` field you just created. -There will be a gentx-node-ID.json a file at `$IRISHOME/config/gentx/`. - -The content of the file will be: - -``` -{ - "node_id": "b272ea8a29f5b21dfb4587968f22a5612c6b120a", - "ip": "192.168.1.7", - "validator": { - "pub_key": { - "type": "tendermint/PubKeyEd25519", - "value": "0CtwpyEviDneH7uQUL5a+e+cTqJC0sciZSJk21moH8Y=" - }, - "power": "100", - "name": "" - }, - "app_gen_tx": { - "name": "name", - "address": "faa1nnlmkvfmdvn7efwqz7eyur9rszdw723adx2mcx", - "pub_key": "fap1zcjduepq6q4hpfep97yrnhslhwg9p0j6l8hecn4zgtfvwgn9yfjdkkdgrlrqftg82c" - } -``` -validator is generated by \$IRISHOME/config/priv_validator.json - -## Submit Gentx - -Submit your `gentx-.json` to `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gentx/` by createing a pull request. - -After the team has collected all the gen-tx transactions, we will publish the genesis file in the following folder: `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/` - -You could then download the final genesis file and start a node. diff --git a/docs/get-started/Install-Iris.md b/docs/get-started/Install-Iris.md deleted file mode 100644 index 4e80d1861..000000000 --- a/docs/get-started/Install-Iris.md +++ /dev/null @@ -1,124 +0,0 @@ -# Install Iris - -### Step 1: Configure Your Server - -All the blockchains in IRISnet is based on Cosmos-SDK, which is a framework for building blockchain applications in Golang. It is being used to build [Cosmos Hub](https://cosmos.network/). It's recommended to run a validator node on Linux server. - -**Recommanded Configurations:** - -1. 2 CPU -2. Memory: 4GB -3. Disk: 60GB SSD -4. OS: Ubuntu 16.04 LTS -5. Allow all incoming connections on TCP port 26656 and 26657 - -### Step 2: Install Iris - -There are two ways to get Iris running on your server. You can download the binary files from our release pages, or you can download the source code and compile it locally. - -#### Download Binary Directly - -Go to the download page: - -https://github.com/irisnet/irishub/releases/ - -then get the release v0.6.0 on your computer. -`unzip -C /usr/local/bin iris$VERSION.$OS-$ARCH.zip` to `/usr/local/bin/ ` - -You can verify you have the right version installed by running the following commands: - -``` -$ iris version -v0.6.0 - -$ iriscli version -v0.6.0 -``` - -#### Compile Source Code - -- Install Go 1.10+ - -``` -$ sudo add-apt-repository ppa:gophers/archive -$ sudo apt-get update -$ sudo apt-get install golang-1.10-go -``` - -> Note that golang-1.10-go puts binaries in /usr/lib/go-1.10/bin. If you want them on your PATH, you need to make that change yourself. - -Using snaps also works quite well: - -``` -This will give you the latest version of go -$ sudo snap install --classic go -``` - -> A restart is required for the command to be recognized. - -Then you need to verify the versions of Go: - -``` -$ go version -go version go1.10.3 darwin/amd64 -``` - -Then, you need to add `GOPATH` to system `PATH` , then your system could correctly compile the code. - -Open your `.profile` in your home directory. Add the following lines at the end of file: - -``` -GOPATH=$HOME/go -PATH=$GOPATH/bin:$PATH -``` - -Save the file and exit the editor. Then run the following to make your bash reload your profile configurations. - -``` -$ source $HOME/.profile -``` - -Now you should see something like this if you echo your\$GOPATH and \$PATH variables - -``` -$ echo $GOPATH -/home/iris/go -$ echo $PATH -/home/isir/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin -``` - -- Get the code and compile Iris - -After setup Go correctly, you should be able to compile and run **Iris**. -Make sure that you can access to google.com for that our project used some libraries provided by google. -``` -mkdir -p $GOPATH/src/github.com/irisnet -cd $GOPATH/src/github.com/irisnet -git clone https://github.com/irisnet/irishub -cd irishub && git checkout v0.6.0 -curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh -make get_tools && get_vendor_deps && make install -``` - -If your environment variables have set up correctly, you should not get any errors by running the above commands. -Now check your **Iris** version. - -``` -$ iris version -v0.6.0 -$ iriscli version -v0.6.0 -``` - -### How to Update - -Get latest code (you can also `git fetch` only the version desired), ensure the dependencies are up to date, then recompile. - -``` -cd $GOPATH/src/github.com/irisnet/irishub -git fetch -a origin -rm Gopkg.lock -git checkout v0.6.0 -make get_vendor_deps -make install -``` \ No newline at end of file diff --git a/docs/get-started/Install-the-Software.md b/docs/get-started/Install-the-Software.md new file mode 100644 index 000000000..d9786f2a0 --- /dev/null +++ b/docs/get-started/Install-the-Software.md @@ -0,0 +1,2 @@ +# IRISnet Testnet Codename Fuxi + diff --git a/docs/get-started/Join-the-Testnet.md b/docs/get-started/Join-the-Testnet.md new file mode 100644 index 000000000..dd91119ee --- /dev/null +++ b/docs/get-started/Join-the-Testnet.md @@ -0,0 +1,5 @@ +# IRISnet Testnet Codename Fuxi + +## What is IRISnet + +IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. diff --git a/docs/get-started/README.md b/docs/get-started/README.md index 5ca83a259..dd91119ee 100644 --- a/docs/get-started/README.md +++ b/docs/get-started/README.md @@ -3,48 +3,3 @@ ## What is IRISnet IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. - -## How to Join Fuxi Testnet - -### Step 1: Install Iris on Your Server - -Please follow this [instruction](Install-Iris.md) to get **Iris** installed locally. - -### Step 2: Run a Full Node - -Please follow this [instruction](Full-Node.md) to get your full node running. - - -### Step 3: Upgrade to Validator Node - -Please follow this [instruction](Validator-Node.md) to upgrade your full node to validator node. - -### Deploy IRISHub Monitor - -Please follow this [guide](../tools/Deploy-IRIS-Monitor.md) to get IRIHub monitor running on your side. - - -### Upgrade to Validator Node - -You now have an active full node. What's the next step? - -If you have participated in the genesis file generation process, you should be a validator once you are fully synced. - -If you miss the genesis file generation process, you can still upgrade your full node to become a IRISnet Validator. The top 100 validators have the ability to propose new blocks to the IRIS Hub. Continue onto [the Validator Setup](Validator-Node.md). - -### Setup a sentry node - -A validator is under the risk of being attacked. You could follow this [guide](../validators/Setup-Sentry-Node.md) to setup a sentry node to protect yourself. - -## Fuxi Incentivized Testnet -IRIS foundation plans to reward all the testnet participants who took part in the testnet. In Fuxi-3001 testnet,the community members have finished the tasks and they will receive their rewards in genesis allocation. -* Task List for Fuxi-3001： https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-3001/README.md -* Results：https://github.com/irisnet/testnets/issues/125 -To get more people involved, IRIS foundation decides to send out more tasks in the latest iteration of testnet:Fuxi-4001. -* Task List for Fuxi-4000: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-4000/README.md - -## Useful Links - -* Riot chat: #irisvalidators:matrix.org - -* Explorer: https://testnet.irisplorer.io/#/home \ No newline at end of file diff --git a/docs/get-started/Validator-Node.md b/docs/get-started/Validator-Node.md deleted file mode 100644 index f079481aa..000000000 --- a/docs/get-started/Validator-Node.md +++ /dev/null @@ -1,133 +0,0 @@ -# Running a Validator Node - -Before setting up your validator node, make sure you've already installed **Iris** by this [guide](Full-Node.md) - -Validators are responsible for committing new blocks to the blockchain through consensus. A validator's stake will be slashed if they become unavailable, double sign a transaction, or don't cast their votes. Please read about Sentry Node Architecture to protect your node from DDOS attacks and to ensure high-availability. - -## Get IRIS Token - -### Create Account - -You need to get `iris` and `iriscli` installed first. Then, follow the instructions below to create a new account: - -``` -iriscli keys add -``` - -Then, you should set a password of at least 8 characters. - -The output will look like the following: -``` -NAME: TYPE: ADDRESS: PUBKEY: -tom local faa1arlugktm7p64uylcmh6w0g5m09ptvklxm5k69x fap1addwnpepqvlmtpv7tke2k93vlyfpy2sxup93jfulll6r3jty695dkh09tekrzagazek -**Important** write this seed phrase in a safe place. -It is the only way to recover your account if you ever forget your password. - -blast change tumble toddler rival ordinary chicken dirt physical club few language noise oak moment consider enemy claim elephant cruel people adult peanut garden -``` - -You could see the address and public key of this account. Please node that account address in IRISnet will start with `faa` and public key of account will start with `fap`. - -The seed phrase of this account will also be displayed. You could use these 24 phrases to recover this account in another server. The recover command is: -``` -iriscli keys add --recover -``` - - -### Claim tokens - -You can always get some `IRIS` by using the [Faucet](https://testnet.irisplorer.io/#/faucet). The faucet will send you 10IRIS every request, Please don't abuse it. - -Once you have created your own address, please then you could use this　account to stake as a validatord. The following command is used to check the balance of your account: -``` -iriscli bank account --node=http://localhost:26657 -``` - -## Create Validator - -### Confirm Your Validator is Synced - -Your validator is active if the following command returns anything: - -``` -iriscli status --node=tcp://localhost:26657 -``` - -You should also be able to see `catching_up` is `false`. - -You need to get the public key of your node before upgrade your node to a validator node. The public key of your node starts with `fvp`, -it can be used to create a new validator by staking tokens. To understand more about the address encoding in IRISHub, -please read this [doc](Bech32-on-IRISnet.md) - -You can find your validator's pubkey by running: - -``` -iris tendermint show_validator --home= -``` -Example output: -``` -fvp1zcjduepqv7z2kgussh7ufe8e0prupwcm7l9jcn2fp90yeupaszmqjk73rjxq8yzw85 -``` -Next, use the output as `` field for `iriscli stake create-validator` command: - - -``` -iriscli stake create-validator --amount=XXiris --pubkey= --moniker= --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --node=http://localhost:26657 -``` -Please note the **fee** can be the **decimal** of IRIS token, like `0.01iris`. And you could also use other coin-type like `iris-milli` - -To read more about fee mechanism in IRISHub, go to this [doc](../modules/fee-token/Fee.md) - - -In this way, to stake 1IRIS, you need to do: - -``` -iriscli stake create-validator --pubkey=pubkey --fee=0.05iris --gas=2000000 --from= --chain-id=fuxi-4000 --node=tcp://localhost:26657 --amount=1iris -``` -Don't forget the `fee` and `gas` field. To read more about coin-type in IRISHub, you should read [this](../zh/modules/coin/README.md) - - - -### View Validator Info - -View the validator's information with this command: - -``` -iriscli stake validator --chain-id=fuxi-4000 --node=tcp://localhost:26657 -``` - -The `` is your account address that starts with 'faa1' - - -### Confirm Your Validator is Running - -Your validator is active if the following command returns anything: - -``` -iriscli status --node=tcp://localhost:26657 -``` - -You should also be able to see your power is above 0 if your bonded toke is in top 100. Also, you should see validator on the [Explorer](https://testnet.irisplorer.io). - - -### Edit Validator Description - -You can edit your validator's public description. This info is to identify your validator, and will be relied on by delegators to decide which validators to stake to. Make sure to provide input for every flag below, otherwise the field will default to empty (`--moniker`defaults to the machine name). - -You should put your name of your team in `details`. - -``` -iriscli stake edit-validator --from= < name > --moniker="choose a moniker" --website="https://irisnet.org" --details="team" --chain-id=fuxi-4000 - --details="details"--node=tcp://localhost:26657 --fee=0.04iris --gas=2000000 -``` -### View Validator Description - -View the validator's information with this command: - -``` -iriscli stake validator --chain-id=fuxi-4000 -``` - -### Use IRISPlorer - -You should also be able to see your validator on the [Explorer](https://testnet.irisplorer.io). You are looking for the `bech32` encoded `address` in the `~/.iris/config/priv_validator.json` file. diff --git a/docs/get-started/irislcd.md b/docs/get-started/irislcd.md deleted file mode 100644 index 557fd2fd4..000000000 --- a/docs/get-started/irislcd.md +++ /dev/null @@ -1,36 +0,0 @@ -# What is Irislcd - -An irislcd node is a REST server which can connect to any full nodes and provide a set of rest APIs. By these APIs, users can send transactions and query blockchain data. Irislcd can verify the proof of query result. So it can provide the same security as a full node with the minimal requirements on bandwidth, computing and storage resource. Besides, it also provides swagger-ui which presents detailed description about what APIs it provides and how to use them. - -## Irislcd options - -To start a irislcd, we need to specify the following parameters: - -| Parameter | Type | Default | Required | Description | -| --------------- | --------- | ----------------------- | -------- | ---------------------------------------------------- | -| chain-id | string | null | true | Chain ID of Tendermint node | -| home | string | "$HOME/.irislcd" | false | Directory for config and data, such as key and checkpoint | -| node | string | "tcp://localhost:26657" | false | Full node to connect to | -| laddr | string | "tcp://localhost:1317" | false | Address for server to listen on | -| trust-node | bool | false | false | Trust connected full nodes (Don't verify proofs for responses) | -| max-open | int | 1000 | false | The number of maximum open connections | -| cors | string | "" | false |Set the domains that can make CORS requests | - -## Start Irislcd - -Sample command to start irislcd: -``` -irislcd start --chain-id= -``` -Please visit the following url with in your internet explorer to open Swagger-UI: -``` -http://localhost:1317/swagger-ui/ -``` -Execute the following command to print the irislcd version. -``` -irislcd version -``` - -When the connected full node is trusted, then the proof is not necessary, so you can run irislcd with trust-node option: -``` -irislcd start --chain-id= --trust-node \ No newline at end of file diff --git a/docs/introduction/README.md b/docs/introduction/README.md new file mode 100644 index 000000000..857e7dd82 --- /dev/null +++ b/docs/introduction/README.md @@ -0,0 +1,8 @@ +# Introduction + +## The IRIS hub + +## The IRIS Service + +## The IRIS Network + diff --git a/docs/introduction/The-IRIS-Hub/Delegators.md b/docs/introduction/The-IRIS-Hub/Delegators.md new file mode 100644 index 000000000..c8b484c90 --- /dev/null +++ b/docs/introduction/The-IRIS-Hub/Delegators.md @@ -0,0 +1 @@ +# Delegators diff --git a/docs/introduction/The-IRIS-Hub/IRIS-Tokens.md b/docs/introduction/The-IRIS-Hub/IRIS-Tokens.md new file mode 100644 index 000000000..61d1755e3 --- /dev/null +++ b/docs/introduction/The-IRIS-Hub/IRIS-Tokens.md @@ -0,0 +1 @@ +# IRIS Tokens diff --git a/docs/introduction/The-IRIS-Hub/Proof-of-Stake.md b/docs/introduction/The-IRIS-Hub/Proof-of-Stake.md new file mode 100644 index 000000000..7ec980837 --- /dev/null +++ b/docs/introduction/The-IRIS-Hub/Proof-of-Stake.md @@ -0,0 +1 @@ +# Proof of Stake diff --git a/docs/introduction/The-IRIS-Hub/Validators.md b/docs/introduction/The-IRIS-Hub/Validators.md new file mode 100644 index 000000000..e41e267fe --- /dev/null +++ b/docs/introduction/The-IRIS-Hub/Validators.md @@ -0,0 +1 @@ +# Validators diff --git a/docs/introduction/The-IRIS-Network/README.md b/docs/introduction/The-IRIS-Network/README.md new file mode 100644 index 000000000..8756dfd6a --- /dev/null +++ b/docs/introduction/The-IRIS-Network/README.md @@ -0,0 +1 @@ +# The IRIS Network diff --git a/docs/introduction/The-IRIS-Service/Consumers.md b/docs/introduction/The-IRIS-Service/Consumers.md new file mode 100644 index 000000000..3476d964e --- /dev/null +++ b/docs/introduction/The-IRIS-Service/Consumers.md @@ -0,0 +1 @@ +# Consumers diff --git a/docs/introduction/The-IRIS-Service/Lifecycle.md b/docs/introduction/The-IRIS-Service/Lifecycle.md new file mode 100644 index 000000000..75a17e1af --- /dev/null +++ b/docs/introduction/The-IRIS-Service/Lifecycle.md @@ -0,0 +1 @@ +# Lifecycle diff --git a/docs/introduction/The-IRIS-Service/Providers.md b/docs/introduction/The-IRIS-Service/Providers.md new file mode 100644 index 000000000..ae4c68601 --- /dev/null +++ b/docs/introduction/The-IRIS-Service/Providers.md @@ -0,0 +1 @@ +# Providers diff --git a/docs/modules/coin/README.md b/docs/modules/coin/README.md deleted file mode 100644 index 3656537eb..000000000 --- a/docs/modules/coin/README.md +++ /dev/null @@ -1,111 +0,0 @@ -# Coin_Type - -## Definitions - -Coin_type defines the available units of a kind of token in IRISnet. The developers can specify different coin_type for their tokens. The native token in IRIShub is `iris`, which has following available units: `iris-milli`, `iris-micro`, `iris-nano`, `iris-pico`, `iris-femto` and `iris-atto`. The conversion relationship between them are as follows: - -``` -1 iris = 10^3 iris-milli -1 iris = 10^6 iris-micro -1 iris = 10^9 iris-nano -1 iris = 10^12 iris-pico -1 iris = 10^15 iris-femto -1 iris = 10^18 iris-atto -``` - -All the registered types of `iris` in the system can be used with transactions. - -## Data Structure of coin_type - -```golang -type CoinType struct { - Name string `json:"name"` - MinUnit Unit `json:"min_unit"` - Units Units `json:"units"` - Origin Origin `json:"origin"` - Desc string `json:"desc"` -} -``` - -## Structure definition of Unit - -```golang -type Unit struct { - Denom string `json:"denom"` - Decimal int `json:"decimal"` -} -``` - -* Name : The name of a token, which is also its default unit；for instance,the default unit of `iris` is `iris`. -* MinUnit：The minimum unit of coin_type. - -The tokens in the system are all stored in the form of minimum unit, -such as `iris-atto`. You could choose to use the minimum unit of the tokens when sending a transaction to the IRIShub. -If you use the command line client, aka `iriscli`, you can use any system-recognized unit and the system -will automatically convert to the minimum unit of this corresponding token. For example, if you execute `send`command -to transfer 1iris, the command line will be processed as 10^18 iris-attos in the backend, and you will only -see 10^18 `iris-attos` when searching the transaction details by transaction hash. - - - -`Denom` is defined as the name of this unit, and `Decimal` is defined as the precision of the unit. - -For example, the precision of iris-atto is 18. - -* `Unit` defines a set of units available under coin_type. -* `Origin` defines the source of the coin_type, with the value `Native` (inner system, iris for IRIShub), -`External` (external system, such as eth for Ethereum, etc.), and `UserIssued` (user-defined). -* `Desc`：Description of the coin_type. - -## Query of coin_type - -If you want to query the coin_type configuration of a certain token, you can use the following command: - -```golang -iriscli bank coin-type [coin_name] -``` - -If you query the `coin-type` of `iris` with `iriscli bank coin-type iris` - -Example output: -```$xslt -{ - "name": "iris", - "min_unit": { - "denom": "iris-atto", - "decimal": "18" - }, - "units": [ - { - "denom": "iris", - "decimal": "0" - }, - { - "denom": "iris-milli", - "decimal": "3" - }, - { - "denom": "iris-micro", - "decimal": "6" - }, - { - "denom": "iris-nano", - "decimal": "9" - }, - { - "denom": "iris-pico", - "decimal": "12" - }, - { - "denom": "iris-femto", - "decimal": "15" - }, - { - "denom": "iris-atto", - "decimal": "18" - } - ], - "origin": 1, - "desc": "IRIS Network" -} -``` \ No newline at end of file diff --git a/docs/modules/fee-token/Fee.md b/docs/modules/fee-token/Fee.md deleted file mode 100644 index 64b2587f2..000000000 --- a/docs/modules/fee-token/Fee.md +++ /dev/null @@ -1,23 +0,0 @@ -# Introduction - -Specify the maximum fee you want to pay by `--fee`. Gas is the unit used to measure how much resource needed to execute the transaction. Specify the maximum gas limit by --gas. If maximum gas is too small, it won't be enough for executing the transaction. If the fee is too low, fee paid for each unit of gas will be low & validator won't execute the transaction too. The fee(minimum unit)/gas must be large than 2*10^10. We recommend that you set your maximum gas to 20000 and set your maximum fee to 400000000000000iris. Fee will be deduct according to the gas used and lefted fee will be returned to user. - -## Fee - -To secure their own validator node and maintain the avalibility of blockchain network, validators in IRISnet need a lot of equipments and works. Thus, every transactions in IRISnet should pay some fee to validators. The parameter in commands is used to specify the maximum fee the user want to pay for their transaction. - -## Gas - -The resource needed for every transactions are varied for different type of transactions. For example, only a few computations, queries & modifies is needed for sending some token to other peolpe. But a lot of computations, queries & modifies is needed for creating a validator. Gas is the unit used to measure how much resource needed to execute the transaction. We list the gas needed for some typical operactions in the below: - -- gas needed for reading some data from database: 10 + data length(in bytes) -- gas needed for writing some data to database: 10 + 10 * data length(in bytes) -- sign or verify a signature - -The total gas needed for executing the transaction is the sum of gas needed for every operations performed during executing the transaction. User should specify the maximum gas by --gas parameter. If maximum gas is not enough for executing the transcation, the transaction won't be executed successfully and all the fee will be returned to user's account. After the transaction being executed successfully, fee will deduct according to gas used, deducted fee will be maximum fee * gas used / maximum gas and left fee will be returned to user. Gas price is equal to maximum fee / maximum gas and stands for fee that user want to pay for each unit of gas. To keep the fee is set in a resonable range, we set a minimum limit for gas price, 2^(-8) iris/gas, transaction won't be executed if the gas price is less than this value. - -Example -``` - iriscli stake unbond complete --from=test --address-validator=faa1mahw6ymzvt2q3lu4pjj5pau2e8krntklgarrxy --address-delegator=faa1mahw6ymzvt2q3lu4pjj5pau2e8krntklgarrxy --fee=2000000000000000iris --gas=20000 --chain-id=test -``` -This example is a transaction to complete the unbond operation. The maximum fee(--fee) is set to be 2000000000000000iris(2*10^15) and the maximum(--gas) gas is set to be 20000. Therefore, the gas price here is 10^11iris/gas. Suppose that 1500 gas is used to execute the transaction, then 1500000000000000 iris will be paid to validators and lefted 500000000000000 iris will be returned to user. diff --git a/docs/modules/fee-token/README.md b/docs/modules/fee-token/README.md deleted file mode 100644 index d5b1c6c4b..000000000 --- a/docs/modules/fee-token/README.md +++ /dev/null @@ -1,58 +0,0 @@ -# Fee Token specification - -## Previous implementation in Cosmos-SDK - -* There is no any constrain to fee token, just ensure gas is enough. Gas has no explicit connection with fee token. -* All fee token will be deducted - -## Current implementation in Cosmos-SDK - -* In global parameter store, the native fee token name has been specified. In iris network, the native fee token is iris. Other tokens will be ignored. The native fee token can't be modified. -* Transactions should specify the max gas (gasLimit) to be consumed in transaction execution. If the gas is exhausted, the transaction execution will be terminated and return error. No fee will be charged. -* gasPrice = feeToken / gasLimit. gasPrice should be no less than gasPriceThreshold (default value: 2*10^(-8)iris, iris precision: 10^18). Otherwise the transactions will be considered as invalid. gasPriceThreshold is a global parameter which can be modified by governance. -* Normally, the fee token will not be deducted totally. The deducted quantity depends on how many the gas is consumed. If half of gas is consumed, then only half of fee token will be deducted. - -## How to specify fee for transactions - -Now we must specify fee for each transaction properly. Otherwise, your transaction will be rejected. Here we take sending token for example. Now we can send token by command line and rest API: - -For command Line: -``` -iriscli send --to=faa1ze87hkku6vgnqp7gqkn528d60ttr06xuudx0k9 --name=moniker --chain-id=test-chain-UieBV2 --amount=10iris --node=tcp://localhost:26657 \ ---gas=10000 --fee=0.0005iris -``` -In command line, we specify gas and fee token by two option: "--gas" and "--fee". The "--gas" option can be omitted. Because gas has default value: 200000. However, the "--fee" option can't be omitted. Because its default value is empty. - -For rest API: -``` -{ - "amount":[{"denom":"iris","amount":"10"}], - "name":"moniker", - "password":"1234567890", - "chain_id":"test-chain-UieBV2", - "sequence":"9", - "account_number":"0", - "gas":"10000", - "fee":"0.0005iris" -} -``` -In rest API, the gas and fee token are specified by gas field and fee field in json body. Both of them can't be omitted. - -The transaction senders should ensure the gas is enough for transaction execution and the gasPrice is no less than gasPriceThreshold. In addition, only specify iris as fee token. Other token will be ignored. - -## Suggestions for test - -For both command line and rest API: - -* Try to specify no fee. -* Try to specify other token instead of iris token as fee. -* Try to specify few iris token. -* Try to specify more gas so that the gas price is very low. -* Try different kinds of transaction. - -## Future improvement - -* Fee token whitelist will be brought in. All tokens in the whitelist can be used as fee token. The whitelist can be modified by governance. -* Currently, the transaction senders have no motivation to pay more fee, just ensure the gasPrice is no less than the gasPriceThreshold. Next new mechanisms will be brought in to encourage users to pay more fee. For example, proposals will tender to include transactions with higher gasPrice. Transactions with lower gasPrice have to wait for more time. -* When a proposal builds a block, it should check whether the sum of all transaction gas is greater than blockGasLimit. If so, remove some transactions the accommodate this rule. With blockGasLimit, transactions which will consumed too much resource, such as memory , disk space and execution time, will be rejected. These special transaction may cause crash or consensus failure. -* Consider to charge fee even if the transactions encounter execution failure. This is helpful for defencing DDos attack. diff --git a/docs/modules/gov/README.md b/docs/modules/gov/README.md deleted file mode 100644 index 7961541cc..000000000 --- a/docs/modules/gov/README.md +++ /dev/null @@ -1,260 +0,0 @@ -# Gov/Iparam User Guide - -## Basic Function Description - -1. On-chain governance proposals on text -2. On-chain governance proposals on parameter change -3. On-chain governance proposals on software upgrade - -## Interactive process - -### governance process - -1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value `min_deposit`, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches `min_deposit`, enter voting period. However, if the block-time exceeds `max_deposit_period` in the deposit period, the proposal will be closed. -2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. -3. More details about voting for proposals: -[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) - -## Usage Scenario -### Create an environment - -``` -rm -rf iris -rm -rf .iriscli -iris init gen-tx --name=x --home=iris -iris init --gen-txs --chain-id=gov-test -o --home=iris -iris start --home=iris -``` - -### Usage scenario of parameter change - -Scenario 1：Change the parameters through the command lines - -``` -# Query parameters can be changed by the modules'name in gov -iriscli gov query-params --module=gov --trust-node - -# Results -[ - "Gov/gov/DepositProcedure", - "Gov/gov/TallyingProcedure", - "Gov/gov/VotingProcedure" -] - -# Query parameters can be modified by "key” -iriscli gov query-params --key=Gov/gov/DepositProcedure --trust-node - -# Results -{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":10}","op":""} - -# Send proposals, return changed parameters -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# Deposit for a proposal -echo 1234567890 | iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# Vote for a proposal -echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# Query the state of a proposal -iriscli gov query-proposal --proposal-id=1 --trust-node - -``` - -Scenario 2: Change the parameters by the files - -``` -# Export profiles -iriscli gov pull-params --path=iris --trust-node - -# Query profiles' info -cat iris/config/params.json -{ - "gov": { - "Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" - }, - "Gov/gov/VotingProcedure": { - "voting_period": "10" - }, - "Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "1/100" - } - } -} -# Modify profiles (TallyingProcedure的governance_penalty) -vi iris/config/params.json -{ - "gov": { - "Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" - }, - "Gov/gov/VotingProcedure": { - "voting_period": "10" - }, - "Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "20/100" - } - } -} - -# Change the parameters through files, return changed parameters -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/gov/TallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# Deposit for a proposal -echo 1234567890 | iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# Vote for a proposal -echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# Query the state of a proposal -iriscli gov query-proposal --proposal-id=1 --trust-node -``` - -## CLI Command Details - -### Basic method of gov modules - -``` -# Text proposals -iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="Text" --deposit="10iris" --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--title` The title of a proposal -* `--description` The description of a proposal -* `--type` The type of a proposal {'Text','ParameterChange','SoftwareUpgrade'} -* `--deposit` The number of the tokens deposited -* The basic text proposals are as below - -``` -iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--propsal-id` The ID of the proposal deposited -* `--deposit` The number of the tokens deposited - -``` -iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--proposal-id` The ID of the proposal in voting period -* `--option` Vote option{'Yes'-agree,'Abstain'-abstain,'No'-disagree,'nowithVeto'-strongly disagree } - - -``` -# Query the state of a proposal -iriscli gov query-proposal --proposal-id=1 --trust-node -``` - -* `--proposal-id` Query the ID of a proposal - - - -### The proposals on parameters modification - -``` -# Query parameters can be modified by the modules'name in gov -iriscli gov query-params --module=gov --trust-node -``` - -* `--module` Query the list of "key" of the parameters can be changed in the module - - -``` -# Query the parameters can be modified by "key" -iriscli gov query-params --key=Gov/gov/DepositProcedure --trust-node -``` - -* `--key` Query the parameter corresponding to the "key" - -``` -# Export profiles -iriscli gov pull-params --path=iris --trust-node -``` - -* `--path` The folder of node initialization - - - -``` -# Modify the parameters through the command lines -iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--param` The details of changed parameters （get parameters through query-params, modify it and then add "update" on the "op", more details in usage scenarios） -* Other fields' proposals are similar with text proposal - -``` -# Change the parameters through files, return modified parameters -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/gov/TallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--path` The folder of node initialization -* `--key` The key of the parameter to be modified -* `--op` The type of changed parameters; only 'update' is implemented at present -* Other fields' proposals are similar with text proposal - -### Proposals on software upgrade - -## Basic parameters - -``` -# DepositProcedure（The parameters in deposit period） -"Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" -} -``` - -* Parameters can be changed -* The key of parameters:"Gov/gov/DepositProcedure" -* `min_deposit[0].denom` The minimum tokens deposited are counted by iris-atto. -* `min_deposit[0].amount` The number of minimum tokens and the default scope：10iris,（1iris，200iris） -* `max_deposit_period` Window period for repaying deposit, default :10， scope（0，1） - -``` -# VotingProcedure（The parameters in voting period） -"Gov/gov/VotingProcedure": { - "voting_period": "10" -}, -``` - -* Parameters can be changed -* `voting_perid` Window period for vote, default：10, scope（20，20000） - -``` -# TallyingProcedure (The parameters in Tallying period) -"Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "1/100" -} -``` - -* Parameters can be changed -* `veto` default: 1/3, scope（0，1） -* `threshold` default 1/2, scope（0，1） -* `governance_penalty` The default ratio of slashing tokens of validators who didn't vote: 1/100, scope（0，1） -* Vote rules: If the ratio of voting power of "strongly disagree" over "veto", the proposal won't be passed. If the ratio of voting_power of "agree" over "veto", the proposal won't be passed. Otherwise, it will be passed. - diff --git a/docs/modules/iservice/README.md b/docs/modules/iservice/README.md deleted file mode 100644 index fc4ddd255..000000000 --- a/docs/modules/iservice/README.md +++ /dev/null @@ -1,86 +0,0 @@ -# IService User Guide - -## Basic Function Description - -1. Service Definition -2. Service Binding (TODO) -3. Service Invocation (TODO) -4. Dispute Resolution (TODO) -5. Service Analysis (TODO) - -## Interactive process - -### Service definition process - -1. Any users can define a service. In service definition，Use [protobuf](https://developers.google.com/protocol-buffers/) to standardize the definition of the service's method, its input and output parameters. - -## Usage Scenario -### Create an environment - -``` -rm -rf iris -rm -rf .iriscli -iris init gen-tx --name=x --home=iris -iris init --gen-txs --chain-id=service-test -o --home=iris -iris start --home=iris -``` - -### Service Definition - -``` -# Service definition -iriscli iservice define --chain-id=service-test --from=x --fee=0.004iris --name=test-service --service-description=service-description --author-description=author-description --tags "tag1 tag2" --broadcast=Broadcast --idl-content= --file=test.proto - -# Result -Committed at block 1040 (tx hash: 58FD40B739F592F5BD9B904A661B8D7B19C63FA9, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:13601 Tags:[{Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[247 102 151 120 200 0]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "completeConsumedTxFee-iris-atto": "159740000000000" - } -} - -# Query service definition -iriscli iservice definition --def-chain-id=service-test --name=test-service --chain-id=service-test - -``` - -## CLI Command Details - -``` -iriscli iservice define --chain-id=service-test --from=x --fee=0.004iris --name=test-service --service-description=service-description --author-description=author-description --tags "tag1 tag2" --broadcast=Broadcast --idl-content= --file=test.proto -``` - -* `--name` The name of iService -* `--service-description` The description of this iService -* `--author-description` The self-description of the iService creator which is optional -* `--tags` The keywords of this iService -* `--broadcast` The Broadcast type of this iService{`Broadcast`,`Unicast`} -* `--idl-content` The standardized definition of the methods for this iService -* `--file` Idl-content can be replaced by files,if the item is not empty. - -``` -iriscli iservice definition --def-chain-id=service-test --name=test-service --chain-id=service-test -``` - -* `--def-chain-id` The ID of the blockchain defined of the iService -* `--name` The name of iService - -## IDL extension -When using proto file to standardize the definition of the service's method, its input and output parameters, the method attributes can be added through annotations. - -### Annotation standard -* If `//@Attribute attribute： value` wrote on top of `rpc method`，it will be added to the method attributes. Eg. -> //@Attribute description: sayHello - -### Currently supported attributes -* `description` The name of this method in the iService -* `output_privacy` Whether the output of the method is encrypted，{`NoPrivacy`,`PubKeyEncryption`} -* `output_cached` Whether the output of the method is cached，{`OffChainCached`，`NoCached`} - -### IDL content example -* idl-content example -> syntax = \"proto3\";\n\npackage helloworld;\n\n// The greeting service definition.\nservice Greeter {\n //@Attribute description: sayHello\n //@Attribute output_privacy: NoPrivacy\n //@Attribute output_cached: NoCached\n rpc SayHello (HelloRequest) returns (HelloReply) {}\n}\n\n// The request message containing the user's name.\nmessage HelloRequest {\n string name = 1;\n}\n\n// The response message containing the greetings\nmessage HelloReply {\n string message = 1;\n}\n - -* IDL file example - -[test.proto](./test.proto) diff --git a/docs/modules/iservice/test.proto b/docs/modules/iservice/test.proto deleted file mode 100644 index ccb70ab00..000000000 --- a/docs/modules/iservice/test.proto +++ /dev/null @@ -1,21 +0,0 @@ -syntax = "proto3"; - -package helloworld; - -// The greeting service definition. -service Greeter { - //@Attribute description: sayHello - //@Attribute output_privacy: NoPrivacy - //@Attribute output_cached: NoCached - rpc SayHello (HelloRequest) returns (HelloReply) {} -} - -// The request message containing the user's name. -message HelloRequest { - string name = 1; -} - -// The response message containing the greetings -message HelloReply { - string message = 1; -} diff --git a/docs/modules/record/README.md b/docs/modules/record/README.md deleted file mode 100644 index 2c81c2185..000000000 --- a/docs/modules/record/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# iriscli record - -## Description - -Record allows you to submit, query and download your records on the chain. - -## Usage - -```shell -iriscli record [command] -``` - -## Available Commands - -| Name | Description | -| ------------------------| --------------------------------------------------------------| -| [query](query.md) | Query specified record | -| [download](download.md) | Download related data with unique record ID to specified file | -| [submit](submit.md) | Submit a new record | - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | ------- | --------------- | -------- | -| --help, -h | | help for record | | - -## Extended description - -1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the chain, the request will be completed successfully and the relevant metadata will be recorded on the chain. And you will be returned a record ID to confirm your ownership of the data. -2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. -3. Any users can search/download on the chain based on the record ID. -4. At present, the maximum amount of stored data is 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. diff --git a/docs/modules/record/download.md b/docs/modules/record/download.md deleted file mode 100644 index f912c6e2d..000000000 --- a/docs/modules/record/download.md +++ /dev/null @@ -1,40 +0,0 @@ -# iriscli record download - -## Description - -Download related data with unique record ID to specified file - -## Usage - -``` -iriscli record download [record ID] [flags] -``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --file-name | | [string] Download file name | Yes | -| --height | most recent provable block | [int] block height to query | | -| --help, -h | | help for download | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --record-id | | [string] record ID | | -| --trust-node | true | Don't verify proofs for responses | | - -## Examples - -### Download a record - -```shell -iriscli record download --chain-id=test --record-id=MyRecordID --file-name="download.txt" -``` - -After that, you will get download file under iriscli home directory with the specfied record ID info. - -```txt -[ONCHAIN] Downloading ~/.iriscli/download.txt from blockchain directly... -[ONCHAIN] Download file from blockchain complete. -``` diff --git a/docs/modules/record/query.md b/docs/modules/record/query.md deleted file mode 100644 index 766e06f53..000000000 --- a/docs/modules/record/query.md +++ /dev/null @@ -1,46 +0,0 @@ -# iriscli record query - -## Description - -Query details of the existing record - -## Usage - -``` -iriscli record query [flags] -``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for query | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --record-id | | [string] Record ID for query | Yes | -| --trust-node | true | Don't verify proofs for responses | | - -## Examples - -### Query a record - -```shell -iriscli record query --chain-id=test --record-id=MyRecordID -``` - -After that, you will get detail info for the record which has the specfied record ID. - -```json -{ - "submit_time": "2018-11-13 15:31:36", - "owner_addr": "faa122uzzpugtrzs09nf3uh8xfjaza59xvf9rvthdl", - "record_id": "record:ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6", - "description": "description", - "data_hash": "ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6", - "data_size": "24", - "data": "this is my on chain data" -} -``` diff --git a/docs/modules/record/submit.md b/docs/modules/record/submit.md deleted file mode 100644 index 87f2c1ad2..000000000 --- a/docs/modules/record/submit.md +++ /dev/null @@ -1,61 +0,0 @@ -# iriscli record submit - -## Description - -Submit a record on the chain - -## Usage - -``` -iriscli record submit [flags] -``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | -------------------------- | ------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --description | description | [string] Uploaded file description | | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas string | 200000 | Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| -h, --help | | help for submit | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --onchain-data | | [string] on chain data source | Yes | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | - -## Examples - -### Submit a record - -```shell -iriscli record submit --chain-id="test" --onchain-data="this is my on chain data" --from=node0 --fee=0.1iris -``` - -After that, you're done with submitting a new record, but remember to back up your record id, it's the only way to retrieve your record. - -```txt -Password to sign with 'node0': -Committed at block 72 (tx hash: 7CCC8B4018D4447E6A496923944870E350A1A3AF9E15DB15B8943DAD7B5D782B, response: {Code:0 Data:[114 101 99 111 114 100 58 97 98 53 54 48 50 98 97 99 49 51 102 49 49 55 51 55 101 56 55 57 56 100 100 53 55 56 54 57 99 52 54 56 49 57 52 101 102 97 100 50 100 98 51 55 54 50 53 55 57 53 102 49 101 102 100 56 100 57 100 54 51 99 54] Log:Msg 0: Info: GasWanted:200000 GasUsed:4090 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 50 50 117 122 122 112 117 103 116 114 122 115 48 57 110 102 51 117 104 56 120 102 106 97 122 97 53 57 120 118 102 57 114 118 116 104 100 108] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 97 98 53 54 48 50 98 97 99 49 51 102 49 49 55 51 55 101 56 55 57 56 100 100 53 55 56 54 57 99 52 54 56 49 57 52 101 102 97 100 50 100 98 51 55 54 50 53 55 57 53 102 49 101 102 100 56 100 57 100 54 51 99 54] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 50 48 52 53 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "submit-record", - "completeConsumedTxFee-iris-atto": "\"2045000000000000\"", - "ownerAddress": "faa122uzzpugtrzs09nf3uh8xfjaza59xvf9rvthdl", - "record-id": "record:ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6" - } - } -``` - diff --git a/docs/modules/upgrade/README.md b/docs/modules/upgrade/README.md deleted file mode 100644 index 6882286e7..000000000 --- a/docs/modules/upgrade/README.md +++ /dev/null @@ -1,112 +0,0 @@ -# Software Upgrade User Guide - -## Basic Function Description - -The module supports the infrastructure of the blockchain software upgrade. It will be upgraded to the new version through voting at UpgradeProposal and switch stage within specific time, and is fully compatible with the historical data on the blockchain. - -## Interaction Process - -### Governance process of software upgrade proposal -1. Submit a software upgrade proposal -2. More details about governance process is in GOV [User Guide](../gov/README.md) - - -### The process of software upgrade -1. Install a new software, send a switch message, and broadcast to the whole network. -2. Once reach the limited time, it will be counted whether the proportion of voting power of upgraded software exceeds 95%. -3. If it exceeds 95%, the software will be upgraded, otherwise the upgrade fails. -4. The validators who didn't upgrade in time need to re-download the new software and blocks synchronized. - -## Usage Scenarios - -### Create an environment - -``` -rm -rf iris -rm -rf .iriscli -iris init gen-tx --name=x --home=iris -iris init --gen-txs --chain-id=upgrade-test -o --home=iris -iris start --home=iris -``` -### Submit a software upgrade proposal -``` -# Send an upgrade proposal -iriscli gov submit-proposal --title=Upgrade --description="SoftwareUpgrade" --type="SoftwareUpgrade" --deposit=10iris --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 - -# Deposit for a proposal -iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 - -# Vote for a proposal -iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 - -# Query the state of a proposal -iriscli gov query-proposal --proposal-id=1 --trust-node -``` - -### Upgrade software - -* Scenario 1 - -Implement following operations within limited time（2days, 57600 block height）： - -``` -# 1. Download the new version:iris1 - -# 2. Close the old one -kill -f iris - -# 3. Install the new version，iris1 and start it（copy to bin） -iris1 start --home=iris - -# 4. Send a switch message, and broadcast to the whole network that the new software has been installed. -iriscli1 upgrade submit-switch --from=x --proposalID=1 --chain-id=upgrade-test --fee=0.05iris --gas=20000 - -# 5. Upgrade automatically when reach the preset time - -# 6. Query whether the current version has been successfully upgraded -iriscli upgrade info --trust-node -``` - -* Scenario 2 - -The operations in Scenario 1 haven't been implemented in the limited time (2 days, 57600 block height), report errors after the new version become valid: - -``` -# 1. Download the new version, iris1 - -# 2. Close the old one -kill -f iris - -# 3. Install the new version, iris1 and start it with following command lines（copy to bin） -iris1 start --replay --home=iris - -# 4. Query whether the current version has been successfully upgraded -iriscli upgrade info --trust-node -``` - -## Command details - -``` -iriscli gov submit-proposal --title=Upgrade --description="SoftwareUpgrade" --type="SoftwareUpgrade" --deposit=10iris --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 -``` - -* `--type` "SoftwareUpgrade" The type of Software upgrade proposals -* Other parameters can be referrenced in [Gov User Guide](../gov/README.md) - -``` -iriscli upgrade submit-switch --name=x --from=$VADDR --proposalID=1 --chain-id=upgrade-test --fee=0.05iris --gas=20000 -``` - -* `--proposalID` The ID of passed software upgrade proposals - -``` -iris start --replay -``` - -* Resynchronize the block, clean the dirty AppHash - -``` -iriscli upgrade info --trust-node -``` - -* Query the version details of current software diff --git a/docs/resources/README.md b/docs/resources/README.md index e69de29bb..3c1229ee1 100644 --- a/docs/resources/README.md +++ b/docs/resources/README.md @@ -0,0 +1 @@ +# Resources diff --git a/docs/delegators/README.md b/docs/resources/delegator-faq.md similarity index 100% rename from docs/delegators/README.md rename to docs/resources/delegator-faq.md diff --git a/docs/resources/validator-faq.md b/docs/resources/validator-faq.md new file mode 100644 index 000000000..5b1003104 --- /dev/null +++ b/docs/resources/validator-faq.md @@ -0,0 +1,3 @@ +# FAQ + + diff --git a/docs/introduction/Whitepaper.md b/docs/resources/whitepaper-en.md similarity index 100% rename from docs/introduction/Whitepaper.md rename to docs/resources/whitepaper-en.md diff --git a/docs/resources/whitepaper-kr.md b/docs/resources/whitepaper-kr.md new file mode 100644 index 000000000..1911a7c8e --- /dev/null +++ b/docs/resources/whitepaper-kr.md @@ -0,0 +1 @@ +# IRIS \ No newline at end of file diff --git a/docs/introduction/Whitepaper_CN.md b/docs/resources/whitepaper-zh.md similarity index 100% rename from docs/introduction/Whitepaper_CN.md rename to docs/resources/whitepaper-zh.md diff --git a/docs/software/basic-concepts/key-types/genesis.md b/docs/software/README.md similarity index 100% rename from docs/software/basic-concepts/key-types/genesis.md rename to docs/software/README.md diff --git a/docs/software/basic-concepts/key-types/coin-type.md b/docs/software/basic-concepts/coin-type.md similarity index 100% rename from docs/software/basic-concepts/key-types/coin-type.md rename to docs/software/basic-concepts/coin-type.md diff --git a/docs/software/basic-concepts/key-types/fee.md b/docs/software/basic-concepts/fee.md similarity index 100% rename from docs/software/basic-concepts/key-types/fee.md rename to docs/software/basic-concepts/fee.md diff --git a/docs/software/basic-concepts/key-types/gov-params.md b/docs/software/basic-concepts/genesis-file.md similarity index 100% rename from docs/software/basic-concepts/key-types/gov-params.md rename to docs/software/basic-concepts/genesis-file.md diff --git a/docs/software/basic-concepts/key-types/inflation.md b/docs/software/basic-concepts/gov-params.md similarity index 100% rename from docs/software/basic-concepts/key-types/inflation.md rename to docs/software/basic-concepts/gov-params.md diff --git a/docs/software/basic-concepts/inflation.md b/docs/software/basic-concepts/inflation.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/software/monitor.md b/docs/software/monitor.md index e69de29bb..a2f598566 100644 --- a/docs/software/monitor.md +++ b/docs/software/monitor.md @@ -0,0 +1,62 @@ +# How to deploy IRIShub Monitor + +Please make sure that iris is installed in your computer and added to $PATH.You can see this page for insturcion https://github.com/irisnet/irishub. You also need /bin/bash, wc, ps to ensure the monitor work properly. + +### Get Monitor Info + +* Address of validator + +``` +-a= < hex-encoded-address-of-validator > +``` + +* Chain-ID +``` +--chain-id= < id-of-blockchain > +``` + +* Node + + +``` +--node= < localhost:26657 > +``` +### Start IRIS Monitor +Example: +``` +irismon --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --chain-id=irishub-stage --node=http://localhost:26657& +``` + +then, you can visit http://localhost:3660/ to see the metrics page. + +### Start Prometheus + +First, you need to edit the configuration file of prometheus. Add `jobs` : +```$xslt +- job_name: fuxi-4000 + + static_configs: + + - targets: ['localhost:36660'] + + labels: + + instance: fuxi-4000 +``` +Then, you could see in your browser that there are some data available at port 36660. + +### Start Grafana + +You could start grafana with docker by running: +```$xslt +sudo docker run -p 3000:3000 grafana/grafana 1>grafana.log 2>grafana.error & +``` + +The default username and password are both admin. We strongly recommend immediately changing your username & password after login. + +Then you could create your own dashboard. + +### Stop IRIS Monitor +``` +kill -9 +``` \ No newline at end of file diff --git a/docs/tools/Deploy-IRIS-Monitor.md b/docs/tools/Deploy-IRIS-Monitor.md deleted file mode 100644 index a2f598566..000000000 --- a/docs/tools/Deploy-IRIS-Monitor.md +++ /dev/null @@ -1,62 +0,0 @@ -# How to deploy IRIShub Monitor - -Please make sure that iris is installed in your computer and added to $PATH.You can see this page for insturcion https://github.com/irisnet/irishub. You also need /bin/bash, wc, ps to ensure the monitor work properly. - -### Get Monitor Info - -* Address of validator - -``` --a= < hex-encoded-address-of-validator > -``` - -* Chain-ID -``` ---chain-id= < id-of-blockchain > -``` - -* Node - - -``` ---node= < localhost:26657 > -``` -### Start IRIS Monitor -Example: -``` -irismon --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --chain-id=irishub-stage --node=http://localhost:26657& -``` - -then, you can visit http://localhost:3660/ to see the metrics page. - -### Start Prometheus - -First, you need to edit the configuration file of prometheus. Add `jobs` : -```$xslt -- job_name: fuxi-4000 - - static_configs: - - - targets: ['localhost:36660'] - - labels: - - instance: fuxi-4000 -``` -Then, you could see in your browser that there are some data available at port 36660. - -### Start Grafana - -You could start grafana with docker by running: -```$xslt -sudo docker run -p 3000:3000 grafana/grafana 1>grafana.log 2>grafana.error & -``` - -The default username and password are both admin. We strongly recommend immediately changing your username & password after login. - -Then you could create your own dashboard. - -### Stop IRIS Monitor -``` -kill -9 -``` \ No newline at end of file diff --git a/docs/validators/FAQ.md b/docs/validators/FAQ.md deleted file mode 100644 index 50576ac7f..000000000 --- a/docs/validators/FAQ.md +++ /dev/null @@ -1,58 +0,0 @@ -# FAQ - -1. What is IRISnet? - -IRIS network is named after the Greek goddess Iris, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRISnet is designed to be the foundation for next generation distributed business applications. IRISnet will enhance Interblockchain Communication(IBC)protocol of Cosmos to introduce a service-oriented infrastructure into ecosystem to support more efficient building distributed business application chains. It will make services interoperable across blockchains: public, consortium & legacy systems. - -2. IRISnet and Cosmos - -Cosmos IBC defines a protocol for transferring values from an account on one chain to an account on another chain. The IRIS network designs new semantics to allow cross-chain computation to be invoked by leveraging IBC.The IRIS network could provide the service infrastructure for handing and coordinating on-chain transaction processing with off-chain data processing and business logic execution - - -3. What is IRIS token? - -IRIS token is the native toke in IRISnet. It has two main usages: - -* Staking token: IRIS token holders could stake or delegate some IRIS to become a validator candidate -* Fee token: IRIS could be used to pay for network fee and service fee. - -iris precision: 10^18 - - - -3. Server Configuration - -Here is the recommanded configuration of the server. -* No. of CPUs: 2 -* Memory: 4GB -* Disk: 40GB SSD -* OS: Ubuntu 18.04 LTS/16.04 LTS -* Allow all incoming connections from TCP port 26656 and 26657 - - -4. What is a Validator? - - -The IRISHub is based on a consensus engine called Tendermint. It relies on a set of validators to secure the network. The role of validators is to run a full-node and participate in consensus by broadcasting votes which contain cryptographic signatures signed by their private key. Validators commit new blocks in the blockchain and receive revenue in exchange for their work. They must also participate in governance by voting on proposals. Validators are weighted according to their total stake. - -The reward for a validator is 3-fold: - -* Block provision -* Transaction fee -* Commission - - -5. What is a Delegator? - -Not every iris token holder is eligible to become a validator. Any iris token holder could choose to delegate their own iris token to one or more validators. In this way, they could still earn block provision and transaction fees. At the same time, some percent of commission needs to be paid to their validator. - - -6. How to understand different address formats in IRISnet? - -Please read this [doc](https://github.com/irisnet/testnets/blob/master/fuxi/docs/Bech32%20on%20IRISnet.md) to understand the address format in IRISnet. - -7. How to understand the notion of gas&fee in IRISHub? - -This is the tech spec for fee&gas is [here](../modules/fee-token/README.md) - - diff --git a/docs/validators/How-to-participate-in-onchain-governance.md b/docs/validators/How-to-participate-in-onchain-governance.md deleted file mode 100644 index bef0c3bc0..000000000 --- a/docs/validators/How-to-participate-in-onchain-governance.md +++ /dev/null @@ -1,198 +0,0 @@ -# Governance In IRISHub - -## What is Blockchain Governance? - -Generally, governance is about decisions that ultimately affect stakeholders of blockchain network. It’s about the processes -that community members in governance use to make decisions. -It’s also about how different groups coordinate around decisions and decision-making processes. -It includes the establishment, maintenance, and revocation of the legitimacy of decisions, decision making processes, norms, -and other mechanisms for coordination. - -### Stakeholder of Governance - -* Core Developers:a blockchain are software developers who work on the software that implement that protocol. -Developers have processes that are supposed to assure the quality of the software they release, - -* Validators/Delegators: Validators and delegators are responsible for securing the network. They need to actively involved in governance -proposals or their credit will be damaged. - -* Community Members: They could come up with interesting for improvement of network. block explorers and other low level service providers, exchanges, speculators, application developers, users, journalists and passive observers - - - -## Governance Process -![workflow](../pics/flow.jpg) - -The governance process is divided in a few steps that are outlined below: - -* Proposal submission: Proposal is submitted to the blockchain with a deposit. -* Vote: Once deposit reaches a certain value (MinDeposit), proposal is confirmed and vote opens. Bonded Atom holders can then send TxGovVote transactions to vote on the proposal. -* If the proposal is passed, then there sill be some changes. - - -For `System Parameter Change` proposals, the following parameters are eligible for change: - -* Mininimum Depost: `10IRIS` -* Deposit Period: 1440 blocks -* Penalty for non-voting validtors: 1% -* Pass Threshold: 50% -* Voting Period: 20000 blocks - - -### Types of Governance Proposal - -* Text -* System Parameter Change -* Protocol Upgrade - - -## How to submit a proposal? - -Anyone could submit a governance proposal, but you need to make the deposit for this proposal more than the minimium requirement. - -The following command is for submitting a `Text` proposal: - -``` -iriscli gov submit-proposal --title="Text" --description="name of the proposal" --type="Text" --deposit="100iris" --proposer= --from= --chain-id=fuxi-4000 --fee=0.05iris --gas=20000 --node=http://localhost:26657 -``` - -The `` for `proposer` field should start with `faa` which corresponds to ``. - - -## How to add deposit to a proposal? - -To add deposit to some proposal, you could execute this command to add `100IRIS` to the proposal's deposit: - -``` -iriscli gov deposit --proposalID=1 --depositer= --deposit=1000000000000000000iris --from= --chain-id=fuxi-4000 --fee=0.05iris --gas=20000 --node=http://localhost:36657 -``` -## How to query proposals? - -Run the following command will return all the existing proposals: -```$xslt -iriscli gov query-proposals -``` -Example output: -```$xslt - 1 - 78547 - 2 - 96866 - 3 - 46727 - 4 - 92454 - 5 - 57682 -``` - -You could also use IRISplorer to see all proposal. - -## How to vote a proposal? - -In the current version of governance module, you have the following choices for each proposal: -* Yes -* No -* NoWithVeto -* Abstien - -You could put one of the choices in the `--option` field. - -To vote for a proposal, you need to get the correct ``.You could execute the following command to vote on proposal with ID = 1: - - -## How to get more information about a proposal? - -You could use the following command to get the first proposal: -``` -iriscli gov query-proposal --proposal-id=6 --chain-id=fuxi-3001 --node=http://localhost:26657 -``` - -Example output is the following: -```$xslt -{ - "proposal_id": "1", - "title": "text_proposal", - "description": "test_description", - "proposal_type": "Text", - "proposal_status": "VotingPeriod", - "tally_result": { - "yes": "0", - "abstain": "0", - "no": "0", - "no_with_veto": "0" - }, - "submit_block": "200981", - "total_deposit": [ - "20iris" - ], - "voting_start_block": "200981", - "param": { - "key": "", - "value": "", - "op": "" - } -} -``` -## Proposal Examples - -### Text Proposal - -A text proposal is just a notice. You could send one with the following command: -```$xslt -iriscli gov submit-proposal --title=text_proposal --description=test_description --type=Text --deposit=20iris --fee=0.1iris --from=bft --chain-id=fuxi-4000 -``` -You could vote on it with the following command: -```$xslt -iriscli gov vote --proposal-id=6 --option=Yes --from=bft --chain-id=fuxi-4000 --fee=0.05iris --gas=20000 -``` - - -### System Parameter Change Proposal - -First, you could query the flexible parameters with the following command: -``` -iriscli gov query-params --trust-node --module=gov - -``` - -The output is the shown below: -```$xslt -[ - "Gov/gov/DepositProcedure", - "Gov/gov/TallyingProcedure", - "Gov/gov/VotingProcedure" -] -``` -It corresponds to the following fields in genesis file: - -```json -gov: { -starting_proposalID: "1", -deposit_period: { -min_deposit: [ -{ -denom: "iris-atto", -amount: "10000000000000000000" -} -], -max_deposit_period: "50" -}, -voting_period: { -voting_period: "50" -}, -tallying_procedure: { -threshold: "1/2", -veto: "1/3", -governance_penalty: "1/100" -} -}, -``` - - -The default value of flexible parameters are shown above. - -You could submit a parameter change proposal, -```$xslt -iriscli gov submit-proposal --title="update VotingProcedure" --description="test" --type="ParameterChange" --deposit=10iris --param='{"key":"Gov/gov/VotingProcedure","value":"{\"voting_period\": 250}","op":"update"}' --from=bft --chain-id=fuxi-4000 --fee=0.05iris --gas=20000 -``` -This proposal will change the voting period from default to 250. - -### System Upgrade Proposal - -You could read more about it in the [doc](../modules/upgrade/README.md) \ No newline at end of file diff --git a/docs/validators/README.md b/docs/validators/README.md deleted file mode 100644 index cb4952187..000000000 --- a/docs/validators/README.md +++ /dev/null @@ -1,154 +0,0 @@ -# Validators - -## Tendermint & Cosmos-SDK - -Tendermint is software for securely and consistently replicating an application on many machines. Tendermint is designed to be easy-to-use, simple-to-understand, highly performant, and useful for a wide variety of distributed applications. - - - -## What is a validator - -In IRIS network , a validator is responsible for for creating new blocks and verifying transactions. The IRIS network will keep generating value when its validators could keep the whole network secure. -Validator candidates can bond their own IRIS to become a validator. - - -## What is a delegator - -People that cannot, or do not want to run validator operations, can still participate in the staking process as delegators. Indeed, validators are not chosen based on their own stake but based on their total stake, which is the sum of their own stake and of the stake that is delegated to them. This is an important property, as it makes delegators a safeguard against validators that exhibit bad behavior. If a validator misbehaves, its delegators will move their Atoms away from it, thereby reducing its stake. Eventually, if a validator's stake falls under the top 100 addresses with highest stake, it will exit the validator set. - - -## States for Validator - - -After a validator is created with a `create-validator` transaction, it can be in the following states: - -![states](../pics/states.png) - -After a validator is created with a create-validator transaction, it can be in five states: - -* `unbonded` & `unjailed` : -* `bonded`: -* `unbonding`& `unjailed`: -* `unbonding`& `jailed`: -* `unbonded`&`jailed`: - -Validator is in the active set and participates in consensus. Validator is earning rewards and can be slashed for misbehaviour. -unbonding: Validator is not in the active set and does not participate in consensus. Validator is not earning rewards, but can still be -slashed for misbehaviour. This is a transition state from bonded to unbonded. If validator does not send a rebond transaction while in -* unbonding mode, it will take three weeks for the state transition to complete. -* unbonded: Validator is not in the active set, and therefore not signing blocs. -Validator cannot be slashed, and does not earn any reward. It is still possible to delegate Atoms to this validator. Un-delegating -from an unbonded validator is immediate. - -Once a user execute `create-validator` transaction with pubkey of a fully synced node, -its state become `unbonded` & `unjailed`. If it's voting power is in the top 100 of all the candidates, then the state will change to `Bonded`. -But if the voting power is not enough to make to top 100, then the state will change to `unbonding`& `unjailed`. If the state keeps unchange for 3 weeks, -then the state will change back to `unbonded` & `unjailed`. During this time, the validator could use additional delegations or add self-delegation. -If the validator get jailed for slashing or unbond all of his self-delegation, then his state will change to `unbonding`& `jailed`. The slashing conditions -are explained below. The validator could use a `unrevoke` command to unjailed himself. His voting power will be reduced by a portion. -If he could still remain in the top 100 validator candidates, then his state is `Bonded`, otherwise it's `unbonding`& `unjailed`. -However, if the validator doesn't unjail himself in 3 weeks, his state will be `unbonded`&`jailed`. But he could still unjail himself later. -If he unjailed himself from the state `unbonded`&`jailed`, his state will be `Bonded` if his voting power is within top 100. - -### Slashing conditions -While a validator’s goal is staying online, we will test slashing. Slashing is a punitive function that is triggered by a validator ’s bad actions. Getting slashed is losing voting power. Validators will be slashed for the actions below: - -* Going offline or unable to communicate with the network - -* Double sign a block - -## Common Operations for Validators - -* **Create Validator** - -All the participants could show that they want to become a validator by sending a `create-validator` transaction, the following parameters would be necessory: - -The following parameters are essential: - -* `Validator's PubKey`: With flag `--pubkey`, the private key associated with PubKey is used to sign blocks. -* `Validator's Address`: With flag `--address-validator`, the address of a participant who wants to become a validator. This is the address used to identify your validator publicly. Thhis address is used to bond, unbond, claim rewards, receive delegation and participate in governance. -* `Validator's name` : With flag `--pubkey`, default value: [do-not-modify] -* `Validator's self bond tokens`: With flag `--amount`, this value should be more than 0 and it's under unit `iris-atto` - - -The following parameters are optional: -* `Validator's website`: With flag `--website` -* `Validator's details`: With flag `--details` - -How to get the `PubKey` of your node? -``` -iris tendermint show_validator --home={path-to-your-home} -``` - -The example output is the following: -``` -fvp1zcjduepqcxd82mjnsnqfhwzja2d3y690ec6scw64xpg2uqkjx3rl0g0p2lwsprxnnf -``` - -In summary, an example of the `create-validator` command to bond 10IRIS is the following: -``` -iriscli stake create-validator --pubkey=pub-key --amount=XXiris --fee=0.05iris --gas=2000000 --node=tcp://localhost:26657 --chain-id=fuxi-4000 --from=name --moniker=name -``` -### Edit Validator Information - -Validators could edit its information. - -The following parameters are optional: - -* keybase signature of the validator key holder: With flag `--keybase-sig`,default value: [do-not-modify] -* the official website of the validator operator: With flag `--website`,default value: [do-not-modify] -* the name of validator: With flag `--moniker`,default value: [do-not-modify] - - -The command is the following: -```$xslt -iriscli stake edit-validator --chain-id=fuxi-4000 --from=name --details=details --gas=2000000 --fee=0.04iris -``` - -For each validator, the voting power is the sum of self-bonded token and delegated tokens. - - -### View Validator Description - -Anyone can view certain validator's information with the following command: -```$xslt -iriscli stake validator --address-validator={address-validator} --chain-id=fuxi-4000 -``` - -### Track Validator Signing Information -In order to keep track of a validator's signatures in the past you can do so by using the signing-info command: - -The command is the following: -``` -iriscli stake signing-information --chain-id=fuxi-4000 -``` - -### Unrevoke Validator -When a validator is Revoked for downtime, you must submit an Unrevoke transaction in order to be able to get block rewards again. -In fuxi-3001, if your node missed the previous 5000 blocks in the last 10000 blocks, you will get revoked. -To query your validator's info: -```$xslt -Validator -Owner: -Validator: -Revoked: true -Status: Bonded -Tokens: 211.5500000000 -Delegator Shares: 2800.3740578441 -Description: {} -Bond Height: 642721 -Proposer Reward Pool: -Commission: 0/1 -Max Commission Rate: 0/1 -Commission Change Rate: 0/1 -Commission Change Today: 0/1 -Previous Bonded Tokens: 0/1 -``` - -The `Revoked` field of an offline validator will be `true`. - -To unrevoke your validator node, the command is the following: - -``` -iriscli stake unrevoke --from=name --chain-id=fuxi-4000 -``` \ No newline at end of file diff --git a/docs/validators/Setup-Sentry-Node.md b/docs/validators/Setup-Sentry-Node.md deleted file mode 100644 index 41d5612ef..000000000 --- a/docs/validators/Setup-Sentry-Node.md +++ /dev/null @@ -1,59 +0,0 @@ -# Setup A Sentry Node - -## Why do we need a sentry node? - -A validator node is under the risk of distributed denial-of-service (DDoS)attack. It occures when an attacker tries to disrupt normal traffic of a node. In this way, this node will be isolated from other nodes in the network. One way to mitigate this risk is for validators to carefully structure their network topology in a so-called sentry node architecture. - -## What is a sentry node? - -In IRISnet, a sentry node is just a normal full node. The validator node will only connect to its sentry node. In this way, the sentry nodes will be protect the validator node from DDoS attack. - -## How to setup a sentry node? - - -### Sentry Node - -On the sentry node's side, you need to get fully initialized first. - -Then, you should edit its `config.toml` file, and change `private_peers_id` field： - -``` -private_peers_ids="validator_node_id" -``` - -`validator node id` is the `node-id` of validator node. - -Then you could start your sentry node, - -``` -iris start --home=sentry_home -``` - -If you have multiple sentry node, you could make them as `persistent-peers` to each other. - -### Validator Node - -On the validator node's side, you also need to get fully initialized first, and make sure you have the `priv_validator.json` file backuped. - -Then, you should edit its `config.toml` file, - -``` -persistent_peers="sentry_node_id@sentry_listen_address" -``` - -If you want to put multiple sentry info, you need to separate the information with `,` - -Set -``` -pex=false -``` -In this way, the validator node will diable its peer reactor, so it will not respond to any peer exchange request other than its sentry nodes. - -Then you could start your validator node, - -``` -iris start --home=sentry_home -``` - -It's also recommanded to enable the firewall of validator node. - From 9d9a57004894fb001587ff9bb0b305307afdefe0 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Thu, 15 Nov 2018 17:38:24 +0800 Subject: [PATCH 024/100] Move modules/record to Features/record --- docs/features/record.md | 43 +++++++++-------- docs/modules/record/README.md | 88 ----------------------------------- 2 files changed, 23 insertions(+), 108 deletions(-) delete mode 100644 docs/modules/record/README.md diff --git a/docs/features/record.md b/docs/features/record.md index a7ea515fe..e71ffe356 100644 --- a/docs/features/record.md +++ b/docs/features/record.md @@ -6,26 +6,29 @@ 2. On-Chain record for the text file (TODO) 3. On-Chain governance for the record params (TODO) -## Interaction Process +## Interaction -### Record process +### Record Introduction -1. Any users can initiate a record request. It will cost you some tokens. If there’s no record of the data on the existing chains, the request will be completed successfully and the relevant metadata will be recorded onchain. And you will be returned a record ID to confirm your ownership of the data. -2. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. -3. Any users can search/download onchain based on the record ID. -4. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. +Record metadata components -## Usage Scenarios +| Fields in record metadata | Description | +| ---------------------------- | ---------------------------------------- | +| record submit time | data submit time | +| record owner address | data owner's address on the target chain | +| record ID | record index ID | +| record description | data description | +| data hash | uploaded data hash | +| data size | uploaded data size | +| data | uploaded data itself | -### Build Usage Scenarios +1. Record module generates related metadata from uploaded data on the target chain, and it has the obvious advantages such as efficiency, auditability and traceability over the traditional record technologies. +2. Any users can initiate a record request. It will cost you some tokens. If there’s no identical data on the targt chain, the request will be completed successfully and the metadata of record payload will be recorded on the target chain. And you will be returned a record ID to confirm your ownership of the data. +3. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. +4. Any users can search/download onchain based on the record ID. +5. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. -``` -rm -rf iris -rm -rf .iriscli -iris init gen-tx --name=x --home=iris -iris init --gen-txs --chain-id=record-test -o --home=iris -iris start --home=iris -``` +## Usage Scenarios ### Usage Scenarios of Record on Chains @@ -37,15 +40,15 @@ Scenario 1: Record the data through cli iriscli record submit --description="test" --onchain-data=x --from=x --fee=0.04iris # Result -Committed at block 4 (tx hash: F649D5465A28842B50CAE1EE5950890E33379C45, response: {Code:0 Data:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98] Log:Msg 0: Info: GasWanted:200000 GasUsed:3857 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100]} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 109 57 51 99 103 57 54 51 56 121 115 104 116 116 100 109 119 54 57 97 121 118 51 103 106 53 102 116 116 109 108 120 51 99 102 121 107 109]} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 97 98 57 100 57 57 100 48 99 102 102 54 53 51 100 99 54 101 56 53 52 53 99 56 99 99 55 50 101 53 53 51 51 100 101 97 97 97 49 50 53 53 50 53 52 97 100 102 100 54 98 48 48 55 52 101 50 56 54 57 54 54 49 98]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[2 189 149 142 250 208 0]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +Committed at block 1845 (tx hash: E620F3CD62BD9128443BA168296FFECC9BE2AF8F45CF21FD8FDA609DEFA253ED, response: {Code:0 Data:[114 101 99 111 114 100 58 101 56 51 102 57 102 50 55 55 100 101 99 102 54 98 57 52 102 100 55 50 55 100 52 54 53 99 49 51 52 54 57 102 53 53 50 48 51 57 56 56 57 102 98 101 102 99 56 97 49 99 55 52 101 48 54 99 54 56 48 57 98 48 101] Log:Msg 0: Info: GasWanted:200000 GasUsed:3978 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 48 117 115 121 50 50] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 101 56 51 102 57 102 50 55 55 100 101 99 102 54 98 57 52 102 100 55 50 55 100 52 54 53 99 49 51 52 54 57 102 53 53 50 48 51 57 56 56 57 102 98 101 102 99 56 97 49 99 55 52 101 48 54 99 54 56 48 57 98 48 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 57 53 54 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) { "tags": { "action": "submit-record", - "completeConsumedTxFee-iris-atto": "\u0002\ufffd\ufffd\ufffd\ufffd\ufffd\u0000", - "ownerAddress": "faa1m93cg9638yshttdmw69ayv3gj5fttmlx3cfykm", - "record-id": "record:ab9d99d0cff653dc6e8545c8cc72e5533deaaa1255254adfd6b0074e2869661b" + "completeConsumedTxFee-iris-atto": "\"795600000000000\"", + "ownerAddress": "faa15grv3xg3ekxh9xrf79zd0w077krgv5xf0usy22", + "record-id": "record:e83f9f277decf6b94fd727d465c13469f552039889fbefc8a1c74e06c6809b0e" } - } +} # Query the Status of the Records iriscli record query --record-id=x diff --git a/docs/modules/record/README.md b/docs/modules/record/README.md deleted file mode 100644 index e71ffe356..000000000 --- a/docs/modules/record/README.md +++ /dev/null @@ -1,88 +0,0 @@ -# Record User Guide - -## Basic Function Description - -1. On-Chain record for the text data -2. On-Chain record for the text file (TODO) -3. On-Chain governance for the record params (TODO) - -## Interaction - -### Record Introduction - -Record metadata components - -| Fields in record metadata | Description | -| ---------------------------- | ---------------------------------------- | -| record submit time | data submit time | -| record owner address | data owner's address on the target chain | -| record ID | record index ID | -| record description | data description | -| data hash | uploaded data hash | -| data size | uploaded data size | -| data | uploaded data itself | - -1. Record module generates related metadata from uploaded data on the target chain, and it has the obvious advantages such as efficiency, auditability and traceability over the traditional record technologies. -2. Any users can initiate a record request. It will cost you some tokens. If there’s no identical data on the targt chain, the request will be completed successfully and the metadata of record payload will be recorded on the target chain. And you will be returned a record ID to confirm your ownership of the data. -3. If any others initiate a record request for the same data, the request will be directly rejected and it will hint that the relevant record data has already existed. -4. Any users can search/download onchain based on the record ID. -5. At present, the maximum amount of stored data at most 1K Bytes. In the future, the dynamic adjustment of parameters will be implemented in conjunction with the governance module. - -## Usage Scenarios - -### Usage Scenarios of Record on Chains - -Scenario 1: Record the data through cli - -``` -# Specify the text data which needs to be recorded by --onchain-data - -iriscli record submit --description="test" --onchain-data=x --from=x --fee=0.04iris - -# Result -Committed at block 1845 (tx hash: E620F3CD62BD9128443BA168296FFECC9BE2AF8F45CF21FD8FDA609DEFA253ED, response: {Code:0 Data:[114 101 99 111 114 100 58 101 56 51 102 57 102 50 55 55 100 101 99 102 54 98 57 52 102 100 55 50 55 100 52 54 53 99 49 51 52 54 57 102 53 53 50 48 51 57 56 56 57 102 98 101 102 99 56 97 49 99 55 52 101 48 54 99 54 56 48 57 98 48 101] Log:Msg 0: Info: GasWanted:200000 GasUsed:3978 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 114 101 99 111 114 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[111 119 110 101 114 65 100 100 114 101 115 115] Value:[102 97 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 48 117 115 121 50 50] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[114 101 99 111 114 100 45 105 100] Value:[114 101 99 111 114 100 58 101 56 51 102 57 102 50 55 55 100 101 99 102 54 98 57 52 102 100 55 50 55 100 52 54 53 99 49 51 52 54 57 102 53 53 50 48 51 57 56 56 57 102 98 101 102 99 56 97 49 99 55 52 101 48 54 99 54 56 48 57 98 48 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 57 53 54 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "submit-record", - "completeConsumedTxFee-iris-atto": "\"795600000000000\"", - "ownerAddress": "faa15grv3xg3ekxh9xrf79zd0w077krgv5xf0usy22", - "record-id": "record:e83f9f277decf6b94fd727d465c13469f552039889fbefc8a1c74e06c6809b0e" - } -} - -# Query the Status of the Records -iriscli record query --record-id=x - -# Download the Record -iriscli record download --record-id=x --file-name="download" - -``` - -Scenario 2: Query the transactions including recorded data onchain through cli - -``` -# Query the status of the records onchain -iriscli tendermint txs --tag "action='submit-record'" -``` - -## Details of cli - -``` -iriscli record submit --description="test" --onchain-data=x --chain-id="record-test" --from=x --fee=0.04iris -``` - -* `--onchain-data` The data needs to be recorded - - -``` -iriscli record query --record-id=x --chain-id="record-test" -``` - -* `--record-id` Record ID to be queried - - -``` -iriscli record download --record-id=x --file-name="download" --chain-id="record-test" -``` - -* `--file-name` The filename of recorded data, in the directory specified by `--home` From f097e729617395c3570fe9dcce8edec105293fb3 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Thu, 15 Nov 2018 17:50:03 +0800 Subject: [PATCH 025/100] Refactor irisnet docs -zh --- docs/zh/cli-client/README.md | 1 + docs/zh/cli-client/bank/README.md | 1 + docs/zh/cli-client/gov/README.md | 1 + docs/zh/cli-client/keys/README.md | 30 + docs/zh/cli-client/keys/add.md | 69 ++ docs/zh/cli-client/service/README.md | 1 + docs/zh/cli-client/stake/README.md | 1 + docs/zh/cli-client/status/README.md | 1 + docs/zh/cli-client/tendermint/README.md | 1 + docs/zh/cli-client/upgrade/README.md | 1 + docs/zh/features/README.md | 13 + docs/zh/features/bank.md | 0 docs/zh/features/distribution.md | 0 .../gov/README.md => features/governance.md} | 0 .../record/README.md => features/record.md} | 0 .../README.md => features/service.md} | 0 docs/zh/features/stake.md | 94 ++ docs/zh/features/test.proto | 21 + .../upgrade/README.md => features/upgrade.md} | 0 docs/zh/get-started/Bech32-on-IRISnet.md | 36 - docs/zh/get-started/Download-Rainbow.md | 5 + docs/zh/get-started/Full-Node.md | 108 -- .../get-started/Genesis-Generation-Process.md | 70 -- docs/zh/get-started/Install-Iris.md | 117 -- docs/zh/get-started/Install-the-Software.md | 2 + docs/zh/get-started/Join-the-Testnet.md | 5 + docs/zh/get-started/README.md | 50 - docs/zh/get-started/Validator-Node.md | 127 -- docs/zh/get-started/irislcd.md | 36 - docs/zh/introduction/README.md | 8 + .../introduction/The-IRIS-Hub/Delegators.md | 1 + .../introduction/The-IRIS-Hub/IRIS-Tokens.md | 1 + .../The-IRIS-Hub/Proof-of-Stake.md | 1 + .../introduction/The-IRIS-Hub/Validators.md | 1 + .../introduction/The-IRIS-Network/README.md | 1 + .../The-IRIS-Service/Consumers.md | 1 + .../The-IRIS-Service/Lifecycle.md | 1 + .../The-IRIS-Service/Providers.md | 1 + docs/zh/light-client/README.md | 0 docs/zh/pics/flow.jpg | Bin 0 -> 51942 bytes docs/zh/pics/iris.jpg | Bin 0 -> 44414 bytes docs/zh/pics/states.png | Bin 0 -> 62923 bytes docs/zh/resources/README.md | 1 + docs/zh/resources/delegator-faq.md | 94 ++ docs/zh/resources/validator-faq.md | 3 + docs/zh/resources/whitepaper-en.md | 1032 +++++++++++++++++ docs/zh/resources/whitepaper-kr.md | 1 + docs/zh/resources/whitepaper-zh.md | 616 ++++++++++ docs/zh/software/README.md | 0 .../software/basic-concepts/bech32-prefix.md | 0 .../basic-concepts/coin-type.md} | 0 .../Fee.md => software/basic-concepts/fee.md} | 0 .../software/basic-concepts/genesis-file.md | 0 docs/zh/software/basic-concepts/gov-params.md | 0 docs/zh/software/basic-concepts/inflation.md | 0 docs/zh/software/cli-client.md | 0 docs/zh/software/light-client.md | 0 .../monitor.md} | 0 docs/zh/software/node.md | 0 ...ow-to-participate-in-onchain-governance.md | 68 -- docs/zh/validators/Setup-Sentry-Node.md | 54 - 61 files changed, 2010 insertions(+), 666 deletions(-) create mode 100644 docs/zh/cli-client/README.md create mode 100644 docs/zh/cli-client/bank/README.md create mode 100644 docs/zh/cli-client/gov/README.md create mode 100644 docs/zh/cli-client/keys/README.md create mode 100644 docs/zh/cli-client/keys/add.md create mode 100644 docs/zh/cli-client/service/README.md create mode 100644 docs/zh/cli-client/stake/README.md create mode 100644 docs/zh/cli-client/status/README.md create mode 100644 docs/zh/cli-client/tendermint/README.md create mode 100644 docs/zh/cli-client/upgrade/README.md create mode 100644 docs/zh/features/README.md create mode 100644 docs/zh/features/bank.md create mode 100644 docs/zh/features/distribution.md rename docs/zh/{modules/gov/README.md => features/governance.md} (100%) rename docs/zh/{modules/record/README.md => features/record.md} (100%) rename docs/zh/{modules/iservice/README.md => features/service.md} (100%) create mode 100644 docs/zh/features/stake.md create mode 100644 docs/zh/features/test.proto rename docs/zh/{modules/upgrade/README.md => features/upgrade.md} (100%) delete mode 100644 docs/zh/get-started/Bech32-on-IRISnet.md create mode 100644 docs/zh/get-started/Download-Rainbow.md delete mode 100644 docs/zh/get-started/Full-Node.md delete mode 100644 docs/zh/get-started/Genesis-Generation-Process.md delete mode 100644 docs/zh/get-started/Install-Iris.md create mode 100644 docs/zh/get-started/Install-the-Software.md create mode 100644 docs/zh/get-started/Join-the-Testnet.md delete mode 100644 docs/zh/get-started/Validator-Node.md delete mode 100644 docs/zh/get-started/irislcd.md create mode 100644 docs/zh/introduction/README.md create mode 100644 docs/zh/introduction/The-IRIS-Hub/Delegators.md create mode 100644 docs/zh/introduction/The-IRIS-Hub/IRIS-Tokens.md create mode 100644 docs/zh/introduction/The-IRIS-Hub/Proof-of-Stake.md create mode 100644 docs/zh/introduction/The-IRIS-Hub/Validators.md create mode 100644 docs/zh/introduction/The-IRIS-Network/README.md create mode 100644 docs/zh/introduction/The-IRIS-Service/Consumers.md create mode 100644 docs/zh/introduction/The-IRIS-Service/Lifecycle.md create mode 100644 docs/zh/introduction/The-IRIS-Service/Providers.md create mode 100644 docs/zh/light-client/README.md create mode 100644 docs/zh/pics/flow.jpg create mode 100644 docs/zh/pics/iris.jpg create mode 100644 docs/zh/pics/states.png create mode 100644 docs/zh/resources/README.md create mode 100644 docs/zh/resources/delegator-faq.md create mode 100644 docs/zh/resources/validator-faq.md create mode 100644 docs/zh/resources/whitepaper-en.md create mode 100644 docs/zh/resources/whitepaper-kr.md create mode 100644 docs/zh/resources/whitepaper-zh.md create mode 100644 docs/zh/software/README.md create mode 100644 docs/zh/software/basic-concepts/bech32-prefix.md rename docs/zh/{modules/coin/README.md => software/basic-concepts/coin-type.md} (100%) rename docs/zh/{modules/fee-token/Fee.md => software/basic-concepts/fee.md} (100%) create mode 100644 docs/zh/software/basic-concepts/genesis-file.md create mode 100644 docs/zh/software/basic-concepts/gov-params.md create mode 100644 docs/zh/software/basic-concepts/inflation.md create mode 100644 docs/zh/software/cli-client.md create mode 100644 docs/zh/software/light-client.md rename docs/zh/{tools/Deploy-IRIS-Monitor.md => software/monitor.md} (100%) create mode 100644 docs/zh/software/node.md delete mode 100644 docs/zh/validators/How-to-participate-in-onchain-governance.md delete mode 100644 docs/zh/validators/Setup-Sentry-Node.md diff --git a/docs/zh/cli-client/README.md b/docs/zh/cli-client/README.md new file mode 100644 index 000000000..c1901202e --- /dev/null +++ b/docs/zh/cli-client/README.md @@ -0,0 +1 @@ +# CLi Client diff --git a/docs/zh/cli-client/bank/README.md b/docs/zh/cli-client/bank/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/zh/cli-client/bank/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/zh/cli-client/gov/README.md b/docs/zh/cli-client/gov/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/zh/cli-client/gov/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/zh/cli-client/keys/README.md b/docs/zh/cli-client/keys/README.md new file mode 100644 index 000000000..410208962 --- /dev/null +++ b/docs/zh/cli-client/keys/README.md @@ -0,0 +1,30 @@ +# iriscli keys + +## Description + +Keys allows you to manage your local keystore for tendermint. + +## Usage + +```shell +iriscli keys [command] +``` + +## Available Commands + +| Name | Description | +| ------------- | ------------------------------------- | +| [add](add.md) | Create a new key, or import from seed | +| list | List all keys | +| show | Show key info for the given name | +| delete | Delete the given key | + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | ------- | ------------- | -------- | +| --help, -h | | help for keys | | + +## Extended description + +These keys may be in any format supported by go-crypto and can be used by light-clients, full nodes, or any other application that needs to sign with a private key. diff --git a/docs/zh/cli-client/keys/add.md b/docs/zh/cli-client/keys/add.md new file mode 100644 index 000000000..2174b8c7c --- /dev/null +++ b/docs/zh/cli-client/keys/add.md @@ -0,0 +1,69 @@ +# iriscli keys add + +## Description + +Create a new key, or import from seed + +## Usage + +``` +iriscli keys add [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --account | | [uint32] Account number for HD derivation | | +| --dry-run | | Perform action, but don't add key to local keystore | | +| --help, -h | | help for add | | +| --index | | [uint32] Index number for HD derivation | | +| --ledger | | Store a local reference to a private key on a Ledger device | | +| --no-backup | | Don't print out seed phrase (if others are watching the terminal) | | +| --recover | | Provide seed phrase to recover existing key instead of creating | | +| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | + +## Examples + +### Create a new key + +```shell +iriscli keys add MyKey +``` + +You'll be asked to enter a password for your key, note: password must be at least 8 characters. + +```txt +Enter a passphrase for your key: +Repeat the passphrase: +``` + +After that, you're done with creating a new key, but remember to backup your seed phrase, it is the only way to recover your account if you ever forget your password or lose your key. + +```txt +NAME: TYPE: ADDRESS: PUBKEY: +MyKey local faa1mmsm487rqkgktl2qgrjad0z3yaf9n8t5pkp33m fap1addwnpepq2g0u7cnxp5ew0yhqep8j4rth5ugq8ky7gjmunk8tkpze95ss23ak4svkjq +**Important** write this seed phrase in a safe place. +It is the only way to recover your account if you ever forget your password. + +oval green shrug term already arena pilot spirit jump gain useful symbol hover grid item concert kiss zero bleak farm capable peanut snack basket +``` + +The 24 words above is a seed phrase just for example, **DO NOT** use it in production. + +### Recover an existing key + +If you forget your password or lose your key, or you wanna use your key in another place, you can recover your key by your seed phrase. + +```txt +iriscli keys add MyKey --recover +``` + +You'll be asked to enter a new password for your key, and enter the seed phrase. Then you get your key back. + +```txt +Enter a passphrase for your key: +Repeat the passphrase: +Enter your recovery seed phrase: +``` + diff --git a/docs/zh/cli-client/service/README.md b/docs/zh/cli-client/service/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/zh/cli-client/service/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/zh/cli-client/stake/README.md b/docs/zh/cli-client/stake/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/zh/cli-client/stake/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/zh/cli-client/status/README.md b/docs/zh/cli-client/status/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/zh/cli-client/status/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/zh/cli-client/tendermint/README.md b/docs/zh/cli-client/tendermint/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/zh/cli-client/tendermint/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/zh/cli-client/upgrade/README.md b/docs/zh/cli-client/upgrade/README.md new file mode 100644 index 000000000..5083eb47f --- /dev/null +++ b/docs/zh/cli-client/upgrade/README.md @@ -0,0 +1 @@ +# iriscli \ No newline at end of file diff --git a/docs/zh/features/README.md b/docs/zh/features/README.md new file mode 100644 index 000000000..74212951c --- /dev/null +++ b/docs/zh/features/README.md @@ -0,0 +1,13 @@ +# Features + +## Bank + +## Stake + +## Service + +## Record + +## Governance + +## Distribution \ No newline at end of file diff --git a/docs/zh/features/bank.md b/docs/zh/features/bank.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/features/distribution.md b/docs/zh/features/distribution.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/modules/gov/README.md b/docs/zh/features/governance.md similarity index 100% rename from docs/zh/modules/gov/README.md rename to docs/zh/features/governance.md diff --git a/docs/zh/modules/record/README.md b/docs/zh/features/record.md similarity index 100% rename from docs/zh/modules/record/README.md rename to docs/zh/features/record.md diff --git a/docs/zh/modules/iservice/README.md b/docs/zh/features/service.md similarity index 100% rename from docs/zh/modules/iservice/README.md rename to docs/zh/features/service.md diff --git a/docs/zh/features/stake.md b/docs/zh/features/stake.md new file mode 100644 index 000000000..2189c8edd --- /dev/null +++ b/docs/zh/features/stake.md @@ -0,0 +1,94 @@ +# Delegators + +## What is a delegator? +People that cannot, or do not want to run validator operations, can still participate in the staking process as delegators. Indeed, validators are not chosen based on their own stake +but based on their total stake, which is the sum of their own stake and of the stake that is delegated to them. This is an important property, as it makes delegators a safeguard against + validators that exhibit bad behavior. If a validator misbehaves, its delegators will move their Atoms away from it, thereby reducing its stake. Eventually, if a validator's stake falls + under the top 100 addresses with highest stake, it will exit the validator set. + +## States for a Delegator + +Delegators have the same state as their validator. + + +Note that delegation are not necessarily bonded. Tokens of each delegator can be delegated and bonded, delegated and unbonding, delegated and unbonded, or loose. + +## Common operation for Delegators + +* Delegation + +To delegate some IRIS token to a validator, you could run the following command: +```$xslt +iriscli stake delegate --address-delegator= --address-validator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --amount=10000000000000000000iris +``` +> Please notice that the amount is under unit iris-atto, 1iris=10^18 iris-atto + +* Query Delegations + +You could query your delegation amount with the following command: + +```$xslt +iriscli stake delegation --address-delegator= --address-validator= --chain-id=fuxi-3001 +``` + +The example output is the following: +```$xslt +Delegation +Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 +Validator: faa1dmp6eyjw94u0wzc67qa03cmgl92qwqaph28lxq +Shares: 10000000000000000000/1Height: 215307 +``` + +> Please notice that the share amount is also correspond to iris-atto, 1iris=10^18 iris-atto + + +* Re-delegate + +Once a delegator has delegated his own IRIS to certain validator, he/she could change the destination of delegation at anytime. If the transaction is executed, the +delegation will be placed at the other's pool after 10 minutes. + +The redelegation operation is composed of two phases: + * redelegate begin + * redelegate complete + + To start, you should run the following command: +```$xslt +iriscli stake redelegate begin --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 +``` + +Please note that you have to wait 10 minute to run the next command: + +```$xslt +iriscli stake redelegate complete --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris +``` + +The example output is the following: +```$xslt +Delegation +Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 +Validator: faa1kepndxvjr6gnc8tjcnelp9hqz8jdcs8mvz7m86 +Shares: 10000000000000000000/1Height: 215459 +``` + +* Unbond Delegation + + +Once a delegator has delegated his own IRIS to certain validator, he/she could withdraw the delegation at anytime. If the transaction is executed, the +delegation will become liquid after 10 minutes. + +The redelegation operation is composed of two phases: + * unbond begin + * unbond complete + + To start, you should run the following command: +```$xslt +iriscli stake unbond begin --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 +``` + +Please note that you have to wait 10 minute to run the next command: + +```$xslt +iriscli stake unbond complete --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris +``` + +You could check that the balance of delegator has increased. \ No newline at end of file diff --git a/docs/zh/features/test.proto b/docs/zh/features/test.proto new file mode 100644 index 000000000..ccb70ab00 --- /dev/null +++ b/docs/zh/features/test.proto @@ -0,0 +1,21 @@ +syntax = "proto3"; + +package helloworld; + +// The greeting service definition. +service Greeter { + //@Attribute description: sayHello + //@Attribute output_privacy: NoPrivacy + //@Attribute output_cached: NoCached + rpc SayHello (HelloRequest) returns (HelloReply) {} +} + +// The request message containing the user's name. +message HelloRequest { + string name = 1; +} + +// The response message containing the greetings +message HelloReply { + string message = 1; +} diff --git a/docs/zh/modules/upgrade/README.md b/docs/zh/features/upgrade.md similarity index 100% rename from docs/zh/modules/upgrade/README.md rename to docs/zh/features/upgrade.md diff --git a/docs/zh/get-started/Bech32-on-IRISnet.md b/docs/zh/get-started/Bech32-on-IRISnet.md deleted file mode 100644 index a62927bb4..000000000 --- a/docs/zh/get-started/Bech32-on-IRISnet.md +++ /dev/null @@ -1,36 +0,0 @@ -# Bech32 on IRISnet - -Bech32 is a new Bitcoin address format proposed by Pieter Wuille and Greg Maxwell. Besides Bitcoin addresses, Bech32 can encode any short binary data. In the IRIS network, keys and addresses may refer to a number of different roles in the network like accounts, validators etc. The IRIS network is designed to use the Bech32 address format to provide robust integrity checks on data. The human readable part(HRP) makes it more efficient to read and the users could see error messages. - - -## Human Readable Part Table - - -| HRP | Definition | -| ------------- |:-------------:| -|faa |IRISnet Account Address| -|fap| IRISnet Account Public Key| -|fva |IRISnet Consensus Address| -|fvp| IRISnet Consensus Public Key| - -## Separator - -Why include a separator in addresses? That way the human-readable part is unambiguously separated from the data part, avoiding potential collisions with other human-readable parts that share a prefix. It also allows us to avoid having character-set restrictions on the human-readable part. The separator is 1 because using a non-alphanumeric character would complicate copy-pasting of addresses (with no double-click selection in several applications). Therefore an alphanumeric character outside the normal character set was chosen. - -## Encoding - -Not all interfaces to users IRISnet should be exposed as bech32 interfaces. Many address are still in hex or base64 encoded form. - -To covert between other binary reprsentation of addresses and keys, it is important to first apply the Amino enocoding process before bech32 encoding. - - -## Example - -Once you create a new address, you should see the following: - -` -NAME: TYPE: ADDRESS: PUBKEY: -test1 local faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv -` - -This means you have created a new address `faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl`, its hrp is `faa`. And its public key could be encoded into `fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv`, its hrp is `fap`. \ No newline at end of file diff --git a/docs/zh/get-started/Download-Rainbow.md b/docs/zh/get-started/Download-Rainbow.md new file mode 100644 index 000000000..dd91119ee --- /dev/null +++ b/docs/zh/get-started/Download-Rainbow.md @@ -0,0 +1,5 @@ +# IRISnet Testnet Codename Fuxi + +## What is IRISnet + +IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. diff --git a/docs/zh/get-started/Full-Node.md b/docs/zh/get-started/Full-Node.md deleted file mode 100644 index be996147c..000000000 --- a/docs/zh/get-started/Full-Node.md +++ /dev/null @@ -1,108 +0,0 @@ -# 如何运行一个全节点 - -## 配置 - -### 设置软件运行的目录 - -iris在运行过程中所依赖的配置文件和数据会存放在\$IRISHOME下，所以在运行iris前，需要指定一个目录作为\$IRISHOME。\$IRISHOME默认为：/Users/$user/.iris。 - -在\$IRISHOME需要设置两个文件夹：/config 和 /data - -### 下载配置文件文件 -iris运行中需要用到两个重要的文件：genesis.json 和config.toml - -genesis文件中定义了区块链网络的初始状态，而config.toml指定了iris软件模块的重要组成部分。 - -下载这两个文件到/$IRISHOME/config目录下： - -``` -cd $IRISHOME/config/ -wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/config.toml -wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/genesis.json -``` -### 修改配置文件 -在config.toml文件中可以配置以下信息： -* 将`moniker`字段配置称为自定义的名称，这样便于区分不同的节点 -* `seed`字段用语设置种子节点，在fuxi-4000中的官方中字节点为： -``` -c16700520a810b270206d59f0f02ea9abd85a4fe@ts-1.bianjie.ai:26656 -a12cfb2f535210ea12731f94a76b691832056156@ts-2.bianjie.ai:26656 -``` - -你也可以配置 `moniker` 和 `external_address` 字段. - -``` -moniker = "" -external_address = "your-public-IP:26656" -``` - - -另外，如果你需要与其他节点通过内网链接，请设置 `addr_book_strict` 为 `false` 。 - -``` -addr_book_strict = false -``` -### 配置端口 - -如果你的节点需要与其他节点建立链接，则需要开放 `26656` 端口；若需要通过rpc端口查询Tendermint提供的信息，则需要开放 `26657` 端口。 - -通过以下命令启动全节点，并将日志输出到文件中： -``` -iris start --home {path_to_your_home} > log文件地址 & -``` -通过执行以下操作确认节点的运行状态： -``` -iriscli status -``` -示例输出： -```json -{"node_info":{"id":"3fb472c641078eaaee4a4acbe32841f18967672c","listen_addr":"172.31.0.190:26656","network":"fuxi-4000","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:26657"]},"sync_info":{"latest_block_hash":"7B1168B2055B19F811773EEE56BB3C9ECB6F3B37","latest_app_hash":"B8F7F8BF18E3F1829CCDE26897DB905A51AF4372","latest_block_height":12567,"latest_block_time":"2018-08-25T11:33:13.164432273Z","catching_up":false},"validator_info":{"address":"CAF80DAEC0F4A7036DD2116B56F89B07F43A133E","pub_key":{"type":"AC26791624DE60","value":"Cl6Yq+gqZZY14QxrguOaZqAswPhluv7bDfcyQx2uSRc="},"voting_power":0}} -``` -通过以上命令可以查看状态： - -* `"catching_up":false`: 表示节点与网络保持同步 - -* `"catching_up":true`: 表示节点正在同步区块 - -* `"latest_block_height"`: 表示最新的区块高度 - - -之后你就应该可以在浏览器中看到 - -## 重置一个全节点 - -若需要将一个节点重启，则可以通过以下命令让节点再次通过与网络保持同步。 - -### 重置IRIShub节点流程如下： - -1. 关闭iris进程 -``` -kill -9 -``` - -若Genesis文件有变动，则需要下载新的文件到$IRISHOME/config目录下。 - -2. 重置iris -``` -iris unsafe_reset_all --home= -``` - -3. 重新启动 - -通过以下命令启动全节点，并将日志输出到文件中： -``` -iris start --home > log文件地址 & -``` -通过执行以下操作确认节点的运行状态： -``` -iriscli status -``` -示例输出： -```json -{"node_info":{"id":"3fb472c641078eaaee4a4acbe32841f18967672c","listen_addr":"172.31.0.190:26656","network":"fuxi-4000","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:26657"]},"sync_info":{"latest_block_hash":"7B1168B2055B19F811773EEE56BB3C9ECB6F3B37","latest_app_hash":"B8F7F8BF18E3F1829CCDE26897DB905A51AF4372","latest_block_height":12567,"latest_block_time":"2018-08-25T11:33:13.164432273Z","catching_up":false},"validator_info":{"address":"CAF80DAEC0F4A7036DD2116B56F89B07F43A133E","pub_key":{"type":"AC26791624DE60","value":"Cl6Yq+gqZZY14QxrguOaZqAswPhluv7bDfcyQx2uSRc="},"voting_power":100}} -``` -通过以上命令可以查看状态： - -* `"catching_up":false`: 表示节点与网络保持同步 - -* `"latest_block_height"`: 表示最新的区块高度 \ No newline at end of file diff --git a/docs/zh/get-started/Genesis-Generation-Process.md b/docs/zh/get-started/Genesis-Generation-Process.md deleted file mode 100644 index 367a75e74..000000000 --- a/docs/zh/get-started/Genesis-Generation-Process.md +++ /dev/null @@ -1,70 +0,0 @@ -# 参与Genesis文件生成 - - -1. 每个希望成为验证人的参与者确保请根据一下[教程](Install-Iris.md) 在服务器上完成**Iris**的安装。 - -2. 执行gentx命令，获得一个node-id.json的文件。这个操作将默认生成一个余额为200IRIS的账户，该账户默认绑定100IRIS成为一个验证人候选人。 - -``` -iris init gen-tx --name=your_name --home= --ip=Your_public_IP -``` -* 代码示例： -``` -iris init gen-tx --name=alice -``` - -``` - { - "app_message": { - "secret": "village venue about lend pause popular vague swarm blue unusual level drastic field broken moral north repair blue accident miss essay loan rail harbor" - }, - "gen_tx_file": { - "node_id": "1b45f5bb7ba1e00be01e8795dcaa0e8008f28cb5", - "ip": "192.168.150.206", - "validator": { - "pub_key": { - "type": "tendermint/PubKeyEd25519", - "value": "NlMcGgz05K45ukGY10R8DApp8A0N0Jv4F2/OKtq9fCU=" - }, - "power": "100", - "name": "" - }, - "app_gen_tx": { - "name": "tom", - "address": "faa1mmnaknf87p7uu80m6uthyssd2ge0s73hcfr05h", - "pub_key": "fap1zcjduepqxef3cxsv7nj2uwd6gxvdw3rups9xnuqdphgfh7qhdl8z4k4a0sjsxh3kgg" - } - } - } - ``` -然后你可以发现在$IRISHOME/config目录下生成了一个gentx文件夹。里面存在一个gentx-node-ID.json文件。这个文件包含了如下信息： - -``` -{ - "node_id": "612db83e7facdd9abab879f7e465ed829f3f3487", - "ip": "192.168.150.223", - "validator": { - "pub_key": { - "type": "tendermint/PubKeyEd25519", - "value": "bzLIySQ4YDwBIkTgeyrnBx7VEoQ23zDnWhIV4FEEOZ4=" - }, - "power": "100", - "name": "" - }, - "app_gen_tx": { - "name": "haoyang-virtualbox2", - "address": "faa1k96h5cyppg6q2meftv6epuw39u5dd0sa8t84fv", - "pub_key": "fap1zcjduepqduev3jfy8psrcqfzgns8k2h8qu0d2y5yxm0npe66zg27q5gy8x0qh7wt9l" - } - } -``` -validator字段对应了home/config下的节点信息 - -`app_gen_tx`中说明了拥有这个节点的账户信息。这个账户的助记词就是刚刚的secret - -3. 将上述提到的json文件以提交Pull Request的形式上传到`https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gentx`目录下： - -> 注意:json文中的IP改成公网IP - -4. 在收集完参与者的gentx文件后，团队将在一下目录公布fuxi-4000测试网的配置文件：`https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config`。然后你就可以下载genesis.json和config.toml文件了。 - diff --git a/docs/zh/get-started/Install-Iris.md b/docs/zh/get-started/Install-Iris.md deleted file mode 100644 index a1a5f0306..000000000 --- a/docs/zh/get-started/Install-Iris.md +++ /dev/null @@ -1,117 +0,0 @@ -### 安装IRIShub - -#### 服务器配置要求 - - -首先，你需要配置一台服务器。你的验证人节点应该能够一直运行，使用你可能需要在一台数据中心的服务器。任何像AWS、GCP、DigitalOcean中的云服务器都是适合的。 - -IRIS Hub是用Go语言编写的。它可以在任何能够编译并运行Go语言程序的平台上工作。然而，我强烈建议在Linux服务器上运行验证人节点。我曾经尝试在Windows上运行验证人节点。我能够顺利的编译但是在运行的时候会有一些问题。接下来的说明和指导都是基于Linux服务器的。 -这是我们推荐的服务器的配置： - -* CPU核数：2 -* 内存容量：2GB -* 磁盘空间：40GB -* 操作系统：Ubuntu 18.04 LTS/16.04 LTS -* 允许的入方向的链接：TCP端口 26656 和 26657 - - -#### 方法1：下载发行版安装 - -进入下载页: https://github.com/irisnet/irishub/releases/ -下载对应版本的可执行文件 -解压缩 -``` -tar -C /usr/local/bin -xzf iris$VERSION.$OS-$ARCH.zip -``` -拷贝到/usr/local/bin/目录下 -执行以下命令,若出现对应的版本号则说明安装成功。 - -``` -$ iris version -v0.6.0 - -$ iriscli version -v0.6.0 -``` -#### 方法2：源码编译安装 - -#### 安装Go版本 1.10+ - - -系统要求： - -Ubuntu LTS 16.04 - - -安装IRISHub需要保证Go的版本在1.10以上， - -通过执行以下命令安装1.10版本的Go。 - -``` -$ sudo add-apt-repository ppa:gophers/archive -$ sudo apt-get update -$ sudo apt-get install golang-1.10-go -``` - -以上命令将安装 golang-1.10-go在 /usr/lib/go-1.10/bin. 需要将它加入到PATH中 - -``` -echo "export PATH=$PATH:/usr/lib/go-1.10/bin" >> ~/.bash_profile -source ~/.bash_profile -``` - -同时，你需要指定相关的 $GOPATH, $GOBIN, 和 $PATH 变量, 例如: - -``` -mkdir -p $HOME/go/bin -echo "export GOPATH=$HOME/go" >> ~/.bash_profile -source ~/.bash_profile -echo "export GOBIN=$GOPATH/bin" >> ~/.bash_profile -source ~/.bash_profile -echo "export PATH=$PATH:$GOBIN" >> ~/.bash_profile -source ~/.bash_profile -``` - -参考链接： - -1. https://golang.org/doc/install -2. https://github.com/golang/go/wiki/Ubuntu - - - -#### 下载源码并安装 - - -在完成Go的安装后，通过以下命令下载并安装IRIS hub相关程序. - -``` -mkdir -p $GOPATH/src/github.com/irisnet -cd $GOPATH/src/github.com/irisnet -git clone https://github.com/irisnet/irishub -cd irishub && git checkout v0.6.0 -curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh -make get_tools && get_vendor_deps && make install -``` - -以上命令将完成 iris 和 iriscli的安装. 若出现对应的版本号则说明安装成功。 - -``` -$ iris version -v0.6.0 - -$ iriscli version -v0.6.0 -``` -### 如何升级IRISHub - -通过执行一下命令可以完成IRISHub从v0.4.2到v0.6.0的升级 - -``` -cd $GOPATH/src/github.com/irisnet/irishub -git fetch -a origin -rm Gopkg.lock -git checkout v0.6.0 -make get_tools -make get_vendor_deps -make install -``` \ No newline at end of file diff --git a/docs/zh/get-started/Install-the-Software.md b/docs/zh/get-started/Install-the-Software.md new file mode 100644 index 000000000..d9786f2a0 --- /dev/null +++ b/docs/zh/get-started/Install-the-Software.md @@ -0,0 +1,2 @@ +# IRISnet Testnet Codename Fuxi + diff --git a/docs/zh/get-started/Join-the-Testnet.md b/docs/zh/get-started/Join-the-Testnet.md new file mode 100644 index 000000000..dd91119ee --- /dev/null +++ b/docs/zh/get-started/Join-the-Testnet.md @@ -0,0 +1,5 @@ +# IRISnet Testnet Codename Fuxi + +## What is IRISnet + +IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. diff --git a/docs/zh/get-started/README.md b/docs/zh/get-started/README.md index 2cfbb8abc..047f46d8e 100644 --- a/docs/zh/get-started/README.md +++ b/docs/zh/get-started/README.md @@ -4,53 +4,3 @@ IRIS Hub是在Cosmos生态中的区域性枢纽，提供iService服务 -## 如何加入fuxi测试网 - -### 第一步: 安装IRIShub - -请根据一下[教程](Install-Iris.md) 在服务器上完成**Iris**的安装。 - -### 第二步: 运行一个全节点 - -请根据一下[步骤](Full-Node.md) 完成初始化并开始在服务器上运行一个全节点。 - - -### 第三步: 将全节点升级成为一个验证人节点 - -请根据以下[步骤](Validator-Node.md) 将一个全节点升级成为验证人节点。 - -### 部署IRISHub Monitor监控 - -请根据以下[链接](../tools/Deploy-IRIS-Monitor.md) 在服务器上部署一个Monitor监控。 - - -### 如何成为一个验证人节点 - -如何你的节点已经完全同步了，那么要如何才能升级成为一个验证人节点你？ - -如果你参与到了genesis文件的生成过程中，那么只要你的节点与网络同时启动，它就会保持验证人的状态。 - -如果你并没有参与到genesis文件的生成过程中，那么你依然可以通过执行相关操作升级成为一个验证人。目前IRIShub的验证人上限是100。升级的流程在[这里](Validator-Node.md). - -### 部署哨兵节点 - -验证人有遭受攻击的风险。你可以根据以下[教程](../validators/Setup-Sentry-Node.md)部署一个哨兵节点来保护验证人。 - -## Fuxi测试网激励计划 - -IRIS基金会通过推出测试网激励计划来鼓励更多的人加入到Fuxi测试网中。在Fuxi-2000中，我们针对中国社区发布了测试网激励任务。一共有14位社区成员完成了任务。 - -Fuxi-2000 任务列表： https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-2000/README.md - -Fuxi-2000 任务完成情况：https://github.com/irisnet/testnets/issues/51 - -在Fuxi-3001测试网中， IRIS基金会决定推出更多的测试网激励计划。 - -Fuxi-3001任务列表: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-3001/README.md - -## 更多链接 - - -* Explorer: https://testnet.irisplorer.io/#/home - -* Riot chat: #irisvalidators:matrix.org \ No newline at end of file diff --git a/docs/zh/get-started/Validator-Node.md b/docs/zh/get-started/Validator-Node.md deleted file mode 100644 index f837b7291..000000000 --- a/docs/zh/get-started/Validator-Node.md +++ /dev/null @@ -1,127 +0,0 @@ -# 运行一个验证人节点 - -在配置验证人节点之前，请保证已经按照此[文档](Install-Iris.md)正确安装了**Iris** - -在IRISHub枢纽中，验证人负责将交易打包并提交区块。成为一个验证人需要满足很多条件，不仅仅是技术和硬件上的投资。同时，因为只有在有限验证人的条件下，Tendermint才能发挥最大的作用。目前，我们将IRISHub枢纽的验证人上限定为100。也就是说只有前100个验证人能够获得奖励，而大部分IRIS持有者不会成为验证人而是通过委托的方式决定谁会成为验证人。 - -## 如何升级成一个验证人节点 - -### 获取IRIS Token - -#### 创建一个账户 -你首先需要安装`iris` 和 `iriscli`。然后执行以下操作创建一个新的账户： - -``` -iriscli keys add -``` - -然后你需要输入至少8位的密码。 - -示例输出如下： -``` -NAME: TYPE: ADDRESS: PUBKEY: -tom local faa1arlugktm7p64uylcmh6w0g5m09ptvklxm5k69x fap1addwnpepqvlmtpv7tke2k93vlyfpy2sxup93jfulll6r3jty695dkh09tekrzagazek -**Important** write this seed phrase in a safe place. -It is the only way to recover your account if you ever forget your password. - -blast change tumble toddler rival ordinary chicken dirt physical club few language noise oak moment consider enemy claim elephant cruel people adult peanut garden -``` - -你可以查看到该账户的地址和公钥。在IRISHub中，地址经过bech32编码后将以`faa1`为首字节 ，另外公钥将以 `fap1`为首字节. - -账户的助记词(seed phrase)也将被显示出来。你可以使用该长度为24个单词的助记词在任意的机器上恢复你的账户。恢复账户的命令是: - -``` -iriscli keys add --recover -``` -### Claim tokens - - -一旦你完成了账户的创建，你可以通过[水龙头](https://testnet.irisplorer.io/#/faucet)获得用于测试网的IRIS token,然后你就可以将这部分IRIS用于绑定成为验证人。 -水龙头每次将发送10IRIS，请按需使用！ - -以下命令将查询你的账户的余额： - -``` -iriscli bank account --node=http://localhost:26657 -``` - -## 执行成为验证人操作 - -### 确认你的全节点与网络保持同步 - -通过以下命令确认节点的状况： -``` -iriscli status --node=tcp://localhost:26657 -``` -若 `catching_up` 字段为 `false`那么你的节点就是同步的。 - -你需要获取当前节点的公钥信息来执行以下操作，公钥信息以 `fvp`为首字节，想要了解更多的编码信息，请参考以下 [文档](Bech32-on-IRISnet.md) - -通过执行以下命令获得节点的公钥信息，公钥信息将以`fvp1`开头： - -``` -iris tendermint show_validator --home= < IRIS-HOME > -``` -示例输出: -``` -fvp1zcjduepqv7z2kgussh7ufe8e0prupwcm7l9jcn2fp90yeupaszmqjk73rjxq8yzw85 -``` -然后，使用以上输出作为`iriscli stake create-validator`命令的 `` 字段： - -``` -iriscli stake create-validator --from= < name > --amount= < amount >iris --pubkey= < pubkey > --moniker= < moniker > --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --node=http://localhost:26657 -``` -> 注意：**amount** 应为整数， **Fee** 字段可以使用小数，例如`0。01iris` 。 - -也就是说，如果你想要抵押1IRIS,你可以执行以下操作： - -``` -iriscli stake create-validator --pubkey=pubkey --fee=0.04iris --gas=2000000 --from= < name > --chain-id=fuxi-4000 --node=tcp://localhost:26657 --amount=1iris -``` - -### 查询验证人信息 - -你可以通过以下命令查询验证人的信息： - -``` -iriscli stake validator < address-validator-operator > --chain-id=fuxi-4000 --node=tcp://localhost:26657 -``` - -请注意 `` 字段是以`faa1`为首字母。 - - -### 确认验证人是否在线 - -你可以通过以下命令查询验证人节点的运行状况， - -``` -iriscli status --node=tcp://localhost:26657 -``` - -你应该可以看到节点的`power`字段返回值大于0。 - -### 编辑验证人信息 - -你可以通过以下命令修改验证人的描述信息，验证人的名称默认为`--moniker`字段。 -你应该在`details`字段注明自定义的信息。 - -``` -iriscli stake edit-validator --from= < name > --moniker="choose a moniker" --website="https://irisnet.org" --details="team" --chain-id=fuxi-4000 - --details="details"--node=tcp://localhost:26657 --fee=0.04iris --gas=2000000 -``` -### 查询验证人信息 - -你可以通过以下命令查询验证人的信息： - -``` -iriscli stake validator < address-validator-operator > --chain-id=fuxi-4000 -``` - -### 使用浏览器：IRISPlorer - -你可以通过[浏览器](https://testnet.irisplorer.io)确认验证人节点的运行状况。 - -### 部署IRISHub Monitor监控 - -请根据以下[链接](../tools/Deploy-IRIS-Monitor.md) 部署一个Monitor监控验证人。 diff --git a/docs/zh/get-started/irislcd.md b/docs/zh/get-started/irislcd.md deleted file mode 100644 index 5012ecb95..000000000 --- a/docs/zh/get-started/irislcd.md +++ /dev/null @@ -1,36 +0,0 @@ -# 介绍 - -irislcd是一个能连接到任何全节点并且提供rest API接口的服务。通过这些API接口，用户可以发起交易或者查询区块链上的数据。irislcd可以验证全节点返回数据的完整性和有效性，因此irislcd可以以最小的带宽资源，最小的计算需求和最小的存储消耗来获取可全节点一样的数据安全。另外，irislcd还提供swagger-ui页面，这个页面列出来所以得API接口并且附有详细的说明文档。 - -## Irislcd options - -irislcd有如下这些参数可以配置 - -| 参数名 | 类型 | 默认值 | 是否必须 | 功能介绍 | -| --------------- | --------- | ----------------------- | -------- | ---------------------------------------------------- | -| chain-id | 字符串 | null | true | 所连接的tendermint区块链网络的ID | -| home | 字符串 | "$HOME/.irislcd" | false | irislcd的home目录，用来存储秘钥和历史验证信息 | -| node | 字符串 | "tcp://localhost:26657" | false | 所要连接的全节点的url | -| laddr | 字符串 | "tcp://localhost:1317" | false | 侦听的网络端口 | -| trust-node | 布尔型 | false | false | 是否信任全节点 | -| max-open | 整型 | 1000 | false | 最大支持的连接数 | -| cors | 字符串 | "" | false | 是否支持跨域请求 | - -## Start Irislcd - -启动irislcd: -``` -irislcd start --chain-id= -``` -在浏览器中访问以下的url就可以打开Swagger-UI: -``` -http://localhost:1317/swagger-ui/ -``` -打印版本号. -``` -irislcd version -``` -如果所连接的全节点是可信的，可以加上`trust-node`: -``` -irislcd start --chain-id= --trust-node -``` diff --git a/docs/zh/introduction/README.md b/docs/zh/introduction/README.md new file mode 100644 index 000000000..857e7dd82 --- /dev/null +++ b/docs/zh/introduction/README.md @@ -0,0 +1,8 @@ +# Introduction + +## The IRIS hub + +## The IRIS Service + +## The IRIS Network + diff --git a/docs/zh/introduction/The-IRIS-Hub/Delegators.md b/docs/zh/introduction/The-IRIS-Hub/Delegators.md new file mode 100644 index 000000000..c8b484c90 --- /dev/null +++ b/docs/zh/introduction/The-IRIS-Hub/Delegators.md @@ -0,0 +1 @@ +# Delegators diff --git a/docs/zh/introduction/The-IRIS-Hub/IRIS-Tokens.md b/docs/zh/introduction/The-IRIS-Hub/IRIS-Tokens.md new file mode 100644 index 000000000..61d1755e3 --- /dev/null +++ b/docs/zh/introduction/The-IRIS-Hub/IRIS-Tokens.md @@ -0,0 +1 @@ +# IRIS Tokens diff --git a/docs/zh/introduction/The-IRIS-Hub/Proof-of-Stake.md b/docs/zh/introduction/The-IRIS-Hub/Proof-of-Stake.md new file mode 100644 index 000000000..7ec980837 --- /dev/null +++ b/docs/zh/introduction/The-IRIS-Hub/Proof-of-Stake.md @@ -0,0 +1 @@ +# Proof of Stake diff --git a/docs/zh/introduction/The-IRIS-Hub/Validators.md b/docs/zh/introduction/The-IRIS-Hub/Validators.md new file mode 100644 index 000000000..e41e267fe --- /dev/null +++ b/docs/zh/introduction/The-IRIS-Hub/Validators.md @@ -0,0 +1 @@ +# Validators diff --git a/docs/zh/introduction/The-IRIS-Network/README.md b/docs/zh/introduction/The-IRIS-Network/README.md new file mode 100644 index 000000000..8756dfd6a --- /dev/null +++ b/docs/zh/introduction/The-IRIS-Network/README.md @@ -0,0 +1 @@ +# The IRIS Network diff --git a/docs/zh/introduction/The-IRIS-Service/Consumers.md b/docs/zh/introduction/The-IRIS-Service/Consumers.md new file mode 100644 index 000000000..3476d964e --- /dev/null +++ b/docs/zh/introduction/The-IRIS-Service/Consumers.md @@ -0,0 +1 @@ +# Consumers diff --git a/docs/zh/introduction/The-IRIS-Service/Lifecycle.md b/docs/zh/introduction/The-IRIS-Service/Lifecycle.md new file mode 100644 index 000000000..75a17e1af --- /dev/null +++ b/docs/zh/introduction/The-IRIS-Service/Lifecycle.md @@ -0,0 +1 @@ +# Lifecycle diff --git a/docs/zh/introduction/The-IRIS-Service/Providers.md b/docs/zh/introduction/The-IRIS-Service/Providers.md new file mode 100644 index 000000000..ae4c68601 --- /dev/null +++ b/docs/zh/introduction/The-IRIS-Service/Providers.md @@ -0,0 +1 @@ +# Providers diff --git a/docs/zh/light-client/README.md b/docs/zh/light-client/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/pics/flow.jpg b/docs/zh/pics/flow.jpg new file mode 100644 index 0000000000000000000000000000000000000000..06101664b954c08ed7e5c24b8194559bf26c00ec GIT binary patch literal 51942 zcmdSBcU%)&w?01fF1?qaR0Tu?L}|f76A=&vsj+~75fBiF5D0?wCLpLFMT(%5h%_k@ z=^`M~dr1K4l29Xru$et&=5;WJ?}GugA(-fOSD*R!5Alwry=z;RK} zP!FJ@0ssT>51?Ry>$(V+I{;v83>*UhfDxdk;sR*EBP#F@2zLQ!e;osWH25C?XtJpO zel?5w_p4M-vuJ)lrkOmrk+KS$Hg$G?;O^z@eqUVq_zB?jIYVRGgVMn5*Rj;ELymsY zn2~tkJ?&x;)AJSLxj@P%fRmAClIkf9)e(T2lZu9uiqZ@~z#7p}{n~#04E&&?rlF;y zXJBMvW&v-g-~g*mLqknVLq~V;7^(p9IzY=w$8}igEIqf`O@<>LJSQI|yke9%SK7dP zr3Wvme9JSKiJ6aIKu}0ZT1NKhF%{KQYNyYrpTD51r*B|*(fsN)3(MITT z-1U0k?c!W5=Py#Tb8_=u=NG(r`@XEaqO$5kbxmVab4zR6 z=k_nXefzk4E)H(+n1ccq0(K}3C^;keLk<=u7VzwUbE8avYAHk+1z2gQ zKxLxg1fanFmFy^4;NRQXO)dgVZ9kXoO$hqi$wYsA$8`$uSo3%x4kchDkjTzP^lM*p zPxGBP&f^*(cE*Q+R)hndMBF22w2jWkY-WyhOy9|_)K(bGv6(>Gb3{IC^1D1ObOqzv zos=!dabJ%)MIWY5Jdd~eL;>jPv_~P2SMpN6FLt%&7uvVa!Dfg}&isgZ zNu?tOV{cX*^JgtDl*6B4d`ts00W74Xb7F0cULI3@X=ygObL7; z^@J?Ve7f>Bx?fXN-33;j*_iHyt^2yiZFzP-FWacSZPylvXcxe?iOj}WVqA7ZW z^YSLgCaos)q=Ipix`{{4!mcGh#Xe#Xk2|U=s$nu9@6_jQ#Nt0@^nCQ_>W?E<63Oh> z9NieTP9V_9TZ+ufkWyIG4MJ6Lh3L7R=?wIPTLhW#JZThBPb#^!V^2@!evndgWIs*j z%jES>+NIgA%4(}H6=B<7abRf@RyR{*SQ90HYsulPjAv-?dzqV3>GJ&L&OrJ0?<-JI zHxGPUj0Znih>N}U;$FG`(X}5JW8Ou{j*LHA4pq&!H{Y|Eu(Kj}WpaHlyV46`gI&1q zv976WO97_j`>DDD+x*zJrkXk^Kun-?)mfZLl;6`ysk%TGedl@CmsFS!Pw0+8$5hu4 z)E_XxDJeb>dJ=h7^-q?aJAQWa z!7IpX_^}IpNGLwdHryJ|m*?w&pT8RC%Hmbr)2(B z7YY9xiS3^CMwutFVpJ}=BKb3MKdK2d)8R4NN04s)TP}5$_&rMk+h8(Znxo6Dt|JT0 zI((;_PMa$mh?G9z6+hYfBZg`#k0;8-84wq%Ft_Ma*@s`M?b))q{^K5c+8_ShLD1@! z_pvYfuV~|2i@*7qGIXO#zZbu8_Jc%gQ!Q_3j>b2}I+jOB--BovrJWqcl&-)3u)^s# z^euU#s_|PTsxrQH3@%Y4yvp6=YkA{=VJ|~0!wf`q)A(0gAGG&>wxcLL|Go;9xZ|8c z+2gfEi1`gHNAxDed(aOmeD@0a8VO<0b0Z|V+}wM&QvpK!@J>r2B5j%>?7=coXv_lt z)EH}LF+wKsTQGb+HaW+qMgbm0ZAbm|#d-fI-aAIJOq;or3D;_CVi%b>&mX6Njm%Tm z&hilP%RUy2tQ5A;QGcSnagur0{KDWSigVGT=EtMA)=SpjBsmYbFZ^T&PtUtAH764p zwX=g1&2)LF%q@F1GdWzISxbM+8@+4oy=hE0kT));qTJfV8W+R-KB1p8YOXvp7)Jj9 z!n|Zp_l?X&R5QU(zVp4Su2m8W=S{}WyvVxBba>kH)23MRsF{w4eKKBu`fDiK7+1`V zl?hSVzl)om=qMOnI8|z=IVTzO+41V3>$&gW+?(e*z0jt?J`JNaln#;4IMgFZQfPhL zW)iJ_eVv5fggx7V)c(}Igsgi|{6!Y{^s8fHcZ`poCc)=naWDZ@c0uB6$VfD3KzPVX zL!3j+)-NG-@l8V4#ZBa6PGX#IG)P>2^}=w}TI&<*{?pF-(}ej}NW8~u6|@i{c*>|} zd@G~dD6%-kW9(jx4Z$3yH^>l#eRJqb}jNXtlOwj7`Sz0beEl>FT zSa%SFlgvFi35UHOirL(UT&_(h`Ju^+Zrl;l_-ZKcI%~0^pmv}6wfO=-vk-Mc3$*D1 z7#CRVBm{DY_-OAiaomLIsLG_!hmdPwmqgrSj#@Od>d0vJPvJ+zFz>5Y*@*}U1*o#@ z5ulC&eom2vCCJ4#+YuC?Q5ZaJinJK0vYXVu}+b|x2-%Qyv4aaA9x_U+26glCJ_kg zDlJXFDZ^K0C>#^}q@8X>-Le77HclT)dNXu&Xzo(NQ|~dhdY$R`bWg@b`(k|3G^S}P zI1qw5gkZU_cWfM*?*CBvXO-`U*9)hoq_53oepE^20Q|!!v^@_v^c1+^-NIw0L-$|o z5K7;_+u7`())?d_o?VTy24u6Ne(i@mS{#?PrM_vN9)zQpEqoZvs%JpVEf39179u3cNu98jjT;B966K|0pKJ;~ro6 zDaPBc$|A}&=rGD{`r+xvl@E(g#{KVLOrD{O0foOcz!fEN2i9-YJqEc+gDFAGvf2OX z4yE+}dySG6(*rJKI`&`-_YwK67&@fHL;r%Y>&x}h)$i&~@h4h;`BqUX$s{2j!)wuY zsbG3AoOEKSQQiZGia-%9>~8<;!?>V-%1xEc@5gze7Ue9z5d{`OH9|EVLPFT8$XxLe z4!i7pc1}NgC;+P}KEj)z)(j;b`%$y+Wq(FG85=;;(noTRzKl1CE3Xce61E`N@_V_6 zo$f*B4YX8k`>*No-)~&qMoAzwRxz z`}1uf=Yc_S9?uLLn~|^^R6m2qx)g?9H?*I1a1nz z+<_*b1@TTTuxJ=tAPv!Xj~iDUA31fEDCmzXRz39MZefJ_S7IMFGm#eqi1r?-E+N zrlO_eFGU+B-@tEu{8)F&0KDfZBAD;PRi?U&x*weGPt~~$*RPg7o~_p+?zQxi-1_T} zA>i2V=&cFiX|Iv7rnfFvY@!*(E}7t@K1BY=Ntq!_t&d6GIxRh>VjTaR1JDxc-ex7r z-Q)~08Labn6};n_K+K-IT6#ty$nWL%BE=O|{Nr_`34wc=0x&ra5qrr4es)#OY>HUD z%zOlY6O=wZqQZJ1DEdKWKOhFS$2pwjB6D= zn`j`V%TJGpje*~nb~@+iTFA$*nG#8$05dY7fx^!A$^-Rs&XdP$2;q&<7~wN@eF|9> z-xP1`Q5WT`yb>*j_Bm|uUFo!^shF|N4)Sv+o#<|4-xVYuL1C@D$tsXx_&?Wi10#ks z*w50Gn`t8|V&kJN15bLSR(jaJb?HlnpOzl|{C+<@x50<{ zZ1fCzG#YnllB0rvd4xn2PqksE7+tKt7u`di$sKmVxO_;truY`+Jf8MQ{*Wp>*Q>w0meEGx9c3PBCPwo7a}jw*})=XKZf! zp*A)rj=|e5&S!r$KjF#MTOa4AOWAR2F;=svMxWZi%wa#vpW7vh+o=$OFUF~f0+_#? z+P&CMwW%JY&U)pWY!-FYf4;L*2L3(s1NxIR^Qcic`QpyXPYQ7R;28s(y2!OXV^q8S zekOFqD~$peTGvOc>WIW-GSqW*%{UU16&pcK#6&*{vkNGao-0s zdFp*wNMkXy<(a*9DbWdQgW`rMYke)_i+8K)Qt5X%j|`r%#&s@HgAWF)|gaa z2C0EJpPqVrufk5bF_WoIID2IIiB#nq_xuHmN&@WM+iSO9Z~_U`iPZ1JsS)36Sf*-yMOKN1q6df3)Xrv%Au(2?R^986(bSHe~Q zp2*SDr)dcCHu<~f-0j9{qzP0A*y~l-7_ptR zc@Vbf5U|7g?jrfl(6jHryG;~xez2+uOWPZw`jA1|Sptvi+oF^ctqSPSp*8#IRbktX z@9uZbDAvlH=|aB17a9(lHwQA~-5(#%Wo9)tYBSo*uba67pKIfy ziV(22lcn;A$p7^7dPte~YnP!R3(Kk+@8XuP>2k(S^6v^imd6U~bqjMoy)6>=IEJgF z>6I#et;wBrIgpq55U1s55^8_4lAr>bf+jTYGFLqNMEZHtcU2X=Z1Y`Z-kpT5L$7;v zYV%lOM_=%WdEo}bOGsx2Nrp2s_@Op6zGtbE#a`Hta?N7E0NT|pZ4Y`eN;*!%DQd@{ z?xDi$shyT5t2f-JiPsCh&c>YX);wNpCUjcNHnzO+w0ByPMA!V|Xw>&R6Mmv2cMe^h?y=K8iE@QE!Z2>5y| z06q?8cM8yJk;R@($HV-Wpb-sa@PA_{l$}KUhPt8UL!{)j zkqvU&8O&yK;R4dZl*aJWVi)2EhS1%T>W0B}utBgc1DhCzlcIXtT6a!6a6W%rw9L}B z;c7QdKkts_UAcFfggStXzO_>#C56>Wr<{IA^p6%Zjc}TIq+F z(&c_jH#$?#z{zgcF+1Y`K5E13l6Z;37gW zOb#mJW5(t)@r|qe&6)VfyOYPODh4dD3ieEgpEAzgD0-FY)7z4u#Sy8HFeJ?IZ2>R;fa6D_u4^r#nkUH zQyFi(Hy6jyUcuKpkr27y^{FZ}&i@M1g=i-e^&Nka*xGp)uiPeisYK#X$h?UPI_0{r z-Nm%taMy&p@X3DKkIsYN|O56G?+iKSHvq4HRx85RP+X!N8u8X~N z&+MQ|nw)}7Q_>>eZa{sGuU2V|@8?XeS0_p)Pt%mv`&&GAlmcx^{F5Yo4Jay4DwzNE|`q)WNoi^1{ z(BB-TG2tg4?yZ+xc!Id-erW8xuLhg0;w$G_aalH@kh;Vy>E6qTE{}SN{YtBl`4oY(ujHtz+CdrKI$aCq0IU%iDhVxuHkLHP7J34Er9i z4Aoa+4zVT_H#IiDH97)0q1ZXx>XY^d5J!Zp1SvdS&pMR;fS@?>0LT#kxDAe4BNzPbSJ zyFKcYkZ0_~R)I}4l&symMD4KuIY#|d-wypukYOuhiOD%48?MkS+ivOPLeGQ^q5-Lo zOqjGA58-My(@C81>Nw>y7h(44hq8X8Ha!uC626P#(1fC1rOgc$d%K>R{F!^A&c${1 zbCT<&9H;N+YQsy^W9re*)H=RW0Q9pNqOkhUcty1%dzfi5ByxNb=|?oW`D$_UNM>sa z>gK@Yg);9rJr_Z3vguI=mR8&+y3b$bys+pP4E6?5?jj+6+jkgRj&%v_o_|u+Mg7LdacYTKBPP`9UP4k%LwVQXj9K$c3@FTz< z%l=qZkqW8NqbXHn;;uTGMx!e?R;J?c?9NZ4V~Hp9P32haL`09lR@Q6X$q*w&3_79y zQ04Jrld0A(Q}N&$eOfg6Pu3u45Z(P}Z|AvRcn@_H-G6~b4E=jHF8B7MRBKt977F0( z{#YAIOnXCw*n?A^F~9BrlK)Njo2FB5+$9O+@%$+v9haO06*|0u8zF6)n!I}+ke|gA zfE@~9Go%15mOWHDd81nDpl?3k0IA}fA@ln-VMx-s6ae=Iie=pYPy>mbIs`frsYw(d z3Z3ntC%Zv2?@l}m;@-zG_}V~G3V>CW0i6;Zy#8vVI?|2k+qQ3X1x2{Fd6`Z?uuG0= zqlyG#2UUka+?%BqJ4NOOFJ6Vv299f?u)au*Sqkv2;-CQ71zZgC4W!AQ7IAEQfcSH| zkOBw}lg#jZ$)a(!1q*is>ok9K4weaYzF_MqeQB8wA|Bj(9;hDhkzmlEKa+F~1S>8B zP^>N@g#3je61rJhxKsp+Hids2I1b&ksTT#8@mCIRgdCiaAjAJAY~gR&!Nn>5@oP4>1oTVnp)z3I5O^m>Nq*Unk=uVlox^GyNK z|9pjfuzF_y?||aqO8M{6mxMSC+&j&KD$yg37@t%WKxAI-8MCf4hML$^H{bb=C9k+- zfQ3!3vZo4$Ac&(^9dzn z@&-O7R4*U!+9sBn0+{w}YWQP*-u9NSMSmAt6>re$79U!S5I`pjZ(kyY<8{L@dom=m zy1ohOk2|3x6Q$ZdRYTxs?j-$!qgRTQPKVm0F0MwACUDqV-kJnshdM);CrNUIwDd^6 zw`cp@>VY`vN1zUZ5Nc_{?!KqIFF$ihhB zZ`~1r62zJ|y~-QNh`E5i@dT36h3bdwds#DQPNTsV4h`KiA@@#wAR1;F;*&llZ4oYG z?nw?R-qKoCP>yIYf6~?OnfOMaq#GN)5HeS!_2->wuwf#;{@ST$G zTMtE$&n0gt-MjNKggSLh9qwQ%V7b_7q(?k9#H-Vb_{kQ4``KH)c&4?&hwuDInk1GwkO> z?{rTgj}JKztEUZw6|f(D?xzmKSV0tuhYW+v8mmldN|U<$EF0NJL9^T{7xwKz*SVSV z1iMO$ohJ2hm_vW@IB@-;>&~ZcDW*0-n$ubAw%N}iG9e~^>EHimz5Wt+J)hAU#23{@ zfJKv(reW-p2y|=4;l6TXev|mF8Vu&c^&6p{!1#*J>=R(g5TG`Gh-&B_1?`f4+nV4M z5rS2WQuN;YsNQOP&cD3(cvjhZ?{(abGGigR%0)}SNnA;gI!G%!in!B)DbH*%p(i@c zsMt&NudGUOB3`dyOR9M5F36|eNRWJ&E~r_iE>PdYapU{-m}-XhdwbAU^r-nK3IHgO zpfYhPnY?!ynvdRh{TlkJtKi=H1)I(c)BQ>0+*rm3_aCXiR*jy9rRw?{3K0B+#Iy>6 zOi>u(g-KNCZ8$iAn#D80xvUXRSp7#8FY1imem+u;638a{o5Up2Zzs+T{x$L`TfWH*0MPROhu9zT6!0zN|W#xGwYz#8K@NymDHrgYv9J&>C? zL|<7BJKla=98pzt%*?=UuadgD^`x>6M05$pDoxZP(C8A;d-sSKV`8ym(OLg(_)bNJ z9O}@7jg?VgyI5w8!F-rOu@mt2&7smq-27hx*eL*;(R8dt({B3Ls%e;@vvo$ec061$ ztVCtmw?D=&xqIZEWTbeiLB<)WL(i?$j>aY@Uw17s;S21@I8JPOZJbB)BYt$pu^?1B zmPMt9bnv5#r?$N&Y$|Fe4U%l_1m~`2Trj<^8wrygq4o5IzW0sN6r5f?tI6**4To~w zB}?F6w#$T&Xq>W!M{E{HbIm_?RxWE8dhQ|H?hgU3ItfRVq&{gGko)Wf$?Ya`pXybT zT3kz@;p`!aU&i+AylE?JD)ppM?`ioulO9evuSdNPnv1Z`$p!~AH9m*?X-*HPWCLj>oBx zk0dqoTff4OiHhCdX1ckpd~^Gi>?2oPM94N;xyyL&OOmK3KdRK2{Hnltr{-C6Iv*MC zY5@1GNgjH9ggjK)4>3#JUEE9?p4WdD<@+>8SG<~v=f-TQ)Zp}ks>}*UbeO8ElBRjK zoe8%6LASu&QFKJn3aQ`$vD{VHwNgOHDdl{y*$W!}1n{X2H~BVE6_CfbdsQR1(DaBV zgQ3kxm0=84ptkf;g;80-mv6%lsReT%HTOzJF(qHPqqc$km@hIP4Rt8RWwP54?M))I zbswkHEA~~G5TDA&d$^QLu?%wZJ-c`1yvqHX>5f*sB0R#xS6Ju>Gm6={rfw7#iR8p~ zb4^Svs@1qoJ=TVdE~EyO*C31KUA5j`T%UN@`J;^fgIQ^1^Wif-mUcRuQy~yu)%d7W zlPBs2G?jg`*ch4Kc};q)r{X&tWzL-Tfe4e%Z^Oiv zQs+ZaWqpm?gJo9NzZiUwcDR-8$z+!F4y*q~ASCgmA2ei&9ceNx2jv&uF?#eDiiGlkRw+lys)cp**;g*Wt%M5Uk&74@*25Gd$<< zGRPxo@ZHV*3~$8vaxY0Yq0UUSt9)=Yf7|n+M;oo4R7_JXTe4=NU+7H9kD3mwt&neH zWW9h5{A3`x*IDc*cHHPoXXhTxAvL8>6MZ5(+JR!Hmpev%e8vJZl~bcywB6iO+A@ea zGi}iiirt!wf;Spd9W2%9D&KD0y>I)@#Q~z?GIuJVjdofj6`>Hp5?)!qZXoyLkSbk$c~X-H;^As) z|4};TOf8tl=+tqYHU=^8Y=(d^ZwGKs9iZMqzw~F0fZkc9w$-Z5N;*K;k#}x)PJfCUOL3wMT1-p`{~R2 zMvLjK7#s0y(ZZxs6(KXK?%wFuTxddRh1`vlwwp5#iUeNRh+%9~UlDF^+Y?;~=B6gR z5$>7_Gjg{i%L&?#l*%wsXJ7I=etPQlb^7vYTFXFc)trk1RhX}B7Q9!lQh=!7aepe%+X3hyEALZhfi0uRPCmlrk3y%vF$jM3Rlj`* zzPztt+_#y=s8W3F%jDNDy{ci8qmxomvbW7bFI)p;L2{k|!2A=1or2=cx}!6 zLQ^xaYt!CY>=MM-JtdM7F&|%LM>Luds1Qz!a;=Q1Vj_6X zX7*O`2fps2#zGyfAC{~aCI|(jI(c5!j1-`Kahd7LiOw@D zaqzKibe;!3P$72&yU5{qH+ z7IwL}Mp7uAC>NTm$c?VZsjNN6`bkOa+l8(Q@w29*G%E>{hL~+dW|71YJOY! zk*X**xQRkWo>=i61yc1T$9i|gm6Va|?Iua{wq?{*1A#ry>`(R~*`3lZG0>cdYbWKcJB>FNFDjl--bzOdU5#CzfMKk;YC z#kUTLiA8QjybyId*&e%aBF@~W@rybalZY=clpNJyQD~m}w0LRir^q$@mXq}2m$ovK%=E>apRxy5+_HIT6WGA2=}TjnJ4Y7L>}6(Ml` zES^*^QyV5qukp$;cNsI%Al%uOYUF5Ba)SP{ex5)53q1OhH8jeJ@H!K_kUj9j+E8q! zDJZZXEd_8T<}|%t-)X-fLP3WqntJcUGAX~9Xa)B)Qtz2*`;Bw<21-O{_)zD(%!g|D~muJ47J)>db z-ulrjkej4w4YywzZCd*exU+LxevsGpWa6-AXWKi$S{24b>!7RLB-|ShvChT$a)R@ zkF=a6dkKH3`d*~|oSn^r+Une7KPP0F|Em7iJ&zffix>v94*P@4a@h1WB2)+ zwzI!2xp=wPokjFLER%GVmk!u5bLA|qHOSQ4`MlO%BGCfD7itTP4I_03cM6@b9Z)ux z-o;bT)YN01*yy?|U$9n`^J%wDLsTXf&Cnhd9#)HKC+y6aw2cT~+J8pk+>ghOFd1t4 z<7)4OjiUwOa(cq^P=C5-Zh8WW)?2vLs4D~M1Pkko34$_iz9}=LMi>!|Q;S-806)k6 zv`qWXhZ`p?WS=QY+z{gtBG3^-_AZips;h{`*hOt#gqTNnRNYxOh-F>GEMHj}nKhWv z_q6yNOw;lvzI*!;9`aZfJF_OX1mbL*Aj8m?z!35L(oKo1%Amw2vSbc5-WAZVo-6m| z)%DBJ$A@g+Cf>wHZNoT6tnA=qh1#EMNaK=DcU8gh7$q*X-FE@pBKHl^Hq884d7ngZ zzp-n6XW9Jm|6j$2vwF^Eu_p(LqQ2;BA4iQqzd<+QmIK$;(M{-|2J9r2SMtwZBo5v!UO&x`L38G0o=!DSoXH5P?X4nHVlZw zMkpRv7*b2U*VJDBUXxn-QN81Q?D(rQO+uUJvW8+v_WMuk`AOIMlUlY3_C%xB!Q$^D z;K1(-NZdWcaQ-kX#q67Clg}jYGZm_ptlpt7(FE9b!hV_(oY2>#NRVsb019WIY-6kS z6%iiw+ug5$*%~~s_oIz>4Z}v3BWV$9vlJuiMTk`Acr#UPXJ8@f_DQQ4ZX+W&I$L0fL_`i z82vc%3PE1KBV&7@?jyU2OiniqKS6u<#Z1&y*l%J#84Mm5ymn7;i{!?9+D4>$J* z#2z#7)Tpgw;vkXMc~vneI22+yqr^2`0OZ>JHAMRx z(D4^B%Kw?N{z6UJRm^l4eS*CDiV+OW@xyx!_TmH@ft zAqwC$0yB0LkNj~wPJeZ*Fkj*F@$qYm3`uiZ@ai5jMOrX-tBwiPj0wD-kEbJ;S2mlsGgMfwq7AX7|5s?2y z3m#OVf$+Tw2W3NOSPYS*uzG}3#rb2ZEtPT4ZjG#6T)$<={63O7Y*YZSxtn6@%eJJq z+WIhyJp<#EDN2Ia?6HSq%A6k0W;O|hz9cIV4rRH2S6bxf|7xxAkk4JIYy7=@Uh$4h zVkw9hs-j+9t-P=MaHnA{423VgNkF>0=3SVSB)H|{#P4yt%~d}+`6BRI=W|nG^ySwd z8Ns#hU#!Ldc#Y<_Sb*MX(gKxpiGFLKBtb0ct@EgUcurr2tEsIcn(tin+}n3&&MEb8 zy@iZocrmqD=WH!6m&sSo5WL9k<^&v5nmK6`MhA8r- zq2$1xOd+x|i3V?%A3uwq5B0Va6TLh+W|=7ARr7UFf7Gc}pV>fWH0TV5D8oQ{g60qd z;lfPf?=hIpZlcWED(_7CxpinTiggpkewVN$CQjgwQ1#!7*Hn1S{@~JuRp|P+mj#+Q zjLrtZ_n@Uy|6dC9|9_MHPo7Y>)9km?qR6^1Bs4*?=SyU9O-teZaNPHVS&)I~bzk&Z z3z>o}I&f&w9E6&(_GNQbsG1PN>_p=_NW#$GdBXme!7``nBD65-^Xl{l1-J>>=c*{~ zANqQy-QRJ+?=&n(X#q}6LbWvF!}pt^n>xiCqwm}?v#*Hf$vDWaxWyS)aw*R>6t?V} zb9U5jQs>`dTx>i-z)wr;5GmIS2jakQQCX;kLG;_gIaoMsJ>fU+mVIAnVC&j%SqvgG zQL?ShG@XH}NF->>KP{BAuVyk4^P4U0rRv~p>K#ofN)zMlCtt5?RwgjbydF=*>aQlf zgb*FwM93pqz!$gd;Q=G0 zpu&wnw(d@q>ytUA_G{vazmdo#Koxc;PyCjp1o{pRPGr}=Q_U?PaZs07?lv;V0Erg| z9Z}wXoM}9`GWWh(AAkI;{uSkT4M9;o|3|PZrh3ja8hVKo-J4{Oa3!)uq~&2c-SB_uQdZ8q)s=0Ksi){*a{*JHc15y0k^fWif#pJUrE z0OUVV4uiBKXfw*o|D3->^MnY(0+KrxAovB@)mC4|(|JPpp|crFQ`=1xK)=l{;Fk)Z z4x)3pZcoc&dxK7+K#g1m^=1!b^)DnBo9z_JwN9<86QN`rbXN*~HDKxI_z+OsE$k6;uJ(qL*?rz0Pe%3y_QC;TZm;BOSusMiPTk6`J2oZoi zs{oy>4GHXrazLRPw$W?Mp7sVqf{KPg<)lNh zY4-XjnhEC;$n<>kn?QMlkfK00wlD_k{4gj(1vFCqH z?j22n`?=0X)C<`zYBLh}3JVrS#Xj!8P8#p>a1!l|+2K2P;zroj_aBth+vQF$eY~Y$ z3sQaVLPQo|Z1?JAiA|r-_>IOY{(6ytTZ7;GkM#5Ji7lH~#^HoNKR#PrVqBNI5_2g_ zY3$UNI1r%quli_3G@j|eM3QNG>riUpV|wL7SpHqdx@Sh3=$kTK?(((t!xJ;dzMtr> z@?qg(6f^zNBDXG{FS-1~db42&Wc8mRVMK!)Dola@pfCwd1L%-ndG)cjhn^2Th?q z?M3|fxuu5L`=1xZwB~7gV-7vfVy7WWV4<-nda}qcf{w(N15X^AfWf*@iqW|brBc>^ z*i_SKjJiF^`P%b>(OkM~&$O~-DruT6?Bk59GLAp8&JOpCujXmsk@zMqn9cZNiZyzq zE+tVgb=>YPV8dC|!F0>!3vKGwr>qA#&YM~6Y27Plu~I$mb!VIi{y5{5XKxXK?5s;1 zXT4v`*)DE>_i*99crT_v+-iir&2%Y3ii@=OQMegJQwK#8-CJt7mPfaqPRb9ikPM|( zi}2CWTIYK1ks`$vx%H?kLThgs%+juX77rDB%Bz1i%9a_}SQdrhCUz3?mZ#V@{ozJI zl{>y3#LTW_4ifrE{s@mUVA%GBX|sg8X{vNBLaygCx89={TgC(Af41&QPmjyPVSk5p1k=(({r@f)}epQE6`K=7X$Ja z9OZwRt%ofa@tD(KiIl0MP|~EYXt8mJ9$d6Yn}*Mi>e% zhj2FB`+oh%K>4scmy876(~CtsGci%$QP`Ilr))1U!3qL$?zpz0q`N`vL}xHfahV+5 z29gnv$)kv?5PT1q=`^&@9}lwau3iWIyiq9jCCUlCD^39p_=(R-!3>?NsHW58ZrJ8o z@&PST@iql$Edangs`&j3%t9R!%&>3FZUZ?yU|DRCJuOrZ;($6B`m44%WWly=KMIh| zj$Z?9lRt#4s!vjmU)cheRDV^o!}~d4qKpS&2CO|VAC%3%Wqn3srn@Oy ztIiy(YMaZ{zY6&?hs?B(hfS|V)w95B;v>o2L^aFW=r--c6>!RY z#!`Tg42C{cVKpurdn=+}uORm3Cx-+H*8FiHV6_c)*BYQ%Z?pbW{N>*s)L;VB|A9gM zFRxu-cw~Qm&xmwyu%3!2XF_}g$0iSKA}Zi;R}WHSv7@7eD?GH#E;rZv4ruAK4QQeu_q7$7-$J`}4TsSh+UE51|0!Pj?fP=(hKl==1Qv$WU1a-;KRt)S8 zC+Gi`uJQ;>mp$;pQUBo^AKda!$=biYYXltZ3E;a)iuW#{u%Kr+Rsa_InF17o1w-*+ z6krw1oBI=gx(F%~*e4_drhOL@<(gsdomQE&(~7M+96jTwZDZqd9Rl|Xmb8|aE;4oj zf$+d4j?ut&ZDE3lQ2a_eVeQJ0>gq*(wUkMQTYN3oe{wqJF&uvAHlk_S55*7fgVs11 z^&c7K0i3;mlDBU5$6Ei&TnCA_|Aa*7{{hWFXM^PE^zPN)S3P8?N$t-!nAN66gfhPJFqQ=+`)#Ujn1o~C z5P`PoH4y}u-;DzC7EV}WJx|?Ge$OV0a5}^F-jeBSj+J$#_0=ivM?;j9Z=K9AXIJPb zfEXc`o1pkqqM9{6e)~sZcDnr+8`b{u!ptM=2cA9*vOfn=S6_CWnl(q&cTMx~S1rqz|NXsd2uu zbh0?xmA|q~U|yeg$q*+txnn6OJ~YC`F+suEHLrzcKVR;2hFm!U0(+zXDt%jH>Z#1P22Ums&zjqP9NFO5Xue4I{E&|2 z`)r-s)@olG97Od+pskS6c%1vAz~j)cItadT!wz4PiR5qn{zY1^f1 z^BhMl><-b^=m^ODOp`+C5ENHB@NGD?W>McZ48NvA77>dsS}C76(qY*vk)b8lOC_P+ z@|{n3F2%*c$@DQg<%9NhnUweY$y;4&jpm5JK3r8A3Z6@ZU+nc}=@RJL_Wrg7Pur9J zaQ;49tA+E;r1_Yt#IMY2qd}r~LiUV_!Z5;Bd(m(`0&j8bKKWIyi_mIUu2KHd&i1+6 z-mY$q=Z|mhskRCkB%aZHrd0bVsh1=|EXzl_;9W8CDo_?gyk4(+v*+S!@u`$Hs5df;@>wsM~BZ4G>Q5R?{UhW`7$y{i_46`5~Wt65tyqe$o@7 zUyFJ*6VD5Ncy_}8_w;QuTJCKn1$aPo$4U_c@HHnQM>RytJkI?3n zAZH(d;DWw;okq=IU_xCkV~8w{kZBx>%qJ$b3Y|)RK!~(p=~#H>`S^)|+zCm?>rVYb zDvA->3^^$4KfF;Az}}ZGQhBXnVo$p|d|p9M}2R46PpO zAZEQbKWj#YU|E`Wlye70(50Rs=^B10;!raDZcha^=;XvjYv*J>wJWC-J6j@VvHIr* znwIM22&ROs)>=rEx2*27n4$-?eJL}1t}c>J51k{Lly9U@=u18j*jeL3I9(vP#h(hn z2`g3%+w!;^*|1aNxxeK5i?_s3aod)36i+uFHAARq3(pR?C9QAO`Tn*atHjfZckkmK z2kVP|Qk}c??%La{-}B`Bs>u4hNG+@O8qd<1Kx%?h)Q`FV?8L3*7WMQ-V$#*Yduu8q zcNF0~KFiM^n?bf5kogjlF<$MR7@i+U*8(K0<{MH=Cb9$@el~8!%0+#C8=<$M^gVIJ zVmTOS|GXTv&8Ccn1(lB3ZD|r9U1|HOyqQ()6RO$W)bJJ*14uKN zx<(!&=!YB6ttGyDn7xjZZ&eO$cFU<={ra$I?oo5iq142WYZ#MivYuz-;DetJD==H% z2*T{q+TuOsnbgGWJuA!rt+jNa)HuCGtlR5|72T%}VSghoRj|jAq4>cE?p)65th<%@ zH{qzV6e9C_CC#h;1sgN_M6rrR-$9bV|}#xkVulOCVH zcgK@*{leFa{E}n|w`Ac0>7u@l_V}3-p(GtbdY%6qOU`M&y)M3t8`mB!8*$|rOL@)< z<%4d2EjTV*HK<&=^$XO0FX5bXi5zme&k|c<=eq!&P_7`T&Q*vtongF_maBVxywg#b z_>k)zQ_2LNtLenu;B?5`)d|1ph4FF8SmxZ5-vKswK zgu7H=SNC4p1`+!skc#?dTfLvn|tLPdbF!t4-i|Yf!|<&l7Pb!o5#H z(31EPoDt>vxk)r3bs)rRf}PICRna@IlMWb@gUY<$vbaQS%bkcYD%ueR*If`bSHBl_ zWI#Y*$RAN#QbP>u5vmdVlq)qb<@h_56ga|&=ot|<{5h0 zDp&wgza~z~I4r0}l3l@^1jL%x@3Oysf?V4nN>AKGoruyP*u>$~WSpQdeqtsBe4HvpxK|Yh$gO(5!utn&73gI4u)D_;h95kz=x~V+?unEK!t(gvDi+fp z0oV_j0P^M~Jy7fc-wWbf>mMKPA9B|?P&5L6xHe7mKb{-=lVAQ52~3xXsuZ>X^v3lU z|E6zc{)sp@tOICs+z3FMGx-c?bESW#&4G}FvBlc44zMWXw>oFx4oF_UJrEVRIoTHv z5EvJa_-U~axw;|Z1rxo;2DBWmS3qHel7^cC=<8_CS>??{5+H14GA;dGjB*;IF;I^Y zwo3deVTh&GnB5_RA#~16PLya}0?f`|K*Ff|+&*KpX21+4CmKYpp8j*I;WA(z9MGO> z-%O-sX0#mq)8QYN$6uq9bP2?EY6cDHsWv6jQXGD6lX`M-+p)nCEN~t8{BGq&AHJp9zJs}A z^`|PcU&6xd+KG_DV)8A_4B7{LRnhfJ(R<%Io%Pcer_Wp%#6#~Bs<#hIrDrtX$xLWv z0P;Pw8#tW+xe}!=wdpI5cGm2f32VqhCVGt5C9T4;uQ$JdW|`PMnWoP=+bLRJ7`|*f z4!8h*n8U^6`VJ5)%j~v;KrFlM1i6r84Fm%zY!sb%jfPy}nYHyx1?$~3&eZOMq9iBi%;=VClBiT0+{2i+ zP)>eO=3SzT8AWjr=ZHMHIkADV2QqE4ia#*l>+8i-A1-R;EV!0;ol{s2RzLY2IqJWT z@uPW#j*1A3-l9Q#wA0JBzYn+`voPfL(@%H9ds^94wjsFc)V@%-y!OQ;Dl=Lsg zQ>*`qG;3dEsms5d zvkTmiICDT&GjX{@o>7bgFkgUSnrnWWQorhydmHg4@EA^XjO zqi&BpB<`J8so|Y>8Nnldicm!(>wjBhR(^r%zrI)!aa@WjDTZG`@Vdf)k#P;UKatu8NszGq!i=PST&+RWXvP zG2`_`@b)FGj8%NP9y-@4eo_AE$45wccDf%|m%+s$JV04b*QM4+Z72N#y*=7yLZ&O3 z{SKJOc>z;h?k1bBTzzE4ca@wdX`+^3!Q&83x&ZnH{tCe$mHwgvoqX>fO}A{?>L=C7 z@mOKx&tIUC#w{lB>h$aQX*oF;#55jBn9q~~oT2*f5M6_!!p-C|#L|$)VAn{Q!(mov z;$~Q{r+#|ML&wvMjArv{BBu8}JLOXjxB&0f>(4{D2$}8U9CGS=Y_QKPbnmRgq(O9F z#nny@;L~iRHZK)_YjB~u@xCfq^K|Fbxw>~P_U~toy>l!1dh%qi z%8m5RRXAlIlxEs!!cZZE5O7;cl*4t_|ewK!aV&Y4Di9R&j(&@ z9>KpcfnERoEy6!LvjHAr0GJn|K$clLe48GLPyN2JSwD0`4@I=v$g3dG1^WqhfW%VP!OO9a2lY+2ryBLI1KEzkH zHUHD`A71jmQWH5q{xo1YeKZH?wtqNnWLy|1H{p(C$--~$*u;!BsWloeQS}K^O7PtL zaU-N<^Vraft^p3}n4VD8!3oc@_T^iAQpNKgcP>b8$I*Yhk}1S>OArBzeB-_QR{2(n;HAczWNQJ$8F} zX4D~3hZ`mSO{WgDs&?2>1v<>4orW#y5>%sUEU;Qq1UdhuleYtu1V5O5<>u4k+!Qa8 zE!W6#>IR<$A~fob#YEmdg_xP-!Y#p#m;m+*QB2^(y-N7S+-Y3V>Ylff;QW3`?Z#|Msxi4()i12?E z7;(*NzuY~xGPpc_(3bZLv^+3>|KhUmq~#~EqJ~sQV6j%2nF3!sD*`HZe?HF1<>2sh zXYqfmO8iBg$j@HCBoX2R3So+w5#3uxoJ4qU$1gH^nsV7su1;%N2G!rCD!=X_eYlF9 zdn|ebknuTs*)~TATUxeHGZ|@<$hyYuHc8)FxG;gEPrSQD0%saZ6Q`=G+8qU5I#rrs zV2vM9IxPUQ=i&I5 zZ2Q_VlDRj4&54(m4A$N#n7|cZ{JBQTxp5{s`}ER1eYxV&rz3ouKoLS?1!8&UUdzQ3 z7Q1rpU%Osf`$c-Yxmg@ltKv+1u;dxd#P@~32@qz6+N2Is;8JfEdH_%r9^I1Lh2)*> zdSs~bbW=HgNx!RTsj$i)NUaG4{!lbQ%@UIbL^!dx%rsP;l? zXdthE6_?_dg6k*gIyHHNT+Qf^0Y9xH&CK3U-Ibb9c9e-2)O`2Ja?a^WO^-Cs#~Ovx zF(Q}Nb@@=5I6u0c7X8K~tqT>iJ{Uh7%c+*yXCBFu8Lx8132W*V3fIG{o}n&L#C@U| zrnXQ}iZpBunutLU-)S1XN9W`v2uRE!OX>=%ZrG|H{I&b9{)RS$=ATn#ed;13lyH#1qSw;dE_}_kTF?=K-$Kg zsDA0Iv8*zq5*py$qI6Dqb8=smr<2#eceu@+|4Ed2pn*R}aNF-+U;K~t&6{HH2)jgM z^|_y$7A0Z2bha*Hki+&mk@p1BH>>+bW3#cWh+jh^=A!gVg_vCW=u68mft1u9eG~U~ zt|FCTFxnOH$UF#nA%2-CwNXZ_oZfLvh)6wIIKCk#iai}){KRsw_4FINskx67vJ1bK z?fc)(7N*QSokUSpLj5XcH}Zb(szvqFS9%i1FlB{&H(6hlD>C=1i=@M=m#R*{ka$}( zhv)vWCRSlz^5(15Mu&fP2~I@mcaqK= z7NKMaYm~0{ur2<{jsyb?8BYHBE@n2!uYgp+Gvz0xd`VNu2jL)-2zS0 zk_qwSX{qH$+@8GIWGsOCCJBAyuj1~1&ng|Y(--y0p)qC;D!k?gDZ)_}g&eR_2A5I+l=w7>~=6UGra=3saC{`!Z_^L zHdNK;L7rO{yg27|a)@syaqPdn0lqZiMsbX!Ym=@*FmQptzdHFxLfyMmD>&c;PNTM2qQ4d0#3-`R~N z4>J$iR?2TmE!k1U%VA{}nE*$>Ue6-8yXYoV2ORb z6tt-1Wbpd>kZJH3uZhUxl(EYX&p&5B$_CXA49bA<)-wKdaGe=x-m)rsR9AEzI^-L9 z5YbSN+Kzk_W^h=n#b3G}+H#&IM6`KE%6}L9vl6;HA}ypjTf5?TJ?vPP0_HxSP;P+b zLuJS*xLXs!7R|*869u#R@VC#6I$hg;-{pLYXNi-^nm!?Pq`wuW+2-N{n80tpZzAW> zv>RrEcWYawZcc5xY6=v6R4(~C<8M+1Ex_h-@1K=bCUYz+{aBhM& zwZKqAx$i3~M0ClQeaz!5p_+Fy!||Oc)(`#YbmZq95!lU&xQB1cVL_xQL3S6;WVpLT zI#w2ldKfSAAs_GLKWzVCiTddgy3CcIrGBzf$n-F6OIFhOEjjL{fb6L{&jtb^{wS(teb4d4yp%B1Ji8d}}x2m3O#jsl(6Xy`Nr6htdYZFbX#E03MO3_ibo|#h_`}^sd2#MWTtPUTn5nX6QF{4VV+U&b}QXnI> zKmE_^huzcMY1C%a2(kh^L)upRF#4I9w4?SIssULUr?X+k49hmp z(U$LWC|b_7;lH*YSbq8JGQ$!heTKoqPtVTlo^sgFPf#;TC*LZqz_-zM@AUd5)z&eA(U%`K9YV$<~#57+l_4J zZP46=ixAo6n+kS}BlK}GF3EVa1PF-y2)jtW0uRSJas-*MRJ*k%)fyNuE+g8~GjTRd z3uzL*27#o;MiZLkoe+hPbCw4mn(IGQHJZ%JM#`@>Xw=^{qYv&cs>+#L+TLWMXn^Z! zBQA0fHNpe+I|Q8+xgaf`=)eZs;wOMEAjGP2sZEwB>NOoL5? zz9e^w?BcWMw@%!Z_<0KN_Qgf6&(3w~NgIxcQmD@k5TmN+U7qRP)6yx8w z4qaeVJ-`E30pr?yf?s4)?M8CL5Z8&MbnG@CS?C6#J-Kb7{QLfd{p>}bBtKCLD1Cy3 zc&GGTU9|8C48(1lrXoOWk0Z{|&ivkh^dr2_wR`zV4|5%Z%aYRx+g-Gi;|0CjHb``6 zcKLgWu&X<*PUqLbv!B#B^Xd3F`8sdfqWdKG-W?#E1?Kh00RNx)u!ls(XFTwXS{ta<(1Arl0BidLR?Oktv5n>SHcuJPipf4p9v7 z5rQF}E1jkezcwa|J1l|ltcQw<wE5d|{n+_@jz#zOX7l282RPDo6+TelA*DXrzNh79|UH#jFm9P?$v zuO^+>y0~N#G4~X185E$>`o__l6eZN=Xfij~_aR9S`nC2ovok@Gv-27Nif3Yq1JEMF z6F5YlLA@(0xz=#v*r3YF!S@*wX@4g&{Uj=|?}C1cG5^=}B8=`WnKe=A zx{^{kv)o3#{)`i8J`pa~LyIN5r+Ro(pXWKOY8?Hekud&S{JK;@^&tBZz@)F_0U{d? znIc=KePXdA3LNk8#C{<>&vusg!b^Ga1{O@I5vy?reMZ|H=_@fexzGei?CDe|_6`MI zeMaA~zu#h|aX0Kj!IeiWwSMXMVS}UuvI$Pej1MN%+s>q{S@L$m4?fqE zc_Z$w1uATGfTfo{L)Y?Q?-?8R@=Gf;kPlJ-2oV(Edyss}4CAsiaQ)1KglB~d3iUI} zNlzuemME5dJ$6(U#q}co?HvYGO}pNbjcp=T<|Wx)nR!=;tERH#omr`Krt;#amS>G7 zQlG9XhIe#`M8D)hqUHRR}WL#B-V58-+L9{=~wFDgh`TronfQjly>}K z2FR_zzYDdFQ{5~hejFbjxz-U2MgXjyN{-tkoCEe;TjsdHqu82hBB2MO>%`N{oM zH=_2g?|B!A$*(5)SB3*fMn}9}>zaLp+$w%0BJ=HDlk!ezGeyc*^vIMP%7bzawq*ud z%WlrYcQ-~L;0}=n|y_R$_3`kW4ilyo)~NvQNuQYz6fKQU3bWw%>-9c7<-sP@Sb(LL?+; z#prhWb&1=OtXoXp5-EG87p*3gKPb-FkA<)~9zqUyo9kNZpLry}ob@D<)~?pnJk+C$ zW$w9z19N#TNRP>DX;yu%`1<1A<>`Hei#5qS3CtfKUfQSU`8;inm45u?=Ei}Dogkt6 zmiUd*ubI{>(+iQPk*BB&L|5F~cHI2+)sF1%Gqtc@5^cvwV`Zh=dm3XM!!7lMHLyx4 zevsR6o<3pIn5Is>Mx1X?($e>ktbF!TD*9f?nc57TRda$zI8ISt+I@BBm6~Q#<~;@U zOq(zG2<`YfhBFgeVc2z{J|T`L?z&xNrC8R2igWpEtANw&5W*eJmgfcDxd29vcFgCP zgNe=qvCNJ8mf!r77km8dtv&O z`LeRLal! z`z5v~?OEHGO&eRJzwuwY_tqQ}$cT1Qn@bNvcOUh!xaxV zjwrVG+JCPVIN(nrTQ$@-8B_D0J?|Dvkp6L`*+BQy6ED2?T#hXuymqk5$xD=lI3Q)5 z9X?PhL;+90#ay7O>)Ad=9qQ=`7rE}4%gbz7uah`d6t57>E43U#ZV+`3zYdx+W zarH!s%Vtj1%!18~ugiSB*5Hl9s=Z8(wd6PC#LLw?b=9SFz9aM(nK!qv-tl<`=!f(R zM%b1udiRrMEnJ)DhyYN2TElri?(TA3!jC@Vsh9Qd+q}ndUXR{BlVlz36TXYzzt{8Z z(y1RDVTIj@S}>Z!41H_n2H|Zp0wE!o(=759CFwssK5*1T>`i;Cb&h(WmUON$UyUB? zv}*#A9&Ul30}ObMv)}J0CI`z5A~w%%?n$}(!o)b}oE#p4=KZ7O)`vr0!@_lUv<{m5vO(@H3N)J?| zwfp9H$*CmzqhFdn_Ybr?9<3lV#ml}k%n(q(I|<>1K@Ewri}6~9uk_x27ksfn6D!cR zKanYG2p`N?g1*t<2wPbwM< zl}N93#4<~8Us_fEZvFsEU#eNVT3zpLQ@(mxtNL4eSq>=$+a^QhA-fTa4Qc)4WUPs) z$soO>bM&p&dM)bca8q!ndWWW&zwZlxS7;6xM~qj#w-hvBR+F{{GWxnP$08doTCyMV z-MY3pK=1J}gIPe!_C+Q$Z2~wU!gr!huPahT3BuHLCWGh3Rj&HkJwwA6?g^O9TNIQI z6!^M7-Wh->!1WLFq9h#PQUoYEn7m#*bT%HYu&zWCAAiV4FZ9kG_Vkpx*sTZb{)Oiu z6QdzQ^R~wIlgb>&_6?hwl8hzO*SjX>kX!2U%W24c=lCEnD~$uLL{@&C&W0U{msNUa zZ#(kBHnL}s3zu_eus^Dp?mgdJG}ER3d5;sYto}wUa0&rI`yZMxEzv}ZE@D}-iu15! zZ;>6gt)IIz98&=^u_bQ3c;`ivOzd>{`nn;`HFjZBj^mvoyj;TWDP5v@2lPmw?-vvl zaBwun0nXn#&0nAi$tt$PVibZRBb3x81otA`MR3DSm8)Cc6MFNpKb8I5MiaWbs?T|` z1=8_f`vr=a=l<1jfpn!mw6xC`_r`u56R^P zzsJ+vX7wia!cU*QwG9m{OUg~deIQY2SNR`s9X`+je_{QZNeUu|Qw+Z$j#t!IXlt1) zA>(4C=CSfZupI3$%Up#RI>%e8Ss#@HvW1)nMyZ8i;OjoZ@XLhcZCZiZA(<~n1W~Vl zrcK|9CIk$N<3tfxyJZc#?<3+Wv`oX4NVSfizpU>Ip0dC7Lc%_aw4j>9B7RoFMt^vP zPFxv>pbJhn>(CK_>nxe^Q;&>M1`H=;?A4TJC;u9qhPT!R}_1kF~Q>@iV6ZQveC#eIBbeCE{2wg5{q6KR;R zci_`T-$Jg%jj(wM#`h)O{LtP`6!*R1U^G*6ru=SwtaA=iG$!ZP&uFCzfiyY8?=*(M zMeeqfR2^~&cAwCP)?xX6@HOwJnC3g0*V8m;#-+sMcFbj=g=h#Xalgme@H)~8%1Ij) ztSll>^ih)|52TujLkrnKLUdAc`4B1ewtS{)dZ zRVjK=!-(&Q+WnM~Ot{d!u*O&|3xCMi-MG?O7jBi9;mNxoO?CCkeXP``BVhy=Rk^@9 zAlb<&;F^W-7t?3p=Q~KOVGk9pSV4Q6H+kN;y3-%#Io&^;aDBAM8VpW$ zW!B=MT>N%lg8x47{X@iHNF!pxGv(!&d_y9=#TVJ0ym)i1XX8f8`d^rVlT`#wYpbRc z*JcPna?>O`m(+LX6$iTn0RZmako$0iEcnWaMenSWm!Ex|4^dKheTLjAdrI<+wK*D> zo)Zl>p~zFO5M9waNd-)VA5<4&RYpA*KRL|KHLXB!rVv^KyR+gxcg&C_o+0(;$`TK! z2;)XT6B&`1kCTdr^OZ-9+0sOFR_zY6oqs;c$tGkXE%SzdXB7fpNCec4qMv8&*pP>XO$0* z5QT66p7Oy0I2+y0gR(9DmUn+y#%X{u@R|K_%IVxE#NkPLe1l9U0(&=V%(c#oqS}$k z22PA(L&o9FjyooxS^!Xh$P?r%;j-pV+7BKeClWR1BB4VMIS-q|MrV;0yTNr84e0^l z+L_y~W;vJuXqn<=$gPRl@|!nBhOhe{5sxLy00X7M@L|0_qeN!mw*ezglCtm6^+EGd zm$mQ^4poErD>;LH#YOG8Maw+I4nd*SL8O({|AhbDFrHRTB z_~Yx#w8OPr@v^dMf@z}S4L`JANN(qRsYjUznTT~MNVvt`{_a|+Q-erq6C*bQQ!~tx zqRz_>5Vbesv?m*Fx-bz*)EREG^ST^a#>^=O<{H)C$3OVqa=$m0wt8~=Do7X?&Hi6Z zg#0&S9e|G-xJRn}{U!+z830woXZQZS7tlzRVvcxJSgv%cau@ow{pD4!J9OunZkq8K z0`Lale)fJ;#YOU#u&%d`kStQ2n~ta zdt8UyGVHB~IMpvGL&EH;PD5|w(k|JQD-mw^?%PayP?eV|zo-CeN~|{9rB3iM#N+9X zfWfSS!EG5HnPdUmATGAUY}7fzI(C24u7H~$9}_Gh_JfO)TwfXTLEOBqwPAX9K)FnP zcl-P$@wyv&ybG4kPH1glw0bVpeu1d_(wJx3#GPSby^G8!Nt_u6RgKV3tV*u02%sA& zp37;9u)ACMBmYxa?sd&%v+7v#rLL4{uJ+`wQcMS}AP+KkPKT&M?S zwy)z?34L$s_tkrU<#BjTsf%M{UcUMJhj)dn^ViH24xW2zdwVkm2ATYwY7gdvO9RI4 zayTFYSJPdk*(j4L;MRmP+Kp;r84b-L^V4nyQ}-{<8$Zz}t3Wjjp@&P87vH4I1C-5* z5dL_h`ZlMY2(SBJ&&_Zas%ZvVCkZ`H*=4;@0H_?rhw&6E+NVXG2YW0u74p$9h<-Vm znLOG?A)~L`B0p4Pa?L@ViYnZnq4`o zdr#bPsLi)>{Got}30sa!s6w`1Bu9*k1u>s=hipMCe_MvrK4Gef4sA6>ChaCe2218@ z4!a~RC>`xxl_%MsgRXngRkTjFiBJUz%FXSlF{(J$@94CqX2AJmKR;hqxzD(357jK< zEwb)|OkuKpo03Fd{0DT4)CO|ta*N6i`vQch#RV-kjEnX2`wVSz+foz%dQCV}{V+3% z(;HD|m{fi+}YC|4)D^jIVXcaaiF3 z9US2D0Nla_iw>RbK&mSq%d>v?>i1J_xd;>*xafu>@LU`1gnhhCJAaavNhuj=n&m4o z9+K}TWbLaNi7+)zEAfE81gmgwo))?anUw%4sK>hw;LiEuSIPBd)LShx^&c#4+a}z{ z>L`u_6B`<`NoRlPc^(tn+_`-vTx778SC`qE%_XMpJ`i1Zy%8Ss4@u468?g2j8L(jc zhVFR#lk~_k*FU)&{;+%f9q9u2!~Xa=A*Tu0sj3oPyQ|_IMp991h4wzQ)AbQXN^@*8 z=QxJY`xd&7Y8jnd)0*ZV9y#?qS|0=ha-PwvOP)#0r{aK9{Fo@$Aw(5iweD(d8%q@j z=-fc_o1d)LrNaT|e@zbR2F94e^(xnZiAx1JjW&YwPxj(J^q>ZLc#>~8=0C`lwl7dV zUHxKV@9!7$-$qgV+2g;N{`}vdapI7^Ot0>$`RV(hUK7Zdf|84vH z$D`8-8p?#|3ded97D<_(!(6@h+rqNH;x}duP(^b)&cl znb_$P$|WDyx|wc7l1<)|hF5Q#$zfLGyMs@+$~lWx=fY>M5}WNRRUGu$OVS#11tfSi zKcGXZ07Kz(;olfO05}zcGdn!*bMW>*kuU#_r}`%%-@j>j`rkm9{9k( zhDl{1Uz?VPdZ0XgGex~ITOAmMwQ(AyL+U0QmQd}<7bE%OS0fO-WFN1+Lq?ClCRC&5 zlvypv>d=dBL}%%R#@iR31V_7xt*T9Ib1OLp=SHt+R3=dbWx4tChd(f>q&#LQ3UCK? z%0!94wsAViP}+H_o;_|H&i~HG!uv!ytBg->)^_W|j0Yt`k(c_bCZjL?!6o}Mf5$&Q z_iuYWfDyj`@1?u`O?1@%?3)oi3wrsSv#GqD2f&>!aE(>M^>7t|gGLkQXCiy%H`duN zWRjjG(R~ilE?Z^W#>C;wdItxn$`o-j{aR@9>Dbji7qRrsx(N5@$B%N0ViPWP2w29t zdwh-7-sxLBMr9$i>gEF4D7O}{iFUXfez^Cg)#SP7Z7;RYpx0{n8$$s<2RlL@}0r-x5AUDlTtll`L3 z!R~|uwksQ86nnCF)QtR&nf9CRmBBVgcTq;rF;%H)2sdp?haGa>wLLy zf@XJaJD-+MvrWy|Ng*MX<$EotUm#n-SY|aTdbgB3(0=P2#Z+b3PtT$?VS0L=J=;t( z37^g+`7A#gwB;|e3O*J!6Skl{EvLmrktUyjCJTO%UHRf`_Ed>O`@`*KwH-76cimxx zT2bkWVjyTQgxCK9Idxc0jSA6J4k=jdpou)$4EDXnEG^}KCHK6>?dNgNHP7{g0(rY7D)*rU<(@D=$YAARly0jEz(FbC;%^;hRo)H$Baq^;ezB&G04yrLL zJOia8Va@jp^N5}|FEz@F@-p5srW3$5W^M`*ytP!?E|jj=#PG1Icpzyt0;K@ zo!<2Hj~CO}vlu*t?}_@X`K}g!4Y3*^?iTfbzj|;tf8N<|dY=8e`y|ugF3+7lGF9dbP0x z{plYwQ08)7tyXHGF#9nhyb{sM%BlIuqsM_8PG3t(q0h>SJR1>uqwlItlY=OxR8``1 zvdGF-t?wJ3fbSzEi*_Hk27OtNf%kj(z|b2^;^Xxj2rt(M_cIgsxOg34z49CLawf2C z$t(;Eb6oxCF`#ys8R19^S&h3AVC7MoMH#bJEca7a`}nwS!gB`NUL2KJxFpJ4B~I=E z)DjtTpMM^yq}a);K)RvZo}7Cnesv#RN4GP=jcQsZwFD~r zO7uK0G&Z5ljvJm@Ww_1yS^cD1=Z0xu4j8PIZi16aLh*_(*Dz+1I&uwHe` z|MeX!CFn60N1AeK?7>-rr^x!ePXjO?8Sg4xFMP z+|CbYVFBEo!bge+Ed2bz*31O6N%lVs7Jxu7|%`}!b7qLvk^5C z>*y|V^*ME>Aw^Yh>*G<9IdH-s?{v{3grWTy!N@^AV`KjuU3R@Kk zA{`aiEu&I&gL)DFcTSA||8ML7R6QA>^y&Nl0x?*S=K{1!cmv>&@%j1B(xvg$5^yt7_yY;ICq@)X7qT|9L!SQo=yw-B zviwqo2IgeW=@qY>m3b?WYQH%uz1Kt?;7&`OiM{|2Aub5D&(e1Ah8>RS;=OlPUdCOP z7ndzM>|T^C&T*Bt-H)FLICV}yosLn5jtYk+L9_^WQeWHkK#Rz6-5Og(C3Euzi_nP> zQw>trwBtF2IiA;9U$GK5-fX2`ZGh~1FHdiLI{J{ z4~Ji7W)`_n$^k(E;-*Ry-sYP98^(9;$N-aGv%=LYHF5kK9|$ryl`N%0PwYaryViM$ z`bnkK;OYF#;!pqHF9T;8XL8A&p>Edw$O~V{w8HE}5}AZFu9w zw_F$4b2pp$&j$2%yBsd*B)R}2)?OK6ksz`|x8B5S^&hgQ=RUNfHuqmNQ$88*SAlq< zCKqcRjzCG78KR(ulRU_Ia$eUdHM(~wx(vqeLL%JkGZpaDhp!;KaKDB}C@$QU$g6W= zJ4Pti+BKE5H?cLki>mZI&4JC^x}q7nQsR7gS7934I)Zo4(PUm@-7G;<`?zI|8N|@m zu^IKYF$7b*VlPHtz$|j4>dq1&oa&R)=!Xa@banLR-*k^uMkV_N0t400-QXj=m-hGf zzr-XQXLrl1>w_w5%D0UU+}ct#PlbU^&P6XNMn?)4pU_^eRt*j0}l z^?DhTWVtgJJuY1^`VooU36YEtan@Oq%G?7B&QbM=9*c?Dmd!-vgo;RyJLB~zo9UeK z?vv@yE=s)VXF1Qyff9YXnz$*6o4_KOdcqKr4fREBufp&aP$+#iv(jcik=Fy05OyKj z_TKmxKH(Yn0Lm5edoR(mvD?_PZ!S{fR5hB!grA%;bLHvg8YXDor&pnmwd$OWoanM2 z;V0}klix(%6SH66U;Q}O(w6*YzGcp^u*J+on^mxCV-r_~Ov#Np9lLFc>^?|Lk`4K3 z+FKZvtvhyhUU2TpAbV!B)tj`ywg(^?6!{6zz#;?mF>az~Jksb#@PiL^lVWXISAw8{ zV(epgZ?MG(VBaemVpq8+S76=Um6)nzxK2QT7}?ht<#$4Tlk{v0D#)dL$4csatE0E3 z;WfH!$3oKM8UB$`39@})o4jeDwxFyK#YS8xH+opo_hG9QbMMuqf*0Z9cGjI|KWdbH z2u94T1zC4{Dn6Hzc!MjicU1OlbqI@)`zlQXKpH%E;WAi}i~2LWz9N?01wvCw#m(u@ zx$2!Zek@#ES%rR_y+y~qd=yqbq)PH8r(wcU3a8|DjlL4;4}|-{)~FBS8 zFFvwZj2>@1qO0r)ICki8>mzjEG-#>Xt1(}Zy?)qvOTRje=VSUOAKmWay*c!RiJ7Ip zL+S&P0Ukzs38KCOH}tP>mG_Z7RgVXuvg( zD_f*}&QtR5gFM38Rkn@i-M=I`T*3E7G!o4i?w;l8{O+`AO#buQ_>MCzMai8J5JTA$ zAFi{8-w6{OuJfi0IqaubcubQpnA|8ixD>eu2XraC?iVM#A;4*Zgynz%w<2GD{>x`t z=?>wKx{w!Kj>ay7xWE^xA{!U0uSDNtRdt_6$<2_SwGtWHAMkhTaLR?0Z39zAy5=a? z&+3<9`b$*4GoKw8b+l}>BQV;hk@M1Cj5M&j&r`- z6&nlNWs9HeZ>88RoO3rcK4NPlV8irItSyR&+{k=A=i3P8ZUeze_pzR75n*;06vr3fYc&eGGL=na?~V;N%$;2t&GmO_@SWZram6=ppgJ` zB-Id(!|rM($)Y@7_wGCJ;ctU(_qxm`i?6t?`4<+C<%u>I!g8Xlqwqq421j^c$jSw)6sE8{};%P>6(Jp?V}f6S}%csabP(J?9HeNWUU)F+r?%YUWcg@Ft- ztRUdS0+f8Aqwm87aw_`%%5Za`YU0Aa$MvQMQs4mH zlRC;CR0lFsM5z$qK4$-Pu<)u9vo^zd@T@lHv;JK-o!d{uZ>AZ1N#^SuEO@0KE(i}I zZx>UqqUzpHDvP-5657+05+S6 zPr`nJmOfrbkZMUb!y|a87L8M~A<&cLx6@#@PB$p8gK=%`32=&nv8qITU8W};t599kY*6EsYDL$uxMiXHTm{@OiI zZ%lu~&c|jVvUGgyY-bq7Dli=nGPrL-px|xeq5y|HaWzrLlPjLb*S6&W;Ty&?j(X-@ z4v(>$?57*+{QGCMl5RJ7T5FnAr!0K=xVCXaiC`DH-JeRE>67%ZK3tv5v+aU1lP^QL z$T{n-lZ!MSHktlo+m>y%$KFt`)qF9+XQ>b_SzA0x12N^p;z)HZ#GI;tCFE>S$3FO& za+B*|(=?kQ#>i4=S@T6g_5Rx5)Ich&l9y zS*8R02Vra9$;xeuF9Z%clF6hNv}}$%M=Bp>{J)GayrKC;i8f zrpOhkyaUDF-VxKfM6-#FrTY5DOTr4>Cynst3Vc@npbZAI7+p|snIiiU%zrWL=-(op z{}nYR_+Le0Wo;S#Z2l%(Ii@V-XnxXAxJ$)Fzn z2gXO6G39JkiB<<-IQl~}|2>s*JQ~7BHUz9mA!NX+4nP*8CG&MYh-6G;>W*|+?QO5I&AdZUd8L&Q(ayej(dnCD zT-ZF%m(gkgp_$OJE_&W0yEe_(Ob+r>yUb&-h-*^@&mv9~-j=TrM{YC*2={4S>YNoj z7TU6uM$m^b_38i<)ex~!XMl@ahhrC+yU>78uKDOfii znkEmCq6Up?T_kLAIH_V#+Dn7XrziKAkqp^4Cdc3daemIk*tO5};df=$0I)PW>Ik8* zn@G0BjywonB2M}Se zYp0stb|&w41p@V0UX9Oe{dZyfnNRs(XI~t0- zxcbiO@IyrLGy`_TT=^nZKNOgzLnVgds!M4 zC1gTEvSrCWBuhy`Qp8lq77`*2BaVGb3nyfhEm z&T)Er&i6Ub@AZ5AUa#LD+;el!%;&zY>;7Dy_5BX+xqV15#!X23WxelN-NA~`LD#er zzoJbtRqK#}F(>Xx9#YqUeO`yGN*~9RKV^soWAu{ng%-39S&=vb97nxB3OXZ}x(!a- zHGv&og@R$+5CgVJN{Q!B0+iMve;67rRNVmi);dHBFtR*IT8D(?*F``;E`8H&8*dV_ zf>rE)EfM$z9YJy#VU6Dh+=Pfd7&nQ6T&O@Z-T}Ec$A~br_ki2ZhO6z4*QVZ#w>$R4 zafK+JJx!LVgx!CBnTI}|VGK$Z&8kN*I}9@}Pg@z7bG{i;C9>D*ROT&|^d9s#6VAdT zjG&PyDBbIgb#NA}gUU3LKe-^2qTOSzN0uYBo+Km$E%|_=$Hcc8k;h#sb!1nTUgN`_ z@%{R%>cAWA*hFrthPR?0-gs#8hyHPV|KdW}JWE!=Ty#yKKk<))oc70wx&csa|Bo%r z|H~5HMAW;5Rd4G-@;!C5I8`t)X!L0Y0LkaOACw)tzb#-{sOqGEd!h;5NZU8H^c!;3 z@6*cvc>QoZ*l4k86sr3d3uDAyNm>bpc9f zvgkJR5kwdZf{dXYUx#FbR6pC(YC)+2)wFg05o^k#qv-eZM^ZcwFRnH({1)ZL1hrhD{*L4G2+}u=U-H0u=MI% z4phgcU))l=Clwk|O;2lumx|6z;PSNV0OsD+8hdh{m!Yo9Dcl^)!jb(h|16W4zYf1x z6MdCD3R@TI);kPv2OcaL;Q({lzm^B^psP;MSh+v1sjfrDt^)#$?{b@epscnBr7Ud_ zuw9j=p?RMAlJ^#=F>l)}bix%KRcb8}{;|>s~WocdVbp z)L}VM*Mw3O-0_G= z7*|VZ021YfI}*H{1O0`a0^>(@VdGPPPyrxxs}M+W+0JOr628bmp$W^j5*O*SZC7W!*phyA zH9kGSc2hu5vYaEPyQw)YQ?i7)>onAEFohD-qI~KW2@^v(PnfqRhZDU=?LtG<#4q`w zxQ7z=bxW1(E_K=eYtc*NoA+*XEH!B-eqN4^L~+VP!!2&y&hmM0Kt0@Q-Jz!L$C&7n z>#pCvZzoJP{RmW0S@i+EboL0$Zj8VC%s9rmm?{lWA){mY)~s~r()VI)yQ`41c-cKAJalbGhY zRZ6)RSJ8mH*??Vzr4(9jCR5|Sc=MFRIGbA(eCOPf z?($>%>Gkp6WycF|;FVtSFedk;(%vP=S(CL9l`lIlb&4c4@FrD#I=D+UghuC9K*IZ@N4s&oVI0f?cyX^x3M+ zNDn6HhxL_Ti83~A65mw> z^>j*KR+N71zxOu&m{gMGIFB$(T#%I)7hR)I)<{-u4ga9kuul)}NKmDghrdhToQtV; zN%>t5i2K$Xaa-LE9p86>`eBBdPQjVRZ3I+$(Pt8xkVldJY4|pZaS6dOCBV@}gOU$6X?1n&Jl#H9%yuqMs_R@~ z_~mnT$3w0NUsF1yKjmz5lzeMMnoTRC-^Zp_Wm_D;%~#0$HD1M2Mlx#W;o`Qs?RxPs zZH?#6=_16H_nB+ySwJ4!KXF*~TOQA_N$<0?nquOe^Lc#c?#R=+hdk^r83ImSlQ_JH zn-3`Au&UHTjZ|%$F!espyWpZB`fH($jhjS;FawL)MPGBB+q#fvrgwYe4ql6o=27%# zB3M7leLJcO+v-5-%WK3-&YU&QowJ<3qIrb>%S6hubqB5t+oHkOe@mKvau?C*_}Gx% zu1BnSb@r+kn6T`NK||$NS!Ip-I_GE$e$ntTgnKKnr0GU%9z)q-EDkjvM~#%u`GrUq ztvm#oG-=nt-U+1^2Zu!FaKKhS0~(GeNfs{oq=i7G|xF}(?^+j+%LYG zacaA_z62O?XWEJR8PGLmlRUh70x*pr=QlCwr58=!)}fDph;M;-W;_Yd&?e8Oeja8A zQRv}7G#66URZ_b0mbVv9(zanCW5EA-9IvLvqLd8Oy0WL|a`jp2bNHtU0GdNOEefm& zMa;9{AJ#vkHW)bm>&riA`AHz%$Oo2|nv%*C!FEs;jB4UN5>RP2T7h8mNwlOM1>jMZ z!xz$Z2cD|#zTM0-pqV4FW_yyb6kjW54|vEuu+6>s)p&J7dLN4ugsxRR+o8$# zYjlrc4AIX(Gr-Ke1du57D5|j2>QjJZUCKg9K=gXh-Y^2UUbk!c^jEG$`c1)0=r_Xb zZ(+jCE8_1c!p&dwug;+lP*}!Vski`j?mu!(oVgZKf!A=(0;(0CXd=+iPQN91KgjW#9@TZ0ND^YF6{@TX?h#% zb=LpH$94eE|7JEf@Ob|j_WS?K^%YP2FOL@^yckScR4l;G-u9ieuEax^{Fz`{@B64U z9Mls=X|QxD@HH*u&CF1=9pyWeC$o9=&&SY>Z0j=p6UE;VYYAc*E);7-hqNbey)}Xe zP1!>jYZ#6ai5ayLJziFH^R%Tb>-c^Xta>!W&tjXS1J_qRWtJakG0YG2#lJA|eiHh4 z5~2H96UK%V#?x3o6JPMt`)@=)W9OC<*Pc}~QPaGLYcSfNH6Jy{YgWjc>_OziVr%^m zb_s=8hP2OhwY9s1DOtsLr;81}i?ebusnzjAk02t3*=eGdei+4&?@9KY+~d^F_^65urM5)j|{zqAiWC>+0pZ zD1OK14`&a#r9b>&@mAo2l0K#GSn%shrANjCBxxOp1@jvF);0d$A_h#zdjRmM2kRC! zq(n_ovmul<_L+x!h9m8TR!DNLGB1lH$KHiP*#l$_D05%1wFPr($qEt67seYku)%{+ z9Lq*w=6ybuF?9wGyOgDvirGXO>aXp;_ulLmPT>=IhZ@f5@m9E8y|^+nTs)Kw@>48> zJ{6-`*vVPRoyKi5xzd$_&yJ58sv27zowN)IahQFQfE1P7e?{O-qp%~dW&p#G14f|( z)W~6eQOOFIqKIbsWRBub7q2-5CaTZ(=GzvtyFM;`v4Bj_O#s?Rj;RKS$bwL5QUP|i``<5~{1&58i8fIJTPo zB_Vn^62vAgr^D@TI@_!5P>YY=lcHmG1-j?ji~T{xK_$<9lqTaDwr{=uf|i3&c-+G7 zFW^27+$DI0N5^Eo+(~jRVfsALtSPX#mD{2vx34&i)NiHb&}eIRT~Sr6`CzU-#9%BYBfuxM{PT-&ukM||NcTj=KSOv zp8Er6tyTiLTLJxK?fl-Wx^f!~0^Uu%}B5A{{?)9<4N?&pk|6%Myn; zG6f@?jQ!|lT9rtf7%?n2P))Ea>+v%1sf7>5s6NmUcmol5u*|`=fo%`igSbG?B#4G4 zC>DT3k0%P7kGf>EDp<4P;S2*d+L<;@*g-T|q;*CjMuXV{I0s*^^ICM9-MbE9EDUOZ zZI?Gfn%x`VD=koA|2K6eB1_yQvIqovh&r7ekBePJM#nO!3p_c?xrm9Wr zvSdK~JprI1FWGWU5Y#v9^uR?MoasRt<&Xs}&r~%N7wV(=HVI68K8-%btC& zu@L{rKhtaZaf*SWC(L8=e7ykMivqF>#p2FF*IpbdFy!%h z_`ywc?f#AzaJb`e5xm~n(uju~d6a;_LK&QV8zw^Lb1P+W{cD(+$cj9PGnS6TT^uxu=2NU-DFRly&z9bMmbPbabqCJKovtO#ltztECz&K8D8$W z2*KjWQ_ip3r?@S($BRi{kZD|;uWNkmc;J^W8Uq4Jm6}&I;oZZ+(2*B!sX@Ca3#Tn|Yv9{KG zqipXIwB6-Cre_OP=J1Ee3QIGJi*3d4Gk@yBPwdH)Vsbo@{!t zU`5f?2lG*$C}t~1U+-YbrOboPY%Dv^BLv^@5Gw1gUC#(PLXdgk3Tr^HBh5$VSqJ-_ zOJ#?gtwlQJZ%HT>XU{LQXXHk_TX?Iy!ouPdK)=KogSMCzxX)$USH*g>S_nGiJwMq0 zZZYc~Zj3OAoWP-bYwG*#BRHLW;~yyoJ9}hbu)M%F-Ce#8IiY)c*I?2N@%eza%=i!Y+J9thq( z(FpY1K-~M0Dm_)F?gs?zQQd_6N#Bdrgn{ZkA1aNd!-SGNoBa;zpPR8`wRt^+4Wz@* z;aMj4ft+)yP)uNG(q-%DyxcR_ljUz%xe85GAs06}*VSQ=ZI7mb8}5K=0HI^}j0Xr5 z9k-~&cKnk-?r-`dpk?d3O8NPbX9Pg{e~l04(^_kOfQc1zJe9+_ z!C#y(+Y^GZ2J5YgFuQak!T4SCbF^&Qb)`vjmXwk@=*MAx6!r|QO#r^Nc3x(xJb#>C(VB`zmE))JcmxYp)@U&Aoq_BzD6#>+m4#aO~ zvT-6=l%zve9<7Oib0{Eo`(R0r$+H}@=m@W90fpzpw5B~}r7vXb^?e5B4k{}{Nc2?| zG#)%HKZ^v)?CK^!(C#!#+nzK9kQR__qFNcvZU^~95QcF``%f?X@G04y20m~0um|xL z3Atw-^6gZ`SV3r*?_XMT z+wK!5op;wIQACbKfkGy=tiL9LB7uo?1-#H7V3TI z4%BBG^Dc!23}t7i1ZdAI)qME&^3GkUzBS22;f-qzK z(S&e)2T%C@k?v=qj~|L3=uY$PxkoXkX7~$G4tK+GP&NR0(72;1LqbO9`5M0v*Z!+ zjd|o`I7~Q=SuH~~tz8e$2>;93)WTMZniw(mTSks)EQ`X$Olx=MdkwcgpEoD$kP#j7 zLOYFJM)*UZ1H-3Q@&WVu*l;wr+Br`ITdT(t@@}k3ehFsUx%e_|oaRT+N=C6J$0bs= zj3dZ7BhoXAYnT1s`}20HNfXB3l28#nXF9KR&I#a_Gw(DDzW-om{>iv5>Y7A{9uVTj zx2z+e2W~@bgL#nQ#2cM+`*TuMz5~N#qQt}_ITEH* zZLf+Wq8MHG$OBjTer>0@7B%CEL37jU1xQ#k53Y&-QW#!&yz`9WQg zz|kR{yW++nW)JS;ZnNx*5utUK^=POHYc_j4>a5OtHS02!*qD zg>5rgH7^eyt`keMzs{1+^??OgG2}=1S&v3vqnR;+oUtWr*R*loTn%Q+G0=}BdW}OI zQ8Cfn#vP_4%w!;pNuvmoB}Y(!LogRWNMZ8U!*d*O+J&)Q#4M}EE8omNAS_jX*Zm8q z=*njyseW+FrwJe^HbjMT032-EnMsty6D(BqRIiS3Q0oK4jcL7@Tdx4Lh`l^$@8#kI zd0(!mYhoLmFXBl_@YcTMt&{GF5DOUqeIVhavVo}D`WvFEY_Vzoz_CKTg96Xq3~>5h zBqAiHthu}4mut9c@or2`D#7!$>eiDDqejpZCqb+r%0MDIffRKL2eAp?`IH5&EHOsC ztf}slnV0Ff+WpWwZK||jpcnCq)FboyaAEzF+5Om~TVc@<1AA{blrzWdqk8atx`o(7 zr}pgEh2%(VAh_T ztrfdVW}xvC=XpE*AbKs~eP8717Ka`Z)9|4|8hqz`dK%z6JO^(qHo&)DA-+kX3T!!4 ztV)ha$w-*NSsPp{Yt-8zr+8W9Ja?dUCWWnIc~BG|T0bZa0+LsVEnU^YxG1N4eHQ)i z!kSFn86%ytx7!`EWfXdJPj}mltJ{^(I&1E-m~I|5xeUF%F)4k9&oYuPYF+MUu-wNm z_REU#71>}73-^VHcLeFW)(|+`NJS~xnJ|sj*cn27FxPRc-DT!1EgdQDNK zW)QLYy6Hx@$H$fL5MvlYMGbRlC?ff&sntr(s3PEHK*@$)s=FA{t0_m;kHc(H71T_9SE3dRtbJ4RCp8V_I* zGf(dFEbHghoiuLbk>wdo_EJuTvcZaX&)!jj6*8mdRAGP0wql+^CWhhzG|mDOF_2n_ zn*0D?C`aRrn~4>qPhFtUa7nt?NcZ^*ND3wj zpP_;(MF*o@7Cw=q2eMsAd=9yH@>1d)lUHPdI#Ui05)mh%8B+g(B>rbbNt>UXbWkB- zv85Hb()0DxgO-4Z4|AlkMWg#xY>0qzd5AQ>C3fctPe093rR8I0j4M|aa|68g`HkCh zFJ*@3O#(d8Jg-59GbNqH)8wJ;T z49#XC8LWi(>wSS*Ecu4WwVMQnQFz_0{uXDF1u+Gk_POV}!eCQi3E3L2ce7a}x-w$O zE_06V%o{%d_vE)-2Z`T3D?zNl;%A0A;kIzTaGc12B&<27)AQz_Xkzfek4mo@ClZrD zN~(u+b^}TY$^dNfDG10^t^C_W6)155<^+lia^xj$8;0u^H`<^cMNyAxQMO?z|8is< z;+hJ5B8GX?IvWQtHS*Sup>UwgwLcp=>o}TcupN*E8IZf&kDPQW=kj&3r+$g6QGu-P zPxe<>#574q@rFiGOrbLk1S9hZ6wh?n^r+-1=#U;R`VgmRyzU-EvCPG|tkdt(XC(zD z@B8Dy}im32bODS4I@Q^#!uK4 zPBMFeQXwtaFS^c;PaJL)UwIUMWr;!50rG*lCjiL}e4bDZjyB3xoU^H0hC_U~{naRM z#jdG$w<`FH1U}ufT)OB50J8oaKGynA!aSQ-*T#7oLp%8W>JO$hfZ5dHf+Xp!$fwe6 P{P#!i+w?bv_1^yh2OYrF literal 0 HcmV?d00001 diff --git a/docs/zh/pics/iris.jpg b/docs/zh/pics/iris.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8d9686a458df0049ef7542addfdc4897f6d6ee98 GIT binary patch literal 44414 zcmbSzby!s0yY|q6grqbo9fCASjEJPt4ZA{*Z0SFeG446%-);*to7vm+-q*8Z*LjlJmB; z0)bRiKwKaY=ne=Y+!lll908|*Xn}tq5Y}f55Ek$gC=7fSbw;rbpUiNM$WL$^W6scvDM$+~s|(aCO{8LWV<_LTy#Y0a zUl(0--A`B(H`g*{6(}RBjO#ip!Dm?;)sQt+t+sGTc4Vp`B9`BZUA`QrShvzj5i1T@ z5{ayC6_;nBmae5w5b`@?toefV6*|S#d7({dWnrBaO0$hB!Q=?|Gq4a+C{l|lwqm{c z`AnESBf;g)=J>c8H+(_TN824Xjbo<2-YCp9(B|OM=)XhD`T8y{B{YLP$9(ehgOHGC zEcCHlP+=D8G`AhjAd@ezp(LYeh$^Dalru_}e*HWcJEf8hj@?JGY*huU@zYXFh5G`> z{y6d{5~vou&!zRwEc5gbw+$!5p!BTuSlb#6XI3QxX|4WC+IJBw8{|W|Wv5uNa`!P5 zxt!-{l`C0Ej&J8Q0}(IEKEP3LN~LzDgdC@Q)6U<6*Mi9sw~>a%%zXADp*j4nmK6u| zx6`l|qt%-lzw#|ET0M+IW<}SYti&c~alCIOC3#B*GxT%a?WZL)2E>!pLbH|Cm?8tB zB$I*M6G=B9#*pj7Z510=(Jn8N$()dLb?_`Yc@M|XHDA0Vdc5OaRI7Q=_Cm%9naJna znu0BJffwqQ>w_(suVLG-^qocfJ>w=n1xDy(?Q0}y?Zq-$ zu3c&hwGmau6|=K^l_U^TyaADw zYYQumyVgQe6tN_2yhr1{$5wbCJwA%r!hsWeKS{HIC1&V2(j}Sw=bc`-kM05Jk>W+# z$rfiEH@II6BBMc`twQk{k6VDgv|Fu7Jm3b@zffx!$%|d};^_DtV}7BWX2Gu&jb%xDg;FiUJnqe8oG>%> zd$%1sOeJy2@gVM3T@Es}{$;GJs(K+xa@;}IgG%0jMsbNhve+y+qoh|B9wK?Sj&c7p^mn=9IYe*W>FcK z#js4Qx3V_Zc5GJWAH|Et;HDI0#B!>vdURGyA9i)N3ew0Wd2rVyQpdH0P7_wewX_0u zoX(9-^V$?hE=N?7uFd^bloM*)K;vO-iSoU#vh6B9-_zd3@7b2tP@SijWFJ^4{#-(H zYyAcI(e1d?@={mhG~z=(${cU+Vmd7H%*C0U#{6TUk-=GCf4CM?yv7|{1$+x!L(4G| z(sEo6v$KgdkQvf6|&l1UR2j?9UHR(2x$JuCK<{Za~^O zF~V#XbZXq&I_&;!k&%^VO1N(%FKGjViAg9QgOWAm9uRQ;h}=1p?X0fe!a~6Uq_*xW6JzdoZ=wBe~0U%xS=#2^YD1E*v5un z&87D5O3IQ#OG~jgAxesvk(@dPu@n}=nA+bIm>K$dTNKS>87(B@3Kdu?*ztn4IDa?X zuP;&Q+Qg&zQ|4NbzM#6itIBk=1zkX=5GWpHRcQIQSyEc?X!(!Twn)$hjjW2fM1Bl( zpwIyBt&T57Kfb~eZDl_6xhS5rCw6mfe*uP1@sQBVVaG0M;Fn13{n1ZMm&GWqy!}ez zbQbdsYv=Q_@qcvQin9q-aj6|-80p({l#`|fESDSyb`}9h*@s!YBQp6#iRdereZb}M z(`l_kWK`$d8e)QKGhHaL`;Uosyht3!e?nI-wYdhuxt#5O595yLdUf+%4kcekMy$B6 zot~9cl8(qx1ajmR16HYW95_yptb3Pla%QNTk@5iXJa+RJRJtLPR4(NseaDS;y z+s9|4U$=fK{IN@?UK$P7UUSiv>`ILYBPl631FT&rzR7LeCo-(4jY2~XMDdx-S-kWk zdCVw7Uh-g#!+TSoKgEtq`ceGL^lRC{nY@-iVwyY*D*%gDT#L|;)6(+?y}_nurR4nn>2^=GFPLUAAZTWe7|q>_GhR3UoZ4l@4|-5HQ#5@{PGIv_8xNj4 zwjAl$wt#$p9Md-zX~-#(#9f@@BGQ38mriE{}YjJ5c;PP@2h>D3s$L$m`W4u$4h%r7~} zQ>H_xa)quM%7+99oOcMuZ*Ol)=0-O@pvnufF@C~Ttnyc2}Uqds@1eH#j$5at@e9n8{R{4hHOW;`n@MsMz;%FA*S-OT%4qeXOK(5~ z_wH!`I-ma6-)z}#+y>#3ZJkn?2WwglWM7EiL6dzlToRa9NQWvO_elf-#<&p3$&!_= z!b+hXWVVQGO)>dmbOX9ST0S8akE5LQl&D2-cwAe%2q%YEJisQFB)5o1fc%7zL`!`l zeI~Mmy`*dydyyWp)3dr`hilf$<7&%MFpZ=3k4b$l-G@(+^j@gfW8NwW84HYQetTPU zKT_iuRk1x=uAzDjN|WIf>yg^N$_qd68{D1Nl=v3(ZZ`v_W=enX%e7Z%mZKC?A37QN zHfNV^#}=5l3W^!ELnrIMgt#NbQX8 zjA=3hlNOK|P@b}CdXB!&`2Up*o2{#57=7zKE<0UszyZ7{{_@rh=pZAwI6NOny#XBs z0&D?>E-yHITOFj-w((_-8C1+r_Hlrq26zS>{kp5oZJnL&`bDsEi6f2=M_vKo)3L4mYnQ-cex)Q*aY8p}3ta*pmLia=?*W5C5d5d_}|C9%Z!#Hxmp}8*QxyC z;JNx~rYw2-Rt(Idh8xgpJKBuZYnS5TJ2rWd&nP9KJ2{9Fu5rZ;_O{(&JvNp5L!?;4dvg})9Rit`+1BwEKn`q)EbeS!`C)2)Cx)-Q?D`IhG9<+&zAloql zy;by2&Y<-h`jsgTa5&vnIYOdua@JKPf=nWHb+y8%g^~fU9|=mo0gV@r-++|EilAql zXW-G?qBh|7&tCo~$x_1n7JpBSqEF|2ICE*)7PkA}DZT-vI`x!K#9erz?DGDZ;+(&3 z(o%^m=|QjgGp3s{H2+7ZRErSjYui^6VOy%p+jBZTI=7{e@DxM7VlO3GW{fT7d?wjiKbH@y4U1?+AbGE?_NzjVWm8pA!9LDkaSNRyp@_kT0 zcb`K`p(W@V7HlEy2y!@camC9fu?DsD78NRta(pazILEcE;aj5knEa`h=L3L|v1Q6# zVQ{_bYhUxBP5K$DY9=NfR<76R_vHGMG!IIj+ikgmf2E2&^JmVyY)`i{lhD_35Act~>2i?42GM>Qof;}xuw^V#(M{mz}ZiEu+S(+#Ly3dL_jw!32WjW_>M ze87-}WExU3EFnY!lmE|i(p`v_x7WGjbvBCZTc5-7)#H(ayR6eE5ks%jqpXj%A*Jim z1RD(>N~c_kn&%hizQW0mv#xsls&VIRdUTi)tFGpAmY~v=r_etta1R6jo25}j~T0VXQV%5ae}7UpF+-EkkJ7+ ze$QL4KLtEBlHpAfZjT9=pl#OuLnuFk;S$GY+0GJoP>6~?s z?yDZC!K706x%Y-UhspKY$(L9D5uFG**{m(~)$1jD#hxIn6y5TeTSFJm+{T1}b=+wuwSQe%?Y{m&s z9$@*I&nNReu*l}#L?(57`NJJmY7*rPv6DVV2}6Y9ikIRF!1&fNFYxYA;5v-u&b36yMB=cDaHLji9Xo zDH?`=k^jvPv+jHbiw-P&Dtn8qboa@eH$+R5hK%>&+GR$>n%7ltoN{c`Ii^mAoLSr1 zu3DGo>4nj$ut_8@);tX{wHB8}T3ia+^0b&b1#Ls@|9!-q zk)-g9PP0Jm!H+G8@gU}?YwH1jF42_5khasj`L-lK7ijrK=J@z?11u-JjMzwCoUCq9 zNJ@*ZHXj}P0%|)&;8nj!wnA>+lB}j2`ddIPX9NpfE|B%dKGD^|i?uB*!RNc|xg7W4 z39R{oCpjL>672{S!W{PM4;5$7hnoPL-~)ui*|ZZuqWqv+H~~|ZC$v6k@a1hf0C z_!V8nRp%`C^CM7Fkk*G3-0fJY5`iz~Z<&v7 zk+5MPU41eO=ei`&Nn5o5o}EI&6MN&{syjRLSj#hcF`=@7VxTB#OB9!9rIyYM@yUw?%K#K5V42xs znSuLZ*eV5LG*SvJTDFxU&!2z|j7MGrV&l`2$YP5FBFj()^3Tje# z;K?8c!ic>3O0m>vt~cqTxt3S&f6aFhS;NKQCdX)mfSijV?srbay*?@$bklkLV4rcZ$Wd7A_6dO`gHO7|jyfv3Lg=*4BSza%&O6d=I@jT6&IgkwO z*9|BJUJH+vX0K^t4_i>VFDK5ZtrAgWqHt*Jd+(jh@#VoP6DyfgAFR9w858!iw3$s- zg%vgEgbsimNK24*MBUe#HMdwyJ-cMG@RPl62oUt{j)8@<#&u4nJ*fCRFNhV_A{Z=# zO;6q7@nAFZ!rJJ_DH5gO?C2+3GPn3+03z5w>NhyP90AJcRD4PF%d>*}RcT5fP+Y&Y+n}gY5Yi=yx-Q>cD$XwAt$r zK31)=*TDf)@K9;SIX~G63jgXZLdk?!&B;g4Hy^k$uYZrpC3zi*tUez`*5!~&^9>f- zYT~;O;so@PGBBD{*STEZfZ{!{c@+$=H^Zx$&dkH9gjx5?g+~3GAU{7I_WeM=TS0|f zzg+>Bj5|$hM5%neHayv=I?({j+<@M~XZpcWt>ibL_lq4aR7b=Kq+AhkrzLm;BMI|U zNsJ`o+`r_(6sKTv@1%|?h&^Key8C@wupvGGOp4RY$~*hpp9`L|T^HbWNnr%gcsH%p z)fc|NsqPDOd>n7;Dt(#|h(&(#q?1f_6(Sxmw^$vHdX!O(GDld5jX42$O~iZBBAn*^ zQ4_Hl&Z{{>@Ye%zKiNK;jRvtJd5!!lTgQqi)pF}~TL(`UZ=-CzK9{kjxfA`xKMs3` zFy0o%qrF3hy*P2C?bSP!7lNhK31-~8B0&kFhNb@bY>}wz-nn)1F1 zMrmY7-8W2VmMZP*==4@ddU&eTb6Cec|C5=f!f>kNy&*w7s}hS-y=XT#lFS=Y-= z6k1l;N4(x6gUM1W&nY3li*0r{nL;nNGSL>$XK?x(kQq1>Or7iR*7>8AX)?{xC{u^= zRo5z`yDWi!x=6j`M-Tx@9|=c@uJE-J`Pc9<7*J2d9XRIyG#cQ~>V1eMy%g9ME9Wb^ zcXnmzCy!+2F=Q;*ukeNj7>-)8uHZ>T6T8*3td;gBZ7H#zL**yYgy;!4VY-N1`S$%t z$=!FY2K#G!)L2d86q|&_*P{x;m(9nj468l@(j#whodbVow4*L;I&M9wJUrxo3GKs zW3r3hjz>rK-tTOt*DeG>xb(!~2bF7X@zP3x9}}Wno$W7RPk($fu;SI{u@JXrnA-VX zJd(43V(1a~gr;f@x|Wp{a+VjtDW>G>YOUzt}paH zZ#-SM;~e->OvtZN3RLhMph6(`p3MI1yvM(SsV)FN!CVH<%(PN%oSmQ}W_?Ox<_5t8F3= zfQbg_AI-E^$}^um005K8#4m@jjw}~yB_-Kxsy=asnHUUzK|ap@FTDhU&xp#M)9KAr zwH7j~#2S+}oRlNhZJ(Z=memHfJZPH>r22BsqiR&4CeHmRWob!cqoDcK6Ms4F`oFMQ z@_K;f86}bIZ5a(zKwWV$Yur612K^Hd9Shqj|^qupEVzqjKk1ZCrZSoMPne@)OZv~NF) zFyAmo64y+nf0%`HoC6Qoq#+U*XyMLyCa)V`$AT&~x>ojAJ1qpTn^ypK;}C>HDbd;U zx0^*t^>=;qA}b%xioWuUQ$5|odSi?AM*O_|x0d4*aFJco&~0F*fFJK8C%UlH3)xB9 zPWRQdw?%OKaF>E>E&Bf!o{BiSTwa{*<%|}t(aOLq>gFYyDkGYR<`qf`6hB=s zNZAhm=wDWN{*I#hyA$WMXR&1i@ghBV2W@p$!Z7n|L%e82d5KcsZxL8a^eSfuvIDNT zbH{!PjgNXXiRMR+@{!p7&aH_fGkG1_-+BLdZvLK^1-NoL1Y)syq!DUh{*c)R)=5b+JjnlJ1pH%Il@+d#!t6U%HX z>?P|%MI_5+C3~P43W|gu*>~qq`@Qg(_jz77;z(6j($$U0zlJd%i@VYGIA|Iq9W({D zhRoKlgeQ5dHe$oCS0=K;_??gr$ByUVRSesee?EuIGyQCr`vzy zUBo~&M=wcuKF6rB2pm@Y!k4C%oZJxdJ#UqAULP4Cwjdiy$!iu~Jg`_85Mvn7HYlX= zNw%Ag4$DW*HX(b7KRLh>N^p8bGW~LCk2uc5x9rz5x|E_&?Q9g!!@wI*kX~jOVpF*E zob1g0wDCj-F~M0r$dpLD|8Q<%7A1m^x&d{?F>D9i8OyZDh~A}1qB$NbZxs-%#dvFB zO%0n?5j>YgVigMN3uXEaUy+(wrl&o=b(cxZqTu*tAx?X$RdQ zwHTj^f$xtP6z=|+-jvWzNQ%Azfvbmv#}D0HyVnw;1R0ggT$L^}t}(8^2XL^ptXw&T zWtbm?D8&70e1LFdrMWwXB&XjjCk@nvOWXfEGWtNp_e9@LZLXkE4+c5DV1!^=aN~!i z*!p=eEEcPsTx7P=9I<^{x&hrYK<0Oz(E0wR(Y1N)X(_%r&iLMoUhnWvJ3InSc3s#? zUUOM+uYZb^PDQturA&gC+U*3#<>cXx1euI5>R9i4zz~$~3>p+58P%nWwzzah#-b7&OpnRf*-*|D=zZVn4&c4<@b5%959QJ!PWcK!``+xr&4!dISI6~?`dFL;VWL9 zHy|AJ=nV)z^iyqHB6maRLZ&Y%b}#Q-zPq^A9}5$F8XDbprXWT^#AM47l++mcvI|I& ze{&MLJv?J*KPWH_7JCpZR(>QJ^id~5KU$=Q%l`iF{u@x_K?@BdnRgJ+;vGc8AU{P- z;z6C}HS5e}erA^jN#=&rXbaymdk>h-@BUG=v>@W`6{}2@4TOzmg@v3x^3D&j)vS=< zJCB;bMxu7{Vk^SSX_4>5`gyl2#=x%zUB8G(5J@r$WPB1YDx~_F;ZF-LbP8J}3!n;^ z0I=dsB5Xa+RF@CJk40Q*mg1xL9Wj<-Mt<=Bm}@Y7hElsOhFU*1I`=&~nU-nYlo=OQ zDmH$y2E)m76+2;O$Ghqz3d$nBza-kLMv1~aY7XE4(= zy4su*At21tcWiEpdMwxKl%cD1?xavQrhqbNlO}cnV;sHz_^jotmhpm1@=6xp1lz$n zV+^0qQ>A%hKMXmO@tPJj`DO>OUj4_(<>%ibEo|oS)OVCCv2iu2eS%43we2q!G+g|u z40GlvcH~{OLYjO9JTjRr;7cq2#sTEp|S;} zuV!#Rw<`v@RM*E{vK|?{cc#s;_Uk{PXC3fKFEl~O4TwVmnQ#NLIAFRa#d-Jcqv@8I z9QO(Mn2Wy={hA3MY!NqGy?P$xvH}lcBJ?v@b>JOcnpJ!Ed8>XlrCE<4>S5@5ZP*I~ z%%}X%WgRTV+G)-JDoOBL0DhBi1Aw7w!1aVd)R1x>P_!KEfE`T;VBpEVezG^9stB(e zP|+uWIBy z$|Sa_r5RI5F(1^0hD!4W^n+^-_s$9pb{Cn@bjad%5ySUIcMZ<=8ULt6zSHrdUiB@> z*E7v$)lQ1F?{;@!e|;ohZMzI3G8lqFp#ny;vxYsRgF;nLv}47Fsl2QnaFwtm1qwp8 zNP!27zXA1?pdJ9vTD5xvQZ#A30M-i}(3w-Mh9XNv<2Tx0>H9q&tAH=_H6aQX9v?Y< zXwG@MBf(yOopF}_(lH_1AMMb^gPy++i*J(gkQGit?lhJJ@m9`+t|vXbO4 zx-DY$=WrF|u>~rz@5#`>4tki7lD%!=E8uhE-nOU-M9yzo{*tdPH1I376)LB1bfot) z^su|nD?T4>FczPRqVI}c@u7Pb5n4G&w(Q(1bHAs?%xH23zK#*(P-oMIS=~76x7cwL zC2Mz?6MEsg^ffTuQCYd^u=XuDS9xggwegUzg*~DoCe1iBNY; zLt|A0lzBU$@1y{lZgr&A@p~xB(7G*-f-Tc><9^uAf`p37dsC|8n)2{C^-S>#$#T!d zUvo=S8>w-U7^{n+Xs%|2XxBa!fWI_tWN&a+fVJyBjvnA?1y{8T6ntolzSn=JG}On{ zGvt+n;Kz3nKs((q3|DE2v^k9`LN0wMBoF^U}4yI57f4?B`IK!OpeT_$u$&I04@5nG=hqp%xL z<*=H$9W`4%j}`8``$5jG+Mz&5LgY$e`q(FHImfV-p)SMQPEm>7Elk^y znxn+d8i3Psw63{m-{LV>G4#7=9mYDH<#78<*l{$FNvdXLXV;Y8ZI}m8L3iTc9iCF9 zYzgW8*?|bo8AmMCj}__<7MB@c2lNljla%Dx+PMDdPky;=R;oVGE5t7Sv62Y1?<2@e z*p@EGo$hkXi8JQqmA>)R1G%$(YP*^IPrviO*#paR6zc!G0s)$kr5Hej0J@~bD(IRq z^S{&~)y!*Kpi8EG+a>$AtdP}xB=4QBZISp{>zPk#2$}-9+a--Rj^^|>6SWbdStT?l z+OVceAC9|N6R9?jzaxbKn`D}aTPDY(51M2g9jQ3`bxcr2i3%pA5p!-nQ-? zy%FJs6+ZqvKB3Y2th0a;HYV{i;ZvFb(H+<5v5|wg1^#r%Wib!SP9NN!X+fcSVR!WW zr24RUH?9{JcRvSfa&~3)Sq6G^k1}?fRVTudM%pNvte8ITkZ?7(w|6#f|6-*tm%GS2 zV3bBesH*SL>h!!aQT`X-`+q%KbK$1QBRXQri=foIto{HS9sFK=@ z;LYdXWU|J0ni_vzLb951eAhuxV^a9Vm{1x^V`ExqEJt$nw;pFupQPU0BGC=#O$=10 z+E{Bv=g+yROG-^WrcyZgcx32DBSWf}Mk0_`&QY<853p^Il(OG|oP^*n0^TTpvW`ujdjmE&8H| zc$ddh`WTyirjl%csF%|gBUbdil=2Cw=tO zHUn~=DgGBY$_OtH2K%#LxXaCsm>&Gp>BXGfkB#ap&2d)^@$N01M~ zBxF1LO&e$f_V|;SUrKF#>{y@swsjs$O03*P$_>WEbd6+-Dv(#9O-Ui&>zd$gPWbwL z4AHYxIoJl)iYiqg-^9{bC_z5^J}Uz6MU^dimo7KGUvdZ!6#JPH3de7tS+MiOZRKc0 zW#<&~C1Gi$I%7QbF&EIhHVI!94sVA<%~mvgAM@icQzPB#v*!dlzYG;HO7swzx|w9z z>L@3w#;S5GzAT+J1Js_itniUVz~Tn<9Rf7aiKRKcMOTWFcpI0ZQk!bS)Hn-l3O+c2 z$net2)bL7vz<$Ay9C+Pq<7d|r%O+{7KgOo^y}YHY;z?;4!9fDvViFfLhErg~AFejb z#NI0}37F?(wUc9<>i4~RX(xCXCU!`BcK`;ac9>Q$_aDAR=$+`F^m;>nnm|78_V1dXklaVUBu||JJkIeuF*V!YL#j^ML%)Xn zUm!M7yR|3x$(}j0^NcK{$M7-VmSaU)jvz*}4?W;T< zZaXD!4uTR|!9@XF8Ft^#3h8u|=*>OgX-^D)zuF zIw$l%QfI}t&(OC;c}LIuqjmapqHm(AeYLpA>rOIEb@jCL8Vh zNimx72o&u&>-c0V7j0}gJ9~@4e1XI<#!uT zVdfywfE2HrJSy`O)syu09-Wurg;|_K?29dCP%~X)m2oon+VnEb`@w z&#{rwAxqrgW8Y5rJ;`^u_7Fy4vDuZuGk(hXc5x@^UBC1;>N|G`)Id}^SlNydnEllY5OwGPLTky*K zthl+ePQvhVO3>Op`8&d>zTP=fJ?_HL?(tO7x^O|?tKYRy`4$gwgCG5oZumVjLHed- z3M#5%7IXW6eO~?V?vnyzc~w%Xnb9R!BfVd5wU|&_&GQC9z|EbQdt)WXL z;NuW@1k<@H(5f1_r+2{*kYg$+(baH-Hq(X7VprT1yYmfb>x2D9L&$3WE?Pc$XaI~9 z>_uzr11<7?)47LcU{m$5|;?JV(^Yh9JJLxg!%4*Q(@82I`WSK|jtgoI2T$iCp zt^kMJK9a$=kAY~lYDDxDuDq)d$_$f_o-@?9O*CX}Q_%4+K;?6Bmo?=F?oi(Ye`P{) zS+`*T`Kk&q8(Q`vOx5Sr-d0D%an>t~M71#kl?tU4?~U8-UE}$UJ~%#d&0{AHhVVWU z?TH2t4WWU^6SD$b*o2~vl&MYCYs6;kGI(vF_49sBsNG4xSq9x!+|FGz$-^5^k_Hm! z37K0?q2pWpQ*S`n0NX9N1^ok3SG;Gv44cVZP5t2BBDiut{8SEsuFbV?)oFfOSlIjs z!{x2TU7RjKnb5=seqE-^V{epLkcViJ`>~vGOL$29oYJ~Hny--%`D^$sgq;B)4(mUR z%|Y0S_K;wq`k<l3Q_;p^_}0_f5h36kBZ=dtEtcMhh<5UC%3LkoYir>9nL z={7&HXpOT8XVXAdmVdQb((wazDtOu=lCu{@7jvZxtcGMWhVRjzj;7k2E=c&SeO zf&Ap3SwGcvO`}Xb9$H>)p#+J2tBVwEN7w+#%)^1I@J9M#WXhI$T>f`8B&^{enJ z&Wu!adX3$M^?C9QC?ug3C~@0Gz&0>)bPv1=)^231*0De`>9{;0OjFBL_48fnPl=Z$ zYP8*i9V(;M7%Wvzt^)1y6#jrZ;XzqUoL&5Q&-}!`Jzwpo${sqLpx@O zo{w5i>miTY6Y&9a=8byj6f)b3qF`RZO?CR>U3aLRDUVpI$H=nv zoQ%X7sO)i}&R$+4uzdK5IqvP-pmma~s4FpOKc*iY0M`f%0nPDs7$Eb~B-4i`J^)Nz zN~RSJb3cD?jD(m>yyeZ0s9NgdXq1n)Ubj*TdusVic%3UTjJDv>=|=sAkzr06Kw!kK#`n!D6)hbkOMG#HVNCU!U(5u@}8$2^K&XVE88xz=M^ti8+e(`$Vh}I zjMWbF)C2L%pq$czz#2_L>lgPfj=&~J{v)p?XqdYb8Pf66So-ppQRb+oO{s8YM?-AROr!FEPy zbVA>g>g-ds%@1n>&O#>U(&KmZL#2lB#gwy_DVd}l`Wi1?0E;F8Zj_5mLK7Gvu)4^+ zqdKS-faY(g6I*(2_qlz2)0JkX*45-9g)hkgdTYp}7Ig(}?}H)?`0jh>cR{J3OG!!I zRKFPbUXBY{K}e&vi8?P_W_Ge>FC=gcQ1G))xChO8Q%ne}dQ|3O4*-N|Q31@rf<(O& zTL6ZkwtZRzxD}j4fBdhfqS|NOPP59w|5+1#8Koj6)6^y^UNMO6f-TPoaf36n&#;a9; z-B^6fqXf!TfV&P*oSje*WtjH)UxF#lzl0Y`$K&w$Z@Gl9)?%y_3*#o^>GV;Gv z*dndfzZD)pZJhdFC1L@-k^){Fe)t4nfYJJ_PnE0PWp@vDPGwN_u!^ zji@!bNNk9ZV zuv(md)PIc&1_(E{;9y-ST{B^-&;8`t?nIimZ1bThbl5%m7L?8c1qeF&KqX)g!}}+H zxja)lfA$2A6uP8&5EF-;*H)bDakAPrynR3P3;GKPpRRj;lTAwb(Kai1`c9f(N%FC= z*)JyI6Cdw>*B>rrN1rbIviAc@PXmf`(ZApzA?SNXMn=}jRU(+lbJ`69{wQ~5HkLh5 z?=QDL#z2fECOWW#o9#Q%aB0#bWM);1_3aPX~=wy?TgTmp9=@yalg9>{-0Xp-#G|?JWWh${`3=fJ?MJ6 zt#sePNUJfne?%$U>P{p$B5eudOgIOkkM4yKL6@H*VN~@2pQmlO&l@plNO(OvJ}Dge zZ3aI{lalkWr13lQPJ5Hv{0TmY`dH-Zsi&~R)LDTgi^M?~E(~c~#!7Jw&n+qz_?=KL z@@qcde0*Hw>{6q*42zY7lzCru&&Ea9X5IZH@0p(B!@GK1a;_0dvx${)Epy#~=HLtW zBeg}Gx8Hz9Yf~4cB@DaAofUYISS1hj87D5p%#;L%bK1^eBhBiA5BE7O)BGPQJ(k=r zo`Z{c(})=DZA!jCb5iaeK&JU1sY=Mr>ts>tGpVQEks+b;GzPMy!}0e5eI2E15i`I} zlsvdRcqvDk8-bn&Ew_{ESa_%0Q~%*qm*DmU@mrma+$<$w=^Qt1i4+S==z%ABI+$4n~u9TB@Jn z=tsLjKBSzs3RzQZeUX+8MRKw%R(yeNe1xALT}%bO=GXLa@l%POtavAs^T+9(U)GoA zMz!AnY|1Vg#{@wt_%2`B#M!*PFI8{I| zniSy`vxky}dFx6M-~Im6Som$?GIPw`@4Y3Gd6Kzn@@lHw$gsSIBYiH9EKBK3BIVvQ zHy~92wk8Dc2K;0~yyTm4>IP#6NO+rf`)m|{MV2|Z;-Av_(o{??7;#IO#!l(g{bE^k z>jG|{(d6`J~5`%=PR#{6Z;@~5hDfo_&> z;S3$$N!%b03ch9$XNML3reEAa>z?L)#LeRB|Kjz=p9c!mjR=67iWHk#2BXLq&tE}j ztj`M(0C!AM!7_J8aA>))=B}@}N=xBtZP)n;UHNzOAlGBX_qgC@Q&r3$1Q2Z76@gi2 z!iKin*8pihq#bq_S=8C4M_V&{4$Gf2njuoSQa;B2c(kA3#E6-s#{Mbnlk>n52s085 zz1=^&QVc%Y0t1`$vRs>#-7*%8P`v|CbuhwY2>JNW9 z-0Y`;jO&(Ueo0Lup@-%o^{G7i{C#s}{EM~jIS3^_q&RE^Z%-DnDSMp`w^JijS%rpY z5aLd~f{$j1)qZ+9PdO|0!i^&MnAPE1S#zb3jnWB|4Uq0~eTaG3F}~Ooe(1MQ}jUfmAsev;dT9wU(!xzEmBC>rYxEO z=zZZmMBSEl!ANG!>r6C;cK`&#PY`ZeKjiTwRd*s!fjG)#Jz!^+C#dPptZ|p$XyrqN zlLyC=IX>z7%g3*zINiF9FG4cGU!cf`qNw}D=eIXALH7kPBk_)YcQSHM);gGXPx+t( zw?xhbepl3-Q&E-0PKg3qLSnZT80wjF5y3*Tad=*V%+E!+Ul;oM9+h`gsyP)R%T3@D z4rWaR)xDJChg>|lG~;4KVY35*!xkG(er2^cWobleiIFZ zFQpse?HQDNi}oBNGnJ7pcp-(~Bd1hE9{W;#b6^rvki5{D&ZR$L8wk;k z$)?Da9f|TBQO$|jSuGyiJ=qU$LiH6M)aj<-n-g2TeE`|mgZAd$fP62t3BGLFo#+qu zacCuG=-Jx?i{lJmiUdr@kc1MLBQ})R%H7B2oerx^nBHB#KWV9kEjxUz*bGcD`fhFE z?xjDI+;OF=iiOp` zeJKZm78cO&1T+QilO`kz1`R@Kugw3F&{N3!58Jo5xa}H^X>@cl{=_#nksZeJKBAE> zO8RyC;Ry#%Cw#bv8zM5uaMvV4WmWY6zIbE~ze+o>b>K6>#NX{qMM?l0eH{5W!+(zX zFPH7hJKOt$^f@xmfsX=^%yD-wx~UF$s0#P`wc8Hs z{LMuGer6^uGux(04xSC~eCuij;+x#z0_J-v-%*}QEC_MIa+RcqfTQ>Q^4HA-S)d{s zzQ@>gDsP?k2^9$l9fjcOz>ZZs{Vsx~jIB>4HLR@60(;)qJ~<0n{s1Xgc3MWFZv9bi zBZ}3Es7v*7bkjJ32y4H9Yq;&$xVkCws1+hBAWQIsx}EWaD#p@UFT&;51N?6^crEWQ zh|9b0;4+RLgu{A4ubZ!eF@`#Y&;%}%LRdw9_mzE}rlvuntoWKcwGwNwwT2U8M)C$8 zt38j6d__6wc6`6EbQt4&{t#!1_W|`F!qa7;z123mvC@ZG9BwO8wzQre4Qd|!H~oj? z|5_2`iPB&e4XK?>x{cR*s=frfg{r~34>WH#soi5W2t4eA=fmg0Opu<{@N<>m_r*kcG~1{$Bs);{dmui>V3uvKSX1{Q;> z6CZ@cAX$7MY+J$2A^bC%LS|GQCIW)%eo}$7)k>TQ?nKqH`E(j@N8T}31}4bF&HDO$ z=M=nGui3(qyQUA$k?kSfPiG0)D>K&IfX)j1xeKuZ`j8`nVed`41_+(I*&47~BlQJ3 zXaQ^zfeZii#R=6|QXQSs`5z=Y}l61_iI`6j{EXXA3 zYm9qvPwIZjrVKfA7}mkL^&{^i?N`GMVJw*V1;IJ$fFK`LeYx$3D;zhXWp%sX=a$MJ zCn5+T%Of{{3y8m?Kq@}|{93pC^s8M3KWv94?(t5=A>--?9B6p;ggv^s8jS(pE-PY@(3#-T;} z;+*5Q;~W>Hq~ESF9LB2^zQaim@ob3lob=Y%A3-w zG9=E!`Wq%-h{t?agAMh4&Hc>lt5qGGg@`C4?01};kYu~3`}&ohJh_C7&@cGTp=F8C znR;+^gPXnl#?RRv)qI7WMmj3O~o==or@FuQ@y z?Y0Pt`)!GzCDt#ATO0_znL0>BNFAc52|iP6JXzT=Li;Pbrgv}7+1A@tV~>1{n&Raw z=-?ifRf7q}glzuBz3*o(lc3Qvq+t=WVU$;}pf$yHb)+$me6nLe5apz7rqB^=R-&f- zBL8A}87Wx@ski{;co=9j*oGCQ8bwKD>EdeYk-Si6AFvqMnLd^dtGzB&5bPq83YiL- zc-PrKk<8p4NjCPEM!~>9m&OyIfWZAMktho5G4B3l z7SE)&5gbIgF^DBiw%mGf-@)z5fCnz%CO!HJq8z+doc?PhAFpwGi7#%~JoWjIdr4+K z46Q1v_z8U3B2(3<#u{+vo;vqYCY?j6+lqHVM&i2=ylBL6W$GH?=CNLo$R(zV{xS#Y zirTRX_4r}sg&51-4N>s0VI1kBZ7EkYStX^KpMr(E2KdVhTS>ZFM_c+j28x5evBq~b z8yJ(|XLv5{GtO7&XW_m&HZz8sZ~tnOPZrwSC2&I2Cb*QF+yHN%F(9-r^#7s)uqAfM z?o=S?@FAvH`{;LS;(1y^9n*)e>lz<)J=DAR;qg-MmGoP0K2in}8cs;mAq1O6|CIAC zwhPyo05lD~yxpWEOtVn`yIX{wnxjL;TSp->4=z#9Kyq^q-Tknwtv=Sb$74s3*7RvZ#Km_k_0m$k2@1&l$!|%<4kEH?&rB_V<2)Y>71>T4(KhkZ= z_}3yBGxcXz{jqS%dsfz>{Oya9==wMa{kFUM%)#le#l;?uks*n4Mn-MVpZEFB4xu-Z zZ{1>$j2Z&|C8#HbTnf!=2a3<9>s5nwhL|78-6>2zrq$+&8s{_SFTLW2`B{*ut3WyK z{jY7{Uxv}Era-PoF{^(7?{sh(<^;!t|FsSw-}#4(vEF%>Q^AZbbJfgN z$no{X3SUa=WUTudbhaXc9Ot}^yVNAG`pikKg092v_tm(LZ;R<3|5QF>(W_$JF3n*x zYz}}LKAZI=%kLP&4D2%#9{QJcWl|u;2-iqDbRlM;g zVNQZn+aK6SBzG|s#uo-J-!SXbgjASTHH#!E(3V~>UG z{z3#MD+-@HI~b%}_$JAtCjE1z{k!?wg!v>j(_54o_CpMd#NBG;jhXj%JsMu+!cUW^ z`|)Ea-EX)4?GE2T6vJ=A2mc}CB&py94Dm^8{&j=i`eHaq74(VmjD+{^zUg0e)xE{X z4vqKt@6k1{as9$3?b~8kQAbHI-Zg2?c}q(WpLL&ofz#cUuHfP&wc3hi{=>dQ0S%Kx zwV4+!fv9f8-eEEh?e+QX!`IFR-zszsCTl^JNS_CuiFa6vvXbA10=PHQC8+{QbXk1k`z zfi8VU)nb?e+livvx~nom-o#$XFw=!>BYA>Yf+_R3=F9YbL3`7nww9gU!=gYsOZ_V8;M@3rpqx%87nz`lPf22(6c!6e`Xc|9=-QOhfY}p zDUw~%8rLb{COT%!O;XRlZk!eimLGrLR=;-pOWHg{JhiK=BlP~*f9#RkO~J2Sa}zV3 zR7z?la##O_WZcOI;8)kk#AMF+|MsPYdrwm_RXQ-Dz~7+wIral7w&5<8p7s9! zA@%43b}@thpkA`bm&zko?f!k!fFddE2=XQPu_i>94A>s`{Mz>F~duw98!pUncj-=pE$%;3&_}R=k+f|34s~-241xSKlS1#3$LD z*~IF;SAE!z2LOF@OGpeP!F^|yTS_ioN}gB4WQ2#Of8-YV^jEkk=0_{A3iBG+HEb`4 zzC#)x(r<2M#BDV=iTZr+TG+cjaTnthGlkdcoolC+w3BhAkzWPczg#GOPLv+ro5>UOYeDFt-|H9-a5miPi$GGe7NiuolP@}V zGW##CDHQm;Zmsk-*MCe#F051|%&ATm^98?=M$U>a!t`{`tul4oa@3%l>T#QPWm6E7 zHIq5fxujpd|NQGqTaj2S-s)~V#@r1BsEF>JLyA_fzW(m9m%yQbeUcTGHJP1}z22C4 z2rnabh0tn8lDNmQ*Dvn6$^QlW_QFP7sKvhV8E~F6Pbt|nv0~W|va#}{TQJ+^$qFI+ zs);K#5wgB9CZx;IF-7*jx}AfMDU0A$uy@$XER6VC+Mm(_iUwzHlj^Agjw^4(H@jIF zG=E>;e~Ib%g4n9w2zW6fD)G}(cOxY*)h5zB#;5tmsj5cujU>8_-+Z*)$biQN1=hf5 zd$MFy+`C4w8So8+&~HL@;XgxoD@k z!Fx$4;*T4+Jj3o6zrZQSu!RmvW?CEG1w%jR<~Gj$u;hReg~;>pXkcoeT2BhBdb}Ipi-O1Qz%N z|C^+>@puu{PLZcM=7S60LJGXb?hhs9L-r%Vw{cRvx(2|jxgf9cfvZ>MI*M$FewdrdUAVf9Lf)DD=tjcVZ8 zqacC_+eJL>6)h>M<+=@)Pvl)3W9DDqkX%TUtK^3rjQF~ho#^qrT?xw>j806;=jSKG zXD@Qhmv{o~yH{hl=DKq^7w|og{w_$TIKF9($P|4^szvJD5M* zG0&hoDxnrP-joSOYl`*hh;1+Nh1_*ME9Z3zz)|j=S(iPuUnP<6ZIzy}Ob!^<;@5${ zvxcZ&Cd0Y=Fh{7TD#hP&tVxY=Bayb}wgZRe4P+0S2-U!4el%o34{c0*hA$1SxKAi| zNt%Dxxe*}4r07dH$iR)sx{IG8aXI)@Kp@wH68fp4`P{AkHjew*^{e9XI>T2uMEQKz zFpCCM6z1rI0nDX1m_cTu2laj9l<%W1a_Y=&1|%Qb*`M}yWor&v139=N(v4tAx`9u5 z=fG8f8exnJNTRtTlAn__4#{c+=jGNbb_FHH!>>?kODt3-cLeFY|ND07IzC#E4Cu?) zPQ<%YBYLCw@(PZK&Yz}p!`!sKZ!~702M^Y-pMgoqO$yLLsQD^BZtkHST$D#K;zAzxxwJi zUkc!U5R>$awrdoDFGjJcU6}nyGn&#zp~M=Q?lF~6j*k@+_LR+tvF}Uz$HTJP%7`(1 z(yg+L*P9V#Q})Z=A#=t%HEsPIKg7y4;E?JIPGDMqns61yMCI_x zj8tDz-Gt{?gmh`O8J*jx0bTou4z0xQe!cfeZG3<9%ehJ9HSGQriNrHr+FxIo&=bk#($b(f+$b?xs8E(ZV3Wd9F^6dIO`WF8`wg1N#< z{%5?RKv61wYjK*dKNpz50MO8X(Iu2s@bMq!>qqZ<+(S^erog8^R4(!ORA43QZNNOm6O_&X?G6ObI!Niq6G&_=JM%2%CH-Zmk#s5xYAhBok z*YU_FSoqiE5uZXE&7iA4sUHfp#qmeoFi8`-uXJm@X%CvWA`J8(3jDWh@DX0vq^Ecb z%#jYZzHbW`jlI^9<|n`J7ZmGY&m6SrpoyXVnW z_+*X-egp-j!Ox*ZqSTzfE!5A}mOT8v(B~B*RXLZc$@Be(?bmNE@p)9gEy(#@jz^`t zNX+;nf*f9;FK{I}f4ikIzC+fD%XD)&tx$on&rTt?u&Uu96FF-+L@tTv;l_iX_lM-M zaimEQlbZ$~ehYQjEU1!6d^l5g>1>W{xjC2MS0Xov z#1#0`8#Gl-8yht&VCHoOAfYe1JY!$K%`vmHZDZ<9UV}D>9JqLi^h$rYIO zLUqJ5xdiDnI&;fU3%2E;zSTB5yzHx!X?aAMUfq(eU!-v!4SRaoM0CNDcdH;Hyg^j{ z#$74+G_`gwL(IX4hQ@_VcBU4HU|>2dop6GKX2UFi+rZN*O7{~BSL`J zP8W|2sl>ZIunM8s&SjDyjo7_Tm)X6$AcS3p&vv{>9aZ9f`?V^q#$f*h8rs2z6-KPB zGViQNPY5zXcg&xySSdg2di%aNx!R0^M>ag{ZqVF(%j&@ameLyERRMEu#FRvOw|n(2 z@KxkH9lUb(VezY|(3bGam@KdcUs(P9+4Zqpvzm~9{igS>XNot-s?C=1&JISUzmH7} z$^D0nj`$9%9S)F1TG!sDxi~C9;t_IXBlCq8bU!^EuWxkTwo5iN?U*LLeBcee=dE&q_?;W2yhj#S1mZi6?JXM7nMu1XHlj4->+2KcE1KUfUa8a`b{~RAKK-h zwbHfKEtXPxFLg(QYuAnzd-@m5L*?9}KrBQ~6gVc`hAV2nMQ%mBwxzjw>fl~(O^XWJ_drfcKHs@4(!Ex{1BmOI!I*f@ryl#C+3V#|jVjqIFLJPNhU|LRWFeaHA1;zi6 zb+=D}Ybz@>7QgqrQd4x}O{+6rtTA{3J7(m+PD!zKvI1Q!!^OBIUDzL}+kaoQ#3wzB zws8E|og z7-WxI)arFLP*CBn4c~-3osIbA^~r#Gk(RngA1!pAWw{T_bX?PR&XxIHO%BRJHqLb( zQIf`1>(3K4ZsHlUy%VI4Mc=J|+RTeQUJ+q4h-w6x5&=8OzC44{U=((;yT9`_NZS& z8Y|LE&+e3?hD}&p-MyGunwx8swS~>G-+Ys<)qmaMcWRJ*R*7m2HPS6YVt{LMOP++1wza9%k}dapr+za%(phcJ?a zRxS6ybmb%_5If$6`z&V|v_HyrJ#1y%Ow6^|kY)GST20GMMp?7It%&$@0_?U&07vDp z;QiL!A~XPVGn{S;u;rc-4qQhJGci`wn@v;)Hw$R(nVxREmYHqRhv2p@^WWkR@<Rc)*mOwB|(^R9mM?1)-i!v(0heKu7eJ6*P zR}WGNraQj5>`40|I6q#xTNdxT+Py-9*FaPM)I2Y=W&LtFS(8U| z97|ls*AndT2()=9qJz`lzMGE?!^IX(u?DP(rp%+B`AD2OVSB#`hs_#>2sNj|cXT))&V=1cG}c zS+6I2Us(RVtdCxfWc*{3ZA<``Ow?&XFK*6V>Yw_}0l zWtL8o&wVOcIl#kE&e-^6i^e?dwRM=IWacyF)h1DD(^y*%^}WtO0Ho1z9T=Y~NOauY z>9_&dYhb2|z0U2N^7?K%jnh%{>;_B>`6vx26C<3BRyP=U^11B^o2ox_y{0DPLR5)i|g?bLe9tD`9$zK0CjEZ30g(9J zL%CL9UT<}hSh0wxvuuM^i}cmr^z+oee!de!6mFn-H%X7^O^=i7dj{CtgI`#`zRZ#j z=K520(3^O_F0Nk7KdGp8u3r`2h3zpjy)`A7Q)2_JlgDGn6mLy^C|L_iS<1VAUS7wZ zm3&aUh84#lFH6p(X?OU<=7<7VGRHvuhGwS>9H3!XSg6dGk`k)RIQQ&W^wEinG!;r* zT1(RS1?Pl`Usl7pVC?t`guk;sCb1q3jh%q0&Vf-}4RHo_Z8bTnoavh`{F)T(j742Z zGT+T_wT2BOCBVQ0H=^kTNeX|CE;{^D;DkdmyH!dPAEOQ)ELfa659FW@)1GR0{>-O- zV@p$xHlawm8~N@egySDF=kZu1yB%gTt=x={;g=dnv}poZ@nfO1$XxeBp`d8f!gOO* zC0e@_bC3Az9%>`p?jhA1;VX_OL+ZRqd=?snwqgjis zea_zUA0qX>6eWC;3wybDckm@Ot;RIo76U~k#UfuFeaPh@Lg|q4^5an}bXdO9LOjD3 z{Kspo`cbx@=MB_;`Alz0=a+!ccL$GL{vpd*I480=11_29cRs;d<2^ZSzlc!8g1&v3 zKhj`oh1U}&{y}EE!&X(3`DdH1P#dGp(q@PKGWvr3AQ+p~EsE)Pqgd+6Um*&|9`dr` ze!Vc*3kp&{U3FYJOu2ea&o}ePn0>e_@p-+GxO?^4Ku<+T58u_xc%m`k-8cYip>xi; zH%ANxMc#@tnye6+^j_4SDnuq%c#lh17RGnp5|(AWzi?$pBad*E_!h(7?}op#+C9$h zsBwL&O`uHkRmJ0S?Sg}FePo(<7R~}ym3U|N=jTCPCS^{J&|!uxFbCcZw~IZGRMSNh z;@ocd+pKqYD7IT`8)JO>z8*VV-H|o33JR%GK_^0!B#Xb@n zKs2#MCUBj{v{9nK^iH6g2X*Rt585!e)azLupoKFf3E{|qysLVj7br!}_YeNOI%kI3 z!-qns_`}g|J-PF(>#LC@CVyW#n}sfUIvV4t(WBUUDg=s&I$=HxZKc;dQ6>R(2z~s~ zl!3t+=qsSM26EYf^9Z_*{LsQ$|8>EwSKNwQUrX;pa&e4=v_O0GV$I<9@<}c7BkgOR zWR%Hgq-3C=0OQ9C@Nqq0#v?V+wM*lE5~tO36juN6^Rd%Zmm?^Z#hgiEhvv0}$k(bu zykU$cr=Xa&RxetA9TZ_hi9ryVQ+q9UcN$Wh1MU0o8oy&8Vp&^^Uo!cq+?MZ z@kVUT)Jc-XT7*Z}+z0s+5?B5q8=o!xu3zS4&Q;NAn)1gyEo|eCR9`fw;JQen^L7w) zAp;!-A4wp9v|LiVQ~ck-h8rYbb)e(o${vb&?swX=$5Hwb^!SGhm+~oC0U!Syl*CA=X;{OOS0vz#bQeFpvkL_&5Fz+1l-qAa z50Zw&)c+pTa$Q%Kv^@9(rD>PG$Xk)pGr*RahpdhDN$|K?adpcw0dwRctd*~XrRMEyh7 zXrH9UyOzM-#V3Y|`T%q7VEfR8B8)TcMD89vN%|QO_E6CHflz{7h|KF23$&5a{fb*b zK89)~+crg*#kGw6Wi)ibwl~xKeO-3oT#p6_li2*tk#wuUYGz7kuF`vFR$`Dwsexdh z-uY3ANj;@h+Z%ivkLWkgWes^H&FMdOVlY`}ArFbw07<$O%mWxP%)!JNAanI`xmxZa zy4c*1_`H@+7mi^$Fi|nbG^rlPK{7@_^{97;^)P2I>!*UZ%J;OEm{#pF{a@H zl|LhHxc7wB;D^vb^zYCAAtTERo8G>NY<5Ib3*P}YA-jU_99wmM!)1=4UWNp%UEH-3B<^DUiDnTou zqMl);O8kB-4Y+c?(nSadY&=h!|9#8;_QQJ&GAR%_(@dv9Lv60No%0NxXGf;n`OS+G z>7f5xJLe7Fd#nICOE?2i?h`u7tV;i78LYOO1B5t(2?oWyrTS~?g8pOA(B=OQk;H%@ zlHtHwxfB#|KSA1O`3-51eBA{~L+_{}&Mf;p7()_%3iU{l6@_x(QI@ z3eV-YQ}LwVzexPfQW=U0>5|2eE4R|y$Oj+2BK>~z@tkV0+UDQh?LOWzQr#H+r-({2 z_0^lv@Wh0B(rTcV<^laqK7F{0gC9v`=71mXQv?uO?WWycf3(`#aE|9ljwbsWx?z5L z1p}b!R55X=*^ITa5C%t&uA;?qgYI4FOoN){E43M(KmB(DZxF|o@-DNryd8FTpImq+ zxgjABFBLI*u~3k`zr>cZM}$O8Si;8S7D7__Y-fa3`fx~Onn=7vs#&3-Z2rRosIhQo z5B128IWW=_Re`0S*A-m`g_TH09_{VUXaXd3mFpJL$k$P zrSrBMV@TIy;x&iu4sOiZ<(4(@qNRw#0&QRA0;lkIyg0!b@cJPVktn)ZfRFUh`Cv|}`Zix@_YfIL@CkwBe+fMtb&?uvj7070q z#%Zb8wbITlK9T6|KOm2S*57QzhIEI}+hL*I&Y$z0CF;>~S1n+b-~dLKK?U1Cv{7QZ z6s%pu_ZaBFYIFxHKAEz&Z1HcsUcHdL)fdj*s%Gx>jqC#Q&Bf3{T3TB3_RxVlWd#MX z_ufT?RmX|uefVUuzbU?~bl~H=*ic#~&~aG;C%1v|V&fYxOzi4-pVp<zasoRmSQd(!`qFSqm(~V1vXG%7^Sv z^0V)#B7_464t%ic8n<9iUBvZ1=@xI7;{2a{96nZ*9i-Yzjo?X+ps*G0ux=uOih}8E z2|`5p^ewCCI;PkjrF4G**I?5^3b^UcGk7&o`_pT)byiXJtqmT6M*V%( z9NxELFR7|8LyJzPclm^`YoJw)xG};;;3ucN(zqLVAG-cah&i$;iSR=po)n}X_#8@q zFFYMw;uoEK?TfA54W@|0xi@RN8UP;rS2vBWq&vNj!NEl(~&E2$jpsflm0?W=6ttML}yV{pUJs z`!8J5zwiWlN#7c(d(7}s%a5|ted&-wQ5n%?A(-OGW%0aLMli)wS6x?rJ4a-e=!j|; z+gdxj{D&;N*aFI(B&=Y;e^2ZalR!MNyzt|d1+SEQ@d15s`2iklwMmn2sKL_yS<<;x zfJ4UMslQd^s|VySPr+zEMk7`C$$3j00ch!_2W+FYs52@ILEU z?MS0PE|x31{*te%BPZTER!Z3?-%1psc&+tO+|D;OIdy)dsxm3lY3P3wQxLzBfU9ry z5|T3Hr6WnspP*Og#<=2t1erX&H0v>rd)64NU@dzQuy%b6ZDo!2w|%>$Hq*&@FP@${@_^yxX7t+EtCv~r zVOzuA<~!pNZ5F@>5sm+a4$xrS)wte_H!WV)maw#sUo~%=c72)6@EK}S=Q%shQhv3m zA(21gJuM3}RD!5@nF_y0w469Ya`^&~haq?Ew@_IDSU0sS|kH=IU zrGDb(M8!2_seQ?}?N41}SDag;Q#`+gS@Q2*q4>(E+qDY(yEE1^zX_Ydp+&-g#TN)Ec3?tnYz8!MG9XN;Xh+5XuZ!3sz3BP zWHy@@2oP3{F>7G0H~tF)at5%5Q6W|K2hv#WN0>kDC>LpiM_9N)+%;Tv@$+Tqdx1w> zG|pw8i`^&1`58X@UNcFNF|SJsTj8#|OzsfDAN5@r_W=D5YJB7UU->DzLfQ?9yS$Kt zk9C?K-aSqKwb7Dp^w~&uzDR%ZSu@s-_3V8AHU@z@?@wCr)51{psVe)>-LM9~Xm4(a zeA^gckX^6>eUxwV_Y>#Kr^$=_9Ut({m{pwNWr+qKOlw+AX06>AwF%HW6&0GVSNS+f zpZ2IR^;a)g3u0WEtldPZbv2ie?#HHD*)v_W$GHDeE?JlGaVWn8qR1NbCQ)~;yjMjr zmNY9j1Pt@C_GKl^IUm2?sa~SbHuv?E6`zNx6L{bgBz}ChVpsdUhYu@z3VP7gvwE%1 zD-KTQ519T+*|(&aHpbp_6O&oxPm^FlH5GpA-WoA6pXcMb%pgg_RPZI33jokyu8;M} zh?UoQHRW=9MzT`w!01gHxrJVUt@{v-!sg8iF_nTc9&vJ0xsZ89z&}0W#zK67_d*3p zg1Rr>wkl+MgNz!&#`V7RrWVygg55#G3G5@fZ#;P$N_~?%MQVe?wgyei0ZJBdfN0>! z(b`cROuHA1ZF4XS3Plw;F6&;d6lkA^z+-N!QG3B^9U4HJ3@duBaM$@8z`|jJPe7?) zGG+Llz6+lZ4H|qcdg>-S3zfOwhivavJ!Y4&Skf1~-%Q;+Ep^PUnkee2(d7+m^g17y zESsCp1nqMY^!;m}U=GWQ9N9!gV)t(r75rY>ZSiTy3wBPY5o9xdA=DFdBlix~i3sL; zB{^z!zX)4`c8gf;Z(+?&NdE-T9OmPE%683EOgxw4T_c%;)ij)iH%}B?shj;6o8E3w zLtnONc;>e=qX)W^qCw;x{JX2vB+(s2;ob$$pOxd8`40nYCke zOQMy9uRh1{V6JK(fAYs+CsSo#nu3%3{{p%I1TF_m3Y#|9h5S%fh`&ywn#7?{oM}^G z?|H7+aVtgj#K}w#D&H&Vc8d-BV}K8%_$rP~70CpC1zIpiC5Bh*tq4z+3qfe|8>+A8 zmN_m&%*4JCSMRGY`dQl_{j*F!_FBSc@ial;+enkkV+e)fMQ{K&nsm!ia!b z>@7u=$Ju|%N-S2P53ZZ8)iyUJq913FEEsaz2j^SmcR*J{ULLU$U*j3E^yrA?(c-L9 zf0KniJA1#<-xi8FuEe;)w!~eBjmF>K_GKvmR=L=r+OtyKQ%XTN%mlZ(7qw0-+XHbD z<*??&d*j`I_dEC&eh;CY4-6#1y=)n7UO|;3ymRvloRY9DMjAgFmRGOuec=zm@m}V)*{!uxqJ?uyb{Z^2V)6s(T1O$zr@Xf-A9>Z+eo*w2;oakB7)j`4 z=)Gnq(hV1fiQ?a59-`SwF$i>emT)q{VTwcQ;Eh-xk0;d|iNta$vEe6Gx56|_-JQ+Y z)o`%{`+*P&7acpVIQ~6Bg8X!#}E#8(qeQI9!UaQ$}`NTiTXEM#Jp5^z$VY(^D;1wT0IZ*EWph z%PI{&B}=isr@S6BnTDe&*o+lFv&HFNMifQiS}{l6^a};rHEmO8!6G&-E*f)Yk&Z^z z;HNog8IQ{>&$o@8(qTn_5T2k)C3gp*^;NoF->63~ zQZJu1UPk^D^S3f@y6WixEsZUI$$V9dhR6TGv2 zz%^5(=m{tk9*G%j=o~T&X^-$Rwr`jX8mg))AW15ej-;Lr%EAwUVw$oj)C0Qf65N6=b zMeKJnks@WXPn-YwJwJ$rdk^sSR0#akS>*UHXPRD&5At*MTY=2z+@{+kkl47UzV1Kv zZ-UmBjLm;@>C}2th!Z4}ir+V8{x@=f5nxNuJ^8<52j1V>09cbX=lf-A;G_kXiDi+xR}qd81Vf^zW3PBXu@m*CwdF{XEVZ`jJ5bv6ak+Z5Jid{jLmIUa##5vD zJ9PuTS+@qqo`(AG@@Mf#g!*;ThneTmoT!QP*{oisvKKwyK|ldi?$#-E(rbH$Hd8!K z$@sk4?oDB{4-U5IcMh5lu_M&f)`ln^CfX8!7~9Dn$(39W-p#@Umg>9y8xJ0eiw@q3 z2h@^Wr9cYyS0BE}j)T_25SD&@)q-;{;O4w^!IpJ}%(rZOSJN!MrPp+<2;t~tzY@${ zupYYdJ`^#A1lUbMsVMq5FiHTk!3|UWp?vp1nc+!*gU&9c_uc^KAc6w#h$Vl4w_8^Q zbNk!qXRuYA^c%1}A74#qA(kttdCYxBEL$m)K%^-URojrQ>`q|YV{2}=EQ*5g@RMsP z3LBt5^cpXY9{3R?NHeH5J9@?@Ukd|SU0cj9CY7M)jIDia+ZC z3hNp1m6JI437hEGGh_eW$Yaw*N!MCr&LCH~GUQ<{JzT_J1YMaXT)P&BtnZ_5qVrn=59L#WyJpJ9* zK&JcP;`BYtBF-J}WG-%3{5zrdE2pc_tHj^Z;_G~!zJ>!EihaN(Ec2)z%mqQ~8=sqP z)B2`&ZoZ1I-YQ}6{NnsM_ zaHjbo`JFOwYu07@r5Jm{y3(tM_X7tyA@q3iz7Q^=I0_NllIlR>M$Slnn?{(t>3Vm3 zMPN(7mC{V)hKB15;Rtm^<c4~BT^SxaVpM}YIfu{yq8jI5%TttIu??pG3Wuo4cbkW4O_Q*dMV^pUJPk7G(*|&gH zFM}czOXF76ZT5HnC={}1mD_6fA|l}!;^^%68v+skB!F4frn&-Z|-)5k6q5g`sP0hq3l8;YOkTw&u!?j5ZGxHbS4z zZFwiFh4_2yJ^Htu185iGK3#TT#{1|g=ixtbpho?MMrZb32(7=t5$Y#f-Y>V;(`f|_ zRnzO&HD%uXIxKvYDNoJ3$e*(K`DVddM_B>P`!WK~MpVQ@F(=)ttS|`X!a9)7UT03a zvK+Dhx}zg#`|zM35;yv`?r!d?UdHkKeN}A{%v&fhuF6-+fwU-{l^kT_ZW^CYLK7v| zL2*!?0&Ecw^0t3im-Jo{&Iug!ADj-+&g>~GyIuM9dS!F=t<4G4F*(XYX2&FL_rkf} z9Ew?QKu{89fhTld6fHNkLqXda4e2#10eAx4w2>amn zwEzM_)a)AbIeD*&W#d5x;Vyi_w{ZbR`oC&B%dn`sc5e?zODHAM2uez)#E3{s53Mv3 zN{4hw4qXZo1Cm3FAR#Rwp)@GcDI(3tkiKiseLwep_x`%SavU(hf35Xf*Sgku64yIL z+<9WJHT$i)-MgU6lIo{WPVzul`P8j_sV>btoJ{`D)D3wL14aN=v4tbxGZUT&o!zOq z!>*0iE{~CNV+h{lQ^zII;bBhgEN)Gb z6ma=0#bcB80VqO;=Xnz|O)-(83~rx(rSe-h)*ofCjCY}%4&$M;N+9gPYr&hNZ&GbX z70=$1&CVOs{NW+n7bt7`HliawY>otF`W!*whdU3w?3K}>Ef!JfvCXj2xQygYEtM)2 zS!w*%GZ=_y6ZH_5_W zjos@vbfI^!H(oppuD9AZjrS1gIbKqmIDDGmipUAvQN0~tN*wU*oM!U2)9X=Q^HD#A z+Z8r1#I<-$Wyi?p4wF*lZ|TWD>cNd<*f_Y{(IS0T=BF_~M`<^=qculuYc%*F!=D27 zf}6zRH$`AZM~`Dl<6rqFRy+gdf%4uY3AqP@!<*RBb6>&=W?&G1b> zs{ibYKWrkg3xyvbzS(rXV8Zc}o8R=2kYVz2Q+Yq?QQGxLtn)>G-ulo(gQ;E?xR4~( zEfH^)6tmFIoZA5;P4O)KwAOqM%k)KC{(~TtgqjkaOM;7aEd@F22;x%@wCeRXRD&+UjjCxCYKenL^;~cIO$TP zejmnQ!ZS9tVf|z0!2#D#p^fOtoKu;RK)YD{b`t@#TcPc*JARl5m-XZXG@1TNW3{BJ z9hG_$Uo+Lf-dq3nSqkDdjgvl;bilwAUuQh6A3maOmS(3eR7MaDRhdLxPCFn`*!l9L z@viNXp$Ap!&Dtc%Cuym&=4?YztawW8_bWg8V$2Ujc@iBlLqEPoa2{-LM$d0Qm$?MS zTbY;5ylCz((ACoRVr`|-7`?e=L@6dZY?4Fxj9$p`e!V93T|qnvs2k|og<6BcQQa@5 zoxlzc~{|+==|ms>WT@U2NbFdS;Gkq*C+@K@;bLVL)ab$$UX(I zAB2z(DF6)Z`EO;Xa(Oy@@r34}PqlV3mRdJ^fD2_ZkYICZL?hb6pIc#4Sijl$TPcIw zy@t5Yw_ZI|__X%*_Is8q3I#BM{9{9VJi z6kqYTAD(YaxSQX9db)VuP){tjk6gyAqKJW@g3Mst(WBX7!?=;CdS+n1{y`WCE46qp z`*kU+S9Oo1jm91p{nY4;|GKsqxOwe_CSXv89xdlf`nGi4$fSX%h0eFs_ep5Dzx?30 z@{wn9g7v`@{-H;zL;?_*CsU3x%wD8DOShWmukG?8%1qE=zg#DpIE(FvX5?=-ZL4@A=`-$k&?x&@ysT!da3@#i)um<{v_Qo zy^!bU_0FU!TwS~&ESx<*WG=H~{HhUyZX;M)C>Bh+5n-m6n{J;_c)jlt(|buR!;su% zsm*Bde!bkI{Nc^!<;Y9b&2N=nx`gDsi7|`WV&e09`%4krntZ9cJJ%KK);(nt?kDY1 zG;_Nm*P*Oqt&3m7Iq2(GMH?aM5f#r~4(q+-$5!pwts*5Ca*%@Y#JXwS(UZBM`B{~llBI$&Weycks5*9UKSnjYm z`NCr4erVNzS#^kv`KX8!a6O$Y#(xF18k85c2uW4;;ml`}W zGL|dsxl}VrvO3*85)!q-^~S%z#WXTrsFeXfr?^3PZ-`B|x-j%7taFZAupaN)Ci zoS=QZM%tmEHcsBsN%*)Xe_PWv=6j^`m%bn$eGueu2_|ahuJ~E+tQHl{bost-o4u-B z0GCe|DvY*$i*L<-2%nF@UnM4xn(U|*&tQF;2jCS9s-+~XsEu>NuyQ|E&=?E2G5br8 zYt8f4vng6f&RLCkbFwW=RDo5qD^kyz&e0-;I}}f0s-C3o(r}=eX{-s!?s@VO6P@3a z$xZi9mJ5}UkI|(Cbdy5L{>~G10uR4*R`ZL$`uU|-05{(w1|qayxp+w~v5^(H$Z=uz zwGN^bQO8|7aw-j=i_lEk7x2gIJZ!`|tM2P@c_`<08uYTCa=-!c)0#F`H`!PzaKSpf$SL#)@0>Ze_5wZLI(NGv>?1xYb$^MFDa_wT^v-Q-Epj#hU%RAkD>HYJa_?$V z=AXAW0Ms`**chzYO$pt!1qEAdbFTVt{DZANDRL+8h}y#22S@V0(o6OB`{+#A?0t=( z>E@bDBc7vws37RCb{FI87LgE81I4nTF+RYG>nI4`XvLEe^%|THgfH##g<0RGxWene z5E;HG^JCr}I^$U4y_OK@-a_YRfK~%XAGd6uc8b~Ez-bxf4YIqzbLS3IQxW=+mpJeT z;_qiXVhTNdv}lUGF>%hm6Z`YswO$ z%bd5aH9|{d;t?u5{UP7_T@sGFv7Kh~4`UCVTi|CFXJ5U=2K-L|OYIlIE`B&|AjK)| zzKEK%Y~sNo^K>WVW>dAxYH`oy^S3!47&X?UX9{M*`oGTIANq8i>-&5uCqtyvbJI%G zOVIfoAH3!jFSn)pPYNH=bJ_DFMYp_|nq`x(v$H$*Syl{593vL-+qOfXHKfUmZ%U2Y zy+%0qJh-o2<}(>7lnZhdtv4g}!hf~1lc^EY)~or6`82<^6gt>&(nEemTdx>btRcBG zd7VaWgNtHV9;G({JFQ7!`fA7Yxk`Lle*#+la+6T3Jsz}<*=+0~(26KM*n67W%kP}u zmQ-l;4+r6-{!}tLVYcD~yI*MC&mCvvd=oD8f-1o2<(wzNsI@;Qc=rcf&pudF(-SIlE zm*{Yx8B20|zLlBhRWlL$NKz)^C(|bTj-)DjcOFY7ayamb5qnnAjEBA+U5r(QYZ9^9 z{`2P>hykas8Ve+Iu>m6O)}?p*9TpD7^gHBP$tcWkd{DxbcoxUU(VTxPa%a=4mk+5x6luvHdQ;PbW7xXOVg&d&Q?grqxt z^^;%x*3;aSQ7Q_#ltWa4T?|m$ruuS{AFQifI(Y34&s*7SGAybGO87{E0!E4q9b16E z#BXNsF1ly;eP=68)BUNq^0XRs6!kl^(?mYxdc(I;fn#C_t~b3vp=!4)LD#(-FuFqV zU)$PUoR7KiAXK~P7+n<W^`@13A;O;|;gw=`43Ax~ zT6UF|cYQ0!#qm1-Vs0!{PFI*XipVXtcOf0V5V92py`ov-VT(EVX)m4F;l@7T&$+9b zj?LUwNcckbojLljbci5ZFQ8eP>rVQDHQmcqQ={-)40jRGRN#=*n^yCC(j@B96!l(c z)?yKIx$Yy<;p4F=t_Z>_ZG!=|T3C-P6#3ZM4zP2)4bk*uvN}>F5A*X_r5neb$mo^; zRQ`TY2oRQCxSNsWdg@u27y4slGqT118E1*n$!V+6o5v(EHis!ZHt7DMxHOC4sZYp@ zfj2|KRv**puP}z>A_pYHFYKQ=#TVunj7*ym*t@yxpDK!Jq_)aw<@20o<0Fy8iCvv? z>|^81H(v>V^d^PS6f?RieCZzE)KTTsBT|s1x*GNHg1-rC3aXUn#G$8E`LnKMR(y0V zqMUjmZlaz^W@Jk!L^kR3VZxr{^NN@J%QcO?b^~Q071w~@;m=1^A zy1j$90B4k4fDwQ)WObfvx2bTvPQYjYNcF5SoKk=gWo}1N5h;w&b0CA^j0lWA99xcT zYfK1ojU8$f*;g#uA+SB0Z-?mDlUkD~d>ZFy3Hreh2~@po%Og7Jh5*-}p@{`-a9ApY z_^fah*NZI`&bhskXrBa%N-X)LJR@8v^8_XiXEa`QQXgl}JXik>@fr3GW=cyWmhVN0 zJWT3gTP?G=(45nTB_=F{bI}mLhI3*85jH;nnd*jxX*y;u4L!@vH>ggG^G((TuRZzm z4*l{cNvbc;?N4BoS}ODZ?Wn667L@h)A~NVj8T^5o0?%FFuF6>(0pNG)g8L-W0*v>V(%BN(VFg>%=d)`Mj#Ypo2uRjQBGja&Z?8XNT)&SX7BD z!P{Y}cM``{Zg*8GlnozS&qL81hmlW>B>5tb>3u>Cu_~U<^`^qwM#nLoXSpT!$0zExKm?C;Fu(0T0lK4!} zYYt0It8*gm2KRY@!Zz@+#q%J_GHky0Y?|BbWOTX}^_V_4VXitK3Auk_b>#tT)-sOw zv#Z^m0v_UIwcZPj;q1ee(5EwECTD5e+Z8JYO~!BBdm@5YmHC;cnXey7VLsrPhG?CuMMTgD6s9t-55ip9rbocceHnv8Is3QnBV z`qufbAN!tMn>%GkTh2=Y_yKy!c(lBhM9-A-#tVZfubjw(y>>y~!(P@);yRyk{aF|J zzCq_n!x^UHG|s(k7TRs#HScJHSxjJB#zGea9%{P(UX;`hd{Xp@!Ji|k(OWCFFJ zt1TQegr`qR)I1|q74bapg|2ON*FW5k?YSLCSSf8-NAi~B1F9$$PL{Dv@$r*~TW_hU z+`c;7?j`Y08OJEk(eE|!(`7AtY+-4RPO1KClAn~$4HOsc*%Oyfy3@4+db;7t?6->E zovZ-^NLSq)RKudsel@C!ckO7jL1w@o9)5r z0b{L%0W0HU!oj=t_^ETxM@O=PlKor)OO}sc1*g54o_?jmDT*`k8?q55r(^sZQb9$+ z0P#`U%|s$w-T2p*orW-WNiwflp>WE+^jp?+#;c}s+CM}2vO*Le_zs&fD`kTz)Be%0 z{Gkj`$j|Dz)a8H?aey`ObB)JMJsPA$`#VW|sAyEKBNoQUI;xAI2`E-u^9b z*HU!uqSiOG#xBq$K3YF;U;VyEwuZvS~5U<@`>-olBeV3$@bSJY<1K-p8p4cHhT z0~`?N7ov|bYXm|%n{h1rr=QlRUX8i{rXP$lC`s8!Zr}Z&`1|VwYTf|!F$|L6%5_mG zGAZ#5w)~_lV;Hf>SqTi8t%Aq!a16)WeWca-y1K57B+P0&;f=<=|A>Tmq3}0_FABrQ z!)9c>7&x&^NIF|N`^C=p^*oi-48_^7CT!nb<4~S}01L1s37^Nlb-j>?)>G8rkPM&p zYyM#im+`%Hc2<}`Q5q1nkvns_&?*k}>`-1$#rvWlJ!lk^q^<^0+7}|p3j^OgI7dkT z4H+vM`wdYEFZ|moQP`ICxbJ6*BU3pEDaKKK{4ans2TmqYHLb+wNgB&(ZJ~S#C9uuO zY7B}dFP;(Tsq;}tOME9#Yfr99UniUbrojtesO}GpJXClQ*C)%y>^;4ssZR(zBiK4u zpDsrN#qgs6ELvF1%erBS)*VU`Kjoz%{|E9=9rojw$MG9#SR|BMN|Wp)5eQv( zRsTcg{^xd4MUWuo1xlIrHqqlgZ+=5~=VD=ZE9HSY=&v5=LD2w2dHY9B4SFJl0z1}j!e#RsqF z<>d`I>3a@MIS)iGakG3N)*QObbli0ecc0r(6TN6`S#O;H)NnXl^D;eYt(hYI!%u+Y zmxRq0wR}=5zDM=IYE4@0-oB8txT&m`mh;WOTyuE7G9&c;=t#k3%DHEtbtNmPTwY=r zBofYAW(~J2l@ALVn{6%uhq_Sy+??xrywC{D6c5N;oaJd$-(Qyz zc>Y1Evjv4|WiBY#_YurPC3>Y?rt*NsxKk7!68aNolZwT9ZTa^>E3lxgg#GWF#r=@*IgxNvp599X4Cd!7QG|(`r3o?H$@NL1OD0)Ax zZzvJ`@Q8@r%gRF)Il-A4_QjCJ*S~%?SWTmTs3>tnO0blTGQ?z4&e}Vl65nanYtFQV zz^lxs#qK>LQ%9ME2mQB!x84k5Hdx4@9LTrCtnum1zS>H7`8cs#p7B13O~|{t;;g~1 zD)yuzc-$Vmo|guXSeRg;VH!#KKAD{Q-V02oEOKnqM{c%GlJy+H*seI+Kl#Jle=#pB zPq~a~yvo014-3n5l;T4oiMq&Uk1`I5vlWxK-49BtC=e_u3Zw!u7)SZ|6?Pye8%7s^ycvaXGQ$_4x%#1>;nR06J1e=c1ZM@eb-j1kOoHO|f1TVb z4It}oJcdb2x5O$e5>$COP{KnLT@<&r=Hs}aoUC*}ih+Ech^Hsec73q? z-hDUMq9;DIbydXP>EYu?`a>|`RXv?>n!+)D@W~T!IoRmqIDwiE`(n<5Cvm|0Xk452 z(J(>^G4|je_5-(R0(oW5)QtAAuM)^MTE;sb#0#)KwX`id-*P*fIOD=skPD|oB!JB= zz$Akz#zpu`1#SxelX0IH;^{~9nEibcLp8o!gB>kXR<=%XGODO^I4@LP`G;MFWolnt z--noArQdNJMDf0agL(%QYxgiBW54(Z-G83%Pu*Yf7LG?JSem31S#RVheLde^)6?vt zfV2uR3VqS#aSi#R{$Vv@HtUlZJtW-I!4c%sILsbNhDhW{L=w$+1#j z&4wM1XwY`g@%h{yBjEA~U2>1GJ+p`D#_%&n`-o*RddBtB|UR&{^InNWh#VW7)gI`V31G_*a;eBjR7)nH>$+quN zxKc4&>hj5qw4|0}j`Av-+*M*=kR%5<=zQ=+{IgEiv(dw={)x84mv87MuVeyxZ7lbzm+pQ4ZZD)2bH14iYb{sqMsJhCgej1lu%W0dtDA3Ssm!z_# zk_}nH&dvRPDLox5#$X}QIj8!YgPEC;6Pj~8A6O@wW#tKjCGWX33Skc3Bn%U_Ot?l% zdau3maTFl=ZZ$(8rQD9NySZL6}-$1ECu%Sf!x^>1K%$k=GjHEZi*r(PT>*;#6SraVNhSYF**n)f-(Paq%{ zZ%AI133=`P2rUh2m*7A7;k-u23Me_}bkzUpAV=J#PZlHr)hZE|ShiJ)=ilvXAxnuW z^PJj6B<=a7Rp+Nv$(fcQ+awT*dVc1x#lz)sZhDn@KQVTcDThjU-Z=J+OE&60psRc# X%*G6FX-s z3Bkidd0>vgckXB!jKKf!UDV~J@CrN5{ea&PI4bD6;NcOGBLCv!C8wN)59nHJ>fF&$ zRuVFIu;Vnn>0oBTdC$%fK8=Sba!&|;X=icA6nD?g*4{NM_Cmo?ci*I_INf+T z9h@z>cmxFnxwtQJUAn{ppWtwDx4&b0kHg-D;m<|>xsHs5i@CG4;~i@UdmM6IQ!|IV zcSPywksJN{&!2JLvA*@6JK4MZeJprDF62+RcsRMa{=GK*RT1R7Lf4(GE#S_`^~HEZ z4nO(-eDCjlM7WTf|DVD9dD6r0!lQ~2ig5iqZDNEE3Q zW1J{@-2eMEfl=V@4gRlh;!t$VxJK?N3cnDp|M%lK6v>IZC;#i}VG?Zw3fw2Qk7i6p z{`alX(uPO=`<_^5xQet7zSY)${|T;9b>P3RfC)Hj~~G?o>W?!A#jqHcy`z7U~lVN zjO*8M=3(Fc)pV;jmCHj#b|dBX;^T6Y>IZAGija$?yJ-N1-iU%mg{yG(tYb9 zJU4?SeiW4D$;nEfWpIipt$gj*3C2Ex)1MbMyRUJ*9gU%R%w=ppVCa@==<r(Y+R|O{v zEIZSl^zOoJjFegTEd0nxcSY^F&!k$uSuB4-T0B%$xp?H*iNWkT9b?<_pvH0-qRr_!Slp%<77ywE!{Je~)QpzNmh9-1lIy>?VeK zeSV;V!suS3by?lsuWK-QiDORhXsq#zZTc=sUul<-JW}cN+e3J@oj1~UX?rHUVzpCz z9G*+QqSo+@>t)x4K~!ULci70NwkZ=pWYYi1Ru`$t)*6*ivr`^N+UbcYa;NnRTpk|F25+Hb?*5S`%)IxAhUPa&4}n{_SetFjL9#Ci8AVrl{V zl;3-+ohnS*PuEZPM2L{!5a{28?2kq;&Z{=&|KFH5sNw3}fGD34>%X44; zcD3!$r4d*{M3)C%>JMO#eH-$5d*%k&If~`u?V7}=d=GxR>DPL^_MCAkI3Q-cQD|U| zS-bX_-Kj{&j(&xK&pCRbtVcyEeZABcb^}+scyDv5FuA5_S)B$YiJa^v;U|*(j zMV;xnQCGj#eJ$1TV@Wu<*8z*wke6hGj7f6^cmGCa&@JQZWp3?y#I5(}ikbAfe$k&R z)G2AI#o9B7GlVHHU`ajcKVxc zU!n|d0?k=HOFv@&W^t57MR<|#&DPh*ESm+)!&28py&Rqvh`83zkigGzq_kr@M{Y|1Enw?8tTaF{}(NWICijCRN z%>?yv0d(oL+@XGoVJF`Y)(h}WV?m#=xWPd{;3D)X~KnV$*r4KfHg`Wr5} z?owolI-Rsb!|rV|{MvyZCbTe4$Du$J|+O=D$6YBpozSES6V)lll9R zuJ~)Ma76MAHB&?r)Qxv=GcfNcwI=m4EXXc>bIM?nxg9d0S#GPl$xl^yk0=0tI=NGH z)4)I0pOvl2YP`Zlt(s39G21gUO_#(HaaYg9&5m#nMwGiE-b+H% zu{x(Xsw+y2fVWA#i9flT$w=zNJh#?;;jdVi}*w*#=9V3J<+vdOP zJpLk_zb#3uNuu(OjXqjR25<6vqWOI%F-NNn*Ku#R9Cu0{v!FANgy_!meYr^%eTvks zo1IY)dzIM3zII)E=1pkG2@NUwxc)-J5o?C`^aS zTW&nqU@a+sH=+`|DeX8_{avdPD|7s%S$0F%gn|S;{m8Efb|aVY*jeM08IFq4OU?q` z!wQcLYMOe&KOE{_F zI_74X+hj0>P(JYdy@AkJA6arGtC4cM`EHqWo(mrL_cD9VJKF>7z8)K(X>~&j?Mc>Ne_`pT$W25+M8U~^kB-r2^^?H;H!uw>hDd=_rCet;AaO)6cJ_cPu3oo^PZ5(a1j{L@6H)A)QKSjT&?zz!&3V7EUlzRCckmCgu;W{wh-b?A zCL@8qbQSM_BOo*Cyr>5Q?b|3VW&cvQDfpcJb&ZhY}ai5yo zG#mnYvS?W@ZnKc&CCQ6Jw6xx2rNMCzJ7pd!E(dma{(5 z?EL&w+qD%x=gn_x#KA^_?I(uKcjr58YIqz z`6?XTFD(lLa6(NLwphl=QXJ@&+YZT{F}0sNDq9wjEvEKQRlY6}@Ra$f8;p>I6t_b! zg)2(pwWJc<@RFQmxOhR0Gbx26(^yO`?fw^8+&UV2qBgc|7vVQ*3^GTjEADkk9BgJy0FHYjjq|oLCpTk43vbrDU84iNJ(OxMKEp z=8NR&l(^WoWhMHa1#ebJ&m^Dp*W1f8-07HK4ZiP?djrBJn zHu*gBdvn}Pihh|*yMX1a#G{K^3k^q3_hw$lC-z3@mj50Dl!JqgTscM*(*=pxM1OcwX`kxWHL3oaBlFSIel+!;pi-+*av<3c4SavD^25kw?LnEOy!(?}G*0NOa3 z%zyh9|Ly)VV1?f)@S^3AH6*0~oC$NiI)oi1ODu7=Wu}cNFzyEYXqCFj{mB5W|U7-gO&A+^dHmC~k6*z+$|{-G%wYrJ-h9O_)vzG_IkE81;3;p?(o9N8561{$)k^bLA)1 z!Hi1n7HS#uho1?MhS528Jo31RVrB5_oER)IUwl1a#4EO23QIyz68j1Fe%j*v^!r&u zWHB9!7eWeIV0? zgwBs2@RnG7e7t1z>eJ;BM!nY?e+q~KFRTLVV+C`vxF=}tW%_DdvSen&S7w>U(MSTl zCztJ_a3mzhUb#Q+EyqkT<16(c@R3Pb|Ff04{N7J90oC?y#XzTao_AN2GuxF{SNCpf z0wOgc>)_suk|?=01>@Es0V=`$N zt6y+!5z?Qy^fS+(s`Nl_89~I@Gbl_rf(BCb{zZFV`yT7t|JWn`%y{0pjjltUhmA%v z3;7sU9T8DHzVa{Z(KTG$1L9x_OV-0bclMOnNxB?<>}HQtR46niv?12P|eN)({( zd1$`P8UHeD!_-_bg;6n&dF$Y>?;j1RVPV#$di{D2g{@rfl7G3=enwn59ySMg zO}RZ!JA#rLN-aJv0Af~97<+x*-Q)sYH;3qt?D&-2 z+@+#$-acZu+9VD(-*rJJfg*0N5CIt8PLUp){sPK{#@tP0bg^czb2Lt9_JvERp}R132m8A! z(z7>;E5=;)=SQnv^^kxXQ1_yFE%lJ_NDyKQjB1Bvd1?4<9!_>D3&J*EEO^yX3i~4` zhXC~Fnbw7|f#WBFk$a!xx*AqUwEo;&o za`Lii6B?-6JKN8hvi6QsL9&5^*@~oWT6vm2Cv~z8w=EjpvJ&27*E9Yy7_a^986d`+ zL+wetW2W#IL-kWH=%tZ#GfS!O9=;J9f>=^wmwkC!?_TcZoL(TtV_7jmb1W2RgkE#x zT|Pu(Zv>4G&gF*UGZX^^dag7cUyK&`;wW0A{W96mvGFLUm(V`P-?dvMJpnt!74;RM z-XJIJn6l<<|4aRkc?@nU@g7L?j}KSl#nV*|3dDQbP3yB|O3iyKiugvI7NHG`MIe(e5bWYHwzCd9*NC%d0r8{dH|iumGfyjt&nvT*_e*`y`3tzICE&UDB8D&S?s?0fQOmtXYw|-IXD^e@c&m z6sXl1C@W8e#;9yd(F*sYLL32GI^M&>1q06R)639?RTxw)Ru^FLwxt4$)&`o zG?4H*avXaY)}sGxjk6fs*;D652B$kx=L5R$%yu;%&CLZ->ug974=la< zT9Aij#ZRM#g7qSG12@BadzvS)Zi7e1etuq&^UtFsMt%eir0*TGROr&1Ngc zFMz^V4y*4otPxAtx@oCCJ3pSI*R3TBuO8xV5eAz}H4s?w#p7diK2Q?Z_e=>oeR*1| zHYrq5fQmjyN1HyQm31|?0rVwHz|l9K5_y_w+;O+ z%faA2sODv6U~v(nu#sjm+g|Edbj?|m>=j|ksbx^ z^U`hki)#z9Jld9Qt`KHTj1*?A)AEM-NDxxZ3LM7kIu6W{J=$oo@_XXdpY7m>$&PP; zw`e!p^_0_tHS*!Rb1qSlMtT7McP{5wAHE-?XZhBYof@Fx7nW62yOBHw0&MxMPgME3 zub%giEP)0nNt?X$$2Nyif!hlR>taKk^?S~2AZFHRS&1VbV&Q=yG0D9kbdGMwN%yfC zFmQ?f4UC)f*9g>v7d1gut`B-?4=?AhjA>659@ts?VGcTI2_o6*)+|)bq&->4;X>97 zjt1d)fq8T7g!rg-5fGkTK_NTKh7@4u_j67QNXK-DkT@*dLVN*c(G9<6CAfZ}^y2~$ zD>aj3T#CrL8XASD%MI5vst=4&A`0(iuQ+{`q0pSp%P%a2f-xtVM+6v(+%Xp28bj;w zdv{YH&0$KoWyj))T{*#&POmk@ev6V0cD z+pSMp2+jRKdLd*SvuK6eJU830$o_m4@S`t3;qGjgBsq_yc*$HnW(wi`g7?&WpADkh zw)q?OwaSLS0Pc1safq1=Io?<{;cw<0qpV*@2Cqj zUVMp==shu;rK*!1Ry@86f-#)dNX{r#Fq?iEyd zpxD0`0BD>$8*8Ytj{&&E@}r(uytLqFM=4?x#k{NU&h@^>5-Mtn+w`&!1S>lB(jhzv z>4j9YcC~|ZpIOt{Fe)eoiP3BNkXwU%|8j5#tRa7N5)HX`KykJxSq`9^@8*$&k81~s2mtQN>m{iehJT;?gx?=}ek2BzZs zTUoDdhq|p#TPTx8XcS3CNPK`-uOz6hm3R>~#k4T=Dktt80rM`HQX^279_Gzy#r(5` zj{2wj?7T+`Gva>~Sob{VOn0bq{{G9%mMRDq(KLo-OKDms{}~$7o+didA+oB(Ojd67 zx#_#(1Jy)4iN%Y5NHY~mc%e9OwXx_%Q5tdfN!mSddqnxZ4M+gAsY^>xHTODdaAhaOhLH=JRjVwkXeCKl;V4vIq#|65va#$$FKiD(Bb(6#El7c-- zj>`0XB|ibcS2EcgIwE~qbPC-l=Dnly#&xlDfbKQ>;aG4ed|Ra!b?z=&-FVaQml z{B|FoI=Gq*mJia@zmhbxvzJ1cY=6D4ujltiHwwJAe|3mwLWlVeD!_;&&=Jflz}4PZ zJu9l)$v-X<*i|t6a=UokW13fUw zw~{M|UC?c6gTR6lVk?xNTt?9F%DB|zUlau4fCfLP`6E~T=za11dkLrrh4K2|8~Srp zs><-Z?$Q#^v)x@T2J&J_RuC%$u_wV)eGTr2_79c-mz`dXKWK_ag2R34yJ5VT`KZ6h zcsxwI`uk)3V~&h-r7+ZLq<^5$?bB!U2aX~1)baa=M@av*8LNK3iC*o;wZCYgz>2S~ zYvBBziF1%TuD+xn)EuR&BdQh%0x;n;x+l`!G^~5=?`^w&ai5`-qT4@(lnTCJf8ofv z;y<&ZN?=>^mi#in+Xx5-3s7fYQQKEGh8g7@vTK0j7xOpoT7ZGK&J4+GUb` z%9<9&XA$&Pj)l=p9h7}0vgsdH{l!Qzfc{-R18QyEePU}ZK^2YDbvxCEO< zBSig-EXfw=B`?7(M!K8o&6k4L}HxfyMb4lYWX*$?uFjUvOf~SN(fCKXNF($R7Ng4V=Q_lZ?f;WRB)<+hQ*TS%g(32@ae(3$iia2H=J>se^$?L5)=f?wwEV#0{|BeulO=CZ@V z-fBz_?iV{!`!N*ocPE9$t*JSvr1*lbC2+nb=g?!hZaS=xZ}!hRJnauXiQewUqM=7F zR4q}_=oi{ZnPGybw!E(FCo> zmjSCbz#kk2h8)BcjTYNo;1!0lp0XS5Fb&x9id5xF(w^dhYLKdc}-RwDj_a!Nm;xO71Gi<==0T=jcjyMxa;wGeAR zSE58X-7P8=4K}#Ir6B1?6A1Z9ae3q->J63KuJ?tSc9pZm8+Z)65xa^{RbqM4u(SVs zg_GhId!Z|{OuVd;E++buP|CFh^b&J~ThnQd-yJYKnkBFA3Tm0o>h!0@F6q;+p;!z; z-omI@^j9-NU-qA!Qc}u#H14zesSs=};i*{Z0zkYD8#d>0nc=9{%g}wzeUUD#?8nFim*UOCdSah zzYMLSzRwAzEQCWIeia`&)jSzEy&oXB%PCfDm2jvWbL zaLEBCAlKJ)|D0eqO{gPi^92Dyguay^1fR4UWh<&NJ4ebIRpLNz*E*a~u3cnghmo4A0fOfPkp`MGSS7Z&?tnBIZZV>#6FU?oq(3drQ)J?h5gvX z>8lL?j&U#y??SXyqtD(?c_iQ>H?r1wfHB$7&C_IUmdDb50&BV|8sq=1HTu=-u35cr=<(y3N>-$H1?=>rsfyX3baqQqQy!xkGgBe#@})y` zb2OlQ%kRRS7}1Sl*+_ETV8Sy7cXpr^u`RnkC0;TdHF_hR_j<;i=_i_zk{5~{C#BxZ z<>jZG6k!uPPV40u8=6)3@7^bqp2&>kEJga;H17>v%S&O78KpeO8U1(A^ZG{W{?4fO}apKB|BL75-%KYm`Pm?)jrW0sCNd(|TQ896G63zPG+ zobtADxdv$dOZgQMXV}QSrjPt&>M}rz)`!O&^X0^e+D!N#W4Yoai<1Ju*c`E2uqMKH?z>rY*wo0NupU& zW|cBvYF9|i-`&5G(?6eZm#gK>}rdMC9z;sB%XA7qoOI zlxc`I01Ej7@c)eE*-KcIyZBLW6*i@KF`-wgC@ArrmsVhxe z5E6QdW-jxA6K@kSrM}01U}=xp&zDkg9cz2uXKQkg)-iw~=p!gnwy-1bO5SpO{c|-N zkag_xh%N8!@w(a(l_krd)(2$2u00qAw~gF&z3;||B6Dh)+THLnb6@8!Q{BX%w`gIs*Tl7;nBY!ImPY|T~%ur;iTTB zn{BZvi#bA%^-$>ZO$KLP&ZY>uq_l3ekX~1^W60yM#3-02^5)QQ3Q5^hokw9pgP4~- zXUQ+!RTm}s2VUAR{?HUO>s8nPm zyI+xKZsbmx5uJXaOU#(p4_@RUPy$JPH`Mk{L{<22a|axP1AqER_RU!kzzrd<<}Tc! zb3|H|zKB=wXn1RQ*8)+TK$0*Gyg66IkR1*2(HE=dbz>A_+mC6d^tkcs53<6!M~48XCZq& zxx1~G%yfpN?B_M^6T_6(%zX!njFPb-2P`sD?y!qKD8 zI~(aUUSu~48C%aUGN*f)K|}1~6C9M$5!zQ@)~NpWpJ{YP0rC_BVC#WknW~BY>&B45@6JTDbBAAbN#{ir`z2L76F@J+^v%5gLMMQ^!uj z4;~#6l!^=95rhQ6tkU@rf44J^ivSz^3hG+O>GS<^iMrD^bYblvF3s@;B7lsD5*hhW zo9;B3M3QrmDZcW%x<{*E9H6RG@8eyeiam%M=A}TU@9nDxlVW3lHsyDIs3R$+YX-@a z(|ut6{b5BCcm&vJ(nhRClL6TY@acLV;RMkGtHBK(iA`SxUc7a@&h*pGODSCDYEVD5 zLyg*nig1SZDh7zKjk3PC4Q+eZd@}xK0TTIyihJ=Djq2@xIgvl3pUGCQ#`UUEABdyc zt3=_?=bRSb>oU4Gc{IW7D{vpz-%V4GaF-ZO#(}!IWEM#-p$U&pN0WIef#~bDsp}h{ z3=F2Y(>UCt-ue60H;^GUq!Ac(4215rN@o3s$zKkG^-f(MP-K_N0v=%XCVr7NrEFnUIU7 z`mU}V%jsXb-mgDGz??D>kO|rxXVQ|oQN`wfv2PWQHxY~EB|kASInH#lCYU6O&s=&M z7aOz&RIJpdFAov8Nrbe8|D_XQcxc$9;>>4B#zZs%=%zCfLPLtN{FJQaNN+PxXqS`b zk;hBP^ep764M9UK=)N1!l?#ryL)dY^I!a?C!sg=zc(9@D^k?M>9QwE1Mx8==OBx zhbxiefQy{VN {hiRNc6*iXC#NQnh=5o{KW1D71l9KltYPx(oXW-@{rg|R}xGEqn zFq#JJ3TZHVq|7)yV6{;D1YJyGkT9X;3wnsK!1?}{yaSbbAFjYVqLfdoJ+^I1syqjI z+zP}dFJiDcG?fr&z!jshdm*Q2sud63N1xMG5&ZtJ&DY%L!pSD^qngZ($Bll-Y3cT&cpZ+oo2{Gb^iqm$uCWA7mmQ|S9`nFF! zIoB(sPYJfznSV|$J1)lhyX4*Z+Y|bZvZbOizyPK`d;E}qk3pgi@A zys+t{1TDa2S~I(dVerQ{EEXTCaa|| z0Rwo^(vKF1CsG_cj64_l*`V_DP|c;>T=u$||NT>GU-9s#6Zo`_$KKfy1SgpmYX4IU z#tE=zp986sJr!>k%<&M3icmb|Q)d~q&PiPeXHJV%)nRY8U}G@d6Xs zt^2;5uNfP;6FTG~b^}fxK(r!7;$ADIWp<^j)<5B0dh9J!Vm!GP5*(irh+?-oI@6I# zz5NIY0e2)oT=a-_I>6fbKZ)%)$?chkm?+AsU61 zUkNSAWB0ZD0{$&6I+$L_u*eE?iF|=PSIq>Ql1fr&v5ui8-OhJ7aS%D2z1*#I=#9tC z)o)Kze=|U&q7S4=x2CI%YSGOG;?jy6r+ZG&dzpS9b`Ml36`}!$`=6GZniyAasHP_^ zz6_e{OQgNK?EY&i`hMiz@t$r7M|Uul#_SoT_gpg>t#s(LHKV60Mg=d|E2&_FhgwtPI$ctf9gj*XN_9;2ys6P zkl*j`T}|(i@k@-C4mpANgI~VKFjnxB-_p0QvPjm`d@YG+ObV849d#s*w}4E97}F6f z{$mUxTbTw8X$oshU|lR#WWWj!__+sn+cyDqhgV!Q6lw8CqY&pShlY`YDOpcF6w9t4 zi^gS$gt)uX)BqFexEa_|EJOdF^8{G`J0w*{ zu+T#N#*6IG24G?Zz}_~XfzyL7cLCUw>eT18j8k`BlAJi=y>odUYk)YE^1 zk)R*J<$<(CpXF)dF9GP+gQfDal5YqqKq@KvGv{TSUWL_1chXXP=l6eo>P<4X2zF=2@d7;I2T&^l0YV@VfC6ubs^@rr+}9bmDa-+k;Ak2R|SD^Sf+Sy}xF zwEl^!q8E0Nuvb$sQFLF%1?6OP!6xFif{hw_C?GwsiLbN#(furhwGT8a+fT{-hk7Ih zDT~r__=k5y2hh~^ZhYr2xlLe?vvAXfuip!M3t(9LF_J;WT3fAmy3 z)P{*OwDVCll2P$MS#ke8f#k$C6~|#)yWVe460uB5C1GTBzRDy*?Ti;&HO{&-Y&Z@4jQZ6-B%M* zj2fsxKrPEGyB%g96bnHZI#QolC>?|=T{xdGCKypqzDVf`W#@>`QQN`dMirqSjF$BL zwu9UiD2f%j++75pu<>~D8DN`qLdgf4A*JAUMKwCEy(8+FV+m-v&u5B><0uD^eRNqaQ6^?ghE~&S{8A z5QMPGCl3)Cd;DOUA1F$Hf))j2NU}3{iIiuF5CU8VtdkmXgmkXkJw!eWmer8Fn9ei-f#`{P2E6%wTc`12`+B@^RoaN z=|3Pmm`@p@aB_vlW02U zZ6Cqf=a?>X;;=tQr3CAP!xbT(pPJhWy5w~GGv~UVxeR14GD`XpFtWPq;5C=UOWpI@ z%a0M9PAr&~+y#P>TD${P>Ww0&cQZu^l*o>j^aI%46qpP;nX_JS;x20bvFt-QwlfUs z|4d<@txclNnrX@Rw-m;Ah&bU8Qw8t#Qunh+Qj%wqqicj7&{L%1+Ptv!$`AU@zvk1U z-Xm5id)2usr%3Y<`fy5gO*Nr_?|3!Y2hNp@w+^U-D5h(VD_?{rwieURdvo9ga*_I+ zE%4b13oYpSs^PyJa^B-|+>ElAXjfE#x*-jb89f23-x&k>cC!Y%0#q>|hE6X%+yF8|EzPfvF0Slxw`9Bw$Byo ze~x&-A~l#eDYe0yYX@6aWm9-;Mq}MF6i>_>L!A9O6FYU3mQTH8%0p73<*MH}=}}{& z_6r(6Rukt>5N@!XU1lUvQ?$eZRU%1^Z zNSNpSx(r%%X=mZw!sv3?1f$3k1#@hR!8^1U6{OErv%YP&S(2+aYZfa^7+r#MeERi1 zwX2q`>9I$7&ma+Jf{ol*? zRs!GPQ9T88Cs^Qu%8bM#UUVN!L3J{a@H6Otu(dyDh`xH&&x8Mpow1wt6Ak|UUHuQ&MCP^@h$U`|I!`I&*nJa}!zB=L)pT)a-zvJnbUTUc zEPL4mL--@*M0yA0AlsPq^XutLxHJfaB9W|0GCHQLyewH0a{xSnY2vU0>@gmqMz^EB z_>X!?CnP@*GF@P|T4mX~5=(`CDl*nFHs#Zl>je!rXC-zqD{e}%&87$~6ZT??0YB60 z3!Gu?2!*!evMZ$Gr{7M6O3-@mtU2ZKciqD>W~yb$ZQmp0f6h*d!xGd#L9}!0oc9)? z1h?wQmWbKOOB8&j;^g(<;NI%j^TdmL+!S;-_?zf%{Ybgq{sZ>&pX7`U)%?vfu?pFP zW9BM(H;Z#al_$=g=NpY;MO=KK^qt@3KHh1$+#%qe25pqh))`go3HMp^Lhx6&W&9l1 zk~^Tgk5t3URp=X5|mnM(@q=Fr(oxAnaCbqPYZJwjgba;E7gQglF2g2T$}XFv$6 zF_BN3&Sw)3B&RDp{>JO)xa`DR+J_}h*Kel4Vb)JO28_lpGX#|j^m4M@OMdRciK@~xBk_m;rZHX+QKC8P{0S;-%RKEEY55jrlih#;KZT&|z z&V4wPF1_Cn-*eNw4b1a1$9QuUCRdPTAhddn*Vg)M#jq1Y4N@1R=(ZP*ojz|1cz;*y z#LGb*tY&C0|JHYgbEWr^Z+9-59apttuxDp~P;wdB%G6q>lD9cP-r-uWk6R;B6~T3T@(_H-35FG7BGy1+oy0Cz)F9 zw!EYyw`!=Nvo#7Qcpw_5<5csD1l;Z|;uI{))XzY5-E2tl_KsH2m# zT9Mp0fsWPqdD!?V6oiyQ0c_q(mo7HZnI{T37)88zK}Fnl0zZHq32(@08nr+FHRM&s zk_j^MD^87m#e6Y;7Tw$_i8l;ZuzMW_R{!wi(N)q93PfCL)>-@ zk)txwWS%f;zca{&qk8`3>DSF>tp$U~$ga4U2Lw=3*HKFHeR|fpb%Xm@*-1>OSgo91 zL#{fp0x>@QV&?Z&E(|_TLGU= zeRc2oMEpk!s6`#ap_TaU%VBoh$PrmEWnHR9=JeCRf;{U-S_4FyAxhYvvMnn|{Spea z8#mL!@QDzKw-Mf5MCK;!QQ_DxQ^M-R{sv5bG3?VuiAs~^H{g7P!J>`aPVffpDNMMG ztei^*J*os6jZ-eR^p+Ly%>7GG2fyTLvE7E&Z1?0zDn1tGcTrk+Vs9&tdjEV&!MRSR z*PJHmSIb&yQJ+m>Pxv7#8 zSyw}WalM#v$aAMDV*EXV&(7R}QX_`1ZTdv041Y;CI#hxqX73b=r(=cHL{1w)`ltca z@Ne`nU(=~uOxQlRYCl+>#5+x2n&};?!TIQIB*mMs8O(aSJoi&yP^n%5s#WzWuQRnA z4r$6`Nu<{_jc|r8K_Bc1Lq`hjU(PQlXcalHooBD( zCii-X(dsx$F!GWfRVC-Ah^1E=P_Uu%~_P9lYp)EuqA)uBmrN3T;*-OBSytvh) zR*a?F@cVFpu?4gGKGApsE5)9x?kpv!fkfQRt4U(?=Pr$7)NKO~)cSM0kW9n7PIfh3 zcjDG_k`herDD*9NI2}?T6-7ER#7(p_Q+-cuF}J7xZT zSPfn$-3qj#!$1J%s-@3v;C9xZ$6G+|EJgN+9dKhJ(&0PzZ`@^;p8$E*Ig$0!g(FSe`m=AZ90bzDnh%&)AYxG!POdkA_>XPKu@UBX$rGo8 znI9_Mg4JbW`StthTi;`9Zd;N64vNJNAqw(HLa5};Al36qa1N#n$%~vq!V2B<6})jW zk?(`HAqsK#{XBz9vJ=MywR;;~Xyt7>Z5I1I^01At;*Wz+*hkP^_=G6(xlO^v7{P(W~;Nx_Dt$cx>7hxEnSAWv@czJv!Ic+8+ z1;=SRUFk_kQWuge)126%AXif6f8_X%^jNb6SVo*e9OjZ|ISRSu(oufDlO6(uUM7gW zmpq?Lpw4G!dU-eDnw_Vd)yXPa&@Px8c!QilvtyZv3MKiTDod^|p(-MV z1vEW_DGT-RmA!W)in3^DaFl42$7@<{`E_^-ZFi_l@)n6j9J(2k1b$tz@Z&SSBwgPs+K!lk!s2o(Z;C_u zn&LS2%Fil#DTbyCrUl+B1ls45&Y7LRI#yGCcV2tp%3#|Rwdv!XXZ%s&*Mzf^@L1hg z;KyRHJ6-!}HETTuo6EU=64aAH=&Ee%_jhhfj>s%Bojuck)+mrR_i1EKv`+G#&SSiz zsjO@Mo>#$@AFbFIRJEe`O)Z5&N*A1J66BRB(9$#`^&{>4h8Rgz5iMf$+oF}USiB|3 zH9K!o(MSJUczc!AIW5+UNJ#ykG%Rx;>VhAm?-#HI4A$zhFMgI(`F6DqceQ4l5Kghq zdI==9E$usWr9&d8@*9t|Y;1Gf?@(GF$2f7KC(q;xG3uwqj-g*Sy2Ww-mbJdxrrYYH zlxQ7D5wG)L^^*Hrr_`p`6W3~}Zi?Ru8hx-Oy6w8oiF%Kn@Cg~>`{5e4@gz?@B_!?g z)=6y0|(Na{FA&!AaU(RBnkpRMbE@IM29xMMsihWaQV=FiM)M;x8y6|b_qK^ z{Rrz`Qd=83J{hza{ZZB$!-LQmKVt(y5K09I(#XZAenuybWBsjI(u}?2FO*YgOH{^~ z{Lli;duGR}Ela^1X{Z`9pfvSN9p8T1#K^lk>yahm&bjb_&h2&vZ`y z_UfVnQ?ozGGt<8S4wxBe?fgc>6y=T0r>(gOeG_drk}g>gwukvb&@I5cwpeFH_TgzO z1xn!)i6(ilhA~^al%&H}&qv>{u_cFm8IWBe@G(Z;Y+CDhV)4rp$AZq^-IK%c$?lv8 za3{Mg7}+n!uI$5p4R8FN)pAg={I|{klDg@OlNTnABuPkW%Y+*erBT$oUwK|?BH4n% zMpl7D^XgjgI)pidBcE!1nO7gO>|;W`g}zYdTq?VrbaPOwpTr<6M)q}j@#J;3AaGv1 z+VQ=&zbAySQZ`Y?m%z_r5kA?3Bx|^nzI(-Ppj>(*+v5? zD$|c($XvkF6kNoO3|fN2x3mHQwLWfP8u+Oyrg=>~R(Rhy#2n)+iI<&*ucOr^{ld@Y z&yx9akl)~9+j|J?%C3x>Y8mn(UJS~Ld?#zgvHo2YV!YwzamS;@e}8p5qucd?VP!iQ zS1xl_ z@$0W?>$ZHhBG6@T?e=@iL>?D%n%2HA|3=Kro1W z3Hq3g#gPh=U)Q>*wJF@&u!U)MacoZ#t4s;uOgYh;ow@u}2Xhg-($l|#8$oWHp9|Z( zvdE0e#YxCW_(UqTBgX|_T_u;=;+XhGq09X;W@f9+oStF#65UPWkZK<5XJl!NUz@*g zh8N_#==_o*oP0t2F_VPaUGn`?cH(NeJk1trEMZ4YLs;I&HMwHn#Vv~M21}7&)FNS? zP#zS0*K&JnoH#Ltlnal8Za^S_nUhWDY{@-1h$eYKRj4hsbD+-iRsOv)gY6HvGvCbk zW8P!v@`6pHe)Ah|yh68@44YC|ZBh1k z=zDFE;F9JEAd+r%n!&&6zvW8rhDns7_m%@BPW&YEVGg=e4{c>?(J7xgoK+tc!@xsDWTbwY2+gr4!9B{U!?Tq$V>C$w{3yi=S!pC2**(|JgMPf}rM@6}XZ69!ep@;77knU#aMjAz0O1eY|=@5|;8A4j5L{dSK zPNhK*L`nn^X^^46{dj!e_gm}yb=Ep_W_b3q_kG{{x_%d2KSgIB1{vAz30G}b@KlqL z*%OkRD0S+of5n4ibER? z+#c8Ubz!}1zo#qwSiS1!Rz7`uiBsc@fM8umH>hI`s_Y_4!(#4D_o)sRhO4J|GBBw6e(kNRt za*y*DaHpaO4Hemt&Mp3S)#AISc0!NFvd}H(02cK7cf;r#sF-_YwIbnk4A+awmM1^Q zPv$MqCWq!Y?1t=$Ij+{)YBr{OQFV)J5@Tu}ecTLJx_X%{Z^2+;1kxU3nK;d{y%vyJ zZN_C|@VVmRG)nylW--rY1lPXoQyN|l?GdiZvS@SwwK186`g}J^74dhNw+Lr9y2t4?6(N1eyov};jTr`pu8)RH7p(zd0h|x%&ZP@ z9wt;UuH<5np{E=aT$;^Z-`*LpMLV&?k5An}2K=evF{iOed(MM7==0bXp~Pqz>wNI_C0rs)$2 z?n;{@xLsd@qN3xYIOiN+z`g|TftGkoeyj`mP+Iwn3fmI5T{x1ev~69-R@WH8n5mc%jr|jy*HTzXQXLQ$!IZW!itpeNO#ZWM_q9bZiTF6 zyW|P6`HNyr7P)DhRb$tJ58&_sET}ShUoitGw=R zfWL1y7#np=J>7XN@o)>fVy9)w0&Q;q9|a<~RpXiTU%HJHEPIN_WZF_>+4ZpDCPOPS zj^q?-r^b%-sUPM(sq5?asXP+U9rKt(tX%UHddqwKhd1KbgFb7L4(MV{(5#KQ9XXe( zt(x%CVhYia$p}BkzM>7aW3$~;lRxMe(M~+i8)-WoY;nmLd1Lw(uH0dJ_i~OLRF&v6 zny#WpoKL+P@qQ@~LL2;ml}(G^izHc%e0gRSQO$Q$ z172wQ_J@el5CqJ;<0_UqP1nB;J@{f~rL;2TvS`>T`YFt{b?|cnj=Wj#+Z*YFX2oHw z&Dgw1*`VL9=x3>4)0e1hL-*8+&3fk-Q&JL5s$0F&&ibmQKgk7mj@gD-Z5!C-9v|14 zUIj&Cz{C_kg5%XX^^=I`w*gSmYzRO?7!#*=q{h#xts45S8>iND(7P2T#3Zh5JmRnM zaf@b){Tw_JIcnbm;1fL!AwyxoHv0MUvnS7inCVF5cr=SqUMXro?b*q}`g?H+YySCY zJYz9%C8r*j5>q-_#0m@)3^JeROY82s7$+Mh>I}jWD|yA4ZCAdB0_PmxAKo%PNF2nG zA-7`WZj|N4*xg9}s0l3a5O z9V(K>{S9uNAUb#gB%l`>-)d~z+me2^fH?y7)){D(zPX0HyIO7;35)r2f8=0=b`(pv zo!`&oK_ur*+spF)T zn?0&>IxTmE8X+LDIU_uOcn0Y<&H}(VbWJNI>KoA&i~cc(A|0pFpqk}A3Hucz`KSlQ zXqOVjgPT@m%n*?vvpS~_`g@b*@~C(f&9>Xgj-;`HP8fRfQ`JT5kOf>%bUCJ9qgqit|pkH z`!ZHuU%Lv^UL3bxxkt-O(U*%;+WeGVKoK&yCZ}Kz0{Nxalo?EPn-}Wn#ut|3nZ2NS zag>r=pKN%^M>2H(!S{PHEj&pCsEPgg72005=tb^G_ogcNDkWxi`dY_^)4sU>n%;L6 zZn24}JcLr@ewUHEJ5kW}%gA-^%?&0ZE<1Rf5HOsnnCQW`o4*rFVaftc%Qq*MiRwq% z6jg6g`z$dc6=&f3h~UXFGx|dw5b$|1>vgx*ChsO|^Rxc4a_ZEKA*;G=E41T^Gw2`d z+({6d_Vr@jGA#J&;`lZ*Y3iO_G6OC-b2_JE@m!fcy`!z|InB9*^?Vxx`734*{zu%N zKqE_US!rIWDw))vGstnm)EjxEjy=#Uceu zcRb0xX`n7lGZo~ZIfQneghYwXQ;@ewV>M>g{Ggh*6uTx1&jFW~52w}0ucD3&U zUt;G~%YJ7=1W}hsB|gce>m6X+3LvrNQmWPwV`WLjBFCyZ0@A1Vc#*a@xJf1E{LOPW zKUb|63s39-%le%XuHah7ebotXJ@af+b*}I=DRpB9p~fC}sd~RgCt+m94eP|uxJtgr z=F-=X6Y-d1_xxIS#BS^qXIh?7&7`=>kL#tT!N2m2cS%;OGI-_`I~Ax#VC~H=DaOiVvW&9AmV)A5HX-+b|&4eUy2^lfA zpkmm|)`F)rFW?_|9Q` zX#3^!bzK3mMUMBy-D)f@&=DMI@_kqfDAp1fekQ+5C5+U{xbZ}Dvt-|P>nlX>T7qL zQ?q~3-b_|SGH8&;_Vuw#I>jqy_?_|KmH1vYVoVesDN;P#8Xl+`PkjAn7qD&;C~BT5 z7jjeKo@1$ivF%ybc=PIv8LxI)?TAJP4l-U{a!hyuPZ#;D!kx1| z$Kss&z6n#(C@P_C^;ZAUgBhfD&f(=!=|x9rMl36ATx}vkEvJ>uiFL}4q>np$#s zc1WX;D{?jqd#Woo#Jl=C0dvN{6+DIlhGdS9SXcGMW+fFn1x55NP$kZPB0%*rzVu{6 zm}2#ghDOO&VjSh>DoD9;IiaR2O5-p{3}HlE{j>13@A?RK=G8Q=j0)O24ozzA-tdT2 z(4QlQB$+CoT9RYM$n6L3V>~e%BP;e)MemZhh3mE<61uW1x2W0_wd{s=d;!L$*WKLl zh;=qGV@GOdPcOars6;y7RhNc4&GF=MJJC&xk3jA8dm-cE0EjSY*L?Esy{^-LQxm{Q zozn5V=8f)6Z|zY-?XQN1Xb-%&y3>sdCW4)QiKN=U#0wx0{V*;UWm4URq-hTm_np7h zyt9Ankieks$??}gi~E2(^{!AB{qs67P1&*b@0g_D+xCUs+88T}_I=X)aK&4THD?$2 zv`mZ?%$eX?X>AGE^aNqM$R$9mFl9lUp3%HNWpRac-E%F-cxndnEp*oz_rB6JCB+)9 zp~BJA19nZz)!xuZ$@?~Ai$J5hpl}U6^hs#xz(Z5H=QHN;T_A8F--!A{8JP#MT0Xr@ zNE9Ps73a8&%l;wwL;WBvs)*!X{$S+R=U?SASn~OZjm+KS9)Q2b^EWNUf0A71~tAk>Yz27S2?+Su3lG0HWw#rRRA_YtJ& z#UBtjc$HljiM=n>@VUC-?r1|zL4jrZb?k1nU;JLSFuRxnNa`@GM03lD4uRF+^Dvg^ zvPZsug%|bApMk)fQU@i0Mtf;Q;@a(^3 ze#IAaM}SSsCDM>12@lAZ{S}MQv7#EVZqWD39H)UBYV|6e#Uy1rNLIOD(e*4JxrCcJ zMY^jfW25`*UC#F^yz5j3=P)H!W-|Ud)VVqiZQ|>)sjVMY!Yz6hdsSOv&O<(tI>3K% zd&!&jF0vyi9M=c3Blk7m zvGR0w=!n63g~7R?sP-mppoe?9t+$Tn2{$>-2vMgK3N4Ix$Z6ay2J|qfC{}rd04Wwg z6E&ozu(qpm&FT%**C~JRH${K5HQ5-`q446Tywbc3Vjnf+`!y28sMiKSQYJ1VS~`!q zxaK{Wfnc}+v2+s-ip_&)wEu#)eJxsc*-x21~bhoPDD`Jy=17qTq-&o0Qqj?Y)Z zaM%RMBeQ3qA%D*I@ILyJS+goY4VpQJ-|DpN&w6lF$dt4Ltp+CEn zPEGlPw3xIgHIW-yjU;KF9HM)?UW=9jkG>DWp7!F4V^uG48(VU^>~|-PhNs&!6EkCv z84lokk4|6J!L~h)_;0??w`~O@yrb2XW7k{F;k)b_OZ?VjlHkUE_&P=>W-@QPVF4EF zTu|es-V)ww6k>plyzEz6EVjH}zSS7Z7`&Z3Mg`UsOpqfuF(-dK?=P6Z(C@n__v5Ka zUI@IaS6AqRX{p`7ihh>h?Rm@AT?^Cqm-$;4E05;5^LJM6PcJ=;&y0V2$Ybq&Baq_q zNeI%Ofc9ZqISD^;v56*s-IJ6c>*^ha_Trcw%l^}?Jc8}qR!ikox^4$-C4Ig9`;f~) zP?O_6TNnn@!&bm&oB{T!drcmbKkBV_0`m`35@q?_^}G@%C_Vi$xx0sd3d03DKVHv3 z58xVW$fY?Zi^#Bwa&0h<4OApxbX{*JSxDk@B^-3rvfqCUY&XIS@^PqwBHj)GsR@^g z@;9OvjQkhp#A9stU*WWq=w*CJ@hLl_c%{Jg-1YUc?R<>v++NGM0@nlA_V{Ol^@W}G_VJsjpDm~=c9_N_h6dBEDHrif z;3z1*HQ+!>fSKBs2jqkF*fz_S^Xg9&Pk%(*>g>Rc?vt<4XYel8^_y4@q+^F>24tyy!bvZCb1Cna?rr(cx@5Cb{8G(DNPjLkXK~(b__(N z*nn$7q5=ylPU*!xxcy&{ueT6amTM9ZI9UA6i5qX2c0SDVL=8F=KZ!_Tq4ieD&{kP8 z)6S0oT{@TTWSOR)XVJx4uLBKlHYE9jsr#L5A#&&j;E zYXyQNeDp(>`w3Jd>6PhZe_IL9THr}xatW<&cCA)OAE@nEWC&ajk4K%jM{-$3T`34w zx8D{*I6g@5CC7AF2s^$_Jr;9!l3t!vEjBEnHt9YWrWqU~qgt}IxuMsIc~~?&rcwRL zL>JeAI%7&1ek4b>x}DGfdb66t=zm;PvS_u8xf$9|U+Lvd!l99gK-Rn}4ro|kZxjiKpnZNsxOGFOa zzX!Z}jV!kAH~Q7W<7eILd#|3rpOt|5(rb}J`Ha`RZS2~)F{AIxu#T)gt>NP`P zDmwXX(m;MsEz7;vuoe#|deD=tET?AQ;c`j!OO=HXcMMq`_M+*^HK$5pFPJ^dQO{Mv zMJrF}1}!{Y+fY7hyF0}2)o^0+T{ zFJmXD%GP5{I`ZnWBNgN zV(FA33#rogjO8;5pQv6CQ(>|RHqc!HRfpVGSnY!X`VZ=3tixC>3;TmYc=zy&rO57l zUaw_mAzLfa&k^^{c?xbvyE#Lzz)w%6P-{&A{@bwrSrt3BkD?i#0zS1piSsrSVgrHT z)_YyHlibA2*fDjQjXstokV0t5sf0wuYtsMI9|!pv0n(sBZ#@K?c(#Ci#%4UlQ%AtJlXyzvO+?$!oGwbln;H$7!x)8Ed$Dp50CT;m$JHIvYN&XyoQh2@J z6&b%g?(hHFU;K*|`x>V$Rp4$GgQ!!2V<@;g{Q?*yn^A-4x^6~h%Mr|*l=}&6kA1fX zymgdGV4AiLp2ugLrv_{XkT4D}*Oh0ZVKgPz^>)RVMS{5SG$G2sxC&w+ng>s2ndD~3 zFcXDEI5B9_g79>{J7PM$f9S3Rshypd=O2QLrarZ6{U!KrNT=i_h|aQz$ldsDDIrij?1VLlFFWW@>H#dA zj)0;Z(#ZAwG(UA)xKRIx@gsulARSgPfCQp0x!5Ky8%k0R5p}1?(&n!4)$_+qw!VR- ze!0};3jL?dCPPXN2Z*y@iGfbaA~rx$NFltg)V9#4c*~GTM6(vKrv|_ z{LnwwHa_Be*&Rkxfb_e)qT>T*7yXP*Tq9g$3&~nJ*171x;Q}S4??I6zjXVoc!39DC$wY!_OgkAlXmOZ60=LcBm6DW70 zNsY+&8uvR$VSStIYcb#EVtYHevNmQ12M%lcPsi0S`?0bEtj8buUw?r{*B_e~`{WWI zYomvvu_n#P*h?w|wD-7b^VPL~P1HelHLhuj*C#rMXyKg{W%Z}}F{Yy;TJmFU#cq!K zpQ308>|J$0e!?nSJeg@3@L$F4*wj$yS>wUGkT^Ly+v_d05u34a>AiEK#Da+R-avT2 zH9wk|gkEyUt$c%?Ut6`sMA`L~&Ow7We*Z19N;S>L*aTF~gEWDiNOhQ~euVG^P!fN*RcG7mV}CQ}m@D^uM5LchNwl!{r;n?E}R96F>U_tfrbjfAleKJA1V*yq+v3sw~<%+I1e4P{P<_ zk+RO1Y zUSqB+y}%_@d3bfAT5t~38sqWjGkLVPY$0r}u8wf$cdO*XDAuxTd>fp~wQ*o5)vN(o z=E z8^R%^L3qwY?Krv}I$FUfOexlJM+q7Zt%cB{jvEmbu8=M22$u6^(m-xlokE?xD=_sF zX22L38{tGhWRZmDKh?z^<{QPXHn4OuP1MIQ5cp#Eh%u(T4JPvdvJUd&t-S`=*Rn~Q zex`~)h{!1fTItWoHG@ZNTiric(=*^WuuK*l7&f^Mg*F?R8pXA>7<}iB(Z~2~H1LJU zL=z(l%2hQZ5mJh4&K&~U!Ysv6Q3>H^Q@5`-d@{(--`GBx*^!cKnEdwH%uxT{%q{P9 zI~45`yqPFl>>K5lq=08}v#Z~&e+sWqCPG3{aO2duwo+3o5LqEdbnUt-JCe8UU4L-H z{*bQ${2a8KTW#mQU2Fxnz4*AI)7m6M4b;m^UZbfe?$MMdDA&LX(@F|Ab|>z|DRa24 z0C9>3HktU^_((jn5P=Lj&DT>DuRB2OX5!276cA4%7J=8)NG8p?ZUb}1|KZ#?Kt^<17g zMly7RiwXjR?RyI@al9}s=b?C+F{+x(Cg13{9%^j*24sQdF0R&Uh#G`F+Fh?Fd^djnESYqlxTl03Xb%6Sa0OtScEpL=MM=ac9_*L)Y{@E4ooa+dgPtz8 zfFFtAUgu$YqP@6%$|fR`QvcblvBW^{gqP#@lH|t)u<+@hE#Z#@|rG+sxrs^V>RQUqBhPN@ATiZMJX|VG#+R;|~Pymx)W(L>idEv?&-wx)^t5 z?W?#BjS&}yv18f1!?u4NtjN!{Zoj6Q;9p!+@9@MZjyIDZ%`JMe#M-Ohj^^VczuuUn zw!q#5n;SG`f~lGH2t2}TX^ef+w&1VbadIpVG$h&*(b$wVc%fHp1mxdMC2qLxTYX^_ zrbtpZD514_xHq~de!3@s^=O8A^I^^X327rTw_DZkL_ZMe!ni6>kJAH~>~lt8=_<{# zfC?lUrZc)3(!}B}F*gj!B^I(SexChg@wtu|%-kP+cqz6OYhdC1W#QyDSx>AVMC}XF z8ao}>NtM1fL|}>G*qZI4cI!9(&8sP!hh$$C3Wo8$tH#)F!1apL6|m+__pVr(S=-p* zw-eDR!h)0VE)i~!0F3O%z8cF)q$ zG`h@yU!TF5L5vAw2({VUP;GYoQfrU=T(qaD8#Silj@8HsjP&)|!+UphUoxFR7$9wpvIaeztDLP$h*pdl z0Jn|dr)ww+Wb-%@Y>@wrKSQ?pO z3G*l$OPYV-^?*=_c$0TmHrUzzTgL^g2*K(D_=n~!D#9f7Mgzf1Rq=~T?fk{FI7Pek z8d`-cEMwuBuV71<)E@!sHs|23>)lVrS23cIi+p9j)cCnTtGF&)K|Ya|%~pH6Q&nr> zQ+6@!OQs<$h?C(DWPO&44bt!LHsHb%wg+R<=k2QN9V$0m8j73{KD;HY9Kl4S-Xa;g zoUZz!>r-uPsf3tR{iq1?@*iM^s&9E0H6&BKCFi{$Pj3zL%qt++Qrkt|N|512DhuK( z#<&KLx7t0^MDPm;!V^fT_+c=(_-rXP+st(ts%X<)H*PYa$fslF@jtAdjnM2e^!VW( zK(^BbYmid4VY>d_5ih-m0msu7tN;%IOojC@DZNN9Bd>hvNR4L?zV9U#A)Z)rO2L{V z$(~|22=5cW%RHHHJ}eb!^dexT$TbruSuxE>4{%W)IMfUE%IA%obxY z$hj2B$7c%TclXjvMI;|^BUv}xE$#4b*+=4Jc!|dgu(6`a$_+rFpbi|YWm;TDB;g_y zfQ#R;??Zi#78bMbiZ&nqaeA=(G~YsBDR`XwbPelHaJa*BWmr0g53oGl)MxEj z&UH7qEA)X|f7OZjXt)i1-+>d!%7YhPcw(KPtg~$_{u1^u+K`4|?W>wRwQ@05Hwn#q{p*kgmUnd* zlHxI|;z<+^Q;%+gDxtbF%NVS8y@*0uS2y^Vo>hidnr&IuBFjusFEEj;Ty5|eAiw4z zJisE4q9Co@%iwqrkV-%rwD+E~kgjt$YWq0*qh;YnpDk+XF3{cy9l992s3~NKZjnlo zJbaG*99V`0ef&{{wIeTsbR1DH#<`a8kgRKb)%)eE`52^{R)Oq`v{9J^bLnT#IH$2- zH$!<{<-%B=HpO)Hd~tg{PsUQrmLaVtk0;#YjksbCV1Oje_nX- z(2>V=PTYBj=BtMJ2RAXGYB3^>WFciqz>74u-0GV_=$k20o#WdAn|ufn`JD+}|Da+~ zM|Z7lQ)@bu9)!x)%Ml+ms62>Ny7>a4HRs%RR)vpJnbdHfyFK^OGQQ{M5!Zq!$_TG- z9tWnBuUDaj@5})kWz#sykh8@^B+Z;O(iBXJ^fIl}`$=!2y0EKPl(6QFvP(s^yLJ*? z15q@?Kzc=O@U7Zwl4>qygU7Sr;Z?g!_hMcz z+s89HU$-4gC{84HEV4z<*ej@BYKz~oCrEud)Vu{$b&|UbGy6ch>TKf2>EHT?5>r#T z(}e*qW%2nS@%;)8h6jXl!@m;E`#)X)K#Tp|t|9z}x1eIY6NVM5EDfx?^uAMW&$SPe zZOs)?p)X{f%F46A#%#U;)0nxkn$hY_f{<(=E^Pt8OOIOWm@f7w(p?#X-}@7>VWUjv zDPz?TJ@@_zL-Ca>UY3xp4Qj5R{HII}#V0a7-9*d8TD8>)pzf9JfAw*G!;0fac&GPS zdC8Od(M{nOH?-p^W=;S%@f9b|G-eKWsj8S#N~Rqu*4M>vR4qRD2v7hrZ3PL2CKa&B z6F>v>1uye}MEyO0NRe#LZwLA$0Gs)UY=+qVRWWR4B-_h+*&IVfij5~Po{->RHd@5w zXok=PEh8GNfNzC<t#yvuT~Xx6G*O`nyB*hxc1x0H zygf%5z*Ilmk+z8oiBHa31=LnngI_6|Sm#p3F}>U#B^$Q41 z8@+HLfh_AIPC>ZkbJ(j^FwB~s4+VO2$#-&*>4;skH=GedB5hevIr*6aG`Rw%$K#$M z)!w4o;0)n%)2K*FROD|0a!)DiLcUIph=QL$}FqeL2bGXdy)aP~pu5E$-pqQZi1<#HvZi9XX zpA{{VND!S(!<&?VO85+SOA z5jS>8Y`ZOQ9CO$0&T5MzY1G}Mi8@EkDg`y8!w@T=g8EFR2>jb`Do{P?2Aqr3GAqgS zGfFKEb<%9^n-CRr2LX}=b-~Z13Wvi8Skp@dM+7=Xx_B**`Z+c}M;%gC_pu4@-u&^UXK`qY9c$lVHfcnowPeJJ=s}M36M8=KLc&nv)#U+H&CVmi;n? zm{v7BxNW7alMVNo7+)eOi|{D03%F4~7a8qmHc^MI0AVvtiV@D6h7|?iy55v3ArQN! z9A=J9yo+W{*G&AZ&(+`x8%NaY3@0Jm1Z>c!yDSU9(liVlc3u+6Y80Q=6WkT)jV1bV zVeqDuxa3~ybK>ld6=teZpTl{2O9~Da7q<429ZQ1FuP?8)pN|cZ1m@e80iun`h~?@C@*L}vHBp$^XW-k8$;Tk? z1s;@-Yut{J*h*UfPWI*W_;mI-HE1+XW-_OPwHiVlpQ1%DN1fhhOJ{6j4dbu(oHJmi z4K{u>#}b%m^87k2*hjj`li^r^a;#+3Y5^2ti`J0c=3Y<*5yQNmhFS>V`y zapT}kyl5ns=P)o6xJsm!7TOsXBoCgyd9`;e^>`5CW&2BYY2V?;j6t3sTSoYjHqSm% zC-A2hA4QMOR9pFPsN1jy)@yXL1?p? z4p)TTfH#4?Cs6sQL(wtMe;@Vj5EiAK2eKD-frc(kGT0;he1fQu3|A#gHD8&R-oyn~4TNZlnmjyhD)x zle^MoeNI=r6PY?&euLc~@B^(Pjgsibt?u{{921?V;H`??-*=*yQOG!|s__AHi=TVa z@6`HA89Oj7{{?V_fdmxPx?#3x@7k4Gi54q9_gp+QF*H!rX3fCEOg?}JEorfXnCF+W}Z&q&9=}w9FMuWnprdKcbMcH)jx%{IL4(Bac zY3E0*s%t{qW+&QG@*kdc=k`0cgr4|?;CLncBY*U~wBcX2C`8g`c z7(pQ-!%4?XZhGu6@#ut}+){68ew9j0T5k!3eupPqR)toRQAvFuqvTv1GujWU0gmX< zE$vR~Bs@kLhj^7YR{^7?izEq-YIRLY}T9msu--PTBD_3SHfq3 zq2R9D^6;$bT}XC(7`&QiXZg~AF=e#$*WXMECA`997F%i|GTHA*33v>13NU%`q}GY+ zsMezUNa=1<@kz`(kKU$GUV^vnOIfS3qxQfhP{#2jSos=>T-w&!MSkPkawpW9dnyG3 z6a@$WN=Rt9*4Wd;{7fd@hcEdVS_FrwPT-v5f|`qna%RKa(lnq;JW)q{p-NP1ZQJTkYF^a7R$+k zKj$>W0D*rVw*aTWFkmU`0SxgFC_4%!&ok*r9)g|z=W=lETvGNV0DBLEqUgwIKeg#E zQxO!YAk~W-2Q&SwNhcUy%kyc)1IR>PO-sltm>8Y<8ygQ zH*$&Dej|bTY!8q%W-~v63nnd|!|xas5EPxwNI4=_ZassCWtnvskn3hg>@ESsf~__a zW6ocIY&Vk&8&UDu6e#}52o=s5mo|~CGb#U~LzM7XXdK+N#%MEl5x|Kqs@e6XD2#!xc`9ym@ z>p=NubK%4LZz+Y+YU0U{{pdEotbCo{Yqa8&jT}|Fn)d=8*YLyVAOdS2g>l~~(MRv; zgdXhYN5`i{8}DGMB=PACN}%&)LYjYuep@OIX4XgqpVrUk9?O@P0IA(Ww9pa0+SD7M z%P9xmahb1Wkb;uC357R3EfXn73MKx1-Q#My2w`p0T#?-oaoG52< zL~#oA!AtB|sI+(W03=S|GcKjrjobZLnA)@}jM@oT*kU0gDQz5@YVD7e9y$ZgPZZL46ItBMNv!T%( zrjR+L=)U>h1>0sXM*w)!b#+H^8L$K;vEJzeB-UYYiFP-^6>ua5y1sigFXJ45 zE5_W7$(Qt8Ui;X5YUD@Jsap=1+CEGzke?zlQ&J2E!&mnswja_I9V zug|Eg^nafhTja_dvJ!ZcT225t&7^wV@|7)cuzH5q0!md51gbp;qOlvBs&F;k!AA4hTJ+A!A#D-BN&MNe9VrP~e)|HZ28Qb%fCbqzc#YSNWB{`PacOsATnu@97f61U!X)Y(T+#*VNLRGLF5WMhsF zg&c88PD%{_+nuju zcJ|L)UJC@hxl`f|S-sg)N_Y$W>8ue4FOW8%_UJF}w(t2wib~ zrcN6u6C~i(h*JOXw|Xwiht2YA}Qeorv^sG!N&{`Y^~`rK|H8n{!z&r|EL zh3V`IJ@#OwYjwh(s{kX&$-ICGZOJGo{dwzS2wNZ&Y-An*#lP71UV`uf0kZSRa|iI? zL_lluw#)_y`}9iZTEE3BE1;HFGAf_|HHJu#my!eAY_!#UwGl>xLReoZtE*oygnzYKRjTE9G3haD2b&>r)~s^feKb!aiziqAc~UIzDnJ% z^_meKV(_0JYh4&fnGF9JREs4lYr*ZZJFqASY$nU}8zSqF6B2>!#30Y$JBChRgLqs; z`lRpQ-QqeX3|EindnPcJE3OHy3PO9hKJfB6Y`;vNX!u@Lhro?lC3DqGzxy3^!jWb*n_+Jx_b*R`Sh!9?Tb2T2D>W&t#JA<;6-lsy=W3 zw*uVAIvzKIjin5TxPw+yS?KoROaO(y1{w&1=0E9V!zIb`Kvd~576+*1+2H+`TRv@c zbcRcJ)&j;;c7;(>f-(~sOYjOH2f0Ihc_1~Up?8xZ5m~*R1-3iaf#-cjH?$S7s@?w{ z;ObavSnBKpAs{`2;KF4-%I4AM91zYx8>7N@^4zzNHZEqIZChRHNGgmxi-1K?yBUcGHV3~$n%jmG(H1#dt;dx#?}W0&v_EIC zp-!GldCocU_r{xomj#^c^YnWXrKyKDob%A$E#77z%<=B||9+_5{sxo- zWJBQlP|yghrK%E(03>0W5ehDya_k$$N`4a*&5?(A0XqxdP8~-<{!}Pj0W=|VwI zT!gEty6*&2C5v|Now(LfX$-xmqIxWp{u62JnsYsWAi{MEpjqkx#+}$apIH_@CO6G9 zUK6g&?m#H3O#}=0YTvd^hAP;1#W>tL@&@xT;X^y|`#g2&kKY(|;>u%G^Zi`_-7ssI zE_E}9%@K&hk!&3kUjWBn8JMB%5s&{7AoYnVf*lE9&baMIbpUj_lcmRf5Y`BpXfvq8 zM*0nOz^6`0d3>?En@L-N>tpr;0)GW77Y1$3y_p8zq5oCbNS=)3OX{*ms|wZNoS1iP zRQ&@k``9QPngG{@EtM7v=KpKFB;G7k9sp~yD@>cvPa?K+mj`z4su93o4Z`5a?x;^t)`Q8x z)7GpuB8Z*9^f>?TiH}iJ`8U*z1kO<`!ok=JvJX5~jTgQG&X|g>=^a_v?%owBE~^J` z$sYZ*1W(Bm@AtdSnlccs^@lE3+->5G+|S$&XoYqnWKE3o0{`(N&kYN~Zucf_Ts#g= zZ*e;?lhuWF%@lfFuH-V~ug|yMZ`f+W8eLsps`_Nb>I0U=*8^~d_2S$d`lub4UJX^8 znC|On122Jpz{@LgmPoO+cvu0el>HuZY8>E3vw>Y71*{=_wU)lhiYJRdik|XT7~-f6 z!xYzGZ?ol(W~N4AAf0b+;F>l;%jl$VbE@6nJB2!r)3tJDofa#roga{@@?2(^88 z(2pwxCt>scGYauyx7&XK;<)hi(>4Ikq>3HV?mkL_o=UK2V&TBaw`{hnWO{D)**RUg!uW+p;I>TO;5)M{ctVFc7L*Y3d_8?8Ghvu- z8AP;>Mf(PjaJ==~=;Ss1yTTzV-xR<_Pon`k0afSNp9AUTc7d?s_Def4TIVgZKs41# z-*SGp&2!D8N6KyFxbR)a!k+P=f}uQ+KQ2tVD9O7c+j98 zTo}PrKNgX)YkawvVo>3(z)}ljJ-Wh&5ml8Gkt?t~nGGP>83rj4R-p}-Bv2L`6JgGQ zC$x;L&HjcHGLiBC>k(1;F4&A_#m*P6E(&Hrg(@$bTY2;dV_Np{GMJ{c%EtZzd4N1D zwP2!>4dF1$PO|0h)u3WP`jjdO&J8+MlEQy4A*ut|Qg5TWAu*B^sIvCK^H?Cj8cFU} zNctch{|mfWJajQ}Qn|=!kv^ zU|D~8ss_OK#v}|{GzlOD76Y~_p6Y}vUX)r3&txq9QRgu%k9Px<{9%jc5=O8tWFffZ zSc|wuEDTMmKu=7d`*y#E88odle%a{{FwFk$LCQFI&}p|;6wg#2=?npN$=#OgJ_)}6 z((?yh&MWJNQ{+;?=SJ87yZMqd(gEgVaFb9A<0{jRrbERf13I=qQO+Gfg&>~**19it zVt_C+TUHOn7lt1L^OaYFzAZX8Vv^=#|JdU9(&^X~jJ49zb7)apf$Ju;EDBcvsCjUs zs|EjViEt0jUC`*{rYK#0f#SW^03iR{JJyv9z+R!jJmX2W@4(R;CL)Styf;72;5WcJ z-Ms$kP}Y-j(~@Vj;k{e10e?0DF7^P z@;FKHrtv0plL7_^P8Mz2Zbf7aSO$*eOJbe0Vol=mu(>y$ca2h8!CoQx+CKQfGiHS} z@UhZz$wmLSX=|l*0QIpGp#Kr69<~w)HnVtL7v)Y)8px6>6yZQ26yqN8ZGK`kE>RsR{@?aG!BXos$>k3~Z(r$Z-u>b;dE+tL-1Il+ zqX66<^?b9CL&sxu3b{{}+eZ_;0_$Ii$V69-#Sq>IO!|KUKzVR~;`?rZ3HV&c4VY>= zcNHihz(1?`9iU}$fFg@>q`bXug5W!&XkkvsWOV|JG08(@QBJgTVNpkSy8w_Wo@J5H=cXzV%*Q*uDZ28Lq&*ppom~L<HmD57-#1H?cCZ3a0Np$1Ol=3L22$Odd5NA^xh%p9a!UE;2{8qsr$!gtAHI# zlyjIg__;akQnL^&xIdGv_YWvwe9G;QuGY-pM$yq@rXYfZhO_AgC|-ZV60~GM_xN=f z^bS_b!n2Cs9TR-C>em1dz87RGv(NH1J|u<*Y|qc`8bgt2M3Eo<%zZkgSzG%pd$$r+ zDgrKMAAh&JU53Cm{5MvWf;kVN?7{xz0ftU45B~hl_G5Q4$Ptxg{4aD4!2(UJXavkr zyntGii`!K7?;r?8ZNNeJiBFdAOJfNfQQ@-9zMKfw}j~W~-s2%{7bPVq}^REa-pr!U|$(;q0&RdiVN} zTAGX-7Y~<3KNxm<08HkybfbZ6#AUEPO1Lv0ReQ26cNTjI7AuFk-O2us=}}qpe6QPY zwONn8jX=Mf%nf|+%KyH%3Ko=DtFN{AF7R#x;5~8&oBsX=4sn23yhHI^T$0}toWgMK zNN}LfvM^M}WI?AdXiES0^wo-hvcCTw5AWAO;y0>;G;u3R#tjq{9$x~Z=E{Q&m%sp9 z6ct^J8C0+sdY}&xh;NbG?;8tR)pPuaOEvxlHXn(8rjY8+c{IxLi3o(Bv3{u?0^Pb@Cw^U|Jmr&(4 zP%3hWQTexQi-f@;0RT8^g#H#-D$zK23~6XV!FparZ-DH*w}R_F`j|B00_3?40b#ct zi1DTt19?VIH`_oi2a#e46j7ss21f@9y8Wh=^0H2oeQ8+W1%=_}1LP}sh;;sdA4f4; z^H2@YiyUq%C0dj84%d@!-K##}x*7jfC@rY|bnjJfF#Yg3~n@cJ{F7sy; zc!jzB8WbV7pxXQJ^cE)L4UfhHu3HwOTT_9#0^hE-g*t^LyhKvwfbQn8u2mhFZK2NG zOQ0<Y`*dasFIZ+vsMvj_-M98X^3o!d5XxBaL z1~1}P9Vncy`)Pp+t@@$+YOx?z5x<1{)L8NB=%V8e(uAN34u6Hxi4E6v;DL3TtJsvZ zdUy5BHpHY zZO2lWF!_&wvi?Xs0Blup<&Olgnxhsg`G1ebi21$$T6T{V&KK!a6L0-TBs=KWJAKd6 zHw!1mayFXktVSRM`aS1Jbh)BfT z?WefGiGm4hdV)BTPTLLed!@jvP6T9{*PYC?U*0+WvvsS~#If(O2v|Y2$W=(Y^)6`Z zrqlaN(#S$`t-}XU5x&J&c8KQJ)yz#? zo2I_>%KrlUVeR+`Ao>VSf@<&omclPse(1io7>KR(2at)mgv^SWr(e?01Xbr!R|S5XI_6yk0>WD2O`UO82CR){S@WYPqCdUc_H%n-$u*g z2t!OTfiRI^BmL7?Y&d0ifqRn-yCJcZx?u1`ufrlqBn`06=!^51`>#$p2MYUf8z zbq}0$ZW1P3g6|I67&0`dGl#&fkmtZ5n8OH0OK@9!2H6c>BrGW_;9~aKeCM2;Cl-vE z?d2SBO+Z~*i+-2~x2$vv_gA2~Dw)>6aZGs|mWzKB3tCP|SOB9}G)Jv1PfC%dDmS?D z`u7ESScC(AnRdh4K?N>zgjsd#ZH?QvcTM*Jtl7gxbx7B&Ub7GkCZ^v8fbx7TT~}~+ zt;aQUeK^+z%#20&n+w2}S_Z}vl0vL<{a@SkV^5JVH9LB&cf@a1$o?NyUl~@_+C?k4 zkxfaLbc-TvIz+k~l$KUPL{dT;Nh!ggQ^W#ELFp6_kd$r_P`XpNb9ugdpXdJJIX{kj zuf5j0-gnM1#vEgW4>oW6C8Vctd^sJZ9Hd_eTh0{O2tXC!Gi-PNOjRUnS?=TYZ@`Zc zI^FDG3jHTmQX^a{gld&GRDR{- zYvCPq>A!`h{;ytG^@4!||AD}Az2~@$-VHDZ&Q#}MC?$&8*82uo8%B{>XJ?3NL@Mp4 z6Q86C6FhxAPLg$r=*ktTnbmcAk5?AzP9xQW zI>yK1SaAHUU^q$|dg%xCCDsRk^J1E0#dW)Jfv)imtE;OQ( zM38Cng0n&oK&MI(+5nfhC-?n-j4pW7iTfXUj2la*BuE?`Tw;7UsC!|y`InK$_)exj zHUPJ2@4)ZgxW?Ocw&QRD@V8^+!Q=i$9{jiezT}OcHA6DuaL8??zQW8!1JX?zzEuun zKPf@Of!Ky`hI%v#<+k-|YMB#A1xtP?X{L+yElp*WSrv0BT^;%4Xt)gp@L0(K5<8x< z4v9L+y?YZC=62Mf914X-iM@Xiwj!#wR+oxte6BLZ{WkCW6e zZ-deS8N;m?5vEuL>pNpB>5XlVyRf_Lv4tFgd+a^Xec67BfHhSYHNiLKX_z$yHzF5G zM4AlE-irH%Pni$avxOxtuV%oRM=R!%4Gt!;wBl}ebW#gF|MidSXr$&586m9mLym}y z`QwiXXO1MPawt*_i!9i*9~Zy<7ZnY^KY)w*rXI0!yCTO6Kor^$M1h$Pjr8XW&_N0* zGy3Eeg~?qw@0fsO)8#AB2-<3x$HYtgx0#aoA>}l^yq($=X>wwg5BK1~)-Yp0i!|N? z$*Q=y_2An4sgIA;KEv3C`O-(F|N2{qW`sBKqCe~rPIc@;;RPQ5>#^9igM62+uh-ao zOX72eP^J_=9C0xu9r?nU@VDL^`EIBO-FxvfO4+etL|E`ZVG@`i4yPe6_$9{7E&%C| zEh82gT}`7NPZSX8=JQ+l$6$jqW~p_AAmE^ElM1`!5&5s0IVTnNx%p?&>YItMO{ELc z@_I&oAiA*a&r{v>90sttfj&hb@YL_P`dh!l!%Ohf(AbD~>>0Ftl5?j1UH@b>@ePnX zdatMW(eAzfCqqaFs?`C^__2S;HkFgVc<#me{G-XID>|#hjyC%c(suK;8YQ$|(=?iD z%@W`KBu(Re&c0oB;jgeB+)YMexHsnwcHt-Ga5m&w!Exfr8aQGVf%CBloS`vbDp5LG z?(hu3+p&jFF(NdwldlU9DOvM~;;t&n4-$)Vq$8kPZ2Jj$Qq?1ZeozuJW~u)82f`en zpYBBO{7e~^X38tBGij@-<^04mLrSf10Bda6uB6RBUZHmB1 zVtsf7w?T*8CFB-FY@8q04p~5ypA~<>07w*>MYKF7dl~+UpPh@7)Fu$Vw%9}cFG+9% z$p~muH2~KvP!%l^yLBQ9m)Q0b-g=t`L_on@jzTuyZk0}il^VwR@(T8g3R3+N#xKyA zJf3)=Q(gf87;a%@j0V`OSGH6y&Ray3LdM}ab?oiXLaWXKRRv^wzKqA1k8&`IZD%c*CZVBa@w9>fZv>hnNFu=OEs#_{78f}Ht@ z=mT=bj6KU76g3T=yZ7yySZVrG!1;(S_X7;e4aQs&zC!<)vez8L4Y_Ua{H4fgAm&Md zxf%r-zYnx8H)5(MY%(-Mtav17#~?-hn&|)#;{vx{y+<01U>9;1S=qhmz`!zCG2!`T zd1^=+Gt$R*Bcy$ra~*AJ9Zm_G02k5R+jreoEHgskz@_4;Ct**+S~R9<0zhrN4B$EJ z`x$UtGgBbT8>(TszN~hw!2;s}!b?K!0S}vrM3cdni318uyMzWXv%E_()M5A8syUn| z)A$Xfy}DeI#|u9_yau1tWOUh3or-yx0$JrOLDCh1s|3$z9p=wHTp8)}_%ql6T?Vl& zOy4A=?TAOCdX<;}<`UrQW_8a{L(yZs;Rl+5E%6wdDr1`S@F%F?CY)QL;SKPTJ0TEF zZ^0@wLpi? z4?L0G?0pF+go4nhv<759x-RpSs$Vkn(~MnYJAY_|aq3{EmD|Z#Cg8u!=U{0ACS~a)=?8$hAOYs}yZ?u^n%YIj|0dLPHaHJ%Z3U~?T~(0Uhcr}vPK+Y9_v0O1>>N$ z;Nf@J>twOJx%4W&f_xCk;DC%o(YkwSm)NkaIA!XbzX34OG|}C#155H{xElPCSr&rp z4d$HbQUMR}8JT^y(XY_HeIM$1I*12EBtPORSgLP-CWOX_uRLU{b`^oG6=D9Wj(S$D(MQi@6GU)532d+r|BOp<>Z4L$n)0;Skvg4 z*Yd=B#WUVmp+)-kJ3}w;9!Qu?ks&n1YBfqe@B}HQ9q1`igw(VDZSf6ckvn`{qOm!2 zw&b_| zSM?wg^0-jxDdgGE?}4tM`FxhXrJVKu4oM0QxQ$UtmljUK6n$$~10k$I010q}fmnV} ze+z6c_Dp+n`TxWVM$`@(1b4l2_B@N(Bw z=T1M5?63pePHe>>52EKth}ru|bD;`AO$^)*5W?mpJS*Vn9rYXCj8^om0;9fiz!Mu7 zEaVYr*cng7X6f4W9Y;tiatiBug&MvsENnNvJqKeqO=x&53#c84V&}Rkz5|0FS4V*01a|TqN36{w??Q0ZT z7^J+JG<-z;4?elfyaBRgTB>eP;QHPKJe~iL2`i*;W`7U#l*s@dUDb1-3ZO+G5y>J$ zn0Ww|&ni#4?i-Te6AswwK<(7#jOf1GasYAKyN@!``45*FQJVo|rHoXJ6kqk=X zfyqVK=;%TJAW}ICuc;Ga&^WvK^jw!2Nh(*ScT=;iNwiK92PzW+P&MnyQ6!8II5@dtBP~Qx&bTWjWU5Rb2NESHK1Oqlr0Pnh?9<_xE z{bgU3e#$=@@IelNBk79?pn8*A`CSrJecC@0utdKZeuotP4V9>Q3mRX0WX2GD7#Lv? zfJhL+Xn?j09l^DCGyxL&@z7Jr#CVt~G ze?HMjRh*G{0Tr|*S}c}D^(zQ^Wdf8#<%Nt9JOibyyBXI2Jna46A+n4eu<+knQ-DCt zt>mDa&jE#Ni--I9vP~8?l?xvSpj9}?JQr+NoM&l0<5%K8y+khzNu=Q-Z7c=hgtXR> zoA%<>%h0oO^c*6NgY=UKa1mEKxL&{r0eA>4gtbHS=D8)!`8evdbj!ExdFH+PNTjAL zJ2E(D^z4S;Qu#glKos%y6%4`~rv(DUwg4QtAQBUH^0-`C4W)H`RmgV&PT>a>^lTiV z5-KQbP>IlxYY&OS^AXsB!(u!$0qyrcq3hSr^Q$n$e=^()=%{<=waSt6ktPy>rzb7M zLz#HwGb#QDvk_^4YNgm^`HRf{EC+l{#u^TK;60)?w;u7~g`1P}8c5s9P>7OVsW3i6 z3SXHiQbgFiT2}V9{rWj>&(A>nEU5r-DhIC%fZ3wG+u^~lu z*@--u0t7WWL#*5l+cP9k9m>S&--Xy0O@KGLp(pF+t3M$Fq5#RehVom++7~||4IGbM zkk$+WvrVNx1G_Tlx6z2(p`Ts*lS~W@EQzA4AihM@eW5F=y519DNR@ODwYM1Gwb4dW zSLj_Y`pIp)%4ts*!j6%GtB0B$PF>67G3{)iw-*qU9N~bz%qObHL~o>;I7z%0!y=oy zZqW=foX-cgkjI56E%Cw~;G%W@U9{nAK`xG&kbmlwdBI?$y*+`#XecokmcU^QYhm3p zliA#8UIB!xgH*d5p$Lb*iM<){7f&b{*&YH?Y9wR-Xg!5nf|9-KCJHk>dGD&=gF_U~F){Co zo7piTMcA>w-EVz=jRSl9ubGaXgdXl|jUZf4kYTQFLJ1&YblE9e_2uRrRZ+SPAN}V8Lh0BRz_#tauWZ`dgGJ}4;PecrG~Td4VhLm}vG9?BT$al4=k zwt}MZEHrLF3;q==i3fJ8J7v`;RaW7iWd2vhzUOf-KDRVdVLK#NxccjLqVYdvD>8|x zDIO+5HH{n#!Gq|hOwa8a0MJM_!I8M~6IDL=!Zj~S|E2Kea~l&gblu@| zZbIMw7xtiVk~7V3(r1U-Wk5*X7ExZL3YH;vISnHt{3{p(Nxni<-+OctRNaNnNg(Ku z7J3Ef$b7e7-}rm{K?*c}`8B^+zY=LXX)u&9rs_=CTpcIZlpkjggom6v4SNo+OGK`; z)lw*gV8rH{3LDnFqbCZ|x(bVx9Q%Nx>exb+s9_PJpQbpRzKyT1)og3IBf&Km=}7a=A)|S4q}Q=dYXdAj^jpIx`o6{-(^x-D6gK;8z22ZhvKgJc z+G6SKPGPnC{jNIV#->H0-IZKz^8_HxxiQ&~LnFrf^V4~A;urIWztM2#X2>ErXgooU zb*s=s_;bc~_AlfB0|2o+7E=ZD(#aq;D{b+>Q>J$f^;xgok5Q-5yg3CNi+m976dS>p z0}>jai|?SH4x){qcZ+Nk^@M_|!!Vl-)^H3k(a#5^r2!5TzZ8vVXm1c;_img6f~v=T z5Fh9}_@7F(nNuwz&!{f(zsLp5-8w*BY#&;BI_lz_CG)TJKJy6%?$qyek&d|=D0%x& zG01js19c6c3<6D9#nFa2XU~{j`V^^0YoYBvt?5tZ3|6UrBBOz=g?Y~HprK(r39ZYA z&(WD(ifl+Ga`c1Vz<*248oLiA&nlV7rFGX78yr0XjthNYFYAJYNFD1`RKFi+T`D2b zFjjO5gM`zJ!b9kSXW)4Cs~*6>0sP1o^q1+wi`nLgG_VLx1sPH@BDMjccwI5+W(D<{ z(S{X7&>_5#ZR-=tJx2|LLnaoFmPpcs>Ib#atr)_d_es{i@eaj+vYi%^aGM6B5Gfg+V;yT=aLUj?Gt`oBMpB;zx;iQYI_K)~ zO@Nw;Ig1pQ3(Tr35ZO4=_Y<}~8^dz48$k%;2VrZ719*NmzUkQ@6X{0cx&6!d1SbFY zIuRAkXqmcAaC*0)ou+2jUD-6+t^WrFsuNDS!T~b1ctJSQ2B!a`I^b5?pbt6*f z-j4m(>PZz+G4>L0x-fl9ujO$=oM8+sfo>gF-}&niv%~vuj^LenFAbv0O6_o-%+*FP zeN4m-oshjHQ#xSF*Q_g^HFN$RM3%!-O6=Bd)z{ZzVj0fV4SuNpLSm5VKp@UWg5sxZ zjUZ|4#S5wlL=+qltW(MPdd)Xfr0W)9kMt^<%!(p*9&}(`fE*Pb-Yb9$2BmJiFzrKL zGQaq2M2>P5L+0?ZLClKh#Ix@yt4lq+u2w6#N9@?NTtSLht|EEYy2QrHufW+yRkw3- zVRn^lk`MUH+HW4^|2o7-nLJAsX5MmZn9v)6+ERUof8IXxszPTv#I})Qxxh(Ld71_Y zL~%xpFd)jX+|Q@;+k{hcl3t!9h_!&5*a|&`prGCNaudychV|t5(?#jClApdHYE^!K z-))y%U6)|Oo~7p%YD@AXp@94;t;0|Pmxmlo^IL5_;99i%Y~RPau9ce#&sU+r4m2<~ zx|=+79mv%fvyrK`u2kX9`(x!D_tqnWRG(%Vftnv2twR8hdGZc=rP+`6cu0HHtxjrt z*?yOV43BUdPB-IcDj@@6(yiX(X1~x!$$E2XONn*QzRg0>UTG7p6w54P&(v&$ndR{A zL4KU(_jb&lp+8x$2cC=btC{tJIVPwl-6g5MuP6nCi!-7#5Txe=YNMO=FE*A=930LC znb%dgz+EO?wsROsKU<5+7Im3vNH&vEiHec<P1Ie!Spl?lr>5Fix~$wtDNg{;iaeV%)A6~v5pyMQU6i2VBZGORjX zw2BQ4jz(Pl)JMx*-tto0ZO5i86O*HcDDQPcmRITIAwmwi{_ zJ97oT7A9{W7RRG4d40i%Ar%0L@rLV&3NYT}O@3sMG@8UCABs-{=9XLLt%yZ` z$9isVM|(#YCFdt1V7##}Bg4K$9~DVT^NBS@wduV&+B`#SKe|H8np%CeY1(2~aJ2ov34{;#0GZfA8bYm7BiqQB8m-*+eYeilo}fsi>}xv(GS5l^P86>Jl^_%RKQ7Sh~MU`LM*H4 zR^O2Us!7wbDHKm+@i(&RVYu}-iJ`jWj>Gwqo$0@4OgHNU8+q6#5*;jDzoszqhs1)t z8aKpJBCW!!yf>}WR+8y~@hiL{DXI&KhhivIbv7!SJmA!^f&`?eRl4Gw-EzP)G(Z$Vaia0T4-r zt>(h}RV(KLR5QEs0r)iti6xQar{l7PF$o8t-nM}0?K9Y8%?C&*Hf@qY0Y*f83OwDI zd?fF1jy$gWkg**%p^IcBtU1=FBv_NjWKGYhuUlOR-+Q`99I&py&!HHOIK)V7cL@^t za4`X^CSRxZVuD1aWs&y7wI^lsdNsJtU%wqvCkiaW%uAxkBwZKx@Rdf4tOwexAh8a5 z=RLHB0^*>h>2N#o2=!s>zNnjaPAhv#v7q>kKW|@k!8r6QO4^>cAFN5yqHqaKH|pN) zU5urvlTB9FQ+dd5*>KL$HuYYHmE;;CJnVLi#OXsaFvD6fdjs13)_u1(8Bc^*700(g z^KR6t2;bEO1OCwu1_Q-GhKc!3astLR3yAguj2=sTGK?5*td@>0;gP{Iz*wd6#me$yuh&5)obQ zmb)G@L_+-(*!bymARCRH<)zYfqdFDENX?hf8W&VJj!N4rDw5vUsIOuJIQIFg9Hi-irs6mMy&@5_=u{dJGwOSI+Xu(mm@BI0=VTU z;?`T8oY1M|t572Pab){i)W!MP9{q(GnB?&X)!i2qZTLS0o}K1H5a|}nl?L@O{H_HR zeqo1xcDfgmf`i*-RELtd?h_r`qmVP;SR1~@akG*3v1)Tx;Y&-S`?oRsGPRmxc)5Po ztOKxfTKnQ`TdY*Ud+?~t?Uz~^u-j?SxR2ht)VLCB0t$(zs<5HlO|(573R`C}xPpjS zu*SRt$i4t>R&_}5I(rfI!6rCGB?c8CA2gIFc9<3Fm-)iMe ztg-xxlO&mUA@mpDLbkBb=Otl^+L8TTeO4JScUm$M@s zS*)KA2uUA#e|6E1?GbE@LvV=pWsMr#3Eu~`y9S_ixQeLIr#+G@gq)`)b|CkO)#`i5$3j+li?5l=!rM4tl*Xx>SX&6S6PQ z?L)2n>%Q82f#aQyn_kvu@U5;vP^6cJlyg##ySGx7{o!S^EBf#6K>z$2T`R>fRx?cF zHUL39F)VpPUmT%(`QD3bHya$YeVuRcNa02E8loiY9*_8>U8F6nj*?{i_syAqKc5=% zi$5e5n>ptwQUO#JVoRR_Gg1E{mj8)`p;TMuJotE;D(rZvz{`6t@o}=u4f_|jz%rs| zn@DuRa=^d1IH;A}y&Py39vwLx{0KPr(hviTXd#{o760%B@^0%od*Tuecv<3pgYTO| zUv6u~`H#+ivdrr^@?d)t>T0uq%*m`o2X`p3ZRAMKKb2oO{{*e8pdl}I3s5<&q^zE&SY6o;Xtrdi6q0Sri4upx%qb_E8z-69e!&{1U zfm+Nzt>;owu4jsTr5}9d zxI}){zSG@=LTwH7{-_<3JDllsT`8m&jh`cB<~x&5?=!>}n)65n#{o_>i6w2c$8br4 z7@$;`ufAZOMO6ja zTlL!|?Tg|yQaz}gs>6k}Zlsit#fc&Tf;cN)db43id>thpkgcHDTsaFWTtlJnky%%W zUqiEOGVax73VN&eEiI&eJG!V44VnGArB`o!Ej&cbog3@3RKgCb%Unv3aoy~29JP~= z#pZZr7fAPsw(!|V*l28Oo6imn=C|q1v+N46FvMRynAEW-1IgR3H*O#rbTGt9cNi(o z=?;8WB>p1zFAp-u-mU5*_H(`Q3;|jixnO@@;UBE!6JaWN`4OImr{0~8q)08C_mjHs0-B@z3qd1g|7+y>%=K+AFyzwO>M|Vtl$ydLey(d_- zMFZ-MHwN;N4L~0#+$=J$&5lcZvw8}E_%$wGdodOTgd{*E1+Do<#b&@CSHL2>@HfLa zVkzp)@Ud;`1OCb}h@XJsxXfQkg&qb9%_V(l7ZGDA6Rw04$t>39BoBt!2rr~>57Nk6 zXdo7D{{^liCAN9?O-#V9^zyEud}5wd{$*;dM{l2@Qdo{gAqS8-2lG{i4FkfW!%hH$vjm{e8%gS0ZmaQE5pO-XNyASuE$hGY*VhkA9yXkjt!Mthr#Yzuh)7-YyR(a zI#2lRFPMJ1cbA$o0tlz9Vbr_XFCGw_W|Wg)=QD!ue;vvM!oy>dkPdh1g^=GHh?nH9 zT3wSL#AQ3ukkBMdi{7`S7z}a4Qm6bzYnRTFgJC|OA{xTtbL4H6*#}Kd5TW*3DpFjI zyR5~Tu9@TtLi?U4-(c2!=(5iC_dCe6`nO_-YWXrOOl{*i1UM4txU@6xn@Mko`T@-H zZ;TkMnVfo+*h}pbMh$!n>9G0vNj93{(8(Z5R8BsFK;umQYwWH!HW}l@7m_iag0H0# zh7*@Eiji16!h#SZ^!t`|>JNfck8Xv?GV`J24b0OQqV4mn2>sK4XVJx2D$)wyyY=nr zM#_UEWTFUwS$L3TZoYq}7F7-w8L&z~VRgYmDDjTX%W#ocl?aq-8pbMQ*J?{U`ld5p z(`>fvwi5`3;t&qweU`i&TAc#h5U?2?qXuUj)XWoVA z1M0DidCVY8N*82d+sc`|P&oCP7=34JYEeU^PbOFYIu0vZ|iVvE{f}zu{WG#PC2V!7um6D+)6%3;u37y9YbFElBY8MgsuuGD;N9p zvR7Nr;SUF-5? zH&)_P*G0|Yat0A(QvI&bgNe^_7N*3hE2=LL;dbn)HhVu*uY=Fr-|9J|=ff=9iJyn8 z))`zQJ7a151EUw8aK*x-U?>}!Yd6gXv&xj3{Tt9F4Lz9w(Q|SBp~ebpCuCQx<`D}@ zbFO+#xGK*sfQb4>4P=IdXX7havM21qWE2s3Ry)};{Q>J=fZ4*gv$-EZE6Ykex!_(< zRWW)PXt6X!9UCKEr~JVaN|RK8v&JQXZ#8giS4g*XuqP=3)liye6tjrzH3bbOXpzh; zje$)NuJj1@4jJPbUh|gfc~GBS|Hg5Q@m7|dUo9Sci$BGH{R>M{bggBizaTkou3y4c zRSt1%%m@~H9Y5Bq?(8P~l;04F9I zS~|%7gq-IqmS}YZdA1}`S(s`=Jud}y6l;b&!Q+J{Cp#NNpS+LA#cJ!x{J&G8wm62ujRTPJjZbISn=n=j-}bd1!|QGOGzjDUX*`m9x~CJVs#$h+rL;Y_ zB$x76W9qjX3FT@cAhg(cmh(lpC+1jOUlNxADM+iS}|j zyRKx?&k^@_%pIc9p-D2O`*m=`P0N@#O%v{J&b6u*9gy9drX+hIXw{bY7RIml9P6Ta z0AAsl;MzJ)l)BD>5uk}6r&1r2o?Q1>S5LCsi|4bb^UKM9n$2)frgyrXb!IgC=lM-7 z{$wM&@qHc!vfI+=P}J+$F(vsY@r+rIZwdU~UO8fb>nF@#mEH7Nmf|YwbvOr`jh1W6cfhEJBYt)Dz75l#mX&E{LI!7KY8U|e%g8@l^{h%8?Cdi(a@A> z$W3(>_^oUbm7S@@qvku8+=WlDjDr_V5T|sag!9_qc~faBxBfpBHAaI>>=e4AvNo$d z)jwF}Oo)z^s4?zB1p7j$t#%%BL#`|P2zntnxl;=Es3`i>eyOVc*P-3ixU&(F?*wFT z_gdcuS%bkqOcvuaLya)iq@XkfoqjBrYjO1A{U*}0NzsAMAPA?Pu@Pz_$XfKypR>X^ z5r^~$Zr`EeO;)zqiXkpm!yr${qvAlJ=O;@};w7w+#;0@1`3BG8pgnEBfaR6J>Ar50 zsKKu5caC&{q)z4XTDfghMcOTFAce|K%@y*Zcd*!NWk3wlrATddr>FJ3K)_`%<26AW z$?MQ@?!n2gQRN?%8Sxh$Q~1lkeUOnpA<7H4L@aU#=>2#43}|4d&PT|%`&S656an9! z_q|4cIMYit*QOrCB@~rxeO$}_b9+TdQ^09j;(frLkCJ=0HNok^#PsI6J|1uI>f`a9 zgKP2W^sUpTzAdZ`sAnyGm{wX7s45%kQF>qYXKyMCDVuXpqUxZUrW&OW}itlrO$_$JYEZJAUD*Qw^W!8NF?|mDY-n zQurwNVulR8x@2YE$R18Ptue3T%9#}4>9JrJDG>-}DI&w<#CV)O2~yG}Zb7X_w9O}G0*FvB?q>NAZVbl#|%yeA!8u=>XNr6vnPuZ86 z^>D~o1n0sSZ#`wGLI0<0RVdH0?wbUGB*8!JoL+#vSE*EwfD@n3VES%&*4&M3j11;Z zU%U|eXTrCrG#Pswc>{lpyydSbT$%hQ(+nA^k!o^}45aahdd{EELK!A@V=crrQ`jLG zvc}(oryi?=)#&-_SWqqlzB`(>us%n8PYlZ3S(wVKnb zUCj+N#l(!9F+Mie$s`m-^#t_af9|b=q@w(o3Z-$mwCK1_rr~7V-y9;NXQgoPQqOpc z-<(!AxYoM(%DTL4TE)4z9!PD!x^jktojSP>pfTUX_XupJ;Cg}+h83^P@0&ozk9krZ z$WjdH&WJhJzly~PxUff$^L;mL9K<#IUI-m}wi(AKdHGvJh|bL3ZDip+zp?WPs*#U) z?C$HG4^1Dt1wi*NpqJuk7rgLy9mGh>>)6*Org3av!{Bgwh+*)%-_tncR@MGcqNH4R zxFlR?R5G_7@|>!|AM6%Jrg0XAJRc+~y`a7B0g0UzW;l&*0tR+<2DfJ3I2lv%Sk6<( zHnKi(!gaS?D7iArLShoja`hI4hWy-%VlfFs;poXx29w)ESTtOg^aD{OMjIQY2^Xvq zG%gmac*ec9q5Gnl1%<cOsjOVKWp zF|6zAGi3e39lWn8ltdMM=UxOFv#z%0E<(>yjP)wA^hy4+$c%vE4b|2~@dT;GpHg2g zqKueNY5E()Eab4Cd}$vz6l1hnakqcm^SK-!1WASyt_0Dq1oQbQR(e$VbZf*G?cIXD z^mItJ)2p{tc>j$$)y{R)i+l@>!=22aYN^TH)I-5}i&(h&v_RBWb=$$P4QJa2XikTS zH(_fRuEFQ=C+ySo(KS-A+=_F)5?!`toJJIaE>j4dKS{PGBhLYafCxhu;#K&!p|mfq z-5q+kM5Uvw=wnHEFZS{`^Ku*R`|PcZhHsOxRKYmSZ!b0BgC{cf!r_3?mS!6(MjJNG zEord+#ulVT9A>KBI^MI?UBFquP{~$_H_&(9GGHd?x?S)}^6=a3rdjWwxvO6hUsaKE z3F7l7=ID@HdS8G7DDV_>qZ8f4e#VN#0w@MJ8CKy9fB$A7(Ta2DO6Hj$3?$t@LM49L ze;rtH@|GpT*CK%ATah{7R}J?E?rCKPp88xj=6u2(T?U-gr~MJ6P0~swZEydfI)9VL zt5mmr`e4K+e$@Uo+7>k;jt~ip(`EaGg#V;Vg?0ZmimBhA?r@}36pW0*c`e#Lp8`$_RgmR1nmCs70|W^ zvug@36)kzpm1i#=k=SE*OdVrSj`9dgjrv-=Onp6Y5OhwL#&~5utalfH_%UDJeGArC zuXN{Iu^Ap*1%$B30gN$cr@nsxW;1gq7hF`re55-1R7~5CM~kiGuUE1VDTriZX?3oZ zuVs3O^jrz!h+Zweo6yu55;6<$od`%f%G}k;7cMjDD7+1Q*5HXFTDmiMLF!jOsPLP= z9YU?`pBCNzW+_*MK$E3nKC~m;akEML9rH#kC5iysa^%Ip-0|nL=tX(=>E#;|SSSf9 zN|-E;b=pGBZa2xHt~TQ`cswl(wYMrT7vyf7kCIf0=|kkIyFdN7cPE9K zrE9}4@00b`@@<#@oIDl?RQh2=hIN|>^MXCzwBWYGN?Q}JZi}&)=AzWEHTMZGGs%#| zF@t_Dp6_mFt@m)Ht2xwP(r}I?ge`Jo=aN$`4;MLO@Vf8J*2U-BL2nZ#6``?VjA1X- z=Xv?N;(Wbwxw^ekluve|6jr|+a{)gS^J_JMu-3Vdb0I*}yN4QuO-uDDbue|XVkh{} zHp9q8i-g8FwiffwCHbTgp_!la(F<%wI_XLwJrj4lH@13bZJ#|!;og0#z||n15p^+N zmi;2%Z!i?u{|isX`Rl1pLJ0?Lm?$gCl!+uQ zc`|3;J0JSO%Pbod&XwH_5tM{UV1x7VwB%9U`ZZiLAGM{YkBgHpN9x$)=Uy4FF`R#f z%+Z?dsCaIz-q5w7))$MnNsD#=LqAR?qpnMWH zd#+KfXcY;<%#@n+c-9`{@<(}`GhugiY9H<52R?qc6Qz3N@Zu&e+XXCwNR2&$+zQjq z*C3JxRW*#ty)e2F?B)G&1%w8wj*oW>=oGJW~#UN7qRrY3%9FBDkDQ2{5 z0XE`8y-+*PA`?|Pxpr$K;>5V%yA3adwPz&rC0woo`A)@+l@G37Ej2!NdcTFp;E-6* z`2FMCdbICO;OREghgQz5S6R_E9ko4w!zV+ZsETI!#P7Kszbwx>jytXHN!Zr z3Q{tk*$~~QL*MFdYo0JBr?atdxyi9%W5&s@#aJN&bh1@MX^S+$#4K1Ao@+l~yA(K3 zV?`;&arEF)k-%1cFTPdzFZe55F4Zm5extZvWYd?`+KPm%-1B|Sq2XT>;&}&(Aiu)P38IzRL~+w&o%12sru!JT^#Dgl zqp`<)%uV#1IigetFUd%GQV(%MSWFZ-i|nnvKMRt|URRm3#b0>aohDkDMd0R`3ftFr z$)lxLVZ^wJY;5!buJM(V26`J2tymgiy$8jmnpREi&gaPuQ8x`z^-JX&*7v0X3~>(i zR~1^X=~(uAc5o!!!PUXHi>lfG(wrjpWiHfpKd`QDyXIljoy~p3I3ZoPYe%wQgIp9< z;m+513uf=FB7GSHd?+gG1ug7Y2!nCz>i{A*al~DNXmm=ZXm0}&qg&ak-0e5-Kkfi~ zrCM)F+T$!=cK`Wb8pp#$7S7kMqv<1@>wH-nHk%~cC^^@7S~lg3T(W!?$DW9sS>5mL zX9K9|0K_Qcj%4I!=EW1;GG=uVqWA)Tc zt{J1RPxc#K&e*0+9)QjADmpyp3Wx8I{53x1_?Oh{=d=cPVV9u=JY=Z4-ZeOeb-l zlrZC5`*p0S-j&?nHxPH$4z_J`DrX|%Xz%e!evP?g1qJ-Tf;$6R6_o6v6-}J01D~(o zo2rGyH8zag{pao3czqfpHLsrE?oQa3(pWGyd&5k>CBF3wrBrv-!FSW2?JWL;-iIfP zRLY0tK)FsiV7=nY`b0oqo!9u}^*T36yWyjOC)$8hG5uOh~=TMi(R`bxAhZq`# zyX$vRVLzps<}30-dK;wHeBOSPt!o)rEsbb;kH zNt+ep-v~~bJ-`$3^-v2QlZqim)jGF&Mw0nK8Wn;unEWNHN5N(92mcd+!5|(mL{+7c(@73DG zzW>>tBa^ZPRwH7%NXYr}BauQ_z9vP#)}8mgOlzZBmL3arHSSq_zt7s&GgRM^x6F1% zPha7aY7R3jZ~Ees>E08>l$Aje71SvFin)NG%8Udr#0uyA$l zgd<~^k90uoo@v24z4`-o4oXgSvF`0AzKb`R%OlZG&@op!NQ0Orl20%>ESBf6P}Y=; zEy*5<%aQsXhDM~eI1>((hnYWQLlxw-$@9XaNS>h$wE53sDkp!$rcgWR_1bQYHw4}V zh-oM*80UOfYOe^!)r0(=SHYB^cEhCa1X5P#8M4*mYQ*(zSaL>okVjJm@W$OO_sz;0 z&n&EPbz=Lx;YL2(?!N7(k*ARFEc2|(|GX73OTPE4Xp4XB+syB{_$&e@QFb`9e#Mwo zkJf8ITuEfURf z26d`)kz7GC?byzxIHKelC4KjRFJJ>St+#Ne>f-Ti23{o-Yd%M3Q;7$8k9V8RX?t`8 zx9t_JXEZ5Z{N@aYH5nb0qq3th9n5L|EG{BBpL&qVHFUN)GKk+1EiH@`>} zs(WC{JN?*xY_0rJ%#Hk-cP4iHb!7PNhs)cGU;Z9ad_Q;9?m`njvkAeA9lXy!ZncS| zT;jK5k0<3TSG}_N&w@?Y-!Ye=7I^m;OKrn2fI?Ppm#dJOYtJ#{ncJ^;L|Db%^O4st z>{coAn*-|hNgv$MQ&;iOqv|@5@X>(O;J+3@(mkKy&@u@ok*)xK%|u#3L*(W)jVIia z+6Ud_-dD}xVF!!Qu?#pmdFFWvo2UIPW~e+D`pXE1Nom1^2OqkMLLIuJ^}w_709)7A z_y;#Osm@#PiW`nk$Wf-shqUUFoUr}X$yn#Mt?T;+ql08l&+2+?kar`+y9Uzf!>qR4 z`M=7>CmW=vn7)|9%F>dZ(FLY;BRq&{&42Szc$7Hj;`}uG@BM?#pH87I-fh3``R1?r zf4NuB^ga3=7wHRrv$jWA(n4MHQBP9tTVVw+l1N1+H?lq7NKwh%RFk}l_RDuhT9%4< zk!t7*4bm8jrZCR&fW)YZC8**_K9(^`)JG5L+Oza29qD2Sa~-P52{RTlrWs8X*8bK= zfadDJU12<09Y2JX^ns7pA@Muh!kmExYQ{WbA5G@L5Eiy&#-%Sbce?~jY5BXCrK-~K zL>ZBxlt40eo` z7ZPiEy9QMC?REazhfT?gC!@%U$MaxiPLAxiQj-yx_PJP=#%Ok$udK;|ofJ)T*bswkTR!3flc=(g6qcFLr2A9H0t0S=LvT~p+QR(aqWIVt zwDZC-``0?-sj_v|KcN~I#qIM~w|umAhu{7r0}Q0`=?e-!qvAK58Wo+BFVW9$?OW+T z6T*7?%bk?}+7C}Iw+Rs7+G}3i1MBFfNVh2ZH~xsCSe==Aziwp@Q*Ad;%U4~aE+=p3e~v)^OWZz5yh*Rdcm|Gq)h6SdYv0}p`$jy*Ykc$;pHXqcz=OF7^%1A8+qW~n zv`0FKJ>a6_kELYE)tD91AfZ#c(<1bTJ;gci@NrUx2VsXV;^a8vj6GVlFOJVsCk*j_ zoI{?|FLu8B69rx?xJq^-Kkw1OcLwbZ6kqh3zj?p@q!rf;4^2AeXWOaukQB@>)1jmM zg7P?Axmiv|%#EE7U2ioFQn%b!iVN7R)?-i#t{h&tNN>L#$f4(4b^N*A^+8k01Aht7LV~v}Tp-8z`K0C_ zMGo9*f8y8tIduEHSfA1aGo!)i<^CnC4eW=|JwA*L!f!RW#pZAyERhO?K(@-lTU1vEoxUh)!%LLCTr^Qbl6V8tZ zRbUEsSoux{}=vtuaCT zMbUTW#pq#le%4iV!sRhb{3Kut-Jy8o_+i~m3<4*z`*nop^&k4EH+;$VULAUN*-~RH z3w(c;E6A5=q*LpzhkrL?HaPyIiPB?1UN(4pmIo-^DrfUz7lI(@CSI|9laZPVzG}RkAI?U_aw^D0#)edkx%Z89bC6AI$@> z9|=q4HOPe_pqXS+Lfn`C^a#vPyL~NG#c%Vo)WTTxY7<$@gcL{LF{scB6_r7(cHiS> zs0p@Dj!(;*3(t7fpxeVIR-V}@U7A|tF#D0AjY8ZpY$$llYesmtyhpw444#||6TdF! z09{RYB8NJ@_VS)9=c+8fzg;k4IIwYoAj9BYiHCF-PP|Za3~C5?L_4ktJ67Qgu@{Qs-G2O)g7KNq)0TT=cPT}kl4 zt;u?pn)U?b6&I}DzpvqX3QP^?@Wx9Y$nu0FZ`jAw&G2EJi`9MD8?OXd6d|e&|5`qf^ z=((&DOo)-JuB;A*<~&(RuI?=o!mnhF7oLPo9B2A+iC3r9R;zm2+AaD^8M)bd?WL{z zPmRh?9craW2L>>>F*4n^fUuZ{+Dm;(*EGU%))yp+2eafYaG&L3VhCGwLO?zqmUU4HEE{u&=q)N~DwO5UC@ro3Sw z<`i!fDx0S7F@3yG~(|84fAYzCK;q~Pu#uIw>7_d=C#@T890JTn5!fd~3)WIM6 z%_x6*I1RiRI3;Qr;%&qnC{kZBl-c$0!tg!q)=!Ys1-Ad}_Rn4)zb#v@ZP|>SA>KnQ zxglfb<9(B=EKS(az)V$W0sVE)ID>6rQt_;qyA8Bnf3CFkfZdB3=BgCUBe=M;^><@A z>--uI5Bg}WDCMWGuXZyWJ@~%uayP!3Aoo07I6rR>Jef=uq>6Yd%slz9Zk(QHJ_lF zQ62fgu!y(B@DJ>E;ut99E9=^TDV@`A&jCR2qaG8itN ze#WT-cA`E5g&7Uono&1fxitFlTJq*cE{pFixj(NeI01**+tRa7wC5q*?+ytKV8M988$gL$u=HkREY9vPu#;$iwriE3v|>dtph4|kowp(car&4H+hXKXG;59eYCk)Z{}S((!mf+r0+SpHdc z&P&&u*syCUN5C0)dCzL|eTj>D*Y?8`LuMXCEPBLDHLgqX$ZkiE`Joj}@1{c+_|_O8 zqZ*|!VdwVyb<#`V396FBlb;Vip#c}<(k-AnU&2Jv$4jAMkIx0uV;@QRTf}))T|U-t zNMB4y;a~L0i(20?usjNsdS^T`p0rYLIBp$%?a!2$h5xQTGP?E+%N{{ohOtX_TL8PzeY4YYR&RYe z3n4{EN2%2hUEwQFPY!y3`itRYgY|Kek7aZ`*dGkw8ksOChTA==D zRFaDf0)CQ-xgJ&W$RVF?LDB+3tbc*Q+gtd?RO-#fjK?xXIC^|if|opbTF87SkU7_f z>&cfhwLsI;mnp?jR}b3MQaA>;zz60z&3GU%yh*Su9;w}~j%Jt17KJrFCFV!i= z*A?3V$9lSMg!k$iBQn>>QIV7kJB5sI%Ohg=E~@k>(t9O}ts>+11$+4kKGx$Lf7re7!bG?#@ZgW26Hf5`yoB zf3@O~BwvCb`YwUXP}TA&3g+p1s!V<(X7>bnu!+@v#Nt=s_q2}MWd!NmM=~5&KYOOt z`||eJsZLj!u)=1=+(>-`t{Io+Axf!VU{X-{EEq&xgH^aaKwbu)0MK+R0xS=pUyFFk5=-XhDQ7VVI@Ls0Sua2M#QV1L_C?jyiuZcG0G z7lvB{uNXN6+;AKUJXU9?VEXJG%h$#2-32;Ssnqo9j?I$pJ^uYo24)lP0_X14-W{FO z$W)79^w=^<^a^kl$L6}Dm(Fh7?_2X0IB{fVC(FO!xq!ljVql4U{^VZZ>GyKXF=6;eseo zcX-6yDGpJL#q%yNi+d0&5+G3~czq?OfPzB<11My)6V4Tv*Uq)=Z#ZP&zs}VQEXpAu z5dqY}Znl-_^~8ol8{99%wSiP~0JSYB2l?vUEp6U5U8i! zsky+wXJ(nBFw_!|wuHS0wtV%~g{cJ_c0yx;!I>GQhREs`2nI-)Nz4LU1$E1)ve5uR uN=c(BWHigbiZ2d<(ZXT0aG+A*@F8C$@xhfAn~Qx6K;Y@>=d#Wzp$Py;{aGpi literal 0 HcmV?d00001 diff --git a/docs/zh/resources/README.md b/docs/zh/resources/README.md new file mode 100644 index 000000000..3c1229ee1 --- /dev/null +++ b/docs/zh/resources/README.md @@ -0,0 +1 @@ +# Resources diff --git a/docs/zh/resources/delegator-faq.md b/docs/zh/resources/delegator-faq.md new file mode 100644 index 000000000..2189c8edd --- /dev/null +++ b/docs/zh/resources/delegator-faq.md @@ -0,0 +1,94 @@ +# Delegators + +## What is a delegator? +People that cannot, or do not want to run validator operations, can still participate in the staking process as delegators. Indeed, validators are not chosen based on their own stake +but based on their total stake, which is the sum of their own stake and of the stake that is delegated to them. This is an important property, as it makes delegators a safeguard against + validators that exhibit bad behavior. If a validator misbehaves, its delegators will move their Atoms away from it, thereby reducing its stake. Eventually, if a validator's stake falls + under the top 100 addresses with highest stake, it will exit the validator set. + +## States for a Delegator + +Delegators have the same state as their validator. + + +Note that delegation are not necessarily bonded. Tokens of each delegator can be delegated and bonded, delegated and unbonding, delegated and unbonded, or loose. + +## Common operation for Delegators + +* Delegation + +To delegate some IRIS token to a validator, you could run the following command: +```$xslt +iriscli stake delegate --address-delegator= --address-validator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --amount=10000000000000000000iris +``` +> Please notice that the amount is under unit iris-atto, 1iris=10^18 iris-atto + +* Query Delegations + +You could query your delegation amount with the following command: + +```$xslt +iriscli stake delegation --address-delegator= --address-validator= --chain-id=fuxi-3001 +``` + +The example output is the following: +```$xslt +Delegation +Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 +Validator: faa1dmp6eyjw94u0wzc67qa03cmgl92qwqaph28lxq +Shares: 10000000000000000000/1Height: 215307 +``` + +> Please notice that the share amount is also correspond to iris-atto, 1iris=10^18 iris-atto + + +* Re-delegate + +Once a delegator has delegated his own IRIS to certain validator, he/she could change the destination of delegation at anytime. If the transaction is executed, the +delegation will be placed at the other's pool after 10 minutes. + +The redelegation operation is composed of two phases: + * redelegate begin + * redelegate complete + + To start, you should run the following command: +```$xslt +iriscli stake redelegate begin --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 +``` + +Please note that you have to wait 10 minute to run the next command: + +```$xslt +iriscli stake redelegate complete --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris +``` + +The example output is the following: +```$xslt +Delegation +Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 +Validator: faa1kepndxvjr6gnc8tjcnelp9hqz8jdcs8mvz7m86 +Shares: 10000000000000000000/1Height: 215459 +``` + +* Unbond Delegation + + +Once a delegator has delegated his own IRIS to certain validator, he/she could withdraw the delegation at anytime. If the transaction is executed, the +delegation will become liquid after 10 minutes. + +The redelegation operation is composed of two phases: + * unbond begin + * unbond complete + + To start, you should run the following command: +```$xslt +iriscli stake unbond begin --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 +``` + +Please note that you have to wait 10 minute to run the next command: + +```$xslt +iriscli stake unbond complete --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris +``` + +You could check that the balance of delegator has increased. \ No newline at end of file diff --git a/docs/zh/resources/validator-faq.md b/docs/zh/resources/validator-faq.md new file mode 100644 index 000000000..5b1003104 --- /dev/null +++ b/docs/zh/resources/validator-faq.md @@ -0,0 +1,3 @@ +# FAQ + + diff --git a/docs/zh/resources/whitepaper-en.md b/docs/zh/resources/whitepaper-en.md new file mode 100644 index 000000000..a1916bd21 --- /dev/null +++ b/docs/zh/resources/whitepaper-en.md @@ -0,0 +1,1032 @@ +# The IRIS Network +**Inter-chain service infrastructure and protocol for building trustworthy and distributed business applications** + +Harriet Cao harriet@bianjie.ai
+Haifeng Xi haifeng@bianjie.ai + +_NOTE: If you can read this on GitHub, then we're still actively developing this +document. Please check regularly for updates!_ +
+ +## Table of Contents ########################################################### + +* [Disclaimer](#disclaimer) +* [IRIS Overview](#iris-overview) + * [Cosmos and Tendermint](#cosmos-and-tendermint) + * [IRIS Innovations](#iris-innovations) +* [IRIS Network Design](#iris-network-design) + * [Network Actors](#network-actors) + * [IRIS Services](#iris-services) + * [IBC Enhancement](#ibc-enhancement) +* [Use Cases](#use-cases) +* [Token Economics](#token-economics) +* [Initial Token Distribution](#initial-token-distribution) +* [Roadmap](#roadmap) +* [The Team](#the-team) + * [Core Members](#core-members) + * [Advisors](#advisors) +* [References](#references) + +
+ +## Disclaimer + +This whitepaper and any other documents published in association with this whitepaper relate to the intended development and use of the IRIS network. They are information purposes only and may be subject to change. + +### This whitepaper describes a developing project + +This whitepaper contains forward-looking statements that are based on the beliefs of IRIS Foundation Limited, as well as certain assumptions made by and information available to IRIS Foundation Limited. + +The IRIS network as envisaged in this whitepaper is under development and is being constantly updated, including but not limited to key governance and technical features. The IRIS token involves and relates to the development and use of experimental platforms (software) and technologies that may not come to fruition or achieve the objectives specified in this whitepaper. + +If and when the IRIS network is completed, it may differ significantly from the network set out in this whitepaper. No representation or warranty is given as to the achievement or reasonableness of any plans, future projections or prospects and nothing in this document is or should be relied upon as a promise or representation as to the future. + +### No offer of regulated products + +The IRIS tokens are not intended to represent a security or any other regulated product in any jurisdiction. + +This document does not constitute an offer or solicitation of securities or any other regulated product, nor a promotion, invitation or solicitation for investment purposes. The terms of the purchase are not intended to be a financial service offering document or a prospectus of any sort. + +The IRIS tokens do not represent equity, shares, units, royalties or rights to capital, profit, returns or income in the platform or software or in IRIS Foundation Limited or any other company or intellectual property associated with the platform or any other public or private enterprise, corporation, foundation or other entity in any jurisdiction. + +### This whitepaper is not advice + +This whitepaper does not constitute advice to purchase any IRIS tokens. It must not be relied upon in connection with any contract or purchasing decision. + +### Risk warning + +The purchase of IRIS tokens and participation in the IRIS network carries with it significant risks. + +Prior to purchasing IRIS tokens, you should carefully assess and take into account the risks, including those listed on and in any other documentation. + +### Views of IRIS Foundation Limited only + +The views and opinions expressed in this whitepaper are those of IRIS Foundation Limited and do not necessarily reflect the official policy or position of any government, quasi-government, authority or public body (including but not limited to any regulatory body of any jurisdiction) in any jurisdiction. + +Information contained in this whitepaper is based on sources considered reliable by IRIS Foundation Limited but there is no assurance as to their accuracy or completeness. + +### English is the authorised language of this whitepaper + +This whitepaper and related materials are issued in English only. Any translation is for reference purposes only and is not certified by IRIS Foundation Limited or any other person. No assurance can be made as to the accuracy and completeness of any translations. If there is any inconsistency between a translation and the English version of this whitepaper, the English version prevails. + +### No third party affiliation or endorsements + +References in this whitepaper to specific companies and platforms are for illustrative purposes only. The use of any company and/or platform names and trademarks does not imply any affiliation with, or endorsement by, any of those parties. + +### You must obtain all necessary professional advice + +You must consult a lawyer, accountant and/or tax professional, as well as any other professional advisors, as necessary prior to determining whether to purchase IRIS tokens or otherwise participate in the IRIS network. + +
+ +## IRIS OVERVIEW ################################################################ + +> The IRIS network is named after the Greek goddess Iris, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. + +Contractual relationships are a fundamental building block of human society and the +importance of blockchain technology lies in providing a very efficient +and cost effective way of realizing reliable contractual +relationships: for the first time, trust (which is also very +costly to establish) is not needed when multiple parties participate in sophisticated +business interactions. It has been said that blockchain technology provides +the most important elements for distributed business to take place: lifting network effect +and very low transaction cost. More and more people see the potential of +blockchains as the new internet of value and will gradually transform the +current business models into more efficient distributed ones. Especially +the token mechanism embedded in most modern blockchain emphasizes each network +participant's right and will disrupt business in its current form [\[1\]][1]. + +However, blockchain technology is still in its early stages. As with any new technology, there are drawbacks. These include limited performance and undeveloped governance mechanisms. Presently, these drawbacks make it difficult for blockchains to support real-world distributed business collaboration. Consortium chains, such as Hyperledger Fabric and R3 Corda, and organisations such as the Ethereum Enterprise Alliance, have tried to address those performance and governance issues to make blockchain technology more suitable for enterprises. However, today consortium chains are dominated by huge +enterprise companies. Furthermore their close-form off on-chain governance model +is very inefficient. Without a token economics model and the +openness and the excitement in public chains, consortium chains may be viewed as lacking vitality. + +We would like to enhance the current blockchain technology and +make it possible to enable thousands and millions of Small Medium Businesses ("SMBs") and even individual freelance business service providers to provide their services and enjoy the rewards in an open network. To achieve this, we have identified the following challenges and consequent opportunities for technology innovations: + +**Not all computation could or should be implemented as on-chain computations such as smart contracts** + +The [Turing-complete](https://en.wikipedia.org/wiki/Turing_completeness) virtual +machine provided by Ethereum [\[2\]][2] runs Smart Contracts gives people a lot of hope of developing +decentralized applications. However Smart contracts can only handle deterministic logic (so +every node can reach an identical state after processing every +transaction and block) while huge amount of existing business logic that +is not deterministic and might vary at different time and under +different environmental parameters. Especially these days, business systems have placed an increasing amount of reliance on computer algorithms, including Natural Language Processing ("NLP"), machine learning, and operation research algorithms, for decision optimization. In those +algorithms, very often we purposely add some randomness to make the +decision not to get stuck at local optimal states while trying to find a +better sub-optimal result. + +On the other hand, some of the real world business logics are meant to +be run once off-chain and shouldn't be implemented as smart contracts +this type of replicated computing. Integration and collaboration of off-chain services and resources with +a distributed ledger is key to further advance the adoption of +blockchain technology for more real-world use scenarios. + +**How to reuse the existing blockchain resources, including both public chains and consortium chains** + +It is infeasible to use one public chain to address all use cases. +Every day there are different chains going live which focus on one aspect +of problem solving such as distributed storage, asset ownership or predict market etc. +According to the coinmarketcap.com, there are more than 1000 +cryptocurrencies currently active on various exchanges. + +While building business applications involve handling storage and also +different source of data feeds. Another motivation of our work involves +how to support building distributed business applications by reusing +some of the existing work like storage (IPFS, SIA, Storj.io etc.), data feed +(Augur, Gnosis, Oraclize etc.) and IoT (IOTA etc.) provided by those +dedicated blockchains and not reinventing the wheel. + +Besides, there are many (near) real-time business transactions do need +more close form consortium/permission/private chains to address +performance, security and business governance requirements. Our vision of distributed business infrastructure needs to have the Interoperability of many heterogeneous chains including public/consortium/permission/private chains. + +Inter-chain technology is a very nature answer to the requirement. +However, till today, the existing Inter-chain technologies are mainly +designed to provide interoperability among existing blockchains and +focus on token value transfer. The question of how to consume the +resource provided in different chains still remains unanswered. + +Comparing the proposed inter-chain technologies like Cosmos [\[3\]][3] and +Polkadot [\[4\]][4], we find out that Cosmos provides more mature base for +interoperability and scalability. Especially, we found the design of +"`many hubs and many zones`" and "`each zones are independent blockchains +having independent governance models`" from Cosmos provides a very +suitable architecture for modeling the real world complexity in a SOC +way. To best reuse the existing framework, we present the IRIS Network, a +decentralized inter-chain network composing hub and zones with +implementing a layer of service infrastructure based on +Cosmos/Tendermint [\[5\]][5], with enhanced usage of token . + +Since the IRIS network is designed on top of Cosmos/Tendermint, we will first discuss Cosmos/Tendermint, summarize the features we inherit from Cosmos/Tendermint and summarize the innovations we have created. + +### Cosmos and Tendermint ################################################################ + +Cosmos [\[3\]][3] intends to build the 'internet of blockchains'. It is a network of many independent blockchains, called "zones". Each zone is powered by classical Byzantine fault-tolerant ("BFT") +consensus protocols like [Tendermint](https://tendermint.com/). + +Tendermint provides a high-performance, consistent, secure BFT consensus +engine, where strict fork-accountability guarantees hold over the +behavior of malicious actors. Tendermint is well suited for scaling +heterogeneous blockchains including public blockchains such as Ethermint +[\[6\]][6], which is a blazing fast Proof-of-Stake implementation of +Ethereum, as well as performance critical permission/consortium chains. +The successful stories on using Tendermint in the permission/consortium +chain domain including Oracle [\[7\]][7], CITA [\[8\]][8] and +Hyperledger Burrow [\[9\]][9]. + +Tendermint is used as the consensus protocol for building the first zone +on the Cosmos Hub. Hub can connect to many different +kinds of zones, and the communication is achieved via an +inter-blockchain communication ("IBC") protocol, a kind of virtual UDP or +TCP for blockchains. Tokens can be transferred from one zone to another +securely through the Cosmos Hub, without the need for an exchange +or a trusted third party between zones. + +To develop robust interoperable blockchains and blockchain applications +with Cosmos Hub, Cosmos SDK provides blockchain development +\'starter-kit\' of common blockchain modules while not enforcing +user stories thus giving maximum flexibility for application customization. + +### IRIS Innovations ################################################################ + +IRIS network aims to build technology foundation which facilitate +construction of distributed business applications. It goes beyond today's +blockchain systems which are mainly for digitalized assets. + +The key challenges that we aim to address via the IRIS network are two-fold: +* Integration and collaboration of off-chain computing and resources on + a distributed ledger; +* interoperability of the services across + heterogeneous chains. + +We address those challenges through incorporation +of a service oriented infrastructure into Cosmos/Tendermint. + +Our design inherits the thinking pattern from +many years of service-oriented architecture ("SOA") practices. SOA is an architectural approach to create +systems built from autonomous services which have explicit boundaries, +share schemas and contracts [\[13\]][13]. Earlier practice of SOA focused +on the implementation of Enterprise Service Bus ("ESB") which enables +communication among services via a common communication bus which +consists of a variety of point-to-point connections between providers +and consumers. However, centralized management of services through ESB could +trigger a single point of failure, also adds dependency of service +deployment. The recent surge of micro-services architectural style can be +seen as a development of SOA without focusing on the ESB rather using +light message queues for inter service communication. In IRIS network, +the inter service communication is intended to be implemented over blockchain to +leverage blockchain as a trusted machine for mediating business +collaborations. It runs without prerequisite of existing trust among service +provider and service consumer which is very hard to establish. + +The IRIS network uses Tendermint protocol as a high-performance consensus +engine. Leveraging the flexibility provided by tendermint's Application +BlockChain Interface ("ABCI"), we define a set of service infrastructure +transaction types including service provisioning, service consumption +and service governance. As explained earlier, most business logic is not +suitable for implementation as deterministic smart contracts on +blockchain, we are using this service layer to move the business +application specific logics and transaction processing off the +blockchain itself and use the blockchain only to get consensus on the +results generated through those services. This idea is also inspired by +existing work from blockchain community when address performance issues +of moving some complicated computation off the main chain, such as Lightning +Network's off-chain state channels [\[10\]][10] as well as Plasma's fraud +proof side chains [\[11\]][11]. Although we are not implementing side chains, +we rip traditional business logic computation off the blockchain + and use it as a trustworthy mediation bus for +complicated business collaboration. + +For interchain communication, Cosmos IBC [\[12\]][12] defines a protocol for +transferring values from an account on one chain to an account on another +chain. The IRIS network designs new semantics to allow cross-chain computation to be invoked by leveraging IBC. We believe this capability is very important when building scalable business applications. Further details of potential use cases are set out below. + +The IRIS network is intended to provide the service infrastructure for handing and coordinating on-chain transaction processing with off-chain data processing and business logic execution. Enhanced IBC capability +allows those off-chain processing to be invoked cross chain, if required. The IRIS network, as presently envisaged, will also include client-side tools, including a smart wallet enabling cross-chain multi-asset storage, as well as consume and provide iServices. We plan to provide SDKs for easy construction of iServices. For example, for a specific service definition, the Client SDK would generate the provider side skeleton as well as consumer side stub for major programming languages. + +
+ +## IRIS Network Design ################################################################ + +![Figure of IRIS Network](https://github.com/irisnet/irisnet/blob/master/images/chap2-1.png?raw=true) + +As illustrated in the figure above, the IRIS network is intended to have the +same topology as the Cosmos network. We plan to connect the IRIS Hub to +the Cosmos Hub as one of its zones and regional hubs. IRIS full nodes, +developed with the IRIS SDK (which is itself a planned extension of the +Cosmos SDK), are proposed to provide a service infrastructure as well as +offer integration with an embedded InterPlanetary File System ("IPFS") node. + +IRIS Services (a.k.a. "iServices") intend to bridge the gap between the blockchain +world and the conventional business application world, by mediating a +complete lifecycle of off-chain services -- from their definition, +binding (provider registration), invocation, to their governance +(profiling and dispute resolution). By enhancing the IBC processing +logic to support service semantics, the IRIS SDK is intended to allow +distributed business services to be available across the internet of blockchains. + +While the IRIS network focuses on providing an innovative solution +for distributed business applications, it is still part of +the broader Cosmos network. All zones connected to our proposed IRIS hub would be able to interact with any other zone in the Cosmos network over +the standard IBC protocol. Furthermore, by introducing a layer of service +semantics, which we believe could enable a whole new set of business scenarios, +the planned IRIS network would represent an increase in scale and diversity +of the Cosmos network. + +### Network Actors + +1. **Consumers** are those users who may consume off-chain services by sending + requests to the network and receiving responses from the network. + +2. **Providers** are those users who may offer the implementation of one or more +iService definitions and often act as *adaptors* of off-chain services and resources located + in other public and consortium chains, as well as in enterprise legacy + systems. Providers monitor and process incoming requests and send responses + back to the network. A provider could at the same time act as a consumer + by sending requests to other providers. As planned, providers would be required to + charge a fee for any services they might offer, and the service fee, by default, would be + priced in the IRIS network's native fee token known as "IRIS"; providers + could also price their services in other whitelisted Cosmos fee tokens, to be + considered in due course. + +3. **Profiler** is the special user who works on behalf of the IRIS Foundation +Limited ("Foundation"), a Hong Kong incorporated company limited by guarantee. +The Foundation will take the lead in building the IRIS network. The profiler +is the sole user authorized to invoke iServices in the profiling mode, which +is intended to help create and maintain objective *provider profiles* that +consumers use to select suitable providers. + +### IRIS Services + +In this section, we set out the intended technical parameters for deploying iServices on the IRIS network. + +**Service Definition** + +A `Method` is composed of: + +* `ID (int)`: The unique ID of this method in the encompassing iService + +* `Name (string)`: The unique name of this method in the iService + +* `Description (string)`: A description of this method + +* `Input (string)`: A structured definition of the input parameters + +* `Output (string)`: A structured definition of the output result + +* `Error (string)`: A structured definition of all possible error conditions + +* `OutputPrivacy (enum)`: Can be one of `NoPrivacy` or `PubKeyEncryption` + +A `ServiceDefinition` is composed of: + +* `Name (string)`: The name of this iService + +* `Description (string)`: A description of this iService + +* `Tags (string)`: Comma separated keywords about this iService + +* `Creator (string)`: A self-description of the iService creator. *Optional* + +* `ChainID (string)`: The ID of the blockchain where this iService was + originally defined + +* `Messaging (enum)`: Can be one of `Unicast` or `Multicast` + +* `Methods ([]Method)`: The definition of methods available in this iService + +A `CreateServiceDefinitionTx` transaction is composed of: + +* `Definition (ServiceDefinition)`: The service definition to be created + +**Service Binding**: + +A `CreateServiceBindingTx` transaction is composed of: + +* `DefinitionHash ([]byte)`: The hash of the service definition that the provider is binding to + +* `ChainID (string)`: The ID of the blockchain where the provider is connected + +* `ProviderAddress ([]byte)`: The provider's blockchain address + +* `BindingType (enum)`: Can be one of `Local` or `Global`; choose `Global` if a + provider wants the binding to be exposed to the rest of the world; + otherwise, use `Local` + +* `ProviderDeposit (int64)`: To create an effective binding, the provider + must put down a deposit (in terms of IRIS token amount) that is greater than + the value of the system parameter `MinProviderDeposit`; a larger deposit + may imply more trustworthiness of the provider + +* `ServicePricing (string)`: A structured definition of the service pricing + model on a per method basis, including cost per call, volume discount, + promotional terms etc.; service fee is by default listed in IRIS token but + could also be quoted in other whitelisted fee tokens. + +* `ServiceLevel (string)`: A structured definition of service level the + provider agrees to bind himself to, in terms of response time, + availability etc. + +* `BindingExpiration (int64)`: The blockchain height where this binding + expires; a negative number means "never expire" + +An `UpdateServiceBindingTx` transaction is composed of: + +* `DefinitionHash ([]byte)`: The hash of the service definition the + provider has bound to + +* `ChainID (string)`: The ID of the blockchain where the provider is + connected + +* `ProviderAddress ([]byte)`: The provider's blockchain address + +* `ChangeSet (string)`: A structured definition of desired changes to an + existing binding identified by the preceding three fields + +![Figure of iService Definition and Bindings](https://github.com/irisnet/irisnet/blob/master/images/chap2-2.png?raw=true) + +A provider can update `ServicePricing`, `ServiceLevel` and `BindingExpiration` +at any time, but a small amount of their deposit will be slashed for +changing the latter two (specified by `ServiceLevelUpdateSlash` and +`BindingExpirationUpdateSlash` respectively). Setting `BindingExpiration` to +a height that is lower than the current height will be interpreted as +invalidating the binding immediately. + +Updates to `ProviderDeposit` will always be treated as *adding to* the +current deposit balance. Whenever the balance drops below +`MinProviderDeposit`, the binding will be disabled until the provider +increases the balance above the threshold. Upon expiration or +invalidation of a binding, the provider will automatically get back the +remaining balance of its deposit. + +`BindingType` can be changed from `Local` to `Global`, but not the other way +around. To downgrade a binding from `Global` to `Local`, a provider must +first invalidate the binding in question and then create a new `Local` +binding. + +If a provider somehow needs to move the binding to a new address, it is +not allowed to update `ProviderAddress` directly; instead, the provider +should invalidate the current binding and create another one with the +desired new `ProviderAddress`. + +Upon successful execution of these two transactions by the application +(i.e., iService business logic in the IRIS SDK), a `ServiceBinding` object +will be created or updated accordingly. + +A `ServiceBinding` is composed of: + +* `DefinitionHash ([]byte)` + +* `ChainID (string)` + +* `ProviderAddress ([]byte)` + +* `ServiceLevel (string)` + +* `ServicePricing (string)` + +* `BindingExpiration (int64)` + +* `IsValid (enum)`: Can be one of `True` or `False` + +**Service Invocation** + +![Figure of Service Invocation](https://github.com/irisnet/irisnet/blob/master/images/chap2-3.png?raw=true) + +Consumers and providers are proposed to interact with each other through *endpoints*. +There are two kinds of endpoints -- *request table* and *response table* +(see Figure above). Service requests are posted to request tables monitored +by interested provider(s) which pick up and process requests addressed +to them; service results (or errors) are posted back to response tables +monitored in turn by matched consumers. + +For a `Multicast` service, all of its bindings share one request table; +for a `Unicast` service, however, a separate request table is created and +maintained for each of its bindings. As for the other direction, a dedicated response table would be created and managed for each consumer. + +A `ServiceRequest` is composed of: + +* `ChainID (string)`: The ID of the blockchain where the consumer is + connected + +* `ConsumerAddress ([]byte)`: The blockchain address of the consumer + +* `DefinitionHash ([]byte)`: The hash of the service definition + +* `MethodID (int)`: The ID of the method to be invoked + +* `InputValue (string)`: A structured representation of input values + +* `BindingHash ([]byte)`: The hash of the target binding, in case of a + `Unicast` service. *Optional* + +* `MaxServiceFee (int64)`: The max amount of service fee the consumer is + willing to pay for a `Multicast` request. *Optional* + +* `Timeout (int)`: The max number of blocks the consumer is willing to wait + for response(s) to come back + +A `PostServiceRequestTx` transaction is composed of: + +* `Requests ([]ServiceRequest)`: The service requests to be posted + +* `RequestDeposits ([]int64)`: The consumer must put down for each request + a deposit (in terms of IRIS amount) that is greater than the value of + `MinRequestDeposit`; this deposit is meant to incentivize the consumer to acknowledge receipt of service responses in a timely manner (see `ConfirmServiceResponseTx`). + +The application will verify that each request is coming from a consumer +with matching `ChainID` and `ConsumerAddress`, the targeted binding is +valid, the request deposit is sufficient, the consumer's account balance is +enough to cover the request deposits and service fees, and that the total +number of requests in the transaction is less than `MaxRequestPostBatch`. + +When a verified request is appended to the request table, the related +service fee (`MaxServiceFee` in case of a `Multicast` request) will be +deducted from the consumer's account and locked up in escrow. + +A `GetServiceRequest` query is composed of: + +* `DefinitionHash ([]byte)`: The hash of the service definition + +* `BindingHash ([]byte)`: The hash of this provider's binding to the + service in question; the application will verify that the binding is + valid and the caller matches the binding's `ChainID` and `ProviderAddress` + +* `BeginHeight (uint64)`: The blockchain height from where the application + should start to retrieve requests for the provider, up to a total number + that is the lesser of `BatchSize` and `MaxRequestGetBatch` + +* `BatchSize (int)`: The max number of requests to be returned + +A `ServiceResponse` is composed of: + +* `RequestHash ([]byte)`: The hash of the matched request + +* `BindingHash ([]byte)`: The hash of this provider's service binding + +* `OutputValue ([]byte)`: A structured (potentially encrypted) + representation of output result. *Optional* + +* `ErrorMsg (string)`: A structured representation of error messages. + *Optional* + +A `PostServiceResponseTx` transaction is composed of: + +* `Responses ([]ServiceResponse)`: The service responses to be posted + +The application will verify that each response is coming from a +provider with matching `ChainID` and `ProviderAddress`, and that the number +of responses in the transaction is less than `MaxResponsePostBatch`. A +verified request will be appended to the response table for the intended +consumer. + +A `GetServiceResponse` query is composed of: + +* `RequestHash ([]byte)`: The hash of the original request; the + application will verify that the caller matches the request's `ChainID` + and `ConsumerAddress` + +* `BeginHeight (uint64)`: The blockchain height from where the application + should start to retrieve responses for the consumer, up to a total + number that is the lesser of `BatchSize` and `MaxResponseGetBatch` + +* `BatchSize (int)`: The max number of responses to be returned + +A `ConfirmServiceResponseTx` transaction is composed of: + +* `ResponseHash ([][]byte)`: The hash of responses to be confirmed + +The application will verify that the each response to be confirmed is +indeed for a request originated by the caller, and that the number of +responses in the transaction is less than `MaxResponseConfirmBatch`. + +Responses that fall out of the `Timeout` window (and, in case of `Multicast` +responses, when `MaxServiceFee` runs out as more responses come back) will +not be accepted by the application. A consumer starts processing a +`Unicast` response immediately upon receiving it. However, for `Multicast` +responses, a consumer will need to wait until the `Timeout` window elapses before +starting to process all responses received, if any. + +When a `Unicast` response is confirmed by the consumer, the associated +service fee will be released from escrow to the matched provider account +-- after a small tax (defined by `ServiceFeeTaxRate`) is deducted and +added to the *system reserve*; and the associated request deposit will +be returned to the consumer as well. + +In the case of a `Multicast` request, the situation is a bit more complex: +when a response is confirmed, only part of the request deposit is +returned to the consumer, in proportion to the response related service +fee vs `MaxServiceFee`; and after all responses are confirmed, the +remaining escrow balance for the request will be returned to the +consumer. + +If a request timeouts without seeing any response come back, the +application will refund the associated balance held in escrow plus the request +deposit, in full, back to the consumer. However, if the consumer does +not confirm a response in time (before `ResponseConfirmTimeout` + +blockchain height of the response), a small penalty (defined by +`ResponseConfirmDelayPenaltyRate`) will be applied before the request +deposit is refunded to the consumer, while the associated service fee +will be released to the provider as usual. + +**Dispute Resolution** + +In any case where a consumer is unsatisfied with a service response, a mechanism should exist allowing the consumer to issue a complaint and consequently, to receive an acceptable solution to that complaint, without having to resort to a centralized authority such as the legal system. Also, this mechanism should avoid +introducing subjective evaluation, which could be abused by either side. + +The process to resolve a dispute that arises on the IRIS network resembles that of service invocation, except that a consumer sends a `Complaint` to the provider, and the provider responds with a `Resolution`. These interactions are intended to happen through a pair of global endpoints known as *complaint table* and *resolution table*. + +Under the present design for the IRIS network, a consumer deposit is required for filing a complaint. Where a consumer does not confirm a resolution in a timely manner, a penalty will be deducted from this deposit. Similarly, a provider's deposit will be partially slashed if he fails to respond to a complaint in a timely manner. + +A `Complaint` is composed of: + +* `ResponseHash ([]byte)`: The hash of the response in dispute + +* `Problem (string)`: A description of the problem with the service response + +* `PreferredDisposal (enum)`: Can be one of `Refund` or `Redo` + +A Resolution is composed of: + +* `ComplaintHash ([]byte)`: The hash of the matched complaint + +* `Disposal (enum)`: Can be one of `Refund` or `Redo` + +* `Refund (uint64)`: Service fee refund. *Optional* + +* `OutputValue ([]byte)`: A structured (potentially encrypted) + representation of output result. *Optional* + +Our intended dispute resolution process, as outlined above, may not be legally binding. Nonetheless, we believe that it will provide an efficient means of resolving common disputes on the IRIS network. + +**Service Profiling** + +Bootstrapping the iService ecosystem presents a few challenges. A major challenge is finding a way to make it easy for consumers to discover suitable providers - consumers need performance metrics to evaluate and select a provider, yet without consumer usage no performance metrics will be available. + +With the intention to solve this circular issue, we plan to introduce a profiling mechanism where a privileged system user, the profiler, invokes all the active services on a regular schedule. This would leave objective performance data in the network (such as response time, availability, complaint handling etc.) that are useful for real consumers. + +Service profiling calls would be exempt from service fees and consumer +deposits, but they would incur network transaction fees. These calls +would originate from a few reserved addresses that are intended to be recognized and honored by the application. + +Profiling activities would stay at a relatively stable level for new services +and gradually decline for individual services as they start to +attract real consumer calls, which is expected to generate more performance data on their own. + +Transaction fees incurred during profiling would be paid out from the system reserve by default, and the Foundation reserve would step in if necessary. + +**Query** + +All the service related lifecycle objects described above can be queried +using the ABCI Query interface [\[3\]][3]. These queries would be executed over +the Query connection and do not participate in the consensus process. We +have already seen how `GetServiceRequest` and `GetServiceResponse` queries +work as part of the service invocation process. + +Below is a non-exhaustive summary of our currently planned queries: + +**Service Objects** + +| Object | Commonly Used Filters | Authorization | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Service Definition | Name, keywords, source (chain ID), messaging type, with active bindings... | Anyone can query | +| Service Binding (for a given definition) | Location (local or remote), pricing, service level, expiration... | Anyone can query | +| Service Request | Service definition and binding, blockchain height, batch size | Only matched provider(s) | +| Service Response | Service request, blockchain height, batch size | Only matched consumer | + + +**Performance Metrics** + +| Area | Metrics | Authorization | +| --------------------------- | ---------------------------------------- | ----------------- | +| Provider (address) | Number of services provided (ever and active), response time (min, max and average), requests served (local and remote), requests missed, complaints received, complaints ignored, ... | Anyone can query | +| Provider (binding) | Active time, response time (min, max and average), requests served (local and remote), requests missed, complaints received, complaints ignored, ... | Anyone can query | +| Consumer | Number of services ever used, requests made, requests confirmed (in time and missed), complaints made, resolutions confirmed, ... | Anyone can query | +| Consumer (service, binding) | Requests made, requests confirmed (in time and missed), complaints made, resolutions confirmed, ... | Anyone can query | + + +### IBC Enhancement + +One unique advantage of establishing our service infrastructure on top of Cosmos is the potential for services to be *deployed once and invoked +everywhere*, over an internet of blockchains. Specifically, our plan is to +accomplish the following: + +1. Service definitions are broadcast to every zone in the IRIS network; + +2. Global service bindings are broadcast to every zone in the IRIS network; + +3. Service requests or complaints targeting a remote provider are routed to + the blockchain to which the provider is connected; + +4. Service responses or resolution meant for a remote consumer are routed + back to the blockchain to which the consumer is connected. + +When processing a `CreateServiceDefinitionTx` transaction, the application +is designed to first validate and store the `ServiceDefinition` object locally, before creating an `IBCPacket` containing the definition for each neighboring chain. + +Each neighbor eventually receives -- from the corresponding relay process -- +an `IBCPacketTx` containing the packet; if the definition does not already +exist in the receiving chain, the latter will pass on the definition by +creating an `IBCPacket` for each of *its* neighbors -- except the source +chain from which it received the packet in the first place; if the +definition already exists, the receiving chain stops passing on the +definition. + +Similarly, when a `ServiceBinding` is created or updated with its +`BindingType` set or updated to `Global`, an `IBCPacket` containing the +binding is created for each neighboring chain, and gets propagated across +the entire IRIS network. + +An `IBCPacket` described above is composed of: + +* `Header (IBCPacketHeader)`: The packet header + +* `Payload (ServiceDefinition or ServiceBinding)`: The bytes of the service + definition or binding + +The `IBCPacketHeader` above is composed of: + +* `SrcChainID (string)`: The ID of the blockchain creating this packet + +* `DstChainID (string)`: The ID of the neighboring blockchain this packet is + destined for + +* `Number (int)`: A unique number for all packets + +* `Status (enum)`: `NoAck` + +* `Type (string)`: "iris-service-definition" or "iris-service-binding" + +Now let's take a look at how interchain service invocation happens through IBC. +When a request is made for a `Unicast` service, the application checks if +the target binding is `Local`; where this is true, the `ServiceRequest` is appended to the corresponding request table as explained in 2.2; otherwise, an +`IBCPacket` containing the `ServiceRequest` will be created instead. + +An `IBCPacket` containing a `ServiceRequest` is composed of: + +* `Header (IBCPacketHeader)`: The packet header + +* `Payload (ServiceRequest)`: The bytes of the service request + +The `IBCPacketHeader` above is composed of: + +* `SrcChainID (string)`: The ID of the blockchain creating this packet + +* `DstChainID (string)`: The ID of the blockchain where the remote provider + is located, i.e., `ServiceRequest.ServiceBinding.ChainID` + +* `Number (int)`: A unique number for all packets + +* `Status (enum)`: `AckPending` + +* `Type (string)`: "iris-service-request" + +* `MaxHeight (int)`: Current height + `ServiceRequest.Timeout` + +As a remote request finally arrives at the destination chain, the +application would append it to the corresponding endpoint (the request table) +for the targeted binding. A response to this remote request would be +wrapped in a receipt `IBCPacket` that is routed all the way back to the +source chain and appended to the remote endpoint (the response table) for +the originating consumer. + +Request for a remote `Multicast` service is treated in the same way except +that more than one `IBCPacket` could be generated in the source chain. + +Remote complaints and resolutions are expected to work in the same manner as requests and responses, and therefore will not be elaborated here. + +Below is a complete list of application-dependent `IBCPacket` types: + +| **Type** | **iService Object** | +| ------------------------- | ------------------- | +| "iris-service-definition" | ServiceDefinition | +| "iris-service-binding" | ServiceBinding | +| "iris-service-request" | ServiceRequest | +| "iris-service-response" | ServiceResponse | +| "iris-complaint" | Complaint | +| "iris-resolution" | Resolution | + +
+ +## Use Cases ################################################################ + +In this section, we have set out some potential use cases for the IRIS network. + +### Distributed AI for privacy preserving data analysis + +The proposed service infrastructure has been prototyped by Bianjie AI, a +Shanghai based startup, into its permission product `BEAN (Blockchain +Edge Analytics Network)` to solve the longstanding challenge of getting +data for running analytics models. Although homomorphic encryption is +one of the key methods allowing computing to be achieved over encrypted data, it is said to be unable to practically solve real world machine learning problems due to its slow performance. As a result, BEAN was created to take a different approach. This approach uses the idea of model parallelism taken from the traditional distributed AI study [\[14\]][14] and +utilizing SOA design patterns to develop distributed analytics services as an additional layer to the blockchain. + +To protect data access, the (partial) model that runs on the data side needs to be open sourced to the client and specified in the service definition. Since only the partial model is released to the client, the model developers do not have to worry about someone stealing their idea; equally, the data owners never need to worry about losing control of data usage as their data will not be leaving its origin. + +Other potential benefits could include the following: +1. Only a small amount of parametric data being exchanged on-chain, which can help enhance performance. + + . A more practical way for data usage auditing, which is often needed in the healthcare domain. + +Healthcare data is highly private, involving numerous security requirements. This puts forward the challenge for healthcare data to be used for the purposes of cross-organization collaboration (such as a cross-hospital clinic records search for diagnosis assistance, new drug clinic test patient identification, health insurance automatic claim processing etc.). This minimum viable product ("MVP") service layer implementation is built on top of `Ethermint` in attempt to connect hospitals, insurance companies and analytics service providers to provide privacy preserving healthcare data analytics capability. + +Smart contracts have been implemented to support on-chain service registration and invocation. One example of the off-chain data processing could be to support a Diagnosis Related Group ("DRG") grouping analytics service. More specifically, when a hospital user invokes the DRG service, the raw medical record is processed off-chain using service provider provided client side NLP (implemented as SQL and Python) code stub to exact structured data inputs for receiving DRGs service over blockchain without passing the highly confidential raw medical records. + +The `BEAN` +scenario demonstrates a more complicated service use case including +implementing distributed analytics, and connecting service providers as +well as service consumers, utilizing blockchain to provide audible +transaction ledge as well as trustworthy distributed computing +foundation. + +### Data and analytics e-marketplace + +From studying several proposed AI+Blockchain projects, it seems that most of the projects aim to provide data exchange markets and analytics API markets. With proposed `IRIS` infrastructure, those +networks could potentially be built with ease through publishing data as data services and wrapping analytics API as analytics services utilizing the `IRIS` service provider SDK. + +### Distributed e-commerce + +With the proposed `IRIS` infrastructure, integration with traditional systems +like `ERP` to obtain inventory information, or inter-chain query on trusted data sources to obtain information such as transportation and weather data, will be quite similar to the approach with which many enterprise application developers are already familiar. With those services integrated to support +distributed e-commerce applications, it could be possible for distributed e-commerce applications to provide a similar user experience as centralized systems, such as Amazon or Alibaba. + +### Combining public chains & consortium chains + +For many business scenarios, taking a hybrid architecture of combining the good features of a public chain and a consortium chain can provide beneficial results, particularly with regards to performance, security and economic incentives. + +For example, hospitals and insurance companies could form a consortium blockchain to support high performance medical insurance transactions, whilst identifying other information such as statistics regarding certain diseases as a global service, which can be invoked from other public chains. The tokens received from public chains can be awarded back to +those information providers in the consortium chain, which motivate the +system participants to improve and promote services. With this infrastructure provided by `IRIS`, large-scale spontaneous collaboration could be made possible while still supporting stringent performance and security requirements. + +There are many use cases that could be supported by the `IRIS` service +infrastructure, such as more efficient asset based security systems, +distributed regulation technology such as due diligence, mutual aid +marketplace etc. One of `IRIS` project plans is also working closely with +such application project teams to support and enable them with needed +blockchain infrastructure and allow them to focus on delivering the +envisioned business value more efficiently. + +
+ +## Token Economics ################################################################ + +Similar to the Cosmos Network, the IRIS network, as presently designed, is intended to support a multi-token model. The tokens will be held on the various zones, and can be moved from one zone to another via the IRIS Hub. There are two types of tokens that are expected to support IRIS network's operation: + +* staking token +* fee token + +### Staking token + +Adopting the same staking mechanism design used in the Cosmos network [\[15\]][15], the IRIS Hub will have its own special native token for staking. This token will be called "IRIS". We have a number of ideas in mind regarding the specific functionality of the IRIS token, including: + +* integration of the IRIS token in the IRIS network's consensus engine validators, through a system of validators and delegators; + +* voting power to participate in the IRIS network's governance + + +### Fee token + +There are two types of fee tokens in IRIS network: +* **Network fee** token is for spam-prevention and payment to validators in maintaining the + ledger; +* **Service fee** token is used for payment to service providers + who deploy iServices and the default payment service token is IRIS token. + +The IRIS network is intended to support all whitelisted fee tokens from the Cosmos network, e.g [Photon](https://blog.cosmos.network/cosmos-fee-token-introducing-the-photon-8a62b2f51aa), plus the IRIS token. + +Supporting a variety of whitelisted fee tokens is a feature that we plan to adopt from Cosmos. It can provide an enhanced experience for network participants. In Cosmos, for `network fee token`, each validator has a config +file defines his personal weighting of how much they value each fee +token. Validator can run a separate cron job to update the config file +based on validator preferred live market data or maybe just use a +default config value. + +For the `service fee token` design, similarly a multi-token model is planned to be supported. A service provider on the IRIS network should therefore have the freedom to charge for their services in their preferred tokens, provided that it appears on the whitelist. + +To help IRIS network participants mitigate cryptocurrency price volatility, the Foundation intends to facilitate the deployment of global iServices for retrieving market data from different exchanges, or through the potential introduction of oracles. + +Both staking and fee tokens are subject to further refinement to ensure compliance with legal and regulatory obligations. + +
+ +## Initial Token Distribution ################################################################ + +On Genesis, the initial token supply will be 2,000,000,000 IRIS tokens. The distribution of IRIS tokens is planned to be as follows: + +* **Private Sale**: 20% + +* **Core Developer Team**: 20% (4-year vesting period starting from IRIS Hub launch, during which the team will vest 1/48th of its IRIS tokens each month) + +* **IRIS Foundation**: 15% (reserved to support the operations of the Foundation) + +* **Ecosystem Development**: 45% (swap with zones connecting to IRIS Hub; grant to potential users; awards to outstanding partners; potential public sale) + +If and when the IRIS network is fully deployed, the annual inflation rate of IRIS tokens will be adjusted to account for the fact that a substantial portion of IRIS tokens in circulation may be voluntarily staked by participants to participate in the consensus engine. + +Proceeds from the private sale of IRIS tokens will be used, first and foremost, for the development of the IRIS network. The planned usage distribution is as follows: + +* **Foundation Operations**: 10% (including service providers and contractors fees, for example, auditing, consulting, legal and other third party fees, and other overheads) + +* **Software Development**: 50% (including costs, fees and expenses directly attributable to the development of launch) + +* **Developer Enablement**: 10% (including funding hackathons, awards to volunteers and training programs) + +* **Research and Development Sponsorships**: 10% (including conference, research programs and university outreach) + +* **Marketing and Promotion**: 20% (including business development, community programs and outreach, together with related travel, communication, publication, distribution and other expenses) + + +
+ +## Roadmap ################################################################ + +The expected IRIS project is set out below. We reiterate that the roadmap is indicative only, and subject to change. + +* **PANGU** (January 2018 \~ July 2018) The first stage of the IRIS project will focus on having the IRIS Hub up and running and connected to the Cosmos Hub. We also intend to release an initial version of the mobile client for the IRIS network. + + +* **NUWA** (July 2018 \~ November 2018) +The second stage will focus on building the fundamental IRIS Service Layer. This will involve enabling service definition, binding, invocation and query. +In this stage we are also aiming to have a beta version of the IRIS SDK ready for developers. + +* **KUAFU** (December 2018 \~ May 2019) The third stage will focus on incremental upgrades to the IRIS network in order to support our planned advanced IRIS Service governance features. + + +* **HOUYI** (Beyond June 2019) +The fourth stage will focus on further technology innovations to the IRIS network, IRIS SDK and mobile client, as well as developer engagement. + +
+ +## The Team ################################################################ + +**Tendermint** (the team that developed the [Tendermint](https://www.tendermint.com) consensus engine and is currently building Cosmos), **Wancloud** (a subsidiary of [Wanxiang +Blockchain](http://www.wxblockchain.com) and **Bianjie AI** will work together to build the IRIS network's infrastructure. + +Tendermint's intended role to give technical advice and development support to the IRIS project team in extending the Tendermint ABCI and the Cosmos IBC technologies. +[Wancloud](https://www.wancloud.io) is envisaged as the key strategy partner to both the Cosmos and IRIS ecosystems, and we understand that it intends to participate in Cosmos and IRIS development across Asia. + +**Bianjie AI** +will be the core development team for the IRIS network, leveraging the team's experience established from building distributed AI analytics services for healthcare data analysis and exchange. [Bianjie AI](https://www.bianjie.ai) is a Shanghai-based start-up established in 2016. It focuses on developing innovative products and solutions for healthcare and financial industries, using advanced Blockchain and AI technologies. One of Bianjie's core products, `BEAN (Blockchain Edge Analytics Network)` BEAN (Blockchain Edge Analytics Network), is a permission chain which delivers distributed data analytics services for privacy preserving healthcare data analysis and exchange using NLP and machine learning technologies. Bianjie AI is +currently extending `BEAN` capabilities to build the IRIS network. +**Bianjie AI** +is also the operation and service partner of Cosmos Network in China. + + +### Core Members + +**Harriet Cao** + +[Harriet](https://www.linkedin.com/in/harrietcao/) is the founder of Bianjie AI, which a Shanghai-based start-up focusing on building smart services for blockchain that enable trustworthy and efficient business collaborations using distributed AI technology. Harriet is an award-winning practitioner of data analytics and artificial intelligence technologies, and was the recipient of 2010 INFORMS Daniel H. Wagner Prize. Prior to establishing Bianjie AI, Harriet worked for IBM Research for more than 16 years in various capacities including Director of IBM Research Shanghai Lab and Big Data Analytics Leader for IBM Global Labs. +Harriet has an M.S degree in Robotics from Carnegie Mellon University and an M.S. degree in Automation Control from Tsinghua University. + + +**Haifeng Xi** + +[Haifeng](https://www.linkedin.com/in/haifengxi/) is a senior technologist and entrepreneur. Since returning to China from the United States in 2009, he had worked in the capacity of Chief Technology Officer for three companies, one of which is NASDAQ listed. He also co-founded two start-ups in Shanghai, where he plays an active role of technical leader and engineering champion. +Haifeng has a Master's degree in Electrical and Computer Engineering from the University of Maryland, and a Master's and Bachelor's degree in Automatic Control from Tsinghua University. + + +**Jae Kwon** + +After graduating from Cornell in 2005 with an undergraduate degree in computer science, [Jae](https://www.linkedin.com/in/yjkwon/) worked as a software developer in Silicon Valley, first at Amazon (where he worked on the Alexa digital assistant), then later at Yelp, where he led their mobile app development team. +After getting the blockchain bug, Jae created the Tendermint BFT consensus algorithm and the Tendermint Core blockchain engine, with the intent of creating a provably secure proof-of-stake algorithm. +In addition to Tendermint, Jae is also the creator of Cosmos. + + +**Tom Tao** + +Since joining Wanxiang in August 2016, [Tom](https://www.linkedin.com/in/tom-tao-14763a45/) is responsible for Wanxiang Blockhain Group's consulting service, Wancloud BaaS Platform as well as the ChainBase accelerator and incubator service. Before Wanxiang, Tom worked in service management and business management for over 18 years in a number of global leading companies. +Tom has spearheaded the introduction of cloud services, IoT data service platforms, and creative accelerator technologies into the Chinese market. +Tom has been tracking trends in the blockchain, cloud computing, IoT and smart manufacturing industries since 2013. Tom has a Master's degree in Physics from Fudan University and a Bachelor's degree in Electrical Engineering from Nankai University. + + +### Advisors + +**Jim Yang** + +[Jim Yang](https://www.linkedin.com/in/jimyang/) runs Strategy for Tendermint. He was the founder and CEO at ChatX, mobile messaging studio. ChatX developed various mobile messaging/social apps. He also co-founded Identyx, where he served as CEO until its acquisition by Red Hat. Identyx developed an open source enterprise identity management software. + +**Zaki Manian** + +[Zaki Manian](https://zaki.manian.org), Executive Director of Trusted IoT Alliance, is a prolific contributor to the development of blockchain and cryptocurrency technology. Zaki has deep expertise in cryptography and distributed consensus system. He is also an advisor to the Cosmos project, and several other investment funds and startup in the space. + +**Adrian Brink** + +[Adrian Brink](https://adrianbrink.com), Core Developer & Head of Community of Tendermint / Cosmos Network. + +**Michael Yuan** + +[Dr. Michael Yuan](http://www.michaelyuan.com) is the Director of the [CyberMiles Foundation](https://cm.5miles.com). Michael received a PhD in Astrophysics from University of Texas at Austin. He is the author of 5 books on software development, published by Prentice Hall, Addison-Wesley, and O'Reilly. Michael was an active code committer in large Open Source projects such as Firefox, Fedora, JBoss, and others. He is an expert on enterprise and mobile software, and was a Principle Investigator on multiple research projects funded by the US government. + +
+ +## References ################################################################ + +[1]: https://drive.google.com/file/d/1bI7JIOe-CfJ5fPHKxYlFub2Kg-KCGU6r/view?usp=sharing +[2]: http://ethdocs.org/en/latest/ +[3]: https://cosmos.network/whitepaper +[4]: https://polkadot.io/ +[5]: https://tendermint.readthedocs.io/en/master/ +[6]: https://ethermint.zone/ +[7]: http://www.freepatentsonline.com/y2017/0236120.html +[8]: https://github.com/cryptape/cita-whitepaper/blob/master/en/technical-whitepaper.md +[9]: https://github.com/hyperledger/burrow +[10]: https://lightning.network/lightning-network-paper.pdf +[11]: https://www.plasma.io/plasma.pdf +[12]: https://github.com/cosmos/ibc/blob/master/README.md +[13]: https://www.amazon.com/SOA-Principles-Service-Thomas-Erl/dp/0132344823 +[14]: http://www.cs.toronto.edu/~ranzato/publications/DistBeliefNIPS2012_withAppendix.pdf +[15]: https://medium.com/@tendermint/b5b2c682a292 +[16]: https://drive.google.com/file/d/1jtyYtx7t1xy9gxEi2T5lXFNd8xUY7bhJ/view + + +* [1] Wanxiang Blochchain Inc., Distributed Business Value Research Institute, + "Blockchain and Distributed Business Whitepaper", September 2017. + +* [2] Ethereum Foundation, "Ethereum Homestead Documentation", + http://ethdocs.org/en/latest/ + +* [3] Jae Kwon, Ethan Buchman，"Cosmos, A Network of Distributed + Ledgers", https://cosmos.network/whitepaper + +* [4] Gavin Wood, "Polkadot: Vision For a Heterogeneous Muilti-chain + Framework", https://polkadot.io/ + +* [5] Tendermint, https://tendermint.readthedocs.io/en/master/ + +* [6] Ethermint, https://ethermint.zone/ + +* [7] Oracle International Corporation, "Accountability and Trust in + Distributed Ledger Systems", USA Patent Application 20170236120, August + 17, 2017, http://www.freepatentsonline.com/y2017/0236120.html + +* [8] Jan Xie, "CITA Technical Whitepaper", + https://github.com/cryptape/cita-whitepaper/blob/master/en/technical-whitepaper.md + +* [9] Hyperledger Burrow, https://github.com/hyperledger/burrow + +* [10] Joseph Poon, Thaddeus Dryja, "The Bitcoin Lightning Network: + Scalable Off-Chain Instant Payments", January 14, 2016, + https://lightning.network/lightning-network-paper.pdf + +* [11] Joseph Poon, Vitalik Buterin, "Plasma: Scalable Autonomous Smart + Contracts", August 11, 2017, https://www.plasma.io/plasma.pdf + +* [12] Ethan Frey, "Cosmos IBC Specification", Sep. 29, 2017, + https://github.com/cosmos/ibc/blob/master/README.md + +* [13] Thomas Erl,  "SOA: Principles of Service Design", Prentice Hall; + 1st edition (July 28, 2007) + +* [14] Dean, J., Corrado, G.S., Monga, R., et al, Ng, A. Y. "Large Scale + Distributed Deep Networks". In Proceedings of the Neural Information + Processing Systems (NIPS'12) (Lake Tahoe, Nevada, United States, + December 3--6, 2012). Curran Associates, Inc, 57 Morehouse Lane, Red + Hook, NY, 2013, 1223-1232. + +* [15] Tendermint Blog, "Cosmos Validator Economics -- Revenue Streams", + January 2018, https://medium.com/@tendermint/b5b2c682a292 + +* [16] Sunny Aggarwal, "Cosmos Token Model", December 2017, + https://drive.google.com/file/d/1jtyYtx7t1xy9gxEi2T5lXFNd8xUY7bhJ/view diff --git a/docs/zh/resources/whitepaper-kr.md b/docs/zh/resources/whitepaper-kr.md new file mode 100644 index 000000000..1911a7c8e --- /dev/null +++ b/docs/zh/resources/whitepaper-kr.md @@ -0,0 +1 @@ +# IRIS \ No newline at end of file diff --git a/docs/zh/resources/whitepaper-zh.md b/docs/zh/resources/whitepaper-zh.md new file mode 100644 index 000000000..661f69bfd --- /dev/null +++ b/docs/zh/resources/whitepaper-zh.md @@ -0,0 +1,616 @@ +# IRIS 网络白皮书 + +**用于构建可信分布式商业应用的跨链服务基础设施及协议** + +Harriet Cao harriet@bianjie.ai
Haifeng Xi haifeng@bianjie.ai + +_NOTE:如果你可以在GitHub上阅读，那么我们仍然在积极完善这个文档。 请定期检查更新!_
+ +## 目录 + +- [免责声明](#disclaimer) +- [IRIS 概览](#iris-概览) + - [Cosmos 和 Tendermint](#cosmos-和-tendermint) + - [IRIS 技术创新](#iris-技术创新) +- [IRIS网络设计](#iris-网络设计) + - [网络参与者](#网络参与者) + - [IRIS服务](#iris-服务) + - [IBC 改进](#ibc-改进) +- [用例](#用例) +- [通证经济](#通证经济) +- [初始通证分配](#初始通证分配) +- [路线图](#路线图) +- [团队](#团队) + - [核心成员](#核心成员) + - [顾问](#顾问) +- [参考文献](#参考文献) + +
+ +## 免责声明 + +本白皮书及其相关文档用于接下来对IRIS网络的开发和应用。仅做信息传播之用并可能更改。 + +### 本文介绍了一个开发中的项目 + +本文基于IRIS 基金会有限公司（IRIS Foundation Limited）提供的已知信息及假设，包含了符合该基金会理念的前瞻性声明。 + +本文所设想的IRIS网络尚在开发中，并将不断更新，这些更新包括但不限于关键治理和关键技术。 开发使用IRIS通证或与之相关的测试平台（软件）以及技术，可能无法实现或无法完全实现本白皮书所述的目标。 + +如果IRIS网络得以完成，可能与本文所述有所不同。本文不对未来的任何计划、预测或前景的成功性或者合理性做出陈述或保证，本文的任何内容都不应被视为对未来的承诺或陈述。 + +### 并非监管类产品的要约 + +IRIS通证不代表任何一种有价证券或者任何其它司法监管下的产品。 + +本文不构成对任何有价证券或其他受监管产品的出价要约或询价邀请，也不构成以投资为目的的促销、邀请或询价。其购买条款并非提供金融服务的文件或任何类型的招股说明书。 + +IRIS通证不代表任何平台或软件系统、或IRIS 基金会有限公司以及其他任何公司的股权、股份、单位、资本权益或版权使用费、利润、回报或收入，不代表任何与平台有关的公有或私有企业、公司、基金会以及其他受监管实体的知识产权。 + +### 并非建议 + +本白皮书不构成任何对IRIS通证的购买建议。请不要依赖本白皮书去达成任何合同或购买的决策。 + +### 风险警告 + +购买IRIS通证并参与IRIS网络伴随着极大的风险。 + +在购买IRIS通证之前，您应该仔细评估并考虑风险，包括在上和其他任何文档中列出的风险。 + +### 仅代表IRIS基金会有限公司的意见 + +本白皮书所表达的观点为IRIS 基金会有限公司的观点，并不一定反映任何政府、准政府、当局或公共机构(包括但不限于任何管辖范围内的任何管辖机构)的官方政策或立场。 + +本白皮书中的信息基于IRIS 基金会认为可靠的来源，但并不能保证其准确性或完整性。 + +### 英文是本白皮书的授权语言 + +本白皮书和相关材料仅以英文发行。任何翻译并未经IRIS 基金会有限公司或其他人员认证，其准确性和完整性无法保证，仅供参考。如果翻译与本白皮书的英文版本之间有任何不一致之处，则以英文版本为准。 + +### 非第三方从属关联或背书 + +本白皮书中提及的特定公司和平台仅供参考。使用任何公司和/或平台名称和商标并不意味着与其有任何的从属关联或背书。 + +### 您必须获得所有必要的专业建议 + +您有必要在决定是否购买IRIS通证或参与IRIS网络项目之前，必须咨询律师、会计师和/或税务专业人员，以及其他专业顾问。 + +
+ +## IRIS 概览 + +> IRIS网络是以希腊女神Iris的名字命名的，她是彩虹的化身，是在天堂和人类之间忠诚传递消息的信使。 + +契约关系是人类社会的基本组成部分，区块链技术的重要性在于提供一种非常有效和低成本的方式来实现可靠的契约关系：第一次出现了多方参与复杂的业务交互时不再需要（本来非常昂贵的）信任。 也就是说区块链技术为分布式商业提供了最重要的元素：以极低的交易成本提升网络效益。越来越多的人认识到区块链作为新的价值互联网的影响力，并将逐步把当前的商业模式转变为更高效的分布式网络。 特别是内置于大多数现代区块链中的通证机制，强调每个网络参与者的权利，并将革新商业的现有模式[[1]]。 + +不过，区块链技术仍处于早期阶段。与其它新技术一样也存在缺点，包括有限的性能和还没有发展起来的治理机制。目前，这些缺点使区块链难以支持真实的分布式商业协作。 诸如Hyperledger Fabric和R3 Corda，以及以太坊企业联盟（Ethereum Enterprise Alliance）等组织都在试图通过联盟链（consortium chains）解决这些性能和治理的问题，使区块链技术更适用于企业。然而，如今的联盟链由大型企业公司主导的，他们封闭式的链上链下治理模式非常低效。联盟链可能因为缺乏公有链的通证经济模型及其开放性和激励性而缺乏活力。 + +我们希望发展当前的区块链技术，让成千上万的中小企业(Small Medium Businesses，SMBs)，甚至是个体自由职业者，可以在一个开放的网络中提供他们的服务并享受回报。为了实现这一目标，我们确定了以下挑战以及随之而来的技术创新机会： + +**并非所有的运算都可以或应该以诸如智能合约这样的形式在区块链上实现** + +以太坊提供了[图灵完备](https://en.wikipedia.org/wiki/Turing_completeness)的虚拟机 [[2]]运行智能合约，带给人们开发分布式应用的诸多希望。 然而，智能合约只能处理确定性逻辑（因此每个节点在处理完同一交易和块后都能达到相同的状态），而大量现存的业务逻辑是不确定的，在不同时间和不同环境参数下可能会发生变化。 特别是现在，业务系统越来越依赖于计算机的算法进行决策优化，包括自然语言处理（Natural Language Processing，NLP），机器学习和操作研究算法。我们经常会故意在这些算法中添加一些随机性，以使决策不仅仅是局部最优状态，同时试图找到一个更好的次优结果。 + +另一方面，一些真实世界的业务逻辑应该在链下运行，不应该作为诸如可重复运算的智能合约这种类型来执行。 利用分布式账本集成和协同链下的服务和资源，是进一步推动区块链技术在更多真实场景中应用的关键。 + +**如何利用现有的区块链资源，包括公有链和联盟链** + +使用一个公有链来处理所有用例是不可行的。每天都有不同的区块链上线，各自专注于解决问题的一个方面，比如分布式存储、资产所有权或市场预测等。据coinmarketcap.com显示，目前有超过1000种加密货币在不同的交易平台上活跃。 + +构建业务应用程序时涉及处理存储以及不同数据源的来源，我们的另一个工作动机是如何通过重用一些现有的工作，比如存储(IPFS, SIA, Storj.io等等)、数据发送（Augur，Gnosis，Oraclize等）和物联网（IOTA等）提供的这些专用的区块链，而不是“重新发明轮子”。 + +此外，有很多（近）实时业务交易确实需要更密切的联盟链/许可链/私有链来处理性能问题、安全问题和业务治理要求。因此，我们对分布式商业基础设施的愿景是要具备在多种异构链，包括公共链/联盟链/许可链/私有链之间具备互操作的能力。 + +跨链技术是满足这一需求非常自然的解决方案。 然而目前为止，现有的跨链技术主要是为了在已有区块链中提供互操作性，并专注于通证的价值转移。 如何使用不同区块链提供的资源，这一问题仍然没有答案。 + +比较现有的跨链技术如Cosmos [[3]] 和 Polkadot[[4]]，提出的跨链技术，我们发现Cosmos为互操作性和可扩展性提供了更成熟的基础。 尤其我们发现Cosmos的多枢纽多分区（ "many hubs and many zones" ）和每个分区都是独立的区块链，拥有独立的治理模型（ "each zones are independent blockchains having independent governance models" 的设计，提供了一种非常合适的体系架构，可以用SOC（Seperation of Concern，SOC）的方式对现实世界的复杂性进行建模。 为了最好地重用现有框架，我们提出了IRIS网络（IRIS Network），它是由一个枢纽和众多分区构成的去中心化的跨链网络，基于Cosmos/Tendermint [[5]]实现，具有更为完善的通证使用。 + +鉴于IRIS网络是基于Cosmos/Tendermint设计的，我们将首先讨论Cosmos/Tendermint，总结我们从Cosmos/Tendermint继承的特性和独特的创新。 + +### Cosmos 和 Tendermint + +Cosmos[[3]]想要建立“区块链的互联网”。 这是由许多被称为分区“Zone”的独立区块链构成的互联网络，每个分区都由经典的拜占庭容错（Byzantine fault-tolerant，BFT）共识协议（如Tendermint）提供支持。 + +Tendermint提供了一个高性能、一致的、安全的BFT共识引擎，严格的分叉问责保证能够控制作恶者的行为。Tendermint非常适合用于扩展异构区块链，包括公有链以及注重的性能的许可链/联盟链，像Ethermint [[6]]就是一次对Ethereum以太坊POS机制的快速实现。 使用Tendermint在许可/联盟链域中的成功案例包括Oracle [[7]]，CITA [[8]] 和Hyperledger Burrow [[9]]。 + +Tendermint作为共识协议用于在Cosmos Hub上构建第一个分区。Cosmos Hub可以连接到许多不同类型的分区，并且通过一种相当于区块链之间的虚拟UDP或TCP的IBC协议（ Inter-blockchain Communication，IBC）实现跨链通信。 通证可以安全地通过Cosmos Hub从一个分区转移到另一个分区，而不需要在分区之间的交易所或受信任的第三方。 + +为了使用Cosmos Hub开发强大的可互操作区块链和区块链应用，Cosmos SDK提供了区块链常用模块的开发“入门套件”，而不是限制可实现的用户故事，从而为应用定制提供了最大的灵活性。 + +### IRIS 技术创新 + +IRIS网络的目标是为构建分布式商业应用提供技术基础设施，它超越了主要用于数字资产的现有区块链系统。 + +我们打算通过IRIS网络解决的关键挑战在于两个方面： +- 利用分布式账本支持链下运算资源的集成和协同 +- 服务跨异构区块链的互操作性 + +我们通过将面向服务的基础架构融入Cosmos / Tendermint来应对这些挑战。 + +我们的设计继承了多年来面向服务架构（Service-oriented Architecture，SOA）实践的思维模式。 SOA是一种架构方法，用于创建由自治服务构建的系统，这些系统具有明确的边界、共享模式和契约[[13]]。早期的SOA实践侧重于实施企业服务总线（Enterprise Service Bus，ESB），通过服务提供者和服务消费者之间的各种点对点连接组成公用总线，实现服务间的通信。但是，通过ESB集中管理服务可能会触发单点故障，也会增加服务部署的依赖性。最近大量的微服务架构可以看作是SOA的发展，不再关注ESB而是使用轻量级的消息队列进行服务间通信。在IRIS网络中，服务之间的通信旨在通过实施区块链作为信任机器来协同实现商业协作，使它在服务提供者和服务消费者之间很难建立信任的前提下也能运行。 + +IRIS网络使用Tendermint协议作为高性能的共识引擎。利用Tendermint的区块链应用接口（Application BlockChain Interface，ABCI）提供的灵活性，我们定义了一组服务的基础交易类型，包括：服务提供，服务消费和服务治理。如前所述，大多数业务逻辑不适合作为区块链上确定的智能合约来实施，我们正在使用这个服务层将业务应用的特定逻辑和事务处理移出区块链，仅使用区块链对这些服务产生的结果达成共识。这一想法也受到区块链社区已有成果的启发，将一些复杂计算从主链上移除以解决性能问题，例如Lightning Network的离线状态通道[[10]]以及Plasma的防欺诈侧链[[11]]。尽管我们没有实施侧链，但是我们将传统业务逻辑计算从区块链中剥离出来，并将其用作复杂业务协作的可信中介总线。 + +对于跨链通信，Cosmos IBC [[12]]定义了一个协议用于将价值从一条链上的某个帐户转移到另一条链上的某个帐户的协议。而IRIS网络设计了新的语义，以允许利用IBC调用跨链计算资源。我们认为这种能力在构建可扩展的业务应用程序时非常重要。更详细的潜在用例将会在后面描述。 + +IRIS网络旨在提供服务基础设施，以处理和协同链上的交易处理与链下的数据处理和业务逻辑执行。必要时，扩展的IBC功能允许那些链下的处理被跨链调用。 按目前的设想，IRIS网络还将包含客户端工具，一个支持跨链多资产存储的智能钱包以及服务消费方和提供方使用的iServices。 我们计划提供SDK以轻松构建iServices。 例如，对于特定的服务定义，客户端Client SDK将生成服务提供方的框架以及服务消费方的模块。 + +
+ +## IRIS 网络设计 + +![img](https://github.com/irisnet/irisnet/blob/master/images/chap2-1.png?raw=true) + +如上图所示，IRIS网络在设计上与Cosmos网络具有相同的拓扑结构。 我们计划将IRIS Hub作为Cosmos众多分区和区域型Hub之一与Cosmos Hub连接起来。IRIS SDK本身就是计划对Cosmos SDK的扩展，由IRIS SDK开发的IRIS全节点旨在提供一个服务的基础设施，并在内部集成了分布式文件系统IPFS（InterPlanetary File System,IPFS）。 + +IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定（服务提供方注册）、调用到治理（分析和争端解决）的全生命周期传递，来跨越区块链世界和传统业务应用世界之间的鸿沟。 IRIS SDK通过增强的IBC处理逻辑来支持服务语义，以允许分布式商业服务在区块链互联网上可用。 + +尽管IRIS网络专注于为分布式业务应用提供创新解决方案，但它仍是Cosmos网络的一部分。 连接到IRIS Hub的所有分区都可以通过标准IBC协议与Cosmos网络中的任何其他分区进行交互。此外，我们相信通过引入服务语义层可以实现全新的业务场景，创新的IRIS网络将增加Cosmos网络的规模和多样性。 + +### 网络参与者 + +1. **服务消费者** 服务消费者是通过向网络发送请求并接收响应来使用链下服务的用户。 + +2. **服务提供者** 服务提供者是那些可能提供一个或多个iService定义的用户，并且通常是其它公有链和联盟链甚至传统企业应用系统中链下服务和资源之间的适配器。服务提供者监听和处理传入的请求，并将结果发送回网络。一个服务提供者可以向其它服务提供者发送请求而同时成为服务消费者。服务提提供者可以按计划为他们提供的任何服务收取费用，默认情况下服务费使用IRIS网络的原生费用通证“IRIS”定价；也可以在适当的时候考虑使用Cosmos白名单中的其他费用通证对服务定价。 + +3. **分析员** 分析员是一种特殊用户，代表了发起建立IRIS网络的IRIS基金会有限公司（IRIS Foundation Limited），这是一家注册在香港的股份有限公司。分析员是在分析模式中调用iServices的唯一授权用户，旨在帮助创建和维护服务提供者的概要文件，通过这些客观的概要文件服务消费者可以选择合适的服务提供者。 + +### IRIS 服务 + +在本节中，我们列出了在IRS网络上部署iService时预计使用的技术参数。 + +**服务定义** + +`Method`包括 : + +* `ID (int)`: iService中该方法的唯一标识 +* `Name (string)`: iService中该方法的唯一名称 +* `Description (string)`: 对该方法的描述 +* `Input (string)`: 对输入参数的结构化定义 +* `Output (string)`: 对输出结果的结构化定义 +* `Error (string)`: 对可能出现的错误条件的结构化定义 +* `OutputPrivacy (enum)`: 设置此方法是非隐私的还是公钥加密的，可选值`NoPrivacy`/`PubKeyEncryption` + +`ServiceDefinition`包括: + +* `Name (string)`: 该iService服务的名称 +* `Description (string)`: 对此iService服务的描述 +* `Tags (string)`: 此iService服务以逗号分隔的关键字 +* `Creator (string)`: 对此iService服务创建者的描述. *可选* +* `ChainID (string)`: 最初定义此iService服务的区块链标识 +* `Messaging (enum)`: 设置此服务消息是单播还是多播，可选值`Unicast`/`Multicast` +* `Methods ([]Method)`: 定义此iService服务中可用的方法 + +`CreateServiceDefinitionTx` 交易包括: + +* `Definition (ServiceDefinition)`: 创建的服务定义 + +**服务绑定**: + +`CreateServiceBindingTx` 交易包括: + +* `DefinitionHash ([]byte)`: 服务定义的哈希值，由服务提供者绑定 +* `ChainID (string)`: 服务提供者所接入的区块链标识 +* `ProviderAddress ([]byte)`: 服务提供者的区块链地址 +* `BindingType (enum)`: 对服务是本地还是全局的设置，可选值`Local`/`Global`；其中`Global`选项将绑定暴露到全局，反之则使用`Local` +* `ProviderDeposit (int64)`: 服务提供者的保证金。服务提供者必须提供大于系统参数`MinProviderDeposit`所设（以IRIS通证计数）的保证金，才能创建有效的绑定，押金越高意味着更值得信任 +* `ServicePricing (string)`: 服务定价。基于每个方法对服务价格模型的结构化定义，包括每次的调用成本、批量折扣、促销条款等；服务费默认使用IRIS通证也可以是白名单列出的其它费用通证 +* `ServiceLevel (string)`: 服务水平。对服务提供者自己认可所绑定服务水平的结构化定义，包括响应时间、可用性等。 +* `BindingExpiration (int64)`: 此绑定过期的区块高度，采用负数即表示“永不过期” + +`UpdateServiceBindingTx` 交易包括: + +* `DefinitionHash ([]byte)`: 服务定义的哈希值，由服务提供者绑定 +* `ChainID (string)`: 服务提供者接入区块链标识 +* `ProviderAddress ([]byte)`: 服务提供者的区块链地址 +* `ChangeSet (string)`: 更改集，由前面三个字段确定的现有绑定所需更改内容的结构化定义 + +![img](https://github.com/irisnet/irisnet/blob/master/images/chap2-2.png?raw=true) + + +服务提供者可以在任何时间更新`ServicePricing`，`ServiceLevel`和`BindingExpiration`，但他们的少量保证金将随后续（分别由`ServiceLevelUpdateSlash`和 `BindingExpirationUpdateSlash`规定的）两种情况减少。当`BindingExpiration`设置的高度低于当前区块高度，将立即被解释为无效的绑定。 + +更新 `ProviderDeposit`将始终被视为*adding to*，即增加当前保证金余额。当保证金低于`MinProviderDeposit`时，绑定将失效，直到服务提供者增加余额高于阈值方可恢复。绑定过期或者失效的时候，保证金余额将自动返还给服务提供者。 + +`BindingType`可用从`Local`更改为`Global`，但反之不行。要把一个绑定从`Global` 降到 `Local`，服务提供者只能先使绑定的问题失效，然后重新创建一个 `Local`型的绑定。 + +如果服务提供者出于某种原因需要将绑定移到一个新地址，是不允许直接更新`ProviderAddress`的；必须先使当前绑定失效，再使用所需的 `ProviderAddress`创建另一个绑定. + +一个 `ServiceBinding` 的对象将在应用程序成功的执行这两个交易时（例如，在IRIS SDK种的iService业务逻辑）被创建或更新. + +`ServiceBinding`包括: + +* `DefinitionHash ([]byte)` +* `ChainID (string)` +* `ProviderAddress ([]byte)` +* `ServiceLevel (string)` +* `ServicePricing (string)` +* `BindingExpiration (int64)` +* `IsValid (enum)`: 可选项`True`/`False` + +**服务调用** + +![img](https://github.com/irisnet/irisnet/blob/master/images/chap2-3.png?raw=true) + +服务消费者和服务提供者被建议通过 *端点（endpoints）* 交互。有两种服务端点 —— *请求表（request table）* 和 *响应表（response table）* （见上图）。服务请求被添加到请求表，感兴趣的服务提供者监控这些请求表并接收和处理发送给他们的请求; 服务结果（或错误）被返回由相应的服务消费者反过来监控的响应表中。 + +`Multicast`多播服务的所有绑定共享一个请求表;而`Unicast`单播服务为每个绑定创建和维护单独的请求表。 至于另一个方向（的服务）将为每个服务消费者创建和管理专用的响应表。 + +`ServiceRequest`交易包括: + +- `ChainID (string)`: 服务消费者所接入的区块链标识ID +- `ConsumerAddress ([]byte)`: 服务消费者所的区块链地址 +- `DefinitionHash ([]byte)`: 服务定义的哈希值 +- `MethodID (int)`: 被调用的方法ID +- `InputValue (string)`: 输入值的结构化表示 +- `BindingHash ([]byte)`:在'Unicast'单播服务情况下目标绑定的哈希值。 *可选* +- `MaxServiceFee (int64)`: 服务消费者愿意为一个'Multicast'多播请求支付的最大服务费金额 。*可选* +- `Timeout (int)`: 服务消费者愿意等待响应返回的最大区块数 + +`PostServiceRequestTx` 交易包括: + +- `Requests ([]ServiceRequest)`: 被发送的服务请求 +- `RequestDeposits ([]int64)`: 服务消费者必须为每个请求者(使用IRIS计数)支付大于`MinRequestDeposit`的押金。此押金目的是为了激励消费者及时确认收到的服务响应（参考 `ConfirmServiceResponseTx`). + +应用程序将验证用户与'ChainID'和'ConsumerAddress'一致的每一个请求、目标绑定的有效性、请求押金充足，服务消费者帐户余额足够支付请求押金和服务费用，并且请求的总数小于`MaxRequestPostBatch`。 + +当一个已验证请求被追加到请求表中时，相关服务费用（对'Multicast'多播方式是'MaxServiceFee'）将从服务消费者的账户中扣除并锁定到第三方托管。 + + `GetServiceRequest` 查询包括: + +- `DefinitionHash ([]byte)`: 服务定义的哈希值 +- `BindingHash ([]byte)`: 服务提供者对此问题绑定服务的哈希值; 应用程序将验证绑定有效，并且调用者具有匹配绑定的区块链标识`ChainID`和服务提供者地址`ProviderAddress` +- `BeginHeight (uint64)`: 应用程序应当从此区块高度开始检索对服务提供者的请求，一般是最大请求数'BatchSize'和'MaxRequestGetBatch'中较小的一个 +- `BatchSize (int)`: 返回的最大请求数 + + `ServiceResponse` 查询包括: + +- `RequestHash ([]byte)`: 所匹配请求的哈希值 +- `BindingHash ([]byte)`: 服务提供者绑定服务的哈希值 +- `OutputValue ([]byte)`: 输出结果的结构化（可能加密）表示。*可选* +- `ErrorMsg (string)`: 错误信息的结构化表示。*可选* + + `PostServiceResponseTx` 交易包含: + +- `Responses ([]ServiceResponse)`: 服务回复内容 + +应用程序将验证服务提供者的每个响应是否带有匹配的区块链标识`ChainID`和地址`ProviderAddress`，并且该交易中的响应数少于`MaxResponsePostBatch`。经过验证的请求将附加到目标消费者的响应表中。 + +`GetServiceResponse` 查询包括: + +- `RequestHash ([]byte)`: 原始请求的哈希值，应用程序将校验调用者是否有匹配的区块链标识'ChainID'和服务消费者地址'ConsumerAddress' +- `BeginHeight (uint64)`: 应用程序应当从此区块高度开始检索服务提供者的响应，一般是最大响应数`BatchSize`和`MaxResponseGetBatch`中的较小的一个 +- `BatchSize (int)`: 返回的最大响应数 + +`ConfirmServiceResponseTx` 交易包含: + +- `ResponseHash ([][]byte)`: 待确认响应的哈希值 + +应用程序将验证每个待确认响应是否确实是由调用者发起的请求，并且此交易中的响应数量小于`MaxResponseConfirmBatch`。 + +从`Timeout`超时窗口中退出的响应(对于'Multicast'多播服务，当`MaxServiceFee`随响应返回增加而消耗光时)将不会被应用程序接受。服务消费者一收到'Unicast'单播响应就立即开始处理。然而，对于`Multicast`多播响应，必须等待`Timeout`超时窗口结束，然后才开始处理可能收到的全部响应。 + +当一个`Unicast`单播响应被用户确认，相关服务费用将从托管账户中释放到匹配的服务提供者账户 ——其中扣除少量（由'ServiceFeeTaxRate'定义的）税金并添加到*系统准备金（system reserve）* 中; 同时，相关请求的押金也将退还给服务消费者。 + +在`Multicast`多播请求的情况有点复杂：每个响应确认时，只有部分请求押金被退还给服务消费者，即此响应相关服务费用占`MaxServiceFee`的比例; 在所有的响应被确认之后，此请求剩余的托管余额将会退还给服务消费者。 + +如果请求超时而没有看到任何响应，则应用程序将托管中的相关余额以及请求押金全额退还给用户。但是，如果用户没有（在`ResponseConfirmTimeout`+响应区块数的高度之前）及时确认回复，请求押金将被执行一个（由`ResponseConfirmDelayPenaltyRate`定义的）小惩罚再退还给消费者，与此同时，相关服务费将照常释放给服务提供者。 + +**争议解决** + +在任何情况下如果服务消费者对服务响应不满意，就应该存在一种机制允许服务消费者发出投诉，从而获得可接受的解决方案，而不必求助于诸如法律系统等集中的权威。同时，这种机制应避免引入可能会被任一方滥用的主观评价。 + +解决出现在IRIS网络上的争议，其过程类似于服务调用，不仅服务消费者向服务提供者发送`Complaint`（服务），而且服务提供者以一个`Resolution`（服务）进行响应。这些交互是通过一对称为 *投诉表（complaint table）* 和 *解决方案表（resolution table）* 的全局端点来实现的。 + +在IRIS网络目前的设计中，提交投诉时需要一份消费押金。如果服务消费者不及时确认某个解决方案，将从该押金中扣除罚款。同样地，如果服务提供者不及时响应投诉，他的保证金将被部分削减。 + +`Complaint` 包含: + +- `ResponseHash ([]byte)`: 对争议响应的哈希 +- `Problem (string)`: 对服务响应的问题描述 +- `PreferredDisposal (enum)`: 可以是`Refund`或`Redo`选项 + +`Resolution`包括: + +- `ComplaintHash ([]byte)`: 对所匹配投诉的哈希 +- `Disposal (enum)`: 可以是`Refund`或`Redo`选项 +- `Refund (uint64)`: 服务费退款. *可选* +- `OutputValue ([]byte)`:输出结果的结构化（可能加密）表示。 *可选* + +如上所述，我们预期的争议解决流程可能不具有法律约束力。尽管如此，我们认为这将为解决IRIS网络上的常见争议提供有效手段。 + +**服务分析** + +引入iService生态系统带来一些挑战。一个主要的挑战是找到一种方法，让服务消费者更容易发现合适的服务提供者——服务消费者需要性能指标来评估和选择服务提供商，但如果没有服务消费者的使用，性能指标也就不可用。 + +为了试图解决这个循环问题，我们计划引入一种分析机制，在这个机制中，一个享有特权的系统用户即分析员，在常规的调度下调用所有活动的服务。这将使网络中的客观性能数据（例如响应时间、可用性、投诉处理等）对实际消费者有用。 + +服务分析调用将免除服务费用和消费押金，但会产生网络交易费用。这些调用来自那些被应用程序识别和认可的保留地址。 + +对于新服务，分析活动将保持相对稳定的水平，随着它们开始吸引真正的服务消费者调用并预计生成更多的性能数据，分析活动将逐渐减少单个服务的使用。 + +分析过程中发生的交易费用默认情况下从系统准备金（system reserve）中支付，必要时基金会准备金（Foundation reserve）将会介入。 + +**查询** + +上述所有与服务生命周期相关的对象都可以使用ABCI 'Query'接口[\[3\]]查询到。这些查询将通过'Query'连接执行，并不参与共识过程。我们已经看到了如何得到的`GetServiceRequest`和得到`GetServiceResponse`查询作为服务调用过程的一部分。 +上面描述的所有与服务相关的生命周期对象都可以使用ABCI查询接口3来查询。 + +以下是我们目前计划的查询的一个非详尽的摘要： + +**服务对象** + +| Object | Commonly Used Filters | Authorization | +| ---------------------------------------- | ------------------------------------------------------------ | ------------------------ | +| Service Definition | Name, keywords, source (chain ID), messaging type, with active bindings... | Anyone can query | +| Service Binding (for a given definition) | Location (local or remote), pricing, service level, expiration... | Anyone can query | +| Service Request | Service definition and binding, blockchain height, batch size | Only matched provider(s) | +| Service Response | Service request, blockchain height, batch size | Only matched consumer | + + +**性能指标** + + +| Area | Metrics | Authorization | +| --------------------------- | ------------------------------------------------------------ | ---------------- | +| Provider (address) | Number of services provided (ever and active), response time (min, max and average), requests served (local and remote), requests missed, complaints received, complaints ignored, ... | Anyone can query | +| Provider (binding) | Active time, response time (min, max and average), requests served (local and remote), requests missed, complaints received, complaints ignored, ... | Anyone can query | +| Consumer | Number of services ever used, requests made, requests confirmed (in time and missed), complaints made, resolutions confirmed, ... | Anyone can query | +| Consumer (service, binding) | Requests made, requests confirmed (in time and missed), complaints made, resolutions confirmed, ... | Anyone can query | + +### IBC 改进 + +在Cosmos上建立自己的服务基础架构有一个独特优势：*服务可以部署一次，并通过区块链互联网随时随地进行调用*。具体来说，我们的计划是完成以下内容： +1. 服务定义广播到IRIS网络中的每个分区； +2. 全局服务绑定广播到IRIS网络中的每个分区； +3. 针对远程提供者的服务请求或投诉被路由到提供者所连接的区块链； +4. 针对远程消费者的服务响应或决议被路由回消费者所连接的区块链。 + +在处理一个`CreateServiceDefinitionTx`交易时，应用程序被设计为首先在本地验证和存储`ServiceDefinition`对象，然后创建一个包含了对每个相邻链定义的`IBCPacket`。 + +每个相邻链最终从相应的中继过程中接收包含该数据包的`IBCPacketTx`；如果此定义在接收链中尚不存在，则后者将通过为他的每个相邻链（除了最初接收数据包的源链之外）创建一个`IBCPacket`来传递此定义；如果该定义已经存在，接收链将停止传递此定义。 + +同样，当`ServiceBinding`创建或更新它的`BindingType`集合或更新为`Global`时，将为每个相邻链创建一个包含绑定的`IBCPacket`数据包，并在整个IRIS网络中进行广播。 + +上述`IBCPacket`由以下部分组成： + + +- `Header (IBCPacketHeader)` ：数据包的头部 + + +- `Payload（ServiceDefinition或ServiceBinding）`：服务定义或绑定的字节数 + +前面提到的`IBCPacketHeader`由以下部分组成： + +- `SrcChainID（string）`：创建此数据包的区块链标识ID +- `DstChainID（string）`：此数据包将派往的相邻区块链标识ID +- `Number（int）`：数据包对应的唯一编号 +- `Status（enum）`：'NoAck' +- `Type (string)`：“iris-service-definition”或者是“iris-service-binding” + +现在让我们来看看如何通过IBC发生跨链服务调用。当请求一个`Unicast`单播服务时，应用程序检查目标绑定是否是`Local`本地的，如果是`Local`则将`ServiceRequest`追加到相应的请求表中，如2.2所述；否则，将会创建一个包含`ServiceRequest`的`IBCPacket`。 + + +包含一个'ServiceRequest'的`IBCPacket`由以下部分组成： + +- `Header（IBCPacketHeader）`：数据包的头部 +- `Payload（ServiceRequest）`：服务请求的字节数 + +前面提到的`IBCPacketHeader`由以下部分组成： + +- `SrcChainID（string）`：创建此数据包的区块链标识ID +- `DstChainID（string）`：远程服务提供者所在的区块链标识ID，例如'ServiceRequest'、'ServiceBinding'、'ChainID' +- `Number（int）`：数据包对应的唯一编号 +- `Status（enum）`：'AckPending' +- `Type（string）`：“iris-service-request” +- `MaxHeight（int）`：当前高度加上'ServiceRequest.Timeout' + +当远程请求最终到达目标链时，应用程序将其追加到相应的端点（请求表）中，以便进行目标绑定。对此远程请求的响应将被包装在一个收据IBCPacket中，该收据被一直路由回到源链，并将其追加到原始消费者的远程端点（响应表）中。 + +对远程的`Multicast`多播服务的请求以相同的方式处理，只不过可以在源链中生成多个`IBCPacket`。 + +远程投诉和解决的工作方式与请求和响应的方式相同，因此在此不做详细阐述。 + +下面是应用程序依赖`IBCPacket`类型的完整列表： + +| **类型** | **iService 对象** | +| ------------------------- | ------------------- | +| "iris-service-definition" | ServiceDefinition | +| "iris-service-binding" | ServiceBinding | +| "iris-service-request" | ServiceRequest | +| "iris-service-response" | ServiceResponse | +| "iris-complaint" | Complaint | +| "iris-resolution" | Resolution | + +
+ +## 用例 + +在本节中，我们为IRIS网络列出了一些可能的用例。 + +### 分布式人工智能用于隐私保护下的数据分析 + +这个用例的服务基础架构已由位于上海的初创公司`边界智能`进行了原型设计，并将其应用到联盟链产品`BEAN (BlockchainEdge Analytics Network)`中，用于解决长期已来为运行分析模型获取数据的挑战。尽管同态加密是允许通过加密数据实现计算的关键方法之一，但由于性能低下，实际上无法解决现实世界的机器学习问题。因此，BEAN的创建提供了另一种解决方案--利用传统的分布式人工智能研究[[14]]中的模型并行性和SOA设计模式，作为区块链的附加层开发分布式分析服务。 + +为了保护数据存取，运行在数据端的（部分）模型需要开放给客户端，并在服务定义中说明。由于只有部分模型开放给客户端，模型开发人员不必担心有人窃取他们的想法；同样，数据拥有者永远不需要担心失去对其数据使用的控制，因为数据不会离开他们的数据源。 + +其他潜在的好处可能包括以下几点： + +1. 仅在链上交换少量参数数据，这可以帮助提高性能。 + +2. 一种更实用的数据使用审计方法，这在医疗保健领域经常被用到。 + +医疗健康数据隐私度高，涉及众多安全需求。这就为医疗健康数据用于跨组织协作的目的提出了挑战（例如用于辅助诊断的跨医院会诊记录搜索，新药临床试验的患者身份，健康保险自动理赔等）。最小化可行产品（Minimum Viable Product,MVP）服务层的实现是建立在`Ethermint`的基础之上，试图连接众多医院、保险公司和分析服务提供者，以提供具有隐私保护的医疗健康数据分析能力。 + +支持链上服务注册和调用的智能合约已经实现。链下数据处理的一个例子是支持相关诊断组（Diagnosis Related Group,DRG）的分组分析服务。更具体地说，当一个医院用户调用DRG服务时，原始医疗记录将在链下进行处理，使用服务提供者提供的客户端NLP(由SQL和Python实现)代码存根来提取通过区块链接收DRGS服务传来的结构化数据，而不传递高度机密的原始医疗记录。 + +`BEAN`场景阐述了一个更复杂的服务使用案例，包括实现分布式分析、连接服务提供者和服务消费者、利用区块链提供可审计交易平台以及可信任的分布式计算基础。 + +### 数据和分析电子市场 + +通过对几个AI+区块链项目的研究，发现似乎大部分项目都旨在提供数据交换市场和分析API市场。在建议的`IRIS`基础架构中，通过使用`IRIS`服务提供者SDK来发布数据作为数据服务和包装分析API作为分析服务，从而轻松地构建这些网络。 + +### 分布式电子商务 + +将建议的`IRIS`基础架构与传统系统（例如`ERP`）集成以获取库存信息，或对可信数据源进行链间查询以获取交通和天气数据等信息，此方法与许多企业应用程序开发人员已经熟悉的方法非常相似。通过集成这些服务来支持分布式电子商务应用程序，就有可能提供与中心化系统（例如Amazon亚马逊或Alibaba阿里巴巴）相近的用户体验。 + +### 公有链和联盟链的结合 + +对于许多业务场景而言，采用混合了公有链和联盟链优良特性的混合架构，从而可以提供有益的结果，特别是在性能、安全性和经济激励方面。 + +例如，医院和保险公司可以组成联盟链以支持高性能的医疗保险交易，同时识别其他信息，例如关于某些疾病的全球服务的统计数据，这些信息可以从其他公有链中调用。从公有链接收到的通证可以返回给联盟链中的信息提供者，从而激励系统参与者改善和提高服务质量。利用`IRIS`提供的这种基础架构，可以在满足严格的性能和安全要求的前提下实现大规模的自发协作。 + +`IRIS`服务基础架构可以支持许多用例，例如更高效的基于资产的安全系统、分布式监管技术（如严格评估，互助市场等）。IRIS项目计划之一还包括与此类应用程序项目团队展开密切合作，以支持并使他们能够拥有所需的区块链基础架构，让他们专注于更高效地交付预期的业务价值。 + +
+ +## 通证经济 + +与Cosmos网络相似，IRIS网络也被设计为支持多通证模型。这些通证被不同的分区所拥有，同时可以通过IRIS枢纽从一个分区转移到另一个分区。我们构建了两种通证类型来支持IRIS网络上的操作： + +- 权益通证 +- 费用通证 + +### 权益通证 + +与Cosmos网络 [[15]][15]采用同样的权益机制设计，IRIS枢纽也拥有自己特殊的原生通证来表示权益。通证命名为`IRIS`。关于IRIS通证，我们设计了一些具体功能，其包括： + +- 通过验证人和代理人系统，将IRIS通证整合到IRIS网络的共识引擎验证人中; +- 代表投票权，参与IRIS网络的治理 + +### 费用通证 + +在IRIS网络中有两种费用通证: + +- **网络费用** 用来进行垃圾请求防范和支付验证人进行账本维护的报酬; +- **服务费用** 用来支付部署iServices的服务提供者的报酬。默认支付服务的通证为IRIS通证 + +IRIS网络旨在支持所有来自Cosmos网络白名单中的费用通证，例如 [Photon光子](https://blog.cosmos.network/cosmos-fee-token-introducing-the-photon-8a62b2f51aa), 以及IRIS通证。 + +支持各种白名单的中的费用通证是我们计划从Cosmos中采用的一个特性。它可以为网络的参与者提供增强的体验。在Cosmos中，对于网络费用通证`network fee token`，每一个验证人都拥有配置文件来定义他自己对每一个费用通证的价值评估。验证人可以运行一个独立的定时器，根据实时市场数据更新配置信息，或者使用默认的配置数据。 + +对于服务费用通证`service fee token`的设计，同样支持多通证模型。因此，在IRIS网络上的服务提供者，可以自由选择白名单中出现的通证为其服务收费。 + +为了帮助IRIS网络的参与者降低通证价格的波动性，基金会希望发展全球性的iService以从不同的交易所、或者从oracle预言机的潜在信息中获取市场价格数据。 + +权益通证和费用通证都会进一步细化以确保符合法律和监管规定的义务。 + +
+ +## 初始通证分配 + +最开始，系统预计发放2000000000个IRIS通证。IRIS通证的分布计划如下： + +- **私募**: 20% +- **核心开发团队**: 20% (自IRIS Hub主网上线起的4年成熟期，每月释放1/48。) +- **IRIS 基金会**: 15% (保留用作基金会的日常建设和运营) +- **生态建设**: 45% (在链接到IRIS Hub的分区中进行通证交换；激励潜在用户；奖励的合作伙伴) + +如果IRIS网络完全开发完毕，IRIS通证每年的通胀速率会根据账户进行调整，因为事实上，很大一部分流通中的IRIS通证都将被参与者作为权益证明主动投入到共识引擎中。 + +首要说明的是，私募的IRIS通证将用于开发IRIS网络。这部分通证的使用计划如下： + +- **运营**: 10% (包括服务提供者和承建商的费用，例如，审计、顾问、法律和其他第三方费用，以及其它管理费）) +- **软件开发**: 50% (包括直接用于开发上线所需的成本、费用和开支) +- **开发者支持**: 10% (包括黑客马拉松、志愿者奖励和培训项目) +- **研发赞助**: 10% (包括会议、研究项目和大学合作) +- **市场拓展**: 20% (包括业务发展，社区发展和推广，以及出差、交流、出版、发行和其他费用等) + +
+ +## 路线图 + +预期的IRIS项目路线图如下。这里我们重申一下，路线图只是一个大概方向，将来根据项目实施会有变化。 + +- **盘古**（2018年1月~2018年7月）：IRIS项目的第一阶段，将集中在构建和运行IRIS Hub以及与Cosmos Hub的交互。同时，我们将发布一个初始版本的IRIS网络移动客户端。 + +- **女娲**   (2018年7月~2018年11月)：第二阶段主要集中在构建IRIS Service Layer。这将涉及启用服务定义、绑定、调用和查询。在这个阶段，我们也打算为开发者准备一个beta版的IRIS SDK。 + +- **夸父** （2018年12月~2019年5月）：第三阶段主要专注于IRIS网络的增量升级，以支持我们计划中先进的IRIS Service治理特性。 + +- **后裔** （2019年6月之后）：第四阶段专注在IRIS网络、IRIS SDK和移动客户端的技术创新，以及开发者的参与。 + +
+ +## 团队 + +**Tendermint** (该团队开发了 [Tendermint](https://www.tendermint.com)共识引擎，当前正在开发Cosmos), **Wancloud万云** ( [万向区块链](http://www.wxblockchain.com) 子公司)和 **边界智能** 将共同构建IRIS网络的基础设施。 + +Tendermint将在扩展Tendermint ABCI和Cosmos IBC技术方面，为IRIS项目团队提供技术咨询和开发支持。[Wancloud万云](https://www.wancloud.io) 将是Cosmos和IRIS生态系统的关键战略合作伙伴，它将积极参与Cosmos和IRIS在亚太地区的开发和发展。 + +边界智能将是IRIS网络的核心开发团队，IRIS充分借助团队创建分布式智能分析服务的经验，实现医疗数据分析与交换。边界智能是一家于2016年在上海成立的初创公司，专注于利用先进的区块链技术和人工智能技术为医疗和金融行业开发创新产品和提供解决方案。边界智能中的一个核心产品`BEAN`（区块链智能信息边缘分析网络Blockchain Edge Analytics Network）是一条许可链，它利用自然语言分析及机器学习技术为隐私保护、医疗健康数据的分析和交换提供分布式智能分析服务。边界智能正不断扩展`BEAN`功能来构建IRIS网络，同时，**边界智能**也是Cosmos网络在中国的运营和服务合作伙伴。 + +### 核心成员 + +**曹恒** + +[曹恒](https://www.linkedin.com/in/harrietcao/) 是边界智能的创始人，该公司是一家成立于上海的初创公司。边界智能专注于利用分布式AI技术为区块链提供智能化服务，支持可信高效的行业协作。曹恒是曾获得过2010年美国运筹学和管理学研究协会（INFORMS）颁发的数据分析和人工智能技术领域的“Daniel H. Wagner”大奖。在创立边界智能之前，曹恒在IBM 研究院工作16年，曾担任IBM研究院上海研究院院长，是前IBM全球研究院大数据分析技术带头人。曹恒拥有卡耐基梅隆大学机器人硕士学位和清华大学自动化控制学士学位。 + +**奚海峰** + +[奚海峰](https://www.linkedin.com/in/haifengxi/) 是高级技术专家和企业家。自2009年从美国归国以来，他曾在三家公司担任首席技术官，其中一家是纳斯达克上市公司。他还在上海联合创立过两家初创公司，并在那里担当技术和工程学的领导角色。奚海峰拥有马里兰大学电子与计算机工程硕士学位，以及清华大学自动化控制硕士和学士学位。 + +**Jae Kwon** + +2005年，[Jae](https://www.linkedin.com/in/yjkwon/)毕业于康奈尔大学计算机科学学士学位后，曾在硅谷担任软件开发工程师，起先在亚马逊从事Alexa开发工作，后来在Yelp带领移动应用开发团队。Jae在认识到区块链问题后，开发了Tendermint BFT共识算法和Tendermint Core共识引擎。Tendermint是第一个可信的PoS算法。 除了开发Tendermint之外，Jae还是Cosmos的创始人之一。 + +**陶曲明** + +[陶曲明](https://www.linkedin.com/in/tom-tao-14763a45/)自2016年8月加入万向以来，便负责万向区块链集团的咨询服务，万云BaaS平台，以及ChainBase加速器和孵化器服务。在加入万向前，他曾在多家全球领先企业里积累了超过18年的丰富服务管理和业务管理的实践经验。Tom率先将云服务，物联网数据服务平台和加速器技术引入中国市场。自2013年起，Tom一直在跟踪区块链，云计算，物联网和智能制造行业的发展趋势。Tom拥有复旦大学物理学硕士学位和南开大学电气工程学士学位。 + + +### 顾问 + +**Jim Yang** + +[Jim Yang](https://www.linkedin.com/in/jimyang/) 是Tendermint首席运营官。 他是ChatX移动信息工作室的创始人兼首席执行官。 ChatX开发了各种移动消息/社交应用程序。 他还共同创立了Identyx并一直担任CEO至被Red Hat收购。 Identyx开发一个开源企业身份管理软件。 + +**Zaki Manian** + +[Zaki Manian](https://zaki.manian.org)是可信物联网联盟执行董事，也是区块链和加密货币技术发展的丰富贡献者。 Zaki在密码学和分布式共识系统方面拥有深厚的专业积累。 他还是Cosmos项目以及其创业项目的顾问。 + +**Adrian Brink** + +[Adrian Brink](https://adrianbrink.com), 是Tendermint / Cosmos 网络的核心开发者和社区负责人。 + +**Michael Yuan** + +[Dr. Michael Yuan](http://www.michaelyuan.com) 博士是 [CyberMiles Foundation](https://cm.5miles.com)基金会的负责人。Michael在德克萨斯大学奥斯汀分校获得了天体物理学博士学位。 他编写的5本关于软件开发的书已由Prentice Hall，Addison-Wesley和O'Reilly出版。 Michael是Firefox，Fedora，JBoss等大型开源项目中的活跃代码提交者。 他是企业应用软件和移动软件方面的专家，也是参与了多个由美国政府资助的研究项目。 + +
+ +## 参考文献 + +[1]: https://drive.google.com/file/d/1bI7JIOe-CfJ5fPHKxYlFub2Kg-KCGU6r/view?usp=sharing +[2]: http://ethdocs.org/en/latest/ +[3]: https://cosmos.network/whitepaper +[4]: https://polkadot.io/ +[5]: https://tendermint.readthedocs.io/en/master/ +[6]: https://ethermint.zone/ +[7]: http://www.freepatentsonline.com/y2017/0236120.html +[8]: https://github.com/cryptape/cita-whitepaper/blob/master/en/technical-whitepaper.md +[9]: https://github.com/hyperledger/burrow +[10]: https://lightning.network/lightning-network-paper.pdf +[11]: https://www.plasma.io/plasma.pdf +[12]: https://github.com/cosmos/ibc/blob/master/README.md +[13]: https://www.amazon.com/SOA-Principles-Service-Thomas-Erl/dp/0132344823 +[14]: http://www.cs.toronto.edu/~ranzato/publications/DistBeliefNIPS2012_withAppendix.pdf +[15]: https://medium.com/@tendermint/b5b2c682a292 +[16]: https://drive.google.com/file/d/1jtyYtx7t1xy9gxEi2T5lXFNd8xUY7bhJ/view + +* [1] Wanxiang Blochchain Inc., Distributed Business Value Research Institute,"Blockchain and Distributed Business Whitepaper", September 2017. +* [2] Ethereum Foundation, "Ethereum Homestead Documentation", +* [3] Jae Kwon, Ethan Buchman，"Cosmos, A Network of DistributedLedgers", +* [4] Gavin Wood, "Polkadot: Vision For a Heterogeneous Muilti-chainFramework", +* [5] Tendermint, +* [6] Ethermint, +* [7] Oracle International Corporation, "Accountability and Trust inDistributed Ledger Systems", USA Patent Application 20170236120, August17, 2017, +* [8] Jan Xie, "CITA Technical Whitepaper", +* [9] Hyperledger Burrow, +* [10] Joseph Poon, Thaddeus Dryja, "The Bitcoin Lightning Network:Scalable Off-Chain Instant Payments", January 14, 2016, +* [11] Joseph Poon, Vitalik Buterin, "Plasma: Scalable Autonomous SmartContracts", August 11, 2017, +* [12] Ethan Frey, "Cosmos IBC Specification", Sep. 29, 2017, +* [13] Thomas Erl, "SOA: Principles of Service Design", Prentice Hall;1st edition (July 28, 2007) +* [14] Dean, J., Corrado, G.S., Monga, R., et al, Ng, A. Y. "Large ScaleDistributed Deep Networks". In Proceedings of the Neural InformationProcessing Systems (NIPS'12) (Lake Tahoe, Nevada, United States,December 3--6, 2012). Curran Associates, Inc, 57 Morehouse Lane, RedHook, NY, 2013, 1223-1232. +* [15] Tendermint Blog, "Cosmos Validator Economics -- Revenue Streams",January 2018, @tendermint/b5b2c682a292 +* [16] Sunny Aggarwal, "Cosmos Token Model", December 2017, diff --git a/docs/zh/software/README.md b/docs/zh/software/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/software/basic-concepts/bech32-prefix.md b/docs/zh/software/basic-concepts/bech32-prefix.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/modules/coin/README.md b/docs/zh/software/basic-concepts/coin-type.md similarity index 100% rename from docs/zh/modules/coin/README.md rename to docs/zh/software/basic-concepts/coin-type.md diff --git a/docs/zh/modules/fee-token/Fee.md b/docs/zh/software/basic-concepts/fee.md similarity index 100% rename from docs/zh/modules/fee-token/Fee.md rename to docs/zh/software/basic-concepts/fee.md diff --git a/docs/zh/software/basic-concepts/genesis-file.md b/docs/zh/software/basic-concepts/genesis-file.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/software/basic-concepts/gov-params.md b/docs/zh/software/basic-concepts/gov-params.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/software/basic-concepts/inflation.md b/docs/zh/software/basic-concepts/inflation.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/software/cli-client.md b/docs/zh/software/cli-client.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/software/light-client.md b/docs/zh/software/light-client.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/tools/Deploy-IRIS-Monitor.md b/docs/zh/software/monitor.md similarity index 100% rename from docs/zh/tools/Deploy-IRIS-Monitor.md rename to docs/zh/software/monitor.md diff --git a/docs/zh/software/node.md b/docs/zh/software/node.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/zh/validators/How-to-participate-in-onchain-governance.md b/docs/zh/validators/How-to-participate-in-onchain-governance.md deleted file mode 100644 index 72d9a1ab8..000000000 --- a/docs/zh/validators/How-to-participate-in-onchain-governance.md +++ /dev/null @@ -1,68 +0,0 @@ -# IRISHub重的链上治理过程 - -## 什么是链上治理? - -链上治理是让验证人对区块链网络的运行达成共识的一种投票机制。 - -### 线上治理提案的类型 - -* Text -* System Parameter Change -* Protocol Upgrade [未实现] - -## 线上治理流程 - -链上治理投票分为以下三步骤： - - -* Mininimum Depost: `1000IRIS` or `1000000000000000000000iris` -* Deposit Period: 1440 blocks -* Penalty for non-voting validtors: 1% -* Pass Threshold: 50% -* Voting Period: 20000 blocks - -## 如何提交一个提案? - -任何人都可以提交链上治理提案，但你需要为此提案存入超过最低要求的押金。 - -如下的命令将执行提交一个 `Text`类型的提案: - -``` -iriscli gov submit-proposal --title="Text" --description="name of the proposal" --type="Text" --deposit="1000000000000000000000iris" --proposer= --from= --chain-id=fuxi-3001 --fee=400000000000000iris --gas=20000 --node=http://localhost:36657 -``` - -The `` for `proposer` field should start with `faa` which corresponds to ``. - - -## 如何增加投票的抵押金额? - -To add deposit to some proposal, you could execute this command to add `10IRIS` to the proposal's deposit: - -``` -iriscli gov deposit --proposalID=1 --depositer= --deposit=1000000000000000000iris --from= --chain-id=fuxi-3001 --fee=400000000000000iris --gas=20000 --node=http://localhost:36657 -``` - -##如何投票? - -In the current version of governance module, you have the following choices for each proposal: -* Yes -* No -* NoWithVeto -* Abstien - -You could put one of the choices in the `--option` field. - -To vote for a proposal, you need to get the correct ``.You could execute the following command to vote on proposal with ID = 1: -``` -iriscli vote --from=jerry --voter= --proposalID=1 --option=Yes --chain-id=fuxi-3001 --fee=2000000000000000iris --gas=20000 --node=http://localhost:36657 -``` - -## 如何查询投票信息? - -例如，查询第一个提案的信息： - -``` -iriscli gov query-proposal --proposalID=1 --chain-id=fuxi-3001 --node=http://localhost:26657 - -`````` -也可以在浏览器上查询。 diff --git a/docs/zh/validators/Setup-Sentry-Node.md b/docs/zh/validators/Setup-Sentry-Node.md deleted file mode 100644 index e1ba22465..000000000 --- a/docs/zh/validators/Setup-Sentry-Node.md +++ /dev/null @@ -1,54 +0,0 @@ -# 哨兵节点及其搭建 - -为了保证验证人节点的安全性和可用性，我们建议为验证人节点配置2个以上的哨兵节点。使用哨兵节点的好处在于可以有效地防止DoS攻击等其他针对验证人节点的攻击。 - -## 初始化一个全节点 - -为了搭建哨兵节点，首先我们需要初始化一些全节点。执行以下命令创建一个全节点(建议在多台不同的服务器上创建多个哨兵节点以提高可用性和安全性) -``` -iris init --name= --home= -``` -``是你指定的哨兵节点的地址。示例： -``` -iris init --name="sentry" --home=sentry --home-client=sentry -{ - "chain_id": "test-chain-hfuDmL", - "node_id": "937efdf8526e3d9e8b5e887fa953ff1645cc096d", - "app_message": { - "secret": "issue envelope dose rail busy glass treat crop royal resemble city deer hungry govern cable angle cousin during mountain december spare stick unveil great" - } -} -``` - - -## 修改哨兵节点的配置 - -然后将验证人节点中的genesis.json文件复制到 `/config/`目录下。接下来对`/config/`目录下的config.toml进行编辑。需要进行如下修改： -``` -private_peers_ids="validator_node_id" -``` - -这里的``可以在验证人节点上使用iriscli status命令获得。经过这样设置之后然后使用 - -``` -iris init --home= -``` - -启动哨兵节点。对每个哨兵节点都需要进行这些操作。 - -## 修改验证人节点的配置 - -接下来需要对验证人节点的`/config/`目录下的config.toml进行修改： - -``` -persistent_peers="sentry node id@sentry listen address" -``` - -这里只写sentry节点的node id和地址，多个哨兵节点的信息使用逗号分开。 - -设置`pex=false` 不与其他节点进行peers交换，这样验证人节点就不会连接除persistent_peers之外的节点。 -这里的``可以在哨兵节点上使用iriscli status命令获得。修改完成后需要重启验证人节点使修改生效。 - -``` -iris init --home= -``` From d26b3e688488047c14d1e21a56c8f7221cb23700 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Thu, 15 Nov 2018 19:07:00 +0800 Subject: [PATCH 026/100] Add docs for distribution and mint --- docs/cli-client/distribution/README.md | 99 +++++++++++++++++++++++ docs/features/distribution.md | 4 + docs/features/mint.md | 36 +++++++++ docs/zh/cli-client/distribution/README.md | 99 +++++++++++++++++++++++ docs/zh/features/distribution.md | 1 + docs/zh/features/mint.md | 0 6 files changed, 239 insertions(+) create mode 100644 docs/cli-client/distribution/README.md create mode 100644 docs/features/mint.md create mode 100644 docs/zh/cli-client/distribution/README.md create mode 100644 docs/zh/features/mint.md diff --git a/docs/cli-client/distribution/README.md b/docs/cli-client/distribution/README.md new file mode 100644 index 000000000..5da77ae77 --- /dev/null +++ b/docs/cli-client/distribution/README.md @@ -0,0 +1,99 @@ +# Introduction + +This document description how to use the the command line interface of distribution module. + +# Query interface + +By default, trust-node mode is enable. If you don't trust the connected node, just append --trust-node=false in each query command. + +1. Query withdraw address + + For example: + ```bash + ubuntu@ubuntu:~$ iriscli distribution withdraw-address faa1vm068fnjx28zv7k9kd9j85wrwhjn8vfsxfmcrz + ``` + If the given delegator doesn't specify other withdraw address, the query result will be empty. + +2. Query delegation distribution information + + For example: + ```bash + ubuntu@ubuntu:~$ iriscli distribution delegation-distr-info --address-delegator=faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j \ + --address-validator=fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4 + ``` + Query result: + ```json + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } + ``` + The above response means this delegator has send transaction to withdraw reward at height 4044 or the delegation is created on height 4044. + +2. Query delegator distribution information + + For example: + ```bash + iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j + ``` + Query result: + ```json + [ + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", + "del_pool_withdrawal_height": "10859" + }, + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } + ] + ``` + +4. Query validator distribution information + + For example: + ```bash + iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j + ``` + Query result: + ```json + { + "operator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "fee_pool_withdrawal_height": "416", + "del_accum": { + "update_height": "416", + "accum": "0.0000000000" + }, + "del_pool": "0.0000000000iris", + "val_commission": "0.0000000000iris" + } + ``` + +# Send transactions interface + +1. Set withdraw address + + Validator operators or delegators can specify other address as their withdraw address. If no other address has been specified, the delegator address or validator self-delegator address will be used as default address. + For example: + ```bash + iriscli distribution set-withdraw-addr faa1syva9fvh8m6dc6wjnjedah64mmpq7rwwz6nj0k --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + +2. withdraw rewards + + 1. Only withdraw the delegation reward from a given validator + ```bash + iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + 2. Withdraw all delegation reward of a delegator + ```bash + iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + 3. If the delegator is a onwer of a validator, withdraw all delegation reward and validator reward: + ```bash + iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test + ``` \ No newline at end of file diff --git a/docs/features/distribution.md b/docs/features/distribution.md index e69de29bb..a424ae84e 100644 --- a/docs/features/distribution.md +++ b/docs/features/distribution.md @@ -0,0 +1,4 @@ +# Introduction + +This module is in charge of distributing collected transaction fee and inflated token to all validators and delegators. To reduce computation stress, a lazy distribution strategy is brought in. `lazy` means that the benefit won't be paid directly to contributors automatically. The contributors are required to explicitly send transactions to withdraw their benefit, otherwise, their benefit will be kept in the global pool. + diff --git a/docs/features/mint.md b/docs/features/mint.md new file mode 100644 index 000000000..0e7ee56ae --- /dev/null +++ b/docs/features/mint.md @@ -0,0 +1,36 @@ +# Introduction + +The incentive mechanism of POW is widely known and explicit: once a new block is produced, the block miner will acquire a certain amount of token which is the reward for producing block. As a POS blockchain network, the Irishub also has incentive mechanism. But it is much different. Strictly speaking, it is the inflation token which will be distributed to all the contributors. + +As we all know, POW means proof of work. In each producing period, all miners compete to submit their work proof and the fastest one will be the winner. Actually, all loser miners don't offer any positive help or collaboration to the winner miner, and they are only the competitors. So it is reasonable to grant all reward to the winner miner. However, in POS blockchain network, we can't do that. Because each block producing process is based on the collaboration of all validators and delegators, which means the benefit should be share by all these contributors. + +As for how to distribute inflation token to contributors, we will document and implement it in distribution module. Here we mainly introduce how to figure out the inflation token and what is the impact to users. + +# Reward Calculation + +Unlike POW network, the inflation token will not be paid to contributors in each block. Instead, once an hour(`block time`) the inflation token is calculated and saved in global pool. Only when contributors explicitly send transactions to withdraw reward, then will the inflation token be transfered to users specified addresses. + +## Block Time + +The block time is not the machine time, because different machines may not have exactly the same time. They must have some deviation more or less which will result in non-deterministic. So here the block time is the BFT time. Please refer to this [tendermint bft-time](https://github.com/tendermint/tendermint/blob/master/docs/spec/consensus/bft-time.md) for detailed description. + +## Inflation Rate + +The inflation rate depends on the bonded ratio which means it always changes. The desired bonded ratio 67%. If the ratio is higher, the inflation rate will decrease. In contrast, if the bonded ratio is lower, the inflation rate will increase. Besides, the inflation rate should no more than 20% and no less than 7%. Otherwise, it will be truncated. + +Suppose the inflation rate is 10%, and total token amount is 10000iris, then the inflation token will be 0.114iris(10000iris*10%/8766, one year has 8766 hours). After this inflation, the total token amount will be 10000.114iris. + +# Impact to users + +The inflation calculation is an automatically process. Users have no directly interface to this process. However, users can send delegation or unboud transactions to change the bonded ratio, therefore the inflation rate will change accordingly. + +Besides, the inflation process will increate the total token amount. Users can get the total token amount by this command: +``` +ubuntu@ubuntu:~$ iriscli stake pool --node= +Pool +Loose Tokens: 200.1186409166 +Bonded Tokens: 400.0000000000 +Token Supply: 600.1186409166 +Bonded Ratio: 0.6665348695 +``` + diff --git a/docs/zh/cli-client/distribution/README.md b/docs/zh/cli-client/distribution/README.md new file mode 100644 index 000000000..5da77ae77 --- /dev/null +++ b/docs/zh/cli-client/distribution/README.md @@ -0,0 +1,99 @@ +# Introduction + +This document description how to use the the command line interface of distribution module. + +# Query interface + +By default, trust-node mode is enable. If you don't trust the connected node, just append --trust-node=false in each query command. + +1. Query withdraw address + + For example: + ```bash + ubuntu@ubuntu:~$ iriscli distribution withdraw-address faa1vm068fnjx28zv7k9kd9j85wrwhjn8vfsxfmcrz + ``` + If the given delegator doesn't specify other withdraw address, the query result will be empty. + +2. Query delegation distribution information + + For example: + ```bash + ubuntu@ubuntu:~$ iriscli distribution delegation-distr-info --address-delegator=faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j \ + --address-validator=fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4 + ``` + Query result: + ```json + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } + ``` + The above response means this delegator has send transaction to withdraw reward at height 4044 or the delegation is created on height 4044. + +2. Query delegator distribution information + + For example: + ```bash + iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j + ``` + Query result: + ```json + [ + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", + "del_pool_withdrawal_height": "10859" + }, + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } + ] + ``` + +4. Query validator distribution information + + For example: + ```bash + iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j + ``` + Query result: + ```json + { + "operator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "fee_pool_withdrawal_height": "416", + "del_accum": { + "update_height": "416", + "accum": "0.0000000000" + }, + "del_pool": "0.0000000000iris", + "val_commission": "0.0000000000iris" + } + ``` + +# Send transactions interface + +1. Set withdraw address + + Validator operators or delegators can specify other address as their withdraw address. If no other address has been specified, the delegator address or validator self-delegator address will be used as default address. + For example: + ```bash + iriscli distribution set-withdraw-addr faa1syva9fvh8m6dc6wjnjedah64mmpq7rwwz6nj0k --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + +2. withdraw rewards + + 1. Only withdraw the delegation reward from a given validator + ```bash + iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + 2. Withdraw all delegation reward of a delegator + ```bash + iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + 3. If the delegator is a onwer of a validator, withdraw all delegation reward and validator reward: + ```bash + iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test + ``` \ No newline at end of file diff --git a/docs/zh/features/distribution.md b/docs/zh/features/distribution.md index e69de29bb..8d3f495d4 100644 --- a/docs/zh/features/distribution.md +++ b/docs/zh/features/distribution.md @@ -0,0 +1 @@ +# 介绍 \ No newline at end of file diff --git a/docs/zh/features/mint.md b/docs/zh/features/mint.md new file mode 100644 index 000000000..e69de29bb From 91fa4737582512f42458eed4a6b1f60ca8597e82 Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Thu, 15 Nov 2018 19:53:50 +0800 Subject: [PATCH 027/100] WIP : Add English stake doc --- docs/cli-client/stake/README.md | 45 +++++++++++++- docs/cli-client/stake/delegation.md | 43 +++++++++++++ docs/cli-client/stake/delegations.md | 44 +++++++++++++ docs/cli-client/stake/unbond.md | 62 +++++++++++++++++++ docs/cli-client/stake/unbonding-delegation.md | 45 ++++++++++++++ .../stake/unbonding-delegations-from.md | 52 ++++++++++++++++ .../cli-client/stake/unbonding-delegations.md | 46 ++++++++++++++ docs/cli-client/stake/validator.md | 48 ++++++++++++++ docs/cli-client/stake/validators.md | 48 ++++++++++++++ 9 files changed, 432 insertions(+), 1 deletion(-) create mode 100644 docs/cli-client/stake/delegation.md create mode 100644 docs/cli-client/stake/delegations.md create mode 100644 docs/cli-client/stake/unbond.md create mode 100644 docs/cli-client/stake/unbonding-delegation.md create mode 100644 docs/cli-client/stake/unbonding-delegations-from.md create mode 100644 docs/cli-client/stake/unbonding-delegations.md create mode 100644 docs/cli-client/stake/validator.md create mode 100644 docs/cli-client/stake/validators.md diff --git a/docs/cli-client/stake/README.md b/docs/cli-client/stake/README.md index 5083eb47f..1ae4daf48 100644 --- a/docs/cli-client/stake/README.md +++ b/docs/cli-client/stake/README.md @@ -1 +1,44 @@ -# iriscli \ No newline at end of file +# iriscli stake + +## Description + +Stake allows you to execute stake and validation subcommands + +## Usage + +```shell +iriscli stake [command] +``` + +## Available Commands + +| Name | Description | +| --------------------------------| --------------------------------------------------------------| +| [validator](validator.md) | Query a validator | +| [validators](validators.md) | Query for all validators | +| [delegation](delegation.md) | Query a delegation based on address and validator address | +| [delegations](delegations.md) | Query all delegations made from one delegator | +| [unbonding-delegation](unbonding-delegation.md) | Query an unbonding-delegation record based on delegator and validator address | +| [unbonding-delegations](unbonding-delegations.md) | Query all unbonding-delegations records for one delegator | +| [unbonding-delegations-from](unbonding-delegations-from.md) | Query all unbonding delegatations from a validator | +| [redelegations-from](redelegations-from.md) | Query all outgoing redelegatations from a validator | +| [redelegation](redelegation.md) | Query a redelegation record based on delegator and a source and destination validator address | +| [redelegations](redelegations.md) | Query all redelegations records for one delegator | +| [pool](pool.md) | Query the current staking pool values | +| [parameters](parameters.md) | Query the current staking parameters information | +| [signing-info](signing-info.md) | Query a validator's signing information | +| [create-validator](create-validator.md) | Create new validator initialized with a self-delegation to it | +| [edit-validator](edit-validator.md) | Edit and existing validator account | +| [delegate](delegate.md) | Delegate liquid tokens to an validator | +| [unbond](unbond.md) | Unbond shares from a validator | +| [redelegate](redelegate.md) | Redelegate illiquid tokens from one validator to another | +| [unjail](unjail.md) | Unjail validator previously jailed for downtime | + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | ------- | --------------- | -------- | +| --help, -h | | help for stake | | + + diff --git a/docs/cli-client/stake/delegation.md b/docs/cli-client/stake/delegation.md new file mode 100644 index 000000000..a792819bd --- /dev/null +++ b/docs/cli-client/stake/delegation.md @@ -0,0 +1,43 @@ +# iriscli stake delegation + +## Description + +Query a delegation based on address and validator address + +## Usage + +``` +iriscli stake delegation [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | +| --address-delegator | | [string] Bech address of the delegator | Yes | +| --address-validator | | [string] Bech address of the validator | Yes | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query a validator + +```shell +iriscli stake delegation --address-validator=ValidatorAddress --address-delegator=DelegatorAddress + +``` + +After that, you will get detailed info of the delegation between specified validator and delegator. + +```txt +Delegation +Delegator: faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx +Validator: fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +Shares: 0.2000000000Height: 290 +``` diff --git a/docs/cli-client/stake/delegations.md b/docs/cli-client/stake/delegations.md new file mode 100644 index 000000000..16d0e00ea --- /dev/null +++ b/docs/cli-client/stake/delegations.md @@ -0,0 +1,44 @@ +# iriscli stake delegations + +## Description + +Query all delegations made from one delegator + +## Usage + +``` +iriscli stake delegations [delegator-addr] [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for delegations | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query a validator + +```shell +iriscli stake delegations DelegatorAddress +``` + +After that, you will get all detailed info of delegations from the specified delegator address. + +```json +[ + { + "delegator_addr": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "validator_addr": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", + "shares": "0.2000000000", + "height": "290" + } +] +``` diff --git a/docs/cli-client/stake/unbond.md b/docs/cli-client/stake/unbond.md new file mode 100644 index 000000000..bcea3aeb2 --- /dev/null +++ b/docs/cli-client/stake/unbond.md @@ -0,0 +1,62 @@ +# iriscli stake unbond + +## Description + +Unbond shares from a validator + +## Usage + +``` +iriscli stake unbond [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --address-validator | | [string] Bech address of the validator | Yes | +| --async | | Broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for unbond | | +| --indent | | Add indent to JSON response | | +| --json | | Return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --print-response | | Return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --shares-amount | | [string] Amount of source-shares to either unbond or redelegate as a positive integer or decimal | | +| --shares-percent | | [string] Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Unbond shares from a validator + +```shell +iriscli stake unbond --address-validator=ValidatorAddress --shares-percent=SharePercent --from=UnbondInitiator --chain-id=ChainID --fee=Fee +``` + +After that, you're done with unbonding shares from specified validator. + +```txt +Committed at block 851 (tx hash: A82833DE51A4127BD5D60E7F9E4CD5895F97B1B54241BCE272B68698518D9D2B, response: {Code:0 Data:[11 8 230 225 179 223 5 16 249 233 245 21] Log:Msg 0: Info: GasWanted:200000 GasUsed:16547 Tags:[{Key:[97 99 116 105 111 110] Value:[98 101 103 105 110 45 117 110 98 111 110 100 105 110 103] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 51 108 99 119 110 120 112 121 110 50 101 97 51 115 107 122 109 101 107 54 52 118 118 110 112 57 55 106 115 107 56 113 109 104 108 54 118 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[115 111 117 114 99 101 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[101 110 100 45 116 105 109 101] Value:[11 8 230 225 179 223 5 16 249 233 245 21] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 56 50 55 51 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "begin-unbonding", + "completeConsumedTxFee-iris-atto": "\"8273500000000000\"", + "delegator": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "end-time": "\u000b\u0008\ufffd\ufffd\ufffd\ufffd\u0005\u0010\ufffd\ufffd\ufffd\u0015", + "source-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd" + } + } + +``` diff --git a/docs/cli-client/stake/unbonding-delegation.md b/docs/cli-client/stake/unbonding-delegation.md new file mode 100644 index 000000000..3ad0f6618 --- /dev/null +++ b/docs/cli-client/stake/unbonding-delegation.md @@ -0,0 +1,45 @@ +# iriscli stake unbonding-delegation + +## Description + +Query an unbonding-delegation record based on delegator and validator address + +## Usage + +``` +iriscli stake unbonding-delegation [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --address-delegator | | [string] Bech address of the delegator | | +| --address-validator | | [string] Bech address of the validator | | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + + +## Examples + +### Query an unbonding-delegation + +```shell +iriscli stake unbonding-delegation --address-delegator=faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx --address-validator=fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +``` + +After that, you will get unbonding delegation's detailed info between specified validator and delegator. + +```txt +Unbonding Delegation +Delegator: faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx +Validator: fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +Creation height: 1310 +Min time to unbond (unix): 2018-11-15 06:24:22.754703377 +0000 UTC +Expected balance: 0.02iris +``` diff --git a/docs/cli-client/stake/unbonding-delegations-from.md b/docs/cli-client/stake/unbonding-delegations-from.md new file mode 100644 index 000000000..4b65325f0 --- /dev/null +++ b/docs/cli-client/stake/unbonding-delegations-from.md @@ -0,0 +1,52 @@ +# iriscli stake unbonding-delegations-from + +## Description + +Query all unbonding delegatations from a validator + +## Usage + +``` +iriscli stake unbonding-delegations-from [operator-addr] [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query all unbonding delegatations from a validator + +```shell +iriscli stake unbonding-delegations ValidatorAddress +``` + +After that, you will get unbonding delegation's detailed info from specified validator. + +```json +[ + { + "delegator_addr": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "validator_addr": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", + "creation_height": "1310", + "min_time": "2018-11-15T06:24:22.754703377Z", + "initial_balance": { + "denom": "iris-atto", + "amount": "20000000000000000" + }, + "balance": { + "denom": "iris-atto", + "amount": "20000000000000000" + } + } +] +``` diff --git a/docs/cli-client/stake/unbonding-delegations.md b/docs/cli-client/stake/unbonding-delegations.md new file mode 100644 index 000000000..c2b4bf316 --- /dev/null +++ b/docs/cli-client/stake/unbonding-delegations.md @@ -0,0 +1,46 @@ +# iriscli stake unbonding-delegations + +## Description + +Query all unbonding-delegations records for one delegator + +## Usage + +``` +iriscli stake unbonding-delegations [delegator-addr] [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query an unbonding-delegation + +```shell +iriscli stake unbonding-delegations DelegatorAddress +``` + +After that, you will get unbonding delegation's detailed info from specified delegator. + +```json +[ + { + "delegator_addr": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "validator_addr": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", + "creation_height": "1310", + "min_time": "2018-11-15T06:24:22.754703377Z", + "initial_balance": "0.02iris", + "balance": "0.02iris" + } +] +``` diff --git a/docs/cli-client/stake/validator.md b/docs/cli-client/stake/validator.md new file mode 100644 index 000000000..102c3250f --- /dev/null +++ b/docs/cli-client/stake/validator.md @@ -0,0 +1,48 @@ +# iriscli stake validator + +## Description + +Query a validator + +## Usage + +``` +iriscli stake validator [owner-addr] [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query a validator + +```shell +iriscli stake validator YourValidatorOwnerAddress +``` + +After that, you will get the specified validator's info. + +```txt +Validator +Operator Address: fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +Validator Consensus Pubkey: fvp1zcjduepq47906n2zvq597vwyqdc0h35ve0fcl64hwqs9xw5fg67zj4g658aqyuhepj +Jailed: false +Status: Bonded +Tokens: 100.0000000000 +Delegator Shares: 100.0000000000 +Description: {node0 } +Bond Height: 0 +Unbonding Height: 0 +Minimum Unbonding Time: 1970-01-01 00:00:00 +0000 UTC +Commission: {{0.0000000000 0.0000000000 0.0000000000 0001-01-01 00:00:00 +0000 UTC}} +``` diff --git a/docs/cli-client/stake/validators.md b/docs/cli-client/stake/validators.md new file mode 100644 index 000000000..e9d2bee3c --- /dev/null +++ b/docs/cli-client/stake/validators.md @@ -0,0 +1,48 @@ +# iriscli stake validators + +## Description + +Query for all validators + +## Usage + +``` +iriscli stake validators [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query a validator + +```shell +iriscli stake validators +``` + +After that, you will get all validators' info. + +```txt +Validator +Operator Address: fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +Validator Consensus Pubkey: fvp1zcjduepq47906n2zvq597vwyqdc0h35ve0fcl64hwqs9xw5fg67zj4g658aqyuhepj +Jailed: false +Status: Bonded +Tokens: 100.0000000000 +Delegator Shares: 100.0000000000 +Description: {node0 } +Bond Height: 0 +Unbonding Height: 0 +Minimum Unbonding Time: 1970-01-01 00:00:00 +0000 UTC +Commission: {{0.0000000000 0.0000000000 0.0000000000 0001-01-01 00:00:00 +0000 UTC}} +``` From d0990c06df0b87770bdf8246a397cb36764346ee Mon Sep 17 00:00:00 2001 From: kaifei Date: Thu, 15 Nov 2018 20:35:21 +0800 Subject: [PATCH 028/100] revert config.js --- docs/.vuepress/config.js | 239 ++++++++++++++++++++++++++++++--------- docs/software/monitor.md | 77 ++++++------- 2 files changed, 221 insertions(+), 95 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 5ae9e920e..26e19bc71 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,56 +1,185 @@ module.exports = { - title: 'IRISnet Document', - description: '', - base: "/docs/", - themeConfig: { - displayAllHeaders: false, - nav: [ - { text: 'Back to IRISnet', link: 'https://www.irisnet.org' } - ], - sidebar: [ - { - title: 'Introduction', - collapsable: false, - children: [ - ['/introduction/Whitepaper.md', 'Whitepaper - English'], - ['/introduction/Whitepaper_CN.md', 'Whitepaper - 中文'] - ] - },{ - title: 'Getting Started', - collapsable: false, - children: [ - ['/get-started/', 'Join the Testnet'], - ['/get-started/Install-Iris.md', 'Install'], - ['/get-started/Full-Node.md', 'Run a Full Node'], - ['/get-started/Validator-Node.md', 'Run a Validator Node'], - ['/get-started/Genesis-Generation-Process.md', 'Genesis Generation'], - ['/get-started/Bech32-on-IRISnet.md', 'Bech32 on IRISnet'], - ] - },{ - title: 'Modules', - collapsable: false, - children: [ - // ['/modules/coin/README.md', 'Coin Type'], - ['/modules/fee-token/', 'Fee Token'] - // ['/modules/gov/README.md', 'Governance'] - ] - },{ - title: 'Tools', - collapsable: false, - children: [ - ['/tools/Deploy-IRIS-Monitor.md', 'Monitor'] - ] - },{ - title: 'Validators', - collapsable: false, - children: [ - ['/validators/', 'Overview'], - ['/validators/Setup-Sentry-Node.md', 'Sentry Node'], - ['/validators/How-to-participate-in-onchain-governance.md', 'Onchain Governance'], - ['/validators/FAQ.md', 'FAQ'] - ] - } - ] - } -} - + title: 'IRISnet Document', + description: '', + base: "/docs/", + themeConfig: { + displayAllHeaders: false, + nav: [ + {text: 'Back to IRISnet', link: 'https://www.irisnet.org'}, + {text: 'Introduction', link: '/introduction/'}, + {text: 'Software', link: '/software/'}, + {text: 'Getting Started', link: '/get-started/'}, + {text: 'Features', link: '/features/'}, + {text: 'CLI Client', link: '/cli-client/'}, + {text: 'Light Client', link: '/light-client/'}, + {text: 'Resources', link: '/resources/'}, + ], + sidebar: { + '/introduction/': [{ + title: 'The IRIS Hub', + collapsable: false, + children: [ + 'The-IRIS-Hub/Proof-of-Stake.md', + 'The-IRIS-Hub/IRIS-Tokens.md', + 'The-IRIS-Hub/Validators.md', + 'The-IRIS-Hub/Delegators.md' + ] + }, + { + title: 'The IRIS Service', + collapsable: false, + children: [ + 'The-IRIS-Service/Lifecycle.md', + 'The-IRIS-Service/Providers.md', + 'The-IRIS-Service/Consumers.md', + ] + }, + { + title: 'The IRIS Network', + collapsable: false, + children: [ + 'The-IRIS-Network/' + ] + }], + '/software/': [{ + title: 'Basic Concepts', + collapsable: false, + children: [ + ["basic-concepts/coin-type.md", 'Coin Type'], + ["basic-concepts/fee.md", 'Fee'], + ["basic-concepts/inflation.md", 'Infation'], + ["basic-concepts/bech32-prefix.md", 'Bech32 Prefix'], + ["basic-concepts/genesis-file.md", 'Genesis File'], + ["basic-concepts/gov-params.md", 'Gov Params'] + ] + }, { + title: 'Node', + collapsable: false, + children: [ + ['node.md', 'Node'] + ] + }, { + title: 'CLI Client', + collapsable: false, + children: [ + ['cli-client.md', 'CLI Client'] + ] + }, { + title: 'Light Client', + collapsable: false, + children: [ + ['light-client.md', 'Light Client'] + ] + }, { + title: 'Monitor', + collapsable: false, + children: [ + ['monitor.md', 'Monitor'] + ] + }], + '/get-started/': [{ + title: 'Getting Started', + collapsable: false, + children: [ + ['Download-Rainbow.md', 'Download Rainbow'], + ['Install-the-Software.md', 'Install the Software'], + ['Join-the-Testnet.md', 'Join the Testnet'] + ] + }], + '/features/': [{ + title: 'Features', + collapsable: false, + children: [ + ['bank.md', 'Bank'], + ['stake.md', 'Stake'], + ['service.md', 'Service'], + ['record.md', 'Record'], + ['governance.md', 'Governance'], + ['upgrade.md', 'Upgrade'], + ['distribution.md', 'Distribution'], + ] + }], + '/cli-client/': [{ + title: 'Status', + collapsable: false, + children: [ + ['status/', 'iriscli status'] + ] + }, + { + title: 'Tendermint', + collapsable: false, + children: [ + ['tendermint/', 'iriscli tendermint'] + ] + }, + { + title: 'Keys', + collapsable: false, + children: [ + ['keys/', 'iriscli keys'] + ] + }, + { + title: 'Bank', + collapsable: false, + children: [ + ['bank/', 'iriscli bank'] + ] + }, + { + title: 'Stake', + collapsable: false, + children: [ + ['stake/', 'iriscli stake'] + ] + }, + { + title: 'Gov', + collapsable: false, + children: [ + ['gov/', 'iriscli gov'] + ] + }, + { + title: 'Record', + collapsable: false, + children: [ + ['record/', 'iriscli record'] + ] + }, + { + title: 'Upgrade', + collapsable: false, + children: [ + ['upgrade/', 'iriscli upgrade'] + ] + }, + { + title: 'Service', + collapsable: false, + children: [ + ['service/', 'iriscli service'] + ] + }], + '/light-client/': [{ + title: 'Light Client', + collapsable: false, + children: [ + ['', 'Light Client'] + ] + }], + '/resources/': [{ + title: 'Resources', + collapsable: false, + children: [ + ['validator-faq.md', 'Validator FAQ'], + ['delegator-faq.md', 'Delegator FAQ'], + ['whitepaper-zh.md', 'Whitepaper ZH'], + ['whitepaper-en.md', 'Whitepaper EN'], + ['whitepaper-kr.md', 'Whitepaper KR'], + ] + }] + } + } +} \ No newline at end of file diff --git a/docs/software/monitor.md b/docs/software/monitor.md index a2f598566..e1d5ed132 100644 --- a/docs/software/monitor.md +++ b/docs/software/monitor.md @@ -1,62 +1,59 @@ -# How to deploy IRIShub Monitor +# How to deploy IRIS Monitor -Please make sure that iris is installed in your computer and added to $PATH.You can see this page for insturcion https://github.com/irisnet/irishub. You also need /bin/bash, wc, ps to ensure the monitor work properly. +## Install IRIS Monitor +Please refer to this [document](https://github.com/irisnet/irishub/blob/master/docs/get-started/Install-Iris.md) for deatiled instructions. Besides, please make sure your machine has these commands(bash, wc, ps) installed. -### Get Monitor Info - -* Address of validator +## Start IRIS Monitor ``` --a= < hex-encoded-address-of-validator > +irismon --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 \ +--account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st \ +--chain-id=irishub-stage --node=http://localhost:26657 ``` -* Chain-ID -``` ---chain-id= < id-of-blockchain > -``` +Parameters： -* Node +- `address`：hex encoded validator address +- `account-address`：bech32 encoded account address +- `chain-id`：blockchain id that you want to monitor +- `node`：listening address of the node that you want to monitor (The rpc url of a irishub node, default value is tcp://localhost:26657. If you want to monitor other irishub nodes, please change this value.) +Then you can visit `http://localhost:36660/` to see metrics data。 -``` ---node= < localhost:26657 > -``` -### Start IRIS Monitor -Example: -``` -irismon --account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st --address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 --chain-id=irishub-stage --node=http://localhost:26657& -``` +## Start Prometheus -then, you can visit http://localhost:3660/ to see the metrics page. +### Edit Prometheus config file -### Start Prometheus +You can visit [prometheus.yml](https://github.com/prometheus/prometheus/blob/master/documentation/examples/prometheus.yml) to download default `prometheus.yml`. -First, you need to edit the configuration file of prometheus. Add `jobs` : -```$xslt -- job_name: fuxi-4000 +Then edit `prometheus.yml` and add `jobs` : - static_configs: +```yaml + - job_name: fuxi-4000 + static_configs: + - targets: ['localhost:36660'] + labels: + instance: fuxi-4000 +``` - - targets: ['localhost:36660'] +> Note：value of targets is ip:port which used by IRIS monitor - labels: +### Start Prometheus - instance: fuxi-4000 +```bash +docker run -d --name=prometheus -p 9090:9090 -v ~/volumes/prometheus:/etc/prometheus prom/prometheus ``` -Then, you could see in your browser that there are some data available at port 36660. -### Start Grafana - -You could start grafana with docker by running: -```$xslt -sudo docker run -p 3000:3000 grafana/grafana 1>grafana.log 2>grafana.error & -``` +> The above example, you can save `prometheus.yml` at `~/volumes/prometheus` on your host machine -The default username and password are both admin. We strongly recommend immediately changing your username & password after login. +You can visit `http://localhost:9090` to see prometheus data. -Then you could create your own dashboard. +## Start Grafana -### Stop IRIS Monitor ``` -kill -9 -``` \ No newline at end of file +docker run -d --name=grafana -p 3000:3000 grafana/grafana +``` + +You can visit `http://localhost:3000/` to open grafana and create your own dashboard. + +> Tips: The default username and password are both admin. We strongly recommend immediately changing your username & password after login \ No newline at end of file From d5e64959ff06c45dae00e33ba5e1c9fd82967e9a Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Thu, 15 Nov 2018 21:59:08 +0800 Subject: [PATCH 029/100] Add lcd docs --- docs/cli-client/lcd/lcd.md | 36 ++++++++++++++ docs/features/distribution.md | 9 +++- docs/features/lcd.md | 93 +++++++++++++++++++++++++++++++++++ docs/features/mint.md | 12 +++-- 4 files changed, 144 insertions(+), 6 deletions(-) create mode 100644 docs/cli-client/lcd/lcd.md create mode 100644 docs/features/lcd.md diff --git a/docs/cli-client/lcd/lcd.md b/docs/cli-client/lcd/lcd.md new file mode 100644 index 000000000..dca3b46df --- /dev/null +++ b/docs/cli-client/lcd/lcd.md @@ -0,0 +1,36 @@ +# What is Irislcd + +An irislcd node is a REST server which can connect to any full nodes and provide a set of rest APIs. By these APIs, users can send transactions and query blockchain data. Irislcd can verify the proof of query result. So it can provide the same security as a full node with the minimal requirements on bandwidth, computing and storage resource. Besides, it also provides swagger-ui which presents detailed description about what APIs it provides and how to use them. + +## Irislcd usage + +Irislcd has two subcommands: + +| subcommand | Description | Example command | +| --------------- | --------------------------- | --------------- | +| version | Print the irislcd version | irislcd version | +| start | Start a irislcd node | irislcd start --chain-id= | + +`start` subcommand has these options: + +| Parameter | Type | Default | Required | Description | +| --------------- | --------- | ----------------------- | -------- | ---------------------------------------------------- | +| chain-id | string | null | true | Chain ID of Tendermint node | +| home | string | "$HOME/.irislcd" | false | Directory for config and data, such as key and checkpoint | +| node | string | "tcp://localhost:26657" | false | Full node to connect to | +| laddr | string | "tcp://localhost:1317" | false | Address for server to listen on | +| trust-node | bool | false | false | Trust connected full nodes (Don't verify proofs for responses) | +| max-open | int | 1000 | false | The number of maximum open connections | +| cors | string | "" | false | Set the domains that can make CORS requests | + +## Sample commands + +1. When the connected full node is trusted, then the proof is not necessary, so you can run irislcd with trust-node option: +```bash +irislcd start --chain-id= --trust-node +``` + +2. If you want to access your irislcd in remote machine, you have to specify `--laddr`, for instance: +```bash +irislcd start --chain-id= --laddr=tcp://0.0.0.0:1317 +``` \ No newline at end of file diff --git a/docs/features/distribution.md b/docs/features/distribution.md index a424ae84e..76f5d3a60 100644 --- a/docs/features/distribution.md +++ b/docs/features/distribution.md @@ -1,4 +1,11 @@ -# Introduction +# Distribution User Guide + +## Introduction This module is in charge of distributing collected transaction fee and inflated token to all validators and delegators. To reduce computation stress, a lazy distribution strategy is brought in. `lazy` means that the benefit won't be paid directly to contributors automatically. The contributors are required to explicitly send transactions to withdraw their benefit, otherwise, their benefit will be kept in the global pool. +## Basic Functionality Description + + + +## Usage Scenario \ No newline at end of file diff --git a/docs/features/lcd.md b/docs/features/lcd.md new file mode 100644 index 000000000..37d860cd4 --- /dev/null +++ b/docs/features/lcd.md @@ -0,0 +1,93 @@ +# IRISLCD User Guide + +## Introduction + +## Basic Functionality Description + +1. Provide RESTful APIs and swagger-ui to show these APIs +2. Verify query proof + +## Usage Scenario + +Suppose an IRISLCD node is running and its swagger-ui page url is `localhost:1317/swagger-ui/`. The default home folder of irislcd is `$HOME/.irislcd`. Once an IRISLCD is started, firstly it will create key store in its home folder. If the IRISLCD is running in distrust mode, then ir will fetch the latest block as its trust basis and the trust basis will be saved to folder `trust-base.db` under its home folder. The IRISLCD node always trust the basis. It will verify all query proof against the trust basis, which means IRISLCD can only verify the proof on later height. However, this is also a defect of IRISLCD. When it tries to verify some transactions or blocks on lower height, it will report error. So if you want to query transactions or block on lower height, please start IRISLCD in trust mode. For detailed proof verification algorithm please refer to this [document](https://github.com/tendermint/tendermint/blob/master/docs/tendermint-core/light-client-protocol.md). + +Open `localhost:1317/swagger-ui/` in your explorer and all RESTful APIs will be shown the page. + +### Tendermint APIs, such as query blocks, transactions and validatorset +1. `GET /node_info`: The properties of the connected node +2. `GET /syncing`: Syncing state of node +3. `GET /blocks/latest`: Get the latest block +4. `GET /blocks/{height}`: Get a block at a certain height +5. `GET /validatorsets/latest`: Get the latest validator set +6. `GET /validatorsets/{height}`: Get a validator set a certain height +7. `GET /txs/{hash}`: Get a Tx by hash +8. `GET /txs`: Search transactions +9. `POST /txs`: Broadcast Tx + +### Key management APIs + +1. `GET /keys`: List of accounts stored locally +2. `POST /keys`: Create a new account locally +3. `GET /keys/seed`: Create a new seed to create a new account with +4. `GET /keys/{name}`: Get a certain locally stored account +5. `PUT /keys/{name}`: Update the password for this account in the KMS +6. `DELETE /keys/{name}`: Remove an account +7. `GET /auth/accounts/{address}`: Get the account information on blockchain + +##Create, sign and broadcast transactions + +1. `POST /tx/sign`: Sign a transation +2. `POST /tx/broadcast`: Broadcast a signed StdTx with amino encoding signature and public key +3. `POST /txs/send`: Send non-amino encoding transaction +4. `GET /bank/coin/{coin-type}`: Get coin type +5. `GET /bank/balances/{address}`: Get the account information on blockchain +6. `POST /bank/accounts/{address}/transfers`: Send coins (build -> sign -> send) + +## Stake module APIs + +1. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction +2. `POST /stake/delegators/{delegatorAddr}/redelegate`: Submit redelegation transaction +3. `POST /stake/delegators/{delegatorAddr}/unbond`: Submit unbonding transaction +4. `GET /stake/delegators/{delegatorAddr}/delegations`: Get all delegations from a delegator +5. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations`: Get all unbonding delegations from a delegator +6. `GET /stake/delegators/{delegatorAddr}/redelegations`: Get all redelegations from a delegator +7. `GET /stake/delegators/{delegatorAddr}/validators`: Query all validators that a delegator is bonded to +8. `GET /stake/delegators/{delegatorAddr}/validators/{validatorAddr}`: Query a validator that a delegator is bonded to +9. `GET /stake/delegators/{delegatorAddr}/txs` :Get all staking txs (i.e msgs) from a delegator +10. `GET /stake/delegators/{delegatorAddr}/delegations/{validatorAddr}`: Query the current delegation between a delegator and a validator +11. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}`: Query all unbonding delegations between a delegator and a validator +12. `GET /stake/validators`: Get all validator candidates +13. `GET /stake/validators/{validatorAddr}`: Query the information from a single validator +14. `GET /stake/validators/{validatorAddr}/unbonding_delegations`: Get all unbonding delegations from a validator +15. `GET /stake/validators/{validatorAddr}/redelegations`: Get all outgoing redelegations from a validator +16. `GET /stake/pool`: Get the current state of the staking pool +17. `GET /stake/parameters`: Get the current staking parameter values + +## Governance module APIs + +1. `POST /gov/proposal`: Submit a proposal +2. `GET /gov/proposals`: Query proposals +3. `POST /gov/proposals/{proposalId}/deposits`: Deposit tokens to a proposal +4. `GET /gov/proposals/{proposalId}/deposits`: Query deposits +5. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal +6. `GET /gov/proposals/{proposalId}/votes`: Query voters +7. `GET /gov/proposals/{proposalId}`: Query a proposal +8. `GET /gov/proposals/{proposalId}/deposits/{depositor}`: Query deposit +9. `GET /gov/proposals/{proposalId}/votes/{voter}`: Query vote +10. `GET/gov/params`: Query governance parameters + +## Slashing module APIs +1. `GET /slashing/validators/{validatorPubKey}/signing_info`: Get sign info of given validator +2. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator + +## Distribution module APIs +1. `POST /distribution/{delegatorAddr}/withdrawAddress`: Set withdraw address +2. `GET /distribution/{delegatorAddr}/withdrawAddress`: Query withdraw address +3. `POST /distribution/{delegatorAddr}/withdrawReward`: Set withdraw address +4. `GET /distribution/{delegatorAddr}/distrInfo/{validatorAddr}`: Query distribution information for a delegation +5. `GET /distribution/{delegatorAddr}/distrInfos`: Query distribution information list for a given delegator +6. `GET /distribution/{validatorAddr}/valDistrInfo`: Query withdraw address + +## Query app version +1. `GET /version`: Version of irislcd +2. `GET /node_version`: Version of the connected node \ No newline at end of file diff --git a/docs/features/mint.md b/docs/features/mint.md index 0e7ee56ae..2fd324b35 100644 --- a/docs/features/mint.md +++ b/docs/features/mint.md @@ -1,4 +1,6 @@ -# Introduction +#IRISLCD User Guide + +## Introduction The incentive mechanism of POW is widely known and explicit: once a new block is produced, the block miner will acquire a certain amount of token which is the reward for producing block. As a POS blockchain network, the Irishub also has incentive mechanism. But it is much different. Strictly speaking, it is the inflation token which will be distributed to all the contributors. @@ -6,21 +8,21 @@ As we all know, POW means proof of work. In each producing period, all miners co As for how to distribute inflation token to contributors, we will document and implement it in distribution module. Here we mainly introduce how to figure out the inflation token and what is the impact to users. -# Reward Calculation +## Reward Calculation Unlike POW network, the inflation token will not be paid to contributors in each block. Instead, once an hour(`block time`) the inflation token is calculated and saved in global pool. Only when contributors explicitly send transactions to withdraw reward, then will the inflation token be transfered to users specified addresses. -## Block Time +### Block Time The block time is not the machine time, because different machines may not have exactly the same time. They must have some deviation more or less which will result in non-deterministic. So here the block time is the BFT time. Please refer to this [tendermint bft-time](https://github.com/tendermint/tendermint/blob/master/docs/spec/consensus/bft-time.md) for detailed description. -## Inflation Rate +### Inflation Rate The inflation rate depends on the bonded ratio which means it always changes. The desired bonded ratio 67%. If the ratio is higher, the inflation rate will decrease. In contrast, if the bonded ratio is lower, the inflation rate will increase. Besides, the inflation rate should no more than 20% and no less than 7%. Otherwise, it will be truncated. Suppose the inflation rate is 10%, and total token amount is 10000iris, then the inflation token will be 0.114iris(10000iris*10%/8766, one year has 8766 hours). After this inflation, the total token amount will be 10000.114iris. -# Impact to users +## Impact to users The inflation calculation is an automatically process. Users have no directly interface to this process. However, users can send delegation or unboud transactions to change the bonded ratio, therefore the inflation rate will change accordingly. From 745ce3cf7b8f66031cf085199f14243c534390a4 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Thu, 15 Nov 2018 23:16:15 +0800 Subject: [PATCH 030/100] keys module docs --- docs/cli-client/keys/README.md | 24 +++++++++---- docs/cli-client/keys/delete.md | 37 +++++++++++++++++++ docs/cli-client/keys/list.md | 34 ++++++++++++++++++ docs/cli-client/keys/mnemonic.md | 32 +++++++++++++++++ docs/cli-client/keys/new.md | 62 ++++++++++++++++++++++++++++++++ docs/cli-client/keys/show.md | 36 +++++++++++++++++++ docs/cli-client/keys/update.md | 44 +++++++++++++++++++++++ 7 files changed, 263 insertions(+), 6 deletions(-) create mode 100644 docs/cli-client/keys/delete.md create mode 100644 docs/cli-client/keys/list.md create mode 100644 docs/cli-client/keys/mnemonic.md create mode 100644 docs/cli-client/keys/new.md create mode 100644 docs/cli-client/keys/show.md create mode 100644 docs/cli-client/keys/update.md diff --git a/docs/cli-client/keys/README.md b/docs/cli-client/keys/README.md index 410208962..583787200 100644 --- a/docs/cli-client/keys/README.md +++ b/docs/cli-client/keys/README.md @@ -12,12 +12,15 @@ iriscli keys [command] ## Available Commands -| Name | Description | -| ------------- | ------------------------------------- | -| [add](add.md) | Create a new key, or import from seed | -| list | List all keys | -| show | Show key info for the given name | -| delete | Delete the given key | +| Name | Description | +| ----------------------- | -------------------------------------------------------------------------------------------- | +| [mnemonic](mnemonic.md) | Create a bip39 mnemonic, sometimes called a seed phrase, by reading from the system entropy. | +| [new](new.md) | Derive a new private key using an interactive command that will prompt you for each input. | +| [add](add.md) | Create a new key, or import from seed | +| [list](list.md) | List all keys | +| [show](show.md) | Show key info for the given name | +| [delete](delete.md) | Delete the given key | +| [update](update.md) | Change the password used to protect private key | ## Flags @@ -25,6 +28,15 @@ iriscli keys [command] | --------------- | ------- | ------------- | -------- | | --help, -h | | help for keys | | +## Global Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------- | -------------------------------------- | -------- | +| --encoding, -e | hex | [string] Binary encoding (hex|b64|btc) | | +| --home | $HOME/.iriscli | [string] directory for config and data | | +| --output, -o | text | [string] Output format (text|json) | | +| --trace | | print out full stack trace on errors | | + ## Extended description These keys may be in any format supported by go-crypto and can be used by light-clients, full nodes, or any other application that needs to sign with a private key. diff --git a/docs/cli-client/keys/delete.md b/docs/cli-client/keys/delete.md new file mode 100644 index 000000000..35c649091 --- /dev/null +++ b/docs/cli-client/keys/delete.md @@ -0,0 +1,37 @@ +# iriscli keys delete + +## Description + +Delete the given key + +## Usage + +``` +iriscli keys delete [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --help, -h | | help for add | | + +## Examples + +### Delete a given key + +```shell +iriscli keys delete MyKey +``` + +You'll be asked to enter a password for your key. + +```txt +DANGER - enter password to permanently delete key: +``` + +After that, you're done with deleting your key. + +```txt +Password deleted forever (uh oh!) +``` \ No newline at end of file diff --git a/docs/cli-client/keys/list.md b/docs/cli-client/keys/list.md new file mode 100644 index 000000000..a41bc74cd --- /dev/null +++ b/docs/cli-client/keys/list.md @@ -0,0 +1,34 @@ +# iriscli keys list + +## Description + +Return a list of all public keys stored by this key manager +along with their associated name and address. + +## Usage + +``` +iriscli keys list [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --help, -h | | help for add | | + +## Examples + +### List all public keys + +```shell +iriscli keys list +``` + +After this, you will get all the local public keys with 'address' and 'pubkey' element. + +```txt +NAME: TYPE: ADDRESS: PUBKEY: +abc local faa1va2eu9qhwn5fx58kvl87x05ee4qrgh44yd8teh fap1addwnpepq02r0hts0yjhp4rsal627s2lqk4agy2g6tek5g9yq2tfrmkkehee2td75cs +test local faa1kkm4w5pvmcw0e3vjcxqtfxwqpm3k0zakl7lxn5 fap1addwnpepq0gsl90v9dgac3r9hzgz53ul5ml5ynq89ax9x8qs5jgv5z5vyssskww57lw +``` \ No newline at end of file diff --git a/docs/cli-client/keys/mnemonic.md b/docs/cli-client/keys/mnemonic.md new file mode 100644 index 000000000..230d0ba4c --- /dev/null +++ b/docs/cli-client/keys/mnemonic.md @@ -0,0 +1,32 @@ +# iriscli keys mnemonic + +## Description + +Create a bip39 mnemonic, sometimes called a seed phrase, by reading from the system entropy. To pass your own entropy, use --unsafe-entropy + +## Usage + +``` +iriscli keys mnemonic [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------- | --------- | ----------------------------------------------------------------------------- | -------- | +| --help, -h | | help for add | | +| --unsafe-entropy | | Prompt the user to supply their own entropy, instead of relying on the system | | + +## Examples + +### Create a bip39 mnemonic + +```shell +iriscli keys mnemonic abc +``` + +After this, you'll get a bip39 mnemonic. + +```txt +police possible oval milk network indicate usual blossom spring wasp taste canal announce purpose rib mind river pet brown web response sting remain airport +``` \ No newline at end of file diff --git a/docs/cli-client/keys/new.md b/docs/cli-client/keys/new.md new file mode 100644 index 000000000..9d30cdd7c --- /dev/null +++ b/docs/cli-client/keys/new.md @@ -0,0 +1,62 @@ +# iriscli keys new + +## Description + +Derive a new private key using an interactive command that will prompt you for each input. +Optionally specify a bip39 mnemonic, a bip39 passphrase to further secure the mnemonic, +and a bip32 HD path to derive a specific account. The key will be stored under the given name +and encrypted with the given password. The only input that is required is the encryption password. + +## Usage + +``` +iriscli keys new [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | ----------------- | --------------------------------------------------------------- | -------- | +| --bip44-path | "44'/118'/0'/0/0" | BIP44 path from which to derive a private key | | +| --default | | Skip the prompts and just use the default values for everything | | +| --help, -h | | help for add | | +| --ledger | | Store a local reference to a private key on a Ledger device | | + +## Examples + +### Create a new key by the specified method + +```shell +iriscli keys new MyKey +``` + +You'll be asked to enter your bip44 path, default is 44'/118'/0'/0/0. + +```txt +> ------------------------------------- +> Enter your bip44 path. Default is 44'/118'/0'/0/0 +``` + +Then you'll be asked to enter your bip39 mnemonic, or hit enter to generate one. + +```txt +> Enter your bip39 mnemonic, or hit enter to generate one. +``` + +You could hit enter to generate bip39 mnemonic, then a new hint will be show to ask you to enter bip39 passphrase. + +```txt +> ------------------------------------- +> Enter your bip39 passphrase. This is combined with the mnemonic to derive the seed +> Most users should just hit enter to use the default, "" +``` + +Also you could hit enter to skip it, then you'll receive a hint to enter a password. + +```txt +> ------------------------------------- +> Enter a passphrase to encrypt your key to disk: +> Repeat the passphrase: +``` + +After that, you're done with creating a new key. \ No newline at end of file diff --git a/docs/cli-client/keys/show.md b/docs/cli-client/keys/show.md new file mode 100644 index 000000000..18fc75c23 --- /dev/null +++ b/docs/cli-client/keys/show.md @@ -0,0 +1,36 @@ +# iriscli keys show + +## Description + +Return public details of one local key. + +## Usage + +``` +iriscli keys show [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| -------------------- | ----------------- | -------------------------------------------------------------- | -------- | +| --address | | output the address only (overrides --output) | | +| --bech | acc | [string] The Bech32 prefix encoding for a key (acc|val|cons) | | +| --help, -h | | help for add | | +| --multisig-threshold | 1 | [uint] K out of N required signatures | | +| --pubkey | | output the public key only (overrides --output) | | + +## Examples + +### Show a given key + +```shell +iriscli keys show test +``` + +After this, you will get the local public keys with 'address' and 'pubkey' element of a given key. + +```txt +NAME: TYPE: ADDRESS: PUBKEY: +test local faa1kkm4w5pvmcw0e3vjcxqtfxwqpm3k0zakl7lxn5 fap1addwnpepq0gsl90v9dgac3r9hzgz53ul5ml5ynq89ax9x8qs5jgv5z5vyssskww57lw +``` \ No newline at end of file diff --git a/docs/cli-client/keys/update.md b/docs/cli-client/keys/update.md new file mode 100644 index 000000000..1c159b955 --- /dev/null +++ b/docs/cli-client/keys/update.md @@ -0,0 +1,44 @@ +# iriscli keys update + +## Description + +Change the password used to protect private key + +## Usage + +``` +iriscli keys update [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --help, -h | | help for add | | + +## Examples + +### Change the password of a given key + +```shell +iriscli keys update MyKey +``` + +You'll be asked to enter the current password for your key. + +```txt +Enter the current passphrase: +``` + +After this, you'll be asked to enter a new password. + +```txt +Enter the new passphrase: +Repeat the new passphrase: +``` + +After that, you're done with changing your password. + +```txt +Password successfully updated! +``` \ No newline at end of file From f0cefe1d20efee2ef3a5829e61b3871438e69abd Mon Sep 17 00:00:00 2001 From: trevorfu Date: Thu, 15 Nov 2018 23:21:05 +0800 Subject: [PATCH 031/100] gov module docs --- docs/cli-client/gov/README.md | 54 ++++++++++++++++++++- docs/cli-client/gov/deposit.md | 60 +++++++++++++++++++++++ docs/cli-client/gov/pull-params.md | 38 +++++++++++++++ docs/cli-client/gov/query-deposit.md | 48 ++++++++++++++++++ docs/cli-client/gov/query-deposits.md | 49 +++++++++++++++++++ docs/cli-client/gov/query-params.md | 39 +++++++++++++++ docs/cli-client/gov/query-proposal.md | 65 +++++++++++++++++++++++++ docs/cli-client/gov/query-proposals.md | 42 ++++++++++++++++ docs/cli-client/gov/query-tally.md | 36 ++++++++++++++ docs/cli-client/gov/query-vote.md | 39 +++++++++++++++ docs/cli-client/gov/query-votes.md | 38 +++++++++++++++ docs/cli-client/gov/submit-proposal.md | 67 ++++++++++++++++++++++++++ docs/cli-client/gov/vote.md | 51 ++++++++++++++++++++ 13 files changed, 625 insertions(+), 1 deletion(-) create mode 100644 docs/cli-client/gov/deposit.md create mode 100644 docs/cli-client/gov/pull-params.md create mode 100644 docs/cli-client/gov/query-deposit.md create mode 100644 docs/cli-client/gov/query-deposits.md create mode 100644 docs/cli-client/gov/query-params.md create mode 100644 docs/cli-client/gov/query-proposal.md create mode 100644 docs/cli-client/gov/query-proposals.md create mode 100644 docs/cli-client/gov/query-tally.md create mode 100644 docs/cli-client/gov/query-vote.md create mode 100644 docs/cli-client/gov/query-votes.md create mode 100644 docs/cli-client/gov/submit-proposal.md create mode 100644 docs/cli-client/gov/vote.md diff --git a/docs/cli-client/gov/README.md b/docs/cli-client/gov/README.md index 5083eb47f..c750378c8 100644 --- a/docs/cli-client/gov/README.md +++ b/docs/cli-client/gov/README.md @@ -1 +1,53 @@ -# iriscli \ No newline at end of file +# iriscli gov + +## Description + +IRIShub governance module provides the basic functions as described below: +1. On-chain governance proposals on text +2. On-chain governance proposals on parameter change +3. On-chain governance proposals on software upgrade + +## Usage + +```shell +iriscli gov [command] +``` + +## Available Commands + +| Name | Description | +| ------------------------------------- | --------------------------------------------------------------- | +| [query-proposal](query-proposal.md) | Query details of a single proposal | +| [query-proposals](query-proposals.md) | query proposals with optional filters | +| [query-vote](query-vote.md) | query vote | +| [query-votes](query-votes.md) | query votes on a proposal | +| [query-deposit](query-deposit.md) | Query details of a deposit | +| [query-deposits](query-deposits.md) | Query deposits on a proposal | +| [query-tally](query-tally.md) | Get the tally of a proposal vote | +| [query-params](query-params.md) | query parameter proposal's config | +| [pull-params](pull-params.md) | generate param.json file | +| [submit-proposal](submit-proposal.md) | Create a new key, or import from seed | +| [deposit](deposit.md) | deposit tokens for activing proposal | +| [vote](vote.md) | vote for an active proposal, options: Yes/No/NoWithVeto/Abstain | + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | ------- | ------------- | -------- | +| --help, -h | | help for gov | | + +## Global Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------- | -------------------------------------- | -------- | +| --encoding, -e | hex | [string] Binary encoding (hex|b64|btc) | | +| --home | $HOME/.iriscli | [string] directory for config and data | | +| --output, -o | text | [string] Output format (text|json) | | +| --trace | | print out full stack trace on errors | | + +## Extended description + +1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value `min_deposit`, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches `min_deposit`, enter voting period. However, if the block-time exceeds `max_deposit_period` in the deposit period, the proposal will be closed. +2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. +3. More details about voting for proposals: +[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) \ No newline at end of file diff --git a/docs/cli-client/gov/deposit.md b/docs/cli-client/gov/deposit.md new file mode 100644 index 000000000..27a18d9f6 --- /dev/null +++ b/docs/cli-client/gov/deposit.md @@ -0,0 +1,60 @@ +# iriscli gov deposit + +## Description + +Deposit tokens for activing proposal + +## Usage + +``` +iriscli gov deposit [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --deposit | | [string] deposit of proposal | | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Deposit + +```shell +iriscli gov deposit --chain-id=test --proposal-id=1 --deposit=10iris --from=node0 --fee=0.1iris +``` + + After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt +Password to sign with 'node0': +Committed at block 861 (tx hash: 42D72A67ADCBE1FD90D8313E3EFB5F63A626B41F16DC0A0C7FD116907604CEF6, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:6629 Tags:[{Key:[97 99 116 105 111 110] Value:[100 101 112 111 115 105 116] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 112 111 115 105 116 101 114] Value:[102 97 97 49 115 108 116 106 120 100 103 107 48 48 115 56 54 50 57 50 122 48 99 110 55 97 53 100 106 99 99 116 54 101 115 115 110 97 118 100 121 122] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 97 108 45 105 100] Value:[49] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 51 51 49 52 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "deposit", + "completeConsumedTxFee-iris-atto": "\"3314500000000000\"", + "depositer": "faa1sltjxdgk00s86292z0cn7a5djcct6essnavdyz", + "proposal-id": "1" + } + } +``` \ No newline at end of file diff --git a/docs/cli-client/gov/pull-params.md b/docs/cli-client/gov/pull-params.md new file mode 100644 index 000000000..a5a11fdcc --- /dev/null +++ b/docs/cli-client/gov/pull-params.md @@ -0,0 +1,38 @@ +# iriscli gov pull-params + +## Description + +Generate param.json file + +## Usage + +``` +iriscli gov pull-params [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --path | $HOME/.iris | [string] directory of iris home | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Pull params + +```shell + +``` + + After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt + +``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-deposit.md b/docs/cli-client/gov/query-deposit.md new file mode 100644 index 000000000..44ec14cf1 --- /dev/null +++ b/docs/cli-client/gov/query-deposit.md @@ -0,0 +1,48 @@ +# iriscli gov query-deposit + +## Description + +Query details of a deposit + +## Usage + +``` +iriscli gov query-deposit [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --depositer | | [string] bech32 depositer address | | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query deposit + +```shell +iriscli gov query-deposit --chain-id=test --proposal-id=1 --depositer=faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07 +``` + +After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt +{ + "depositer": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", + "proposal_id": "1", + "amount": [ + { + "denom": "iris-atto", + "amount": "30000000000000000000" + } + ] +} +``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-deposits.md b/docs/cli-client/gov/query-deposits.md new file mode 100644 index 000000000..98d452edd --- /dev/null +++ b/docs/cli-client/gov/query-deposits.md @@ -0,0 +1,49 @@ +# iriscli gov query-deposits + +## Description + +Query details of a deposits + +## Usage + +``` +iriscli gov query-deposits [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query deposits + +```shell +iriscli gov query-deposits --chain-id=test --proposal-id=1 +``` + +After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt +[ + { + "depositer": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", + "proposal_id": "1", + "amount": [ + { + "denom": "iris-atto", + "amount": "35000000000000000000" + } + ] + } +] +``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-params.md b/docs/cli-client/gov/query-params.md new file mode 100644 index 000000000..33b15d995 --- /dev/null +++ b/docs/cli-client/gov/query-params.md @@ -0,0 +1,39 @@ +# iriscli gov query-params + +## Description + +Query parameter proposal's config + +## Usage + +``` +iriscli gov query-params [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --key | | [string] key name of parameter | Yes | +| --ledger | | Use a connected Ledger device | | +| --module | | [string] module name | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query params + +```shell + +``` + + After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt + +``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-proposal.md b/docs/cli-client/gov/query-proposal.md new file mode 100644 index 000000000..91b75ccf7 --- /dev/null +++ b/docs/cli-client/gov/query-proposal.md @@ -0,0 +1,65 @@ +# iriscli gov query-proposal + +## Description + +Query details of a single proposal + +## Usage + +``` +iriscli gov query-proposal [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query proposal + +```shell +iriscli gov query-proposal --chain-id=test --proposal-id=1 +``` + + After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt +{ + "proposal_id": "1", + "title": "test proposal", + "description": "a new text proposal", + "proposal_type": "Text", + "proposal_status": "DepositPeriod", + "tally_result": { + "yes": "0.0000000000", + "abstain": "0.0000000000", + "no": "0.0000000000", + "no_with_veto": "0.0000000000" + }, + "submit_time": "2018-11-14T09:10:19.365363Z", + "deposit_end_time": "2018-11-16T09:10:19.365363Z", + "total_deposit": [ + { + "denom": "iris-atto", + "amount": "49000000000000000050" + } + ], + "voting_start_time": "0001-01-01T00:00:00Z", + "voting_end_time": "0001-01-01T00:00:00Z", + "param": { + "key": "", + "value": "", + "op": "" + } +} +``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-proposals.md b/docs/cli-client/gov/query-proposals.md new file mode 100644 index 000000000..a0d634eca --- /dev/null +++ b/docs/cli-client/gov/query-proposals.md @@ -0,0 +1,42 @@ +# iriscli gov query-proposals + +## Description + +Query proposals with optional filters + +## Usage + +``` +iriscli gov query-proposals [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --depositer | | [string] (optional) filter by proposals deposited on by depositer | | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --limit | | [string] (optional) limit to latest [number] proposals. Defaults to all proposals | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --status | | [string] proposalID of proposal depositing on | | +| --trust-node | true | Don't verify proofs for responses | | +| --voter | | [string] (optional) filter by proposals voted on by voted | | + +## Examples + +### Query proposals + +```shell +iriscli gov query-proposals --chain-id=test +``` + + After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt + 1 - test proposal + 2 - new proposal +``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-tally.md b/docs/cli-client/gov/query-tally.md new file mode 100644 index 000000000..251afd863 --- /dev/null +++ b/docs/cli-client/gov/query-tally.md @@ -0,0 +1,36 @@ +# iriscli gov query-tally + +## Description + +Get the tally of a proposal vote + +## Usage + +``` +iriscli gov query-tally [flags] +``` + +## Flags +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query tally + +```shell + +``` + After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt + +``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-vote.md b/docs/cli-client/gov/query-vote.md new file mode 100644 index 000000000..7b81cbe6c --- /dev/null +++ b/docs/cli-client/gov/query-vote.md @@ -0,0 +1,39 @@ +# iriscli gov query-vote + +## Description + +Query vote + +## Usage + +``` +iriscli gov query-vote [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | +| --voter | | [string] bech32 voter address | Yes | + +## Examples + +### Query vote + +```shell + +``` + + After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt + +``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-votes.md b/docs/cli-client/gov/query-votes.md new file mode 100644 index 000000000..6967a7b92 --- /dev/null +++ b/docs/cli-client/gov/query-votes.md @@ -0,0 +1,38 @@ +# iriscli gov query-votes + +## Description + +Query votes on a proposal + +## Usage + +``` +iriscli gov query-votes [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query votes + +```shell + +``` + + After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt + +``` \ No newline at end of file diff --git a/docs/cli-client/gov/submit-proposal.md b/docs/cli-client/gov/submit-proposal.md new file mode 100644 index 000000000..06eca96ef --- /dev/null +++ b/docs/cli-client/gov/submit-proposal.md @@ -0,0 +1,67 @@ +# iriscli gov submit-proposal + +## Description + +Submit a proposal along with an initial deposit + +## Usage + +``` +iriscli gov submit-proposal [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --deposit | | [string] deposit of proposal | | +| --description | | [string] description of proposal | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --key | | the key of parameter | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --op | | [string] the operation of parameter | | +| --param | | [string] parameter of proposal,eg. [{key:key,value:value,op:update}] | | +| --path | | [string] the path of param.json | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --title | | [string] title of proposal | Yes | +| --trust-node | true | Don't verify proofs for responses | | +| --type | | [string] proposalType of proposal,eg:Text/ParameterChange/SoftwareUpgrade | Yes | + +## Examples + +### Submit a proposal + +```shell +iriscli gov submit-proposal --chain-id=test --title="test proposal" --type=Text --param="official notice" --description="a new text proposal" --from=node0 --fee=0.1iris +``` + + After that, you're done with submitting a new proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt +Password to sign with 'node0': +Committed at block 44 (tx hash: 2C28A87A6262CACEDDB4EBBC60FE989D0DB2B7DEB1EC6795D2F4707DA32C7CBF, response: {Code:0 Data:[49] Log:Msg 0: Info: GasWanted:200000 GasUsed:8091 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 112 114 111 112 111 115 97 108] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 101 114] Value:[102 97 97 49 115 108 116 106 120 100 103 107 48 48 115 56 54 50 57 50 122 48 99 110 55 97 53 100 106 99 99 116 54 101 115 115 110 97 118 100 121 122] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 97 108 45 105 100] Value:[49] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 97 114 97 109] Value:[] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 52 48 52 53 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "submit-proposal", + "completeConsumedTxFee-iris-atto": "\"4045500000000000\"", + "param": "", + "proposal-id": "1", + "proposer": "faa1sltjxdgk00s86292z0cn7a5djcct6essnavdyz" + } + } +``` \ No newline at end of file diff --git a/docs/cli-client/gov/vote.md b/docs/cli-client/gov/vote.md new file mode 100644 index 000000000..1bb8a7c9a --- /dev/null +++ b/docs/cli-client/gov/vote.md @@ -0,0 +1,51 @@ +# iriscli gov vote + +## Description + +Vote for an active proposal, options: Yes/No/NoWithVeto/Abstain + +## Usage + +``` +iriscli gov vote [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --option | | [string] vote option {Yes, No, NoWithVeto, Abstain} | Yes | +| --print-response | | return tx response (only works with async = false) | | +| --proposal-id | | [string] proposalID of proposal voting on | Yes | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Vote + +```shell + +``` + + After that, you're done with submitting a new proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. + +```txt + +``` \ No newline at end of file From 07cb06448d32656302d90cfcc01980554a29cb60 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 10:39:44 +0800 Subject: [PATCH 032/100] keys module docs --- docs/cli-client/keys/add.md | 18 +++++++++--------- docs/cli-client/keys/delete.md | 4 ++-- docs/cli-client/keys/list.md | 2 +- docs/cli-client/keys/mnemonic.md | 4 ++-- docs/cli-client/keys/new.md | 2 +- docs/cli-client/keys/show.md | 6 +++--- docs/cli-client/keys/update.md | 4 ++-- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/cli-client/keys/add.md b/docs/cli-client/keys/add.md index 2174b8c7c..f9a4f0818 100644 --- a/docs/cli-client/keys/add.md +++ b/docs/cli-client/keys/add.md @@ -12,16 +12,16 @@ iriscli keys add [flags] ## Flags -| Name, shorthand | Default | Description | Required | -| --------------- | --------- | ------------------------------------------------------------ | -------- | -| --account | | [uint32] Account number for HD derivation | | -| --dry-run | | Perform action, but don't add key to local keystore | | -| --help, -h | | help for add | | -| --index | | [uint32] Index number for HD derivation | | -| --ledger | | Store a local reference to a private key on a Ledger device | | +| Name, shorthand | Default | Description | Required | +| --------------- | --------- | ----------------------------------------------------------------- | -------- | +| --account | | [uint32] Account number for HD derivation | | +| --dry-run | | Perform action, but don't add key to local keystore | | +| --help, -h | | help for add | | +| --index | | [uint32] Index number for HD derivation | | +| --ledger | | Store a local reference to a private key on a Ledger device | | | --no-backup | | Don't print out seed phrase (if others are watching the terminal) | | -| --recover | | Provide seed phrase to recover existing key instead of creating | | -| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | +| --recover | | Provide seed phrase to recover existing key instead of creating | | +| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | ## Examples diff --git a/docs/cli-client/keys/delete.md b/docs/cli-client/keys/delete.md index 35c649091..e89d6c8c7 100644 --- a/docs/cli-client/keys/delete.md +++ b/docs/cli-client/keys/delete.md @@ -24,13 +24,13 @@ iriscli keys delete [flags] iriscli keys delete MyKey ``` -You'll be asked to enter a password for your key. +You'll receive a danger warning and be asked to enter a password for your key. ```txt DANGER - enter password to permanently delete key: ``` -After that, you're done with deleting your key. +After you enter the correct password, you're done with deleting your key. ```txt Password deleted forever (uh oh!) diff --git a/docs/cli-client/keys/list.md b/docs/cli-client/keys/list.md index a41bc74cd..83ca23029 100644 --- a/docs/cli-client/keys/list.md +++ b/docs/cli-client/keys/list.md @@ -25,7 +25,7 @@ iriscli keys list [flags] iriscli keys list ``` -After this, you will get all the local public keys with 'address' and 'pubkey' element. +You'll get all the local public keys with 'address' and 'pubkey' element. ```txt NAME: TYPE: ADDRESS: PUBKEY: diff --git a/docs/cli-client/keys/mnemonic.md b/docs/cli-client/keys/mnemonic.md index 230d0ba4c..da5728e28 100644 --- a/docs/cli-client/keys/mnemonic.md +++ b/docs/cli-client/keys/mnemonic.md @@ -22,10 +22,10 @@ iriscli keys mnemonic [flags] ### Create a bip39 mnemonic ```shell -iriscli keys mnemonic abc +iriscli keys mnemonic MyKey ``` -After this, you'll get a bip39 mnemonic. +You'll get a bip39 mnemonic with 24 words. ```txt police possible oval milk network indicate usual blossom spring wasp taste canal announce purpose rib mind river pet brown web response sting remain airport diff --git a/docs/cli-client/keys/new.md b/docs/cli-client/keys/new.md index 9d30cdd7c..6e36fc5c2 100644 --- a/docs/cli-client/keys/new.md +++ b/docs/cli-client/keys/new.md @@ -17,7 +17,7 @@ iriscli keys new [flags] | Name, shorthand | Default | Description | Required | | --------------- | ----------------- | --------------------------------------------------------------- | -------- | -| --bip44-path | "44'/118'/0'/0/0" | BIP44 path from which to derive a private key | | +| --bip44-path | 44'/118'/0'/0/0 | BIP44 path from which to derive a private key | | | --default | | Skip the prompts and just use the default values for everything | | | --help, -h | | help for add | | | --ledger | | Store a local reference to a private key on a Ledger device | | diff --git a/docs/cli-client/keys/show.md b/docs/cli-client/keys/show.md index 18fc75c23..ea4c2a84a 100644 --- a/docs/cli-client/keys/show.md +++ b/docs/cli-client/keys/show.md @@ -25,12 +25,12 @@ iriscli keys show [flags] ### Show a given key ```shell -iriscli keys show test +iriscli keys show MyKey ``` -After this, you will get the local public keys with 'address' and 'pubkey' element of a given key. +You'll get the local public keys with 'address' and 'pubkey' element of a given key. ```txt NAME: TYPE: ADDRESS: PUBKEY: -test local faa1kkm4w5pvmcw0e3vjcxqtfxwqpm3k0zakl7lxn5 fap1addwnpepq0gsl90v9dgac3r9hzgz53ul5ml5ynq89ax9x8qs5jgv5z5vyssskww57lw +MyKey local faa1kkm4w5pvmcw0e3vjcxqtfxwqpm3k0zakl7lxn5 fap1addwnpepq0gsl90v9dgac3r9hzgz53ul5ml5ynq89ax9x8qs5jgv5z5vyssskww57lw ``` \ No newline at end of file diff --git a/docs/cli-client/keys/update.md b/docs/cli-client/keys/update.md index 1c159b955..9eac11398 100644 --- a/docs/cli-client/keys/update.md +++ b/docs/cli-client/keys/update.md @@ -30,14 +30,14 @@ You'll be asked to enter the current password for your key. Enter the current passphrase: ``` -After this, you'll be asked to enter a new password. +Then you'll be asked to enter a new password and repeat it. ```txt Enter the new passphrase: Repeat the new passphrase: ``` -After that, you're done with changing your password. +It will be done if you enter a new password that meets the criteria. ```txt Password successfully updated! From a403727edf0b36f962aec7a231d3fd8196c8acd9 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 10:40:42 +0800 Subject: [PATCH 033/100] IDEA conf ignore --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index ff984d63b..8b7b0e399 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ vendor .DS_Store .idea +irishub.iml build/ .out docs/.vuepress/dist/ @@ -11,4 +12,4 @@ client/lcd/statik/statik.go dependency-graph.png tools/protobuf/*.a tools/protobuf/*.o -tools/protobuf/*.so +tools/protobuf/*.so \ No newline at end of file From cc65133e282a6e3f2923300b6003e8f1833ac8c3 Mon Sep 17 00:00:00 2001 From: Haifeng Xi Date: Fri, 16 Nov 2018 10:56:37 +0800 Subject: [PATCH 034/100] removed intro dirs --- docs/introduction/The-IRIS-Hub/Delegators.md | 1 - docs/introduction/The-IRIS-Hub/IRIS-Tokens.md | 1 - docs/introduction/The-IRIS-Hub/Proof-of-Stake.md | 1 - docs/introduction/The-IRIS-Hub/Validators.md | 1 - docs/introduction/The-IRIS-Network/README.md | 1 - docs/introduction/The-IRIS-Service/Consumers.md | 1 - docs/introduction/The-IRIS-Service/Lifecycle.md | 1 - docs/introduction/The-IRIS-Service/Providers.md | 1 - 8 files changed, 8 deletions(-) delete mode 100644 docs/introduction/The-IRIS-Hub/Delegators.md delete mode 100644 docs/introduction/The-IRIS-Hub/IRIS-Tokens.md delete mode 100644 docs/introduction/The-IRIS-Hub/Proof-of-Stake.md delete mode 100644 docs/introduction/The-IRIS-Hub/Validators.md delete mode 100644 docs/introduction/The-IRIS-Network/README.md delete mode 100644 docs/introduction/The-IRIS-Service/Consumers.md delete mode 100644 docs/introduction/The-IRIS-Service/Lifecycle.md delete mode 100644 docs/introduction/The-IRIS-Service/Providers.md diff --git a/docs/introduction/The-IRIS-Hub/Delegators.md b/docs/introduction/The-IRIS-Hub/Delegators.md deleted file mode 100644 index c8b484c90..000000000 --- a/docs/introduction/The-IRIS-Hub/Delegators.md +++ /dev/null @@ -1 +0,0 @@ -# Delegators diff --git a/docs/introduction/The-IRIS-Hub/IRIS-Tokens.md b/docs/introduction/The-IRIS-Hub/IRIS-Tokens.md deleted file mode 100644 index 61d1755e3..000000000 --- a/docs/introduction/The-IRIS-Hub/IRIS-Tokens.md +++ /dev/null @@ -1 +0,0 @@ -# IRIS Tokens diff --git a/docs/introduction/The-IRIS-Hub/Proof-of-Stake.md b/docs/introduction/The-IRIS-Hub/Proof-of-Stake.md deleted file mode 100644 index 7ec980837..000000000 --- a/docs/introduction/The-IRIS-Hub/Proof-of-Stake.md +++ /dev/null @@ -1 +0,0 @@ -# Proof of Stake diff --git a/docs/introduction/The-IRIS-Hub/Validators.md b/docs/introduction/The-IRIS-Hub/Validators.md deleted file mode 100644 index e41e267fe..000000000 --- a/docs/introduction/The-IRIS-Hub/Validators.md +++ /dev/null @@ -1 +0,0 @@ -# Validators diff --git a/docs/introduction/The-IRIS-Network/README.md b/docs/introduction/The-IRIS-Network/README.md deleted file mode 100644 index 8756dfd6a..000000000 --- a/docs/introduction/The-IRIS-Network/README.md +++ /dev/null @@ -1 +0,0 @@ -# The IRIS Network diff --git a/docs/introduction/The-IRIS-Service/Consumers.md b/docs/introduction/The-IRIS-Service/Consumers.md deleted file mode 100644 index 3476d964e..000000000 --- a/docs/introduction/The-IRIS-Service/Consumers.md +++ /dev/null @@ -1 +0,0 @@ -# Consumers diff --git a/docs/introduction/The-IRIS-Service/Lifecycle.md b/docs/introduction/The-IRIS-Service/Lifecycle.md deleted file mode 100644 index 75a17e1af..000000000 --- a/docs/introduction/The-IRIS-Service/Lifecycle.md +++ /dev/null @@ -1 +0,0 @@ -# Lifecycle diff --git a/docs/introduction/The-IRIS-Service/Providers.md b/docs/introduction/The-IRIS-Service/Providers.md deleted file mode 100644 index ae4c68601..000000000 --- a/docs/introduction/The-IRIS-Service/Providers.md +++ /dev/null @@ -1 +0,0 @@ -# Providers From 7c09bedd6a50bcf206ea5840c65ca7c7e9529a11 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Fri, 16 Nov 2018 11:17:02 +0800 Subject: [PATCH 035/100] Update irislcd docs --- docs/features/lcd.md | 181 ++++++++++++++++++++++++------------------- 1 file changed, 101 insertions(+), 80 deletions(-) diff --git a/docs/features/lcd.md b/docs/features/lcd.md index 37d860cd4..fc2ee7082 100644 --- a/docs/features/lcd.md +++ b/docs/features/lcd.md @@ -4,90 +4,111 @@ ## Basic Functionality Description -1. Provide RESTful APIs and swagger-ui to show these APIs +1. Provide restful APIs and swagger-ui to show these APIs 2. Verify query proof ## Usage Scenario Suppose an IRISLCD node is running and its swagger-ui page url is `localhost:1317/swagger-ui/`. The default home folder of irislcd is `$HOME/.irislcd`. Once an IRISLCD is started, firstly it will create key store in its home folder. If the IRISLCD is running in distrust mode, then ir will fetch the latest block as its trust basis and the trust basis will be saved to folder `trust-base.db` under its home folder. The IRISLCD node always trust the basis. It will verify all query proof against the trust basis, which means IRISLCD can only verify the proof on later height. However, this is also a defect of IRISLCD. When it tries to verify some transactions or blocks on lower height, it will report error. So if you want to query transactions or block on lower height, please start IRISLCD in trust mode. For detailed proof verification algorithm please refer to this [document](https://github.com/tendermint/tendermint/blob/master/docs/tendermint-core/light-client-protocol.md). -Open `localhost:1317/swagger-ui/` in your explorer and all RESTful APIs will be shown the page. - -### Tendermint APIs, such as query blocks, transactions and validatorset -1. `GET /node_info`: The properties of the connected node -2. `GET /syncing`: Syncing state of node -3. `GET /blocks/latest`: Get the latest block -4. `GET /blocks/{height}`: Get a block at a certain height -5. `GET /validatorsets/latest`: Get the latest validator set -6. `GET /validatorsets/{height}`: Get a validator set a certain height -7. `GET /txs/{hash}`: Get a Tx by hash -8. `GET /txs`: Search transactions -9. `POST /txs`: Broadcast Tx +Once the IRISLCD node is started successfully, then you can open `localhost:1317/swagger-ui/` in your explorer and all restful APIs will be shown. + +1. Tendermint APIs, such as query blocks, transactions and validatorset + 1. `GET /node_info`: The properties of the connected node + 2. `GET /syncing`: Syncing state of node + 3. `GET /blocks/latest`: Get the latest block + 4. `GET /blocks/{height}`: Get a block at a certain height + 5. `GET /validatorsets/latest`: Get the latest validator set + 6. `GET /validatorsets/{height}`: Get a validator set a certain height + 7. `GET /txs/{hash}`: Get a Tx by hash + 8. `GET /txs`: Search transactions + 9. `POST /txs`: Broadcast Tx -### Key management APIs - -1. `GET /keys`: List of accounts stored locally -2. `POST /keys`: Create a new account locally -3. `GET /keys/seed`: Create a new seed to create a new account with -4. `GET /keys/{name}`: Get a certain locally stored account -5. `PUT /keys/{name}`: Update the password for this account in the KMS -6. `DELETE /keys/{name}`: Remove an account -7. `GET /auth/accounts/{address}`: Get the account information on blockchain - -##Create, sign and broadcast transactions - -1. `POST /tx/sign`: Sign a transation -2. `POST /tx/broadcast`: Broadcast a signed StdTx with amino encoding signature and public key -3. `POST /txs/send`: Send non-amino encoding transaction -4. `GET /bank/coin/{coin-type}`: Get coin type -5. `GET /bank/balances/{address}`: Get the account information on blockchain -6. `POST /bank/accounts/{address}/transfers`: Send coins (build -> sign -> send) - -## Stake module APIs - -1. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction -2. `POST /stake/delegators/{delegatorAddr}/redelegate`: Submit redelegation transaction -3. `POST /stake/delegators/{delegatorAddr}/unbond`: Submit unbonding transaction -4. `GET /stake/delegators/{delegatorAddr}/delegations`: Get all delegations from a delegator -5. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations`: Get all unbonding delegations from a delegator -6. `GET /stake/delegators/{delegatorAddr}/redelegations`: Get all redelegations from a delegator -7. `GET /stake/delegators/{delegatorAddr}/validators`: Query all validators that a delegator is bonded to -8. `GET /stake/delegators/{delegatorAddr}/validators/{validatorAddr}`: Query a validator that a delegator is bonded to -9. `GET /stake/delegators/{delegatorAddr}/txs` :Get all staking txs (i.e msgs) from a delegator -10. `GET /stake/delegators/{delegatorAddr}/delegations/{validatorAddr}`: Query the current delegation between a delegator and a validator -11. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}`: Query all unbonding delegations between a delegator and a validator -12. `GET /stake/validators`: Get all validator candidates -13. `GET /stake/validators/{validatorAddr}`: Query the information from a single validator -14. `GET /stake/validators/{validatorAddr}/unbonding_delegations`: Get all unbonding delegations from a validator -15. `GET /stake/validators/{validatorAddr}/redelegations`: Get all outgoing redelegations from a validator -16. `GET /stake/pool`: Get the current state of the staking pool -17. `GET /stake/parameters`: Get the current staking parameter values - -## Governance module APIs - -1. `POST /gov/proposal`: Submit a proposal -2. `GET /gov/proposals`: Query proposals -3. `POST /gov/proposals/{proposalId}/deposits`: Deposit tokens to a proposal -4. `GET /gov/proposals/{proposalId}/deposits`: Query deposits -5. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal -6. `GET /gov/proposals/{proposalId}/votes`: Query voters -7. `GET /gov/proposals/{proposalId}`: Query a proposal -8. `GET /gov/proposals/{proposalId}/deposits/{depositor}`: Query deposit -9. `GET /gov/proposals/{proposalId}/votes/{voter}`: Query vote -10. `GET/gov/params`: Query governance parameters - -## Slashing module APIs -1. `GET /slashing/validators/{validatorPubKey}/signing_info`: Get sign info of given validator -2. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator - -## Distribution module APIs -1. `POST /distribution/{delegatorAddr}/withdrawAddress`: Set withdraw address -2. `GET /distribution/{delegatorAddr}/withdrawAddress`: Query withdraw address -3. `POST /distribution/{delegatorAddr}/withdrawReward`: Set withdraw address -4. `GET /distribution/{delegatorAddr}/distrInfo/{validatorAddr}`: Query distribution information for a delegation -5. `GET /distribution/{delegatorAddr}/distrInfos`: Query distribution information list for a given delegator -6. `GET /distribution/{validatorAddr}/valDistrInfo`: Query withdraw address - -## Query app version -1. `GET /version`: Version of irislcd -2. `GET /node_version`: Version of the connected node \ No newline at end of file +2. Key management APIs + + 1. `GET /keys`: List of accounts stored locally + 2. `POST /keys`: Create a new account locally + 3. `GET /keys/seed`: Create a new seed to create a new account with + 4. `GET /keys/{name}`: Get a certain locally stored account + 5. `PUT /keys/{name}`: Update the password for this account in the KMS + 6. `DELETE /keys/{name}`: Remove an account + 7. `GET /auth/accounts/{address}`: Get the account information on blockchain + +3. Create, sign and broadcast transactions + + 1. `POST /tx/sign`: Sign a transation + 2. `POST /tx/broadcast`: Broadcast a signed StdTx with amino encoding signature and public key + 3. `POST /txs/send`: Send non-amino encoding transaction + 4. `GET /bank/coin/{coin-type}`: Get coin type + 5. `GET /bank/balances/{address}`: Get the account information on blockchain + 6. `POST /bank/accounts/{address}/transfers`: Send coins (build -> sign -> send) + +4. Stake module APIs + + 1. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction + 2. `POST /stake/delegators/{delegatorAddr}/redelegate`: Submit redelegation transaction + 3. `POST /stake/delegators/{delegatorAddr}/unbond`: Submit unbonding transaction + 4. `GET /stake/delegators/{delegatorAddr}/delegations`: Get all delegations from a delegator + 5. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations`: Get all unbonding delegations from a delegator + 6. `GET /stake/delegators/{delegatorAddr}/redelegations`: Get all redelegations from a delegator + 7. `GET /stake/delegators/{delegatorAddr}/validators`: Query all validators that a delegator is bonded to + 8. `GET /stake/delegators/{delegatorAddr}/validators/{validatorAddr}`: Query a validator that a delegator is bonded to + 9. `GET /stake/delegators/{delegatorAddr}/txs` :Get all staking txs (i.e msgs) from a delegator + 10. `GET /stake/delegators/{delegatorAddr}/delegations/{validatorAddr}`: Query the current delegation between a delegator and a validator + 11. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}`: Query all unbonding delegations between a delegator and a validator + 12. `GET /stake/validators`: Get all validator candidates + 13. `GET /stake/validators/{validatorAddr}`: Query the information from a single validator + 14. `GET /stake/validators/{validatorAddr}/unbonding_delegations`: Get all unbonding delegations from a validator + 15. `GET /stake/validators/{validatorAddr}/redelegations`: Get all outgoing redelegations from a validator + 16. `GET /stake/pool`: Get the current state of the staking pool + 17. `GET /stake/parameters`: Get the current staking parameter values + +5. Governance module APIs + + 1. `POST /gov/proposal`: Submit a proposal + 2. `GET /gov/proposals`: Query proposals + 3. `POST /gov/proposals/{proposalId}/deposits`: Deposit tokens to a proposal + 4. `GET /gov/proposals/{proposalId}/deposits`: Query deposits + 5. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal + 6. `GET /gov/proposals/{proposalId}/votes`: Query voters + 7. `GET /gov/proposals/{proposalId}`: Query a proposal + 8. `GET /gov/proposals/{proposalId}/deposits/{depositor}`: Query deposit + 9. `GET /gov/proposals/{proposalId}/votes/{voter}`: Query vote + 10. `GET/gov/params`: Query governance parameters + +6. Slashing module APIs + 1. `GET /slashing/validators/{validatorPubKey}/signing_info`: Get sign info of given validator + 2. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator + +7. Distribution module APIs + + 1. `POST /distribution/{delegatorAddr}/withdrawAddress`: Set withdraw address + 2. `GET /distribution/{delegatorAddr}/withdrawAddress`: Query withdraw address + 3. `POST /distribution/{delegatorAddr}/withdrawReward`: Set withdraw address + 4. `GET /distribution/{delegatorAddr}/distrInfo/{validatorAddr}`: Query distribution information for a delegation + 5. `GET /distribution/{delegatorAddr}/distrInfos`: Query distribution information list for a given delegator + 6. `GET /distribution/{validatorAddr}/valDistrInfo`: Query withdraw address + +8. Query app version + + 1. `GET /version`: Version of irislcd + 2. `GET /node_version`: Version of the connected node + +## Options for post apis + +1. `POST /bank/accounts/{address}/transfers`: Send tokens (build -> sign -> send) +2. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction +3. `POST /stake/delegators/{delegatorAddr}/redelegate`: Submit redelegation transaction +4. `POST /stake/delegators/{delegatorAddr}/unbond`: Submit unbonding transaction +5. `POST /gov/proposal`: Submit a proposal +6. `POST /gov/proposals/{proposalId}/deposits`: Deposit tokens to a proposal +7. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal +8. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator + +| Option name | Type | Default | Priority | Description | +| --------------- | ---- | ------- |--------- |--------------------------- | +| generate-only | bool | false | 0 | Build an unsigned transaction and write it back | +| simulate | bool | false | 1 | Ignore the gas field and perform a simulation of a transaction, but don’t broadcast it | +| async | bool | false | 2 | Broadcast transaction asynchronously | + +The above eight post APIs have three query options which are shown in the above table. By default, their values are all false. Each option has its unique priority( Here `0` is the top priority). If multiple options are enabled, then the options with lower priority will be ignored. For instance, if `generate-only` is true, then other options, such as `simulate` and `async` will be ignored. \ No newline at end of file From a5a7bde8ee8c9ce558babdb2705fc2501fe06cab Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Fri, 16 Nov 2018 11:40:46 +0800 Subject: [PATCH 036/100] Add English doc for stake module. --- docs/cli-client/stake/create-validator.md | 62 ++++++++++++++++++ docs/cli-client/stake/delegate.md | 59 +++++++++++++++++ docs/cli-client/stake/edit-validator.md | 71 +++++++++++++++++++++ docs/cli-client/stake/parameters.md | 40 ++++++++++++ docs/cli-client/stake/pool.md | 41 ++++++++++++ docs/cli-client/stake/redelegate.md | 53 +++++++++++++++ docs/cli-client/stake/redelegation.md | 40 ++++++++++++ docs/cli-client/stake/redelegations-from.md | 37 +++++++++++ docs/cli-client/stake/redelegations.md | 37 +++++++++++ docs/cli-client/stake/signing-info.md | 37 +++++++++++ docs/cli-client/stake/unjail.md | 53 +++++++++++++++ 11 files changed, 530 insertions(+) create mode 100644 docs/cli-client/stake/create-validator.md create mode 100644 docs/cli-client/stake/delegate.md create mode 100644 docs/cli-client/stake/edit-validator.md create mode 100644 docs/cli-client/stake/parameters.md create mode 100644 docs/cli-client/stake/pool.md create mode 100644 docs/cli-client/stake/redelegate.md create mode 100644 docs/cli-client/stake/redelegation.md create mode 100644 docs/cli-client/stake/redelegations-from.md create mode 100644 docs/cli-client/stake/redelegations.md create mode 100644 docs/cli-client/stake/signing-info.md create mode 100644 docs/cli-client/stake/unjail.md diff --git a/docs/cli-client/stake/create-validator.md b/docs/cli-client/stake/create-validator.md new file mode 100644 index 000000000..58024cdf2 --- /dev/null +++ b/docs/cli-client/stake/create-validator.md @@ -0,0 +1,62 @@ +# iriscli stake create-validator + +## Description + +Create new validator initialized with a self-delegation to it + +## Usage + +``` +iriscli stake create-validator [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --address-delegator | | [string] Bech address of the delegator | | +| --amount | | [string] Amount of coins to bond | Yes | +| --async | | Broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --commission-max-change-rate | | [string] The maximum commission change rate percentage (per day) | Yes | +| --commission-max-rate | | [string] The maximum commission rate percentage | Yes | +| --commission-rate | | [string] The initial commission rate percentage | Yes | +| --details | | [string] Optional details | | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignor | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --genesis-format | | Export the transaction in gen-tx format; it implies --generate-only | | +| --help, -h | | Help for create-validator | | +| --identity | | [string] Optional identity signature (ex. UPort or Keybase) | | +| --indent | | Add indent to JSON response | | +| --ip | | [string] Node's public IP. It takes effect only when used in combination with --genesis-format | | +| --json | | Return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --moniker | | [string] Validator name | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --node-id | | [string] Node's ID | | +| --print-response | | Return tx response (only works with async = false) | | +| --pubkey | | [string] Go-Amino encoded hex PubKey of the validator. For Ed25519 the go-amino prepend hex is 1624de6220 | Yes | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | +| --website | | [string] Optional website | | + +## Examples + +### Create new validator + +```shell +iriscli stake create-validator --chain-id=ChainID --from=KeyName --fee=Fee --pubkey=ValidatorPublicKey --commission-max-change-rate=CommissionMaxChangeRate --commission-max-rate=CommissionMaxRate --commission-rate=CommissionRate --amount=Coins +``` + +After that, you're done with creating a new validator. + +```txt +TODO +``` diff --git a/docs/cli-client/stake/delegate.md b/docs/cli-client/stake/delegate.md new file mode 100644 index 000000000..5c3c7b316 --- /dev/null +++ b/docs/cli-client/stake/delegate.md @@ -0,0 +1,59 @@ +# iriscli stake delegate + +## Description + +Delegate liquid tokens to an validator + +## Usage + +``` +iriscli stake delegate [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --address-validator | | [string] Bech address of the validator | Yes | +| --amount | | [string] Amount of coins to bond | Yes | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set |manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --help, -h | | Help for delegate | | +| --indent | | Add indent to JSON response | | +| --json | | Return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence int | | Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Delegate liquid tokens to an validator + +```shell +iriscli stake delegate --chain-id=ChainID --from=KeyName --fee=Fee --amount=CoinstoBond --address-validator=ValidatorOwnerAddress +``` + +After that, you're done with delegating liquid tokens to specified validator. + +```txt +Committed at block 2352 (tx hash: 2069F0453619637EE67EFB0CFC53713AF28A0BB89137DEB4574D8B13E723999B, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:15993 Tags:[{Key:[97 99 116 105 111 110] Value:[100 101 108 101 103 97 116 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 51 108 99 119 110 120 112 121 110 50 101 97 51 115 107 122 109 101 107 54 52 118 118 110 112 57 55 106 115 107 56 113 109 104 108 54 118 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 57 57 54 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "delegate", + "completeConsumedTxFee-iris-atto": "\"7996500000000000\"", + "delegator": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "destination-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd" + } + } +``` diff --git a/docs/cli-client/stake/edit-validator.md b/docs/cli-client/stake/edit-validator.md new file mode 100644 index 000000000..e5869936a --- /dev/null +++ b/docs/cli-client/stake/edit-validator.md @@ -0,0 +1,71 @@ +# iriscli stake edit-validator + +## Description + +Edit existing validator account + +## Usage + +``` +iriscli stake edit-validator [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --address-delegator | | [string] Bech address of the delegator | | +| --amount | | [string] Amount of coins to bond | | +| --async | | Broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --commission-max-change-rate | | [string] The maximum commission change rate percentage (per day) | | +| --commission-max-rate | | [string] The maximum commission rate percentage | | +| --commission-rate | | [string] The initial commission rate percentage | | +| --details | | [string] Optional details | | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignor | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --genesis-format | | Export the transaction in gen-tx format; it implies --generate-only | | +| --help, -h | | Help for create-validator | | +| --identity | | [string] Optional identity signature (ex. UPort or Keybase) | | +| --indent | | Add indent to JSON response | | +| --ip | | [string] Node's public IP. It takes effect only when used in combination with --genesis-format | | +| --json | | Return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --moniker | | [string] Validator name | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --node-id | | [string] Node's ID | | +| --print-response | | Return tx response (only works with async = false) | | +| --pubkey | | [string] Go-Amino encoded hex PubKey of the validator. For Ed25519 the go-amino prepend hex is 1624de6220 | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | +| --website | | [string] Optional website | | + +## Examples + +### Edit existing validator account + +```shell +iriscli stake edit-validator --from=KeyName --chain-id=ChainID --fee=Fee --memo=YourMemo +``` + +After that, you're done with editting a new validator. + +```txt +Committed at block 2160 (tx hash: C48CABDA1183B5319003433EB1FDEBE5A626E00BD319F1A84D84B6247E9224D1, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:3540 Tags:[{Key:[97 99 116 105 111 110] Value:[101 100 105 116 45 118 97 108 105 100 97 116 111 114] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[109 111 110 105 107 101 114] Value:[117 98 117 110 116 117 49 56] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[105 100 101 110 116 105 116 121] Value:[] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 55 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "edit-validator", + "completeConsumedTxFee-iris-atto": "\"177000000000000\"", + "destination-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", + "identity": "", + "moniker": "ubuntu18" + } +} +``` diff --git a/docs/cli-client/stake/parameters.md b/docs/cli-client/stake/parameters.md new file mode 100644 index 000000000..12c5db948 --- /dev/null +++ b/docs/cli-client/stake/parameters.md @@ -0,0 +1,40 @@ +# iriscli stake parameters + +## Description + +Query the current staking parameters information + +## Usage + +``` +iriscli stake parameters [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query the current staking parameters information + +```shell +iriscli stake parameters +``` + +After that, you will get the current staking parameters information. + +```txt +Params +Unbonding Time: 10m0s +Max Validators: 100: +Bonded Coin Denomination: iris-atto +``` diff --git a/docs/cli-client/stake/pool.md b/docs/cli-client/stake/pool.md new file mode 100644 index 000000000..0887c191d --- /dev/null +++ b/docs/cli-client/stake/pool.md @@ -0,0 +1,41 @@ +# iriscli stake pool + +## Description + +Query the current staking pool values + +## Usage + +``` +iriscli stake pool [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query the current staking pool values + +```shell +iriscli stake pool +``` + +After that, you will get the current staking pool values. + +```txt +Pool +Loose Tokens: 49.8289125612 +Bonded Tokens: 100.1800000000 +Token Supply: 150.0089125612 +Bonded Ratio: 0.6678269863 +``` diff --git a/docs/cli-client/stake/redelegate.md b/docs/cli-client/stake/redelegate.md new file mode 100644 index 000000000..f69d753df --- /dev/null +++ b/docs/cli-client/stake/redelegate.md @@ -0,0 +1,53 @@ +# iriscli stake redelegate + +## Description + +Redelegate illiquid tokens from one validator to another + +## Usage + +``` +iriscli stake redelegate [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --address-validator-dest | | [string] Bech address of the destination validator | | +| --address-validator-source | | [string] Bech address of the source validator | | +| --async | | Broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it || +| --fee | | [string] Fee to pay along with transaction | | +| --from | | [string] Name of private key with which to sign | | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically || +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored || +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for redelegate | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --shares-amount | | [string] Amount of source-shares to either unbond or redelegate as a positive integer or decimal || +| --shares-percent | | [string] Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 || +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Redelegate illiquid tokens from one validator to another + +```shell +iriscli stake redelegation --chain-id=ChainID --from=KeyName --fee=Fee --address-validator-source=SourceValidatorVddress --address-validator-dest=DestinationValidatorAddress --shares-percent=SharePercent +``` + +After that, you're done with redelegating specified liquid tokens from one validator to another validator. + +```txt +TODO +``` diff --git a/docs/cli-client/stake/redelegation.md b/docs/cli-client/stake/redelegation.md new file mode 100644 index 000000000..bc71b8e32 --- /dev/null +++ b/docs/cli-client/stake/redelegation.md @@ -0,0 +1,40 @@ +# iriscli stake redelegation + +## Description + +Query a redelegation record based on delegator and a source and destination validator address + +## Usage + +``` +iriscli stake redelegation [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --address-delegator | | [string] Bech address of the delegator | Yes | +| --address-validator-dest | | [string] Bech address of the destination validator | Yes | +| --address-validator-source | | [string] Bech address of the source validator | Yes | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query a redelegation record + +```shell +iriscli stake redelegation --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --address-delegator=DelegatorAddress +``` + +After that, you will get specified redelegation's info based on delegator and a source and destination validator address + +```txt +TODO +``` diff --git a/docs/cli-client/stake/redelegations-from.md b/docs/cli-client/stake/redelegations-from.md new file mode 100644 index 000000000..4bbaa5ee9 --- /dev/null +++ b/docs/cli-client/stake/redelegations-from.md @@ -0,0 +1,37 @@ +# iriscli stake redelegations-from + +## Description + +Query all outgoing redelegatations from a validator + +## Usage + +``` +iriscli stake redelegations-from [operator-addr] [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query all outgoing redelegatations + +```shell +iriscli stake redelegations-from ValidatorAddress +``` + +After that, you will get all outgoing redelegatations' from specified validator + +```txt +TODO +``` diff --git a/docs/cli-client/stake/redelegations.md b/docs/cli-client/stake/redelegations.md new file mode 100644 index 000000000..39050c45b --- /dev/null +++ b/docs/cli-client/stake/redelegations.md @@ -0,0 +1,37 @@ +# iriscli stake redelegations + +## Description + +Query all redelegations records for one delegator + +## Usage + +``` +iriscli stake redelegations [delegator-addr] [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query all redelegations records + +```shell +iriscli stake redelegations DelegatorAddress +``` + +After that, you will get all redelegations records' info for specified delegator + +```txt +TODO +``` diff --git a/docs/cli-client/stake/signing-info.md b/docs/cli-client/stake/signing-info.md new file mode 100644 index 000000000..f563ad06e --- /dev/null +++ b/docs/cli-client/stake/signing-info.md @@ -0,0 +1,37 @@ +# iriscli stake signing-info + +## Description + +Query a validator's signing information + +## Usage + +``` +iriscli stake signing-info [validator-pubkey] [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for validator | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Query specified validator's signing information + +```shell +iriscli stake signing-info ValidatorPublicKey +``` + +After that, you will get specified validator's signing information. + +```txt +Start height: 0, index offset: 2136, jailed until: 1970-01-01 00:00:00 +0000 UTC, missed blocks counter: 0 +``` diff --git a/docs/cli-client/stake/unjail.md b/docs/cli-client/stake/unjail.md new file mode 100644 index 000000000..2be821105 --- /dev/null +++ b/docs/cli-client/stake/unjail.md @@ -0,0 +1,53 @@ +# iriscli stake unjail + +## Description + +Unjail validator previously jailed for downtime + +## Usage + +``` +iriscli stake redelegate [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --address-validator-dest | | [string] Bech address of the destination validator | | +| --address-validator-source | | [string] Bech address of the source validator | | +| --async | | Broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it || +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically || +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored || +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for redelegate | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence int | | Sequence number to sign the tx | | +| --shares-amount | | [string] Amount of source-shares to either unbond or redelegate as a positive integer or decimal || +| --shares-percent | | [string] Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 || +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Unjail validator previously jailed for downtime + +```shell +iriscli stake unjail --from=KeyName --fee=Fee --chain-id=ChainID +``` + +After that, you're done with unjailing specified validator. + +```txt +TODO +``` From dc03e27402588863ae7e3e6f64aa080730f67f91 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 12:03:42 +0800 Subject: [PATCH 037/100] gov module docs --- docs/cli-client/gov/README.md | 7 ++++++- docs/cli-client/gov/submit-proposal.md | 24 ++++++++++++++++++++---- 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/docs/cli-client/gov/README.md b/docs/cli-client/gov/README.md index c750378c8..9e1f6f085 100644 --- a/docs/cli-client/gov/README.md +++ b/docs/cli-client/gov/README.md @@ -2,7 +2,12 @@ ## Description -IRIShub governance module provides the basic functions as described below: +IRIShub Gov module allows you to submit proposals, vote and query the governance information you care about on the chain: +1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value min_deposit, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches min_deposit, enter voting period. However, if the block-time exceeds max_deposit_period in the deposit period, the proposal will be closed. +2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. +3. More details about voting for proposals: CosmosSDK-Gov-spec + +This module provides the basic functions as described below: 1. On-chain governance proposals on text 2. On-chain governance proposals on parameter change 3. On-chain governance proposals on software upgrade diff --git a/docs/cli-client/gov/submit-proposal.md b/docs/cli-client/gov/submit-proposal.md index 06eca96ef..781cbeb2e 100644 --- a/docs/cli-client/gov/submit-proposal.md +++ b/docs/cli-client/gov/submit-proposal.md @@ -44,13 +44,13 @@ iriscli gov submit-proposal [flags] ## Examples -### Submit a proposal +### Submit a 'Text' type proposal ```shell -iriscli gov submit-proposal --chain-id=test --title="test proposal" --type=Text --param="official notice" --description="a new text proposal" --from=node0 --fee=0.1iris +iriscli gov submit-proposal --chain-id=test --title="notice proposal" --type=Text --description="a new text proposal" --from=node0 --fee=0.01iris ``` - After that, you're done with submitting a new proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +After you enter the correct password, you're done with submitting a new proposal, and then remember to back up your proposal-id, it's the only way to retrieve your proposal. ```txt Password to sign with 'node0': @@ -64,4 +64,20 @@ Committed at block 44 (tx hash: 2C28A87A6262CACEDDB4EBBC60FE989D0DB2B7DEB1EC6795 "proposer": "faa1sltjxdgk00s86292z0cn7a5djcct6essnavdyz" } } -``` \ No newline at end of file +``` + +### Submit a 'ParameterChange' type proposal + +```shell +iriscli gov submit-proposal --chain-id=test --title="update MinDeposit proposal" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --type=ParameterChange --description="a new parameter change proposal" --from=node0 --fee=0.01iris +``` + +After that, you're done with submitting a new 'ParameterChange' proposal. Notice, in this case, 'path' and 'param' can't be both empty. The details of changed parameters （get parameters through query-params, modify it and then add "update" on the "op", more details in usage scenarios）and other fields of proposal are similar with text proposal. + +### Submit a 'SoftwareUpgrade' type proposal + +```shell +iriscli gov submit-proposal --chain-id=test --title="irishub0.7.0 upgrade proposal" --type=SoftwareUpgrade --description="a new software upgrade proposal" --from=node0 --fee=0.01iris +``` + +In this case, 'title'、 'type' and 'desciption' of the proposal is required parameters, also you should back up your proposal-id which is the only way to retrieve your proposal. From 56f4613c34a15da61dc84f0d333fcf00842a4cae Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 13:16:49 +0800 Subject: [PATCH 038/100] Move software/basic_concepts to features --- docs/.vuepress/config.js | 27 ++++++++++--------- .../basic-concepts/bech32-prefix.md | 0 .../basic-concepts/coin-type.md | 0 .../basic-concepts/fee.md | 0 .../basic-concepts/genesis-file.md | 0 .../basic-concepts/gov-params.md | 0 .../basic-concepts/inflation.md | 0 7 files changed, 14 insertions(+), 13 deletions(-) rename docs/{software => features}/basic-concepts/bech32-prefix.md (100%) rename docs/{software => features}/basic-concepts/coin-type.md (100%) rename docs/{software => features}/basic-concepts/fee.md (100%) rename docs/{software => features}/basic-concepts/genesis-file.md (100%) rename docs/{software => features}/basic-concepts/gov-params.md (100%) rename docs/{software => features}/basic-concepts/inflation.md (100%) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 26e19bc71..2ed13bd45 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -41,18 +41,8 @@ module.exports = { 'The-IRIS-Network/' ] }], - '/software/': [{ - title: 'Basic Concepts', - collapsable: false, - children: [ - ["basic-concepts/coin-type.md", 'Coin Type'], - ["basic-concepts/fee.md", 'Fee'], - ["basic-concepts/inflation.md", 'Infation'], - ["basic-concepts/bech32-prefix.md", 'Bech32 Prefix'], - ["basic-concepts/genesis-file.md", 'Genesis File'], - ["basic-concepts/gov-params.md", 'Gov Params'] - ] - }, { + '/software/': [ + { title: 'Node', collapsable: false, children: [ @@ -87,7 +77,18 @@ module.exports = { ] }], '/features/': [{ - title: 'Features', + title: 'Basic Concepts', + collapsable: false, + children: [ + ["basic-concepts/coin-type.md", 'Coin Type'], + ["basic-concepts/fee.md", 'Fee'], + ["basic-concepts/inflation.md", 'Infation'], + ["basic-concepts/bech32-prefix.md", 'Bech32 Prefix'], + ["basic-concepts/genesis-file.md", 'Genesis File'], + ["basic-concepts/gov-params.md", 'Gov Params'] + ] + },{ + title: 'Modules', collapsable: false, children: [ ['bank.md', 'Bank'], diff --git a/docs/software/basic-concepts/bech32-prefix.md b/docs/features/basic-concepts/bech32-prefix.md similarity index 100% rename from docs/software/basic-concepts/bech32-prefix.md rename to docs/features/basic-concepts/bech32-prefix.md diff --git a/docs/software/basic-concepts/coin-type.md b/docs/features/basic-concepts/coin-type.md similarity index 100% rename from docs/software/basic-concepts/coin-type.md rename to docs/features/basic-concepts/coin-type.md diff --git a/docs/software/basic-concepts/fee.md b/docs/features/basic-concepts/fee.md similarity index 100% rename from docs/software/basic-concepts/fee.md rename to docs/features/basic-concepts/fee.md diff --git a/docs/software/basic-concepts/genesis-file.md b/docs/features/basic-concepts/genesis-file.md similarity index 100% rename from docs/software/basic-concepts/genesis-file.md rename to docs/features/basic-concepts/genesis-file.md diff --git a/docs/software/basic-concepts/gov-params.md b/docs/features/basic-concepts/gov-params.md similarity index 100% rename from docs/software/basic-concepts/gov-params.md rename to docs/features/basic-concepts/gov-params.md diff --git a/docs/software/basic-concepts/inflation.md b/docs/features/basic-concepts/inflation.md similarity index 100% rename from docs/software/basic-concepts/inflation.md rename to docs/features/basic-concepts/inflation.md From 32757ba27f889488ec63f5d32499986429535ebf Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 13:17:47 +0800 Subject: [PATCH 039/100] Move software/basic_concepts to features -zh --- docs/zh/{software => features}/basic-concepts/bech32-prefix.md | 0 docs/zh/{software => features}/basic-concepts/coin-type.md | 0 docs/zh/{software => features}/basic-concepts/fee.md | 0 docs/zh/{software => features}/basic-concepts/genesis-file.md | 0 docs/zh/{software => features}/basic-concepts/gov-params.md | 0 docs/zh/{software => features}/basic-concepts/inflation.md | 0 6 files changed, 0 insertions(+), 0 deletions(-) rename docs/zh/{software => features}/basic-concepts/bech32-prefix.md (100%) rename docs/zh/{software => features}/basic-concepts/coin-type.md (100%) rename docs/zh/{software => features}/basic-concepts/fee.md (100%) rename docs/zh/{software => features}/basic-concepts/genesis-file.md (100%) rename docs/zh/{software => features}/basic-concepts/gov-params.md (100%) rename docs/zh/{software => features}/basic-concepts/inflation.md (100%) diff --git a/docs/zh/software/basic-concepts/bech32-prefix.md b/docs/zh/features/basic-concepts/bech32-prefix.md similarity index 100% rename from docs/zh/software/basic-concepts/bech32-prefix.md rename to docs/zh/features/basic-concepts/bech32-prefix.md diff --git a/docs/zh/software/basic-concepts/coin-type.md b/docs/zh/features/basic-concepts/coin-type.md similarity index 100% rename from docs/zh/software/basic-concepts/coin-type.md rename to docs/zh/features/basic-concepts/coin-type.md diff --git a/docs/zh/software/basic-concepts/fee.md b/docs/zh/features/basic-concepts/fee.md similarity index 100% rename from docs/zh/software/basic-concepts/fee.md rename to docs/zh/features/basic-concepts/fee.md diff --git a/docs/zh/software/basic-concepts/genesis-file.md b/docs/zh/features/basic-concepts/genesis-file.md similarity index 100% rename from docs/zh/software/basic-concepts/genesis-file.md rename to docs/zh/features/basic-concepts/genesis-file.md diff --git a/docs/zh/software/basic-concepts/gov-params.md b/docs/zh/features/basic-concepts/gov-params.md similarity index 100% rename from docs/zh/software/basic-concepts/gov-params.md rename to docs/zh/features/basic-concepts/gov-params.md diff --git a/docs/zh/software/basic-concepts/inflation.md b/docs/zh/features/basic-concepts/inflation.md similarity index 100% rename from docs/zh/software/basic-concepts/inflation.md rename to docs/zh/features/basic-concepts/inflation.md From d0b9dd6ddde19a066148e7b8768ace8741972c08 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 14:02:41 +0800 Subject: [PATCH 040/100] gov module docs - about deposit --- docs/cli-client/gov/deposit.md | 12 ++++++------ docs/cli-client/gov/query-deposit.md | 4 ++-- docs/cli-client/gov/query-deposits.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/cli-client/gov/deposit.md b/docs/cli-client/gov/deposit.md index 27a18d9f6..83abd7952 100644 --- a/docs/cli-client/gov/deposit.md +++ b/docs/cli-client/gov/deposit.md @@ -17,7 +17,7 @@ iriscli gov deposit [flags] | --account-number | | [int] AccountNumber number to sign the tx | | | --async | | broadcast transactions asynchronously | | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --deposit | | [string] deposit of proposal | | +| --deposit | | [string] deposit of proposal | Yes | | --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | | --fee | | [string] Fee to pay along with transaction | Yes | | --from | | [string] Name of private key with which to sign | Yes | @@ -41,19 +41,19 @@ iriscli gov deposit [flags] ### Deposit ```shell -iriscli gov deposit --chain-id=test --proposal-id=1 --deposit=10iris --from=node0 --fee=0.1iris +iriscli gov deposit --chain-id=test --proposal-id=1 --deposit=50iris --from=node0 --fee=0.01iris ``` - After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +You could deposit 50iris to make your proposal active which can be voted, after you enter the correct password, you're done with depositing iris tokens for an activing proposal. ```txt Password to sign with 'node0': -Committed at block 861 (tx hash: 42D72A67ADCBE1FD90D8313E3EFB5F63A626B41F16DC0A0C7FD116907604CEF6, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:6629 Tags:[{Key:[97 99 116 105 111 110] Value:[100 101 112 111 115 105 116] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 112 111 115 105 116 101 114] Value:[102 97 97 49 115 108 116 106 120 100 103 107 48 48 115 56 54 50 57 50 122 48 99 110 55 97 53 100 106 99 99 116 54 101 115 115 110 97 118 100 121 122] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 97 108 45 105 100] Value:[49] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 51 51 49 52 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +Committed at block 473 (tx hash: 0309E969589F19A9D9E4BFC9479720487FBF929ED6A88824414C5E7E91709206, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:6710 Tags:[{Key:[97 99 116 105 111 110] Value:[100 101 112 111 115 105 116] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 112 111 115 105 116 101 114] Value:[102 97 97 49 52 113 53 114 102 57 115 108 50 100 113 100 50 117 120 114 120 121 107 97 102 120 113 51 110 117 51 108 106 50 102 112 57 108 55 112 103 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 97 108 45 105 100] Value:[49] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 51 51 53 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) { "tags": { "action": "deposit", - "completeConsumedTxFee-iris-atto": "\"3314500000000000\"", - "depositer": "faa1sltjxdgk00s86292z0cn7a5djcct6essnavdyz", + "completeConsumedTxFee-iris-atto": "\"335500000000000\"", + "depositer": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", "proposal-id": "1" } } diff --git a/docs/cli-client/gov/query-deposit.md b/docs/cli-client/gov/query-deposit.md index 44ec14cf1..dfee3e40e 100644 --- a/docs/cli-client/gov/query-deposit.md +++ b/docs/cli-client/gov/query-deposit.md @@ -15,7 +15,7 @@ iriscli gov query-deposit [flags] | Name, shorthand | Default | Description | Required | | --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --depositer | | [string] bech32 depositer address | | +| --depositer | | [string] bech32 depositer address | Yes | | --height | | [int] block height to query, omit to get most recent provable block | | | --help, -h | | help for submit-proposal | | | --indent | | Add indent to JSON response | | @@ -32,7 +32,7 @@ iriscli gov query-deposit [flags] iriscli gov query-deposit --chain-id=test --proposal-id=1 --depositer=faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07 ``` -After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +You could query the deposited tokens on a specific proposal. ```txt { diff --git a/docs/cli-client/gov/query-deposits.md b/docs/cli-client/gov/query-deposits.md index 98d452edd..35f540479 100644 --- a/docs/cli-client/gov/query-deposits.md +++ b/docs/cli-client/gov/query-deposits.md @@ -31,7 +31,7 @@ iriscli gov query-deposits [flags] iriscli gov query-deposits --chain-id=test --proposal-id=1 ``` -After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +You could query all the deposited tokens on a specific proposal, includes deposit details for each depositor. ```txt [ From 5938c17e36fad57b226551f76cb8ac1b2ffd4fa4 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Fri, 16 Nov 2018 14:58:03 +0800 Subject: [PATCH 041/100] Add distribution feature docs --- docs/features/distribution.md | 40 ++++++++- docs/zh/cli-client/distribution/README.md | 99 ----------------------- 2 files changed, 38 insertions(+), 101 deletions(-) diff --git a/docs/features/distribution.md b/docs/features/distribution.md index 76f5d3a60..be0c94001 100644 --- a/docs/features/distribution.md +++ b/docs/features/distribution.md @@ -4,8 +4,44 @@ This module is in charge of distributing collected transaction fee and inflated token to all validators and delegators. To reduce computation stress, a lazy distribution strategy is brought in. `lazy` means that the benefit won't be paid directly to contributors automatically. The contributors are required to explicitly send transactions to withdraw their benefit, otherwise, their benefit will be kept in the global pool. -## Basic Functionality Description +## Usage Scenario +1. Set withdraw address + A delegator may have multiple irishub wallet address. Suppose one of the wallets has many iris token and part of these tokens have been delegated to a validator. + The delegator may hope the delegation reward can be paid to another wallet, thus the delegator will have explicit idea about how many tokens he/she has earned. + However, by default, the reward will be paid to the wallet(marked as `A`) address which send the delegation transaction. To set another wallet(marked as `B`) as the paid address, + delegator need to send another transaction from wallet `A`. The referenced command can be: + ```bash + iriscli distribution set-withdraw-addr [address of wallet B] --fee=0.004iris --from=[key name of wallet A] --chain-id=[chain-id] + ``` + To verify the whether the above operation take effect, delegator can execute the following command. + ```bash + iriscli distribution withdraw-address [address of wallet A] + ``` + If set withdraw operation is success, the query response must equal to the address of wallet B. -## Usage Scenario \ No newline at end of file +2. Withdraw reward + + According to the introduction section, our delegation reward won't be paid to our wallet automatically, we have to send transactions to withdraw reward. + Suppose a delegator operate a validator(marked as `validatorA`), besides, it also has delegations on two other validators(marked as `validatorB` and `validatorC`). All delegations are created from wallet A. + + 1. Only withdraw the self-delegation reward of from validatorA: + ```bash + iriscli distribution withdraw-rewards --only-from-validator [address of validatorA] --from [key name of wallet A] --fee=0.004iris --chain-id=[chain-id] + ``` + 2. Withdraw all delegation reward: + ```bash + iriscli distribution withdraw-rewards --from [key name of wallet A] --fee=0.004iris --chain-id=[chain-id] + ``` + 3. Withdraw all delegation reward including commission benefit of `validatorA` : + ```bash + iriscli distribution withdraw-rewards --is-validator=true --from [key name of wallet A] --fee=0.004iris --chain-id=[chain-id] + ``` + +3. Query reward token + + Execute the command to get the earned tokens: + ```bash + iriscli bank account [withdraw address] + ``` \ No newline at end of file diff --git a/docs/zh/cli-client/distribution/README.md b/docs/zh/cli-client/distribution/README.md index 5da77ae77..e69de29bb 100644 --- a/docs/zh/cli-client/distribution/README.md +++ b/docs/zh/cli-client/distribution/README.md @@ -1,99 +0,0 @@ -# Introduction - -This document description how to use the the command line interface of distribution module. - -# Query interface - -By default, trust-node mode is enable. If you don't trust the connected node, just append --trust-node=false in each query command. - -1. Query withdraw address - - For example: - ```bash - ubuntu@ubuntu:~$ iriscli distribution withdraw-address faa1vm068fnjx28zv7k9kd9j85wrwhjn8vfsxfmcrz - ``` - If the given delegator doesn't specify other withdraw address, the query result will be empty. - -2. Query delegation distribution information - - For example: - ```bash - ubuntu@ubuntu:~$ iriscli distribution delegation-distr-info --address-delegator=faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j \ - --address-validator=fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4 - ``` - Query result: - ```json - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", - "del_pool_withdrawal_height": "4044" - } - ``` - The above response means this delegator has send transaction to withdraw reward at height 4044 or the delegation is created on height 4044. - -2. Query delegator distribution information - - For example: - ```bash - iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j - ``` - Query result: - ```json - [ - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", - "del_pool_withdrawal_height": "10859" - }, - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", - "del_pool_withdrawal_height": "4044" - } - ] - ``` - -4. Query validator distribution information - - For example: - ```bash - iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j - ``` - Query result: - ```json - { - "operator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "fee_pool_withdrawal_height": "416", - "del_accum": { - "update_height": "416", - "accum": "0.0000000000" - }, - "del_pool": "0.0000000000iris", - "val_commission": "0.0000000000iris" - } - ``` - -# Send transactions interface - -1. Set withdraw address - - Validator operators or delegators can specify other address as their withdraw address. If no other address has been specified, the delegator address or validator self-delegator address will be used as default address. - For example: - ```bash - iriscli distribution set-withdraw-addr faa1syva9fvh8m6dc6wjnjedah64mmpq7rwwz6nj0k --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - -2. withdraw rewards - - 1. Only withdraw the delegation reward from a given validator - ```bash - iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - 2. Withdraw all delegation reward of a delegator - ```bash - iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - 3. If the delegator is a onwer of a validator, withdraw all delegation reward and validator reward: - ```bash - iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test - ``` \ No newline at end of file From 079fb57b785be383e0ed9c752454bb08336d79f6 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 15:15:48 +0800 Subject: [PATCH 042/100] gov module docs - about votes --- docs/cli-client/gov/deposit.md | 2 +- docs/cli-client/gov/query-tally.md | 12 +++++++++--- docs/cli-client/gov/query-vote.md | 10 +++++++--- docs/cli-client/gov/query-votes.md | 12 +++++++++--- docs/cli-client/gov/vote.md | 18 ++++++++++++++---- 5 files changed, 40 insertions(+), 14 deletions(-) diff --git a/docs/cli-client/gov/deposit.md b/docs/cli-client/gov/deposit.md index 83abd7952..f86fd4c62 100644 --- a/docs/cli-client/gov/deposit.md +++ b/docs/cli-client/gov/deposit.md @@ -44,7 +44,7 @@ iriscli gov deposit [flags] iriscli gov deposit --chain-id=test --proposal-id=1 --deposit=50iris --from=node0 --fee=0.01iris ``` -You could deposit 50iris to make your proposal active which can be voted, after you enter the correct password, you're done with depositing iris tokens for an activing proposal. +After you enter the correct password, you could deposit 50iris to make your proposal active which can be voted, after you enter the correct password, you're done with depositing iris tokens for an activing proposal. ```txt Password to sign with 'node0': diff --git a/docs/cli-client/gov/query-tally.md b/docs/cli-client/gov/query-tally.md index 251afd863..a132459b1 100644 --- a/docs/cli-client/gov/query-tally.md +++ b/docs/cli-client/gov/query-tally.md @@ -27,10 +27,16 @@ iriscli gov query-tally [flags] ### Query tally ```shell - +iriscli gov query-tally --chain-id=test --proposal-id=1 ``` - After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. -```txt +You could query the statistics of each voting option. +```txt +{ + "yes": "100.0000000000", + "abstain": "0.0000000000", + "no": "0.0000000000", + "no_with_veto": "0.0000000000" +} ``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-vote.md b/docs/cli-client/gov/query-vote.md index 7b81cbe6c..52fa62d65 100644 --- a/docs/cli-client/gov/query-vote.md +++ b/docs/cli-client/gov/query-vote.md @@ -29,11 +29,15 @@ iriscli gov query-vote [flags] ### Query vote ```shell - +iriscli gov query-vote --chain-id=test --proposal-id=1 --voter=faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd ``` - After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +You could query the voting by specifying the proposal and the voter. ```txt - +{ + "voter": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", + "proposal_id": "1", + "option": "Yes" +} ``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-votes.md b/docs/cli-client/gov/query-votes.md index 6967a7b92..1502b1941 100644 --- a/docs/cli-client/gov/query-votes.md +++ b/docs/cli-client/gov/query-votes.md @@ -28,11 +28,17 @@ iriscli gov query-votes [flags] ### Query votes ```shell - +iriscli gov query-votes --chain-id=test --proposal-id=1 ``` - After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +You could query the voting of all the voters by specifying the proposal. ```txt - +[ + { + "voter": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", + "proposal_id": "1", + "option": "Yes" + } +] ``` \ No newline at end of file diff --git a/docs/cli-client/gov/vote.md b/docs/cli-client/gov/vote.md index 1bb8a7c9a..066e54399 100644 --- a/docs/cli-client/gov/vote.md +++ b/docs/cli-client/gov/vote.md @@ -38,14 +38,24 @@ iriscli gov vote [flags] ## Examples -### Vote +### Vote for proposal ```shell - +iriscli gov vote --chain-id=test --proposal-id=1 --option=Yes --from node0 --fee=0.01iris ``` - After that, you're done with submitting a new proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +Validators and delegators can vote for proposals which enter voting period. +After you enter the correct password, you're done with voting for a 'VotingPeriod' proposal. ```txt - +Vote[Voter:faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd,ProposalID:1,Option:Yes]Password to sign with 'node0': +Committed at block 989 (tx hash: ABDD88AA3CA8F365AC499427477CCE83ADF09D7FC2D62643D0217107E489A483, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:2408 Tags:[{Key:[97 99 116 105 111 110] Value:[118 111 116 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[118 111 116 101 114] Value:[102 97 97 49 52 113 53 114 102 57 115 108 50 100 113 100 50 117 120 114 120 121 107 97 102 120 113 51 110 117 51 108 106 50 102 112 57 108 55 112 103 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 97 108 45 105 100] Value:[49] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 50 48 52 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "vote", + "completeConsumedTxFee-iris-atto": "\"120400000000000\"", + "proposal-id": "1", + "voter": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd" + } + } ``` \ No newline at end of file From 277c7be801cd587fae94b2b66bafd79c6fead53b Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Fri, 16 Nov 2018 15:25:27 +0800 Subject: [PATCH 043/100] Update English stake docs --- docs/cli-client/stake/create-validator.md | 3 --- docs/cli-client/stake/redelegate.md | 24 +++++++++++++------ docs/cli-client/stake/redelegation.md | 9 ++++++- docs/cli-client/stake/redelegations-from.md | 22 +++++++++++++++-- docs/cli-client/stake/redelegations.md | 16 +++++++++++-- docs/cli-client/stake/unbonding-delegation.md | 4 ++-- docs/cli-client/stake/unjail.md | 3 --- 7 files changed, 61 insertions(+), 20 deletions(-) diff --git a/docs/cli-client/stake/create-validator.md b/docs/cli-client/stake/create-validator.md index 58024cdf2..3816421a1 100644 --- a/docs/cli-client/stake/create-validator.md +++ b/docs/cli-client/stake/create-validator.md @@ -57,6 +57,3 @@ iriscli stake create-validator --chain-id=ChainID --from=KeyName --fee=Fee --pub After that, you're done with creating a new validator. -```txt -TODO -``` diff --git a/docs/cli-client/stake/redelegate.md b/docs/cli-client/stake/redelegate.md index f69d753df..a54d1e319 100644 --- a/docs/cli-client/stake/redelegate.md +++ b/docs/cli-client/stake/redelegate.md @@ -15,13 +15,13 @@ iriscli stake redelegate [flags] | Name, shorthand | Default | Description | Required | | ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | | --account-number | | [int] AccountNumber number to sign the tx | | -| --address-validator-dest | | [string] Bech address of the destination validator | | -| --address-validator-source | | [string] Bech address of the source validator | | +| --address-validator-dest | | [string] Bech address of the destination validator | Yes | +| --address-validator-source | | [string] Bech address of the source validator | Yes | | --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | | --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it || -| --fee | | [string] Fee to pay along with transaction | | -| --from | | [string] Name of private key with which to sign | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | | --from-addr | | [string] Specify from address in generate-only mode | | | --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically || | --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored || @@ -43,11 +43,21 @@ iriscli stake redelegate [flags] ### Redelegate illiquid tokens from one validator to another ```shell -iriscli stake redelegation --chain-id=ChainID --from=KeyName --fee=Fee --address-validator-source=SourceValidatorVddress --address-validator-dest=DestinationValidatorAddress --shares-percent=SharePercent +iriscli stake redelegate --chain-id=ChainID --from=KeyName --fee=Fee --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --shares-percent=SharesPercent ``` After that, you're done with redelegating specified liquid tokens from one validator to another validator. ```txt -TODO +Committed at block 648 (tx hash: E59EE3C8F04D62DA0F5CFD89AC96402A92A56728692AEA47E8A126CDDA58E44B, response: {Code:0 Data:[11 8 185 204 185 223 5 16 247 169 147 42] Log:Msg 0: Info: GasWanted:200000 GasUsed:29085 Tags:[{Key:[97 99 116 105 111 110] Value:[98 101 103 105 110 45 114 101 100 101 108 101 103 97 116 105 111 110] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 48 115 48 97 114 113 57 107 104 112 108 48 99 102 122 110 103 51 113 103 120 99 120 113 48 110 121 54 104 109 99 57 115 121 116 106 102 107] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[115 111 117 114 99 101 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 100 97 121 117 106 100 102 110 120 106 103 103 100 53 121 100 108 118 118 103 107 101 114 112 50 115 117 112 107 110 116 104 97 106 112 99 104 50] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 104 50 55 120 100 119 54 116 57 108 53 106 103 118 117 110 55 54 113 100 117 52 53 107 103 114 120 57 108 113 101 100 101 56 104 112 99 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[101 110 100 45 116 105 109 101] Value:[11 8 185 204 185 223 5 16 247 169 147 42] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 53 56 49 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "begin-redelegation", + "completeConsumedTxFee-iris-atto": "\"5817000000000000\"", + "delegator": "faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk", + "destination-validator": "fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd", + "end-time": "\u000b\u0008\ufffd̹\ufffd\u0005\u0010\ufffd\ufffd\ufffd*", + "source-validator": "fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2" + } +} ``` diff --git a/docs/cli-client/stake/redelegation.md b/docs/cli-client/stake/redelegation.md index bc71b8e32..75d3c7d5b 100644 --- a/docs/cli-client/stake/redelegation.md +++ b/docs/cli-client/stake/redelegation.md @@ -36,5 +36,12 @@ iriscli stake redelegation --address-validator-source=SourceValidatorAddress --a After that, you will get specified redelegation's info based on delegator and a source and destination validator address ```txt -TODO +Redelegation +Delegator: faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk +Source Validator: fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2 +Destination Validator: fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd +Creation height: 1130 +Min time to unbond (unix): 2018-11-16 07:22:48.740311064 +0000 UTC +Source shares: 0.1000000000 +Destination shares: 0.1000000000 ``` diff --git a/docs/cli-client/stake/redelegations-from.md b/docs/cli-client/stake/redelegations-from.md index 4bbaa5ee9..5428ce3ee 100644 --- a/docs/cli-client/stake/redelegations-from.md +++ b/docs/cli-client/stake/redelegations-from.md @@ -32,6 +32,24 @@ iriscli stake redelegations-from ValidatorAddress After that, you will get all outgoing redelegatations' from specified validator -```txt -TODO +```json +[ + { + "delegator_addr": "faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk", + "validator_src_addr": "fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2", + "validator_dst_addr": "fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd", + "creation_height": "1130", + "min_time": "2018-11-16T07:22:48.740311064Z", + "initial_balance": { + "denom": "iris-atto", + "amount": "100000000000000000" + }, + "balance": { + "denom": "iris-atto", + "amount": "100000000000000000" + }, + "shares_src": "100000000000000000.0000000000", + "shares_dst": "100000000000000000.0000000000" + } +] ``` diff --git a/docs/cli-client/stake/redelegations.md b/docs/cli-client/stake/redelegations.md index 39050c45b..77c07600f 100644 --- a/docs/cli-client/stake/redelegations.md +++ b/docs/cli-client/stake/redelegations.md @@ -32,6 +32,18 @@ iriscli stake redelegations DelegatorAddress After that, you will get all redelegations records' info for specified delegator -```txt -TODO +```json +[ + { + "delegator_addr": "faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk", + "validator_src_addr": "fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2", + "validator_dst_addr": "fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd", + "creation_height": "1130", + "min_time": "2018-11-16T07:22:48.740311064Z", + "initial_balance": "0.1iris", + "balance": "0.1iris", + "shares_src": "0.1000000000", + "shares_dst": "0.1000000000" + } +] ``` diff --git a/docs/cli-client/stake/unbonding-delegation.md b/docs/cli-client/stake/unbonding-delegation.md index 3ad0f6618..b2313ed65 100644 --- a/docs/cli-client/stake/unbonding-delegation.md +++ b/docs/cli-client/stake/unbonding-delegation.md @@ -14,8 +14,8 @@ iriscli stake unbonding-delegation [flags] | Name, shorthand | Default | Description | Required | | ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --address-delegator | | [string] Bech address of the delegator | | -| --address-validator | | [string] Bech address of the validator | | +| --address-delegator | | [string] Bech address of the delegator | Yes | +| --address-validator | | [string] Bech address of the validator | Yes | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | | --help, -h | | help for validator | | diff --git a/docs/cli-client/stake/unjail.md b/docs/cli-client/stake/unjail.md index 2be821105..031f0f58a 100644 --- a/docs/cli-client/stake/unjail.md +++ b/docs/cli-client/stake/unjail.md @@ -48,6 +48,3 @@ iriscli stake unjail --from=KeyName --fee=Fee --chain-id=ChainID After that, you're done with unjailing specified validator. -```txt -TODO -``` From d3c774672c8ca04b03fe023570dfa6e8b0cc403d Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Fri, 16 Nov 2018 15:35:48 +0800 Subject: [PATCH 044/100] Add Chinese docs for distribution --- docs/cli-client/distribution/README.md | 4 +- docs/zh/cli-client/distribution/README.md | 99 +++++++++++++++++++++++ 2 files changed, 101 insertions(+), 2 deletions(-) diff --git a/docs/cli-client/distribution/README.md b/docs/cli-client/distribution/README.md index 5da77ae77..e3facf88f 100644 --- a/docs/cli-client/distribution/README.md +++ b/docs/cli-client/distribution/README.md @@ -10,7 +10,7 @@ By default, trust-node mode is enable. If you don't trust the connected node, ju For example: ```bash - ubuntu@ubuntu:~$ iriscli distribution withdraw-address faa1vm068fnjx28zv7k9kd9j85wrwhjn8vfsxfmcrz + iriscli distribution withdraw-address faa1vm068fnjx28zv7k9kd9j85wrwhjn8vfsxfmcrz ``` If the given delegator doesn't specify other withdraw address, the query result will be empty. @@ -18,7 +18,7 @@ By default, trust-node mode is enable. If you don't trust the connected node, ju For example: ```bash - ubuntu@ubuntu:~$ iriscli distribution delegation-distr-info --address-delegator=faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j \ + iriscli distribution delegation-distr-info --address-delegator=faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j \ --address-validator=fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4 ``` Query result: diff --git a/docs/zh/cli-client/distribution/README.md b/docs/zh/cli-client/distribution/README.md index e69de29bb..b82ff74ed 100644 --- a/docs/zh/cli-client/distribution/README.md +++ b/docs/zh/cli-client/distribution/README.md @@ -0,0 +1,99 @@ +# 介绍 + +这里主要介绍distribution模块对于的命令行接口。 + +# 查询接口 + +在默认情况下，所以查询命令处于信任模式，也就是在查询的时候不要求全节点返回查询结果对于的proof，并且即使全节点返回proof也不会对其进行验证。如果用户不信任所连接的全节点，可以通过在查询命令后天就`--trust-node=false`来使能非信任模式。 + +1. 查询撤回地址 + + 示例命令: + ```bash + iriscli distribution withdraw-address faa1vm068fnjx28zv7k9kd9j85wrwhjn8vfsxfmcrz + ``` + 如果委托人没有指定过撤回地址，那么查询结果为空。 + +2. 查询委托(delegation)的收益分配记录 + + 示例命令: + ```bash + iriscli distribution delegation-distr-info --address-delegator=faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j \ + --address-validator=fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4 + ``` + 示例查询结果： + ```json + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } + ``` + 从这个查询结果可知，这个委托是在4044高度创建的，或者在4044高度发起过撤回交易。 + +2. 查询委托人所有的委托(delegation)的收益分配记录 + + 示例命令: + ```bash + iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j + ``` + 示例查询结果： + ```json + [ + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", + "del_pool_withdrawal_height": "10859" + }, + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } + ] + ``` + +4. 查询验证人收益分配记录 + + 示例命令: + ```bash + iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j + ``` + 示例查询结果： + ```json + { + "operator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "fee_pool_withdrawal_height": "416", + "del_accum": { + "update_height": "416", + "accum": "10000.0000000000" + }, + "del_pool": "10.1300000000iris", + "val_commission": "1.2345000000iris" + } + ``` + 从这个查询结果可知，这个委托是在4044高度创建的，或者在4044高度发起过撤回交易。 + +# 发交易接口 + +1. 设置收益收款地址 + + 示例命令: + ```bash + iriscli distribution set-withdraw-addr faa1syva9fvh8m6dc6wjnjedah64mmpq7rwwz6nj0k --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + +2. withdraw rewards + + 1. 仅撤回某一个委托产生的收益 + ```bash + iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + 2. 仅撤回某所有委托产生的收益 + ```bash + iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test + ``` + 3. 仅撤回某所有委托产生的收益和验证人的佣金收益 + ```bash + iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test + ``` \ No newline at end of file From 966fb2163aeba75f699210a0d9639bf245012447 Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Fri, 16 Nov 2018 15:52:20 +0800 Subject: [PATCH 045/100] Add doc for status subcmd --- docs/cli-client/status/README.md | 33 ++++++++++++++++++++++++++++- docs/zh/cli-client/status/README.md | 33 ++++++++++++++++++++++++++++- 2 files changed, 64 insertions(+), 2 deletions(-) diff --git a/docs/cli-client/status/README.md b/docs/cli-client/status/README.md index 5083eb47f..39f0403f2 100644 --- a/docs/cli-client/status/README.md +++ b/docs/cli-client/status/README.md @@ -1 +1,32 @@ -# iriscli \ No newline at end of file +# iriscli status + +## Description + +Query remote node for status + +## Usage + +```shell +iriscli status [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | --------------------- | ----------------------------------- | -------- | +| --help, -h | | Help for status | | +| --node, -n | tcp://localhost:26657 | [string] Node to connect to | | + +## Examples + +### Query remote node for status + +```shell +iriscli status +``` + +After that, you can get remote node status as follows: + +```json +{"node_info":{"protocol_version":{"p2p":"4","block":"7","app":"0"},"id":"959185fdc3d14bdc7be1af40c5290d25042a454c","listen_addr":"tcp://0.0.0.0:26656","network":"test","version":"0.26.0","channels":"4020212223303800","moniker":"node0","other":{"tx_index":"on","rpc_address":"tcp://0.0.0.0:26657"}},"sync_info":{"latest_block_hash":"04A6B890A61F503A64F254CF8479C8FB9012A9C9494249DC76F81B6453ADF6A1","latest_app_hash":"B3549258BBC34860630BB5721364104DAC241EB243A8B0BCA0AA4968A64A1A6B","latest_block_height":"2647","latest_block_time":"2018-11-16T03:12:46.701163933Z","catching_up":false},"validator_info":{"address":"91679AB00C0A09B006F9A812AAF686092657F658","pub_key":{"type":"tendermint/PubKeyEd25519","value":"r4r9TUJgKF8xxANw+8aMy9OP6rdwIFM6iUa8KVUaofo="},"voting_power":"100"}} +``` diff --git a/docs/zh/cli-client/status/README.md b/docs/zh/cli-client/status/README.md index 5083eb47f..3c6dabf22 100644 --- a/docs/zh/cli-client/status/README.md +++ b/docs/zh/cli-client/status/README.md @@ -1 +1,32 @@ -# iriscli \ No newline at end of file +# iriscli status + +## 描述 + +查询远端节点状态 + +## 用法 + +```shell +iriscli status [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------------- | --------------------- | ----------------------------------- | -------- | +| --help, -h | | 状态命令帮助 | | +| --node, -n | tcp://localhost:26657 | [string] 连接的节点 | | + +## 例子 + +### 查询远端节点状态 + +```shell +iriscli status +``` + +查询到的结果如下所示： + +```json +{"node_info":{"protocol_version":{"p2p":"4","block":"7","app":"0"},"id":"959185fdc3d14bdc7be1af40c5290d25042a454c","listen_addr":"tcp://0.0.0.0:26656","network":"test","version":"0.26.0","channels":"4020212223303800","moniker":"node0","other":{"tx_index":"on","rpc_address":"tcp://0.0.0.0:26657"}},"sync_info":{"latest_block_hash":"04A6B890A61F503A64F254CF8479C8FB9012A9C9494249DC76F81B6453ADF6A1","latest_app_hash":"B3549258BBC34860630BB5721364104DAC241EB243A8B0BCA0AA4968A64A1A6B","latest_block_height":"2647","latest_block_time":"2018-11-16T03:12:46.701163933Z","catching_up":false},"validator_info":{"address":"91679AB00C0A09B006F9A812AAF686092657F658","pub_key":{"type":"tendermint/PubKeyEd25519","value":"r4r9TUJgKF8xxANw+8aMy9OP6rdwIFM6iUa8KVUaofo="},"voting_power":"100"}} +``` From a8495388421aa42028f8cf388caef96190cb411b Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 16:02:17 +0800 Subject: [PATCH 046/100] gov module docs - about votes --- docs/cli-client/gov/pull-params.md | 57 ++++++++++++++++++++++++-- docs/cli-client/gov/query-params.md | 28 ++++++++++--- docs/cli-client/gov/submit-proposal.md | 4 +- 3 files changed, 79 insertions(+), 10 deletions(-) diff --git a/docs/cli-client/gov/pull-params.md b/docs/cli-client/gov/pull-params.md index a5a11fdcc..d54826b00 100644 --- a/docs/cli-client/gov/pull-params.md +++ b/docs/cli-client/gov/pull-params.md @@ -14,13 +14,13 @@ iriscli gov pull-params [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --chain-id | | [string] Chain ID of tendermint node | | | --height | | [int] block height to query, omit to get most recent provable block | | | --help, -h | | help for submit-proposal | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --path | $HOME/.iris | [string] directory of iris home | Yes | +| --path | $HOME/.iris | [string] directory of iris home | | | --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -28,11 +28,60 @@ iriscli gov pull-params [flags] ### Pull params ```shell - +iriscli gov pull-params ``` - After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +Then you'll receive a message as described below: ```txt +Save the parameter config file in /Users/trevorfu/.iris/config/params.json +``` +If you open the params.json in the --path/config directory, you can see it's json format content. + +```txt +{ + "gov": { + "Gov/govDepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000000" + } + ], + "max_deposit_period": "172800000000000" + }, + "Gov/govVotingProcedure": { +: "gov": { + "Gov/govDepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000000" + } + ], + "max_deposit_period": "172800000000000" + }, + "Gov/govVotingProcedure": { + "voting_period": "172800000000000" +: "gov": { + "Gov/govDepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000000" + } + ], + "max_deposit_period": "172800000000000" + }, + "Gov/govVotingProcedure": { + "voting_period": "172800000000000" + }, + "Gov/govTallyingProcedure": { + "threshold": "0.5000000000", + "veto": "0.3340000000", + "participation": "0.6670000000" + } + } +} ``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-params.md b/docs/cli-client/gov/query-params.md index 33b15d995..b89979ea8 100644 --- a/docs/cli-client/gov/query-params.md +++ b/docs/cli-client/gov/query-params.md @@ -14,11 +14,11 @@ iriscli gov query-params [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --chain-id | | [string] Chain ID of tendermint node | | | --height | | [int] block height to query, omit to get most recent provable block | | | --help, -h | | help for submit-proposal | | | --indent | | Add indent to JSON response | | -| --key | | [string] key name of parameter | Yes | +| --key | | [string] key name of parameter | | | --ledger | | Use a connected Ledger device | | | --module | | [string] module name | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | @@ -26,14 +26,32 @@ iriscli gov query-params [flags] ## Examples -### Query params +### Query params by module ```shell +iriscli gov query-params --module=gov +``` + +You'll get all the keys of gov module. + +```txt +[ + "Gov/govDepositProcedure", + "Gov/govTallyingProcedure", + "Gov/govVotingProcedure" +] +``` + +### Query params by key +```shell +iriscli gov query-params --key=Gov/govDepositProcedure ``` - After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +You'll get all the details of the key specified in the gov module. ```txt +{"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"1000000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":""} +``` -``` \ No newline at end of file +Note: --module and --key cannot be both empty. \ No newline at end of file diff --git a/docs/cli-client/gov/submit-proposal.md b/docs/cli-client/gov/submit-proposal.md index 781cbeb2e..2fa1c09a1 100644 --- a/docs/cli-client/gov/submit-proposal.md +++ b/docs/cli-client/gov/submit-proposal.md @@ -72,7 +72,9 @@ Committed at block 44 (tx hash: 2C28A87A6262CACEDDB4EBBC60FE989D0DB2B7DEB1EC6795 iriscli gov submit-proposal --chain-id=test --title="update MinDeposit proposal" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --type=ParameterChange --description="a new parameter change proposal" --from=node0 --fee=0.01iris ``` -After that, you're done with submitting a new 'ParameterChange' proposal. Notice, in this case, 'path' and 'param' can't be both empty. The details of changed parameters （get parameters through query-params, modify it and then add "update" on the "op", more details in usage scenarios）and other fields of proposal are similar with text proposal. +After that, you're done with submitting a new 'ParameterChange' proposal. +The details of changed parameters （get parameters through query-params, modify it and then add "update" on the "op", more details in usage scenarios）and other fields of proposal are similar with text proposal. +Note: in this case, --path and --param cannot be both empty. ### Submit a 'SoftwareUpgrade' type proposal From e23a3e3ddcaa44562a3ea55d66a3098aef583c07 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Fri, 16 Nov 2018 16:05:21 +0800 Subject: [PATCH 047/100] Add Chinese docs for lcd --- docs/cli-client/lcd/{lcd.md => README.md} | 10 +- docs/zh/cli-client/lcd/README.md | 36 +++++++ docs/zh/features/lcd.md | 114 ++++++++++++++++++++++ 3 files changed, 155 insertions(+), 5 deletions(-) rename docs/cli-client/lcd/{lcd.md => README.md} (86%) create mode 100644 docs/zh/cli-client/lcd/README.md create mode 100644 docs/zh/features/lcd.md diff --git a/docs/cli-client/lcd/lcd.md b/docs/cli-client/lcd/README.md similarity index 86% rename from docs/cli-client/lcd/lcd.md rename to docs/cli-client/lcd/README.md index dca3b46df..352629f04 100644 --- a/docs/cli-client/lcd/lcd.md +++ b/docs/cli-client/lcd/README.md @@ -1,6 +1,6 @@ # What is Irislcd -An irislcd node is a REST server which can connect to any full nodes and provide a set of rest APIs. By these APIs, users can send transactions and query blockchain data. Irislcd can verify the proof of query result. So it can provide the same security as a full node with the minimal requirements on bandwidth, computing and storage resource. Besides, it also provides swagger-ui which presents detailed description about what APIs it provides and how to use them. +An IRISLCD node is a REST server which can connect to any full nodes and provide a set of rest APIs. By these APIs, users can send transactions and query blockchain data. Irislcd can verify the proof of query result. So it can provide the same security as a full node with the minimal requirements on bandwidth, computing and storage resource. Besides, it also provides swagger-ui which presents detailed description about what APIs it provides and how to use them. ## Irislcd usage @@ -8,8 +8,8 @@ Irislcd has two subcommands: | subcommand | Description | Example command | | --------------- | --------------------------- | --------------- | -| version | Print the irislcd version | irislcd version | -| start | Start a irislcd node | irislcd start --chain-id= | +| version | Print the IRISLCD version | IRISLCD version | +| start | Start a IRISLCD node | IRISLCD start --chain-id= | `start` subcommand has these options: @@ -25,12 +25,12 @@ Irislcd has two subcommands: ## Sample commands -1. When the connected full node is trusted, then the proof is not necessary, so you can run irislcd with trust-node option: +1. When the connected full node is trusted, then the proof is not necessary, so you can run IRISLCD with trust-node option: ```bash irislcd start --chain-id= --trust-node ``` -2. If you want to access your irislcd in remote machine, you have to specify `--laddr`, for instance: +2. If you want to access your IRISLCD in remote machine, you have to specify `--laddr`, for instance: ```bash irislcd start --chain-id= --laddr=tcp://0.0.0.0:1317 ``` \ No newline at end of file diff --git a/docs/zh/cli-client/lcd/README.md b/docs/zh/cli-client/lcd/README.md new file mode 100644 index 000000000..493ea54e8 --- /dev/null +++ b/docs/zh/cli-client/lcd/README.md @@ -0,0 +1,36 @@ +# 介绍 + +IRISLCD节点是一个提供REST APIs接口的服务器，它可以连接到任何IRISHUB的全节点。通过这些REST APIs，用户可以发送交易和查询区块链数据。对于从链上返回的数据，IRISLCD可以独立验证数据的有效性。因此，它可以提供与全节点相同的安全性，同时对带宽，计算和存储资源的要求最低。此外，它还提供了swagger-ui，它详细描述了它提供的API以及如何使用它们。 + +## IRISLCD的用法 + +IRISLCD有两个子命令: + +| 子命令 | 功能 | 示例命令 | +| --------------- | --------------------------- | --------------- | +| version | 打印版本信息 | irislcd version | +| start | 启动一个IRISLCD节点 | irislcd start --chain-id= | + +`start`子命令有如下参数可配置 + +| 参数名称 | 类型 | 默认值 | 是否必填 | 功能描述 | +| --------------- | --------- | ----------------------- | -------- | ---------------------------------------------------- | +| chain-id | string | null | true | Tendermint节点的chain ID | +| home | string | "$HOME/.irislcd" | false | 配置home目录，key和proof相关的信息都存于此 | +| node | string | "tcp://localhost:26657" | false | 全节点的rpc地址 | +| laddr | string | "tcp://localhost:1317" | false | 侦听的地址和端口 | +| trust-node | bool | false | false | 是否信任全节点 | +| max-open | int | 1000 | false | 最大连接数 | +| cors | string | "" | false | 允许跨域访问的地址 | + +## 示例命令 + +1. 如果所连接的全节点是可信的，那么可以使能信任模式；如果不可行，那么要关闭信任模式。默认是非信任模式，打开信任模式的方法是加上`--trust-node`： +```bash +irislcd start --chain-id= --trust-node +``` + +2. 如果需要在其他机器上访问此IRISLCD节点，还需要配置`--laddr`参数，例如： +```bash +irislcd start --chain-id= --laddr=tcp://0.0.0.0:1317 +``` \ No newline at end of file diff --git a/docs/zh/features/lcd.md b/docs/zh/features/lcd.md new file mode 100644 index 000000000..fc2ee7082 --- /dev/null +++ b/docs/zh/features/lcd.md @@ -0,0 +1,114 @@ +# IRISLCD User Guide + +## Introduction + +## Basic Functionality Description + +1. Provide restful APIs and swagger-ui to show these APIs +2. Verify query proof + +## Usage Scenario + +Suppose an IRISLCD node is running and its swagger-ui page url is `localhost:1317/swagger-ui/`. The default home folder of irislcd is `$HOME/.irislcd`. Once an IRISLCD is started, firstly it will create key store in its home folder. If the IRISLCD is running in distrust mode, then ir will fetch the latest block as its trust basis and the trust basis will be saved to folder `trust-base.db` under its home folder. The IRISLCD node always trust the basis. It will verify all query proof against the trust basis, which means IRISLCD can only verify the proof on later height. However, this is also a defect of IRISLCD. When it tries to verify some transactions or blocks on lower height, it will report error. So if you want to query transactions or block on lower height, please start IRISLCD in trust mode. For detailed proof verification algorithm please refer to this [document](https://github.com/tendermint/tendermint/blob/master/docs/tendermint-core/light-client-protocol.md). + +Once the IRISLCD node is started successfully, then you can open `localhost:1317/swagger-ui/` in your explorer and all restful APIs will be shown. + +1. Tendermint APIs, such as query blocks, transactions and validatorset + 1. `GET /node_info`: The properties of the connected node + 2. `GET /syncing`: Syncing state of node + 3. `GET /blocks/latest`: Get the latest block + 4. `GET /blocks/{height}`: Get a block at a certain height + 5. `GET /validatorsets/latest`: Get the latest validator set + 6. `GET /validatorsets/{height}`: Get a validator set a certain height + 7. `GET /txs/{hash}`: Get a Tx by hash + 8. `GET /txs`: Search transactions + 9. `POST /txs`: Broadcast Tx + +2. Key management APIs + + 1. `GET /keys`: List of accounts stored locally + 2. `POST /keys`: Create a new account locally + 3. `GET /keys/seed`: Create a new seed to create a new account with + 4. `GET /keys/{name}`: Get a certain locally stored account + 5. `PUT /keys/{name}`: Update the password for this account in the KMS + 6. `DELETE /keys/{name}`: Remove an account + 7. `GET /auth/accounts/{address}`: Get the account information on blockchain + +3. Create, sign and broadcast transactions + + 1. `POST /tx/sign`: Sign a transation + 2. `POST /tx/broadcast`: Broadcast a signed StdTx with amino encoding signature and public key + 3. `POST /txs/send`: Send non-amino encoding transaction + 4. `GET /bank/coin/{coin-type}`: Get coin type + 5. `GET /bank/balances/{address}`: Get the account information on blockchain + 6. `POST /bank/accounts/{address}/transfers`: Send coins (build -> sign -> send) + +4. Stake module APIs + + 1. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction + 2. `POST /stake/delegators/{delegatorAddr}/redelegate`: Submit redelegation transaction + 3. `POST /stake/delegators/{delegatorAddr}/unbond`: Submit unbonding transaction + 4. `GET /stake/delegators/{delegatorAddr}/delegations`: Get all delegations from a delegator + 5. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations`: Get all unbonding delegations from a delegator + 6. `GET /stake/delegators/{delegatorAddr}/redelegations`: Get all redelegations from a delegator + 7. `GET /stake/delegators/{delegatorAddr}/validators`: Query all validators that a delegator is bonded to + 8. `GET /stake/delegators/{delegatorAddr}/validators/{validatorAddr}`: Query a validator that a delegator is bonded to + 9. `GET /stake/delegators/{delegatorAddr}/txs` :Get all staking txs (i.e msgs) from a delegator + 10. `GET /stake/delegators/{delegatorAddr}/delegations/{validatorAddr}`: Query the current delegation between a delegator and a validator + 11. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}`: Query all unbonding delegations between a delegator and a validator + 12. `GET /stake/validators`: Get all validator candidates + 13. `GET /stake/validators/{validatorAddr}`: Query the information from a single validator + 14. `GET /stake/validators/{validatorAddr}/unbonding_delegations`: Get all unbonding delegations from a validator + 15. `GET /stake/validators/{validatorAddr}/redelegations`: Get all outgoing redelegations from a validator + 16. `GET /stake/pool`: Get the current state of the staking pool + 17. `GET /stake/parameters`: Get the current staking parameter values + +5. Governance module APIs + + 1. `POST /gov/proposal`: Submit a proposal + 2. `GET /gov/proposals`: Query proposals + 3. `POST /gov/proposals/{proposalId}/deposits`: Deposit tokens to a proposal + 4. `GET /gov/proposals/{proposalId}/deposits`: Query deposits + 5. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal + 6. `GET /gov/proposals/{proposalId}/votes`: Query voters + 7. `GET /gov/proposals/{proposalId}`: Query a proposal + 8. `GET /gov/proposals/{proposalId}/deposits/{depositor}`: Query deposit + 9. `GET /gov/proposals/{proposalId}/votes/{voter}`: Query vote + 10. `GET/gov/params`: Query governance parameters + +6. Slashing module APIs + 1. `GET /slashing/validators/{validatorPubKey}/signing_info`: Get sign info of given validator + 2. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator + +7. Distribution module APIs + + 1. `POST /distribution/{delegatorAddr}/withdrawAddress`: Set withdraw address + 2. `GET /distribution/{delegatorAddr}/withdrawAddress`: Query withdraw address + 3. `POST /distribution/{delegatorAddr}/withdrawReward`: Set withdraw address + 4. `GET /distribution/{delegatorAddr}/distrInfo/{validatorAddr}`: Query distribution information for a delegation + 5. `GET /distribution/{delegatorAddr}/distrInfos`: Query distribution information list for a given delegator + 6. `GET /distribution/{validatorAddr}/valDistrInfo`: Query withdraw address + +8. Query app version + + 1. `GET /version`: Version of irislcd + 2. `GET /node_version`: Version of the connected node + +## Options for post apis + +1. `POST /bank/accounts/{address}/transfers`: Send tokens (build -> sign -> send) +2. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction +3. `POST /stake/delegators/{delegatorAddr}/redelegate`: Submit redelegation transaction +4. `POST /stake/delegators/{delegatorAddr}/unbond`: Submit unbonding transaction +5. `POST /gov/proposal`: Submit a proposal +6. `POST /gov/proposals/{proposalId}/deposits`: Deposit tokens to a proposal +7. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal +8. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator + +| Option name | Type | Default | Priority | Description | +| --------------- | ---- | ------- |--------- |--------------------------- | +| generate-only | bool | false | 0 | Build an unsigned transaction and write it back | +| simulate | bool | false | 1 | Ignore the gas field and perform a simulation of a transaction, but don’t broadcast it | +| async | bool | false | 2 | Broadcast transaction asynchronously | + +The above eight post APIs have three query options which are shown in the above table. By default, their values are all false. Each option has its unique priority( Here `0` is the top priority). If multiple options are enabled, then the options with lower priority will be ignored. For instance, if `generate-only` is true, then other options, such as `simulate` and `async` will be ignored. \ No newline at end of file From 3e757b09dae0df90915227b5f1f89b0343900459 Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Fri, 16 Nov 2018 16:44:35 +0800 Subject: [PATCH 048/100] Update description of --help --- docs/cli-client/keys/delete.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli-client/keys/delete.md b/docs/cli-client/keys/delete.md index e89d6c8c7..6d121621e 100644 --- a/docs/cli-client/keys/delete.md +++ b/docs/cli-client/keys/delete.md @@ -14,7 +14,7 @@ iriscli keys delete [flags] | Name, shorthand | Default | Description | Required | | --------------- | --------- | ------------------------------------------------------------ | -------- | -| --help, -h | | help for add | | +| --help, -h | | help for delete | | ## Examples @@ -34,4 +34,4 @@ After you enter the correct password, you're done with deleting your key. ```txt Password deleted forever (uh oh!) -``` \ No newline at end of file +``` From f809cb4e82fdca79ab824004af35e7a62185f946 Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Fri, 16 Nov 2018 16:45:19 +0800 Subject: [PATCH 049/100] Update description of --help --- docs/cli-client/keys/list.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli-client/keys/list.md b/docs/cli-client/keys/list.md index 83ca23029..cfdb078ed 100644 --- a/docs/cli-client/keys/list.md +++ b/docs/cli-client/keys/list.md @@ -15,7 +15,7 @@ iriscli keys list [flags] | Name, shorthand | Default | Description | Required | | --------------- | --------- | ------------------------------------------------------------ | -------- | -| --help, -h | | help for add | | +| --help, -h | | help for list | | ## Examples @@ -31,4 +31,4 @@ You'll get all the local public keys with 'address' and 'pubkey' element. NAME: TYPE: ADDRESS: PUBKEY: abc local faa1va2eu9qhwn5fx58kvl87x05ee4qrgh44yd8teh fap1addwnpepq02r0hts0yjhp4rsal627s2lqk4agy2g6tek5g9yq2tfrmkkehee2td75cs test local faa1kkm4w5pvmcw0e3vjcxqtfxwqpm3k0zakl7lxn5 fap1addwnpepq0gsl90v9dgac3r9hzgz53ul5ml5ynq89ax9x8qs5jgv5z5vyssskww57lw -``` \ No newline at end of file +``` From ee2aec406d0b9a902666b4680e5f88d68afd7e84 Mon Sep 17 00:00:00 2001 From: Harriet Cao Date: Fri, 16 Nov 2018 16:45:22 +0800 Subject: [PATCH 050/100] updated version --- docs/resources/whitepaper-en.md | 50 +++++++++++++++++---------------- 1 file changed, 26 insertions(+), 24 deletions(-) diff --git a/docs/resources/whitepaper-en.md b/docs/resources/whitepaper-en.md index a1916bd21..af42d73ee 100644 --- a/docs/resources/whitepaper-en.md +++ b/docs/resources/whitepaper-en.md @@ -1,8 +1,8 @@ # The IRIS Network **Inter-chain service infrastructure and protocol for building trustworthy and distributed business applications** -Harriet Cao harriet@bianjie.ai
-Haifeng Xi haifeng@bianjie.ai +Haifeng Xi haifeng@bianjie.ai
+Harriet Cao harriet@bianjie.ai _NOTE: If you can read this on GitHub, then we're still actively developing this document. Please check regularly for updates!_ @@ -883,50 +883,44 @@ Proceeds from the private sale of IRIS tokens will be used, first and foremost, The expected IRIS project is set out below. We reiterate that the roadmap is indicative only, and subject to change. -* **PANGU** (January 2018 \~ July 2018) The first stage of the IRIS project will focus on having the IRIS Hub up and running and connected to the Cosmos Hub. We also intend to release an initial version of the mobile client for the IRIS network. +* **PANGU** (January 2018 \~ March 2019) The first stage of the IRIS project will focus on having the IRIS Hub up and running. We also intend to release an initial version of the mobile client for the IRIS network. In this stage we also focus on building the fundamental IRIS Service Layer. This will involve enabling service definition, binding, invocation and query. We plan to collabrate with 1-2 ecosystem parteners to release i-Services to IRIShub. +* **NUWA** (April 2019 \~ December 2019) In this stage we are aiming to have a beta version of the IRIS SDK ready for developers. We plan to upgrade IRISnet mobile client to support i-Services. We plan to establish collabrations with application specific blockchains and enable them as zones connecting to IRIShub. We also plan to accomplish the connection with Cosmos Hub at this stage. + + +* **KUAFU** (Oct 2019 \~ Dec 2019) The third stage will focus on incremental upgrades to the IRIS network in order to support our planned advanced IRIS Service governance features. -* **NUWA** (July 2018 \~ November 2018) -The second stage will focus on building the fundamental IRIS Service Layer. This will involve enabling service definition, binding, invocation and query. -In this stage we are also aiming to have a beta version of the IRIS SDK ready for developers. -* **KUAFU** (December 2018 \~ May 2019) The third stage will focus on incremental upgrades to the IRIS network in order to support our planned advanced IRIS Service governance features. - - -* **HOUYI** (Beyond June 2019) +* **HOUYI** (Beyond January 2020) The fourth stage will focus on further technology innovations to the IRIS network, IRIS SDK and mobile client, as well as developer engagement.
## The Team ################################################################ +**Bianjie AI** +is the core development team for the IRIS network, leveraging the team's experience established from building distributed applications. [Bianjie AI](https://www.bianjie.ai) is a Shanghai-based start-up established in 2016. It focuses on developing innovative products and solutions for healthcare and financial industries, using advanced Blockchain and AI technologies. Besides IRISnet, Bianjie's also building another core product --- `BEAN (Blockchain Edge Analytics Network)` BEAN (Blockchain Edge Analytics Network), which is a permission chain which delivers distributed data analytics services for privacy preserving healthcare data analysis and exchange using NLP and machine learning technologies. +**Bianjie AI** +is also the operation and service partner of Cosmos Network in China. + **Tendermint** (the team that developed the [Tendermint](https://www.tendermint.com) consensus engine and is currently building Cosmos), **Wancloud** (a subsidiary of [Wanxiang -Blockchain](http://www.wxblockchain.com) and **Bianjie AI** will work together to build the IRIS network's infrastructure. +Blockchain](http://www.wxblockchain.com) are strategic parteners working together with **Bianjie AI** building the IRIS network's infrastructure. Tendermint's intended role to give technical advice and development support to the IRIS project team in extending the Tendermint ABCI and the Cosmos IBC technologies. [Wancloud](https://www.wancloud.io) is envisaged as the key strategy partner to both the Cosmos and IRIS ecosystems, and we understand that it intends to participate in Cosmos and IRIS development across Asia. -**Bianjie AI** -will be the core development team for the IRIS network, leveraging the team's experience established from building distributed AI analytics services for healthcare data analysis and exchange. [Bianjie AI](https://www.bianjie.ai) is a Shanghai-based start-up established in 2016. It focuses on developing innovative products and solutions for healthcare and financial industries, using advanced Blockchain and AI technologies. One of Bianjie's core products, `BEAN (Blockchain Edge Analytics Network)` BEAN (Blockchain Edge Analytics Network), is a permission chain which delivers distributed data analytics services for privacy preserving healthcare data analysis and exchange using NLP and machine learning technologies. Bianjie AI is -currently extending `BEAN` capabilities to build the IRIS network. -**Bianjie AI** -is also the operation and service partner of Cosmos Network in China. +### Core Members + +**Haifeng Xi** +[Haifeng](https://www.linkedin.com/in/haifengxi/) is a senior technologist and entrepreneur. Haifeng has an M.S degree in ECE from the University of Maryland. Haifeng worked as CTO for Wanxiang Blockchain Wancloud before starting IRISnet project. He also worked as senior architect for two leading financial companies In US (Tudor Investment & RBS Sempra), then he came back to China worked in the capacity of CTO for three companies, one of which is NASDAQ listed (China Finance Online). -### Core Members **Harriet Cao** [Harriet](https://www.linkedin.com/in/harrietcao/) is the founder of Bianjie AI, which a Shanghai-based start-up focusing on building smart services for blockchain that enable trustworthy and efficient business collaborations using distributed AI technology. Harriet is an award-winning practitioner of data analytics and artificial intelligence technologies, and was the recipient of 2010 INFORMS Daniel H. Wagner Prize. Prior to establishing Bianjie AI, Harriet worked for IBM Research for more than 16 years in various capacities including Director of IBM Research Shanghai Lab and Big Data Analytics Leader for IBM Global Labs. Harriet has an M.S degree in Robotics from Carnegie Mellon University and an M.S. degree in Automation Control from Tsinghua University. - -**Haifeng Xi** - -[Haifeng](https://www.linkedin.com/in/haifengxi/) is a senior technologist and entrepreneur. Since returning to China from the United States in 2009, he had worked in the capacity of Chief Technology Officer for three companies, one of which is NASDAQ listed. He also co-founded two start-ups in Shanghai, where he plays an active role of technical leader and engineering champion. -Haifeng has a Master's degree in Electrical and Computer Engineering from the University of Maryland, and a Master's and Bachelor's degree in Automatic Control from Tsinghua University. - - **Jae Kwon** After graduating from Cornell in 2005 with an undergraduate degree in computer science, [Jae](https://www.linkedin.com/in/yjkwon/) worked as a software developer in Silicon Valley, first at Amazon (where he worked on the Alexa digital assistant), then later at Yelp, where he led their mobile app development team. @@ -943,6 +937,10 @@ Tom has been tracking trends in the blockchain, cloud computing, IoT and smart m ### Advisors +**Dr. Shuo Bai** + +Dr. Bai is the director of ChinaLedger Technical Committee, and former Chief Architect of Shanghai Stock Exchange. He is a senior blockchain professional who graduated from Peking University with doctorate of science. He worked in various capacities including researcher, doctoral student advisor, director of software department, and chief scientist in the Institute of Computing Technology, Chinese Academy of Sciences. He also led the establishment of China National Internet Emergency Center (CNCERT/CC) since 2000. Dr. Bai has rich experiences in theoretical research and technical practices in the fields of financial exchanges, consortium and public blockchains. + **Jim Yang** [Jim Yang](https://www.linkedin.com/in/jimyang/) runs Strategy for Tendermint. He was the founder and CEO at ChatX, mobile messaging studio. ChatX developed various mobile messaging/social apps. He also co-founded Identyx, where he served as CEO until its acquisition by Red Hat. Identyx developed an open source enterprise identity management software. @@ -959,6 +957,10 @@ Tom has been tracking trends in the blockchain, cloud computing, IoT and smart m [Dr. Michael Yuan](http://www.michaelyuan.com) is the Director of the [CyberMiles Foundation](https://cm.5miles.com). Michael received a PhD in Astrophysics from University of Texas at Austin. He is the author of 5 books on software development, published by Prentice Hall, Addison-Wesley, and O'Reilly. Michael was an active code committer in large Open Source projects such as Firefox, Fedora, JBoss, and others. He is an expert on enterprise and mobile software, and was a Principle Investigator on multiple research projects funded by the US government. +**Yubo Ruan** + +[Yubo](https://www.linkedin.com/in/yubo-ruan/) is the founder of 8 Decimal Capital. The fund invested in IRISnet，0x、Kyber、Ontology、Fcoin、Zilliqa、ICON、Wanchian、Bibox、BiShiJie. Yubo is the co-founder of Skylight Investment, a boston based venture fund backed by New Oriental(NYSE:EDU). Previously, Yubo started two highly successful companies, including Alisimba (Acquired by TopHacker Group) held 4 national patents and won the 2017 AACYF 30 under 30, Silver Medal Winner, iENA International Inventions Competition, 2012. +
## References ################################################################ From 31a8c27be00a30d5d32debbc10149c6e5d471afb Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Fri, 16 Nov 2018 16:45:44 +0800 Subject: [PATCH 051/100] Update description of --help --- docs/cli-client/keys/mnemonic.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli-client/keys/mnemonic.md b/docs/cli-client/keys/mnemonic.md index da5728e28..91f83e8d6 100644 --- a/docs/cli-client/keys/mnemonic.md +++ b/docs/cli-client/keys/mnemonic.md @@ -14,7 +14,7 @@ iriscli keys mnemonic [flags] | Name, shorthand | Default | Description | Required | | ---------------- | --------- | ----------------------------------------------------------------------------- | -------- | -| --help, -h | | help for add | | +| --help, -h | | help for mnemonic | | | --unsafe-entropy | | Prompt the user to supply their own entropy, instead of relying on the system | | ## Examples @@ -29,4 +29,4 @@ You'll get a bip39 mnemonic with 24 words. ```txt police possible oval milk network indicate usual blossom spring wasp taste canal announce purpose rib mind river pet brown web response sting remain airport -``` \ No newline at end of file +``` From c363a52c26c7814f523675e748ef9670a2bf683b Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Fri, 16 Nov 2018 16:46:45 +0800 Subject: [PATCH 052/100] Update description of --help --- docs/cli-client/keys/new.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli-client/keys/new.md b/docs/cli-client/keys/new.md index 6e36fc5c2..0a82f3cfc 100644 --- a/docs/cli-client/keys/new.md +++ b/docs/cli-client/keys/new.md @@ -19,7 +19,7 @@ iriscli keys new [flags] | --------------- | ----------------- | --------------------------------------------------------------- | -------- | | --bip44-path | 44'/118'/0'/0/0 | BIP44 path from which to derive a private key | | | --default | | Skip the prompts and just use the default values for everything | | -| --help, -h | | help for add | | +| --help, -h | | help for new | | | --ledger | | Store a local reference to a private key on a Ledger device | | ## Examples @@ -59,4 +59,4 @@ Also you could hit enter to skip it, then you'll receive a hint to enter a passw > Repeat the passphrase: ``` -After that, you're done with creating a new key. \ No newline at end of file +After that, you're done with creating a new key. From 4a781a426fef6bc4f456091a7f7d27d98f14d679 Mon Sep 17 00:00:00 2001 From: Harriet Cao Date: Fri, 16 Nov 2018 16:47:04 +0800 Subject: [PATCH 053/100] updated with new version --- docs/resources/whitepaper-zh.md | 56 +++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 24 deletions(-) diff --git a/docs/resources/whitepaper-zh.md b/docs/resources/whitepaper-zh.md index 661f69bfd..084e63eba 100644 --- a/docs/resources/whitepaper-zh.md +++ b/docs/resources/whitepaper-zh.md @@ -2,7 +2,9 @@ **用于构建可信分布式商业应用的跨链服务基础设施及协议** -Harriet Cao harriet@bianjie.ai
Haifeng Xi haifeng@bianjie.ai +Haifeng Xi haifeng@bianjie.ai
+Harriet Cao harriet@bianjie.ai + _NOTE:如果你可以在GitHub上阅读，那么我们仍然在积极完善这个文档。 请定期检查更新!_
@@ -37,7 +39,7 @@ _NOTE:如果你可以在GitHub上阅读，那么我们仍然在积极完善这 本文所设想的IRIS网络尚在开发中，并将不断更新，这些更新包括但不限于关键治理和关键技术。 开发使用IRIS通证或与之相关的测试平台（软件）以及技术，可能无法实现或无法完全实现本白皮书所述的目标。 -如果IRIS网络得以完成，可能与本文所述有所不同。本文不对未来的任何计划、预测或前景的成功性或者合理性做出陈述或保证，本文的任何内容都不应被视为对未来的承诺或陈述。 +如果IRIS网络得以完成，可能与本文所述有所不同。本文不对未来的任何计划、预测或前景的成功性或者合理性做出陈述或保证，本文的任何内容都不应被视为对未来的承诺或陈述。 ### 并非监管类产品的要约 @@ -113,13 +115,13 @@ Cosmos[[3]]想要建立“区块链的互联网”。 这是由许多被称为 Tendermint提供了一个高性能、一致的、安全的BFT共识引擎，严格的分叉问责保证能够控制作恶者的行为。Tendermint非常适合用于扩展异构区块链，包括公有链以及注重的性能的许可链/联盟链，像Ethermint [[6]]就是一次对Ethereum以太坊POS机制的快速实现。 使用Tendermint在许可/联盟链域中的成功案例包括Oracle [[7]]，CITA [[8]] 和Hyperledger Burrow [[9]]。 -Tendermint作为共识协议用于在Cosmos Hub上构建第一个分区。Cosmos Hub可以连接到许多不同类型的分区，并且通过一种相当于区块链之间的虚拟UDP或TCP的IBC协议（ Inter-blockchain Communication，IBC）实现跨链通信。 通证可以安全地通过Cosmos Hub从一个分区转移到另一个分区，而不需要在分区之间的交易所或受信任的第三方。 +Tendermint作为共识协议用于在Cosmos Hub上构建第一个分区。Cosmos Hub可以连接到许多不同类型的分区，并且通过一种相当于区块链之间的虚拟UDP或TCP的IBC协议（ Inter-blockchain Communication，IBC）实现跨链通信。 通证可以安全地通过Cosmos Hub从一个分区转移到另一个分区，而不需要在分区之间的交易所或受信任的第三方。 为了使用Cosmos Hub开发强大的可互操作区块链和区块链应用，Cosmos SDK提供了区块链常用模块的开发“入门套件”，而不是限制可实现的用户故事，从而为应用定制提供了最大的灵活性。 ### IRIS 技术创新 -IRIS网络的目标是为构建分布式商业应用提供技术基础设施，它超越了主要用于数字资产的现有区块链系统。 +IRIS网络的目标是为构建分布式商业应用提供技术基础设施，它超越了主要用于数字资产的现有区块链系统。 我们打算通过IRIS网络解决的关键挑战在于两个方面： - 利用分布式账本支持链下运算资源的集成和协同 @@ -151,13 +153,13 @@ IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定 1. **服务消费者** 服务消费者是通过向网络发送请求并接收响应来使用链下服务的用户。 -2. **服务提供者** 服务提供者是那些可能提供一个或多个iService定义的用户，并且通常是其它公有链和联盟链甚至传统企业应用系统中链下服务和资源之间的适配器。服务提供者监听和处理传入的请求，并将结果发送回网络。一个服务提供者可以向其它服务提供者发送请求而同时成为服务消费者。服务提提供者可以按计划为他们提供的任何服务收取费用，默认情况下服务费使用IRIS网络的原生费用通证“IRIS”定价；也可以在适当的时候考虑使用Cosmos白名单中的其他费用通证对服务定价。 +2. **服务提供者** 服务提供者是那些可能提供一个或多个iService定义的用户，并且通常是其它公有链和联盟链甚至传统企业应用系统中链下服务和资源之间的适配器。服务提供者监听和处理传入的请求，并将结果发送回网络。一个服务提供者可以向其它服务提供者发送请求而同时成为服务消费者。服务提供者可以按计划为他们提供的任何服务收取费用，默认情况下服务费使用IRIS网络的原生费用通证“IRIS”定价；也可以在适当的时候考虑使用Cosmos白名单中的其他费用通证对服务定价。 3. **分析员** 分析员是一种特殊用户，代表了发起建立IRIS网络的IRIS基金会有限公司（IRIS Foundation Limited），这是一家注册在香港的股份有限公司。分析员是在分析模式中调用iServices的唯一授权用户，旨在帮助创建和维护服务提供者的概要文件，通过这些客观的概要文件服务消费者可以选择合适的服务提供者。 ### IRIS 服务 -在本节中，我们列出了在IRS网络上部署iService时预计使用的技术参数。 +在本节中，我们列出了在IRIS网络上部署iService时预计使用的技术参数。 **服务定义** @@ -167,7 +169,7 @@ IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定 * `Name (string)`: iService中该方法的唯一名称 * `Description (string)`: 对该方法的描述 * `Input (string)`: 对输入参数的结构化定义 -* `Output (string)`: 对输出结果的结构化定义 +* `Output (string)`: 对输出结果的机构化定义 * `Error (string)`: 对可能出现的错误条件的结构化定义 * `OutputPrivacy (enum)`: 设置此方法是非隐私的还是公钥加密的，可选值`NoPrivacy`/`PubKeyEncryption` @@ -333,7 +335,7 @@ IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定 **查询** -上述所有与服务生命周期相关的对象都可以使用ABCI 'Query'接口[\[3\]]查询到。这些查询将通过'Query'连接执行，并不参与共识过程。我们已经看到了如何得到的`GetServiceRequest`和得到`GetServiceResponse`查询作为服务调用过程的一部分。 +上述所有与服务生命周期相关的对象都可以使用ABCI 'Query'接口[\[3\]]查询到。这些查询将通过'Query'连接执行，并不参与共识过程。我们已经看到了如何得到的`GetServiceRequest`和得到`GetServiceResponse`查询作为服务调用过程的一部分。 上面描述的所有与服务相关的生命周期对象都可以使用ABCI查询接口3来查询。 以下是我们目前计划的查询的一个非详尽的摘要： @@ -430,7 +432,7 @@ IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定 ### 分布式人工智能用于隐私保护下的数据分析 -这个用例的服务基础架构已由位于上海的初创公司`边界智能`进行了原型设计，并将其应用到联盟链产品`BEAN (BlockchainEdge Analytics Network)`中，用于解决长期已来为运行分析模型获取数据的挑战。尽管同态加密是允许通过加密数据实现计算的关键方法之一，但由于性能低下，实际上无法解决现实世界的机器学习问题。因此，BEAN的创建提供了另一种解决方案--利用传统的分布式人工智能研究[[14]]中的模型并行性和SOA设计模式，作为区块链的附加层开发分布式分析服务。 +这个用例的服务基础架构已由位于上海的科技创业公司`边界智能`进行了原型设计，并将其应用到联盟链产品`BEAN (BlockchainEdge Analytics Network)`中，用于解决长期已来为运行分析模型获取数据的挑战。尽管同态加密是允许通过加密数据实现计算的关键方法之一，但由于性能低下，实际上无法解决现实世界的机器学习问题。因此，BEAN的创建提供了另一种解决方案--利用传统的分布式人工智能研究[[14]]中的模型并行性和SOA设计模式，作为区块链的附加层开发分布式分析服务。 为了保护数据存取，运行在数据端的（部分）模型需要开放给客户端，并在服务定义中说明。由于只有部分模型开放给客户端，模型开发人员不必担心有人窃取他们的想法；同样，数据拥有者永远不需要担心失去对其数据使用的控制，因为数据不会离开他们的数据源。 @@ -522,37 +524,35 @@ IRIS网络旨在支持所有来自Cosmos网络白名单中的费用通证，例 预期的IRIS项目路线图如下。这里我们重申一下，路线图只是一个大概方向，将来根据项目实施会有变化。 -- **盘古**（2018年1月~2018年7月）：IRIS项目的第一阶段，将集中在构建和运行IRIS Hub以及与Cosmos Hub的交互。同时，我们将发布一个初始版本的IRIS网络移动客户端。 +- **盘古**（2018年1月~2019年3月）：IRISnet项目的第一阶段，我们专注于构建并启动 IRISnet 主网（Hub）。同时，我们将发布一个初始版本的IRIS网络移动客户端。我们也将建立 IRISnet 基本服务层： 升级网络以实现服务定义、绑定、调用和查询; 并实现支持1-2两个生态伙伴发布i-Services到跨链枢纽。 -- **女娲**   (2018年7月~2018年11月)：第二阶段主要集中在构建IRIS Service Layer。这将涉及启用服务定义、绑定、调用和查询。在这个阶段，我们也打算为开发者准备一个beta版的IRIS SDK。 +- **女娲** (2019年4月~2019年9月)：第二阶段将为开发者准备了beta版的IRIS SDK，并升级移动客户端以支持服务; 与应用专有链项目形成战略联盟，支持它们作为分区连接到IRIS枢纽。IRISnet 也在第二阶段完成和 Cosmos Hub 的链接，打通和以太坊生态的链接。 -- **夸父** （2018年12月~2019年5月）：第三阶段主要专注于IRIS网络的增量升级，以支持我们计划中先进的IRIS Service治理特性。 +- **夸父**（2019年10月~2019年12月）：第三阶段主要专注于完成IRIS网络的增强功能，升级网络以支持复杂的IRIS服务管理功能，例如：分析和争议解决; 不断完善SDK和手机客户端; 加速拓展网络，连接更多的分区，整合更多的服务提供商。 -- **后裔** （2019年6月之后）：第四阶段专注在IRIS网络、IRIS SDK和移动客户端的技术创新，以及开发者的参与。 +- **后羿** (2020年1月之后）：第四阶段通过不懈的技术创新，完善的社区建设和可持续的开发者支持以实现分布式商业生态系统。 -
-## 团队 -**Tendermint** (该团队开发了 [Tendermint](https://www.tendermint.com)共识引擎，当前正在开发Cosmos), **Wancloud万云** ( [万向区块链](http://www.wxblockchain.com) 子公司)和 **边界智能** 将共同构建IRIS网络的基础设施。 +## 团队 -Tendermint将在扩展Tendermint ABCI和Cosmos IBC技术方面，为IRIS项目团队提供技术咨询和开发支持。[Wancloud万云](https://www.wancloud.io) 将是Cosmos和IRIS生态系统的关键战略合作伙伴，它将积极参与Cosmos和IRIS在亚太地区的开发和发展。 +边界智能是IRIS网络的核心开发团队。边界智能是一家于2016年在上海成立的技术创新公司，具有区块链、人工智能等方面的核心竞争力。边界智能基于服务架构构建复杂商业区块链应用获得了客户（包括复星健康云、宁夏医疗大数据平台和民生保险等），研究机构以及中国国家级创新大赛的认可 ：在2018第七届中国创新创业大赛全国总决赛上进入成长组32强并获得优秀企业奖，荣获2018年度上海市科技型中小企业技术创新资金资助；2018年8月25日获国家队组织的2018年中国健康医疗大数据创新大赛TMT数据组一等奖，天使之星组冠军，同时，**边界智能**从2017年起就是Cosmos网络在中国的运营和服务合作伙伴。 -边界智能将是IRIS网络的核心开发团队，IRIS充分借助团队创建分布式智能分析服务的经验，实现医疗数据分析与交换。边界智能是一家于2016年在上海成立的初创公司，专注于利用先进的区块链技术和人工智能技术为医疗和金融行业开发创新产品和提供解决方案。边界智能中的一个核心产品`BEAN`（区块链智能信息边缘分析网络Blockchain Edge Analytics Network）是一条许可链，它利用自然语言分析及机器学习技术为隐私保护、医疗健康数据的分析和交换提供分布式智能分析服务。边界智能正不断扩展`BEAN`功能来构建IRIS网络，同时，**边界智能**也是Cosmos网络在中国的运营和服务合作伙伴。 +**Tendermint** (该团队开发了 [Tendermint](https://www.tendermint.com)共识引擎，当前正在开发Cosmos) 也在扩展Tendermint ABCI和Cosmos IBC技术方面，为IRIS项目团队提供技术咨询和开发支持。[Wancloud万云](https://www.wancloud.io) 将是Cosmos和IRIS生态系统的关键战略合作伙伴，它将积极参与Cosmos和IRIS在亚太地区的开发和发展。 ### 核心成员 -**曹恒** +**Haifeng Xi** -[曹恒](https://www.linkedin.com/in/harrietcao/) 是边界智能的创始人，该公司是一家成立于上海的初创公司。边界智能专注于利用分布式AI技术为区块链提供智能化服务，支持可信高效的行业协作。曹恒是曾获得过2010年美国运筹学和管理学研究协会（INFORMS）颁发的数据分析和人工智能技术领域的“Daniel H. Wagner”大奖。在创立边界智能之前，曹恒在IBM 研究院工作16年，曾担任IBM研究院上海研究院院长，是前IBM全球研究院大数据分析技术带头人。曹恒拥有卡耐基梅隆大学机器人硕士学位和清华大学自动化控制学士学位。 +[Haifeng](https://www.linkedin.com/in/haifengxi/) 是边界智能的联合创始人，他是高级区块链技术专家和企业家。他先后获得了清华大学自动化控制学士、硕士学位和美国马里兰大学电子与计算机工程硕士学位。他曾在美国排名前20的对冲基金(Tudor Investment) 和全球大宗商品交易公司集团(RBS Sempra)担任主管架构师和软件开发经理。自2009年归国以来，他先后在三家公司担任首席技术官CTO，其中一家是纳斯达克上市公司。他还在上海联合创立过两家初创公司，并领导技术研发。在领导边界智能之前，奚海峰先生还担任了万向区块链股份公司旗下万云平台的CTO。 -**奚海峰** +**Harriet Cao** -[奚海峰](https://www.linkedin.com/in/haifengxi/) 是高级技术专家和企业家。自2009年从美国归国以来，他曾在三家公司担任首席技术官，其中一家是纳斯达克上市公司。他还在上海联合创立过两家初创公司，并在那里担当技术和工程学的领导角色。奚海峰拥有马里兰大学电子与计算机工程硕士学位，以及清华大学自动化控制硕士和学士学位。 +[Harriet](https://www.linkedin.com/in/harrietcao/) 是边界智能的联合创始人，该公司是一家成立于上海的高科技公司。边界智能专注于利用分布式AI技术为区块链提供智能化服务，支持可信高效的行业协作。曹恒曾获得过2010年美国运筹学和管理学研究协会（INFORMS）颁发的 “Daniel H. Wagner”大奖。在创立边界智能之前，曹恒在IBM 研究院工作16年，曾担任IBM研究院上海研究院院长，是前IBM全球研究院大数据分析技术带头人。曹恒拥有卡耐基梅隆大学机器人硕士学位和清华大学自动化控制学士学位。 **Jae Kwon** -2005年，[Jae](https://www.linkedin.com/in/yjkwon/)毕业于康奈尔大学计算机科学学士学位后，曾在硅谷担任软件开发工程师，起先在亚马逊从事Alexa开发工作，后来在Yelp带领移动应用开发团队。Jae在认识到区块链问题后，开发了Tendermint BFT共识算法和Tendermint Core共识引擎。Tendermint是第一个可信的PoS算法。 除了开发Tendermint之外，Jae还是Cosmos的创始人之一。 +2005年，[Jae](https://www.linkedin.com/in/yjkwon/)是最具技术前瞻性的跨链项目Cosmos的创始人，也是著名开源区块链项目Tendermint的创始人。Jae 毕业于康奈尔大学计算机科学专业，曾在美国硅谷Alexa/亚马逊（Amazon）等公司担任软件开发工程师，后在Yelp带领移动应用开发团队。Jae也是早期比特币网络开发人员，为解决比特币bug，Jae创建了Tendermint BFT共识算法和Tendermint Core区块链引擎，以在POW之外，创建一个可靠的POS算法。 **陶曲明** @@ -561,6 +561,10 @@ Tendermint将在扩展Tendermint ABCI和Cosmos IBC技术方面，为IRIS项目 ### 顾问 +**白硕** + +白硕博士是ChinaLedger技术委员会主任，原上海证券交易所总工程师，他是资深的区块链技术专家。他毕业于北京大学，获理学博士，曾任中科院计算所研究员、博士生导师、软件室主任、软件方向首席科学家。2000年起参与组建国家计算机网络应急技术协调中心（CNCERT/CC）。白硕先生在区块链领域拥有极为丰富的理论研究及技术实践，在金融交易所、联盟链、跨链技术领域都有非常深入的理解。 + **Jim Yang** [Jim Yang](https://www.linkedin.com/in/jimyang/) 是Tendermint首席运营官。 他是ChatX移动信息工作室的创始人兼首席执行官。 ChatX开发了各种移动消息/社交应用程序。 他还共同创立了Identyx并一直担任CEO至被Red Hat收购。 Identyx开发一个开源企业身份管理软件。 @@ -577,9 +581,13 @@ Tendermint将在扩展Tendermint ABCI和Cosmos IBC技术方面，为IRIS项目 [Dr. Michael Yuan](http://www.michaelyuan.com) 博士是 [CyberMiles Foundation](https://cm.5miles.com)基金会的负责人。Michael在德克萨斯大学奥斯汀分校获得了天体物理学博士学位。 他编写的5本关于软件开发的书已由Prentice Hall，Addison-Wesley和O'Reilly出版。 Michael是Firefox，Fedora，JBoss等大型开源项目中的活跃代码提交者。 他是企业应用软件和移动软件方面的专家，也是参与了多个由美国政府资助的研究项目。 +**阮宇博** + +[阮宇博](https://www.linkedin.com/in/yubo-ruan/)，天使投资人和基金管理者，八维资本8 Decimal Capital创始人，基金投资了IRISnet,0x、Kyber、本体、Fcoin、Zilliqa、ICON、Wanchian、Bibox、币世界等区块链公司，也是Bluzelle和Gifto顾问；宇博是Skylight Investment的Co-founder，基金投资了20多家优秀的科技公司和金融科技企业。阮宇博有多年企业创办和管理经验，原阿里辛巴CEO，全视之眼创始人，有成功退出经历，获得过全美华裔30位30岁以下优秀创业者。他还是杰出科技人才，有拥有13项国际科技大奖和5项国家专利。Silver Medal Winner, iENA International Inventions Competition, 2012。 +
-## 参考文献 +## 参考文献################################################################### [1]: https://drive.google.com/file/d/1bI7JIOe-CfJ5fPHKxYlFub2Kg-KCGU6r/view?usp=sharing [2]: http://ethdocs.org/en/latest/ From 4d856877f84c2f1144b6184e90d131fc370c0901 Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Fri, 16 Nov 2018 16:47:51 +0800 Subject: [PATCH 054/100] Update description of --help --- docs/cli-client/keys/show.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli-client/keys/show.md b/docs/cli-client/keys/show.md index ea4c2a84a..75860c5e8 100644 --- a/docs/cli-client/keys/show.md +++ b/docs/cli-client/keys/show.md @@ -16,7 +16,7 @@ iriscli keys show [flags] | -------------------- | ----------------- | -------------------------------------------------------------- | -------- | | --address | | output the address only (overrides --output) | | | --bech | acc | [string] The Bech32 prefix encoding for a key (acc|val|cons) | | -| --help, -h | | help for add | | +| --help, -h | | help for show | | | --multisig-threshold | 1 | [uint] K out of N required signatures | | | --pubkey | | output the public key only (overrides --output) | | @@ -33,4 +33,4 @@ You'll get the local public keys with 'address' and 'pubkey' element of a given ```txt NAME: TYPE: ADDRESS: PUBKEY: MyKey local faa1kkm4w5pvmcw0e3vjcxqtfxwqpm3k0zakl7lxn5 fap1addwnpepq0gsl90v9dgac3r9hzgz53ul5ml5ynq89ax9x8qs5jgv5z5vyssskww57lw -``` \ No newline at end of file +``` From e9e587518fe3122872a69e5a50e28d9e30fa2422 Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Fri, 16 Nov 2018 16:48:18 +0800 Subject: [PATCH 055/100] Update description of --help --- docs/cli-client/keys/update.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli-client/keys/update.md b/docs/cli-client/keys/update.md index 9eac11398..eac14aff4 100644 --- a/docs/cli-client/keys/update.md +++ b/docs/cli-client/keys/update.md @@ -14,7 +14,7 @@ iriscli keys update [flags] | Name, shorthand | Default | Description | Required | | --------------- | --------- | ------------------------------------------------------------ | -------- | -| --help, -h | | help for add | | +| --help, -h | | help for udpate | | ## Examples @@ -41,4 +41,4 @@ It will be done if you enter a new password that meets the criteria. ```txt Password successfully updated! -``` \ No newline at end of file +``` From 58a4d77914da68bf3eada7f6d063879517377474 Mon Sep 17 00:00:00 2001 From: kidinamoto01 Date: Fri, 16 Nov 2018 17:16:39 +0800 Subject: [PATCH 056/100] =?UTF-8?q?IRISHUB-679=EF=BC=9AAdd=20resources=20&?= =?UTF-8?q?=20get=20started?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/get-started/Download-Rainbow.md | 9 +- docs/get-started/Full-Node.md | 85 +++++++++++ .../get-started/Genesis-Generation-Process.md | 89 ++++++++++++ docs/get-started/Install-Iris.md | 124 ---------------- docs/get-started/Install-the-Software.md | 124 +++++++++++++++- docs/get-started/Join-the-Testnet.md | 50 ++++++- docs/get-started/README.md | 45 ++++++ docs/get-started/Validator-Node.md | 133 ++++++++++++++++++ docs/zh/get-started/Download-Rainbow.md | 8 +- docs/zh/get-started/Full-Node.md | 108 ++++++++++++++ .../get-started/Genesis-Generation-Process.md | 81 +++++++++++ docs/zh/get-started/Install-the-Software.md | 117 ++++++++++++++- docs/zh/get-started/Join-the-Testnet.md | 53 ++++++- docs/zh/get-started/README.md | 50 +++++++ docs/zh/get-started/Validator-Node.md | 127 +++++++++++++++++ 15 files changed, 1065 insertions(+), 138 deletions(-) create mode 100644 docs/get-started/Full-Node.md create mode 100644 docs/get-started/Genesis-Generation-Process.md delete mode 100644 docs/get-started/Install-Iris.md create mode 100644 docs/get-started/Validator-Node.md create mode 100644 docs/zh/get-started/Full-Node.md create mode 100644 docs/zh/get-started/Genesis-Generation-Process.md create mode 100644 docs/zh/get-started/Validator-Node.md diff --git a/docs/get-started/Download-Rainbow.md b/docs/get-started/Download-Rainbow.md index dd91119ee..06f225a0b 100644 --- a/docs/get-started/Download-Rainbow.md +++ b/docs/get-started/Download-Rainbow.md @@ -1,5 +1,8 @@ -# IRISnet Testnet Codename Fuxi +# IRISnet Mobile Client: Rainbow -## What is IRISnet +## What is Raibow -IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. +First IRISnet mobile client that supports cross-chain +multi-asset transfers and iServices consumption + +https://www.rainbow.one \ No newline at end of file diff --git a/docs/get-started/Full-Node.md b/docs/get-started/Full-Node.md new file mode 100644 index 000000000..419a56454 --- /dev/null +++ b/docs/get-started/Full-Node.md @@ -0,0 +1,85 @@ +# Setup A Full-node + +Before setting up your validator node, make sure you already had **Iris** installed by following this [guide](Install-Iris.md) + +## Init Your Node + +These instructions are for setting up a brand new full node from scratch. + +First, initialize the node and create the necessary config files: + +``` +iris init --name= --home=$IRISHOME +``` + +> Note: Only ASCII characters are supported for the `--name`. Using Unicode characters will render your node unreachable. + +The default \$IRISHOME is `~/.iris` , You can edit this `name` later, in the `~/.iris/config/config.toml` file: + +Your full node has been initialized! + +## Get Configuration Files + + +After intializing your node, please download the genesis file and the config file to join in the testnet. + +``` +cd $IRISHOME/config/ +rm genesis.json +rm config.toml +wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/config.toml +wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/genesis.json +``` +## Edit Your Config File + +You could customized the `moniker` and `external_address` fields. + +``` +# A custom human readable name for this node +moniker = "" +external_address = "your-public-IP:26656" +``` + + +Optional: +Set `addr_book_strict` to `false` to make peering more easily. + +``` +addr_book_strict = false +``` + + +### Add Seed Nodes + +Your node needs to know how to find more peers. You'll need to add healthy seed nodes to `$IRISHOME/config/config.toml`. Here are some seed nodes you can use: + +``` +c16700520a810b270206d59f0f02ea9abd85a4fe@ts-1.bianjie.ai:26656 +a12cfb2f535210ea12731f94a76b691832056156@ts-2.bianjie.ai:26656 +``` + +Meanwhile, you could add some known full node as `Persistent Peer`. Your node could connect to `sentry node` as `persistent peers`. + + +### Enable Port + +You will need to set `26656` port to get connected with other peers and `26657` to query information of Tendermint. + +## Run a Full Node + +Start the full node with this command: + +``` +iris start --home=$IRISHOME > iris.log +``` + +Check that everything is running smoothly: + +``` +iriscli status +``` +You could see the following +``` +{"node_info":{"id":"1c40d19d695721fc3e3ce44cbc3f446f038b36e4","listen_addr":"172.31.0.190:46656","network":"iris-stage-4","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:46657"]},"sync_info":{"latest_block_hash":"41117D8CB54FA54EFD8DEAD81D6D83BDCE0E63AC","latest_app_hash":"95D82B8AC8B64C4CD6F85C1D91F999C2D1DA4F0A","latest_block_height":"1517","latest_block_time":"2018-09-07T05:44:27.810641328Z","catching_up":false},"validator_info":{"address":"3FCCECF1A27A9CEBD394F3A0C5253ADAA8392EB7","pub_key":{"type":"tendermint/PubKeyEd25519","value":"wZp1blOEwJu4UuqbEmivzjUMO1UwUK4C0jRH96HhV90="},"voting_power":"100"}} +``` +If you see the `catching_up` is `false`, it means your node is fully synced with the network, otherwise your node is still downloading blocks. Once fully synced, you could upgrade your node to a validator node. The instructions is in [here](Validator-Node.md). \ No newline at end of file diff --git a/docs/get-started/Genesis-Generation-Process.md b/docs/get-started/Genesis-Generation-Process.md new file mode 100644 index 000000000..6c62ff68a --- /dev/null +++ b/docs/get-started/Genesis-Generation-Process.md @@ -0,0 +1,89 @@ +# How To Participate in Genesis Process + +## Requirements + +You must have follow this [guide](Install-Iris.md) to install the correct version of **Iris**. + +## Gentx + +Please run the `keys add` subcommand and run the `gen-tx` subcommand to generate files. + + +``` +iriscli keys add your_name +iris gentx --name=your_name --home= --ip=Your_public_IP +``` + +For example, + +``` +iriscli keys add alice +iris gentx --name=alice --home=iris --chain-id=irishub-stage --ip=1.1.1.1 +``` + +There will be a gentx-node-ID.json a file at `$IRISHOME/config/gentx/`. + +The content of the file will be: + +``` +{ + "type": "auth/StdTx", + "value": { + "msg": [ + { + "type": "cosmos-sdk/MsgCreateValidator", + "value": { + "Description": { + "moniker": "chenggedexiaokeai.local", + "identity": "", + "website": "", + "details": "" + }, + "Commission": { + "rate": "0.1000000000", + "max_rate": "0.2000000000", + "max_change_rate": "0.0100000000" + }, + "delegator_address": "faa1cf25tf4pfjdhkzx8lqnkajlse6jcpm2fyw4yme", + "validator_address": "fva1cf25tf4pfjdhkzx8lqnkajlse6jcpm2f3lltx7", + "pubkey": { + "type": "tendermint/PubKeyEd25519", + "value": "/JvLFsvyMgm2ND4QgN4JKyLxhL42dVgat67383Q+mPY=" + }, + "delegation": { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + } + } + ], + "fee": { + "amount": null, + "gas": "200000" + }, + "signatures": [ + { + "pub_key": { + "type": "tendermint/PubKeySecp256k1", + "value": "AtfNRj0zYvffAQG+iad6SScfdl29ag9G3EI0JDSwKJmy" + }, + "signature": "BwTejBceK4M+3LzmNl62jVFUr9wVv//UO7iI/yWi5KFoez9eY43HSlaZJf+3rnKLjosn2tD79EIw55BJ6SbYzQ==", + "account_number": "0", + "sequence": "0" + } + ], + "memo": "0eb02fdabb96923ac1e855ac012a5a624793264a@1.1.1.1:26656" + } +} +``` +This is the `CreateValidator` message. +validator is generated by \$IRISHOME/config/priv_validator.json + +## Submit Gentx + +Submit your `gentx-.json` to `https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-4000/config/gen-tx/` by createing a pull request. + +After the team has collected all the gen-tx transactions, we will publish the genesis file in the following folder: `https://github.com/irisnet/testnets/tree/master/testnets/fuxi-3001/config/` + +You could then download the final genesis file and start a node. + diff --git a/docs/get-started/Install-Iris.md b/docs/get-started/Install-Iris.md deleted file mode 100644 index bf871a7f0..000000000 --- a/docs/get-started/Install-Iris.md +++ /dev/null @@ -1,124 +0,0 @@ -# Install Iris - -### Step 1: Configure Your Server - -All the blockchains in IRISnet is based on Cosmos-SDK, which is a framework for building blockchain applications in Golang. It is being used to build [Cosmos Hub](https://cosmos.network/). It's recommended to run a validator node on Linux server. - -**Recommanded Configurations:** - -1. 2 CPU -2. Memory: 4GB -3. Disk: 60GB SSD -4. OS: Ubuntu 16.04 LTS -5. Allow all incoming connections on TCP port 26656 and 26657 - -### Step 2: Install Iris - -There are two ways to get Iris running on your server. You can download the binary files from our release pages, or you can download the source code and compile it locally. - -#### Download Binary Directly - -Go to the download page: - -https://github.com/irisnet/irishub/releases/ - -then get the release v0.6.0 on your computer. -`unzip -C /usr/local/bin iris$VERSION.$OS-$ARCH.zip` to `/usr/local/bin/ ` - -You can verify you have the right version installed by running the following commands: - -``` -$ iris version -v0.6.0 - -$ iriscli version -v0.6.0 -``` - -#### Compile Source Code - -- Install Go 1.10+ - -``` -$ sudo add-apt-repository ppa:gophers/archive -$ sudo apt-get update -$ sudo apt-get install golang-1.10-go -``` - -> Note that golang-1.10-go puts binaries in /usr/lib/go-1.10/bin. If you want them on your PATH, you need to make that change yourself. - -Using snaps also works quite well: - -``` -This will give you the latest version of go -$ sudo snap install --classic go -``` - -> A restart is required for the command to be recognized. - -Then you need to verify the versions of Go: - -``` -$ go version -go version go1.10.3 darwin/amd64 -``` - -Then, you need to add `GOPATH` to system `PATH` , then your system could correctly compile the code. - -Open your `.profile` in your home directory. Add the following lines at the end of file: - -``` -GOPATH=$HOME/go -PATH=$GOPATH/bin:$PATH -``` - -Save the file and exit the editor. Then run the following to make your bash reload your profile configurations. - -``` -$ source $HOME/.profile -``` - -Now you should see something like this if you echo your\$GOPATH and \$PATH variables - -``` -$ echo $GOPATH -/home/iris/go -$ echo $PATH -/home/isir/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin -``` - -- Get the code and compile Iris - -After setup Go correctly, you should be able to compile and run **Iris**. -Make sure that you can access to google.com for that our project used some libraries provided by google. -``` -mkdir -p $GOPATH/src/github.com/irisnet -cd $GOPATH/src/github.com/irisnet -git clone https://github.com/irisnet/irishub -cd irishub && git checkout v0.6.0 -curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh -make get_tools get_vendor_deps install -``` - -If your environment variables have set up correctly, you should not get any errors by running the above commands. -Now check your **Iris** version. - -``` -$ iris version -v0.6.0 -$ iriscli version -v0.6.0 -``` - -### How to Update - -Get latest code (you can also `git fetch` only the version desired), ensure the dependencies are up to date, then recompile. - -``` -cd $GOPATH/src/github.com/irisnet/irishub -git fetch -a origin -rm Gopkg.lock -git checkout v0.6.0 -make get_vendor_deps -make install -``` \ No newline at end of file diff --git a/docs/get-started/Install-the-Software.md b/docs/get-started/Install-the-Software.md index d9786f2a0..4e80d1861 100644 --- a/docs/get-started/Install-the-Software.md +++ b/docs/get-started/Install-the-Software.md @@ -1,2 +1,124 @@ -# IRISnet Testnet Codename Fuxi +# Install Iris +### Step 1: Configure Your Server + +All the blockchains in IRISnet is based on Cosmos-SDK, which is a framework for building blockchain applications in Golang. It is being used to build [Cosmos Hub](https://cosmos.network/). It's recommended to run a validator node on Linux server. + +**Recommanded Configurations:** + +1. 2 CPU +2. Memory: 4GB +3. Disk: 60GB SSD +4. OS: Ubuntu 16.04 LTS +5. Allow all incoming connections on TCP port 26656 and 26657 + +### Step 2: Install Iris + +There are two ways to get Iris running on your server. You can download the binary files from our release pages, or you can download the source code and compile it locally. + +#### Download Binary Directly + +Go to the download page: + +https://github.com/irisnet/irishub/releases/ + +then get the release v0.6.0 on your computer. +`unzip -C /usr/local/bin iris$VERSION.$OS-$ARCH.zip` to `/usr/local/bin/ ` + +You can verify you have the right version installed by running the following commands: + +``` +$ iris version +v0.6.0 + +$ iriscli version +v0.6.0 +``` + +#### Compile Source Code + +- Install Go 1.10+ + +``` +$ sudo add-apt-repository ppa:gophers/archive +$ sudo apt-get update +$ sudo apt-get install golang-1.10-go +``` + +> Note that golang-1.10-go puts binaries in /usr/lib/go-1.10/bin. If you want them on your PATH, you need to make that change yourself. + +Using snaps also works quite well: + +``` +This will give you the latest version of go +$ sudo snap install --classic go +``` + +> A restart is required for the command to be recognized. + +Then you need to verify the versions of Go: + +``` +$ go version +go version go1.10.3 darwin/amd64 +``` + +Then, you need to add `GOPATH` to system `PATH` , then your system could correctly compile the code. + +Open your `.profile` in your home directory. Add the following lines at the end of file: + +``` +GOPATH=$HOME/go +PATH=$GOPATH/bin:$PATH +``` + +Save the file and exit the editor. Then run the following to make your bash reload your profile configurations. + +``` +$ source $HOME/.profile +``` + +Now you should see something like this if you echo your\$GOPATH and \$PATH variables + +``` +$ echo $GOPATH +/home/iris/go +$ echo $PATH +/home/isir/go/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin +``` + +- Get the code and compile Iris + +After setup Go correctly, you should be able to compile and run **Iris**. +Make sure that you can access to google.com for that our project used some libraries provided by google. +``` +mkdir -p $GOPATH/src/github.com/irisnet +cd $GOPATH/src/github.com/irisnet +git clone https://github.com/irisnet/irishub +cd irishub && git checkout v0.6.0 +curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh +make get_tools && get_vendor_deps && make install +``` + +If your environment variables have set up correctly, you should not get any errors by running the above commands. +Now check your **Iris** version. + +``` +$ iris version +v0.6.0 +$ iriscli version +v0.6.0 +``` + +### How to Update + +Get latest code (you can also `git fetch` only the version desired), ensure the dependencies are up to date, then recompile. + +``` +cd $GOPATH/src/github.com/irisnet/irishub +git fetch -a origin +rm Gopkg.lock +git checkout v0.6.0 +make get_vendor_deps +make install +``` \ No newline at end of file diff --git a/docs/get-started/Join-the-Testnet.md b/docs/get-started/Join-the-Testnet.md index dd91119ee..52fccef53 100644 --- a/docs/get-started/Join-the-Testnet.md +++ b/docs/get-started/Join-the-Testnet.md @@ -1,5 +1,49 @@ -# IRISnet Testnet Codename Fuxi +IRISnet Testnet Codename Fuxi -## What is IRISnet +What is IRISnet -IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. +IRIS network (a.k.a. IRISnet) is named after Greek goddess Iris, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. + +How to Join Fuxi Testnet + +Step 1: Install Iris on Your Server + +Please follow this instruction to get Iris installed locally. + +Step 2: Run a Full Node + +Please follow this instruction to get your full node running. + +Step 3: Upgrade to Validator Node + +Please follow this instruction to upgrade your full node to validator node. + +Deploy IRISHub Monitor + +Please follow this guide to get IRIHub monitor running on your side. + +Upgrade to Validator Node + +You now have an active full node. What's the next step? + +If you have participated in the genesis file generation process, you should be a validator once you are fully synced. + +If you miss the genesis file generation process, you can still upgrade your full node to become a IRISnet Validator. The top 100 validators have the ability to propose new blocks to the IRIS Hub. Continue onto the Validator Setup. + +Setup a sentry node + +A validator is under the risk of being attacked. You could follow this guide to setup a sentry node to protect yourself. + +Fuxi Incentivized Testnet + +IRIS foundation plans to reward all the testnet participants who took part in the testnet. In Fuxi-3001 testnet,the community members have finished the tasks and they will receive their rewards in genesis allocation. + +- Task List for Fuxi-3001： https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-3001/README.md +- Results：https://github.com/irisnet/testnets/issues/125 + To get more people involved, IRIS foundation decides to send out more tasks in the latest iteration of testnet:Fuxi-4001. +- Task List for Fuxi-4000: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-4000/README.md + +Useful Links + +- Riot chat: #irisvalidators:matrix.org +- Explorer: https://testnet.irisplorer.io/#/home diff --git a/docs/get-started/README.md b/docs/get-started/README.md index dd91119ee..5ca83a259 100644 --- a/docs/get-started/README.md +++ b/docs/get-started/README.md @@ -3,3 +3,48 @@ ## What is IRISnet IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. + +## How to Join Fuxi Testnet + +### Step 1: Install Iris on Your Server + +Please follow this [instruction](Install-Iris.md) to get **Iris** installed locally. + +### Step 2: Run a Full Node + +Please follow this [instruction](Full-Node.md) to get your full node running. + + +### Step 3: Upgrade to Validator Node + +Please follow this [instruction](Validator-Node.md) to upgrade your full node to validator node. + +### Deploy IRISHub Monitor + +Please follow this [guide](../tools/Deploy-IRIS-Monitor.md) to get IRIHub monitor running on your side. + + +### Upgrade to Validator Node + +You now have an active full node. What's the next step? + +If you have participated in the genesis file generation process, you should be a validator once you are fully synced. + +If you miss the genesis file generation process, you can still upgrade your full node to become a IRISnet Validator. The top 100 validators have the ability to propose new blocks to the IRIS Hub. Continue onto [the Validator Setup](Validator-Node.md). + +### Setup a sentry node + +A validator is under the risk of being attacked. You could follow this [guide](../validators/Setup-Sentry-Node.md) to setup a sentry node to protect yourself. + +## Fuxi Incentivized Testnet +IRIS foundation plans to reward all the testnet participants who took part in the testnet. In Fuxi-3001 testnet,the community members have finished the tasks and they will receive their rewards in genesis allocation. +* Task List for Fuxi-3001： https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-3001/README.md +* Results：https://github.com/irisnet/testnets/issues/125 +To get more people involved, IRIS foundation decides to send out more tasks in the latest iteration of testnet:Fuxi-4001. +* Task List for Fuxi-4000: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-4000/README.md + +## Useful Links + +* Riot chat: #irisvalidators:matrix.org + +* Explorer: https://testnet.irisplorer.io/#/home \ No newline at end of file diff --git a/docs/get-started/Validator-Node.md b/docs/get-started/Validator-Node.md new file mode 100644 index 000000000..f079481aa --- /dev/null +++ b/docs/get-started/Validator-Node.md @@ -0,0 +1,133 @@ +# Running a Validator Node + +Before setting up your validator node, make sure you've already installed **Iris** by this [guide](Full-Node.md) + +Validators are responsible for committing new blocks to the blockchain through consensus. A validator's stake will be slashed if they become unavailable, double sign a transaction, or don't cast their votes. Please read about Sentry Node Architecture to protect your node from DDOS attacks and to ensure high-availability. + +## Get IRIS Token + +### Create Account + +You need to get `iris` and `iriscli` installed first. Then, follow the instructions below to create a new account: + +``` +iriscli keys add +``` + +Then, you should set a password of at least 8 characters. + +The output will look like the following: +``` +NAME: TYPE: ADDRESS: PUBKEY: +tom local faa1arlugktm7p64uylcmh6w0g5m09ptvklxm5k69x fap1addwnpepqvlmtpv7tke2k93vlyfpy2sxup93jfulll6r3jty695dkh09tekrzagazek +**Important** write this seed phrase in a safe place. +It is the only way to recover your account if you ever forget your password. + +blast change tumble toddler rival ordinary chicken dirt physical club few language noise oak moment consider enemy claim elephant cruel people adult peanut garden +``` + +You could see the address and public key of this account. Please node that account address in IRISnet will start with `faa` and public key of account will start with `fap`. + +The seed phrase of this account will also be displayed. You could use these 24 phrases to recover this account in another server. The recover command is: +``` +iriscli keys add --recover +``` + + +### Claim tokens + +You can always get some `IRIS` by using the [Faucet](https://testnet.irisplorer.io/#/faucet). The faucet will send you 10IRIS every request, Please don't abuse it. + +Once you have created your own address, please then you could use this　account to stake as a validatord. The following command is used to check the balance of your account: +``` +iriscli bank account --node=http://localhost:26657 +``` + +## Create Validator + +### Confirm Your Validator is Synced + +Your validator is active if the following command returns anything: + +``` +iriscli status --node=tcp://localhost:26657 +``` + +You should also be able to see `catching_up` is `false`. + +You need to get the public key of your node before upgrade your node to a validator node. The public key of your node starts with `fvp`, +it can be used to create a new validator by staking tokens. To understand more about the address encoding in IRISHub, +please read this [doc](Bech32-on-IRISnet.md) + +You can find your validator's pubkey by running: + +``` +iris tendermint show_validator --home= +``` +Example output: +``` +fvp1zcjduepqv7z2kgussh7ufe8e0prupwcm7l9jcn2fp90yeupaszmqjk73rjxq8yzw85 +``` +Next, use the output as `` field for `iriscli stake create-validator` command: + + +``` +iriscli stake create-validator --amount=XXiris --pubkey= --moniker= --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --node=http://localhost:26657 +``` +Please note the **fee** can be the **decimal** of IRIS token, like `0.01iris`. And you could also use other coin-type like `iris-milli` + +To read more about fee mechanism in IRISHub, go to this [doc](../modules/fee-token/Fee.md) + + +In this way, to stake 1IRIS, you need to do: + +``` +iriscli stake create-validator --pubkey=pubkey --fee=0.05iris --gas=2000000 --from= --chain-id=fuxi-4000 --node=tcp://localhost:26657 --amount=1iris +``` +Don't forget the `fee` and `gas` field. To read more about coin-type in IRISHub, you should read [this](../zh/modules/coin/README.md) + + + +### View Validator Info + +View the validator's information with this command: + +``` +iriscli stake validator --chain-id=fuxi-4000 --node=tcp://localhost:26657 +``` + +The `` is your account address that starts with 'faa1' + + +### Confirm Your Validator is Running + +Your validator is active if the following command returns anything: + +``` +iriscli status --node=tcp://localhost:26657 +``` + +You should also be able to see your power is above 0 if your bonded toke is in top 100. Also, you should see validator on the [Explorer](https://testnet.irisplorer.io). + + +### Edit Validator Description + +You can edit your validator's public description. This info is to identify your validator, and will be relied on by delegators to decide which validators to stake to. Make sure to provide input for every flag below, otherwise the field will default to empty (`--moniker`defaults to the machine name). + +You should put your name of your team in `details`. + +``` +iriscli stake edit-validator --from= < name > --moniker="choose a moniker" --website="https://irisnet.org" --details="team" --chain-id=fuxi-4000 + --details="details"--node=tcp://localhost:26657 --fee=0.04iris --gas=2000000 +``` +### View Validator Description + +View the validator's information with this command: + +``` +iriscli stake validator --chain-id=fuxi-4000 +``` + +### Use IRISPlorer + +You should also be able to see your validator on the [Explorer](https://testnet.irisplorer.io). You are looking for the `bech32` encoded `address` in the `~/.iris/config/priv_validator.json` file. diff --git a/docs/zh/get-started/Download-Rainbow.md b/docs/zh/get-started/Download-Rainbow.md index dd91119ee..1dd243942 100644 --- a/docs/zh/get-started/Download-Rainbow.md +++ b/docs/zh/get-started/Download-Rainbow.md @@ -1,5 +1,7 @@ -# IRISnet Testnet Codename Fuxi +# IRISnet 钱包: Rainbow -## What is IRISnet +## Raibow是什么？ -IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. +第一个支持跨链多资产转移及服务消费的IRISnet移动客户端公测即将开启，敬请期待... + +https://www.rainbow.one \ No newline at end of file diff --git a/docs/zh/get-started/Full-Node.md b/docs/zh/get-started/Full-Node.md new file mode 100644 index 000000000..be996147c --- /dev/null +++ b/docs/zh/get-started/Full-Node.md @@ -0,0 +1,108 @@ +# 如何运行一个全节点 + +## 配置 + +### 设置软件运行的目录 + +iris在运行过程中所依赖的配置文件和数据会存放在\$IRISHOME下，所以在运行iris前，需要指定一个目录作为\$IRISHOME。\$IRISHOME默认为：/Users/$user/.iris。 + +在\$IRISHOME需要设置两个文件夹：/config 和 /data + +### 下载配置文件文件 +iris运行中需要用到两个重要的文件：genesis.json 和config.toml + +genesis文件中定义了区块链网络的初始状态，而config.toml指定了iris软件模块的重要组成部分。 + +下载这两个文件到/$IRISHOME/config目录下： + +``` +cd $IRISHOME/config/ +wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/config.toml +wget https://raw.githubusercontent.com/irisnet/testnets/master/fuxi/fuxi-4000/config/genesis.json +``` +### 修改配置文件 +在config.toml文件中可以配置以下信息： +* 将`moniker`字段配置称为自定义的名称，这样便于区分不同的节点 +* `seed`字段用语设置种子节点，在fuxi-4000中的官方中字节点为： +``` +c16700520a810b270206d59f0f02ea9abd85a4fe@ts-1.bianjie.ai:26656 +a12cfb2f535210ea12731f94a76b691832056156@ts-2.bianjie.ai:26656 +``` + +你也可以配置 `moniker` 和 `external_address` 字段. + +``` +moniker = "" +external_address = "your-public-IP:26656" +``` + + +另外，如果你需要与其他节点通过内网链接，请设置 `addr_book_strict` 为 `false` 。 + +``` +addr_book_strict = false +``` +### 配置端口 + +如果你的节点需要与其他节点建立链接，则需要开放 `26656` 端口；若需要通过rpc端口查询Tendermint提供的信息，则需要开放 `26657` 端口。 + +通过以下命令启动全节点，并将日志输出到文件中： +``` +iris start --home {path_to_your_home} > log文件地址 & +``` +通过执行以下操作确认节点的运行状态： +``` +iriscli status +``` +示例输出： +```json +{"node_info":{"id":"3fb472c641078eaaee4a4acbe32841f18967672c","listen_addr":"172.31.0.190:26656","network":"fuxi-4000","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:26657"]},"sync_info":{"latest_block_hash":"7B1168B2055B19F811773EEE56BB3C9ECB6F3B37","latest_app_hash":"B8F7F8BF18E3F1829CCDE26897DB905A51AF4372","latest_block_height":12567,"latest_block_time":"2018-08-25T11:33:13.164432273Z","catching_up":false},"validator_info":{"address":"CAF80DAEC0F4A7036DD2116B56F89B07F43A133E","pub_key":{"type":"AC26791624DE60","value":"Cl6Yq+gqZZY14QxrguOaZqAswPhluv7bDfcyQx2uSRc="},"voting_power":0}} +``` +通过以上命令可以查看状态： + +* `"catching_up":false`: 表示节点与网络保持同步 + +* `"catching_up":true`: 表示节点正在同步区块 + +* `"latest_block_height"`: 表示最新的区块高度 + + +之后你就应该可以在浏览器中看到 + +## 重置一个全节点 + +若需要将一个节点重启，则可以通过以下命令让节点再次通过与网络保持同步。 + +### 重置IRIShub节点流程如下： + +1. 关闭iris进程 +``` +kill -9 +``` + +若Genesis文件有变动，则需要下载新的文件到$IRISHOME/config目录下。 + +2. 重置iris +``` +iris unsafe_reset_all --home= +``` + +3. 重新启动 + +通过以下命令启动全节点，并将日志输出到文件中： +``` +iris start --home > log文件地址 & +``` +通过执行以下操作确认节点的运行状态： +``` +iriscli status +``` +示例输出： +```json +{"node_info":{"id":"3fb472c641078eaaee4a4acbe32841f18967672c","listen_addr":"172.31.0.190:26656","network":"fuxi-4000","version":"0.22.6","channels":"4020212223303800","moniker":"name","other":["amino_version=0.10.1","p2p_version=0.5.0","consensus_version=v1/0.2.2","rpc_version=0.7.0/3","tx_index=on","rpc_addr=tcp://0.0.0.0:26657"]},"sync_info":{"latest_block_hash":"7B1168B2055B19F811773EEE56BB3C9ECB6F3B37","latest_app_hash":"B8F7F8BF18E3F1829CCDE26897DB905A51AF4372","latest_block_height":12567,"latest_block_time":"2018-08-25T11:33:13.164432273Z","catching_up":false},"validator_info":{"address":"CAF80DAEC0F4A7036DD2116B56F89B07F43A133E","pub_key":{"type":"AC26791624DE60","value":"Cl6Yq+gqZZY14QxrguOaZqAswPhluv7bDfcyQx2uSRc="},"voting_power":100}} +``` +通过以上命令可以查看状态： + +* `"catching_up":false`: 表示节点与网络保持同步 + +* `"latest_block_height"`: 表示最新的区块高度 \ No newline at end of file diff --git a/docs/zh/get-started/Genesis-Generation-Process.md b/docs/zh/get-started/Genesis-Generation-Process.md new file mode 100644 index 000000000..e4909b0fd --- /dev/null +++ b/docs/zh/get-started/Genesis-Generation-Process.md @@ -0,0 +1,81 @@ +# 参与到Genesis文件生成流程中 + + +1. 每个希望成为验证人的参与者确保安装了对应版本的软件：iris v0.7.0 + +2. 先创建账户,再执行gentx命令，获得一个gentx-node-ID.json的文件。这个操作将默认生成一个余额为150IRIS的账户，该账户默认绑定100IRIS成为一个验证人候选人。 + +``` +iriscli keys add your_name +iris gentx --name=your_name --home= --ip=Your_public_IP +``` + +代码示例： + +``` +iriscli keys add alice +iris gentx --name=alice --home=iris --chain-id=irishub-stage --ip=1.1.1.1 +``` +然后你可以发现在$IRISHOME/config目录下生成了一个gentx文件夹。里面存在一个gentx-node-ID.json文件。这个文件包含了如下信息： + +``` +{ + "type": "auth/StdTx", + "value": { + "msg": [ + { + "type": "cosmos-sdk/MsgCreateValidator", + "value": { + "Description": { + "moniker": "chenggedexiaokeai.local", + "identity": "", + "website": "", + "details": "" + }, + "Commission": { + "rate": "0.1000000000", + "max_rate": "0.2000000000", + "max_change_rate": "0.0100000000" + }, + "delegator_address": "faa1cf25tf4pfjdhkzx8lqnkajlse6jcpm2fyw4yme", + "validator_address": "fva1cf25tf4pfjdhkzx8lqnkajlse6jcpm2f3lltx7", + "pubkey": { + "type": "tendermint/PubKeyEd25519", + "value": "/JvLFsvyMgm2ND4QgN4JKyLxhL42dVgat67383Q+mPY=" + }, + "delegation": { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + } + } + ], + "fee": { + "amount": null, + "gas": "200000" + }, + "signatures": [ + { + "pub_key": { + "type": "tendermint/PubKeySecp256k1", + "value": "AtfNRj0zYvffAQG+iad6SScfdl29ag9G3EI0JDSwKJmy" + }, + "signature": "BwTejBceK4M+3LzmNl62jVFUr9wVv//UO7iI/yWi5KFoez9eY43HSlaZJf+3rnKLjosn2tD79EIw55BJ6SbYzQ==", + "account_number": "0", + "sequence": "0" + } + ], + "memo": "0eb02fdabb96923ac1e855ac012a5a624793264a@1.1.1.1:26656" + } +} +``` + +`msg` 是创建验证人节点的交易 + +3. 将上述提到的json文件以提交Pull Request的形式上传到`https://github.com/irisnet/testnets/tree/master/testnets/fuxi-5000/config/gentx`目录下： + + 注意⚠️：json文中的IP改成公网IP + + + + diff --git a/docs/zh/get-started/Install-the-Software.md b/docs/zh/get-started/Install-the-Software.md index d9786f2a0..a1a5f0306 100644 --- a/docs/zh/get-started/Install-the-Software.md +++ b/docs/zh/get-started/Install-the-Software.md @@ -1,2 +1,117 @@ -# IRISnet Testnet Codename Fuxi +### 安装IRIShub +#### 服务器配置要求 + + +首先，你需要配置一台服务器。你的验证人节点应该能够一直运行，使用你可能需要在一台数据中心的服务器。任何像AWS、GCP、DigitalOcean中的云服务器都是适合的。 + +IRIS Hub是用Go语言编写的。它可以在任何能够编译并运行Go语言程序的平台上工作。然而，我强烈建议在Linux服务器上运行验证人节点。我曾经尝试在Windows上运行验证人节点。我能够顺利的编译但是在运行的时候会有一些问题。接下来的说明和指导都是基于Linux服务器的。 +这是我们推荐的服务器的配置： + +* CPU核数：2 +* 内存容量：2GB +* 磁盘空间：40GB +* 操作系统：Ubuntu 18.04 LTS/16.04 LTS +* 允许的入方向的链接：TCP端口 26656 和 26657 + + +#### 方法1：下载发行版安装 + +进入下载页: https://github.com/irisnet/irishub/releases/ +下载对应版本的可执行文件 +解压缩 +``` +tar -C /usr/local/bin -xzf iris$VERSION.$OS-$ARCH.zip +``` +拷贝到/usr/local/bin/目录下 +执行以下命令,若出现对应的版本号则说明安装成功。 + +``` +$ iris version +v0.6.0 + +$ iriscli version +v0.6.0 +``` +#### 方法2：源码编译安装 + +#### 安装Go版本 1.10+ + + +系统要求： + +Ubuntu LTS 16.04 + + +安装IRISHub需要保证Go的版本在1.10以上， + +通过执行以下命令安装1.10版本的Go。 + +``` +$ sudo add-apt-repository ppa:gophers/archive +$ sudo apt-get update +$ sudo apt-get install golang-1.10-go +``` + +以上命令将安装 golang-1.10-go在 /usr/lib/go-1.10/bin. 需要将它加入到PATH中 + +``` +echo "export PATH=$PATH:/usr/lib/go-1.10/bin" >> ~/.bash_profile +source ~/.bash_profile +``` + +同时，你需要指定相关的 $GOPATH, $GOBIN, 和 $PATH 变量, 例如: + +``` +mkdir -p $HOME/go/bin +echo "export GOPATH=$HOME/go" >> ~/.bash_profile +source ~/.bash_profile +echo "export GOBIN=$GOPATH/bin" >> ~/.bash_profile +source ~/.bash_profile +echo "export PATH=$PATH:$GOBIN" >> ~/.bash_profile +source ~/.bash_profile +``` + +参考链接： + +1. https://golang.org/doc/install +2. https://github.com/golang/go/wiki/Ubuntu + + + +#### 下载源码并安装 + + +在完成Go的安装后，通过以下命令下载并安装IRIS hub相关程序. + +``` +mkdir -p $GOPATH/src/github.com/irisnet +cd $GOPATH/src/github.com/irisnet +git clone https://github.com/irisnet/irishub +cd irishub && git checkout v0.6.0 +curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh +make get_tools && get_vendor_deps && make install +``` + +以上命令将完成 iris 和 iriscli的安装. 若出现对应的版本号则说明安装成功。 + +``` +$ iris version +v0.6.0 + +$ iriscli version +v0.6.0 +``` +### 如何升级IRISHub + +通过执行一下命令可以完成IRISHub从v0.4.2到v0.6.0的升级 + +``` +cd $GOPATH/src/github.com/irisnet/irishub +git fetch -a origin +rm Gopkg.lock +git checkout v0.6.0 +make get_tools +make get_vendor_deps +make install +``` \ No newline at end of file diff --git a/docs/zh/get-started/Join-the-Testnet.md b/docs/zh/get-started/Join-the-Testnet.md index dd91119ee..247de4868 100644 --- a/docs/zh/get-started/Join-the-Testnet.md +++ b/docs/zh/get-started/Join-the-Testnet.md @@ -1,5 +1,52 @@ -# IRISnet Testnet Codename Fuxi +IRISnet测试网 -## What is IRISnet +IRIShub 简介 -IRIS network (a.k.a. IRISnet) is named after Greek goddess **Iris**, said to be the personification of the rainbow and the faithful messenger between heaven and humanity. IRIS network aims to build the foundation which facilitates construction of distributed business applications. IRIS hub will provide iServices, which allow resources such as data service and computing services being invoked across blockchains. To know more about IRISnet, please read this blog. +IRIS Hub是在Cosmos生态中的区域性枢纽，提供iService服务 + +如何加入fuxi测试网 + +第一步: 安装IRIShub + +请根据一下教程 在服务器上完成Iris的安装。 + +第二步: 运行一个全节点 + +请根据一下步骤 完成初始化并开始在服务器上运行一个全节点。 + +第三步: 将全节点升级成为一个验证人节点 + +请根据以下步骤 将一个全节点升级成为验证人节点。 + +部署IRISHub Monitor监控 + +请根据以下链接 在服务器上部署一个Monitor监控。 + +如何成为一个验证人节点 + +如何你的节点已经完全同步了，那么要如何才能升级成为一个验证人节点你？ + +如果你参与到了genesis文件的生成过程中，那么只要你的节点与网络同时启动，它就会保持验证人的状态。 + +如果你并没有参与到genesis文件的生成过程中，那么你依然可以通过执行相关操作升级成为一个验证人。目前IRIShub的验证人上限是100。升级的流程在这里. + +部署哨兵节点 + +验证人有遭受攻击的风险。你可以根据以下教程部署一个哨兵节点来保护验证人。 + +Fuxi测试网激励计划 + +IRIS基金会通过推出测试网激励计划来鼓励更多的人加入到Fuxi测试网中。在Fuxi-2000中，我们针对中国社区发布了测试网激励任务。一共有14位社区成员完成了任务。 + +Fuxi-2000 任务列表： https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-2000/README.md + +Fuxi-2000 任务完成情况：https://github.com/irisnet/testnets/issues/51 + +在Fuxi-3001测试网中， IRIS基金会决定推出更多的测试网激励计划。 + +Fuxi-3001任务列表: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-3001/README.md + +更多链接 + +- Explorer: https://testnet.irisplorer.io/#/home +- Riot chat: #irisvalidators:matrix.org diff --git a/docs/zh/get-started/README.md b/docs/zh/get-started/README.md index 047f46d8e..2cfbb8abc 100644 --- a/docs/zh/get-started/README.md +++ b/docs/zh/get-started/README.md @@ -4,3 +4,53 @@ IRIS Hub是在Cosmos生态中的区域性枢纽，提供iService服务 +## 如何加入fuxi测试网 + +### 第一步: 安装IRIShub + +请根据一下[教程](Install-Iris.md) 在服务器上完成**Iris**的安装。 + +### 第二步: 运行一个全节点 + +请根据一下[步骤](Full-Node.md) 完成初始化并开始在服务器上运行一个全节点。 + + +### 第三步: 将全节点升级成为一个验证人节点 + +请根据以下[步骤](Validator-Node.md) 将一个全节点升级成为验证人节点。 + +### 部署IRISHub Monitor监控 + +请根据以下[链接](../tools/Deploy-IRIS-Monitor.md) 在服务器上部署一个Monitor监控。 + + +### 如何成为一个验证人节点 + +如何你的节点已经完全同步了，那么要如何才能升级成为一个验证人节点你？ + +如果你参与到了genesis文件的生成过程中，那么只要你的节点与网络同时启动，它就会保持验证人的状态。 + +如果你并没有参与到genesis文件的生成过程中，那么你依然可以通过执行相关操作升级成为一个验证人。目前IRIShub的验证人上限是100。升级的流程在[这里](Validator-Node.md). + +### 部署哨兵节点 + +验证人有遭受攻击的风险。你可以根据以下[教程](../validators/Setup-Sentry-Node.md)部署一个哨兵节点来保护验证人。 + +## Fuxi测试网激励计划 + +IRIS基金会通过推出测试网激励计划来鼓励更多的人加入到Fuxi测试网中。在Fuxi-2000中，我们针对中国社区发布了测试网激励任务。一共有14位社区成员完成了任务。 + +Fuxi-2000 任务列表： https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-2000/README.md + +Fuxi-2000 任务完成情况：https://github.com/irisnet/testnets/issues/51 + +在Fuxi-3001测试网中， IRIS基金会决定推出更多的测试网激励计划。 + +Fuxi-3001任务列表: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-3001/README.md + +## 更多链接 + + +* Explorer: https://testnet.irisplorer.io/#/home + +* Riot chat: #irisvalidators:matrix.org \ No newline at end of file diff --git a/docs/zh/get-started/Validator-Node.md b/docs/zh/get-started/Validator-Node.md new file mode 100644 index 000000000..d45a23218 --- /dev/null +++ b/docs/zh/get-started/Validator-Node.md @@ -0,0 +1,127 @@ +# 运行一个验证人节点 + +在配置验证人节点之前，请保证已经按照此[文档](Install-Iris.md)正确安装了**Iris** + +在IRISHub枢纽中，验证人负责将交易打包并提交区块。成为一个验证人需要满足很多条件，不仅仅是技术和硬件上的投资。同时，因为只有在有限验证人的条件下，Tendermint才能发挥最大的作用。目前，我们将IRISHub枢纽的验证人上限定为100。也就是说只有前100个验证人能够获得奖励，而大部分IRIS持有者不会成为验证人而是通过委托的方式决定谁会成为验证人。 + +## 如何升级成一个验证人节点 + +### 获取IRIS Token + +#### 创建一个账户 +你首先需要安装`iris` 和 `iriscli`。然后执行以下操作创建一个新的账户： + +``` +iriscli keys add +``` + +然后你需要输入至少8位的密码。 + +示例输出如下： +``` +NAME: TYPE: ADDRESS: PUBKEY: +tom local faa1arlugktm7p64uylcmh6w0g5m09ptvklxm5k69x fap1addwnpepqvlmtpv7tke2k93vlyfpy2sxup93jfulll6r3jty695dkh09tekrzagazek +**Important** write this seed phrase in a safe place. +It is the only way to recover your account if you ever forget your password. + +blast change tumble toddler rival ordinary chicken dirt physical club few language noise oak moment consider enemy claim elephant cruel people adult peanut garden +``` + +你可以查看到该账户的地址和公钥。在IRISHub中，地址经过bech32编码后将以`faa1`为首字节 ，另外公钥将以 `fap1`为首字节. + +账户的助记词(seed phrase)也将被显示出来。你可以使用该长度为24个单词的助记词在任意的机器上恢复你的账户。恢复账户的命令是: + +``` +iriscli keys add --recover +``` +### Claim tokens + + +一旦你完成了账户的创建，你可以通过[水龙头](https://testnet.irisplorer.io/#/faucet)获得用于测试网的IRIS token,然后你就可以将这部分IRIS用于绑定成为验证人。 +水龙头每次将发送10IRIS，请按需使用！ + +以下命令将查询你的账户的余额： + +``` +iriscli bank account --node=http://localhost:26657 +``` + +## 执行成为验证人操作 + +### 确认你的全节点与网络保持同步 + +通过以下命令确认节点的状况： +``` +iriscli status --node=tcp://localhost:26657 +``` +若 `catching_up` 字段为 `false`那么你的节点就是同步的。 + +你需要获取当前节点的公钥信息来执行以下操作，公钥信息以 `fvp`为首字节，想要了解更多的编码信息，请参考以下 [文档](Bech32-on-IRISnet.md) + +通过执行以下命令获得节点的公钥信息，公钥信息将以`fvp1`开头： + +``` +iris tendermint show_validator --home= < IRIS-HOME > +``` +示例输出: +``` +fvp1zcjduepqv7z2kgussh7ufe8e0prupwcm7l9jcn2fp90yeupaszmqjk73rjxq8yzw85 +``` +然后，使用以上输出作为`iriscli stake create-validator`命令的 `` 字段： + +``` +iriscli stake create-validator --from= < name > --amount= < amount >iris --pubkey= < pubkey > --moniker= < moniker > --fee=0.05iris --gas=2000000 --chain-id=fuxi-4000 --node=http://localhost:26657 +``` +> 注意：**amount** 应为整数， **Fee** 字段可以使用小数，例如`0。01iris` 。 + +也就是说，如果你想要抵押1IRIS,你可以执行以下操作： + +``` +iriscli stake create-validator --pubkey=pubkey --fee=0.04iris --gas=2000000 --from= < name > --chain-id=fuxi-4000 --node=tcp://localhost:26657 --amount=1iris +``` + +### 查询验证人信息 + +你可以通过以下命令查询验证人的信息： + +``` +iriscli stake validator < address-validator-operator > --chain-id=fuxi-4000 --node=tcp://localhost:26657 +``` + +请注意 `` 字段是以`faa1`为首字母。 + + +### 确认验证人是否在线 + +你可以通过以下命令查询验证人节点的运行状况， + +``` +iriscli status --node=tcp://localhost:26657 +``` + +你应该可以看到节点的`power`字段返回值大于0。 + +### 编辑验证人信息 + +你可以通过以下命令修改验证人的描述信息，验证人的名称默认为`--moniker`字段。 +你应该在`details`字段注明自定义的信息。 + +``` +iriscli stake edit-validator --from= < name > --moniker="choose a moniker" --website="https://irisnet.org" --details="team" --chain-id=fuxi-4000 + --details="details"--node=tcp://localhost:26657 --fee=0.04iris --gas=2000000 +``` +### 查询验证人信息 + +你可以通过以下命令查询验证人的信息： + +``` +iriscli stake validator < address-validator-operator > --chain-id=fuxi-4000 +``` + +### 使用浏览器：IRISPlorer + +你可以通过[浏览器](https://testnet.irisplorer.io)确认验证人节点的运行状况。 + +### 部署IRISHub Monitor监控 + +请根据以下[链接](../../tools/Deploy-IRIS-Monitor.md) 部署一个Monitor监控验证人。 From 1011bb973c5c3d9e769bf6c7642e96592bad08be Mon Sep 17 00:00:00 2001 From: kidinamoto01 Date: Fri, 16 Nov 2018 17:17:36 +0800 Subject: [PATCH 057/100] =?UTF-8?q?IRISHUB-679=EF=BC=9AAdd=20resources=20&?= =?UTF-8?q?=20get=20started?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/resources/README.md | 2 ++ docs/resources/validator-faq.md | 25 ++++++++++++- docs/resources/whitepaper-en.md | 50 +++++++++++++------------- docs/resources/whitepaper-zh.md | 56 +++++++++++++----------------- docs/zh/resources/README.md | 4 ++- docs/zh/resources/validator-faq.md | 25 ++++++++++++- 6 files changed, 101 insertions(+), 61 deletions(-) diff --git a/docs/resources/README.md b/docs/resources/README.md index 3c1229ee1..718032453 100644 --- a/docs/resources/README.md +++ b/docs/resources/README.md @@ -1 +1,3 @@ # Resources + +This is where you could find all the resources of IRISnet. \ No newline at end of file diff --git a/docs/resources/validator-faq.md b/docs/resources/validator-faq.md index 5b1003104..e62b4e6cc 100644 --- a/docs/resources/validator-faq.md +++ b/docs/resources/validator-faq.md @@ -1,3 +1,26 @@ -# FAQ +# Fuxi测试网激励计划常见问题 +1.如何加入Fuxi测试网? + +你可以加入QQ工作群：834063323。团队将在群里及时通知有关测试网的消息。 + +有两种方式加入测试网： +* 以验证人的身份加入：你可以在自己的服务器上部署一个IRIShub节点。然后将其绑定成为一个验证人节点。如果你暂时没有服务器，你也可以申请免费试用BaaS的服务，我们将提供 +Wancloud和Zig-BaaS的免费试用机会。然后你就可以完成测试网的任务了。 + +* 以委托人的身份加入： +如果你对于部署一个验证人节点感到很困难，你可以只下载一个客户端，然后执行相关的测试网的任务交易。 + + +2.测试网的激励任务在哪里? + +每一个测试网迭代中，团队都会发布相关的测试网激励任务。例如，Fuxi-3001测试网激励任务在下面链接中：https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-3001 + +3.怎样能知道我的任务完成情况? + +每当决定切换到下一个测试网的时候，团队会检查参与者的任务完成情况。例如，Fuxi-2000测试网任务完成情况在这里：https://github.com/irisnet/testnets/issues/51 + +4.如果我获得了测试网奖励，何时才能拿到? + +测试网的奖励将在主网上线后发放给社区成员。你需要用你的Keybase签名一个irishub的地址，然后将其发送给团队。 \ No newline at end of file diff --git a/docs/resources/whitepaper-en.md b/docs/resources/whitepaper-en.md index af42d73ee..a1916bd21 100644 --- a/docs/resources/whitepaper-en.md +++ b/docs/resources/whitepaper-en.md @@ -1,8 +1,8 @@ # The IRIS Network **Inter-chain service infrastructure and protocol for building trustworthy and distributed business applications** -Haifeng Xi haifeng@bianjie.ai
-Harriet Cao harriet@bianjie.ai +Harriet Cao harriet@bianjie.ai
+Haifeng Xi haifeng@bianjie.ai _NOTE: If you can read this on GitHub, then we're still actively developing this document. Please check regularly for updates!_ @@ -883,44 +883,50 @@ Proceeds from the private sale of IRIS tokens will be used, first and foremost, The expected IRIS project is set out below. We reiterate that the roadmap is indicative only, and subject to change. -* **PANGU** (January 2018 \~ March 2019) The first stage of the IRIS project will focus on having the IRIS Hub up and running. We also intend to release an initial version of the mobile client for the IRIS network. In this stage we also focus on building the fundamental IRIS Service Layer. This will involve enabling service definition, binding, invocation and query. We plan to collabrate with 1-2 ecosystem parteners to release i-Services to IRIShub. +* **PANGU** (January 2018 \~ July 2018) The first stage of the IRIS project will focus on having the IRIS Hub up and running and connected to the Cosmos Hub. We also intend to release an initial version of the mobile client for the IRIS network. -* **NUWA** (April 2019 \~ December 2019) In this stage we are aiming to have a beta version of the IRIS SDK ready for developers. We plan to upgrade IRISnet mobile client to support i-Services. We plan to establish collabrations with application specific blockchains and enable them as zones connecting to IRIShub. We also plan to accomplish the connection with Cosmos Hub at this stage. - - -* **KUAFU** (Oct 2019 \~ Dec 2019) The third stage will focus on incremental upgrades to the IRIS network in order to support our planned advanced IRIS Service governance features. +* **NUWA** (July 2018 \~ November 2018) +The second stage will focus on building the fundamental IRIS Service Layer. This will involve enabling service definition, binding, invocation and query. +In this stage we are also aiming to have a beta version of the IRIS SDK ready for developers. -* **HOUYI** (Beyond January 2020) +* **KUAFU** (December 2018 \~ May 2019) The third stage will focus on incremental upgrades to the IRIS network in order to support our planned advanced IRIS Service governance features. + + +* **HOUYI** (Beyond June 2019) The fourth stage will focus on further technology innovations to the IRIS network, IRIS SDK and mobile client, as well as developer engagement.
## The Team ################################################################ -**Bianjie AI** -is the core development team for the IRIS network, leveraging the team's experience established from building distributed applications. [Bianjie AI](https://www.bianjie.ai) is a Shanghai-based start-up established in 2016. It focuses on developing innovative products and solutions for healthcare and financial industries, using advanced Blockchain and AI technologies. Besides IRISnet, Bianjie's also building another core product --- `BEAN (Blockchain Edge Analytics Network)` BEAN (Blockchain Edge Analytics Network), which is a permission chain which delivers distributed data analytics services for privacy preserving healthcare data analysis and exchange using NLP and machine learning technologies. -**Bianjie AI** -is also the operation and service partner of Cosmos Network in China. - **Tendermint** (the team that developed the [Tendermint](https://www.tendermint.com) consensus engine and is currently building Cosmos), **Wancloud** (a subsidiary of [Wanxiang -Blockchain](http://www.wxblockchain.com) are strategic parteners working together with **Bianjie AI** building the IRIS network's infrastructure. +Blockchain](http://www.wxblockchain.com) and **Bianjie AI** will work together to build the IRIS network's infrastructure. Tendermint's intended role to give technical advice and development support to the IRIS project team in extending the Tendermint ABCI and the Cosmos IBC technologies. [Wancloud](https://www.wancloud.io) is envisaged as the key strategy partner to both the Cosmos and IRIS ecosystems, and we understand that it intends to participate in Cosmos and IRIS development across Asia. -### Core Members - -**Haifeng Xi** +**Bianjie AI** +will be the core development team for the IRIS network, leveraging the team's experience established from building distributed AI analytics services for healthcare data analysis and exchange. [Bianjie AI](https://www.bianjie.ai) is a Shanghai-based start-up established in 2016. It focuses on developing innovative products and solutions for healthcare and financial industries, using advanced Blockchain and AI technologies. One of Bianjie's core products, `BEAN (Blockchain Edge Analytics Network)` BEAN (Blockchain Edge Analytics Network), is a permission chain which delivers distributed data analytics services for privacy preserving healthcare data analysis and exchange using NLP and machine learning technologies. Bianjie AI is +currently extending `BEAN` capabilities to build the IRIS network. +**Bianjie AI** +is also the operation and service partner of Cosmos Network in China. -[Haifeng](https://www.linkedin.com/in/haifengxi/) is a senior technologist and entrepreneur. Haifeng has an M.S degree in ECE from the University of Maryland. Haifeng worked as CTO for Wanxiang Blockchain Wancloud before starting IRISnet project. He also worked as senior architect for two leading financial companies In US (Tudor Investment & RBS Sempra), then he came back to China worked in the capacity of CTO for three companies, one of which is NASDAQ listed (China Finance Online). +### Core Members **Harriet Cao** [Harriet](https://www.linkedin.com/in/harrietcao/) is the founder of Bianjie AI, which a Shanghai-based start-up focusing on building smart services for blockchain that enable trustworthy and efficient business collaborations using distributed AI technology. Harriet is an award-winning practitioner of data analytics and artificial intelligence technologies, and was the recipient of 2010 INFORMS Daniel H. Wagner Prize. Prior to establishing Bianjie AI, Harriet worked for IBM Research for more than 16 years in various capacities including Director of IBM Research Shanghai Lab and Big Data Analytics Leader for IBM Global Labs. Harriet has an M.S degree in Robotics from Carnegie Mellon University and an M.S. degree in Automation Control from Tsinghua University. + +**Haifeng Xi** + +[Haifeng](https://www.linkedin.com/in/haifengxi/) is a senior technologist and entrepreneur. Since returning to China from the United States in 2009, he had worked in the capacity of Chief Technology Officer for three companies, one of which is NASDAQ listed. He also co-founded two start-ups in Shanghai, where he plays an active role of technical leader and engineering champion. +Haifeng has a Master's degree in Electrical and Computer Engineering from the University of Maryland, and a Master's and Bachelor's degree in Automatic Control from Tsinghua University. + + **Jae Kwon** After graduating from Cornell in 2005 with an undergraduate degree in computer science, [Jae](https://www.linkedin.com/in/yjkwon/) worked as a software developer in Silicon Valley, first at Amazon (where he worked on the Alexa digital assistant), then later at Yelp, where he led their mobile app development team. @@ -937,10 +943,6 @@ Tom has been tracking trends in the blockchain, cloud computing, IoT and smart m ### Advisors -**Dr. Shuo Bai** - -Dr. Bai is the director of ChinaLedger Technical Committee, and former Chief Architect of Shanghai Stock Exchange. He is a senior blockchain professional who graduated from Peking University with doctorate of science. He worked in various capacities including researcher, doctoral student advisor, director of software department, and chief scientist in the Institute of Computing Technology, Chinese Academy of Sciences. He also led the establishment of China National Internet Emergency Center (CNCERT/CC) since 2000. Dr. Bai has rich experiences in theoretical research and technical practices in the fields of financial exchanges, consortium and public blockchains. - **Jim Yang** [Jim Yang](https://www.linkedin.com/in/jimyang/) runs Strategy for Tendermint. He was the founder and CEO at ChatX, mobile messaging studio. ChatX developed various mobile messaging/social apps. He also co-founded Identyx, where he served as CEO until its acquisition by Red Hat. Identyx developed an open source enterprise identity management software. @@ -957,10 +959,6 @@ Dr. Bai is the director of ChinaLedger Technical Committee, and former Chief Arc [Dr. Michael Yuan](http://www.michaelyuan.com) is the Director of the [CyberMiles Foundation](https://cm.5miles.com). Michael received a PhD in Astrophysics from University of Texas at Austin. He is the author of 5 books on software development, published by Prentice Hall, Addison-Wesley, and O'Reilly. Michael was an active code committer in large Open Source projects such as Firefox, Fedora, JBoss, and others. He is an expert on enterprise and mobile software, and was a Principle Investigator on multiple research projects funded by the US government. -**Yubo Ruan** - -[Yubo](https://www.linkedin.com/in/yubo-ruan/) is the founder of 8 Decimal Capital. The fund invested in IRISnet，0x、Kyber、Ontology、Fcoin、Zilliqa、ICON、Wanchian、Bibox、BiShiJie. Yubo is the co-founder of Skylight Investment, a boston based venture fund backed by New Oriental(NYSE:EDU). Previously, Yubo started two highly successful companies, including Alisimba (Acquired by TopHacker Group) held 4 national patents and won the 2017 AACYF 30 under 30, Silver Medal Winner, iENA International Inventions Competition, 2012. -
## References ################################################################ diff --git a/docs/resources/whitepaper-zh.md b/docs/resources/whitepaper-zh.md index 084e63eba..661f69bfd 100644 --- a/docs/resources/whitepaper-zh.md +++ b/docs/resources/whitepaper-zh.md @@ -2,9 +2,7 @@ **用于构建可信分布式商业应用的跨链服务基础设施及协议** -Haifeng Xi haifeng@bianjie.ai
-Harriet Cao harriet@bianjie.ai - +Harriet Cao harriet@bianjie.ai
Haifeng Xi haifeng@bianjie.ai _NOTE:如果你可以在GitHub上阅读，那么我们仍然在积极完善这个文档。 请定期检查更新!_
@@ -39,7 +37,7 @@ _NOTE:如果你可以在GitHub上阅读，那么我们仍然在积极完善这 本文所设想的IRIS网络尚在开发中，并将不断更新，这些更新包括但不限于关键治理和关键技术。 开发使用IRIS通证或与之相关的测试平台（软件）以及技术，可能无法实现或无法完全实现本白皮书所述的目标。 -如果IRIS网络得以完成，可能与本文所述有所不同。本文不对未来的任何计划、预测或前景的成功性或者合理性做出陈述或保证，本文的任何内容都不应被视为对未来的承诺或陈述。 +如果IRIS网络得以完成，可能与本文所述有所不同。本文不对未来的任何计划、预测或前景的成功性或者合理性做出陈述或保证，本文的任何内容都不应被视为对未来的承诺或陈述。 ### 并非监管类产品的要约 @@ -115,13 +113,13 @@ Cosmos[[3]]想要建立“区块链的互联网”。 这是由许多被称为 Tendermint提供了一个高性能、一致的、安全的BFT共识引擎，严格的分叉问责保证能够控制作恶者的行为。Tendermint非常适合用于扩展异构区块链，包括公有链以及注重的性能的许可链/联盟链，像Ethermint [[6]]就是一次对Ethereum以太坊POS机制的快速实现。 使用Tendermint在许可/联盟链域中的成功案例包括Oracle [[7]]，CITA [[8]] 和Hyperledger Burrow [[9]]。 -Tendermint作为共识协议用于在Cosmos Hub上构建第一个分区。Cosmos Hub可以连接到许多不同类型的分区，并且通过一种相当于区块链之间的虚拟UDP或TCP的IBC协议（ Inter-blockchain Communication，IBC）实现跨链通信。 通证可以安全地通过Cosmos Hub从一个分区转移到另一个分区，而不需要在分区之间的交易所或受信任的第三方。 +Tendermint作为共识协议用于在Cosmos Hub上构建第一个分区。Cosmos Hub可以连接到许多不同类型的分区，并且通过一种相当于区块链之间的虚拟UDP或TCP的IBC协议（ Inter-blockchain Communication，IBC）实现跨链通信。 通证可以安全地通过Cosmos Hub从一个分区转移到另一个分区，而不需要在分区之间的交易所或受信任的第三方。 为了使用Cosmos Hub开发强大的可互操作区块链和区块链应用，Cosmos SDK提供了区块链常用模块的开发“入门套件”，而不是限制可实现的用户故事，从而为应用定制提供了最大的灵活性。 ### IRIS 技术创新 -IRIS网络的目标是为构建分布式商业应用提供技术基础设施，它超越了主要用于数字资产的现有区块链系统。 +IRIS网络的目标是为构建分布式商业应用提供技术基础设施，它超越了主要用于数字资产的现有区块链系统。 我们打算通过IRIS网络解决的关键挑战在于两个方面： - 利用分布式账本支持链下运算资源的集成和协同 @@ -153,13 +151,13 @@ IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定 1. **服务消费者** 服务消费者是通过向网络发送请求并接收响应来使用链下服务的用户。 -2. **服务提供者** 服务提供者是那些可能提供一个或多个iService定义的用户，并且通常是其它公有链和联盟链甚至传统企业应用系统中链下服务和资源之间的适配器。服务提供者监听和处理传入的请求，并将结果发送回网络。一个服务提供者可以向其它服务提供者发送请求而同时成为服务消费者。服务提供者可以按计划为他们提供的任何服务收取费用，默认情况下服务费使用IRIS网络的原生费用通证“IRIS”定价；也可以在适当的时候考虑使用Cosmos白名单中的其他费用通证对服务定价。 +2. **服务提供者** 服务提供者是那些可能提供一个或多个iService定义的用户，并且通常是其它公有链和联盟链甚至传统企业应用系统中链下服务和资源之间的适配器。服务提供者监听和处理传入的请求，并将结果发送回网络。一个服务提供者可以向其它服务提供者发送请求而同时成为服务消费者。服务提提供者可以按计划为他们提供的任何服务收取费用，默认情况下服务费使用IRIS网络的原生费用通证“IRIS”定价；也可以在适当的时候考虑使用Cosmos白名单中的其他费用通证对服务定价。 3. **分析员** 分析员是一种特殊用户，代表了发起建立IRIS网络的IRIS基金会有限公司（IRIS Foundation Limited），这是一家注册在香港的股份有限公司。分析员是在分析模式中调用iServices的唯一授权用户，旨在帮助创建和维护服务提供者的概要文件，通过这些客观的概要文件服务消费者可以选择合适的服务提供者。 ### IRIS 服务 -在本节中，我们列出了在IRIS网络上部署iService时预计使用的技术参数。 +在本节中，我们列出了在IRS网络上部署iService时预计使用的技术参数。 **服务定义** @@ -169,7 +167,7 @@ IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定 * `Name (string)`: iService中该方法的唯一名称 * `Description (string)`: 对该方法的描述 * `Input (string)`: 对输入参数的结构化定义 -* `Output (string)`: 对输出结果的机构化定义 +* `Output (string)`: 对输出结果的结构化定义 * `Error (string)`: 对可能出现的错误条件的结构化定义 * `OutputPrivacy (enum)`: 设置此方法是非隐私的还是公钥加密的，可选值`NoPrivacy`/`PubKeyEncryption` @@ -335,7 +333,7 @@ IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定 **查询** -上述所有与服务生命周期相关的对象都可以使用ABCI 'Query'接口[\[3\]]查询到。这些查询将通过'Query'连接执行，并不参与共识过程。我们已经看到了如何得到的`GetServiceRequest`和得到`GetServiceResponse`查询作为服务调用过程的一部分。 +上述所有与服务生命周期相关的对象都可以使用ABCI 'Query'接口[\[3\]]查询到。这些查询将通过'Query'连接执行，并不参与共识过程。我们已经看到了如何得到的`GetServiceRequest`和得到`GetServiceResponse`查询作为服务调用过程的一部分。 上面描述的所有与服务相关的生命周期对象都可以使用ABCI查询接口3来查询。 以下是我们目前计划的查询的一个非详尽的摘要： @@ -432,7 +430,7 @@ IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定 ### 分布式人工智能用于隐私保护下的数据分析 -这个用例的服务基础架构已由位于上海的科技创业公司`边界智能`进行了原型设计，并将其应用到联盟链产品`BEAN (BlockchainEdge Analytics Network)`中，用于解决长期已来为运行分析模型获取数据的挑战。尽管同态加密是允许通过加密数据实现计算的关键方法之一，但由于性能低下，实际上无法解决现实世界的机器学习问题。因此，BEAN的创建提供了另一种解决方案--利用传统的分布式人工智能研究[[14]]中的模型并行性和SOA设计模式，作为区块链的附加层开发分布式分析服务。 +这个用例的服务基础架构已由位于上海的初创公司`边界智能`进行了原型设计，并将其应用到联盟链产品`BEAN (BlockchainEdge Analytics Network)`中，用于解决长期已来为运行分析模型获取数据的挑战。尽管同态加密是允许通过加密数据实现计算的关键方法之一，但由于性能低下，实际上无法解决现实世界的机器学习问题。因此，BEAN的创建提供了另一种解决方案--利用传统的分布式人工智能研究[[14]]中的模型并行性和SOA设计模式，作为区块链的附加层开发分布式分析服务。 为了保护数据存取，运行在数据端的（部分）模型需要开放给客户端，并在服务定义中说明。由于只有部分模型开放给客户端，模型开发人员不必担心有人窃取他们的想法；同样，数据拥有者永远不需要担心失去对其数据使用的控制，因为数据不会离开他们的数据源。 @@ -524,35 +522,37 @@ IRIS网络旨在支持所有来自Cosmos网络白名单中的费用通证，例 预期的IRIS项目路线图如下。这里我们重申一下，路线图只是一个大概方向，将来根据项目实施会有变化。 -- **盘古**（2018年1月~2019年3月）：IRISnet项目的第一阶段，我们专注于构建并启动 IRISnet 主网（Hub）。同时，我们将发布一个初始版本的IRIS网络移动客户端。我们也将建立 IRISnet 基本服务层： 升级网络以实现服务定义、绑定、调用和查询; 并实现支持1-2两个生态伙伴发布i-Services到跨链枢纽。 - -- **女娲** (2019年4月~2019年9月)：第二阶段将为开发者准备了beta版的IRIS SDK，并升级移动客户端以支持服务; 与应用专有链项目形成战略联盟，支持它们作为分区连接到IRIS枢纽。IRISnet 也在第二阶段完成和 Cosmos Hub 的链接，打通和以太坊生态的链接。 +- **盘古**（2018年1月~2018年7月）：IRIS项目的第一阶段，将集中在构建和运行IRIS Hub以及与Cosmos Hub的交互。同时，我们将发布一个初始版本的IRIS网络移动客户端。 -- **夸父**（2019年10月~2019年12月）：第三阶段主要专注于完成IRIS网络的增强功能，升级网络以支持复杂的IRIS服务管理功能，例如：分析和争议解决; 不断完善SDK和手机客户端; 加速拓展网络，连接更多的分区，整合更多的服务提供商。 +- **女娲**   (2018年7月~2018年11月)：第二阶段主要集中在构建IRIS Service Layer。这将涉及启用服务定义、绑定、调用和查询。在这个阶段，我们也打算为开发者准备一个beta版的IRIS SDK。 -- **后羿** (2020年1月之后）：第四阶段通过不懈的技术创新，完善的社区建设和可持续的开发者支持以实现分布式商业生态系统。 +- **夸父** （2018年12月~2019年5月）：第三阶段主要专注于IRIS网络的增量升级，以支持我们计划中先进的IRIS Service治理特性。 +- **后裔** （2019年6月之后）：第四阶段专注在IRIS网络、IRIS SDK和移动客户端的技术创新，以及开发者的参与。 +
## 团队 -边界智能是IRIS网络的核心开发团队。边界智能是一家于2016年在上海成立的技术创新公司，具有区块链、人工智能等方面的核心竞争力。边界智能基于服务架构构建复杂商业区块链应用获得了客户（包括复星健康云、宁夏医疗大数据平台和民生保险等），研究机构以及中国国家级创新大赛的认可 ：在2018第七届中国创新创业大赛全国总决赛上进入成长组32强并获得优秀企业奖，荣获2018年度上海市科技型中小企业技术创新资金资助；2018年8月25日获国家队组织的2018年中国健康医疗大数据创新大赛TMT数据组一等奖，天使之星组冠军，同时，**边界智能**从2017年起就是Cosmos网络在中国的运营和服务合作伙伴。 +**Tendermint** (该团队开发了 [Tendermint](https://www.tendermint.com)共识引擎，当前正在开发Cosmos), **Wancloud万云** ( [万向区块链](http://www.wxblockchain.com) 子公司)和 **边界智能** 将共同构建IRIS网络的基础设施。 + +Tendermint将在扩展Tendermint ABCI和Cosmos IBC技术方面，为IRIS项目团队提供技术咨询和开发支持。[Wancloud万云](https://www.wancloud.io) 将是Cosmos和IRIS生态系统的关键战略合作伙伴，它将积极参与Cosmos和IRIS在亚太地区的开发和发展。 -**Tendermint** (该团队开发了 [Tendermint](https://www.tendermint.com)共识引擎，当前正在开发Cosmos) 也在扩展Tendermint ABCI和Cosmos IBC技术方面，为IRIS项目团队提供技术咨询和开发支持。[Wancloud万云](https://www.wancloud.io) 将是Cosmos和IRIS生态系统的关键战略合作伙伴，它将积极参与Cosmos和IRIS在亚太地区的开发和发展。 +边界智能将是IRIS网络的核心开发团队，IRIS充分借助团队创建分布式智能分析服务的经验，实现医疗数据分析与交换。边界智能是一家于2016年在上海成立的初创公司，专注于利用先进的区块链技术和人工智能技术为医疗和金融行业开发创新产品和提供解决方案。边界智能中的一个核心产品`BEAN`（区块链智能信息边缘分析网络Blockchain Edge Analytics Network）是一条许可链，它利用自然语言分析及机器学习技术为隐私保护、医疗健康数据的分析和交换提供分布式智能分析服务。边界智能正不断扩展`BEAN`功能来构建IRIS网络，同时，**边界智能**也是Cosmos网络在中国的运营和服务合作伙伴。 ### 核心成员 -**Haifeng Xi** +**曹恒** -[Haifeng](https://www.linkedin.com/in/haifengxi/) 是边界智能的联合创始人，他是高级区块链技术专家和企业家。他先后获得了清华大学自动化控制学士、硕士学位和美国马里兰大学电子与计算机工程硕士学位。他曾在美国排名前20的对冲基金(Tudor Investment) 和全球大宗商品交易公司集团(RBS Sempra)担任主管架构师和软件开发经理。自2009年归国以来，他先后在三家公司担任首席技术官CTO，其中一家是纳斯达克上市公司。他还在上海联合创立过两家初创公司，并领导技术研发。在领导边界智能之前，奚海峰先生还担任了万向区块链股份公司旗下万云平台的CTO。 +[曹恒](https://www.linkedin.com/in/harrietcao/) 是边界智能的创始人，该公司是一家成立于上海的初创公司。边界智能专注于利用分布式AI技术为区块链提供智能化服务，支持可信高效的行业协作。曹恒是曾获得过2010年美国运筹学和管理学研究协会（INFORMS）颁发的数据分析和人工智能技术领域的“Daniel H. Wagner”大奖。在创立边界智能之前，曹恒在IBM 研究院工作16年，曾担任IBM研究院上海研究院院长，是前IBM全球研究院大数据分析技术带头人。曹恒拥有卡耐基梅隆大学机器人硕士学位和清华大学自动化控制学士学位。 -**Harriet Cao** +**奚海峰** -[Harriet](https://www.linkedin.com/in/harrietcao/) 是边界智能的联合创始人，该公司是一家成立于上海的高科技公司。边界智能专注于利用分布式AI技术为区块链提供智能化服务，支持可信高效的行业协作。曹恒曾获得过2010年美国运筹学和管理学研究协会（INFORMS）颁发的 “Daniel H. Wagner”大奖。在创立边界智能之前，曹恒在IBM 研究院工作16年，曾担任IBM研究院上海研究院院长，是前IBM全球研究院大数据分析技术带头人。曹恒拥有卡耐基梅隆大学机器人硕士学位和清华大学自动化控制学士学位。 +[奚海峰](https://www.linkedin.com/in/haifengxi/) 是高级技术专家和企业家。自2009年从美国归国以来，他曾在三家公司担任首席技术官，其中一家是纳斯达克上市公司。他还在上海联合创立过两家初创公司，并在那里担当技术和工程学的领导角色。奚海峰拥有马里兰大学电子与计算机工程硕士学位，以及清华大学自动化控制硕士和学士学位。 **Jae Kwon** -2005年，[Jae](https://www.linkedin.com/in/yjkwon/)是最具技术前瞻性的跨链项目Cosmos的创始人，也是著名开源区块链项目Tendermint的创始人。Jae 毕业于康奈尔大学计算机科学专业，曾在美国硅谷Alexa/亚马逊（Amazon）等公司担任软件开发工程师，后在Yelp带领移动应用开发团队。Jae也是早期比特币网络开发人员，为解决比特币bug，Jae创建了Tendermint BFT共识算法和Tendermint Core区块链引擎，以在POW之外，创建一个可靠的POS算法。 +2005年，[Jae](https://www.linkedin.com/in/yjkwon/)毕业于康奈尔大学计算机科学学士学位后，曾在硅谷担任软件开发工程师，起先在亚马逊从事Alexa开发工作，后来在Yelp带领移动应用开发团队。Jae在认识到区块链问题后，开发了Tendermint BFT共识算法和Tendermint Core共识引擎。Tendermint是第一个可信的PoS算法。 除了开发Tendermint之外，Jae还是Cosmos的创始人之一。 **陶曲明** @@ -561,10 +561,6 @@ IRIS网络旨在支持所有来自Cosmos网络白名单中的费用通证，例 ### 顾问 -**白硕** - -白硕博士是ChinaLedger技术委员会主任，原上海证券交易所总工程师，他是资深的区块链技术专家。他毕业于北京大学，获理学博士，曾任中科院计算所研究员、博士生导师、软件室主任、软件方向首席科学家。2000年起参与组建国家计算机网络应急技术协调中心（CNCERT/CC）。白硕先生在区块链领域拥有极为丰富的理论研究及技术实践，在金融交易所、联盟链、跨链技术领域都有非常深入的理解。 - **Jim Yang** [Jim Yang](https://www.linkedin.com/in/jimyang/) 是Tendermint首席运营官。 他是ChatX移动信息工作室的创始人兼首席执行官。 ChatX开发了各种移动消息/社交应用程序。 他还共同创立了Identyx并一直担任CEO至被Red Hat收购。 Identyx开发一个开源企业身份管理软件。 @@ -581,13 +577,9 @@ IRIS网络旨在支持所有来自Cosmos网络白名单中的费用通证，例 [Dr. Michael Yuan](http://www.michaelyuan.com) 博士是 [CyberMiles Foundation](https://cm.5miles.com)基金会的负责人。Michael在德克萨斯大学奥斯汀分校获得了天体物理学博士学位。 他编写的5本关于软件开发的书已由Prentice Hall，Addison-Wesley和O'Reilly出版。 Michael是Firefox，Fedora，JBoss等大型开源项目中的活跃代码提交者。 他是企业应用软件和移动软件方面的专家，也是参与了多个由美国政府资助的研究项目。 -**阮宇博** - -[阮宇博](https://www.linkedin.com/in/yubo-ruan/)，天使投资人和基金管理者，八维资本8 Decimal Capital创始人，基金投资了IRISnet,0x、Kyber、本体、Fcoin、Zilliqa、ICON、Wanchian、Bibox、币世界等区块链公司，也是Bluzelle和Gifto顾问；宇博是Skylight Investment的Co-founder，基金投资了20多家优秀的科技公司和金融科技企业。阮宇博有多年企业创办和管理经验，原阿里辛巴CEO，全视之眼创始人，有成功退出经历，获得过全美华裔30位30岁以下优秀创业者。他还是杰出科技人才，有拥有13项国际科技大奖和5项国家专利。Silver Medal Winner, iENA International Inventions Competition, 2012。 -
-## 参考文献################################################################### +## 参考文献 [1]: https://drive.google.com/file/d/1bI7JIOe-CfJ5fPHKxYlFub2Kg-KCGU6r/view?usp=sharing [2]: http://ethdocs.org/en/latest/ diff --git a/docs/zh/resources/README.md b/docs/zh/resources/README.md index 3c1229ee1..ec15572d2 100644 --- a/docs/zh/resources/README.md +++ b/docs/zh/resources/README.md @@ -1 +1,3 @@ -# Resources +# 相关资源 + +本目录将包含与IRISnet有关的资源。 \ No newline at end of file diff --git a/docs/zh/resources/validator-faq.md b/docs/zh/resources/validator-faq.md index 5b1003104..e62b4e6cc 100644 --- a/docs/zh/resources/validator-faq.md +++ b/docs/zh/resources/validator-faq.md @@ -1,3 +1,26 @@ -# FAQ +# Fuxi测试网激励计划常见问题 +1.如何加入Fuxi测试网? + +你可以加入QQ工作群：834063323。团队将在群里及时通知有关测试网的消息。 + +有两种方式加入测试网： +* 以验证人的身份加入：你可以在自己的服务器上部署一个IRIShub节点。然后将其绑定成为一个验证人节点。如果你暂时没有服务器，你也可以申请免费试用BaaS的服务，我们将提供 +Wancloud和Zig-BaaS的免费试用机会。然后你就可以完成测试网的任务了。 + +* 以委托人的身份加入： +如果你对于部署一个验证人节点感到很困难，你可以只下载一个客户端，然后执行相关的测试网的任务交易。 + + +2.测试网的激励任务在哪里? + +每一个测试网迭代中，团队都会发布相关的测试网激励任务。例如，Fuxi-3001测试网激励任务在下面链接中：https://github.com/irisnet/testnets/tree/master/fuxi/fuxi-3001 + +3.怎样能知道我的任务完成情况? + +每当决定切换到下一个测试网的时候，团队会检查参与者的任务完成情况。例如，Fuxi-2000测试网任务完成情况在这里：https://github.com/irisnet/testnets/issues/51 + +4.如果我获得了测试网奖励，何时才能拿到? + +测试网的奖励将在主网上线后发放给社区成员。你需要用你的Keybase签名一个irishub的地址，然后将其发送给团队。 \ No newline at end of file From f60ad178062119f79f5f44d6be93cce3a6fddbb9 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 17:57:35 +0800 Subject: [PATCH 058/100] add chinese gov docs --- docs/cli-client/gov/README.md | 9 +-- docs/zh/cli-client/gov/README.md | 52 ++++++++++++- docs/zh/cli-client/gov/deposit.md | 68 ++++++++++++++++ docs/zh/cli-client/gov/pull-params.md | 87 +++++++++++++++++++++ docs/zh/cli-client/gov/query-deposit.md | 48 ++++++++++++ docs/zh/cli-client/gov/query-deposits.md | 49 ++++++++++++ docs/zh/cli-client/gov/query-params.md | 57 ++++++++++++++ docs/zh/cli-client/gov/query-proposal.md | 65 ++++++++++++++++ docs/zh/cli-client/gov/query-proposals.md | 53 +++++++++++++ docs/zh/cli-client/gov/query-tally.md | 42 ++++++++++ docs/zh/cli-client/gov/query-vote.md | 43 +++++++++++ docs/zh/cli-client/gov/query-votes.md | 44 +++++++++++ docs/zh/cli-client/gov/submit-proposal.md | 94 +++++++++++++++++++++++ docs/zh/cli-client/gov/vote.md | 71 +++++++++++++++++ 14 files changed, 773 insertions(+), 9 deletions(-) create mode 100644 docs/zh/cli-client/gov/deposit.md create mode 100644 docs/zh/cli-client/gov/pull-params.md create mode 100644 docs/zh/cli-client/gov/query-deposit.md create mode 100644 docs/zh/cli-client/gov/query-deposits.md create mode 100644 docs/zh/cli-client/gov/query-params.md create mode 100644 docs/zh/cli-client/gov/query-proposal.md create mode 100644 docs/zh/cli-client/gov/query-proposals.md create mode 100644 docs/zh/cli-client/gov/query-tally.md create mode 100644 docs/zh/cli-client/gov/query-vote.md create mode 100644 docs/zh/cli-client/gov/query-votes.md create mode 100644 docs/zh/cli-client/gov/submit-proposal.md create mode 100644 docs/zh/cli-client/gov/vote.md diff --git a/docs/cli-client/gov/README.md b/docs/cli-client/gov/README.md index 9e1f6f085..d82a1c7c8 100644 --- a/docs/cli-client/gov/README.md +++ b/docs/cli-client/gov/README.md @@ -5,7 +5,7 @@ IRIShub Gov module allows you to submit proposals, vote and query the governance information you care about on the chain: 1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value min_deposit, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches min_deposit, enter voting period. However, if the block-time exceeds max_deposit_period in the deposit period, the proposal will be closed. 2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. -3. More details about voting for proposals: CosmosSDK-Gov-spec +3. More details about voting for proposals: [CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) This module provides the basic functions as described below: 1. On-chain governance proposals on text @@ -49,10 +49,3 @@ iriscli gov [command] | --home | $HOME/.iriscli | [string] directory for config and data | | | --output, -o | text | [string] Output format (text|json) | | | --trace | | print out full stack trace on errors | | - -## Extended description - -1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value `min_deposit`, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches `min_deposit`, enter voting period. However, if the block-time exceeds `max_deposit_period` in the deposit period, the proposal will be closed. -2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. -3. More details about voting for proposals: -[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) \ No newline at end of file diff --git a/docs/zh/cli-client/gov/README.md b/docs/zh/cli-client/gov/README.md index 5083eb47f..9ae9c749f 100644 --- a/docs/zh/cli-client/gov/README.md +++ b/docs/zh/cli-client/gov/README.md @@ -1 +1,51 @@ -# iriscli \ No newline at end of file +# iriscli gov + +## 描述 + +IRIShub Gov模块允许您提交提案，投票和查询您关注的管理信息： +1.任何用户都可以存入一些令牌来发起提案。存款达到一定值min_deposit后，进入投票期，否则将保留存款期。其他人可以在存款期内存入提案。一旦存款总额达到min_deposit，输入投票期。但是，如果冻结时间超过存款期间的max_deposit_period，则提案将被关闭。 +2.进入投票期的提案只能由验证人和委托人投票。未投票的代理人的投票将与其验证人的投票相同，并且投票的代理人的投票将保留。到达“voting_period”时，票数将被计算在内。 +3.关于投票建议的更多细节：[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) + +该模块提供如下所述的基本功能： +1.关于案文的连锁治理提案 +2.关于参数变化的链式治理建议 +3.关于软件升级的链式治理建议 + +## 使用方式 + +```shell +iriscli gov [command] +``` + +## 相关命令 + +| 命令 | 描述 | +| ------------------------------------- | --------------------------------------------------------------- | +| [query-proposal](query-proposal.md) | Query details of a single proposal | +| [query-proposals](query-proposals.md) | query proposals with optional filters | +| [query-vote](query-vote.md) | query vote | +| [query-votes](query-votes.md) | query votes on a proposal | +| [query-deposit](query-deposit.md) | Query details of a deposit | +| [query-deposits](query-deposits.md) | Query deposits on a proposal | +| [query-tally](query-tally.md) | Get the tally of a proposal vote | +| [query-params](query-params.md) | query parameter proposal's config | +| [pull-params](pull-params.md) | generate param.json file | +| [submit-proposal](submit-proposal.md) | Create a new key, or import from seed | +| [deposit](deposit.md) | deposit tokens for activing proposal | +| [vote](vote.md) | vote for an active proposal, options: Yes/No/NoWithVeto/Abstain | + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | ------- | ------------- | -------- | +| --help, -h | | help for gov | | + +## 全局标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------- | -------------------------------------- | -------- | +| --encoding, -e | hex | [string] Binary encoding (hex|b64|btc) | | +| --home | $HOME/.iriscli | [string] directory for config and data | | +| --output, -o | text | [string] Output format (text|json) | | +| --trace | | print out full stack trace on errors | | diff --git a/docs/zh/cli-client/gov/deposit.md b/docs/zh/cli-client/gov/deposit.md new file mode 100644 index 000000000..814b753bf --- /dev/null +++ b/docs/zh/cli-client/gov/deposit.md @@ -0,0 +1,68 @@ +# iriscli gov deposit + +## 描述 + +充值保证金以激活提议 + +## 使用方式 + +``` +iriscli gov deposit [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --deposit | | [string] deposit of proposal | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### 充值保证金 + +```shell +iriscli gov deposit --chain-id=test --proposal-id=1 --deposit=50iris --from=node0 --fee=0.01iris +``` + +输入正确的密码后，你就充值了50个iris用以激活提议的投票状态。 + +```txt +Password to sign with 'node0': +Committed at block 473 (tx hash: 0309E969589F19A9D9E4BFC9479720487FBF929ED6A88824414C5E7E91709206, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:6710 Tags:[{Key:[97 99 116 105 111 110] Value:[100 101 112 111 115 105 116] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 112 111 115 105 116 101 114] Value:[102 97 97 49 52 113 53 114 102 57 115 108 50 100 113 100 50 117 120 114 120 121 107 97 102 120 113 51 110 117 51 108 106 50 102 112 57 108 55 112 103 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 97 108 45 105 100] Value:[49] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 51 51 53 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "deposit", + "completeConsumedTxFee-iris-atto": "\"335500000000000\"", + "depositer": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", + "proposal-id": "1" + } + } +``` + +如何查询保证金充值明细？ + +请点击下述链接： + +[query-deposit](query-deposit.md) + +[query-deposits](query-deposits.md) \ No newline at end of file diff --git a/docs/zh/cli-client/gov/pull-params.md b/docs/zh/cli-client/gov/pull-params.md new file mode 100644 index 000000000..22544447d --- /dev/null +++ b/docs/zh/cli-client/gov/pull-params.md @@ -0,0 +1,87 @@ +# iriscli gov pull-params + +## 描述 + +生成param.json文件 + +## 使用方式 + +``` +iriscli gov pull-params [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --path | $HOME/.iris | [string] directory of iris home | | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### 生成参数文件 + +```shell +iriscli gov pull-params +``` + +执行该指令，你会收到如下提示信息： + +```txt +Save the parameter config file in /Users/trevorfu/.iris/config/params.json +``` + +打开--path/config目录下的params.json文件，你可以看到json格式的文件内容。 + +```txt +{ + "gov": { + "Gov/govDepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000000" + } + ], + "max_deposit_period": "172800000000000" + }, + "Gov/govVotingProcedure": { +: "gov": { + "Gov/govDepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000000" + } + ], + "max_deposit_period": "172800000000000" + }, + "Gov/govVotingProcedure": { + "voting_period": "172800000000000" +: "gov": { + "Gov/govDepositProcedure": { + "min_deposit": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000000" + } + ], + "max_deposit_period": "172800000000000" + }, + "Gov/govVotingProcedure": { + "voting_period": "172800000000000" + }, + "Gov/govTallyingProcedure": { + "threshold": "0.5000000000", + "veto": "0.3340000000", + "participation": "0.6670000000" + } + } +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/gov/query-deposit.md b/docs/zh/cli-client/gov/query-deposit.md new file mode 100644 index 000000000..dd85d2966 --- /dev/null +++ b/docs/zh/cli-client/gov/query-deposit.md @@ -0,0 +1,48 @@ +# iriscli gov query-deposit + +## 描述 + +查询保证金的充值明细 + +## 使用方式 + +``` +iriscli gov query-deposit [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --depositer | | [string] bech32 depositer address | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### 查询充值保证金 + +```shell +iriscli gov query-deposit --chain-id=test --proposal-id=1 --depositer=faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07 +``` + +通过指定提议、指定存款人查询保证金充值详情，得到结果如下： + +```txt +{ + "depositer": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", + "proposal_id": "1", + "amount": [ + { + "denom": "iris-atto", + "amount": "30000000000000000000" + } + ] +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/gov/query-deposits.md b/docs/zh/cli-client/gov/query-deposits.md new file mode 100644 index 000000000..d4b17c789 --- /dev/null +++ b/docs/zh/cli-client/gov/query-deposits.md @@ -0,0 +1,49 @@ +# iriscli gov query-deposits + +## 描述 + +查询指定提议的保证金详细情况 + +## 使用方式 + +``` +iriscli gov query-deposits [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### 查询所有保证金 + +```shell +iriscli gov query-deposits --chain-id=test --proposal-id=1 +``` + +你可以查询到指定提议的所有保证金代币，包括每个存款人的充值详情。 + +```txt +[ + { + "depositer": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", + "proposal_id": "1", + "amount": [ + { + "denom": "iris-atto", + "amount": "35000000000000000000" + } + ] + } +] +``` \ No newline at end of file diff --git a/docs/zh/cli-client/gov/query-params.md b/docs/zh/cli-client/gov/query-params.md new file mode 100644 index 000000000..72a953798 --- /dev/null +++ b/docs/zh/cli-client/gov/query-params.md @@ -0,0 +1,57 @@ +# iriscli gov query-params + +## 描述 + +查询参数型（ParameterChange）提议的配置 + +## 使用方式 + +``` +iriscli gov query-params [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --key | | [string] key name of parameter | | +| --ledger | | Use a connected Ledger device | | +| --module | | [string] module name | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### 通过module查参数 + +```shell +iriscli gov query-params --module=gov +``` + +可以检索得到gov模块的所有键值。 + +```txt +[ + "Gov/govDepositProcedure", + "Gov/govTallyingProcedure", + "Gov/govVotingProcedure" +] +``` + +### 通过key查参数 + +```shell +iriscli gov query-params --key=Gov/govDepositProcedure +``` + +可以得到gov模块中指定键值的参数详情。 + +```txt +{"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"1000000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":""} +``` + +注意：--module和--key参数不能同时为空. \ No newline at end of file diff --git a/docs/zh/cli-client/gov/query-proposal.md b/docs/zh/cli-client/gov/query-proposal.md new file mode 100644 index 000000000..058898b7e --- /dev/null +++ b/docs/zh/cli-client/gov/query-proposal.md @@ -0,0 +1,65 @@ +# iriscli gov query-proposal + +## 描述 + +查询单个提议的详情 + +## 使用方式 + +``` +iriscli gov query-proposal [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### 查询指定的提议 + +```shell +iriscli gov query-proposal --chain-id=test --proposal-id=1 +``` + +查询指定提议的详情，可以得到结果如下： + +```txt +{ + "proposal_id": "1", + "title": "test proposal", + "description": "a new text proposal", + "proposal_type": "Text", + "proposal_status": "DepositPeriod", + "tally_result": { + "yes": "0.0000000000", + "abstain": "0.0000000000", + "no": "0.0000000000", + "no_with_veto": "0.0000000000" + }, + "submit_time": "2018-11-14T09:10:19.365363Z", + "deposit_end_time": "2018-11-16T09:10:19.365363Z", + "total_deposit": [ + { + "denom": "iris-atto", + "amount": "49000000000000000050" + } + ], + "voting_start_time": "0001-01-01T00:00:00Z", + "voting_end_time": "0001-01-01T00:00:00Z", + "param": { + "key": "", + "value": "", + "op": "" + } +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/gov/query-proposals.md b/docs/zh/cli-client/gov/query-proposals.md new file mode 100644 index 000000000..ff3c4a27a --- /dev/null +++ b/docs/zh/cli-client/gov/query-proposals.md @@ -0,0 +1,53 @@ +# iriscli gov query-proposals + +## 描述 + +通过可选项过滤查询满足条件的提议 + +## 使用方式 + +``` +iriscli gov query-proposals [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --depositer | | [string] (optional) filter by proposals deposited on by depositer | | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --limit | | [string] (optional) limit to latest [number] proposals. Defaults to all proposals | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --status | | [string] proposalID of proposal depositing on | | +| --trust-node | true | Don't verify proofs for responses | | +| --voter | | [string] (optional) filter by proposals voted on by voted | | + +## 例子 + +### 查询提议 + +```shell +iriscli gov query-proposals --chain-id=test +``` + +默认查询所有的提议。 + +```txt + 1 - test proposal + 2 - new proposal +``` + +当然这里可以查询指定条件的提议。 + +```shell +gov query-proposals --chain-id=test --depositer=faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd +``` + +可以得到存款人是faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd地址的提议。 +```txt + 2 - new proposal +``` diff --git a/docs/zh/cli-client/gov/query-tally.md b/docs/zh/cli-client/gov/query-tally.md new file mode 100644 index 000000000..4a10bcdcf --- /dev/null +++ b/docs/zh/cli-client/gov/query-tally.md @@ -0,0 +1,42 @@ +# iriscli gov query-tally + +## 描述 + +查询指定提议的投票统计 + +## 使用方式 + +``` +iriscli gov query-tally [flags] +``` + +## 标志 +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### 查询投票统计 + +```shell +iriscli gov query-tally --chain-id=test --proposal-id=1 +``` + +可以查询指定提议每个投票选项的投票统计。 + +```txt +{ + "yes": "100.0000000000", + "abstain": "0.0000000000", + "no": "200.0000000000", + "no_with_veto": "0.0000000000" +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/gov/query-vote.md b/docs/zh/cli-client/gov/query-vote.md new file mode 100644 index 000000000..00ba5daaa --- /dev/null +++ b/docs/zh/cli-client/gov/query-vote.md @@ -0,0 +1,43 @@ +# iriscli gov query-vote + +## 描述 + +查询指定提议、指定投票者的投票情况 + +## 使用方式 + +``` +iriscli gov query-vote [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | +| --voter | | [string] bech32 voter address | Yes | + +## 例子 + +### 查询投票 + +```shell +iriscli gov query-vote --chain-id=test --proposal-id=1 --voter=faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd +``` + +通过指定提议、指定投票者查询投票情况。 + +```txt +{ + "voter": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", + "proposal_id": "1", + "option": "Yes" +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/gov/query-votes.md b/docs/zh/cli-client/gov/query-votes.md new file mode 100644 index 000000000..69280de05 --- /dev/null +++ b/docs/zh/cli-client/gov/query-votes.md @@ -0,0 +1,44 @@ +# iriscli gov query-votes + +## 描述 + +查询指定提议的投票情况 + +## 使用方式 + +``` +iriscli gov query-votes [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --height | | [int] block height to query, omit to get most recent provable block | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### Query votes + +```shell +iriscli gov query-votes --chain-id=test --proposal-id=1 +``` + +通过指定的提议查询该提议所有投票者的投票详情。 + +```txt +[ + { + "voter": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", + "proposal_id": "1", + "option": "Yes" + } +] +``` \ No newline at end of file diff --git a/docs/zh/cli-client/gov/submit-proposal.md b/docs/zh/cli-client/gov/submit-proposal.md new file mode 100644 index 000000000..93ea82d67 --- /dev/null +++ b/docs/zh/cli-client/gov/submit-proposal.md @@ -0,0 +1,94 @@ +# iriscli gov submit-proposal + +## 描述 + +提交区块链治理提议以及发起提议所涉及的初始保证金，其中提议的类型包括Text/ParameterChange/SoftwareUpgrade这三种类型。 + +## 使用方式 + +``` +iriscli gov submit-proposal [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --deposit | | [string] deposit of proposal | | +| --description | | [string] description of proposal | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --key | | the key of parameter | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --op | | [string] the operation of parameter | | +| --param | | [string] parameter of proposal,eg. [{key:key,value:value,op:update}] | | +| --path | | [string] the path of param.json | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --title | | [string] title of proposal | Yes | +| --trust-node | true | Don't verify proofs for responses | | +| --type | | [string] proposalType of proposal,eg:Text/ParameterChange/SoftwareUpgrade | Yes | + +## 例子 + +### 提交一个'Text'类型的提议 + +```shell +iriscli gov submit-proposal --chain-id=test --title="notice proposal" --type=Text --description="a new text proposal" --from=node0 --fee=0.01iris +``` + +输入正确的密码之后，你就完成提交了一个提议，需要注意的是要记下你的提议ID，这是可以检索你的提议的唯一要素。 + +```txt +Password to sign with 'node0': +Committed at block 44 (tx hash: 2C28A87A6262CACEDDB4EBBC60FE989D0DB2B7DEB1EC6795D2F4707DA32C7CBF, response: {Code:0 Data:[49] Log:Msg 0: Info: GasWanted:200000 GasUsed:8091 Tags:[{Key:[97 99 116 105 111 110] Value:[115 117 98 109 105 116 45 112 114 111 112 111 115 97 108] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 101 114] Value:[102 97 97 49 115 108 116 106 120 100 103 107 48 48 115 56 54 50 57 50 122 48 99 110 55 97 53 100 106 99 99 116 54 101 115 115 110 97 118 100 121 122] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 97 108 45 105 100] Value:[49] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 97 114 97 109] Value:[] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 52 48 52 53 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "submit-proposal", + "completeConsumedTxFee-iris-atto": "\"4045500000000000\"", + "param": "", + "proposal-id": "1", + "proposer": "faa1sltjxdgk00s86292z0cn7a5djcct6essnavdyz" + } + } +``` + +### 提交一个'ParameterChange'类型的提议 + +```shell +iriscli gov submit-proposal --chain-id=test --title="update MinDeposit proposal" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --type=ParameterChange --description="a new parameter change proposal" --from=node0 --fee=0.01iris +``` + +提交之后，您完成了提交新的“ParameterChange”提议。 +更改参数的详细信息（通过查询参数获取参数，修改它，然后在“操作”上添加“更新”，使用方案中的更多详细信息）和其他类型的提议字段与文本提议类似。 +注意：在这个例子中, --path 和 --param 不能同时为空。 + +### 提交一个'SoftwareUpgrade'类型的提议 + +```shell +iriscli gov submit-proposal --chain-id=test --title="irishub0.7.0 upgrade proposal" --type=SoftwareUpgrade --description="a new software upgrade proposal" --from=node0 --fee=0.01iris +``` + +在这种场景下，提议的 --title、--type 和--description参数必不可少，另外你也应该保留好提议ID，这是检索所提交提议的唯一方法。 + + +如何查询提议详情？ + +请点击下述链接： + +[query-proposal](query-proposal.md) + +[query-proposals](query-proposals.md) \ No newline at end of file diff --git a/docs/zh/cli-client/gov/vote.md b/docs/zh/cli-client/gov/vote.md new file mode 100644 index 000000000..e5cc0e62f --- /dev/null +++ b/docs/zh/cli-client/gov/vote.md @@ -0,0 +1,71 @@ +# iriscli gov vote + +## 描述 + +给VotingPeriod状态的提议投票, 可选项包括: Yes/No/NoWithVeto/Abstain + +## 使用方式 + +``` +iriscli gov vote [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --help, -h | | help for submit-proposal | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --option | | [string] vote option {Yes, No, NoWithVeto, Abstain} | Yes | +| --print-response | | return tx response (only works with async = false) | | +| --proposal-id | | [string] proposalID of proposal voting on | Yes | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## 例子 + +### 给提议投票 + +```shell +iriscli gov vote --chain-id=test --proposal-id=1 --option=Yes --from node0 --fee=0.01iris +``` + +输入正确的密码之后，你就完成了对于所指定的提议投票。 +注意：验证人和委托人才能对指定提议投票，并且可投票的提议必须是'VotingPeriod'状态。 + +```txt +Vote[Voter:faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd,ProposalID:1,Option:Yes]Password to sign with 'node0': +Committed at block 989 (tx hash: ABDD88AA3CA8F365AC499427477CCE83ADF09D7FC2D62643D0217107E489A483, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:2408 Tags:[{Key:[97 99 116 105 111 110] Value:[118 111 116 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[118 111 116 101 114] Value:[102 97 97 49 52 113 53 114 102 57 115 108 50 100 113 100 50 117 120 114 120 121 107 97 102 120 113 51 110 117 51 108 106 50 102 112 57 108 55 112 103 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[112 114 111 112 111 115 97 108 45 105 100] Value:[49] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 50 48 52 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "vote", + "completeConsumedTxFee-iris-atto": "\"120400000000000\"", + "proposal-id": "1", + "voter": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd" + } + } +``` + +如何查询投票详情？ + +请点击下述链接： + +[query-vote](query-vote.md) + +[query-votes](query-votes.md) + +[query-tally](query-tally.md) \ No newline at end of file From 9a96d2dbfede3f1963a24d02817fc57227f433f1 Mon Sep 17 00:00:00 2001 From: chengwenxi Date: Fri, 16 Nov 2018 10:48:14 +0800 Subject: [PATCH 059/100] IRISHUB-677: client doc of service --- docs/cli-client/service/README.md | 31 ++++++++- docs/cli-client/service/bind.md | 63 +++++++++++++++++ docs/cli-client/service/binding.md | 69 +++++++++++++++++++ docs/cli-client/service/bindings.md | 60 ++++++++++++++++ docs/cli-client/service/define.md | 72 ++++++++++++++++++++ docs/cli-client/service/definition.md | 62 +++++++++++++++++ docs/cli-client/service/disable.md | 57 ++++++++++++++++ docs/cli-client/service/enable.md | 57 ++++++++++++++++ docs/cli-client/service/refund-deposit.md | 57 ++++++++++++++++ docs/cli-client/service/test.proto | 21 ++++++ docs/cli-client/service/update-binding.md | 62 +++++++++++++++++ docs/zh/cli-client/service/README.md | 31 ++++++++- docs/zh/cli-client/service/bind.md | 63 +++++++++++++++++ docs/zh/cli-client/service/binding.md | 68 ++++++++++++++++++ docs/zh/cli-client/service/bindings.md | 59 ++++++++++++++++ docs/zh/cli-client/service/define.md | 72 ++++++++++++++++++++ docs/zh/cli-client/service/definition.md | 62 +++++++++++++++++ docs/zh/cli-client/service/disable.md | 57 ++++++++++++++++ docs/zh/cli-client/service/enable.md | 57 ++++++++++++++++ docs/zh/cli-client/service/refund-deposit.md | 57 ++++++++++++++++ docs/zh/cli-client/service/test.proto | 21 ++++++ docs/zh/cli-client/service/update-binding.md | 62 +++++++++++++++++ 22 files changed, 1218 insertions(+), 2 deletions(-) create mode 100644 docs/cli-client/service/bind.md create mode 100644 docs/cli-client/service/binding.md create mode 100644 docs/cli-client/service/bindings.md create mode 100644 docs/cli-client/service/define.md create mode 100644 docs/cli-client/service/definition.md create mode 100644 docs/cli-client/service/disable.md create mode 100644 docs/cli-client/service/enable.md create mode 100644 docs/cli-client/service/refund-deposit.md create mode 100644 docs/cli-client/service/test.proto create mode 100644 docs/cli-client/service/update-binding.md create mode 100644 docs/zh/cli-client/service/bind.md create mode 100644 docs/zh/cli-client/service/binding.md create mode 100644 docs/zh/cli-client/service/bindings.md create mode 100644 docs/zh/cli-client/service/define.md create mode 100644 docs/zh/cli-client/service/definition.md create mode 100644 docs/zh/cli-client/service/disable.md create mode 100644 docs/zh/cli-client/service/enable.md create mode 100644 docs/zh/cli-client/service/refund-deposit.md create mode 100644 docs/zh/cli-client/service/test.proto create mode 100644 docs/zh/cli-client/service/update-binding.md diff --git a/docs/cli-client/service/README.md b/docs/cli-client/service/README.md index 5083eb47f..62e207bcd 100644 --- a/docs/cli-client/service/README.md +++ b/docs/cli-client/service/README.md @@ -1 +1,30 @@ -# iriscli \ No newline at end of file +# iriscli service + +## Description +Service allows you to define、bind、invocate a service on chain. + +## Usage + +```shell +iriscli service [command] +``` + +## Available Commands + +| Name | Description | +| ------------------------------------ | ----------------------------------------- | +| [define](define.md) | Create a new service definition | +| [definition](definition.md) | Query service definition | +| [bind](bind.md) | Create a new service binding | +| [binding](binding.md) | Query service binding | +| [bindings](bindings.md) | Query service bindings | +| [update-binding](update-binding.md) | Update a service binding | +| [disable](disable.md) | Disable a available service binding | +| [enable](enable.md) | Enable an unavailable service binding | +| [refund-deposit](refund-deposit.md) | Refund all deposit from a service binding | + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | ------- | ---------------- | -------- | +| --help, -h | | help for service | | \ No newline at end of file diff --git a/docs/cli-client/service/bind.md b/docs/cli-client/service/bind.md new file mode 100644 index 000000000..d96d82e7b --- /dev/null +++ b/docs/cli-client/service/bind.md @@ -0,0 +1,63 @@ +# iriscli service bind + +## Description + +Create a new service binding + +## Usage + +``` +iriscli service bind [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --avg-rsp-time | | [int] the average service response time in milliseconds | Yes | +| --bind-type | | [string] type of binding, valid values can be Local and Global | Yes | +| --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | +| --deposit | | [string] deposit of binding | Yes | +| --prices | | [strings] prices of binding, will contains all method | | +| --service-name | | [string] service name | Yes | +| --usable-time | | [int] an integer represents the number of usable service invocations per 10,000 | Yes | +| -h, --help | | help for bind | | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Add a binding to an existing service definition +```shell +iriscli service bind --chain-id=test --from=node0 --fee=0.004iris --service-name=test-service --def-chain-id=test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 +``` + +After that, you're done with adding a binding to an existing service definition. + +```txt +Password to sign with 'node0': +Committed at block 6 (tx hash: 87A477AEA41B22F7294084B4794837211C43A297D73EABA2F42F6436F3D975DD, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5568 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 98 105 110 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 49 49 51 54 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-bind", + "completeConsumedTxFee-iris-atto": "\"111360000000000\"" + } + } +``` + diff --git a/docs/cli-client/service/binding.md b/docs/cli-client/service/binding.md new file mode 100644 index 000000000..60af39649 --- /dev/null +++ b/docs/cli-client/service/binding.md @@ -0,0 +1,69 @@ +# iriscli service binding + +## Description + +Query service binding + +## Usage + +``` +iriscli service binding [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --bind-chain-id | | [string] the ID of the blockchain bond of the service | Yes | +| --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | +| --provider | | [string] bech32 encoded account created the service binding | Yes | +| --service-name | | [string] service name | Yes | +| --help, -h | | help for binding | | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | [int] block height to query | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + + +## Examples + +### Query a service binding + +```shell +iriscli service binding --def-chain-id=test --service-name=test-service --bind-chain-id=test --provider=faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd +``` + +After that, you will get detail info for the service binding. + +```json +{ + "type": "iris-hub/service/SvcBinding", + "value": { + "def_name": "test-service", + "def_chain_id": "test", + "bind_chain_id": "test", + "provider": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "binding_type": "Local", + "deposit": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000000" + } + ], + "price": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000" + } + ], + "level": { + "avg_rsp_time": "10000", + "usable_time": "100" + }, + "available": true, + "disable_height": "0" + } +} +``` \ No newline at end of file diff --git a/docs/cli-client/service/bindings.md b/docs/cli-client/service/bindings.md new file mode 100644 index 000000000..6bde865fe --- /dev/null +++ b/docs/cli-client/service/bindings.md @@ -0,0 +1,60 @@ +# iriscli service bindings + +## Description + +Query service bindings + +## Usage + +``` +iriscli service bindings [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | +| --service-name | | [string] service name | Yes | +| --help, -h | | help for bindings | | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | [int] block height to query | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + + +## Examples + +### Query service binding list + +```shell +iriscli service bindings --def-chain-id=test --service-name=test-service +``` + +After that, you will get a binding list of the service definition. + +```json +[{ + "def_name": "test-service", + "def_chain_id": "test", + "bind_chain_id": "test", + "provider": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "binding_type": "Local", + "deposit": [{ + "denom": "iris-atto", + "amount": "1000000000000000000000" + }], + "price": [{ + "denom": "iris-atto", + "amount": "1000000000000000000" + }], + "level": { + "avg_rsp_time": "10000", + "usable_time": "100" + }, + "available": true, + "disable_height": "0" +}] +``` \ No newline at end of file diff --git a/docs/cli-client/service/define.md b/docs/cli-client/service/define.md new file mode 100644 index 000000000..ccf81ff5d --- /dev/null +++ b/docs/cli-client/service/define.md @@ -0,0 +1,72 @@ +# iriscli service define + +## Description + +Create a new service definition + +## Usage + +``` +iriscli service define [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --service-description | | [string] service description | | +| --author-description | | [string] service author description | | +| --service-name | | [string] service name | Yes | +| --tags | | [strings] service tags | | +| --idl-content | | [string] content of service interface description language | | +| --file | | [string] path of file which contains service interface description language | | +| -h, --help | | help for define | | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### define a service +```shell +iriscli service define --chain-id=test --from=node0 --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags=tag1,tag2 --idl-content= --file=test.proto +``` +Idl-content can be replaced by file if the file item is not empty. [Example of IDL content](#idl-content-example). + +After that, you're done with defining a new service. + +```txt +Password to sign with 'node0': +Committed at block 65 (tx hash: 663B676E453F91BFCDC87B0308910501DD14DF79C88390FC15E06C4CC9612422, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:7968 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 101 102 105 110 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 53 57 51 54 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-define", + "completeConsumedTxFee-iris-atto": "\"159360000000000\"" + } + } +``` + +### IDL content example +* idl-content example + + > syntax = \\"proto3\\";\n\npackage helloworld;\n\n// The greeting service definition.\nservice Greeter {\n //@Attribute description: sayHello\n //@Attribute output_privacy: NoPrivacy\n //@Attribute output_cached: NoCached\n rpc SayHello (HelloRequest) returns (HelloReply) {}\n}\n\n// The request message containing the user's name.\nmessage HelloRequest {\n string name = 1;\n}\n\n// The response message containing the greetings\nmessage HelloReply {\n string message = 1;\n}\n + +* IDL file example + + [test.proto](./test.proto) + diff --git a/docs/cli-client/service/definition.md b/docs/cli-client/service/definition.md new file mode 100644 index 000000000..b532f6ab2 --- /dev/null +++ b/docs/cli-client/service/definition.md @@ -0,0 +1,62 @@ +# iriscli service definition + +## Description + +Query service definition + +## Usage + +``` +iriscli service definition [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | +| --service-name | | [string] service name | Yes | +| --help, -h | | help for definition | | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | [int] block height to query | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + + +## Examples + +### Query a service definition + +```shell +iriscli service definition --def-chain-id=test --service-name=test-service +``` + +After that, you will get detail info for the service definition which has the specfied define chain id and service name. + +```json +{ + "SvcDef": { + "name": "test-service", + "chain_id": "test", + "description": "service-description", + "tags": [ + "tag1", + "tag2" + ], + "author": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "author_description": "author-description", + "idl_content": "syntax = \"proto3\";\n\npackage helloworld;\n\n// The greeting service definition.\nservice Greeter {\n //@Attribute description: sayHello\n //@Attribute output_privacy: NoPrivacy\n //@Attribute output_cached: NoCached\n rpc SayHello (HelloRequest) returns (HelloReply) {}\n}\n\n// The request message containing the user's name.\nmessage HelloRequest {\n string name = 1;\n}\n\n// The response message containing the greetings\nmessage HelloReply {\n string message = 1;\n}\n" + }, + "methods": [ + { + "id": "1", + "name": "SayHello", + "description": "sayHello", + "output_privacy": "NoPrivacy", + "output_cached": "NoCached" + } + ] +} +``` \ No newline at end of file diff --git a/docs/cli-client/service/disable.md b/docs/cli-client/service/disable.md new file mode 100644 index 000000000..8ad4a7d1b --- /dev/null +++ b/docs/cli-client/service/disable.md @@ -0,0 +1,57 @@ +# iriscli service disable + +## Description + +Disable a available service binding + +## Usage + +``` +iriscli service disable [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | +| --service-name | | [string] service name | Yes | +| -h, --help | | help for disable | | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Disable a available service binding +```shell +iriscli service disable --chain-id=test --from=node0 --fee=0.004iris --def-chain-id=test --service-name=test-service +``` + +After that, you're done with disabling a available service binding. + +```txt +Password to sign with 'node0': +Committed at block 537 (tx hash: 66C5EE634339D168A07C073C6BF209D80081762EB8451974ABC33A41914A7158, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:3510 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 105 115 97 98 108 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 48 50 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-disable", + "completeConsumedTxFee-iris-atto": "\"70200000000000\"" + } + } +``` \ No newline at end of file diff --git a/docs/cli-client/service/enable.md b/docs/cli-client/service/enable.md new file mode 100644 index 000000000..4ebece3f1 --- /dev/null +++ b/docs/cli-client/service/enable.md @@ -0,0 +1,57 @@ +# iriscli service enable + +## Description + +Enable an unavailable service binding + +## Usage + +``` +iriscli service enable [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | +| --deposit string | | [string] deposit of binding, will add to the current deposit balance | | +| --service-name | | [string] service name | Yes | +| -h, --help | | help for enable | | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Enable a unavailable service binding +```shell +iriscli service enable --chain-id=test --from=node0 --fee=0.004iris --def-chain-id=test --service-name=test-service +``` + +After that, you're done with Enabling a available service binding. + +```txt +Committed at block 654 (tx hash: CF74E7629F0098AC3295F454F5C15BD5846A1F77C4E6C6FBA551606672B364DD, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5036 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 101 110 97 98 108 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 48 48 55 50 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-enable", + "completeConsumedTxFee-iris-atto": "\"100720000000000\"" + } + } +``` \ No newline at end of file diff --git a/docs/cli-client/service/refund-deposit.md b/docs/cli-client/service/refund-deposit.md new file mode 100644 index 000000000..c7308356e --- /dev/null +++ b/docs/cli-client/service/refund-deposit.md @@ -0,0 +1,57 @@ +# iriscli service refund-deposit + +## Description + +Refund all deposit from a service binding + +## Usage + +``` +iriscli service refund-deposit [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | +| --service-name | | [string] service name | Yes | +| -h, --help | | help for refund-deposit | | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Refund all deposit from an unavailable service binding +```shell +iriscli service refund-deposit --chain-id=test --from=node0 --fee=0.004iris --def-chain-id=test --service-name=test-service +``` + +After that, you're done with refunding all deposit from a service binding. + +```txt +Password to sign with 'node0': +Committed at block 991 (tx hash: 8A7F0EA61AB73A8B241945C8942EC8593774346B36BB70E36E138A23E7A473EE, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:4614 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 114 101 102 117 110 100 45 100 101 112 111 115 105 116] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 57 50 50 56 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-refund-deposit", + "completeConsumedTxFee-iris-atto": "\"92280000000000\"" + } + } +``` \ No newline at end of file diff --git a/docs/cli-client/service/test.proto b/docs/cli-client/service/test.proto new file mode 100644 index 000000000..ccb70ab00 --- /dev/null +++ b/docs/cli-client/service/test.proto @@ -0,0 +1,21 @@ +syntax = "proto3"; + +package helloworld; + +// The greeting service definition. +service Greeter { + //@Attribute description: sayHello + //@Attribute output_privacy: NoPrivacy + //@Attribute output_cached: NoCached + rpc SayHello (HelloRequest) returns (HelloReply) {} +} + +// The request message containing the user's name. +message HelloRequest { + string name = 1; +} + +// The response message containing the greetings +message HelloReply { + string message = 1; +} diff --git a/docs/cli-client/service/update-binding.md b/docs/cli-client/service/update-binding.md new file mode 100644 index 000000000..9cd7108ff --- /dev/null +++ b/docs/cli-client/service/update-binding.md @@ -0,0 +1,62 @@ +# iriscli service update-binding + +## Description + +Update a service binding + +## Usage + +``` +iriscli service update-binding [flags] +``` + +## Flags +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| --avg-rsp-time | | [int] the average service response time in milliseconds | | +| --bind-type | | [string] type of binding, valid values can be Local and Global | | +| --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | +| --deposit | | [string] deposit of binding, will add to the current deposit balance | | +| --prices | | [strings] prices of binding, will contains all method | | +| --service-name | | [string] service name | Yes | +| --usable-time | | [int] an integer represents the number of usable service invocations per 10,000 | | +| -h, --help | | help for update-binding | | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | build an unsigned transaction and write it to STDOUT | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | + +## Examples + +### Update an existing service binding +```shell +iriscli service update-binding --chain-id=test --from=node0 --fee=0.004iris --service-name=test-service --def-chain-id=test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 +``` + +After that, you're done with updating an existing service binding. + +```txt +Password to sign with 'node0': +Committed at block 417 (tx hash: 8C9969A2BF3F7A8C13C2E0B57CE4FD7BE43454280559831D7E39B0FD3C1FCD28, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5042 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 117 112 100 97 116 101 45 98 105 110 100 105 110 103] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 48 48 56 52 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-update-binding", + "completeConsumedTxFee-iris-atto": "\"100840000000000\"" + } + } +``` + diff --git a/docs/zh/cli-client/service/README.md b/docs/zh/cli-client/service/README.md index 5083eb47f..1c48ac1cb 100644 --- a/docs/zh/cli-client/service/README.md +++ b/docs/zh/cli-client/service/README.md @@ -1 +1,30 @@ -# iriscli \ No newline at end of file +# iriscli service + +## 描述 +Service 允许你通过区块链定义、绑定、调用服务。 + +## 用法 + +```shell +iriscli service [command] +``` + +## 相关命令 + +| Name | Description | +| ------------------------------------ | ---------------------- | +| [define](define.md) | 创建一个新的服务定义 | +| [definition](definition.md) | 查询服务定义 | +| [bind](bind.md) | 创建一个新的服务绑定 | +| [binding](binding.md) | 查询服务绑定 | +| [bindings](bindings.md) | 查询服务绑定列表 | +| [update-binding](update-binding.md) | 更新一个存在的服务绑定 | +| [disable](disable.md) | 禁用一个可用的服务绑定 | +| [enable](enable.md) | 启用一个不可用的服务绑定 | +| [refund-deposit](refund-deposit.md) | 取回所有押金 | + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | ------- | ---------------- | -------- | +| --help, -h | | 服务命令帮助 | | \ No newline at end of file diff --git a/docs/zh/cli-client/service/bind.md b/docs/zh/cli-client/service/bind.md new file mode 100644 index 000000000..7aafcc32f --- /dev/null +++ b/docs/zh/cli-client/service/bind.md @@ -0,0 +1,63 @@ +# iriscli service bind + +## 描述 + +创建一个新的服务绑定 + +## 用法 + +``` +iriscli service bind [flags] +``` + +## 标志 + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ---------------------------------------------------------------------------------- | -------- | +| --avg-rsp-time | | [int] 服务平均返回时间的毫秒数表示 | Yes | +| --bind-type | | [string] 对服务是本地还是全局的设置，可选值Local/Global | Yes | +| --def-chain-id | | [string] 定义该服务的区块链ID | Yes | +| --deposit | | [string] 服务提供者的保证金 | Yes | +| --prices | | [strings] 服务定价,按照服务方法排序的定价列表 | | +| --service-name | | [string] 服务名称 | Yes | +| --usable-time | | [int] 每一万次服务调用的可用性的整数表示 | Yes | +| -h, --help | | 绑定命令帮助 | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | 是 | +| --from | | [string] 用来签名的私钥名 | 是 | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 添加服务绑定到已存在的服务定义 +```shell +iriscli service bind --chain-id=test --from=node0 --fee=0.004iris --service-name=test-service --def-chain-id=test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 +``` + +运行成功以后，返回的结果如下: + +```txt +Password to sign with 'node0': +Committed at block 6 (tx hash: 87A477AEA41B22F7294084B4794837211C43A297D73EABA2F42F6436F3D975DD, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5568 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 98 105 110 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 49 49 51 54 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-bind", + "completeConsumedTxFee-iris-atto": "\"111360000000000\"" + } + } +``` + diff --git a/docs/zh/cli-client/service/binding.md b/docs/zh/cli-client/service/binding.md new file mode 100644 index 000000000..c76a8a8ea --- /dev/null +++ b/docs/zh/cli-client/service/binding.md @@ -0,0 +1,68 @@ +# iriscli service binding + +## 描述 + +查询服务绑定 + +## 用法 + +``` +iriscli service binding [flags] +``` + +## 标志 + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ---------------------------------------------------- | -------- | +| --bind-chain-id | | [string] 绑定该服务的区块链ID | 是 | +| --def-chain-id | | [string] 定义该服务的区块链ID | 是 | +| --provider | | [string] 服务提供者的区块链地址(bech32编码) | 是 | +| --service-name | | [string] 服务名称 | 是 | +| --help, -h | | 查询绑定命令帮助 | | +| --chain-id | | [string] tendermint节点的链ID | | +| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | +| --indent | | 在JSON格式的应答中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询服务绑定 + +```shell +iriscli service binding --def-chain-id=test --service-name=test-service --bind-chain-id=test --provider=faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd +``` + +运行成功以后，返回的结果如下: + +```json +{ + "type": "iris-hub/service/SvcBinding", + "value": { + "def_name": "test-service", + "def_chain_id": "test", + "bind_chain_id": "test", + "provider": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "binding_type": "Local", + "deposit": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000000" + } + ], + "price": [ + { + "denom": "iris-atto", + "amount": "1000000000000000000" + } + ], + "level": { + "avg_rsp_time": "10000", + "usable_time": "100" + }, + "available": true, + "disable_height": "0" + } +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/service/bindings.md b/docs/zh/cli-client/service/bindings.md new file mode 100644 index 000000000..5243b8c09 --- /dev/null +++ b/docs/zh/cli-client/service/bindings.md @@ -0,0 +1,59 @@ +# iriscli service bindings + +## 描述 + +查询服务绑定列表 + +## 用法 + +``` +iriscli service bindings [flags] +``` + +## 标志 + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ------------------------------------------------------ | -------- | +| --def-chain-id | | [string] 定义该服务的区块链ID | 是 | +| --service-name | | [string] 服务名称 | 是 | +| --help, -h | | 查询绑定列表命令帮助 | | +| --chain-id | | [string] tendermint节点的链ID | | +| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | +| --indent | | 在JSON格式的应答中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询服务绑定列表 + +```shell +iriscli service bindings --def-chain-id=test --service-name=test-service +``` + +运行成功以后，返回的结果如下: + +```json +[{ + "def_name": "test-service", + "def_chain_id": "test", + "bind_chain_id": "test", + "provider": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "binding_type": "Local", + "deposit": [{ + "denom": "iris-atto", + "amount": "1000000000000000000000" + }], + "price": [{ + "denom": "iris-atto", + "amount": "1000000000000000000" + }], + "level": { + "avg_rsp_time": "10000", + "usable_time": "100" + }, + "available": true, + "disable_height": "0" +}] +``` \ No newline at end of file diff --git a/docs/zh/cli-client/service/define.md b/docs/zh/cli-client/service/define.md new file mode 100644 index 000000000..cb9990934 --- /dev/null +++ b/docs/zh/cli-client/service/define.md @@ -0,0 +1,72 @@ +# iriscli service define + +## 描述 + +创建一个新的服务定义 + +## 用法 + +``` +iriscli service define [flags] +``` + +## 标志 + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | --------------------------------------------------------------------------------- | -------- | +| --service-description | | [string] 服务的描述 | | +| --author-description | | [string] 服务创建者的描述 | | +| --service-name | | [string] 服务名称 | Yes | +| --tags | | [strings] 该服务的关键字 | | +| --idl-content | | [string] 对该服务描述的接口定义语言内容 | | +| --file | | [string] 对该服务描述的接口定义语言内容的文件路径 | | +| -h, --help | | 服务定义命令帮助 | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | 是 | +| --from | | [string] 用来签名的私钥名 | 是 | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 创建一个新的服务定义 +```shell +iriscli service define --chain-id=test --from=node0 --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags=tag1,tag2 --idl-content= --file=test.proto +``` +如果文件项不是空的，将会替换Idl-content. [IDL内容示例](#idl-content-example). + +运行成功以后，返回的结果如下: + +```txt +Password to sign with 'node0': +Committed at block 65 (tx hash: 663B676E453F91BFCDC87B0308910501DD14DF79C88390FC15E06C4CC9612422, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:7968 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 101 102 105 110 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 53 57 51 54 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-define", + "completeConsumedTxFee-iris-atto": "\"159360000000000\"" + } + } +``` + +### IDL内容示例 +* IDL内容示例 + + > syntax = \\"proto3\\";\n\npackage helloworld;\n\n// The greeting service definition.\nservice Greeter {\n //@Attribute description: sayHello\n //@Attribute output_privacy: NoPrivacy\n //@Attribute output_cached: NoCached\n rpc SayHello (HelloRequest) returns (HelloReply) {}\n}\n\n// The request message containing the user's name.\nmessage HelloRequest {\n string name = 1;\n}\n\n// The response message containing the greetings\nmessage HelloReply {\n string message = 1;\n}\n + +* IDL文件示例 + + [test.proto](./test.proto) + diff --git a/docs/zh/cli-client/service/definition.md b/docs/zh/cli-client/service/definition.md new file mode 100644 index 000000000..9c5f13943 --- /dev/null +++ b/docs/zh/cli-client/service/definition.md @@ -0,0 +1,62 @@ +# iriscli service definition + +## 描述 + +查询服务定义 + +## 用法 + +``` +iriscli service definition [flags] +``` + +## 标志 + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ------------------------------------------------------ | -------- | +| --def-chain-id | | [string] 定义该服务的区块链ID | 是 | +| --service-name | | [string] 服务名称 | 是 | +| --help, -h | | 查询定义命令帮助 | | +| --chain-id | | [string] tendermint节点的链ID | | +| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | +| --indent | | 在JSON格式的应答中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + + +## 例子 + +### 查询服务定义 + +```shell +iriscli service definition --def-chain-id=test --service-name=test-service +``` + +运行成功以后，返回的结果如下: + +```json +{ + "SvcDef": { + "name": "test-service", + "chain_id": "test", + "description": "service-description", + "tags": [ + "tag1", + "tag2" + ], + "author": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "author_description": "author-description", + "idl_content": "syntax = \"proto3\";\n\npackage helloworld;\n\n// The greeting service definition.\nservice Greeter {\n //@Attribute description: sayHello\n //@Attribute output_privacy: NoPrivacy\n //@Attribute output_cached: NoCached\n rpc SayHello (HelloRequest) returns (HelloReply) {}\n}\n\n// The request message containing the user's name.\nmessage HelloRequest {\n string name = 1;\n}\n\n// The response message containing the greetings\nmessage HelloReply {\n string message = 1;\n}\n" + }, + "methods": [ + { + "id": "1", + "name": "SayHello", + "description": "sayHello", + "output_privacy": "NoPrivacy", + "output_cached": "NoCached" + } + ] +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/service/disable.md b/docs/zh/cli-client/service/disable.md new file mode 100644 index 000000000..74d71a168 --- /dev/null +++ b/docs/zh/cli-client/service/disable.md @@ -0,0 +1,57 @@ +# iriscli service disable + +## 描述 + +禁用一个可用的服务绑定 + +## 用法 + +``` +iriscli service disable [flags] +``` + +## 标志 + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | --------------------------------------------------------------------------------- | -------- | +| --def-chain-id | | [string] 定义该服务的区块链ID | Yes | +| --service-name | | [string] 服务名称 | Yes | +| -h, --help | | 禁用命令帮助 | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | 是 | +| --from | | [string] 用来签名的私钥名 | 是 | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 禁用一个可用的服务绑定 +```shell +iriscli service disable --chain-id=test --from=node0 --fee=0.004iris --def-chain-id=test --service-name=test-service +``` + +运行成功以后，返回的结果如下: + +```txt +Password to sign with 'node0': +Committed at block 537 (tx hash: 66C5EE634339D168A07C073C6BF209D80081762EB8451974ABC33A41914A7158, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:3510 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 105 115 97 98 108 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 48 50 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-disable", + "completeConsumedTxFee-iris-atto": "\"70200000000000\"" + } + } +``` \ No newline at end of file diff --git a/docs/zh/cli-client/service/enable.md b/docs/zh/cli-client/service/enable.md new file mode 100644 index 000000000..3b60b7a54 --- /dev/null +++ b/docs/zh/cli-client/service/enable.md @@ -0,0 +1,57 @@ +# iriscli service enable + +## 描述 + +启用一个不可用的服务绑定 + +## 用法 + +``` +iriscli service enable [flags] +``` + +## 标志 + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | --------------------------------------------------------------------------------- | -------- | +| --def-chain-id | | [string] 定义该服务的区块链ID | Yes | +| --deposit string | | [string] 绑定押金, 将会增加当前服务绑定押金 | | +| --service-name | | [string] 服务名称 | Yes | +| -h, --help | | 启用命令帮助 | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | 是 | +| --from | | [string] 用来签名的私钥名 | 是 | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 启用一个不可用的服务绑定 +```shell +iriscli service enable --chain-id=test --from=node0 --fee=0.004iris --def-chain-id=test --service-name=test-service +``` + +运行成功以后，返回的结果如下: + +```txt +Committed at block 654 (tx hash: CF74E7629F0098AC3295F454F5C15BD5846A1F77C4E6C6FBA551606672B364DD, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5036 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 101 110 97 98 108 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 48 48 55 50 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-enable", + "completeConsumedTxFee-iris-atto": "\"100720000000000\"" + } + } +``` \ No newline at end of file diff --git a/docs/zh/cli-client/service/refund-deposit.md b/docs/zh/cli-client/service/refund-deposit.md new file mode 100644 index 000000000..835159115 --- /dev/null +++ b/docs/zh/cli-client/service/refund-deposit.md @@ -0,0 +1,57 @@ +# iriscli service refund-deposit + +## 描述 + +取回所有押金 + +## 用法 + +``` +iriscli service refund-deposit [flags] +``` + +## 标志 + +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ---------------------------------------------------------------------------------- | -------- | +| --def-chain-id | | [string] 定义该服务的区块链ID | Yes | +| --service-name | | [string] 服务名称 | Yes | +| -h, --help | | 取回押金命令帮助 | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | 是 | +| --from | | [string] 用来签名的私钥名 | 是 | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 取回所有押金 +```shell +iriscli service refund-deposit --chain-id=test --from=node0 --fee=0.004iris --def-chain-id=test --service-name=test-service +``` + +运行成功以后，返回的结果如下: + +```txt +Password to sign with 'node0': +Committed at block 991 (tx hash: 8A7F0EA61AB73A8B241945C8942EC8593774346B36BB70E36E138A23E7A473EE, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:4614 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 114 101 102 117 110 100 45 100 101 112 111 115 105 116] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 57 50 50 56 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-refund-deposit", + "completeConsumedTxFee-iris-atto": "\"92280000000000\"" + } + } +``` \ No newline at end of file diff --git a/docs/zh/cli-client/service/test.proto b/docs/zh/cli-client/service/test.proto new file mode 100644 index 000000000..ccb70ab00 --- /dev/null +++ b/docs/zh/cli-client/service/test.proto @@ -0,0 +1,21 @@ +syntax = "proto3"; + +package helloworld; + +// The greeting service definition. +service Greeter { + //@Attribute description: sayHello + //@Attribute output_privacy: NoPrivacy + //@Attribute output_cached: NoCached + rpc SayHello (HelloRequest) returns (HelloReply) {} +} + +// The request message containing the user's name. +message HelloRequest { + string name = 1; +} + +// The response message containing the greetings +message HelloReply { + string message = 1; +} diff --git a/docs/zh/cli-client/service/update-binding.md b/docs/zh/cli-client/service/update-binding.md new file mode 100644 index 000000000..3cfe4f8fd --- /dev/null +++ b/docs/zh/cli-client/service/update-binding.md @@ -0,0 +1,62 @@ +# iriscli service update-binding + +## 描述 + +更新一个存在的服务绑定 + +## 用法 + +``` +iriscli service update-binding [flags] +``` + +## 标志 +| Name, shorthand | Default | Description | Required | +| --------------------- | ----------------------- | ---------------------------------------------------------------------------------- | -------- | +| --avg-rsp-time | | [int] 服务平均返回时间的毫秒数表示 | Yes | +| --bind-type | | [string] 对服务是本地还是全局的设置，可选值Local/Global | Yes | +| --def-chain-id | | [string] 定义该服务的区块链ID | Yes | +| --deposit | | [string] 绑定押金, 将会增加当前服务绑定押金 | | +| --prices | | [strings] 服务定价,按照服务方法排序的定价列表 | | +| --service-name | | [string] 服务名称 | Yes | +| --usable-time | | [int] 每一万次服务调用的可用性的整数表示 | Yes | +| -h, --help | | 绑定更新命令帮助 | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | 是 | +| --from | | [string] 用来签名的私钥名 | 是 | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 更新一个存在的服务绑定 +```shell +iriscli service update-binding --chain-id=test --from=node0 --fee=0.004iris --service-name=test-service --def-chain-id=test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 +``` + +运行成功以后，返回的结果如下: + +```txt +Password to sign with 'node0': +Committed at block 417 (tx hash: 8C9969A2BF3F7A8C13C2E0B57CE4FD7BE43454280559831D7E39B0FD3C1FCD28, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5042 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 117 112 100 97 116 101 45 98 105 110 100 105 110 103] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 48 48 56 52 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-update-binding", + "completeConsumedTxFee-iris-atto": "\"100840000000000\"" + } + } +``` + From fed2248ed059bf42678e556a6d243e3f60ce0150 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 18:39:27 +0800 Subject: [PATCH 060/100] add chinese gov docs --- docs/zh/cli-client/keys/README.md | 40 ++++++++++++------- docs/zh/cli-client/keys/add.md | 42 ++++++++++---------- docs/zh/cli-client/keys/delete.md | 37 ++++++++++++++++++ docs/zh/cli-client/keys/list.md | 35 +++++++++++++++++ docs/zh/cli-client/keys/mnemonic.md | 32 ++++++++++++++++ docs/zh/cli-client/keys/new.md | 59 +++++++++++++++++++++++++++++ docs/zh/cli-client/keys/show.md | 36 ++++++++++++++++++ docs/zh/cli-client/keys/update.md | 44 +++++++++++++++++++++ 8 files changed, 290 insertions(+), 35 deletions(-) create mode 100644 docs/zh/cli-client/keys/delete.md create mode 100644 docs/zh/cli-client/keys/list.md create mode 100644 docs/zh/cli-client/keys/mnemonic.md create mode 100644 docs/zh/cli-client/keys/new.md create mode 100644 docs/zh/cli-client/keys/show.md create mode 100644 docs/zh/cli-client/keys/update.md diff --git a/docs/zh/cli-client/keys/README.md b/docs/zh/cli-client/keys/README.md index 410208962..ca0eb1552 100644 --- a/docs/zh/cli-client/keys/README.md +++ b/docs/zh/cli-client/keys/README.md @@ -1,30 +1,42 @@ # iriscli keys -## Description +## 描述 -Keys allows you to manage your local keystore for tendermint. +Keys模块用于管理本地密钥库。 -## Usage +## 使用方式 ```shell iriscli keys [command] ``` -## Available Commands +## 相关命令 -| Name | Description | -| ------------- | ------------------------------------- | -| [add](add.md) | Create a new key, or import from seed | -| list | List all keys | -| show | Show key info for the given name | -| delete | Delete the given key | +| 命令 | 描述 | +| ----------------------- | -------------------------------------------------------------------------------------------- | +| [mnemonic](mnemonic.md) | Create a bip39 mnemonic, sometimes called a seed phrase, by reading from the system entropy. | +| [new](new.md) | Derive a new private key using an interactive command that will prompt you for each input. | +| [add](add.md) | Create a new key, or import from seed | +| [list](list.md) | List all keys | +| [show](show.md) | Show key info for the given name | +| [delete](delete.md) | Delete the given key | +| [update](update.md) | Change the password used to protect private key | -## Flags +## 标志 -| Name, shorthand | Default | Description | Required | +| 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | ------- | ------------- | -------- | | --help, -h | | help for keys | | -## Extended description +## 全局标志 -These keys may be in any format supported by go-crypto and can be used by light-clients, full nodes, or any other application that needs to sign with a private key. +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | -------------- | -------------------------------------- | -------- | +| --encoding, -e | hex | [string] Binary encoding (hex|b64|btc) | | +| --home | $HOME/.iriscli | [string] directory for config and data | | +| --output, -o | text | [string] Output format (text|json) | | +| --trace | | print out full stack trace on errors | | + +## 补充说明 + +这些密钥可以是go-crypto支持的任何格式，并且可以由轻客户端，完整节点或需要使用私钥签名的任何其他应用程序使用。 diff --git a/docs/zh/cli-client/keys/add.md b/docs/zh/cli-client/keys/add.md index 2174b8c7c..a955a9329 100644 --- a/docs/zh/cli-client/keys/add.md +++ b/docs/zh/cli-client/keys/add.md @@ -1,44 +1,44 @@ # iriscli keys add -## Description +## 描述 -Create a new key, or import from seed +创建一个新密钥，或通过密钥种子导入 -## Usage +## 使用方式 ``` iriscli keys add [flags] ``` -## Flags +## 标志 -| Name, shorthand | Default | Description | Required | -| --------------- | --------- | ------------------------------------------------------------ | -------- | -| --account | | [uint32] Account number for HD derivation | | -| --dry-run | | Perform action, but don't add key to local keystore | | -| --help, -h | | help for add | | -| --index | | [uint32] Index number for HD derivation | | -| --ledger | | Store a local reference to a private key on a Ledger device | | +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | --------- | ----------------------------------------------------------------- | -------- | +| --account | | [uint32] Account number for HD derivation | | +| --dry-run | | Perform action, but don't add key to local keystore | | +| --help, -h | | help for add | | +| --index | | [uint32] Index number for HD derivation | | +| --ledger | | Store a local reference to a private key on a Ledger device | | | --no-backup | | Don't print out seed phrase (if others are watching the terminal) | | -| --recover | | Provide seed phrase to recover existing key instead of creating | | -| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | +| --recover | | Provide seed phrase to recover existing key instead of creating | | +| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | -## Examples +## 例子 -### Create a new key +### 创建密钥 ```shell iriscli keys add MyKey ``` -You'll be asked to enter a password for your key, note: password must be at least 8 characters. +执行命令后，系统会要求你输入密钥密码，注意：密码必须至少为8个字符。 ```txt Enter a passphrase for your key: Repeat the passphrase: ``` -After that, you're done with creating a new key, but remember to backup your seed phrase, it is the only way to recover your account if you ever forget your password or lose your key. +之后，你已经完成了创建新密钥的工作，但请记住备份你的助记词短语，如果你不慎忘记密码或丢失了密钥，这是唯一能恢复帐户的方法。 ```txt NAME: TYPE: ADDRESS: PUBKEY: @@ -49,17 +49,17 @@ It is the only way to recover your account if you ever forget your password. oval green shrug term already arena pilot spirit jump gain useful symbol hover grid item concert kiss zero bleak farm capable peanut snack basket ``` -The 24 words above is a seed phrase just for example, **DO NOT** use it in production. +上面的24个字是一个助记词种子短语，例如，**不要**在生产中使用它。 -### Recover an existing key +### 通过密钥种子恢复密钥 -If you forget your password or lose your key, or you wanna use your key in another place, you can recover your key by your seed phrase. +如果你忘记了密码或丢失了密钥，或者你想在其他地方使用密钥，则可以通过种子短语来恢复密钥。 ```txt iriscli keys add MyKey --recover ``` -You'll be asked to enter a new password for your key, and enter the seed phrase. Then you get your key back. +系统会要求你输入并确认密钥的新密码，然后输入种子短语。 这样就恢复了你的密钥。 ```txt Enter a passphrase for your key: diff --git a/docs/zh/cli-client/keys/delete.md b/docs/zh/cli-client/keys/delete.md new file mode 100644 index 000000000..f788182ca --- /dev/null +++ b/docs/zh/cli-client/keys/delete.md @@ -0,0 +1,37 @@ +# iriscli keys delete + +## 描述 + +删除指定的密钥 + +## 使用方式 + +``` +iriscli keys delete [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --help, -h | | help for add | | + +## 例子 + +### 删除指定的密钥 + +```shell +iriscli keys delete MyKey +``` + +执行命令后，你会收到一个危险警告，并且要求你输入密码用于执行删除指令。 + +```txt +DANGER - enter password to permanently delete key: +``` + +输入正确的密码之后，你就完成了删除操作。 + +```txt +Password deleted forever (uh oh!) +``` \ No newline at end of file diff --git a/docs/zh/cli-client/keys/list.md b/docs/zh/cli-client/keys/list.md new file mode 100644 index 000000000..510ef546d --- /dev/null +++ b/docs/zh/cli-client/keys/list.md @@ -0,0 +1,35 @@ +# iriscli keys list + +## 描述 + +返回此密钥管理器存储的所有公钥的列表以及他们的相关名称和地址。 + +## 使用方式 + +``` +iriscli keys list [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --help, -h | | help for add | | + +## 例子 + +### 列出所有的密钥 + +```shell +iriscli keys list +``` + +执行命令后，你会得到所有存于本地客户端存储的密钥，包括它们的地址和公钥信息。 + +```txt +NAME: TYPE: ADDRESS: PUBKEY: +abc local faa1va2eu9qhwn5fx58kvl87x05ee4qrgh44yd8teh fap1addwnpepq02r0hts0yjhp4rsal627s2lqk4agy2g6tek5g9yq2tfrmkkehee2td75cs +test local faa1kkm4w5pvmcw0e3vjcxqtfxwqpm3k0zakl7lxn5 fap1addwnpepq0gsl90v9dgac3r9hzgz53ul5ml5ynq89ax9x8qs5jgv5z5vyssskww57lw +``` + +需要注意的是，如果本地有多个.iriscli存储，需要通过--home 参数来定位查询源。 \ No newline at end of file diff --git a/docs/zh/cli-client/keys/mnemonic.md b/docs/zh/cli-client/keys/mnemonic.md new file mode 100644 index 000000000..25025f3d4 --- /dev/null +++ b/docs/zh/cli-client/keys/mnemonic.md @@ -0,0 +1,32 @@ +# iriscli keys mnemonic + +## 描述 + +通过读取系统熵来创建24个单词组成的bip39助记词，有时称为种子短语。如果需要传递自定义的熵，请使用--unsafe-entropy参数。 + +## 使用方式 + +``` +iriscli keys mnemonic [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| ---------------- | --------- | ----------------------------------------------------------------------------- | -------- | +| --help, -h | | help for add | | +| --unsafe-entropy | | Prompt the user to supply their own entropy, instead of relying on the system | | + +## 例子 + +### 创建指定密钥的助记词 + +```shell +iriscli keys mnemonic MyKey +``` + +执行命令就可以得到24个单词组成的助记词。为了安全考虑，请注意保存，比如将单词手抄纸并将纸张妥善保存。 + +```txt +police possible oval milk network indicate usual blossom spring wasp taste canal announce purpose rib mind river pet brown web response sting remain airport +``` \ No newline at end of file diff --git a/docs/zh/cli-client/keys/new.md b/docs/zh/cli-client/keys/new.md new file mode 100644 index 000000000..592bb4777 --- /dev/null +++ b/docs/zh/cli-client/keys/new.md @@ -0,0 +1,59 @@ +# iriscli keys new + +## 描述 + +使用交互式命令派生新的私钥，该命令将提示您输入每个输入。可选择指定bip39助记符，bip39密码短语以进一步保护助记符，和bip32 HD路径，以获得特定帐户。密钥将以给定名称存储并使用给定的密码加密。这里唯一需要的输入是加密密码。 + +## 使用方式 + +``` +iriscli keys new [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | ----------------- | --------------------------------------------------------------- | -------- | +| --bip44-path | 44'/118'/0'/0/0 | BIP44 path from which to derive a private key | | +| --default | | Skip the prompts and just use the default values for everything | | +| --help, -h | | help for add | | +| --ledger | | Store a local reference to a private key on a Ledger device | | + +## 例子 + +### Create a new key by the specified method + +```shell +iriscli keys new MyKey +``` + +执行命令后，系统提示你输入 bip44 路径, 直接回车的默认值是 44'/118'/0'/0/0. + +```txt +> ------------------------------------- +> Enter your bip44 path. Default is 44'/118'/0'/0/0 +``` + +然后你会被要求输入你的bip39助记词，或者直接敲回车键生成一个。注意保存好助记词。 + +```txt +> Enter your bip39 mnemonic, or hit enter to generate one. +``` + +直接按回车键生成bip39助记符，会显示一个新提示，要求您输入bip39密码。 + +```txt +> ------------------------------------- +> Enter your bip39 passphrase. This is combined with the mnemonic to derive the seed +> Most users should just hit enter to use the default, "" +``` + +你也可以直接回车键跳过，然后你会收到一个输入并确认密码的提示： + +```txt +> ------------------------------------- +> Enter a passphrase to encrypt your key to disk: +> Repeat the passphrase: +``` + +设置密码完成这些步骤，你就创建了一个自定义的密钥。 \ No newline at end of file diff --git a/docs/zh/cli-client/keys/show.md b/docs/zh/cli-client/keys/show.md new file mode 100644 index 000000000..bee5c3b1a --- /dev/null +++ b/docs/zh/cli-client/keys/show.md @@ -0,0 +1,36 @@ +# iriscli keys show + +## 描述 + +查询本地密钥的详细信息 + +## 使用方式 + +``` +iriscli keys show [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| -------------------- | ----------------- | -------------------------------------------------------------- | -------- | +| --address | | output the address only (overrides --output) | | +| --bech | acc | [string] The Bech32 prefix encoding for a key (acc|val|cons) | | +| --help, -h | | help for add | | +| --multisig-threshold | 1 | [uint] K out of N required signatures | | +| --pubkey | | output the public key only (overrides --output) | | + +## 例子 + +### 查询指定密钥 + +```shell +iriscli keys show MyKey +``` + +执行命令后，你会得到本地客户端存储的指定密钥详情。 + +```txt +NAME: TYPE: ADDRESS: PUBKEY: +MyKey local faa1kkm4w5pvmcw0e3vjcxqtfxwqpm3k0zakl7lxn5 fap1addwnpepq0gsl90v9dgac3r9hzgz53ul5ml5ynq89ax9x8qs5jgv5z5vyssskww57lw +``` \ No newline at end of file diff --git a/docs/zh/cli-client/keys/update.md b/docs/zh/cli-client/keys/update.md new file mode 100644 index 000000000..c831a6973 --- /dev/null +++ b/docs/zh/cli-client/keys/update.md @@ -0,0 +1,44 @@ +# iriscli keys update + +## 描述 + +更改用于保护私钥的密码 + +## 使用方式 + +``` +iriscli keys update [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --help, -h | | help for add | | + +## 例子 + +### 修改密码 + +```shell +iriscli keys update MyKey +``` + +执行命令后，系统会要求你输入指定密钥的当前密码。 + +```txt +Enter the current passphrase: +``` + +然后系统会要求你输入新密码并重复输入确认密码。 + +```txt +Enter the new passphrase: +Repeat the new passphrase: +``` + +如果你输入新密码符合要求，则会执行更新操作。 + +```txt +Password successfully updated! +``` \ No newline at end of file From b5af11c107c54c7aec773ce13685fe3b327809b4 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 19:33:35 +0800 Subject: [PATCH 061/100] fix gov doc's problem commented by yelong --- docs/cli-client/gov/README.md | 24 +++++++++--------- docs/cli-client/gov/deposit.md | 16 ++++++------ docs/cli-client/gov/pull-params.md | 6 ++--- docs/cli-client/gov/query-deposit.md | 8 +++--- docs/cli-client/gov/query-deposits.md | 6 ++--- docs/cli-client/gov/query-params.md | 8 +++--- docs/cli-client/gov/query-proposal.md | 8 +++--- docs/cli-client/gov/query-proposals.md | 26 ++++++++++++++------ docs/cli-client/gov/query-tally.md | 6 ++--- docs/cli-client/gov/query-vote.md | 8 +++--- docs/cli-client/gov/query-votes.md | 6 ++--- docs/cli-client/gov/submit-proposal.md | 30 +++++++++++------------ docs/cli-client/gov/vote.md | 18 +++++++------- docs/zh/cli-client/gov/README.md | 27 ++++++++++---------- docs/zh/cli-client/gov/deposit.md | 18 +++++++------- docs/zh/cli-client/gov/pull-params.md | 2 +- docs/zh/cli-client/gov/query-deposit.md | 2 +- docs/zh/cli-client/gov/query-deposits.md | 2 +- docs/zh/cli-client/gov/query-params.md | 2 +- docs/zh/cli-client/gov/query-proposal.md | 2 +- docs/zh/cli-client/gov/query-proposals.md | 2 +- docs/zh/cli-client/gov/query-tally.md | 2 +- docs/zh/cli-client/gov/query-vote.md | 2 +- docs/zh/cli-client/gov/query-votes.md | 2 +- docs/zh/cli-client/gov/submit-proposal.md | 2 +- docs/zh/cli-client/gov/vote.md | 2 +- 26 files changed, 126 insertions(+), 111 deletions(-) diff --git a/docs/cli-client/gov/README.md b/docs/cli-client/gov/README.md index d82a1c7c8..b516e5030 100644 --- a/docs/cli-client/gov/README.md +++ b/docs/cli-client/gov/README.md @@ -2,11 +2,6 @@ ## Description -IRIShub Gov module allows you to submit proposals, vote and query the governance information you care about on the chain: -1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value min_deposit, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches min_deposit, enter voting period. However, if the block-time exceeds max_deposit_period in the deposit period, the proposal will be closed. -2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. -3. More details about voting for proposals: [CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) - This module provides the basic functions as described below: 1. On-chain governance proposals on text 2. On-chain governance proposals on parameter change @@ -23,16 +18,16 @@ iriscli gov [command] | Name | Description | | ------------------------------------- | --------------------------------------------------------------- | | [query-proposal](query-proposal.md) | Query details of a single proposal | -| [query-proposals](query-proposals.md) | query proposals with optional filters | -| [query-vote](query-vote.md) | query vote | -| [query-votes](query-votes.md) | query votes on a proposal | +| [query-proposals](query-proposals.md) | Query proposals with optional filters | +| [query-vote](query-vote.md) | Query vote | +| [query-votes](query-votes.md) | Query votes on a proposal | | [query-deposit](query-deposit.md) | Query details of a deposit | | [query-deposits](query-deposits.md) | Query deposits on a proposal | | [query-tally](query-tally.md) | Get the tally of a proposal vote | -| [query-params](query-params.md) | query parameter proposal's config | -| [pull-params](pull-params.md) | generate param.json file | +| [query-params](query-params.md) | Query parameter proposal's config | +| [pull-params](pull-params.md) | Generate param.json file | | [submit-proposal](submit-proposal.md) | Create a new key, or import from seed | -| [deposit](deposit.md) | deposit tokens for activing proposal | +| [deposit](deposit.md) | Deposit tokens for activing proposal | | [vote](vote.md) | vote for an active proposal, options: Yes/No/NoWithVeto/Abstain | ## Flags @@ -49,3 +44,10 @@ iriscli gov [command] | --home | $HOME/.iriscli | [string] directory for config and data | | | --output, -o | text | [string] Output format (text|json) | | | --trace | | print out full stack trace on errors | | + +## Extended description + +1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value `min_deposit`, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches `min_deposit`, enter voting period. However, if the block-time exceeds `max_deposit_period` in the deposit period, the proposal will be closed. +2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. +3. More details about voting for proposals: +[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) \ No newline at end of file diff --git a/docs/cli-client/gov/deposit.md b/docs/cli-client/gov/deposit.md index f86fd4c62..396c0d885 100644 --- a/docs/cli-client/gov/deposit.md +++ b/docs/cli-client/gov/deposit.md @@ -15,24 +15,24 @@ iriscli gov deposit [flags] | Name, shorthand | Default | Description | Required | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | +| --async | | Broadcast transactions asynchronously | | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --deposit | | [string] deposit of proposal | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --deposit | | [string] Deposit of proposal | Yes | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | | --fee | | [string] Fee to pay along with transaction | Yes | | --from | | [string] Name of private key with which to sign | Yes | | --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | | --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for deposit | | | --indent | | Add indent to JSON response | | -| --json | | return output in json format | | +| --json | | Return output in json format | | | --ledger | | Use a connected Ledger device | | | --memo | | [string] Memo to send along with transaction | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --print-response | | return tx response (only works with async = false) | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | | --sequence | | [int] Sequence number to sign the tx | | | --trust-node | true | Don't verify proofs for responses | | diff --git a/docs/cli-client/gov/pull-params.md b/docs/cli-client/gov/pull-params.md index d54826b00..dd8b5397b 100644 --- a/docs/cli-client/gov/pull-params.md +++ b/docs/cli-client/gov/pull-params.md @@ -15,12 +15,12 @@ iriscli gov pull-params [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for pull-params | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --path | $HOME/.iris | [string] directory of iris home | | +| --path | $HOME/.iris | [string] Directory of iris home | | | --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/gov/query-deposit.md b/docs/cli-client/gov/query-deposit.md index dfee3e40e..6d1e1727d 100644 --- a/docs/cli-client/gov/query-deposit.md +++ b/docs/cli-client/gov/query-deposit.md @@ -15,13 +15,13 @@ iriscli gov query-deposit [flags] | Name, shorthand | Default | Description | Required | | --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --depositer | | [string] bech32 depositer address | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --depositer | | [string] Bech32 depositer address | Yes | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for query-deposit | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | | --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/gov/query-deposits.md b/docs/cli-client/gov/query-deposits.md index 35f540479..e1facd263 100644 --- a/docs/cli-client/gov/query-deposits.md +++ b/docs/cli-client/gov/query-deposits.md @@ -15,12 +15,12 @@ iriscli gov query-deposits [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for query-deposits | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | | --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/gov/query-params.md b/docs/cli-client/gov/query-params.md index b89979ea8..543d400ba 100644 --- a/docs/cli-client/gov/query-params.md +++ b/docs/cli-client/gov/query-params.md @@ -15,12 +15,12 @@ iriscli gov query-params [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for query-params | | | --indent | | Add indent to JSON response | | -| --key | | [string] key name of parameter | | +| --key | | [string] Key name of parameter | | | --ledger | | Use a connected Ledger device | | -| --module | | [string] module name | | +| --module | | [string] Module name | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --trust-node | true | Don't verify proofs for responses | | diff --git a/docs/cli-client/gov/query-proposal.md b/docs/cli-client/gov/query-proposal.md index 91b75ccf7..b77535703 100644 --- a/docs/cli-client/gov/query-proposal.md +++ b/docs/cli-client/gov/query-proposal.md @@ -15,12 +15,12 @@ iriscli gov query-proposal [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for query-proposal | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | | --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -31,7 +31,7 @@ iriscli gov query-proposal [flags] iriscli gov query-proposal --chain-id=test --proposal-id=1 ``` - After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +You could query the details of a specific proposal. ```txt { diff --git a/docs/cli-client/gov/query-proposals.md b/docs/cli-client/gov/query-proposals.md index a0d634eca..9e942d3f8 100644 --- a/docs/cli-client/gov/query-proposals.md +++ b/docs/cli-client/gov/query-proposals.md @@ -15,16 +15,16 @@ iriscli gov query-proposals [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --depositer | | [string] (optional) filter by proposals deposited on by depositer | | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --depositer | | [string] (optional) Filter by proposals deposited on by depositer | | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for query-proposals | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | -| --limit | | [string] (optional) limit to latest [number] proposals. Defaults to all proposals | | +| --limit | | [string] (optional) Limit to latest [number] proposals. Defaults to all proposals | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --status | | [string] proposalID of proposal depositing on | | +| --status | | [string] ProposalID of proposal depositing on | | | --trust-node | true | Don't verify proofs for responses | | -| --voter | | [string] (optional) filter by proposals voted on by voted | | +| --voter | | [string] (optional) Filter by proposals voted on by voted | | ## Examples @@ -34,9 +34,21 @@ iriscli gov query-proposals [flags] iriscli gov query-proposals --chain-id=test ``` - After that, you're done with depositing iris tokens for an activing proposal, and remember to back up your proposal-id, it's the only way to retrieve your proposal. +You could query all the proposals by default. ```txt 1 - test proposal 2 - new proposal +``` + +Also you can query proposal by filters, such as: + +```shell +gov query-proposals --chain-id=test --depositer=faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd +``` + +Finally, here shows the proposal who's depositor address is faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd. + +```txt + 2 - new proposal ``` \ No newline at end of file diff --git a/docs/cli-client/gov/query-tally.md b/docs/cli-client/gov/query-tally.md index a132459b1..ca9c32513 100644 --- a/docs/cli-client/gov/query-tally.md +++ b/docs/cli-client/gov/query-tally.md @@ -14,12 +14,12 @@ iriscli gov query-tally [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for query-tally | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | | --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/gov/query-vote.md b/docs/cli-client/gov/query-vote.md index 52fa62d65..0a05d9b8c 100644 --- a/docs/cli-client/gov/query-vote.md +++ b/docs/cli-client/gov/query-vote.md @@ -15,14 +15,14 @@ iriscli gov query-vote [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for query-vote | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | | --trust-node | true | Don't verify proofs for responses | | -| --voter | | [string] bech32 voter address | Yes | +| --voter | | [string] Bech32 voter address | Yes | ## Examples diff --git a/docs/cli-client/gov/query-votes.md b/docs/cli-client/gov/query-votes.md index 1502b1941..c9834c5d6 100644 --- a/docs/cli-client/gov/query-votes.md +++ b/docs/cli-client/gov/query-votes.md @@ -15,12 +15,12 @@ iriscli gov query-votes [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --height | | [int] Block height to query, omit to get most recent provable block | | +| --help, -h | | Help for query-votes | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | | --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/gov/submit-proposal.md b/docs/cli-client/gov/submit-proposal.md index 2fa1c09a1..10c056aca 100644 --- a/docs/cli-client/gov/submit-proposal.md +++ b/docs/cli-client/gov/submit-proposal.md @@ -15,32 +15,32 @@ iriscli gov submit-proposal [flags] | Name, shorthand | Default | Description | Required | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | +| --async | | Broadcast transactions asynchronously | | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --deposit | | [string] deposit of proposal | | -| --description | | [string] description of proposal | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --deposit | | [string] Deposit of proposal | | +| --description | | [string] Description of proposal | Yes | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | | --fee | | [string] Fee to pay along with transaction | Yes | | --from | | [string] Name of private key with which to sign | Yes | | --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | | --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for submit-proposal | | | --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --key | | the key of parameter | | +| --json | | Return output in json format | | +| --key | | The key of parameter | | | --ledger | | Use a connected Ledger device | | | --memo | | [string] Memo to send along with transaction | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --op | | [string] the operation of parameter | | -| --param | | [string] parameter of proposal,eg. [{key:key,value:value,op:update}] | | -| --path | | [string] the path of param.json | | -| --print-response | | return tx response (only works with async = false) | | +| --op | | [string] The operation of parameter | | +| --param | | [string] Parameter of proposal,eg. [{key:key,value:value,op:update}] | | +| --path | | [string] The path of param.json | | +| --print-response | | Return tx response (only works with async = false) | | | --sequence | | [int] Sequence number to sign the tx | | -| --title | | [string] title of proposal | Yes | +| --title | | [string] Title of proposal | Yes | | --trust-node | true | Don't verify proofs for responses | | -| --type | | [string] proposalType of proposal,eg:Text/ParameterChange/SoftwareUpgrade | Yes | +| --type | | [string] ProposalType of proposal,eg:Text/ParameterChange/SoftwareUpgrade | Yes | ## Examples diff --git a/docs/cli-client/gov/vote.md b/docs/cli-client/gov/vote.md index 066e54399..88e86ba7a 100644 --- a/docs/cli-client/gov/vote.md +++ b/docs/cli-client/gov/vote.md @@ -15,24 +15,24 @@ iriscli gov vote [flags] | Name, shorthand | Default | Description | Required | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | +| --async | | Broadcast transactions asynchronously | | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | | --fee | | [string] Fee to pay along with transaction | Yes | | --from | | [string] Name of private key with which to sign | Yes | | --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | | --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for vote | | | --indent | | Add indent to JSON response | | -| --json | | return output in json format | | +| --json | | Return output in json format | | | --ledger | | Use a connected Ledger device | | | --memo | | [string] Memo to send along with transaction | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --option | | [string] vote option {Yes, No, NoWithVeto, Abstain} | Yes | -| --print-response | | return tx response (only works with async = false) | | -| --proposal-id | | [string] proposalID of proposal voting on | Yes | +| --option | | [string] Vote option {Yes, No, NoWithVeto, Abstain} | Yes | +| --print-response | | Return tx response (only works with async = false) | | +| --proposal-id | | [string] ProposalID of proposal voting on | Yes | | --sequence | | [int] Sequence number to sign the tx | | | --trust-node | true | Don't verify proofs for responses | | diff --git a/docs/zh/cli-client/gov/README.md b/docs/zh/cli-client/gov/README.md index 9ae9c749f..e21b81e0b 100644 --- a/docs/zh/cli-client/gov/README.md +++ b/docs/zh/cli-client/gov/README.md @@ -2,11 +2,6 @@ ## 描述 -IRIShub Gov模块允许您提交提案，投票和查询您关注的管理信息： -1.任何用户都可以存入一些令牌来发起提案。存款达到一定值min_deposit后，进入投票期，否则将保留存款期。其他人可以在存款期内存入提案。一旦存款总额达到min_deposit，输入投票期。但是，如果冻结时间超过存款期间的max_deposit_period，则提案将被关闭。 -2.进入投票期的提案只能由验证人和委托人投票。未投票的代理人的投票将与其验证人的投票相同，并且投票的代理人的投票将保留。到达“voting_period”时，票数将被计算在内。 -3.关于投票建议的更多细节：[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) - 该模块提供如下所述的基本功能： 1.关于案文的连锁治理提案 2.关于参数变化的链式治理建议 @@ -23,17 +18,17 @@ iriscli gov [command] | 命令 | 描述 | | ------------------------------------- | --------------------------------------------------------------- | | [query-proposal](query-proposal.md) | Query details of a single proposal | -| [query-proposals](query-proposals.md) | query proposals with optional filters | -| [query-vote](query-vote.md) | query vote | -| [query-votes](query-votes.md) | query votes on a proposal | +| [query-proposals](query-proposals.md) | Query proposals with optional filters | +| [query-vote](query-vote.md) | Query vote | +| [query-votes](query-votes.md) | Query votes on a proposal | | [query-deposit](query-deposit.md) | Query details of a deposit | | [query-deposits](query-deposits.md) | Query deposits on a proposal | | [query-tally](query-tally.md) | Get the tally of a proposal vote | -| [query-params](query-params.md) | query parameter proposal's config | -| [pull-params](pull-params.md) | generate param.json file | +| [query-params](query-params.md) | Query parameter proposal's config | +| [pull-params](pull-params.md) | Generate param.json file | | [submit-proposal](submit-proposal.md) | Create a new key, or import from seed | -| [deposit](deposit.md) | deposit tokens for activing proposal | -| [vote](vote.md) | vote for an active proposal, options: Yes/No/NoWithVeto/Abstain | +| [deposit](deposit.md) | Deposit tokens for activing proposal | +| [vote](vote.md) | Vote for an active proposal, options: Yes/No/NoWithVeto/Abstain | ## 标志 @@ -43,9 +38,15 @@ iriscli gov [command] ## 全局标志 -| 名称, 速记 | 默认值 | 描述 | 是否必须 | +| 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------- | -------------------------------------- | -------- | | --encoding, -e | hex | [string] Binary encoding (hex|b64|btc) | | | --home | $HOME/.iriscli | [string] directory for config and data | | | --output, -o | text | [string] Output format (text|json) | | | --trace | | print out full stack trace on errors | | + +## 补充描述 + +1.任何用户都可以存入一些令牌来发起提案。存款达到一定值min_deposit后，进入投票期，否则将保留存款期。其他人可以在存款期内存入提案。一旦存款总额达到min_deposit，输入投票期。但是，如果冻结时间超过存款期间的max_deposit_period，则提案将被关闭。 +2.进入投票期的提案只能由验证人和委托人投票。未投票的代理人的投票将与其验证人的投票相同，并且投票的代理人的投票将保留。到达“voting_period”时，票数将被计算在内。 +3.关于投票建议的更多细节：[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) diff --git a/docs/zh/cli-client/gov/deposit.md b/docs/zh/cli-client/gov/deposit.md index 814b753bf..e4132767d 100644 --- a/docs/zh/cli-client/gov/deposit.md +++ b/docs/zh/cli-client/gov/deposit.md @@ -15,24 +15,24 @@ iriscli gov deposit [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | +| --async | | Broadcast transactions asynchronously | | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --deposit | | [string] deposit of proposal | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --deposit | | [string] Deposit of proposal | Yes | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | | --fee | | [string] Fee to pay along with transaction | Yes | | --from | | [string] Name of private key with which to sign | Yes | | --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | | --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for deposit | | | --indent | | Add indent to JSON response | | -| --json | | return output in json format | | +| --json | | Return output in json format | | | --ledger | | Use a connected Ledger device | | | --memo | | [string] Memo to send along with transaction | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | +| --print-response | | Return tx response (only works with async = false) | | +| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | | --sequence | | [int] Sequence number to sign the tx | | | --trust-node | true | Don't verify proofs for responses | | diff --git a/docs/zh/cli-client/gov/pull-params.md b/docs/zh/cli-client/gov/pull-params.md index 22544447d..17332ead9 100644 --- a/docs/zh/cli-client/gov/pull-params.md +++ b/docs/zh/cli-client/gov/pull-params.md @@ -16,7 +16,7 @@ iriscli gov pull-params [flags] | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for pull-params | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/zh/cli-client/gov/query-deposit.md b/docs/zh/cli-client/gov/query-deposit.md index dd85d2966..5d087ee02 100644 --- a/docs/zh/cli-client/gov/query-deposit.md +++ b/docs/zh/cli-client/gov/query-deposit.md @@ -17,7 +17,7 @@ iriscli gov query-deposit [flags] | --chain-id | | [string] Chain ID of tendermint node | Yes | | --depositer | | [string] bech32 depositer address | Yes | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for query-deposit | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/zh/cli-client/gov/query-deposits.md b/docs/zh/cli-client/gov/query-deposits.md index d4b17c789..205d80ec2 100644 --- a/docs/zh/cli-client/gov/query-deposits.md +++ b/docs/zh/cli-client/gov/query-deposits.md @@ -16,7 +16,7 @@ iriscli gov query-deposits [flags] | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for query-deposits | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/zh/cli-client/gov/query-params.md b/docs/zh/cli-client/gov/query-params.md index 72a953798..a24ac1529 100644 --- a/docs/zh/cli-client/gov/query-params.md +++ b/docs/zh/cli-client/gov/query-params.md @@ -16,7 +16,7 @@ iriscli gov query-params [flags] | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for query-params | | | --indent | | Add indent to JSON response | | | --key | | [string] key name of parameter | | | --ledger | | Use a connected Ledger device | | diff --git a/docs/zh/cli-client/gov/query-proposal.md b/docs/zh/cli-client/gov/query-proposal.md index 058898b7e..8419b9717 100644 --- a/docs/zh/cli-client/gov/query-proposal.md +++ b/docs/zh/cli-client/gov/query-proposal.md @@ -16,7 +16,7 @@ iriscli gov query-proposal [flags] | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for query-proposal | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/zh/cli-client/gov/query-proposals.md b/docs/zh/cli-client/gov/query-proposals.md index ff3c4a27a..03dcc4804 100644 --- a/docs/zh/cli-client/gov/query-proposals.md +++ b/docs/zh/cli-client/gov/query-proposals.md @@ -17,7 +17,7 @@ iriscli gov query-proposals [flags] | --chain-id | | [string] Chain ID of tendermint node | Yes | | --depositer | | [string] (optional) filter by proposals deposited on by depositer | | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for query-proposals | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --limit | | [string] (optional) limit to latest [number] proposals. Defaults to all proposals | | diff --git a/docs/zh/cli-client/gov/query-tally.md b/docs/zh/cli-client/gov/query-tally.md index 4a10bcdcf..37c5faab0 100644 --- a/docs/zh/cli-client/gov/query-tally.md +++ b/docs/zh/cli-client/gov/query-tally.md @@ -15,7 +15,7 @@ iriscli gov query-tally [flags] | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for query-tally | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/zh/cli-client/gov/query-vote.md b/docs/zh/cli-client/gov/query-vote.md index 00ba5daaa..d297c2187 100644 --- a/docs/zh/cli-client/gov/query-vote.md +++ b/docs/zh/cli-client/gov/query-vote.md @@ -16,7 +16,7 @@ iriscli gov query-vote [flags] | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for query-vote | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/zh/cli-client/gov/query-votes.md b/docs/zh/cli-client/gov/query-votes.md index 69280de05..b2c6244d2 100644 --- a/docs/zh/cli-client/gov/query-votes.md +++ b/docs/zh/cli-client/gov/query-votes.md @@ -16,7 +16,7 @@ iriscli gov query-votes [flags] | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | | --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for query-votes | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/zh/cli-client/gov/submit-proposal.md b/docs/zh/cli-client/gov/submit-proposal.md index 93ea82d67..40c8a2ed6 100644 --- a/docs/zh/cli-client/gov/submit-proposal.md +++ b/docs/zh/cli-client/gov/submit-proposal.md @@ -26,7 +26,7 @@ iriscli gov submit-proposal [flags] | --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | | --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | | --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for submit-proposal | | | --indent | | Add indent to JSON response | | | --json | | return output in json format | | | --key | | the key of parameter | | diff --git a/docs/zh/cli-client/gov/vote.md b/docs/zh/cli-client/gov/vote.md index e5cc0e62f..af6fe2c9b 100644 --- a/docs/zh/cli-client/gov/vote.md +++ b/docs/zh/cli-client/gov/vote.md @@ -24,7 +24,7 @@ iriscli gov vote [flags] | --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | | --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | | --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for submit-proposal | | +| --help, -h | | Help for vote | | | --indent | | Add indent to JSON response | | | --json | | return output in json format | | | --ledger | | Use a connected Ledger device | | From 2cc7f6fd462ed81514552bfeac10b791ee233d98 Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Fri, 16 Nov 2018 19:50:54 +0800 Subject: [PATCH 062/100] Update stake English docs --- docs/cli-client/stake/delegation.md | 2 +- docs/cli-client/stake/delegations.md | 2 +- docs/cli-client/stake/edit-validator.md | 2 +- docs/cli-client/stake/parameters.md | 2 +- docs/cli-client/stake/pool.md | 2 +- docs/cli-client/stake/redelegation.md | 2 +- docs/cli-client/stake/redelegations-from.md | 2 +- docs/cli-client/stake/redelegations.md | 2 +- docs/cli-client/stake/signing-info.md | 2 +- docs/cli-client/stake/unbonding-delegation.md | 4 ++-- docs/cli-client/stake/unbonding-delegations-from.md | 2 +- docs/cli-client/stake/unbonding-delegations.md | 2 +- docs/cli-client/stake/unjail.md | 2 +- 13 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/cli-client/stake/delegation.md b/docs/cli-client/stake/delegation.md index a792819bd..43d730d07 100644 --- a/docs/cli-client/stake/delegation.md +++ b/docs/cli-client/stake/delegation.md @@ -18,7 +18,7 @@ iriscli stake delegation [flags] | --address-validator | | [string] Bech address of the validator | Yes | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for delegation | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/delegations.md b/docs/cli-client/stake/delegations.md index 16d0e00ea..6fa58df30 100644 --- a/docs/cli-client/stake/delegations.md +++ b/docs/cli-client/stake/delegations.md @@ -24,7 +24,7 @@ iriscli stake delegations [delegator-addr] [flags] ## Examples -### Query a validator +### Query all delegations made from one delegator ```shell iriscli stake delegations DelegatorAddress diff --git a/docs/cli-client/stake/edit-validator.md b/docs/cli-client/stake/edit-validator.md index e5869936a..36dc8c3ce 100644 --- a/docs/cli-client/stake/edit-validator.md +++ b/docs/cli-client/stake/edit-validator.md @@ -31,7 +31,7 @@ iriscli stake edit-validator [flags] | --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignor | | | --generate-only | | Build an unsigned transaction and write it to STDOUT | | | --genesis-format | | Export the transaction in gen-tx format; it implies --generate-only | | -| --help, -h | | Help for create-validator | | +| --help, -h | | Help for edit-validator | | | --identity | | [string] Optional identity signature (ex. UPort or Keybase) | | | --indent | | Add indent to JSON response | | | --ip | | [string] Node's public IP. It takes effect only when used in combination with --genesis-format | | diff --git a/docs/cli-client/stake/parameters.md b/docs/cli-client/stake/parameters.md index 12c5db948..8effa2e49 100644 --- a/docs/cli-client/stake/parameters.md +++ b/docs/cli-client/stake/parameters.md @@ -16,7 +16,7 @@ iriscli stake parameters [flags] | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for parameters | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/pool.md b/docs/cli-client/stake/pool.md index 0887c191d..ed06d79a0 100644 --- a/docs/cli-client/stake/pool.md +++ b/docs/cli-client/stake/pool.md @@ -16,7 +16,7 @@ iriscli stake pool [flags] | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for pool | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/redelegation.md b/docs/cli-client/stake/redelegation.md index 75d3c7d5b..0a20c45b4 100644 --- a/docs/cli-client/stake/redelegation.md +++ b/docs/cli-client/stake/redelegation.md @@ -19,7 +19,7 @@ iriscli stake redelegation [flags] | --address-validator-source | | [string] Bech address of the source validator | Yes | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for redelegation | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/redelegations-from.md b/docs/cli-client/stake/redelegations-from.md index 5428ce3ee..5fcf5b8ab 100644 --- a/docs/cli-client/stake/redelegations-from.md +++ b/docs/cli-client/stake/redelegations-from.md @@ -16,7 +16,7 @@ iriscli stake redelegations-from [operator-addr] [flags] | ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for redelegations-from | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/redelegations.md b/docs/cli-client/stake/redelegations.md index 77c07600f..e5945b41c 100644 --- a/docs/cli-client/stake/redelegations.md +++ b/docs/cli-client/stake/redelegations.md @@ -16,7 +16,7 @@ iriscli stake redelegations [delegator-addr] [flags] | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for redelegations | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/signing-info.md b/docs/cli-client/stake/signing-info.md index f563ad06e..c9bce82d6 100644 --- a/docs/cli-client/stake/signing-info.md +++ b/docs/cli-client/stake/signing-info.md @@ -16,7 +16,7 @@ iriscli stake signing-info [validator-pubkey] [flags] | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for signing-info | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/unbonding-delegation.md b/docs/cli-client/stake/unbonding-delegation.md index b2313ed65..a30824507 100644 --- a/docs/cli-client/stake/unbonding-delegation.md +++ b/docs/cli-client/stake/unbonding-delegation.md @@ -18,7 +18,7 @@ iriscli stake unbonding-delegation [flags] | --address-validator | | [string] Bech address of the validator | Yes | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for unbonding-delegation | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | @@ -30,7 +30,7 @@ iriscli stake unbonding-delegation [flags] ### Query an unbonding-delegation ```shell -iriscli stake unbonding-delegation --address-delegator=faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx --address-validator=fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +iriscli stake unbonding-delegation --address-delegator=DelegatorAddress --address-validator=ValidatorAddress ``` After that, you will get unbonding delegation's detailed info between specified validator and delegator. diff --git a/docs/cli-client/stake/unbonding-delegations-from.md b/docs/cli-client/stake/unbonding-delegations-from.md index 4b65325f0..5723deb24 100644 --- a/docs/cli-client/stake/unbonding-delegations-from.md +++ b/docs/cli-client/stake/unbonding-delegations-from.md @@ -16,7 +16,7 @@ iriscli stake unbonding-delegations-from [operator-addr] [flags] | ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for unbonding-delegations-from | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/unbonding-delegations.md b/docs/cli-client/stake/unbonding-delegations.md index c2b4bf316..9dad2d577 100644 --- a/docs/cli-client/stake/unbonding-delegations.md +++ b/docs/cli-client/stake/unbonding-delegations.md @@ -16,7 +16,7 @@ iriscli stake unbonding-delegations [delegator-addr] [flags] | ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | | | --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | +| --help, -h | | help for unbonding-delegations | | | --indent | | Add indent to JSON response | | | --ledger | | Use a connected Ledger device | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | diff --git a/docs/cli-client/stake/unjail.md b/docs/cli-client/stake/unjail.md index 031f0f58a..566cbe72e 100644 --- a/docs/cli-client/stake/unjail.md +++ b/docs/cli-client/stake/unjail.md @@ -26,7 +26,7 @@ iriscli stake redelegate [flags] | --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically || | --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored || | --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for redelegate | | +| --help, -h | | help for unjail | | | --indent | | Add indent to JSON response | | | --json | | return output in json format | | | --ledger | | Use a connected Ledger device | | From 16fa61d1a8a5a115ae66e1e719dbf7000319182f Mon Sep 17 00:00:00 2001 From: raoyunkun Date: Fri, 16 Nov 2018 19:51:41 +0800 Subject: [PATCH 063/100] Add stake Chinese docs --- docs/zh/cli-client/record/submit.md | 2 +- docs/zh/cli-client/stake/README.md | 42 ++++++++++- docs/zh/cli-client/stake/create-validator.md | 58 +++++++++++++++ docs/zh/cli-client/stake/delegate.md | 59 +++++++++++++++ docs/zh/cli-client/stake/delegation.md | 43 +++++++++++ docs/zh/cli-client/stake/delegations.md | 44 ++++++++++++ docs/zh/cli-client/stake/edit-validator.md | 71 +++++++++++++++++++ docs/zh/cli-client/stake/parameters.md | 40 +++++++++++ docs/zh/cli-client/stake/pool.md | 41 +++++++++++ docs/zh/cli-client/stake/redelegate.md | 63 ++++++++++++++++ docs/zh/cli-client/stake/redelegation.md | 47 ++++++++++++ .../zh/cli-client/stake/redelegations-from.md | 55 ++++++++++++++ docs/zh/cli-client/stake/redelegations.md | 49 +++++++++++++ docs/zh/cli-client/stake/signing-info.md | 37 ++++++++++ docs/zh/cli-client/stake/unbond.md | 62 ++++++++++++++++ .../cli-client/stake/unbonding-delegation.md | 45 ++++++++++++ .../stake/unbonding-delegations-from.md | 52 ++++++++++++++ .../cli-client/stake/unbonding-delegations.md | 46 ++++++++++++ docs/zh/cli-client/stake/unjail.md | 49 +++++++++++++ docs/zh/cli-client/stake/validator.md | 48 +++++++++++++ docs/zh/cli-client/stake/validators.md | 48 +++++++++++++ 21 files changed, 999 insertions(+), 2 deletions(-) create mode 100644 docs/zh/cli-client/stake/create-validator.md create mode 100644 docs/zh/cli-client/stake/delegate.md create mode 100644 docs/zh/cli-client/stake/delegation.md create mode 100644 docs/zh/cli-client/stake/delegations.md create mode 100644 docs/zh/cli-client/stake/edit-validator.md create mode 100644 docs/zh/cli-client/stake/parameters.md create mode 100644 docs/zh/cli-client/stake/pool.md create mode 100644 docs/zh/cli-client/stake/redelegate.md create mode 100644 docs/zh/cli-client/stake/redelegation.md create mode 100644 docs/zh/cli-client/stake/redelegations-from.md create mode 100644 docs/zh/cli-client/stake/redelegations.md create mode 100644 docs/zh/cli-client/stake/signing-info.md create mode 100644 docs/zh/cli-client/stake/unbond.md create mode 100644 docs/zh/cli-client/stake/unbonding-delegation.md create mode 100644 docs/zh/cli-client/stake/unbonding-delegations-from.md create mode 100644 docs/zh/cli-client/stake/unbonding-delegations.md create mode 100644 docs/zh/cli-client/stake/unjail.md create mode 100644 docs/zh/cli-client/stake/validator.md create mode 100644 docs/zh/cli-client/stake/validators.md diff --git a/docs/zh/cli-client/record/submit.md b/docs/zh/cli-client/record/submit.md index 6efd72a65..bd746daea 100644 --- a/docs/zh/cli-client/record/submit.md +++ b/docs/zh/cli-client/record/submit.md @@ -32,7 +32,7 @@ iriscli record submit [flags] | --memo | | [string] 发送交易的备忘录 | | | --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --onchain-data | | [string] 上链数据 | 是 | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | | --sequence | | [int] 用来签名交易的sequence number | | | --trust-node | true | 关闭响应结果校验 | | diff --git a/docs/zh/cli-client/stake/README.md b/docs/zh/cli-client/stake/README.md index 5083eb47f..ea0ce126d 100644 --- a/docs/zh/cli-client/stake/README.md +++ b/docs/zh/cli-client/stake/README.md @@ -1 +1,41 @@ -# iriscli \ No newline at end of file +# iriscli stake + +## 描述 + +权益模块允许你执行权益和验证子命令 + +## 用法 + +```shell +iriscli stake [command] +``` + +## 相关命令 + +| 命令 | 描述 | +| --------------------------------| --------------------------------------------------------------| +| [validator](validator.md) | 查询某个验证者 | +| [validators](validators.md) | 查询所有的验证者 | +| [delegation](delegation.md) | 基于委托者地址和验证者地址的委托查询 | +| [delegations](delegations.md) | 基于委托者地址的所有委托查询 | +| [unbonding-delegation](unbonding-delegation.md) | 基于委托者地址和验证者地址的unbonding-delegation记录查询 | +| [unbonding-delegations](unbonding-delegations.md) | 基于委托者地址的所有unbonding-delegation记录查询 | +| [unbonding-delegations-from](unbonding-delegations-from.md) | 基于验证者地址的所有unbonding-delegation记录查询 | +| [redelegations-from](redelegations-from.md) | 基于某一验证者的所有重新委托查询 | +| [redelegation](redelegation.md) | 基于委托者地址，原源验证者地址和目标验证者地址的重新委托记录查询 | +| [redelegations](redelegations.md) | 基于委托者地址的所有重新委托记录查询 | +| [pool](pool.md) | 查询最新的权益池 | +| [parameters](parameters.md) | 查询最新的权益参数信息 | +| [signing-info](signing-info.md) | 查询验证者签名信息 | +| [create-validator](create-validator.md) | 以自委托的方式创建一个新的验证者 | +| [edit-validator](edit-validator.md) | 编辑已存在的验证者信息 | +| [delegate](delegate.md) | 委托一定代币到某个验证者 | +| [unbond](unbond.md) | 从指定的验证者解绑一定的股份 | +| [redelegate](redelegate.md) | 重新委托一定的token从一个验证者到另一个验证者 | +| [unjail](unjail.md) | 恢复之前由于宕机被惩罚的验证者的身份 | + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | ------- | --------------- | -------- | +| --help, -h | | stake命令帮助 | | diff --git a/docs/zh/cli-client/stake/create-validator.md b/docs/zh/cli-client/stake/create-validator.md new file mode 100644 index 000000000..ffbe89e51 --- /dev/null +++ b/docs/zh/cli-client/stake/create-validator.md @@ -0,0 +1,58 @@ +# iriscli stake create-validator + +## 描述 + +以自委托的方式创建一个新的验证者 + +## 用法 + +``` +iriscli stake create-validator [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] 用来签名交易的accountNumber | | +| --address-delegator | | [string] 委托者bech地址 | | +| --amount | | [string] 绑定的代币数量 | Yes | +| --async | | 是否异步广播交易 | | +| --chain-id | | [string] Tendermint节点的链ID | Yes | +| --commission-max-change-rate | | [string] 最大佣金变化率(每天) | Yes | +| --commission-max-rate | | [string] 最大佣金率 | Yes | +| --commission-rate | | [string] 初始佣金率 | Yes | +| --details | | [string] 可选details | | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --genesis-format | | 以gen-tx的格式导出交易; 其暗含 --generate-only | | +| --help, -h | | create-validator命令帮助 | | +| --identity | | [string] 可选身份签名 (ex. UPort or Keybase) | | +| --indent | | 在JSON响应中添加缩进 | | +| --ip | | [string] N节点的公有IP，仅开启--genesis-format时生效 | | +| --json | | 以json形式输出 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易时的备忘录 | | +| --moniker | | [string] 验证者名字 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --node-id | | [string] 节点ID | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | +| --pubkey | | [string] 验证者的Go-Amino编码的16进制公钥. 对于Ed25519，go-amino的16进制前缀为1624de6220 | Yes | +| --sequence | | [int] 用来签名交易的sequence | | +| --trust-node | true | 关闭响应结果校验 | | +| --website | | [string] 选填的网站 | | + +## 例子 + +### 创建新的验证者 + +```shell +iriscli stake create-validator --chain-id=ChainID --from=KeyName --fee=Fee --pubkey=ValidatorPublicKey --commission-max-change-rate=CommissionMaxChangeRate --commission-max-rate=CommissionMaxRate --commission-rate=CommissionRate --amount=Coins +``` + +运行上述命令之后，你便成功地创建了一个验证者。 diff --git a/docs/zh/cli-client/stake/delegate.md b/docs/zh/cli-client/stake/delegate.md new file mode 100644 index 000000000..bf50ec29d --- /dev/null +++ b/docs/zh/cli-client/stake/delegate.md @@ -0,0 +1,59 @@ +# iriscli stake delegate + +## 描述 + +委托一定代币到某个验证者 + +## 用法 + +``` +iriscli stake delegate [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] 用来签名交易的accountNumber | | +| --address-validator | | [string] 验证者bech地址 | Yes | +| --amount | | [string] 绑定的代币数量 | Yes | +| --async | | 是否异步广播交易 | | +| --chain-id | | [string] Tendermint节点的链ID | Yes | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --help, -h | | delegate命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 以json形式输出 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易时的备忘录 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | +| --sequence int | | [int] 用来签名交易的sequence | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 委托一定代币到某个验证者 + +```shell +iriscli stake delegate --chain-id=ChainID --from=KeyName --fee=Fee --amount=CoinstoBond --address-validator=ValidatorOwnerAddress +``` + +运行成功以后，返回的结果如下： + +```txt +Committed at block 2352 (tx hash: 2069F0453619637EE67EFB0CFC53713AF28A0BB89137DEB4574D8B13E723999B, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:15993 Tags:[{Key:[97 99 116 105 111 110] Value:[100 101 108 101 103 97 116 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 51 108 99 119 110 120 112 121 110 50 101 97 51 115 107 122 109 101 107 54 52 118 118 110 112 57 55 106 115 107 56 113 109 104 108 54 118 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 57 57 54 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "delegate", + "completeConsumedTxFee-iris-atto": "\"7996500000000000\"", + "delegator": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "destination-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd" + } + } +``` diff --git a/docs/zh/cli-client/stake/delegation.md b/docs/zh/cli-client/stake/delegation.md new file mode 100644 index 000000000..85cfc45a2 --- /dev/null +++ b/docs/zh/cli-client/stake/delegation.md @@ -0,0 +1,43 @@ +# iriscli stake delegation + +## 描述 + +基于委托者和验证者地址查询委托交易 + +## 用法 + +``` +iriscli stake delegation [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | +| --address-delegator | | [string] 委托者bech地址 | Yes | +| --address-validator | | [string] 验证者bech地址 | Yes | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | delegation命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询验证者 + +```shell +iriscli stake delegation --address-validator=ValidatorAddress --address-delegator=DelegatorAddress + +``` + +运行成功以后，返回的结果如下： + +```txt +Delegation +Delegator: faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx +Validator: fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +Shares: 0.2000000000Height: 290 +``` diff --git a/docs/zh/cli-client/stake/delegations.md b/docs/zh/cli-client/stake/delegations.md new file mode 100644 index 000000000..e88807e63 --- /dev/null +++ b/docs/zh/cli-client/stake/delegations.md @@ -0,0 +1,44 @@ +# iriscli stake delegations + +## 描述 + +查询某个委托者发起的所有委托记录 + +## 用法 + +``` +iriscli stake delegations [delegator-addr] [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | delegations命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## Examples + +### 查询某个委托者发起的所有委托记录 + +```shell +iriscli stake delegations DelegatorAddress +``` + +运行成功以后，返回的结果如下： + +```json +[ + { + "delegator_addr": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "validator_addr": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", + "shares": "0.2000000000", + "height": "290" + } +] +``` diff --git a/docs/zh/cli-client/stake/edit-validator.md b/docs/zh/cli-client/stake/edit-validator.md new file mode 100644 index 000000000..2c97c6fc6 --- /dev/null +++ b/docs/zh/cli-client/stake/edit-validator.md @@ -0,0 +1,71 @@ +# iriscli stake edit-validator + +## 描述 + +编辑已存在的验证者信息 + +## 用法 + +``` +iriscli stake edit-validator [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] 用来签名交易的accountNumber | | +| --address-delegator | | [string] 委托者bech地址 | | +| --amount | | [string] 绑定的代币数量 | | +| --async | | 是否异步广播交易 | | +| --chain-id | | [string] Tendermint节点的链ID | Yes | +| --commission-max-change-rate | | [string] 最大佣金变化率(每天) | | +| --commission-max-rate | | [string] 最大佣金率 | | +| --commission-rate | | [string] [string] 初始佣金率 | | +| --details | | [string] 可选details | | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --genesis-format | | 以gen-tx的格式导出交易; 其暗含 --generate-only | | +| --help, -h | | edit-validator命令帮助 | | +| --identity | | [string] 可选身份签名 (ex. UPort or Keybase) | | +| --indent | | 在JSON响应中添加缩进 | | +| --ip | | [string] N节点的公有IP，仅开启--genesis-format时生效 | | +| --json | | 以json形式输出 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易时的备忘录 | | +| --moniker | | [string] 验证者名字 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --node-id | | [string] 节点ID | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | +| --pubkey | | [string] 验证者的Go-Amino编码的16进制公钥. 对于Ed25519，go-amino的16进制前缀为1624de6220 | | +| --sequence | | [int] 用来签名交易的sequence | | +| --trust-node | true | 关闭响应结果校验 | | +| --website | | [string] 选填网站 | | + +## 例子 + +### 编辑已存在的验证者信息 + +```shell +iriscli stake edit-validator --from=KeyName --chain-id=ChainID --fee=Fee --memo=YourMemo +``` + +运行成功以后，返回的结果如下： + +```txt +Committed at block 2160 (tx hash: C48CABDA1183B5319003433EB1FDEBE5A626E00BD319F1A84D84B6247E9224D1, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:3540 Tags:[{Key:[97 99 116 105 111 110] Value:[101 100 105 116 45 118 97 108 105 100 97 116 111 114] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[109 111 110 105 107 101 114] Value:[117 98 117 110 116 117 49 56] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[105 100 101 110 116 105 116 121] Value:[] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 55 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "edit-validator", + "completeConsumedTxFee-iris-atto": "\"177000000000000\"", + "destination-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", + "identity": "", + "moniker": "ubuntu18" + } +} +``` diff --git a/docs/zh/cli-client/stake/parameters.md b/docs/zh/cli-client/stake/parameters.md new file mode 100644 index 000000000..e417a5fa2 --- /dev/null +++ b/docs/zh/cli-client/stake/parameters.md @@ -0,0 +1,40 @@ +# iriscli stake parameters + +## 描述 + +查询最新的权益参数信息 + +## 用法 + +``` +iriscli stake parameters [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | parameters命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询最新的权益参数信息 + +```shell +iriscli stake parameters +``` + +运行成功以后，返回的结果如下： + +```txt +Params +Unbonding Time: 10m0s +Max Validators: 100: +Bonded Coin Denomination: iris-atto +``` diff --git a/docs/zh/cli-client/stake/pool.md b/docs/zh/cli-client/stake/pool.md new file mode 100644 index 000000000..cfc034839 --- /dev/null +++ b/docs/zh/cli-client/stake/pool.md @@ -0,0 +1,41 @@ +# iriscli stake pool + +## 描述 + +查询最新的权益池 + +## 用法 + +``` +iriscli stake pool [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | pool命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询最新的权益池 + +```shell +iriscli stake pool +``` + +运行成功以后，返回的结果如下： + +```txt +Pool +Loose Tokens: 49.8289125612 +Bonded Tokens: 100.1800000000 +Token Supply: 150.0089125612 +Bonded Ratio: 0.6678269863 +``` diff --git a/docs/zh/cli-client/stake/redelegate.md b/docs/zh/cli-client/stake/redelegate.md new file mode 100644 index 000000000..db9329b86 --- /dev/null +++ b/docs/zh/cli-client/stake/redelegate.md @@ -0,0 +1,63 @@ +# iriscli stake redelegate + +## 描述 + +重新委托一定的token从一个验证者到另一个验证者 + +## 用法 + +``` +iriscli stake redelegate [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] 用来签名交易的accountNumber | | +| --address-validator-dest | | [string] 目标验证者bech地址 | Yes | +| --address-validator-source | | [string] 源验证者bech地址 | Yes | +| --async | | 是否异步广播交易 | | +| --chain-id | | [string] Tendermint节点的链ID | Yes | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 || +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --help, -h | | redelegate命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 以json形式输出 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易时的备忘录 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | +| --sequence | | [int] 用来签名交易的sequence | | +| --shares-amount | | [string] 指定重新委托给其他验证者的股份 | | +| --shares-percent | | [string] 指定重新委托给其他验证者的股份比例，位于0到1之间的正数 | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 重新委托一定的token从一个验证者到另一个验证者 + +```shell +iriscli stake redelegate --chain-id=ChainID --from=KeyName --fee=Fee --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --shares-percent=SharesPercent +``` + +运行成功以后，返回的结果如下： + +```txt +Committed at block 648 (tx hash: E59EE3C8F04D62DA0F5CFD89AC96402A92A56728692AEA47E8A126CDDA58E44B, response: {Code:0 Data:[11 8 185 204 185 223 5 16 247 169 147 42] Log:Msg 0: Info: GasWanted:200000 GasUsed:29085 Tags:[{Key:[97 99 116 105 111 110] Value:[98 101 103 105 110 45 114 101 100 101 108 101 103 97 116 105 111 110] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 48 115 48 97 114 113 57 107 104 112 108 48 99 102 122 110 103 51 113 103 120 99 120 113 48 110 121 54 104 109 99 57 115 121 116 106 102 107] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[115 111 117 114 99 101 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 100 97 121 117 106 100 102 110 120 106 103 103 100 53 121 100 108 118 118 103 107 101 114 112 50 115 117 112 107 110 116 104 97 106 112 99 104 50] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 104 50 55 120 100 119 54 116 57 108 53 106 103 118 117 110 55 54 113 100 117 52 53 107 103 114 120 57 108 113 101 100 101 56 104 112 99 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[101 110 100 45 116 105 109 101] Value:[11 8 185 204 185 223 5 16 247 169 147 42] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 53 56 49 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "begin-redelegation", + "completeConsumedTxFee-iris-atto": "\"5817000000000000\"", + "delegator": "faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk", + "destination-validator": "fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd", + "end-time": "\u000b\u0008\ufffd̹\ufffd\u0005\u0010\ufffd\ufffd\ufffd*", + "source-validator": "fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2" + } +} +``` diff --git a/docs/zh/cli-client/stake/redelegation.md b/docs/zh/cli-client/stake/redelegation.md new file mode 100644 index 000000000..4d5c07815 --- /dev/null +++ b/docs/zh/cli-client/stake/redelegation.md @@ -0,0 +1,47 @@ +# iriscli stake redelegation + +## 描述 + +基于委托者地址，原源验证者地址和目标验证者地址的重新委托记录查询 + +## 用法 + +``` +iriscli stake redelegation [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --address-delegator | | [string] 委托者bech地址 | Yes | +| --address-validator-dest | | [string] 目标验证者bech地址 | Yes | +| --address-validator-source | | [string] 源验证者bech地址 | Yes | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | redelegation命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询重新委托记录 + +```shell +iriscli stake redelegation --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --address-delegator=DelegatorAddress +``` + +运行成功以后，返回的结果如下： + +```txt +Redelegation +Delegator: faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk +Source Validator: fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2 +Destination Validator: fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd +Creation height: 1130 +Min time to unbond (unix): 2018-11-16 07:22:48.740311064 +0000 UTC +Source shares: 0.1000000000 +Destination shares: 0.1000000000 +``` diff --git a/docs/zh/cli-client/stake/redelegations-from.md b/docs/zh/cli-client/stake/redelegations-from.md new file mode 100644 index 000000000..6d6b9ff7f --- /dev/null +++ b/docs/zh/cli-client/stake/redelegations-from.md @@ -0,0 +1,55 @@ +# iriscli stake redelegations-from + +## 描述 + +基于某一验证者的所有重新委托查询 + +## 用法 + +``` +iriscli stake redelegations-from [operator-addr] [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | redelegations-from命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 基于某一验证者的所有重新委托查询 + +```shell +iriscli stake redelegations-from ValidatorAddress +``` + +运行成功以后，返回的结果如下： + +```json +[ + { + "delegator_addr": "faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk", + "validator_src_addr": "fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2", + "validator_dst_addr": "fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd", + "creation_height": "1130", + "min_time": "2018-11-16T07:22:48.740311064Z", + "initial_balance": { + "denom": "iris-atto", + "amount": "100000000000000000" + }, + "balance": { + "denom": "iris-atto", + "amount": "100000000000000000" + }, + "shares_src": "100000000000000000.0000000000", + "shares_dst": "100000000000000000.0000000000" + } +] +``` diff --git a/docs/zh/cli-client/stake/redelegations.md b/docs/zh/cli-client/stake/redelegations.md new file mode 100644 index 000000000..022597494 --- /dev/null +++ b/docs/zh/cli-client/stake/redelegations.md @@ -0,0 +1,49 @@ +# iriscli stake redelegations + +## 描述 + +基于委托者地址的所有重新委托记录查询 + +## 用法 + +``` +iriscli stake redelegations [delegator-addr] [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | redelegations命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 基于委托者地址的所有重新委托记录查询 + +```shell +iriscli stake redelegations DelegatorAddress +``` + +运行成功以后，返回的结果如下： + +```json +[ + { + "delegator_addr": "faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk", + "validator_src_addr": "fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2", + "validator_dst_addr": "fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd", + "creation_height": "1130", + "min_time": "2018-11-16T07:22:48.740311064Z", + "initial_balance": "0.1iris", + "balance": "0.1iris", + "shares_src": "0.1000000000", + "shares_dst": "0.1000000000" + } +] +``` diff --git a/docs/zh/cli-client/stake/signing-info.md b/docs/zh/cli-client/stake/signing-info.md new file mode 100644 index 000000000..0bd07259f --- /dev/null +++ b/docs/zh/cli-client/stake/signing-info.md @@ -0,0 +1,37 @@ +# iriscli stake signing-info + +## 描述 + +查询验证者签名信息 + +## 用法 + +``` +iriscli stake signing-info [validator-pubkey] [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | signing-info命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询验证者签名信息 + +```shell +iriscli stake signing-info ValidatorPublicKey +``` + +运行成功以后，返回的结果如下： + +```txt +Start height: 0, index offset: 2136, jailed until: 1970-01-01 00:00:00 +0000 UTC, missed blocks counter: 0 +``` diff --git a/docs/zh/cli-client/stake/unbond.md b/docs/zh/cli-client/stake/unbond.md new file mode 100644 index 000000000..0bd1dcc2d --- /dev/null +++ b/docs/zh/cli-client/stake/unbond.md @@ -0,0 +1,62 @@ +# iriscli stake unbond + +## 描述 + +从指定的验证者解绑一定的股份 + +## 用法 + +``` +iriscli stake unbond [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------- | -------- | +| --account-number | | [int] 用来签名交易的accountNumber | | +| --address-validator | | [string] 验证者bech地址 | Yes | +| --async | | 是否异步广播交易 | | +| --chain-id | | [string] Tendermint节点的链ID | Yes | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --help, -h | | unbond命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 以json形式输出 | | +| --ledger | | 使用连接的硬件记账设 | | +| --memo | | [string] 发送交易时的备忘录 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | +| --sequence | | [int] 用来签名交易的sequence | | +| --shares-amount | | [string] 指定解绑的股份数 | | +| --shares-percent | | [string] 指定解绑的股份比例，为0到1之间的正数 | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 从指定的验证者解绑一定的股份 + +```shell +iriscli stake unbond --address-validator=ValidatorAddress --shares-percent=SharePercent --from=UnbondInitiator --chain-id=ChainID --fee=Fee +``` + +运行成功以后，返回的结果如下： + +```txt +Committed at block 851 (tx hash: A82833DE51A4127BD5D60E7F9E4CD5895F97B1B54241BCE272B68698518D9D2B, response: {Code:0 Data:[11 8 230 225 179 223 5 16 249 233 245 21] Log:Msg 0: Info: GasWanted:200000 GasUsed:16547 Tags:[{Key:[97 99 116 105 111 110] Value:[98 101 103 105 110 45 117 110 98 111 110 100 105 110 103] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 51 108 99 119 110 120 112 121 110 50 101 97 51 115 107 122 109 101 107 54 52 118 118 110 112 57 55 106 115 107 56 113 109 104 108 54 118 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[115 111 117 114 99 101 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[101 110 100 45 116 105 109 101] Value:[11 8 230 225 179 223 5 16 249 233 245 21] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 56 50 55 51 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "begin-unbonding", + "completeConsumedTxFee-iris-atto": "\"8273500000000000\"", + "delegator": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "end-time": "\u000b\u0008\ufffd\ufffd\ufffd\ufffd\u0005\u0010\ufffd\ufffd\ufffd\u0015", + "source-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd" + } + } + +``` diff --git a/docs/zh/cli-client/stake/unbonding-delegation.md b/docs/zh/cli-client/stake/unbonding-delegation.md new file mode 100644 index 000000000..fcd74b018 --- /dev/null +++ b/docs/zh/cli-client/stake/unbonding-delegation.md @@ -0,0 +1,45 @@ +# iriscli stake unbonding-delegation + +## 描述 + +基于委托者地址和验证者地址的unbonding-delegation记录查询 + +## 用法 + +``` +iriscli stake unbonding-delegation [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --address-delegator | | [string] 委托者bech地址 | Yes | +| --address-validator | | [string] 验证者bech地址 | Yes | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | unbonding-delegation命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + + +## 例子 + +### 查询unbonding-delegation + +```shell +iriscli stake unbonding-delegation --address-delegator=DelegatorAddress --address-validator=ValidatorAddress +``` + +运行成功以后，返回的结果如下： + +```txt +Unbonding Delegation +Delegator: faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx +Validator: fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +Creation height: 1310 +Min time to unbond (unix): 2018-11-15 06:24:22.754703377 +0000 UTC +Expected balance: 0.02iris +``` diff --git a/docs/zh/cli-client/stake/unbonding-delegations-from.md b/docs/zh/cli-client/stake/unbonding-delegations-from.md new file mode 100644 index 000000000..2e2ba849f --- /dev/null +++ b/docs/zh/cli-client/stake/unbonding-delegations-from.md @@ -0,0 +1,52 @@ +# iriscli stake unbonding-delegations-from + +## 描述 + +基于验证者地址的所有unbonding-delegation记录查询 + +## 用法 + +``` +iriscli stake unbonding-delegations-from [operator-addr] [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | unbonding-delegations-from命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 基于验证者地址的所有unbonding-delegation记录查询 + +```shell +iriscli stake unbonding-delegations ValidatorAddress +``` + +运行成功以后，返回的结果如下： + +```json +[ + { + "delegator_addr": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "validator_addr": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", + "creation_height": "1310", + "min_time": "2018-11-15T06:24:22.754703377Z", + "initial_balance": { + "denom": "iris-atto", + "amount": "20000000000000000" + }, + "balance": { + "denom": "iris-atto", + "amount": "20000000000000000" + } + } +] +``` diff --git a/docs/zh/cli-client/stake/unbonding-delegations.md b/docs/zh/cli-client/stake/unbonding-delegations.md new file mode 100644 index 000000000..afc64451f --- /dev/null +++ b/docs/zh/cli-client/stake/unbonding-delegations.md @@ -0,0 +1,46 @@ +# iriscli stake unbonding-delegations + +## 描述 + +基于委托者地址的所有unbonding-delegation记录查询 + +## 用法 + +``` +iriscli stake unbonding-delegations [delegator-addr] [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | unbonding-delegations命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询unbonding-delegation + +```shell +iriscli stake unbonding-delegations DelegatorAddress +``` + +运行成功以后，返回的结果如下： + +```json +[ + { + "delegator_addr": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", + "validator_addr": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", + "creation_height": "1310", + "min_time": "2018-11-15T06:24:22.754703377Z", + "initial_balance": "0.02iris", + "balance": "0.02iris" + } +] +``` diff --git a/docs/zh/cli-client/stake/unjail.md b/docs/zh/cli-client/stake/unjail.md new file mode 100644 index 000000000..24eec0434 --- /dev/null +++ b/docs/zh/cli-client/stake/unjail.md @@ -0,0 +1,49 @@ +# iriscli stake unjail + +## 描述 + +恢复之前由于宕机被惩罚的验证者的身份 + +## 用法 + +``` +iriscli stake redelegate [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | +| --account-number | | [int] 用来签名交易的accountNumber | | +| --address-validator-dest | | [string] 目标验证者bech地址 | | +| --address-validator-source | | [string] 源验证者bech地址 | | +| --async | | 是否异步广播交易 | | +| --chain-id | | [string] Tendermint节点的链ID | Yes | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 || +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --help, -h | | unjail命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 以json形式输出 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易时的备忘录 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | +| --sequence int | | [int] 用来签名交易的sequence | | +| --shares-amount | | [string] 指定恢复验证者身份是的股份 | | +| --shares-percent | | [string] 指定恢复验证者身份是的股份比，为0到1之间的正数 | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 恢复之前由于宕机被惩罚的验证者的身份 + +```shell +iriscli stake unjail --from=KeyName --fee=Fee --chain-id=ChainID +``` + +执行完成以后，你成功地恢复了指定的验证者的身份。 diff --git a/docs/zh/cli-client/stake/validator.md b/docs/zh/cli-client/stake/validator.md new file mode 100644 index 000000000..1c85223ec --- /dev/null +++ b/docs/zh/cli-client/stake/validator.md @@ -0,0 +1,48 @@ +# iriscli stake validator + +## 描述 + +查询验证者 + +## 用法 + +``` +iriscli stake validator [owner-addr] [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | validator命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +### 查询验证者 + +```shell +iriscli stake validator YourValidatorOwnerAddress +``` + +运行成功以后，返回的结果如下： + +```txt +Validator +Operator Address: fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +Validator Consensus Pubkey: fvp1zcjduepq47906n2zvq597vwyqdc0h35ve0fcl64hwqs9xw5fg67zj4g658aqyuhepj +Jailed: false +Status: Bonded +Tokens: 100.0000000000 +Delegator Shares: 100.0000000000 +Description: {node0 } +Bond Height: 0 +Unbonding Height: 0 +Minimum Unbonding Time: 1970-01-01 00:00:00 +0000 UTC +Commission: {{0.0000000000 0.0000000000 0.0000000000 0001-01-01 00:00:00 +0000 UTC}} +``` diff --git a/docs/zh/cli-client/stake/validators.md b/docs/zh/cli-client/stake/validators.md new file mode 100644 index 000000000..47b53758e --- /dev/null +++ b/docs/zh/cli-client/stake/validators.md @@ -0,0 +1,48 @@ +# iriscli stake validators + +## 描述 + +查询所有验证者 + +## 用法 + +``` +iriscli stake validators [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | +| --chain-id | | [string] Tendermint节点的链ID | | +| --height | 最新的可证明区块高度 | 查询的区块高度 | | +| --help, -h | | validators命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## E例子 + +### 查询验证者 + +```shell +iriscli stake validators +``` + +运行成功以后，返回的结果如下： + +```txt +Validator +Operator Address: fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd +Validator Consensus Pubkey: fvp1zcjduepq47906n2zvq597vwyqdc0h35ve0fcl64hwqs9xw5fg67zj4g658aqyuhepj +Jailed: false +Status: Bonded +Tokens: 100.0000000000 +Delegator Shares: 100.0000000000 +Description: {node0 } +Bond Height: 0 +Unbonding Height: 0 +Minimum Unbonding Time: 1970-01-01 00:00:00 +0000 UTC +Commission: {{0.0000000000 0.0000000000 0.0000000000 0001-01-01 00:00:00 +0000 UTC}} +``` From e6fb8cf7cf2d6354955897ff3fb2c458e14e7a94 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 19:41:15 +0800 Subject: [PATCH 064/100] fix keys doc's problem commented by yelong --- docs/zh/cli-client/keys/add.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/zh/cli-client/keys/add.md b/docs/zh/cli-client/keys/add.md index a955a9329..dbe43e449 100644 --- a/docs/zh/cli-client/keys/add.md +++ b/docs/zh/cli-client/keys/add.md @@ -2,7 +2,7 @@ ## 描述 -创建一个新密钥，或通过密钥种子导入 +创建一个新密钥，或通过助记词导入已有密钥 ## 使用方式 @@ -49,17 +49,17 @@ It is the only way to recover your account if you ever forget your password. oval green shrug term already arena pilot spirit jump gain useful symbol hover grid item concert kiss zero bleak farm capable peanut snack basket ``` -上面的24个字是一个助记词种子短语，例如，**不要**在生产中使用它。 +上面24个单词只是助记词的示例，**不要**在生产环境中使用。 -### 通过密钥种子恢复密钥 +### 通过助记词恢复密钥 -如果你忘记了密码或丢失了密钥，或者你想在其他地方使用密钥，则可以通过种子短语来恢复密钥。 +如果你忘记了密码或丢失了密钥，或者你想在其他地方使用密钥，则可以通过助记词短语来恢复。 ```txt iriscli keys add MyKey --recover ``` -系统会要求你输入并确认密钥的新密码，然后输入种子短语。 这样就恢复了你的密钥。 +系统会要求你输入并确认密钥的新密码，然后输入助记词。这样就能恢复你的密钥。 ```txt Enter a passphrase for your key: From 8a0516ca3410e0484b1b840013eb5247de708bcf Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 20:05:06 +0800 Subject: [PATCH 065/100] modify chinese description --- docs/zh/cli-client/keys/README.md | 14 +++++++------- docs/zh/cli-client/keys/add.md | 16 ++++++++-------- docs/zh/cli-client/keys/delete.md | 2 +- docs/zh/cli-client/keys/list.md | 2 +- docs/zh/cli-client/keys/mnemonic.md | 4 ++-- docs/zh/cli-client/keys/new.md | 8 ++++---- docs/zh/cli-client/keys/show.md | 8 ++++---- docs/zh/cli-client/keys/update.md | 2 +- 8 files changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/zh/cli-client/keys/README.md b/docs/zh/cli-client/keys/README.md index ca0eb1552..b3429a3ec 100644 --- a/docs/zh/cli-client/keys/README.md +++ b/docs/zh/cli-client/keys/README.md @@ -14,13 +14,13 @@ iriscli keys [command] | 命令 | 描述 | | ----------------------- | -------------------------------------------------------------------------------------------- | -| [mnemonic](mnemonic.md) | Create a bip39 mnemonic, sometimes called a seed phrase, by reading from the system entropy. | -| [new](new.md) | Derive a new private key using an interactive command that will prompt you for each input. | -| [add](add.md) | Create a new key, or import from seed | -| [list](list.md) | List all keys | -| [show](show.md) | Show key info for the given name | -| [delete](delete.md) | Delete the given key | -| [update](update.md) | Change the password used to protect private key | +| [mnemonic](mnemonic.md) | 通过读取系统熵来创建bip39助记词，也可以称为种子短语。 | +| [new](new.md) | 使用交互式命令派生新的私钥，该命令将提示你每个输入。 | +| [add](add.md) | 创建新密钥，或从助记词导入已有密钥 | +| [list](list.md) | 列出所有密钥 | +| [show](show.md) | 显示指定名称的关键信息 | +| [delete](delete.md) | 删除指定的密钥 | +| [update](update.md) | 更改用于保护私钥的密码 | ## 标志 diff --git a/docs/zh/cli-client/keys/add.md b/docs/zh/cli-client/keys/add.md index dbe43e449..654798a70 100644 --- a/docs/zh/cli-client/keys/add.md +++ b/docs/zh/cli-client/keys/add.md @@ -14,14 +14,14 @@ iriscli keys add [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | --------- | ----------------------------------------------------------------- | -------- | -| --account | | [uint32] Account number for HD derivation | | -| --dry-run | | Perform action, but don't add key to local keystore | | -| --help, -h | | help for add | | -| --index | | [uint32] Index number for HD derivation | | -| --ledger | | Store a local reference to a private key on a Ledger device | | -| --no-backup | | Don't print out seed phrase (if others are watching the terminal) | | -| --recover | | Provide seed phrase to recover existing key instead of creating | | -| --type, -t | secp256k1 | [string] Type of private key (secp256k\|ed25519) | | +| --account | | [uint32] HD推导的账号 | | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --help, -h | | 查询命令帮助 | | +| --index | | [uint32] HD推导的索引号 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --no-backup | | 不输出助记词（如果其他人正在看着操作终端） | | +| --recover | | 提供助记词以恢复现有密钥而不是新建 | | +| --type, -t | secp256k1 | [string] 私钥类型 (secp256k\|ed25519) | | ## 例子 diff --git a/docs/zh/cli-client/keys/delete.md b/docs/zh/cli-client/keys/delete.md index f788182ca..fa74acd64 100644 --- a/docs/zh/cli-client/keys/delete.md +++ b/docs/zh/cli-client/keys/delete.md @@ -14,7 +14,7 @@ iriscli keys delete [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | --------- | ------------------------------------------------------------ | -------- | -| --help, -h | | help for add | | +| --help, -h | | 查询命令帮助 | | ## 例子 diff --git a/docs/zh/cli-client/keys/list.md b/docs/zh/cli-client/keys/list.md index 510ef546d..ed0e1b3f3 100644 --- a/docs/zh/cli-client/keys/list.md +++ b/docs/zh/cli-client/keys/list.md @@ -14,7 +14,7 @@ iriscli keys list [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | --------- | ------------------------------------------------------------ | -------- | -| --help, -h | | help for add | | +| --help, -h | | 查询命令帮助 | | ## 例子 diff --git a/docs/zh/cli-client/keys/mnemonic.md b/docs/zh/cli-client/keys/mnemonic.md index 25025f3d4..8b6fc19a6 100644 --- a/docs/zh/cli-client/keys/mnemonic.md +++ b/docs/zh/cli-client/keys/mnemonic.md @@ -14,8 +14,8 @@ iriscli keys mnemonic [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | ---------------- | --------- | ----------------------------------------------------------------------------- | -------- | -| --help, -h | | help for add | | -| --unsafe-entropy | | Prompt the user to supply their own entropy, instead of relying on the system | | +| --help, -h | | 查询命令帮助 | | +| --unsafe-entropy | | 提示用户提供自己的熵，而不是依赖于系统生成 | | ## 例子 diff --git a/docs/zh/cli-client/keys/new.md b/docs/zh/cli-client/keys/new.md index 592bb4777..66f53bc71 100644 --- a/docs/zh/cli-client/keys/new.md +++ b/docs/zh/cli-client/keys/new.md @@ -14,10 +14,10 @@ iriscli keys new [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | ----------------- | --------------------------------------------------------------- | -------- | -| --bip44-path | 44'/118'/0'/0/0 | BIP44 path from which to derive a private key | | -| --default | | Skip the prompts and just use the default values for everything | | -| --help, -h | | help for add | | -| --ledger | | Store a local reference to a private key on a Ledger device | | +| --bip44-path | 44'/118'/0'/0/0 | 从中导出私钥的BIP44路径 | | +| --default | | 跳过提示，只使用默认值 | | +| --help, -h | | 查询命令帮助 | | +| --ledger | | 使用连接的硬件记账设备 | | ## 例子 diff --git a/docs/zh/cli-client/keys/show.md b/docs/zh/cli-client/keys/show.md index bee5c3b1a..a7c6e1e84 100644 --- a/docs/zh/cli-client/keys/show.md +++ b/docs/zh/cli-client/keys/show.md @@ -14,11 +14,11 @@ iriscli keys show [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | -------------------- | ----------------- | -------------------------------------------------------------- | -------- | -| --address | | output the address only (overrides --output) | | -| --bech | acc | [string] The Bech32 prefix encoding for a key (acc|val|cons) | | -| --help, -h | | help for add | | +| --address | | 仅输出地址 | | +| --bech | acc | [string] 密钥的Bech32前缀编码 (acc|val|cons) | | +| --help, -h | | 查询命令帮助 | | | --multisig-threshold | 1 | [uint] K out of N required signatures | | -| --pubkey | | output the public key only (overrides --output) | | +| --pubkey | | 仅输出公钥 | | ## 例子 diff --git a/docs/zh/cli-client/keys/update.md b/docs/zh/cli-client/keys/update.md index c831a6973..eec10a472 100644 --- a/docs/zh/cli-client/keys/update.md +++ b/docs/zh/cli-client/keys/update.md @@ -14,7 +14,7 @@ iriscli keys update [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | --------- | ------------------------------------------------------------ | -------- | -| --help, -h | | help for add | | +| --help, -h | | 查询命令帮助 | | ## 例子 From 48b02373d4d410ee9aa09e6f13e6f16f15d05343 Mon Sep 17 00:00:00 2001 From: trevorfu Date: Fri, 16 Nov 2018 20:42:01 +0800 Subject: [PATCH 066/100] modify chinese description --- docs/cli-client/gov/query-proposals.md | 2 +- docs/zh/cli-client/gov/deposit.md | 42 +++++++++--------- docs/zh/cli-client/gov/pull-params.md | 16 +++---- docs/zh/cli-client/gov/query-deposit.md | 18 ++++---- docs/zh/cli-client/gov/query-deposits.md | 16 +++---- docs/zh/cli-client/gov/query-params.md | 18 ++++---- docs/zh/cli-client/gov/query-proposal.md | 16 +++---- docs/zh/cli-client/gov/query-proposals.md | 22 ++++----- docs/zh/cli-client/gov/query-tally.md | 16 +++---- docs/zh/cli-client/gov/query-vote.md | 18 ++++---- docs/zh/cli-client/gov/query-votes.md | 16 +++---- docs/zh/cli-client/gov/submit-proposal.md | 54 +++++++++++------------ docs/zh/cli-client/gov/vote.md | 42 +++++++++--------- 13 files changed, 148 insertions(+), 148 deletions(-) diff --git a/docs/cli-client/gov/query-proposals.md b/docs/cli-client/gov/query-proposals.md index 9e942d3f8..81d3b9fc4 100644 --- a/docs/cli-client/gov/query-proposals.md +++ b/docs/cli-client/gov/query-proposals.md @@ -22,7 +22,7 @@ iriscli gov query-proposals [flags] | --ledger | | Use a connected Ledger device | | | --limit | | [string] (optional) Limit to latest [number] proposals. Defaults to all proposals | | | --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --status | | [string] ProposalID of proposal depositing on | | +| --status | | [string] (optional) filter proposals by proposal status | | | --trust-node | true | Don't verify proofs for responses | | | --voter | | [string] (optional) Filter by proposals voted on by voted | | diff --git a/docs/zh/cli-client/gov/deposit.md b/docs/zh/cli-client/gov/deposit.md index e4132767d..3991033b0 100644 --- a/docs/zh/cli-client/gov/deposit.md +++ b/docs/zh/cli-client/gov/deposit.md @@ -14,27 +14,27 @@ iriscli gov deposit [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --deposit | | [string] Deposit of proposal | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | Help for deposit | | -| --indent | | Add indent to JSON response | | -| --json | | Return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --print-response | | Return tx response (only works with async = false) | | -| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --deposit | | [string] 发起提议的保证金 | Yes | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --proposal-id | | [string] 充值保证金的提议ID | Yes | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/gov/pull-params.md b/docs/zh/cli-client/gov/pull-params.md index 17332ead9..c43dbc476 100644 --- a/docs/zh/cli-client/gov/pull-params.md +++ b/docs/zh/cli-client/gov/pull-params.md @@ -14,14 +14,14 @@ iriscli gov pull-params [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for pull-params | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --path | $HOME/.iris | [string] directory of iris home | | -| --trust-node | true | Don't verify proofs for responses | | +| --chain-id | | [string] tendermint节点的链ID | | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --path | $HOME/.iris | [string] iris home目录 | | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/gov/query-deposit.md b/docs/zh/cli-client/gov/query-deposit.md index 5d087ee02..636d2fa7d 100644 --- a/docs/zh/cli-client/gov/query-deposit.md +++ b/docs/zh/cli-client/gov/query-deposit.md @@ -14,15 +14,15 @@ iriscli gov query-deposit [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --depositer | | [string] bech32 depositer address | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-deposit | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --depositer | | [string] bech32编码的存款人地址 | Yes | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --proposal-id | | [string] 提议ID | Yes | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/gov/query-deposits.md b/docs/zh/cli-client/gov/query-deposits.md index 205d80ec2..d4696cfad 100644 --- a/docs/zh/cli-client/gov/query-deposits.md +++ b/docs/zh/cli-client/gov/query-deposits.md @@ -14,14 +14,14 @@ iriscli gov query-deposits [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-deposits | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --proposal-id | | [string] 提议ID | Yes | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/gov/query-params.md b/docs/zh/cli-client/gov/query-params.md index a24ac1529..001ef7f56 100644 --- a/docs/zh/cli-client/gov/query-params.md +++ b/docs/zh/cli-client/gov/query-params.md @@ -14,15 +14,15 @@ iriscli gov query-params [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-params | | -| --indent | | Add indent to JSON response | | -| --key | | [string] key name of parameter | | -| --ledger | | Use a connected Ledger device | | -| --module | | [string] module name | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +| --chain-id | | [string] tendermint节点的链ID | | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --key | | [string] 参数的键名称 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --module | | [string] 模块名称 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/gov/query-proposal.md b/docs/zh/cli-client/gov/query-proposal.md index 8419b9717..577e7458e 100644 --- a/docs/zh/cli-client/gov/query-proposal.md +++ b/docs/zh/cli-client/gov/query-proposal.md @@ -14,14 +14,14 @@ iriscli gov query-proposal [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-proposal | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --proposal-id | | [string] 提议ID | Yes | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/gov/query-proposals.md b/docs/zh/cli-client/gov/query-proposals.md index 03dcc4804..18ba05d85 100644 --- a/docs/zh/cli-client/gov/query-proposals.md +++ b/docs/zh/cli-client/gov/query-proposals.md @@ -14,17 +14,17 @@ iriscli gov query-proposals [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --depositer | | [string] (optional) filter by proposals deposited on by depositer | | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-proposals | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --limit | | [string] (optional) limit to latest [number] proposals. Defaults to all proposals | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --status | | [string] proposalID of proposal depositing on | | -| --trust-node | true | Don't verify proofs for responses | | -| --voter | | [string] (optional) filter by proposals voted on by voted | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --depositer | | [string] （可选）按存款人过滤 | | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --limit | | [string] （可选）限制最新[数量]提议。 默认为所有提议 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --status | | [string] （可选）按提议状态过滤提议 | | +| --trust-node | true | 关闭响应结果校验 | | +| --voter | | [string] （可选）按投票人过滤 | | ## 例子 diff --git a/docs/zh/cli-client/gov/query-tally.md b/docs/zh/cli-client/gov/query-tally.md index 37c5faab0..f9ed82baf 100644 --- a/docs/zh/cli-client/gov/query-tally.md +++ b/docs/zh/cli-client/gov/query-tally.md @@ -13,14 +13,14 @@ iriscli gov query-tally [flags] ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-tally | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --proposal-id | | [string] 提议ID | Yes | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/gov/query-vote.md b/docs/zh/cli-client/gov/query-vote.md index d297c2187..d9846bf43 100644 --- a/docs/zh/cli-client/gov/query-vote.md +++ b/docs/zh/cli-client/gov/query-vote.md @@ -14,15 +14,15 @@ iriscli gov query-vote [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-vote | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | -| --voter | | [string] bech32 voter address | Yes | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --proposal-id | | [string] 提议ID | Yes | +| --trust-node | true | 关闭响应结果校验 | | +| --voter | | [string] bech32编码的投票人地址 | Yes | ## 例子 diff --git a/docs/zh/cli-client/gov/query-votes.md b/docs/zh/cli-client/gov/query-votes.md index b2c6244d2..c60450250 100644 --- a/docs/zh/cli-client/gov/query-votes.md +++ b/docs/zh/cli-client/gov/query-votes.md @@ -14,14 +14,14 @@ iriscli gov query-votes [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-votes | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] proposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --height | | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --proposal-id | | [string] 提议ID | Yes | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/gov/submit-proposal.md b/docs/zh/cli-client/gov/submit-proposal.md index 40c8a2ed6..b089c2106 100644 --- a/docs/zh/cli-client/gov/submit-proposal.md +++ b/docs/zh/cli-client/gov/submit-proposal.md @@ -14,33 +14,33 @@ iriscli gov submit-proposal [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --deposit | | [string] deposit of proposal | | -| --description | | [string] description of proposal | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | Help for submit-proposal | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --key | | the key of parameter | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --op | | [string] the operation of parameter | | -| --param | | [string] parameter of proposal,eg. [{key:key,value:value,op:update}] | | -| --path | | [string] the path of param.json | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --title | | [string] title of proposal | Yes | -| --trust-node | true | Don't verify proofs for responses | | -| --type | | [string] proposalType of proposal,eg:Text/ParameterChange/SoftwareUpgrade | Yes | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --deposit | | [string] 提议的保证金 | | +| --description | | [string] 提议的描述 | Yes | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --key | | 参数的键名称 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --op | | [string] 对参数的操作 | | +| --param | | [string] 提议参数,例如: [{key:key,value:value,op:update}] | | +| --path | | [string] param.json文件路径 | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --title | | [string] 提议标题 | Yes | +| --trust-node | true | 关闭响应结果校验 | | +| --type | | [string] 提议类型,例如:Text/ParameterChange/SoftwareUpgrade | Yes | ## 例子 diff --git a/docs/zh/cli-client/gov/vote.md b/docs/zh/cli-client/gov/vote.md index af6fe2c9b..4131e8af1 100644 --- a/docs/zh/cli-client/gov/vote.md +++ b/docs/zh/cli-client/gov/vote.md @@ -14,27 +14,27 @@ iriscli gov vote [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | Help for vote | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --option | | [string] vote option {Yes, No, NoWithVeto, Abstain} | Yes | -| --print-response | | return tx response (only works with async = false) | | -| --proposal-id | | [string] proposalID of proposal voting on | Yes | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | Yes | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | Yes | +| --from | | [string] 用来签名的私钥名 | Yes | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --option | | [string] 投票选项 {Yes, No, NoWithVeto, Abstain} | Yes | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --proposal-id | | [string] 投票的提议ID | Yes | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | ## 例子 From a763e9336c5b3eece44433d117286b578a94a533 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Fri, 16 Nov 2018 21:14:17 +0800 Subject: [PATCH 067/100] add chinese docs for lcd and mint --- docs/features/lcd.md | 10 +-- docs/features/mint.md | 10 +-- docs/zh/features/lcd.md | 163 +++++++++++++++++++-------------------- docs/zh/features/mint.md | 36 +++++++++ 4 files changed, 126 insertions(+), 93 deletions(-) diff --git a/docs/features/lcd.md b/docs/features/lcd.md index fc2ee7082..aff1767ba 100644 --- a/docs/features/lcd.md +++ b/docs/features/lcd.md @@ -1,7 +1,5 @@ # IRISLCD User Guide -## Introduction - ## Basic Functionality Description 1. Provide restful APIs and swagger-ui to show these APIs @@ -84,7 +82,7 @@ Once the IRISLCD node is started successfully, then you can open `localhost:1317 1. `POST /distribution/{delegatorAddr}/withdrawAddress`: Set withdraw address 2. `GET /distribution/{delegatorAddr}/withdrawAddress`: Query withdraw address - 3. `POST /distribution/{delegatorAddr}/withdrawReward`: Set withdraw address + 3. `POST /distribution/{delegatorAddr}/withdrawReward`: Withdraw address 4. `GET /distribution/{delegatorAddr}/distrInfo/{validatorAddr}`: Query distribution information for a delegation 5. `GET /distribution/{delegatorAddr}/distrInfos`: Query distribution information list for a given delegator 6. `GET /distribution/{validatorAddr}/valDistrInfo`: Query withdraw address @@ -94,7 +92,7 @@ Once the IRISLCD node is started successfully, then you can open `localhost:1317 1. `GET /version`: Version of irislcd 2. `GET /node_version`: Version of the connected node -## Options for post apis +## Extra parameters for post apis 1. `POST /bank/accounts/{address}/transfers`: Send tokens (build -> sign -> send) 2. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction @@ -105,10 +103,10 @@ Once the IRISLCD node is started successfully, then you can open `localhost:1317 7. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal 8. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator -| Option name | Type | Default | Priority | Description | +| parameter name | Type | Default | Priority | Description | | --------------- | ---- | ------- |--------- |--------------------------- | | generate-only | bool | false | 0 | Build an unsigned transaction and write it back | | simulate | bool | false | 1 | Ignore the gas field and perform a simulation of a transaction, but don’t broadcast it | | async | bool | false | 2 | Broadcast transaction asynchronously | -The above eight post APIs have three query options which are shown in the above table. By default, their values are all false. Each option has its unique priority( Here `0` is the top priority). If multiple options are enabled, then the options with lower priority will be ignored. For instance, if `generate-only` is true, then other options, such as `simulate` and `async` will be ignored. \ No newline at end of file +The above eight post APIs have three query parameter which are shown in the above table. By default, their values are all false. Each parameter has its unique priority( Here `0` is the top priority). If multiple parameters are specified, then the parameters with lower priority will be ignored. For instance, if `generate-only` is true, then other parameters, such as `simulate` and `async` will be ignored. \ No newline at end of file diff --git a/docs/features/mint.md b/docs/features/mint.md index 2fd324b35..5c97a2d28 100644 --- a/docs/features/mint.md +++ b/docs/features/mint.md @@ -1,16 +1,16 @@ -#IRISLCD User Guide +# IRISLCD User Guide ## Introduction -The incentive mechanism of POW is widely known and explicit: once a new block is produced, the block miner will acquire a certain amount of token which is the reward for producing block. As a POS blockchain network, the Irishub also has incentive mechanism. But it is much different. Strictly speaking, it is the inflation token which will be distributed to all the contributors. +The incentive mechanism of POW is widely known and explicit: once a new block is produced, the block miner will acquire a certain amount of token as well as the accumulation of transaction fee in the block. As a POS blockchain network, the IRISHUB incentive mechanism is much different. -As we all know, POW means proof of work. In each producing period, all miners compete to submit their work proof and the fastest one will be the winner. Actually, all loser miners don't offer any positive help or collaboration to the winner miner, and they are only the competitors. So it is reasonable to grant all reward to the winner miner. However, in POS blockchain network, we can't do that. Because each block producing process is based on the collaboration of all validators and delegators, which means the benefit should be share by all these contributors. +As we all know, POW means proof of work. In each block producing period, all miners compete to calculate their work proof and the fastest one will be the winner. Actually, all loser miners don't offer any positive help or collaboration to the winner miner, and they are only the competitors. So it is reasonable to grant all reward to the winner miner. However, in POS blockchain network, we can't do that. Because each block producing process is the collaboration of all validators and delegators, which means the benefit should be share by all these contributors. There are two sources of revenue, one is the transaction fee of the packaged transaction in the block. The other is regular inflation, which will produce new tokens. As for how to distribute inflation token to contributors, we will document and implement it in distribution module. Here we mainly introduce how to figure out the inflation token and what is the impact to users. -## Reward Calculation +## Inflation Calculation -Unlike POW network, the inflation token will not be paid to contributors in each block. Instead, once an hour(`block time`) the inflation token is calculated and saved in global pool. Only when contributors explicitly send transactions to withdraw reward, then will the inflation token be transfered to users specified addresses. +Unlike POW network, the inflation token will not be paid to contributors in each block. Only when contributors explicitly send transactions to withdraw reward, then will the inflation token be transfered to users specified addresses. Besides, the token inflation is triggered once an hour, and the new produced token will be saved in global pool. ### Block Time diff --git a/docs/zh/features/lcd.md b/docs/zh/features/lcd.md index fc2ee7082..d594950ec 100644 --- a/docs/zh/features/lcd.md +++ b/docs/zh/features/lcd.md @@ -1,114 +1,113 @@ -# IRISLCD User Guide +# IRISLCD用户文档 -## Introduction +## 基本功能介绍 -## Basic Functionality Description +1.提供restful API以及swagger-ui +2.验证查询结果的有效性 -1. Provide restful APIs and swagger-ui to show these APIs -2. Verify query proof +## 使用场景 -## Usage Scenario +假设有一个正在运行的IRISLCD节点，其swagger-ui页面url是`localhost:1317/swagger-ui/`。IRISLCD用户文档的默认home目录是`$HOME/.irislcd`。IRISLCD启动以后，首先它将在其主文件夹中创建存储密钥的文件。如果IRISLCD运行在非信任模式下，它将获取当前区块作为其信任基础，并且将其保存到其home目录下的`trust-base.db`。IRISLCD节点始终无条件信任这个区块。它将根据这个区块的验证人集合来验证此后所有查询结果，这意味着IRISLCD只能验证其信任区块之后的区块信息和交易。这也是IRISLCD的缺陷。当它尝试验证较低高度的某些交易和区块时，会有错误返回。因此，如果您想查询早期的区块和交易时，请以信任模式启动IRISLCD。有关详细的查询结果的验证算法，请参阅此[文档](https://github.com/tendermint/tendermint/blob/master/docs/tendermint-core/light-client-protocol.md)。 -Suppose an IRISLCD node is running and its swagger-ui page url is `localhost:1317/swagger-ui/`. The default home folder of irislcd is `$HOME/.irislcd`. Once an IRISLCD is started, firstly it will create key store in its home folder. If the IRISLCD is running in distrust mode, then ir will fetch the latest block as its trust basis and the trust basis will be saved to folder `trust-base.db` under its home folder. The IRISLCD node always trust the basis. It will verify all query proof against the trust basis, which means IRISLCD can only verify the proof on later height. However, this is also a defect of IRISLCD. When it tries to verify some transactions or blocks on lower height, it will report error. So if you want to query transactions or block on lower height, please start IRISLCD in trust mode. For detailed proof verification algorithm please refer to this [document](https://github.com/tendermint/tendermint/blob/master/docs/tendermint-core/light-client-protocol.md). +IRISLCD节点成功启动后，在浏览器中打开`localhost1317/swagger-ui/`，您可以看到所有REST APIs。 -Once the IRISLCD node is started successfully, then you can open `localhost:1317/swagger-ui/` in your explorer and all restful APIs will be shown. - -1. Tendermint APIs, such as query blocks, transactions and validatorset - 1. `GET /node_info`: The properties of the connected node - 2. `GET /syncing`: Syncing state of node - 3. `GET /blocks/latest`: Get the latest block - 4. `GET /blocks/{height}`: Get a block at a certain height - 5. `GET /validatorsets/latest`: Get the latest validator set - 6. `GET /validatorsets/{height}`: Get a validator set a certain height - 7. `GET /txs/{hash}`: Get a Tx by hash - 8. `GET /txs`: Search transactions - 9. `POST /txs`: Broadcast Tx +1. Tendermint相关APIs, 例如查询区块，交易和验证人集 + 1. `GET /node_info`: 查询所连接全节点的信息 + 2. `GET /syncing`: 查询所连接全节点是否处于追赶区块的状态 + 3. `GET /blocks/latest`: 获取最新区块 + 4. `GET /blocks/{height}`: 获取某一高度的区块 + 5. `GET /validatorsets/latest`: 获取最新的验证人集合 + 6. `GET /validatorsets/{height}`: 获取某一高度的验证人集合 + 7. `GET /txs/{hash}`: 通过交易hash查询交易 + 8. `GET /txs`: 搜索交易 + 9. `POST /txs`: 广播交易 2. Key management APIs - 1. `GET /keys`: List of accounts stored locally - 2. `POST /keys`: Create a new account locally - 3. `GET /keys/seed`: Create a new seed to create a new account with - 4. `GET /keys/{name}`: Get a certain locally stored account - 5. `PUT /keys/{name}`: Update the password for this account in the KMS - 6. `DELETE /keys/{name}`: Remove an account - 7. `GET /auth/accounts/{address}`: Get the account information on blockchain + 1. `GET /keys`: 列出所有本地的秘钥 + 2. `POST /keys`: 创建新的秘钥 + 3. `GET /keys/seed`: 创建新的助记词 + 4. `GET /keys/{name}`: 根据秘钥名称查询秘钥 + 5. `PUT /keys/{name}`: 更新秘钥的密码 + 6. `DELETE /keys/{name}`: 删除秘钥 + 7. `GET /auth/accounts/{address}`: 查询秘钥对象账户的信息 3. Create, sign and broadcast transactions - 1. `POST /tx/sign`: Sign a transation - 2. `POST /tx/broadcast`: Broadcast a signed StdTx with amino encoding signature and public key - 3. `POST /txs/send`: Send non-amino encoding transaction - 4. `GET /bank/coin/{coin-type}`: Get coin type - 5. `GET /bank/balances/{address}`: Get the account information on blockchain - 6. `POST /bank/accounts/{address}/transfers`: Send coins (build -> sign -> send) + 1. `POST /tx/sign`: 签名交易 + 2. `POST /tx/broadcast`: 广播一个amino编码的交易 + 3. `POST /txs/send`: 广播一个非amino编码的交易 + 4. `GET /bank/coin/{coin-type}`: 查询coin的类型信息 + 5. `GET /bank/balances/{address}`: 查询账户的token数量 + 6. `POST /bank/accounts/{address}/transfers`: 发起转账交易 4. Stake module APIs - 1. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction - 2. `POST /stake/delegators/{delegatorAddr}/redelegate`: Submit redelegation transaction - 3. `POST /stake/delegators/{delegatorAddr}/unbond`: Submit unbonding transaction - 4. `GET /stake/delegators/{delegatorAddr}/delegations`: Get all delegations from a delegator - 5. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations`: Get all unbonding delegations from a delegator - 6. `GET /stake/delegators/{delegatorAddr}/redelegations`: Get all redelegations from a delegator - 7. `GET /stake/delegators/{delegatorAddr}/validators`: Query all validators that a delegator is bonded to - 8. `GET /stake/delegators/{delegatorAddr}/validators/{validatorAddr}`: Query a validator that a delegator is bonded to - 9. `GET /stake/delegators/{delegatorAddr}/txs` :Get all staking txs (i.e msgs) from a delegator - 10. `GET /stake/delegators/{delegatorAddr}/delegations/{validatorAddr}`: Query the current delegation between a delegator and a validator - 11. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}`: Query all unbonding delegations between a delegator and a validator - 12. `GET /stake/validators`: Get all validator candidates - 13. `GET /stake/validators/{validatorAddr}`: Query the information from a single validator - 14. `GET /stake/validators/{validatorAddr}/unbonding_delegations`: Get all unbonding delegations from a validator - 15. `GET /stake/validators/{validatorAddr}/redelegations`: Get all outgoing redelegations from a validator - 16. `GET /stake/pool`: Get the current state of the staking pool - 17. `GET /stake/parameters`: Get the current staking parameter values + 1. `POST /stake/delegators/{delegatorAddr}/delegate`: 发起委托交易 + 2. `POST /stake/delegators/{delegatorAddr}/redelegate`: 发起转委托交易 + 3. `POST /stake/delegators/{delegatorAddr}/unbond`: 发起解委托交易 + 4. `GET /stake/delegators/{delegatorAddr}/delegations`: 查询委托人的所有委托记录 + 5. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations`: 查询委托人的所有解委托记录 + 6. `GET /stake/delegators/{delegatorAddr}/redelegations`: 查询委托人的所有转委托记录 + 7. `GET /stake/delegators/{delegatorAddr}/validators`: 查询委托人的所委托的所有验证人 + 8. `GET /stake/delegators/{delegatorAddr}/validators/{validatorAddr}`: 查询某个被委托的验证人上信息 + 9. `GET /stake/delegators/{delegatorAddr}/txs`: 查询所有委托人相关的委托交易 + 10. `GET /stake/delegators/{delegatorAddr}/delegations/{validatorAddr}`: 查询委托人在某个验证人上的委托记录 + 11. `GET /stake/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}`: 查询委托人在某个验证人上所有的解委托记录 + 12. `GET /stake/validators`: 获取所有委托人信息 + 13. `GET /stake/validators/{validatorAddr}`: 获取某个委托人信息 + 14. `GET /stake/validators/{validatorAddr}/unbonding_delegations`: 获取某个验证人上的所有解委托记录 + 15. `GET /stake/validators/{validatorAddr}/redelegations`: 获取某个验证人上的所有转委托记录 + 16. `GET /stake/pool`: 获取权益池信息 + 17. `GET /stake/parameters`: 获取权益证明的参数 5. Governance module APIs - 1. `POST /gov/proposal`: Submit a proposal - 2. `GET /gov/proposals`: Query proposals - 3. `POST /gov/proposals/{proposalId}/deposits`: Deposit tokens to a proposal - 4. `GET /gov/proposals/{proposalId}/deposits`: Query deposits - 5. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal - 6. `GET /gov/proposals/{proposalId}/votes`: Query voters - 7. `GET /gov/proposals/{proposalId}`: Query a proposal - 8. `GET /gov/proposals/{proposalId}/deposits/{depositor}`: Query deposit - 9. `GET /gov/proposals/{proposalId}/votes/{voter}`: Query vote - 10. `GET/gov/params`: Query governance parameters + 1. `POST /gov/proposal`: 发起提交提议交易 + 2. `GET /gov/proposals`: 查询提议 + 3. `POST /gov/proposals/{proposalId}/deposits`: 发起缴纳押金的交易 + 4. `GET /gov/proposals/{proposalId}/deposits`: 查询缴纳的押金 + 5. `POST /gov/proposals/{proposalId}/votes`: 发起投票交易 + 6. `GET /gov/proposals/{proposalId}/votes`: 查询投票 + 7. `GET /gov/proposals/{proposalId}`: 查询某个提议 + 8. `GET /gov/proposals/{proposalId}/deposits/{depositor}`:查询押金 + 9. `GET /gov/proposals/{proposalId}/votes/{voter}`: 查询投票 + 10. `GET/gov/params`: 查询可供治理的参数 6. Slashing module APIs - 1. `GET /slashing/validators/{validatorPubKey}/signing_info`: Get sign info of given validator - 2. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator + + 1. `GET /slashing/validators/{validatorPubKey}/signing_info`: 获取验证人的签名记录 + 2. `POST /slashing/validators/{validatorAddr}/unjail`: 赦免某个作恶的验证人节点 7. Distribution module APIs - 1. `POST /distribution/{delegatorAddr}/withdrawAddress`: Set withdraw address - 2. `GET /distribution/{delegatorAddr}/withdrawAddress`: Query withdraw address - 3. `POST /distribution/{delegatorAddr}/withdrawReward`: Set withdraw address - 4. `GET /distribution/{delegatorAddr}/distrInfo/{validatorAddr}`: Query distribution information for a delegation - 5. `GET /distribution/{delegatorAddr}/distrInfos`: Query distribution information list for a given delegator - 6. `GET /distribution/{validatorAddr}/valDistrInfo`: Query withdraw address + 1. `POST /distribution/{delegatorAddr}/withdrawAddress`: 设置收益撤回地址 + 2. `GET /distribution/{delegatorAddr}/withdrawAddress`: 查询收益撤回地址 + 3. `POST /distribution/{delegatorAddr}/withdrawReward`: 撤回收益 + 4. `GET /distribution/{delegatorAddr}/distrInfo/{validatorAddr}`: 查询某个委托的收益分配信息 + 5. `GET /distribution/{delegatorAddr}/distrInfos`: 查询委托人所有委托的收益分配信息 + 6. `GET /distribution/{validatorAddr}/valDistrInfo`: 查询验证人的收益分配信息 8. Query app version - 1. `GET /version`: Version of irislcd - 2. `GET /node_version`: Version of the connected node + 1. `GET /version`: 获取IRISHUB的版本 + 2. `GET /node_version`: 查询全节点版本 ## Options for post apis -1. `POST /bank/accounts/{address}/transfers`: Send tokens (build -> sign -> send) -2. `POST /stake/delegators/{delegatorAddr}/delegate`: Submit delegation transaction -3. `POST /stake/delegators/{delegatorAddr}/redelegate`: Submit redelegation transaction -4. `POST /stake/delegators/{delegatorAddr}/unbond`: Submit unbonding transaction -5. `POST /gov/proposal`: Submit a proposal -6. `POST /gov/proposals/{proposalId}/deposits`: Deposit tokens to a proposal -7. `POST /gov/proposals/{proposalId}/votes`: Vote a proposal -8. `POST /slashing/validators/{validatorAddr}/unjail`: Unjail a jailed validator +1. `POST /bank/accounts/{address}/transfers` +2. `POST /stake/delegators/{delegatorAddr}/delegate` +3. `POST /stake/delegators/{delegatorAddr}/redelegate` +4. `POST /stake/delegators/{delegatorAddr}/unbond` +5. `POST /gov/proposal` +6. `POST /gov/proposals/{proposalId}/deposits` +7. `POST /gov/proposals/{proposalId}/votes` +8. `POST /slashing/validators/{validatorAddr}/unjail` -| Option name | Type | Default | Priority | Description | +| 参数名字 | 类型 | 默认值 | 优先级 | 功能描述 | | --------------- | ---- | ------- |--------- |--------------------------- | -| generate-only | bool | false | 0 | Build an unsigned transaction and write it back | -| simulate | bool | false | 1 | Ignore the gas field and perform a simulation of a transaction, but don’t broadcast it | -| async | bool | false | 2 | Broadcast transaction asynchronously | +| generate-only | bool | false | 0 | 构建一个未签名的交易并返回 | +| simulate | bool | false | 1 | 用仿真的方式去执行交易 | +| async | bool | false | 2 | 用异步地方式广播交易 | -The above eight post APIs have three query options which are shown in the above table. By default, their values are all false. Each option has its unique priority( Here `0` is the top priority). If multiple options are enabled, then the options with lower priority will be ignored. For instance, if `generate-only` is true, then other options, such as `simulate` and `async` will be ignored. \ No newline at end of file +以上八个APIs都有三个额外的查询参数，如上表所示。默认情况下，它们的值都是false。每个参数都有其唯一的优先级（这里`0`是最高优先级）。 如果指定了多个参数，则将忽略优先级较低的参数。 例如，如果`generate-only`为真，那么其他参数，例如`simulate`和`async`将被忽略。 \ No newline at end of file diff --git a/docs/zh/features/mint.md b/docs/zh/features/mint.md index e69de29bb..15a73855c 100644 --- a/docs/zh/features/mint.md +++ b/docs/zh/features/mint.md @@ -0,0 +1,36 @@ +# IRISLCD用户文档 + +## 介绍 + +POW共识网络的激励机制十分简明：一旦新的区块产生，那么区块的产生者将会获得一定数量的token作为出块奖励。我们IRISHUB是POS区块链网络，这里的激励机制相对复杂很多。 + +按照字面意思，POW就是工作量证明。在每个区块生成期间，所有矿工竞争计算工作证明，最快计算出结果的矿工将成为赢家。实际上，所有失败的矿工都没有向优胜者矿工提供任何积极的帮助或合作，他们只是竞争对手。因此，向获胜者矿工授予所有奖励是合理的。但是，在POS区块链网络中，我们不能这样做。因为每个块生成过程都是所有验证人和委托人的协作，这意味着所有这些贡献者应该共享出块收益。出块收益有两个来源，一个是区块中打包的交易的交易费；另一个就是定时的通胀，通胀多出来的token作为出块奖励。 + +至于如何将通胀的token分发给贡献者，我们将在distribution模块中详细解说。在这里，我们主要介绍如何计算通胀的数量以及对用户的影响。 + +## 计算通胀 + +与POW网络不同，我们这里的收益不会直接支付给贡献者。有当贡献者明确发送交易以提取奖励时，才会将通胀令牌转移到用户指定的地址。此外，token通胀每小时触发一次，新生成的token将保存在全局池中。 + +### 区块时间 + +区块时间不是机器时间，因为不同机器的时间不可能完全相同。 他们必须或多或少地有一些偏差，这将导致不确定性。 这里的时间是指BFT时间。 有关详细说明，请参阅[tendermint bft-time](https://github.com/tendermint/tendermint/blob/master/docs/spec/consensus/bft-time.md)。 + +### 通胀率 + +通胀率取决于有多大比例的token被绑定，被绑定的token的比例一直会变，那么这个通胀的比例也会一直在变。理想的绑定比率是67％，如果这个比率更高，通胀率将下降。相反，如果绑定比率较低，通胀率将会增加。此外，通胀率不应超过20％且不低于7％。例如，当计算出的通胀率高于20%，那么我们强制把通胀率置为20%。 + +假设计算出的通胀率为10％，总token金额为10000iris，则通胀token为0.114iris(10000iris*10％/8766，一年有8766小时)。在此通胀之后，总token金额将为10000.114iris。 + +## 对用户的影响 + +通胀计算是一个自动过程。没有接口可用用户来干预此过程。但是，用户可以发送委托或解委托交易来改变绑定比率，从而改变通胀率会。此外，通胀过程将增加总token金额。用户可以通过此命令获取总token数量： +``` +ubuntu@ubuntu:~$ iriscli stake pool --node= +Pool +Loose Tokens: 200.1186409166 +Bonded Tokens: 400.0000000000 +Token Supply: 600.1186409166 +Bonded Ratio: 0.6665348695 +``` + From 45d725ff3d10816d9dd08ef60e12ee3f47e40792 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Fri, 16 Nov 2018 21:59:05 +0800 Subject: [PATCH 068/100] Add chinese docs for distribution --- docs/features/distribution.md | 5 +--- docs/zh/features/distribution.md | 43 +++++++++++++++++++++++++++++++- docs/zh/features/lcd.md | 6 ++--- 3 files changed, 46 insertions(+), 8 deletions(-) diff --git a/docs/features/distribution.md b/docs/features/distribution.md index be0c94001..917f51460 100644 --- a/docs/features/distribution.md +++ b/docs/features/distribution.md @@ -8,10 +8,7 @@ This module is in charge of distributing collected transaction fee and inflated 1. Set withdraw address - A delegator may have multiple irishub wallet address. Suppose one of the wallets has many iris token and part of these tokens have been delegated to a validator. - The delegator may hope the delegation reward can be paid to another wallet, thus the delegator will have explicit idea about how many tokens he/she has earned. - However, by default, the reward will be paid to the wallet(marked as `A`) address which send the delegation transaction. To set another wallet(marked as `B`) as the paid address, - delegator need to send another transaction from wallet `A`. The referenced command can be: + A delegator may have multiple irishub wallet address. Suppose one of the wallets has many iris token and part of these tokens have been delegated to a validator. The delegator may hope the delegation reward can be paid to another wallet, thus the delegator will have explicit idea about how many tokens he/she has earned.However, by default, the reward will be paid to the wallet(marked as `A`) address which send the delegation transaction. To set another wallet(marked as `B`) as the paid address, delegator need to send another transaction from wallet `A`. The referenced command can be: ```bash iriscli distribution set-withdraw-addr [address of wallet B] --fee=0.004iris --from=[key name of wallet A] --chain-id=[chain-id] ``` diff --git a/docs/zh/features/distribution.md b/docs/zh/features/distribution.md index 8d3f495d4..d516cbf3a 100644 --- a/docs/zh/features/distribution.md +++ b/docs/zh/features/distribution.md @@ -1 +1,42 @@ -# 介绍 \ No newline at end of file +# 收益分配模块的用户手册 + +## 简介 + +该模块负责将收集的交易费和虚增的令牌分发给所有验证员和委托人。为了减少计算压力，引入了一种惰性分配策略。`惰性`意味着不会直接向贡献者自动支付利益。贡委托人或者验证人必须手动发送交易以取回其收益，否则，他们的收益将保留在全局收益池中。 + +## 使用场景 + +1. 设置收益取回地址 + + 委托人可能有多个irishub钱包地址。假设其中一个钱包(标记为`B`)有许多token，并且一部分token已被委托给验证人。委托人可能希望所得收益可以支付给另一个钱包，因此委托人可以清楚明白的知道有多少收益。但是，默认情况下，收益将支付给发送委托交易的钱包。如果要将另一个钱包(标记为`B`)设置为支付收益的地址，委托人需要从钱包`A`发送另一个交易。参考命令： + ```bash + iriscli distribution set-withdraw-addr [address of wallet B] --fee=0.004iris --from=[key name of wallet A] --chain-id=[chain-id] + ``` + 如果想验证设置取回地址是否成功，可以查询一下收益地址：参考命令： + ```bash + iriscli distribution withdraw-address [address of wallet A] + ``` + 如果返回结果就是钱包`B`的地址，那么设置取回地址成功。 + +2. 取回收益 + + 根据之前的叙述，我们的收益不会自动支付给我们的钱包，我们必须发送交易以提取收益。假设一个委托人自己有一个一个验证节点(标记为`validatorA`)，也就是说这个委托人也是验证人；此外，它在其它两个验证人上还有委托(两个验证人标记为`validatorB`和`validatorC`)。所有委托均由钱包A创建。 + 1. 仅取回在验证人`validatorA`上的委托收益: + ```bash + iriscli distribution withdraw-rewards --only-from-validator [address of validatorA] --from [key name of wallet A] --fee=0.004iris --chain-id=[chain-id] + ``` + 2. 仅取回在所有验证人上的委托收益: + ```bash + iriscli distribution withdraw-rewards --from [key name of wallet A] --fee=0.004iris --chain-id=[chain-id] + ``` + 3. 仅取回在所有委托收益和验证人赚取的佣金: + ```bash + iriscli distribution withdraw-rewards --is-validator=true --from [key name of wallet A] --fee=0.004iris --chain-id=[chain-id] + ``` + +3. 查询收益 + + Execute the command to get the earned tokens: + ```bash + iriscli bank account [withdraw address] + ``` \ No newline at end of file diff --git a/docs/zh/features/lcd.md b/docs/zh/features/lcd.md index d594950ec..c335a59d8 100644 --- a/docs/zh/features/lcd.md +++ b/docs/zh/features/lcd.md @@ -81,9 +81,9 @@ IRISLCD节点成功启动后，在浏览器中打开`localhost1317/swagger-ui/` 7. Distribution module APIs - 1. `POST /distribution/{delegatorAddr}/withdrawAddress`: 设置收益撤回地址 - 2. `GET /distribution/{delegatorAddr}/withdrawAddress`: 查询收益撤回地址 - 3. `POST /distribution/{delegatorAddr}/withdrawReward`: 撤回收益 + 1. `POST /distribution/{delegatorAddr}/withdrawAddress`: 设置收益取回地址 + 2. `GET /distribution/{delegatorAddr}/withdrawAddress`: 查询收益取回地址 + 3. `POST /distribution/{delegatorAddr}/withdrawReward`: 取回收益 4. `GET /distribution/{delegatorAddr}/distrInfo/{validatorAddr}`: 查询某个委托的收益分配信息 5. `GET /distribution/{delegatorAddr}/distrInfos`: 查询委托人所有委托的收益分配信息 6. `GET /distribution/{validatorAddr}/valDistrInfo`: 查询验证人的收益分配信息 From d50b249f4a683f856b000d358df0c019f252e352 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 23:03:36 +0800 Subject: [PATCH 069/100] Finish the upgrade EN --- docs/cli-client/upgrade/README.md | 26 ++++++++- docs/cli-client/upgrade/info.md | 67 ++++++++++++++++++++++++ docs/cli-client/upgrade/query-switch.md | 32 +++++++++++ docs/cli-client/upgrade/submit-switch.md | 44 ++++++++++++++++ 4 files changed, 168 insertions(+), 1 deletion(-) create mode 100644 docs/cli-client/upgrade/info.md create mode 100644 docs/cli-client/upgrade/query-switch.md create mode 100644 docs/cli-client/upgrade/submit-switch.md diff --git a/docs/cli-client/upgrade/README.md b/docs/cli-client/upgrade/README.md index 5083eb47f..29d783ecc 100644 --- a/docs/cli-client/upgrade/README.md +++ b/docs/cli-client/upgrade/README.md @@ -1 +1,25 @@ -# iriscli \ No newline at end of file +# iriscli upgrade + +## Description + +Be used to participate in the software upgrade process. + +## Usage + +```shell +iriscli upgrade [command] +``` + +## Available Commands + +| Name | Description | +| ------------- | ------------------------------------- | +| [submit-switch](submit-switch.md) | Submit a switch msg for a upgrade propsal| +| [query-switch](query-switch.md) | query switch detail | +| [info](info.md) | Query the information of upgrade module | + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | ------- | ---------------- | -------- | +| --help, -h | | help for upgrade | | diff --git a/docs/cli-client/upgrade/info.md b/docs/cli-client/upgrade/info.md new file mode 100644 index 000000000..e90d80522 --- /dev/null +++ b/docs/cli-client/upgrade/info.md @@ -0,0 +1,67 @@ +# iriscli upgrade info + +## Description + +Query the information of software version and upgrade module. + +## Usage + +``` +iriscli upgrade info +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for query | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Example + +Query the current version information. + +``` +iriscli upgrade info +``` + +Then it will show + +``` +{ +"current_proposal_id": "0", +"current_proposal_accept_height": "-1", +"version": { +"Id": "0", +"ProposalID": "0", +"Start": "0", +"ModuleList": [ +{ +"Start": "0", +"End": "9223372036854775807", +"Handler": "bank", +"Store": [ +"acc" +] +}, +{ +"Start": "0", +"End": "9223372036854775807", +"Handler": "stake", +"Store": [ +"stake", +"acc", +"mint", +"distr" +] +}, +....... +] +} +} +``` diff --git a/docs/cli-client/upgrade/query-switch.md b/docs/cli-client/upgrade/query-switch.md new file mode 100644 index 000000000..b447683fe --- /dev/null +++ b/docs/cli-client/upgrade/query-switch.md @@ -0,0 +1,32 @@ +# iriscli upgrade query-switch + +## Description +Query the switch information to know if someone have send the switch message for the certain software upgrade proposal. + +## Usage + +``` +iriscli upgrade query-switch --proposal-id --voter +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | +| --proposal-id | | proposalID of upgrade swtich being queried | Yes | +| --voter | | Address sign the switch msg | Yes | +| --chain-id | | [string] Chain ID of tendermint node | | +| --height | most recent provable block | block height to query | | +| --help, -h | | help for query | | +| --indent | | Add indent to JSON response | | +| --ledger | | Use a connected Ledger device | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | +| --trust-node | true | Don't verify proofs for responses | | + +## Example + +Query if the address `faa1qvt2r6hh9vyg3kh4tnwgx8wh0kpa7q2lsk03fe` send the switch message for the software upgrade proposal whose ID is 5. + +``` +iriscli upgrade query-switch --proposal-id=5 --voter=faa1qvt2r6hh9vyg3kh4tnwgx8wh0kpa7q2lsk03fe +``` diff --git a/docs/cli-client/upgrade/submit-switch.md b/docs/cli-client/upgrade/submit-switch.md new file mode 100644 index 000000000..51dee96a9 --- /dev/null +++ b/docs/cli-client/upgrade/submit-switch.md @@ -0,0 +1,44 @@ +# iriscli upgrade submit-switch + +## Description + +Submit a switch msg for a upgrade propsal after installing the new software and broadcast to the whole network. + +## Usage + +``` +iriscli upgrade submit-switch [flags] +``` + +## Flags + +| Name, shorthand | Default | Description | Required | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --proposal-id | | proposalID of upgrade proposal | Yes | +| --title | | title of switch | | +| --help, -h | | help for submit-switch | | +| --account-number | | [int] AccountNumber number to sign the tx | | +| --async | | Broadcast transactions asynchronously | | +| --chain-id | | [string] Chain ID of tendermint node | Yes | +| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | +| --fee | | [string] Fee to pay along with transaction | Yes | +| --from | | [string] Name of private key with which to sign | Yes | +| --from-addr | | [string] Specify from address in generate-only mode | | +| --gas string | 200000 | Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | +| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | +| --generate-only | | Build an unsigned transaction and write it to STDOUT | | +| --indent | | Add indent to JSON response | | +| --json | | return output in json format | | +| --ledger | | Use a connected Ledger device | | +| --memo | | [string] Memo to send along with transaction | | +| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | Yes | +| --print-response | | return tx response (only works with async = false) | | +| --sequence | | [int] Sequence number to sign the tx | | +| --trust-node | true | Don't verify proofs for responses | | +## Examples + +Send a switch message for the software upgrade proposal whose `proposalID` is 5. + +``` +iriscli upgrade submit-switch --chain-id=IRISnet --from=x --fee=0.004iris --proposalID 5 --title="Run new verison" +``` From 4e23e40d25d9be3f5161939c72c95faacda7bab9 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 23:06:53 +0800 Subject: [PATCH 070/100] Finish the upgrade ZH --- docs/zh/cli-client/upgrade/README.md | 26 +++++++- docs/zh/cli-client/upgrade/info.md | 69 +++++++++++++++++++++ docs/zh/cli-client/upgrade/query-switch.md | 33 ++++++++++ docs/zh/cli-client/upgrade/submit-switch.md | 45 ++++++++++++++ 4 files changed, 172 insertions(+), 1 deletion(-) create mode 100644 docs/zh/cli-client/upgrade/info.md create mode 100644 docs/zh/cli-client/upgrade/query-switch.md create mode 100644 docs/zh/cli-client/upgrade/submit-switch.md diff --git a/docs/zh/cli-client/upgrade/README.md b/docs/zh/cli-client/upgrade/README.md index 5083eb47f..2fd3a1ad5 100644 --- a/docs/zh/cli-client/upgrade/README.md +++ b/docs/zh/cli-client/upgrade/README.md @@ -1 +1,25 @@ -# iriscli \ No newline at end of file +# iriscli upgrade + +## 描述 + +用来参与软件升级的流程，并可查看当前版本的信息。 + +## 用法 + +```shell +iriscli upgrade [command] +``` + +## 相关命令 + +| Name | Description | +| ------------- | ------------------------------------- | +| [submit-switch](submit-switch.md) | Submit a switch msg for a upgrade propsal| +| [query-switch](query-switch.md) | query switch detail | +| [info](info.md) | Query the information of upgrade module | + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | ------- | ---------------- | -------- | +| --help, -h | | 升级命令帮助 | | diff --git a/docs/zh/cli-client/upgrade/info.md b/docs/zh/cli-client/upgrade/info.md new file mode 100644 index 000000000..1ad172160 --- /dev/null +++ b/docs/zh/cli-client/upgrade/info.md @@ -0,0 +1,69 @@ +# iriscli upgrade info + +## 描述 + +查询软件版本信息和升级模块的信息 + +## 用法 + +``` +iriscli upgrade info +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | +| --proposal-id | | 软件升级提议的ID | 是 | +| --voter | | 签名switch消息的地址 | 是 | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON格式的应答中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +查询当前版本信息 + +``` +iriscli upgrade info +``` + +然后它会打印如下内容： + +``` +{ + "current_proposal_id": "0", + "current_proposal_accept_height": "-1", + "version": { + "Id": "0", + "ProposalID": "0", + "Start": "0", + "ModuleList": [ + { + "Start": "0", + "End": "9223372036854775807", + "Handler": "bank", + "Store": [ + "acc" + ] + }, + { + "Start": "0", + "End": "9223372036854775807", + "Handler": "stake", + "Store": [ + "stake", + "acc", + "mint", + "distr" + ] + }, + ....... + ] + } +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/upgrade/query-switch.md b/docs/zh/cli-client/upgrade/query-switch.md new file mode 100644 index 000000000..1aaa09389 --- /dev/null +++ b/docs/zh/cli-client/upgrade/query-switch.md @@ -0,0 +1,33 @@ +# iriscli upgrade query-switch + +## 描述 + +查询switch信息来知道某人对某升级提议是否发送了switch消息。 + +## 用法 + +``` +iriscli upgrade query-switch --proposal-id --voter +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | +| --proposal-id | | 软件升级提议的ID | 是 | +| --voter | | 签名switch消息的地址 | 是 | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | +| --help, -h | | 查询命令帮助 | | +| --indent | | 在JSON格式的应答中添加缩进 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --trust-node | true | 关闭响应结果校验 | | + +## 例子 + +查询用户`faa1qvt2r6hh9vyg3kh4tnwgx8wh0kpa7q2lsk03fe`是否对升级提议（ID为5）发送了switch消息 + +``` +iriscli upgrade query-switch --proposal-id=5 --voter=faa1qvt2r6hh9vyg3kh4tnwgx8wh0kpa7q2lsk03fe +``` diff --git a/docs/zh/cli-client/upgrade/submit-switch.md b/docs/zh/cli-client/upgrade/submit-switch.md new file mode 100644 index 000000000..61c40bc6e --- /dev/null +++ b/docs/zh/cli-client/upgrade/submit-switch.md @@ -0,0 +1,45 @@ +# iriscli upgrade submit-switch + +## 描述 + +安装完新软件后，向这次升级相关的提议发送switch消息，表明自己已经安装新软件并把消息广播到全网。 + +## 用例 + +``` +iriscli upgrade submit-switch [flags] +``` + +## 标志 + +| 名称, 速记 | 默认值 | 描述 | 必需 | +| --------------- | --------- | ------------------------------------------------------------ | -------- | +| --proposal-id | | 软件升级提议的ID | 是 | +| --title | | switch消息对标题 | | +| --account-number | | [int] 用来签名交易的AccountNumber | | +| --async | | 异步广播交易 | | +| --chain-id | | [string] tendermint节点的链ID | 是 | +| --description | description | [string] 上传文件的描述信息 | | +| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | +| --fee | | [string] 支付的交易费用 | 是 | +| --from | | [string] 用来签名的私钥名 | 是 | +| --from-addr | | [string] 指定generate-only模式下的from address | | +| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | +| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | +| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | +| -h, --help | | 提交命令帮助 | | +| --indent | | 在JSON响应中添加缩进 | | +| --json | | 输出将以json格式返回 | | +| --ledger | | 使用连接的硬件记账设备 | | +| --memo | | [string] 发送交易的备忘录 | | +| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | +| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | +| --sequence | | [int] 用来签名交易的sequence number | | +| --trust-node | true | 关闭响应结果校验 | | +## 用例 + +发送对软件升级提议（ID为5）switch消息 + +``` +iriscli upgrade submit-switch --chain-id=IRISnet --from=x --fee=0.004iris --proposalID 5 --title="Run new verison" +``` \ No newline at end of file From 900c0779e48fb3b0f713adb5f98c079e5af02c40 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 23:17:18 +0800 Subject: [PATCH 071/100] Finish the Feature/gov --- docs/zh/features/governance.md | 311 ++++++++++++--------------------- 1 file changed, 111 insertions(+), 200 deletions(-) diff --git a/docs/zh/features/governance.md b/docs/zh/features/governance.md index 8678c4cc4..a1ecd1be5 100644 --- a/docs/zh/features/governance.md +++ b/docs/zh/features/governance.md @@ -1,255 +1,166 @@ -# Gov/Iparam User Guide +# Gov User Guide -## 基本功能描述 +## Basic Function Description -1. 文本提议的链上治理 -2. 参数修改提议的链上治理 -3. 软件升级提议的链上治理 +1. On-chain governance proposals on text +2. On-chain governance proposals on parameter change +3. On-chain governance proposals on software upgrade -## 交互流程 +## Interactive process -### 治理流程 +### governance process -1. 任何用户可以发起提议，并抵押一部分token，如果超过`min_deposit`,提议进入投票，否则留在抵押期。其他人可以对在抵押期的提议进行抵押token，如果提议的抵押token总和超过`min_deposit`,则进入投票期。但若提议在抵押期停留的出块数目超过`max_deposit_period`，则提议被关闭。 -2. 进入投票期的提议，只有验证人和委托人可以进行投票。如果委托人没投票，则他继承他委托的验证人的投票选项。如果委托人投票了，则覆盖他委托的验证人的投票选项。当提议到达`voting_perid`,统计投票结果。 -3. 具体提议投票逻辑细节见[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) +1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value `min_deposit`, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches `min_deposit`, enter voting period. However, if the block-time exceeds `max_deposit_period` in the deposit period, the proposal will be closed. +2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. +3. Our tally have a limit on participation, Other details about voting for proposals: +[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) -## 使用场景 -### 创建使用环境 +## Usage Scenario -``` -rm -rf iris -rm -rf .iriscli -iris init gen-tx --name=x --home=iris -iris init --gen-txs --chain-id=gov-test -o --home=iris -iris start --home=iris -``` - -### 参数修改的使用场景 +### Usage scenario of parameter change -场景一：通过命令行带入参数修改信息进行参数修改 +Scenario 1：Change the parameters through the command lines ``` -# 根据gov模块名查询的可修改的参数 +# Query parameters can be changed by the modules'name in gov iriscli gov query-params --module=gov --trust-node -# 结果 +# Results [ - "Gov/gov/DepositProcedure", - "Gov/gov/TallyingProcedure", - "Gov/gov/VotingProcedure" +"Gov/govDepositProcedure", +"Gov/govTallyingProcedure", +"Gov/govVotingProcedure" ] -# 根据Key查询可修改参数的内容 -iriscli gov query-params --key=Gov/gov/DepositProcedure --trust-node +# Query parameters can be modified by "key” +iriscli gov query-params --key=Gov/govDepositProcedure --trust-node -# 结果 -{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":10}","op":""} +# Results +{"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":""} -# 发送提议，返回参数修改的内容 -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +# Send proposals, return changed parameters +iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"20000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":"update"}}' --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 -# 对提议进行抵押 -echo 1234567890 | iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +# Deposit for a proposal +iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 -# 对提议投票 -echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +# Vote for a proposal +echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 -# 查询提议情况 +# Query the state of a proposal iriscli gov query-proposal --proposal-id=1 --trust-node ``` -场景二，通过文件修改参数 +Scenario 2: Change the parameters by the files ``` -# 导出配置文件 +# Export profiles iriscli gov pull-params --path=iris --trust-node -# 查询配置文件信息 -cat iris/config/params.json +# Query profiles' info +cat iris/config/params.json { +"gov": { +"Gov/govDepositProcedure": { +"min_deposit": [ { - "gov": { - "Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" - }, - "Gov/gov/VotingProcedure": { - "voting_period": "10" - }, - "Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "1/100" - } - } +"denom": "iris-atto", +"amount": "10000000000000000000" +} +], +"max_deposit_period": "172800000000000" +}, +"Gov/govVotingProcedure": { +"voting_period": "10000000000" +}, +"Gov/govTallyingProcedure": { +"threshold": "0.5000000000", +"veto": "0.3340000000", +"participation": "0.6670000000" } -# 修改配置文件(TallyingProcedure的governance_penalty) -vi iris/config/params.json -{ - "gov": { - "Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" - }, - "Gov/gov/VotingProcedure": { - "voting_period": "10" - }, - "Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "20/100" - } - } } -# 通过文件修改参数的命令，返回参数修改的内容 -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/gov/TallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# 对提议进行抵押 -echo 1234567890 | iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# 对提议投票 -echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# 查询提议情况 -iriscli gov query-proposal --proposal-id=1 --trust-node -``` - -## CLI命令详情 - -### 治理模块基础方法 - -``` -# 文本类提议 -iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="Text" --deposit="10iris" --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` +# Modify profiles (TallyingProcedure的governance_penalty) +vi iris/config/params.json { +"gov": { +"Gov/govDepositProcedure": { +"min_deposit": [ +{ +"denom": "iris-atto", +"amount": "10000000000000000000" +} +], +"max_deposit_period": "172800000000000" +}, +"Gov/govVotingProcedure": { +"voting_period": "10000000000" +}, +"Gov/govTallyingProcedure": { +"threshold": "0.5000000000", +"veto": "0.3340000000", +"participation": "0.4990000000" +} +} -* `--title` 提议的标题 -* `--description` 提议的描述 -* `--type` 提议的类型 {'Text','ParameterChange','SoftwareUpgrade'} -* `--deposit` 抵押的token数量 -* 上面就是典型的文本类提议 +# Change the parameters through files, return changed parameters +iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/govTallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` +# Deposit for a proposal iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` -* `--propsal-id` 抵押提议ID -* `--deposit` 抵押的token数量 - -``` +# Vote for a proposal iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--proposal-id` 投票提议ID -* `--option` 投票的选项{'Yes'赞同,'Abstain'弃权,'No'不同意,'nowithVeto'强烈不同意} - -``` -# 查询提议情况 +# Query the state of a proposal iriscli gov query-proposal --proposal-id=1 --trust-node ``` -* `--proposal-id` 查询提议ID +### Proposals on software upgrade +Detail in [Upgrade](upgrade.md) - -### 参数修改提议部分 +## Basic parameters ``` -# 根据gov模块名查询的可修改的参数 -iriscli gov query-params --module=gov --trust-node -``` - -* `--module` 查询module可修改参数的key的列表 - - -``` -# 根据Key查询可修改参数的内容 -iriscli gov query-params --key=Gov/gov/DepositProcedure --trust-node -``` - -* `--key` 查询key对应的参数值 - -``` -# 导出配置文件 -iriscli gov pull-params --path=iris --trust-node -``` - -* `--path` 节点初始化的文件夹 - - - -``` -# 通过命令行带入参数修改信息进行参数修改 -iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--param` 参数修改的具体内容（通过query-params得到参数内容，然后直接对其修改，并在"op"上添上update,具体可见使用场景） -* 其他字段与文本提议类似 - -``` -# 通过文件修改参数的命令，返回参数修改的内容 -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/gov/TallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--path` 节点初始化的文件夹 -* `--key` 要修改参数的key -* `--op` 参数修改类型，目前只实现了'update' -* 其他字段与文本提议类似 - -### 软件升级提议部分 - -## 基本参数 - -``` -# DepositProcedure（抵押阶段的参数） -"Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" +# DepositProcedure（The parameters in deposit period） +"Gov/govDepositProcedure": { +"min_deposit": [ +{ +"denom": "iris-atto", +"amount": "10000000000000000000" +} +], +"max_deposit_period": "172800000000000" } ``` -* 可修改参数 -* 参数的key:"Gov/gov/DepositProcedure" -* `min_deposit[0].denom` 最小抵押token只能是单位是iris-atto的iris通证。 -* `min_deposit[0].amount` 最小抵押token数量,默认:10iris,范围（1iris，200iris） -* `max_deposit_period` 补交抵押token的窗口期,默认:10,范围（0，1） +* Parameters can be changed +* The key of parameters:"Gov/gov/DepositProcedure" +* `min_deposit[0].denom` The minimum tokens deposited are counted by iris-atto. +* `min_deposit[0].amount` The number of minimum tokens and the default scope：1000iris,（1iris，10000iris） +* `max_deposit_period` Window period for repaying deposit, default:172800000000000ns==2Days， scope（20s，3Day） ``` -# VotingProcedure（投票阶段的参数） -"Gov/gov/VotingProcedure": { - "voting_period": "10" -}, +# VotingProcedure（The parameters in voting period） +"Gov/govVotingProcedure": { +"voting_period": "10000000000" +} ``` -* `voting_perid` 投票的窗口期,默认:10,范围（20，20000） +* Parameters can be changed +* `voting_perid` Window period for vote, default:172800000000000ns==2Days, scope（20s，3Days） ``` -# TallyingProcedure (统计阶段段参数) -"Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "1/100" +# TallyingProcedure (The parameters in Tallying period) +"Gov/govTallyingProcedure": { +"threshold": "0.5000000000", +"veto": "0.3340000000", +"participation": "0.6670000000" } -``` -* `veto` 默认:1/3,范围（0，1） -* `threshold` 默认:1/2,范围（0，1） -* `governance_penalty` 未投票的验证人惩罚token的比例 默认:1/100,范围（0，1） -* 投票统计逻辑：如果强烈反对的voting_power占总的voting_power 超过 veto,提议不通过。然后再看赞同的voting_power占总的投票的voting_power 是否超过 veto,超过则提议不通过,不超过则不通过。 \ No newline at end of file +``` + +* Parameters can be changed +* `veto` default: 0.334, scope（0，1） +* `threshold` default: 0.5, scope（0，1） +* `governance_penalty` default: 0.667, scope（0，1） +* Vote rules:If the ratio of all voters' `voting_power` to the total 'voting_power' in system less than “participation”, the proposal won't be passed. If the ratio of strongly opposed `voting_power` to all voters' `voting_power` more than “veto”, the proposal won't be passed. Then if the ratio of approved `voting_power` to all voter's `voting_power` except abstentions over “threshold”, the proposal will be passed. Otherwise, N/A. From 77ae0cb8a2290a42150c2eee2c6e6586ef10068e Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 23:21:48 +0800 Subject: [PATCH 072/100] Finish the Bech32 --- .../features/basic-concepts/bech32-prefix.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/zh/features/basic-concepts/bech32-prefix.md b/docs/zh/features/basic-concepts/bech32-prefix.md index e69de29bb..b6ece16dd 100644 --- a/docs/zh/features/basic-concepts/bech32-prefix.md +++ b/docs/zh/features/basic-concepts/bech32-prefix.md @@ -0,0 +1,30 @@ +# Bech32 on IRISnet + +Bech32是由Pieter Wuille和Greg Maxwel提出的新比特币地址格式。除了比特币之外,bech32可以编码任何短二进制数据。在IRISnet里，私钥和地址可能指的是一些在网络中不同的角色，例如普通账户和验证人账户等。IRISnet设计使用Bech32地址格式来提供对数据鲁棒的完整性检查。 用户可读部分(human readable part) 使得用户更有效率的理解地址和阅读错误信息。 + + +## 用户可读部分表 + +| HRP | Definition | +| -----------|:-------------| +|faa| IRISnet Account Address| +|fap| IRISnet Account Public Key| +|fva| IRISnet Validator's Operator Address| +|fvp| IRISnet Validator's Operator Public Key| +|fca| IRISnet Consensus Address| +|fcp| IRISnet Consensus Public Key| + +## 编码 + +不是所有IRISnet的用户地址都会以bech32的格式暴露出来。许多地址仍然是hex编码或者base64编码。 在bech32编码之前，首先要使用amino对其他地址私钥二进制表示进行编码。 + +## 例子 + +一旦创建一个新的账户，你将会看到以下信息: + +``` +NAME: TYPE: ADDRESS: PUBKEY: +test1 local faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv +``` + +这意味着你创建了一个新账户地址 `faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl`， 他的用户可读部分是 `faa`。他的公钥被密码成 `fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv`， 他的用户可读部分是 `fap`。 \ No newline at end of file From c9f75a09c9008a4cd4ab674b3501de8f2a836da5 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 23:23:41 +0800 Subject: [PATCH 073/100] Finish the genesis --- docs/features/basic-concepts/genesis-file.md | 46 +++++++++++++++++++ .../features/basic-concepts/genesis-file.md | 46 +++++++++++++++++++ 2 files changed, 92 insertions(+) diff --git a/docs/features/basic-concepts/genesis-file.md b/docs/features/basic-concepts/genesis-file.md index e69de29bb..ded17325a 100644 --- a/docs/features/basic-concepts/genesis-file.md +++ b/docs/features/basic-concepts/genesis-file.md @@ -0,0 +1,46 @@ +# Genesis File + +The Genesis file is the basis for the entire network initialization，which contains most info for creating a Genesis block (such as ChainID, consensus params,app state), initialize account balances, parameters for each module, and validators info. + +## Basic State + +* genesis_time The time to build Genesis file +* chain_id Blockchain’s ID + +## Consensus Params + +* block_size Block size and config params of the number of Gas in the block +* evidence The lifecycle of deception evidence in the block + +## App State + +* **accounts** Initialization account info + +* **stake** Params related to the staking consensus + * `loose_tokens` The sum of unbonded tokens in the entire network + * `unbonding_time` The time between the moment a validator begin to unbond until the moment it is unbonded successfully + * `max_validators` The max of validators + +* **mint** Params related to inflation + * `inflation_max` The max of inflation rate + * `inflation_min` The min of inflation rate + +* **distribution** Params related to distribution & commission + +* **gov** Params related to on-chain governance + * `DepositProcedure` Params in deposit period + * `VotingProcedure` Params in voting period + * `TallyingProcedure` Params in tallying period + +* **upgrade** Params related to upgrade + * `switch_period` After upgrade, a switch message needs to be sent in switch_perid + +* **slashing** Params related to slashing validators + +* **service** Params related to Service + * `MaxRequestTimeout` The max of waiting blocks for service invocation + * `MinProviderDeposit` The min deposit for service binding + +## Gentxs + +Gentxs contains the transaction set of creating validators in genesis block. \ No newline at end of file diff --git a/docs/zh/features/basic-concepts/genesis-file.md b/docs/zh/features/basic-concepts/genesis-file.md index e69de29bb..ed88418e5 100644 --- a/docs/zh/features/basic-concepts/genesis-file.md +++ b/docs/zh/features/basic-concepts/genesis-file.md @@ -0,0 +1,46 @@ +# Genesis + +Genesis文件是整个网络初始化的基础。它包含了创建创世块的大部分信息(比如ChainID，共识的参数),初始化账户余额，每个模块的参数，validators信息。 + +## Basic State + +* genesis_time Genesis文件创建时间 +* chain_id 区块链的ID + +## Consensus Params + +* block_size 区块大小和区块内Gas数量的配置参数 +* evidence 区块内作恶证据的生命周期 + +## App State + +* **accounts** 初始化账户信息 + +* **stake** 与抵押共识相关的参数 + * `loose_tokens` 全网未绑定的通证总和 + * `unbonding_time` 开始解绑到解绑成功需要的时间 + * `max_validators` 最大验证人数目 + +* **mint** 与通货膨胀相关的参数 + * `inflation_max` 最大通货膨胀率 + * `inflation_min` 最小通货膨胀率 + +* **distribution** 与分配收益有关的参数 + +* **gov** 与链上治理相关的参数 + * `DepositProcedure` 抵押阶段的参数 + * `VotingProcedure` 投票阶段的参数 + * `TallyingProcedure` 统计阶段的参数 + +* **upgrade** 与升级相关的参数 + * `switch_period` 软件升级通过后需要在switch_perid内发送switch消息 + +* **slashing** 与惩罚validator相关的参数 + +* **service** 与Service相关的参数 + * `MaxRequestTimeout` 服务调用最大等待区块个数 + * `MinProviderDeposit` 服务绑定最小抵押金额 + +## Gentxs + +Gentxs中包含了创世区块中创建validators的交易集合。 \ No newline at end of file From 86b162783e769c4b42826933cbf74187297cf0f4 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 23:34:29 +0800 Subject: [PATCH 074/100] Finish the gov params --- docs/features/basic-concepts/gov-params.md | 18 ++++++++++++++++++ docs/zh/features/basic-concepts/gov-params.md | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/docs/features/basic-concepts/gov-params.md b/docs/features/basic-concepts/gov-params.md index e69de29bb..7b5a53761 100644 --- a/docs/features/basic-concepts/gov-params.md +++ b/docs/features/basic-concepts/gov-params.md @@ -0,0 +1,18 @@ +# Gov Params + +In IRISnet, there are some special parameters can be modified through on-chain governance. All the IRIS holders are able to modify. If the community is not satisfied with certain modifiable parameters, it is available to set the proper values in governance module. + +## Gov Module + +* `DepositProcedure` Parameters in deposit period (The minimum of deposit, deposit period) +* `VotingProcedure` Parameters in voting period（Voting period） +* `TallyingProcedure` Parameters in tallying period（The standards of voting） + +Details in [gov](gov.md) + +## Service Module + +* `MaxRequestTimeout` The maximum of waiting blocks for service invocation +* `MinProviderDeposit` The minimum deposit for service binding + +Details in [service](serivice.md) \ No newline at end of file diff --git a/docs/zh/features/basic-concepts/gov-params.md b/docs/zh/features/basic-concepts/gov-params.md index e69de29bb..5b653387b 100644 --- a/docs/zh/features/basic-concepts/gov-params.md +++ b/docs/zh/features/basic-concepts/gov-params.md @@ -0,0 +1,18 @@ +# Gov Params + +在IRISnet中，存在一些特殊的参数，它们可通过链上治理被修改。持有IRIS通证的用户都可以参与到参数修改的链上治理。如果社区对某些可修改的参数不满意，完全可以通过治理模块设置合适的值。 + +## Gov Module + +* `DepositProcedure` 抵押阶段的参数（最小抵押金额，抵押期） +* `VotingProcedure` 投票阶段的参数（投票期） +* `TallyingProcedure` 统计阶段的参数（投票是否通过的标准） + +详细见[gov](gov.md) + +## Service Module + +* `MaxRequestTimeout` 服务调用最大等待区块个数 +* `MinProviderDeposit` 服务绑定最小抵押金额 + +详细见[service](serivice.md) From bbc96960c0be2c477da30476c63184018feb8c67 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Fri, 16 Nov 2018 23:42:59 +0800 Subject: [PATCH 075/100] Finish the Bech32 EN --- docs/features/basic-concepts/bech32-prefix.md | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/features/basic-concepts/bech32-prefix.md b/docs/features/basic-concepts/bech32-prefix.md index e69de29bb..a0fc83ebb 100644 --- a/docs/features/basic-concepts/bech32-prefix.md +++ b/docs/features/basic-concepts/bech32-prefix.md @@ -0,0 +1,34 @@ +# Bech32 on IRISnet + +Bech32 is a new Bitcoin address format proposed by Pieter Wuille and Greg Maxwell. Besides Bitcoin addresses, Bech32 can encode any short binary data. In the IRIS network, keys and addresses may refer to a number of different roles in the network like accounts, validators etc. The IRIS network is designed to use the Bech32 address format to provide robust integrity checks on data. The human readable part(HRP) makes it more efficient to read and the users could see error messages. + + +## Human Readable Part Table + + +| HRP | Definition | +| -----------|:-------------| +|faa| IRISnet Account Address| +|fap| IRISnet Account Public Key| +|fva| IRISnet Validator's Operator Address| +|fvp| IRISnet Validator's Operator Public Key| +|fca| IRISnet Consensus Address| +|fcp| IRISnet Consensus Public Key| + +## Encoding + +Not all interfaces to users IRISnet should be exposed as bech32 interfaces. Many address are still in hex or base64 encoded form. + +To covert between other binary reprsentation of addresses and keys, it is important to first apply the Amino enocoding process before bech32 encoding. + + +## Example + +Once you create a new address, you should see the following: + +``` +NAME: TYPE: ADDRESS: PUBKEY: +test1 local faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv +``` + +This means you have created a new address `faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl`, its hrp is `faa`. And its public key could be encoded into `fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv`, its hrp is `fap`. From 26e2cc7ea28371ef935174ad97a9f3bbcd1959ef Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sat, 17 Nov 2018 13:34:35 +0800 Subject: [PATCH 076/100] Move all global flags to cli-client/README.md, and refactor stake and distribution interface --- docs/cli-client/README.md | 54 +++++++++ docs/cli-client/distribution/README.md | 111 ++++-------------- .../distribution/delegation-distr-info.md | 38 ++++++ .../distribution/delegator-distr-info.md | 42 +++++++ .../distribution/set-withdraw-address.md | 28 +++++ .../distribution/validator-distr-info.md | 43 +++++++ .../distribution/withdraw-address.md | 33 ++++++ .../distribution/withdraw-rewards.md | 41 +++++++ docs/cli-client/stake/README.md | 17 ++- docs/cli-client/stake/create-validator.md | 61 ++++------ docs/cli-client/stake/delegate.md | 36 ++---- docs/cli-client/stake/edit-validator.md | 54 +++------ docs/cli-client/stake/redelegate.md | 45 +++---- docs/cli-client/stake/unbond.md | 41 +++---- docs/cli-client/stake/unjail.md | 40 ++----- 15 files changed, 399 insertions(+), 285 deletions(-) create mode 100644 docs/cli-client/distribution/delegation-distr-info.md create mode 100644 docs/cli-client/distribution/delegator-distr-info.md create mode 100644 docs/cli-client/distribution/set-withdraw-address.md create mode 100644 docs/cli-client/distribution/validator-distr-info.md create mode 100644 docs/cli-client/distribution/withdraw-address.md create mode 100644 docs/cli-client/distribution/withdraw-rewards.md diff --git a/docs/cli-client/README.md b/docs/cli-client/README.md index c1901202e..f72b62dcc 100644 --- a/docs/cli-client/README.md +++ b/docs/cli-client/README.md @@ -1 +1,55 @@ # CLi Client + +## Global flags for query commands + +All query commands has their unique flags and these global flags. + +| Name, shorthand | type | Required | Default Value | Description | +| --------------- | ---- | -------- | --------------------- | -------------------------------------------------------------------- | +| --chain-id | string | false | "" | Chain ID of tendermint node | +| --height | int | false | 0 | block height to query, omit to get most recent provable block | +| --help, -h | string | false | | help for delegation | +| --indent | bool | false | false | Add indent to JSON response | +| --ledger | bool | false | false | Use a connected Ledger device | +| --node | string | false | tcp://localhost:26657 | \:\ to tendermint rpc interface for this chain | +| --trust-node | bool | false | true | Don't verify proofs for responses | + +## Global flags for commands to send transactions + +All commands which can be used to send transactions has their unique flags and these global flags. + +| Name, shorthand | type | Required | Default | Description | +| -----------------| ----- | -------- | --------------------- | ------------------------------------------------------------------- | +| --account-number | int | false | 0 | AccountNumber number to sign the tx | +| --async | bool | false | false | broadcast transactions asynchronously | +| --chain-id | string | true | "" | Chain ID of tendermint node | +| --dry-run | bool | false | false | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | +| --fee | string | true | "" | Fee to pay along with transaction | +| --from | string | false | "" | Name of private key with which to sign | +| --from-addr | string | false | "" | Specify from address in generate-only mode | +| --gas | int | false | 200000 | Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | +| --gas-adjustment | int | false | 1 | Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set | +| --generate-only | bool | false | false | Build an unsigned transaction and write it to STDOUT | +| --help, -h | string | false | | Help for delegate | +| --indent | bool | false | false | Add indent to JSON response | +| --json | string | false | false | Return output in json format | +| --ledger | bool | false | false | Use a connected Ledger device | +| --memo | string | false | "" | Memo to send along with transaction | +| --node | string | false | tcp://localhost:26657 | \:\ to tendermint rpc interface for this chain | +| --print-response | bool | false | false | return tx response (only works with async = false)| +| --sequence int | int | false | 0 | Sequence number to sign the tx | +| --trust-node | bool | false | true | Don't verify proofs for responses | + +## Command list + +1. [bank command](./bank/README.md) +2. [distribution command](./distribution/README.md) +3. [gov command](./gov/README.md) +4. [keys command](./keys/README.md) +5. [lcd command](./lcd/README.md) +6. [record command](./record/README.md) +7. [service command](./service/README.md) +8. [stake command](./stake/README.md) +9. [status command](./status/README.md) +10. [tendermint command](./tendermint/README.md) +11. [upgrade command](./upgrade/README.md) diff --git a/docs/cli-client/distribution/README.md b/docs/cli-client/distribution/README.md index e3facf88f..e7dca38c8 100644 --- a/docs/cli-client/distribution/README.md +++ b/docs/cli-client/distribution/README.md @@ -1,99 +1,28 @@ -# Introduction +# iriscli distribution -This document description how to use the the command line interface of distribution module. - -# Query interface - -By default, trust-node mode is enable. If you don't trust the connected node, just append --trust-node=false in each query command. - -1. Query withdraw address - - For example: - ```bash - iriscli distribution withdraw-address faa1vm068fnjx28zv7k9kd9j85wrwhjn8vfsxfmcrz - ``` - If the given delegator doesn't specify other withdraw address, the query result will be empty. +## Description -2. Query delegation distribution information - - For example: - ```bash - iriscli distribution delegation-distr-info --address-delegator=faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j \ - --address-validator=fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4 - ``` - Query result: - ```json - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", - "del_pool_withdrawal_height": "4044" - } - ``` - The above response means this delegator has send transaction to withdraw reward at height 4044 or the delegation is created on height 4044. - -2. Query delegator distribution information - - For example: - ```bash - iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j - ``` - Query result: - ```json - [ - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", - "del_pool_withdrawal_height": "10859" - }, - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", - "del_pool_withdrawal_height": "4044" - } - ] - ``` +This document description how to use the the command line interface of distribution module. -4. Query validator distribution information +## Usage - For example: - ```bash - iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j - ``` - Query result: - ```json - { - "operator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "fee_pool_withdrawal_height": "416", - "del_accum": { - "update_height": "416", - "accum": "0.0000000000" - }, - "del_pool": "0.0000000000iris", - "val_commission": "0.0000000000iris" - } - ``` +```shell +iriscli distribution [subcommand] +``` -# Send transactions interface +Print all supported subcommands and options: -1. Set withdraw address +```shell +iriscli distribution --help +``` - Validator operators or delegators can specify other address as their withdraw address. If no other address has been specified, the delegator address or validator self-delegator address will be used as default address. - For example: - ```bash - iriscli distribution set-withdraw-addr faa1syva9fvh8m6dc6wjnjedah64mmpq7rwwz6nj0k --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - -2. withdraw rewards +## Available Commands - 1. Only withdraw the delegation reward from a given validator - ```bash - iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - 2. Withdraw all delegation reward of a delegator - ```bash - iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - 3. If the delegator is a onwer of a validator, withdraw all delegation reward and validator reward: - ```bash - iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test - ``` \ No newline at end of file +| Name | Description | +| --------------------------------| --------------------------------------------------------------| +| [delegation-distr-info](delegation-distr-info.md) | Query delegation distribution information | +| [delegator-distr-info](delegator-distr-info.md) | Query delegator distribution information | +| [validator-distr-info](validator-distr-info.md) | Query validator distribution information | +| [withdraw-address](withdraw-address.md) | Query withdraw address | +| [set-withdraw-address](set-withdraw-address.md) | change the default withdraw address for rewards associated with an address | +| [withdraw-rewards](withdraw-rewards.md) | withdraw rewards for either: all-delegations, a delegation, or a validator | diff --git a/docs/cli-client/distribution/delegation-distr-info.md b/docs/cli-client/distribution/delegation-distr-info.md new file mode 100644 index 000000000..a070ac4fa --- /dev/null +++ b/docs/cli-client/distribution/delegation-distr-info.md @@ -0,0 +1,38 @@ +# iriscli distribution delegation-distr-info + +## Description + +Query delegation distribution information + +## Usage + +``` +iriscli distribution delegation-distr-info [flags] +``` + +Print all supported options: + +```shell +iriscli distribution delegation-distr-info --help +``` + +## Unique Flags + +| Name, shorthand | type | Required | Default | Description | +| --------------------| ----- | -------- | -------- | ------------------------------------------------------------------- | +| --address-validator | string | true | "" | Bech address of the validator | +| --address-delegator | string | true | "" | Bech address of the delegator | + +## Examples + +```shell +iriscli distribution delegation-distr-info --address-delegator= --address-validator= +``` +Example response: +```json +{ + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" +} +``` \ No newline at end of file diff --git a/docs/cli-client/distribution/delegator-distr-info.md b/docs/cli-client/distribution/delegator-distr-info.md new file mode 100644 index 000000000..1fa122735 --- /dev/null +++ b/docs/cli-client/distribution/delegator-distr-info.md @@ -0,0 +1,42 @@ +# iriscli distribution delegator-distr-info + +## Description + +Query delegator distribution information + +## Usage + +``` +iriscli distribution delegator-distr-info [flags] +``` + +Print all supported options: + +```shell +iriscli distribution delegator-distr-info --help +``` + +## Unique Flags + +There is no unique option. But it requires a argument: delegator address + +## Examples + +```shell +iriscli distribution delegation-distr-info +``` +Example response: +```json +[ + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", + "del_pool_withdrawal_height": "10859" + }, + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } +] +``` \ No newline at end of file diff --git a/docs/cli-client/distribution/set-withdraw-address.md b/docs/cli-client/distribution/set-withdraw-address.md new file mode 100644 index 000000000..bc9b5ed4c --- /dev/null +++ b/docs/cli-client/distribution/set-withdraw-address.md @@ -0,0 +1,28 @@ +# iriscli distribution set-withdraw-addr + +## Description + +Set withdraw address of a delegator + +## Usage + +``` +iriscli distribution set-withdraw-addr [withdraw-addr] [flags] +``` + +Print all supported options: + +```shell +iriscli distribution set-withdraw-addr --help +``` + +## Unique Flags + +There is no unique option. But it requires a argument: new withdraw address + + +## Examples + +```shell +iriscli distribution set-withdraw-addr
--from --fee=0.004iris --chain-id= +``` diff --git a/docs/cli-client/distribution/validator-distr-info.md b/docs/cli-client/distribution/validator-distr-info.md new file mode 100644 index 000000000..486c4142a --- /dev/null +++ b/docs/cli-client/distribution/validator-distr-info.md @@ -0,0 +1,43 @@ +# iriscli distribution validator-distr-info + +## Description + +Query validator distribution information + +## Usage + +``` +iriscli distribution validator-distr-info [flags] +``` + +Print all supported options: + +```shell +iriscli distribution validator-distr-info --help +``` + +## Unique Flags + +There is no unique option. But it requires a argument: validator address + + +## Examples + +```shell +iriscli distribution validator-distr-info +``` +Example response: +```json +[ + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", + "del_pool_withdrawal_height": "10859" + }, + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } +] +``` \ No newline at end of file diff --git a/docs/cli-client/distribution/withdraw-address.md b/docs/cli-client/distribution/withdraw-address.md new file mode 100644 index 000000000..be1c4fcb6 --- /dev/null +++ b/docs/cli-client/distribution/withdraw-address.md @@ -0,0 +1,33 @@ +# iriscli distribution withdraw-address + +## Description + +Query withdraw address of a delegator + +## Usage + +``` +iriscli distribution withdraw-address [delegator address] [flags] +``` + +Print all supported options: + +```shell +iriscli distribution withdraw-address --help +``` + +## Unique Flags + +There is no unique option. But it requires a argument: delegator address + + +## Examples + +```shell +iriscli distribution withdraw-address +``` +Example response: +```text +faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j +``` +If the given delegator didn't specify other withdraw address, the query result will be empty. \ No newline at end of file diff --git a/docs/cli-client/distribution/withdraw-rewards.md b/docs/cli-client/distribution/withdraw-rewards.md new file mode 100644 index 000000000..c6e44f78f --- /dev/null +++ b/docs/cli-client/distribution/withdraw-rewards.md @@ -0,0 +1,41 @@ +# iriscli distribution withdraw-rewards + +## Description + +Withdraw rewards + +## Usage + +``` +iriscli distribution withdraw-rewards [flags] +``` + +Print all supported options: + +```shell +iriscli distribution withdraw-rewards --help +``` + +## Unique Flags + +| Name, shorthand | type | Required | Default | Description | +| --------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | +| --only-from-validator | string | false | "" | only withdraw from this validator address (in bech) | +| --is-validator | bool | false | false | Also withdraw validator's commission | + +Keep in mind, don't specify the above options both. + +## Examples + +1. Only withdraw the delegation reward from a given validator + ``` + iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test + ``` +2. Withdraw all delegation reward of a delegator + ``` + iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test + ``` +3. If the delegator is a onwer of a validator, withdraw all delegation reward and validator reward: + ``` + iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test + ``` \ No newline at end of file diff --git a/docs/cli-client/stake/README.md b/docs/cli-client/stake/README.md index 1ae4daf48..cd6b52e91 100644 --- a/docs/cli-client/stake/README.md +++ b/docs/cli-client/stake/README.md @@ -2,12 +2,17 @@ ## Description -Stake allows you to execute stake and validation subcommands +Stake module provides a set of subcommands to query staking state and send staking transactions. ## Usage ```shell -iriscli stake [command] +iriscli stake [subcommand] +``` + +Print all supported subcommands and flags: +```shell +iriscli stake --help ``` ## Available Commands @@ -34,11 +39,3 @@ iriscli stake [command] | [redelegate](redelegate.md) | Redelegate illiquid tokens from one validator to another | | [unjail](unjail.md) | Unjail validator previously jailed for downtime | -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | ------- | --------------- | -------- | -| --help, -h | | help for stake | | - - diff --git a/docs/cli-client/stake/create-validator.md b/docs/cli-client/stake/create-validator.md index 3816421a1..c9d92ff88 100644 --- a/docs/cli-client/stake/create-validator.md +++ b/docs/cli-client/stake/create-validator.md @@ -2,7 +2,7 @@ ## Description -Create new validator initialized with a self-delegation to it +Create new validator initialized with a self-delegation on it ## Usage @@ -10,49 +10,34 @@ Create new validator initialized with a self-delegation to it iriscli stake create-validator [flags] ``` -## Flags - -| Name, shorthand | Default | Description | Required | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --address-delegator | | [string] Bech address of the delegator | | -| --amount | | [string] Amount of coins to bond | Yes | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --commission-max-change-rate | | [string] The maximum commission change rate percentage (per day) | Yes | -| --commission-max-rate | | [string] The maximum commission rate percentage | Yes | -| --commission-rate | | [string] The initial commission rate percentage | Yes | -| --details | | [string] Optional details | | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignor | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --genesis-format | | Export the transaction in gen-tx format; it implies --generate-only | | -| --help, -h | | Help for create-validator | | -| --identity | | [string] Optional identity signature (ex. UPort or Keybase) | | -| --indent | | Add indent to JSON response | | -| --ip | | [string] Node's public IP. It takes effect only when used in combination with --genesis-format | | -| --json | | Return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --moniker | | [string] Validator name | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --node-id | | [string] Node's ID | | -| --print-response | | Return tx response (only works with async = false) | | -| --pubkey | | [string] Go-Amino encoded hex PubKey of the validator. For Ed25519 the go-amino prepend hex is 1624de6220 | Yes | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | -| --website | | [string] Optional website | | +Print help messages: +```shell +iriscli stake create-validator --help +``` + +## Unique Flags + +| Name, shorthand | type | Required | Default | Description | +| ---------------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | +| --address-delegator | string | true | "" | Bech address of the delegator | +| --amount | string | true | "" | Amount of coins to bond | +| --commission-max-change-rate | float | true | 0.0 | The maximum commission change rate percentage (per day)| +| --commission-max-rate | float | true | 0.0 | The maximum commission rate percentage | +| --commission-rate | float | true | 0.0 | The initial commission rate percentage | +| --details | string | false | "" | Optional details | +| --genesis-format | bool | false | false | Export the transaction in gen-tx format; it implies --generate-only | +| --identity | string | false | "" | Optional identity signature (ex. UPort or Keybase) | +| --ip | string | false | "" | Node's public IP. It takes effect only when used in combination with | +| --moniker | string | true | "" | Validator name | +| --pubkey | string | true | "" | Go-Amino encoded hex PubKey of the validator. For Ed25519 the go-amino prepend hex is 1624de6220 | +| --website | string | false | "" | Optional website | ## Examples ### Create new validator ```shell -iriscli stake create-validator --chain-id=ChainID --from=KeyName --fee=Fee --pubkey=ValidatorPublicKey --commission-max-change-rate=CommissionMaxChangeRate --commission-max-rate=CommissionMaxRate --commission-rate=CommissionRate --amount=Coins +iriscli stake create-validator --chain-id= --from= --fee=0.004iris --pubkey= --commission-max-change-rate=0.01 --commission-max-rate=0.2 --commission-rate=0.1 --amount=100iris --moniker= ``` After that, you're done with creating a new validator. diff --git a/docs/cli-client/stake/delegate.md b/docs/cli-client/stake/delegate.md index 5c3c7b316..b9e315591 100644 --- a/docs/cli-client/stake/delegate.md +++ b/docs/cli-client/stake/delegate.md @@ -10,31 +10,17 @@ Delegate liquid tokens to an validator iriscli stake delegate [flags] ``` -## Flags - -| Name, shorthand | Default | Description | Required | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --address-validator | | [string] Bech address of the validator | Yes | -| --amount | | [string] Amount of coins to bond | Yes | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set |manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | Help for delegate | | -| --indent | | Add indent to JSON response | | -| --json | | Return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence int | | Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +```shell +iriscli stake delegate --help +``` + +## Unique Flags + +| Name, shorthand | type | Required | Default | Description | +| --------------------| ----- | -------- | -------- | ------------------------------------------------------------------- | +| --address-delegator | string | true | "" | Bech address of the delegator | +| --amount | string | true | "" | Amount of coins to bond | ## Examples diff --git a/docs/cli-client/stake/edit-validator.md b/docs/cli-client/stake/edit-validator.md index 36dc8c3ce..98debd321 100644 --- a/docs/cli-client/stake/edit-validator.md +++ b/docs/cli-client/stake/edit-validator.md @@ -2,60 +2,38 @@ ## Description -Edit existing validator account +Edit existing validator ## Usage ``` iriscli stake edit-validator [flags] ``` +Print help messages: +```shell +iriscli stake edit-validator --help +``` + +## Unique Flags -## Flags +| Name, shorthand | type | Required | Default | Description | +| --------------------| ----- | -------- | -------- | ------------------------------------------------------------------- | +| --commission-rate | string | float | 0.0 | Commission rate percentage | +| --moniker | string | false | "" | Validator name | +| --identity | string | false | "" | Optional identity signature (ex. UPort or Keybase) | +| --website | string | false | "" | Optional website | +| --details | string | false | "" | Optional details | -| Name, shorthand | Default | Description | Required | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --address-delegator | | [string] Bech address of the delegator | | -| --amount | | [string] Amount of coins to bond | | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --commission-max-change-rate | | [string] The maximum commission change rate percentage (per day) | | -| --commission-max-rate | | [string] The maximum commission rate percentage | | -| --commission-rate | | [string] The initial commission rate percentage | | -| --details | | [string] Optional details | | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignor | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --genesis-format | | Export the transaction in gen-tx format; it implies --generate-only | | -| --help, -h | | Help for edit-validator | | -| --identity | | [string] Optional identity signature (ex. UPort or Keybase) | | -| --indent | | Add indent to JSON response | | -| --ip | | [string] Node's public IP. It takes effect only when used in combination with --genesis-format | | -| --json | | Return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --moniker | | [string] Validator name | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --node-id | | [string] Node's ID | | -| --print-response | | Return tx response (only works with async = false) | | -| --pubkey | | [string] Go-Amino encoded hex PubKey of the validator. For Ed25519 the go-amino prepend hex is 1624de6220 | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | -| --website | | [string] Optional website | | ## Examples ### Edit existing validator account ```shell -iriscli stake edit-validator --from=KeyName --chain-id=ChainID --fee=Fee --memo=YourMemo +iriscli stake edit-validator --from= --chain-id= --fee=0.004iris --commission-rate=0.15 ``` -After that, you're done with editting a new validator. +After that, you're done with editing a new validator. ```txt Committed at block 2160 (tx hash: C48CABDA1183B5319003433EB1FDEBE5A626E00BD319F1A84D84B6247E9224D1, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:3540 Tags:[{Key:[97 99 116 105 111 110] Value:[101 100 105 116 45 118 97 108 105 100 97 116 111 114] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[109 111 110 105 107 101 114] Value:[117 98 117 110 116 117 49 56] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[105 100 101 110 116 105 116 121] Value:[] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 55 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) diff --git a/docs/cli-client/stake/redelegate.md b/docs/cli-client/stake/redelegate.md index a54d1e319..e211cec84 100644 --- a/docs/cli-client/stake/redelegate.md +++ b/docs/cli-client/stake/redelegate.md @@ -2,7 +2,7 @@ ## Description -Redelegate illiquid tokens from one validator to another +Redelegate transfer delegation from one validator to another one. ## Usage @@ -10,33 +10,22 @@ Redelegate illiquid tokens from one validator to another iriscli stake redelegate [flags] ``` -## Flags - -| Name, shorthand | Default | Description | Required | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --address-validator-dest | | [string] Bech address of the destination validator | Yes | -| --address-validator-source | | [string] Bech address of the source validator | Yes | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it || -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically || -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored || -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for redelegate | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --shares-amount | | [string] Amount of source-shares to either unbond or redelegate as a positive integer or decimal || -| --shares-percent | | [string] Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 || -| --trust-node | true | Don't verify proofs for responses | | +Print all help messages: + +```shell +iriscli stake redelegate --help +``` + +## Unique Flags + +| Name, shorthand | type | Required | Default | Description | +| -------------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | +| --address-validator-dest | string | true | "" | Bech address of the destination validator | +| --address-validator-source | string | true | "" | Bech address of the source validator | +| --shares-amount | float | false | 0.0 | Amount of source-shares to either unbond or redelegate as a positive integer or decimal | +| --shares-percent | float | false | 0.0 | Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 | + +Users must specify the redeleagte amount. There two options can do this: `--shares-amount` or `--shares-percent`. Keep in mind, don't specify them both. ## Examples diff --git a/docs/cli-client/stake/unbond.md b/docs/cli-client/stake/unbond.md index bcea3aeb2..bc8ecdbc8 100644 --- a/docs/cli-client/stake/unbond.md +++ b/docs/cli-client/stake/unbond.md @@ -10,32 +10,21 @@ Unbond shares from a validator iriscli stake unbond [flags] ``` -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --address-validator | | [string] Bech address of the validator | Yes | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for unbond | | -| --indent | | Add indent to JSON response | | -| --json | | Return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --print-response | | Return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --shares-amount | | [string] Amount of source-shares to either unbond or redelegate as a positive integer or decimal | | -| --shares-percent | | [string] Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 | | -| --trust-node | true | Don't verify proofs for responses | | +Print all help messages: + +```shell +iriscli stake unbond --help +``` + +## Unique Flags + +| Name, shorthand | type | Required | Default | Description | +| --------------------| ----- | -------- | -------- | ------------------------------------------------------------------- | +| --address-delegator | string | true | "" | Bech address of the delegator | +| --shares-amount | float | false | 0.0 | Amount of source-shares to either unbond or redelegate as a positive integer or decimal | +| --shares-percent | float | false | 0.0 | Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 | + +Users must specify the unbond amount. There two options can do this: `--shares-amount` or `--shares-percent`. Keep in mind, don't specify them both. ## Examples diff --git a/docs/cli-client/stake/unjail.md b/docs/cli-client/stake/unjail.md index 566cbe72e..74a582207 100644 --- a/docs/cli-client/stake/unjail.md +++ b/docs/cli-client/stake/unjail.md @@ -7,43 +7,25 @@ Unjail validator previously jailed for downtime ## Usage ``` -iriscli stake redelegate [flags] +iriscli stake unjail [flags] ``` -## Flags - -| Name, shorthand | Default | Description | Required | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --address-validator-dest | | [string] Bech address of the destination validator | | -| --address-validator-source | | [string] Bech address of the source validator | | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it || -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically || -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored || -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --help, -h | | help for unjail | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence int | | Sequence number to sign the tx | | -| --shares-amount | | [string] Amount of source-shares to either unbond or redelegate as a positive integer or decimal || -| --shares-percent | | [string] Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 || -| --trust-node | true | Don't verify proofs for responses | | +Print all help messages: + +```shell +iriscli stake unjail --help +``` + +## Unique Flags + +There is no unique flags. ## Examples ### Unjail validator previously jailed for downtime ```shell -iriscli stake unjail --from=KeyName --fee=Fee --chain-id=ChainID +iriscli stake unjail --from= --fee=0.004iris --chain-id= ``` After that, you're done with unjailing specified validator. From 008f43a1f3bac8283b41f365f1082e3f39127cfe Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sat, 17 Nov 2018 14:25:21 +0800 Subject: [PATCH 077/100] Refactor Chinese docs for distribution --- docs/zh/README.md | 58 ++++++++- docs/zh/cli-client/distribution/README.md | 111 ++++-------------- .../distribution/delegation-distr-info.md | 38 ++++++ .../distribution/delegator-distr-info.md | 42 +++++++ .../distribution/set-withdraw-address.md | 28 +++++ .../distribution/validator-distr-info.md | 43 +++++++ .../distribution/withdraw-address.md | 33 ++++++ .../distribution/withdraw-rewards.md | 41 +++++++ 8 files changed, 299 insertions(+), 95 deletions(-) create mode 100644 docs/zh/cli-client/distribution/delegation-distr-info.md create mode 100644 docs/zh/cli-client/distribution/delegator-distr-info.md create mode 100644 docs/zh/cli-client/distribution/set-withdraw-address.md create mode 100644 docs/zh/cli-client/distribution/validator-distr-info.md create mode 100644 docs/zh/cli-client/distribution/withdraw-address.md create mode 100644 docs/zh/cli-client/distribution/withdraw-rewards.md diff --git a/docs/zh/README.md b/docs/zh/README.md index 0d04c7b6c..c4586a191 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -1,5 +1,55 @@ -# IRISnet文档目录 -![irisnet](../pics/iris.jpg) +# 命令行客户端 -IRIS网络是上海边界智能和Tendermint团队合作打造的跨链区块链网络，将是Cosmos网络生态中的第一个区域性枢纽(Hub)，并专注于为分布式商业应用提供基础 设施和协议。 -IRISnet将面向服务的基础设施融入到Cosmos网络中，支持对包括公链、联盟链以及 现有传统商业系统的集成从而实现互联互通。通过对Cosmos网络的跨链协议进行创新 扩展，IRISnet允许数据及复杂计算跨异构网络被调用。就像忠实地在人间和天堂传递 信息的希腊彩虹女神 Iris, IRISnet的目标是成为链接数字经济和实体经济，支持构建复 杂分布式商业应用的下一代公链。 +## 查询命令的flags + +| Name, shorthand | type | Required | Default Value | Description | +| --------------- | ---- | -------- | --------------------- | -------------------------------------------------------------------- | +| --chain-id | string | false | "" | Tendermint节点的Chain ID | +| --height | int | false | 0 | 查询某个高度的区块链数据，如果是0，这返回最新的区块链数据 | +| --help, -h | string | false | | 打印帮助信息 | +| --indent | bool | false | false | 格式化json字符串| +| --ledger | bool | false | false | 是否使用硬件钱包 | +| --node | string | false | tcp://localhost:26657 | tendermint节点的rpc地址| +| --trust-node | bool | false | true | 是否信任全节点返回的数据，如果不信任，客户端会验证查询结果的正确性 | + +每个区块链状态查询命令都包含上表中的flags，同时不同查询命令还可能会有自己独有的flags。 + +## 发送交易命令的flags + +| Name, shorthand | type | Required | Default | Description | +| -----------------| ----- | -------- | --------------------- | ------------------------------------------------------------------- | +| --account-number | int | false | 0 | 发起交易的账户的编号 | +| --async | bool | false | false | 是否异步广播交易 | +| --chain-id | string | true | "" | Tendermint节点的`Chain ID` | +| --dry-run | bool | false | false | 模拟执行交易，并返回消耗的`gas`。`--gas`指定的值会被忽略 | +| --fee | string | true | "" | 交易费 | +| --from | string | false | "" | 发送交易的账户名称 | +| --from-addr | string | false | "" | 签名地址，在`generate-only`为`true`的情况下有效 | +| --gas | int | false | 200000 | 交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | +| --gas-adjustment | int | false | 1 | gas调整因子，这个值降乘以模拟执行消耗的`gas`，计算的结果返回给用户; 如果`--gas`的值不是`simulate`，这个标志将被忽略 | +| --generate-only | bool | false | false | 是否仅仅构建一个未签名的交易便返回 | +| --help, -h | string | false | | 打印帮助信息 | +| --indent | bool | false | false | 格式化json字符串 | +| --json | string | false | false | 指定返回结果的格式，`json`或者`text` | +| --ledger | bool | false | false | 是否使用硬件钱包| +| --memo | string | false | "" | 指定交易的memo字段 | +| --node | string | false | tcp://localhost:26657 | tendermint节点的rpc地址 | +| --print-response | bool | false | false | 是否打印交易返回结果，仅在`async`为true的情况下有效| +| --sequence int | int | false | 0 | 发起交易的账户的sequence | +| --trust-node | bool | false | true | 是否信任全节点返回的数据，如果不信任，客户端会验证查询结果的正确性 | + +每个发送交易的命令都包含上表中的flags，同时不同交易的命令还可能会有自己独有的flags。 + +## Command list + +1. [bank command](./bank/README.md) +2. [distribution command](./distribution/README.md) +3. [gov command](./gov/README.md) +4. [keys command](./keys/README.md) +5. [lcd command](./lcd/README.md) +6. [record command](./record/README.md) +7. [service command](./service/README.md) +8. [stake command](./stake/README.md) +9. [status command](./status/README.md) +10. [tendermint command](./tendermint/README.md) +11. [upgrade command](./upgrade/README.md) diff --git a/docs/zh/cli-client/distribution/README.md b/docs/zh/cli-client/distribution/README.md index b82ff74ed..1b9fbc879 100644 --- a/docs/zh/cli-client/distribution/README.md +++ b/docs/zh/cli-client/distribution/README.md @@ -1,99 +1,28 @@ -# 介绍 +# iriscli distribution -这里主要介绍distribution模块对于的命令行接口。 +## 介绍 -# 查询接口 +这里主要介绍distribution模块提供的命令行接口 -在默认情况下，所以查询命令处于信任模式，也就是在查询的时候不要求全节点返回查询结果对于的proof，并且即使全节点返回proof也不会对其进行验证。如果用户不信任所连接的全节点，可以通过在查询命令后天就`--trust-node=false`来使能非信任模式。 +## 用法 -1. 查询撤回地址 +```shell +iriscli distribution [subcommand] +``` - 示例命令: - ```bash - iriscli distribution withdraw-address faa1vm068fnjx28zv7k9kd9j85wrwhjn8vfsxfmcrz - ``` - 如果委托人没有指定过撤回地址，那么查询结果为空。 +打印所以子命令和参数 -2. 查询委托(delegation)的收益分配记录 +```shell +iriscli distribution --help +``` - 示例命令: - ```bash - iriscli distribution delegation-distr-info --address-delegator=faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j \ - --address-validator=fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4 - ``` - 示例查询结果： - ```json - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", - "del_pool_withdrawal_height": "4044" - } - ``` - 从这个查询结果可知，这个委托是在4044高度创建的，或者在4044高度发起过撤回交易。 +## 子命令 -2. 查询委托人所有的委托(delegation)的收益分配记录 - - 示例命令: - ```bash - iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j - ``` - 示例查询结果： - ```json - [ - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", - "del_pool_withdrawal_height": "10859" - }, - { - "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", - "del_pool_withdrawal_height": "4044" - } - ] - ``` - -4. 查询验证人收益分配记录 - - 示例命令: - ```bash - iriscli distribution delegator-distr-info faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j - ``` - 示例查询结果： - ```json - { - "operator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", - "fee_pool_withdrawal_height": "416", - "del_accum": { - "update_height": "416", - "accum": "10000.0000000000" - }, - "del_pool": "10.1300000000iris", - "val_commission": "1.2345000000iris" - } - ``` - 从这个查询结果可知，这个委托是在4044高度创建的，或者在4044高度发起过撤回交易。 - -# 发交易接口 - -1. 设置收益收款地址 - - 示例命令: - ```bash - iriscli distribution set-withdraw-addr faa1syva9fvh8m6dc6wjnjedah64mmpq7rwwz6nj0k --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - -2. withdraw rewards - - 1. 仅撤回某一个委托产生的收益 - ```bash - iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - 2. 仅撤回某所有委托产生的收益 - ```bash - iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test - ``` - 3. 仅撤回某所有委托产生的收益和验证人的佣金收益 - ```bash - iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test - ``` \ No newline at end of file +| 名称 | 功能 | +| --------------------------------| --------------------------------------------------------------| +| [delegation-distr-info](delegation-distr-info.md) | 查询委托(delegation)的收益分配记录 | +| [delegator-distr-info](delegator-distr-info.md) | 查询委托人所有的委托(delegation)的收益分配记录 | +| [validator-distr-info](validator-distr-info.md) | 查询验证人收益分配记录 | +| [withdraw-address](withdraw-address.md) | 查询收益取回地址 | +| [set-withdraw-address](set-withdraw-address.md) | 设置收益取回地址 | +| [withdraw-rewards](withdraw-rewards.md) | 发起取回收益的交易 | diff --git a/docs/zh/cli-client/distribution/delegation-distr-info.md b/docs/zh/cli-client/distribution/delegation-distr-info.md new file mode 100644 index 000000000..1e7f3801b --- /dev/null +++ b/docs/zh/cli-client/distribution/delegation-distr-info.md @@ -0,0 +1,38 @@ +# iriscli distribution delegation-distr-info + +## 介绍 + +查询某个委托的收益分配信息 + +## 用法 + +``` +iriscli distribution delegation-distr-info [flags] +``` + +打印帮助信息 + +```shell +iriscli distribution delegation-distr-info --help +``` + +## 特有的flags + +| 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | +| --------------------| ----- | -------- | -------- | -------------- | +| --address-validator | string | true | "" | 验证人bech地址 | +| --address-delegator | string | true | "" | 委托人bech地址 | + +## 示例 + +```shell +iriscli distribution delegation-distr-info --address-delegator= --address-validator= +``` +执行结果示例 +```json +{ + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" +} +``` \ No newline at end of file diff --git a/docs/zh/cli-client/distribution/delegator-distr-info.md b/docs/zh/cli-client/distribution/delegator-distr-info.md new file mode 100644 index 000000000..45d2f9255 --- /dev/null +++ b/docs/zh/cli-client/distribution/delegator-distr-info.md @@ -0,0 +1,42 @@ +# iriscli distribution delegator-distr-info + +## 介绍 + +查询委托人全部委托的收益分配信息 + +## 用法 + +``` +iriscli distribution delegator-distr-info [flags] +``` + +打印帮助信息 + +```shell +iriscli distribution delegator-distr-info --help +``` + +## 特有的flags + +这个命令没有特有的flag，它有一个输入参数：delegator的地址 + +## 示例 + +```shell +iriscli distribution delegation-distr-info +``` +执行结果示例 +```json +[ + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", + "del_pool_withdrawal_height": "10859" + }, + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } +] +``` \ No newline at end of file diff --git a/docs/zh/cli-client/distribution/set-withdraw-address.md b/docs/zh/cli-client/distribution/set-withdraw-address.md new file mode 100644 index 000000000..17fe2204c --- /dev/null +++ b/docs/zh/cli-client/distribution/set-withdraw-address.md @@ -0,0 +1,28 @@ +# iriscli distribution set-withdraw-addr + +## 介绍 + +设置取回收益时的收款地址 + +## 用法 + +``` +iriscli distribution set-withdraw-addr [withdraw-addr] [flags] +``` + +打印帮助信息: + +``` +iriscli distribution set-withdraw-addr --help +``` + +## 特有的flags + +这个命令没有特有的flag，它有一个输入参数：收款地址 + + +## 示例 + +``` +iriscli distribution set-withdraw-addr
--from --fee=0.004iris --chain-id= +``` diff --git a/docs/zh/cli-client/distribution/validator-distr-info.md b/docs/zh/cli-client/distribution/validator-distr-info.md new file mode 100644 index 000000000..21205b0db --- /dev/null +++ b/docs/zh/cli-client/distribution/validator-distr-info.md @@ -0,0 +1,43 @@ +# iriscli distribution validator-distr-info + +## 介绍 + +查询验证人的收益分配信息 + +## 用法 + +``` +iriscli distribution validator-distr-info [flags] +``` + +打印帮助信息: + +``` +iriscli distribution validator-distr-info --help +``` + +## 特有的flags + +这个命令没有特有的flag，它有一个输入参数：验证人地址 + + +## 示例 + +``` +iriscli distribution validator-distr-info +``` +执行结果示例 +```json +[ + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva14a70gzu0v2w8dlfx462c9sldvja24qaz6vv4sg", + "del_pool_withdrawal_height": "10859" + }, + { + "delegator_addr": "faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j", + "val_operator_addr": "fva1ezzh0humhy3329xg4avhcjtay985nll0hpyhf4", + "del_pool_withdrawal_height": "4044" + } +] +``` \ No newline at end of file diff --git a/docs/zh/cli-client/distribution/withdraw-address.md b/docs/zh/cli-client/distribution/withdraw-address.md new file mode 100644 index 000000000..c7e6607b0 --- /dev/null +++ b/docs/zh/cli-client/distribution/withdraw-address.md @@ -0,0 +1,33 @@ +# iriscli distribution withdraw-address + +## 介绍 + +查收取回收益时的收款地址 + +## 用法 + +``` +iriscli distribution withdraw-address [delegator address] [flags] +``` + +打印帮助信息: + +``` +iriscli distribution withdraw-address --help +``` + +## 特有的flags + +这个命令没有特有的flag，它有一个输入参数：委托人地址 + + +## 示例 + +``` +iriscli distribution withdraw-address +``` +执行结果示例 +``` +faa1ezzh0humhy3329xg4avhcjtay985nll0zswc5j +``` +If the given delegator didn't specify other withdraw address, the query result will be empty. \ No newline at end of file diff --git a/docs/zh/cli-client/distribution/withdraw-rewards.md b/docs/zh/cli-client/distribution/withdraw-rewards.md new file mode 100644 index 000000000..791aef94b --- /dev/null +++ b/docs/zh/cli-client/distribution/withdraw-rewards.md @@ -0,0 +1,41 @@ +# iriscli distribution withdraw-rewards + +## 介绍 + +取回收益 + +## 用法 + +``` +iriscli distribution withdraw-rewards [flags] +``` + +打印帮助信息: + +``` +iriscli distribution withdraw-rewards --help +``` + +## 特有的flags + +| Name, shorthand | type | Required | Default | Description | +| --------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | +| --only-from-validator | string | false | "" | only withdraw from this validator address (in bech) | +| --is-validator | bool | false | false | Also withdraw validator's commission | + +不能同时使用两个flags。 + +## 示例 + +1. 仅取回某一个委托产生的收益 + ``` + iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test + ``` +2. 取回所有委托产生的收益，不包含验证人的佣金收益: + ``` + iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test + ``` +3. 取回所有委托产生的收益以及验证人的佣金收益: + ``` + iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test + ``` \ No newline at end of file From f0ddfe381fb4cdae1043a4a76e9e97c51f88e84a Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sat, 17 Nov 2018 15:21:28 +0800 Subject: [PATCH 078/100] Reactor Chinese docs for stake --- docs/cli-client/stake/README.md | 2 +- docs/cli-client/stake/create-validator.md | 9 +-- docs/cli-client/stake/delegate.md | 22 +----- docs/cli-client/stake/edit-validator.md | 21 +----- docs/cli-client/stake/redelegate.md | 22 +----- docs/cli-client/stake/unbond.md | 24 +----- docs/cli-client/stake/unjail.md | 5 +- docs/zh/README.md | 58 +-------------- docs/zh/cli-client/README.md | 56 +++++++++++++- .../distribution/withdraw-rewards.md | 6 +- docs/zh/cli-client/stake/README.md | 66 ++++++++--------- docs/zh/cli-client/stake/create-validator.md | 74 +++++++------------ docs/zh/cli-client/stake/delegate.md | 62 ++++------------ docs/zh/cli-client/stake/edit-validator.md | 71 ++++-------------- docs/zh/cli-client/stake/redelegate.md | 71 ++++++------------ docs/zh/cli-client/stake/unbond.md | 65 +++++----------- docs/zh/cli-client/stake/unjail.md | 50 ++++--------- 17 files changed, 222 insertions(+), 462 deletions(-) diff --git a/docs/cli-client/stake/README.md b/docs/cli-client/stake/README.md index cd6b52e91..291e8a1e8 100644 --- a/docs/cli-client/stake/README.md +++ b/docs/cli-client/stake/README.md @@ -1,6 +1,6 @@ # iriscli stake -## Description +## Introduction Stake module provides a set of subcommands to query staking state and send staking transactions. diff --git a/docs/cli-client/stake/create-validator.md b/docs/cli-client/stake/create-validator.md index c9d92ff88..22f6b9053 100644 --- a/docs/cli-client/stake/create-validator.md +++ b/docs/cli-client/stake/create-validator.md @@ -1,8 +1,8 @@ # iriscli stake create-validator -## Description +## Introduction -Create new validator initialized with a self-delegation on it +Send transaction to apply to be validator and delegate a certain amount tokens on it ## Usage @@ -19,7 +19,6 @@ iriscli stake create-validator --help | Name, shorthand | type | Required | Default | Description | | ---------------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | -| --address-delegator | string | true | "" | Bech address of the delegator | | --amount | string | true | "" | Amount of coins to bond | | --commission-max-change-rate | float | true | 0.0 | The maximum commission change rate percentage (per day)| | --commission-max-rate | float | true | 0.0 | The maximum commission rate percentage | @@ -34,11 +33,7 @@ iriscli stake create-validator --help ## Examples -### Create new validator - ```shell iriscli stake create-validator --chain-id= --from= --fee=0.004iris --pubkey= --commission-max-change-rate=0.01 --commission-max-rate=0.2 --commission-rate=0.1 --amount=100iris --moniker= ``` -After that, you're done with creating a new validator. - diff --git a/docs/cli-client/stake/delegate.md b/docs/cli-client/stake/delegate.md index b9e315591..c10e56f78 100644 --- a/docs/cli-client/stake/delegate.md +++ b/docs/cli-client/stake/delegate.md @@ -1,8 +1,8 @@ # iriscli stake delegate -## Description +## Introduction -Delegate liquid tokens to an validator +Delegate tokens to a validator ## Usage @@ -24,22 +24,6 @@ iriscli stake delegate --help ## Examples -### Delegate liquid tokens to an validator - ```shell -iriscli stake delegate --chain-id=ChainID --from=KeyName --fee=Fee --amount=CoinstoBond --address-validator=ValidatorOwnerAddress -``` - -After that, you're done with delegating liquid tokens to specified validator. - -```txt -Committed at block 2352 (tx hash: 2069F0453619637EE67EFB0CFC53713AF28A0BB89137DEB4574D8B13E723999B, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:15993 Tags:[{Key:[97 99 116 105 111 110] Value:[100 101 108 101 103 97 116 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 51 108 99 119 110 120 112 121 110 50 101 97 51 115 107 122 109 101 107 54 52 118 118 110 112 57 55 106 115 107 56 113 109 104 108 54 118 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 57 57 54 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "delegate", - "completeConsumedTxFee-iris-atto": "\"7996500000000000\"", - "delegator": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", - "destination-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd" - } - } +iriscli stake delegate --chain-id= --from= --fee=0.004iris --amount=100iris --address-validator= ``` diff --git a/docs/cli-client/stake/edit-validator.md b/docs/cli-client/stake/edit-validator.md index 98debd321..3b7c1812e 100644 --- a/docs/cli-client/stake/edit-validator.md +++ b/docs/cli-client/stake/edit-validator.md @@ -1,8 +1,8 @@ # iriscli stake edit-validator -## Description +## Introduction -Edit existing validator +Edit existing validator, such as commission rate, name and other description message. ## Usage @@ -27,23 +27,6 @@ iriscli stake edit-validator --help ## Examples -### Edit existing validator account - ```shell iriscli stake edit-validator --from= --chain-id= --fee=0.004iris --commission-rate=0.15 ``` - -After that, you're done with editing a new validator. - -```txt -Committed at block 2160 (tx hash: C48CABDA1183B5319003433EB1FDEBE5A626E00BD319F1A84D84B6247E9224D1, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:3540 Tags:[{Key:[97 99 116 105 111 110] Value:[101 100 105 116 45 118 97 108 105 100 97 116 111 114] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[109 111 110 105 107 101 114] Value:[117 98 117 110 116 117 49 56] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[105 100 101 110 116 105 116 121] Value:[] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 55 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "edit-validator", - "completeConsumedTxFee-iris-atto": "\"177000000000000\"", - "destination-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", - "identity": "", - "moniker": "ubuntu18" - } -} -``` diff --git a/docs/cli-client/stake/redelegate.md b/docs/cli-client/stake/redelegate.md index e211cec84..0e4813f2a 100644 --- a/docs/cli-client/stake/redelegate.md +++ b/docs/cli-client/stake/redelegate.md @@ -1,6 +1,6 @@ # iriscli stake redelegate -## Description +## Introduction Redelegate transfer delegation from one validator to another one. @@ -29,24 +29,6 @@ Users must specify the redeleagte amount. There two options can do this: `--shar ## Examples -### Redelegate illiquid tokens from one validator to another - ```shell -iriscli stake redelegate --chain-id=ChainID --from=KeyName --fee=Fee --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --shares-percent=SharesPercent -``` - -After that, you're done with redelegating specified liquid tokens from one validator to another validator. - -```txt -Committed at block 648 (tx hash: E59EE3C8F04D62DA0F5CFD89AC96402A92A56728692AEA47E8A126CDDA58E44B, response: {Code:0 Data:[11 8 185 204 185 223 5 16 247 169 147 42] Log:Msg 0: Info: GasWanted:200000 GasUsed:29085 Tags:[{Key:[97 99 116 105 111 110] Value:[98 101 103 105 110 45 114 101 100 101 108 101 103 97 116 105 111 110] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 48 115 48 97 114 113 57 107 104 112 108 48 99 102 122 110 103 51 113 103 120 99 120 113 48 110 121 54 104 109 99 57 115 121 116 106 102 107] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[115 111 117 114 99 101 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 100 97 121 117 106 100 102 110 120 106 103 103 100 53 121 100 108 118 118 103 107 101 114 112 50 115 117 112 107 110 116 104 97 106 112 99 104 50] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 104 50 55 120 100 119 54 116 57 108 53 106 103 118 117 110 55 54 113 100 117 52 53 107 103 114 120 57 108 113 101 100 101 56 104 112 99 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[101 110 100 45 116 105 109 101] Value:[11 8 185 204 185 223 5 16 247 169 147 42] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 53 56 49 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "begin-redelegation", - "completeConsumedTxFee-iris-atto": "\"5817000000000000\"", - "delegator": "faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk", - "destination-validator": "fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd", - "end-time": "\u000b\u0008\ufffd̹\ufffd\u0005\u0010\ufffd\ufffd\ufffd*", - "source-validator": "fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2" - } -} +iriscli stake redelegate --chain-id= --from= --fee=0.004iris --address-validator-source= --address-validator-dest= --shares-percent=0.1 ``` diff --git a/docs/cli-client/stake/unbond.md b/docs/cli-client/stake/unbond.md index bc8ecdbc8..eac8b028e 100644 --- a/docs/cli-client/stake/unbond.md +++ b/docs/cli-client/stake/unbond.md @@ -1,6 +1,6 @@ # iriscli stake unbond -## Description +## Introduction Unbond shares from a validator @@ -20,7 +20,7 @@ iriscli stake unbond --help | Name, shorthand | type | Required | Default | Description | | --------------------| ----- | -------- | -------- | ------------------------------------------------------------------- | -| --address-delegator | string | true | "" | Bech address of the delegator | +| --address-validator | string | true | "" | Bech address of the validator | | --shares-amount | float | false | 0.0 | Amount of source-shares to either unbond or redelegate as a positive integer or decimal | | --shares-percent | float | false | 0.0 | Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 | @@ -28,24 +28,6 @@ Users must specify the unbond amount. There two options can do this: `--shares-a ## Examples -### Unbond shares from a validator - ```shell -iriscli stake unbond --address-validator=ValidatorAddress --shares-percent=SharePercent --from=UnbondInitiator --chain-id=ChainID --fee=Fee -``` - -After that, you're done with unbonding shares from specified validator. - -```txt -Committed at block 851 (tx hash: A82833DE51A4127BD5D60E7F9E4CD5895F97B1B54241BCE272B68698518D9D2B, response: {Code:0 Data:[11 8 230 225 179 223 5 16 249 233 245 21] Log:Msg 0: Info: GasWanted:200000 GasUsed:16547 Tags:[{Key:[97 99 116 105 111 110] Value:[98 101 103 105 110 45 117 110 98 111 110 100 105 110 103] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 51 108 99 119 110 120 112 121 110 50 101 97 51 115 107 122 109 101 107 54 52 118 118 110 112 57 55 106 115 107 56 113 109 104 108 54 118 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[115 111 117 114 99 101 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[101 110 100 45 116 105 109 101] Value:[11 8 230 225 179 223 5 16 249 233 245 21] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 56 50 55 51 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "begin-unbonding", - "completeConsumedTxFee-iris-atto": "\"8273500000000000\"", - "delegator": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", - "end-time": "\u000b\u0008\ufffd\ufffd\ufffd\ufffd\u0005\u0010\ufffd\ufffd\ufffd\u0015", - "source-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd" - } - } - +iriscli stake unbond --address-validator= --shares-percent=0.1 --from= --chain-id= --fee=0.004iris ``` diff --git a/docs/cli-client/stake/unjail.md b/docs/cli-client/stake/unjail.md index 74a582207..2dd3d4368 100644 --- a/docs/cli-client/stake/unjail.md +++ b/docs/cli-client/stake/unjail.md @@ -1,6 +1,6 @@ # iriscli stake unjail -## Description +## Introduction Unjail validator previously jailed for downtime @@ -27,6 +27,3 @@ There is no unique flags. ```shell iriscli stake unjail --from= --fee=0.004iris --chain-id= ``` - -After that, you're done with unjailing specified validator. - diff --git a/docs/zh/README.md b/docs/zh/README.md index c4586a191..0d04c7b6c 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -1,55 +1,5 @@ -# 命令行客户端 +# IRISnet文档目录 +![irisnet](../pics/iris.jpg) -## 查询命令的flags - -| Name, shorthand | type | Required | Default Value | Description | -| --------------- | ---- | -------- | --------------------- | -------------------------------------------------------------------- | -| --chain-id | string | false | "" | Tendermint节点的Chain ID | -| --height | int | false | 0 | 查询某个高度的区块链数据，如果是0，这返回最新的区块链数据 | -| --help, -h | string | false | | 打印帮助信息 | -| --indent | bool | false | false | 格式化json字符串| -| --ledger | bool | false | false | 是否使用硬件钱包 | -| --node | string | false | tcp://localhost:26657 | tendermint节点的rpc地址| -| --trust-node | bool | false | true | 是否信任全节点返回的数据，如果不信任，客户端会验证查询结果的正确性 | - -每个区块链状态查询命令都包含上表中的flags，同时不同查询命令还可能会有自己独有的flags。 - -## 发送交易命令的flags - -| Name, shorthand | type | Required | Default | Description | -| -----------------| ----- | -------- | --------------------- | ------------------------------------------------------------------- | -| --account-number | int | false | 0 | 发起交易的账户的编号 | -| --async | bool | false | false | 是否异步广播交易 | -| --chain-id | string | true | "" | Tendermint节点的`Chain ID` | -| --dry-run | bool | false | false | 模拟执行交易，并返回消耗的`gas`。`--gas`指定的值会被忽略 | -| --fee | string | true | "" | 交易费 | -| --from | string | false | "" | 发送交易的账户名称 | -| --from-addr | string | false | "" | 签名地址，在`generate-only`为`true`的情况下有效 | -| --gas | int | false | 200000 | 交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | -| --gas-adjustment | int | false | 1 | gas调整因子，这个值降乘以模拟执行消耗的`gas`，计算的结果返回给用户; 如果`--gas`的值不是`simulate`，这个标志将被忽略 | -| --generate-only | bool | false | false | 是否仅仅构建一个未签名的交易便返回 | -| --help, -h | string | false | | 打印帮助信息 | -| --indent | bool | false | false | 格式化json字符串 | -| --json | string | false | false | 指定返回结果的格式，`json`或者`text` | -| --ledger | bool | false | false | 是否使用硬件钱包| -| --memo | string | false | "" | 指定交易的memo字段 | -| --node | string | false | tcp://localhost:26657 | tendermint节点的rpc地址 | -| --print-response | bool | false | false | 是否打印交易返回结果，仅在`async`为true的情况下有效| -| --sequence int | int | false | 0 | 发起交易的账户的sequence | -| --trust-node | bool | false | true | 是否信任全节点返回的数据，如果不信任，客户端会验证查询结果的正确性 | - -每个发送交易的命令都包含上表中的flags，同时不同交易的命令还可能会有自己独有的flags。 - -## Command list - -1. [bank command](./bank/README.md) -2. [distribution command](./distribution/README.md) -3. [gov command](./gov/README.md) -4. [keys command](./keys/README.md) -5. [lcd command](./lcd/README.md) -6. [record command](./record/README.md) -7. [service command](./service/README.md) -8. [stake command](./stake/README.md) -9. [status command](./status/README.md) -10. [tendermint command](./tendermint/README.md) -11. [upgrade command](./upgrade/README.md) +IRIS网络是上海边界智能和Tendermint团队合作打造的跨链区块链网络，将是Cosmos网络生态中的第一个区域性枢纽(Hub)，并专注于为分布式商业应用提供基础 设施和协议。 +IRISnet将面向服务的基础设施融入到Cosmos网络中，支持对包括公链、联盟链以及 现有传统商业系统的集成从而实现互联互通。通过对Cosmos网络的跨链协议进行创新 扩展，IRISnet允许数据及复杂计算跨异构网络被调用。就像忠实地在人间和天堂传递 信息的希腊彩虹女神 Iris, IRISnet的目标是成为链接数字经济和实体经济，支持构建复 杂分布式商业应用的下一代公链。 diff --git a/docs/zh/cli-client/README.md b/docs/zh/cli-client/README.md index c1901202e..c4586a191 100644 --- a/docs/zh/cli-client/README.md +++ b/docs/zh/cli-client/README.md @@ -1 +1,55 @@ -# CLi Client +# 命令行客户端 + +## 查询命令的flags + +| Name, shorthand | type | Required | Default Value | Description | +| --------------- | ---- | -------- | --------------------- | -------------------------------------------------------------------- | +| --chain-id | string | false | "" | Tendermint节点的Chain ID | +| --height | int | false | 0 | 查询某个高度的区块链数据，如果是0，这返回最新的区块链数据 | +| --help, -h | string | false | | 打印帮助信息 | +| --indent | bool | false | false | 格式化json字符串| +| --ledger | bool | false | false | 是否使用硬件钱包 | +| --node | string | false | tcp://localhost:26657 | tendermint节点的rpc地址| +| --trust-node | bool | false | true | 是否信任全节点返回的数据，如果不信任，客户端会验证查询结果的正确性 | + +每个区块链状态查询命令都包含上表中的flags，同时不同查询命令还可能会有自己独有的flags。 + +## 发送交易命令的flags + +| Name, shorthand | type | Required | Default | Description | +| -----------------| ----- | -------- | --------------------- | ------------------------------------------------------------------- | +| --account-number | int | false | 0 | 发起交易的账户的编号 | +| --async | bool | false | false | 是否异步广播交易 | +| --chain-id | string | true | "" | Tendermint节点的`Chain ID` | +| --dry-run | bool | false | false | 模拟执行交易，并返回消耗的`gas`。`--gas`指定的值会被忽略 | +| --fee | string | true | "" | 交易费 | +| --from | string | false | "" | 发送交易的账户名称 | +| --from-addr | string | false | "" | 签名地址，在`generate-only`为`true`的情况下有效 | +| --gas | int | false | 200000 | 交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | +| --gas-adjustment | int | false | 1 | gas调整因子，这个值降乘以模拟执行消耗的`gas`，计算的结果返回给用户; 如果`--gas`的值不是`simulate`，这个标志将被忽略 | +| --generate-only | bool | false | false | 是否仅仅构建一个未签名的交易便返回 | +| --help, -h | string | false | | 打印帮助信息 | +| --indent | bool | false | false | 格式化json字符串 | +| --json | string | false | false | 指定返回结果的格式，`json`或者`text` | +| --ledger | bool | false | false | 是否使用硬件钱包| +| --memo | string | false | "" | 指定交易的memo字段 | +| --node | string | false | tcp://localhost:26657 | tendermint节点的rpc地址 | +| --print-response | bool | false | false | 是否打印交易返回结果，仅在`async`为true的情况下有效| +| --sequence int | int | false | 0 | 发起交易的账户的sequence | +| --trust-node | bool | false | true | 是否信任全节点返回的数据，如果不信任，客户端会验证查询结果的正确性 | + +每个发送交易的命令都包含上表中的flags，同时不同交易的命令还可能会有自己独有的flags。 + +## Command list + +1. [bank command](./bank/README.md) +2. [distribution command](./distribution/README.md) +3. [gov command](./gov/README.md) +4. [keys command](./keys/README.md) +5. [lcd command](./lcd/README.md) +6. [record command](./record/README.md) +7. [service command](./service/README.md) +8. [stake command](./stake/README.md) +9. [status command](./status/README.md) +10. [tendermint command](./tendermint/README.md) +11. [upgrade command](./upgrade/README.md) diff --git a/docs/zh/cli-client/distribution/withdraw-rewards.md b/docs/zh/cli-client/distribution/withdraw-rewards.md index 791aef94b..769c29233 100644 --- a/docs/zh/cli-client/distribution/withdraw-rewards.md +++ b/docs/zh/cli-client/distribution/withdraw-rewards.md @@ -18,10 +18,10 @@ iriscli distribution withdraw-rewards --help ## 特有的flags -| Name, shorthand | type | Required | Default | Description | +| 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | | --------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | -| --only-from-validator | string | false | "" | only withdraw from this validator address (in bech) | -| --is-validator | bool | false | false | Also withdraw validator's commission | +| --only-from-validator | string | false | "" | 验证人地址，仅取回在这个验证人上的委托收益 | +| --is-validator | bool | false | false | 取回验证人佣金收益 | 不能同时使用两个flags。 diff --git a/docs/zh/cli-client/stake/README.md b/docs/zh/cli-client/stake/README.md index ea0ce126d..5cd9e0b55 100644 --- a/docs/zh/cli-client/stake/README.md +++ b/docs/zh/cli-client/stake/README.md @@ -1,41 +1,41 @@ # iriscli stake -## 描述 +## 介绍 -权益模块允许你执行权益和验证子命令 +Stake模块提供了一系列查询staking状态和发送staking交易的命令 ## 用法 -```shell -iriscli stake [command] ``` +iriscli stake [subcommand] +``` + +打印所以子命令和flags： +``` +iriscli stake --help +``` + +## 子命令 + +| 子命令 | 功能 | +| ------------------------------------------------------------- | --------------------------------------------------------------| +| [validator](validator.md) | 查询某个验证者 | +| [validators](validators.md) | 查询所有的验证者 | +| [delegation](delegation.md) | 基于委托者地址和验证者地址的委托查询 | +| [delegations](delegations.md) | 基于委托者地址的所有委托查询 | +| [unbonding-delegation](unbonding-delegation.md) | 基于委托者地址和验证者地址的unbonding-delegation记录查询 | +| [unbonding-delegations](unbonding-delegations.md) | 基于委托者地址的所有unbonding-delegation记录查询 | +| [unbonding-delegations-from](unbonding-delegations-from.md) | 基于验证者地址的所有unbonding-delegation记录查询| +| [redelegations-from](redelegations-from.md) | 基于某一验证者的所有重新委托查询 | +| [redelegation](redelegation.md) | 基于委托者地址，原源验证者地址和目标验证者地址的重新委托记录查询 | +| [redelegations](redelegations.md) | 基于委托者地址的所有重新委托记录查询 | +| [pool](pool.md) | 查询最新的权益池 | +| [parameters](parameters.md) | 查询最新的权益参数信息 | +| [signing-info](signing-info.md) | 查询验证者签名信息 | +| [create-validator](create-validator.md) | 以自委托的方式创建一个新的验证者 | +| [edit-validator](edit-validator.md) | 编辑已存在的验证者信息 | +| [delegate](delegate.md) | 委托一定代币到某个验证者 | +| [unbond](unbond.md) | 从指定的验证者解绑一定的股份 | +| [redelegate](redelegate.md) | 重新委托一定的token从一个验证者到另一个验证者 | +| [unjail](unjail.md) | 恢复之前由于宕机被惩罚的验证者的身份 | -## 相关命令 - -| 命令 | 描述 | -| --------------------------------| --------------------------------------------------------------| -| [validator](validator.md) | 查询某个验证者 | -| [validators](validators.md) | 查询所有的验证者 | -| [delegation](delegation.md) | 基于委托者地址和验证者地址的委托查询 | -| [delegations](delegations.md) | 基于委托者地址的所有委托查询 | -| [unbonding-delegation](unbonding-delegation.md) | 基于委托者地址和验证者地址的unbonding-delegation记录查询 | -| [unbonding-delegations](unbonding-delegations.md) | 基于委托者地址的所有unbonding-delegation记录查询 | -| [unbonding-delegations-from](unbonding-delegations-from.md) | 基于验证者地址的所有unbonding-delegation记录查询 | -| [redelegations-from](redelegations-from.md) | 基于某一验证者的所有重新委托查询 | -| [redelegation](redelegation.md) | 基于委托者地址，原源验证者地址和目标验证者地址的重新委托记录查询 | -| [redelegations](redelegations.md) | 基于委托者地址的所有重新委托记录查询 | -| [pool](pool.md) | 查询最新的权益池 | -| [parameters](parameters.md) | 查询最新的权益参数信息 | -| [signing-info](signing-info.md) | 查询验证者签名信息 | -| [create-validator](create-validator.md) | 以自委托的方式创建一个新的验证者 | -| [edit-validator](edit-validator.md) | 编辑已存在的验证者信息 | -| [delegate](delegate.md) | 委托一定代币到某个验证者 | -| [unbond](unbond.md) | 从指定的验证者解绑一定的股份 | -| [redelegate](redelegate.md) | 重新委托一定的token从一个验证者到另一个验证者 | -| [unjail](unjail.md) | 恢复之前由于宕机被惩罚的验证者的身份 | - -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| --------------- | ------- | --------------- | -------- | -| --help, -h | | stake命令帮助 | | diff --git a/docs/zh/cli-client/stake/create-validator.md b/docs/zh/cli-client/stake/create-validator.md index ffbe89e51..d9d7f3212 100644 --- a/docs/zh/cli-client/stake/create-validator.md +++ b/docs/zh/cli-client/stake/create-validator.md @@ -1,8 +1,8 @@ # iriscli stake create-validator -## 描述 +## 介绍 -以自委托的方式创建一个新的验证者 +发送交易申请成为验证人，并在在此验证人上委托一定数额的token ## 用法 @@ -10,49 +10,31 @@ iriscli stake create-validator [flags] ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的accountNumber | | -| --address-delegator | | [string] 委托者bech地址 | | -| --amount | | [string] 绑定的代币数量 | Yes | -| --async | | 是否异步广播交易 | | -| --chain-id | | [string] Tendermint节点的链ID | Yes | -| --commission-max-change-rate | | [string] 最大佣金变化率(每天) | Yes | -| --commission-max-rate | | [string] 最大佣金率 | Yes | -| --commission-rate | | [string] 初始佣金率 | Yes | -| --details | | [string] 可选details | | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --genesis-format | | 以gen-tx的格式导出交易; 其暗含 --generate-only | | -| --help, -h | | create-validator命令帮助 | | -| --identity | | [string] 可选身份签名 (ex. UPort or Keybase) | | -| --indent | | 在JSON响应中添加缩进 | | -| --ip | | [string] N节点的公有IP，仅开启--genesis-format时生效 | | -| --json | | 以json形式输出 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易时的备忘录 | | -| --moniker | | [string] 验证者名字 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --node-id | | [string] 节点ID | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | -| --pubkey | | [string] 验证者的Go-Amino编码的16进制公钥. 对于Ed25519，go-amino的16进制前缀为1624de6220 | Yes | -| --sequence | | [int] 用来签名交易的sequence | | -| --trust-node | true | 关闭响应结果校验 | | -| --website | | [string] 选填的网站 | | - -## 例子 - -### 创建新的验证者 - -```shell -iriscli stake create-validator --chain-id=ChainID --from=KeyName --fee=Fee --pubkey=ValidatorPublicKey --commission-max-change-rate=CommissionMaxChangeRate --commission-max-rate=CommissionMaxRate --commission-rate=CommissionRate --amount=Coins +打印帮助信息 ``` +iriscli stake create-validator --help +``` + +## 特有的flags + +| 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | +| ---------------------------- | ----- | -------- | -------- | ------------------------------------ | +| --amount | string | true | "" | 委托token的数量 | +| --commission-max-change-rate | float | true | 0.0 | 佣金比率每天变化的最大数量 | +| --commission-max-rate | float | true | 0.0 | 最大佣金比例 | +| --commission-rate | float | true | 0.0 | 初始佣金比例 | +| --details | string | false | "" | 验证人节点的详细信息 | +| --genesis-format | bool | false | false | 是否已genesis transaction的方式倒出 | +| --identity | string | false | "" | 身份信息的签名 | +| --ip | string | false | "" | 验证人节点的IP | +| --moniker | string | true | "" | 验证人节点名称 | +| --pubkey | string | true | "" | Amino编码的验证人公钥 | +| --website | string | false | "" | 验证人节点的网址 | + +## 示例 + +``` +iriscli stake create-validator --chain-id= --from= --fee=0.004iris --pubkey= --commission-max-change-rate=0.01 --commission-max-rate=0.2 --commission-rate=0.1 --amount=100iris --moniker= +``` + -运行上述命令之后，你便成功地创建了一个验证者。 diff --git a/docs/zh/cli-client/stake/delegate.md b/docs/zh/cli-client/stake/delegate.md index bf50ec29d..fe0935904 100644 --- a/docs/zh/cli-client/stake/delegate.md +++ b/docs/zh/cli-client/stake/delegate.md @@ -1,8 +1,8 @@ # iriscli stake delegate -## 描述 +## 介绍 -委托一定代币到某个验证者 +发送委托交易 ## 用法 @@ -10,50 +10,20 @@ iriscli stake delegate [flags] ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的accountNumber | | -| --address-validator | | [string] 验证者bech地址 | Yes | -| --amount | | [string] 绑定的代币数量 | Yes | -| --async | | 是否异步广播交易 | | -| --chain-id | | [string] Tendermint节点的链ID | Yes | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --help, -h | | delegate命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 以json形式输出 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易时的备忘录 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | -| --sequence int | | [int] 用来签名交易的sequence | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 委托一定代币到某个验证者 - -```shell -iriscli stake delegate --chain-id=ChainID --from=KeyName --fee=Fee --amount=CoinstoBond --address-validator=ValidatorOwnerAddress +打印帮助信息 +``` +iriscli stake delegate --help ``` -运行成功以后，返回的结果如下： - -```txt -Committed at block 2352 (tx hash: 2069F0453619637EE67EFB0CFC53713AF28A0BB89137DEB4574D8B13E723999B, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:15993 Tags:[{Key:[97 99 116 105 111 110] Value:[100 101 108 101 103 97 116 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 51 108 99 119 110 120 112 121 110 50 101 97 51 115 107 122 109 101 107 54 52 118 118 110 112 57 55 106 115 107 56 113 109 104 108 54 118 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 55 57 57 54 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "delegate", - "completeConsumedTxFee-iris-atto": "\"7996500000000000\"", - "delegator": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", - "destination-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd" - } - } +## 特有的flags + +| 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | +| --------------------| ----- | -------- | -------- | ---------------- | +| --address-delegator | string | true | "" | 验证人地址 | +| --amount | string | true | "" | 委托的token数量 | + +## 示例 + +``` +iriscli stake delegate --chain-id=ChainID --from=KeyName --fee=Fee --amount=CoinstoBond --address-validator=ValidatorOwnerAddress ``` diff --git a/docs/zh/cli-client/stake/edit-validator.md b/docs/zh/cli-client/stake/edit-validator.md index 2c97c6fc6..76c171623 100644 --- a/docs/zh/cli-client/stake/edit-validator.md +++ b/docs/zh/cli-client/stake/edit-validator.md @@ -1,71 +1,32 @@ # iriscli stake edit-validator -## 描述 +## 介绍 -编辑已存在的验证者信息 +修改验证的的参数，包括佣金比率，验证人节点名称以及其他描述信息 ## 用法 ``` iriscli stake edit-validator [flags] ``` +打印帮助信息 +```shell +iriscli stake edit-validator --help +``` -## 标志 +## 特有flags -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的accountNumber | | -| --address-delegator | | [string] 委托者bech地址 | | -| --amount | | [string] 绑定的代币数量 | | -| --async | | 是否异步广播交易 | | -| --chain-id | | [string] Tendermint节点的链ID | Yes | -| --commission-max-change-rate | | [string] 最大佣金变化率(每天) | | -| --commission-max-rate | | [string] 最大佣金率 | | -| --commission-rate | | [string] [string] 初始佣金率 | | -| --details | | [string] 可选details | | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --genesis-format | | 以gen-tx的格式导出交易; 其暗含 --generate-only | | -| --help, -h | | edit-validator命令帮助 | | -| --identity | | [string] 可选身份签名 (ex. UPort or Keybase) | | -| --indent | | 在JSON响应中添加缩进 | | -| --ip | | [string] N节点的公有IP，仅开启--genesis-format时生效 | | -| --json | | 以json形式输出 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易时的备忘录 | | -| --moniker | | [string] 验证者名字 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --node-id | | [string] 节点ID | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | -| --pubkey | | [string] 验证者的Go-Amino编码的16进制公钥. 对于Ed25519，go-amino的16进制前缀为1624de6220 | | -| --sequence | | [int] 用来签名交易的sequence | | -| --trust-node | true | 关闭响应结果校验 | | -| --website | | [string] 选填网站 | | +| 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | +| --------------------| ----- | -------- | -------- | ------------------------------------------------------------------- | +| --commission-rate | string | float | 0.0 | 佣金比率 | +| --moniker | string | false | "" | 验证人名称 | +| --identity | string | false | "" | 身份签名 | +| --website | string | false | "" | 网址 | +| --details | string | false | "" | 验证人节点详细信息 | -## 例子 -### 编辑已存在的验证者信息 +## 示例 ```shell -iriscli stake edit-validator --from=KeyName --chain-id=ChainID --fee=Fee --memo=YourMemo -``` - -运行成功以后，返回的结果如下： - -```txt -Committed at block 2160 (tx hash: C48CABDA1183B5319003433EB1FDEBE5A626E00BD319F1A84D84B6247E9224D1, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:3540 Tags:[{Key:[97 99 116 105 111 110] Value:[101 100 105 116 45 118 97 108 105 100 97 116 111 114] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[109 111 110 105 107 101 114] Value:[117 98 117 110 116 117 49 56] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[105 100 101 110 116 105 116 121] Value:[] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 55 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "edit-validator", - "completeConsumedTxFee-iris-atto": "\"177000000000000\"", - "destination-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd", - "identity": "", - "moniker": "ubuntu18" - } -} +iriscli stake edit-validator --from= --chain-id= --fee=0.004iris --commission-rate=0.15 ``` diff --git a/docs/zh/cli-client/stake/redelegate.md b/docs/zh/cli-client/stake/redelegate.md index db9329b86..b1e236181 100644 --- a/docs/zh/cli-client/stake/redelegate.md +++ b/docs/zh/cli-client/stake/redelegate.md @@ -1,8 +1,8 @@ # iriscli stake redelegate -## 描述 +## 介绍 -重新委托一定的token从一个验证者到另一个验证者 +把某个委托的一部分或者全部从一个验证人转移到另外一个验证人 ## 用法 @@ -10,54 +10,25 @@ iriscli stake redelegate [flags] ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的accountNumber | | -| --address-validator-dest | | [string] 目标验证者bech地址 | Yes | -| --address-validator-source | | [string] 源验证者bech地址 | Yes | -| --async | | 是否异步广播交易 | | -| --chain-id | | [string] Tendermint节点的链ID | Yes | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 || -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --help, -h | | redelegate命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 以json形式输出 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易时的备忘录 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | -| --sequence | | [int] 用来签名交易的sequence | | -| --shares-amount | | [string] 指定重新委托给其他验证者的股份 | | -| --shares-percent | | [string] 指定重新委托给其他验证者的股份比例，位于0到1之间的正数 | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 重新委托一定的token从一个验证者到另一个验证者 - -```shell -iriscli stake redelegate --chain-id=ChainID --from=KeyName --fee=Fee --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --shares-percent=SharesPercent +打印帮助信息 ``` +iriscli stake redelegate --help +``` + +## 特有flags + +| 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | +| -------------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | +| --address-validator-dest | string | true | "" | 目标验证人地址 | +| --address-validator-source | string | true | "" | 源验证人地址 | +| --shares-amount | float | false | 0.0 | 转移的share数量，正数 | +| --shares-percent | float | false | 0.0 | 转移的比率，0到1之间的正数 | + +用户可以用`--shares-amount`或者`--shares-percent`指定装委托的token数量。记住，这两个参数不可同时使用。 -运行成功以后，返回的结果如下： - -```txt -Committed at block 648 (tx hash: E59EE3C8F04D62DA0F5CFD89AC96402A92A56728692AEA47E8A126CDDA58E44B, response: {Code:0 Data:[11 8 185 204 185 223 5 16 247 169 147 42] Log:Msg 0: Info: GasWanted:200000 GasUsed:29085 Tags:[{Key:[97 99 116 105 111 110] Value:[98 101 103 105 110 45 114 101 100 101 108 101 103 97 116 105 111 110] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 48 115 48 97 114 113 57 107 104 112 108 48 99 102 122 110 103 51 113 103 120 99 120 113 48 110 121 54 104 109 99 57 115 121 116 106 102 107] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[115 111 117 114 99 101 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 100 97 121 117 106 100 102 110 120 106 103 103 100 53 121 100 108 118 118 103 107 101 114 112 50 115 117 112 107 110 116 104 97 106 112 99 104 50] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 115 116 105 110 97 116 105 111 110 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 104 50 55 120 100 119 54 116 57 108 53 106 103 118 117 110 55 54 113 100 117 52 53 107 103 114 120 57 108 113 101 100 101 56 104 112 99 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[101 110 100 45 116 105 109 101] Value:[11 8 185 204 185 223 5 16 247 169 147 42] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 53 56 49 55 48 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "begin-redelegation", - "completeConsumedTxFee-iris-atto": "\"5817000000000000\"", - "delegator": "faa10s0arq9khpl0cfzng3qgxcxq0ny6hmc9sytjfk", - "destination-validator": "fva1h27xdw6t9l5jgvun76qdu45kgrx9lqede8hpcd", - "end-time": "\u000b\u0008\ufffd̹\ufffd\u0005\u0010\ufffd\ufffd\ufffd*", - "source-validator": "fva1dayujdfnxjggd5ydlvvgkerp2supknthajpch2" - } -} +## 示例 + +``` +iriscli stake redelegate --chain-id= --from= --fee=0.004iris --address-validator-source= --address-validator-dest= --shares-percent=0.1 ``` + diff --git a/docs/zh/cli-client/stake/unbond.md b/docs/zh/cli-client/stake/unbond.md index 0bd1dcc2d..043693757 100644 --- a/docs/zh/cli-client/stake/unbond.md +++ b/docs/zh/cli-client/stake/unbond.md @@ -1,8 +1,8 @@ # iriscli stake unbond -## 描述 +## 介绍 -从指定的验证者解绑一定的股份 +Unbond shares from a validator ## 用法 @@ -10,53 +10,24 @@ iriscli stake unbond [flags] ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| --------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的accountNumber | | -| --address-validator | | [string] 验证者bech地址 | Yes | -| --async | | 是否异步广播交易 | | -| --chain-id | | [string] Tendermint节点的链ID | Yes | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --help, -h | | unbond命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 以json形式输出 | | -| --ledger | | 使用连接的硬件记账设 | | -| --memo | | [string] 发送交易时的备忘录 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | -| --sequence | | [int] 用来签名交易的sequence | | -| --shares-amount | | [string] 指定解绑的股份数 | | -| --shares-percent | | [string] 指定解绑的股份比例，为0到1之间的正数 | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 从指定的验证者解绑一定的股份 - -```shell -iriscli stake unbond --address-validator=ValidatorAddress --shares-percent=SharePercent --from=UnbondInitiator --chain-id=ChainID --fee=Fee +打印帮助信息 + +``` +iriscli stake unbond --help ``` -运行成功以后，返回的结果如下： +## 特有flags + +| 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | +| --------------------| ----- | -------- | -------- | ------------------------------------------------------------------- | +| --address-validator | string | true | "" | 验证人地址 | +| --shares-amount | float | false | 0.0 | 解绑的share数量，正数 | +| --shares-percent | float | false | 0.0 | 解绑的比率，0到1之间的正数 | -```txt -Committed at block 851 (tx hash: A82833DE51A4127BD5D60E7F9E4CD5895F97B1B54241BCE272B68698518D9D2B, response: {Code:0 Data:[11 8 230 225 179 223 5 16 249 233 245 21] Log:Msg 0: Info: GasWanted:200000 GasUsed:16547 Tags:[{Key:[97 99 116 105 111 110] Value:[98 101 103 105 110 45 117 110 98 111 110 100 105 110 103] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[100 101 108 101 103 97 116 111 114] Value:[102 97 97 49 51 108 99 119 110 120 112 121 110 50 101 97 51 115 107 122 109 101 107 54 52 118 118 110 112 57 55 106 115 107 56 113 109 104 108 54 118 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[115 111 117 114 99 101 45 118 97 108 105 100 97 116 111 114] Value:[102 118 97 49 53 103 114 118 51 120 103 51 101 107 120 104 57 120 114 102 55 57 122 100 48 119 48 55 55 107 114 103 118 53 120 102 54 100 54 116 104 100] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[101 110 100 45 116 105 109 101] Value:[11 8 230 225 179 223 5 16 249 233 245 21] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 56 50 55 51 53 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] Codespace: XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) -{ - "tags": { - "action": "begin-unbonding", - "completeConsumedTxFee-iris-atto": "\"8273500000000000\"", - "delegator": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx", - "end-time": "\u000b\u0008\ufffd\ufffd\ufffd\ufffd\u0005\u0010\ufffd\ufffd\ufffd\u0015", - "source-validator": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd" - } - } +用户可以用`--shares-amount`或者`--shares-percent`指定解绑定的token数量，这两个参数不可同时使用。 +## 示例 + +``` +iriscli stake unbond --address-validator= --shares-percent=0.1 --from= --chain-id= --fee=0.004iris ``` diff --git a/docs/zh/cli-client/stake/unjail.md b/docs/zh/cli-client/stake/unjail.md index 24eec0434..c9cd36a8d 100644 --- a/docs/zh/cli-client/stake/unjail.md +++ b/docs/zh/cli-client/stake/unjail.md @@ -1,49 +1,27 @@ # iriscli stake unjail -## 描述 +## 介绍 -恢复之前由于宕机被惩罚的验证者的身份 +Unjail validator previously jailed for downtime ## 用法 ``` -iriscli stake redelegate [flags] +iriscli stake unjail [flags] ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ---------------------------- | --------------------- | ------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的accountNumber | | -| --address-validator-dest | | [string] 目标验证者bech地址 | | -| --address-validator-source | | [string] 源验证者bech地址 | | -| --async | | 是否异步广播交易 | | -| --chain-id | | [string] Tendermint节点的链ID | Yes | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 || -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --help, -h | | unjail命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 以json形式输出 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易时的备忘录 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用) | | -| --sequence int | | [int] 用来签名交易的sequence | | -| --shares-amount | | [string] 指定恢复验证者身份是的股份 | | -| --shares-percent | | [string] 指定恢复验证者身份是的股份比，为0到1之间的正数 | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 恢复之前由于宕机被惩罚的验证者的身份 +打印帮助信息 ```shell -iriscli stake unjail --from=KeyName --fee=Fee --chain-id=ChainID +iriscli stake unjail --help ``` -执行完成以后，你成功地恢复了指定的验证者的身份。 +## 特有flags + +没有特有的flags + +## 示例 + +```shell +iriscli stake unjail --from= --fee=0.004iris --chain-id= +``` From 6b5391107ece9838bc0a792a96b89f7a7860090f Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sat, 17 Nov 2018 15:28:06 +0800 Subject: [PATCH 079/100] Improve docs for distribution cli-client --- docs/cli-client/distribution/README.md | 10 +++++----- docs/cli-client/distribution/delegation-distr-info.md | 5 ++--- docs/cli-client/distribution/delegator-distr-info.md | 3 +-- docs/cli-client/distribution/set-withdraw-address.md | 3 +-- docs/cli-client/distribution/validator-distr-info.md | 3 +-- docs/cli-client/distribution/withdraw-address.md | 2 +- docs/cli-client/distribution/withdraw-rewards.md | 2 +- docs/cli-client/stake/README.md | 2 +- 8 files changed, 13 insertions(+), 17 deletions(-) diff --git a/docs/cli-client/distribution/README.md b/docs/cli-client/distribution/README.md index e7dca38c8..3d5b25648 100644 --- a/docs/cli-client/distribution/README.md +++ b/docs/cli-client/distribution/README.md @@ -1,22 +1,22 @@ # iriscli distribution -## Description +## introduction -This document description how to use the the command line interface of distribution module. +This document describe how to use the the command line interfaces of distribution module. ## Usage ```shell -iriscli distribution [subcommand] +iriscli distribution [subcommand] [flags] ``` -Print all supported subcommands and options: +Print all supported subcommands and flags: ```shell iriscli distribution --help ``` -## Available Commands +## Available Subommands | Name | Description | | --------------------------------| --------------------------------------------------------------| diff --git a/docs/cli-client/distribution/delegation-distr-info.md b/docs/cli-client/distribution/delegation-distr-info.md index a070ac4fa..9f543be7b 100644 --- a/docs/cli-client/distribution/delegation-distr-info.md +++ b/docs/cli-client/distribution/delegation-distr-info.md @@ -1,6 +1,6 @@ # iriscli distribution delegation-distr-info -## Description +## introduction Query delegation distribution information @@ -10,8 +10,7 @@ Query delegation distribution information iriscli distribution delegation-distr-info [flags] ``` -Print all supported options: - +Print help messages: ```shell iriscli distribution delegation-distr-info --help ``` diff --git a/docs/cli-client/distribution/delegator-distr-info.md b/docs/cli-client/distribution/delegator-distr-info.md index 1fa122735..f2c0077ce 100644 --- a/docs/cli-client/distribution/delegator-distr-info.md +++ b/docs/cli-client/distribution/delegator-distr-info.md @@ -10,8 +10,7 @@ Query delegator distribution information iriscli distribution delegator-distr-info [flags] ``` -Print all supported options: - +Print help messages: ```shell iriscli distribution delegator-distr-info --help ``` diff --git a/docs/cli-client/distribution/set-withdraw-address.md b/docs/cli-client/distribution/set-withdraw-address.md index bc9b5ed4c..95926ead8 100644 --- a/docs/cli-client/distribution/set-withdraw-address.md +++ b/docs/cli-client/distribution/set-withdraw-address.md @@ -10,8 +10,7 @@ Set withdraw address of a delegator iriscli distribution set-withdraw-addr [withdraw-addr] [flags] ``` -Print all supported options: - +Print help messages: ```shell iriscli distribution set-withdraw-addr --help ``` diff --git a/docs/cli-client/distribution/validator-distr-info.md b/docs/cli-client/distribution/validator-distr-info.md index 486c4142a..d006e61ce 100644 --- a/docs/cli-client/distribution/validator-distr-info.md +++ b/docs/cli-client/distribution/validator-distr-info.md @@ -10,8 +10,7 @@ Query validator distribution information iriscli distribution validator-distr-info [flags] ``` -Print all supported options: - +Print help messages: ```shell iriscli distribution validator-distr-info --help ``` diff --git a/docs/cli-client/distribution/withdraw-address.md b/docs/cli-client/distribution/withdraw-address.md index be1c4fcb6..c47549c26 100644 --- a/docs/cli-client/distribution/withdraw-address.md +++ b/docs/cli-client/distribution/withdraw-address.md @@ -10,7 +10,7 @@ Query withdraw address of a delegator iriscli distribution withdraw-address [delegator address] [flags] ``` -Print all supported options: +Print help messages: ```shell iriscli distribution withdraw-address --help diff --git a/docs/cli-client/distribution/withdraw-rewards.md b/docs/cli-client/distribution/withdraw-rewards.md index c6e44f78f..98a18d59d 100644 --- a/docs/cli-client/distribution/withdraw-rewards.md +++ b/docs/cli-client/distribution/withdraw-rewards.md @@ -10,7 +10,7 @@ Withdraw rewards iriscli distribution withdraw-rewards [flags] ``` -Print all supported options: +Print help messages: ```shell iriscli distribution withdraw-rewards --help diff --git a/docs/cli-client/stake/README.md b/docs/cli-client/stake/README.md index 291e8a1e8..1d0ada080 100644 --- a/docs/cli-client/stake/README.md +++ b/docs/cli-client/stake/README.md @@ -7,7 +7,7 @@ Stake module provides a set of subcommands to query staking state and send staki ## Usage ```shell -iriscli stake [subcommand] +iriscli stake [subcommand] [flags] ``` Print all supported subcommands and flags: From 8cddde9e55ef75a44d715dc20a889dbc9da405d1 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sat, 17 Nov 2018 15:49:37 +0800 Subject: [PATCH 080/100] Correct some spell error and grammar error --- docs/cli-client/README.md | 20 ++++++++++--------- docs/cli-client/distribution/README.md | 2 +- .../distribution/delegation-distr-info.md | 6 +++--- .../distribution/delegator-distr-info.md | 10 +++++----- .../distribution/set-withdraw-address.md | 10 +++++----- .../distribution/validator-distr-info.md | 8 ++++---- .../distribution/withdraw-address.md | 8 ++++---- .../distribution/withdraw-rewards.md | 12 +++++------ docs/cli-client/stake/redelegate.md | 4 ++-- docs/cli-client/stake/unbond.md | 4 ++-- docs/cli-client/stake/unjail.md | 2 +- docs/zh/cli-client/README.md | 2 +- 12 files changed, 45 insertions(+), 43 deletions(-) diff --git a/docs/cli-client/README.md b/docs/cli-client/README.md index f72b62dcc..b2d562167 100644 --- a/docs/cli-client/README.md +++ b/docs/cli-client/README.md @@ -1,22 +1,22 @@ -# CLi Client +# Command Line Client -## Global flags for query commands +## Global flags of query commands -All query commands has their unique flags and these global flags. +All query commands has these global flags. Their unique flags will be introduced later. | Name, shorthand | type | Required | Default Value | Description | | --------------- | ---- | -------- | --------------------- | -------------------------------------------------------------------- | | --chain-id | string | false | "" | Chain ID of tendermint node | -| --height | int | false | 0 | block height to query, omit to get most recent provable block | -| --help, -h | string | false | | help for delegation | +| --height | int | false | 0 | Block height to query, omit to get most recent provable block | +| --help, -h | string | false | | Print help message | | --indent | bool | false | false | Add indent to JSON response | | --ledger | bool | false | false | Use a connected Ledger device | | --node | string | false | tcp://localhost:26657 | \:\ to tendermint rpc interface for this chain | | --trust-node | bool | false | true | Don't verify proofs for responses | -## Global flags for commands to send transactions +## Global flags of commands to send transactions -All commands which can be used to send transactions has their unique flags and these global flags. +All commands which can be used to send transactions have these global flags. Their unique flags will be introduced later. | Name, shorthand | type | Required | Default | Description | | -----------------| ----- | -------- | --------------------- | ------------------------------------------------------------------- | @@ -30,7 +30,7 @@ All commands which can be used to send transactions has their unique flags and t | --gas | int | false | 200000 | Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | --gas-adjustment | int | false | 1 | Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set | | --generate-only | bool | false | false | Build an unsigned transaction and write it to STDOUT | -| --help, -h | string | false | | Help for delegate | +| --help, -h | string | false | | Print help message | | --indent | bool | false | false | Add indent to JSON response | | --json | string | false | false | Return output in json format | | --ledger | bool | false | false | Use a connected Ledger device | @@ -40,7 +40,9 @@ All commands which can be used to send transactions has their unique flags and t | --sequence int | int | false | 0 | Sequence number to sign the tx | | --trust-node | bool | false | true | Don't verify proofs for responses | -## Command list +## Modules list + +Each modules provides a set of command line interfaces. Here we sort these commands by modules. 1. [bank command](./bank/README.md) 2. [distribution command](./distribution/README.md) diff --git a/docs/cli-client/distribution/README.md b/docs/cli-client/distribution/README.md index 3d5b25648..9aec53571 100644 --- a/docs/cli-client/distribution/README.md +++ b/docs/cli-client/distribution/README.md @@ -2,7 +2,7 @@ ## introduction -This document describe how to use the the command line interfaces of distribution module. +This document describes how to use the the command line interfaces of distribution module. ## Usage diff --git a/docs/cli-client/distribution/delegation-distr-info.md b/docs/cli-client/distribution/delegation-distr-info.md index 9f543be7b..c5734a0d8 100644 --- a/docs/cli-client/distribution/delegation-distr-info.md +++ b/docs/cli-client/distribution/delegation-distr-info.md @@ -2,7 +2,7 @@ ## introduction -Query delegation distribution information +Query a delegation distribution information ## Usage @@ -11,7 +11,7 @@ iriscli distribution delegation-distr-info [flags] ``` Print help messages: -```shell +``` iriscli distribution delegation-distr-info --help ``` @@ -24,7 +24,7 @@ iriscli distribution delegation-distr-info --help ## Examples -```shell +``` iriscli distribution delegation-distr-info --address-delegator= --address-validator= ``` Example response: diff --git a/docs/cli-client/distribution/delegator-distr-info.md b/docs/cli-client/distribution/delegator-distr-info.md index f2c0077ce..cb4c501b1 100644 --- a/docs/cli-client/distribution/delegator-distr-info.md +++ b/docs/cli-client/distribution/delegator-distr-info.md @@ -2,7 +2,7 @@ ## Description -Query delegator distribution information +Query a delegator distribution information ## Usage @@ -11,18 +11,18 @@ iriscli distribution delegator-distr-info [flags] ``` Print help messages: -```shell +``` iriscli distribution delegator-distr-info --help ``` ## Unique Flags -There is no unique option. But it requires a argument: delegator address +There is no unique flag. But it requires a argument: delegator address ## Examples -```shell -iriscli distribution delegation-distr-info +``` +iriscli distribution delegator-distr-info ``` Example response: ```json diff --git a/docs/cli-client/distribution/set-withdraw-address.md b/docs/cli-client/distribution/set-withdraw-address.md index 95926ead8..6aa1140f2 100644 --- a/docs/cli-client/distribution/set-withdraw-address.md +++ b/docs/cli-client/distribution/set-withdraw-address.md @@ -2,7 +2,7 @@ ## Description -Set withdraw address of a delegator +Set withdraw address for delegator ## Usage @@ -11,17 +11,17 @@ iriscli distribution set-withdraw-addr [withdraw-addr] [flags] ``` Print help messages: -```shell +``` iriscli distribution set-withdraw-addr --help ``` ## Unique Flags -There is no unique option. But it requires a argument: new withdraw address +There is no unique flag. But it requires an argument: new withdraw address ## Examples -```shell -iriscli distribution set-withdraw-addr
--from --fee=0.004iris --chain-id= +``` +iriscli distribution set-withdraw-addr --from --fee=0.004iris --chain-id= ``` diff --git a/docs/cli-client/distribution/validator-distr-info.md b/docs/cli-client/distribution/validator-distr-info.md index d006e61ce..840b6d776 100644 --- a/docs/cli-client/distribution/validator-distr-info.md +++ b/docs/cli-client/distribution/validator-distr-info.md @@ -2,7 +2,7 @@ ## Description -Query validator distribution information +Query a validator distribution information ## Usage @@ -11,18 +11,18 @@ iriscli distribution validator-distr-info [flags] ``` Print help messages: -```shell +``` iriscli distribution validator-distr-info --help ``` ## Unique Flags -There is no unique option. But it requires a argument: validator address +There is no unique flag. But it requires an argument: validator address ## Examples -```shell +``` iriscli distribution validator-distr-info ``` Example response: diff --git a/docs/cli-client/distribution/withdraw-address.md b/docs/cli-client/distribution/withdraw-address.md index c47549c26..f3ab8030c 100644 --- a/docs/cli-client/distribution/withdraw-address.md +++ b/docs/cli-client/distribution/withdraw-address.md @@ -2,7 +2,7 @@ ## Description -Query withdraw address of a delegator +Query the withdraw address of a delegator ## Usage @@ -12,7 +12,7 @@ iriscli distribution withdraw-address [delegator address] [flags] Print help messages: -```shell +``` iriscli distribution withdraw-address --help ``` @@ -23,8 +23,8 @@ There is no unique option. But it requires a argument: delegator address ## Examples -```shell -iriscli distribution withdraw-address +``` +iriscli distribution withdraw-address ``` Example response: ```text diff --git a/docs/cli-client/distribution/withdraw-rewards.md b/docs/cli-client/distribution/withdraw-rewards.md index 98a18d59d..3b949047f 100644 --- a/docs/cli-client/distribution/withdraw-rewards.md +++ b/docs/cli-client/distribution/withdraw-rewards.md @@ -27,15 +27,15 @@ Keep in mind, don't specify the above options both. ## Examples -1. Only withdraw the delegation reward from a given validator +1. Only withdraw a delegation rewards from a given validator ``` - iriscli distribution withdraw-rewards --only-from-validator fva134mhjjyyc7mehvaay0f3d4hj8qx3ee3w3eq5nq --from mykey --fee=0.004iris --chain-id=irishub-test + iriscli distribution withdraw-rewards --only-from-validator --from --fee=0.004iris --chain-id= ``` -2. Withdraw all delegation reward of a delegator +2. Withdraw all delegation rewards of a delegator ``` - iriscli distribution withdraw-rewards --from mykey --fee=0.004iris --chain-id=irishub-test + iriscli distribution withdraw-rewards --from --fee=0.004iris --chain-id= ``` -3. If the delegator is a onwer of a validator, withdraw all delegation reward and validator reward: +3. If the delegator is a onwer of a validator, withdraw all delegation rewards and validator commmission rewards: ``` - iriscli distribution withdraw-rewards --is-validator=true --from mykey --fee=0.004iris --chain-id=irishub-test + iriscli distribution withdraw-rewards --is-validator=true --from --fee=0.004iris --chain-id= ``` \ No newline at end of file diff --git a/docs/cli-client/stake/redelegate.md b/docs/cli-client/stake/redelegate.md index 0e4813f2a..c594e79c7 100644 --- a/docs/cli-client/stake/redelegate.md +++ b/docs/cli-client/stake/redelegate.md @@ -2,7 +2,7 @@ ## Introduction -Redelegate transfer delegation from one validator to another one. +Transfer delegation from one validator to another one. ## Usage @@ -25,7 +25,7 @@ iriscli stake redelegate --help | --shares-amount | float | false | 0.0 | Amount of source-shares to either unbond or redelegate as a positive integer or decimal | | --shares-percent | float | false | 0.0 | Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 | -Users must specify the redeleagte amount. There two options can do this: `--shares-amount` or `--shares-percent`. Keep in mind, don't specify them both. +Users must specify the redeleagtion token amount. There two options can do this: `--shares-amount` or `--shares-percent`. Keep in mind, don't specify both of them. ## Examples diff --git a/docs/cli-client/stake/unbond.md b/docs/cli-client/stake/unbond.md index eac8b028e..244973a94 100644 --- a/docs/cli-client/stake/unbond.md +++ b/docs/cli-client/stake/unbond.md @@ -2,7 +2,7 @@ ## Introduction -Unbond shares from a validator +Unbond tokens from a validator ## Usage @@ -24,7 +24,7 @@ iriscli stake unbond --help | --shares-amount | float | false | 0.0 | Amount of source-shares to either unbond or redelegate as a positive integer or decimal | | --shares-percent | float | false | 0.0 | Percent of source-shares to either unbond or redelegate as a positive integer or decimal >0 and <=1 | -Users must specify the unbond amount. There two options can do this: `--shares-amount` or `--shares-percent`. Keep in mind, don't specify them both. +Users must specify the unbond amount. There two options can do this: `--shares-amount` or `--shares-percent`. Keep in mind, don't specify both of them. ## Examples diff --git a/docs/cli-client/stake/unjail.md b/docs/cli-client/stake/unjail.md index 2dd3d4368..7a29eaa57 100644 --- a/docs/cli-client/stake/unjail.md +++ b/docs/cli-client/stake/unjail.md @@ -2,7 +2,7 @@ ## Introduction -Unjail validator previously jailed for downtime +Unjail validator which may be jailed previously for downtime ## Usage diff --git a/docs/zh/cli-client/README.md b/docs/zh/cli-client/README.md index c4586a191..6f280cdca 100644 --- a/docs/zh/cli-client/README.md +++ b/docs/zh/cli-client/README.md @@ -40,7 +40,7 @@ 每个发送交易的命令都包含上表中的flags，同时不同交易的命令还可能会有自己独有的flags。 -## Command list +## 模块列表 1. [bank command](./bank/README.md) 2. [distribution command](./distribution/README.md) From 74c7ec4ef7a0952977d5178302784592fb31ecf4 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sat, 17 Nov 2018 16:02:54 +0800 Subject: [PATCH 081/100] Correct spell error depositer to depositor --- docs/cli-client/gov/deposit.md | 2 +- docs/cli-client/gov/query-deposit.md | 6 +++--- docs/cli-client/gov/query-deposits.md | 2 +- docs/cli-client/gov/query-proposals.md | 4 ++-- docs/zh/cli-client/gov/deposit.md | 2 +- docs/zh/cli-client/gov/query-deposit.md | 6 +++--- docs/zh/cli-client/gov/query-deposits.md | 2 +- docs/zh/cli-client/gov/query-proposals.md | 4 ++-- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/cli-client/gov/deposit.md b/docs/cli-client/gov/deposit.md index 396c0d885..95c383530 100644 --- a/docs/cli-client/gov/deposit.md +++ b/docs/cli-client/gov/deposit.md @@ -53,7 +53,7 @@ Committed at block 473 (tx hash: 0309E969589F19A9D9E4BFC9479720487FBF929ED6A8882 "tags": { "action": "deposit", "completeConsumedTxFee-iris-atto": "\"335500000000000\"", - "depositer": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", + "depositor": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", "proposal-id": "1" } } diff --git a/docs/cli-client/gov/query-deposit.md b/docs/cli-client/gov/query-deposit.md index 6d1e1727d..a2a98a5c1 100644 --- a/docs/cli-client/gov/query-deposit.md +++ b/docs/cli-client/gov/query-deposit.md @@ -15,7 +15,7 @@ iriscli gov query-deposit [flags] | Name, shorthand | Default | Description | Required | | --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --depositer | | [string] Bech32 depositer address | Yes | +| --depositor | | [string] Bech32 depositor address | Yes | | --height | | [int] Block height to query, omit to get most recent provable block | | | --help, -h | | Help for query-deposit | | | --indent | | Add indent to JSON response | | @@ -29,14 +29,14 @@ iriscli gov query-deposit [flags] ### Query deposit ```shell -iriscli gov query-deposit --chain-id=test --proposal-id=1 --depositer=faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07 +iriscli gov query-deposit --chain-id=test --proposal-id=1 --depositor=faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07 ``` You could query the deposited tokens on a specific proposal. ```txt { - "depositer": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", + "depositor": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", "proposal_id": "1", "amount": [ { diff --git a/docs/cli-client/gov/query-deposits.md b/docs/cli-client/gov/query-deposits.md index e1facd263..d9098a365 100644 --- a/docs/cli-client/gov/query-deposits.md +++ b/docs/cli-client/gov/query-deposits.md @@ -36,7 +36,7 @@ You could query all the deposited tokens on a specific proposal, includes deposi ```txt [ { - "depositer": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", + "depositor": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", "proposal_id": "1", "amount": [ { diff --git a/docs/cli-client/gov/query-proposals.md b/docs/cli-client/gov/query-proposals.md index 81d3b9fc4..0c0645c3e 100644 --- a/docs/cli-client/gov/query-proposals.md +++ b/docs/cli-client/gov/query-proposals.md @@ -15,7 +15,7 @@ iriscli gov query-proposals [flags] | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | -| --depositer | | [string] (optional) Filter by proposals deposited on by depositer | | +| --depositor | | [string] (optional) Filter by proposals deposited on by depositor | | | --height | | [int] Block height to query, omit to get most recent provable block | | | --help, -h | | Help for query-proposals | | | --indent | | Add indent to JSON response | | @@ -44,7 +44,7 @@ You could query all the proposals by default. Also you can query proposal by filters, such as: ```shell -gov query-proposals --chain-id=test --depositer=faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd +gov query-proposals --chain-id=test --depositor=faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd ``` Finally, here shows the proposal who's depositor address is faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd. diff --git a/docs/zh/cli-client/gov/deposit.md b/docs/zh/cli-client/gov/deposit.md index 3991033b0..a83045555 100644 --- a/docs/zh/cli-client/gov/deposit.md +++ b/docs/zh/cli-client/gov/deposit.md @@ -53,7 +53,7 @@ Committed at block 473 (tx hash: 0309E969589F19A9D9E4BFC9479720487FBF929ED6A8882 "tags": { "action": "deposit", "completeConsumedTxFee-iris-atto": "\"335500000000000\"", - "depositer": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", + "depositor": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd", "proposal-id": "1" } } diff --git a/docs/zh/cli-client/gov/query-deposit.md b/docs/zh/cli-client/gov/query-deposit.md index 636d2fa7d..c061675ff 100644 --- a/docs/zh/cli-client/gov/query-deposit.md +++ b/docs/zh/cli-client/gov/query-deposit.md @@ -15,7 +15,7 @@ iriscli gov query-deposit [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] tendermint节点的链ID | Yes | -| --depositer | | [string] bech32编码的存款人地址 | Yes | +| --depositor | | [string] bech32编码的存款人地址 | Yes | | --height | | [int] 查询的区块高度 | | | --help, -h | | 查询命令帮助 | | | --indent | | 在JSON响应中添加缩进 | | @@ -29,14 +29,14 @@ iriscli gov query-deposit [flags] ### 查询充值保证金 ```shell -iriscli gov query-deposit --chain-id=test --proposal-id=1 --depositer=faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07 +iriscli gov query-deposit --chain-id=test --proposal-id=1 --depositor=faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07 ``` 通过指定提议、指定存款人查询保证金充值详情，得到结果如下： ```txt { - "depositer": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", + "depositor": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", "proposal_id": "1", "amount": [ { diff --git a/docs/zh/cli-client/gov/query-deposits.md b/docs/zh/cli-client/gov/query-deposits.md index d4696cfad..2f5dd8853 100644 --- a/docs/zh/cli-client/gov/query-deposits.md +++ b/docs/zh/cli-client/gov/query-deposits.md @@ -36,7 +36,7 @@ iriscli gov query-deposits --chain-id=test --proposal-id=1 ```txt [ { - "depositer": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", + "depositor": "faa1c4kjt586r3t353ek9jtzwxum9x9fcgwetyca07", "proposal_id": "1", "amount": [ { diff --git a/docs/zh/cli-client/gov/query-proposals.md b/docs/zh/cli-client/gov/query-proposals.md index 18ba05d85..2c3b276c7 100644 --- a/docs/zh/cli-client/gov/query-proposals.md +++ b/docs/zh/cli-client/gov/query-proposals.md @@ -15,7 +15,7 @@ iriscli gov query-proposals [flags] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] tendermint节点的链ID | Yes | -| --depositer | | [string] （可选）按存款人过滤 | | +| --depositor | | [string] （可选）按存款人过滤 | | | --height | | [int] 查询的区块高度 | | | --help, -h | | 查询命令帮助 | | | --indent | | 在JSON响应中添加缩进 | | @@ -44,7 +44,7 @@ iriscli gov query-proposals --chain-id=test 当然这里可以查询指定条件的提议。 ```shell -gov query-proposals --chain-id=test --depositer=faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd +gov query-proposals --chain-id=test --depositor=faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd ``` 可以得到存款人是faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd地址的提议。 From c789514bac851e06ab33d55ccdd9e63677374d4d Mon Sep 17 00:00:00 2001 From: chengwenxi Date: Sat, 17 Nov 2018 16:04:25 +0800 Subject: [PATCH 082/100] IRISHUB-677: update doc of service feature --- docs/cli-client/service/define.md | 2 +- docs/cli-client/service/test.proto | 21 ---- docs/features/service.md | 111 +++++++++++------ docs/zh/cli-client/service/define.md | 2 +- docs/zh/cli-client/service/test.proto | 21 ---- docs/zh/features/service.md | 164 ++++++++++++++++++++++---- docs/zh/features/test.proto | 21 ---- 7 files changed, 222 insertions(+), 120 deletions(-) delete mode 100644 docs/cli-client/service/test.proto delete mode 100644 docs/zh/cli-client/service/test.proto delete mode 100644 docs/zh/features/test.proto diff --git a/docs/cli-client/service/define.md b/docs/cli-client/service/define.md index ccf81ff5d..309d397f3 100644 --- a/docs/cli-client/service/define.md +++ b/docs/cli-client/service/define.md @@ -68,5 +68,5 @@ Committed at block 65 (tx hash: 663B676E453F91BFCDC87B0308910501DD14DF79C88390FC * IDL file example - [test.proto](./test.proto) + [test.proto](../../features/test.proto) diff --git a/docs/cli-client/service/test.proto b/docs/cli-client/service/test.proto deleted file mode 100644 index ccb70ab00..000000000 --- a/docs/cli-client/service/test.proto +++ /dev/null @@ -1,21 +0,0 @@ -syntax = "proto3"; - -package helloworld; - -// The greeting service definition. -service Greeter { - //@Attribute description: sayHello - //@Attribute output_privacy: NoPrivacy - //@Attribute output_cached: NoCached - rpc SayHello (HelloRequest) returns (HelloReply) {} -} - -// The request message containing the user's name. -message HelloRequest { - string name = 1; -} - -// The response message containing the greetings -message HelloReply { - string message = 1; -} diff --git a/docs/features/service.md b/docs/features/service.md index 6ee46fffa..492f282d2 100644 --- a/docs/features/service.md +++ b/docs/features/service.md @@ -1,4 +1,4 @@ -# IService User Guide +# Service User Guide ## Basic Function Description IRIS Services (a.k.a. "iServices") intend to bridge the gap between the blockchain world and the conventional business application world, by mediating a complete lifecycle of off-chain services -- from their definition, binding (provider registration), invocation, to their governance (profiling and dispute resolution). By enhancing the IBC processing logic to support service semantics, the IRIS SDK is intended to allow distributed business services to be available across the internet of blockchains. The [Interface description language](https://en.wikipedia.org/wiki/Interface_description_language) (IDL) we introduced is @@ -31,7 +31,7 @@ iris start --home=iris ``` # Service definition -iriscli iservice define --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags tag1,tag2 --messaging=Unicast --idl-content= --file=test.proto +iriscli service define --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags=tag1,tag2 --idl-content= --file=test.proto # Result Committed at block 92 (tx hash: A63241AA6666B8CFE6B1C092B707AB0FA350F108, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:8007 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 101 102 105 110 101]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 54 48 49 52 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) @@ -43,14 +43,14 @@ Committed at block 92 (tx hash: A63241AA6666B8CFE6B1C092B707AB0FA350F108, respon } # Query service definition -iriscli iservice definition --def-chain-id=service-test --service-name=test-service +iriscli service definition --def-chain-id=service-test --service-name=test-service ``` ### Service Binding ``` # Service Binding -iriscli iservice bind --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 --expiration=-1 +iriscli service bind --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 # Result Committed at block 168 (tx hash: 02CAC60E75CD93465CAE10CE35F30B53C8A95574, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5437 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 98 105 110 100]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 48 56 55 52 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) @@ -62,13 +62,13 @@ Committed at block 168 (tx hash: 02CAC60E75CD93465CAE10CE35F30B53C8A95574, respo } # Query service binding -iriscli iservice binding --def-chain-id=service-test --service-name=test-service --bind-chain-id=service-test --provider= +iriscli service binding --def-chain-id=service-test --service-name=test-service --bind-chain-id=service-test --provider= # Query service binding list -iriscli iservice bindings --def-chain-id=service-test --service-name=test-service +iriscli service bindings --def-chain-id=service-test --service-name=test-service # Service binding update -iriscli iservice update-binding --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris,2iris --avg-rsp-time=10000 --usable-time=100 --expiration=-1 +iriscli service update-binding --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris,2iris --avg-rsp-time=10000 --usable-time=100 # Result Committed at block 233 (tx hash: 2F5F44BAF09981D137EA667F9E872EB098A9B619, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:4989 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 98 105 110 100 105 110 103 45 117 112 100 97 116 101]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[57 57 55 56 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) @@ -79,8 +79,32 @@ Committed at block 233 (tx hash: 2F5F44BAF09981D137EA667F9E872EB098A9B619, respo } } +# Disable service binding +iriscli service disable --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service + +# Result +Committed at block 241 (tx hash: 0EF936E1228F9838D0343D0FB3613F5E938602B7, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:4861 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 105 115 97 98 108 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 57 55 50 50 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-disable", + "completeConsumedTxFee-iris-atto": "\"97220000000000\"" + } +} + +# Enable service binding +iriscli service enable --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service --deposit=1iris + +# Result +Committed at block 176 (tx hash: 74AE647B8A311501CA82DACE90AA28CDB4695803, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:6330 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 101 110 97 98 108 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 50 54 54 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-enable", + "completeConsumedTxFee-iris-atto": "\"126600000000000\"" + } +} + # Refund Deposit -iriscli iservice refund-deposit --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service +iriscli service refund-deposit --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service # Result Committed at block 1563 (tx hash: 748CEA6EA9DEFB384FFCFBE68A3CB6D8B643361B, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5116 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 114 101 102 117 110 100 45 100 101 112 111 115 105 116]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 48 50 51 50 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) @@ -95,57 +119,74 @@ Committed at block 1563 (tx hash: 748CEA6EA9DEFB384FFCFBE68A3CB6D8B643361B, resp ## CLI Command Details ``` -iriscli iservice define --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags "tag1 tag2" --messaging=Unicast --idl-content= --file=test.proto +iriscli service define --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags=tag1,tag2 --idl-content= --file=test.proto ``` -* `--service-name` The name of iService -* `--service-description` The description of this iService -* `--author-description` The self-description of the iService creator which is optional -* `--tags` The keywords of this iService -* `--messaging` The transfer type of this iService{`Unicast`,`Multicast`} -* `--idl-content` The standardized definition of the methods for this iService +* `--service-name` The name of service +* `--service-description` The description of this service +* `--author-description` The self-description of the service creator which is optional +* `--tags` The keywords of this service +* `--idl-content` The standardized definition of the methods for this service * `--file` Idl-content can be replaced by files,if the item is not empty. ``` -iriscli iservice definition --def-chain-id=service-test --service-name=test-service +iriscli service definition --def-chain-id=service-test --service-name=test-service ``` -* `--def-chain-id` The ID of the blockchain defined of the iService -* `--service-name` The name of iService +* `--def-chain-id` The ID of the blockchain defined of the service +* `--service-name` The name of service ``` -iriscli iservice bind --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 --expiration=-1 +iriscli service bind --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 ``` -* `--def-chain-id` The ID of the blockchain defined of the iService -* `--service-name` The name of iService +* `--def-chain-id` The ID of the blockchain defined of the service +* `--service-name` The name of service * `--bind-type` Set whether the service is local or global * `--deposit` The deposit of service provider * `--prices` Service prices, a list sorted by service method * `--avg-rsp-time` The average service response time in milliseconds * `--usable-time` An integer represents the number of usable service invocations per 10,000 -* `--expiration` Negative number used here means the unbonded blockchain height "never expire" ``` -iriscli iservice binding --def-chain-id=service-test --service-name=test-service --bind-chain-id=service-test --provider= +iriscli service binding --def-chain-id=service-test --service-name=test-service --bind-chain-id=service-test --provider= ``` -* `--def-chain-id` The ID of the blockchain defined of the iService -* `--service-name` The name of iService -* `--bind-chain-id` The ID of the blockchain bound of the iService +* `--def-chain-id` The ID of the blockchain defined of the service +* `--service-name` The name of service +* `--bind-chain-id` The ID of the blockchain bound of the service * `--provider` The blockchain address of bech32 encoded account ``` -iriscli iservice bindings --def-chain-id=service-test --service-name=test-service +iriscli service bindings --def-chain-id=service-test --service-name=test-service +``` +* Refer to iriscli service binding + +``` +iriscli service update-binding --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris,2iris --avg-rsp-time=10000 --usable-time=100 +``` +* `--def-chain-id` The ID of the blockchain defined of the service +* `--service-name` The name of service +* `--bind-type` Set whether the service is local or global +* `--deposit` Add to the current deposit balance of service provider +* `--prices` Service prices, a list sorted by service method +* `--avg-rsp-time` The average service response time in milliseconds +* `--usable-time` An integer represents the number of usable service invocations per 10,000 + +``` +iriscli service disable --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service ``` -* Refer to iriscli iservice binding +* `--def-chain-id` The ID of the blockchain defined of the service +* `--service-name` The name of service ``` -iriscli iservice update-binding --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris,2iris --avg-rsp-time=10000 --usable-time=100 --expiration=-1 +iriscli service enable --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service --deposit=1iris ``` -* Refer to iriscli iservice bind +* `--def-chain-id` The ID of the blockchain defined of the service +* `--service-name` The name of service +* `--deposit` Add to the current deposit balance of service provider ``` -iriscli iservice refund-deposit --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service +iriscli service refund-deposit --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service ``` -* `--def-chain-id` The ID of the blockchain defined of the iService -* `--service-name` The name of iService +* `--def-chain-id` The ID of the blockchain defined of the service +* `--service-name` The name of service ## IDL extension When using proto file to standardize the definition of the service's method, its input and output parameters, the method attributes can be added through annotations. @@ -155,7 +196,7 @@ When using proto file to standardize the definition of the service's method, its > //@Attribute description: sayHello ### Currently supported attributes -* `description` The name of this method in the iService +* `description` The name of this method in the service * `output_privacy` Whether the output of the method is encrypted，{`NoPrivacy`,`PubKeyEncryption`} * `output_cached` Whether the output of the method is cached，{`OffChainCached`，`NoCached`} @@ -165,4 +206,4 @@ When using proto file to standardize the definition of the service's method, its * IDL file example -[test.proto](./test.proto) +[test.proto](./test.proto) \ No newline at end of file diff --git a/docs/zh/cli-client/service/define.md b/docs/zh/cli-client/service/define.md index cb9990934..553874d8b 100644 --- a/docs/zh/cli-client/service/define.md +++ b/docs/zh/cli-client/service/define.md @@ -68,5 +68,5 @@ Committed at block 65 (tx hash: 663B676E453F91BFCDC87B0308910501DD14DF79C88390FC * IDL文件示例 - [test.proto](./test.proto) + [test.proto](../../../features/test.proto) diff --git a/docs/zh/cli-client/service/test.proto b/docs/zh/cli-client/service/test.proto deleted file mode 100644 index ccb70ab00..000000000 --- a/docs/zh/cli-client/service/test.proto +++ /dev/null @@ -1,21 +0,0 @@ -syntax = "proto3"; - -package helloworld; - -// The greeting service definition. -service Greeter { - //@Attribute description: sayHello - //@Attribute output_privacy: NoPrivacy - //@Attribute output_cached: NoCached - rpc SayHello (HelloRequest) returns (HelloReply) {} -} - -// The request message containing the user's name. -message HelloRequest { - string name = 1; -} - -// The response message containing the greetings -message HelloReply { - string message = 1; -} diff --git a/docs/zh/features/service.md b/docs/zh/features/service.md index ea5a85792..23e51e935 100644 --- a/docs/zh/features/service.md +++ b/docs/zh/features/service.md @@ -1,9 +1,11 @@ -# IService User Guide +# 服务模块用户手册 ## 基本功能描述 - +IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定（服务提供方注册）、调用到治理（分析和争端解决）的全生命周期传递，来跨越区块链世界和传统业务应用世界之间的鸿沟。 +IRIS SDK通过增强的IBC处理逻辑来支持服务语义，以允许分布式商业服务在区块链互联网上可用。我们引入接口描述语言（[Interface description language](https://en.wikipedia.org/wiki/Interface_description_language)， +简称IDL）对服务进行进行标准化的定义来满足跨语言的服务调用。目前支持的IDL语言为[protobuf](https://developers.google.com/protocol-buffers/)。该模块的主要功能点如下： 1. 服务定义 -2. 服务绑定 (TODO) +2. 服务绑定 3. 服务调用 (TODO) 4. 争议解决 (TODO) 5. 服务分析 (TODO) @@ -12,7 +14,7 @@ ### 服务定义流程 -1. 任何用户可以发起服务定义请求，在服务定义中，使用 [protobuf](https://developers.google.com/protocol-buffers/) 对该服务的方法，方法的输入、输出参数进行标准化定义。 +1. 任何用户可以发起服务定义请求，在服务定义中，使用`protobuf`对该服务的方法，方法的输入、输出参数进行标准化定义。 ## 使用场景 ### 创建使用环境 @@ -29,41 +31,163 @@ iris start --home=iris ``` # 服务定义 -iriscli iservice define --chain-id=service-test --from=x --fee=0.004iris --name=test-service --service-description=service-description --author-description=author-description --tags "tag1 tag2" --broadcast=Broadcast --idl-content= --file=test.proto +iriscli service define --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags=tag1,tag2 --idl-content= --file=test.proto # 结果 -Committed at block 1040 (tx hash: 58FD40B739F592F5BD9B904A661B8D7B19C63FA9, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:13601 Tags:[{Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[247 102 151 120 200 0]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +Committed at block 92 (tx hash: A63241AA6666B8CFE6B1C092B707AB0FA350F108, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:8007 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 101 102 105 110 101]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 54 48 49 52 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) { "tags": { - "completeConsumedTxFee-iris-atto": "159740000000000" + "action": "service-define", + "completeConsumedTxFee-iris-atto": "160140000000000" } } # 查询服务定义 -iriscli iservice definition --def-chain-id=service-test --name=test-service --chain-id=service-test +iriscli service definition --def-chain-id=service-test --service-name=test-service + +``` + +### 服务绑定 +``` +# 服务绑定 +iriscli service bind --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 + +# 结果 +Committed at block 168 (tx hash: 02CAC60E75CD93465CAE10CE35F30B53C8A95574, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5437 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 98 105 110 100]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 48 56 55 52 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-bind", + "completeConsumedTxFee-iris-atto": "108740000000000" + } +} + +# 查询服务绑定 +iriscli service binding --def-chain-id=service-test --service-name=test-service --bind-chain-id=service-test --provider= + +# 查询服务绑定列表 +iriscli service bindings --def-chain-id=service-test --service-name=test-service + +# 服务绑定更新 +iriscli service update-binding --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris,2iris --avg-rsp-time=10000 --usable-time=100 + +# 结果 +Committed at block 233 (tx hash: 2F5F44BAF09981D137EA667F9E872EB098A9B619, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:4989 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 98 105 110 100 105 110 103 45 117 112 100 97 116 101]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[57 57 55 56 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-binding-update", + "completeConsumedTxFee-iris-atto": "99780000000000" + } +} + +# 禁用服务绑定 +iriscli service disable --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service + +# 结果 +Committed at block 241 (tx hash: 0EF936E1228F9838D0343D0FB3613F5E938602B7, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:4861 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 100 105 115 97 98 108 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 57 55 50 50 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-disable", + "completeConsumedTxFee-iris-atto": "\"97220000000000\"" + } +} + +# 开启服务绑定 +iriscli service enable --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service --deposit=1iris + +# 结果 +Committed at block 176 (tx hash: 74AE647B8A311501CA82DACE90AA28CDB4695803, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:6330 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 101 110 97 98 108 101] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[34 49 50 54 54 48 48 48 48 48 48 48 48 48 48 48 34] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-enable", + "completeConsumedTxFee-iris-atto": "\"126600000000000\"" + } +} + +# 取回押金 +iriscli service refund-deposit --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service + +# 结果 +Committed at block 1563 (tx hash: 748CEA6EA9DEFB384FFCFBE68A3CB6D8B643361B, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:5116 Tags:[{Key:[97 99 116 105 111 110] Value:[115 101 114 118 105 99 101 45 114 101 102 117 110 100 45 100 101 112 111 115 105 116]} {Key:[99 111 109 112 108 101 116 101 67 111 110 115 117 109 101 100 84 120 70 101 101 45 105 114 105 115 45 97 116 116 111] Value:[49 48 50 51 50 48 48 48 48 48 48 48 48 48 48]}] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0}) +{ + "tags": { + "action": "service-refund-deposit", + "completeConsumedTxFee-iris-atto": "102320000000000" + } +} ``` ## 命令详情 ``` -iriscli iservice define --chain-id=service-test --from=x --fee=0.004iris --name=test-service --service-description=service-description --author-description=author-description --tags "tag1 tag2" --broadcast=Broadcast --idl-content= --file=test.proto +iriscli service define --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --service-description=service-description --author-description=author-description --tags=tag1,tag2 --idl-content= --file=test.proto ``` - -* `--name` 该iService服务的名称 -* `--service-description` 该iService服务的描述 -* `--author-description` 该iService服务创建者的描述. 可选 -* `--tags` 该iService服务的关键字 -* `--broadcast` 此服务消息广播类型{`Broadcast`,`Unicast`} -* `--idl-content` 对该iService服务的methods的标准化定义内容 +* `--service-name` 该服务名称 +* `--service-description` 该服务的描述 +* `--author-description` 该服务创建者的描述. 可选 +* `--tags` 该服务的关键字 +* `--idl-content` 对该服务的methods的标准化定义内容 * `--file` 可使用文件代替idl-content，当该项不为空时，覆盖`idl-content`内容 ``` -iriscli iservice definition --def-chain-id=service-test --name=test-service --chain-id=service-test +iriscli service definition --def-chain-id=service-test --service-name=test-service +``` +* `--def-chain-id` 定义该服务的区块链ID +* `--service-name` 服务名称 + +``` +iriscli service bind --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris --avg-rsp-time=10000 --usable-time=100 ``` +* `--def-chain-id` 定义该服务的区块链ID +* `--service-name` 服务名称 +* `--bind-type` 对服务是本地还是全局的设置，可选值Local/Global +* `--deposit` 服务提供者的保证金 +* `--prices` 服务定价,按照服务方法排序的定价列表 +* `--avg-rsp-time` 服务平均返回时间的毫秒数表示 +* `--usable-time` 每一万次服务调用的可用性的整数表示 -* `--def-chain-id` 定义该iservice服务的区块链ID -* `--name` iService服务的名称 +``` +iriscli service binding --def-chain-id=service-test --service-name=test-service --bind-chain-id=service-test --provider= +``` +* `--def-chain-id` 定义该服务的区块链ID +* `--service-name` 服务名称 +* `--bind-chain-id` 绑定该服务的区块链ID +* `--provider` 服务提供者的区块链地址(bech32编码) + +``` +iriscli service bindings --def-chain-id=service-test --service-name=test-service +``` +* 参照iriscli service binding + +``` +iriscli service update-binding --chain-id=service-test --from=x --fee=0.004iris --service-name=test-service --def-chain-id=service-test --bind-type=Local --deposit=1iris --prices=1iris,2iris --avg-rsp-time=10000 --usable-time=100 +``` +* `--def-chain-id` 定义该服务的区块链ID +* `--service-name` 服务名称 +* `--bind-type` 对服务是本地还是全局的设置，可选值Local/Global +* `--deposit` 追加的服务提供者保证金 +* `--prices` 服务定价,按照服务方法排序的定价列表 +* `--avg-rsp-time` 服务平均返回时间的毫秒数表示 +* `--usable-time` 每一万次服务调用可用次数的整数表示 + +``` +iriscli service disable --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service +``` +* `--def-chain-id` 定义该服务的区块链ID +* `--service-name` 服务名称 + +``` +iriscli service enable --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service --deposit=1iris +``` +* `--def-chain-id` 定义该服务的区块链ID +* `--service-name` 服务名称 +* `--deposit` 追加的服务提供者保证金 + +``` +iriscli service refund-deposit --chain-id=service-test --from=x --fee=0.004iris --def-chain-id=service-test --service-name=test-service +``` +* `--def-chain-id` 定义该服务的区块链ID +* `--service-name` 服务名称 ## IDL文件扩展 在使用proto文件对服务的方法，输入、输出参数进行标准化定义时，可通过注释的方式增加method属性。 @@ -83,4 +207,4 @@ iriscli iservice definition --def-chain-id=service-test --name=test-service --ch * IDL文件参照 -[test.proto](../../../modules/iservice/test.proto) \ No newline at end of file +[test.proto](../../features/test.proto) \ No newline at end of file diff --git a/docs/zh/features/test.proto b/docs/zh/features/test.proto deleted file mode 100644 index ccb70ab00..000000000 --- a/docs/zh/features/test.proto +++ /dev/null @@ -1,21 +0,0 @@ -syntax = "proto3"; - -package helloworld; - -// The greeting service definition. -service Greeter { - //@Attribute description: sayHello - //@Attribute output_privacy: NoPrivacy - //@Attribute output_cached: NoCached - rpc SayHello (HelloRequest) returns (HelloReply) {} -} - -// The request message containing the user's name. -message HelloRequest { - string name = 1; -} - -// The response message containing the greetings -message HelloReply { - string message = 1; -} From 3b2ffe3f3bf9095ea6ae09e5e611b2c44d40c37c Mon Sep 17 00:00:00 2001 From: chengwenxi Date: Sat, 17 Nov 2018 16:25:26 +0800 Subject: [PATCH 083/100] IRISHUB-677: remove global flags --- docs/cli-client/service/bind.md | 18 ------------------ docs/cli-client/service/binding.md | 7 ------- docs/cli-client/service/bindings.md | 7 ------- docs/cli-client/service/define.md | 18 ------------------ docs/cli-client/service/definition.md | 7 ------- docs/cli-client/service/disable.md | 18 ------------------ docs/cli-client/service/enable.md | 18 ------------------ docs/cli-client/service/refund-deposit.md | 18 ------------------ docs/cli-client/service/update-binding.md | 18 ------------------ docs/zh/cli-client/service/bind.md | 18 ------------------ docs/zh/cli-client/service/binding.md | 6 ------ docs/zh/cli-client/service/bindings.md | 6 ------ docs/zh/cli-client/service/define.md | 18 ------------------ docs/zh/cli-client/service/definition.md | 7 ------- docs/zh/cli-client/service/disable.md | 18 ------------------ docs/zh/cli-client/service/enable.md | 18 ------------------ docs/zh/cli-client/service/refund-deposit.md | 18 ------------------ docs/zh/cli-client/service/update-binding.md | 18 ------------------ docs/zh/features/service.md | 2 +- 19 files changed, 1 insertion(+), 257 deletions(-) diff --git a/docs/cli-client/service/bind.md b/docs/cli-client/service/bind.md index d96d82e7b..fc2a609ea 100644 --- a/docs/cli-client/service/bind.md +++ b/docs/cli-client/service/bind.md @@ -22,24 +22,6 @@ iriscli service bind [flags] | --service-name | | [string] service name | Yes | | --usable-time | | [int] an integer represents the number of usable service invocations per 10,000 | Yes | | -h, --help | | help for bind | | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/service/binding.md b/docs/cli-client/service/binding.md index 60af39649..8c5e2554a 100644 --- a/docs/cli-client/service/binding.md +++ b/docs/cli-client/service/binding.md @@ -19,13 +19,6 @@ iriscli service binding [flags] | --provider | | [string] bech32 encoded account created the service binding | Yes | | --service-name | | [string] service name | Yes | | --help, -h | | help for binding | | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | [int] block height to query | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | - ## Examples diff --git a/docs/cli-client/service/bindings.md b/docs/cli-client/service/bindings.md index 6bde865fe..8634882e4 100644 --- a/docs/cli-client/service/bindings.md +++ b/docs/cli-client/service/bindings.md @@ -17,13 +17,6 @@ iriscli service bindings [flags] | --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | | --service-name | | [string] service name | Yes | | --help, -h | | help for bindings | | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | [int] block height to query | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | - ## Examples diff --git a/docs/cli-client/service/define.md b/docs/cli-client/service/define.md index 309d397f3..ff85b2f59 100644 --- a/docs/cli-client/service/define.md +++ b/docs/cli-client/service/define.md @@ -21,24 +21,6 @@ iriscli service define [flags] | --idl-content | | [string] content of service interface description language | | | --file | | [string] path of file which contains service interface description language | | | -h, --help | | help for define | | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/service/definition.md b/docs/cli-client/service/definition.md index b532f6ab2..6ad5e85ca 100644 --- a/docs/cli-client/service/definition.md +++ b/docs/cli-client/service/definition.md @@ -17,13 +17,6 @@ iriscli service definition [flags] | --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | | --service-name | | [string] service name | Yes | | --help, -h | | help for definition | | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | [int] block height to query | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | - ## Examples diff --git a/docs/cli-client/service/disable.md b/docs/cli-client/service/disable.md index 8ad4a7d1b..fdaa07e32 100644 --- a/docs/cli-client/service/disable.md +++ b/docs/cli-client/service/disable.md @@ -17,24 +17,6 @@ iriscli service disable [flags] | --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | | --service-name | | [string] service name | Yes | | -h, --help | | help for disable | | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/service/enable.md b/docs/cli-client/service/enable.md index 4ebece3f1..91057770a 100644 --- a/docs/cli-client/service/enable.md +++ b/docs/cli-client/service/enable.md @@ -18,24 +18,6 @@ iriscli service enable [flags] | --deposit string | | [string] deposit of binding, will add to the current deposit balance | | | --service-name | | [string] service name | Yes | | -h, --help | | help for enable | | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/service/refund-deposit.md b/docs/cli-client/service/refund-deposit.md index c7308356e..845c88b09 100644 --- a/docs/cli-client/service/refund-deposit.md +++ b/docs/cli-client/service/refund-deposit.md @@ -17,24 +17,6 @@ iriscli service refund-deposit [flags] | --def-chain-id | | [string] the ID of the blockchain defined of the service | Yes | | --service-name | | [string] service name | Yes | | -h, --help | | help for refund-deposit | | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/cli-client/service/update-binding.md b/docs/cli-client/service/update-binding.md index 9cd7108ff..f7c34f303 100644 --- a/docs/cli-client/service/update-binding.md +++ b/docs/cli-client/service/update-binding.md @@ -21,24 +21,6 @@ iriscli service update-binding [flags] | --service-name | | [string] service name | Yes | | --usable-time | | [int] an integer represents the number of usable service invocations per 10,000 | | | -h, --help | | help for update-binding | | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | build an unsigned transaction and write it to STDOUT | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] : to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples diff --git a/docs/zh/cli-client/service/bind.md b/docs/zh/cli-client/service/bind.md index 7aafcc32f..00a68b866 100644 --- a/docs/zh/cli-client/service/bind.md +++ b/docs/zh/cli-client/service/bind.md @@ -22,24 +22,6 @@ iriscli service bind [flags] | --service-name | | [string] 服务名称 | Yes | | --usable-time | | [int] 每一万次服务调用的可用性的整数表示 | Yes | | -h, --help | | 绑定命令帮助 | | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | 是 | -| --from | | [string] 用来签名的私钥名 | 是 | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/service/binding.md b/docs/zh/cli-client/service/binding.md index c76a8a8ea..6cbfd598c 100644 --- a/docs/zh/cli-client/service/binding.md +++ b/docs/zh/cli-client/service/binding.md @@ -19,12 +19,6 @@ iriscli service binding [flags] | --provider | | [string] 服务提供者的区块链地址(bech32编码) | 是 | | --service-name | | [string] 服务名称 | 是 | | --help, -h | | 查询绑定命令帮助 | | -| --chain-id | | [string] tendermint节点的链ID | | -| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | -| --indent | | 在JSON格式的应答中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/service/bindings.md b/docs/zh/cli-client/service/bindings.md index 5243b8c09..dbb40811a 100644 --- a/docs/zh/cli-client/service/bindings.md +++ b/docs/zh/cli-client/service/bindings.md @@ -17,12 +17,6 @@ iriscli service bindings [flags] | --def-chain-id | | [string] 定义该服务的区块链ID | 是 | | --service-name | | [string] 服务名称 | 是 | | --help, -h | | 查询绑定列表命令帮助 | | -| --chain-id | | [string] tendermint节点的链ID | | -| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | -| --indent | | 在JSON格式的应答中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/service/define.md b/docs/zh/cli-client/service/define.md index 553874d8b..176541cdb 100644 --- a/docs/zh/cli-client/service/define.md +++ b/docs/zh/cli-client/service/define.md @@ -21,24 +21,6 @@ iriscli service define [flags] | --idl-content | | [string] 对该服务描述的接口定义语言内容 | | | --file | | [string] 对该服务描述的接口定义语言内容的文件路径 | | | -h, --help | | 服务定义命令帮助 | | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | 是 | -| --from | | [string] 用来签名的私钥名 | 是 | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/service/definition.md b/docs/zh/cli-client/service/definition.md index 9c5f13943..30814f420 100644 --- a/docs/zh/cli-client/service/definition.md +++ b/docs/zh/cli-client/service/definition.md @@ -17,13 +17,6 @@ iriscli service definition [flags] | --def-chain-id | | [string] 定义该服务的区块链ID | 是 | | --service-name | | [string] 服务名称 | 是 | | --help, -h | | 查询定义命令帮助 | | -| --chain-id | | [string] tendermint节点的链ID | | -| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | -| --indent | | 在JSON格式的应答中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - ## 例子 diff --git a/docs/zh/cli-client/service/disable.md b/docs/zh/cli-client/service/disable.md index 74d71a168..f1b866d4d 100644 --- a/docs/zh/cli-client/service/disable.md +++ b/docs/zh/cli-client/service/disable.md @@ -17,24 +17,6 @@ iriscli service disable [flags] | --def-chain-id | | [string] 定义该服务的区块链ID | Yes | | --service-name | | [string] 服务名称 | Yes | | -h, --help | | 禁用命令帮助 | | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | 是 | -| --from | | [string] 用来签名的私钥名 | 是 | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/service/enable.md b/docs/zh/cli-client/service/enable.md index 3b60b7a54..e9c2bb8d7 100644 --- a/docs/zh/cli-client/service/enable.md +++ b/docs/zh/cli-client/service/enable.md @@ -18,24 +18,6 @@ iriscli service enable [flags] | --deposit string | | [string] 绑定押金, 将会增加当前服务绑定押金 | | | --service-name | | [string] 服务名称 | Yes | | -h, --help | | 启用命令帮助 | | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | 是 | -| --from | | [string] 用来签名的私钥名 | 是 | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/service/refund-deposit.md b/docs/zh/cli-client/service/refund-deposit.md index 835159115..e056cc943 100644 --- a/docs/zh/cli-client/service/refund-deposit.md +++ b/docs/zh/cli-client/service/refund-deposit.md @@ -17,24 +17,6 @@ iriscli service refund-deposit [flags] | --def-chain-id | | [string] 定义该服务的区块链ID | Yes | | --service-name | | [string] 服务名称 | Yes | | -h, --help | | 取回押金命令帮助 | | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | 是 | -| --from | | [string] 用来签名的私钥名 | 是 | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/service/update-binding.md b/docs/zh/cli-client/service/update-binding.md index 3cfe4f8fd..4d3e6343e 100644 --- a/docs/zh/cli-client/service/update-binding.md +++ b/docs/zh/cli-client/service/update-binding.md @@ -21,24 +21,6 @@ iriscli service update-binding [flags] | --service-name | | [string] 服务名称 | Yes | | --usable-time | | [int] 每一万次服务调用的可用性的整数表示 | Yes | | -h, --help | | 绑定更新命令帮助 | | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | 是 | -| --from | | [string] 用来签名的私钥名 | 是 | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/features/service.md b/docs/zh/features/service.md index 23e51e935..66752cb68 100644 --- a/docs/zh/features/service.md +++ b/docs/zh/features/service.md @@ -1,4 +1,4 @@ -# 服务模块用户手册 +# Service User Guide ## 基本功能描述 IRIS Services（又名“iServices”）旨在对链下服务从定义、绑定（服务提供方注册）、调用到治理（分析和争端解决）的全生命周期传递，来跨越区块链世界和传统业务应用世界之间的鸿沟。 From 080f5cfde61308451c806916bb8fdc9bc1f6bf8b Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sat, 17 Nov 2018 17:15:19 +0800 Subject: [PATCH 084/100] Refactor docs for stake query interface --- docs/cli-client/distribution/README.md | 4 +-- .../distribution/delegator-distr-info.md | 8 ++---- .../distribution/set-withdraw-address.md | 8 ++---- .../distribution/validator-distr-info.md | 9 ++----- .../distribution/withdraw-address.md | 8 +----- .../distribution/withdraw-rewards.md | 2 +- docs/cli-client/stake/README.md | 4 +-- docs/cli-client/stake/create-validator.md | 4 +-- docs/cli-client/stake/delegate.md | 4 +-- docs/cli-client/stake/delegation.md | 18 +++++-------- docs/cli-client/stake/delegations.md | 25 ++++++----------- docs/cli-client/stake/edit-validator.md | 4 +-- docs/cli-client/stake/parameters.md | 21 +++++---------- docs/cli-client/stake/pool.md | 21 +++++---------- docs/cli-client/stake/redelegate.md | 6 ++--- docs/cli-client/stake/redelegation.md | 18 +++++-------- docs/cli-client/stake/redelegations-from.md | 25 ++++++----------- docs/cli-client/stake/redelegations.md | 25 ++++++----------- docs/cli-client/stake/signing-info.md | 20 +++++--------- docs/cli-client/stake/unbond.md | 7 +++-- docs/cli-client/stake/unbonding-delegation.md | 18 +++++-------- .../stake/unbonding-delegations-from.md | 25 ++++++----------- .../cli-client/stake/unbonding-delegations.md | 25 ++++++----------- docs/cli-client/stake/unjail.md | 11 +++----- docs/cli-client/stake/validator.md | 25 ++++++----------- docs/cli-client/stake/validators.md | 21 +++++---------- docs/zh/cli-client/distribution/README.md | 4 +-- .../distribution/delegation-distr-info.md | 4 +-- .../distribution/delegator-distr-info.md | 12 +++------ .../distribution/set-withdraw-address.md | 9 ++----- .../distribution/validator-distr-info.md | 5 ---- .../distribution/withdraw-address.md | 9 ++----- docs/zh/cli-client/stake/delegation.md | 18 +++++-------- docs/zh/cli-client/stake/delegations.md | 24 ++++++----------- docs/zh/cli-client/stake/edit-validator.md | 4 +-- docs/zh/cli-client/stake/parameters.md | 23 +++++----------- docs/zh/cli-client/stake/pool.md | 23 +++++----------- docs/zh/cli-client/stake/redelegate.md | 2 +- docs/zh/cli-client/stake/redelegation.md | 20 ++++++-------- .../zh/cli-client/stake/redelegations-from.md | 27 +++++++------------ docs/zh/cli-client/stake/redelegations.md | 27 +++++++------------ docs/zh/cli-client/stake/signing-info.md | 25 ++++++----------- .../cli-client/stake/unbonding-delegation.md | 21 ++++++--------- .../stake/unbonding-delegations-from.md | 27 +++++++------------ .../cli-client/stake/unbonding-delegations.md | 27 +++++++------------ docs/zh/cli-client/stake/unjail.md | 4 +-- docs/zh/cli-client/stake/validator.md | 27 +++++++------------ docs/zh/cli-client/stake/validators.md | 23 +++++----------- docs/zh/features/distribution.md | 2 +- 49 files changed, 243 insertions(+), 490 deletions(-) diff --git a/docs/cli-client/distribution/README.md b/docs/cli-client/distribution/README.md index 9aec53571..768e90fcb 100644 --- a/docs/cli-client/distribution/README.md +++ b/docs/cli-client/distribution/README.md @@ -6,13 +6,13 @@ This document describes how to use the the command line interfaces of distributi ## Usage -```shell +``` iriscli distribution [subcommand] [flags] ``` Print all supported subcommands and flags: -```shell +``` iriscli distribution --help ``` diff --git a/docs/cli-client/distribution/delegator-distr-info.md b/docs/cli-client/distribution/delegator-distr-info.md index cb4c501b1..223a6cdbf 100644 --- a/docs/cli-client/distribution/delegator-distr-info.md +++ b/docs/cli-client/distribution/delegator-distr-info.md @@ -7,7 +7,7 @@ Query a delegator distribution information ## Usage ``` -iriscli distribution delegator-distr-info [flags] +iriscli distribution delegator-distr-info [delegator address] [flags] ``` Print help messages: @@ -15,14 +15,10 @@ Print help messages: iriscli distribution delegator-distr-info --help ``` -## Unique Flags - -There is no unique flag. But it requires a argument: delegator address - ## Examples ``` -iriscli distribution delegator-distr-info +iriscli distribution delegator-distr-info [delegator address] ``` Example response: ```json diff --git a/docs/cli-client/distribution/set-withdraw-address.md b/docs/cli-client/distribution/set-withdraw-address.md index 6aa1140f2..6ed528b0b 100644 --- a/docs/cli-client/distribution/set-withdraw-address.md +++ b/docs/cli-client/distribution/set-withdraw-address.md @@ -7,7 +7,7 @@ Set withdraw address for delegator ## Usage ``` -iriscli distribution set-withdraw-addr [withdraw-addr] [flags] +iriscli distribution set-withdraw-addr [withdraw-address] [flags] ``` Print help messages: @@ -15,13 +15,9 @@ Print help messages: iriscli distribution set-withdraw-addr --help ``` -## Unique Flags - -There is no unique flag. But it requires an argument: new withdraw address - ## Examples ``` -iriscli distribution set-withdraw-addr --from --fee=0.004iris --chain-id= +iriscli distribution set-withdraw-addr [withdraw address] --from --fee=0.004iris --chain-id= ``` diff --git a/docs/cli-client/distribution/validator-distr-info.md b/docs/cli-client/distribution/validator-distr-info.md index 840b6d776..3bf7cd2db 100644 --- a/docs/cli-client/distribution/validator-distr-info.md +++ b/docs/cli-client/distribution/validator-distr-info.md @@ -7,7 +7,7 @@ Query a validator distribution information ## Usage ``` -iriscli distribution validator-distr-info [flags] +iriscli distribution validator-distr-info [validator address] [flags] ``` Print help messages: @@ -15,15 +15,10 @@ Print help messages: iriscli distribution validator-distr-info --help ``` -## Unique Flags - -There is no unique flag. But it requires an argument: validator address - - ## Examples ``` -iriscli distribution validator-distr-info +iriscli distribution validator-distr-info [validator address] ``` Example response: ```json diff --git a/docs/cli-client/distribution/withdraw-address.md b/docs/cli-client/distribution/withdraw-address.md index f3ab8030c..e46a1314e 100644 --- a/docs/cli-client/distribution/withdraw-address.md +++ b/docs/cli-client/distribution/withdraw-address.md @@ -5,7 +5,6 @@ Query the withdraw address of a delegator ## Usage - ``` iriscli distribution withdraw-address [delegator address] [flags] ``` @@ -16,15 +15,10 @@ Print help messages: iriscli distribution withdraw-address --help ``` -## Unique Flags - -There is no unique option. But it requires a argument: delegator address - - ## Examples ``` -iriscli distribution withdraw-address +iriscli distribution withdraw-address [delegator address] ``` Example response: ```text diff --git a/docs/cli-client/distribution/withdraw-rewards.md b/docs/cli-client/distribution/withdraw-rewards.md index 3b949047f..09da2a1e7 100644 --- a/docs/cli-client/distribution/withdraw-rewards.md +++ b/docs/cli-client/distribution/withdraw-rewards.md @@ -12,7 +12,7 @@ iriscli distribution withdraw-rewards [flags] Print help messages: -```shell +``` iriscli distribution withdraw-rewards --help ``` diff --git a/docs/cli-client/stake/README.md b/docs/cli-client/stake/README.md index 1d0ada080..883278ae2 100644 --- a/docs/cli-client/stake/README.md +++ b/docs/cli-client/stake/README.md @@ -6,12 +6,12 @@ Stake module provides a set of subcommands to query staking state and send staki ## Usage -```shell +``` iriscli stake [subcommand] [flags] ``` Print all supported subcommands and flags: -```shell +``` iriscli stake --help ``` diff --git a/docs/cli-client/stake/create-validator.md b/docs/cli-client/stake/create-validator.md index 22f6b9053..bf9b36209 100644 --- a/docs/cli-client/stake/create-validator.md +++ b/docs/cli-client/stake/create-validator.md @@ -11,7 +11,7 @@ iriscli stake create-validator [flags] ``` Print help messages: -```shell +``` iriscli stake create-validator --help ``` @@ -33,7 +33,7 @@ iriscli stake create-validator --help ## Examples -```shell +``` iriscli stake create-validator --chain-id= --from= --fee=0.004iris --pubkey= --commission-max-change-rate=0.01 --commission-max-rate=0.2 --commission-rate=0.1 --amount=100iris --moniker= ``` diff --git a/docs/cli-client/stake/delegate.md b/docs/cli-client/stake/delegate.md index c10e56f78..944692c31 100644 --- a/docs/cli-client/stake/delegate.md +++ b/docs/cli-client/stake/delegate.md @@ -11,7 +11,7 @@ iriscli stake delegate [flags] ``` Print help messages: -```shell +``` iriscli stake delegate --help ``` @@ -24,6 +24,6 @@ iriscli stake delegate --help ## Examples -```shell +``` iriscli stake delegate --chain-id= --from= --fee=0.004iris --amount=100iris --address-validator= ``` diff --git a/docs/cli-client/stake/delegation.md b/docs/cli-client/stake/delegation.md index 43d730d07..a15276594 100644 --- a/docs/cli-client/stake/delegation.md +++ b/docs/cli-client/stake/delegation.md @@ -9,26 +9,22 @@ Query a delegation based on address and validator address ``` iriscli stake delegation [flags] ``` +Print help messages: +``` +iriscli stake delegation --help +``` -## Flags +## Unique Flags | Name, shorthand | Default | Description | Required | | --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | | --address-delegator | | [string] Bech address of the delegator | Yes | | --address-validator | | [string] Bech address of the validator | Yes | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for delegation | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query a validator - -```shell +Query a validator +``` iriscli stake delegation --address-validator=ValidatorAddress --address-delegator=DelegatorAddress ``` diff --git a/docs/cli-client/stake/delegations.md b/docs/cli-client/stake/delegations.md index 6fa58df30..d59b1215f 100644 --- a/docs/cli-client/stake/delegations.md +++ b/docs/cli-client/stake/delegations.md @@ -7,27 +7,18 @@ Query all delegations made from one delegator ## Usage ``` -iriscli stake delegations [delegator-addr] [flags] +iriscli stake delegations [delegator-address] [flags] +``` +Print help messages: +``` +iriscli stake delegations --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for delegations | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query all delegations made from one delegator - -```shell -iriscli stake delegations DelegatorAddress +Query all delegations made from one delegator +``` +iriscli stake delegations [delegator-address] ``` After that, you will get all detailed info of delegations from the specified delegator address. diff --git a/docs/cli-client/stake/edit-validator.md b/docs/cli-client/stake/edit-validator.md index 3b7c1812e..0494db6ef 100644 --- a/docs/cli-client/stake/edit-validator.md +++ b/docs/cli-client/stake/edit-validator.md @@ -10,7 +10,7 @@ Edit existing validator, such as commission rate, name and other description mes iriscli stake edit-validator [flags] ``` Print help messages: -```shell +``` iriscli stake edit-validator --help ``` @@ -27,6 +27,6 @@ iriscli stake edit-validator --help ## Examples -```shell +``` iriscli stake edit-validator --from= --chain-id= --fee=0.004iris --commission-rate=0.15 ``` diff --git a/docs/cli-client/stake/parameters.md b/docs/cli-client/stake/parameters.md index 8effa2e49..93a51c46a 100644 --- a/docs/cli-client/stake/parameters.md +++ b/docs/cli-client/stake/parameters.md @@ -9,24 +9,15 @@ Query the current staking parameters information ``` iriscli stake parameters [flags] ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for parameters | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +``` +iriscli stake parameters --help +``` ## Examples -### Query the current staking parameters information - -```shell +Query the current staking parameters information +``` iriscli stake parameters ``` diff --git a/docs/cli-client/stake/pool.md b/docs/cli-client/stake/pool.md index ed06d79a0..6f89128ad 100644 --- a/docs/cli-client/stake/pool.md +++ b/docs/cli-client/stake/pool.md @@ -9,24 +9,15 @@ Query the current staking pool values ``` iriscli stake pool [flags] ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for pool | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +``` +iriscli stake pool --help +``` ## Examples -### Query the current staking pool values - -```shell +Query the current staking pool values +``` iriscli stake pool ``` diff --git a/docs/cli-client/stake/redelegate.md b/docs/cli-client/stake/redelegate.md index c594e79c7..a1c756f08 100644 --- a/docs/cli-client/stake/redelegate.md +++ b/docs/cli-client/stake/redelegate.md @@ -10,9 +10,9 @@ Transfer delegation from one validator to another one. iriscli stake redelegate [flags] ``` -Print all help messages: +Print help messages: -```shell +``` iriscli stake redelegate --help ``` @@ -29,6 +29,6 @@ Users must specify the redeleagtion token amount. There two options can do this: ## Examples -```shell +``` iriscli stake redelegate --chain-id= --from= --fee=0.004iris --address-validator-source= --address-validator-dest= --shares-percent=0.1 ``` diff --git a/docs/cli-client/stake/redelegation.md b/docs/cli-client/stake/redelegation.md index 0a20c45b4..dc2c59ee6 100644 --- a/docs/cli-client/stake/redelegation.md +++ b/docs/cli-client/stake/redelegation.md @@ -9,27 +9,23 @@ Query a redelegation record based on delegator and a source and destination vali ``` iriscli stake redelegation [flags] ``` +Print help messages: +``` +iriscli stake redelegation --help +``` -## Flags +## Unique Flags | Name, shorthand | Default | Description | Required | | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --address-delegator | | [string] Bech address of the delegator | Yes | | --address-validator-dest | | [string] Bech address of the destination validator | Yes | | --address-validator-source | | [string] Bech address of the source validator | Yes | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for redelegation | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query a redelegation record - -```shell +Query a redelegation record +``` iriscli stake redelegation --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --address-delegator=DelegatorAddress ``` diff --git a/docs/cli-client/stake/redelegations-from.md b/docs/cli-client/stake/redelegations-from.md index 5fcf5b8ab..bacdf391e 100644 --- a/docs/cli-client/stake/redelegations-from.md +++ b/docs/cli-client/stake/redelegations-from.md @@ -7,27 +7,18 @@ Query all outgoing redelegatations from a validator ## Usage ``` -iriscli stake redelegations-from [operator-addr] [flags] +iriscli stake redelegations-from [validator-address] [flags] +``` +Print help messages: +``` +iriscli stake redelegations-from --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for redelegations-from | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query all outgoing redelegatations - -```shell -iriscli stake redelegations-from ValidatorAddress +Query all outgoing redelegatations +``` +iriscli stake redelegations-from [validator-address] ``` After that, you will get all outgoing redelegatations' from specified validator diff --git a/docs/cli-client/stake/redelegations.md b/docs/cli-client/stake/redelegations.md index e5945b41c..5ef565bb8 100644 --- a/docs/cli-client/stake/redelegations.md +++ b/docs/cli-client/stake/redelegations.md @@ -7,27 +7,18 @@ Query all redelegations records for one delegator ## Usage ``` -iriscli stake redelegations [delegator-addr] [flags] +iriscli stake redelegations [delegator-address] [flags] +``` +Print help messages: +``` +iriscli stake redelegations --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for redelegations | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query all redelegations records - -```shell -iriscli stake redelegations DelegatorAddress +Query all redelegations records +``` +iriscli stake redelegations [delegator-address] ``` After that, you will get all redelegations records' info for specified delegator diff --git a/docs/cli-client/stake/signing-info.md b/docs/cli-client/stake/signing-info.md index c9bce82d6..6747039d9 100644 --- a/docs/cli-client/stake/signing-info.md +++ b/docs/cli-client/stake/signing-info.md @@ -9,25 +9,17 @@ Query a validator's signing information ``` iriscli stake signing-info [validator-pubkey] [flags] ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for signing-info | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +``` +iriscli stake signing-info --help +``` ## Examples ### Query specified validator's signing information -```shell -iriscli stake signing-info ValidatorPublicKey +``` +iriscli stake signing-info [validator-pubkey] ``` After that, you will get specified validator's signing information. diff --git a/docs/cli-client/stake/unbond.md b/docs/cli-client/stake/unbond.md index 244973a94..a1f307de7 100644 --- a/docs/cli-client/stake/unbond.md +++ b/docs/cli-client/stake/unbond.md @@ -10,9 +10,8 @@ Unbond tokens from a validator iriscli stake unbond [flags] ``` -Print all help messages: - -```shell +Print help messages: +``` iriscli stake unbond --help ``` @@ -28,6 +27,6 @@ Users must specify the unbond amount. There two options can do this: `--shares-a ## Examples -```shell +``` iriscli stake unbond --address-validator= --shares-percent=0.1 --from= --chain-id= --fee=0.004iris ``` diff --git a/docs/cli-client/stake/unbonding-delegation.md b/docs/cli-client/stake/unbonding-delegation.md index a30824507..c5975b6f1 100644 --- a/docs/cli-client/stake/unbonding-delegation.md +++ b/docs/cli-client/stake/unbonding-delegation.md @@ -9,27 +9,23 @@ Query an unbonding-delegation record based on delegator and validator address ``` iriscli stake unbonding-delegation [flags] ``` +Print help messages: +``` +iriscli stake unbonding-delegation --help +``` -## Flags +## Unique Flags | Name, shorthand | Default | Description | Required | | ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --address-delegator | | [string] Bech address of the delegator | Yes | | --address-validator | | [string] Bech address of the validator | Yes | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for unbonding-delegation | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query an unbonding-delegation - -```shell +Query an unbonding-delegation +``` iriscli stake unbonding-delegation --address-delegator=DelegatorAddress --address-validator=ValidatorAddress ``` diff --git a/docs/cli-client/stake/unbonding-delegations-from.md b/docs/cli-client/stake/unbonding-delegations-from.md index 5723deb24..ebac8617a 100644 --- a/docs/cli-client/stake/unbonding-delegations-from.md +++ b/docs/cli-client/stake/unbonding-delegations-from.md @@ -7,27 +7,18 @@ Query all unbonding delegatations from a validator ## Usage ``` -iriscli stake unbonding-delegations-from [operator-addr] [flags] +iriscli stake unbonding-delegations-from [validator-address] [flags] +``` +Print help messages: +``` +iriscli stake unbonding-delegations-from --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for unbonding-delegations-from | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query all unbonding delegatations from a validator - -```shell -iriscli stake unbonding-delegations ValidatorAddress +Query all unbonding delegatations from a validator +``` +iriscli stake unbonding-delegations [validator-address] ``` After that, you will get unbonding delegation's detailed info from specified validator. diff --git a/docs/cli-client/stake/unbonding-delegations.md b/docs/cli-client/stake/unbonding-delegations.md index 9dad2d577..6280ebdf3 100644 --- a/docs/cli-client/stake/unbonding-delegations.md +++ b/docs/cli-client/stake/unbonding-delegations.md @@ -7,27 +7,18 @@ Query all unbonding-delegations records for one delegator ## Usage ``` -iriscli stake unbonding-delegations [delegator-addr] [flags] +iriscli stake unbonding-delegations [delegator-address] [flags] +``` +Print help messages: +``` +iriscli stake unbonding-delegations --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for unbonding-delegations | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query an unbonding-delegation - -```shell -iriscli stake unbonding-delegations DelegatorAddress +Query an unbonding-delegation +``` +iriscli stake unbonding-delegations [delegator-address] ``` After that, you will get unbonding delegation's detailed info from specified delegator. diff --git a/docs/cli-client/stake/unjail.md b/docs/cli-client/stake/unjail.md index 7a29eaa57..ccbb2c881 100644 --- a/docs/cli-client/stake/unjail.md +++ b/docs/cli-client/stake/unjail.md @@ -10,20 +10,15 @@ Unjail validator which may be jailed previously for downtime iriscli stake unjail [flags] ``` -Print all help messages: - -```shell +Print help messages: +``` iriscli stake unjail --help ``` -## Unique Flags - -There is no unique flags. - ## Examples ### Unjail validator previously jailed for downtime -```shell +``` iriscli stake unjail --from= --fee=0.004iris --chain-id= ``` diff --git a/docs/cli-client/stake/validator.md b/docs/cli-client/stake/validator.md index 102c3250f..5ebc3df79 100644 --- a/docs/cli-client/stake/validator.md +++ b/docs/cli-client/stake/validator.md @@ -7,27 +7,18 @@ Query a validator ## Usage ``` -iriscli stake validator [owner-addr] [flags] +iriscli stake validator [validator-address] [flags] +``` +Print help messages: +``` +iriscli stake validator --help ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples -### Query a validator - -```shell -iriscli stake validator YourValidatorOwnerAddress +Query a validator +``` +iriscli stake validator [validator-address] ``` After that, you will get the specified validator's info. diff --git a/docs/cli-client/stake/validators.md b/docs/cli-client/stake/validators.md index e9d2bee3c..7187e7e74 100644 --- a/docs/cli-client/stake/validators.md +++ b/docs/cli-client/stake/validators.md @@ -9,24 +9,15 @@ Query for all validators ``` iriscli stake validators [flags] ``` - -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for validator | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | +Print help messages: +``` +iriscli stake validators --help +``` ## Examples -### Query a validator - -```shell +Query a validator +``` iriscli stake validators ``` diff --git a/docs/zh/cli-client/distribution/README.md b/docs/zh/cli-client/distribution/README.md index 1b9fbc879..d158ef22d 100644 --- a/docs/zh/cli-client/distribution/README.md +++ b/docs/zh/cli-client/distribution/README.md @@ -6,13 +6,13 @@ ## 用法 -```shell +``` iriscli distribution [subcommand] ``` 打印所以子命令和参数 -```shell +``` iriscli distribution --help ``` diff --git a/docs/zh/cli-client/distribution/delegation-distr-info.md b/docs/zh/cli-client/distribution/delegation-distr-info.md index 1e7f3801b..be15ef4d1 100644 --- a/docs/zh/cli-client/distribution/delegation-distr-info.md +++ b/docs/zh/cli-client/distribution/delegation-distr-info.md @@ -12,7 +12,7 @@ iriscli distribution delegation-distr-info [flags] 打印帮助信息 -```shell +``` iriscli distribution delegation-distr-info --help ``` @@ -25,7 +25,7 @@ iriscli distribution delegation-distr-info --help ## 示例 -```shell +``` iriscli distribution delegation-distr-info --address-delegator= --address-validator= ``` 执行结果示例 diff --git a/docs/zh/cli-client/distribution/delegator-distr-info.md b/docs/zh/cli-client/distribution/delegator-distr-info.md index 45d2f9255..d82c9eadb 100644 --- a/docs/zh/cli-client/distribution/delegator-distr-info.md +++ b/docs/zh/cli-client/distribution/delegator-distr-info.md @@ -7,23 +7,19 @@ ## 用法 ``` -iriscli distribution delegator-distr-info [flags] +iriscli distribution delegator-distr-info [delegator address] [flags] ``` 打印帮助信息 -```shell +``` iriscli distribution delegator-distr-info --help ``` -## 特有的flags - -这个命令没有特有的flag，它有一个输入参数：delegator的地址 - ## 示例 -```shell -iriscli distribution delegation-distr-info +``` +iriscli distribution delegation-distr-info [delegator address] ``` 执行结果示例 ```json diff --git a/docs/zh/cli-client/distribution/set-withdraw-address.md b/docs/zh/cli-client/distribution/set-withdraw-address.md index 17fe2204c..0848d5d68 100644 --- a/docs/zh/cli-client/distribution/set-withdraw-address.md +++ b/docs/zh/cli-client/distribution/set-withdraw-address.md @@ -7,7 +7,7 @@ ## 用法 ``` -iriscli distribution set-withdraw-addr [withdraw-addr] [flags] +iriscli distribution set-withdraw-addr [withdraw-address] [flags] ``` 打印帮助信息: @@ -16,13 +16,8 @@ iriscli distribution set-withdraw-addr [withdraw-addr] [flags] iriscli distribution set-withdraw-addr --help ``` -## 特有的flags - -这个命令没有特有的flag，它有一个输入参数：收款地址 - - ## 示例 ``` -iriscli distribution set-withdraw-addr
--from --fee=0.004iris --chain-id= +iriscli distribution set-withdraw-addr [withdraw-address] --from --fee=0.004iris --chain-id= ``` diff --git a/docs/zh/cli-client/distribution/validator-distr-info.md b/docs/zh/cli-client/distribution/validator-distr-info.md index 21205b0db..f36c9703b 100644 --- a/docs/zh/cli-client/distribution/validator-distr-info.md +++ b/docs/zh/cli-client/distribution/validator-distr-info.md @@ -16,11 +16,6 @@ iriscli distribution validator-distr-info [flags] iriscli distribution validator-distr-info --help ``` -## 特有的flags - -这个命令没有特有的flag，它有一个输入参数：验证人地址 - - ## 示例 ``` diff --git a/docs/zh/cli-client/distribution/withdraw-address.md b/docs/zh/cli-client/distribution/withdraw-address.md index c7e6607b0..53abbd44a 100644 --- a/docs/zh/cli-client/distribution/withdraw-address.md +++ b/docs/zh/cli-client/distribution/withdraw-address.md @@ -7,7 +7,7 @@ ## 用法 ``` -iriscli distribution withdraw-address [delegator address] [flags] +iriscli distribution withdraw-address [delegator-address] [flags] ``` 打印帮助信息: @@ -16,15 +16,10 @@ iriscli distribution withdraw-address [delegator address] [flags] iriscli distribution withdraw-address --help ``` -## 特有的flags - -这个命令没有特有的flag，它有一个输入参数：委托人地址 - - ## 示例 ``` -iriscli distribution withdraw-address +iriscli distribution withdraw-address [delegator-address] ``` 执行结果示例 ``` diff --git a/docs/zh/cli-client/stake/delegation.md b/docs/zh/cli-client/stake/delegation.md index 85cfc45a2..e4a6d1d07 100644 --- a/docs/zh/cli-client/stake/delegation.md +++ b/docs/zh/cli-client/stake/delegation.md @@ -9,26 +9,22 @@ ``` iriscli stake delegation [flags] ``` - -## 标志 +打印帮助信息 +``` +iriscli stake delegation --help +``` +## 特有的flags | 名称, 速记 | 默认值 | 描述 | 必需 | | --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | | --address-delegator | | [string] 委托者bech地址 | Yes | | --address-validator | | [string] 验证者bech地址 | Yes | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | delegation命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | -## 例子 +## 示例 ### 查询验证者 -```shell +``` iriscli stake delegation --address-validator=ValidatorAddress --address-delegator=DelegatorAddress ``` diff --git a/docs/zh/cli-client/stake/delegations.md b/docs/zh/cli-client/stake/delegations.md index e88807e63..f4cbbeaac 100644 --- a/docs/zh/cli-client/stake/delegations.md +++ b/docs/zh/cli-client/stake/delegations.md @@ -7,27 +7,19 @@ ## 用法 ``` -iriscli stake delegations [delegator-addr] [flags] +iriscli stake delegations [delegator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake delegations --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | delegations命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## Examples +## 示例 ### 查询某个委托者发起的所有委托记录 -```shell -iriscli stake delegations DelegatorAddress +``` +iriscli stake delegations [delegator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/edit-validator.md b/docs/zh/cli-client/stake/edit-validator.md index 76c171623..ec70763e4 100644 --- a/docs/zh/cli-client/stake/edit-validator.md +++ b/docs/zh/cli-client/stake/edit-validator.md @@ -10,7 +10,7 @@ iriscli stake edit-validator [flags] ``` 打印帮助信息 -```shell +``` iriscli stake edit-validator --help ``` @@ -27,6 +27,6 @@ iriscli stake edit-validator --help ## 示例 -```shell +``` iriscli stake edit-validator --from= --chain-id= --fee=0.004iris --commission-rate=0.15 ``` diff --git a/docs/zh/cli-client/stake/parameters.md b/docs/zh/cli-client/stake/parameters.md index e417a5fa2..027913019 100644 --- a/docs/zh/cli-client/stake/parameters.md +++ b/docs/zh/cli-client/stake/parameters.md @@ -9,24 +9,15 @@ ``` iriscli stake parameters [flags] ``` +打印帮助信息 +``` +iriscli stake parameters --help +``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | parameters命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询最新的权益参数信息 +## 示例 -```shell +查询最新的权益参数信息 +``` iriscli stake parameters ``` diff --git a/docs/zh/cli-client/stake/pool.md b/docs/zh/cli-client/stake/pool.md index cfc034839..5788748b7 100644 --- a/docs/zh/cli-client/stake/pool.md +++ b/docs/zh/cli-client/stake/pool.md @@ -9,24 +9,15 @@ ``` iriscli stake pool [flags] ``` +打印帮助信息 +``` +iriscli stake pool --help +``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | pool命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询最新的权益池 +## 示例 -```shell +查询最新的权益池 +``` iriscli stake pool ``` diff --git a/docs/zh/cli-client/stake/redelegate.md b/docs/zh/cli-client/stake/redelegate.md index b1e236181..385c17ab8 100644 --- a/docs/zh/cli-client/stake/redelegate.md +++ b/docs/zh/cli-client/stake/redelegate.md @@ -15,7 +15,7 @@ iriscli stake redelegate [flags] iriscli stake redelegate --help ``` -## 特有flags +## 特有的flags | 名称 | 类型 | 是否必填 | 默认值 | 功能描述 | | -------------------------- | ----- | -------- | -------- | ------------------------------------------------------------------- | diff --git a/docs/zh/cli-client/stake/redelegation.md b/docs/zh/cli-client/stake/redelegation.md index 4d5c07815..b78169e5f 100644 --- a/docs/zh/cli-client/stake/redelegation.md +++ b/docs/zh/cli-client/stake/redelegation.md @@ -9,27 +9,23 @@ ``` iriscli stake redelegation [flags] ``` +打印帮助信息 +``` +iriscli stake redelegation --help +``` -## 标志 +## 特有的flags | 名称, 速记 | 默认值 | 描述 | 必需 | | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --address-delegator | | [string] 委托者bech地址 | Yes | | --address-validator-dest | | [string] 目标验证者bech地址 | Yes | | --address-validator-source | | [string] 源验证者bech地址 | Yes | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | redelegation命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | -## 例子 +## 示例 -### 查询重新委托记录 - -```shell +查询重新委托记录 +``` iriscli stake redelegation --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --address-delegator=DelegatorAddress ``` diff --git a/docs/zh/cli-client/stake/redelegations-from.md b/docs/zh/cli-client/stake/redelegations-from.md index 6d6b9ff7f..ee9f286e5 100644 --- a/docs/zh/cli-client/stake/redelegations-from.md +++ b/docs/zh/cli-client/stake/redelegations-from.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake redelegations-from [operator-addr] [flags] +iriscli stake redelegations-from [validator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake redelegations-from --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | redelegations-from命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 基于某一验证者的所有重新委托查询 +## 示例 -```shell -iriscli stake redelegations-from ValidatorAddress +基于某一验证者的所有重新委托查询 +``` +iriscli stake redelegations-from [validator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/redelegations.md b/docs/zh/cli-client/stake/redelegations.md index 022597494..e7b74cea7 100644 --- a/docs/zh/cli-client/stake/redelegations.md +++ b/docs/zh/cli-client/stake/redelegations.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake redelegations [delegator-addr] [flags] +iriscli stake redelegations [delegator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake redelegations --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | redelegations命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 基于委托者地址的所有重新委托记录查询 +## 示例 -```shell -iriscli stake redelegations DelegatorAddress +基于委托者地址的所有重新委托记录查询 +``` +iriscli stake redelegations [delegator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/signing-info.md b/docs/zh/cli-client/stake/signing-info.md index 0bd07259f..67590838f 100644 --- a/docs/zh/cli-client/stake/signing-info.md +++ b/docs/zh/cli-client/stake/signing-info.md @@ -9,25 +9,16 @@ ``` iriscli stake signing-info [validator-pubkey] [flags] ``` +打印帮助信息 +``` +iriscli stake signing-info --help +``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | signing-info命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询验证者签名信息 +## 示例 -```shell -iriscli stake signing-info ValidatorPublicKey +查询验证者签名信息 +``` +iriscli stake signing-info [validator-pubkey] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/unbonding-delegation.md b/docs/zh/cli-client/stake/unbonding-delegation.md index fcd74b018..b46190aa9 100644 --- a/docs/zh/cli-client/stake/unbonding-delegation.md +++ b/docs/zh/cli-client/stake/unbonding-delegation.md @@ -9,27 +9,22 @@ ``` iriscli stake unbonding-delegation [flags] ``` +打印帮助信息 +``` +iriscli stake unbonding-delegation --help +``` -## 标志 +## 特有的flags | 名称, 速记 | 默认值 | 描述 | 必需 | | ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | | --address-delegator | | [string] 委托者bech地址 | Yes | | --address-validator | | [string] 验证者bech地址 | Yes | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | unbonding-delegation命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 +## 示例 -### 查询unbonding-delegation - -```shell +查询unbonding-delegation +``` iriscli stake unbonding-delegation --address-delegator=DelegatorAddress --address-validator=ValidatorAddress ``` diff --git a/docs/zh/cli-client/stake/unbonding-delegations-from.md b/docs/zh/cli-client/stake/unbonding-delegations-from.md index 2e2ba849f..072f384d5 100644 --- a/docs/zh/cli-client/stake/unbonding-delegations-from.md +++ b/docs/zh/cli-client/stake/unbonding-delegations-from.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake unbonding-delegations-from [operator-addr] [flags] +iriscli stake unbonding-delegations-from [validator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake unbonding-delegations-from --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | unbonding-delegations-from命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 基于验证者地址的所有unbonding-delegation记录查询 +## 示例 -```shell -iriscli stake unbonding-delegations ValidatorAddress +基于验证者地址的所有unbonding-delegation记录查询 +``` +iriscli stake unbonding-delegations [validator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/unbonding-delegations.md b/docs/zh/cli-client/stake/unbonding-delegations.md index afc64451f..6ba055aeb 100644 --- a/docs/zh/cli-client/stake/unbonding-delegations.md +++ b/docs/zh/cli-client/stake/unbonding-delegations.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake unbonding-delegations [delegator-addr] [flags] +iriscli stake unbonding-delegations [delegator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake unbonding-delegations --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| ------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | unbonding-delegations命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询unbonding-delegation +## 示例 -```shell -iriscli stake unbonding-delegations DelegatorAddress +查询unbonding-delegation +``` +iriscli stake unbonding-delegations [delegator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/unjail.md b/docs/zh/cli-client/stake/unjail.md index c9cd36a8d..abbad5ca5 100644 --- a/docs/zh/cli-client/stake/unjail.md +++ b/docs/zh/cli-client/stake/unjail.md @@ -12,7 +12,7 @@ iriscli stake unjail [flags] 打印帮助信息 -```shell +``` iriscli stake unjail --help ``` @@ -22,6 +22,6 @@ iriscli stake unjail --help ## 示例 -```shell +``` iriscli stake unjail --from= --fee=0.004iris --chain-id= ``` diff --git a/docs/zh/cli-client/stake/validator.md b/docs/zh/cli-client/stake/validator.md index 1c85223ec..c232ff93b 100644 --- a/docs/zh/cli-client/stake/validator.md +++ b/docs/zh/cli-client/stake/validator.md @@ -7,27 +7,18 @@ ## 用法 ``` -iriscli stake validator [owner-addr] [flags] +iriscli stake validator [validator-address] [flags] +``` +打印帮助信息 +``` +iriscli stake validator --help ``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | validator命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## 例子 - -### 查询验证者 +## 示例 -```shell -iriscli stake validator YourValidatorOwnerAddress +查询验证者 +``` +iriscli stake validator [validator-address] ``` 运行成功以后，返回的结果如下： diff --git a/docs/zh/cli-client/stake/validators.md b/docs/zh/cli-client/stake/validators.md index 47b53758e..28dc0c17f 100644 --- a/docs/zh/cli-client/stake/validators.md +++ b/docs/zh/cli-client/stake/validators.md @@ -9,24 +9,15 @@ ``` iriscli stake validators [flags] ``` +打印帮助信息 +``` +iriscli stake validators --help +``` -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 必需 | -| --------------- | -------------------------- | ------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Tendermint节点的链ID | | -| --height | 最新的可证明区块高度 | 查询的区块高度 | | -| --help, -h | | validators命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] Tendermint远程过程调用的接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | - -## E例子 - -### 查询验证者 +## 示例 -```shell +查询验证者 +``` iriscli stake validators ``` diff --git a/docs/zh/features/distribution.md b/docs/zh/features/distribution.md index d516cbf3a..398edd9e6 100644 --- a/docs/zh/features/distribution.md +++ b/docs/zh/features/distribution.md @@ -1,4 +1,4 @@ -# 收益分配模块的用户手册 +# distribution模块的用户手册 ## 简介 From 5ed67c9889ae12ae75eeef76c24a26ea3fdc86d9 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Sat, 17 Nov 2018 21:06:59 +0800 Subject: [PATCH 085/100] Finish the features/gov ZH --- docs/zh/features/governance.md | 100 ++++++++++++++++----------------- 1 file changed, 49 insertions(+), 51 deletions(-) diff --git a/docs/zh/features/governance.md b/docs/zh/features/governance.md index a1ecd1be5..9b9007d7e 100644 --- a/docs/zh/features/governance.md +++ b/docs/zh/features/governance.md @@ -1,64 +1,63 @@ # Gov User Guide -## Basic Function Description +## 基本功能描述 -1. On-chain governance proposals on text -2. On-chain governance proposals on parameter change -3. On-chain governance proposals on software upgrade +1. 文本提议的链上治理 +2. 参数修改提议的链上治理 +3. 软件升级提议的链上治理 -## Interactive process +## 交互流程 -### governance process +### 治理流程 -1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value `min_deposit`, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches `min_deposit`, enter voting period. However, if the block-time exceeds `max_deposit_period` in the deposit period, the proposal will be closed. -2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. -3. Our tally have a limit on participation, Other details about voting for proposals: -[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) +1. 任何用户可以发起提议，并抵押一部分token，如果超过`min_deposit`,提议进入投票，否则留在抵押期。其他人可以对在抵押期的提议进行抵押token，如果提议的抵押token总和超过`min_deposit`,则进入投票期。但若提议在抵押期停留的出块数目超过`max_deposit_period`，则提议被关闭。 +2. 进入投票期的提议，只有验证人和委托人可以进行投票。如果委托人没投票，则他继承他委托的验证人的投票选项。如果委托人投票了，则覆盖他委托的验证人的投票选项。当提议到达`voting_perid`,统计投票结果。 +3. 我们统计结果有参与度的限制，其他逻辑细节见[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) -## Usage Scenario +## 使用场景 -### Usage scenario of parameter change +### 参数修改的使用场景 -Scenario 1：Change the parameters through the command lines +场景一：通过命令行带入参数修改信息进行参数修改 ``` -# Query parameters can be changed by the modules'name in gov +# 根据gov模块名查询的可修改的参数 iriscli gov query-params --module=gov --trust-node -# Results +# 结果 [ "Gov/govDepositProcedure", "Gov/govTallyingProcedure", "Gov/govVotingProcedure" ] -# Query parameters can be modified by "key” +# 根据Key查询可修改参数的内容 iriscli gov query-params --key=Gov/govDepositProcedure --trust-node -# Results +# 结果 {"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":""} -# Send proposals, return changed parameters +# 发送提议，返回参数修改的内容 iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"20000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":"update"}}' --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 -# Deposit for a proposal +# 对提议进行抵押 iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 -# Vote for a proposal -echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 +# 对提议投票 +iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 -# Query the state of a proposal +# 查询提议情况 iriscli gov query-proposal --proposal-id=1 --trust-node ``` -Scenario 2: Change the parameters by the files +场景二，通过文件修改参数 ``` -# Export profiles +# 导出配置文件 iriscli gov pull-params --path=iris --trust-node -# Query profiles' info +# 查询配置文件信息 cat iris/config/params.json { "gov": { "Gov/govDepositProcedure": { @@ -80,7 +79,7 @@ cat iris/config/params.json { } } -# Modify profiles (TallyingProcedure的governance_penalty) +# 修改配置文件 (TallyingProcedure的governance_penalty) vi iris/config/params.json { "gov": { "Gov/govDepositProcedure": { @@ -102,27 +101,28 @@ vi iris/config/params.json { } } -# Change the parameters through files, return changed parameters +# 通过文件修改参数的命令，返回参数修改的内容 iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/govTallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -# Deposit for a proposal +# 对提议进行抵押 iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -# Vote for a proposal +# 对提议投票 iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -# Query the state of a proposal +# 查询提议情况 iriscli gov query-proposal --proposal-id=1 --trust-node ``` -### Proposals on software upgrade +### 软件升级提议部分 -Detail in [Upgrade](upgrade.md) +详细参考[Upgrade](upgrade.md) + +## 基本参数 -## Basic parameters ``` -# DepositProcedure（The parameters in deposit period） +# DepositProcedure（抵押阶段的参数） "Gov/govDepositProcedure": { "min_deposit": [ { @@ -134,33 +134,31 @@ Detail in [Upgrade](upgrade.md) } ``` -* Parameters can be changed -* The key of parameters:"Gov/gov/DepositProcedure" -* `min_deposit[0].denom` The minimum tokens deposited are counted by iris-atto. -* `min_deposit[0].amount` The number of minimum tokens and the default scope：1000iris,（1iris，10000iris） -* `max_deposit_period` Window period for repaying deposit, default:172800000000000ns==2Days， scope（20s，3Day） +* 可修改参数 +* 参数的key:"Gov/gov/DepositProcedure" +* `min_deposit[0].denom` 最小抵押token只能是单位是iris-atto的iris通证。 +* `min_deposit[0].amount` 最小抵押token数量,默认:10iris,范围（1iris，200iris） +* `max_deposit_period` 补交抵押token的窗口期,默认:172800000000000纳秒==2天,范围（20秒，3天） ``` -# VotingProcedure（The parameters in voting period） +# VotingProcedure（投票阶段的参数） "Gov/govVotingProcedure": { "voting_period": "10000000000" } ``` - -* Parameters can be changed -* `voting_perid` Window period for vote, default:172800000000000ns==2Days, scope（20s，3Days） +* 可修改参数 +* `voting_perid` 投票的窗口期,默认:172800000000000纳秒==2天,范围（20秒，3天） ``` -# TallyingProcedure (The parameters in Tallying period) +# TallyingProcedure (统计阶段段参数) "Gov/govTallyingProcedure": { "threshold": "0.5000000000", "veto": "0.3340000000", "participation": "0.6670000000" } -``` - -* Parameters can be changed -* `veto` default: 0.334, scope（0，1） -* `threshold` default: 0.5, scope（0，1） -* `governance_penalty` default: 0.667, scope（0，1） -* Vote rules:If the ratio of all voters' `voting_power` to the total 'voting_power' in system less than “participation”, the proposal won't be passed. If the ratio of strongly opposed `voting_power` to all voters' `voting_power` more than “veto”, the proposal won't be passed. Then if the ratio of approved `voting_power` to all voter's `voting_power` except abstentions over “threshold”, the proposal will be passed. Otherwise, N/A. +``` +* 可修改参数 +* `veto` 默认:0.334,范围（0，1） +* `threshold` 默认:0.500,范围（0，1） +* `participation` 默认:0.667,范围（0，1） +* 投票统计逻辑：如果所有投票者的`voting_power`占系统总的`voting_power`的比例没有超过participation，投票不通过。如果强烈反对的`voting_power`占所有投票者的`voting_power` 超过 veto,提议不通过。然后再看赞同的`voting_power`占排除投弃权以外的投票者的总`voting_power` 是否超过 threshold, 超过则提议通过,不超过则不通过。 From ac6106f8363af1ac9f099efaae00c3683f59fea7 Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Sat, 17 Nov 2018 22:02:38 +0800 Subject: [PATCH 086/100] Update description begin with a capital letter --- docs/cli-client/keys/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/cli-client/keys/README.md b/docs/cli-client/keys/README.md index 583787200..1d486c368 100644 --- a/docs/cli-client/keys/README.md +++ b/docs/cli-client/keys/README.md @@ -26,16 +26,16 @@ iriscli keys [command] | Name, shorthand | Default | Description | Required | | --------------- | ------- | ------------- | -------- | -| --help, -h | | help for keys | | +| --help, -h | | Help for keys | | ## Global Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------- | -------------------------------------- | -------- | | --encoding, -e | hex | [string] Binary encoding (hex|b64|btc) | | -| --home | $HOME/.iriscli | [string] directory for config and data | | +| --home | $HOME/.iriscli | [string] Directory for config and data | | | --output, -o | text | [string] Output format (text|json) | | -| --trace | | print out full stack trace on errors | | +| --trace | | Print out full stack trace on errors | | ## Extended description From d8fb16ca77641666f984800e233662d3a47cdfb5 Mon Sep 17 00:00:00 2001 From: Yelong Zhang Date: Sat, 17 Nov 2018 22:06:16 +0800 Subject: [PATCH 087/100] Update description begin with a capital letter --- docs/cli-client/keys/add.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli-client/keys/add.md b/docs/cli-client/keys/add.md index f9a4f0818..78dd319a5 100644 --- a/docs/cli-client/keys/add.md +++ b/docs/cli-client/keys/add.md @@ -16,7 +16,7 @@ iriscli keys add [flags] | --------------- | --------- | ----------------------------------------------------------------- | -------- | | --account | | [uint32] Account number for HD derivation | | | --dry-run | | Perform action, but don't add key to local keystore | | -| --help, -h | | help for add | | +| --help, -h | | Help for add | | | --index | | [uint32] Index number for HD derivation | | | --ledger | | Store a local reference to a private key on a Ledger device | | | --no-backup | | Don't print out seed phrase (if others are watching the terminal) | | From 7ea9a980fa67212040566c32ddbee410e849208b Mon Sep 17 00:00:00 2001 From: trevorfu Date: Sat, 17 Nov 2018 22:36:44 +0800 Subject: [PATCH 088/100] Fix some problems --- docs/cli-client/gov/README.md | 4 ++-- docs/zh/cli-client/gov/README.md | 28 ++++++++++++++-------------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/cli-client/gov/README.md b/docs/cli-client/gov/README.md index b516e5030..deb544f77 100644 --- a/docs/cli-client/gov/README.md +++ b/docs/cli-client/gov/README.md @@ -40,9 +40,9 @@ iriscli gov [command] | Name, shorthand | Default | Description | Required | | --------------- | -------------- | -------------------------------------- | -------- | -| --encoding, -e | hex | [string] Binary encoding (hex|b64|btc) | | +| --encoding, -e | hex | [string] Binary encoding (hex ¦ b64 ¦ btc) | | | --home | $HOME/.iriscli | [string] directory for config and data | | -| --output, -o | text | [string] Output format (text|json) | | +| --output, -o | text | [string] Output format (text ¦ json) | | | --trace | | print out full stack trace on errors | | ## Extended description diff --git a/docs/zh/cli-client/gov/README.md b/docs/zh/cli-client/gov/README.md index e21b81e0b..4f89d2701 100644 --- a/docs/zh/cli-client/gov/README.md +++ b/docs/zh/cli-client/gov/README.md @@ -17,18 +17,18 @@ iriscli gov [command] | 命令 | 描述 | | ------------------------------------- | --------------------------------------------------------------- | -| [query-proposal](query-proposal.md) | Query details of a single proposal | -| [query-proposals](query-proposals.md) | Query proposals with optional filters | -| [query-vote](query-vote.md) | Query vote | -| [query-votes](query-votes.md) | Query votes on a proposal | -| [query-deposit](query-deposit.md) | Query details of a deposit | -| [query-deposits](query-deposits.md) | Query deposits on a proposal | -| [query-tally](query-tally.md) | Get the tally of a proposal vote | -| [query-params](query-params.md) | Query parameter proposal's config | -| [pull-params](pull-params.md) | Generate param.json file | -| [submit-proposal](submit-proposal.md) | Create a new key, or import from seed | -| [deposit](deposit.md) | Deposit tokens for activing proposal | -| [vote](vote.md) | Vote for an active proposal, options: Yes/No/NoWithVeto/Abstain | +| [query-proposal](query-proposal.md) | 查询单个提议的详细信息 | +| [query-proposals](query-proposals.md) | 通过可选过滤器查询提议 | +| [query-vote](query-vote.md) | 查询投票信息 | +| [query-votes](query-votes.md) | 查询提议的投票情况 | +| [query-deposit](query-deposit.md) | 查询保证金详情 | +| [query-deposits](query-deposits.md) | 查询提议的保证金 | +| [query-tally](query-tally.md) | 查询提议投票的统计 | +| [query-params](query-params.md) | 查询参数提议的配置 | +| [pull-params](pull-params.md) | 生成param.json文件 | +| [submit-proposal](submit-proposal.md) | 创建新密钥，或者通过助记词导入恢复 | +| [deposit](deposit.md) | 充值保证金代币以激活提议 | +| [vote](vote.md) | 为有效的提议投票，选项：Yes/No/NoWithVeto/Abstain | ## 标志 @@ -40,9 +40,9 @@ iriscli gov [command] | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------- | -------------------------------------- | -------- | -| --encoding, -e | hex | [string] Binary encoding (hex|b64|btc) | | +| --encoding, -e | hex | [string] Binary encoding (hex ¦ b64 ¦ btc) | | | --home | $HOME/.iriscli | [string] directory for config and data | | -| --output, -o | text | [string] Output format (text|json) | | +| --output, -o | text | [string] Output format (text ¦ json) | | | --trace | | print out full stack trace on errors | | ## 补充描述 From 531dc3d5a9a7086ddd94d2e1d6d10b21c166f7f2 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Sat, 17 Nov 2018 23:27:21 +0800 Subject: [PATCH 089/100] Complete the cli-client readme.md --- docs/zh/cli-client/README.md | 3 ++- docs/zh/cli-client/upgrade/README.md | 8 ++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/zh/cli-client/README.md b/docs/zh/cli-client/README.md index 6f280cdca..e6889113b 100644 --- a/docs/zh/cli-client/README.md +++ b/docs/zh/cli-client/README.md @@ -2,7 +2,7 @@ ## 查询命令的flags -| Name, shorthand | type | Required | Default Value | Description | +| 名称, 速记 | 类型 |必需 |默认值 | 描述 | | --------------- | ---- | -------- | --------------------- | -------------------------------------------------------------------- | | --chain-id | string | false | "" | Tendermint节点的Chain ID | | --height | int | false | 0 | 查询某个高度的区块链数据，如果是0，这返回最新的区块链数据 | @@ -16,6 +16,7 @@ ## 发送交易命令的flags +| 名称, 速记 | 类型 |必需 |默认值 | 描述 | | Name, shorthand | type | Required | Default | Description | | -----------------| ----- | -------- | --------------------- | ------------------------------------------------------------------- | | --account-number | int | false | 0 | 发起交易的账户的编号 | diff --git a/docs/zh/cli-client/upgrade/README.md b/docs/zh/cli-client/upgrade/README.md index 2fd3a1ad5..bdde59d82 100644 --- a/docs/zh/cli-client/upgrade/README.md +++ b/docs/zh/cli-client/upgrade/README.md @@ -12,11 +12,11 @@ iriscli upgrade [command] ## 相关命令 -| Name | Description | +| 命令 | 描述 | | ------------- | ------------------------------------- | -| [submit-switch](submit-switch.md) | Submit a switch msg for a upgrade propsal| -| [query-switch](query-switch.md) | query switch detail | -| [info](info.md) | Query the information of upgrade module | +| [submit-switch](submit-switch.md) | 针对软件升级提议发送switch消息| +| [query-switch](query-switch.md) | 查询switch信息 | +| [info](info.md) | 查询软件升级模块的信息| ## 标志 From 950ad46a9493d026bfcff3ffe51fb8a8a710210c Mon Sep 17 00:00:00 2001 From: jiacheng Date: Sat, 17 Nov 2018 23:45:08 +0800 Subject: [PATCH 090/100] Fix the comment --- docs/features/basic-concepts/bech32-prefix.md | 2 +- docs/features/governance.md | 246 ++++++------------ .../features/basic-concepts/bech32-prefix.md | 4 +- docs/zh/features/governance.md | 2 +- 4 files changed, 80 insertions(+), 174 deletions(-) diff --git a/docs/features/basic-concepts/bech32-prefix.md b/docs/features/basic-concepts/bech32-prefix.md index a0fc83ebb..79dbb1fb3 100644 --- a/docs/features/basic-concepts/bech32-prefix.md +++ b/docs/features/basic-concepts/bech32-prefix.md @@ -1,6 +1,6 @@ # Bech32 on IRISnet -Bech32 is a new Bitcoin address format proposed by Pieter Wuille and Greg Maxwell. Besides Bitcoin addresses, Bech32 can encode any short binary data. In the IRIS network, keys and addresses may refer to a number of different roles in the network like accounts, validators etc. The IRIS network is designed to use the Bech32 address format to provide robust integrity checks on data. The human readable part(HRP) makes it more efficient to read and the users could see error messages. +Bech32 is a new Bitcoin address format proposed by Pieter Wuille and Greg Maxwell. Besides Bitcoin addresses, Bech32 can encode any short binary data. In the IRIS network, keys and addresses may refer to a number of different roles in the network like accounts, validators etc. The IRIS network is designed to use the Bech32 address format to provide robust integrity checks on data. The human readable part(HRP) makes it more efficient to read and the users could see error messages. More details in [bip-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) ## Human Readable Part Table diff --git a/docs/features/governance.md b/docs/features/governance.md index 7961541cc..b90348f27 100644 --- a/docs/features/governance.md +++ b/docs/features/governance.md @@ -1,4 +1,4 @@ -# Gov/Iparam User Guide +# Gov User Guide ## Basic Function Description @@ -12,19 +12,10 @@ 1. Any users can deposit some tokens to initiate a proposal. Once deposit reaches a certain value `min_deposit`, enter voting period, otherwise it will remain in the deposit period. Others can deposit the proposals on the deposit period. Once the sum of the deposit reaches `min_deposit`, enter voting period. However, if the block-time exceeds `max_deposit_period` in the deposit period, the proposal will be closed. 2. The proposals which enter voting period only can be voted by validators and delegators. The vote of a delegator who hasn't vote will be the same as his validator's vote, and the vote of a delegator who has voted will be remained. The votes wil be tallyed when reach `voting_period'. -3. More details about voting for proposals: -[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) +3. Our tally have a limit on participation, Other details about voting for proposals: +[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/v0.26.0/docs/spec/governance/overview.md) ## Usage Scenario -### Create an environment - -``` -rm -rf iris -rm -rf .iriscli -iris init gen-tx --name=x --home=iris -iris init --gen-txs --chain-id=gov-test -o --home=iris -iris start --home=iris -``` ### Usage scenario of parameter change @@ -36,25 +27,25 @@ iriscli gov query-params --module=gov --trust-node # Results [ - "Gov/gov/DepositProcedure", - "Gov/gov/TallyingProcedure", - "Gov/gov/VotingProcedure" +"Gov/govDepositProcedure", +"Gov/govTallyingProcedure", +"Gov/govVotingProcedure" ] # Query parameters can be modified by "key” -iriscli gov query-params --key=Gov/gov/DepositProcedure --trust-node +iriscli gov query-params --key=Gov/govDepositProcedure --trust-node # Results -{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":10}","op":""} +{"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":""} # Send proposals, return changed parameters -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"20000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":"update"}}' --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 # Deposit for a proposal -echo 1234567890 | iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 # Vote for a proposal -echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=200000 # Query the state of a proposal iriscli gov query-proposal --proposal-id=1 --trust-node @@ -68,193 +59,108 @@ Scenario 2: Change the parameters by the files iriscli gov pull-params --path=iris --trust-node # Query profiles' info -cat iris/config/params.json +cat iris/config/params.json { +"gov": { +"Gov/govDepositProcedure": { +"min_deposit": [ { - "gov": { - "Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" - }, - "Gov/gov/VotingProcedure": { - "voting_period": "10" - }, - "Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "1/100" - } - } +"denom": "iris-atto", +"amount": "10000000000000000000" } +], +"max_deposit_period": "172800000000000" +}, +"Gov/govVotingProcedure": { +"voting_period": "10000000000" +}, +"Gov/govTallyingProcedure": { +"threshold": "0.5000000000", +"veto": "0.3340000000", +"participation": "0.6670000000" +} +} + # Modify profiles (TallyingProcedure的governance_penalty) -vi iris/config/params.json +vi iris/config/params.json { +"gov": { +"Gov/govDepositProcedure": { +"min_deposit": [ { - "gov": { - "Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" - }, - "Gov/gov/VotingProcedure": { - "voting_period": "10" - }, - "Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "20/100" - } - } +"denom": "iris-atto", +"amount": "10000000000000000000" +} +], +"max_deposit_period": "172800000000000" +}, +"Gov/govVotingProcedure": { +"voting_period": "10000000000" +}, +"Gov/govTallyingProcedure": { +"threshold": "0.5000000000", +"veto": "0.3340000000", +"participation": "0.4990000000" +} } # Change the parameters through files, return changed parameters -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/gov/TallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 +iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/govTallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 # Deposit for a proposal -echo 1234567890 | iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# Vote for a proposal -echo 1234567890 | iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 - -# Query the state of a proposal -iriscli gov query-proposal --proposal-id=1 --trust-node -``` - -## CLI Command Details - -### Basic method of gov modules - -``` -# Text proposals -iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="Text" --deposit="10iris" --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--title` The title of a proposal -* `--description` The description of a proposal -* `--type` The type of a proposal {'Text','ParameterChange','SoftwareUpgrade'} -* `--deposit` The number of the tokens deposited -* The basic text proposals are as below - -``` iriscli gov deposit --proposal-id=1 --deposit=1iris --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` -* `--propsal-id` The ID of the proposal deposited -* `--deposit` The number of the tokens deposited - -``` +# Vote for a proposal iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` -* `--proposal-id` The ID of the proposal in voting period -* `--option` Vote option{'Yes'-agree,'Abstain'-abstain,'No'-disagree,'nowithVeto'-strongly disagree } - - -``` # Query the state of a proposal iriscli gov query-proposal --proposal-id=1 --trust-node ``` -* `--proposal-id` Query the ID of a proposal - - - -### The proposals on parameters modification - -``` -# Query parameters can be modified by the modules'name in gov -iriscli gov query-params --module=gov --trust-node -``` - -* `--module` Query the list of "key" of the parameters can be changed in the module - - -``` -# Query the parameters can be modified by "key" -iriscli gov query-params --key=Gov/gov/DepositProcedure --trust-node -``` - -* `--key` Query the parameter corresponding to the "key" - -``` -# Export profiles -iriscli gov pull-params --path=iris --trust-node -``` - -* `--path` The folder of node initialization +### Proposals on software upgrade - - -``` -# Modify the parameters through the command lines -iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --param='{"key":"Gov/gov/DepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"10000000000000000000\"}],\"max_deposit_period\":20}","op":"update"}' --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--param` The details of changed parameters （get parameters through query-params, modify it and then add "update" on the "op", more details in usage scenarios） -* Other fields' proposals are similar with text proposal - -``` -# Change the parameters through files, return modified parameters -echo 1234567890 | iriscli gov submit-proposal --title="update MinDeposit" --description="test" --type="ParameterChange" --deposit="10iris" --path=iris --key=Gov/gov/TallyingProcedure --op=update --from=x --chain-id=gov-test --fee=0.05iris --gas=20000 -``` - -* `--path` The folder of node initialization -* `--key` The key of the parameter to be modified -* `--op` The type of changed parameters; only 'update' is implemented at present -* Other fields' proposals are similar with text proposal - -### Proposals on software upgrade +Detail in [Upgrade](upgrade.md) ## Basic parameters ``` # DepositProcedure（The parameters in deposit period） -"Gov/gov/DepositProcedure": { - "min_deposit": [ - { - "denom": "iris-atto", - "amount": "10000000000000000000" - } - ], - "max_deposit_period": "10" +"Gov/govDepositProcedure": { +"min_deposit": [ +{ +"denom": "iris-atto", +"amount": "10000000000000000000" +} +], +"max_deposit_period": "172800000000000" } ``` * Parameters can be changed * The key of parameters:"Gov/gov/DepositProcedure" * `min_deposit[0].denom` The minimum tokens deposited are counted by iris-atto. -* `min_deposit[0].amount` The number of minimum tokens and the default scope：10iris,（1iris，200iris） -* `max_deposit_period` Window period for repaying deposit, default :10， scope（0，1） +* `min_deposit[0].amount` The number of minimum tokens and the default scope：1000iris,（1iris，10000iris） +* `max_deposit_period` Window period for repaying deposit, default:172800000000000ns==2Days， scope（20s，3Day） ``` # VotingProcedure（The parameters in voting period） -"Gov/gov/VotingProcedure": { - "voting_period": "10" -}, +"Gov/govVotingProcedure": { +"voting_period": "10000000000" +} ``` * Parameters can be changed -* `voting_perid` Window period for vote, default：10, scope（20，20000） - +* `voting_perid` Window period for vote, default:172800000000000ns==2Days, scope（20s，3Days） + ``` # TallyingProcedure (The parameters in Tallying period) -"Gov/gov/TallyingProcedure": { - "threshold": "1/2", - "veto": "1/3", - "governance_penalty": "1/100" +"Gov/govTallyingProcedure": { +"threshold": "0.5000000000", +"veto": "0.3340000000", +"participation": "0.6670000000" } ``` - -* Parameters can be changed -* `veto` default: 1/3, scope（0，1） -* `threshold` default 1/2, scope（0，1） -* `governance_penalty` The default ratio of slashing tokens of validators who didn't vote: 1/100, scope（0，1） -* Vote rules: If the ratio of voting power of "strongly disagree" over "veto", the proposal won't be passed. If the ratio of voting_power of "agree" over "veto", the proposal won't be passed. Otherwise, it will be passed. +* Parameters can be changed +* `veto` default: 0.334, scope（0，1） +* `threshold` default: 0.5, scope（0，1） +* `governance_penalty` default: 0.667, scope（0，1） +* Vote rules:If the ratio of all voters' `voting_power` to the total 'voting_power' in system less than “participation”, the proposal won't be passed. If the ratio of strongly opposed `voting_power` to all voters' `voting_power` more than “veto”, the proposal won't be passed. Then if the ratio of approved `voting_power` to all voter's `voting_power` except abstentions over “threshold”, the proposal will be passed. Otherwise, N/A. diff --git a/docs/zh/features/basic-concepts/bech32-prefix.md b/docs/zh/features/basic-concepts/bech32-prefix.md index b6ece16dd..a77c5140a 100644 --- a/docs/zh/features/basic-concepts/bech32-prefix.md +++ b/docs/zh/features/basic-concepts/bech32-prefix.md @@ -1,6 +1,6 @@ # Bech32 on IRISnet -Bech32是由Pieter Wuille和Greg Maxwel提出的新比特币地址格式。除了比特币之外,bech32可以编码任何短二进制数据。在IRISnet里，私钥和地址可能指的是一些在网络中不同的角色，例如普通账户和验证人账户等。IRISnet设计使用Bech32地址格式来提供对数据鲁棒的完整性检查。 用户可读部分(human readable part) 使得用户更有效率的理解地址和阅读错误信息。 +Bech32是由Pieter Wuille和Greg Maxwel提出的新比特币地址格式。除了比特币之外,bech32可以编码任何短二进制数据。在IRISnet里，私钥和地址可能指的是一些在网络中不同的角色，例如普通账户和验证人账户等。IRISnet设计使用Bech32地址格式来提供对数据鲁棒的完整性检查。 用户可读部分(human readable part) 使得用户更有效率的理解地址和阅读错误信息。Bech32更多细节见 [bip-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) ## 用户可读部分表 @@ -27,4 +27,4 @@ NAME: TYPE: ADDRESS: PUBKEY: test1 local faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv ``` -这意味着你创建了一个新账户地址 `faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl`， 他的用户可读部分是 `faa`。他的公钥被密码成 `fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv`， 他的用户可读部分是 `fap`。 \ No newline at end of file +这意味着你创建了一个新账户地址 `faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl`， 他的用户可读部分是 `faa`。他的公钥被密码成 `fap1addwnpepqgxa40ww28uy9q46gg48g6ulqdzwupyjcwfumgfjpvz7krmg5mrnw6zv8uv`， 他的用户可读部分是 `fap`。 diff --git a/docs/zh/features/governance.md b/docs/zh/features/governance.md index 9b9007d7e..b8a5ec07b 100644 --- a/docs/zh/features/governance.md +++ b/docs/zh/features/governance.md @@ -12,7 +12,7 @@ 1. 任何用户可以发起提议，并抵押一部分token，如果超过`min_deposit`,提议进入投票，否则留在抵押期。其他人可以对在抵押期的提议进行抵押token，如果提议的抵押token总和超过`min_deposit`,则进入投票期。但若提议在抵押期停留的出块数目超过`max_deposit_period`，则提议被关闭。 2. 进入投票期的提议，只有验证人和委托人可以进行投票。如果委托人没投票，则他继承他委托的验证人的投票选项。如果委托人投票了，则覆盖他委托的验证人的投票选项。当提议到达`voting_perid`,统计投票结果。 -3. 我们统计结果有参与度的限制，其他逻辑细节见[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/spec/governance/overview.md) +3. 我们统计结果有参与度的限制，其他逻辑细节见[CosmosSDK-Gov-spec](https://github.com/cosmos/cosmos-sdk/blob/v0.26.0/docs/spec/governance/overview.md) ## 使用场景 From 5c782c88fdaa58b5f20a5f4fad3498f356c71f54 Mon Sep 17 00:00:00 2001 From: chengwenxi Date: Sun, 18 Nov 2018 01:04:51 +0800 Subject: [PATCH 091/100] IRISHUB-677: zh user guide for bank --- docs/zh/features/bank.md | 197 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 197 insertions(+) diff --git a/docs/zh/features/bank.md b/docs/zh/features/bank.md index e69de29bb..501fdef0e 100644 --- a/docs/zh/features/bank.md +++ b/docs/zh/features/bank.md @@ -0,0 +1,197 @@ +# Bank模块用户文档 + +## 简介 +该模块主要用于账户之间转账、查询账户余额，同时提供了通用的签名方法，此外，irisnet使用[coin_type](./basic-concepts/coin-type.md)定义了iris-hub系统中代币的可用单位。 + +## 使用场景 + +1. 查询某一代币coin_type + ```bash + iriscli bank coin-type [coin-name] + ``` + 如coin-name为iris，将返回iris的coin_type: + ```json + { + "name": "iris", + "min_unit": { + "denom": "iris-atto", + "decimal": "18" + }, + "units": [ + { + "denom": "iris", + "decimal": "0" + }, + { + "denom": "iris-milli", + "decimal": "3" + }, + { + "denom": "iris-micro", + "decimal": "6" + }, + { + "denom": "iris-nano", + "decimal": "9" + }, + { + "denom": "iris-pico", + "decimal": "12" + }, + { + "denom": "iris-femto", + "decimal": "15" + }, + { + "denom": "iris-atto", + "decimal": "18" + } + ], + "origin": 1, + "desc": "IRIS Network" + } + ``` + +2. 账户查询 + + 可以通过账户地址查询该账户的信息，包括账户余额、账户公钥、账户编号和交易序号。 + ```bash + iriscli bank account [account address] + ``` + +3. 账户间转账 + + 如从账户A转账给账户B10iris: + ```bash + iriscli bank send --to [address of wallet B] --amount=10iris --fee=0.004iris --from=[key name of wallet A] --chain-id=[chain-id] + ``` + iris网络支持多种代币流通，在将来iris可以在同一交易个包含多种代币交换——代币种类可以为任意在iris网络中注册过的coin_type。 + +4. 交易签名 + + 为了提高账户安全性，iris提供离线签名保护账户的私钥。在任意交易中，使用参数--generate-only=true可以构建一个未签名的交易。使用转账交易作为示例: + ```bash + iriscli bank send --to [address of wallet B] --amount=10iris --fee=0.004iris --from=[key name of wallet A] --generate-only=true + ``` + 将构建一个signatures为空的交易返回: + ```json + { + "type": "auth/StdTx", + "value": { + "msg": [ + { + "type": "cosmos-sdk/Send", + "value": { + "inputs": [ + { + "address": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "coins": [ + { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + ] + } + ], + "outputs": [ + { + "address": "faa1ut8aues05kq0nkcj3lzkyhk7eyfasrdfnf7wph", + "coins": [ + { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + ] + } + ] + } + } + ], + "fee": { + "amount": [ + { + "denom": "iris-atto", + "amount": "40000000000000000" + } + ], + "gas": "200000" + }, + "signatures": null, + "memo": "" + } + } + ``` + 将结果保存到文件。 + + 发送签名交易: + ```bash + iriscli bank sign [file] --chain-id=[chain-id] --name [key name of from account] + ``` + 将返回已签名的交易: + ```json + { + "type": "auth/StdTx", + "value": { + "msg": [ + { + "type": "cosmos-sdk/Send", + "value": { + "inputs": [ + { + "address": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "coins": [ + { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + ] + } + ], + "outputs": [ + { + "address": "faa1ut8aues05kq0nkcj3lzkyhk7eyfasrdfnf7wph", + "coins": [ + { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + ] + } + ] + } + } + ], + "fee": { + "amount": [ + { + "denom": "iris-atto", + "amount": "40000000000000000" + } + ], + "gas": "200000" + }, + "signatures": [ + { + "pub_key": { + "type": "tendermint/PubKeySecp256k1", + "value": "A+qXW5isQDb7blT/KwEgQHepji8RfpzIstkHpKoZq0kr" + }, + "signature": "5hxk/R81SWmKAGi4kTW2OapezQZpp6zEnaJbVcyDiWRfgBm4Uejq8+CDk6uzk0aFSgAZzz06E014UkgGpelU7w==", + "account_number": "0", + "sequence": "11" + } + ], + "memo": "" + } + } + ``` + 将结果保存到文件。 + +5. 广播交易 + + 广播离线产生的已签名的交易，使用步骤4中最终生成的文件提交该交易: + ```bash + iriscli bank broadcast [file] + ``` + 该交易将在iris网络中广播并执行。 + \ No newline at end of file From d64e84f82e432937877d7db62d39d24f26163ec4 Mon Sep 17 00:00:00 2001 From: chengwenxi Date: Sun, 18 Nov 2018 09:41:24 +0800 Subject: [PATCH 092/100] IRISHUB-677: en user guide for bank --- docs/features/bank.md | 197 +++++++++++++++++++++++++++++++++++++++ docs/zh/features/bank.md | 10 +- 2 files changed, 202 insertions(+), 5 deletions(-) diff --git a/docs/features/bank.md b/docs/features/bank.md index e69de29bb..5f564bca6 100644 --- a/docs/features/bank.md +++ b/docs/features/bank.md @@ -0,0 +1,197 @@ +# Bank User Guide + +## Introduction +This module is mainly used to transfer coins between accounts、query account balances, and provide a common offline transaction signing and broadcasting method. In addition, the available units of tokens in the IRIShub system are defined using [coin_type](./basic-concepts/coin-type.md). + +## Usage Scenario + +1. Query the coin_type configuration of a certain token: + ```bash + iriscli bank coin-type [coin-name] + ``` + For example, coin_type of iris will be returned if the coin-name is iris: + ```json + { + "name": "iris", + "min_unit": { + "denom": "iris-atto", + "decimal": "18" + }, + "units": [ + { + "denom": "iris", + "decimal": "0" + }, + { + "denom": "iris-milli", + "decimal": "3" + }, + { + "denom": "iris-micro", + "decimal": "6" + }, + { + "denom": "iris-nano", + "decimal": "9" + }, + { + "denom": "iris-pico", + "decimal": "12" + }, + { + "denom": "iris-femto", + "decimal": "15" + }, + { + "denom": "iris-atto", + "decimal": "18" + } + ], + "origin": 1, + "desc": "IRIS Network" + } + ``` + +2. Query account + + Query the account information of a certain account address, including the balance, the public key, the account number and the transaction number. + ```bash + iriscli bank account [account address] + ``` + +3. Transfer between accounts + + For example, transfer from account A to account B10iris: + ```bash + iriscli bank send --to [address of wallet B] --amount=10iris --fee=0.004iris --from=[key name of wallet A] --chain-id=[chain-id] + ``` + IRISnet supports multiple tokens in circulation, and in the future IRISnet will be able to include multiple tokens in one transaction -- tokens can be any coin_type registered in IRISnet. + +4. Sign transactions generated offline + + To improve account security, IRISnet supports offline signing of transactions to protect the account's private key. In any transaction, you can build an unsigned transaction using the flag --generate-only=true. Use transfer transactions as an example: + ```bash + iriscli bank send --to [address of wallet B] --amount=10iris --fee=0.004iris --from=[key name of wallet A] --generate-only=true + ``` + Return the built transaction with empty signatures: + ```json + { + "type": "auth/StdTx", + "value": { + "msg": [ + { + "type": "cosmos-sdk/Send", + "value": { + "inputs": [ + { + "address": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "coins": [ + { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + ] + } + ], + "outputs": [ + { + "address": "faa1ut8aues05kq0nkcj3lzkyhk7eyfasrdfnf7wph", + "coins": [ + { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + ] + } + ] + } + } + ], + "fee": { + "amount": [ + { + "denom": "iris-atto", + "amount": "40000000000000000" + } + ], + "gas": "200000" + }, + "signatures": null, + "memo": "" + } + } + ``` + Save the result to a file. + + Send signature transaction: + ```bash + iriscli bank sign [file] --chain-id=[chain-id] --name [key name of from account] + ``` + Return signed transactions: + ```json + { + "type": "auth/StdTx", + "value": { + "msg": [ + { + "type": "cosmos-sdk/Send", + "value": { + "inputs": [ + { + "address": "faa1ydhmma8l4m9dygsh7l08fgrwka6yczs0gkfnvd", + "coins": [ + { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + ] + } + ], + "outputs": [ + { + "address": "faa1ut8aues05kq0nkcj3lzkyhk7eyfasrdfnf7wph", + "coins": [ + { + "denom": "iris-atto", + "amount": "100000000000000000000" + } + ] + } + ] + } + } + ], + "fee": { + "amount": [ + { + "denom": "iris-atto", + "amount": "40000000000000000" + } + ], + "gas": "200000" + }, + "signatures": [ + { + "pub_key": { + "type": "tendermint/PubKeySecp256k1", + "value": "A+qXW5isQDb7blT/KwEgQHepji8RfpzIstkHpKoZq0kr" + }, + "signature": "5hxk/R81SWmKAGi4kTW2OapezQZpp6zEnaJbVcyDiWRfgBm4Uejq8+CDk6uzk0aFSgAZzz06E014UkgGpelU7w==", + "account_number": "0", + "sequence": "11" + } + ], + "memo": "" + } + } + ``` + Save the result to a file. + +5. Broadcast transactions + + Broadcast signed transactions generated offline, using the final generated file in step 4: + ```bash + iriscli bank broadcast [file] + ``` + The transaction will broadcast and executed in IRISnet. + \ No newline at end of file diff --git a/docs/zh/features/bank.md b/docs/zh/features/bank.md index 501fdef0e..75aeeb5d3 100644 --- a/docs/zh/features/bank.md +++ b/docs/zh/features/bank.md @@ -1,11 +1,11 @@ # Bank模块用户文档 ## 简介 -该模块主要用于账户之间转账、查询账户余额，同时提供了通用的签名方法，此外，irisnet使用[coin_type](./basic-concepts/coin-type.md)定义了iris-hub系统中代币的可用单位。 +该模块主要用于账户之间转账、查询账户余额，同时提供了通用的离线签名与交易广播方法，此外，使用[coin_type](./basic-concepts/coin-type.md)定义了IRIShub系统中代币的可用单位。 ## 使用场景 -1. 查询某一代币coin_type +1. 查询某一代币coin_type: ```bash iriscli bank coin-type [coin-name] ``` @@ -65,11 +65,11 @@ ```bash iriscli bank send --to [address of wallet B] --amount=10iris --fee=0.004iris --from=[key name of wallet A] --chain-id=[chain-id] ``` - iris网络支持多种代币流通，在将来iris可以在同一交易个包含多种代币交换——代币种类可以为任意在iris网络中注册过的coin_type。 + IRISnet支持多种代币流通，将来IRISnet可以在一个交易中包含多种代币交换——代币种类可以为任意在IRISnet中注册过的coin_type。 4. 交易签名 - 为了提高账户安全性，iris提供离线签名保护账户的私钥。在任意交易中，使用参数--generate-only=true可以构建一个未签名的交易。使用转账交易作为示例: + 为了提高账户安全性，IRISnet支持交易离线签名保护账户的私钥。在任意交易中，使用参数--generate-only=true可以构建一个未签名的交易。使用转账交易作为示例: ```bash iriscli bank send --to [address of wallet B] --amount=10iris --fee=0.004iris --from=[key name of wallet A] --generate-only=true ``` @@ -193,5 +193,5 @@ ```bash iriscli bank broadcast [file] ``` - 该交易将在iris网络中广播并执行。 + 该交易将在IRISnet中广播并执行。 \ No newline at end of file From 4ca9654833bf006cd51fce888429a67e0804a732 Mon Sep 17 00:00:00 2001 From: chengwenxi Date: Sun, 18 Nov 2018 11:00:41 +0800 Subject: [PATCH 093/100] Update guide --- docs/features/bank.md | 6 +++--- docs/zh/features/bank.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/features/bank.md b/docs/features/bank.md index 5f564bca6..1a2359087 100644 --- a/docs/features/bank.md +++ b/docs/features/bank.md @@ -125,7 +125,7 @@ This module is mainly used to transfer coins between accounts、query account ba Send signature transaction: ```bash - iriscli bank sign [file] --chain-id=[chain-id] --name [key name of from account] + iriscli bank sign [file] --chain-id=[chain-id] --name [key name] ``` Return signed transactions: ```json @@ -189,9 +189,9 @@ This module is mainly used to transfer coins between accounts、query account ba 5. Broadcast transactions - Broadcast signed transactions generated offline, using the final generated file in step 4: + Broadcast offline signed transactions. Here you just use the transaction generated by above sign command. Of course, you can generate your signed transaction by any methods, eg. [irisnet-crypto](https://github.com/irisnet/irisnet-crypto). ```bash iriscli bank broadcast [file] ``` - The transaction will broadcast and executed in IRISnet. + The transaction will be broadcast and executed in IRISnet. \ No newline at end of file diff --git a/docs/zh/features/bank.md b/docs/zh/features/bank.md index 75aeeb5d3..c90878f5f 100644 --- a/docs/zh/features/bank.md +++ b/docs/zh/features/bank.md @@ -125,7 +125,7 @@ 发送签名交易: ```bash - iriscli bank sign [file] --chain-id=[chain-id] --name [key name of from account] + iriscli bank sign [file] --chain-id=[chain-id] --name [key name] ``` 将返回已签名的交易: ```json @@ -189,7 +189,7 @@ 5. 广播交易 - 广播离线产生的已签名的交易，使用步骤4中最终生成的文件提交该交易: + 广播离线产生的已签名的交易，在这里，你只需使用上面的sign命令生成的交易。当然，您可以通过任何方法生成已签名的交易，例如：[irisnet-crypto](https://github.com/irisnet/irisnet-crypto)。 ```bash iriscli bank broadcast [file] ``` From 425a6c25250cf4c0eda356b83eb0128a6edc935c Mon Sep 17 00:00:00 2001 From: chengwenxi Date: Sun, 18 Nov 2018 11:10:48 +0800 Subject: [PATCH 094/100] Update guide --- docs/features/bank.md | 4 ++-- docs/zh/features/bank.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/features/bank.md b/docs/features/bank.md index 1a2359087..e64829ec9 100644 --- a/docs/features/bank.md +++ b/docs/features/bank.md @@ -61,7 +61,7 @@ This module is mainly used to transfer coins between accounts、query account ba 3. Transfer between accounts - For example, transfer from account A to account B10iris: + For example, transfer 10iris from account A to account B: ```bash iriscli bank send --to [address of wallet B] --amount=10iris --fee=0.004iris --from=[key name of wallet A] --chain-id=[chain-id] ``` @@ -189,7 +189,7 @@ This module is mainly used to transfer coins between accounts、query account ba 5. Broadcast transactions - Broadcast offline signed transactions. Here you just use the transaction generated by above sign command. Of course, you can generate your signed transaction by any methods, eg. [irisnet-crypto](https://github.com/irisnet/irisnet-crypto). + Broadcast offline signed transactions. Here you can just use the transaction generated by above sign command. Of course, you can generate your signed transaction by any methods, eg. [irisnet-crypto](https://github.com/irisnet/irisnet-crypto). ```bash iriscli bank broadcast [file] ``` diff --git a/docs/zh/features/bank.md b/docs/zh/features/bank.md index c90878f5f..7da520a5c 100644 --- a/docs/zh/features/bank.md +++ b/docs/zh/features/bank.md @@ -189,7 +189,7 @@ 5. 广播交易 - 广播离线产生的已签名的交易，在这里，你只需使用上面的sign命令生成的交易。当然，您可以通过任何方法生成已签名的交易，例如：[irisnet-crypto](https://github.com/irisnet/irisnet-crypto)。 + 广播离线产生的已签名的交易，在这里，你可以使用上面的sign命令生成的交易。当然，您可以通过任何方法生成已签名的交易，例如：[irisnet-crypto](https://github.com/irisnet/irisnet-crypto)。 ```bash iriscli bank broadcast [file] ``` From 88a8d5c245cb35e72b5007dc487abbf43114397e Mon Sep 17 00:00:00 2001 From: jiacheng Date: Sun, 18 Nov 2018 11:40:12 +0800 Subject: [PATCH 095/100] Modify the gov cliclient --- docs/cli-client/gov/deposit.md | 27 +++++--------------- docs/cli-client/gov/pull-params.md | 15 +++++------ docs/cli-client/gov/query-deposit.md | 14 +++++----- docs/cli-client/gov/query-deposits.md | 15 +++++------ docs/cli-client/gov/query-params.md | 14 +++++----- docs/cli-client/gov/query-proposal.md | 15 +++++------ docs/cli-client/gov/query-proposals.md | 16 ++++++------ docs/cli-client/gov/query-tally.md | 15 +++++------ docs/cli-client/gov/query-vote.md | 15 +++++------ docs/cli-client/gov/query-votes.md | 14 +++++----- docs/cli-client/gov/submit-proposal.md | 24 ++++-------------- docs/cli-client/gov/vote.md | 26 +++++-------------- docs/zh/cli-client/gov/deposit.md | 26 +++++-------------- docs/zh/cli-client/gov/pull-params.md | 15 +++++------ docs/zh/cli-client/gov/query-deposit.md | 15 +++++------ docs/zh/cli-client/gov/query-deposits.md | 13 ++++------ docs/zh/cli-client/gov/query-params.md | 13 ++++------ docs/zh/cli-client/gov/query-proposal.md | 15 +++++------ docs/zh/cli-client/gov/query-proposals.md | 11 +++----- docs/zh/cli-client/gov/query-tally.md | 15 +++++------ docs/zh/cli-client/gov/query-vote.md | 13 ++++------ docs/zh/cli-client/gov/query-votes.md | 14 +++++----- docs/zh/cli-client/gov/submit-proposal.md | 31 ++++++----------------- docs/zh/cli-client/gov/vote.md | 26 +++++-------------- 24 files changed, 148 insertions(+), 269 deletions(-) diff --git a/docs/cli-client/gov/deposit.md b/docs/cli-client/gov/deposit.md index 95c383530..5ebbad303 100644 --- a/docs/cli-client/gov/deposit.md +++ b/docs/cli-client/gov/deposit.md @@ -10,32 +10,17 @@ Deposit tokens for activing proposal iriscli gov deposit [flags] ``` +Print help messages: + +``` +iriscli gov deposit --help +``` ## Flags | Name, shorthand | Default | Description | Required | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | | --deposit | | [string] Deposit of proposal | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | Help for deposit | | -| --indent | | Add indent to JSON response | | -| --json | | Return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --print-response | | return tx response (only works with async = false) | | | --proposal-id | | [string] ProposalID of proposal depositing on | Yes | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | - ## Examples ### Deposit @@ -57,4 +42,4 @@ Committed at block 473 (tx hash: 0309E969589F19A9D9E4BFC9479720487FBF929ED6A8882 "proposal-id": "1" } } -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/pull-params.md b/docs/cli-client/gov/pull-params.md index dd8b5397b..1830b0fa5 100644 --- a/docs/cli-client/gov/pull-params.md +++ b/docs/cli-client/gov/pull-params.md @@ -10,18 +10,17 @@ Generate param.json file iriscli gov pull-params [flags] ``` +Print help messages: + +``` +iriscli gov pull-params --help +``` + ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for pull-params | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --path | $HOME/.iris | [string] Directory of iris home | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -84,4 +83,4 @@ If you open the params.json in the --path/config directory, you can see it's jso } } } -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/query-deposit.md b/docs/cli-client/gov/query-deposit.md index a2a98a5c1..6633eb4c4 100644 --- a/docs/cli-client/gov/query-deposit.md +++ b/docs/cli-client/gov/query-deposit.md @@ -10,19 +10,17 @@ Query details of a deposit iriscli gov query-deposit [flags] ``` +Print help messages: + +``` +iriscli gov query-deposit --help +``` ## Flags | Name, shorthand | Default | Description | Required | | --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | --chain-id | | [string] Chain ID of tendermint node | Yes | | --depositor | | [string] Bech32 depositor address | Yes | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-deposit | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --proposal-id | | [string] ProposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -45,4 +43,4 @@ You could query the deposited tokens on a specific proposal. } ] } -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/query-deposits.md b/docs/cli-client/gov/query-deposits.md index d9098a365..c2b183287 100644 --- a/docs/cli-client/gov/query-deposits.md +++ b/docs/cli-client/gov/query-deposits.md @@ -10,18 +10,17 @@ Query details of a deposits iriscli gov query-deposits [flags] ``` +Print help messages: + +``` +iriscli gov query-deposits --help +``` ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-deposits | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --proposal-id | | [string] ProposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | + ## Examples @@ -46,4 +45,4 @@ You could query all the deposited tokens on a specific proposal, includes deposi ] } ] -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/query-params.md b/docs/cli-client/gov/query-params.md index 543d400ba..2f61348e8 100644 --- a/docs/cli-client/gov/query-params.md +++ b/docs/cli-client/gov/query-params.md @@ -10,19 +10,17 @@ Query parameter proposal's config iriscli gov query-params [flags] ``` +Print help messages: + +``` +iriscli gov query-params --help +``` ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-params | | -| --indent | | Add indent to JSON response | | | --key | | [string] Key name of parameter | | -| --ledger | | Use a connected Ledger device | | | --module | | [string] Module name | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -54,4 +52,4 @@ You'll get all the details of the key specified in the gov module. {"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"1000000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":""} ``` -Note: --module and --key cannot be both empty. \ No newline at end of file +Note: --module and --key cannot be both empty. diff --git a/docs/cli-client/gov/query-proposal.md b/docs/cli-client/gov/query-proposal.md index b77535703..348052272 100644 --- a/docs/cli-client/gov/query-proposal.md +++ b/docs/cli-client/gov/query-proposal.md @@ -10,18 +10,17 @@ Query details of a single proposal iriscli gov query-proposal [flags] ``` +Print help messages: + +``` +iriscli gov query-proposal --help +``` + ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-proposal | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --proposal-id | | [string] ProposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -62,4 +61,4 @@ You could query the details of a specific proposal. "op": "" } } -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/query-proposals.md b/docs/cli-client/gov/query-proposals.md index 0c0645c3e..21424ff87 100644 --- a/docs/cli-client/gov/query-proposals.md +++ b/docs/cli-client/gov/query-proposals.md @@ -10,20 +10,20 @@ Query proposals with optional filters iriscli gov query-proposals [flags] ``` + +Print help messages: + +``` +iriscli gov query-proposals --help +``` + ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | | --depositor | | [string] (optional) Filter by proposals deposited on by depositor | | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-proposals | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | | --limit | | [string] (optional) Limit to latest [number] proposals. Defaults to all proposals | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --status | | [string] (optional) filter proposals by proposal status | | -| --trust-node | true | Don't verify proofs for responses | | | --voter | | [string] (optional) Filter by proposals voted on by voted | | ## Examples @@ -51,4 +51,4 @@ Finally, here shows the proposal who's depositor address is faa14q5rf9sl2dqd2uxr ```txt 2 - new proposal -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/query-tally.md b/docs/cli-client/gov/query-tally.md index ca9c32513..9a0331b50 100644 --- a/docs/cli-client/gov/query-tally.md +++ b/docs/cli-client/gov/query-tally.md @@ -10,17 +10,16 @@ Get the tally of a proposal vote iriscli gov query-tally [flags] ``` +Print help messages: + +``` +iriscli gov query-tally --help +``` + ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-tally | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --proposal-id | | [string] ProposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -39,4 +38,4 @@ You could query the statistics of each voting option. "no": "0.0000000000", "no_with_veto": "0.0000000000" } -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/query-vote.md b/docs/cli-client/gov/query-vote.md index 0a05d9b8c..e7175f1c3 100644 --- a/docs/cli-client/gov/query-vote.md +++ b/docs/cli-client/gov/query-vote.md @@ -10,18 +10,17 @@ Query vote iriscli gov query-vote [flags] ``` +Print help messages: + +``` +iriscli gov query-vote --help +``` + ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-vote | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --proposal-id | | [string] ProposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | | --voter | | [string] Bech32 voter address | Yes | ## Examples @@ -40,4 +39,4 @@ You could query the voting by specifying the proposal and the voter. "proposal_id": "1", "option": "Yes" } -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/query-votes.md b/docs/cli-client/gov/query-votes.md index c9834c5d6..bed60f2cf 100644 --- a/docs/cli-client/gov/query-votes.md +++ b/docs/cli-client/gov/query-votes.md @@ -10,18 +10,16 @@ Query votes on a proposal iriscli gov query-votes [flags] ``` +Print help messages: + +``` +iriscli gov query-votes --help +``` ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --height | | [int] Block height to query, omit to get most recent provable block | | -| --help, -h | | Help for query-votes | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --proposal-id | | [string] ProposalID of proposal depositing on | Yes | -| --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -41,4 +39,4 @@ You could query the voting of all the voters by specifying the proposal. "option": "Yes" } ] -``` \ No newline at end of file +``` diff --git a/docs/cli-client/gov/submit-proposal.md b/docs/cli-client/gov/submit-proposal.md index 10c056aca..beaf29045 100644 --- a/docs/cli-client/gov/submit-proposal.md +++ b/docs/cli-client/gov/submit-proposal.md @@ -10,36 +10,22 @@ Submit a proposal along with an initial deposit iriscli gov submit-proposal [flags] ``` +Print help messages: + +``` +iriscli gov submit-proposal --help +``` ## Flags | Name, shorthand | Default | Description | Required | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | | --deposit | | [string] Deposit of proposal | | | --description | | [string] Description of proposal | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | Help for submit-proposal | | -| --indent | | Add indent to JSON response | | -| --json | | Return output in json format | | | --key | | The key of parameter | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --op | | [string] The operation of parameter | | | --param | | [string] Parameter of proposal,eg. [{key:key,value:value,op:update}] | | | --path | | [string] The path of param.json | | -| --print-response | | Return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | | --title | | [string] Title of proposal | Yes | -| --trust-node | true | Don't verify proofs for responses | | | --type | | [string] ProposalType of proposal,eg:Text/ParameterChange/SoftwareUpgrade | Yes | ## Examples diff --git a/docs/cli-client/gov/vote.md b/docs/cli-client/gov/vote.md index 88e86ba7a..a8b63e039 100644 --- a/docs/cli-client/gov/vote.md +++ b/docs/cli-client/gov/vote.md @@ -10,31 +10,17 @@ Vote for an active proposal, options: Yes/No/NoWithVeto/Abstain iriscli gov vote [flags] ``` +Print help messages: + +``` +iriscli gov vote --help +``` ## Flags | Name, shorthand | Default | Description | Required | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas | 200000 | [string] Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --help, -h | | Help for vote | | -| --indent | | Add indent to JSON response | | -| --json | | Return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | | --option | | [string] Vote option {Yes, No, NoWithVeto, Abstain} | Yes | -| --print-response | | Return tx response (only works with async = false) | | | --proposal-id | | [string] ProposalID of proposal voting on | Yes | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | ## Examples @@ -58,4 +44,4 @@ Committed at block 989 (tx hash: ABDD88AA3CA8F365AC499427477CCE83ADF09D7FC2D6264 "voter": "faa14q5rf9sl2dqd2uxrxykafxq3nu3lj2fp9l7pgd" } } -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/gov/deposit.md b/docs/zh/cli-client/gov/deposit.md index a83045555..9799ca73a 100644 --- a/docs/zh/cli-client/gov/deposit.md +++ b/docs/zh/cli-client/gov/deposit.md @@ -10,31 +10,17 @@ iriscli gov deposit [flags] ``` +打印帮助信息: + +``` +iriscli gov deposit --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | Yes | | --deposit | | [string] 发起提议的保证金 | Yes | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | | --proposal-id | | [string] 充值保证金的提议ID | Yes | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 @@ -65,4 +51,4 @@ Committed at block 473 (tx hash: 0309E969589F19A9D9E4BFC9479720487FBF929ED6A8882 [query-deposit](query-deposit.md) -[query-deposits](query-deposits.md) \ No newline at end of file +[query-deposits](query-deposits.md) diff --git a/docs/zh/cli-client/gov/pull-params.md b/docs/zh/cli-client/gov/pull-params.md index c43dbc476..ce7189ca0 100644 --- a/docs/zh/cli-client/gov/pull-params.md +++ b/docs/zh/cli-client/gov/pull-params.md @@ -9,19 +9,16 @@ ``` iriscli gov pull-params [flags] ``` +打印帮助信息: +``` +iriscli gov pull-params --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --path | $HOME/.iris | [string] iris home目录 | | -| --trust-node | true | 关闭响应结果校验 | | +| --path | $HOME/.iris | [string] iris home目录 ## 例子 @@ -84,4 +81,4 @@ Save the parameter config file in /Users/trevorfu/.iris/config/params.json } } } -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/gov/query-deposit.md b/docs/zh/cli-client/gov/query-deposit.md index c061675ff..51437efab 100644 --- a/docs/zh/cli-client/gov/query-deposit.md +++ b/docs/zh/cli-client/gov/query-deposit.md @@ -9,21 +9,18 @@ ``` iriscli gov query-deposit [flags] ``` +打印帮助信息: +``` +iriscli gov query-deposit --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | Yes | | --depositor | | [string] bech32编码的存款人地址 | Yes | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --proposal-id | | [string] 提议ID | Yes | -| --trust-node | true | 关闭响应结果校验 | | - + ## 例子 ### 查询充值保证金 @@ -45,4 +42,4 @@ iriscli gov query-deposit --chain-id=test --proposal-id=1 --depositor=faa1c4kjt5 } ] } -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/gov/query-deposits.md b/docs/zh/cli-client/gov/query-deposits.md index 2f5dd8853..ef0da3e43 100644 --- a/docs/zh/cli-client/gov/query-deposits.md +++ b/docs/zh/cli-client/gov/query-deposits.md @@ -9,19 +9,16 @@ ``` iriscli gov query-deposits [flags] ``` +打印帮助信息: +``` +iriscli gov query-deposits --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | Yes | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --proposal-id | | [string] 提议ID | Yes | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 @@ -46,4 +43,4 @@ iriscli gov query-deposits --chain-id=test --proposal-id=1 ] } ] -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/gov/query-params.md b/docs/zh/cli-client/gov/query-params.md index 001ef7f56..1bffbcbe3 100644 --- a/docs/zh/cli-client/gov/query-params.md +++ b/docs/zh/cli-client/gov/query-params.md @@ -9,20 +9,17 @@ ``` iriscli gov query-params [flags] ``` +打印帮助信息: +``` +iriscli gov query-params --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | | --key | | [string] 参数的键名称 | | -| --ledger | | 使用连接的硬件记账设备 | | | --module | | [string] 模块名称 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 @@ -54,4 +51,4 @@ iriscli gov query-params --key=Gov/govDepositProcedure {"key":"Gov/govDepositProcedure","value":"{\"min_deposit\":[{\"denom\":\"iris-atto\",\"amount\":\"1000000000000000000000\"}],\"max_deposit_period\":172800000000000}","op":""} ``` -注意：--module和--key参数不能同时为空. \ No newline at end of file +注意：--module和--key参数不能同时为空. diff --git a/docs/zh/cli-client/gov/query-proposal.md b/docs/zh/cli-client/gov/query-proposal.md index 577e7458e..a332a4b73 100644 --- a/docs/zh/cli-client/gov/query-proposal.md +++ b/docs/zh/cli-client/gov/query-proposal.md @@ -9,20 +9,17 @@ ``` iriscli gov query-proposal [flags] ``` +打印帮助信息: + +``` +iriscli gov query-proposal --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | Yes | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --proposal-id | | [string] 提议ID | Yes | -| --trust-node | true | 关闭响应结果校验 | | - ## 例子 ### 查询指定的提议 @@ -62,4 +59,4 @@ iriscli gov query-proposal --chain-id=test --proposal-id=1 "op": "" } } -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/gov/query-proposals.md b/docs/zh/cli-client/gov/query-proposals.md index 2c3b276c7..2d1a25b0c 100644 --- a/docs/zh/cli-client/gov/query-proposals.md +++ b/docs/zh/cli-client/gov/query-proposals.md @@ -9,21 +9,18 @@ ``` iriscli gov query-proposals [flags] ``` +打印帮助信息: +``` +iriscli gov query-proposals --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | Yes | | --depositor | | [string] （可选）按存款人过滤 | | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | | --limit | | [string] （可选）限制最新[数量]提议。 默认为所有提议 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --status | | [string] （可选）按提议状态过滤提议 | | -| --trust-node | true | 关闭响应结果校验 | | | --voter | | [string] （可选）按投票人过滤 | | ## 例子 diff --git a/docs/zh/cli-client/gov/query-tally.md b/docs/zh/cli-client/gov/query-tally.md index f9ed82baf..66a083a3b 100644 --- a/docs/zh/cli-client/gov/query-tally.md +++ b/docs/zh/cli-client/gov/query-tally.md @@ -10,17 +10,16 @@ iriscli gov query-tally [flags] ``` +打印帮助信息: + +``` +iriscli gov query-tally --help +``` + ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | Yes | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --proposal-id | | [string] 提议ID | Yes | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 @@ -39,4 +38,4 @@ iriscli gov query-tally --chain-id=test --proposal-id=1 "no": "200.0000000000", "no_with_veto": "0.0000000000" } -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/gov/query-vote.md b/docs/zh/cli-client/gov/query-vote.md index d9846bf43..b9e93a51c 100644 --- a/docs/zh/cli-client/gov/query-vote.md +++ b/docs/zh/cli-client/gov/query-vote.md @@ -9,19 +9,16 @@ ``` iriscli gov query-vote [flags] ``` +打印帮助信息: +``` +iriscli gov query-vote --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | Yes | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --proposal-id | | [string] 提议ID | Yes | -| --trust-node | true | 关闭响应结果校验 | | | --voter | | [string] bech32编码的投票人地址 | Yes | ## 例子 @@ -40,4 +37,4 @@ iriscli gov query-vote --chain-id=test --proposal-id=1 --voter=faa14q5rf9sl2dqd2 "proposal_id": "1", "option": "Yes" } -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/gov/query-votes.md b/docs/zh/cli-client/gov/query-votes.md index c60450250..97bae4270 100644 --- a/docs/zh/cli-client/gov/query-votes.md +++ b/docs/zh/cli-client/gov/query-votes.md @@ -9,19 +9,17 @@ ``` iriscli gov query-votes [flags] ``` +打印帮助信息: + +``` +iriscli gov query-votes --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | --------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --chain-id | | [string] tendermint节点的链ID | Yes | -| --height | | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --proposal-id | | [string] 提议ID | Yes | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 @@ -41,4 +39,4 @@ iriscli gov query-votes --chain-id=test --proposal-id=1 "option": "Yes" } ] -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/gov/submit-proposal.md b/docs/zh/cli-client/gov/submit-proposal.md index b089c2106..e05630d84 100644 --- a/docs/zh/cli-client/gov/submit-proposal.md +++ b/docs/zh/cli-client/gov/submit-proposal.md @@ -9,37 +9,22 @@ ``` iriscli gov submit-proposal [flags] ``` +打印帮助信息: +``` +iriscli gov submit-proposal --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | Yes | | --deposit | | [string] 提议的保证金 | | -| --description | | [string] 提议的描述 | Yes | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --key | | 参数的键名称 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --op | | [string] 对参数的操作 | | +| --description | | [string] 提议的描述 | Yes | +| --key | | 参数的键名称 | | +| --op | | [string] 对参数的操作 | | | --param | | [string] 提议参数,例如: [{key:key,value:value,op:update}] | | | --path | | [string] param.json文件路径 | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | -| --sequence | | [int] 用来签名交易的sequence number | | | --title | | [string] 提议标题 | Yes | -| --trust-node | true | 关闭响应结果校验 | | | --type | | [string] 提议类型,例如:Text/ParameterChange/SoftwareUpgrade | Yes | ## 例子 @@ -91,4 +76,4 @@ iriscli gov submit-proposal --chain-id=test --title="irishub0.7.0 upgrade propos [query-proposal](query-proposal.md) -[query-proposals](query-proposals.md) \ No newline at end of file +[query-proposals](query-proposals.md) diff --git a/docs/zh/cli-client/gov/vote.md b/docs/zh/cli-client/gov/vote.md index 4131e8af1..47d0162eb 100644 --- a/docs/zh/cli-client/gov/vote.md +++ b/docs/zh/cli-client/gov/vote.md @@ -10,31 +10,17 @@ iriscli gov vote [flags] ``` +打印帮助信息: + +``` +iriscli gov vote --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 是否必须 | | ---------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | Yes | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | Yes | -| --from | | [string] 用来签名的私钥名 | Yes | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas | 200000 | [string] 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | | --option | | [string] 投票选项 {Yes, No, NoWithVeto, Abstain} | Yes | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | | --proposal-id | | [string] 投票的提议ID | Yes | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 @@ -68,4 +54,4 @@ Committed at block 989 (tx hash: ABDD88AA3CA8F365AC499427477CCE83ADF09D7FC2D6264 [query-votes](query-votes.md) -[query-tally](query-tally.md) \ No newline at end of file +[query-tally](query-tally.md) From b5e76374abe0c8c9327333eba576f8aa7a8d2d90 Mon Sep 17 00:00:00 2001 From: jiacheng Date: Sun, 18 Nov 2018 11:44:17 +0800 Subject: [PATCH 096/100] Modify the upgrade cli-client --- docs/cli-client/upgrade/info.md | 12 ++++----- docs/cli-client/upgrade/query-switch.md | 12 ++++----- docs/cli-client/upgrade/submit-switch.md | 25 +++++-------------- docs/zh/cli-client/upgrade/info.md | 16 +++++------- docs/zh/cli-client/upgrade/query-switch.md | 12 ++++----- docs/zh/cli-client/upgrade/submit-switch.md | 27 +++++---------------- 6 files changed, 33 insertions(+), 71 deletions(-) diff --git a/docs/cli-client/upgrade/info.md b/docs/cli-client/upgrade/info.md index e90d80522..c2c69e31f 100644 --- a/docs/cli-client/upgrade/info.md +++ b/docs/cli-client/upgrade/info.md @@ -10,17 +10,15 @@ Query the information of software version and upgrade module. iriscli upgrade info ``` +Print help messages: + +``` +iriscli upgrade info --help +``` ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for query | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Example diff --git a/docs/cli-client/upgrade/query-switch.md b/docs/cli-client/upgrade/query-switch.md index b447683fe..7889df017 100644 --- a/docs/cli-client/upgrade/query-switch.md +++ b/docs/cli-client/upgrade/query-switch.md @@ -9,19 +9,17 @@ Query the switch information to know if someone have send the switch message for iriscli upgrade query-switch --proposal-id --voter ``` +Print help messages: + +``` +iriscli upgrade query-switch --help +``` ## Flags | Name, shorthand | Default | Description | Required | | --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | | --proposal-id | | proposalID of upgrade swtich being queried | Yes | | --voter | | Address sign the switch msg | Yes | -| --chain-id | | [string] Chain ID of tendermint node | | -| --height | most recent provable block | block height to query | | -| --help, -h | | help for query | | -| --indent | | Add indent to JSON response | | -| --ledger | | Use a connected Ledger device | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | -| --trust-node | true | Don't verify proofs for responses | | ## Example diff --git a/docs/cli-client/upgrade/submit-switch.md b/docs/cli-client/upgrade/submit-switch.md index 51dee96a9..2e55457ec 100644 --- a/docs/cli-client/upgrade/submit-switch.md +++ b/docs/cli-client/upgrade/submit-switch.md @@ -10,31 +10,18 @@ Submit a switch msg for a upgrade propsal after installing the new software and iriscli upgrade submit-switch [flags] ``` +Print help messages: + +``` +iriscli upgrade submit-switch --help +``` ## Flags | Name, shorthand | Default | Description | Required | | --------------- | --------- | ------------------------------------------------------------ | -------- | | --proposal-id | | proposalID of upgrade proposal | Yes | | --title | | title of switch | | -| --help, -h | | help for submit-switch | | -| --account-number | | [int] AccountNumber number to sign the tx | | -| --async | | Broadcast transactions asynchronously | | -| --chain-id | | [string] Chain ID of tendermint node | Yes | -| --dry-run | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it | | -| --fee | | [string] Fee to pay along with transaction | Yes | -| --from | | [string] Name of private key with which to sign | Yes | -| --from-addr | | [string] Specify from address in generate-only mode | | -| --gas string | 200000 | Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically | | -| --gas-adjustment | 1 | [float] Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored | | -| --generate-only | | Build an unsigned transaction and write it to STDOUT | | -| --indent | | Add indent to JSON response | | -| --json | | return output in json format | | -| --ledger | | Use a connected Ledger device | | -| --memo | | [string] Memo to send along with transaction | | -| --node | tcp://localhost:26657 | [string] \:\ to tendermint rpc interface for this chain | | Yes | -| --print-response | | return tx response (only works with async = false) | | -| --sequence | | [int] Sequence number to sign the tx | | -| --trust-node | true | Don't verify proofs for responses | | + ## Examples Send a switch message for the software upgrade proposal whose `proposalID` is 5. diff --git a/docs/zh/cli-client/upgrade/info.md b/docs/zh/cli-client/upgrade/info.md index 1ad172160..7a8013050 100644 --- a/docs/zh/cli-client/upgrade/info.md +++ b/docs/zh/cli-client/upgrade/info.md @@ -10,19 +10,15 @@ iriscli upgrade info ``` +打印帮助信息: + +``` +iriscli upgrade info --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 必需 | | --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | -| --proposal-id | | 软件升级提议的ID | 是 | -| --voter | | 签名switch消息的地址 | 是 | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON格式的应答中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 @@ -66,4 +62,4 @@ iriscli upgrade info ] } } -``` \ No newline at end of file +``` diff --git a/docs/zh/cli-client/upgrade/query-switch.md b/docs/zh/cli-client/upgrade/query-switch.md index 1aaa09389..a263c0e89 100644 --- a/docs/zh/cli-client/upgrade/query-switch.md +++ b/docs/zh/cli-client/upgrade/query-switch.md @@ -9,6 +9,11 @@ ``` iriscli upgrade query-switch --proposal-id --voter ``` +打印帮助信息: + +``` +iriscli upgrade query-switch --help +``` ## 标志 @@ -16,13 +21,6 @@ iriscli upgrade query-switch --proposal-id --voter | --------------- | -------------------------- | ----------------------------------------------------------------- | -------- | | --proposal-id | | 软件升级提议的ID | 是 | | --voter | | 签名switch消息的地址 | 是 | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --height | 最近可证明区块高度 | [int] 查询的区块高度 | | -| --help, -h | | 查询命令帮助 | | -| --indent | | 在JSON格式的应答中添加缩进 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --node | tcp://localhost:26657 | [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --trust-node | true | 关闭响应结果校验 | | ## 例子 diff --git a/docs/zh/cli-client/upgrade/submit-switch.md b/docs/zh/cli-client/upgrade/submit-switch.md index 61c40bc6e..a1ef824bc 100644 --- a/docs/zh/cli-client/upgrade/submit-switch.md +++ b/docs/zh/cli-client/upgrade/submit-switch.md @@ -9,37 +9,22 @@ ``` iriscli upgrade submit-switch [flags] ``` +打印帮助信息: +``` +iriscli upgrade submit-switch --help +``` ## 标志 | 名称, 速记 | 默认值 | 描述 | 必需 | | --------------- | --------- | ------------------------------------------------------------ | -------- | | --proposal-id | | 软件升级提议的ID | 是 | | --title | | switch消息对标题 | | -| --account-number | | [int] 用来签名交易的AccountNumber | | -| --async | | 异步广播交易 | | -| --chain-id | | [string] tendermint节点的链ID | 是 | -| --description | description | [string] 上传文件的描述信息 | | -| --dry-run | | 忽略--gas标志并进行本地的交易仿真 | | -| --fee | | [string] 支付的交易费用 | 是 | -| --from | | [string] 用来签名的私钥名 | 是 | -| --from-addr | | [string] 指定generate-only模式下的from address | | -| --gas string | 200000 | 单次交易的gas上限; 设置为"simulate"将自动计算相应的阈值 | | -| --gas-adjustment | 1 | [float] 这个调整因子将乘以交易仿真返回的估计值; 如果手动设置了gas的上限，这个标志将被忽略 | | -| --generate-only | | 构建一个未签名交易并将其打印到标准输出 | | -| -h, --help | | 提交命令帮助 | | -| --indent | | 在JSON响应中添加缩进 | | -| --json | | 输出将以json格式返回 | | -| --ledger | | 使用连接的硬件记账设备 | | -| --memo | | [string] 发送交易的备忘录 | | -| --node | tcp://localhost:26657 | [string] [string] tendermint节点开启的远程过程调用接口\<主机>:\<端口> | | -| --print-response | | 返回交易响应 (当且仅当同步模式下使用)) | | -| --sequence | | [int] 用来签名交易的sequence number | | -| --trust-node | true | 关闭响应结果校验 | | + ## 用例 发送对软件升级提议（ID为5）switch消息 ``` iriscli upgrade submit-switch --chain-id=IRISnet --from=x --fee=0.004iris --proposalID 5 --title="Run new verison" -``` \ No newline at end of file +``` From 70ac52ecc67679f42493e7dc9fdac84c898a9755 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sun, 18 Nov 2018 13:43:47 +0800 Subject: [PATCH 097/100] Add docs of stake --- docs/features/stake.md | 184 ++++++++++++++++++++------------------ docs/zh/features/stake.md | 95 +------------------- 2 files changed, 102 insertions(+), 177 deletions(-) diff --git a/docs/features/stake.md b/docs/features/stake.md index 2189c8edd..6a4fa7403 100644 --- a/docs/features/stake.md +++ b/docs/features/stake.md @@ -1,94 +1,106 @@ -# Delegators +# Stake User Guide -## What is a delegator? -People that cannot, or do not want to run validator operations, can still participate in the staking process as delegators. Indeed, validators are not chosen based on their own stake -but based on their total stake, which is the sum of their own stake and of the stake that is delegated to them. This is an important property, as it makes delegators a safeguard against - validators that exhibit bad behavior. If a validator misbehaves, its delegators will move their Atoms away from it, thereby reducing its stake. Eventually, if a validator's stake falls - under the top 100 addresses with highest stake, it will exit the validator set. +## Introduction -## States for a Delegator +This specification briefly introduces the functionality of stake module and what user should do with the provided commands. -Delegators have the same state as their validator. +## Core Concept +1. Voting power -Note that delegation are not necessarily bonded. Tokens of each delegator can be delegated and bonded, delegated and unbonding, delegated and unbonded, or loose. + Voting power is a consensus concept. IRISHUB is a Byzantine-fault-tolerant POS blockchain network. During the consensus process, a set of validators will vote the proposal block. If a validator thinks the proposal block is valid, it will vote `yes`, otherwise, it will vote nil. The votes from different validator don't have the same weight. The weight of a vote is called the voting power of the corresponding validator. + +2. Validator -## Common operation for Delegators + Validator is a full IRISHUB node. As a full nodes, it will sync all blocks and execute all transactions, which will consume much storage and computation resoure. If its voting power is zero, it is just a normal full node or validator candidates or jailed validator. Once its voting power is positive, then it is a validator. + +3. Delegator && Delegation -* Delegation - -To delegate some IRIS token to a validator, you could run the following command: -```$xslt -iriscli stake delegate --address-delegator= --address-validator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --amount=10000000000000000000iris -``` -> Please notice that the amount is under unit iris-atto, 1iris=10^18 iris-atto - -* Query Delegations - -You could query your delegation amount with the following command: - -```$xslt -iriscli stake delegation --address-delegator= --address-validator= --chain-id=fuxi-3001 -``` - -The example output is the following: -```$xslt -Delegation -Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 -Validator: faa1dmp6eyjw94u0wzc67qa03cmgl92qwqaph28lxq -Shares: 10000000000000000000/1Height: 215307 -``` - -> Please notice that the share amount is also correspond to iris-atto, 1iris=10^18 iris-atto - - -* Re-delegate - -Once a delegator has delegated his own IRIS to certain validator, he/she could change the destination of delegation at anytime. If the transaction is executed, the -delegation will be placed at the other's pool after 10 minutes. - -The redelegation operation is composed of two phases: - * redelegate begin - * redelegate complete + People that cannot, or do not want to run validator nodes, can still participate in the staking process as delegators. After delegators delegate some tokens to some validators, then these delegator will gain delegation from corresponding validators. Delegating tokens is called bonding tokens to validators. Later we will have detailed description on it. Besides, a validator operator is also a delegator. Usually, a validator operator only has delegation on its own validator. But it can also have delegation on other validators. + +4. Validator Candidates - To start, you should run the following command: -```$xslt -iriscli stake redelegate begin --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 -``` - -Please note that you have to wait 10 minute to run the next command: - -```$xslt -iriscli stake redelegate complete --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris -``` - -The example output is the following: -```$xslt -Delegation -Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 -Validator: faa1kepndxvjr6gnc8tjcnelp9hqz8jdcs8mvz7m86 -Shares: 10000000000000000000/1Height: 215459 -``` - -* Unbond Delegation - - -Once a delegator has delegated his own IRIS to certain validator, he/she could withdraw the delegation at anytime. If the transaction is executed, the -delegation will become liquid after 10 minutes. - -The redelegation operation is composed of two phases: - * unbond begin - * unbond complete - - To start, you should run the following command: -```$xslt -iriscli stake unbond begin --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 -``` - -Please note that you have to wait 10 minute to run the next command: - -```$xslt -iriscli stake unbond complete --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris -``` - -You could check that the balance of delegator has increased. \ No newline at end of file + The quantity of validators can't increase without limit. Too many validators may result in inefficent consensus which slows down the blockchain TPS. So Byzantine-fault-tolerant POS blockchain network will have a limiation to the validator quantity. Usually, the value is 100. If more than 100 full nodes apply to join validator set. Then only these nodes with top 100 most bounded tokens will be real validators. Others will be validator candidates and will be descending sorted according to their bonded token amount. Once the one or more validators are kicked out from validator set, then the top candidates will be added into validator set automatically. + +5. Bond && Unbond && Unbonding Period + + Validator operators must bond their liquid tokens to their validators. The validator voting power is proportional to the bonded tokens including both self-bonded tokens and tokens from other delegators. Validator operators can lower their own bonded tokens by sending unbond transactions. Delegators can also lower bonded token by sending unbond transactions. However, these unbonded token won't become liquid tokens immediately. After the unbond transactions are executed, the corresponding validator operators or delegators can't sending unbond transactions on the same validators again until the unbonding period is end. Usually the unbonding period is three weeks. Once the unbonding period is end, the unbonded token will become liquid token automatically. The unbonding period mechanism makes great contribution to the security of POS blockchain network. Besides, if the self-bonded token equals to zero, then the corresponding validator will be removed out of validator set. + +6. Redelegate + + Delegators can transfer their delegation from one validator to another one. Redelegation can be devided into two steps: ubond from first validator and bond to another validator. As we have talked above, ubond operation can't be completed immediately until unbonding period is end, which means delegators can't send another redelegation transactions immediately. + +7. Evidence && Slash + + The Byzantine-fault-tolerant POS blockchain network can work well assume that the Byzantine nodes possess less than 1/3 of total voting power. These Byzantine nodes must be punished. So it is necessary to collect the evidence of Byzantine behavior. According to the evidence, stake module will aotumatically slash a certain mount of token from corresponding validators and delegators. The slashed tokens are just burned. Besides, the Byzantine validators will be removed from the validator set and put into jail, which means their voting power is zero. During the jail period, these nodes are not event validator candidates . Once the jail period is end, they can send transactions to unjail themselves and become validator candidates again. + +8. Rewards + + As a delegator, the more bonded tokens it has on validator, the more rewards it will earn. For a validator operator, it will have extra rewards: validator commission. The rewards comes from token inflation and transaction fee. As for how to calculate the rewards and how to get the rewards, please refer to [mint](mint.md) and [distribution](distribution.md). + +## What users can do + +1. Create a full node + + Please refer to [full node](../get-started/Full-Node.md) to create a full node. + +2. Apply to be validator + + Firstly, you have a wallet which has a certain iris tokens. Here we assume you have import your wallet to iriscli key store. + + Then just send a create-validator transaction. This is an example command. + ``` + iriscli stake create-validator --amount=100iris --pubkey=$(iris tendermint show-validator) --moniker= --fee=0.004iris --chain-id= --from= --commission-max-change-rate=0.01 --commission-max-rate=0.2 --commission-rate=0.1 + ``` + The more tokens you specified by `--amount`, the more probability, you will be a real validator. Otherwise, you will just be validator candidate. + +3. Query own validator + + Users can query own validators by their wallet address. But users have to convert their wallet addresses to validator operator address pattern: + ``` + iriscli keys show [key name] --bech=val + ``` + Example response: + ``` + NAME: TYPE: ADDRESS: PUBKEY: + faucet local fva1ljemm0yznz58qxxs8xyak7fashcfxf5l9pe40u fvp1addwnpepqtdme789cpm8zww058ndlhzpwst3s0mxnhdhu5uyps0wjucaufha605ek3w + ``` + Then, example command to query validator: + ``` + iriscli stake validator fva1ljemm0yznz58qxxs8xyak7fashcfxf5l9pe40u + ``` + +4. Edit validator + + ``` + iriscli stake edit-validator --from= --chain-id= --fee=0.004iris --commission-rate=0.15 --moniker= + ``` + +5. Increase self-delegation + + ``` + iriscli stake delegate --address-validator= --chain-id= --from= --fee=0.004iris --amount=100iris + ``` + +6. Delegate tokens to other validators + + If you just want to be a delegator, you can skip the above steps. + ``` + iriscli stake delegate --address-validator= --chain-id= --from= --fee=0.004iris --amount=100iris + ``` + +7. Unbond tokens from a validator + + Unbond half of total bonded token on a given validator + ``` + iriscli stake unbond --address-validator= --chain-id= --from= --fee=0.004iris --amount=100iris --share-percent=0.5 + ``` + +8. Redelegate tokens to another validator + + Redelegate half of total bonded token on a given validator to another one + ``` + iriscli stake redelegate --chain-id= --from= --fee=0.004iris --address-validator-source= --address-validator-dest= --shares-percent=0.5 + ``` + +For other query stake state commands, please refer to [stake cli client](../cli-client/stake/REAMDME.md) diff --git a/docs/zh/features/stake.md b/docs/zh/features/stake.md index 2189c8edd..ca8014141 100644 --- a/docs/zh/features/stake.md +++ b/docs/zh/features/stake.md @@ -1,94 +1,7 @@ -# Delegators +# Stake用户手册 -## What is a delegator? -People that cannot, or do not want to run validator operations, can still participate in the staking process as delegators. Indeed, validators are not chosen based on their own stake -but based on their total stake, which is the sum of their own stake and of the stake that is delegated to them. This is an important property, as it makes delegators a safeguard against - validators that exhibit bad behavior. If a validator misbehaves, its delegators will move their Atoms away from it, thereby reducing its stake. Eventually, if a validator's stake falls - under the top 100 addresses with highest stake, it will exit the validator set. +## 介绍 -## States for a Delegator +本文简要介绍了stake模块的功能以及常见用户接口。 -Delegators have the same state as their validator. - - -Note that delegation are not necessarily bonded. Tokens of each delegator can be delegated and bonded, delegated and unbonding, delegated and unbonded, or loose. - -## Common operation for Delegators - -* Delegation - -To delegate some IRIS token to a validator, you could run the following command: -```$xslt -iriscli stake delegate --address-delegator= --address-validator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --amount=10000000000000000000iris -``` -> Please notice that the amount is under unit iris-atto, 1iris=10^18 iris-atto - -* Query Delegations - -You could query your delegation amount with the following command: - -```$xslt -iriscli stake delegation --address-delegator= --address-validator= --chain-id=fuxi-3001 -``` - -The example output is the following: -```$xslt -Delegation -Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 -Validator: faa1dmp6eyjw94u0wzc67qa03cmgl92qwqaph28lxq -Shares: 10000000000000000000/1Height: 215307 -``` - -> Please notice that the share amount is also correspond to iris-atto, 1iris=10^18 iris-atto - - -* Re-delegate - -Once a delegator has delegated his own IRIS to certain validator, he/she could change the destination of delegation at anytime. If the transaction is executed, the -delegation will be placed at the other's pool after 10 minutes. - -The redelegation operation is composed of two phases: - * redelegate begin - * redelegate complete - - To start, you should run the following command: -```$xslt -iriscli stake redelegate begin --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 -``` - -Please note that you have to wait 10 minute to run the next command: - -```$xslt -iriscli stake redelegate complete --addr-validator-dest= --addr-validator-source= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris -``` - -The example output is the following: -```$xslt -Delegation -Delegator: faa1je9qyff4qate4e0kthum0p8v7q7z8lr7eczsv6 -Validator: faa1kepndxvjr6gnc8tjcnelp9hqz8jdcs8mvz7m86 -Shares: 10000000000000000000/1Height: 215459 -``` - -* Unbond Delegation - - -Once a delegator has delegated his own IRIS to certain validator, he/she could withdraw the delegation at anytime. If the transaction is executed, the -delegation will become liquid after 10 minutes. - -The redelegation operation is composed of two phases: - * unbond begin - * unbond complete - - To start, you should run the following command: -```$xslt -iriscli stake unbond begin --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris --shares-percent=1.0 -``` - -Please note that you have to wait 10 minute to run the next command: - -```$xslt -iriscli stake unbond complete --address-validator= --address-delegator= --chain-id=fuxi-3001 --from=name --gas=2000000 --fee=40000000000000000iris -``` - -You could check that the balance of delegator has increased. \ No newline at end of file +## 核心概念 (TODO) \ No newline at end of file From 1ed5673857a0170ef498f21a0b36cb61c15fd820 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sun, 18 Nov 2018 13:50:12 +0800 Subject: [PATCH 098/100] Remove useless flags --- docs/cli-client/gov/README.md | 18 ++++-------------- docs/zh/cli-client/gov/README.md | 20 +++++--------------- 2 files changed, 9 insertions(+), 29 deletions(-) diff --git a/docs/cli-client/gov/README.md b/docs/cli-client/gov/README.md index deb544f77..9921f50e6 100644 --- a/docs/cli-client/gov/README.md +++ b/docs/cli-client/gov/README.md @@ -12,6 +12,10 @@ This module provides the basic functions as described below: ```shell iriscli gov [command] ``` +Print all supported subcommands and flags: +``` +iriscli distribution --help +``` ## Available Commands @@ -30,20 +34,6 @@ iriscli gov [command] | [deposit](deposit.md) | Deposit tokens for activing proposal | | [vote](vote.md) | vote for an active proposal, options: Yes/No/NoWithVeto/Abstain | -## Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | ------- | ------------- | -------- | -| --help, -h | | help for gov | | - -## Global Flags - -| Name, shorthand | Default | Description | Required | -| --------------- | -------------- | -------------------------------------- | -------- | -| --encoding, -e | hex | [string] Binary encoding (hex ¦ b64 ¦ btc) | | -| --home | $HOME/.iriscli | [string] directory for config and data | | -| --output, -o | text | [string] Output format (text ¦ json) | | -| --trace | | print out full stack trace on errors | | ## Extended description diff --git a/docs/zh/cli-client/gov/README.md b/docs/zh/cli-client/gov/README.md index 4f89d2701..c5c60c34c 100644 --- a/docs/zh/cli-client/gov/README.md +++ b/docs/zh/cli-client/gov/README.md @@ -13,6 +13,11 @@ iriscli gov [command] ``` +打印所以子命令和参数 +``` +iriscli distribution --help +``` + ## 相关命令 | 命令 | 描述 | @@ -30,21 +35,6 @@ iriscli gov [command] | [deposit](deposit.md) | 充值保证金代币以激活提议 | | [vote](vote.md) | 为有效的提议投票，选项：Yes/No/NoWithVeto/Abstain | -## 标志 - -| 名称, 速记 | 默认值 | 描述 | 是否必须 | -| --------------- | ------- | ------------- | -------- | -| --help, -h | | help for gov | | - -## 全局标志 - -| 名称, 速记 | 默认值 | 描述 | 是否必须 | -| --------------- | -------------- | -------------------------------------- | -------- | -| --encoding, -e | hex | [string] Binary encoding (hex ¦ b64 ¦ btc) | | -| --home | $HOME/.iriscli | [string] directory for config and data | | -| --output, -o | text | [string] Output format (text ¦ json) | | -| --trace | | print out full stack trace on errors | | - ## 补充描述 1.任何用户都可以存入一些令牌来发起提案。存款达到一定值min_deposit后，进入投票期，否则将保留存款期。其他人可以在存款期内存入提案。一旦存款总额达到min_deposit，输入投票期。但是，如果冻结时间超过存款期间的max_deposit_period，则提案将被关闭。 From e4ae8b83a8e45d814c9c2aecfd53bcc2ed4433d5 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sun, 18 Nov 2018 13:54:21 +0800 Subject: [PATCH 099/100] Correct some errors --- docs/features/stake.md | 33 ++++++++++++++++------- docs/zh/cli-client/distribution/README.md | 2 +- docs/zh/cli-client/gov/README.md | 2 +- docs/zh/cli-client/stake/README.md | 2 +- 4 files changed, 27 insertions(+), 12 deletions(-) diff --git a/docs/features/stake.md b/docs/features/stake.md index 6a4fa7403..34a847a42 100644 --- a/docs/features/stake.md +++ b/docs/features/stake.md @@ -12,11 +12,11 @@ This specification briefly introduces the functionality of stake module and what 2. Validator - Validator is a full IRISHUB node. As a full nodes, it will sync all blocks and execute all transactions, which will consume much storage and computation resoure. If its voting power is zero, it is just a normal full node or validator candidates or jailed validator. Once its voting power is positive, then it is a validator. + Validator is a full IRISHUB node. As a full nodes, it will sync all blocks and execute all transactions, which will consume much storage and computation resoure. If its voting power is zero, it is just a normal full node or a validator candidate. Once its voting power is positive, then it is a real validator. 3. Delegator && Delegation - People that cannot, or do not want to run validator nodes, can still participate in the staking process as delegators. After delegators delegate some tokens to some validators, then these delegator will gain delegation from corresponding validators. Delegating tokens is called bonding tokens to validators. Later we will have detailed description on it. Besides, a validator operator is also a delegator. Usually, a validator operator only has delegation on its own validator. But it can also have delegation on other validators. + People that cannot, or do not want to run validator nodes, can still participate in the staking process as delegators. After delegating some tokens to validators, delegators will gain delegations from corresponding validators. Delegating tokens is also called bonding tokens to validators. Later we will have detailed description on it. Besides, a validator operator is also a delegator. Usually, a validator operator only has delegation on its own validator. But it can also have delegation on other validators. 4. Validator Candidates @@ -46,29 +46,44 @@ This specification briefly introduces the functionality of stake module and what 2. Apply to be validator - Firstly, you have a wallet which has a certain iris tokens. Here we assume you have import your wallet to iriscli key store. + Firstly, you must have a wallet which has a certain amount of iris tokens. Here we assume you have import your wallet to iriscli key store. Then just send a create-validator transaction. This is an example command. ``` iriscli stake create-validator --amount=100iris --pubkey=$(iris tendermint show-validator) --moniker= --fee=0.004iris --chain-id= --from= --commission-max-change-rate=0.01 --commission-max-rate=0.2 --commission-rate=0.1 ``` - The more tokens you specified by `--amount`, the more probability, you will be a real validator. Otherwise, you will just be validator candidate. + The more tokens specified by `--amount`, the more probability your full node will be a real validator. Otherwise, it will just be validator candidate. -3. Query own validator +3. Query your own validator - Users can query own validators by their wallet address. But users have to convert their wallet addresses to validator operator address pattern: + Users can query their own validators by their wallet address. But firstly users have to convert their wallet addresses to validator operator address pattern: ``` iriscli keys show [key name] --bech=val ``` Example response: ``` NAME: TYPE: ADDRESS: PUBKEY: - faucet local fva1ljemm0yznz58qxxs8xyak7fashcfxf5l9pe40u fvp1addwnpepqtdme789cpm8zww058ndlhzpwst3s0mxnhdhu5uyps0wjucaufha605ek3w + faucet local fva1ljemm0yznz58qxxs8xyak7fashcfxf5l9pe40u fvp1addwnpepqtdme789cpm8zww058ndlhzpwst3s0mxnhdhu5uyps0wjucaufha605ek3w ``` Then, example command to query validator: ``` iriscli stake validator fva1ljemm0yznz58qxxs8xyak7fashcfxf5l9pe40u ``` + Example response: + ```text + Validator + Operator Address: fva1ljemm0yznz58qxxs8xyak7fashcfxf5l9pe40u + Validator Consensus Pubkey: fvp1zcjduepq8fw9p4zfrl5fknrdd9tc2l24jnqel6waxlugn66y66dxasmeuzhsxl6m5e + Jailed: false + Status: Bonded + Tokens: 100.0000000000 + Delegator Shares: 100.0000000000 + Description: {node2 } + Bond Height: 0 + Unbonding Height: 0 + Minimum Unbonding Time: 1970-01-01 00:00:00 +0000 UTC + Commission: {{0.1000000000 0.2000000000 0.0100000000 0001-01-01 00:00:00 +0000 UTC}} + ``` 4. Edit validator @@ -93,7 +108,7 @@ This specification briefly introduces the functionality of stake module and what Unbond half of total bonded token on a given validator ``` - iriscli stake unbond --address-validator= --chain-id= --from= --fee=0.004iris --amount=100iris --share-percent=0.5 + iriscli stake unbond --address-validator= --chain-id= --from= --fee=0.004iris --amount=100iris --share-percent=0.5 ``` 8. Redelegate tokens to another validator @@ -103,4 +118,4 @@ This specification briefly introduces the functionality of stake module and what iriscli stake redelegate --chain-id= --from= --fee=0.004iris --address-validator-source= --address-validator-dest= --shares-percent=0.5 ``` -For other query stake state commands, please refer to [stake cli client](../cli-client/stake/REAMDME.md) +For other query stake state commands, please refer to [stake cli client](../cli-client/stake/README.md) diff --git a/docs/zh/cli-client/distribution/README.md b/docs/zh/cli-client/distribution/README.md index d158ef22d..39b9e0349 100644 --- a/docs/zh/cli-client/distribution/README.md +++ b/docs/zh/cli-client/distribution/README.md @@ -10,7 +10,7 @@ iriscli distribution [subcommand] ``` -打印所以子命令和参数 +打印子命令和参数 ``` iriscli distribution --help diff --git a/docs/zh/cli-client/gov/README.md b/docs/zh/cli-client/gov/README.md index c5c60c34c..fbdfd45e5 100644 --- a/docs/zh/cli-client/gov/README.md +++ b/docs/zh/cli-client/gov/README.md @@ -13,7 +13,7 @@ iriscli gov [command] ``` -打印所以子命令和参数 +打印子命令和参数 ``` iriscli distribution --help ``` diff --git a/docs/zh/cli-client/stake/README.md b/docs/zh/cli-client/stake/README.md index 5cd9e0b55..35af9ff4f 100644 --- a/docs/zh/cli-client/stake/README.md +++ b/docs/zh/cli-client/stake/README.md @@ -10,7 +10,7 @@ Stake模块提供了一系列查询staking状态和发送staking交易的命令 iriscli stake [subcommand] ``` -打印所以子命令和flags： +打印子命令和flags： ``` iriscli stake --help ``` From e5c44101f1d4e3b6a49db0ed78a9272251e3dfa5 Mon Sep 17 00:00:00 2001 From: HaoyangLiu Date: Sun, 18 Nov 2018 15:57:13 +0800 Subject: [PATCH 100/100] Remove useless change on .gitignore --- .gitignore | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 8b7b0e399..ff984d63b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,6 @@ vendor .DS_Store .idea -irishub.iml build/ .out docs/.vuepress/dist/ @@ -12,4 +11,4 @@ client/lcd/statik/statik.go dependency-graph.png tools/protobuf/*.a tools/protobuf/*.o -tools/protobuf/*.so \ No newline at end of file +tools/protobuf/*.so