Modify test.md
This commit is contained in:
Nex
parent
645f0d0f9f
commit
796b3ebff6
98
test.md
98
test.md
@ -1,22 +1,10 @@
|
||||
## 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
|
||||
|
||||
```proto
|
||||
message ClientVersionResponse {
|
||||
Error error = 1;
|
||||
string version = 2; // 节点客户端版本
|
||||
string version = 1; // 节点客户端版本
|
||||
}
|
||||
```
|
||||
|
||||
@ -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
|
||||
@ -113,7 +83,6 @@ bdchain.api.ClientVersionResponse
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
version: 'TxLedgerGo/v0.0.1alpha/darwin/go1.11'
|
||||
```
|
||||
|
||||
@ -133,7 +102,7 @@ message CreateLedgerRequest {
|
||||
|
||||
```proto
|
||||
message CreateLedgerResponse {
|
||||
Error error = 1;
|
||||
bool ok = 1;
|
||||
}
|
||||
```
|
||||
|
||||
@ -148,7 +117,7 @@ name: 'test'
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
ok: true
|
||||
```
|
||||
|
||||
##### 2
|
||||
@ -164,12 +133,10 @@ On the wire:
|
||||
name: '' (defualt value)
|
||||
```
|
||||
|
||||
**Response**
|
||||
**Error**
|
||||
```yaml
|
||||
error:
|
||||
code: 'BadArgument'
|
||||
code: Code.InvalidArgument
|
||||
message: 'name must not be empty'
|
||||
target: 'name'
|
||||
details:
|
||||
```
|
||||
|
||||
@ -187,8 +154,7 @@ google.protobuf.Empty
|
||||
|
||||
```proto
|
||||
message GetLedgersResponse {
|
||||
Error error = 1;
|
||||
repeated string ledgers = 2;
|
||||
repeated string ledgers = 1;
|
||||
}
|
||||
```
|
||||
|
||||
@ -203,7 +169,6 @@ message GetLedgersResponse {
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
ledgers:
|
||||
- 'first'
|
||||
- 'second'
|
||||
@ -233,8 +198,7 @@ message SendTransactionRequest {
|
||||
|
||||
```proto
|
||||
message SendTransactionResponse {
|
||||
Error error = 1;
|
||||
bytes hash = 2;
|
||||
bytes hash = 1;
|
||||
}
|
||||
```
|
||||
|
||||
@ -254,7 +218,6 @@ transaction:
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
hash: 0xd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5edd15ea5ed (in bytes)
|
||||
```
|
||||
|
||||
@ -270,22 +233,17 @@ transaction:
|
||||
data: null (in bytes)
|
||||
```
|
||||
|
||||
**Response**
|
||||
**Error**
|
||||
```yaml
|
||||
error:
|
||||
code: 'BadArgument'
|
||||
code: Code.InvalidArgument
|
||||
message: 'Multiple errors in transaction'
|
||||
target: 'transaction'
|
||||
details:
|
||||
- code: 'EmptyValue'
|
||||
- code: Code.InvalidArgument
|
||||
message: 'from must not be empty'
|
||||
target: 'from'
|
||||
details:
|
||||
- code: 'MalformedAddress'
|
||||
- code: Code.InvalidArgument
|
||||
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**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
version: 'AcChainGo/v0.0.1alpha/darwin/go1.11'
|
||||
```
|
||||
|
||||
@ -337,8 +294,7 @@ message BlockNumberRequest {
|
||||
|
||||
```proto
|
||||
message BlockNumberResponse {
|
||||
Error error = 1;
|
||||
uint64 block_number = 2;
|
||||
uint64 block_number = 1;
|
||||
}
|
||||
```
|
||||
|
||||
@ -353,7 +309,6 @@ ledger: 'test'
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
block_number: 2018
|
||||
```
|
||||
|
||||
@ -370,14 +325,11 @@ On the wire:
|
||||
ledger: '' (defualt value)
|
||||
```
|
||||
|
||||
**Response**
|
||||
**Error**
|
||||
```yaml
|
||||
error:
|
||||
code: 'BadArgument'
|
||||
code: Code.InvalidArgument
|
||||
message: 'name must not be empty'
|
||||
target: 'name'
|
||||
details:
|
||||
block_number: 0 (default value)
|
||||
```
|
||||
|
||||
---
|
||||
@ -397,7 +349,7 @@ message GetBlockByNumberRequest {
|
||||
#### Response
|
||||
|
||||
```
|
||||
bdchain.api.BlockResponse
|
||||
Block
|
||||
```
|
||||
|
||||
#### Test cases
|
||||
@ -413,8 +365,6 @@ full_transaction: true
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
block:
|
||||
number: 2018
|
||||
hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
|
||||
parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes)
|
||||
@ -469,8 +419,6 @@ full_transaction: false (defualt value)
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
block:
|
||||
number: 2018
|
||||
hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
|
||||
parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes)
|
||||
@ -501,7 +449,7 @@ message GetBlockByHashRequest {
|
||||
#### Response
|
||||
|
||||
```
|
||||
bdchain.api.BlockResponse
|
||||
Block
|
||||
```
|
||||
|
||||
#### Test cases
|
||||
@ -517,8 +465,6 @@ full_transaction: false
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
block:
|
||||
number: 2018
|
||||
hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
|
||||
parent_hash: 0xbabefacebabefacebabefacebabefacebabefacebabefacebabefacebabeface (in bytes)
|
||||
@ -548,7 +494,7 @@ message GetTransactionByHashRequest {
|
||||
#### Response
|
||||
|
||||
```
|
||||
bdchain.api.TransactionResponse
|
||||
Transaction
|
||||
```
|
||||
|
||||
#### Test cases
|
||||
@ -563,8 +509,6 @@ hash: 0x0404040404040404040404040404040404040404040404040404040404040404 (in byt
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
transaction:
|
||||
block_number: 2018
|
||||
block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
|
||||
index: 0
|
||||
@ -596,7 +540,7 @@ message GetTransactionByBlockNumberAndIndexRequest {
|
||||
#### Response
|
||||
|
||||
```
|
||||
bdchain.api.TransactionResponse
|
||||
Transaction
|
||||
```
|
||||
|
||||
#### Test cases
|
||||
@ -612,8 +556,6 @@ index: 0
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
transaction:
|
||||
block_number: 2018
|
||||
block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
|
||||
index: 0
|
||||
@ -645,7 +587,7 @@ message GetTransactionByBlockHashAndIndexRequest {
|
||||
#### Response
|
||||
|
||||
```
|
||||
bdchain.api.TransactionResponse
|
||||
Transaction
|
||||
```
|
||||
|
||||
#### Test cases
|
||||
@ -661,8 +603,6 @@ index: 0
|
||||
|
||||
**Response**
|
||||
```yaml
|
||||
error: (empty Error object)
|
||||
transaction:
|
||||
block_number: 2018
|
||||
block_hash: 0xdeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcodedeadcode (in bytes)
|
||||
index: 0
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user