Skip to content

Commit

Permalink
Merge pull request #1748 from irisnet/yelong/asset-docs
Browse files Browse the repository at this point in the history 
R4R: Add vuepress config for asset
  • Loading branch information
@chengwenxi
chengwenxi committed Jul 8, 2019
2 parents ab817cc + 0044f66 commit 506e02d
Show file tree
Hide file tree
Showing 13 changed files with 118 additions and 14 deletions.
20 changes: 18 additions & 2 deletions docs/.vuepress/config.js
View file
Expand Up @@ -68,7 +68,8 @@ module.exports = {
['upgrade.md', 'Upgrade'],
['distribution.md', 'Distribution'],
['guardian.md', 'Guardian'],
['mint.md', 'Mint']
['mint.md', 'Mint'],
['asset.md', 'Asset']
]
}],
'/cli-client/': [{
Expand Down Expand Up @@ -140,6 +141,13 @@ module.exports = {
children: [
['service/', 'iriscli service']
]
},
{
title: 'Asset',
collapsable: false,
children: [
['asset/', 'iriscli asset']
]
}],
'/resources/': [
['validator-faq.md', 'Validator FAQ'],
Expand Down Expand Up @@ -205,7 +213,8 @@ module.exports = {
['upgrade.md', '升级'],
['distribution.md', '收益分配'],
['guardian.md', '系统用户'],
['mint.md', '通胀']
['mint.md', '通胀'],
['asset.md', '资产管理']
]
}],
'/zh/cli-client/': [{
Expand Down Expand Up @@ -277,6 +286,13 @@ module.exports = {
children: [
['service/', 'iriscli service']
]
},
{
title: '资产管理',
collapsable: false,
children: [
['asset/', 'iriscli asset']
]
}],
'/zh/resources/': [
['validator-faq.md', '验证人 FAQ'],
Expand Down
45 changes: 45 additions & 0 deletions docs/cli-client/asset/README.md
View file
@@ -0,0 +1,45 @@
# iriscli asset

## Description

Asset allows you to manage assets on IRIS Hub

## Usage:

```
iriscli asset <command>
```


## Available Commands

| Name | Description |
| --------------------------------------------------- | ----------------------------------------------- |
| [create-gateway](create-gateway.md) | Create a gateway |
| [edit-gateway](edit-gateway.md) | Edit a gateway |
| [transfer-gateway-owner](transfer-gateway-owner.md) | Transfer the ownership of a gateway |
| [issue-token](issue-token.md) | Issue a new token |
| [edit-token](edit-token.md) | Edit an existing token |
| [transfer-token-owner](transfer-token-owner.md) | Transfer the ownership of a token |
| [mint-token](mint-token.md) | Mint tokens to a specified address |
| [query-token](query-token.md) | Query details of a token |
| [query-tokens](query-tokens.md) | Query details of a group of tokens |
| [query-gateway](query-gateway.md) | Query details of a gateway by the given moniker |
| [query-gateways](query-gateways.md) | Query all gateways with an optional owner |
| [query-fee](query-fee.md) | Query the asset related fees |


## Global Flags

| Name,shorthand | Default | Description | Required | Type |
| --------------------- | -------------- | ------------------------------------------- | -------- | ------ |
| -e, --encoding | hex | String Binary encoding (hex\b64\btc ) | False | String |
| --home | /root/.iriscli | Directory for config and data | False | String |
| -o, --output | text | Output format (text\json) | False | String |
| --trace | | Print out full stack trace on errors | False | |

## Flags

| Name,shorthand | Default | Description | Required |
| -------------- | ------- | ------------- | -------- |
| -h, --help | | Help for asset | |
2 changes: 1 addition & 1 deletion docs/cli-client/bank/account.md
View file
Expand Up @@ -18,7 +18,7 @@ iriscli bank account <address> <flags>
| --chain-id | String | False | | Chain ID of tendermint node |
| --height | Int | False | | Block height to query, omit to get most recent provable block |
| --ledger | String | False | | Use a connected Ledger device |
| --node | String | False | tcp://localhost:26657 | <host>:<port> to tendermint rpc interface for this chain |
| --node | String | False | tcp://localhost:26657 | `<host>:<port>`to tendermint rpc interface for this chain |
| --trust-node | String | False | True | Don't verify proofs for responses |


Expand Down
2 changes: 1 addition & 1 deletion docs/cli-client/bank/coin-type.md
View file
Expand Up @@ -20,7 +20,7 @@ Query a special kind of token in IRISnet. The native token in IRIShub is `iris`,
| --height | Int | False | | Block height to query, omit to get most recent provable block |
| --indent | String | False | | Add indent to JSON response |
| --ledger | String | False | | Use a connected Ledger device |
| --node | String | False | tcp://localhost:26657 | <host>:<port> to tendermint rpc interface for this chain |
| --node | String | False | tcp://localhost:26657 | `<host>:<port>`to tendermint rpc interface for this chain |
| --trust-node | String | False | True | Don't verify proofs for responses |


Expand Down
2 changes: 1 addition & 1 deletion docs/cli-client/bank/token-stats.md
View file
Expand Up @@ -19,7 +19,7 @@ Query the token statistic, including total loose tokens, total burned token and
| --height | Int | False | | Block height to query, omit to get most recent provable block |
| --indent | String | False | | Add indent to JSON response |
| --ledger | String | False | | Use a connected Ledger device |
| --node | String | False | tcp://localhost:26657 | <host>:<port> to tendermint rpc interface for this chain |
| --node | String | False | tcp://localhost:26657 | `<host>:<port>`to tendermint rpc interface for this chain |
| --trust-node | String | False | True | Don't verify proofs for responses |


Expand Down
2 changes: 1 addition & 1 deletion docs/cli-client/tx/broadcast.md
View file
Expand Up @@ -18,7 +18,7 @@ iriscli tx broadcast <tx-file> <flags>
| --chain-id | String | False | | Chain ID of tendermint node |
| --height | Int | False | | Block height to query, omit to get most recent provable block |
| --ledger | String | False | | Use a connected Ledger device |
| --node | String | False | tcp://localhost:26657 | <host>:<port> to tendermint rpc interface for this chain |
| --node | String | False | tcp://localhost:26657 | `<host>:<port>`to tendermint rpc interface for this chain |
| --trust-node | String | False | True | Don't verify proofs for responses |

## Examples
Expand Down
43 changes: 43 additions & 0 deletions docs/zh/cli-client/asset/README.md
View file
@@ -0,0 +1,43 @@
# iriscli asset

## 描述

Asset 模块允许你在 IRIS Hub 上发行/管理资产

## 使用方式

```
iriscli asset <command>
```

## 相关命令

| Name | Description |
| --------------------------------------------------- | ---------------------- |
| [create-gateway](create-gateway.md) | 创建网关 |
| [edit-gateway](edit-gateway.md) | 编辑网关信息 |
| [transfer-gateway-owner](transfer-gateway-owner.md) | 转让网关所有权 |
| [issue-token](issue-token.md) | 发行资产 |
| [transfer-token-owner](transfer-token-owner.md) | 转让资产所有权 |
| [edit-token](edit-token.md) | 编辑资产信息 |
| [mint-token](mint-token.md) | 增发资产 |
| [query-token](query-token.md) | 查询资产详情 |
| [query-tokens](query-tokens.md) | 查询资产列表 |
| [query-gateway](query-gateway.md) | 查询网关详情 |
| [query-gateways](query-gateways.md) | 查询网关列表 |
| [query-fee](query-fee.md) | 查询资产管理相关的费用 |

## 标志

| 命令，速记 | 默认值 | 描述 | 是否必须 |
| ---------- | ------ | ------------ | -------- |
| -h, --help | | Asset 模块帮助 | 否 |

## 全局标志

| 命令，速记 | 默认值 | 描述 | 是否必须 |
| --------------------- | -------------- | ----------------------------------- | -------- |
| -e, --encoding | hex | 字符串二进制编码 (hex\b64\btc ) | 否 |
| --home | /root/.iriscli | 配置和数据存储目录 | 否 |
| -o, --output | text | 输出格式 (text\json) | 否 |
| --tr
4 changes: 2 additions & 2 deletions docs/zh/cli-client/bank/README.md
View file
Expand Up @@ -32,7 +32,7 @@

| 命令，速记 | 默认值 | 描述 | 是否必须 |
| --------------------- | -------------- | ----------------------------------- | -------- |
| -e, --encoding | hex | 字符串二进制编码 (hex \|b64 \|btc ) | 否 |
| -e, --encoding | hex | 字符串二进制编码 (hex\b64\btc ) | 否 |
| --home | /root/.iriscli | 配置和数据存储目录 | 否 |
| -o, --output | text | 输出格式 (text \| json) | 否 |
| -o, --output | text | 输出格式 (text\json) | 否 |
| --trace | | 出错时打印完整栈信息 | 否 |
2 changes: 1 addition & 1 deletion docs/zh/cli-client/bank/account.md
View file
Expand Up @@ -19,7 +19,7 @@ iriscli bank account <address> <flags>
| --chain-id | String | 否 | | tendermint 节点Chain ID |
| --height | Int | 否 | | 查询的区块高度用于获取最新的区块。 |
| --ledger | String | 否 | | 使用ledger设备 |
| --node | String | 否 | tcp://localhost:26657 | <主机>:<端口> 链上的tendermint rpc 接口。 |
| --node | String | 否 | tcp://localhost:26657 | `<主机>:<端口>` 链上的tendermint rpc 接口。 |
| --trust-node | String | 否 | True | 不验证响应的证明 |


Expand Down
2 changes: 1 addition & 1 deletion docs/zh/cli-client/bank/coin-type.md
View file
Expand Up @@ -19,7 +19,7 @@
| --height | Int | 否 | | 查询的区块高度用于获取最新的区块。 |
| --indent | String | 否 | | 在JSON响应中增加缩进 |
| --ledger | String | 否 | | 使用ledger设备 |
| --node | String | 否 | tcp://localhost:26657 | <主机>:<端口> 链上的tendermint rpc 接口。 |
| --node | String | 否 | tcp://localhost:26657 | `<主机>:<端口>` 链上的tendermint rpc 接口。 |
| --trust-node | String | 否 | True | 不验证响应的证明 |

## 例子
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/cli-client/bank/token-stats.md
View file
Expand Up @@ -19,7 +19,7 @@
| --height | Int | 否 | | 查询的区块高度用于获取最新的区块。 |
| --indent | String | 否 | | 在JSON响应中增加缩进 |
| --ledger | String | 否 | | 使用ledger设备 |
| --node | String | 否 | tcp://localhost:26657 | <主机>:<端口> 链上的tendermint rpc 接口。 |
| --node | String | 否 | tcp://localhost:26657 | `<主机>:<端口>` 链上的tendermint rpc 接口。 |
| --trust-node | String | 否 | True | 不验证响应的证明 |

##
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/cli-client/tx/broadcast.md
View file
Expand Up @@ -18,7 +18,7 @@ iriscli tx broadcast <tx-file> <flags>
| --chain-id | String | 否 | | tendermint 节点网络ID |
| --height | Int | 否 | | 查询的区块高度用于获取最新的区块。 |
| --ledger | String | 否 | | 使用ledger设备 |
| --node | String | 否 | tcp://localhost:26657 | <主机>:<端口> 链上的tendermint rpc 接口。 |
| --node | String | 否 | tcp://localhost:26657 | `<主机>:<端口>` 链上的tendermint rpc 接口。 |
| --trust-node | String | 否 | True | 不验证响应的证明 |

## 例子
Expand Down
4 changes: 2 additions & 2 deletions docs/zh/features/bank.md
View file
Expand Up @@ -51,7 +51,7 @@
}
}
```
将结果保存到文件<file>。
将结果保存到文件`<file>`。

对上述的离线交易进行签名:
```bash
Expand Down Expand Up @@ -79,7 +79,7 @@
}
}
```
将结果保存到文件<file>。
将结果保存到文件`<file>`。

5. 广播交易

Expand Down

0 comments on commit 506e02d

Please sign in to comment.