docs: initialize english docs

Author: lanhaoxiang

docs/faq/README.md

@@ -1 +1,42 @@
 # Overview
+
+## witness_node启动常见问题
+
+### 1. 如何判断witness_node在正常运行
+   观察后台日志文件`trusted_node/logs/witness.log`,  如果日志持续在网络上接收区块，表示节点在正常运行, 如下
+   ```
+2018-08-23T07:10:39 th_a:invoke handle_block         handle_block ] Got block: #6939202 time: 2018-08-23T07:10:39 latency: 29 ms from: init6  irreversible: 6939194 (-8)		application.cpp:487
+2018-08-23T07:10:42 th_a:invoke handle_block         handle_block ] Got block: #6939203 time: 2018-08-23T07:10:42 latency: 30 ms from: init4  irreversible: 6939195 (-8)		application.cpp:487
+2018-08-23T07:10:45 th_a:invoke handle_block         handle_block ] Got block: #6939204 time: 2018-08-23T07:10:45 latency: 32 ms from: init0  irreversible: 6939195 (-9)		application.cpp:487
+2018-08-23T07:10:48 th_a:invoke handle_block         handle_block ] Got block: #6939205 time: 2018-08-23T07:10:48 latency: 34 ms from: init5  irreversible: 6939197 (-8)		application.cpp:487
+2018-08-23T07:10:51 th_a:invoke handle_block         handle_block ] Got block: #6939206 time: 2018-08-23T07:10:51 latency: 34 ms from: init1  irreversible: 6939198 (-8)		application.cpp:487
+2018-08-23T07:10:54 th_a:invoke handle_block         handle_block ] Got block: #6939207 time: 2018-08-23T07:10:54 latency: 36 ms from: bob  irreversible: 6939199 (-8)			application.cpp:487
+2018-08-23T07:10:57 th_a:invoke handle_block         handle_block ] Got block: #6939208 time: 2018-08-23T07:10:57 latency: 37 ms from: init1  irreversible: 6939200 (-8)		application.cpp:487
+2018-08-23T07:11:00 th_a:invoke handle_block         handle_block ] Got block: #6939209 time: 2018-08-23T07:11:00 latency: 39 ms from: init7  irreversible: 6939200 (-9)		application.cpp:487
+2018-08-23T07:11:03 th_a:invoke handle_block         handle_block ] Got block: #6939210 time: 2018-08-23T07:11:03 latency: 41 ms from: bao  irreversible: 6939201 (-9)			application.cpp:487
+2018-08-23T07:11:06 th_a:invoke handle_block         handle_block ] Got block: #6939211 time: 2018-08-23T07:11:06 latency: 41 ms from: init8  irreversible: 6939202 (-9)		application.cpp:487
+2018-08-23T07:11:09 th_a:invoke handle_block         handle_block ] Got block: #6939212 time: 2018-08-23T07:11:09 latency: 44 ms from: init2  irreversible: 6939203 (-9)		application.cpp:487
+2018-08-23T07:11:12 th_a:invoke handle_block         handle_block ] Got block: #6939213 time: 2018-08-23T07:11:12 latency: 45 ms from: init4  irreversible: 6939204 (-9)
+   ```
+### 2. 块同步时报错
+   观察后台日志文件`trusted_node/logs/witness.log`,  如果日志持续报错，如`"unlinkable block", "block does not link to known chain"`，这是区块同步出错了。
+
+   解决方法：
+   * 区块同步异常，有可能本地的区块链文件坏掉了。需要停止witness\_node程序，然后删除trusted\_node， 重新启动witness\_node。
+   * 或者不需要删除trusted\_node目录，启动命令加上参数`--resync-blockchain`， 会重新同步区块。
+### 3. 如何正常关闭witness\_node
+   witness_node将所有数据以对象的形式保存在内存，程序正常退出时，会将内存中的数据写入到磁盘，所以不能强行kill掉进程，否则内存数据库会坏掉。
+   * 如果witness\_node没有后台运行，则执行一次Ctrl + C,  然后等待程序保存内存数据后自动退出。
+   * 如果witness\_node运行在后台， 执行`kill -s SIGINT $(pgrep witness_node)`，等待程序保存内存数据后自动退出。不能使用kill -9， 否则下次启动会重建索引，启动比较慢。
+### 4. witness_node进程正常，但不从网络接收区块
+   * 检查后台日志文件, 发现无报错信息, 并且节点没有从网络中接收新区块。此时可能是你的witness_node版本比较低，请及时访问[github release 页面](https://github.com/gxchain/gxb-core/releases/latest) 下载最新的程序包。
+   * 可以通过-v参数，查看witness_node版本号 :
+   ```
+$./programs/witness_node/witness_node -v
+Version: 1.0.180713-379-g4c9a2f4
+SHA: 4c9a2f4e168503abe3ce1432c699f88b8babe356
+Timestamp: 4 hours ago
+SSL: OpenSSL 1.0.2o  27 Mar 2018
+Boost: 1.67
+Websocket++: 0.7.0
+   ```

docs/guide/apis.md

@@ -1,3 +1,120 @@
-# APIs
+# API Reference
+
+GXChain的节点提供WebSocket和JSONRPC两种接口形式
+
+## 区块相关
+
+### `get_block`
+
+通过区块号获取区块信息
+
+``` bash
+curl POST --data '{
+    "jsonrpc": "2.0",
+    "method": "call",
+    "params": [0, "get_block", [1]],
+    "id": 1
+}' https://node1.gxb.io/rpc
+```
+
+根据区块号获取区块信息
+
+### `get_block_header`
+
+``` bash
+curl POST --data '{
+    "jsonrpc": "2.0",
+    "method": "call",
+    "params": [0, "get_block_header", [1]],
+    "id": 1
+}' https://node1.gxb.io/rpc
+```
+
+根据区块号获取区块头信息
+
+## 对象相关
+
+在GXChain里面，通过不同的对象来存储不同类型的数据，常见的有以下几种类型
+
+| ID | Object Type |
+| :--- | :--- |
+| 1.2.x | 帐户对象 |
+| 1.3.x | 资产对象 |
+| 1.5.x | 理事会成员对象 |
+| 1.6.x | 见证人对象 |
+| 1.10.x | 提案对象 |
+| 1.11.x | 操作历史对象 |
+| 1.13.x | 待解冻余额对象 |
+| 1.14.x | 预算项目对象 |
+| 1.25.x | 忠诚计划冻结余额对象 |
+| 2.0.0 | 系统全局参数对象 |
+| 2.1.x | 动态参数对象 |
+| 2.3.x | 资产动态参数对象 |
+| 2.5.x | 帐户余额对象 |
+| 2.6.x | 帐户统计对象 |
+| 2.7.x | 交易对象 |
+| 2.8.x | 区块摘要对象 |
+| 2.9.x | 帐户交易历史对象 |
+| 2.12.x | 见证人调度表对象 |
+
+### `get_objects`
+
+根据对象ID获取对象信息
+
+``` bash
+curl --data '{
+    "jsonrpc": "2.0",
+    "method": "call",
+    "params": [0, "get_objects", [["1.25.100","1.2.200"]]], "id": 1
+}' https://node1.gxb.io/rpc
+```
+
+## 账户相关
+
+### `get_account_by_name`
+
+根据`account_name`获取`account`信息，**不包含**关联对象的信息，如账户资产余额，冻结余额等
+
+``` bash
+curl --data '{
+    "jsonrpc": "2.0",
+    "method": "call",
+    "params": [0, "get_account_by_name", ["nathan"]],
+    "id": 1
+}' https://node1.gxb.io/rpc
+```
+
+### `get_full_accounts`
+
+根据`account_ids`获取完整账户信息，**包含**关联对象的信息，如账户资产余额，冻结余额等
+
+``` bash
+curl --data '{
+    "jsonrpc": "2.0",
+    "method": "call",
+    "params": [0, "get_full_accounts", [["1.2.1"],false]],
+    "id": 1
+}' https://node1.gxb.io/rpc
+```
+
+## 资产相关
+
+### `list_assets`
+
+根据首字母查询资产
+
+### `lookup_asset_symbols`
+
+根据资产名称获取资产详情
+
+
+
+
+
+
+
+
+
+
+
 
-## Overview

docs/guide/asset.md

@@ -0,0 +1,31 @@
+# 创建和发行资产
+
+## 1. 创建资产
+访问[公信宝网页钱包](https://wallet.gxb.io)，导入私钥, 按下图创建资产
+
+![](./assets/asset/create_asset1.png)
+
+![](./assets/asset/create_asset2.png)
+
+填写完成后，点击“创建资产”, 弹出确认页面，点击"确认发送"，完成资产创建。
+
+创建不同长度的资产，需要燃烧的手续费不同(创建资产前，需要向往帐户里发送足够数量的GXS)：
+```
+3字符资产 1000 GXS
+4字符资产 800 GXS
+5字符资产 500 GXS
+```
+
+## 2. 发行资产
+
+资产创建完成后，需要发行资产
+![](./assets/asset/issue_asset1.png)
+![](./assets/asset/issue_asset2.png)
+
+## 3. 发行要点和最佳实践
+
+**1) 按照当前市场流通份额，发送特定数额到基金会账号**
+
+**2) 统一由基金会账号对资产进行分发和使用**
+
+**3) 避免直接发行到非基金会账号下**

docs/guide/assets/asset/create_asset1.png

@@ -0,0 +1,45 @@
+## 获取存储费率
+
+获取数据存储的费率（以KB为单位）
+
+## 请求地址
+
+GET /api/storeFee
+
+## 请求参数
+
+## 响应参数
+
+| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例 |
+| --- | --- | --- | --- | --- | --- |
+| price\_per\_kbyte | Number | Y |  | 每KB需要的GXS数，整数 | 20，实际为20/100000即0.00002GXS/KB |
+
+```
+price_per_kbyte: 确保整数,金额 = 100000 * 实际金额
+```
+
+例子
+
+```js
+{
+    "code":200,
+    "msg":"ok",
+    "data":{
+        "price_per_kbyte":20
+    }
+}
+```
+
+## SDK示例-JAVA
+
+```java
+GetStoreDataFeeReq request = new GetStoreDataFeeReq();
+GxbClient gxbClient = new GxbDefaultClient(storeUrl);
+// 获取返回
+GetStoreDataFeeResp resp = gxbClient.execute(request);
+```
+
+## 错误情况
+
+
+

docs/guide/assets/asset/create_asset2.png

@@ -0,0 +1,43 @@
+## 介绍
+
+通过指定路径获取服务方提供的信息
+
+## 请求地址
+
+GET /provider
+
+## 请求参数
+无
+
+### 例子（以curl为例）
+```sh
+curl https://baas.gxchain.cn/api/storage/provider
+```
+
+## 响应返回
+
+```js
+{
+    "code":200,
+    "msg":"ok",
+    "data":{
+        "account_id":"1.2.639287", // 提供方正式环境baas account id
+        "name":"GXChain Official BaaS Storage",
+        "description":"公信宝BaaS存储+存证服务",
+        "fees":[ // 支持的支付资产类型以及费率
+            {"fee_per_kbytes": 20, "asset_id":"1.3.1"} 
+        ]
+    }
+}
+```
+
+## SDK示例-JAVA
+
+```java
+return new BaasDefaultClient(URL_HEADER + "storage/provider").execute(new ProviderReq());
+```
+
+可参考**com.gxb.block.baas.sdk.client.api.BaasConstants**类
+
+
+

docs/guide/assets/asset/issue_asset1.png

@@ -0,0 +1,49 @@
+## 介绍
+
+通过Cid值获取对应存的数据
+
+## 请求地址
+
+GET /data/{cid}
+
+## 请求参数
+
+| 参数 | 类型 | 必填 | 最大长度 | 描述 | 示例 |
+| --- | --- | --- | --- | --- | --- |
+| cid | String | Y | 64 | 存储数据的Cid值 | QmaZrwThXyZm8Rxs93Tih3L6p4Q8NqYEXp32iN4PeAqDgv |
+
+例子：
+
+```js
+GET /api/data/QmaZrwThXyZm8Rxs93Tih3L6p4Q8NqYEXp32iN4PeAqDgv
+```
+
+## 响应返回
+
+返回一个 QmaZrwThXyZm8Rxs93Tih3L6p4Q8NqYEXp32iN4PeAqDgv.baas 的文件
+
+## SDK示例-JAVA
+
+```java
+// build store client
+// EXAMPLE_ACCOUNT is your account id
+// EXAMPLE_PRIVATE_KEY is your account private key
+// EXAMPLE_PUBLIC_KEY is your account public key
+// * Attention: Your EXAMPLE_PRIVATE_KEY and EXAMPLE_PUBLIC_KEY can not be uploaded.
+StoreClient client = new StoreClient(EXAMPLE_ACCOUNT, EXAMPLE_PRIVATE_KEY, EXAMPLE_PUBLIC_KEY, false);
+// byte[]
+byte[] result = client.getRawBytes(CID);
+// String
+String str = client.getRawString(CID);
+// File
+String file = client.downloadFile(CID,TARGET_FILE); // TARGET_FILE is java.io.File.
+```
+
+## 错误情况
+
+| code | msg | 描述 |
+| --- | --- | --- |
+| 401 | NO\_EXIT | 不存在 |
+
+
+