create-mn-app 0.3.12 → 0.3.14

package/README.md

@@ -1,15 +1,13 @@
 # create-mn-app
 
-Scaffold Midnight Network applications.
+Scaffold Midnight Network applications on Preprod.
 
 [![npm version](https://img.shields.io/npm/v/create-mn-app.svg)](https://www.npmjs.com/package/create-mn-app)
 [![npm downloads](https://img.shields.io/npm/dw/create-mn-app.svg)](https://www.npmjs.com/package/create-mn-app)
 [![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Node.js](https://img.shields.io/node/v/create-mn-app.svg)](https://nodejs.org/)
 
-## Installation
-
-**Recommended (no install needed):**
+## Quick Start
 
 ```bash
 npx create-mn-app my-app
@@ -17,80 +15,48 @@ cd my-app
 npm run setup
 ```
 
-**Or install globally:**
+The `setup` command:
 
-```bash
-npm i -g create-mn-app
-create-mn-app my-app
-```
+1. Starts proof server via Docker
+2. Compiles the Compact contract
+3. Deploys to Preprod (prompts for faucet funding)
 
-> Using `npx` is recommended - it always runs the latest version without needing updates.
+> Fund your wallet at [faucet.preprod.midnight.network](https://faucet.preprod.midnight.network/)
 
 ## Why create-mn-app?
 
-- **Zero Configuration**: Start building immediately without complex setup
-- **Best Practices**: Pre-configured TypeScript, hot reloading, and project structure
-- **Production Ready**: Includes wallet generation, environment management, and deployment scripts
-- **Developer Experience**: Interactive prompts, health checks, and helpful error messages
-- **Stay Updated**: Built-in update notifier keeps you on the latest version
-
-## Features
-
-- **Interactive project setup** with template selection
-- **Auto-detects package manager** (npm/yarn/pnpm/bun)
-- **Smart dependency management**:
-  - Checks Node.js, Docker, and Compact compiler versions
-  - **Automatic Compact compiler updates** when version mismatch detected
-  - Prompts user before updating with clear explanations
-- **TypeScript** with hot reloading
-- **Pre-configured Compact contracts**
-- **Secure wallet generation**
-- **Environment health checks**
-
-## Quick Start
-
-### Interactive Mode
-
-```bash
-npx create-mn-app
-```
-
-### CLI Mode
-
-```bash
-npx create-mn-app my-app --template hello-world
-cd my-app
-npm run setup
-```
+- **Zero Configuration** - Start building immediately
+- **Preprod Ready** - Deploys to Midnight Preprod network
+- **SDK 3.0** - Uses latest Midnight wallet and contract SDKs
+- **One Command Setup** - Single `npm run setup` handles everything
+- **Auto-updates** - Built-in notifier for new versions
 
 ## Templates
 
 ### Hello World (Default)
 
-Basic message storage contract demonstrating state management and deployment.
+Basic message storage contract demonstrating state management.
 
 ```bash
 npx create-mn-app my-app
+cd my-app
+npm run setup     # starts proof server, compiles, deploys
+npm run cli       # interact with deployed contract
 ```
 
-### Counter DApp
+### Counter
 
-Real-world example with increment/decrement state and zkProofs.
+Increment/decrement counter with zkProofs. Cloned from [midnightntwrk/example-counter](https://github.com/midnightntwrk/example-counter).
 
 ```bash
 npx create-mn-app my-app --template counter
-```
-
-Cloned from [Midnight Network's example-counter](https://github.com/midnightntwrk/example-counter). Requires Node.js 22+, Docker, and Compact compiler.
-
-After creation:
-
-```bash
 cd my-app
 npm install
-# Follow setup instructions displayed
+# follow displayed instructions
 ```
 
+Requires Compact compiler - the CLI will check and offer to install it.
+
 ### Coming Soon
 
 - Bulletin Board - Multi-user interactions with privacy patterns
@@ -99,53 +65,45 @@ npm install
 
 ## Requirements
 
-- **Node.js 22+** - Required for all templates
-- **Docker** - Required for running the proof server
-- **npm/yarn/pnpm/bun** - Package manager (auto-detected)
-- **Compact Compiler 0.23.0+** - Required for Counter template
-  - **Auto-update available**: If you have an older version, the CLI will offer to update it automatically
-  - Version compatibility checked before project creation
-  - Manual installation: See [Compact releases](https://github.com/midnightntwrk/compact/releases/latest)
+| Requirement      | Version | Notes                                        |
+| ---------------- | ------- | -------------------------------------------- |
+| Node.js          | 22+     | Required for all templates                   |
+| Docker           | Latest  | Runs proof server                            |
+| Compact Compiler | 0.23.0+ | Counter template only (auto-install offered) |
 
 ## CLI Options
 
 ```bash
 npx create-mn-app [project-name] [options]
-
-Options:
-  -t, --template <name>     Template: hello-world, counter
-  --use-npm                 Use npm
-  --use-yarn                Use Yarn
-  --use-pnpm                Use pnpm
-  --use-bun                 Use bun
-  --skip-install            Skip dependency installation
-  --skip-git                Skip git initialization
-  --verbose                 Show detailed output
-  -h, --help                Help
-  -V, --version             Version
 ```
 
+| Option                    | Description                        |
+| ------------------------- | ---------------------------------- |
+| `-t, --template <name>`   | Template: `hello-world`, `counter` |
+| `--use-npm/yarn/pnpm/bun` | Force package manager              |
+| `--skip-install`          | Skip dependency installation       |
+| `--skip-git`              | Skip git initialization            |
+| `--verbose`               | Show detailed output               |
+| `-h, --help`              | Show help                          |
+| `-V, --version`           | Show version                       |
+
 ## Project Structure
 
 ```
-create-mn-app/
-├── bin/
-│   └── create-midnight-app.js    # CLI entry point
+my-app/
+├── contracts/
+│   └── hello-world.compact    # Compact smart contract
 ├── src/
-│   ├── cli.ts                     # Main CLI logic
-│   ├── create-app.ts              # Project scaffolding
-│   ├── installers/                # Package & proof server setup
-│   └── utils/                     # Helpers & templates
-├── templates/
-│   └── hello-world/               # Bundled template
+│   ├── cli.ts                 # Interact with deployed contract
+│   ├── deploy.ts              # Deploy contract to Preprod
+│   └── check-balance.ts       # Check wallet balance
+├── docker-compose.yml         # Proof server config
 ├── package.json
-└── tsconfig.json
+└── deployment.json            # Generated after deploy (contains wallet seed)
 ```
 
 ## Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request.
-
 1. Fork the repository
 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
 3. Commit your changes (`git commit -m 'Add some amazing feature'`)
@@ -156,10 +114,9 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 
 - [Midnight Docs](https://docs.midnight.network)
 - [Discord Community](https://discord.com/invite/midnightnetwork)
-- [GitHub](https://github.com/Olanetsoft/create-mn-app)
+- [GitHub](https://github.com/midnightntwrk/create-mn-app)
+- [Preprod Faucet](https://faucet.preprod.midnight.network/)
 
 ## License
 
 Apache-2.0 © 2025 Midnight Foundation
-
-See [LICENSE](LICENSE) for more information.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-mn-app",
-  "version": "0.3.12",
+  "version": "0.3.14",
   "description": "Create Midnight Network applications with zero configuration",
   "main": "dist/index.js",
   "bin": {

package/templates/hello-world/src/deploy.ts.template

@@ -167,16 +167,63 @@ async function main() {
   const rl = createInterface({ input: stdin, output: stdout });
 
   try {
+    // Check for existing deployment.json (previous attempt or completed deployment)
+    let existingSeed: string | undefined;
+    let existingContract: string | undefined;
+
+    if (fs.existsSync('deployment.json')) {
+      try {
+        const existing = JSON.parse(fs.readFileSync('deployment.json', 'utf-8'));
+        if (existing.seed) existingSeed = existing.seed;
+        if (existing.contractAddress) existingContract = existing.contractAddress;
+      } catch {
+        // Ignore parse errors
+      }
+    }
+
+    // If already deployed, ask if they want to redeploy
+    if (existingContract) {
+      console.log('─── Existing Deployment Found ──────────────────────────────────\n');
+      console.log(`  Contract: ${existingContract}`);
+      const redeploy = await rl.question('\n  Deploy a new contract? [y/N] ');
+      if (redeploy.toLowerCase() !== 'y') {
+        console.log('\n  Run `npm run cli` to interact with your existing contract.\n');
+        return;
+      }
+      existingSeed = undefined; // Fresh deployment = fresh wallet
+    }
+
     // 1. Wallet setup
     console.log('─── Step 1: Wallet Setup ───────────────────────────────────────\n');
-    const choice = await rl.question('  [1] Create new wallet\n  [2] Restore from seed\n  > ');
-
-    const seed = choice.trim() === '2'
-      ? await rl.question('\n  Enter your 64-character seed: ')
-      : toHex(Buffer.from(generateRandomSeed()));
 
-    if (choice.trim() !== '2') {
-      console.log(`\n  ⚠️  SAVE THIS SEED (you'll need it later):\n  ${seed}\n`);
+    let seed: string;
+
+    if (existingSeed) {
+      // Resume from previous failed deployment
+      console.log('  Found saved seed from previous attempt.');
+      const useSaved = await rl.question('  Use saved wallet? [Y/n] ');
+      if (useSaved.toLowerCase() !== 'n') {
+        seed = existingSeed;
+        console.log('  Using saved wallet...\n');
+      } else {
+        const choice = await rl.question('  [1] Create new wallet\n  [2] Restore from seed\n  > ');
+        seed = choice.trim() === '2'
+          ? await rl.question('\n  Enter your 64-character seed: ')
+          : toHex(Buffer.from(generateRandomSeed()));
+
+        if (choice.trim() !== '2') {
+          console.log(`\n  ⚠️  SAVE THIS SEED (you'll need it later):\n  ${seed}\n`);
+        }
+      }
+    } else {
+      const choice = await rl.question('  [1] Create new wallet\n  [2] Restore from seed\n  > ');
+      seed = choice.trim() === '2'
+        ? await rl.question('\n  Enter your 64-character seed: ')
+        : toHex(Buffer.from(generateRandomSeed()));
+
+      if (choice.trim() !== '2') {
+        console.log(`\n  ⚠️  SAVE THIS SEED (you'll need it later):\n  ${seed}\n`);
+      }
     }
 
     console.log('  Creating wallet...');
@@ -236,12 +283,67 @@ async function main() {
     console.log('  Setting up providers...');
     const providers = await createProviders(walletCtx);
 
-    console.log('  Deploying contract (this may take 30-60 seconds)...\n');
-    const deployed = await deployContract(providers, {
-      compiledContract,
-      privateStateId: 'helloWorldState',
-      initialPrivateState: {},
-    });
+    console.log('  Deploying contract...\n');
+
+    const MAX_RETRIES = 5;
+    const RETRY_DELAY_MS = 30000; // 30 seconds between retries
+
+    let deployed: Awaited<ReturnType<typeof deployContract>> | undefined;
+
+    for (let attempt = 1; attempt <= MAX_RETRIES; attempt++) {
+      try {
+        deployed = await deployContract(providers, {
+          compiledContract,
+          privateStateId: 'helloWorldState',
+          initialPrivateState: {},
+        });
+        break; // Success - exit retry loop
+      } catch (err: any) {
+        const errMsg = err?.message || err?.toString() || '';
+
+        // Check if it's a DUST-related error
+        if (errMsg.includes('Not enough Dust') || errMsg.includes('Wallet.Transacting')) {
+          if (attempt < MAX_RETRIES) {
+            console.log(`  ⏳ Waiting for more DUST to generate (attempt ${attempt}/${MAX_RETRIES})...`);
+            console.log('     DUST generates as blocks are produced (~30s per block)');
+            console.log(`     Retrying in ${RETRY_DELAY_MS / 1000}s...\n`);
+
+            // Countdown display
+            for (let i = RETRY_DELAY_MS / 1000; i > 0; i -= 5) {
+              await new Promise((r) => setTimeout(r, 5000));
+              if (i > 5) process.stdout.write(`\r     ${i - 5}s remaining...   `);
+            }
+            process.stdout.write('\r                              \r');
+          } else {
+            // All retries exhausted
+            console.log('  ❌ Not enough DUST generated yet.\n');
+            console.log('  DUST is generated over time as blocks are produced.');
+            console.log('  Your wallet and funds are saved - just retry later:\n');
+            console.log('  $ npm run deploy\n');
+
+            // Save partial deployment info so user can resume
+            const partialInfo = {
+              seed,
+              network: 'preprod',
+              status: 'pending_dust',
+              lastAttempt: new Date().toISOString(),
+            };
+            fs.writeFileSync('deployment.json', JSON.stringify(partialInfo, null, 2));
+            console.log('  Seed saved to deployment.json for retry.\n');
+
+            await walletCtx.wallet.stop();
+            process.exit(1);
+          }
+        } else {
+          // Not a DUST error - rethrow
+          throw err;
+        }
+      }
+    }
+
+    if (!deployed) {
+      throw new Error('Deployment failed after all retries');
+    }
 
     const contractAddress = deployed.deployTxData.public.contractAddress;
     console.log('  ✅ Contract deployed successfully!\n');