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

Modify test.md

Browse Source
This commit is contained in:
Nex 2018-10-09 16:48:14 +08:00
parent 645f0d0f9f
commit 796b3ebff6
1 changed files with 121 additions and 181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

300
test.md
View File

@ -1,22 +1,10 @@
## Basic types ## Basic types
### Error
```proto
message Error {
string code = 1; // One of a server-defined set of error codes.
string message = 2; // A human-readable representation of the error.
string target = 3; // The target of the error.
repeated Error details = 4; // An array of details about specific errors that led to this reported error.
}
```
### ClientVersionResponse ### ClientVersionResponse
```proto ```proto
message ClientVersionResponse { message ClientVersionResponse {
Error error = 1; string version = 1; // 节点客户端版本
string version = 2; // 节点客户端版本
} }
``` ```
@ -66,24 +54,6 @@ message Block {
} }
``` ```
### BlockResponse
```proto
message BlockResponse {
Error error = 1;
Block block = 2;
}
```
### TransactionResponse
```proto
message TransactionResponse {
Error error = 1;
Transaction transaction = 2;
}
```
--- ---
## Transaction ledger API ## Transaction ledger API
@ -113,7 +83,6 @@ bdchain.api.ClientVersionResponse
**Response** **Response**
```yaml ```yaml
error: (empty Error object)
version: 'TxLedgerGo/v0.0.1alpha/darwin/go1.11' version: 'TxLedgerGo/v0.0.1alpha/darwin/go1.11'
``` ```
@ -133,7 +102,7 @@ message CreateLedgerRequest {
```proto ```proto
message CreateLedgerResponse { message CreateLedgerResponse {
Error error = 1; bool ok = 1;
} }
``` ```
@ -148,7 +117,7 @@ name: 'test'
**Response** **Response**
```yaml ```yaml
error: (empty Error object) ok: true
``` ```
##### 2 ##### 2
@ -164,13 +133,11 @@ On the wire:
name: '' (defualt value) name: '' (defualt value)
``` ```
**Response** **Error**
```yaml ```yaml
error: code: Code.InvalidArgument
code: 'BadArgument' message: 'name must not be empty'
message: 'name must not be empty' details:
target: 'name'
details:
``` ```
--- ---
@ -187,8 +154,7 @@ google.protobuf.Empty
```proto ```proto
message GetLedgersResponse { message GetLedgersResponse {
Error error = 1; repeated string ledgers = 1;
repeated string ledgers = 2;
} }
``` ```
@ -203,7 +169,6 @@ message GetLedgersResponse {
**Response** **Response**
```yaml ```yaml
error: (empty Error object)
ledgers: ledgers:
- 'first' - 'first'
- 'second' - 'second'
@ -233,8 +198,7 @@ message SendTransactionRequest {
```proto ```proto
message SendTransactionResponse { message SendTransactionResponse {
Error error = 1; bytes hash = 1;
bytes hash = 2;
} }
``` ```
@ -254,7 +218,6 @@ transaction:
**Response** **Response**
```yaml ```yaml
error: (empty Error object)
hash: 0xd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5ed (in bytes) hash: 0xd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5ed (in bytes)
``` ```
@ -270,22 +233,17 @@ transaction:
data: null (in bytes) data: null (in bytes)
``` ```
**Response** **Error**
```yaml ```yaml
error: code: Code.InvalidArgument
code: 'BadArgument' message: 'Multiple errors in transaction'
message: 'Multiple errors in transaction' details:
target: 'transaction' - code: Code.InvalidArgument
details: message: 'from must not be empty'
- code: 'EmptyValue' details:
message: 'from must not be empty' - code: Code.InvalidArgument
target: 'from' message: 'to must be a valid 32-byte address'
details: details:
- code: 'MalformedAddress'
message: 'to must be a valid 32-byte address'
target: 'to'
details:
hash: (empty bytes, default value)
``` ```
--- ---
@ -317,7 +275,6 @@ bdchain.api.ClientVersionResponse
**Response** **Response**
```yaml ```yaml
error: (empty Error object)
version: 'AcChainGo/v0.0.1alpha/darwin/go1.11' version: 'AcChainGo/v0.0.1alpha/darwin/go1.11'
``` ```
@ -337,8 +294,7 @@ message BlockNumberRequest {
```proto ```proto
message BlockNumberResponse { message BlockNumberResponse {
Error error = 1; uint64 block_number = 1;
uint64 block_number = 2;
} }
``` ```
@ -353,7 +309,6 @@ ledger: 'test'
**Response** **Response**
```yaml ```yaml
error: (empty Error object)
block_number: 2018 block_number: 2018
``` ```
@ -370,14 +325,11 @@ On the wire:
ledger: '' (defualt value) ledger: '' (defualt value)
``` ```
**Response** **Error**
```yaml ```yaml
error: code: Code.InvalidArgument
code: 'BadArgument' message: 'name must not be empty'
message: 'name must not be empty' details:
target: 'name'
details:
block_number: 0 (default value)
``` ```
--- ---
@ -397,7 +349,7 @@ message GetBlockByNumberRequest {
#### Response #### Response
``` ```
bdchain.api.BlockResponse Block
``` ```
#### Test cases #### Test cases
@ -413,41 +365,39 @@ full_transaction: true
**Response** **Response**
```yaml ```yaml
error: (empty Error object) number: 2018
block: hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
number: 2018 parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes)
hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes) witness: 0x1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad (in bytes)
parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes) timestamp: 2018050400000
witness: 0x1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad (in bytes) size: 20180504
timestamp: 2018050400000 transactions_root: 0x5obada555obada555obada555obada555obada555obada555obada555obada55 (in bytes)
size: 20180504 transactions:
transactions_root: 0x5obada555obada555obada555obada555obada555obada555obada555obada55 (in bytes) - block_number: 2018
transactions: block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
- block_number: 2018 index: 0
block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes) hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes)
index: 0 type: TransactionType.RECORD
hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes) from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
type: TransactionType.RECORD nonce: 2018
from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) to: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
nonce: 2018 data: 0xdeadbeef (in bytes)
to: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) v: 0x25 (in bytes)
data: 0xdeadbeef (in bytes) r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes)
v: 0x25 (in bytes) s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes) - block_number: 2018
s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes) block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
- block_number: 2018 index: 1
block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes) hash: 0x1313131313131313131313131313131313131313131313131313131313131313 (in bytes)
index: 1 type: TransactionType.MESSAGE
hash: 0x1313131313131313131313131313131313131313131313131313131313131313 (in bytes) from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
type: TransactionType.MESSAGE nonce: 2019
from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) to: 0xfeedbabefeedbabefeedbabefeedbabefeedbabefeedbabefeedbabefeedbabe (in bytes)
nonce: 2019 data: (empty bytes, default value)
to: 0xfeedbabefeedbabefeedbabefeedbabefeedbabefeedbabefeedbabefeedbabe (in bytes) v: 0x25 (in bytes)
data: (empty bytes, default value) r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes)
v: 0x25 (in bytes) s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes) transaction_hashes:
s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
transaction_hashes:
``` ```
##### 2 ##### 2
@ -469,19 +419,17 @@ full_transaction: false (defualt value)
**Response** **Response**
```yaml ```yaml
error: (empty Error object) number: 2018
block: hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
number: 2018 parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes)
hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes) witness: 0x1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad (in bytes)
parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes) timestamp: 2018050400000
witness: 0x1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad (in bytes) size: 20180504
timestamp: 2018050400000 transactions_root: 0x5obada555obada555obada555obada555obada555obada555obada555obada55 (in bytes)
size: 20180504 transactions:
transactions_root: 0x5obada555obada555obada555obada555obada555obada555obada555obada55 (in bytes) transaction_hashes:
transactions: - 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes)
transaction_hashes: - 0x1313131313131313131313131313131313131313131313131313131313131313 (in bytes)
- 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes)
- 0x1313131313131313131313131313131313131313131313131313131313131313 (in bytes)
``` ```
--- ---
@ -501,7 +449,7 @@ message GetBlockByHashRequest {
#### Response #### Response
``` ```
bdchain.api.BlockResponse Block
``` ```
#### Test cases #### Test cases
@ -517,19 +465,17 @@ full_transaction: false
**Response** **Response**
```yaml ```yaml
error: (empty Error object) number: 2018
block: hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
number: 2018 parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes)
hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes) witness: 0x1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad (in bytes)
parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes) timestamp: 2018050400000
witness: 0x1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad1fee1bad (in bytes) size: 20180504
timestamp: 2018050400000 transactions_root: 0x5obada555obada555obada555obada555obada555obada555obada555obada55 (in bytes)
size: 20180504 transactions:
transactions_root: 0x5obada555obada555obada555obada555obada555obada555obada555obada55 (in bytes) transaction_hashes:
transactions: - 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes)
transaction_hashes: - 0x1313131313131313131313131313131313131313131313131313131313131313 (in bytes)
- 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes)
- 0x1313131313131313131313131313131313131313131313131313131313131313 (in bytes)
``` ```
--- ---
@ -548,7 +494,7 @@ message GetTransactionByHashRequest {
#### Response #### Response
``` ```
bdchain.api.TransactionResponse Transaction
``` ```
#### Test cases #### Test cases
@ -563,20 +509,18 @@ hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in byt
**Response** **Response**
```yaml ```yaml
error: (empty Error object) block_number: 2018
transaction: block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
block_number: 2018 index: 0
block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes) hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes)
index: 0 type: TransactionType.RECORD
hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes) from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
type: TransactionType.RECORD nonce: 2018
from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) to: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
nonce: 2018 data: 0xdeadbeef (in bytes)
to: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) v: 0x25 (in bytes)
data: 0xdeadbeef (in bytes) r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes)
v: 0x25 (in bytes) s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes)
s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
``` ```
--- ---
@ -596,7 +540,7 @@ message GetTransactionByBlockNumberAndIndexRequest {
#### Response #### Response
``` ```
bdchain.api.TransactionResponse Transaction
``` ```
#### Test cases #### Test cases
@ -612,20 +556,18 @@ index: 0
**Response** **Response**
```yaml ```yaml
error: (empty Error object) block_number: 2018
transaction: block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
block_number: 2018 index: 0
block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes) hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes)
index: 0 type: TransactionType.RECORD
hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes) from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
type: TransactionType.RECORD nonce: 2018
from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) to: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
nonce: 2018 data: 0xdeadbeef (in bytes)
to: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) v: 0x25 (in bytes)
data: 0xdeadbeef (in bytes) r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes)
v: 0x25 (in bytes) s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes)
s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
``` ```
--- ---
@ -645,7 +587,7 @@ message GetTransactionByBlockHashAndIndexRequest {
#### Response #### Response
``` ```
bdchain.api.TransactionResponse Transaction
``` ```
#### Test cases #### Test cases
@ -661,18 +603,16 @@ index: 0
**Response** **Response**
```yaml ```yaml
error: (empty Error object) block_number: 2018
transaction: block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
block_number: 2018 index: 0
block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes) hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes)
index: 0 type: TransactionType.RECORD
hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in bytes) from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
type: TransactionType.RECORD nonce: 2018
from: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) to: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes)
nonce: 2018 data: 0xdeadbeef (in bytes)
to: 0xf00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafef00dcafe (in bytes) v: 0x25 (in bytes)
data: 0xdeadbeef (in bytes) r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes)
v: 0x25 (in bytes) s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
r: 0x1b5e176d927f8e9ab405058b2d2457392da3e20f328b16ddabcebc33eaac5fea (in bytes)
s: 0x4ba69724e8f69de52f0125ad8b3c5c2cef33019bac3249e2c0a2192766d1721c (in bytes)
``` ```