update API docs

This commit is contained in:
Nex
2020-09-04 12:29:54 +08:00
parent affc42e963
commit c331546099
3 changed files with 170 additions and 12 deletions

View File

@@ -329,6 +329,16 @@
"ismap": false,
"defaultValue": ""
},
{
"name": "block_timestamp",
"description": "事务所在的区块产生时的 UNIX 时间戳,单位为秒",
"label": "",
"type": "int64",
"longType": "int64",
"fullType": "int64",
"ismap": false,
"defaultValue": ""
},
{
"name": "index",
"description": "事务在区块中的位置 index当事务处于待确认状态时为`null`",
@@ -634,6 +644,16 @@
"ismap": false,
"defaultValue": ""
},
{
"name": "nonce",
"description": "",
"label": "",
"type": "uint64",
"longType": "uint64",
"fullType": "uint64",
"ismap": false,
"defaultValue": ""
},
{
"name": "to",
"description": "",
@@ -785,15 +805,15 @@
"name": "bdware/bdledger/api/query.proto",
"description": "",
"package": "bdware.bdledger.api",
"hasEnums": false,
"hasEnums": true,
"hasExtensions": false,
"hasMessages": true,
"hasServices": true,
"enums": [
{
"name": "IncludeTransactions",
"longName": "BlocksRequest.IncludeTransactions",
"fullName": "bdware.bdledger.api.BlocksRequest.IncludeTransactions",
"longName": "IncludeTransactions",
"fullName": "bdware.bdledger.api.IncludeTransactions",
"description": "",
"values": [
{
@@ -901,8 +921,8 @@
"description": "",
"label": "",
"type": "IncludeTransactions",
"longType": "BlocksRequest.IncludeTransactions",
"fullType": "bdware.bdledger.api.BlocksRequest.IncludeTransactions",
"longType": "IncludeTransactions",
"fullType": "bdware.bdledger.api.IncludeTransactions",
"ismap": false,
"defaultValue": ""
}
@@ -1248,6 +1268,47 @@
}
]
},
{
"name": "RecentBlocksRequest",
"longName": "RecentBlocksRequest",
"fullName": "bdware.bdledger.api.RecentBlocksRequest",
"description": "",
"hasExtensions": false,
"hasFields": true,
"extensions": [],
"fields": [
{
"name": "ledger",
"description": "",
"label": "",
"type": "string",
"longType": "string",
"fullType": "string",
"ismap": false,
"defaultValue": ""
},
{
"name": "count",
"description": "",
"label": "",
"type": "int64",
"longType": "int64",
"fullType": "int64",
"ismap": false,
"defaultValue": ""
},
{
"name": "include_transactions",
"description": "",
"label": "",
"type": "IncludeTransactions",
"longType": "IncludeTransactions",
"fullType": "bdware.bdledger.api.IncludeTransactions",
"ismap": false,
"defaultValue": ""
}
]
},
{
"name": "TransactionFilter",
"longName": "TransactionFilter",
@@ -1394,6 +1455,18 @@
"responseFullType": "bdware.bdledger.api.CountBlocksResponse",
"responseStreaming": false
},
{
"name": "GetRecentBlocks",
"description": "Get recent 'count' blocks (Only support IncludeTransactions=NONE for now)\n查询最新的n个区块",
"requestType": "RecentBlocksRequest",
"requestLongType": "RecentBlocksRequest",
"requestFullType": "bdware.bdledger.api.RecentBlocksRequest",
"requestStreaming": false,
"responseType": "GetBlocksResponse",
"responseLongType": "GetBlocksResponse",
"responseFullType": "bdware.bdledger.api.GetBlocksResponse",
"responseStreaming": false
},
{
"name": "GetTransactionByHash",
"description": "Get a transaction identified by its hash\n查询哈希所指定的事务",