[Miner] feat: add block client #65

bryanchriswhite · 2023-10-14T19:04:06Z

Summary

Adds BlockClient interface and implementation.

---
title: Clients Dependency Tree
---
flowchart

sup[SupplierClient]
tx[TxClient]
bl[BlockClient]
evt[EventsQueryClient]

sup --"#SignAndBroadcast()"--> tx
tx --"#CommittedBlocksSequence()"--> bl
tx --"#EventsBytes()"--> evt
bl --"#EventsBytes()"--> evt

Issue

Relates to:

BlockClient is a nested dependency of Miner.

Type of change

Select one or more:

Testing

Run all unit tests: make go_test_integration
Verify Localnet manually: See the instructions [here](TODO: add link to instructions)

Sanity Checklist

I have tested my changes using the available tooling
I have performed a self-review of my own code
I have commented my code, updated documentation and left TODOs throughout the codebase

pkg/client/block/client_test.go

docs/pkg/client/events_query.md

pkg/client/block/client_test_integration.go

pkg/observable/channel/map.go

(cherry picked from commit 22371aa550eb0060b528f4573ba6908bbdfa0c1c)

* pokt/main: fix: RelayerProxy interface mismatch (#91) [RelayerProxy] feat: implement relayerProxy struct (#82) [AppGate] Scaffold undelegate-from-gateway message & nothing else (#86) [AppGate] Scaffold delegate-to-gateway message and nothing else (#85) [Supplier] Implement MsgUnstakeSupplier w/ Tests (#77) [Supplier] Implement MsgStakeSupplier & Add Extensive Tests (#76) [RelayerProxy] feat: add RelayerProxy interface (#80)

(cherry picked from commit ab21790164ab544ae5f1508d3237a3faab33e71e)

* feat/observable-map: feat: add the map channel observable operator

* feat/replay-observable: feat: add replay observable

* pokt/main: Update main README.md [Miner] feat: add replay observable (#93) [Proxy] feat: add general proxy logic and server builder (#96) [Code Health] Replace `mocks.go` w/ `.gitkeep` (#103) [Application] Add `ServiceConfigs` to `AppStaking` (#95)

Olshansk

A few last minute NITs but no blockers.

I didn't do a deep dive into pkg/retry/retry_test.go since it's really hard to build context into this. When the TODOs are tended to, it'll be easier to compartmentalize on a per-PR basis.

internal/testclient/testblock/client.go

pkg/client/block/client.go

pkg/client/block/client_integration_test.go

Olshansk · 2023-10-31T00:03:32Z

pkg/retry/retry_test.go

@@ -0,0 +1,337 @@
+package retry_test
+
+/* TODO_TECHDEBT: improve this test:


Olshansk · 2023-10-31T00:11:07Z

pkg/client/block/client_test.go

+}
+
+/*
+TODO_TECHDEBT/TODO_CONSIDERATION(#XXX): this duplicates the unexported block event


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

bryanchriswhite · 2023-10-31T07:57:03Z

Waiting to merge until CI is working and green:

[CI] Quick change: install ignite from github releases #116

okdas · 2023-10-31T22:01:30Z

~~Closing this as ignite.com now works. Will add a comment linking to this PR in case a similar issue arises.~~

Olshansk · 2023-10-31T22:06:18Z

@okdas Shouldn't we close #116 but keep this one open?

okdas · 2023-10-31T22:08:50Z

@okdas Shouldn't we close #116 but keep this one open?

LOL, sorry. I pushed the comment on the wrong tab. :)

Olshansk · 2023-10-31T22:21:43Z

@bryanchriswhite Try to merge with main to see if CI passes and please take not of #121 as well

okdas · 2023-10-31T23:18:15Z

There's a test failure unfortunately: https://github.com/pokt-network/poktroll/actions/runs/6712974558/job/18243662555?pr=65

* pokt/main: [Miner] feat: add block client (#65)

* pokt/main: [Miner] feat: add block client (#65) [Supplier] Add `ServiceConfigs` to `SupplierStaking` (#114) [AppGate] Add the MaxDelegatedGateways parameter (#109) [Test] Temporarily skip a flaky test `TestEventsQueryClient_Subscribe_Succeeds` (#121) [AppGate] Implement DelegateToGateway and add Tests (#90) [E2E] Add (Un)Stake Tests (#88)

…plementation * pokt/main: (28 commits) [Miner] feat: add supplier client (#42) [Off-chain] refactor: keyring errors & helpers (#131) [Miner] feat: add `TxClient` (#94) [CI] Build container images (#107) fix: flaky block client test (#132) [Tooling] add `go_lint` & `go_imports` make targets & CI step (#129) Update README.md [Code Health] Support `godoc` by replacing the `pocket `module name with `github.com/pokt-network/poktroll` (#128) [Miner] feat: add `TxContext` (#118) [Testing] fix: flaky tests in observable & client pkgs (#124) Added first roadmap change [AppGate] Implement UndelegateFromGateway with Extensive Tests (#125) [Miner] feat: add block client (#65) [Supplier] Add `ServiceConfigs` to `SupplierStaking` (#114) [AppGate] Add the MaxDelegatedGateways parameter (#109) [Test] Temporarily skip a flaky test `TestEventsQueryClient_Subscribe_Succeeds` (#121) [AppGate] Implement DelegateToGateway and add Tests (#90) [E2E] Add (Un)Stake Tests (#88) refactor: add `either.Bytes` alias (#117) feat: add either.AsyncErr type & helpers (#115) ...

* feat: add the map channel observable operator (cherry picked from commit 22371aa550eb0060b528f4573ba6908bbdfa0c1c) * feat: add replay observable (cherry picked from commit ab21790164ab544ae5f1508d3237a3faab33e71e) * chore: add query client interface * chore: add query client errors * test: fix false positive, prevent regression, & add comments * chore: add godoc comment * feat: add query client implementation * chore: add connection & dialer wrapper implementations * test: query client & add testquery helper pkg * chore: add go_test_integration make target * chore: add internal mocks pkg * test: query client integration test * docs: add event query client docs * chore: update go.mod * chore: re-order `eventsQueryClient` methods to improve readability * chore: add godoc comments to testclient helpers * fix: comment formatting * chore: improve comment & naming in evt query client test * test: tune events query client parameters * chore: improve godoc comments * chore: review improvements * refactor: `replayObservable` as its own interface type * refactor: `replayObservable#Next() V` to `ReplayObservable#Last(ctx, n) []V` * chore: add constructor func for `ReplayObservable` * test: reorder to improve readibility * refactor: rename and add godoc comments * chore: improve naming & comments * chore: add warning log and improve comments * test: improve and add tests * fix: interface assertion * fix: comment typo * chore: review improvements * fix: race * chore: add block client interface * chore: add `MapReplay` operator * feat: add block client * test: block client integration * test: block client * docs: fix install instructions * fix: race on eventsBytesAndConns map * fix: interface assertions Co-authored-by: Redouane Lakrache <[email protected]> * fix: race * Small updates to the README * refactor: add observableInternals interface (cherry picked from commit 5d149e5297ce7d11dad77983f53be53efd8dae15) * chore: update last; only block for 1 value min (cherry picked from commit b24a5e586e9c776a962008043d065a2294fd921c) * chore: review improvements * refactor: move add `channelObservableInternals` & migrate its relevant methods & state from channelObservable * refactor: simplify, cleanup, & improve comments * chore: review improvements (cherry picked from commit 31555cdc68211964358c43842e0581f565d1afff) * refactor: eliminate `EventsQueryClient#requestId` field (cherry picked from commit ccb1d6981f67ab860cb65dde4da15d89bcf57875) * refactor: review improvements * refactor: eliminate `EventsQueryClient#requestId` field * refactor: move websocket dialer and connection to own pkg * chore: add comment * fix: notify `retryOnError()` of async error propagating through `#EventsBytes()` observable * chore: review improvements * chore: move `EventsBytesObservable type above interfaces * chore: review improvements * fix: bug & improve naming & comments * chore: review improvements * fix: bug in `accumulateReplayValues()` * refactor: promote `retryOnError` to its own pkg: `retry.OnError` * chore: improve comments * test: inline wip test helpers * test: skip retry.OnError tests & comment * chore: review feedback improvements Co-authored-by: Daniel Olshansky <[email protected]> * chore: review feedback improvements Co-authored-by: Daniel Olshansky <[email protected]> * fix: format placeholder error --------- Co-authored-by: Redouane Lakrache <[email protected]> Co-authored-by: Daniel Olshansky <[email protected]>

bryanchriswhite added the miner Changes related to the Miner label Oct 14, 2023

bryanchriswhite added this to the Shannon TestNet milestone Oct 14, 2023

bryanchriswhite self-assigned this Oct 14, 2023

bryanchriswhite linked an issue Oct 14, 2023 that may be closed by this pull request

[Miner] Foundation for the Miner submodule #13

Closed

10 tasks

h5law reviewed Oct 14, 2023

View reviewed changes

pkg/client/block/client_test.go Outdated Show resolved Hide resolved

bryanchriswhite force-pushed the feat/query-client branch 4 times, most recently from e9c47f9 to 0d73bd8 Compare October 18, 2023 12:09

bryanchriswhite mentioned this pull request Oct 19, 2023

[Pkg] feat: add channel observable #31

Merged

10 tasks

bryanchriswhite force-pushed the feat/query-client branch 6 times, most recently from 0439247 to 015e5ef Compare October 20, 2023 11:09

bryanchriswhite force-pushed the feat/block-client branch from 90b465b to 6c60e68 Compare October 20, 2023 22:00

h5law reviewed Oct 21, 2023

View reviewed changes

docs/pkg/client/events_query.md Outdated Show resolved Hide resolved

h5law reviewed Oct 21, 2023

View reviewed changes

pkg/client/block/client_test_integration.go Outdated Show resolved Hide resolved

h5law reviewed Oct 21, 2023

View reviewed changes

pkg/observable/channel/map.go Outdated Show resolved Hide resolved

bryanchriswhite added 7 commits October 23, 2023 18:06

feat: add the map channel observable operator

3f2971b

(cherry picked from commit 22371aa550eb0060b528f4573ba6908bbdfa0c1c)

feat: add replay observable

4af6643

(cherry picked from commit ab21790164ab544ae5f1508d3237a3faab33e71e)

Merge branch 'feat/observable-map' into merge/map_x_replay

765b0c9

* feat/observable-map: feat: add the map channel observable operator

Merge branch 'feat/replay-observable' into merge/map_x_replay

5f9ce1b

* feat/replay-observable: feat: add replay observable

chore: add query client interface

9c42698

chore: add query client errors

6273f52

bryanchriswhite force-pushed the feat/query-client branch from 3878431 to 30b7a3c Compare October 23, 2023 17:23

bryanchriswhite force-pushed the feat/block-client branch from 6c60e68 to 596a49d Compare October 23, 2023 17:23

bryanchriswhite mentioned this pull request Oct 23, 2023

[Miner] feat: add events query client #64

Merged

10 tasks

bryanchriswhite changed the base branch from main to feat/replay-observable October 27, 2023 12:45

bryanchriswhite changed the base branch from feat/replay-observable to main October 27, 2023 12:52

bryanchriswhite changed the base branch from main to feat/replay-observable October 27, 2023 12:53

bryanchriswhite added 2 commits October 30, 2023 21:12

refactor: promote retryOnError to its own pkg: retry.OnError

6c3c2b9

bryanchriswhite changed the base branch from feat/replay-observable to main October 30, 2023 20:16

bryanchriswhite added 3 commits October 30, 2023 21:47

chore: improve comments

b226a10

test: inline wip test helpers

7ade4a0

test: skip retry.OnError tests & comment

7cfe788

bryanchriswhite requested a review from Olshansk October 30, 2023 21:06

Olshansk approved these changes Oct 31, 2023

View reviewed changes

bryanchriswhite and others added 3 commits October 31, 2023 08:53

chore: review feedback improvements

486dba0

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

chore: review feedback improvements

1677e3f

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

Merge branch 'main' into feat/block-client

cc466b2

okdas closed this Oct 31, 2023

okdas reopened this Oct 31, 2023

bryanchriswhite added 2 commits November 1, 2023 07:52

Merge branch 'main' into feat/block-client

2f49089

fix: format placeholder error

7ae2650

bryanchriswhite merged commit e85cc8a into main Nov 1, 2023

bryanchriswhite added a commit that referenced this pull request Nov 1, 2023

Merge remote-tracking branch 'pokt/main' into issues/120/fix

4405514

* pokt/main: [Miner] feat: add block client (#65)

Olshansk deleted the feat/block-client branch May 29, 2024 16:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Miner] feat: add block client #65

[Miner] feat: add block client #65

bryanchriswhite commented Oct 14, 2023 •

edited

Loading

Olshansk left a comment

Olshansk Oct 31, 2023

bryanchriswhite Oct 31, 2023

Olshansk Oct 31, 2023

bryanchriswhite commented Oct 31, 2023

okdas commented Oct 31, 2023 •

edited

Loading

Olshansk commented Oct 31, 2023 •

edited

Loading

okdas commented Oct 31, 2023

Olshansk commented Oct 31, 2023

okdas commented Oct 31, 2023

		@@ -0,0 +1,337 @@
		package retry_test

		/* TODO_TECHDEBT: improve this test:

[Miner] feat: add block client #65

[Miner] feat: add block client #65

Conversation

bryanchriswhite commented Oct 14, 2023 • edited Loading

Summary

Issue

Type of change

Testing

Sanity Checklist

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk Oct 31, 2023

Choose a reason for hiding this comment

bryanchriswhite Oct 31, 2023

Choose a reason for hiding this comment

Olshansk Oct 31, 2023

Choose a reason for hiding this comment

bryanchriswhite commented Oct 31, 2023

okdas commented Oct 31, 2023 • edited Loading

Olshansk commented Oct 31, 2023 • edited Loading

okdas commented Oct 31, 2023

Olshansk commented Oct 31, 2023

okdas commented Oct 31, 2023

bryanchriswhite commented Oct 14, 2023 •

edited

Loading

okdas commented Oct 31, 2023 •

edited

Loading

Olshansk commented Oct 31, 2023 •

edited

Loading