bdledger-apis/bdledger/api/query.proto

syntax = "proto3";

package bdledger.api;

import "bdledger/api/common.proto";

option go_package = "bdware.org/bdledger/pkg/api/grpc/proto";
option java_package = "bdledger.api.grpc.query";
option java_outer_classname = "QueryProto";
option java_multiple_files = true;

service Query {
  rpc GetBlockByHash (GetBlockByHashRequest) returns (GetBlockByHashResponse);
  rpc GetBlocks (BlocksRequest) returns (GetBlocksResponse); // start_timestamp is required
  rpc CountBlocks (BlocksRequest) returns (CountBlocksResponse);
  rpc GetTransactionByHash (GetTransactionByHashRequest) returns (GetTransactionByHashResponse);
  rpc GetTransactionByBlockHashAndIndex (GetTransactionByBlockHashAndIndexRequest) returns (GetTransactionByBlockHashAndIndexResponse);
  rpc GetTransactions (TransactionsRequest) returns (GetTransactionsResponse);
  rpc CountTransactions (TransactionsRequest) returns (CountTransactionsResponse);
}

message BlockFilter {
  bytes hash = 1;
  int64 timestamp = 2;
}

// repeated Transaction/BlockFilters are combined by "&&"(and) operator;
message TransactionFilter {
  bytes hash = 1;
  bytes from = 2;
  bytes to = 3;
  bytes timestamp = 4;
}

message GetBlockByHashRequest {
  string ledger = 1;
  bytes hash = 2;
  bool full_transactions = 3;
}
message GetBlockByHashResponse {
  Block block = 1;
}

message BlocksRequest {
  string ledger = 1;
  int64 start_timestamp = 2;
  int64 end_timestamp = 3;
  repeated BlockFilter filters = 4;
  enum IncludeTransactions {
    NONE = 0; // 不包含交易数据
    HASH = 1; // 包含交易哈希列表
    FULL = 2; // 包含完整交易列表
  }
  IncludeTransactions include_transactions = 5;
}
message GetBlocksResponse {
  repeated Block blocks = 1;
  int64 start_timestamp = 2;
  int64 end_timestamp = 3;
}
message CountBlocksResponse {
  uint64 count = 1;
  int64 start_timestamp = 2;
  int64 end_timestamp = 3;
}

message GetTransactionByHashRequest {
  string ledger = 1;
  bytes hash = 2;
}
message GetTransactionByHashResponse {
  Transaction transaction = 1;
}

message GetTransactionByBlockHashAndIndexRequest {
  string ledger = 1;
  bytes block_hash = 2;
  uint32 index = 3;
}
message GetTransactionByBlockHashAndIndexResponse {
  Transaction transaction = 1;
}

message TransactionsRequest {
  string ledger = 1;
  int64 start_timestamp = 2; // required
  int64 end_timestamp = 3;
  repeated TransactionFilter filters = 4;
}
message GetTransactionsResponse {
  repeated Transaction transactions = 1;
  int64 start_timestamp = 2;
  int64 end_timestamp = 3;
}
message CountTransactionsResponse {
  uint64 count = 1;
  int64 start_timestamp = 2;
  int64 end_timestamp = 3;
}