Skip to content

Commit

Permalink
add comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ian-shim committed Feb 29, 2024
1 parent b1678f4 commit 441c768
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
14 changes: 12 additions & 2 deletions api/grpc/churner/churner.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 12 additions & 2 deletions api/proto/churner/churner.proto
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ message ChurnRequest {
// - If any of the quorum fails to register, this entire request will fail.
// - Regardless of whether the specified quorums are full or not, the Churner
// will return parameters for all quorums specified here. The smart contract will
// determine whether to churn out existing operators based on whether the quorums
// have available space.
// determine whether it needs to churn out existing operators based on whether
// the quorums have available space.
// The IDs must be in range [0, 254].
repeated uint32 quorum_ids = 6;
}
Expand All @@ -45,6 +45,16 @@ message ChurnReply {
// The signature signed by the Churner.
SignatureWithSaltAndExpiry signature_with_salt_and_expiry = 1;
// A list of existing operators that get churned out.
// This list will contain the target operators to be churned out for all quorums specified
// in the ChurnRequest even if some quorums may not have any churned out operators.
// It is smart contract's responsibility to determine whether it needs to churn out
// these target operators based on whether the quorums have available space.
//
// For example, if the ChurnRequest specifies quorums 0 and 1 where quorum 0 is full
// and quorum 1 has available space, the ChurnReply will contain the operators to be
// churned out for both quorums 0 and 1 (operators with lowest stake). However,
// smart contract should only churn out the operators for quorum 0 because quorum 1
// has available space without having any operators churned.
// Note: it's possible an operator gets churned out just for one or more quorums
// (rather than entirely churned out for all quorums).
repeated OperatorToChurn operators_to_churn = 2;
Expand Down

0 comments on commit 441c768

Please sign in to comment.