create-stylus 0.0.5 → 0.0.6

package/templates/base/packages/nextjs/utils/scaffold-stylus/burner.ts

@@ -1,6 +1,6 @@
 import type { Hex } from "viem";
 import { generatePrivateKey } from "viem/accounts";
-import { arbitrumNitro } from "./chain";
+import { arbitrumNitro } from "./supportedChains";
 
 const burnerStorageKey = "burnerWallet.pk";
 export const burnerWalletId = "burnerWallet" as const;

package/templates/base/packages/nextjs/utils/scaffold-stylus/index.ts

@@ -1,3 +1,3 @@
 export * from "./burner";
-export * from "./chain";
+export * from "./supportedChains";
 export * from "./networks";

package/templates/base/packages/nextjs/utils/scaffold-stylus/networks.ts

@@ -1,6 +1,6 @@
 import * as chains from "viem/chains";
 import scaffoldConfig from "~~/scaffold.config";
-import { arbitrumNitro } from "~~/utils/scaffold-stylus/chain";
+import { arbitrumNitro } from "~~/utils/scaffold-stylus/supportedChains";
 
 type ChainAttributes = {
   // color | [lightThemeColor, darkThemeColor]

package/templates/base/packages/nextjs/utils/scaffold-stylus/{chain.ts → supportedChains.ts}

@@ -1,8 +1,9 @@
 import { defineChain } from "viem";
+import { arbitrum, arbitrumSepolia, arbitrumNova } from "viem/chains";
 
-export const arbitrumNitro = defineChain({
+const arbitrumNitro = defineChain({
   id: 412346,
-  name: "Arbitrum Nitro",
+  name: "Arbitrum Nitro DevNode",
   network: "arbitrum-nitro",
   nativeCurrency: {
     name: "Ether",
@@ -40,3 +41,5 @@ export const arbitrumNitro = defineChain({
     },
   ],
 });
+
+export { arbitrum, arbitrumSepolia, arbitrumNova, arbitrumNitro };

package/templates/base/packages/stylus/.env.example

@@ -14,3 +14,8 @@ PRIVATE_KEY_SEPOLIA=
 ACCOUNT_ADDRESS_MAINNET=
 RPC_URL_MAINNET=
 PRIVATE_KEY_MAINNET=
+
+## nova
+ACCOUNT_ADDRESS_NOVA=
+RPC_URL_NOVA=
+PRIVATE_KEY_NOVA=

package/templates/base/packages/stylus/package.json

@@ -11,7 +11,7 @@
     "deploy": "ts-node scripts/deploy_wrapper.ts",
     "test:networks": "ts-node scripts/test_network.ts",
     "export-abi": "ts-node scripts/export_abi.ts",
-    "clean": "rm -rf dist",
+    "clean-contracts": "git clean -xdf -e .env -e your-contract/ -e node_modules/",
     "test": "cargo test",
     "lint": "eslint scripts --ext .ts",
     "lint:fix": "eslint scripts --ext .ts --fix",

package/templates/base/packages/stylus/scripts/utils/command.ts

@@ -8,13 +8,6 @@ export async function buildDeployCommand(
 ) {
   let baseCommand = `cargo stylus deploy --endpoint='${config.chain?.rpcUrl}' --private-key='${config.privateKey}'`;
 
-  if (
-    deployOptions.constructorArgs &&
-    deployOptions.constructorArgs.length > 0
-  ) {
-    baseCommand += ` --constructor-args='${deployOptions.constructorArgs.join(" ")}'`;
-  }
-
   if (deployOptions.estimateGas) {
     return `${baseCommand} --estimate-gas`;
   }
@@ -27,6 +20,13 @@ export async function buildDeployCommand(
     baseCommand += ` --max-fee-per-gas-gwei=${deployOptions.maxFee}`;
   }
 
+  if (
+    deployOptions.constructorArgs &&
+    deployOptions.constructorArgs.length > 0
+  ) {
+    baseCommand += ` --constructor-args ${deployOptions.constructorArgs.map((arg) => `"${arg}"`).join(" ")} `;
+  }
+
   return baseCommand;
 }
 

package/templates/base/packages/stylus/scripts/utils/deployment.ts

@@ -1,7 +1,7 @@
 import { config as dotenvConfig } from "dotenv";
 import * as path from "path";
 import * as fs from "fs";
-import { arbitrumNitro } from "../../../nextjs/utils/scaffold-stylus/chain";
+import { arbitrumNitro } from "../../../nextjs/utils/scaffold-stylus/supportedChains";
 import { DeploymentConfig, DeployOptions, DeploymentData } from "./type";
 import { getAccountAddress, getChain, getPrivateKey } from "./network";
 import { getContractNameFromCargoToml } from "./contract";

package/templates/base/packages/stylus/scripts/utils/network.ts

@@ -1,6 +1,6 @@
-import { arbitrum, arbitrumSepolia } from "viem/chains";
+import { arbitrum, arbitrumNova, arbitrumSepolia } from "viem/chains";
 import { Address, Chain } from "viem";
-import { arbitrumNitro } from "../../../nextjs/utils/scaffold-stylus/chain";
+import { arbitrumNitro } from "../../../nextjs/utils/scaffold-stylus/supportedChains";
 import * as path from "path";
 import * as fs from "fs";
 import { config as dotenvConfig } from "dotenv";
@@ -15,12 +15,14 @@ export const SUPPORTED_NETWORKS: Record<string, Chain> = {
   arbitrum,
   arbitrumSepolia,
   arbitrumNitro: arbitrumNitro as Chain,
+  arbitrumNova: arbitrumNova as Chain,
 };
 
 export const ALIASES: Record<string, string> = {
   mainnet: "arbitrum",
   sepolia: "arbitrumSepolia",
   devnet: "arbitrumNitro",
+  nova: "arbitrumNova",
 };
 
 export function getChain(networkName: string): SupportedNetworkMinimal | null {
@@ -67,6 +69,12 @@ export function getPrivateKey(networkName: string): string {
       } else {
         throw new Error("PRIVATE_KEY_SEPOLIA is not set");
       }
+    case "arbitrumnova":
+      if (process.env["PRIVATE_KEY_NOVA"]) {
+        return process.env["PRIVATE_KEY_NOVA"];
+      } else {
+        throw new Error("PRIVATE_KEY_NOVA is not set");
+      }
     default:
       return (
         process.env["PRIVATE_KEY"] ||
@@ -82,6 +90,8 @@ export const getAccountAddress = (networkName: string): Address | undefined => {
       return process.env["ACCOUNT_ADDRESS_MAINNET"] as Address;
     case "arbitrumsepolia":
       return process.env["ACCOUNT_ADDRESS_SEPOLIA"] as Address;
+    case "arbitrumnova":
+      return process.env["ACCOUNT_ADDRESS_NOVA"] as Address;
     default:
       return (
         (process.env["ACCOUNT_ADDRESS"] as Address) ||
@@ -103,6 +113,11 @@ function getRpcUrlFromChain(chain: Chain): string {
         return process.env["RPC_URL_SEPOLIA"];
       }
       break;
+    case arbitrumNova.id:
+      if (process.env["RPC_URL_NOVA"]) {
+        return process.env["RPC_URL_NOVA"];
+      }
+      break;
     default:
       if (process.env["RPC_URL"]) {
         return process.env["RPC_URL"];

package/templates/base/packages/stylus/scripts/utils/type.ts

@@ -13,7 +13,7 @@ export interface DeployCommandOptions
 export interface DeployOptions {
   contract?: string;
   name?: string;
-  constructorArgs?: string[];
+  constructorArgs?: NonNullable<unknown>[];
   network?: string;
   estimateGas?: boolean;
   maxFee?: string;

package/templates/base/packages/stylus/your-contract/src/lib.rs

@@ -20,13 +20,13 @@ use alloc::vec::Vec;
 /// Import items from the SDK. The prelude contains common traits and macros.
 use stylus_sdk::{
     alloy_primitives::{Address, U256},
-    prelude::*,
     alloy_sol_types::sol,
+    prelude::*,
     stylus_core::log,
 };
 
 /// Import OpenZeppelin Ownable functionality
-use openzeppelin_stylus::access::ownable::{self, Ownable, IOwnable};
+use openzeppelin_stylus::access::ownable::{self, IOwnable, Ownable};
 
 /// Error types for the contract
 #[derive(SolidityError, Debug)]
@@ -38,9 +38,7 @@ pub enum Error {
 impl From<ownable::Error> for Error {
     fn from(value: ownable::Error) -> Self {
         match value {
-            ownable::Error::UnauthorizedAccount(e) => {
-                Error::UnauthorizedAccount(e)
-            }
+            ownable::Error::UnauthorizedAccount(e) => Error::UnauthorizedAccount(e),
             ownable::Error::InvalidOwner(e) => Error::InvalidOwner(e),
         }
     }
@@ -103,14 +101,15 @@ impl YourContract {
     pub fn set_greeting(&mut self, new_greeting: String) {
         // Change state variables
         self.greeting.set_str(&new_greeting);
-        
+
         // Increment counters
         let current_total = self.total_counter.get();
         self.total_counter.set(current_total + U256::from(1));
-        
+
         let sender: Address = self.vm().msg_sender();
         let current_user_count = self.user_greeting_counter.get(sender);
-        self.user_greeting_counter.insert(sender, current_user_count + U256::from(1));
+        self.user_greeting_counter
+            .insert(sender, current_user_count + U256::from(1));
 
         // Set premium based on msg.value
         let msg_value = self.vm().msg_value();
@@ -118,13 +117,15 @@ impl YourContract {
         self.premium.set(is_premium);
 
         // Emit the event
-        log(self.vm(),
+        log(
+            self.vm(),
             GreetingChange {
-            greetingSetter: sender,
-            newGreeting: new_greeting,
-            premium: is_premium,
-            value: msg_value,
-        });
+                greetingSetter: sender,
+                newGreeting: new_greeting,
+                premium: is_premium,
+                value: msg_value,
+            },
+        );
     }
 
     /// Function that allows the owner to withdraw all the Ether in the contract
@@ -139,7 +140,7 @@ impl YourContract {
             let owner = self.ownable.owner();
             let _ = self.vm().transfer_eth(owner, balance);
         }
-        
+
         Ok(())
     }
 
@@ -160,10 +161,7 @@ impl IOwnable for YourContract {
         self.ownable.owner()
     }
 
-    fn transfer_ownership(
-        &mut self,
-        new_owner: Address,
-    ) -> Result<(), Self::Error> {
+    fn transfer_ownership(&mut self, new_owner: Address) -> Result<(), Self::Error> {
         Ok(self.ownable.transfer_ownership(new_owner)?)
     }
 
@@ -181,11 +179,11 @@ impl IOwnable for YourContract {
 //     fn test_your_contract() {
 //         let vm = TestVM::default();
 //         let mut contract = YourContract::from(&vm);
-        
+
 //         // Test initialization
 //         let owner_addr = Address::from([1u8; 20]);
 //         contract.init(owner_addr);
-        
+
 //         assert_eq!(contract.owner(), owner_addr);
 //         assert_eq!(contract.greeting(), "Building Unstoppable Apps!!!");
 //         assert_eq!(contract.premium(), false);
@@ -214,7 +212,7 @@ impl IOwnable for YourContract {
 //     fn test_withdraw() {
 //         let vm = TestVM::default();
 //         let mut contract = YourContract::from(&vm);
-        
+
 //         // Initialize with owner
 //         let owner_addr = vm.addr(); // Use VM address as owner for testing
 //         contract.init(owner_addr);
@@ -228,7 +226,7 @@ impl IOwnable for YourContract {
 //     fn test_withdraw_not_owner() {
 //         let vm = TestVM::default();
 //         let mut contract = YourContract::from(&vm);
-        
+
 //         // Initialize with different owner
 //         let owner_addr = Address::from([1u8; 20]);
 //         contract.init(owner_addr);

package/templates/base/readme.md

@@ -21,8 +21,8 @@
 
 Before you begin, you need to install the following tools:
 
-- [Node (>= v18.17)](https://nodejs.org/en/download/)
-- Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install))
+- [Node (>= v20.18)](https://nodejs.org/en/download/)
+- Yarn ([v2+](https://yarnpkg.com/getting-started/install))
 - [Git](https://git-scm.com/downloads)
 - [Rust](https://www.rust-lang.org/tools/install)
 - [Docker](https://docs.docker.com/engine/install/)
@@ -208,7 +208,9 @@ yarn deploy --network <network>
 - **Always keep your private key secure and never commit it to version control**
 - Consider using environment variable management tools for production deployments
 
-## Verify your contract
+## Verify your contract (Highly Experimental)
+
+<details>
 
 #### Prerequisites
 
@@ -219,7 +221,9 @@ Your contract must meet Arbiscan's verification requirements:
 - No custom optimization settings
 - No specific compiler version requirements
 
-### Local Verification
+Check full documentation for more [details](https://docs.arbitrum.io/stylus/how-tos/verifying-contracts-arbiscan#step-4-set-evm-version)
+
+### Stylus Local Verification (Under Development)
 
 Make sure your constructor does not contain any args
 
@@ -243,6 +247,8 @@ This runs `cargo stylus verify` locally after deployment, which:
 - Ensures reproducibility across different environments
 - Validates the deployment transaction
 
+**Note:** This feature is still under development and may not work as expected. Check full documentation for more [details](https://docs.arbitrum.io/stylus/how-tos/verifying-contracts)
+
 ### Arbiscan Verification
 
 For public verification on Arbiscan, follow these steps:
@@ -259,11 +265,13 @@ For public verification on Arbiscan, follow these steps:
    - Provide any constructor arguments if applicable
    - Submit for verification
 
-Check official document for detail instructions: https://docs.arbitrum.io/stylus/how-tos/verifying-contracts-arbiscan
+Check official document for detail instructions: <https://docs.arbitrum.io/stylus/how-tos/verifying-contracts-arbiscan>
 
 > **Note**: Arbiscan verification for Stylus contracts is still evolving. If you encounter issues, consider using the local verification method or check Arbiscan's latest documentation for Stylus-specific instructions.
 
-### 🛠️ Troubleshooting Common Issues
+</details>
+
+## 🛠️ Troubleshooting Common Issues
 
 #### 1. `stylus` Not Recognized
 
@@ -286,9 +294,11 @@ If the version is displayed, `stylus` has been successfully installed and the pa
 If you face issues with the ABI not being generated, you can try one of the following solutions:
 
 - **Restart Docker Node**: Pause and restart the Docker node and the local setup of the project. You can do this by deleting all ongoing running containers and then restarting the local terminal using:
+
   ```bash
   yarn run dev
   ```
+
 - **Modify the Script**: In the `run-dev-node.sh` script, replace the line:
 
   ```bash
@@ -302,6 +312,7 @@ If you face issues with the ABI not being generated, you can try one of the foll
   ```
 
 - **Access Denied Issue**: If you encounter an access denied permission error during ABI generation, run the following command and then execute the script again:
+
   ```bash
   sudo chown -R $USER:$USER target
   ```
@@ -333,6 +344,7 @@ Shell scripts created in Windows often have `CRLF` line endings, which cause iss
    ```
 
 4. Run the Script in WSL:
+
    ```bash
    bash run-dev-node.sh
    ```