Merge pull request #396 from EdgeApp/sam/http-blockbook

Add fallbackServers to EngineInfo

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- added: New fallback server engine info, starting with NOWNodes blockbook servers
+
 ## 2.5.4 (2024-01-26)
 
 - fixed: Check for NaN target totals in `subtractFee` style transactions

src/bch.ts

@@ -1,6 +1,6 @@
 import { EdgeCorePluginOptions, EdgeCurrencyPlugin } from 'edge-core-js/types'
 
-import { makeCurrencyPlugin } from './common/plugin/makeCurrencyPlugin'
+import { makeCurrencyPlugin } from './common/plugin/CurrencyPlugin'
 import { info } from './common/utxobased/info/bitcoincash'
 
 const plugin = (options: EdgeCorePluginOptions): EdgeCurrencyPlugin =>

src/bsv.ts

@@ -1,6 +1,6 @@
 import { EdgeCorePluginOptions, EdgeCurrencyPlugin } from 'edge-core-js/types'
 
-import { makeCurrencyPlugin } from './common/plugin/makeCurrencyPlugin'
+import { makeCurrencyPlugin } from './common/plugin/CurrencyPlugin'
 import { info } from './common/utxobased/info/bitcoinsv'
 
 const plugin = (options: EdgeCorePluginOptions): EdgeCurrencyPlugin =>

src/btc.ts

@@ -1,6 +1,6 @@
 import { EdgeCorePluginOptions, EdgeCurrencyPlugin } from 'edge-core-js/types'
 
-import { makeCurrencyPlugin } from './common/plugin/makeCurrencyPlugin'
+import { makeCurrencyPlugin } from './common/plugin/CurrencyPlugin'
 import { info } from './common/utxobased/info/bitcoin'
 
 const plugin = (options: EdgeCorePluginOptions): EdgeCurrencyPlugin =>

src/common/plugin/makeCurrencyPlugin.ts → src/common/plugin/CurrencyPlugin.ts

@@ -7,19 +7,22 @@ import {
   EdgeWalletInfo
 } from 'edge-core-js/types'
 
-import { makeUtxoEngine } from '../utxobased/engine/makeUtxoEngine'
-import { asUtxoUserSettings } from '../utxobased/engine/types'
-import { makeCurrencyTools } from './makeCurrencyTools'
-import { makeEngineEmitter } from './makeEngineEmitter'
-import { makePluginState } from './pluginState'
+import {
+  asUtxoInitOptions,
+  asUtxoUserSettings
+} from '../utxobased/engine/types'
+import { makeUtxoEngine } from '../utxobased/engine/UtxoEngine'
+import { makeCurrencyTools } from './CurrencyTools'
+import { makeEngineEmitter } from './EngineEmitter'
+import { makePluginState } from './PluginState'
 import { EngineConfig, PluginInfo } from './types'
 
 export function makeCurrencyPlugin(
   pluginOptions: EdgeCorePluginOptions,
   pluginInfo: PluginInfo
 ): EdgeCurrencyPlugin {
   const { currencyInfo } = pluginInfo
-  const { io, log, pluginDisklet } = pluginOptions
+  const { io, log, pluginDisklet, initOptions } = pluginOptions
   const currencyTools = makeCurrencyTools(io, pluginInfo)
   const { defaultSettings, pluginId, currencyCode } = currencyInfo
   const pluginState = makePluginState({
@@ -43,6 +46,7 @@ export function makeCurrencyPlugin(
         pluginInfo,
         pluginDisklet,
         currencyTools,
+        initOptions: asUtxoInitOptions(initOptions),
         io,
         options: {
           ...pluginOptions,

src/common/plugin/makeEngineEmitter.ts → src/common/plugin/EngineEmitter.ts

@@ -5,7 +5,7 @@ import {
 } from 'edge-core-js/types'
 import { EventEmitter } from 'events'
 
-import { SubscribeAddressResponse } from '../utxobased/network/BlockBookAPI'
+import { SubscribeAddressResponse } from '../utxobased/network/blockbookApi'
 
 export declare interface EngineEmitter {
   emit: ((

src/common/plugin/makeMetadata.ts → src/common/plugin/Metadata.ts

@@ -4,7 +4,7 @@ import { EdgeLog } from 'edge-core-js/types'
 import { makeMemlet } from 'memlet'
 
 import AwaitLock from '../utxobased/engine/await-lock'
-import { EngineEmitter, EngineEvent } from './makeEngineEmitter'
+import { EngineEmitter, EngineEvent } from './EngineEmitter'
 import { asLocalWalletMetadata, LocalWalletMetadata } from './types'
 import { removeItem } from './utils'
 

src/common/plugin/pluginState.ts → src/common/plugin/PluginState.ts

@@ -5,19 +5,19 @@ import { Disklet } from 'disklet'
 import { EdgeIo, EdgeLog } from 'edge-core-js/types'
 import { makeMemlet } from 'memlet'
 
-import { UtxoEngineState } from '../utxobased/engine/makeUtxoEngineState'
 import { UtxoUserSettings } from '../utxobased/engine/types'
+import { UtxoEngineState } from '../utxobased/engine/UtxoEngineState'
 import {
   asServerCache,
   ServerCache,
   ServerList,
   ServerScores
-} from './serverScores'
+} from './ServerScores'
 
 // Info server endpoint to getting ServerListInfo data
-const serverListInfoUrl = 'https://info1.edge.app/v1/blockBook/'
-// The filename for ServerInfoCache data (see serverScores.ts)
-// Perhaps this should be in serverScores.ts file, but that'll take some refactoring
+const serverListInfoUrl = 'https://info1.edge.app/v1/blockbook/'
+// The filename for ServerInfoCache data (see ServerScores.ts)
+// Perhaps this should be in ServerScores.ts file, but that'll take some refactoring
 const SERVER_CACHE_FILE = 'serverCache.json'
 
 // ServerListInfo data structure from info server and saved to disk
@@ -51,7 +51,7 @@ export interface PluginState {
   clearCache: () => Promise<void>
   getLocalServers: (
     numServersWanted: number,
-    includePatterns: string[]
+    includePatterns?: Array<string | RegExp>
   ) => string[]
   refreshServers: () => Promise<void>
   updateServers: (settings: UtxoUserSettings) => Promise<void>
@@ -209,7 +209,7 @@ export function makePluginState(settings: PluginStateSettings): PluginState {
 
     getLocalServers(
       numServersWanted: number,
-      includePatterns: string[] = []
+      includePatterns: Array<string | RegExp> = []
     ): string[] {
       return serverScores.getServers(
         knownServers,

src/common/plugin/serverScores.ts → src/common/plugin/ServerScores.ts

@@ -208,7 +208,7 @@ export class ServerScores {
   getServers(
     servers: ServerList,
     numServersWanted: number,
-    includePatterns: string[] = []
+    includePatterns: Array<string | RegExp> = []
   ): string[] {
     if (servers == null || Object.keys(servers).length === 0) {
       return []
@@ -236,7 +236,14 @@ export class ServerScores {
       const filter = (server: ServerInfo): boolean => {
         for (const pattern of includePatterns) {
           // make sure that the server URL starts with the required pattern
-          if (server.serverUrl.indexOf(pattern) === 0) return true
+          if (
+            typeof pattern === 'string' &&
+            server.serverUrl.indexOf(pattern) === 0
+          )
+            return true
+          // Or make sure that the server URL matches regex
+          if (pattern instanceof RegExp && pattern.test(server.serverUrl))
+            return true
         }
         return false
       }

src/common/plugin/types.ts

@@ -23,10 +23,11 @@ import {
 import * as wif from 'wif'
 
 import { asIUTXO, IProcessorTransaction, IUTXO } from '../utxobased/db/types'
+import { UtxoInitOptions } from '../utxobased/engine/types'
 import { ScriptTemplates } from '../utxobased/info/scriptTemplates/types'
 import { UtxoPicker } from '../utxobased/keymanager/utxopicker'
-import { EngineEmitter } from './makeEngineEmitter'
-import { PluginState } from './pluginState'
+import { EngineEmitter } from './EngineEmitter'
+import { PluginState } from './PluginState'
 
 export type CurrencyFormat = ReturnType<typeof asCurrencyFormat>
 export const asCurrencyFormat = asValue('bip32', 'bip44', 'bip49', 'bip84')
@@ -70,6 +71,7 @@ export interface EngineInfo {
   mempoolSpaceFeeInfoServer?: string
   defaultFeeInfo: FeeInfo
   scriptTemplates?: ScriptTemplates
+  serverConfigs?: ServerConfig[]
   // Codec Cleaners
   asBlockbookAddress?: Cleaner<string>
   // Coin specific transaction handling
@@ -79,6 +81,11 @@ export interface EngineInfo {
   ) => IProcessorTransaction
 }
 
+export interface ServerConfig {
+  type: 'blockbook-nownode'
+  uris: string[]
+}
+
 /**
  * Coin Info
  */
@@ -196,6 +203,7 @@ export interface EngineConfig {
   pluginDisklet: Disklet
   currencyTools: EdgeCurrencyTools
   options: EngineOptions
+  initOptions: UtxoInitOptions
   io: EdgeIo
   pluginState: PluginState
 }

src/common/utxobased/db/Models/ProcessorTransaction.ts

@@ -4,9 +4,9 @@ import BN from 'bn.js'
 import { EdgeTransaction, JsonObject } from 'edge-core-js/types'
 
 import { PluginInfo } from '../../../plugin/types'
-import { UTXOPluginWalletTools } from '../../engine/makeUtxoWalletTools'
 import { UtxoTxOtherParams } from '../../engine/types'
-import { Processor } from '../makeProcessor'
+import { UtxoWalletTools } from '../../engine/UtxoWalletTools'
+import { Processor } from '../Processor'
 import { IProcessorTransaction } from '../types'
 
 export const fromEdgeTransaction = (
@@ -54,7 +54,7 @@ export const fromEdgeTransaction = (
 interface ToEdgeTransactionArgs {
   walletId: string
   tx: IProcessorTransaction
-  walletTools: UTXOPluginWalletTools
+  walletTools: UtxoWalletTools
   processor: Processor
   pluginInfo: PluginInfo
 }

src/common/utxobased/db/makeProcessor.ts → src/common/utxobased/db/Processor.ts

@@ -6,7 +6,7 @@ import { makeMemlet } from 'memlet'
 
 import { unixTime } from '../../../util/unixTime'
 import { AddressPath, ChangePath } from '../../plugin/types'
-import { makeBaselets } from './makeBaselets'
+import { makeBaselets } from './Baselets'
 import { addressPathToPrefix, TxIdByDate } from './Models/baselet'
 import {
   IAddress,

src/common/utxobased/db/util/utxo.ts

@@ -3,7 +3,7 @@ import {
   BIP43PurposeTypeEnum,
   ScriptTypeEnum
 } from '../../keymanager/keymanager'
-import { Processor } from '../makeProcessor'
+import { Processor } from '../Processor'
 import { IProcessorTransaction, IUTXO } from '../types'
 
 export const utxoFromProcessorTransactionInput = async (