Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
21e9b9a033 | ||
|
|
db61ea3077 | ||
|
|
d4a3d2392e | ||
|
|
88ecda706d | ||
|
|
184fb1f12e | ||
|
|
91340577df | ||
|
|
36729678e2 | ||
|
|
1c6b4bfc34 | ||
|
|
bbfd175579 | ||
|
|
0a6bd41444 | ||
|
|
ab21274c36 | ||
|
|
d4e6ad5553 | ||
|
|
49dbd757df | ||
|
|
20e82cc45b | ||
|
|
6a7fa80c55 | ||
|
|
12e34cd3e8 | ||
|
|
0a598fdf92 | ||
|
|
659b896ee7 | ||
|
|
7cda007a30 | ||
|
|
2288c4da8a | ||
|
|
fbfc21be1c | ||
|
|
787beb2aea | ||
|
|
6234e16c37 | ||
|
|
e9cbc0a0d9 | ||
|
|
166eeb8852 | ||
|
|
b321f92161 | ||
|
|
cf7d9d9ff5 | ||
|
|
fb5b3c1663 | ||
|
|
46bbc45145 | ||
|
|
dc8b4a6447 | ||
|
|
8ec38eca4a | ||
|
|
24b533689c | ||
|
|
5421e06fc9 | ||
|
|
7115efd94f | ||
|
|
92f88222c4 | ||
|
|
bc7aba71a6 | ||
|
|
1d8b8b3204 | ||
|
|
4a2e090ef8 | ||
|
|
8cf8d5b7e8 | ||
|
|
8d355ff6fc | ||
|
|
72456bb2bd | ||
|
|
87f3fd2827 | ||
|
|
7254aab68d | ||
|
|
95d7160ad0 | ||
|
|
611b1be481 | ||
|
|
73b35fc188 | ||
|
|
6c30d5b9fd | ||
|
|
56d151fe66 | ||
|
|
cd20fe6c8b | ||
|
|
28f8ca73aa | ||
|
|
f4a8bfc0c0 | ||
|
|
94b058d6a3 | ||
|
|
3d7ddb85a2 | ||
|
|
f7a2bb895f | ||
|
|
c1bfcc00b6 | ||
|
|
b16d8e7c26 | ||
|
|
2a4b363fcd | ||
|
|
de689b8e6f | ||
|
|
2e72ab920b | ||
|
|
565e6baecd | ||
|
|
1e15203b6c | ||
|
|
cc8639565d | ||
|
|
b77d2e6860 | ||
|
|
e1fbd8ff9f | ||
|
|
f56dd32b4a | ||
|
|
6077bef570 | ||
|
|
377d83d4ed | ||
|
|
bdb14f91a8 | ||
|
|
cc5b7ed0ad | ||
|
|
d4491aeb7f | ||
|
|
0f6e996799 | ||
|
|
1f3dd60a8d | ||
|
|
3351fb1cba | ||
|
|
32d176e424 | ||
|
|
aec1e26cb9 | ||
|
|
7d529b6c93 | ||
|
|
e22b39ae01 | ||
|
|
18a202c460 | ||
|
|
fd9ce319a5 | ||
|
|
a04c0a5e82 | ||
|
|
06cb5e57a0 | ||
|
|
103ea045bf | ||
|
|
4315c76814 | ||
|
|
6de6b871cd | ||
|
|
82e5d76821 | ||
|
|
d9a18a4acf | ||
|
|
2d1d4f808e | ||
|
|
d1de30907f | ||
|
|
d3583dc432 | ||
|
|
bb04fa28f7 | ||
|
|
bd8e862b62 | ||
|
|
0f45b7fbf3 | ||
|
|
03eb72f128 | ||
|
|
f76a4a98be |
+1
-1
@@ -1,2 +1,2 @@
|
||||
5
|
||||
2.6.2
|
||||
2.6.22.12.2
|
||||
@@ -1,3 +1,4 @@
|
||||
.eslintrc.js
|
||||
**/build/*
|
||||
**/coverage/*
|
||||
**/node_modules/*
|
||||
|
||||
@@ -10,7 +10,7 @@ jobs:
|
||||
matrix:
|
||||
step: ['build:release', 'docs:release']
|
||||
name: ${{ matrix.step }}
|
||||
if: "! contains(github.event.head_commit.message, '[CI Skip]') && github.repository == 'polkadot-js/common'"
|
||||
if: "! startsWith(github.event.head_commit.message, '[CI Skip]') && github.repository == 'polkadot-js/common'"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
@@ -21,16 +21,13 @@ jobs:
|
||||
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
|
||||
GH_PAGES_SRC: build-docs
|
||||
GH_PAT: ${{ secrets.GH_PAT }}
|
||||
GH_TOKEN: ${{ secrets.GH_PAT }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GH_RELEASE_GITHUB_API_TOKEN: ${{ secrets.GH_PAT }}
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
run: |
|
||||
yarn install --immutable | grep -v 'YN0013'
|
||||
yarn ${{ matrix.step }}
|
||||
|
||||
dummy:
|
||||
name: Dummy
|
||||
if: "contains(github.event.head_commit.message, '[CI Skip]')"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: dummy
|
||||
|
||||
Vendored
+14
-8
File diff suppressed because one or more lines are too long
+130
-67
@@ -1,22 +1,85 @@
|
||||
# 2.9.1 Apr 23, 2020
|
||||
# CHANGELOG
|
||||
|
||||
## 3.0.1 Jul 27, 2020
|
||||
|
||||
- Add Katal ss58Format (Thanks to https://github.com/retotrinkler)
|
||||
- Adjust JSON pair output with scrypt kdf (version 3 output)
|
||||
|
||||
## 2.18.1 Jul 13, 2020
|
||||
|
||||
- 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
|
||||
|
||||
- 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
|
||||
|
||||
- Adjust `addressCheck` and `encodeAddress` function to check for valid base58 alphabets (better error reporting)
|
||||
- Rename `createKeySub` to `createKeyDerived` based on changed in Substrate (sub keys now named derived)
|
||||
|
||||
## 2.15.1 Jun 22, 2020
|
||||
|
||||
- Adjust keyring to no override 0-prefix (Polkadot live) settings with keychain default
|
||||
|
||||
## 2.14.1 Jun 16, 2020
|
||||
|
||||
- Add `extractTime` utility conversion (Thanks to https://github.com/kwingram25)
|
||||
|
||||
## 2.13.1 Jun 8, 2020
|
||||
|
||||
- Fix JS blake2 fallback (non-wasm) to correctly deal with hex inputs
|
||||
- Align `bnToHex` signature with `bnToU8a` (with old/new style)
|
||||
- Allow `bnTo{Hex,U8a}` to take any value with `.toBn()` signatures
|
||||
|
||||
## 2.12.2 Jun 1, 2020
|
||||
|
||||
- Fix `isFunction` signature to assert `Function`
|
||||
|
||||
## 2.12.1 Jun 1, 2020
|
||||
|
||||
- **Important** Removed `mnemonicToSeed`, it is only for bip39, use `mnemonicToMiniSecret` for the Substrate variant
|
||||
- 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
|
||||
|
||||
- Internal cleanups on typings
|
||||
- Support for latest TypeScript, eslint & typescript-eslint
|
||||
|
||||
## 2.10.1 May 14, 2020
|
||||
|
||||
- Add Kulupu ss58 prefix as an allowed value (Thanks to https://github.com/sorpaas)
|
||||
- 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
|
||||
|
||||
- Add support for ECDSA keypairs (Thanks to https://github.com/akru)
|
||||
- Added `createKeyMulti` & `createKeySub` to create utility sub & multi keys
|
||||
- Added `u8aSorted` to sort `Uint8Arrays`
|
||||
- Added `sortAddresses` to sort addresses based on their internal representation
|
||||
|
||||
# 2.8.1 Apr 9, 2020
|
||||
## 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)
|
||||
- Cleanup `isDevelopment` regex to cater for chains such as `Westend Development`
|
||||
|
||||
# 2.7.1 Mar 31, 2020
|
||||
## 2.7.1 Mar 31, 2020
|
||||
|
||||
- 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
|
||||
## 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
|
||||
- Add `signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string): VerifyResult` to verify any signature, regardless of type. Returns validity & detected crypto type.
|
||||
@@ -24,14 +87,14 @@
|
||||
- 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
|
||||
## 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
|
||||
- Add `isBigInt(value)` to allow `BigInt` checks. Also add support in `bnToBn` as well as number conversion utils
|
||||
- Add `isChildClass(Parent, Child?)` to check if a class extends the parent, asserting Child is Parent
|
||||
- (internal) Use `#<field>` instead of `private _<field>` for private class variables
|
||||
|
||||
# 2.4.1 Feb 18, 2020
|
||||
## 2.4.1 Feb 18, 2020
|
||||
|
||||
- Ensure that `formatBalance` does not apply unit overrides apply when no SI is applicable
|
||||
- Adjust `formatBalance(<balance>, <options>)` to take expanded `withUnit: string | boolean` option where string is an actual unit, e.g. `KSM`
|
||||
@@ -39,22 +102,22 @@
|
||||
- The `.setSS58Format` on keyring will now just operate on pairs created on the keyring, not globally. The global `setSS58Format` in `@polkadot/util-crypto` will be deprecated.
|
||||
- The deprecated `addressPrefix` option to keyring has been belatedly removed (Use `ss58Format` rather)
|
||||
|
||||
# 2.3.1 Feb 15, 2020
|
||||
## 2.3.1 Feb 15, 2020
|
||||
|
||||
- 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)
|
||||
- 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
|
||||
## 2.2.1 Feb 06, 2020
|
||||
|
||||
- Add resolver for jest requires (tests from src)
|
||||
|
||||
# 2.1.1 Feb 04, 2020
|
||||
## 2.1.1 Feb 04, 2020
|
||||
|
||||
- Update `detectPackage(<package.json>, __dirname?)` with calling folder
|
||||
|
||||
# 2.0.1 Jan 30, 2020
|
||||
## 2.0.1 Jan 30, 2020
|
||||
|
||||
- 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)
|
||||
@@ -62,27 +125,27 @@
|
||||
- Renamed `assertSingletonPackage` to `detectPackage` with inclusion of version listing
|
||||
- Swap to elliptic library for secp2561 recovery (No node bindings)
|
||||
|
||||
# 1.8.1 Jan 09, 2020
|
||||
## 1.8.1 Jan 09, 2020
|
||||
|
||||
- Add cross-client encryption/decryption support (Thanks to https://github.com/hskang9)
|
||||
|
||||
# 1.7.1 Nov 27, 2019
|
||||
## 1.7.1 Nov 27, 2019
|
||||
|
||||
- `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
|
||||
## 1.6.1 Oct 24, 2019
|
||||
|
||||
- `pair.sign(message)` now takes an optional second `options?: SignOptions` parameter, where `SignOptions` is currently defined as `{ withType: boolean }`. Here `withType` instructs the signing to prepend the type of signature (ed2551, sr25519 or ecdsa). This is used for the new Polkadot/Substrate MultiSignature format.
|
||||
|
||||
# 1.5.1 Sep 25, 2019
|
||||
## 1.5.1 Sep 25, 2019
|
||||
|
||||
- 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
|
||||
## 1.4.1 Sep 12, 2019
|
||||
|
||||
- **Breaking change** To set the `ss58Format`, you should now use `setSS58Format` as opposed to the old `setAddressPrefix`
|
||||
- Renamed `keyring.setAddressPrefix` to `keyring.setSS58Format`
|
||||
@@ -90,25 +153,25 @@
|
||||
- Added `stringToHex` and `hexToString` conversion utilities to `@polkadot/util`
|
||||
- Swap to [Babel 7.6.0](https://babeljs.io/) for all compilation, for latest improvements in code generation
|
||||
|
||||
# 1.3.1 Sep 10, 2019
|
||||
## 1.3.1 Sep 10, 2019
|
||||
|
||||
- Remove the `ExtError` class, always prefer the standard JS `Error` object for errors. This would bre a breaking change for any applications using `ExtError`
|
||||
|
||||
# 1.2.1 Sep 09, 2019
|
||||
## 1.2.1 Sep 09, 2019
|
||||
|
||||
- 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
|
||||
## 1.1.1 Aug 09, 2019
|
||||
|
||||
- `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
|
||||
## 1.0.1 Aug 02, 2019
|
||||
|
||||
- `formatBalance` now allows for `Compact` inputs
|
||||
- `formaBalance` now allows correct formatting of very large decimals
|
||||
|
||||
# 0.94.1 Jul 20, 2019
|
||||
### 0.94.1 Jul 20, 2019
|
||||
|
||||
- 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)
|
||||
@@ -116,7 +179,7 @@
|
||||
- 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
|
||||
### 0.93.1 Jun 14, 2019
|
||||
|
||||
- Breaking: External pair interface for keyring has been changed. Instead of
|
||||
- `getMeta` use the `meta` getter, i.e. `console.log(pair.meta.name)`
|
||||
@@ -124,133 +187,133 @@
|
||||
- `publicKey` use the `publicKey` getter, i.e. `console.log(pair.publicKey)`
|
||||
- `Move decodeAddress`, `encodeAddress` & `setAddressPrefix` functions into `@polkadot/util-crypto` from `@polkadot/keyring`. External interfaces should not be affected at this point since it is also (still) exported and exposed on keyring
|
||||
|
||||
# 0.92.1 Jun 04, 2019
|
||||
### 0.92.1 Jun 04, 2019
|
||||
|
||||
- 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
|
||||
### 0.91.1 May 22, 2019
|
||||
|
||||
- ed25519/sr25519 sign & verify functions can now take the message input as Uint8Array/string/hex and verify allows for the signature/publicKey to be specified as Uint8Array/hex
|
||||
- Update `@polkadot/wasm` to include a maintenance bump for the `w3f/schnorrkel` libraries
|
||||
|
||||
# 0.90.1 May 08, 2019
|
||||
### 0.90.1 May 08, 2019
|
||||
|
||||
- Moving towards 1.0
|
||||
- Added bnMin & bnMax functions
|
||||
|
||||
# 0.76.1 Apr 03, 2019
|
||||
### 0.76.1 Apr 03, 2019
|
||||
|
||||
- Fix `addFromMnemonic` to generate using new-style derivation.
|
||||
- Pull in `formatBalance`, `formatDecimal`, `formatElapsed`, `formatNumber`, `calcSi`, `findSi` & `isTestChain` utility functions from the originals in `@polkadot/ui-util`
|
||||
- Swap out `wasm-schnorrkel` & `wasm-ed25519` for combined version with `wasm-crypto`
|
||||
- Swap DB interfaces to optional LRU, removing `transactionAsync` (client-only changes)
|
||||
|
||||
# 0.75.1 Mar 29, 2019
|
||||
### 0.75.1 Mar 29, 2019
|
||||
|
||||
- Start journey to 1.0
|
||||
|
||||
# 0.42.1 Mar 28, 2019
|
||||
### 0.42.1 Mar 28, 2019
|
||||
|
||||
- Add `assertSingletonPackage` to util
|
||||
- Ensure that only a single keyring instance is loaded (uses above)
|
||||
|
||||
# 0.41.1 Mar 25, 2019
|
||||
### 0.41.1 Mar 25, 2019
|
||||
|
||||
- Extensions to the client-specific database interfaces (non-breaking for API and util users)
|
||||
|
||||
# 0.40.1 Mar 23, 2019
|
||||
### 0.40.1 Mar 23, 2019
|
||||
|
||||
- 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
|
||||
### 0.39.1 Mar 20, 2019
|
||||
|
||||
- Pull in bip39 generation functions from `@poladkot/wasm-crypto` with a fallback to the pure JS versions
|
||||
|
||||
# 0.38.1 Mar 18, 2019
|
||||
### 0.38.1 Mar 18, 2019
|
||||
|
||||
- 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
|
||||
### 0.37.1 Mar 14, 2019
|
||||
|
||||
- Swap to publishing -beta.x on merge (non-breaking testing)
|
||||
|
||||
# 0.36.1 Mar 13, 2019
|
||||
### 0.36.1 Mar 13, 2019
|
||||
|
||||
- Add `fromUri` to keyring along with hard & soft key derivation.
|
||||
|
||||
# 0.35.1 Mar 04, 2019
|
||||
### 0.35.1 Mar 04, 2019
|
||||
|
||||
- Remove NodeJs-only `syncify` function, not exported by the package (with binary dependency for Node)
|
||||
|
||||
# 0.34.1 Feb 13, 2019
|
||||
### 0.34.1 Feb 13, 2019
|
||||
|
||||
- Keyring now allows for ed25519 and sr25519 instances. Upon creation, you need to pass the `ed25519`or `sr25519` string to denote the type, i.e. `new Keyring({ type: 'sr25519' })`
|
||||
|
||||
# 0.33.1 Nov 22, 2018
|
||||
### 0.33.1 Nov 22, 2018
|
||||
|
||||
# 0.32.1 Oct 18, 2018
|
||||
### 0.32.1 Oct 18, 2018
|
||||
|
||||
# 0.31.1 Oct 12, 2018
|
||||
### 0.31.1 Oct 12, 2018
|
||||
|
||||
# 0.30.1 Sep 11, 2018
|
||||
### 0.30.1 Sep 11, 2018
|
||||
|
||||
# 0.29.1 Sep 01, 2018
|
||||
### 0.29.1 Sep 01, 2018
|
||||
|
||||
# 0.28.1 Aug 11, 2018
|
||||
### 0.28.1 Aug 11, 2018
|
||||
|
||||
# 0.27.1 Aug 06, 2018
|
||||
### 0.27.1 Aug 06, 2018
|
||||
|
||||
# 0.26.1 Jun 27, 2018
|
||||
### 0.26.1 Jun 27, 2018
|
||||
|
||||
# 0.25.1 Jun 26, 2018
|
||||
### 0.25.1 Jun 26, 2018
|
||||
|
||||
# 0.24.1 Jun 22, 2018
|
||||
### 0.24.1 Jun 22, 2018
|
||||
|
||||
# 0.23.1 Jun 21, 2018
|
||||
### 0.23.1 Jun 21, 2018
|
||||
|
||||
# 0.22.1 May 24, 2018
|
||||
### 0.22.1 May 24, 2018
|
||||
|
||||
# 0.21.1 May 17, 2018
|
||||
### 0.21.1 May 17, 2018
|
||||
|
||||
# 0.20.1 May 16, 2018
|
||||
### 0.20.1 May 16, 2018
|
||||
|
||||
# 0.19.1 Apr 19, 2018
|
||||
### 0.19.1 Apr 19, 2018
|
||||
|
||||
# 0.18.1 Mar 20, 2018
|
||||
### 0.18.1 Mar 20, 2018
|
||||
|
||||
# 0.17.1 Mar0 8, 2018
|
||||
### 0.17.1 Mar0 8, 2018
|
||||
|
||||
# 0.16.1 Feb 23, 2018
|
||||
### 0.16.1 Feb 23, 2018
|
||||
|
||||
# 0.15.1 Feb 15, 2018
|
||||
### 0.15.1 Feb 15, 2018
|
||||
|
||||
# 0.14.1 Feb 07, 2018
|
||||
### 0.14.1 Feb 07, 2018
|
||||
|
||||
# 0.13.1 Jan 25, 2018
|
||||
### 0.13.1 Jan 25, 2018
|
||||
|
||||
# 0.12.1 Jan 11, 2018
|
||||
### 0.12.1 Jan 11, 2018
|
||||
|
||||
# 0.11.1 Dec 30, 2017
|
||||
### 0.11.1 Dec 30, 2017
|
||||
|
||||
# 0.10.1 Dec 17, 2017
|
||||
### 0.10.1 Dec 17, 2017
|
||||
|
||||
# 0.9.1 Dec 14, 2017
|
||||
### 0.9.1 Dec 14, 2017
|
||||
|
||||
# 0.8.1 Dec 12, 2017
|
||||
### 0.8.1 Dec 12, 2017
|
||||
|
||||
# 0.7.1 Dec 11, 2017
|
||||
### 0.7.1 Dec 11, 2017
|
||||
|
||||
# 0.6.1 Nov 30, 2017
|
||||
### 0.6.1 Nov 30, 2017
|
||||
|
||||
# 0.5.1 Nov 20, 2017
|
||||
### 0.5.1 Nov 20, 2017
|
||||
|
||||
# 0.4.1 Nov 19, 2017
|
||||
### 0.4.1 Nov 19, 2017
|
||||
|
||||
# 0.3.1 Nov 19, 2017
|
||||
### 0.3.1 Nov 19, 2017
|
||||
|
||||
# 0.2.1 Nov 18, 2017
|
||||
### 0.2.1 Nov 18, 2017
|
||||
|
||||
+1
-1
@@ -9,5 +9,5 @@
|
||||
"packages": [
|
||||
"packages/*"
|
||||
],
|
||||
"version": "2.9.1"
|
||||
"version": "3.0.1"
|
||||
}
|
||||
|
||||
+7
-6
@@ -7,7 +7,7 @@
|
||||
"packages/*"
|
||||
],
|
||||
"resolutions": {
|
||||
"typescript": "^3.8.3"
|
||||
"babel-core": "^7.0.0-bridge.0"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "polkadot-dev-build-ts",
|
||||
@@ -21,9 +21,10 @@
|
||||
"test:one": "polkadot-dev-run-test"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.9.0",
|
||||
"@polkadot/dev": "^0.52.11",
|
||||
"@polkadot/ts": "^0.3.18",
|
||||
"@types/jest": "^25.2.1"
|
||||
}
|
||||
"@babel/core": "^7.10.5",
|
||||
"@polkadot/dev": "^0.55.28",
|
||||
"@polkadot/ts": "^0.3.29",
|
||||
"@types/jest": "^26.0.7"
|
||||
},
|
||||
"version": "3.0.1"
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@polkadot/keyring",
|
||||
"version": "2.9.1",
|
||||
"version": "3.0.1",
|
||||
"description": "Keyring management",
|
||||
"main": "index.js",
|
||||
"publishConfig": {
|
||||
@@ -27,8 +27,8 @@
|
||||
},
|
||||
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme",
|
||||
"dependencies": {
|
||||
"@babel/runtime": "^7.9.2",
|
||||
"@polkadot/util": "2.9.1",
|
||||
"@polkadot/util-crypto": "2.9.1"
|
||||
"@babel/runtime": "^7.10.5",
|
||||
"@polkadot/util": "3.0.1",
|
||||
"@polkadot/util-crypto": "3.0.1"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -212,4 +212,93 @@ describe('keypair', (): void => {
|
||||
expect(pair.verify(MESSAGE, signature)).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('util', (): void => {
|
||||
let keyring: Keyring;
|
||||
|
||||
beforeEach((): void => {
|
||||
keyring = new Keyring({ ss58Format: 42 });
|
||||
});
|
||||
|
||||
it('can re-encode an address to Polkadot live', (): void => {
|
||||
expect(
|
||||
keyring.encodeAddress('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 0)
|
||||
).toEqual('15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5');
|
||||
});
|
||||
|
||||
it('can re-encode an address to keyring default', (): void => {
|
||||
expect(
|
||||
keyring.encodeAddress('15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5')
|
||||
).toEqual('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY');
|
||||
});
|
||||
});
|
||||
|
||||
describe('version 2 JSON', (): void => {
|
||||
const PAIR = '{"address":"5CczAE5AmGrZ93MeVhha3Ywam7j9dKB7cArnH7gtrXcMFJvu","encoded":"0xee8f236e2ac3217ce689692a4afc612220dc77fddaed0482f8f95136a7c3e034cccfbc495410a6e9b2439904974ed1d207abeca536ff6985ceb78edeeb3dc343e561c184c488101af8811d1331430b4ccf0e96ef507132e5132964e8564232e7100d973c5bee7b231dd0c8ad5273f3501515a422c8d7ed9d20a73c0ed17c98ee4588e54844bb73052dcad81f7a1094613d63c162fec7446c88b1fae70e","encoding":{"content":["pkcs8","sr25519"],"type":"xsalsa20-poly1305","version":"2"},"meta":{"genesisHash":"0xe143f23803ac50e8f6f8e62695d1ce9e4e1d68aa36c1cd2cfd15340213f3423e","name":"json v2","tags":[],"whenCreated":1595243159596}}';
|
||||
const PASS2 = 'versionTwo';
|
||||
const PASS3 = 'versionThree';
|
||||
let keyring: Keyring;
|
||||
|
||||
beforeEach((): void => {
|
||||
keyring = new Keyring({ ss58Format: 42 });
|
||||
});
|
||||
|
||||
it('can decode from a version 2 JSON file', (): void => {
|
||||
const pair = keyring.addFromJson(JSON.parse(PAIR));
|
||||
|
||||
pair.decodePkcs8(PASS2);
|
||||
|
||||
const json = pair.toJson(PASS3);
|
||||
|
||||
expect(pair.isLocked).toBe(false);
|
||||
expect(pair.address).toBe('5CczAE5AmGrZ93MeVhha3Ywam7j9dKB7cArnH7gtrXcMFJvu');
|
||||
expect(json.encoding).toEqual({
|
||||
content: ['pkcs8', 'sr25519'],
|
||||
type: ['scrypt', 'xsalsa20-poly1305'],
|
||||
version: '3'
|
||||
});
|
||||
|
||||
pair.decodePkcs8(PASS3);
|
||||
|
||||
expect(pair.address).toEqual('5CczAE5AmGrZ93MeVhha3Ywam7j9dKB7cArnH7gtrXcMFJvu');
|
||||
});
|
||||
});
|
||||
|
||||
describe('version 3 JSON (hex)', (): void => {
|
||||
const PAIR = '{"address":"FLiSDPCcJ6auZUGXALLj6jpahcP6adVFDBUQznPXUQ7yoqH","encoded":"0xcd238963070cc4d6806053ee1ac500c7add9c28732bb5d434a332f84a91d9be0008000000100000008000000cf630a1113941b350ddd06697e50399183162e5e9a0e893eafc7f5f4893a223dca5055706b9925b56fdb4304192143843da718e11717daf89cf4f4781f94fb443f61432f782d54280af9eec90bd3069c3cc2d957a42b7c18dc2e9497f623735518e0e49b58f8e4db2c09da3a45dbb935659d015fc94b946cba75b606a6ff7f4e823f6b049e2e6892026b49de02d6dbbd64646fe0933f537d9ea53a70be","encoding":{"content":["pkcs8","sr25519"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{"genesisHash":"0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe","name":"version3","tags":[],"whenCreated":1595277797639}}';
|
||||
const PASS3 = 'version3';
|
||||
let keyring: Keyring;
|
||||
|
||||
beforeEach((): void => {
|
||||
keyring = new Keyring({ ss58Format: 2 });
|
||||
});
|
||||
|
||||
it('can decode from a version 3 JSON file', (): void => {
|
||||
const pair = keyring.addFromJson(JSON.parse(PAIR));
|
||||
|
||||
pair.decodePkcs8(PASS3);
|
||||
|
||||
expect(pair.isLocked).toBe(false);
|
||||
expect(pair.address).toBe('FLiSDPCcJ6auZUGXALLj6jpahcP6adVFDBUQznPXUQ7yoqH');
|
||||
});
|
||||
});
|
||||
|
||||
describe('version 3 JSON (base64)', (): void => {
|
||||
const PAIR = '{"address":"FLiSDPCcJ6auZUGXALLj6jpahcP6adVFDBUQznPXUQ7yoqH","encoded":"ILjSgYaGvq1zaCz/kx+aqfLaHBjLXz0Qsmr6RnkOVU4AgAAAAQAAAAgAAAB5R2hm5kgXyc0NQYFxvMU4zCdjB+ugs/ibEooqCvuudbaeKn3Ee47NkCqU1ecOJV+eeaVn4W4dRvIpj5kGmQOGsewR+MiQ/B0G9NFh7JXV0qcPlk2QMNW1/mbJrTO4miqL448BSkP7ZOhUV6HFUpMt3B9HwjiRLN8RORcFp0ID/Azs4Jl/xOpXNzbgQGIffWgCIKTxN9N1ku6tdlG4","encoding":{"content":["pkcs8","sr25519"],"type":["scrypt","xsalsa20-poly1305"],"version":"3"},"meta":{"genesisHash":"0xb0a8d493285c2df73290dfb7e61f870f17b41801197a149ca93654499ea3dafe","name":"version3","tags":[],"whenCreated":1595277797639,"whenEdited":1595278378596}}';
|
||||
const PASS3 = 'version3';
|
||||
let keyring: Keyring;
|
||||
|
||||
beforeEach((): void => {
|
||||
keyring = new Keyring({ ss58Format: 2 });
|
||||
});
|
||||
|
||||
it('can decode from a version 3 JSON file', (): void => {
|
||||
const pair = keyring.addFromJson(JSON.parse(PAIR));
|
||||
|
||||
pair.decodePkcs8(PASS3);
|
||||
|
||||
expect(pair.isLocked).toBe(false);
|
||||
expect(pair.address).toBe('FLiSDPCcJ6auZUGXALLj6jpahcP6adVFDBUQznPXUQ7yoqH');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -3,10 +3,10 @@
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { KeypairType, Keypair } from '@polkadot/util-crypto/types';
|
||||
import { KeyringInstance, KeyringPair, KeyringPair$Json, KeyringPair$Meta, KeyringOptions } from './types';
|
||||
import { KeyringInstance, KeyringPair, KeyringPair$Json, KeyringPair$JsonEncodingTypes, KeyringPair$Meta, KeyringOptions } from './types';
|
||||
|
||||
import { assert, hexToU8a, isHex, stringToU8a } from '@polkadot/util';
|
||||
import { decodeAddress, encodeAddress, keyExtractSuri, keyFromPath, naclKeypairFromSeed as naclFromSeed, schnorrkelKeypairFromSeed as schnorrkelFromSeed, secp256k1KeypairFromSeed as secp256k1FromSeed, mnemonicToMiniSecret } from '@polkadot/util-crypto';
|
||||
import { assert, hexToU8a, isHex, isUndefined, stringToU8a } from '@polkadot/util';
|
||||
import { base64Decode, decodeAddress, encodeAddress, keyExtractSuri, keyFromPath, naclKeypairFromSeed as naclFromSeed, schnorrkelKeypairFromSeed as schnorrkelFromSeed, secp256k1KeypairFromSeed as secp256k1FromSeed, mnemonicToMiniSecret } from '@polkadot/util-crypto';
|
||||
|
||||
import { DEV_PHRASE } from './defaults';
|
||||
import createPair from './pair';
|
||||
@@ -84,10 +84,10 @@ export default class Keyring implements KeyringInstance {
|
||||
* of an account backup), and then generates a keyring pair from them that it passes to
|
||||
* `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
|
||||
*/
|
||||
public addFromAddress (address: string | Uint8Array, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, type: KeypairType = this.type, ignoreChecksum?: boolean): KeyringPair {
|
||||
public addFromAddress (address: string | Uint8Array, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, type: KeypairType = this.type, ignoreChecksum?: boolean, encType?: KeyringPair$JsonEncodingTypes[]): KeyringPair {
|
||||
const publicKey = this.decodeAddress(address, ignoreChecksum);
|
||||
|
||||
return this.addPair(createPair({ toSS58: this.encodeAddress, type }, { publicKey, secretKey: new Uint8Array() }, meta, encoded));
|
||||
return this.addPair(createPair({ toSS58: this.encodeAddress, type }, { publicKey, secretKey: new Uint8Array() }, meta, encoded, encType));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -97,12 +97,15 @@ export default class Keyring implements KeyringInstance {
|
||||
* of an account backup), and then generates a keyring pair from it that it passes to
|
||||
* `addPair` to stores in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
|
||||
*/
|
||||
public addFromJson ({ address, encoded, encoding: { content, version }, meta }: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair {
|
||||
const type = version === '0' || !Array.isArray(content)
|
||||
public addFromJson ({ address, encoded, encoding: { content, type, version }, meta }: KeyringPair$Json, ignoreChecksum?: boolean): KeyringPair {
|
||||
const cryptoType = version === '0' || !Array.isArray(content)
|
||||
? this.type
|
||||
: content[1];
|
||||
const encType = !Array.isArray(type)
|
||||
? [type]
|
||||
: type;
|
||||
|
||||
return this.addFromAddress(address, meta, hexToU8a(encoded), type, ignoreChecksum);
|
||||
return this.addFromAddress(address, meta, isHex(encoded) ? hexToU8a(encoded) : base64Decode(encoded), cryptoType, ignoreChecksum, encType);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -192,7 +195,7 @@ export default class Keyring implements KeyringInstance {
|
||||
* @description Encodes the input into an ss58 representation
|
||||
*/
|
||||
public encodeAddress = (address: Uint8Array | string, ss58Format?: number): string => {
|
||||
return encodeAddress(address, ss58Format || this.#ss58);
|
||||
return encodeAddress(address, isUndefined(ss58Format) ? this.#ss58 : ss58Format);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -2,11 +2,13 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { assert, stringToU8a, u8aFixLength } from '@polkadot/util';
|
||||
import { naclDecrypt } from '@polkadot/util-crypto';
|
||||
import { KeyringPair$JsonEncodingTypes } from '../types';
|
||||
import { PairInfo } from './types';
|
||||
|
||||
import { NONCE_LENGTH, PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SEC_LENGTH, SEED_LENGTH } from './defaults';
|
||||
import { assert, stringToU8a, u8aFixLength } from '@polkadot/util';
|
||||
import { naclDecrypt, scryptEncode, scryptFromU8a } from '@polkadot/util-crypto';
|
||||
|
||||
import { NONCE_LENGTH, PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SEC_LENGTH, SEED_LENGTH, SCRYPT_LENGTH } from './defaults';
|
||||
|
||||
const SEED_OFFSET = PKCS8_HEADER.length;
|
||||
|
||||
@@ -41,18 +43,32 @@ function decodePkcs8 (encoded: Uint8Array): DecodeResult {
|
||||
};
|
||||
}
|
||||
|
||||
export default function decode (passphrase?: string, encrypted?: Uint8Array | null): DecodeResult {
|
||||
export default function decode (passphrase?: string, encrypted?: Uint8Array | null, encType: KeyringPair$JsonEncodingTypes[] = ['scrypt', 'xsalsa20-poly1305']): DecodeResult {
|
||||
assert(encrypted, 'No encrypted data available to decode');
|
||||
assert(passphrase || !encType.includes('xsalsa20-poly1305'), 'Password required to decode encypted data');
|
||||
|
||||
const encoded = passphrase
|
||||
? naclDecrypt(
|
||||
let encoded: Uint8Array | null = encrypted;
|
||||
|
||||
if (passphrase) {
|
||||
let password: Uint8Array;
|
||||
|
||||
if (encType.includes('scrypt')) {
|
||||
const { params, salt } = scryptFromU8a(encrypted);
|
||||
|
||||
password = scryptEncode(passphrase, salt, params).password;
|
||||
encrypted = encrypted.subarray(SCRYPT_LENGTH);
|
||||
} else {
|
||||
password = stringToU8a(passphrase);
|
||||
}
|
||||
|
||||
encoded = naclDecrypt(
|
||||
encrypted.subarray(NONCE_LENGTH),
|
||||
encrypted.subarray(0, NONCE_LENGTH),
|
||||
u8aFixLength(stringToU8a(passphrase), 256, true)
|
||||
)
|
||||
: encrypted;
|
||||
u8aFixLength(password, 256, true)
|
||||
);
|
||||
}
|
||||
|
||||
assert(encoded, 'Unable to unencrypt using the supplied passphrase');
|
||||
assert(encoded, 'Unable to decode using the supplied passphrase');
|
||||
|
||||
return decodePkcs8(encoded);
|
||||
}
|
||||
|
||||
@@ -6,14 +6,18 @@ const NONCE_LENGTH = 24;
|
||||
const PKCS8_DIVIDER = new Uint8Array([161, 35, 3, 33, 0]);
|
||||
const PKCS8_HEADER = new Uint8Array([48, 83, 2, 1, 1, 48, 5, 6, 3, 43, 101, 112, 4, 34, 4, 32]);
|
||||
const PUB_LENGTH = 32;
|
||||
const SALT_LENGTH = 32;
|
||||
const SEC_LENGTH = 64;
|
||||
const SEED_LENGTH = 32;
|
||||
const SCRYPT_LENGTH = SALT_LENGTH + (3 * 4);
|
||||
|
||||
export {
|
||||
NONCE_LENGTH,
|
||||
PKCS8_DIVIDER,
|
||||
PKCS8_HEADER,
|
||||
PUB_LENGTH,
|
||||
SALT_LENGTH,
|
||||
SEC_LENGTH,
|
||||
SEED_LENGTH
|
||||
SEED_LENGTH,
|
||||
SCRYPT_LENGTH
|
||||
};
|
||||
|
||||
@@ -3,10 +3,10 @@
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import testingPairs from '../testingPairs';
|
||||
import { PKCS8_DIVIDER, PKCS8_HEADER, PUB_LENGTH, SEC_LENGTH } from './defaults';
|
||||
import { PKCS8_DIVIDER, PKCS8_HEADER, NONCE_LENGTH, PUB_LENGTH, SCRYPT_LENGTH, SEC_LENGTH } from './defaults';
|
||||
|
||||
const PKCS8_LENGTH = PKCS8_DIVIDER.length + PKCS8_HEADER.length + PUB_LENGTH + SEC_LENGTH;
|
||||
const ENCODED_LENGTH = 157;
|
||||
const ENCODED_LENGTH = 16 + PKCS8_LENGTH + NONCE_LENGTH + SCRYPT_LENGTH;
|
||||
|
||||
const keyring = testingPairs({ type: 'ed25519' }, false);
|
||||
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
|
||||
import { PairInfo } from './types';
|
||||
|
||||
import { stringToU8a, u8aConcat, u8aFixLength, assert } from '@polkadot/util';
|
||||
import { naclEncrypt } from '@polkadot/util-crypto';
|
||||
import { u8aConcat, assert } from '@polkadot/util';
|
||||
import { naclEncrypt, scryptEncode, scryptToU8a } from '@polkadot/util-crypto';
|
||||
|
||||
import { PKCS8_DIVIDER, PKCS8_HEADER } from './defaults';
|
||||
|
||||
@@ -23,7 +23,8 @@ export default function encode ({ publicKey, secretKey }: PairInfo, passphrase?:
|
||||
return encoded;
|
||||
}
|
||||
|
||||
const { encrypted, nonce } = naclEncrypt(encoded, u8aFixLength(stringToU8a(passphrase), 256, true));
|
||||
const { params, password, salt } = scryptEncode(passphrase);
|
||||
const { encrypted, nonce } = naclEncrypt(encoded, password.subarray(0, 32));
|
||||
|
||||
return u8aConcat(nonce, encrypted);
|
||||
return u8aConcat(scryptToU8a(salt, params), nonce, encrypted);
|
||||
}
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { Keypair, KeypairType } from '@polkadot/util-crypto/types';
|
||||
import { KeyringPair, KeyringPair$Json, KeyringPair$Meta, SignOptions } from '../types';
|
||||
import { KeyringPair, KeyringPair$Json, KeyringPair$JsonEncodingTypes, KeyringPair$Meta, SignOptions } from '../types';
|
||||
import { PairInfo } from './types';
|
||||
|
||||
import { assert, u8aConcat } from '@polkadot/util';
|
||||
@@ -112,7 +112,14 @@ 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): KeyringPair {
|
||||
export default function createPair ({ toSS58, type }: Setup, { publicKey, secretKey }: PairInfo, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null, encTypes?: KeyringPair$JsonEncodingTypes[]): KeyringPair {
|
||||
const recode = (passphrase?: string): Uint8Array => {
|
||||
encoded = encode({ publicKey, secretKey }, passphrase); // re-encode, latest version
|
||||
encTypes = undefined; // swap to defaults, latest version follows
|
||||
|
||||
return encoded;
|
||||
};
|
||||
|
||||
return {
|
||||
get address (): string {
|
||||
return toSS58(getAddress(type, publicKey));
|
||||
@@ -130,8 +137,8 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
|
||||
return type;
|
||||
},
|
||||
// eslint-disable-next-line sort-keys
|
||||
decodePkcs8: (passphrase?: string, _encoded?: Uint8Array | null): void => {
|
||||
const decoded = decode(passphrase, _encoded || encoded);
|
||||
decodePkcs8: (passphrase?: string, userEncoded?: Uint8Array | null): void => {
|
||||
const decoded = decode(passphrase, userEncoded || encoded, encTypes);
|
||||
|
||||
if (decoded.secretKey.length === 64) {
|
||||
publicKey = decoded.publicKey;
|
||||
@@ -152,7 +159,7 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
|
||||
return createPair({ toSS58, type }, derived, meta, null);
|
||||
},
|
||||
encodePkcs8: (passphrase?: string): Uint8Array =>
|
||||
encode({ publicKey, secretKey }, passphrase),
|
||||
recode(passphrase),
|
||||
lock: (): void => {
|
||||
secretKey = new Uint8Array(0);
|
||||
},
|
||||
@@ -165,7 +172,7 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
|
||||
return sign(type, message, { publicKey, secretKey }, options);
|
||||
},
|
||||
toJson: (passphrase?: string): KeyringPair$Json =>
|
||||
toJson(type, { address: toSS58(getAddress(type, publicKey)), meta }, encode({ publicKey, secretKey }, passphrase), !!passphrase),
|
||||
toJson(type, { address: toSS58(getAddress(type, publicKey)), meta }, recode(passphrase), !!passphrase),
|
||||
verify: (message: Uint8Array, signature: Uint8Array): boolean =>
|
||||
verify(type, message, signature, publicKey)
|
||||
};
|
||||
|
||||
@@ -12,11 +12,11 @@ describe('toJson', (): void => {
|
||||
keyring.alice.toJson()
|
||||
).toMatchObject({
|
||||
address: '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua',
|
||||
encoded: '0x3053020101300506032b657004220420416c696365202020202020202020202020202020202020202020202020202020d172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4fa123032100d172a74cda4c865912c32ba0a80a57ae69abae410e5ccb59dee84e2f4432db4f',
|
||||
encoded: 'MFMCAQEwBQYDK2VwBCIEIEFsaWNlICAgICAgICAgICAgICAgICAgICAgICAgICAg0XKnTNpMhlkSwyugqApXrmmrrkEOXMtZ3uhOL0Qy20+hIwMhANFyp0zaTIZZEsMroKgKV65pq65BDlzLWd7oTi9EMttP',
|
||||
encoding: {
|
||||
content: ['pkcs8', 'ed25519'],
|
||||
type: 'none',
|
||||
version: '2'
|
||||
type: ['none'],
|
||||
version: '3'
|
||||
},
|
||||
meta: {
|
||||
isTesting: true,
|
||||
@@ -28,13 +28,13 @@ describe('toJson', (): void => {
|
||||
it('creates an encoded output with passphrase', (): void => {
|
||||
const json = keyring.alice.toJson('testing');
|
||||
|
||||
expect(json.encoded).toHaveLength(316);
|
||||
expect(json.encoded).toHaveLength(268);
|
||||
expect(json).toMatchObject({
|
||||
address: '5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaQua',
|
||||
encoding: {
|
||||
content: ['pkcs8', 'ed25519'],
|
||||
type: 'xsalsa20-poly1305',
|
||||
version: '2'
|
||||
type: ['scrypt', 'xsalsa20-poly1305'],
|
||||
version: '3'
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
@@ -5,22 +5,26 @@
|
||||
import { KeypairType } from '@polkadot/util-crypto/types';
|
||||
import { KeyringPair$Json, KeyringPair$Meta } from '../types';
|
||||
|
||||
import { u8aToHex } from '@polkadot/util';
|
||||
import { base64Encode } from '@polkadot/util-crypto';
|
||||
|
||||
type PairStateJson = KeyringPair$Meta & {
|
||||
interface PairStateJson {
|
||||
address: string;
|
||||
};
|
||||
meta: KeyringPair$Meta;
|
||||
}
|
||||
|
||||
// version 2 - nonce, encoded (previous)
|
||||
// version 3 - salt, nonce, encoded
|
||||
|
||||
export default function toJson (type: KeypairType, { address, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
|
||||
return {
|
||||
address,
|
||||
encoded: u8aToHex(encoded),
|
||||
encoded: base64Encode(encoded),
|
||||
encoding: {
|
||||
content: ['pkcs8', type],
|
||||
type: isEncrypted
|
||||
? 'xsalsa20-poly1305'
|
||||
: 'none',
|
||||
version: '2'
|
||||
? ['scrypt', 'xsalsa20-poly1305']
|
||||
: ['none'],
|
||||
version: '3'
|
||||
},
|
||||
meta
|
||||
};
|
||||
|
||||
@@ -10,16 +10,15 @@ export interface KeyringOptions {
|
||||
type?: KeypairType;
|
||||
}
|
||||
|
||||
export interface KeyringPair$Meta {
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
[index: string]: any;
|
||||
}
|
||||
export type KeyringPair$Meta = Record<string, unknown>;
|
||||
|
||||
export type KeyringPair$JsonVersion = '0' | '1' | '2';
|
||||
export type KeyringPair$JsonVersion = '0' | '1' | '2' | '3';
|
||||
|
||||
export type KeyringPair$JsonEncodingTypes = 'none' | 'scrypt' | 'xsalsa20-poly1305';
|
||||
|
||||
export interface KeyringPair$JsonEncoding {
|
||||
content: ['pkcs8', KeypairType];
|
||||
type: 'xsalsa20-poly1305' | 'none';
|
||||
type: KeyringPair$JsonEncodingTypes | KeyringPair$JsonEncodingTypes[];
|
||||
version: KeyringPair$JsonVersion;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@polkadot/util-crypto",
|
||||
"version": "2.9.1",
|
||||
"version": "3.0.1",
|
||||
"description": "A collection of useful crypto utilities for @polkadot",
|
||||
"main": "index.js",
|
||||
"keywords": [
|
||||
@@ -25,25 +25,25 @@
|
||||
},
|
||||
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme",
|
||||
"dependencies": {
|
||||
"@babel/runtime": "^7.9.2",
|
||||
"@polkadot/util": "2.9.1",
|
||||
"@babel/runtime": "^7.10.5",
|
||||
"@polkadot/util": "3.0.1",
|
||||
"@polkadot/wasm-crypto": "^1.2.1",
|
||||
"base-x": "^3.0.8",
|
||||
"bip39": "^3.0.2",
|
||||
"blakejs": "^1.1.0",
|
||||
"bn.js": "^5.1.1",
|
||||
"bs58": "^4.0.1",
|
||||
"elliptic": "^6.5.2",
|
||||
"bn.js": "^5.1.2",
|
||||
"elliptic": "^6.5.3",
|
||||
"js-sha3": "^0.8.0",
|
||||
"pbkdf2": "^3.0.17",
|
||||
"pbkdf2": "^3.1.1",
|
||||
"scryptsy": "^2.1.0",
|
||||
"tweetnacl": "^1.0.3",
|
||||
"xxhashjs": "^0.2.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/bn.js": "^4.11.6",
|
||||
"@types/bs58": "^4.0.1",
|
||||
"@types/elliptic": "^6.4.12",
|
||||
"@types/pbkdf2": "^3.0.0",
|
||||
"@types/xxhashjs": "^0.2.1"
|
||||
"@types/pbkdf2": "^3.1.0",
|
||||
"@types/scryptsy": "^2.0.0",
|
||||
"@types/xxhashjs": "^0.2.2"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -17,6 +17,12 @@ describe('checkAddress', (): void => {
|
||||
).toEqual([true, null]);
|
||||
});
|
||||
|
||||
it('fails when an invalid base58 character is supplied', (): void => {
|
||||
expect(
|
||||
checkAddress('5EnxIUmEbw8DkENKiYuZ1DwQuMoB2UWEQJZZXrTsxoz7SpgG', 2)
|
||||
).toEqual([false, 'Invalid base58 character "I" (0x49) at index 4']);
|
||||
});
|
||||
|
||||
it('fails with invalid prefix when checking Substrate against Kusama prefix', (): void => {
|
||||
expect(
|
||||
checkAddress('5EnxxUmEbw8DkENKiYuZ1DwQuMoB2UWEQJZZXrTsxoz7SpgG', 2)
|
||||
|
||||
@@ -4,13 +4,24 @@
|
||||
|
||||
import { Prefix } from './types';
|
||||
|
||||
import bs58 from 'bs58';
|
||||
|
||||
import base58Decode from '../base58/decode';
|
||||
import checkChecksum from './checkChecksum';
|
||||
import defaults from './defaults';
|
||||
|
||||
/**
|
||||
* @name checkAddress
|
||||
* @summary Validates an ss58 address.
|
||||
* @description
|
||||
* From the provided input, validate that the address is a valid input.
|
||||
*/
|
||||
export default function check (address: string, prefix: Prefix): [boolean, string | null] {
|
||||
const decoded = bs58.decode(address);
|
||||
let decoded;
|
||||
|
||||
try {
|
||||
decoded = base58Decode(address);
|
||||
} catch (error) {
|
||||
return [false, (error as Error).message];
|
||||
}
|
||||
|
||||
if (decoded[0] !== prefix) {
|
||||
return [false, `Prefix mismatch, expected ${prefix}, found ${decoded[0]}`];
|
||||
|
||||
@@ -94,4 +94,10 @@ describe('decode', (): void => {
|
||||
(): Uint8Array => decode('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDwU')
|
||||
).toThrow(/address checksum/);
|
||||
});
|
||||
|
||||
it('fails when invalid base58 encoded address is found', (): void => {
|
||||
expect(
|
||||
() => u8aToHex(decode('F3opIRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29'))
|
||||
).toThrow(/Decoding F3opIRbN5ZbjJNU511Kj2TLuzFcDq9BGduA9TgiECafpg29: Invalid base58 character "I" \(0x49\) at index 4/);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -6,9 +6,9 @@ import { Prefix } from './types';
|
||||
|
||||
// Original implementation: https://github.com/paritytech/polka-ui/blob/4858c094684769080f5811f32b081dd7780b0880/src/polkadot.js#L6
|
||||
|
||||
import bs58 from 'bs58';
|
||||
import { assert, bufferToU8a, isHex, isU8a, u8aToU8a } from '@polkadot/util';
|
||||
import { assert, isHex, isU8a, u8aToU8a } from '@polkadot/util';
|
||||
|
||||
import base58Decode from '../base58/decode';
|
||||
import checkChecksum from './checkChecksum';
|
||||
import defaults from './defaults';
|
||||
|
||||
@@ -18,12 +18,17 @@ export default function decode (encoded: string | Uint8Array, ignoreChecksum?: b
|
||||
return u8aToU8a(encoded);
|
||||
}
|
||||
|
||||
const decoded = bufferToU8a(bs58.decode(encoded));
|
||||
const error = (message: string): string =>
|
||||
`Decoding ${encoded}: ${message}`;
|
||||
const wrapError = (message: string) => `Decoding ${encoded as string}: ${message}`;
|
||||
let decoded;
|
||||
|
||||
try {
|
||||
decoded = base58Decode(encoded);
|
||||
} catch (error) {
|
||||
throw new Error(wrapError((error as Error).message));
|
||||
}
|
||||
|
||||
// assert(defaults.allowedPrefix.includes(decoded[0] as Prefix), error('Invalid decoded address prefix'));
|
||||
assert(defaults.allowedEncodedLengths.includes(decoded.length), error('Invalid decoded address length'));
|
||||
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) {
|
||||
@@ -32,7 +37,7 @@ export default function decode (encoded: string | Uint8Array, ignoreChecksum?: b
|
||||
|
||||
const [isValid, endPos] = checkChecksum(decoded);
|
||||
|
||||
assert(ignoreChecksum || isValid, error('Invalid decoded address checksum'));
|
||||
assert(ignoreChecksum || isValid, wrapError('Invalid decoded address checksum'));
|
||||
|
||||
return decoded.slice(1, endPos);
|
||||
}
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import testingPairs from '../../../keyring/src/testingPairs';
|
||||
import testingPairs from '@polkadot/keyring/testingPairs';
|
||||
|
||||
import encode from './encode';
|
||||
|
||||
const keyring = testingPairs({ type: 'ed25519' }, false);
|
||||
@@ -20,6 +21,12 @@ describe('encode', (): void => {
|
||||
).toEqual('7sL6eNJj5ZGV5cn3hhV2deRUsivXfBfMH76wCALCqWj1EKzv');
|
||||
});
|
||||
|
||||
it('can re-encode an address to Polkadot live', (): void => {
|
||||
expect(
|
||||
encode('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 0)
|
||||
).toEqual('15oF4uVJwmo4TdGW7VfQxNLavjCXviqxT9S1MgbjMNHr6Sp5');
|
||||
});
|
||||
|
||||
it('fails when non-valid publicKey provided', (): void => {
|
||||
expect(
|
||||
(): string => encode(
|
||||
|
||||
@@ -6,9 +6,9 @@ import { Prefix } from './types';
|
||||
|
||||
// Original implementation: https://github.com/paritytech/polka-ui/blob/4858c094684769080f5811f32b081dd7780b0880/src/polkadot.js#L34
|
||||
|
||||
import bs58 from 'bs58';
|
||||
import { assert, u8aConcat, u8aToBuffer } from '@polkadot/util';
|
||||
import { assert, u8aConcat } from '@polkadot/util';
|
||||
|
||||
import base58Encode from '../base58/encode';
|
||||
import decode from './decode';
|
||||
import defaults from './defaults';
|
||||
import sshash from './sshash';
|
||||
@@ -17,16 +17,13 @@ export default function encode (_key: Uint8Array | string, ss58Format: Prefix =
|
||||
// decode it, this means we can re-encode an address
|
||||
const key = decode(_key);
|
||||
|
||||
assert(defaults.allowedDecodedLengths.includes(key.length), `Expected a valid key to convert, with length ${defaults.allowedDecodedLengths}`);
|
||||
assert(defaults.allowedDecodedLengths.includes(key.length), `Expected a valid key to convert, with length ${defaults.allowedDecodedLengths.join(', ')}`);
|
||||
|
||||
const isPublicKey = key.length === 32;
|
||||
|
||||
const input = u8aConcat(new Uint8Array([ss58Format]), key);
|
||||
const hash = sshash(input);
|
||||
|
||||
return bs58.encode(
|
||||
u8aToBuffer(
|
||||
u8aConcat(input, hash.subarray(0, isPublicKey ? 2 : 1))
|
||||
)
|
||||
return base58Encode(
|
||||
u8aConcat(input, hash.subarray(0, isPublicKey ? 2 : 1))
|
||||
);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import encodeDerivedAddress from './encodeDerived';
|
||||
|
||||
describe('encodeDerivedAddress', (): void => {
|
||||
it('creates a valid known derived address', (): void => {
|
||||
expect(
|
||||
encodeDerivedAddress('5GvUh7fGKsdBEh5XpypkfkGuf7j3vXLxH9BdxjxnJNVXRYi1', 0)
|
||||
).toEqual('5E5XxqPxm7QbEs6twYfp3tyjXidn4kqRrNPH4o6JK9JSLUeD');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,21 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { Prefix } from './types';
|
||||
|
||||
import BN from 'bn.js';
|
||||
|
||||
import decode from './decode';
|
||||
import encode from './encode';
|
||||
import keyDerived from './keyDerived';
|
||||
|
||||
/**
|
||||
* @name encodeDerivedAddress
|
||||
* @summary Creates a derived address.
|
||||
* @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);
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import encodeMultiAddress from './encodeMulti';
|
||||
|
||||
describe('encodeMultiAddress', (): void => {
|
||||
it('creates a valid known multi address', (): void => {
|
||||
expect(
|
||||
encodeMultiAddress([
|
||||
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
|
||||
'5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
|
||||
'5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y'
|
||||
], 2)
|
||||
).toEqual('5DjYJStmdZ2rcqXbXGX7TW85JsrW6uG4y9MUcLq2BoPMpRA7');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,20 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { Prefix } from './types';
|
||||
|
||||
import BN from 'bn.js';
|
||||
|
||||
import encode from './encode';
|
||||
import keyMulti from './keyMulti';
|
||||
|
||||
/**
|
||||
* @name encodeMultiAddress
|
||||
* @summary Creates a multisig address.
|
||||
* @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);
|
||||
}
|
||||
@@ -0,0 +1,46 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import testingPairs from '@polkadot/keyring/testingPairs';
|
||||
import { addressEq } from '.';
|
||||
|
||||
describe('addressEq', (): void => {
|
||||
it('returns false with non-equal', (): void => {
|
||||
expect(
|
||||
addressEq(
|
||||
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
|
||||
'5EnxxUmEbw8DkENKiYuZ1DwQuMoB2UWEQJZZXrTsxoz7SpgG'
|
||||
)
|
||||
).toEqual(false);
|
||||
});
|
||||
|
||||
it('returns true for equal, matching prefix', (): void => {
|
||||
expect(
|
||||
addressEq(
|
||||
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
|
||||
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY'
|
||||
)
|
||||
).toEqual(true);
|
||||
});
|
||||
|
||||
it('returns true for equal, non-matching prefix', (): void => {
|
||||
expect(
|
||||
addressEq(
|
||||
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
|
||||
'7sL6eNJj5ZGV5cn3hhV2deRUsivXfBfMH76wCALCqWj1EKzv'
|
||||
)
|
||||
).toEqual(true);
|
||||
});
|
||||
|
||||
it('returns true for equal, address vs publicKey', (): void => {
|
||||
const keyring = testingPairs({ type: 'sr25519' });
|
||||
|
||||
expect(
|
||||
addressEq(
|
||||
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
|
||||
keyring.alice.publicKey
|
||||
)
|
||||
).toEqual(true);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,25 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { u8aEq } from '@polkadot/util';
|
||||
|
||||
import decode from './decode';
|
||||
|
||||
/**
|
||||
* @name addressEq
|
||||
* @summary Compares two addresses, either in ss58, Uint8Array or hex format.
|
||||
* @description
|
||||
* For the input values, return true is the underlying public keys do match.
|
||||
* @example
|
||||
* <BR>
|
||||
*
|
||||
* ```javascript
|
||||
* import { u8aEq } from '@polkadot/util';
|
||||
*
|
||||
* 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));
|
||||
}
|
||||
@@ -5,19 +5,25 @@
|
||||
import checkAddress from './check';
|
||||
import checkAddressChecksum from './checkChecksum';
|
||||
import createKeyMulti from './keyMulti';
|
||||
import createKeySub from './keySub';
|
||||
import createKeyDerived from './keyDerived';
|
||||
import decodeAddress from './decode';
|
||||
import encodeAddress from './encode';
|
||||
import encodeDerivedAddress from './encodeDerived';
|
||||
import encodeMultiAddress from './encodeMulti';
|
||||
import addressEq from './eq';
|
||||
import setSS58Format from './setSS58Format';
|
||||
import sortAddresses from './sort';
|
||||
|
||||
export {
|
||||
addressEq,
|
||||
checkAddress,
|
||||
checkAddressChecksum,
|
||||
createKeyDerived,
|
||||
createKeyMulti,
|
||||
createKeySub,
|
||||
decodeAddress,
|
||||
encodeAddress,
|
||||
encodeDerivedAddress,
|
||||
encodeMultiAddress,
|
||||
setSS58Format,
|
||||
sortAddresses
|
||||
};
|
||||
|
||||
+4
-4
@@ -2,12 +2,12 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import createKeySub from './keySub';
|
||||
import createKeyDerived from './keyDerived';
|
||||
|
||||
describe('createKeySub', (): void => {
|
||||
describe('createKeyDerived', (): void => {
|
||||
it('matches sub accounts with Rust', (): void => {
|
||||
expect(
|
||||
createKeySub(new Uint8Array([1, 0, 0, 0, 0, 0, 0, 0]), 0)
|
||||
createKeyDerived(new Uint8Array([1, 0, 0, 0, 0, 0, 0, 0]), 0)
|
||||
).toEqual(
|
||||
new Uint8Array([234, 236, 28, 96, 177, 168, 152, 193, 71, 179, 226, 102, 179, 155, 188, 240, 90, 182, 21, 175, 47, 47, 250, 179, 178, 0, 81, 222, 70, 56, 52, 234])
|
||||
);
|
||||
@@ -15,7 +15,7 @@ describe('createKeySub', (): void => {
|
||||
|
||||
it('creates a valid subkey', (): void => {
|
||||
expect(
|
||||
createKeySub('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 1)
|
||||
createKeyDerived('5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY', 1)
|
||||
).toEqual(
|
||||
new Uint8Array([248, 19, 86, 209, 254, 89, 84, 48, 54, 128, 166, 239, 153, 212, 143, 34, 191, 60, 210, 50, 39, 77, 122, 71, 29, 60, 247, 198, 95, 101, 246, 83])
|
||||
);
|
||||
+5
-3
@@ -3,15 +3,17 @@
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import BN from 'bn.js';
|
||||
import { bnToU8a, u8aConcat } from '@polkadot/util';
|
||||
import { bnToU8a, stringToU8a, u8aConcat } from '@polkadot/util';
|
||||
|
||||
import blake2AsU8a from '../blake2/asU8a';
|
||||
import decodeAddress from './decode';
|
||||
|
||||
export default function createKeySub (who: Uint8Array | string, index: BigInt | BN | number): Uint8Array {
|
||||
const PREFIX = stringToU8a('modlpy/utilisuba');
|
||||
|
||||
export default function createKeyDerived (who: Uint8Array | string, index: BigInt | BN | number): Uint8Array {
|
||||
return blake2AsU8a(
|
||||
u8aConcat(
|
||||
'modlpy/utilisuba',
|
||||
PREFIX,
|
||||
decodeAddress(who),
|
||||
bnToU8a(index, { bitLength: 16, isLe: true })
|
||||
)
|
||||
@@ -3,15 +3,17 @@
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import BN from 'bn.js';
|
||||
import { bnToU8a, compactToU8a, u8aConcat, u8aSorted } from '@polkadot/util';
|
||||
import { bnToU8a, compactToU8a, stringToU8a, u8aConcat, u8aSorted } from '@polkadot/util';
|
||||
|
||||
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 {
|
||||
return blake2AsU8a(
|
||||
u8aConcat(
|
||||
'modlpy/utilisuba',
|
||||
PREFIX,
|
||||
compactToU8a(who.length),
|
||||
...u8aSorted(who.map((who) => decodeAddress(who))),
|
||||
bnToU8a(threshold, { bitLength: 16, isLe: true })
|
||||
|
||||
@@ -7,6 +7,10 @@ export const allowedSS58 = [
|
||||
0, 1,
|
||||
// Kusama
|
||||
2, 3,
|
||||
// Katal Chain
|
||||
4,
|
||||
// Kulupu
|
||||
16, 17,
|
||||
// Dothereum
|
||||
20,
|
||||
// Substrate default
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import baseX from 'base-x';
|
||||
|
||||
// https://github.com/cryptocoinjs/base-x#alphabets
|
||||
const BASE58_ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
|
||||
|
||||
const bs58 = baseX(BASE58_ALPHABET);
|
||||
|
||||
export {
|
||||
BASE58_ALPHABET,
|
||||
bs58
|
||||
};
|
||||
@@ -0,0 +1,20 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { bufferToU8a } from '@polkadot/util';
|
||||
|
||||
import { bs58 } from './bs58';
|
||||
import validate from './validate';
|
||||
|
||||
/**
|
||||
* @name base58Decode
|
||||
* @summary Decodes a base58 value.
|
||||
* @description
|
||||
* From the provided input, decode the base58 and return the result as an `Uint8Array`.
|
||||
*/
|
||||
export default function base58Decode (value: string): Uint8Array {
|
||||
validate(value);
|
||||
|
||||
return bufferToU8a(bs58.decode(value));
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { u8aToBuffer, u8aToU8a } from '@polkadot/util';
|
||||
|
||||
import { bs58 } from './bs58';
|
||||
|
||||
/**
|
||||
* @name base58Encode
|
||||
* @summary Creates a base58 value.
|
||||
* @description
|
||||
* From the provided input, create the base58 and return the result as a string.
|
||||
*/
|
||||
export default function base58Encode (value: Uint8Array | string | Buffer | number[]): string {
|
||||
return bs58.encode(
|
||||
u8aToBuffer(u8aToU8a(value))
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
/**
|
||||
* @summary Encode and decode base58 values
|
||||
*/
|
||||
|
||||
export { default as base58Decode } from './decode';
|
||||
export { default as base58Encode } from './encode';
|
||||
export { default as base58Validate } from './validate';
|
||||
@@ -0,0 +1,21 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { BASE58_ALPHABET } from './bs58';
|
||||
|
||||
/**
|
||||
* @name base58Validate
|
||||
* @summary Validates a base58 value.
|
||||
* @description
|
||||
* Validates the the supplied value is valid base58
|
||||
*/
|
||||
export default function base58Validate (value: string): true {
|
||||
for (let i = 0; i < value.length; i++) {
|
||||
if (!BASE58_ALPHABET.includes(value[i])) {
|
||||
throw new TypeError(`Invalid base58 character "${value[i]}" (0x${value.charCodeAt(i).toString(16)}) at index ${i}`);
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { stringToU8a } from '@polkadot/util';
|
||||
|
||||
import { base64Decode } from '.';
|
||||
|
||||
describe('base64Decode', (): void => {
|
||||
it('decodes a mixed base64 utf8 string', (): void => {
|
||||
expect(
|
||||
base64Decode('aGVsbG8gd29ybGQg0J/RgNC40LLQtdGC0YHRgtCy0YPRjiDQvNC4IOS9oOWlvQ==')
|
||||
).toEqual(
|
||||
stringToU8a('hello world Приветствую ми 你好')
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,19 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { bufferToU8a } from '@polkadot/util';
|
||||
|
||||
import validate from './validate';
|
||||
|
||||
/**
|
||||
* @name base64Decode
|
||||
* @summary Decodes a base64 value.
|
||||
* @description
|
||||
* From the provided input, decode the base64 and return the result as an `Uint8Array`.
|
||||
*/
|
||||
export default function base64Decode (value: string): Uint8Array {
|
||||
validate(value);
|
||||
|
||||
return bufferToU8a(Buffer.from(value, 'base64'));
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { base64Encode } from '.';
|
||||
|
||||
describe('base64Encode', (): void => {
|
||||
it('encodes a mixed base64 utf8 string', (): void => {
|
||||
expect(
|
||||
base64Encode('hello world Приветствую ми 你好')
|
||||
).toEqual('aGVsbG8gd29ybGQg0J/RgNC40LLQtdGC0YHRgtCy0YPRjiDQvNC4IOS9oOWlvQ==');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,15 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { u8aToBuffer, u8aToU8a } from '@polkadot/util';
|
||||
|
||||
/**
|
||||
* @name base64Encode
|
||||
* @summary Creates a base64 value.
|
||||
* @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 {
|
||||
return u8aToBuffer(u8aToU8a(value)).toString('base64');
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
/**
|
||||
* @summary Encode and decode base64 values
|
||||
*/
|
||||
|
||||
export { default as base64Decode } from './decode';
|
||||
export { default as base64Encode } from './encode';
|
||||
export { default as base64Validate } from './validate';
|
||||
@@ -0,0 +1,13 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { base64Validate } from '.';
|
||||
|
||||
describe('base64Validate', (): void => {
|
||||
it('decodes a mixed base64 utf8 string', (): void => {
|
||||
expect(
|
||||
() => base64Validate('aGVsbG8gd29ybGQg0J/RgNC40LLQtd^GC0YHRgtCy0YPRjiDQvNC4IOS9oOWlvQ==')
|
||||
).toThrow(/Invalid base64 encoding/);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,17 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
/**
|
||||
* @name base64Validate
|
||||
* @summary Validates a base64 value.
|
||||
* @description
|
||||
* Validates the the supplied value is valid base64
|
||||
*/
|
||||
export default function base64Validate (value: string): true {
|
||||
if (!(/^(?:[A-Za-z0-9+/]{2}[A-Za-z0-9+/]{2})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(value))) {
|
||||
throw new TypeError('Invalid base64 encoding');
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -43,4 +43,18 @@ describe('blake2AsU8a', (): void => {
|
||||
hexToU8a('0xba80a53f981c4d0d6a2797b69f12f6e94c212f14685ac4b74b12bb6fdbffa2d17d87c5392aab792dc252d5de4533cc9518d38aa8dbf1925ab92386edd4009923')
|
||||
);
|
||||
});
|
||||
|
||||
it('has equivalent Wasm/Js outputs on hex inputs', (): void => {
|
||||
const a = blake2AsU8a('0x123456', 256, null, false);
|
||||
const b = blake2AsU8a('0x123456', 256, null, true);
|
||||
|
||||
expect(a).toEqual(b);
|
||||
});
|
||||
|
||||
it('has equivalent Wasm/Js outputs with key inputs', (): void => {
|
||||
const a = blake2AsU8a('0x123456', 256, new Uint8Array([1, 2]), false);
|
||||
const b = blake2AsU8a('0x123456', 256, new Uint8Array([1, 2]), true);
|
||||
|
||||
expect(a).toEqual(b);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -20,10 +20,10 @@ 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): Uint8Array {
|
||||
export default function blake2AsU8a (data: Uint8Array | string, bitLength = 256, key: Uint8Array | null = null, onlyJs = false): Uint8Array {
|
||||
const byteLength = Math.ceil(bitLength / 8);
|
||||
|
||||
return isReady()
|
||||
return isReady() && !onlyJs
|
||||
? blake2b(u8aToU8a(data), u8aToU8a(key), byteLength)
|
||||
: blakejs.blake2b(data, key, byteLength);
|
||||
: blakejs.blake2b(u8aToU8a(data), key, byteLength);
|
||||
}
|
||||
|
||||
@@ -10,13 +10,17 @@ export * from './init';
|
||||
|
||||
// all internal exports
|
||||
export * from './address';
|
||||
export * from './base58';
|
||||
export * from './base64';
|
||||
export * from './blake2';
|
||||
export * from './keccak';
|
||||
export * from './key';
|
||||
export * from './mnemonic';
|
||||
export * from './nacl';
|
||||
export * from './pbkdf2';
|
||||
export * from './random';
|
||||
export * from './schnorrkel';
|
||||
export * from './scrypt';
|
||||
export * from './secp256k1';
|
||||
export * from './sha512';
|
||||
export * from './signature';
|
||||
|
||||
@@ -2,8 +2,9 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import BN from 'bn.js';
|
||||
import { bnToHex, compactAddLength, hexToU8a, isBn, isHex, isNumber, isString, stringToU8a } from '@polkadot/util';
|
||||
import type BN from 'bn.js';
|
||||
|
||||
import { bnToHex, compactAddLength, hexToU8a, isBigInt, isBn, isHex, isNumber, isString, stringToU8a } from '@polkadot/util';
|
||||
|
||||
import blake2AsU8a from '../blake2/asU8a';
|
||||
|
||||
@@ -21,10 +22,10 @@ export default class DeriveJunction {
|
||||
#isHard = false;
|
||||
|
||||
public static from (value: string): DeriveJunction {
|
||||
const result = new DeriveJunction();
|
||||
const [code, isHard] = value.startsWith('/')
|
||||
? [value.substr(1), true]
|
||||
: [value, false];
|
||||
const result = new DeriveJunction();
|
||||
|
||||
result.soft(
|
||||
RE_NUMBER.test(code)
|
||||
@@ -49,7 +50,7 @@ export default class DeriveJunction {
|
||||
return !this.#isHard;
|
||||
}
|
||||
|
||||
public hard (value: number | BN | string | Uint8Array): DeriveJunction {
|
||||
public hard (value: number | string | BigInt | BN | Uint8Array): DeriveJunction {
|
||||
return this.soft(value).harden();
|
||||
}
|
||||
|
||||
@@ -59,8 +60,8 @@ export default class DeriveJunction {
|
||||
return this;
|
||||
}
|
||||
|
||||
public soft (value: number | BN | string | Uint8Array): DeriveJunction {
|
||||
if (isNumber(value) || isBn(value)) {
|
||||
public soft (value: number | string | BigInt | BN | Uint8Array): DeriveJunction {
|
||||
if (isNumber(value) || isBn(value) || isBigInt(value)) {
|
||||
return this.soft(bnToHex(value, BN_OPTIONS));
|
||||
} else if (isString(value)) {
|
||||
return isHex(value)
|
||||
|
||||
@@ -13,7 +13,7 @@ export interface ExtractResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* @description Extract derivation juntions from the supplied path
|
||||
* @description Extract derivation junctions from the supplied path
|
||||
*/
|
||||
export default function keyExtractPath (derivePath: string): ExtractResult {
|
||||
const parts = derivePath.match(RE_JUNCTION);
|
||||
|
||||
@@ -9,12 +9,14 @@ import keyHdkdEd15519 from './hdkdEd25519';
|
||||
import keyHdkdSr15519 from './hdkdSr25519';
|
||||
import keyHdkdEcdsa from './hdkdEcdsa';
|
||||
|
||||
const generators = {
|
||||
ecdsa: keyHdkdEcdsa,
|
||||
ed25519: keyHdkdEd15519,
|
||||
sr25519: keyHdkdSr15519
|
||||
};
|
||||
|
||||
export default function keyFromPath (pair: Keypair, path: DeriveJunction[], type: KeypairType): Keypair {
|
||||
const keyHdkd = {
|
||||
ecdsa: keyHdkdEcdsa,
|
||||
ed25519: keyHdkdEd15519,
|
||||
sr25519: keyHdkdSr15519
|
||||
}[type];
|
||||
const keyHdkd = generators[type];
|
||||
|
||||
return path.reduce((pair, junction): Keypair => {
|
||||
return keyHdkd(pair, junction);
|
||||
|
||||
@@ -11,5 +11,4 @@ import '../polyfill';
|
||||
export { default as mnemonicGenerate } from './generate';
|
||||
export { default as mnemonicToEntropy } from './toEntropy';
|
||||
export { default as mnemonicToMiniSecret } from './toMiniSecret';
|
||||
export { default as mnemonicToSeed } from './toSeed';
|
||||
export { default as mnemonicValidate } from './validate';
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { u8aToHex } from '@polkadot/util';
|
||||
|
||||
import toSeed from './toSeed';
|
||||
|
||||
describe('mnemonicToSeed', (): void => {
|
||||
it('generates a valid seed', (): void => {
|
||||
expect(
|
||||
u8aToHex(toSeed('seed sock milk update focus rotate barely fade car face mechanic mercy'))
|
||||
).toEqual('0x3c121e20de068083b49c2315697fb59a2d9e8643c24e5ea7628132c58969a027');
|
||||
});
|
||||
});
|
||||
@@ -1,30 +0,0 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { mnemonicToSeedSync } from 'bip39';
|
||||
import { bufferToU8a } from '@polkadot/util';
|
||||
import { bip39ToSeed, isReady } from '@polkadot/wasm-crypto';
|
||||
|
||||
/**
|
||||
* @name toSeed
|
||||
* @summary Creates a valid seed from a mnemonic input
|
||||
* @example
|
||||
* <BR>
|
||||
*
|
||||
* ```javascript
|
||||
* import { mnemonicGenerate, mnemonicToSeed, mnemonicValidate } from '@polkadot/util-crypto';
|
||||
*
|
||||
* const mnemonic = mnemonicGenerate(); // => string
|
||||
* const isValidMnemonic = mnemonicValidate(mnemonic); // => boolean
|
||||
*
|
||||
* if (isValidMnemonic) {
|
||||
* console.log(`Seed generated from mnemonic: ${mnemonicToSeed(mnemonic)}`); => u8a
|
||||
* }
|
||||
* ```
|
||||
*/
|
||||
export default function toSeed (mnemonic: string, password = ''): Uint8Array {
|
||||
return isReady()
|
||||
? bip39ToSeed(mnemonic, password)
|
||||
: bufferToU8a(mnemonicToSeedSync(mnemonic, password)).subarray(0, 32);
|
||||
}
|
||||
@@ -33,19 +33,19 @@ describe('naclOpen', (): void => {
|
||||
// Receiver sends encrypting public key to receive message to decrypt with his private key
|
||||
const receiverIdBoxKey = naclBoxKeypairFromSecret(receiverIdKey.secretKey);
|
||||
|
||||
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey.publicKey}`);
|
||||
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey.publicKey.toString()}`);
|
||||
|
||||
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
|
||||
const senderIdBoxKey = naclBoxKeypairFromSecret(senderIdKey.secretKey);
|
||||
const message = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
|
||||
const { nonce, sealed } = naclSeal(message, senderIdBoxKey.secretKey, receiverIdBoxKey.publicKey);
|
||||
|
||||
console.log(`Sender sends encrypted message to receiver ${sealed}, ${nonce}`);
|
||||
console.log(`Sender sends encrypted message to receiver ${sealed.toString()}, ${nonce.toString()}`);
|
||||
|
||||
// Receiver opens encrypted message from the sender
|
||||
let opened = naclOpen(sealed, nonce, senderIdBoxKey.publicKey, receiverIdBoxKey.secretKey);
|
||||
|
||||
console.log(`The sealed message is ${opened}`);
|
||||
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');
|
||||
@@ -54,7 +54,7 @@ describe('naclOpen', (): void => {
|
||||
// Receiver sends encrypting public key to receive message to decrypt with his private key
|
||||
const receiverIdBoxKey2 = naclBoxKeypairFromSecret(receiverIdKey2.secretKey);
|
||||
|
||||
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey2.publicKey}`);
|
||||
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey2.publicKey.toString()}`);
|
||||
|
||||
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
|
||||
const senderIdBoxKey2 = naclBoxKeypairFromSecret(senderIdKey2.secretKey);
|
||||
@@ -63,17 +63,17 @@ describe('naclOpen', (): void => {
|
||||
const sealed2 = ctx.sealed;
|
||||
const nonce2 = ctx.nonce;
|
||||
|
||||
console.log(`Sender sends encrypted message to receiver ${sealed}, ${nonce}`);
|
||||
console.log(`Sender sends encrypted message to receiver ${sealed.toString()}, ${nonce.toString()}`);
|
||||
|
||||
// Receiver opens encrypted message from the sender
|
||||
opened = naclOpen(sealed2, nonce2, senderIdBoxKey2.publicKey, receiverIdBoxKey2.secretKey);
|
||||
console.log(`The sealed message is ${opened}`);
|
||||
console.log(`The sealed message is ${opened?.toString() || 'null'}`);
|
||||
|
||||
// This time derive key for each message to send and receive
|
||||
// Receiver sends encrypting public key to receive message to decrypt with his private key
|
||||
const receiverIdBoxKey2One = naclBoxKeypairFromSecret(receiverIdBoxKey2.secretKey);
|
||||
|
||||
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey2One.publicKey}`);
|
||||
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey2One.publicKey.toString()}`);
|
||||
|
||||
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
|
||||
const senderIdBoxKey2One = naclBoxKeypairFromSecret(senderIdBoxKey2.secretKey);
|
||||
@@ -84,11 +84,11 @@ describe('naclOpen', (): void => {
|
||||
const sealed3 = ctx.sealed;
|
||||
const nonce3 = ctx.nonce;
|
||||
|
||||
console.log(`Sender sends encrypted message to receiver ${sealed3}, ${nonce3}`);
|
||||
console.log(`Sender sends encrypted message to receiver ${sealed3.toString()}, ${nonce3.toString()}`);
|
||||
|
||||
// Receiver opens encrypted message from the sender
|
||||
opened = naclOpen(sealed2, nonce2, senderIdBoxKey2One.publicKey, receiverIdBoxKey2One.secretKey);
|
||||
console.log(`The sealed message is ${opened}`);
|
||||
console.log(`The sealed message is ${opened?.toString() || 'null'}`);
|
||||
});
|
||||
|
||||
it('returns null on invalid', (): void => {
|
||||
|
||||
@@ -23,7 +23,7 @@ import { isReady, ed25519Sign } from '@polkadot/wasm-crypto';
|
||||
* ```
|
||||
*/
|
||||
export default function naclSign (message: Uint8Array | string, { publicKey, secretKey }: Partial<Keypair>): Uint8Array {
|
||||
assert(secretKey, 'Expected valid secretKey');
|
||||
assert(secretKey, 'Expected a valid secretKey');
|
||||
|
||||
const messageU8a = u8aToU8a(message);
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import { waitReady } from '@polkadot/wasm-crypto';
|
||||
|
||||
import { naclVerify, naclKeypairFromSeed } from '.';
|
||||
|
||||
describe('naclSign', (): void => {
|
||||
describe('naclVerify', (): void => {
|
||||
let publicKey: Uint8Array;
|
||||
let signature: Uint8Array;
|
||||
|
||||
@@ -51,4 +51,24 @@ describe('naclSign', (): void => {
|
||||
)
|
||||
).toEqual(false);
|
||||
});
|
||||
|
||||
it('throws error when publicKey lengths do not match', (): void => {
|
||||
expect(
|
||||
() => naclVerify(
|
||||
new Uint8Array([0x61, 0x62, 0x63, 0x64]),
|
||||
signature,
|
||||
new Uint8Array([1, 2])
|
||||
)
|
||||
).toThrow(/Invalid publicKey/);
|
||||
});
|
||||
|
||||
it('throws error when signature lengths do not match', (): void => {
|
||||
expect(
|
||||
() => naclVerify(
|
||||
new Uint8Array([0x61, 0x62, 0x63, 0x64]),
|
||||
new Uint8Array([1, 2]),
|
||||
publicKey
|
||||
)
|
||||
).toThrow(/Invalid signature/);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import nacl from 'tweetnacl';
|
||||
import { u8aToU8a } from '@polkadot/util';
|
||||
import { assert, u8aToU8a } from '@polkadot/util';
|
||||
import { isReady, ed25519Verify } from '@polkadot/wasm-crypto';
|
||||
|
||||
/**
|
||||
* @name naclSign
|
||||
* @summary Verifies the signature on the supplied message.
|
||||
* @description
|
||||
* Verifies the `signature` on `message` with the supplied `plublicKey`. Returns `true` on sucess, `false` otherwise.
|
||||
* Verifies the `signature` on `message` with the supplied `publicKey`. Returns `true` on sucess, `false` otherwise.
|
||||
* @example
|
||||
* <BR>
|
||||
*
|
||||
@@ -22,8 +22,11 @@ import { isReady, ed25519Verify } from '@polkadot/wasm-crypto';
|
||||
*/
|
||||
export default function naclVerify (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string): boolean {
|
||||
const messageU8a = u8aToU8a(message);
|
||||
const signatureU8a = u8aToU8a(signature);
|
||||
const publicKeyU8a = u8aToU8a(publicKey);
|
||||
const signatureU8a = u8aToU8a(signature);
|
||||
|
||||
assert(publicKeyU8a.length === 32, `Invalid publicKey, received ${publicKeyU8a.length}, expected 32`);
|
||||
assert(signatureU8a.length === 64, `Invalid signature, received ${signatureU8a.length} bytes, expected 64`);
|
||||
|
||||
return isReady()
|
||||
? ed25519Verify(signatureU8a, messageU8a, publicKeyU8a)
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { pbkdf2Sync } from 'pbkdf2';
|
||||
import { bufferToU8a, u8aToBuffer, u8aToU8a } from '@polkadot/util';
|
||||
import { isReady, pbkdf2 } from '@polkadot/wasm-crypto';
|
||||
|
||||
import randomAsU8a from '../random/asU8a';
|
||||
|
||||
interface Result {
|
||||
password: Uint8Array;
|
||||
rounds: number;
|
||||
salt: Uint8Array;
|
||||
}
|
||||
|
||||
export default function pbkdf2Encode (passphrase?: Uint8Array | string, salt = randomAsU8a(), rounds = 2048): Result {
|
||||
const u8a = u8aToU8a(passphrase);
|
||||
const password = isReady()
|
||||
? pbkdf2(u8a, salt, rounds)
|
||||
: bufferToU8a(pbkdf2Sync(u8aToBuffer(u8a), u8aToBuffer(salt), rounds, 64));
|
||||
|
||||
return { password, rounds, salt };
|
||||
}
|
||||
@@ -0,0 +1,5 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
export { default as pbkdf2Encode } from './encode';
|
||||
@@ -14,8 +14,8 @@ import { sr25519Sign } from '@polkadot/wasm-crypto';
|
||||
* @description Returns message signature of `message`, using the supplied pair
|
||||
*/
|
||||
export default function schnorrkelSign (message: Uint8Array | string, { publicKey, secretKey }: Partial<Keypair>): Uint8Array {
|
||||
assert(publicKey?.length === 32, 'Expected valid publicKey, 32-bytes');
|
||||
assert(secretKey?.length === 64, 'Expected valid secretKey, 64-bytes');
|
||||
assert(publicKey?.length === 32, 'Expected a valid publicKey, 32-bytes');
|
||||
assert(secretKey?.length === 64, 'Expected a valid secretKey, 64-bytes');
|
||||
|
||||
const messageU8a = u8aToU8a(message);
|
||||
|
||||
|
||||
@@ -29,4 +29,24 @@ describe('sign and verify', (): void => {
|
||||
|
||||
expect(verify(MESSAGE, signature, pair.publicKey)).toBe(true);
|
||||
});
|
||||
|
||||
it('throws error when publicKey lengths do not match', (): void => {
|
||||
expect(
|
||||
() => verify(
|
||||
new Uint8Array([0x61, 0x62, 0x63, 0x64]),
|
||||
new Uint8Array(64),
|
||||
new Uint8Array(31)
|
||||
)
|
||||
).toThrow(/Invalid publicKey/);
|
||||
});
|
||||
|
||||
it('throws error when signature lengths do not match', (): void => {
|
||||
expect(
|
||||
() => verify(
|
||||
new Uint8Array([0x61, 0x62, 0x63, 0x64]),
|
||||
new Uint8Array(65),
|
||||
new Uint8Array(32)
|
||||
)
|
||||
).toThrow(/Invalid signature/);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
import '../polyfill';
|
||||
|
||||
import { u8aToU8a } from '@polkadot/util';
|
||||
import { assert, u8aToU8a } from '@polkadot/util';
|
||||
import { sr25519Verify } from '@polkadot/wasm-crypto';
|
||||
|
||||
/**
|
||||
@@ -13,8 +13,11 @@ import { sr25519Verify } from '@polkadot/wasm-crypto';
|
||||
*/
|
||||
export default function schnorrkelVerify (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string): boolean {
|
||||
const messageU8a = u8aToU8a(message);
|
||||
const signatureU8a = u8aToU8a(signature);
|
||||
const publicKeyU8a = u8aToU8a(publicKey);
|
||||
const signatureU8a = u8aToU8a(signature);
|
||||
|
||||
assert(publicKeyU8a.length === 32, `Invalid publicKey, received ${publicKeyU8a.length} bytes, expected 32`);
|
||||
assert(signatureU8a.length === 64, `Invalid signature, received ${signatureU8a.length} bytes, expected 64`);
|
||||
|
||||
return sr25519Verify(signatureU8a, messageU8a, publicKeyU8a);
|
||||
}
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
const DEFAULT_PARAMS = {
|
||||
N: 1 << 15,
|
||||
p: 1,
|
||||
r: 8
|
||||
};
|
||||
|
||||
export { DEFAULT_PARAMS };
|
||||
@@ -0,0 +1,25 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { Params } from './types';
|
||||
|
||||
import scrypt from 'scryptsy';
|
||||
import { bufferToU8a, u8aToBuffer, u8aToU8a } from '@polkadot/util';
|
||||
|
||||
import randomAsU8a from '../random/asU8a';
|
||||
import { DEFAULT_PARAMS } from './defaults';
|
||||
|
||||
interface Result {
|
||||
params: Params,
|
||||
password: Uint8Array;
|
||||
salt: Uint8Array;
|
||||
}
|
||||
|
||||
export default function scryptEncode (passphrase?: Uint8Array | string, salt = randomAsU8a(), params = DEFAULT_PARAMS): Result {
|
||||
const password = bufferToU8a(
|
||||
scrypt(u8aToBuffer(u8aToU8a(passphrase)), u8aToBuffer(salt), params.N, params.r, params.p, 64)
|
||||
);
|
||||
|
||||
return { params, password, salt };
|
||||
}
|
||||
@@ -0,0 +1,29 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { Params } from './types';
|
||||
|
||||
import { u8aToBn, assert } from '@polkadot/util';
|
||||
|
||||
import { DEFAULT_PARAMS } from './defaults';
|
||||
|
||||
interface Result {
|
||||
params: Params,
|
||||
salt: Uint8Array;
|
||||
}
|
||||
|
||||
export default 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();
|
||||
const r = u8aToBn(data.subarray(32 + 8, 32 + 12), { isLe: true }).toNumber();
|
||||
|
||||
// FIXME At this moment we assume these to be fixed params, this is not a great idea since we lose flexibility
|
||||
// and updates for greater security. However we need some protection against carefully-crafted params that can
|
||||
// eat up CPU since these are user inputs. So we need to get very clever here, but atm we only allow the defaults
|
||||
// and if no match, bail out
|
||||
assert(N === DEFAULT_PARAMS.N && p === DEFAULT_PARAMS.p && r === DEFAULT_PARAMS.r, 'Invalid injected scrypt params found');
|
||||
|
||||
return { params: { N, p, r }, salt };
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
export { default as scryptEncode } from './encode';
|
||||
export { default as scryptFromU8a } from './fromU8a';
|
||||
export { default as scryptToU8a } from './toU8a';
|
||||
@@ -0,0 +1,16 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { Params } from './types';
|
||||
|
||||
import { bnToU8a, u8aConcat } from '@polkadot/util';
|
||||
|
||||
export default function scryptToU8a (salt: Uint8Array, { N, p, r }: Params): Uint8Array {
|
||||
return u8aConcat(
|
||||
salt,
|
||||
bnToU8a(N, { bitLength: 32, isLe: true }),
|
||||
bnToU8a(p, { bitLength: 32, isLe: true }),
|
||||
bnToU8a(r, { bitLength: 32, isLe: true })
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
export interface Params {
|
||||
N: number;
|
||||
p: number;
|
||||
r: number;
|
||||
}
|
||||
@@ -14,11 +14,12 @@ const ec = new EC('secp256k1');
|
||||
* @description Returns a object containing a `publicKey` & `secretKey` generated from the supplied seed.
|
||||
*/
|
||||
export default function secp256k1KeypairFromSeed (seed: Uint8Array): Keypair {
|
||||
assert(seed.length === 32, 'Expected valid 32-byte private key as a seed: ' + seed);
|
||||
assert(seed.length === 32, 'Expected valid 32-byte private key as a seed');
|
||||
|
||||
const key = ec.keyFromPrivate(seed);
|
||||
|
||||
return {
|
||||
publicKey: new Uint8Array(key.getPublic().encodeCompressed('array')),
|
||||
secretKey: hexToU8a('0x' + key.getPrivate('hex'))
|
||||
secretKey: hexToU8a(`0x${key.getPrivate('hex')}`)
|
||||
};
|
||||
}
|
||||
|
||||
@@ -13,6 +13,7 @@ const ec = new EC('secp256k1');
|
||||
*/
|
||||
export default 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
|
||||
.recoverPubKey(message, { r: signature.slice(0, 32), s: signature.slice(32, 64) }, recovery)
|
||||
.encode(null, true)
|
||||
|
||||
@@ -21,6 +21,7 @@ export default function secp256k1Verify (message: Uint8Array | string, signature
|
||||
};
|
||||
const recovery = signatureU8a[64];
|
||||
const publicKey = new Uint8Array(
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access
|
||||
ec.recoverPubKey(blake2AsU8a(message, 256), sig, recovery)
|
||||
.encodeCompressed(null)
|
||||
);
|
||||
|
||||
@@ -67,10 +67,9 @@ export default function signatureVerify (message: Uint8Array | string, signature
|
||||
|
||||
const result: VerifyResult = { crypto: 'none', isValid: false };
|
||||
const publicKey = addressDecode(addressOrPublicKey);
|
||||
const isMultisig = [0, 1, 2].includes(signatureU8a[0]) && [65, 66].includes(signatureU8a.length);
|
||||
|
||||
const multisig = [0, 1, 2].includes(signatureU8a[0]) && [65, 66].includes(signatureU8a.length);
|
||||
|
||||
if (multisig) {
|
||||
if (isMultisig) {
|
||||
return verifyMultisig(result, message, signatureU8a, publicKey);
|
||||
} else {
|
||||
return verifyDetect(result, message, signatureU8a, publicKey);
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@polkadot/util",
|
||||
"version": "2.9.1",
|
||||
"version": "3.0.1",
|
||||
"description": "A collection of useful utilities for @polkadot",
|
||||
"main": "index.js",
|
||||
"keywords": [
|
||||
@@ -25,11 +25,11 @@
|
||||
},
|
||||
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util#readme",
|
||||
"dependencies": {
|
||||
"@babel/runtime": "^7.9.2",
|
||||
"@babel/runtime": "^7.10.5",
|
||||
"@types/bn.js": "^4.11.6",
|
||||
"bn.js": "^5.1.1",
|
||||
"bn.js": "^5.1.2",
|
||||
"camelcase": "^5.3.1",
|
||||
"chalk": "^4.0.0",
|
||||
"chalk": "^4.1.0",
|
||||
"ip-regex": "^4.1.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -21,8 +21,8 @@ import isUndefined from '../is/undefined';
|
||||
* ```
|
||||
*/
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
export default function arrayFilter (array: any[], allowNulls = true): any[] {
|
||||
return array.filter((value): boolean => {
|
||||
return !isUndefined(value) && (allowNulls || !isNull(value));
|
||||
});
|
||||
export default function arrayFilter <T = any> (array: T[], allowNulls = true): T[] {
|
||||
return array.filter((value) =>
|
||||
!isUndefined(value) && (allowNulls || !isNull(value))
|
||||
);
|
||||
}
|
||||
|
||||
@@ -22,7 +22,7 @@ type MessageFn = () => string;
|
||||
* assert(false, () => 'message'); // Error with 'message'
|
||||
* ```
|
||||
*/
|
||||
export default function assert (condition: boolean | object | string | number | undefined | null, message: string | MessageFn): asserts condition {
|
||||
export default function assert (condition: unknown, message: string | MessageFn): asserts condition {
|
||||
if (!condition) {
|
||||
throw new Error(
|
||||
isFunction(message)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
// Copyright 2017-2020 @polkadot/util authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { BN_ZERO, BN_ONE, BN_TEN, BN_HUNDRED, BN_THOUSAND } from '.';
|
||||
import BN from 'bn.js';
|
||||
|
||||
describe('consts', (): void => {
|
||||
it('BN_ZERO equals 0', (): void => {
|
||||
expect(
|
||||
BN_ZERO
|
||||
).toEqual(new BN(0));
|
||||
});
|
||||
|
||||
it('BN_ONE equals 1', (): void => {
|
||||
expect(
|
||||
BN_ONE
|
||||
).toEqual(new BN(1));
|
||||
});
|
||||
|
||||
it('BN_TEN equals 10', (): void => {
|
||||
expect(
|
||||
BN_TEN
|
||||
).toEqual(new BN(10));
|
||||
});
|
||||
|
||||
it('BN_HUNDRED equals 100', (): void => {
|
||||
expect(
|
||||
BN_HUNDRED
|
||||
).toEqual(new BN(100));
|
||||
});
|
||||
|
||||
it('BN_THOUSAND equals 1000', (): void => {
|
||||
expect(
|
||||
BN_THOUSAND
|
||||
).toEqual(new BN(1000));
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,43 @@
|
||||
// Copyright 2017-2020 @polkadot/util authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import BN from 'bn.js';
|
||||
|
||||
/**
|
||||
* @name BN_ZERO
|
||||
* @summary BN constant for 0.
|
||||
*/
|
||||
const BN_ZERO: BN = new BN(0);
|
||||
|
||||
/**
|
||||
* @name BN_ONE
|
||||
* @summary BN constant for 1.
|
||||
*/
|
||||
const BN_ONE: BN = new BN(1);
|
||||
|
||||
/**
|
||||
* @name BN_TEN
|
||||
* @summary BN constant for 10.
|
||||
*/
|
||||
const BN_TEN: BN = new BN(10);
|
||||
|
||||
/**
|
||||
* @name BN_HUNDRED
|
||||
* @summary BN constant for 100.
|
||||
*/
|
||||
const BN_HUNDRED: BN = new BN(100);
|
||||
|
||||
/**
|
||||
* @name BN_THOUSAND
|
||||
* @summary BN constant for 1000.
|
||||
*/
|
||||
const BN_THOUSAND: BN = new BN(1000);
|
||||
|
||||
export {
|
||||
BN_ZERO,
|
||||
BN_ONE,
|
||||
BN_TEN,
|
||||
BN_HUNDRED,
|
||||
BN_THOUSAND
|
||||
};
|
||||
@@ -6,6 +6,7 @@
|
||||
* @summary Utility methods to convert to and from `BN` objects
|
||||
*/
|
||||
|
||||
export * from './consts';
|
||||
export { default as bnFromHex } from './fromHex';
|
||||
export { default as bnMax } from './max';
|
||||
export { default as bnMin } from './min';
|
||||
|
||||
@@ -22,5 +22,5 @@ import assert from '../assert';
|
||||
export default function max (...items: BN[]): BN {
|
||||
assert(items && items.length >= 1, 'Must provide one or more BN arguments');
|
||||
|
||||
return items.reduce((acc: BN, val: BN): BN => BN.max(acc, val), items[0]);
|
||||
return items.reduce((acc: BN, val: BN) => BN.max(acc, val), items[0]);
|
||||
}
|
||||
|
||||
@@ -22,5 +22,5 @@ import assert from '../assert';
|
||||
export default function min (...items: BN[]): BN {
|
||||
assert(items && items.length >= 1, 'Must provide one or more BN arguments');
|
||||
|
||||
return items.reduce((acc: BN, val: BN): BN => BN.min(acc, val), items[0]);
|
||||
return items.reduce((acc: BN, val: BN) => BN.min(acc, val), items[0]);
|
||||
}
|
||||
|
||||
@@ -21,7 +21,7 @@ describe('bnToBn', (): void => {
|
||||
|
||||
it('converts BigInt values to BN', (): void => {
|
||||
expect(
|
||||
bnToBn(128_821n).toNumber()
|
||||
bnToBn(128821n).toNumber()
|
||||
).toEqual(128821);
|
||||
});
|
||||
|
||||
|
||||
@@ -25,6 +25,12 @@ describe('bnToHex', (): void => {
|
||||
).toBe('0x0080');
|
||||
});
|
||||
|
||||
it('converts BN values to a prefixed hex representation (bitLength + le)', (): void => {
|
||||
expect(
|
||||
bnToHex(new BN(128), 16, true)
|
||||
).toBe('0x8000');
|
||||
});
|
||||
|
||||
it('converts BN values to a prefixed hex representation (LE)', (): void => {
|
||||
expect(
|
||||
bnToHex(new BN(128), { bitLength: 16, isLe: true })
|
||||
|
||||
@@ -2,11 +2,12 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { ToBn, ToBnOptions } from '../types';
|
||||
|
||||
import BN from 'bn.js';
|
||||
|
||||
import isNumber from '../is/number';
|
||||
import bnToU8a from './toU8a';
|
||||
import { ToBnOptions } from '../types';
|
||||
import { u8aToHex } from '../u8a';
|
||||
|
||||
const ZERO_STR = '0x00';
|
||||
@@ -30,7 +31,9 @@ interface Options extends ToBnOptions {
|
||||
* bnToHex(new BN(0x123456)); // => '0x123456'
|
||||
* ```
|
||||
*/
|
||||
export default function bnToHex (value?: BN | BigInt | number | null, options: number | Options = { bitLength: -1, isLe: false, isNegative: false }): string {
|
||||
function bnToHex <ExtToBn extends ToBn> (value?: ExtToBn | BN | BigInt | number | null, options?: Options): string;
|
||||
function bnToHex <ExtToBn extends ToBn> (value?: ExtToBn | BN | BigInt | number | null, bitLength?: number, isLe?: boolean): string;
|
||||
function bnToHex <ExtToBn extends ToBn> (value?: ExtToBn | BN | BigInt | number | null, arg1: number | Options = { bitLength: -1, isLe: false, isNegative: false }, arg2?: boolean): string {
|
||||
if (!value) {
|
||||
return ZERO_STR;
|
||||
}
|
||||
@@ -39,8 +42,10 @@ export default function bnToHex (value?: BN | BigInt | number | null, options: n
|
||||
isLe: false,
|
||||
isNegative: false,
|
||||
// Backwards-compatibility
|
||||
...(isNumber(options) ? { bitLength: options } : options)
|
||||
...(isNumber(arg1) ? { bitLength: arg1, isLe: arg2 } : arg1)
|
||||
};
|
||||
|
||||
return u8aToHex(bnToU8a(value, _options));
|
||||
}
|
||||
|
||||
export default bnToHex;
|
||||
|
||||
@@ -10,7 +10,7 @@ describe('bnToU8a', (): void => {
|
||||
it('converts null values to 0x00', (): void => {
|
||||
expect(
|
||||
bnToU8a(null, -1, false)
|
||||
).toEqual(new Uint8Array([]));
|
||||
).toEqual(new Uint8Array());
|
||||
});
|
||||
|
||||
it('converts null values to 0x00000000 (bitLength)', (): void => {
|
||||
|
||||
@@ -2,11 +2,12 @@
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { ToBn, ToBnOptions } from '../types';
|
||||
|
||||
import BN from 'bn.js';
|
||||
|
||||
import isNumber from '../is/number';
|
||||
import bnToBn from './toBn';
|
||||
import { ToBnOptions } from '../types';
|
||||
|
||||
interface Options extends ToBnOptions {
|
||||
bitLength?: number;
|
||||
@@ -26,9 +27,9 @@ interface Options extends ToBnOptions {
|
||||
* bnToU8a(new BN(0x1234)); // => [0x12, 0x34]
|
||||
* ```
|
||||
*/
|
||||
function bnToU8a (value: BN | BigInt | number | null, options?: Options): Uint8Array;
|
||||
function bnToU8a (value: BN | BigInt | number | null, bitLength?: number, isLe?: boolean): Uint8Array;
|
||||
function bnToU8a (value: BN | BigInt | number | null, arg1: number | Options = { bitLength: -1, isLe: true, isNegative: false }, arg2?: boolean): Uint8Array {
|
||||
function bnToU8a <ExtToBn extends ToBn> (value?: ExtToBn | BN | BigInt | number | null, options?: Options): Uint8Array;
|
||||
function bnToU8a <ExtToBn extends ToBn> (value?: ExtToBn | BN | BigInt | number | null, bitLength?: number, isLe?: boolean): Uint8Array;
|
||||
function bnToU8a <ExtToBn extends ToBn> (value?: ExtToBn | BN | BigInt | number | null, arg1: number | Options = { bitLength: -1, isLe: true, isNegative: false }, arg2?: boolean): Uint8Array {
|
||||
const _options: Options = {
|
||||
bitLength: -1,
|
||||
isLe: true,
|
||||
@@ -43,7 +44,7 @@ function bnToU8a (value: BN | BigInt | number | null, arg1: number | Options = {
|
||||
|
||||
if (!value) {
|
||||
return _options.bitLength === -1
|
||||
? new Uint8Array([])
|
||||
? new Uint8Array()
|
||||
: new Uint8Array(byteLength);
|
||||
}
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ describe('bufferToU8a', (): void => {
|
||||
it('returns an empty buffer when null provided', (): void => {
|
||||
expect(
|
||||
bufferToU8a(null)
|
||||
).toEqual(new Uint8Array([]));
|
||||
).toEqual(new Uint8Array());
|
||||
});
|
||||
|
||||
it('returns a Uint8Buffer with the correct values', (): void => {
|
||||
|
||||
@@ -17,9 +17,5 @@
|
||||
* ```
|
||||
*/
|
||||
export default function bufferToU8a (buffer?: Buffer | number[] | null): Uint8Array {
|
||||
if (!buffer) {
|
||||
return new Uint8Array([]);
|
||||
}
|
||||
|
||||
return new Uint8Array(buffer);
|
||||
return new Uint8Array(buffer || []);
|
||||
}
|
||||
|
||||
@@ -39,7 +39,7 @@ function flattenVersions (_all: (VersionPath | string)[]): string {
|
||||
const verLength = all.reduce((max, { version }): number => Math.max(max, version.length), 0);
|
||||
|
||||
return all
|
||||
.map(({ path, version }): string => `\t${version.padEnd(verLength)}\t${expandPath(path)}`)
|
||||
.map(({ path, version }) => `\t${version.padEnd(verLength)}\t${expandPath(path)}`)
|
||||
.join('\n');
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
// Copyright 2017-2020 @polkadot/util authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { extractTime } from '.';
|
||||
|
||||
describe('extractTime', (): void => {
|
||||
const milliseconds = 1e9 + 123;
|
||||
|
||||
it('extracts time components correctly', (): void => {
|
||||
expect(extractTime(milliseconds))
|
||||
.toEqual({
|
||||
days: 11,
|
||||
hours: 13,
|
||||
milliseconds: 123,
|
||||
minutes: 46,
|
||||
seconds: 40
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,73 @@
|
||||
// Copyright 2017-2020 @polkadot/util authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { Time } from './types';
|
||||
|
||||
const HRS = 60 * 60;
|
||||
const DAY = HRS * 24;
|
||||
|
||||
/**
|
||||
* @name addTime
|
||||
* @summary Add together two Time arrays
|
||||
*/
|
||||
|
||||
function addTime (a: Time, b: Time): Time {
|
||||
return {
|
||||
days: a.days + b.days,
|
||||
hours: a.hours + b.hours,
|
||||
milliseconds: a.milliseconds + b.milliseconds,
|
||||
minutes: a.minutes + b.minutes,
|
||||
seconds: a.seconds + b.seconds
|
||||
};
|
||||
}
|
||||
|
||||
const ZERO = { days: 0, hours: 0, milliseconds: 0, minutes: 0, seconds: 0 };
|
||||
|
||||
/**
|
||||
* @name extractTime
|
||||
* @summary Convert a quantity of seconds to Time array representing accumulated {days, minutes, hours, seconds, milliseconds}
|
||||
* @example
|
||||
* <BR>
|
||||
*
|
||||
* ```javascript
|
||||
* import { extractTime } from '@polkadot/util';
|
||||
*
|
||||
* const { days, minutes, hours, seconds, milliseconds } = extractTime(6000); // 0, 0, 10, 0, 0
|
||||
* ```
|
||||
*/
|
||||
export default function extractTime (milliseconds?: number): Time {
|
||||
if (!milliseconds) {
|
||||
return ZERO;
|
||||
} else if (milliseconds < 1000) {
|
||||
return { ...ZERO, milliseconds };
|
||||
}
|
||||
|
||||
const secs = milliseconds / 1000;
|
||||
|
||||
if (secs < 60) {
|
||||
const seconds = Math.floor(secs);
|
||||
|
||||
return addTime({ ...ZERO, seconds }, extractTime(milliseconds - (seconds * 1000)));
|
||||
}
|
||||
|
||||
const mins = secs / 60;
|
||||
|
||||
if (mins < 60) {
|
||||
const minutes = Math.floor(mins);
|
||||
|
||||
return addTime({ ...ZERO, minutes }, extractTime(milliseconds - (minutes * 60 * 1000)));
|
||||
}
|
||||
|
||||
const hrs = mins / 60;
|
||||
|
||||
if (hrs < 24) {
|
||||
const hours = Math.floor(hrs);
|
||||
|
||||
return addTime({ ...ZERO, hours }, extractTime(milliseconds - (hours * HRS * 1000)));
|
||||
}
|
||||
|
||||
const days = Math.floor(hrs / 24);
|
||||
|
||||
return addTime({ ...ZERO, days }, extractTime(milliseconds - (days * DAY * 1000)));
|
||||
}
|
||||
@@ -23,7 +23,7 @@ describe('formatBalance', (): void => {
|
||||
|
||||
it('formats BigInt numbers', (): void => {
|
||||
expect(
|
||||
formatBalance(123_456_789_000n, { decimals: 15, withSi: true })
|
||||
formatBalance(123456789000n, { decimals: 15, withSi: true })
|
||||
).toEqual('123.456µ Unit');
|
||||
});
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ describe('formatNumber', (): void => {
|
||||
|
||||
it('formats BigInt numbers', (): void => {
|
||||
expect(
|
||||
formatNumber(123_456_789n)
|
||||
formatNumber(123456789n)
|
||||
).toEqual('123,456,789');
|
||||
});
|
||||
|
||||
|
||||
@@ -53,6 +53,12 @@ describe('hexToBn', (): void => {
|
||||
).toBe(-1234);
|
||||
});
|
||||
|
||||
it('handles negative numbers (LE, 128)', (): void => {
|
||||
expect(
|
||||
hexToBn('0x00009c584c491ff2ffffffffffffffff', { isLe: true, isNegative: true }).toString()
|
||||
).toEqual('-1000000000000000000');
|
||||
});
|
||||
|
||||
it('handles starting zeros correctly (BE)', (): void => {
|
||||
expect(
|
||||
hexToBn('0x0000000000000100', { isLe: false }).toNumber()
|
||||
|
||||
@@ -23,7 +23,7 @@ import hexStripPrefix from './stripPrefix';
|
||||
*/
|
||||
export default function hexToU8a (_value?: string | null, bitLength = -1): Uint8Array {
|
||||
if (!_value) {
|
||||
return new Uint8Array([]);
|
||||
return new Uint8Array();
|
||||
}
|
||||
|
||||
assert(isHex(_value), `Expected hex value to convert, found '${_value}'`);
|
||||
|
||||
@@ -10,6 +10,7 @@ import './polyfill';
|
||||
|
||||
export { default as assert } 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';
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
// Copyright 2017-2020 @polkadot/util authors & contributors
|
||||
// This software may be modified and distributed under the terms
|
||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||
|
||||
import { isAscii } from '.';
|
||||
|
||||
describe('isAscii', (): void => {
|
||||
it('returns true for an ASCII string', (): void => {
|
||||
expect(isAscii('Hello\tWorld!\n\rTesting')).toEqual(true);
|
||||
});
|
||||
|
||||
it('returns true for ASCII bytes', (): void => {
|
||||
expect(isAscii(new Uint8Array([0x31, 0x32, 0x20, 10]))).toEqual(true);
|
||||
});
|
||||
|
||||
it('returns true for empty string inputs', (): void => {
|
||||
expect(isAscii('')).toEqual(true);
|
||||
});
|
||||
|
||||
it('returns true for empty U8a inputs', (): void => {
|
||||
expect(isAscii(new Uint8Array())).toEqual(true);
|
||||
});
|
||||
|
||||
it('returns false for empty undefined inputs', (): void => {
|
||||
expect(isAscii()).toEqual(false);
|
||||
});
|
||||
|
||||
it('returns false for non-printable characters', (): void => {
|
||||
expect(isAscii(new Uint8Array([5]))).toEqual(false);
|
||||
});
|
||||
});
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user