Merge pull request #334 from ckb-devrel/develop

Merge v0.4.2 to master

Author: RetricSu

.gitignore

@@ -7,3 +7,4 @@ dist/
 .vscode
 templates/temp-clone-folder
 build/
+package-lock.json

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>
 ```
@@ -258,7 +267,7 @@ Example result:
 Pay attention to the `devnet.configPath` and `devnet.dataPath`.
 
 2. `cd` into the `devnet.configPath` . Modify the config files as needed. See [Custom Devnet Setup](https://docs.nervos.org/docs/node/run-devnet-node#custom-devnet-setup) and [Configure CKB](https://github.com/nervosnetwork/ckb/blob/develop/docs/configure.md) for details.
-3. After modifications, remove everything in the `devnet.dataPath` folder to reset chain data.
+3. After modifications, run `offckb clean -d` to remove the chain data if needed while keeping the updated config files.
 4. Restart local blockchain by running `offckb node`
 
 

ckb/ckb-js-vm

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

ckb/devnet/specs/ckb_js_vm

@@ -31,8 +31,12 @@ program
   .command('node [CKB-Version]')
   .description('Use the CKB to start devnet')
   .option('--network <network>', 'Specify the network to deploy to', 'devnet')
-  .action(async (version: string, options: { network: Network }) => {
-    return startNode({ version, network: options.network });
+  .option(
+    '-b, --binary-path <binaryPath>',
+    'Specify the CKB binary path to use, only for devnet, when set, will ignore version and network',
+  )
+  .action(async (version: string, options: { network: Network; binaryPath?: string }) => {
+    return startNode({ version, network: options.network, binaryPath: options.binaryPath });
   });
 
 program
@@ -56,6 +60,7 @@ program
   .option('-o, --output <output>', 'Specify the output folder path for the deployment record files', './deployment')
   .option('-t, --type-id', 'Specify if use upgradable type id to deploy the script')
   .option('--privkey <privkey>', 'Specify the private key to deploy scripts')
+  .option('-y, --yes', 'Skip confirmation prompt and deploy immediately')
   .action((options: DeployOptions) => deploy(options));
 
 program
@@ -100,7 +105,11 @@ program
     return printSystemScripts({ style: exportStyle, network });
   });
 
-program.command('clean').description('Clean the devnet data, need to stop running the chain first').action(clean);
+program
+  .command('clean')
+  .description('Clean the devnet data, need to stop running the chain first')
+  .option('-d, --data', 'Only remove chain data, keep devnet config files')
+  .action((options: { data?: boolean }) => clean(options));
 program.command('accounts').description('Print account list info').action(accounts);
 
 program

package.json

@@ -3,19 +3,42 @@ import { isFolderExists } from '../util/fs';
 import { readSettings } from '../cfg/setting';
 import { logger } from '../util/logger';
 
-export function clean() {
+export interface CleanOptions {
+  data?: boolean;
+}
+
+export function clean(options?: CleanOptions) {
   const settings = readSettings();
   const allDevnetDataPath = settings.devnet.configPath;
-  // this is the root folder of devnet, it contains config, data, debugFullTransactions, transactions, failed-transactions, contracts
-  if (isFolderExists(allDevnetDataPath)) {
-    try {
-      fs.rmSync(allDevnetDataPath, { recursive: true });
-      logger.info(`Chain data cleaned.`);
-    } catch (error: unknown) {
-      logger.info(`Did you stop running the chain first?`);
-      logger.error((error as Error).message);
+  const dataOnly = options?.data || false;
+
+  if (dataOnly) {
+    // Only clean the chain data subdirectory
+    const chainDataPath = settings.devnet.dataPath;
+    if (isFolderExists(chainDataPath)) {
+      try {
+        fs.rmSync(chainDataPath, { recursive: true });
+        logger.info(`Chain data cleaned. Devnet config files preserved.`);
+      } catch (error: unknown) {
+        logger.info(`Did you stop running the chain first?`);
+        logger.error((error as Error).message);
+      }
+    } else {
+      logger.info(`Nothing to clean. Chain data directory ${chainDataPath} not found.`);
     }
   } else {
-    logger.info(`Nothing to clean. Devnet data directory ${allDevnetDataPath} not found.`);
+    // Clean everything - the original behavior
+    // this is the root folder of devnet, it contains config, data, debugFullTransactions, transactions, failed-transactions, contracts
+    if (isFolderExists(allDevnetDataPath)) {
+      try {
+        fs.rmSync(allDevnetDataPath, { recursive: true });
+        logger.info(`Chain data cleaned.`);
+      } catch (error: unknown) {
+        logger.info(`Did you stop running the chain first?`);
+        logger.error((error as Error).message);
+      }
+    } else {
+      logger.info(`Nothing to clean. Devnet data directory ${allDevnetDataPath} not found.`);
+    }
   }
 }

pnpm-lock.yaml

@@ -13,6 +13,7 @@ export interface DeployOptions extends NetworkOption {
   output?: string;
   privkey?: string | null;
   typeId?: boolean;
+  yes?: boolean;
 }
 
 export async function deploy(
@@ -55,13 +56,16 @@ export async function deploy(
     `   🔄 Type ID: ${enableTypeId ? 'enabled (upgradable)' : 'disabled (immutable)'}`,
   ]);
 
-  const res = await confirm({
-    message: 'Are you sure you want to deploy these contracts?',
-  });
+  // Skip confirmation if -y flag is provided
+  if (!opt.yes) {
+    const res = await confirm({
+      message: 'Are you sure you want to deploy these contracts?',
+    });
 
-  if (!res) {
-    logger.info('Deployment cancelled.');
-    return;
+    if (!res) {
+      logger.info('Deployment cancelled.');
+      return;
+    }
   }
 
   const results = await deployBinaries(outputFolder, binPaths, privateKey, enableTypeId, ckb);

src/cli.ts

@@ -10,12 +10,17 @@ import { logger } from '../util/logger';
 export interface NodeProp {
   version?: string;
   network?: Network;
+  binaryPath?: string;
 }
 
-export function startNode({ version, network = Network.devnet }: NodeProp) {
+export function startNode({ version, network = Network.devnet, binaryPath }: NodeProp) {
+  if (binaryPath && network !== Network.devnet) {
+    logger.warn('Custom binaryPath is only supported for devnet. The provided binaryPath will be ignored.');
+  }
+
   switch (network) {
     case Network.devnet:
-      return nodeDevnet({ version });
+      return nodeDevnet({ version, binaryPath });
     case Network.testnet:
       return nodeTestnet();
     case Network.mainnet:
@@ -25,13 +30,19 @@ export function startNode({ version, network = Network.devnet }: NodeProp) {
   }
 }
 
-export async function nodeDevnet({ version }: NodeProp) {
+export async function nodeDevnet({ version, binaryPath }: NodeProp) {
   const settings = readSettings();
   const ckbVersion = version || settings.bins.defaultCKBVersion;
-  await installCKBBinary(ckbVersion);
-  await initChainIfNeeded();
+  let ckbBinPath = '';
 
-  const ckbBinPath = encodeBinPathForTerminal(getCKBBinaryPath(ckbVersion));
+  if (binaryPath) {
+    ckbBinPath = encodeBinPathForTerminal(binaryPath);
+    logger.info(`Using custom CKB binary path: ${ckbBinPath}`);
+  } else {
+    await installCKBBinary(ckbVersion);
+    ckbBinPath = encodeBinPathForTerminal(getCKBBinaryPath(ckbVersion));
+  }
+  await initChainIfNeeded();
   const devnetConfigPath = encodeBinPathForTerminal(settings.devnet.configPath);
 
   const ckbCmd = `${ckbBinPath} run -C ${devnetConfigPath}`;