Skip to content

docs(caip): fix createCaip10AccountId JSDoc argument order - #213

Open
kutluhaneth46 wants to merge 1 commit into
agentcommercekit:mainfrom
kutluhaneth46:cursor/fix-caip10-jsdoc-88c1
Open

docs(caip): fix createCaip10AccountId JSDoc argument order#213
kutluhaneth46 wants to merge 1 commit into
agentcommercekit:mainfrom
kutluhaneth46:cursor/fix-caip10-jsdoc-88c1

Conversation

@kutluhaneth46

@kutluhaneth46 kutluhaneth46 commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Align createCaip10AccountId JSDoc @param order with the real (chainId, address) signature.
  • Use a full Solana CAIP-2 chain ID in the example instead of bare solana.

Same class of docs mismatch as the merged createDidPkhUri fix (#209), but for CAIP-10. No existing open/closed PR covers this JSDoc.

Testing

  • Docs-only; compared against packages/caip/README.md and caip-10.test.ts call sites.

AI usage disclosure

Assisted by Cursor. I confirmed the signature/docs mismatch against README and tests before submitting.

Summary by CodeRabbit

  • Documentation
    • Clarified the chainId parameter documentation with complete CAIP-2 chain ID examples.
    • Reordered parameter descriptions for improved readability.

Align @PARAM order with the real (chainId, address) signature and use a
full Solana CAIP-2 chain ID instead of bare `solana`.
@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: e8990591-e745-45ab-bff4-ab0c7dc0271e

📥 Commits

Reviewing files that changed from the base of the PR and between 843e396 and 3cfbe44.

📒 Files selected for processing (1)
  • packages/caip/src/caips/caip-10.ts

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.


Walkthrough

The pull request updates the createCaip10AccountId JSDoc. It reorders the parameters and documents chainId with full CAIP-2 examples. No functional code changes are included.

Changes

CAIP-10 documentation

Layer / File(s) Summary
Clarify CAIP-10 parameters
packages/caip/src/caips/caip-10.ts
The JSDoc lists chainId before address and describes full CAIP-2 chain IDs such as eip155:1 and solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 3cfbe

This updates CAIP-10 helper documentation to accurately describe its existing chain ID and address arguments, with no runtime behavior or public API change. The documented examples match existing usage, so the change is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documentation change to correct the createCaip10AccountId JSDoc argument order. It matches the main change in the pull request.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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