@acala-network/chopsticks 0.10.1 → 0.11.0

package/dist/cjs/cli.js

@@ -17,6 +17,9 @@ function _interop_require_default(obj) {
 }
 (0, _dotenv.config)();
 const processArgv = async (argv)=>{
+    if (argv.unsafeRpcMethods) {
+        await (0, _index1.loadRpcMethodsByScripts)(argv.unsafeRpcMethods);
+    }
     if (argv.config) {
         Object.assign(argv, _lodash.default.defaults(argv, await (0, _index.fetchConfig)(argv.config)));
     }
@@ -52,7 +55,7 @@ const commands = (0, _yargs.default)((0, _helpers.hideBin)(process.argv)).script
             await (0, _chopstickscore.connectVertical)(relaychain, parachain);
         }
     }
-}).strict().help().alias('help', 'h').alias('version', 'v').alias('config', 'c').alias('endpoint', 'e').alias('port', 'p').alias('block', 'b').alias('import-storage', 's').alias('wasm-override', 'w').usage('Usage: $0 <command> [options]').example('$0', '-c acala');
+}).strict().help().alias('help', 'h').alias('version', 'v').alias('config', 'c').alias('endpoint', 'e').alias('port', 'p').alias('block', 'b').alias('unsafe-rpc-methods', 'ur').alias('import-storage', 's').alias('wasm-override', 'w').usage('Usage: $0 <command> [options]').example('$0', '-c acala');
 if (!_chopstickscore.environment.DISABLE_PLUGINS) {
     (0, _index1.pluginExtendCli)(commands.config('config', 'Path to config file with default options', ()=>({}))).then(()=>commands.parse());
 } else {

package/dist/cjs/plugins/index.d.ts

@@ -2,5 +2,7 @@ import { Handlers } from '@acala-network/chopsticks-core';
 import type { Argv } from 'yargs';
 export declare const rpcPluginHandlers: Handlers;
 export declare const rpcPluginMethods: string[];
-export declare const loadRpcPlugin: (method: string) => Promise<any>;
+export declare const loadRpcMethodsByScripts: (path: string) => Promise<void>;
+export declare const getRpcExtensionMethods: () => string[];
+export declare const loadRpcExtensionMethod: (method: string) => Promise<any>;
 export declare const pluginExtendCli: (y: Argv) => Promise<void>;

package/dist/cjs/plugins/index.js

@@ -9,8 +9,14 @@ function _export(target, all) {
     });
 }
 _export(exports, {
-    loadRpcPlugin: function() {
-        return loadRpcPlugin;
+    getRpcExtensionMethods: function() {
+        return getRpcExtensionMethods;
+    },
+    loadRpcExtensionMethod: function() {
+        return loadRpcExtensionMethod;
+    },
+    loadRpcMethodsByScripts: function() {
+        return loadRpcMethodsByScripts;
     },
     pluginExtendCli: function() {
         return pluginExtendCli;
@@ -26,6 +32,7 @@ const _chopstickscore = require("@acala-network/chopsticks-core");
 const _fs = require("fs");
 const _lodash = /*#__PURE__*/ _interop_require_default(require("lodash"));
 const _logger = require("../logger.js");
+const _path = require("path");
 function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
@@ -93,6 +100,27 @@ const loadRpcPlugin = async (method)=>{
     logger.debug(`Registered plugin ${plugin} RPC`);
     return rpc;
 };
+// store the loaded methods by cli
+let rpcScriptMethods = {};
+const loadRpcMethodsByScripts = async (path)=>{
+    try {
+        const scriptContent = (0, _fs.readFileSync)((0, _path.resolve)(path), 'utf8');
+        rpcScriptMethods = new Function(scriptContent)();
+        logger.info(`${Object.keys(rpcScriptMethods).length} extension rpc methods loaded from ${path}`);
+    } catch (error) {
+        console.log('Failed to load rpc extension methods');
+    }
+};
+const getRpcExtensionMethods = ()=>{
+    return [
+        ...Object.keys(rpcScriptMethods),
+        ...rpcPluginMethods
+    ];
+};
+const loadRpcExtensionMethod = async (method)=>{
+    if (rpcScriptMethods[method]) return rpcScriptMethods[method];
+    return loadRpcPlugin(method);
+};
 const pluginExtendCli = async (y)=>{
     for (const plugin of plugins){
         const location = new URL(`${plugin}/index.js`, require("url").pathToFileURL(__filename).toString());

package/dist/cjs/rpc/index.js

@@ -19,15 +19,15 @@ const allHandlers = {
             version: 1,
             methods: [
                 ...Object.keys(allHandlers),
-                ..._index.rpcPluginMethods
+                ...(0, _index.getRpcExtensionMethods)()
             ].sort()
         })
 };
 const getHandler = async (method)=>{
     const handler = allHandlers[method];
     if (!handler) {
-        // no handler for this method, check if it's a plugin
-        return (0, _index.loadRpcPlugin)(method);
+        // no handler for this method, check if it's a plugin or a script loaded
+        return (0, _index.loadRpcExtensionMethod)(method);
     }
     return handler;
 };

package/dist/esm/cli.js

@@ -4,10 +4,13 @@ import _ from 'lodash';
 import yargs from 'yargs';
 import { connectParachains, connectVertical, environment } from '@acala-network/chopsticks-core';
 import { configSchema, fetchConfig, getYargsOptions } from './schema/index.js';
-import { pluginExtendCli } from './plugins/index.js';
+import { loadRpcMethodsByScripts, pluginExtendCli } from './plugins/index.js';
 import { setupWithServer } from './index.js';
 dotenvConfig();
 const processArgv = async (argv)=>{
+    if (argv.unsafeRpcMethods) {
+        await loadRpcMethodsByScripts(argv.unsafeRpcMethods);
+    }
     if (argv.config) {
         Object.assign(argv, _.defaults(argv, await fetchConfig(argv.config)));
     }
@@ -43,7 +46,7 @@ const commands = yargs(hideBin(process.argv)).scriptName('chopsticks').middlewar
             await connectVertical(relaychain, parachain);
         }
     }
-}).strict().help().alias('help', 'h').alias('version', 'v').alias('config', 'c').alias('endpoint', 'e').alias('port', 'p').alias('block', 'b').alias('import-storage', 's').alias('wasm-override', 'w').usage('Usage: $0 <command> [options]').example('$0', '-c acala');
+}).strict().help().alias('help', 'h').alias('version', 'v').alias('config', 'c').alias('endpoint', 'e').alias('port', 'p').alias('block', 'b').alias('unsafe-rpc-methods', 'ur').alias('import-storage', 's').alias('wasm-override', 'w').usage('Usage: $0 <command> [options]').example('$0', '-c acala');
 if (!environment.DISABLE_PLUGINS) {
     pluginExtendCli(commands.config('config', 'Path to config file with default options', ()=>({}))).then(()=>commands.parse());
 } else {

package/dist/esm/plugins/index.d.ts

@@ -2,5 +2,7 @@ import { Handlers } from '@acala-network/chopsticks-core';
 import type { Argv } from 'yargs';
 export declare const rpcPluginHandlers: Handlers;
 export declare const rpcPluginMethods: string[];
-export declare const loadRpcPlugin: (method: string) => Promise<any>;
+export declare const loadRpcMethodsByScripts: (path: string) => Promise<void>;
+export declare const getRpcExtensionMethods: () => string[];
+export declare const loadRpcExtensionMethod: (method: string) => Promise<any>;
 export declare const pluginExtendCli: (y: Argv) => Promise<void>;

package/dist/esm/plugins/index.js

@@ -1,7 +1,8 @@
 import { environment } from '@acala-network/chopsticks-core';
-import { lstatSync, readdirSync } from 'fs';
+import { lstatSync, readFileSync, readdirSync } from 'fs';
 import _ from 'lodash';
 import { defaultLogger } from '../logger.js';
+import { resolve } from 'path';
 const logger = defaultLogger.child({
     name: 'plugin'
 });
@@ -10,7 +11,7 @@ export const rpcPluginHandlers = {};
 const plugins = readdirSync(new URL('.', import.meta.url)).filter((file)=>lstatSync(new URL(file, import.meta.url)).isDirectory());
 // find all rpc methods
 export const rpcPluginMethods = plugins.filter((name)=>readdirSync(new URL(name, import.meta.url)).some((file)=>file.startsWith('rpc'))).map((name)=>`dev_${_.camelCase(name)}`);
-export const loadRpcPlugin = async (method)=>{
+const loadRpcPlugin = async (method)=>{
     if (environment.DISABLE_PLUGINS) {
         return undefined;
     }
@@ -24,6 +25,28 @@ export const loadRpcPlugin = async (method)=>{
     logger.debug(`Registered plugin ${plugin} RPC`);
     return rpc;
 };
+// store the loaded methods by cli
+let rpcScriptMethods = {};
+// use cli to load rpc methods of external scripts
+export const loadRpcMethodsByScripts = async (path)=>{
+    try {
+        const scriptContent = readFileSync(resolve(path), 'utf8');
+        rpcScriptMethods = new Function(scriptContent)();
+        logger.info(`${Object.keys(rpcScriptMethods).length} extension rpc methods loaded from ${path}`);
+    } catch (error) {
+        console.log('Failed to load rpc extension methods');
+    }
+};
+export const getRpcExtensionMethods = ()=>{
+    return [
+        ...Object.keys(rpcScriptMethods),
+        ...rpcPluginMethods
+    ];
+};
+export const loadRpcExtensionMethod = async (method)=>{
+    if (rpcScriptMethods[method]) return rpcScriptMethods[method];
+    return loadRpcPlugin(method);
+};
 export const pluginExtendCli = async (y)=>{
     for (const plugin of plugins){
         const location = new URL(`${plugin}/index.js`, import.meta.url);

package/dist/esm/rpc/index.js

@@ -1,5 +1,5 @@
 import { ResponseError, allHandlers as coreHandlers, defaultLogger } from '@acala-network/chopsticks-core';
-import { loadRpcPlugin, rpcPluginMethods } from '../plugins/index.js';
+import { getRpcExtensionMethods, loadRpcExtensionMethod } from '../plugins/index.js';
 const rpcLogger = defaultLogger.child({
     name: 'rpc'
 });
@@ -9,15 +9,15 @@ const allHandlers = {
             version: 1,
             methods: [
                 ...Object.keys(allHandlers),
-                ...rpcPluginMethods
+                ...getRpcExtensionMethods()
             ].sort()
         })
 };
 const getHandler = async (method)=>{
     const handler = allHandlers[method];
     if (!handler) {
-        // no handler for this method, check if it's a plugin
-        return loadRpcPlugin(method);
+        // no handler for this method, check if it's a plugin or a script loaded
+        return loadRpcExtensionMethod(method);
     }
     return handler;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acala-network/chopsticks",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "author": "Acala Developers <hello@acala.network>",
   "license": "Apache-2.0",
   "bin": "./chopsticks.cjs",
@@ -13,8 +13,8 @@
     "docs:prep": "typedoc"
   },
   "dependencies": {
-    "@acala-network/chopsticks-core": "0.10.1",
-    "@acala-network/chopsticks-db": "0.10.1",
+    "@acala-network/chopsticks-core": "0.11.0",
+    "@acala-network/chopsticks-db": "0.11.0",
     "@pnpm/npm-conf": "^2.2.2",
     "@polkadot/api-augment": "^10.11.2",
     "@polkadot/types": "^10.11.2",