Skip to content

Commit e80c9b9

Browse files
wukongchengwukongcheng
authored
Merge pull request #704 from MrXJC/jiacheng/release0.7
The document reverts back to v0.7.0
2 parents c0cfe2f + fd2c2f1 commit e80c9b9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+2162
-880
lines changed

‎docs/.vuepress/config.js

Lines changed: 249 additions & 177 deletions
Large diffs are not rendered by default.

‎docs/cli-client/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,7 @@ Each modules provides a set of command line interfaces. Here we sort these comma
5555
9. [status command](./status/README.md)
5656
10. [tendermint command](./tendermint/README.md)
5757
11. [upgrade command](./upgrade/README.md)
58+
59+
## iriscli config command
60+
61+
The `iriscli config` command interactively configures some default parameters, such as chain-id, home, fee, and node.

‎docs/cli-client/bank/README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
1-
# iriscli
1+
# iriscli bank
2+
3+
## Description
4+
5+
Bank allows you to manage assets in your local account
6+
7+
## Usage:
8+
9+
```
10+
iriscli bank [command]
11+
```
12+
13+
14+
15+
## Available Commands
16+
17+
| Name | Description |
18+
| --------- | ----------------------------------- |
19+
| coin-type | Query coin type |
20+
| account | Query account balance |
21+
| send | Create and sign a send tx |
22+
| sign | Sign transactions generated offline |
23+
24+
## Flags
25+
26+
| Name,shorthand | Default | Description | Required |
27+
| -------------- | ------- | ------------- | -------- |
28+
| -h, --help | | Help for bank | |
29+
30+
## Global Flags
31+
32+
| Name,shorthand | Default | Description | Required |
33+
| --------------------- | -------------- | ------------------------------------------- | -------- |
34+
| -e, --encoding string | hex | String Binary encoding (hex \|b64 \|btc ) | |
35+
| --home string | /root/.iriscli | Directory for config and data | |
36+
| -o, --output string | text | Output format (text \|json) | |
37+
| --trace | | Print out full stack trace on errors | |

‎docs/cli-client/bank/account.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# iriscli bank account
2+
3+
## Description
4+
5+
Querying account information.
6+
7+
## Usage:
8+
9+
```
10+
iriscli bank account [address] [flags]
11+
```
12+
13+
14+
15+
## Flags
16+
17+
| Name,shorthand | Type | Required | Default | Description |
18+
| -------------- | ------ | -------- | --------------------- | ------------------------------------------------------------ |
19+
| -h, --help | | False | | help for account |
20+
| --chain-id | String | False | | Chain ID of tendermint node |
21+
| --height | Int | False | | Block height to query, omit to get most recent provable block |
22+
| --ledger | String | False | | Use a connected Ledger device |
23+
| --node | String | False | tcp://localhost:26657 | <host>:<port> to tendermint rpc interface for this chain |
24+
| --trust-node | String | False | True | Don't verify proofs for responses |
25+
26+
27+
28+
## Global Flags
29+
30+
| Name,shorthand | Default | Description | Required | Type |
31+
| --------------------- | -------------- | ------------------------------------------- | -------- | ------ |
32+
| -e, --encoding string | hex | String Binary encoding (hex \|b64 \|btc ) | False | String |
33+
| --home string | /root/.iriscli | Directory for config and data | False | String |
34+
| -o, --output string | text | Output format (text \|json) | False | String |
35+
| --trace | | Print out full stack trace on errors | False | |
36+
37+
## Examples
38+
39+
### Query account
40+
41+
```
42+
iriscli bank account faa19aamjx3xszzxgqhrh0yqd4hkurkea7f6d429yx
43+
```
44+
45+
After that, you will get the detail info for the account.
46+
47+
```
48+
{
49+
50+
"address": "faa19aamjx3xszzxgqhrh0yqd4hkurkea7f6d429yx",
51+
52+
"coins": [
53+
54+
"50iris"
55+
56+
],
57+
58+
"public_key": {
59+
60+
"type": "tendermint/PubKeySecp256k1",
61+
62+
"value": "AzlCwiA5Tvxwi7lMB/Hihfp2qnaks5Wrrgkg/Jy7sEkF"
63+
64+
},
65+
66+
"account_number": "0",
67+
68+
"sequence": "1"
69+
70+
}
71+
72+
73+
74+
```
75+
If you query an wrrong account, you will get the fellow information.
76+
```
77+
iriscli bank account faa19aamjx3xszzxgqhrh0yqd4hkurkea7f6d429zz
78+
ERROR: decoding bech32 failed: checksum failed. Expected d429yx, got d429zz.
79+
```
80+
If you query an empty account, you will get the fellow information.
81+
```
82+
iriscli bank account faa1kenrwk5k4ng70e5s9zfsttxpnlesx5ps0gfdv7
83+
ERROR: No account with address faa1kenrwk5k4ng70e5s9zfsttxpnlesx5ps0gfdv7 was found in the state.
84+
Are you sure there has been a transaction involving it?
85+
```
86+
87+
88+
## Extended description
89+
90+
Query your account in iris network.
91+
92+
​
93+
94+
95+
96+
​

‎docs/cli-client/bank/coin-type.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# iriscli bank coin-type
2+
3+
## Description
4+
5+
Query a special kind of token in IRISnet. 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`.
6+
7+
8+
## Usage:
9+
10+
```
11+
iriscli bank coin-type [coin_name] [flags]
12+
```
13+
14+
15+
16+
## Flags
17+
18+
| Name,shorthand | Type | Required | Default | Description |
19+
| -------------- | ------ | -------- | --------------------- | ------------------------------------------------------------ |
20+
| -h, --help | | False | | Help for coin-type |
21+
| --chain-id | String | False | | Chain ID of tendermint node |
22+
| --height | Int | False | | Block height to query, omit to get most recent provable block |
23+
| --indent | String | False | | Add indent to JSON response |
24+
| --ledger | String | False | | Use a connected Ledger device |
25+
| --node | String | False | tcp://localhost:26657 | <host>:<port> to tendermint rpc interface for this chain |
26+
| --trust-node | String | False | True | Don't verify proofs for responses |
27+
28+
29+
30+
## Global Flags
31+
32+
| Name,shorthand | Default | Description | Required | Type |
33+
| --------------------- | -------------- | ------------------------------------------- | -------- | ------ |
34+
| -e, --encoding string | hex | String Binary encoding (hex \|b64 \|btc ) | False | String |
35+
| --home string | /root/.iriscli | Directory for config and data | False | String |
36+
| -o, --output string | text | Output format (text \|json) | False | String |
37+
| --trace | | Print out full stack trace on errors | False | |
38+
39+
## Examples
40+
41+
### Query native token iris
42+
43+
```
44+
iriscli bank coin-type iris
45+
```
46+
47+
After that, you will get the detail info for the native token iris
48+
49+
```
50+
[root@ce7da33d46c3 output]# iriscli bank coin-type iris
51+
{
52+
"name": "iris",
53+
"min_unit": {
54+
"denom": "iris-atto",
55+
"decimal": "18"
56+
},
57+
"units": [
58+
{
59+
"denom": "iris",
60+
"decimal": "0"
61+
},
62+
{
63+
"denom": "iris-milli",
64+
"decimal": "3"
65+
},
66+
{
67+
"denom": "iris-micro",
68+
"decimal": "6"
69+
},
70+
{
71+
"denom": "iris-nano",
72+
"decimal": "9"
73+
},
74+
{
75+
"denom": "iris-pico",
76+
"decimal": "12"
77+
},
78+
{
79+
"denom": "iris-femto",
80+
"decimal": "15"
81+
},
82+
{
83+
"denom": "iris-atto",
84+
"decimal": "18"
85+
}
86+
],
87+
"origin": 1,
88+
"desc": "IRIS Network"
89+
}
90+
```
91+
92+
93+
94+
## Extended description
95+
96+
Query a special token in iris network.
97+
98+
​
99+
100+
101+
102+
​

‎docs/cli-client/bank/send.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# iriscli bank send
2+
3+
## Description
4+
5+
Sending tokens to another address.
6+
7+
## Usage:
8+
9+
```
10+
iriscli bank send --to=<account address> --from <key name> --fee=0.004iris --chain-id=<chain-id> --amount=10iris
11+
```
12+
13+
14+
15+
## Flags
16+
17+
| Name,shorthand | Type | Required | Default | Description |
18+
| ---------------- | ------ | -------- | --------------------- | ------------------------------------------------------------ |
19+
| -h, --help | | False | | Help for send |
20+
| --chain-id | String | False | | Chain ID of tendermint node |
21+
| --account-number | int | False | | AccountNumber number to sign the tx |
22+
| --amount | String | True | | Amount of coins to send, for instance: 10iris |
23+
| --async | | | True | Broadcast transactions asynchronously |
24+
| --dry-run | | False | | Ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it |
25+
| --fee | String | True | | Fee to pay along with transaction |
26+
| --from | String | True | | Name of private key with which to sign |
27+
| --from-addr | string | False | | Specify from address in generate-only mode |
28+
| --gas | String | False | 20000 | Gas limit to set per-transaction; set to "simulate" to calculate required gas automatically |
29+
| --gas-adjustment | Float | | 1 | Adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored |
30+
| --generate-only | | | | Build an unsigned transaction and write it to STDOUT |
31+
| --indent | | | | Add indent to JSON response |
32+
| --json | | | | Return output in json format |
33+
| --memo | String | False | | Memo to send along with transaction |
34+
| --print-response | | | | Return tx response (only works with async = false) |
35+
| --sequence | Int | | | Sequence number to sign the tx |
36+
| --to | String | | | Bech32 encoding address to receive coins |
37+
| --ledger | String | False | | Use a connected Ledger device |
38+
| --node | String | False | tcp://localhost:26657 | <host>:<port> to tendermint rpc interface for this chain |
39+
| --trust-node | String | False | True | Don't verify proofs for responses |
40+
41+
42+
43+
## Global Flags
44+
45+
| Name,shorthand | Default | Description | Required | Type |
46+
| --------------------- | -------------- | ------------------------------------------- | -------- | ------ |
47+
| -e, --encoding string | hex | String Binary encoding (hex \|b64 \|btc ) | False | String |
48+
| --home string | /root/.iriscli | Directory for config and data | False | String |
49+
| -o, --output string | text | Output format (text \|json) | False | String |
50+
| --trace | | Print out full stack trace on errors | False | |
51+
52+
## Examples
53+
54+
### Send token to a address
55+
56+
```
57+
iriscli bank send --to=faa19aamjx3xszzxgqhrh0yqd4hkurkea7f6d429yx --from=test --fee=0.004iris --chain-id=irishub-test --amount=10iris
58+
```
59+
60+
After that, you will get the detail info for the send
61+
62+
```
63+
[root@ce7da33d46c3 iriscli]# iriscli bank send --to=faa19aamjx3xszzxgqhrh0yqd4hkurkea7f6d429yx --from=test --fee=0.004iris --chain-id=irishub-test --amount=10iris
64+
Password to sign with 'test':
65+
Committed at block 2265 (tx hash: A60224C8433487D48C8B03B51CB7A2BCB014932A97A55D946E5F30E561E1195E, response: {Code:0 Data:[] Log:Msg 0: Info: GasWanted:200000 GasUsed:4690 Tags:[{Key:[115 101 110 100 101 114] Value:[102 97 97 49 57 97 97 109 106 120 51 120 115 122 122 120 103 113 104 114 104 48 121 113 100 52 104 107 117 114 107 101 97 55 102 54 100 52 50 57 121 120] XXX_NoUnkeyedLiteral:{} XXX_unrecognized:[] XXX_sizecache:0} {Key:[114 101 99 105 112 105 101 110 116] Value:[102 97 97 49 57 97 97 109 106 120 51 120 115 122 122 120 103 113 104 114 104 48 121 113 100 52 104 107 117 114 107 101 97 55 102 54 100 52 50 57 121 120] 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 51 56 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})
66+
{
67+
"tags": {
68+
"completeConsumedTxFee-iris-atto": "\"93800000000000\"",
69+
"recipient": "faa19aamjx3xszzxgqhrh0yqd4hkurkea7f6d429yx",
70+
"sender": "faa19aamjx3xszzxgqhrh0yqd4hkurkea7f6d429yx"
71+
}
72+
}
73+
74+
```

0 commit comments

Comments
 (0)