Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[SDK] PATH <> Shannon SDK Refactor, Tech Debt & Improvements

Open
  • Is something wrong?
#291 0 comments 0 reactions 1 assignee View on GitHub

@commoddity is already working on this.

Since Jun 9, 2025.

Assessment

This issue has not been assessed yet.

Description

shannon-sdk

Objective

Reduce tech debt and set a better foundation for the shannon-sdk as the protocol has gone live and:

  1. More users will start onboarding to Pocket Network Shannon either via PATH
  2. People use the shannon SDK directly

Origin Document

This ticket stemmed from this github discussion and this internal discord thread.

It is a result of introducing Account caching in the PATH SDK and identifying the deliniation of responsibilities between the shannon SDK.

📃 NOTE: The shannon-sdk was built very quickly when a lot less knowledge of how the end-to-end system would look like 📃

Goals

  • Reduce shannon-sdk <> path related tech debt
  • Set a better foundation for the shannon-sdk
  • Improve the performance of path via caching
  • Enable more consistent patterns across app/session/account handling in FullNode implementations
  • Reduce onboarding complexity for future users of PATH and the SDK
  • Move account-related logic (e.g., public key retrieval) closer to its actual data source

Deliverables

  • Replace use of sdk.PoktNodeAccountFetcher with a higher-level GetAccount method or similar abstraction
  • Update the shannon-sdk to include GetAccount(ctx, address) method with a clear return type
  • Update ApplicationRing, Signer, and other downstream consumers to use this method instead of GetPubKeyFromAddress
  • Refactor the relevant PATH protocol logic (e.g., BuildRequestContextForEndpoint, signRelayRequest) to use the new flow
  • Ensure backwards compatibility or clearly document breaking changes
  • Update the shannon-sdk documentation
  • Remove the tech-debt introduced in PR #290
  • Update PATH Overall Health Grafana with Request Bar Chart and Request Logs Panel (can't find it) and Request by domain panel (can't find it)

Non-goals / Non-deliverables

  • Do not include major changes to unrelated modules like the application or supplier, etc.
  • Do not include full replacement of FullNode interface usages outside of account-related functionality

Creator: @Olshansk
Co-Owners: @commoddity @adshmh @okdas

Dominant language
Go
Stars
12
Forks
8
No merged PRs in 30d

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pokt-network/path

All issues in pokt-network/path

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.