ss58Format option for Keyring (#471)

* ss58Format option for Keyring * Expose setSS58Format everywhere * Remove setAddressPrefix * 1.4.0
2019-09-12 13:59:03 +02:00
parent 00374effc5
commit 16d077c87d
21 changed files with 74 additions and 49 deletions
@@ -1,10 +1,14 @@
-# 1.4.0-beta.x
+# 1.4.1

- Added `stringToHex` and `hexToString` conversion utilities
+- **Breaking change** To set the `ss58Format`, you should now use `setSS58Format` as opposed to the old `setAddressPrefix`
+- 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

- Remove the `ExtError` class, always prefer the standard JS `Error` object for errors. This would bre a breaking change for any appliactions using `ExtError`
+- 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

@@ -9,5 +9,5 @@
  "packages": [
    "packages/*"
  ],
-  "version": "1.4.0-beta.0"
+  "version": "1.4.0"
 }
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/chainspec",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "Contains chain specifications for known chains",
  "main": "index.js",
  "keywords": [
@@ -26,6 +26,6 @@
  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/chainspec#readme",
  "dependencies": {
    "@babel/runtime": "^7.6.0",
-    "@polkadot/util": "^1.4.0-beta.0"
+    "@polkadot/util": "^1.4.0"
  }
 }
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/db",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "Implementation of a basic sync in-memory and on-disk databases with overlays",
  "main": "index.js",
  "keywords": [
@@ -26,8 +26,8 @@
  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/db#readme",
  "dependencies": {
    "@babel/runtime": "^7.6.0",
-    "@polkadot/trie-hash": "^1.4.0-beta.0",
-    "@polkadot/util": "^1.4.0-beta.0",
+    "@polkadot/trie-hash": "^1.4.0",
+    "@polkadot/util": "^1.4.0",
    "lru_map": "^0.3.3"
  }
 }
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/keyring",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "Keyring management",
  "main": "index.js",
  "publishConfig": {
@@ -28,7 +28,7 @@
  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme",
  "dependencies": {
    "@babel/runtime": "^7.6.0",
-    "@polkadot/util": "^1.4.0-beta.0",
-    "@polkadot/util-crypto": "^1.4.0-beta.0"
+    "@polkadot/util": "^1.4.0",
+    "@polkadot/util-crypto": "^1.4.0"
  }
 }
@@ -3,7 +3,7 @@
 // of the Apache-2.0 license. See the LICENSE file for details.

 import { hexToU8a, stringToU8a } from '@polkadot/util';
-import { cryptoWaitReady, setAddressPrefix } from '@polkadot/util-crypto';
+import { cryptoWaitReady, setSS58Format } from '@polkadot/util-crypto';

 import Keyring from '.';

@@ -25,6 +25,10 @@ describe('keypair', (): void => {
      keypair.addFromSeed(seedOne, {});
    });

+    afterEach((): void => {
+      setSS58Format(42);
+    });
+
    it('adds the pair', (): void => {
      expect(
        keypair.addFromSeed(seedTwo, {}).publicKey
@@ -40,7 +44,7 @@ describe('keypair', (): void => {
    });

    it('adds from a mnemonic', (): void => {
-      setAddressPrefix(68);
+      setSS58Format(68);

      expect(
        keypair.addFromMnemonic('moral movie very draw assault whisper awful rebuild speed purity repeat card', {}).address
@@ -93,6 +97,10 @@ describe('keypair', (): void => {
      keypair.addFromSeed(seedOne, {});
    });

+    afterEach((): void => {
+      setSS58Format(42);
+    });
+
    it('creates with dev phrase when only path specified', (): void => {
      expect(
        keypair.createFromUri('//Alice').address
@@ -106,7 +114,7 @@ describe('keypair', (): void => {
    });

    it('adds from a mnemonic', (): void => {
-      setAddressPrefix(68);
+      setSS58Format(68);

      expect(
        keypair.addFromMnemonic('moral movie very draw assault whisper awful rebuild speed purity repeat card', {}).address
@@ -3,7 +3,7 @@
 // of the Apache-2.0 license. See the LICENSE file for details.

 import { assertSingletonPackage } from '@polkadot/util';
-import { decodeAddress, encodeAddress, setAddressPrefix } from '@polkadot/util-crypto';
+import { decodeAddress, encodeAddress, setSS58Format } from '@polkadot/util-crypto';

 import Keyring from './keyring';

@@ -15,5 +15,5 @@ export {
  Keyring,
  decodeAddress,
  encodeAddress,
-  setAddressPrefix
+  setSS58Format
 };
@@ -6,7 +6,7 @@ import { KeypairType } from '@polkadot/util-crypto/types';
 import { KeyringInstance, KeyringPair, KeyringPair$Json, 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 { decodeAddress, encodeAddress, keyExtractSuri, keyFromPath, naclKeypairFromSeed as naclFromSeed, schnorrkelKeypairFromSeed as schnorrkelFromSeed, mnemonicToMiniSecret, setSS58Format } from '@polkadot/util-crypto';

 import { DEV_PHRASE } from './defaults';
 import createPair from './pair';
@@ -37,17 +37,20 @@ export default class Keyring implements KeyringInstance {

  public encodeAddress = encodeAddress;

-  public setAddressPrefix = setAddressPrefix;
+  public setSS58Format = setSS58Format;

  public constructor (options: KeyringOptions = {}) {
    options.type = options.type || 'ed25519';
+    options.ss58Format = options.ss58Format || options.addressPrefix;

    assert(options && ['ed25519', 'sr25519'].includes(options.type || 'undefined'), `Expected a keyring type of either 'ed25519' or 'sr25519', found '${options.type}`);

    this._pairs = new Pairs();
    this._type = options.type;

-    setAddressPrefix(isNumber(options.addressPrefix) ? options.addressPrefix : 42);
+    if (isNumber(options.ss58Format)) {
+      setSS58Format(options.ss58Format);
+    }
  }

  /**
@@ -2,7 +2,7 @@
 // This software may be modified and distributed under the terms
 // of the Apache-2.0 license. See the LICENSE file for details.

-import { setAddressPrefix } from '@polkadot/util-crypto';
+import { setSS58Format } from '@polkadot/util-crypto';

 import testingPairs from '../testingPairs';
 import createPair from '.';
@@ -61,7 +61,7 @@ describe('pair', (): void => {
      '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua'
    );

-    setAddressPrefix(68);
+    setSS58Format(68);

    expect(keyring.alice.address).toEqual(
      '7sGUeMak588SPY2YMmmuKUuLz7u2WQpf74F9dCFtSLB2td9d'
@@ -7,7 +7,9 @@ import { Prefix } from '@polkadot/util-crypto/address/types';
 import { KeypairType } from '@polkadot/util-crypto/types';

 export interface KeyringOptions {
+  // @deprecated
  addressPrefix?: Prefix;
+  ss58Format?: Prefix;
  type?: KeypairType;
 }

@@ -61,7 +63,7 @@ export interface KeyringInstance {

  decodeAddress (encoded: string | Uint8Array, ignoreChecksum?: boolean): Uint8Array;
  encodeAddress (key: Uint8Array | string): string;
-  setAddressPrefix (prefix: Prefix): void;
+  setSS58Format (prefix: Prefix): void;

  addPair (pair: KeyringPair): KeyringPair;
  addFromAddress (address: string | Uint8Array, meta?: KeyringPair$Meta, encoded?: Uint8Array | null, type?: KeypairType, ignoreChecksum?: boolean): KeyringPair;
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/trie-codec",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "This is an implementation of the codec for Substrate Trie",
  "main": "index.js",
  "keywords": [
@@ -26,6 +26,6 @@
  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-codec#readme",
  "dependencies": {
    "@babel/runtime": "^7.6.0",
-    "@polkadot/util": "^1.4.0-beta.0"
+    "@polkadot/util": "^1.4.0"
  }
 }
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/trie-db",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "This is an implementation of the modified merkle patricia tree as specified in Ethereum's yellow paper, adapted for Polkadot",
  "main": "index.js",
  "keywords": [
@@ -26,15 +26,15 @@
  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-db#readme",
  "dependencies": {
    "@babel/runtime": "^7.6.0",
-    "@polkadot/db": "^1.4.0-beta.0",
-    "@polkadot/trie-codec": "^1.4.0-beta.0",
-    "@polkadot/trie-hash": "^1.4.0-beta.0",
-    "@polkadot/util": "^1.4.0-beta.0",
-    "@polkadot/util-crypto": "^1.4.0-beta.0"
+    "@polkadot/db": "^1.4.0",
+    "@polkadot/trie-codec": "^1.4.0",
+    "@polkadot/trie-hash": "^1.4.0",
+    "@polkadot/util": "^1.4.0",
+    "@polkadot/util-crypto": "^1.4.0"
  },
  "devDependencies": {
-    "@polkadot/chainspec": "^1.4.0-beta.0",
-    "@polkadot/util-rlp": "^1.4.0-beta.0",
+    "@polkadot/chainspec": "^1.4.0",
+    "@polkadot/util-rlp": "^1.4.0",
    "ethereumjs-testing": "1.0.4"
  }
 }
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/trie-hash",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "Generates trie roots from key-value pairs",
  "main": "index.js",
  "keywords": [
@@ -26,9 +26,9 @@
  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-hash#readme",
  "dependencies": {
    "@babel/runtime": "^7.6.0",
-    "@polkadot/util": "^1.4.0-beta.0"
+    "@polkadot/util": "^1.4.0"
  },
  "devDependencies": {
-    "@polkadot/chainspec": "^1.4.0-beta.0"
+    "@polkadot/chainspec": "^1.4.0"
  }
 }
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/util-crypto",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "A collection of useful crypto utilities for @polkadot",
  "main": "index.js",
  "keywords": [
@@ -26,7 +26,7 @@
  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme",
  "dependencies": {
    "@babel/runtime": "^7.6.0",
-    "@polkadot/util": "^1.4.0-beta.0",
+    "@polkadot/util": "^1.4.0",
    "@polkadot/wasm-crypto": "^0.14.1",
    "@types/bip39": "^2.4.2",
    "@types/bs58": "^4.0.0",
@@ -14,6 +14,12 @@ describe('encode', (): void => {
    ).toEqual('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua');
  });

+  it('can re-encode an address', (): void => {
+    expect(
+      encode('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 68)
+    ).toEqual('7sL6eNJj5ZGV5cn3hhV2deRUsivXfBfMH76wCALCqWj1EKzv');
+  });
+
  it('fails when non-valid publicKey provided', (): void => {
    expect(
      (): string => encode(
@@ -7,13 +7,15 @@ import { Prefix } from './types';
 // Original implementation: https://github.com/paritytech/polka-ui/blob/4858c094684769080f5811f32b081dd7780b0880/src/polkadot.js#L34

 import bs58 from 'bs58';
-import { assert, u8aConcat, u8aToBuffer, u8aToU8a } from '@polkadot/util';
+import { assert, u8aConcat, u8aToBuffer } from '@polkadot/util';

+import decode from './decode';
 import defaults from './defaults';
 import sshash from './sshash';

 export default function encode (_key: Uint8Array | string, prefix: Prefix = defaults.prefix): string {
-  const key = u8aToU8a(_key);
+  // decode it, this means we can re-encode an address
+  const key = decode(_key);

  assert(defaults.allowedDecodedLengths.includes(key.length), `Expected a valid key to convert, with length ${defaults.allowedDecodedLengths}`);

@@ -5,11 +5,11 @@
 import checkAddress from './check';
 import decodeAddress from './decode';
 import encodeAddress from './encode';
-import setAddressPrefix from './setPrefix';
+import setSS58Format from './setSS58Format';

 export {
  checkAddress,
  decodeAddress,
  encodeAddress,
-  setAddressPrefix
+  setSS58Format
 };
@@ -3,11 +3,11 @@
 // of the Apache-2.0 license. See the LICENSE file for details.

 import encode from './encode';
-import setPrefix from './setPrefix';
+import setSS58Format from './setSS58Format';

-describe('setPrefix', (): void => {
+describe('setSS58Format', (): void => {
  beforeEach((): void => {
-    setPrefix(68);
+    setSS58Format(68);
  });

  it('sets and allows encoding using', (): void => {
@@ -6,6 +6,6 @@ import { Prefix } from './types';

 import defaults from './defaults';

-export default function setPrefix (prefix: Prefix): void {
+export default function setSS58Format (prefix: Prefix): void {
  defaults.prefix = prefix;
 }
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/util-rlp",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "RLP encoding and decoding",
  "main": "index.js",
  "keywords": [
@@ -28,7 +28,7 @@
  "homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-rlp#readme",
  "dependencies": {
    "@babel/runtime": "^7.6.0",
-    "@polkadot/util": "^1.4.0-beta.0"
+    "@polkadot/util": "^1.4.0"
  },
  "devDependencies": {
    "ethereumjs-testing": "1.0.4"
@@ -1,6 +1,6 @@
 {
  "name": "@polkadot/util",
-  "version": "1.4.0-beta.0",
+  "version": "1.4.0",
  "description": "A collection of useful utilities for @polkadot",
  "main": "index.js",
  "keywords": [