github.com/hyperledger/burrow@v0.34.5-0.20220512172541-77f09336001d/protobuf/rpcquery.proto (about)

     1  syntax = 'proto3';
     2  
     3  package rpcquery;
     4  
     5  option go_package = "github.com/hyperledger/burrow/rpc/rpcquery";
     6  
     7  import "gogoproto/gogo.proto";
     8  import "tendermint/types/types.proto";
     9  
    10  import "names.proto";
    11  import "acm.proto";
    12  import "validator.proto";
    13  import "registry.proto";
    14  import "rpc.proto";
    15  import "payload.proto";
    16  
    17  option (gogoproto.marshaler_all) = true;
    18  option (gogoproto.unmarshaler_all) = true;
    19  option (gogoproto.stable_marshaler_all) = true;
    20  option (gogoproto.sizer_all) = true;
    21  option (gogoproto.goproto_registration) = true;
    22  option (gogoproto.messagename_all) = true;
    23  
    24  service Query {
    25      rpc Status (StatusParam) returns (rpc.ResultStatus);
    26      rpc GetAccount (GetAccountParam) returns (acm.Account);
    27      rpc GetMetadata (GetMetadataParam) returns (MetadataResult);
    28      rpc GetStorage (GetStorageParam) returns (StorageValue);
    29  
    30      rpc ListAccounts (ListAccountsParam) returns (stream acm.Account);
    31  
    32      rpc GetName (GetNameParam) returns (names.Entry);
    33      rpc ListNames (ListNamesParam) returns (stream names.Entry);
    34  
    35      // GetNetworkRegistry returns for each validator address, the list of their identified node at the current state
    36      rpc GetNetworkRegistry (GetNetworkRegistryParam) returns (NetworkRegistry);
    37      rpc GetValidatorSet (GetValidatorSetParam) returns (ValidatorSet);
    38      rpc GetValidatorSetHistory (GetValidatorSetHistoryParam) returns (ValidatorSetHistory);
    39  
    40      rpc GetProposal(GetProposalParam) returns (payload.Ballot);
    41      rpc ListProposals(ListProposalsParam) returns (stream ProposalResult);
    42  
    43      rpc GetStats(GetStatsParam) returns (Stats);
    44  
    45      rpc GetBlockHeader(GetBlockParam) returns (tendermint.types.Header);
    46  }
    47  
    48  message StatusParam {
    49      string BlockTimeWithin = 1;
    50      string BlockSeenTimeWithin = 2;
    51  }
    52  
    53  message GetAccountParam {
    54      bytes Address = 1 [(gogoproto.customtype) = "github.com/hyperledger/burrow/crypto.Address", (gogoproto.nullable) = false];
    55  }
    56  
    57  message GetMetadataParam {
    58      bytes Address = 1 [(gogoproto.customtype) = "github.com/hyperledger/burrow/crypto.Address"];
    59      bytes MetadataHash = 2 [(gogoproto.customtype) = "github.com/hyperledger/burrow/binary.HexBytes"];
    60  }
    61  
    62  message MetadataResult {
    63      string Metadata = 1;
    64  }
    65  
    66  message GetStorageParam {
    67      bytes Address = 1 [(gogoproto.customtype) = "github.com/hyperledger/burrow/crypto.Address", (gogoproto.nullable) = false];
    68      bytes Key = 2 [(gogoproto.customtype) = "github.com/hyperledger/burrow/binary.Word256", (gogoproto.nullable) = false];
    69  }
    70  
    71  message StorageValue {
    72      bytes Value = 1 [(gogoproto.customtype) = "github.com/hyperledger/burrow/binary.HexBytes", (gogoproto.nullable) = false];
    73  }
    74  
    75  message ListAccountsParam {
    76      string Query = 1;
    77  }
    78  
    79  message GetNameParam {
    80      string Name = 1;
    81  }
    82  
    83  message ListNamesParam {
    84      string Query = 1;
    85  }
    86  
    87  message GetNetworkRegistryParam {
    88  
    89  }
    90  
    91  message GetValidatorSetParam {
    92  
    93  }
    94  
    95  message GetValidatorSetHistoryParam {
    96      // Use -1 for all available history
    97      int64 IncludePrevious = 1;
    98  }
    99  
   100  message NetworkRegistry {
   101      repeated RegisteredValidator Set = 1;
   102  }
   103  
   104  message RegisteredValidator {
   105      bytes Address = 1 [(gogoproto.customtype) = "github.com/hyperledger/burrow/crypto.Address", (gogoproto.nullable) = false];
   106      registry.NodeIdentity Node = 2;
   107  }
   108  
   109  message ValidatorSetHistory {
   110      repeated ValidatorSet History = 1;
   111  }
   112  
   113  message ValidatorSet {
   114      uint64 height = 1;
   115      repeated validator.Validator Set = 2;
   116  }
   117  
   118  message GetProposalParam {
   119      bytes Hash = 1;
   120  }
   121  
   122  message ListProposalsParam {
   123      bool Proposed = 1;
   124  }
   125  
   126  message ProposalResult {
   127      bytes Hash = 1;
   128      payload.Ballot Ballot = 2;
   129  }
   130  
   131  message GetStatsParam {
   132  
   133  }
   134  
   135  message Stats {
   136      uint64 AccountsWithCode = 1;
   137      uint64 AccountsWithoutCode = 2;
   138  }
   139  
   140  message GetBlockParam {
   141      uint64 Height = 1;
   142  }