@dedot/cli 0.2.0 → 0.4.0

package/cjs/commands/chaintypes.js

@@ -32,41 +32,60 @@ const substrate_hex_1 = __importDefault(require("@polkadot/types-support/metadat
 const api_1 = require("@dedot/api");
 const codecs_1 = require("@dedot/codecs");
 const codegen_1 = require("@dedot/codegen");
+const ora_1 = __importDefault(require("ora"));
 const path = __importStar(require("path"));
 exports.chaintypes = {
     command: 'chaintypes',
-    describe: 'Generate chain types & APIs for a Substrate-based blockchain',
+    describe: 'Generate Types & APIs for Substrate-based chains',
     handler: async (yargs) => {
         const { wsUrl, output = '', chain = '', dts = true, subpath = true } = yargs;
         const outDir = path.resolve(output);
         const extension = dts ? 'd.ts' : 'ts';
-        if (wsUrl === 'substrate') {
-            console.log(`- Generating generic chaintypes`);
-            const metadataHex = substrate_hex_1.default;
-            const rpcMethods = static_substrate_1.rpc.methods;
-            const metadata = codecs_1.$Metadata.tryDecode(metadataHex);
-            const runtimeVersion = getRuntimeVersion(metadata);
-            const runtimeApis = runtimeVersion.apis.reduce((acc, [name, version]) => {
-                acc[name] = version;
-                return acc;
-            }, {});
-            await (0, codegen_1.generateTypes)('substrate', metadata.latest, rpcMethods, runtimeApis, outDir, extension, subpath);
+        const spinner = (0, ora_1.default)().start();
+        const shouldGenerateGenericTypes = wsUrl === 'substrate';
+        try {
+            let generatedResult;
+            if (shouldGenerateGenericTypes) {
+                spinner.text = 'Generating Substrate generic chaintypes';
+                const metadataHex = substrate_hex_1.default;
+                const rpcMethods = static_substrate_1.rpc.methods;
+                const metadata = codecs_1.$Metadata.tryDecode(metadataHex);
+                const runtimeVersion = getRuntimeVersion(metadata);
+                const runtimeApis = runtimeVersion.apis.reduce((acc, [name, version]) => {
+                    acc[name] = version;
+                    return acc;
+                }, {});
+                generatedResult = await (0, codegen_1.generateTypes)(chain || 'substrate', metadata.latest, rpcMethods, runtimeApis, outDir, extension, subpath);
+                spinner.succeed('Generated Substrate generic chaintypes');
+            }
+            else {
+                spinner.text = `Generating chaintypes via endpoint: ${wsUrl}`;
+                generatedResult = await (0, codegen_1.generateTypesFromEndpoint)(chain, wsUrl, outDir, extension, subpath);
+                spinner.succeed(`Generated chaintypes via endpoint: ${wsUrl}`);
+            }
+            console.log(`  ➡ Output directory: file://${outDir}`);
+            console.log(`  ➡ ChainApi interface: ${generatedResult.interfaceName}`);
+            console.log('🌈 Done!');
         }
-        else {
-            console.log(`- Generating chaintypes via endpoint ${wsUrl}`);
-            await (0, codegen_1.generateTypesFromEndpoint)(chain, wsUrl, outDir, extension, subpath);
+        catch (e) {
+            if (shouldGenerateGenericTypes) {
+                spinner.fail(`Failed to generate Substrate generic chaintypes`);
+            }
+            else {
+                spinner.fail(`Failed to generate chaintypes via endpoint: ${wsUrl}`);
+            }
+            console.error(e);
         }
-        console.log(`- DONE! Output: ${outDir}`);
+        spinner.stop();
     },
     builder: (yargs) => {
-        return (yargs
+        return yargs
             .option('wsUrl', {
             type: 'string',
-            describe: 'Websocket Url to fetch metadata',
+            describe: 'Websocket URL to fetch metadata',
             alias: 'w',
             default: 'ws://127.0.0.1:9944',
         })
-            // TODO add file input
             .option('output', {
             type: 'string',
             describe: 'Output folder to put generated files',
@@ -74,7 +93,7 @@ exports.chaintypes = {
         })
             .option('chain', {
             type: 'string',
-            describe: 'Chain name',
+            describe: 'Custom chain name',
             alias: 'c',
         })
             .option('dts', {
@@ -85,10 +104,10 @@ exports.chaintypes = {
         })
             .option('subpath', {
             type: 'boolean',
-            describe: 'Using subpath for shared packages',
+            describe: 'Using subpath for shared packages (e.g: dedot/types)',
             alias: 's',
             default: true,
-        })); // TODO check to verify inputs
+        }); // TODO check to verify inputs
     },
 };
 const getRuntimeVersion = (metadata) => {

package/cjs/commands/typink.js

@@ -22,25 +22,44 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __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.typink = void 0;
 const codegen_1 = require("@dedot/codegen");
+const contracts_1 = require("@dedot/contracts");
 const utils_1 = require("@dedot/utils");
 const fs = __importStar(require("node:fs"));
+const ora_1 = __importDefault(require("ora"));
 const path = __importStar(require("path"));
 exports.typink = {
     command: 'typink',
-    describe: 'Generate types & APIs for a ink! smart contracts',
+    describe: 'Generate Types & APIs for ink! smart contracts',
     handler: async (yargs) => {
         const { contract, output = '', metadata, dts = true, subpath = true } = yargs;
         (0, utils_1.assert)(metadata, 'Metadata file is required, -h or --help to known more about the command');
         const outDir = path.resolve(output);
         const metadataFile = path.resolve(metadata);
         const extension = dts ? 'd.ts' : 'ts';
-        const rawMetadata = fs.readFileSync(metadataFile, 'utf-8');
-        console.log(`- Generating contract types via metadata ${metadata}`);
-        await (0, codegen_1.generateContractTypes)(rawMetadata, contract, outDir, extension, subpath);
-        console.log(`- DONE! Output: ${outDir}`);
+        const spinner = (0, ora_1.default)().start();
+        try {
+            spinner.text = `Parsing contract metadata file: ${metadata}`;
+            const contractMetadata = (0, contracts_1.parseRawMetadata)(fs.readFileSync(metadataFile, 'utf-8'));
+            spinner.succeed(`Parsed contract metadata file: ${metadata}`);
+            spinner.text = 'Generating contract Types & APIs';
+            const { interfaceName } = await (0, codegen_1.generateContractTypes)(contractMetadata, contract, outDir, extension, subpath);
+            spinner.succeed('Generated contract Types & APIs');
+            console.log(`  ➡ Output directory: file://${outDir}`);
+            console.log(`  ➡ ContractApi interface: ${interfaceName}`);
+            console.log('🌈 Done!');
+            spinner.stop();
+        }
+        catch (e) {
+            spinner.stop();
+            spinner.fail(`Failed to generate contract Types & APIs using metadata file: ${metadata}`);
+            console.error(e);
+        }
     },
     builder: (yargs) => {
         return yargs
@@ -57,7 +76,7 @@ exports.typink = {
         })
             .option('contract', {
             type: 'string',
-            describe: 'Contract name',
+            describe: 'Custom contract name, default is contract name from metadata',
             alias: 'c',
         })
             .option('dts', {
@@ -68,7 +87,7 @@ exports.typink = {
         })
             .option('subpath', {
             type: 'boolean',
-            describe: 'Using subpath for shared packages',
+            describe: 'Using subpath for shared packages (e.g: dedot/contracts)',
             alias: 's',
             default: true,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/cli",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/cli",
   "repository": {
@@ -20,10 +20,11 @@
     "start": "ts-node src/index.ts"
   },
   "dependencies": {
-    "@dedot/api": "0.2.0",
-    "@dedot/codecs": "0.2.0",
-    "@dedot/codegen": "0.2.0",
-    "@polkadot/types-support": "^12.2.1",
+    "@dedot/api": "0.4.0",
+    "@dedot/codecs": "0.4.0",
+    "@dedot/codegen": "0.4.0",
+    "@polkadot/types-support": "^12.2.3",
+    "ora": "^8.0.1",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
@@ -34,5 +35,5 @@
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "gitHead": "f29e8784997251518df1e33ef782f1d87207b126"
+  "gitHead": "f6271b5c12d8bf909e4b1a186417bf26db504c63"
 }