edge-core-js 2.45.0 → 2.46.0

package/lib/core/account/account-api.js

@@ -26,10 +26,12 @@ import { AccountSync, fixUsername } from '../../client-side'
 
 
 
+
 
 
 import { makeEdgeResult } from '../../util/edgeResult'
 import { base58 } from '../../util/encoding'
+import { saveWalletSettings } from '../currency/wallet/currency-wallet-files'
 import { getPublicWalletInfo } from '../currency/wallet/currency-wallet-pixie'
 import {
   finishWalletCreation,
@@ -55,13 +57,14 @@ import {
 import { changePin, checkPin2, deletePin } from '../login/pin2'
 import { changeRecovery, deleteRecovery } from '../login/recovery2'
 import { listSplittableWalletTypes, splitWalletInfo } from '../login/splitting'
+import { asEdgeStorageKeys } from '../login/storage-keys'
 import { changeVoucherStatus } from '../login/vouchers'
 import {
   findCurrencyPluginId,
   getCurrencyTools
 } from '../plugins/plugins-selectors'
 
-import { makeLocalDisklet } from '../storage/repo'
+import { makeLocalDisklet, makeRepoPaths } from '../storage/repo'
 import { makeStorageWalletApi } from '../storage/storage-api'
 import { fetchSwapQuotes } from '../swap/swap-api'
 import { changeWalletStates } from './account-files'
@@ -72,6 +75,26 @@ import { makeLobbyApi } from './lobby-api'
 import { makeMemoryWalletInner } from './memory-wallet'
 import { CurrencyConfig, SwapConfig } from './plugin-api'
 
+async function prewriteWalletSettings(
+  ai,
+  walletInfo,
+  walletSettings
+) {
+  // Only persist settings for currencies that actually support them. Otherwise
+  // the data would be written to disk but never loaded or exposed, since the
+  // wallet layer reads settings only when `currencyInfo.hasWalletSettings`:
+  const { currency } = ai.props.state.plugins
+  const pluginId = findCurrencyPluginId(currency, walletInfo.type)
+  const { hasWalletSettings = false } = currency[pluginId].currencyInfo
+  if (!hasWalletSettings) return
+
+  const { io } = ai.props
+  const storageKeys = asEdgeStorageKeys(walletInfo.keys)
+  const { disklet } = makeRepoPaths(io, storageKeys)
+
+  await saveWalletSettings(disklet, walletSettings)
+}
+
 /**
  * Creates an unwrapped account API object around an account state object.
  */
@@ -642,6 +665,9 @@ export function makeAccountApi(ai, accountId) {
       ai.props.log.breadcrumb('EdgeAccount.createCurrencyWallet', {})
 
       const walletInfo = await makeCurrencyWalletKeys(ai, walletType, opts)
+      if (opts.walletSettings != null) {
+        await prewriteWalletSettings(ai, walletInfo, opts.walletSettings)
+      }
       const childKey = decryptChildKey(stashTree, sessionKey, login.loginId)
       await applyKit(ai, sessionKey, makeKeysKit(ai, childKey, [walletInfo]))
       return await finishWalletCreation(ai, accountId, walletInfo.id, opts)
@@ -674,6 +700,14 @@ export function makeAccountApi(ai, accountId) {
         )
       )
 
+      // Prewrite wallet settings before applyKit triggers the pixie:
+      for (let i = 0; i < walletInfos.length; i++) {
+        const { walletSettings } = createWallets[i]
+        if (walletSettings != null) {
+          await prewriteWalletSettings(ai, walletInfos[i], walletSettings)
+        }
+      }
+
       // Store the keys on the server:
       const childKey = decryptChildKey(stashTree, sessionKey, login.loginId)
       await applyKit(ai, sessionKey, makeKeysKit(ai, childKey, walletInfos))

package/lib/core/account/memory-wallet.js

@@ -28,7 +28,7 @@ export const makeMemoryWalletInner = async (
   walletType,
   opts = {}
 ) => {
-  const { keys } = opts
+  const { keys, walletSettings = {} } = opts
   if (keys == null) throw new Error('No keys provided')
 
   const walletId = `memorywallet-${memoryWalletCount++}`
@@ -113,6 +113,7 @@ export const makeMemoryWalletInner = async (
     lightMode: true,
     log,
     userSettings: { ...(_nullishCoalesce(config.userSettings, () => ( {}))) },
+    walletSettings,
     walletLocalDisklet: makeMemoryDisklet(),
     walletLocalEncryptedDisklet: makeMemoryDisklet()
   })

package/lib/core/actions.js

@@ -438,6 +438,21 @@
 
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 

package/lib/core/currency/wallet/currency-wallet-api.js

@@ -40,6 +40,7 @@ import {
 
 
 
+
 
 
 import { makeMetaTokens } from '../../account/custom-tokens'
@@ -63,6 +64,7 @@ import {
   loadTxFiles,
   renameCurrencyWallet,
   saveTxMetadataFile,
+  saveWalletSettingsFile,
   setCurrencyWalletFiat,
   setupNewTxMetadata,
   updateCurrencyWalletTxMetadata
@@ -135,6 +137,9 @@ export function makeCurrencyWalletApi(
     get id() {
       return storageWalletApi.id
     },
+    get imported() {
+      return walletInfo.imported === true
+    },
     get localDisklet() {
       return storageWalletApi.localDisklet
     },
@@ -193,6 +198,17 @@ export function makeCurrencyWalletApi(
       return div(nativeAmount, multiplier, multiplier.length)
     },
 
+    // User settings for this wallet:
+    get walletSettings() {
+      return input.props.walletState.walletSettings
+    },
+    async changeWalletSettings(settings) {
+      if (input.props.walletState.currencyInfo.hasWalletSettings !== true) {
+        throw new Error('Wallet settings unsupported')
+      }
+      await saveWalletSettingsFile(input, settings)
+    },
+
     // Chain state:
     get balances() {
       return input.props.walletState.balances

package/lib/core/currency/wallet/currency-wallet-cleaners.js

@@ -308,6 +308,10 @@ export const asTokensFile = asObject({
   detectedTokenIds: asArray(asString)
 })
 
+export const asWalletSettingsFile = asObject({
+  walletSettings: asOptional(asJsonObject, () => ({}))
+})
+
 const asTransactionAsset = asObject({
   assetAction: asOptional(asEdgeAssetAction),
   metadata: asEdgeMetadata,

package/lib/core/currency/wallet/currency-wallet-files.js

@@ -10,6 +10,7 @@ import { justFiles, navigateDisklet } from 'disklet'
 
 
 
+
 import { makeJsonFile } from '../../../util/file-helpers'
 import { fetchAppIdInfo } from '../../account/lobby-api'
 import { toApiInput } from '../../root-pixie'
@@ -30,6 +31,7 @@ import {
   asTransactionFile,
   asWalletFiatFile,
   asWalletNameFile,
+  asWalletSettingsFile,
 
 
 
@@ -45,6 +47,7 @@ const LEGACY_TOKENS_FILE = 'EnabledTokens.json'
 const SEEN_TX_CHECKPOINT_FILE = 'seenTxCheckpoint.json'
 const TOKENS_FILE = 'Tokens.json'
 const WALLET_NAME_FILE = 'WalletName.json'
+const WALLET_SETTINGS_FILE = 'WalletSettings.json'
 
 const legacyAddressFile = makeJsonFile(asLegacyAddressFile)
 const legacyMapFile = makeJsonFile(asLegacyMapFile)
@@ -55,6 +58,7 @@ const tokensFile = makeJsonFile(asTokensFile)
 const transactionFile = makeJsonFile(asTransactionFile)
 const walletFiatFile = makeJsonFile(asWalletFiatFile)
 const walletNameFile = makeJsonFile(asWalletNameFile)
+const walletSettingsFile = makeJsonFile(asWalletSettingsFile)
 
 /**
  * Updates the enabled tokens on a wallet.
@@ -284,6 +288,52 @@ export async function loadTokensFile(
   })
 }
 
+/**
+ * Loads wallet-specific settings.
+ */
+export async function loadWalletSettingsFile(
+  input
+) {
+  const { dispatch, state, walletId } = input.props
+  const disklet = getStorageWalletDisklet(state, walletId)
+
+  const clean = await walletSettingsFile.load(disklet, WALLET_SETTINGS_FILE)
+  dispatch({
+    type: 'CURRENCY_WALLET_LOADED_WALLET_SETTINGS_FILE',
+    payload: {
+      walletId,
+      walletSettings: _nullishCoalesce(_optionalChain([clean, 'optionalAccess', _ => _.walletSettings]), () => ( {}))
+    }
+  })
+}
+
+/**
+ * Persists wallet settings to disk.
+ */
+export async function saveWalletSettingsFile(
+  input,
+  walletSettings
+) {
+  const { dispatch, state, walletId } = input.props
+  const disklet = getStorageWalletDisklet(state, walletId)
+
+  await saveWalletSettings(disklet, walletSettings)
+
+  dispatch({
+    type: 'CURRENCY_WALLET_CHANGED_WALLET_SETTINGS',
+    payload: { walletId, walletSettings }
+  })
+}
+
+export async function saveWalletSettings(
+  disklet,
+  walletSettings
+) {
+  await walletSettingsFile.save(disklet, WALLET_SETTINGS_FILE, {
+    walletSettings
+  })
+}
+
 /**
  * Loads transaction metadata files.
  */
@@ -437,7 +487,7 @@ export async function loadAddressFiles(
   )
 
   // Load these addresses into the engine:
-  const engine = _optionalChain([input, 'access', _ => _.props, 'access', _2 => _2.walletOutput, 'optionalAccess', _3 => _3.engine])
+  const engine = _optionalChain([input, 'access', _2 => _2.props, 'access', _3 => _3.walletOutput, 'optionalAccess', _4 => _4.engine])
   if (engine != null) await engine.addGapLimitAddresses(out)
 }
 
@@ -482,9 +532,9 @@ export async function updateCurrencyWalletTxMetadata(
   const newFile = {
     ...oldFile,
     creationDate,
-    currencies: new Map(_nullishCoalesce(_optionalChain([oldFile, 'optionalAccess', _4 => _4.currencies]), () => ( []))),
+    currencies: new Map(_nullishCoalesce(_optionalChain([oldFile, 'optionalAccess', _5 => _5.currencies]), () => ( []))),
     internal: true,
-    tokens: new Map(_nullishCoalesce(_optionalChain([oldFile, 'optionalAccess', _5 => _5.tokens]), () => ( []))),
+    tokens: new Map(_nullishCoalesce(_optionalChain([oldFile, 'optionalAccess', _6 => _6.tokens]), () => ( []))),
     txid
   }
 
@@ -697,6 +747,10 @@ export async function reloadWalletFiles(
   if (changes.includes(TOKENS_FILE) || changes.includes(LEGACY_TOKENS_FILE)) {
     await loadTokensFile(input)
   }
+  const { hasWalletSettings = false } = input.props.walletState.currencyInfo
+  if (hasWalletSettings && changes.includes(WALLET_SETTINGS_FILE)) {
+    await loadWalletSettingsFile(input)
+  }
   if (changes.includes(CURRENCY_FILE)) {
     await loadFiatFile(input)
   }

package/lib/core/currency/wallet/currency-wallet-pixie.js

@@ -16,6 +16,7 @@ import { update } from 'yaob'
 
 
 
+
 import { makeJsonFile } from '../../../util/file-helpers'
 import { makePeriodicTask, } from '../../../util/periodic-task'
 import { snooze } from '../../../util/snooze'
@@ -45,9 +46,14 @@ import {
   loadSeenTxCheckpointFile,
   loadTokensFile,
   loadTxFileNames,
+  loadWalletSettingsFile,
   writeTokensFile
 } from './currency-wallet-files'
-import { initialTokenIds } from './currency-wallet-reducer'
+import {
+
+  initialTokenIds,
+  initialWalletSettings
+} from './currency-wallet-reducer'
 import { tokenIdsToCurrencyCodes, uniqueStrings } from './enabled-tokens'
 
 
@@ -118,6 +124,11 @@ export const walletPixie = combinePixies({
       // so the engine can start in the right state:
       await loadTokensFile(input)
 
+      const { hasWalletSettings = false } = walletState.currencyInfo
+      if (hasWalletSettings) {
+        await loadWalletSettingsFile(input)
+      }
+
       // Start the engine:
       const accountState = state.accounts[accountId]
       const engine = await plugin.makeCurrencyEngine(publicWalletInfo, {
@@ -138,7 +149,8 @@ export const walletPixie = combinePixies({
         // User settings:
         customTokens: _nullishCoalesce(accountState.customTokens[pluginId], () => ( {})),
         enabledTokenIds: input.props.walletState.allEnabledTokenIds,
-        userSettings: _nullishCoalesce(accountState.userSettings[pluginId], () => ( {}))
+        userSettings: _nullishCoalesce(accountState.userSettings[pluginId], () => ( {})),
+        walletSettings: input.props.walletState.walletSettings
       })
       input.onOutput(engine)
 
@@ -462,7 +474,8 @@ export const walletPixie = combinePixies({
 
   watcher(input) {
     let lastState
-    let lastSettings = {}
+    let lastUserSettings = {}
+    let lastWalletSettings = initialWalletSettings
     let lastTokens = {}
     let lastEnabledTokenIds = initialTokenIds
 
@@ -480,11 +493,12 @@ export const walletPixie = combinePixies({
       lastState = walletState
 
       // Update engine settings:
-      const userSettings = _nullishCoalesce(accountState.userSettings[pluginId], () => ( lastSettings))
-      if (lastSettings !== userSettings && engine != null) {
+      const userSettings =
+        _nullishCoalesce(accountState.userSettings[pluginId], () => ( lastUserSettings))
+      if (lastUserSettings !== userSettings && engine != null) {
         await engine.changeUserSettings(userSettings)
       }
-      lastSettings = userSettings
+      lastUserSettings = userSettings
 
       // Update the custom tokens:
       const customTokens = _nullishCoalesce(accountState.customTokens[pluginId], () => ( lastTokens))
@@ -505,6 +519,22 @@ export const walletPixie = combinePixies({
       }
       lastTokens = customTokens
 
+      // Update wallet-scoped settings:
+      const { hasWalletSettings = false } = walletState.currencyInfo
+      const { walletSettings } = walletState
+      const settingsChanged = lastWalletSettings !== walletSettings
+
+      if (
+        settingsChanged &&
+        _optionalChain([engine, 'optionalAccess', _5 => _5.changeWalletSettings]) != null &&
+        hasWalletSettings
+      ) {
+        await engine.changeWalletSettings(walletSettings).catch(error => {
+          input.props.onError(error)
+        })
+      }
+      lastWalletSettings = walletSettings
+
       // Update enabled tokens:
       const { allEnabledTokenIds } = walletState
       if (lastEnabledTokenIds !== allEnabledTokenIds && engine != null) {

package/lib/core/currency/wallet/currency-wallet-reducer.js

@@ -15,6 +15,7 @@ import { buildReducer, filterReducer, memoizeReducer } from 'redux-keto'
 
 
 
+
 import { compare } from '../../../util/compare'
 
 import { findCurrencyPluginId } from '../../plugins/plugins-selectors'
@@ -117,6 +118,9 @@ import { uniqueStrings } from './enabled-tokens'
 
 
 
+
+
+export const initialWalletSettings = {}
 
 // Used for detectedTokenIds & enabledTokenIds:
 export const initialTokenIds = []
@@ -250,6 +254,16 @@ const currencyWalletInner = buildReducer
     }
   },
 
+  walletSettings(state = initialWalletSettings, action) {
+    switch (action.type) {
+      case 'CURRENCY_WALLET_LOADED_WALLET_SETTINGS_FILE':
+      case 'CURRENCY_WALLET_CHANGED_WALLET_SETTINGS':
+        return action.payload.walletSettings
+      default:
+        return state
+    }
+  },
+
   engineFailure(state = null, action) {
     if (action.type === 'CURRENCY_ENGINE_FAILED') {
       const { error } = action.payload

package/lib/core/login/splitting.js

@@ -172,18 +172,14 @@ export async function splitWalletInfo(
   // Restore anything that has simply been deleted:
   if (toRestore.length > 0) {
     const newStates = {}
-    let hasChanges = false
     for (const existingWalletInfo of toRestore) {
-      if (existingWalletInfo.archived || existingWalletInfo.deleted) {
-        hasChanges = true
-        newStates[existingWalletInfo.id] = {
-          archived: false,
-          deleted: false,
-          migratedFromWalletId: existingWalletInfo.migratedFromWalletId
-        }
+      newStates[existingWalletInfo.id] = {
+        archived: false,
+        deleted: false,
+        migratedFromWalletId: existingWalletInfo.migratedFromWalletId
       }
     }
-    if (hasChanges) await changeWalletStates(ai, accountId, newStates)
+    await changeWalletStates(ai, accountId, newStates)
   }
 
   // Add the keys to the login: