[Miner] feat: add `TxContext` #118

bryanchriswhite · 2023-10-30T23:11:25Z

Summary

Human Summary

Adds TxContext interface & cosmosTxContext implementation which abstracts cosmos-specific API into discrete concerns.

AI Summary

Summary generated by Reviewpad on 02 Nov 23 11:30 UTC

This pull request includes various changes across multiple files.

In the internal/testclient package:

The file common.go has been deleted, which contained the CometLocalWebsocketURL constant set to "ws://localhost:36657/websocket".
A new file keyring.go has been added, which defines the NewKey function for generating a new key and mnemonic for testing purposes.

In the package testclient:

The file localnet.go has been added, which includes various imports, functions, and constants related to localnet testing. Some notable additions include the CometLocalWebsocketURL constant and the EncodingConfig variable.

In the either package:

The types.go file has been modified to include changes to the AsyncError type and the introduction of the Bytes type.

In the pkg/client/tx package:

The context.go file has been added, which defines the cosmosTxContext struct implementing the client.TxContext interface. This file also includes various methods related to transaction context within the Cosmos SDK.

In the interface.go file:

Changes have been made to include go:generate directives, import packages, and introduce new interfaces for the client, keyring, and types.

These changes add functionality related to localnet testing, key generation, transaction context, and types across multiple packages.

Issue

Relates to:

TxContext

Type of change

Select one or more:

Testing

Run all unit tests: make go_develop_and_test
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/tx/context.go

bryanchriswhite · 2023-10-30T23:12:36Z

internal/testclient/testtx/context.go

+	return txCtxMock
+}
+
+func NewAnyTimesTxTxContext(


@h5law PTAL re: mocking cosmos' client context object...

Olshansk

No blockers. Just a couple NITs & questions, but otherwise g2g!

internal/testclient/common.go

internal/testclient/keyring.go

internal/testclient/common.go

pkg/client/tx/context.go

internal/testclient/testtx/context.go

(cherry picked from commit 78184e523e62450fe5fc7fe1d23906213e8c81bc)

* 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)

(cherry picked from commit e2303a5b776830815457f12f5e371e916e3bee93)

Olshansk

A couple NITs but LGTM otherwise!

Olshansk · 2023-11-02T00:37:19Z

pkg/client/interface.go

@@ -1,4 +1,4 @@
-//go:generate mockgen -destination=../../internal/mocks/mockclient/events_query_client_mock.go -package=mockclient . Dialer,Connection
+//go:generate mockgen -destination=../../internal/mocks/mockclient/events_query_client_mock.go -package=mockclient . Dialer,Connection,EventsQueryClient


Seeing we have different packages but keep them defined in interface.go, it'll be really nice to get a sense of all the different interfaces we have available.

In fact, this is how I went down the #128 🐇 hole

pkg/client/interface.go

* pokt/main: [Testing] fix: flaky tests in observable & client pkgs (#124) Added first roadmap change

* pokt/godoc_support: fix: goimports Update path to main package in config.yml Import updates Update Makefile Merge with main. Remove .gitkeep. Add back mocks.go. Tests are passing [Miner] feat: add `TxContext` (#118) [Testing] fix: flaky tests in observable & client pkgs (#124)

…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) ...

* chore: add `TxContext` interface * feat: add `cosmosTxContext` implementation * test: add `TxContext` test helpers * chore: move godoc comment above `AsyncError` * fixup: goimports * chore: add godoc comments to tx context test helpers * chore: cleanup * chore: add godoc comments to common testclient helpers * chore: review feedback improvements (cherry picked from commit 78184e523e62450fe5fc7fe1d23906213e8c81bc) * chore: update comments * refactor: simplify tx context teset helpers (cherry picked from commit e2303a5b776830815457f12f5e371e916e3bee93) * chore: add godoc comments

bryanchriswhite added miner Changes related to the Miner off-chain Off-chain business logic labels Oct 30, 2023

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

bryanchriswhite self-assigned this Oct 30, 2023

github-actions bot reviewed Oct 30, 2023

View reviewed changes

pkg/client/tx/context.go Outdated Show resolved Hide resolved

bryanchriswhite commented Oct 30, 2023

View reviewed changes

bryanchriswhite changed the title ~~Feat/tx context~~ [Miner] feat: add TxContext Oct 30, 2023

chore: add TxContext interface

a7d050f

bryanchriswhite force-pushed the feat/tx-context branch from dd1980e to 59f0c90 Compare October 31, 2023 07:20

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

[Miner] Foundation for the Miner submodule #13

Closed

10 tasks

bryanchriswhite added 3 commits October 31, 2023 15:01

feat: add cosmosTxContext implementation

ead6e93

test: add TxContext test helpers

980efc0

chore: move godoc comment above AsyncError

493ce8c

bryanchriswhite force-pushed the feat/tx-context branch from abbab6c to 493ce8c Compare October 31, 2023 14:06

bryanchriswhite added 2 commits October 31, 2023 15:24

fixup: goimports

9f123d2

chore: add godoc comments to tx context test helpers

1149012

bryanchriswhite force-pushed the feat/tx-context branch from 64b7ba6 to 1149012 Compare October 31, 2023 14:33

bryanchriswhite added 2 commits October 31, 2023 15:34

chore: cleanup

3d4acba

chore: add godoc comments to common testclient helpers

7142d17

bryanchriswhite marked this pull request as ready for review October 31, 2023 14:38

bryanchriswhite requested a review from Olshansk October 31, 2023 14:38

Olshansk requested changes Oct 31, 2023

View reviewed changes

bryanchriswhite added 3 commits November 1, 2023 14:49

chore: review feedback improvements

c1ec4cc

(cherry picked from commit 78184e523e62450fe5fc7fe1d23906213e8c81bc)

chore: update comments

77c9563

bryanchriswhite requested a review from Olshansk November 1, 2023 13:56

bryanchriswhite added 2 commits November 1, 2023 16:49

refactor: simplify tx context teset helpers

25abb23

(cherry picked from commit e2303a5b776830815457f12f5e371e916e3bee93)

Merge branch 'main' into feat/tx-context

2800ae0

Olshansk approved these changes Nov 2, 2023

View reviewed changes

Merge remote-tracking branch 'pokt/main' into feat/tx-context

bf1350f

* pokt/main: [Testing] fix: flaky tests in observable & client pkgs (#124) Added first roadmap change

chore: add godoc comments

1f00204

bryanchriswhite merged commit b8b7572 into main Nov 2, 2023

bryanchriswhite deleted the feat/tx-context branch November 2, 2023 12:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Miner] feat: add `TxContext` #118

[Miner] feat: add `TxContext` #118

bryanchriswhite commented Oct 30, 2023 •

edited by reviewpad bot

Loading

bryanchriswhite Oct 30, 2023

Olshansk left a comment

Olshansk left a comment

Olshansk Nov 2, 2023

		@@ -1,4 +1,4 @@
		//go:generate mockgen -destination=../../internal/mocks/mockclient/events_query_client_mock.go -package=mockclient . Dialer,Connection
		//go:generate mockgen -destination=../../internal/mocks/mockclient/events_query_client_mock.go -package=mockclient . Dialer,Connection,EventsQueryClient

[Miner] feat: add TxContext #118

[Miner] feat: add TxContext #118

Conversation

bryanchriswhite commented Oct 30, 2023 • edited by reviewpad bot Loading

Summary

Human Summary

AI Summary

Summary generated by Reviewpad on 02 Nov 23 11:30 UTC

Issue

Type of change

Testing

Sanity Checklist

bryanchriswhite Oct 30, 2023

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk Nov 2, 2023

Choose a reason for hiding this comment

[Miner] feat: add `TxContext` #118

[Miner] feat: add `TxContext` #118

bryanchriswhite commented Oct 30, 2023 •

edited by reviewpad bot

Loading