Skip to content

docs: remove phantom multi-context proof API - #18

Merged
peetzweg merged 1 commit into
feat/encode-members-and-docsfrom
docs/remove-phantom-multi-context
Jun 23, 2026
Merged

docs: remove phantom multi-context proof API#18
peetzweg merged 1 commit into
feat/encode-members-and-docsfrom
docs/remove-phantom-multi-context

Conversation

@peetzweg

@peetzweg peetzweg commented Jun 8, 2026

Copy link
Copy Markdown
Member

Removes documentation for a multi-context proof API that does not exist in the bindings.

Both READMEs documented create_multi_context, validate_multi_context, is_valid_multi_context, and the MultiContextResult type as public API. None of these are implemented in packages/verifiablejs/src/lib.rs — the only "multi context" thing in the codebase is a test named test_multi_context_aliases_are_unlinkable, which actually just exercises alias_in_context. A consumer following the docs would hit undefined is not a function.

Removed

  • Root README: TOC entry, the "Multi-Context Proofs" concept section, the full API-reference section (all three functions), the orphaned "Encoding Contexts for Multi-Context Functions" helper, and the MultiContextResult interface.
  • The @polkadot/types example only demonstrated encoding Vec<Vec<u8>> contexts (multi-context input) — repurposed it to encoding members, which is a real need.
  • Package README: the three phantom rows in the API table.
  • A create_multi_context mention in the alias_in_context description.

Notes

The READMEs documented `create_multi_context`, `validate_multi_context`,
`is_valid_multi_context`, and `MultiContextResult` as public API, but none
of these are implemented in lib.rs — only a test named
`test_multi_context_aliases_are_unlinkable` exists (it exercises
`alias_in_context`). Documenting a non-existent API misleads consumers.

Removes the TOC entry, concept section, full API-reference section, the
orphaned "Encoding Contexts" helper, the @polkadot/types contexts example
(repurposed to members), and the `MultiContextResult` type. Also drops the
three phantom rows from the package README's API table.
@peetzweg
peetzweg merged commit dd0f5e7 into feat/encode-members-and-docs Jun 23, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant