Document ValidatorByConsAddr in consumer module (#675)

* Document ValidatorByConsAddr * Bumps comment Co-authored-by: Daniel <[email protected]> Co-authored-by: Shawn <[email protected]> Co-authored-by: Simon Noetzlin <[email protected]>
cosmos · Jan 25, 2023 · a558c69 · a558c69
1 parent 1e2cd5c
commit a558c69
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/x/ccv/consumer/keeper/validators.go b/x/ccv/consumer/keeper/validators.go
@@ -79,6 +79,16 @@ func (k Keeper) IsValidatorJailed(ctx sdk.Context, addr sdk.ConsAddress) bool {
 
 // ValidatorByConsAddr returns an empty validator
 func (k Keeper) ValidatorByConsAddr(sdk.Context, sdk.ConsAddress) stakingtypes.ValidatorI {
+	/*
+		NOTE:
+
+		The evidence module will call this function when it handles equivocation evidence.
+		The returned value must not be nil and must not have an UNBONDED validator status,
+		or evidence will reject it.
+
+		Also, the slashing module will cal lthis function when it observes downtime. In that case
+		the only requirement on the returned value is that it isn't null.
+	*/
 	return stakingtypes.Validator{}
 }