@dedot/cli 0.3.0 → 0.4.1-next.b1afe683.1

package/bin/dedot.mjs

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
-import { dedot } from '../cjs/index.js';
+import { dedot } from '../index.js';
 
 dedot();

package/commands/chaintypes.js

@@ -0,0 +1,91 @@
+import { rpc } from '@polkadot/types-support/metadata/static-substrate';
+import staticSubstrate from '@polkadot/types-support/metadata/v15/substrate-hex';
+import { ConstantExecutor } from '@dedot/api';
+import { $Metadata, PortableRegistry } from '@dedot/codecs';
+import { generateTypes, generateTypesFromEndpoint } from '@dedot/codegen';
+import ora from 'ora';
+import * as path from 'path';
+export const chaintypes = {
+    command: 'chaintypes',
+    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';
+        const spinner = ora().start();
+        const shouldGenerateGenericTypes = wsUrl === 'substrate';
+        try {
+            let generatedResult;
+            if (shouldGenerateGenericTypes) {
+                spinner.text = 'Generating Substrate generic chaintypes';
+                const metadataHex = staticSubstrate;
+                const rpcMethods = rpc.methods;
+                const metadata = $Metadata.tryDecode(metadataHex);
+                const runtimeVersion = getRuntimeVersion(metadata);
+                const runtimeApis = runtimeVersion.apis.reduce((acc, [name, version]) => {
+                    acc[name] = version;
+                    return acc;
+                }, {});
+                generatedResult = await 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 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!');
+        }
+        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);
+        }
+        spinner.stop();
+    },
+    builder: (yargs) => {
+        return yargs
+            .option('wsUrl', {
+            type: 'string',
+            describe: 'Websocket URL to fetch metadata',
+            alias: 'w',
+            default: 'ws://127.0.0.1:9944',
+        })
+            .option('output', {
+            type: 'string',
+            describe: 'Output folder to put generated files',
+            alias: 'o',
+        })
+            .option('chain', {
+            type: 'string',
+            describe: 'Custom chain name',
+            alias: 'c',
+        })
+            .option('dts', {
+            type: 'boolean',
+            describe: 'Generate d.ts files',
+            alias: 'd',
+            default: true,
+        })
+            .option('subpath', {
+            type: 'boolean',
+            describe: 'Using subpath for shared packages (e.g: dedot/types)',
+            alias: 's',
+            default: true,
+        }); // TODO check to verify inputs
+    },
+};
+const getRuntimeVersion = (metadata) => {
+    const registry = new PortableRegistry(metadata.latest);
+    const executor = new ConstantExecutor({
+        registry,
+        metadata,
+    });
+    return executor.execute('system', 'version');
+};

package/commands/index.js

@@ -0,0 +1,2 @@
+export * from './chaintypes.js';
+export * from './typink.js';

package/commands/typink.js

@@ -0,0 +1,66 @@
+import { generateContractTypes } from '@dedot/codegen';
+import { parseRawMetadata } from '@dedot/contracts';
+import { assert } from '@dedot/utils';
+import * as fs from 'node:fs';
+import ora from 'ora';
+import * as path from 'path';
+export const typink = {
+    command: 'typink',
+    describe: 'Generate Types & APIs for ink! smart contracts',
+    handler: async (yargs) => {
+        const { contract, output = '', metadata, dts = true, subpath = true } = yargs;
+        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 spinner = ora().start();
+        try {
+            spinner.text = `Parsing contract metadata file: ${metadata}`;
+            const contractMetadata = parseRawMetadata(fs.readFileSync(metadataFile, 'utf-8'));
+            spinner.succeed(`Parsed contract metadata file: ${metadata}`);
+            spinner.text = 'Generating contract Types & APIs';
+            const { interfaceName } = await 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
+            .option('metadata', {
+            type: 'string',
+            describe: 'Path to contract metadata file (.json, .contract)',
+            alias: 'm',
+            demandOption: true,
+        })
+            .option('output', {
+            type: 'string',
+            describe: 'Output folder to put generated files',
+            alias: 'o',
+        })
+            .option('contract', {
+            type: 'string',
+            describe: 'Custom contract name, default is contract name from metadata',
+            alias: 'c',
+        })
+            .option('dts', {
+            type: 'boolean',
+            describe: 'Generate d.ts files',
+            alias: 'd',
+            default: true,
+        })
+            .option('subpath', {
+            type: 'boolean',
+            describe: 'Using subpath for shared packages (e.g: dedot/contracts)',
+            alias: 's',
+            default: true,
+        });
+    },
+};

package/dedot.js

@@ -0,0 +1,16 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { chaintypes, typink } from './commands/index.js';
+export const dedot = () => {
+    yargs(hideBin(process.argv))
+        .scriptName('dedot')
+        .showHelpOnFail(true)
+        .command(chaintypes)
+        .command(typink)
+        .help('help', 'Show help instructions')
+        .alias('h', 'help')
+        .alias('v', 'version')
+        .epilog(`//-- decode the dots - website: https://dedot.dev --//`)
+        .strictCommands()
+        .demandCommand(1).argv;
+};

package/index.js

@@ -0,0 +1,7 @@
+import { dedot } from './dedot.js';
+export { dedot };
+// We run this directly for development purpose via ts-node
+// @ts-ignore
+if (process[Symbol.for('ts-node.register.instance')]) {
+    dedot();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dedot/cli",
-  "version": "0.3.0",
+  "version": "0.4.1-next.b1afe683.1+b1afe68",
   "author": "Thang X. Vu <thang@coongcrafts.io>",
   "homepage": "https://github.com/dedotdev/dedot/tree/main/packages/cli",
   "repository": {
@@ -12,18 +12,20 @@
     "dedot": "./bin/dedot.mjs",
     "djs": "./bin/dedot.mjs"
   },
-  "main": "./cjs/index.js",
+  "main": "./index.js",
   "sideEffects": false,
+  "type": "module",
   "scripts": {
-    "build": "tsc --project tsconfig.build.cjs.json && cp -R ./bin ./dist",
-    "clean": "rm -rf ./dist && rm -rf ./tsconfig.tsbuildinfo ./tsconfig.build.cjs.tsbuildinfo && rm -rf ./src/codegen",
+    "build": "tsc --project tsconfig.build.json && cp -R ./bin ./dist",
+    "clean": "rm -rf ./dist && rm -rf ./tsconfig.tsbuildinfo ./tsconfig.build.tsbuildinfo",
     "start": "ts-node src/index.ts"
   },
   "dependencies": {
-    "@dedot/api": "0.3.0",
-    "@dedot/codecs": "0.3.0",
-    "@dedot/codegen": "0.3.0",
+    "@dedot/api": "0.4.1-next.b1afe683.1+b1afe68",
+    "@dedot/codecs": "0.4.1-next.b1afe683.1+b1afe68",
+    "@dedot/codegen": "0.4.1-next.b1afe683.1+b1afe68",
     "@polkadot/types-support": "^12.2.3",
+    "ora": "^8.0.1",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
@@ -34,5 +36,7 @@
     "directory": "dist"
   },
   "license": "Apache-2.0",
-  "gitHead": "40d0f3c7eee292b7615649e6a5d54887bee75fe2"
+  "gitHead": "b1afe683dd8f237ef804130b721525a59accd280",
+  "module": "./index.js",
+  "types": "./index.d.ts"
 }

package/cjs/commands/chaintypes.js

@@ -1,101 +0,0 @@
-"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.chaintypes = void 0;
-const static_substrate_1 = require("@polkadot/types-support/metadata/static-substrate");
-const substrate_hex_1 = __importDefault(require("@polkadot/types-support/metadata/v15/substrate-hex"));
-const api_1 = require("@dedot/api");
-const codecs_1 = require("@dedot/codecs");
-const codegen_1 = require("@dedot/codegen");
-const path = __importStar(require("path"));
-exports.chaintypes = {
-    command: 'chaintypes',
-    describe: 'Generate chain types & APIs for a Substrate-based blockchain',
-    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);
-        }
-        else {
-            console.log(`- Generating chaintypes via endpoint ${wsUrl}`);
-            await (0, codegen_1.generateTypesFromEndpoint)(chain, wsUrl, outDir, extension, subpath);
-        }
-        console.log(`- DONE! Output: ${outDir}`);
-    },
-    builder: (yargs) => {
-        return (yargs
-            .option('wsUrl', {
-            type: 'string',
-            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',
-            alias: 'o',
-        })
-            .option('chain', {
-            type: 'string',
-            describe: 'Chain name',
-            alias: 'c',
-        })
-            .option('dts', {
-            type: 'boolean',
-            describe: 'Generate d.ts files',
-            alias: 'd',
-            default: true,
-        })
-            .option('subpath', {
-            type: 'boolean',
-            describe: 'Using subpath for shared packages',
-            alias: 's',
-            default: true,
-        })); // TODO check to verify inputs
-    },
-};
-const getRuntimeVersion = (metadata) => {
-    const registry = new codecs_1.PortableRegistry(metadata.latest);
-    const executor = new api_1.ConstantExecutor({
-        registry,
-        metadata,
-    });
-    return executor.execute('system', 'version');
-};

package/cjs/commands/index.js

@@ -1,18 +0,0 @@
-"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./chaintypes.js"), exports);
-__exportStar(require("./typink.js"), exports);

package/cjs/commands/typink.js

@@ -1,76 +0,0 @@
-"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.typink = void 0;
-const codegen_1 = require("@dedot/codegen");
-const utils_1 = require("@dedot/utils");
-const fs = __importStar(require("node:fs"));
-const path = __importStar(require("path"));
-exports.typink = {
-    command: 'typink',
-    describe: 'Generate types & APIs for a 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}`);
-    },
-    builder: (yargs) => {
-        return yargs
-            .option('metadata', {
-            type: 'string',
-            describe: 'Path to contract metadata file (.json, .contract)',
-            alias: 'm',
-            demandOption: true,
-        })
-            .option('output', {
-            type: 'string',
-            describe: 'Output folder to put generated files',
-            alias: 'o',
-        })
-            .option('contract', {
-            type: 'string',
-            describe: 'Contract name',
-            alias: 'c',
-        })
-            .option('dts', {
-            type: 'boolean',
-            describe: 'Generate d.ts files',
-            alias: 'd',
-            default: true,
-        })
-            .option('subpath', {
-            type: 'boolean',
-            describe: 'Using subpath for shared packages',
-            alias: 's',
-            default: true,
-        });
-    },
-};

package/cjs/dedot.js

@@ -1,23 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dedot = void 0;
-const yargs_1 = __importDefault(require("yargs"));
-const helpers_1 = require("yargs/helpers");
-const index_js_1 = require("./commands/index.js");
-const dedot = () => {
-    (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
-        .scriptName('dedot')
-        .showHelpOnFail(true)
-        .command(index_js_1.chaintypes)
-        .command(index_js_1.typink)
-        .help('help', 'Show help instructions')
-        .alias('h', 'help')
-        .alias('v', 'version')
-        .epilog(`//-- decode the dots - website: https://dedot.dev --//`)
-        .strictCommands()
-        .demandCommand(1).argv;
-};
-exports.dedot = dedot;

package/cjs/index.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dedot = void 0;
-const dedot_js_1 = require("./dedot.js");
-Object.defineProperty(exports, "dedot", { enumerable: true, get: function () { return dedot_js_1.dedot; } });
-// We run this directly for development purpose via ts-node
-// @ts-ignore
-if (process[Symbol.for('ts-node.register.instance')]) {
-    (0, dedot_js_1.dedot)();
-}

package/cjs/package.json

@@ -1 +0,0 @@
-{"type": "commonjs"}