Fix typos in comments and docs across thirdweb packages #8033
Conversation
Signed-off-by: sashaodessa <140454972+sashaodessa@users.noreply.github.com>
Signed-off-by: sashaodessa <140454972+sashaodessa@users.noreply.github.com>
Signed-off-by: sashaodessa <140454972+sashaodessa@users.noreply.github.com>
Signed-off-by: sashaodessa <140454972+sashaodessa@users.noreply.github.com>
|
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
WalkthroughDocumentation/comment typo corrections across multiple files; no runtime, control flow, or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks (2 passed, 1 warning)❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches
🧪 Generate 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. Comment |
|
@sashaodessa is attempting to deploy a commit to the thirdweb Team on Vercel. A member of the Team first needs to authorize it. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
packages/thirdweb/src/react/core/hooks/contract/useContractEvents.ts (1)
31-31: Typo in param docs: “Shuould” → “Should”.Minor doc polish.
Apply this diff:
- * @param options.events - The events to watch. Shuould be an array of [prepared events](https://portal.thirdweb.com/references/typescript/v5/prepareEvent). + * @param options.events - The events to watch. Should be an array of [prepared events](https://portal.thirdweb.com/references/typescript/v5/prepareEvent).packages/thirdweb/src/react/core/hooks/contract/useWaitForReceipt.ts (1)
36-36: Optional: safer optional chaining + nullish coalescing.Prevents accessing
.idwhenchainis undefined and avoids||semantics.- options?.chain.id || -1, + options?.chain?.id ?? -1,
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
packages/thirdweb/src/react/core/hooks/contract/useContractEvents.ts(1 hunks)packages/thirdweb/src/react/core/hooks/contract/useWaitForReceipt.ts(1 hunks)packages/thirdweb/src/rpc/rpc.ts(1 hunks)packages/thirdweb/src/wallets/in-app/native/ecosystem.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx}: Write idiomatic TypeScript with explicit function declarations and return types
Limit each file to one stateless, single-responsibility function for clarity
Re-use shared types from@/typesor localtypes.tsbarrels
Prefer type aliases over interface except for nominal shapes
Avoidanyandunknownunless unavoidable; narrow generics when possible
Choose composition over inheritance; leverage utility types (Partial,Pick, etc.)
Comment only ambiguous logic; avoid restating TypeScript in prose
**/*.{ts,tsx}: Use explicit function declarations and explicit return types in TypeScript
Limit each file to one stateless, single‑responsibility function
Re‑use shared types from@/typeswhere applicable
Prefertypealiases overinterfaceexcept for nominal shapes
Avoidanyandunknownunless unavoidable; narrow generics when possible
Prefer composition over inheritance; use utility types (Partial, Pick, etc.)
Lazy‑import optional features and avoid top‑level side‑effects to reduce bundle size
Files:
packages/thirdweb/src/rpc/rpc.tspackages/thirdweb/src/wallets/in-app/native/ecosystem.tspackages/thirdweb/src/react/core/hooks/contract/useWaitForReceipt.tspackages/thirdweb/src/react/core/hooks/contract/useContractEvents.ts
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (CLAUDE.md)
Load heavy dependencies inside async paths to keep initial bundle lean (lazy loading)
Files:
packages/thirdweb/src/rpc/rpc.tspackages/thirdweb/src/wallets/in-app/native/ecosystem.tspackages/thirdweb/src/react/core/hooks/contract/useWaitForReceipt.tspackages/thirdweb/src/react/core/hooks/contract/useContractEvents.ts
packages/thirdweb/**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
packages/thirdweb/**/*.{ts,tsx}: Every public symbol must have comprehensive TSDoc with at least one compiling@exampleand a custom tag (@beta,@internal,@experimental, etc.)
Comment only ambiguous logic; avoid restating TypeScript in prose
Lazy‑load heavy dependencies inside async paths (e.g.,const { jsPDF } = await import("jspdf"))
Files:
packages/thirdweb/src/rpc/rpc.tspackages/thirdweb/src/wallets/in-app/native/ecosystem.tspackages/thirdweb/src/react/core/hooks/contract/useWaitForReceipt.tspackages/thirdweb/src/react/core/hooks/contract/useContractEvents.ts
packages/thirdweb/src/wallets/**
📄 CodeRabbit inference engine (CLAUDE.md)
packages/thirdweb/src/wallets/**: UnifiedWalletandAccountinterfaces in wallet architecture
Support for in-app wallets (social/email login)
Smart wallets with account abstraction
EIP-1193, EIP-5792, EIP-7702 standard support in wallet modules
Files:
packages/thirdweb/src/wallets/in-app/native/ecosystem.ts
🧠 Learnings (1)
📚 Learning: 2025-06-17T18:30:52.976Z
Learnt from: MananTank
PR: thirdweb-dev/js#7356
File: apps/nebula/src/app/not-found.tsx:1-1
Timestamp: 2025-06-17T18:30:52.976Z
Learning: In the thirdweb/js project, the React namespace is available for type annotations (like React.FC) without needing to explicitly import React. This is project-specific configuration that differs from typical TypeScript/React setups.
Applied to files:
packages/thirdweb/src/react/core/hooks/contract/useContractEvents.ts
🔇 Additional comments (4)
packages/thirdweb/src/rpc/rpc.ts (1)
128-128: Typo fix LGTM.“assign” comment reads correctly; no runtime changes.
packages/thirdweb/src/react/core/hooks/contract/useContractEvents.ts (1)
40-40: Docs path fix LGTM.Corrected to
thirdweb/extensions.packages/thirdweb/src/react/core/hooks/contract/useWaitForReceipt.ts (1)
35-35: Typo fix in TODO LGTM.“undefined” spelled correctly.
packages/thirdweb/src/wallets/in-app/native/ecosystem.ts (1)
51-51: Docs wording fix LGTM.“partner” reads correctly.
Correct minor spelling mistakes in comments/docs.
useContractEvents.ts: “extesions” → “extensions”useWaitForReceipt.ts: “undefned” → “undefined”rpc.ts: “assing” → “assign”ecosystem.ts: “parnter” → “partner”PR-Codex overview
This PR focuses on correcting typos and improving code comments for clarity across various files in the
thirdwebpackage.Detailed summary
undfinedtoundefinedinuseWaitForReceipt.ts.assingtoassigninrpc.ts.extesionstoextensionsinuseContractEvents.ts.parntertopartnerinecosystem.ts.Summary by CodeRabbit