@offckb/cli 0.4.1 → 0.4.2-canary-1af067f.0

package/README.md

@@ -24,12 +24,12 @@ There are BREAKING CHANGES between v0.3.x and v0.4.x, make sure to read the [mig
 - [Install](#install)
 - [Usage](#usage)
 - [Get started](#get-started)
-  - [Run a Local CKB Devnet](#running-ckb)
-  - [Create a CKB Smart Contract Project](#create-project)
-  - [Deploy a CKB Smart Contract](#deploy-contract)
-  - [Debug a CKB Smart Contract](#debug-contract)
-  - [Explore built-in Scripts info](#explore-scripts)
-  - [Tweak Devnet Config](#tweak-devnet-config)
+  - [1. Run a Local CKB Devnet {#running-ckb}](#1-run-a-local-ckb-devnet-running-ckb)
+  - [2. Create a New Contract Project {#create-project}](#2-create-a-new-contract-project-create-project)
+  - [3. Deploy Your Contract {#deploy-contract}](#3-deploy-your-contract-deploy-contract)
+  - [4. Debug Your Contract {#debug-contract}](#4-debug-your-contract-debug-contract)
+  - [5. Explore Built-in Scripts {#explore-scripts}](#5-explore-built-in-scripts-explore-scripts)
+  - [6. Tweak Devnet Config {#tweak-devnet-config}](#6-tweak-devnet-config-tweak-devnet-config)
 - [Config Setting](#config-setting)
   - [List All Settings](#list-all-settings)
   - [Set CKB version](#set-ckb-version)
@@ -107,6 +107,15 @@ Or set a default version globally:
 offckb config set ckb-version 0.201.0
 offckb node
 ```
+
+Or specify the path to your locally compiled CKB binary:
+
+```sh
+offckb node --binary-path /path/to/your/ckb/binary
+```
+
+When using `--binary-path`, it will ignore the specified version and network, and only work for devnet.
+
 **RPC & Proxy RPC**
 
 When the Devnet starts:
@@ -125,7 +134,7 @@ Using a proxy RPC server for Testnet/Mainnet is especially helpful for debugging
 
 ### 2. Create a New Contract Project {#create-project}
     
-Generate a ready-to-use project in JS/TS using templates:
+Generate a ready-to-use smart-contract project in JS/TS using templates:
 ```sh
 offckb create <your-project-name> -c <your-contract-name>
 ```

package/build/index.js

@@ -332,8 +332,9 @@ program
     .command('node [CKB-Version]')
     .description('Use the CKB to start devnet')
     .option('--network <network>', 'Specify the network to deploy to', 'devnet')
+    .option('-b, --binary-path <binaryPath>', 'Specify the CKB binary path to use, only for devnet, when set, will ignore version and network')
     .action((version, options) => __awaiter(void 0, void 0, void 0, function* () {
-    return (0, node_1.startNode)({ version, network: options.network });
+    return (0, node_1.startNode)({ version, network: options.network, binaryPath: options.binaryPath });
 }));
 program
     .command('create [project-name]')
@@ -1286,10 +1287,13 @@ const encoding_1 = __nccwpck_require__(6851);
 const rpc_proxy_1 = __nccwpck_require__(46589);
 const base_1 = __nccwpck_require__(69951);
 const logger_1 = __nccwpck_require__(65370);
-function startNode({ version, network = base_1.Network.devnet }) {
+function startNode({ version, network = base_1.Network.devnet, binaryPath }) {
+    if (binaryPath && network !== base_1.Network.devnet) {
+        logger_1.logger.warn('Custom binaryPath is only supported for devnet. The provided binaryPath will be ignored.');
+    }
     switch (network) {
         case base_1.Network.devnet:
-            return nodeDevnet({ version });
+            return nodeDevnet({ version, binaryPath });
         case base_1.Network.testnet:
             return nodeTestnet();
         case base_1.Network.mainnet:
@@ -1299,13 +1303,20 @@ function startNode({ version, network = base_1.Network.devnet }) {
     }
 }
 function nodeDevnet(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ version }) {
+    return __awaiter(this, arguments, void 0, function* ({ version, binaryPath }) {
         var _b, _c;
         const settings = (0, setting_1.readSettings)();
         const ckbVersion = version || settings.bins.defaultCKBVersion;
-        yield (0, install_1.installCKBBinary)(ckbVersion);
+        let ckbBinPath = '';
+        if (binaryPath) {
+            ckbBinPath = (0, encoding_1.encodeBinPathForTerminal)(binaryPath);
+            logger_1.logger.info(`Using custom CKB binary path: ${ckbBinPath}`);
+        }
+        else {
+            yield (0, install_1.installCKBBinary)(ckbVersion);
+            ckbBinPath = (0, encoding_1.encodeBinPathForTerminal)((0, setting_1.getCKBBinaryPath)(ckbVersion));
+        }
         yield (0, init_chain_1.initChainIfNeeded)();
-        const ckbBinPath = (0, encoding_1.encodeBinPathForTerminal)((0, setting_1.getCKBBinaryPath)(ckbVersion));
         const devnetConfigPath = (0, encoding_1.encodeBinPathForTerminal)(settings.devnet.configPath);
         const ckbCmd = `${ckbBinPath} run -C ${devnetConfigPath}`;
         const minerCmd = `${ckbBinPath} miner -C ${devnetConfigPath}`;
@@ -1471,7 +1482,7 @@ function systemCellToScriptInfo({ cell, depType, depGroup, extraCellDeps, }) {
         }
         return {
             codeHash: (cell.type_hash || cell.data_hash),
-            hashType: cell.type_hash ? 'type' : 'data1',
+            hashType: cell.type_hash ? 'type' : 'data2',
             cellDeps,
         };
     }
@@ -1495,7 +1506,7 @@ function systemCellToScriptInfo({ cell, depType, depGroup, extraCellDeps, }) {
         }
         return {
             codeHash: (cell.type_hash || cell.data_hash),
-            hashType: cell.type_hash ? 'type' : 'data1',
+            hashType: cell.type_hash ? 'type' : 'data2',
             cellDeps,
         };
     }
@@ -2797,7 +2808,7 @@ exports.TESTNET_SYSTEM_SCRIPTS = {
         name: 'secp256k1_blake160_multisig_all_v2',
         script: {
             codeHash: '0x36c971b8d41fbd94aabca77dc75e826729ac98447b46f91e00796155dddb0d29',
-            hashType: 'data1',
+            hashType: 'data2',
             cellDeps: [
                 {
                     cellDep: {
@@ -2921,7 +2932,7 @@ exports.MAINNET_SYSTEM_SCRIPTS = {
         name: 'secp256k1_blake160_multisig_all_v2',
         script: {
             codeHash: '0x36c971b8d41fbd94aabca77dc75e826729ac98447b46f91e00796155dddb0d29',
-            hashType: 'data1',
+            hashType: 'data2',
             cellDeps: [
                 {
                     cellDep: {
@@ -3025,7 +3036,7 @@ function getScriptInfoFrom(recipe) {
     const isDepCode = recipe.depGroupRecipes.length > 0;
     const scriptsInfo = {
         codeHash: (firstCell.typeId ? firstCell.typeId : firstCell.dataHash),
-        hashType: firstCell.typeId ? 'type' : 'data1',
+        hashType: firstCell.typeId ? 'type' : 'data2',
         cellDeps: !isDepCode
             ? [
                 {
@@ -3373,16 +3384,32 @@ exports.networks = {
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.BASE_TEMPLATE_METADATA = exports.TEMPLATE_CONFIG = void 0;
-exports.TEMPLATE_CONFIG = {
+exports.REQUIRED_FILES = exports.PACKAGE_JSON_CONFIG = void 0;
+exports.PACKAGE_JSON_CONFIG = {
+    version: '0.1.0',
+    description: 'CKB JavaScript Smart Contract project',
+    private: true,
+    type: 'module',
+    scripts: {
+        'build:contract': 'node scripts/build-contract.js',
+        'build:contract:debug': 'node scripts/build-contract.js --debug',
+        build: 'node scripts/build-all.js',
+        'build:debug': 'node scripts/build-all.js --debug',
+        deploy: 'node scripts/build-all.js && node scripts/deploy.js',
+        'deploy:debug': 'node scripts/build-all.js --debug && node scripts/deploy.js',
+        test: 'node scripts/build-all.js && jest',
+        'add-contract': 'node scripts/add-contract.js',
+        clean: 'rimraf dist',
+        format: 'prettier --write .',
+    },
     dependencies: {
         '@ckb-js-std/bindings': '~1.0.0',
         '@ckb-js-std/core': '~1.0.0',
         dotenv: '^17.2.1',
     },
     devDependencies: {
-        'ckb-testtool': '1.0.3',
-        '@ckb-ccc/core': '1.5.3', // lock to version compatible with ckb-testtool
+        'ckb-testtool': '1.0.5',
+        '@ckb-ccc/core': '1.12.2', // lock to version compatible with ckb-testtool
         esbuild: '~0.25.8',
         jest: '~29.7.0',
         prettier: '^3.5.3',
@@ -3395,25 +3422,16 @@ exports.TEMPLATE_CONFIG = {
         '@types/jest': '~29.5.14',
     },
 };
-exports.BASE_TEMPLATE_METADATA = {
-    name: 'ckb-js-vm-base',
-    description: 'Base template for CKB JavaScript VM projects',
-    supportedLanguages: ['typescript', 'javascript'],
-    requiredFiles: [
-        'package.json.template',
-        'jest.config.cjs.template',
-        'gitignore.template',
-        'README.md.template',
-        'deployment/scripts.json.template',
-        'deployment/README.md.template',
-        'env.example.template',
-        'env.template',
-    ],
-    conditionalFiles: {
-        typescript: ['tsconfig.json.template', 'tsconfig.base.json.template'],
-        javascript: [],
-    },
-};
+exports.REQUIRED_FILES = [
+    'package.json.template',
+    'jest.config.cjs.template',
+    'gitignore.template',
+    'README.md.template',
+    'deployment/scripts.json.template',
+    'deployment/README.md.template',
+    'env.example.template',
+    'env.template',
+];
 
 
 /***/ }),
@@ -3661,7 +3679,7 @@ class TemplateProcessor {
             return false;
         }
         // Always include required files
-        if (config_1.BASE_TEMPLATE_METADATA.requiredFiles.some((reqFile) => relativePath.includes(reqFile))) {
+        if (config_1.REQUIRED_FILES.some((reqFile) => relativePath.includes(reqFile))) {
             return true;
         }
         // Handle language-specific jest config files
@@ -3705,25 +3723,16 @@ class TemplateProcessor {
     generatePackageJson(context) {
         const basePackageJson = {
             name: context.projectName,
-            version: '0.1.0',
-            description: 'CKB JavaScript Smart Contract project',
-            private: true,
-            type: 'module',
-            scripts: {
-                build: 'node scripts/build-all.js',
-                'build:contract': 'node scripts/build-contract.js',
-                test: 'node scripts/build-all.js && jest',
-                'add-contract': 'node scripts/add-contract.js',
-                deploy: 'node scripts/build-all.js && node scripts/deploy.js',
-                clean: 'rimraf dist',
-                format: 'prettier --write .',
-            },
-            dependencies: config_1.TEMPLATE_CONFIG.dependencies,
-            devDependencies: Object.assign({}, config_1.TEMPLATE_CONFIG.devDependencies),
+            version: config_1.PACKAGE_JSON_CONFIG.version,
+            description: config_1.PACKAGE_JSON_CONFIG.description,
+            private: config_1.PACKAGE_JSON_CONFIG.private,
+            type: config_1.PACKAGE_JSON_CONFIG.type,
+            scripts: config_1.PACKAGE_JSON_CONFIG.scripts,
+            dependencies: config_1.PACKAGE_JSON_CONFIG.dependencies,
+            devDependencies: Object.assign({}, config_1.PACKAGE_JSON_CONFIG.devDependencies),
         };
-        // Add TypeScript dependencies if needed
         if (context.language === 'typescript') {
-            Object.assign(basePackageJson.devDependencies, config_1.TEMPLATE_CONFIG.typescriptDevDeps);
+            Object.assign(basePackageJson.devDependencies, config_1.PACKAGE_JSON_CONFIG.typescriptDevDeps);
         }
         return basePackageJson;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offckb/cli",
-  "version": "0.4.1",
+  "version": "0.4.2-canary-1af067f.0",
   "description": "ckb development network for your first try",
   "author": "CKB EcoFund",
   "license": "MIT",

package/templates/v4/base-template/README.md.template

@@ -56,6 +56,15 @@ Build a specific contract:
 {{PACKAGE_MANAGER}} run build:contract hello-world
 ```
 
+Build with debug version:
+```bash
+{{PACKAGE_MANAGER}} run build:debug
+```
+or for specific contract with debug enabled:
+```bash
+{{PACKAGE_MANAGER}} run build:contract:debug hello-world
+```
+
 ### Running Tests
 
 Run all tests:
@@ -106,9 +115,12 @@ Tests use the `ckb-testtool` framework to simulate CKB blockchain execution. Eac
 
 - `build` - Build all contracts
 - `build:contract <name>` - Build a specific contract
+- `build:debug` - Build all contracts with debug version
+- `build:contract:debug <name>` - Build a specific contract with debug version
 - `test` - Run all tests
 - `add-contract <name>` - Add a new contract
 - `deploy` - Deploy contracts to CKB network
+- `deploy:debug` - Deploy contracts with debug version to CKB network
 - `clean` - Remove all build outputs
 - `format` - Format code with Prettier
 
@@ -129,6 +141,8 @@ Deploy your contracts to CKB networks using the built-in deploy script:
 {{PACKAGE_MANAGER}} run deploy -- --network mainnet
 ```
 
+Note that you can change the `run deploy` to `run deploy:debug` to deploy the debug version of your smart contracts.
+
 ### Advanced Options
 
 ```bash

package/templates/v4/base-template/scripts/build-all.js

@@ -4,7 +4,7 @@ import fs from 'fs';
 import path from 'path';
 import { execSync } from 'child_process';
 
-function buildAllContracts() {
+function buildAllContracts(isDebug = false) {
   const contractsDir = path.join(process.cwd(), 'contracts');
 
   if (!fs.existsSync(contractsDir)) {
@@ -27,8 +27,8 @@ function buildAllContracts() {
   for (const contractName of contracts) {
     console.log(`\n📦 Building contract: ${contractName}`);
     try {
-      execSync(`node scripts/build-contract.js ${contractName}`, { stdio: 'inherit' });
-      console.log(`✅ Successfully built: ${contractName}`);
+      execSync(`node scripts/build-contract.js ${contractName} ${isDebug ? '--debug' : ''}`, { stdio: 'inherit' });
+      console.log(`✅ Successfully built: ${contractName} with ${isDebug ? 'debug' : 'release'} version`);
     } catch (error) {
       console.error(`❌ Failed to build: ${contractName}`);
       console.error(error.message);
@@ -39,4 +39,4 @@ function buildAllContracts() {
   console.log(`\n🎉 All contracts built successfully!`);
 }
 
-buildAllContracts();
+buildAllContracts(process.argv.includes('--debug'));

package/templates/v4/base-template/scripts/build-contract.js

@@ -4,7 +4,7 @@ import { execSync } from 'child_process';
 import path from 'path';
 import fs from 'fs';
 
-function buildContract(contractName) {
+function buildContract(contractName, isDebug = false) {
   if (!contractName) {
     console.error('Usage: node build-contract.js <contract-name>');
     process.exit(1);
@@ -50,14 +50,23 @@ function buildContract(contractName) {
     // }
 
     // Step 2: Bundle with esbuild
-    console.log('  📦 Bundling with esbuild...');
+    console.log(`  📦 Bundling with esbuild with ${isDebug ? 'debug' : 'release'} settings...`);
+    const debugParams = [
+      '--sourcemap=external',
+      '--sources-content',
+      '--keep-names',
+      '--minify=false',
+      '--define:DEBUG=true',
+      '--loader:.map=json',
+    ];
+    const releaseParams = ['--minify'];
     const esbuildCmd = [
       './node_modules/.bin/esbuild',
       '--platform=neutral',
-      '--minify',
       '--bundle',
       '--external:@ckb-js-std/bindings',
       '--target=es2022',
+      ...(isDebug ? debugParams : releaseParams),
       srcFile,
       `--outfile=${outputJsFile}`,
     ].join(' ');
@@ -87,5 +96,7 @@ function buildContract(contractName) {
 }
 
 // Get contract name from command line arguments
-const contractName = process.argv[2];
-buildContract(contractName);
+const isDebug = process.argv.includes('--debug');
+const args = process.argv.slice(2).filter((arg) => arg !== '--debug');
+const contractName = args[0];
+buildContract(contractName, isDebug);