CHANGELOG
master
Changes:
- Add
floatToU8a
andu8aToFloat
(both 32 & 64-bit, le & be) - Adjust
isUndefined
check (local variable available)
9.5.1 Jun 18, 2022
Contributed:
- Update Bifrost genesisHash (Thanks to https://github.com/awesomepan)
- Add Ledger support for Composable (Thanks to https://github.com/carlosala)
Changes:
- Add
u8aToNumber
(limited, <= 48 bits) function - Use
~~
as bitwise/fasterMath.floor
replacement - Remove unneeded
objectSpread
option expansions - Optimize
hexToU8a
operations - Optimize
stringCamelCase
operations - Optimize
u8aToBn
operations - Additional internal/external comments (as missing)
- Upgrade dependencies to latest stable versions
9.4.1 Jun 4, 2022
Changes:
- Add
nextTick
to@polkadot/util
to defer execution to the queue - Upgrade dependencies to latest stable versions
9.3.1 May 29, 2022
Contributed:
- Add Ledger support for Parallel (Thanks to https://github.com/carlosala)
- Add Ledger support for Astar & Polkadex (Thanks to https://github.com/carlosala)
Changes:
- Adjust
u8aToU8a
checks with betterisU8a
shortcut - Adjust compact conversion with unrolled loops
- Adjust
string{Camel, Pascal}Case
with loop (no map) - Add
compactFromU8aLim
variant with Uint8Array-only inputs - Add
u8aConcatStrict
variant with Uint8Array-only inputs - Internal code maintainability enhancements
- Upgrade dependencies to latest stable versions
9.2.1 May 13, 2022
Contributed:
- Add Ledger support for Acala (Thanks to https://github.com/ntduan)
Changes:
- Optimize
u8aToHex
with direct (non-hex) conversion - Change all occurences of
.substr(...)
to.substring(...)
- Sync with upstream Substrate ss58 registry
- Mark deprecated function signatures (no removals)
- Re-enable auto init of
cryptoWaitReady()
- Upgrade to
@polkadot/wasm-crypto
6.1.1
9.1.1 Apr 30, 2022
Contributed:
- Add Ledger support for Statemint (Thanks to https://github.com/carlosala)
- Add Ledger support for xxnetwork (Thanks to https://github.com/xx-labs)
Changes:
- Adjust/dedupe output from
detectPackage
- Adjust
isHex
performance test - Add field-level comments to some
*Options
structures - Add new Rococo genesisHash (reset)
9.0.1 Apr 9, 2022
- Breaking change In this major version the commonjs outputs are moved to a sub-folder. Since the export map and main field in package.json does reflect this change, there should be no usage changes. However the packages here will all need to be on the same version for internal linkage.
Changes:
- Be explicit in
@polkadot/util-crypto
re-exports from@polkadot/networks
- Output commonjs files under the
cjs/**
root - Upgrade to
@polkadot/wasm-crypto
6.0.1
8.7.1 Mar 27, 2022
Changes:
- Fix race-condition with wasm overrides, make
cryptoWaitReady
lazy - Additional tests for
BN
&BigInt
negative conversions - Upgrade to
@polkadot/wasm-crypto
5.1.1
8.6.1 Mar 19, 2022
Important This contains an upgraded version of @polkadot/wasm-crypto
. For users of asm.js, e.g. React Native, there are some additional upgrade instructions in the release notes for this version https://github.com/polkadot-js/wasm/releases/tag/v5.0.1
Contributed:
- Add aditional Dock mainnet genesis (Thanks to https://github.com/lovesh)
- Add Westend genesis (Thanks to https://github.com/Nick-1979)
- Update README with ss58 links (Thanks to https://github.com/Nick-197)
Changes:
- Ensure invalid secp256k1 publicKeys are not returned
- Cater for Expo v41+ in RN random value generation
- Fixed for RN environment imports
- Internal split of details in
@polkadot/networks
- Additional workaround for Vite bundling
- Upgrade to
@polkadot/wasm-crypto
5.0.1
8.5.1 Mar 12, 2022
Changes:
- Adjust for bundlers where
import.meta.url
is undefined - Upgrade dependencies to latest stable versions
8.4.1 Feb 14, 2022
Changes:
- Use upstream
@substrate/ss58-registry
(instead of duplicating here) - Swap
micro-base
to@scure/base
(same package, audited) - Bump
bn.js
library to latest 5.2.0 (has impact on e.g. API) - Upgrade dependencies to latest stable versions
8.3.3 Jan 23, 2022
Changes:
- Sync with upstream Substrate ss58 registry
8.3.2 Jan 15, 2022
Changes:
- Correct network sorting (primary by prefix, secondary by name)
- Sync with upstream Substrate ss58 registry
8.3.1 Jan 9, 2022
Changes:
- Fix
util-crypto
bundle generation (adjustx-randomvalues
) - Add all known Rococo genesis hashes
detectPackage
now uses optionalpath
&type
(esm
orcjs
) info- Ensure package paths are available via ESM and CJS
- Upgrade 3rd party dependencies to latest
- Pin
@noble/*
to latest known tested integrated versions
8.2.2 Dec 19, 2021
Contributed:
- Add Bifrost Ledger capabilities (Thanks to https://github.com/awesomepan)
- Add Sora genesisHash & Ledger capabilities (Thanks to https://github.com/NoodleSploder)
Changes:
- Add
isPromise
check utility function - Add
assertUnreachable
for codepaths that should not be followed - Preserve all-caps word splits in
stringCamelCase
- Adjust
x-*
fallbacks viax-global/extractGlobal
- Sync with upstream Substrate ss58 registry
- Additional tests for
bip39
wordlists - Maintainability cleanups
- Update to latest Ledger dependencies
- Swap to upstream
@noble
packages - Adjust tsconfig with references
- 8.2.2 (8.2.1 failed CI due to incorrect CHANGELOG)
8.1.2 Dec 5, 2021
Changes:
- Adjustment to non-full-word consecutive uppercase via
string{Camel, Pascal}Case
8.1.1 Dec 5, 2021
Contributed:
- Add Picasso genesisHash (Thanks to https://github.com/hussein-aitlahcen)
Changes:
- Allow for use of
secp256k1
from@polkadot/wasm-crypto
- Adjust
isBigInt
to not doinstanceof
check - Ensure consequtive capitals in
stringCamelCase
are lowercased - Use
@polkadot/x-bigint
forBigInt
constructor - Split
@noble/hashes
fork intox-noble-hashes
- Add
@noble/secp256k1
fork intox-noble-secp256k1
, replaceselliptic
8.0.5 Dec 1, 2021
Changes:
- Adjust sha3 expectation of
BigInt
availability
8.0.4 Nov 30, 2021
Changes:
- Adjust
stringCamelCase
with leading_
8.0.3 Nov 30, 2021
Changes:
- Remove
Buffer
usage inx-randomvalues
- Adjust
stringCamelCase
for all-caps parts
8.0.2 Nov 26, 2021
Changes:
- Explicitly include BigInt patched versions
8.0.1 Nov 26, 2021
Important In the 8.0 version the hashing utilities have been consolidated around an optimized and audited version from @noble/hashes
. As in the past the WASM hashing will be used by default if the environment is initialized.
Breaking change The schnorrkel*
functions have been renamed to sr25519*
. Likewise the ed25519
operations have been renamed from nacl*
to ed25519*
. Additionally the {ed, sr, secp256k1}25519KeyPairFrom*
functions have been renamed to {ed, sr, secp256k1}25519PairFrom*
.
Changes:
- Introduce
ed25519*
&sr25519*
functions - Replace camelcase dep with simplified/optimized version
- Replace (most) hashing operations with
@noble/hashes
- Replace JS fallback for
xxhash
- Adjust
BigInt
utility exports (with capability detection) - Previously added
bi*
functions renamed ton*
- Extend performance tests with implementation compares
- Remove non-significant Node Buffer concat fill
7.9.2 Nov 22, 2021
Changes:
- Fix TS compiled definitions for
base*
types - Provide JS/Wasm interfaces for
hmacShaAsU8a
7.9.1 Nov 21, 2021
Contributed:
- Updated Polymesh genesisHash (Thanks to https://github.com/adamdossa)
Changes:
- Add strongly typed
object{Entries, Keys, Values}
utilities - Add
{hex, u8a}ToBigInt
utilities - Add
bi*
utilities forbigint
operations (mirror ofbn*
) - Add
stringPascalCase
utility - Add
isCodec
to check for Codec-like structures - Add
has*
detection shortcuts (e.g.hasWasm
orhasBuffer
) - Add
sha256AsU8a
util (& replace use internally) - Optimize for
hexToU8a
andu8aToHex
functions - Optimize
u8aEq
to useDataView
for compares - Align
base{32, 58, 64}*
around (audited)micro-base
- Space optimization for bip39 wordlists
- Sync with upstream Substrate ss58 registry
- Expand tests for uncovered functions
7.8.2 Nov 7, 2021
Changes:
- Expose internal
isArray
check - Move
object{Property, Properties}
from api repo
7.8.1 Nov 6, 2021
Contributed:
- Added Acala genesisHash (Thanks to https://github.com/qwer951123)
Changes:
- Add
objectClear
andobjectSpread
utility functions - Add
lazyMethod
&lazyMethods
utility functions - Sync with upstream Substrate ss58 registry
7.7.1 Oct 31, 2021
Contributed:
- Add Genshiro support (Thanks to https://github.com/Overseven)
Changes:
- Add
arrayZip
to combine a key + value array into entries-like - Assert
chainCode
inputs toderive*
, protecting against misuse - Adjust testnet detection in
@polkadot/networks
- Adjust base library usage of
for
vsreduce/map
- Bump Ledger libraries to latest versions
7.6.1 Oct 23, 2021
Changes:
- Update
xxhash*
to only useUint8Array
internally, noBuffer
- Adjust
isAscii
to check against original string codepoints (when provided) - Adjust networks to sync with
paritytech/ss58-registry
- Dedupe internal sr25519/ed25519 derivation functions
- Bump Ledger libraries to latest versions
7.5.1 Oct 16, 2021
Contributed:
- Fix comment on
blake2AsU8a
(Thanks to https://github.com/tomokazukozuma) - Update Ethereum derivation process (Thanks to https://github.com/joelamouche)
Changes:
- Derivation paths now caters for >
MAX_SAFE_INTEGER
unsigned values - Sync with upstream Substrate ss58 registry
- Update ss58 registry handling (both previous and current versions)
7.4.1 Sep 17, 2021
Changes:
- Add
u8aWrapBytes
&u8aUnwrapBytes
(originally from@polkadot/extension-dapp
) - Verify both wrapped and unwrapped signatures transparently
- Adjust
isHex
return to0x${string}
under TypeScript - Adjust shared repo Jest config
- Sync with upstream Substrate ss58 registry
- Cleanup rollup build where
x-global
yields undefined
7.3.1 Aug 28, 2021
Contributed:
- Added Bifrost genesisHash (Thanks to https://github.com/awesomepan)
- Added Stafi genesisHash (Thanks to https://github.com/Tore19)
- Add Ledger support for Nodle (Thanks to https://github.com/ETeissonniere)
Changes:
- Add support for
schnorrkelAgreement
(as exposed by newwasm-crypto
) - Ensure
schnorrkel*
functions allows hex inputs @polkadot/wasm-crypto
4.2.1- Sync with upstream Substrate ss58 registry
7.2.1 Aug 15, 2021
Contributed:
- Always use
bigint
type to indicate instance (Thanks to https://github.com/ntduan)
Changes:
- Added
u8aEmpty
helper check, all 0 or no length - Cleanup additional circular dependencies detected by rollup
7.1.2 Aug 11, 2021
Changes:
- Ensure
@polkadot/util-crypto
doesn’t re-exportpackageInfo
from@polkadot/networks
- Minor TS style cleanups in
@polkadot/x-bundle
7.1.1 Aug 2, 2021
Contributed:
- Add keyring encrypt/decrypt functionality (Thanks to https://github.com/RoyTimes)
Changes:
- Bump Ledger libraries to latest versions
7.0.3 Jul 26, 2021
Changes:
- Sync with upstream Substrate ss58 registry
- Bump Ledger libraries to latest versions
7.0.2 Jul 19, 2021
Changes:
- Added
isCompact
utility for check on compact-like types - Sync with upstream Substrate ss58 registry
7.0.1 Jul 11, 2021
- Breaking change The
@polkadot/x-rxjs
package has been removed. Inrxjs
7.2.0 the compatibility issues at the base layer has been solved. - Breaking change The named exports in
@polkadot/networks
has been changed
Contributed:
- Add Ledger config for Centrifuge (Thanks to https://github.com/mikiquantum)
Changes:
- Adjust
@polkadot/networks
to fully-descriptive exports - Remove
@polkadot/x-rxjs
, direct import fromrxjs >= 7.2.0
required - Allow building as a completely stand-alone browser bundle (experimental)
- Sync with upstream Substrate ss58 registry
6.11.1 Jul 5, 2021
Changes:
- Cleanup unneeded dependencies for
@polkadot/x-global
- Sync with upstream Substrate ss58 registry
- Bump Zondax dependencies (Statemine slip44 fix)
6.10.1 Jun 26, 2021
Contributed:
- Add Karura genesisHash (Thanks to https://github.com/ntduan)
Changes:
isHex(value)
will now check for onlystring
types (NoString
classes)- Added
arrayShuffle(array)
to shuffle an array into a new output - Added Statemine Ledger app information
- Simplify tests to use
{describe|it}.each
where applicable - Sync with upstream Substrate ss58 registry
6.9.1 Jun 19, 2021
Changes:
- Added
u8aCmp(a, b)
to do sorting compares - Added
arrayRange(size, startAt = 0)
to create a range of numbers - Added extensive mnemonic compare test (optional, skipped)
6.8.1 Jun 14, 2021
Contributed:
- Add Ledger support for Edgeware (Thanks to https://github.com/raykyri)
- Fix
naclSeal
doc types (Thanks to https://github.com/agustinustheo)
Changes:
- Export
BN
in@polkadot/util
- Sync with upstream Substrate ss58 registry
6.7.1 Jun 6, 2021
Changes:
- Add WebHID transport for Ledger
- Update to latest Ledger transport packages
- Remove old
Gerald
key for Moonbeam - Cleanup testing keyring semgrep recommendations
6.6.1 May 29, 2021
Changes:
- Adjust HD path validation & replacement
- Sync with Substrate ss58 registry
6.5.1 May 22, 2021
Changes:
- Allow hdLedger derivation with optional 25th word password
- Sync with Substrate ss58 registry
6.4.1 May 15, 2021
Contributed:
- Update genesis for HydraDx gen-3 (Thanks to https://github.com/jak-pan)
- Allow Ethereum pair in keyring addAddress (Thanks to https://github.com/joelamouche)
Changes:
- Added additional double-byte ss58 tests
- Aligned ss58 registry with Substrate
- Add explicit log for deprecation of
setSS58Format
6.3.1 Apr 25, 2021
Changes:
- Added
stringify
util to correctly handleJSON.stringify
withBigInt
values - Additional input asserts for non-convertible values in
u8aToU8a
- Adapt
@polkadot/x-global
to returnglobalThis
as available - Minor readability cleanups
- BN manipulation via in-place shifts (as applicable)
- Add explicit
engines
config topackage.json
6.2.1 Apr 18, 2021
Contributed:
- Added HydraDx genesis (Thanks to https://github.com/jak-pan)
Changes:
- Add
isAddress
andvalidateAddress
functions (the latter will throw if invalid) - Check
@polkadot/hw-ledger
against@polkadot/networks
for discrepancies (test-only) - Align ss58 registry with upstream Substrate
6.1.1 Apr 11, 2021
Contributed:
- Adjust Polymath genesis in
@polkadot/networks
(Thanks to https://github.com/adamdossa) - Adjust
@polkadot/util
logger for +/-/* compat (Thanks to https://github.com/Lezek123) - Fix typo in
@polkadot/util
detect messaging (Thanks to https://github.com/amphineko)
Changes:
- Remove
@polkadot/networks
code duplication, manages data via script from upstream - Align ss58 registry with upstream Substrate
6.0.5 Mar 8, 2021
Changes:
- Fix for
@polkadot/x-rxjs
in Node CJS environments (no Node-specific import)
6.0.4 Mar 7, 2021
Contributed:
- Enhance check for global process existence (Thanks to https://github.com/Yuripetusko)
Changes:
- Dedupe & optimize logger process.env checks
6.0.3 Mar 5, 2021
Changes:
- Add import indirection for both CJS & ESM (where generated source file is commonjs)
6.0.2 Mar 5, 2021
Changes:
- Fix
@polkadot/x-rxjs
ESM exports for Node environments (now different due to the ESM conversion)
6.0.1 Mar 5, 2021
Important In the 6.0 version the default package type has been changed to ESM modules by default. This should not affect usage, however since the output formats changed, a new major version is required.
Contributed:
- Add dev addresses for Frontier-based chains (Thanks to https://github.com/joelamouche)
Changes:
- Build to ESM by default (with cjs versions via export map)
- Allow addition or raw pairs on the keyring via
{add, create}FromPair
- Extract re-usable json encryption/decryption functions
5.9.2 Feb 28, 2021
Changes:
- Fix package detection for
@polkadot/networks
(no dependencies)
5.9.1 Feb 28, 2021
Changes:
- Expand
detectPackage
with optional param allowing checks for monorepo versions - Export logger
format
function directly asloggerFormat
- Expand tests and checks for
hdValidatePath
- Remove
hdEthereum
class-based approach, simplify - Cleanup formatting on nested conditionals in the
@polkadot/x-
packages - All packages now export
packageInfo
from the root
5.8.1 Feb 26, 2021
Contributed:
- Add ss58 information for HydraDX (Thanks to https://github.com/jak-pan)
- HD derivation for Ethereum (Thanks to https://github.com/joelamouche)
Changes:
- Adjust base64 encoding/decoding to not rely on Buffer being available
- Rework Ethereum derivation to only use Uint8Array internally
- Shared HD path validation for Ledger & Ethereum
- Additional derivation, encoding and decoding tests on keyring
- Align networks with upstream ss58 registry
@polkadot/wasm-crypto
3.2.4
5.7.1 Feb 21, 2021
Breaking change The signature of pair.verify
now requires the signer public key as a parameter. If using pair.verify
pass the publicKey (hex or Uint8Array) of the signer.
Changes:
- The signature on the keyring for
.verify
now explicitly requires thepublicKey
of the signer. Previously it only verified against an own public key. - Add additional ss58 test vectors (against chains with >63 prefixes in the Substrate registry)
5.6.3 Feb 16, 2021
Contributed:
- Add ss58 information for Aventus (Thanks to https://github.com/nahuseyoum)
Changes:
- Add
unlock(password)
to keypair (less confusing than only havingdecodePkcs8
, equivalent tolock()
) - Change use of
detectPackage
to usepackageInfo.ts
- Align with upstream ss58 registry
@polkadot/wasm-crypto
3.2.3
5.6.2 Feb 8, 2021
Changes:
@polkadot/networks
now filters the new upstream-introducednull
networks
5.6.1 Feb 7, 2021
Contributed:
- Fix installation instructions in
@polkadot/x-global
(Thanks to https://github.com/raoulmillais)
Changes:
- Conform to new ss58 encoding with ids up to 16,383 (>= 64 as 2 bytes)
- Use JS sqrt inside
bnSqrt
when value <= MAX_SAFE_INTEGER - Adjust all
Buffer.from
usages, preferUint8Array
where possible - Expand tests for keyring with
vrf{Sign, Verify}
- Align
@polkadot/networks
with latest ss58 registry
5.5.2 Feb 2, 2021
Changes:
- Expose
BN_{MILLION, BILLION}
constants (in addition to 2-9)
5.5.1 Jan 31, 2021
Changes:
- Added
hdLedger
to util-crypto for Ledger-compatible bip32+ed25519 derivation - Added
hmac{Sha256, 512}
to util-crypto - Add
slip44
indices for Ledger into@polkadot/networks
- Remove
module
entry inpackage.json
(only rely on exports map) - Remove direct references to
global
object, use@polkadot/x-global
- Update
@ledgerhq
dependencies to latest
5.4.1 Jan 24, 2021
Contributed:
- Adjust Ledger app lookup for Polymesh (Thanks to https://github.com/adamdossa)
Changes:
- Allow decimals as
number[]
& symbol asstring[]
in balanceFormat defaults - Add
schnorrkelVrf{Sign, Verify}
to@polkadot/util-crypto
- Export
vrf{Sign, Verify}
on keyring interface - Move
@polkadot/x-rxjs
packages from the api repo - Align
@polkadot/networks
with Substrate master - Explicit edcsa tests for derivation
@polkadot/wasm-crypto
3.2.1
5.3.1 Jan 17, 2021
Important For users of the @polkadot/ledger
package, it is now included in this repo (since it is a general utility) and renamed to @polkadot/hw-ledger
Contributed:
- Add Dock Ledger integration (Thanks to https://github.com/lovesh)
- Add Polymesh Ledger integration (Thanks to https://github.com/adamdossa)
- Add flag for Ledger capabilities on networks (Thanks to https://github.com/Tbaut)
Changes:
- Move
@polkadot/ledger
packages into common - Update
@polkadot/networks
to align with latest Substrate ss58-registry
5.2.1 Dec 27, 2020
Changes:
- Add
arrayFlatten
to merge a series of arrays into a single - Add
arrayChunk
to chunk an array into multiples of defined size - Add
bitLength
param (allowed 256, 512) tokeccakAs{Hex, U8a}
- Align
@polkadot/networks
with Substrate master
5.1.1 Dec 19, 2020
Changes:
detectPackage
now can take a path-retrieval callback as second argument- Adjust
blake2js
imports to consistently cater for esm & cjs usage - Explicitly mark
detectPackage
usage as having side-effects - Align
@polkadot/networks
with Substrate master @polkadot/wasm-crypto
3.1.1
5.0.1 Dec 13, 2020
Important While this package contains no external interface changes, it now compiles and ships both cjs and esm modules. This means that modern bundlers will have more information for tree-shaking available. Additionally when using Node with .mjs
extensions, the esm version imports will be used on recent Node versions. Adding an export map, as here, may have some impacts so a major semver bump is advised. There may be (small) dragons hiding in the dark corners…
Changes:
- Build and expose both cjs and esm via exports map
- Use
import type { ... }
form for all type imports - Align with Substrate master network list
- Debug logs now don’t depend on
NODE_ENV
, but ratherDEBUG=<type,type,...>
(*
logs all) - Limit debug console output via
DEBUG_MAX=<number>
value, trimming when passed - Add
memoize
util, allowing for function memoization (as used in the API) - Align
@polkadot/networks
with Substrate master @polkadot/wasm-crypto
3.0.1
4.2.1 Nov 23, 2020
Changes:
- Rename default Mega to Million, Giga to Billion and Tera to Trillion in formatter
- Dedupe bn.js by aligning versions between different libraries
- Add explicit link to base Substrate ss58 formats (as managed in
@polkadot/util
)
4.1.1 Nov 16, 2020
Contributed:
- Expand ETH tests, allow for verification against address (Thanks to https://github.com/joelamouche)
Changes:
- Replace pbkdf2 imports with explicit use from sync-only package
- Adjust secp256k1 imports with shared elliptic
- Expand crypto tests for explicit wasm vs JS compares in all cases
4.0.1 Nov 8, 2020
- Breaking change Polyfills are not injected by these libraries anymore to avoid clobbering external globals, the user should provide them if their environment is missing base functionality.
Changes:
- Remove built-in utility polyfills for
Array.fill
,String.padStart
,String.padEnd
as well asObject.setPrototypeOf
. These should be provided by the actual user of the libraries if so required. - Update
@polkadot/wasm-crypto
library (under-the-hood cleanups) - Remove explicit crypto polyfill injection (aligning with updated
@polkadot/wasm-crypto
) - Add cross-environment
@polkadot/x-randomvalues
(for use in@polkadot/wasm-crypto
)
3.7.1 Nov 1, 2020
Changes:
- Remove the use of
chalk
(logger) for less overall dependencies string*
utilities now also allowsString
(class) inputs- Align bip39 use with wasm-crypto for English-only wordlist, default, non supplied)
- Adjust elliptic imports for explicit paths (allows tree-shaking)
- Add Totem (ss58 prefix 14) into
@polkadot/networks
- Move
@polkadot/x-{fetch,textdecoder,textencoder,ws}
intocommon
repo
3.6.1 Oct 18, 2020
Contributed:
- Add evmToAddress and addressToEvm
@polkadot/util-crypto
(Thanks to https://github.com/jnaviask) - Remove invalid link to docs (thanks to https://github.com/roccomuso)
Changes:
- Rename
mnemonicToBip39
tomnemonicToLegacySeed
(used in non-Substrate compatible fashion) - Update pair signature verification to handle MultiSignature results
- Move documentation to docs repo
- Added
@polkadot/networks
for a list of known networks and their identifying information
3.5.1 Sep 27, 2020
Contributed:
- Add Dock network identifiers (Thanks to https://github.com/lovesh)
Changes:
- Use cross-environment TextDecoder & TextEncoder from the polkadot-js polyfills
- Add
isBase{32, 58, 64}
to@polkadot/util-crypto
- Add
base64{Pad, Trim}
to add/remove padding characters - Add
createFromJson(json)
to keyring (create pair without adding) - Balance formatter now outputs 4 numbers after the decimal point
3.4.1 Aug 31, 2020
Changes:
- Allow for WASM-as-available
mnemonicToBip39
call (used for Ethereum-compatible keypairs) - Add
isWasm
utility to check for valid WASM headers @polkadot/wasm-crypto
1.4.1
3.3.1 Aug 24, 2020
Changes:
- Add
addressRaw
to Keyring interface (if address encoding is different to publicKey) - Allow for Ethereum pair signing and verification
3.2.1 Aug 17, 2020
Changes:
- Allow for (optional, default blake2) hasher to secp256k1 sign/verify functions
- Utilities for secp256k1 publicKey expansion and compression
- Add basic Ethereum address utils (encode with checksum & checksum verification)
- Add Ethereum-compatible
mnemonicToBip39
seed creation function
3.1.1 Aug 10, 2020
Changes:
- Add
deriveAddress(<address>, '/<soft>/<soft-b>')
via sr25519 soft - Use
scrypt
from WASM as available (JS fallback in place) - Add
base32{Encode, Decode}
utilities (IPFS-compatible alphabet) - Support IPFS compatibility flag in base58 encoding/decoding
- Update to
@polkadot/wasm-crypto
1.3.1
3.0.1 Jul 27, 2020
Contributed:
- Add Katal ss58Format (Thanks to https://github.com/retotrinkler)
Changes:
- Adjust JSON pair output with scrypt kdf (version 3 output)
2.18.1 Jul 13, 2020
Changes:
- Add
base64{Decode, Encode, Validate}
as crypto utils - Extract
base58Validate
from base58 decode checks - Add
isAscii
to allow detection of printable ASCII sequences (including tab, newline) - Add
isUtf8
to allow detection of valid Utf8 sequences
2.17.1 Jul 6, 2020
Changes:
- Add
encode{Derived, Multi}Address
to encode derived/multi addresses - Correctly handle 0 inputs in
numberToU8a
- Simplify and flatten base58 dependencies
2.16.1 Jun 29, 2020
Changes:
- Adjust
addressCheck
andencodeAddress
function to check for valid base58 alphabets (better error reporting) - Rename
createKeySub
tocreateKeyDerived
based on changed in Substrate (sub keys now named derived)
2.15.1 Jun 22, 2020
Changes:
- Adjust keyring to no override 0-prefix (Polkadot live) settings with keychain default
2.14.1 Jun 16, 2020
Contributed:
- Add
extractTime
utility conversion (Thanks to https://github.com/kwingram25)
2.13.1 Jun 8, 2020
Changes:
- Fix JS blake2 fallback (non-wasm) to correctly deal with hex inputs
- Align
bnToHex
signature withbnToU8a
(with old/new style) - Allow
bnTo{Hex,U8a}
to take any value with.toBn()
signatures
2.12.2 Jun 1, 2020
Changes:
- Fix
isFunction
signature to assertFunction
2.12.1 Jun 1, 2020
- Important Removed
mnemonicToSeed
, it is only for bip39, usemnemonicToMiniSecret
for the Substrate variant
Changes:
- Added
u8aEq
to compare two Uint8Array or hex values for an exact match - Added
addressEq
to compare two addresses (ss58, Uint8array or hex) for an exact match - Throw error on
{nacl,schnorrkel}Verify
on invalid input lengths - Performance optimizations in
u8aToHex
&u8aConcat
2.11.1 May 26, 2020
Changes:
- Internal cleanups on typings
- Support for latest TypeScript, eslint & typescript-eslint
2.10.1 May 14, 2020
Contributed:
- Add Kulupu ss58 prefix as an allowed value (Thanks to https://github.com/sorpaas)
Changes:
- Make the
TextEncoder
polyfill handle non-compliant Buffer implementations (newer versions of Jest) DeriveJunction
now also allows for BigInt values (aligning with number types elsewhere)- Small code-flow optimizations
2.9.1 Apr 30, 2020
Contributed:
- Add support for ECDSA keypairs (Thanks to https://github.com/akru)
Changes:
- Added
createKeyMulti
&createKeySub
to create utility sub & multi keys - Added
u8aSorted
to sortUint8Arrays
- Added
sortAddresses
to sort addresses based on their internal representation
2.8.1 Apr 9, 2020
- Keypair will now throw an error when attempting to sign/derive using a locked pair (Thanks to https://github.com/h4x3rotab)
Changes:
- Cleanup
isDevelopment
regex to cater for chains such asWestend Development
2.7.1 Mar 31, 2020
Changes:
- Add
bnSqrt
to calculate the integer sqrt via Newton iteration - Allow for optional wasm-crypto, specifically via
@polkadot/util-crypto/noWasm
- Misc. CI infrastructure cleanups
2.6.1 Feb 29, 2020
- Breaking change Following on the 2.0 release,
@polkadot/wasm
was updated to 1.1+. sr25510 now only verifies 0.8+ signatures, closing the loop on dropping Substrate 1.x-era support
Changes:
- Add
signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string): VerifyResult
to verify any signature, regardless of type. Returns validity & detected crypto type. - Add
cryptoIsReady (): boolean
function to check status of initialization - Add
addressCheckChecksum (decoded: Uint8Array)
as an helper to extract and verify the ss58 checksum - Swap to yarn 2, allow use in yarn 2 projects
2.5.1 Feb 22, 2020
- Breaking change (TypeScript only) The
*.d.ts
files now contain TypeScript 3.8 features,#private
, which is not usable in older versions
Changes:
- Add
isBigInt(value)
to allowBigInt
checks. Also add support inbnToBn
as well as number conversion utils - Add
isChildClass(Parent, Child?)
to check if a class extends the parent, asserting Child is Parent - (internal) Use
#<field>
instead ofprivate _<field>
for private class variables
2.4.1 Feb 18, 2020
Changes:
- Ensure that
formatBalance
does not apply unit overrides apply when no SI is applicable - Adjust
formatBalance(<balance>, <options>)
to take expandedwithUnit: string | boolean
option where string is an actual unit, e.g.KSM
- The
decimals
option toformatBalance
should now be passed as part of theoptions
(previous last-param deprecated) - The
.setSS58Format
on keyring will now just operate on pairs created on the keyring, not globally. The globalsetSS58Format
in@polkadot/util-crypto
will be deprecated. - The deprecated
addressPrefix
option to keyring has been belatedly removed (Usess58Format
rather)
2.3.1 Feb 15, 2020
Contributed:
- Remove dependency on moment.js with
formatDate
function (Thanks to https://github.com/AndreasGassmann) - Move TypeScript
@types/*
to dev deps (Thanks to https://github.com/AndreasGassmann)
Changes:
- Update to
@polkadot/wasm-crypto
1.0 - Cleanup dependencies to pave the way for using yarn 2 (Explicit instead of implicit)
2.2.1 Feb 06, 2020
Changes:
- Add resolver for jest requires (tests from src)
2.1.1 Feb 04, 2020
Changes:
- Update
detectPackage(<package.json>, __dirname?)
with calling folder
2.0.1 Jan 30, 2020
Changes:
- Update w3f/schnorrkel to 0.8.5 (Full Substrate 2.x support, no 1.x support)
- Remove Alice session (ed2551) account from testing keyring (not applicable to Substrate 2.x)
- Remove
chainspec
,db
,trie-codec
,trie-db
andtrie-hash
packages (moved to client) - Renamed
assertSingletonPackage
todetectPackage
with inclusion of version listing - Swap to elliptic library for secp2561 recovery (No node bindings)
1.8.1 Jan 09, 2020
Contributed:
- Add cross-client encryption/decryption support (Thanks to https://github.com/hskang9)
1.7.1 Nov 27, 2019
Changes:
formatBalance
signature now allows to force unit displays- Keypair now allows for derive on a pair, with
pair.derive(...)
assert
now acts like a real asserts, with no return - signature adapted for new TS 3.7
1.6.1 Oct 24, 2019
Changes:
pair.sign(message)
now takes an optional secondoptions?: SignOptions
parameter, whereSignOptions
is currently defined as{ withType: boolean }
. HerewithType
instructs the signing to prepend the type of signature (ed2551, sr25519 or ecdsa). This is used for the new Polkadot/Substrate MultiSignature format.
1.5.1 Sep 25, 2019
Changes:
- Fix typings on the Keyring-exposed encode & decodeAddress
- Allow ss58Format = 0 as a valid value
- Loosen type definitions for allowed ss58format values (still checked against allowed array)
1.4.1 Sep 12, 2019
- Breaking change To set the
ss58Format
, you should now usesetSS58Format
as opposed to the oldsetAddressPrefix
Changes:
- Renamed
keyring.setAddressPrefix
tokeyring.setSS58Format
- Deprecated
addressPrefix
on the keyring options, added thess58Format
as a replacement (aligning with chain properties - the old version is still accepted) - Added
stringToHex
andhexToString
conversion utilities to@polkadot/util
- Swap to Babel 7.6.0 for all compilation, for latest improvements in code generation
1.3.1 Sep 10, 2019
Changes:
- Remove the
ExtError
class, always prefer the standard JSError
object for errors. This would bre a breaking change for any applications usingExtError
1.2.1 Sep 09, 2019
Changes:
- Keyring
addFromAddress
can now be used to store external accounts, for example those provided by external signers - Maintainability updates
1.1.1 Aug 09, 2019
Changes:
assertSingletonPackage
now warns via console.warn, but does not throw. This does allow the info to come accross while still allowing the app developers using multiple libraries time to fix.
1.0.1 Aug 02, 2019
Changes:
formatBalance
now allows forCompact
inputsformaBalance
now allows correct formatting of very large decimals
0.94.1 Jul 20, 2019
Changes:
- Add
checkAddress(address, prefix)
to@polkadot/util-crypto
that validates an ss-58 address - Add support for the Kusama network (as a valid checked prefix)
- Add an
asm.js
fallback for the React Native environment (via@polkadot/wasm-crypto
) - The ed25519 key for Alice (representing the session), now appears in the test keyrings
- Fix missing dependencies for keyring (after address moves in 0.93.1)
0.93.1 Jun 14, 2019
Changes:
- Breaking: External pair interface for keyring has been changed. Instead of
getMeta
use themeta
getter, i.e.console.log(pair.meta.name)
address
use theaddress
getter, i.e.console.log(pair.address)
publicKey
use thepublicKey
getter, i.e.console.log(pair.publicKey)
Move decodeAddress
,encodeAddress
&setAddressPrefix
functions into@polkadot/util-crypto
from@polkadot/keyring
. External interfaces should not be affected at this point since it is also (still) exported and exposed on keyring
0.92.1 Jun 04, 2019
Changes:
- Only allow integer input values into
formatBalance
- Allow
formatBalance
,formatDecimal
&formatNumber
to cater for negative numbers - Add ‘Bob//stash’ to testing keyring, joining the existing ‘Alice//stash’
0.91.1 May 22, 2019
Changes:
- ed25519/sr25519 sign & verify functions can now take the message input as Uint8Array/string/hex and verify allows for the signature/publicKey to be specified as Uint8Array/hex
- Update
@polkadot/wasm
to include a maintenance bump for thew3f/schnorrkel
libraries
0.90.1 May 08, 2019
Changes:
- Moving towards 1.0
- Added bnMin & bnMax functions
0.76.1 Apr 03, 2019
Changes:
- Fix
addFromMnemonic
to generate using new-style derivation. - Pull in
formatBalance
,formatDecimal
,formatElapsed
,formatNumber
,calcSi
,findSi
&isTestChain
utility functions from the originals in@polkadot/ui-util
- Swap out
wasm-schnorrkel
&wasm-ed25519
for combined version withwasm-crypto
- Swap DB interfaces to optional LRU, removing
transactionAsync
(client-only changes)
0.75.1 Mar 29, 2019
Changes:
- Start journey to 1.0
0.42.1 Mar 28, 2019
Changes:
- Add
assertSingletonPackage
to util - Ensure that only a single keyring instance is loaded (uses above)
0.41.1 Mar 25, 2019
Changes:
- Extensions to the client-specific database interfaces (non-breaking for API and util users)
0.40.1 Mar 23, 2019
Changes:
- Add additional derivation path extraction mechanisms to util-crypto
- Add createFromUri function to keypair (creates keypair, does not add it)
- Allow all crypto hashing & ed25519 to use WASM (as available, JS fallbacks)
0.39.1 Mar 20, 2019
Changes:
- Pull in bip39 generation functions from
@poladkot/wasm-crypto
with a fallback to the pure JS versions
0.38.1 Mar 18, 2019
Changes:
- Align with current substrate master for sr25519 keys and hard/soft derivation
- Swap default dev keys to derived (sr25519)
0.37.1 Mar 14, 2019
Changes:
- Swap to publishing -beta.x on merge (non-breaking testing)
0.36.1 Mar 13, 2019
Changes:
- Add
fromUri
to keyring along with hard & soft key derivation.
0.35.1 Mar 04, 2019
Changes:
- Remove NodeJs-only
syncify
function, not exported by the package (with binary dependency for Node)
0.34.1 Feb 13, 2019
Changes:
- Keyring now allows for ed25519 and sr25519 instances. Upon creation, you need to pass the
ed25519
orsr25519
string to denote the type, i.e.new Keyring({ type: 'sr25519' })