[Code Health] refactor: block query client interface #616

bryanchriswhite · 2024-06-18T10:53:55Z

Summary

Define a new interface which is a subset of cometclient.CometRPC and only contains members that poktroll depends on.

Issue

We were depending on a cometbft interface which was much larger than we need. This came while working on #402 in an integration test. Defining our own interface for this purpose is more "SOLID".

[Proof] Claim & proof distribution validation #402

Type of change

Select one or more:

Testing

Documentation changes (only if making doc changes)

make docusaurus_start; only needed if you make doc changes

Local Testing (only if making code changes)

Unit Tests: make go_develop_and_test
LocalNet E2E Tests: make test_e2e
See quickstart guide for instructions

PR Testing (only if making code changes)

DevNet E2E Tests: Add the devnet-test-e2e label to the PR.
- THIS IS VERY EXPENSIVE, so only do it after all the reviews are complete.
- Optionally run make trigger_ci if you want to re-trigger tests without any code changes
- If tests fail, try re-running failed tests only using the GitHub UI as shown here

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

…dule param

Co-authored-by: Daniel Olshansky <[email protected]>

…param/proof_request_probability

…request_probability * pokt/main: [Proof Module] feat: on-chain proof window validation (#588)

…/579/param/proof_requirement_threshold

…requirement_threshold * pokt/main: [Proof Module] Add `proof_request_probability` param (#593)

Co-authored-by: Daniel Olshansky <[email protected]>

…lpers

Olshansk · 2024-06-20T21:03:42Z

pkg/client/interface.go

@@ -297,3 +298,10 @@ type SharedQueryClient interface {
 	// the session that includes queryHeight opens.
 	GetProofWindowOpenHeight(ctx context.Context, queryHeight int64) (int64, error)
 }
+
+// BlockQueryClient defines an interface that enables the querying of


LGTM. No issues. Just calling out something below but not looking for a response.

Looks like we're already diverging from [1] w.r.t Naming (e.g. BlockClient vs BlockQueryClient)

I know:

It has different uses

It has different contexts

Functionality differs

Just calling it out.

cc @adshmh @red-0ne

[1] https://github.com/pokt-network/shannon-sdk/blob/d6cb20a34a2e50ea26f196f7c671e60a66bbc015/block.go

Just note that shannon-sdk's block client and poktroll's block client will diverge in functionality.

While the former will mainly be used to query block heights, the later wants the full block to get block events and txs.

So they are definitely not interchangeable.

github-actions · 2024-06-24T08:25:40Z

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 616)
Grafana network dashboard for devnet-issue-{issue-id}

github-actions · 2024-06-24T08:25:40Z

The image is going to be pushed after the next commit.

You can use make trigger_ci to push an empty commit.

If you also want to run E2E tests, please add devnet-test-e2e label.

bryanchriswhite · 2024-06-24T09:51:29Z

E2E tests passed locally but failed to run in CI:

…02/refactor/relayminer * pokt/issues/402/feat/rng: [Code Health] refactor: tx hash encoding (#617) [Docs] Relay session & claim/proof diagrams (#478) Empty commit [Code Health] refactor: block query client interface (#616) [TODO] chore: cleanup done TODOs (#627) [TODOs] chore: cleanup validate session ID TODOs (#608) [LocalNet] Switch to CosmosSDK defaults (#609) [Relay Mining] Emit events and refactor test helpers (#610) [Docs] Minor improvements to `adding_params.md` (#623) [Telemetry] chore: add probabilistic proof telemetry (#605)

…period * pokt/main: [Code Health] refactor: random number generation (#618) [Code Health] refactor: tx hash encoding (#617) [Docs] Relay session & claim/proof diagrams (#478) [Code Health] refactor: block query client interface (#616)

…aim-proof-distribution * issues/402/refactor/relayminer: (21 commits) fix: unflake and speed up tests chore: speed up & improve tests chore: update comments chore: simplify [E2E] Add logging output from the init-container step (#635) fix: failing test Empty commit [Code Health] refactor: random number generation (#618) chore: review improvements chore: review improvments [Code Health] refactor: tx hash encoding (#617) [Docs] Relay session & claim/proof diagrams (#478) Empty commit [Code Health] refactor: block query client interface (#616) chore: review feedback improvements [TODO] chore: cleanup done TODOs (#627) [TODOs] chore: cleanup validate session ID TODOs (#608) [LocalNet] Switch to CosmosSDK defaults (#609) [Relay Mining] Emit events and refactor test helpers (#610) [Docs] Minor improvements to `adding_params.md` (#623) ...

bryanchriswhite and others added 30 commits June 6, 2024 12:25

refactor: relayminer to use proof_window_open_offset_blocks shared mo…

88e4cd4

…dule param

feat: add on-chain proof window validation

6b6df27

chore: add proof_request_probability proof module param

f105c8c

Merge branch 'main' into issues/516/feat/on-chain-proof-window

54bec5c

chore: review improvements

01fd0d6

Co-authored-by: Daniel Olshansky <[email protected]>

chore: review

6b74295

Co-authored-by: Daniel Olshansky <[email protected]>

Merge branch 'issues/516/feat/on-chain-proof-window' into issues/579/…

1f19a18

…param/proof_request_probability

fix: test error format strings

34d7ffb

Merge branch 'issues/516/feat/on-chain-proof-window' into issues/579/…

d169254

…param/proof_request_probability

fix: param update json

0b53c3f

fix: test types

f8a6f91

chore: regen protobufs

c2f442c

feat: add proof_requirement_threshold proof module param

a4f6ac0

Merge remote-tracking branch 'pokt/main' into issues/579/param/proof_…

de0a5ce

…request_probability * pokt/main: [Proof Module] feat: on-chain proof window validation (#588)

Merge branch 'issues/579/param/proof_request_probability' into issues…

0880826

…/579/param/proof_requirement_threshold

Merge remote-tracking branch 'pokt/main' into issues/579/param/proof_…

c8b7472

…requirement_threshold * pokt/main: [Proof Module] Add `proof_request_probability` param (#593)

chore: self-review

07e0d96

feat: add proof_missing_penalty proof module param

1b8fe2d

refactor: pre-generated-accounts

63963c7

fix: pre-generated-accounts prefix

f0c4d1e

chore: regenerate pre-generated-accounts

65d20f0

chore: review

151c4e3

Co-authored-by: Daniel Olshansky <[email protected]>

chore: self-review

1917db6

refactor: tokenomics keeper tests

66b678c

chore: self-review improvements

87d7c65

fixup! chore: self-review improvements

9fa62e3

test: add coverage for proof required via probability only

f93d42f

feat: add probabilistic proof requirement case when settling

638a31e

refactor: tokenomics keeper tests to use claim/proof window height he…

3c9bf6f

…lpers

test: secureRandomProbability

499588e

bryanchriswhite added 6 commits June 19, 2024 21:39

chore: self-review improvements

fd239c8

fix: failing unit tests

bc18a87

chore: review feedback improvements

a8f24a5

Merge branch 'main' into issues/579/chore/telemetry

2fac83e

fix: missing goroutine

1721103

fixup! fix: missing goroutine

55af523

bryanchriswhite force-pushed the issues/402/refactor/block-query-client branch from b4f0108 to 2ed7f2c Compare June 20, 2024 08:13

refactor: block query client interface

70b13c2

bryanchriswhite force-pushed the issues/402/refactor/block-query-client branch from 2ed7f2c to 70b13c2 Compare June 20, 2024 08:17

bryanchriswhite marked this pull request as ready for review June 20, 2024 08:18

bryanchriswhite requested review from Olshansk and red-0ne June 20, 2024 08:18

bryanchriswhite changed the base branch from issues/579/chore/telemetry to main June 20, 2024 08:43

Merge branch 'main' into issues/402/refactor/block-query-client

2f1f9de

Olshansk reviewed Jun 20, 2024

View reviewed changes

Olshansk approved these changes Jun 20, 2024

View reviewed changes

red-0ne approved these changes Jun 21, 2024

View reviewed changes

bryanchriswhite added push-image CI related - pushes images to ghcr.io devnet-test-e2e labels Jun 24, 2024

github-actions bot added the devnet label Jun 24, 2024

Merge branch 'main' into issues/402/refactor/block-query-client

344e5a3

bryanchriswhite merged commit 60fda01 into main Jun 24, 2024
9 of 10 checks passed

bryanchriswhite deleted the issues/402/refactor/block-query-client branch June 24, 2024 10:00

okdas pushed a commit that referenced this pull request Nov 14, 2024

[Code Health] refactor: block query client interface (#616)

3f70957

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Code Health] refactor: block query client interface #616

[Code Health] refactor: block query client interface #616

bryanchriswhite commented Jun 18, 2024 •

edited

Loading

Olshansk Jun 20, 2024

red-0ne Jun 21, 2024

github-actions bot commented Jun 24, 2024

github-actions bot commented Jun 24, 2024

bryanchriswhite commented Jun 24, 2024

[Code Health] refactor: block query client interface #616

[Code Health] refactor: block query client interface #616

Conversation

bryanchriswhite commented Jun 18, 2024 • edited Loading

Summary

Issue

Type of change

Testing

Sanity Checklist

Olshansk Jun 20, 2024

Choose a reason for hiding this comment

red-0ne Jun 21, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 24, 2024

github-actions bot commented Jun 24, 2024

bryanchriswhite commented Jun 24, 2024

bryanchriswhite commented Jun 18, 2024 •

edited

Loading