edge-core-js 2.2.0 → 2.3.0

package/lib/node/index.js

@@ -20,7 +20,7 @@ var elliptic = require('elliptic');
 var yavent = require('yavent');
 var reduxKeto = require('redux-keto');
 var crypto = require('crypto');
-var fetch = require('node-fetch');
+var fetch$1 = require('node-fetch');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -30,7 +30,7 @@ var aesjs__default = /*#__PURE__*/_interopDefaultLegacy(aesjs);
 var hashjs__default = /*#__PURE__*/_interopDefaultLegacy(hashjs);
 var elliptic__default = /*#__PURE__*/_interopDefaultLegacy(elliptic);
 var crypto__default = /*#__PURE__*/_interopDefaultLegacy(crypto);
-var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
+var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch$1);
 
 function scrypt$2(data, salt, n, r, p, dklen) {
   return new Promise((resolve, reject) => {
@@ -1843,7 +1843,7 @@ async function waitForPlugins(ai) {
       swap
     } = props.state.plugins;
     const missingPlugins = [];
-    for (const pluginId in init) {
+    for (const pluginId of Object.keys(init)) {
       const shouldLoad = init[pluginId] !== false && init[pluginId] != null;
       if (shouldLoad && currency[pluginId] == null && swap[pluginId] == null) {
         missingPlugins.push(pluginId);
@@ -3258,6 +3258,13 @@ const clientFile = makeJsonFile(cleaners.asObject({
   clientId: asBase64
 }));
 
+const INFO_CACHE_FILE_NAME = 'infoCache.json';
+const asInfoCacheFile = cleaners.asObject({
+  corePlugins: cleaners.asObject(asJsonObject),
+  syncServers: cleaners.asArray(cleaners.asString)
+});
+const infoCacheFile = makeJsonFile(asInfoCacheFile);
+
 const allPlugins = {};
 let allPluginsLocked = false;
 const onPluginsAdded = [];
@@ -3272,7 +3279,7 @@ function addEdgeCorePlugins(plugins) {
   }
 
   // Save the new plugins:
-  for (const pluginId in plugins) {
+  for (const pluginId of Object.keys(plugins)) {
     allPlugins[pluginId] = plugins[pluginId];
   }
 
@@ -3291,7 +3298,7 @@ function lockEdgeCorePlugins() {
 /**
  * Subscribes a context object to the core plugin list.
  */
-function watchPlugins(ios, logBackend, pluginsInit, dispatch) {
+function watchPlugins(ios, infoCache, logBackend, pluginsInit, dispatch) {
   const {
     io,
     nativeIo
@@ -3302,7 +3309,7 @@ function watchPlugins(ios, logBackend, pluginsInit, dispatch) {
   };
   function pluginsAdded(plugins) {
     const out = {};
-    for (const pluginId in plugins) {
+    for (const pluginId of Object.keys(plugins)) {
       const plugin = plugins[pluginId];
       const log = makeLog(logBackend, pluginId);
       const initOptions = pluginsInit[pluginId];
@@ -3312,6 +3319,7 @@ function watchPlugins(ios, logBackend, pluginsInit, dispatch) {
       try {
         if (typeof plugin === 'function') {
           const opts = {
+            infoPayload: infoCache.corePlugins?.[pluginId] ?? {},
             initOptions: typeof initOptions === 'object' ? initOptions : {},
             io: legacyIo,
             log,
@@ -3563,7 +3571,7 @@ async function addStorageWallet(ai, walletInfo) {
       const {
         lastHash
       } = status;
-      ai.props.log.error(`Could not sync ${syncKey} with last hash ${String(lastHash)}: ${String(error)}`);
+      ai.props.log.error(`Could not sync ${String(syncKey)} with last hash ${String(lastHash)}: ${String(error)}`);
       onError(error);
     });
   } else await syncPromise;
@@ -4049,8 +4057,9 @@ const asEdgeMetadata = raw => {
   } = clean;
 
   // Delete corrupt amounts that exceed the Javascript number range:
-  for (const fiat of Object.keys(clean)) {
+  for (const fiat of Object.keys(exchangeAmount)) {
     if (String(exchangeAmount[fiat]).includes('e')) {
+      // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
       delete exchangeAmount[fiat];
     }
   }
@@ -5469,7 +5478,7 @@ const asAppIdInfo = cleaners.asObject({
  */
 async function fetchAppIdInfo(ai, appId) {
   try {
-    const infoServerUri = shuffle(ai.props.state.contextConfig.edgeServers.infoServers)[0];
+    const [infoServerUri] = shuffle(ai.props.state.infoServers);
     const url = `${infoServerUri}/v1/appIdInfo/${appId}`;
     const response = await ai.props.io.fetch(url);
     if (response.status === 404) {
@@ -5820,21 +5829,23 @@ async function loadTokensFile(input) {
     return;
   }
   const legacyCurrencyCodes = await legacyTokensFile.load(disklet, LEGACY_TOKENS_FILE);
-  const {
-    accountId,
-    currencyInfo,
-    pluginId
-  } = input.props.walletState;
-  const accountState = input.props.state.accounts[accountId];
-  const tokenIds = currencyCodesToTokenIds(accountState.builtinTokens[pluginId], accountState.customTokens[pluginId], currencyInfo, legacyCurrencyCodes ?? []);
-  dispatch({
-    type: 'CURRENCY_WALLET_LOADED_TOKEN_FILE',
-    payload: {
-      walletId: input.props.walletId,
-      detectedTokenIds: [],
-      enabledTokenIds: tokenIds
-    }
-  });
+  if (legacyCurrencyCodes != null) {
+    const {
+      accountId,
+      currencyInfo,
+      pluginId
+    } = input.props.walletState;
+    const accountState = input.props.state.accounts[accountId];
+    const tokenIds = currencyCodesToTokenIds(accountState.builtinTokens[pluginId], accountState.customTokens[pluginId], currencyInfo, legacyCurrencyCodes);
+    dispatch({
+      type: 'CURRENCY_WALLET_LOADED_TOKEN_FILE',
+      payload: {
+        walletId: input.props.walletId,
+        detectedTokenIds: [],
+        enabledTokenIds: tokenIds
+      }
+    });
+  }
 }
 
 /**
@@ -6653,7 +6664,7 @@ function makeCurrencyWalletCallbacks(input) {
         return;
       }
       pushUpdate({
-        id: `${walletId}==${tokenId}`,
+        id: `${walletId}==${String(tokenId)}`,
         action: 'onTokenBalanceChanged',
         updateFunc: () => {
           input.props.dispatch({
@@ -8254,14 +8265,15 @@ async function fetchSwapQuotes(ai, accountId, request, opts = {}) {
     slowResponseMs = 20000
   } = opts;
   const {
-    log
+    log,
+    state
   } = ai.props;
-  const account = ai.props.state.accounts[accountId];
+  const account = state.accounts[accountId];
   const {
     swapSettings,
     userSettings
   } = account;
-  const swapPlugins = ai.props.state.plugins.swap;
+  const swapPlugins = state.plugins.swap;
   log.warn('Requesting swap quotes for: ', {
     ...request,
     fromWallet: request.fromWallet.id,
@@ -8283,6 +8295,7 @@ async function fetchSwapQuotes(ai, accountId, request, opts = {}) {
     // Start request:
     pendingIds.add(pluginId);
     promises.push(swapPlugins[pluginId].fetchSwapQuote(request, userSettings[pluginId], {
+      infoPayload: state.infoCache.corePlugins?.[pluginId] ?? {},
       promoCode: promoCodes[pluginId]
     }).then(quote => {
       const {
@@ -9241,8 +9254,8 @@ function makeAccountApi(ai, accountId) {
       } = walletOutput;
       if (engine == null) throw new Error(`Invalid wallet: ${activateWalletId} not found`);
       if (engine.engineActivateWallet == null) throw new Error(`activateWallet unsupported by walletId ${activateWalletId}`);
-      const walletId = paymentInfo?.walletId;
-      const wallet = currencyWallets[walletId ?? ''];
+      const walletId = paymentInfo?.walletId ?? '';
+      const wallet = currencyWallets[walletId];
       if (wallet == null) {
         throw new Error(`No wallet for walletId ${walletId}`);
       }
@@ -9702,14 +9715,7 @@ const accountPixie = reduxPixies.combinePixies({
     });
     return {
       update() {
-        const {
-          accountOutput
-        } = input.props;
-        if (accountOutput == null) return;
-        const {
-          accountApi
-        } = accountOutput;
-        if (accountApi == null) return;
+        if (input.props.accountOutput?.accountApi == null) return;
 
         // Start once the EdgeAccount API exists:
         dataTask.start({
@@ -10118,16 +10124,110 @@ const context = reduxPixies.combinePixies({
         }
       }
     };
-  }
+  },
+  infoFetcher: reduxPixies.filterPixie(input => {
+    async function doInfoSync() {
+      const {
+        dispatch,
+        io
+      } = input.props;
+      const [infoServerUri] = shuffle(input.props.state.infoServers);
+      const response = await fetch(`${infoServerUri}/v1/coreRollup`, {
+        headers: {
+          accept: 'application/json'
+        }
+      });
+      if (!response.ok) return;
+      const json = await response.json();
+      const infoCache = asInfoCacheFile(json);
+      dispatch({
+        type: 'INFO_CACHE_FETCHED',
+        payload: infoCache
+      });
+      await infoCacheFile.save(io.disklet, INFO_CACHE_FILE_NAME, infoCache);
+    }
+    const infoTask = makePeriodicTask(doInfoSync, 10 * 60 * 1000);
+    infoTask.start();
+    return {
+      update() {},
+      destroy() {
+        infoTask.stop();
+      }
+    };
+  }, props => props.state.paused ? undefined : props)
 });
 
+/**
+ * Compares two JSON-like objects, returning false if they differ.
+ */
+function matchJson(a, b) {
+  // Use simple equality, unless a and b are proper objects:
+  if (typeof a !== 'object' || typeof b !== 'object' || a == null || b == null) {
+    return a === b;
+  }
+
+  // These must either be both arrays or both objects:
+  const aIsArray = Array.isArray(a);
+  const bIsArray = Array.isArray(b);
+  if (aIsArray !== bIsArray) return false;
+
+  // Compare arrays in order:
+  if (aIsArray) {
+    if (a.length !== b.length) return false;
+    for (let i = 0; i < a.length; ++i) {
+      if (!matchJson(a[i], b[i])) return false;
+    }
+    return true;
+  }
+
+  // These are both regular objects, so grab the keys,
+  // ignoring entries where the value is `undefined`:
+  const aKeys = Object.getOwnPropertyNames(a).filter(key => a[key] !== undefined);
+  const bKeys = Object.getOwnPropertyNames(b).filter(key => b[key] !== undefined);
+  if (aKeys.length !== bKeys.length) return false;
+
+  // We know that both objects have the same number of properties,
+  // so if every property in `a` has a matching property in `b`,
+  // the objects must be identical, regardless of key order.
+  for (const key of aKeys) {
+    if (!Object.prototype.hasOwnProperty.call(b, key)) return false;
+    if (!matchJson(a[key], b[key])) return false;
+  }
+  return true;
+}
+
 const currency$1 = reduxPixies.combinePixies({
   wallets: reduxPixies.mapPixie(walletPixie, props => props.state.currency.currencyWalletIds, (props, walletId) => ({
     ...props,
     walletId,
     walletState: props.state.currency.wallets[walletId],
     walletOutput: props.output.currency.wallets[walletId]
-  }))
+  })),
+  pluginUpdater(input) {
+    let lastInfo;
+    return async () => {
+      const {
+        infoCache,
+        plugins
+      } = input.props.state;
+
+      // Bail out quickly if nothing has changed:
+      if (lastInfo === infoCache) return;
+
+      // Update plugins after the first run:
+      if (lastInfo != null) {
+        for (const pluginId of Object.keys(plugins.currency)) {
+          const plugin = plugins.currency[pluginId];
+          const newPayload = infoCache.corePlugins?.[pluginId] ?? {};
+          const oldPayload = lastInfo.corePlugins?.[pluginId] ?? {};
+          if (plugin.updateInfoPayload != null && !matchJson(oldPayload, newPayload)) {
+            await plugin.updateInfoPayload(newPayload);
+          }
+        }
+      }
+      lastInfo = infoCache;
+    };
+  }
 });
 
 /**
@@ -10280,26 +10380,6 @@ const rootPixie = reduxPixies.combinePixies({
   scrypt
 });
 
-const defaultEdgeServers = {
-  infoServers: [],
-  syncServers: []
-};
-const contextConfig = reduxKeto.buildReducer({
-  edgeServers(state = defaultEdgeServers, action) {
-    if (action.type === 'INIT') {
-      const {
-        infoServers,
-        syncServers
-      } = action.payload;
-      return {
-        infoServers,
-        syncServers
-      };
-    }
-    return state;
-  }
-});
-
 const currency = reduxKeto.buildReducer({
   currencyWalletIds(state, action, next) {
     // Optimize the common case:
@@ -10554,6 +10634,18 @@ const reducer = reduxKeto.buildReducer({
   hideKeys(state = true, action) {
     return action.type === 'INIT' ? action.payload.hideKeys : state;
   },
+  infoCache(state = {}, action) {
+    switch (action.type) {
+      case 'INIT':
+        return action.payload.infoCache;
+      case 'INFO_CACHE_FETCHED':
+        return action.payload;
+    }
+    return state;
+  },
+  infoServers(state = [], action) {
+    return action.type === 'INIT' ? action.payload.infoServers : state;
+  },
   lastAccountId(state, action, next) {
     return `login${next.accountCount}`;
   },
@@ -10575,7 +10667,9 @@ const reducer = reduxKeto.buildReducer({
   skipBlockHeight(state = false, action) {
     return action.type === 'INIT' ? action.payload.skipBlockHeight : state;
   },
-  contextConfig,
+  syncServers(state = [], action) {
+    return action.type === 'INIT' ? action.payload.syncServers : state;
+  },
   currency,
   login,
   plugins,
@@ -10600,15 +10694,15 @@ async function makeContext(ios, logBackend, opts) {
     apiKey,
     appId = '',
     authServer = 'https://login.edge.app/api',
-    infoServer = ['https://info-eu1.edge.app', 'https://info-us1.edge.app'],
-    syncServer = ['https://sync-us1.edge.app', 'https://sync-us2.edge.app', 'https://sync-us3.edge.app', 'https://sync-us4.edge.app', 'https://sync-us5.edge.app', 'https://sync-us6.edge.app', 'https://sync-eu.edge.app'],
+    infoServer,
+    syncServer,
     deviceDescription = null,
     hideKeys = false,
     plugins: pluginsInit = {},
     skipBlockHeight = false
   } = opts;
-  const infoServers = Array.isArray(infoServer) ? infoServer : [infoServer];
-  const syncServers = Array.isArray(syncServer) ? syncServer : [syncServer];
+  const infoServers = typeof infoServer === 'string' ? [infoServer] : infoServer != null && infoServer.length > 0 ? infoServer : ['https://info-eu1.edge.app', 'https://info-us1.edge.app'];
+  const syncServers = typeof syncServer === 'string' ? [syncServer] : syncServer != null && syncServer.length > 0 ? syncServer : ['https://sync-us1.edge.app', 'https://sync-us2.edge.app', 'https://sync-us3.edge.app', 'https://sync-us4.edge.app', 'https://sync-us5.edge.app', 'https://sync-us6.edge.app', 'https://sync-eu.edge.app'];
   const logSettings = {
     ...defaultLogSettings,
     ...opts.logSettings
@@ -10629,9 +10723,9 @@ async function makeContext(ios, logBackend, opts) {
     return state.ready ? state.logSettings : logSettings;
   });
   const log = makeLog(logBackend, 'edge-core');
+  let [clientInfo, infoCache = {}, stashes] = await Promise.all([clientFile.load(io.disklet, CLIENT_FILE_NAME), infoCacheFile.load(io.disklet, INFO_CACHE_FILE_NAME), loadStashes(io.disklet, log)]);
 
-  // Load the clientId from disk:
-  let clientInfo = await clientFile.load(io.disklet, CLIENT_FILE_NAME);
+  // Save the clientId if we don't have one:
   if (clientInfo == null) {
     clientInfo = {
       clientId: io.random(16)
@@ -10640,13 +10734,13 @@ async function makeContext(ios, logBackend, opts) {
   }
 
   // Load the login stashes from disk:
-  const stashes = await loadStashes(io.disklet, log);
   redux$1.dispatch({
     type: 'INIT',
     payload: {
       apiKey,
       appId,
       authServer,
+      infoCache,
       infoServers,
       syncServers,
       clientId: clientInfo.clientId,
@@ -10660,10 +10754,10 @@ async function makeContext(ios, logBackend, opts) {
   });
 
   // Subscribe to new plugins:
-  watchPlugins(ios, logBackend, pluginsInit, redux$1.dispatch);
+  watchPlugins(ios, infoCache, logBackend, pluginsInit, redux$1.dispatch);
 
   // Create sync client:
-  const syncClient = await edgeSyncClient.makeSyncClient({
+  const syncClient = edgeSyncClient.makeSyncClient({
     log,
     fetch: io.fetch,
     edgeServers: {
@@ -10720,9 +10814,9 @@ function closeEdge() {
  */
 class FakeDb {
   constructor() {
-    this.lobbies = {};
+    this.lobbies = new Map();
     this.logins = [];
-    this.repos = {};
+    this.repos = new Map();
   }
   getLoginById(loginId) {
     return this.logins.find(login => verifyData(login.loginId, loginId));
@@ -10757,7 +10851,7 @@ class FakeDb {
     }
   }
   setupRepo(syncKey, repo) {
-    this.repos[syncKey] = repo;
+    this.repos.set(syncKey, repo);
   }
   dumpLogin(login) {
     const makeTree = login => ({
@@ -11224,7 +11318,7 @@ function createLogin(request, login) {
     keyBoxes: []
   }))(body.data);
   for (const syncKey of keys.newSyncKeys) {
-    db.repos[syncKey] = {};
+    db.repos.set(syncKey, {});
   }
 
   // Start building the new database row:
@@ -11267,7 +11361,7 @@ const addKeysRoute = withLogin2(request => {
 
   // Set up repos:
   for (const syncKey of clean.newSyncKeys) {
-    db.repos[syncKey] = {};
+    db.repos.set(syncKey, {});
   }
   login.keyBoxes = softCat(login.keyBoxes, clean.keyBoxes);
   return statusResponse();
@@ -11526,7 +11620,7 @@ const withLobby = (server, fallback = handleMissingLobby) => request => {
     path
   } = request;
   const lobbyId = path.split('/')[4];
-  const lobby = db.lobbies[lobbyId];
+  const lobby = db.lobbies.get(lobbyId);
   return lobby != null ? server({
     ...request,
     lobby,
@@ -11550,11 +11644,11 @@ const createLobbyRoute = withLobby(request => statusResponse(statusCodes.account
     timeout = 600
   } = clean;
   const expires = new Date(Date.now() + 1000 * timeout).toISOString();
-  db.lobbies[lobbyId] = {
+  db.lobbies.set(lobbyId, {
     request: clean,
     replies: [],
     expires
-  };
+  });
   return statusResponse();
 });
 const updateLobbyRoute = withLobby(request => {
@@ -11580,7 +11674,7 @@ const deleteLobbyRoute = withLobby(request => {
     db,
     lobbyId
   } = request;
-  delete db.lobbies[lobbyId];
+  db.lobbies.delete(lobbyId);
   return statusResponse();
 });
 
@@ -11623,7 +11717,7 @@ const withRepo = server => request => {
   const syncKey = elements[4];
   // const hash = elements[5]
 
-  const repo = db.repos[syncKey];
+  const repo = db.repos.get(syncKey);
   if (repo == null) {
     // This is not the auth server, so we have a different format:
     return jsonResponse({
@@ -11867,7 +11961,9 @@ function makeFakeWorld(ios, logBackend, users) {
 
       // Find the data on the server:
       const login = fakeDb.getLoginById(loginId);
-      if (login == null) throw new Error(`Cannot find user ${account.username}`);
+      if (login == null) {
+        throw new Error(`Cannot find user ${account.rootLoginId}`);
+      }
 
       // Figure out which repos to use:
       const syncKeys = [];
@@ -11878,7 +11974,8 @@ function makeFakeWorld(ios, logBackend, users) {
       }
       const repos = {};
       for (const syncKey of syncKeys) {
-        repos[syncKey] = wasEdgeRepoDump(fakeDb.repos[syncKey]);
+        const repo = fakeDb.repos.get(syncKey);
+        if (repo != null) repos[syncKey] = wasEdgeRepoDump(repo);
       }
       return {
         lastLogin: account.lastLogin,

package/lib/types/types.js

@@ -1894,6 +1894,10 @@ export * from './server-types'
 
 
 
+
+
+
+
 
 
 

package/lib/util/match-json.js

@@ -0,0 +1,47 @@
+/**
+ * Compares two JSON-like objects, returning false if they differ.
+ */
+export function matchJson(a, b) {
+  // Use simple equality, unless a and b are proper objects:
+  if (
+    typeof a !== 'object' ||
+    typeof b !== 'object' ||
+    a == null ||
+    b == null
+  ) {
+    return a === b
+  }
+
+  // These must either be both arrays or both objects:
+  const aIsArray = Array.isArray(a)
+  const bIsArray = Array.isArray(b)
+  if (aIsArray !== bIsArray) return false
+
+  // Compare arrays in order:
+  if (aIsArray) {
+    if (a.length !== b.length) return false
+    for (let i = 0; i < a.length; ++i) {
+      if (!matchJson(a[i], b[i])) return false
+    }
+    return true
+  }
+
+  // These are both regular objects, so grab the keys,
+  // ignoring entries where the value is `undefined`:
+  const aKeys = Object.getOwnPropertyNames(a).filter(
+    key => a[key] !== undefined
+  )
+  const bKeys = Object.getOwnPropertyNames(b).filter(
+    key => b[key] !== undefined
+  )
+  if (aKeys.length !== bKeys.length) return false
+
+  // We know that both objects have the same number of properties,
+  // so if every property in `a` has a matching property in `b`,
+  // the objects must be identical, regardless of key order.
+  for (const key of aKeys) {
+    if (!Object.prototype.hasOwnProperty.call(b, key)) return false
+    if (!matchJson(a[key], b[key])) return false
+  }
+  return true
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-core-js",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Edge account & wallet management library",
   "keywords": [
     "bitcoin",

package/src/types/types.ts

@@ -163,9 +163,12 @@ export interface EdgeNativeIo {
  * All core plugins receive these options at creation time.
  */
 export interface EdgeCorePluginOptions {
-  // Load-time options (like API keys) passed into the context:
+  /** Load-time options (like API keys) passed into the context */
   initOptions: JsonObject
 
+  /** Data provided by the info server */
+  infoPayload: JsonObject
+
   // Access to the world outside the plugin:
   io: EdgeIo
   log: EdgeLog // Plugin-scoped logging
@@ -1034,6 +1037,7 @@ export interface EdgeCurrencyPlugin {
     walletInfo: EdgeWalletInfo,
     opts: EdgeCurrencyEngineOptions
   ) => Promise<EdgeCurrencyEngine>
+  readonly updateInfoPayload?: (infoPayload: JsonObject) => Promise<void>
 
   // Escape hatch:
   readonly otherMethods?: EdgeOtherMethods
@@ -1311,7 +1315,7 @@ export interface EdgeSwapPlugin {
   readonly fetchSwapQuote: (
     request: EdgeSwapRequest,
     userSettings: JsonObject | undefined,
-    opts: { promoCode?: string }
+    opts: { infoPayload: JsonObject; promoCode?: string }
   ) => Promise<EdgeSwapQuote>
 }
 

package/lib/core/context/context-reducer.js

@@ -1,31 +0,0 @@
-import { buildReducer } from 'redux-keto'
-
-
-
-
-
-
-
-
-
-
-
-
-const defaultEdgeServers = {
-  infoServers: [],
-  syncServers: []
-}
-
-export const contextConfig = buildReducer
-
-
-
-({
-  edgeServers(state = defaultEdgeServers, action) {
-    if (action.type === 'INIT') {
-      const { infoServers, syncServers } = action.payload
-      return { infoServers, syncServers }
-    }
-    return state
-  }
-})