@offckb/cli 0.3.0-rc2 → 0.3.0-rc3

package/README.md

@@ -27,6 +27,7 @@ There are BREAKING CHANGES between v0.2.x and v0.3.x, make sure to read the [mig
 - [Get started](#get-started)
   - [Running CKB](#running-ckb)
   - [List scripts info](#list-scripts-info)
+  - [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)
   - [Build and Deploy a script](#build-and-deploy-a-script)
@@ -49,7 +50,7 @@ There are BREAKING CHANGES between v0.2.x and v0.3.x, make sure to read the [mig
 npm install -g @offckb/cli
 ```
 
-*We recommand using [LTS](https://nodejs.org/en/download/package-manager) version of Node to run `offckb`*
+_We recommand using [LTS](https://nodejs.org/en/download/package-manager) version of Node to run `offckb`_
 
 ## Usage
 
@@ -83,7 +84,7 @@ Commands:
   help [command]                                    display help for command
 ```
 
-*Use `offckb [command] -h` to learn more about a specific command.*
+_Use `offckb [command] -h` to learn more about a specific command._
 
 ## Get started
 
@@ -98,7 +99,7 @@ offckb node
 Or specify a CKB version:
 
 ```sh
-offckb node 0.117.0 
+offckb node 0.117.0
 ```
 
 Or set the default CKB version:
@@ -142,6 +143,39 @@ Or print the scripts info in a CCC style:
 offckb system-scripts --export-style ccc
 ```
 
+### Tweak Devnet Config
+
+By default, offckb use a fixed devnet config for the local blockchain. You can tweak the config to customize the devnet:
+
+First, start a default CKB devnet and locate your devnet folder
+
+```sh
+offckb node
+# after starting, press ctrl-c to kill the node
+# then get the config
+offckb config list
+```
+
+Result:
+
+```json
+{
+  "devnet": {
+    "rpcUrl": "http://localhost:8114",
+    "configPath": "~/Library/Application Support/offckb-nodejs/devnet",
+    "dataPath": "~/Library/Application Support/offckb-nodejs/devnet/data"
+  }
+}
+```
+
+Pay attention to the `devnet.configPath` and `devnet.dataPath`. They are the ones we need.
+
+1. `cd` into the `devnet.configPath`, this is the config folder for the local blockchain. Modify the config in the folder to better customize the devnet. For customization, 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 better explanation of the config files.
+2. After modifications, remove everything in the `devnet.dataPath` folder. This will clean the chain data.
+3. Restart local blockchain by running `offckb node`
+
+Done.
+
 ### Create a full-stack Project
 
 Create a new project from predefined boilerplates.
@@ -166,7 +200,7 @@ Note: you need to have rust/cargo/cargo-generate/clang 16+ installed in your env
 
 The fullstack boilerplate project is a monorepo, which contains a script project and a frontend project.
 
-To build the script, in the root of the project, run: 
+To build the script, in the root of the project, run:
 
 ```sh
 make build

package/ckb/devnet/specs/dev.toml

@@ -1,4 +1,4 @@
-name = "offckb"
+name = "ckb_dev"
 
 [genesis]
 version = 0

package/dist/cmd/system-scripts.js

@@ -65,18 +65,22 @@ function getSystemScriptsFromListHashes() {
     const listHashesString = (0, list_hashes_1.getListHashes)(settings.bins.defaultCKBVersion);
     if (listHashesString) {
         const listHashes = toml_1.default.parse(listHashesString);
-        const systemScriptArray = listHashes.offckb.system_cells
+        const chainSpecHashes = Object.values(listHashes)[0];
+        if (chainSpecHashes == null) {
+            throw new Error(`invalid chain spec hashes file ${listHashesString}`);
+        }
+        const systemScriptArray = chainSpecHashes.system_cells
             .map((cell) => {
             var _a;
             // Extract the file name
             const name = ((_a = cell.path.split('/').pop()) === null || _a === void 0 ? void 0 : _a.replace(')', '')) || 'unknown script';
-            const depGroupIndex = listHashes.offckb.dep_groups.findIndex((depGroup) => depGroup.included_cells.includes(`Bundled(specs/cells/${name})`));
+            const depGroupIndex = chainSpecHashes.dep_groups.findIndex((depGroup) => depGroup.included_cells.includes(`Bundled(specs/cells/${name})`));
             const depType = depGroupIndex === -1 ? 'code' : 'depGroup';
             const depGroup = depGroupIndex === -1
                 ? undefined
                 : {
-                    txHash: listHashes.offckb.dep_groups[depGroupIndex].tx_hash,
-                    index: listHashes.offckb.dep_groups[depGroupIndex].index,
+                    txHash: chainSpecHashes.dep_groups[depGroupIndex].tx_hash,
+                    index: chainSpecHashes.dep_groups[depGroupIndex].index,
                 };
             const scriptInfo = systemCellToScriptInfo(cell, depType, depGroup);
             return {

package/package.json

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