dapp/vote:update doc

plugin/dapp/vote/readme.md

@@ -6,7 +6,7 @@
 ### 交易功能
 以下功能需要创建交易，并在链上执行
 
-#### 创建投票组
+#### 创建投票组(CreateGroup)
 
 - 设定投票组名称，管理员和组成员
 - 默认创建者为管理员
@@ -49,9 +49,14 @@ message GroupInfo {
 ```
 ##### 创建交易示例
 
+- 创建交易通用json rpc接口，Chain33.CreateTransaction
+- actionName: CreateGroup
 
+```bash
+curl -kd  '{"method":"Chain33.CreateTransaction","params":[{"execer":"vote","actionName":"CreateGroup","payload":{"name":"group30","admins":[],"members":[{"addr":"1BQXS6TxaYYG5mADaWij4AxhZZUTpw95a5","voteWeight":0}],"description":""}}],"id":0}' http://localhost:8801
+```
 
-#### 更新投票组
+#### 更新投票组(UpdateGroup)
 指定投票组ID，并由管理员添加或删除组成员、管理员
 
 ##### 交易请求
@@ -81,8 +86,16 @@ message GroupInfo {
 
 ```
 
+##### 创建交易示例
+
+- 创建交易通用json rpc接口，Chain33.CreateTransaction
+- actionName: UpdateGroup
 
-#### 创建投票
+```bash
+curl -kd  '{"method":"Chain33.CreateTransaction","params":[{"execer":"vote","actionName":"UpdateGroup","payload":{"groupID":"g000000000000700000","addMembers":[{"addr":"member1","voteWeight":0},{"addr":"member2","voteWeight":0}],"removeMembers":["member3"],"addAdmins":["admin1"],"removeAdmins":["admin2"]}}],"id":0}' http://localhost:8801
+```
+
+#### 创建投票(CreateVote)
 - 由管理员发起
 - 设定投票名称，投票选项，关联投票组ID
 - 关联投票组，即只有这些投票组的成员进行投票
@@ -128,7 +141,16 @@ message VoteOption {
 }
 ```
 
-#### 提交投票
+##### 创建交易示例
+
+- 创建交易通用json rpc接口，Chain33.CreateTransaction
+- actionName: CreateVote
+
+```bash
+curl -kd  '{"method":"Chain33.CreateTransaction","params":[{"execer":"vote","actionName":"CreateVote","payload":{"name":"vote1","groupID":"g000000000000600000","voteOptions":["A","B","C"],"beginTimestamp":"1611562096","endTimestamp":"1611648496","description":""}}],"id":0}' http://localhost:8801
+```
+
+#### 提交投票(CommitVote)
 - 投票组成员发起投票交易
 - 指定所在投票组ID，投票ID，投票选项
 - 投票选项使用数组下标标识，而不是选项内容
@@ -154,7 +176,17 @@ message CommitInfo {
 }
 ```
 
-#### 关闭投票
+##### 创建交易示例
+
+- 创建交易通用json rpc接口，Chain33.CreateTransaction
+- actionName: CommitVote
+
+```bash
+curl -kd  '{"method":"Chain33.CreateTransaction","params":[{"execer":"vote","actionName":"CommitVote","payload":{"voteID":"v000000000001300000","optionIndex":0}}],"id":0}' http://localhost:8801
+
+```
+
+#### 关闭投票(CloseVote)
 - 由管理员发起，将指定投票关闭
 
 ##### 交易请求
@@ -184,7 +216,16 @@ message VoteInfo {
 }
 ```
 
-#### 更新用户信息
+##### 创建交易示例
+
+- 创建交易通用json rpc接口，Chain33.CreateTransaction
+- actionName: CloseVote
+
+```bash
+curl -kd  '{"method":"Chain33.CreateTransaction","params":[{"execer":"vote","actionName":"CloseVote","payload":{"voteID":"v000000000001300000"}}],"id":0}' http://localhost:8801
+```
+
+#### 更新用户信息(UpdateMember)
 - 目前仅支持用户更新名称信息
 
 ##### 交易请求
@@ -206,11 +247,20 @@ message MemberInfo {
 }
 ```
 
+##### 创建交易示例
+
+- 创建交易通用json rpc接口，Chain33.CreateTransaction
+- actionName: UpdateMember
+
+```bash
+ curl -kd  '{"method":"Chain33.CreateTransaction","params":[{"execer":"vote","actionName":"UpdateMember","payload":{"name":"name1"}}],"id":0}' http://localhost:8801
+```
+
 
 ### 查询功能
 以下功能为本地查询，无需创建交易
 
-#### 获取组信息
+#### 获取组信息(GetGroups)
 根据投票组ID查询组信息，支持多个同时查询
 
 ##### 请求结构
@@ -227,8 +277,16 @@ message GroupInfos {
     repeated GroupInfo groupList = 1; //投票组信息列表
 }
 ```
+##### 示例
+
+- 通用查询json rpc接口，Chain33.Query
+- funcName: GetGroups
+
+```bash
+curl -ksd '{"method":"Chain33.Query","params":[{"execer":"vote","funcName":"GetGroups","payload":{"items":["g000000000001700000","g000000000001800000"]}}],"id":0}' http://localhost:8801
+```
 
-#### 获取投票信息
+#### 获取投票信息(GetVotes)
 根据投票ID查询投票信息，支持多个同时查询
 
 ##### 请求结构
@@ -248,7 +306,16 @@ message ReplyVoteList {
 }
 ```
 
-#### 获取成员信息
+##### 示例
+
+- 通用查询json rpc接口，Chain33.Query
+- funcName: GetVotes
+
+```bash
+curl -kd  '{"method":"Chain33.Query","params":[{"execer":"vote","funcName":"GetVotes","payload":{"items":["v000000000001300000","v000000000001400000"]}}],"id":0}' http://localhost:8801
+```
+
+#### 获取成员信息(GetMembers)
 获取用户信息，支持多个同时查询
 
 ##### 请求结构
@@ -272,7 +339,16 @@ message MemberInfo {
 }
 ```
 
-#### 获取投票组列表
+##### 示例
+
+- 通用查询json rpc接口，Chain33.Query
+- funcName: GetMembers
+- 
+```bash
+curl -kd  '{"method":"Chain33.Query","params":[{"execer":"vote","funcName":"GetMembers","payload":{"items":["1BQXS6TxaYYG5mADaWij4AxhZZUTpw95a5"]}}],"id":0}' http://localhost:8801
+```
+
+#### 获取投票组列表(ListGroup)
 
 ##### 请求结构
 ```proto
@@ -291,7 +367,16 @@ message GroupInfos {
 }
 ```
 
-#### 获取投票列表
+##### 示例
+
+- 通用查询json rpc接口，Chain33.Query
+- funcName: ListGroup
+
+```bash
+curl -kd  '{"method":"Chain33.Query","params":[{"execer":"vote","funcName":"ListGroup","payload":{"startItemID":"","count":2,"direction":0}}],"id":0}' http://localhost:8801
+```
+
+#### 获取投票列表(ListVote)
 
 ##### 请求结构
 ```proto
@@ -308,6 +393,7 @@ message ReqListItem {
 }
 ```
 
+
 ##### 响应结构
 ```proto
 message ReplyVoteList {
@@ -318,7 +404,16 @@ message ReplyVoteList {
 }
 ```
 
-#### 获取用户列表
+##### 示例
+
+- 通用查询json rpc接口，Chain33.Query
+- funcName: ListVote
+
+```bash
+curl -kd  '{"method":"Chain33.Query","params":[{"execer":"vote","funcName":"ListVote","payload":{"groupID":"","listReq":{"startItemID":"","count":2,"direction":0}}}],"id":0}' http://localhost:8801
+```
+
+#### 获取用户列表(ListMember)
 
 ##### 请求结构
 
@@ -338,6 +433,15 @@ message MemberInfos {
 }
 ```
 
+##### 示例
+
+- 通用查询json rpc接口，Chain33.Query
+- funcName: ListMember
+
+```bash
+curl -kd  '{"method":"Chain33.Query","params":[{"execer":"vote","funcName":"ListMember","payload":{"startItemID":"","count":1,"direction":1}}],"id":0}' http://localhost:8801
+```
+
 #### 其他
 
 [投票合约proto源文件](proto/vote.proto)