Skip to content

Commit 5b22771

Browse files
authored
godoc: update godoc of solomachine status method
1 parent eeb031b commit 5b22771

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

modules/light-clients/06-solomachine/light_client_module.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,9 @@ func (l LightClientModule) VerifyNonMembership(
169169

170170
// Status returns the status of the solo machine client.
171171
// The client may be:
172-
// - Active: if frozen sequence is 0
173-
// - Frozen: otherwise solo machine is frozen
172+
// - Active: if `IsFrozen` is false.
173+
// - Frozen: if `IsFrozen` is true.
174+
// - Unknown: if the client state associated with the provided client identifier is not found.
174175
//
175176
// CONTRACT: clientID is validated in 02-client router, thus clientID is assumed here to have the format 06-solomachine-{n}.
176177
func (l LightClientModule) Status(ctx sdk.Context, clientID string) exported.Status {

0 commit comments

Comments
 (0)