Stylus CLI updates #7502
Stylus CLI updates #7502
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
""" WalkthroughThe CLI project creation flow is extended with new Stylus project templates including ERC721, ERC1155, and various airdrop types. Project creation logic is unified into a single variable with consolidated error handling after all template cloning attempts. Additionally, new ABI files, deployment logic for Stylus contracts with constructors, constructor signature parsing, and prerequisite tool checks are introduced. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant GitRepo
User->>CLI: Select Stylus project type (ERC20, ERC721, ERC1155, Airdrop variants)
CLI->>CLI: Check prerequisites (cargo, rustc, solc)
CLI->>CLI: Assign newProject via spawnSync based on selected template
CLI->>GitRepo: Clone corresponding template repository
CLI->>CLI: Check newProject exit status
alt Success
CLI->>User: Confirm project creation
else Failure
CLI->>User: Show error and exit
end
sequenceDiagram
participant Builder
participant StylusCLI
Builder->>StylusCLI: Run `cargo stylus constructor` to get constructor signature
StylusCLI->>Builder: Return constructor signature string
Builder->>Builder: Parse signature string to ABI constructor object
Builder->>Builder: Prepend constructor ABI to ABI array if missing
sequenceDiagram
participant DeployFunction
participant StylusDeployerContract
participant Blockchain
DeployFunction->>StylusDeployerContract: Prepare deploy transaction with bytecode, encoded constructor calldata, zero value, zero salt
DeployFunction->>Blockchain: Send and confirm transaction
Blockchain->>DeployFunction: Emit ContractDeployed event with deployed contract address
DeployFunction->>DeployFunction: Parse event logs and extract deployed address
Possibly related PRs
Suggested reviewers
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 (
|
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. |
kumaryash90
added
the
DO NOT MERGE
![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)
packages/thirdweb/src/cli/commands/stylus/create.ts (1)
66-72: Consider refactoring to reduce code duplication.The ERC721 branch is nearly identical to the ERC20 branch, differing only in the repository URL and spinner message. Consider extracting the common logic into a helper function.
+ const cloneTemplate = (templateType: string, repoUrl: string, projectName: string) => { + spinner.start(`Creating new ${templateType} Stylus project: ${projectName}...`); + return spawnSync("git", ["clone", repoUrl, projectName], { + stdio: "inherit", + }); + }; + } else if (projectType === "erc20") { - const repoUrl = "[email protected]:thirdweb-example/stylus-erc20-template.git"; - spinner.start(`Creating new ERC20 Stylus project: ${projectName}...`); - newProject = spawnSync("git", ["clone", repoUrl, projectName], { - stdio: "inherit", - }); + newProject = cloneTemplate("ERC20", "[email protected]:thirdweb-example/stylus-erc20-template.git", projectName); } else if (projectType === "erc721") { - const repoUrl = "[email protected]:thirdweb-example/stylus-erc721-template.git"; - spinner.start(`Creating new ERC721 Stylus project: ${projectName}...`); - newProject = spawnSync("git", ["clone", repoUrl, projectName], { - stdio: "inherit", - }); + newProject = cloneTemplate("ERC721", "[email protected]:thirdweb-example/stylus-erc721-template.git", projectName);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/thirdweb/src/cli/commands/stylus/create.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{ts,tsx}`: Write idiomatic TypeScript with explicit function declarations ...
**/*.{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
Load heavy dependencies inside async paths to keep initial bundle lean (lazy loading)
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/thirdweb/src/cli/commands/stylus/create.ts
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/form.ts:25-42
Timestamp: 2025-06-10T00:46:00.514Z
Learning: In NFT creation functions, the setClaimConditions function signatures are intentionally different between ERC721 and ERC1155. ERC721 setClaimConditions accepts the full CreateNFTFormValues, while ERC1155 setClaimConditions accepts a custom object with nftCollectionInfo and nftBatch parameters because it processes batches differently than the entire form data.
packages/thirdweb/src/cli/commands/stylus/create.ts (1)
Learnt from: MananTank
PR: thirdweb-dev/js#7434
File: apps/dashboard/src/app/(app)/team/~/~/contract/[chain]/[contractAddress]/components/project-selector.tsx:62-76
Timestamp: 2025-06-24T21:38:03.155Z
Learning: In the project-selector.tsx component for contract imports, the addToProject.mutate() call is intentionally not awaited (fire-and-forget pattern) to allow immediate navigation to the contract page while the import happens in the background. This is a deliberate design choice to prioritize user experience.
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: Unit Tests
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Size
- GitHub Check: Build Packages
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Lint Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
packages/thirdweb/src/cli/commands/stylus/create.ts (1)
46-46: LGTM: ERC721 template option added correctly.The new ERC721 template option follows the existing pattern and integrates well with the project type selection.
| ], | ||
| message: "Select a template:", | ||
| name: "projectType", | ||
| type: "select", | ||
| }); | ||
|
|
||
| // Step 5: Create the project | ||
| let newProject; |
There was a problem hiding this comment.
Add explicit type annotation to comply with coding guidelines.
The variable declaration violates the coding guidelines which require explicit types and avoiding any. The implicit any type should be replaced with the proper return type.
- let newProject;
+ let newProject: ReturnType<typeof spawnSync>;📝 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.
| let newProject; | |
| let newProject: ReturnType<typeof spawnSync>; |
🤖 Prompt for AI Agents
In packages/thirdweb/src/cli/commands/stylus/create.ts at line 54, the variable
newProject is declared without an explicit type, causing an implicit any type
violation. Add an explicit type annotation to newProject that matches the
expected return type of the value it will hold, ensuring compliance with coding
guidelines that forbid implicit any types.
| if (!newProject?.status || newProject.status !== 0) { | ||
| spinner.fail("Failed to create Stylus project."); | ||
| process.exit(1); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add explicit handling for unexpected project types.
The unified error handling is good, but if projectType doesn't match any known values, newProject remains undefined and triggers the error condition. Consider adding an explicit else clause or validation.
+ } else {
+ spinner.fail(`Unknown project type: ${projectType}`);
+ process.exit(1);
+ }
+
- if (!newProject?.status || newProject.status !== 0) {
+ if (!newProject || newProject.status !== 0) {This makes the error handling more explicit and removes the need for optional chaining since newProject will always be defined at this point.
🤖 Prompt for AI Agents
In packages/thirdweb/src/cli/commands/stylus/create.ts around lines 74 to 77,
add explicit validation for the projectType before creating newProject to ensure
it matches known values. Include an else clause that handles unexpected
projectType values by setting newProject to a defined error state or throwing an
error. This will guarantee newProject is always defined, allowing you to remove
optional chaining and make error handling more explicit and clear.
size-limit report 📦
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #7502 +/- ##
==========================================
- Coverage 51.96% 51.86% -0.11%
==========================================
Files 952 954 +2
Lines 64220 64375 +155
Branches 4237 4240 +3
==========================================
+ Hits 33375 33391 +16
- Misses 30738 30876 +138
- Partials 107 108 +1
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts (2)
14-33: Consider logging errors for debugging purposes.While the boolean return pattern is appropriate for an activation check, swallowing all errors silently might make debugging difficult. Consider adding optional error logging or returning a result object with error details.
export async function isContractActivated( options: IsContractActivatedOptions, ): Promise<boolean> { const { chain, client, bytecode } = options; const arbWasmPrecompile = getContract({ address: ARB_WASM_ADDRESS, chain, client, }); try { await codehashVersion({ codehash: keccak256(extractRuntimeBytecode(bytecode)), contract: arbWasmPrecompile, }); return true; - } catch { + } catch (error) { + // Optionally log for debugging while maintaining the simple boolean API + if (process.env.NODE_ENV === 'development') { + console.debug('Contract activation check failed:', error); + } return false; } }
35-90: Consider extracting magic numbers as named constants.The function implementation is thorough, but the magic numbers and expected pattern could be more maintainable as named constants.
+// Constants for Stylus deployment bytecode structure +const PUSH32_OPCODE = 0x7f; +const PRELUDE_LENGTH = 42; +const VERSION_BYTE_LENGTH = 1; +const TOTAL_FIXED_LENGTH = PRELUDE_LENGTH + VERSION_BYTE_LENGTH; +const EXPECTED_PRELUDE_PATTERN = [ + 0x80, // DUP1 + 0x60, 0x2b, // PUSH1 0x2b (42 + 1) + 0x60, 0x00, // PUSH1 0 + 0x39, // CODECOPY + 0x60, 0x00, // PUSH1 0 + 0xf3, // RETURN + 0x00, // version +] as const; function extractRuntimeBytecode(deployInput: string | Uint8Array): Uint8Array { // normalise input const deploy: Uint8Array = typeof deployInput === "string" ? hexToBytes(deployInput) : deployInput; - // the contract_deployment_calldata helper emits 42-byte prelude + 1-byte version => 43 bytes total - // ref: https://github.com/OffchainLabs/cargo-stylus/blob/main/main/src/deploy/mod.rs#L305 - const PRELUDE_LEN = 42; - const TOTAL_FIXED = PRELUDE_LEN + 1; // +1 version byte - - if (deploy.length < TOTAL_FIXED) { + if (deploy.length < TOTAL_FIXED_LENGTH) { throw new Error("Deployment bytecode too short"); } - if (deploy[0] !== 0x7f) { + if (deploy[0] !== PUSH32_OPCODE) { throw new Error( "Missing 0x7f PUSH32 - not produced by contract_deployment_calldata", ); } // read length const codeLenBytes = deploy.slice(1, 33); let codeLen = 0n; for (const b of codeLenBytes) codeLen = (codeLen << 8n) | BigInt(b); if (codeLen > BigInt(Number.MAX_SAFE_INTEGER)) { throw new Error("Runtime code length exceeds JS safe integer range"); } // pattern sanity-check - const EXPECTED = [ - 0x80, // DUP1 - 0x60, - 0x2b, // PUSH1 0x2b (42 + 1) - 0x60, - 0x00, // PUSH1 0 - 0x39, // CODECOPY - 0x60, - 0x00, // PUSH1 0 - 0xf3, // RETURN - 0x00, // version - ] as const; - for (let i = 0; i < EXPECTED.length; i++) { - if (deploy[33 + i] !== EXPECTED[i]) { + for (let i = 0; i < EXPECTED_PRELUDE_PATTERN.length; i++) { + if (deploy[33 + i] !== EXPECTED_PRELUDE_PATTERN[i]) { throw new Error("Prelude bytes do not match expected pattern"); } } // slice out runtime code - const start = TOTAL_FIXED; + const start = TOTAL_FIXED_LENGTH; const end = start + Number(codeLen); if (deploy.length < end) { throw new Error("Deployment bytecode truncated - runtime code incomplete"); } return deploy.slice(start, end); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
packages/thirdweb/src/extensions/stylus/__generated__/IArbWasm/read/codehashVersion.tsis excluded by!**/__generated__/**
📒 Files selected for processing (4)
packages/thirdweb/scripts/generate/abis/stylus/IArbWasm.json(1 hunks)packages/thirdweb/src/contract/deployment/deploy-with-abi.ts(3 hunks)packages/thirdweb/src/extensions/stylus/write/activateStylusContract.ts(1 hunks)packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- packages/thirdweb/src/extensions/stylus/write/activateStylusContract.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/thirdweb/src/contract/deployment/deploy-with-abi.ts
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{ts,tsx}`: Write idiomatic TypeScript with explicit function declarations ...
**/*.{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
Load heavy dependencies inside async paths to keep initial bundle lean (lazy loading)
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Auto-generated contracts from ABI definitions in extensions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/wallets/**/*.{ts,tsx} : Support EIP-1193, EIP-5792, EIP-7702 standards in wallet architecture
packages/thirdweb/scripts/generate/abis/stylus/IArbWasm.json (1)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Auto-generated contracts from ABI definitions in extensions
packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts (3)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Auto-generated contracts from ABI definitions in extensions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/wallets/**/*.{ts,tsx} : Support EIP-1193, EIP-5792, EIP-7702 standards in wallet architecture
Learnt from: MananTank
PR: thirdweb-dev/js#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.
🧬 Code Graph Analysis (1)
packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts (3)
packages/thirdweb/src/extensions/stylus/write/activateStylusContract.ts (1)
ARB_WASM_ADDRESS(15-15)packages/thirdweb/src/extensions/stylus/__generated__/IArbWasm/read/codehashVersion.ts (1)
codehashVersion(118-126)packages/thirdweb/src/extensions/stylus/__generated__/IStylusDeployer/write/deploy.ts (1)
deploy(141-178)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Unit Tests
- GitHub Check: Build Packages
- GitHub Check: Lint Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
packages/thirdweb/scripts/generate/abis/stylus/IArbWasm.json (1)
1-4: LGTM!The new
codehashVersionfunction signature is correctly added to the ABI. The function signature follows proper Solidity conventions with appropriate modifiers (external view) for a read-only function.packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts (2)
1-6: Imports are well-organized and necessary.All imports are relevant to the module's functionality and follow the project's conventions.
8-12: Type definition follows best practices.The type alias is well-structured with appropriate property types, including the hex string template literal type for bytecode validation.
| function hexToBytes(hex: string): Uint8Array { | ||
| const normalized = hex.startsWith("0x") ? hex.slice(2) : hex; | ||
| if (normalized.length % 2 !== 0) { | ||
| throw new Error("Hex string must have an even length"); | ||
| } | ||
| const bytes = new Uint8Array(normalized.length / 2); | ||
| for (let i = 0; i < bytes.length; i++) { | ||
| bytes[i] = parseInt(normalized.slice(i * 2, i * 2 + 2), 16); | ||
| } | ||
| return bytes; | ||
| } |
There was a problem hiding this comment.
Add validation for hex characters to prevent silent data corruption.
The parseInt function returns NaN for invalid hex characters, which gets coerced to 0 in Uint8Array. This could lead to silent data corruption if invalid hex strings are passed.
function hexToBytes(hex: string): Uint8Array {
const normalized = hex.startsWith("0x") ? hex.slice(2) : hex;
if (normalized.length % 2 !== 0) {
throw new Error("Hex string must have an even length");
}
+ if (!/^[0-9a-fA-F]*$/.test(normalized)) {
+ throw new Error("Invalid hex characters in string");
+ }
const bytes = new Uint8Array(normalized.length / 2);
for (let i = 0; i < bytes.length; i++) {
- bytes[i] = parseInt(normalized.slice(i * 2, i * 2 + 2), 16);
+ const byte = parseInt(normalized.slice(i * 2, i * 2 + 2), 16);
+ if (isNaN(byte)) {
+ throw new Error(`Invalid hex byte at position ${i}`);
+ }
+ bytes[i] = byte;
}
return bytes;
}📝 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.
| function hexToBytes(hex: string): Uint8Array { | |
| const normalized = hex.startsWith("0x") ? hex.slice(2) : hex; | |
| if (normalized.length % 2 !== 0) { | |
| throw new Error("Hex string must have an even length"); | |
| } | |
| const bytes = new Uint8Array(normalized.length / 2); | |
| for (let i = 0; i < bytes.length; i++) { | |
| bytes[i] = parseInt(normalized.slice(i * 2, i * 2 + 2), 16); | |
| } | |
| return bytes; | |
| } | |
| function hexToBytes(hex: string): Uint8Array { | |
| const normalized = hex.startsWith("0x") ? hex.slice(2) : hex; | |
| if (normalized.length % 2 !== 0) { | |
| throw new Error("Hex string must have an even length"); | |
| } | |
| if (!/^[0-9a-fA-F]*$/.test(normalized)) { | |
| throw new Error("Invalid hex characters in string"); | |
| } | |
| const bytes = new Uint8Array(normalized.length / 2); | |
| for (let i = 0; i < bytes.length; i++) { | |
| const byte = parseInt(normalized.slice(i * 2, i * 2 + 2), 16); | |
| if (isNaN(byte)) { | |
| throw new Error(`Invalid hex byte at position ${i}`); | |
| } | |
| bytes[i] = byte; | |
| } | |
| return bytes; | |
| } |
🤖 Prompt for AI Agents
In packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts around
lines 92 to 102, the hexToBytes function lacks validation for hex characters,
causing parseInt to return NaN for invalid input, which coerces to 0 and
silently corrupts data. Add a check after parsing each byte to verify that the
result is a valid number and throw an error if invalid hex characters are
detected to prevent silent data corruption.
…nto yash/stylus-cli-update
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
packages/thirdweb/src/exports/extensions/stylus.ts (1)
1-16: Consider adding file-level documentation.While the exports are well-structured, consider adding a file-level TSDoc comment to explain the purpose of this Stylus extensions module in the public API.
+/** + * Stylus contract extensions for the thirdweb SDK. + * + * Provides functionality for deploying and managing Stylus contracts on Arbitrum chains. + * + * @example + * ```typescript + * import { deployWithStylusConstructor, isContractActivated } from "thirdweb/extensions/stylus"; + * ``` + */ /** * Write */
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/thirdweb/src/exports/extensions/stylus.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.{ts,tsx}`: Write idiomatic TypeScript with explicit function declarations ...
**/*.{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
Load heavy dependencies inside async paths to keep initial bundle lean (lazy loading)
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/thirdweb/src/exports/extensions/stylus.ts
`packages/thirdweb/src/exports/**/*.{ts,tsx}`: Export everything via `exports/` ...
packages/thirdweb/src/exports/**/*.{ts,tsx}: Export everything viaexports/directory, grouped by feature in the public API of the SDK
Every public symbol must have comprehensive TSDoc with at least one@exampleblock that compiles and custom annotation tags (@beta,@internal,@experimental)
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
packages/thirdweb/src/exports/extensions/stylus.ts
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Auto-generated contracts from ABI definitions in extensions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/wallets/**/*.{ts,tsx} : Support EIP-1193, EIP-5792, EIP-7702 standards in wallet architecture
packages/thirdweb/src/exports/extensions/stylus.ts (10)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to packages/thirdweb/src/exports/**/*.{ts,tsx} : Export everything via `exports/` directory, grouped by feature in the public API of the SDK
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Auto-generated contracts from ABI definitions in extensions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to packages/thirdweb/src/exports/**/*.{ts,tsx} : 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-06-30T10:25:29.489Z
Learning: Applies to src/exports/react.native.ts : React Native specific exports are in `src/exports/react.native.ts`
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Extensions follow modular pattern in `src/extensions/`
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Support for read/write operations in extensions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to **/*.{ts,tsx} : Write idiomatic TypeScript with explicit function declarations and return types
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Composable functions with TypeScript safety in extensions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : Use Tailwind CSS only – no inline styles or CSS modules
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/api/**/*.{ts,tsx} : Export default async functions without `'use client';` – they run on the Node edge.
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: Unit Tests
- GitHub Check: Build Packages
- GitHub Check: Lint Packages
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Analyze (javascript)
| export { | ||
| type IsContractActivatedOptions, | ||
| isContractActivated, | ||
| } from "../../extensions/stylus/write/isContractActivated.js"; |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify TSDoc compliance for the new export.
The export structure is consistent with the existing pattern. Ensure the source function has proper TSDoc documentation as required.
🏁 Script executed:
#!/bin/bash
# Description: Check if isContractActivated has proper TSDoc documentation
# Expected: TSDoc comments with @example block and annotation tags
rg -A 20 "export.*isContractActivated" --type tsLength of output: 1947
Add comprehensive TSDoc for isContractActivated export
The isContractActivated function in
packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts
is currently missing a TSDoc comment with an @example block and the required custom annotation tags (@beta, @internal, @experimental, as applicable). Please add a documentation block immediately above the function declaration, for example:
/**
* Checks whether a given contract’s bytecode has been activated.
*
* @remarks
* This uses the ArbWasm precompile contract to verify the runtime bytecode version.
*
* @param options - Configuration options for the activation check.
* @param options.chain - The target blockchain.
* @param options.client - The RPC client instance.
* @param options.bytecode - The contract’s runtime bytecode.
*
* @returns A promise that resolves to `true` if activated, otherwise `false`.
*
* @example
* ```ts
* const activated = await isContractActivated({
* chain: "arbitrum",
* client: myRpcClient,
* bytecode: myContractBytecode,
* });
* console.log(activated); // true
* ```
*
* @beta
*/
export async function isContractActivated(
options: IsContractActivatedOptions,
): Promise<boolean> { … }- Ensure the TSDoc compiles without errors.
- Include at least one valid
@exampleblock. - Add the appropriate custom annotation tag.
🤖 Prompt for AI Agents
In packages/thirdweb/src/extensions/stylus/write/isContractActivated.ts around
lines 12 to 15, the isContractActivated function lacks a comprehensive TSDoc
comment. Add a detailed TSDoc block immediately above the function declaration
that describes its purpose, parameters, and return value. Include an @example
block demonstrating usage and add the appropriate custom annotation tag such as
@beta. Ensure the TSDoc is well-formed and compiles without errors.
| export { | ||
| type DeployWithStylusConstructorOptions, | ||
| deployWithStylusConstructor, | ||
| } from "../../extensions/stylus/write/deployWithStylusConstructor.js"; |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify TSDoc compliance for the new export.
The export structure follows the established pattern correctly. However, per the coding guidelines, every public symbol must have comprehensive TSDoc with at least one @example block and custom annotation tags.
🏁 Script executed:
#!/bin/bash
# Description: Check if deployWithStylusConstructor has proper TSDoc documentation
# Expected: TSDoc comments with @example block and annotation tags
rg -A 20 "export.*deployWithStylusConstructor" --type tsLength of output: 2307
🏁 Script executed:
#!/bin/bash
# Check for existing TSDoc above the deployWithStylusConstructor function
rg -B5 -n "export function deployWithStylusConstructor" packages/thirdweb/src/extensions/stylus/write/deployWithStylusConstructor.tsLength of output: 275
🏁 Script executed:
#!/bin/bash
# Display TSDoc for deployWithStylusConstructor function
echo "===== deployWithStylusConstructor.ts (first 50 lines) ====="
head -n 50 packages/thirdweb/src/extensions/stylus/write/deployWithStylusConstructor.ts
# Display exports file to check for file-level TSDoc
echo "===== stylus.ts exports file (first 20 lines) ====="
head -n 20 packages/thirdweb/src/exports/extensions/stylus.tsLength of output: 2570
Add missing custom annotation tag to deployWithStylusConstructor TSDoc
The deployWithStylusConstructor function already has a description, @param, @returns and a working @example, but per our SDK docs guidelines every public symbol also needs a custom annotation tag (e.g. @beta or @experimental).
• In packages/thirdweb/src/extensions/stylus/write/deployWithStylusConstructor.ts, add an appropriate annotation to the existing TSDoc block above export function deployWithStylusConstructor(...).
/**
* Deploy stylus contract with constructor params
* @beta ← add one of: @beta | @experimental | @internal
* @param options – The options for deploying a contract with constructor
* @returns Prepared transaction to call stylus deployer
* @example
* …
*/
export function deployWithStylusConstructor(…)• (Optional) Enhance the file-level TSDoc in packages/thirdweb/src/exports/extensions/stylus.ts to describe the module’s purpose more thoroughly.
🤖 Prompt for AI Agents
In packages/thirdweb/src/extensions/stylus/write/deployWithStylusConstructor.ts
around the export function deployWithStylusConstructor, add a custom annotation
tag such as @beta, @experimental, or @internal to the existing TSDoc block above
the function to comply with SDK docs guidelines. Optionally, in
packages/thirdweb/src/exports/extensions/stylus.ts, enhance the file-level TSDoc
comment to provide a more detailed description of the module's purpose.
PR-Codex overview
This PR introduces new functionalities and enhancements related to the
Stylusextension in thethirdwebpackage, including new contract methods, event handling, and improvements in project creation and deployment processes.Detailed summary
stylus_constructorfunction toIStylusConstructor.json.IStylusDeployer.jsonwithdeployfunction andContractDeployedevent.IArbWasm.jsonto includecodehashVersionfunction.ARB_WASM_ADDRESSto be exported inactivateStylusContract.ts.deploy-with-abi.ts.isStylus_constructorSupportedandstylus_constructorfunctions instylus_constructor.ts.checkPrerequisitesfunction for better error handling.create.ts.codehashVersionfunction with encoding and decoding capabilities incodehashVersion.ts.deployfunction with parameter encoding inIStylusDeployer/write/deploy.ts.Summary by CodeRabbit
New Features
Improvements