Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IRISHUB-973:edit docs #888

Merged
merged 29 commits into from
Dec 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
3a3ab68
IRISHUB-973:edit docs
kidinamoto01 Dec 25, 2018
6fa4e0f
Update genesis-file.md
kidinamoto01 Dec 27, 2018
73e49eb
Update service.md
kidinamoto01 Dec 27, 2018
b9c2fbb
Update bech32-prefix.md
kidinamoto01 Dec 27, 2018
855906c
Update bech32-prefix.md
kidinamoto01 Dec 27, 2018
3ea8656
fix conflict
kidinamoto01 Dec 27, 2018
5088419
Update upgrade.md
kidinamoto01 Dec 27, 2018
88613c7
Update upgrade.md
kidinamoto01 Dec 27, 2018
f23d0cd
Update upgrade.md
kidinamoto01 Dec 27, 2018
5668442
Update upgrade.md
kidinamoto01 Dec 27, 2018
cafd85c
Update upgrade.md
kidinamoto01 Dec 27, 2018
80e686d
Merge branch 'release0.9' into release0.9
kidinamoto01 Dec 27, 2018
e787fd0
Update upgrade.md
kidinamoto01 Dec 27, 2018
d2c2473
Update genesis-file.md
kidinamoto01 Dec 27, 2018
02394be
Update distribution.md
kidinamoto01 Dec 27, 2018
53eeb85
Update distribution.md
kidinamoto01 Dec 27, 2018
97ffd10
Update distribution.md
kidinamoto01 Dec 27, 2018
d94e5c1
Update distribution.md
kidinamoto01 Dec 27, 2018
7be6d8d
Update genesis-file.md
kidinamoto01 Dec 27, 2018
f22a303
Update service.md
kidinamoto01 Dec 27, 2018
14f68ae
Delete query-signals.md
kidinamoto01 Dec 27, 2018
c84bff8
Delete query-signals.md
kidinamoto01 Dec 27, 2018
814de32
Update gov-params.md
kidinamoto01 Dec 27, 2018
4aa6d2b
Update genesis-file.md
kidinamoto01 Dec 27, 2018
d37d666
Update governance.md
kidinamoto01 Dec 27, 2018
b819b43
Update governance.md
kidinamoto01 Dec 27, 2018
d62878f
Update upgrade.md
kidinamoto01 Dec 27, 2018
4c67472
Update submit-proposal.md
kidinamoto01 Dec 27, 2018
8cd984c
Update submit-proposal.md
kidinamoto01 Dec 27, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions docs/cli-client/gov/submit-proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,33 +33,6 @@ iriscli gov submit-proposal --help

## Examples

### Submit a 'Text' type proposal

```shell
iriscli gov submit-proposal --chain-id=test --title="notice proposal" --type=Text --description="a new text proposal" --from=node0 --fee=0.01iris
```

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
Committed at block 13 (tx hash: 234463E89B5641F9271113D72B28CA088F641DD8A63DB57257B7CAF90ED5A1C3, response:
{
"code": 0,
"data": "MQ==",
"log": "Msg 0: ",
"info": "",
"gas_wanted": 200000,
"gas_used": 6608,
"codespace": "",
"tags": {
"action": "submit_proposal",
"param": "",
"proposal-id": "1",
"proposer": "faa1x25y3ltr4jvp89upymegvfx7n0uduz5kmh5xuz"
}
})
```

### Submit a 'ParameterChange' type proposal

```shell
Expand Down
5 changes: 4 additions & 1 deletion docs/cli-client/service/bind.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@ iriscli service bind [flags]
## Examples

### Add a binding to an existing service definition
In service binding, you need to define `deposit`, minimum deposit = `price` of this service * `MinDepositMultiple` in genesis file


```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
iriscli service bind --chain-id=test --from=node0 --fee=0.004iris --service-name=test-service --def-chain-id=test --bind-type=Local --deposit=1000iris --prices=1iris --avg-rsp-time=10000 --usable-time=100
```

After that, you're done with adding a binding to an existing service definition.
Expand Down
4 changes: 2 additions & 2 deletions docs/cli-client/stake/delegations-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ iriscli stake delegations-to --help

Query all delegations to one validator
```
iriscli stake delegations-to [validator-address]
iriscli stake delegations-to fva1yclscskdtqu9rgufgws293wxp3njsesx7s40m2
```

After that, you will get all detailed info of delegations from the specified delegator address.
Expand All @@ -27,7 +27,7 @@ After that, you will get all detailed info of delegations from the specified del
[
{
"delegator_addr": "faa13lcwnxpyn2ea3skzmek64vvnp97jsk8qmhl6vx",
"validator_addr": "fva15grv3xg3ekxh9xrf79zd0w077krgv5xf6d6thd",
"validator_addr": "fva1yclscskdtqu9rgufgws293wxp3njsesx7s40m2",
"shares": "0.2000000000",
"height": "290"
}
Expand Down
1 change: 1 addition & 0 deletions docs/cli-client/upgrade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ iriscli upgrade [command]
| Name | Description |
| ------------- | ------------------------------------- |
| [info](info.md) | Query the information of upgrade module |
|[query-signals](query-signals.md)|Query the information of signals |

## Flags

Expand Down
Empty file.
19 changes: 16 additions & 3 deletions docs/features/basic-concepts/bech32-prefix.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Bech32 is a new Bitcoin address format proposed by Pieter Wuille and Greg Maxwel
|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|
|fca| Tendermint Consensus Address|
|fcp| Tendermint Consensus Public Key|

## Encoding

Expand All @@ -22,7 +22,7 @@ Not all interfaces to users IRISnet should be exposed as bech32 interfaces. Many
To covert between other binary reprsentation of addresses and keys, it is important to first apply the Amino enocoding process before bech32 encoding.


## Example
## Account Key Example

Once you create a new address, you should see the following:

Expand All @@ -32,3 +32,16 @@ test1 local faa18ekc4dswwrh2a6lfyev4tr25h5y76jkpqsz7kl fap1addwnpepqgxa
```

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`.

## Validator Key Example

A Tendermint Consensus Public key is generated when the node is created with `iris init`.
You can get this value with
```
iris tendermint show-validator
```

Example output:
```
fcp1zcjduepqwh0tqpqrewe9lrr87ywgjq50gd3m82mgz0qwsmu62s83pukrqsfs5lv2kw
```
2 changes: 1 addition & 1 deletion docs/features/basic-concepts/fee.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ The total gas needed for executing the transaction is the sum of gas needed for

Example
```
iriscli stake unbond complete --from=test --address-validator=faa1mahw6ymzvt2q3lu4pjj5pau2e8krntklgarrxy --address-delegator=faa1mahw6ymzvt2q3lu4pjj5pau2e8krntklgarrxy --fee=2000000000000000iris --gas=20000 --chain-id=test
iriscli stake unbond --from=test --address-validator=faa1mahw6ymzvt2q3lu4pjj5pau2e8krntklgarrxy --address-delegator=faa1mahw6ymzvt2q3lu4pjj5pau2e8krntklgarrxy --fee=0.02iris --gas=20000 --chain-id=test-irishub
```
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.
7 changes: 6 additions & 1 deletion docs/features/basic-concepts/genesis-file.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# 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.
The genesis file sets the initial parameters of any new IRIS network. Establishing a robust social consensus over the genesis file is critical to starting a network.

Each genesis state starts with a list of account balances. Social consensus on these account balances must be bootstrapped from some external process be it events on another blockchain to a token generation event.

## Basic State

Expand Down Expand Up @@ -50,4 +53,6 @@ The Genesis file is the basis for the entire network initialization,which cont

## Gentxs

Gentxs contains the transaction set of creating validators in genesis block.
Gentxs contains the transaction set of creating validators in genesis block.
The IRIS provides robust tools for bootstrapping the identities that will start chain via the gen-tx process. gen-tx or a Genesis Transaction are cryptographically signed transactions that are executed during chain initialization that generate a starting set of validators.
The gen-txs are artifacts that prove that the holders of accounts consent in launching the network and that they putting capital at risk in the process.
23 changes: 16 additions & 7 deletions docs/features/basic-concepts/gov-params.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
# Gov Params
# System Parameters

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.
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 put up a `parameter-change` proposal in governance module.

## Gov Module
## Parameters in Governance 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)
* In `DepositProcedure` step of governance procedure, the following parameters are up to on-chain governance:
* Minimum of deposit as `min_deposit` in genesis file
* Deposit period as `voting_period` in genesis file
* In `VotingProcedure` step of governance procedure, the following parameters are up to on-chain governance:
* Voting period as `voting_period` in genesis file
* In `TallyingProcedure` step of governance procedure, the following parameters are up to on-chain governance:
* Threshold as `threshold` in genesis file to pass a proposal
* Veto percentage as `veto`in genesis file to stop a proposal
* Participation percentage as `participation` in genesis file to make the results legitimate

Details in [gov](../governance.md)

## Service Module
## Parameters in Service Module

* `MaxRequestTimeout` The maximum of waiting blocks for service invocation
* `MinProviderDeposit` The minimum deposit for service binding

Details in [service](../service.md)

25 changes: 22 additions & 3 deletions docs/features/distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,26 @@ This module is in charge of distributing collected transaction fee and inflated

3. Query reward token

Execute the command to get the earned tokens:
Execute the command to get the estimated inflation rewards :

```bash
iriscli bank account [withdraw address]
```
iriscli distribution withdraw-rewards --from=bob --dry-run --chain-id=test-irishub --fee=0.004iris --commit
```

Output is the following,`withdraw-reward-total`is your estimated inflation rewards:

```bash
estimated gas = 6032
simulation code = 0
simulation log = Msg 0:
simulation gas wanted = 200000
simulation gas used = 6032
simulation fee amount = 0
simulation fee denom =
simulation tag action = withdraw-delegator-rewards-all
simulation tag delegator = faa1yclscskdtqu9rgufgws293wxp3njsesxtplqxd
simulation tag withdraw-reward-total = 1308135156755646iris-atto
simulation tag withdraw-reward-from-validator-fva1yclscskdtqu9rgufgws293wxp3njsesx7s40m2 = 1308135156755646iris-atto
simulation tag action = withdraw_delegation_rewards_all

```
5 changes: 4 additions & 1 deletion docs/features/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

## 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
4. On-chain governance proposals on software halt
5. On-chain governance proposals on tax usage

## Interactive process

Expand Down Expand Up @@ -186,4 +189,4 @@ iriscli gov vote --proposal-id=1 --option=Yes --from=x --chain-id=gov-test --fe

# Query the state of a proposal
iriscli gov query-proposal --proposal-id=1
```
```
2 changes: 2 additions & 0 deletions docs/features/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ iriscli service definition --def-chain-id=service-test --service-name=test-servi
```

### Service Binding

In service binding, you need to define `deposit`, minimum deposit = `price` of this service * `MinDepositMultiple` in genesis file
```
# Service Binding
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
Expand Down
23 changes: 6 additions & 17 deletions docs/features/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The module supports the infrastructure of the blockchain software upgrade. It wi
## Interaction Process

### Governance process of software upgrade proposal
1. Submit a software upgrade proposal
1. Submit a software upgrade proposal and vote to make the proposal pass
2. More details about governance process is in GOV [User Guide](governance.md)

### The process of software upgrade
Expand Down Expand Up @@ -75,7 +75,7 @@ The operations in Scenario 1 haven't been implemented at the certain time (80 bl
# 2. Close the old one
kill -f iris

# 3. Install the new version iris1 and start it
# 3. Install the new version iris1 and start it

iris1 start --home=iris

Expand All @@ -89,27 +89,16 @@ iriscli upgrade info --trust-node
iriscli gov submit-proposal --title=Upgrade --description="SoftwareUpgrade" --type="SoftwareUpgrade" --deposit=10iris --from=x --chain-id=upgrade-test --fee=0.05iris --gas=20000 --software=https://github.com/irisnet/irishub/tree/v0.9.0 --version=2 --switch-height=80
```

* `--type` "SoftwareUpgrade" The type of Software upgrade proposals
* `--version` The version of the new protocol
* `--software` The software of the new protocol
* `--type` "SoftwareUpgrade" The type of Software upgrade proposals
* `--version` The version of the new protocol
* `--software` The software of the new protocol
* `--switch-height` The switchheight of the new protocol
* Other parameters can be referrenced in [Gov User Guide](governance.md)
* Only profiler can submit the software upgrade proposal.

```
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
Query the version details of current software

```
iriscli upgrade info --trust-node
```

* Query the version details of current software
16 changes: 8 additions & 8 deletions docs/get-started/Install-the-Software.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ Go to the download page:

https://github.com/irisnet/irishub/releases/

then get the release v0.7.0 on your computer.
then get the release v0.9.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.7.0
v0.9.0

$ iriscli version
v0.7.0
v0.9.0
```

#### Compile Source Code
Expand Down Expand Up @@ -95,7 +95,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.7.0
cd irishub && git checkout v0.9.0
curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
make all
```
Expand All @@ -105,20 +105,20 @@ Now check your **Iris** version.

```
$ iris version
v0.7.0
v0.9.0
$ iriscli version
v0.7.0
v0.9.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.

```
iris unsafe_reset_all --home
iris unsafe-reset-all --home
cd $GOPATH/src/github.com/irisnet/irishub
git fetch -a origin
git checkout v0.7.0
git checkout v0.9.0
make get_vendor_deps
make install
```
6 changes: 3 additions & 3 deletions docs/get-started/Join-the-Testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ A validator is under the risk of being attacked. You could follow this [guide](.

## 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-4000: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-4000/README.md
* Results for Fuxi-4000 tasks: https://github.com/irisnet/testnets/issues/176
* Task List for Fuxi-6000: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-6000/README.md
* Results for Fuxi-6000 tasks: https://github.com/irisnet/testnets/issues/211

To get more people involved, IRIS foundation decides to send out more tasks in the latest iteration of testnet:Fuxi-5000.
* Task List for Fuxi-5000: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-5000/README.md
* Task List for Fuxi-7000: https://github.com/irisnet/testnets/blob/master/fuxi/fuxi-7000/README.md

## Useful Links

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/Validator-Node.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ iriscli stake create-validator --chain-id=<chain-id> --from=<key name> --fee=0.0
```
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](../)
To read more about fee mechanism in IRISHub, go to this [doc](../features/basic-concepts/fee.md)


In this way, to stake 1IRIS, you need to do:
Expand Down
2 changes: 1 addition & 1 deletion docs/software/monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Please refer to this [document](https://github.com/irisnet/irishub/blob/master/d
```
iristool monitor --validator-address=EAC535EC37EB3AE8D18C623BA4B4C8128BC082D2 \
--account-address=faa1nwpzlrs35nawthal6vz2rjr4k8xjvn7k8l63st \
--chain-id=<chain-id> --node=http://localhost:26657
--chain-id=test-irishub--node=http://localhost:26657
```

Parameters:
Expand Down
Loading