[CI Skip] release/stable 6.3.1

skip-checks: true

.123trigger

@@ -1,13 +1,17 @@
-6
+7
+
 2.6.2
 2.12.2
 5.2.2
 5.2.3
-
 5.4.2
 5.4.3
 5.4.4
 5.5.2
 5.6.2
 5.6.3
-5.9.2
+5.9.2
+6.0.2
+6.0.3
+6.0.4
+6.0.5

.codeclimate.yml

@@ -1,5 +1,5 @@
 exclude_patterns:
 - "**/*.spec.js"
 - "**/*.spec.ts"
-- "packages/networks/src/index.ts"
+- "packages/networks/src/substrate.ts"
 - "packages/util/src/is/utf8.ts"

.github/ss58-check.md

@@ -5,6 +5,6 @@ labels: ['ci', '@networks']
 
 cc @polkadot-js/notifications
 
-Discrepancies detected between https://github.com/paritytech/substrate/blob/master/ss58-registry.json and https://github.com/polkadot-js/common/blob/master/packages/networks/src/index.ts
+Discrepancies detected between https://github.com/paritytech/substrate/blob/master/ss58-registry.json and https://github.com/polkadot-js/common/blob/master/packages/networks/src/substrate.ts
 
-Check the nightly cron output or run `yarn networks:crosscheck` locally. The output as found from the test includes:
+Check the nightly cron output (or via `yarn networks:crosscheck` locally) and run `yarn networks:sync` to update. The output as found from the test includes:

.github/workflows/pr-any.yml

@@ -5,7 +5,7 @@ jobs:
   pr:
     strategy:
       matrix:
-        step: ['lint', 'test', 'build', 'networks:crosscheck']
+        step: ['lint', 'test', 'build']
     name: ${{ matrix.step }}
     runs-on: ubuntu-latest
     steps:

.nvmrc

@@ -1 +0,0 @@
-12

.yarnrc.yml

@@ -10,4 +10,4 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
     spec: "@yarnpkg/plugin-version"
 
-yarnPath: .yarn/releases/yarn-2.4.0.cjs
+yarnPath: .yarn/releases/yarn-2.4.1.cjs

CHANGELOG.md

@@ -1,5 +1,91 @@
 # CHANGELOG
 
+## 6.3.1 Apr 25, 2021
+
+Changes:
+
+- Added `stringify` util to correctly handle `JSON.stringify` with `BigInt` values
+- Additional input asserts for non-convertible values in `u8aToU8a`
+- Adapt `@polkadot/x-global` to return `globalThis` as available
+- Minor readability cleanups
+- BN manipulation via in-place shifts (as applicable)
+- Add explicit `engines` config to `package.json`
+
+
+## 6.2.1 Apr 18, 2021
+
+Contributed:
+
+- Added HydraDx genesis (Thanks to https://github.com/jak-pan)
+
+Changes:
+
+- Add `isAddress` and `validateAddress` functions (the latter will throw if invalid)
+- Check `@polkadot/hw-ledger` against `@polkadot/networks` for discrepancies (test-only)
+- Align ss58 registry with upstream Substrate
+
+
+## 6.1.1 Apr 11, 2021
+
+Contributed:
+
+- Adjust Polymath genesis in `@polkadot/networks` (Thanks to https://github.com/adamdossa)
+- Adjust `@polkadot/util` logger for +/-/* compat (Thanks to https://github.com/Lezek123)
+- Fix typo in `@polkadot/util` detect messaging (Thanks to https://github.com/amphineko)
+
+Changes:
+
+- Remove `@polkadot/networks` code duplication, manages data via script from upstream
+- Align ss58 registry with upstream Substrate
+
+
+## 6.0.5 Mar 8, 2021
+
+Changes:
+
+- Fix for `@polkadot/x-rxjs` in Node CJS environments (no Node-specific import)
+
+
+## 6.0.4 Mar 7, 2021
+
+Contributed:
+
+- Enhance check for global process existence (Thanks to https://github.com/Yuripetusko)
+
+Changes:
+
+- Dedupe & optimize logger process.env checks
+
+
+## 6.0.3 Mar 5, 2021
+
+Changes:
+
+- Add import indirection for both CJS & ESM (where generated source file is commonjs)
+
+
+## 6.0.2 Mar 5, 2021
+
+Changes:
+
+- Fix `@polkadot/x-rxjs` ESM exports for Node environments (now different due to the ESM conversion)
+
+
+## 6.0.1 Mar 5, 2021
+
+**Important** In the 6.0 version the default package type has been changed to ESM modules by default. This should not affect usage, however since the output formats changed, a new major version is required.
+
+Contributed:
+
+- Add dev addresses for Frontier-based chains (Thanks to https://github.com/joelamouche)
+
+Changes:
+
+- Build to ESM by default (with cjs versions via export map)
+- Allow addition or raw pairs on the keyring via `{add, create}FromPair`
+- Extract re-usable json encryption/decryption functions
+
+
 ## 5.9.2 Feb 28, 2021
 
 Changes:

jest.config.cjs

@@ -32,5 +32,5 @@ module.exports = Object.assign({}, config, {
     '<rootDir>/packages/x-textencoder/build',
     '<rootDir>/packages/x-ws/build'
   ],
-  resolver: '@polkadot/dev/config/jest-resolver.cjs'
+  transformIgnorePatterns: ['/node_modules/(?!@polkadot)']
 });

package.json

@@ -7,7 +7,7 @@
     "packages/*"
   ],
   "resolutions": {
-    "typescript": "^4.1.5"
+    "typescript": "^4.2.4"
   },
   "scripts": {
     "build": "polkadot-dev-build-ts",
@@ -15,15 +15,16 @@
     "lint": "polkadot-dev-run-lint",
     "clean": "polkadot-dev-clean-build",
     "networks:crosscheck": "polkadot-dev-run-test packages/networks/src/crosscheck",
+    "networks:sync": "node packages/networks/scripts/fromSubstrate.mjs",
     "postinstall": "polkadot-dev-yarn-only",
     "test": "polkadot-dev-run-test --coverage --runInBand --testPathIgnorePatterns crosscheck",
     "test:one": "polkadot-dev-run-test"
   },
   "devDependencies": {
-    "@babel/core": "^7.13.8",
-    "@polkadot/dev": "^0.61.30",
-    "@polkadot/ts": "^0.3.59",
-    "@types/jest": "^26.0.20"
+    "@babel/core": "^7.13.16",
+    "@polkadot/dev": "^0.62.10",
+    "@polkadot/ts": "^0.3.63",
+    "@types/jest": "^26.0.22"
   },
-  "version": "5.9.2"
+  "version": "6.3.1"
 }

packages/hw-ledger-transports/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@polkadot/hw-ledger-transports",
-  "version": "5.9.2",
+  "version": "6.3.1",
+  "type": "module",
   "repository": "github:polkadot-js/common",
   "author": "Jaco Greeff <jacogr@gmail.com>",
   "maintainers": [],
@@ -10,15 +11,18 @@
   "browser": "browser.js",
   "react-native": "react-native.js",
   "sideEffects": false,
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "dependencies": {
-    "@babel/runtime": "^7.13.8",
-    "@ledgerhq/hw-transport-webusb": "^5.43.0"
+    "@babel/runtime": "^7.13.17",
+    "@ledgerhq/hw-transport-webusb": "^5.49.0"
   },
   "devDependencies": {
     "@types/ledgerhq__hw-transport-node-hid": "^4.22.2",
     "@types/ledgerhq__hw-transport-webusb": "^4.70.1"
   },
   "optionalDependencies": {
-    "@ledgerhq/hw-transport-node-hid-singleton": "^5.43.0"
+    "@ledgerhq/hw-transport-node-hid-singleton": "^5.49.0"
   }
 }

packages/hw-ledger-transports/src/packageInfo.ts

@@ -1,6 +1,6 @@
-// Copyright 2017-2021 @polkadot/dev authors & contributors
+// Copyright 2017-2021 @polkadot/hw-ledger-transports authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 // Auto-generated by @polkadot/dev, do not edit
 
-export const packageInfo = { name: '@polkadot/hw-ledger-transports', version: '5.9.2' };
+export const packageInfo = { name: '@polkadot/hw-ledger-transports', version: '6.3.1' };

packages/hw-ledger/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@polkadot/hw-ledger",
-  "version": "5.9.2",
+  "version": "6.3.1",
+  "type": "module",
   "repository": "github:polkadot-js/common",
   "author": "Jaco Greeff <jacogr@gmail.com>",
   "maintainers": [],
@@ -9,12 +10,15 @@
   "main": "index.js",
   "sideEffects": [
     "./detectPackage.js",
-    "./detectPackage.mjs"
+    "./detectPackage.cjs"
   ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "dependencies": {
-    "@babel/runtime": "^7.13.8",
-    "@polkadot/hw-ledger-transports": "5.9.2",
-    "@polkadot/util": "^5.9.2",
-    "@zondax/ledger-polkadot": "^0.13.1"
+    "@babel/runtime": "^7.13.17",
+    "@polkadot/hw-ledger-transports": "6.3.1",
+    "@polkadot/util": "^6.3.1",
+    "@zondax/ledger-polkadot": "^0.13.6"
   }
 }

packages/hw-ledger/src/constants.ts

@@ -0,0 +1,10 @@
+// Copyright 2017-2021 @polkadot/hw-ledger authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export const LEDGER_DEFAULT_ACCOUNT = 0x80000000;
+
+export const LEDGER_DEFAULT_CHANGE = 0x80000000;
+
+export const LEDGER_DEFAULT_INDEX = 0x80000000;
+
+export const LEDGER_SUCCESS_CODE = 0x9000;

packages/hw-ledger/src/defaults.spec.ts

@@ -0,0 +1,24 @@
+// Copyright 2017-2021 @polkadot/hw-ledger authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { knownLedger } from '@polkadot/networks/defaults';
+
+import { ledgerApps } from './defaults';
+
+describe('defaults', (): void => {
+  it('has entries for each of the apps (hwledger -> networks)', (): void => {
+    expect(
+      Object.keys(knownLedger).filter((network) =>
+        !ledgerApps[network]
+      )
+    ).toEqual([]);
+  });
+
+  it('has entries for each of the apps (networks -> hwledger)', (): void => {
+    expect(
+      Object.keys(ledgerApps).filter((network) =>
+        !knownLedger[network]
+      )
+    ).toEqual([]);
+  });
+});

packages/hw-ledger/src/defaults.ts

@@ -0,0 +1,17 @@
+// Copyright 2017-2021 @polkadot/hw-ledger authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type Transport from '@ledgerhq/hw-transport';
+import type { SubstrateApp } from '@zondax/ledger-polkadot';
+
+import { newDockApp, newKusamaApp, newPolkadotApp, newPolymeshApp } from '@zondax/ledger-polkadot';
+
+// These match up with the network keys in the @polkadot/networks package
+// (which is turn aligns with the substrate/ss58-registry.json as the single
+// source of truth)
+export const ledgerApps: Record<string, (transport: Transport) => SubstrateApp> = {
+  'dock-mainnet': newDockApp,
+  kusama: newKusamaApp,
+  polkadot: newPolkadotApp,
+  polymesh: newPolymeshApp
+};

packages/hw-ledger/src/index.ts

@@ -3,35 +3,18 @@
 
 import './detectPackage';
 
-import type Transport from '@ledgerhq/hw-transport';
+import type { ResponseBase, SubstrateApp } from '@zondax/ledger-polkadot';
 import type { AccountOptions, LedgerAddress, LedgerSignature, LedgerTypes, LedgerVersion } from './types';
 
-import { newDockApp, newKusamaApp, newPolkadotApp, newPolymeshApp, ResponseBase, SubstrateApp } from '@zondax/ledger-polkadot';
-
 import { transports } from '@polkadot/hw-ledger-transports';
 import { assert, u8aToBuffer } from '@polkadot/util';
 
+import { LEDGER_DEFAULT_ACCOUNT, LEDGER_DEFAULT_CHANGE, LEDGER_DEFAULT_INDEX, LEDGER_SUCCESS_CODE } from './constants';
+import { ledgerApps } from './defaults';
+
 export { packageInfo } from './packageInfo';
 
-export const LEDGER_DEFAULT_ACCOUNT = 0x80000000;
-
-export const LEDGER_DEFAULT_CHANGE = 0x80000000;
-
-export const LEDGER_DEFAULT_INDEX = 0x80000000;
-
-const SUCCESS_CODE = 0x9000;
-
-// These match up with the network keys in the @polkadot/networks package
-// (which is turn aligns with the substrate/ss58-registry.json as the single
-// source of truth)
-const APPS: Record<string, (transport: Transport) => SubstrateApp> = {
-  dock: newDockApp,
-  kusama: newKusamaApp,
-  polkadot: newPolkadotApp,
-  polymesh: newPolymeshApp
-};
-
-type Chain = keyof typeof APPS;
+type Chain = keyof typeof ledgerApps;
 
 // A very basic wrapper for a ledger app -
 //  - it connects automatically, creating an app as required
@@ -45,8 +28,8 @@ export class Ledger {
 
   constructor (transport: LedgerTypes, chain: Chain) {
     // u2f is deprecated
-    assert(['hid', 'webusb'].includes(transport), `Unsupported transport ${transport}`);
-    assert(Object.keys(APPS).includes(chain), `Unsupported chain ${chain}`);
+    assert(['hid', 'webusb'].includes(transport), () => `Unsupported transport ${transport}`);
+    assert(Object.keys(ledgerApps).includes(chain), () => `Unsupported chain ${chain}`);
 
     this.#chain = chain;
     this.#transport = transport;
@@ -90,11 +73,11 @@ export class Ledger {
     if (!this.#app) {
       const def = transports.find(({ type }) => type === this.#transport);
 
-      assert(def, `Unable to find a transport for ${this.#transport}`);
+      assert(def, () => `Unable to find a transport for ${this.#transport}`);
 
       const transport = await def.create();
 
-      this.#app = APPS[this.#chain](transport);
+      this.#app = ledgerApps[this.#chain](transport);
     }
 
     return this.#app;
@@ -115,7 +98,7 @@ export class Ledger {
   #wrapError = async <T extends ResponseBase> (promise: Promise<T>): Promise<T> => {
     const result = await promise;
 
-    assert(result.return_code === SUCCESS_CODE, result.error_message);
+    assert(result.return_code === LEDGER_SUCCESS_CODE, () => result.error_message);
 
     return result;
   };

packages/hw-ledger/src/packageInfo.ts

@@ -1,6 +1,6 @@
-// Copyright 2017-2021 @polkadot/dev authors & contributors
+// Copyright 2017-2021 @polkadot/hw-ledger authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 // Auto-generated by @polkadot/dev, do not edit
 
-export const packageInfo = { name: '@polkadot/hw-ledger', version: '5.9.2' };
+export const packageInfo = { name: '@polkadot/hw-ledger', version: '6.3.1' };

packages/keyring/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@polkadot/keyring",
-  "version": "5.9.2",
+  "version": "6.3.1",
+  "type": "module",
   "description": "Keyring management",
   "author": "Jaco Greeff <jacogr@gmail.com>",
   "maintainers": [],
@@ -9,18 +10,21 @@
   "main": "index.js",
   "sideEffects": [
     "./detectPackage.js",
-    "./detectPackage.mjs"
+    "./detectPackage.cjs"
   ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "repository": "github:polkadot-js/common",
   "bugs": "https://github.com/polkadot-js/common/issues",
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme",
   "dependencies": {
-    "@babel/runtime": "^7.13.8",
-    "@polkadot/util": "5.9.2",
-    "@polkadot/util-crypto": "5.9.2"
+    "@babel/runtime": "^7.13.17",
+    "@polkadot/util": "6.3.1",
+    "@polkadot/util-crypto": "6.3.1"
   },
   "peerDependencies": {
-    "@polkadot/util": "5.9.2",
-    "@polkadot/util-crypto": "5.9.2"
+    "@polkadot/util": "6.3.1",
+    "@polkadot/util-crypto": "6.3.1"
   }
 }

packages/keyring/src/index.spec.ts

@@ -1,9 +1,12 @@
 // Copyright 2017-2021 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import { hexToU8a, stringToU8a } from '@polkadot/util';
-import { cryptoWaitReady, encodeAddress, randomAsU8a, setSS58Format } from '@polkadot/util-crypto';
+import type { KeyringPair$Json } from './types';
 
+import { hexToU8a, stringToU8a } from '@polkadot/util';
+import { base64Decode, cryptoWaitReady, encodeAddress, randomAsU8a, setSS58Format } from '@polkadot/util-crypto';
+
+import { decodePair } from './pair/decode';
 import Keyring from '.';
 
 describe('keypair', (): void => {
@@ -306,6 +309,7 @@ describe('keypair', (): void => {
   describe('ethereum', (): void => {
     // combine mnemonic with derivation path
     const PHRASE = 'seed sock milk update focus rotate barely fade car face mechanic mercy' + '/m/44\'/60\'/0\'/0/0';
+    const PRIV_KEY_ONE = '0x070dc3117300011918e26b02176945cc15c3d548cf49fd8418d97f93af699e46';
     const ETH_ADDRESS_ONE = '0x31ea8795EE32D782C8ff41a5C68Dcbf0F5B27f6d';
 
     let keyring: Keyring;
@@ -314,6 +318,22 @@ describe('keypair', (): void => {
       keyring = new Keyring({ type: 'ethereum' });
     });
 
+    it('creates with dev phrase from the private key', (): void => {
+      const pair = keyring.addFromSeed(hexToU8a(PRIV_KEY_ONE));
+
+      expect(
+        pair.address
+      ).toEqual(ETH_ADDRESS_ONE);
+    });
+
+    it('creates with dev phrase from the private key in createFromUri', (): void => {
+      const pair = keyring.createFromUri(PRIV_KEY_ONE);
+
+      expect(
+        pair.address
+      ).toEqual(ETH_ADDRESS_ONE);
+    });
+
     it('creates with dev phrase with derivation path specified', (): void => {
       const pair = keyring.createFromUri(PHRASE);
 
@@ -412,6 +432,30 @@ describe('keypair', (): void => {
     });
   });
 
+  describe('raw pair add/create', (): void => {
+    const json = JSON.parse('{"address":"5PjeoaQzCoYbSi42aQRKB3Sx18StCaEAzCbGEEbWbZyfKS3H","encoded":"JQUl8ZpoXv2OMkL9TPylLmcIye2cYhaS9INICbFgZTsAgAAAAQAAAAgAAAAr/0hJOOzokIdBG71TstigLABX9D5xGD7L37ySxtjDrVRg26LL90jLQ47quT9o3bq6ppXMVL6USk7Q4p3WU66bojTFuCDyhpYRhNbUqU6s0rD3S4bhv9lG+pG9vQ4eD5PVQUvxdANmJpYuDg45nrTmsMC5AHGdFGkHW/LHnkmbFid1cvPYkdiBoef5CIEdoly512pxMupVxnJWF1NT","encoding":{"content":["pkcs8","sr25519"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{"name":"hello"}}') as KeyringPair$Json;
+    const decoded = decodePair('1', base64Decode(json.encoded), json.encoding.type);
+    const keyring = new Keyring({ ss58Format: 44 });
+
+    it('creates a pair from a private/public combo', (): void => {
+      const pair = keyring.createFromPair(decoded, json.meta, 'sr25519');
+
+      expect(pair.address).toEqual('5PjeoaQzCoYbSi42aQRKB3Sx18StCaEAzCbGEEbWbZyfKS3H');
+      expect(pair.isLocked).toEqual(false);
+      expect(pair.meta.name).toEqual('hello');
+    });
+
+    it('adds a pair from a private/public combo', (): void => {
+      keyring.addFromPair(decoded, json.meta, 'sr25519');
+
+      const pair = keyring.getPairs()[0];
+
+      expect(pair.address).toEqual('5PjeoaQzCoYbSi42aQRKB3Sx18StCaEAzCbGEEbWbZyfKS3H');
+      expect(pair.isLocked).toEqual(false);
+      expect(pair.meta.name).toEqual('hello');
+    });
+  });
+
   describe('util', (): void => {
     let keyring: Keyring;
 

packages/keyring/src/keyring.ts

@@ -1,8 +1,9 @@
 // Copyright 2017-2021 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
+import type { EncryptedJsonEncoding } from '@polkadot/util-crypto/json/types';
 import type { Keypair, KeypairType } from '@polkadot/util-crypto/types';
-import type { KeyringInstance, KeyringOptions, KeyringPair, KeyringPair$Json, KeyringPair$JsonEncodingTypes, KeyringPair$Meta } from './types';
+import type { KeyringInstance, KeyringOptions, KeyringPair, KeyringPair$Json, KeyringPair$Meta } from './types';
 
 import { assert, hexToU8a, isHex, isUndefined, stringToU8a } from '@polkadot/util';
 import { base64Decode, decodeAddress, encodeAddress, ethereumEncode, hdEthereum, keyExtractSuri, keyFromPath, mnemonicToLegacySeed, mnemonicToMiniSecret, naclKeypairFromSeed as naclFromSeed, schnorrkelKeypairFromSeed as schnorrkelFromSeed, secp256k1KeypairFromSeed as secp256k1FromSeed } from '@polkadot/util-crypto';
@@ -46,7 +47,7 @@ export class Keyring implements KeyringInstance {
   constructor (options: KeyringOptions = {}) {
     options.type = options.type || 'ed25519';
 
-    assert(options && ['ecdsa', 'ethereum', 'ed25519', 'sr25519'].includes(options.type || 'undefined'), `Expected a keyring type of either 'ed25519', 'sr25519', 'ethereum' or 'ecdsa', found '${options.type}`);
+    assert(['ecdsa', 'ethereum', 'ed25519', 'sr25519'].includes(options.type || 'undefined'), () => `Expected a keyring type of either 'ed25519', 'sr25519', 'ethereum' or 'ecdsa', found '${options.type || 'unknown'}`);
 
     this.#pairs = new Pairs();
     this.#ss58 = options.ss58Format;
@@ -90,7 +91,7 @@ export class Keyring implements KeyringInstance {
    * of an account backup), and then generates a keyring pair from them that it passes to
    * `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
    */
-  public addFromAddress (address: string | Uint8Array, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, type: KeypairType = this.type, ignoreChecksum?: boolean, encType?: KeyringPair$JsonEncodingTypes[]): KeyringPair {
+  public addFromAddress (address: string | Uint8Array, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, type: KeypairType = this.type, ignoreChecksum?: boolean, encType?: EncryptedJsonEncoding[]): KeyringPair {
     const publicKey = this.decodeAddress(address, ignoreChecksum);
 
     return this.addPair(createPair({ toSS58: this.encodeAddress, type }, { publicKey, secretKey: new Uint8Array() }, meta, encoded, encType));
@@ -119,6 +120,16 @@ export class Keyring implements KeyringInstance {
     return this.addFromUri(mnemonic, meta, type);
   }
 
+  /**
+   * @name addFromPair
+   * @summary Stores an account created from an explicit publicKey/secreteKey combination
+   */
+  public addFromPair (pair: Keypair, meta: KeyringPair$Meta = {}, type: KeypairType = this.type): KeyringPair {
+    return this.addPair(
+      this.createFromPair(pair, meta, type)
+    );
+  }
+
   /**
    * @name addFromSeed
    * @summary Stores an account, given seed data, as a Key/Value (public key, pair) in Keyring Pair Dictionary
@@ -127,7 +138,9 @@ export class Keyring implements KeyringInstance {
    * `addPair` to store in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
    */
   public addFromSeed (seed: Uint8Array, meta: KeyringPair$Meta = {}, type: KeypairType = this.type): KeyringPair {
-    return this.addPair(createPair({ toSS58: this.encodeAddress, type }, keypairFromSeed[type](seed), meta, null));
+    return this.addPair(
+      createPair({ toSS58: this.encodeAddress, type }, keypairFromSeed[type](seed), meta, null)
+    );
   }
 
   /**
@@ -146,13 +159,18 @@ export class Keyring implements KeyringInstance {
    * @description Creates a pair from a JSON keyfile
    */
   public createFromJson ({ address, encoded, encoding: { content, type, version }, meta }: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair {
+    assert(version !== '3' || content[0] === 'pkcs8', () => `Unable to decode non-pkcs8 type, [${content.join(',')}] found}`);
+
     const cryptoType = version === '0' || !Array.isArray(content)
       ? this.type
       : content[1];
     const encType = !Array.isArray(type)
       ? [type]
       : type;
-      // Here the address and publicKey are 32 bytes and isomorphic. This is why the address field needs to be the public key for ethereum type pairs
+
+    assert(['ed25519', 'sr25519', 'ecdsa', 'ethereum'].includes(cryptoType), () => `Unknown crypto type ${cryptoType}`);
+
+    // Here the address and publicKey are 32 bytes and isomorphic. This is why the address field needs to be the public key for ethereum type pairs
     const publicKey = isHex(address)
       ? hexToU8a(address)
       : this.decodeAddress(address, ignoreChecksum);
@@ -160,7 +178,15 @@ export class Keyring implements KeyringInstance {
       ? hexToU8a(encoded)
       : base64Decode(encoded);
 
-    return createPair({ toSS58: this.encodeAddress, type: cryptoType }, { publicKey, secretKey: new Uint8Array() }, meta, decoded, encType);
+    return createPair({ toSS58: this.encodeAddress, type: cryptoType as KeypairType }, { publicKey, secretKey: new Uint8Array() }, meta, decoded, encType);
+  }
+
+  /**
+   * @name createFromPair
+   * @summary Creates a pair from an explicit publicKey/secreteKey combination
+   */
+  public createFromPair (pair: Keypair, meta: KeyringPair$Meta = {}, type: KeypairType = this.type): KeyringPair {
+    return createPair({ toSS58: this.encodeAddress, type }, pair, meta, null);
   }
 
   /**
@@ -175,11 +201,12 @@ export class Keyring implements KeyringInstance {
       : _suri;
     const { derivePath, password, path, phrase } = keyExtractSuri(suri);
     let seed: Uint8Array;
+    const isPhraseHex = isHex(phrase, 256);
 
-    if (isHex(phrase, 256)) {
+    if (isPhraseHex) {
       seed = hexToU8a(phrase);
     } else {
-      const str = phrase as string;
+      const str = phrase;
       const parts = str.split(' ');
 
       if ([12, 15, 18, 21, 24].includes(parts.length)) {
@@ -194,7 +221,9 @@ export class Keyring implements KeyringInstance {
     }
 
     const derived = type === 'ethereum'
-      ? hdEthereum(seed, derivePath.substring(1))
+      ? isPhraseHex
+        ? keypairFromSeed[type](seed) // for eth, if the private key is provided as suri, it must be derived only once
+        : hdEthereum(seed, derivePath.substring(1))
       : keyFromPath(keypairFromSeed[type](seed), path, type);
 
     return createPair({ toSS58: this.encodeAddress, type }, derived, meta, null);

packages/keyring/src/packageInfo.ts

@@ -1,6 +1,6 @@
-// Copyright 2017-2021 @polkadot/dev authors & contributors
+// Copyright 2017-2021 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 // Auto-generated by @polkadot/dev, do not edit
 
-export const packageInfo = { name: '@polkadot/keyring', version: '5.9.2' };
+export const packageInfo = { name: '@polkadot/keyring', version: '6.3.1' };

packages/keyring/src/pair/decode.ts

@@ -1,13 +1,13 @@
 // Copyright 2017-2021 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import type { KeyringPair$JsonEncodingTypes } from '../types';
+import type { EncryptedJsonEncoding } from '@polkadot/util-crypto/json/types';
 import type { PairInfo } from './types';
 
-import { assert, stringToU8a, u8aFixLength } from '@polkadot/util';
-import { naclDecrypt, scryptEncode, scryptFromU8a } from '@polkadot/util-crypto';
+import { assert, isUndefined, u8aEq } from '@polkadot/util';
+import { jsonDecryptData } from '@polkadot/util-crypto';
 
-import { ENCODING, NONCE_LENGTH, PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SCRYPT_LENGTH, SEC_LENGTH, SEED_LENGTH } from './defaults';
+import { PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SEC_LENGTH, SEED_LENGTH } from './defaults';
 
 const SEED_OFFSET = PKCS8_HEADER.length;
 
@@ -15,59 +15,33 @@ type DecodeResult = PairInfo & {
   secretKey: Uint8Array;
 };
 
-function decodePkcs8 (encoded: Uint8Array): DecodeResult {
-  const header = encoded.subarray(0, PKCS8_HEADER.length);
+export function decodePair (passphrase?: string, encrypted?: Uint8Array | null, _encType?: EncryptedJsonEncoding | EncryptedJsonEncoding[]): DecodeResult {
+  const encType = Array.isArray(_encType) || isUndefined(_encType)
+    ? _encType
+    : [_encType];
+  const decrypted = jsonDecryptData(encrypted, passphrase, encType);
+  const header = decrypted.subarray(0, PKCS8_HEADER.length);
 
-  assert(header.toString() === PKCS8_HEADER.toString(), 'Invalid Pkcs8 header found in body');
+  assert(u8aEq(header, PKCS8_HEADER), 'Invalid Pkcs8 header found in body');
 
-  let secretKey = encoded.subarray(SEED_OFFSET, SEED_OFFSET + SEC_LENGTH);
+  let secretKey = decrypted.subarray(SEED_OFFSET, SEED_OFFSET + SEC_LENGTH);
   let divOffset = SEED_OFFSET + SEC_LENGTH;
-  let divider = encoded.subarray(divOffset, divOffset + PKCS8_DIVIDER.length);
+  let divider = decrypted.subarray(divOffset, divOffset + PKCS8_DIVIDER.length);
 
   // old-style, we have the seed here
-  if (divider.toString() !== PKCS8_DIVIDER.toString()) {
+  if (!u8aEq(divider, PKCS8_DIVIDER)) {
     divOffset = SEED_OFFSET + SEED_LENGTH;
-    secretKey = encoded.subarray(SEED_OFFSET, divOffset);
-    divider = encoded.subarray(divOffset, divOffset + PKCS8_DIVIDER.length);
+    secretKey = decrypted.subarray(SEED_OFFSET, divOffset);
+    divider = decrypted.subarray(divOffset, divOffset + PKCS8_DIVIDER.length);
+
+    assert(u8aEq(divider, PKCS8_DIVIDER), 'Invalid Pkcs8 divider found in body');
   }
 
-  assert(divider.toString() === PKCS8_DIVIDER.toString(), 'Invalid Pkcs8 divider found in body');
-
   const pubOffset = divOffset + PKCS8_DIVIDER.length;
-  const publicKey = encoded.subarray(pubOffset, pubOffset + PUB_LENGTH);
+  const publicKey = decrypted.subarray(pubOffset, pubOffset + PUB_LENGTH);
 
   return {
     publicKey,
     secretKey
   };
 }
-
-export function decodePair (passphrase?: string, encrypted?: Uint8Array | null, encType: KeyringPair$JsonEncodingTypes[] = ENCODING): DecodeResult {
-  assert(encrypted, 'No encrypted data available to decode');
-  assert(passphrase || !encType.includes('xsalsa20-poly1305'), 'Password required to decode encypted data');
-
-  let encoded: Uint8Array | null = encrypted;
-
-  if (passphrase) {
-    let password: Uint8Array;
-
-    if (encType.includes('scrypt')) {
-      const { params, salt } = scryptFromU8a(encrypted);
-
-      password = scryptEncode(passphrase, salt, params).password;
-      encrypted = encrypted.subarray(SCRYPT_LENGTH);
-    } else {
-      password = stringToU8a(passphrase);
-    }
-
-    encoded = naclDecrypt(
-      encrypted.subarray(NONCE_LENGTH),
-      encrypted.subarray(0, NONCE_LENGTH),
-      u8aFixLength(password, 256, true)
-    );
-  }
-
-  assert(encoded, 'Unable to decode using the supplied passphrase');
-
-  return decodePkcs8(encoded);
-}

packages/keyring/src/pair/defaults.ts

@@ -1,14 +1,9 @@
 // Copyright 2017-2021 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import type { KeyringPair$JsonEncodingTypes } from '../types';
-
-export const ENCODING: KeyringPair$JsonEncodingTypes[] = ['scrypt', 'xsalsa20-poly1305'];
-export const NONCE_LENGTH = 24;
 export const PKCS8_DIVIDER = new Uint8Array([161, 35, 3, 33, 0]);
 export const PKCS8_HEADER = new Uint8Array([48, 83, 2, 1, 1, 48, 5, 6, 3, 43, 101, 112, 4, 34, 4, 32]);
 export const PUB_LENGTH = 32;
 export const SALT_LENGTH = 32;
 export const SEC_LENGTH = 64;
 export const SEED_LENGTH = 32;
-export const SCRYPT_LENGTH = SALT_LENGTH + (3 * 4);

packages/keyring/src/pair/encode.spec.ts

@@ -1,8 +1,10 @@
 // Copyright 2017-2021 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
+import { NONCE_LENGTH, SCRYPT_LENGTH } from '@polkadot/util-crypto/json/constants';
+
 import { createTestPairs } from '../testingPairs';
-import { NONCE_LENGTH, PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SCRYPT_LENGTH, SEC_LENGTH } from './defaults';
+import { PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SEC_LENGTH } from './defaults';
 
 const PKCS8_LENGTH = PKCS8_DIVIDER.length + PKCS8_HEADER.length + PUB_LENGTH + SEC_LENGTH;
 const ENCODED_LENGTH = 16 + PKCS8_LENGTH + NONCE_LENGTH + SCRYPT_LENGTH;

packages/keyring/src/pair/index.ts

@@ -1,8 +1,9 @@
 // Copyright 2017-2021 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
+import type { EncryptedJsonEncoding } from '@polkadot/util-crypto/json/types';
 import type { Keypair, KeypairType } from '@polkadot/util-crypto/types';
-import type { KeyringPair, KeyringPair$Json, KeyringPair$JsonEncodingTypes, KeyringPair$Meta, SignOptions } from '../types';
+import type { KeyringPair, KeyringPair$Json, KeyringPair$Meta, SignOptions } from '../types';
 import type { PairInfo } from './types';
 
 import { assert, u8aConcat, u8aEq, u8aToHex, u8aToU8a } from '@polkadot/util';
@@ -87,7 +88,7 @@ function vrfHash (proof: Uint8Array, context?: string | Uint8Array, extra?: stri
  * an `encoded` property that is assigned with the encoded public key in hex format, and an `encoding`
  * property that indicates whether the public key value of the `encoded` property is encoded or not.
  */
-export function createPair ({ toSS58, type }: Setup, { publicKey, secretKey }: PairInfo, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, encTypes?: KeyringPair$JsonEncodingTypes[]): KeyringPair {
+export function createPair ({ toSS58, type }: Setup, { publicKey, secretKey }: PairInfo, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, encTypes?: EncryptedJsonEncoding[]): KeyringPair {
   const decodePkcs8 = (passphrase?: string, userEncoded?: Uint8Array | null): void => {
     const decoded = decodePair(passphrase, userEncoded || encoded, encTypes);
 

packages/keyring/src/pair/toJson.ts

@@ -2,34 +2,19 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { KeypairType } from '@polkadot/util-crypto/types';
-import type { KeyringPair$Json, KeyringPair$JsonEncodingTypes, KeyringPair$Meta } from '../types';
+import type { KeyringPair$Json, KeyringPair$Meta } from '../types';
 
-import { base64Encode } from '@polkadot/util-crypto';
-
-import { ENCODING } from './defaults';
+import { jsonEncryptFormat } from '@polkadot/util-crypto';
 
 interface PairStateJson {
   address: string;
   meta: KeyringPair$Meta;
 }
 
-// version 2 - nonce, encoded (previous)
-// version 3 - salt, nonce, encoded
-const VERSION = '3';
-
-const ENC_NONE: KeyringPair$JsonEncodingTypes[] = ['none'];
-
 export function pairToJson (type: KeypairType, { address, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
   return {
+    ...jsonEncryptFormat(encoded, ['pkcs8', type], isEncrypted),
     address,
-    encoded: base64Encode(encoded),
-    encoding: {
-      content: ['pkcs8', type],
-      type: isEncrypted
-        ? ENCODING
-        : ENC_NONE,
-      version: VERSION
-    },
     meta
   };
 }

packages/keyring/src/pairs.ts

@@ -24,13 +24,11 @@ export class Pairs implements KeyringPairs {
   public get (address: string | Uint8Array): KeyringPair {
     const pair = this.#map[decodeAddress(address).toString()];
 
-    assert(pair, (): string => {
-      const formatted: string = isU8a(address) || isHex(address)
+    assert(pair, () => `Unable to retrieve keypair '${
+      isU8a(address) || isHex(address)
         ? u8aToHex(u8aToU8a(address))
-        : address;
-
-      return `Unable to retrieve keypair '${formatted}'`;
-    });
+        : address
+    }'`);
 
     return pair;
   }

packages/keyring/src/testing.ts

@@ -73,6 +73,49 @@ export const PAIRSSR25519: PairDef[] = [
 ];
 
 export const PAIRSETHEREUM: PairDef[] = [
+  {
+    name: 'Alith',
+    publicKey: hexToU8a('0x02509540919faacf9ab52146c9aa40db68172d83777250b28e4679176e49ccdd9f'),
+    secretKey: hexToU8a('0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133'),
+    seed: "m/44'/40'/0'/0",
+    type: 'ethereum'
+  },
+  {
+    name: 'Baltathar',
+    publicKey: hexToU8a('0x033bc19e36ff1673910575b6727a974a9abd80c9a875d41ab3e2648dbfb9e4b518'),
+    secretKey: hexToU8a('0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b'),
+    seed: "m/44'/40'/0'/0",
+    type: 'ethereum'
+  },
+  {
+    name: 'Charleth',
+    publicKey: hexToU8a('0x0234637bdc0e89b5d46543bcbf8edff329d2702bc995e27e9af4b1ba009a3c2a5e'),
+    secretKey: hexToU8a('0x0b6e18cafb6ed99687ec547bd28139cafdd2bffe70e6b688025de6b445aa5c5b'),
+    seed: "m/44'/40'/0'/0",
+    type: 'ethereum'
+  },
+  {
+    name: 'Dorothy',
+    publicKey: hexToU8a('0x02a00d60b2b408c2a14c5d70cdd2c205db8985ef737a7e55ad20ea32cc9e7c417c'),
+    secretKey: hexToU8a('0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68'),
+    seed: "m/44'/40'/0'/0",
+    type: 'ethereum'
+  },
+  {
+    name: 'Ethan',
+    publicKey: hexToU8a('0x025cdc005b752651cd3f728fb9192182acb3a9c89e19072cbd5b03f3ee1f1b3ffa'),
+    secretKey: hexToU8a('0x7dce9bc8babb68fec1409be38c8e1a52650206a7ed90ff956ae8a6d15eeaaef4'),
+    seed: "m/44'/40'/0'/0",
+    type: 'ethereum'
+  },
+  {
+    name: 'Faith',
+    publicKey: hexToU8a('0x037964b6c9d546da4646ada28a99e34acaa1d14e7aba861a9055f9bd200c8abf74'),
+    secretKey: hexToU8a('0xb9d2ea9a615f3165812e8d44de0d24da9bbd164b65c4f0573e1ce2c8dbd9c8df'),
+    seed: "m/44'/40'/0'/0",
+    type: 'ethereum'
+  },
+  // Gerald will be removed when moonbeam is done changing dev addresses (should def be done by end of march 21)
   {
     name: 'Gerald',
     publicKey: new Uint8Array([3, 98, 79, 114, 14, 174, 103, 106,
@@ -81,7 +124,7 @@ export const PAIRSETHEREUM: PairDef[] = [
       198, 190, 114, 152, 60, 235, 98, 15,
       191]),
     secretKey: hexToU8a('0x99b3c12287537e38c90a9219d4cb074a89a16e9cdb20bf85728ebd97c343e342'),
-    seed: 'Gerald',
+    seed: "m/44'/40'/0'/0",
     type: 'ethereum'
   }
 ];
@@ -101,7 +144,6 @@ export function createTestKeyring (options: KeyringOptions = {}, isDerived = tru
       isTesting: true,
       name: name || seed.replace('//', '_').toLowerCase()
     };
-
     const pair = !isDerived && !name
       ? keyring.addFromUri(seed, meta, options.type)
       : keyring.addPair(

packages/keyring/src/testingPairs.spec.ts

@@ -1,9 +1,11 @@
 // Copyright 2017-2021 @polkadot/keyring authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
+import { u8aToHex } from '@polkadot/util';
 import { cryptoWaitReady } from '@polkadot/util-crypto';
 
 import { createTestPairs } from './testingPairs';
+import Keyring from '.';
 
 describe('testingPairs', (): void => {
   beforeEach(async (): Promise<void> => {
@@ -27,4 +29,41 @@ describe('testingPairs', (): void => {
       createTestPairs({ type: 'ed25519' }).alice.address
     ).toEqual('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY');
   });
+
+  it('has the correct address for Alith (Eth)', (): void => {
+    expect(
+      createTestPairs({ type: 'ethereum' }).Alith.address
+    ).toEqual('0xf24FF3a9CF04c71Dbc94D0b566f7A27B94566cac');
+  });
+
+  it('has the correct address for Alith (Eth), same as obtained by createFromUri', (): void => {
+    const keyring = new Keyring({ type: 'ethereum' });
+    const pair = keyring.createFromUri('0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133');
+
+    expect(
+      pair && pair.address
+    ).toEqual('0xf24FF3a9CF04c71Dbc94D0b566f7A27B94566cac');
+  });
+
+  it('checks eth test addresses', (): void => {
+    const ring = createTestPairs({ type: 'ethereum' });
+    const keyring = new Keyring({ type: 'ethereum' });
+    // priv keys generated by  ganache-cli --mnemonic "bottom drive obey lake curtain smoke basket hold race lonely fit walk"
+    const privKeys: string[] = ['0x5fb92d6e98884f76de468fa3f6278f8807c48bebc13595d45af5bdc4da702133',
+      '0x8075991ce870b93a8870eca0c0f91913d12f47948ca0fd25b49c6fa7cdbeee8b',
+      '0x0b6e18cafb6ed99687ec547bd28139cafdd2bffe70e6b688025de6b445aa5c5b',
+      '0x39539ab1876910bbf3a223d84a29e28f1cb4e2e456503e7e91ed39b2e7223d68',
+      '0x7dce9bc8babb68fec1409be38c8e1a52650206a7ed90ff956ae8a6d15eeaaef4',
+      '0xb9d2ea9a615f3165812e8d44de0d24da9bbd164b65c4f0573e1ce2c8dbd9c8df',
+      '0x96b8a38e12e1a31dee1eab2fffdf9d9990045f5b37e44d8cc27766ef294acf18',
+      '0x0d6dcaaef49272a5411896be8ad16c01c35d6f8c18873387b71fbc734759b0ab',
+      '0x4c42532034540267bf568198ccec4cb822a025da542861fcb146a5fab6433ff8',
+      '0x94c49300a58d576011096bcb006aa06f5a91b34b4383891e8029c21dc39fbb8b'];
+
+    delete ring.nobody;
+
+    Object.keys(ring).forEach((testKeyring, i) => {
+      if (i < 6) { expect(u8aToHex(ring[testKeyring].publicKey)).toEqual(u8aToHex(keyring.createFromUri(privKeys[i]).publicKey)); }
+    });
+  });
 });

packages/keyring/src/types.ts

@@ -2,7 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { Prefix } from '@polkadot/util-crypto/address/types';
-import type { KeypairType } from '@polkadot/util-crypto/types';
+import type { EncryptedJson } from '@polkadot/util-crypto/json/types';
+import type { Keypair, KeypairType } from '@polkadot/util-crypto/types';
 
 export interface KeyringOptions {
   ss58Format?: Prefix;
@@ -11,20 +12,8 @@ export interface KeyringOptions {
 
 export type KeyringPair$Meta = Record<string, unknown>;
 
-export type KeyringPair$JsonVersion = '0' | '1' | '2' | '3';
-
-export type KeyringPair$JsonEncodingTypes = 'none' | 'scrypt' | 'xsalsa20-poly1305';
-
-export interface KeyringPair$JsonEncoding {
-  content: ['pkcs8', KeypairType];
-  type: KeyringPair$JsonEncodingTypes | KeyringPair$JsonEncodingTypes[];
-  version: KeyringPair$JsonVersion;
-}
-
-export interface KeyringPair$Json {
+export interface KeyringPair$Json extends EncryptedJson {
   address: string;
-  encoded: string;
-  encoding: KeyringPair$JsonEncoding;
   meta: KeyringPair$Meta;
 }
 
@@ -73,9 +62,11 @@ export interface KeyringInstance {
   addFromAddress (address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeypairType, ignoreChecksum?: boolean): KeyringPair;
   addFromJson (pair: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair;
   addFromMnemonic (mnemonic: string, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
+  addFromPair (pair: Keypair, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair
   addFromSeed (seed: Uint8Array, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
   addFromUri (suri: string, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
   createFromJson (json: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair;
+  createFromPair (pair: Keypair, meta: KeyringPair$Meta, type: KeypairType): KeyringPair
   createFromUri (suri: string, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
   getPair (address: string | Uint8Array): KeyringPair;
   getPairs (): KeyringPair[];

packages/networks/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@polkadot/networks",
-  "version": "5.9.2",
+  "version": "6.3.1",
+  "type": "module",
   "description": "A list of all available Substrate networks and their applicable prefixes",
   "main": "index.js",
   "sideEffects": false,
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "repository": "github:polkadot-js/common",
   "author": "Jaco Greeff <jacogr@gmail.com>",
   "maintainers": [],
@@ -12,10 +16,10 @@
   "bugs": "https://github.com/polkadot-js/common/issues",
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/networks#readme",
   "dependencies": {
-    "@babel/runtime": "^7.13.8"
+    "@babel/runtime": "^7.13.17"
   },
   "devDependencies": {
-    "@polkadot/util": "5.9.2",
-    "@polkadot/x-fetch": "5.9.2"
+    "@polkadot/util": "6.3.1",
+    "@polkadot/x-fetch": "6.3.1"
   }
 }

packages/networks/scripts/fromSubstrate.mjs

@@ -0,0 +1,59 @@
+// Copyright 2017-2021 @polkadot/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import fs from 'fs';
+import fetch from 'node-fetch';
+
+const SUBSTRATE_REGISTRY = 'https://raw.githubusercontent.com/paritytech/substrate/master/ss58-registry.json';
+
+function outputField (v) {
+  if (typeof v === 'string') {
+    return `'${v}'`;
+  } else if (Array.isArray(v)) {
+    return `[${v.map((v) => outputField(v)).join(', ')}]`;
+  }
+
+  return v;
+}
+
+async function getSubstrateRegistry () {
+  const original = await fetch(SUBSTRATE_REGISTRY);
+  const json = await original.json();
+
+  return json.registry
+    .map((e) =>
+      `  {\n${Object
+        .entries(e)
+        .sort(([a], [b]) => a.localeCompare(b))
+        .map(([k, v]) => `    ${k}: ${outputField(v)}`)
+        .join(',\n')}\n  }`
+    )
+    .join(',\n');
+}
+
+getSubstrateRegistry()
+  .then((entries) => {
+    fs.writeFileSync('packages/networks/src/substrate.ts', `// Copyright 2017-2021 @polkadot/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Auto-generated by yarn networks:sync (via scripts/fromSubstrate.mjs)
+//
+// Do not edit, rather
+//   - make a PR to the upstream registry as per ${SUBSTRATE_REGISTRY}
+//   - yarn networks:sync
+//
+
+import type { KnownSubstrate } from './types';
+
+export const knownSubstrate: KnownSubstrate[] = [\n${entries}\n];
+`);
+
+    console.log('Completed.');
+
+    process.exit(0);
+  })
+  .catch((error) => {
+    console.error('Error:', error.message);
+
+    process.exit(-1);
+  });

packages/networks/src/crosscheck.spec.ts

@@ -9,8 +9,8 @@ import { fetch } from '@polkadot/x-fetch';
 
 import { all } from './';
 
-const ORIGINAL = 'https://raw.githubusercontent.com/paritytech/substrate/master/ss58-registry.json';
 const OUTPUT = './.github/ss58-check.md';
+const SUBSTRATE_REGISTRY = 'https://raw.githubusercontent.com/paritytech/substrate/master/ss58-registry.json';
 
 function assertAndLog (check: boolean, error: string): void {
   if (!check) {
@@ -27,7 +27,7 @@ describe('check latest Substrate ss58 registry', (): void => {
   let original: Ss58Registry;
 
   beforeAll(async (): Promise<void> => {
-    original = (await (await fetch(ORIGINAL)).json()) as Ss58Registry;
+    original = (await (await fetch(SUBSTRATE_REGISTRY)).json()) as Ss58Registry;
   });
 
   it('has the same number as the original', (): void => {

packages/networks/src/defaults.spec.ts

@@ -0,0 +1,14 @@
+// Copyright 2017-2021 @polkadot/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { knownGenesis, knownLedger } from './defaults';
+
+describe('defaults', (): void => {
+  it('has genesis for all Ledger chains', (): void => {
+    expect(
+      Object.keys(knownLedger).filter((network) =>
+        !knownGenesis[network]
+      )
+    ).toEqual([]);
+  });
+});

packages/networks/src/defaults.ts

@@ -0,0 +1,63 @@
+// Copyright 2017-2021 @polkadot/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { KnownGenesis, KnownIcon, KnownLedger, KnownTestnet } from './types';
+
+// NOTE: In the case where the network was hard-spooned and multiple genesisHashes
+// are provided, it needs to be in reverse order, i.e. most-recent first, oldest
+// last. This make lookups for the current a simple genesisHash[0]
+// (See Kusama as an example)
+export const knownGenesis: KnownGenesis = {
+  'dock-mainnet': [
+    '0xf73467c6544aa68df2ee546b135f955c46b90fa627e9b5d7935f41061bb8a5a9'
+  ],
+  edgeware: [
+    '0x742a2ca70c2fda6cee4f8df98d64c4c670a052d9568058982dad9d5a7a135c5b'
+  ],
+  hydradx: [
+    '0x3d75507dd46301767e601265791da1d9cb47b6ebc94e87347b635e5bf58bd047',
+    '0x0ed32bfcab4a83517fac88f2aa7cbc2f88d3ab93be9a12b6188a036bf8a943c2'
+  ],
+  kulupu: [
+    '0xf7a99d3cb92853d00d5275c971c132c074636256583fee53b3bbe60d7b8769ba'
+  ],
+  kusama: [
+    '0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe', // Kusama CC3,
+    '0xe3777fa922cafbff200cadeaea1a76bd7898ad5b89f7848999058b50e715f636', // Kusama CC2
+    '0x3fd7b9eb6a00376e5be61f01abb429ffb0b104be05eaff4d458da48fcd425baf' // Kusama CC1
+  ],
+  plasm: [
+    '0x3e86364d4b4894021cb2a0390bcf2feb5517d5292f2de2bb9404227e908b0b8b'
+  ],
+  polkadot: [
+    '0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3'
+  ],
+  polymesh: [
+    '0x9deeb940c92ae02111c3bd5baca89970384f4c9849f02a1b2e53e66414d30f9f'
+  ],
+  subsocial: [
+    '0x0bd72c1c305172e1275278aaeb3f161e02eccb7a819e63f62d47bd53a28189f8'
+  ]
+};
+
+// these are icon overrides
+export const knownIcon: KnownIcon = {
+  kusama: 'polkadot',
+  polkadot: 'polkadot'
+};
+
+// support for ledger
+export const knownLedger: KnownLedger = {
+  'dock-mainnet': 0x00000252,
+  kusama: 0x000001b2,
+  polkadot: 0x00000162,
+  polymesh: 0x00000253
+};
+
+// testenets should not allow selection
+export const knownTestnet: KnownTestnet = {
+  'dock-testnet': true,
+  jupiter: true,
+  'mathchain-testnet': true,
+  'zero-alphaville': true
+};

packages/networks/src/index.spec.ts

@@ -1,7 +1,10 @@
 // Copyright 2017-2021 @polkadot/networks authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import filtered, { available } from '.';
+import type { SubstrateNetwork } from './types';
+
+import { knownGenesis, knownIcon, knownLedger, knownTestnet } from './defaults';
+import filtered, { all, available } from '.';
 
 describe('filtered', (): void => {
   it('has the correct starting order', (): void => {
@@ -11,4 +14,67 @@ describe('filtered', (): void => {
   it('has no ignored networks', (): void => {
     expect(available.some(({ isIgnored }) => isIgnored)).toEqual(false);
   });
+
+  it('has no reserved networks', (): void => {
+    expect(available.some(({ prefix }) => prefix === 47)).toEqual(false);
+  });
+
+  it('has all genesis information', (): void => {
+    expect(
+      Object.entries(knownGenesis).filter(([network, genesisHash]) =>
+        available.some((a) =>
+          a.network === network &&
+          genesisHash.some((g, index) => a.genesisHash[index] !== g)
+        )
+      )
+    ).toEqual([]);
+  });
+
+  it('has all ledger details', (): void => {
+    expect(
+      Object.entries(knownLedger).filter(([network, slip44]) =>
+        available.some((a) =>
+          a.network === network && (
+            a.slip44 !== slip44 ||
+            !a.hasLedgerSupport ||
+            !a.genesisHash.length
+          )
+        )
+      )
+    ).toEqual([]);
+  });
+
+  it('has no testnets exposed', (): void => {
+    expect(
+      Object.keys(knownTestnet).filter((network) =>
+        available.some((a) =>
+          a.network === network
+        )
+      )
+    ).toEqual([]);
+  });
+
+  it('has all icons, except for overrides', (): void => {
+    expect(
+      available.filter(({ icon, network }) =>
+        icon !== 'substrate' &&
+        knownIcon[network] !== icon
+      )
+    ).toEqual([]);
+  });
+
+  it('has no ss58 duplicates', (): void => {
+    const dupes: SubstrateNetwork[] = [];
+    const uniques: SubstrateNetwork[] = [];
+
+    all.forEach((a): void => {
+      if (uniques.some((u) => u.prefix === a.prefix)) {
+        dupes.push(a);
+      } else {
+        uniques.push(a);
+      }
+    });
+
+    expect(dupes).toEqual([]);
+  });
 });

packages/networks/src/index.ts

@@ -1,502 +1,39 @@
 // Copyright 2017-2021 @polkadot/networks authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-// This contains exactly the same information as available in (with some extensions)
-// https://raw.githubusercontent.com/paritytech/substrate/master/ss58-registry.json
-//
-// Once the above is published as a package, the duplication here can be removed
+import type { Network, SubstrateNetwork } from './types';
 
-import type { Network, NetworkFromSubstrate, NetworkFromSubstrateNamed } from './types';
+import { knownGenesis, knownIcon, knownLedger, knownTestnet } from './defaults';
+import { knownSubstrate } from './substrate';
 
 export { packageInfo } from './packageInfo';
 
 // These are known prefixes that are not sorted
 const UNSORTED = [0, 2, 42];
 
-// NOTE: In the case where the network was hard-spooned and multiple genesisHashes
-// are provided, it needs to be in reverse order, i.e. most-recent first, oldest
-// last. This make lookups for the current a simple genesisHash[0]
-// (See Kusama as an example)
+export const all = knownSubstrate.map((o): SubstrateNetwork => {
+  const network = o.network || '';
+  const n = o as SubstrateNetwork;
 
-const createReserved = (prefix: number, displayName: string, network: string | null = null): NetworkFromSubstrate => ({
-  decimals: null,
-  displayName,
-  isIgnored: true,
-  network,
-  prefix,
-  standardAccount: null,
-  symbols: null,
-  website: null
+  n.slip44 = knownLedger[network];
+  n.hasLedgerSupport = !!n.slip44;
+
+  n.genesisHash = knownGenesis[network] || [];
+  n.icon = knownIcon[network] || 'substrate';
+  n.isIgnored = !network || !!knownTestnet[network] || network.startsWith('reserved');
+
+  return n;
 });
 
-export const all: NetworkFromSubstrate[] = [
-  {
-    decimals: [10],
-    displayName: 'Polkadot Relay Chain',
-    genesisHash: ['0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3'],
-    hasLedgerSupport: true,
-    icon: 'polkadot',
-    network: 'polkadot',
-    prefix: 0,
-    slip44: 0x00000162,
-    standardAccount: '*25519',
-    symbols: ['DOT'],
-    website: 'https://polkadot.network'
-  },
-  createReserved(1, 'Bare 32-bit Schnorr/Ristretto (S/R 25519) public key.'),
-  {
-    decimals: [12],
-    displayName: 'Kusama Relay Chain',
-    genesisHash: [
-      '0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe', // Kusama CC3,
-      '0xe3777fa922cafbff200cadeaea1a76bd7898ad5b89f7848999058b50e715f636', // Kusama CC2
-      '0x3fd7b9eb6a00376e5be61f01abb429ffb0b104be05eaff4d458da48fcd425baf' // Kusama CC1
-    ],
-    hasLedgerSupport: true,
-    icon: 'polkadot',
-    network: 'kusama',
-    prefix: 2,
-    slip44: 0x000001b2,
-    standardAccount: '*25519',
-    symbols: ['KSM'],
-    website: 'https://kusama.network'
-  },
-  createReserved(3, 'Bare 32-bit Ed25519 public key.'),
-  {
-    decimals: null,
-    displayName: 'Katal Chain',
-    network: 'katalchain',
-    prefix: 4,
-    standardAccount: '*25519',
-    symbols: null,
-    website: null
-  },
-  {
-    decimals: null,
-    displayName: 'Plasm Network',
-    genesisHash: ['0x3e86364d4b4894021cb2a0390bcf2feb5517d5292f2de2bb9404227e908b0b8b'],
-    network: 'plasm',
-    prefix: 5,
-    standardAccount: '*25519',
-    symbols: ['PLM'],
-    website: null
-  },
-  {
-    decimals: [12],
-    displayName: 'Bifrost',
-    network: 'bifrost',
-    prefix: 6,
-    standardAccount: '*25519',
-    symbols: ['BNC'],
-    website: 'https://bifrost.finance/'
-  },
-  {
-    decimals: [18],
-    displayName: 'Edgeware',
-    genesisHash: ['0x742a2ca70c2fda6cee4f8df98d64c4c670a052d9568058982dad9d5a7a135c5b'],
-    network: 'edgeware',
-    prefix: 7,
-    standardAccount: '*25519',
-    symbols: ['EDG'],
-    website: 'https://edgewa.re'
-  },
-  {
-    decimals: [18],
-    displayName: 'Acala Karura Canary',
-    network: 'karura',
-    prefix: 8,
-    standardAccount: '*25519',
-    symbols: ['KAR'],
-    website: 'https://acala.network/'
-  },
-  {
-    decimals: [18],
-    displayName: 'Laminar Reynolds Canary',
-    network: 'reynolds',
-    prefix: 9,
-    standardAccount: '*25519',
-    symbols: ['REY'],
-    website: 'http://laminar.network/'
-  },
-  {
-    decimals: [18],
-    displayName: 'Acala',
-    network: 'acala',
-    prefix: 10,
-    standardAccount: '*25519',
-    symbols: ['ACA'],
-    website: 'https://acala.network/'
-  },
-  {
-    decimals: [18],
-    displayName: 'Laminar',
-    network: 'laminar',
-    prefix: 11,
-    standardAccount: '*25519',
-    symbols: ['LAMI'],
-    website: 'http://laminar.network/'
-  },
-  {
-    decimals: [6],
-    displayName: 'Polymesh',
-    genesisHash: ['0x12fddc9e2128b3fe571e4e5427addcb87fcaf08493867a68dd6ae44b406b39c7'],
-    hasLedgerSupport: true,
-    network: 'polymesh',
-    prefix: 12,
-    slip44: 0x00000253,
-    standardAccount: '*25519',
-    symbols: ['POLYX'],
-    website: 'https://polymath.network/'
-  },
-  {
-    decimals: null,
-    displayName: 'SubstraTEE',
-    network: 'substratee',
-    prefix: 13,
-    standardAccount: '*25519',
-    symbols: null,
-    website: 'https://www.substratee.com'
-  },
-  {
-    decimals: [0],
-    displayName: 'Totem',
-    network: 'totem',
-    prefix: 14,
-    standardAccount: '*25519',
-    symbols: ['XTX'],
-    website: 'https://totemaccounting.com'
-  },
-  {
-    decimals: [12],
-    displayName: 'Synesthesia',
-    network: 'synesthesia',
-    prefix: 15,
-    standardAccount: '*25519',
-    symbols: ['SYN'],
-    website: 'https://synesthesia.network/'
-  },
-  {
-    decimals: [12],
-    displayName: 'Kulupu',
-    genesisHash: ['0xf7a99d3cb92853d00d5275c971c132c074636256583fee53b3bbe60d7b8769ba'],
-    network: 'kulupu',
-    prefix: 16,
-    standardAccount: '*25519',
-    symbols: ['KLP'],
-    website: 'https://kulupu.network/'
-  },
-  {
-    decimals: null,
-    displayName: 'Dark Mainnet',
-    network: 'dark',
-    prefix: 17,
-    standardAccount: '*25519',
-    symbols: null,
-    website: null
-  },
-  {
-    decimals: [9, 9],
-    displayName: 'Darwinia Network',
-    network: 'darwinia',
-    prefix: 18,
-    standardAccount: '*25519',
-    symbols: ['RING', 'KTON'],
-    website: 'https://darwinia.network/'
-  },
-  {
-    decimals: [12],
-    displayName: 'GeekCash',
-    network: 'geek',
-    prefix: 19,
-    standardAccount: '*25519',
-    symbols: ['GEEK'],
-    website: 'https://geekcash.org'
-  },
-  {
-    decimals: [12],
-    displayName: 'Stafi',
-    genesisHash: ['0x290a4149f09ea0e402c74c1c7e96ae4239588577fe78932f94f5404c68243d80'],
-    network: 'stafi',
-    prefix: 20,
-    standardAccount: '*25519',
-    symbols: ['FIS'],
-    website: 'https://stafi.io'
-  },
-  {
-    decimals: [6],
-    displayName: 'Dock Testnet',
-    isIgnored: true, // testnet
-    network: 'dock-testnet',
-    prefix: 21,
-    standardAccount: '*25519',
-    symbols: ['DCK'],
-    website: 'https://dock.io'
-  },
-  {
-    decimals: [6],
-    displayName: 'Dock Mainnet',
-    genesisHash: ['0xf73467c6544aa68df2ee546b135f955c46b90fa627e9b5d7935f41061bb8a5a9'],
-    hasLedgerSupport: true,
-    network: 'dock-mainnet',
-    prefix: 22,
-    slip44: 0x00000252,
-    standardAccount: '*25519',
-    symbols: ['DCK'],
-    website: 'https://dock.io'
-  },
-  {
-    decimals: null,
-    displayName: 'ShiftNrg',
-    network: 'shift',
-    prefix: 23,
-    standardAccount: '*25519',
-    symbols: null,
-    website: null
-  },
-  {
-    decimals: [18],
-    displayName: 'ZERO',
-    network: 'zero',
-    prefix: 24,
-    standardAccount: '*25519',
-    symbols: ['PLAY'],
-    website: 'https://zero.io'
-  },
-  {
-    decimals: [18],
-    displayName: 'ZERO Alphaville',
-    isIgnored: true, // testnet
-    network: 'zero-alphaville',
-    prefix: 25,
-    standardAccount: '*25519',
-    symbols: ['PLAY'],
-    website: 'https://zero.io'
-  },
-  {
-    decimals: [10],
-    displayName: 'Jupiter',
-    isIgnored: true, // testnet
-    network: 'jupiter',
-    prefix: 26,
-    standardAccount: '*25519',
-    symbols: ['jDOT'],
-    website: 'https://jupiter.patract.io'
-  },
-  {
-    decimals: [10, 12],
-    displayName: 'Patract',
-    network: 'patract',
-    prefix: 27,
-    standardAccount: '*25519',
-    symbols: ['pDOT', 'pKSM'],
-    website: 'https://patract.network'
-  },
-  {
-    decimals: null,
-    displayName: 'Subsocial',
-    genesisHash: ['0x0bd72c1c305172e1275278aaeb3f161e02eccb7a819e63f62d47bd53a28189f8'],
-    network: 'subsocial',
-    prefix: 28,
-    standardAccount: '*25519',
-    symbols: null,
-    website: null
-  },
-  {
-    decimals: [18],
-    displayName: 'Dhiway CORD Network',
-    network: 'cord',
-    prefix: 29,
-    standardAccount: '*25519',
-    symbols: ['DCU'],
-    website: 'https://dhiway.com/'
-  },
-  {
-    decimals: [12],
-    displayName: 'Phala Network',
-    network: 'phala',
-    prefix: 30,
-    standardAccount: '*25519',
-    symbols: ['PHA'],
-    website: 'https://phala.network'
-  },
-  {
-    decimals: [12],
-    displayName: 'Litentry Network',
-    network: 'litentry',
-    prefix: 31,
-    standardAccount: '*25519',
-    symbols: ['LIT'],
-    website: 'https://litentry.com/'
-  },
-  {
-    decimals: [9],
-    displayName: 'Robonomics',
-    network: 'robonomics',
-    prefix: 32,
-    standardAccount: '*25519',
-    symbols: ['XRT'],
-    website: 'https://robonomics.network'
-  },
-  {
-    decimals: null,
-    displayName: 'DataHighway',
-    network: 'datahighway',
-    prefix: 33,
-    standardAccount: '*25519',
-    symbols: null,
-    website: null
-  },
-  {
-    decimals: [12],
-    displayName: 'Ares Protocol',
-    network: 'ares',
-    prefix: 34,
-    standardAccount: '*25519',
-    symbols: ['ARES'],
-    website: 'https://www.aresprotocol.com/'
-  },
-  {
-    decimals: [15],
-    displayName: 'Valiu Liquidity Network',
-    network: 'vln',
-    prefix: 35,
-    standardAccount: '*25519',
-    symbols: ['USDv'],
-    website: 'https://valiu.com/'
-  },
-  {
-    decimals: [18],
-    displayName: 'Centrifuge Chain',
-    network: 'centrifuge',
-    prefix: 36,
-    standardAccount: '*25519',
-    symbols: ['RAD'],
-    website: 'https://centrifuge.io/'
-  },
-  {
-    decimals: [18],
-    displayName: 'Nodle Chain',
-    network: 'nodle',
-    prefix: 37,
-    standardAccount: '*25519',
-    symbols: ['NODL'],
-    website: 'https://nodle.io/'
-  },
-  {
-    decimals: [18],
-    displayName: 'KILT Chain',
-    network: 'kilt',
-    prefix: 38,
-    standardAccount: '*25519',
-    symbols: ['KILT'],
-    website: 'https://kilt.io/'
-  },
-  {
-    decimals: [18],
-    displayName: 'MathChain mainnet',
-    network: 'mathchain',
-    prefix: 39,
-    standardAccount: '*25519',
-    symbols: ['MATH'],
-    website: 'https://mathwallet.org'
-  },
-  {
-    decimals: [18],
-    displayName: 'MathChain testnet',
-    isIgnored: true, // testnet
-    network: 'mathchain-testnet',
-    prefix: 40,
-    standardAccount: '*25519',
-    symbols: ['MATH'],
-    website: 'https://mathwallet.org'
-  },
-  {
-    decimals: null,
-    displayName: 'Polimec Chain',
-    network: 'poli',
-    prefix: 41,
-    standardAccount: '*25519',
-    symbols: null,
-    website: 'https://polimec.io/'
-  },
-  {
-    decimals: null,
-    displayName: 'Substrate',
-    network: 'substrate',
-    prefix: 42,
-    standardAccount: '*25519',
-    symbols: null,
-    website: 'https://substrate.dev/'
-  },
-  createReserved(43, 'Bare 32-bit ECDSA SECP-256k1 public key.'),
-  {
-    decimals: [8],
-    displayName: 'ChainX',
-    network: 'chainx',
-    prefix: 44,
-    standardAccount: '*25519',
-    symbols: ['PCX'],
-    website: 'https://chainx.org/'
-  },
-  {
-    decimals: [12, 12],
-    displayName: 'UniArts Network',
-    network: 'uniarts',
-    prefix: 45,
-    standardAccount: '*25519',
-    symbols: ['UART', 'UINK'],
-    website: 'https://uniarts.me'
-  },
-  createReserved(46, 'This prefix is reserved.', 'reserved46'),
-  createReserved(47, 'This prefix is reserved.', 'reserved47'),
-  {
-    decimals: [12],
-    displayName: 'Neatcoin Mainnet',
-    network: 'neatcoin',
-    prefix: 48,
-    standardAccount: '*25519',
-    symbols: ['NEAT'],
-    website: 'https://neatcoin.org'
-  },
-  {
-    decimals: [12],
-    displayName: 'HydraDX',
-    network: 'hydradx',
-    prefix: 63,
-    standardAccount: '*25519',
-    symbols: ['HDX'],
-    website: 'https://hydradx.io'
-  },
-  {
-    decimals: [18],
-    displayName: 'AvN Mainnet',
-    network: 'aventus',
-    prefix: 65,
-    standardAccount: '*25519',
-    symbols: ['AVT'],
-    website: 'https://aventus.io'
-  },
-  {
-    decimals: [12],
-    displayName: 'Crust Network',
-    network: 'crust',
-    prefix: 66,
-    standardAccount: '*25519',
-    symbols: ['CRU'],
-    website: 'https://crust.network'
-  }
-];
-
 // The list of available/claimed prefixes
 //   - no testnets
 //   - we only include those where we have a standardAccount
 //   - when no icon has been specified, default to substrate
 //   - sort by name, however we keep 0, 2, 42 first in the list
-export const available: Network[] = all
-  .filter((n): n is NetworkFromSubstrateNamed => !n.isIgnored && !!n.network)
-  .map((n) => ({ ...n, genesisHash: n.genesisHash || [], icon: n.icon || 'substrate' }))
+export const available = all
+  .filter((n): n is Network => !n.isIgnored && !!n.network)
   .sort((a, b) =>
-    UNSORTED.includes(a.prefix) && UNSORTED.includes(b.prefix)
+    UNSORTED.includes(a.prefix) === UNSORTED.includes(b.prefix)
       ? 0
       : UNSORTED.includes(a.prefix)
         ? -1

packages/networks/src/packageInfo.ts

@@ -1,6 +1,6 @@
-// Copyright 2017-2021 @polkadot/dev authors & contributors
+// Copyright 2017-2021 @polkadot/networks authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 // Auto-generated by @polkadot/dev, do not edit
 
-export const packageInfo = { name: '@polkadot/networks', version: '5.9.2' };
+export const packageInfo = { name: '@polkadot/networks', version: '6.3.1' };

packages/networks/src/substrate.ts

@@ -0,0 +1,500 @@
+// Copyright 2017-2021 @polkadot/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+// Auto-generated by yarn networks:sync (via scripts/fromSubstrate.mjs)
+//
+// Do not edit, rather
+//   - make a PR to the upstream registry as per https://raw.githubusercontent.com/paritytech/substrate/master/ss58-registry.json
+//   - yarn networks:sync
+//
+
+import type { KnownSubstrate } from './types';
+
+export const knownSubstrate: KnownSubstrate[] = [
+  {
+    decimals: [10],
+    displayName: 'Polkadot Relay Chain',
+    network: 'polkadot',
+    prefix: 0,
+    standardAccount: '*25519',
+    symbols: ['DOT'],
+    website: 'https://polkadot.network'
+  },
+  {
+    decimals: null,
+    displayName: 'Bare 32-bit Schnorr/Ristretto (S/R 25519) public key.',
+    network: null,
+    prefix: 1,
+    standardAccount: null,
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: [12],
+    displayName: 'Kusama Relay Chain',
+    network: 'kusama',
+    prefix: 2,
+    standardAccount: '*25519',
+    symbols: ['KSM'],
+    website: 'https://kusama.network'
+  },
+  {
+    decimals: null,
+    displayName: 'Bare 32-bit Ed25519 public key.',
+    network: null,
+    prefix: 3,
+    standardAccount: null,
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: null,
+    displayName: 'Katal Chain',
+    network: 'katalchain',
+    prefix: 4,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: [15],
+    displayName: 'Plasm Network',
+    network: 'plasm',
+    prefix: 5,
+    standardAccount: '*25519',
+    symbols: ['PLM'],
+    website: 'https://plasmnet.io'
+  },
+  {
+    decimals: [12],
+    displayName: 'Bifrost',
+    network: 'bifrost',
+    prefix: 6,
+    standardAccount: '*25519',
+    symbols: ['BNC'],
+    website: 'https://bifrost.finance/'
+  },
+  {
+    decimals: [18],
+    displayName: 'Edgeware',
+    network: 'edgeware',
+    prefix: 7,
+    standardAccount: '*25519',
+    symbols: ['EDG'],
+    website: 'https://edgewa.re'
+  },
+  {
+    decimals: [18],
+    displayName: 'Acala Karura Canary',
+    network: 'karura',
+    prefix: 8,
+    standardAccount: '*25519',
+    symbols: ['KAR'],
+    website: 'https://acala.network/'
+  },
+  {
+    decimals: [18],
+    displayName: 'Laminar Reynolds Canary',
+    network: 'reynolds',
+    prefix: 9,
+    standardAccount: '*25519',
+    symbols: ['REY'],
+    website: 'http://laminar.network/'
+  },
+  {
+    decimals: [18],
+    displayName: 'Acala',
+    network: 'acala',
+    prefix: 10,
+    standardAccount: '*25519',
+    symbols: ['ACA'],
+    website: 'https://acala.network/'
+  },
+  {
+    decimals: [18],
+    displayName: 'Laminar',
+    network: 'laminar',
+    prefix: 11,
+    standardAccount: '*25519',
+    symbols: ['LAMI'],
+    website: 'http://laminar.network/'
+  },
+  {
+    decimals: [6],
+    displayName: 'Polymesh',
+    network: 'polymesh',
+    prefix: 12,
+    standardAccount: '*25519',
+    symbols: ['POLYX'],
+    website: 'https://polymath.network/'
+  },
+  {
+    decimals: null,
+    displayName: 'SubstraTEE',
+    network: 'substratee',
+    prefix: 13,
+    standardAccount: '*25519',
+    symbols: null,
+    website: 'https://www.substratee.com'
+  },
+  {
+    decimals: [0],
+    displayName: 'Totem',
+    network: 'totem',
+    prefix: 14,
+    standardAccount: '*25519',
+    symbols: ['XTX'],
+    website: 'https://totemaccounting.com'
+  },
+  {
+    decimals: [12],
+    displayName: 'Synesthesia',
+    network: 'synesthesia',
+    prefix: 15,
+    standardAccount: '*25519',
+    symbols: ['SYN'],
+    website: 'https://synesthesia.network/'
+  },
+  {
+    decimals: [12],
+    displayName: 'Kulupu',
+    network: 'kulupu',
+    prefix: 16,
+    standardAccount: '*25519',
+    symbols: ['KLP'],
+    website: 'https://kulupu.network/'
+  },
+  {
+    decimals: null,
+    displayName: 'Dark Mainnet',
+    network: 'dark',
+    prefix: 17,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: [9, 9],
+    displayName: 'Darwinia Network',
+    network: 'darwinia',
+    prefix: 18,
+    standardAccount: '*25519',
+    symbols: ['RING', 'KTON'],
+    website: 'https://darwinia.network/'
+  },
+  {
+    decimals: [12],
+    displayName: 'GeekCash',
+    network: 'geek',
+    prefix: 19,
+    standardAccount: '*25519',
+    symbols: ['GEEK'],
+    website: 'https://geekcash.org'
+  },
+  {
+    decimals: [12],
+    displayName: 'Stafi',
+    network: 'stafi',
+    prefix: 20,
+    standardAccount: '*25519',
+    symbols: ['FIS'],
+    website: 'https://stafi.io'
+  },
+  {
+    decimals: [6],
+    displayName: 'Dock Testnet',
+    network: 'dock-testnet',
+    prefix: 21,
+    standardAccount: '*25519',
+    symbols: ['DCK'],
+    website: 'https://dock.io'
+  },
+  {
+    decimals: [6],
+    displayName: 'Dock Mainnet',
+    network: 'dock-mainnet',
+    prefix: 22,
+    standardAccount: '*25519',
+    symbols: ['DCK'],
+    website: 'https://dock.io'
+  },
+  {
+    decimals: null,
+    displayName: 'ShiftNrg',
+    network: 'shift',
+    prefix: 23,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: [18],
+    displayName: 'ZERO',
+    network: 'zero',
+    prefix: 24,
+    standardAccount: '*25519',
+    symbols: ['PLAY'],
+    website: 'https://zero.io'
+  },
+  {
+    decimals: [18],
+    displayName: 'ZERO Alphaville',
+    network: 'zero-alphaville',
+    prefix: 25,
+    standardAccount: '*25519',
+    symbols: ['PLAY'],
+    website: 'https://zero.io'
+  },
+  {
+    decimals: [10],
+    displayName: 'Jupiter',
+    network: 'jupiter',
+    prefix: 26,
+    standardAccount: '*25519',
+    symbols: ['jDOT'],
+    website: 'https://jupiter.patract.io'
+  },
+  {
+    decimals: [10, 12],
+    displayName: 'Patract',
+    network: 'patract',
+    prefix: 27,
+    standardAccount: '*25519',
+    symbols: ['pDOT', 'pKSM'],
+    website: 'https://patract.network'
+  },
+  {
+    decimals: null,
+    displayName: 'Subsocial',
+    network: 'subsocial',
+    prefix: 28,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: [18],
+    displayName: 'Dhiway CORD Network',
+    network: 'cord',
+    prefix: 29,
+    standardAccount: '*25519',
+    symbols: ['DCU'],
+    website: 'https://dhiway.com/'
+  },
+  {
+    decimals: [12],
+    displayName: 'Phala Network',
+    network: 'phala',
+    prefix: 30,
+    standardAccount: '*25519',
+    symbols: ['PHA'],
+    website: 'https://phala.network'
+  },
+  {
+    decimals: [12],
+    displayName: 'Litentry Network',
+    network: 'litentry',
+    prefix: 31,
+    standardAccount: '*25519',
+    symbols: ['LIT'],
+    website: 'https://litentry.com/'
+  },
+  {
+    decimals: [9],
+    displayName: 'Robonomics',
+    network: 'robonomics',
+    prefix: 32,
+    standardAccount: '*25519',
+    symbols: ['XRT'],
+    website: 'https://robonomics.network'
+  },
+  {
+    decimals: null,
+    displayName: 'DataHighway',
+    network: 'datahighway',
+    prefix: 33,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: [12],
+    displayName: 'Ares Protocol',
+    network: 'ares',
+    prefix: 34,
+    standardAccount: '*25519',
+    symbols: ['ARES'],
+    website: 'https://www.aresprotocol.com/'
+  },
+  {
+    decimals: [15],
+    displayName: 'Valiu Liquidity Network',
+    network: 'vln',
+    prefix: 35,
+    standardAccount: '*25519',
+    symbols: ['USDv'],
+    website: 'https://valiu.com/'
+  },
+  {
+    decimals: [18],
+    displayName: 'Centrifuge Chain',
+    network: 'centrifuge',
+    prefix: 36,
+    standardAccount: '*25519',
+    symbols: ['RAD'],
+    website: 'https://centrifuge.io/'
+  },
+  {
+    decimals: [18],
+    displayName: 'Nodle Chain',
+    network: 'nodle',
+    prefix: 37,
+    standardAccount: '*25519',
+    symbols: ['NODL'],
+    website: 'https://nodle.io/'
+  },
+  {
+    decimals: [18],
+    displayName: 'KILT Chain',
+    network: 'kilt',
+    prefix: 38,
+    standardAccount: '*25519',
+    symbols: ['KILT'],
+    website: 'https://kilt.io/'
+  },
+  {
+    decimals: [18],
+    displayName: 'MathChain mainnet',
+    network: 'mathchain',
+    prefix: 39,
+    standardAccount: '*25519',
+    symbols: ['MATH'],
+    website: 'https://mathwallet.org'
+  },
+  {
+    decimals: [18],
+    displayName: 'MathChain testnet',
+    network: 'mathchain-testnet',
+    prefix: 40,
+    standardAccount: '*25519',
+    symbols: ['MATH'],
+    website: 'https://mathwallet.org'
+  },
+  {
+    decimals: null,
+    displayName: 'Polimec Chain',
+    network: 'poli',
+    prefix: 41,
+    standardAccount: '*25519',
+    symbols: null,
+    website: 'https://polimec.io/'
+  },
+  {
+    decimals: null,
+    displayName: 'Substrate',
+    network: 'substrate',
+    prefix: 42,
+    standardAccount: '*25519',
+    symbols: null,
+    website: 'https://substrate.dev/'
+  },
+  {
+    decimals: null,
+    displayName: 'Bare 32-bit ECDSA SECP-256k1 public key.',
+    network: null,
+    prefix: 43,
+    standardAccount: null,
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: [8],
+    displayName: 'ChainX',
+    network: 'chainx',
+    prefix: 44,
+    standardAccount: '*25519',
+    symbols: ['PCX'],
+    website: 'https://chainx.org/'
+  },
+  {
+    decimals: [12, 12],
+    displayName: 'UniArts Network',
+    network: 'uniarts',
+    prefix: 45,
+    standardAccount: '*25519',
+    symbols: ['UART', 'UINK'],
+    website: 'https://uniarts.me'
+  },
+  {
+    decimals: null,
+    displayName: 'This prefix is reserved.',
+    network: 'reserved46',
+    prefix: 46,
+    standardAccount: null,
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: null,
+    displayName: 'This prefix is reserved.',
+    network: 'reserved47',
+    prefix: 47,
+    standardAccount: null,
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: [12],
+    displayName: 'Neatcoin Mainnet',
+    network: 'neatcoin',
+    prefix: 48,
+    standardAccount: '*25519',
+    symbols: ['NEAT'],
+    website: 'https://neatcoin.org'
+  },
+  {
+    decimals: [12],
+    displayName: 'HydraDX',
+    network: 'hydradx',
+    prefix: 63,
+    standardAccount: '*25519',
+    symbols: ['HDX'],
+    website: 'https://hydradx.io'
+  },
+  {
+    decimals: [18],
+    displayName: 'AvN Mainnet',
+    network: 'aventus',
+    prefix: 65,
+    standardAccount: '*25519',
+    symbols: ['AVT'],
+    website: 'https://aventus.io'
+  },
+  {
+    decimals: [12],
+    displayName: 'Crust Network',
+    network: 'crust',
+    prefix: 66,
+    standardAccount: '*25519',
+    symbols: ['CRU'],
+    website: 'https://crust.network'
+  },
+  {
+    decimals: [18],
+    displayName: 'SORA Network',
+    network: 'sora',
+    prefix: 69,
+    standardAccount: '*25519',
+    symbols: ['XOR'],
+    website: 'https://sora.org'
+  },
+  {
+    decimals: [18],
+    displayName: 'Social Network',
+    network: 'social-network',
+    prefix: 252,
+    standardAccount: '*25519',
+    symbols: ['NET'],
+    website: 'https://social.network'
+  }
+];

packages/networks/src/types.ts

@@ -3,32 +3,38 @@
 
 export type Icon = 'beachball' | 'empty' | 'jdenticon' | 'polkadot' | 'substrate';
 
-export interface NetworkFromSubstrate {
+export interface KnownSubstrate {
   decimals: number[] | null,
   displayName: string;
   network: string | null;
   prefix: number;
-  genesisHash?: string[] | null;
-  hasLedgerSupport?: boolean;
-  icon?: Icon | null;
-  isIgnored?: boolean;
-  slip44?: number;
   standardAccount: '*25519' | null;
   symbols: string[] | null;
   website: string | null;
 }
 
-export interface NetworkFromSubstrateNamed extends NetworkFromSubstrate {
+export type KnownIcon = Record<string, Icon>;
+
+export type KnownLedger = Record<string, number>;
+
+export type KnownGenesis = Record<string, string[]>;
+
+export type KnownTestnet = Record<string, true>;
+
+export interface SubstrateNetwork extends KnownSubstrate {
+  genesisHash: string[];
+  hasLedgerSupport: boolean;
+  icon: Icon;
+  isIgnored: boolean;
+  slip44?: number | null;
+}
+
+export interface Network extends SubstrateNetwork {
   network: string;
 }
 
-export interface Network extends NetworkFromSubstrateNamed {
-  genesisHash: string[];
-  icon: Icon;
-}
-
 export interface Ss58Registry {
-  registry: NetworkFromSubstrate[];
+  registry: KnownSubstrate[];
   specification: string;
   schema: Record<string, string>;
 }

packages/util-crypto/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@polkadot/util-crypto",
-  "version": "5.9.2",
+  "version": "6.3.1",
+  "type": "module",
   "description": "A collection of useful crypto utilities for @polkadot",
   "main": "index.js",
   "sideEffects": [
     "./detectPackage.js",
-    "./detectPackage.mjs"
+    "./detectPackage.cjs"
   ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "author": "Jaco Greeff <jacogr@gmail.com>",
   "maintainers": [],
   "contributors": [],
@@ -15,11 +19,11 @@
   "bugs": "https://github.com/polkadot-js/common/issues",
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme",
   "dependencies": {
-    "@babel/runtime": "^7.13.8",
-    "@polkadot/networks": "5.9.2",
-    "@polkadot/util": "5.9.2",
-    "@polkadot/wasm-crypto": "^3.2.4",
-    "@polkadot/x-randomvalues": "5.9.2",
+    "@babel/runtime": "^7.13.17",
+    "@polkadot/networks": "6.3.1",
+    "@polkadot/util": "6.3.1",
+    "@polkadot/wasm-crypto": "^4.0.2",
+    "@polkadot/x-randomvalues": "6.3.1",
     "base-x": "^3.0.8",
     "base64-js": "^1.5.1",
     "blakejs": "^1.1.0",
@@ -40,6 +44,6 @@
     "@types/xxhashjs": "^0.2.2"
   },
   "peerDependencies": {
-    "@polkadot/util": "5.9.2"
+    "@polkadot/util": "6.3.1"
   }
 }

packages/util-crypto/src/address/decode.ts

@@ -10,7 +10,9 @@ import { base58Decode } from '../base58/decode';
 import { checkAddressChecksum } from './checksum';
 import { defaults } from './defaults';
 
-export function decodeAddress (encoded: string | Uint8Array, ignoreChecksum?: boolean, ss58Format: Prefix = -1): Uint8Array {
+export function decodeAddress (encoded?: string | Uint8Array | null, ignoreChecksum?: boolean, ss58Format: Prefix = -1): Uint8Array {
+  assert(encoded, 'Invalid empty address passed');
+
   if (isU8a(encoded) || isHex(encoded)) {
     return u8aToU8a(encoded);
   }
@@ -23,7 +25,7 @@ export function decodeAddress (encoded: string | Uint8Array, ignoreChecksum?: bo
     const [isValid, endPos, ss58Length, ss58Decoded] = checkAddressChecksum(decoded);
 
     assert(ignoreChecksum || isValid, 'Invalid decoded address checksum');
-    assert([-1, ss58Decoded].includes(ss58Format), `Expected ss58Format ${ss58Format}, received ${ss58Decoded}`);
+    assert([-1, ss58Decoded].includes(ss58Format), () => `Expected ss58Format ${ss58Format}, received ${ss58Decoded}`);
 
     return decoded.slice(ss58Length, endPos);
   } catch (error) {

packages/util-crypto/src/address/encode.ts

@@ -11,27 +11,27 @@ import { decodeAddress } from './decode';
 import { defaults } from './defaults';
 import { sshash } from './sshash';
 
-export function encodeAddress (_key: Uint8Array | string, ss58Format: Prefix = defaults.prefix): string {
+export function encodeAddress (key: Uint8Array | string, ss58Format: Prefix = defaults.prefix): string {
   // decode it, this means we can re-encode an address
-  const key = decodeAddress(_key);
+  const u8a = decodeAddress(key);
 
   assert(ss58Format >= 0 && ss58Format <= 16383 && ![46, 47].includes(ss58Format), 'Out of range ss58Format specified');
-  assert(defaults.allowedDecodedLengths.includes(key.length), `Expected a valid key to convert, with length ${defaults.allowedDecodedLengths.join(', ')}`);
+  assert(defaults.allowedDecodedLengths.includes(u8a.length), () => `Expected a valid key to convert, with length ${defaults.allowedDecodedLengths.join(', ')}`);
 
-  const isPublicKey = [32, 33].includes(key.length);
   const input = u8aConcat(
-    new Uint8Array(
-      ss58Format < 64
-        ? [ss58Format]
-        : [
-          ((ss58Format & 0b0000_0000_1111_1100) >> 2) | 0b0100_0000,
-          (ss58Format >> 8) | ((ss58Format & 0b0000_0000_0000_0011) << 6)
-        ]
-    ),
-    key
+    ss58Format < 64
+      ? [ss58Format]
+      : [
+        ((ss58Format & 0b0000_0000_1111_1100) >> 2) | 0b0100_0000,
+        (ss58Format >> 8) | ((ss58Format & 0b0000_0000_0000_0011) << 6)
+      ],
+    u8a
   );
 
   return base58Encode(
-    u8aConcat(input, sshash(input).subarray(0, isPublicKey ? 2 : 1))
+    u8aConcat(
+      input,
+      sshash(input).subarray(0, [32, 33].includes(u8a.length) ? 2 : 1)
+    )
   );
 }

packages/util-crypto/src/address/index.ts

@@ -13,5 +13,7 @@ export { encodeDerivedAddress } from './encodeDerived';
 export { encodeMultiAddress } from './encodeMulti';
 export { evmToAddress } from './evmToAddress';
 export { addressEq } from './eq';
+export { isAddress } from './is';
 export { setSS58Format } from './setSS58Format';
 export { sortAddresses } from './sort';
+export { validateAddress } from './validate';

packages/util-crypto/src/address/is.ts

@@ -0,0 +1,14 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Prefix } from './types';
+
+import { validateAddress } from './validate';
+
+export function isAddress (address?: string | null, ignoreChecksum?: boolean, ss58Format?: Prefix): address is string {
+  try {
+    return validateAddress(address, ignoreChecksum, ss58Format);
+  } catch (error) {
+    return false;
+  }
+}

packages/util-crypto/src/address/validate.ts

@@ -0,0 +1,10 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Prefix } from './types';
+
+import { decodeAddress } from './decode';
+
+export function validateAddress (encoded?: string | null, ignoreChecksum?: boolean, ss58Format?: Prefix): encoded is string {
+  return !!decodeAddress(encoded, ignoreChecksum, ss58Format);
+}

packages/util-crypto/src/base32/is.ts

@@ -11,6 +11,6 @@ export function testValidator (validate: (value?: string | null, ipfsCompat?: bo
   }
 }
 
-export function isBase32 (value?: string | null, ipfsCompat?: boolean): boolean {
+export function isBase32 (value?: string | null, ipfsCompat?: boolean): value is string {
   return testValidator(base32Validate, value, ipfsCompat);
 }

packages/util-crypto/src/base32/validate.ts

@@ -10,8 +10,8 @@ const BASE_CONFIG = { alphabet: BASE32_ALPHABET, ipfsChar: 'b', type: 'base32' }
  * @name base32Validate
  * @summary Validates a base32 value.
  * @description
- * Validates the the supplied value is valid base32
+ * Validates that the supplied value is valid base32
  */
-export function base32Validate (value?: string | null, ipfsCompat?: boolean): true {
+export function base32Validate (value?: string | null, ipfsCompat?: boolean): value is string {
   return validateChars(BASE_CONFIG, value, ipfsCompat);
 }

packages/util-crypto/src/base58/is.ts

@@ -4,6 +4,6 @@
 import { testValidator } from '../base32/is';
 import { base58Validate } from './validate';
 
-export function isBase58 (value?: string | null, ipfsCompat?: boolean): boolean {
+export function isBase58 (value?: string | null, ipfsCompat?: boolean): value is string {
   return testValidator(base58Validate, value, ipfsCompat);
 }

packages/util-crypto/src/base58/validate.ts

@@ -14,11 +14,11 @@ interface CheckConfig {
 const BASE_CONFIG = { alphabet: BASE58_ALPHABET, ipfsChar: 'z', type: 'base58' };
 
 export function validateChars ({ alphabet, ipfsChar, type }: CheckConfig, value?: string | null, ipfsCompat?: boolean): true {
-  assert(value, `Expected non-null, non-empty ${type} input`);
-  assert(!ipfsCompat || value[0] === ipfsChar, `Expected ${type} to start with '${ipfsChar}'`);
+  assert(value, () => `Expected non-null, non-empty ${type} input`);
+  assert(!ipfsCompat || value[0] === ipfsChar, () => `Expected ${type} to start with '${ipfsChar}'`);
 
   for (let i = (ipfsCompat ? 1 : 0); i < value.length; i++) {
-    assert(alphabet.includes(value[i]), `Invalid ${type} character "${value[i]}" (0x${value.charCodeAt(i).toString(16)}) at index ${i}`);
+    assert(alphabet.includes(value[i]), () => `Invalid ${type} character "${value[i]}" (0x${value.charCodeAt(i).toString(16)}) at index ${i}`);
   }
 
   return true;
@@ -28,8 +28,8 @@ export function validateChars ({ alphabet, ipfsChar, type }: CheckConfig, value?
  * @name base58Validate
  * @summary Validates a base58 value.
  * @description
- * Validates the the supplied value is valid base58
+ * Validates that the supplied value is valid base58
  */
-export function base58Validate (value?: string | null, ipfsCompat?: boolean): true {
+export function base58Validate (value?: string | null, ipfsCompat?: boolean): value is string {
   return validateChars(BASE_CONFIG, value, ipfsCompat);
 }

packages/util-crypto/src/base64/is.ts

@@ -3,7 +3,7 @@
 
 import { base64Validate } from './validate';
 
-export function isBase64 (value?: string | null): boolean {
+export function isBase64 (value?: string | null): value is string {
   try {
     return base64Validate(value);
   } catch (error) {

packages/util-crypto/src/base64/validate.ts

@@ -7,9 +7,9 @@ import { assert } from '@polkadot/util';
  * @name base64Validate
  * @summary Validates a base64 value.
  * @description
- * Validates the the supplied value is valid base64
+ * Validates that the supplied value is valid base64
  */
-export function base64Validate (value?: string | null): true {
+export function base64Validate (value?: string | null): value is string {
   assert(value, 'Expected non-null, non-empty base64 input');
   assert(/^(?:[A-Za-z0-9+/]{2}[A-Za-z0-9+/]{2})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(value), 'Invalid base64 encoding');
 

packages/util-crypto/src/index.ts

@@ -16,6 +16,7 @@ export * from './crypto';
 export * from './ethereum';
 export * from './hd';
 export * from './hmac';
+export * from './json';
 export * from './keccak';
 export * from './key';
 export * from './mnemonic';

packages/util-crypto/src/json/constants.ts

@@ -0,0 +1,11 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { EncryptedJsonEncoding, EncryptedJsonVersion } from './types';
+
+export const ENCODING: EncryptedJsonEncoding[] = ['scrypt', 'xsalsa20-poly1305'];
+export const ENCODING_NONE: EncryptedJsonEncoding[] = ['none'];
+export const ENCODING_VERSION: EncryptedJsonVersion = '3';
+
+export const NONCE_LENGTH = 24;
+export const SCRYPT_LENGTH = 32 + (3 * 4);

packages/util-crypto/src/json/decrypt.ts

@@ -0,0 +1,23 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { EncryptedJson } from './types';
+
+import { assert, hexToU8a, isHex } from '@polkadot/util';
+
+import { base64Decode } from '../base64';
+import { jsonDecryptData } from './decryptData';
+
+export function jsonDecrypt ({ encoded, encoding }: EncryptedJson, passphrase?: string | null): Uint8Array {
+  assert(encoded, 'No encrypted data available to decode');
+
+  return jsonDecryptData(
+    isHex(encoded)
+      ? hexToU8a(encoded)
+      : base64Decode(encoded),
+    passphrase,
+    Array.isArray(encoding.type)
+      ? encoding.type
+      : [encoding.type]
+  );
+}

packages/util-crypto/src/json/decryptData.ts

@@ -0,0 +1,40 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { EncryptedJsonEncoding } from './types';
+
+import { assert, stringToU8a, u8aFixLength } from '@polkadot/util';
+
+import { naclDecrypt } from '../nacl';
+import { scryptEncode, scryptFromU8a } from '../scrypt';
+import { ENCODING, NONCE_LENGTH, SCRYPT_LENGTH } from './constants';
+
+export function jsonDecryptData (encrypted?: Uint8Array | null, passphrase?: string | null, encType: EncryptedJsonEncoding[] = ENCODING): Uint8Array {
+  assert(encrypted, 'No encrypted data available to decode');
+  assert(passphrase || !encType.includes('xsalsa20-poly1305'), 'Password required to decode encypted data');
+
+  let encoded: Uint8Array | null = encrypted;
+
+  if (passphrase) {
+    let password: Uint8Array;
+
+    if (encType.includes('scrypt')) {
+      const { params, salt } = scryptFromU8a(encrypted);
+
+      password = scryptEncode(passphrase, salt, params).password;
+      encrypted = encrypted.subarray(SCRYPT_LENGTH);
+    } else {
+      password = stringToU8a(passphrase);
+    }
+
+    encoded = naclDecrypt(
+      encrypted.subarray(NONCE_LENGTH),
+      encrypted.subarray(0, NONCE_LENGTH),
+      u8aFixLength(password, 256, true)
+    );
+  }
+
+  assert(encoded, 'Unable to decode using the supplied passphrase');
+
+  return encoded;
+}

packages/util-crypto/src/json/encrypt.ts

@@ -0,0 +1,25 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { EncryptedJson } from './types';
+
+import { u8aConcat } from '@polkadot/util';
+
+import { naclEncrypt } from '../nacl';
+import { scryptEncode, scryptToU8a } from '../scrypt';
+import { jsonEncryptFormat } from './encryptFormat';
+
+export function jsonEncrypt (data: Uint8Array, contentType: string[], passphrase?: string | null): EncryptedJson {
+  let isEncrypted = false;
+  let encoded = data;
+
+  if (passphrase) {
+    const { params, password, salt } = scryptEncode(passphrase);
+    const { encrypted, nonce } = naclEncrypt(encoded, password.subarray(0, 32));
+
+    isEncrypted = true;
+    encoded = u8aConcat(scryptToU8a(salt, params), nonce, encrypted);
+  }
+
+  return jsonEncryptFormat(encoded, contentType, isEncrypted);
+}

packages/util-crypto/src/json/encryptFormat.ts

@@ -0,0 +1,20 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { EncryptedJson } from './types';
+
+import { base64Encode } from '../base64';
+import { ENCODING, ENCODING_NONE, ENCODING_VERSION } from './constants';
+
+export function jsonEncryptFormat (encoded: Uint8Array, contentType: string[], isEncrypted: boolean): EncryptedJson {
+  return {
+    encoded: base64Encode(encoded),
+    encoding: {
+      content: contentType,
+      type: isEncrypted
+        ? ENCODING
+        : ENCODING_NONE,
+      version: ENCODING_VERSION
+    }
+  };
+}

packages/util-crypto/src/json/index.ts

@@ -0,0 +1,7 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export { jsonDecrypt } from './decrypt';
+export { jsonDecryptData } from './decryptData';
+export { jsonEncrypt } from './encrypt';
+export { jsonEncryptFormat } from './encryptFormat';

packages/util-crypto/src/json/types.ts

@@ -0,0 +1,17 @@
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export type EncryptedJsonVersion = '0' | '1' | '2' | '3';
+
+export type EncryptedJsonEncoding = 'none' | 'scrypt' | 'xsalsa20-poly1305';
+
+export interface EncryptedJsonDescriptor {
+  content: string[];
+  type: EncryptedJsonEncoding | EncryptedJsonEncoding[];
+  version: EncryptedJsonVersion;
+}
+
+export interface EncryptedJson {
+  encoded: string;
+  encoding: EncryptedJsonDescriptor;
+}

packages/util-crypto/src/key/extractPath.ts

@@ -28,7 +28,7 @@ export function keyExtractPath (derivePath: string): ExtractResult {
     });
   }
 
-  assert(constructed === derivePath, `Re-constructed path "${constructed}" does not match input`);
+  assert(constructed === derivePath, () => `Re-constructed path "${constructed}" does not match input`);
 
   return {
     parts,

packages/util-crypto/src/mnemonic/toLegacySeed.ts

@@ -26,7 +26,7 @@ import { mnemonicValidate } from './validate';
  */
 export function mnemonicToLegacySeed (mnemonic: string, password = '', onlyJs = false, byteLength: 32 | 64 = 32): Uint8Array {
   assert(mnemonicValidate(mnemonic), 'Invalid bip39 mnemonic specified');
-  assert([32, 64].includes(byteLength), `Invalid seed length ${byteLength}, expected 32 or 64`);
+  assert([32, 64].includes(byteLength), () => `Invalid seed length ${byteLength}, expected 32 or 64`);
 
   if (byteLength && byteLength === 32) {
     return isReady() && !onlyJs

packages/util-crypto/src/nacl/verify.ts

@@ -25,8 +25,8 @@ export function naclVerify (message: Uint8Array | string, signature: Uint8Array
   const publicKeyU8a = u8aToU8a(publicKey);
   const signatureU8a = u8aToU8a(signature);
 
-  assert(publicKeyU8a.length === 32, `Invalid publicKey, received ${publicKeyU8a.length}, expected 32`);
-  assert(signatureU8a.length === 64, `Invalid signature, received ${signatureU8a.length} bytes, expected 64`);
+  assert(publicKeyU8a.length === 32, () => `Invalid publicKey, received ${publicKeyU8a.length}, expected 32`);
+  assert(signatureU8a.length === 64, () => `Invalid signature, received ${signatureU8a.length} bytes, expected 64`);
 
   return isReady() && !onlyJs
     ? ed25519Verify(signatureU8a, messageU8a, publicKeyU8a)

packages/util-crypto/src/packageInfo.ts

@@ -1,6 +1,6 @@
-// Copyright 2017-2021 @polkadot/dev authors & contributors
+// Copyright 2017-2021 @polkadot/util-crypto authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 // Auto-generated by @polkadot/dev, do not edit
 
-export const packageInfo = { name: '@polkadot/util-crypto', version: '5.9.2' };
+export const packageInfo = { name: '@polkadot/util-crypto', version: '6.3.1' };

packages/util-crypto/src/schnorrkel/verify.ts

@@ -12,8 +12,8 @@ export function schnorrkelVerify (message: Uint8Array | string, signature: Uint8
   const publicKeyU8a = u8aToU8a(publicKey);
   const signatureU8a = u8aToU8a(signature);
 
-  assert(publicKeyU8a.length === 32, `Invalid publicKey, received ${publicKeyU8a.length} bytes, expected 32`);
-  assert(signatureU8a.length === 64, `Invalid signature, received ${signatureU8a.length} bytes, expected 64`);
+  assert(publicKeyU8a.length === 32, () => `Invalid publicKey, received ${publicKeyU8a.length} bytes, expected 32`);
+  assert(signatureU8a.length === 64, () => `Invalid signature, received ${signatureU8a.length} bytes, expected 64`);
 
   return sr25519Verify(signatureU8a, u8aToU8a(message), publicKeyU8a);
 }

packages/util-crypto/src/signature/verify.ts

@@ -54,7 +54,7 @@ function verifyDetect (result: VerifyResult, { message, publicKey, signature }:
 }
 
 function verifyMultisig (result: VerifyResult, { message, publicKey, signature }: VerifyInput): VerifyResult {
-  assert([0, 1, 2].includes(signature[0]), `Unknown crypto type, expected signature prefix [0..2], found ${signature[0]}`);
+  assert([0, 1, 2].includes(signature[0]), () => `Unknown crypto type, expected signature prefix [0..2], found ${signature[0]}`);
 
   const type = CRYPTO_TYPES[signature[0]] || 'none';
 
@@ -77,7 +77,7 @@ function verifyMultisig (result: VerifyResult, { message, publicKey, signature }
 export function signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string): VerifyResult {
   const signatureU8a = u8aToU8a(signature);
 
-  assert([64, 65, 66].includes(signatureU8a.length), `Invalid signature length, expected [64..66] bytes, found ${signatureU8a.length}`);
+  assert([64, 65, 66].includes(signatureU8a.length), () => `Invalid signature length, expected [64..66] bytes, found ${signatureU8a.length}`);
 
   const publicKey = decodeAddress(addressOrPublicKey);
   const input = { message, publicKey, signature: signatureU8a };

packages/util/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@polkadot/util",
-  "version": "5.9.2",
+  "version": "6.3.1",
+  "type": "module",
   "description": "A collection of useful utilities for @polkadot",
   "main": "index.js",
   "sideEffects": [
     "./detectPackage.js",
-    "./detectPackage.mjs"
+    "./detectPackage.cjs"
   ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "author": "Jaco Greeff <jacogr@gmail.com>",
   "maintainers": [],
   "contributors": [],
@@ -15,9 +19,9 @@
   "bugs": "https://github.com/polkadot-js/common/issues",
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util#readme",
   "dependencies": {
-    "@babel/runtime": "^7.13.8",
-    "@polkadot/x-textdecoder": "5.9.2",
-    "@polkadot/x-textencoder": "5.9.2",
+    "@babel/runtime": "^7.13.17",
+    "@polkadot/x-textdecoder": "6.3.1",
+    "@polkadot/x-textencoder": "6.3.1",
     "@types/bn.js": "^4.11.6",
     "bn.js": "^4.11.9",
     "camelcase": "^5.3.1",

packages/util/src/bn/sqrt.ts

@@ -9,6 +9,8 @@ import { assert } from '../assert';
 import { BN_MAX_INTEGER, BN_ONE, BN_ZERO } from '../bn';
 import { bnToBn } from './toBn';
 
+const SQRT_MAX_SAFE_INTEGER = new BN(94906265);
+
 /**
  * @name bnSqrt
  * @summary Calculates the integer square root of a BN
@@ -35,7 +37,7 @@ export function bnSqrt <ExtToBn extends ToBn> (value: ExtToBn | BN | BigInt | st
 
   // Use sqrt(MAX_SAFE_INTEGER) as starting point. since we already know the
   // output will be larger than this, we expect this to be a safe start
-  let x0 = new BN(94906265);
+  let x0 = SQRT_MAX_SAFE_INTEGER.clone();
 
   while (true) {
     const x1 = n.div(x0).iadd(x0).ishrn(1);

packages/util/src/bn/toBn.ts

@@ -10,14 +10,6 @@ import { isBigInt } from '../is/bigInt';
 import { isHex } from '../is/hex';
 import { isToBn } from '../is/toBn';
 
-function numberToBn <ExtToBn extends ToBn> (value: number | ExtToBn | BN): BN {
-  return BN.isBN(value)
-    ? value
-    : isToBn(value)
-      ? value.toBn()
-      : new BN(value);
-}
-
 /**
  * @name bnToBn
  * @summary Creates a BN value from a BN, BigInt, string (base 10 or hex) or number input.
@@ -43,5 +35,9 @@ export function bnToBn <ExtToBn extends ToBn> (value?: ExtToBn | BN | BigInt | s
     return new BN(value.toString());
   }
 
-  return numberToBn(value);
+  return BN.isBN(value)
+    ? value
+    : isToBn(value)
+      ? value.toBn()
+      : new BN(value);
 }

packages/util/src/bn/util.ts

@@ -8,5 +8,5 @@ import { assert } from '../assert';
 export function checkMaxMin (type: 'max' | 'min', items: BN[]): BN {
   assert(items.length >= 1, 'Must provide one or more BN arguments');
 
-  return items.reduce((acc: BN, val: BN) => BN[type](acc, val), items[0]);
+  return items.reduce<BN>((a, v) => BN[type](a, v), items[0]);
 }

packages/util/src/compact/fromU8a.spec.ts

@@ -15,25 +15,28 @@ describe('compactFromU8a', (): void => {
 
   it('decodes from same u16 encoded value', (): void => {
     expect(
-      compactFromU8a(new Uint8Array([0b11111101, 0b00000111]), 32)
+      compactFromU8a(new Uint8Array([0b11111101, 0b00000111]))
     ).toEqual([2, new BN(511)]);
   });
 
   it('decodes from same u32 encoded value (short)', (): void => {
     expect(
-      compactFromU8a(new Uint8Array([254, 255, 3, 0]), 32)
-    ).toEqual([4, new BN(0xffff)]);
+      compactFromU8a(new Uint8Array([254, 255, 3, 0]))
+    ).toEqual(
+      // since we use in-place, the words are different... HACK it
+      [4, new BN(0xffff).ishln(16).ishrn(16)]
+    );
   });
 
   it('decodes from same u32 encoded value (full)', (): void => {
     expect(
-      compactFromU8a(new Uint8Array([3, 249, 255, 255, 255]), 32)
+      compactFromU8a(new Uint8Array([3, 249, 255, 255, 255]))
     ).toEqual([5, new BN(0xfffffff9)]);
   });
 
   it('decodes from same u32 as u64 encoded value (full, default)', (): void => {
     expect(
-      compactFromU8a(new Uint8Array([3 + ((4 - 4) << 2), 249, 255, 255, 255]), 64)
+      compactFromU8a(new Uint8Array([3 + ((4 - 4) << 2), 249, 255, 255, 255]))
     ).toEqual([5, new BN(0xfffffff9)]);
   });
 
@@ -44,4 +47,12 @@ describe('compactFromU8a', (): void => {
       )
     ).toEqual([7, new BN('5af3107a4000', 16)]);
   });
+
+  it('decodes an actual value', (): void => {
+    expect(
+      compactFromU8a(
+        hexToU8a('0x0284d717')
+      )[1].toString()
+    ).toEqual('100000000');
+  });
 });

packages/util/src/compact/fromU8a.ts

@@ -1,12 +1,10 @@
 // Copyright 2017-2021 @polkadot/util authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import type { BitLength } from './types';
-
 import BN from 'bn.js';
 
+import { BN_FOUR } from '../bn';
 import { u8aToBn, u8aToU8a } from '../u8a';
-import { DEFAULT_BITLENGTH } from './defaults';
 
 /**
  * @name compactFromU8a
@@ -17,29 +15,29 @@ import { DEFAULT_BITLENGTH } from './defaults';
  * ```javascript
  * import { compactFromU8a } from '@polkadot/util';
  *
- * const [offset, length] = compactFromU8a(new Uint8Array([254, 255, 3, 0]), 32));
+ * const [offset, length] = compactFromU8a(new Uint8Array([254, 255, 3, 0]));
  *
  * console.log('value offset=', offset, 'length=', length); // 4, 0xffff
  * ```
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function compactFromU8a (_input: Uint8Array | string, bitLength: BitLength = DEFAULT_BITLENGTH): [number, BN] {
+export function compactFromU8a (_input: Buffer | Uint8Array | string | number[]): [number, BN] {
   const input = u8aToU8a(_input);
   const flag = input[0] & 0b11;
 
   if (flag === 0b00) {
-    return [1, new BN(input[0]).shrn(2)];
+    return [1, new BN(input[0]).ishrn(2)];
   } else if (flag === 0b01) {
-    return [2, u8aToBn(input.slice(0, 2), true).shrn(2)];
+    return [2, u8aToBn(input.slice(0, 2), true).ishrn(2)];
   } else if (flag === 0b10) {
-    return [4, u8aToBn(input.slice(0, 4), true).shrn(2)];
+    return [4, u8aToBn(input.slice(0, 4), true).ishrn(2)];
   }
 
-  const length = new BN(input[0])
-    .shrn(2) // clear flag
-    .addn(4) // add 4 for base length
-    .toNumber();
-  const offset = 1 + length;
+  const offset = 1 + (
+    new BN(input[0])
+      .ishrn(2) // clear flag
+      .iadd(BN_FOUR) // add 4 for base length
+      .toNumber()
+  );
 
   return [offset, u8aToBn(input.subarray(1, offset), true)];
 }

packages/util/src/compact/stripLength.ts

@@ -1,9 +1,6 @@
 // Copyright 2017-2021 @polkadot/util authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import type { BitLength } from './types';
-
-import { DEFAULT_BITLENGTH } from './defaults';
 import { compactFromU8a } from './fromU8a';
 
 /**
@@ -18,8 +15,8 @@ import { compactFromU8a } from './fromU8a';
  * console.log(compactStripLength(new Uint8Array([2 << 2, 0xde, 0xad]))); // [2, Uint8Array[0xde, 0xad]]
  * ```
  */
-export function compactStripLength (input: Uint8Array, bitLength: BitLength = DEFAULT_BITLENGTH): [number, Uint8Array] {
-  const [offset, length] = compactFromU8a(input, bitLength);
+export function compactStripLength (input: Uint8Array): [number, Uint8Array] {
+  const [offset, length] = compactFromU8a(input);
   const total = offset + length.toNumber();
 
   return [

packages/util/src/compact/toU8a.spec.ts

@@ -72,6 +72,13 @@ describe('encode', (): void => {
     );
   });
 
+  it('does not modify the original', (): void => {
+    const original = new BN(123456);
+
+    expect(compactToU8a(original)).toEqual(new Uint8Array([2, 137, 7, 0]));
+    expect(original.toString()).toEqual('123456');
+  });
+
   describe('from Rust', (): void => {
     // Copied from https://github.com/paritytech/parity-codec/blob/master/src/codec.rs
     const testCases = [

packages/util/src/compact/toU8a.ts

@@ -4,7 +4,7 @@
 import BN from 'bn.js';
 
 import { assert } from '../assert';
-import { bnToBn, bnToU8a } from '../bn';
+import { BN_ONE, BN_TWO, bnToBn, bnToU8a } from '../bn';
 import { u8aConcat } from '../u8a';
 
 const MAX_U8 = new BN(2).pow(new BN(8 - 2)).subn(1);
@@ -29,9 +29,9 @@ export function compactToU8a (_value: BN | BigInt | number): Uint8Array {
   if (value.lte(MAX_U8)) {
     return new Uint8Array([value.toNumber() << 2]);
   } else if (value.lte(MAX_U16)) {
-    return bnToU8a(value.shln(2).addn(0b01), 16, true);
+    return bnToU8a(value.shln(2).iadd(BN_ONE), 16, true);
   } else if (value.lte(MAX_U32)) {
-    return bnToU8a(value.shln(2).addn(0b10), 32, true);
+    return bnToU8a(value.shln(2).iadd(BN_TWO), 32, true);
   }
 
   const u8a = bnToU8a(value);
@@ -42,13 +42,11 @@ export function compactToU8a (_value: BN | BigInt | number): Uint8Array {
     length--;
   }
 
-  assert(length >= 4, 'Previous tests match anyting less than 2^30; qed');
+  assert(length >= 4, 'Invalid length, previous checks match anything less than 2^30');
 
   return u8aConcat(
-    new Uint8Array([
-      // substract 4 as minimum (also catered for in decoding)
-      ((length - 4) << 2) + 0b11
-    ]),
+    // subtract 4 as minimum (also catered for in decoding)
+    [((length - 4) << 2) + 0b11],
     u8a.subarray(0, length)
   );
 }

packages/util/src/hex/addPrefix.ts

@@ -22,9 +22,5 @@ export function hexAddPrefix (value?: string | null): string {
     return value;
   }
 
-  const prefix = value && value.length % 2 === 1
-    ? '0'
-    : '';
-
-  return `0x${prefix}${value || ''}`;
+  return `0x${value && value.length % 2 === 1 ? '0' : ''}${value || ''}`;
 }

packages/util/src/hex/stripPrefix.ts

@@ -22,13 +22,9 @@ const UNPREFIX_HEX_REGEX = /^[a-fA-F0-9]+$/;
 export function hexStripPrefix (value?: string | null): string {
   if (!value) {
     return '';
-  }
-
-  if (hexHasPrefix(value)) {
+  } else if (hexHasPrefix(value)) {
     return value.substr(2);
-  }
-
-  if (UNPREFIX_HEX_REGEX.test(value)) {
+  } else if (UNPREFIX_HEX_REGEX.test(value)) {
     return value;
   }
 

packages/util/src/hex/toBn.ts

@@ -16,7 +16,7 @@ function reverse (value: string): string {
 
 /**
  * @name hexToBn
- * @summary Creates a BN.js bignumber object from a hex string.
+ * @summary Creates a BN.js object from a hex string.
  * @description
  * `null` inputs returns a `BN(0)` result. Hex input values return the actual value converted to a BN. Anything that is not a hex string (including the `0x` prefix) throws an error.
  * @param _value The value to convert
@@ -43,7 +43,6 @@ export function hexToBn (value?: string | number | null, options: ToBnOptions |
     // Backwards-compatibility
     ...(isBoolean(options) ? { isLe: options } : options)
   };
-
   const _value = hexStripPrefix(value as string);
 
   // FIXME: Use BN's 3rd argument `isLe` once this issue is fixed

packages/util/src/hex/toU8a.ts

@@ -25,7 +25,7 @@ export function hexToU8a (_value?: string | null, bitLength = -1): Uint8Array {
     return new Uint8Array();
   }
 
-  assert(isHex(_value), `Expected hex value to convert, found '${_value}'`);
+  assert(isHex(_value), () => `Expected hex value to convert, found '${_value}'`);
 
   const value = hexStripPrefix(_value);
   const valLength = value.length / 2;

packages/util/src/index.ts

@@ -22,5 +22,6 @@ export * from './memoize';
 export * from './number';
 export * from './promisify';
 export * from './string';
+export * from './stringify';
 export * from './u8a';
 export * from './versionDetect';

packages/util/src/is/jsonObject.ts

@@ -1,6 +1,8 @@
 // Copyright 2017-2021 @polkadot/util authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
+import { stringify } from '../stringify';
+
 interface ObjectIndexed {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [index: string]: any;
@@ -32,13 +34,13 @@ interface ObjectIndexed {
  */
 export function isJsonObject (value: unknown): value is ObjectIndexed {
   const str = typeof value !== 'string'
-    ? JSON.stringify(value)
+    ? stringify(value)
     : value;
 
   try {
     const obj = JSON.parse(str) as unknown;
 
-    return (typeof obj === 'object' && obj !== null);
+    return typeof obj === 'object' && obj !== null;
   } catch (e) {
     return false;
   }

packages/util/src/logger.spec.ts

@@ -118,6 +118,8 @@ describe('logger', (): void => {
   });
 
   it('does debug log when DEBUG partial specified', (): void => {
+    process.env.DEBUG = 'test*';
+
     l = logger('testing');
     l.debug('test');
 
@@ -160,4 +162,31 @@ describe('logger', (): void => {
 
     expect(spy.log).not.toHaveBeenCalled();
   });
+
+  it('does not debug log when explicitly excluded', (): void => {
+    process.env.DEBUG = '*,-test';
+
+    l = logger('test');
+    l.debug('test');
+
+    expect(spy.log).not.toHaveBeenCalled();
+  });
+
+  it('does not debug log when part of exclusion group', (): void => {
+    process.env.DEBUG = '*,-test:*';
+
+    l = logger('test:sub');
+    l.debug('test');
+
+    expect(spy.log).not.toHaveBeenCalled();
+  });
+
+  it('does debug log when not part of exclusion groups', (): void => {
+    process.env.DEBUG = '*,-test:*,-tes,-a:*';
+
+    l = logger('test');
+    l.debug('test');
+
+    expect(spy.log).toHaveBeenCalled();
+  });
 });

packages/util/src/logger.ts

@@ -77,11 +77,29 @@ function noop (): void {
 }
 
 function parseEnv (type: string): [boolean, number] {
-  const maxSize = parseInt(process?.env?.DEBUG_MAX || '-1', 10);
+  const env = (typeof process === 'object' ? process : {}).env || {};
+  const maxSize = parseInt(env.DEBUG_MAX || '-1', 10);
+
+  let isDebugOn = false;
+
+  (env.DEBUG || '')
+    .toLowerCase()
+    .split(',')
+    .forEach((e) => {
+      if (!!e && (e === '*' || type === e || (e.endsWith('*') && type.startsWith(e.slice(0, -1))))) {
+        isDebugOn = true;
+      }
+
+      if (!!e && e.startsWith('-') && (type === e.slice(1) || (e.endsWith('*') && type.startsWith(e.slice(1, -1))))) {
+        isDebugOn = false;
+      }
+    });
 
   return [
-    (process?.env?.DEBUG || '').toLowerCase().split(',').some((e) => !!e && (e === '*' || type.startsWith(e))),
-    isNaN(maxSize) ? -1 : maxSize
+    isDebugOn,
+    isNaN(maxSize)
+      ? -1
+      : maxSize
   ];
 }
 

packages/util/src/memoize.ts

@@ -3,8 +3,8 @@
 
 import type { Memoized } from './types';
 
-import { isBigInt } from './is/bigInt';
 import { isUndefined } from './is/undefined';
+import { stringify } from './stringify';
 
 interface Options {
   getInstanceId?: () => string;
@@ -14,20 +14,12 @@ function defaultGetId (): string {
   return 'none';
 }
 
-function normalize (args: unknown[]): string {
-  return JSON.stringify(args, (_, value: unknown) =>
-    isBigInt(value)
-      ? value.toString()
-      : value
-  );
-}
-
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function memoize <T, F extends (...args: any[]) => T> (fn: F, { getInstanceId = defaultGetId }: Options = {}): Memoized<F> {
   const cache: Record<string, Record<string, T>> = {};
 
   const memoized = (...args: unknown[]): T => {
-    const stringParams = normalize(args);
+    const stringParams = stringify(args);
     const instanceId = getInstanceId();
 
     if (!cache[instanceId]) {
@@ -42,7 +34,7 @@ export function memoize <T, F extends (...args: any[]) => T> (fn: F, { getInstan
   };
 
   memoized.unmemoize = (...args: unknown[]): void => {
-    const stringParams = normalize(args);
+    const stringParams = stringify(args);
     const instanceId = getInstanceId();
 
     if (cache[instanceId] && !isUndefined(cache[instanceId][stringParams])) {

packages/util/src/packageInfo.ts

@@ -1,6 +1,6 @@
-// Copyright 2017-2021 @polkadot/dev authors & contributors
+// Copyright 2017-2021 @polkadot/util authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 // Auto-generated by @polkadot/dev, do not edit
 
-export const packageInfo = { name: '@polkadot/util', version: '5.9.2' };
+export const packageInfo = { name: '@polkadot/util', version: '6.3.1' };

packages/util/src/stringify.spec.ts

@@ -0,0 +1,32 @@
+// Copyright 2017-2021 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import BN from 'bn.js';
+
+import { stringify } from './stringify';
+
+describe('stringify', (): void => {
+  it('stringifies a BigInt', (): void => {
+    expect(
+      stringify(1234n)
+    ).toEqual('"1234"');
+  });
+
+  it('stringifies an array of values', (): void => {
+    expect(
+      stringify(['a', 1, 2n, new BN(3)])
+    ).toEqual('["a",1,"2","3"]');
+  });
+
+  it('stringifies an array of values (with spaces)', (): void => {
+    expect(
+      stringify(['a', 1, 2n, new BN(3)], 2)
+    ).toEqual('[\n  "a",\n  1,\n  "2",\n  "3"\n]');
+  });
+
+  it('stringifies a nested object', (): void => {
+    expect(
+      stringify({ a: 'a', b: 1, c: { d: 2n, e: new BN(3) } })
+    ).toEqual('{"a":"a","b":1,"c":{"d":"2","e":"3"}}');
+  });
+});

packages/util/src/stringify.ts

@@ -0,0 +1,15 @@
+// Copyright 2017-2021 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { isBigInt } from './is/bigInt';
+
+export function stringify (args: unknown, space?: string | number): string {
+  return JSON.stringify(
+    args,
+    (_, value: unknown) =>
+      isBigInt(value)
+        ? value.toString()
+        : value,
+    space
+  );
+}

packages/util/src/u8a/concat.ts

@@ -23,11 +23,10 @@ import { u8aToU8a } from './toU8a';
 export function u8aConcat (...list: (Buffer | Uint8Array | number[] | string)[]): Uint8Array {
   let length = 0;
   let offset = 0;
-  const u8as = new Array(list.length) as Uint8Array[];
+  const u8as = new Array<Uint8Array>(list.length);
 
   for (let i = 0; i < list.length; i++) {
     u8as[i] = u8aToU8a(list[i]);
-
     length += u8as[i].length;
   }
 

packages/util/src/u8a/toBuffer.ts

@@ -16,7 +16,5 @@
  * ```
  */
 export function u8aToBuffer (value?: Uint8Array | null): Buffer {
-  return !value
-    ? Buffer.from([])
-    : Buffer.from(value);
+  return Buffer.from(value || []);
 }

packages/util/src/u8a/toHex.ts

@@ -5,7 +5,7 @@ const ALPHABET = new Array(256).fill(0).map((_, n) => n.toString(16).padStart(2,
 
 /** @internal */
 function extract (value: Uint8Array): string {
-  const result = new Array(value.length) as string[];
+  const result = new Array<string>(value.length);
 
   for (let i = 0; i < value.length; i++) {
     result[i] = ALPHABET[value[i]];
@@ -44,8 +44,9 @@ export function u8aToHex (value?: Uint8Array | null, bitLength = -1, isPrefixed
 
   const byteLength = Math.ceil(bitLength / 8);
 
-  return prefix + ((byteLength > 0 && value.length > byteLength)
-    ? trim(value, Math.ceil(byteLength / 2))
-    : extract(value)
+  return prefix + (
+    (byteLength > 0 && value.length > byteLength)
+      ? trim(value, Math.ceil(byteLength / 2))
+      : extract(value)
   );
 }

packages/util/src/u8a/toU8a.spec.ts

@@ -40,6 +40,14 @@ describe('u8aToU8a', (): void => {
     );
   });
 
+  it('creates from a Buffer', (): void => {
+    expect(
+      u8aToU8a(Buffer.from([1, 2, 3, 128, 0, 10, 11, 12]))
+    ).toEqual(
+      new Uint8Array([1, 2, 3, 128, 0, 10, 11, 12])
+    );
+  });
+
   it('returns a Uint8Array as-is (u8a input)', (): void => {
     expect(
       u8aToU8a(new Uint8Array([128, 0, 10]))
@@ -47,4 +55,11 @@ describe('u8aToU8a', (): void => {
       new Uint8Array([128, 0, 10])
     );
   });
+
+  it('fails to create from unknown typed values', (): void => {
+    expect(
+      // this is where completely invalid data is being passed
+      () => u8aToU8a(123 as unknown as Uint8Array)
+    ).toThrow('Unable to convert 123 (typeof number) to a Uint8Array');
+  });
 });

packages/util/src/u8a/toU8a.ts

@@ -1,25 +1,14 @@
 // Copyright 2017-2021 @polkadot/util authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
-import { bufferToU8a } from '../buffer/toU8a';
+import { assert } from '../assert';
 import { hexToU8a } from '../hex/toU8a';
 import { isBuffer } from '../is/buffer';
 import { isHex } from '../is/hex';
 import { isString } from '../is/string';
+import { isU8a } from '../is/u8a';
 import { stringToU8a } from '../string/toU8a';
 
-function convertArray (value: number[] | Uint8Array): Uint8Array {
-  return Array.isArray(value)
-    ? Uint8Array.from(value)
-    : value;
-}
-
-function convertString (value: string): Uint8Array {
-  return isHex(value)
-    ? hexToU8a(value)
-    : stringToU8a(value);
-}
-
 /**
  * @name u8aToU8a
  * @summary Creates a Uint8Array value from a Uint8Array, Buffer, string or hex input.
@@ -29,7 +18,7 @@ function convertString (value: string): Uint8Array {
  * <BR>
  *
  * ```javascript
- * import { { u8aToU8a } from '@polkadot/util';
+ * import { u8aToU8a } from '@polkadot/util';
  *
  * u8aToU8a(new Uint8Array([0x12, 0x34]); // => Uint8Array([0x12, 0x34])
  * u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34])
@@ -38,11 +27,15 @@ function convertString (value: string): Uint8Array {
 export function u8aToU8a (value?: number[] | Buffer | Uint8Array | string | null): Uint8Array {
   if (!value) {
     return new Uint8Array();
-  } else if (isBuffer(value)) {
-    return bufferToU8a(value);
   } else if (isString(value)) {
-    return convertString(value);
+    return isHex(value)
+      ? hexToU8a(value)
+      : stringToU8a(value);
+  } else if (Array.isArray(value) || isBuffer(value)) {
+    return new Uint8Array(value);
   }
 
-  return convertArray(value);
+  assert(isU8a(value), () => `Unable to convert ${value.toString()} (typeof ${typeof value}) to a Uint8Array`);
+
+  return value;
 }

packages/util/src/versionDetect.spec.ts

@@ -11,7 +11,7 @@ describe('detectPackage', (): void => {
   const PATH = '/Users/jaco/Projects/polkadot-js/api/node_modules/@polkadot/util';
 
   const MISMATCH = `@polkadot/util has multiple versions, ensure that there is only one installed.
-Either remove and explicitly install matching versions or deupe using your package manager.
+Either remove and explicitly install matching versions or dedupe using your package manager.
 The following conflicting packages were found:
 \t${VER1}\t${PATH}/01
 \t${VER2}        \t${PATH}/02`;
@@ -61,7 +61,7 @@ describe('detectPackageDeps', (): void => {
 
     detectPackage({ name: '@polkadot/two', version: '1.1.1' }, false, [DEP0, DEP1, DEP2, DEP3]);
     expect(spy).toHaveBeenCalledWith(`@polkadot/two requires direct dependencies exactly matching version 1.1.1.
-Either remove and explicitly install matching versions or deupe using your package manager.
+Either remove and explicitly install matching versions or dedupe using your package manager.
 The following conflicting packages were found:
 \t1.1.2\t@polkadot/util
 \t1.1.3\t@polkadot/util-crypto`);

packages/util/src/versionDetect.ts

@@ -26,7 +26,7 @@ interface PjsChecks extends This {
 type PjsWindow = (Window & This) & PjsChecks;
 type FnString = () => string | undefined;
 
-const DEDUPE = 'Either remove and explicitly install matching versions or deupe using your package manager.\nThe following conflicting packages were found:';
+const DEDUPE = 'Either remove and explicitly install matching versions or dedupe using your package manager.\nThe following conflicting packages were found:';
 
 /** @internal */
 function getEntry (name: string): VersionPath[] {
@@ -88,7 +88,7 @@ function getPath (pathOrFn?: FnString | string | false): string {
  * @summary Checks that a specific package is only imported once
  */
 export function detectPackage ({ name, version }: PackageJson, pathOrFn?: FnString | string | false, deps: PackageJson[] = []): void {
-  assert(name.startsWith('@polkadot'), `Invalid package descriptor ${name}`);
+  assert(name.startsWith('@polkadot'), () => `Invalid package descriptor ${name}`);
 
   const entry = getEntry(name);
 

packages/x-fetch/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@polkadot/x-fetch",
-  "version": "5.9.2",
+  "version": "6.3.1",
+  "type": "module",
   "description": "A cross-environment fetch replacement",
   "browser": "browser.js",
   "main": "node.js",
   "react-native": "react-native.js",
   "sideEffects": false,
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "author": "Jaco Greeff <jacogr@gmail.com>",
   "maintainers": [],
   "contributors": [],
@@ -14,9 +18,9 @@
   "bugs": "https://github.com/polkadot-js/common/issues",
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/x-fetch#readme",
   "dependencies": {
-    "@babel/runtime": "^7.13.8",
-    "@polkadot/x-global": "5.9.2",
-    "@types/node-fetch": "^2.5.8",
+    "@babel/runtime": "^7.13.17",
+    "@polkadot/x-global": "6.3.1",
+    "@types/node-fetch": "^2.5.10",
     "node-fetch": "^2.6.1"
   }
 }

packages/x-fetch/src/packageInfo.ts

@@ -1,6 +1,6 @@
-// Copyright 2017-2021 @polkadot/dev authors & contributors
+// Copyright 2017-2021 @polkadot/x-fetch authors & contributors
 // SPDX-License-Identifier: Apache-2.0
 
 // Auto-generated by @polkadot/dev, do not edit
 
-export const packageInfo = { name: '@polkadot/x-fetch', version: '5.9.2' };
+export const packageInfo = { name: '@polkadot/x-fetch', version: '6.3.1' };

packages/x-global/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@polkadot/x-global",
-  "version": "5.9.2",
+  "version": "6.3.1",
+  "type": "module",
   "description": "A cross-environment global replacement",
   "main": "index.js",
   "sideEffects": false,
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "author": "Jaco Greeff <jacogr@gmail.com>",
   "maintainers": [],
   "contributors": [],
@@ -12,8 +16,8 @@
   "bugs": "https://github.com/polkadot-js/common/issues",
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/x-global#readme",
   "dependencies": {
-    "@babel/runtime": "^7.13.8",
-    "@types/node-fetch": "^2.5.8",
+    "@babel/runtime": "^7.13.17",
+    "@types/node-fetch": "^2.5.10",
     "node-fetch": "^2.6.1"
   }
 }

packages/x-global/src/index.ts

@@ -4,11 +4,13 @@
 export { packageInfo } from './packageInfo';
 
 export const xglobal = (
-  typeof global !== 'undefined'
-    ? global
-    : typeof self !== 'undefined'
-      ? self
-      : typeof window !== 'undefined'
-        ? window
-        : this as unknown as (Window & typeof globalThis)
+  typeof globalThis !== 'undefined'
+    ? globalThis
+    : typeof global !== 'undefined'
+      ? global
+      : typeof self !== 'undefined'
+        ? self
+        : typeof window !== 'undefined'
+          ? window
+          : this as unknown as (Window & typeof globalThis)
 );