refactor(neuron-wallet): use Validate decorator to verify password in…

packages/neuron-wallet/src/channel/wallet.ts

@@ -1,8 +1,7 @@
 import { BrowserWindow } from 'electron'
 
 import Listeners from './listeners'
-import { ResponseCode } from '../controllers'
-import { Channel } from '../utils/const'
+import { Channel, ResponseCode } from '../utils/const'
 
 export default class WalletChannel extends Listeners {
   public win: BrowserWindow

packages/neuron-wallet/src/controllers/helpers.ts

@@ -1,6 +1,6 @@
 import Key from '../keys/key'
-import { ResponseCode } from '.'
 import { CatchControllerError } from '../decorators'
+import { ResponseCode } from '../utils/const'
 import i18n from '../utils/i18n'
 
 export enum HelpersMethod {

packages/neuron-wallet/src/controllers/index.ts

@@ -3,11 +3,6 @@ import WalletsController, { WalletsMethod } from './wallets'
 import TransactionsController from './transactions'
 import HelpersController, { HelpersMethod } from './helpers'
 
-export enum ResponseCode {
-  Fail,
-  Success,
-}
-
 export const methods = {
   NetworksMethod,
   WalletsMethod,
@@ -19,5 +14,4 @@ export default {
   WalletsController,
   TransactionsController,
   HelpersController,
-  ResponseCode,
 }

packages/neuron-wallet/src/controllers/networks.ts

@@ -1,6 +1,6 @@
-import { ResponseCode } from '.'
 import NetworksService, { NetworkType, NetworkID, Network } from '../services/networks'
 import { CatchControllerError } from '../decorators'
+import { ResponseCode } from '../utils/const'
 import i18n from '../utils/i18n'
 
 export enum NetworksMethod {

packages/neuron-wallet/src/controllers/transactions.ts

@@ -1,11 +1,11 @@
-import { ResponseCode } from '.'
 import { Transaction } from '../appTypes/types'
 import TransactionsService, {
   TransactionsByAddressesParam,
   PaginationResult,
   TransactionsByLockHashesParam,
 } from '../services/transactions'
 import { CatchControllerError } from '../decorators'
+import { ResponseCode } from '../utils/const'
 import i18n from '../utils/i18n'
 
 /**

packages/neuron-wallet/src/controllers/wallets.ts

@@ -1,11 +1,9 @@
 import WalletsService, { Wallet, WalletProperties } from '../services/wallets'
-import { ResponseCode } from './index'
-import windowManage from '../utils/windowManage'
-import { Channel } from '../utils/const'
 import Key from '../keys/key'
 import { CatchControllerError } from '../decorators'
+import windowManage from '../utils/windowManage'
+import { Channel, ResponseCode } from '../utils/const'
 import i18n from '../utils/i18n'
-import { verifyPasswordComplexity } from '../utils/validators'
 
 export enum WalletsMethod {
   GetAll = 'getAll',
@@ -132,7 +130,7 @@ class WalletsController {
     receivingAddressNumber: number
     changeAddressNumber: number
   }): Promise<Controller.Response<Wallet>> {
-    const key = Key.fromKeystore(keystore, password, receivingAddressNumber, changeAddressNumber)
+    const key = await Key.fromKeystore(keystore, password, receivingAddressNumber, changeAddressNumber)
     const wallet = WalletsController.service.create({
       name,
       keystore: key.keystore || null,
@@ -170,8 +168,7 @@ class WalletsController {
 
     if (newPassword) {
       if (WalletsController.service.validate({ id, password })) {
-        verifyPasswordComplexity(password)
-        const key = Key.fromKeystore(JSON.stringify(wallet!.loadKeystore()), password)
+        const key = await Key.fromKeystore(JSON.stringify(wallet!.loadKeystore()), password)
         props.keystore = key.toKeystore(JSON.stringify(key.keysData!), newPassword)
       } else {
         throw new Error(i18n.t('messages.wallet-incorrect-password'))

packages/neuron-wallet/src/decorators/errors.ts

@@ -1,12 +1,12 @@
-import { ResponseCode } from '../controllers'
+import { ResponseCode } from '../utils/const'
 
-export const CatchControllerError = (_target: any, _name: string, descripor: PropertyDescriptor) => {
-  const originalMethod = descripor.value
+export const CatchControllerError = (_target: any, _name: string, descriptor: PropertyDescriptor) => {
+  const originalMethod = descriptor.value
   return {
-    ...descripor,
+    ...descriptor,
     async value(...args: any[]) {
       try {
-        return originalMethod(...args)
+        return await originalMethod(...args)
       } catch (err) {
         return {
           status: ResponseCode.Fail,

packages/neuron-wallet/src/decorators/index.ts

@@ -1,7 +1,10 @@
-import errorsDecorators from './errors'
+import errorDecorators from './errors'
+import validatorDecorators from './validators'
 
-export const { CatchControllerError } = errorsDecorators
+export const { CatchControllerError } = errorDecorators
+export const { Validate, Password, Required } = validatorDecorators
 
 export default {
-  ...errorsDecorators,
+  ...errorDecorators,
+  ...validatorDecorators,
 }

packages/neuron-wallet/src/decorators/validators.ts

@@ -0,0 +1,75 @@
+import 'reflect-metadata'
+
+import i18n from '../utils/i18n'
+import { MIN_PASSWORD_LENGTH, MAX_PASSWORD_LENGTH } from '../utils/const'
+
+const requiredMetadataKey = Symbol('required')
+const passwordMetadataKey = Symbol('password')
+
+export const verifyPasswordComplexity = (password: string) => {
+  if (password.length < MIN_PASSWORD_LENGTH) {
+    throw Error(i18n.t('messages.wallet-password-less-than-min-length', { minPasswordLength: MIN_PASSWORD_LENGTH }))
+  }
+  if (password.length > MAX_PASSWORD_LENGTH) {
+    throw Error(i18n.t('messages.wallet-password-more-than-max-length', { maxPasswordLength: MAX_PASSWORD_LENGTH }))
+  }
+  let complex = 0
+  let reg = /\d/
+  if (reg.test(password)) {
+    complex++
+  }
+  reg = /[a-z]/
+  if (reg.test(password)) {
+    complex++
+  }
+  reg = /[A-Z]/
+  if (reg.test(password)) {
+    complex++
+  }
+  reg = /[^0-9a-zA-Z]/
+  if (reg.test(password)) {
+    complex++
+  }
+  if (complex < 3) {
+    throw Error(i18n.t('messages.wallet-password-letter-complexity'))
+  }
+}
+
+const Required = (target: Object, propertyKey: string | symbol, index: number) => {
+  const indices: number[] = Reflect.getOwnMetadata(requiredMetadataKey, target, propertyKey) || []
+  indices.push(index)
+  Reflect.defineMetadata(requiredMetadataKey, indices, target, propertyKey)
+}
+
+const Password = (target: Object, propertyKey: string | symbol, parameterIndex: number) => {
+  Reflect.defineMetadata(passwordMetadataKey, parameterIndex, target, propertyKey)
+}
+
+const Validate = (target: any, propertyKey: string, descriptor: PropertyDescriptor) => {
+  const originalMethod = descriptor.value
+  return {
+    ...descriptor,
+    async value(...args: any[]) {
+      const requiredIndices: number[] = Reflect.getOwnMetadata(requiredMetadataKey, target, propertyKey)
+      if (requiredIndices) {
+        requiredIndices.forEach(idx => {
+          if (idx >= args.length || args[idx] === undefined) {
+            throw new Error('Missing required argument')
+          }
+        })
+      }
+
+      const passwordIndex: number = Reflect.getOwnMetadata(passwordMetadataKey, target, propertyKey)
+      if (passwordIndex !== undefined) {
+        verifyPasswordComplexity(args[passwordIndex])
+      }
+      return originalMethod(...args)
+    },
+  }
+}
+
+export default {
+  Required,
+  Password,
+  Validate,
+}

packages/neuron-wallet/src/keys/key.ts

@@ -5,9 +5,8 @@ import SHA3 from 'sha3'
 import { v4 as uuid } from 'uuid'
 import Address, { HDAddress } from '../services/addresses'
 import { Keystore, KdfParams, KeysData } from './keystore'
-import i18n from '../utils/i18n'
-import { verifyPasswordComplexity } from '../utils/validators'
 import { Keychain } from './hd'
+import { Validate, Required, Password } from '../decorators'
 
 export interface Addresses {
   receiving: HDAddress[]
@@ -49,22 +48,17 @@ export default class Key {
     return bip39.generateMnemonic()
   }
 
-  static fromKeystore(
-    keystore: string,
-    password: string,
+  @Validate
+  static async fromKeystore(
+    @Required keystore: string,
+    @Password password: string,
     receivingAddressNumber = DefaultAddressNumber.Receiving,
     changeAddressNumber = DefaultAddressNumber.Change,
   ) {
-    if (!password) throw new Error(i18n.t('messages.password-is-required'))
-    verifyPasswordComplexity(password)
-
-    if (!keystore) throw new Error(i18n.t('messages.keystore-is-required'))
     const keystoreObject: Keystore = JSON.parse(keystore)
     const key = new Key()
     key.keystore = keystoreObject
-    if (password === undefined) {
-      throw new Error('No password given.')
-    } else if (!key.checkPassword(password)) {
+    if (!key.checkPassword(password)) {
       throw new Error('Password error.')
     }
     const { kdfparams } = keystoreObject.crypto
@@ -98,16 +92,13 @@ export default class Key {
     return key
   }
 
+  @Validate
   public static async fromMnemonic(
-    mnemonic: string,
-    password: string,
+    @Required mnemonic: string,
+    @Password password: string,
     receivingAddressNumber = DefaultAddressNumber.Receiving,
     changeAddressNumber = DefaultAddressNumber.Change,
   ) {
-    if (!password) throw new Error(i18n.t('messages.password-is-required'))
-    verifyPasswordComplexity(password)
-
-    if (!mnemonic) throw new Error(i18n.t('messages.mnemonic-is-required'))
     if (!bip39.validateMnemonic(mnemonic)) {
       throw new Error('Wrong Mnemonic')
     }

packages/neuron-wallet/src/services/networks.ts

@@ -5,9 +5,8 @@ import Store from '../utils/store'
 import env from '../env'
 
 import windowManage from '../utils/windowManage'
-import { ResponseCode } from '../controllers'
 import { NetworksMethod } from '../controllers/networks'
-import { Channel } from '../utils/const'
+import { Channel, ResponseCode } from '../utils/const'
 import nodeService from '../startup/nodeService'
 
 export type NetworkID = string

packages/neuron-wallet/src/startup/initWindow.ts

@@ -1,6 +1,6 @@
 import { app, BrowserWindow } from 'electron'
-import controllers, { ResponseCode } from '../controllers'
-import { Channel } from '../utils/const'
+import controllers from '../controllers'
+import { Channel, ResponseCode } from '../utils/const'
 
 const { WalletsController, NetworksController } = controllers
 

packages/neuron-wallet/src/utils/const.ts

@@ -12,6 +12,12 @@ export enum Channel {
   Helpers = 'helpers',
 }
 
+export enum ResponseCode {
+  Fail,
+  Success,
+}
+
 export default {
   Channel,
+  ResponseCode,
 }

packages/neuron-wallet/tests/keys/key.test.ts

@@ -15,7 +15,7 @@ describe('Key tests', () => {
   })
 
   it('import key from keystore', async () => {
-    const key = Key.fromKeystore(keystoreJson, '1qaz.2wsx', 20, 10)
+    const key = await Key.fromKeystore(keystoreJson, '1qaz.2wsx', 20, 10)
     expect(privateKey).toBe(key.keysData!.privateKey)
     expect(key.addresses!.receiving.length).toEqual(20)
     expect(key.addresses!.change.length).toEqual(10)

packages/neuron-wallet/tests/utils/validators.test.ts

@@ -1,4 +1,4 @@
-import { verifyPasswordComplexity } from '../../src/utils/validators'
+import { verifyPasswordComplexity } from '../../src/decorators/validators'
 import i18n from '../../src/utils/i18n'
 import { MIN_PASSWORD_LENGTH } from '../../src/utils/const'