edge-currency-plugins 3.15.0 → 3.17.0

package/lib/src/common/utxobased/engine/ServerStates.d.ts

@@ -8,10 +8,20 @@ import { AddressResponse, AddressUtxosResponse, BlockbookTransaction } from '../
 import Deferred from '../network/Deferred';
 import { WsTask, WsTaskGenerator } from '../network/Socket';
 import { UtxoInitOptions } from './types';
+/**
+ * What the last REST health probe said about a connected server:
+ * - `pending`: the probe has not answered yet.
+ * - `healthy`: Blockbook reported `inSync: true`.
+ * - `unhealthy`: Blockbook reported `inSync: false`.
+ * - `unknown`: the server has no HTTP twin to probe, or the probe failed
+ *   (network error, non-200, unparseable body). Never treated as unhealthy.
+ */
+export declare type ServerHealth = 'pending' | 'healthy' | 'unhealthy' | 'unknown';
 export interface ServerState {
     blockbook: Blockbook;
     blockSubscriptionStatus: 'unsubscribed' | 'subscribing' | 'subscribed';
     blockHeight: number;
+    health: ServerHealth;
     txids: Set<string>;
     addresses: Set<string>;
 }
@@ -28,12 +38,21 @@ interface ServerStateConfig {
      * seconds the socket layer uses for a request. Exposed for tests.
      */
     broadcastTimeoutMs?: number;
+    /**
+     * Timing overrides so tests can drive the keepalive probe cycle in
+     * milliseconds rather than minutes. Production uses the defaults.
+     */
+    healthProbeMinIntervalMs?: number;
+    healthProbeTimeoutMs?: number;
+    keepAliveMs?: number;
+    wakeUpMs?: number;
 }
 export interface ServerStates {
     setPickNextTaskCB: (callback: (uri: string) => AsyncGenerator<WsTask<unknown> | boolean>) => void;
     stop: () => void;
     serverCanGetTx: (uri: string, txid: string) => boolean;
     serverCanGetAddress: (uri: string, address: string) => boolean;
+    serverCanGetAddressHistory: (uri: string, address: string) => boolean;
     serverIsAwareOfAddress: (uri: string, address: string) => boolean;
     getServerState: (uri: string) => ServerState | undefined;
     refillServers: () => void;
@@ -43,6 +62,7 @@ export interface ServerStates {
     watchAddresses: (uri: string, addresses: string[], deferredAddressSub?: Deferred<unknown>) => void;
     watchBlocks: (uri: string) => void;
     getBlockHeight: (uri: string) => number;
+    getServerHealth: (uri: string) => ServerHealth | undefined;
     addressQueryTask: (serverUri: string, address: string, params: {
         lastQueriedBlockHeight: number;
         page: number;
@@ -67,5 +87,17 @@ export declare const NOWNODES_BROADCAST_DELAY_MS = 2000;
  * open. This mirrors the socket figure.
  */
 export declare const BROADCAST_ATTEMPT_TIMEOUT_MS = 30000;
+/**
+ * Upper bound on a REST health probe. The probe runs off the socket keepalive
+ * and must never hold the connection's timer for long.
+ */
+export declare const HEALTH_PROBE_TIMEOUT_MS = 10000;
+/**
+ * Probes of one server closer together than this share a single request,
+ * across every wallet of the plugin. The connect path and the first
+ * keepalive can land within milliseconds of each other, and N wallets each
+ * run their own keepalive; one answer serves them all.
+ */
+export declare const HEALTH_PROBE_MIN_INTERVAL_MS = 10000;
 export declare function makeServerStates(config: ServerStateConfig): ServerStates;
 export {};

package/lib/src/common/utxobased/engine/UtxoEngineProcessor.d.ts

@@ -42,7 +42,9 @@ interface CommonParams {
     emitter: EngineEmitter;
     taskCache: TaskCache;
     pendingTimeouts: Set<NodeJS.Timeout>;
-    updateProgressRatio: () => void;
+    electrumHistoryAddresses: Set<string>;
+    reopenAddresses: (addresses: Iterable<string>) => number;
+    updateProgressRatio: (scriptPubkey: string, process: AddressProcess) => Promise<void>;
     updateSeenTxCheckpoint: () => void;
     io: EdgeIo;
     log: EdgeLog;
@@ -75,6 +77,8 @@ interface AddressForUtxosCache {
         path: ChangePath;
     };
 }
+/** The two per-address jobs that make up the sync progress ratio. */
+declare type AddressProcess = 'txs' | 'utxos';
 interface AddressSubscribeCache {
     [key: string]: {
         processing: boolean;

package/lib/src/common/utxobased/info/all.d.ts

@@ -12,6 +12,8 @@ export { info as digibyte } from './digibyte';
 export { info as dogecoin } from './dogecoin';
 export { info as eboost } from './eboost';
 export { info as ecash } from './ecash';
+export { info as ecashbitcoin } from './ecashbitcoin';
+export { info as ecashbitcoinbetanet } from './ecashbitcoinbetanet';
 export { info as feathercoin } from './feathercoin';
 export { info as groestlcoin } from './groestlcoin';
 export { info as litecoin } from './litecoin';

package/lib/src/common/utxobased/info/ecashbitcoin.d.ts

@@ -0,0 +1,3 @@
+import { CoinInfo, PluginInfo } from '../../plugin/types';
+export declare const coinInfo: CoinInfo;
+export declare const info: PluginInfo;

package/lib/src/common/utxobased/info/ecashbitcoinbetanet.d.ts

@@ -0,0 +1,3 @@
+import { CoinInfo, PluginInfo } from '../../plugin/types';
+export declare const coinInfo: CoinInfo;
+export declare const info: PluginInfo;

package/lib/src/common/utxobased/network/Blockbook.d.ts

@@ -2,7 +2,7 @@ import { Cleaner } from 'cleaners';
 import { EdgeLog, EdgeTransaction } from 'edge-core-js/types';
 import { EngineEmitter } from '../../plugin/EngineEmitter';
 import { UtxoInitOptions } from '../engine/types';
-import { AddressResponse, AddresssMessageParams, AddressUtxosResponse, BlockbookTask, BlockbookTransaction, BroadcastTxResponse, InfoResponse, SubscribeAddressResponse, TransactionResponse } from './blockbookApi';
+import { AddressResponse, AddresssMessageParams, AddressUtxosResponse, BlockbookTask, BlockbookTransaction, BroadcastTxResponse, InfoResponse, SubscribeAddressResponse, SubscribeNewBlockResponse, TransactionResponse } from './blockbookApi';
 import Deferred from './Deferred';
 import { TaskGeneratorFn, WsResponse, WsTaskGenerator } from './Socket';
 import { SocketEmitter } from './SocketEmitter';
@@ -40,8 +40,13 @@ interface BlockbookConfig {
     log: EdgeLog;
     taskGeneratorFn: TaskGeneratorFn;
     ping?: () => Promise<void>;
+    /** The new-block subscription, for servers that are not Blockbook. */
+    subscribeNewBlockMessage?: () => BlockbookTask<SubscribeNewBlockResponse>;
     socketEmitter: SocketEmitter;
     walletId: string;
+    /** Socket timing overrides, for tests. */
+    keepAliveMs?: number;
+    wakeUpMs?: number;
 }
 export declare function makeBlockbook(config: BlockbookConfig): Blockbook;
 export {};

package/lib/src/common/utxobased/network/BlockbookElectrum.d.ts

@@ -25,3 +25,5 @@ export interface ElectrumResponseMessage {
     } | undefined;
 }
 export declare function makeBlockbookElectrum(config: BlockbookElectrumConfig): Blockbook;
+/** True for the URIs of Electrum servers, as opposed to Blockbook servers. */
+export declare const isElectrumUri: (uri: string) => boolean;

package/lib/src/common/utxobased/network/Socket.d.ts

@@ -39,6 +39,10 @@ interface SocketConfig {
     taskGeneratorFn: TaskGeneratorFn;
     timeout?: number;
     walletId: string;
+    /** Keepalive interval override, for tests. Defaults to KEEP_ALIVE_MS. */
+    keepAliveMs?: number;
+    /** Timer wake-up interval override, for tests. Defaults to WAKE_UP_MS. */
+    wakeUpMs?: number;
 }
 export declare type WsResponse = WsResponseMessage[];
 export interface WsResponseMessage {

package/lib/src/common/utxobased/network/electrumApi.d.ts

@@ -67,6 +67,15 @@ export declare const asElectrumResponse: <T>(asT: Cleaner<T>) => Cleaner<T>;
 export declare const pingMessage: () => ElectrumTask<PingResponse>;
 export declare type PingResponse = ReturnType<typeof asPingResponse>;
 export declare const asPingResponse: Cleaner<undefined>;
+/**
+ * Subscribe to Headers (Get Block Height)
+ */
+export declare const headersSubscribeMessage: () => ElectrumTask<HeadersSubscribeResponse>;
+export declare type HeadersSubscribeResponse = ReturnType<typeof asHeadersSubscribeResponse>;
+export declare const asHeadersSubscribeResponse: import("cleaners").ObjectCleaner<{
+    height: number;
+    hex: string;
+}>;
 /**
  * List Unspent (Get UTXOs)
  */
@@ -88,3 +97,15 @@ export declare const asAddressTransactionsResponse: Cleaner<{
 export declare const transactionMessage: (txHash: string, asAddress?: Cleaner<string>) => ElectrumTask<TransactionResponse>;
 export declare type TransactionResponse = ElectrumTransaction;
 export declare const asTransactionResponse: (asAddress?: Cleaner<string>) => Cleaner<ElectrumTransaction>;
+/**
+ * Get Raw Transaction
+ */
+export declare const rawTransactionMessage: (txHash: string) => ElectrumTask<RawTransactionResponse>;
+export declare type RawTransactionResponse = ReturnType<typeof asRawTransactionResponse>;
+export declare const asRawTransactionResponse: Cleaner<string>;
+/**
+ * Broadcast Transaction
+ */
+export declare const broadcastTransactionMessage: (rawTx: string) => ElectrumTask<BroadcastTransactionResponse>;
+export declare type BroadcastTransactionResponse = ReturnType<typeof asBroadcastTransactionResponse>;
+export declare const asBroadcastTransactionResponse: Cleaner<string>;

package/lib/test/common/plugin/PluginState.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/common/utxobased/engine/AddressRepair.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/common/utxobased/engine/UtxoEngineProcessor.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/common/utxobased/keymanager/coins/ecashbitcointransactiontest.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/common/utxobased/network/BlockbookElectrum.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "3.15.0",
+  "version": "3.17.0",
   "description": "Edge currency plugins to fetch and process wallet accounts, balances and transactions.",
   "homepage": "https://edge.app/",
   "repository": "https://github.com/EdgeApp/edge-currency-plugins",