[Docs] Update README with comprehensive SDK package information #7738
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
WalkthroughThe README.md file was thoroughly restructured and expanded. The update replaces the previous brief features list with comprehensive sections detailing the core SDK package, adapters, and type-safe API wrappers, including installation instructions, usage examples, and ecosystem package listings. The library comparison table was removed, and resource links were updated. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~6 minutes Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7738 +/- ##
=======================================
Coverage 56.22% 56.22%
=======================================
Files 905 905
Lines 58880 58880
Branches 4134 4134
=======================================
Hits 33106 33106
Misses 25669 25669
Partials 105 105
🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
68-70: Add a quick code snippet for the React Native polyfill stepThe sentence tells users to “import it at app startup for polyfills” but does not show how. A one-liner prevents guesswork:
For React Native Applications, you'll also need to install the `@thirdweb-dev/react-native-adapter` package and import it at app startup for polyfills. + +```typescript +// App.tsx ─ must run before any thirdweb imports +import "@thirdweb-dev/react-native-adapter"; +```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Keep documentation focused on developer experience and practical usage
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/exports/** : Export everything via `exports/` directory, grouped by feature in the SDK public API
README.md (19)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/exports/** : Export everything via exports/ directory, grouped by feature in the SDK public API
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: MananTank
PR: #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.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/exports/** : Every public symbol must have comprehensive TSDoc with at least one @example block that compiles and custom annotation tags (@beta, @internal, @experimental)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Keep documentation focused on developer experience and practical usage
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard/**/*client.tsx : Anything that consumes hooks from @tanstack/react-query or thirdweb SDKs.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/wallets/** : EIP-1193, EIP-5792, EIP-7702 standard support in wallet modules
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/wallets/** : Unified Wallet and Account interfaces in wallet architecture
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/wallets/** : Support for in-app wallets (social/email login)
Learnt from: MananTank
PR: #7332
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/public-pages/nft/overview/nft-drop-claim.tsx:82-90
Timestamp: 2025-06-13T13:03:41.732Z
Learning: The thirdweb contract object is serializable and can safely be used in contexts (e.g., React-Query keys) that require serializable values.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/wagmi-adapter/** : Wagmi ecosystem integration is in packages/wagmi-adapter/
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/react-native-adapter/** : Mobile platform shims are in packages/react-native-adapter/
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/wallets/** : Smart wallets with account abstraction
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard/**/*client.tsx : When you need access to browser APIs (localStorage, window, IntersectionObserver etc.).
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Client Components (browser): Begin files with 'use client';
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Return typed results (e.g., Project[], User[]) – avoid any
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard/**/*.{ts,tsx} : Heavy data fetching that should not ship to the client (e.g. analytics, billing).
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to **/*.{ts,tsx} : Write idiomatic TypeScript with explicit function declarations and return types
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard//api//*.{ts,tsx} : Return typed results (Project[], User[], …) – avoid any.
🪛 LanguageTool
README.md
[style] ~70-~70: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... it at app startup for polyfills. #### For Backend Applications ```bash npm insta...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~140-~140: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...nsight`](./packages/insight/README.md) TypeScript SDK for Insight, thirdweb's multichain ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
README.md
20-20: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
105-105: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
123-123: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Lint Packages
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Build Packages
- GitHub Check: Analyze (javascript)
| ## Core Package | ||
|
|
||
| #### [`thirdweb`](./packages/thirdweb/README.md) | ||
|
|
||
| The main SDK package providing all-in-one web3 functionality for Browser, Node, and Mobile applications. | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix heading-level jumps to satisfy Markdown linting and improve document hierarchy
markdownlint (MD001) flags these sections because they jump directly from an h2 (##) to an h4 (####) without an intermediate h3.
Use ### for the package names (or demote the parent headings) so levels increment by one.
-## Core Package
-#### [`thirdweb`](./packages/thirdweb/README.md)
+## Core Package
+### [`thirdweb`](./packages/thirdweb/README.md)
-## Adapters
-#### [`@thirdweb-dev/react-native-adapter`](./packages/react-native-adapter/README.md)
+## Adapters
+### [`@thirdweb-dev/react-native-adapter`](./packages/react-native-adapter/README.md)
-## Type safe API wrappers
-#### [`@thirdweb-dev/api`](./packages/api/README.md)
+## Type safe API wrappers
+### [`@thirdweb-dev/api`](./packages/api/README.md)Apply the same change to every sub-heading under these sections.
This will silence the linter and make the outline easier to scan.
Also applies to: 103-119, 121-161
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
20-20: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🤖 Prompt for AI Agents
In README.md around lines 18 to 24, the heading levels jump from h2 (##)
directly to h4 (####), which violates markdownlint rule MD001. Change the h4
headings for package names to h3 (###) to ensure proper incremental heading
levels. Apply the same adjustment to all sub-headings under these sections,
including lines 103-119 and 121-161, to fix the linter warnings and improve
document structure.
| ```typescript | ||
| import { createThirdwebClient, Engine } from "thirdweb"; | ||
|
|
||
| const client = createThirdwebClient({ | ||
| secretKey: "YOUR_SECRET_KEY", | ||
| }); | ||
|
|
||
| const wallet = Engine.serverWallet({ | ||
| client, | ||
| address: "0x...", | ||
| }); | ||
|
|
||
| const transaction = transfer({ | ||
| contract: getContract({ | ||
| client, | ||
| address: "0x...", // token contract | ||
| chain: defineChain(1), | ||
| }), | ||
| to: "0x...", // recipient | ||
| amount: "0.01", // amount in tokens | ||
| }); | ||
|
|
||
| await wallet.enqueueTransaction({ | ||
| transaction, | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Backend quick-start snippet omits required imports and may confuse readers
transfer, getContract, and defineChain are used but never imported, so the example will not compile if copy-pasted.
-import { createThirdwebClient, Engine } from "thirdweb";
+import {
+ createThirdwebClient,
+ Engine,
+ transfer,
+ getContract,
+ defineChain,
+} from "thirdweb";Consider adding a short note that these helpers come from the same package to prevent friction for newcomers.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ```typescript | |
| import { createThirdwebClient, Engine } from "thirdweb"; | |
| const client = createThirdwebClient({ | |
| secretKey: "YOUR_SECRET_KEY", | |
| }); | |
| const wallet = Engine.serverWallet({ | |
| client, | |
| address: "0x...", | |
| }); | |
| const transaction = transfer({ | |
| contract: getContract({ | |
| client, | |
| address: "0x...", // token contract | |
| chain: defineChain(1), | |
| }), | |
| to: "0x...", // recipient | |
| amount: "0.01", // amount in tokens | |
| }); | |
| await wallet.enqueueTransaction({ | |
| transaction, | |
| }); | |
| ``` | |
| import { | |
| createThirdwebClient, | |
| Engine, | |
| transfer, | |
| getContract, | |
| defineChain, | |
| } from "thirdweb"; | |
| const client = createThirdwebClient({ | |
| secretKey: "YOUR_SECRET_KEY", | |
| }); | |
| const wallet = Engine.serverWallet({ | |
| client, | |
| address: "0x...", | |
| }); | |
| const transaction = transfer({ | |
| contract: getContract({ | |
| client, | |
| address: "0x...", // token contract | |
| chain: defineChain(1), | |
| }), | |
| to: "0x...", // recipient | |
| amount: "0.01", // amount in tokens | |
| }); | |
| await wallet.enqueueTransaction({ | |
| transaction, | |
| }); |
🤖 Prompt for AI Agents
In README.md between lines 76 and 101, the example code uses transfer,
getContract, and defineChain without importing them, which will cause
compilation errors. Add import statements for these functions from the
"thirdweb" package at the top of the snippet. Also, include a brief note
clarifying that these helpers come from the same package to help new users
understand where they originate.
size-limit report 📦
|
joaquim-verges
deleted the
_Docs_Update_README_with_comprehensive_SDK_package_information
branch
PR-Codex overview
This PR updates the
README.mdto enhance the documentation of thethirdwebSDK, introducing a structured overview of the core package, features, installation instructions, and adapters, while removing outdated content.Detailed summary
Core Packagesection detailing thethirdwebSDK.Adapterssection for additional SDK integrations.Type safe API wrapperssection for TypeScript SDKs.Library Comparisontable.Additional Resourcessection for clarity.Summary by CodeRabbit