@offckb/cli 0.2.1 → 0.2.3

package/README.md

@@ -23,15 +23,8 @@ 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) 
-  - [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)
-- [dApp Examples with Detailed Tutorial](#dapp-examples-with-detailed-tutorial)
-  - [View and transfer balance](#view-and-transfer-balance)
-  - [Write \& read on-chain messages](#write--read-on-chain-messages)
-  - [Issue custom token via xUDT scripts](#issue-custom-token-via-xudt-scripts)
-  - [Create on-chain digital object via Spore protocol](#create-on-chain-digital-object-via-spore-protocol)
+  - [Create a full-stack Project](#create-a-full-stack-project)
+  - [Create a script-only Project](#create-a-script-only-project)
 - [Built-in scripts](#built-in-scripts)
 - [Accounts](#accounts)
 - [About Lumos](#about-lumos)
@@ -57,14 +50,13 @@ Options:
   -h, --help                                        display help for command
 
 Commands:
-  init [your-project-name]                          Init a example dApp to learn and run
   create [your-project-name]                        Create a new dApp from bare templates
   node                                              Use the CKB to start devnet
   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
   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
@@ -75,9 +67,16 @@ Commands:
 
 *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 full-stack Project
 
 Create a new project from predefined boilerplates.
 
@@ -97,117 +96,6 @@ 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
-
-### Step 1: Select A dApp To Init
-
-```sh
-offckb init <your-project-name, eg:my-awesome-ckb-dapp>
-
-## Select an example dApp
-? Select a dapp template (Use arrow keys)
-❯ Transfer CKB
-  Issue Coin With XUDT scripts
-a simple dapp to check CKB balance and transfer CKB from address to address
-init CKB dapp project: /Users/ckb/Desktop/offckb/my-awesome-ckb-dapp
-✨  Done in 7.52s.
-
-## start running
-cd my-awesome-ckb-dapp
-yarn && yarn start
-
-## results
-yarn run v1.22.19
-$ parcel index.html
-Server running at http://localhost:1234
-✨ Built in 10ms
-```
-
-### Step 2: Start the Devnet
-
-Open another terminal and run:
-
-```sh
-offckb node
-
-# result
-# ...
-CKB-Miner: 2024-03-04 14:35:12.563 +00:00 client INFO ckb_miner::miner  Found! #3181 0x3749481a320824fe21077eaa8ec9d024a7b62d031720c27c1ef1681e8ab349e8
-
-CKB-Miner: 2024-03-04 14:35:17.567 +00:00 client INFO ckb_miner::miner  Found! #3184 0xa612a9ea35f292a6473e23e88856283aea8b1bc6a607147bef5c06c94e964f2f
-#...
-```
-
-You can leave this terminal open to keep the devnet running, feel free to `ctrl+c` to exit the terminal and stop the local blockchain.
-
-### Step 3: Access Pre-funded Accounts
-
-Open another terminal and check the accounts to use:
-
-```sh
-offckb accounts
-
-# results
-
-#### ALL ACCOUNTS ARE FOR TEST AND DEVELOP ONLY  ####
-#### DON'T USE THESE ACCOUNTS ON MAINNET         ####
-#### OTHERWISE YOU WILL LOOSE YOUR MONEY         ####
-
-Print account list, each account is funded with 42_000_000_00000000 capacity in the devnet genesis block.
-
-- "#": 0
-address: ckt1qzda0cr08m85hc8jlnfp3zer7xulejywt49kt2rr0vthywaa50xwsqvwg2cen8extgq8s5puft8vf40px3f599cytcyd8
-privkey: 0x6109170b275a09ad54877b82f7d9930f88cab5717d484fb4741ae9d1dd078cd6
-pubkey: 0x02025fa7b61b2365aa459807b84df065f1949d58c0ae590ff22dd2595157bffefa
-lock_arg: 0x8e42b1999f265a0078503c4acec4d5e134534297
-lockScript:
-    codeHash: 0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8
-    hashType: type
-    args: 0x8e42b1999f265a0078503c4acec4d5e134534297
-
-- "#": 1
-address: ckt1qzda0cr08m85hc8jlnfp3zer7xulejywt49kt2rr0vthywaa50xwsqt435c3epyrupszm7khk6weq5lrlyt52lg48ucew
-privkey: 0x9f315d5a9618a39fdc487c7a67a8581d40b045bd7a42d83648ca80ef3b2cb4a1
-pubkey: 0x026efa0579f09cc7c1129b78544f70098c90b2ab155c10746316f945829c034a2d
-lock_arg: 0x758d311c8483e0602dfad7b69d9053e3f917457d
-lockScript:
-    codeHash: 0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8
-    hashType: type
-    args: 0x758d311c8483e0602dfad7b69d9053e3f917457d
-```
-
-Copy some private keys and visit http://localhost:1234 to play your first CKB dApp!
-
-## dApp Examples with Detailed Tutorial
-
-`offckb` packs some basic minimal dApp examples for you to learn and get started with. By running `offckb init`, you can select the different dApp examples to quickly set up a local dApp project targeting the local blockchain with built-in scripts and accounts.
-
-The dApp examples often involve interaction with some most useful smart contracts on CKB like xUDT/Spore/Omnilock. The best thing is those dApp examples also come with detailed tutorial documents from [docs.nervos.org](https://docs.nervos.org/). The source codes of these templates are also maintained [here](https://github.com/nervosnetwork/docs.nervos.org/tree/develop-v2/examples).
-
-### View and transfer balance
-
-A simple dApp to check CKB balance and transfer CKB.
-
-[Tutorial](https://docs.nervos.org/docs/getting-started/transfer-ckb)
-
-### Write & read on-chain messages
-
-A simple dApp to issue your own token via XUDT scripts.
-
-[Tutorial](https://docs.nervos.org/docs/getting-started/write-message)
-
-### Issue custom token via xUDT scripts
-
-A simple dApp to store & retrieve data from a Cell.
-
-[Tutorial](https://docs.nervos.org/docs/getting-started/create-token)
-
-### Create on-chain digital object via Spore protocol
-
-A simple dApp to create on-chain digital objects with spore scripts.
-
-[Tutorial](https://docs.nervos.org/docs/getting-started/create-dob)
-
 ## Built-in scripts
 
 - [x] xUDT https://github.com/nervosnetwork/rfcs/pull/428

package/dist/cfg/const.d.ts

@@ -14,9 +14,8 @@ export declare const deployedContractInfoFolderPath: string;
 export declare const accountTargetDir: string;
 export declare const minimalRequiredCKBVersion = "0.113.1";
 export declare const defaultLumosVersion = "0.21.0";
-export declare const dappTemplateGitRepoUserAndName = "nervosnetwork/docs.nervos.org";
-export declare const dappTemplateGitUrl = "https://github.com/nervosnetwork/docs.nervos.org";
+export declare const dappTemplateGitRepoUserAndName = "RetricSu/offckb";
+export declare const dappTemplateGitUrl = "https://github.com/RetricSu/offckb";
 export declare const dappTemplateGitBranch = "develop";
-export declare const dappTemplateGitFolder = "examples";
-export declare const dappTemplateGitSelectOptionFile = "options.json";
+export declare const dappTemplateGitFolder = "templates";
 export declare const bareTemplateGitSelectOptionFile = "template.json";

package/dist/cfg/const.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bareTemplateGitSelectOptionFile = exports.dappTemplateGitSelectOptionFile = exports.dappTemplateGitFolder = exports.dappTemplateGitBranch = exports.dappTemplateGitUrl = exports.dappTemplateGitRepoUserAndName = exports.defaultLumosVersion = exports.minimalRequiredCKBVersion = exports.accountTargetDir = exports.deployedContractInfoFolderPath = exports.ckbBinPath = exports.ckbFolderPath = exports.devnetDataPath = exports.devnetPath = exports.devnetSourcePath = exports.userOffCKBConfigPath = exports.predefinedOffCKBConfigTsPath = exports.targetEnvironmentPath = exports.dappTemplatePath = exports.packageRootPath = exports.packageSrcPath = exports.currentExecPath = void 0;
+exports.bareTemplateGitSelectOptionFile = exports.dappTemplateGitFolder = exports.dappTemplateGitBranch = exports.dappTemplateGitUrl = exports.dappTemplateGitRepoUserAndName = exports.defaultLumosVersion = exports.minimalRequiredCKBVersion = exports.accountTargetDir = exports.deployedContractInfoFolderPath = exports.ckbBinPath = exports.ckbFolderPath = exports.devnetDataPath = exports.devnetPath = exports.devnetSourcePath = exports.userOffCKBConfigPath = exports.predefinedOffCKBConfigTsPath = exports.targetEnvironmentPath = exports.dappTemplatePath = exports.packageRootPath = exports.packageSrcPath = exports.currentExecPath = void 0;
 const path = __importStar(require("path"));
 // path
 exports.currentExecPath = process.cwd();
@@ -44,9 +44,8 @@ exports.accountTargetDir = path.join(exports.packageRootPath, `account`);
 exports.minimalRequiredCKBVersion = '0.113.1';
 exports.defaultLumosVersion = '0.21.0';
 // url
-exports.dappTemplateGitRepoUserAndName = 'nervosnetwork/docs.nervos.org';
+exports.dappTemplateGitRepoUserAndName = 'RetricSu/offckb';
 exports.dappTemplateGitUrl = `https://github.com/${exports.dappTemplateGitRepoUserAndName}`;
 exports.dappTemplateGitBranch = 'develop';
-exports.dappTemplateGitFolder = 'examples';
-exports.dappTemplateGitSelectOptionFile = 'options.json';
+exports.dappTemplateGitFolder = 'templates';
 exports.bareTemplateGitSelectOptionFile = 'template.json';

package/dist/cli.js

@@ -17,14 +17,13 @@ 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 init_1 = require("./cmd/init");
 const accounts_1 = require("./cmd/accounts");
 const clean_1 = require("./cmd/clean");
 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");
@@ -36,14 +35,6 @@ const description = require('../package.json').description;
 (0, encoding_1.setUTF8EncodingForWindows)();
 const program = new commander_1.Command();
 program.name('offckb').description(description).version(version);
-program
-    .command('init [your-project-name]')
-    .description('Init a example dApp to learn and run')
-    .action((projectName) => __awaiter(void 0, void 0, void 0, function* () {
-    const name = projectName !== null && projectName !== void 0 ? projectName : 'my-awesome-ckb-dapp';
-    const template = yield (0, init_1.selectTemplate)();
-    return (0, init_1.init)(name, template);
-}));
 program
     .command('create [your-project-name]')
     .description('Create a new dApp from bare templates')
@@ -61,7 +52,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')

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/dist/util/template.d.ts

@@ -1,9 +1,3 @@
-export interface TutorialOption {
-    name: string;
-    value: string;
-    description: string;
-}
-export declare function loadTutorialOpts(): Promise<Array<TutorialOption>>;
 export interface BareTemplateOption {
     name: string;
     value: string;

package/dist/util/template.js

@@ -12,22 +12,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadBareTemplateOpts = exports.loadTutorialOpts = void 0;
+exports.loadBareTemplateOpts = void 0;
 const axios_1 = __importDefault(require("axios"));
 const const_1 = require("../cfg/const");
-function loadTutorialOpts() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const githubUrl = `https://raw.githubusercontent.com/${const_1.dappTemplateGitRepoUserAndName}/${const_1.dappTemplateGitBranch}/${const_1.dappTemplateGitFolder}/${const_1.dappTemplateGitSelectOptionFile}`;
-        try {
-            const response = yield axios_1.default.get(githubUrl);
-            return response.data;
-        }
-        catch (error) {
-            throw new Error(`Error fetching JSON: ${error.message}`);
-        }
-    });
-}
-exports.loadTutorialOpts = loadTutorialOpts;
 function loadBareTemplateOpts() {
     return __awaiter(this, void 0, void 0, function* () {
         const githubUrl = `https://raw.githubusercontent.com/${const_1.dappTemplateGitRepoUserAndName}/${const_1.dappTemplateGitBranch}/${const_1.dappTemplateGitFolder}/${const_1.bareTemplateGitSelectOptionFile}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offckb/cli",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "ckb development network for your first try",
   "author": "Retric Su <retric@cryptape.com>",
   "license": "MIT",
@@ -16,7 +16,8 @@
     "dist",
     "account",
     "ckb",
-    "templates"
+    "templates/config.json",
+    "templates/offckb.config.ts"
   ],
   "private": false,
   "publishConfig": {

package/dist/cmd/init.d.ts

@@ -1,3 +0,0 @@
-import { TutorialOption } from '../util/template';
-export declare function init(name: string, template: TutorialOption): void;
-export declare function selectTemplate(): Promise<TutorialOption>;

package/dist/cmd/init.js

@@ -1,50 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.selectTemplate = exports.init = void 0;
-const const_1 = require("../cfg/const");
-const path_1 = __importDefault(require("path"));
-const select_1 = __importDefault(require("@inquirer/select"));
-const template_1 = require("../util/template");
-const fs_1 = require("../util/fs");
-const git_1 = require("../util/git");
-function init(name, template) {
-    const targetPath = path_1.default.resolve(const_1.currentExecPath, name);
-    const dappTemplateFolderPath = `${const_1.dappTemplateGitFolder}/${template.value}`;
-    (0, git_1.gitCloneAndDownloadFolderSync)(const_1.dappTemplateGitUrl, const_1.dappTemplateGitBranch, dappTemplateFolderPath, targetPath);
-    // add some common code files
-    const ckbDotTs = path_1.default.resolve(const_1.dappTemplatePath, 'ckb.ts');
-    const configJson = path_1.default.resolve(const_1.dappTemplatePath, 'config.json');
-    (0, fs_1.copyFileSync)(ckbDotTs, targetPath);
-    (0, fs_1.copyFileSync)(configJson, targetPath);
-    console.log(`init CKB dapp project: ${targetPath}`);
-}
-exports.init = init;
-function selectTemplate() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const opts = yield (0, template_1.loadTutorialOpts)();
-        const answer = yield (0, select_1.default)({
-            message: 'Select an example dApp',
-            choices: opts.map((opt) => {
-                return {
-                    name: opt.name,
-                    value: opt.value,
-                    description: opt.description,
-                };
-            }),
-        });
-        return opts.find((opt) => opt.value === answer);
-    });
-}
-exports.selectTemplate = selectTemplate;

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

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

package/templates/ckb.ts

@@ -1,11 +0,0 @@
-import { Indexer, RPC, config } from '@ckb-lumos/lumos';
-import devConfig from './config.json';
-
-export const lumosConfig: config.Config = devConfig as config.Config;
-//export const lumosConfig: config.Config = config.predefined.AGGRON4;
-
-export const CKB_RPC_URL = 'http://localhost:8114';
-//export const CKB_RPC_URL = "https://testnet.ckb.dev/rpc";
-
-export const rpc = new RPC(CKB_RPC_URL);
-export const indexer = new Indexer(CKB_RPC_URL);