[Docs] Readme rewrite #19
Merged
Conversation
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
* refactor: remove redundant application client * refactor: move the BlockClient to top level * remove the redundant clients/block.go * fix spacing in the comment * Refactor: move session client to top level * refactor: use poktroll exported types in GetSessionSupplierEndpoints * Use PoktNodeSessionFetcher as the interface consumed by SessionClinet * feat: introduce a wrapper for Sessions to support endpoint selection * fix: refactor FilteredSession to make it stateless * fix linter errors * fix linter warnings
* refactor: remove redundant application client * refactor: move the BlockClient to top level * remove the redundant clients/block.go * fix spacing in the comment * Refactor: move session client to top level * refactor: use poktroll exported types in GetSessionSupplierEndpoints * Use PoktNodeSessionFetcher as the interface consumed by SessionClinet * feat: introduce a wrapper for Sessions to support endpoint selection * Draft: overall SDK structure * Fix the send relay example * fix typo * address review comments * fix linter warnings * address review comment: make SupplierAddress an input for Validating response * address review comment: use query height to get app ring * address review: TODO for stateless ring constructor
* refactor: remove redundant application client * refactor: move the BlockClient to top level * remove the redundant clients/block.go * fix spacing in the comment * Refactor: move session client to top level * refactor: use poktroll exported types in GetSessionSupplierEndpoints * Use PoktNodeSessionFetcher as the interface consumed by SessionClinet * feat: introduce a wrapper for Sessions to support endpoint selection * Draft: overall SDK structure * Fix the send relay example * fix typo * address review comments * fix linter warnings * address review comment: make SupplierAddress an input for Validating response * address review comment: use query height to get app ring * address review: TODO for stateless ring constructor * refactor: Use poktroll ring construction functions * fix: ring naming and linting * fix: Remove unused argument * fix: Application address logging * fix: Relay test example and go.mod poktroll dep * chore: Update dependencies --------- Co-authored-by: Arash Deshmeh <[email protected]>
* fix: Restore CopyToHTTPHeader * chore: Add TODO_REFACTOR
adshmh
approved these changes
Jun 28, 2024
bryanchriswhite
approved these changes
Jun 28, 2024
| relayClient := NewRelayClient() | ||
| signer := NewSigner(privateKeyHex) | ||
|
|
||
| sdk, err := NewShannonSDK( |
There was a problem hiding this comment.
Just curious, was depinject considered for use here (i.e. receiving a depinject.Config)?
There was a problem hiding this comment.
Mainly to reduce third party dependencies and cognitive load.
adshmh
approved these changes
Jun 28, 2024
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Rewrite the
README.mdand remove unused code.Issue
Documentation got out of date after code refactoring.
Type of change
Select one or more:
Sanity Checklist