Feat: (Health check) Check alt_ip if web domain is not accessible

src/config/utils/nodes.ts

@@ -1,4 +1,4 @@
-import { NodeInfo } from '@/types/wallets'
+import type { NodeInfo } from '@/types/wallets'
 import { BlockchainSymbol } from './types'
 import config from '../index'
 

src/lib/nodes/abstract.client.ts

@@ -95,7 +95,11 @@ export abstract class Client<N extends Node> {
   // This method can throw an error if there are no online nodes.
   // Better use "useClient()" method.
   getClient(): N['client'] {
-    return this.getNode().client
+    const node = this.getNode()
+
+    // Ethereum nodes return a new client every time depending on `preferDomain` property.
+    if (node.type === 'eth') return (node.client as () => N['client'])()
+    else return node.client
   }
 
   /**

src/lib/nodes/abstract.node.ts

@@ -1,4 +1,5 @@
-import { getHealthCheckInterval } from './utils/getHealthcheckConfig'
+import type { NodeInfo } from '@/types/wallets/index.ts'
+import { getBaseURL, getHealthCheckInterval } from './utils/getHealthcheckConfig'
 import { TNodeLabel } from './constants'
 import { HealthcheckInterval, HealthcheckResult, NodeKind, NodeStatus, NodeType } from './types'
 import { nodesStorage } from './storage'
@@ -29,6 +30,10 @@ export abstract class Node<C = unknown> {
    */
   wsPort = '36668'
 
+  /**
+   * Node alternative IP
+   */
+  altIp?: string
   /**
    * Node base URL
    */
@@ -56,10 +61,22 @@ export abstract class Node<C = unknown> {
   hasSupportedProtocol = true
 
   // Healthcheck related params
+  /**
+   * Indicates whether a node with alternative IP is available
+   */
+  altIpAvailable = false
+  /**
+   * Indicates whether a node with main URL is available
+   */
+  availableByDomain = true
   /**
    * Indicates whether node is available.
    */
   online = true
+  /**
+   * Indicates whether prefer a node with alternative IP or not
+   */
+  preferDomain = true
   /**
    * Node ping estimation
    */
@@ -97,13 +114,16 @@ export abstract class Node<C = unknown> {
   healthcheckInProgress = false
 
   constructor(
-    url: string,
+    endpoint: NodeInfo,
     type: NodeType,
     kind: NodeKind,
     label: TNodeLabel,
     version = '',
     minNodeVersion = ''
   ) {
+    const { alt_ip, url } = endpoint
+
+    this.altIp = alt_ip
     this.url = url
     this.type = type
     this.label = label
@@ -134,8 +154,31 @@ export abstract class Node<C = unknown> {
         this.height = health.height
         this.ping = health.ping
         this.online = true
+
+        if (this.preferDomain) {
+          console.info(
+            `Attempt to use domain ${this.url} performed successfully, using domain by default.`
+          )
+          this.availableByDomain = true
+        } else {
+          console.info(
+            `There was a failed attempt to use domain ${this.url}, using IP ${this.altIp} by default.`
+          )
+        }
       } catch {
-        this.online = false
+        if (this.preferDomain && this.availableByDomain) {
+          console.info(
+            `There was a failed attempt to use domain ${this.url}, trying to use IP ${this.altIp} in the next attempt.`
+          )
+          this.availableByDomain = false
+          this.preferDomain = false
+        } else {
+          console.info(
+            `There was failed attempts to use domain ${this.url} and IP ${this.altIp}, assume node is offline.`
+          )
+          this.online = false
+          this.preferDomain = true
+        }
       } finally {
         this.healthcheckInProgress = false
       }
@@ -164,6 +207,7 @@ export abstract class Node<C = unknown> {
 
   getStatus() {
     return {
+      alt_ip: this.altIp,
       url: this.url,
       port: this.port,
       hostname: this.hostname,
@@ -224,9 +268,11 @@ export abstract class Node<C = unknown> {
    * Enables/disables a node.
    */
   toggleNode(active: boolean) {
+    const baseURL = getBaseURL(this)
+
     this.active = active
 
-    nodesStorage.saveActive(this.url, active)
+    nodesStorage.saveActive(baseURL, active)
 
     return this.getStatus()
   }

src/lib/nodes/adm/AdmClient.ts

@@ -5,6 +5,7 @@ import {
   RegisterChatMessageTransaction
 } from '@/lib/schema/client'
 import { NODE_LABELS } from '@/lib/nodes/constants'
+import type { NodeInfo } from '@/types/wallets'
 import { AdmNode, Payload, RequestConfig } from './AdmNode'
 import { Client } from '../abstract.client'
 
@@ -16,7 +17,7 @@ import { Client } from '../abstract.client'
  * is not available at the moment.
  */
 export class AdmClient extends Client<AdmNode> {
-  constructor(endpoints: string[] = [], minNodeVersion = '0.0.0') {
+  constructor(endpoints: NodeInfo[] = [], minNodeVersion = '0.0.0') {
     super('adm', 'node', NODE_LABELS.AdmNode)
     this.nodes = endpoints.map((endpoint) => new AdmNode(endpoint, minNodeVersion))
     this.minNodeVersion = minNodeVersion
@@ -75,7 +76,9 @@ export class AdmClient extends Client<AdmNode> {
     return this.getNode().timeDelta
   }
 
-  async sendChatTransaction(transaction: RegisterChatMessageTransaction): Promise<CreateNewChatMessageResponseDto> {
+  async sendChatTransaction(
+    transaction: RegisterChatMessageTransaction
+  ): Promise<CreateNewChatMessageResponseDto> {
     return this.post('/api/chats/process', () => ({ transaction }))
   }
 }

src/lib/nodes/adm/AdmNode.ts

@@ -4,6 +4,8 @@ import { GetNodeStatusResponseDto } from '@/lib/schema/client'
 import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'
 import { Node } from '@/lib/nodes/abstract.node'
 import { NODE_LABELS } from '@/lib/nodes/constants'
+import { getBaseURL } from '@/lib/nodes/utils/getHealthcheckConfig'
+import type { NodeInfo } from '@/types/wallets'
 
 type FetchNodeInfoResult = {
   socketSupport: boolean
@@ -18,6 +20,7 @@ export type Payload =
       (ctx: AdmNode): Record<string, any>
     }
 export type RequestConfig<P extends Payload> = {
+  baseURL?: string
   url: string
   method?: string
   payload?: P
@@ -28,18 +31,18 @@ export type RequestConfig<P extends Payload> = {
  * to the node and verify is status (online/offline, version, ping, etc.)
  */
 export class AdmNode extends Node<AxiosInstance> {
-  constructor(url: string, minNodeVersion = '0.0.0') {
-    super(url, 'adm', 'node', NODE_LABELS.AdmNode, '', minNodeVersion)
+  constructor(endpoint: NodeInfo, minNodeVersion = '0.0.0') {
+    super(endpoint, 'adm', 'node', NODE_LABELS.AdmNode, '', minNodeVersion)
 
     this.wsPort = '36668' // default wsPort
     this.wsProtocol = this.protocol === 'https:' ? 'wss:' : 'ws:'
     this.wsPortNeeded = this.wsProtocol === 'ws:' && !this.hostname.includes('.onion')
   }
 
   protected buildClient(): AxiosInstance {
-    return axios.create({
-      baseURL: this.url
-    })
+    const baseURL = getBaseURL(this)
+
+    return axios.create({ baseURL })
   }
 
   /**
@@ -50,8 +53,10 @@ export class AdmNode extends Node<AxiosInstance> {
    */
   request<P extends Payload = Payload, R = any>(cfg: RequestConfig<P>): Promise<R> {
     const { url, method = 'get', payload } = cfg
+    const baseURL = getBaseURL(this)
 
     const config: AxiosRequestConfig = {
+      baseURL,
       url,
       method: method.toLowerCase(),
       [method === 'get' ? 'params' : 'data']:
@@ -72,7 +77,6 @@ export class AdmNode extends Node<AxiosInstance> {
         // According to https://github.com/axios/axios#handling-errors this means, that request was sent,
         // but server could not respond.
         if (!error.response && error.request) {
-          this.online = false
           throw new NodeOfflineError()
         }
         throw error

src/lib/nodes/adm/index.ts

@@ -1,8 +1,9 @@
 import config from '@/config'
-import { NodeInfo } from '@/types/wallets'
+import type { NodeInfo } from '@/types/wallets'
 import { AdmClient } from './AdmClient'
 
-const endpoints = (config.adm.nodes.list as NodeInfo[]).map((endpoint) => endpoint.url)
+const endpoints = config.adm.nodes.list as NodeInfo[]
+
 export const adm = new AdmClient(endpoints, config.adm.nodes.minVersion)
 
 export default adm

src/lib/nodes/btc-indexer/BtcIndexer.ts

@@ -2,25 +2,35 @@ import { createBtcLikeClient } from '../utils/createBtcLikeClient'
 import { AxiosInstance, AxiosRequestConfig } from 'axios'
 import { Node } from '@/lib/nodes/abstract.node'
 import { NODE_LABELS } from '@/lib/nodes/constants'
+import { getBaseURL } from '@/lib/nodes/utils/getHealthcheckConfig'
+import type { NodeInfo } from '@/types/wallets'
 
 /**
  * Encapsulates a node. Provides methods to send API-requests
  * to the node and verify is status (online/offline, version, ping, etc.)
  */
 export class BtcIndexer extends Node<AxiosInstance> {
-  constructor(url: string) {
-    super(url, 'btc', 'service', NODE_LABELS.BtcIndexer)
+  constructor(endpoint: NodeInfo) {
+    super(endpoint, 'btc', 'service', NODE_LABELS.BtcIndexer)
   }
 
   protected buildClient(): AxiosInstance {
-    return createBtcLikeClient(this.url)
+    const baseURL = getBaseURL(this)
+
+    return createBtcLikeClient(baseURL)
   }
 
   protected async checkHealth() {
     const time = Date.now()
-    const blockNumber = await this.client.get('/blocks/tip/height').then((res) => {
-      return Number(res.data) || 0
-    })
+    const baseURL = getBaseURL(this)
+
+    const blockNumber = await this.client
+      .get('/blocks/tip/height', {
+        baseURL
+      })
+      .then((res) => {
+        return Number(res.data) || 0
+      })
 
     return {
       height: Number(blockNumber),
@@ -37,9 +47,12 @@ export class BtcIndexer extends Node<AxiosInstance> {
     params?: Params,
     requestConfig?: AxiosRequestConfig
   ): Promise<Response> {
+    const baseURL = getBaseURL(this)
+
     return this.client
       .request({
         ...requestConfig,
+        baseURL,
         url: path,
         method,
         params: method === 'GET' ? params : undefined,

src/lib/nodes/btc-indexer/BtcIndexerClient.ts

@@ -1,5 +1,6 @@
 import type { AxiosRequestConfig } from 'axios'
 import { NODE_LABELS } from '@/lib/nodes/constants'
+import type { NodeInfo } from '@/types/wallets'
 import { Client } from '../abstract.client'
 import { BtcIndexer } from './BtcIndexer'
 import { MULTIPLIER, normalizeTransaction } from './utils'
@@ -17,7 +18,7 @@ import { GetUnspentsParams } from './types/api/get-unspents/get-unspents-params'
  * is not available at the moment.
  */
 export class BtcIndexerClient extends Client<BtcIndexer> {
-  constructor(endpoints: string[] = [], minNodeVersion = '0.0.0') {
+  constructor(endpoints: NodeInfo[] = [], minNodeVersion = '0.0.0') {
     super('btc', 'service', NODE_LABELS.BtcIndexer)
     this.nodes = endpoints.map((endpoint) => new BtcIndexer(endpoint))
     this.minNodeVersion = minNodeVersion

src/lib/nodes/btc-indexer/index.ts

@@ -1,8 +1,9 @@
 import config from '@/config'
-import { NodeInfo } from '@/types/wallets'
+import type { NodeInfo } from '@/types/wallets'
 import { BtcIndexerClient } from './BtcIndexerClient'
 
-const endpoints = (config.btc.services.btcIndexer.list as NodeInfo[]).map((endpoint) => endpoint.url)
+const endpoints = config.btc.services.btcIndexer.list as NodeInfo[]
+
 export const btcIndexer = new BtcIndexerClient(endpoints)
 
 export default btcIndexer

src/lib/nodes/btc/BtcClient.ts

@@ -1,5 +1,6 @@
 import type { AxiosRequestConfig } from 'axios'
 import { NODE_LABELS } from '@/lib/nodes/constants'
+import type { NodeInfo } from '@/types/wallets'
 import { BtcNode } from './BtcNode'
 import { Client } from '../abstract.client'
 import { RpcRequest } from './types/api/common'
@@ -12,7 +13,7 @@ import { RpcRequest } from './types/api/common'
  * is not available at the moment.
  */
 export class BtcClient extends Client<BtcNode> {
-  constructor(endpoints: string[] = [], minNodeVersion = '0.0.0') {
+  constructor(endpoints: NodeInfo[] = [], minNodeVersion = '0.0.0') {
     super('btc', 'node', NODE_LABELS.BtcNode)
     this.nodes = endpoints.map((endpoint) => new BtcNode(endpoint))
     this.minNodeVersion = minNodeVersion

src/lib/nodes/btc/BtcNode.ts

@@ -2,7 +2,9 @@ import { AxiosInstance, AxiosRequestConfig } from 'axios'
 import { createBtcLikeClient } from '../utils/createBtcLikeClient'
 import { Node } from '@/lib/nodes/abstract.node'
 import { NODE_LABELS } from '@/lib/nodes/constants'
+import { getBaseURL } from '@/lib/nodes/utils/getHealthcheckConfig'
 import { formatBtcVersion } from '@/lib/nodes/utils/nodeVersionFormatters'
+import type { NodeInfo } from '@/types/wallets'
 import { RpcRequest, RpcResponse } from './types/api/common'
 import { NetworkInfo } from './types/api/network-info'
 import { BlockchainInfo } from './types/api/blockchain-info'
@@ -12,12 +14,14 @@ import { BlockchainInfo } from './types/api/blockchain-info'
  * to the node and verify is status (online/offline, version, ping, etc.)
  */
 export class BtcNode extends Node<AxiosInstance> {
-  constructor(url: string) {
-    super(url, 'btc', 'node', NODE_LABELS.BtcNode)
+  constructor(endpoint: NodeInfo) {
+    super(endpoint, 'btc', 'node', NODE_LABELS.BtcNode)
   }
 
   protected buildClient(): AxiosInstance {
-    return createBtcLikeClient(this.url)
+    const baseURL = getBaseURL(this)
+
+    return createBtcLikeClient(baseURL)
   }
 
   protected async checkHealth() {
@@ -50,9 +54,12 @@ export class BtcNode extends Node<AxiosInstance> {
     params?: Params,
     requestConfig?: AxiosRequestConfig
   ): Promise<Result> {
+    const baseURL = getBaseURL(this)
+
     return this.client
       .request<RpcResponse<Result>>({
         ...requestConfig,
+        baseURL,
         method: 'POST',
         data: params
       })

src/lib/nodes/btc/index.ts

@@ -1,8 +1,9 @@
 import config from '@/config'
-import { NodeInfo } from '@/types/wallets'
+import type { NodeInfo } from '@/types/wallets'
 import { BtcClient } from './BtcClient'
 
-const endpoints = (config.btc.nodes.list as NodeInfo[]).map((endpoint) => endpoint.url)
+const endpoints = config.btc.nodes.list as NodeInfo[]
+
 export const btc = new BtcClient(endpoints)
 
 export default btc

src/lib/nodes/btc/types/api/common.ts

@@ -23,6 +23,7 @@ type Method =
   | 'getaddressbalance'
 
 export type RpcRequest<P = any, M extends Method | string = string> = {
+  baseURL?: string
   method: M
   params?: P
 }