docs(express): document the address/derive endpoint and trust model#9038
Merged
Merged
Conversation
Expand the OpenAPI doc comment for POST /api/v2/{coin}/address/derive (the source
of the generated API reference) to cover: supported coins and the keychain material
each needs (UTXO xpub triple + chain/script-type codes; MPC/TSS commonKeychain for
EVM and EdDSA), the offline/air-gapped + stateless properties, the recommended
derive->verify round-trip with iswalletaddress, and the "bring your own trusted
keys" guidance (the verification is only meaningful with independently-held keys).
WCN-919
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the
POST /api/v2/{coin}/address/deriveendpoint by expanding its OpenAPI doc comment — the source of the generated API reference (the repo documents endpoints via typed-route JSDoc, not the README, matchingisWalletAddress).The expanded description covers:
pub(withchain→ script-type mapping: 0/1 P2SH, 10/11 P2SH-P2WSH, 20/21 P2WSH/bech32, 30/31 P2TR); MPC/TSScommonKeychainfor EVM (v3/5/6; legacy forwarder v1/2/4 not yet supported) and EdDSA (SOL, incl. SMCderivedFromParentWithSeed).iswalletaddress.Context
FR-465 Phase 1 docs (WCN-919). Docs-only change to one file.
Test plan
audit-api-specCI command (openapi-generator --codec-file … index.ts), exit 0, description present in the generated speceslintclean🤖 Generated with Claude Code