@acala-network/chopsticks 0.12.1 → 0.12.2

package/dist/cjs/plugins/fetch-storage/cli.js

@@ -42,6 +42,7 @@ const cli = (y)=>{
                 });
                 process.exit(0);
             } catch (e) {
+                _fetchstorages.logger.error(e);
                 process.exit(1);
             }
         }

package/dist/cjs/plugins/try-runtime/README.md

@@ -0,0 +1,21 @@
+# Try-Runtime CLI
+
+🚧 EXPERIMENTAL FEATURE 🚧
+
+You can use Chopsticks to perform runtime migration checks. It doesn't support PoV measure yet, only weight check is support.
+
+```bash
+# try-runtime print help
+npx @acala-network/chopsticks try-runtime --help
+```
+
+Basic example:
+
+```bash
+npx @acala-network/chopsticks try-runtime \
+  --endpoint <wss://remote.endpoint> \
+  --runtime <wasm_runtime_path> \
+  --checks PreAndPost
+```
+
+__NOTE__: You can also use `--config` to pass arguments

package/dist/cjs/plugins/try-runtime/index.js

@@ -8,61 +8,93 @@ Object.defineProperty(exports, "cli", {
         return cli;
     }
 });
+const _chopstickscore = require("@acala-network/chopsticks-core");
 const _nodefs = require("node:fs");
 const _zod = require("zod");
 const _index = require("../../schema/index.js");
-const _generatehtmldiff = require("../../utils/generate-html-diff.js");
-const _openhtml = require("../../utils/open-html.js");
+const _override = require("../../utils/override.js");
 const _context = require("../../context.js");
 const schema = _zod.z.object({
     endpoint: _index.configSchema.shape.endpoint,
-    port: _index.configSchema.shape.port,
-    ['build-block-mode']: _index.configSchema.shape['build-block-mode'],
     block: _index.configSchema.shape.block,
     db: _index.configSchema.shape.db,
-    ['runtime-log-level']: _index.configSchema.shape['runtime-log-level'],
-    ['wasm-override']: _zod.z.string({
+    ['runtime-log-level']: _index.configSchema.shape['runtime-log-level'].default(5),
+    ['runtime']: _zod.z.string({
         description: 'Path to WASM built with feature `try-runtime` enabled'
     }),
+    'import-storage': _index.configSchema.shape['import-storage'],
+    checks: _zod.z.enum([
+        'None',
+        'All',
+        'PreAndPost',
+        'TryState'
+    ]),
+    'disable-spec-check': _zod.z.boolean({
+        description: 'Disable spec name/version check'
+    }).optional(),
     ['output-path']: _zod.z.string({
         description: 'File path to print output'
-    }).optional(),
-    html: _zod.z.boolean({
-        description: 'Generate html with storage diff'
-    }).optional(),
-    open: _zod.z.boolean({
-        description: 'Open generated html'
     }).optional()
 });
 const cli = (y)=>{
-    y.command('try-runtime', 'Runs runtime upgrade', (yargs)=>yargs.options((0, _index.getYargsOptions)(schema.shape)), async (argv)=>{
-        const context = await (0, _context.setupContext)(schema.parse(argv));
+    y.command('try-runtime', '🚧 EXPERIMENTAL: Check upgrade migrations 🚧', (yargs)=>yargs.options((0, _index.getYargsOptions)(schema.shape)), async (argv)=>{
+        console.log('🚧 EXPERIMENTAL FEATURE 🚧');
+        const config = schema.parse(argv);
+        if (!config.db) {
+            console.log('⚠️ Make sure to provide db, it will speed up the process');
+        }
+        const context = await (0, _context.setupContext)({
+            ...config,
+            port: 8000,
+            'build-block-mode': _chopstickscore.BuildBlockMode.Manual
+        });
         const block = context.chain.head;
         const registry = await block.registry;
         registry.register({
             UpgradeCheckSelect: {
                 _enum: {
-                    None: null
+                    None: null,
+                    All: null,
+                    PreAndPost: null,
+                    TryState: null
                 }
             }
         });
-        const select_none = registry.createType('UpgradeCheckSelect', 'None');
-        const result = await block.call('TryRuntime_on_runtime_upgrade', [
+        const oldVersion = await block.runtimeVersion;
+        // set new runtime
+        await (0, _override.overrideWasm)(block.chain, config.runtime);
+        const newVersion = await block.runtimeVersion;
+        console.log('\n');
+        console.log(new Array(80).fill('-').join(''));
+        console.log(`\tCurrent runtime spec_name: ${oldVersion.specName}, spec_version: ${oldVersion.specVersion}`);
+        console.log(`\tNew runtime spec_name: ${newVersion.specName}, spec_version: ${newVersion.specVersion}`);
+        console.log(new Array(80).fill('-').join(''));
+        console.log('\n');
+        if (!config['disable-spec-check'] && oldVersion.specName !== newVersion.specName) {
+            console.log('❌ Spec name does not match. Use --disable-spec-check to disable this check');
+            process.exit(1);
+        }
+        if (!config['disable-spec-check'] && oldVersion.specVersion >= newVersion.specVersion) {
+            console.log('❌ Spec version must increase. Use --disable-spec-check to disable this check');
+            process.exit(1);
+        }
+        const select_none = registry.createType('UpgradeCheckSelect', config.checks);
+        const response = await block.call('TryRuntime_on_runtime_upgrade', [
             select_none.toHex()
         ]);
-        if (argv.html) {
-            const filePath = await (0, _generatehtmldiff.generateHtmlDiffPreviewFile)(block, result.storageDiff, block.hash);
-            console.log(`Generated preview ${filePath}`);
-            if (argv.open) {
-                (0, _openhtml.openHtml)(filePath);
-            }
-        } else if (argv.outputPath) {
-            (0, _nodefs.writeFileSync)(argv.outputPath, JSON.stringify(result, null, 2));
+        if (argv.outputPath) {
+            (0, _nodefs.writeFileSync)(argv.outputPath, JSON.stringify(response, null, 2));
         } else {
-            console.dir(result, {
-                depth: null,
-                colors: false
-            });
+            const [actual, max] = registry.createType('(Weight, Weight)', response.result);
+            const consumedWeight = actual.refTime.toBn();
+            const maxWeight = max.refTime.toBn();
+            console.log('\n🚧 EXPERIMENTAL FEATURE 🚧');
+            console.log('⚠️ PoV measure is not supported, consider using https://crates.io/crates/try-runtime-cli');
+            console.log(`\nConsumed weight: ${consumedWeight.toNumber()} of max: ${maxWeight.toNumber()} ( ${(consumedWeight.toNumber() / maxWeight.toNumber() * 100).toFixed(2)}% )`);
+            if (consumedWeight.gt(maxWeight)) {
+                console.log('❌ Weight limit is exceeded ❌');
+                process.exit(1);
+            }
         }
         process.exit(0);
     });

package/dist/cjs/utils/fetch-storages.js

@@ -118,7 +118,6 @@ const getPrefixesFromConfig = async (config, api)=>{
 };
 const fetchStorages = async ({ block, endpoint, dbPath, config })=>{
     if (!endpoint) throw new Error('endpoint is required');
-    if (!block) throw new Error('block is required');
     const provider = new _rpcprovider.WsProvider(endpoint, 3_000);
     const apiPromise = new _api.ApiPromise({
         provider

package/dist/esm/plugins/fetch-storage/cli.js

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import _ from 'lodash';
 import { configSchema, getYargsOptions } from '../../schema/index.js';
-import { fetchStorages } from '../../utils/fetch-storages.js';
+import { fetchStorages, logger } from '../../utils/fetch-storages.js';
 const schema = z.object(_.pick(configSchema.shape, [
     'endpoint',
     'block',
@@ -27,6 +27,7 @@ export const cli = (y)=>{
                 });
                 process.exit(0);
             } catch (e) {
+                logger.error(e);
                 process.exit(1);
             }
         }

package/dist/esm/plugins/try-runtime/README.md

@@ -0,0 +1,21 @@
+# Try-Runtime CLI
+
+🚧 EXPERIMENTAL FEATURE 🚧
+
+You can use Chopsticks to perform runtime migration checks. It doesn't support PoV measure yet, only weight check is support.
+
+```bash
+# try-runtime print help
+npx @acala-network/chopsticks try-runtime --help
+```
+
+Basic example:
+
+```bash
+npx @acala-network/chopsticks try-runtime \
+  --endpoint <wss://remote.endpoint> \
+  --runtime <wasm_runtime_path> \
+  --checks PreAndPost
+```
+
+__NOTE__: You can also use `--config` to pass arguments

package/dist/esm/plugins/try-runtime/index.js

@@ -1,58 +1,90 @@
+import { BuildBlockMode } from '@acala-network/chopsticks-core';
 import { writeFileSync } from 'node:fs';
 import { z } from 'zod';
 import { configSchema, getYargsOptions } from '../../schema/index.js';
-import { generateHtmlDiffPreviewFile } from '../../utils/generate-html-diff.js';
-import { openHtml } from '../../utils/open-html.js';
+import { overrideWasm } from '../../utils/override.js';
 import { setupContext } from '../../context.js';
 const schema = z.object({
     endpoint: configSchema.shape.endpoint,
-    port: configSchema.shape.port,
-    ['build-block-mode']: configSchema.shape['build-block-mode'],
     block: configSchema.shape.block,
     db: configSchema.shape.db,
-    ['runtime-log-level']: configSchema.shape['runtime-log-level'],
-    ['wasm-override']: z.string({
+    ['runtime-log-level']: configSchema.shape['runtime-log-level'].default(5),
+    ['runtime']: z.string({
         description: 'Path to WASM built with feature `try-runtime` enabled'
     }),
+    'import-storage': configSchema.shape['import-storage'],
+    checks: z.enum([
+        'None',
+        'All',
+        'PreAndPost',
+        'TryState'
+    ]),
+    'disable-spec-check': z.boolean({
+        description: 'Disable spec name/version check'
+    }).optional(),
     ['output-path']: z.string({
         description: 'File path to print output'
-    }).optional(),
-    html: z.boolean({
-        description: 'Generate html with storage diff'
-    }).optional(),
-    open: z.boolean({
-        description: 'Open generated html'
     }).optional()
 });
 export const cli = (y)=>{
-    y.command('try-runtime', 'Runs runtime upgrade', (yargs)=>yargs.options(getYargsOptions(schema.shape)), async (argv)=>{
-        const context = await setupContext(schema.parse(argv));
+    y.command('try-runtime', '🚧 EXPERIMENTAL: Check upgrade migrations 🚧', (yargs)=>yargs.options(getYargsOptions(schema.shape)), async (argv)=>{
+        console.log('🚧 EXPERIMENTAL FEATURE 🚧');
+        const config = schema.parse(argv);
+        if (!config.db) {
+            console.log('⚠️ Make sure to provide db, it will speed up the process');
+        }
+        const context = await setupContext({
+            ...config,
+            port: 8000,
+            'build-block-mode': BuildBlockMode.Manual
+        });
         const block = context.chain.head;
         const registry = await block.registry;
         registry.register({
             UpgradeCheckSelect: {
                 _enum: {
-                    None: null
+                    None: null,
+                    All: null,
+                    PreAndPost: null,
+                    TryState: null
                 }
             }
         });
-        const select_none = registry.createType('UpgradeCheckSelect', 'None');
-        const result = await block.call('TryRuntime_on_runtime_upgrade', [
+        const oldVersion = await block.runtimeVersion;
+        // set new runtime
+        await overrideWasm(block.chain, config.runtime);
+        const newVersion = await block.runtimeVersion;
+        console.log('\n');
+        console.log(new Array(80).fill('-').join(''));
+        console.log(`\tCurrent runtime spec_name: ${oldVersion.specName}, spec_version: ${oldVersion.specVersion}`);
+        console.log(`\tNew runtime spec_name: ${newVersion.specName}, spec_version: ${newVersion.specVersion}`);
+        console.log(new Array(80).fill('-').join(''));
+        console.log('\n');
+        if (!config['disable-spec-check'] && oldVersion.specName !== newVersion.specName) {
+            console.log('❌ Spec name does not match. Use --disable-spec-check to disable this check');
+            process.exit(1);
+        }
+        if (!config['disable-spec-check'] && oldVersion.specVersion >= newVersion.specVersion) {
+            console.log('❌ Spec version must increase. Use --disable-spec-check to disable this check');
+            process.exit(1);
+        }
+        const select_none = registry.createType('UpgradeCheckSelect', config.checks);
+        const response = await block.call('TryRuntime_on_runtime_upgrade', [
             select_none.toHex()
         ]);
-        if (argv.html) {
-            const filePath = await generateHtmlDiffPreviewFile(block, result.storageDiff, block.hash);
-            console.log(`Generated preview ${filePath}`);
-            if (argv.open) {
-                openHtml(filePath);
-            }
-        } else if (argv.outputPath) {
-            writeFileSync(argv.outputPath, JSON.stringify(result, null, 2));
+        if (argv.outputPath) {
+            writeFileSync(argv.outputPath, JSON.stringify(response, null, 2));
         } else {
-            console.dir(result, {
-                depth: null,
-                colors: false
-            });
+            const [actual, max] = registry.createType('(Weight, Weight)', response.result);
+            const consumedWeight = actual.refTime.toBn();
+            const maxWeight = max.refTime.toBn();
+            console.log('\n🚧 EXPERIMENTAL FEATURE 🚧');
+            console.log('⚠️ PoV measure is not supported, consider using https://crates.io/crates/try-runtime-cli');
+            console.log(`\nConsumed weight: ${consumedWeight.toNumber()} of max: ${maxWeight.toNumber()} ( ${(consumedWeight.toNumber() / maxWeight.toNumber() * 100).toFixed(2)}% )`);
+            if (consumedWeight.gt(maxWeight)) {
+                console.log('❌ Weight limit is exceeded ❌');
+                process.exit(1);
+            }
         }
         process.exit(0);
     });

package/dist/esm/utils/fetch-storages.js

@@ -93,7 +93,6 @@ const checkPalletStorageByName = (meta, palletName, storageName)=>{
  * Fetch storages and save in a local db
  */ export const fetchStorages = async ({ block, endpoint, dbPath, config })=>{
     if (!endpoint) throw new Error('endpoint is required');
-    if (!block) throw new Error('block is required');
     const provider = new WsProvider(endpoint, 3_000);
     const apiPromise = new ApiPromise({
         provider

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acala-network/chopsticks",
-  "version": "0.12.1",
+  "version": "0.12.2",
   "author": "Acala Developers <hello@acala.network>",
   "license": "Apache-2.0",
   "bin": "./chopsticks.cjs",
@@ -10,18 +10,21 @@
     "build": "yarn clean && yarn build:cjs && yarn build:esm",
     "build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs --copy-files && tsc -p tsconfig.json --declarationDir dist/cjs && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
     "build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm --copy-files && tsc -p tsconfig.json --declarationDir dist/esm",
-    "docs:prep": "typedoc"
+    "docs:prep": "typedoc",
+    "depcheck": "npx depcheck --ignore-patterns='*.test.ts'"
   },
   "dependencies": {
-    "@acala-network/chopsticks-core": "0.12.1",
-    "@acala-network/chopsticks-db": "0.12.1",
+    "@acala-network/chopsticks-core": "0.12.2",
+    "@acala-network/chopsticks-db": "0.12.2",
     "@pnpm/npm-conf": "^2.2.2",
-    "@polkadot/api": "^10.11.2",
-    "@polkadot/api-augment": "^10.11.2",
-    "@polkadot/types": "^10.11.2",
+    "@polkadot/api": "^11.2.1",
+    "@polkadot/api-augment": "^11.2.1",
+    "@polkadot/rpc-provider": "^11.2.1",
+    "@polkadot/types": "^11.2.1",
     "@polkadot/util": "^12.6.2",
     "@polkadot/util-crypto": "^12.6.2",
     "axios": "^1.6.8",
+    "comlink": "^4.4.1",
     "dotenv": "^16.4.5",
     "global-agent": "^3.0.0",
     "js-yaml": "^4.1.0",
@@ -40,8 +43,7 @@
     "@types/node": "^20.11.5",
     "@types/ws": "^8.5.10",
     "@types/yargs": "^17.0.32",
-    "typescript": "^5.3.3",
-    "vitest": "^1.4.0"
+    "typescript": "^5.3.3"
   },
   "files": [
     "dist/esm/**",