@offckb/cli 0.1.1 → 0.1.2-canary-a369f24.0

package/dist/util/git.js

@@ -0,0 +1,85 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gitCloneAndDownloadFolderSync = exports.isGitInstalled = void 0;
+const child_process_1 = require("child_process");
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const const_1 = require("../cfg/const");
+const fs_1 = require("./fs");
+function isGitInstalled() {
+    try {
+        (0, child_process_1.execSync)('git --version');
+        return true;
+    }
+    catch (error) {
+        return false;
+    }
+}
+exports.isGitInstalled = isGitInstalled;
+function gitCloneAndDownloadFolderSync(repoUrl, branch, subFolderName, targetPath) {
+    console.log('start cloning the dapp template..');
+    const tempFolder = path.resolve(const_1.dappTemplatePath, 'temp-clone-folder');
+    if (!isGitInstalled()) {
+        console.log('Git is not installed, please check https://git-scm.com/');
+        return process.exit(1);
+    }
+    // Empty the temp folder if it exists
+    if (fs.existsSync(tempFolder)) {
+        fs.rmSync(tempFolder, { recursive: true });
+    }
+    // Create the temp folder
+    fs.mkdirSync(tempFolder, { recursive: true });
+    // Clone the repository
+    try {
+        const cloneCommand = `git clone -n --depth=1 --single-branch --branch ${branch} --filter=tree:0 ${repoUrl} ${tempFolder}`;
+        (0, child_process_1.execSync)(cloneCommand);
+    }
+    catch (error) {
+        console.error('Error:', error);
+        process.exit(1);
+    }
+    // checkout the examples sub folder
+    try {
+        (0, child_process_1.execSync)(`git sparse-checkout set ${subFolderName}`, { cwd: tempFolder });
+        (0, child_process_1.execSync)(`git checkout`, { cwd: tempFolder });
+    }
+    catch (error) {
+        console.error('Error:', error);
+        process.exit(1);
+    }
+    // Ensure targetPath exists and is a directory
+    if (!fs.existsSync(targetPath) || !fs.statSync(targetPath).isDirectory()) {
+        fs.mkdirSync(targetPath, { recursive: true });
+    }
+    const source = path.resolve(tempFolder, subFolderName);
+    (0, fs_1.copyFolderSync)(source, targetPath);
+    // Empty the temp folder if it exists
+    if (fs.existsSync(tempFolder)) {
+        fs.rmSync(tempFolder, { recursive: true });
+    }
+    console.log(`Folder ${subFolderName} downloaded successfully from ${repoUrl} and moved to ${targetPath}`);
+}
+exports.gitCloneAndDownloadFolderSync = gitCloneAndDownloadFolderSync;

package/dist/util/link.d.ts

@@ -0,0 +1 @@
+export declare function buildTestnetTxLink(txHash: string): string;

package/dist/util/link.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildTestnetTxLink = void 0;
+function buildTestnetTxLink(txHash) {
+    return `https://pudge.explorer.nervos.org/transaction/${txHash}`;
+}
+exports.buildTestnetTxLink = buildTestnetTxLink;

package/dist/util/template.d.ts

@@ -0,0 +1,14 @@
+export interface TutorialOption {
+    name: string;
+    value: string;
+    description: string;
+}
+export declare function loadTutorialOpts(): Promise<Array<TutorialOption>>;
+export interface BareTemplateOption {
+    name: string;
+    value: string;
+    description: string;
+    tag: string[];
+    author: string;
+}
+export declare function loadBareTemplateOpts(): Promise<Array<BareTemplateOption>>;

package/dist/util/template.js

@@ -0,0 +1,43 @@
+"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.loadBareTemplateOpts = exports.loadTutorialOpts = 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}`;
+        try {
+            const response = yield axios_1.default.get(githubUrl);
+            return response.data;
+        }
+        catch (error) {
+            throw new Error(`Error fetching JSON: ${error.message}`);
+        }
+    });
+}
+exports.loadBareTemplateOpts = loadBareTemplateOpts;

package/dist/util/type.d.ts

@@ -0,0 +1,8 @@
+export declare enum Network {
+    devnet = "devnet",
+    testnet = "testnet",
+    mainnet = "mainnet"
+}
+export interface NetworkOption {
+    network: Network;
+}

package/dist/util/type.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Network = void 0;
+// network
+var Network;
+(function (Network) {
+    Network["devnet"] = "devnet";
+    Network["testnet"] = "testnet";
+    Network["mainnet"] = "mainnet";
+})(Network || (exports.Network = Network = {}));

package/dist/util/validator.d.ts

@@ -0,0 +1,4 @@
+export declare function validateTypescriptWorkspace(): void;
+export declare function validateExecDappEnvironment(): void;
+export declare function isValidNetworkString(network: string): boolean;
+export declare function validateNetworkOpt(network: string): void;

package/dist/util/validator.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateNetworkOpt = exports.isValidNetworkString = exports.validateExecDappEnvironment = exports.validateTypescriptWorkspace = void 0;
+const path_1 = __importDefault(require("path"));
+const const_1 = require("../cfg/const");
+const fs_1 = __importDefault(require("fs"));
+const type_1 = require("./type");
+function validateTypescriptWorkspace() {
+    const cwd = const_1.currentExecPath;
+    // Check if package.json exists
+    const packageJsonPath = path_1.default.join(cwd, 'package.json');
+    if (!fs_1.default.existsSync(packageJsonPath)) {
+        throw new Error('package.json not found in the current directory');
+    }
+    // Check if tsconfig.json exists
+    const tsconfig = path_1.default.join(cwd, 'tsconfig.json');
+    if (!fs_1.default.existsSync(tsconfig)) {
+        throw new Error('tsconfig.json not found in the current directory');
+    }
+}
+exports.validateTypescriptWorkspace = validateTypescriptWorkspace;
+function validateExecDappEnvironment() {
+    const cwd = const_1.currentExecPath;
+    // Check if package.json and tsconfig.json exists
+    validateTypescriptWorkspace();
+    // Check if offckb.config.ts exists
+    const offCKBConfigPath = path_1.default.resolve(cwd, 'offckb.config.ts');
+    if (!fs_1.default.existsSync(offCKBConfigPath)) {
+        throw new Error('offckb.config.ts not found in the current directory');
+    }
+    // Read offckb.config.ts file
+    const offCKBConfigFile = fs_1.default.readFileSync(offCKBConfigPath, 'utf-8');
+    // Check if offckb.config.ts contains OffCKBConfig interface
+    if (!offCKBConfigFile.includes('export interface OffCKBConfig')) {
+        throw new Error('offckb.config.ts does not contain OffCKBConfig interface');
+    }
+    // Check if OffCKBConfig is exported
+    if (!offCKBConfigFile.includes('export default offCKBConfig;')) {
+        throw new Error('OffCKBConfig interface is not exported in offckb.config.ts');
+    }
+}
+exports.validateExecDappEnvironment = validateExecDappEnvironment;
+function isValidNetworkString(network) {
+    return ['devnet', 'testnet', 'mainnet'].includes(network);
+}
+exports.isValidNetworkString = isValidNetworkString;
+function validateNetworkOpt(network) {
+    if (!isValidNetworkString(network)) {
+        throw new Error('invalid network option, ' + network);
+    }
+    if (network === type_1.Network.mainnet) {
+        console.log('Mainnet not support yet. Please use CKB-CLI to operate on mainnet for better security. Check https://github.com/nervosnetwork/ckb-cli');
+        process.exit(1);
+    }
+}
+exports.validateNetworkOpt = validateNetworkOpt;

package/package.json

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

package/templates/offckb.config.ts

@@ -0,0 +1,193 @@
+import { Indexer, RPC, config } from '@ckb-lumos/lumos';
+
+export interface NetworkConfig {
+  lumosConfig: config.Config;
+  rpc_url: string;
+  rpc: RPC;
+  indexer: Indexer;
+}
+
+export interface OffCKBConfig {
+  version: string;
+  lumosVersion: string;
+  contractBinFolder: string;
+  network: {
+    devnet: NetworkConfig;
+    testnet: NetworkConfig;
+    mainnet: NetworkConfig;
+  };
+  initializeLumosConfig: () => void;
+  readonly rpc: RPC;
+  readonly indexer: Indexer;
+  readonly lumosConfig: config.Config;
+}
+
+function readEnvNetwork(): 'devnet' | 'testnet' | 'mainnet' {
+  // you may need to update the env method
+  // according to your frontend framework
+  const network = process.env.NETWORK;
+  const defaultNetwork = 'devnet';
+  if (!network) return defaultNetwork;
+
+  if (!['devnet', 'testnet', 'mainnet'].includes(network)) {
+    return defaultNetwork;
+  }
+
+  return network as 'devnet' | 'testnet' | 'mainnet';
+}
+
+// please do not alter the following structure
+// we use it as a check point in offCKB
+// ---devnet lumos config---
+const lumosConfig: config.Config = {
+  PREFIX: 'ckt',
+  SCRIPTS: {
+    SECP256K1_BLAKE160: {
+      CODE_HASH: '0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8',
+      HASH_TYPE: 'type',
+      TX_HASH: '0x75be96e1871693f030db27ddae47890a28ab180e88e36ebb3575d9f1377d3da7',
+      INDEX: '0x0',
+      DEP_TYPE: 'depGroup',
+      SHORT_ID: 1,
+    },
+    SECP256K1_BLAKE160_MULTISIG: {
+      CODE_HASH: '0x5c5069eb0857efc65e1bca0c07df34c31663b3622fd3876c876320fc9634e2a8',
+      HASH_TYPE: 'type',
+      TX_HASH: '0x75be96e1871693f030db27ddae47890a28ab180e88e36ebb3575d9f1377d3da7',
+      INDEX: '0x1',
+      DEP_TYPE: 'depGroup',
+    },
+    DAO: {
+      CODE_HASH: '0x82d76d1b75fe2fd9a27dfbaa65a039221a380d76c926f378d3f81cf3e7e13f2e',
+      HASH_TYPE: 'type',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0x2',
+      DEP_TYPE: 'code',
+      SHORT_ID: 2,
+    },
+    SUDT: {
+      CODE_HASH: '0x6283a479a3cf5d4276cd93594de9f1827ab9b55c7b05b3d28e4c2e0a696cfefd',
+      HASH_TYPE: 'type',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0x5',
+      DEP_TYPE: 'code',
+    },
+    XUDT: {
+      CODE_HASH: '0x1a1e4fef34f5982906f745b048fe7b1089647e82346074e0f32c2ece26cf6b1e',
+      HASH_TYPE: 'type',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0x6',
+      DEP_TYPE: 'code',
+    },
+    OMNILOCK: {
+      CODE_HASH: '0x9c6933d977360f115a3e9cd5a2e0e475853681b80d775d93ad0f8969da343e56',
+      HASH_TYPE: 'type',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0x7',
+      DEP_TYPE: 'code',
+    },
+    ANYONE_CAN_PAY: {
+      CODE_HASH: '0xe09352af0066f3162287763ce4ddba9af6bfaeab198dc7ab37f8c71c9e68bb5b',
+      HASH_TYPE: 'type',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0x8',
+      DEP_TYPE: 'code',
+    },
+    ALWAYS_SUCCESS: {
+      CODE_HASH: '0xbb4469004225b39e983929db71fe2253cba1d49a76223e9e1d212cdca1f79f28',
+      HASH_TYPE: 'type',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0x9',
+      DEP_TYPE: 'code',
+    },
+    SPORE: {
+      CODE_HASH: '0x7e8bf78a62232caa2f5d47e691e8db1a90d05e93dc6828ad3cb935c01ec6d208',
+      HASH_TYPE: 'data1',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0xa',
+      DEP_TYPE: 'code',
+    },
+    SPORE_CLUSTER: {
+      CODE_HASH: '0x7366a61534fa7c7e6225ecc0d828ea3b5366adec2b58206f2ee84995fe030075',
+      HASH_TYPE: 'data1',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0xb',
+      DEP_TYPE: 'code',
+    },
+    SPORE_CLUSTER_AGENT: {
+      CODE_HASH: '0xc986099b41d79ca1b2a56ce5874bcda8175440a17298ea5e2bbc3897736b8c21',
+      HASH_TYPE: 'data1',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0xc',
+      DEP_TYPE: 'code',
+    },
+    SPORE_CLUSTER_PROXY: {
+      CODE_HASH: '0xbe8b9ce3d05a32c4bb26fe71cd5fc1407ce91e3a8b9e8719be2ab072cef1454b',
+      HASH_TYPE: 'data1',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0xd',
+      DEP_TYPE: 'code',
+    },
+    SPORE_LUA: {
+      CODE_HASH: '0x94a9b875911ace20f1f0d063a26495d14e4b04e32fd218261bb747f34e71ae47',
+      HASH_TYPE: 'data1',
+      TX_HASH: '0x1dbed8dcfe0f18359c65c5e9546fd15cd69de73ea0a502345be30180649c9467',
+      INDEX: '0xe',
+      DEP_TYPE: 'code',
+    },
+  },
+} as config.Config;
+// ---end of devnet lumos config---
+// ---testnet lumos config---
+const testnetLumosConfig: config.Config = { ...config.predefined.AGGRON4, ...{} } as config.Config;
+// ---end of testnet lumos config---
+// ---mainnet lumos config---
+const mainnetLumosConfig: config.Config = { ...config.predefined.LINA, ...{} } as config.Config;
+// ---end of mainnet lumos config---
+
+const offCKBConfig: OffCKBConfig = {
+  version: 'update-me-offckb-config-version',
+  lumosVersion: '0.21.0',
+  contractBinFolder: '../../build/release',
+  network: {
+    devnet: {
+      lumosConfig,
+      rpc_url: 'http://127.0.0.1:8114',
+      rpc: new RPC('http://127.0.0.1:8114'),
+      indexer: new Indexer('http://127.0.0.1:8114'),
+    },
+    testnet: {
+      lumosConfig: testnetLumosConfig,
+      rpc_url: 'https://testnet.ckb.dev/rpc',
+      rpc: new RPC('https://testnet.ckb.dev/rpc'),
+      indexer: new Indexer('https://testnet.ckb.dev/rpc'),
+    },
+    mainnet: {
+      lumosConfig: mainnetLumosConfig,
+      rpc_url: 'https://mainnet.ckb.dev/rpc',
+      rpc: new RPC('https://mainnet.ckb.dev/rpc'),
+      indexer: new Indexer('https://mainnet.ckb.dev/rpc'),
+    },
+  },
+  initializeLumosConfig: () => {
+    const network = readEnvNetwork();
+    const lumosConfig = offCKBConfig.network[network].lumosConfig;
+    return config.initializeConfig(lumosConfig);
+  },
+  get rpc() {
+    const network = readEnvNetwork();
+    return offCKBConfig.network[network].rpc;
+  },
+
+  get indexer() {
+    const network = readEnvNetwork();
+    return offCKBConfig.network[network].indexer;
+  },
+
+  get lumosConfig() {
+    const network = readEnvNetwork();
+    return offCKBConfig.network[network].lumosConfig;
+  },
+};
+
+export default offCKBConfig;

package/dist/cmd/build-lumos-config.d.ts

@@ -1,99 +0,0 @@
-export declare function devnetLumosConfigTemplate(cellBaseTxHashInGenesisBlock: string, secondTxHashInGenesisBlock: string): {
-    PREFIX: string;
-    SCRIPTS: {
-        SECP256K1_BLAKE160: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-            SHORT_ID: number;
-        };
-        SECP256K1_BLAKE160_MULTISIG: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        DAO: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-            SHORT_ID: number;
-        };
-        SUDT: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        XUDT: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        OMNILOCK: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        ANYONE_CAN_PAY: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        ALWAYS_SUCCESS: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        SPORE: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        SPORE_CLUSTER: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        SPORE_CLUSTER_AGENT: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        SPORE_CLUSTER_PROXY: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-        SPORE_LUA: {
-            CODE_HASH: string;
-            HASH_TYPE: string;
-            TX_HASH: string;
-            INDEX: string;
-            DEP_TYPE: string;
-        };
-    };
-};
-export declare function buildLumosConfig(): Promise<void>;

package/dist/util.d.ts

@@ -1,13 +0,0 @@
-export declare function isFolderExists(folderPath: string): boolean;
-export declare function copyFolderSync(source: string, destination: string): void;
-export declare function copyFileSync(source: string, target: string): void;
-export declare function copyFilesWithExclusion(sourceDir: string, destinationDir: string, excludedFolders: string[]): Promise<void>;
-export declare function copyRecursive(source: string, destination: string, excludedFolders: string[]): Promise<void>;
-export declare function isGitInstalled(): boolean;
-export declare function gitCloneAndDownloadFolderSync(repoUrl: string, branch: string, subFolderName: string, targetPath: string): undefined;
-export interface TemplateOption {
-    name: string;
-    value: string;
-    description: string;
-}
-export declare function loadTemplateOpts(): Promise<Array<TemplateOption>>;