@offckb/cli 0.3.0-canary-3b77560.0 → 0.3.0-canary-ce4cd80.0

package/README.md

@@ -25,6 +25,7 @@ Start building on CKB blockchain, right now, right away!
 - [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)
@@ -47,7 +48,7 @@ Start building on CKB blockchain, right now, right away!
 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
 
@@ -81,7 +82,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
 
@@ -96,7 +97,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:
@@ -140,6 +141,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.
@@ -164,7 +198,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/dist/cmd/deploy.js

@@ -131,21 +131,26 @@ function deployBinary(binPath, from, ckb) {
         console.log(`contract ${contractName} deployed, tx hash:`, res);
         console.log('wait 4 blocks..');
         yield ckb.indexer.waitForSync(-4); // why negative 4? a bug in ckb-lumos
+        const txHash = result.scriptConfig.TX_HASH;
+        const index = result.scriptConfig.INDEX;
+        const dataByteLen = BigInt(tx.outputsData[+index].slice(2).length / 2);
+        const dataShannonLen = dataByteLen * BigInt('100000000');
+        const occupiedCapacity = '0x' + dataShannonLen.toString(16);
         // todo: handle multiple cell recipes?
         return {
             deploymentOptions: {
                 name: contractName,
                 binFilePath: binPath,
                 enableTypeId: true,
-                lockScript: tx.outputs[+result.scriptConfig.INDEX].lock,
+                lockScript: tx.outputs[+index].lock,
             },
             deploymentRecipe: {
                 cellRecipes: [
                     {
                         name: contractName,
-                        txHash: result.scriptConfig.TX_HASH,
-                        index: result.scriptConfig.INDEX,
-                        occupiedCapacity: '0x' + BigInt(tx.outputsData[+result.scriptConfig.INDEX].slice(2).length / 2).toString(16),
+                        txHash,
+                        index,
+                        occupiedCapacity,
                         dataHash: (0, utils_1.ckbHash)(tx.outputsData[+result.scriptConfig.INDEX]),
                         typeId: (0, utils_1.computeScriptHash)(result.typeId),
                     },

package/dist/deploy/migration.d.ts

@@ -23,17 +23,17 @@ export interface DeploymentRecipeJson {
     cell_recipes: {
         name: string;
         tx_hash: string;
-        index: HexNumber;
-        occupied_capacity: HexNumber;
+        index: number;
+        occupied_capacity: number;
         data_hash: string;
         type_id?: string;
     }[];
     dep_group_recipes: {
         name: string;
         tx_hash: string;
-        index: HexNumber;
+        index: number;
         data_hash: string;
-        occupied_capacity: HexNumber;
+        occupied_capacity: number;
     }[];
 }
 export declare function generateDeploymentRecipeJsonFile(name: string, deploymentRecipe: DeploymentRecipe, network?: Network): void;

package/dist/deploy/migration.js

@@ -84,22 +84,30 @@ exports.getNewestMigrationFile = getNewestMigrationFile;
 function deploymentRecipeToJson(recipe) {
     return {
         cell_recipes: recipe.cellRecipes.map((val) => {
+            if (BigInt(val.occupiedCapacity) > BigInt(Number.MAX_SAFE_INTEGER)) {
+                // CKB blocksize limit is 500k, so it should be impossible to have a cell occupied data larger than Number.MAX_SAFE_INTEGER which is 9007,1992,5474,0991
+                console.error(`invalid occupiedCapacity: ${val.occupiedCapacity}, the cell_recipes json might be incorrect for cell outpoint ${val.txHash}:${+val.index}`);
+            }
             return {
                 name: val.name,
                 tx_hash: val.txHash,
-                index: val.index,
-                occupied_capacity: val.occupiedCapacity,
+                index: +val.index,
+                occupied_capacity: +BigInt(val.occupiedCapacity).toString(10),
                 data_hash: val.dataHash,
                 type_id: val.typeId,
             };
         }),
         dep_group_recipes: recipe.depGroupRecipes.map((val) => {
+            if (BigInt(val.occupiedCapacity) > BigInt(Number.MAX_SAFE_INTEGER)) {
+                // CKB blocksize limit is 500k, so it should be impossible to have a cell occupied data larger than Number.MAX_SAFE_INTEGER which is 9007,1992,5474,0991
+                console.error(`invalid occupiedCapacity: ${val.occupiedCapacity}, the dep_group_recipes json might be incorrect for cell outpoint ${val.txHash}:${+val.index}`);
+            }
             return {
                 name: val.name,
                 tx_hash: val.txHash,
-                index: val.index,
+                index: +val.index,
                 data_hash: val.dataHash,
-                occupied_capacity: val.occupiedCapacity,
+                occupied_capacity: +BigInt(val.occupiedCapacity).toString(10),
             };
         }),
     };
@@ -111,8 +119,8 @@ function deploymentRecipeFromJson(json) {
             return {
                 name: val.name,
                 txHash: val.tx_hash,
-                index: val.index,
-                occupiedCapacity: val.occupied_capacity,
+                index: '0x' + val.index.toString(16),
+                occupiedCapacity: '0x' + val.occupied_capacity.toString(16),
                 dataHash: val.data_hash,
                 typeId: val.type_id,
             };
@@ -121,9 +129,9 @@ function deploymentRecipeFromJson(json) {
             return {
                 name: val.name,
                 txHash: val.tx_hash,
-                index: val.index,
+                index: '0x' + val.index.toString(16),
                 dataHash: val.data_hash,
-                occupiedCapacity: val.occupied_capacity,
+                occupiedCapacity: '0x' + val.occupied_capacity.toString(16),
             };
         }),
     };

package/dist/deploy/toml.d.ts

@@ -10,7 +10,7 @@ export interface DeploymentOptions {
 export interface DeploymentToml {
     cells: {
         name: string;
-        enable_type_id: 'true' | 'false';
+        enable_type_id: boolean;
         location: {
             file: string;
         };

package/dist/deploy/toml.js

@@ -13,7 +13,7 @@ function generateDeploymentToml(options, network) {
         cells: [
             {
                 name: options.name,
-                enable_type_id: options.enableTypeId ? 'true' : 'false',
+                enable_type_id: options.enableTypeId,
                 location: {
                     file: options.binFilePath,
                 },
@@ -44,7 +44,7 @@ function readDeploymentToml(scriptName, network) {
         cells: [
             {
                 name: data.cells[0].name,
-                enableTypeId: data.cells[0].enable_type_id === 'true' ? true : false,
+                enableTypeId: data.cells[0].enable_type_id,
                 location: {
                     file: data.cells[0].location.file,
                 },

package/package.json

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