@acala-network/chopsticks 0.5.9 → 0.5.10

package/lib/blockchain/block-builder.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dryRunInherents = exports.dryRunExtrinsic = exports.buildBlock = exports.newHeader = void 0;
 const block_1 = require("./block");
-const util_crypto_1 = require("@polkadot/util-crypto");
+const storage_layer_1 = require("./storage-layer");
 const util_1 = require("@polkadot/util");
 const utils_1 = require("../utils");
 const logger_1 = require("../logger");
@@ -90,12 +90,16 @@ const newHeader = async (head) => {
     return header;
 };
 exports.newHeader = newHeader;
-const initNewBlock = async (head, header, inherents) => {
+const initNewBlock = async (head, header, inherents, storageLayer) => {
     const blockNumber = header.number.toNumber();
     const hash = `0x${Math.round(Math.random() * 100000000)
         .toString(16)
         .padEnd(64, '0')}`;
-    const newBlock = new block_1.Block(head.chain, blockNumber, hash, head, { header, extrinsics: [], storage: head.storage });
+    const newBlock = new block_1.Block(head.chain, blockNumber, hash, head, {
+        header,
+        extrinsics: [],
+        storage: storageLayer ?? head.storage,
+    });
     {
         // initialize block
         const { storageDiff } = await newBlock.call('Core_initialize_block', [header.toHex()]);
@@ -125,18 +129,11 @@ const initNewBlock = async (head, header, inherents) => {
 const buildBlock = async (head, inherents, extrinsics, ump, onApplyExtrinsicError) => {
     const registry = await head.registry;
     const header = await (0, exports.newHeader)(head);
-    const { block: newBlock } = await initNewBlock(head, header, inherents);
-    logger.info({
-        number: newBlock.number,
-        extrinsicsCount: extrinsics.length,
-        tempHash: newBlock.hash,
-    }, `Try building block #${newBlock.number.toLocaleString()}`);
-    const pendingExtrinsics = [];
-    const includedExtrinsic = [];
+    let layer;
     // apply ump via storage override hack
     if (Object.keys(ump).length > 0) {
         const meta = await head.meta;
-        const layer = head.pushStorageLayer();
+        layer = new storage_layer_1.StorageLayer(head.storage);
         for (const [paraId, upwardMessages] of Object.entries(ump)) {
             const queueSize = meta.registry.createType('(u32, u32)', [
                 upwardMessages.length,
@@ -148,15 +145,20 @@ const buildBlock = async (head, inherents, extrinsics, ump, onApplyExtrinsicErro
                 [(0, utils_1.compactHex)(meta.query.ump.relayDispatchQueues(paraId)), messages.toHex()],
                 [(0, utils_1.compactHex)(meta.query.ump.relayDispatchQueueSize(paraId)), queueSize.toHex()],
             ]);
+            logger.trace({ paraId, upwardMessages: (0, logger_1.truncate)(upwardMessages) }, 'Pushed UMP');
         }
-        logger.trace({
-            number: newBlock.number,
-            tempHash: newBlock.hash,
-            ump,
-        }, 'Upward messages');
         const needsDispatch = meta.registry.createType('Vec<u32>', Object.keys(ump));
         layer.set((0, utils_1.compactHex)(meta.query.ump.needsDispatch()), needsDispatch.toHex());
     }
+    const { block: newBlock } = await initNewBlock(head, header, inherents, layer);
+    logger.info({
+        number: newBlock.number,
+        extrinsicsCount: extrinsics.length,
+        umpCount: Object.keys(ump).length,
+        tempHash: newBlock.hash,
+    }, `Try building block #${newBlock.number.toLocaleString()}`);
+    const pendingExtrinsics = [];
+    const includedExtrinsic = [];
     // apply extrinsics
     for (const extrinsic of extrinsics) {
         try {
@@ -194,11 +196,12 @@ const buildBlock = async (head, inherents, extrinsics, ump, onApplyExtrinsicErro
         storageDiff,
     });
     logger.info({
-        hash: finalBlock.hash,
-        extrinsics: includedExtrinsic.map((x) => (0, util_crypto_1.blake2AsHex)(x, 256)),
-        pendingExtrinsics: pendingExtrinsics.length,
         number: newBlock.number,
-    }, `Block built #${newBlock.number.toLocaleString()} hash ${finalBlock.hash}`);
+        hash: finalBlock.hash,
+        extrinsics: (0, logger_1.truncate)(includedExtrinsic),
+        pendingExtrinsicsCount: pendingExtrinsics.length,
+        ump: (0, logger_1.truncate)(ump),
+    }, 'Block built');
     return [finalBlock, pendingExtrinsics];
 };
 exports.buildBlock = buildBlock;

package/lib/blockchain/txpool.js

@@ -8,6 +8,8 @@ const node_stream_1 = require("node:stream");
 const lodash_1 = __importDefault(require("lodash"));
 const utils_1 = require("../utils");
 const block_builder_1 = require("./block-builder");
+const logger_1 = require("../logger");
+const logger = logger_1.defaultLogger.child({ name: 'txpool' });
 exports.APPLY_EXTRINSIC_ERROR = 'TxPool::ApplyExtrinsicError';
 var BuildBlockMode;
 (function (BuildBlockMode) {
@@ -38,6 +40,7 @@ class TxPool {
         return this.#pool.filter(({ signer }) => signer === address).map(({ extrinsic }) => extrinsic);
     }
     async submitExtrinsic(extrinsic) {
+        logger.debug({ extrinsic: (0, logger_1.truncate)(extrinsic) }, 'submit extrinsic');
         this.#pool.push({ extrinsic, signer: await this.#getSigner(extrinsic) });
         this.#maybeBuildBlock();
     }
@@ -47,6 +50,7 @@ class TxPool {
         return tx.signer.toString();
     }
     submitUpwardMessages(id, ump) {
+        logger.debug({ id, ump: (0, logger_1.truncate)(ump) }, 'submit upward messages');
         if (!this.#ump[id]) {
             this.#ump[id] = [];
         }
@@ -54,10 +58,12 @@ class TxPool {
         this.#maybeBuildBlock();
     }
     submitDownwardMessages(dmp) {
+        logger.debug({ dmp: (0, logger_1.truncate)(dmp) }, 'submit downward messages');
         this.#dmp.push(...dmp);
         this.#maybeBuildBlock();
     }
     submitHorizontalMessages(id, hrmp) {
+        logger.debug({ id, hrmp: (0, logger_1.truncate)(hrmp) }, 'submit horizontal messages');
         if (!this.#hrmp[id]) {
             this.#hrmp[id] = [];
         }
@@ -136,6 +142,7 @@ class TxPool {
             throw new Error('Unreachable');
         }
         const { params, deferred } = pending;
+        logger.trace({ params }, 'build block');
         const head = this.#chain.head;
         const inherents = await this.#inherentProvider.createInherents(head, params);
         const [newBlock, pendingExtrinsics] = await (0, block_builder_1.buildBlock)(head, inherents, params.transactions, params.upwardMessages, (extrinsic, error) => {

package/lib/cli.js

@@ -15,6 +15,7 @@ const dry_run_1 = require("./dry-run");
 const dry_run_preimage_1 = require("./dry-run-preimage");
 const utils_1 = require("./utils");
 const run_block_1 = require("./run-block");
+const try_runtime_1 = require("./try-runtime");
 const processConfig = async (path) => {
     let file;
     if ((0, utils_1.isUrl)(path)) {
@@ -59,14 +60,14 @@ const defaultOptions = {
     .scriptName('chopsticks')
     .command('run-block', 'Replay a block', (yargs) => yargs.options({
     ...defaultOptions,
-    port: {
-        desc: 'Port to listen on',
-        number: true,
-    },
     'output-path': {
         desc: 'File path to print output',
         string: true,
     },
+    'import-storage': {
+        desc: 'Pre-defined JSON/YAML storage file path',
+        string: true,
+    },
     html: {
         desc: 'Generate html with storage diff',
     },
@@ -75,6 +76,26 @@ const defaultOptions = {
     },
 }), async (argv) => {
     await (0, run_block_1.runBlock)(await processArgv(argv));
+})
+    .command('try-runtime', 'Runs runtime upgrade', (yargs) => yargs.options({
+    ...defaultOptions,
+    'wasm-override': {
+        desc: 'Path to WASM built with feature `try-runtime` enabled',
+        string: true,
+        required: true,
+    },
+    'output-path': {
+        desc: 'File path to print output',
+        string: true,
+    },
+    html: {
+        desc: 'Generate html with storage diff',
+    },
+    open: {
+        desc: 'Open generated html',
+    },
+}), async (argv) => {
+    await (0, try_runtime_1.tryRuntime)(await processArgv(argv));
 })
     .command('dry-run', 'Dry run an extrinsic', (yargs) => yargs.options({
     ...defaultOptions,

package/lib/run-block.js

@@ -7,7 +7,7 @@ const open_html_1 = require("./utils/open-html");
 const executor_1 = require("./executor");
 const setup_1 = require("./setup");
 const runBlock = async (argv) => {
-    const context = await (0, setup_1.setup)(argv);
+    const context = await (0, setup_1.setup)(argv, true);
     const header = await context.chain.head.header;
     const wasm = await context.chain.head.wasm;
     const block = context.chain.head;

package/lib/server.js

@@ -137,7 +137,7 @@ const createServer = async (handler, port) => {
                 send({
                     id: req.id,
                     jsonrpc: '2.0',
-                    result: resp || null,
+                    result: resp ?? null,
                 });
             }
             catch (e) {

package/lib/setup.d.ts

@@ -3,7 +3,7 @@ import { ProviderInterface } from '@polkadot/rpc-provider/types';
 import { Api } from './api';
 import { Blockchain } from './blockchain';
 import { Config } from './schema';
-export declare const setup: (argv: Config) => Promise<{
+export declare const setup: (argv: Config, runBlock?: boolean) => Promise<{
     chain: Blockchain;
     api: Api;
     ws: ProviderInterface;

package/lib/setup.js

@@ -11,7 +11,7 @@ const logger_1 = require("./logger");
 const import_storage_1 = require("./utils/import-storage");
 const db_1 = require("./db");
 const time_travel_1 = require("./utils/time-travel");
-const setup = async (argv) => {
+const setup = async (argv, runBlock = false) => {
     let provider;
     if (argv.genesis) {
         if (typeof argv.genesis === 'string') {
@@ -66,10 +66,18 @@ const setup = async (argv) => {
     });
     if (argv.timestamp)
         await (0, time_travel_1.timeTravel)(chain, argv.timestamp);
+    let at;
+    if (runBlock) {
+        // in case of run block we need to apply wasm-override and import-storage to parent block
+        const block = await chain.head.parentBlock;
+        if (!block)
+            throw new Error('Cannot find parent block');
+        at = block.hash;
+    }
     // override wasm before importing storage, in case new pallets have been
     // added that have storage imports
-    await (0, import_storage_1.overrideWasm)(chain, argv['wasm-override']);
-    await (0, import_storage_1.importStorage)(chain, argv['import-storage']);
+    await (0, import_storage_1.overrideWasm)(chain, argv['wasm-override'], at);
+    await (0, import_storage_1.importStorage)(chain, argv['import-storage'], at);
     return { chain, api, ws: provider };
 };
 exports.setup = setup;

package/lib/try-runtime.d.ts

@@ -0,0 +1,2 @@
+import { Config } from './schema';
+export declare const tryRuntime: (argv: Config) => Promise<never>;

package/lib/try-runtime.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tryRuntime = void 0;
+const node_fs_1 = require("node:fs");
+const generate_html_diff_1 = require("./utils/generate-html-diff");
+const open_html_1 = require("./utils/open-html");
+const setup_1 = require("./setup");
+const tryRuntime = async (argv) => {
+    const context = await (0, setup_1.setup)(argv);
+    const block = context.chain.head;
+    const registry = await block.registry;
+    registry.register({
+        UpgradeCheckSelect: {
+            _enum: {
+                None: null,
+            },
+        },
+    });
+    const select_none = registry.createType('UpgradeCheckSelect', 'None');
+    const result = await block.call('TryRuntime_on_runtime_upgrade', [select_none.toHex()], []);
+    if (argv['html']) {
+        const filePath = await (0, generate_html_diff_1.generateHtmlDiffPreviewFile)(block, result.storageDiff, block.hash);
+        console.log(`Generated preview ${filePath}`);
+        if (argv['open']) {
+            (0, open_html_1.openHtml)(filePath);
+        }
+    }
+    else if (argv['output-path']) {
+        (0, node_fs_1.writeFileSync)(argv['output-path'], JSON.stringify(result, null, 2));
+    }
+    else {
+        console.dir(result, { depth: null, colors: false });
+    }
+    process.exit(0);
+};
+exports.tryRuntime = tryRuntime;

package/lib/utils/import-storage.d.ts

@@ -1,4 +1,5 @@
+import { HexString } from '@polkadot/util/types';
 import { Blockchain } from '../blockchain';
 import { StorageValues } from './set-storage';
-export declare const importStorage: (chain: Blockchain, storage?: string | StorageValues) => Promise<void>;
-export declare const overrideWasm: (chain: Blockchain, wasmPath?: string) => Promise<void>;
+export declare const importStorage: (chain: Blockchain, storage?: string | StorageValues, at?: HexString) => Promise<void>;
+export declare const overrideWasm: (chain: Blockchain, wasmPath?: string, at?: HexString) => Promise<void>;

package/lib/utils/import-storage.js

@@ -8,7 +8,7 @@ const node_fs_1 = require("node:fs");
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const set_storage_1 = require("./set-storage");
 const logger_1 = require("../logger");
-const importStorage = async (chain, storage) => {
+const importStorage = async (chain, storage, at) => {
     if (storage == null) {
         return;
     }
@@ -21,11 +21,11 @@ const importStorage = async (chain, storage) => {
     else {
         storageValue = storage;
     }
-    const blockHash = await (0, set_storage_1.setStorage)(chain, storageValue);
+    const blockHash = await (0, set_storage_1.setStorage)(chain, storageValue, at);
     logger_1.defaultLogger.trace({ blockHash, storage }, 'ImportStorage');
 };
 exports.importStorage = importStorage;
-const overrideWasm = async (chain, wasmPath) => {
+const overrideWasm = async (chain, wasmPath, at) => {
     if (wasmPath == null) {
         return;
     }
@@ -38,6 +38,14 @@ const overrideWasm = async (chain, wasmPath) => {
     else {
         wasmHex = '0x' + wasm.toString('hex');
     }
-    chain.head.setWasm(wasmHex);
+    if (at) {
+        const block = await chain.getBlock(at);
+        if (!block)
+            throw new Error(`Cannot find block ${at}`);
+        block.setWasm(wasmHex);
+    }
+    else {
+        chain.head.setWasm(wasmHex);
+    }
 };
 exports.overrideWasm = overrideWasm;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@acala-network/chopsticks",
-  "version": "0.5.9",
+  "version": "0.5.10",
   "author": "Bryan Chen <xlchen1291@gmail.com>",
   "license": "Apache-2.0",
   "bin": "./chopsticks.js",
   "scripts": {
     "clean": "rm -rf lib tsconfig.tsbuildinfo",
-    "build": "yarn clean && tsc -p ./tsconfig.json",
+    "build": "tsc -p ./tsconfig.json",
     "script:start": "cd ../..; ts-node --transpile-only packages/chopsticks/src/cli.ts",
     "script:run": "LOG_LEVEL=trace ts-node-dev --transpile-only --inspect --notify=false src/cli.ts -- dev --config=../../configs/dev.yml",
     "dev:karura": "ts-node-dev --transpile-only --inspect --notify=false src/cli.ts -- dev --config=../../configs/karura.yml",
@@ -15,7 +15,7 @@
     "dev:moonbeam": "ts-node-dev --transpile-only --inspect --notify=false src/cli.ts -- dev --config=../../configs/moonbeam.yml"
   },
   "dependencies": {
-    "@acala-network/chopsticks-executor": "0.5.9",
+    "@acala-network/chopsticks-executor": "0.5.10",
     "@polkadot/api": "^9.14.2",
     "@polkadot/rpc-provider": "^9.14.2",
     "@polkadot/types": "^9.14.2",