feat: extend consumer chains query #2172
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,14 +5,15 @@ import ( | |
| "context" | ||
| "fmt" | ||
| "sort" | ||
| "strconv" | ||
|
|
||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
|
|
||
| errorsmod "cosmossdk.io/errors" | ||
|
|
||
| "cosmossdk.io/math" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/interchain-security/v5/x/ccv/provider/types" | ||
| ccvtypes "github.com/cosmos/interchain-security/v5/x/ccv/types" | ||
| ) | ||
|
|
@@ -51,13 +52,51 @@ func (k Keeper) QueryConsumerChains(goCtx context.Context, req *types.QueryConsu | |
|
|
||
| ctx := sdk.UnwrapSDKContext(goCtx) | ||
|
|
||
| consumerIds := []string{} | ||
| phaseFilter := req.Phase | ||
|
|
||
| // if the phase filter is set Launched get consumer from the state directly | ||
| if phaseFilter == types.ConsumerPhase_CONSUMER_PHASE_LAUNCHED { | ||
| consumerIds = append(consumerIds, k.GetAllRegisteredConsumerIds(ctx)...) | ||
| // otherwise iterate over all the consumer using the last unused consumer Id | ||
| } else { | ||
| firstUnusedConsumerId, ok := k.GetConsumerId(ctx) | ||
| if !ok { | ||
| return &types.QueryConsumerChainsResponse{}, nil | ||
| } | ||
| for i := uint64(0); i < firstUnusedConsumerId; i++ { | ||
| // if the phase filter is set, verify that the consumer has the same phase | ||
| if phaseFilter != types.ConsumerPhase_CONSUMER_PHASE_UNSPECIFIED { | ||
| p := k.GetConsumerPhase(ctx, strconv.FormatInt(int64(i), 10)) | ||
| if p == types.ConsumerPhase_CONSUMER_PHASE_UNSPECIFIED { | ||
| return nil, status.Error(codes.Internal, fmt.Sprintf("cannot retrieve phase for consumer id: %d", i)) | ||
| } | ||
| if p != phaseFilter { | ||
| continue | ||
| } | ||
| } | ||
|
|
||
| consumerIds = append(consumerIds, strconv.FormatInt(int64(i), 10)) | ||
| } | ||
| } | ||
|
|
||
| // set limit to default value | ||
| limit := 100 | ||
| if req.Limit != 0 { | ||
| // update limit if specified | ||
| limit = int(req.Limit) | ||
| } | ||
|
|
||
| chains := make([]*types.Chain, math.Min(len(consumerIds), limit)) | ||
| for i, cID := range consumerIds { | ||
| if i == limit { | ||
| break | ||
| } | ||
| c, err := k.GetConsumerChain(ctx, cID) | ||
| if err != nil { | ||
| return nil, status.Error(codes.Internal, err.Error()) | ||
| } | ||
| chains[i] = &c | ||
| } | ||
|
|
||
| return &types.QueryConsumerChainsResponse{Chains: chains}, nil | ||
|
|
@@ -70,11 +109,7 @@ func (k Keeper) GetConsumerChain(ctx sdk.Context, consumerId string) (types.Chai | |
| return types.Chain{}, fmt.Errorf("cannot find chainID for consumer (%s)", consumerId) | ||
| } | ||
|
|
||
| clientID, _ := k.GetConsumerClientId(ctx, consumerId) | ||
| topN := k.GetTopN(ctx, consumerId) | ||
|
|
||
| // Get the minimal power in the top N for the consumer chain | ||
|
|
@@ -84,9 +119,10 @@ func (k Keeper) GetConsumerChain(ctx sdk.Context, consumerId string) (types.Chai | |
| minPowerInTopN = -1 | ||
| } | ||
|
|
||
| phase := k.GetConsumerPhase(ctx, consumerId) | ||
| if phase == types.ConsumerPhase_CONSUMER_PHASE_UNSPECIFIED { | ||
| return types.Chain{}, fmt.Errorf("cannot find phase for consumer (%s)", consumerId) | ||
| } | ||
|
|
||
| allowlist := k.GetAllowList(ctx, consumerId) | ||
| strAllowlist := make([]string, len(allowlist)) | ||
|
|
@@ -100,19 +136,25 @@ func (k Keeper) GetConsumerChain(ctx sdk.Context, consumerId string) (types.Chai | |
| strDenylist[i] = addr.String() | ||
| } | ||
|
|
||
| metadata, err := k.GetConsumerMetadata(ctx, consumerId) | ||
| if err != nil { | ||
| return types.Chain{}, fmt.Errorf("cannot get metadata for consumer (%s): %w", consumerId, err) | ||
| } | ||
|
|
||
| allowInactiveVals := k.AllowsInactiveValidators(ctx, consumerId) | ||
| minStake := k.GetMinStake(ctx, consumerId) | ||
|
|
||
| return types.Chain{ | ||
| ChainId: chainID, | ||
| ClientId: clientID, | ||
| Top_N: topN, | ||
| MinPowerInTop_N: minPowerInTopN, | ||
| ValidatorSetCap: k.GetValidatorSetCap(ctx, consumerId), | ||
| ValidatorsPowerCap: k.GetValidatorsPowerCap(ctx, consumerId), | ||
| Allowlist: strAllowlist, | ||
| Denylist: strDenylist, | ||
| Phase: phase, | ||
| Metadata: metadata, | ||
| AllowInactiveVals: allowInactiveVals, | ||
| MinStake: minStake, | ||
| }, nil | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,9 @@ import ( | |
| "bytes" | ||
| "fmt" | ||
| "sort" | ||
| "strconv" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/golang/mock/gomock" | ||
| "github.com/stretchr/testify/require" | ||
|
|
@@ -18,6 +20,7 @@ import ( | |
|
|
||
| cryptotestutil "github.com/cosmos/interchain-security/v5/testutil/crypto" | ||
| testkeeper "github.com/cosmos/interchain-security/v5/testutil/keeper" | ||
| "github.com/cosmos/interchain-security/v5/x/ccv/provider/keeper" | ||
| "github.com/cosmos/interchain-security/v5/x/ccv/provider/types" | ||
| ccvtypes "github.com/cosmos/interchain-security/v5/x/ccv/types" | ||
| ) | ||
|
|
@@ -427,6 +430,8 @@ func TestGetConsumerChain(t *testing.T) { | |
| math.NewInt(300), | ||
| } | ||
|
|
||
| metadataLists := []types.ConsumerMetadata{} | ||
|
|
||
| expectedGetAllOrder := []types.Chain{} | ||
| for i, consumerID := range consumerIDs { | ||
| pk.SetConsumerChainId(ctx, consumerID, chainIDs[i]) | ||
|
|
@@ -455,6 +460,12 @@ func TestGetConsumerChain(t *testing.T) { | |
| strDenylist[j] = addr.String() | ||
| } | ||
|
|
||
| metadataLists = append(metadataLists, types.ConsumerMetadata{Name: chainIDs[i]}) | ||
| pk.SetConsumerMetadata(ctx, consumerID, metadataLists[i]) | ||
|
|
||
| phase := types.ConsumerPhase(int32(i + 1)) | ||
| pk.SetConsumerPhase(ctx, consumerID, phase) | ||
|
|
||
| expectedGetAllOrder = append(expectedGetAllOrder, | ||
| types.Chain{ | ||
| ChainId: chainIDs[i], | ||
|
|
@@ -465,13 +476,15 @@ func TestGetConsumerChain(t *testing.T) { | |
| ValidatorsPowerCap: validatorPowerCaps[i], | ||
| Allowlist: strAllowlist, | ||
| Denylist: strDenylist, | ||
| Phase: phase, | ||
| Metadata: metadataLists[i], | ||
| AllowInactiveVals: allowInactiveVals[i], | ||
| MinStake: minStakes[i].Uint64(), | ||
| }) | ||
| } | ||
|
|
||
| for i, cId := range consumerIDs { | ||
| c, err := pk.GetConsumerChain(ctx, cId) | ||
| require.NoError(t, err) | ||
| require.Equal(t, expectedGetAllOrder[i], c) | ||
| } | ||
|
|
@@ -562,3 +575,115 @@ func TestQueryConsumerIdFromClientId(t *testing.T) { | |
| require.NoError(t, err) | ||
| require.Equal(t, expectedConsumerId, res.ConsumerId) | ||
| } | ||
|
|
||
| func TestQueryConsumerChains(t *testing.T) { | ||
|
There was a problem hiding this comment. Rename to Consider renaming the function to |
||
| pk, ctx, ctrl, _ := testkeeper.GetProviderKeeperAndCtx(t, testkeeper.NewInMemKeeperParams(t)) | ||
| defer ctrl.Finish() | ||
|
|
||
| consumerNum := 4 | ||
| consumerIds := make([]string, consumerNum) | ||
| consumers := make([]*types.Chain, consumerNum) | ||
|
|
||
| // expect no error and returned chains | ||
| res, err := pk.QueryConsumerChains(ctx, &types.QueryConsumerChainsRequest{}) | ||
| require.NoError(t, err) | ||
| require.Len(t, res.Chains, 0) | ||
|
|
||
| // create four consumer chains in different phase | ||
| for i := 0; i < consumerNum; i++ { | ||
| cID := pk.FetchAndIncrementConsumerId(ctx) | ||
|
There was a problem hiding this comment. Clarify the reason for skipping the first consumer ID. The reason for skipping the first consumer ID is not clear. Consider adding a comment to explain this logic. |
||
| chainID := "consumer-" + strconv.Itoa(i) | ||
| c := types.Chain{ | ||
| ChainId: chainID, | ||
| MinPowerInTop_N: -1, | ||
| ValidatorsPowerCap: 0, | ||
| ValidatorSetCap: 0, | ||
| Allowlist: []string{}, | ||
| Denylist: []string{}, | ||
| Phase: types.ConsumerPhase(i + 1), | ||
| Metadata: types.ConsumerMetadata{Name: chainID}, | ||
| } | ||
| pk.SetConsumerPhase(ctx, cID, c.Phase) | ||
| pk.SetConsumerMetadata(ctx, cID, c.Metadata) | ||
| pk.SetConsumerChainId(ctx, cID, chainID) | ||
|
|
||
| consumerIds[i] = cID | ||
| consumers[i] = &c | ||
| } | ||
|
|
||
| testCases := []struct { | ||
| name string | ||
| setup func(ctx sdk.Context, pk keeper.Keeper) | ||
| phase_filter types.ConsumerPhase | ||
| limit int32 | ||
| expConsumers []*types.Chain | ||
| }{ | ||
| { | ||
| name: "expect all consumers when phase filter isn't set", | ||
| setup: func(ctx sdk.Context, pk keeper.Keeper) {}, | ||
| expConsumers: consumers, | ||
| }, | ||
| { | ||
| name: "expect an amount of consumer equal to the limit", | ||
| setup: func(ctx sdk.Context, pk keeper.Keeper) {}, | ||
| expConsumers: consumers[:3], | ||
| limit: int32(3), | ||
| }, | ||
| { | ||
| name: "expect registered consumers when phase filter is set to Registered", | ||
| setup: func(ctx sdk.Context, pk keeper.Keeper) { | ||
| consumers[0].Phase = types.ConsumerPhase_CONSUMER_PHASE_REGISTERED | ||
| pk.SetConsumerPhase(ctx, consumerIds[0], types.ConsumerPhase_CONSUMER_PHASE_REGISTERED) | ||
| }, | ||
| phase_filter: types.ConsumerPhase_CONSUMER_PHASE_REGISTERED, | ||
| expConsumers: consumers[0:1], | ||
| }, | ||
| { | ||
| name: "expect initialized consumers when phase is set to Initialized", | ||
| setup: func(ctx sdk.Context, pk keeper.Keeper) { | ||
| consumers[1].Phase = types.ConsumerPhase_CONSUMER_PHASE_INITIALIZED | ||
| err := pk.AppendConsumerToBeLaunchedOnSpawnTime(ctx, consumerIds[1], time.Now()) | ||
| require.NoError(t, err) | ||
| pk.SetConsumerPhase(ctx, consumerIds[1], types.ConsumerPhase_CONSUMER_PHASE_INITIALIZED) | ||
| }, | ||
| phase_filter: types.ConsumerPhase_CONSUMER_PHASE_INITIALIZED, | ||
| expConsumers: consumers[1:2], | ||
| }, | ||
| { | ||
| name: "expect launched consumers when phase is set to Launched", | ||
| setup: func(ctx sdk.Context, pk keeper.Keeper) { | ||
| consumers[2].Phase = types.ConsumerPhase_CONSUMER_PHASE_LAUNCHED | ||
| consumers[2].ClientId = "ClientID" | ||
| pk.SetConsumerClientId(ctx, consumerIds[2], consumers[2].ClientId) | ||
| pk.SetConsumerPhase(ctx, consumerIds[2], types.ConsumerPhase_CONSUMER_PHASE_LAUNCHED) | ||
| }, | ||
| phase_filter: types.ConsumerPhase_CONSUMER_PHASE_LAUNCHED, | ||
| expConsumers: consumers[2:3], | ||
| }, | ||
| { | ||
| name: "expect stopped consumers when phase is set to Stopped", | ||
| setup: func(ctx sdk.Context, pk keeper.Keeper) { | ||
| consumers[3].Phase = types.ConsumerPhase_CONSUMER_PHASE_STOPPED | ||
| pk.SetConsumerPhase(ctx, consumerIds[3], types.ConsumerPhase_CONSUMER_PHASE_STOPPED) | ||
| }, | ||
| phase_filter: types.ConsumerPhase_CONSUMER_PHASE_STOPPED, | ||
| expConsumers: consumers[3:], | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| tc.setup(ctx, pk) | ||
| req := types.QueryConsumerChainsRequest{ | ||
| Phase: tc.phase_filter, | ||
| Limit: tc.limit, | ||
| } | ||
| expectedResponse := types.QueryConsumerChainsResponse{ | ||
| Chains: tc.expConsumers, | ||
| } | ||
| res, err := pk.QueryConsumerChains(ctx, &req) | ||
| require.NoError(t, err) | ||
| require.Equal(t, &expectedResponse, res) | ||
| }) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,9 @@ package keeper | |
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| "cosmossdk.io/math" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| sdkgov "github.com/cosmos/cosmos-sdk/x/gov/types" | ||
| stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types" | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.