KEEP-74 Add address book (#309)

Author: ehassed3

package-lock.json

@@ -53,6 +53,7 @@
     "debounce": "^1.2.1",
     "debounce-stream": "^2.0.0",
     "dnode": "^1.2.2",
+    "ethereumjs-util": "^7.1.5",
     "events": "^3.3.0",
     "highlight.js": "^11.3.1",
     "i18next": "^20.6.1",

package.json

@@ -75,7 +75,7 @@ module.exports = ({
       if (isProduction) {
         await zipFolder(
           platformFolder,
-          path.join(DIST_FOLDER, `waves-keeper-${version}-${platformName}.zip`)
+          path.join(DIST_FOLDER, `keeper-wallet-${version}-${platformName}.zip`)
         );
 
         console.log(`Zipping ${platformName} is done`);

scripts/webpack.config.js

@@ -6,6 +6,7 @@ import { TypedUseSelectorHook, useDispatch, useSelector } from 'react-redux';
 
 const reducer = combineReducers({
   tab: reducers.tab,
+  addresses: reducers.addresses,
   accounts: reducers.accounts,
   currentLocale: reducers.currentLocale,
   state: reducers.state,

src/accounts/store.ts

@@ -16,6 +16,7 @@ interface Account {
 }
 
 interface UpdateStateInput {
+  addresses: Record<string, string>;
   accounts?: Account[];
   currentLocale: string;
   currentNetwork?: string;
@@ -136,6 +137,14 @@ export function createUpdateState(store: AccountsStore) {
       });
     }
 
+    const addresses = getParam(state.addresses, {});
+    if (addresses && !equals(addresses, currentState.addresses)) {
+      store.dispatch({
+        type: ACTION.UPDATE_ADDRESSES,
+        payload: addresses,
+      });
+    }
+
     actions.forEach(action => store.dispatch(action));
   };
 }

src/accounts/updateState.ts

@@ -5,7 +5,7 @@ import ColorHash from 'color-hash';
 import * as React from 'react';
 import { useTranslation } from 'react-i18next';
 import { Button } from 'ui/components/ui/buttons/Button';
-import { Input } from 'ui/components/ui/input/index';
+import { Input } from 'ui/components/ui/input';
 import { Tooltip } from 'ui/components/ui/tooltip';
 import { BalanceAssets } from 'ui/reducers/updateState';
 import { AssetDetail } from 'ui/services/Background';

src/assets/selectModal.tsx

@@ -26,6 +26,7 @@ import {
   UiStateController,
   WalletController,
 } from './controllers';
+import { AddressBookController } from './controllers/AddressBookController';
 import { SwapController } from './controllers/SwapController';
 import {
   getExtraFee,
@@ -366,6 +367,10 @@ class BackgroundService extends EventEmitter {
       getNode: this.networkController.getNode.bind(this.networkController),
     });
 
+    this.addressBookController = new AddressBookController({
+      localStore: this.localStore,
+    });
+
     // Messages. Transaction message pipeline. Adds new tx, user approve/reject tx.
     // Delegates different signing to walletController, broadcast and getMatcherPublicKey to networkController,
     // assetInfo for assetInfoController
@@ -488,6 +493,8 @@ class BackgroundService extends EventEmitter {
       },
       newPassword: async (oldPassword, newPassword) =>
         this.walletController.newPassword(oldPassword, newPassword),
+      checkPassword: async password =>
+        this.walletController.checkPassword(password),
       getAccountSeed: async (address, network, password) =>
         this.walletController.getAccountSeed(address, network, password),
       getAccountEncodedSeed: async (address, network, password) =>
@@ -549,6 +556,13 @@ class BackgroundService extends EventEmitter {
       toggleAssetFavorite: this.assetInfoController.toggleAssetFavorite.bind(
         this.assetInfoController
       ),
+      // addresses
+      setAddress: async (address, name) =>
+        this.addressBookController.setAddress(address, name),
+      setAddresses: async addresses =>
+        this.addressBookController.setAddresses(addresses),
+      removeAddress: async address =>
+        this.addressBookController.removeAddress(address),
       // window control
       closeNotificationWindow: async () => this.emit('Close notification'),
       resizeNotificationWindow: async (width, height) =>

src/background.js

@@ -0,0 +1,35 @@
+import * as ObservableStore from 'obs-store';
+import LocalStore from '../lib/localStore';
+
+type AddressBookState = { addresses: Record<string, string> };
+
+type Options = {
+  localStore: LocalStore;
+};
+
+export class AddressBookController {
+  store: ObservableStore<AddressBookState>;
+
+  constructor({ localStore }: Options) {
+    this.store = new ObservableStore(
+      localStore.getInitState({ addresses: {} })
+    );
+    localStore.subscribe(this.store);
+  }
+
+  setAddress(address: string, name: string) {
+    const { addresses } = this.store.getState();
+    this.store.updateState({ addresses: { ...addresses, [address]: name } });
+  }
+
+  setAddresses(newAddresses: Record<string, string>) {
+    const { addresses } = this.store.getState();
+    this.store.updateState({ addresses: { ...newAddresses, ...addresses } });
+  }
+
+  removeAddress(address: string) {
+    const { addresses } = this.store.getState();
+    delete addresses[address];
+    this.store.updateState({ addresses });
+  }
+}

src/controllers/AddressBookController.ts

@@ -125,6 +125,10 @@ export class WalletController extends EventEmitter {
     this._saveWallets();
   }
 
+  checkPassword(password) {
+    return password === this.password;
+  }
+
   getAccountSeed(address, network, password) {
     if (!password) throw new Error('Password is required');
     this._restoreWallets(password);

src/controllers/WalletController.js

@@ -23,6 +23,37 @@
   "activeAccountCard": {
     "swapButton": "Swap"
   },
+  "spoiler": {
+    "view": "View",
+    "hide": "Hide"
+  },
+  "address": {
+    "add": "New address",
+    "addButton": "Add new",
+    "addTooltip": "Add an address to your contacts",
+    "added": "Address added",
+    "addressAlreadyExist": "Address already exist",
+    "addressInvalidError": "Address value is invalid",
+    "cancel": "Cancel",
+    "copied": "Copied!",
+    "copyToClipboard": "Click to copy to clipboard",
+    "delete": "Delete address",
+    "deleteDescription": "Are you sure you want to delete this address from your contacts? This action is irreversible.",
+    "edit": "Edit address",
+    "edited": "Address edited",
+    "emptyDescription": "Add the recipient's Name and Address for quick access to transfer and view in history",
+    "emptyTitle": "No one here yet",
+    "name": "Name",
+    "nameAlreadyExist": "Name already exist",
+    "nameInvalidError": "Name value is invalid",
+    "save": "Save address",
+    "saveChanges": "Save changes",
+    "select": "Choose your address",
+    "subtitle": "Address",
+    "title": "Address book",
+    "wallets": "My wallets",
+    "warningAlias": "Be careful, the recipient has an Alias account, it is not a user from your contacts"
+  },
   "assetAmountInput": {
     "balanceLabel": "Balance"
   },
@@ -132,12 +163,23 @@
     "delete": "Delete account",
     "warn": "Deleting an account will lead to its irretrievable loss!"
   },
+  "exportAndImport": {
+    "exportAccounts": "Export accounts",
+    "importAccounts": "Import accounts",
+    "exportAddressBook": "Export address book",
+    "importAddressBook": "Import address book",
+    "exportAll": "Export all"
+  },
   "exportKeystore": {
     "cancelBtn": "Cancel",
     "chooseAccountsDesc": "Select which accounts you want to export. They will be encrypted and exported into a Keystore file",
+    "chooseContactsDesc": "Select which address you want to export. They will be encrypted and exported into a Keystore file",
     "chooseAccountsExportBtn": "Export {{count}} account",
     "chooseAccountsExportBtn_plural": "Export {{count}} accounts",
+    "chooseContactsExportBtn": "Continue",
     "chooseAccountsTitle": "Export to Keystore file",
+    "chooseContactsTitle": "Export Contacts to file",
+    "encrypt": "Encrypt the file",
     "exportNotSupported": "This account cannot be exported",
     "warningModalTitle": "Attention",
     "warningModalDesc": "Ledger and email accounts cannot be exported",
@@ -146,7 +188,7 @@
     "passwordLabel": "Password",
     "passwordVerifyDesc": "Please enter your Keeper password to confirm that it's really you",
     "passwordVerifyImportantNote": "<attention>Attention:</attention> this password will also be used to encrypt the resulting file. If you forget it, you won't be able to restore your accounts.",
-    "verifyBtn": "Verify"
+    "verifyBtn": "Enter"
   },
   "featureUpdateInfo": {
     "intro": "Keeper Wallet cares about safety of your funds and would like to remind you that losing the seed phrase means losing access to the account permanently.",
@@ -238,6 +280,8 @@
     "readyToUse": "Your account '{{ name }}' is ready to use",
     "readyToUseKeystore": "Your accounts are ready to use",
     "readyHelpText": "You can now close this tab and continue using the extension or add more accounts.",
+    "readyToUseAddressBook": "Your Address Book is ready to use",
+    "readyAddressBookText": "You can now close this tab and continue using the extension.",
     "viaKeystore": "Keystore File",
     "viaLedger": "Ledger",
     "viaSeed": "Seed Phrase or Private Key",
@@ -275,13 +319,16 @@
     "alreadyExists": "Account already exists"
   },
   "importKeystore": {
+    "addressBookLabel": "Address Book file",
+    "addressBookPasswordPlaceholder": "Password used to create file",
     "browse": "Browse...",
-    "chooseAccountsTitle": "Choose accounts",
     "chooseAccountsDesc": "Select which accounts you want to import",
     "chooseAccountsExistingAccountNote": "Already exists in Keeper as {{existingName}}",
     "chooseAccountsImportBtn": "Import {{count}} account",
     "chooseAccountsImportBtn_plural": "Import {{count}} accounts",
     "chooseAccountsSkipBtn": "Skip",
+    "chooseAccountsTitle": "Choose accounts",
+    "chooseAddressBookFileTitle": "Import Address Book",
     "chooseFileSubmitBtn": "Continue",
     "chooseFileTitle": "Import Keystore File",
     "errorDecrypt": "Could not decrypt the Keystore file with the given password",
@@ -475,7 +522,7 @@
     "autoClickDisable": "Disabled",
     "autoClickEnable": "Enabled",
     "deleteAccounts": "Delete accounts",
-    "export": "Export accounts",
+    "exportAndImport": "Export and import",
     "langs": "Change language",
     "logOut": "Log out",
     "network": "Network",