Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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 | ||
|
|
c2b91ad8c2 | ||
|
|
ffc6b0323b | ||
|
|
b666db2721 | ||
|
|
b00d49564f | ||
|
|
34380caf1f | ||
|
|
277cc2b5a8 | ||
|
|
733e9e2729 | ||
|
|
482264c615 | ||
|
|
5d0abef952 | ||
|
|
2397e1c5d7 | ||
|
|
62ebe257a6 | ||
|
|
a2844a449c | ||
|
|
60a9866abe |
+1
-1
@@ -1,2 +1,2 @@
|
|||||||
5
|
5
|
||||||
2.6.2
|
2.6.22.12.2
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
.eslintrc.js
|
||||||
**/build/*
|
**/build/*
|
||||||
**/coverage/*
|
**/coverage/*
|
||||||
**/node_modules/*
|
**/node_modules/*
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ jobs:
|
|||||||
matrix:
|
matrix:
|
||||||
step: ['build:release', 'docs:release']
|
step: ['build:release', 'docs:release']
|
||||||
name: ${{ matrix.step }}
|
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
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v1
|
||||||
@@ -21,16 +21,13 @@ jobs:
|
|||||||
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
|
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
|
||||||
GH_PAGES_SRC: build-docs
|
GH_PAGES_SRC: build-docs
|
||||||
GH_PAT: ${{ secrets.GH_PAT }}
|
GH_PAT: ${{ secrets.GH_PAT }}
|
||||||
GH_TOKEN: ${{ secrets.GH_PAT }}
|
GH_RELEASE_GITHUB_API_TOKEN: ${{ secrets.GH_PAT }}
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
yarn install --immutable | grep -v 'YN0013'
|
yarn install --immutable | grep -v 'YN0013'
|
||||||
yarn ${{ matrix.step }}
|
yarn ${{ matrix.step }}
|
||||||
|
|
||||||
dummy:
|
dummy:
|
||||||
name: Dummy
|
|
||||||
if: "contains(github.event.head_commit.message, '[CI Skip]')"
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: dummy
|
- name: dummy
|
||||||
|
|||||||
Vendored
+14
-8
File diff suppressed because one or more lines are too long
+131
-66
@@ -1,15 +1,80 @@
|
|||||||
# 2.8.1 Apr 9, 2020
|
# CHANGELOG
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
- Keypair will now throw an error when attempting to sign/derive using a locked pair (Thanks to https://github.com/h4x3rotab)
|
- 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`
|
- 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
|
- Add `bnSqrt` to calculate the integer sqrt via Newton iteration
|
||||||
- Allow for optional wasm-crypto, specifically via `@polkadot/util-crypto/noWasm`
|
- Allow for optional wasm-crypto, specifically via `@polkadot/util-crypto/noWasm`
|
||||||
- Misc. CI infrastructure cleanups
|
- 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
|
- **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.
|
- Add `signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string): VerifyResult` to verify any signature, regardless of type. Returns validity & detected crypto type.
|
||||||
@@ -17,14 +82,14 @@
|
|||||||
- Add `addressCheckChecksum (decoded: Uint8Array)` as an helper to extract and verify the ss58 checksum
|
- Add `addressCheckChecksum (decoded: Uint8Array)` as an helper to extract and verify the ss58 checksum
|
||||||
- Swap to yarn 2, allow use in yarn 2 projects
|
- 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
|
- **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 `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
|
- 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
|
- (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
|
- 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`
|
- Adjust `formatBalance(<balance>, <options>)` to take expanded `withUnit: string | boolean` option where string is an actual unit, e.g. `KSM`
|
||||||
@@ -32,22 +97,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 `.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)
|
- 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)
|
- 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)
|
- Move TypeScript `@types/*` to dev deps (Thanks to https://github.com/AndreasGassmann)
|
||||||
- Update to `@polkadot/wasm-crypto` 1.0
|
- Update to `@polkadot/wasm-crypto` 1.0
|
||||||
- Cleanup dependencies to pave the way for using yarn 2 (Explicit instead of implicit)
|
- 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)
|
- 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
|
- 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)
|
- Update w3f/schnorrkel to 0.8.5 (Full Substrate 2.x support, no 1.x support)
|
||||||
- Remove Alice session (ed2551) account from testing keyring (not applicable to Substrate 2.x)
|
- Remove Alice session (ed2551) account from testing keyring (not applicable to Substrate 2.x)
|
||||||
@@ -55,27 +120,27 @@
|
|||||||
- Renamed `assertSingletonPackage` to `detectPackage` with inclusion of version listing
|
- Renamed `assertSingletonPackage` to `detectPackage` with inclusion of version listing
|
||||||
- Swap to elliptic library for secp2561 recovery (No node bindings)
|
- 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)
|
- 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
|
- `formatBalance` signature now allows to force unit displays
|
||||||
- Keypair now allows for derive on a pair, with `pair.derive(...)`
|
- 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
|
- `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.
|
- `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
|
- Fix typings on the Keyring-exposed encode & decodeAddress
|
||||||
- Allow ss58Format = 0 as a valid value
|
- Allow ss58Format = 0 as a valid value
|
||||||
- Loosen type definitions for allowed ss58format values (still checked against allowed array)
|
- 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`
|
- **Breaking change** To set the `ss58Format`, you should now use `setSS58Format` as opposed to the old `setAddressPrefix`
|
||||||
- Renamed `keyring.setAddressPrefix` to `keyring.setSS58Format`
|
- Renamed `keyring.setAddressPrefix` to `keyring.setSS58Format`
|
||||||
@@ -83,25 +148,25 @@
|
|||||||
- Added `stringToHex` and `hexToString` conversion utilities to `@polkadot/util`
|
- 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
|
- 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`
|
- 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
|
- Keyring `addFromAddress` can now be used to store external accounts, for example those provided by external signers
|
||||||
- Maintainability updates
|
- 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.
|
- `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
|
- `formatBalance` now allows for `Compact` inputs
|
||||||
- `formaBalance` now allows correct formatting of very large decimals
|
- `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 `checkAddress(address, prefix)` to `@polkadot/util-crypto` that validates an ss-58 address
|
||||||
- Add support for the Kusama network (as a valid checked prefix)
|
- Add support for the Kusama network (as a valid checked prefix)
|
||||||
@@ -109,7 +174,7 @@
|
|||||||
- The ed25519 key for Alice (representing the session), now appears in the test keyrings
|
- 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)
|
- 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
|
- Breaking: External pair interface for keyring has been changed. Instead of
|
||||||
- `getMeta` use the `meta` getter, i.e. `console.log(pair.meta.name)`
|
- `getMeta` use the `meta` getter, i.e. `console.log(pair.meta.name)`
|
||||||
@@ -117,133 +182,133 @@
|
|||||||
- `publicKey` use the `publicKey` getter, i.e. `console.log(pair.publicKey)`
|
- `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
|
- `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`
|
- Only allow integer input values into `formatBalance`
|
||||||
- Allow `formatBalance`, `formatDecimal` & `formatNumber` to cater for negative numbers
|
- Allow `formatBalance`, `formatDecimal` & `formatNumber` to cater for negative numbers
|
||||||
- Add 'Bob//stash' to testing keyring, joining the existing 'Alice//stash'
|
- 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
|
- 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
|
- 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
|
- Moving towards 1.0
|
||||||
- Added bnMin & bnMax functions
|
- Added bnMin & bnMax functions
|
||||||
|
|
||||||
# 0.76.1 Apr 03, 2019
|
### 0.76.1 Apr 03, 2019
|
||||||
|
|
||||||
- Fix `addFromMnemonic` to generate using new-style derivation.
|
- 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`
|
- 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 out `wasm-schnorrkel` & `wasm-ed25519` for combined version with `wasm-crypto`
|
||||||
- Swap DB interfaces to optional LRU, removing `transactionAsync` (client-only changes)
|
- 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
|
- Start journey to 1.0
|
||||||
|
|
||||||
# 0.42.1 Mar 28, 2019
|
### 0.42.1 Mar 28, 2019
|
||||||
|
|
||||||
- Add `assertSingletonPackage` to util
|
- Add `assertSingletonPackage` to util
|
||||||
- Ensure that only a single keyring instance is loaded (uses above)
|
- 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)
|
- 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 additional derivation path extraction mechanisms to util-crypto
|
||||||
- Add createFromUri function to keypair (creates keypair, does not add it)
|
- Add createFromUri function to keypair (creates keypair, does not add it)
|
||||||
- Allow all crypto hashing & ed25519 to use WASM (as available, JS fallbacks)
|
- 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
|
- 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
|
- Align with current substrate master for sr25519 keys and hard/soft derivation
|
||||||
- Swap default dev keys to derived (sr25519)
|
- 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)
|
- 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.
|
- 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)
|
- 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' })`
|
- 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
|
||||||
|
|||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# Generate a Multisig Account
|
||||||
|
|
||||||
|
Substrate provides a multisig dispatch function in its
|
||||||
|
[Utility pallet](https://crates.parity.io/pallet_utility/index.html). This example generates the
|
||||||
|
address that would correspond to a set of addresses and threshold.
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
/* eslint-disable header/header */
|
||||||
|
import { createKeyMulti, encodeAddress, sortAddresses } from '@polkadot/util-crypto';
|
||||||
|
|
||||||
|
const SS58Prefix = 0;
|
||||||
|
|
||||||
|
// Input the addresses that will make up the multisig account.
|
||||||
|
const addresses = [
|
||||||
|
'1nUC7afqmo7zwRFWxDjrUQu9skk6fk99pafb4SiyGSRc8z3',
|
||||||
|
'1ZX2XntfLEHrBPy73DpfQp9rG7pbLyvrFjEpi7mNKQgyga5',
|
||||||
|
'14b1kB7CrqzRUeMsKc26FJ73f8FCpxAX6sNieu9gfYSfJuoL'
|
||||||
|
];
|
||||||
|
|
||||||
|
// The number of accounts that must approve. Must be greater than 0 and less than
|
||||||
|
// or equal to the total number of addresses.
|
||||||
|
const threshold = 2;
|
||||||
|
|
||||||
|
// The address (as index in `addresses`) that will submit a transaction.
|
||||||
|
const index = 0;
|
||||||
|
|
||||||
|
function main () {
|
||||||
|
// Address as a byte array.
|
||||||
|
const multiAddress = createKeyMulti(addresses, threshold);
|
||||||
|
|
||||||
|
// Convert byte array to SS58 encoding.
|
||||||
|
const Ss58Address = encodeAddress(multiAddress, SS58Prefix);
|
||||||
|
|
||||||
|
console.log(`\nMultisig Address: ${Ss58Address}`);
|
||||||
|
|
||||||
|
// Take addresses and remove the sender.
|
||||||
|
const otherSignatories = addresses.filter((who) => who !== addresses[index]);
|
||||||
|
|
||||||
|
// Sort them by public key.
|
||||||
|
const otherSignatoriesSorted = sortAddresses(otherSignatories, SS58Prefix);
|
||||||
|
|
||||||
|
console.log(`\nOther Signatories: ${otherSignatoriesSorted}\n`);
|
||||||
|
|
||||||
|
process.exit();
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"name": "04_generate_multisig_address",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Example showing how to generate a multisig address for Substrate's Utility pallet",
|
||||||
|
"main": "index.js",
|
||||||
|
"author": "joepetrowski",
|
||||||
|
"license": "MIT",
|
||||||
|
"scripts": {
|
||||||
|
"start": "node index.js"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@polkadot/util-crypto": "^2.9.0-beta.1"
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-1
@@ -9,5 +9,5 @@
|
|||||||
"packages": [
|
"packages": [
|
||||||
"packages/*"
|
"packages/*"
|
||||||
],
|
],
|
||||||
"version": "2.8.1"
|
"version": "2.18.1"
|
||||||
}
|
}
|
||||||
|
|||||||
+7
-6
@@ -7,7 +7,7 @@
|
|||||||
"packages/*"
|
"packages/*"
|
||||||
],
|
],
|
||||||
"resolutions": {
|
"resolutions": {
|
||||||
"typescript": "^3.8.3"
|
"babel-core": "^7.0.0-bridge.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "polkadot-dev-build-ts",
|
"build": "polkadot-dev-build-ts",
|
||||||
@@ -21,9 +21,10 @@
|
|||||||
"test:one": "polkadot-dev-run-test"
|
"test:one": "polkadot-dev-run-test"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@babel/core": "^7.9.0",
|
"@babel/core": "^7.10.4",
|
||||||
"@polkadot/dev": "^0.52.8",
|
"@polkadot/dev": "^0.55.21",
|
||||||
"@polkadot/ts": "^0.3.18",
|
"@polkadot/ts": "^0.3.27",
|
||||||
"@types/jest": "^25.2.1"
|
"@types/jest": "^26.0.4"
|
||||||
}
|
},
|
||||||
|
"version": "2.18.1"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@polkadot/keyring",
|
"name": "@polkadot/keyring",
|
||||||
"version": "2.8.1",
|
"version": "2.18.1",
|
||||||
"description": "Keyring management",
|
"description": "Keyring management",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
@@ -27,8 +27,8 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme",
|
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/runtime": "^7.9.2",
|
"@babel/runtime": "^7.10.4",
|
||||||
"@polkadot/util": "2.8.1",
|
"@polkadot/util": "2.18.1",
|
||||||
"@polkadot/util-crypto": "2.8.1"
|
"@polkadot/util-crypto": "2.18.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -147,4 +147,89 @@ describe('keypair', (): void => {
|
|||||||
expect(pair.verify(MESSAGE, signature)).toBe(true);
|
expect(pair.verify(MESSAGE, signature)).toBe(true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('ecdsa', (): void => {
|
||||||
|
const seedOne = 'potato act energy ahead stone taxi receive fame gossip equip chest round';
|
||||||
|
const seedTwo = hexToU8a('0x3c74be003bd9a876be439949ccf2b292bd966c94959a689173b295b326cd6da7');
|
||||||
|
const publicKeyOne = hexToU8a('0x02c6b6c664db5ef505477bba1cf2f1789c98796b9bb5fa21abd0ac4589bed980e7');
|
||||||
|
const publicKeyTwo = hexToU8a('0x021da683b913fb28c979ba3e5f1881415cef4b1f58a5d05ed3610a2995e7b4943c');
|
||||||
|
const addressKeyOne = hexToU8a('0x0cfd0dd2c59a9987b9848919163931b6a42283ffd3d91e92c98b522525a7038f');
|
||||||
|
let keyring: Keyring;
|
||||||
|
|
||||||
|
beforeEach((): void => {
|
||||||
|
keyring = new Keyring({ ss58Format: 42, type: 'ecdsa' });
|
||||||
|
|
||||||
|
keyring.addFromMnemonic(seedOne, {});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('creates with dev phrase when only path specified', (): void => {
|
||||||
|
expect(
|
||||||
|
keyring.createFromUri('//Alice').address
|
||||||
|
).toEqual('5C7C2Z5sWbytvHpuLTvzKunnnRwQxft1jiqrLD5rhucQ5S9X');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('adds the pair', (): void => {
|
||||||
|
expect(
|
||||||
|
keyring.addFromSeed(seedTwo, {}).publicKey
|
||||||
|
).toEqual(publicKeyTwo);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('adds from a mnemonic', (): void => {
|
||||||
|
keyring.setSS58Format(68);
|
||||||
|
|
||||||
|
expect(
|
||||||
|
keyring.addFromMnemonic('moral movie very draw assault whisper awful rebuild speed purity repeat card').address
|
||||||
|
).toEqual('7ooxHV3mz4nnWbK8v7Mxcb71QMpof268eL1A2VrYWUNWJk8P');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('allows publicKeys retrieval', (): void => {
|
||||||
|
keyring.addFromSeed(seedTwo, {});
|
||||||
|
|
||||||
|
expect(
|
||||||
|
keyring.getPublicKeys()
|
||||||
|
).toEqual([publicKeyOne, publicKeyTwo]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('allows retrieval of a specific item', (): void => {
|
||||||
|
expect(
|
||||||
|
keyring.getPair(addressKeyOne).publicKey
|
||||||
|
).toEqual(publicKeyOne);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('allows adding from JSON', (): void => {
|
||||||
|
expect(
|
||||||
|
keyring.addFromJson(
|
||||||
|
JSON.parse('{"address":"5DzMsaYFhmpRdErWrP6K6PD7UXzYoeETToSBUrZSvxasqWRz","encoded":"0xa192d39b42bc1601bf61df31039a554228593fadf870bc837b658a5114627aca199fff596260c95fe8994c66a47636cf0270aa08f402ba5541038753960d00e6c3af5e239ec58fb1eef3db7d6bc266f4853bdfe4ed17122d9092d879014d53980d2ee57f6f55a88c38836447d8645008e8815379626addc8f81f80cd49a2","encoding":{"content":"pkcs8","type":"xsalsa20-poly1305","version":"2"},"meta":{}}')
|
||||||
|
).address
|
||||||
|
).toEqual('5DzMsaYFhmpRdErWrP6K6PD7UXzYoeETToSBUrZSvxasqWRz');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('signs and verifies', (): void => {
|
||||||
|
const MESSAGE = stringToU8a('this is a message');
|
||||||
|
const pair = keyring.getPair(addressKeyOne);
|
||||||
|
const signature = pair.sign(MESSAGE);
|
||||||
|
|
||||||
|
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');
|
||||||
|
});
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2,11 +2,11 @@
|
|||||||
// This software may be modified and distributed under the terms
|
// This software may be modified and distributed under the terms
|
||||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||||
|
|
||||||
import { KeypairType } from '@polkadot/util-crypto/types';
|
import { KeypairType, Keypair } from '@polkadot/util-crypto/types';
|
||||||
import { KeyringInstance, KeyringPair, KeyringPair$Json, KeyringPair$Meta, KeyringOptions } from './types';
|
import { KeyringInstance, KeyringPair, KeyringPair$Json, KeyringPair$Meta, KeyringOptions } from './types';
|
||||||
|
|
||||||
import { assert, hexToU8a, isHex, stringToU8a } from '@polkadot/util';
|
import { assert, hexToU8a, isHex, isUndefined, stringToU8a } from '@polkadot/util';
|
||||||
import { decodeAddress, encodeAddress, keyExtractSuri, keyFromPath, naclKeypairFromSeed as naclFromSeed, schnorrkelKeypairFromSeed as schnorrkelFromSeed, mnemonicToMiniSecret } from '@polkadot/util-crypto';
|
import { decodeAddress, encodeAddress, keyExtractSuri, keyFromPath, naclKeypairFromSeed as naclFromSeed, schnorrkelKeypairFromSeed as schnorrkelFromSeed, secp256k1KeypairFromSeed as secp256k1FromSeed, mnemonicToMiniSecret } from '@polkadot/util-crypto';
|
||||||
|
|
||||||
import { DEV_PHRASE } from './defaults';
|
import { DEV_PHRASE } from './defaults';
|
||||||
import createPair from './pair';
|
import createPair from './pair';
|
||||||
@@ -40,7 +40,7 @@ export default class Keyring implements KeyringInstance {
|
|||||||
constructor (options: KeyringOptions = {}) {
|
constructor (options: KeyringOptions = {}) {
|
||||||
options.type = options.type || 'ed25519';
|
options.type = options.type || 'ed25519';
|
||||||
|
|
||||||
assert(options && ['ed25519', 'sr25519'].includes(options.type || 'undefined'), `Expected a keyring type of either 'ed25519' or 'sr25519', found '${options.type}`);
|
assert(options && ['ecdsa', 'ed25519', 'sr25519'].includes(options.type || 'undefined'), `Expected a keyring type of either 'ed25519', 'sr25519' or 'ecdsa', found '${options.type}`);
|
||||||
|
|
||||||
this.#pairs = new Pairs();
|
this.#pairs = new Pairs();
|
||||||
this.#ss58 = options.ss58Format;
|
this.#ss58 = options.ss58Format;
|
||||||
@@ -62,7 +62,7 @@ export default class Keyring implements KeyringInstance {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @description Returns the type of the keyring, either ed25519 of sr25519
|
* @description Returns the type of the keyring, ed25519, sr25519 or ecdsa
|
||||||
*/
|
*/
|
||||||
public get type (): KeypairType {
|
public get type (): KeypairType {
|
||||||
return this.#type;
|
return this.#type;
|
||||||
@@ -87,7 +87,7 @@ export default class Keyring implements KeyringInstance {
|
|||||||
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): KeyringPair {
|
||||||
const publicKey = this.decodeAddress(address, ignoreChecksum);
|
const publicKey = this.decodeAddress(address, ignoreChecksum);
|
||||||
|
|
||||||
return this.addPair(createPair({ toSS58: this.encodeAddress, type }, { publicKey, secretKey: new Uint8Array(64) }, meta, encoded));
|
return this.addPair(createPair({ toSS58: this.encodeAddress, type }, { publicKey, secretKey: new Uint8Array() }, meta, encoded));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -125,9 +125,11 @@ export default class Keyring implements KeyringInstance {
|
|||||||
* `addPair` to store in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
|
* `addPair` to store in a keyring pair dictionary the public key of the generated pair as a key and the pair as the associated value.
|
||||||
*/
|
*/
|
||||||
public addFromSeed (seed: Uint8Array, meta: KeyringPair$Meta = {}, type: KeypairType = this.type): KeyringPair {
|
public addFromSeed (seed: Uint8Array, meta: KeyringPair$Meta = {}, type: KeypairType = this.type): KeyringPair {
|
||||||
const keypair = type === 'sr25519'
|
const keypair = {
|
||||||
? schnorrkelFromSeed(seed)
|
ecdsa: (): Keypair => secp256k1FromSeed(seed),
|
||||||
: naclFromSeed(seed);
|
ed25519: (): Keypair => naclFromSeed(seed),
|
||||||
|
sr25519: (): Keypair => schnorrkelFromSeed(seed)
|
||||||
|
}[type]();
|
||||||
|
|
||||||
return this.addPair(createPair({ toSS58: this.encodeAddress, type }, keypair, meta, null));
|
return this.addPair(createPair({ toSS58: this.encodeAddress, type }, keypair, meta, null));
|
||||||
}
|
}
|
||||||
@@ -154,7 +156,7 @@ export default class Keyring implements KeyringInstance {
|
|||||||
? `${DEV_PHRASE}${_suri}`
|
? `${DEV_PHRASE}${_suri}`
|
||||||
: _suri;
|
: _suri;
|
||||||
const { password, path, phrase } = keyExtractSuri(suri);
|
const { password, path, phrase } = keyExtractSuri(suri);
|
||||||
let seed;
|
let seed: Uint8Array;
|
||||||
|
|
||||||
if (isHex(phrase, 256)) {
|
if (isHex(phrase, 256)) {
|
||||||
seed = hexToU8a(phrase);
|
seed = hexToU8a(phrase);
|
||||||
@@ -175,10 +177,12 @@ export default class Keyring implements KeyringInstance {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const keypair = type === 'sr25519'
|
const keypair = {
|
||||||
? schnorrkelFromSeed(seed)
|
ecdsa: (): Keypair => secp256k1FromSeed(seed),
|
||||||
: naclFromSeed(seed);
|
ed25519: (): Keypair => naclFromSeed(seed),
|
||||||
const derived = keyFromPath(keypair, path, type);
|
sr25519: (): Keypair => schnorrkelFromSeed(seed)
|
||||||
|
};
|
||||||
|
const derived = keyFromPath(keypair[type](), path, type);
|
||||||
|
|
||||||
return createPair({ toSS58: this.encodeAddress, type }, derived, meta, null);
|
return createPair({ toSS58: this.encodeAddress, type }, derived, meta, null);
|
||||||
}
|
}
|
||||||
@@ -187,8 +191,8 @@ export default class Keyring implements KeyringInstance {
|
|||||||
* @name encodeAddress
|
* @name encodeAddress
|
||||||
* @description Encodes the input into an ss58 representation
|
* @description Encodes the input into an ss58 representation
|
||||||
*/
|
*/
|
||||||
public encodeAddress = (key: Uint8Array | string, ss58Format?: number): string => {
|
public encodeAddress = (address: Uint8Array | string, ss58Format?: number): string => {
|
||||||
return encodeAddress(key, ss58Format || this.#ss58);
|
return encodeAddress(address, isUndefined(ss58Format) ? this.#ss58 : ss58Format);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { KeyringPair, KeyringPair$Json, KeyringPair$Meta, SignOptions } from '..
|
|||||||
import { PairInfo } from './types';
|
import { PairInfo } from './types';
|
||||||
|
|
||||||
import { assert, u8aConcat } from '@polkadot/util';
|
import { assert, u8aConcat } from '@polkadot/util';
|
||||||
import { keyExtractPath, keyFromPath, naclKeypairFromSeed as naclFromSeed, naclSign, naclVerify, schnorrkelKeypairFromSeed as schnorrkelFromSeed, schnorrkelSign, schnorrkelVerify } from '@polkadot/util-crypto';
|
import { keyExtractPath, keyFromPath, naclKeypairFromSeed as naclFromSeed, naclSign, naclVerify, schnorrkelKeypairFromSeed as schnorrkelFromSeed, schnorrkelSign, schnorrkelVerify, secp256k1KeypairFromSeed as secp256k1FromSeed, secp256k1Sign, secp256k1Verify, blake2AsU8a } from '@polkadot/util-crypto';
|
||||||
|
|
||||||
import decode from './decode';
|
import decode from './decode';
|
||||||
import encode from './encode';
|
import encode from './encode';
|
||||||
@@ -21,45 +21,59 @@ interface Setup {
|
|||||||
const SIG_TYPE_NONE = new Uint8Array();
|
const SIG_TYPE_NONE = new Uint8Array();
|
||||||
const SIG_TYPE_ED25519 = new Uint8Array([0]);
|
const SIG_TYPE_ED25519 = new Uint8Array([0]);
|
||||||
const SIG_TYPE_SR25519 = new Uint8Array([1]);
|
const SIG_TYPE_SR25519 = new Uint8Array([1]);
|
||||||
// const SIG_TYPE_ECDSA = new Uint8Array([2]);
|
const SIG_TYPE_ECDSA = new Uint8Array([2]);
|
||||||
|
|
||||||
function isEmpty (u8a: Uint8Array): boolean {
|
function isEmpty (u8a: Uint8Array): boolean {
|
||||||
return u8a.reduce((count, u8): number => count + u8, 0) === 0;
|
return u8a.reduce((count, u8): number => count + u8, 0) === 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
function isSr25519 (type: KeypairType): boolean {
|
|
||||||
return type === 'sr25519';
|
|
||||||
}
|
|
||||||
|
|
||||||
function fromSeed (type: KeypairType, seed: Uint8Array): Keypair {
|
function fromSeed (type: KeypairType, seed: Uint8Array): Keypair {
|
||||||
return isSr25519(type)
|
return {
|
||||||
? schnorrkelFromSeed(seed)
|
ecdsa: (): Keypair => secp256k1FromSeed(seed),
|
||||||
: naclFromSeed(seed);
|
ed25519: (): Keypair => naclFromSeed(seed),
|
||||||
|
sr25519: (): Keypair => schnorrkelFromSeed(seed)
|
||||||
|
}[type]();
|
||||||
}
|
}
|
||||||
|
|
||||||
function multiSignaturePrefix (type: KeypairType): Uint8Array {
|
function multiSignaturePrefix (type: KeypairType): Uint8Array {
|
||||||
return isSr25519(type)
|
return {
|
||||||
? SIG_TYPE_SR25519
|
ecdsa: SIG_TYPE_ECDSA,
|
||||||
: SIG_TYPE_ED25519;
|
ed25519: SIG_TYPE_ED25519,
|
||||||
|
sr25519: SIG_TYPE_SR25519
|
||||||
|
}[type];
|
||||||
}
|
}
|
||||||
|
|
||||||
function sign (type: KeypairType, message: Uint8Array, pair: Partial<Keypair>, { withType = false }: SignOptions = {}): Uint8Array {
|
function sign (type: KeypairType, message: Uint8Array, pair: Partial<Keypair>, { withType = false }: SignOptions = {}): Uint8Array {
|
||||||
|
const signature = {
|
||||||
|
ecdsa: (): Uint8Array => secp256k1Sign(message, pair),
|
||||||
|
ed25519: (): Uint8Array => naclSign(message, pair),
|
||||||
|
sr25519: (): Uint8Array => schnorrkelSign(message, pair)
|
||||||
|
}[type]();
|
||||||
|
|
||||||
return u8aConcat(
|
return u8aConcat(
|
||||||
// for multi-signatures, i.e. with indicator, append the signature type as per
|
// for multi-signatures, i.e. with indicator, append the signature type as per
|
||||||
// the MultiSignature enum
|
// the MultiSignature enum
|
||||||
withType
|
withType
|
||||||
? multiSignaturePrefix(type)
|
? multiSignaturePrefix(type)
|
||||||
: SIG_TYPE_NONE,
|
: SIG_TYPE_NONE,
|
||||||
isSr25519(type)
|
signature
|
||||||
? schnorrkelSign(message, pair)
|
|
||||||
: naclSign(message, pair)
|
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
function verify (type: KeypairType, message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean {
|
function verify (type: KeypairType, message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean {
|
||||||
return isSr25519(type)
|
return {
|
||||||
? schnorrkelVerify(message, signature, publicKey)
|
ecdsa: (): boolean => secp256k1Verify(message, signature, blake2AsU8a(publicKey, 256)),
|
||||||
: naclVerify(message, signature, publicKey);
|
ed25519: (): boolean => naclVerify(message, signature, publicKey),
|
||||||
|
sr25519: (): boolean => schnorrkelVerify(message, signature, publicKey)
|
||||||
|
}[type]();
|
||||||
|
}
|
||||||
|
|
||||||
|
function getAddress (type: KeypairType, publicKey: Uint8Array): Uint8Array {
|
||||||
|
if (type === 'ecdsa' && publicKey.length > 32) {
|
||||||
|
return blake2AsU8a(publicKey, 256);
|
||||||
|
} else {
|
||||||
|
return publicKey;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Not 100% correct, since it can be a Uint8Array, but an invalid one - just say "undefined" is anything non-valid
|
// Not 100% correct, since it can be a Uint8Array, but an invalid one - just say "undefined" is anything non-valid
|
||||||
@@ -101,7 +115,7 @@ function isLocked (secretKey?: Uint8Array): secretKey is undefined {
|
|||||||
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): KeyringPair {
|
||||||
return {
|
return {
|
||||||
get address (): string {
|
get address (): string {
|
||||||
return toSS58(publicKey);
|
return toSS58(getAddress(type, publicKey));
|
||||||
},
|
},
|
||||||
get isLocked (): boolean {
|
get isLocked (): boolean {
|
||||||
return isLocked(secretKey);
|
return isLocked(secretKey);
|
||||||
@@ -151,7 +165,7 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
|
|||||||
return sign(type, message, { publicKey, secretKey }, options);
|
return sign(type, message, { publicKey, secretKey }, options);
|
||||||
},
|
},
|
||||||
toJson: (passphrase?: string): KeyringPair$Json =>
|
toJson: (passphrase?: string): KeyringPair$Json =>
|
||||||
toJson(type, { meta, publicKey }, encode({ publicKey, secretKey }, passphrase), !!passphrase),
|
toJson(type, { address: toSS58(getAddress(type, publicKey)), meta }, encode({ publicKey, secretKey }, passphrase), !!passphrase),
|
||||||
verify: (message: Uint8Array, signature: Uint8Array): boolean =>
|
verify: (message: Uint8Array, signature: Uint8Array): boolean =>
|
||||||
verify(type, message, signature, publicKey)
|
verify(type, message, signature, publicKey)
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -6,15 +6,15 @@ import { KeypairType } from '@polkadot/util-crypto/types';
|
|||||||
import { KeyringPair$Json, KeyringPair$Meta } from '../types';
|
import { KeyringPair$Json, KeyringPair$Meta } from '../types';
|
||||||
|
|
||||||
import { u8aToHex } from '@polkadot/util';
|
import { u8aToHex } from '@polkadot/util';
|
||||||
import { encodeAddress } from '@polkadot/util-crypto';
|
|
||||||
|
|
||||||
type PairStateJson = KeyringPair$Meta & {
|
interface PairStateJson {
|
||||||
publicKey: Uint8Array;
|
address: string;
|
||||||
};
|
meta: KeyringPair$Meta;
|
||||||
|
}
|
||||||
|
|
||||||
export default function toJson (type: KeypairType, { meta, publicKey }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
|
export default function toJson (type: KeypairType, { address, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
|
||||||
return {
|
return {
|
||||||
address: encodeAddress(publicKey),
|
address,
|
||||||
encoded: u8aToHex(encoded),
|
encoded: u8aToHex(encoded),
|
||||||
encoding: {
|
encoding: {
|
||||||
content: ['pkcs8', type],
|
content: ['pkcs8', type],
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ export default class Pairs implements KeyringPairs {
|
|||||||
readonly #map: KeyringPairMap = {};
|
readonly #map: KeyringPairMap = {};
|
||||||
|
|
||||||
public add (pair: KeyringPair): KeyringPair {
|
public add (pair: KeyringPair): KeyringPair {
|
||||||
this.#map[pair.publicKey.toString()] = pair;
|
this.#map[decodeAddress(pair.address).toString()] = pair;
|
||||||
|
|
||||||
return pair;
|
return pair;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,10 +10,7 @@ export interface KeyringOptions {
|
|||||||
type?: KeypairType;
|
type?: KeypairType;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface KeyringPair$Meta {
|
export type KeyringPair$Meta = Record<string, unknown>;
|
||||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
||||||
[index: string]: any;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type KeyringPair$JsonVersion = '0' | '1' | '2';
|
export type KeyringPair$JsonVersion = '0' | '1' | '2';
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@polkadot/util-crypto",
|
"name": "@polkadot/util-crypto",
|
||||||
"version": "2.8.1",
|
"version": "2.18.1",
|
||||||
"description": "A collection of useful crypto utilities for @polkadot",
|
"description": "A collection of useful crypto utilities for @polkadot",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
@@ -25,25 +25,23 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme",
|
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/runtime": "^7.9.2",
|
"@babel/runtime": "^7.10.4",
|
||||||
"@polkadot/util": "2.8.1",
|
"@polkadot/util": "2.18.1",
|
||||||
"@polkadot/wasm-crypto": "^1.2.1",
|
"@polkadot/wasm-crypto": "^1.2.1",
|
||||||
"base-x": "^3.0.8",
|
"base-x": "^3.0.8",
|
||||||
"bip39": "^3.0.2",
|
"bip39": "^3.0.2",
|
||||||
"blakejs": "^1.1.0",
|
"blakejs": "^1.1.0",
|
||||||
"bn.js": "^5.1.1",
|
"bn.js": "^5.1.2",
|
||||||
"bs58": "^4.0.1",
|
"elliptic": "^6.5.3",
|
||||||
"elliptic": "^6.5.2",
|
|
||||||
"js-sha3": "^0.8.0",
|
"js-sha3": "^0.8.0",
|
||||||
"pbkdf2": "^3.0.17",
|
"pbkdf2": "^3.1.1",
|
||||||
"tweetnacl": "^1.0.3",
|
"tweetnacl": "^1.0.3",
|
||||||
"xxhashjs": "^0.2.2"
|
"xxhashjs": "^0.2.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/bn.js": "^4.11.6",
|
"@types/bn.js": "^4.11.6",
|
||||||
"@types/bs58": "^4.0.1",
|
|
||||||
"@types/elliptic": "^6.4.12",
|
"@types/elliptic": "^6.4.12",
|
||||||
"@types/pbkdf2": "^3.0.0",
|
"@types/pbkdf2": "^3.0.0",
|
||||||
"@types/xxhashjs": "^0.2.1"
|
"@types/xxhashjs": "^0.2.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,6 +17,12 @@ describe('checkAddress', (): void => {
|
|||||||
).toEqual([true, null]);
|
).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 => {
|
it('fails with invalid prefix when checking Substrate against Kusama prefix', (): void => {
|
||||||
expect(
|
expect(
|
||||||
checkAddress('5EnxxUmEbw8DkENKiYuZ1DwQuMoB2UWEQJZZXrTsxoz7SpgG', 2)
|
checkAddress('5EnxxUmEbw8DkENKiYuZ1DwQuMoB2UWEQJZZXrTsxoz7SpgG', 2)
|
||||||
|
|||||||
@@ -4,13 +4,24 @@
|
|||||||
|
|
||||||
import { Prefix } from './types';
|
import { Prefix } from './types';
|
||||||
|
|
||||||
import bs58 from 'bs58';
|
import base58Decode from '../base58/decode';
|
||||||
|
|
||||||
import checkChecksum from './checkChecksum';
|
import checkChecksum from './checkChecksum';
|
||||||
import defaults from './defaults';
|
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] {
|
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) {
|
if (decoded[0] !== prefix) {
|
||||||
return [false, `Prefix mismatch, expected ${prefix}, found ${decoded[0]}`];
|
return [false, `Prefix mismatch, expected ${prefix}, found ${decoded[0]}`];
|
||||||
|
|||||||
@@ -94,4 +94,10 @@ describe('decode', (): void => {
|
|||||||
(): Uint8Array => decode('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDwU')
|
(): Uint8Array => decode('5GoKvZWG5ZPYL1WUovuHW3zJBWBP5eT8CbqjdRY4Q6iMaDwU')
|
||||||
).toThrow(/address checksum/);
|
).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
|
// Original implementation: https://github.com/paritytech/polka-ui/blob/4858c094684769080f5811f32b081dd7780b0880/src/polkadot.js#L6
|
||||||
|
|
||||||
import bs58 from 'bs58';
|
import { assert, isHex, isU8a, u8aToU8a } from '@polkadot/util';
|
||||||
import { assert, bufferToU8a, isHex, isU8a, u8aToU8a } from '@polkadot/util';
|
|
||||||
|
|
||||||
|
import base58Decode from '../base58/decode';
|
||||||
import checkChecksum from './checkChecksum';
|
import checkChecksum from './checkChecksum';
|
||||||
import defaults from './defaults';
|
import defaults from './defaults';
|
||||||
|
|
||||||
@@ -18,12 +18,17 @@ export default function decode (encoded: string | Uint8Array, ignoreChecksum?: b
|
|||||||
return u8aToU8a(encoded);
|
return u8aToU8a(encoded);
|
||||||
}
|
}
|
||||||
|
|
||||||
const decoded = bufferToU8a(bs58.decode(encoded));
|
const wrapError = (message: string) => `Decoding ${encoded as string}: ${message}`;
|
||||||
const error = (message: string): string =>
|
let decoded;
|
||||||
`Decoding ${encoded}: ${message}`;
|
|
||||||
|
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.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
|
// TODO Unless it is an "use everywhere" prefix, throw an error
|
||||||
// if (decoded[0] !== prefix) {
|
// if (decoded[0] !== prefix) {
|
||||||
@@ -32,7 +37,7 @@ export default function decode (encoded: string | Uint8Array, ignoreChecksum?: b
|
|||||||
|
|
||||||
const [isValid, endPos] = checkChecksum(decoded);
|
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);
|
return decoded.slice(1, endPos);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,7 +2,8 @@
|
|||||||
// This software may be modified and distributed under the terms
|
// This software may be modified and distributed under the terms
|
||||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
// 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';
|
import encode from './encode';
|
||||||
|
|
||||||
const keyring = testingPairs({ type: 'ed25519' }, false);
|
const keyring = testingPairs({ type: 'ed25519' }, false);
|
||||||
@@ -20,6 +21,12 @@ describe('encode', (): void => {
|
|||||||
).toEqual('7sL6eNJj5ZGV5cn3hhV2deRUsivXfBfMH76wCALCqWj1EKzv');
|
).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 => {
|
it('fails when non-valid publicKey provided', (): void => {
|
||||||
expect(
|
expect(
|
||||||
(): string => encode(
|
(): string => encode(
|
||||||
|
|||||||
@@ -6,9 +6,9 @@ import { Prefix } from './types';
|
|||||||
|
|
||||||
// Original implementation: https://github.com/paritytech/polka-ui/blob/4858c094684769080f5811f32b081dd7780b0880/src/polkadot.js#L34
|
// Original implementation: https://github.com/paritytech/polka-ui/blob/4858c094684769080f5811f32b081dd7780b0880/src/polkadot.js#L34
|
||||||
|
|
||||||
import bs58 from 'bs58';
|
import { assert, u8aConcat } from '@polkadot/util';
|
||||||
import { assert, u8aConcat, u8aToBuffer } from '@polkadot/util';
|
|
||||||
|
|
||||||
|
import base58Encode from '../base58/encode';
|
||||||
import decode from './decode';
|
import decode from './decode';
|
||||||
import defaults from './defaults';
|
import defaults from './defaults';
|
||||||
import sshash from './sshash';
|
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
|
// decode it, this means we can re-encode an address
|
||||||
const key = decode(_key);
|
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 isPublicKey = key.length === 32;
|
||||||
|
|
||||||
const input = u8aConcat(new Uint8Array([ss58Format]), key);
|
const input = u8aConcat(new Uint8Array([ss58Format]), key);
|
||||||
const hash = sshash(input);
|
const hash = sshash(input);
|
||||||
|
|
||||||
return bs58.encode(
|
return base58Encode(
|
||||||
u8aToBuffer(
|
u8aConcat(input, hash.subarray(0, isPublicKey ? 2 : 1))
|
||||||
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));
|
||||||
|
}
|
||||||
@@ -4,14 +4,26 @@
|
|||||||
|
|
||||||
import checkAddress from './check';
|
import checkAddress from './check';
|
||||||
import checkAddressChecksum from './checkChecksum';
|
import checkAddressChecksum from './checkChecksum';
|
||||||
|
import createKeyMulti from './keyMulti';
|
||||||
|
import createKeyDerived from './keyDerived';
|
||||||
import decodeAddress from './decode';
|
import decodeAddress from './decode';
|
||||||
import encodeAddress from './encode';
|
import encodeAddress from './encode';
|
||||||
|
import encodeDerivedAddress from './encodeDerived';
|
||||||
|
import encodeMultiAddress from './encodeMulti';
|
||||||
|
import addressEq from './eq';
|
||||||
import setSS58Format from './setSS58Format';
|
import setSS58Format from './setSS58Format';
|
||||||
|
import sortAddresses from './sort';
|
||||||
|
|
||||||
export {
|
export {
|
||||||
|
addressEq,
|
||||||
checkAddress,
|
checkAddress,
|
||||||
checkAddressChecksum,
|
checkAddressChecksum,
|
||||||
|
createKeyDerived,
|
||||||
|
createKeyMulti,
|
||||||
decodeAddress,
|
decodeAddress,
|
||||||
encodeAddress,
|
encodeAddress,
|
||||||
setSS58Format
|
encodeDerivedAddress,
|
||||||
|
encodeMultiAddress,
|
||||||
|
setSS58Format,
|
||||||
|
sortAddresses
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
// 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 createKeyDerived from './keyDerived';
|
||||||
|
|
||||||
|
describe('createKeyDerived', (): void => {
|
||||||
|
it('matches sub accounts with Rust', (): void => {
|
||||||
|
expect(
|
||||||
|
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])
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('creates a valid subkey', (): void => {
|
||||||
|
expect(
|
||||||
|
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])
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -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 BN from 'bn.js';
|
||||||
|
import { bnToU8a, stringToU8a, u8aConcat } from '@polkadot/util';
|
||||||
|
|
||||||
|
import blake2AsU8a from '../blake2/asU8a';
|
||||||
|
import decodeAddress from './decode';
|
||||||
|
|
||||||
|
const PREFIX = stringToU8a('modlpy/utilisuba');
|
||||||
|
|
||||||
|
export default function createKeyDerived (who: Uint8Array | string, index: BigInt | BN | number): Uint8Array {
|
||||||
|
return blake2AsU8a(
|
||||||
|
u8aConcat(
|
||||||
|
PREFIX,
|
||||||
|
decodeAddress(who),
|
||||||
|
bnToU8a(index, { bitLength: 16, isLe: true })
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -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 { createKeyMulti } from '.';
|
||||||
|
|
||||||
|
describe('createKeyMulti', (): void => {
|
||||||
|
it('creates a valid multikey (aligning with Rust, needs sorting)', (): void => {
|
||||||
|
expect(
|
||||||
|
createKeyMulti([
|
||||||
|
new Uint8Array([1, 0, 0, 0, 0, 0, 0, 0]),
|
||||||
|
new Uint8Array([3, 0, 0, 0, 0, 0, 0, 0]),
|
||||||
|
new Uint8Array([2, 0, 0, 0, 0, 0, 0, 0])
|
||||||
|
], 2)
|
||||||
|
).toEqual(
|
||||||
|
new Uint8Array([67, 151, 196, 155, 179, 207, 47, 123, 90, 2, 35, 54, 162, 111, 241, 226, 88, 148, 54, 193, 252, 195, 93, 101, 16, 5, 93, 101, 186, 186, 254, 79])
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
// 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 BN from 'bn.js';
|
||||||
|
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(
|
||||||
|
PREFIX,
|
||||||
|
compactToU8a(who.length),
|
||||||
|
...u8aSorted(who.map((who) => decodeAddress(who))),
|
||||||
|
bnToU8a(threshold, { bitLength: 16, isLe: true })
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -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 { sortAddresses } from '.';
|
||||||
|
|
||||||
|
describe('sortAddresses', (): void => {
|
||||||
|
it('sorts addresses by the publicKeys', (): void => {
|
||||||
|
expect(
|
||||||
|
sortAddresses([
|
||||||
|
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
|
||||||
|
'5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
|
||||||
|
'5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y'
|
||||||
|
])
|
||||||
|
).toEqual([
|
||||||
|
'5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty',
|
||||||
|
'5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y',
|
||||||
|
'5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY'
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
// 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 { Prefix } from './types';
|
||||||
|
|
||||||
|
import { u8aSorted } from '@polkadot/util';
|
||||||
|
|
||||||
|
import decodeAddress from './decode';
|
||||||
|
import encodeAddress from './encode';
|
||||||
|
|
||||||
|
export default function sortAddresses (addresses: (Uint8Array | string)[], ss58Format?: Prefix): string[] {
|
||||||
|
return u8aSorted(
|
||||||
|
addresses.map((who) => decodeAddress(who))
|
||||||
|
).map((u8a) => encodeAddress(u8a, ss58Format));
|
||||||
|
}
|
||||||
@@ -7,6 +7,8 @@ export const allowedSS58 = [
|
|||||||
0, 1,
|
0, 1,
|
||||||
// Kusama
|
// Kusama
|
||||||
2, 3,
|
2, 3,
|
||||||
|
// Kulupu
|
||||||
|
16, 17,
|
||||||
// Dothereum
|
// Dothereum
|
||||||
20,
|
20,
|
||||||
// Substrate default
|
// 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')
|
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]
|
* 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);
|
const byteLength = Math.ceil(bitLength / 8);
|
||||||
|
|
||||||
return isReady()
|
return isReady() && !onlyJs
|
||||||
? blake2b(u8aToU8a(data), u8aToU8a(key), byteLength)
|
? blake2b(u8aToU8a(data), u8aToU8a(key), byteLength)
|
||||||
: blakejs.blake2b(data, key, byteLength);
|
: blakejs.blake2b(u8aToU8a(data), key, byteLength);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,6 +10,8 @@ export * from './init';
|
|||||||
|
|
||||||
// all internal exports
|
// all internal exports
|
||||||
export * from './address';
|
export * from './address';
|
||||||
|
export * from './base58';
|
||||||
|
export * from './base64';
|
||||||
export * from './blake2';
|
export * from './blake2';
|
||||||
export * from './keccak';
|
export * from './keccak';
|
||||||
export * from './key';
|
export * from './key';
|
||||||
|
|||||||
@@ -2,8 +2,9 @@
|
|||||||
// This software may be modified and distributed under the terms
|
// This software may be modified and distributed under the terms
|
||||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||||
|
|
||||||
import BN from 'bn.js';
|
import type BN from 'bn.js';
|
||||||
import { bnToHex, compactAddLength, hexToU8a, isBn, isHex, isNumber, isString, stringToU8a } from '@polkadot/util';
|
|
||||||
|
import { bnToHex, compactAddLength, hexToU8a, isBigInt, isBn, isHex, isNumber, isString, stringToU8a } from '@polkadot/util';
|
||||||
|
|
||||||
import blake2AsU8a from '../blake2/asU8a';
|
import blake2AsU8a from '../blake2/asU8a';
|
||||||
|
|
||||||
@@ -21,10 +22,10 @@ export default class DeriveJunction {
|
|||||||
#isHard = false;
|
#isHard = false;
|
||||||
|
|
||||||
public static from (value: string): DeriveJunction {
|
public static from (value: string): DeriveJunction {
|
||||||
|
const result = new DeriveJunction();
|
||||||
const [code, isHard] = value.startsWith('/')
|
const [code, isHard] = value.startsWith('/')
|
||||||
? [value.substr(1), true]
|
? [value.substr(1), true]
|
||||||
: [value, false];
|
: [value, false];
|
||||||
const result = new DeriveJunction();
|
|
||||||
|
|
||||||
result.soft(
|
result.soft(
|
||||||
RE_NUMBER.test(code)
|
RE_NUMBER.test(code)
|
||||||
@@ -49,7 +50,7 @@ export default class DeriveJunction {
|
|||||||
return !this.#isHard;
|
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();
|
return this.soft(value).harden();
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -59,8 +60,8 @@ export default class DeriveJunction {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public soft (value: number | BN | string | Uint8Array): DeriveJunction {
|
public soft (value: number | string | BigInt | BN | Uint8Array): DeriveJunction {
|
||||||
if (isNumber(value) || isBn(value)) {
|
if (isNumber(value) || isBn(value) || isBigInt(value)) {
|
||||||
return this.soft(bnToHex(value, BN_OPTIONS));
|
return this.soft(bnToHex(value, BN_OPTIONS));
|
||||||
} else if (isString(value)) {
|
} else if (isString(value)) {
|
||||||
return isHex(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 {
|
export default function keyExtractPath (derivePath: string): ExtractResult {
|
||||||
const parts = derivePath.match(RE_JUNCTION);
|
const parts = derivePath.match(RE_JUNCTION);
|
||||||
|
|||||||
@@ -7,13 +7,18 @@ import { KeypairType, Keypair } from '../types';
|
|||||||
import DeriveJunction from './DeriveJunction';
|
import DeriveJunction from './DeriveJunction';
|
||||||
import keyHdkdEd15519 from './hdkdEd25519';
|
import keyHdkdEd15519 from './hdkdEd25519';
|
||||||
import keyHdkdSr15519 from './hdkdSr25519';
|
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 {
|
export default function keyFromPath (pair: Keypair, path: DeriveJunction[], type: KeypairType): Keypair {
|
||||||
const isEd25519 = type === 'ed25519';
|
const keyHdkd = generators[type];
|
||||||
|
|
||||||
return path.reduce((pair, junction): Keypair => {
|
return path.reduce((pair, junction): Keypair => {
|
||||||
return isEd25519
|
return keyHdkd(pair, junction);
|
||||||
? keyHdkdEd15519(pair, junction)
|
|
||||||
: keyHdkdSr15519(pair, junction);
|
|
||||||
}, pair);
|
}, pair);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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 { Keypair } from '../types';
|
||||||
|
|
||||||
|
import { assert } from '@polkadot/util';
|
||||||
|
|
||||||
|
import secp256k1DeriveHard from '../secp256k1/deriveHard';
|
||||||
|
import secp256k1KeypairFromSeed from '../secp256k1/keypair/fromSeed';
|
||||||
|
import DeriveJunction from './DeriveJunction';
|
||||||
|
|
||||||
|
export default function keyHdkdEcdsa (keypair: Keypair, { chainCode, isHard }: DeriveJunction): Keypair {
|
||||||
|
assert(isHard, 'A soft key was found in the path (and is unsupported)');
|
||||||
|
|
||||||
|
return secp256k1KeypairFromSeed(
|
||||||
|
secp256k1DeriveHard(keypair.secretKey.subarray(0, 32), chainCode)
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -10,3 +10,4 @@ export { default as keyExtractSuri } from './extractSuri';
|
|||||||
export { default as keyFromPath } from './fromPath';
|
export { default as keyFromPath } from './fromPath';
|
||||||
export { default as keyHdkdEd25519 } from './hdkdEd25519';
|
export { default as keyHdkdEd25519 } from './hdkdEd25519';
|
||||||
export { default as keyHdkdSr25519 } from './hdkdEd25519';
|
export { default as keyHdkdSr25519 } from './hdkdEd25519';
|
||||||
|
export { default as keyHdkdEcdsa } from './hdkdEcdsa';
|
||||||
|
|||||||
@@ -11,5 +11,4 @@ import '../polyfill';
|
|||||||
export { default as mnemonicGenerate } from './generate';
|
export { default as mnemonicGenerate } from './generate';
|
||||||
export { default as mnemonicToEntropy } from './toEntropy';
|
export { default as mnemonicToEntropy } from './toEntropy';
|
||||||
export { default as mnemonicToMiniSecret } from './toMiniSecret';
|
export { default as mnemonicToMiniSecret } from './toMiniSecret';
|
||||||
export { default as mnemonicToSeed } from './toSeed';
|
|
||||||
export { default as mnemonicValidate } from './validate';
|
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
|
// Receiver sends encrypting public key to receive message to decrypt with his private key
|
||||||
const receiverIdBoxKey = naclBoxKeypairFromSecret(receiverIdKey.secretKey);
|
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
|
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
|
||||||
const senderIdBoxKey = naclBoxKeypairFromSecret(senderIdKey.secretKey);
|
const senderIdBoxKey = naclBoxKeypairFromSecret(senderIdKey.secretKey);
|
||||||
const message = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
|
const message = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
|
||||||
const { nonce, sealed } = naclSeal(message, senderIdBoxKey.secretKey, receiverIdBoxKey.publicKey);
|
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
|
// Receiver opens encrypted message from the sender
|
||||||
let opened = naclOpen(sealed, nonce, senderIdBoxKey.publicKey, receiverIdBoxKey.secretKey);
|
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
|
// Oh no the Id key is hacked, derive Id key again from another index
|
||||||
const senderIdKey2 = fromPath(sender, keyExtractPath('//1//1//1//2').path, 'ed25519');
|
const 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
|
// Receiver sends encrypting public key to receive message to decrypt with his private key
|
||||||
const receiverIdBoxKey2 = naclBoxKeypairFromSecret(receiverIdKey2.secretKey);
|
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
|
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
|
||||||
const senderIdBoxKey2 = naclBoxKeypairFromSecret(senderIdKey2.secretKey);
|
const senderIdBoxKey2 = naclBoxKeypairFromSecret(senderIdKey2.secretKey);
|
||||||
@@ -63,17 +63,17 @@ describe('naclOpen', (): void => {
|
|||||||
const sealed2 = ctx.sealed;
|
const sealed2 = ctx.sealed;
|
||||||
const nonce2 = ctx.nonce;
|
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
|
// Receiver opens encrypted message from the sender
|
||||||
opened = naclOpen(sealed2, nonce2, senderIdBoxKey2.publicKey, receiverIdBoxKey2.secretKey);
|
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
|
// 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
|
// Receiver sends encrypting public key to receive message to decrypt with his private key
|
||||||
const receiverIdBoxKey2One = naclBoxKeypairFromSecret(receiverIdBoxKey2.secretKey);
|
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
|
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
|
||||||
const senderIdBoxKey2One = naclBoxKeypairFromSecret(senderIdBoxKey2.secretKey);
|
const senderIdBoxKey2One = naclBoxKeypairFromSecret(senderIdBoxKey2.secretKey);
|
||||||
@@ -84,11 +84,11 @@ describe('naclOpen', (): void => {
|
|||||||
const sealed3 = ctx.sealed;
|
const sealed3 = ctx.sealed;
|
||||||
const nonce3 = ctx.nonce;
|
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
|
// Receiver opens encrypted message from the sender
|
||||||
opened = naclOpen(sealed2, nonce2, senderIdBoxKey2One.publicKey, receiverIdBoxKey2One.secretKey);
|
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 => {
|
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 {
|
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);
|
const messageU8a = u8aToU8a(message);
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import { waitReady } from '@polkadot/wasm-crypto';
|
|||||||
|
|
||||||
import { naclVerify, naclKeypairFromSeed } from '.';
|
import { naclVerify, naclKeypairFromSeed } from '.';
|
||||||
|
|
||||||
describe('naclSign', (): void => {
|
describe('naclVerify', (): void => {
|
||||||
let publicKey: Uint8Array;
|
let publicKey: Uint8Array;
|
||||||
let signature: Uint8Array;
|
let signature: Uint8Array;
|
||||||
|
|
||||||
@@ -51,4 +51,24 @@ describe('naclSign', (): void => {
|
|||||||
)
|
)
|
||||||
).toEqual(false);
|
).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.
|
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||||
|
|
||||||
import nacl from 'tweetnacl';
|
import nacl from 'tweetnacl';
|
||||||
import { u8aToU8a } from '@polkadot/util';
|
import { assert, u8aToU8a } from '@polkadot/util';
|
||||||
import { isReady, ed25519Verify } from '@polkadot/wasm-crypto';
|
import { isReady, ed25519Verify } from '@polkadot/wasm-crypto';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @name naclSign
|
* @name naclSign
|
||||||
* @summary Verifies the signature on the supplied message.
|
* @summary Verifies the signature on the supplied message.
|
||||||
* @description
|
* @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
|
* @example
|
||||||
* <BR>
|
* <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 {
|
export default function naclVerify (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string): boolean {
|
||||||
const messageU8a = u8aToU8a(message);
|
const messageU8a = u8aToU8a(message);
|
||||||
const signatureU8a = u8aToU8a(signature);
|
|
||||||
const publicKeyU8a = u8aToU8a(publicKey);
|
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()
|
return isReady()
|
||||||
? ed25519Verify(signatureU8a, messageU8a, publicKeyU8a)
|
? ed25519Verify(signatureU8a, messageU8a, publicKeyU8a)
|
||||||
|
|||||||
@@ -14,8 +14,8 @@ import { sr25519Sign } from '@polkadot/wasm-crypto';
|
|||||||
* @description Returns message signature of `message`, using the supplied pair
|
* @description Returns message signature of `message`, using the supplied pair
|
||||||
*/
|
*/
|
||||||
export default function schnorrkelSign (message: Uint8Array | string, { publicKey, secretKey }: Partial<Keypair>): Uint8Array {
|
export default function schnorrkelSign (message: Uint8Array | string, { publicKey, secretKey }: Partial<Keypair>): Uint8Array {
|
||||||
assert(publicKey?.length === 32, 'Expected valid publicKey, 32-bytes');
|
assert(publicKey?.length === 32, 'Expected a valid publicKey, 32-bytes');
|
||||||
assert(secretKey?.length === 64, 'Expected valid secretKey, 64-bytes');
|
assert(secretKey?.length === 64, 'Expected a valid secretKey, 64-bytes');
|
||||||
|
|
||||||
const messageU8a = u8aToU8a(message);
|
const messageU8a = u8aToU8a(message);
|
||||||
|
|
||||||
|
|||||||
@@ -29,4 +29,24 @@ describe('sign and verify', (): void => {
|
|||||||
|
|
||||||
expect(verify(MESSAGE, signature, pair.publicKey)).toBe(true);
|
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 '../polyfill';
|
||||||
|
|
||||||
import { u8aToU8a } from '@polkadot/util';
|
import { assert, u8aToU8a } from '@polkadot/util';
|
||||||
import { sr25519Verify } from '@polkadot/wasm-crypto';
|
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 {
|
export default function schnorrkelVerify (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string): boolean {
|
||||||
const messageU8a = u8aToU8a(message);
|
const messageU8a = u8aToU8a(message);
|
||||||
const signatureU8a = u8aToU8a(signature);
|
|
||||||
const publicKeyU8a = u8aToU8a(publicKey);
|
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);
|
return sr25519Verify(signatureU8a, messageU8a, publicKeyU8a);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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 { compactAddLength, stringToU8a, u8aConcat } from '@polkadot/util';
|
||||||
|
|
||||||
|
import blake2AsU8a from '../blake2/asU8a';
|
||||||
|
|
||||||
|
const HDKD = compactAddLength(stringToU8a('Secp256k1HDKD'));
|
||||||
|
|
||||||
|
export default function deriveHard (seed: Uint8Array, chainCode: Uint8Array): Uint8Array {
|
||||||
|
return blake2AsU8a(u8aConcat(HDKD, seed, chainCode), 256);
|
||||||
|
}
|
||||||
@@ -2,4 +2,7 @@
|
|||||||
// This software may be modified and distributed under the terms
|
// This software may be modified and distributed under the terms
|
||||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||||
|
|
||||||
|
export { default as secp256k1KeypairFromSeed } from './keypair/fromSeed';
|
||||||
export { default as secp256k1Recover } from './recover';
|
export { default as secp256k1Recover } from './recover';
|
||||||
|
export { default as secp256k1Verify } from './verify';
|
||||||
|
export { default as secp256k1Sign } from './sign';
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
// 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, hexToU8a } from '@polkadot/util';
|
||||||
|
|
||||||
|
import { mnemonicToMiniSecret } from '../../mnemonic';
|
||||||
|
import { secp256k1KeypairFromSeed } from '..';
|
||||||
|
import tests from './testing';
|
||||||
|
|
||||||
|
describe('secp256k1KeypairFromSeed', (): void => {
|
||||||
|
const TEST = hexToU8a('0x4380de832af797688026ce24f85204d508243f201650c1a134929e5458b7fbae');
|
||||||
|
const RESULT = {
|
||||||
|
publicKey: hexToU8a('0x03fd8c74f795ced92064b86191cb2772b1e3a0947740aa0a5a6e379592471fd85b'),
|
||||||
|
secretKey: hexToU8a('0x4380de832af797688026ce24f85204d508243f201650c1a134929e5458b7fbae')
|
||||||
|
};
|
||||||
|
|
||||||
|
it('generates a valid publicKey/secretKey pair (u8a)', (): void => {
|
||||||
|
expect(secp256k1KeypairFromSeed(TEST)).toEqual(RESULT);
|
||||||
|
});
|
||||||
|
|
||||||
|
tests.forEach(([mnemonic, secretKey, publicKey], index): void => {
|
||||||
|
it(`creates valid against known (${index})`, (): void => {
|
||||||
|
const seed = mnemonicToMiniSecret(mnemonic);
|
||||||
|
const pair = secp256k1KeypairFromSeed(seed);
|
||||||
|
|
||||||
|
expect(u8aToHex(pair.secretKey)).toEqual(secretKey);
|
||||||
|
expect(u8aToHex(pair.publicKey)).toEqual(publicKey);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -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 { Keypair } from '../../types';
|
||||||
|
import { assert, hexToU8a } from '@polkadot/util';
|
||||||
|
import elliptic from 'elliptic';
|
||||||
|
|
||||||
|
const EC = elliptic.ec;
|
||||||
|
const ec = new EC('secp256k1');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name secp256k1KeypairFromSeed
|
||||||
|
* @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');
|
||||||
|
|
||||||
|
const key = ec.keyFromPrivate(seed);
|
||||||
|
|
||||||
|
return {
|
||||||
|
publicKey: new Uint8Array(key.getPublic().encodeCompressed('array')),
|
||||||
|
secretKey: hexToU8a(`0x${key.getPrivate('hex')}`)
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
// 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.
|
||||||
|
|
||||||
|
// mnemonic, secret, public, account_id
|
||||||
|
type Test = [string, string, string, string];
|
||||||
|
|
||||||
|
const tests: Test[] = [
|
||||||
|
[
|
||||||
|
'life fee table ahead modify maximum dumb such tobacco boss dry nurse',
|
||||||
|
'0xf2360e871c830d397fe221382b503f07ddd8763df81a94bb2504390a2fb91f59',
|
||||||
|
'0x036b0aa6beab469dd2b748a0ff5ddbe3d13df1e15c9d28a2aa057212994e127bea',
|
||||||
|
'0xae8e8fcacbaeb607bcdf0bbd7e615f2b4ef484ee54f19d68a7393fb6db2dd9cd'
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'tide survey cradle cover column ugly author wait eye state elder blame',
|
||||||
|
'0x5385355a5118ec732b9dbcf1668ba21db38b07cf79082dafa9a7cc4b52e4abb0',
|
||||||
|
'0x03929e4f93cdad265751ad8f6365185d8e937610d19b510400f5867d542d60a313',
|
||||||
|
'0xf80ea815da66c42f870b687e1530770d5a7936ae81a147b009506d85bd6d621c'
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'laugh fish flee cake approve butter april dynamic myth license ticket lobster',
|
||||||
|
'0x83ec65cf9a8a7442d808aef6f8987599f1ba3be880769bb3a20621b13adbd476',
|
||||||
|
'0x0388299e4cfaa33d180a026bd54a46ad98df129a131320a9d2fd6f80e64bc3db39',
|
||||||
|
'0x35036238dd195f4c2169379354bda6cba5746f67bde03ef59a77a4cea80729bc'
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'animal thing fork recipe exotic pilot inquiry pledge obey slab obtain reveal',
|
||||||
|
'0x0fd50580eb5a58b0eee60c77656dffa50094b539262366f1227d3babfd7343e5',
|
||||||
|
'0x036edc954685ad89f0a23b0fb1eb2b9c3a8600eee9091c758426dfb2bc7889a7c3',
|
||||||
|
'0x2a94b10d1f28810dc4628e7e424b2d08bd3d17fb08f9416d112f17e86c8fa77c'
|
||||||
|
]
|
||||||
|
];
|
||||||
|
|
||||||
|
export default tests;
|
||||||
@@ -13,6 +13,7 @@ const ec = new EC('secp256k1');
|
|||||||
*/
|
*/
|
||||||
export default function secp256k1Recover (message: Uint8Array, signature: Uint8Array, recovery: number): Uint8Array {
|
export default function secp256k1Recover (message: Uint8Array, signature: Uint8Array, recovery: number): Uint8Array {
|
||||||
return new Uint8Array(
|
return new Uint8Array(
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access
|
||||||
ec
|
ec
|
||||||
.recoverPubKey(message, { r: signature.slice(0, 32), s: signature.slice(32, 64) }, recovery)
|
.recoverPubKey(message, { r: signature.slice(0, 32), s: signature.slice(32, 64) }, recovery)
|
||||||
.encode(null, true)
|
.encode(null, true)
|
||||||
|
|||||||
@@ -0,0 +1,28 @@
|
|||||||
|
// 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 { Keypair } from '../types';
|
||||||
|
import { assert, u8aToU8a, u8aConcat } from '@polkadot/util';
|
||||||
|
import { blake2AsU8a } from '../blake2';
|
||||||
|
import elliptic from 'elliptic';
|
||||||
|
|
||||||
|
const EC = elliptic.ec;
|
||||||
|
const ec = new EC('secp256k1');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name secp256k1Sign
|
||||||
|
* @description Returns message signature of `message`, using the supplied pair
|
||||||
|
*/
|
||||||
|
export default function secp256k1Sign (message: Uint8Array | string, { secretKey }: Partial<Keypair>): Uint8Array {
|
||||||
|
assert(secretKey?.length === 32, 'Expected valid secp256k1 secretKey, 32-bytes');
|
||||||
|
|
||||||
|
const messageHash = blake2AsU8a(u8aToU8a(message), 256);
|
||||||
|
const key = ec.keyFromPrivate(secretKey);
|
||||||
|
const ecsig = key.sign(messageHash);
|
||||||
|
const rParam = new Uint8Array(ecsig.r.toArray());
|
||||||
|
const sParam = new Uint8Array(ecsig.s.toArray());
|
||||||
|
const recoveryParam = Uint8Array.of(ecsig.recoveryParam || 0);
|
||||||
|
|
||||||
|
return u8aConcat(rParam, sParam, recoveryParam);
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
// 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 { blake2AsU8a } from '../blake2';
|
||||||
|
import randomAsU8a from '../random/asU8a';
|
||||||
|
import pairFromSeed from './keypair/fromSeed';
|
||||||
|
import sign from './sign';
|
||||||
|
import verify from './verify';
|
||||||
|
|
||||||
|
const MESSAGE = stringToU8a('this is a message');
|
||||||
|
|
||||||
|
describe('sign and verify', (): void => {
|
||||||
|
it('verify message signature', (): void => {
|
||||||
|
const address = '0x59f587c045d4d4e9aa1016eae43770fc0551df8a385027723342753a876aeef0';
|
||||||
|
const sig = '0x92fcacf0946bbd10b31dfe16d567ed1d3014e81007dd9e5256e19c0f07eacc1643b151ca29e449a765e16a7ce59b88d800467d6b3412d30ea8ad22307a59664b00';
|
||||||
|
const msg = stringToU8a('secp256k1');
|
||||||
|
|
||||||
|
expect(verify(msg, sig, address)).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('has 65-byte signatures', (): void => {
|
||||||
|
const pair = pairFromSeed(randomAsU8a());
|
||||||
|
|
||||||
|
expect(sign(MESSAGE, pair)).toHaveLength(65);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('can sign and verify a message by random key', (): void => {
|
||||||
|
const pair = pairFromSeed(randomAsU8a());
|
||||||
|
const signature = sign(MESSAGE, pair);
|
||||||
|
const address = blake2AsU8a(pair.publicKey, 256);
|
||||||
|
|
||||||
|
expect(verify(MESSAGE, signature, address)).toBe(true);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
// 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 { u8aToU8a } from '@polkadot/util';
|
||||||
|
import { blake2AsU8a } from '../blake2';
|
||||||
|
import elliptic from 'elliptic';
|
||||||
|
|
||||||
|
const EC = elliptic.ec;
|
||||||
|
const ec = new EC('secp256k1');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name secp256k1Verify
|
||||||
|
* @description Verifies the signature of `message`, using the supplied pair
|
||||||
|
*/
|
||||||
|
export default function secp256k1Verify (message: Uint8Array | string, signature: Uint8Array | string, address: Uint8Array | string): boolean {
|
||||||
|
const signatureU8a = u8aToU8a(signature);
|
||||||
|
const sig = {
|
||||||
|
r: signatureU8a.slice(0, 32),
|
||||||
|
s: signatureU8a.slice(32, 64)
|
||||||
|
};
|
||||||
|
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)
|
||||||
|
);
|
||||||
|
|
||||||
|
return Buffer.compare(blake2AsU8a(publicKey, 256), u8aToU8a(address)) === 0;
|
||||||
|
}
|
||||||
@@ -10,11 +10,14 @@ import { signatureVerify } from '.';
|
|||||||
|
|
||||||
const ADDR_ED = 'DxN4uvzwPzJLtn17yew6jEffPhXQfdKHTp2brufb98vGbPN';
|
const ADDR_ED = 'DxN4uvzwPzJLtn17yew6jEffPhXQfdKHTp2brufb98vGbPN';
|
||||||
const ADDR_SR = 'EK1bFgKm2FsghcttHT7TB7rNyXApFgs9fCbijMGQNyFGBQm';
|
const ADDR_SR = 'EK1bFgKm2FsghcttHT7TB7rNyXApFgs9fCbijMGQNyFGBQm';
|
||||||
|
const ADDR_EC = 'XyFVXiGaHxoBhXZkSh6NS2rjFyVaVNUo5UiZDqZbuSfUdji';
|
||||||
const MESSAGE = 'hello world';
|
const MESSAGE = 'hello world';
|
||||||
const SIG_ED = '0x299d3bf4c8bb51af732f8067b3a3015c0862a5ff34721749d8ed6577ea2708365d1c5f76bd519009971e41156f12c70abc2533837ceb3bad9a05a99ab923de06';
|
const SIG_ED = '0x299d3bf4c8bb51af732f8067b3a3015c0862a5ff34721749d8ed6577ea2708365d1c5f76bd519009971e41156f12c70abc2533837ceb3bad9a05a99ab923de06';
|
||||||
const SIG_SR = '0xca01419b5a17219f7b78335658cab3b126db523a5df7be4bfc2bef76c2eb3b1dcf4ca86eb877d0a6cf6df12db5995c51d13b00e005d053b892bd09c594434288';
|
const SIG_SR = '0xca01419b5a17219f7b78335658cab3b126db523a5df7be4bfc2bef76c2eb3b1dcf4ca86eb877d0a6cf6df12db5995c51d13b00e005d053b892bd09c594434288';
|
||||||
|
const SIG_EC = '0x994638ee586d2c5dbd9bacacbc35d9b7e9018de8f7892f00c900db63bc57b1283e2ee7bc51a9b1c1dae121ac4f4b9e2a41cd1d6bf4bb3e24d7fed6faf6d85e0501';
|
||||||
const MUL_ED = u8aToHex(u8aConcat(new Uint8Array([0]), hexToU8a(SIG_ED)));
|
const MUL_ED = u8aToHex(u8aConcat(new Uint8Array([0]), hexToU8a(SIG_ED)));
|
||||||
const MUL_SR = u8aToHex(u8aConcat(new Uint8Array([1]), hexToU8a(SIG_SR)));
|
const MUL_SR = u8aToHex(u8aConcat(new Uint8Array([1]), hexToU8a(SIG_SR)));
|
||||||
|
const MUL_EC = u8aToHex(u8aConcat(new Uint8Array([2]), hexToU8a(SIG_EC)));
|
||||||
|
|
||||||
describe('signatureVerify', (): void => {
|
describe('signatureVerify', (): void => {
|
||||||
beforeEach(async (): Promise<void> => {
|
beforeEach(async (): Promise<void> => {
|
||||||
@@ -24,7 +27,7 @@ describe('signatureVerify', (): void => {
|
|||||||
it('throws on invalid signature length', (): void => {
|
it('throws on invalid signature length', (): void => {
|
||||||
expect(
|
expect(
|
||||||
() => signatureVerify(MESSAGE, new Uint8Array(32), ADDR_ED)
|
() => signatureVerify(MESSAGE, new Uint8Array(32), ADDR_ED)
|
||||||
).toThrow('Invalid signature length, expected 64 or 65 bytes, found 32');
|
).toThrow('Invalid signature length, expected [64..66] bytes, found 32');
|
||||||
});
|
});
|
||||||
|
|
||||||
describe('verifyDetect', (): void => {
|
describe('verifyDetect', (): void => {
|
||||||
@@ -35,6 +38,13 @@ describe('signatureVerify', (): void => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('verifies an ecdsa signature', (): void => {
|
||||||
|
expect(signatureVerify(MESSAGE, SIG_EC, ADDR_EC)).toEqual({
|
||||||
|
crypto: 'ecdsa',
|
||||||
|
isValid: true
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
it('verifies an sr25519 signature', (): void => {
|
it('verifies an sr25519 signature', (): void => {
|
||||||
expect(signatureVerify(MESSAGE, SIG_SR, ADDR_SR)).toEqual({
|
expect(signatureVerify(MESSAGE, SIG_SR, ADDR_SR)).toEqual({
|
||||||
crypto: 'sr25519',
|
crypto: 'sr25519',
|
||||||
@@ -58,16 +68,6 @@ describe('signatureVerify', (): void => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe('verifyMultisig', (): void => {
|
describe('verifyMultisig', (): void => {
|
||||||
it('throws with invalid multisig indicator', (): void => {
|
|
||||||
const u8aSig = hexToU8a(MUL_ED);
|
|
||||||
|
|
||||||
u8aSig[0] = 69;
|
|
||||||
|
|
||||||
expect(
|
|
||||||
() => signatureVerify(MESSAGE, u8aSig, ADDR_ED)
|
|
||||||
).toThrow('Unknown crypto type, expected signature prefix of 0 or 1, found 69');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('verifies an ed25519 signature', (): void => {
|
it('verifies an ed25519 signature', (): void => {
|
||||||
expect(signatureVerify(MESSAGE, MUL_ED, ADDR_ED)).toEqual({
|
expect(signatureVerify(MESSAGE, MUL_ED, ADDR_ED)).toEqual({
|
||||||
crypto: 'ed25519',
|
crypto: 'ed25519',
|
||||||
@@ -75,6 +75,13 @@ describe('signatureVerify', (): void => {
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('verifies an ecdsa signature', (): void => {
|
||||||
|
expect(signatureVerify(MESSAGE, MUL_EC, ADDR_EC)).toEqual({
|
||||||
|
crypto: 'ecdsa',
|
||||||
|
isValid: true
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
it('verifies an sr25519 signature', (): void => {
|
it('verifies an sr25519 signature', (): void => {
|
||||||
expect(signatureVerify(MESSAGE, MUL_SR, ADDR_SR)).toEqual({
|
expect(signatureVerify(MESSAGE, MUL_SR, ADDR_SR)).toEqual({
|
||||||
crypto: 'sr25519',
|
crypto: 'sr25519',
|
||||||
|
|||||||
@@ -9,10 +9,18 @@ import { assert, u8aToU8a } from '@polkadot/util';
|
|||||||
import addressDecode from '../address/decode';
|
import addressDecode from '../address/decode';
|
||||||
import naclVerify from '../nacl/verify';
|
import naclVerify from '../nacl/verify';
|
||||||
import schnorrkelVerify from '../schnorrkel/verify';
|
import schnorrkelVerify from '../schnorrkel/verify';
|
||||||
|
import secp256k1Verify from '../secp256k1/verify';
|
||||||
|
|
||||||
const VERIFIERS: [KeypairType, (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string) => boolean][] = [
|
const VERIFIERS: [KeypairType, (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string) => boolean][] = [
|
||||||
['ed25519', naclVerify],
|
['ed25519', naclVerify],
|
||||||
['sr25519', schnorrkelVerify]
|
['sr25519', schnorrkelVerify],
|
||||||
|
['ecdsa', secp256k1Verify]
|
||||||
|
];
|
||||||
|
|
||||||
|
const CRYPTO_TYPES: KeypairType[] = [
|
||||||
|
'ed25519',
|
||||||
|
'sr25519',
|
||||||
|
'ecdsa'
|
||||||
];
|
];
|
||||||
|
|
||||||
function verifyDetect (result: VerifyResult, message: Uint8Array | string, signature: Uint8Array, publicKey: Uint8Array): VerifyResult {
|
function verifyDetect (result: VerifyResult, message: Uint8Array | string, signature: Uint8Array, publicKey: Uint8Array): VerifyResult {
|
||||||
@@ -34,18 +42,17 @@ function verifyDetect (result: VerifyResult, message: Uint8Array | string, signa
|
|||||||
}
|
}
|
||||||
|
|
||||||
function verifyMultisig (result: VerifyResult, message: Uint8Array | string, signature: Uint8Array, publicKey: Uint8Array): VerifyResult {
|
function verifyMultisig (result: VerifyResult, message: Uint8Array | string, signature: Uint8Array, publicKey: Uint8Array): VerifyResult {
|
||||||
assert([0, 1].includes(signature[0]), `Unknown crypto type, expected signature prefix of 0 or 1, found ${signature[0]}`);
|
assert([0, 1, 2].includes(signature[0]), `Unknown crypto type, expected signature prefix [0..2], found ${signature[0]}`);
|
||||||
|
|
||||||
const isEd25519 = signature[0] === 0;
|
result.crypto = CRYPTO_TYPES[signature[0]] || 'none';
|
||||||
|
|
||||||
result.crypto = isEd25519
|
|
||||||
? 'ed25519'
|
|
||||||
: 'sr25519';
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
result.isValid = isEd25519
|
result.isValid = {
|
||||||
? naclVerify(message, signature.subarray(1), publicKey)
|
ecdsa: (): boolean => secp256k1Verify(message, signature.subarray(1), publicKey),
|
||||||
: schnorrkelVerify(message, signature.subarray(1), publicKey);
|
ed25519: (): boolean => naclVerify(message, signature.subarray(1), publicKey),
|
||||||
|
none: (): boolean => { throw Error('no verify for `none` crypto type'); },
|
||||||
|
sr25519: (): boolean => schnorrkelVerify(message, signature.subarray(1), publicKey)
|
||||||
|
}[result.crypto]();
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
// ignore, result.isValid still set to false
|
// ignore, result.isValid still set to false
|
||||||
}
|
}
|
||||||
@@ -56,12 +63,15 @@ function verifyMultisig (result: VerifyResult, message: Uint8Array | string, sig
|
|||||||
export default function signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string): VerifyResult {
|
export default function signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string): VerifyResult {
|
||||||
const signatureU8a = u8aToU8a(signature);
|
const signatureU8a = u8aToU8a(signature);
|
||||||
|
|
||||||
assert([64, 65].includes(signatureU8a.length), `Invalid signature length, expected 64 or 65 bytes, found ${signatureU8a.length}`);
|
assert([64, 65, 66].includes(signatureU8a.length), `Invalid signature length, expected [64..66] bytes, found ${signatureU8a.length}`);
|
||||||
|
|
||||||
const result: VerifyResult = { crypto: 'none', isValid: false };
|
const result: VerifyResult = { crypto: 'none', isValid: false };
|
||||||
const publicKey = addressDecode(addressOrPublicKey);
|
const publicKey = addressDecode(addressOrPublicKey);
|
||||||
|
const isMultisig = [0, 1, 2].includes(signatureU8a[0]) && [65, 66].includes(signatureU8a.length);
|
||||||
|
|
||||||
return signatureU8a.length === 65
|
if (isMultisig) {
|
||||||
? verifyMultisig(result, message, signatureU8a, publicKey)
|
return verifyMultisig(result, message, signatureU8a, publicKey);
|
||||||
: verifyDetect(result, message, signatureU8a, publicKey);
|
} else {
|
||||||
|
return verifyDetect(result, message, signatureU8a, publicKey);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ export interface Seedpair {
|
|||||||
seed: Uint8Array;
|
seed: Uint8Array;
|
||||||
}
|
}
|
||||||
|
|
||||||
export type KeypairType = 'ed25519' | 'sr25519';
|
export type KeypairType = 'ed25519' | 'sr25519' | 'ecdsa';
|
||||||
|
|
||||||
export interface VerifyResult {
|
export interface VerifyResult {
|
||||||
crypto: 'none' | KeypairType;
|
crypto: 'none' | KeypairType;
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@polkadot/util",
|
"name": "@polkadot/util",
|
||||||
"version": "2.8.1",
|
"version": "2.18.1",
|
||||||
"description": "A collection of useful utilities for @polkadot",
|
"description": "A collection of useful utilities for @polkadot",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
@@ -25,11 +25,11 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util#readme",
|
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/runtime": "^7.9.2",
|
"@babel/runtime": "^7.10.4",
|
||||||
"@types/bn.js": "^4.11.6",
|
"@types/bn.js": "^4.11.6",
|
||||||
"bn.js": "^5.1.1",
|
"bn.js": "^5.1.2",
|
||||||
"camelcase": "^5.3.1",
|
"camelcase": "^5.3.1",
|
||||||
"chalk": "^4.0.0",
|
"chalk": "^4.1.0",
|
||||||
"ip-regex": "^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
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||||
export default function arrayFilter (array: any[], allowNulls = true): any[] {
|
export default function arrayFilter <T = any> (array: T[], allowNulls = true): T[] {
|
||||||
return array.filter((value): boolean => {
|
return array.filter((value) =>
|
||||||
return !isUndefined(value) && (allowNulls || !isNull(value));
|
!isUndefined(value) && (allowNulls || !isNull(value))
|
||||||
});
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ type MessageFn = () => string;
|
|||||||
* assert(false, () => 'message'); // Error with 'message'
|
* 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) {
|
if (!condition) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
isFunction(message)
|
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
|
* @summary Utility methods to convert to and from `BN` objects
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
export * from './consts';
|
||||||
export { default as bnFromHex } from './fromHex';
|
export { default as bnFromHex } from './fromHex';
|
||||||
export { default as bnMax } from './max';
|
export { default as bnMax } from './max';
|
||||||
export { default as bnMin } from './min';
|
export { default as bnMin } from './min';
|
||||||
|
|||||||
@@ -22,5 +22,5 @@ import assert from '../assert';
|
|||||||
export default function max (...items: BN[]): BN {
|
export default function max (...items: BN[]): BN {
|
||||||
assert(items && items.length >= 1, 'Must provide one or more BN arguments');
|
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 {
|
export default function min (...items: BN[]): BN {
|
||||||
assert(items && items.length >= 1, 'Must provide one or more BN arguments');
|
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 => {
|
it('converts BigInt values to BN', (): void => {
|
||||||
expect(
|
expect(
|
||||||
bnToBn(128_821n).toNumber()
|
bnToBn(128821n).toNumber()
|
||||||
).toEqual(128821);
|
).toEqual(128821);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -25,6 +25,12 @@ describe('bnToHex', (): void => {
|
|||||||
).toBe('0x0080');
|
).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 => {
|
it('converts BN values to a prefixed hex representation (LE)', (): void => {
|
||||||
expect(
|
expect(
|
||||||
bnToHex(new BN(128), { bitLength: 16, isLe: true })
|
bnToHex(new BN(128), { bitLength: 16, isLe: true })
|
||||||
|
|||||||
@@ -2,11 +2,12 @@
|
|||||||
// This software may be modified and distributed under the terms
|
// This software may be modified and distributed under the terms
|
||||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||||
|
|
||||||
|
import { ToBn, ToBnOptions } from '../types';
|
||||||
|
|
||||||
import BN from 'bn.js';
|
import BN from 'bn.js';
|
||||||
|
|
||||||
import isNumber from '../is/number';
|
import isNumber from '../is/number';
|
||||||
import bnToU8a from './toU8a';
|
import bnToU8a from './toU8a';
|
||||||
import { ToBnOptions } from '../types';
|
|
||||||
import { u8aToHex } from '../u8a';
|
import { u8aToHex } from '../u8a';
|
||||||
|
|
||||||
const ZERO_STR = '0x00';
|
const ZERO_STR = '0x00';
|
||||||
@@ -30,7 +31,9 @@ interface Options extends ToBnOptions {
|
|||||||
* bnToHex(new BN(0x123456)); // => '0x123456'
|
* 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) {
|
if (!value) {
|
||||||
return ZERO_STR;
|
return ZERO_STR;
|
||||||
}
|
}
|
||||||
@@ -39,8 +42,10 @@ export default function bnToHex (value?: BN | BigInt | number | null, options: n
|
|||||||
isLe: false,
|
isLe: false,
|
||||||
isNegative: false,
|
isNegative: false,
|
||||||
// Backwards-compatibility
|
// Backwards-compatibility
|
||||||
...(isNumber(options) ? { bitLength: options } : options)
|
...(isNumber(arg1) ? { bitLength: arg1, isLe: arg2 } : arg1)
|
||||||
};
|
};
|
||||||
|
|
||||||
return u8aToHex(bnToU8a(value, _options));
|
return u8aToHex(bnToU8a(value, _options));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export default bnToHex;
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ describe('bnToU8a', (): void => {
|
|||||||
it('converts null values to 0x00', (): void => {
|
it('converts null values to 0x00', (): void => {
|
||||||
expect(
|
expect(
|
||||||
bnToU8a(null, -1, false)
|
bnToU8a(null, -1, false)
|
||||||
).toEqual(new Uint8Array([]));
|
).toEqual(new Uint8Array());
|
||||||
});
|
});
|
||||||
|
|
||||||
it('converts null values to 0x00000000 (bitLength)', (): void => {
|
it('converts null values to 0x00000000 (bitLength)', (): void => {
|
||||||
|
|||||||
@@ -2,11 +2,12 @@
|
|||||||
// This software may be modified and distributed under the terms
|
// This software may be modified and distributed under the terms
|
||||||
// of the Apache-2.0 license. See the LICENSE file for details.
|
// of the Apache-2.0 license. See the LICENSE file for details.
|
||||||
|
|
||||||
|
import { ToBn, ToBnOptions } from '../types';
|
||||||
|
|
||||||
import BN from 'bn.js';
|
import BN from 'bn.js';
|
||||||
|
|
||||||
import isNumber from '../is/number';
|
import isNumber from '../is/number';
|
||||||
import bnToBn from './toBn';
|
import bnToBn from './toBn';
|
||||||
import { ToBnOptions } from '../types';
|
|
||||||
|
|
||||||
interface Options extends ToBnOptions {
|
interface Options extends ToBnOptions {
|
||||||
bitLength?: number;
|
bitLength?: number;
|
||||||
@@ -26,9 +27,9 @@ interface Options extends ToBnOptions {
|
|||||||
* bnToU8a(new BN(0x1234)); // => [0x12, 0x34]
|
* bnToU8a(new BN(0x1234)); // => [0x12, 0x34]
|
||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
function bnToU8a (value: BN | BigInt | number | null, options?: Options): Uint8Array;
|
function bnToU8a <ExtToBn extends ToBn> (value?: ExtToBn | BN | BigInt | number | null, options?: Options): Uint8Array;
|
||||||
function bnToU8a (value: BN | BigInt | number | null, bitLength?: number, isLe?: boolean): Uint8Array;
|
function bnToU8a <ExtToBn extends ToBn> (value?: ExtToBn | 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, arg1: number | Options = { bitLength: -1, isLe: true, isNegative: false }, arg2?: boolean): Uint8Array {
|
||||||
const _options: Options = {
|
const _options: Options = {
|
||||||
bitLength: -1,
|
bitLength: -1,
|
||||||
isLe: true,
|
isLe: true,
|
||||||
@@ -43,7 +44,7 @@ function bnToU8a (value: BN | BigInt | number | null, arg1: number | Options = {
|
|||||||
|
|
||||||
if (!value) {
|
if (!value) {
|
||||||
return _options.bitLength === -1
|
return _options.bitLength === -1
|
||||||
? new Uint8Array([])
|
? new Uint8Array()
|
||||||
: new Uint8Array(byteLength);
|
: new Uint8Array(byteLength);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ describe('bufferToU8a', (): void => {
|
|||||||
it('returns an empty buffer when null provided', (): void => {
|
it('returns an empty buffer when null provided', (): void => {
|
||||||
expect(
|
expect(
|
||||||
bufferToU8a(null)
|
bufferToU8a(null)
|
||||||
).toEqual(new Uint8Array([]));
|
).toEqual(new Uint8Array());
|
||||||
});
|
});
|
||||||
|
|
||||||
it('returns a Uint8Buffer with the correct values', (): void => {
|
it('returns a Uint8Buffer with the correct values', (): void => {
|
||||||
|
|||||||
@@ -17,9 +17,5 @@
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
export default function bufferToU8a (buffer?: Buffer | number[] | null): Uint8Array {
|
export default function bufferToU8a (buffer?: Buffer | number[] | null): Uint8Array {
|
||||||
if (!buffer) {
|
return new Uint8Array(buffer || []);
|
||||||
return new Uint8Array([]);
|
|
||||||
}
|
|
||||||
|
|
||||||
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);
|
const verLength = all.reduce((max, { version }): number => Math.max(max, version.length), 0);
|
||||||
|
|
||||||
return all
|
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');
|
.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 => {
|
it('formats BigInt numbers', (): void => {
|
||||||
expect(
|
expect(
|
||||||
formatBalance(123_456_789_000n, { decimals: 15, withSi: true })
|
formatBalance(123456789000n, { decimals: 15, withSi: true })
|
||||||
).toEqual('123.456µ Unit');
|
).toEqual('123.456µ Unit');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ describe('formatNumber', (): void => {
|
|||||||
|
|
||||||
it('formats BigInt numbers', (): void => {
|
it('formats BigInt numbers', (): void => {
|
||||||
expect(
|
expect(
|
||||||
formatNumber(123_456_789n)
|
formatNumber(123456789n)
|
||||||
).toEqual('123,456,789');
|
).toEqual('123,456,789');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user