Skip to content

feat: add API surface tracking with api-extractor for v1.0.0 - #152

Merged
truthixify merged 7 commits into
wraith-protocol:developfrom
code3ks:feat/api-stability-sweep-v1
Jul 29, 2026
Merged

feat: add API surface tracking with api-extractor for v1.0.0#152
truthixify merged 7 commits into
wraith-protocol:developfrom
code3ks:feat/api-stability-sweep-v1

Conversation

@code3ks

@code3ks code3ks commented Jul 24, 2026

Copy link
Copy Markdown
Contributor
  • Mark internal implementation helpers with @internal TSDoc tag
    • Stellar: scalar utilities, cache, event filters, batch builder
    • EVM/Solana/CKB: builders, deployments, announcements
  • Add Stellar multisig exports (buildMultisigStealthWithdraw, etc.)
  • Install @microsoft/api-extractor with configs for all 6 entry points
  • Generate API report snapshots in etc/*.api.md
  • Add pnpm api:check script to validate API surface
  • Update CI to fail on undocumented API changes
  • Update companion packages peerDependencies to >=1.0.0 <2

Closes #124

@drips-wave

drips-wave Bot commented Jul 24, 2026

Copy link
Copy Markdown

@code3ks Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@truthixify

Copy link
Copy Markdown
Contributor

The api:check failure in test (22) is a first-run setup thing on your side. api-extractor is diffing the current public API against a committed baseline at etc/*.api.md, but the baselines don't exist yet because this PR is what's introducing them.

To fix:

  1. Run pnpm build locally. api-extractor's local mode auto-generates the initial baseline files (etc/sdk.api.md, etc/sdk-evm.api.md, etc/sdk-stellar.api.md, etc/sdk-solana.api.md, etc/sdk-ckb.api.md, etc/sdk-vault.api.md).
  2. git add etc/ and commit them.
  3. Force-push.

After that CI will pass because the baselines exist and match the code. Future PRs that change the public API will need to update these files in the same commit.

@code3ks

code3ks commented Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

CI passed succesfully now,you can review and merge. Thank you

@truthixify

Copy link
Copy Markdown
Contributor

Cascade conflict from sdk#149 landing right before this. Rebase against develop and force-push, should slot in cleanly next.

code3ks added 6 commits July 29, 2026 11:05
- Mark internal implementation helpers with @internal TSDoc tag
  - Stellar: scalar utilities, cache, event filters, batch builder
  - EVM/Solana/CKB: builders, deployments, announcements
- Add Stellar multisig exports (buildMultisigStealthWithdraw, etc.)
- Install @microsoft/api-extractor with configs for all 6 entry points
- Generate API report snapshots in etc/*.api.md
- Add pnpm api:check script to validate API surface
- Update CI to fail on undocumented API changes
- Update companion packages peerDependencies to >=1.0.0 <2

Closes wraith-protocol#124
@code3ks
code3ks force-pushed the feat/api-stability-sweep-v1 branch from dadd842 to 180bbdf Compare July 29, 2026 10:08
@truthixify
truthixify merged commit 7245ad8 into wraith-protocol:develop Jul 29, 2026
11 checks passed
@truthixify

Copy link
Copy Markdown
Contributor

In. API-extractor plus baseline files lands. Future public-surface changes will get flagged automatically now, nice work.

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.

SDK v1.0.0 API-stability sweep

2 participants