@offckb/cli 0.2.6 → 0.3.0-canary-cfe9b48.0

package/README.md

@@ -14,7 +14,7 @@
 - built-in scripts like [Omnilock](https://github.com/cryptape/omnilock) and [Spore-contract](https://github.com/sporeprotocol/spore-contract)
 - multiple minimal dApp templates to learn and get your hands dirty
 
-Start building on Nervos blockchain, right now, right away!
+Start building on CKB blockchain, right now, right away!
 
 ## Table of Contents
 
@@ -25,9 +25,14 @@ Start building on Nervos blockchain, right now, right away!
 - [Get started](#get-started)
   - [Create a full-stack Project](#create-a-full-stack-project)
   - [Create a script-only Project](#create-a-script-only-project)
+- [Config Setting](#config-setting)
+  - [List All Settings](#list-all-settings)
+  - [Set CKB version](#set-ckb-version)
+  - [Set Network Proxy](#set-network-proxy)
 - [Built-in scripts](#built-in-scripts)
 - [Accounts](#accounts)
-- [About Lumos](#about-lumos)
+- [About CCC](#about-ccc)
+- [FAQ](#faq)
 - [Contributing](#contributing)
 
 ## Install
@@ -50,30 +55,27 @@ Options:
   -h, --help                                        display help for command
 
 Commands:
-  create [your-project-name]                        Create a new dApp from bare templates
-  node                                              Use the CKB to start devnet
+  create [options] [your-project-name]              Create a new dApp from bare templates
+  node [options] [CKB-Version]                      Use the CKB to start devnet
+  proxy-rpc [options]                               Start the rpc proxy server
   clean                                             Clean the devnet data, need to stop running the chain first
   accounts                                          Print account list info
-  list-hashes                                       Use the CKB to list blockchain scripts hashes
+  list-hashes [CKB-Version]                         Use the CKB to list blockchain scripts hashes
   inject-config                                     Add offckb.config.ts to your workspace
-  sync-config                                       sync 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
+  my-scripts [options]                              Show deployed contracts info on different networks, only supports devnet and testnet
+  config <action> [item] [value]                    do a configuration action
+  debug [options]                                   CKB Debugger for development
+  system-scripts [options]                          Output system scripts of the local devnet
   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
@@ -94,7 +96,38 @@ You can create a new script project without a frontend. This is useful when you
 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. 
+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.
+
+## Config Setting
+
+### List All Settings
+
+```sh
+offckb config list
+```
+
+### Set CKB version
+
+```sh
+offckb config get ckb-version
+> 0.113.0
+offckb config set ckb-version 0.117.0
+offckb config get ckb-version
+> 0.117.0
+```
+
+### Set Network Proxy
+
+```sh
+offckb config set proxy http://127.0.0.1:1086
+> save new settings
+offckb config get proxy
+> http://127.0.0.1:1086
+offckb config rm proxy
+> save new settings
+offckb config get proxy
+> No Proxy.
+```
 
 ## Built-in scripts
 
@@ -118,9 +151,18 @@ detail informations about each account are recorded in the `account/account.json
 
 :warning: **DO NOT SEND REAL ASSETS INTO ALL THESE ACCOUNTS, YOU CAN LOOSE YOUR MONEY** :warning:
 
-## About Lumos
+## About CCC
+
+`offckb` uses [CCC](https://github.com/ckb-ecofund/ccc) as the development framework to build the CKB dApp template projects.
 
-`offckb` uses [Lumos](https://github.com/ckb-js/lumos) as the CKB dApp framework to build the template projects.
+## FAQ
+
+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
+```
 
 ## Contributing
 

package/ckb/devnet/specs/dev.toml

@@ -38,10 +38,10 @@ capacity = 100_000_0000_0000
 file = { file = "sudt" }
 create_type_id = true
 [[genesis.system_cells]]
-file = { file = "xudt_rce" }
+file = { file = "xudt" }
 create_type_id = true
 [[genesis.system_cells]]
-file = { file = "omni_lock" }
+file = { file = "omnilock" }
 create_type_id = true
 [[genesis.system_cells]]
 file = { file = "anyone_can_pay" }
@@ -50,19 +50,19 @@ create_type_id = true
 file = { file = "always_success" }
 create_type_id = true
 [[genesis.system_cells]]
-file = { file = "spore-scripts/spore" }
+file = { file = "spore/spore" }
 create_type_id = false
 [[genesis.system_cells]]
-file = { file = "spore-scripts/cluster" }
+file = { file = "spore/spore_cluster" }
 create_type_id = false
 [[genesis.system_cells]]
-file = { file = "spore-scripts/cluster_agent" }
+file = { file = "spore/spore_cluster_agent" }
 create_type_id = false
 [[genesis.system_cells]]
-file = { file = "spore-scripts/cluster_proxy" }
+file = { file = "spore/spore_cluster_proxy" }
 create_type_id = false
 [[genesis.system_cells]]
-file = { file = "spore-scripts/spore_extension_lua" }
+file = { file = "spore/spore_extension_lua" }
 create_type_id = false
 
 [genesis.system_cells_lock]

package/dist/cfg/env-path.d.ts

@@ -0,0 +1,9 @@
+export default function envPaths(appName: string, { suffix }?: {
+    suffix?: string | undefined;
+}): {
+    data: string;
+    config: string;
+    cache: string;
+    log: string;
+    temp: string;
+};

package/dist/cfg/env-path.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// take and adapt from https://github.com/sindresorhus/env-paths/blob/main/index.js
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const process_1 = __importDefault(require("process"));
+const homedir = os_1.default.homedir();
+const tmpdir = os_1.default.tmpdir();
+const { env } = process_1.default;
+const macos = (appName) => {
+    const library = path_1.default.join(homedir, 'Library');
+    return {
+        data: path_1.default.join(library, 'Application Support', appName),
+        config: path_1.default.join(library, 'Preferences', appName),
+        cache: path_1.default.join(library, 'Caches', appName),
+        log: path_1.default.join(library, 'Logs', appName),
+        temp: path_1.default.join(tmpdir, appName),
+    };
+};
+const windows = (appName) => {
+    const appData = env.APPDATA || path_1.default.join(homedir, 'AppData', 'Roaming');
+    const localAppData = env.LOCALAPPDATA || path_1.default.join(homedir, 'AppData', 'Local');
+    return {
+        // Data/config/cache/log are invented by me as Windows isn't opinionated about this
+        data: path_1.default.join(localAppData, appName, 'Data'),
+        config: path_1.default.join(appData, appName, 'Config'),
+        cache: path_1.default.join(localAppData, appName, 'Cache'),
+        log: path_1.default.join(localAppData, appName, 'Log'),
+        temp: path_1.default.join(tmpdir, appName),
+    };
+};
+// https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
+const linux = (appName) => {
+    const username = path_1.default.basename(homedir);
+    return {
+        data: path_1.default.join(env.XDG_DATA_HOME || path_1.default.join(homedir, '.local', 'share'), appName),
+        config: path_1.default.join(env.XDG_CONFIG_HOME || path_1.default.join(homedir, '.config'), appName),
+        cache: path_1.default.join(env.XDG_CACHE_HOME || path_1.default.join(homedir, '.cache'), appName),
+        // https://wiki.debian.org/XDGBaseDirectorySpecification#state
+        log: path_1.default.join(env.XDG_STATE_HOME || path_1.default.join(homedir, '.local', 'state'), appName),
+        temp: path_1.default.join(tmpdir, username, appName),
+    };
+};
+function envPaths(appName, { suffix = 'nodejs' } = {}) {
+    if (typeof appName !== 'string') {
+        throw new TypeError(`Expected a string, got ${typeof appName}`);
+    }
+    if (suffix) {
+        // Add suffix to prevent possible conflict with native apps
+        appName += `-${suffix}`;
+    }
+    if (process_1.default.platform === 'darwin') {
+        return macos(appName);
+    }
+    if (process_1.default.platform === 'win32') {
+        return windows(appName);
+    }
+    return linux(appName);
+}
+exports.default = envPaths;

package/dist/cfg/setting.d.ts

@@ -0,0 +1,45 @@
+import { AxiosProxyConfig } from 'axios';
+export declare const configPath: string;
+export declare const dataPath: string;
+export declare const cachePath: string;
+export declare const packageSrcPath: string;
+export declare const packageRootPath: string;
+export interface Settings {
+    proxy?: AxiosProxyConfig;
+    rpc: {
+        proxyPort: number;
+    };
+    bins: {
+        rootFolder: string;
+        defaultCKBVersion: string;
+        downloadPath: string;
+    };
+    devnet: {
+        rpcUrl: string;
+        configPath: string;
+        dataPath: string;
+        debugFullTransactionsPath: string;
+        transactionsPath: string;
+        failedTransactionsPath: string;
+        contractsPath: string;
+    };
+    testnet: {
+        rpcUrl: string;
+        contractsPath: string;
+    };
+    mainnet: {
+        rpcUrl: string;
+        contractsPath: string;
+    };
+    dappTemplate: {
+        gitRepoUrl: string;
+        gitBranch: string;
+        gitFolder: string;
+        downloadPath: string;
+    };
+}
+export declare const defaultSettings: Settings;
+export declare function readSettings(): Settings;
+export declare function writeSettings(settings: Settings): void;
+export declare function getCKBBinaryInstallPath(version: string): string;
+export declare function getCKBBinaryPath(version: string): string;

package/dist/cfg/setting.js

@@ -0,0 +1,124 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCKBBinaryPath = exports.getCKBBinaryInstallPath = exports.writeSettings = exports.readSettings = exports.defaultSettings = exports.packageRootPath = exports.packageSrcPath = exports.cachePath = exports.dataPath = exports.configPath = void 0;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const env_path_1 = __importDefault(require("./env-path"));
+const paths = (0, env_path_1.default)('offckb');
+exports.configPath = path.join(paths.config, 'settings.json');
+exports.dataPath = paths.data;
+exports.cachePath = paths.cache;
+exports.packageSrcPath = path.dirname(require.main.filename);
+exports.packageRootPath = path.resolve(exports.packageSrcPath, '../');
+exports.defaultSettings = {
+    proxy: undefined,
+    rpc: {
+        proxyPort: 9000,
+    },
+    bins: {
+        rootFolder: path.resolve(exports.dataPath, 'bins'),
+        defaultCKBVersion: '0.113.1',
+        downloadPath: path.resolve(exports.cachePath, 'download'),
+    },
+    devnet: {
+        rpcUrl: 'http://localhost:8114',
+        // todo: maybe add a root folder for all devnet data
+        // so we can clean it easily
+        configPath: path.resolve(exports.dataPath, 'devnet'),
+        dataPath: path.resolve(exports.dataPath, 'devnet/data'),
+        debugFullTransactionsPath: path.resolve(exports.dataPath, 'devnet/full-transactions'),
+        transactionsPath: path.resolve(exports.dataPath, 'devnet/transactions'),
+        failedTransactionsPath: path.resolve(exports.dataPath, 'devnet/failed-transactions'),
+        contractsPath: path.resolve(exports.dataPath, 'devnet/contracts'),
+    },
+    testnet: {
+        rpcUrl: 'https://testnet.ckb.dev',
+        contractsPath: path.resolve(exports.dataPath, 'testnet/contracts'),
+    },
+    mainnet: {
+        rpcUrl: 'https://mainnet.ckb.dev',
+        contractsPath: path.resolve(exports.dataPath, 'mainnet/contracts'),
+    },
+    dappTemplate: {
+        gitRepoUrl: `https://github.com/ckb-ecofund/offckb`,
+        gitBranch: 'v0.3.x',
+        gitFolder: 'templates/v3',
+        downloadPath: path.resolve(exports.cachePath, 'download', 'dapp-template'),
+    },
+};
+function readSettings() {
+    try {
+        if (fs.existsSync(exports.configPath)) {
+            const data = fs.readFileSync(exports.configPath, 'utf8');
+            return deepMerge(exports.defaultSettings, JSON.parse(data));
+        }
+        else {
+            return exports.defaultSettings;
+        }
+    }
+    catch (error) {
+        console.error('Error reading settings:', error);
+        return exports.defaultSettings;
+    }
+}
+exports.readSettings = readSettings;
+function writeSettings(settings) {
+    try {
+        fs.mkdirSync(path.dirname(exports.configPath), { recursive: true });
+        fs.writeFileSync(exports.configPath, JSON.stringify(settings, null, 2));
+        console.log('save new settings');
+    }
+    catch (error) {
+        console.error('Error writing settings:', error);
+    }
+}
+exports.writeSettings = writeSettings;
+function getCKBBinaryInstallPath(version) {
+    const setting = readSettings();
+    return `${setting.bins.rootFolder}/${version}`;
+}
+exports.getCKBBinaryInstallPath = getCKBBinaryInstallPath;
+function getCKBBinaryPath(version) {
+    return `${getCKBBinaryInstallPath(version)}/ckb`;
+}
+exports.getCKBBinaryPath = getCKBBinaryPath;
+function deepMerge(target, source) {
+    for (const key in source) {
+        if (source[key] && typeof source[key] === 'object') {
+            if (!target[key]) {
+                target[key] = {};
+            }
+            deepMerge(target[key], source[key]);
+        }
+        else {
+            target[key] = source[key];
+        }
+    }
+    return target;
+}

package/dist/cli.js

@@ -11,12 +11,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
-const install_1 = require("./cmd/develop/install");
-const genkey_1 = require("./cmd/develop/genkey");
 const list_hashes_1 = require("./cmd/list-hashes");
 const node_1 = require("./cmd/node");
-const init_chain_1 = require("./cmd/develop/init-chain");
-const lumos_config_1 = require("./cmd/develop/lumos-config");
 const accounts_1 = require("./cmd/accounts");
 const clean_1 = require("./cmd/clean");
 const encoding_1 = require("./util/encoding");
@@ -26,9 +22,12 @@ const deploy_1 = require("./cmd/deploy");
 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 my_scripts_1 = require("./cmd/my-scripts");
+const config_1 = require("./cmd/config");
+const debug_1 = require("./cmd/debug");
+const system_scripts_1 = require("./cmd/system-scripts");
+const proxy_rpc_1 = require("./cmd/proxy-rpc");
 const version = require('../package.json').version;
 const description = require('../package.json').description;
 // fix windows terminal encoding of simplified chinese text
@@ -47,10 +46,29 @@ program
     const template = yield (0, create_1.selectBareTemplate)();
     return (0, create_1.create)(name, template);
 }));
-program.command('node').description('Use the CKB to start devnet').action(node_1.node);
+program
+    .command('node [CKB-Version]')
+    .description('Use the CKB to start devnet')
+    .option('--no-proxy', 'Do not start the rpc proxy server', true)
+    .action((version, options) => __awaiter(void 0, void 0, void 0, function* () {
+    // commander.js change our noProxy option to proxy
+    return (0, node_1.node)({ version, noProxyServer: !options.proxy });
+}));
+program
+    .command('proxy-rpc')
+    .description('Start the rpc proxy server')
+    .option('--ckb-rpc <ckbRpc>', 'Specify the ckb rpc address')
+    .option('--port <port>', 'Specify the port to start the proxy server')
+    .option('--network <network>', 'Specify the network to proxy')
+    .action((options) => {
+    return (0, proxy_rpc_1.proxyRpc)(options);
+});
 program.command('clean').description('Clean the devnet data, need to stop running the chain first').action(clean_1.clean);
 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('list-hashes [CKB-Version]')
+    .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('sync-config').description('Sync offckb.config.ts in your workspace').action(sync_config_1.syncConfig);
 program
@@ -83,30 +101,36 @@ program
     .option('--privkey <privkey>', 'Specify the private key to deploy scripts')
     .action((options) => (0, deploy_1.deploy)(options));
 program
-    .command('deployed-scripts')
+    .command('my-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
-    program.command('install').description('Install the ckb dependency binary').action(install_1.installDependency);
-    program.command('genkey').description('Generate 20 accounts').action(genkey_1.genkey);
-    program.command('init-chain').description('Use the CKB to init devnet').action(init_chain_1.initChainIfNeeded);
-    program
-        .command('build-devnet-lumos-config')
-        .description('Use the CKB to generate predefined devnet lumos config.json')
-        .action(lumos_config_1.writePredefinedDevnetLumosConfig);
-    program.command('build-accounts').description('Generate accounts with prefunded CKB tokens').action(genkey_1.buildAccounts);
-    program
-        .command('print-account-issue-info')
-        .description('Print account issue cells config toml sections')
-        .action(genkey_1.printIssueSectionForToml);
-    program
-        .command('build-account [privateKey]')
-        .description('Print standard account info from a privatekey')
-        .action(build_account_1.buildAccount);
-}
+    .action((options) => (0, my_scripts_1.printMyScripts)(options));
+program
+    .command('config <action> [item] [value]')
+    .description('do a configuration action')
+    .action((action, item, value) => (0, config_1.Config)(action, item, value));
+program
+    .command('debug')
+    .requiredOption('--tx-hash <txHash>', 'Specify the transaction hash to debug with')
+    .option('--single-script <singleScript>', 'Specify the cell script to debug with')
+    .option('--bin <bin>', 'Specify a binary to replace the script to debug with')
+    .description('CKB Debugger for development')
+    .action((option) => __awaiter(void 0, void 0, void 0, function* () {
+    const txHash = option.txHash;
+    if (option.singleScript) {
+        const { cellType, cellIndex, scriptType } = (0, debug_1.parseSingleScriptOption)(option.singleScript);
+        return (0, debug_1.debugSingleScript)(txHash, cellIndex, cellType, scriptType, option.bin);
+    }
+    return (0, debug_1.debugTransaction)(txHash);
+}));
+program
+    .command('system-scripts')
+    .option('--export-style <exportStyle>', 'Specify the export format, possible values are lumos and ccc.')
+    .description('Output system scripts of the local devnet')
+    .action((option) => __awaiter(void 0, void 0, void 0, function* () {
+    const exportStyle = option.exportStyle;
+    return (0, system_scripts_1.printSystemScripts)(exportStyle);
+}));
 program.parse(process.argv);
 // If no command is specified, display help
 if (!process.argv.slice(2).length) {

package/dist/cmd/clean.js

@@ -4,15 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clean = void 0;
-const const_1 = require("../cfg/const");
 const fs_1 = __importDefault(require("fs"));
 const fs_2 = require("../util/fs");
+const setting_1 = require("../cfg/setting");
 function clean() {
-    if ((0, fs_2.isFolderExists)(const_1.devnetDataPath)) {
+    const settings = (0, setting_1.readSettings)();
+    const allDevnetDataPath = settings.devnet.configPath;
+    // this is the root folder of devnet, it contains config, data, debugFullTransactions, transactions, failed-transactions, contracts
+    if ((0, fs_2.isFolderExists)(allDevnetDataPath)) {
         try {
-            fs_1.default.rmSync(const_1.devnetDataPath, { recursive: true });
+            fs_1.default.rmSync(allDevnetDataPath, { recursive: true });
             console.log(`Chain data cleaned.`);
-            // todo: rm deploy info too
         }
         catch (error) {
             console.log(`Did you stop running the chain first?`);
@@ -20,7 +22,7 @@ function clean() {
         }
     }
     else {
-        console.log(`${const_1.devnetDataPath} not found, unable to clean it.`);
+        console.log(`${allDevnetDataPath} not found, unable to clean it.`);
     }
 }
 exports.clean = clean;

package/dist/cmd/config.d.ts

@@ -0,0 +1,11 @@
+export declare enum ConfigAction {
+    list = "list",
+    get = "get",
+    set = "set",
+    rm = "rm"
+}
+export declare enum ConfigItem {
+    proxy = "proxy",
+    ckbVersion = "ckb-version"
+}
+export declare function Config(action: ConfigAction, item: ConfigItem, value?: string): Promise<void>;