Skip to content

Spike: Audit which src/*.ts modules are unreachable from src/index.ts and decide removal vs export #143

Description

@meshackyaro

Description

This audit found a consistent pattern of source files that exist in src/ but are never reached from the package's actual public entrypoint (src/index.ts) and, in several cases, aren't imported by any other file in src/ either: src/utils.ts (imports missing dependencies), src/utils/cache.ts's SimpleCache, src/utils/logger.ts's SDKLogger, src/utils/validate.ts, src/stellar/horizon.ts's submitTransaction, src/hooks/* (not exported from the root, tracked in #81), and src/errors.ts's TrustFlowError itself (used internally everywhere, but not exported — a different flavor of the same "unreachable from outside" problem). Each of these has its own narrow companion issue in this batch, but there's no single place that decided, module by module, "is this dead code to delete, or a real feature that should be exported and documented" — leaving open the risk that future contributors keep independently rediscovering (or worse, silently reimplementing) functionality that already exists but isn't reachable.

Component

SDK

Difficulty

🟣 Spike — investigation required, scope not yet defined

Tasks

  • Enumerate every exported symbol in src/ and trace whether it's reachable from src/index.ts (directly or transitively)
  • For each unreachable module/symbol, classify it as "delete" or "export + document"
  • Cross-reference against the companion per-module issues already filed in this batch so decisions aren't duplicated
  • Produce a short written recommendation and file/close the relevant per-module issues accordingly

Acceptance Criteria

  • A written audit listing every currently-unreachable src/ module/symbol and its disposition (delete vs export)
  • Follow-up issues filed or closed to match the recommendation

Estimated Time

1-2 days (time-boxed spike)

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdifficulty: spikeResearch/investigation issue — scope and approach are not yet definedinfrastructurepriority: mediumMedium priority issuequestionFurther information is requestedsdk

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions