@offckb/cli 0.3.4 → 0.3.5

package/README.md

@@ -30,6 +30,7 @@ There are BREAKING CHANGES between v0.2.x and v0.3.x, make sure to read the [mig
   - [Tweak Devnet Config](#tweak-devnet-config)
   - [Create a full-stack Project](#create-a-full-stack-project)
   - [Create a script-only Project](#create-a-script-only-project)
+  - [Create a dApp-only Project](#create-a-dapp-only-project)
   - [Build and Deploy a script](#build-and-deploy-a-script)
   - [Start the frontend project](#start-the-frontend-project)
   - [Debug a transaction](#debug-a-transaction)
@@ -208,6 +209,14 @@ offckb create <your-project-name> --script
 
 Note: you need to have rust/cargo/cargo-generate/clang 16+ installed in your environment to use this command. offckb doesn't do anything really, it just call [ckb-script-template](https://github.com/cryptape/ckb-script-templates) to do all the magic.
 
+### Create a dApp-only Project
+
+You can create a new dApp project without the script(CKB Smart Contract). This is useful when you don't need to create your own on-chain script logic.
+
+```sh
+offckb create <your-project-name> --dapp # or -d
+```
+
 ### Build and Deploy a script
 
 The fullstack boilerplate project is a monorepo, which contains a script project and a frontend project.

package/dist/cfg/setting.d.ts

@@ -58,6 +58,9 @@ export interface Settings {
             cachePath: string;
             binFolder: string;
         };
+        ckbDebugger: {
+            minVersion: string;
+        };
     };
 }
 export declare const defaultSettings: Settings;

package/dist/cfg/setting.js

@@ -57,7 +57,7 @@ exports.defaultSettings = {
     },
     bins: {
         rootFolder: path.resolve(exports.dataPath, 'bins'),
-        defaultCKBVersion: '0.113.1',
+        defaultCKBVersion: '0.201.0',
         downloadPath: path.resolve(exports.cachePath, 'download'),
     },
     devnet: {
@@ -97,6 +97,9 @@ exports.defaultSettings = {
             cachePath: path.resolve(exports.cachePath, 'tools', 'moleculec-es'),
             binFolder: path.resolve(exports.dataPath, 'tools', 'moleculec-es'),
         },
+        ckbDebugger: {
+            minVersion: '0.200.0',
+        },
     },
 };
 function readSettings() {

package/dist/cli.js

@@ -75,11 +75,15 @@ program
     .command('create [your-project-name]')
     .description('Create a new dApp from bare templates')
     .option('-s, --script', 'Only create the script project')
+    .option('-d, --dapp', 'Only create the ccc dapp project')
     .action((projectName, option) => __awaiter(void 0, void 0, void 0, function* () {
     const name = projectName !== null && projectName !== void 0 ? projectName : 'my-first-ckb-project';
     if (option.script) {
         return yield (0, create_1.createScriptProject)(name);
     }
+    if (option.dapp) {
+        return yield (0, create_1.createDappProject)(name);
+    }
     const template = yield (0, create_1.selectBareTemplate)();
     return (0, create_1.create)(name, template);
 }));

package/dist/cmd/create.d.ts

@@ -1,7 +1,15 @@
 import { BareTemplateOption } from '../template/option';
-export interface CreateOption {
-    script: boolean;
-}
+export type ScriptOnly = {
+    script: true;
+    dapp?: false;
+};
+export type DappOnly = {
+    dapp: true;
+    script?: false;
+};
+export type CreateOption = ScriptOnly | DappOnly;
 export declare function createScriptProject(name: string): void;
+export declare function createDappProject(name: string): Promise<void>;
 export declare function create(name: string, template: BareTemplateOption): Promise<void>;
 export declare function selectBareTemplate(): Promise<BareTemplateOption>;
+export declare function askForInjectOffckbConfig(dappFolderPath: string): Promise<void>;

package/dist/cmd/create.js

@@ -13,11 +13,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createScriptProject = createScriptProject;
+exports.createDappProject = createDappProject;
 exports.create = create;
 exports.selectBareTemplate = selectBareTemplate;
+exports.askForInjectOffckbConfig = askForInjectOffckbConfig;
 const path_1 = __importDefault(require("path"));
 const fs_1 = require("../util/fs");
 const git_1 = require("../util/git");
+const inject_config_1 = require("./inject-config");
 const prompts_1 = require("@inquirer/prompts");
 const child_process_1 = require("child_process");
 const gen_1 = require("../scripts/gen");
@@ -34,6 +37,19 @@ function createScriptProject(name) {
         console.error('create script project failed, ', error.message);
     }
 }
+function createDappProject(name) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cmd = `npx create-ccc-app@latest ${name} --ts --}`;
+        try {
+            (0, child_process_1.execSync)(cmd, { encoding: 'utf-8', stdio: 'inherit' });
+            const dappFolderPath = path_1.default.resolve(process.cwd(), name);
+            yield askForInjectOffckbConfig(dappFolderPath);
+        }
+        catch (error) {
+            console.error('create ccc-appp project failed, ', error.message);
+        }
+    });
+}
 function create(name, template) {
     return __awaiter(this, void 0, void 0, function* () {
         const targetPath = path_1.default.resolve(process.cwd(), name);
@@ -75,3 +91,14 @@ function selectBareTemplate() {
         return opts.find((opt) => opt.value === answer);
     });
 }
+function askForInjectOffckbConfig(dappFolderPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const answer = yield (0, prompts_1.confirm)({
+            message: 'Do you want to inject offckb configs in your project  so that it can work with local blockchain info?',
+        });
+        if (answer) {
+            const target = path_1.default.resolve(dappFolderPath, 'offckb.config.ts');
+            (0, inject_config_1.injectConfig)({ target });
+        }
+    });
+}

package/dist/cmd/debug.js

@@ -113,7 +113,7 @@ function buildDebugFullTransactionFilePath(network, txHash) {
     return `${settings.mainnet.debugFullTransactionsPath}/${txHash}.json`;
 }
 function debugRaw(options) {
-    if (!ckb_debugger_1.CKBDebugger.isBinaryInstalled()) {
+    if (!ckb_debugger_1.CKBDebugger.isBinaryInstalled() || !ckb_debugger_1.CKBDebugger.isBinaryVersionValid()) {
         ckb_debugger_1.CKBDebugger.installCKBDebugger();
     }
     return ckb_debugger_1.CKBDebugger.runRaw(options);

package/dist/cmd/inject-config.js

@@ -67,6 +67,7 @@ function injectConfig({ target }) {
   const myScriptCodeHash = offCKB.myScripts['script-name'].codeHash;
   const omnilockScriptCodeHash = offCKB.systemScripts['omnilock'].codeHash;
 
-Check example at https://github.com/nervosnetwork/docs.nervos.org/tree/develop/examples/simple-transfer
+Check more on how to integrate offckb config to develop your app at https://docs.nervos.org/docs/getting-started/quick-start#different-frontend-framework
+A Full example can also be found at https://github.com/nervosnetwork/docs.nervos.org/tree/develop/examples/simple-transfer
   `);
 }

package/dist/template/option.js

@@ -3,14 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadBareTemplateOpts = loadBareTemplateOpts;
 const templates = [
     {
-        name: 'Remix-Vite Bare Templates',
+        name: 'JS Script with Next.js fullstack template',
+        value: 'js-script-next-js',
+        description: 'A full-stack template with Next-js and ckb-js-vm script',
+        tag: ['next.js', 'tailwindcss', 'ckb-js-vm', 'typescript'],
+        author: 'retric@cryptape.com',
+    },
+    {
+        name: 'Rust Script with Remix-Vite fullstack template',
         value: 'remix-vite-template',
         description: 'A full-stack template with Remix-vite and ckb-script-templates',
         tag: ['remix', 'vite', 'tailwindcss', 'ckb-script-templates', 'typescript', 'rust'],
         author: 'retric@cryptape.com',
     },
     {
-        name: 'Next.js Bare Templates',
+        name: 'Rust Script with Next.js fullstack template',
         value: 'next-js-template',
         description: 'A full-stack template with Next.js framework and ckb-script-templates',
         tag: ['next.js', 'tailwindcss', 'ckb-script-templates', 'typescript', 'rust'],

package/dist/tools/ckb-debugger.d.ts

@@ -8,5 +8,6 @@ export declare class CKBDebugger {
     static runRaw(options: string): void;
     static runTxCellScript({ fullTxJsonFilePath, cellIndex, cellType, scriptGroupType }: DebugOption): void;
     static isBinaryInstalled(): boolean;
+    static isBinaryVersionValid(): boolean;
     static installCKBDebugger(): void;
 }

package/dist/tools/ckb-debugger.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CKBDebugger = void 0;
 const child_process_1 = require("child_process");
+const setting_1 = require("../cfg/setting");
 class CKBDebugger {
     static runRaw(options) {
         const command = `ckb-debugger ${options}`;
@@ -15,6 +16,20 @@ class CKBDebugger {
         const result = (0, child_process_1.spawnSync)('ckb-debugger', ['--version'], { stdio: 'ignore' });
         return result.status === 0;
     }
+    static isBinaryVersionValid() {
+        const result = (0, child_process_1.spawnSync)('ckb-debugger', ['--version']);
+        if (result.status !== 0) {
+            console.error('ckb-debugger is not installed');
+            return false;
+        }
+        const version = result.stdout.toString().split(' ')[1];
+        const settings = (0, setting_1.readSettings)();
+        if (version < settings.tools.ckbDebugger.minVersion) {
+            console.error(`ckb-debugger version ${version} is less than ${settings.tools.ckbDebugger.minVersion}`);
+            return false;
+        }
+        return true;
+    }
     static installCKBDebugger() {
         const command = `cargo install --git https://github.com/nervosnetwork/ckb-standalone-debugger ckb-debugger`;
         try {

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@offckb/cli",
-  "version": "0.3.0-canary.0",
+  "version": "0.3.5",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@offckb/cli",
-      "version": "0.3.0-canary.0",
+      "version": "0.3.5",
       "license": "MIT",
       "dependencies": {
         "@ckb-ccc/core": "1.5.3",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offckb/cli",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "ckb development network for your first try",
   "author": "CKB EcoFund",
   "license": "MIT",