github.com/palisadeinc/bor@v0.0.0-20230615125219-ab7196213d15/internal/cli/server/proto/server.proto (about)

     1  syntax = "proto3";
     2  
     3  package proto;
     4  
     5  import "google/protobuf/empty.proto";
     6  
     7  option go_package = "/internal/cli/server/proto";
     8  
     9  service Bor {
    10      rpc PeersAdd(PeersAddRequest) returns (PeersAddResponse);
    11  
    12      rpc PeersRemove(PeersRemoveRequest) returns (PeersRemoveResponse);
    13  
    14      rpc PeersList(PeersListRequest) returns (PeersListResponse);
    15  
    16      rpc PeersStatus(PeersStatusRequest) returns (PeersStatusResponse);
    17  
    18      rpc ChainSetHead(ChainSetHeadRequest) returns (ChainSetHeadResponse);
    19  
    20      rpc Status(StatusRequest) returns (StatusResponse);
    21  
    22      rpc ChainWatch(ChainWatchRequest) returns (stream ChainWatchResponse);
    23  
    24      rpc DebugPprof(DebugPprofRequest) returns (stream DebugFileResponse);
    25  
    26      rpc DebugBlock(DebugBlockRequest) returns (stream DebugFileResponse);
    27  }
    28  
    29  message TraceRequest {
    30      int64 number = 1;
    31  }
    32  
    33  message TraceResponse {
    34  
    35  }
    36  
    37  message ChainWatchRequest {
    38  
    39  }
    40  
    41  message ChainWatchResponse {
    42      repeated BlockStub oldchain = 1;
    43      repeated BlockStub newchain = 2;
    44      string type = 3;
    45  }
    46  
    47  message BlockStub {
    48      string hash = 1;
    49      uint64 number = 2;
    50  }
    51  
    52  message PeersAddRequest {
    53      string enode = 1;
    54      bool trusted = 2;
    55  }
    56  
    57  message PeersAddResponse {
    58  }
    59  
    60  message PeersRemoveRequest {
    61      string enode = 1;
    62      bool trusted = 2;
    63  }
    64  
    65  message PeersRemoveResponse {
    66  }
    67  
    68  message PeersListRequest {
    69  }
    70  
    71  message PeersListResponse {
    72      repeated Peer peers = 1;
    73  }
    74  
    75  message PeersStatusRequest {
    76      string enode = 1;
    77  }
    78  
    79  message PeersStatusResponse {
    80      Peer peer = 1;
    81  }
    82  
    83  message Peer {
    84      string id = 1;
    85      string enode = 2;
    86      string enr = 3;
    87      repeated string caps = 4;
    88      string name = 5;
    89      bool trusted = 6;
    90      bool static = 7;
    91  }
    92  
    93  message ChainSetHeadRequest {
    94      uint64 number = 1;
    95  }
    96  
    97  message ChainSetHeadResponse {
    98  }
    99  
   100  message StatusRequest {
   101      bool Wait = 1;
   102  }
   103  
   104  message StatusResponse {
   105      Header currentBlock = 1;
   106      Header currentHeader = 2;
   107      int64 numPeers = 3;
   108      string syncMode = 4;
   109      Syncing syncing = 5;
   110      repeated Fork forks = 6;
   111  
   112      message Fork {
   113          string name = 1;
   114          int64 block = 2;
   115          bool disabled = 3;
   116      }
   117  
   118      message Syncing {
   119          int64 startingBlock = 1;
   120          int64 highestBlock = 2;
   121          int64 currentBlock = 3;
   122      }
   123  }
   124  
   125  message Header {
   126      string hash = 1;
   127      uint64 number = 2;
   128  }
   129  
   130  message DebugPprofRequest {
   131      Type type = 1;
   132  
   133      string profile = 2;
   134  
   135      int64 seconds = 3;
   136  
   137      enum Type {
   138          LOOKUP = 0;
   139          CPU = 1;
   140          TRACE = 2;
   141      }
   142  }
   143  
   144  message DebugBlockRequest {
   145      int64 number = 1;
   146  }
   147  
   148  message DebugFileResponse {
   149      oneof event {
   150          Open open = 1;
   151          Input input = 2;
   152          google.protobuf.Empty eof = 3;
   153      }
   154  
   155      message Open {
   156          map<string, string> headers = 1;
   157      }
   158  
   159      message Input {
   160          bytes data = 1;    
   161      }
   162  }