From f07d66562b09e4ddb8ec31f51f354d1c07d44212 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Sun, 8 Nov 2020 18:07:31 +0100 Subject: [PATCH] Remove default exports (#755) * Remove default exports * Cleanup tests * Exports in util * Single secp256k1 instance * Length check * format check * encoded lengths --- packages/keyring/src/index.ts | 2 +- packages/keyring/src/keyring.ts | 6 +-- packages/keyring/src/pair/decode.spec.ts | 4 +- packages/keyring/src/pair/decode.ts | 2 +- packages/keyring/src/pair/encode.spec.ts | 4 +- packages/keyring/src/pair/encode.ts | 2 +- packages/keyring/src/pair/index.spec.ts | 6 +-- packages/keyring/src/pair/index.ts | 16 +++--- packages/keyring/src/pair/nobody.ts | 2 +- packages/keyring/src/pair/toJson.spec.ts | 4 +- packages/keyring/src/pair/toJson.ts | 2 +- packages/keyring/src/pairs.ts | 2 +- packages/keyring/src/testing.ts | 6 +-- packages/keyring/src/testingPairs.spec.ts | 8 +-- packages/keyring/src/testingPairs.ts | 8 +-- .../src/address/addressToEvm.spec.ts | 2 +- .../util-crypto/src/address/addressToEvm.ts | 6 +-- .../util-crypto/src/address/check.spec.ts | 2 +- packages/util-crypto/src/address/check.ts | 10 ++-- .../address/{checkChecksum.ts => checksum.ts} | 4 +- .../util-crypto/src/address/decode.spec.ts | 36 ++++++------- packages/util-crypto/src/address/decode.ts | 14 +++--- packages/util-crypto/src/address/defaults.ts | 4 +- .../util-crypto/src/address/derive.spec.ts | 6 +-- packages/util-crypto/src/address/derive.ts | 12 ++--- .../util-crypto/src/address/encode.spec.ts | 24 ++++----- packages/util-crypto/src/address/encode.ts | 12 ++--- .../src/address/encodeDerived.spec.ts | 2 +- .../util-crypto/src/address/encodeDerived.ts | 10 ++-- .../src/address/encodeMulti.spec.ts | 2 +- .../util-crypto/src/address/encodeMulti.ts | 8 +-- packages/util-crypto/src/address/eq.spec.ts | 4 +- packages/util-crypto/src/address/eq.ts | 6 +-- .../src/address/evmToAddress.spec.ts | 2 +- .../util-crypto/src/address/evmToAddress.ts | 14 +++--- packages/util-crypto/src/address/index.ts | 45 ++++++----------- .../src/address/keyDerived.spec.ts | 2 +- .../util-crypto/src/address/keyDerived.ts | 6 +-- packages/util-crypto/src/address/keyMulti.ts | 6 +-- .../src/address/setSS58Format.spec.ts | 5 +- .../util-crypto/src/address/setSS58Format.ts | 4 +- packages/util-crypto/src/address/sort.ts | 6 +-- packages/util-crypto/src/address/sshash.ts | 4 +- packages/util-crypto/src/base32/decode.ts | 6 +-- packages/util-crypto/src/base32/encode.ts | 2 +- packages/util-crypto/src/base32/index.ts | 8 +-- packages/util-crypto/src/base32/is.ts | 6 +-- packages/util-crypto/src/base32/validate.ts | 2 +- packages/util-crypto/src/base58/decode.ts | 6 +-- packages/util-crypto/src/base58/encode.ts | 2 +- packages/util-crypto/src/base58/index.ts | 8 +-- packages/util-crypto/src/base58/is.ts | 6 +-- packages/util-crypto/src/base58/validate.ts | 2 +- packages/util-crypto/src/base64/decode.ts | 6 +-- packages/util-crypto/src/base64/encode.ts | 2 +- packages/util-crypto/src/base64/index.ts | 12 ++--- packages/util-crypto/src/base64/is.ts | 6 +-- packages/util-crypto/src/base64/pad.ts | 2 +- packages/util-crypto/src/base64/trim.ts | 2 +- packages/util-crypto/src/base64/validate.ts | 2 +- packages/util-crypto/src/blake2/asHex.ts | 4 +- packages/util-crypto/src/blake2/asU8a.ts | 2 +- packages/util-crypto/src/blake2/index.ts | 4 +- packages/util-crypto/src/ethereum/encode.ts | 2 +- packages/util-crypto/src/ethereum/index.ts | 6 +-- .../util-crypto/src/ethereum/isAddress.ts | 4 +- .../util-crypto/src/ethereum/isChecksum.ts | 2 +- packages/util-crypto/src/keccak/asHex.ts | 4 +- packages/util-crypto/src/keccak/asU8a.ts | 2 +- packages/util-crypto/src/keccak/index.ts | 4 +- .../util-crypto/src/key/DeriveJunction.ts | 4 +- .../util-crypto/src/key/extractPath.spec.ts | 2 +- packages/util-crypto/src/key/extractPath.ts | 5 +- .../util-crypto/src/key/extractSuri.spec.ts | 2 +- packages/util-crypto/src/key/extractSuri.ts | 6 +-- packages/util-crypto/src/key/fromPath.ts | 14 +++--- packages/util-crypto/src/key/hdkdEcdsa.ts | 8 +-- packages/util-crypto/src/key/hdkdEd25519.ts | 8 +-- packages/util-crypto/src/key/hdkdSr25519.ts | 8 +-- packages/util-crypto/src/key/index.ts | 12 ++--- packages/util-crypto/src/mnemonic/bip39.ts | 2 +- .../util-crypto/src/mnemonic/generate.spec.ts | 18 +++---- packages/util-crypto/src/mnemonic/generate.ts | 2 +- packages/util-crypto/src/mnemonic/index.ts | 10 ++-- .../src/mnemonic/toEntropy.spec.ts | 6 +-- .../util-crypto/src/mnemonic/toEntropy.ts | 6 +-- .../util-crypto/src/mnemonic/toLegacySeed.ts | 2 +- .../src/mnemonic/toMiniSecret.spec.ts | 2 +- .../util-crypto/src/mnemonic/toMiniSecret.ts | 6 +-- .../util-crypto/src/mnemonic/validate.spec.ts | 10 ++-- packages/util-crypto/src/mnemonic/validate.ts | 2 +- .../util-crypto/src/nacl/box/fromSecret.ts | 2 +- packages/util-crypto/src/nacl/decrypt.ts | 2 +- packages/util-crypto/src/nacl/deriveHard.ts | 4 +- packages/util-crypto/src/nacl/encrypt.ts | 4 +- packages/util-crypto/src/nacl/index.ts | 23 ++++----- .../src/nacl/keypair/fromRandom.ts | 2 +- .../src/nacl/keypair/fromSecret.ts | 2 +- .../util-crypto/src/nacl/keypair/fromSeed.ts | 2 +- .../src/nacl/keypair/fromString.ts | 8 +-- packages/util-crypto/src/nacl/open.spec.ts | 12 ++--- packages/util-crypto/src/nacl/open.ts | 2 +- packages/util-crypto/src/nacl/seal.ts | 4 +- packages/util-crypto/src/nacl/sign.ts | 2 +- packages/util-crypto/src/nacl/verify.ts | 2 +- packages/util-crypto/src/pbkdf2/encode.ts | 4 +- packages/util-crypto/src/pbkdf2/index.ts | 2 +- packages/util-crypto/src/random/asHex.ts | 4 +- packages/util-crypto/src/random/asNumber.ts | 4 +- packages/util-crypto/src/random/asU8a.ts | 2 +- packages/util-crypto/src/random/index.ts | 6 +-- .../util-crypto/src/schnorrkel/deriveHard.ts | 10 ++-- .../src/schnorrkel/derivePublic.ts | 2 +- .../util-crypto/src/schnorrkel/deriveSoft.ts | 10 ++-- packages/util-crypto/src/schnorrkel/index.ts | 12 ++--- .../src/schnorrkel/keypair/fromSeed.ts | 6 +-- .../src/schnorrkel/keypair/fromU8a.ts | 2 +- .../src/schnorrkel/keypair/toU8a.ts | 2 +- packages/util-crypto/src/schnorrkel/sign.ts | 2 +- .../src/schnorrkel/signVerify.spec.ts | 22 ++++---- packages/util-crypto/src/schnorrkel/verify.ts | 2 +- packages/util-crypto/src/scrypt/encode.ts | 4 +- packages/util-crypto/src/scrypt/fromU8a.ts | 2 +- packages/util-crypto/src/scrypt/index.ts | 6 +-- packages/util-crypto/src/scrypt/toU8a.ts | 2 +- .../util-crypto/src/secp256k1/compress.ts | 10 ++-- .../util-crypto/src/secp256k1/deriveHard.ts | 4 +- packages/util-crypto/src/secp256k1/expand.ts | 13 ++--- .../util-crypto/src/secp256k1/hasher.spec.ts | 8 +-- packages/util-crypto/src/secp256k1/hasher.ts | 2 +- packages/util-crypto/src/secp256k1/index.ts | 12 ++--- .../src/secp256k1/keypair/fromSeed.ts | 9 ++-- packages/util-crypto/src/secp256k1/recover.ts | 8 ++- .../util-crypto/src/secp256k1/secp256k1.ts | 8 +++ packages/util-crypto/src/secp256k1/sign.ts | 16 +++--- .../src/secp256k1/signVerify.spec.ts | 50 ++++++++++--------- packages/util-crypto/src/secp256k1/verify.ts | 19 ++++--- packages/util-crypto/src/sha512/asU8a.ts | 2 +- packages/util-crypto/src/sha512/index.ts | 2 +- packages/util-crypto/src/signature/index.ts | 2 +- packages/util-crypto/src/signature/verify.ts | 12 ++--- packages/util-crypto/src/xxhash/asHex.ts | 4 +- packages/util-crypto/src/xxhash/asU8a.ts | 2 +- packages/util-crypto/src/xxhash/index.ts | 4 +- packages/util/src/array/filter.ts | 6 +-- packages/util/src/array/index.ts | 2 +- packages/util/src/assert.ts | 6 +-- packages/util/src/bn/fromHex.spec.ts | 2 +- packages/util/src/bn/fromHex.ts | 9 +--- packages/util/src/bn/index.ts | 15 +++--- packages/util/src/bn/max.ts | 2 +- packages/util/src/bn/min.ts | 2 +- packages/util/src/bn/sqrt.ts | 4 +- packages/util/src/bn/toBn.ts | 10 ++-- packages/util/src/bn/toHex.ts | 6 +-- packages/util/src/bn/toU8a.ts | 6 +-- packages/util/src/bn/util.ts | 2 +- packages/util/src/buffer/index.ts | 2 +- packages/util/src/buffer/toU8a.ts | 2 +- packages/util/src/compact/addLength.spec.ts | 2 +- packages/util/src/compact/addLength.ts | 4 +- packages/util/src/compact/fromU8a.spec.ts | 4 +- packages/util/src/compact/fromU8a.ts | 2 +- packages/util/src/compact/index.ts | 8 +-- packages/util/src/compact/stripLength.spec.ts | 2 +- packages/util/src/compact/stripLength.ts | 4 +- packages/util/src/compact/toU8a.spec.ts | 2 +- packages/util/src/compact/toU8a.ts | 4 +- packages/util/src/detectPackage.ts | 6 +-- packages/util/src/extractTime.ts | 2 +- .../util/src/format/formatBalance.spec.ts | 2 +- packages/util/src/format/formatBalance.ts | 10 ++-- packages/util/src/format/formatDate.spec.ts | 2 +- packages/util/src/format/formatDate.ts | 2 +- .../util/src/format/formatDecimal.spec.ts | 2 +- packages/util/src/format/formatDecimal.ts | 2 +- .../util/src/format/formatElapsed.spec.ts | 2 +- packages/util/src/format/formatElapsed.ts | 4 +- packages/util/src/format/formatNumber.spec.ts | 2 +- packages/util/src/format/formatNumber.ts | 6 +-- packages/util/src/format/index.ts | 10 ++-- packages/util/src/hex/addPrefix.ts | 6 +-- packages/util/src/hex/fixLength.ts | 6 +-- packages/util/src/hex/hasPrefix.ts | 4 +- packages/util/src/hex/index.ts | 16 +++--- packages/util/src/hex/stripPrefix.ts | 6 +-- packages/util/src/hex/toBn.ts | 6 +-- packages/util/src/hex/toNumber.ts | 4 +- packages/util/src/hex/toString.ts | 6 +-- packages/util/src/hex/toU8a.ts | 8 +-- packages/util/src/index.ts | 10 ++-- packages/util/src/is/ascii.ts | 6 +-- packages/util/src/is/bigInt.ts | 2 +- packages/util/src/is/bn.ts | 2 +- packages/util/src/is/boolean.ts | 2 +- packages/util/src/is/buffer.ts | 6 +-- packages/util/src/is/childClass.ts | 2 +- packages/util/src/is/error.ts | 4 +- packages/util/src/is/function.ts | 2 +- packages/util/src/is/hex.ts | 4 +- packages/util/src/is/index.ts | 46 ++++++++--------- packages/util/src/is/instanceOf.ts | 2 +- packages/util/src/is/ip.ts | 2 +- packages/util/src/is/jsonObject.ts | 2 +- packages/util/src/is/null.ts | 2 +- packages/util/src/is/number.ts | 2 +- packages/util/src/is/object.ts | 2 +- packages/util/src/is/observable.ts | 6 +-- packages/util/src/is/string.ts | 2 +- packages/util/src/is/testChain.spec.ts | 2 +- packages/util/src/is/testChain.ts | 2 +- packages/util/src/is/toBn.ts | 4 +- packages/util/src/is/u8a.ts | 4 +- packages/util/src/is/undefined.ts | 2 +- packages/util/src/is/utf8.ts | 6 +-- packages/util/src/is/wasm.ts | 4 +- packages/util/src/logger.ts | 16 +++--- packages/util/src/number/index.ts | 4 +- packages/util/src/number/toHex.ts | 8 +-- packages/util/src/number/toU8a.ts | 10 ++-- packages/util/src/promisify.ts | 2 +- packages/util/src/string/camelCase.ts | 2 +- packages/util/src/string/index.ts | 12 ++--- packages/util/src/string/lowerFirst.ts | 2 +- packages/util/src/string/shorten.ts | 2 +- packages/util/src/string/toHex.ts | 6 +-- packages/util/src/string/toU8a.ts | 2 +- packages/util/src/string/upperFirst.ts | 2 +- packages/util/src/u8a/concat.ts | 6 +-- packages/util/src/u8a/eq.ts | 6 +-- packages/util/src/u8a/fixLength.ts | 2 +- packages/util/src/u8a/index.ts | 18 +++---- packages/util/src/u8a/sorted.ts | 4 +- packages/util/src/u8a/toBn.ts | 6 +-- packages/util/src/u8a/toBuffer.ts | 2 +- packages/util/src/u8a/toHex.ts | 2 +- packages/util/src/u8a/toString.ts | 2 +- packages/util/src/u8a/toU8a.ts | 16 +++--- 238 files changed, 706 insertions(+), 723 deletions(-) rename packages/util-crypto/src/address/{checkChecksum.ts => checksum.ts} (84%) create mode 100644 packages/util-crypto/src/secp256k1/secp256k1.ts diff --git a/packages/keyring/src/index.ts b/packages/keyring/src/index.ts index c49bad37b..bf24aba14 100644 --- a/packages/keyring/src/index.ts +++ b/packages/keyring/src/index.ts @@ -4,7 +4,7 @@ import { detectPackage } from '@polkadot/util'; import { decodeAddress, encodeAddress, setSS58Format } from '@polkadot/util-crypto'; -import Keyring from './keyring'; +import { Keyring } from './keyring'; // eslint-disable-next-line @typescript-eslint/no-var-requires detectPackage(require('./package.json'), typeof __dirname !== 'undefined' && __dirname); diff --git a/packages/keyring/src/keyring.ts b/packages/keyring/src/keyring.ts index 2312e4620..602019be0 100644 --- a/packages/keyring/src/keyring.ts +++ b/packages/keyring/src/keyring.ts @@ -8,8 +8,8 @@ import { assert, hexToU8a, isHex, isUndefined, stringToU8a } from '@polkadot/uti 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'; +import { createPair } from './pair'; +import { Pairs } from './pairs'; const keypairFromSeed = { ecdsa: (seed: Uint8Array): Keypair => secp256k1FromSeed(seed), @@ -34,7 +34,7 @@ const keypairFromSeed = { * lookup of a pair for a given account address or public key using `getPair`. JSON metadata associated with * an account may be obtained using `toJson` accompanied by the account passphrase. */ -export default class Keyring implements KeyringInstance { +export class Keyring implements KeyringInstance { readonly #pairs: Pairs; readonly #type: KeypairType; diff --git a/packages/keyring/src/pair/decode.spec.ts b/packages/keyring/src/pair/decode.spec.ts index 7437939ee..1fb940f78 100644 --- a/packages/keyring/src/pair/decode.spec.ts +++ b/packages/keyring/src/pair/decode.spec.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/keyring authors & contributors // SPDX-License-Identifier: Apache-2.0 -import testingPairs from '../testingPairs'; +import { createTestPairs } from '../testingPairs'; -const keyring = testingPairs({ type: 'ed25519' }, false); +const keyring = createTestPairs({ type: 'ed25519' }, false); describe('decode', (): void => { it('fails when no data provided', (): void => { diff --git a/packages/keyring/src/pair/decode.ts b/packages/keyring/src/pair/decode.ts index 7f927088b..56251bdb7 100644 --- a/packages/keyring/src/pair/decode.ts +++ b/packages/keyring/src/pair/decode.ts @@ -42,7 +42,7 @@ function decodePkcs8 (encoded: Uint8Array): DecodeResult { }; } -export default function decode (passphrase?: string, encrypted?: Uint8Array | null, encType: KeyringPair$JsonEncodingTypes[] = ENCODING): DecodeResult { +export function decodePair (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'); diff --git a/packages/keyring/src/pair/encode.spec.ts b/packages/keyring/src/pair/encode.spec.ts index 4852eeb7b..e8bb55f99 100644 --- a/packages/keyring/src/pair/encode.spec.ts +++ b/packages/keyring/src/pair/encode.spec.ts @@ -1,13 +1,13 @@ // Copyright 2017-2020 @polkadot/keyring authors & contributors // SPDX-License-Identifier: Apache-2.0 -import testingPairs from '../testingPairs'; +import { createTestPairs } from '../testingPairs'; 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 = 16 + PKCS8_LENGTH + NONCE_LENGTH + SCRYPT_LENGTH; -const keyring = testingPairs({ type: 'ed25519' }, false); +const keyring = createTestPairs({ type: 'ed25519' }, false); describe('encode', (): void => { it('returns PKCS8 when no passphrase supplied', (): void => { diff --git a/packages/keyring/src/pair/encode.ts b/packages/keyring/src/pair/encode.ts index 2c42bfd6d..e60279dd9 100644 --- a/packages/keyring/src/pair/encode.ts +++ b/packages/keyring/src/pair/encode.ts @@ -8,7 +8,7 @@ import { naclEncrypt, scryptEncode, scryptToU8a } from '@polkadot/util-crypto'; import { PKCS8_DIVIDER, PKCS8_HEADER } from './defaults'; -export default function encode ({ publicKey, secretKey }: PairInfo, passphrase?: string): Uint8Array { +export function encodePair ({ publicKey, secretKey }: PairInfo, passphrase?: string): Uint8Array { assert(secretKey, 'Expected a valid secretKey to be passed to encode'); const encoded = u8aConcat( diff --git a/packages/keyring/src/pair/index.spec.ts b/packages/keyring/src/pair/index.spec.ts index 4a22c712d..c111cf7db 100644 --- a/packages/keyring/src/pair/index.spec.ts +++ b/packages/keyring/src/pair/index.spec.ts @@ -6,10 +6,10 @@ import { cryptoWaitReady, encodeAddress as toSS58, setSS58Format } from '@polkad import { hexToU8a } from '@polkadot/util'; import { PAIRS } from '../testing'; -import testingPairs from '../testingPairs'; -import createPair from '.'; +import { createTestPairs } from '../testingPairs'; +import { createPair } from '.'; -const keyring = testingPairs({ type: 'ed25519' }, false); +const keyring = createTestPairs({ type: 'ed25519' }, false); describe('pair', (): void => { beforeEach(async (): Promise => { diff --git a/packages/keyring/src/pair/index.ts b/packages/keyring/src/pair/index.ts index f0d520dbf..3156664fd 100644 --- a/packages/keyring/src/pair/index.ts +++ b/packages/keyring/src/pair/index.ts @@ -8,9 +8,9 @@ import { PairInfo } from './types'; 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'; +import { decodePair } from './decode'; +import { encodePair } from './encode'; +import { pairToJson } from './toJson'; interface Setup { toSS58: (publicKey: Uint8Array) => string; @@ -57,7 +57,7 @@ function isLocked (secretKey?: Uint8Array): secretKey is undefined { } /** - * @name pair + * @name createPair * @summary Creates a keyring pair object * @description Creates a keyring pair object with provided account public key, metadata, and encoded arguments. * The keyring pair stores the account state including the encoded address and associated metadata. @@ -87,9 +87,9 @@ function isLocked (secretKey?: Uint8Array): secretKey is undefined { * 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 ({ toSS58, type }: Setup, { publicKey, secretKey }: PairInfo, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, encTypes?: KeyringPair$JsonEncodingTypes[]): KeyringPair { +export 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); + const decoded = decodePair(passphrase, userEncoded || encoded, encTypes); if (decoded.secretKey.length === 64) { publicKey = decoded.publicKey; @@ -105,7 +105,7 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret const recode = (passphrase?: string): Uint8Array => { isLocked(secretKey) && encoded && decodePkcs8(passphrase, encoded); - encoded = encode({ publicKey, secretKey }, passphrase); // re-encode, latest version + encoded = encodePair({ publicKey, secretKey }, passphrase); // re-encode, latest version encTypes = undefined; // swap to defaults, latest version follows return encoded; @@ -175,7 +175,7 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret ? u8aToHex(secp256k1Compress(publicKey)) : encodeAddress(); - return toJson(type, { address, meta }, recode(passphrase), !!passphrase); + return pairToJson(type, { address, meta }, recode(passphrase), !!passphrase); }, verify: (message: Uint8Array, signature: Uint8Array): boolean => signatureVerify(message, signature, TYPE_ADDRESS[type](publicKey), type === 'ethereum').isValid diff --git a/packages/keyring/src/pair/nobody.ts b/packages/keyring/src/pair/nobody.ts index 4efd5bb51..4ca904f06 100644 --- a/packages/keyring/src/pair/nobody.ts +++ b/packages/keyring/src/pair/nobody.ts @@ -22,7 +22,7 @@ const json: KeyringPair$Json = { meta }; -export default function everybody (): KeyringPair { +export function nobody (): KeyringPair { const pair: KeyringPair = { address, addressRaw: publicKey, diff --git a/packages/keyring/src/pair/toJson.spec.ts b/packages/keyring/src/pair/toJson.spec.ts index d8f4b8c8f..1aa405fe0 100644 --- a/packages/keyring/src/pair/toJson.spec.ts +++ b/packages/keyring/src/pair/toJson.spec.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/keyring authors & contributors // SPDX-License-Identifier: Apache-2.0 -import testingPairs from '../testingPairs'; +import { createTestPairs } from '../testingPairs'; -const keyring = testingPairs({ type: 'ed25519' }, false); +const keyring = createTestPairs({ type: 'ed25519' }, false); describe('toJson', (): void => { it('creates an unencoded output with no passphrase', (): void => { diff --git a/packages/keyring/src/pair/toJson.ts b/packages/keyring/src/pair/toJson.ts index 501cd2ee8..e518c512a 100644 --- a/packages/keyring/src/pair/toJson.ts +++ b/packages/keyring/src/pair/toJson.ts @@ -19,7 +19,7 @@ const VERSION = '3'; const ENC_NONE: KeyringPair$JsonEncodingTypes[] = ['none']; -export default function toJson (type: KeypairType, { address, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json { +export function pairToJson (type: KeypairType, { address, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json { return { address, encoded: base64Encode(encoded), diff --git a/packages/keyring/src/pairs.ts b/packages/keyring/src/pairs.ts index e326e0efd..3b900f0dc 100644 --- a/packages/keyring/src/pairs.ts +++ b/packages/keyring/src/pairs.ts @@ -8,7 +8,7 @@ import { decodeAddress } from '@polkadot/util-crypto'; type KeyringPairMap = Record; -export default class Pairs implements KeyringPairs { +export class Pairs implements KeyringPairs { readonly #map: KeyringPairMap = {}; public add (pair: KeyringPair): KeyringPair { diff --git a/packages/keyring/src/testing.ts b/packages/keyring/src/testing.ts index db34fdafd..bdccbd80e 100644 --- a/packages/keyring/src/testing.ts +++ b/packages/keyring/src/testing.ts @@ -5,7 +5,7 @@ import { KeyringInstance, KeyringOptions } from './types'; import { hexToU8a } from '@polkadot/util'; -import createPair from './pair'; +import { createPair } from './pair'; import Keyring from '.'; interface PairDef { @@ -67,9 +67,9 @@ export const PAIRS: PairDef[] = [ * @name testKeyring * @summary Create an instance of Keyring pre-populated with locked test accounts * @description The test accounts (i.e. alice, bob, dave, eve, ferdie) - * are available on the dev chain and each test account is initialised with DOT funds. + * are available on the dev chain and each test account is initialized with DOT funds. */ -export default function testKeyring (options: KeyringOptions = {}, isDerived = true): KeyringInstance { +export function createTestKeyring (options: KeyringOptions = {}, isDerived = true): KeyringInstance { const keyring = new Keyring(options); PAIRS.forEach(({ name, publicKey, secretKey, seed, type = 'sr25519' }): void => { diff --git a/packages/keyring/src/testingPairs.spec.ts b/packages/keyring/src/testingPairs.spec.ts index f0507ea71..534059b1e 100644 --- a/packages/keyring/src/testingPairs.spec.ts +++ b/packages/keyring/src/testingPairs.spec.ts @@ -3,7 +3,7 @@ import { cryptoWaitReady } from '@polkadot/util-crypto'; -import testingPairs from './testingPairs'; +import { createTestPairs } from './testingPairs'; describe('testingPairs', (): void => { beforeEach(async (): Promise => { @@ -12,19 +12,19 @@ describe('testingPairs', (): void => { it('creates without failing', (): void => { expect( - Object.keys(testingPairs()) + Object.keys(createTestPairs()) ).toHaveLength(2 + 0 + 7); // stash, session, pairs }); it('has the correct address for Alice (non-HDKD)', (): void => { expect( - testingPairs({ type: 'ed25519' }, false).alice.address + createTestPairs({ type: 'ed25519' }, false).alice.address ).toEqual('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua'); }); it('has the correct address for Alice (HDKD)', (): void => { expect( - testingPairs({ type: 'ed25519' }).alice.address + createTestPairs({ type: 'ed25519' }).alice.address ).toEqual('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY'); }); }); diff --git a/packages/keyring/src/testingPairs.ts b/packages/keyring/src/testingPairs.ts index 2d50c28bc..1b9418c4f 100644 --- a/packages/keyring/src/testingPairs.ts +++ b/packages/keyring/src/testingPairs.ts @@ -3,15 +3,15 @@ import { KeyringPair, KeyringOptions } from './types'; -import createKeyring from './testing'; -import nobody from './pair/nobody'; +import { createTestKeyring } from './testing'; +import { nobody } from './pair/nobody'; export interface TestKeyringMap { [index: string]: KeyringPair; } -export default function testKeyringPairs (options?: KeyringOptions, isDerived = true): TestKeyringMap { - const keyring = createKeyring(options, isDerived); +export function createTestPairs (options?: KeyringOptions, isDerived = true): TestKeyringMap { + const keyring = createTestKeyring(options, isDerived); const pairs = keyring.getPairs(); const map: TestKeyringMap = { nobody: nobody() }; diff --git a/packages/util-crypto/src/address/addressToEvm.spec.ts b/packages/util-crypto/src/address/addressToEvm.spec.ts index 7f20858e0..80425ebdc 100644 --- a/packages/util-crypto/src/address/addressToEvm.spec.ts +++ b/packages/util-crypto/src/address/addressToEvm.spec.ts @@ -3,7 +3,7 @@ import { hexToU8a } from '@polkadot/util'; -import addressToEvm from './addressToEvm'; +import { addressToEvm } from './addressToEvm'; describe('addressToEvm', (): void => { it('creates a valid known EVM address', (): void => { diff --git a/packages/util-crypto/src/address/addressToEvm.ts b/packages/util-crypto/src/address/addressToEvm.ts index a54ec4f47..b3031d827 100644 --- a/packages/util-crypto/src/address/addressToEvm.ts +++ b/packages/util-crypto/src/address/addressToEvm.ts @@ -1,14 +1,14 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import decode from './decode'; +import { decodeAddress } from './decode'; /** * @name addressToEvm * @summary Converts an SS58 address to its corresponding EVM address. */ -export default function addressToEvm (address: string | Uint8Array, ignoreChecksum?: boolean): Uint8Array { - const decoded = decode(address, ignoreChecksum); +export function addressToEvm (address: string | Uint8Array, ignoreChecksum?: boolean): Uint8Array { + const decoded = decodeAddress(address, ignoreChecksum); return decoded.subarray(0, 20); } diff --git a/packages/util-crypto/src/address/check.spec.ts b/packages/util-crypto/src/address/check.spec.ts index 71ea92dfc..1090c04b2 100644 --- a/packages/util-crypto/src/address/check.spec.ts +++ b/packages/util-crypto/src/address/check.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import checkAddress from './check'; +import { checkAddress } from '.'; describe('checkAddress', (): void => { it('returns [true, null] for Kusama', (): void => { diff --git a/packages/util-crypto/src/address/check.ts b/packages/util-crypto/src/address/check.ts index a8a991ec0..29852d792 100644 --- a/packages/util-crypto/src/address/check.ts +++ b/packages/util-crypto/src/address/check.ts @@ -3,9 +3,9 @@ import { Prefix } from './types'; -import base58Decode from '../base58/decode'; -import checkChecksum from './checkChecksum'; -import defaults from './defaults'; +import { base58Decode } from '../base58/decode'; +import { checkAddressChecksum } from './checksum'; +import { defaults } from './defaults'; /** * @name checkAddress @@ -13,7 +13,7 @@ import defaults from './defaults'; * @description * From the provided input, validate that the address is a valid input. */ -export default function check (address: string, prefix: Prefix): [boolean, string | null] { +export function checkAddress (address: string, prefix: Prefix): [boolean, string | null] { let decoded; try { @@ -28,7 +28,7 @@ export default function check (address: string, prefix: Prefix): [boolean, strin return [false, 'Invalid decoded address length']; } - const [isValid] = checkChecksum(decoded); + const [isValid] = checkAddressChecksum(decoded); return [isValid, isValid ? null : 'Invalid decoded address checksum']; } diff --git a/packages/util-crypto/src/address/checkChecksum.ts b/packages/util-crypto/src/address/checksum.ts similarity index 84% rename from packages/util-crypto/src/address/checkChecksum.ts rename to packages/util-crypto/src/address/checksum.ts index 7cddd5830..5f7440e98 100644 --- a/packages/util-crypto/src/address/checkChecksum.ts +++ b/packages/util-crypto/src/address/checksum.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import sshash from './sshash'; +import { sshash } from './sshash'; -export default function checkChecksum (decoded: Uint8Array): [boolean, number] { +export function checkAddressChecksum (decoded: Uint8Array): [boolean, number] { const isPublicKey = [35, 36].includes(decoded.length); // non-publicKeys has 1 byte checksums, else default to 2 diff --git a/packages/util-crypto/src/address/decode.spec.ts b/packages/util-crypto/src/address/decode.spec.ts index 516ad9024..ebd0aeea6 100644 --- a/packages/util-crypto/src/address/decode.spec.ts +++ b/packages/util-crypto/src/address/decode.spec.ts @@ -3,19 +3,19 @@ import { stringToU8a, u8aToHex, hexToU8a } from '@polkadot/util'; -import testingPairs, { TestKeyringMap } from '../../../keyring/src/testingPairs'; -import decode from './decode'; +import { TestKeyringMap, createTestPairs } from '../../../keyring/src/testingPairs'; +import { decodeAddress } from '.'; describe('decodeAddress', (): void => { let keyring: TestKeyringMap; beforeAll((): void => { - keyring = testingPairs({ type: 'sr25519' }); + keyring = createTestPairs({ type: 'sr25519' }); }); it('decodes an address', (): void => { expect( - decode('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY') + decodeAddress('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY') ).toEqual( keyring.alice.publicKey ); @@ -23,13 +23,13 @@ describe('decodeAddress', (): void => { it('decodes the council address', (): void => { expect( - u8aToHex(decode('F3opxRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29')) + u8aToHex(decodeAddress('F3opxRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29')) ).toEqual(u8aToHex(stringToU8a('modlpy/trsry'.padEnd(32, '\0')))); }); it('converts a publicKey (u8a) as-is', (): void => { expect( - decode(new Uint8Array([1, 2, 3])) + decodeAddress(new Uint8Array([1, 2, 3])) ).toEqual( new Uint8Array([1, 2, 3]) ); @@ -37,7 +37,7 @@ describe('decodeAddress', (): void => { it('converts a publicKey (hex) as-is', (): void => { expect( - decode('0x01020304') + decodeAddress('0x01020304') ).toEqual( new Uint8Array([1, 2, 3, 4]) ); @@ -45,37 +45,37 @@ describe('decodeAddress', (): void => { it('decodes a short address', (): void => { expect( - decode('F7NZ') + decodeAddress('F7NZ') ).toEqual(new Uint8Array([1])); }); it('decodes a 1-byte accountId (with prefix)', (): void => { expect( - decode('PqtB', false, 68) + decodeAddress('PqtB', false, 68) ).toEqual(new Uint8Array([1])); }); it('decodes a 2-byte accountId', (): void => { expect( - decode('2jpAFn', false, 68) + decodeAddress('2jpAFn', false, 68) ).toEqual(new Uint8Array([0, 1])); }); it('encodes a 4-byte address', (): void => { expect( - decode('as7QnGMf', false, 68) + decodeAddress('as7QnGMf', false, 68) ).toEqual(new Uint8Array([1, 2, 3, 4])); }); it('decodes a 8-byte address', (): void => { expect( - decode('4q7qY5RBG7Z4wv', false, 68) + decodeAddress('4q7qY5RBG7Z4wv', false, 68) ).toEqual(new Uint8Array([42, 44, 10, 0, 0, 0, 0, 0])); }); it('decodes a 33-byte address', (): void => { expect( - decode('KWCv1L3QX9LDPwY4VzvLmarEmXjVJidUzZcinvVnmxAJJCBou') + decodeAddress('KWCv1L3QX9LDPwY4VzvLmarEmXjVJidUzZcinvVnmxAJJCBou') ).toEqual( hexToU8a('0x03b9dc646dd71118e5f7fda681ad9eca36eb3ee96f344f582fbe7b5bcdebb13077') ); @@ -83,28 +83,28 @@ describe('decodeAddress', (): void => { it.skip('allows invalid prefix (in list)', (): void => { expect( - (): Uint8Array => decode('6GfvWUvHvU8otbZ7sFhXH4eYeMcKdUkL61P3nFy52efEPVUx') + (): Uint8Array => decodeAddress('6GfvWUvHvU8otbZ7sFhXH4eYeMcKdUkL61P3nFy52efEPVUx') ).toThrow(/address prefix/); }); it('fails when length is invalid', (): void => { expect( - (): Uint8Array => decode('y9EMHt34JJo4rWLSaxoLGdYXvjgSXEd4zHUnQgfNzwES8b') + (): Uint8Array => decodeAddress('y9EMHt34JJo4rWLSaxoLGdYXvjgSXEd4zHUnQgfNzwES8b') ).toThrow(/address length/); }); it('fails when the checksum does not match', (): void => { expect( - (): Uint8Array => decode('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMa9cj') + (): Uint8Array => decodeAddress('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMa9cj') ).toThrow(/address checksum/); expect( - (): Uint8Array => decode('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDwU') + (): Uint8Array => decodeAddress('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDwU') ).toThrow(/address checksum/); }); it('fails when invalid base58 encoded address is found', (): void => { expect( - () => u8aToHex(decode('F3opIRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29')) + () => u8aToHex(decodeAddress('F3opIRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29')) ).toThrow(/Decoding F3opIRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29: Invalid base58 character "I" \(0x49\) at index 4/); }); }); diff --git a/packages/util-crypto/src/address/decode.ts b/packages/util-crypto/src/address/decode.ts index ac01edac3..bcd3b0668 100644 --- a/packages/util-crypto/src/address/decode.ts +++ b/packages/util-crypto/src/address/decode.ts @@ -7,12 +7,12 @@ import { Prefix } from './types'; import { assert, isHex, isU8a, u8aToU8a } from '@polkadot/util'; -import base58Decode from '../base58/decode'; -import checkChecksum from './checkChecksum'; -import defaults from './defaults'; +import { base58Decode } from '../base58/decode'; +import { checkAddressChecksum } from './checksum'; +import { defaults } from './defaults'; // eslint-disable-next-line @typescript-eslint/no-unused-vars -export default function decode (encoded: string | Uint8Array, ignoreChecksum?: boolean, ss58Format: Prefix = 99): Uint8Array { +export function decodeAddress (encoded: string | Uint8Array, ignoreChecksum?: boolean, ss58Format: Prefix = -1): Uint8Array { if (isU8a(encoded) || isHex(encoded)) { return u8aToU8a(encoded); } @@ -30,11 +30,11 @@ export default function decode (encoded: string | Uint8Array, ignoreChecksum?: b assert(defaults.allowedEncodedLengths.includes(decoded.length), wrapError('Invalid decoded address length')); // TODO Unless it is an "use everywhere" prefix, throw an error - // if (decoded[0] !== prefix) { - // console.log(`WARN: Expected ${prefix}, found ${decoded[0]}`); + // if (ss58Format !== -1 && (decoded[0] !== ss58Format)) { + // console.log(`WARN: Expected ${ss58Format}, found ${decoded[0]}`); // } - const [isValid, endPos] = checkChecksum(decoded); + const [isValid, endPos] = checkAddressChecksum(decoded); assert(ignoreChecksum || isValid, wrapError('Invalid decoded address checksum')); diff --git a/packages/util-crypto/src/address/defaults.ts b/packages/util-crypto/src/address/defaults.ts index 0adb47636..fa8287e51 100644 --- a/packages/util-crypto/src/address/defaults.ts +++ b/packages/util-crypto/src/address/defaults.ts @@ -3,12 +3,10 @@ import { available } from '@polkadot/networks'; -const defaults = { +export const defaults = { allowedDecodedLengths: [1, 2, 4, 8, 32, 33], // publicKey has prefix + 2 checksum bytes, short only prefix + 1 checksum byte allowedEncodedLengths: [3, 4, 6, 10, 35, 36], allowedPrefix: available.map(({ prefix }) => prefix), prefix: 42 }; - -export default defaults; diff --git a/packages/util-crypto/src/address/derive.spec.ts b/packages/util-crypto/src/address/derive.spec.ts index 6785df861..76d625a7c 100644 --- a/packages/util-crypto/src/address/derive.spec.ts +++ b/packages/util-crypto/src/address/derive.spec.ts @@ -3,7 +3,7 @@ import { waitReady } from '@polkadot/wasm-crypto'; -import derive from './derive'; +import { deriveAddress } from '.'; describe('deriveAddress', (): void => { beforeEach(async (): Promise => { @@ -12,13 +12,13 @@ describe('deriveAddress', (): void => { it('derives a known path', (): void => { expect( - derive('5CZtJLXtVzrBJq1fMWfywDa6XuRwXekGdShPR4b8i9GWSbzB', '/joe/polkadot/0') + deriveAddress('5CZtJLXtVzrBJq1fMWfywDa6XuRwXekGdShPR4b8i9GWSbzB', '/joe/polkadot/0') ).toEqual('5GZ4srnepXvdsuNVoxCGyVZd8ScDm4gkGLTKuaGARy9akjTa'); }); it('fails on hard paths', (): void => { expect( - () => derive('5CZtJLXtVzrBJq1fMWfywDa6XuRwXekGdShPR4b8i9GWSbzB', '//bob') + () => deriveAddress('5CZtJLXtVzrBJq1fMWfywDa6XuRwXekGdShPR4b8i9GWSbzB', '//bob') ).toThrow(/Expected suri to contain a combination of non-hard paths/); }); }); diff --git a/packages/util-crypto/src/address/derive.ts b/packages/util-crypto/src/address/derive.ts index 43b2d80f6..95b034807 100644 --- a/packages/util-crypto/src/address/derive.ts +++ b/packages/util-crypto/src/address/derive.ts @@ -5,11 +5,11 @@ import { Prefix } from './types'; import { assert } from '@polkadot/util'; -import DeriveJunction from '../key/DeriveJunction'; +import { DeriveJunction } from '../key/DeriveJunction'; import { keyExtractPath } from '../key'; import { schnorrkelDerivePublic } from '../schnorrkel'; -import decode from './decode'; -import encode from './encode'; +import { decodeAddress } from './decode'; +import { encodeAddress } from './encode'; /** * @name deriveAddress @@ -17,12 +17,12 @@ import encode from './encode'; * @description * Creates a sr25519 derived address based on the input address/publicKey and the uri supplied. */ -export default function deriveAddress (who: Uint8Array | string, suri: string, ss58Format?: Prefix): string { +export function deriveAddress (who: Uint8Array | string, suri: string, ss58Format?: Prefix): string { const { path } = keyExtractPath(suri); assert(path.length && !path.some((path) => path.isHard), 'Expected suri to contain a combination of non-hard paths'); - return encode(path.reduce((publicKey: Uint8Array, path: DeriveJunction): Uint8Array => { + return encodeAddress(path.reduce((publicKey: Uint8Array, path: DeriveJunction): Uint8Array => { return schnorrkelDerivePublic(publicKey, path.chainCode); - }, decode(who)), ss58Format); + }, decodeAddress(who)), ss58Format); } diff --git a/packages/util-crypto/src/address/encode.spec.ts b/packages/util-crypto/src/address/encode.spec.ts index df1f54fb3..bdabface8 100644 --- a/packages/util-crypto/src/address/encode.spec.ts +++ b/packages/util-crypto/src/address/encode.spec.ts @@ -1,11 +1,11 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import testingPairs from '@polkadot/keyring/testingPairs'; +import { createTestPairs } from '@polkadot/keyring/testingPairs'; -import encode from './encode'; +import { encodeAddress } from '.'; -const keyring = testingPairs({ type: 'ed25519' }, false); +const keyring = createTestPairs({ type: 'ed25519' }, false); describe('encode', (): void => { it('encodes an address to a valid value', (): void => { @@ -16,19 +16,19 @@ describe('encode', (): void => { it('can re-encode an address', (): void => { expect( - encode('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 68) + encodeAddress('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 68) ).toEqual('7sL6eNJj5ZGV5cn3hhV2deRUsivXfBfMH76wCALCqWj1EKzv'); }); it('can re-encode an address to Polkadot live', (): void => { expect( - encode('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 0) + encodeAddress('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 0) ).toEqual('15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5'); }); it('fails when non-valid publicKey provided', (): void => { expect( - (): string => encode( + (): string => encodeAddress( keyring.alice.publicKey.slice(0, 30) ) ).toThrow(/Expected a valid key/); @@ -36,7 +36,7 @@ describe('encode', (): void => { it('encodes a 1-byte address', (): void => { expect( - encode( + encodeAddress( new Uint8Array([1]) ) ).toEqual('F7NZ'); @@ -44,7 +44,7 @@ describe('encode', (): void => { it('encodes a 1-byte address (with prefix)', (): void => { expect( - encode( + encodeAddress( new Uint8Array([1]), 68 ) ).toEqual('PqtB'); @@ -52,7 +52,7 @@ describe('encode', (): void => { it('encodes a 2-byte address', (): void => { expect( - encode( + encodeAddress( new Uint8Array([0, 1]), 68 ) ).toEqual('2jpAFn'); @@ -60,7 +60,7 @@ describe('encode', (): void => { it('encodes a 4-byte address', (): void => { expect( - encode( + encodeAddress( new Uint8Array([1, 2, 3, 4]), 68 ) ).toEqual('as7QnGMf'); @@ -68,7 +68,7 @@ describe('encode', (): void => { it('encodes a 8-byte address', (): void => { expect( - encode( + encodeAddress( new Uint8Array([42, 44, 10, 0, 0, 0, 0, 0]), 68 ) ).toEqual('4q7qY5RBG7Z4wv'); @@ -76,7 +76,7 @@ describe('encode', (): void => { it('encodes an 33-byte address', (): void => { expect( - encode('0x03b9dc646dd71118e5f7fda681ad9eca36eb3ee96f344f582fbe7b5bcdebb13077') + encodeAddress('0x03b9dc646dd71118e5f7fda681ad9eca36eb3ee96f344f582fbe7b5bcdebb13077') ).toEqual('KWCv1L3QX9LDPwY4VzvLmarEmXjVJidUzZcinvVnmxAJJCBou'); }); }); diff --git a/packages/util-crypto/src/address/encode.ts b/packages/util-crypto/src/address/encode.ts index 4a7857cb6..6352df867 100644 --- a/packages/util-crypto/src/address/encode.ts +++ b/packages/util-crypto/src/address/encode.ts @@ -7,14 +7,14 @@ import { Prefix } from './types'; import { assert, u8aConcat } from '@polkadot/util'; -import base58Encode from '../base58/encode'; -import decode from './decode'; -import defaults from './defaults'; -import sshash from './sshash'; +import { base58Encode } from '../base58/encode'; +import { decodeAddress } from './decode'; +import { defaults } from './defaults'; +import { sshash } from './sshash'; -export default function encode (_key: Uint8Array | string, ss58Format: Prefix = defaults.prefix): string { +export function encodeAddress (_key: Uint8Array | string, ss58Format: Prefix = defaults.prefix): string { // decode it, this means we can re-encode an address - const key = decode(_key); + const key = decodeAddress(_key); assert(defaults.allowedDecodedLengths.includes(key.length), `Expected a valid key to convert, with length ${defaults.allowedDecodedLengths.join(', ')}`); diff --git a/packages/util-crypto/src/address/encodeDerived.spec.ts b/packages/util-crypto/src/address/encodeDerived.spec.ts index 8b2d797f8..6cc3e7dd7 100644 --- a/packages/util-crypto/src/address/encodeDerived.spec.ts +++ b/packages/util-crypto/src/address/encodeDerived.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import encodeDerivedAddress from './encodeDerived'; +import { encodeDerivedAddress } from '.'; describe('encodeDerivedAddress', (): void => { it('creates a valid known derived address', (): void => { diff --git a/packages/util-crypto/src/address/encodeDerived.ts b/packages/util-crypto/src/address/encodeDerived.ts index f9ae846d9..572a71013 100644 --- a/packages/util-crypto/src/address/encodeDerived.ts +++ b/packages/util-crypto/src/address/encodeDerived.ts @@ -5,9 +5,9 @@ import { Prefix } from './types'; import BN from 'bn.js'; -import decode from './decode'; -import encode from './encode'; -import keyDerived from './keyDerived'; +import { decodeAddress } from './decode'; +import { encodeAddress } from './encode'; +import { createKeyDerived } from './keyDerived'; /** * @name encodeDerivedAddress @@ -15,6 +15,6 @@ import keyDerived from './keyDerived'; * @description * Creates a Substrate derived address based on the input address/publicKey and the index supplied. */ -export default function encodeDerivedAddress (who: Uint8Array | string, index: BigInt | BN | number, ss58Format?: Prefix): string { - return encode(keyDerived(decode(who), index), ss58Format); +export function encodeDerivedAddress (who: Uint8Array | string, index: BigInt | BN | number, ss58Format?: Prefix): string { + return encodeAddress(createKeyDerived(decodeAddress(who), index), ss58Format); } diff --git a/packages/util-crypto/src/address/encodeMulti.spec.ts b/packages/util-crypto/src/address/encodeMulti.spec.ts index 4504cc48a..b3ccf04e9 100644 --- a/packages/util-crypto/src/address/encodeMulti.spec.ts +++ b/packages/util-crypto/src/address/encodeMulti.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import encodeMultiAddress from './encodeMulti'; +import { encodeMultiAddress } from '.'; describe('encodeMultiAddress', (): void => { it('creates a valid known multi address', (): void => { diff --git a/packages/util-crypto/src/address/encodeMulti.ts b/packages/util-crypto/src/address/encodeMulti.ts index fa773bf97..174ae70a9 100644 --- a/packages/util-crypto/src/address/encodeMulti.ts +++ b/packages/util-crypto/src/address/encodeMulti.ts @@ -5,8 +5,8 @@ import { Prefix } from './types'; import BN from 'bn.js'; -import encode from './encode'; -import keyMulti from './keyMulti'; +import { encodeAddress } from './encode'; +import { createKeyMulti } from './keyMulti'; /** * @name encodeMultiAddress @@ -14,6 +14,6 @@ import keyMulti from './keyMulti'; * @description * Creates a Substrate multisig address based on the input address and the required threshold. */ -export default function encodeMultiAddress (who: (Uint8Array | string)[], threshold: BigInt | BN | number, ss58Format?: Prefix): string { - return encode(keyMulti(who, threshold), ss58Format); +export function encodeMultiAddress (who: (Uint8Array | string)[], threshold: BigInt | BN | number, ss58Format?: Prefix): string { + return encodeAddress(createKeyMulti(who, threshold), ss58Format); } diff --git a/packages/util-crypto/src/address/eq.spec.ts b/packages/util-crypto/src/address/eq.spec.ts index a91c63c1c..3a03db94b 100644 --- a/packages/util-crypto/src/address/eq.spec.ts +++ b/packages/util-crypto/src/address/eq.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import testingPairs from '@polkadot/keyring/testingPairs'; +import { createTestPairs } from '@polkadot/keyring/testingPairs'; import { addressEq } from '.'; describe('addressEq', (): void => { @@ -33,7 +33,7 @@ describe('addressEq', (): void => { }); it('returns true for equal, address vs publicKey', (): void => { - const keyring = testingPairs({ type: 'sr25519' }); + const keyring = createTestPairs({ type: 'sr25519' }); expect( addressEq( diff --git a/packages/util-crypto/src/address/eq.ts b/packages/util-crypto/src/address/eq.ts index 43cc6d036..f83c8bcc0 100644 --- a/packages/util-crypto/src/address/eq.ts +++ b/packages/util-crypto/src/address/eq.ts @@ -3,7 +3,7 @@ import { u8aEq } from '@polkadot/util'; -import decode from './decode'; +import { decodeAddress } from './decode'; /** * @name addressEq @@ -19,6 +19,6 @@ import decode from './decode'; * u8aEq(new Uint8Array([0x68, 0x65]), new Uint8Array([0x68, 0x65])); // true * ``` */ -export default function addressEq (a: string | Uint8Array, b: string | Uint8Array): boolean { - return u8aEq(decode(a), decode(b)); +export function addressEq (a: string | Uint8Array, b: string | Uint8Array): boolean { + return u8aEq(decodeAddress(a), decodeAddress(b)); } diff --git a/packages/util-crypto/src/address/evmToAddress.spec.ts b/packages/util-crypto/src/address/evmToAddress.spec.ts index dbe8395de..dfaae8011 100644 --- a/packages/util-crypto/src/address/evmToAddress.spec.ts +++ b/packages/util-crypto/src/address/evmToAddress.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import evmToAddress from './evmToAddress'; +import { evmToAddress } from '.'; describe('evmToAddress', (): void => { it('creates a valid known SS58 address', (): void => { diff --git a/packages/util-crypto/src/address/evmToAddress.ts b/packages/util-crypto/src/address/evmToAddress.ts index 747c5da88..ec768b72b 100644 --- a/packages/util-crypto/src/address/evmToAddress.ts +++ b/packages/util-crypto/src/address/evmToAddress.ts @@ -1,19 +1,19 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import encode from './encode'; import { Prefix } from './types'; -import hasher from '../secp256k1/hasher'; -import { HashType } from '../secp256k1/types'; - import { u8aConcat } from '@polkadot/util'; +import { secp256k1Hasher } from '../secp256k1/hasher'; +import { HashType } from '../secp256k1/types'; +import { encodeAddress } from './encode'; + /** * @name evmToAddress * @summary Converts an EVM address to its corresponding SS58 address. */ -export default function evmToAddress (evmAddress: string | Uint8Array, ss58Format?: Prefix, hashType: HashType = 'blake2'): string { +export function evmToAddress (evmAddress: string | Uint8Array, ss58Format?: Prefix, hashType: HashType = 'blake2'): string { const wrapError = (message: string) => `Converting ${evmAddress as string}: ${message}`; const message = u8aConcat('evm:', evmAddress); @@ -22,7 +22,7 @@ export default function evmToAddress (evmAddress: string | Uint8Array, ss58Forma throw new Error(wrapError('Invalid evm address length')); } - const address = hasher(hashType, message); + const address = secp256k1Hasher(hashType, message); - return encode(address, ss58Format); + return encodeAddress(address, ss58Format); } diff --git a/packages/util-crypto/src/address/index.ts b/packages/util-crypto/src/address/index.ts index 0436df5c2..3d68c388a 100644 --- a/packages/util-crypto/src/address/index.ts +++ b/packages/util-crypto/src/address/index.ts @@ -1,34 +1,17 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import addressToEvm from './addressToEvm'; -import checkAddress from './check'; -import checkAddressChecksum from './checkChecksum'; -import createKeyMulti from './keyMulti'; -import createKeyDerived from './keyDerived'; -import decodeAddress from './decode'; -import deriveAddress from './derive'; -import encodeAddress from './encode'; -import encodeDerivedAddress from './encodeDerived'; -import encodeMultiAddress from './encodeMulti'; -import evmToAddress from './evmToAddress'; -import addressEq from './eq'; -import setSS58Format from './setSS58Format'; -import sortAddresses from './sort'; - -export { - addressEq, - addressToEvm, - checkAddress, - checkAddressChecksum, - createKeyDerived, - createKeyMulti, - decodeAddress, - deriveAddress, - encodeAddress, - encodeDerivedAddress, - encodeMultiAddress, - evmToAddress, - setSS58Format, - sortAddresses -}; +export { addressToEvm } from './addressToEvm'; +export { checkAddress } from './check'; +export { checkAddressChecksum } from './checksum'; +export { createKeyMulti } from './keyMulti'; +export { createKeyDerived } from './keyDerived'; +export { decodeAddress } from './decode'; +export { deriveAddress } from './derive'; +export { encodeAddress } from './encode'; +export { encodeDerivedAddress } from './encodeDerived'; +export { encodeMultiAddress } from './encodeMulti'; +export { evmToAddress } from './evmToAddress'; +export { addressEq } from './eq'; +export { setSS58Format } from './setSS58Format'; +export { sortAddresses } from './sort'; diff --git a/packages/util-crypto/src/address/keyDerived.spec.ts b/packages/util-crypto/src/address/keyDerived.spec.ts index 223a119fd..9c05cca85 100644 --- a/packages/util-crypto/src/address/keyDerived.spec.ts +++ b/packages/util-crypto/src/address/keyDerived.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import createKeyDerived from './keyDerived'; +import { createKeyDerived } from '.'; describe('createKeyDerived', (): void => { it('matches sub accounts with Rust', (): void => { diff --git a/packages/util-crypto/src/address/keyDerived.ts b/packages/util-crypto/src/address/keyDerived.ts index ab181f9d3..ed3e9c35e 100644 --- a/packages/util-crypto/src/address/keyDerived.ts +++ b/packages/util-crypto/src/address/keyDerived.ts @@ -4,12 +4,12 @@ import BN from 'bn.js'; import { bnToU8a, stringToU8a, u8aConcat } from '@polkadot/util'; -import blake2AsU8a from '../blake2/asU8a'; -import decodeAddress from './decode'; +import { blake2AsU8a } from '../blake2/asU8a'; +import { decodeAddress } from './decode'; const PREFIX = stringToU8a('modlpy/utilisuba'); -export default function createKeyDerived (who: Uint8Array | string, index: BigInt | BN | number): Uint8Array { +export function createKeyDerived (who: Uint8Array | string, index: BigInt | BN | number): Uint8Array { return blake2AsU8a( u8aConcat( PREFIX, diff --git a/packages/util-crypto/src/address/keyMulti.ts b/packages/util-crypto/src/address/keyMulti.ts index b1a273d5e..43c52d88e 100644 --- a/packages/util-crypto/src/address/keyMulti.ts +++ b/packages/util-crypto/src/address/keyMulti.ts @@ -4,12 +4,12 @@ import BN from 'bn.js'; import { bnToU8a, compactToU8a, stringToU8a, u8aConcat, u8aSorted } from '@polkadot/util'; -import blake2AsU8a from '../blake2/asU8a'; -import decodeAddress from './decode'; +import { blake2AsU8a } from '../blake2/asU8a'; +import { decodeAddress } from './decode'; const PREFIX = stringToU8a('modlpy/utilisuba'); -export default function createKeyMulti (who: (Uint8Array | string)[], threshold: BigInt | BN | number): Uint8Array { +export function createKeyMulti (who: (Uint8Array | string)[], threshold: BigInt | BN | number): Uint8Array { return blake2AsU8a( u8aConcat( PREFIX, diff --git a/packages/util-crypto/src/address/setSS58Format.spec.ts b/packages/util-crypto/src/address/setSS58Format.spec.ts index 162da0bd6..b6c60e90b 100644 --- a/packages/util-crypto/src/address/setSS58Format.spec.ts +++ b/packages/util-crypto/src/address/setSS58Format.spec.ts @@ -1,8 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import encode from './encode'; -import setSS58Format from './setSS58Format'; +import { encodeAddress, setSS58Format } from '.'; describe('setSS58Format', (): void => { beforeEach((): void => { @@ -11,7 +10,7 @@ describe('setSS58Format', (): void => { it('sets and allows encoding using', (): void => { expect( - encode( + encodeAddress( new Uint8Array([1]) ) ).toEqual('PqtB'); diff --git a/packages/util-crypto/src/address/setSS58Format.ts b/packages/util-crypto/src/address/setSS58Format.ts index 42a46835c..c67461cea 100644 --- a/packages/util-crypto/src/address/setSS58Format.ts +++ b/packages/util-crypto/src/address/setSS58Format.ts @@ -3,12 +3,12 @@ import { Prefix } from './types'; -import defaults from './defaults'; +import { defaults } from './defaults'; /** * @description Sets the global SS58 format to use for address encoding * @deprecated Use keyring.setSS58Format */ -export default function setSS58Format (prefix: Prefix): void { +export function setSS58Format (prefix: Prefix): void { defaults.prefix = prefix; } diff --git a/packages/util-crypto/src/address/sort.ts b/packages/util-crypto/src/address/sort.ts index 6f6a1e8e5..a9eab1ff7 100644 --- a/packages/util-crypto/src/address/sort.ts +++ b/packages/util-crypto/src/address/sort.ts @@ -5,10 +5,10 @@ import { Prefix } from './types'; import { u8aSorted } from '@polkadot/util'; -import decodeAddress from './decode'; -import encodeAddress from './encode'; +import { decodeAddress } from './decode'; +import { encodeAddress } from './encode'; -export default function sortAddresses (addresses: (Uint8Array | string)[], ss58Format?: Prefix): string[] { +export function sortAddresses (addresses: (Uint8Array | string)[], ss58Format?: Prefix): string[] { return u8aSorted( addresses.map((who) => decodeAddress(who)) ).map((u8a) => encodeAddress(u8a, ss58Format)); diff --git a/packages/util-crypto/src/address/sshash.ts b/packages/util-crypto/src/address/sshash.ts index c7f5dcb3e..619f7ab8b 100644 --- a/packages/util-crypto/src/address/sshash.ts +++ b/packages/util-crypto/src/address/sshash.ts @@ -3,10 +3,10 @@ import { stringToU8a, u8aConcat } from '@polkadot/util'; -import blake2AsU8a from '../blake2/asU8a'; +import { blake2AsU8a } from '../blake2/asU8a'; const SS58_PREFIX = stringToU8a('SS58PRE'); -export default function hash (key: Uint8Array): Uint8Array { +export function sshash (key: Uint8Array): Uint8Array { return blake2AsU8a(u8aConcat(SS58_PREFIX, key), 512); } diff --git a/packages/util-crypto/src/base32/decode.ts b/packages/util-crypto/src/base32/decode.ts index d778852e1..a5697cb72 100644 --- a/packages/util-crypto/src/base32/decode.ts +++ b/packages/util-crypto/src/base32/decode.ts @@ -6,7 +6,7 @@ import { assert } from '@polkadot/util'; import { BASE32_ALPHABET, BITS_PER_CHAR } from './bs32'; -import validate from './validate'; +import { base32Validate } from './validate'; // Build the character lookup table: const LOOKUP = BASE32_ALPHABET @@ -42,8 +42,8 @@ function decode (output: Uint8Array, input: string, offset: number): [Uint8Array * @description * From the provided input, decode the base32 and return the result as an `Uint8Array`. */ -export default function base32Decode (value: string, ipfsCompat = false): Uint8Array { - validate(value, ipfsCompat); +export function base32Decode (value: string, ipfsCompat = false): Uint8Array { + base32Validate(value, ipfsCompat); const offset = (ipfsCompat ? 1 : 0); const [output, bits, buffer] = decode( diff --git a/packages/util-crypto/src/base32/encode.ts b/packages/util-crypto/src/base32/encode.ts index bad95b03b..656cbba66 100644 --- a/packages/util-crypto/src/base32/encode.ts +++ b/packages/util-crypto/src/base32/encode.ts @@ -15,7 +15,7 @@ const MASK = (1 << BITS_PER_CHAR) - 1; * @description * From the provided input, create the base32 and return the result as a string. */ -export default function base32Encode (value: Uint8Array | string | Buffer | number[], ipfsCompat = false): string { +export function base32Encode (value: Uint8Array | string | Buffer | number[], ipfsCompat = false): string { const u8a = u8aToU8a(value); let out = ''; let bits = 0; diff --git a/packages/util-crypto/src/base32/index.ts b/packages/util-crypto/src/base32/index.ts index bb5ba14c7..d58e73038 100644 --- a/packages/util-crypto/src/base32/index.ts +++ b/packages/util-crypto/src/base32/index.ts @@ -5,7 +5,7 @@ * @summary Encode and decode base32 values */ -export { default as base32Decode } from './decode'; -export { default as base32Encode } from './encode'; -export { default as base32Validate } from './validate'; -export { default as isBase32 } from './is'; +export { base32Decode } from './decode'; +export { base32Encode } from './encode'; +export { base32Validate } from './validate'; +export { isBase32 } from './is'; diff --git a/packages/util-crypto/src/base32/is.ts b/packages/util-crypto/src/base32/is.ts index 93cdf849e..54bbf73c0 100644 --- a/packages/util-crypto/src/base32/is.ts +++ b/packages/util-crypto/src/base32/is.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import validate from './validate'; +import { base32Validate } from './validate'; export function testValidator (validate: (value?: string | null, ipfsCompat?: boolean) => boolean, value?: string | null, ipfsCompat?: boolean): boolean { try { @@ -11,6 +11,6 @@ export function testValidator (validate: (value?: string | null, ipfsCompat?: bo } } -export default function isBase32 (value?: string | null, ipfsCompat?: boolean): boolean { - return testValidator(validate, value, ipfsCompat); +export function isBase32 (value?: string | null, ipfsCompat?: boolean): boolean { + return testValidator(base32Validate, value, ipfsCompat); } diff --git a/packages/util-crypto/src/base32/validate.ts b/packages/util-crypto/src/base32/validate.ts index 351ecc282..f56e23015 100644 --- a/packages/util-crypto/src/base32/validate.ts +++ b/packages/util-crypto/src/base32/validate.ts @@ -12,6 +12,6 @@ const BASE_CONFIG = { alphabet: BASE32_ALPHABET, ipfsChar: 'b', type: 'base32' } * @description * Validates the the supplied value is valid base32 */ -export default function base32Validate (value?: string | null, ipfsCompat?: boolean): true { +export function base32Validate (value?: string | null, ipfsCompat?: boolean): true { return validateChars(BASE_CONFIG, value, ipfsCompat); } diff --git a/packages/util-crypto/src/base58/decode.ts b/packages/util-crypto/src/base58/decode.ts index 2d5dfa0a2..7e63abbc2 100644 --- a/packages/util-crypto/src/base58/decode.ts +++ b/packages/util-crypto/src/base58/decode.ts @@ -4,7 +4,7 @@ import { bufferToU8a } from '@polkadot/util'; import { bs58 } from './bs58'; -import validate from './validate'; +import { base58Validate } from './validate'; /** * @name base58Decode @@ -12,8 +12,8 @@ import validate from './validate'; * @description * From the provided input, decode the base58 and return the result as an `Uint8Array`. */ -export default function base58Decode (value: string, ipfsCompat?: boolean): Uint8Array { - validate(value, ipfsCompat); +export function base58Decode (value: string, ipfsCompat?: boolean): Uint8Array { + base58Validate(value, ipfsCompat); return bufferToU8a(bs58.decode(value.substr(ipfsCompat ? 1 : 0))); } diff --git a/packages/util-crypto/src/base58/encode.ts b/packages/util-crypto/src/base58/encode.ts index d561da3d4..f70c386a3 100644 --- a/packages/util-crypto/src/base58/encode.ts +++ b/packages/util-crypto/src/base58/encode.ts @@ -11,7 +11,7 @@ import { bs58 } from './bs58'; * @description * From the provided input, create the base58 and return the result as a string. */ -export default function base58Encode (value: Uint8Array | string | Buffer | number[], ipfsCompat?: boolean): string { +export function base58Encode (value: Uint8Array | string | Buffer | number[], ipfsCompat?: boolean): string { const out = bs58.encode( u8aToBuffer(u8aToU8a(value)) ); diff --git a/packages/util-crypto/src/base58/index.ts b/packages/util-crypto/src/base58/index.ts index 1768d99ca..6b4d8979e 100644 --- a/packages/util-crypto/src/base58/index.ts +++ b/packages/util-crypto/src/base58/index.ts @@ -5,7 +5,7 @@ * @summary Encode and decode base58 values */ -export { default as base58Decode } from './decode'; -export { default as base58Encode } from './encode'; -export { default as base58Validate } from './validate'; -export { default as isBase58 } from './is'; +export { base58Decode } from './decode'; +export { base58Encode } from './encode'; +export { base58Validate } from './validate'; +export { isBase58 } from './is'; diff --git a/packages/util-crypto/src/base58/is.ts b/packages/util-crypto/src/base58/is.ts index 02ed1beb1..77a10f570 100644 --- a/packages/util-crypto/src/base58/is.ts +++ b/packages/util-crypto/src/base58/is.ts @@ -2,8 +2,8 @@ // SPDX-License-Identifier: Apache-2.0 import { testValidator } from '../base32/is'; -import validate from './validate'; +import { base58Validate } from './validate'; -export default function isBase58 (value?: string | null, ipfsCompat?: boolean): boolean { - return testValidator(validate, value, ipfsCompat); +export function isBase58 (value?: string | null, ipfsCompat?: boolean): boolean { + return testValidator(base58Validate, value, ipfsCompat); } diff --git a/packages/util-crypto/src/base58/validate.ts b/packages/util-crypto/src/base58/validate.ts index 08348b6fe..5cd250831 100644 --- a/packages/util-crypto/src/base58/validate.ts +++ b/packages/util-crypto/src/base58/validate.ts @@ -30,6 +30,6 @@ export function validateChars ({ alphabet, ipfsChar, type }: CheckConfig, value? * @description * Validates the the supplied value is valid base58 */ -export default function base58Validate (value?: string | null, ipfsCompat?: boolean): true { +export function base58Validate (value?: string | null, ipfsCompat?: boolean): true { return validateChars(BASE_CONFIG, value, ipfsCompat); } diff --git a/packages/util-crypto/src/base64/decode.ts b/packages/util-crypto/src/base64/decode.ts index 256907b0a..b2db4b771 100644 --- a/packages/util-crypto/src/base64/decode.ts +++ b/packages/util-crypto/src/base64/decode.ts @@ -3,7 +3,7 @@ import { bufferToU8a } from '@polkadot/util'; -import validate from './validate'; +import { base64Validate } from './validate'; /** * @name base64Decode @@ -11,8 +11,8 @@ import validate from './validate'; * @description * From the provided input, decode the base64 and return the result as an `Uint8Array`. */ -export default function base64Decode (value: string): Uint8Array { - validate(value); +export function base64Decode (value: string): Uint8Array { + base64Validate(value); return bufferToU8a(Buffer.from(value, 'base64')); } diff --git a/packages/util-crypto/src/base64/encode.ts b/packages/util-crypto/src/base64/encode.ts index a0ef7038c..0c2f5ba1d 100644 --- a/packages/util-crypto/src/base64/encode.ts +++ b/packages/util-crypto/src/base64/encode.ts @@ -9,6 +9,6 @@ import { u8aToBuffer, u8aToU8a } from '@polkadot/util'; * @description * From the provided input, create the base64 and return the result as a string. */ -export default function base58Encode (value: Uint8Array | string | Buffer | number[]): string { +export function base64Encode (value: Uint8Array | string | Buffer | number[]): string { return u8aToBuffer(u8aToU8a(value)).toString('base64'); } diff --git a/packages/util-crypto/src/base64/index.ts b/packages/util-crypto/src/base64/index.ts index f23cf963c..85c214a83 100644 --- a/packages/util-crypto/src/base64/index.ts +++ b/packages/util-crypto/src/base64/index.ts @@ -5,9 +5,9 @@ * @summary Encode and decode base64 values */ -export { default as base64Decode } from './decode'; -export { default as base64Encode } from './encode'; -export { default as base64Pad } from './pad'; -export { default as base64Trim } from './trim'; -export { default as base64Validate } from './validate'; -export { default as isBase64 } from './is'; +export { base64Decode } from './decode'; +export { base64Encode } from './encode'; +export { base64Pad } from './pad'; +export { base64Trim } from './trim'; +export { base64Validate } from './validate'; +export { isBase64 } from './is'; diff --git a/packages/util-crypto/src/base64/is.ts b/packages/util-crypto/src/base64/is.ts index 5baa8d032..0856cd429 100644 --- a/packages/util-crypto/src/base64/is.ts +++ b/packages/util-crypto/src/base64/is.ts @@ -1,11 +1,11 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import validate from './validate'; +import { base64Validate } from './validate'; -export default function isBase64 (value?: string | null): boolean { +export function isBase64 (value?: string | null): boolean { try { - return validate(value); + return base64Validate(value); } catch (error) { return false; } diff --git a/packages/util-crypto/src/base64/pad.ts b/packages/util-crypto/src/base64/pad.ts index 8b41ad2e0..ae1b5b79a 100644 --- a/packages/util-crypto/src/base64/pad.ts +++ b/packages/util-crypto/src/base64/pad.ts @@ -1,6 +1,6 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -export default function base64Trim (value: string): string { +export function base64Pad (value: string): string { return value.padEnd(value.length + (value.length % 4), '='); } diff --git a/packages/util-crypto/src/base64/trim.ts b/packages/util-crypto/src/base64/trim.ts index a07017d73..30c9e2356 100644 --- a/packages/util-crypto/src/base64/trim.ts +++ b/packages/util-crypto/src/base64/trim.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -export default function base64Trim (value: string): string { +export function base64Trim (value: string): string { while (value.length && value[value.length - 1] === '=') { value = value.slice(0, -1); } diff --git a/packages/util-crypto/src/base64/validate.ts b/packages/util-crypto/src/base64/validate.ts index 80d1d7fa8..b651f3afe 100644 --- a/packages/util-crypto/src/base64/validate.ts +++ b/packages/util-crypto/src/base64/validate.ts @@ -9,7 +9,7 @@ import { assert } from '@polkadot/util'; * @description * Validates the the supplied value is valid base64 */ -export default function base64Validate (value?: string | null): true { +export function base64Validate (value?: string | null): true { assert(value, 'Expected non-null, non-empty base64 input'); assert(/^(?:[A-Za-z0-9+/]{2}[A-Za-z0-9+/]{2})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(value), 'Invalid base64 encoding'); diff --git a/packages/util-crypto/src/blake2/asHex.ts b/packages/util-crypto/src/blake2/asHex.ts index 80d5d9c58..d4837ab2a 100644 --- a/packages/util-crypto/src/blake2/asHex.ts +++ b/packages/util-crypto/src/blake2/asHex.ts @@ -3,7 +3,7 @@ import { u8aToHex } from '@polkadot/util'; -import blake2AsU8a from './asU8a'; +import { blake2AsU8a } from './asU8a'; /** * @name blake2AsHex @@ -19,7 +19,7 @@ import blake2AsU8a from './asU8a'; * blake2AsHex('abc'); // => 0xba80a53f981c4d0d * ``` */ -export default function blake2AsHex (data: Uint8Array | string, bitLength = 256): string { +export function blake2AsHex (data: Uint8Array | string, bitLength = 256): string { return u8aToHex( blake2AsU8a(data, bitLength) ); diff --git a/packages/util-crypto/src/blake2/asU8a.ts b/packages/util-crypto/src/blake2/asU8a.ts index 9c82e9863..a21d9da0e 100644 --- a/packages/util-crypto/src/blake2/asU8a.ts +++ b/packages/util-crypto/src/blake2/asU8a.ts @@ -19,7 +19,7 @@ import { blake2b, isReady } from '@polkadot/wasm-crypto'; * blake2AsU8a('abc'); // => [0xba, 0x80, 0xa53, 0xf98, 0x1c, 0x4d, 0x0d] * ``` */ -export default function blake2AsU8a (data: Uint8Array | string, bitLength = 256, key: Uint8Array | null = null, onlyJs = false): Uint8Array { +export function blake2AsU8a (data: Uint8Array | string, bitLength = 256, key: Uint8Array | null = null, onlyJs = false): Uint8Array { const byteLength = Math.ceil(bitLength / 8); return isReady() && !onlyJs diff --git a/packages/util-crypto/src/blake2/index.ts b/packages/util-crypto/src/blake2/index.ts index 85a7685cd..b4b51d709 100644 --- a/packages/util-crypto/src/blake2/index.ts +++ b/packages/util-crypto/src/blake2/index.ts @@ -5,5 +5,5 @@ * @summary Create blake2b values with specified bitlengths */ -export { default as blake2AsHex } from './asHex'; -export { default as blake2AsU8a } from './asU8a'; +export { blake2AsHex } from './asHex'; +export { blake2AsU8a } from './asU8a'; diff --git a/packages/util-crypto/src/ethereum/encode.ts b/packages/util-crypto/src/ethereum/encode.ts index 6dcfc0d6e..e1437e934 100644 --- a/packages/util-crypto/src/ethereum/encode.ts +++ b/packages/util-crypto/src/ethereum/encode.ts @@ -14,7 +14,7 @@ function getH160 (u8a: Uint8Array): Uint8Array { return u8a.slice(-20); } -export default function ethereumEncode (addressOrPublic?: string | Uint8Array): string { +export function ethereumEncode (addressOrPublic?: string | Uint8Array): string { if (!addressOrPublic) { return '0x'; } diff --git a/packages/util-crypto/src/ethereum/index.ts b/packages/util-crypto/src/ethereum/index.ts index 719beb9ee..42b311b1e 100644 --- a/packages/util-crypto/src/ethereum/index.ts +++ b/packages/util-crypto/src/ethereum/index.ts @@ -1,6 +1,6 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -export { default as ethereumEncode } from './encode'; -export { default as isEthereumAddress } from './isAddress'; -export { default as isEthereumChecksum } from './isChecksum'; +export { ethereumEncode } from './encode'; +export { isEthereumAddress } from './isAddress'; +export { isEthereumChecksum } from './isChecksum'; diff --git a/packages/util-crypto/src/ethereum/isAddress.ts b/packages/util-crypto/src/ethereum/isAddress.ts index 51a935285..fe13d0544 100644 --- a/packages/util-crypto/src/ethereum/isAddress.ts +++ b/packages/util-crypto/src/ethereum/isAddress.ts @@ -3,9 +3,9 @@ import { isHex } from '@polkadot/util'; -import isEthereumChecksum from './isChecksum'; +import { isEthereumChecksum } from './isChecksum'; -export default function isEthereumAddress (address?: string): boolean { +export function isEthereumAddress (address?: string): boolean { if (!address || address.length !== 42 || !isHex(address)) { return false; } diff --git a/packages/util-crypto/src/ethereum/isChecksum.ts b/packages/util-crypto/src/ethereum/isChecksum.ts index b442663d0..7de4c2ebf 100644 --- a/packages/util-crypto/src/ethereum/isChecksum.ts +++ b/packages/util-crypto/src/ethereum/isChecksum.ts @@ -9,7 +9,7 @@ function isInvalidChar (char: string, byte: number): boolean { return (byte > 7 && char !== char.toUpperCase()) || (byte <= 7 && char !== char.toLowerCase()); } -export default function isEthereumChecksum (_address: string): boolean { +export function isEthereumChecksum (_address: string): boolean { const address = _address.replace('0x', ''); const hash = u8aToHex(keccakAsU8a(address.toLowerCase()), -1, false); diff --git a/packages/util-crypto/src/keccak/asHex.ts b/packages/util-crypto/src/keccak/asHex.ts index 2e33ee49e..43c9b83b5 100644 --- a/packages/util-crypto/src/keccak/asHex.ts +++ b/packages/util-crypto/src/keccak/asHex.ts @@ -3,7 +3,7 @@ import { u8aToHex } from '@polkadot/util'; -import keccakAsU8a from './asU8a'; +import { keccakAsU8a } from './asU8a'; /** * @name keccakAsHex @@ -19,7 +19,7 @@ import keccakAsU8a from './asU8a'; * keccakAsHex('123'); // => 0x... * ``` */ -export default function keccakAsHex (value: Buffer | Uint8Array | string): string { +export function keccakAsHex (value: Buffer | Uint8Array | string): string { return u8aToHex( keccakAsU8a(value) ); diff --git a/packages/util-crypto/src/keccak/asU8a.ts b/packages/util-crypto/src/keccak/asU8a.ts index 50421fac1..e9d0e2cc3 100644 --- a/packages/util-crypto/src/keccak/asU8a.ts +++ b/packages/util-crypto/src/keccak/asU8a.ts @@ -19,7 +19,7 @@ import { isReady, keccak256 } from '@polkadot/wasm-crypto'; * keccakAsU8a('123'); // => Uint8Array * ``` */ -export default function keccakAsU8a (value: Buffer | Uint8Array | string): Uint8Array { +export function keccakAsU8a (value: Buffer | Uint8Array | string): Uint8Array { return isReady() ? keccak256(u8aToU8a(value)) : new Uint8Array( diff --git a/packages/util-crypto/src/keccak/index.ts b/packages/util-crypto/src/keccak/index.ts index ff50d73cd..f6291cfa3 100644 --- a/packages/util-crypto/src/keccak/index.ts +++ b/packages/util-crypto/src/keccak/index.ts @@ -5,5 +5,5 @@ * @summary Create Keccak256 values as hex & Uint8Array output */ -export { default as keccakAsHex } from './asHex'; -export { default as keccakAsU8a } from './asU8a'; +export { keccakAsHex } from './asHex'; +export { keccakAsU8a } from './asU8a'; diff --git a/packages/util-crypto/src/key/DeriveJunction.ts b/packages/util-crypto/src/key/DeriveJunction.ts index 62c5d3bc3..0aec02e65 100644 --- a/packages/util-crypto/src/key/DeriveJunction.ts +++ b/packages/util-crypto/src/key/DeriveJunction.ts @@ -5,7 +5,7 @@ import type BN from 'bn.js'; import { bnToHex, compactAddLength, hexToU8a, isBigInt, isBn, isHex, isNumber, isString, stringToU8a } from '@polkadot/util'; -import blake2AsU8a from '../blake2/asU8a'; +import { blake2AsU8a } from '../blake2/asU8a'; const RE_NUMBER = /^\d+$/; @@ -15,7 +15,7 @@ const BN_OPTIONS = { isLe: true }; -export default class DeriveJunction { +export class DeriveJunction { readonly #chainCode: Uint8Array = new Uint8Array(32); #isHard = false; diff --git a/packages/util-crypto/src/key/extractPath.spec.ts b/packages/util-crypto/src/key/extractPath.spec.ts index cb469055f..b0dcfc1aa 100644 --- a/packages/util-crypto/src/key/extractPath.spec.ts +++ b/packages/util-crypto/src/key/extractPath.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import keyExtractPath, { ExtractResult } from './extractPath'; +import { keyExtractPath, ExtractResult } from './extractPath'; describe('keyExtractPath', (): void => { it('extracts properly from soft', (): void => { diff --git a/packages/util-crypto/src/key/extractPath.ts b/packages/util-crypto/src/key/extractPath.ts index 21cec422b..1560ee334 100644 --- a/packages/util-crypto/src/key/extractPath.ts +++ b/packages/util-crypto/src/key/extractPath.ts @@ -1,9 +1,10 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import DeriveJunction from './DeriveJunction'; import { assert } from '@polkadot/util'; +import { DeriveJunction } from './DeriveJunction'; + const RE_JUNCTION = /\/(\/?)([^/]+)/g; export interface ExtractResult { @@ -14,7 +15,7 @@ export interface ExtractResult { /** * @description Extract derivation junctions from the supplied path */ -export default function keyExtractPath (derivePath: string): ExtractResult { +export function keyExtractPath (derivePath: string): ExtractResult { const parts = derivePath.match(RE_JUNCTION); const path: DeriveJunction[] = []; let constructed = ''; diff --git a/packages/util-crypto/src/key/extractSuri.spec.ts b/packages/util-crypto/src/key/extractSuri.spec.ts index 9562a347f..7bc192e45 100644 --- a/packages/util-crypto/src/key/extractSuri.spec.ts +++ b/packages/util-crypto/src/key/extractSuri.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import keyExtractSuri, { ExtractResult } from './extractSuri'; +import { keyExtractSuri, ExtractResult } from './extractSuri'; describe('keyExtractSuri', (): void => { it('does not extract from invalid suri', (): void => { diff --git a/packages/util-crypto/src/key/extractSuri.ts b/packages/util-crypto/src/key/extractSuri.ts index 34bd846c1..cd03a60c1 100644 --- a/packages/util-crypto/src/key/extractSuri.ts +++ b/packages/util-crypto/src/key/extractSuri.ts @@ -3,8 +3,8 @@ import { assert, isNull } from '@polkadot/util'; -import DeriveJunction from './DeriveJunction'; -import keyExtractPath from './extractPath'; +import { DeriveJunction } from './DeriveJunction'; +import { keyExtractPath } from './extractPath'; export interface ExtractResult { password?: string; @@ -17,7 +17,7 @@ const RE_CAPTURE = /^(\w+( \w+)*)((\/\/?[^/]+)*)(\/\/\/(.*))?$/; /** * @description Extracts the phrase, path and password from a SURI format for specifying secret keys `//////` (the `///password` may be omitted, and `/` and `//` maybe repeated and mixed). */ -export default function keyExtract (suri: string): ExtractResult { +export function keyExtractSuri (suri: string): ExtractResult { // eslint-disable-next-line @typescript-eslint/prefer-regexp-exec const matches = suri.match(RE_CAPTURE); diff --git a/packages/util-crypto/src/key/fromPath.ts b/packages/util-crypto/src/key/fromPath.ts index 6fb66606e..88f60d16a 100644 --- a/packages/util-crypto/src/key/fromPath.ts +++ b/packages/util-crypto/src/key/fromPath.ts @@ -3,20 +3,20 @@ import { KeypairType, Keypair } from '../types'; -import DeriveJunction from './DeriveJunction'; -import keyHdkdEd15519 from './hdkdEd25519'; -import keyHdkdSr15519 from './hdkdSr25519'; -import keyHdkdEcdsa from './hdkdEcdsa'; +import { DeriveJunction } from './DeriveJunction'; +import { keyHdkdEd25519 } from './hdkdEd25519'; +import { keyHdkdSr25519 } from './hdkdSr25519'; +import { keyHdkdEcdsa } from './hdkdEcdsa'; const generators = { ecdsa: keyHdkdEcdsa, - ed25519: keyHdkdEd15519, + ed25519: keyHdkdEd25519, // FIXME This is Substrate-compatible, not Ethereum-compatible ethereum: keyHdkdEcdsa, - sr25519: keyHdkdSr15519 + sr25519: keyHdkdSr25519 }; -export default function keyFromPath (pair: Keypair, path: DeriveJunction[], type: KeypairType): Keypair { +export function keyFromPath (pair: Keypair, path: DeriveJunction[], type: KeypairType): Keypair { const keyHdkd = generators[type]; return path.reduce((pair, junction): Keypair => { diff --git a/packages/util-crypto/src/key/hdkdEcdsa.ts b/packages/util-crypto/src/key/hdkdEcdsa.ts index 6b3a86319..4f90537b7 100644 --- a/packages/util-crypto/src/key/hdkdEcdsa.ts +++ b/packages/util-crypto/src/key/hdkdEcdsa.ts @@ -5,11 +5,11 @@ import { Keypair } from '../types'; import { assert } from '@polkadot/util'; -import secp256k1DeriveHard from '../secp256k1/deriveHard'; -import secp256k1KeypairFromSeed from '../secp256k1/keypair/fromSeed'; -import DeriveJunction from './DeriveJunction'; +import { secp256k1DeriveHard } from '../secp256k1/deriveHard'; +import { secp256k1KeypairFromSeed } from '../secp256k1/keypair/fromSeed'; +import { DeriveJunction } from './DeriveJunction'; -export default function keyHdkdEcdsa (keypair: Keypair, { chainCode, isHard }: DeriveJunction): Keypair { +export function keyHdkdEcdsa (keypair: Keypair, { chainCode, isHard }: DeriveJunction): Keypair { assert(isHard, 'A soft key was found in the path (and is unsupported)'); return secp256k1KeypairFromSeed( diff --git a/packages/util-crypto/src/key/hdkdEd25519.ts b/packages/util-crypto/src/key/hdkdEd25519.ts index 0b645fd46..d15de50be 100644 --- a/packages/util-crypto/src/key/hdkdEd25519.ts +++ b/packages/util-crypto/src/key/hdkdEd25519.ts @@ -5,11 +5,11 @@ import { Keypair } from '../types'; import { assert } from '@polkadot/util'; -import naclDeriveHard from '../nacl/deriveHard'; -import naclKeypairFromSeed from '../nacl/keypair/fromSeed'; -import DeriveJunction from './DeriveJunction'; +import { naclDeriveHard } from '../nacl/deriveHard'; +import { naclKeypairFromSeed } from '../nacl/keypair/fromSeed'; +import { DeriveJunction } from './DeriveJunction'; -export default function keyHdkdEd25519 (keypair: Keypair, { chainCode, isHard }: DeriveJunction): Keypair { +export function keyHdkdEd25519 (keypair: Keypair, { chainCode, isHard }: DeriveJunction): Keypair { assert(isHard, 'A soft key was found in the path (and is unsupported)'); return naclKeypairFromSeed( diff --git a/packages/util-crypto/src/key/hdkdSr25519.ts b/packages/util-crypto/src/key/hdkdSr25519.ts index d0f224c58..98c3a56e8 100644 --- a/packages/util-crypto/src/key/hdkdSr25519.ts +++ b/packages/util-crypto/src/key/hdkdSr25519.ts @@ -3,11 +3,11 @@ import { Keypair } from '../types'; -import schnorrkelDeriveHard from '../schnorrkel/deriveHard'; -import schnorrkelDeriveSoft from '../schnorrkel/deriveSoft'; -import DeriveJunction from './DeriveJunction'; +import { schnorrkelDeriveHard } from '../schnorrkel/deriveHard'; +import { schnorrkelDeriveSoft } from '../schnorrkel/deriveSoft'; +import { DeriveJunction } from './DeriveJunction'; -export default function keyHdkdSr25519 (keypair: Keypair, { chainCode, isSoft }: DeriveJunction): Keypair { +export function keyHdkdSr25519 (keypair: Keypair, { chainCode, isSoft }: DeriveJunction): Keypair { return isSoft ? schnorrkelDeriveSoft(keypair, chainCode) : schnorrkelDeriveHard(keypair, chainCode); diff --git a/packages/util-crypto/src/key/index.ts b/packages/util-crypto/src/key/index.ts index e880acca5..9316b010f 100644 --- a/packages/util-crypto/src/key/index.ts +++ b/packages/util-crypto/src/key/index.ts @@ -4,9 +4,9 @@ /** * @summary Create keys from paths, seeds and password */ -export { default as keyExtractPath } from './extractPath'; -export { default as keyExtractSuri } from './extractSuri'; -export { default as keyFromPath } from './fromPath'; -export { default as keyHdkdEd25519 } from './hdkdEd25519'; -export { default as keyHdkdSr25519 } from './hdkdEd25519'; -export { default as keyHdkdEcdsa } from './hdkdEcdsa'; +export { keyExtractPath } from './extractPath'; +export { keyExtractSuri } from './extractSuri'; +export { keyFromPath } from './fromPath'; +export { keyHdkdEd25519 } from './hdkdEd25519'; +export { keyHdkdSr25519 } from './hdkdSr25519'; +export { keyHdkdEcdsa } from './hdkdEcdsa'; diff --git a/packages/util-crypto/src/mnemonic/bip39.ts b/packages/util-crypto/src/mnemonic/bip39.ts index f6ae040f1..7a7896a6a 100644 --- a/packages/util-crypto/src/mnemonic/bip39.ts +++ b/packages/util-crypto/src/mnemonic/bip39.ts @@ -17,7 +17,7 @@ import createHash from 'create-hash'; import { pbkdf2Sync } from 'pbkdf2'; import { assert, u8aToU8a } from '@polkadot/util'; -import randomAsU8a from '../random/asU8a'; +import { randomAsU8a } from '../random/asU8a'; import DEFAULT_WORDLIST from './bip39-en'; const INVALID_MNEMONIC = 'Invalid mnemonic'; diff --git a/packages/util-crypto/src/mnemonic/generate.spec.ts b/packages/util-crypto/src/mnemonic/generate.spec.ts index 409e6834e..5904af050 100644 --- a/packages/util-crypto/src/mnemonic/generate.spec.ts +++ b/packages/util-crypto/src/mnemonic/generate.spec.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import generate, { WordCount } from './generate'; -import validate from './validate'; +import { mnemonicGenerate, WordCount } from './generate'; +import { mnemonicValidate } from './validate'; import { cryptoWaitReady } from '..'; describe('mnemonicGenerate', (): void => { @@ -12,15 +12,15 @@ describe('mnemonicGenerate', (): void => { it('generates a valid mnemonic (default strength)', (): void => { expect( - validate(generate()) + mnemonicValidate(mnemonicGenerate()) ).toEqual(true); }); [false, true].forEach((onlyJs): void => { ([12, 15, 18, 21, 24] as WordCount[]).forEach((num: WordCount): void => { it(`generates a valid mnemonic (${num} words, onlyJs=${onlyJs.toString()})`, (): void => { - const mnemonic = generate(num, onlyJs); - const isValid = validate(mnemonic); + const mnemonic = mnemonicGenerate(num, onlyJs); + const isValid = mnemonicValidate(mnemonic); expect(mnemonic.split(' ')).toHaveLength(num); expect(isValid).toEqual(true); @@ -31,12 +31,12 @@ describe('mnemonicGenerate', (): void => { [true, false].forEach((onlyJs): void => { it(`generates not deterministic (onlyJs=${onlyJs.toString()})`, (): void => { [false, true].forEach((onlyJs): void => { - const m1 = generate(24, onlyJs); - const m2 = generate(24, onlyJs); + const m1 = mnemonicGenerate(24, onlyJs); + const m2 = mnemonicGenerate(24, onlyJs); expect(m1 === m2).toEqual(false); - expect(validate(m1)).toEqual(true); - expect(validate(m2)).toEqual(true); + expect(mnemonicValidate(m1)).toEqual(true); + expect(mnemonicValidate(m2)).toEqual(true); }); }); }); diff --git a/packages/util-crypto/src/mnemonic/generate.ts b/packages/util-crypto/src/mnemonic/generate.ts index 59c21dba1..2098864e2 100644 --- a/packages/util-crypto/src/mnemonic/generate.ts +++ b/packages/util-crypto/src/mnemonic/generate.ts @@ -28,7 +28,7 @@ const STRENGTH_MAP = { * const mnemonic = mnemonicGenerate(); // => string * ``` */ -export default function mnemonicGenerate (numWords: WordCount = 12, onlyJs = false): string { +export function mnemonicGenerate (numWords: WordCount = 12, onlyJs = false): string { return isReady() && !onlyJs ? bip39Generate(numWords) : generateMnemonic(STRENGTH_MAP[numWords]); diff --git a/packages/util-crypto/src/mnemonic/index.ts b/packages/util-crypto/src/mnemonic/index.ts index 60fb04af8..ba75c31a6 100644 --- a/packages/util-crypto/src/mnemonic/index.ts +++ b/packages/util-crypto/src/mnemonic/index.ts @@ -4,8 +4,8 @@ /** * @summary Create valid mnemonic strings, validate them using BIP39, and convert them to valid seeds */ -export { default as mnemonicGenerate } from './generate'; -export { default as mnemonicToEntropy } from './toEntropy'; -export { default as mnemonicToLegacySeed } from './toLegacySeed'; -export { default as mnemonicToMiniSecret } from './toMiniSecret'; -export { default as mnemonicValidate } from './validate'; +export { mnemonicGenerate } from './generate'; +export { mnemonicToEntropy } from './toEntropy'; +export { mnemonicToLegacySeed } from './toLegacySeed'; +export { mnemonicToMiniSecret } from './toMiniSecret'; +export { mnemonicValidate } from './validate'; diff --git a/packages/util-crypto/src/mnemonic/toEntropy.spec.ts b/packages/util-crypto/src/mnemonic/toEntropy.spec.ts index 9dbf29380..0c4888b3a 100644 --- a/packages/util-crypto/src/mnemonic/toEntropy.spec.ts +++ b/packages/util-crypto/src/mnemonic/toEntropy.spec.ts @@ -3,7 +3,7 @@ import { u8aToHex } from '@polkadot/util'; -import toEntropy from './toEntropy'; +import { mnemonicToEntropy } from './toEntropy'; import tests from '../schnorrkel/keypair/testing'; import { cryptoWaitReady } from '..'; @@ -14,8 +14,8 @@ describe('mnemonicToEntropy', (): void => { tests.forEach(([mnemonic, entropy], index): void => { it(`Created correct entropy for ${index}`, (): void => { - expect(u8aToHex(toEntropy(mnemonic))).toEqual(entropy); - expect(u8aToHex(toEntropy(mnemonic, true))).toEqual(entropy); + expect(u8aToHex(mnemonicToEntropy(mnemonic))).toEqual(entropy); + expect(u8aToHex(mnemonicToEntropy(mnemonic, true))).toEqual(entropy); }); }); }); diff --git a/packages/util-crypto/src/mnemonic/toEntropy.ts b/packages/util-crypto/src/mnemonic/toEntropy.ts index 1ee0a8ca5..7dfe6932a 100644 --- a/packages/util-crypto/src/mnemonic/toEntropy.ts +++ b/packages/util-crypto/src/mnemonic/toEntropy.ts @@ -3,10 +3,10 @@ import { bip39ToEntropy, isReady } from '@polkadot/wasm-crypto'; -import { mnemonicToEntropy } from './bip39'; +import { mnemonicToEntropy as jsToEntropy } from './bip39'; -export default function toEntropy (mnemonic: string, onlyJs = false): Uint8Array { +export function mnemonicToEntropy (mnemonic: string, onlyJs = false): Uint8Array { return isReady() && !onlyJs ? bip39ToEntropy(mnemonic) - : mnemonicToEntropy(mnemonic); + : jsToEntropy(mnemonic); } diff --git a/packages/util-crypto/src/mnemonic/toLegacySeed.ts b/packages/util-crypto/src/mnemonic/toLegacySeed.ts index 2672dd8d8..74247910d 100644 --- a/packages/util-crypto/src/mnemonic/toLegacySeed.ts +++ b/packages/util-crypto/src/mnemonic/toLegacySeed.ts @@ -24,7 +24,7 @@ import { mnemonicToSeedSync } from './bip39'; * } * ``` */ -export default function toLegacy (mnemonic: string, password = '', onlyJs = false): Uint8Array { +export function mnemonicToLegacySeed (mnemonic: string, password = '', onlyJs = false): Uint8Array { return isReady() && !onlyJs ? bip39ToSeed(mnemonic, password) : bufferToU8a(mnemonicToSeedSync(mnemonic, password)).subarray(0, 32); diff --git a/packages/util-crypto/src/mnemonic/toMiniSecret.spec.ts b/packages/util-crypto/src/mnemonic/toMiniSecret.spec.ts index 7b4894d7d..30a4a160b 100644 --- a/packages/util-crypto/src/mnemonic/toMiniSecret.spec.ts +++ b/packages/util-crypto/src/mnemonic/toMiniSecret.spec.ts @@ -3,7 +3,7 @@ import { u8aToHex } from '@polkadot/util'; -import mnemonicToMiniSecret from './toMiniSecret'; +import { mnemonicToMiniSecret } from './toMiniSecret'; import tests from '../schnorrkel/keypair/testing'; import { cryptoWaitReady } from '..'; diff --git a/packages/util-crypto/src/mnemonic/toMiniSecret.ts b/packages/util-crypto/src/mnemonic/toMiniSecret.ts index dce4dd8ce..8942ecc57 100644 --- a/packages/util-crypto/src/mnemonic/toMiniSecret.ts +++ b/packages/util-crypto/src/mnemonic/toMiniSecret.ts @@ -5,14 +5,14 @@ import { pbkdf2Sync } from 'pbkdf2'; import { bufferToU8a, stringToU8a, u8aToBuffer } from '@polkadot/util'; import { bip39ToMiniSecret, isReady } from '@polkadot/wasm-crypto'; -import toEntropy from './toEntropy'; +import { mnemonicToEntropy } from './toEntropy'; -export default function toMiniSecret (mnemonic: string, password = '', onlyJs = false): Uint8Array { +export function mnemonicToMiniSecret (mnemonic: string, password = '', onlyJs = false): Uint8Array { if (isReady() && !onlyJs) { return bip39ToMiniSecret(mnemonic, password); } - const entropy = u8aToBuffer(toEntropy(mnemonic)); + const entropy = u8aToBuffer(mnemonicToEntropy(mnemonic)); const salt = u8aToBuffer(stringToU8a(`mnemonic${password}`)); // return the first 32 bytes as the seed diff --git a/packages/util-crypto/src/mnemonic/validate.spec.ts b/packages/util-crypto/src/mnemonic/validate.spec.ts index 3b7046f52..376539da3 100644 --- a/packages/util-crypto/src/mnemonic/validate.spec.ts +++ b/packages/util-crypto/src/mnemonic/validate.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import validate from './validate'; +import { mnemonicValidate } from './validate'; import { cryptoWaitReady } from '..'; describe('mnemonicValidate', (): void => { @@ -11,19 +11,19 @@ describe('mnemonicValidate', (): void => { it('returns true on valid', (): void => { expect( - validate('seed sock milk update focus rotate barely fade car face mechanic mercy') + mnemonicValidate('seed sock milk update focus rotate barely fade car face mechanic mercy') ).toEqual(true); expect( - validate('seed sock milk update focus rotate barely fade car face mechanic mercy', true) + mnemonicValidate('seed sock milk update focus rotate barely fade car face mechanic mercy', true) ).toEqual(true); }); it('returns false on invalid', (): void => { expect( - validate('wine photo extra cushion basket dwarf humor cloud truck job boat submit') + mnemonicValidate('wine photo extra cushion basket dwarf humor cloud truck job boat submit') ).toEqual(false); expect( - validate('wine photo extra cushion basket dwarf humor cloud truck job boat submit', true) + mnemonicValidate('wine photo extra cushion basket dwarf humor cloud truck job boat submit', true) ).toEqual(false); }); }); diff --git a/packages/util-crypto/src/mnemonic/validate.ts b/packages/util-crypto/src/mnemonic/validate.ts index a9a34dce0..2427cf821 100644 --- a/packages/util-crypto/src/mnemonic/validate.ts +++ b/packages/util-crypto/src/mnemonic/validate.ts @@ -18,7 +18,7 @@ import { validateMnemonic } from './bip39'; * const isValidMnemonic = mnemonicValidate(mnemonic); // => boolean * ``` */ -export default function mnemonicValidate (mnemonic: string, onlyJs = false): boolean { +export function mnemonicValidate (mnemonic: string, onlyJs = false): boolean { return isReady() && !onlyJs ? bip39Validate(mnemonic) : validateMnemonic(mnemonic); diff --git a/packages/util-crypto/src/nacl/box/fromSecret.ts b/packages/util-crypto/src/nacl/box/fromSecret.ts index 07a07fa0e..e20e3dec4 100644 --- a/packages/util-crypto/src/nacl/box/fromSecret.ts +++ b/packages/util-crypto/src/nacl/box/fromSecret.ts @@ -19,6 +19,6 @@ import nacl from 'tweetnacl'; * naclBoxKeypairFromSecret(...); // => { secretKey: [...], publicKey: [...] } * ``` */ -export default function naclBoxKeypairFromSecret (secret: Uint8Array): Keypair { +export function naclBoxKeypairFromSecret (secret: Uint8Array): Keypair { return nacl.box.keyPair.fromSecretKey(secret.slice(0, 32)); } diff --git a/packages/util-crypto/src/nacl/decrypt.ts b/packages/util-crypto/src/nacl/decrypt.ts index 02ac88218..462740ec1 100644 --- a/packages/util-crypto/src/nacl/decrypt.ts +++ b/packages/util-crypto/src/nacl/decrypt.ts @@ -17,6 +17,6 @@ import nacl from 'tweetnacl'; * naclDecrypt([...], [...], [...]); // => [...] * ``` */ -export default function naclDecrypt (encrypted: Uint8Array, nonce: Uint8Array, secret: Uint8Array): Uint8Array | null { +export function naclDecrypt (encrypted: Uint8Array, nonce: Uint8Array, secret: Uint8Array): Uint8Array | null { return nacl.secretbox.open(encrypted, nonce, secret) || null; } diff --git a/packages/util-crypto/src/nacl/deriveHard.ts b/packages/util-crypto/src/nacl/deriveHard.ts index 3fa5ec77d..62b646907 100644 --- a/packages/util-crypto/src/nacl/deriveHard.ts +++ b/packages/util-crypto/src/nacl/deriveHard.ts @@ -3,11 +3,11 @@ import { compactAddLength, stringToU8a, u8aConcat } from '@polkadot/util'; -import blake2AsU8a from '../blake2/asU8a'; +import { blake2AsU8a } from '../blake2/asU8a'; const HDKD = compactAddLength(stringToU8a('Ed25519HDKD')); -export default function deriveHard (seed: Uint8Array, chainCode: Uint8Array): Uint8Array { +export function naclDeriveHard (seed: Uint8Array, chainCode: Uint8Array): Uint8Array { return blake2AsU8a( u8aConcat(HDKD, seed, chainCode) ); diff --git a/packages/util-crypto/src/nacl/encrypt.ts b/packages/util-crypto/src/nacl/encrypt.ts index 95676c2d0..4499a6dc6 100644 --- a/packages/util-crypto/src/nacl/encrypt.ts +++ b/packages/util-crypto/src/nacl/encrypt.ts @@ -3,7 +3,7 @@ import nacl from 'tweetnacl'; -import randomAsU8a from '../random/asU8a'; +import { randomAsU8a } from '../random/asU8a'; interface Encrypted { encrypted: Uint8Array; @@ -24,7 +24,7 @@ interface Encrypted { * naclEncrypt([...], [...]); // => [...] * ``` */ -export default function naclEncrypt (message: Uint8Array, secret: Uint8Array, nonce: Uint8Array = randomAsU8a(24)): Encrypted { +export function naclEncrypt (message: Uint8Array, secret: Uint8Array, nonce: Uint8Array = randomAsU8a(24)): Encrypted { return { encrypted: nacl.secretbox(message, nonce, secret), nonce diff --git a/packages/util-crypto/src/nacl/index.ts b/packages/util-crypto/src/nacl/index.ts index 8f3dcd13f..3601c348e 100644 --- a/packages/util-crypto/src/nacl/index.ts +++ b/packages/util-crypto/src/nacl/index.ts @@ -4,15 +4,14 @@ /** * @summary Implements [NaCl](http://nacl.cr.yp.to/) secret-key authenticated encryption, public-key authenticated encryption, hashing, and public-key signatures */ -export { default as naclDecrypt } from './decrypt'; -export { default as deriveHard } from './deriveHard'; -export { default as naclEncrypt } from './encrypt'; -export { default as naclKeypairFromRandom } from './keypair/fromRandom'; -export { default as naclKeypairFromSecret } from './keypair/fromSecret'; -export { default as naclKeypairFromSeed } from './keypair/fromSeed'; -export { default as naclKeypairFromString } from './keypair/fromString'; -export { default as naclSign } from './sign'; -export { default as naclVerify } from './verify'; -export { default as naclBoxKeypairFromSecret } from './box/fromSecret'; -export { default as naclOpen } from './open'; -export { default as naclSeal } from './seal'; +export { naclDecrypt } from './decrypt'; +export { naclEncrypt } from './encrypt'; +export { naclKeypairFromRandom } from './keypair/fromRandom'; +export { naclKeypairFromSecret } from './keypair/fromSecret'; +export { naclKeypairFromSeed } from './keypair/fromSeed'; +export { naclKeypairFromString } from './keypair/fromString'; +export { naclSign } from './sign'; +export { naclVerify } from './verify'; +export { naclBoxKeypairFromSecret } from './box/fromSecret'; +export { naclOpen } from './open'; +export { naclSeal } from './seal'; diff --git a/packages/util-crypto/src/nacl/keypair/fromRandom.ts b/packages/util-crypto/src/nacl/keypair/fromRandom.ts index 87379728a..8c8ddb5be 100644 --- a/packages/util-crypto/src/nacl/keypair/fromRandom.ts +++ b/packages/util-crypto/src/nacl/keypair/fromRandom.ts @@ -19,6 +19,6 @@ import nacl from 'tweetnacl'; * naclKeypairFromRandom(); // => { secretKey: [...], publicKey: [...] } * ``` */ -export default function naclKeypairFromRandom (): Keypair { +export function naclKeypairFromRandom (): Keypair { return nacl.sign.keyPair(); } diff --git a/packages/util-crypto/src/nacl/keypair/fromSecret.ts b/packages/util-crypto/src/nacl/keypair/fromSecret.ts index 522c0f9f3..5373cf856 100644 --- a/packages/util-crypto/src/nacl/keypair/fromSecret.ts +++ b/packages/util-crypto/src/nacl/keypair/fromSecret.ts @@ -19,6 +19,6 @@ import nacl from 'tweetnacl'; * naclKeypairFromSecret(...); // => { secretKey: [...], publicKey: [...] } * ``` */ -export default function naclKeypairFromSecret (secret: Uint8Array): Keypair { +export function naclKeypairFromSecret (secret: Uint8Array): Keypair { return nacl.sign.keyPair.fromSecretKey(secret); } diff --git a/packages/util-crypto/src/nacl/keypair/fromSeed.ts b/packages/util-crypto/src/nacl/keypair/fromSeed.ts index 832f8a676..f5861858f 100644 --- a/packages/util-crypto/src/nacl/keypair/fromSeed.ts +++ b/packages/util-crypto/src/nacl/keypair/fromSeed.ts @@ -20,7 +20,7 @@ import { isReady, ed25519KeypairFromSeed } from '@polkadot/wasm-crypto'; * naclKeypairFromSeed(...); // => { secretKey: [...], publicKey: [...] } * ``` */ -export default function naclKeypairFromSeed (seed: Uint8Array): Keypair { +export function naclKeypairFromSeed (seed: Uint8Array): Keypair { if (isReady()) { const full = ed25519KeypairFromSeed(seed); diff --git a/packages/util-crypto/src/nacl/keypair/fromString.ts b/packages/util-crypto/src/nacl/keypair/fromString.ts index e7318766f..1f75dbeae 100644 --- a/packages/util-crypto/src/nacl/keypair/fromString.ts +++ b/packages/util-crypto/src/nacl/keypair/fromString.ts @@ -5,8 +5,8 @@ import { Keypair } from '../../types'; import { stringToU8a } from '@polkadot/util'; -import blake2AsU8a from '../../blake2/asU8a'; -import fromSeed from './fromSeed'; +import { blake2AsU8a } from '../../blake2/asU8a'; +import { naclKeypairFromSeed } from './fromSeed'; /** * @name naclKeypairFromString @@ -22,8 +22,8 @@ import fromSeed from './fromSeed'; * naclKeypairFromString('test'); // => { secretKey: [...], publicKey: [...] } * ``` */ -export default function naclKeypairFromString (value: string): Keypair { - return fromSeed( +export function naclKeypairFromString (value: string): Keypair { + return naclKeypairFromSeed( blake2AsU8a( stringToU8a(value), 256 diff --git a/packages/util-crypto/src/nacl/open.spec.ts b/packages/util-crypto/src/nacl/open.spec.ts index eed14c6ed..033f65d61 100644 --- a/packages/util-crypto/src/nacl/open.spec.ts +++ b/packages/util-crypto/src/nacl/open.spec.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 +import { keyFromPath } from '../key/fromPath'; +import { keyExtractPath } from '../key'; import { naclBoxKeypairFromSecret, naclKeypairFromString, naclOpen, naclSeal } from '.'; -import fromPath from '@polkadot/util-crypto/key/fromPath'; -import { keyExtractPath } from '@polkadot/util-crypto/key'; describe('naclOpen', (): void => { it('opens a sealed message by the sender', (): void => { @@ -26,8 +26,8 @@ describe('naclOpen', (): void => { const receiver = naclKeypairFromString('receiver'); // Make id key for identifying each other - const senderIdKey = fromPath(sender, keyExtractPath('//1//1//1//1').path, 'ed25519'); - const receiverIdKey = fromPath(receiver, keyExtractPath('//2//2//2//2').path, 'ed25519'); + const senderIdKey = keyFromPath(sender, keyExtractPath('//1//1//1//1').path, 'ed25519'); + const receiverIdKey = keyFromPath(receiver, keyExtractPath('//2//2//2//2').path, 'ed25519'); // Receiver sends encrypting public key to receive message to decrypt with his private key const receiverIdBoxKey = naclBoxKeypairFromSecret(receiverIdKey.secretKey); @@ -47,8 +47,8 @@ describe('naclOpen', (): void => { console.log(`The sealed message is ${opened?.toString() || 'null'}`); // Oh no the Id key is hacked, derive Id key again from another index - const senderIdKey2 = fromPath(sender, keyExtractPath('//1//1//1//2').path, 'ed25519'); - const receiverIdKey2 = fromPath(receiver, keyExtractPath('//2//2//2//3').path, 'ed25519'); + const senderIdKey2 = keyFromPath(sender, keyExtractPath('//1//1//1//2').path, 'ed25519'); + const receiverIdKey2 = keyFromPath(receiver, keyExtractPath('//2//2//2//3').path, 'ed25519'); // Receiver sends encrypting public key to receive message to decrypt with his private key const receiverIdBoxKey2 = naclBoxKeypairFromSecret(receiverIdKey2.secretKey); diff --git a/packages/util-crypto/src/nacl/open.ts b/packages/util-crypto/src/nacl/open.ts index c990fc3ac..2d6e9e622 100644 --- a/packages/util-crypto/src/nacl/open.ts +++ b/packages/util-crypto/src/nacl/open.ts @@ -17,6 +17,6 @@ import nacl from 'tweetnacl'; * naclOpen([...], [...], [...]); // => [...] * ``` */ -export default function naclOpen (sealed: Uint8Array, nonce: Uint8Array, senderBoxPublic: Uint8Array, receiverBoxSecret: Uint8Array): Uint8Array | null { +export function naclOpen (sealed: Uint8Array, nonce: Uint8Array, senderBoxPublic: Uint8Array, receiverBoxSecret: Uint8Array): Uint8Array | null { return nacl.box.open(sealed, nonce, senderBoxPublic, receiverBoxSecret) || null; } diff --git a/packages/util-crypto/src/nacl/seal.ts b/packages/util-crypto/src/nacl/seal.ts index d59966b17..f96e281ea 100644 --- a/packages/util-crypto/src/nacl/seal.ts +++ b/packages/util-crypto/src/nacl/seal.ts @@ -3,7 +3,7 @@ import nacl from 'tweetnacl'; -import randomAsU8a from '../random/asU8a'; +import { randomAsU8a } from '../random/asU8a'; interface Sealed { sealed: Uint8Array; @@ -24,7 +24,7 @@ interface Sealed { * naclSeal([...], [...], [...], [...]); // => [...] * ``` */ -export default function naclSeal (message: Uint8Array, senderBoxSecret: Uint8Array, receiverBoxPublic: Uint8Array, nonce: Uint8Array = randomAsU8a(24)): Sealed { +export function naclSeal (message: Uint8Array, senderBoxSecret: Uint8Array, receiverBoxPublic: Uint8Array, nonce: Uint8Array = randomAsU8a(24)): Sealed { return { nonce, sealed: nacl.box(message, nonce, receiverBoxPublic, senderBoxSecret) diff --git a/packages/util-crypto/src/nacl/sign.ts b/packages/util-crypto/src/nacl/sign.ts index 924cc1369..32275d773 100644 --- a/packages/util-crypto/src/nacl/sign.ts +++ b/packages/util-crypto/src/nacl/sign.ts @@ -21,7 +21,7 @@ import { isReady, ed25519Sign } from '@polkadot/wasm-crypto'; * naclSign([...], [...]); // => [...] * ``` */ -export default function naclSign (message: Uint8Array | string, { publicKey, secretKey }: Partial): Uint8Array { +export function naclSign (message: Uint8Array | string, { publicKey, secretKey }: Partial): Uint8Array { assert(secretKey, 'Expected a valid secretKey'); const messageU8a = u8aToU8a(message); diff --git a/packages/util-crypto/src/nacl/verify.ts b/packages/util-crypto/src/nacl/verify.ts index e805dfe93..dffd32905 100644 --- a/packages/util-crypto/src/nacl/verify.ts +++ b/packages/util-crypto/src/nacl/verify.ts @@ -19,7 +19,7 @@ import { isReady, ed25519Verify } from '@polkadot/wasm-crypto'; * naclVerify([...], [...], [...]); // => true/false * ``` */ -export default function naclVerify (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string): boolean { +export function naclVerify (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string): boolean { const messageU8a = u8aToU8a(message); const publicKeyU8a = u8aToU8a(publicKey); const signatureU8a = u8aToU8a(signature); diff --git a/packages/util-crypto/src/pbkdf2/encode.ts b/packages/util-crypto/src/pbkdf2/encode.ts index 8af5712ae..f0ab3ffa7 100644 --- a/packages/util-crypto/src/pbkdf2/encode.ts +++ b/packages/util-crypto/src/pbkdf2/encode.ts @@ -5,7 +5,7 @@ import { pbkdf2Sync } from 'pbkdf2'; import { bufferToU8a, u8aToBuffer, u8aToU8a } from '@polkadot/util'; import { isReady, pbkdf2 } from '@polkadot/wasm-crypto'; -import randomAsU8a from '../random/asU8a'; +import { randomAsU8a } from '../random/asU8a'; interface Result { password: Uint8Array; @@ -13,7 +13,7 @@ interface Result { salt: Uint8Array; } -export default function pbkdf2Encode (passphrase?: Uint8Array | string, salt = randomAsU8a(), rounds = 2048): Result { +export function pbkdf2Encode (passphrase?: Uint8Array | string, salt = randomAsU8a(), rounds = 2048): Result { const u8a = u8aToU8a(passphrase); const password = isReady() ? pbkdf2(u8a, salt, rounds) diff --git a/packages/util-crypto/src/pbkdf2/index.ts b/packages/util-crypto/src/pbkdf2/index.ts index 857b3e5e0..4ce16d7c3 100644 --- a/packages/util-crypto/src/pbkdf2/index.ts +++ b/packages/util-crypto/src/pbkdf2/index.ts @@ -1,4 +1,4 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -export { default as pbkdf2Encode } from './encode'; +export { pbkdf2Encode } from './encode'; diff --git a/packages/util-crypto/src/random/asHex.ts b/packages/util-crypto/src/random/asHex.ts index 9fe10b7ef..bd95b3812 100644 --- a/packages/util-crypto/src/random/asHex.ts +++ b/packages/util-crypto/src/random/asHex.ts @@ -3,7 +3,7 @@ import { u8aToHex } from '@polkadot/util'; -import randomAsU8a from './asU8a'; +import { randomAsU8a } from './asU8a'; /** * @name randomAsHex @@ -19,7 +19,7 @@ import randomAsU8a from './asU8a'; * randomAsHex(); // => 0x... * ``` */ -export default function randomAsHex (length = 32): string { +export function randomAsHex (length = 32): string { return u8aToHex( randomAsU8a(length) ); diff --git a/packages/util-crypto/src/random/asNumber.ts b/packages/util-crypto/src/random/asNumber.ts index a6fd8b6f6..8b74ad216 100644 --- a/packages/util-crypto/src/random/asNumber.ts +++ b/packages/util-crypto/src/random/asNumber.ts @@ -4,7 +4,7 @@ import BN from 'bn.js'; import { hexToBn } from '@polkadot/util'; -import randomAsHex from './asHex'; +import { randomAsHex } from './asHex'; const BN_53 = new BN(0b11111111111111111111111111111111111111111111111111111); @@ -22,7 +22,7 @@ const BN_53 = new BN(0b11111111111111111111111111111111111111111111111111111); * randomAsNumber(); // => * ``` */ -export default function randomAsNumber (): number { +export function randomAsNumber (): number { return hexToBn( randomAsHex(8) ).and(BN_53).toNumber(); diff --git a/packages/util-crypto/src/random/asU8a.ts b/packages/util-crypto/src/random/asU8a.ts index f8247f65b..825370ad5 100644 --- a/packages/util-crypto/src/random/asU8a.ts +++ b/packages/util-crypto/src/random/asU8a.ts @@ -17,6 +17,6 @@ import getRandomValues from '@polkadot/x-randomvalues'; * randomAsU8a(); // => Uint8Array([...]) * ``` */ -export default function randomAsU8a (length = 32): Uint8Array { +export function randomAsU8a (length = 32): Uint8Array { return getRandomValues(new Uint8Array(length)); } diff --git a/packages/util-crypto/src/random/index.ts b/packages/util-crypto/src/random/index.ts index 76602fa93..fb4952b8d 100644 --- a/packages/util-crypto/src/random/index.ts +++ b/packages/util-crypto/src/random/index.ts @@ -5,6 +5,6 @@ * @summary Returns a sequence of secure random bytes in a variety of formats */ -export { default as randomAsHex } from './asHex'; -export { default as randomAsNumber } from './asNumber'; -export { default as randomAsU8a } from './asU8a'; +export { randomAsHex } from './asHex'; +export { randomAsNumber } from './asNumber'; +export { randomAsU8a } from './asU8a'; diff --git a/packages/util-crypto/src/schnorrkel/deriveHard.ts b/packages/util-crypto/src/schnorrkel/deriveHard.ts index f204f15eb..75b7e674e 100644 --- a/packages/util-crypto/src/schnorrkel/deriveHard.ts +++ b/packages/util-crypto/src/schnorrkel/deriveHard.ts @@ -5,11 +5,11 @@ import { Keypair } from '../types'; import { sr25519DeriveKeypairHard } from '@polkadot/wasm-crypto'; -import keypairFromU8a from './keypair/fromU8a'; -import keypairToU8a from './keypair/toU8a'; +import { schnorrkelKeypairFromU8a } from './keypair/fromU8a'; +import { schnorrkelKeypairToU8a } from './keypair/toU8a'; -export default function deriveHard (keypair: Keypair, chainCode: Uint8Array): Keypair { - return keypairFromU8a( - sr25519DeriveKeypairHard(keypairToU8a(keypair), chainCode) +export function schnorrkelDeriveHard (keypair: Keypair, chainCode: Uint8Array): Keypair { + return schnorrkelKeypairFromU8a( + sr25519DeriveKeypairHard(schnorrkelKeypairToU8a(keypair), chainCode) ); } diff --git a/packages/util-crypto/src/schnorrkel/derivePublic.ts b/packages/util-crypto/src/schnorrkel/derivePublic.ts index dad1f607f..b94d29aa9 100644 --- a/packages/util-crypto/src/schnorrkel/derivePublic.ts +++ b/packages/util-crypto/src/schnorrkel/derivePublic.ts @@ -3,6 +3,6 @@ import { sr25519DerivePublicSoft } from '@polkadot/wasm-crypto'; -export default function deriveSoft (publicKey: Uint8Array, chainCode: Uint8Array): Uint8Array { +export function schnorrkelDerivePublic (publicKey: Uint8Array, chainCode: Uint8Array): Uint8Array { return sr25519DerivePublicSoft(publicKey, chainCode); } diff --git a/packages/util-crypto/src/schnorrkel/deriveSoft.ts b/packages/util-crypto/src/schnorrkel/deriveSoft.ts index e30fac9c8..cb1c3e842 100644 --- a/packages/util-crypto/src/schnorrkel/deriveSoft.ts +++ b/packages/util-crypto/src/schnorrkel/deriveSoft.ts @@ -5,11 +5,11 @@ import { Keypair } from '../types'; import { sr25519DeriveKeypairSoft } from '@polkadot/wasm-crypto'; -import keypairFromU8a from './keypair/fromU8a'; -import keypairToU8a from './keypair/toU8a'; +import { schnorrkelKeypairFromU8a } from './keypair/fromU8a'; +import { schnorrkelKeypairToU8a } from './keypair/toU8a'; -export default function deriveSoft (keypair: Keypair, chainCode: Uint8Array): Keypair { - return keypairFromU8a( - sr25519DeriveKeypairSoft(keypairToU8a(keypair), chainCode) +export function schnorrkelDeriveSoft (keypair: Keypair, chainCode: Uint8Array): Keypair { + return schnorrkelKeypairFromU8a( + sr25519DeriveKeypairSoft(schnorrkelKeypairToU8a(keypair), chainCode) ); } diff --git a/packages/util-crypto/src/schnorrkel/index.ts b/packages/util-crypto/src/schnorrkel/index.ts index 5c8a2efc0..ea24c3a71 100644 --- a/packages/util-crypto/src/schnorrkel/index.ts +++ b/packages/util-crypto/src/schnorrkel/index.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -export { default as schnorrkelDeriveHard } from './deriveHard'; -export { default as schnorrkelDerivePublic } from './derivePublic'; -export { default as schnorrkelDeriveSoft } from './deriveSoft'; -export { default as schnorrkelKeypairFromSeed } from './keypair/fromSeed'; -export { default as schnorrkelSign } from './sign'; -export { default as schnorrkelVerify } from './verify'; +export { schnorrkelDeriveHard } from './deriveHard'; +export { schnorrkelDerivePublic } from './derivePublic'; +export { schnorrkelDeriveSoft } from './deriveSoft'; +export { schnorrkelKeypairFromSeed } from './keypair/fromSeed'; +export { schnorrkelSign } from './sign'; +export { schnorrkelVerify } from './verify'; diff --git a/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts b/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts index 5cd5588c0..6bf998da7 100644 --- a/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts +++ b/packages/util-crypto/src/schnorrkel/keypair/fromSeed.ts @@ -5,14 +5,14 @@ import { Keypair } from '../../types'; import { sr25519KeypairFromSeed } from '@polkadot/wasm-crypto'; -import keypairFromU8a from './fromU8a'; +import { schnorrkelKeypairFromU8a } from './fromU8a'; /** * @name schnorrkelKeypairFromSeed * @description Returns a object containing a `publicKey` & `secretKey` generated from the supplied seed. */ -export default function schnorrkelKeypairFromSeed (seed: Uint8Array): Keypair { - return keypairFromU8a( +export function schnorrkelKeypairFromSeed (seed: Uint8Array): Keypair { + return schnorrkelKeypairFromU8a( sr25519KeypairFromSeed(seed) ); } diff --git a/packages/util-crypto/src/schnorrkel/keypair/fromU8a.ts b/packages/util-crypto/src/schnorrkel/keypair/fromU8a.ts index ae0f025b3..54d7178b4 100644 --- a/packages/util-crypto/src/schnorrkel/keypair/fromU8a.ts +++ b/packages/util-crypto/src/schnorrkel/keypair/fromU8a.ts @@ -6,7 +6,7 @@ import { Keypair } from '../../types'; const SEC_LEN = 64; const PUB_LEN = 32; -export default function schnorrkelKeypairFromU8a (full: Uint8Array): Keypair { +export function schnorrkelKeypairFromU8a (full: Uint8Array): Keypair { return { publicKey: full.slice(SEC_LEN, SEC_LEN + PUB_LEN), secretKey: full.slice(0, SEC_LEN) diff --git a/packages/util-crypto/src/schnorrkel/keypair/toU8a.ts b/packages/util-crypto/src/schnorrkel/keypair/toU8a.ts index 724a06f18..4aa12e0a3 100644 --- a/packages/util-crypto/src/schnorrkel/keypair/toU8a.ts +++ b/packages/util-crypto/src/schnorrkel/keypair/toU8a.ts @@ -5,6 +5,6 @@ import { Keypair } from '../../types'; import { u8aConcat } from '@polkadot/util'; -export default function schnorrkelKeypairToU8a ({ publicKey, secretKey }: Keypair): Uint8Array { +export function schnorrkelKeypairToU8a ({ publicKey, secretKey }: Keypair): Uint8Array { return u8aConcat(secretKey, publicKey).slice(); } diff --git a/packages/util-crypto/src/schnorrkel/sign.ts b/packages/util-crypto/src/schnorrkel/sign.ts index 442bd4b29..1defeeff6 100644 --- a/packages/util-crypto/src/schnorrkel/sign.ts +++ b/packages/util-crypto/src/schnorrkel/sign.ts @@ -10,7 +10,7 @@ import { sr25519Sign } from '@polkadot/wasm-crypto'; * @name schnorrkelSign * @description Returns message signature of `message`, using the supplied pair */ -export default function schnorrkelSign (message: Uint8Array | string, { publicKey, secretKey }: Partial): Uint8Array { +export function schnorrkelSign (message: Uint8Array | string, { publicKey, secretKey }: Partial): Uint8Array { assert(publicKey?.length === 32, 'Expected a valid publicKey, 32-bytes'); assert(secretKey?.length === 64, 'Expected a valid secretKey, 64-bytes'); diff --git a/packages/util-crypto/src/schnorrkel/signVerify.spec.ts b/packages/util-crypto/src/schnorrkel/signVerify.spec.ts index 170c02df2..560fb7883 100644 --- a/packages/util-crypto/src/schnorrkel/signVerify.spec.ts +++ b/packages/util-crypto/src/schnorrkel/signVerify.spec.ts @@ -4,10 +4,10 @@ import { stringToU8a } from '@polkadot/util'; import { waitReady } from '@polkadot/wasm-crypto'; -import randomAsU8a from '../random/asU8a'; -import pairFromSeed from './keypair/fromSeed'; -import sign from './sign'; -import verify from './verify'; +import { randomAsU8a } from '../random/asU8a'; +import { schnorrkelKeypairFromSeed } from './keypair/fromSeed'; +import { schnorrkelSign } from './sign'; +import { schnorrkelVerify } from './verify'; const MESSAGE = stringToU8a('this is a message'); @@ -17,21 +17,21 @@ describe('sign and verify', (): void => { }); it('has 64-byte signatures', (): void => { - const pair = pairFromSeed(randomAsU8a()); + const pair = schnorrkelKeypairFromSeed(randomAsU8a()); - expect(sign(MESSAGE, pair)).toHaveLength(64); + expect(schnorrkelSign(MESSAGE, pair)).toHaveLength(64); }); it('can sign and verify a message', (): void => { - const pair = pairFromSeed(randomAsU8a()); - const signature = sign(MESSAGE, pair); + const pair = schnorrkelKeypairFromSeed(randomAsU8a()); + const signature = schnorrkelSign(MESSAGE, pair); - expect(verify(MESSAGE, signature, pair.publicKey)).toBe(true); + expect(schnorrkelVerify(MESSAGE, signature, pair.publicKey)).toBe(true); }); it('throws error when publicKey lengths do not match', (): void => { expect( - () => verify( + () => schnorrkelVerify( new Uint8Array([0x61, 0x62, 0x63, 0x64]), new Uint8Array(64), new Uint8Array(31) @@ -41,7 +41,7 @@ describe('sign and verify', (): void => { it('throws error when signature lengths do not match', (): void => { expect( - () => verify( + () => schnorrkelVerify( new Uint8Array([0x61, 0x62, 0x63, 0x64]), new Uint8Array(65), new Uint8Array(32) diff --git a/packages/util-crypto/src/schnorrkel/verify.ts b/packages/util-crypto/src/schnorrkel/verify.ts index 3a3807600..4773286a9 100644 --- a/packages/util-crypto/src/schnorrkel/verify.ts +++ b/packages/util-crypto/src/schnorrkel/verify.ts @@ -8,7 +8,7 @@ import { sr25519Verify } from '@polkadot/wasm-crypto'; * @name schnorrkelVerify * @description Verifies the signature of `message`, using the supplied pair */ -export default function schnorrkelVerify (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string): boolean { +export function schnorrkelVerify (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string): boolean { const messageU8a = u8aToU8a(message); const publicKeyU8a = u8aToU8a(publicKey); const signatureU8a = u8aToU8a(signature); diff --git a/packages/util-crypto/src/scrypt/encode.ts b/packages/util-crypto/src/scrypt/encode.ts index ed90ca7e0..ed0c753b2 100644 --- a/packages/util-crypto/src/scrypt/encode.ts +++ b/packages/util-crypto/src/scrypt/encode.ts @@ -7,7 +7,7 @@ import scryptsy from 'scryptsy'; import { bufferToU8a, u8aToBuffer, u8aToU8a } from '@polkadot/util'; import { isReady, scrypt } from '@polkadot/wasm-crypto'; -import randomAsU8a from '../random/asU8a'; +import { randomAsU8a } from '../random/asU8a'; import { DEFAULT_PARAMS } from './defaults'; interface Result { @@ -16,7 +16,7 @@ interface Result { salt: Uint8Array; } -export default function scryptEncode (passphrase?: Uint8Array | string, salt = randomAsU8a(), params = DEFAULT_PARAMS): Result { +export function scryptEncode (passphrase?: Uint8Array | string, salt = randomAsU8a(), params = DEFAULT_PARAMS): Result { const password = isReady() ? scrypt(u8aToU8a(passphrase), salt, Math.log2(params.N), params.r, params.p) : bufferToU8a( diff --git a/packages/util-crypto/src/scrypt/fromU8a.ts b/packages/util-crypto/src/scrypt/fromU8a.ts index 7a645054a..3a970f186 100644 --- a/packages/util-crypto/src/scrypt/fromU8a.ts +++ b/packages/util-crypto/src/scrypt/fromU8a.ts @@ -12,7 +12,7 @@ interface Result { salt: Uint8Array; } -export default function scryptFromU8a (data: Uint8Array): Result { +export function scryptFromU8a (data: Uint8Array): Result { const salt = data.subarray(0, 32); const N = u8aToBn(data.subarray(32 + 0, 32 + 4), { isLe: true }).toNumber(); const p = u8aToBn(data.subarray(32 + 4, 32 + 8), { isLe: true }).toNumber(); diff --git a/packages/util-crypto/src/scrypt/index.ts b/packages/util-crypto/src/scrypt/index.ts index 2c224724f..6529fa154 100644 --- a/packages/util-crypto/src/scrypt/index.ts +++ b/packages/util-crypto/src/scrypt/index.ts @@ -1,6 +1,6 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -export { default as scryptEncode } from './encode'; -export { default as scryptFromU8a } from './fromU8a'; -export { default as scryptToU8a } from './toU8a'; +export { scryptEncode } from './encode'; +export { scryptFromU8a } from './fromU8a'; +export { scryptToU8a } from './toU8a'; diff --git a/packages/util-crypto/src/scrypt/toU8a.ts b/packages/util-crypto/src/scrypt/toU8a.ts index 522d2438d..c73a58ebe 100644 --- a/packages/util-crypto/src/scrypt/toU8a.ts +++ b/packages/util-crypto/src/scrypt/toU8a.ts @@ -5,7 +5,7 @@ import { Params } from './types'; import { bnToU8a, u8aConcat } from '@polkadot/util'; -export default function scryptToU8a (salt: Uint8Array, { N, p, r }: Params): Uint8Array { +export function scryptToU8a (salt: Uint8Array, { N, p, r }: Params): Uint8Array { return u8aConcat( salt, bnToU8a(N, { bitLength: 32, isLe: true }), diff --git a/packages/util-crypto/src/secp256k1/compress.ts b/packages/util-crypto/src/secp256k1/compress.ts index 68bce0b8b..928fc8033 100644 --- a/packages/util-crypto/src/secp256k1/compress.ts +++ b/packages/util-crypto/src/secp256k1/compress.ts @@ -1,15 +1,17 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import { ec as EC } from 'elliptic'; import { assert } from '@polkadot/util'; -const ec = new EC('secp256k1'); +import { secp256k1 } from './secp256k1'; -export default function secp256k1Compress (publicKey: Uint8Array): Uint8Array { +export function secp256k1Compress (publicKey: Uint8Array): Uint8Array { assert([33, 65].includes(publicKey.length), 'Invalid publicKey provided'); return new Uint8Array( - ec.keyFromPublic(publicKey).getPublic().encodeCompressed() + secp256k1 + .keyFromPublic(publicKey) + .getPublic() + .encodeCompressed() ); } diff --git a/packages/util-crypto/src/secp256k1/deriveHard.ts b/packages/util-crypto/src/secp256k1/deriveHard.ts index 0fa968321..289758ff0 100644 --- a/packages/util-crypto/src/secp256k1/deriveHard.ts +++ b/packages/util-crypto/src/secp256k1/deriveHard.ts @@ -3,11 +3,11 @@ import { compactAddLength, stringToU8a, u8aConcat } from '@polkadot/util'; -import blake2AsU8a from '../blake2/asU8a'; +import { blake2AsU8a } from '../blake2/asU8a'; const HDKD = compactAddLength(stringToU8a('Secp256k1HDKD')); -export default function deriveHard (seed: Uint8Array, chainCode: Uint8Array): Uint8Array { +export function secp256k1DeriveHard (seed: Uint8Array, chainCode: Uint8Array): Uint8Array { // NOTE This is specific to the Substrate HDD derivation, so always use the blake2 hasher return blake2AsU8a(u8aConcat(HDKD, seed, chainCode), 256); } diff --git a/packages/util-crypto/src/secp256k1/expand.ts b/packages/util-crypto/src/secp256k1/expand.ts index 6da55c29d..78fec13a9 100644 --- a/packages/util-crypto/src/secp256k1/expand.ts +++ b/packages/util-crypto/src/secp256k1/expand.ts @@ -1,18 +1,19 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import { ec as EC } from 'elliptic'; import { assert, bnToU8a, u8aConcat } from '@polkadot/util'; -const ec = new EC('secp256k1'); +import { EXPAND_OPT, secp256k1 } from './secp256k1'; -export default function secp256k1Expand (publicKey: Uint8Array): Uint8Array { +export function secp256k1Expand (publicKey: Uint8Array): Uint8Array { assert([33, 65].includes(publicKey.length), 'Invalid publicKey provided'); - const expanded = ec.keyFromPublic(publicKey).getPublic(); + const expanded = secp256k1 + .keyFromPublic(publicKey) + .getPublic(); return u8aConcat( - bnToU8a(expanded.getX(), { bitLength: 256, isLe: false }), - bnToU8a(expanded.getY(), { bitLength: 256, isLe: false }) + bnToU8a(expanded.getX(), EXPAND_OPT), + bnToU8a(expanded.getY(), EXPAND_OPT) ); } diff --git a/packages/util-crypto/src/secp256k1/hasher.spec.ts b/packages/util-crypto/src/secp256k1/hasher.spec.ts index 8ba0e1877..7010e224c 100644 --- a/packages/util-crypto/src/secp256k1/hasher.spec.ts +++ b/packages/util-crypto/src/secp256k1/hasher.spec.ts @@ -1,18 +1,18 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import hasher from './hasher'; +import { secp256k1Hasher } from './hasher'; describe('secp256k1Hasher', (): void => { it('fails with unknown hasher', (): void => { expect( - () => hasher('unknown' as 'blake2', 'testing') + () => secp256k1Hasher('unknown' as 'blake2', 'testing') ).toThrow(/Unsupported secp256k1 hasher 'unknown', expected one of blake2, keccak/); }); it('creates a blake2 hash', (): void => { expect( - hasher('blake2', 'abc') + secp256k1Hasher('blake2', 'abc') ).toEqual( new Uint8Array([189, 221, 129, 60, 99, 66, 57, 114, 49, 113, 239, 63, 238, 152, 87, 155, 148, 150, 78, 59, 177, 203, 62, 66, 114, 98, 200, 192, 104, 213, 35, 25]) ); @@ -20,7 +20,7 @@ describe('secp256k1Hasher', (): void => { it('creates a keccak hash', (): void => { expect( - hasher('keccak', 'abc') + secp256k1Hasher('keccak', 'abc') ).toEqual( new Uint8Array([78, 3, 101, 122, 234, 69, 169, 79, 199, 212, 123, 168, 38, 200, 214, 103, 192, 209, 230, 227, 58, 100, 160, 54, 236, 68, 245, 143, 161, 45, 108, 69]) ); diff --git a/packages/util-crypto/src/secp256k1/hasher.ts b/packages/util-crypto/src/secp256k1/hasher.ts index ca8f3a3e3..4b258cef7 100644 --- a/packages/util-crypto/src/secp256k1/hasher.ts +++ b/packages/util-crypto/src/secp256k1/hasher.ts @@ -8,7 +8,7 @@ import { keccakAsU8a } from '../keccak'; const HASH_TYPES = ['blake2', 'keccak']; -export default function secp256k1Hasher (hashType: HashType, data: Uint8Array | string): Uint8Array { +export function secp256k1Hasher (hashType: HashType, data: Uint8Array | string): Uint8Array { if (hashType === 'blake2') { return blake2AsU8a(data); } else if (hashType === 'keccak') { diff --git a/packages/util-crypto/src/secp256k1/index.ts b/packages/util-crypto/src/secp256k1/index.ts index eae9c95cf..b0b80f4d2 100644 --- a/packages/util-crypto/src/secp256k1/index.ts +++ b/packages/util-crypto/src/secp256k1/index.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -export { default as secp256k1Compress } from './compress'; -export { default as secp256k1Expand } from './expand'; -export { default as secp256k1KeypairFromSeed } from './keypair/fromSeed'; -export { default as secp256k1Recover } from './recover'; -export { default as secp256k1Verify } from './verify'; -export { default as secp256k1Sign } from './sign'; +export { secp256k1Compress } from './compress'; +export { secp256k1Expand } from './expand'; +export { secp256k1KeypairFromSeed } from './keypair/fromSeed'; +export { secp256k1Recover } from './recover'; +export { secp256k1Sign } from './sign'; +export { secp256k1Verify } from './verify'; diff --git a/packages/util-crypto/src/secp256k1/keypair/fromSeed.ts b/packages/util-crypto/src/secp256k1/keypair/fromSeed.ts index 625b18db4..34151370a 100644 --- a/packages/util-crypto/src/secp256k1/keypair/fromSeed.ts +++ b/packages/util-crypto/src/secp256k1/keypair/fromSeed.ts @@ -3,22 +3,21 @@ import { Keypair } from '../../types'; -import { ec as EC } from 'elliptic'; import { assert, bnToU8a } from '@polkadot/util'; -const ec = new EC('secp256k1'); +import { EXPAND_OPT, secp256k1 } from '../secp256k1'; /** * @name secp256k1KeypairFromSeed * @description Returns a object containing a `publicKey` & `secretKey` generated from the supplied seed. */ -export default function secp256k1KeypairFromSeed (seed: Uint8Array): Keypair { +export function secp256k1KeypairFromSeed (seed: Uint8Array): Keypair { assert(seed.length === 32, 'Expected valid 32-byte private key as a seed'); - const key = ec.keyFromPrivate(seed); + const key = secp256k1.keyFromPrivate(seed); return { publicKey: new Uint8Array(key.getPublic().encodeCompressed()), - secretKey: bnToU8a(key.getPrivate(), { bitLength: 256, isLe: false }) + secretKey: bnToU8a(key.getPrivate(), EXPAND_OPT) }; } diff --git a/packages/util-crypto/src/secp256k1/recover.ts b/packages/util-crypto/src/secp256k1/recover.ts index 5f792da43..705387e1a 100644 --- a/packages/util-crypto/src/secp256k1/recover.ts +++ b/packages/util-crypto/src/secp256k1/recover.ts @@ -1,18 +1,16 @@ // Copyright 2017-2020 @polkadot/util-crypto authors & contributors // SPDX-License-Identifier: Apache-2.0 -import { ec as EC } from 'elliptic'; - -const ec = new EC('secp256k1'); +import { secp256k1 } from './secp256k1'; /** * @name secp256k1Recover * @description Recovers a publicKey from the supplied signature */ -export default function secp256k1Recover (message: Uint8Array, signature: Uint8Array, recovery: number): Uint8Array { +export function secp256k1Recover (message: Uint8Array, signature: Uint8Array, recovery: number): Uint8Array { return new Uint8Array( // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access - ec + secp256k1 .recoverPubKey(message, { r: signature.slice(0, 32), s: signature.slice(32, 64) }, recovery) .encode(null, true) ); diff --git a/packages/util-crypto/src/secp256k1/secp256k1.ts b/packages/util-crypto/src/secp256k1/secp256k1.ts new file mode 100644 index 000000000..a8f090c5f --- /dev/null +++ b/packages/util-crypto/src/secp256k1/secp256k1.ts @@ -0,0 +1,8 @@ +// Copyright 2017-2020 @polkadot/util-crypto authors & contributors +// SPDX-License-Identifier: Apache-2.0 + +import { ec as EC } from 'elliptic'; + +export const secp256k1 = new EC('secp256k1'); + +export const EXPAND_OPT = { bitLength: 256, isLe: false }; diff --git a/packages/util-crypto/src/secp256k1/sign.ts b/packages/util-crypto/src/secp256k1/sign.ts index cc0ed8e00..ffdd6df96 100644 --- a/packages/util-crypto/src/secp256k1/sign.ts +++ b/packages/util-crypto/src/secp256k1/sign.ts @@ -4,30 +4,28 @@ import { Keypair } from '../types'; import { HashType } from './types'; -import { ec as EC } from 'elliptic'; import { assert, bnToU8a, u8aConcat } from '@polkadot/util'; -import hasher from './hasher'; +import { secp256k1Hasher } from './hasher'; +import { EXPAND_OPT, secp256k1 } from './secp256k1'; interface Options { hashType: HashType; } -const ec = new EC('secp256k1'); - /** * @name secp256k1Sign * @description Returns message signature of `message`, using the supplied pair */ -export default function secp256k1Sign (message: Uint8Array | string, { secretKey }: Partial, { hashType = 'blake2' }: Partial = {}): Uint8Array { +export function secp256k1Sign (message: Uint8Array | string, { secretKey }: Partial, { hashType = 'blake2' }: Partial = {}): Uint8Array { assert(secretKey?.length === 32, 'Expected valid secp256k1 secretKey, 32-bytes'); - const key = ec.keyFromPrivate(secretKey); - const ecsig = key.sign(hasher(hashType, message)); + const key = secp256k1.keyFromPrivate(secretKey); + const ecsig = key.sign(secp256k1Hasher(hashType, message)); return u8aConcat( - bnToU8a(ecsig.r, { bitLength: 256, isLe: false }), - bnToU8a(ecsig.s, { bitLength: 256, isLe: false }), + bnToU8a(ecsig.r, EXPAND_OPT), + bnToU8a(ecsig.s, EXPAND_OPT), new Uint8Array([ecsig.recoveryParam || 0]) ); } diff --git a/packages/util-crypto/src/secp256k1/signVerify.spec.ts b/packages/util-crypto/src/secp256k1/signVerify.spec.ts index 66d890bbb..a944fff20 100644 --- a/packages/util-crypto/src/secp256k1/signVerify.spec.ts +++ b/packages/util-crypto/src/secp256k1/signVerify.spec.ts @@ -3,11 +3,11 @@ import { stringToU8a } from '@polkadot/util'; -import randomAsU8a from '../random/asU8a'; -import pairFromSeed from './keypair/fromSeed'; -import hasher from './hasher'; -import sign from './sign'; -import verify from './verify'; +import { randomAsU8a } from '../random/asU8a'; +import { secp256k1KeypairFromSeed } from './keypair/fromSeed'; +import { secp256k1Hasher } from './hasher'; +import { secp256k1Sign } from './sign'; +import { secp256k1Verify } from './verify'; const MESSAGE = stringToU8a('this is a message'); @@ -17,45 +17,47 @@ describe('sign and verify', (): void => { const sig = '0x92fcacf0946bbd10b31dfe16d567ed1d3014e81007dd9e5256e19c0f07eacc1643b151ca29e449a765e16a7ce59b88d800467d6b3412d30ea8ad22307a59664b00'; const msg = stringToU8a('secp256k1'); - expect(verify(msg, sig, address)).toBe(true); + expect(secp256k1Verify(msg, sig, address)).toBe(true); }); it('has 65-byte signatures', (): void => { - const pair = pairFromSeed(randomAsU8a()); + const pair = secp256k1KeypairFromSeed(randomAsU8a()); - expect(sign(MESSAGE, pair)).toHaveLength(65); + expect(secp256k1Sign(MESSAGE, pair)).toHaveLength(65); }); it('signs/verifies a message by random key (blake2)', (): void => { - const pair = pairFromSeed(randomAsU8a()); - const signature = sign(MESSAGE, pair); - const address = hasher('blake2', pair.publicKey); + const pair = secp256k1KeypairFromSeed(randomAsU8a()); + const signature = secp256k1Sign(MESSAGE, pair); + const address = secp256k1Hasher('blake2', pair.publicKey); - expect(verify(MESSAGE, signature, address)).toBe(true); + expect(secp256k1Verify(MESSAGE, signature, address)).toBe(true); }); it('signs/verifies a message by random key (keccak)', (): void => { - const pair = pairFromSeed(randomAsU8a()); - const signature = sign(MESSAGE, pair, { hashType: 'keccak' }); - const address = hasher('keccak', pair.publicKey); + const pair = secp256k1KeypairFromSeed(randomAsU8a()); + const signature = secp256k1Sign(MESSAGE, pair, { hashType: 'keccak' }); + const address = secp256k1Hasher('keccak', pair.publicKey); - expect(verify(MESSAGE, signature, address, { hashType: 'keccak' })).toBe(true); + expect(secp256k1Verify(MESSAGE, signature, address, { hashType: 'keccak' })).toBe(true); }); it('fails verification on hasher mismatches', (): void => { - const pair = pairFromSeed(randomAsU8a()); - const signature = sign(MESSAGE, pair, { hashType: 'keccak' }); - const address = hasher('keccak', pair.publicKey); + const pair = secp256k1KeypairFromSeed(randomAsU8a()); + const signature = secp256k1Sign(MESSAGE, pair, { hashType: 'keccak' }); + const address = secp256k1Hasher('keccak', pair.publicKey); - expect(verify(MESSAGE, signature, address, { hashType: 'blake2' })).toBe(false); + expect(secp256k1Verify(MESSAGE, signature, address, { hashType: 'blake2' })).toBe(false); }); it('works over a range of random keys (blake2)', (): void => { for (let i = 0; i < 256; i++) { - const pair = pairFromSeed(randomAsU8a()); + const pair = secp256k1KeypairFromSeed(randomAsU8a()); try { - expect(verify(MESSAGE, sign(MESSAGE, pair, { hashType: 'blake2' }), hasher('blake2', pair.publicKey), { hashType: 'blake2' })).toBe(true); + expect( + secp256k1Verify(MESSAGE, secp256k1Sign(MESSAGE, pair, { hashType: 'blake2' }), secp256k1Hasher('blake2', pair.publicKey), { hashType: 'blake2' }) + ).toBe(true); } catch (error) { console.error(`blake2 failed on #${i}`); throw error; @@ -65,10 +67,10 @@ describe('sign and verify', (): void => { it('works over a range of random keys (keccak)', (): void => { for (let i = 0; i < 256; i++) { - const pair = pairFromSeed(randomAsU8a()); + const pair = secp256k1KeypairFromSeed(randomAsU8a()); try { - expect(verify(MESSAGE, sign(MESSAGE, pair, { hashType: 'keccak' }), hasher('keccak', pair.publicKey), { hashType: 'keccak' })).toBe(true); + expect(secp256k1Verify(MESSAGE, secp256k1Sign(MESSAGE, pair, { hashType: 'keccak' }), secp256k1Hasher('keccak', pair.publicKey), { hashType: 'keccak' })).toBe(true); } catch (error) { console.error(`keccak failed on #${i}`); throw error; diff --git a/packages/util-crypto/src/secp256k1/verify.ts b/packages/util-crypto/src/secp256k1/verify.ts index 936a1a241..efabb75d5 100644 --- a/packages/util-crypto/src/secp256k1/verify.ts +++ b/packages/util-crypto/src/secp256k1/verify.ts @@ -3,36 +3,39 @@ import { HashType } from './types'; -import { ec as EC } from 'elliptic'; import { assert, u8aEq, u8aToU8a } from '@polkadot/util'; -import secp256k1Expand from './expand'; -import hasher from './hasher'; +import { secp256k1Expand } from './expand'; +import { secp256k1Hasher } from './hasher'; +import { secp256k1 } from './secp256k1'; interface Options { hashType: HashType; isExpanded: boolean; } -const ec = new EC('secp256k1'); - /** * @name secp256k1Verify * @description Verifies the signature of `message`, using the supplied pair */ -export default function secp256k1Verify (message: Uint8Array | string, signature: Uint8Array | string, address: Uint8Array | string, { hashType = 'blake2', isExpanded = false }: Partial = {}): boolean { +export function secp256k1Verify (message: Uint8Array | string, signature: Uint8Array | string, address: Uint8Array | string, { hashType = 'blake2', isExpanded = false }: Partial = {}): boolean { const u8a = u8aToU8a(signature); assert(u8a.length === 65, `Expected signature with 65 bytes, ${u8a.length} found instead`); const publicKey = new Uint8Array( // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access - ec.recoverPubKey(hasher(hashType, message), { r: u8a.slice(0, 32), s: u8a.slice(32, 64) }, u8a[64]) + secp256k1 + .recoverPubKey( + secp256k1Hasher(hashType, message), + { r: u8a.slice(0, 32), s: u8a.slice(32, 64) }, + u8a[64] + ) .encodeCompressed() ); return u8aEq( - hasher(hashType, isExpanded ? secp256k1Expand(publicKey) : publicKey), + secp256k1Hasher(hashType, isExpanded ? secp256k1Expand(publicKey) : publicKey), u8aToU8a(address) ); } diff --git a/packages/util-crypto/src/sha512/asU8a.ts b/packages/util-crypto/src/sha512/asU8a.ts index 090cca6dd..ab3fd3397 100644 --- a/packages/util-crypto/src/sha512/asU8a.ts +++ b/packages/util-crypto/src/sha512/asU8a.ts @@ -18,7 +18,7 @@ import { isReady, sha512 } from '@polkadot/wasm-crypto'; * sha512AsU8a(Uint8Array.from([...])); // => Uint8Array([...]) * ``` */ -export default function sha512AsU8a (data: Uint8Array): Uint8Array { +export function sha512AsU8a (data: Uint8Array): Uint8Array { return isReady() ? sha512(data) : nacl.hash(data); diff --git a/packages/util-crypto/src/sha512/index.ts b/packages/util-crypto/src/sha512/index.ts index 4d3642367..3fac1b3f8 100644 --- a/packages/util-crypto/src/sha512/index.ts +++ b/packages/util-crypto/src/sha512/index.ts @@ -5,4 +5,4 @@ * @summary Implements Sha-512 hashing functions for a variety of input and outputs */ -export { default as sha512AsU8a } from './asU8a'; +export { sha512AsU8a } from './asU8a'; diff --git a/packages/util-crypto/src/signature/index.ts b/packages/util-crypto/src/signature/index.ts index 728e9d41e..809fac0f8 100644 --- a/packages/util-crypto/src/signature/index.ts +++ b/packages/util-crypto/src/signature/index.ts @@ -5,4 +5,4 @@ * @summary Utilities for working with signatures */ -export { default as signatureVerify } from './verify'; +export { signatureVerify } from './verify'; diff --git a/packages/util-crypto/src/signature/verify.ts b/packages/util-crypto/src/signature/verify.ts index 15843b91a..8de2050ab 100644 --- a/packages/util-crypto/src/signature/verify.ts +++ b/packages/util-crypto/src/signature/verify.ts @@ -5,10 +5,10 @@ import { KeypairType, VerifyResult } from '../types'; import { assert, u8aToU8a } from '@polkadot/util'; -import addressDecode from '../address/decode'; -import naclVerify from '../nacl/verify'; -import schnorrkelVerify from '../schnorrkel/verify'; -import secp256k1Verify from '../secp256k1/verify'; +import { decodeAddress } from '../address/decode'; +import { naclVerify } from '../nacl/verify'; +import { schnorrkelVerify } from '../schnorrkel/verify'; +import { secp256k1Verify } from '../secp256k1/verify'; interface VerifyInput { message: Uint8Array | string; @@ -74,13 +74,13 @@ function verifyMultisig (result: VerifyResult, { message, publicKey, signature } return result; } -export default function signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string, isExpanded?: boolean): VerifyResult { +export function signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string, isExpanded?: boolean): VerifyResult { const signatureU8a = u8aToU8a(signature); assert([64, 65, 66].includes(signatureU8a.length), `Invalid signature length, expected [64..66] bytes, found ${signatureU8a.length}`); const result: VerifyResult = { crypto: 'none', isValid: false }; - const publicKey = addressDecode(addressOrPublicKey); + const publicKey = decodeAddress(addressOrPublicKey); const input = { message, publicKey, signature: signatureU8a }; return [0, 1, 2].includes(signatureU8a[0]) && [65, 66].includes(signatureU8a.length) diff --git a/packages/util-crypto/src/xxhash/asHex.ts b/packages/util-crypto/src/xxhash/asHex.ts index 60d32ed1a..f8edbd641 100644 --- a/packages/util-crypto/src/xxhash/asHex.ts +++ b/packages/util-crypto/src/xxhash/asHex.ts @@ -3,7 +3,7 @@ import { u8aToHex } from '@polkadot/util'; -import xxhashAsU8a from './asU8a'; +import { xxhashAsU8a } from './asU8a'; /** * @name xxhashAsHex @@ -19,7 +19,7 @@ import xxhashAsU8a from './asU8a'; * xxhashAsHex('abc'); // => 0x44bc2cf5ad770999 * ``` */ -export default function xxhashAsHex (data: Buffer | Uint8Array | string, bitLength = 64): string { +export function xxhashAsHex (data: Buffer | Uint8Array | string, bitLength = 64): string { return u8aToHex( xxhashAsU8a(data, bitLength) ); diff --git a/packages/util-crypto/src/xxhash/asU8a.ts b/packages/util-crypto/src/xxhash/asU8a.ts index 66ad94c00..3112157bc 100644 --- a/packages/util-crypto/src/xxhash/asU8a.ts +++ b/packages/util-crypto/src/xxhash/asU8a.ts @@ -20,7 +20,7 @@ import xxhash64AsBn from './xxhash64/asBn'; * xxhashAsU8a('abc'); // => 0x44bc2cf5ad770999 * ``` */ -export default function xxhashAsU8a (data: Buffer | Uint8Array | string, bitLength = 64): Uint8Array { +export function xxhashAsU8a (data: Buffer | Uint8Array | string, bitLength = 64): Uint8Array { const iterations = Math.ceil(bitLength / 64); if (isReady()) { diff --git a/packages/util-crypto/src/xxhash/index.ts b/packages/util-crypto/src/xxhash/index.ts index 5b2bd8292..e5c1cc055 100644 --- a/packages/util-crypto/src/xxhash/index.ts +++ b/packages/util-crypto/src/xxhash/index.ts @@ -5,5 +5,5 @@ * @summary Create xxhash64 values with specified bitlengths */ -export { default as xxhashAsHex } from './asHex'; -export { default as xxhashAsU8a } from './asU8a'; +export { xxhashAsHex } from './asHex'; +export { xxhashAsU8a } from './asU8a'; diff --git a/packages/util/src/array/filter.ts b/packages/util/src/array/filter.ts index 1355e66a4..188212eb4 100644 --- a/packages/util/src/array/filter.ts +++ b/packages/util/src/array/filter.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isNull from '../is/null'; -import isUndefined from '../is/undefined'; +import { isNull } from '../is/null'; +import { isUndefined } from '../is/undefined'; /** * @name arrayFilter @@ -20,7 +20,7 @@ import isUndefined from '../is/undefined'; * ``` */ // eslint-disable-next-line @typescript-eslint/no-explicit-any -export default function arrayFilter (array: T[], allowNulls = true): T[] { +export function arrayFilter (array: T[], allowNulls = true): T[] { return array.filter((value) => !isUndefined(value) && (allowNulls || !isNull(value)) ); diff --git a/packages/util/src/array/index.ts b/packages/util/src/array/index.ts index 6c0f0d594..1c46734c5 100644 --- a/packages/util/src/array/index.ts +++ b/packages/util/src/array/index.ts @@ -5,4 +5,4 @@ * @summary Utility methods that operates on arrays */ -export { default as arrayFilter } from './filter'; +export { arrayFilter } from './filter'; diff --git a/packages/util/src/assert.ts b/packages/util/src/assert.ts index ec3c00d41..c8ea83c82 100644 --- a/packages/util/src/assert.ts +++ b/packages/util/src/assert.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isFunction from './is/function'; -import isUndefined from './is/undefined'; +import { isFunction } from './is/function'; +import { isUndefined } from './is/undefined'; type MessageFn = () => string; @@ -22,7 +22,7 @@ type MessageFn = () => string; * assert(false, () => 'message'); // Error with 'message' * ``` */ -export default function assert (condition: unknown, message: string | MessageFn): asserts condition { +export function assert (condition: unknown, message: string | MessageFn): asserts condition { if (!condition) { throw new Error( isFunction(message) diff --git a/packages/util/src/bn/fromHex.spec.ts b/packages/util/src/bn/fromHex.spec.ts index a883920e7..7035fa720 100644 --- a/packages/util/src/bn/fromHex.spec.ts +++ b/packages/util/src/bn/fromHex.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isFunction from '../is/function'; +import { isFunction } from '../is/function'; import { bnFromHex } from '.'; diff --git a/packages/util/src/bn/fromHex.ts b/packages/util/src/bn/fromHex.ts index 8d19715d2..519b2e6dd 100644 --- a/packages/util/src/bn/fromHex.ts +++ b/packages/util/src/bn/fromHex.ts @@ -1,11 +1,4 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import bnFromHex from '../hex/toBn'; - -/** - * @name bnFromHex - * @summary Creates a BN.js bignumber object from a hex string. - * @alias hex/toBn - */ -export default bnFromHex; +export { hexToBn as bnFromHex } from '../hex/toBn'; diff --git a/packages/util/src/bn/index.ts b/packages/util/src/bn/index.ts index ac63f8ff5..c423d3c6c 100644 --- a/packages/util/src/bn/index.ts +++ b/packages/util/src/bn/index.ts @@ -6,10 +6,11 @@ */ export * from './consts'; -export { default as bnFromHex } from './fromHex'; -export { default as bnMax } from './max'; -export { default as bnMin } from './min'; -export { default as bnSqrt } from './sqrt'; -export { default as bnToBn } from './toBn'; -export { default as bnToHex } from './toHex'; -export { default as bnToU8a } from './toU8a'; + +export { bnFromHex } from './fromHex'; +export { bnMax } from './max'; +export { bnMin } from './min'; +export { bnSqrt } from './sqrt'; +export { bnToBn } from './toBn'; +export { bnToHex } from './toHex'; +export { bnToU8a } from './toU8a'; diff --git a/packages/util/src/bn/max.ts b/packages/util/src/bn/max.ts index 04d36bf11..bf49d3fb9 100644 --- a/packages/util/src/bn/max.ts +++ b/packages/util/src/bn/max.ts @@ -18,6 +18,6 @@ import { checkMaxMin } from './util'; * bnMax([new BN(1), new BN(3), new BN(2)]).toString(); // => '3' * ``` */ -export default function max (...items: BN[]): BN { +export function bnMax (...items: BN[]): BN { return checkMaxMin('max', items); } diff --git a/packages/util/src/bn/min.ts b/packages/util/src/bn/min.ts index 02bdd98ba..c296c36af 100644 --- a/packages/util/src/bn/min.ts +++ b/packages/util/src/bn/min.ts @@ -18,6 +18,6 @@ import { checkMaxMin } from './util'; * bnMin([new BN(1), new BN(3), new BN(2)]).toString(); // => '1' * ``` */ -export default function min (...items: BN[]): BN { +export function bnMin (...items: BN[]): BN { return checkMaxMin('min', items); } diff --git a/packages/util/src/bn/sqrt.ts b/packages/util/src/bn/sqrt.ts index 7353c52fa..e70e6ae4b 100644 --- a/packages/util/src/bn/sqrt.ts +++ b/packages/util/src/bn/sqrt.ts @@ -3,7 +3,7 @@ import BN from 'bn.js'; -import assert from '../assert'; +import { assert } from '../assert'; // https://golb.hplar.ch/2018/09/javascript-bigint.html function newtonIteration (n: BN, x0: BN): BN { @@ -29,7 +29,7 @@ function newtonIteration (n: BN, x0: BN): BN { * bnSqrt(new BN(16)).toString(); // => '4' * ``` */ -export default function sqrt (value: BN): BN { +export function bnSqrt (value: BN): BN { assert(value.gten(0), 'square root of negative numbers is not supported'); return value.ltn(2) diff --git a/packages/util/src/bn/toBn.ts b/packages/util/src/bn/toBn.ts index 7dd37c395..7a1baf18e 100644 --- a/packages/util/src/bn/toBn.ts +++ b/packages/util/src/bn/toBn.ts @@ -5,10 +5,10 @@ import { ToBn } from '../types'; import BN from 'bn.js'; -import isBigInt from '../is/bigInt'; -import isToBn from '../is/toBn'; -import isHex from '../is/hex'; -import hexToBn from '../hex/toBn'; +import { isBigInt } from '../is/bigInt'; +import { isToBn } from '../is/toBn'; +import { isHex } from '../is/hex'; +import { hexToBn } from '../hex/toBn'; function numberToBn (value: number | ExtToBn | BN): BN { return BN.isBN(value) @@ -34,7 +34,7 @@ function numberToBn (value: number | ExtToBn | BN): BN { * bnToBn(new BN(0x1234)); // => BN(0x1234) * ``` */ -export default function bnToBn (value?: ExtToBn | BN | BigInt | string | number | null): BN { +export function bnToBn (value?: ExtToBn | BN | BigInt | string | number | null): BN { if (!value) { return new BN(0); } else if (isHex(value)) { diff --git a/packages/util/src/bn/toHex.ts b/packages/util/src/bn/toHex.ts index 8c3cdd4f4..f9b457c65 100644 --- a/packages/util/src/bn/toHex.ts +++ b/packages/util/src/bn/toHex.ts @@ -5,8 +5,8 @@ import { ToBn, ToBnOptions } from '../types'; import BN from 'bn.js'; -import isNumber from '../is/number'; -import bnToU8a from './toU8a'; +import { isNumber } from '../is/number'; +import { bnToU8a } from './toU8a'; import { u8aToHex } from '../u8a'; const ZERO_STR = '0x00'; @@ -47,4 +47,4 @@ function bnToHex (value?: ExtToBn | BN | BigInt | number return u8aToHex(bnToU8a(value, _options)); } -export default bnToHex; +export { bnToHex }; diff --git a/packages/util/src/bn/toU8a.ts b/packages/util/src/bn/toU8a.ts index 7e915e1cb..dcedbf9fc 100644 --- a/packages/util/src/bn/toU8a.ts +++ b/packages/util/src/bn/toU8a.ts @@ -5,8 +5,8 @@ import { ToBn, ToBnOptions } from '../types'; import BN from 'bn.js'; -import isNumber from '../is/number'; -import bnToBn from './toBn'; +import { isNumber } from '../is/number'; +import { bnToBn } from './toBn'; interface Options extends ToBnOptions { bitLength?: number; @@ -61,4 +61,4 @@ function bnToU8a (value?: ExtToBn | BN | BigInt | number : createEmpty(byteLength, options); } -export default bnToU8a; +export { bnToU8a }; diff --git a/packages/util/src/bn/util.ts b/packages/util/src/bn/util.ts index ea46e13fd..3a38bfbe6 100644 --- a/packages/util/src/bn/util.ts +++ b/packages/util/src/bn/util.ts @@ -3,7 +3,7 @@ import BN from 'bn.js'; -import assert from '../assert'; +import { assert } from '../assert'; export function checkMaxMin (type: 'max' | 'min', items: BN[]): BN { assert(items.length >= 1, 'Must provide one or more BN arguments'); diff --git a/packages/util/src/buffer/index.ts b/packages/util/src/buffer/index.ts index 4caaa0755..d4c59d34f 100644 --- a/packages/util/src/buffer/index.ts +++ b/packages/util/src/buffer/index.ts @@ -5,4 +5,4 @@ * @summary Utility methods to convert to and from `Buffer` objects */ -export { default as bufferToU8a } from './toU8a'; +export { bufferToU8a } from './toU8a'; diff --git a/packages/util/src/buffer/toU8a.ts b/packages/util/src/buffer/toU8a.ts index 1393dd501..93850c6c3 100644 --- a/packages/util/src/buffer/toU8a.ts +++ b/packages/util/src/buffer/toU8a.ts @@ -15,6 +15,6 @@ * bufferToU8a(Buffer.from([1, 2, 3])); * ``` */ -export default function bufferToU8a (buffer?: Buffer | number[] | null): Uint8Array { +export function bufferToU8a (buffer?: Buffer | number[] | null): Uint8Array { return new Uint8Array(buffer || []); } diff --git a/packages/util/src/compact/addLength.spec.ts b/packages/util/src/compact/addLength.spec.ts index a5b27a6f4..3cba1f5ce 100644 --- a/packages/util/src/compact/addLength.spec.ts +++ b/packages/util/src/compact/addLength.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import compactAddLength from './addLength'; +import { compactAddLength } from '.'; describe('compactAddLength', (): void => { it('correctly adds the length prefix', (): void => { diff --git a/packages/util/src/compact/addLength.ts b/packages/util/src/compact/addLength.ts index 1a65c7335..3268c5ced 100644 --- a/packages/util/src/compact/addLength.ts +++ b/packages/util/src/compact/addLength.ts @@ -2,7 +2,7 @@ // SPDX-License-Identifier: Apache-2.0 import { u8aConcat } from '../u8a'; -import compactToU8a from './toU8a'; +import { compactToU8a } from './toU8a'; /** * @name compactAddLength @@ -16,7 +16,7 @@ import compactToU8a from './toU8a'; * console.log(compactAddLength(new Uint8Array([0xde, 0xad, 0xbe, 0xef]))); // Uint8Array([4 << 2, 0xde, 0xad, 0xbe, 0xef]) * ``` */ -export default function compactAddLength (input: Uint8Array): Uint8Array { +export function compactAddLength (input: Uint8Array): Uint8Array { return u8aConcat( compactToU8a(input.length), input diff --git a/packages/util/src/compact/fromU8a.spec.ts b/packages/util/src/compact/fromU8a.spec.ts index 28a37b93f..62c7d818e 100644 --- a/packages/util/src/compact/fromU8a.spec.ts +++ b/packages/util/src/compact/fromU8a.spec.ts @@ -3,8 +3,8 @@ import BN from 'bn.js'; -import hexToU8a from '../hex/toU8a'; -import compactFromU8a from './fromU8a'; +import { hexToU8a } from '../hex/toU8a'; +import { compactFromU8a } from '.'; describe('compactFromU8a', (): void => { it('decoded u8 value', (): void => { diff --git a/packages/util/src/compact/fromU8a.ts b/packages/util/src/compact/fromU8a.ts index bd0dc8345..1d498ff90 100644 --- a/packages/util/src/compact/fromU8a.ts +++ b/packages/util/src/compact/fromU8a.ts @@ -23,7 +23,7 @@ import { DEFAULT_BITLENGTH } from './defaults'; * ``` */ // eslint-disable-next-line @typescript-eslint/no-unused-vars -export default function compactFromU8a (_input: Uint8Array | string, bitLength: BitLength = DEFAULT_BITLENGTH): [number, BN] { +export function compactFromU8a (_input: Uint8Array | string, bitLength: BitLength = DEFAULT_BITLENGTH): [number, BN] { const input = u8aToU8a(_input); const flag = input[0] & 0b11; diff --git a/packages/util/src/compact/index.ts b/packages/util/src/compact/index.ts index 52b64bf38..5019deaf2 100644 --- a/packages/util/src/compact/index.ts +++ b/packages/util/src/compact/index.ts @@ -22,7 +22,7 @@ * Note: we use *LOW BITS* of the LSB in LE encoding to encode the 2 bit key. */ -export { default as compactAddLength } from './addLength'; -export { default as compactStripLength } from './stripLength'; -export { default as compactFromU8a } from './fromU8a'; -export { default as compactToU8a } from './toU8a'; +export { compactAddLength } from './addLength'; +export { compactStripLength } from './stripLength'; +export { compactFromU8a } from './fromU8a'; +export { compactToU8a } from './toU8a'; diff --git a/packages/util/src/compact/stripLength.spec.ts b/packages/util/src/compact/stripLength.spec.ts index 7f008b654..2f1cc7c7a 100644 --- a/packages/util/src/compact/stripLength.spec.ts +++ b/packages/util/src/compact/stripLength.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import compactStripLength from './stripLength'; +import { compactStripLength } from '.'; describe('compactStripLength', (): void => { it('correctly removes the length prefix', (): void => { diff --git a/packages/util/src/compact/stripLength.ts b/packages/util/src/compact/stripLength.ts index 165377b43..33fa8338c 100644 --- a/packages/util/src/compact/stripLength.ts +++ b/packages/util/src/compact/stripLength.ts @@ -4,7 +4,7 @@ import { BitLength } from './types'; import { DEFAULT_BITLENGTH } from './defaults'; -import compactFromU8a from './fromU8a'; +import { compactFromU8a } from './fromU8a'; /** * @name compactStripLength @@ -18,7 +18,7 @@ import compactFromU8a from './fromU8a'; * console.log(compactStripLength(new Uint8Array([2 << 2, 0xde, 0xad]))); // [2, Uint8Array[0xde, 0xad]] * ``` */ -export default function compactStripLength (input: Uint8Array, bitLength: BitLength = DEFAULT_BITLENGTH): [number, Uint8Array] { +export function compactStripLength (input: Uint8Array, bitLength: BitLength = DEFAULT_BITLENGTH): [number, Uint8Array] { const [offset, length] = compactFromU8a(input, bitLength); const total = offset + length.toNumber(); diff --git a/packages/util/src/compact/toU8a.spec.ts b/packages/util/src/compact/toU8a.spec.ts index 194d690f0..046a55617 100644 --- a/packages/util/src/compact/toU8a.spec.ts +++ b/packages/util/src/compact/toU8a.spec.ts @@ -3,7 +3,7 @@ import BN from 'bn.js'; -import compactToU8a from './toU8a'; +import { compactToU8a } from '.'; describe('encode', (): void => { it('encodes short u8', (): void => { diff --git a/packages/util/src/compact/toU8a.ts b/packages/util/src/compact/toU8a.ts index f0f7074b2..a4a675b83 100644 --- a/packages/util/src/compact/toU8a.ts +++ b/packages/util/src/compact/toU8a.ts @@ -3,7 +3,7 @@ import BN from 'bn.js'; -import assert from '../assert'; +import { assert } from '../assert'; import { bnToBn, bnToU8a } from '../bn'; import { u8aConcat } from '../u8a'; @@ -23,7 +23,7 @@ const MAX_U32 = new BN(2).pow(new BN(32 - 2)).subn(1); * console.log(compactToU8a(511, 32)); // Uint8Array([0b11111101, 0b00000111]) * ``` */ -export default function compactToU8a (_value: BN | BigInt | number): Uint8Array { +export function compactToU8a (_value: BN | BigInt | number): Uint8Array { const value = bnToBn(_value); if (value.lte(MAX_U8)) { diff --git a/packages/util/src/detectPackage.ts b/packages/util/src/detectPackage.ts index 442e4a769..164dc01f5 100644 --- a/packages/util/src/detectPackage.ts +++ b/packages/util/src/detectPackage.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import assert from './assert'; -import isString from './is/string'; +import { assert } from './assert'; +import { isString } from './is/string'; // eslint-disable-next-line no-undef type This = typeof globalThis; @@ -46,7 +46,7 @@ function flattenVersions (_all: (VersionPath | string)[]): string { * @name detectPackage * @summary Checks that a specific package is only imported once */ -export default function detectPackage ({ name, version }: PackageJson, path?: string | false): void { +export function detectPackage ({ name, version }: PackageJson, path?: string | false): void { const _global = typeof window !== 'undefined' ? window as PjsWindow : global as PjsGlobal; diff --git a/packages/util/src/extractTime.ts b/packages/util/src/extractTime.ts index 848709f75..b11de576f 100644 --- a/packages/util/src/extractTime.ts +++ b/packages/util/src/extractTime.ts @@ -77,7 +77,7 @@ function extractSecs (milliseconds: number): Time { * const { days, minutes, hours, seconds, milliseconds } = extractTime(6000); // 0, 0, 10, 0, 0 * ``` */ -export default function extractTime (milliseconds?: number): Time { +export function extractTime (milliseconds?: number): Time { if (!milliseconds) { return ZERO; } else if (milliseconds < 1000) { diff --git a/packages/util/src/format/formatBalance.spec.ts b/packages/util/src/format/formatBalance.spec.ts index 358ff5a68..549e63fb9 100644 --- a/packages/util/src/format/formatBalance.spec.ts +++ b/packages/util/src/format/formatBalance.spec.ts @@ -3,7 +3,7 @@ import BN from 'bn.js'; -import formatBalance from './formatBalance'; +import { formatBalance } from '.'; describe('formatBalance', (): void => { const TESTVAL = new BN('123456789000'); diff --git a/packages/util/src/format/formatBalance.ts b/packages/util/src/format/formatBalance.ts index ec5d41e6f..5e2135901 100644 --- a/packages/util/src/format/formatBalance.ts +++ b/packages/util/src/format/formatBalance.ts @@ -5,10 +5,10 @@ import { SiDef, ToBn } from '../types'; import BN from 'bn.js'; -import bnToBn from '../bn/toBn'; -import isBoolean from '../is/boolean'; -import isUndefined from '../is/undefined'; -import formatDecimal from './formatDecimal'; +import { bnToBn } from '../bn/toBn'; +import { isBoolean } from '../is/boolean'; +import { isUndefined } from '../is/undefined'; +import { formatDecimal } from './formatDecimal'; import { SI, SI_MID, calcSi, findSi } from './si'; interface Defaults { @@ -115,4 +115,4 @@ formatBalance.setDefaults = ({ decimals, unit }: Partial): void => { SI[SI_MID].text = defaultUnit; }; -export default formatBalance; +export { formatBalance }; diff --git a/packages/util/src/format/formatDate.spec.ts b/packages/util/src/format/formatDate.spec.ts index b0eb5a84c..91c069ce0 100644 --- a/packages/util/src/format/formatDate.spec.ts +++ b/packages/util/src/format/formatDate.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import formatDate from './formatDate'; +import { formatDate } from '.'; describe('formatDate', (): void => { it('formats a known date into the correct format', (): void => { diff --git a/packages/util/src/format/formatDate.ts b/packages/util/src/format/formatDate.ts index cf4795169..d071aabd9 100644 --- a/packages/util/src/format/formatDate.ts +++ b/packages/util/src/format/formatDate.ts @@ -6,7 +6,7 @@ function zeroPad (value: number): string { return value.toString().padStart(2, '0'); } -export default function formatDate (date: Date): string { +export function formatDate (date: Date): string { const year = date.getFullYear().toString(); const month = zeroPad((date.getMonth() + 1)); const day = zeroPad(date.getDate()); diff --git a/packages/util/src/format/formatDecimal.spec.ts b/packages/util/src/format/formatDecimal.spec.ts index 7d2b3c9b3..49ecaa9d0 100644 --- a/packages/util/src/format/formatDecimal.spec.ts +++ b/packages/util/src/format/formatDecimal.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import formatDecimal from './formatDecimal'; +import { formatDecimal } from '.'; describe('formatDecimal', (): void => { it('formats decimals in number groupings', (): void => { diff --git a/packages/util/src/format/formatDecimal.ts b/packages/util/src/format/formatDecimal.ts index ae82c0d24..6d92b8153 100644 --- a/packages/util/src/format/formatDecimal.ts +++ b/packages/util/src/format/formatDecimal.ts @@ -4,7 +4,7 @@ // eslint-disable-next-line prefer-regex-literals const NUMBER_REGEX = new RegExp('(\\d+?)(?=(\\d{3})+(?!\\d)|$)', 'g'); -export default function formatDecimal (value: string): string { +export function formatDecimal (value: string): string { // We can do this by adjusting the regx, however for the sake of clarity // we rather strip and re-add the negative sign in the output const isNegative = value[0].startsWith('-'); diff --git a/packages/util/src/format/formatElapsed.spec.ts b/packages/util/src/format/formatElapsed.spec.ts index 96c8d34d6..e59868984 100644 --- a/packages/util/src/format/formatElapsed.spec.ts +++ b/packages/util/src/format/formatElapsed.spec.ts @@ -3,7 +3,7 @@ import BN from 'bn.js'; -import formatElapsed from './formatElapsed'; +import { formatElapsed } from '.'; describe('formatElapsed', (): void => { const start = 12345678; diff --git a/packages/util/src/format/formatElapsed.ts b/packages/util/src/format/formatElapsed.ts index d1037aca1..ccad65747 100644 --- a/packages/util/src/format/formatElapsed.ts +++ b/packages/util/src/format/formatElapsed.ts @@ -5,7 +5,7 @@ import { ToBn } from '../types'; import BN from 'bn.js'; -import bnToBn from '../bn/toBn'; +import { bnToBn } from '../bn/toBn'; function formatValue (elapsed: number): string { if (elapsed < 15) { @@ -19,7 +19,7 @@ function formatValue (elapsed: number): string { return `${elapsed / 3600 | 0}h`; } -export default function formatElapsed (now?: Date | null, value?: BigInt | BN | ExtToBn | Date | number | null): string { +export function formatElapsed (now?: Date | null, value?: BigInt | BN | ExtToBn | Date | number | null): string { const tsNow = (now && now.getTime()) || 0; const tsValue = value instanceof Date ? value.getTime() diff --git a/packages/util/src/format/formatNumber.spec.ts b/packages/util/src/format/formatNumber.spec.ts index e040090c7..6e2f162fe 100644 --- a/packages/util/src/format/formatNumber.spec.ts +++ b/packages/util/src/format/formatNumber.spec.ts @@ -3,7 +3,7 @@ import BN from 'bn.js'; -import formatNumber from './formatNumber'; +import { formatNumber } from '.'; describe('formatNumber', (): void => { it('formats empty', (): void => { diff --git a/packages/util/src/format/formatNumber.ts b/packages/util/src/format/formatNumber.ts index 60a0ccd2f..71b65e30f 100644 --- a/packages/util/src/format/formatNumber.ts +++ b/packages/util/src/format/formatNumber.ts @@ -5,9 +5,9 @@ import { ToBn } from '../types'; import BN from 'bn.js'; -import bnToBn from '../bn/toBn'; -import formatDecimal from './formatDecimal'; +import { bnToBn } from '../bn/toBn'; +import { formatDecimal } from './formatDecimal'; -export default function formatNumber (value?: ExtToBn | BN | BigInt | number | null): string { +export function formatNumber (value?: ExtToBn | BN | BigInt | number | null): string { return formatDecimal(bnToBn(value).toString()); } diff --git a/packages/util/src/format/index.ts b/packages/util/src/format/index.ts index 837d0fb6c..28f32ef34 100644 --- a/packages/util/src/format/index.ts +++ b/packages/util/src/format/index.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -export { default as formatBalance } from './formatBalance'; -export { default as formatDate } from './formatDate'; -export { default as formatDecimal } from './formatDecimal'; -export { default as formatElapsed } from './formatElapsed'; -export { default as formatNumber } from './formatNumber'; +export { formatBalance } from './formatBalance'; +export { formatDate } from './formatDate'; +export { formatDecimal } from './formatDecimal'; +export { formatElapsed } from './formatElapsed'; +export { formatNumber } from './formatNumber'; export { calcSi, findSi } from './si'; diff --git a/packages/util/src/hex/addPrefix.ts b/packages/util/src/hex/addPrefix.ts index 37585134e..b7c613776 100644 --- a/packages/util/src/hex/addPrefix.ts +++ b/packages/util/src/hex/addPrefix.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import hasPrefix from './hasPrefix'; +import { hexHasPrefix } from './hasPrefix'; /** * @name hexAddPrefix @@ -17,8 +17,8 @@ import hasPrefix from './hasPrefix'; * console.log('With prefix', hexAddPrefix('0a0b12')); // => 0x0a0b12 * ``` */ -export default function hexAddPrefix (value?: string | null): string { - if (value && hasPrefix(value)) { +export function hexAddPrefix (value?: string | null): string { + if (value && hexHasPrefix(value)) { return value; } diff --git a/packages/util/src/hex/fixLength.ts b/packages/util/src/hex/fixLength.ts index f207ec903..7407f4534 100644 --- a/packages/util/src/hex/fixLength.ts +++ b/packages/util/src/hex/fixLength.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import hexAddPrefix from './addPrefix'; -import hexStripPrefix from './stripPrefix'; +import { hexAddPrefix } from './addPrefix'; +import { hexStripPrefix } from './stripPrefix'; /** * @name hexFixLength @@ -20,7 +20,7 @@ import hexStripPrefix from './stripPrefix'; * console.log('fixed', hexFixLength('0x0012', 8)); // => 0x12 * ``` */ -export default function hexFixLength (value: string, bitLength = -1, withPadding = false): string { +export function hexFixLength (value: string, bitLength = -1, withPadding = false): string { const strLength = Math.ceil(bitLength / 4); const hexLength = strLength + 2; diff --git a/packages/util/src/hex/hasPrefix.ts b/packages/util/src/hex/hasPrefix.ts index 01ab73734..765482eef 100644 --- a/packages/util/src/hex/hasPrefix.ts +++ b/packages/util/src/hex/hasPrefix.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isHex from '../is/hex'; +import { isHex } from '../is/hex'; /** * @name hexHasPrefix @@ -17,6 +17,6 @@ import isHex from '../is/hex'; * console.log('has prefix', hexHasPrefix('0x1234')); // => true * ``` */ -export default function hexHasPrefix (value?: string | null): boolean { +export function hexHasPrefix (value?: string | null): boolean { return !!(value && isHex(value, -1, true) && value.substr(0, 2) === '0x'); } diff --git a/packages/util/src/hex/index.ts b/packages/util/src/hex/index.ts index dbb279df1..4ce19fcdf 100644 --- a/packages/util/src/hex/index.ts +++ b/packages/util/src/hex/index.ts @@ -5,11 +5,11 @@ * @summary Internal utilities to create and test for hex values */ -export { default as hexAddPrefix } from './addPrefix'; -export { default as hexFixLength } from './fixLength'; -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'; +export { hexAddPrefix } from './addPrefix'; +export { hexFixLength } from './fixLength'; +export { hexHasPrefix } from './hasPrefix'; +export { hexStripPrefix } from './stripPrefix'; +export { hexToBn } from './toBn'; +export { hexToNumber } from './toNumber'; +export { hexToString } from './toString'; +export { hexToU8a } from './toU8a'; diff --git a/packages/util/src/hex/stripPrefix.ts b/packages/util/src/hex/stripPrefix.ts index 81221450a..002ab9c46 100644 --- a/packages/util/src/hex/stripPrefix.ts +++ b/packages/util/src/hex/stripPrefix.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import hasPrefix from './hasPrefix'; +import { hexHasPrefix } from './hasPrefix'; const UNPREFIX_HEX_REGEX = /^[a-fA-F0-9]+$/; @@ -19,12 +19,12 @@ const UNPREFIX_HEX_REGEX = /^[a-fA-F0-9]+$/; * console.log('stripped', hexStripPrefix('0x1234')); // => 1234 * ``` */ -export default function hexStripPrefix (value?: string | null): string { +export function hexStripPrefix (value?: string | null): string { if (!value) { return ''; } - if (hasPrefix(value)) { + if (hexHasPrefix(value)) { return value.substr(2); } diff --git a/packages/util/src/hex/toBn.ts b/packages/util/src/hex/toBn.ts index 5aaf8b1c2..4c0eef7e1 100644 --- a/packages/util/src/hex/toBn.ts +++ b/packages/util/src/hex/toBn.ts @@ -3,8 +3,8 @@ import BN from 'bn.js'; -import isBoolean from '../is/boolean'; -import hexStripPrefix from './stripPrefix'; +import { isBoolean } from '../is/boolean'; +import { hexStripPrefix } from './stripPrefix'; import { ToBnOptions } from '../types'; function reverse (value: string): string { @@ -31,7 +31,7 @@ function reverse (value: string): string { * hexToBn('0x123480001f'); // => BN(0x123480001f) * ``` */ -export default function hexToBn (value?: string | number | null, options: ToBnOptions | boolean = { isLe: false, isNegative: false }): BN { +export function hexToBn (value?: string | number | null, options: ToBnOptions | boolean = { isLe: false, isNegative: false }): BN { if (!value) { return new BN(0); } diff --git a/packages/util/src/hex/toNumber.ts b/packages/util/src/hex/toNumber.ts index 1dee3cab7..f5e47425d 100644 --- a/packages/util/src/hex/toNumber.ts +++ b/packages/util/src/hex/toNumber.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import hexToBn from './toBn'; +import { hexToBn } from './toBn'; /** * @name hexToNumber @@ -17,7 +17,7 @@ import hexToBn from './toBn'; * hexToNumber('0x1234'); // => 0x1234 * ``` */ -export default function hexToNumber (value?: string | null): number { +export function hexToNumber (value?: string | null): number { return value ? hexToBn(value).toNumber() : NaN; diff --git a/packages/util/src/hex/toString.ts b/packages/util/src/hex/toString.ts index c82af22f5..599bc6c49 100644 --- a/packages/util/src/hex/toString.ts +++ b/packages/util/src/hex/toString.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import u8aToString from '../u8a/toString'; -import hexToU8a from './toU8a'; +import { u8aToString } from '../u8a/toString'; +import { hexToU8a } from './toU8a'; /** * @name hexToU8a @@ -18,7 +18,7 @@ import hexToU8a from './toU8a'; * hexToU8a('0x68656c6c6f'); // hello * ``` */ -export default function hexToString (_value?: string | null): string { +export function hexToString (_value?: string | null): string { return u8aToString( hexToU8a(_value) ); diff --git a/packages/util/src/hex/toU8a.ts b/packages/util/src/hex/toU8a.ts index 4ae308802..08d17df75 100644 --- a/packages/util/src/hex/toU8a.ts +++ b/packages/util/src/hex/toU8a.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import assert from '../assert'; -import isHex from '../is/hex'; -import hexStripPrefix from './stripPrefix'; +import { assert } from '../assert'; +import { isHex } from '../is/hex'; +import { hexStripPrefix } from './stripPrefix'; /** * @name hexToU8a @@ -20,7 +20,7 @@ import hexStripPrefix from './stripPrefix'; * hexToU8a('0x80001f', 32); // Uint8Array([0x00, 0x80, 0x00, 0x1f]) * ``` */ -export default function hexToU8a (_value?: string | null, bitLength = -1): Uint8Array { +export function hexToU8a (_value?: string | null, bitLength = -1): Uint8Array { if (!_value) { return new Uint8Array(); } diff --git a/packages/util/src/index.ts b/packages/util/src/index.ts index 130d189f8..4c0a513de 100644 --- a/packages/util/src/index.ts +++ b/packages/util/src/index.ts @@ -5,11 +5,11 @@ * @summary Utility methods for this package are split into groups */ -export { default as assert, assertReturn } from './assert'; -export { default as detectPackage } from './detectPackage'; -export { default as extractTime } from './extractTime'; -export { default as logger } from './logger'; -export { default as promisify } from './promisify'; +export { assert, assertReturn } from './assert'; +export { detectPackage } from './detectPackage'; +export { extractTime } from './extractTime'; +export { logger } from './logger'; +export { promisify } from './promisify'; export * from './array'; export * from './bn'; diff --git a/packages/util/src/is/ascii.ts b/packages/util/src/is/ascii.ts index 85d9fc4cc..5044cd163 100644 --- a/packages/util/src/is/ascii.ts +++ b/packages/util/src/is/ascii.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import u8aToU8a from '../u8a/toU8a'; -import isString from './string'; +import { u8aToU8a } from '../u8a/toU8a'; +import { isString } from './string'; const FORMAT = [9, 10, 13]; @@ -12,7 +12,7 @@ const FORMAT = [9, 10, 13]; * @description * Checks to see if the input string or Uint8Array is printable ASCII, 32-127 + formatters */ -export default function isAscii (value?: number[] | Buffer | Uint8Array | string | null): boolean { +export function isAscii (value?: number[] | Buffer | Uint8Array | string | null): boolean { return value ? !u8aToU8a(value).some((byte) => (byte >= 127) || (byte < 32 && !FORMAT.includes(byte))) : isString(value); diff --git a/packages/util/src/is/bigInt.ts b/packages/util/src/is/bigInt.ts index 512ff042d..7b9b691c6 100644 --- a/packages/util/src/is/bigInt.ts +++ b/packages/util/src/is/bigInt.ts @@ -15,6 +15,6 @@ * console.log('isBigInt', isBigInt(123_456n)); // => true * ``` */ -export default function isBigInt (value: unknown): value is BigInt { +export function isBigInt (value: unknown): value is BigInt { return typeof value === 'bigint'; } diff --git a/packages/util/src/is/bn.ts b/packages/util/src/is/bn.ts index 16022de0e..3486ed196 100644 --- a/packages/util/src/is/bn.ts +++ b/packages/util/src/is/bn.ts @@ -18,6 +18,6 @@ import BN from 'bn.js'; * console.log('isBn', isBn(new BN(1))); // => true * ``` */ -export default function isBn (value: unknown): value is BN { +export function isBn (value: unknown): value is BN { return BN.isBN(value); } diff --git a/packages/util/src/is/boolean.ts b/packages/util/src/is/boolean.ts index 26b6b4eed..51142d559 100644 --- a/packages/util/src/is/boolean.ts +++ b/packages/util/src/is/boolean.ts @@ -15,6 +15,6 @@ * isBoolean(false); // => true * ``` */ -export default function isBoolean (value: unknown): value is boolean { +export function isBoolean (value: unknown): value is boolean { return typeof value === 'boolean'; } diff --git a/packages/util/src/is/buffer.ts b/packages/util/src/is/buffer.ts index 5a9a128a0..2eb0fee1b 100644 --- a/packages/util/src/is/buffer.ts +++ b/packages/util/src/is/buffer.ts @@ -1,8 +1,6 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isInstanceOf from './instanceOf'; - /** * @name isBuffer * @summary Tests for a `Buffer` object instance. @@ -17,6 +15,6 @@ import isInstanceOf from './instanceOf'; * console.log('isBuffer', isBuffer(Buffer.from([]))); // => true * ``` */ -export default function isBuffer (value: unknown): value is Buffer { - return isInstanceOf(value, Buffer); +export function isBuffer (value: unknown): value is Buffer { + return Buffer.isBuffer(value); } diff --git a/packages/util/src/is/childClass.ts b/packages/util/src/is/childClass.ts index 6206099d8..d03c78a2d 100644 --- a/packages/util/src/is/childClass.ts +++ b/packages/util/src/is/childClass.ts @@ -18,7 +18,7 @@ import { Constructor } from '../types'; * console.log('isChildClass', isChildClass(BN, Uint8Array); // => false * ``` */ -export default function isChildClass

(Parent: P, Child?: Constructor | null | unknown): Child is P { +export function isChildClass

(Parent: P, Child?: Constructor | null | unknown): Child is P { // https://stackoverflow.com/questions/30993434/check-if-a-constructor-inherits-another-in-es6/30993664 return Child // eslint-disable-next-line no-prototype-builtins diff --git a/packages/util/src/is/error.ts b/packages/util/src/is/error.ts index 22dea38d9..9b90a76e4 100644 --- a/packages/util/src/is/error.ts +++ b/packages/util/src/is/error.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isInstanceOf from './instanceOf'; +import { isInstanceOf } from './instanceOf'; /** * @name isError @@ -17,6 +17,6 @@ import isInstanceOf from './instanceOf'; * console.log('isError', isError(new Error('message'))); // => true * ``` */ -export default function isError (value: unknown): value is Error { +export function isError (value: unknown): value is Error { return isInstanceOf(value, Error); } diff --git a/packages/util/src/is/function.ts b/packages/util/src/is/function.ts index ae491f7d0..92b489554 100644 --- a/packages/util/src/is/function.ts +++ b/packages/util/src/is/function.ts @@ -18,6 +18,6 @@ type FnType = Function; * isFunction(() => false); // => true * ``` */ -export default function isFunction (value: unknown): value is FnType { +export function isFunction (value: unknown): value is FnType { return typeof value === 'function'; } diff --git a/packages/util/src/is/hex.ts b/packages/util/src/is/hex.ts index cf87b0ca9..fb8651c2a 100644 --- a/packages/util/src/is/hex.ts +++ b/packages/util/src/is/hex.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isString from './string'; +import { isString } from './string'; const HEX_REGEX = /^0x[a-fA-F0-9]+$/; @@ -21,7 +21,7 @@ const HEX_REGEX = /^0x[a-fA-F0-9]+$/; * ``` */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function isHex (value: unknown, bitLength = -1, ignoreLength = false): value is string | String { +export function isHex (value: unknown, bitLength = -1, ignoreLength = false): value is string | String { const isValidHex = value === '0x' || (isString(value) && HEX_REGEX.test(value.toString())); if (isValidHex && bitLength !== -1) { diff --git a/packages/util/src/is/index.ts b/packages/util/src/is/index.ts index 5162f9887..c9198ec94 100644 --- a/packages/util/src/is/index.ts +++ b/packages/util/src/is/index.ts @@ -4,26 +4,26 @@ /** * @summary Type checking utilities */ -export { default as isAscii } from './ascii'; -export { default as isBigInt } from './bigInt'; -export { default as isBn } from './bn'; -export { default as isBuffer } from './buffer'; -export { default as isBoolean } from './boolean'; -export { default as isChildClass } from './childClass'; -export { default as isError } from './error'; -export { default as isFunction } from './function'; -export { default as isHex } from './hex'; -export { default as isInstanceOf } from './instanceOf'; -export { default as isIp } from './ip'; -export { default as isJsonObject } from './jsonObject'; -export { default as isNull } from './null'; -export { default as isNumber } from './number'; -export { default as isObject } from './object'; -export { default as isObservable } from './observable'; -export { default as isString } from './string'; -export { default as isTestChain } from './testChain'; -export { default as isToBn } from './toBn'; -export { default as isU8a } from './u8a'; -export { default as isUndefined } from './undefined'; -export { default as isUtf8 } from './utf8'; -export { default as isWasm } from './wasm'; +export { isAscii } from './ascii'; +export { isBigInt } from './bigInt'; +export { isBn } from './bn'; +export { isBuffer } from './buffer'; +export { isBoolean } from './boolean'; +export { isChildClass } from './childClass'; +export { isError } from './error'; +export { isFunction } from './function'; +export { isHex } from './hex'; +export { isInstanceOf } from './instanceOf'; +export { isIp } from './ip'; +export { isJsonObject } from './jsonObject'; +export { isNull } from './null'; +export { isNumber } from './number'; +export { isObject } from './object'; +export { isObservable } from './observable'; +export { isString } from './string'; +export { isTestChain } from './testChain'; +export { isToBn } from './toBn'; +export { isU8a } from './u8a'; +export { isUndefined } from './undefined'; +export { isUtf8 } from './utf8'; +export { isWasm } from './wasm'; diff --git a/packages/util/src/is/instanceOf.ts b/packages/util/src/is/instanceOf.ts index 903502856..b1e9122d4 100644 --- a/packages/util/src/is/instanceOf.ts +++ b/packages/util/src/is/instanceOf.ts @@ -16,6 +16,6 @@ * ``` */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function isInstanceOf (value: unknown, clazz: Function): boolean { +export function isInstanceOf (value: unknown, clazz: Function): boolean { return value instanceof clazz; } diff --git a/packages/util/src/is/ip.ts b/packages/util/src/is/ip.ts index f5ddaffdc..cb2124fe3 100644 --- a/packages/util/src/is/ip.ts +++ b/packages/util/src/is/ip.ts @@ -22,7 +22,7 @@ type IpTypes = 'v4' | 'v6'; * isIp('1:2:3:4:5:6:7:8', 'v4'); // => false * ``` */ -export default function isIp (value: string, type?: IpTypes): boolean { +export function isIp (value: string, type?: IpTypes): boolean { if (type === 'v4') { return ipRegex.v4({ exact: true }).test(value); } else if (type === 'v6') { diff --git a/packages/util/src/is/jsonObject.ts b/packages/util/src/is/jsonObject.ts index d75cd1a39..f94082041 100644 --- a/packages/util/src/is/jsonObject.ts +++ b/packages/util/src/is/jsonObject.ts @@ -30,7 +30,7 @@ interface ObjectIndexed { * isJsonObject('not an object'); // => false * ``` */ -export default function isJsonObject (value: unknown): value is ObjectIndexed { +export function isJsonObject (value: unknown): value is ObjectIndexed { const str = typeof value !== 'string' ? JSON.stringify(value) : value; diff --git a/packages/util/src/is/null.ts b/packages/util/src/is/null.ts index c298dacba..d4fbe1b67 100644 --- a/packages/util/src/is/null.ts +++ b/packages/util/src/is/null.ts @@ -15,6 +15,6 @@ * console.log('isNull', isNull(null)); // => true * ``` */ -export default function isNull (value?: unknown): value is null { +export function isNull (value?: unknown): value is null { return value === null; } diff --git a/packages/util/src/is/number.ts b/packages/util/src/is/number.ts index 47f6fce1e..9138f5abf 100644 --- a/packages/util/src/is/number.ts +++ b/packages/util/src/is/number.ts @@ -15,6 +15,6 @@ * console.log('isNumber', isNumber(1234)); // => true * ``` */ -export default function isNumber (value: unknown): value is number { +export function isNumber (value: unknown): value is number { return typeof value === 'number'; } diff --git a/packages/util/src/is/object.ts b/packages/util/src/is/object.ts index 47a443719..b6ce7a11d 100644 --- a/packages/util/src/is/object.ts +++ b/packages/util/src/is/object.ts @@ -21,6 +21,6 @@ interface ObjectIndexed { * isObject('something'); // => false * ``` */ -export default function isObject (value: unknown): value is ObjectIndexed { +export function isObject (value: unknown): value is ObjectIndexed { return typeof value === 'object'; } diff --git a/packages/util/src/is/observable.ts b/packages/util/src/is/observable.ts index 23403cacb..b25414cef 100644 --- a/packages/util/src/is/observable.ts +++ b/packages/util/src/is/observable.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isFunction from './function'; -import isObject from './object'; +import { isFunction } from './function'; +import { isObject } from './object'; interface Observable { // eslint-disable-next-line @typescript-eslint/no-explicit-any @@ -23,6 +23,6 @@ interface Observable { * console.log('isObservable', isObservable(...)); * ``` */ -export default function isObservable (value: unknown): value is Observable { +export function isObservable (value: unknown): value is Observable { return isObject(value) && isFunction((value as Observable).next); } diff --git a/packages/util/src/is/string.ts b/packages/util/src/is/string.ts index d0d2deb7c..9c44655f4 100644 --- a/packages/util/src/is/string.ts +++ b/packages/util/src/is/string.ts @@ -16,6 +16,6 @@ * ``` */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function isString (value: unknown): value is string | String { +export function isString (value: unknown): value is string | String { return typeof value === 'string' || value instanceof String; } diff --git a/packages/util/src/is/testChain.spec.ts b/packages/util/src/is/testChain.spec.ts index 9a8b7f6c7..57ba35f93 100644 --- a/packages/util/src/is/testChain.spec.ts +++ b/packages/util/src/is/testChain.spec.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isTestChain from './testChain'; +import { isTestChain } from '.'; describe('isTestChain', (): void => { it('enables test environment when chain specification matches text of dev or loc(al)', (): void => { diff --git a/packages/util/src/is/testChain.ts b/packages/util/src/is/testChain.ts index 2e139ee8c..95e725222 100644 --- a/packages/util/src/is/testChain.ts +++ b/packages/util/src/is/testChain.ts @@ -3,7 +3,7 @@ const re = /(Development|Local Testnet)$/; -export default function isTestChain (chain?: string | null): boolean { +export function isTestChain (chain?: string | null): boolean { if (!chain) { return false; } diff --git a/packages/util/src/is/toBn.ts b/packages/util/src/is/toBn.ts index 3da43cb42..b2ba8b94e 100644 --- a/packages/util/src/is/toBn.ts +++ b/packages/util/src/is/toBn.ts @@ -3,8 +3,8 @@ import { ToBn } from '../types'; -import isFunction from './function'; +import { isFunction } from './function'; -export default function isToBn (value?: unknown): value is ToBn { +export function isToBn (value?: unknown): value is ToBn { return !!value && isFunction((value as ToBn).toBn); } diff --git a/packages/util/src/is/u8a.ts b/packages/util/src/is/u8a.ts index 65104ea00..2326e95a6 100644 --- a/packages/util/src/is/u8a.ts +++ b/packages/util/src/is/u8a.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isInstanceOf from './instanceOf'; +import { isInstanceOf } from './instanceOf'; /** * @name isU8a @@ -17,6 +17,6 @@ import isInstanceOf from './instanceOf'; * console.log('isU8a', isU8a([])); // => false * ``` */ -export default function isU8a (value?: unknown): value is Uint8Array { +export function isU8a (value?: unknown): value is Uint8Array { return isInstanceOf(value, Uint8Array); } diff --git a/packages/util/src/is/undefined.ts b/packages/util/src/is/undefined.ts index 36d492842..17c244365 100644 --- a/packages/util/src/is/undefined.ts +++ b/packages/util/src/is/undefined.ts @@ -16,6 +16,6 @@ * ``` */ // eslint-disable-next-line @typescript-eslint/no-explicit-any -export default function isUndefined (value?: unknown): value is undefined { +export function isUndefined (value?: unknown): value is undefined { return typeof value === 'undefined'; } diff --git a/packages/util/src/is/utf8.ts b/packages/util/src/is/utf8.ts index 3dd9ce3f1..d422f23bb 100644 --- a/packages/util/src/is/utf8.ts +++ b/packages/util/src/is/utf8.ts @@ -3,8 +3,8 @@ // Adapted from https://github.com/JulienPalard/is_utf8/blob/master/is_utf8.c -import u8aToU8a from '../u8a/toU8a'; -import isString from './string'; +import { u8aToU8a } from '../u8a/toU8a'; +import { isString } from './string'; /** * @name isUtf8 @@ -12,7 +12,7 @@ import isString from './string'; * @description * Checks to see if the input string or Uint8Array is valid Utf8 */ -export default function isUtf8 (value?: number[] | Buffer | Uint8Array | string | null): boolean { +export function isUtf8 (value?: number[] | Buffer | Uint8Array | string | null): boolean { if (!value) { return isString(value); } diff --git a/packages/util/src/is/wasm.ts b/packages/util/src/is/wasm.ts index ab6bbbe9c..1c3ffc193 100644 --- a/packages/util/src/is/wasm.ts +++ b/packages/util/src/is/wasm.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import u8aEq from '../u8a/eq'; +import { u8aEq } from '../u8a/eq'; const WASM_MAGIC = new Uint8Array([0, 97, 115, 109]); // \0asm @@ -11,6 +11,6 @@ const WASM_MAGIC = new Uint8Array([0, 97, 115, 109]); // \0asm * @description * Checks to see if the input Uint8Array contains a valid WASM header */ -export default function isWasm (value?: Uint8Array): boolean { +export function isWasm (value?: Uint8Array): boolean { return !!value && u8aEq(value.subarray(0, 4), WASM_MAGIC); } diff --git a/packages/util/src/logger.ts b/packages/util/src/logger.ts index 7dedf39b8..0657996ea 100644 --- a/packages/util/src/logger.ts +++ b/packages/util/src/logger.ts @@ -3,13 +3,13 @@ import { Logger, Logger$Data } from './types'; -import formatDate from './format/formatDate'; -import isBn from './is/bn'; -import isFunction from './is/function'; -import isObject from './is/object'; -import isU8a from './is/u8a'; -import u8aToHex from './u8a/toHex'; -import u8aToU8a from './u8a/toU8a'; +import { formatDate } from './format/formatDate'; +import { isBn } from './is/bn'; +import { isFunction } from './is/function'; +import { isObject } from './is/object'; +import { isU8a } from './is/u8a'; +import { u8aToHex } from './u8a/toHex'; +import { u8aToU8a } from './u8a/toU8a'; import { isBuffer } from './is'; type ConsoleType = 'error' | 'log' | 'warn'; @@ -78,7 +78,7 @@ function noop (): void { * l.log('blah'); // TEST: blah * ``` */ -export default function logger (_type: string): Logger { +export function logger (_type: string): Logger { const type = `${_type.toUpperCase()}:`.padStart(16); let isDebug; diff --git a/packages/util/src/number/index.ts b/packages/util/src/number/index.ts index 50f57fe0e..b3deaee6e 100644 --- a/packages/util/src/number/index.ts +++ b/packages/util/src/number/index.ts @@ -5,5 +5,5 @@ * @summary Utility methods to convert to and from `number` values */ -export { default as numberToHex } from './toHex'; -export { default as numberToU8a } from './toU8a'; +export { numberToHex } from './toHex'; +export { numberToU8a } from './toU8a'; diff --git a/packages/util/src/number/toHex.ts b/packages/util/src/number/toHex.ts index 078de530b..8689b22f7 100644 --- a/packages/util/src/number/toHex.ts +++ b/packages/util/src/number/toHex.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import hexFixLength from '../hex/fixLength'; -import isNull from '../is/null'; -import isUndefined from '../is/undefined'; +import { hexFixLength } from '../hex/fixLength'; +import { isNull } from '../is/null'; +import { isUndefined } from '../is/undefined'; /** * @name numberToHex @@ -20,7 +20,7 @@ import isUndefined from '../is/undefined'; * numberToHex(0x1234, 32); // => 0x00001234 * ``` */ -export default function numberToHex (value?: number | null, bitLength = -1): string { +export function numberToHex (value?: number | null, bitLength = -1): string { if (isUndefined(value) || isNull(value) || isNaN(value)) { return '0x'; } diff --git a/packages/util/src/number/toU8a.ts b/packages/util/src/number/toU8a.ts index b6276c4ad..7413056f3 100644 --- a/packages/util/src/number/toU8a.ts +++ b/packages/util/src/number/toU8a.ts @@ -1,10 +1,10 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import hexToU8a from '../hex/toU8a'; -import isNull from '../is/null'; -import isUndefined from '../is/undefined'; -import numberToHex from './toHex'; +import { hexToU8a } from '../hex/toU8a'; +import { isNull } from '../is/null'; +import { isUndefined } from '../is/undefined'; +import { numberToHex } from './toHex'; /** * @name numberToU8a @@ -20,7 +20,7 @@ import numberToHex from './toHex'; * numberToU8a(0x1234); // => [0x12, 0x34] * ``` */ -export default function numberToU8a (value?: number | null, bitLength = -1): Uint8Array { +export function numberToU8a (value?: number | null, bitLength = -1): Uint8Array { if (isUndefined(value) || isNull(value) || isNaN(value)) { return new Uint8Array(); } diff --git a/packages/util/src/promisify.ts b/packages/util/src/promisify.ts index 146575f71..23ecf0aab 100644 --- a/packages/util/src/promisify.ts +++ b/packages/util/src/promisify.ts @@ -17,7 +17,7 @@ * ``` */ // eslint-disable-next-line @typescript-eslint/no-explicit-any -export default function promisify (self: unknown, fn: (...params: any) => any, ...params: any[]): Promise { +export function promisify (self: unknown, fn: (...params: any) => any, ...params: any[]): Promise { return new Promise((resolve, reject): void => { const handler = (error: Error | null, result?: R): void => { if (error) { diff --git a/packages/util/src/string/camelCase.ts b/packages/util/src/string/camelCase.ts index b572e3ee6..521b7becf 100644 --- a/packages/util/src/string/camelCase.ts +++ b/packages/util/src/string/camelCase.ts @@ -8,6 +8,6 @@ import camelcase from 'camelcase'; * @summary Convert a dash/dot/underscore/space separated string/String to camelCase */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function stringCamelCase (value: string | String): string { +export function stringCamelCase (value: string | String): string { return camelcase(value.toString()); } diff --git a/packages/util/src/string/index.ts b/packages/util/src/string/index.ts index a30939a0a..2ea557837 100644 --- a/packages/util/src/string/index.ts +++ b/packages/util/src/string/index.ts @@ -5,9 +5,9 @@ * @summary Utility methods to convert to work with `string` values */ -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'; +export { stringCamelCase } from './camelCase'; +export { stringLowerFirst } from './lowerFirst'; +export { stringShorten } from './shorten'; +export { stringToHex } from './toHex'; +export { stringToU8a } from './toU8a'; +export { stringUpperFirst } from './upperFirst'; diff --git a/packages/util/src/string/lowerFirst.ts b/packages/util/src/string/lowerFirst.ts index c94b98e73..772541a07 100644 --- a/packages/util/src/string/lowerFirst.ts +++ b/packages/util/src/string/lowerFirst.ts @@ -16,7 +16,7 @@ * ``` */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function stringLowerFirst (value?: string | String | null): string { +export function stringLowerFirst (value?: string | String | null): string { return value ? value.charAt(0).toLowerCase() + value.slice(1) : ''; diff --git a/packages/util/src/string/shorten.ts b/packages/util/src/string/shorten.ts index 7f4447740..a3bbb7864 100644 --- a/packages/util/src/string/shorten.ts +++ b/packages/util/src/string/shorten.ts @@ -16,7 +16,7 @@ * ``` */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function stringShorten (value: String | string, prefixLength = 6): string { +export function stringShorten (value: String | string, prefixLength = 6): string { if (value.length <= 2 + 2 * prefixLength) { return value.toString(); } diff --git a/packages/util/src/string/toHex.ts b/packages/util/src/string/toHex.ts index fd7cd540c..a2357ecd8 100644 --- a/packages/util/src/string/toHex.ts +++ b/packages/util/src/string/toHex.ts @@ -1,8 +1,8 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import u8aToHex from '../u8a/toHex'; -import stringToU8a from './toU8a'; +import { u8aToHex } from '../u8a/toHex'; +import { stringToU8a } from './toU8a'; /** * @name stringToHex @@ -19,7 +19,7 @@ import stringToU8a from './toU8a'; * ``` */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function stringToHex (value?: String | string): string { +export function stringToHex (value?: String | string): string { return u8aToHex( stringToU8a(value) ); diff --git a/packages/util/src/string/toU8a.ts b/packages/util/src/string/toU8a.ts index 275e8f141..cad140a29 100644 --- a/packages/util/src/string/toU8a.ts +++ b/packages/util/src/string/toU8a.ts @@ -20,7 +20,7 @@ const encoder = new TextEncoder(); * ``` */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function stringToU8a (value?: String | string): Uint8Array { +export function stringToU8a (value?: String | string): Uint8Array { return value ? encoder.encode(value.toString()) : new Uint8Array(); diff --git a/packages/util/src/string/upperFirst.ts b/packages/util/src/string/upperFirst.ts index 2d97ae022..4797580cb 100644 --- a/packages/util/src/string/upperFirst.ts +++ b/packages/util/src/string/upperFirst.ts @@ -16,7 +16,7 @@ * ``` */ // eslint-disable-next-line @typescript-eslint/ban-types -export default function stringUpperFirst (value?: String | string | null): string { +export function stringUpperFirst (value?: String | string | null): string { return value ? value.charAt(0).toUpperCase() + value.slice(1) : ''; diff --git a/packages/util/src/u8a/concat.ts b/packages/util/src/u8a/concat.ts index 787d365b6..7a84bace5 100644 --- a/packages/util/src/u8a/concat.ts +++ b/packages/util/src/u8a/concat.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import u8aToU8a from './toU8a'; +import { u8aToU8a } from './toU8a'; /** * @name u8aConcat @@ -12,7 +12,7 @@ import u8aToU8a from './toU8a'; *
* * ```javascript - * import { u8aConcat } from '@polkadot/util'; + * import { { u8aConcat } from '@polkadot/util'; * * u8aConcat( * new Uint8Array([1, 2, 3]), @@ -20,7 +20,7 @@ import u8aToU8a from './toU8a'; * ); // [1, 2, 3, 4, 5, 6] * ``` */ -export default function u8aConcat (...list: (Uint8Array | string)[]): Uint8Array { +export function u8aConcat (...list: (Uint8Array | string)[]): Uint8Array { let length = 0; let offset = 0; const u8as = new Array(list.length) as Uint8Array[]; diff --git a/packages/util/src/u8a/eq.ts b/packages/util/src/u8a/eq.ts index 278e35c66..25feb8bed 100644 --- a/packages/util/src/u8a/eq.ts +++ b/packages/util/src/u8a/eq.ts @@ -1,7 +1,7 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import u8aToU8a from './toU8a'; +import { u8aToU8a } from './toU8a'; function equals (a: Uint8Array, b: Uint8Array): boolean { if (a.length !== b.length) { @@ -26,11 +26,11 @@ function equals (a: Uint8Array, b: Uint8Array): boolean { *
* * ```javascript - * import { u8aEq } from '@polkadot/util'; + * import { { u8aEq } from '@polkadot/util'; * * u8aEq(new Uint8Array([0x68, 0x65]), new Uint8Array([0x68, 0x65])); // true * ``` */ -export default function u8aEq (a: Uint8Array | string, b: Uint8Array | string): boolean { +export function u8aEq (a: Uint8Array | string, b: Uint8Array | string): boolean { return equals(u8aToU8a(a), u8aToU8a(b)); } diff --git a/packages/util/src/u8a/fixLength.ts b/packages/util/src/u8a/fixLength.ts index 7df6d4460..7cdc0d825 100644 --- a/packages/util/src/u8a/fixLength.ts +++ b/packages/util/src/u8a/fixLength.ts @@ -17,7 +17,7 @@ * u8aFixLength('0x1234', 8) // => 0x12 * ``` */ -export default function u8aFixLength (value: Uint8Array, bitLength = -1, atStart = false): Uint8Array { +export function u8aFixLength (value: Uint8Array, bitLength = -1, atStart = false): Uint8Array { const byteLength = Math.ceil(bitLength / 8); if (bitLength === -1 || value.length === byteLength) { diff --git a/packages/util/src/u8a/index.ts b/packages/util/src/u8a/index.ts index d289fb84a..df981aa45 100644 --- a/packages/util/src/u8a/index.ts +++ b/packages/util/src/u8a/index.ts @@ -5,12 +5,12 @@ * @summary Utility methods to convert to and from `Uint8Array` objects */ -export { default as u8aConcat } from './concat'; -export { default as u8aEq } from './eq'; -export { default as u8aFixLength } from './fixLength'; -export { default as u8aSorted } from './sorted'; -export { default as u8aToBn } from './toBn'; -export { default as u8aToBuffer } from './toBuffer'; -export { default as u8aToHex } from './toHex'; -export { default as u8aToString } from './toString'; -export { default as u8aToU8a } from './toU8a'; +export { u8aConcat } from './concat'; +export { u8aEq } from './eq'; +export { u8aFixLength } from './fixLength'; +export { u8aSorted } from './sorted'; +export { u8aToBn } from './toBn'; +export { u8aToBuffer } from './toBuffer'; +export { u8aToHex } from './toHex'; +export { u8aToString } from './toString'; +export { u8aToU8a } from './toU8a'; diff --git a/packages/util/src/u8a/sorted.ts b/packages/util/src/u8a/sorted.ts index 30898e560..e02ba0708 100644 --- a/packages/util/src/u8a/sorted.ts +++ b/packages/util/src/u8a/sorted.ts @@ -1,9 +1,9 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isUndefined from '../is/undefined'; +import { isUndefined } from '../is/undefined'; -export default function u8aSorted (u8as: Uint8Array[]): Uint8Array[] { +export function u8aSorted (u8as: Uint8Array[]): Uint8Array[] { return u8as.sort((a, b): number => { let i = 0; diff --git a/packages/util/src/u8a/toBn.ts b/packages/util/src/u8a/toBn.ts index 012687d4f..95ab7a9d0 100644 --- a/packages/util/src/u8a/toBn.ts +++ b/packages/util/src/u8a/toBn.ts @@ -3,8 +3,8 @@ import BN from 'bn.js'; -import hexToBn from '../hex/toBn'; -import u8aToHex from './toHex'; +import { hexToBn } from '../hex/toBn'; +import { u8aToHex } from './toHex'; import { ToBnOptions } from '../types'; /** @@ -25,7 +25,7 @@ import { ToBnOptions } from '../types'; * u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f * ``` */ -export default function u8aToBn (value: Uint8Array, options: ToBnOptions | boolean = { isLe: true, isNegative: false }): BN { +export function u8aToBn (value: Uint8Array, options: ToBnOptions | boolean = { isLe: true, isNegative: false }): BN { return hexToBn( u8aToHex(value), options diff --git a/packages/util/src/u8a/toBuffer.ts b/packages/util/src/u8a/toBuffer.ts index 76ca50a9b..84b89bcb8 100644 --- a/packages/util/src/u8a/toBuffer.ts +++ b/packages/util/src/u8a/toBuffer.ts @@ -15,7 +15,7 @@ * console.log('Buffer', u8aToBuffer('0x123480001f')); * ``` */ -export default function u8aToBuffer (value?: Uint8Array | null): Buffer { +export function u8aToBuffer (value?: Uint8Array | null): Buffer { return !value ? Buffer.from([]) : Buffer.from(value); diff --git a/packages/util/src/u8a/toHex.ts b/packages/util/src/u8a/toHex.ts index af33fd003..f5ef93516 100644 --- a/packages/util/src/u8a/toHex.ts +++ b/packages/util/src/u8a/toHex.ts @@ -33,7 +33,7 @@ function trim (value: Uint8Array, halfLength: number): string { * u8aToHex(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0xf])); // 0x68656c0f * ``` */ -export default function u8aToHex (value?: Uint8Array | null, bitLength = -1, isPrefixed = true): string { +export function u8aToHex (value?: Uint8Array | null, bitLength = -1, isPrefixed = true): string { const prefix = isPrefixed ? '0x' : ''; diff --git a/packages/util/src/u8a/toString.ts b/packages/util/src/u8a/toString.ts index 6bfbe954d..7e08642b5 100644 --- a/packages/util/src/u8a/toString.ts +++ b/packages/util/src/u8a/toString.ts @@ -19,7 +19,7 @@ const decoder = new TextDecoder('utf-8'); * u8aToString(new Uint8Array([0x68, 0x65, 0x6c, 0x6c, 0x6f])); // hello * ``` */ -export default function u8aToString (value?: Uint8Array | null): string { +export function u8aToString (value?: Uint8Array | null): string { return !value?.length ? '' : decoder.decode(value); diff --git a/packages/util/src/u8a/toU8a.ts b/packages/util/src/u8a/toU8a.ts index 3cfeeb431..ff3082ca5 100644 --- a/packages/util/src/u8a/toU8a.ts +++ b/packages/util/src/u8a/toU8a.ts @@ -1,12 +1,12 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import isBuffer from '../is/buffer'; -import isHex from '../is/hex'; -import isString from '../is/string'; -import bufferToU8a from '../buffer/toU8a'; -import hexToU8a from '../hex/toU8a'; -import stringToU8a from '../string/toU8a'; +import { isBuffer } from '../is/buffer'; +import { isHex } from '../is/hex'; +import { isString } from '../is/string'; +import { bufferToU8a } from '../buffer/toU8a'; +import { hexToU8a } from '../hex/toU8a'; +import { stringToU8a } from '../string/toU8a'; function convertArray (value: number[] | Uint8Array): Uint8Array { return Array.isArray(value) @@ -29,13 +29,13 @@ function convertString (value: string): Uint8Array { *
* * ```javascript - * import { u8aToU8a } from '@polkadot/util'; + * import { { u8aToU8a } from '@polkadot/util'; * * u8aToU8a(new Uint8Array([0x12, 0x34]); // => Uint8Array([0x12, 0x34]) * u8aToU8a(0x1234); // => Uint8Array([0x12, 0x34]) * ``` */ -export default function u8aToU8a (value?: number[] | Buffer | Uint8Array | string | null): Uint8Array { +export function u8aToU8a (value?: number[] | Buffer | Uint8Array | string | null): Uint8Array { if (!value) { return new Uint8Array(); } else if (isBuffer(value)) {