@offckb/cli 0.2.0 → 0.2.2

package/README.md

@@ -23,7 +23,9 @@ Start building on Nervos blockchain, right now, right away!
 - [Install](#install)
 - [Usage](#usage)
 - [Get started](#get-started)
-- [Run A dApp Example](#run-a-dapp-example) 
+  - [Create a full-stack Project](#create-a-full-stack-project)
+  - [Create a script-only Project](#create-a-script-only-project)
+- [Run A dApp Example](#run-a-dapp-example)
   - [Step 1: Select A dApp To Init](#step-1-select-a-dapp-to-init)
   - [Step 2: Start the Devnet](#step-2-start-the-devnet)
   - [Step 3: Access Pre-funded Accounts](#step-3-access-pre-funded-accounts)
@@ -64,25 +66,45 @@ Commands:
   accounts                                          Print account list info
   list-hashes                                       Use the CKB to list blockchain scripts hashes
   inject-config                                     Add offckb.config.ts to your workspace
-  update-config                                     Update offckb.config.ts in your workspace
+  sync-config                                       sync offckb.config.ts in your workspace
   deposit [options] [toAddress] [amountInShannon]   Deposit CKB tokens to address, only devnet and testnet
   transfer [options] [toAddress] [amountInShannon]  Transfer CKB tokens to address, only devnet and testnet
   balance [options] [toAddress]                     Check account balance, only devnet and testnet
   deploy [options]                                  Deploy contracts to different networks, only supports devnet and testnet
+  deployed-scripts [options]                        Show deployed contracts info on networks, only supports devnet and testnet
   help [command]                                    display help for command
 ```
 
 *Use `offckb [command] -h` to learn more about a specific command.*
 
+Sometimes you might encounter sudo permission problems. Granting the current user write access to the node_modules directory can resolve the problem.
+
+```sh
+sudo chown -R $(whoami) /usr/local/lib/node_modules
+npm install -g @offckb/cli
+```
+
 ## Get started
 
+### Create a full-stack Project 
+
 Create a new project from predefined boilerplates.
 
 ```sh
 offckb create <your-project-name, eg:my-first-ckb-project>
 ```
 
-The boilerplate can be targeting on different CKB networks. Check README.md in the project to get started.
+The boilerplate can be targeting on different CKB networks. Check [README.md](https://github.com/nervosnetwork/docs.nervos.org/blob/develop/examples/remix-vite-template/readme.md) in the project to get started.
+
+### Create a script-only Project
+
+You can create a new script project without a frontend. This is useful when you only want to develop smart contracts for CKB.
+
+```sh
+offckb create <your-project-name> --script
+```
+
+Note: you need to have rust/cargo/cargo-generate/clang 16+ installed in your environment to use this command. offckb doesn't do anything really, it just call [ckb-script-template](https://github.com/cryptape/ckb-script-tempaltes) to do all the magic. 
 
 ## Run A dApp Example
 

package/dist/cli.js

@@ -24,11 +24,12 @@ const encoding_1 = require("./util/encoding");
 const inject_config_1 = require("./cmd/inject-config");
 const deposit_1 = require("./cmd/deposit");
 const deploy_1 = require("./cmd/deploy");
-const update_config_1 = require("./cmd/update-config");
+const sync_config_1 = require("./cmd/sync-config");
 const transfer_1 = require("./cmd/transfer");
 const balance_1 = require("./cmd/balance");
 const build_account_1 = require("./cmd/develop/build-account");
 const create_1 = require("./cmd/create");
+const deployed_scripts_1 = require("./cmd/deployed-scripts");
 const version = require('../package.json').version;
 const description = require('../package.json').description;
 // fix windows terminal encoding of simplified chinese text
@@ -46,8 +47,12 @@ program
 program
     .command('create [your-project-name]')
     .description('Create a new dApp from bare templates')
-    .action((projectName) => __awaiter(void 0, void 0, void 0, function* () {
+    .option('-s, --script', 'Only create the script project')
+    .action((projectName, option) => __awaiter(void 0, void 0, void 0, function* () {
     const name = projectName !== null && projectName !== void 0 ? projectName : 'my-first-ckb-project';
+    if (option.script) {
+        return yield (0, create_1.createScriptProject)(name);
+    }
     const template = yield (0, create_1.selectBareTemplate)();
     return (0, create_1.create)(name, template);
 }));
@@ -56,7 +61,7 @@ program.command('clean').description('Clean the devnet data, need to stop runnin
 program.command('accounts').description('Print account list info').action(accounts_1.accounts);
 program.command('list-hashes').description('Use the CKB to list blockchain scripts hashes').action(list_hashes_1.listHashes);
 program.command('inject-config').description('Add offckb.config.ts to your workspace').action(inject_config_1.injectConfig);
-program.command('update-config').description('Update offckb.config.ts in your workspace').action(update_config_1.updateConfig);
+program.command('sync-config').description('Sync offckb.config.ts in your workspace').action(sync_config_1.syncConfig);
 program
     .command('deposit [toAddress] [amountInShannon]')
     .description('Deposit CKB tokens to address, only devnet and testnet')
@@ -86,6 +91,11 @@ program
     .option('--target <target>', 'Specify the relative bin target folder to deploy to')
     .option('--privkey <privkey>', 'Specify the private key to deploy scripts')
     .action((options) => (0, deploy_1.deploy)(options));
+program
+    .command('deployed-scripts')
+    .description('Show deployed contracts info on different networks, only supports devnet and testnet')
+    .option('--network <network>', 'Specify the network to deploy to', 'devnet')
+    .action((options) => (0, deployed_scripts_1.deployedScripts)(options));
 // Add commands meant for developers
 if (process.env.NODE_ENV === 'development') {
     // Define the CLI commands and options

package/dist/cmd/create.d.ts

@@ -1,3 +1,7 @@
 import { BareTemplateOption } from '../util/template';
+export interface CreateOption {
+    script: boolean;
+}
+export declare function createScriptProject(name: string): void;
 export declare function create(name: string, template: BareTemplateOption): Promise<void>;
 export declare function selectBareTemplate(): Promise<BareTemplateOption>;

package/dist/cmd/create.js

@@ -12,14 +12,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.selectBareTemplate = exports.create = void 0;
+exports.selectBareTemplate = exports.create = exports.createScriptProject = void 0;
 const path_1 = __importDefault(require("path"));
 const const_1 = require("../cfg/const");
 const fs_1 = require("../util/fs");
 const template_1 = require("../util/template");
 const git_1 = require("../util/git");
 const prompts_1 = require("@inquirer/prompts");
+const child_process_1 = require("child_process");
 const version = require('../../package.json').version;
+function createScriptProject(name) {
+    const cmd = `cargo generate gh:cryptape/ckb-script-templates workspace --name ${name}`;
+    try {
+        (0, child_process_1.execSync)(cmd, { encoding: 'utf-8', stdio: 'inherit' });
+    }
+    catch (error) {
+        console.error('create script project failed, ', error.message);
+    }
+}
+exports.createScriptProject = createScriptProject;
 function create(name, template) {
     return __awaiter(this, void 0, void 0, function* () {
         const targetPath = path_1.default.resolve(const_1.currentExecPath, name);

package/dist/cmd/deployed-scripts.d.ts

@@ -0,0 +1,4 @@
+import { NetworkOption } from '../util/type';
+export interface DeployedScriptOption extends NetworkOption {
+}
+export declare function deployedScripts(option?: DeployedScriptOption): void;

package/dist/cmd/deployed-scripts.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deployedScripts = void 0;
+const config_1 = require("../util/config");
+const type_1 = require("../util/type");
+const validator_1 = require("../util/validator");
+function deployedScripts(option = { network: type_1.Network.devnet }) {
+    const network = option.network;
+    (0, validator_1.validateNetworkOpt)(network);
+    const scritpsInfo = (0, config_1.readUserDeployedScriptsInfo)(network);
+    console.log(`User deployed scripts on ${network}`);
+    console.log(JSON.stringify(scritpsInfo, null, 2));
+}
+exports.deployedScripts = deployedScripts;

package/dist/cmd/inject-config.js

@@ -35,11 +35,12 @@ const config_1 = require("../util/config");
 const validator_1 = require("../util/validator");
 const type_1 = require("../util/type");
 function injectConfig() {
-    const targetPath = const_1.currentExecPath;
     (0, validator_1.validateTypescriptWorkspace)();
     // inject the offckb.config.ts file into users workspace
     // copy config template
-    (0, fs_1.copyFileSync)(const_1.predefinedOffCKBConfigTsPath, targetPath);
+    (0, fs_1.copyFileSync)(const_1.predefinedOffCKBConfigTsPath, const_1.userOffCKBConfigPath);
+    // update the version in the offckb.config.ts
+    (0, config_1.updateOffCKBConfigVersion)(const_1.userOffCKBConfigPath);
     // update the config
     const devnetFullLumosConfig = (0, config_1.buildFullLumosConfig)(type_1.Network.devnet);
     const testnetFullLumosConfig = (0, config_1.buildFullLumosConfig)(type_1.Network.testnet);
@@ -59,7 +60,7 @@ function injectConfig() {
   const indexer = offCKB.indexer;
   const rpc = offCKB.rpc;
 
-Check example at https://github.com/nervosnetwork/docs.nervos.org/tree/develop-v2/examples/create-dob
+Check example at https://github.com/nervosnetwork/docs.nervos.org/tree/develop/examples/simple-transfer
   `);
 }
 exports.injectConfig = injectConfig;

package/dist/cmd/sync-config.d.ts

@@ -0,0 +1 @@
+export declare function syncConfig(): void;

package/dist/cmd/{update-config.js → sync-config.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateConfig = void 0;
+exports.syncConfig = void 0;
 const const_1 = require("../cfg/const");
 const config_1 = require("../util/config");
 const type_1 = require("../util/type");
 const validator_1 = require("../util/validator");
-function updateConfig() {
+function syncConfig() {
     (0, validator_1.validateExecDappEnvironment)();
     // update the offckb.config.ts file in users workspace
     const devnetFullLumosConfig = (0, config_1.buildFullLumosConfig)(type_1.Network.devnet);
@@ -16,4 +16,4 @@ function updateConfig() {
     (0, config_1.updateScriptInfoInOffCKBConfigTs)(mainnetFullLumosConfig, const_1.userOffCKBConfigPath, type_1.Network.mainnet);
     console.log('offCKB config updated.');
 }
-exports.updateConfig = updateConfig;
+exports.syncConfig = syncConfig;

package/dist/util/config.d.ts

@@ -1,5 +1,6 @@
 import { config } from '@ckb-lumos/lumos';
 import { Network } from './type';
+export declare function updateOffCKBConfigVersion(filePath: string): void;
 export declare function updateScriptInfoInOffCKBConfigTs(newConfig: config.Config, filePath: string, network: Network): void;
 export declare function readUserDeployedScriptsInfo(network: Network): Record<string, config.ScriptConfig>;
 export declare function readPredefinedDevnetLumosConfig(): config.Config;

package/dist/util/config.js

@@ -23,12 +23,21 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildFullLumosConfig = exports.readPredefinedTestnetLumosConfig = exports.readPredefinedMainnetLumosConfig = exports.readPredefinedDevnetLumosConfig = exports.readUserDeployedScriptsInfo = exports.updateScriptInfoInOffCKBConfigTs = void 0;
+exports.buildFullLumosConfig = exports.readPredefinedTestnetLumosConfig = exports.readPredefinedMainnetLumosConfig = exports.readPredefinedDevnetLumosConfig = exports.readUserDeployedScriptsInfo = exports.updateScriptInfoInOffCKBConfigTs = exports.updateOffCKBConfigVersion = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const const_1 = require("../cfg/const");
 const lumos_1 = require("@ckb-lumos/lumos");
 const type_1 = require("./type");
+const version = require('../../package.json').version;
+function updateOffCKBConfigVersion(filePath) {
+    const versionTarget = 'update-me-offckb-config-version';
+    let fileContent = fs.readFileSync(filePath, 'utf-8');
+    fileContent = fileContent.replace(versionTarget, version);
+    // Write the updated content back to the file
+    fs.writeFileSync(filePath, fileContent, 'utf-8');
+}
+exports.updateOffCKBConfigVersion = updateOffCKBConfigVersion;
 function updateScriptInfoInOffCKBConfigTs(newConfig, filePath, network) {
     // Read the content of the offckb.config.ts file
     let fileContent = fs.readFileSync(filePath, 'utf-8');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offckb/cli",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "ckb development network for your first try",
   "author": "Retric Su <retric@cryptape.com>",
   "license": "MIT",

package/dist/cmd/update-config.d.ts

@@ -1 +0,0 @@
-export declare function updateConfig(): void;