Skip to content

api: Stop requiring private vector helpers #49

Description

@BenWestgate

Before v1, constructing and checking reference vectors must not require underscore-prefixed imports, while unrelated implementation internals should remain private rather than being indiscriminately re-exported.

Implemented and reviewed in PR #53:

  • publish the checksum specifications/u5 conversion/checksum-selection helpers needed for external vector work at their owning modules;
  • document a vector-construction workflow using supported names only;
  • audit production cross-module private imports and document the remaining correction/profile/wallet/Core/CLI couplings instead of renaming them cosmetically;
  • keep package-level codex32.__all__ deliberate.

The reviewed follow-up also makes chars_to_u5() ASCII-case-insensitive without Unicode folding and introduces the shared private _ascii_lower helper intended to absorb #13's duplicate ASCII-only normalization.

Final integration is intentionally deferred until the overlapping runtime/API prerequisites settle: #42/#57/#46, #13, #33 and #64. #7/#51 are already in reviewability-v1; #45 is already in #42. After #64, package-level codex32.__all__ should contain 23 names; #53's module-level vector helpers do not change that count. Refresh #53 once, rerun vector/API/full CI and review threads, then apply the repository's human rewrite/squash policy to the Codex-authored follow-up before merge.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: apiPublic and supported Python API boundaries.area: bip93BIP93 encoding, checksum, parsing, and format rules.enhancementNew feature or requestgate: adversarial reviewResolve, merge, or explicitly defer before the next full adversarial review.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions