Skip to content

docs: JSDoc all consumer-facing exports and update README#59

Merged
satoshai-dev merged 3 commits intomainfrom
docs/jsdoc-exports
Mar 6, 2026
Merged

docs: JSDoc all consumer-facing exports and update README#59
satoshai-dev merged 3 commits intomainfrom
docs/jsdoc-exports

Conversation

@satoshai-dev
Copy link
Copy Markdown
Owner

Summary

  • Add JSDoc documentation to all 20 consumer-facing source files: hooks, errors, types, utilities, provider, and constants
  • Update README with:
    • Typed useWriteContract mode with ABI autocomplete example and link to @satoshai/abi-cli
    • createContractConfig() utility usage
    • Error handling guide with all error classes
    • Mutation hook return types table
    • WalletConnect session management section (zombie detection, disconnect, account changes)
    • Provider props table
    • Expanded hook docs with full return shapes and onSettled callbacks

Closes #34

Test plan

  • pnpm typecheck — no errors
  • pnpm test — 175/175 tests pass
  • pnpm build — builds successfully
  • JSDoc comments are documentation-only, no logic changes

🤖 Generated with Claude Code

satoshai-dev and others added 3 commits March 6, 2026 16:46
Add comprehensive JSDoc documentation to all hooks, errors, types,
utilities, provider, and constants. Update README with typed
useWriteContract examples, createContractConfig, error handling guide,
mutation return types table, and WalletConnect session management docs.

Closes #34

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Neither wallet fully implements SIP-030. Xverse uses a proprietary
addListener('accountChange') API, and Leather does not emit account
change events at all.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@satoshai-dev satoshai-dev merged commit f2e8259 into main Mar 6, 2026
1 check 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.

Add JSDoc to all exported hooks, types, and utilities

1 participant