R4R: Update doc for record module #607

yunkunrao · 2018-11-14T11:08:16Z

No description provided.

HaoyangLiu · 2018-11-15T03:34:41Z

docs/zh/cli-client/record/README.md

+| --------------- | ------- | --------------- | -------- |
+| --help, -h      |         | 存证命令帮助     |          |
+
+## 扩展描述


改成## 存证模块的介绍

可否把这块挪到相关命令之前，把英文文档也做这个调整

HaoyangLiu · 2018-11-15T05:54:37Z

docs/zh/cli-client/record/download.md

+iriscli record download --chain-id=test --record-id=MyRecordID --file-name="download.txt"
+```
+
+在这之后，你将在iriscli的home目录下得到指定存证ID的下载文件。


iriscli会先在home目录(default: ~/.irislci)中创建一个用户指定的文件(download.txt)，然后把从链上下载的数据保存在此文件中。

HaoyangLiu · 2018-11-15T05:55:15Z

docs/zh/cli-client/record/query.md

+iriscli record query --chain-id=test --record-id=MyRecordID
+```
+
+在这之后，你将得到存证ID指定的存证的详细信息。


查询到的结果如下所示：

HaoyangLiu · 2018-11-15T05:55:57Z

docs/zh/cli-client/record/submit.md

+iriscli record submit --chain-id="test" --onchain-data="this is my on chain data" --from=node0 --fee=0.1iris
+```
+
+在这之后你已经成功提交了一个存证，但是请记得备份你的存证ID，它是可以用来检索你的存证的唯一方法。


改成

运行成功以后，返回的结果如下：

HaoyangLiu · 2018-11-15T06:01:32Z

docs/zh/cli-client/record/submit.md

+   }
+ }
+```
+


加上

本次存证操作的record-id如下: `"record-id": "record:ab5602bac13f11737e8798dd57869c468194efad2db37625795f1efd8d9d63c6"` 请务必备份record-id，以备将来查询本次存证。若丢失record-id，本次存证再也无法查询到。

HaoyangLiu · 2018-11-15T07:02:09Z

docs/modules/record/README.md


-## Usage
+## Interaction Process


I think Interactive is better

HaoyangLiu · 2018-11-15T07:09:46Z

docs/modules/record/README.md


-```shell
-iriscli record [command]
+### Record process


## Record Introduction

HaoyangLiu · 2018-11-15T07:19:07Z

docs/modules/record/README.md

+
+## Usage Scenarios
+
+### Build Usage Scenarios


This section can be removed. Instead, you can suggest user to start a private testnet and offer a document about how to do it.

OK, I will remove [Build Usage Scenarios] section. And maybe we could add how-to-setup-private-testnet doc in a totally separated doc later for general purpose.

HaoyangLiu · 2018-11-15T07:22:55Z

docs/modules/record/README.md

+{
+   "tags": {
+     "action": "submit-record",
+     "completeConsumedTxFee-iris-atto": "\u0002\ufffd\ufffd\ufffd\ufffd\ufffd\u0000",


The response changed:
"completeConsumedTxFee-iris-atto": "97720000000000",

HaoyangLiu · 2018-11-15T07:26:52Z

docs/modules/record/README.md

-iriscli record [command]
+### 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.


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.

How about change the above sentences to this:

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.

HaoyangLiu · 2018-11-15T07:31:40Z

docs/modules/record/README.md

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


Add description about the architecture of the record module. Please include these points:

Where the recording payload will be saved?

What is the metadata and how to generate it?

Why do we adopt this strategy?

My suggestions are as follows:

Record payload is saved on the target chain as the statement "the metadata of record payload will be recorded on the target chain" says. So I think maybe there's no need to emphasize this again.

I will introduce the meanings of each component in the record metadata.

Record module which enables generating corresponding metadata from uploaded data on the target chain, and it's public and can NOT be tampered with. And that's the way you declare data sovereignty by blockchain.

yunkunrao added 4 commits November 14, 2018 18:18

Rename docs/modules/record -> docs/cli-client/record

deda227

Update Chinese doc for record module

1a4e510

Recover docs/modules/record/README.md

d772a1d

Merge branch 'origin/feature/docs' into yunkun-docs

f1bce19

HaoyangLiu reviewed Nov 15, 2018

View reviewed changes

Update record doc

f55a660

HaoyangLiu reviewed Nov 15, 2018

View reviewed changes

Update docs/modules/record/README.md

763b609

HaoyangLiu approved these changes Nov 15, 2018

View reviewed changes

HaoyangLiu merged commit 1473e9f into irisnet:feature/docs Nov 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

R4R: Update doc for record module #607

R4R: Update doc for record module #607

yunkunrao commented Nov 14, 2018

HaoyangLiu Nov 15, 2018 •

edited

Loading

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018 •

edited

Loading

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018 •

edited

Loading

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

yunkunrao Nov 15, 2018

HaoyangLiu Nov 15, 2018

R4R: Update doc for record module #607

R4R: Update doc for record module #607

Conversation

yunkunrao commented Nov 14, 2018

HaoyangLiu Nov 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HaoyangLiu Nov 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HaoyangLiu Nov 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HaoyangLiu Nov 15, 2018 •

edited

Loading

HaoyangLiu Nov 15, 2018 •

edited

Loading

HaoyangLiu Nov 15, 2018 •

edited

Loading