@paraswap/dex-lib 2.12.12-rfqtests.0 → 2.12.12

package/build/lib/log-messages-suppressor.d.ts

@@ -0,0 +1,30 @@
+import { Logger, LogLevels } from '../types';
+export declare const DEFAULT_LOG_PUBLISH_PERIOD_MS = 60000;
+export declare const DEFAULT_LOG_DISCARD_PERIOD_MS: number;
+export declare const DEFAULT_LOG_MAX_IDENTITIES_TO_SHOW = 10;
+export declare type StandardStringEnum = Readonly<Record<string, string>>;
+export declare type MessageInfo<T extends StandardStringEnum> = {
+    key: keyof T;
+    message: T[keyof T];
+    logLevel: LogLevels;
+};
+export declare type MessageData = {
+    counter: number;
+    lastLoggedAtMs: number;
+    identificationInfos: string[];
+};
+export declare type AggregatedLogForEntity<T extends StandardStringEnum> = {
+    [key in keyof T]?: MessageData;
+};
+export declare class LogMessagesSuppressor<T extends StandardStringEnum> {
+    readonly entityName: string;
+    private _allMessages;
+    protected logger: Logger;
+    static instances: Record<string, LogMessagesSuppressor<any>>;
+    private _aggregatedLogs;
+    constructor(entityName: string, _allMessages: Record<keyof T, MessageInfo<T>>, logger: Logger);
+    static getLogSuppressorInstance<T extends StandardStringEnum>(entityName: string, allMessages: Record<keyof T, MessageInfo<T>>, logger: Logger): LogMessagesSuppressor<any>;
+    logMessage(msgKey: keyof T, identificationInfo?: string, ...args: unknown[]): void;
+    private _formatLogMessage;
+    private _clearMessageData;
+}

package/build/lib/log-messages-suppressor.js

@@ -0,0 +1,107 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogMessagesSuppressor = exports.DEFAULT_LOG_MAX_IDENTITIES_TO_SHOW = exports.DEFAULT_LOG_DISCARD_PERIOD_MS = exports.DEFAULT_LOG_PUBLISH_PERIOD_MS = void 0;
+const ts_essentials_1 = require("ts-essentials");
+const lodash_1 = __importDefault(require("lodash"));
+exports.DEFAULT_LOG_PUBLISH_PERIOD_MS = 60000;
+// After this period previous logs, even if unpublished, would be discarded
+// Because most likely they are outdated
+exports.DEFAULT_LOG_DISCARD_PERIOD_MS = 15 * 60 * 1000;
+// We may have hundreds of pools failing at the same time,
+// and we don't want to show them all
+exports.DEFAULT_LOG_MAX_IDENTITIES_TO_SHOW = 10;
+/*
+ * This is helper module to reduce frequency of logging of spamming messages
+ *
+ * 1. You can only have predefined set of log messages to log
+ * First time log message is received, it is published with all arguments.
+ * Limitation - message can not include variables, but you can pass them as args
+ * If within cooldown period received another message of the same category, it
+ * is not published, but counter is increased with addition of some entity identifier
+ *
+ * 2. There is no background task running. In order to keep relevance of logs,
+ * if after certain amount of time we didn't receive logs, then we discarded accumulated ones
+ * on the next received ones and only publish relevant ones
+ */
+class LogMessagesSuppressor {
+    constructor(entityName, _allMessages, logger) {
+        this.entityName = entityName;
+        this._allMessages = _allMessages;
+        this.logger = logger;
+        this._aggregatedLogs = {};
+    }
+    static getLogSuppressorInstance(entityName, allMessages, logger) {
+        const instance = LogMessagesSuppressor.instances[entityName];
+        if (instance === undefined) {
+            LogMessagesSuppressor.instances[entityName] =
+                new LogMessagesSuppressor(entityName, allMessages, logger);
+        }
+        else {
+            (0, ts_essentials_1.assert)(lodash_1.default.isEqual(allMessages, instance._allMessages), 'getLogSuppressorInstance: try to get existing instance with different allMessagesInfo');
+            (0, ts_essentials_1.assert)(lodash_1.default.isEqual(logger, instance.logger), 'getLogSuppressorInstance: try to get existing instance with different logger');
+        }
+        return LogMessagesSuppressor.instances[entityName];
+    }
+    logMessage(msgKey, identificationInfo = '', ...args) {
+        const msgInfo = this._allMessages[msgKey];
+        (0, ts_essentials_1.assert)(msgInfo !== undefined, `Used unrecognized msgKey=${String(msgKey)} to get msgInfo`);
+        if (this._aggregatedLogs[msgKey] === undefined) {
+            this._aggregatedLogs[msgKey] = {
+                counter: 0,
+                identificationInfos: identificationInfo === '' ? [] : [identificationInfo],
+                lastLoggedAtMs: 0,
+            };
+        }
+        const msgData = this._aggregatedLogs[msgKey];
+        (0, ts_essentials_1.assert)(msgData !== undefined, `msgData is undefined for msgKey=${String(msgKey)}`);
+        const nowMs = Date.now();
+        const elapsedSinceLastPublish = nowMs - msgData.lastLoggedAtMs;
+        if (elapsedSinceLastPublish > exports.DEFAULT_LOG_PUBLISH_PERIOD_MS) {
+            // Accumulated logs are too old to have any relevance, so better to discard them
+            if (elapsedSinceLastPublish > exports.DEFAULT_LOG_DISCARD_PERIOD_MS) {
+                this._clearMessageData(msgData);
+            }
+            // Make actual logging
+            // Logging is done using original logger of the entity to keep module info
+            // and not override it
+            this.logger[msgInfo.logLevel](this._formatLogMessage(msgData, msgInfo.message), ...args);
+            this._clearMessageData(msgData);
+        }
+        else {
+            msgData.counter++;
+            if (identificationInfo !== '') {
+                msgData.identificationInfos.push(identificationInfo);
+            }
+        }
+    }
+    _formatLogMessage(msgData, message) {
+        const { counter, identificationInfos } = msgData;
+        let identities = identificationInfos && identificationInfos.length === 0
+            ? ''
+            : ` for entities: ${identificationInfos.length > exports.DEFAULT_LOG_MAX_IDENTITIES_TO_SHOW
+                ? identificationInfos
+                    .slice(exports.DEFAULT_LOG_MAX_IDENTITIES_TO_SHOW)
+                    .join(',')
+                : identificationInfos.join(',')}`;
+        if (identificationInfos &&
+            identificationInfos.length > exports.DEFAULT_LOG_MAX_IDENTITIES_TO_SHOW) {
+            identities = `${identities}... ${identificationInfos.length} total`;
+        }
+        return `${this.entityName}: logged ${counter} occurrences of: "${message}"${identities}. `;
+    }
+    _clearMessageData(messageData) {
+        messageData.counter = 0;
+        if (messageData.identificationInfos) {
+            messageData.identificationInfos.length = 0;
+        }
+        messageData.lastLoggedAtMs = Date.now();
+    }
+}
+exports.LogMessagesSuppressor = LogMessagesSuppressor;
+// I don't really like this any, but couldn't come up with better solution
+// in reasonable time. So, in order to unblock myself, do this
+LogMessagesSuppressor.instances = {};
+//# sourceMappingURL=log-messages-suppressor.js.map

package/build/lib/log-messages-suppressor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-messages-suppressor.js","sourceRoot":"","sources":["../../src/lib/log-messages-suppressor.ts"],"names":[],"mappings":";;;;;;AAAA,iDAAuC;AACvC,oDAAuB;AAGV,QAAA,6BAA6B,GAAG,KAAM,CAAC;AAEpD,2EAA2E;AAC3E,wCAAwC;AAC3B,QAAA,6BAA6B,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAE5D,0DAA0D;AAC1D,qCAAqC;AACxB,QAAA,kCAAkC,GAAG,EAAE,CAAC;AAoBrD;;;;;;;;;;;;GAYG;AAEH,MAAa,qBAAqB;IAOhC,YACW,UAAkB,EACnB,YAA6C,EAC3C,MAAc;QAFf,eAAU,GAAV,UAAU,CAAQ;QACnB,iBAAY,GAAZ,YAAY,CAAiC;QAC3C,WAAM,GAAN,MAAM,CAAQ;QALlB,oBAAe,GAA8B,EAAE,CAAC;IAMrD,CAAC;IAEJ,MAAM,CAAC,wBAAwB,CAC7B,UAAkB,EAClB,WAA4C,EAC5C,MAAc;QAEd,MAAM,QAAQ,GAAG,qBAAqB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,qBAAqB,CAAC,SAAS,CAAC,UAAU,CAAC;gBACzC,IAAI,qBAAqB,CAAI,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;SACjE;aAAM;YACL,IAAA,sBAAM,EACJ,gBAAC,CAAC,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC,YAAY,CAAC,EAC7C,uFAAuF,CACxF,CAAC;YACF,IAAA,sBAAM,EACJ,gBAAC,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EAClC,8EAA8E,CAC/E,CAAC;SACH;QACD,OAAO,qBAAqB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED,UAAU,CACR,MAAe,EACf,qBAA6B,EAAE,EAC/B,GAAG,IAAe;QAElB,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAA,sBAAM,EACJ,OAAO,KAAK,SAAS,EACrB,4BAA4B,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAC5D,CAAC;QAEF,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YAC9C,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG;gBAC7B,OAAO,EAAE,CAAC;gBACV,mBAAmB,EACjB,kBAAkB,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC;gBACvD,cAAc,EAAE,CAAC;aAClB,CAAC;SACH;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAA,sBAAM,EACJ,OAAO,KAAK,SAAS,EACrB,mCAAmC,MAAM,CAAC,MAAM,CAAC,EAAE,CACpD,CAAC;QAEF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEzB,MAAM,uBAAuB,GAAG,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC;QAE/D,IAAI,uBAAuB,GAAG,qCAA6B,EAAE;YAC3D,gFAAgF;YAChF,IAAI,uBAAuB,GAAG,qCAA6B,EAAE;gBAC3D,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;aACjC;YAED,sBAAsB;YACtB,0EAA0E;YAC1E,sBAAsB;YACtB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAC3B,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,EAChD,GAAG,IAAI,CACR,CAAC;YACF,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;SACjC;aAAM;YACL,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,kBAAkB,KAAK,EAAE,EAAE;gBAC7B,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;aACtD;SACF;IACH,CAAC;IAEO,iBAAiB,CAAC,OAAoB,EAAE,OAAe;QAC7D,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,OAAO,CAAC;QACjD,IAAI,UAAU,GACZ,mBAAmB,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC;YACrD,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,kBACE,mBAAmB,CAAC,MAAM,GAAG,0CAAkC;gBAC7D,CAAC,CAAC,mBAAmB;qBAChB,KAAK,CAAC,0CAAkC,CAAC;qBACzC,IAAI,CAAC,GAAG,CAAC;gBACd,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAClC,EAAE,CAAC;QAET,IACE,mBAAmB;YACnB,mBAAmB,CAAC,MAAM,GAAG,0CAAkC,EAC/D;YACA,UAAU,GAAG,GAAG,UAAU,OAAO,mBAAmB,CAAC,MAAM,QAAQ,CAAC;SACrE;QAED,OAAO,GAAG,IAAI,CAAC,UAAU,YAAY,OAAO,qBAAqB,OAAO,IAAI,UAAU,IAAI,CAAC;IAC7F,CAAC;IAEO,iBAAiB,CAAC,WAAwB;QAChD,WAAW,CAAC,OAAO,GAAG,CAAC,CAAC;QACxB,IAAI,WAAW,CAAC,mBAAmB,EAAE;YACnC,WAAW,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC;SAC5C;QACD,WAAW,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC1C,CAAC;;AAnHH,sDAoHC;AAnHC,0EAA0E;AAC1E,8DAA8D;AACvD,+BAAS,GAA+C,EAAE,CAAC"}

package/build/lib/stateful-rpc-poller/state-polling-manager.d.ts

@@ -0,0 +1,23 @@
+import { IDexHelper } from '../../dex-helper';
+import { IStatefulRpcPoller } from './types';
+export declare class StatePollingManager {
+    protected dexHelper: IDexHelper;
+    private static __instances;
+    static getInstance(dexHelper: IDexHelper): StatePollingManager;
+    private _lastProcessedBlockNumber;
+    private logger;
+    private _registeredPendingPools;
+    private _poolsToInstances;
+    private _poolsToBeUpdated;
+    private _idlePools;
+    private constructor();
+    get isMaster(): boolean;
+    enableStateTracking(identifierKey: string): void;
+    disableStateTracking(identifierKey: string): void;
+    onBlockNumber(blockNumber: number): Promise<void>;
+    protected _updatePoolStates(poolsToBeUpdated: IStatefulRpcPoller<any, any>[], blockNumber?: number | 'latest', numberOfChunks?: number): Promise<number>;
+    private _keyToPoolInstance;
+    initializeAllPendingPools(): void;
+    registerPendingPool<T, M>(statefulRpcPoller: IStatefulRpcPoller<T, M>): void;
+    initializePool<T, M>(statefulRpcPoller: IStatefulRpcPoller<T, M>): void;
+}

package/build/lib/stateful-rpc-poller/state-polling-manager.js

@@ -0,0 +1,173 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatePollingManager = void 0;
+const console_1 = require("console");
+const log4js_1 = require("../log4js");
+class StatePollingManager {
+    constructor(dexHelper) {
+        this.dexHelper = dexHelper;
+        this._lastProcessedBlockNumber = 0;
+        this._registeredPendingPools = [];
+        // ALl registered instances from identifier to instance
+        this._poolsToInstances = {};
+        // This pools will be updated if we see new block and the time has come
+        this._poolsToBeUpdated = new Set();
+        // This pools wont be updated before we change _isStateToBeUpdated to true
+        this._idlePools = new Set();
+        this.logger = (0, log4js_1.getLogger)(`${this.constructor.name}-${dexHelper.config.data.network}`);
+        if (this.isMaster) {
+        }
+    }
+    static getInstance(dexHelper) {
+        const network = dexHelper.config.data.network;
+        if (StatePollingManager.__instances[network] === undefined) {
+            StatePollingManager.__instances[network] = new StatePollingManager(dexHelper);
+        }
+        return StatePollingManager.__instances[network];
+    }
+    get isMaster() {
+        return !this.dexHelper.config.isSlave;
+    }
+    enableStateTracking(identifierKey) {
+        (0, console_1.assert)(this._poolsToInstances[identifierKey] !== undefined, `enableTracking: pool with identifierKey=${identifierKey} is not initialized`);
+        this._poolsToBeUpdated.add(identifierKey);
+        this._idlePools.delete(identifierKey);
+    }
+    disableStateTracking(identifierKey) {
+        (0, console_1.assert)(this._poolsToInstances[identifierKey] !== undefined, `disableStateTracking: pool with identifierKey=${identifierKey} is not initialized`);
+        this._poolsToBeUpdated.delete(identifierKey);
+        this._idlePools.add(identifierKey);
+    }
+    async onBlockNumber(blockNumber) {
+        if (!this.isMaster) {
+            return;
+        }
+        // Events-client calls several times for the same blockNumber sometimes
+        // I want to filter them. The only condition, that matters is that blockNumbers are the same
+        if (this._lastProcessedBlockNumber === blockNumber) {
+            return;
+        }
+        this._lastProcessedBlockNumber = blockNumber;
+        const poolsToBeUpdated = [];
+        Array.from(this._poolsToBeUpdated).forEach(p => {
+            const pool = this._keyToPoolInstance(p);
+            // We always expect pools in _poolsToBeUpdated to participate in updates
+            (0, console_1.assert)(pool.isPoolParticipateInUpdates, `onBlockNumber: pool=${p} from ${pool.dexKey} is not participate in updates`);
+            if (!pool.isPoolInTheMiddleOfUpdate &&
+                pool.isTimeToTriggerUpdate(blockNumber)) {
+                pool.isPoolInTheMiddleOfUpdate = true;
+                poolsToBeUpdated.push(pool);
+            }
+        });
+        if (poolsToBeUpdated.length === 0) {
+            this.logger.debug(`onBlockNumber=${blockNumber} no pools to be updated. Skipping`);
+            return;
+        }
+        this._updatePoolStates(poolsToBeUpdated)
+            .then(receivedBlockNumber => {
+            // There is no guarantee that we receive latest state. This is our best effort
+            if (receivedBlockNumber < blockNumber) {
+                this.logger.warn(`onBlockNumber=${blockNumber} at least for some pools receivedBlockNumber=${receivedBlockNumber} is lower than expected`);
+            }
+        })
+            .catch(e => this.logger.error(`onBlockNumber=${blockNumber} error while updating pools: ${e}`))
+            .finally(() => {
+            poolsToBeUpdated.forEach(pool => {
+                pool.isPoolInTheMiddleOfUpdate = false;
+            });
+        });
+    }
+    async _updatePoolStates(poolsToBeUpdated, blockNumber = 'latest', numberOfChunks) {
+        const indexDividers = [];
+        const multiCalls = poolsToBeUpdated
+            .map((p, i) => {
+            const callData = p.getFetchStateWithBlockInfoMultiCalls();
+            indexDividers.push(callData.length);
+            return callData;
+        })
+            .flat();
+        (0, console_1.assert)(indexDividers.length === poolsToBeUpdated.length, 'indexDividers.length === poolsToBeUpdated.length');
+        const results = (await this.dexHelper.multiWrapper.tryAggregate(false, multiCalls, blockNumber, numberOfChunks));
+        let minBlockNumber = 0;
+        const lastUpdatedAtMs = Date.now();
+        // Let's pack each result into relevant pools
+        const unFlattenedResults = [];
+        let accumulatedStart = 0;
+        indexDividers.forEach(divider => {
+            unFlattenedResults.push(results.slice(accumulatedStart, accumulatedStart + divider));
+            accumulatedStart += divider;
+        });
+        (0, console_1.assert)(unFlattenedResults.length === poolsToBeUpdated.length, 'unFlattenedResults.length === poolsToBeUpdated.length');
+        await Promise.all(unFlattenedResults.map(async (result, index) => {
+            const pool = poolsToBeUpdated[index];
+            try {
+                const parsedStateResult = pool.parseStateFromMultiResultsWithBlockInfo(result, lastUpdatedAtMs);
+                minBlockNumber = Math.min(parsedStateResult.blockNumber, minBlockNumber);
+                await pool.setState(parsedStateResult.value, parsedStateResult.blockNumber, parsedStateResult.lastUpdatedAtMs);
+            }
+            catch (e) {
+                this.logger.error(`onBlockNumber=${blockNumber} error while parsing state from multicall for pool=${pool.identifierKey} from ${pool.dexKey}: ${e}`);
+            }
+        }));
+        return minBlockNumber;
+    }
+    // When this method is called, we expect that all pools are initialized
+    _keyToPoolInstance(identifierKey) {
+        const pool = this._poolsToInstances[identifierKey];
+        (0, console_1.assert)(pool !== undefined, `keyToPoolInstance: pool=${identifierKey} is undefined`);
+        return pool;
+    }
+    // Once you instantiated all your pools, you should trigger at the end of initializing this method
+    // So all state will be initialized. It is not part of constructor, because and that time we don't have
+    // all classes built
+    initializeAllPendingPools() {
+        if (this._registeredPendingPools.length === 0) {
+            return;
+        }
+        this._registeredPendingPools.forEach(p => {
+            this.initializePool(p);
+        });
+        this._registeredPendingPools = [];
+    }
+    registerPendingPool(statefulRpcPoller) {
+        if (this._poolsToInstances[statefulRpcPoller.identifierKey]) {
+            this.logger.error(`Attempt to register initialized pool=${statefulRpcPoller.identifierKey}`);
+            return;
+        }
+        const alreadyRegisteredAsPending = this._registeredPendingPools.some(p => p.identifierKey === statefulRpcPoller.identifierKey);
+        if (alreadyRegisteredAsPending) {
+            this.logger.error(`Attempt to register pool=${statefulRpcPoller.identifierKey} twice`);
+            return;
+        }
+        this._registeredPendingPools.push(statefulRpcPoller);
+    }
+    initializePool(statefulRpcPoller) {
+        const { identifierKey } = statefulRpcPoller;
+        if (this._idlePools.has(identifierKey) ||
+            this._poolsToBeUpdated.has(identifierKey) ||
+            this._poolsToInstances.hasOwnProperty(identifierKey)) {
+            this.logger.warn(`Attempt to reinitialize existing poolIdentifier=` +
+                `${identifierKey}. Maybe there is memory leak`);
+        }
+        else {
+            this._poolsToInstances[identifierKey] = statefulRpcPoller;
+            statefulRpcPoller.isPoolParticipateInUpdates
+                ? this._poolsToBeUpdated.add(identifierKey)
+                : this._idlePools.add(identifierKey);
+            const currentBlockNumber = this.dexHelper.blockManager.getActiveChainHead()?.number;
+            (0, console_1.assert)(currentBlockNumber !== undefined, 'currentBlockNumber !== undefined');
+            statefulRpcPoller
+                .initializeState()
+                .then(() => {
+                this.logger.info(`Successfully initialized pool=${identifierKey}`);
+            })
+                .catch(e => {
+                // Must never happen
+                this.logger.error(`initializePool: pool=${identifierKey} from ${statefulRpcPoller.dexKey} error while initializing state: ${e}`);
+            });
+        }
+    }
+}
+exports.StatePollingManager = StatePollingManager;
+StatePollingManager.__instances = {};
+//# sourceMappingURL=state-polling-manager.js.map

package/build/lib/stateful-rpc-poller/state-polling-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state-polling-manager.js","sourceRoot":"","sources":["../../../src/lib/stateful-rpc-poller/state-polling-manager.ts"],"names":[],"mappings":";;;AACA,qCAAiC;AAGjC,sCAAsC;AAItC,MAAa,mBAAmB;IA4B9B,YAA8B,SAAqB;QAArB,cAAS,GAAT,SAAS,CAAY;QAf3C,8BAAyB,GAAG,CAAC,CAAC;QAI9B,4BAAuB,GAAmC,EAAE,CAAC;QAErE,uDAAuD;QAC/C,sBAAiB,GAAiD,EAAE,CAAC;QAE7E,uEAAuE;QAC/D,sBAAiB,GAAgB,IAAI,GAAG,EAAE,CAAC;QAEnD,0EAA0E;QAClE,eAAU,GAAgB,IAAI,GAAG,EAAE,CAAC;QAG1C,IAAI,CAAC,MAAM,GAAG,IAAA,kBAAS,EACrB,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAC5D,CAAC;QAEF,IAAI,IAAI,CAAC,QAAQ,EAAE;SAClB;IACH,CAAC;IAhCD,MAAM,CAAC,WAAW,CAAC,SAAqB;QACtC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;QAC9C,IAAI,mBAAmB,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;YAC1D,mBAAmB,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,mBAAmB,CAChE,SAAS,CACV,CAAC;SACH;QACD,OAAO,mBAAmB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAClD,CAAC;IA0BD,IAAI,QAAQ;QACV,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,mBAAmB,CAAC,aAAqB;QACvC,IAAA,gBAAM,EACJ,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,KAAK,SAAS,EACnD,2CAA2C,aAAa,qBAAqB,CAC9E,CAAC;QACF,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IACxC,CAAC;IAED,oBAAoB,CAAC,aAAqB;QACxC,IAAA,gBAAM,EACJ,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,KAAK,SAAS,EACnD,iDAAiD,aAAa,qBAAqB,CACpF,CAAC;QACF,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC7C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,WAAmB;QACrC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,OAAO;SACR;QAED,uEAAuE;QACvE,4FAA4F;QAC5F,IAAI,IAAI,CAAC,yBAAyB,KAAK,WAAW,EAAE;YAClD,OAAO;SACR;QACD,IAAI,CAAC,yBAAyB,GAAG,WAAW,CAAC;QAE7C,MAAM,gBAAgB,GAAmC,EAAE,CAAC;QAE5D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;YAExC,wEAAwE;YACxE,IAAA,gBAAM,EACJ,IAAI,CAAC,0BAA0B,EAC/B,uBAAuB,CAAC,SAAS,IAAI,CAAC,MAAM,gCAAgC,CAC7E,CAAC;YAEF,IACE,CAAC,IAAI,CAAC,yBAAyB;gBAC/B,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,EACvC;gBACA,IAAI,CAAC,yBAAyB,GAAG,IAAI,CAAC;gBACtC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,iBAAiB,WAAW,mCAAmC,CAChE,CAAC;YACF,OAAO;SACR;QAED,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC;aACrC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YAC1B,8EAA8E;YAC9E,IAAI,mBAAmB,GAAG,WAAW,EAAE;gBACrC,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,iBAAiB,WAAW,gDAAgD,mBAAmB,yBAAyB,CACzH,CAAC;aACH;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,CACT,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,iBAAiB,WAAW,gCAAgC,CAAC,EAAE,CAChE,CACF;aACA,OAAO,CAAC,GAAG,EAAE;YACZ,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC9B,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC;YACzC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAES,KAAK,CAAC,iBAAiB,CAC/B,gBAAgD,EAChD,cAAiC,QAAQ,EACzC,cAAuB;QAEvB,MAAM,aAAa,GAAa,EAAE,CAAC;QAEnC,MAAM,UAAU,GAAG,gBAAgB;aAChC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACZ,MAAM,QAAQ,GAAG,CAAC,CAAC,oCAAoC,EAAE,CAAC;YAC1D,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACpC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;aACD,IAAI,EAAE,CAAC;QAEV,IAAA,gBAAM,EACJ,aAAa,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EAChD,kDAAkD,CACnD,CAAC;QAEF,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,YAAY,CAC7D,KAAK,EACL,UAAU,EACV,WAAW,EACX,cAAc,CACf,CAAiD,CAAC;QAEnD,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEnC,6CAA6C;QAC7C,MAAM,kBAAkB,GACtB,EAAE,CAAC;QAEL,IAAI,gBAAgB,GAAG,CAAC,CAAC;QACzB,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC9B,kBAAkB,CAAC,IAAI,CACrB,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAGzD,CACF,CAAC;YACF,gBAAgB,IAAI,OAAO,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAA,gBAAM,EACJ,kBAAkB,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EACrD,uDAAuD,CACxD,CAAC;QAEF,MAAM,OAAO,CAAC,GAAG,CACf,kBAAkB,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE;YAC7C,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;YACrC,IAAI;gBACF,MAAM,iBAAiB,GACrB,IAAI,CAAC,uCAAuC,CAC1C,MAAM,EACN,eAAe,CAChB,CAAC;gBAEJ,cAAc,GAAG,IAAI,CAAC,GAAG,CACvB,iBAAiB,CAAC,WAAW,EAC7B,cAAc,CACf,CAAC;gBAEF,MAAM,IAAI,CAAC,QAAQ,CACjB,iBAAiB,CAAC,KAAK,EACvB,iBAAiB,CAAC,WAAW,EAC7B,iBAAiB,CAAC,eAAe,CAClC,CAAC;aACH;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,iBAAiB,WAAW,sDAAsD,IAAI,CAAC,aAAa,SAAS,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CACjI,CAAC;aACH;QACH,CAAC,CAAC,CACH,CAAC;QAEF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,uEAAuE;IAC/D,kBAAkB,CACxB,aAAqB;QAErB,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QACnD,IAAA,gBAAM,EACJ,IAAI,KAAK,SAAS,EAClB,2BAA2B,aAAa,eAAe,CACxD,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kGAAkG;IAClG,uGAAuG;IACvG,oBAAoB;IACpB,yBAAyB;QACvB,IAAI,IAAI,CAAC,uBAAuB,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7C,OAAO;SACR;QAED,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACvC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,uBAAuB,GAAG,EAAE,CAAC;IACpC,CAAC;IAED,mBAAmB,CAAO,iBAA2C;QACnE,IAAI,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,CAAC,EAAE;YAC3D,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,wCAAwC,iBAAiB,CAAC,aAAa,EAAE,CAC1E,CAAC;YACF,OAAO;SACR;QAED,MAAM,0BAA0B,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAClE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,KAAK,iBAAiB,CAAC,aAAa,CACzD,CAAC;QACF,IAAI,0BAA0B,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,4BAA4B,iBAAiB,CAAC,aAAa,QAAQ,CACpE,CAAC;YACF,OAAO;SACR;QACD,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACvD,CAAC;IAED,cAAc,CAAO,iBAA2C;QAC9D,MAAM,EAAE,aAAa,EAAE,GAAG,iBAAiB,CAAC;QAE5C,IACE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC;YAClC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC;YACzC,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,aAAa,CAAC,EACpD;YACA,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,kDAAkD;gBAChD,GAAG,aAAa,8BAA8B,CACjD,CAAC;SACH;aAAM;YACL,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,GAAG,iBAAiB,CAAC;YAC1D,iBAAiB,CAAC,0BAA0B;gBAC1C,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,aAAa,CAAC;gBAC3C,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAEvC,MAAM,kBAAkB,GACtB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,kBAAkB,EAAE,EAAE,MAAM,CAAC;YAE3D,IAAA,gBAAM,EACJ,kBAAkB,KAAK,SAAS,EAChC,kCAAkC,CACnC,CAAC;YAEF,iBAAiB;iBACd,eAAe,EAAE;iBACjB,IAAI,CAAC,GAAG,EAAE;gBACT,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,aAAa,EAAE,CAAC,CAAC;YACrE,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE;gBACT,oBAAoB;gBACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,wBAAwB,aAAa,SAAS,iBAAiB,CAAC,MAAM,oCAAoC,CAAC,EAAE,CAC9G,CAAC;YACJ,CAAC,CAAC,CAAC;SACN;IACH,CAAC;;AA7RH,kDA8RC;AA7RgB,+BAAW,GAAwC,EAAE,CAAC"}

package/build/lib/stateful-rpc-poller/stateful-rpc-poller.d.ts

@@ -0,0 +1,72 @@
+import { Logger, LogLevels } from '../../types';
+import { IDexHelper } from '../../dex-helper';
+import { IStatefulRpcPoller, ObjWithUpdateInfo, PollingManagerControllersCb, StateSources } from './types';
+import { MultiCallParams, MultiResult } from '../multi-wrapper';
+import { LogMessagesSuppressor, MessageInfo } from '../log-messages-suppressor';
+declare const StatefulRPCPollerMessages: {
+    readonly ERROR_FETCHING_STATE_FROM_CACHE: "Unexpected error while fetching state from Cache";
+    readonly ERROR_FETCHING_STATE_FROM_RPC: "Unexpected error while fetching state from RPC";
+    readonly ERROR_SAVING_LIQUIDITY_IN_CACHE: "Unexpected error while saving liquidity in Cache";
+    readonly ERROR_SAVING_STATE_IN_CACHE: "Unexpected error while saving state in Cache";
+    readonly FALLBACK_TO_RPC: "Failed to retrieve updated state from cache. Falling back to RPC";
+    readonly LIQUIDITY_INFO_IS_OUTDATED: string;
+};
+export declare abstract class StatefulRpcPoller<State, M> implements IStatefulRpcPoller<State, M> {
+    readonly dexKey: string;
+    protected dexHelper: IDexHelper;
+    protected liquidityThresholdForUpdate: number;
+    protected liquidityUpdateAllowedDelayMs: number;
+    protected isLiquidityTracked: boolean;
+    protected managerCbControllers: PollingManagerControllersCb;
+    protected maxAllowedStateDelayInBlocks: number;
+    protected blocksBackToTriggerUpdate: number;
+    protected liquidityUpdatePeriodMs: number;
+    static StatefulRPCPollerMessages: Record<keyof typeof StatefulRPCPollerMessages, MessageInfo<typeof StatefulRPCPollerMessages>>;
+    protected _stateWithUpdateInfo?: ObjWithUpdateInfo<State>;
+    protected _liquidityInUSDWithUpdateInfo: ObjWithUpdateInfo<number>;
+    readonly cacheStateKey: string;
+    readonly cacheLiquidityMapKey: string;
+    protected _cachedMultiCallData?: [
+        MultiCallParams<number>,
+        ...MultiCallParams<M>[]
+    ];
+    protected _getBlockNumberMultiCall: MultiCallParams<number>;
+    readonly entityName: string;
+    protected logMessagesSuppressor: LogMessagesSuppressor<typeof StatefulRPCPollerMessages>;
+    protected _isPoolParticipateInUpdates: boolean;
+    protected _isPoolInTheMiddleOfUpdate: boolean;
+    readonly identifierKey: string;
+    protected logger: Logger;
+    constructor(dexKey: string, poolIdentifier: string, dexHelper: IDexHelper, liquidityThresholdForUpdate: number, liquidityUpdateAllowedDelayMs: number, isLiquidityTracked: boolean, managerCbControllers: PollingManagerControllersCb, maxAllowedStateDelayInBlocks?: number, blocksBackToTriggerUpdate?: number, liquidityUpdatePeriodMs?: number);
+    get network(): number;
+    protected get isMaster(): boolean;
+    protected _isStateOutdated(checkForBlockNumber: number, stateValidBlockNumber: number, stateValidityBlockNumDelay: number): boolean;
+    protected _isStateOutdatedForUse(checkForBlockNumber: number, stateValidBlockNumber: number): boolean;
+    isTimeToTriggerUpdate(blocknumber: number): boolean;
+    protected _retrieveStateWithChecks(retriever: () => Promise<ObjWithUpdateInfo<State> | null>, blockNumber: number | 'latest', source: StateSources): Promise<ObjWithUpdateInfo<State> | null>;
+    getState(blockNumber?: number | 'latest', forInitialization?: boolean, saveInMemory?: boolean): Promise<ObjWithUpdateInfo<State> | null>;
+    protected _logMessageWithSuppression(msgKey: keyof typeof StatefulRPCPollerMessages, ...args: unknown[]): void;
+    protected _immediateLogMessage(message: string, level: LogLevels, ...args: unknown[]): void;
+    get isPoolParticipateInUpdates(): boolean;
+    set isPoolParticipateInUpdates(value: boolean);
+    get isPoolInTheMiddleOfUpdate(): boolean;
+    set isPoolInTheMiddleOfUpdate(value: boolean);
+    protected abstract _getFetchStateMultiCalls(): MultiCallParams<M>[];
+    getFetchStateWithBlockInfoMultiCalls(): [
+        MultiCallParams<number>,
+        ...MultiCallParams<M>[]
+    ];
+    protected abstract _parseStateFromMultiResults(multiOutputs: M[]): State;
+    parseStateFromMultiResultsWithBlockInfo(multiOutputs: [MultiResult<number>, ...MultiResult<M>[]], lastUpdatedAtMs: number): ObjWithUpdateInfo<State>;
+    fetchLatestStateFromRpc(): Promise<ObjWithUpdateInfo<State> | null>;
+    setState(state: State, blockNumber: number, lastUpdatedAtMs: number): Promise<void>;
+    protected _saveStateInCache(): Promise<boolean>;
+    protected _saveLiquidityInCache(): Promise<boolean>;
+    fetchStateFromCache(): Promise<ObjWithUpdateInfo<State> | null>;
+    protected _fetchLiquidityFromCache(): Promise<ObjWithUpdateInfo<number> | null>;
+    setLiquidity(newLiquidityInUSD: number, lastUpdatedAtMs: number, blockNumber?: number): Promise<void>;
+    protected _adjustIsStateToBeUpdated(): void;
+    protected _getExpiryTimeForCachedLiquidity(): number;
+    initializeState(): Promise<void>;
+}
+export {};