@acala-network/chopsticks 0.9.1-2 → 0.9.1-4

package/dist/esm/server.js

@@ -1,40 +1,50 @@
 import { WebSocket, WebSocketServer } from 'ws';
 import { ResponseError } from '@acala-network/chopsticks-core';
 import { z } from 'zod';
-import { defaultLogger, truncate } from './logger';
-const logger = defaultLogger.child({ name: 'ws' });
+import { defaultLogger, truncate } from './logger.js';
+const logger = defaultLogger.child({
+    name: 'ws'
+});
 const singleRequest = z.object({
     id: z.number(),
     jsonrpc: z.literal('2.0'),
     method: z.string(),
-    params: z.array(z.any()).default([]),
+    params: z.array(z.any()).default([])
 });
 const batchRequest = z.array(singleRequest);
-const requestSchema = z.union([singleRequest, batchRequest]);
-const parseRequest = (request) => {
+const requestSchema = z.union([
+    singleRequest,
+    batchRequest
+]);
+const parseRequest = (request)=>{
     try {
         return JSON.parse(request);
-    }
-    catch (e) {
+    } catch (e) {
         return undefined;
     }
 };
-const createWS = async (port) => {
-    const wss = new WebSocketServer({ port, maxPayload: 1024 * 1024 * 100 });
-    const promise = new Promise((resolve) => {
-        wss.on('listening', () => {
-            resolve([wss, wss.address().port]);
+const createWS = async (port)=>{
+    const wss = new WebSocketServer({
+        port,
+        maxPayload: 1024 * 1024 * 100
+    });
+    const promise = new Promise((resolve)=>{
+        wss.on('listening', ()=>{
+            resolve([
+                wss,
+                wss.address().port
+            ]);
         });
-        wss.on('error', (_) => {
+        wss.on('error', (_)=>{
             resolve([]);
         });
     });
     return promise;
 };
-export const createServer = async (handler, port) => {
+export const createServer = async (handler, port)=>{
     let wss;
     let listenPort;
-    for (let i = 0; i < 10; i++) {
+    for(let i = 0; i < 10; i++){
         const preferPort = (port ?? 0) > 0 ? (port ?? 0) + i : 0;
         logger.debug('Try starting on port %d', preferPort);
         const [maybeWss, maybeListenPort] = await createWS(preferPort);
@@ -47,80 +57,86 @@ export const createServer = async (handler, port) => {
     if (!wss || !listenPort) {
         throw new Error(`Failed to create WebsocketServer at port ${port}`);
     }
-    wss.on('connection', (ws) => {
+    wss.on('connection', (ws)=>{
         logger.debug('New connection');
-        const send = (data) => {
+        const send = (data)=>{
             if (ws.readyState === WebSocket.OPEN) {
                 ws.send(JSON.stringify(data));
             }
         };
         const subscriptions = {};
         const subscriptionManager = {
-            subscribe: (method, subid, onCancel = () => { }) => {
+            subscribe: (method, subid, onCancel = ()=>{})=>{
                 subscriptions[subid] = onCancel;
-                return (data) => {
+                return (data)=>{
                     if (subscriptions[subid]) {
-                        logger.trace({ method, subid, data: truncate(data) }, 'Subscription notification');
+                        logger.trace({
+                            method,
+                            subid,
+                            data: truncate(data)
+                        }, 'Subscription notification');
                         send({
                             jsonrpc: '2.0',
                             method,
                             params: {
                                 result: data,
-                                subscription: subid,
-                            },
+                                subscription: subid
+                            }
                         });
                     }
                 };
             },
-            unsubscribe: (subid) => {
+            unsubscribe: (subid)=>{
                 if (subscriptions[subid]) {
                     subscriptions[subid](subid);
                     delete subscriptions[subid];
                 }
-            },
+            }
         };
-        const processRequest = async (req) => {
+        const processRequest = async (req)=>{
             logger.trace({
                 id: req.id,
-                method: req.method,
+                method: req.method
             }, 'Received message');
             try {
                 const resp = await handler(req, subscriptionManager);
                 logger.trace({
                     id: req.id,
                     method: req.method,
-                    result: truncate(resp),
+                    result: truncate(resp)
                 }, 'Response for request');
                 return {
                     id: req.id,
                     jsonrpc: '2.0',
-                    result: resp ?? null,
+                    result: resp ?? null
                 };
-            }
-            catch (e) {
+            } catch (e) {
                 logger.info('Error handling request: %s %o', e, e.stack);
                 return {
                     id: req.id,
                     jsonrpc: '2.0',
-                    error: e instanceof ResponseError ? e : { code: -32603, message: `Internal ${e}` },
+                    error: e instanceof ResponseError ? e : {
+                        code: -32603,
+                        message: `Internal ${e}`
+                    }
                 };
             }
         };
-        ws.on('close', () => {
+        ws.on('close', ()=>{
             logger.debug('Connection closed');
-            for (const [subid, onCancel] of Object.entries(subscriptions)) {
+            for (const [subid, onCancel] of Object.entries(subscriptions)){
                 onCancel(subid);
             }
             ws.removeAllListeners();
         });
-        ws.on('error', () => {
+        ws.on('error', ()=>{
             logger.debug('Connection error');
-            for (const [subid, onCancel] of Object.entries(subscriptions)) {
+            for (const [subid, onCancel] of Object.entries(subscriptions)){
                 onCancel(subid);
             }
             ws.removeAllListeners();
         });
-        ws.on('message', async (message) => {
+        ws.on('message', async (message)=>{
             const parsed = await requestSchema.safeParseAsync(parseRequest(message.toString()));
             if (!parsed.success) {
                 logger.info('Invalid request: %s', message);
@@ -129,19 +145,22 @@ export const createServer = async (handler, port) => {
                     jsonrpc: '2.0',
                     error: {
                         code: -32600,
-                        message: 'Invalid JSON Request',
-                    },
+                        message: 'Invalid JSON Request'
+                    }
                 });
                 return;
             }
             const { data: req } = parsed;
             if (Array.isArray(req)) {
-                logger.trace({ req }, 'Received batch request');
+                logger.trace({
+                    req
+                }, 'Received batch request');
                 const resp = await Promise.all(req.map(processRequest));
                 send(resp);
-            }
-            else {
-                logger.trace({ req }, 'Received single request');
+            } else {
+                logger.trace({
+                    req
+                }, 'Received single request');
                 const resp = await processRequest(req);
                 send(resp);
             }
@@ -149,16 +168,15 @@ export const createServer = async (handler, port) => {
     });
     return {
         port: listenPort,
-        close: () => new Promise((resolve, reject) => {
-            wss?.clients.forEach((socket) => socket.close());
-            wss?.close((err) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    resolve();
-                }
-            });
-        }),
+        close: ()=>new Promise((resolve, reject)=>{
+                wss?.clients.forEach((socket)=>socket.close());
+                wss?.close((err)=>{
+                    if (err) {
+                        reject(err);
+                    } else {
+                        resolve();
+                    }
+                });
+            })
     };
 };

package/dist/esm/setup-with-server.js

@@ -1,8 +1,8 @@
-import { createServer } from './server';
-import { handler } from './rpc';
+import { createServer } from './server.js';
+import { handler } from './rpc/index.js';
 import { logger } from '@acala-network/chopsticks-core';
-import { setupContext } from './context';
-export const setupWithServer = async (argv) => {
+import { setupContext } from './context.js';
+export const setupWithServer = async (argv)=>{
     const context = await setupContext(argv);
     const port = argv.port ?? 8000;
     if (argv.genesis) {
@@ -14,9 +14,9 @@ export const setupWithServer = async (argv) => {
     return {
         ...context,
         listenPort,
-        async close() {
+        async close () {
             await context.chain.close();
             await close();
-        },
+        }
     };
 };

package/dist/esm/types.js

@@ -1,2 +1,13 @@
-export * from '@acala-network/chopsticks-core/src/rpc/substrate';
-export * from './plugins/types';
+/**
+ * Chopsticks JSON RPC and CLI.
+ *
+ * @remarks
+ * This package extends the `@acala-network/chopsticks-core` package a with JSON RPC server and CLI support.
+ *
+ * @privateRemarks
+ * Above is the package documentation for 'chopsticks' package.
+ * `export` below is for tsdoc.
+ *
+ * @packageDocumentation
+ */ export * from '@acala-network/chopsticks-core/rpc/substrate/index.js';
+export * from './plugins/types.js';

package/dist/esm/utils/decoder.js

@@ -2,14 +2,22 @@ import { decodeBlockStorageDiff } from '@acala-network/chopsticks-core';
 import { create } from 'jsondiffpatch';
 import _ from 'lodash';
 const diffPatcher = create({
-    array: { detectMove: false },
-    textDiff: { minLength: Number.MAX_VALUE }, // skip text diff
+    array: {
+        detectMove: false
+    },
+    textDiff: {
+        minLength: Number.MAX_VALUE
+    }
 });
-export const decodeStorageDiff = async (block, diff) => {
+export const decodeStorageDiff = async (block, diff)=>{
     const [oldState, newState] = await decodeBlockStorageDiff(block, diff);
     const oldStateWithoutEvents = _.cloneDeep(oldState);
     if (oldStateWithoutEvents['system']?.['events']) {
         oldStateWithoutEvents['system']['events'] = [];
     }
-    return { oldState, newState, delta: diffPatcher.diff(oldStateWithoutEvents, newState) };
+    return {
+        oldState,
+        newState,
+        delta: diffPatcher.diff(oldStateWithoutEvents, newState)
+    };
 };

package/dist/esm/utils/generate-html-diff.js

@@ -1,15 +1,19 @@
-import { decodeStorageDiff } from './decoder';
+import { decodeStorageDiff } from './decoder.js';
 import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
 import _ from 'lodash';
-import url from 'node:url';
-export const generateHtmlDiff = async (block, diff) => {
+export const generateHtmlDiff = async (block, diff)=>{
     const { oldState, delta } = await decodeStorageDiff(block, diff);
-    const htmlTemplate = readFileSync(url.resolve(__filename, './template/diff.html'), 'utf-8');
-    return _.template(htmlTemplate)({ left: JSON.stringify(oldState), delta: JSON.stringify(delta) });
+    const htmlTemplate = readFileSync(new URL('template/diff.html', import.meta.url), 'utf-8');
+    return _.template(htmlTemplate)({
+        left: JSON.stringify(oldState),
+        delta: JSON.stringify(delta)
+    });
 };
-export const generateHtmlDiffPreviewFile = async (block, diff, filename) => {
+export const generateHtmlDiffPreviewFile = async (block, diff, filename)=>{
     const html = await generateHtmlDiff(block, diff);
-    mkdirSync('./preview', { recursive: true });
+    mkdirSync('./preview', {
+        recursive: true
+    });
     const filePath = `./preview/${filename}.html`;
     writeFileSync(filePath, html);
     return filePath;

package/dist/esm/utils/index.js

@@ -1,4 +1,4 @@
-export * from './decoder';
-export * from './generate-html-diff';
-export * from './open-html';
-export * from './override';
+export * from './decoder.js';
+export * from './generate-html-diff.js';
+export * from './open-html.js';
+export * from './override.js';

package/dist/esm/utils/open-html.js

@@ -1,5 +1,5 @@
 import { execSync } from 'node:child_process';
-export const openHtml = (filePath) => {
+export const openHtml = (filePath)=>{
     const start = process.platform == 'darwin' ? 'open' : process.platform == 'win32' ? 'start' : 'xdg-open';
     execSync(start + ' ' + filePath);
 };

package/dist/esm/utils/override.js

@@ -1,24 +1,25 @@
 import { setStorage } from '@acala-network/chopsticks-core';
 import { existsSync, readFileSync } from 'node:fs';
 import yaml from 'js-yaml';
-import { defaultLogger } from '../logger';
-export const overrideStorage = async (chain, storage, at) => {
+import { defaultLogger } from '../logger.js';
+export const overrideStorage = async (chain, storage, at)=>{
     if (storage == null) {
         return;
     }
     let storageValue;
     if (typeof storage === 'string') {
-        if (!existsSync(storage))
-            throw Error(`File ${storage} does not exist`);
+        if (!existsSync(storage)) throw Error(`File ${storage} does not exist`);
         storageValue = yaml.load(String(readFileSync(storage)));
-    }
-    else {
+    } else {
         storageValue = storage;
     }
     const blockHash = await setStorage(chain, storageValue, at);
-    defaultLogger.trace({ blockHash, storage }, 'OverrideStorage');
+    defaultLogger.trace({
+        blockHash,
+        storage
+    }, 'OverrideStorage');
 };
-export const overrideWasm = async (chain, wasmPath, at) => {
+export const overrideWasm = async (chain, wasmPath, at)=>{
     if (wasmPath == null) {
         return;
     }
@@ -27,17 +28,14 @@ export const overrideWasm = async (chain, wasmPath, at) => {
     if (wasm.at(0) === 0x30 && wasm.at(1) === 0x78) {
         // starts with 0x
         wasmHex = wasm.toString().trim();
-    }
-    else {
+    } else {
         wasmHex = '0x' + wasm.toString('hex');
     }
     if (at) {
         const block = await chain.getBlock(at);
-        if (!block)
-            throw new Error(`Cannot find block ${at}`);
+        if (!block) throw new Error(`Cannot find block ${at}`);
         block.setWasm(wasmHex);
-    }
-    else {
+    } else {
         chain.head.setWasm(wasmHex);
     }
 };

package/dist/esm/utils/tunnel.js

@@ -1,11 +1,4 @@
 import 'global-agent/bootstrap';
 import npmConf from '@pnpm/npm-conf';
 const npmConfig = npmConf().config;
-global.GLOBAL_AGENT.HTTP_PROXY =
-    process.env.HTTP_PROXY ||
-        process.env.http_proxy ||
-        process.env.HTTPS_PROXY ||
-        process.env.https_proxy ||
-        npmConfig.get('proxy') ||
-        npmConfig.get('https-proxy') ||
-        global.GLOBAL_AGENT.HTTP_PROXY;
+global.GLOBAL_AGENT.HTTP_PROXY = process.env.HTTP_PROXY || process.env.http_proxy || process.env.HTTPS_PROXY || process.env.https_proxy || npmConfig.get('proxy') || npmConfig.get('https-proxy') || global.GLOBAL_AGENT.HTTP_PROXY;

package/dist/types/context.d.ts

@@ -1,6 +1,6 @@
-import './utils/tunnel';
+import './utils/tunnel.js';
 import { GenesisProvider } from '@acala-network/chopsticks-core';
-import { Config } from './schema';
+import { Config } from './schema/index.js';
 export declare const genesisFromUrl: (url: string) => Promise<GenesisProvider>;
 export declare const setupContext: (argv: Config, overrideParent?: boolean) => Promise<{
     chain: import("@acala-network/chopsticks-core").Blockchain;

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 import '@polkadot/api-augment';
 export * from '@acala-network/chopsticks-core';
-export { setupWithServer } from './setup-with-server';
-export { fetchConfig } from './schema';
+export { setupWithServer } from './setup-with-server.js';
+export { fetchConfig } from './schema/index.js';

package/dist/types/plugins/dry-run/dry-run-extrinsic.d.ts

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

package/dist/types/plugins/dry-run/dry-run-preimage.d.ts

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

package/dist/types/plugins/dry-run/index.d.ts

@@ -1,2 +1,2 @@
-export * from './cli';
-export * from './rpc';
+export * from './cli.js';
+export * from './rpc.js';

package/dist/types/plugins/run-block/index.d.ts

@@ -52,7 +52,7 @@ export interface RunBlockParams {
      */
     includeBlockDetails: Params['includeBlockDetails'];
     /**
-     * The parent block hash to run on top of. Deafult to chain head.
+     * The parent block hash to run on top of. Default to chain head.
      */
     parent: Params['parent'];
     /**

package/dist/types/plugins/types.d.ts

@@ -1,11 +1,11 @@
-export { rpc as newBlock } from './new-block';
-export { rpc as dryRun } from './dry-run';
-export { rpc as setBlockBuildMode } from './set-block-build-mode';
-export { rpc as setHead } from './set-head';
-export { rpc as setRuntimeLogLevel } from './set-runtime-log-level';
-export { rpc as setStorage } from './set-storage';
-export { rpc as timeTravel } from './time-travel';
-export { rpc as runBlock } from './run-block';
-export type { NewBlockParams } from './new-block';
-export type { DryRunParams } from './dry-run';
-export type { RunBlockParams } from './run-block';
+export { rpc as newBlock } from './new-block/index.js';
+export { rpc as dryRun } from './dry-run/index.js';
+export { rpc as setBlockBuildMode } from './set-block-build-mode/index.js';
+export { rpc as setHead } from './set-head/index.js';
+export { rpc as setRuntimeLogLevel } from './set-runtime-log-level/index.js';
+export { rpc as setStorage } from './set-storage/index.js';
+export { rpc as timeTravel } from './time-travel/index.js';
+export { rpc as runBlock } from './run-block/index.js';
+export type { NewBlockParams } from './new-block/index.js';
+export type { DryRunParams } from './dry-run/index.js';
+export type { RunBlockParams } from './run-block/index.js';

package/dist/types/setup-with-server.d.ts

@@ -1,4 +1,4 @@
-import { Config } from './schema';
+import { Config } from './schema/index.js';
 export declare const setupWithServer: (argv: Config) => Promise<{
     listenPort: number;
     close(): Promise<void>;

package/dist/types/types.d.ts

@@ -11,5 +11,5 @@
  * @packageDocumentation
  */
 export type { ChainProperties, RuntimeVersion, Context, SubscriptionManager, Handler, } from '@acala-network/chopsticks-core';
-export * from '@acala-network/chopsticks-core/src/rpc/substrate';
-export * from './plugins/types';
+export * from '@acala-network/chopsticks-core/rpc/substrate/index.js';
+export * from './plugins/types.js';

package/dist/types/utils/index.d.ts

@@ -1,4 +1,4 @@
-export * from './decoder';
-export * from './generate-html-diff';
-export * from './open-html';
-export * from './override';
+export * from './decoder.js';
+export * from './generate-html-diff.js';
+export * from './open-html.js';
+export * from './override.js';

package/package.json

@@ -1,25 +1,21 @@
 {
   "name": "@acala-network/chopsticks",
-  "version": "0.9.1-2",
+  "version": "0.9.1-4",
   "author": "Acala Developers <hello@acala.network>",
   "license": "Apache-2.0",
-  "bin": "./chopsticks.js",
+  "bin": "./chopsticks.cjs",
+  "type": "module",
   "scripts": {
     "clean": "rm -rf dist",
-    "build": "yarn clean && tsc -p ./tsconfig.json && tsc -p ./tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./dist/esm/package.json && yarn copyfiles",
-    "copyfiles": "cp -r src/utils/template dist/cjs/utils/ && cp -r src/utils/template dist/esm/utils/",
-    "script:start": "cd ../..; ts-node --transpile-only -r tsconfig-paths/register packages/chopsticks/src/cli.ts",
-    "script:run": "cd ../..; LOG_LEVEL=trace ts-node-dev --transpile-only -r tsconfig-paths/register --inspect --notify=false packages/chopsticks/src/cli.ts -- --config=configs/dev.yml",
-    "dev:karura": "cd ../..; ts-node-dev --transpile-only --inspect -r tsconfig-paths/register --notify=false packages/chopsticks/src/cli.ts -- --config=configs/karura.yml",
-    "dev:acala": "cd ../..; ts-node-dev --transpile-only --inspect -r tsconfig-paths/register --notify=false packages/chopsticks/src/cli.ts -- --config=configs/acala.yml",
-    "dev:polkadot": "cd ../..; ts-node-dev --transpile-only --inspect -r tsconfig-paths/register --notify=false packages/chopsticks/src/cli.ts -- --config=configs/polkadot.yml",
-    "dev:moonriver": "cd ../..; ts-node-dev --transpile-only --inspect -r tsconfig-paths/register --notify=false packages/chopsticks/src/cli.ts -- --config=configs/moonriver.yml",
-    "dev:moonbeam": "cd ../..; ts-node-dev --transpile-only --inspect -r tsconfig-paths/register --notify=false packages/chopsticks/src/cli.ts -- --config=configs/moonbeam.yml",
+    "build": "yarn clean && yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:cjs": "swc ./src --config-file ../../.cjsswcrc -d dist/cjs --copy-files && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
+    "build:esm": "swc ./src --config-file ../../.esmswcrc -d dist/esm --copy-files",
+    "build:types": "tsc -p tsconfig.json --emitDeclarationOnly --outDir dist/types",
     "docs:prep": "typedoc"
   },
   "dependencies": {
-    "@acala-network/chopsticks-core": "0.9.1-2",
-    "@acala-network/chopsticks-db": "0.9.1-2",
+    "@acala-network/chopsticks-core": "0.9.1-4",
+    "@acala-network/chopsticks-db": "0.9.1-4",
     "@pnpm/npm-conf": "^2.2.2",
     "axios": "^1.6.0",
     "dotenv": "^16.3.1",
@@ -32,21 +28,21 @@
     "zod": "^3.22.3"
   },
   "devDependencies": {
+    "@swc/cli": "0.1.62",
+    "@swc/core": "^1.3.96",
     "@types/global-agent": "^2.1.1",
     "@types/js-yaml": "^4.0.5",
     "@types/lodash": "^4.14.199",
     "@types/node": "^20.5.7",
     "@types/ws": "^8.5.6",
     "@types/yargs": "^17.0.29",
-    "ts-node": "^10.9.1",
-    "ts-node-dev": "^2.0.0",
     "typescript": "^5.1.6"
   },
   "files": [
     "dist/esm/**",
     "dist/cjs/**",
     "dist/types/**",
-    "chopsticks.js"
+    "chopsticks.cjs"
   ],
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -59,10 +55,10 @@
       "default": "./dist/esm/index.js"
     },
     "./*": {
-      "types": "./dist/types/index.d.ts",
-      "require": "./dist/cjs/index.js",
-      "import": "./dist/esm/index.js",
-      "default": "./dist/esm/index.js"
+      "types": "./dist/types/*.d.ts",
+      "require": "./dist/cjs/*.js",
+      "import": "./dist/esm/*.js",
+      "default": "./dist/esm/*.js"
     },
     "./plugins/*": {
       "types": "./dist/types/plugins/*.d.ts",
@@ -71,6 +67,6 @@
       "default": "./dist/esm/plugins/*.js"
     },
     "./package.json": "./package.json",
-    "./package.esm.json": "./dist/esm/package.json"
+    "./package.cjs.json": "./dist/cjs/package.json"
   }
 }

package/dist/esm/package.json

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