[Clients] embed ParamsQuerier into SharedQueryClient

[bryanchriswhite]

Summary

Embed the ParamsQuerier interface into SharedQueryClient and update both off- and on-chain implementations; i.e. sharedQuerier and sharedKeeperQueryClient, respectively.

---
title: Legend
---

classDiagram-v2

class GenericInterface__T__any {
    <<interface>>
    GenericMethod() T
}

class Implementer {
    ExportedField FieldType
    unexportedField FieldType
}

Implementer --|> GenericInterface__T__any: implements

class Embedder__T__any {
    <<interface>>
    GenericInterface[T]
}

Embedder__T__any ..|> GenericInterface__T__any: embeds

Implementer --* FieldType: composes*
Implementer --o FieldType: aggregates*

Loading

*Aggregation implies that the compose component instance DOES have an independent existence from its composition, composition DOES NOT.

---
title: Shared Querier Integration (off-chain)
---

classDiagram-v2

class ParamsQuerier__P__sdk_Msg {
    <<interface>>
    GetParams(ctx context.Context) (params P, err error)
    GetParamsAtHeight(ctx context.Context, height int64) (params P, err error)
}


class cachedParamsQuerier__P__sdk_Msg__Q__paramsQuerier {
    queryClient Q__paramsQuerier[P]
    paramsCache HistoricalQueryCache[P]
    ...
}
cachedParamsQuerier__P__sdk_Msg__Q__paramsQuerier --|> ParamsQuerier__P__sdk_Msg

class HistoricalQueryCache__T__any {
    <<interface>>
    QueryCache__T__any  // omitted from this diagram
    GetAtHeight(key string, heigt int64) (value T, err error)
    SetAtHeight(key string, value T, heigt int64) (err error)
}

cachedParamsQuerier__P__sdk_Msg__Q__paramsQuerier --* HistoricalQueryCache__T__any

class SharedQuerier {
    <<interface>>
    ParamsQuerier__P__sdk_Msg
}
SharedQuerier ..|> ParamsQuerier__P__sdk_Msg
sharedQuerier --|> SharedQuerier

class sharedQuerier {
    ParamsQuerier__P__sdk_Msg
}
sharedQuerier --* cachedParamsQuerier__P__sdk_Msg__Q__paramsQuerier

Loading

---
title: Shared Querier Integration (on-chain)
---

classDiagram-v2

class ParamsQuerier__P__sdk_Msg {
    <<interface>>
    GetParams(ctx context.Context) (params P, err error)
    GetParamsAtHeight(ctx context.Context, height int64) (params P, err error)
}

class keeperParamsQuerier__P__any__K__paramsKeeperIface {
    keeper K

    GetParams(ctx context.Context) (params P, err error)
    GetParamsAtHeight(ctx context.Context, height int64) (params P, err error)  // NEVER called; blocked by #931
}

keeperParamsQuerier__P__any__K__paramsKeeperIface --|> ParamsQuerier__P__sdk_Msg

%% class paramsKeeperIface__P__any {
%%     GetParams(context.Context) P
%% }
%% keeperParamsQuerier__P__any__K__paramsKeeperIface --> paramsKeeperIface__P__any

class sharedkeeper.Keeper {
    GetParams(ctx context.Context) (params P, err error)
    %% GetParamsAtHeight(ctx context.Context, height int64) (params P, err error)
}

keeperParamsQuerier__P__any__K__paramsKeeperIface --o sharedkeeper.Keeper

class SharedQuerier {
    <<interface>>
    ParamsQuerier__P__sdk_Msg
}
SharedQuerier ..|> ParamsQuerier__P__sdk_Msg
sharedKeeperQueryClient --|> SharedQuerier

class sharedKeeperQueryClient {
    ParamsQuerier__P__sdk_Msg

    sharedKeeper sharedKeeper
    sessionKeeper SessionKeeper  // omitted from this diagram
}
sharedKeeperQueryClient --* keeperParamsQuerier__P__any__K__paramsKeeperIface
sharedKeeperQueryClient --o sharedkeeper.Keeper

Loading

Issue

• [Off-Chain] ModuleParamsClient & Historical Params #543

Type of change

Select one or more from the following:

• New feature, functionality or library
• Consensus breaking; add the consensus-breaking label if so. See [Infra] Automatically add the consensus-breaking label #791 for details
• Bug fix
• Code health or cleanup
• Documentation
• Other (specify)

Testing

• Documentation: make docusaurus_start; only needed if you make doc changes
• Unit Tests: make go_develop_and_test
• LocalNet E2E Tests: make test_e2e
• DevNet E2E Tests: Add the devnet-test-e2e label to the PR.

Sanity Checklist

• I have tested my changes using the available tooling
• I have commented my code
• I have performed a self-review of my own code; both comments & source code
• I create and reference any new tickets, if applicable
• I have left TODOs throughout the codebase, if applicable

[github-actions]

The CI will now also run the e2e tests on devnet, which increases the time it takes to complete all CI checks.

You may need to run make trigger_ci to submit an empty commit that'll trigger the tests.

GCP workloads (requires changing the namespace to 1000)
Grafana network dashboard for devnet-issue-1000

[Olshansk]

I can tell there's a lot more work to do but this is a great step forward :)

[Olshansk]

Suggested change

	GetParams(context.Context) (*Params, error)
	GetParams(context.Context) (*Params, error)
	// TODO_MAINNET(@bryanchriswhite, #931): GetParamsAtHeight(context.Context, uint64) (*Params, error)

[bryanchriswhite]

This is not accurate. The point of this interface is only to adapt from:

Params(context.Context, *QueryParamsRequest, ...) (*QueryParamsResponse, error)

to:

GetParams(context.Context) (*Params, error)

This interface is used as a generic type parameter to the NewCachedParamsQuerier() constructor which is what returns the object that defines GetParamsAtHeight().

[Olshansk]

Can you #PUC so this reasoning is clear to others please?