trezor-wallet/src/actions/LocalStorageActions.js

/* @flow */

import * as CONNECT from 'actions/constants/TrezorConnect';
import * as ACCOUNT from 'actions/constants/account';
import * as TOKEN from 'actions/constants/token';
import * as DISCOVERY from 'actions/constants/discovery';
import * as STORAGE from 'actions/constants/localStorage';
import * as PENDING from 'actions/constants/pendingTx';
import * as WALLET from 'actions/constants/wallet';
import { httpRequest } from 'utils/networkUtils';
import * as buildUtils from 'utils/build';
import * as storageUtils from 'utils/storage';
import * as WalletActions from 'actions/WalletActions';
import * as l10nUtils from 'utils/l10n';
import { getAccountTokens } from 'reducers/utils';
import type { Account } from 'reducers/AccountsReducer';
import type { Token } from 'reducers/TokensReducer';
import type { Discovery } from 'reducers/DiscoveryReducer';

import type {
    TrezorDevice,
    ThunkAction,
    AsyncAction,
    GetState,
    Dispatch,
    Transaction,
} from 'flowtype';
import type { Config, Network, TokensCollection } from 'reducers/LocalStorageReducer';

import Erc20AbiJSON from 'public/data/ERC20Abi.json';
import AppConfigJSON from 'public/data/appConfig.json';

export type StorageAction =
    | {
          type: typeof STORAGE.READY,
          config: Config,
          tokens: TokensCollection,
          ERC20Abi: Array<TokensCollection>,
      }
    | {
          type: typeof STORAGE.SAVE,
          network: string,
      }
    | {
          type: typeof STORAGE.ERROR,
          error: string,
      };

const TYPE: 'local' = 'local';
const { STORAGE_PATH } = storageUtils;
const KEY_VERSION: string = `${STORAGE_PATH}version`;
const KEY_DEVICES: string = `${STORAGE_PATH}devices`;
const KEY_ACCOUNTS: string = `${STORAGE_PATH}accounts`;
const KEY_IMPORTED_ACCOUNTS: string = `${STORAGE_PATH}importedAccounts`;
const KEY_DISCOVERY: string = `${STORAGE_PATH}discovery`;
const KEY_TOKENS: string = `${STORAGE_PATH}tokens`;
const KEY_PENDING: string = `${STORAGE_PATH}pending`;
const KEY_BETA_MODAL: string = '/betaModalPrivacy'; // this key needs to be compatible with "parent" (old) wallet
const KEY_LANGUAGE: string = `${STORAGE_PATH}language`;
const KEY_LOCAL_CURRENCY: string = `${STORAGE_PATH}localCurrency`;
const KEY_HIDE_BALANCE: string = `${STORAGE_PATH}hideBalance`;
const KEY_HIDDEN_COINS: string = `${STORAGE_PATH}hiddenCoins`;
const KEY_HIDDEN_COINS_EXTERNAL: string = `${STORAGE_PATH}hiddenCoinsExternal`;

// https://github.com/STRML/react-localstorage/blob/master/react-localstorage.js
// or
// https://www.npmjs.com/package/redux-react-session

const findAccounts = (devices: Array<TrezorDevice>, accounts: Array<Account>): Array<Account> =>
    devices.reduce((arr, dev) => arr.concat(accounts.filter(a => a.deviceState === dev.state)), []);

const findTokens = (accounts: Array<Account>, tokens: Array<Token>): Array<Token> =>
    accounts.reduce((arr, account) => arr.concat(getAccountTokens(tokens, account)), []);

const findDiscovery = (
    devices: Array<TrezorDevice>,
    discovery: Array<Discovery>
): Array<Discovery> =>
    devices.reduce(
        (arr, dev) => arr.concat(discovery.filter(d => d.deviceState === dev.state && d.completed)),
        []
    );

const findPendingTxs = (
    accounts: Array<Account>,
    pending: Array<Transaction>
): Array<Transaction> =>
    accounts.reduce(
        (result, account) =>
            result.concat(
                pending.filter(
                    p => p.descriptor === account.descriptor && p.network === account.network
                )
            ),
        []
    );

export const save = (): ThunkAction => (dispatch: Dispatch, getState: GetState): void => {
    const devices: Array<TrezorDevice> = getState().devices.filter(
        d => d.features && d.remember === true
    );
    const accounts: Array<Account> = findAccounts(devices, getState().accounts);
    const tokens: Array<Token> = findTokens(accounts, getState().tokens);
    const pending: Array<Transaction> = findPendingTxs(accounts, getState().pending);
    const discovery: Array<Discovery> = findDiscovery(devices, getState().discovery);

    // save devices
    storageUtils.set(TYPE, KEY_DEVICES, JSON.stringify(devices));

    // save already preloaded accounts
    storageUtils.set(TYPE, KEY_ACCOUNTS, JSON.stringify(accounts));

    // save discovery state
    storageUtils.set(TYPE, KEY_DISCOVERY, JSON.stringify(discovery));

    // tokens
    storageUtils.set(TYPE, KEY_TOKENS, JSON.stringify(tokens));

    // pending transactions
    storageUtils.set(TYPE, KEY_PENDING, JSON.stringify(pending));
};

export const update = (event: StorageEvent): ThunkAction => (dispatch: Dispatch): void => {
    if (!event.newValue) return;

    if (event.key === KEY_DEVICES) {
        // check if device was added/ removed
        // const newDevices: Array<TrezorDevice> = JSON.parse(event.newValue);
        // const myDevices: Array<TrezorDevice> = getState().connect.devices.filter(d => d.features);
        // if (newDevices.length !== myDevices.length) {
        //     const diff = myDevices.filter(d => newDevices.indexOf(d) < 0)
        //     console.warn("DEV LIST CHANGED!", newDevices.length, myDevices.length, diff)
        //     // check if difference is caused by local device which is not saved
        //     // or device which was saved in other tab
        // }
        // const diff = oldDevices.filter(d => newDevices.indexOf())
    }

    if (event.key === KEY_ACCOUNTS) {
        dispatch({
            type: ACCOUNT.FROM_STORAGE,
            payload: JSON.parse(event.newValue),
        });
    }

    if (event.key === KEY_TOKENS) {
        dispatch({
            type: TOKEN.FROM_STORAGE,
            payload: JSON.parse(event.newValue),
        });
    }

    if (event.key === KEY_PENDING) {
        dispatch({
            type: PENDING.FROM_STORAGE,
            payload: JSON.parse(event.newValue),
        });
    }

    if (event.key === KEY_DISCOVERY) {
        dispatch({
            type: DISCOVERY.FROM_STORAGE,
            payload: JSON.parse(event.newValue),
        });
    }
};

const loadJSON = (): AsyncAction => async (dispatch: Dispatch): Promise<void> => {
    if (typeof window.localStorage === 'undefined') return;

    try {
        const config: Config = await httpRequest(AppConfigJSON, 'json');

        // remove testnets from config networks
        if (!buildUtils.isDev()) {
            config.networks = config.networks.filter(n => !n.testnet);
        }

        const ERC20Abi = await httpRequest(Erc20AbiJSON, 'json');

        window.addEventListener('storage', event => {
            dispatch(update(event));
        });

        // load tokens
        const tokens = await config.networks.reduce(
            async (
                promise: Promise<TokensCollection>,
                network: Network
            ): Promise<TokensCollection> => {
                const collection: TokensCollection = await promise;
                if (network.tokens) {
                    const json = await httpRequest(network.tokens, 'json');
                    collection[network.shortcut] = json;
                }
                return collection;
            },
            Promise.resolve({})
        );

        dispatch({
            type: STORAGE.READY,
            config,
            tokens,
            ERC20Abi,
        });
    } catch (error) {
        console.error(error);
        dispatch({
            type: STORAGE.ERROR,
            error,
        });
    }
};

// version 3 since trezor-connect@8 implementation
const VERSION: string = '3';

const loadStorageData = (): ThunkAction => (dispatch: Dispatch): void => {
    // validate version
    const version: ?string = storageUtils.get(TYPE, KEY_VERSION);
    if (version && version !== VERSION) {
        storageUtils.clearAll();
    }
    storageUtils.set(TYPE, KEY_VERSION, VERSION);

    const devices: ?string = storageUtils.get(TYPE, KEY_DEVICES);
    if (devices) {
        dispatch({
            type: CONNECT.DEVICE_FROM_STORAGE,
            payload: JSON.parse(devices),
        });
    }

    const accounts: ?string = storageUtils.get(TYPE, KEY_ACCOUNTS);
    if (accounts) {
        dispatch({
            type: ACCOUNT.FROM_STORAGE,
            payload: JSON.parse(accounts),
        });
    }

    const importedAccounts = getImportedAccounts();
    if (importedAccounts) {
        importedAccounts.forEach(account => {
            dispatch({
                type: ACCOUNT.CREATE,
                payload: account,
            });
        });
    }

    const hiddenCoins = getHiddenCoins(false);
    dispatch({
        type: WALLET.SET_HIDDEN_COINS,
        hiddenCoins,
    });

    const isExternal = true;
    const hiddenCoinsExternal = getHiddenCoins(isExternal);
    dispatch({
        type: WALLET.SET_HIDDEN_COINS_EXTERNAL,
        hiddenCoinsExternal,
    });

    const userTokens: ?string = storageUtils.get(TYPE, KEY_TOKENS);
    if (userTokens) {
        dispatch({
            type: TOKEN.FROM_STORAGE,
            payload: JSON.parse(userTokens),
        });
    }

    const pending: ?string = storageUtils.get(TYPE, KEY_PENDING);
    if (pending) {
        dispatch({
            type: PENDING.FROM_STORAGE,
            payload: JSON.parse(pending),
        });
    }

    const discovery: ?string = storageUtils.get(TYPE, KEY_DISCOVERY);
    if (discovery) {
        dispatch({
            type: DISCOVERY.FROM_STORAGE,
            payload: JSON.parse(discovery),
        });
    }

    if (buildUtils.isDev() || buildUtils.isBeta()) {
        const betaModal = Object.keys(window.localStorage).find(
            key => key.indexOf(KEY_BETA_MODAL) >= 0
        );
        if (!betaModal) {
            dispatch({
                type: WALLET.SHOW_BETA_DISCLAIMER,
                show: true,
            });
        }
    }

    const language: ?string = storageUtils.get(TYPE, KEY_LANGUAGE);
    if (language) {
        dispatch(WalletActions.fetchLocale(JSON.parse(language)));
    } else {
        dispatch(WalletActions.fetchLocale(l10nUtils.getInitialLocale(navigator.language)));
    }

    const localCurrency: ?string = storageUtils.get(TYPE, KEY_LOCAL_CURRENCY);
    if (localCurrency) {
        dispatch(WalletActions.setLocalCurrency(JSON.parse(localCurrency)));
    }

    const hideBalance: ?string = storageUtils.get(TYPE, KEY_HIDE_BALANCE);
    if (hideBalance) {
        dispatch(WalletActions.setHideBalance(JSON.parse(hideBalance)));
    }
};

export const loadData = (): ThunkAction => (dispatch: Dispatch, getState: GetState): void => {
    dispatch(loadStorageData());

    // stop loading resources and wait for user action
    if (!getState().wallet.showBetaDisclaimer) {
        dispatch(loadJSON());
    }
};

export const hideBetaDisclaimer = (): ThunkAction => (dispatch: Dispatch): void => {
    storageUtils.set(TYPE, KEY_BETA_MODAL, true);
    dispatch(loadJSON());
};

export const setLanguage = (): ThunkAction => (dispatch: Dispatch, getState: GetState): void => {
    const { language } = getState().wallet;
    storageUtils.set(TYPE, KEY_LANGUAGE, JSON.stringify(language));
};

export const setHideBalance = (): ThunkAction => (dispatch: Dispatch, getState: GetState): void => {
    const { hideBalance } = getState().wallet;
    storageUtils.set(TYPE, KEY_HIDE_BALANCE, hideBalance);
};

export const setLocalCurrency = (): ThunkAction => (
    dispatch: Dispatch,
    getState: GetState
): void => {
    const { localCurrency } = getState().wallet;
    storageUtils.set(TYPE, KEY_LOCAL_CURRENCY, JSON.stringify(localCurrency));
};

export const setImportedAccount = (account: Account): ThunkAction => (): void => {
    const prevImportedAccounts: ?Array<Account> = getImportedAccounts();
    let importedAccounts = [account];
    if (prevImportedAccounts) {
        importedAccounts = importedAccounts.concat(prevImportedAccounts);
    }
    storageUtils.set(TYPE, KEY_IMPORTED_ACCOUNTS, JSON.stringify(importedAccounts));
};

export const getImportedAccounts = (): ?Array<Account> => {
    const importedAccounts: ?string = storageUtils.get(TYPE, KEY_IMPORTED_ACCOUNTS);
    if (importedAccounts) {
        return JSON.parse(importedAccounts);
    }
    return null;
};

export const handleCoinVisibility = (
    coinShortcut: string,
    shouldBeVisible: boolean,
    isExternal: boolean
): ThunkAction => (dispatch: Dispatch): void => {
    const configuration: Array<string> = getHiddenCoins(isExternal);
    let newConfig: Array<string> = configuration;
    const isAlreadyHidden = configuration.find(coin => coin === coinShortcut);

    if (shouldBeVisible) {
        newConfig = configuration.filter(coin => coin !== coinShortcut);
    } else if (!isAlreadyHidden) {
        newConfig = [...configuration, coinShortcut];
    }

    if (isExternal) {
        storageUtils.set(TYPE, KEY_HIDDEN_COINS_EXTERNAL, JSON.stringify(newConfig));
        dispatch({
            type: WALLET.SET_HIDDEN_COINS_EXTERNAL,
            hiddenCoinsExternal: newConfig,
        });
    } else {
        storageUtils.set(TYPE, KEY_HIDDEN_COINS, JSON.stringify(newConfig));
        dispatch({
            type: WALLET.SET_HIDDEN_COINS,
            hiddenCoins: newConfig,
        });
    }
};

export const toggleGroupCoinsVisibility = (
    allCoins: Array<string>,
    checked: boolean,
    isExternal: boolean
): ThunkAction => (dispatch: Dispatch) => {
    // supported coins
    if (checked && !isExternal) {
        dispatch({
            type: WALLET.SET_HIDDEN_COINS,
            hiddenCoins: [],
        });
        storageUtils.set(TYPE, KEY_HIDDEN_COINS, JSON.stringify([]));
    }

    if (!checked && !isExternal) {
        dispatch({
            type: WALLET.SET_HIDDEN_COINS,
            hiddenCoins: allCoins,
        });
        storageUtils.set(TYPE, KEY_HIDDEN_COINS, JSON.stringify(allCoins));
    }

    // external coins
    if (checked && isExternal) {
        dispatch({
            type: WALLET.SET_HIDDEN_COINS_EXTERNAL,
            hiddenCoinsExternal: [],
        });
        storageUtils.set(TYPE, KEY_HIDDEN_COINS_EXTERNAL, JSON.stringify([]));
    }

    if (!checked && isExternal) {
        dispatch({
            type: WALLET.SET_HIDDEN_COINS_EXTERNAL,
            hiddenCoinsExternal: allCoins,
        });
        storageUtils.set(TYPE, KEY_HIDDEN_COINS_EXTERNAL, JSON.stringify(allCoins));
    }
};

export const getHiddenCoins = (isExternal: boolean): Array<string> => {
    let coinsConfig: ?string = '';
    if (isExternal) {
        coinsConfig = storageUtils.get(TYPE, KEY_HIDDEN_COINS_EXTERNAL);
    } else {
        coinsConfig = storageUtils.get(TYPE, KEY_HIDDEN_COINS);
    }
    if (coinsConfig) {
        return JSON.parse(coinsConfig);
    }
    return [];
};

export const removeImportedAccounts = (device: TrezorDevice): ThunkAction => (
    dispatch: Dispatch
): void => {
    const importedAccounts: ?Array<Account> = getImportedAccounts();
    if (!importedAccounts) return;

    const filteredImportedAccounts = importedAccounts.filter(
        account => account.deviceID !== device.id
    );
    storageUtils.remove(TYPE, KEY_IMPORTED_ACCOUNTS);
    filteredImportedAccounts.forEach(account => {
        dispatch(setImportedAccount(account));
    });
};