Usage cleanups (#487)

package.json

@@ -39,7 +39,7 @@
     "test": "yarn run:api --help && yarn run:json --help && yarn run:metadata --help && yarn run:monitor --help && yarn run:signer --help && yarn run:vanity --help"
   },
   "devDependencies": {
-    "@polkadot/dev": "^0.72.39",
+    "@polkadot/dev": "^0.72.43",
     "@types/node": "^18.15.11",
     "@types/yargs": "^17.0.24"
   },

packages/api-cli/src/runcli.ts

@@ -13,13 +13,10 @@ import { hideBin } from 'yargs/helpers';
 
 import { ApiPromise, SubmittableResult, WsProvider } from '@polkadot/api';
 import { Keyring } from '@polkadot/keyring';
-import { assert, isFunction, stringify } from '@polkadot/util';
+import { assert, isCodec, stringify } from '@polkadot/util';
 
 import { hexMiddleware, jsonMiddleware, parseParams } from './cli.js';
 
-type ApiOptionsTypes = ApiOptions['types'];
-type ApiOptionsRpc = ApiOptions['rpc'];
-
 // the function signature for our catch-any result logger
 // eslint-disable-next-line no-use-before-define
 type LogFn = (result: SubmittableResult | Codec | ApiCallFn) => void;
@@ -166,45 +163,43 @@ const params = parseParams(paramsInline, paramsFile);
 
 const ALLOWED = ['consts', 'derive', 'query', 'rpc', 'tx'];
 
-function readFile <T> (src: string): T {
+function readFile <T> (src: string): NonNullable<T> {
   if (!src) {
-    return {} as T;
+    return {} as NonNullable<T>;
   }
 
   assert(fs.existsSync(src), `Unable to read .json file at ${src}`);
 
-  return JSON.parse(fs.readFileSync(src, 'utf8')) as T;
+  return JSON.parse(fs.readFileSync(src, 'utf8')) as NonNullable<T>;
 }
 
 // parse the arguments and retrieve the details of what we want to do
 async function getCallInfo (): Promise<CallInfo> {
   assert(endpoint && endpoint.includes('.'), 'You need to specify the command to execute, e.g. query.system.account');
 
-  const rpc: ApiOptionsRpc = readFile(argv.rpc);
-  const types: ApiOptionsTypes = readFile(argv.types);
+  const rpc = readFile<ApiOptions['rpc']>(argv.rpc);
+  const types = readFile<ApiOptions['types']>(argv.types);
   const provider = new WsProvider(ws);
   const api = await ApiPromise.create({ provider, rpc, types });
   const apiExt = (api as unknown) as ApiExt;
   const [type, section, method] = endpoint.split('.') as [keyof ApiExt, string, string];
 
   assert(ALLOWED.includes(type), `Expected one of ${ALLOWED.join(', ')}, found ${type}`);
   assert(apiExt[type][section], `Cannot find ${type}.${section}, your chain does not have the ${section} pallet exposed in the runtime`);
-  assert(apiExt[type][section][method], `Cannot find ${type}.${section}.${method}, your chain doesn't have the ${method} exposed in the ${section} pallet`);
 
   const fn = apiExt[type][section][method];
 
+  assert(fn, `Cannot find ${type}.${section}.${method}, your chain doesn't have the ${method} exposed in the ${section} pallet`);
+
   return {
     api,
     fn,
     log: (result: SubmittableResult | Codec | ApiCallFn): void =>
-      console.log(
-        stringify({
-          // eslint-disable-next-line @typescript-eslint/unbound-method
-          [method]: isFunction((result as Codec).toHuman)
-            ? (result as Codec).toHuman()
-            : result
-        }, 2)
-      ),
+      console.log(stringify({
+        [method]: isCodec(result)
+          ? (result as Codec).toHuman()
+          : result
+      }, 2)),
     method,
     section,
     type

packages/json-serve/package.json

@@ -26,7 +26,7 @@
     "@polkadot/api-derive": "^10.3.2",
     "@polkadot/types": "^10.3.2",
     "@polkadot/util": "^11.1.3",
-    "koa": "^2.14.1",
+    "koa": "^2.14.2",
     "koa-route": "^3.2.0",
     "tslib": "^2.5.0",
     "yargs": "^17.7.1"

packages/monitor-rpc/package.json

@@ -24,7 +24,7 @@
     "@polkadot/api": "^10.3.2",
     "@polkadot/types": "^10.3.2",
     "@polkadot/util": "^11.1.3",
-    "koa": "^2.14.1",
+    "koa": "^2.14.2",
     "koa-route": "^3.2.0",
     "tslib": "^2.5.0",
     "yargs": "^17.7.1"

packages/vanitygen/src/runcli.ts

@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { KeypairType } from '@polkadot/util-crypto/types';
-import type { GeneratorOptions } from './types.js';
+import type { GeneratorMatch, GeneratorOptions } from './types.js';
 
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
@@ -14,12 +14,7 @@ import { cryptoWaitReady } from '@polkadot/util-crypto';
 import generator from './generator.js';
 import matchRegex from './regex.js';
 
-interface Best {
-  address: string;
-  count: number;
-  mnemonic?: string;
-  offset: number;
-  seed?: Uint8Array;
+interface Best extends GeneratorMatch {
   withCase?: boolean;
 }
 

packages/vanitygen/src/types.ts

@@ -11,7 +11,7 @@ export interface GeneratorCalculation {
 export interface GeneratorMatch extends GeneratorCalculation {
   address: string;
   mnemonic?: string;
-  seed: Uint8Array;
+  seed?: Uint8Array;
 }
 
 export type GeneratorMatches = GeneratorMatch[];