github.com/Finschia/finschia-sdk@v0.49.1/proto/lbm/fbridge/v1/query.proto (about)

     1  syntax = "proto3";
     2  package lbm.fbridge.v1;
     3  
     4  option go_package = "github.com/Finschia/finschia-sdk/x/fbridge/types";
     5  
     6  import "google/api/annotations.proto";
     7  import "gogoproto/gogo.proto";
     8  import "cosmos/base/query/v1beta1/pagination.proto";
     9  import "lbm/fbridge/v1/fbridge.proto";
    10  
    11  service Query {
    12    // Params queries the parameters of x/fbridge module.
    13    rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
    14      option (google.api.http).get = "/lbm/fbridge/v1/params";
    15    }
    16  
    17    // NextSeqSend queries the sequence of next bridge request
    18    rpc NextSeqSend(QueryNextSeqSendRequest) returns (QueryNextSeqSendResponse) {
    19      option (google.api.http).get = "/lbm/fbridge/v1/sending/nextseq";
    20    }
    21  
    22    // BlocknumToSeqs queries a list of block numbers for which each sequence has been confirmed.
    23    rpc SeqToBlocknums(QuerySeqToBlocknumsRequest) returns (QuerySeqToBlocknumsResponse) {
    24      option (google.api.http).get = "/lbm/fbridge/v1/sending/blocknums";
    25    }
    26  
    27    // GreatestSeqByOperator queries a greatest sequence number confirmed by a particular operator
    28    rpc GreatestSeqByOperator(QueryGreatestSeqByOperatorRequest) returns (QueryGreatestSeqByOperatorResponse) {
    29      option (google.api.http).get = "/lbm/fbridge/v1/receiving/operators/{operator}/seq";
    30    }
    31  
    32    // GreatestConsecutiveConfirmedSeq queries a greatest consecutive sequence number confirmed by n-of-m operators
    33    rpc GreatestConsecutiveConfirmedSeq(QueryGreatestConsecutiveConfirmedSeqRequest)
    34        returns (QueryGreatestConsecutiveConfirmedSeqResponse) {
    35      option (google.api.http).get = "/lbm/fbridge/v1/receiving/greatest_confirmed_seq";
    36    }
    37  
    38    // SubmittedProvision queries a provision submitted by a particular operator
    39    rpc SubmittedProvision(QuerySubmittedProvisionRequest) returns (QuerySubmittedProvisionResponse) {
    40      option (google.api.http).get = "/lbm/fbridge/v1/receiving/operators/{operator}/provision/{seq}";
    41    }
    42  
    43    // ConfirmedProvision queries a particular sequence of confirmed provisions
    44    rpc ConfirmedProvision(QueryConfirmedProvisionRequest) returns (QueryConfirmedProvisionResponse) {
    45      option (google.api.http).get = "/lbm/fbridge/v1/receiving/provision/{seq}";
    46    }
    47  
    48    // NeededSubmissionSeqs queries a list of sequence numbers that need to be submitted by a particular operator
    49    // The search scope is [greatest_consecutive_seq_by_operator, min(greatest_consecutive_seq_by_operator + range,
    50    // greatest_seq_by_operator)] greatest_consecutive_seq_by_operator can be replaced with greatest_consecutive_seq if
    51    // the operator is newly added
    52    rpc NeededSubmissionSeqs(QueryNeededSubmissionSeqsRequest) returns (QueryNeededSubmissionSeqsResponse) {
    53      option (google.api.http).get = "/lbm/fbridge/v1/receiving/operators/{operator}/needed_submission_seqs";
    54    }
    55  
    56    // Commitments queries commitments of a specific sequence number
    57    rpc Commitments(QueryCommitmentsRequest) returns (QueryCommitmentsResponse) {
    58      option (google.api.http).get = "/lbm/fbridge/v1/receiving/commitments/{seq}";
    59    }
    60  
    61    // Members queries the members of spcific group registered on the bridge
    62    rpc Members(QueryMembersRequest) returns (QueryMembersResponse) {
    63      option (google.api.http).get = "/lbm/fbridge/v1/members";
    64    }
    65  
    66    // Member queries the role of a specific member
    67    rpc Member(QueryMemberRequest) returns (QueryMemberResponse) {
    68      option (google.api.http).get = "/lbm/fbridge/v1/members/{address}";
    69    }
    70  
    71    // Proposals queries a list of SuggestRole Proposals
    72    rpc Proposals(QueryProposalsRequest) returns (QueryProposalsResponse) {
    73      option (google.api.http).get = "/lbm/fbridge/v1/proposals";
    74    }
    75  
    76    // Proposal queries a SuggestRole Proposal
    77    rpc Proposal(QueryProposalRequest) returns (QueryProposalResponse) {
    78      option (google.api.http).get = "/lbm/fbridge/v1/proposals/{proposal_id}";
    79    }
    80  
    81    // Vote queries voted information based on proposalID, voterAddr.
    82    rpc Vote(QueryVoteRequest) returns (QueryVoteResponse) {
    83      option (google.api.http).get = "/lbm/fbridge/v1/proposals/{proposal_id}/votes/{voter}";
    84    }
    85  
    86    // Votes queries votes of a given proposal.
    87    rpc Votes(QueryVotesRequest) returns (QueryVotesResponse) {
    88      option (google.api.http).get = "/lbm/fbridge/v1/proposals/{proposal_id}/votes";
    89    }
    90  
    91    // BridgeStatus queries the status of the bridge
    92    rpc BridgeStatus(QueryBridgeStatusRequest) returns (QueryBridgeStatusResponse) {
    93      option (google.api.http).get = "/lbm/fbridge/v1/status";
    94    }
    95  }
    96  
    97  message QueryParamsRequest {}
    98  
    99  message QueryParamsResponse {
   100    Params params = 1 [(gogoproto.nullable) = false];
   101  }
   102  
   103  message QueryNextSeqSendRequest {}
   104  
   105  message QueryNextSeqSendResponse {
   106    uint64 seq = 1;
   107  }
   108  
   109  message QuerySeqToBlocknumsRequest {
   110    // list of sequence number of the bridge request
   111    repeated uint64 seqs = 1;
   112  }
   113  
   114  message QuerySeqToBlocknumsResponse {
   115    repeated uint64 blocknums = 1;
   116  }
   117  
   118  message QueryGreatestSeqByOperatorRequest {
   119    // the address of the operator
   120    string operator = 1;
   121  }
   122  
   123  message QueryGreatestSeqByOperatorResponse {
   124    uint64 seq = 1;
   125  }
   126  
   127  message QueryGreatestConsecutiveConfirmedSeqRequest {}
   128  
   129  message QueryGreatestConsecutiveConfirmedSeqResponse {
   130    uint64 seq = 1;
   131  }
   132  
   133  message QuerySubmittedProvisionRequest {
   134    // the address of the operator
   135    string operator = 1;
   136    // the sequence number of the bridge request
   137    uint64 seq = 2;
   138  }
   139  
   140  message QuerySubmittedProvisionResponse {
   141    ProvisionData   data   = 1 [(gogoproto.nullable) = false];
   142    ProvisionStatus status = 2 [(gogoproto.nullable) = false];
   143  }
   144  
   145  message QueryNeededSubmissionSeqsRequest {
   146    // the address of the operator
   147    string operator = 1;
   148    // range specifies the size of the range to search
   149    uint64 range = 2;
   150  }
   151  
   152  message QueryNeededSubmissionSeqsResponse {
   153    repeated uint64 seqs = 1;
   154  }
   155  
   156  message QueryConfirmedProvisionRequest {
   157    // the sequence number of the bridge request
   158    uint64 seq = 1;
   159  }
   160  
   161  message QueryConfirmedProvisionResponse {
   162    ProvisionData   data   = 1 [(gogoproto.nullable) = false];
   163    ProvisionStatus status = 2 [(gogoproto.nullable) = false];
   164  }
   165  
   166  message QueryCommitmentsRequest {
   167    // the sequence number of the bridge request
   168    uint64 seq = 1;
   169  }
   170  
   171  message QueryCommitmentsResponse {
   172    repeated string commitments = 1;
   173  }
   174  
   175  message QueryMembersRequest {
   176    // the role name (guardian, operator, judge)
   177    string role = 1;
   178  }
   179  
   180  message QueryMembersResponse {
   181    repeated string members = 1;
   182  }
   183  
   184  message QueryMemberRequest {
   185    string address = 1;
   186  }
   187  
   188  message QueryMemberResponse {
   189    string role = 1;
   190  }
   191  
   192  message QueryProposalsRequest {
   193    // pagination defines an optional pagination for the request.
   194    cosmos.base.query.v1beta1.PageRequest pagination = 1;
   195  }
   196  
   197  message QueryProposalsResponse {
   198    repeated RoleProposal proposals = 1 [(gogoproto.nullable) = false];
   199  
   200    // pagination defines an pagination for the response.
   201    cosmos.base.query.v1beta1.PageResponse pagination = 2;
   202  }
   203  
   204  message QueryProposalRequest {
   205    // the proposal id
   206    uint64 proposal_id = 1;
   207  }
   208  
   209  message QueryProposalResponse {
   210    RoleProposal proposal = 1 [(gogoproto.nullable) = false];
   211  }
   212  
   213  message QueryVoteRequest {
   214    // proposal_id defines the unique id of the proposal.
   215    uint64 proposal_id = 1;
   216  
   217    // voter defines the oter address for the proposals.
   218    string voter = 2;
   219  }
   220  
   221  message QueryVoteResponse {
   222    // vote defined the queried vote.
   223    Vote vote = 1 [(gogoproto.nullable) = false];
   224  }
   225  
   226  message QueryVotesRequest {
   227    // proposal_id defines the unique id of the proposal.
   228    uint64 proposal_id = 1;
   229  }
   230  
   231  message QueryVotesResponse {
   232    // votes defined the queried votes.
   233    repeated Vote votes = 1 [(gogoproto.nullable) = false];
   234  }
   235  
   236  message QueryBridgeStatusRequest {}
   237  
   238  message QueryBridgeStatusResponse {
   239    BridgeStatus         status   = 1;
   240    BridgeStatusMetadata metadata = 2 [(gogoproto.nullable) = false];
   241  }