bdware/bdledger-apis
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update API docs

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/apis.html
View File

@@ -334,6 +334,10 @@
<a href="#bdware.bdledger.api.GetTransactionsResponse"><span class="badge">M</span>GetTransactionsResponse</a>
</li>
<li>
<a href="#bdware.bdledger.api.RecentBlocksRequest"><span class="badge">M</span>RecentBlocksRequest</a>
</li>
<li>
<a href="#bdware.bdledger.api.TransactionFilter"><span class="badge">M</span>TransactionFilter</a>
</li>
@@ -344,7 +348,7 @@
<li>
<a href="#bdware.bdledger.api.BlocksRequest.IncludeTransactions"><span class="badge">E</span>BlocksRequest.IncludeTransactions</a>
<a href="#bdware.bdledger.api.IncludeTransactions"><span class="badge">E</span>IncludeTransactions</a>
</li>
@@ -560,6 +564,13 @@
<td><p>事务所在的区块的哈希，当事务处于待确认状态时为`null` </p></td>
</tr>
<tr>
<td>block_timestamp</td>
<td><a href="#int64">int64</a></td>
<td></td>
<td><p>事务所在的区块产生时的 UNIX 时间戳，单位为秒 </p></td>
</tr>
<tr>
<td>index</td>
<td><a href="#uint32">uint32</a></td>
@@ -967,6 +978,13 @@ field. E.g., &#34;field_violations.field&#34; would identify this field. </p></t
<td><p> </p></td>
</tr>
<tr>
<td>nonce</td>
<td><a href="#uint64">uint64</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
<td>to</td>
<td><a href="#bytes">bytes</a></td>
@@ -1191,7 +1209,7 @@ field. E.g., &#34;field_violations.field&#34; would identify this field. </p></t
<tr>
<td>include_transactions</td>
<td><a href="#bdware.bdledger.api.BlocksRequest.IncludeTransactions">BlocksRequest.IncludeTransactions</a></td>
<td><a href="#bdware.bdledger.api.IncludeTransactions">IncludeTransactions</a></td>
<td></td>
<td><p> </p></td>
</tr>
@@ -1534,6 +1552,44 @@ field. E.g., &#34;field_violations.field&#34; would identify this field. </p></t
<h3 id="bdware.bdledger.api.RecentBlocksRequest">RecentBlocksRequest</h3>
<p></p>
<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
<td>ledger</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
<td>count</td>
<td><a href="#int64">int64</a></td>
<td></td>
<td><p> </p></td>
</tr>
<tr>
<td>include_transactions</td>
<td><a href="#bdware.bdledger.api.IncludeTransactions">IncludeTransactions</a></td>
<td></td>
<td><p> </p></td>
</tr>
</tbody>
</table>
<h3 id="bdware.bdledger.api.TransactionFilter">TransactionFilter</h3>
<p>repeated Transaction/BlockFilters are combined by "&&"(and) operator;</p>
@@ -1626,7 +1682,7 @@ field. E.g., &#34;field_violations.field&#34; would identify this field. </p></t
<h3 id="bdware.bdledger.api.BlocksRequest.IncludeTransactions">BlocksRequest.IncludeTransactions</h3>
<h3 id="bdware.bdledger.api.IncludeTransactions">IncludeTransactions</h3>
<p></p>
<table class="enum-table">
<thead>
@@ -1692,6 +1748,14 @@ start_timestamp is required</p></td>
查询帐本中的所有区块数量，或时间范围内的区块数量</p></td>
</tr>
<tr>
<td>GetRecentBlocks</td>
<td><a href="#bdware.bdledger.api.RecentBlocksRequest">RecentBlocksRequest</a></td>
<td><a href="#bdware.bdledger.api.GetBlocksResponse">GetBlocksResponse</a></td>
<td><p>Get recent &#39;count&#39; blocks (Only support IncludeTransactions=NONE for now)
查询最新的n个区块</p></td>
</tr>
<tr>
<td>GetTransactionByHash</td>
<td><a href="#bdware.bdledger.api.GetTransactionByHashRequest">GetTransactionByHashRequest</a></td>