Compare commits

..
11 Commits
Author SHA1 Message Date
Travis CI bf1c187969 [CI Skip] 1.4.1 2019-09-12 12:05:38 +00:00
Jaco Greeff 16d077c87d 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
Jaco Greeff 00374effc5 string <-> hex conversion utilities (#470)
* string <-> hex conversion utilities

* Add tests
2019-09-12 13:48:06 +02:00
Travis CI 891a855fb8 [CI Skip] 1.4.0-beta.0 2019-09-11 10:33:22 +00:00
Jaco Greeff 854cb56621 Bump deps (#469) 2019-09-11 12:25:47 +02:00
Travis CI 1018a11548 [CI Skip] 1.3.1 2019-09-10 17:14:48 +00:00
Jaco Greeff dc55f2170f 1.3.1 (#467)
* 1.3.1

* CHANGELOG bump
2019-09-10 19:08:12 +02:00
Travis CI 36cd5cd504 [CI Skip] 1.3.0-beta.1 2019-09-10 15:51:48 +00:00
Jaco Greeff a5d23696e6 Remove ExtError 2019-09-10 17:44:47 +02:00
Travis CI 5adc753f81 [CI Skip] 1.3.0-beta.0 2019-09-10 15:16:34 +00:00
Jaco Greeff 5e494b7163 Fix ExtError construction 2019-09-10 17:03:21 +02:00
37 changed files with 496 additions and 574 deletions
+12
View File
@@ -1,3 +1,15 @@
# 1.4.1
- **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 applications using `ExtError`
# 1.2.1
- Keyring `addFromAddress` can now be used to store external accounts, for example those provided by external signers
+1 -1
View File
@@ -9,5 +9,5 @@
"packages": [
"packages/*"
],
"version": "1.2.1"
"version": "1.4.1"
}
+5 -5
View File
@@ -1,5 +1,5 @@
{
"version": "1.2.1",
"version": "1.4.1",
"private": true,
"engines": {
"yarn": "^1.10.1"
@@ -9,7 +9,7 @@
],
"resolutions": {
"babel-core": "^7.0.0-bridge.0",
"typescript": "^3.6.2"
"typescript": "^3.6.3"
},
"scripts": {
"build": "polkadot-dev-build-ts && polkadot-dev-build-docs",
@@ -21,9 +21,9 @@
"test:one": "jest"
},
"devDependencies": {
"@babel/core": "^7.5.5",
"@polkadot/dev": "^0.31.0-beta.7",
"@polkadot/ts": "^0.1.71",
"@babel/core": "^7.6.0",
"@polkadot/dev": "^0.31.0-beta.8",
"@polkadot/ts": "^0.1.72",
"gh-pages": "^2.1.1"
}
}
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/chainspec",
"version": "1.2.1",
"version": "1.4.1",
"description": "Contains chain specifications for known chains",
"main": "index.js",
"keywords": [
@@ -25,7 +25,7 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/chainspec#readme",
"dependencies": {
"@babel/runtime": "^7.5.5",
"@polkadot/util": "^1.2.1"
"@babel/runtime": "^7.6.0",
"@polkadot/util": "^1.4.1"
}
}
+4 -4
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/db",
"version": "1.2.1",
"version": "1.4.1",
"description": "Implementation of a basic sync in-memory and on-disk databases with overlays",
"main": "index.js",
"keywords": [
@@ -25,9 +25,9 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/db#readme",
"dependencies": {
"@babel/runtime": "^7.5.5",
"@polkadot/trie-hash": "^1.2.1",
"@polkadot/util": "^1.2.1",
"@babel/runtime": "^7.6.0",
"@polkadot/trie-hash": "^1.4.1",
"@polkadot/util": "^1.4.1",
"lru_map": "^0.3.3"
}
}
+4 -4
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/keyring",
"version": "1.2.1",
"version": "1.4.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.2.1",
"@polkadot/util-crypto": "^1.2.1"
"@babel/runtime": "^7.6.0",
"@polkadot/util": "^1.4.1",
"@polkadot/util-crypto": "^1.4.1"
}
}
+11 -3
View File
@@ -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
+2 -2
View File
@@ -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 -3
View File
@@ -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 -2
View File
@@ -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'
+3 -1
View File
@@ -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;
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/trie-codec",
"version": "1.2.1",
"version": "1.4.1",
"description": "This is an implementation of the codec for Substrate Trie",
"main": "index.js",
"keywords": [
@@ -25,7 +25,7 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-codec#readme",
"dependencies": {
"@babel/runtime": "^7.5.5",
"@polkadot/util": "^1.2.1"
"@babel/runtime": "^7.6.0",
"@polkadot/util": "^1.4.1"
}
}
+9 -9
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/trie-db",
"version": "1.2.1",
"version": "1.4.1",
"description": "This is an implementation of the modified merkle patricia tree as specified in Ethereum's yellow paper, adapted for Polkadot",
"main": "index.js",
"keywords": [
@@ -25,16 +25,16 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-db#readme",
"dependencies": {
"@babel/runtime": "^7.5.5",
"@polkadot/db": "^1.2.1",
"@polkadot/trie-codec": "^1.2.1",
"@polkadot/trie-hash": "^1.2.1",
"@polkadot/util": "^1.2.1",
"@polkadot/util-crypto": "^1.2.1"
"@babel/runtime": "^7.6.0",
"@polkadot/db": "^1.4.1",
"@polkadot/trie-codec": "^1.4.1",
"@polkadot/trie-hash": "^1.4.1",
"@polkadot/util": "^1.4.1",
"@polkadot/util-crypto": "^1.4.1"
},
"devDependencies": {
"@polkadot/chainspec": "^1.2.1",
"@polkadot/util-rlp": "^1.2.1",
"@polkadot/chainspec": "^1.4.1",
"@polkadot/util-rlp": "^1.4.1",
"ethereumjs-testing": "1.0.4"
}
}
+4 -4
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/trie-hash",
"version": "1.2.1",
"version": "1.4.1",
"description": "Generates trie roots from key-value pairs",
"main": "index.js",
"keywords": [
@@ -25,10 +25,10 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/trie-hash#readme",
"dependencies": {
"@babel/runtime": "^7.5.5",
"@polkadot/util": "^1.2.1"
"@babel/runtime": "^7.6.0",
"@polkadot/util": "^1.4.1"
},
"devDependencies": {
"@polkadot/chainspec": "^1.2.1"
"@polkadot/chainspec": "^1.4.1"
}
}
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/util-crypto",
"version": "1.2.1",
"version": "1.4.1",
"description": "A collection of useful crypto utilities for @polkadot",
"main": "index.js",
"keywords": [
@@ -25,8 +25,8 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme",
"dependencies": {
"@babel/runtime": "^7.5.5",
"@polkadot/util": "^1.2.1",
"@babel/runtime": "^7.6.0",
"@polkadot/util": "^1.4.1",
"@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(
+4 -2
View File
@@ -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}`);
+2 -2
View File
@@ -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;
}
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/util-rlp",
"version": "1.2.1",
"version": "1.4.1",
"description": "RLP encoding and decoding",
"main": "index.js",
"keywords": [
@@ -27,8 +27,8 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-rlp#readme",
"dependencies": {
"@babel/runtime": "^7.5.5",
"@polkadot/util": "^1.2.1"
"@babel/runtime": "^7.6.0",
"@polkadot/util": "^1.4.1"
},
"devDependencies": {
"ethereumjs-testing": "1.0.4"
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/util",
"version": "1.2.1",
"version": "1.4.1",
"description": "A collection of useful utilities for @polkadot",
"main": "index.js",
"keywords": [
@@ -25,7 +25,7 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util#readme",
"dependencies": {
"@babel/runtime": "^7.5.5",
"@babel/runtime": "^7.6.0",
"@types/bn.js": "^4.11.5",
"bn.js": "^4.11.8",
"camelcase": "^5.3.1",
-10
View File
@@ -22,14 +22,4 @@ describe('assert', (): void => {
(): boolean => assert(false, (): string => 'message from function')
).toThrow(/message from function/);
});
it('throws a valid constructed ExtError', (): void => {
try {
assert(false, 'error', -666, 'data');
} catch (error) {
expect(error.code).toEqual(-666);
expect(error.data).toEqual('data');
expect(error.message).toEqual('error');
}
});
});
+6 -7
View File
@@ -2,7 +2,6 @@
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import ExtError from './ext/error';
import isFunction from './is/function';
type MessageFn = () => string;
@@ -11,9 +10,9 @@ type Falsy = null | undefined | false | 0 | ''; // No NaN type
/**
* @name assert
* @summary Checks for a valid test, if not ExtError is thrown.
* @summary Checks for a valid test, if not Error is thrown.
* @description
* Checks that `test` is a truthy value. If value is falsy (`null`, `undefined`, `false`, ...), it throws an ExtError with the supplied `message` and an optional `code` and `data`. When `test` passes, `true` is returned.
* Checks that `test` is a truthy value. If value is falsy (`null`, `undefined`, `false`, ...), it throws an Error with the supplied `message`. When `test` passes, `true` is returned.
* @example
* <BR>
*
@@ -21,11 +20,11 @@ type Falsy = null | undefined | false | 0 | ''; // No NaN type
* const { assert } from '@polkadot/util';
*
* assert(true, 'True should be true'); // true returned
* assert(false, 'False should not be true'); // ExtError thrown
* assert(false, () => 'message'); // ExtError with 'message'
* assert(false, 'False should not be true'); // Error thrown
* assert(false, () => 'message'); // Error with 'message'
* ```
*/
export default function assert<T> (test: Falsy | T, message: string | MessageFn, code: number = ExtError.CODES.ASSERT, data?: string | number): test is T {
export default function assert<T> (test: Falsy | T, message: string | MessageFn): test is T {
if (test) {
return true;
}
@@ -34,5 +33,5 @@ export default function assert<T> (test: Falsy | T, message: string | MessageFn,
message = message();
}
throw new ExtError(message, code, data);
throw new Error(message);
}
-102
View File
@@ -1,102 +0,0 @@
/* eslint-disable @typescript-eslint/unbound-method */
// Copyright 2017-2019 @polkadot/util authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import isError from '../is/error';
import { ExtError } from '.';
describe('ExtError', (): void => {
describe('constructor', (): void => {
it('constructs an Error that is still an Error', (): void => {
expect(
isError(
new ExtError()
)
).toEqual(true);
});
});
describe('static', (): void => {
it('exposes the .CODES as a static', (): void => {
expect(
Object.keys(ExtError.CODES)
).not.toEqual(0);
});
});
describe('constructor properties', (): void => {
it('sets the .message property', (): void => {
expect(
new ExtError('test message').message
).toEqual('test message');
});
it("sets the .message to '' when not set", (): void => {
expect(
new ExtError().message
).toEqual('');
});
it('sets the .code property', (): void => {
expect(
new ExtError('test message', 1234).code
).toEqual(1234);
});
it('sets the .code to UKNOWN when not set', (): void => {
expect(
new ExtError('test message').code
).toEqual(ExtError.CODES.UNKNOWN);
});
it('sets the .data property', (): void => {
const data = 'here';
expect(
new ExtError('test message', 1234, data).data
).toEqual(data);
});
});
describe('stack traces', (): void => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let captureStackTrace: (targetObject: Record<string, any>, constructorOpt?: Function | undefined) => void;
beforeEach((): void => {
captureStackTrace = Error.captureStackTrace;
Error.captureStackTrace = function (error): void {
Object.defineProperty(error, 'stack', {
configurable: true,
get: function getStack (): string {
const value = 'some stack returned';
Object.defineProperty(this, 'stack', { value });
return value;
}
});
};
});
afterEach((): void => {
Error.captureStackTrace = captureStackTrace;
});
it('captures via captureStackTrace when available', (): void => {
expect(
new ExtError().stack
).toEqual('some stack returned');
});
it('captures via stack when captureStackTrace not available', (): void => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Error.captureStackTrace = null as any;
expect(
new ExtError().stack.length
).not.toEqual(0);
});
});
});
-73
View File
@@ -1,73 +0,0 @@
// Copyright 2017-2019 @polkadot/util authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import { ExtErrorInterface } from '../types';
import isFunction from '../is/function';
const UNKNOWN = -99999;
function extend (that: ExtError, name: string, value?: string | number): void {
Object.defineProperty(that, name, {
configurable: true,
enumerable: false,
value
});
}
/**
* @name ExtError
* @summary Extension to the basic JS Error.
* @description
* The built-in JavaScript Error class is extended by adding a code to allow for Error categorization. In addition to the normal `stack`, `message`, the numeric `code` and `data` (any types) parameters are available on the object.
* @example
* <BR>
*
* ```javascript
* const { ExtError } from '@polkadot/util');
*
* throw new ExtError('some message', ExtError.CODES.METHOD_NOT_FOUND); // => error.code = -32601
* ```
*/
export default class ExtError extends Error implements ExtErrorInterface {
public code: number;
public data?: number | string;
public message: string;
public name: string;
public stack: string;
public constructor (message = '', code: number = UNKNOWN, data?: number | string) {
super();
// These are actually done via extend below to clean them up
this.code = code;
this.data = data;
this.name = name;
this.message = message;
this.stack = '';
extend(this, 'message', String(message));
extend(this, 'name', this.constructor.name);
extend(this, 'data', data);
extend(this, 'code', code);
// eslint-disable-next-line @typescript-eslint/unbound-method
if (isFunction(Error.captureStackTrace)) {
Error.captureStackTrace(this, this.constructor);
} else {
extend(this, 'stack', (new Error(message)).stack);
}
}
public static CODES = {
ASSERT: -90009,
UNKNOWN,
INVALID_JSONRPC: -99998,
METHOD_NOT_FOUND: -32601 // Rust client
};
}
-9
View File
@@ -1,9 +0,0 @@
// Copyright 2017-2019 @polkadot/util authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
/**
* @summary Extensions to basic classes
*/
export { default as ExtError } from './error';
+1
View File
@@ -12,4 +12,5 @@ export { default as hexHasPrefix } from './hasPrefix';
export { default as hexStripPrefix } from './stripPrefix';
export { default as hexToBn } from './toBn';
export { default as hexToNumber } from './toNumber';
export { default as hexToString } from './toString';
export { default as hexToU8a } from './toU8a';
+19
View File
@@ -0,0 +1,19 @@
// Copyright 2017-2019 @polkadot/util authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import { hexToString } from '.';
describe('hexToString', (): void => {
it('converts an empty to ""', (): void => {
expect(
hexToString()
).toEqual('');
});
it('converts to a string from hex', (): void => {
expect(
hexToString('0x68656c6c6f')
).toEqual('hello');
});
});
+26
View File
@@ -0,0 +1,26 @@
// Copyright 2017-2019 @polkadot/util authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import u8aToString from '../u8a/toString';
import hexToU8a from './toU8a';
/**
* @name hexToU8a
* @summary Creates a Uint8Array object from a hex string.
* @description
* Hex input values return the actual bytes value converted to a string. Anything that is not a hex string (including the `0x` prefix) throws an error.
* @example
* <BR>
*
* ```javascript
* import { hexToString } from '@polkadot/util';
*
* hexToU8a('0x68656c6c6f'); // hello
* ```
*/
export default function hexToString (_value?: string | null): string {
return u8aToString(
hexToU8a(_value)
);
}
+1 -1
View File
@@ -8,7 +8,7 @@ import hexStripPrefix from './stripPrefix';
/**
* @name hexToU8a
* @summary Creates a Buffer object from a hex string.
* @summary Creates a Uint8Array object from a hex string.
* @description
* `null` inputs returns an empty `Uint8Array` result. Hex input values return the actual bytes value converted to a Uint8Array. Anything that is not a hex string (including the `0x` prefix) throws an error.
* @example
-1
View File
@@ -17,7 +17,6 @@ export * from './array';
export * from './bn';
export * from './buffer';
export * from './compact';
export * from './ext';
export * from './format';
export * from './hex';
export * from './is';
+1
View File
@@ -9,5 +9,6 @@
export { default as stringCamelCase } from './camelCase';
export { default as stringLowerFirst } from './lowerFirst';
export { default as stringShorten } from './shorten';
export { default as stringToHex } from './toHex';
export { default as stringToU8a } from './toU8a';
export { default as stringUpperFirst } from './upperFirst';
+19
View File
@@ -0,0 +1,19 @@
// Copyright 2017-2019 @polkadot/util authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import { stringToHex } from '.';
describe('hexToString', (): void => {
it('converts an empty to ""', (): void => {
expect(
stringToHex()
).toEqual('0x');
});
it('converts to a hex from string', (): void => {
expect(
stringToHex('hello')
).toEqual('0x68656c6c6f');
});
});
+26
View File
@@ -0,0 +1,26 @@
// Copyright 2017-2019 @polkadot/util authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import u8aToHex from '../u8a/toHex';
import stringToU8a from './toU8a';
/**
* @name stringToHex
* @summary Creates a hex string from a utf-8 string
* @description
* String input values return the actual encoded hex value.
* @example
* <BR>
*
* ```javascript
* import { stringToHex } from '@polkadot/util';
*
* stringToU8a('hello'); // 0x68656c6c6f
* ```
*/
export default function stringToHex (value?: string): string {
return u8aToHex(
stringToU8a(value)
);
}
-7
View File
@@ -8,13 +8,6 @@ export interface ToBn {
toBn: () => BN;
}
export interface ExtErrorInterface {
code: number;
data?: string | number;
message: string;
stack: string;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type Logger$Data$Fn = () => any[];
// eslint-disable-next-line @typescript-eslint/no-explicit-any
+304 -304
View File
File diff suppressed because it is too large Load Diff