From c2046be0d8606ded9a328f392baf62cad802b98f Mon Sep 17 00:00:00 2001 From: Dan Finlay Date: Wed, 30 Mar 2016 19:15:49 -0700 Subject: Made configuration migrateable Abstract all configuration data into a singleton called `configManager`, who is responsible for reading and writing to the persisted storage (localStorage, in our case). Uses my new module [pojo-migrator](https://www.npmjs.com/package/pojo-migrator), and wraps it with the `ConfigManager` class, which we can hang any state setting or getting methods we need. By keeping all the persisted state in one place, we can stabilize its outward-facing API, making the interactions increasingly atomic, which will allow us to add features that require restructuring the persisted data in the long term without having to rewrite UI or even `background.js` code. All the restructuring and data-type management is kept in one neat little place. This should make it very easy to add new configuration options like user-configured providers, per-domain vaults, and more! I know this doesn't seem like a big user-facing feature, but we have a big laundry list of features that I think this will really help streamline. --- app/scripts/lib/config-manager.js | 161 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 app/scripts/lib/config-manager.js (limited to 'app/scripts/lib/config-manager.js') diff --git a/app/scripts/lib/config-manager.js b/app/scripts/lib/config-manager.js new file mode 100644 index 000000000..038774a30 --- /dev/null +++ b/app/scripts/lib/config-manager.js @@ -0,0 +1,161 @@ +const Migrator = require('pojo-migrator') +const extend = require('xtend') + +const STORAGE_KEY = 'metamask-config' +var DEFAULT_RPC = 'https://rawtestrpc.metamask.io/' + +/* The config-manager is a convenience object + * wrapping a pojo-migrator. + * + * It exists mostly to allow the creation of + * convenience methods to access and persist + * particular portions of the state. + */ +module.exports = ConfigManager +function ConfigManager() { + + /* The migrator exported on the config-manager + * has two methods the user should be concerned with: + * + * getData(), which returns the app-consumable data object + * saveData(), which persists the app-consumable data object. + */ + this.migrator = new Migrator({ + + // Migrations must start at version 1 or later. + // They are objects with a `version` number + // and a `migrate` function. + // + // The `migrate` function receives the previous + // config data format, and returns the new one. + migrations: [], + + // How to load initial config. + // Includes step on migrating pre-pojo-migrator data. + loadData: loadData, + + // How to persist migrated config. + setData: function(data) { + window.localStorage[STORAGE_KEY] = JSON.stringify(data) + }, + }) +} + +ConfigManager.prototype.setConfig = function(config) { + var data = this.migrator.getData() + data.config = config + this.setData(data) +} + +ConfigManager.prototype.setRpcTarget = function(rpcUrl) { + var config = this.getConfig() + config.provider = { + type: 'rpc', + rpcTarget: rpcUrl, + } + this.setConfig(config) +} + +ConfigManager.prototype.getConfig = function() { + var data = this.migrator.getData() + if ('config' in data) { + return data.config + } else { + return { + provider: { + type: 'rpc', + rpcTarget: DEFAULT_RPC, + } + } + } +} + +ConfigManager.prototype.setData = function(data) { + this.migrator.saveData(data) +} + +ConfigManager.prototype.getData = function() { + return this.migrator.getData() +} + +ConfigManager.prototype.setWallet = function(wallet) { + var data = this.migrator.getData() + data.wallet = wallet + this.setData(data) +} + +ConfigManager.prototype.getWallet = function() { + return this.migrator.getData().wallet +} + +ConfigManager.prototype.getSeedWords = function() { + return this.migrator.getData().seedWords +} + +ConfigManager.prototype.setSeedWords = function(seedWords) { + var data = this.migrator.getData() + data.seedWords = seedWords + this.setData(data) +} + +ConfigManager.prototype.clearSeedWords = function() { + var data = this.migrator.getData() + delete data.seedWords + this.setData(data) +} + +ConfigManager.prototype.getCurrentRpcAddress = function() { + var config = this.getConfig() + if (!config) return null + return config.provider && config.provider.rpcTarget ? config.provider.rpcTarget : DEFAULT_RPC +} + +ConfigManager.prototype.clearWallet = function() { + var data = this.getConfig() + delete data.wallet + this.setData(data) +} + +function loadData() { + + var oldData = getOldStyleData() + var newData + try { + newData = JSON.parse(window.localStorage[STORAGE_KEY]) + } catch (e) {} + + var data = extend({ + version: 0, + data: { + config: { + rpcTarget: DEFAULT_RPC, + } + } + }, oldData ? oldData : null, newData ? newData : null) + return data +} + +function getOldStyleData() { + var config, wallet, seedWords + + var result = { + meta: { version: 0 }, + data: {}, + } + + try { + config = JSON.parse(window.localStorage['config']) + result.data.config = config + } catch (e) {} + try { + wallet = JSON.parse(window.localStorage['lightwallet']) + result.data.wallet = wallet + } catch (e) {} + try { + seedWords = window.localStorage['seedWords'] + result.data.seedWords = seedWords + } catch (e) {} + + return result +} + -- cgit v1.2.3 From f5105293bf2d3e6fb325e015b5b2b67baa7d03cc Mon Sep 17 00:00:00 2001 From: Dan Finlay Date: Thu, 31 Mar 2016 10:47:40 -0700 Subject: Do not cache the seed, retrieve it from the decrypted wallet --- app/scripts/lib/config-manager.js | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) (limited to 'app/scripts/lib/config-manager.js') diff --git a/app/scripts/lib/config-manager.js b/app/scripts/lib/config-manager.js index 038774a30..682b34637 100644 --- a/app/scripts/lib/config-manager.js +++ b/app/scripts/lib/config-manager.js @@ -88,20 +88,16 @@ ConfigManager.prototype.getWallet = function() { return this.migrator.getData().wallet } -ConfigManager.prototype.getSeedWords = function() { - return this.migrator.getData().seedWords -} - -ConfigManager.prototype.setSeedWords = function(seedWords) { +// Takes a boolean +ConfigManager.prototype.setShowSeedWords = function(should) { var data = this.migrator.getData() - data.seedWords = seedWords + data.showSeedWords = should this.setData(data) } -ConfigManager.prototype.clearSeedWords = function() { +ConfigManager.prototype.getShouldShowSeedWords = function() { var data = this.migrator.getData() - delete data.seedWords - this.setData(data) + return data.showSeedWords } ConfigManager.prototype.getCurrentRpcAddress = function() { -- cgit v1.2.3