[CI Skip] release/stable 3.7.1

skip-checks: true

.123trigger

@@ -1 +1,2 @@
-1
+5
+2.6.22.12.2

.babelrc.js

@@ -1 +0,0 @@
-module.exports = require('./babel.config.js');

.circleci/config.yml

@@ -1,21 +0,0 @@
-version: 2
-jobs:
-  build:
-    working_directory: ~/polkadot-js
-    docker:
-      - image: circleci/node:10
-    steps:
-      - checkout
-      - restore_cache:
-          key: dependency-cache-{{ checksum "yarn.lock" }}
-      - run:
-          name: install-deps
-          command: yarn install --frozen-lockfile
-      - save_cache:
-          key: dependency-cache-{{ checksum "yarn.lock" }}
-          paths:
-            - ./node_modules
-            - ~/.cache/yarn
-      - run:
-          name: build
-          command: yarn polkadot-dev-circleci-build

.eslintignore

@@ -1,3 +0,0 @@
-**/build/*
-**/coverage/*
-**/node_modules/*

.eslintrc.js

@@ -1,11 +1,28 @@
+// Copyright 2017-2020 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
 const base = require('@polkadot/dev/config/eslint');
 
 module.exports = {
   ...base,
+  ignorePatterns: [
+    '.eslintrc.js',
+    '.github/**',
+    '.vscode/**',
+    '.yarn/**',
+    '**/build/*',
+    '**/coverage/*',
+    '**/node_modules/*'
+  ],
   parserOptions: {
     ...base.parserOptions,
     project: [
-      './tsconfig.eslint.json'
+      './tsconfig.json'
     ]
+  },
+  rules: {
+    ...base.rules,
+    // this seems very broken atm, false positives
+    '@typescript-eslint/unbound-method': 'off'
   }
 };

.github/ss58-check.md

@@ -0,0 +1,11 @@
+---
+assignees: ['jacogr']
+title: SS58 registry is outdated
+labels: ['ci', '@networks']
+---
+
+cc @jacogr
+
+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
+
+Check the nightly cron output or run `yarn networks:crosscheck` locally. The output as found from the test includes:

.github/workflows/pr-any.yml

@@ -0,0 +1,18 @@
+name: PR
+on: [pull_request]
+
+jobs:
+  pr:
+    strategy:
+      matrix:
+        step: ['lint', 'test', 'build']
+    name: ${{ matrix.step }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: ${{ matrix.step }}
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+      run: |
+        yarn install --immutable | grep -v 'YN0013'
+        yarn ${{ matrix.step }}

.github/workflows/push-master.yml

@@ -0,0 +1,34 @@
+name: Master
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  master:
+    strategy:
+      matrix:
+        step: ['build:release']
+    name: ${{ matrix.step }}
+    if: "! startsWith(github.event.head_commit.message, '[CI Skip]') && github.repository == 'polkadot-js/common'"
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        token: ${{ secrets.GH_PAT }}
+    - name: ${{ matrix.step }}
+      env:
+        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        GH_PAT: ${{ secrets.GH_PAT }}
+        GH_RELEASE_GITHUB_API_TOKEN: ${{ secrets.GH_PAT }}
+        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      run: |
+        yarn install --immutable | grep -v 'YN0013'
+        yarn ${{ matrix.step }}
+
+  dummy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: dummy
+      run: |
+        echo "Dummy skip step"

.github/workflows/ss58-check.yml

@@ -0,0 +1,24 @@
+name: SS58
+on:
+  schedule:
+    - cron:  '45 3 * * *'
+
+jobs:
+  ss58:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: check
+      env:
+        CI_LOG: 123
+      run: |
+        yarn install --immutable | grep -v 'YN0013'
+        yarn networks:crosscheck
+
+    - name: issue
+      if: ${{ failure() }}
+      uses: JasonEtco/create-an-issue@v2
+      env:
+        GITHUB_TOKEN: ${{ secrets.GH_PAT }}
+      with:
+        filename: .github/ss58-check.md

.gitignore

@@ -12,6 +12,10 @@ tmp/
 .env.test.local
 .env.production.local
 .npmrc
+.yarn/*
+!.yarn/releases
+!.yarn/plugins
+.pnp.*
 cc-test-reporter
 lerna-debug.log*
 npm-debug.log*
@@ -20,3 +24,5 @@ yarn-debug.log*
 yarn-error.log*
 store.db
 store.db.compacted
+.idea
+.vscode

.nvmrc

@@ -1 +1 @@
-10
+12

.travis.yml

@@ -1,28 +0,0 @@
-language: node_js
-node_js:
-  - "10"
-env:
-  global:
-    - CC_TEST_REPORTER_ID=27a299582eb7fd9580e27897a6ecda1c82a1cd24bcfe2f2ebda1ca70238509b4
-    - GH_PAGES_SRC="build-docs"
-cache:
-  yarn: true
-  directories:
-    - node_modules
-before_install:
-  - curl -o- -L https://yarnpkg.com/install.sh | bash
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - export PATH=$HOME/.yarn/bin:$(yarn global bin):$PATH
-before_script:
-  - ./cc-test-reporter before-build
-script:
-  - yarn polkadot-dev-travis-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-deploy:
-  skip_cleanup: true
-  provider: script
-  script: yarn polkadot-dev-travis-deploy
-  on:
-    branch: master

.yarnrc.yml

@@ -0,0 +1,15 @@
+enableImmutableInstalls: false
+
+enableProgressBars: false
+
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: "@yarnpkg/plugin-interactive-tools"
+  - path: .yarn/plugins/@yarnpkg/plugin-version.cjs
+    spec: "@yarnpkg/plugin-version"
+  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
+    spec: "@yarnpkg/plugin-workspace-tools"
+
+yarnPath: .yarn/releases/yarn-2.3.3.cjs

CHANGELOG.md

@@ -1,22 +1,365 @@
-# 1.3.1
+# CHANGELOG
 
-- Remove the `ExtError` class, always prefer the standard JS `Error` object for errors. This would bre a breaking change for any appliactions using `ExtError`
+## 3.7.1 Nov 1, 2020
 
-# 1.2.1
+Changes:
+
+- Remove the use of `chalk` (logger) for less overall dependencies
+- `string*` utilities now also allows `String` (class) inputs
+- Align bip39 use with wasm-crypto for English-only wordlist, default, non supplied)
+- Adjust elliptic imports for explicit paths (allows tree-shaking)
+- Add Totem (ss58 prefix 14) into `@polkadot/networks`
+- Move `@polkadot/x-{fetch,textdecoder,textencoder,ws}` into `common` repo
+
+
+## 3.6.1 Oct 18, 2020
+
+Contributed:
+
+- Add evmToAddress and addressToEvm `@polkadot/util-crypto` (Thanks to https://github.com/jnaviask)
+- Remove invalid link to docs (thanks to https://github.com/roccomuso)
+
+Changes:
+
+- Rename `mnemonicToBip39` to `mnemonicToLegacySeed` (used in non-Substrate compatible fashion)
+- Update pair signature verification to handle MultiSignature results
+- Move documentation to docs repo
+- Added `@polkadot/networks` for a list of known networks and their identifying information
+
+
+## 3.5.1 Sep 27, 2020
+
+Contributed:
+
+- Add Dock network identifiers (Thanks to https://github.com/lovesh)
+
+Changes:
+
+- Use cross-environment TextDecoder & TextEncoder from the polkadot-js polyfills
+- Add `isBase{32, 58, 64}` to `@polkadot/util-crypto`
+- Add `base64{Pad, Trim}` to add/remove padding characters
+- Add `createFromJson(json)` to keyring (create pair without adding)
+- Balance formatter now outputs 4 numbers after the decimal point
+
+
+## 3.4.1 Aug 31, 2020
+
+Changes:
+
+- Allow for WASM-as-available `mnemonicToBip39` call (used for Ethereum-compatible keypairs)
+- Add `isWasm` utility to check for valid WASM headers
+- `@polkadot/wasm-crypto` 1.4.1
+
+
+## 3.3.1 Aug 24, 2020
+
+Changes:
+
+- Add `addressRaw` to Keyring interface (if address encoding is different to publicKey)
+- Allow for Ethereum pair signing and verification
+
+
+## 3.2.1 Aug 17, 2020
+
+Changes:
+
+- Allow for (optional, default blake2) hasher to secp256k1 sign/verify functions
+- Utilities for secp256k1 publicKey expansion and compression
+- Add basic Ethereum address utils (encode with checksum & checksum verification)
+- Add Ethereum-compatible `mnemonicToBip39` seed creation function
+
+
+## 3.1.1 Aug 10, 2020
+
+Changes:
+
+- Add `deriveAddress(<address>, '/<soft>/<soft-b>')` via sr25519 soft
+- Use `scrypt` from WASM as available (JS fallback in place)
+- Add `base32{Encode, Decode}` utilities (IPFS-compatible alphabet)
+- Support IPFS compatibility flag in base58 encoding/decoding
+- Update to `@polkadot/wasm-crypto` 1.3.1
+
+
+## 3.0.1 Jul 27, 2020
+
+Contributed:
+
+- Add Katal ss58Format (Thanks to https://github.com/retotrinkler)
+
+Changes:
+
+- Adjust JSON pair output with scrypt kdf (version 3 output)
+
+
+## 2.18.1 Jul 13, 2020
+
+Changes:
+
+- Add `base64{Decode, Encode, Validate}` as crypto utils
+- Extract `base58Validate` from base58 decode checks
+- Add `isAscii` to allow detection of printable ASCII sequences (including tab, newline)
+- Add `isUtf8` to allow detection of valid Utf8 sequences
+
+
+## 2.17.1 Jul 6, 2020
+
+Changes:
+
+- Add `encode{Derived, Multi}Address` to encode derived/multi addresses
+- Correctly handle 0 inputs in `numberToU8a`
+- Simplify and flatten base58 dependencies
+
+
+## 2.16.1 Jun 29, 2020
+
+Changes:
+
+- Adjust `addressCheck` and `encodeAddress` function to check for valid base58 alphabets (better error reporting)
+- Rename `createKeySub` to `createKeyDerived` based on changed in Substrate (sub keys now named derived)
+
+
+## 2.15.1 Jun 22, 2020
+
+Changes:
+
+- Adjust keyring to no override 0-prefix (Polkadot live) settings with keychain default
+
+
+## 2.14.1 Jun 16, 2020
+
+Contributed:
+
+- Add `extractTime` utility conversion (Thanks to https://github.com/kwingram25)
+
+
+## 2.13.1 Jun 8, 2020
+
+Changes:
+
+- Fix JS blake2 fallback (non-wasm) to correctly deal with hex inputs
+- Align `bnToHex` signature with `bnToU8a` (with old/new style)
+- Allow `bnTo{Hex,U8a}` to take any value with `.toBn()` signatures
+
+
+## 2.12.2 Jun 1, 2020
+
+Changes:
+
+- Fix `isFunction` signature to assert `Function`
+
+
+## 2.12.1 Jun 1, 2020
+
+- **Important** Removed `mnemonicToSeed`, it is only for bip39, use `mnemonicToMiniSecret` for the Substrate variant
+
+Changes:
+
+- Added `u8aEq` to compare two Uint8Array or hex values for an exact match
+- Added `addressEq` to compare two addresses (ss58, Uint8array or hex) for an exact match
+- Throw error on `{nacl,schnorrkel}Verify` on invalid input lengths
+- Performance optimizations in `u8aToHex` & `u8aConcat`
+
+
+## 2.11.1 May 26, 2020
+
+Changes:
+
+- Internal cleanups on typings
+- Support for latest TypeScript, eslint & typescript-eslint
+
+
+## 2.10.1 May 14, 2020
+
+Contributed:
+
+- Add Kulupu ss58 prefix as an allowed value (Thanks to https://github.com/sorpaas)
+
+Changes:
+
+- Make the `TextEncoder` polyfill handle non-compliant Buffer implementations (newer versions of Jest)
+- `DeriveJunction` now also allows for BigInt values (aligning with number types elsewhere)
+- Small code-flow optimizations
+
+
+## 2.9.1 Apr 30, 2020
+
+Contributed:
+
+- Add support for ECDSA keypairs (Thanks to https://github.com/akru)
+
+Changes:
+
+- Added `createKeyMulti` & `createKeySub` to create utility sub & multi keys
+- Added `u8aSorted` to sort `Uint8Arrays`
+- Added `sortAddresses` to sort addresses based on their internal representation
+
+
+## 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)
+
+Changes:
+
+- Cleanup `isDevelopment` regex to cater for chains such as `Westend Development`
+
+
+## 2.7.1 Mar 31, 2020
+
+Changes:
+
+- 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
+
+Changes:
+
+- 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 yarn 2 projects
+
+
+## 2.5.1 Feb 22, 2020
+
+- **Breaking change** (TypeScript only) The `*.d.ts` files now contain TypeScript 3.8 features, `#private`, which is not usable in older versions
+
+Changes:
+
+- Add `isBigInt(value)` to allow `BigInt` checks. Also add support in `bnToBn` as well as number conversion utils
+- Add `isChildClass(Parent, Child?)` to check if a class extends the parent, asserting Child is Parent
+- (internal) Use `#<field>` instead of `private _<field>` for private class variables
+
+
+## 2.4.1 Feb 18, 2020
+
+Changes:
+
+- Ensure that `formatBalance` does not apply unit overrides apply when no SI is applicable
+- Adjust `formatBalance(<balance>, <options>)` to take expanded `withUnit: string | boolean` option where string is an actual unit, e.g. `KSM`
+- The `decimals` option to `formatBalance` should now be passed as part of the `options` (previous last-param deprecated)
+- The `.setSS58Format` on keyring will now just operate on pairs created on the keyring, not globally. The global `setSS58Format` in `@polkadot/util-crypto` will be deprecated.
+- The deprecated `addressPrefix` option to keyring has been belatedly removed (Use `ss58Format` rather)
+
+
+## 2.3.1 Feb 15, 2020
+
+Contributed:
+
+- 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)
+
+Changes:
+
+- Update to `@polkadot/wasm-crypto` 1.0
+- Cleanup dependencies to pave the way for using yarn 2 (Explicit instead of implicit)
+
+
+## 2.2.1 Feb 06, 2020
+
+Changes:
+
+- Add resolver for jest requires (tests from src)
+
+
+## 2.1.1 Feb 04, 2020
+
+Changes:
+
+- Update `detectPackage(<package.json>, __dirname?)` with calling folder
+
+
+## 2.0.1 Jan 30, 2020
+
+Changes:
+
+- Update w3f/schnorrkel to 0.8.5 (Full Substrate 2.x support, no 1.x support)
+- Remove Alice session (ed2551) account from testing keyring (not applicable to Substrate 2.x)
+- Remove `chainspec`, `db`, `trie-codec`, `trie-db` and `trie-hash` packages (moved to client)
+- Renamed `assertSingletonPackage` to `detectPackage` with inclusion of version listing
+- Swap to elliptic library for secp2561 recovery (No node bindings)
+
+
+## 1.8.1 Jan 09, 2020
+
+Contributed:
+
+- Add cross-client encryption/decryption support (Thanks to https://github.com/hskang9)
+
+
+## 1.7.1 Nov 27, 2019
+
+Changes:
+
+- `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 Oct 24, 2019
+
+Changes:
+
+- `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.
+
+
+## 1.5.1 Sep 25, 2019
+
+Changes:
+
+- Fix typings on the Keyring-exposed encode & decodeAddress
+- Allow ss58Format = 0 as a valid value
+- Loosen type definitions for allowed ss58format values (still checked against allowed array)
+
+
+## 1.4.1 Sep 12, 2019
+
+- **Breaking change** To set the `ss58Format`, you should now use `setSS58Format` as opposed to the old `setAddressPrefix`
+
+Changes:
+
+- Renamed `keyring.setAddressPrefix` to `keyring.setSS58Format`
+- Deprecated `addressPrefix` on the keyring options, added the `ss58Format` as a replacement (aligning with chain properties - the old version is still accepted)
+- Added `stringToHex` and `hexToString` conversion utilities to `@polkadot/util`
+- Swap to [Babel 7.6.0](https://babeljs.io/) for all compilation, for latest improvements in code generation
+
+
+## 1.3.1 Sep 10, 2019
+
+Changes:
+
+- Remove the `ExtError` class, always prefer the standard JS `Error` object for errors. This would bre a breaking change for any applications using `ExtError`
+
+
+## 1.2.1 Sep 09, 2019
+
+Changes:
 
 - Keyring `addFromAddress` can now be used to store external accounts, for example those provided by external signers
 - Maintainability updates
 
-# 1.1.1
+
+## 1.1.1 Aug 09, 2019
+
+Changes:
 
 - `assertSingletonPackage` now warns via console.warn, but does not throw. This does allow the info to come accross while still allowing the app developers using multiple libraries time to fix.
 
-# 1.0.1
+
+## 1.0.1 Aug 02, 2019
+
+Changes:
 
 - `formatBalance` now allows for `Compact` inputs
 - `formaBalance` now allows correct formatting of very large decimals
 
-# 0.94.1
+
+## 0.94.1 Jul 20, 2019
+Changes:
 
 - Add `checkAddress(address, prefix)` to `@polkadot/util-crypto` that validates an ss-58 address
 - Add support for the Kusama network (as a valid checked prefix)
@@ -24,7 +367,10 @@
 - The ed25519 key for Alice (representing the session), now appears in the test keyrings
 - Fix missing dependencies for keyring (after address moves in 0.93.1)
 
-# 0.93.1
+
+## 0.93.1 Jun 14, 2019
+
+Changes:
 
 - Breaking: External pair interface for keyring has been changed. Instead of
   - `getMeta` use the `meta` getter, i.e. `console.log(pair.meta.name)`
@@ -32,69 +378,176 @@
   - `publicKey` use the `publicKey` getter, i.e. `console.log(pair.publicKey)`
 - `Move decodeAddress`, `encodeAddress` & `setAddressPrefix` functions into `@polkadot/util-crypto` from `@polkadot/keyring`. External interfaces should not be affected at this point since it is also (still) exported and exposed on keyring
 
-# 0.92.1
+
+## 0.92.1 Jun 04, 2019
+
+Changes:
 
 - Only allow integer input values into `formatBalance`
 - Allow `formatBalance`, `formatDecimal` & `formatNumber` to cater for negative numbers
 - Add 'Bob//stash' to testing keyring, joining the existing 'Alice//stash'
 
-# 0.91.1
+
+## 0.91.1 May 22, 2019
+
+Changes:
 
 - ed25519/sr25519 sign & verify functions can now take the message input as Uint8Array/string/hex and verify allows for the signature/publicKey to be specified as Uint8Array/hex
 - Update `@polkadot/wasm` to include a maintenance bump for the `w3f/schnorrkel` libraries
 
-# 0.90.1
+
+## 0.90.1 May 08, 2019
+
+Changes:
 
 - Moving towards 1.0
 - Added bnMin & bnMax functions
 
-# 0.76.1
+
+## 0.76.1 Apr 03, 2019
+
+Changes:
 
 - Fix `addFromMnemonic` to generate using new-style derivation.
 - Pull in `formatBalance`, `formatDecimal`, `formatElapsed`, `formatNumber`, `calcSi`, `findSi` & `isTestChain` utility functions from the originals in `@polkadot/ui-util`
 - Swap out `wasm-schnorrkel` & `wasm-ed25519` for combined version with `wasm-crypto`
 - Swap DB interfaces to optional LRU, removing `transactionAsync` (client-only changes)
 
-# 0.75.1
+
+## 0.75.1 Mar 29, 2019
+
+Changes:
 
 - Start journey to 1.0
 
-# 0.42.1
+
+## 0.42.1 Mar 28, 2019
+
+Changes:
 
 - Add `assertSingletonPackage` to util
 - Ensure that only a single keyring instance is loaded (uses above)
 
-# 0.41.1
+
+## 0.41.1 Mar 25, 2019
+
+Changes:
 
 - Extensions to the client-specific database interfaces (non-breaking for API and util users)
 
-# 0.40.1
+
+## 0.40.1 Mar 23, 2019
+
+Changes:
 
 - Add additional derivation path extraction mechanisms to util-crypto
 - Add createFromUri function to keypair (creates keypair, does not add it)
 - Allow all crypto hashing & ed25519 to use WASM (as available, JS fallbacks)
 
-# 0.39.1
+
+## 0.39.1 Mar 20, 2019
+
+Changes:
 
 - Pull in bip39 generation functions from `@poladkot/wasm-crypto` with a fallback to the pure JS versions
 
-# 0.38.1
+
+## 0.38.1 Mar 18, 2019
+
+Changes:
 
 - Align with current substrate master for sr25519 keys and hard/soft derivation
 - Swap default dev keys to derived (sr25519)
 
-# 0.37.1
+
+## 0.37.1 Mar 14, 2019
+
+Changes:
 
 - Swap to publishing -beta.x on merge (non-breaking testing)
 
-# 0.36.1
+
+## 0.36.1 Mar 13, 2019
+
+Changes:
 
 - Add `fromUri` to keyring along with hard & soft key derivation.
 
-# 0.35.1
+
+## 0.35.1 Mar 04, 2019
+
+Changes:
 
 - Remove NodeJs-only `syncify` function, not exported by the package (with binary dependency for Node)
 
-# 0.34.1
+
+## 0.34.1 Feb 13, 2019
+
+Changes:
 
 - Keyring now allows for ed25519 and sr25519 instances. Upon creation, you need to pass the `ed25519`or `sr25519` string to denote the type, i.e. `new Keyring({ type: 'sr25519' })`
+
+
+## 0.33.1 Nov 22, 2018
+
+## 0.32.1 Oct 18, 2018
+
+## 0.31.1 Oct 12, 2018
+
+## 0.30.1 Sep 11, 2018
+
+## 0.29.1 Sep 01, 2018
+
+## 0.28.1 Aug 11, 2018
+
+## 0.27.1 Aug 06, 2018
+
+## 0.26.1 Jun 27, 2018
+
+## 0.25.1 Jun 26, 2018
+
+## 0.24.1 Jun 22, 2018
+
+## 0.23.1 Jun 21, 2018
+
+## 0.22.1 May 24, 2018
+
+## 0.21.1 May 17, 2018
+
+## 0.20.1 May 16, 2018
+
+## 0.19.1 Apr 19, 2018
+
+## 0.18.1 Mar 20, 2018
+
+## 0.17.1 Mar0 8, 2018
+
+## 0.16.1 Feb 23, 2018
+
+## 0.15.1 Feb 15, 2018
+
+## 0.14.1 Feb 07, 2018
+
+## 0.13.1 Jan 25, 2018
+
+## 0.12.1 Jan 11, 2018
+
+## 0.11.1 Dec 30, 2017
+
+## 0.10.1 Dec 17, 2017
+
+## 0.9.1 Dec 14, 2017
+
+## 0.8.1 Dec 12, 2017
+
+## 0.7.1 Dec 11, 2017
+
+## 0.6.1 Nov 30, 2017
+
+## 0.5.1 Nov 20, 2017
+
+## 0.4.1 Nov 19, 2017
+
+## 0.3.1 Nov 19, 2017
+
+## 0.2.1 Nov 18, 2017

README.md

@@ -16,13 +16,6 @@ This repository is split up into a number of internal packages, namely utilities
 - [keyring](packages/keyring/) Keyring management
 - [util](packages/util/) General utilities
 - [util-crypto](packages/util-crypto/) Crypto and hashing utilities
-- [util-rlp](packages/util-rlp/) RLP encoding & decoding
-
-Various useful trie and database interfaces -
-
-- [db](packages/db/) Sync memory and disk database interfaces
-- [trie-db](packages/trie-db/) Merkle Patricia Tree implementation adapted for Polkadot
-- [trie-hash](packages/trie-hash/) Calculate hashes (either ordered or unordered) from a set of inputs
 
 ## development
 

babel.config.js

@@ -1,3 +1,4 @@
-module.exports = {
-  extends: '@polkadot/dev/config/babel'
-};
+// Copyright 2017-2020 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+module.exports = require('@polkadot/dev/config/babel');

copy-to-apps.sh

@@ -1,17 +0,0 @@
-#!/bin/bash
-
-function copy_folder () {
-  SRC="packages/$1/build"
-  DST="../apps/node_modules/@polkadot/$1"
-
-  echo "** Copying $SRC to $DST"
-
-  rm -rf $DST
-  cp -r $SRC $DST
-}
-
-yarn polkadot-dev-build-ts
-
-copy_folder "keyring"
-copy_folder "util"
-copy_folder "util-crypto"

docs/.nojekyll

@@ -0,0 +1 @@
+

docs/.vuepress/config.js

@@ -1,41 +0,0 @@
-module.exports = {
-  base: '/common/',
-  title: 'polkadot-js/common',
-  description: 'Common utilities and libraries that are in use accross all @polkadot projects',
-  markdown: {
-    lineNumbers: true
-  },
-  themeConfig: {
-    displayAllHeaders: true,
-    nav: [
-      { text: 'Polkadot/Substrate Apps', link: 'https://polkadot.js.org/apps/' },
-      { text: 'Project family', link: 'https://polkadot.js.org/' },
-      {
-        text: 'Documentation',
-        items: [
-          { text: 'API Reference', link: 'https://polkadot.js.org/api/' },
-          { text: 'Utility Reference (this)', link: 'https://polkadot.js.org/common/' },
-          { text: 'UI Libs Reference', link: 'https://polkadot.js.org/ui/' },
-        ]
-      },
-      { text: 'GitHub', link: 'https://github.com/polkadot-js/common' }
-    ],
-    search: false,
-    sidebar: [
-      {
-        title: 'Examples (keyring)',
-        path: '/examples/keyring/',
-        collapsable: false,
-        sidebarDepth: 1,
-        children: [
-          ['/examples/keyring/01_create_account/', 'Create account'],
-          ['/examples/keyring/02_load_accounts/', 'Load Accounts']
-        ]
-      },
-      ['/util/', '@polkadot/util'],
-      ['/util-crypto/', '@polkadot/util-crypto'],
-      ['/keyring/', '@polkadot/keyring'],
-      '/CONTRIBUTING.md'
-    ]
-  }
-};

docs/.vuepress/styles/palette.styl

@@ -1,9 +0,0 @@
-$accentColor = #fd8824
-$textColor = #2c3e50
-
-.home .hero .description,
-.home .feature h2,
-.home .feature p {
-  color: $textColor
-  opacity: 0.75
-}

docs/404.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="initial-scale=0.5, maximum-scale=1">
+    <meta http-equiv="refresh" content="0;URL='https://polkadot.js.org/docs/'" />
+    <title>Redirecting to https://polkadot.js.org/docs/</title>
+  </head>
+  <body>
+    Redirecting to <a href="https://polkadot.js.org/docs/">https://polkadot.js.org/docs/</a>
+  </body>
+</html>

docs/README.md

@@ -1,51 +0,0 @@
----
-home: true
-heroText:
-tagline:
-# Bringing JavaScript to the Polkadot world.
-# actionText: Repository Overview
-# actionLink: /REPOS.md
-features:
-- title: Keyring
-  details: Manage user keys allowing for signing, encryption and decryption.
-- title: Utilities
-  details: Various user utilities to work with data and perform check on it.
-- title: Crypto
-  details: A thin and easy-to-use wrapper around cryptographic and hashing libraries.
-
-footer: Apache-2 Licensed | Copyright © 2017-2019 polkadot-js authors and contributors
----
-
-## Welcome
-
-Various useful utility functions that are used across all projects in the [@polkadot](https://polkadot.js.org) namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.
-
-::: tip Examples
-In a rush and just want examples? [Jump right in](/examples/keyring/) and get a handle on using the various components in your projects.
-:::
-
-## Available packages
-
-It is split up into a number of internal packages, namely utilities -
-
-- [keyring](keyring/README.md) Keyring management
-- [util](util/README.md) General utilities
-- [util-crypto](util-crypto/README.md) Crypto and hashing utilities
-
-## The Polkadot Project
-
-You can read more about the Polkadot Network at [https://polkadot.network/](https://polkadot.network/)
-
-## Github repositories
-
-You can find the Polkadot repositories at:
-
-- [https://github.com/polkadot-js](https://github.com/polkadot-js)
-- [https://github.com/paritytech/polkadot](https://github.com/paritytech/polkadot)
-- [https://github.com/paritytech/substrate](https://github.com/paritytech/substrate)
-
-This documentation is generated from [https://github.com/polkadot-js/common](https://github.com/polkadot-js/common)
-
-## Contributing
-
-Contribution to Polkadot JS Common are more than welcome. You can [report issues](https://github.com/polkadot-js/common/issues/new) and [log feature requests](https://github.com/polkadot-js/common/issues/new).

docs/examples/.gitignore

@@ -1 +0,0 @@
-yarn.lock

docs/examples/keyring/01_create_account/README.md

@@ -1,5 +0,0 @@
-# Create Account
-
-The following example shows how to create and account with keyring.
-
-<<< @/docs/examples/keyring/01_create_account/index.js

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

@@ -1,21 +0,0 @@
-/* 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;
-
-async function main () {
-  // Create account seed for Alice
-  const ALICE_SEED = 'Alice'.padEnd(32, ' ');
-
-  // Create an instance of the Keyring
-  const keyring = new Keyring();
-
-  // Create pair and add Alice to keyring pair dictionary (with account seed)
-  const pairAlice = keyring.addFromSeed(stringToU8a(ALICE_SEED));
-
-  console.log(`Created keyring pair for Alice with address: ${keyring.getPair(pairAlice.address).address}`);
-}
-
-main().catch(console.error).finally(() => process.exit());

docs/examples/keyring/01_create_account/package.json

@@ -1,19 +0,0 @@
-{
-  "name": "01_create_account",
-  "version": "0.1.0",
-  "description": "Example showing how to create an account",
-  "main": "index.js",
-  "author": "ltfschoen",
-  "license": "MIT",
-  "scripts": {
-    "clean": "rimraf node_modules",
-    "start": "node index.js"
-  },
-  "dependencies": {
-    "@polkadot/util": "^0.32.10",
-    "@polkadot/keyring": "^0.32.10"
-  },
-  "devDependencies": {
-    "rimraf": "^2.6.2"
-  }
-}

docs/examples/keyring/02_load_accounts/README.md

@@ -1,5 +0,0 @@
-# Load Accounts
-
-The following example shows how to load all accounts from the keyring as pairs and convert them into JSON format.
-
-<<< @/docs/examples/keyring/02_load_accounts/index.js

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

@@ -1,33 +0,0 @@
-/* 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;
-
-async function main () {
-  // Create account seed for Alice and Bob
-  const ALICE_SEED = 'Alice'.padEnd(32, ' ');
-  const BOB_SEED = 'Bob'.padEnd(32, ' ');
-
-  // Create an instance of the Keyring
-  const keyring = new Keyring();
-
-  // Create their pairs with account seeds. Add to keyring pair dictionary
-  keyring.addFromSeed(stringToU8a(ALICE_SEED));
-  keyring.addFromSeed(stringToU8a(BOB_SEED));
-
-  // Note that we did not use `addFromAddress` since it does not add the
-  // secret key to memory so we cannot later retrieve it with `getPairs`
-
-  // Retrieve all keyring pairs from the keyring pair dictionary
-  keyring
-    .getPairs()
-    .forEach((pair, index) => {
-      const { address } = pair;
-
-      console.log(`\nAccount with index #${index} has json: `, JSON.stringify(keyring.toJson(address), null, 2));
-    });
-}
-
-main().catch(console.error).finally(() => process.exit());

docs/examples/keyring/02_load_accounts/package.json

@@ -1,19 +0,0 @@
-{
-  "name": "02_load_accounts",
-  "version": "0.1.0",
-  "description": "Example showing how to load accounts",
-  "main": "index.js",
-  "author": "ltfschoen",
-  "license": "MIT",
-  "scripts": {
-    "clean": "rimraf node_modules",
-    "start": "node index.js"
-  },
-  "dependencies": {
-    "@polkadot/util": "^0.32.10",
-    "@polkadot/keyring": "^0.32.10"
-  },
-  "devDependencies": {
-    "rimraf": "^2.6.2"
-  }
-}

docs/examples/keyring/03_validate_address/README.md

@@ -1,5 +0,0 @@
-# Validate Adress
-
-- This function will return true if the address is a legitamate Polkadot address and false if it is not
-
-- Works both with Ed25519 and Sr25519 key types

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

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

docs/examples/keyring/03_validate_address/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "03_validate_address",
-  "version": "0.1.0",
-  "description": "Example showing how to validate a polkadot address",
-  "main": "index.js",
-  "author": "Jesse",
-  "license": "MIT",
-  "scripts": {
-    "clean": "rimraf node_modules",
-    "start": "node index.js"
-  },
-  "dependencies": {
-    "@polkadot/keyring": "*"
-  },
-  "devDependencies": {
-    "rimraf": "^2.6.2"
-  }
-}

docs/examples/keyring/README.md

@@ -1,12 +0,0 @@
-# Keyring Examples
-
-Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain.
-
-## Running the examples
-
-From within each folder run the following to install required dependencies and to execute the example:
-```shell
-yarn;
-yarn start
-```
-

docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/README.md

@@ -1,5 +0,0 @@
-# Encrypt & Decrypt Message using NaCl
-
-The following example shows how to encrypt and decrypt a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.
-
-[include](index.js)

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

@@ -1,26 +0,0 @@
-/* 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');
-
-async function main () {
-  const secret = new Uint8Array(32);
-  const messagePreEncryption = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
-  const noncePreEncryption = new Uint8Array(24);
-
-  // Encrypt the message
-  const { encrypted, nonce } = naclEncrypt(messagePreEncryption, secret, noncePreEncryption);
-
-  // Show contents of the encrypted message
-  console.log(`Encrypted message: ${JSON.stringify(encrypted, null, 2)}`);
-
-  // Decrypt the message
-  const messageDecrypted = naclDecrypt(encrypted, nonce, secret);
-  // Convert each Uint8Array to a string for comparison
-  const isMatch = messagePreEncryption.toString === messageDecrypted.toString;
-
-  // Verify that the decrypted message matches the original message
-  console.log(`Does the decrypted message match the original message? ${isMatch}`);
-}
-
-main().catch(console.error).finally(() => process.exit());

docs/examples/util-crypto/01_encrypt_decrypt_message_nacl/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "01_encrypt_decrypt_message_nacl",
-  "version": "0.1.0",
-  "description": "Example showing how to encrypt and decrypt a message using NaCl",
-  "main": "index.js",
-  "author": "ltfschoen",
-  "license": "MIT",
-  "scripts": {
-    "clean": "rimraf node_modules",
-    "start": "node index.js"
-  },
-  "dependencies": {
-    "@polkadot/util-crypto": "^0.32.10"
-  },
-  "devDependencies": {
-    "rimraf": "^2.6.2"
-  }
-}

docs/examples/util-crypto/02_sign_verify_message_nacl/README.md

@@ -1,5 +0,0 @@
-# Sign & Verify Message using NaCl
-
-The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.
-
-[include](index.js)

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

@@ -1,32 +0,0 @@
-/* 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');
-
-async function main () {
-  // Create account seed for Alice as fallback if generated mnemonic not valid
-  const seedAlice = 'Alice'.padEnd(32, ' ');
-
-  // Generate new public/secret keypair for Alice from the supplied seed
-  const { secretKey, publicKey } = naclKeypairFromSeed(stringToU8a(seedAlice));
-
-  // Encrypt message. Create Uint8Array's filled with random bytes of specified length
-  const secret = randomAsU8a(32);
-  const messagePreEncryption = stringToU8a('please send me DOTs');
-  const noncePreEncryption = randomAsU8a(24);
-
-  const { encrypted } = naclEncrypt(messagePreEncryption, secret, noncePreEncryption);
-
-  // Sign the message with a valid signature
-  const messageSignature = naclSign(encrypted, secretKey);
-
-  console.log(`Message signature: ${u8aToHex(messageSignature)}`);
-
-  // Validate that the message was correctly signed
-  const isValidSignature = naclVerify(encrypted, messageSignature, publicKey);
-
-  console.log(`Was the message correctly signed? ${isValidSignature}`);
-}
-
-main().catch(console.error).finally(() => process.exit());

docs/examples/util-crypto/02_sign_verify_message_nacl/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "02_sign_verify_message_nacl",
-  "version": "0.1.0",
-  "description": "Example showing how to sign and verify a message using NaCl",
-  "main": "index.js",
-  "author": "ltfschoen",
-  "license": "MIT",
-  "scripts": {
-    "clean": "rimraf node_modules",
-    "start": "node index.js"
-  },
-  "dependencies": {
-    "@polkadot/util-crypto": "^0.32.10"
-  },
-  "devDependencies": {
-    "rimraf": "^2.6.2"
-  }
-}

docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/README.md

@@ -1,5 +0,0 @@
-# Create & Generate Mnemonic using BIP39
-
-The following example shows how to create and generate mnemonics using BIP39.
-
-[include](index.js)

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

@@ -1,27 +0,0 @@
-/* eslint-disable @typescript-eslint/unbound-method */
-/* eslint-disable @typescript-eslint/require-await */
-/* eslint-disable @typescript-eslint/no-var-requires,@typescript-eslint/no-unused-vars */
-const { mnemonicGenerate, mnemonicToSeed, mnemonicValidate, naclKeypairFromSeed } = require('@polkadot/util-crypto');
-
-async function main () {
-  // Create mnemonic string for Alice using BIP39
-  const mnemonicAlice = mnemonicGenerate();
-
-  console.log(`Generated mnemonic: ${mnemonicAlice}`);
-
-  // Validate the mnemic string that was generated
-  const isValidMnemonic = mnemonicValidate(mnemonicAlice);
-
-  console.log(`isValidMnemonic: ${isValidMnemonic}`);
-
-  // Create valid seed from mnemonic as u8a and convert it to a string
-  // FIXME - Replace with mnemonicToSeed once exposed
-  const seedAlice = mnemonicToSeed(mnemonicAlice);
-
-  // Generate new public/secret keypair for Alice from the supplied seed
-  const { secretKey, publicKey } = naclKeypairFromSeed(seedAlice);
-
-  // Encrypt, Sign and Validate the message. See Example 'Sign & Verify Message'
-}
-
-main().catch(console.error).finally(() => process.exit());

docs/examples/util-crypto/03_mnemonic_generate_validate_bip39/package.json

@@ -1,18 +0,0 @@
-{
-  "name": "03_mnemonic_generate_validate_bip39",
-  "version": "0.1.0",
-  "description": "Example showing how to sign and verify a message using NaCl",
-  "main": "index.js",
-  "author": "ltfschoen",
-  "license": "MIT",
-  "scripts": {
-    "clean": "rimraf node_modules",
-    "start": "node index.js"
-  },
-  "dependencies": {
-    "@polkadot/util-crypto": "^0.32.10"
-  },
-  "devDependencies": {
-    "rimraf": "^2.6.2"
-  }
-}

docs/examples/util-crypto/README.md

@@ -1,13 +0,0 @@
-# Util-Crypto Examples
-
-Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.
-
-## Running the examples
-
-From within each folder run the following to install required dependencies and to execute the example:
-```shell
-yarn;
-yarn start
-```
-
-

docs/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="initial-scale=0.5, maximum-scale=1">
+    <meta http-equiv="refresh" content="0;URL='https://polkadot.js.org/docs/'" />
+    <title>Redirecting to https://polkadot.js.org/docs/</title>
+  </head>
+  <body>
+    Redirecting to <a href="https://polkadot.js.org/docs/">https://polkadot.js.org/docs/</a>
+  </body>
+</html>

jest.config.js

@@ -1,24 +1,26 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+// Copyright 2017-2020 @polkadot/util authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
 const config = require('@polkadot/dev/config/jest');
 
 module.exports = Object.assign({}, config, {
   moduleNameMapper: {
-    '@polkadot/chainspec(.*)$': '<rootDir>/packages/chainspec/src/$1',
-    '@polkadot/db(.*)$': '<rootDir>/packages/db/src/$1',
     '@polkadot/keyring(.*)$': '<rootDir>/packages/keyring/src/$1',
-    '@polkadot/trie-(codec|db|hash)(.*)$': '<rootDir>/packages/trie-$1/src/$2',
-    '@polkadot/util-(crypto|rlp)(.*)$': '<rootDir>/packages/util-$1/src/$2',
-    '@polkadot/util(.*)$': '<rootDir>/packages/util/src/$1'
+    '@polkadot/networks(.*)$': '<rootDir>/packages/networks/src/$1',
+    '@polkadot/util-(crypto)(.*)$': '<rootDir>/packages/util-$1/src/$2',
+    // eslint-disable-next-line sort-keys
+    '@polkadot/util(.*)$': '<rootDir>/packages/util/src/$1',
+    '@polkadot/x-(fetch|textdecoder|textencoder|ws)(.*)$': '<rootDir>/packages/x-$1/src/node'
   },
   modulePathIgnorePatterns: [
-    '<rootDir>/packages/db/build',
-    '<rootDir>/packages/chainspec/build',
     '<rootDir>/packages/keyring/build',
-    '<rootDir>/packages/trie-codec/build',
-    '<rootDir>/packages/trie-db/build',
-    '<rootDir>/packages/trie-hash/build',
+    '<rootDir>/packages/networks/build',
     '<rootDir>/packages/util/build',
     '<rootDir>/packages/util-crypto/build',
-    '<rootDir>/packages/util-rlp/build'
-  ]
+    '<rootDir>/packages/x-fetch/build',
+    '<rootDir>/packages/x-textdecoder/build',
+    '<rootDir>/packages/x-textencoder/build',
+    '<rootDir>/packages/x-ws/build'
+  ],
+  resolver: '@polkadot/dev/config/jest-resolver'
 });

lerna.json

@@ -1,13 +0,0 @@
-{
-  "npmClient": "yarn",
-  "useWorkspaces": true,
-  "command": {
-    "publish": {
-      "allowBranch": "master"
-    }
-  },
-  "packages": [
-    "packages/*"
-  ],
-  "version": "1.3.1"
-}

package.json

@@ -1,29 +1,30 @@
 {
-  "version": "1.3.1",
+  "repository": "https://github.com/polkadot-js/common",
+  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "license": "Apache-2",
   "private": true,
-  "engines": {
-    "yarn": "^1.10.1"
-  },
   "workspaces": [
     "packages/*"
   ],
   "resolutions": {
     "babel-core": "^7.0.0-bridge.0",
-    "typescript": "^3.6.2"
+    "typescript": "^4.0.5"
   },
   "scripts": {
-    "build": "polkadot-dev-build-ts && polkadot-dev-build-docs",
-    "check": "yarn lint",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx . && tsc --noEmit --pretty",
+    "build": "polkadot-dev-build-ts",
+    "build:release": "polkadot-ci-ghact-build",
+    "lint": "polkadot-dev-run-lint",
     "clean": "polkadot-dev-clean-build",
+    "networks:crosscheck": "polkadot-dev-run-test packages/networks/src/crosscheck",
     "postinstall": "polkadot-dev-yarn-only",
-    "test": "jest --coverage --runInBand",
-    "test:one": "jest"
+    "test": "polkadot-dev-run-test --coverage --runInBand --testPathIgnorePatterns crosscheck",
+    "test:one": "polkadot-dev-run-test"
   },
   "devDependencies": {
-    "@babel/core": "^7.5.5",
-    "@polkadot/dev": "^0.31.0-beta.7",
-    "@polkadot/ts": "^0.1.71",
-    "gh-pages": "^2.1.1"
-  }
+    "@babel/core": "^7.12.3",
+    "@polkadot/dev": "^0.59.12",
+    "@polkadot/ts": "^0.3.53",
+    "@types/jest": "^26.0.15"
+  },
+  "version": "3.7.1"
 }

packages/chainspec/README.md

@@ -1,7 +0,0 @@
-# @polkadot/chainspec
-
-Chainspecs for known chains
-
-## Utilities
-
-[Utilities](SUMMARY.md)

packages/chainspec/src/index.ts

@@ -1,6 +0,0 @@
-// Copyright 2017-2019 @polkadot/chainspec 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 { default as alexander } from './alexander';
-export { default as driedDanta } from './dried-danta';

packages/chainspec/src/types.ts

@@ -1,20 +0,0 @@
-// Copyright 2017-2019 @polkadot/chainspec 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 type Telemetry = [string, number];
-
-export interface Chainspec {
-  bootNodes: string[];
-  id: string;
-  genesis: {
-    raw: Record<string, string>;
-  };
-  genesisRoot?: string;
-  name: string;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  properties: null | Record<string, any>;
-  protocolId: string | null;
-  telemetryUrl?: string | null;
-  telemetryEndpoints?: Telemetry[];
-}

packages/db/LICENSE

@@ -1,201 +0,0 @@
-                              Apache License
-                        Version 2.0, January 2004
-                    http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-  "License" shall mean the terms and conditions for use, reproduction,
-  and distribution as defined by Sections 1 through 9 of this document.
-
-  "Licensor" shall mean the copyright owner or entity authorized by
-  the copyright owner that is granting the License.
-
-  "Legal Entity" shall mean the union of the acting entity and all
-  other entities that control, are controlled by, or are under common
-  control with that entity. For the purposes of this definition,
-  "control" means (i) the power, direct or indirect, to cause the
-  direction or management of such entity, whether by contract or
-  otherwise, or (ii) ownership of fifty percent (50%) or more of the
-  outstanding shares, or (iii) beneficial ownership of such entity.
-
-  "You" (or "Your") shall mean an individual or Legal Entity
-  exercising permissions granted by this License.
-
-  "Source" form shall mean the preferred form for making modifications,
-  including but not limited to software source code, documentation
-  source, and configuration files.
-
-  "Object" form shall mean any form resulting from mechanical
-  transformation or translation of a Source form, including but
-  not limited to compiled object code, generated documentation,
-  and conversions to other media types.
-
-  "Work" shall mean the work of authorship, whether in Source or
-  Object form, made available under the License, as indicated by a
-  copyright notice that is included in or attached to the work
-  (an example is provided in the Appendix below).
-
-  "Derivative Works" shall mean any work, whether in Source or Object
-  form, that is based on (or derived from) the Work and for which the
-  editorial revisions, annotations, elaborations, or other modifications
-  represent, as a whole, an original work of authorship. For the purposes
-  of this License, Derivative Works shall not include works that remain
-  separable from, or merely link (or bind by name) to the interfaces of,
-  the Work and Derivative Works thereof.
-
-  "Contribution" shall mean any work of authorship, including
-  the original version of the Work and any modifications or additions
-  to that Work or Derivative Works thereof, that is intentionally
-  submitted to Licensor for inclusion in the Work by the copyright owner
-  or by an individual or Legal Entity authorized to submit on behalf of
-  the copyright owner. For the purposes of this definition, "submitted"
-  means any form of electronic, verbal, or written communication sent
-  to the Licensor or its representatives, including but not limited to
-  communication on electronic mailing lists, source code control systems,
-  and issue tracking systems that are managed by, or on behalf of, the
-  Licensor for the purpose of discussing and improving the Work, but
-  excluding communication that is conspicuously marked or otherwise
-  designated in writing by the copyright owner as "Not a Contribution."
-
-  "Contributor" shall mean Licensor and any individual or Legal Entity
-  on behalf of whom a Contribution has been received by Licensor and
-  subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-  this License, each Contributor hereby grants to You a perpetual,
-  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-  copyright license to reproduce, prepare Derivative Works of,
-  publicly display, publicly perform, sublicense, and distribute the
-  Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-  this License, each Contributor hereby grants to You a perpetual,
-  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-  (except as stated in this section) patent license to make, have made,
-  use, offer to sell, sell, import, and otherwise transfer the Work,
-  where such license applies only to those patent claims licensable
-  by such Contributor that are necessarily infringed by their
-  Contribution(s) alone or by combination of their Contribution(s)
-  with the Work to which such Contribution(s) was submitted. If You
-  institute patent litigation against any entity (including a
-  cross-claim or counterclaim in a lawsuit) alleging that the Work
-  or a Contribution incorporated within the Work constitutes direct
-  or contributory patent infringement, then any patent licenses
-  granted to You under this License for that Work shall terminate
-  as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-  Work or Derivative Works thereof in any medium, with or without
-  modifications, and in Source or Object form, provided that You
-  meet the following conditions:
-
-  (a) You must give any other recipients of the Work or
-      Derivative Works a copy of this License; and
-
-  (b) You must cause any modified files to carry prominent notices
-      stating that You changed the files; and
-
-  (c) You must retain, in the Source form of any Derivative Works
-      that You distribute, all copyright, patent, trademark, and
-      attribution notices from the Source form of the Work,
-      excluding those notices that do not pertain to any part of
-      the Derivative Works; and
-
-  (d) If the Work includes a "NOTICE" text file as part of its
-      distribution, then any Derivative Works that You distribute must
-      include a readable copy of the attribution notices contained
-      within such NOTICE file, excluding those notices that do not
-      pertain to any part of the Derivative Works, in at least one
-      of the following places: within a NOTICE text file distributed
-      as part of the Derivative Works; within the Source form or
-      documentation, if provided along with the Derivative Works; or,
-      within a display generated by the Derivative Works, if and
-      wherever such third-party notices normally appear. The contents
-      of the NOTICE file are for informational purposes only and
-      do not modify the License. You may add Your own attribution
-      notices within Derivative Works that You distribute, alongside
-      or as an addendum to the NOTICE text from the Work, provided
-      that such additional attribution notices cannot be construed
-      as modifying the License.
-
-  You may add Your own copyright statement to Your modifications and
-  may provide additional or different license terms and conditions
-  for use, reproduction, or distribution of Your modifications, or
-  for any such Derivative Works as a whole, provided Your use,
-  reproduction, and distribution of the Work otherwise complies with
-  the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-  any Contribution intentionally submitted for inclusion in the Work
-  by You to the Licensor shall be under the terms and conditions of
-  this License, without any additional terms or conditions.
-  Notwithstanding the above, nothing herein shall supersede or modify
-  the terms of any separate license agreement you may have executed
-  with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-  names, trademarks, service marks, or product names of the Licensor,
-  except as required for reasonable and customary use in describing the
-  origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-  agreed to in writing, Licensor provides the Work (and each
-  Contributor provides its Contributions) on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-  implied, including, without limitation, any warranties or conditions
-  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-  PARTICULAR PURPOSE. You are solely responsible for determining the
-  appropriateness of using or redistributing the Work and assume any
-  risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-  whether in tort (including negligence), contract, or otherwise,
-  unless required by applicable law (such as deliberate and grossly
-  negligent acts) or agreed to in writing, shall any Contributor be
-  liable to You for damages, including any direct, indirect, special,
-  incidental, or consequential damages of any character arising as a
-  result of this License or out of the use or inability to use the
-  Work (including but not limited to damages for loss of goodwill,
-  work stoppage, computer failure or malfunction, or any and all
-  other commercial damages or losses), even if such Contributor
-  has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-  the Work or Derivative Works thereof, You may choose to offer,
-  and charge a fee for, acceptance of support, warranty, indemnity,
-  or other liability obligations and/or rights consistent with this
-  License. However, in accepting such obligations, You may act only
-  on Your own behalf and on Your sole responsibility, not on behalf
-  of any other Contributor, and only if You agree to indemnify,
-  defend, and hold each Contributor harmless for any liability
-  incurred by, or claims asserted against, such Contributor by reason
-  of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-  To apply the Apache License to your work, attach the following
-  boilerplate notice, with the fields enclosed by brackets "[]"
-  replaced with your own identifying information. (Don't include
-  the brackets!)  The text should be enclosed in the appropriate
-  comment syntax for the file format. We also recommend that a
-  file or class name and description of purpose be included on the
-  same "printed page" as the copyright notice for easier
-  identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

packages/db/README.md

@@ -1,24 +0,0 @@
-# @polkadot/db
-
-This is an implementation of a basic sync in-memory and on-disk database with overlays. Memory is currently used by polkadot-js/client
-
-## Usage
-
-Installation -
-
-```
-yarn add @polkadot/db
-```
-
-Classes can be imported as follows:
-
-```js
-// Default exports
-import DiskDb from '@polkadot/db/Disk';
-import MemoryDb from '@polkadot/db/Memory';
-import TransactionDb from '@polkadot/db/engines/TransactionDb';
-```
-
-## Utilities
-
-[Utilities](SUMMARY.md)

packages/db/src/Memory.ts

@@ -1,68 +0,0 @@
-// Copyright 2017-2019 @polkadot/db 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 MemoryDb from './engines/MemoryDb';
-import TransactionDb from './engines/TransactionDb';
-
-/**
- * @name MemoryDb
- * @summary Creates a MemoryDb database extending TransactionDb
- * @description Create an instance of a Memory database using
- * MemoryDb and extending TransactionDb.
- * `options` argument (optional) used to specifies whether
- * to use compression.
- * - Enable compression when storing "blocks" since they compress well.
- * - Disable compression when storing "state" Transactions Trie
- * using @polkadot/trie-db or @polkadot/db/src/engines/TransactionDb.ts
- * (potentially LevelDb or RocksDb implementation of a Merkle Patricia Trie)
- * data structure serialised with Recursive Length Prefix (RLP) encoding
- * @example
- * <BR>
- *
- * ```javascript
- * import stringToU8a from '@polkadot/util/string/toU8a';
- * import MemoryDb from '@polkadot/db/Memory';
- * import TransactionDb from '@polkadot/db/engines/TransactionDb';
- *
- * const memoryDb = new MemoryDb();
- * const txDb = new TransactionDb(memoryDb);
- *
- * // Open the memory database
- * memoryDb.open();
- *
- * // Declare key/value pair to allocate to store under a the key
- * const key = stringToU8a('key');
- * const value = stringToU8a('some value');
- *
- * // Store key/value pair in memory db
- * memoryDb.put(key, value);
- *
- * // Retrieve value for key from memory db
- * valueRetrieved = memoryDb.get(key);
- *
- * // Delete key/value pair from memory db
- * memoryDb.del(key);
- *
- * // Transaction to Store key/value pair in transaction db
- * const isTxSuccess = txDb.transaction((): void => {
- *   txDb.put(key, value);
- *
- *   // Boolean to indicate whether transaction was successful or not
- *   return true;
- * });
- *
- * console.log(`Transaction successful?: ${isTxSuccess}`);
- *
- * // Retrieve transaction value from memory db
- * console.log(`Transfered value: ${memoryDb.get(key)}`);
- *
- * // Close the memory database
- * memoryDb.close();
- * ```
- */
-export default class Memory extends TransactionDb {
-  public constructor () {
-    super(new MemoryDb());
-  }
-}

packages/db/src/engines/LruDb.spec.ts

@@ -1,63 +0,0 @@
-// Copyright 2017-2019 @polkadot/db 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 toU8a from '@polkadot/util/u8a/toU8a';
-
-import LruDb from './LruDb';
-import MemoryDb from './MemoryDb';
-
-describe('LruDb', (): void => {
-  const memory = new MemoryDb();
-  const db = new LruDb(memory);
-
-  it('retrieves an item from the backing when not available (caching it)', (): void => {
-    const key = toU8a('test1');
-    const value = toU8a('value1');
-
-    memory.put(key, value);
-
-    expect(db.get(key)).toEqual(value);
-    expect(db._getLru(key)).toEqual({ value });
-  });
-
-  it('replaces an item (caching and backing)', (): void => {
-    const key = toU8a('test1');
-    const value = toU8a('test');
-
-    db.put(key, value);
-
-    expect(db.get(key)).toEqual(value);
-    expect(memory.get(key)).toEqual(value);
-    expect(db._getLru(key)).toEqual({ value });
-  });
-
-  it('retrieves item from LRU when available', (): void => {
-    const key = toU8a('test1');
-    const value = toU8a('test');
-
-    memory.del(key);
-
-    expect(db.get(key)).toEqual(value);
-  });
-
-  it('puts item both in LRU and backing', (): void => {
-    const key = toU8a('test0');
-    const value = toU8a('value0');
-
-    db.put(key, value);
-
-    expect(memory.get(key)).toEqual(value);
-    expect(db._getLru(key)).toEqual({ value });
-  });
-
-  it('deletes an item from both backing and db', (): void => {
-    const key = toU8a('test0');
-
-    db.del(key);
-
-    expect(memory.get(key)).toEqual(null);
-    expect(db._getLru(key)).toEqual({ value: null });
-    expect(db.get(key)).toEqual(null);
-  });
-});

packages/db/src/engines/LruDb.ts

@@ -1,116 +0,0 @@
-// Copyright 2017-2019 @polkadot/db 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 { BaseDb, ProgressCb } from '../types';
-
-import { LRUMap } from 'lru_map';
-import { logger } from '@polkadot/util';
-
-interface CachedValue {
-  value: Uint8Array | null;
-}
-
-const DEFAULT_ITEM_COUNT = 4096;
-
-const l = logger('db/lru');
-
-export default class LruDb implements BaseDb {
-  private backing: BaseDb;
-
-  private lru: LRUMap<string, CachedValue>;
-
-  public constructor (backing: BaseDb, itemCount: number = DEFAULT_ITEM_COUNT) {
-    this.backing = backing;
-    this.lru = new LRUMap(itemCount);
-  }
-
-  public close (): void {
-    l.debug((): string[] => ['close']);
-
-    this.lru.clear();
-    this.backing.close();
-  }
-
-  public open (): void {
-    l.debug((): string[] => ['open']);
-
-    this.lru.clear();
-    this.backing.open();
-  }
-
-  public drop (): void {
-    this.backing.drop();
-  }
-
-  public empty (): void {
-    l.debug((): string[] => ['empty']);
-
-    this.lru.clear();
-    this.backing.empty();
-  }
-
-  public rename (base: string, file: string): void {
-    this.backing.rename(base, file);
-  }
-
-  public maintain (fn: ProgressCb): void {
-    this.backing.maintain(fn);
-  }
-
-  public size (): number {
-    return this.backing.size();
-  }
-
-  public del (key: Uint8Array): void {
-    const keyStr = key.toString();
-
-    this.backing.del(key);
-    this.lru.set(keyStr, { value: null });
-  }
-
-  public get (key: Uint8Array): Uint8Array | null {
-    const keyStr = key.toString();
-    const cached = this.lru.get(keyStr);
-
-    if (cached) {
-      return cached.value;
-    }
-
-    const value = this.backing.get(key);
-
-    this.lru.set(keyStr, { value });
-
-    return value;
-  }
-
-  // Convenience methods used in tests
-  public _getLru (key: Uint8Array): CachedValue | undefined {
-    return this.lru.get(key.toString());
-  }
-
-  public put (key: Uint8Array, value: Uint8Array): void {
-    const keyStr = key.toString();
-
-    this.backing.put(key, value);
-    this.lru.set(keyStr, { value });
-  }
-
-  public txCommit (): void {
-    if (this.backing.txCommit) {
-      this.backing.txCommit();
-    }
-  }
-
-  public txRevert (): void {
-    if (this.backing.txRevert) {
-      this.backing.txRevert();
-    }
-  }
-
-  public txStart (): void {
-    if (this.backing.txStart) {
-      this.backing.txStart();
-    }
-  }
-}

packages/db/src/engines/MemoryDb.spec.ts

@@ -1,27 +0,0 @@
-// Copyright 2017-2019 @polkadot/db 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 MemoryDb from './MemoryDb';
-
-describe('MemoryDb', (): void => {
-  const memory = new MemoryDb();
-
-  it('gets the combioned size of the entry values', (): void => {
-    memory.put(new Uint8Array([1]), new Uint8Array([1, 2, 3]));
-    memory.put(new Uint8Array([2]), new Uint8Array([1, 2, 3]));
-    memory.put(new Uint8Array([3]), new Uint8Array([1, 2, 3]));
-
-    expect(memory.size()).toEqual(9);
-  });
-
-  it('does not throw on the stubs', (done): void => {
-    memory.close();
-    memory.open();
-    memory.drop();
-    memory.empty();
-    memory.rename('foo', 'bar');
-
-    memory.maintain((): void => done());
-  });
-});

packages/db/src/engines/MemoryDb.ts

@@ -1,70 +0,0 @@
-// Copyright 2017-2019 @polkadot/db 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 { BaseDb, ProgressCb } from '../types';
-
-import { logger } from '@polkadot/util';
-
-const l = logger('db/memory');
-
-export default class MemoryDb implements BaseDb {
-  private _storage: Map<string, Uint8Array> = new Map();
-
-  public close (): void {
-    this.empty();
-  }
-
-  public open (): void {
-    this.empty();
-  }
-
-  public drop (): void {
-    this.empty();
-  }
-
-  public empty (): void {
-    this._storage.clear();
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  public rename (base: string, file: string): void {
-    l.warn('rename() is not implemented');
-  }
-
-  public maintain (fn: ProgressCb): void {
-    fn({
-      isCompleted: true,
-      keys: this._storage.size,
-      percent: 100
-    });
-  }
-
-  public size (): number {
-    let size = 0;
-
-    this._storage.forEach((value): void => {
-      size += value.length;
-    });
-
-    return size;
-  }
-
-  public del (key: Uint8Array): void {
-    // l.debug(() => ['del', { key }]);
-
-    this._storage.delete(key.toString());
-  }
-
-  public get (key: Uint8Array): Uint8Array | null {
-    // l.debug(() => ['get', { key }]);
-
-    return this._storage.get(key.toString()) || null;
-  }
-
-  public put (key: Uint8Array, value: Uint8Array): void {
-    // l.debug(() => ['put', { key, value }]);
-
-    this._storage.set(key.toString(), value);
-  }
-}

packages/db/src/engines/TransactionDb.spec.ts

@@ -1,93 +0,0 @@
-// Copyright 2017-2019 @polkadot/db 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 toU8a from '@polkadot/util/string/toU8a';
-
-import MemoryDb from './MemoryDb';
-import TransactionDb from './TransactionDb';
-
-describe('TransactionDb', (): void => {
-  const memory = new MemoryDb();
-  const db = new TransactionDb(memory);
-
-  it('passed through values immediately when not in transaction', (): void => {
-    const key = toU8a('test0');
-    const value = toU8a('value0');
-
-    db.put(key, value);
-
-    expect(memory.get(key)).toEqual(value);
-  });
-
-  it('commits when transaction passes (result = true, put)', (): void => {
-    const key = toU8a('test1');
-    const value = toU8a('value1');
-
-    expect(
-      db.transaction((): boolean => {
-        db.put(key, value);
-
-        return true;
-      })
-    ).toEqual(true);
-    expect(memory.get(key)).toEqual(value);
-  });
-
-  it('commits when transaction passes (result = true, del)', (): void => {
-    const key = toU8a('test0');
-
-    expect(
-      db.transaction((): boolean => {
-        db.del(key);
-
-        return true;
-      })
-    ).toEqual(true);
-    expect(memory.get(key)).toEqual(null);
-  });
-
-  it('does not commit when transaction fails (result = false)', (): void => {
-    const key = toU8a('test2');
-    const value = toU8a('value2');
-
-    expect(
-      db.transaction((): boolean => {
-        db.put(key, value);
-
-        return false;
-      })
-    ).toEqual(false);
-    expect(memory.get(key)).toEqual(null);
-  });
-
-  it('does not commit when transaction throws', (): void => {
-    const key = toU8a('test2');
-    const value = toU8a('value2');
-
-    expect(
-      (): void => {
-        db.transaction((): void => {
-          db.put(key, value);
-
-          throw new Error('test');
-        });
-      }
-    ).toThrow(/test/);
-    expect(memory.get(key)).toEqual(null);
-  });
-
-  it('inside the transaction, the value is set', (): void => {
-    const key = toU8a('test2');
-    const value = toU8a('value2');
-
-    db.transaction((): boolean => {
-      db.put(key, value);
-
-      expect(db.get(key)).toEqual(value);
-
-      return false;
-    });
-    expect(memory.get(key)).toEqual(null);
-  });
-});

packages/db/src/engines/TransactionDb.ts

@@ -1,157 +0,0 @@
-// Copyright 2017-2019 @polkadot/db 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 { BaseDb, TxDb, ProgressCb } from '../types';
-
-import { assert, isNull, logger } from '@polkadot/util';
-
-interface OverlayItem {
-  key: Uint8Array;
-  value: Uint8Array | null;
-}
-
-const l = logger('db/transact');
-
-export default class TransactionDb implements TxDb {
-  private backing: BaseDb;
-
-  private txOverlay: Map<string, OverlayItem> = new Map();
-
-  private txStarted: boolean;
-
-  public constructor (backing: BaseDb) {
-    this.backing = backing;
-    this.txStarted = false;
-  }
-
-  public transaction<T> (fn: () => T): T {
-    l.debug((): string[] => ['transaction']);
-
-    try {
-      this.createTx();
-
-      const result = fn();
-
-      if (result) {
-        this.commitTx();
-      } else {
-        this.revertTx();
-      }
-
-      return result;
-    } catch (error) {
-      this.revertTx();
-
-      throw error;
-    }
-  }
-
-  public close (): void {
-    this.backing.close();
-  }
-
-  public open (): void {
-    this.backing.open();
-  }
-
-  public drop (): void {
-    this.backing.drop();
-  }
-
-  public empty (): void {
-    this.backing.empty();
-  }
-
-  public rename (base: string, file: string): void {
-    this.backing.rename(base, file);
-  }
-
-  public maintain (fn: ProgressCb): void {
-    assert(this.txStarted === false, 'Cannot maintain inside an open transaction');
-
-    this.backing.maintain(fn);
-  }
-
-  public size (): number {
-    return this.backing.size();
-  }
-
-  public del (key: Uint8Array): void {
-    if (this.txStarted) {
-      this.txOverlay.set(key.toString(), { key, value: null });
-      return;
-    }
-
-    this.backing.del(key);
-  }
-
-  public get (key: Uint8Array): Uint8Array | null {
-    // l.debug(() => ['get', u8aToHex(key)]);
-
-    if (this.txStarted) {
-      const value = this.txOverlay.get(key.toString());
-
-      if (value) {
-        return value.value;
-      }
-    }
-
-    return this.backing.get(key);
-  }
-
-  public put (key: Uint8Array, value: Uint8Array): void {
-    // l.debug(() => ['put', u8aToHex(key), u8aToHex(value)]);
-
-    if (this.txStarted) {
-      this.txOverlay.set(key.toString(), { key, value });
-
-      return;
-    }
-
-    return this.backing.put(key, value);
-  }
-
-  private createTx (): void {
-    l.debug((): string[] => ['createTx']);
-
-    assert(!this.txStarted, 'Cannot create a transaction when one is already active');
-
-    this.txOverlay.clear();
-    this.txStarted = true;
-  }
-
-  private commitTx (): void {
-    l.debug((): [string, number, string] => ['commitTx', Object.keys(this.txOverlay).length, 'keys']);
-
-    assert(this.txStarted, 'Cannot commit when not in transaction');
-
-    if (this.backing.txStart) {
-      this.backing.txStart();
-    }
-
-    this.txOverlay.forEach(({ key, value }): void => {
-      if (isNull(value)) {
-        this.backing.del(key);
-      } else {
-        this.backing.put(key, value);
-      }
-    });
-
-    if (this.backing.txCommit) {
-      this.backing.txCommit();
-    }
-
-    this.txOverlay.clear();
-    this.txStarted = false;
-  }
-
-  private revertTx (): void {
-    l.debug((): string[] => ['revertTx']);
-
-    assert(this.txStarted, 'Cannot revert when not in transaction');
-
-    this.txOverlay.clear();
-    this.txStarted = false;
-  }
-}

packages/db/src/types.ts

@@ -1,39 +0,0 @@
-// Copyright 2017-2019 @polkadot/db 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 interface ProgressValue {
-  isCompleted?: boolean;
-  keys: number;
-  percent: number;
-}
-
-export type ProgressCb = (progress: ProgressValue) => void;
-
-export interface BaseDbOptions {
-  isCompressed?: boolean;
-  isLru?: boolean;
-  isNative?: boolean;
-}
-
-export interface BaseDb {
-  close (): void;
-  open (): void;
-  drop (): void;
-  empty (): void;
-  maintain (fn: ProgressCb): void;
-  rename (base: string, file: string): void;
-  size (): number;
-
-  txCommit?: () => void;
-  txRevert?: () => void;
-  txStart?: () => void;
-
-  del (key: Uint8Array): void;
-  get (key: Uint8Array): Uint8Array | null;
-  put (key: Uint8Array, value: Uint8Array): void;
-}
-
-export interface TxDb extends BaseDb {
-  transaction <T> (fn: () => T): T;
-}

packages/keyring/README.md

@@ -15,7 +15,3 @@ Classes and Functions can be imported as follows:
 ```js
 import Keyring from '@polkadot/keyring';
 ```
-
-## Utilities
-
-[Utilities](SUMMARY.md)

packages/keyring/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@polkadot/keyring",
-  "version": "1.3.1",
+  "version": "3.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.5.5",
-    "@polkadot/util": "^1.3.1",
-    "@polkadot/util-crypto": "^1.3.1"
+    "@babel/runtime": "^7.12.1",
+    "@polkadot/util": "^3.7.1",
+    "@polkadot/util-crypto": "^3.7.1"
   }
 }

packages/keyring/src/defaults.ts

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 // default substrate dev phrase
 const DEV_PHRASE = 'bottom drive obey lake curtain smoke basket hold race lonely fit walk';

packages/keyring/src/index.spec.ts

@@ -1,9 +1,8 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { hexToU8a, stringToU8a } from '@polkadot/util';
-import { cryptoWaitReady, setAddressPrefix } from '@polkadot/util-crypto';
+import { cryptoWaitReady, setSS58Format, encodeAddress } from '@polkadot/util-crypto';
 
 import Keyring from '.';
 
@@ -17,53 +16,61 @@ describe('keypair', (): void => {
     const publicKeyTwo = new Uint8Array([215, 90, 152, 1, 130, 177, 10, 183, 213, 75, 254, 211, 201, 100, 7, 58, 14, 225, 114, 243, 218, 166, 35, 37, 175, 2, 26, 104, 247, 7, 81, 26]);
     const seedOne = stringToU8a('12345678901234567890123456789012');
     const seedTwo = hexToU8a('0x9d61b19deffd5a60ba844af492ec2cc44449c5697b326919703bac031cae7f60');
-    let keypair: Keyring;
+    let keyring: Keyring;
 
     beforeEach((): void => {
-      keypair = new Keyring({ type: 'ed25519' });
+      keyring = new Keyring({ ss58Format: 42, type: 'ed25519' });
 
-      keypair.addFromSeed(seedOne, {});
+      keyring.addFromSeed(seedOne, {});
     });
 
     it('adds the pair', (): void => {
       expect(
-        keypair.addFromSeed(seedTwo, {}).publicKey
+        keyring.addFromSeed(seedTwo, {}).publicKey
       ).toEqual(publicKeyTwo);
     });
 
+    it('creates via a dev seed', (): void => {
+      expect(
+        keyring.addFromUri('//Alice').address
+      ).toEqual('5FA9nQDVg267DEd8m1ZypXLBnvN7SFxYwV7ndqSYGiN9TTpu');
+    });
+
     it('creates a ed25519 pair via mnemonicToSeed', (): void => {
       expect(
-        keypair.addFromUri(
+        keyring.addFromUri(
           'seed sock milk update focus rotate barely fade car face mechanic mercy'
         ).address
       ).toEqual('5DkQP32jP4DVJLWWBRBoZF2tpWjqFrcrTBo6H5NcSk7MxKCC');
     });
 
-    it('adds from a mnemonic', (): void => {
-      setAddressPrefix(68);
+    it('adds from a mnemonic, with correct ss58', (): void => {
+      setSS58Format(20); // this would not be used
+      keyring.setSS58Format(68); // this would be used
 
-      expect(
-        keypair.addFromMnemonic('moral movie very draw assault whisper awful rebuild speed purity repeat card', {}).address
-      ).toEqual('7sPsxWPE5DzAyPT3VuoJYw5NTGscx9QYN9oddQx4kALKC3hH');
+      const pair = keyring.addFromMnemonic('moral movie very draw assault whisper awful rebuild speed purity repeat card', {});
+
+      expect(pair.address).toEqual('7sPsxWPE5DzAyPT3VuoJYw5NTGscx9QYN9oddQx4kALKC3hH');
+      expect(encodeAddress(pair.publicKey)).toEqual('35cDYtPsdG1HUa2n2MaARgJyRz1WKMBZK1DL6c5cX7nugQh1');
     });
 
     it('allows publicKeys retrieval', (): void => {
-      keypair.addFromSeed(seedTwo, {});
+      keyring.addFromSeed(seedTwo, {});
 
       expect(
-        keypair.getPublicKeys()
+        keyring.getPublicKeys()
       ).toEqual([publicKeyOne, publicKeyTwo]);
     });
 
     it('allows retrieval of a specific item', (): void => {
       expect(
-        keypair.getPair(publicKeyOne).publicKey
+        keyring.getPair(publicKeyOne).publicKey
       ).toEqual(publicKeyOne);
     });
 
     it('allows adding from JSON', (): void => {
       expect(
-        keypair.addFromJson(
+        keyring.addFromJson(
           JSON.parse('{"address":"5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua","encoded":"0xb4a14995d25ab609f3686e9fa45f1fb237cd833f33f00d4b12c51858ca070d96972e47d73aae5eeb0fc06f923826cf0943fdb02c2c2ee30ef52a7912663053940d1da4da66b3a3f520ae07422c1c94b2d95690fca9d1f4a997623bb2923a8833280e19e7f72c3c5cfa343974e60e2b3dc53b404fdaf330756daad5e4e3","encoding":{"content":"pkcs8","type":"xsalsa20-poly1305","version":"0"},"meta":{"isTesting":true,"name":"alice"}}')
         ).publicKey
       ).toEqual(
@@ -73,10 +80,20 @@ describe('keypair', (): void => {
 
     it('signs and verifies', (): void => {
       const MESSAGE = stringToU8a('this is a message');
-      const pair = keypair.getPair(publicKeyOne);
+      const pair = keyring.getPair(publicKeyOne);
       const signature = pair.sign(MESSAGE);
 
       expect(pair.verify(MESSAGE, signature)).toBe(true);
+      expect(pair.verify(new Uint8Array(), signature)).toBe(false);
+    });
+
+    it('signs and verifies (withType)', (): void => {
+      const MESSAGE = stringToU8a('this is a message');
+      const pair = keyring.getPair(publicKeyOne);
+      const signature = pair.sign(MESSAGE, { withType: true });
+
+      expect(pair.verify(MESSAGE, signature)).toBe(true);
+      expect(pair.verify(new Uint8Array(), signature)).toBe(false);
     });
   });
 
@@ -85,51 +102,51 @@ describe('keypair', (): void => {
     const publicKeyTwo = hexToU8a('0x44a996beb1eef7bdcab976ab6d2ca26104834164ecf28fb375600576fcc6eb0f');
     const seedOne = stringToU8a('12345678901234567890123456789012');
     const seedTwo = hexToU8a('0x9d61b19deffd5a60ba844af492ec2cc44449c5697b326919703bac031cae7f60');
-    let keypair: Keyring;
+    let keyring: Keyring;
 
     beforeEach((): void => {
-      keypair = new Keyring({ type: 'sr25519' });
+      keyring = new Keyring({ ss58Format: 42, type: 'sr25519' });
 
-      keypair.addFromSeed(seedOne, {});
+      keyring.addFromSeed(seedOne, {});
     });
 
     it('creates with dev phrase when only path specified', (): void => {
       expect(
-        keypair.createFromUri('//Alice').address
+        keyring.createFromUri('//Alice').address
       ).toEqual('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY');
     });
 
     it('adds the pair', (): void => {
       expect(
-        keypair.addFromSeed(seedTwo, {}).publicKey
+        keyring.addFromSeed(seedTwo, {}).publicKey
       ).toEqual(publicKeyTwo);
     });
 
     it('adds from a mnemonic', (): void => {
-      setAddressPrefix(68);
+      keyring.setSS58Format(68);
 
       expect(
-        keypair.addFromMnemonic('moral movie very draw assault whisper awful rebuild speed purity repeat card', {}).address
+        keyring.addFromMnemonic('moral movie very draw assault whisper awful rebuild speed purity repeat card', {}).address
       ).toEqual('7qQGarA4PWjPPVHG4USn1yuuVZvEHN7XZz8o7EbAp48jayZQ');
     });
 
     it('allows publicKeys retrieval', (): void => {
-      keypair.addFromSeed(seedTwo, {});
+      keyring.addFromSeed(seedTwo, {});
 
       expect(
-        keypair.getPublicKeys()
+        keyring.getPublicKeys()
       ).toEqual([publicKeyOne, publicKeyTwo]);
     });
 
     it('allows retrieval of a specific item', (): void => {
       expect(
-        keypair.getPair(publicKeyOne).publicKey
+        keyring.getPair(publicKeyOne).publicKey
       ).toEqual(publicKeyOne);
     });
 
     it('allows adding from JSON', (): void => {
       expect(
-        keypair.addFromJson(
+        keyring.addFromJson(
           JSON.parse('{"address":"5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua","encoded":"0xb4a14995d25ab609f3686e9fa45f1fb237cd833f33f00d4b12c51858ca070d96972e47d73aae5eeb0fc06f923826cf0943fdb02c2c2ee30ef52a7912663053940d1da4da66b3a3f520ae07422c1c94b2d95690fca9d1f4a997623bb2923a8833280e19e7f72c3c5cfa343974e60e2b3dc53b404fdaf330756daad5e4e3","encoding":{"content":"pkcs8","type":"xsalsa20-poly1305","version":"0"},"meta":{"isTesting":true,"name":"alice"}}')
         ).publicKey
       ).toEqual(
@@ -139,10 +156,283 @@ describe('keypair', (): void => {
 
     it('signs and verifies', (): void => {
       const MESSAGE = stringToU8a('this is a message');
-      const pair = keypair.getPair(publicKeyOne);
+      const pair = keyring.getPair(publicKeyOne);
       const signature = pair.sign(MESSAGE);
 
       expect(pair.verify(MESSAGE, signature)).toBe(true);
+      expect(pair.verify(new Uint8Array(), signature)).toBe(false);
+    });
+
+    it('signs and verifies (withType)', (): void => {
+      const MESSAGE = stringToU8a('this is a message');
+      const pair = keyring.getPair(publicKeyOne);
+      const signature = pair.sign(MESSAGE, { withType: true });
+
+      expect(pair.verify(MESSAGE, signature)).toBe(true);
+      expect(pair.verify(new Uint8Array(), signature)).toBe(false);
+    });
+  });
+
+  describe('ecdsa', (): void => {
+    const seedOne = 'potato act energy ahead stone taxi receive fame gossip equip chest round';
+    const seedTwo = hexToU8a('0x3c74be003bd9a876be439949ccf2b292bd966c94959a689173b295b326cd6da7');
+    const publicKeyOne = hexToU8a('0x02c6b6c664db5ef505477bba1cf2f1789c98796b9bb5fa21abd0ac4589bed980e7');
+    const publicKeyTwo = hexToU8a('0x021da683b913fb28c979ba3e5f1881415cef4b1f58a5d05ed3610a2995e7b4943c');
+    const addressKeyOne = hexToU8a('0x0cfd0dd2c59a9987b9848919163931b6a42283ffd3d91e92c98b522525a7038f');
+    let keyring: Keyring;
+
+    beforeEach((): void => {
+      keyring = new Keyring({ ss58Format: 42, type: 'ecdsa' });
+
+      keyring.addFromMnemonic(seedOne, {});
+    });
+
+    it('creates with dev phrase when only path specified', (): void => {
+      expect(
+        keyring.createFromUri('//Alice').address
+      ).toEqual('5C7C2Z5sWbytvHpuLTvzKunnnRwQxft1jiqrLD5rhucQ5S9X');
+    });
+
+    it('adds the pair', (): void => {
+      expect(
+        keyring.addFromSeed(seedTwo, {}).publicKey
+      ).toEqual(publicKeyTwo);
+    });
+
+    it('adds from a mnemonic', (): void => {
+      keyring.setSS58Format(68);
+
+      expect(
+        keyring.addFromMnemonic('moral movie very draw assault whisper awful rebuild speed purity repeat card').address
+      ).toEqual('7ooxHV3mz4nnWbK8v7Mxcb71QMpof268eL1A2VrYWUNWJk8P');
+    });
+
+    it('allows publicKeys retrieval', (): void => {
+      keyring.addFromSeed(seedTwo, {});
+
+      expect(
+        keyring.getPublicKeys()
+      ).toEqual([publicKeyOne, publicKeyTwo]);
+    });
+
+    it('allows retrieval of a specific item', (): void => {
+      expect(
+        keyring.getPair(addressKeyOne).publicKey
+      ).toEqual(publicKeyOne);
+    });
+
+    it('allows adding from JSON', (): void => {
+      expect(
+        keyring.addFromJson(
+          JSON.parse('{"address":"5DzMsaYFhmpRdErWrP6K6PD7UXzYoeETToSBUrZSvxasqWRz","encoded":"0xa192d39b42bc1601bf61df31039a554228593fadf870bc837b658a5114627aca199fff596260c95fe8994c66a47636cf0270aa08f402ba5541038753960d00e6c3af5e239ec58fb1eef3db7d6bc266f4853bdfe4ed17122d9092d879014d53980d2ee57f6f55a88c38836447d8645008e8815379626addc8f81f80cd49a2","encoding":{"content":"pkcs8","type":"xsalsa20-poly1305","version":"2"},"meta":{}}')
+        ).address
+      ).toEqual('5DzMsaYFhmpRdErWrP6K6PD7UXzYoeETToSBUrZSvxasqWRz');
+    });
+
+    it('allows creation from JSON', (): void => {
+      keyring.setSS58Format(2);
+      const pair = keyring.createFromJson(
+        JSON.parse('{"address":"0x02fde629668eb2bcc7d748f40a7e597f7c7b363498ff3db31f03ce4854937883ad","encoded":"qIhAhKqtf2iyEoWEr8nmBdksSI8EHHCpgJHToqd6Pl8AgAAAAQAAAAgAAADDZ//fj/BRRj+0+bl1KAlYgoPJp6nEUwiw0fVqO2BW4mjEgQ+iWwJEgDf1JUtecbzOlfhTXBzqX/dIYzLgUADrF4EFEPpboCWiU1iN7W/3DM1cOTRVvTGcbdIqW//z3axhz961qzeJVUIFgllwGe/euLUPIlKbIkiN/CsRYdQ=","encoding":{"content":["pkcs8","ecdsa"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{"genesisHash":"0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe","name":"ecdsa","tags":[],"whenCreated":1600925898271}}')
+      );
+
+      expect(pair.address).toEqual('DHL8HKFuTTR55JzzLmkJRCAfPBbuevKaT9cXikxbEV97Ko8');
+      expect(pair.publicKey).toEqual(hexToU8a('0x02fde629668eb2bcc7d748f40a7e597f7c7b363498ff3db31f03ce4854937883ad'));
+    });
+
+    it('fails toJson() when password is incorrect', (): void => {
+      const pair = keyring.createFromJson(
+        JSON.parse('{"address":"0x02fde629668eb2bcc7d748f40a7e597f7c7b363498ff3db31f03ce4854937883ad","encoded":"qIhAhKqtf2iyEoWEr8nmBdksSI8EHHCpgJHToqd6Pl8AgAAAAQAAAAgAAADDZ//fj/BRRj+0+bl1KAlYgoPJp6nEUwiw0fVqO2BW4mjEgQ+iWwJEgDf1JUtecbzOlfhTXBzqX/dIYzLgUADrF4EFEPpboCWiU1iN7W/3DM1cOTRVvTGcbdIqW//z3axhz961qzeJVUIFgllwGe/euLUPIlKbIkiN/CsRYdQ=","encoding":{"content":["pkcs8","ecdsa"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{"genesisHash":"0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe","name":"ecdsa","tags":[],"whenCreated":1600925898271}}')
+      );
+
+      expect(
+        () => pair.toJson('invalid')
+      ).toThrow(/Unable to decode using the supplied passphrase/);
+    });
+
+    it('pass toJson() when password is correct', (): void => {
+      const pair = keyring.createFromJson(
+        JSON.parse('{"address":"0x02fde629668eb2bcc7d748f40a7e597f7c7b363498ff3db31f03ce4854937883ad","encoded":"qIhAhKqtf2iyEoWEr8nmBdksSI8EHHCpgJHToqd6Pl8AgAAAAQAAAAgAAADDZ//fj/BRRj+0+bl1KAlYgoPJp6nEUwiw0fVqO2BW4mjEgQ+iWwJEgDf1JUtecbzOlfhTXBzqX/dIYzLgUADrF4EFEPpboCWiU1iN7W/3DM1cOTRVvTGcbdIqW//z3axhz961qzeJVUIFgllwGe/euLUPIlKbIkiN/CsRYdQ=","encoding":{"content":["pkcs8","ecdsa"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{"genesisHash":"0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe","name":"ecdsa","tags":[],"whenCreated":1600925898271}}')
+      );
+
+      expect(
+        () => pair.toJson('testing')
+      ).not.toThrow();
+    });
+
+    it('signs and verifies', (): void => {
+      const MESSAGE = stringToU8a('this is a message');
+      const pair = keyring.getPair(addressKeyOne);
+      const signature = pair.sign(MESSAGE);
+
+      expect(pair.verify(MESSAGE, signature)).toBe(true);
+      expect(pair.verify(new Uint8Array(), signature)).toBe(false);
+    });
+
+    it('signs and verifies (withType)', (): void => {
+      const MESSAGE = stringToU8a('this is a message');
+      const pair = keyring.getPair(addressKeyOne);
+      const signature = pair.sign(MESSAGE, { withType: true });
+
+      expect(pair.verify(MESSAGE, signature)).toBe(true);
+      expect(pair.verify(new Uint8Array(), signature)).toBe(false);
+    });
+  });
+
+  describe('ethereum', (): void => {
+    const PHRASE = 'seed sock milk update focus rotate barely fade car face mechanic mercy';
+    let keyring: Keyring;
+
+    beforeEach((): void => {
+      keyring = new Keyring({ type: 'ethereum' });
+    });
+
+    it('adds a pair with the correct address', (): void => {
+      const pair = keyring.createFromUri(PHRASE);
+
+      expect(pair.publicKey).toEqual(hexToU8a('0x03b9dc646dd71118e5f7fda681ad9eca36eb3ee96f344f582fbe7b5bcdebb13077'));
+      expect(pair.address).toEqual('0x4119b2e6c3Cb618F4f0B93ac77f9BeeC7FF02887');
+    });
+
+    it('encodes a pair toJSON', (): void => {
+      const pair = keyring.createFromUri(PHRASE);
+      const json = pair.toJson('password');
+
+      expect(json.address).toEqual('0x03b9dc646dd71118e5f7fda681ad9eca36eb3ee96f344f582fbe7b5bcdebb13077');
+      expect(json.encoding).toEqual({
+        content: ['pkcs8', 'ethereum'],
+        type: ['scrypt', 'xsalsa20-poly1305'],
+        version: '3'
+      });
+    });
+
+    it('allows adding from JSON', (): void => {
+      const pair = keyring.addFromJson(
+        JSON.parse('{"address":"KWCv1L3QX9LDPwY4VzvLmarEmXjVJidUzZcinvVnmxAJJCBou","encoded":"U8qFEaghhmNV2PgFhjqzmhyUy37Ok7abfFU2MNsBd0sAgAAAAQAAAAgAAAA3+NniKogzNphiMNueB1X0sGA07B6CaXWfpXPx45iSXoTTprwzU5mOoSqUWO0GKHROI72LN+uJ8Yfv6Ll6JOOV3VPKfoVoFmYm+zDrrMPa0gk5E5kUuSijxADcE6zUrliPVr0Ix/qaghu5SJ7RtWDQLBf4Hp86SJ8Gg6gTSSk=","encoding":{"content":["pkcs8","ethereum"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{}}')
+      );
+
+      expect(pair.publicKey).toEqual(hexToU8a('0x03b9dc646dd71118e5f7fda681ad9eca36eb3ee96f344f582fbe7b5bcdebb13077'));
+      expect(pair.address).toEqual('0x4119b2e6c3Cb618F4f0B93ac77f9BeeC7FF02887');
+
+      pair.decodePkcs8('password');
+
+      expect(pair.isLocked).toBe(false);
+      expect(pair.publicKey).toEqual(hexToU8a('0x03b9dc646dd71118e5f7fda681ad9eca36eb3ee96f344f582fbe7b5bcdebb13077'));
+      expect(pair.address).toBe('0x4119b2e6c3Cb618F4f0B93ac77f9BeeC7FF02887');
+    });
+
+    it('allows for signing/verification', (): void => {
+      const MESSAGE = stringToU8a('just some test message');
+      const signer = keyring.createFromUri(PHRASE);
+      const verifier = keyring.addFromJson(
+        JSON.parse('{"address":"KWCv1L3QX9LDPwY4VzvLmarEmXjVJidUzZcinvVnmxAJJCBou","encoded":"U8qFEaghhmNV2PgFhjqzmhyUy37Ok7abfFU2MNsBd0sAgAAAAQAAAAgAAAA3+NniKogzNphiMNueB1X0sGA07B6CaXWfpXPx45iSXoTTprwzU5mOoSqUWO0GKHROI72LN+uJ8Yfv6Ll6JOOV3VPKfoVoFmYm+zDrrMPa0gk5E5kUuSijxADcE6zUrliPVr0Ix/qaghu5SJ7RtWDQLBf4Hp86SJ8Gg6gTSSk=","encoding":{"content":["pkcs8","ethereum"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{}}')
+      );
+
+      const signature = signer.sign(MESSAGE);
+
+      expect(verifier.verify(MESSAGE, signature)).toBe(true);
+      expect(verifier.verify(new Uint8Array(), signature)).toBe(false);
+    });
+
+    it('allows for signing/verification (withType)', (): void => {
+      const MESSAGE = stringToU8a('just some test message');
+      const signer = keyring.createFromUri(PHRASE);
+      const verifier = keyring.addFromJson(
+        JSON.parse('{"address":"KWCv1L3QX9LDPwY4VzvLmarEmXjVJidUzZcinvVnmxAJJCBou","encoded":"U8qFEaghhmNV2PgFhjqzmhyUy37Ok7abfFU2MNsBd0sAgAAAAQAAAAgAAAA3+NniKogzNphiMNueB1X0sGA07B6CaXWfpXPx45iSXoTTprwzU5mOoSqUWO0GKHROI72LN+uJ8Yfv6Ll6JOOV3VPKfoVoFmYm+zDrrMPa0gk5E5kUuSijxADcE6zUrliPVr0Ix/qaghu5SJ7RtWDQLBf4Hp86SJ8Gg6gTSSk=","encoding":{"content":["pkcs8","ethereum"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{}}')
+      );
+
+      const signature = signer.sign(MESSAGE, { withType: true });
+
+      expect(verifier.verify(MESSAGE, signature)).toBe(true);
+      expect(verifier.verify(new Uint8Array(), signature)).toBe(false);
+    });
+  });
+
+  describe('util', (): void => {
+    let keyring: Keyring;
+
+    beforeEach((): void => {
+      keyring = new Keyring({ ss58Format: 42 });
+    });
+
+    it('can re-encode an address to Polkadot live', (): void => {
+      expect(
+        keyring.encodeAddress('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 0)
+      ).toEqual('15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5');
+    });
+
+    it('can re-encode an address to keyring default', (): void => {
+      expect(
+        keyring.encodeAddress('15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5')
+      ).toEqual('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY');
+    });
+  });
+
+  describe('version 2 JSON', (): void => {
+    const PAIR = '{"address":"5CczAE5AmGrZ93MeVhha3Ywam7j9dKB7cArnH7gtrXcMFJvu","encoded":"0xee8f236e2ac3217ce689692a4afc612220dc77fddaed0482f8f95136a7c3e034cccfbc495410a6e9b2439904974ed1d207abeca536ff6985ceb78edeeb3dc343e561c184c488101af8811d1331430b4ccf0e96ef507132e5132964e8564232e7100d973c5bee7b231dd0c8ad5273f3501515a422c8d7ed9d20a73c0ed17c98ee4588e54844bb73052dcad81f7a1094613d63c162fec7446c88b1fae70e","encoding":{"content":["pkcs8","sr25519"],"type":"xsalsa20-poly1305","version":"2"},"meta":{"genesisHash":"0xe143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423e","name":"json v2","tags":[],"whenCreated":1595243159596}}';
+    const PASS2 = 'versionTwo';
+    const PASS3 = 'versionThree';
+    let keyring: Keyring;
+
+    beforeEach((): void => {
+      keyring = new Keyring({ ss58Format: 42 });
+    });
+
+    it('can decode from a version 2 JSON file', (): void => {
+      const pair = keyring.addFromJson(JSON.parse(PAIR));
+
+      pair.decodePkcs8(PASS2);
+
+      const json = pair.toJson(PASS3);
+
+      expect(pair.isLocked).toBe(false);
+      expect(pair.address).toBe('5CczAE5AmGrZ93MeVhha3Ywam7j9dKB7cArnH7gtrXcMFJvu');
+      expect(json.encoding).toEqual({
+        content: ['pkcs8', 'sr25519'],
+        type: ['scrypt', 'xsalsa20-poly1305'],
+        version: '3'
+      });
+
+      pair.decodePkcs8(PASS3);
+
+      expect(pair.address).toEqual('5CczAE5AmGrZ93MeVhha3Ywam7j9dKB7cArnH7gtrXcMFJvu');
+    });
+  });
+
+  describe('version 3 JSON (hex)', (): void => {
+    const PAIR = '{"address":"FLiSDPCcJ6auZUGXALLj6jpahcP6adVFDBUQznPXUQ7yoqH","encoded":"0xcd238963070cc4d6806053ee1ac500c7add9c28732bb5d434a332f84a91d9be0008000000100000008000000cf630a1113941b350ddd06697e50399183162e5e9a0e893eafc7f5f4893a223dca5055706b9925b56fdb4304192143843da718e11717daf89cf4f4781f94fb443f61432f782d54280af9eec90bd3069c3cc2d957a42b7c18dc2e9497f623735518e0e49b58f8e4db2c09da3a45dbb935659d015fc94b946cba75b606a6ff7f4e823f6b049e2e6892026b49de02d6dbbd64646fe0933f537d9ea53a70be","encoding":{"content":["pkcs8","sr25519"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{"genesisHash":"0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe","name":"version3","tags":[],"whenCreated":1595277797639}}';
+    const PASS3 = 'version3';
+    let keyring: Keyring;
+
+    beforeEach((): void => {
+      keyring = new Keyring({ ss58Format: 2 });
+    });
+
+    it('can decode from a version 3 JSON file', (): void => {
+      const pair = keyring.addFromJson(JSON.parse(PAIR));
+
+      pair.decodePkcs8(PASS3);
+
+      expect(pair.isLocked).toBe(false);
+      expect(pair.address).toBe('FLiSDPCcJ6auZUGXALLj6jpahcP6adVFDBUQznPXUQ7yoqH');
+    });
+  });
+
+  describe('version 3 JSON (base64)', (): void => {
+    const PAIR = '{"address":"FLiSDPCcJ6auZUGXALLj6jpahcP6adVFDBUQznPXUQ7yoqH","encoded":"ILjSgYaGvq1zaCz/kx+aqfLaHBjLXz0Qsmr6RnkOVU4AgAAAAQAAAAgAAAB5R2hm5kgXyc0NQYFxvMU4zCdjB+ugs/ibEooqCvuudbaeKn3Ee47NkCqU1ecOJV+eeaVn4W4dRvIpj5kGmQOGsewR+MiQ/B0G9NFh7JXV0qcPlk2QMNW1/mbJrTO4miqL448BSkP7ZOhUV6HFUpMt3B9HwjiRLN8RORcFp0ID/Azs4Jl/xOpXNzbgQGIffWgCIKTxN9N1ku6tdlG4","encoding":{"content":["pkcs8","sr25519"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{"genesisHash":"0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe","name":"version3","tags":[],"whenCreated":1595277797639,"whenEdited":1595278378596}}';
+    const PASS3 = 'version3';
+    let keyring: Keyring;
+
+    beforeEach((): void => {
+      keyring = new Keyring({ ss58Format: 2 });
+    });
+
+    it('can decode from a version 3 JSON file', (): void => {
+      const pair = keyring.addFromJson(JSON.parse(PAIR));
+
+      pair.decodePkcs8(PASS3);
+
+      expect(pair.isLocked).toBe(false);
+      expect(pair.address).toBe('FLiSDPCcJ6auZUGXALLj6jpahcP6adVFDBUQznPXUQ7yoqH');
     });
   });
 });

packages/keyring/src/index.ts

@@ -1,13 +1,13 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
-import { assertSingletonPackage } from '@polkadot/util';
-import { decodeAddress, encodeAddress, setAddressPrefix } from '@polkadot/util-crypto';
+import { detectPackage } from '@polkadot/util';
+import { decodeAddress, encodeAddress, setSS58Format } from '@polkadot/util-crypto';
 
 import Keyring from './keyring';
 
-assertSingletonPackage('@polkadot/keyring');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+detectPackage(require('./package.json'), typeof __dirname !== 'undefined' && __dirname);
 
 export default Keyring;
 
@@ -15,5 +15,5 @@ export {
   Keyring,
   decodeAddress,
   encodeAddress,
-  setAddressPrefix
+  setSS58Format
 };

packages/keyring/src/keyring.ts

@@ -1,17 +1,23 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
-import { KeypairType } from '@polkadot/util-crypto/types';
-import { KeyringInstance, KeyringPair, KeyringPair$Json, KeyringPair$Meta, KeyringOptions } from './types';
+import { KeypairType, Keypair } from '@polkadot/util-crypto/types';
+import { KeyringInstance, KeyringPair, KeyringPair$Json, KeyringPair$JsonEncodingTypes, KeyringPair$Meta, KeyringOptions } from './types';
 
-import { assert, hexToU8a, isNumber, isHex, stringToU8a } from '@polkadot/util';
-import { decodeAddress, encodeAddress, keyExtractSuri, keyFromPath, naclKeypairFromSeed as naclFromSeed, schnorrkelKeypairFromSeed as schnorrkelFromSeed, mnemonicToMiniSecret, setAddressPrefix } from '@polkadot/util-crypto';
+import { assert, hexToU8a, isHex, isUndefined, stringToU8a } from '@polkadot/util';
+import { base64Decode, decodeAddress, encodeAddress, keyExtractSuri, keyFromPath, naclKeypairFromSeed as naclFromSeed, schnorrkelKeypairFromSeed as schnorrkelFromSeed, secp256k1KeypairFromSeed as secp256k1FromSeed, mnemonicToLegacySeed, mnemonicToMiniSecret } from '@polkadot/util-crypto';
 
 import { DEV_PHRASE } from './defaults';
 import createPair from './pair';
 import Pairs from './pairs';
 
+const keypairFromSeed = {
+  ecdsa: (seed: Uint8Array): Keypair => secp256k1FromSeed(seed),
+  ed25519: (seed: Uint8Array): Keypair => naclFromSeed(seed),
+  ethereum: (seed: Uint8Array): Keypair => secp256k1FromSeed(seed),
+  sr25519: (seed: Uint8Array): Keypair => schnorrkelFromSeed(seed)
+};
+
 /**
  * # @polkadot/keyring
  *
@@ -29,25 +35,22 @@ import Pairs from './pairs';
  * an account may be obtained using `toJson` accompanied by the account passphrase.
  */
 export default class Keyring implements KeyringInstance {
-  private _pairs: Pairs;
+  readonly #pairs: Pairs;
 
-  private _type: KeypairType;
+  readonly #type: KeypairType;
+
+  #ss58?: number;
 
   public decodeAddress = decodeAddress;
 
-  public encodeAddress = encodeAddress;
-
-  public setAddressPrefix = setAddressPrefix;
-
-  public constructor (options: KeyringOptions = {}) {
+  constructor (options: KeyringOptions = {}) {
     options.type = options.type || 'ed25519';
 
-    assert(options && ['ed25519', 'sr25519'].includes(options.type || 'undefined'), `Expected a keyring type of either 'ed25519' or 'sr25519', found '${options.type}`);
+    assert(options && ['ecdsa', 'ethereum', 'ed25519', 'sr25519'].includes(options.type || 'undefined'), `Expected a keyring type of either 'ed25519', 'sr25519' or 'ecdsa', found '${options.type}`);
 
-    this._pairs = new Pairs();
-    this._type = options.type;
-
-    setAddressPrefix(isNumber(options.addressPrefix) ? options.addressPrefix : 42);
+    this.#pairs = new Pairs();
+    this.#ss58 = options.ss58Format;
+    this.#type = options.type;
   }
 
   /**
@@ -65,10 +68,10 @@ export default class Keyring implements KeyringInstance {
   }
 
   /**
-   * @description Returns the type of the keyring, either ed25519 of sr25519
+   * @description Returns the type of the keyring, ed25519, sr25519 or ecdsa
    */
   public get type (): KeypairType {
-    return this._type;
+    return this.#type;
   }
 
   /**
@@ -76,7 +79,7 @@ export default class Keyring implements KeyringInstance {
    * @summary Stores an account, given a keyring pair, as a Key/Value (public key, pair) in Keyring Pair Dictionary
    */
   public addPair (pair: KeyringPair): KeyringPair {
-    return this._pairs.add(pair);
+    return this.#pairs.add(pair);
   }
 
   /**
@@ -87,10 +90,10 @@ export default 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): KeyringPair {
+  public addFromAddress (address: string | Uint8Array, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, type: KeypairType = this.type, ignoreChecksum?: boolean, encType?: KeyringPair$JsonEncodingTypes[]): KeyringPair {
     const publicKey = this.decodeAddress(address, ignoreChecksum);
 
-    return this.addPair(createPair(type, { publicKey, secretKey: new Uint8Array(64) }, meta, encoded));
+    return this.addPair(createPair({ toSS58: this.encodeAddress, type }, { publicKey, secretKey: new Uint8Array() }, meta, encoded, encType));
   }
 
   /**
@@ -100,12 +103,8 @@ export default class Keyring implements KeyringInstance {
    * of an account backup), and then generates a keyring pair from it 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 addFromJson ({ address, encoded, encoding: { content, version }, meta }: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair {
-    const type = version === '0' || !Array.isArray(content)
-      ? this.type
-      : content[1];
-
-    return this.addFromAddress(address, meta, hexToU8a(encoded), type, ignoreChecksum);
+  public addFromJson (json: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair {
+    return this.addPair(this.createFromJson(json, ignoreChecksum));
   }
 
   /**
@@ -128,11 +127,7 @@ export default 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 {
-    const keypair = type === 'sr25519'
-      ? schnorrkelFromSeed(seed)
-      : naclFromSeed(seed);
-
-    return this.addPair(createPair(type, keypair, meta, null));
+    return this.addPair(createPair({ toSS58: this.encodeAddress, type }, keypairFromSeed[type](seed), meta, null));
   }
 
   /**
@@ -146,9 +141,30 @@ export default class Keyring implements KeyringInstance {
     );
   }
 
+  /**
+   * @name createFromJson
+   * @description Creates a pair from a JSON keyfile
+   */
+  public createFromJson ({ address, encoded, encoding: { content, type, version }, meta }: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair {
+    const cryptoType = version === '0' || !Array.isArray(content)
+      ? this.type
+      : content[1];
+    const encType = !Array.isArray(type)
+      ? [type]
+      : type;
+    const publicKey = isHex(address)
+      ? hexToU8a(address)
+      : this.decodeAddress(address, ignoreChecksum);
+    const decoded = isHex(encoded)
+      ? hexToU8a(encoded)
+      : base64Decode(encoded);
+
+    return createPair({ toSS58: this.encodeAddress, type: cryptoType }, { publicKey, secretKey: new Uint8Array() }, meta, decoded, encType);
+  }
+
   /**
    * @name createFromUri
-   * @summry Creates a Keypair from an suri
+   * @summary Creates a Keypair from an suri
    * @description This creates a pair from the suri, but does not add it to the keyring
    */
   public createFromUri (_suri: string, meta: KeyringPair$Meta = {}, type: KeypairType = this.type): KeyringPair {
@@ -156,8 +172,8 @@ export default class Keyring implements KeyringInstance {
     const suri = _suri.startsWith('//')
       ? `${DEV_PHRASE}${_suri}`
       : _suri;
-    const { password, phrase, path } = keyExtractSuri(suri);
-    let seed;
+    const { password, path, phrase } = keyExtractSuri(suri);
+    let seed: Uint8Array;
 
     if (isHex(phrase, 256)) {
       seed = hexToU8a(phrase);
@@ -166,11 +182,9 @@ export default class Keyring implements KeyringInstance {
       const parts = str.split(' ');
 
       if ([12, 15, 18, 21, 24].includes(parts.length)) {
-        // FIXME This keeps compat with older versions, but breaks compat with subkey
-        // seed = type === 'sr25519'
-        //   ? mnemonicToMiniSecret(phrase, password)
-        //   : mnemonicToSeed(phrase, password);
-        seed = mnemonicToMiniSecret(phrase, password);
+        seed = type === 'ethereum'
+          ? mnemonicToLegacySeed(phrase)
+          : mnemonicToMiniSecret(phrase, password);
       } else {
         assert(str.length <= 32, 'specified phrase is not a valid mnemonic and is invalid as a raw seed at > 32 bytes');
 
@@ -178,12 +192,18 @@ export default class Keyring implements KeyringInstance {
       }
     }
 
-    const keypair = type === 'sr25519'
-      ? schnorrkelFromSeed(seed)
-      : naclFromSeed(seed);
-    const derived = keyFromPath(keypair, path, type);
+    // FIXME Need to support Ethereum-type derivation paths
+    const derived = keyFromPath(keypairFromSeed[type](seed), path, type);
 
-    return createPair(type, derived, meta, null);
+    return createPair({ toSS58: this.encodeAddress, type }, derived, meta, null);
+  }
+
+  /**
+   * @name encodeAddress
+   * @description Encodes the input into an ss58 representation
+   */
+  public encodeAddress = (address: Uint8Array | string, ss58Format?: number): string => {
+    return encodeAddress(address, isUndefined(ss58Format) ? this.#ss58 : ss58Format);
   }
 
   /**
@@ -193,7 +213,7 @@ export default class Keyring implements KeyringInstance {
    * a key lookup using the provided account address or public key (after decoding it).
    */
   public getPair (address: string | Uint8Array): KeyringPair {
-    return this._pairs.get(address);
+    return this.#pairs.get(address);
   }
 
   /**
@@ -202,7 +222,7 @@ export default class Keyring implements KeyringInstance {
    * @description Returns an array list of all the keyring pair values that are stored in the keyring pair dictionary.
    */
   public getPairs (): KeyringPair[] {
-    return this._pairs.all();
+    return this.#pairs.all();
   }
 
   /**
@@ -211,7 +231,7 @@ export default class Keyring implements KeyringInstance {
    * @description Returns an array list of all the public keys associated with each of the keyring pair values that are stored in the keyring pair dictionary.
    */
   public getPublicKeys (): Uint8Array[] {
-    return this._pairs
+    return this.#pairs
       .all()
       .map(({ publicKey }): Uint8Array =>
         publicKey
@@ -223,7 +243,15 @@ export default class Keyring implements KeyringInstance {
    * @description Deletes the provided input address or public key from the stored Keyring Pair Dictionary.
    */
   public removePair (address: string | Uint8Array): void {
-    this._pairs.remove(address);
+    this.#pairs.remove(address);
+  }
+
+  /**
+   * @name setSS58Format;
+   * @description Sets the ss58 format for the keyring
+   */
+  public setSS58Format (ss58: number): void {
+    this.#ss58 = ss58;
   }
 
   /**
@@ -235,6 +263,6 @@ export default class Keyring implements KeyringInstance {
    * may backup their account to a JSON file that contains this information.
    */
   public toJson (address: string | Uint8Array, passphrase?: string): KeyringPair$Json {
-    return this._pairs.get(address).toJson(passphrase);
+    return this.#pairs.get(address).toJson(passphrase);
   }
 }

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

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import testingPairs from '../testingPairs';
 

packages/keyring/src/pair/decode.ts

@@ -1,12 +1,13 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
-import { assert, stringToU8a, u8aFixLength } from '@polkadot/util';
-import { naclDecrypt } from '@polkadot/util-crypto';
+import { KeyringPair$JsonEncodingTypes } from '../types';
 import { PairInfo } from './types';
 
-import { NONCE_LENGTH, PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SEC_LENGTH, SEED_LENGTH } from './defaults';
+import { assert, stringToU8a, u8aFixLength } from '@polkadot/util';
+import { naclDecrypt, scryptEncode, scryptFromU8a } from '@polkadot/util-crypto';
+
+import { ENCODING, NONCE_LENGTH, PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SEC_LENGTH, SEED_LENGTH, SCRYPT_LENGTH } from './defaults';
 
 const SEED_OFFSET = PKCS8_HEADER.length;
 
@@ -14,20 +15,7 @@ type DecodeResult = PairInfo & {
   secretKey: Uint8Array;
 };
 
-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),
-      encrypted.subarray(0, NONCE_LENGTH),
-      u8aFixLength(stringToU8a(passphrase), 256, true)
-    ) as Uint8Array)
-    : encrypted;
-
-  assert(encoded, 'Unable to unencrypt using the supplied passphrase');
-
+function decodePkcs8 (encoded: Uint8Array): DecodeResult {
   const header = encoded.subarray(0, PKCS8_HEADER.length);
 
   assert(header.toString() === PKCS8_HEADER.toString(), 'Invalid Pkcs8 header found in body');
@@ -53,3 +41,33 @@ export default function decode (passphrase?: string, _encrypted?: Uint8Array | n
     secretKey
   };
 }
+
+export default function decode (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,19 +1,26 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
+import { KeyringPair$JsonEncodingTypes } from '../types';
+
+const ENCODING: KeyringPair$JsonEncodingTypes[] = ['scrypt', 'xsalsa20-poly1305'];
 const NONCE_LENGTH = 24;
 const PKCS8_DIVIDER = new Uint8Array([161, 35, 3, 33, 0]);
 const PKCS8_HEADER = new Uint8Array([48, 83, 2, 1, 1, 48, 5, 6, 3, 43, 101, 112, 4, 34, 4, 32]);
 const PUB_LENGTH = 32;
+const SALT_LENGTH = 32;
 const SEC_LENGTH = 64;
 const SEED_LENGTH = 32;
+const SCRYPT_LENGTH = SALT_LENGTH + (3 * 4);
 
 export {
+  ENCODING,
   NONCE_LENGTH,
   PKCS8_DIVIDER,
   PKCS8_HEADER,
   PUB_LENGTH,
+  SALT_LENGTH,
   SEC_LENGTH,
-  SEED_LENGTH
+  SEED_LENGTH,
+  SCRYPT_LENGTH
 };

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

@@ -1,12 +1,11 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import testingPairs from '../testingPairs';
-import { PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SEC_LENGTH } from './defaults';
+import { PKCS8_DIVIDER, PKCS8_HEADER, NONCE_LENGTH, PUB_LENGTH, SCRYPT_LENGTH, SEC_LENGTH } from './defaults';
 
 const PKCS8_LENGTH = PKCS8_DIVIDER.length + PKCS8_HEADER.length + PUB_LENGTH + SEC_LENGTH;
-const ENCODED_LENGTH = 157;
+const ENCODED_LENGTH = 16 + PKCS8_LENGTH + NONCE_LENGTH + SCRYPT_LENGTH;
 
 const keyring = testingPairs({ type: 'ed25519' }, false);
 

packages/keyring/src/pair/encode.ts

@@ -1,11 +1,10 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { PairInfo } from './types';
 
-import { stringToU8a, u8aConcat, u8aFixLength, assert } from '@polkadot/util';
-import { naclEncrypt } from '@polkadot/util-crypto';
+import { u8aConcat, assert } from '@polkadot/util';
+import { naclEncrypt, scryptEncode, scryptToU8a } from '@polkadot/util-crypto';
 
 import { PKCS8_DIVIDER, PKCS8_HEADER } from './defaults';
 
@@ -14,7 +13,7 @@ export default function encode ({ publicKey, secretKey }: PairInfo, passphrase?:
 
   const encoded = u8aConcat(
     PKCS8_HEADER,
-    secretKey as Uint8Array,
+    secretKey,
     PKCS8_DIVIDER,
     publicKey
   );
@@ -23,7 +22,8 @@ export default function encode ({ publicKey, secretKey }: PairInfo, passphrase?:
     return encoded;
   }
 
-  const { encrypted, nonce } = naclEncrypt(encoded, u8aFixLength(stringToU8a(passphrase), 256, true));
+  const { params, password, salt } = scryptEncode(passphrase);
+  const { encrypted, nonce } = naclEncrypt(encoded, password.subarray(0, 32));
 
-  return u8aConcat(nonce, encrypted);
+  return u8aConcat(scryptToU8a(salt, params), nonce, encrypted);
 }

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

@@ -1,15 +1,21 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
-import { setAddressPrefix } from '@polkadot/util-crypto';
+import { cryptoWaitReady, encodeAddress as toSS58, setSS58Format } from '@polkadot/util-crypto';
 
+import { hexToU8a } from '@polkadot/util';
+
+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 => {
@@ -18,6 +24,11 @@ describe('pair', (): void => {
     ).toEqual(
       new Uint8Array([209, 114, 167, 76, 218, 76, 134, 89, 18, 195, 43, 160, 168, 10, 87, 174, 105, 171, 174, 65, 14, 92, 203, 89, 222, 232, 78, 47, 68, 50, 219, 79])
     );
+    expect(
+      keyring.alice.addressRaw
+    ).toEqual(
+      new Uint8Array([209, 114, 167, 76, 218, 76, 134, 89, 18, 195, 43, 160, 168, 10, 87, 174, 105, 171, 174, 65, 14, 92, 203, 89, 222, 232, 78, 47, 68, 50, 219, 79])
+    );
   });
 
   it('allows signing', (): void => {
@@ -61,20 +72,50 @@ describe('pair', (): void => {
       '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua'
     );
 
-    setAddressPrefix(68);
+    setSS58Format(68);
 
     expect(keyring.alice.address).toEqual(
       '7sGUeMak588SPY2YMmmuKUuLz7u2WQpf74F9dCFtSLB2td9d'
     );
+
+    setSS58Format(42);
   });
 
   it('allows getting public key after decoding', (): void => {
     const PASS = 'testing';
     const encoded = keyring.alice.encodePkcs8(PASS);
 
-    const pair = createPair('sr25519', { publicKey: keyring.alice.publicKey });
+    const pair = createPair({ toSS58, type: 'sr25519' }, { publicKey: keyring.alice.publicKey });
+
     pair.decodePkcs8(PASS, encoded);
 
     expect(pair.isLocked).toEqual(false);
   });
+
+  it('allows derivation on the pair', (): void => {
+    const alice = createPair({ toSS58, type: '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');
+  });
+
+  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');
+  });
+
+  describe('ethereum', (): void => {
+    it('has a valid address from a known public', (): void => {
+      const pair = createPair({ toSS58, type: 'ethereum' }, { publicKey: hexToU8a('0x03b9dc646dd71118e5f7fda681ad9eca36eb3ee96f344f582fbe7b5bcdebb13077') });
+
+      expect(pair.address).toEqual('0x4119b2e6c3Cb618F4f0B93ac77f9BeeC7FF02887');
+      expect(pair.addressRaw).toEqual(hexToU8a('0x4119b2e6c3Cb618F4f0B93ac77f9BeeC7FF02887'));
+    });
+  });
 });

packages/keyring/src/pair/index.ts

@@ -1,38 +1,60 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { Keypair, KeypairType } from '@polkadot/util-crypto/types';
-import { KeyringPair, KeyringPair$Json, KeyringPair$Meta } from '../types';
+import { KeyringPair, KeyringPair$Json, KeyringPair$JsonEncodingTypes, KeyringPair$Meta, SignOptions } from '../types';
 import { PairInfo } from './types';
 
-import { encodeAddress, naclKeypairFromSeed as naclFromSeed, naclSign, naclVerify, schnorrkelKeypairFromSeed as schnorrkelFromSeed, schnorrkelSign, schnorrkelVerify } from '@polkadot/util-crypto';
+import { assert, u8aConcat, u8aToHex } from '@polkadot/util';
+import { blake2AsU8a, ethereumEncode, keccakAsU8a, keyExtractPath, keyFromPath, naclKeypairFromSeed as naclFromSeed, naclSign, schnorrkelKeypairFromSeed as schnorrkelFromSeed, schnorrkelSign, secp256k1Expand, secp256k1KeypairFromSeed as secp256k1FromSeed, secp256k1Sign, secp256k1Compress, signatureVerify } from '@polkadot/util-crypto';
 
 import decode from './decode';
 import encode from './encode';
 import toJson from './toJson';
 
-function isEmpty (u8a: Uint8Array): boolean {
-  return u8a.reduce((count, u8): number => count + u8, 0) === 0;
+interface Setup {
+  toSS58: (publicKey: Uint8Array) => string;
+  type: KeypairType;
 }
 
-const isSr25519 = (type: KeypairType): boolean =>
-  type === 'sr25519';
+const SIG_TYPE_NONE = new Uint8Array();
 
-const fromSeed = (type: KeypairType, seed: Uint8Array): Keypair =>
-  isSr25519(type)
-    ? schnorrkelFromSeed(seed)
-    : naclFromSeed(seed);
+const TYPE_FROM_SEED = {
+  ecdsa: secp256k1FromSeed,
+  ed25519: naclFromSeed,
+  ethereum: secp256k1FromSeed,
+  sr25519: schnorrkelFromSeed
+};
 
-const sign = (type: KeypairType, message: Uint8Array, pair: Partial<Keypair>): Uint8Array =>
-  isSr25519(type)
-    ? schnorrkelSign(message, pair)
-    : naclSign(message, pair);
+const TYPE_PREFIX = {
+  ecdsa: new Uint8Array([2]),
+  ed25519: new Uint8Array([0]),
+  ethereum: new Uint8Array([2]),
+  sr25519: new Uint8Array([1])
+};
 
-const verify = (type: KeypairType, message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean =>
-  isSr25519(type)
-    ? schnorrkelVerify(message, signature, publicKey)
-    : naclVerify(message, signature, publicKey);
+const TYPE_SIGNATURE = {
+  ecdsa: (m: Uint8Array, p: Partial<Keypair>) => secp256k1Sign(m, p, 'blake2'),
+  ed25519: naclSign,
+  ethereum: (m: Uint8Array, p: Partial<Keypair>) => secp256k1Sign(m, p, 'keccak'),
+  sr25519: schnorrkelSign
+};
+
+const TYPE_ADDRESS = {
+  ecdsa: (p: Uint8Array) => p.length > 32 ? blake2AsU8a(p) : p,
+  ed25519: (p: Uint8Array) => p,
+  ethereum: (p: Uint8Array) => keccakAsU8a(secp256k1Expand(p)),
+  sr25519: (p: Uint8Array) => p
+};
+
+function isEmpty (u8a: Uint8Array): boolean {
+  return u8a.reduce((count, u8) => count + u8, 0) === 0;
+}
+
+// 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
@@ -65,47 +87,97 @@ const verify = (type: KeypairType, message: Uint8Array, signature: Uint8Array, p
  * 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 default function createPair (type: KeypairType, { publicKey, secretKey }: PairInfo, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null): KeyringPair {
+export default function createPair ({ toSS58, type }: Setup, { publicKey, secretKey }: PairInfo, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, encTypes?: KeyringPair$JsonEncodingTypes[]): KeyringPair {
+  const decodePkcs8 = (passphrase?: string, userEncoded?: Uint8Array | null): void => {
+    const decoded = decode(passphrase, userEncoded || encoded, encTypes);
+
+    if (decoded.secretKey.length === 64) {
+      publicKey = decoded.publicKey;
+      secretKey = decoded.secretKey;
+    } else {
+      const pair = TYPE_FROM_SEED[type](decoded.secretKey);
+
+      publicKey = pair.publicKey;
+      secretKey = pair.secretKey;
+    }
+  };
+
+  const recode = (passphrase?: string): Uint8Array => {
+    isLocked(secretKey) && encoded && decodePkcs8(passphrase, encoded);
+
+    encoded = encode({ publicKey, secretKey }, passphrase); // re-encode, latest version
+    encTypes = undefined; // swap to defaults, latest version follows
+
+    return encoded;
+  };
+
+  const encodeAddress = (): string => {
+    const raw = TYPE_ADDRESS[type](publicKey);
+
+    return type === 'ethereum'
+      ? ethereumEncode(raw)
+      : toSS58(raw);
+  };
+
   return {
-    type,
     get address (): string {
-      return encodeAddress(publicKey);
+      return encodeAddress();
     },
-    decodePkcs8: (passphrase?: string, _encoded?: Uint8Array | null): void => {
-      const decoded = decode(passphrase, _encoded || encoded);
+    get addressRaw (): Uint8Array {
+      const raw = TYPE_ADDRESS[type](publicKey);
 
-      if (decoded.secretKey.length === 64) {
-        publicKey = decoded.publicKey;
-        secretKey = decoded.secretKey;
-      } else {
-        const pair = fromSeed(type, decoded.secretKey);
-
-        publicKey = pair.publicKey;
-        secretKey = pair.secretKey;
-      }
-    },
-    encodePkcs8: (passphrase?: string): Uint8Array =>
-      encode({ publicKey, secretKey }, passphrase),
-    get meta (): KeyringPair$Meta {
-      return meta;
+      return type === 'ethereum'
+        ? raw.slice(-20)
+        : raw;
     },
     get isLocked (): boolean {
-      return !secretKey || secretKey.length === 0 || isEmpty(secretKey);
+      return isLocked(secretKey);
     },
-    lock: (): void => {
-      secretKey = new Uint8Array(0);
+    get meta (): KeyringPair$Meta {
+      return meta;
     },
     get publicKey (): Uint8Array {
       return publicKey;
     },
+    get type (): KeypairType {
+      return type;
+    },
+    // eslint-disable-next-line sort-keys
+    decodePkcs8,
+    derive: (suri: string, meta?: KeyringPair$Meta): KeyringPair => {
+      assert(!isLocked(secretKey), 'Cannot derive on a locked keypair');
+
+      const { path } = keyExtractPath(suri);
+      const derived = keyFromPath({ publicKey, secretKey }, path, type);
+
+      return createPair({ toSS58, type }, derived, meta, null);
+    },
+    encodePkcs8: (passphrase?: string): Uint8Array =>
+      recode(passphrase),
+    lock: (): void => {
+      secretKey = new Uint8Array();
+    },
     setMeta: (additional: KeyringPair$Meta): void => {
       meta = { ...meta, ...additional };
     },
-    sign: (message: Uint8Array): Uint8Array =>
-      sign(type, message, { publicKey, secretKey }),
-    toJson: (passphrase?: string): KeyringPair$Json =>
-      toJson(type, { meta, publicKey }, encode({ publicKey, secretKey }, passphrase), !!passphrase),
+    sign: (message: Uint8Array, options: SignOptions = {}): Uint8Array => {
+      assert(!isLocked(secretKey), 'Cannot sign with a locked key pair');
+
+      return u8aConcat(
+        options.withType
+          ? TYPE_PREFIX[type]
+          : SIG_TYPE_NONE,
+        TYPE_SIGNATURE[type](message, { publicKey, secretKey })
+      );
+    },
+    toJson: (passphrase?: string): KeyringPair$Json => {
+      const address = ['ecdsa', 'ethereum'].includes(type)
+        ? u8aToHex(secp256k1Compress(publicKey))
+        : encodeAddress();
+
+      return toJson(type, { address, meta }, recode(passphrase), !!passphrase);
+    },
     verify: (message: Uint8Array, signature: Uint8Array): boolean =>
-      verify(type, message, signature, publicKey)
+      signatureVerify(message, signature, TYPE_ADDRESS[type](publicKey), type === 'ethereum').isValid
   };
 }

packages/keyring/src/pair/nobody.ts

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { KeyringPair, KeyringPair$Json, KeyringPair$Meta } from '../types';
 
@@ -24,20 +23,23 @@ const json: KeyringPair$Json = {
 };
 
 export default function everybody (): KeyringPair {
-  return {
-    type: 'ed25519',
+  const pair: KeyringPair = {
     address,
+    addressRaw: publicKey,
     // 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,
     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 =>
@@ -48,8 +50,11 @@ 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
   };
+
+  return pair;
 }

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

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import testingPairs from '../testingPairs';
 
@@ -12,15 +11,15 @@ describe('toJson', (): void => {
       keyring.alice.toJson()
     ).toMatchObject({
       address: '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua',
-      encoded: '0x3053020101300506032b657004220420416c696365202020202020202020202020202020202020202020202020202020d172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4fa123032100d172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4f',
+      encoded: 'MFMCAQEwBQYDK2VwBCIEIEFsaWNlICAgICAgICAgICAgICAgICAgICAgICAgICAg0XKnTNpMhlkSwyugqApXrmmrrkEOXMtZ3uhOL0Qy20+hIwMhANFyp0zaTIZZEsMroKgKV65pq65BDlzLWd7oTi9EMttP',
       encoding: {
         content: ['pkcs8', 'ed25519'],
-        type: 'none',
-        version: '2'
+        type: ['none'],
+        version: '3'
       },
       meta: {
-        name: 'alice',
-        isTesting: true
+        isTesting: true,
+        name: 'alice'
       }
     });
   });
@@ -28,13 +27,13 @@ describe('toJson', (): void => {
   it('creates an encoded output with passphrase', (): void => {
     const json = keyring.alice.toJson('testing');
 
-    expect(json.encoded).toHaveLength(316);
+    expect(json.encoded).toHaveLength(268);
     expect(json).toMatchObject({
       address: '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua',
       encoding: {
         content: ['pkcs8', 'ed25519'],
-        type: 'xsalsa20-poly1305',
-        version: '2'
+        type: ['scrypt', 'xsalsa20-poly1305'],
+        version: '3'
       }
     });
   });

packages/keyring/src/pair/toJson.ts

@@ -1,27 +1,34 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { KeypairType } from '@polkadot/util-crypto/types';
-import { KeyringPair$Json, KeyringPair$Meta } from '../types';
+import { KeyringPair$Json, KeyringPair$JsonEncodingTypes, KeyringPair$Meta } from '../types';
 
-import { u8aToHex } from '@polkadot/util';
-import { encodeAddress } from '@polkadot/util-crypto';
+import { base64Encode } from '@polkadot/util-crypto';
 
-type PairStateJson = KeyringPair$Meta & {
-  publicKey: Uint8Array;
-};
+import { ENCODING } from './defaults';
 
-export default function toJson (type: KeypairType, { publicKey, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
+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 default function toJson (type: KeypairType, { address, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
   return {
-    address: encodeAddress(publicKey),
-    encoded: u8aToHex(encoded),
+    address,
+    encoded: base64Encode(encoded),
     encoding: {
       content: ['pkcs8', type],
       type: isEncrypted
-        ? 'xsalsa20-poly1305'
-        : 'none',
-      version: '2'
+        ? ENCODING
+        : ENC_NONE,
+      version: VERSION
     },
     meta
   };

packages/keyring/src/pair/types.ts

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 export interface PairInfo {
   publicKey: Uint8Array;

packages/keyring/src/pairs.ts

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { KeyringPairs, KeyringPair } from './types';
 
@@ -10,24 +9,20 @@ import { decodeAddress } from '@polkadot/util-crypto';
 type KeyringPairMap = Record<string, KeyringPair>;
 
 export default class Pairs implements KeyringPairs {
-  private _map: KeyringPairMap;
-
-  public constructor () {
-    this._map = {};
-  }
+  readonly #map: KeyringPairMap = {};
 
   public add (pair: KeyringPair): KeyringPair {
-    this._map[pair.publicKey.toString()] = pair;
+    this.#map[decodeAddress(pair.address).toString()] = pair;
 
     return pair;
   }
 
   public all (): KeyringPair[] {
-    return Object.values(this._map);
+    return Object.values(this.#map);
   }
 
   public get (address: string | Uint8Array): KeyringPair {
-    const pair = this._map[decodeAddress(address).toString()];
+    const pair = this.#map[decodeAddress(address).toString()];
 
     assert(pair, (): string => {
       const formatted: string = isU8a(address) || isHex(address)
@@ -41,6 +36,6 @@ export default class Pairs implements KeyringPairs {
   }
 
   public remove (address: string | Uint8Array): void {
-    delete this._map[decodeAddress(address).toString()];
+    delete this.#map[decodeAddress(address).toString()];
   }
 }

packages/keyring/src/suri.spec.ts

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 // From https://github.com/paritytech/substrate/wiki/Secret-URI-Test-Vectors
 

packages/keyring/src/testing.ts

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { KeyringInstance, KeyringOptions } from './types';
 
@@ -21,53 +20,46 @@ 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',
+    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'
   },
   {
-    name: 'alice_session',
-    type: 'ed25519',
-    seed: 'Alice',
-    secretKey: hexToU8a('0xabf8e5bdbe30c65656c0a3cbd181ff8a56294a69dfedd27982aace4a7690911588dc3417d5058ec4b4503e0c12ea1a0a89be200fe98922423d4334014fa6b0ee'),
-    publicKey: hexToU8a('0x88dc3417d5058ec4b4503e0c12ea1a0a89be200fe98922423d4334014fa6b0ee')
-  },
-  {
-    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'
   }
 ];
 
@@ -80,7 +72,7 @@ const PAIRS: PairDef[] = [
 export default function testKeyring (options: KeyringOptions = {}, isDerived = true): KeyringInstance {
   const keyring = new Keyring(options);
 
-  PAIRS.forEach(({ name, publicKey, secretKey, seed, type }): void => {
+  PAIRS.forEach(({ name, publicKey, secretKey, seed, type = 'sr25519' }): void => {
     const meta = {
       isTesting: true,
       name: name || seed.replace('//', '_').toLowerCase()
@@ -89,7 +81,7 @@ export default function testKeyring (options: KeyringOptions = {}, isDerived = t
     const pair = !isDerived && !name
       ? keyring.addFromUri(seed, meta, options.type)
       : keyring.addPair(
-        createPair(type || 'sr25519', { publicKey, secretKey }, meta)
+        createPair({ toSS58: keyring.encodeAddress, type }, { publicKey, secretKey }, meta)
       );
 
     pair.lock = (): void => {

packages/keyring/src/testingPairs.spec.ts

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { cryptoWaitReady } from '@polkadot/util-crypto';
 
@@ -14,7 +13,7 @@ describe('testingPairs', (): void => {
   it('creates without failing', (): void => {
     expect(
       Object.keys(testingPairs())
-    ).toHaveLength(2 + 1 + 7);
+    ).toHaveLength(2 + 0 + 7); // stash, session, pairs
   });
 
   it('has the correct address for Alice (non-HDKD)', (): void => {
@@ -28,10 +27,4 @@ describe('testingPairs', (): void => {
       testingPairs({ type: 'ed25519' }).alice.address
     ).toEqual('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY');
   });
-
-  it('has the correct address for Alice_session (HDKD)', (): void => {
-    expect(
-      testingPairs({ type: 'ed25519' }).alice_session.address
-    ).toEqual('5FA9nQDVg267DEd8m1ZypXLBnvN7SFxYwV7ndqSYGiN9TTpu');
-  });
 });

packages/keyring/src/testingPairs.ts

@@ -1,6 +1,5 @@
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { KeyringPair, KeyringOptions } from './types';
 

packages/keyring/src/types.ts

@@ -1,26 +1,23 @@
-/* eslint-disable @typescript-eslint/class-name-casing */
-// Copyright 2017-2019 @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.
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
 
 import { Prefix } from '@polkadot/util-crypto/address/types';
 import { KeypairType } from '@polkadot/util-crypto/types';
 
 export interface KeyringOptions {
-  addressPrefix?: Prefix;
+  ss58Format?: Prefix;
   type?: KeypairType;
 }
 
-export interface KeyringPair$Meta {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [index: string]: any;
-}
+export type KeyringPair$Meta = Record<string, unknown>;
 
-export type KeyringPair$JsonVersion = '0' | '1' | '2';
+export type KeyringPair$JsonVersion = '0' | '1' | '2' | '3';
+
+export type KeyringPair$JsonEncodingTypes = 'none' | 'scrypt' | 'xsalsa20-poly1305';
 
 export interface KeyringPair$JsonEncoding {
   content: ['pkcs8', KeypairType];
-  type: 'xsalsa20-poly1305' | 'none';
+  type: KeyringPair$JsonEncodingTypes | KeyringPair$JsonEncodingTypes[];
   version: KeyringPair$JsonVersion;
 }
 
@@ -31,18 +28,24 @@ export interface KeyringPair$Json {
   meta: KeyringPair$Meta;
 }
 
+export interface SignOptions {
+  withType?: boolean;
+}
+
 export interface KeyringPair {
+  readonly address: string;
+  readonly addressRaw: Uint8Array;
+  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): Uint8Array;
+  sign (message: Uint8Array, options?: SignOptions): Uint8Array;
   toJson (passphrase?: string): KeyringPair$Json;
   verify (message: Uint8Array, signature: Uint8Array): boolean;
 }
@@ -59,9 +62,9 @@ export interface KeyringInstance {
   readonly publicKeys: Uint8Array[];
   readonly type: KeypairType;
 
-  decodeAddress (encoded: string | Uint8Array, ignoreChecksum?: boolean): Uint8Array;
-  encodeAddress (key: Uint8Array | string): string;
-  setAddressPrefix (prefix: Prefix): void;
+  decodeAddress (encoded: string | Uint8Array, ignoreChecksum?: boolean, ss58Format?: Prefix): Uint8Array;
+  encodeAddress (key: Uint8Array | string, ss58Format?: Prefix): string;
+  setSS58Format (ss58Format: Prefix): void;
 
   addPair (pair: KeyringPair): KeyringPair;
   addFromAddress (address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeypairType, ignoreChecksum?: boolean): KeyringPair;
@@ -69,6 +72,7 @@ export interface KeyringInstance {
   addFromMnemonic (mnemonic: string, 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;
   createFromUri (suri: string, meta?: KeyringPair$Meta, type?: KeypairType): KeyringPair;
   getPair (address: string | Uint8Array): KeyringPair;
   getPairs (): KeyringPair[];

packages/networks/README.md

@@ -0,0 +1,5 @@
+# @polkadot/networks
+
+A list of all available Substrate networks and their applicable prefixes.
+
+This list is periodically checked against the master list available at https://github.com/paritytech/substrate/blob/master/ss58-registry.json

packages/networks/package.json

@@ -1,17 +1,8 @@
 {
-  "name": "@polkadot/trie-hash",
-  "version": "1.3.1",
-  "description": "Generates trie roots from key-value pairs",
+  "name": "@polkadot/networks",
+  "version": "3.7.1",
+  "description": "A list of all available Substrate networks and their applicable prefixes",
   "main": "index.js",
-  "keywords": [
-    "Polkadot"
-  ],
-  "author": "Jaco Greeff <jacogr@gmail.com>",
-  "maintainers": [
-    "Jaco Greeff <jacogr@gmail.com>"
-  ],
-  "contributors": [],
-  "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -20,15 +11,25 @@
     "type": "git",
     "url": "git+https://github.com/polkadot-js/common.git"
   },
+  "keywords": [
+    "Polkadot",
+    "ss58"
+  ],
+  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "maintainers": [
+    "Jaco Greeff <jacogr@gmail.com>"
+  ],
+  "contributors": [],
+  "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/polkadot-js/common/issues"
   },
-  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-hash#readme",
+  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/networks#readme",
   "dependencies": {
-    "@babel/runtime": "^7.5.5",
-    "@polkadot/util": "^1.3.1"
+    "@babel/runtime": "^7.12.1"
   },
   "devDependencies": {
-    "@polkadot/chainspec": "^1.3.1"
+    "@polkadot/util": "^3.7.1",
+    "@polkadot/x-fetch": "^3.7.1"
   }
 }

packages/networks/src/crosscheck.spec.ts

@@ -0,0 +1,71 @@
+// Copyright 2017-2020 @polkadot/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { Ss58Registry } from './types';
+
+import fs from 'fs';
+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';
+
+function assertAndLog (check: boolean, error: string): void {
+  if (!check) {
+    process.env.CI_LOG && fs.appendFileSync(OUTPUT, `
+
+${error}
+`);
+
+    throw new Error(error);
+  }
+}
+
+describe('check latest Substrate ss58 registry', (): void => {
+  let original: Ss58Registry;
+
+  beforeAll(async (): Promise<void> => {
+    original = (await (await fetch(ORIGINAL)).json()) as Ss58Registry;
+  });
+
+  it('has the same number as the original', (): void => {
+    assertAndLog(all.length === original.registry.length, `Number of entries mismatched:: Expected ${original.registry.length} found ${all.length}`);
+  });
+
+  it('has no missing any entries', (): void => {
+    const missing = original.registry
+      .filter(({ prefix }) => !all.some((n) => n.prefix === prefix))
+      .map(({ displayName, prefix }) => `${displayName} (${prefix})`);
+
+    assertAndLog(!missing.length, `Missing entries found: ${JSON.stringify(missing, null, 2)}`);
+  });
+
+  it('has no extra entries', (): void => {
+    const missing = all
+      .filter(({ prefix }) => !original.registry.some((n) => n.prefix === prefix))
+      .map(({ displayName, prefix }) => `${displayName} (${prefix})`);
+
+    assertAndLog(!missing.length, `Extra entries found: ${JSON.stringify(missing, null, 2)}`);
+  });
+
+  it('has the same values as the original', (): void => {
+    const fields = Object.keys(original.schema);
+    const errors = original.registry
+      .map((n): [string, string[]] => {
+        const other = all.find(({ prefix }) => prefix === n.prefix);
+
+        return [
+          `${n.displayName} (${n.prefix})`,
+          other
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            ? fields.filter((f) => JSON.stringify(n[f]) !== JSON.stringify(other[f]))
+            : []
+        ];
+      })
+      .filter(([, fields]) => fields.length);
+
+    assertAndLog(!errors.length, `Mismatches found: ${JSON.stringify(errors.map(([name, m]) => `${name}:: ${m.join(', ')}`), null, 2)}`);
+  });
+});

packages/networks/src/index.spec.ts

@@ -0,0 +1,10 @@
+// Copyright 2017-2020 @polkadot/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import filtered from './';
+
+describe('filtered', (): void => {
+  it('has the correct starting order', (): void => {
+    expect(filtered.slice(0, 3).map(({ prefix }) => prefix)).toEqual([0, 2, 42]);
+  });
+});

packages/networks/src/index.ts

@@ -0,0 +1,367 @@
+// Copyright 2017-2020 @polkadot/networks authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import { Network, NetworkFromSubstrate } from './types';
+
+// 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)
+
+const createReserved = (prefix: number, displayName = 'This prefix is reserved.'): NetworkFromSubstrate => ({
+  decimals: null,
+  displayName,
+  network: `reserved${prefix}`,
+  prefix,
+  standardAccount: null,
+  symbols: null,
+  website: null
+});
+
+const all: NetworkFromSubstrate[] = [
+  {
+    decimals: [10],
+    displayName: 'Polkadot Relay Chain',
+    genesisHash: ['0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3'],
+    icon: 'polkadot',
+    network: 'polkadot',
+    prefix: 0,
+    standardAccount: '*25519',
+    symbols: ['DOT'],
+    website: 'https://polkadot.network'
+  },
+  createReserved(1),
+  {
+    decimals: [12],
+    displayName: 'Kusama Relay Chain',
+    genesisHash: [
+      '0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe', // Kusama CC3,
+      '0xe3777fa922cafbff200cadeaea1a76bd7898ad5b89f7848999058b50e715f636', // Kusama CC2
+      '0x3fd7b9eb6a00376e5be61f01abb429ffb0b104be05eaff4d458da48fcd425baf' // Kusama CC1
+    ],
+    icon: 'polkadot',
+    network: 'kusama',
+    prefix: 2,
+    standardAccount: '*25519',
+    symbols: ['KSM'],
+    website: 'https://kusama.network'
+  },
+  createReserved(3),
+  {
+    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: null,
+    displayName: 'Polymath',
+    network: 'polymath',
+    prefix: 12,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    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: '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',
+    genesisHash: ['0x3f0608444cf5d7eec977430483ffef31ff86dfa6bfc6d7114023ee80cc03ea3f'],
+    network: 'dock-testnet',
+    prefix: 21,
+    standardAccount: '*25519',
+    symbols: ['DCK'],
+    website: 'https://dock.io'
+  },
+  {
+    decimals: [6],
+    displayName: 'Dock Mainnet',
+    genesisHash: ['0xf73467c6544aa68df2ee546b135f955c46b90fa627e9b5d7935f41061bb8a5a9'],
+    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: null,
+    displayName: 'Subsocial',
+    genesisHash: ['0x0bd72c1c305172e1275278aaeb3f161e02eccb7a819e63f62d47bd53a28189f8'],
+    network: 'subsocial',
+    prefix: 28,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: null,
+    displayName: 'Phala Network',
+    network: 'phala',
+    prefix: 30,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: null,
+    displayName: 'Robonomics Network',
+    network: 'robonomics',
+    prefix: 32,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    decimals: null,
+    displayName: 'DataHighway',
+    network: 'datahighway',
+    prefix: 33,
+    standardAccount: '*25519',
+    symbols: null,
+    website: null
+  },
+  {
+    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: '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: 'Substrate',
+    network: 'substrate',
+    prefix: 42,
+    standardAccount: '*25519',
+    symbols: null,
+    website: 'https://substrate.dev/'
+  },
+  createReserved(43),
+  {
+    decimals: [8],
+    displayName: 'ChainX',
+    network: 'chainx',
+    prefix: 44,
+    standardAccount: '*25519',
+    symbols: ['PCX'],
+    website: 'https://chainx.org/'
+  },
+  createReserved(46),
+  createReserved(47),
+  createReserved(48, 'All prefixes 48 and higher are reserved and cannot be allocated.')
+];
+
+// The list of available/claimed prefixes
+//   - 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
+const available: Network[] = all
+  .filter((n) => n.standardAccount === '*25519')
+  .map((n) => ({ ...n, genesisHash: n.genesisHash || [], icon: n.icon || 'substrate' }))
+  .sort((a, b) =>
+    UNSORTED.includes(a.prefix) && UNSORTED.includes(b.prefix)
+      ? 0
+      : UNSORTED.includes(a.prefix)
+        ? -1
+        : UNSORTED.includes(b.prefix)
+          ? 1
+          : a.displayName.localeCompare(b.displayName)
+  );
+
+// A filtered list of those chains we have details about (genesisHashes)
+const filtered: Network[] = available.filter((n) => n.genesisHash.length || n.prefix === 42);
+
+export { all, available };
+
+export default filtered;

packages/networks/src/types.ts

@@ -0,0 +1,27 @@
+// Copyright 2017-2020 @polkadot/keyring authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export type Icon = 'beachball' | 'empty' | 'jdenticon' | 'polkadot' | 'substrate';
+
+export interface NetworkFromSubstrate {
+  decimals: number[] | null,
+  displayName: string;
+  network: string;
+  prefix: number;
+  genesisHash?: string[] | null;
+  icon?: Icon | null;
+  standardAccount: '*25519' | null;
+  symbols: string[] | null;
+  website: string | null;
+}
+
+export interface Network extends NetworkFromSubstrate {
+  genesisHash: string[];
+  icon: Icon;
+}
+
+export interface Ss58Registry {
+  registry: NetworkFromSubstrate[];
+  specification: string;
+  schema: Record<string, string>;
+}

packages/trie-codec/LICENSE

@@ -1,201 +0,0 @@
-                              Apache License
-                        Version 2.0, January 2004
-                    http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-  "License" shall mean the terms and conditions for use, reproduction,
-  and distribution as defined by Sections 1 through 9 of this document.
-
-  "Licensor" shall mean the copyright owner or entity authorized by
-  the copyright owner that is granting the License.
-
-  "Legal Entity" shall mean the union of the acting entity and all
-  other entities that control, are controlled by, or are under common
-  control with that entity. For the purposes of this definition,
-  "control" means (i) the power, direct or indirect, to cause the
-  direction or management of such entity, whether by contract or
-  otherwise, or (ii) ownership of fifty percent (50%) or more of the
-  outstanding shares, or (iii) beneficial ownership of such entity.
-
-  "You" (or "Your") shall mean an individual or Legal Entity
-  exercising permissions granted by this License.
-
-  "Source" form shall mean the preferred form for making modifications,
-  including but not limited to software source code, documentation
-  source, and configuration files.
-
-  "Object" form shall mean any form resulting from mechanical
-  transformation or translation of a Source form, including but
-  not limited to compiled object code, generated documentation,
-  and conversions to other media types.
-
-  "Work" shall mean the work of authorship, whether in Source or
-  Object form, made available under the License, as indicated by a
-  copyright notice that is included in or attached to the work
-  (an example is provided in the Appendix below).
-
-  "Derivative Works" shall mean any work, whether in Source or Object
-  form, that is based on (or derived from) the Work and for which the
-  editorial revisions, annotations, elaborations, or other modifications
-  represent, as a whole, an original work of authorship. For the purposes
-  of this License, Derivative Works shall not include works that remain
-  separable from, or merely link (or bind by name) to the interfaces of,
-  the Work and Derivative Works thereof.
-
-  "Contribution" shall mean any work of authorship, including
-  the original version of the Work and any modifications or additions
-  to that Work or Derivative Works thereof, that is intentionally
-  submitted to Licensor for inclusion in the Work by the copyright owner
-  or by an individual or Legal Entity authorized to submit on behalf of
-  the copyright owner. For the purposes of this definition, "submitted"
-  means any form of electronic, verbal, or written communication sent
-  to the Licensor or its representatives, including but not limited to
-  communication on electronic mailing lists, source code control systems,
-  and issue tracking systems that are managed by, or on behalf of, the
-  Licensor for the purpose of discussing and improving the Work, but
-  excluding communication that is conspicuously marked or otherwise
-  designated in writing by the copyright owner as "Not a Contribution."
-
-  "Contributor" shall mean Licensor and any individual or Legal Entity
-  on behalf of whom a Contribution has been received by Licensor and
-  subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-  this License, each Contributor hereby grants to You a perpetual,
-  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-  copyright license to reproduce, prepare Derivative Works of,
-  publicly display, publicly perform, sublicense, and distribute the
-  Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-  this License, each Contributor hereby grants to You a perpetual,
-  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-  (except as stated in this section) patent license to make, have made,
-  use, offer to sell, sell, import, and otherwise transfer the Work,
-  where such license applies only to those patent claims licensable
-  by such Contributor that are necessarily infringed by their
-  Contribution(s) alone or by combination of their Contribution(s)
-  with the Work to which such Contribution(s) was submitted. If You
-  institute patent litigation against any entity (including a
-  cross-claim or counterclaim in a lawsuit) alleging that the Work
-  or a Contribution incorporated within the Work constitutes direct
-  or contributory patent infringement, then any patent licenses
-  granted to You under this License for that Work shall terminate
-  as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-  Work or Derivative Works thereof in any medium, with or without
-  modifications, and in Source or Object form, provided that You
-  meet the following conditions:
-
-  (a) You must give any other recipients of the Work or
-      Derivative Works a copy of this License; and
-
-  (b) You must cause any modified files to carry prominent notices
-      stating that You changed the files; and
-
-  (c) You must retain, in the Source form of any Derivative Works
-      that You distribute, all copyright, patent, trademark, and
-      attribution notices from the Source form of the Work,
-      excluding those notices that do not pertain to any part of
-      the Derivative Works; and
-
-  (d) If the Work includes a "NOTICE" text file as part of its
-      distribution, then any Derivative Works that You distribute must
-      include a readable copy of the attribution notices contained
-      within such NOTICE file, excluding those notices that do not
-      pertain to any part of the Derivative Works, in at least one
-      of the following places: within a NOTICE text file distributed
-      as part of the Derivative Works; within the Source form or
-      documentation, if provided along with the Derivative Works; or,
-      within a display generated by the Derivative Works, if and
-      wherever such third-party notices normally appear. The contents
-      of the NOTICE file are for informational purposes only and
-      do not modify the License. You may add Your own attribution
-      notices within Derivative Works that You distribute, alongside
-      or as an addendum to the NOTICE text from the Work, provided
-      that such additional attribution notices cannot be construed
-      as modifying the License.
-
-  You may add Your own copyright statement to Your modifications and
-  may provide additional or different license terms and conditions
-  for use, reproduction, or distribution of Your modifications, or
-  for any such Derivative Works as a whole, provided Your use,
-  reproduction, and distribution of the Work otherwise complies with
-  the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-  any Contribution intentionally submitted for inclusion in the Work
-  by You to the Licensor shall be under the terms and conditions of
-  this License, without any additional terms or conditions.
-  Notwithstanding the above, nothing herein shall supersede or modify
-  the terms of any separate license agreement you may have executed
-  with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-  names, trademarks, service marks, or product names of the Licensor,
-  except as required for reasonable and customary use in describing the
-  origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-  agreed to in writing, Licensor provides the Work (and each
-  Contributor provides its Contributions) on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-  implied, including, without limitation, any warranties or conditions
-  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-  PARTICULAR PURPOSE. You are solely responsible for determining the
-  appropriateness of using or redistributing the Work and assume any
-  risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-  whether in tort (including negligence), contract, or otherwise,
-  unless required by applicable law (such as deliberate and grossly
-  negligent acts) or agreed to in writing, shall any Contributor be
-  liable to You for damages, including any direct, indirect, special,
-  incidental, or consequential damages of any character arising as a
-  result of this License or out of the use or inability to use the
-  Work (including but not limited to damages for loss of goodwill,
-  work stoppage, computer failure or malfunction, or any and all
-  other commercial damages or losses), even if such Contributor
-  has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-  the Work or Derivative Works thereof, You may choose to offer,
-  and charge a fee for, acceptance of support, warranty, indemnity,
-  or other liability obligations and/or rights consistent with this
-  License. However, in accepting such obligations, You may act only
-  on Your own behalf and on Your sole responsibility, not on behalf
-  of any other Contributor, and only if You agree to indemnify,
-  defend, and hold each Contributor harmless for any liability
-  incurred by, or claims asserted against, such Contributor by reason
-  of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-  To apply the Apache License to your work, attach the following
-  boilerplate notice, with the fields enclosed by brackets "[]"
-  replaced with your own identifying information. (Don't include
-  the brackets!)  The text should be enclosed in the appropriate
-  comment syntax for the file format. We also recommend that a
-  file or class name and description of purpose be included on the
-  same "printed page" as the copyright notice for easier
-  identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

packages/trie-codec/README.md

@@ -1,7 +0,0 @@
-# @polkadot/trie-codec
-
-Implementation of the Substrate-specific codec for a Trie
-
-## Utilities
-
-[Utilities](SUMMARY.md)

packages/trie-codec/src/NodeHeader.ts

@@ -1,135 +0,0 @@
-// Copyright 2017-2019 @polkadot/trie-codec 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 { decodeNibbles, isNibblesTerminated } from '@polkadot/trie-codec/nibbles';
-
-import { BRANCH_NODE_NO_VALUE, BRANCH_NODE_WITH_VALUE, EMPTY_TRIE, EXTENSION_NODE_BIG, EXTENSION_NODE_OFFSET, EXTENSION_NODE_SMALL_MAX, EXTENSION_NODE_THRESHOLD, LEAF_NODE_BIG, LEAF_NODE_OFFSET, LEAF_NODE_SMALL_MAX, LEAF_NODE_THRESHOLD, NODE_TYPE_BRANCH, NODE_TYPE_EXT, NODE_TYPE_LEAF, NODE_TYPE_NULL } from './constants';
-
-// FIXME These are not actually extending from types, we may want to bring
-// that in if the dependency imports can be sorted out
-type NodeType = 0 | 1 | 2 | 3;
-
-export type Null = null;
-export type BranchHeader = boolean;
-export type NibbleHeader = number;
-export type ExtensionHeader = NibbleHeader;
-export type LeafHeader = NibbleHeader;
-
-export default class NodeHeader {
-  private _nodeType: NodeType;
-
-  private _value: Null | BranchHeader | ExtensionHeader | LeafHeader;
-
-  public constructor (input?: null | Uint8Array | (null | Uint8Array)[]) {
-    const [nodeType, value] = Array.isArray(input)
-      ? NodeHeader.decodeNodeHeaderArray(input)
-      : NodeHeader.decodeNodeHeaderU8a(input);
-
-    this._nodeType = nodeType;
-    this._value = value;
-  }
-
-  private static decodeNodeHeaderArray (input: (null | Uint8Array)[]): [NodeType, Null | BranchHeader | ExtensionHeader | LeafHeader] {
-    if (input.length === 0) {
-      return [NODE_TYPE_NULL, null];
-    } else if (input.length === 2) {
-      const nibbles = decodeNibbles(input[0]);
-      const isTerminated = isNibblesTerminated(nibbles);
-
-      return isTerminated
-        ? [NODE_TYPE_LEAF, nibbles.length - 1]
-        : [NODE_TYPE_EXT, nibbles.length];
-    } else if (input.length === 17) {
-      return [NODE_TYPE_BRANCH, !!input[16]];
-    }
-
-    throw new Error('Unreachable');
-  }
-
-  private static decodeNodeHeaderU8a (input?: null | Uint8Array): [NodeType, Null | BranchHeader | ExtensionHeader | LeafHeader] {
-    const firstByte = input
-      ? input[0]
-      : EMPTY_TRIE;
-
-    if (!input || firstByte === EMPTY_TRIE) {
-      return [NODE_TYPE_NULL, null];
-    } else if (firstByte === BRANCH_NODE_NO_VALUE) {
-      return [NODE_TYPE_BRANCH, false];
-    } else if (firstByte === BRANCH_NODE_WITH_VALUE) {
-      return [NODE_TYPE_BRANCH, true];
-    } else if (firstByte >= EXTENSION_NODE_OFFSET && firstByte <= EXTENSION_NODE_SMALL_MAX) {
-      return [NODE_TYPE_EXT, firstByte - EXTENSION_NODE_OFFSET];
-    } else if (firstByte === EXTENSION_NODE_BIG) {
-      return [NODE_TYPE_EXT, input[1] + EXTENSION_NODE_THRESHOLD];
-    } else if (firstByte >= LEAF_NODE_OFFSET && firstByte <= LEAF_NODE_SMALL_MAX) {
-      return [NODE_TYPE_LEAF, firstByte - LEAF_NODE_OFFSET];
-    } else if (firstByte === LEAF_NODE_BIG) {
-      return [NODE_TYPE_LEAF, input[1] + LEAF_NODE_THRESHOLD];
-    }
-
-    throw new Error('Unreachable');
-  }
-
-  public get encodedLength (): number {
-    switch (this.nodeType) {
-      case NODE_TYPE_NULL:
-      case NODE_TYPE_BRANCH:
-        return 1;
-
-      case NODE_TYPE_EXT:
-        return (this.value as ExtensionHeader) < EXTENSION_NODE_THRESHOLD
-          ? 1
-          : 2;
-
-      case NODE_TYPE_LEAF:
-        return (this.value as LeafHeader) < LEAF_NODE_THRESHOLD
-          ? 1
-          : 2;
-
-      default:
-        throw new Error('Unreachable');
-    }
-  }
-
-  public get nodeType (): number {
-    return this._nodeType;
-  }
-
-  public get value (): Null | BranchHeader | ExtensionHeader | LeafHeader {
-    return this._value;
-  }
-
-  public toU8a (): Uint8Array {
-    switch (this.nodeType) {
-      case NODE_TYPE_NULL:
-        return new Uint8Array([EMPTY_TRIE]);
-
-      case NODE_TYPE_BRANCH:
-        return new Uint8Array([
-          this.value as BranchHeader
-            ? BRANCH_NODE_WITH_VALUE
-            : BRANCH_NODE_NO_VALUE
-        ]);
-
-      case NODE_TYPE_EXT: {
-        const nibbleCount = this.value as ExtensionHeader;
-
-        return (nibbleCount < EXTENSION_NODE_THRESHOLD)
-          ? new Uint8Array([EXTENSION_NODE_OFFSET + nibbleCount])
-          : new Uint8Array([EXTENSION_NODE_BIG, nibbleCount - EXTENSION_NODE_THRESHOLD]);
-      }
-
-      case NODE_TYPE_LEAF: {
-        const nibbleCount = this.value as LeafHeader;
-
-        return (nibbleCount < LEAF_NODE_THRESHOLD)
-          ? new Uint8Array([LEAF_NODE_OFFSET + nibbleCount])
-          : new Uint8Array([LEAF_NODE_BIG, nibbleCount - LEAF_NODE_THRESHOLD]);
-      }
-
-      default:
-        throw new Error('Unreachable');
-    }
-  }
-}