@offckb/cli 0.3.0-rc8 → 0.3.0

package/README.md

@@ -212,12 +212,18 @@ To build the script, in the root of the project, run:
 make build
 ```
 
-To deploy the script, cd into the frontend folder and run:
+To deploy the script, cd into the frontend folder where the default `offckb.config.ts` file is located and run:
 
 ```sh
 cd frontend && offckb deploy --network <devnet/testnet>
 ```
 
+Or specific the `offckb.config.ts` file path for deploy command to locate:
+
+```sh
+offckb deploy --network <devnet/testnet> --config <file-path-to-your-offckb.config.ts-file>
+```
+
 Pass `--type-id` option if you want Scripts to be upgradable
 
 ```sh

package/dist/cli.js

@@ -96,8 +96,19 @@ program
     .command('list-hashes [CKB-Version]')
     .description('Use the CKB to list blockchain scripts hashes')
     .action(list_hashes_1.printDevnetListHashes);
-program.command('inject-config').description('Add offckb.config.ts to your frontend workspace').action(inject_config_1.injectConfig);
-program.command('sync-scripts').description('Sync scripts json files in your frontend workspace').action(sync_scripts_1.syncScripts);
+program
+    .command('inject-config')
+    .description('Add offckb.config.ts to your frontend workspace')
+    .option('--target <target>', 'Specify the custom file path of the new injected config')
+    .action(inject_config_1.injectConfig);
+program
+    .command('sync-scripts')
+    .description('Sync scripts json files in your frontend workspace')
+    .option('--config <config>', 'Specify the offckb.config.ts file path', undefined)
+    .action((opt) => {
+    const configPath = opt.config;
+    return (0, sync_scripts_1.syncScripts)({ configPath });
+});
 program
     .command('deposit [toAddress] [amountInCKB]')
     .description('Deposit CKB tokens to address, only devnet and testnet')
@@ -136,6 +147,7 @@ program
     .description('Deploy contracts to different networks, only supports devnet and testnet')
     .option('--network <network>', 'Specify the network to deploy to', 'devnet')
     .option('--target <target>', 'Specify the relative bin target folder to deploy to')
+    .option('--config <config>', 'Specify the offckb.config.ts file path for deployment', undefined)
     .option('-t, --type-id', 'Specify if use upgradable type id to deploy the script')
     .option('--privkey <privkey>', 'Specify the private key to deploy scripts')
     .option('-r, --proxy-rpc', 'Use Proxy RPC to connect to blockchain')

package/dist/cmd/deploy.d.ts

@@ -1,6 +1,7 @@
 import { NetworkOption } from '../type/base';
 export interface DeployOptions extends NetworkOption {
-    target: string | null | undefined;
+    target?: string;
+    config?: string;
     privkey?: string | null;
     typeId?: boolean;
     proxyRpc?: boolean;

package/dist/cmd/deploy.js

@@ -20,7 +20,8 @@ const fs_1 = require("../util/fs");
 const validator_1 = require("../util/validator");
 const deploy_1 = require("../deploy");
 const ckb_1 = require("../sdk/ckb");
-function deploy(opt = { network: base_1.Network.devnet, typeId: false, target: null, proxyRpc: false }) {
+const fs_2 = __importDefault(require("fs"));
+function deploy(opt = { network: base_1.Network.devnet, typeId: false, target: undefined, proxyRpc: false }) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const network = opt.network;
@@ -30,6 +31,7 @@ function deploy(opt = { network: base_1.Network.devnet, typeId: false, target: n
         // we use deployerAccount to deploy contract by default
         const privateKey = opt.privkey || account_1.deployerAccount.privkey;
         const enableTypeId = (_a = opt.typeId) !== null && _a !== void 0 ? _a : false;
+        const configPath = opt.config;
         const targetFolder = opt.target;
         if (targetFolder) {
             const binFolder = (0, fs_1.isAbsolutePath)(targetFolder) ? targetFolder : path_1.default.resolve(process.cwd(), targetFolder);
@@ -37,21 +39,22 @@ function deploy(opt = { network: base_1.Network.devnet, typeId: false, target: n
             const binPaths = bins.map((bin) => path_1.default.resolve(binFolder, bin));
             const results = yield (0, deploy_1.deployBinaries)(binPaths, privateKey, enableTypeId, ckb);
             // record the deployed contract infos
-            (0, deploy_1.recordDeployResult)(results, network, false); // we don't update my-scripts.json since we don't know where the file is
+            (0, deploy_1.recordDeployResult)(results, network); // we don't update my-scripts.json since we don't know where the file is
             return;
         }
-        // check if target workspace is valid
-        try {
-            (0, validator_1.validateExecDappEnvironment)();
-        }
-        catch (error) {
-            return console.debug('Not a valid offCKB dapp workspace.');
-        }
         // read contract bin folder
-        const bins = (0, deploy_1.getToDeployBinsPath)();
+        const userOffCKBConfigPath = configPath
+            ? (0, fs_1.isAbsolutePath)(configPath)
+                ? configPath
+                : path_1.default.resolve(process.cwd(), configPath)
+            : path_1.default.resolve(process.cwd(), 'offckb.config.ts');
+        if (!fs_2.default.existsSync(userOffCKBConfigPath)) {
+            throw new Error(`config file not exits: ${userOffCKBConfigPath}, tips: use --config to specific the offckb.config.ts file`);
+        }
+        const bins = (0, deploy_1.getToDeployBinsPath)(userOffCKBConfigPath);
         const results = yield (0, deploy_1.deployBinaries)(bins, privateKey, enableTypeId, ckb);
         // record the deployed contract infos
-        (0, deploy_1.recordDeployResult)(results, network);
+        (0, deploy_1.recordDeployResult)(results, network, userOffCKBConfigPath);
     });
 }
 exports.deploy = deploy;

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

@@ -1 +1,4 @@
-export declare function injectConfig(): void;
+export interface InjectConfigProp {
+    target?: string;
+}
+export declare function injectConfig({ target }: InjectConfigProp): void;

package/dist/cmd/inject-config.js

@@ -1,22 +1,44 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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.injectConfig = void 0;
 const fs_1 = require("fs");
-const validator_1 = require("../util/validator");
-const path_1 = __importDefault(require("path"));
+const path_1 = __importStar(require("path"));
 const gen_1 = require("../scripts/gen");
 const offckb_config_1 = require("../template/offckb-config");
 const setting_1 = require("../cfg/setting");
 const version = require('../../package.json').version;
-function injectConfig() {
-    (0, validator_1.validateTypescriptWorkspace)();
+function injectConfig({ target }) {
     // inject the offckb.config.ts file into users workspace
     // copy config template
+    const userOffCKBConfigPath = target
+        ? (0, path_1.isAbsolute)(target)
+            ? target
+            : path_1.default.resolve(process.cwd(), target)
+        : path_1.default.resolve(process.cwd(), 'offckb.config.ts');
     const predefinedOffCKBConfigTsPath = path_1.default.resolve(setting_1.packageRootPath, 'templates/v3/offckb.config.example.ts');
-    const userOffCKBConfigPath = path_1.default.resolve(process.cwd(), 'offckb.config.ts');
     (0, fs_1.copyFileSync)(predefinedOffCKBConfigTsPath, userOffCKBConfigPath);
     // update the version in the offckb.config.ts
     offckb_config_1.OffCKBConfigFile.updateVersion(version, userOffCKBConfigPath);

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

@@ -1 +1,4 @@
-export declare function syncScripts(): void;
+export interface SyncScriptsProp {
+    configPath?: string;
+}
+export declare function syncScripts({ configPath }: SyncScriptsProp): void;

package/dist/cmd/sync-scripts.js

@@ -5,12 +5,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.syncScripts = void 0;
 const path_1 = __importDefault(require("path"));
-const validator_1 = require("../util/validator");
 const gen_1 = require("../scripts/gen");
 const offckb_config_1 = require("../template/offckb-config");
-function syncScripts() {
-    (0, validator_1.validateExecDappEnvironment)();
-    const userOffCKBConfigPath = path_1.default.resolve(process.cwd(), 'offckb.config.ts');
+const fs_1 = require("../util/fs");
+const fs_2 = __importDefault(require("fs"));
+function syncScripts({ configPath }) {
+    const userOffCKBConfigPath = configPath
+        ? (0, fs_1.isAbsolutePath)(configPath)
+            ? configPath
+            : path_1.default.resolve(process.cwd(), configPath)
+        : path_1.default.resolve(process.cwd(), 'offckb.config.ts');
+    if (!fs_2.default.existsSync(userOffCKBConfigPath)) {
+        throw new Error(`config file not exits: ${userOffCKBConfigPath}, tips: use --config to specific the offckb.config.ts file`);
+    }
     const contractInfoFolder = offckb_config_1.OffCKBConfigFile.readContractInfoFolder(userOffCKBConfigPath);
     if (!contractInfoFolder) {
         throw new Error('No contract info folder found in offckb.config.ts!');

package/dist/deploy/index.d.ts

@@ -6,8 +6,8 @@ import { HexString } from '../type/base';
 export type DeployBinaryReturnType = ReturnType<typeof deployBinary>;
 export type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
 export type DeployedInterfaceType = UnwrapPromise<DeployBinaryReturnType>;
-export declare function getToDeployBinsPath(): string[];
-export declare function recordDeployResult(results: DeployedInterfaceType[], network: Network, isUpdateMyScriptsJsonFile?: boolean): Promise<void>;
+export declare function getToDeployBinsPath(userOffCKBConfigPath: string): string[];
+export declare function recordDeployResult(results: DeployedInterfaceType[], network: Network, userOffCKBConfigPath?: string): Promise<void>;
 export declare function deployBinaries(binPaths: string[], privateKey: HexString, enableTypeId: boolean, ckb: CKB): Promise<{
     deploymentRecipe: DeploymentRecipe;
     deploymentOptions: DeploymentOptions;

package/dist/deploy/index.js

@@ -21,15 +21,14 @@ const fs_1 = require("../util/fs");
 const path_1 = __importDefault(require("path"));
 const fs_2 = __importDefault(require("fs"));
 const core_1 = require("@ckb-ccc/core");
-function getToDeployBinsPath() {
-    const userOffCKBConfigPath = path_1.default.resolve(process.cwd(), 'offckb.config.ts');
+function getToDeployBinsPath(userOffCKBConfigPath) {
     const fileContent = fs_2.default.readFileSync(userOffCKBConfigPath, 'utf-8');
     const match = fileContent.match(/contractBinFolder:\s*['"]([^'"]+)['"]/);
     if (match && match[1]) {
         const contractBinFolderValue = match[1];
         const binFolderPath = (0, fs_1.isAbsolutePath)(contractBinFolderValue)
             ? contractBinFolderValue
-            : path_1.default.resolve(process.cwd(), contractBinFolderValue);
+            : path_1.default.resolve(userOffCKBConfigPath, contractBinFolderValue);
         const bins = (0, fs_1.listBinaryFilesInFolder)(binFolderPath);
         return bins.map((bin) => path_1.default.resolve(binFolderPath, bin));
     }
@@ -39,7 +38,7 @@ function getToDeployBinsPath() {
     }
 }
 exports.getToDeployBinsPath = getToDeployBinsPath;
-function recordDeployResult(results, network, isUpdateMyScriptsJsonFile = true) {
+function recordDeployResult(results, network, userOffCKBConfigPath) {
     return __awaiter(this, void 0, void 0, function* () {
         if (results.length === 0) {
             return;
@@ -49,8 +48,10 @@ function recordDeployResult(results, network, isUpdateMyScriptsJsonFile = true)
             (0, migration_1.generateDeploymentMigrationFile)(result.deploymentOptions.name, result.deploymentRecipe, network);
         }
         // update my-scripts.json
-        if (isUpdateMyScriptsJsonFile) {
-            const userOffCKBConfigPath = path_1.default.resolve(process.cwd(), 'offckb.config.ts');
+        if (userOffCKBConfigPath) {
+            if (!fs_2.default.existsSync(userOffCKBConfigPath)) {
+                throw new Error(`config file not exits: ${userOffCKBConfigPath}`);
+            }
             const folder = offckb_config_1.OffCKBConfigFile.readContractInfoFolder(userOffCKBConfigPath);
             if (folder) {
                 const myScriptsFilePath = path_1.default.resolve(folder, 'my-scripts.json');

package/package.json

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