[CI Skip] 2.8.1

skip-checks: true

.123trigger

@@ -1 +1,2 @@
 5
+2.6.2

.github/workflows/pr-any.yml

@@ -2,112 +2,17 @@ name: PR
 on: [pull_request]
 
 jobs:
-  lint:
+  pr:
-    name: Linting
-    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x]
+        step: ['lint', 'test', 'build', 'docs']
-    steps:
+    name: ${{ matrix.step }}
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Config yarn cache
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-    - uses: actions/cache@v1
-      id: yarn-cache
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-
-    - name: lint
-      run: |
-        yarn install --immutable | grep -v 'YN0013'
-        yarn lint
-
-  test:
-    name: Testing
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.x]
     steps:
     - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
+    - name: ${{ matrix.step }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Config yarn cache
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-    - uses: actions/cache@v1
-      id: yarn-cache
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-
-    - name: test
       env:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
       run: |
         yarn install --immutable | grep -v 'YN0013'
-        yarn test
+        yarn ${{ matrix.step }}
-
-  build_code:
-    name: Build Code
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.x]
-    steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Config yarn cache
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-    - uses: actions/cache@v1
-      id: yarn-cache
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-
-    - name: build
-      run: |
-        yarn install --immutable | grep -v 'YN0013'
-        yarn build
-
-  build_docs:
-    name: Build Docs
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.x]
-    steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Config yarn cache
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-    - uses: actions/cache@v1
-      id: yarn-cache
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-
-    - name: build
-      run: |
-        yarn install --immutable | grep -v 'YN0013'
-        yarn docs

.github/workflows/push-master.yml

@@ -5,82 +5,33 @@ on:
       - master
 
 jobs:
-  build_code:
+  master:
-    name: Build Code
-    if: "! contains(github.event.head_commit.message, '[CI Skip]')"
-    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x]
+        step: ['build:release', 'docs:release']
+    name: ${{ matrix.step }}
+    if: "! contains(github.event.head_commit.message, '[CI Skip]') && github.repository == 'polkadot-js/common'"
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
       with:
         token: ${{ secrets.GH_PAT }}
-    - name: Use Node.js ${{ matrix.node-version }}
+    - name: ${{ matrix.step }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Config yarn cache
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-    - uses: actions/cache@v1
-      id: yarn-cache
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-
-    - name: build
       env:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        GH_PAGES_SRC: build-docs
         GH_PAT: ${{ secrets.GH_PAT }}
         GH_TOKEN: ${{ secrets.GH_PAT }}
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       run: |
         yarn install --immutable | grep -v 'YN0013'
-        yarn polkadot-ci-ghact-build
+        yarn ${{ matrix.step }}
-
-  build_docs:
-    name: Build Docs
-    if: "! contains(github.event.head_commit.message, '[CI Skip]')"
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.x]
-    steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: Config yarn cache
-      id: yarn-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-    - uses: actions/cache@v1
-      id: yarn-cache
-      with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-        restore-keys: |
-          ${{ runner.os }}-yarn-
-    - name: build
-      env:
-        GH_PAT: ${{ secrets.GH_PAT }}
-        GH_TOKEN: ${{ secrets.GH_PAT }}
-        GH_PAGES_SRC: build-docs
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: |
-        yarn install --immutable | grep -v 'YN0013'
-        yarn polkadot-ci-ghact-docs
 
   dummy:
     name: Dummy
     if: "contains(github.event.head_commit.message, '[CI Skip]')"
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.x]
     steps:
     - name: dummy
       run: |

.yarnrc.yml

@@ -1,4 +1,5 @@
 enableImmutableInstalls: false
+
 enableProgressBars: false
 
 nodeLinker: node-modules
@@ -7,4 +8,4 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.js
     spec: "@yarnpkg/plugin-interactive-tools"
 
-yarnPath: .yarn/releases/yarn-berry.js
+yarnPath: .yarn/releases/yarn-rc.js

CHANGELOG.md

@@ -1,10 +1,21 @@
+# 2.8.1 Apr 9, 2020
+
+- Keypair will now throw an error when attempting to sign/derive using a locked pair (Thanks to https://github.com/h4x3rotab)
+- Cleanup `isDevelopment` regex to cater for chains such as `Westend Development`
+
+# 2.7.1 Mar 31, 2020
+
+- Add `bnSqrt` to calculate the integer sqrt via Newton iteration
+- Allow for optional wasm-crypto, specifically via `@polkadot/util-crypto/noWasm`
+- Misc. CI infrastructure cleanups
+
 # 2.6.1 Feb 29, 2020
 
 - **Breaking change** Following on the 2.0 release, `@polkadot/wasm` was updated to 1.1+. sr25510 now only verifies 0.8+ signatures, closing the loop on dropping Substrate 1.x-era support
 - Add `signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string): VerifyResult` to verify any signature, regardless of type. Returns validity & detected crypto type.
 - Add `cryptoIsReady (): boolean` function to check status of initialization
 - Add `addressCheckChecksum (decoded: Uint8Array)` as an helper to extract and verify the ss58 checksum
-- Swap to yarn 2, allow use in yan 2 projects
+- Swap to yarn 2, allow use in yarn 2 projects
 
 # 2.5.1 Feb 22, 2020
 
@@ -26,7 +37,7 @@
 - Remove dependency on moment.js with `formatDate` function (Thanks to https://github.com/AndreasGassmann)
 - Move TypeScript `@types/*` to dev deps (Thanks to https://github.com/AndreasGassmann)
 - Update to `@polkadot/wasm-crypto` 1.0
-- Cleanup dependencies to pave the way for using yarnpkg 2 (Explicit instead of implicit)
+- Cleanup dependencies to pave the way for using yarn 2 (Explicit instead of implicit)
 
 # 2.2.1 Feb 06, 2020
 

babel.config.js

@@ -1 +1,5 @@
+// Copyright 2017-2020 @polkadot/util authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
 module.exports = require('@polkadot/dev/config/babel');

docs/examples/keyring/01_create_account/index.js

@@ -1,6 +1,7 @@
+/* eslint-disable header/header */
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/unbound-method */
-/* eslint-disable @typescript-eslint/no-var-requires */
+
 // Import Keyring class and utility function
 const Keyring = require('@polkadot/keyring').default;
 const stringToU8a = require('@polkadot/util/string/toU8a').default;

docs/examples/keyring/02_load_accounts/index.js

@@ -1,6 +1,7 @@
+/* eslint-disable header/header */
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/unbound-method */
-/* eslint-disable @typescript-eslint/no-var-requires */
+
 // Import Keyring class and utility function
 const Keyring = require('@polkadot/keyring').default;
 const stringToU8a = require('@polkadot/util/string/toU8a').default;

docs/examples/keyring/03_validate_address/index.js

@@ -1,12 +1,18 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable header/header */
-const { encodeAddress, decodeAddress } = require('@polkadot/keyring');
+
-const { isHex, hexToU8a } = require('@polkadot/util');
+const { decodeAddress, encodeAddress } = require('@polkadot/keyring');
+const { hexToU8a, isHex } = require('@polkadot/util');
 
 const address = '5GrpknVvGGrGH3EFuURXeMrWHvbpj3VfER1oX5jFtuGbfzCE';
 
 const isValidAddressPolkadotAddress = () => {
   try {
-    encodeAddress(isHex(address) ? hexToU8a(address) : decodeAddress(address));
+    encodeAddress(
+      isHex(address)
+        ? hexToU8a(address)
+        : decodeAddress(address)
+    );
+
     return true;
   } catch (error) {
     return false;

docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/index.js

@@ -1,7 +1,8 @@
+/* eslint-disable header/header */
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/unbound-method */
-/* eslint-disable @typescript-eslint/no-var-requires */
+
-const { naclEncrypt, naclDecrypt } = require('@polkadot/util-crypto');
+const { naclDecrypt, naclEncrypt } = require('@polkadot/util-crypto');
 
 async function main () {
   const secret = new Uint8Array(32);

docs/examples/util-crypto/02_sign_verify_message_nacl/index.js

@@ -1,6 +1,7 @@
+/* eslint-disable header/header */
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/unbound-method */
-/* eslint-disable @typescript-eslint/no-var-requires */
+
 const { stringToU8a, u8aToHex } = require('@polkadot/util');
 const { naclEncrypt, naclKeypairFromSeed, naclSign, naclVerify, randomAsU8a } = require('@polkadot/util-crypto');
 
@@ -9,7 +10,7 @@ async function main () {
   const seedAlice = 'Alice'.padEnd(32, ' ');
 
   // Generate new public/secret keypair for Alice from the supplied seed
-  const { secretKey, publicKey } = naclKeypairFromSeed(stringToU8a(seedAlice));
+  const { publicKey, secretKey } = naclKeypairFromSeed(stringToU8a(seedAlice));
 
   // Encrypt message. Create Uint8Array's filled with random bytes of specified length
   const secret = randomAsU8a(32);

docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/index.js

@@ -1,6 +1,8 @@
+/* eslint-disable header/header */
 /* eslint-disable @typescript-eslint/unbound-method */
 /* eslint-disable @typescript-eslint/require-await */
-/* eslint-disable @typescript-eslint/no-var-requires,@typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
 const { mnemonicGenerate, mnemonicToSeed, mnemonicValidate, naclKeypairFromSeed } = require('@polkadot/util-crypto');
 
 async function main () {
@@ -19,7 +21,7 @@ async function main () {
   const seedAlice = mnemonicToSeed(mnemonicAlice);
 
   // Generate new public/secret keypair for Alice from the supplied seed
-  const { secretKey, publicKey } = naclKeypairFromSeed(seedAlice);
+  const { publicKey, secretKey } = naclKeypairFromSeed(seedAlice);
 
   // Encrypt, Sign and Validate the message. See Example 'Sign & Verify Message'
 }

jest.config.js

@@ -1,10 +1,14 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+// Copyright 2017-2020 @polkadot/util authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
 const config = require('@polkadot/dev/config/jest');
 
 module.exports = Object.assign({}, config, {
   moduleNameMapper: {
     '@polkadot/keyring(.*)$': '<rootDir>/packages/keyring/src/$1',
     '@polkadot/util-(crypto)(.*)$': '<rootDir>/packages/util-$1/src/$2',
+    // eslint-disable-next-line sort-keys
     '@polkadot/util(.*)$': '<rootDir>/packages/util/src/$1'
   },
   modulePathIgnorePatterns: [

jest.resolver.js

@@ -1,7 +1,6 @@
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
-/* eslint-disable @typescript-eslint/no-var-requires */
 
 const path = require('path');
 

lerna.json

@@ -9,5 +9,5 @@
   "packages": [
     "packages/*"
   ],
-  "version": "2.6.1"
+  "version": "2.8.1"
 }

package.json

@@ -11,7 +11,9 @@
   },
   "scripts": {
     "build": "polkadot-dev-build-ts",
+    "build:release": "polkadot-ci-ghact-build",
     "docs": "polkadot-dev-build-docs",
+    "docs:release": "polkadot-ci-ghact-docs",
     "lint": "polkadot-dev-run-lint",
     "clean": "polkadot-dev-clean-build",
     "postinstall": "polkadot-dev-yarn-only",
@@ -19,8 +21,9 @@
     "test:one": "polkadot-dev-run-test"
   },
   "devDependencies": {
-    "@babel/core": "^7.8.6",
+    "@babel/core": "^7.9.0",
-    "@polkadot/dev": "^0.50.15",
+    "@polkadot/dev": "^0.52.8",
-    "@polkadot/ts": "^0.3.6"
+    "@polkadot/ts": "^0.3.18",
+    "@types/jest": "^25.2.1"
   }
 }

packages/keyring/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/keyring",
-  "version": "2.6.1",
+  "version": "2.8.1",
   "description": "Keyring management",
   "main": "index.js",
   "publishConfig": {
@@ -27,8 +27,8 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme",
   "dependencies": {
-    "@babel/runtime": "^7.8.4",
+    "@babel/runtime": "^7.9.2",
-    "@polkadot/util": "2.6.1",
+    "@polkadot/util": "2.8.1",
-    "@polkadot/util-crypto": "2.6.1"
+    "@polkadot/util-crypto": "2.8.1"
   }
 }

packages/keyring/src/index.ts

@@ -8,7 +8,7 @@ import { decodeAddress, encodeAddress, setSS58Format } from '@polkadot/util-cryp
 import Keyring from './keyring';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-detectPackage(require('./package.json'), __dirname);
+detectPackage(require('./package.json'), typeof __dirname !== 'undefined' && __dirname);
 
 export default Keyring;
 

packages/keyring/src/keyring.ts

@@ -153,7 +153,7 @@ export default class Keyring implements KeyringInstance {
     const suri = _suri.startsWith('//')
       ? `${DEV_PHRASE}${_suri}`
       : _suri;
-    const { password, phrase, path } = keyExtractSuri(suri);
+    const { password, path, phrase } = keyExtractSuri(suri);
     let seed;
 
     if (isHex(phrase, 256)) {

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

@@ -80,6 +80,7 @@ describe('pair', (): void => {
     const encoded = keyring.alice.encodePkcs8(PASS);
 
     const pair = createPair({ toSS58, type: 'sr25519' }, { publicKey: keyring.alice.publicKey });
+
     pair.decodePkcs8(PASS, encoded);
 
     expect(pair.isLocked).toEqual(false);
@@ -93,4 +94,13 @@ describe('pair', (): void => {
     expect(stash.publicKey).toEqual(PAIRS[1].publicKey);
     expect(soft.address).toEqual('5ECQNn7UueWHPFda5qUi4fTmTtyCnPvGnuoyVVSj5CboJh9J');
   });
+
+  it('fails to sign when locked', (): void => {
+    const pair = createPair({ toSS58, type: 'sr25519' }, { publicKey: keyring.alice.publicKey });
+
+    expect(pair.isLocked).toEqual(true);
+    expect((): Uint8Array =>
+      pair.sign(new Uint8Array([0]))
+    ).toThrow('Cannot sign with a locked key pair');
+  });
 });

packages/keyring/src/pair/index.ts

@@ -6,7 +6,7 @@ import { Keypair, KeypairType } from '@polkadot/util-crypto/types';
 import { KeyringPair, KeyringPair$Json, KeyringPair$Meta, SignOptions } from '../types';
 import { PairInfo } from './types';
 
-import { u8aConcat, assert } from '@polkadot/util';
+import { assert, u8aConcat } from '@polkadot/util';
 import { keyExtractPath, keyFromPath, naclKeypairFromSeed as naclFromSeed, naclSign, naclVerify, schnorrkelKeypairFromSeed as schnorrkelFromSeed, schnorrkelSign, schnorrkelVerify } from '@polkadot/util-crypto';
 
 import decode from './decode';
@@ -62,6 +62,11 @@ function verify (type: KeypairType, message: Uint8Array, signature: Uint8Array,
     : naclVerify(message, signature, publicKey);
 }
 
+// Not 100% correct, since it can be a Uint8Array, but an invalid one - just say "undefined" is anything non-valid
+function isLocked (secretKey?: Uint8Array): secretKey is undefined {
+  return !secretKey || secretKey.length === 0 || isEmpty(secretKey);
+}
+
 /**
  * @name pair
  * @summary Creates a keyring pair object
@@ -98,18 +103,19 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
     get address (): string {
       return toSS58(publicKey);
     },
+    get isLocked (): boolean {
+      return isLocked(secretKey);
+    },
     get meta (): KeyringPair$Meta {
       return meta;
     },
-    get isLocked (): boolean {
-      return !secretKey || secretKey.length === 0 || isEmpty(secretKey);
-    },
     get publicKey (): Uint8Array {
       return publicKey;
     },
     get type (): KeypairType {
       return type;
     },
+    // eslint-disable-next-line sort-keys
     decodePkcs8: (passphrase?: string, _encoded?: Uint8Array | null): void => {
       const decoded = decode(passphrase, _encoded || encoded);
 
@@ -124,10 +130,10 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
       }
     },
     derive: (suri: string, meta?: KeyringPair$Meta): KeyringPair => {
-      assert(secretKey, 'Cannot derive on a locked keypair');
+      assert(!isLocked(secretKey), 'Cannot derive on a locked keypair');
 
       const { path } = keyExtractPath(suri);
-      const derived = keyFromPath({ publicKey, secretKey: secretKey }, path, type);
+      const derived = keyFromPath({ publicKey, secretKey }, path, type);
 
       return createPair({ toSS58, type }, derived, meta, null);
     },
@@ -139,8 +145,11 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
     setMeta: (additional: KeyringPair$Meta): void => {
       meta = { ...meta, ...additional };
     },
-    sign: (message: Uint8Array, options?: SignOptions): Uint8Array =>
+    sign: (message: Uint8Array, options?: SignOptions): Uint8Array => {
-      sign(type, message, { publicKey, secretKey }, options),
+      assert(!isLocked(secretKey), 'Cannot sign with a locked key pair');
+
+      return sign(type, message, { publicKey, secretKey }, options);
+    },
     toJson: (passphrase?: string): KeyringPair$Json =>
       toJson(type, { meta, publicKey }, encode({ publicKey, secretKey }, passphrase), !!passphrase),
     verify: (message: Uint8Array, signature: Uint8Array): boolean =>

packages/keyring/src/pair/nobody.ts

@@ -25,7 +25,6 @@ const json: KeyringPair$Json = {
 
 export default function everybody (): KeyringPair {
   const pair: KeyringPair = {
-    type: 'ed25519',
     address,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     decodePkcs8: (passphrase?: string, encoded?: Uint8Array): void =>
@@ -36,11 +35,11 @@ export default function everybody (): KeyringPair {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     encodePkcs8: (passphrase?: string): Uint8Array =>
       new Uint8Array(0),
-    meta,
     isLocked: true,
     lock: (): void => {
       // no locking, it is always locked
     },
+    meta,
     publicKey,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     setMeta: (meta: KeyringPair$Meta): void =>
@@ -51,6 +50,7 @@ export default function everybody (): KeyringPair {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     toJson: (passphrase?: string): KeyringPair$Json =>
       json,
+    type: 'ed25519',
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     verify: (message: Uint8Array, signature: Uint8Array): boolean =>
       false

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

@@ -19,8 +19,8 @@ describe('toJson', (): void => {
         version: '2'
       },
       meta: {
-        name: 'alice',
+        isTesting: true,
-        isTesting: true
+        name: 'alice'
       }
     });
   });

packages/keyring/src/pair/toJson.ts

@@ -12,7 +12,7 @@ type PairStateJson = KeyringPair$Meta & {
   publicKey: Uint8Array;
 };
 
-export default function toJson (type: KeypairType, { publicKey, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
+export default function toJson (type: KeypairType, { meta, publicKey }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
   return {
     address: encodeAddress(publicKey),
     encoded: u8aToHex(encoded),

packages/keyring/src/testing.ts

@@ -23,44 +23,44 @@ interface PairDef {
 // adding the keys when only the keyring is used.
 export const PAIRS: PairDef[] = [
   {
-    seed: 'Alice',
+    publicKey: hexToU8a('0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d'),
     secretKey: hexToU8a('0x98319d4ff8a9508c4bb0cf0b5a78d760a0b2082c02775e6e82370816fedfff48925a225d97aa00682d6a59b95b18780c10d7032336e88f3442b42361f4a66011'),
-    publicKey: hexToU8a('0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d')
+    seed: 'Alice'
   },
   {
-    seed: 'Alice//stash',
+    publicKey: hexToU8a('0xbe5ddb1579b72e84524fc29e78609e3caf42e85aa118ebfe0b0ad404b5bdd25f'),
     secretKey: hexToU8a('0xe8da6c9d810e020f5e3c7f5af2dea314cbeaa0d72bc6421e92c0808a0c584a6046ab28e97c3ffc77fe12b5a4d37e8cd4afbfebbf2391ffc7cb07c0f38c023efd'),
-    publicKey: hexToU8a('0xbe5ddb1579b72e84524fc29e78609e3caf42e85aa118ebfe0b0ad404b5bdd25f')
+    seed: 'Alice//stash'
   },
   {
-    seed: 'Bob',
+    publicKey: hexToU8a('0x8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48'),
     secretKey: hexToU8a('0x081ff694633e255136bdb456c20a5fc8fed21f8b964c11bb17ff534ce80ebd5941ae88f85d0c1bfc37be41c904e1dfc01de8c8067b0d6d5df25dd1ac0894a325'),
-    publicKey: hexToU8a('0x8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48')
+    seed: 'Bob'
   },
   {
-    seed: 'Bob//stash',
+    publicKey: hexToU8a('0xfe65717dad0447d715f660a0a58411de509b42e6efb8375f562f58a554d5860e'),
     secretKey: hexToU8a('0xc006507cdfc267a21532394c49ca9b754ca71de21e15a1cdf807c7ceab6d0b6c3ed408d9d35311540dcd54931933e67cf1ea10d46f75408f82b789d9bd212fde'),
-    publicKey: hexToU8a('0xfe65717dad0447d715f660a0a58411de509b42e6efb8375f562f58a554d5860e')
+    seed: 'Bob//stash'
   },
   {
-    seed: 'Charlie',
+    publicKey: hexToU8a('0x90b5ab205c6974c9ea841be688864633dc9ca8a357843eeacf2314649965fe22'),
     secretKey: hexToU8a('0xa8f2d83016052e5d6d77b2f6fd5d59418922a09024cda701b3c34369ec43a7668faf12ff39cd4e5d92bb773972f41a7a5279ebc2ed92264bed8f47d344f8f18c'),
-    publicKey: hexToU8a('0x90b5ab205c6974c9ea841be688864633dc9ca8a357843eeacf2314649965fe22')
+    seed: 'Charlie'
   },
   {
-    seed: 'Dave',
+    publicKey: hexToU8a('0x306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc20'),
     secretKey: hexToU8a('0x20e05482ca4677e0edbc58ae9a3a59f6ed3b1a9484ba17e64d6fe8688b2b7b5d108c4487b9323b98b11fe36cb301b084e920f7b7895536809a6d62a451b25568'),
-    publicKey: hexToU8a('0x306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc20')
+    seed: 'Dave'
   },
   {
-    seed: 'Eve',
+    publicKey: hexToU8a('0xe659a7a1628cdd93febc04a4e0646ea20e9f5f0ce097d9a05290d4a9e054df4e'),
     secretKey: hexToU8a('0x683576abfd5dc35273e4264c23095a1bf21c14517bece57c7f0cc5c0ed4ce06a3dbf386b7828f348abe15d76973a72009e6ef86a5c91db2990cb36bb657c6587'),
-    publicKey: hexToU8a('0xe659a7a1628cdd93febc04a4e0646ea20e9f5f0ce097d9a05290d4a9e054df4e')
+    seed: 'Eve'
   },
   {
-    seed: 'Ferdie',
+    publicKey: hexToU8a('0x1cbd2d43530a44705ad088af313e18f80b53ef16b36177cd4b77b846f2a5f07c'),
     secretKey: hexToU8a('0xb835c20f450079cf4f513900ae9faf8df06ad86c681884122c752a4b2bf74d4303e4f21bc6cc62bb4eeed5a9cce642c25e2d2ac1464093b50f6196d78e3a7426'),
-    publicKey: hexToU8a('0x1cbd2d43530a44705ad088af313e18f80b53ef16b36177cd4b77b846f2a5f07c')
+    seed: 'Ferdie'
   }
 ];
 

packages/keyring/src/types.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/class-name-casing */
 // Copyright 2017-2020 @polkadot/keyring authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.

packages/util-crypto/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/util-crypto",
-  "version": "2.6.1",
+  "version": "2.8.1",
   "description": "A collection of useful crypto utilities for @polkadot",
   "main": "index.js",
   "keywords": [
@@ -25,8 +25,8 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme",
   "dependencies": {
-    "@babel/runtime": "^7.8.4",
+    "@babel/runtime": "^7.9.2",
-    "@polkadot/util": "2.6.1",
+    "@polkadot/util": "2.8.1",
     "@polkadot/wasm-crypto": "^1.2.1",
     "base-x": "^3.0.8",
     "bip39": "^3.0.2",

packages/util-crypto/src/nacl/open.spec.ts

@@ -13,8 +13,8 @@ describe('naclOpen', (): void => {
     const receiver = naclKeypairFromString('receiver');
     const senderBox = naclBoxKeypairFromSecret(sender.secretKey);
     const receiverBox = naclBoxKeypairFromSecret(receiver.secretKey);
+    const { nonce, sealed } = naclSeal(message, senderBox.secretKey, receiverBox.publicKey);
 
-    const { sealed, nonce } = naclSeal(message, senderBox.secretKey, receiverBox.publicKey);
     expect(
       naclOpen(sealed, nonce, senderBox.publicKey, receiverBox.secretKey)
     ).toEqual(
@@ -32,16 +32,19 @@ describe('naclOpen', (): void => {
 
     // Receiver sends encrypting public key to receive message to decrypt with his private key
     const receiverIdBoxKey = naclBoxKeypairFromSecret(receiverIdKey.secretKey);
+
     console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey.publicKey}`);
 
     // Sender encrypts message to send with the public key the receiver sent and send it to receiver
     const senderIdBoxKey = naclBoxKeypairFromSecret(senderIdKey.secretKey);
     const message = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
-    const { sealed, nonce } = naclSeal(message, senderIdBoxKey.secretKey, receiverIdBoxKey.publicKey);
+    const { nonce, sealed } = naclSeal(message, senderIdBoxKey.secretKey, receiverIdBoxKey.publicKey);
+
     console.log(`Sender sends encrypted message to receiver ${sealed}, ${nonce}`);
 
     // Receiver opens encrypted message from the sender
     let opened = naclOpen(sealed, nonce, senderIdBoxKey.publicKey, receiverIdBoxKey.secretKey);
+
     console.log(`The sealed message is ${opened}`);
 
     // Oh no the Id key is hacked, derive Id key again from another index
@@ -50,6 +53,7 @@ describe('naclOpen', (): void => {
 
     // Receiver sends encrypting public key to receive message to decrypt with his private key
     const receiverIdBoxKey2 = naclBoxKeypairFromSecret(receiverIdKey2.secretKey);
+
     console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey2.publicKey}`);
 
     // Sender encrypts message to send with the public key the receiver sent and send it to receiver
@@ -58,6 +62,7 @@ describe('naclOpen', (): void => {
     let ctx = naclSeal(message2, senderIdBoxKey2.secretKey, receiverIdBoxKey2.publicKey);
     const sealed2 = ctx.sealed;
     const nonce2 = ctx.nonce;
+
     console.log(`Sender sends encrypted message to receiver ${sealed}, ${nonce}`);
 
     // Receiver opens encrypted message from the sender
@@ -67,14 +72,18 @@ describe('naclOpen', (): void => {
     // This time derive key for each message to send and receive
     // Receiver sends encrypting public key to receive message to decrypt with his private key
     const receiverIdBoxKey2One = naclBoxKeypairFromSecret(receiverIdBoxKey2.secretKey);
+
     console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey2One.publicKey}`);
 
     // Sender encrypts message to send with the public key the receiver sent and send it to receiver
     const senderIdBoxKey2One = naclBoxKeypairFromSecret(senderIdBoxKey2.secretKey);
     const message3 = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
+
     ctx = naclSeal(message3, senderIdBoxKey2One.secretKey, receiverIdBoxKey2One.publicKey);
+
     const sealed3 = ctx.sealed;
     const nonce3 = ctx.nonce;
+
     console.log(`Sender sends encrypted message to receiver ${sealed3}, ${nonce3}`);
 
     // Receiver opens encrypted message from the sender

packages/util-crypto/src/nacl/seal.spec.ts

@@ -13,11 +13,12 @@ describe('naclSeal', (): void => {
     const receiverBox = naclBoxKeypairFromSecret(receiver.secretKey);
     const senderBoxSecret = senderBox.secretKey;
     const receiverBoxPublic = receiverBox.publicKey;
+
     expect(
       naclSeal(message, senderBoxSecret, receiverBoxPublic, new Uint8Array(24))
     ).toEqual({
-      sealed: new Uint8Array([137, 195, 104, 255, 67, 199, 40, 235, 148, 177, 180, 73, 239, 131, 215, 80, 61, 191, 167, 213, 152, 138, 5, 47, 135]),
+      nonce: new Uint8Array(24),
-      nonce: new Uint8Array(24)
+      sealed: new Uint8Array([137, 195, 104, 255, 67, 199, 40, 235, 148, 177, 180, 73, 239, 131, 215, 80, 61, 191, 167, 213, 152, 138, 5, 47, 135])
     });
   });
 });

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

@@ -27,7 +27,7 @@ interface Sealed {
  */
 export default function naclSeal (message: Uint8Array, senderBoxSecret: Uint8Array, receiverBoxPublic: Uint8Array, nonce: Uint8Array = randomAsU8a(24)): Sealed {
   return {
-    sealed: nacl.box(message, nonce, receiverBoxPublic, senderBoxSecret),
+    nonce,
-    nonce
+    sealed: nacl.box(message, nonce, receiverBoxPublic, senderBoxSecret)
   };
 }

packages/util-crypto/src/noWasm.ts

@@ -0,0 +1,13 @@
+// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+export function isReady (): boolean {
+  // always false, when true it will try and use non-existent functions
+  return false;
+}
+
+export function waitReady (): Promise<boolean> {
+  // always immediate true, our process is done
+  return Promise.resolve(true);
+}

packages/util/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/util",
-  "version": "2.6.1",
+  "version": "2.8.1",
   "description": "A collection of useful utilities for @polkadot",
   "main": "index.js",
   "keywords": [
@@ -25,11 +25,11 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util#readme",
   "dependencies": {
-    "@babel/runtime": "^7.8.4",
+    "@babel/runtime": "^7.9.2",
     "@types/bn.js": "^4.11.6",
     "bn.js": "^5.1.1",
     "camelcase": "^5.3.1",
-    "chalk": "^3.0.0",
+    "chalk": "^4.0.0",
     "ip-regex": "^4.1.0"
   }
 }

packages/util/src/bn/index.ts

@@ -9,6 +9,7 @@
 export { default as bnFromHex } from './fromHex';
 export { default as bnMax } from './max';
 export { default as bnMin } from './min';
+export { default as bnSqrt } from './sqrt';
 export { default as bnToBn } from './toBn';
 export { default as bnToHex } from './toHex';
 export { default as bnToU8a } from './toU8a';

packages/util/src/bn/max.ts

@@ -7,16 +7,16 @@ import BN from 'bn.js';
 import assert from '../assert';
 
 /**
- * @name max
+ * @name bnMax
  * @summary Finds and returns the highest value in an array of BNs.
  * @example
  * <BR>
  *
  * ```javascript
  * import BN from 'bn.js';
- * import { max } from '@polkadot/util';
+ * import { bnMax } from '@polkadot/util';
  *
- * max([new BN(1), new BN(3), new BN(2)]).toString(); // => '3'
+ * bnMax([new BN(1), new BN(3), new BN(2)]).toString(); // => '3'
  * ```
  */
 export default function max (...items: BN[]): BN {

packages/util/src/bn/min.ts

@@ -7,16 +7,16 @@ import BN from 'bn.js';
 import assert from '../assert';
 
 /**
- * @name min
+ * @name bnMin
  * @summary Finds and returns the smallest value in an array of BNs.
  * @example
  * <BR>
  *
  * ```javascript
  * import BN from 'bn.js';
- * import { min } from '@polkadot/util';
+ * import { bnMin } from '@polkadot/util';
  *
- * min([new BN(1), new BN(3), new BN(2)]).toString(); // => '1'
+ * bnMin([new BN(1), new BN(3), new BN(2)]).toString(); // => '1'
  * ```
  */
 export default function min (...items: BN[]): BN {

packages/util/src/bn/sqrt.spec.ts

@@ -0,0 +1,33 @@
+// Copyright 2017-2020 @polkadot/util authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+import BN from 'bn.js';
+
+import { bnSqrt } from '.';
+
+describe('bnSqrt', (): void => {
+  it('fails on < 0 roots', (): void => {
+    expect(
+      () => bnSqrt(new BN(-1))
+    ).toThrow(/negative numbers is not supported/);
+  });
+
+  it('finds the sqrt (exact)', (): void => {
+    expect(
+      bnSqrt(new BN(256).mul(new BN(256)))
+    ).toEqual(new BN(256));
+  });
+
+  it('finds the sqrt (round)', (): void => {
+    expect(
+      bnSqrt(new BN(266))
+    ).toEqual(new BN(16));
+  });
+
+  it('find the sqrt for 1', (): void => {
+    expect(
+      bnSqrt(new BN(1))
+    ).toEqual(new BN(1));
+  });
+});

packages/util/src/bn/sqrt.ts

@@ -0,0 +1,39 @@
+// Copyright 2017-2020 @polkadot/util authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
+import BN from 'bn.js';
+
+import assert from '../assert';
+
+// https://golb.hplar.ch/2018/09/javascript-bigint.html
+function newtonIteration (n: BN, x0: BN): BN {
+  const x1 = n.div(x0).add(x0).shrn(1);
+
+  if (x0.eq(x1) || x0.eq(x1.subn(1))) {
+    return x0;
+  }
+
+  return newtonIteration(n, x1);
+}
+
+/**
+ * @name bnSqrt
+ * @summary Calculates the integer square root of a BN
+ * @example
+ * <BR>
+ *
+ * ```javascript
+ * import BN from 'bn.js';
+ * import { bnSqrt } from '@polkadot/util';
+ *
+ * bnSqrt(new BN(16)).toString(); // => '4'
+ * ```
+ */
+export default function sqrt (value: BN): BN {
+  assert(value.gten(0), 'square root of negative numbers is not supported');
+
+  return value.ltn(2)
+    ? value
+    : newtonIteration(value, new BN(1));
+}

packages/util/src/bn/toBn.spec.ts

@@ -46,8 +46,8 @@ describe('bnToBn', (): void => {
   it('converts Compact to BN', (): void => {
     expect(
       bnToBn({
-        toBn: (): BN => new BN(1234),
+        something: 'test',
-        something: 'test'
+        toBn: (): BN => new BN(1234)
       }).toNumber()
     ).toEqual(1234);
   });

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

@@ -45,13 +45,13 @@ describe('bnToU8a', (): void => {
 
   it('converts negative numbers (BE)', (): void => {
     expect(
-      bnToU8a(new BN(-1234), { isNegative: true, isLe: false })
+      bnToU8a(new BN(-1234), { isLe: false, isNegative: true })
     ).toEqual(new Uint8Array([251, 46]));
   });
 
   it('converts negative numbers (bitLength)', (): void => {
     expect(
-      bnToU8a(new BN(-1234), { isNegative: true, bitLength: 32 })
+      bnToU8a(new BN(-1234), { bitLength: 32, isNegative: true })
     ).toEqual(new Uint8Array([46, 251, 255, 255]));
   });
 

packages/util/src/bn/toU8a.ts

@@ -30,9 +30,9 @@ function bnToU8a (value: BN | BigInt | number | null, options?: Options): Uint8A
 function bnToU8a (value: BN | BigInt | number | null, bitLength?: number, isLe?: boolean): Uint8Array;
 function bnToU8a (value: BN | BigInt | number | null, arg1: number | Options = { bitLength: -1, isLe: true, isNegative: false }, arg2?: boolean): Uint8Array {
   const _options: Options = {
+    bitLength: -1,
     isLe: true,
     isNegative: false,
-    bitLength: -1,
     ...isNumber(arg1) ? { bitLength: arg1, isLe: arg2 } : arg1
   };
 

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

@@ -76,20 +76,20 @@ describe('encode', (): void => {
   describe('from Rust', (): void => {
     // Copied from https://github.com/paritytech/parity-codec/blob/master/src/codec.rs
     const testCases = [
-      { value: new BN('0'), expected: '00' },
+      { expected: '00', value: new BN('0') },
-      { value: new BN('63'), expected: 'fc' },
+      { expected: 'fc', value: new BN('63') },
-      { value: new BN('64'), expected: '01 01' },
+      { expected: '01 01', value: new BN('64') },
-      { value: new BN('16383'), expected: 'fd ff' },
+      { expected: 'fd ff', value: new BN('16383') },
-      { value: new BN('16384'), expected: '02 00 01 00' },
+      { expected: '02 00 01 00', value: new BN('16384') },
-      { value: new BN('1073741823'), expected: 'fe ff ff ff' },
+      { expected: 'fe ff ff ff', value: new BN('1073741823') },
-      { value: new BN('1073741824'), expected: '03 00 00 00 40' },
+      { expected: '03 00 00 00 40', value: new BN('1073741824') },
-      { value: new BN(`${1}${'0'.repeat(32)}`, 2).subn(1), expected: '03 ff ff ff ff' },
+      { expected: '03 ff ff ff ff', value: new BN(`${1}${'0'.repeat(32)}`, 2).subn(1) },
-      { value: new BN(`${1}${'0'.repeat(32)}`, 2), expected: '07 00 00 00 00 01' },
+      { expected: '07 00 00 00 00 01', value: new BN(`${1}${'0'.repeat(32)}`, 2) },
-      { value: new BN(`${1}${'0'.repeat(40)}`, 2), expected: '0b 00 00 00 00 00 01' },
+      { expected: '0b 00 00 00 00 00 01', value: new BN(`${1}${'0'.repeat(40)}`, 2) },
-      { value: new BN(`${1}${'0'.repeat(48)}`, 2), expected: '0f 00 00 00 00 00 00 01' },
+      { expected: '0f 00 00 00 00 00 00 01', value: new BN(`${1}${'0'.repeat(48)}`, 2) },
-      { value: new BN(`${1}${'0'.repeat(56)}`, 2).subn(1), expected: '0f ff ff ff ff ff ff ff' },
+      { expected: '0f ff ff ff ff ff ff ff', value: new BN(`${1}${'0'.repeat(56)}`, 2).subn(1) },
-      { value: new BN(`${1}${'0'.repeat(56)}`, 2), expected: '13 00 00 00 00 00 00 00 01' },
+      { expected: '13 00 00 00 00 00 00 00 01', value: new BN(`${1}${'0'.repeat(56)}`, 2) },
-      { value: new BN(`${1}${'0'.repeat(64)}`, 2).subn(1), expected: '13 ff ff ff ff ff ff ff ff' }
+      { expected: '13 ff ff ff ff ff ff ff ff', value: new BN(`${1}${'0'.repeat(64)}`, 2).subn(1) }
     ];
 
     function testEncode (value: BN, expected: string): void {
@@ -104,6 +104,6 @@ describe('encode', (): void => {
       });
     }
 
-    testCases.forEach(({ value, expected }): void => testEncode(value, expected));
+    testCases.forEach(({ expected, value }): void => testEncode(value, expected));
   });
 });

packages/util/src/detectPackage.ts

@@ -26,7 +26,7 @@ type PjsGlobal = NodeJS.Global & PjsChecks;
 type PjsWindow = Window & PjsChecks;
 
 function expandPath (path?: string): string {
-  return (!path || path.length < 5) ? '<unknown path>' : path;
+  return (!path || path.length < 5) ? '<unknown>' : path;
 }
 
 /** @internal */
@@ -47,7 +47,7 @@ function flattenVersions (_all: (VersionPath | string)[]): string {
  * @name detectPackage
  * @summary Checks that a specific package is only imported once
  */
-export default function detectPackage ({ name, version }: PackageJson, path?: string): void {
+export default function detectPackage ({ name, version }: PackageJson, path?: string | false): void {
   const _global = typeof window !== 'undefined'
     ? window as PjsWindow
     : global as PjsGlobal;
@@ -58,7 +58,7 @@ export default function detectPackage ({ name, version }: PackageJson, path?: st
 
   assert(name.startsWith('@polkadot'), `Invalid package descriptor ${name}`);
 
-  _global.__polkadotjs[name] = [...(_global.__polkadotjs[name] || []), { path, version }];
+  _global.__polkadotjs[name] = [...(_global.__polkadotjs[name] || []), { path: path || '', version }];
 
   if (_global.__polkadotjs[name].length !== 1) {
     const versions = flattenVersions(_global.__polkadotjs[name]);

packages/util/src/format/formatBalance.spec.ts

@@ -17,13 +17,13 @@ describe('formatBalance', (): void => {
 
     it('formats 123,456,789,000 (decimals=15)', (): void => {
       expect(
-        formatBalance(TESTVAL, { withSi: true, decimals: 15 })
+        formatBalance(TESTVAL, { decimals: 15, withSi: true })
       ).toEqual('123.456µ Unit');
     });
 
     it('formats BigInt numbers', (): void => {
       expect(
-        formatBalance(123_456_789_000n, { withSi: true, decimals: 15 })
+        formatBalance(123_456_789_000n, { decimals: 15, withSi: true })
       ).toEqual('123.456µ Unit');
     });
 
@@ -35,24 +35,25 @@ describe('formatBalance', (): void => {
 
     it('formats 123,456,789,000 (decimals=36, option)', (): void => {
       expect(
-        formatBalance(TESTVAL, { withSi: true, decimals: 36 })
+        formatBalance(TESTVAL, { decimals: 36, withSi: true })
       ).toEqual('0.123y Unit');
     });
 
     it('formats 123,456,789,000 (decimals=15, Compact)', (): void => {
       const compact = {
+        something: 'else',
         toBn: (): BN => TESTVAL,
-        unwrap: (): BN => TESTVAL,
+        unwrap: (): BN => TESTVAL
-        something: 'else'
       };
+
       expect(
-        formatBalance(compact, { withSi: true, decimals: 15 })
+        formatBalance(compact, { decimals: 15, withSi: true })
       ).toEqual('123.456µ Unit');
     });
 
     it('formats 123,456,789,000 (decimals=12)', (): void => {
       expect(
-        formatBalance(TESTVAL, { withSi: true, decimals: 12 })
+        formatBalance(TESTVAL, { decimals: 12, withSi: true })
       ).toEqual('123.456m Unit');
     });
 
@@ -173,13 +174,13 @@ describe('formatBalance', (): void => {
     it('finds the SI value', (): void => {
       expect(
         formatBalance.findSi('k')
-      ).toEqual({ power: 3, value: 'k', text: 'Kilo' });
+      ).toEqual({ power: 3, text: 'Kilo', value: 'k' });
     });
 
     it('returns default on not found', (): void => {
       expect(
         formatBalance.findSi('blah')
-      ).toEqual({ power: 0, value: '-', text: 'Unit' });
+      ).toEqual({ power: 0, text: 'Unit', value: '-' });
     });
   });
 
@@ -214,15 +215,15 @@ describe('formatBalance', (): void => {
     expect(
       formatBalance.getOptions()
     ).toEqual([
-      { power: 0, value: '-', text: 'TEST' },
+      { power: 0, text: 'TEST', value: '-' },
-      { power: 3, value: 'k', text: 'Kilo' },
+      { power: 3, text: 'Kilo', value: 'k' },
-      { power: 6, value: 'M', text: 'Mega' },
+      { power: 6, text: 'Mega', value: 'M' },
-      { power: 9, value: 'G', text: 'Giga' },
+      { power: 9, text: 'Giga', value: 'G' },
-      { power: 12, value: 'T', text: 'Tera' },
+      { power: 12, text: 'Tera', value: 'T' },
-      { power: 15, value: 'P', text: 'Peta' },
+      { power: 15, text: 'Peta', value: 'P' },
-      { power: 18, value: 'E', text: 'Exa' },
+      { power: 18, text: 'Exa', value: 'E' },
-      { power: 21, value: 'Z', text: 'Zeta' },
+      { power: 21, text: 'Zeta', value: 'Z' },
-      { power: 24, value: 'Y', text: 'Yotta' }
+      { power: 24, text: 'Yotta', value: 'Y' }
     ]);
   });
 });

packages/util/src/format/si.ts

@@ -7,23 +7,23 @@ import { SiDef } from '../types';
 export const SI_MID = 8;
 
 export const SI: SiDef[] = [
-  { power: -24, value: 'y', text: 'yocto' },
+  { power: -24, text: 'yocto', value: 'y' },
-  { power: -21, value: 'z', text: 'zepto' },
+  { power: -21, text: 'zepto', value: 'z' },
-  { power: -18, value: 'a', text: 'atto' },
+  { power: -18, text: 'atto', value: 'a' },
-  { power: -15, value: 'f', text: 'femto' },
+  { power: -15, text: 'femto', value: 'f' },
-  { power: -12, value: 'p', text: 'pico' },
+  { power: -12, text: 'pico', value: 'p' },
-  { power: -9, value: 'n', text: 'nano' },
+  { power: -9, text: 'nano', value: 'n' },
-  { power: -6, value: 'µ', text: 'micro' },
+  { power: -6, text: 'micro', value: 'µ' },
-  { power: -3, value: 'm', text: 'milli' },
+  { power: -3, text: 'milli', value: 'm' },
-  { power: 0, value: '-', text: 'Unit' }, // position 8
+  { power: 0, text: 'Unit', value: '-' }, // position 8
-  { power: 3, value: 'k', text: 'Kilo' },
+  { power: 3, text: 'Kilo', value: 'k' },
-  { power: 6, value: 'M', text: 'Mega' },
+  { power: 6, text: 'Mega', value: 'M' },
-  { power: 9, value: 'G', text: 'Giga' },
+  { power: 9, text: 'Giga', value: 'G' },
-  { power: 12, value: 'T', text: 'Tera' },
+  { power: 12, text: 'Tera', value: 'T' },
-  { power: 15, value: 'P', text: 'Peta' },
+  { power: 15, text: 'Peta', value: 'P' },
-  { power: 18, value: 'E', text: 'Exa' },
+  { power: 18, text: 'Exa', value: 'E' },
-  { power: 21, value: 'Z', text: 'Zeta' },
+  { power: 21, text: 'Zeta', value: 'Z' },
-  { power: 24, value: 'Y', text: 'Yotta' }
+  { power: 24, text: 'Yotta', value: 'Y' }
 ];
 
 // Given a SI type (e.g. k, m, Y) find the SI definition

packages/util/src/is/testChain.ts

@@ -2,7 +2,7 @@
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
-const re = new RegExp('^(Development|Local Testnet)$');
+const re = new RegExp('(Development|Local Testnet)$');
 
 export default function isTestChain (chain?: string | null): boolean {
   if (!chain) {

packages/util/src/polyfill/fill.spec.ts

@@ -1,10 +1,11 @@
-/* eslint-disable @typescript-eslint/ban-ts-ignore */
-/* eslint-disable no-extend-native */
-/* eslint-disable @typescript-eslint/unbound-method */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+/* eslint-disable @typescript-eslint/ban-ts-ignore */
+/* eslint-disable no-extend-native */
+/* eslint-disable @typescript-eslint/unbound-method */
+
 describe('Array.fill', (): void => {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let arrayFill: (value: any, start?: number | undefined, end?: number | undefined) => any[];

packages/util/src/polyfill/fill.ts

@@ -1,9 +1,10 @@
-/* eslint-disable no-extend-native */
-/* eslint-disable @typescript-eslint/unbound-method */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+/* eslint-disable no-extend-native */
+/* eslint-disable @typescript-eslint/unbound-method */
+
 if (!Array.prototype.fill) {
   // eslint-disable-next-line no-extend-native,@typescript-eslint/no-explicit-any
   Array.prototype.fill = function fill (value: any, start = 0, end?: number): any[] {

packages/util/src/polyfill/padEnd.spec.ts

@@ -1,8 +1,9 @@
-/* eslint-disable @typescript-eslint/unbound-method */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+/* eslint-disable @typescript-eslint/unbound-method */
+
 describe('String padEnd', (): void => {
   let stringEnd: (length: number, fill?: string) => string;
 

packages/util/src/polyfill/padEnd.ts

@@ -1,9 +1,10 @@
-/* eslint-disable no-extend-native */
-/* eslint-disable @typescript-eslint/unbound-method */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+/* eslint-disable no-extend-native */
+/* eslint-disable @typescript-eslint/unbound-method */
+
 if (!String.prototype.padEnd) {
   String.prototype.padEnd = function padEnd (length: number, char = ' '): string {
     let result = String(this);

packages/util/src/polyfill/padStart.spec.ts

@@ -1,8 +1,9 @@
-/* eslint-disable @typescript-eslint/unbound-method */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+/* eslint-disable @typescript-eslint/unbound-method */
+
 describe('String padStart', (): void => {
   let stringStart: (length: number, fill?: string) => string;
 

packages/util/src/polyfill/padStart.ts

@@ -1,9 +1,10 @@
-/* eslint-disable no-extend-native */
-/* eslint-disable @typescript-eslint/unbound-method */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+/* eslint-disable no-extend-native */
+/* eslint-disable @typescript-eslint/unbound-method */
+
 if (!String.prototype.padStart) {
   String.prototype.padStart = function padStart (length: number, char = ' '): string {
     let result = String(this);

packages/util/src/polyfill/setPrototypeOf.spec.ts

@@ -1,10 +1,11 @@
-/* eslint-disable no-proto */
-/* eslint-disable @typescript-eslint/ban-ts-ignore */
-/* eslint-disable @typescript-eslint/unbound-method */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+/* eslint-disable no-proto */
+/* eslint-disable @typescript-eslint/ban-ts-ignore */
+/* eslint-disable @typescript-eslint/unbound-method */
+
 describe('setPrototypeOf', (): void => {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let orig: (o: any, proto: object | null) => any;

packages/util/src/polyfill/setPrototypeOf.ts

@@ -1,8 +1,9 @@
-/* eslint-disable @typescript-eslint/unbound-method */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+/* eslint-disable @typescript-eslint/unbound-method */
+
 // React Native does not have Object.setPrototypeOf
 if (!Object.setPrototypeOf) {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

packages/util/src/polyfill/textDecoder.ts

@@ -1,10 +1,10 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 // Copyright 2017-2020 @polkadot/util authors & contributors
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
 if (typeof TextDecoder === 'undefined') {
   try {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     (global as any).TextDecoder = require('util').TextDecoder;
   } catch (error) {
     // noop

typedoc.js

@@ -1,15 +1,19 @@
+// Copyright 2017-2020 @polkadot/util authors & contributors
+// This software may be modified and distributed under the terms
+// of the Apache-2.0 license. See the LICENSE file for details.
+
 module.exports = {
-  name: 'Polkadot JS Common',
   exclude: '**/*+(index|e2e|spec).ts',
   excludeExternals: true,
   excludeNotExported: true,
-  excludeProtected: true,
   excludePrivate: true,
+  excludeProtected: true,
   hideGenerator: true,
   includeDeclarations: false,
-  out: 'docs',
   module: 'commonjs',
   moduleResolution: 'node',
+  name: 'Polkadot JS Common',
+  out: 'docs',
   stripInternal: 'true',
   theme: 'markdown'
 };