Compare commits

..
49 Commits
Author SHA1 Message Date
Github Actions c2b91ad8c2 [CI Skip] 2.9.1
skip-checks: true
2020-04-29 22:42:23 +00:00
Jaco Greeff ffc6b0323b 2.9.1 2020-04-30 00:38:59 +02:00
Github Actions b666db2721 [CI Skip] 2.9.0-beta.4
skip-checks: true
2020-04-29 22:37:08 +00:00
Jaco Greeff b00d49564f Update CHANGELOG.md 2020-04-30 00:34:31 +02:00
Alexander Krupenkin 34380caf1f Added ECDSA keypair support (#589)
* Added ECDSA signature verification

* Add ECDSA keypair, sign, key derivation, fromSeed and tests

* keyring: added ECDSA keypair

* Fix lint errors
2020-04-30 00:33:10 +02:00
Github Actions 277cc2b5a8 [CI Skip] 2.9.0-beta.3
skip-checks: true
2020-04-26 20:26:19 +00:00
joe petrowski 733e9e2729 Add example for multisig address creation (#590)
* add multisig example

* typo

* lint fix

* sort addresses

* make linter happy

* clean up sorting with ss58 param
2020-04-26 22:23:15 +02:00
Github Actions 482264c615 [CI Skip] 2.9.0-beta.2
skip-checks: true
2020-04-26 12:36:41 +00:00
Jaco Greeff 5d0abef952 Sort with ss58 prefix (#591) 2020-04-26 14:33:45 +02:00
Github Actions 2397e1c5d7 [CI Skip] 2.9.0-beta.1
skip-checks: true
2020-04-24 17:18:36 +00:00
Jaco Greeff 62ebe257a6 u8aSorted & sortAddresses (#588) 2020-04-24 19:15:43 +02:00
Github Actions a2844a449c [CI Skip] 2.9.0-beta.0
skip-checks: true
2020-04-24 13:38:04 +00:00
Jaco Greeff 60a9866abe Create createKeyMulti & createKeySub for utility (util-crypto) (#587)
* Create keyMulti & keysub for utility

* Bumps
2020-04-24 15:34:47 +02:00
Github Actions b196158125 [CI Skip] 2.8.1
skip-checks: true
2020-04-09 13:12:53 +00:00
Jaco Greeff 6b1caacfb9 2.8 (#586)
* 2.8

* Typos
2020-04-09 15:10:23 +02:00
Github Actions a7679fb07c [CI Skip] 2.8.0-beta.7
skip-checks: true
2020-04-07 19:51:29 +00:00
Jaco Greeff c4acca6c7c eslint update 2020-04-07 21:48:07 +02:00
Github Actions 5012792693 [CI Skip] 2.8.0-beta.6
skip-checks: true
2020-04-07 19:26:31 +00:00
Jaco Greeff d40d6c65f7 isDevelopment regex 2020-04-07 21:23:20 +02:00
Github Actions 2c0d8e4b59 [CI Skip] 2.8.0-beta.5
skip-checks: true
2020-04-06 10:25:18 +00:00
Jaco Greeff d3d8caa0df Use bundled node (#585) 2020-04-06 12:22:31 +02:00
Github Actions a8f8525c9d [CI Skip] 2.8.0-beta.4
skip-checks: true
2020-04-05 07:55:56 +00:00
Jaco Greeff caa5a8b9e6 Bump deps (#584) 2020-04-05 09:52:59 +02:00
Github Actions ce6187f378 [CI Skip] 2.8.0-beta.3
skip-checks: true
2020-04-04 08:45:26 +00:00
Jaco Greeff fe9c7a8a80 Bump deps (#583) 2020-04-04 10:42:21 +02:00
Github Actions d5584c1837 [CI Skip] 2.8.0-beta.2
skip-checks: true
2020-04-02 06:45:50 +00:00
Jaco Greeff adb1c1fea4 Rewrite yarn.lock (#580) 2020-04-02 08:42:32 +02:00
Github Actions c87c228ab1 [CI Skip] 2.8.0-beta.1
skip-checks: true
2020-04-01 19:23:33 +00:00
Jaco Greeff cbec4add88 Bump dev (incl. lint fixes) (#579)
* Bump dev (incl. lint fixes)

* Fix failures
2020-04-01 21:20:50 +02:00
Github Actions 6429cc307c [CI Skip] 2.8.0-beta.0
skip-checks: true
2020-04-01 18:47:32 +00:00
h4x3rotab c98e994777 Throws an error when signing with a locked keypair (#578)
* Throws an error when signing with a locked keypair

Fixes #576

* Fix lint errors

* Switch to `assert` and fix nits
2020-04-01 20:44:40 +02:00
Github Actions 697a452ba6 [CI Skip] 2.7.1
skip-checks: true
2020-03-31 11:56:12 +00:00
Jaco Greeff f68294c4e7 2.7 (#575) 2020-03-31 13:53:10 +02:00
Github Actions 0130d18945 [CI Skip] 2.7.0-beta.8
skip-checks: true
2020-03-24 06:29:44 +00:00
Jaco Greeff 15c9904c96 Add bnSqrt (#574)
* Add bnSqrt function

* Bumps

* CHANGELOG

* Add extra case
2020-03-24 07:25:53 +01:00
Github Actions add2749967 [CI Skip] 2.7.0-beta.7
skip-checks: true
2020-03-24 05:58:23 +00:00
Jaco Greeff fe2f054389 wasm-crypto initNone (#573)
* wasm-crypto initNone

* noWasm to replace @polkadot/wasm-crypto interface
2020-03-24 06:55:07 +01:00
Github Actions bb1c117727 [CI Skip] 2.7.0-beta.6
skip-checks: true
2020-03-21 09:15:30 +00:00
Jaco Greeff 27c474bd78 Bump deps (#572)
* Bump deps

* @types/jest
2020-03-21 10:12:17 +01:00
Github Actions 039b5ec932 [CI Skip] 2.7.0-beta.5
skip-checks: true
2020-03-16 14:35:40 +00:00
Jaco Greeff 9eea21e0c4 Add yarn matrix (#570)
* Add yarn matrix

* Update pr-any.yml
2020-03-16 15:32:59 +01:00
Github Actions aab533f92e [CI Skip] 2.7.0-beta.4
skip-checks: true
2020-03-16 13:36:21 +00:00
Jaco Greeff 2159270d80 Remove actions matrix (#569)
* Remove actions matrix

* Bumps
2020-03-16 14:33:27 +01:00
Github Actions f1b09eb2e5 [CI Skip] 2.7.0-beta.3
skip-checks: true
2020-03-15 07:21:01 +00:00
Jaco Greeff d08cf8b5fe Remove non-working CI cache (#567) 2020-03-15 08:18:04 +01:00
Github Actions 941618b830 [CI Skip] 2.7.0-beta.2
skip-checks: true
2020-03-14 08:31:56 +00:00
Jaco Greeff 983ca718ec Bump deps (#566) 2020-03-14 09:28:16 +01:00
Github Actions 41ebdd5c59 [CI Skip] 2.7.0-beta.1
skip-checks: true
2020-03-11 06:46:07 +00:00
Jaco Greeff 8971c89081 Back to preminor (#565) 2020-03-11 07:42:45 +01:00
85 changed files with 2573 additions and 1838 deletions
+5 -100
View File
@@ -2,112 +2,17 @@ name: PR
on: [pull_request]
jobs:
lint:
name: Linting
runs-on: ubuntu-latest
pr:
strategy:
matrix:
node-version: [12.x]
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Config yarn cache
id: yarn-cache-dir-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v1
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: lint
run: |
yarn install --immutable | grep -v 'YN0013'
yarn lint
test:
name: Testing
step: ['lint', 'test', 'build', 'docs']
name: ${{ matrix.step }}
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x]
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Config yarn cache
id: yarn-cache-dir-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v1
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: test
- name: ${{ matrix.step }}
env:
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
run: |
yarn install --immutable | grep -v 'YN0013'
yarn test
build_code:
name: Build Code
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x]
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Config yarn cache
id: yarn-cache-dir-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v1
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: build
run: |
yarn install --immutable | grep -v 'YN0013'
yarn build
build_docs:
name: Build Docs
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x]
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Config yarn cache
id: yarn-cache-dir-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v1
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: build
run: |
yarn install --immutable | grep -v 'YN0013'
yarn docs
yarn ${{ matrix.step }}
+8 -57
View File
@@ -5,82 +5,33 @@ on:
- master
jobs:
build_code:
name: Build Code
if: "! contains(github.event.head_commit.message, '[CI Skip]')"
runs-on: ubuntu-latest
master:
strategy:
matrix:
node-version: [12.x]
step: ['build:release', 'docs:release']
name: ${{ matrix.step }}
if: "! contains(github.event.head_commit.message, '[CI Skip]') && github.repository == 'polkadot-js/common'"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
with:
token: ${{ secrets.GH_PAT }}
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Config yarn cache
id: yarn-cache-dir-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v1
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: build
- name: ${{ matrix.step }}
env:
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
GH_PAGES_SRC: build-docs
GH_PAT: ${{ secrets.GH_PAT }}
GH_TOKEN: ${{ secrets.GH_PAT }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
yarn install --immutable | grep -v 'YN0013'
yarn polkadot-ci-ghact-build
build_docs:
name: Build Docs
if: "! contains(github.event.head_commit.message, '[CI Skip]')"
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x]
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Config yarn cache
id: yarn-cache-dir-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v1
id: yarn-cache
with:
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: build
env:
GH_PAT: ${{ secrets.GH_PAT }}
GH_TOKEN: ${{ secrets.GH_PAT }}
GH_PAGES_SRC: build-docs
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
yarn install --immutable | grep -v 'YN0013'
yarn polkadot-ci-ghact-docs
yarn ${{ matrix.step }}
dummy:
name: Dummy
if: "contains(github.event.head_commit.message, '[CI Skip]')"
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x]
steps:
- name: dummy
run: |
-58
View File
File diff suppressed because one or more lines are too long
Vendored Executable
+50
View File
File diff suppressed because one or more lines are too long
+2 -1
View File
@@ -1,4 +1,5 @@
enableImmutableInstalls: false
enableProgressBars: false
nodeLinker: node-modules
@@ -7,4 +8,4 @@ plugins:
- path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.js
spec: "@yarnpkg/plugin-interactive-tools"
yarnPath: .yarn/releases/yarn-berry.js
yarnPath: .yarn/releases/yarn-rc.js
+20 -2
View File
@@ -1,10 +1,28 @@
# 2.9.1 Apr 23, 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)
- Cleanup `isDevelopment` regex to cater for chains such as `Westend Development`
# 2.7.1 Mar 31, 2020
- Add `bnSqrt` to calculate the integer sqrt via Newton iteration
- Allow for optional wasm-crypto, specifically via `@polkadot/util-crypto/noWasm`
- Misc. CI infrastructure cleanups
# 2.6.1 Feb 29, 2020
- **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 `cryptoIsReady (): boolean` function to check status of initialization
- Add `addressCheckChecksum (decoded: Uint8Array)` as an helper to extract and verify the ss58 checksum
- Swap to yarn 2, allow use in yan 2 projects
- Swap to yarn 2, allow use in yarn 2 projects
# 2.5.1 Feb 22, 2020
@@ -26,7 +44,7 @@
- Remove dependency on moment.js with `formatDate` function (Thanks to https://github.com/AndreasGassmann)
- Move TypeScript `@types/*` to dev deps (Thanks to https://github.com/AndreasGassmann)
- Update to `@polkadot/wasm-crypto` 1.0
- Cleanup dependencies to pave the way for using yarnpkg 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
+4
View File
@@ -1 +1,5 @@
// 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.
module.exports = require('@polkadot/dev/config/babel');
@@ -1,6 +1,7 @@
/* eslint-disable header/header */
/* eslint-disable @typescript-eslint/require-await */
/* eslint-disable @typescript-eslint/unbound-method */
/* eslint-disable @typescript-eslint/no-var-requires */
// Import Keyring class and utility function
const Keyring = require('@polkadot/keyring').default;
const stringToU8a = require('@polkadot/util/string/toU8a').default;
@@ -1,6 +1,7 @@
/* eslint-disable header/header */
/* eslint-disable @typescript-eslint/require-await */
/* eslint-disable @typescript-eslint/unbound-method */
/* eslint-disable @typescript-eslint/no-var-requires */
// Import Keyring class and utility function
const Keyring = require('@polkadot/keyring').default;
const stringToU8a = require('@polkadot/util/string/toU8a').default;
@@ -1,12 +1,18 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const { encodeAddress, decodeAddress } = require('@polkadot/keyring');
const { isHex, hexToU8a } = require('@polkadot/util');
/* eslint-disable header/header */
const { decodeAddress, encodeAddress } = require('@polkadot/keyring');
const { hexToU8a, isHex } = require('@polkadot/util');
const address = '5GrpknVvGGrGH3EFuURXeMrWHvbpj3VfER1oX5jFtuGbfzCE';
const isValidAddressPolkadotAddress = () => {
try {
encodeAddress(isHex(address) ? hexToU8a(address) : decodeAddress(address));
encodeAddress(
isHex(address)
? hexToU8a(address)
: decodeAddress(address)
);
return true;
} catch (error) {
return false;
@@ -1,7 +1,8 @@
/* eslint-disable header/header */
/* eslint-disable @typescript-eslint/require-await */
/* eslint-disable @typescript-eslint/unbound-method */
/* eslint-disable @typescript-eslint/no-var-requires */
const { naclEncrypt, naclDecrypt } = require('@polkadot/util-crypto');
const { naclDecrypt, naclEncrypt } = require('@polkadot/util-crypto');
async function main () {
const secret = new Uint8Array(32);
@@ -1,6 +1,7 @@
/* eslint-disable header/header */
/* eslint-disable @typescript-eslint/require-await */
/* eslint-disable @typescript-eslint/unbound-method */
/* eslint-disable @typescript-eslint/no-var-requires */
const { stringToU8a, u8aToHex } = require('@polkadot/util');
const { naclEncrypt, naclKeypairFromSeed, naclSign, naclVerify, randomAsU8a } = require('@polkadot/util-crypto');
@@ -9,7 +10,7 @@ async function main () {
const seedAlice = 'Alice'.padEnd(32, ' ');
// Generate new public/secret keypair for Alice from the supplied seed
const { secretKey, publicKey } = naclKeypairFromSeed(stringToU8a(seedAlice));
const { publicKey, secretKey } = naclKeypairFromSeed(stringToU8a(seedAlice));
// Encrypt message. Create Uint8Array's filled with random bytes of specified length
const secret = randomAsU8a(32);
@@ -1,6 +1,8 @@
/* eslint-disable header/header */
/* eslint-disable @typescript-eslint/unbound-method */
/* eslint-disable @typescript-eslint/require-await */
/* eslint-disable @typescript-eslint/no-var-requires,@typescript-eslint/no-unused-vars */
/* eslint-disable @typescript-eslint/no-unused-vars */
const { mnemonicGenerate, mnemonicToSeed, mnemonicValidate, naclKeypairFromSeed } = require('@polkadot/util-crypto');
async function main () {
@@ -19,7 +21,7 @@ async function main () {
const seedAlice = mnemonicToSeed(mnemonicAlice);
// Generate new public/secret keypair for Alice from the supplied seed
const { secretKey, publicKey } = naclKeypairFromSeed(seedAlice);
const { publicKey, secretKey } = naclKeypairFromSeed(seedAlice);
// Encrypt, Sign and Validate the message. See Example 'Sign & Verify Message'
}
@@ -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"
}
}
+5 -1
View File
@@ -1,10 +1,14 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
// 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.
const config = require('@polkadot/dev/config/jest');
module.exports = Object.assign({}, config, {
moduleNameMapper: {
'@polkadot/keyring(.*)$': '<rootDir>/packages/keyring/src/$1',
'@polkadot/util-(crypto)(.*)$': '<rootDir>/packages/util-$1/src/$2',
// eslint-disable-next-line sort-keys
'@polkadot/util(.*)$': '<rootDir>/packages/util/src/$1'
},
modulePathIgnorePatterns: [
-1
View File
@@ -1,7 +1,6 @@
// 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.
/* eslint-disable @typescript-eslint/no-var-requires */
const path = require('path');
+1 -1
View File
@@ -9,5 +9,5 @@
"packages": [
"packages/*"
],
"version": "2.6.2"
"version": "2.9.1"
}
+6 -3
View File
@@ -11,7 +11,9 @@
},
"scripts": {
"build": "polkadot-dev-build-ts",
"build:release": "polkadot-ci-ghact-build",
"docs": "polkadot-dev-build-docs",
"docs:release": "polkadot-ci-ghact-docs",
"lint": "polkadot-dev-run-lint",
"clean": "polkadot-dev-clean-build",
"postinstall": "polkadot-dev-yarn-only",
@@ -19,8 +21,9 @@
"test:one": "polkadot-dev-run-test"
},
"devDependencies": {
"@babel/core": "^7.8.7",
"@polkadot/dev": "^0.50.30",
"@polkadot/ts": "^0.3.7"
"@babel/core": "^7.9.0",
"@polkadot/dev": "^0.52.11",
"@polkadot/ts": "^0.3.18",
"@types/jest": "^25.2.1"
}
}
+4 -4
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/keyring",
"version": "2.6.2",
"version": "2.9.1",
"description": "Keyring management",
"main": "index.js",
"publishConfig": {
@@ -27,8 +27,8 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/keyring#readme",
"dependencies": {
"@babel/runtime": "^7.8.7",
"@polkadot/util": "2.6.2",
"@polkadot/util-crypto": "2.6.2"
"@babel/runtime": "^7.9.2",
"@polkadot/util": "2.9.1",
"@polkadot/util-crypto": "2.9.1"
}
}
+65
View File
@@ -147,4 +147,69 @@ describe('keypair', (): void => {
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);
});
});
});
+20 -16
View File
@@ -2,11 +2,11 @@
// This software may be modified and distributed under the terms
// 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 { assert, hexToU8a, isHex, 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 createPair from './pair';
@@ -40,7 +40,7 @@ export default class Keyring implements KeyringInstance {
constructor (options: KeyringOptions = {}) {
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.#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 {
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 {
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.
*/
public addFromSeed (seed: Uint8Array, meta: KeyringPair$Meta = {}, type: KeypairType = this.type): KeyringPair {
const keypair = type === 'sr25519'
? schnorrkelFromSeed(seed)
: naclFromSeed(seed);
const keypair = {
ecdsa: (): Keypair => secp256k1FromSeed(seed),
ed25519: (): Keypair => naclFromSeed(seed),
sr25519: (): Keypair => schnorrkelFromSeed(seed)
}[type]();
return this.addPair(createPair({ toSS58: this.encodeAddress, type }, keypair, meta, null));
}
@@ -153,8 +155,8 @@ export default class Keyring implements KeyringInstance {
const suri = _suri.startsWith('//')
? `${DEV_PHRASE}${_suri}`
: _suri;
const { password, phrase, path } = keyExtractSuri(suri);
let seed;
const { password, path, phrase } = keyExtractSuri(suri);
let seed: Uint8Array;
if (isHex(phrase, 256)) {
seed = hexToU8a(phrase);
@@ -175,10 +177,12 @@ export default class Keyring implements KeyringInstance {
}
}
const keypair = type === 'sr25519'
? schnorrkelFromSeed(seed)
: naclFromSeed(seed);
const derived = keyFromPath(keypair, path, type);
const keypair = {
ecdsa: (): Keypair => secp256k1FromSeed(seed),
ed25519: (): Keypair => naclFromSeed(seed),
sr25519: (): Keypair => schnorrkelFromSeed(seed)
};
const derived = keyFromPath(keypair[type](), path, type);
return createPair({ toSS58: this.encodeAddress, type }, derived, meta, null);
}
@@ -187,8 +191,8 @@ export default class Keyring implements KeyringInstance {
* @name encodeAddress
* @description Encodes the input into an ss58 representation
*/
public encodeAddress = (key: Uint8Array | string, ss58Format?: number): string => {
return encodeAddress(key, ss58Format || this.#ss58);
public encodeAddress = (address: Uint8Array | string, ss58Format?: number): string => {
return encodeAddress(address, ss58Format || this.#ss58);
}
/**
+10
View File
@@ -80,6 +80,7 @@ describe('pair', (): void => {
const encoded = keyring.alice.encodePkcs8(PASS);
const pair = createPair({ toSS58, type: 'sr25519' }, { publicKey: keyring.alice.publicKey });
pair.decodePkcs8(PASS, encoded);
expect(pair.isLocked).toEqual(false);
@@ -93,4 +94,13 @@ describe('pair', (): void => {
expect(stash.publicKey).toEqual(PAIRS[1].publicKey);
expect(soft.address).toEqual('5ECQNn7UueWHPFda5qUi4fTmTtyCnPvGnuoyVVSj5CboJh9J');
});
it('fails to sign when locked', (): void => {
const pair = createPair({ toSS58, type: 'sr25519' }, { publicKey: keyring.alice.publicKey });
expect(pair.isLocked).toEqual(true);
expect((): Uint8Array =>
pair.sign(new Uint8Array([0]))
).toThrow('Cannot sign with a locked key pair');
});
});
+51 -28
View File
@@ -6,8 +6,8 @@ import { Keypair, KeypairType } from '@polkadot/util-crypto/types';
import { KeyringPair, KeyringPair$Json, KeyringPair$Meta, SignOptions } from '../types';
import { PairInfo } from './types';
import { u8aConcat, assert } from '@polkadot/util';
import { keyExtractPath, keyFromPath, naclKeypairFromSeed as naclFromSeed, naclSign, naclVerify, schnorrkelKeypairFromSeed as schnorrkelFromSeed, schnorrkelSign, schnorrkelVerify } from '@polkadot/util-crypto';
import { assert, u8aConcat } from '@polkadot/util';
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 encode from './encode';
@@ -21,45 +21,64 @@ interface Setup {
const SIG_TYPE_NONE = new Uint8Array();
const SIG_TYPE_ED25519 = new Uint8Array([0]);
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 {
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 {
return isSr25519(type)
? schnorrkelFromSeed(seed)
: naclFromSeed(seed);
return {
ecdsa: (): Keypair => secp256k1FromSeed(seed),
ed25519: (): Keypair => naclFromSeed(seed),
sr25519: (): Keypair => schnorrkelFromSeed(seed)
}[type]();
}
function multiSignaturePrefix (type: KeypairType): Uint8Array {
return isSr25519(type)
? SIG_TYPE_SR25519
: SIG_TYPE_ED25519;
return {
ecdsa: SIG_TYPE_ECDSA,
ed25519: SIG_TYPE_ED25519,
sr25519: SIG_TYPE_SR25519
}[type];
}
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(
// for multi-signatures, i.e. with indicator, append the signature type as per
// the MultiSignature enum
withType
? multiSignaturePrefix(type)
: SIG_TYPE_NONE,
isSr25519(type)
? schnorrkelSign(message, pair)
: naclSign(message, pair)
signature
);
}
function verify (type: KeypairType, message: Uint8Array, signature: Uint8Array, publicKey: Uint8Array): boolean {
return isSr25519(type)
? schnorrkelVerify(message, signature, publicKey)
: naclVerify(message, signature, publicKey);
return {
ecdsa: (): boolean => secp256k1Verify(message, signature, blake2AsU8a(publicKey, 256)),
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
function isLocked (secretKey?: Uint8Array): secretKey is undefined {
return !secretKey || secretKey.length === 0 || isEmpty(secretKey);
}
/**
@@ -96,20 +115,21 @@ function verify (type: KeypairType, message: Uint8Array, signature: Uint8Array,
export default function createPair ({ toSS58, type }: Setup, { publicKey, secretKey }: PairInfo, meta: KeyringPair$Meta = {}, encoded: Uint8Array | null = null): KeyringPair {
return {
get address (): string {
return toSS58(publicKey);
return toSS58(getAddress(type, publicKey));
},
get isLocked (): boolean {
return isLocked(secretKey);
},
get meta (): KeyringPair$Meta {
return meta;
},
get isLocked (): boolean {
return !secretKey || secretKey.length === 0 || isEmpty(secretKey);
},
get publicKey (): Uint8Array {
return publicKey;
},
get type (): KeypairType {
return type;
},
// eslint-disable-next-line sort-keys
decodePkcs8: (passphrase?: string, _encoded?: Uint8Array | null): void => {
const decoded = decode(passphrase, _encoded || encoded);
@@ -124,10 +144,10 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
}
},
derive: (suri: string, meta?: KeyringPair$Meta): KeyringPair => {
assert(secretKey, 'Cannot derive on a locked keypair');
assert(!isLocked(secretKey), 'Cannot derive on a locked keypair');
const { path } = keyExtractPath(suri);
const derived = keyFromPath({ publicKey, secretKey: secretKey }, path, type);
const derived = keyFromPath({ publicKey, secretKey }, path, type);
return createPair({ toSS58, type }, derived, meta, null);
},
@@ -139,10 +159,13 @@ export default function createPair ({ toSS58, type }: Setup, { publicKey, secret
setMeta: (additional: KeyringPair$Meta): void => {
meta = { ...meta, ...additional };
},
sign: (message: Uint8Array, options?: SignOptions): Uint8Array =>
sign(type, message, { publicKey, secretKey }, options),
sign: (message: Uint8Array, options?: SignOptions): Uint8Array => {
assert(!isLocked(secretKey), 'Cannot sign with a locked key pair');
return sign(type, message, { publicKey, secretKey }, options);
},
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(type, message, signature, publicKey)
};
+2 -2
View File
@@ -25,7 +25,6 @@ const json: KeyringPair$Json = {
export default function everybody (): KeyringPair {
const pair: KeyringPair = {
type: 'ed25519',
address,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
decodePkcs8: (passphrase?: string, encoded?: Uint8Array): void =>
@@ -36,11 +35,11 @@ export default function everybody (): KeyringPair {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
encodePkcs8: (passphrase?: string): Uint8Array =>
new Uint8Array(0),
meta,
isLocked: true,
lock: (): void => {
// no locking, it is always locked
},
meta,
publicKey,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
setMeta: (meta: KeyringPair$Meta): void =>
@@ -51,6 +50,7 @@ export default function everybody (): KeyringPair {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
toJson: (passphrase?: string): KeyringPair$Json =>
json,
type: 'ed25519',
// eslint-disable-next-line @typescript-eslint/no-unused-vars
verify: (message: Uint8Array, signature: Uint8Array): boolean =>
false
+2 -2
View File
@@ -19,8 +19,8 @@ describe('toJson', (): void => {
version: '2'
},
meta: {
name: 'alice',
isTesting: true
isTesting: true,
name: 'alice'
}
});
});
+3 -4
View File
@@ -6,15 +6,14 @@ import { KeypairType } from '@polkadot/util-crypto/types';
import { KeyringPair$Json, KeyringPair$Meta } from '../types';
import { u8aToHex } from '@polkadot/util';
import { encodeAddress } from '@polkadot/util-crypto';
type PairStateJson = KeyringPair$Meta & {
publicKey: Uint8Array;
address: string;
};
export default function toJson (type: KeypairType, { publicKey, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
export default function toJson (type: KeypairType, { address, meta }: PairStateJson, encoded: Uint8Array, isEncrypted: boolean): KeyringPair$Json {
return {
address: encodeAddress(publicKey),
address,
encoded: u8aToHex(encoded),
encoding: {
content: ['pkcs8', type],
+1 -1
View File
@@ -13,7 +13,7 @@ export default class Pairs implements KeyringPairs {
readonly #map: KeyringPairMap = {};
public add (pair: KeyringPair): KeyringPair {
this.#map[pair.publicKey.toString()] = pair;
this.#map[decodeAddress(pair.address).toString()] = pair;
return pair;
}
+16 -16
View File
@@ -23,44 +23,44 @@ interface PairDef {
// adding the keys when only the keyring is used.
export const PAIRS: PairDef[] = [
{
seed: 'Alice',
publicKey: hexToU8a('0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d'),
secretKey: hexToU8a('0x98319d4ff8a9508c4bb0cf0b5a78d760a0b2082c02775e6e82370816fedfff48925a225d97aa00682d6a59b95b18780c10d7032336e88f3442b42361f4a66011'),
publicKey: hexToU8a('0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d')
seed: 'Alice'
},
{
seed: 'Alice//stash',
publicKey: hexToU8a('0xbe5ddb1579b72e84524fc29e78609e3caf42e85aa118ebfe0b0ad404b5bdd25f'),
secretKey: hexToU8a('0xe8da6c9d810e020f5e3c7f5af2dea314cbeaa0d72bc6421e92c0808a0c584a6046ab28e97c3ffc77fe12b5a4d37e8cd4afbfebbf2391ffc7cb07c0f38c023efd'),
publicKey: hexToU8a('0xbe5ddb1579b72e84524fc29e78609e3caf42e85aa118ebfe0b0ad404b5bdd25f')
seed: 'Alice//stash'
},
{
seed: 'Bob',
publicKey: hexToU8a('0x8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48'),
secretKey: hexToU8a('0x081ff694633e255136bdb456c20a5fc8fed21f8b964c11bb17ff534ce80ebd5941ae88f85d0c1bfc37be41c904e1dfc01de8c8067b0d6d5df25dd1ac0894a325'),
publicKey: hexToU8a('0x8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48')
seed: 'Bob'
},
{
seed: 'Bob//stash',
publicKey: hexToU8a('0xfe65717dad0447d715f660a0a58411de509b42e6efb8375f562f58a554d5860e'),
secretKey: hexToU8a('0xc006507cdfc267a21532394c49ca9b754ca71de21e15a1cdf807c7ceab6d0b6c3ed408d9d35311540dcd54931933e67cf1ea10d46f75408f82b789d9bd212fde'),
publicKey: hexToU8a('0xfe65717dad0447d715f660a0a58411de509b42e6efb8375f562f58a554d5860e')
seed: 'Bob//stash'
},
{
seed: 'Charlie',
publicKey: hexToU8a('0x90b5ab205c6974c9ea841be688864633dc9ca8a357843eeacf2314649965fe22'),
secretKey: hexToU8a('0xa8f2d83016052e5d6d77b2f6fd5d59418922a09024cda701b3c34369ec43a7668faf12ff39cd4e5d92bb773972f41a7a5279ebc2ed92264bed8f47d344f8f18c'),
publicKey: hexToU8a('0x90b5ab205c6974c9ea841be688864633dc9ca8a357843eeacf2314649965fe22')
seed: 'Charlie'
},
{
seed: 'Dave',
publicKey: hexToU8a('0x306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc20'),
secretKey: hexToU8a('0x20e05482ca4677e0edbc58ae9a3a59f6ed3b1a9484ba17e64d6fe8688b2b7b5d108c4487b9323b98b11fe36cb301b084e920f7b7895536809a6d62a451b25568'),
publicKey: hexToU8a('0x306721211d5404bd9da88e0204360a1a9ab8b87c66c1bc2fcdd37f3c2222cc20')
seed: 'Dave'
},
{
seed: 'Eve',
publicKey: hexToU8a('0xe659a7a1628cdd93febc04a4e0646ea20e9f5f0ce097d9a05290d4a9e054df4e'),
secretKey: hexToU8a('0x683576abfd5dc35273e4264c23095a1bf21c14517bece57c7f0cc5c0ed4ce06a3dbf386b7828f348abe15d76973a72009e6ef86a5c91db2990cb36bb657c6587'),
publicKey: hexToU8a('0xe659a7a1628cdd93febc04a4e0646ea20e9f5f0ce097d9a05290d4a9e054df4e')
seed: 'Eve'
},
{
seed: 'Ferdie',
publicKey: hexToU8a('0x1cbd2d43530a44705ad088af313e18f80b53ef16b36177cd4b77b846f2a5f07c'),
secretKey: hexToU8a('0xb835c20f450079cf4f513900ae9faf8df06ad86c681884122c752a4b2bf74d4303e4f21bc6cc62bb4eeed5a9cce642c25e2d2ac1464093b50f6196d78e3a7426'),
publicKey: hexToU8a('0x1cbd2d43530a44705ad088af313e18f80b53ef16b36177cd4b77b846f2a5f07c')
seed: 'Ferdie'
}
];
-1
View File
@@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/class-name-casing */
// Copyright 2017-2020 @polkadot/keyring authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/util-crypto",
"version": "2.6.2",
"version": "2.9.1",
"description": "A collection of useful crypto utilities for @polkadot",
"main": "index.js",
"keywords": [
@@ -25,8 +25,8 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util-crypto#readme",
"dependencies": {
"@babel/runtime": "^7.8.7",
"@polkadot/util": "2.6.2",
"@babel/runtime": "^7.9.2",
"@polkadot/util": "2.9.1",
"@polkadot/wasm-crypto": "^1.2.1",
"base-x": "^3.0.8",
"bip39": "^3.0.2",
+7 -1
View File
@@ -4,14 +4,20 @@
import checkAddress from './check';
import checkAddressChecksum from './checkChecksum';
import createKeyMulti from './keyMulti';
import createKeySub from './keySub';
import decodeAddress from './decode';
import encodeAddress from './encode';
import setSS58Format from './setSS58Format';
import sortAddresses from './sort';
export {
checkAddress,
checkAddressChecksum,
createKeyMulti,
createKeySub,
decodeAddress,
encodeAddress,
setSS58Format
setSS58Format,
sortAddresses
};
@@ -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,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 BN from 'bn.js';
import { bnToU8a, compactToU8a, u8aConcat, u8aSorted } from '@polkadot/util';
import blake2AsU8a from '../blake2/asU8a';
import decodeAddress from './decode';
export default function createKeyMulti (who: (Uint8Array | string)[], threshold: BigInt | BN | number): Uint8Array {
return blake2AsU8a(
u8aConcat(
'modlpy/utilisuba',
compactToU8a(who.length),
...u8aSorted(who.map((who) => decodeAddress(who))),
bnToU8a(threshold, { bitLength: 16, isLe: true })
)
);
}
@@ -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 createKeySub from './keySub';
describe('createKeySub', (): void => {
it('matches sub accounts with Rust', (): void => {
expect(
createKeySub(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(
createKeySub('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,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 BN from 'bn.js';
import { bnToU8a, u8aConcat } from '@polkadot/util';
import blake2AsU8a from '../blake2/asU8a';
import decodeAddress from './decode';
export default function createKeySub (who: Uint8Array | string, index: BigInt | BN | number): Uint8Array {
return blake2AsU8a(
u8aConcat(
'modlpy/utilisuba',
decodeAddress(who),
bnToU8a(index, { 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'
]);
});
});
+16
View File
@@ -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 -4
View File
@@ -7,13 +7,16 @@ import { KeypairType, Keypair } from '../types';
import DeriveJunction from './DeriveJunction';
import keyHdkdEd15519 from './hdkdEd25519';
import keyHdkdSr15519 from './hdkdSr25519';
import keyHdkdEcdsa from './hdkdEcdsa';
export default function keyFromPath (pair: Keypair, path: DeriveJunction[], type: KeypairType): Keypair {
const isEd25519 = type === 'ed25519';
const keyHdkd = {
ecdsa: keyHdkdEcdsa,
ed25519: keyHdkdEd15519,
sr25519: keyHdkdSr15519
}[type];
return path.reduce((pair, junction): Keypair => {
return isEd25519
? keyHdkdEd15519(pair, junction)
: keyHdkdSr15519(pair, junction);
return keyHdkd(pair, junction);
}, pair);
}
+19
View File
@@ -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)
);
}
+1
View File
@@ -10,3 +10,4 @@ export { default as keyExtractSuri } from './extractSuri';
export { default as keyFromPath } from './fromPath';
export { default as keyHdkdEd25519 } from './hdkdEd25519';
export { default as keyHdkdSr25519 } from './hdkdEd25519';
export { default as keyHdkdEcdsa } from './hdkdEcdsa';
+11 -2
View File
@@ -13,8 +13,8 @@ describe('naclOpen', (): void => {
const receiver = naclKeypairFromString('receiver');
const senderBox = naclBoxKeypairFromSecret(sender.secretKey);
const receiverBox = naclBoxKeypairFromSecret(receiver.secretKey);
const { nonce, sealed } = naclSeal(message, senderBox.secretKey, receiverBox.publicKey);
const { sealed, nonce } = naclSeal(message, senderBox.secretKey, receiverBox.publicKey);
expect(
naclOpen(sealed, nonce, senderBox.publicKey, receiverBox.secretKey)
).toEqual(
@@ -32,16 +32,19 @@ describe('naclOpen', (): void => {
// Receiver sends encrypting public key to receive message to decrypt with his private key
const receiverIdBoxKey = naclBoxKeypairFromSecret(receiverIdKey.secretKey);
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey.publicKey}`);
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
const senderIdBoxKey = naclBoxKeypairFromSecret(senderIdKey.secretKey);
const message = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
const { sealed, nonce } = 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}`);
// Receiver opens encrypted message from the sender
let opened = naclOpen(sealed, nonce, senderIdBoxKey.publicKey, receiverIdBoxKey.secretKey);
console.log(`The sealed message is ${opened}`);
// Oh no the Id key is hacked, derive Id key again from another index
@@ -50,6 +53,7 @@ describe('naclOpen', (): void => {
// Receiver sends encrypting public key to receive message to decrypt with his private key
const receiverIdBoxKey2 = naclBoxKeypairFromSecret(receiverIdKey2.secretKey);
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey2.publicKey}`);
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
@@ -58,6 +62,7 @@ describe('naclOpen', (): void => {
let ctx = naclSeal(message2, senderIdBoxKey2.secretKey, receiverIdBoxKey2.publicKey);
const sealed2 = ctx.sealed;
const nonce2 = ctx.nonce;
console.log(`Sender sends encrypted message to receiver ${sealed}, ${nonce}`);
// Receiver opens encrypted message from the sender
@@ -67,14 +72,18 @@ describe('naclOpen', (): void => {
// This time derive key for each message to send and receive
// Receiver sends encrypting public key to receive message to decrypt with his private key
const receiverIdBoxKey2One = naclBoxKeypairFromSecret(receiverIdBoxKey2.secretKey);
console.log(`Receiver sends receiver's public key to sender ${receiverIdBoxKey2One.publicKey}`);
// Sender encrypts message to send with the public key the receiver sent and send it to receiver
const senderIdBoxKey2One = naclBoxKeypairFromSecret(senderIdBoxKey2.secretKey);
const message3 = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
ctx = naclSeal(message3, senderIdBoxKey2One.secretKey, receiverIdBoxKey2One.publicKey);
const sealed3 = ctx.sealed;
const nonce3 = ctx.nonce;
console.log(`Sender sends encrypted message to receiver ${sealed3}, ${nonce3}`);
// Receiver opens encrypted message from the sender
+3 -2
View File
@@ -13,11 +13,12 @@ describe('naclSeal', (): void => {
const receiverBox = naclBoxKeypairFromSecret(receiver.secretKey);
const senderBoxSecret = senderBox.secretKey;
const receiverBoxPublic = receiverBox.publicKey;
expect(
naclSeal(message, senderBoxSecret, receiverBoxPublic, new Uint8Array(24))
).toEqual({
sealed: new Uint8Array([137, 195, 104, 255, 67, 199, 40, 235, 148, 177, 180, 73, 239, 131, 215, 80, 61, 191, 167, 213, 152, 138, 5, 47, 135]),
nonce: new Uint8Array(24)
nonce: new Uint8Array(24),
sealed: new Uint8Array([137, 195, 104, 255, 67, 199, 40, 235, 148, 177, 180, 73, 239, 131, 215, 80, 61, 191, 167, 213, 152, 138, 5, 47, 135])
});
});
});
+2 -2
View File
@@ -27,7 +27,7 @@ interface Sealed {
*/
export default function naclSeal (message: Uint8Array, senderBoxSecret: Uint8Array, receiverBoxPublic: Uint8Array, nonce: Uint8Array = randomAsU8a(24)): Sealed {
return {
sealed: nacl.box(message, nonce, receiverBoxPublic, senderBoxSecret),
nonce
nonce,
sealed: nacl.box(message, nonce, receiverBoxPublic, senderBoxSecret)
};
}
+13
View File
@@ -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.
export function isReady (): boolean {
// always false, when true it will try and use non-existent functions
return false;
}
export function waitReady (): Promise<boolean> {
// always immediate true, our process is done
return Promise.resolve(true);
}
@@ -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
// 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 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,24 @@
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import { 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: ' + 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;
@@ -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,29 @@
// Copyright 2017-2020 @polkadot/util-crypto authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import { 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(
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_SR = 'EK1bFgKm2FsghcttHT7TB7rNyXApFgs9fCbijMGQNyFGBQm';
const ADDR_EC = 'XyFVXiGaHxoBhXZkSh6NS2rjFyVaVNUo5UiZDqZbuSfUdji';
const MESSAGE = 'hello world';
const SIG_ED = '0x299d3bf4c8bb51af732f8067b3a3015c0862a5ff34721749d8ed6577ea2708365d1c5f76bd519009971e41156f12c70abc2533837ceb3bad9a05a99ab923de06';
const SIG_SR = '0xca01419b5a17219f7b78335658cab3b126db523a5df7be4bfc2bef76c2eb3b1dcf4ca86eb877d0a6cf6df12db5995c51d13b00e005d053b892bd09c594434288';
const SIG_EC = '0x994638ee586d2c5dbd9bacacbc35d9b7e9018de8f7892f00c900db63bc57b1283e2ee7bc51a9b1c1dae121ac4f4b9e2a41cd1d6bf4bb3e24d7fed6faf6d85e0501';
const MUL_ED = u8aToHex(u8aConcat(new Uint8Array([0]), hexToU8a(SIG_ED)));
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 => {
beforeEach(async (): Promise<void> => {
@@ -24,7 +27,7 @@ describe('signatureVerify', (): void => {
it('throws on invalid signature length', (): void => {
expect(
() => 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 => {
@@ -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 => {
expect(signatureVerify(MESSAGE, SIG_SR, ADDR_SR)).toEqual({
crypto: 'sr25519',
@@ -58,16 +68,6 @@ describe('signatureVerify', (): 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 => {
expect(signatureVerify(MESSAGE, MUL_ED, ADDR_ED)).toEqual({
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 => {
expect(signatureVerify(MESSAGE, MUL_SR, ADDR_SR)).toEqual({
crypto: 'sr25519',
+25 -14
View File
@@ -9,10 +9,18 @@ import { assert, u8aToU8a } from '@polkadot/util';
import addressDecode from '../address/decode';
import naclVerify from '../nacl/verify';
import schnorrkelVerify from '../schnorrkel/verify';
import secp256k1Verify from '../secp256k1/verify';
const VERIFIERS: [KeypairType, (message: Uint8Array | string, signature: Uint8Array | string, publicKey: Uint8Array | string) => boolean][] = [
['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 {
@@ -34,18 +42,17 @@ function verifyDetect (result: VerifyResult, message: Uint8Array | string, signa
}
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 = isEd25519
? 'ed25519'
: 'sr25519';
result.crypto = CRYPTO_TYPES[signature[0]] || 'none';
try {
result.isValid = isEd25519
? naclVerify(message, signature.subarray(1), publicKey)
: schnorrkelVerify(message, signature.subarray(1), publicKey);
result.isValid = {
ecdsa: (): boolean => secp256k1Verify(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) {
// ignore, result.isValid still set to false
}
@@ -56,12 +63,16 @@ function verifyMultisig (result: VerifyResult, message: Uint8Array | string, sig
export default function signatureVerify (message: Uint8Array | string, signature: Uint8Array | string, addressOrPublicKey: Uint8Array | string): VerifyResult {
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 publicKey = addressDecode(addressOrPublicKey);
return signatureU8a.length === 65
? verifyMultisig(result, message, signatureU8a, publicKey)
: verifyDetect(result, message, signatureU8a, publicKey);
const multisig = [0, 1, 2].includes(signatureU8a[0]) && [65, 66].includes(signatureU8a.length);
if (multisig) {
return verifyMultisig(result, message, signatureU8a, publicKey);
} else {
return verifyDetect(result, message, signatureU8a, publicKey);
}
}
+1 -1
View File
@@ -12,7 +12,7 @@ export interface Seedpair {
seed: Uint8Array;
}
export type KeypairType = 'ed25519' | 'sr25519';
export type KeypairType = 'ed25519' | 'sr25519' | 'ecdsa';
export interface VerifyResult {
crypto: 'none' | KeypairType;
+3 -3
View File
@@ -1,6 +1,6 @@
{
"name": "@polkadot/util",
"version": "2.6.2",
"version": "2.9.1",
"description": "A collection of useful utilities for @polkadot",
"main": "index.js",
"keywords": [
@@ -25,11 +25,11 @@
},
"homepage": "https://github.com/polkadot-js/common/tree/master/packages/util#readme",
"dependencies": {
"@babel/runtime": "^7.8.7",
"@babel/runtime": "^7.9.2",
"@types/bn.js": "^4.11.6",
"bn.js": "^5.1.1",
"camelcase": "^5.3.1",
"chalk": "^3.0.0",
"chalk": "^4.0.0",
"ip-regex": "^4.1.0"
}
}
+1
View File
@@ -9,6 +9,7 @@
export { default as bnFromHex } from './fromHex';
export { default as bnMax } from './max';
export { default as bnMin } from './min';
export { default as bnSqrt } from './sqrt';
export { default as bnToBn } from './toBn';
export { default as bnToHex } from './toHex';
export { default as bnToU8a } from './toU8a';
+3 -3
View File
@@ -7,16 +7,16 @@ import BN from 'bn.js';
import assert from '../assert';
/**
* @name max
* @name bnMax
* @summary Finds and returns the highest value in an array of BNs.
* @example
* <BR>
*
* ```javascript
* import BN from 'bn.js';
* import { max } from '@polkadot/util';
* import { bnMax } from '@polkadot/util';
*
* max([new BN(1), new BN(3), new BN(2)]).toString(); // => '3'
* bnMax([new BN(1), new BN(3), new BN(2)]).toString(); // => '3'
* ```
*/
export default function max (...items: BN[]): BN {
+3 -3
View File
@@ -7,16 +7,16 @@ import BN from 'bn.js';
import assert from '../assert';
/**
* @name min
* @name bnMin
* @summary Finds and returns the smallest value in an array of BNs.
* @example
* <BR>
*
* ```javascript
* import BN from 'bn.js';
* import { min } from '@polkadot/util';
* import { bnMin } from '@polkadot/util';
*
* min([new BN(1), new BN(3), new BN(2)]).toString(); // => '1'
* bnMin([new BN(1), new BN(3), new BN(2)]).toString(); // => '1'
* ```
*/
export default function min (...items: BN[]): BN {
+33
View File
@@ -0,0 +1,33 @@
// 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';
import { bnSqrt } from '.';
describe('bnSqrt', (): void => {
it('fails on < 0 roots', (): void => {
expect(
() => bnSqrt(new BN(-1))
).toThrow(/negative numbers is not supported/);
});
it('finds the sqrt (exact)', (): void => {
expect(
bnSqrt(new BN(256).mul(new BN(256)))
).toEqual(new BN(256));
});
it('finds the sqrt (round)', (): void => {
expect(
bnSqrt(new BN(266))
).toEqual(new BN(16));
});
it('find the sqrt for 1', (): void => {
expect(
bnSqrt(new BN(1))
).toEqual(new BN(1));
});
});
+39
View File
@@ -0,0 +1,39 @@
// 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';
import assert from '../assert';
// https://golb.hplar.ch/2018/09/javascript-bigint.html
function newtonIteration (n: BN, x0: BN): BN {
const x1 = n.div(x0).add(x0).shrn(1);
if (x0.eq(x1) || x0.eq(x1.subn(1))) {
return x0;
}
return newtonIteration(n, x1);
}
/**
* @name bnSqrt
* @summary Calculates the integer square root of a BN
* @example
* <BR>
*
* ```javascript
* import BN from 'bn.js';
* import { bnSqrt } from '@polkadot/util';
*
* bnSqrt(new BN(16)).toString(); // => '4'
* ```
*/
export default function sqrt (value: BN): BN {
assert(value.gten(0), 'square root of negative numbers is not supported');
return value.ltn(2)
? value
: newtonIteration(value, new BN(1));
}
+2 -2
View File
@@ -46,8 +46,8 @@ describe('bnToBn', (): void => {
it('converts Compact to BN', (): void => {
expect(
bnToBn({
toBn: (): BN => new BN(1234),
something: 'test'
something: 'test',
toBn: (): BN => new BN(1234)
}).toNumber()
).toEqual(1234);
});
+2 -2
View File
@@ -45,13 +45,13 @@ describe('bnToU8a', (): void => {
it('converts negative numbers (BE)', (): void => {
expect(
bnToU8a(new BN(-1234), { isNegative: true, isLe: false })
bnToU8a(new BN(-1234), { isLe: false, isNegative: true })
).toEqual(new Uint8Array([251, 46]));
});
it('converts negative numbers (bitLength)', (): void => {
expect(
bnToU8a(new BN(-1234), { isNegative: true, bitLength: 32 })
bnToU8a(new BN(-1234), { bitLength: 32, isNegative: true })
).toEqual(new Uint8Array([46, 251, 255, 255]));
});
+1 -1
View File
@@ -30,9 +30,9 @@ function bnToU8a (value: BN | BigInt | number | null, options?: Options): Uint8A
function bnToU8a (value: BN | BigInt | number | null, bitLength?: number, isLe?: boolean): Uint8Array;
function bnToU8a (value: BN | BigInt | number | null, arg1: number | Options = { bitLength: -1, isLe: true, isNegative: false }, arg2?: boolean): Uint8Array {
const _options: Options = {
bitLength: -1,
isLe: true,
isNegative: false,
bitLength: -1,
...isNumber(arg1) ? { bitLength: arg1, isLe: arg2 } : arg1
};
+15 -15
View File
@@ -76,20 +76,20 @@ describe('encode', (): void => {
describe('from Rust', (): void => {
// Copied from https://github.com/paritytech/parity-codec/blob/master/src/codec.rs
const testCases = [
{ value: new BN('0'), expected: '00' },
{ value: new BN('63'), expected: 'fc' },
{ value: new BN('64'), expected: '01 01' },
{ value: new BN('16383'), expected: 'fd ff' },
{ value: new BN('16384'), expected: '02 00 01 00' },
{ value: new BN('1073741823'), expected: 'fe ff ff ff' },
{ value: new BN('1073741824'), expected: '03 00 00 00 40' },
{ value: new BN(`${1}${'0'.repeat(32)}`, 2).subn(1), expected: '03 ff ff ff ff' },
{ value: new BN(`${1}${'0'.repeat(32)}`, 2), expected: '07 00 00 00 00 01' },
{ value: new BN(`${1}${'0'.repeat(40)}`, 2), expected: '0b 00 00 00 00 00 01' },
{ value: new BN(`${1}${'0'.repeat(48)}`, 2), expected: '0f 00 00 00 00 00 00 01' },
{ value: new BN(`${1}${'0'.repeat(56)}`, 2).subn(1), expected: '0f ff ff ff ff ff ff ff' },
{ value: new BN(`${1}${'0'.repeat(56)}`, 2), expected: '13 00 00 00 00 00 00 00 01' },
{ value: new BN(`${1}${'0'.repeat(64)}`, 2).subn(1), expected: '13 ff ff ff ff ff ff ff ff' }
{ expected: '00', value: new BN('0') },
{ expected: 'fc', value: new BN('63') },
{ expected: '01 01', value: new BN('64') },
{ expected: 'fd ff', value: new BN('16383') },
{ expected: '02 00 01 00', value: new BN('16384') },
{ expected: 'fe ff ff ff', value: new BN('1073741823') },
{ expected: '03 00 00 00 40', value: new BN('1073741824') },
{ expected: '03 ff ff ff ff', value: new BN(`${1}${'0'.repeat(32)}`, 2).subn(1) },
{ expected: '07 00 00 00 00 01', value: new BN(`${1}${'0'.repeat(32)}`, 2) },
{ expected: '0b 00 00 00 00 00 01', value: new BN(`${1}${'0'.repeat(40)}`, 2) },
{ expected: '0f 00 00 00 00 00 00 01', value: new BN(`${1}${'0'.repeat(48)}`, 2) },
{ expected: '0f ff ff ff ff ff ff ff', value: new BN(`${1}${'0'.repeat(56)}`, 2).subn(1) },
{ expected: '13 00 00 00 00 00 00 00 01', value: new BN(`${1}${'0'.repeat(56)}`, 2) },
{ expected: '13 ff ff ff ff ff ff ff ff', value: new BN(`${1}${'0'.repeat(64)}`, 2).subn(1) }
];
function testEncode (value: BN, expected: string): void {
@@ -104,6 +104,6 @@ describe('encode', (): void => {
});
}
testCases.forEach(({ value, expected }): void => testEncode(value, expected));
testCases.forEach(({ expected, value }): void => testEncode(value, expected));
});
});
+19 -18
View File
@@ -17,13 +17,13 @@ describe('formatBalance', (): void => {
it('formats 123,456,789,000 (decimals=15)', (): void => {
expect(
formatBalance(TESTVAL, { withSi: true, decimals: 15 })
formatBalance(TESTVAL, { decimals: 15, withSi: true })
).toEqual('123.456µ Unit');
});
it('formats BigInt numbers', (): void => {
expect(
formatBalance(123_456_789_000n, { withSi: true, decimals: 15 })
formatBalance(123_456_789_000n, { decimals: 15, withSi: true })
).toEqual('123.456µ Unit');
});
@@ -35,24 +35,25 @@ describe('formatBalance', (): void => {
it('formats 123,456,789,000 (decimals=36, option)', (): void => {
expect(
formatBalance(TESTVAL, { withSi: true, decimals: 36 })
formatBalance(TESTVAL, { decimals: 36, withSi: true })
).toEqual('0.123y Unit');
});
it('formats 123,456,789,000 (decimals=15, Compact)', (): void => {
const compact = {
something: 'else',
toBn: (): BN => TESTVAL,
unwrap: (): BN => TESTVAL,
something: 'else'
unwrap: (): BN => TESTVAL
};
expect(
formatBalance(compact, { withSi: true, decimals: 15 })
formatBalance(compact, { decimals: 15, withSi: true })
).toEqual('123.456µ Unit');
});
it('formats 123,456,789,000 (decimals=12)', (): void => {
expect(
formatBalance(TESTVAL, { withSi: true, decimals: 12 })
formatBalance(TESTVAL, { decimals: 12, withSi: true })
).toEqual('123.456m Unit');
});
@@ -173,13 +174,13 @@ describe('formatBalance', (): void => {
it('finds the SI value', (): void => {
expect(
formatBalance.findSi('k')
).toEqual({ power: 3, value: 'k', text: 'Kilo' });
).toEqual({ power: 3, text: 'Kilo', value: 'k' });
});
it('returns default on not found', (): void => {
expect(
formatBalance.findSi('blah')
).toEqual({ power: 0, value: '-', text: 'Unit' });
).toEqual({ power: 0, text: 'Unit', value: '-' });
});
});
@@ -214,15 +215,15 @@ describe('formatBalance', (): void => {
expect(
formatBalance.getOptions()
).toEqual([
{ power: 0, value: '-', text: 'TEST' },
{ power: 3, value: 'k', text: 'Kilo' },
{ power: 6, value: 'M', text: 'Mega' },
{ power: 9, value: 'G', text: 'Giga' },
{ power: 12, value: 'T', text: 'Tera' },
{ power: 15, value: 'P', text: 'Peta' },
{ power: 18, value: 'E', text: 'Exa' },
{ power: 21, value: 'Z', text: 'Zeta' },
{ power: 24, value: 'Y', text: 'Yotta' }
{ power: 0, text: 'TEST', value: '-' },
{ power: 3, text: 'Kilo', value: 'k' },
{ power: 6, text: 'Mega', value: 'M' },
{ power: 9, text: 'Giga', value: 'G' },
{ power: 12, text: 'Tera', value: 'T' },
{ power: 15, text: 'Peta', value: 'P' },
{ power: 18, text: 'Exa', value: 'E' },
{ power: 21, text: 'Zeta', value: 'Z' },
{ power: 24, text: 'Yotta', value: 'Y' }
]);
});
});
+17 -17
View File
@@ -7,23 +7,23 @@ import { SiDef } from '../types';
export const SI_MID = 8;
export const SI: SiDef[] = [
{ power: -24, value: 'y', text: 'yocto' },
{ power: -21, value: 'z', text: 'zepto' },
{ power: -18, value: 'a', text: 'atto' },
{ power: -15, value: 'f', text: 'femto' },
{ power: -12, value: 'p', text: 'pico' },
{ power: -9, value: 'n', text: 'nano' },
{ power: -6, value: 'µ', text: 'micro' },
{ power: -3, value: 'm', text: 'milli' },
{ power: 0, value: '-', text: 'Unit' }, // position 8
{ power: 3, value: 'k', text: 'Kilo' },
{ power: 6, value: 'M', text: 'Mega' },
{ power: 9, value: 'G', text: 'Giga' },
{ power: 12, value: 'T', text: 'Tera' },
{ power: 15, value: 'P', text: 'Peta' },
{ power: 18, value: 'E', text: 'Exa' },
{ power: 21, value: 'Z', text: 'Zeta' },
{ power: 24, value: 'Y', text: 'Yotta' }
{ power: -24, text: 'yocto', value: 'y' },
{ power: -21, text: 'zepto', value: 'z' },
{ power: -18, text: 'atto', value: 'a' },
{ power: -15, text: 'femto', value: 'f' },
{ power: -12, text: 'pico', value: 'p' },
{ power: -9, text: 'nano', value: 'n' },
{ power: -6, text: 'micro', value: 'µ' },
{ power: -3, text: 'milli', value: 'm' },
{ power: 0, text: 'Unit', value: '-' }, // position 8
{ power: 3, text: 'Kilo', value: 'k' },
{ power: 6, text: 'Mega', value: 'M' },
{ power: 9, text: 'Giga', value: 'G' },
{ power: 12, text: 'Tera', value: 'T' },
{ power: 15, text: 'Peta', value: 'P' },
{ power: 18, text: 'Exa', value: 'E' },
{ power: 21, text: 'Zeta', value: 'Z' },
{ power: 24, text: 'Yotta', value: 'Y' }
];
// Given a SI type (e.g. k, m, Y) find the SI definition
+1 -1
View File
@@ -2,7 +2,7 @@
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
const re = new RegExp('^(Development|Local Testnet)$');
const re = new RegExp('(Development|Local Testnet)$');
export default function isTestChain (chain?: string | null): boolean {
if (!chain) {
+4 -3
View File
@@ -1,10 +1,11 @@
/* eslint-disable @typescript-eslint/ban-ts-ignore */
/* eslint-disable no-extend-native */
/* eslint-disable @typescript-eslint/unbound-method */
// 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.
/* eslint-disable @typescript-eslint/ban-ts-ignore */
/* eslint-disable no-extend-native */
/* eslint-disable @typescript-eslint/unbound-method */
describe('Array.fill', (): void => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let arrayFill: (value: any, start?: number | undefined, end?: number | undefined) => any[];
+3 -2
View File
@@ -1,9 +1,10 @@
/* eslint-disable no-extend-native */
/* eslint-disable @typescript-eslint/unbound-method */
// 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.
/* eslint-disable no-extend-native */
/* eslint-disable @typescript-eslint/unbound-method */
if (!Array.prototype.fill) {
// eslint-disable-next-line no-extend-native,@typescript-eslint/no-explicit-any
Array.prototype.fill = function fill (value: any, start = 0, end?: number): any[] {
+2 -1
View File
@@ -1,8 +1,9 @@
/* eslint-disable @typescript-eslint/unbound-method */
// 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.
/* eslint-disable @typescript-eslint/unbound-method */
describe('String padEnd', (): void => {
let stringEnd: (length: number, fill?: string) => string;
+3 -2
View File
@@ -1,9 +1,10 @@
/* eslint-disable no-extend-native */
/* eslint-disable @typescript-eslint/unbound-method */
// 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.
/* eslint-disable no-extend-native */
/* eslint-disable @typescript-eslint/unbound-method */
if (!String.prototype.padEnd) {
String.prototype.padEnd = function padEnd (length: number, char = ' '): string {
let result = String(this);
+2 -1
View File
@@ -1,8 +1,9 @@
/* eslint-disable @typescript-eslint/unbound-method */
// 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.
/* eslint-disable @typescript-eslint/unbound-method */
describe('String padStart', (): void => {
let stringStart: (length: number, fill?: string) => string;
+3 -2
View File
@@ -1,9 +1,10 @@
/* eslint-disable no-extend-native */
/* eslint-disable @typescript-eslint/unbound-method */
// 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.
/* eslint-disable no-extend-native */
/* eslint-disable @typescript-eslint/unbound-method */
if (!String.prototype.padStart) {
String.prototype.padStart = function padStart (length: number, char = ' '): string {
let result = String(this);
@@ -1,10 +1,11 @@
/* eslint-disable no-proto */
/* eslint-disable @typescript-eslint/ban-ts-ignore */
/* eslint-disable @typescript-eslint/unbound-method */
// 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.
/* eslint-disable no-proto */
/* eslint-disable @typescript-eslint/ban-ts-ignore */
/* eslint-disable @typescript-eslint/unbound-method */
describe('setPrototypeOf', (): void => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let orig: (o: any, proto: object | null) => any;
+2 -1
View File
@@ -1,8 +1,9 @@
/* eslint-disable @typescript-eslint/unbound-method */
// 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.
/* eslint-disable @typescript-eslint/unbound-method */
// React Native does not have Object.setPrototypeOf
if (!Object.setPrototypeOf) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
+1 -1
View File
@@ -1,10 +1,10 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
// 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.
if (typeof TextDecoder === 'undefined') {
try {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(global as any).TextDecoder = require('util').TextDecoder;
} catch (error) {
// noop
+2 -3
View File
@@ -22,9 +22,8 @@ import u8aToU8a from './toU8a';
* ```
*/
export default function u8aConcat (..._list: (Uint8Array | string)[]): Uint8Array {
const list: Uint8Array[] = _list.map(u8aToU8a);
const length = list.reduce((total, item): number => total + item.length, 0);
const result = new Uint8Array(length);
const list = _list.map(u8aToU8a);
const result = new Uint8Array(list.reduce((total, item): number => total + item.length, 0));
let offset = 0;
return list.reduce((result, item): Uint8Array => {
+1
View File
@@ -8,6 +8,7 @@
export { default as u8aConcat } from './concat';
export { default as u8aFixLength } from './fixLength';
export { default as u8aSorted } from './sorted';
export { default as u8aToBn } from './toBn';
export { default as u8aToBuffer } from './toBuffer';
export { default as u8aToHex } from './toHex';
+19
View File
@@ -0,0 +1,19 @@
// 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 { u8aSorted } from '.';
describe('u8aSorted', (): void => {
it('sorts a simple set of u8a', (): void => {
expect(
u8aSorted([new Uint8Array([1, 2, 3]), new Uint8Array([4, 5, 6]), new Uint8Array([2, 3, 4])])
).toEqual([new Uint8Array([1, 2, 3]), new Uint8Array([2, 3, 4]), new Uint8Array([4, 5, 6])]);
});
it('sorts a simple set of u8a (not the same lengths)', (): void => {
expect(
u8aSorted([new Uint8Array([1, 2, 3, 4]), new Uint8Array([4, 5, 6]), new Uint8Array([1, 2, 3, 5])])
).toEqual([new Uint8Array([1, 2, 3, 4]), new Uint8Array([1, 2, 3, 5]), new Uint8Array([4, 5, 6])]);
});
});
+29
View File
@@ -0,0 +1,29 @@
// 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 isUndefined from '../is/undefined';
export default function u8aSorted (u8as: Uint8Array[]): Uint8Array[] {
return u8as.sort((a, b): number => {
let i = 0;
while (true) {
if (isUndefined(a[i]) && isUndefined(b[i])) {
return 0;
} else if (isUndefined(a[i])) {
return -1;
} else if (isUndefined(b[i])) {
return 1;
}
const cmp = a[i] - b[i];
if (cmp !== 0) {
return cmp;
}
i++;
}
});
}
+7 -3
View File
@@ -1,15 +1,19 @@
// 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.
module.exports = {
name: 'Polkadot JS Common',
exclude: '**/*+(index|e2e|spec).ts',
excludeExternals: true,
excludeNotExported: true,
excludeProtected: true,
excludePrivate: true,
excludeProtected: true,
hideGenerator: true,
includeDeclarations: false,
out: 'docs',
module: 'commonjs',
moduleResolution: 'node',
name: 'Polkadot JS Common',
out: 'docs',
stripInternal: 'true',
theme: 'markdown'
};
+1567 -1401
View File
File diff suppressed because it is too large Load Diff