[CI Skip] 1.7.1

skip-checks: true

.123trigger

@@ -1 +1 @@
-1
+2

.github/workflows/push-master.yml

@@ -14,6 +14,8 @@ jobs:
         node-version: [12.x]
     steps:
     - uses: actions/checkout@v1
+      with:
+        token: ${{ secrets.GH_PAT }}
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
@@ -51,3 +53,15 @@ jobs:
       run: |
         yarn install --frozen-lockfile
         yarn polkadot-dev-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: |
+        echo "Dummy skip step"

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.7.1
+
+- `formatBalance` signature now allows to force unit displays
+- Keypair now allows for derive on a pair, with `pair.derive(...)`
+- `assert` now acts like a real asserts, with no return - signature adapted for new TS 3.7
+
 # 1.6.1
 
 - `pair.sign(message)` now takes an optional second `options?: SignOptions` parameter, where `SignOptions` is currently defined as `{ withType: boolean }`. Here `withType` instructs the signing to prepend the type of signature (ed2551, sr25519 or ecdsa). This is used for the new Polkadot/Substrate MultiSignature format.

lerna.json

@@ -9,5 +9,5 @@
   "packages": [
     "packages/*"
   ],
-  "version": "1.6.1"
+  "version": "1.7.1"
 }

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.1",
+  "version": "1.7.1",
   "private": true,
   "engines": {
     "yarn": "^1.10.1"
@@ -9,7 +9,7 @@
   ],
   "resolutions": {
     "babel-core": "^7.0.0-bridge.0",
-    "typescript": "^3.6.4"
+    "typescript": "^3.7.2"
   },
   "scripts": {
     "build": "polkadot-dev-build-ts",
@@ -21,9 +21,9 @@
     "test:one": "jest"
   },
   "devDependencies": {
-    "@babel/core": "^7.6.4",
-    "@polkadot/dev": "^0.32.0-beta.11",
-    "@polkadot/ts": "^0.1.82",
+    "@babel/core": "^7.7.4",
+    "@polkadot/dev": "^0.32.0-beta.15",
+    "@polkadot/ts": "^0.1.86",
     "gh-pages": "^2.1.1"
   }
 }

packages/chainspec/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/chainspec",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "Contains chain specifications for known chains",
   "main": "index.js",
   "keywords": [
@@ -25,7 +25,7 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/chainspec#readme",
   "dependencies": {
-    "@babel/runtime": "^7.6.3",
-    "@polkadot/util": "^1.6.1"
+    "@babel/runtime": "^7.7.4",
+    "@polkadot/util": "^1.7.1"
   }
 }

packages/db/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/db",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "Implementation of a basic sync in-memory and on-disk databases with overlays",
   "main": "index.js",
   "keywords": [
@@ -25,9 +25,9 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/db#readme",
   "dependencies": {
-    "@babel/runtime": "^7.6.3",
-    "@polkadot/trie-hash": "^1.6.1",
-    "@polkadot/util": "^1.6.1",
+    "@babel/runtime": "^7.7.4",
+    "@polkadot/trie-hash": "^1.7.1",
+    "@polkadot/util": "^1.7.1",
     "lru_map": "^0.3.3"
   }
 }

packages/db/src/Memory.ts

@@ -62,7 +62,7 @@ import TransactionDb from './engines/TransactionDb';
  * ```
  */
 export default class Memory extends TransactionDb {
-  public constructor () {
+  constructor () {
     super(new MemoryDb());
   }
 }

packages/db/src/engines/LruDb.ts

@@ -20,7 +20,7 @@ export default class LruDb implements BaseDb {
 
   private lru: LRUMap<string, CachedValue>;
 
-  public constructor (backing: BaseDb, itemCount: number = DEFAULT_ITEM_COUNT) {
+  constructor (backing: BaseDb, itemCount: number = DEFAULT_ITEM_COUNT) {
     this.backing = backing;
     this.lru = new LRUMap(itemCount);
   }

packages/db/src/engines/TransactionDb.ts

@@ -20,7 +20,7 @@ export default class TransactionDb implements TxDb {
 
   private txStarted: boolean;
 
-  public constructor (backing: BaseDb) {
+  constructor (backing: BaseDb) {
     this.backing = backing;
     this.txStarted = false;
   }

packages/keyring/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/keyring",
-  "version": "1.6.1",
+  "version": "1.7.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.6.3",
-    "@polkadot/util": "^1.6.1",
-    "@polkadot/util-crypto": "^1.6.1"
+    "@babel/runtime": "^7.7.4",
+    "@polkadot/util": "^1.7.1",
+    "@polkadot/util-crypto": "^1.7.1"
   }
 }

packages/keyring/src/keyring.ts

@@ -39,7 +39,7 @@ export default class Keyring implements KeyringInstance {
 
   public setSS58Format = setSS58Format;
 
-  public constructor (options: KeyringOptions = {}) {
+  constructor (options: KeyringOptions = {}) {
     options.type = options.type || 'ed25519';
     options.ss58Format = isNumber(options.ss58Format)
       ? options.addressPrefix

packages/keyring/src/pair/decode.ts

@@ -14,10 +14,9 @@ type DecodeResult = PairInfo & {
   secretKey: Uint8Array;
 };
 
-export default function decode (passphrase?: string, _encrypted?: Uint8Array | null): DecodeResult {
-  assert(_encrypted, 'No encrypted data available to decode');
+export default function decode (passphrase?: string, encrypted?: Uint8Array | null): DecodeResult {
+  assert(encrypted, 'No encrypted data available to decode');
 
-  const encrypted = (_encrypted as Uint8Array);
   const encoded = passphrase
     ? (naclDecrypt(
       encrypted.subarray(NONCE_LENGTH),

packages/keyring/src/pair/encode.ts

@@ -14,7 +14,7 @@ export default function encode ({ publicKey, secretKey }: PairInfo, passphrase?:
 
   const encoded = u8aConcat(
     PKCS8_HEADER,
-    secretKey as Uint8Array,
+    secretKey,
     PKCS8_DIVIDER,
     publicKey
   );

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

@@ -2,14 +2,19 @@
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
-import { setSS58Format } from '@polkadot/util-crypto';
+import { cryptoWaitReady, setSS58Format } from '@polkadot/util-crypto';
 
+import { PAIRS } from '../testing';
 import testingPairs from '../testingPairs';
 import createPair from '.';
 
 const keyring = testingPairs({ type: 'ed25519' }, false);
 
 describe('pair', (): void => {
+  beforeEach(async (): Promise<void> => {
+    await cryptoWaitReady();
+  });
+
   const SIGNATURE = new Uint8Array([80, 191, 198, 147, 225, 207, 75, 88, 126, 39, 129, 109, 191, 38, 72, 181, 75, 254, 81, 143, 244, 79, 237, 38, 236, 141, 28, 252, 134, 26, 169, 234, 79, 33, 153, 158, 151, 34, 175, 188, 235, 20, 35, 135, 83, 120, 139, 211, 233, 130, 1, 208, 201, 215, 73, 80, 56, 98, 185, 196, 11, 8, 193, 14]);
 
   it('has a publicKey', (): void => {
@@ -66,6 +71,8 @@ describe('pair', (): void => {
     expect(keyring.alice.address).toEqual(
       '7sGUeMak588SPY2YMmmuKUuLz7u2WQpf74F9dCFtSLB2td9d'
     );
+
+    setSS58Format(42);
   });
 
   it('allows getting public key after decoding', (): void => {
@@ -77,4 +84,13 @@ describe('pair', (): void => {
 
     expect(pair.isLocked).toEqual(false);
   });
+
+  it('allows derivation on the pair', (): void => {
+    const alice = createPair('sr25519', { publicKey: PAIRS[0].publicKey, secretKey: PAIRS[0].secretKey }, {});
+    const stash = alice.derive('//stash');
+    const soft = alice.derive('//funding/0');
+
+    expect(stash.publicKey).toEqual(PAIRS[1].publicKey);
+    expect(soft.address).toEqual('5ECQNn7UueWHPFda5qUi4fTmTtyCnPvGnuoyVVSj5CboJh9J');
+  });
 });

packages/keyring/src/pair/index.ts

@@ -6,8 +6,8 @@ import { Keypair, KeypairType } from '@polkadot/util-crypto/types';
 import { KeyringPair, KeyringPair$Json, KeyringPair$Meta, SignOptions } from '../types';
 import { PairInfo } from './types';
 
-import { u8aConcat } from '@polkadot/util';
-import { encodeAddress, naclKeypairFromSeed as naclFromSeed, naclSign, naclVerify, schnorrkelKeypairFromSeed as schnorrkelFromSeed, schnorrkelSign, schnorrkelVerify } from '@polkadot/util-crypto';
+import { u8aConcat, assert } from '@polkadot/util';
+import { encodeAddress, keyExtractPath, keyFromPath, naclKeypairFromSeed as naclFromSeed, naclSign, naclVerify, schnorrkelKeypairFromSeed as schnorrkelFromSeed, schnorrkelSign, schnorrkelVerify } from '@polkadot/util-crypto';
 
 import decode from './decode';
 import encode from './encode';
@@ -87,10 +87,21 @@ const verify = (type: KeypairType, message: Uint8Array, signature: Uint8Array, p
  */
 export default function createPair (type: KeypairType, { publicKey, secretKey }: PairInfo, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null): KeyringPair {
   return {
-    type,
     get address (): string {
       return encodeAddress(publicKey);
     },
+    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;
+    },
     decodePkcs8: (passphrase?: string, _encoded?: Uint8Array | null): void => {
       const decoded = decode(passphrase, _encoded || encoded);
 
@@ -104,20 +115,19 @@ export default function createPair (type: KeypairType, { publicKey, secretKey }:
         secretKey = pair.secretKey;
       }
     },
+    derive: (suri: string, meta?: KeyringPair$Meta): KeyringPair => {
+      assert(secretKey, 'Cannot derive on a locked keypair');
+
+      const { path } = keyExtractPath(suri);
+      const derived = keyFromPath({ publicKey, secretKey: secretKey }, path, type);
+
+      return createPair(type, derived, meta, null);
+    },
     encodePkcs8: (passphrase?: string): Uint8Array =>
       encode({ publicKey, secretKey }, passphrase),
-    get meta (): KeyringPair$Meta {
-      return meta;
-    },
-    get isLocked (): boolean {
-      return !secretKey || secretKey.length === 0 || isEmpty(secretKey);
-    },
     lock: (): void => {
       secretKey = new Uint8Array(0);
     },
-    get publicKey (): Uint8Array {
-      return publicKey;
-    },
     setMeta: (additional: KeyringPair$Meta): void => {
       meta = { ...meta, ...additional };
     },

packages/keyring/src/pair/nobody.ts

@@ -24,13 +24,16 @@ const json: KeyringPair$Json = {
 };
 
 export default function everybody (): KeyringPair {
-  return {
+  const pair: KeyringPair = {
     type: 'ed25519',
     address,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     decodePkcs8: (passphrase?: string, encoded?: Uint8Array): void =>
       undefined,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    derive: (suri: string, meta?: KeyringPair$Meta): KeyringPair =>
+      pair,
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     encodePkcs8: (passphrase?: string): Uint8Array =>
       new Uint8Array(0),
     meta,
@@ -52,4 +55,6 @@ export default function everybody (): KeyringPair {
     verify: (message: Uint8Array, signature: Uint8Array): boolean =>
       false
   };
+
+  return pair;
 }

packages/keyring/src/pairs.ts

@@ -12,7 +12,7 @@ type KeyringPairMap = Record<string, KeyringPair>;
 export default class Pairs implements KeyringPairs {
   private _map: KeyringPairMap;
 
-  public constructor () {
+  constructor () {
     this._map = {};
   }
 

packages/keyring/src/testing.ts

@@ -21,7 +21,7 @@ interface PairDef {
 // keyring is for testing - what happens is that in most cases the keyring is initialises
 // before anything else. Since the sr25519 crypto is async, this creates problems with
 // adding the keys when only the keyring is used.
-const PAIRS: PairDef[] = [
+export const PAIRS: PairDef[] = [
   {
     seed: 'Alice',
     secretKey: hexToU8a('0x98319d4ff8a9508c4bb0cf0b5a78d760a0b2082c02775e6e82370816fedfff48925a225d97aa00682d6a59b95b18780c10d7032336e88f3442b42361f4a66011'),

packages/keyring/src/types.ts

@@ -38,15 +38,16 @@ export interface SignOptions {
 }
 
 export interface KeyringPair {
+  readonly address: string;
+  readonly meta: KeyringPair$Meta;
+  readonly isLocked: boolean;
+  readonly publicKey: Uint8Array;
   readonly type: KeypairType;
 
-  address: string;
   decodePkcs8: (passphrase?: string, encoded?: Uint8Array) => void;
+  derive: (suri: string, meta?: KeyringPair$Meta) => KeyringPair;
   encodePkcs8: (passphrase?: string) => Uint8Array;
-  meta: KeyringPair$Meta;
-  isLocked: boolean;
   lock: () => void;
-  publicKey: Uint8Array;
   setMeta: (meta: KeyringPair$Meta) => void;
   sign (message: Uint8Array, options?: SignOptions): Uint8Array;
   toJson (passphrase?: string): KeyringPair$Json;

packages/trie-codec/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/trie-codec",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "This is an implementation of the codec for Substrate Trie",
   "main": "index.js",
   "keywords": [
@@ -25,7 +25,7 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-codec#readme",
   "dependencies": {
-    "@babel/runtime": "^7.6.3",
-    "@polkadot/util": "^1.6.1"
+    "@babel/runtime": "^7.7.4",
+    "@polkadot/util": "^1.7.1"
   }
 }

packages/trie-codec/src/NodeHeader.ts

@@ -21,7 +21,7 @@ export default class NodeHeader {
 
   private _value: Null | BranchHeader | ExtensionHeader | LeafHeader;
 
-  public constructor (input?: null | Uint8Array | (null | Uint8Array)[]) {
+  constructor (input?: null | Uint8Array | (null | Uint8Array)[]) {
     const [nodeType, value] = Array.isArray(input)
       ? NodeHeader.decodeNodeHeaderArray(input)
       : NodeHeader.decodeNodeHeaderU8a(input);

packages/trie-db/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/trie-db",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "This is an implementation of the modified merkle patricia tree as specified in Ethereum's yellow paper, adapted for Polkadot",
   "main": "index.js",
   "keywords": [
@@ -25,16 +25,16 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-db#readme",
   "dependencies": {
-    "@babel/runtime": "^7.6.3",
-    "@polkadot/db": "^1.6.1",
-    "@polkadot/trie-codec": "^1.6.1",
-    "@polkadot/trie-hash": "^1.6.1",
-    "@polkadot/util": "^1.6.1",
-    "@polkadot/util-crypto": "^1.6.1"
+    "@babel/runtime": "^7.7.4",
+    "@polkadot/db": "^1.7.1",
+    "@polkadot/trie-codec": "^1.7.1",
+    "@polkadot/trie-hash": "^1.7.1",
+    "@polkadot/util": "^1.7.1",
+    "@polkadot/util-crypto": "^1.7.1"
   },
   "devDependencies": {
-    "@polkadot/chainspec": "^1.6.1",
-    "@polkadot/util-rlp": "^1.6.1",
+    "@polkadot/chainspec": "^1.7.1",
+    "@polkadot/util-rlp": "^1.7.1",
     "ethereumjs-testing": "1.0.4"
   }
 }

packages/trie-db/src/Checkpoint.ts

@@ -7,7 +7,7 @@ export default class Checkpoint {
 
   protected rootHash: Uint8Array;
 
-  public constructor (rootHash: Uint8Array) {
+  constructor (rootHash: Uint8Array) {
     this.rootHash = rootHash;
     this.txRoot = rootHash;
   }

packages/trie-db/src/Impl.ts

@@ -42,7 +42,7 @@ export default class Impl extends Checkpoint {
 
   protected constants: Constants;
 
-  public constructor (db: TxDb, rootHash?: Uint8Array, codec: Codec = substrateCodec) {
+  constructor (db: TxDb, rootHash?: Uint8Array, codec: Codec = substrateCodec) {
     const _constants = constants(codec);
 
     super(rootHash || _constants.EMPTY_HASH);

packages/trie-db/src/index.ts

@@ -25,7 +25,7 @@ const l = logger('trie/db');
  * @example See [Polkadot-JS Common Trie-DB Examples](https://polkadot.js.org/api/common/examples/trie-db/)
  */
 export default class Trie extends Impl implements TrieDb {
-  public constructor (db: TxDb = new MemoryDb(), rootHash?: Uint8Array, codec?: Codec) {
+  constructor (db: TxDb = new MemoryDb(), rootHash?: Uint8Array, codec?: Codec) {
     super(db, rootHash, codec);
 
     l.debug((): string => `Created with ${this.codec.type} codec, root ${u8aToHex(this.rootHash, 64)}`);

packages/trie-hash/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/trie-hash",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "Generates trie roots from key-value pairs",
   "main": "index.js",
   "keywords": [
@@ -25,10 +25,10 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-hash#readme",
   "dependencies": {
-    "@babel/runtime": "^7.6.3",
-    "@polkadot/util": "^1.6.1"
+    "@babel/runtime": "^7.7.4",
+    "@polkadot/util": "^1.7.1"
   },
   "devDependencies": {
-    "@polkadot/chainspec": "^1.6.1"
+    "@polkadot/chainspec": "^1.7.1"
   }
 }

packages/util-crypto/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/util-crypto",
-  "version": "1.6.1",
+  "version": "1.7.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.6.3",
-    "@polkadot/util": "^1.6.1",
+    "@babel/runtime": "^7.7.4",
+    "@polkadot/util": "^1.7.1",
     "@polkadot/wasm-crypto": "^0.14.1",
     "@types/bip39": "^2.4.2",
     "@types/bs58": "^4.0.0",

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

@@ -2,6 +2,8 @@
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
+import { stringToU8a, u8aToHex } from '@polkadot/util';
+
 import testingPairs, { TestKeyringMap } from '../../../keyring/src/testingPairs';
 import decode from './decode';
 
@@ -20,6 +22,12 @@ describe('decode', (): void => {
     );
   });
 
+  it('decodes the council address', (): void => {
+    expect(
+      u8aToHex(decode('F3opxRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29'))
+    ).toEqual(u8aToHex(stringToU8a('modlpy/trsry'.padEnd(32, '\0'))));
+  });
+
   it('converts a publicKey (u8a) as-is', (): void => {
     expect(
       decode(new Uint8Array([1, 2, 3]))

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

@@ -28,6 +28,6 @@ export default function naclSign (message: Uint8Array | string, { publicKey, sec
   const messageU8a = u8aToU8a(message);
 
   return isReady()
-    ? ed25519Sign(publicKey as Uint8Array, (secretKey as Uint8Array).subarray(0, 32), messageU8a)
-    : nacl.sign.detached(messageU8a, secretKey as Uint8Array);
+    ? ed25519Sign(publicKey as Uint8Array, secretKey.subarray(0, 32), messageU8a)
+    : nacl.sign.detached(messageU8a, secretKey);
 }

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

@@ -14,10 +14,10 @@ import { sr25519Sign } from '@polkadot/wasm-crypto';
  * @description Returns message signature of `message`, using the supplied pair
  */
 export default function schnorrkelSign (message: Uint8Array | string, { publicKey, secretKey }: Partial<Keypair>): Uint8Array {
-  assert(publicKey && publicKey.length === 32, 'Expected valid publicKey, 32-bytes');
-  assert(secretKey && secretKey.length === 64, 'Expected valid secretKey, 64-bytes');
+  assert(publicKey?.length === 32, 'Expected valid publicKey, 32-bytes');
+  assert(secretKey?.length === 64, 'Expected valid secretKey, 64-bytes');
 
   const messageU8a = u8aToU8a(message);
 
-  return sr25519Sign(publicKey as Uint8Array, secretKey as Uint8Array, messageU8a);
+  return sr25519Sign(publicKey, secretKey, messageU8a);
 }

packages/util-rlp/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/util-rlp",
-  "version": "1.6.1",
+  "version": "1.7.1",
   "description": "RLP encoding and decoding",
   "main": "index.js",
   "keywords": [
@@ -27,8 +27,8 @@
   },
   "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-rlp#readme",
   "dependencies": {
-    "@babel/runtime": "^7.6.3",
-    "@polkadot/util": "^1.6.1"
+    "@babel/runtime": "^7.7.4",
+    "@polkadot/util": "^1.7.1"
   },
   "devDependencies": {
     "ethereumjs-testing": "1.0.4"

packages/util-rlp/src/decoder/decode.ts

@@ -30,5 +30,5 @@ export default function decode (input: Uint8Array): DecodeOutput {
 
   assert(decoder, 'Unable to find decoder for input type');
 
-  return (decoder as Decoder).fn(decode, input);
+  return decoder.fn(decode, input);
 }

packages/util-rlp/src/encoder/toU8a.ts

@@ -45,5 +45,5 @@ export default function toU8a (value?: any): Uint8Array {
 
   assert(encoder, 'invalid type');
 
-  return (encoder as Encoder).fn(value);
+  return encoder.fn(value);
 }

packages/util/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/util",
-  "version": "1.6.1",
+  "version": "1.7.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.6.3",
+    "@babel/runtime": "^7.7.4",
     "@types/bn.js": "^4.11.5",
     "bn.js": "^4.11.8",
     "camelcase": "^5.3.1",
-    "chalk": "^2.4.2",
+    "chalk": "^3.0.0",
     "ip-regex": "^4.1.0",
     "moment": "^2.24.0"
   }

packages/util/src/assert.spec.ts

@@ -6,20 +6,18 @@ import { assert } from '.';
 
 describe('assert', (): void => {
   it('should not throw an error when test is true', (): void => {
-    expect(
-      assert(true, 'nothing should be thrown')
-    ).toEqual(true);
+    assert(true, 'nothing should be thrown');
   });
 
   it('should throw an error when test is not true', (): void => {
     expect(
-      (): boolean => assert(false, 'error thrown')
+      (): void => assert(false, 'error thrown')
     ).toThrow(/error thrown/);
   });
 
   it('should throw an error when message: () => string', (): void => {
     expect(
-      (): boolean => assert(false, (): string => 'message from function')
+      (): void => assert(false, (): string => 'message from function')
     ).toThrow(/message from function/);
   });
 });

packages/util/src/assert.ts

@@ -6,8 +6,6 @@ import isFunction from './is/function';
 
 type MessageFn = () => string;
 
-type Falsy = null | undefined | false | 0 | ''; // No NaN type
-
 /**
  * @name assert
  * @summary Checks for a valid test, if not Error is thrown.
@@ -19,19 +17,18 @@ type Falsy = null | undefined | false | 0 | ''; // No NaN type
  * ```javascript
  * const { assert } from '@polkadot/util';
  *
- * assert(true, 'True should be true'); // true returned
+ * assert(true, 'True should be true'); // passes
  * assert(false, 'False should not be true'); // Error thrown
  * assert(false, () => 'message'); // Error with 'message'
  * ```
  */
-export default function assert<T> (test: Falsy | T, message: string | MessageFn): test is T {
-  if (test) {
-    return true;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export default function assert (condition: any, message: string | MessageFn): asserts condition {
+  if (!condition) {
+    throw new Error(
+      isFunction(message)
+        ? message()
+        : message
+    );
   }
-
-  if (isFunction(message)) {
-    message = message();
-  }
-
-  throw new Error(message);
 }

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

@@ -9,80 +9,108 @@ import formatBalance from './formatBalance';
 describe('formatBalance', (): void => {
   const TESTVAL = new BN('123456789000');
 
-  it('formats empty to 0', (): void => {
-    expect(formatBalance()).toEqual('0');
-    expect(formatBalance('0')).toEqual('0');
+  describe('SI formatting', (): void => {
+    it('formats empty to 0', (): void => {
+      expect(formatBalance()).toEqual('0');
+      expect(formatBalance('0')).toEqual('0');
+    });
+
+    it('formats 123,456,789,000 (decimals=15)', (): void => {
+      expect(
+        formatBalance(TESTVAL, true, 15)
+      ).toEqual('123.456µ Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=36)', (): void => {
+      expect(
+        formatBalance(TESTVAL, true, 36)
+      ).toEqual('0.123y Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=15, Compact)', (): void => {
+      const compact = {
+        toBn: (): BN => TESTVAL,
+        unwrap: (): BN => TESTVAL,
+        something: 'else'
+      };
+      expect(
+        formatBalance(compact, true, 15)
+      ).toEqual('123.456µ Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=12)', (): void => {
+      expect(
+        formatBalance(TESTVAL, true, 12)
+      ).toEqual('123.456m Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=12, no SI)', (): void => {
+      expect(
+        formatBalance(TESTVAL, false, 12)
+      ).toEqual('123.456');
+    });
+
+    it('formats 123,456,789,000 (decimals=9)', (): void => {
+      expect(
+        formatBalance(TESTVAL, true, 9)
+      ).toEqual('123.456 Unit');
+    });
+
+    it('formats 123,456,789,000 (decimals=6)', (): void => {
+      expect(
+        formatBalance(TESTVAL, true, 6)
+      ).toEqual('123.456k Unit');
+    });
+
+    it('formats 123,456,789,000 * 10 (decimals=12)', (): void => {
+      expect(
+        formatBalance(TESTVAL.muln(10), true, 12)
+      ).toEqual('1.234 Unit');
+    });
+
+    it('formats 123,456,789,000 * 100 (decimals=12)', (): void => {
+      expect(
+        formatBalance(TESTVAL.muln(100), true, 12)
+      ).toEqual('12.345 Unit');
+    });
+
+    it('formats 123,456,789,000 * 1000 (decimals=12)', (): void => {
+      expect(
+        formatBalance(TESTVAL.muln(1000), true, 12)
+      ).toEqual('123.456 Unit');
+    });
+
+    it('formats -123,456,789,000 (decimals=15)', (): void => {
+      expect(
+        formatBalance(new BN('-123456789000'), true, 15)
+      ).toEqual('-123.456µ Unit');
+    });
   });
 
-  it('formats 123,456,789,000 (decimals=15)', (): void => {
-    expect(
-      formatBalance(TESTVAL, true, 15)
-    ).toEqual('123.456µ Unit');
-  });
+  describe('Forced formatting', (): void => {
+    it('formats 123,456,789,000 (decimals=12, forceUnit=base)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { forceUnit: '-' }, 12)
+      ).toEqual('0.123 Unit');
+    });
 
-  it('formats 123,456,789,000 (decimals=36)', (): void => {
-    expect(
-      formatBalance(TESTVAL, true, 36)
-    ).toEqual('0.123y Unit');
-  });
+    it('formats 123,456,789,000 (decimals=9, forceUnit=base)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { forceUnit: '-' }, 9)
+      ).toEqual('123.456 Unit');
+    });
 
-  it('formats 123,456,789,000 (decimals=15, Compact)', (): void => {
-    const compact = {
-      toBn: (): BN => TESTVAL,
-      unwrap: (): BN => TESTVAL,
-      something: 'else'
-    };
-    expect(
-      formatBalance(compact, true, 15)
-    ).toEqual('123.456µ Unit');
-  });
+    it('formats 123,456,789,000 (decimals=7, forceUnit=base)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { forceUnit: '-' }, 7)
+      ).toEqual('12,345.678 Unit');
+    });
 
-  it('formats 123,456,789,000 (decimals=12)', (): void => {
-    expect(
-      formatBalance(TESTVAL, true, 12)
-    ).toEqual('123.456m Unit');
-  });
-
-  it('formats 123,456,789,000 (decimals=12, no SI)', (): void => {
-    expect(
-      formatBalance(TESTVAL, false, 12)
-    ).toEqual('123.456');
-  });
-
-  it('formats 123,456,789,000 (decimals=9)', (): void => {
-    expect(
-      formatBalance(TESTVAL, true, 9)
-    ).toEqual('123.456 Unit');
-  });
-
-  it('formats 123,456,789,000 (decimals=6)', (): void => {
-    expect(
-      formatBalance(TESTVAL, true, 6)
-    ).toEqual('123.456k Unit');
-  });
-
-  it('formats 123,456,789,000 * 10 (decimals=12)', (): void => {
-    expect(
-      formatBalance(TESTVAL.muln(10), true, 12)
-    ).toEqual('1.234 Unit');
-  });
-
-  it('formats 123,456,789,000 * 100 (decimals=12)', (): void => {
-    expect(
-      formatBalance(TESTVAL.muln(100), true, 12)
-    ).toEqual('12.345 Unit');
-  });
-
-  it('formats 123,456,789,000 * 1000 (decimals=12)', (): void => {
-    expect(
-      formatBalance(TESTVAL.muln(1000), true, 12)
-    ).toEqual('123.456 Unit');
-  });
-
-  it('formats -123,456,789,000 (decimals=15)', (): void => {
-    expect(
-      formatBalance(new BN('-123456789000'), true, 15)
-    ).toEqual('-123.456µ Unit');
+    it('formats 123,456,789,000 (decimals=15, forceUnit=µ)', (): void => {
+      expect(
+        formatBalance(TESTVAL, { forceUnit: 'µ' }, 15)
+      ).toEqual('123.456µ Unit');
+    });
   });
 
   describe('calcSi', (): void => {

packages/util/src/format/formatBalance.ts

@@ -2,22 +2,25 @@
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
-import { ToBn } from '../types';
+import { SiDef, ToBn } from '../types';
 
 import BN from 'bn.js';
 
 import bnToBn from '../bn/toBn';
+import isBoolean from '../is/boolean';
 import isUndefined from '../is/undefined';
 import formatDecimal from './formatDecimal';
-import { SI, SI_MID, SiDef, calcSi, findSi } from './si';
+import { SI, SI_MID, calcSi, findSi } from './si';
 
 interface Defaults {
   decimals: number;
   unit: string;
 }
 
+type Options = boolean | { forceUnit?: string; withSi?: boolean };
+
 interface BalanceFormatter {
-  <ExtToBn extends ToBn> (input?: number | string | BN | ExtToBn, withSi?: boolean, decimals?: number): string;
+  <ExtToBn extends ToBn> (input?: number | string | BN | ExtToBn, options?: Options, decimals?: number): string;
   calcSi (text: string, decimals?: number): SiDef;
   findSi (type: string): SiDef;
   getDefaults (): Defaults;
@@ -32,7 +35,7 @@ let defaultDecimals = DEFAULT_DECIMALS;
 let defaultUnit = DEFAULT_UNIT;
 
 // Formats a string/number with <prefix>.<postfix><type> notation
-function _formatBalance <ExtToBn extends ToBn> (input?: number | string | BN | ExtToBn, withSi = true, decimals: number = defaultDecimals): string {
+function _formatBalance <ExtToBn extends ToBn> (input?: number | string | BN | ExtToBn, options: Options = true, decimals: number = defaultDecimals): string {
   let text = bnToBn(input).toString();
 
   if (text.length === 0 || text === '0') {
@@ -47,10 +50,15 @@ function _formatBalance <ExtToBn extends ToBn> (input?: number | string | BN | E
     text = text.substr(1);
   }
 
+  // extract options - the boolean case is for backwards-compat
+  const { forceUnit = undefined, withSi = true } = isBoolean(options)
+    ? { withSi: options }
+    : options;
+
   // NOTE We start at midpoint (8) minus 1 - this means that values display as
   // 123.456 instead of 0.123k (so always 6 relevant). Additionally we us ceil
   // so there are at most 3 decimal before the decimal seperator
-  const si = calcSi(text, decimals);
+  const si = calcSi(text, decimals, forceUnit);
   const mid = text.length - (decimals + si.power);
   const prefix = text.substr(0, mid);
   const padding = mid < 0 ? 0 - mid : 0;

packages/util/src/format/si.ts

@@ -2,11 +2,7 @@
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.
 
-export interface SiDef {
-  power: number;
-  text: string;
-  value: string;
-}
+import { SiDef } from '../types';
 
 export const SI_MID = 8;
 
@@ -30,11 +26,6 @@ export const SI: SiDef[] = [
   { power: 24, value: 'Y', text: 'Yotta' }
 ];
 
-export function calcSi (text: string, decimals: number): SiDef {
-  const siDefIndex = (SI_MID - 1) + Math.ceil((text.length - decimals) / 3);
-  return SI[siDefIndex] || SI[siDefIndex < 0 ? 0 : SI.length - 1];
-}
-
 // Given a SI type (e.g. k, m, Y) find the SI definition
 export function findSi (type: string): SiDef {
   // use a loop here, better RN support (which doesn't have [].find)
@@ -46,3 +37,13 @@ export function findSi (type: string): SiDef {
 
   return SI[SI_MID];
 }
+
+export function calcSi (text: string, decimals: number, forceUnit?: string): SiDef {
+  if (forceUnit) {
+    return findSi(forceUnit);
+  }
+
+  const siDefIndex = (SI_MID - 1) + Math.ceil((text.length - decimals) / 3);
+
+  return SI[siDefIndex] || SI[siDefIndex < 0 ? 0 : SI.length - 1];
+}

packages/util/src/types.ts

@@ -8,6 +8,12 @@ export interface ToBn {
   toBn: () => BN;
 }
 
+export interface SiDef {
+  power: number;
+  text: string;
+  value: string;
+}
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type Logger$Data$Fn = () => any[];
 // eslint-disable-next-line @typescript-eslint/no-explicit-any