|
|
@ -4,12 +4,12 @@ const extend = require('xtend') |
|
|
|
|
|
|
|
|
|
|
|
class PreferencesController { |
|
|
|
class PreferencesController { |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* |
|
|
|
* |
|
|
|
* @typedef {Object} PreferencesController |
|
|
|
* @typedef {Object} PreferencesController |
|
|
|
* @param {object} opts Overrides the defaults for the initial state of this.store |
|
|
|
* @param {object} opts Overrides the defaults for the initial state of this.store |
|
|
|
* @property {object} store The an object containing a users preferences, stored in local storage |
|
|
|
* @property {object} store The an object containing a users preferences, stored in local storage |
|
|
|
* @property {array} store.frequentRpcList A list of custom rpcs to provide the user |
|
|
|
* @property {array} store.frequentRpcList A list of custom rpcs to provide the user |
|
|
|
* @property {string} store.currentAccountTab Indicates the selected tab in the ui |
|
|
|
* @property {string} store.currentAccountTab Indicates the selected tab in the ui |
|
|
|
* @property {array} store.tokens The tokens the user wants display in their token lists |
|
|
|
* @property {array} store.tokens The tokens the user wants display in their token lists |
|
|
|
* @property {boolean} store.useBlockie The users preference for blockie identicons within the UI |
|
|
|
* @property {boolean} store.useBlockie The users preference for blockie identicons within the UI |
|
|
@ -18,7 +18,7 @@ class PreferencesController { |
|
|
|
* @property {string} store.currentLocale The preferred language locale key |
|
|
|
* @property {string} store.currentLocale The preferred language locale key |
|
|
|
* @property {string} store.selectedAddress A hex string that matches the currently selected address in the app |
|
|
|
* @property {string} store.selectedAddress A hex string that matches the currently selected address in the app |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
constructor (opts = {}) { |
|
|
|
constructor (opts = {}) { |
|
|
|
const initState = extend({ |
|
|
|
const initState = extend({ |
|
|
|
frequentRpcList: [], |
|
|
|
frequentRpcList: [], |
|
|
@ -32,43 +32,43 @@ class PreferencesController { |
|
|
|
} |
|
|
|
} |
|
|
|
// PUBLIC METHODS
|
|
|
|
// PUBLIC METHODS
|
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Setter for the `useBlockie` property |
|
|
|
* Setter for the `useBlockie` property |
|
|
|
* |
|
|
|
* |
|
|
|
* @param {boolean} val Whether or not the user prefers blockie indicators |
|
|
|
* @param {boolean} val Whether or not the user prefers blockie indicators |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
setUseBlockie (val) { |
|
|
|
setUseBlockie (val) { |
|
|
|
this.store.updateState({ useBlockie: val }) |
|
|
|
this.store.updateState({ useBlockie: val }) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Getter for the `useBlockie` property |
|
|
|
* Getter for the `useBlockie` property |
|
|
|
* |
|
|
|
* |
|
|
|
* @returns {boolean} this.store.useBlockie |
|
|
|
* @returns {boolean} this.store.useBlockie |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
getUseBlockie () { |
|
|
|
getUseBlockie () { |
|
|
|
return this.store.getState().useBlockie |
|
|
|
return this.store.getState().useBlockie |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Setter for the `currentLocale` property |
|
|
|
* Setter for the `currentLocale` property |
|
|
|
* |
|
|
|
* |
|
|
|
* @param {string} key he preferred language locale key |
|
|
|
* @param {string} key he preferred language locale key |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
setCurrentLocale (key) { |
|
|
|
setCurrentLocale (key) { |
|
|
|
this.store.updateState({ currentLocale: key }) |
|
|
|
this.store.updateState({ currentLocale: key }) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Setter for the `selectedAddress` property |
|
|
|
* Setter for the `selectedAddress` property |
|
|
|
* |
|
|
|
* |
|
|
|
* @param {string} _address A new hex address for an account |
|
|
|
* @param {string} _address A new hex address for an account |
|
|
|
* @returns {Promise<void>} Promise resolves with undefined |
|
|
|
* @returns {Promise<void>} Promise resolves with undefined |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
setSelectedAddress (_address) { |
|
|
|
setSelectedAddress (_address) { |
|
|
|
return new Promise((resolve, reject) => { |
|
|
|
return new Promise((resolve, reject) => { |
|
|
|
const address = normalizeAddress(_address) |
|
|
|
const address = normalizeAddress(_address) |
|
|
@ -129,13 +129,13 @@ class PreferencesController { |
|
|
|
return Promise.resolve(tokens) |
|
|
|
return Promise.resolve(tokens) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Removes a specified token from the tokens array. |
|
|
|
* Removes a specified token from the tokens array. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param {string} rawAddress Hex address of the token contract to remove. |
|
|
|
* @param {string} rawAddress Hex address of the token contract to remove. |
|
|
|
* @returns {Promise<array> The new array of AddedToken objects |
|
|
|
* @returns {Promise<array> The new array of AddedToken objects |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
removeToken (rawAddress) { |
|
|
|
removeToken (rawAddress) { |
|
|
|
const tokens = this.store.getState().tokens |
|
|
|
const tokens = this.store.getState().tokens |
|
|
|
|
|
|
|
|
|
|
@ -145,23 +145,23 @@ class PreferencesController { |
|
|
|
return Promise.resolve(updatedTokens) |
|
|
|
return Promise.resolve(updatedTokens) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* A getter for the `tokens` property |
|
|
|
* A getter for the `tokens` property |
|
|
|
* |
|
|
|
* |
|
|
|
* @returns {array} The current array of AddedToken objects |
|
|
|
* @returns {array} The current array of AddedToken objects |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
getTokens () { |
|
|
|
getTokens () { |
|
|
|
return this.store.getState().tokens |
|
|
|
return this.store.getState().tokens |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Gets an updated rpc list from this.addToFrequentRpcList() and sets the `frequentRpcList` to this update list. |
|
|
|
* Gets an updated rpc list from this.addToFrequentRpcList() and sets the `frequentRpcList` to this update list. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param {string} _url The the new rpc url to add to the updated list |
|
|
|
* @param {string} _url The the new rpc url to add to the updated list |
|
|
|
* @returns {Promise<void>} Promise resolves with undefined |
|
|
|
* @returns {Promise<void>} Promise resolves with undefined |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
updateFrequentRpcList (_url) { |
|
|
|
updateFrequentRpcList (_url) { |
|
|
|
return this.addToFrequentRpcList(_url) |
|
|
|
return this.addToFrequentRpcList(_url) |
|
|
|
.then((rpcList) => { |
|
|
|
.then((rpcList) => { |
|
|
@ -170,13 +170,13 @@ class PreferencesController { |
|
|
|
}) |
|
|
|
}) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Setter for the `currentAccountTab` property
|
|
|
|
* Setter for the `currentAccountTab` property
|
|
|
|
* |
|
|
|
* |
|
|
|
* @param {string} currentAccountTab Specifies the new tab to be marked as current |
|
|
|
* @param {string} currentAccountTab Specifies the new tab to be marked as current |
|
|
|
* @returns {Promise<void>} Promise resolves with undefined |
|
|
|
* @returns {Promise<void>} Promise resolves with undefined |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
setCurrentAccountTab (currentAccountTab) { |
|
|
|
setCurrentAccountTab (currentAccountTab) { |
|
|
|
return new Promise((resolve, reject) => { |
|
|
|
return new Promise((resolve, reject) => { |
|
|
|
this.store.updateState({ currentAccountTab }) |
|
|
|
this.store.updateState({ currentAccountTab }) |
|
|
@ -184,15 +184,15 @@ class PreferencesController { |
|
|
|
}) |
|
|
|
}) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Returns an updated rpcList based on the passed url and the current list. |
|
|
|
* Returns an updated rpcList based on the passed url and the current list. |
|
|
|
* The returned list will have a max length of 2. If the _url currently exists it the list, it will be moved to the |
|
|
|
* The returned list will have a max length of 2. If the _url currently exists it the list, it will be moved to the |
|
|
|
* end of the list. The current list is modified and returned as a promise. |
|
|
|
* end of the list. The current list is modified and returned as a promise. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param {string} _url The rpc url to add to the frequentRpcList. |
|
|
|
* @param {string} _url The rpc url to add to the frequentRpcList. |
|
|
|
* @returns {Promise<array>} The updated frequentRpcList.
|
|
|
|
* @returns {Promise<array>} The updated frequentRpcList.
|
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
addToFrequentRpcList (_url) { |
|
|
|
addToFrequentRpcList (_url) { |
|
|
|
const rpcList = this.getFrequentRpcList() |
|
|
|
const rpcList = this.getFrequentRpcList() |
|
|
|
const index = rpcList.findIndex((element) => { return element === _url }) |
|
|
|
const index = rpcList.findIndex((element) => { return element === _url }) |
|
|
@ -208,24 +208,24 @@ class PreferencesController { |
|
|
|
return Promise.resolve(rpcList) |
|
|
|
return Promise.resolve(rpcList) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Getter for the `frequentRpcList` property. |
|
|
|
* Getter for the `frequentRpcList` property. |
|
|
|
* |
|
|
|
* |
|
|
|
* @returns {array<string>} An array of one or two rpc urls. |
|
|
|
* @returns {array<string>} An array of one or two rpc urls. |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
getFrequentRpcList () { |
|
|
|
getFrequentRpcList () { |
|
|
|
return this.store.getState().frequentRpcList |
|
|
|
return this.store.getState().frequentRpcList |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* Updates the `featureFlags` property, which is an object. One property within that object will be set to a boolean. |
|
|
|
* Updates the `featureFlags` property, which is an object. One property within that object will be set to a boolean. |
|
|
|
* |
|
|
|
* |
|
|
|
* @param {string} feature A key that corresponds to a UI feature. |
|
|
|
* @param {string} feature A key that corresponds to a UI feature. |
|
|
|
* @param {boolean} activated Indicates whether or not the UI feature should be displayed |
|
|
|
* @param {boolean} activated Indicates whether or not the UI feature should be displayed |
|
|
|
* @returns {Promise<object>} Promises a new object; the updated featureFlags object. |
|
|
|
* @returns {Promise<object>} Promises a new object; the updated featureFlags object. |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
setFeatureFlag (feature, activated) { |
|
|
|
setFeatureFlag (feature, activated) { |
|
|
|
const currentFeatureFlags = this.store.getState().featureFlags |
|
|
|
const currentFeatureFlags = this.store.getState().featureFlags |
|
|
|
const updatedFeatureFlags = { |
|
|
|
const updatedFeatureFlags = { |
|
|
@ -238,13 +238,13 @@ class PreferencesController { |
|
|
|
return Promise.resolve(updatedFeatureFlags) |
|
|
|
return Promise.resolve(updatedFeatureFlags) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
/** |
|
|
|
/** |
|
|
|
* A getter for the `featureFlags` property |
|
|
|
* A getter for the `featureFlags` property |
|
|
|
* |
|
|
|
* |
|
|
|
* @returns {object} A key-boolean map, where keys refer to features and booleans to whether the |
|
|
|
* @returns {object} A key-boolean map, where keys refer to features and booleans to whether the |
|
|
|
* user wishes to see that feature |
|
|
|
* user wishes to see that feature |
|
|
|
* |
|
|
|
* |
|
|
|
*/ |
|
|
|
*/ |
|
|
|
getFeatureFlags () { |
|
|
|
getFeatureFlags () { |
|
|
|
return this.store.getState().featureFlags |
|
|
|
return this.store.getState().featureFlags |
|
|
|
} |
|
|
|
} |
|
|
|