Merge branch 'develop'

Author: RomeroYang

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.3.5] - 20211018
+
+* bump polkadot-js/api v6.4.1
+* add apiKeyring.checkMnemonicValid()
+
 ## [0.3.4] - 20211012
 
 * bump polkadot-js/api v6.3.1

js_api/dist/main.js

@@ -1,6 +1,6 @@
 {
   "name": "@polkawallet/js-api",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "main": "index.js",
   "license": "Apache-2.0",
   "keywords": [
@@ -24,10 +24,10 @@
     "build-dev": "webpack --mode development"
   },
   "resolutions": {
-    "@polkadot/api": "^6.3.1"
+    "@polkadot/api": "^6.4.1"
   },
   "dependencies": {
-    "@polkadot/api": "^6.3.1",
+    "@polkadot/api": "^6.4.1",
     "@polkadot/extension-dapp": "^0.40.3",
     "@polkadot/ui-shared": "0.85.5",
     "@walletconnect/client": "2.0.0-alpha.26",

js_api/package.json

@@ -1,4 +1,4 @@
-import { keyExtractSuri, mnemonicGenerate, cryptoWaitReady, signatureVerify, encodeAddress } from "@polkadot/util-crypto";
+import { keyExtractSuri, mnemonicGenerate, mnemonicValidate, cryptoWaitReady, signatureVerify, encodeAddress } from "@polkadot/util-crypto";
 import { hexToU8a, u8aToHex } from "@polkadot/util";
 import BN from "bn.js";
 import { parseQrCode, getSigner, makeTx, getSubmittable } from "../utils/QrSigner";
@@ -22,6 +22,8 @@ let keyring = new Keyring({ ss58Format: 0, type: "sr25519" });
  */
 async function gen(mnemonic: string, ss58Format: number, cryptoType: KeypairType, derivePath: string) {
   const key = mnemonic || mnemonicGenerate();
+  if (!mnemonicValidate(key)) return null;
+
   const keyPair = keyring.addFromMnemonic(key + (derivePath || ""), {}, cryptoType || "sr25519");
   const address = encodeAddress(keyPair.publicKey, ss58Format || 0);
   const icons = await account.genIcons([address]);
@@ -32,6 +34,13 @@ async function gen(mnemonic: string, ss58Format: number, cryptoType: KeypairType
   };
 }
 
+/**
+ * mnemonic validate.
+ */
+async function checkMnemonicValid(mnemonic: string) {
+  return mnemonicValidate(mnemonic);
+}
+
 /**
  * get address and avatar from mnemonic.
  */
@@ -79,6 +88,9 @@ function recover(keyType: string, cryptoType: KeypairType, key: string, password
     try {
       switch (keyType) {
         case "mnemonic":
+          if (!mnemonicValidate(key.split("/")[0])) {
+            throw new Error(`invalid mnemonic ${key}`);
+          }
           keyPair = keyring.addFromMnemonic(key, {}, cryptoType);
           mnemonic = key;
           break;
@@ -466,6 +478,7 @@ async function verifySignature(message: string, signature: string, address: stri
 export default {
   initKeys,
   gen,
+  checkMnemonicValid,
   addressFromMnemonic,
   addressFromRawSeed,
   recover,

js_api/src/constants/networkMetadata.ts

@@ -33,6 +33,20 @@ async function runKeyringTest() {
   const mnemonic = await keyring.gen(null, 0, "sr25519", "");
   expect(mnemonic.mnemonic.split(" ").length, 12);
   expect(!!mnemonic.svg.match("<svg"), true);
+  const mnemonic1 = await keyring.gen(mnemonic.mnemonic, 0, "sr25519", "//superman");
+  expect(mnemonic1.mnemonic, mnemonic.mnemonic);
+  expect(mnemonic1.address == mnemonic.mnemonic, false);
+  expect(mnemonic1.svg == mnemonic.svg, false);
+  const mnemonic2 = await keyring.gen("null", 0, "sr25519", "");
+  expect(mnemonic2, null);
+
+  console.log("check mnemonic valid");
+  const mnemonicValid = await keyring.checkMnemonicValid(mnemonic.mnemonic);
+  expect(mnemonicValid, true);
+  const mnemonicValid1 = await keyring.checkMnemonicValid("null");
+  expect(mnemonicValid1, false);
+  const mnemonicValid2 = await keyring.checkMnemonicValid(null);
+  expect(mnemonicValid2, false);
 
   console.log("get address from mnemonic/seed");
   const addrWithIcon = await keyring.addressFromMnemonic(mnemonic.mnemonic, 0, "sr25519", "");
@@ -47,6 +61,15 @@ async function runKeyringTest() {
   expect(acc.pubKey.length, 66);
   expect(acc.mnemonic, mnemonic.mnemonic);
   expect(acc.encoding.content[1], sr25519);
+  const acc1 = await keyring.recover("mnemonic", sr25519, mnemonic.mnemonic + "//superman", password);
+  expect(acc1.address == acc.address, false);
+  expect(acc1.pubKey.length, 66);
+  expect(acc1.mnemonic, mnemonic.mnemonic + "//superman");
+  expect(acc1.encoding.content[1], sr25519);
+  const accBad = await keyring.recover("mnemonic", sr25519, mnemonic.mnemonic + " badword", password);
+  expect(accBad.mnemonic, undefined);
+  expect(!!accBad.error, true);
+  expect(!!accBad.error.match("invalid mnemonic"), true);
 
   console.log("import account from raw seed");
   const acc2 = await keyring.recover("rawSeed", sr25519, "Alice", password);