create-mn-app 1.0.1 → 1.0.3

package/README.md

@@ -1,45 +1,247 @@
-# create-midnight-app
+# create-mn-app 🌙
 
 Create Midnight Network applications with zero configuration.
 
+[![npm version](https://img.shields.io/npm/v/create-mn-app.svg)](https://www.npmjs.com/package/create-mn-app)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 ```bash
-npx create-midnight-app my-app
+npx create-mn-app my-app
 cd my-app
 npm run dev
 ```
 
 ## Features
 
-- ⚡ **Zero configuration** - Works out of the box
+- ⚡ **Zero configuration** - Works out of the box with sensible defaults
 - 🔧 **Modern tooling** - TypeScript, hot reloading, auto-compilation
 - 🛡️ **Best practices** - Secure wallet generation, proper project structure
 - 🚀 **Fast setup** - From zero to working app in 60 seconds
 - 🎯 **Developer friendly** - Clear error messages, helpful guides
+- 📦 **ES Modules** - Modern JavaScript module system
+- 🐳 **Docker integration** - Automated proof server setup
 
 ## Quick Start
 
 ```bash
-# Create new app
-npx create-midnight-app my-midnight-app
+# Create a new Midnight app
+npx create-mn-app my-midnight-app
 
-# Enter directory
+# Navigate to your project
 cd my-midnight-app
 
-# Start development
+# Start development server with hot reloading
 npm run dev
 ```
 
+## What's Included?
+
+Your generated project includes:
+
+- 📝 **Hello World Contract** - A simple Compact contract to get started
+- 🔐 **Wallet Setup** - Auto-generated wallet with secure seed phrase
+- 🛠️ **Development Environment** - Pre-configured TypeScript, nodemon, and build tools
+- 📚 **Provider Setup** - Midnight network providers (indexer, proof, state, ZK config)
+- 🎨 **Interactive CLI** - Test your contracts with a user-friendly command-line interface
+- 📋 **Environment Config** - `.env` file with network configuration
+- 🔄 **Git Ready** - Initialized git repository with proper `.gitignore`
+
+## Available Commands
+
+Once your project is created, you can run:
+
+### `npm run dev`
+
+Starts the development server with:
+
+- Docker-based proof server on port 6300
+- File watcher for automatic recompilation
+- Hot reloading for contract changes
+
+### `npm run setup`
+
+Complete setup pipeline:
+
+1. Compiles Compact contracts
+2. Builds TypeScript to JavaScript
+3. Deploys contracts to the network
+
+### `npm run cli`
+
+Opens an interactive command-line interface to:
+
+- Connect your wallet
+- Store messages in the contract
+- Retrieve stored messages
+- Test contract functionality
+
+### `npm run compile`
+
+Compiles your Compact smart contracts from `contracts/` to `contracts/managed/`
+
+### `npm run build`
+
+Builds your TypeScript source code to JavaScript in the `dist/` directory
+
+### `npm run deploy`
+
+Deploys your compiled contract to the Midnight testnet
+
+### `npm run check-balance`
+
+Checks your wallet balance. Useful for verifying if test tokens from the faucet have arrived before deploying.
+
+## Project Structure
+
+```
+my-midnight-app/
+├── contracts/
+│   ├── hello-world.compact       # Your Compact smart contract
+│   └── managed/                  # Compiled contract output
+├── src/
+│   ├── cli.ts                    # Interactive CLI application
+│   ├── deploy.ts                 # Contract deployment script
+│   ├── providers/
+│   │   └── midnight-providers.ts # Network provider configuration
+│   └── utils/
+│       └── environment.ts        # Environment management
+├── .env                          # Environment variables & wallet seed
+├── .gitignore
+├── package.json
+├── tsconfig.json
+└── nodemon.json
+```
+
 ## Templates
 
-- **hello-world** (default) - Simple message storage contract
-- More templates coming soon!
+### Hello World (Default)
+
+A simple message storage contract demonstrating:
+
+- State management
+- Public and private data
+- Contract deployment
+- Interactive testing
+
+**More templates coming soon!**
 
 ## Requirements
 
-- Node.js 18+
-- Docker (for proof server)
+- **Node.js** 18.0.0 or higher
+- **Docker** (for running the proof server)
+- **npm**, **yarn**, or **pnpm** package manager
+
+## Package Manager Options
+
+You can use your preferred package manager:
+
+```bash
+# npm (default)
+npx create-mn-app my-app
+
+# Yarn
+npx create-mn-app my-app --yarn
+
+# pnpm
+npx create-mn-app my-app --pnpm
+```
+
+## Usage Options
+
+```bash
+npx create-mn-app [project-name] [options]
+
+Options:
+  --template <name>    Specify a template (default: hello-world)
+  --yarn              Use Yarn as package manager
+  --pnpm              Use pnpm as package manager
+  --npm               Use npm as package manager
+  --skip-install      Skip dependency installation
+  --skip-git          Skip git initialization
+  -h, --help          Display help information
+```
+
+## Environment Configuration
+
+Your `.env` file contains important configuration:
+
+```env
+# Wallet Configuration
+WALLET_SEED=your-generated-seed-phrase
+
+# Network Configuration
+MIDNIGHT_NETWORK=testnet
+INDEXER_URL=https://indexer.testnet.midnight.network
+INDEXER_WS_URL=wss://indexer.testnet.midnight.network
+PROOF_SERVER_URL=http://localhost:6300
+```
+
+⚠️ **Important**: Never commit your `.env` file or share your wallet seed phrase!
+
+## Troubleshooting
+
+### Waiting for faucet funds
+
+If your deployment is waiting for funds from the testnet faucet:
+
+```bash
+# Option 1: Let the script wait (it will auto-detect funds)
+# Just leave it running after requesting from the faucet
+
+# Option 2: Stop and check manually
+# Press Ctrl+C to stop, then:
+npm run check-balance
+
+# Once funded, deploy:
+npm run deploy
+```
+
+💡 **Note**: Faucet transactions typically take 2-5 minutes to process.
+
+### Port 6300 already in use
+
+If you see "Bind for 0.0.0.0:6300 failed: port is already allocated":
+
+```bash
+# Stop the existing proof server
+docker ps
+docker stop <container-id>
+
+# Or run on a different port (update .env accordingly)
+```
+
+### Module resolution errors
+
+Make sure you're using Node.js 18+ and the project was created with the latest version:
+
+```bash
+node --version
+npx create-mn-app@latest my-app
+```
+
+### Docker not running
+
+Ensure Docker Desktop is running before starting the development server:
+
+```bash
+docker --version
+```
 
 ## Learn More
 
-- [Midnight Documentation](https://docs.midnight.network)
-- [Getting Started Guide](https://docs.midnight.network/getting-started)
+- 📖 [Midnight Documentation](https://docs.midnight.network)
+- 🚀 [Getting Started Guide](https://docs.midnight.network/getting-started)
+- 💬 [Midnight Discord Community](https://discord.gg/midnight)
+- 🐙 [GitHub Repository](https://github.com/Olanetsoft/create-midnight-app)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT © [Olanetsoft](https://github.com/Olanetsoft)
+
+---
+
+Built with ❤️ for the Midnight Network community 🌙✨

package/package.json

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

package/templates/hello-world/package.json.template

@@ -13,6 +13,7 @@
     "build": "tsc",
     "deploy": "node dist/deploy.js",
     "cli": "node dist/cli.js",
+    "check-balance": "npm run build && node dist/check-balance.js",
     "reset": "rm -rf contracts/managed deployment.json dist && npm run compile",
     "validate": "tsc --noEmit && npm run compile",
     "clean": "rm -rf dist contracts/managed deployment.json",

package/templates/hello-world/src/check-balance.ts.template

@@ -0,0 +1,87 @@
+import "dotenv/config";
+import { WalletBuilder } from "@midnight-ntwrk/wallet";
+import {
+  NetworkId,
+  setNetworkId,
+  getZswapNetworkId,
+  getLedgerNetworkId,
+} from "@midnight-ntwrk/midnight-js-network-id";
+import { nativeToken } from "@midnight-ntwrk/ledger";
+import { WebSocket } from "ws";
+import * as Rx from "rxjs";
+import { MidnightProviders } from "./providers/midnight-providers.js";
+import { EnvironmentManager } from "./utils/environment.js";
+
+// Fix WebSocket for Node.js environment
+// @ts-ignore
+globalThis.WebSocket = WebSocket;
+
+// Configure for Midnight Testnet
+setNetworkId(NetworkId.TestNet);
+
+async function checkBalance() {
+  try {
+    console.log("\n🌙 Checking Wallet Balance\n");
+
+    const seed = process.env.WALLET_SEED;
+    if (!seed) {
+      throw new Error("WALLET_SEED not found in .env file");
+    }
+
+    console.log("Building wallet...");
+
+    // Get network configuration
+    const networkConfig = EnvironmentManager.getNetworkConfig();
+
+    // Create providers
+    const providers = MidnightProviders.create({
+      indexerUrl: networkConfig.indexerUrl,
+      indexerWsUrl: networkConfig.indexerWsUrl,
+      prooServerUrl: networkConfig.proofServerUrl,
+      walletSeed: seed,
+      zkConfigPath: networkConfig.zkConfigPath,
+    });
+
+    // Build wallet
+    const wallet = await WalletBuilder.buildFromSeed(
+      getLedgerNetworkId(),
+      seed,
+      providers.privateStateProvider,
+      providers.zkConfigProvider,
+      providers.publicDataProvider,
+      { coinPublicKey: providers.coinPublicKey }
+    );
+
+    wallet.start();
+
+    const state = await Rx.firstValueFrom(wallet.state());
+
+    console.log(`Wallet Address: ${state.address}`);
+
+    const balance = state.balances[nativeToken()] || 0n;
+
+    if (balance === 0n) {
+      console.log(`\n💰 Balance: 0 DUST\n`);
+      console.log("❌ No funds detected.");
+      console.log("\n📝 To get funds:");
+      console.log("   1. Visit: https://midnight.network/test-faucet");
+      console.log("   2. Paste your wallet address");
+      console.log("   3. Wait a few minutes for the transaction to process");
+      console.log("   4. Run 'npm run check-balance' again to verify");
+      console.log("\n💡 Note: Faucet transactions can take 2-5 minutes to process.");
+    } else {
+      console.log(`\n💰 Balance: ${balance} DUST\n`);
+      console.log("✅ Wallet is funded!");
+      console.log("\n🚀 You can now deploy your contract:");
+      console.log("   npm run deploy");
+    }
+
+    wallet.close();
+    process.exit(0);
+  } catch (error) {
+    console.error("Error checking balance:", error);
+    process.exit(1);
+  }
+}
+
+checkBalance();

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

@@ -84,10 +84,18 @@ async function main() {
     let balance = state.balances[nativeToken()] || 0n;
 
     if (balance === 0n) {
-      console.log(`Your wallet balance is: 0`);
-      console.log(
-        "Visit: https://midnight.network/test-faucet to get some funds."
-      );
+      console.log(`Your wallet balance is: 0 DUST`);
+      console.log("\n❌ Wallet needs funding to deploy contracts.\n");
+      console.log("📝 To get test tokens:");
+      console.log("   1. Visit: https://midnight.network/test-faucet");
+      console.log("   2. Paste your wallet address (shown above)");
+      console.log("   3. Request tokens from the faucet\n");
+      console.log("⏱️  Faucet transactions can take 2-5 minutes to process.\n");
+      console.log("💡 Options while waiting:");
+      console.log("   • Let this script wait (it will auto-detect when funds arrive)");
+      console.log("   • OR press Ctrl+C to stop, then check balance with:");
+      console.log("     npm run check-balance");
+      console.log("   • Once funded, run: npm run deploy\n");
       console.log(`Waiting to receive tokens...`);
       balance = await waitForFunds(wallet);
     }