-
Notifications
You must be signed in to change notification settings - Fork 838
tx: improve JSDoc annotations #4161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances code documentation by adding comprehensive JSDoc annotations to utility functions and type guards in the tx package. The changes improve developer experience by documenting function parameters, return types, and behavior.
- Added JSDoc annotations to utility functions in
internal.ts - Added JSDoc annotations to type guard functions in
types.ts - Added JSDoc annotations to capability functions in
legacy.tsandeip2718.ts
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/tx/src/util/internal.ts | Added JSDoc annotations for utility functions including getCommon, txTypeBytes, validateNotArray, sharedConstructor, and getBaseJSON |
| packages/tx/src/types.ts | Added JSDoc annotations for type guard functions checking transaction types and transaction data types |
| packages/tx/src/capabilities/legacy.ts | Added JSDoc annotations for errorMsg and isSigned helper functions |
| packages/tx/src/capabilities/eip2718.ts | Added JSDoc annotations for EIP-2718 transaction helper functions including getHashedMessageToSign, serialize, and validateYParity |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
Please label. Also - as a tip: these kind of PRs can be run with the new "type: test no browser" and "type: skip most of VM" labels, then CI is significantly faster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
Adds missing JSDoc annotations to functions in the tx package