use typed string for status

Author: colin-axner

modules/core/02-client/keeper/grpc_query.go

@@ -211,7 +211,7 @@ func (q Keeper) ClientStatus(c context.Context, req *types.QueryClientStatusRequ
 	status := clientState.Status(ctx, clientStore, q.cdc)
 
 	return &types.QueryClientStatusResponse{
-		Status: status,
+		Status: status.String(),
 	}, nil
 }
 

modules/core/02-client/keeper/grpc_query_test.go

@@ -436,7 +436,7 @@ func (suite *KeeperTestSuite) TestQueryClientStatus() {
 					ClientId: path.EndpointA.ClientID,
 				}
 			},
-			true, exported.Active,
+			true, exported.Active.String(),
 		},
 		{
 			"Unknown client status",
@@ -453,7 +453,7 @@ func (suite *KeeperTestSuite) TestQueryClientStatus() {
 					ClientId: path.EndpointA.ClientID,
 				}
 			},
-			true, exported.Unknown,
+			true, exported.Unknown.String(),
 		},
 		{
 			"Frozen client status",
@@ -469,7 +469,7 @@ func (suite *KeeperTestSuite) TestQueryClientStatus() {
 					ClientId: path.EndpointA.ClientID,
 				}
 			},
-			true, exported.Frozen,
+			true, exported.Frozen.String(),
 		},
 	}
 

modules/core/exported/client.go

@@ -8,6 +8,9 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
+// Status represents the status of a client
+type Status string
+
 const (
 	// TypeClientMisbehaviour is the shared evidence misbehaviour type
 	TypeClientMisbehaviour string = "client_misbehaviour"
@@ -23,13 +26,16 @@ const (
 	Localhost string = "09-localhost"
 
 	// Active is a status type of a client. An active client is allowed to be used.
-	Active string = "Active"
+	Active Status = "Active"
 
 	// Frozen is a status type of a client. A frozen client is not allowed to be used.
-	Frozen string = "Frozen"
+	Frozen Status = "Frozen"
+
+	// Expired is a status type of a client. An expired client is not allowed to be used.
+	Expired Status = "Expired"
 
-	// Unknown indicates there was an error in determining the status of a client
-	Unknown string = "Unknown"
+	// Unknown indicates there was an error in determining the status of a client.
+	Unknown Status = "Unknown"
 )
 
 // ClientState defines the required common functions for light clients.
@@ -49,7 +55,7 @@ type ClientState interface {
 
 	// Status function
 	// Clients must return their status. Only Active clients are allowed to process packets.
-	Status(ctx sdk.Context, clientStore sdk.KVStore, cdc codec.BinaryMarshaler) string
+	Status(ctx sdk.Context, clientStore sdk.KVStore, cdc codec.BinaryMarshaler) Status
 
 	// Genesis function
 	ExportMetadata(sdk.KVStore) []GenesisMetadata
@@ -233,3 +239,8 @@ type GenesisMetadata interface {
 	// returns metadata value
 	GetValue() []byte
 }
+
+// String returns the string representation of a client status.
+func (s Status) String() string {
+	return string(s)
+}

modules/light-clients/06-solomachine/types/client_state.go

@@ -44,7 +44,7 @@ func (cs ClientState) GetLatestHeight() exported.Height {
 // The client may be:
 // - Active: if frozen sequence is 0
 // - Frozen: otherwise solo machine is frozen
-func (cs ClientState) Status(_ sdk.Context, _ sdk.KVStore, _ codec.BinaryMarshaler) string {
+func (cs ClientState) Status(_ sdk.Context, _ sdk.KVStore, _ codec.BinaryMarshaler) exported.Status {
 	if cs.FrozenSequence != 0 {
 		return exported.Frozen
 	}

modules/light-clients/07-tendermint/types/client_state.go

@@ -19,11 +19,6 @@ import (
 	"github.com/cosmos/ibc-go/modules/core/exported"
 )
 
-// Expired is a potential status of a client. A client is expired
-// if its latest consensus state timestamp added to its trusting period
-// is before or equal to the current time.
-const Expired = "Expired"
-
 var _ exported.ClientState = (*ClientState)(nil)
 
 // NewClientState creates a new ClientState instance
@@ -75,7 +70,7 @@ func (cs ClientState) Status(
 	ctx sdk.Context,
 	clientStore sdk.KVStore,
 	cdc codec.BinaryMarshaler,
-) string {
+) exported.Status {
 	if !cs.FrozenHeight.IsZero() {
 		return exported.Frozen
 	}
@@ -87,7 +82,7 @@ func (cs ClientState) Status(
 	}
 
 	if cs.IsExpired(consState.Timestamp, ctx.BlockTime()) {
-		return Expired
+		return exported.Expired
 	}
 
 	return exported.Active

modules/light-clients/07-tendermint/types/client_state_test.go

@@ -37,7 +37,7 @@ func (suite *TendermintTestSuite) TestStatus() {
 	testCases := []struct {
 		name      string
 		malleate  func()
-		expStatus string
+		expStatus exported.Status
 	}{
 		{"client is active", func() {}, exported.Active},
 		{"client is frozen", func() {
@@ -50,7 +50,7 @@ func (suite *TendermintTestSuite) TestStatus() {
 		}, exported.Unknown},
 		{"client status is expired", func() {
 			suite.coordinator.IncrementTimeBy(clientState.TrustingPeriod)
-		}, types.Expired},
+		}, exported.Expired},
 	}
 
 	for _, tc := range testCases {

modules/light-clients/09-localhost/types/client_state.go

@@ -45,7 +45,7 @@ func (cs ClientState) GetLatestHeight() exported.Height {
 
 // Status always returns Active. The localhost status cannot be changed.
 func (cs ClientState) Status(_ sdk.Context, _ sdk.KVStore, _ codec.BinaryMarshaler,
-) string {
+) exported.Status {
 	return exported.Active
 }