create-0g-app 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,149 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const p = __importStar(require("@clack/prompts"));
+const picocolors_1 = __importDefault(require("picocolors"));
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const child_process_1 = require("child_process");
+const TEMPLATES = {
+    storage: "File registry (storage SDK + on-chain provenance)",
+    compute: "Decentralized chat (inference SDK + on-chain logging) — coming soon",
+    agent: "Autonomous agent (storage + compute + task contract) — coming soon",
+};
+async function main() {
+    console.log();
+    console.log(picocolors_1.default.cyan([
+        "  ╔═══════════════════════════════════╗",
+        "  ║     " + picocolors_1.default.bold("create-0g-app") + "  v1.0.0       ║",
+        "  ╚═══════════════════════════════════╝",
+    ].join("\n")));
+    console.log();
+    p.intro(picocolors_1.default.bgCyan(picocolors_1.default.black(" 0G App Scaffolder ")));
+    // Project name from CLI arg or prompt
+    let projectName = process.argv[2];
+    if (!projectName) {
+        const name = await p.text({
+            message: "Project name:",
+            placeholder: "my-0g-app",
+            validate: (v) => {
+                if (!v)
+                    return "Project name is required";
+                if (!/^[a-z0-9-_]+$/i.test(v))
+                    return "Only letters, numbers, hyphens and underscores";
+            },
+        });
+        if (p.isCancel(name)) {
+            p.cancel("Cancelled.");
+            process.exit(0);
+        }
+        projectName = name;
+    }
+    const template = await p.select({
+        message: "Which template would you like to use?",
+        options: Object.entries(TEMPLATES).map(([value, label]) => ({ value, label: `${value.padEnd(10)} — ${label}` })),
+    });
+    if (p.isCancel(template)) {
+        p.cancel("Cancelled.");
+        process.exit(0);
+    }
+    const targetDir = path_1.default.resolve(process.cwd(), projectName);
+    if (fs_extra_1.default.existsSync(targetDir)) {
+        const overwrite = await p.confirm({
+            message: `Directory ${picocolors_1.default.yellow(projectName)} already exists. Overwrite?`,
+            initialValue: false,
+        });
+        if (p.isCancel(overwrite) || !overwrite) {
+            p.cancel("Cancelled.");
+            process.exit(0);
+        }
+        fs_extra_1.default.removeSync(targetDir);
+    }
+    const s = p.spinner();
+    // Copy template
+    s.start("Scaffolding project");
+    const templateDir = path_1.default.join(__dirname, "..", "templates", template);
+    if (!fs_extra_1.default.existsSync(templateDir)) {
+        s.stop(picocolors_1.default.yellow(`The "${template}" template is coming soon! Only "storage" is available right now.`));
+        process.exit(0);
+    }
+    fs_extra_1.default.copySync(templateDir, targetDir, {
+        filter: (src) => !src.includes("node_modules") && !src.includes(".next"),
+    });
+    // Rename gitignore (npm strips .gitignore on publish)
+    const gitignoreSrc = path_1.default.join(targetDir, "_gitignore");
+    const gitignoreDest = path_1.default.join(targetDir, ".gitignore");
+    if (fs_extra_1.default.existsSync(gitignoreSrc))
+        fs_extra_1.default.moveSync(gitignoreSrc, gitignoreDest);
+    // Write .env from .env.example in web package
+    const envExample = path_1.default.join(targetDir, "packages", "web", ".env.example");
+    const envDest = path_1.default.join(targetDir, "packages", "web", ".env.local");
+    if (fs_extra_1.default.existsSync(envExample) && !fs_extra_1.default.existsSync(envDest)) {
+        fs_extra_1.default.copySync(envExample, envDest);
+    }
+    s.stop(`Scaffolded project in ${picocolors_1.default.green(`./${projectName}`)}`);
+    // Install dependencies — stream output directly so user can see progress
+    console.log(picocolors_1.default.dim("\n  Installing dependencies... (this may take a minute, hang tight)\n"));
+    try {
+        (0, child_process_1.execSync)("npm install", { cwd: targetDir, stdio: "inherit" });
+        console.log();
+        p.log.success("Dependencies installed");
+    }
+    catch {
+        p.log.warn("Dependency install failed — run `npm install` manually inside the project");
+    }
+    p.outro([
+        picocolors_1.default.green("Your 0G app is ready!"),
+        "",
+        "  " + picocolors_1.default.dim("Next steps:"),
+        "",
+        `    ${picocolors_1.default.cyan(`cd ${projectName}`)}`,
+        `    ${picocolors_1.default.dim("# Add your private key to packages/web/.env.local")}`,
+        `    ${picocolors_1.default.cyan("npm run dev")}     ${picocolors_1.default.dim("→ local dev server")}`,
+        `    ${picocolors_1.default.cyan("npm run deploy")}  ${picocolors_1.default.dim("→ compile + deploy contract to Galileo testnet")}`,
+        `    ${picocolors_1.default.cyan("npm run verify")}  ${picocolors_1.default.dim("→ verify contract on 0G explorer")}`,
+        "",
+        `  ${picocolors_1.default.dim("Docs: https://docs.0g.ai")}`,
+    ].join("\n"));
+}
+main().catch((e) => {
+    console.error(e);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,kDAAoC;AACpC,4DAA4B;AAC5B,gDAAwB;AACxB,wDAA0B;AAC1B,iDAAyC;AAEzC,MAAM,SAAS,GAAG;IAChB,OAAO,EAAE,mDAAmD;IAC5D,OAAO,EAAE,qEAAqE;IAC9E,KAAK,EAAI,oEAAoE;CACrE,CAAC;AAIX,KAAK,UAAU,IAAI;IACjB,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,OAAO,CAAC,GAAG,CACT,oBAAE,CAAC,IAAI,CACL;QACE,yCAAyC;QACzC,UAAU,GAAG,oBAAE,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,kBAAkB;QAC1D,yCAAyC;KAC1C,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CACF,CAAC;IACF,OAAO,CAAC,GAAG,EAAE,CAAC;IAEd,CAAC,CAAC,KAAK,CAAC,oBAAE,CAAC,MAAM,CAAC,oBAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAEpD,sCAAsC;IACtC,IAAI,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC;YACxB,OAAO,EAAE,eAAe;YACxB,WAAW,EAAE,WAAW;YACxB,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;gBACd,IAAI,CAAC,CAAC;oBAAE,OAAO,0BAA0B,CAAC;gBAC1C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;oBAAE,OAAO,gDAAgD,CAAC;YACzF,CAAC;SACF,CAAC,CAAC;QACH,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAAC,CAAC;QAClE,WAAW,GAAG,IAAc,CAAC;IAC/B,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,MAAM,CAAC;QAC9B,OAAO,EAAE,uCAAuC;QAChD,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC,CAAC;KACjH,CAAC,CAAC;IACH,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAAC,CAAC;IAEtE,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAqB,CAAC,CAAC;IAErE,IAAI,kBAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,OAAO,CAAC;YAChC,OAAO,EAAE,aAAa,oBAAE,CAAC,MAAM,CAAC,WAAqB,CAAC,6BAA6B;YACnF,YAAY,EAAE,KAAK;SACpB,CAAC,CAAC;QACH,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;YAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAAC,CAAC;QACrF,kBAAE,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;IAEtB,gBAAgB;IAChB,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,QAAoB,CAAC,CAAC;IAClF,IAAI,CAAC,kBAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAChC,CAAC,CAAC,IAAI,CAAC,oBAAE,CAAC,MAAM,CAAC,QAAQ,QAAQ,mEAAmE,CAAC,CAAC,CAAC;QACvG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,kBAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,SAAS,EAAE;QAClC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC;KACzE,CAAC,CAAC;IAEH,sDAAsD;IACtD,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACxD,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACzD,IAAI,kBAAE,CAAC,UAAU,CAAC,YAAY,CAAC;QAAE,kBAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;IAE1E,8CAA8C;IAC9C,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IAC3E,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;IACtE,IAAI,kBAAE,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,kBAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,CAAC,CAAC,IAAI,CAAC,yBAAyB,oBAAE,CAAC,KAAK,CAAC,KAAK,WAAqB,EAAE,CAAC,EAAE,CAAC,CAAC;IAE1E,yEAAyE;IACzE,OAAO,CAAC,GAAG,CAAC,oBAAE,CAAC,GAAG,CAAC,uEAAuE,CAAC,CAAC,CAAC;IAC7F,IAAI,CAAC;QACH,IAAA,wBAAQ,EAAC,aAAa,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAC9D,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACP,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;IAC1F,CAAC;IAED,CAAC,CAAC,KAAK,CACL;QACE,oBAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC;QACjC,EAAE;QACF,IAAI,GAAG,oBAAE,CAAC,GAAG,CAAC,aAAa,CAAC;QAC5B,EAAE;QACF,OAAO,oBAAE,CAAC,IAAI,CAAC,MAAM,WAAqB,EAAE,CAAC,EAAE;QAC/C,OAAO,oBAAE,CAAC,GAAG,CAAC,mDAAmD,CAAC,EAAE;QACpE,OAAO,oBAAE,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,oBAAE,CAAC,GAAG,CAAC,oBAAoB,CAAC,EAAE;QACnE,OAAO,oBAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,oBAAE,CAAC,GAAG,CAAC,gDAAgD,CAAC,EAAE;QAC/F,OAAO,oBAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,oBAAE,CAAC,GAAG,CAAC,kCAAkC,CAAC,EAAE;QACjF,EAAE;QACF,KAAK,oBAAE,CAAC,GAAG,CAAC,0BAA0B,CAAC,EAAE;KAC1C,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;AACJ,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "create-0g-app",
+  "version": "1.0.0",
+  "description": "Zero-config scaffold CLI for building on the 0G decentralized AI network",
+  "bin": {
+    "create-0g-app": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "start": "node dist/index.js",
+    "prepare": "npm run build"
+  },
+  "keywords": ["0g", "scaffold", "cli", "web3", "ai", "decentralized"],
+  "license": "MIT",
+  "dependencies": {
+    "@clack/prompts": "^0.9.1",
+    "fs-extra": "^11.2.0",
+    "picocolors": "^1.1.1"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^22.0.0",
+    "typescript": "^5.7.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/templates/storage/README.md

@@ -0,0 +1,106 @@
+# 0G Storage App
+
+A decentralized file registry built on the [0G network](https://0g.ai).
+
+- **Files** are stored on 0G's decentralized storage network via `@0glabs/0g-ts-sdk`
+- **Provenance** (who uploaded what, and when) is recorded on-chain via `FileRegistry.sol`
+- **Frontend** is a Next.js 15 app with wagmi wallet connect
+
+## Quick Start
+
+### 1. Install dependencies
+
+```bash
+npm install
+```
+
+### 2. Configure environment
+
+```bash
+cp packages/web/.env.example packages/web/.env.local
+```
+
+Edit `packages/web/.env.local` and add your private key:
+
+```env
+PRIVATE_KEY=0xYOUR_PRIVATE_KEY_HERE
+```
+
+> Get testnet OG tokens from the [0G faucet](https://faucet.0g.ai) if your wallet is empty.
+
+### 3. Start the dev server (no deploy needed)
+
+```bash
+npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000). You can browse the UI, but uploads need the contract deployed first.
+
+### 4. Deploy the contract to Galileo testnet
+
+```bash
+npm run deploy
+```
+
+This will:
+1. Compile `FileRegistry.sol`
+2. Deploy it to the 0G Galileo testnet (chain ID 16601)
+3. Automatically write the contract address to `packages/web/.env.local`
+
+Restart the dev server after deploying to pick up the new address.
+
+### 5. Verify the contract (optional)
+
+```bash
+npm run verify
+```
+
+View your contract on the [0G Galileo explorer](https://chainscan-galileo.0g.ai).
+
+## Project Structure
+
+```
+├── packages/
+│   ├── contracts/         Solidity + Hardhat
+│   │   ├── contracts/
+│   │   │   └── FileRegistry.sol
+│   │   ├── scripts/
+│   │   │   └── deploy.ts
+│   │   └── hardhat.config.ts
+│   └── web/               Next.js frontend
+│       ├── app/
+│       ├── lib/
+│       │   ├── 0g-storage.ts   0G SDK wrapper
+│       │   ├── abi.ts          FileRegistry ABI
+│       │   └── wagmi.ts        Wallet config
+│       └── .env.example
+└── README.md
+```
+
+## How It Works
+
+1. User connects their wallet (MetaMask or any injected wallet)
+2. User drops a file onto the upload zone
+3. The file is uploaded to 0G storage via the indexer — a content ID (merkle root) is returned
+4. The content ID is written on-chain to `FileRegistry.sol` via `registerFile()`
+5. The file gallery reads all content IDs from the contract for the connected wallet
+6. Clicking "Download" fetches the file from 0G storage by content ID
+
+## Troubleshooting
+
+**"No contract deployed yet" warning**
+Run `npm run deploy` and restart the dev server.
+
+**Transaction fails / insufficient funds**
+Get testnet OG tokens from [https://faucet.0g.ai](https://faucet.0g.ai).
+
+**Upload hangs**
+The 0G storage indexer may be temporarily unavailable. Check [https://docs.0g.ai](https://docs.0g.ai) for status.
+
+**Wrong network in MetaMask**
+Add the 0G Galileo testnet manually:
+- Network name: 0G Galileo Testnet
+- RPC URL: https://evmrpc-test.0g.ai
+- Chain ID: 16601
+- Currency: OG
+- Explorer: https://chainscan-galileo.0g.ai

package/templates/storage/_gitignore

@@ -0,0 +1,20 @@
+# deps
+node_modules/
+
+# Next.js
+packages/web/.next/
+packages/web/out/
+
+# Hardhat
+packages/contracts/artifacts/
+packages/contracts/cache/
+packages/contracts/typechain-types/
+packages/contracts/.deployed-address
+
+# env — never commit private keys
+packages/web/.env.local
+packages/web/.env
+
+# misc
+.DS_Store
+*.log