[Docs] Add Bundler API reference documentation #7257
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
WalkthroughA new API reference documentation for the Thirdweb Bundler service was added, detailing supported methods and usage. The sidebar was updated to include a link to this API reference, and a new "Bundler" SDK card was introduced in the backend APIs grid on the reference page, linking to the documentation. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant PortalSidebar
participant ReferencePage
participant APIReferenceDoc
User->>PortalSidebar: Opens sidebar
PortalSidebar-->>User: Displays "API Reference" link
User->>ReferencePage: Views Backend APIs grid
ReferencePage-->>User: Shows "Bundler" SDK card
User->>APIReferenceDoc: Clicks "API Reference" or "Bundler" card
APIReferenceDoc-->>User: Displays Thirdweb Bundler API documentation
Suggested labels
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
✨ Finishing Touches
🪧 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 (
|
github-actions
bot
added
the
Portal
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. |
joaquim-verges
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7257 +/- ##
=======================================
Coverage 55.57% 55.57%
=======================================
Files 909 909
Lines 58680 58680
Branches 4157 4157
=======================================
Hits 32610 32610
Misses 25963 25963
Partials 107 107
🚀 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: 1
🧹 Nitpick comments (6)
apps/portal/src/app/connect/account-abstraction/api/page.mdx (6)
20-28: Use uppercase “URL” and annotate code block language
Change the heading to “URL Format” for consistency, and update the code fence to use a language specifier (e.g., ```bash) for proper syntax highlighting.
380-389: Standard ERC-4337 Methods
The list of standard bundler RPC methods is useful; consider linking to the official ERC-4337 specification for deeper reference.
435-463: Policy Enforcement details
The policy check process is well articulated; adding a concrete policy rejection example would further illustrate the behavior.🧰 Tools
🪛 LanguageTool
[duplication] ~441-~441: Possible typo: you repeated a word.
Context: ...s paymaster requests against configured policies 2. Policies can restrict based on: - Contract ad...(ENGLISH_WORD_REPEAT_RULE)
472-477: Rate Limits and Quotas formatting
The bullets are clear; for consistency, you may choose to add or remove terminal punctuation across all bulleted sections.🧰 Tools
🪛 LanguageTool
[uncategorized] ~476-~476: A period might be missing here.
Context: ...n - Testnet access is available on free plans ## Supported Networks For the most up...(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
478-482: Supported Networks link
The dashboard URL is helpful; consider marking it as external ([isExternal]) or adding an icon to indicate navigation off-site.
483-491: SDK Integration links
Ensure the SDK URLs include the correct version path (e.g.,/typescript/v5) to align with other documentation routes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
apps/portal/src/app/connect/account-abstraction/api/page.mdx(1 hunks)apps/portal/src/app/connect/sidebar.tsx(1 hunks)apps/portal/src/app/page.tsx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/connect/account-abstraction/api/page.mdx
[uncategorized] ~231-~231: Loose punctuation mark.
Context: ...} ``` Status Values: - not_found: User operation not found - `not_submitt...
(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~441-~441: Possible typo: you repeated a word.
Context: ...s paymaster requests against configured policies 2. Policies can restrict based on: - Contract ad...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~476-~476: A period might be missing here.
Context: ...n - Testnet access is available on free plans ## Supported Networks For the most up...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Lint Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (12)
apps/portal/src/app/connect/sidebar.tsx (1)
201-204: Add API Reference link to Account Abstraction section
The new “API Reference” link is correctly inserted and points to${aAslug}/api, aligning with the existing slug usage.apps/portal/src/app/page.tsx (1)
143-148: Introduce Bundler SDKCard in Backend APIs grid
The new “Bundler” card is consistent with existing cards and correctly links to the/connect/account-abstraction/apipage.apps/portal/src/app/connect/account-abstraction/api/page.mdx (10)
1-4: Document title and intro are clear
The header and introduction succinctly describe the Thirdweb Bundler service and its capabilities.
29-35: Authentication section is accurate
HeadersX-Client-IdandX-Secret-Keyare clearly defined and explained.
36-48: Request format follows JSON-RPC 2.0
The example request is well-formed and demonstrates the correct payload structure.
49-93: Paymaster Methods documented correctly
Eachpm_*method has a clear purpose, parameter list, and response example.
127-165: User Operation Methods section is complete
The gas estimation and submission methods are well explained with accurate JSON examples.
183-202: Gas Price Methods are clear
Thethirdweb_getUserOperationGasPricemethod is properly defined with an illustrative response.
204-227: Status and Tracking Methods are thorough
All possible user operation statuses are listed, and the example response covers the relevant fields.
239-275: zkSync-specific Methods are well covered
Bothzk_paymasterDataandzk_broadcastTransactionsections include clear parameter definitions and examples.
312-356: Verify EIP-7702 Methods parameter order
Thetw_executeexample clearly shows parameters and response; please confirm that the client implementation expects this exact sequence.
390-403: Error Responses section is correct
The JSON-RPC error format and example codes are accurately presented.
| ## Table of Contents | ||
|
|
||
| - [Url format](#url-format) | ||
| - [Authentication](#authentication) | ||
| - [Request Format](#request-format) | ||
| - [Paymaster Methods](#paymaster-methods) | ||
| - [User Operation Methods](#user-operation-methods) | ||
| - [Gas Price Methods](#gas-price-methods) | ||
| - [Status and Tracking Methods](#status-and-tracking-methods) | ||
| - [zkSync-Specific Methods](#zksync-specific-methods) | ||
| - [EIP-7702 Methods](#eip-7702-methods) | ||
| - [Standard ERC-4337 Methods](#standard-erc-4337-methods) | ||
| - [Error Responses](#error-responses) | ||
| - [Policy Enforcement](#policy-enforcement) | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Include missing sections in the Table of Contents
Add “Rate Limits and Quotas”, “Supported Networks”, and “SDK Integration” to the TOC for complete navigation.
🤖 Prompt for AI Agents
In apps/portal/src/app/connect/account-abstraction/api/page.mdx around lines 5
to 19, the Table of Contents is missing the sections "Rate Limits and Quotas",
"Supported Networks", and "SDK Integration". Add these three entries to the TOC
list with appropriate anchor links to ensure complete navigation coverage.
size-limit report 📦
|
joaquim-verges
deleted the
_Connect_Add_Bundler_API_reference_documentation
branch
PR-Codex overview
This PR focuses on enhancing the API reference documentation and adding new features to the
sidebar.tsxandpage.tsxcomponents in the portal app, specifically related to the Thirdweb Bundler and its functionalities.Detailed summary
sidebar.tsx.SDKCardfor "Bundler" inpage.tsx.api/page.mdxwith detailed sections on authentication, request formats, methods, and error handling for the Thirdweb Bundler.Summary by CodeRabbit