docs: wip, add English docs

This commit is contained in:
Nex Zhu 2021-07-22 22:25:57 +08:00
parent a0fab83cef
commit 0d8ac0a76d
No known key found for this signature in database
GPG Key ID: 15C6254AD19362B4
2 changed files with 21 additions and 7 deletions

View File

@ -28,18 +28,26 @@ service Ledger {
} }
message CreateLedgerRequest { message CreateLedgerRequest {
string name = 1; // // Ledger name
//
string name = 1;
} }
message CreateLedgerResponse { message CreateLedgerResponse {
bool ok = 1; // // Boolean value indicating if the ledger is successfully created
//
bool ok = 1;
} }
message GetLedgersResponse { message GetLedgersResponse {
repeated string ledgers = 1; // // List of ledger names
//
repeated string ledgers = 1;
} }
message SendTransactionRequest { message SendTransactionRequest {
string ledger = 1; // // Ledger name
//
string ledger = 1;
message Transaction { message Transaction {
TransactionType type = 1; // type为RECORD (0) TransactionType type = 1; // type为RECORD (0)
bytes from = 2; // 20使 bytes from = 2; // 20使
@ -47,8 +55,12 @@ message SendTransactionRequest {
bytes to = 4; // bytes to = 4; //
bytes data = 5; // bytes data = 5; //
} }
Transaction transaction = 2; // // Transaction info
//
Transaction transaction = 2;
} }
message SendTransactionResponse { message SendTransactionResponse {
bytes hash = 1; // // Hash of the created transaction
//
bytes hash = 1;
} }

View File

@ -17,5 +17,7 @@ service Node {
} }
message ClientVersionResponse { message ClientVersionResponse {
string version = 1; // // Client version
//
string version = 1;
} }