feat(node): support specify the path to a CKB binary (#317)

* feat(node): support specify the path to a CKB binary

* apply review suggestion

Author: RetricSu

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:

src/cli.ts

@@ -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

src/cmd/node.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}`;