-
Notifications
You must be signed in to change notification settings - Fork 483
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
WIP: Support stylus contracts publish and deploy #6495
Draft
kumaryash90
wants to merge
3
commits into
main
Choose a base branch
from
yash/stylus-publish-deploy
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
175 changes: 175 additions & 0 deletions
175
packages/thirdweb/src/cli/commands/publish-stylus/publish-stylus.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,175 @@ | ||||||||||||||
import { spawnSync } from "node:child_process"; | ||||||||||||||
import { existsSync, readFileSync, writeFileSync } from "node:fs"; | ||||||||||||||
import { join } from "node:path"; | ||||||||||||||
import open from "open"; | ||||||||||||||
import ora from "ora"; | ||||||||||||||
import { createThirdwebClient } from "../../../client/client.js"; | ||||||||||||||
import { upload } from "../../../storage/upload.js"; | ||||||||||||||
|
||||||||||||||
export const THIRDWEB_URL = "https://thirdweb.com"; | ||||||||||||||
|
||||||||||||||
export async function publishStylus(secretKey?: string) { | ||||||||||||||
const spinner = ora("Checking if this is a Stylus project...").start(); | ||||||||||||||
|
||||||||||||||
if (!secretKey) { | ||||||||||||||
spinner.fail("Error: Secret key is required."); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
|
||||||||||||||
try { | ||||||||||||||
// Step 1: Validate Stylus project | ||||||||||||||
const root = process.cwd(); | ||||||||||||||
if (!root) { | ||||||||||||||
spinner.fail("Error: No package directory found."); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
|
||||||||||||||
const cargoTomlPath = join(root, "Cargo.toml"); | ||||||||||||||
if (!existsSync(cargoTomlPath)) { | ||||||||||||||
spinner.fail("Error: No Cargo.toml found. Not a Rust project."); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
|
||||||||||||||
const cargoToml = readFileSync(cargoTomlPath, "utf8"); | ||||||||||||||
if (!cargoToml.includes("[dependencies.stylus-sdk]")) { | ||||||||||||||
// spinner.fail("Error: Not a Stylus project. Missing stylus-sdk dependency."); | ||||||||||||||
// process.exit(1); | ||||||||||||||
} | ||||||||||||||
|
||||||||||||||
spinner.succeed("Stylus project detected."); | ||||||||||||||
|
||||||||||||||
// Step 2: Run Stylus export commands | ||||||||||||||
spinner.start("Exporting initcode..."); | ||||||||||||||
const bytecodeResult = spawnSync("cargo", ["stylus", "export-initcode"], { | ||||||||||||||
stdio: "inherit", | ||||||||||||||
}); | ||||||||||||||
|
||||||||||||||
if (bytecodeResult.status !== 0) { | ||||||||||||||
spinner.fail("Failed to export initcode."); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
spinner.succeed("Initcode exported."); | ||||||||||||||
|
||||||||||||||
spinner.start("Exporting ABI..."); | ||||||||||||||
const abiResult = spawnSync( | ||||||||||||||
"cargo", | ||||||||||||||
["stylus", "export-abi", "--json", "--output", "abi.json"], | ||||||||||||||
{ stdio: "inherit" }, | ||||||||||||||
); | ||||||||||||||
|
||||||||||||||
if (abiResult.status !== 0) { | ||||||||||||||
spinner.fail("Failed to export ABI."); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
spinner.succeed("ABI exported."); | ||||||||||||||
|
||||||||||||||
// Step 3: Read the output files | ||||||||||||||
const bytecodePath = join(root, "./initcode"); | ||||||||||||||
const abiPath = join(root, "./abi.json"); | ||||||||||||||
|
||||||||||||||
if (!existsSync(bytecodePath) || !existsSync(abiPath)) { | ||||||||||||||
spinner.fail("Error: Export failed. Bytecode or ABI file not found."); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
const abiContent = readFileSync(abiPath, "utf8").trim(); | ||||||||||||||
|
||||||||||||||
const contractName = extractContractNameFromExportAbi(abiContent); | ||||||||||||||
console.log("extracted contract name: ", contractName); | ||||||||||||||
if (!contractName) { | ||||||||||||||
spinner.fail("Error: Could not determine contract name from ABI output."); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
|
||||||||||||||
let cleanedAbi = ""; | ||||||||||||||
try { | ||||||||||||||
const jsonMatch = abiContent.match(/\[.*\]/s); | ||||||||||||||
if (jsonMatch) { | ||||||||||||||
cleanedAbi = jsonMatch[0]; | ||||||||||||||
} else { | ||||||||||||||
throw new Error("No valid JSON ABI found in the file."); | ||||||||||||||
} | ||||||||||||||
} catch (error) { | ||||||||||||||
spinner.fail("Error: ABI file contains invalid format."); | ||||||||||||||
console.error(error); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
|
||||||||||||||
const metadata = { | ||||||||||||||
compiler: {}, | ||||||||||||||
language: "", | ||||||||||||||
output: { | ||||||||||||||
abi: JSON.parse(cleanedAbi), | ||||||||||||||
devdoc: {}, | ||||||||||||||
userdoc: {}, | ||||||||||||||
}, | ||||||||||||||
settings: { | ||||||||||||||
compilationTarget: { | ||||||||||||||
"src/main.rs": contractName, | ||||||||||||||
}, | ||||||||||||||
}, | ||||||||||||||
sources: {}, | ||||||||||||||
}; | ||||||||||||||
writeFileSync(abiPath, JSON.stringify(metadata), "utf8"); | ||||||||||||||
spinner.succeed("ABI cleaned and saved."); | ||||||||||||||
|
||||||||||||||
spinner.succeed("Stylus contract exported successfully."); | ||||||||||||||
|
||||||||||||||
// Step 4: Upload to IPFS (Placeholder) | ||||||||||||||
spinner.start("Uploading to IPFS..."); | ||||||||||||||
const client = createThirdwebClient({ | ||||||||||||||
secretKey, | ||||||||||||||
}); | ||||||||||||||
|
||||||||||||||
const metadataUri = await upload({ | ||||||||||||||
client, | ||||||||||||||
files: [metadata], | ||||||||||||||
}); | ||||||||||||||
console.log(metadataUri); | ||||||||||||||
|
||||||||||||||
const bytecodeContents = readFileSync(bytecodePath, "utf8"); | ||||||||||||||
|
||||||||||||||
const bytecodeUri = await upload({ | ||||||||||||||
client, | ||||||||||||||
files: [bytecodeContents], | ||||||||||||||
}); | ||||||||||||||
console.log(bytecodeUri); | ||||||||||||||
|
||||||||||||||
const publishUri = await upload({ | ||||||||||||||
client, | ||||||||||||||
files: [ | ||||||||||||||
{ | ||||||||||||||
name: contractName, | ||||||||||||||
metadataUri, | ||||||||||||||
bytecodeUri, | ||||||||||||||
stylus: true, | ||||||||||||||
}, | ||||||||||||||
], | ||||||||||||||
}); | ||||||||||||||
|
||||||||||||||
const url = getUrl(publishUri, "publish").toString(); | ||||||||||||||
spinner.succeed(`Upload complete:, ${url}`); | ||||||||||||||
|
||||||||||||||
await open(url); | ||||||||||||||
} catch (error: any) { | ||||||||||||||
spinner.fail(`Error: ${error}`); | ||||||||||||||
process.exit(1); | ||||||||||||||
} | ||||||||||||||
} | ||||||||||||||
|
||||||||||||||
function extractContractNameFromExportAbi(abiRawOutput: string): string | null { | ||||||||||||||
const match = abiRawOutput.match(/<stdin>:(I[A-Za-z0-9_]+)/); | ||||||||||||||
if (match && match[1]) { | ||||||||||||||
return match[1].replace(/^I/, ""); | ||||||||||||||
} | ||||||||||||||
return null; | ||||||||||||||
} | ||||||||||||||
|
||||||||||||||
export function getUrl(hash: string, command: string) { | ||||||||||||||
const url = new URL( | ||||||||||||||
`${THIRDWEB_URL} | ||||||||||||||
/contracts/${command}/ | ||||||||||||||
${encodeURIComponent(hash.replace("ipfs://", ""))}`, | ||||||||||||||
Comment on lines
+168
to
+171
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The URL template string contains newlines and whitespace that will be included in the final URL, which will cause navigation issues. This should be rewritten as a single-line string: const url = new URL(`${THIRDWEB_URL}/contracts/${command}/${encodeURIComponent(hash.replace("ipfs://", ""))}`);
Suggested change
Spotted by Diamond |
||||||||||||||
); | ||||||||||||||
|
||||||||||||||
return url; | ||||||||||||||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
There's a small typo in the success message - the comma after "Upload complete:" is unnecessary and makes the message read awkwardly. Consider changing to:
This will display a cleaner message to users when their upload finishes.
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.