fix members query in bandtss module

Author: nkitlabs

proto/bandtss/v1beta1/query.proto

@@ -74,8 +74,8 @@ message QueryIsGranteeResponse {
 
 // QueryMembersRequest is the request type for the Query/Members RPC method.
 message QueryMembersRequest {
-  // is_active define filter on members
-  bool is_active = 1;
+  // status define type of filter on member's status.
+  MemberStatusFilter status = 1;
   // pagination defines pagination settings for the request.
   cosmos.base.query.v1beta1.PageRequest pagination = 2;
 }
@@ -147,3 +147,15 @@ message QueryReplacementResponse {
   // replacement is the replacement information.
   Replacement replacement = 1 [(gogoproto.nullable) = false];
 }
+
+// MemberStatusFilter defines the query options for filtering members by their active status.
+enum MemberStatusFilter {
+  option (gogoproto.goproto_enum_prefix) = false;
+
+  // MEMBER_STATUS_FILTER_UNSPECIFIED defines a filter for unspecified active status.
+  MEMBER_STATUS_FILTER_UNSPECIFIED = 0;
+  // MEMBER_STATUS_FILTER_ACTIVE defines a filter for active status.
+  MEMBER_STATUS_FILTER_ACTIVE = 1;
+  // MEMBER_STATUS_FILTER_INACTIVE defines a filter for inactive status.
+  MEMBER_STATUS_FILTER_INACTIVE = 2;
+}

x/bandtss/client/cli/query.go

@@ -10,6 +10,10 @@ import (
 	"github.com/bandprotocol/chain/v2/x/bandtss/types"
 )
 
+const (
+	flagMemberStatusFilter = "status"
+)
+
 // GetQueryCmd returns the cli query commands for this module
 func GetQueryCmd() *cobra.Command {
 	cmd := &cobra.Command{
@@ -66,24 +70,33 @@ func GetQueryCmdMember() *cobra.Command {
 // GetQueryCmdMembers creates a CLI command for querying members information.
 func GetQueryCmdMembers() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "members [is-active]",
+		Use:   "members",
 		Short: "Query the members information of the active group",
-		Args:  cobra.ExactArgs(1),
+		Args:  cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			clientCtx, err := client.GetClientQueryContext(cmd)
 			if err != nil {
 				return err
 			}
 
-			isActive, err := strconv.ParseBool(args[0])
+			statusFilterFlag, err := cmd.Flags().GetBool(flagMemberStatusFilter)
 			if err != nil {
 				return err
 			}
 
+			var statusFilter types.MemberStatusFilter
+			if !cmd.Flags().Changed(flagMemberStatusFilter) {
+				statusFilter = types.MEMBER_STATUS_FILTER_UNSPECIFIED
+			} else if statusFilterFlag {
+				statusFilter = types.MEMBER_STATUS_FILTER_ACTIVE
+			} else {
+				statusFilter = types.MEMBER_STATUS_FILTER_INACTIVE
+			}
+
 			queryClient := types.NewQueryClient(clientCtx)
 
 			res, err := queryClient.Members(cmd.Context(), &types.QueryMembersRequest{
-				IsActive: isActive,
+				Status: statusFilter,
 			})
 			if err != nil {
 				return err
@@ -93,6 +106,7 @@ func GetQueryCmdMembers() *cobra.Command {
 		},
 	}
 
+	cmd.Flags().Bool(flagMemberStatusFilter, false, "Filter members by status")
 	flags.AddQueryFlagsToCmd(cmd)
 
 	return cmd

x/bandtss/keeper/grpc_query.go

@@ -79,10 +79,20 @@ func (q queryServer) Members(
 		req.Pagination,
 		func(key []byte, m *types.Member) (*types.Member, error) {
 			// filter item out if the member's isActive is not equal to the request status.
-			if m.IsActive != req.IsActive {
-				return nil, nil
+			switch req.Status {
+			case types.MEMBER_STATUS_FILTER_UNSPECIFIED:
+				return m, nil
+			case types.MEMBER_STATUS_FILTER_ACTIVE:
+				if m.IsActive {
+					return m, nil
+				}
+			case types.MEMBER_STATUS_FILTER_INACTIVE:
+				if !m.IsActive {
+					return m, nil
+				}
 			}
-			return m, nil
+
+			return nil, nil
 		},
 		func() *types.Member {
 			return &types.Member{}

x/bandtss/keeper/grpc_query_test.go

@@ -21,6 +21,12 @@ func TestGRPCQueryMembers(t *testing.T) {
 	lastActive := time.Now().UTC()
 
 	members := []*types.Member{
+		{
+			Address:    "band1p40yh3zkmhcv0ecqp3mcazy83sa57rgjp07dun",
+			IsActive:   false,
+			Since:      since,
+			LastActive: lastActive,
+		},
 		{
 			Address:    "band1t5x8hrmht463eq4m0xhfgz95h62dyvkq049eek",
 			IsActive:   true,
@@ -42,59 +48,42 @@ func TestGRPCQueryMembers(t *testing.T) {
 		expectOut  expectOut
 	}{
 		{
-			name: "get 2 active members",
+			name: "get all members",
 			input: &types.QueryMembersRequest{
-				IsActive: true,
+				Status: types.MEMBER_STATUS_FILTER_UNSPECIFIED,
 			},
 			expectOut: expectOut{members: members},
 		},
 		{
 			name: "get 1 active members; limit 1 offset 0",
 			input: &types.QueryMembersRequest{
-				IsActive:   true,
+				Status:     types.MEMBER_STATUS_FILTER_ACTIVE,
 				Pagination: &querytypes.PageRequest{Limit: 1, Offset: 0},
 			},
-			expectOut: expectOut{members: members[:1]},
+			expectOut: expectOut{members: members[1:2]},
 		},
 		{
 			name: "get 1 active members limit 1 offset 1",
 			input: &types.QueryMembersRequest{
-				IsActive:   true,
+				Status:     types.MEMBER_STATUS_FILTER_ACTIVE,
 				Pagination: &querytypes.PageRequest{Limit: 1, Offset: 1},
 			},
-			expectOut: expectOut{members: members[1:]},
+			expectOut: expectOut{members: members[2:]},
 		},
 		{
 			name: "get 0 active members; out of pages limit 1 offset 5",
 			input: &types.QueryMembersRequest{
-				IsActive:   true,
+				Status:     types.MEMBER_STATUS_FILTER_ACTIVE,
 				Pagination: &querytypes.PageRequest{Limit: 1, Offset: 5},
 			},
 			expectOut: expectOut{members: []*types.Member{}},
 		},
 		{
 			name: "get no inactive members",
 			input: &types.QueryMembersRequest{
-				IsActive: false,
-			},
-			expectOut: expectOut{members: []*types.Member{}},
-		},
-		{
-			name: "get inactive members",
-			preProcess: func(s *testutil.TestSuite) {
-				s.Keeper.SetMember(s.Ctx, types.Member{
-					Address:    members[0].Address,
-					IsActive:   false,
-					Since:      members[0].Since,
-					LastActive: members[0].LastActive,
-				})
-			},
-			input: &types.QueryMembersRequest{
-				IsActive: false,
+				Status: types.MEMBER_STATUS_FILTER_INACTIVE,
 			},
-			expectOut: expectOut{members: []*types.Member{
-				{Address: members[0].Address, IsActive: false, Since: members[0].Since, LastActive: members[0].LastActive},
-			}},
+			expectOut: expectOut{members: members[0:1]},
 		},
 	}