@paraswap/dex-lib 3.8.26 → 3.8.27-dualsync.1

package/build/stateful-dual-synchronizer.js

@@ -0,0 +1,300 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatefulDualSynchronizer = void 0;
+const ts_essentials_1 = require("ts-essentials");
+const constants_1 = require("./constants");
+const utils_1 = require("./utils");
+// TODO:  make sure that we can get either state object or string
+class StatefulDualSynchronizer {
+    constructor(dexKey, poolIdentifier, dexHelper, logger) {
+        this.dexKey = dexKey;
+        this.poolIdentifier = poolIdentifier;
+        this.dexHelper = dexHelper;
+        this.logger = logger;
+        //The current state and its block number
+        //Derived classes should not set these directly, and instead use setState()
+        this.state = null;
+        this.stateBlockNumber = 0;
+        //Derived classes should use setState() to record a new entry
+        this.stateHistory = {};
+        //Invalid flag - indicates that the currently stored state might not be valid
+        this.invalid = false;
+        this.isTracking = () => false;
+        this.addressesSubscribed = [];
+        this.isInitialized = false;
+        this.dexKey = dexKey.toLowerCase();
+        this.poolIdentifier = poolIdentifier.toLowerCase();
+        // parentName and Name are imposed by the interface. Prefer dexKey and poolIdentifier
+        this.parentName = this.dexKey;
+        this.name = this.poolIdentifier;
+        if (!this.dexHelper.config.isSlave) {
+            this.dexHelper.dexStatePublisher.registerPool(this.dexKey, this.poolIdentifier, this);
+        }
+    }
+    getStateBlockNumber() {
+        return this.stateBlockNumber;
+    }
+    //Function which set the initial state and bounded it to blockNumber
+    //There is multiple possible case:
+    // 1. You provide a state in options object the function will initialize with the provided state
+    //  with blockNumber and subscribe to logs.
+    // 2. if you are a master instance of dex-lib and no state is provided in options object
+    //  then the function generate a new state with blockNumber as height and set the state with
+    //  the result.
+    // 3. if you are a slave instance of dex-lib
+    //  either:
+    //    - If a state is found in the cache and the state is not null we set our state with the
+    //      cache state and cache blockNumber. Subscribe to logs with the cache blockNumber
+    //  or:
+    //    - If no valid state found in cache, we generate a new state with blockNumber
+    //      and se state with blockNumber. Subscribe to logs with blockNumber. The function
+    //      will also publish a message to cache to tell one master version of dex-lib that this slave
+    //      instance subscribed to a pool from dex this.parentName and name this.name.
+    async initialize(blockNumber, options) {
+        let masterBn = undefined;
+        if (options && options.state) {
+            this.setState(options.state, blockNumber);
+        }
+        else {
+            if (this.dexHelper.config.isSlave) {
+                let updatedState = await this.dexHelper.dexStateSubscriber.requestDEXPoolState(this.dexKey, this.poolIdentifier, blockNumber);
+                this.setState(updatedState, blockNumber);
+            }
+            else {
+                // if you are not a slave instance always generate new state
+                this.logger.info(`${this.dexKey}: ${this.poolIdentifier}: cache generating state`);
+                const state = await this.generateState(blockNumber);
+                this.setState(state, blockNumber);
+            }
+        }
+        // apply a callback on the state
+        if (options && options.initCallback) {
+            if (this.state) {
+                (0, ts_essentials_1.assert)(typeof this.state !== 'string', 'LOGIC ERROR: state is serialised');
+                options.initCallback(this.state);
+            }
+        }
+        if (this.dexHelper.config.isSlave) {
+            this.dexHelper.dexStateSubscriber.subscribeToDEXPoolUpdates(this.dexKey, this.poolIdentifier, (state, blockNumber) => {
+                this.setState(state, blockNumber);
+            });
+        }
+        else {
+            this.dexHelper.blockManager.subscribeToLogs(this, this.addressesSubscribed, masterBn || blockNumber);
+        }
+        this.isInitialized = true;
+    }
+    //This function processes all logs for a single block (the block number is
+    //contained in each of the logs).  It is not allowed to call this function
+    //with an empty logs array.  The default implementation here will just call
+    //processLog for each of the logs; it may be overridden, if block specific
+    //handling or handling multiple logs at once is needed.  Null should be
+    //returned if none of the provided logs affect the state.
+    async processBlockLogs(state, logs, blockHeader) {
+        let nextState = null;
+        for (const log of logs) {
+            const retState = await this.processLog(nextState || state, log, blockHeader);
+            if (retState)
+                nextState = retState;
+        }
+        return nextState;
+    }
+    restart(blockNumber) {
+        for (const _bn of Object.keys(this.stateHistory)) {
+            const bn = +_bn;
+            if (bn >= blockNumber)
+                break;
+            delete this.stateHistory[bn];
+        }
+        if (this.state && this.stateBlockNumber < blockNumber) {
+            this.logger.info(`StatefulDualSynchronizer restart, bn: ${blockNumber}, state_bn: ${this.stateBlockNumber}: ${this.dexKey}: ${this.poolIdentifier}`);
+            this._setState(null, blockNumber);
+        }
+    }
+    //Implementation must call setState() for every block in which the state
+    //changes and must ignore any logs that aren't newer than the oldest state
+    //stored.  If state is not set or null, then the implementation should derive
+    //the state by another method for the block number of the first log, ignore
+    //all logs with that block number and then proceed as normal for the remaining
+    //logs.  Remember to clear the invalid flag, even if there are no logs!
+    //A default implementation is provided here, but could be overridden.
+    async update(logs, blockHeaders) {
+        if (this.dexHelper.config.isSlave) {
+            throw new Error('LOGIC ERROR: we should expect to listen to events on slave instances');
+        }
+        let index = 0;
+        let lastBlockNumber;
+        while (index < logs.length) {
+            const blockNumber = logs[index].blockNumber;
+            if (index && blockNumber <= lastBlockNumber) {
+                this.logger.error('update() received blocks out of order!');
+            }
+            const blockHeader = blockHeaders[blockNumber];
+            if (!blockHeader) {
+                this.logger.error('update() missing block header!');
+            }
+            let lastLogIndex = logs[index].logIndex;
+            let indexBlockEnd = index + 1;
+            while (indexBlockEnd < logs.length &&
+                logs[indexBlockEnd].blockNumber === blockNumber) {
+                if (logs[indexBlockEnd].logIndex <= lastLogIndex) {
+                    this.logger.error('update() received logs out of order!');
+                }
+                lastLogIndex = logs[indexBlockEnd].logIndex;
+                ++indexBlockEnd;
+            }
+            if (!this.state) {
+                const freshState = await this.generateState(blockNumber);
+                this.setState(freshState, blockNumber);
+            }
+            //Find the last state before the blockNumber of the logs
+            let stateBeforeLog;
+            for (const _bn of Object.keys(this.stateHistory)) {
+                const bn = +_bn;
+                if (bn >= blockNumber)
+                    break;
+                stateBeforeLog = this.stateHistory[bn];
+            }
+            //Ignoring logs if there's no older state to play them onto
+            if (stateBeforeLog) {
+                (0, ts_essentials_1.assert)(typeof stateBeforeLog !== 'string', 'LOGIC ERROR: state is serialised');
+                const nextState = await this.processBlockLogs(stateBeforeLog, logs.slice(index, indexBlockEnd), blockHeader);
+                if (nextState)
+                    this.setState(nextState, blockNumber);
+            }
+            lastBlockNumber = blockNumber;
+            index = indexBlockEnd;
+        }
+        this.invalid = false;
+        if (!this.dexHelper.config.isSlave && this.state === null) {
+            const network = this.dexHelper.config.data.network;
+            const createNewState = async () => {
+                if (this.state !== null) {
+                    return true;
+                }
+                const latestBlockNumber = this.dexHelper.blockManager.getLatestBlockNumber();
+                this.logger.warn(`${network}: ${this.dexKey}: ${this.poolIdentifier}: master generate (latest: ${latestBlockNumber}) new state because state is null`);
+                try {
+                    const state = await this.generateState(latestBlockNumber);
+                    this.setState(state, latestBlockNumber);
+                    return true;
+                }
+                catch (e) {
+                    this.logger.error(`${network}: ${this.dexKey} ${this.poolIdentifier}: (${latestBlockNumber}) failed fetch state:`, e);
+                }
+                return false;
+            };
+            this.dexHelper.promiseScheduler.addPromise(createNewState);
+        }
+    }
+    //Removes all states that are beyond the given block number and sets the
+    //current state to the latest one that is left, if any, unless the invalid
+    //flag is not set, in which case the most recent state can be kept.
+    rollback(blockNumber) {
+        if (this.invalid) {
+            let lastBn = undefined;
+            //loop in the ascending order of the blockNumber. V8 property when object keys are number.
+            for (const bn of Object.keys(this.stateHistory)) {
+                const bnAsNumber = +bn;
+                if (bnAsNumber > blockNumber) {
+                    delete this.stateHistory[+bn];
+                }
+                else {
+                    lastBn = bnAsNumber;
+                }
+            }
+            if (lastBn) {
+                this._setState(this.stateHistory[lastBn], lastBn);
+            }
+            else {
+                this.logger.info(`StatefulDualSynchronizer rollback, bn: ${blockNumber}: ${this.dexKey}: ${this.poolIdentifier}`);
+                this._setState(null, blockNumber);
+                // TODO: explore generating new state on invalidation
+            }
+        }
+        else {
+            //Keep the current state in this.state and in the history
+            for (const _bn of Object.keys(this.stateHistory)) {
+                const bn = +_bn;
+                if (+bn > blockNumber && +bn !== this.stateBlockNumber) {
+                    delete this.stateHistory[bn];
+                }
+            }
+        }
+    }
+    invalidate() {
+        this.logger.info(`StatefulDualSynchronizer invalidate: ${this.dexKey}: ${this.poolIdentifier}`);
+        this.invalid = true;
+        // TODO: explore generating new state on invalidation
+    }
+    //May return a state that is more recent than the block number specified, or
+    //will return null if a recent enough state cannot be found, in which case the
+    //caller should derive a state using another method (at an exact block
+    //number), possibly using generateState(), and set it on this object using
+    //setState.  In case isTracking() returns true, it is assumed that the stored
+    //state is current and so the minBlockNumber will be disregarded.
+    getState(minBlockNumber) {
+        if (!this.state || this.invalid)
+            return null;
+        if (this.dexHelper.config.isSlave) {
+            if (this.dexHelper.dexStateSubscriber.isSynced(minBlockNumber) ||
+                this.stateBlockNumber >= minBlockNumber) {
+                if (typeof this.state === 'string') {
+                    this.state = utils_1.Utils.Parse(this.state);
+                }
+                (0, ts_essentials_1.assert)(typeof this.state !== 'string', 'LOGIC ERROR: state is serialised');
+                return this.state;
+            }
+        }
+        else {
+            if (this.isTracking() || this.stateBlockNumber >= minBlockNumber) {
+                if (typeof this.state === 'string') {
+                    this.state = utils_1.Utils.Parse(this.state);
+                }
+                (0, ts_essentials_1.assert)(typeof this.state !== 'string', 'LOGIC ERROR: state is serialised');
+                return this.state;
+            }
+        }
+        return null; // DEX need to implement an fallback strategy here
+    }
+    // Returns the last set state. The state might be invalid or not updated.
+    getStaleState() {
+        if (typeof this.state === 'string') {
+            this.state = utils_1.Utils.Parse(this.state);
+        }
+        (0, ts_essentials_1.assert)(typeof this.state !== 'string', 'LOGIC ERROR: state is serialised');
+        return this.state;
+    }
+    _setState(state, blockNumber) {
+        this.state = state;
+        this.stateBlockNumber = blockNumber;
+    }
+    //Saves the state into the stateHistory, and cleans up any old state that is
+    //no longer needed.  If the blockNumber is greater than or equal to the
+    //current state, then the current state will be updated and the invalid flag
+    //can be reset.
+    setState(state, blockNumber) {
+        if (!blockNumber) {
+            this.logger.error('setState() with blockNumber', blockNumber);
+            return;
+        }
+        this.stateHistory[blockNumber] = state;
+        if (!this.state || blockNumber >= this.stateBlockNumber) {
+            this._setState(state, blockNumber);
+            this.invalid = false;
+        }
+        const minBlockNumberToKeep = this.stateBlockNumber - constants_1.MAX_BLOCKS_HISTORY;
+        let lastBlockNumber;
+        for (const bn of Object.keys(this.stateHistory)) {
+            if (+bn <= minBlockNumberToKeep) {
+                if (lastBlockNumber)
+                    delete this.stateHistory[lastBlockNumber];
+            }
+            if (+bn >= minBlockNumberToKeep)
+                break;
+            lastBlockNumber = +bn;
+        }
+    }
+}
+exports.StatefulDualSynchronizer = StatefulDualSynchronizer;
+//# sourceMappingURL=stateful-dual-synchronizer.js.map

package/build/stateful-dual-synchronizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stateful-dual-synchronizer.js","sourceRoot":"","sources":["../src/stateful-dual-synchronizer.ts"],"names":[],"mappings":";;;AAAA,iDAAkE;AAKlE,2CAAiD;AAEjD,mCAAgC;AAWhC,iEAAiE;AACjE,MAAsB,wBAAwB;IAwB5C,YACS,MAAc,EACd,cAAsB,EACnB,SAAqB,EACrB,MAAc;QAHjB,WAAM,GAAN,MAAM,CAAQ;QACd,mBAAc,GAAd,cAAc,CAAQ;QACnB,cAAS,GAAT,SAAS,CAAY;QACrB,WAAM,GAAN,MAAM,CAAQ;QAzB1B,wCAAwC;QACxC,2EAA2E;QACjE,UAAK,GAAgC,IAAI,CAAC;QAC1C,qBAAgB,GAAW,CAAC,CAAC;QAEvC,6DAA6D;QACnD,iBAAY,GAElB,EAAE,CAAC;QAEP,6EAA6E;QACnE,YAAO,GAAY,KAAK,CAAC;QAEnC,eAAU,GAAkB,GAAG,EAAE,CAAC,KAAK,CAAC;QACjC,wBAAmB,GAAa,EAAE,CAAC;QAKnC,kBAAa,GAAG,KAAK,CAAC;QAQ3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QACnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;QAEnD,qFAAqF;QACrF,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC;QAEhC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YAClC,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,YAAY,CAC3C,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,cAAc,EACnB,IAAI,CACL,CAAC;SACH;IACH,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED,oEAAoE;IACpE,kCAAkC;IAClC,gGAAgG;IAChG,2CAA2C;IAC3C,wFAAwF;IACxF,4FAA4F;IAC5F,eAAe;IACf,4CAA4C;IAC5C,WAAW;IACX,4FAA4F;IAC5F,uFAAuF;IACvF,OAAO;IACP,kFAAkF;IAClF,uFAAuF;IACvF,kGAAkG;IAClG,kFAAkF;IAClF,KAAK,CAAC,UAAU,CACd,WAAmB,EACnB,OAAuC;QAEvC,IAAI,QAAQ,GAAuB,SAAS,CAAC;QAC7C,IAAI,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE;YAC5B,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;SAC3C;aAAM;YACL,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;gBACjC,IAAI,YAAY,GACd,MAAM,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,mBAAmB,CACzD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,cAAc,EACnB,WAAW,CACZ,CAAC;gBAEJ,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;aAC1C;iBAAM;gBACL,4DAA4D;gBAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,0BAA0B,CACjE,CAAC;gBACF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACpD,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;aACnC;SACF;QAED,gCAAgC;QAChC,IAAI,OAAO,IAAI,OAAO,CAAC,YAAY,EAAE;YACnC,IAAI,IAAI,CAAC,KAAK,EAAE;gBACd,IAAA,sBAAM,EACJ,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAC9B,kCAAkC,CACnC,CAAC;gBACF,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAClC;SACF;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YACjC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,yBAAyB,CACzD,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,cAAc,EACnB,CAAC,KAAa,EAAE,WAAmB,EAAE,EAAE;gBACrC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YACpC,CAAC,CACF,CAAC;SACH;aAAM;YACL,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,eAAe,CACzC,IAAI,EACJ,IAAI,CAAC,mBAAmB,EACxB,QAAQ,IAAI,WAAW,CACxB,CAAC;SACH;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;IAC5B,CAAC;IAUD,0EAA0E;IAC1E,0EAA0E;IAC1E,2EAA2E;IAC3E,0EAA0E;IAC1E,uEAAuE;IACvE,yDAAyD;IAC/C,KAAK,CAAC,gBAAgB,CAC9B,KAA0B,EAC1B,IAAqB,EACrB,WAAkC;QAElC,IAAI,SAAS,GAA+B,IAAI,CAAC;QACjD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,QAAQ,GAA+B,MAAM,IAAI,CAAC,UAAU,CAChE,SAAS,IAAI,KAAK,EAClB,GAAG,EACH,WAAW,CACZ,CAAC;YACF,IAAI,QAAQ;gBAAE,SAAS,GAAG,QAAQ,CAAC;SACpC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAWD,OAAO,CAAC,WAAmB;QACzB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YAChD,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC;YAChB,IAAI,EAAE,IAAI,WAAW;gBAAE,MAAM;YAC7B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;SAC9B;QACD,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,gBAAgB,GAAG,WAAW,EAAE;YACrD,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,yCAAyC,WAAW,eAAe,IAAI,CAAC,gBAAgB,KAAK,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,EAAE,CACnI,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;SACnC;IACH,CAAC;IAED,wEAAwE;IACxE,0EAA0E;IAC1E,6EAA6E;IAC7E,2EAA2E;IAC3E,8EAA8E;IAC9E,uEAAuE;IACvE,qEAAqE;IACrE,KAAK,CAAC,MAAM,CACV,IAAqB,EACrB,YAAwE;QAExE,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YACjC,MAAM,IAAI,KAAK,CACb,sEAAsE,CACvE,CAAC;SACH;QAED,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,eAAmC,CAAC;QACxC,OAAO,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE;YAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC;YAC5C,IAAI,KAAK,IAAI,WAAW,IAAI,eAAgB,EAAE;gBAC5C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YACD,MAAM,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;YAC9C,IAAI,CAAC,WAAW,EAAE;gBAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;aACrD;YACD,IAAI,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC;YACxC,IAAI,aAAa,GAAG,KAAK,GAAG,CAAC,CAAC;YAC9B,OACE,aAAa,GAAG,IAAI,CAAC,MAAM;gBAC3B,IAAI,CAAC,aAAa,CAAC,CAAC,WAAW,KAAK,WAAW,EAC/C;gBACA,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,IAAI,YAAY,EAAE;oBAChD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;iBAC3D;gBACD,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC;gBAC5C,EAAE,aAAa,CAAC;aACjB;YACD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;gBACf,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;gBACzD,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;aACxC;YACD,wDAAwD;YACxD,IAAI,cAAwD,CAAC;YAC7D,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;gBAChD,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC;gBAChB,IAAI,EAAE,IAAI,WAAW;oBAAE,MAAM;gBAC7B,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;aACxC;YACD,2DAA2D;YAC3D,IAAI,cAAc,EAAE;gBAClB,IAAA,sBAAM,EACJ,OAAO,cAAc,KAAK,QAAQ,EAClC,kCAAkC,CACnC,CAAC;gBACF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAC3C,cAAc,EACd,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,aAAa,CAAC,EAChC,WAAW,CACZ,CAAC;gBACF,IAAI,SAAS;oBAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;aACtD;YACD,eAAe,GAAG,WAAW,CAAC;YAC9B,KAAK,GAAG,aAAa,CAAC;SACvB;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QAErB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE;YACzD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;YACnD,MAAM,cAAc,GAAG,KAAK,IAAI,EAAE;gBAChC,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE;oBACvB,OAAO,IAAI,CAAC;iBACb;gBACD,MAAM,iBAAiB,GACrB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,oBAAoB,EAAE,CAAC;gBACrD,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,GAAG,OAAO,KAAK,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,8BAA8B,iBAAiB,mCAAmC,CACrI,CAAC;gBACF,IAAI;oBACF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;oBAC1D,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;oBACxC,OAAO,IAAI,CAAC;iBACb;gBAAC,OAAO,CAAC,EAAE;oBACV,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,GAAG,OAAO,KAAK,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,cAAc,MAAM,iBAAiB,uBAAuB,EAC/F,CAAC,CACF,CAAC;iBACH;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;SAC5D;IACH,CAAC;IAED,wEAAwE;IACxE,0EAA0E;IAC1E,mEAAmE;IACnE,QAAQ,CAAC,WAAmB;QAC1B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,IAAI,MAAM,GAAG,SAAS,CAAC;YACvB,0FAA0F;YAC1F,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;gBAC/C,MAAM,UAAU,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAI,UAAU,GAAG,WAAW,EAAE;oBAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC;iBAC/B;qBAAM;oBACL,MAAM,GAAG,UAAU,CAAC;iBACrB;aACF;YAED,IAAI,MAAM,EAAE;gBACV,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;aACnD;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,0CAA0C,WAAW,KAAK,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,EAAE,CAChG,CAAC;gBACF,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;gBAClC,qDAAqD;aACtD;SACF;aAAM;YACL,yDAAyD;YACzD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;gBAChD,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC;gBAChB,IAAI,CAAC,EAAE,GAAG,WAAW,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,gBAAgB,EAAE;oBACtD,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;iBAC9B;aACF;SACF;IACH,CAAC;IAED,UAAU;QACR,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,wCAAwC,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,EAAE,CAC9E,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEpB,qDAAqD;IACvD,CAAC;IAED,4EAA4E;IAC5E,8EAA8E;IAC9E,sEAAsE;IACtE,0EAA0E;IAC1E,6EAA6E;IAC7E,iEAAiE;IACjE,QAAQ,CAAC,cAAsB;QAC7B,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO,IAAI,CAAC;QAE7C,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE;YACjC,IACE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,QAAQ,CAAC,cAAc,CAAC;gBAC1D,IAAI,CAAC,gBAAgB,IAAI,cAAc,EACvC;gBACA,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE;oBAClC,IAAI,CAAC,KAAK,GAAG,aAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACtC;gBACD,IAAA,sBAAM,EACJ,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAC9B,kCAAkC,CACnC,CAAC;gBACF,OAAO,IAAI,CAAC,KAAK,CAAC;aACnB;SACF;aAAM;YACL,IAAI,IAAI,CAAC,UAAU,EAAE,IAAI,IAAI,CAAC,gBAAgB,IAAI,cAAc,EAAE;gBAChE,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE;oBAClC,IAAI,CAAC,KAAK,GAAG,aAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;iBACtC;gBACD,IAAA,sBAAM,EACJ,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAC9B,kCAAkC,CACnC,CAAC;gBACF,OAAO,IAAI,CAAC,KAAK,CAAC;aACnB;SACF;QAED,OAAO,IAAI,CAAC,CAAC,kDAAkD;IACjE,CAAC;IAED,yEAAyE;IACzE,aAAa;QACX,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE;YAClC,IAAI,CAAC,KAAK,GAAG,aAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACtC;QACD,IAAA,sBAAM,EAAC,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,kCAAkC,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,SAAS,CAAC,KAAkC,EAAE,WAAmB;QAC/D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC;IACtC,CAAC;IAED,4EAA4E;IAC5E,uEAAuE;IACvE,4EAA4E;IAC5E,eAAe;IACf,QAAQ,CAAC,KAA4B,EAAE,WAAmB;QACxD,IAAI,CAAC,WAAW,EAAE;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,EAAE,WAAW,CAAC,CAAC;YAC9D,OAAO;SACR;QACD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,WAAW,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACvD,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;SACtB;QACD,MAAM,oBAAoB,GAAG,IAAI,CAAC,gBAAgB,GAAG,8BAAkB,CAAC;QACxE,IAAI,eAAmC,CAAC;QACxC,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YAC/C,IAAI,CAAC,EAAE,IAAI,oBAAoB,EAAE;gBAC/B,IAAI,eAAe;oBAAE,OAAO,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;aAChE;YACD,IAAI,CAAC,EAAE,IAAI,oBAAoB;gBAAE,MAAM;YACvC,eAAe,GAAG,CAAC,EAAE,CAAC;SACvB;IACH,CAAC;CACF;AA3YD,4DA2YC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paraswap/dex-lib",
-  "version": "3.8.26",
+  "version": "3.8.27-dualsync.1",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "repository": "https://github.com/paraswap/paraswap-dex-lib",

package/src/dex/idex.ts

@@ -207,6 +207,14 @@ export interface IDexPricing<ExchangeData> {
   // useful for RFQ system
   isBlacklisted?(userAddress?: Address): AsyncOrSync<boolean>;
 
+  addPoolGenerateState?({
+    poolIdentifier,
+    blockNumber,
+  }: {
+    poolIdentifier: string;
+    blockNumber: number;
+  }): AsyncOrSync<null | unknown>;
+
   // blacklist a specific userAddress from exchange
   setBlacklist?(userAddress?: Address): AsyncOrSync<boolean>;
 }

package/src/dex/pancakeswap-v3/pancakeswap-v3-pool.ts

@@ -29,8 +29,9 @@ import {
   _reduceTickBitmap,
   _reduceTicks,
 } from '../uniswap-v3/contract-math/utils';
+import { StatefulDualSynchronizer } from '../../stateful-dual-synchronizer';
 
-export class PancakeSwapV3EventPool extends StatefulEventSubscriber<PoolState> {
+export class PancakeSwapV3EventPool extends StatefulDualSynchronizer<PoolState> {
   handlers: {
     [event: string]: (
       event: any,
@@ -61,7 +62,7 @@ export class PancakeSwapV3EventPool extends StatefulEventSubscriber<PoolState> {
 
   constructor(
     readonly dexHelper: IDexHelper,
-    parentName: string,
+    dexKey: string,
     readonly stateMultiContract: Contract,
     readonly erc20Interface: Interface,
     protected readonly factoryAddress: Address,
@@ -73,14 +74,8 @@ export class PancakeSwapV3EventPool extends StatefulEventSubscriber<PoolState> {
     readonly poolInitCodeHash: string,
     readonly poolDeployer?: string,
   ) {
-    super(
-      parentName,
-      `${token0}_${token1}_${feeCode}`,
-      dexHelper,
-      logger,
-      true,
-      mapKey,
-    );
+    const poolIdentifier = `${token0}_${token1}_${feeCode}`;
+    super(dexKey, poolIdentifier, dexHelper, logger);
     this.feeCodeAsString = feeCode.toString();
     this.token0 = token0.toLowerCase();
     this.token1 = token1.toLowerCase();

package/src/dex/pancakeswap-v3/pancakeswap-v3.ts

@@ -62,6 +62,7 @@ import {
   PancakeswapV3Factory,
 } from './pancakeswap-v3-factory';
 import { extractReturnAmountPosition } from '../../executor/utils';
+import { DexPoolNotFoundError } from '../../dex-utils';
 
 type PoolPairsInfo = {
   token0: Address;
@@ -293,7 +294,10 @@ export class PancakeswapV3
         },
       });
     } catch (e) {
-      if (e instanceof Error && e.message.endsWith('Pool does not exist')) {
+      if (
+        (e instanceof Error && e.message.endsWith('Pool does not exist')) ||
+        e instanceof DexPoolNotFoundError
+      ) {
         // no need to await we want the set to have the pool key but it's not blocking
         this.dexHelper.cache.zadd(
           this.notExistingPoolSetKey,
@@ -368,6 +372,22 @@ export class PancakeswapV3
     return true;
   }
 
+  async addPoolGenerateState({
+    poolIdentifier,
+    blockNumber,
+  }: {
+    poolIdentifier: string;
+    blockNumber: number;
+  }): Promise<PoolState | null> {
+    const [token0, token1, fee] = poolIdentifier.split('_');
+
+    const pool = await this.getPool(token0, token1, BigInt(fee), blockNumber);
+
+    if (!pool) return null;
+
+    return pool.getState(blockNumber);
+  }
+
   async getPoolIdentifiers(
     srcToken: Token,
     destToken: Token,
@@ -661,7 +681,7 @@ export class PancakeswapV3
           if (state.liquidity <= 0n) {
             if (state.liquidity < 0) {
               this.logger.error(
-                `${this.dexKey}-${this.network}: ${pool.poolAddress} pool has negative liquidity: ${state.liquidity}. Find with key: ${pool.mapKey}`,
+                `${this.dexKey}-${this.network}: ${pool.poolAddress} pool has negative liquidity: ${state.liquidity}. Find with key: ${pool.poolIdentifier}`,
               );
             }
             this.logger.trace(`pool have 0 liquidity`);

package/src/dex/uniswap-v2/uniswap-v2.ts

@@ -3,7 +3,6 @@ import { pack } from '@ethersproject/solidity';
 import _ from 'lodash';
 import { AsyncOrSync, DeepReadonly } from 'ts-essentials';
 import erc20ABI from '../../abi/erc20.json';
-import { StatefulEventSubscriber } from '../../stateful-event-subscriber';
 import {
   AdapterExchangeParam,
   Address,
@@ -69,6 +68,7 @@ import {
   hexConcat,
 } from 'ethers/lib/utils';
 import { BigNumber } from 'ethers';
+import { StatefulDualSynchronizer } from '../../stateful-dual-synchronizer';
 
 const rebaseTokens = _rebaseTokens as { chainId: number; address: string }[];
 
@@ -124,11 +124,12 @@ export interface UniswapV2Pair {
   pool?: UniswapV2EventPool;
 }
 
-export class UniswapV2EventPool extends StatefulEventSubscriber<UniswapV2PoolState> {
+export class UniswapV2EventPool extends StatefulDualSynchronizer<UniswapV2PoolState> {
   decoder = (log: Log) => this.iface.parseLog(log);
 
   constructor(
-    parentName: string,
+    public parentName: string,
+    public poolIdentifier: string,
     protected dexHelper: IDexHelper,
     private poolAddress: Address,
     private token0: Token,
@@ -142,15 +143,7 @@ export class UniswapV2EventPool extends StatefulEventSubscriber<UniswapV2PoolSta
     private feesMultiCallDecoder?: (values: any[]) => number,
     private iface: Interface = uniswapV2PoolIface,
   ) {
-    super(
-      parentName,
-      (token0.symbol || token0.address) +
-        '-' +
-        (token1.symbol || token1.address) +
-        ' pool',
-      dexHelper,
-      logger,
-    );
+    super(parentName, poolIdentifier, dexHelper, logger);
   }
 
   protected processLog(
@@ -301,10 +294,11 @@ export class UniswapV2
     reserves1: string,
     feeCode: number,
     blockNumber: number,
-  ) {
+  ): Promise<UniswapV2EventPool | null> {
     const { callEntry, callDecoder } = this.getFeesMultiCallData(pair) || {};
     pair.pool = new UniswapV2EventPool(
       this.dexKey,
+      this._getPoolIdentifier(pair.token0, pair.token1),
       this.dexHelper,
       pair.exchange!,
       pair.token0,
@@ -318,9 +312,50 @@ export class UniswapV2
     );
     pair.pool.addressesSubscribed.push(pair.exchange!);
 
-    await pair.pool.initialize(blockNumber, {
+    try {
+      await pair.pool.initialize(
+        blockNumber,
+        /*, {
       state: { reserves0, reserves1, feeCode },
-    });
+    }
+      */
+      );
+      return pair.pool;
+    } catch (e) {
+      this.logger.error(`Error_addPool could not add pool with error:`, e);
+      delete pair.pool;
+      return null;
+    }
+  }
+
+  async addPoolGenerateState({
+    poolIdentifier,
+    blockNumber,
+  }: {
+    poolIdentifier: string;
+    blockNumber: number;
+  }): Promise<UniswapV2PoolState | null> {
+    // poolIdentifier is in the format of 'uniswapv2_<token0>_<token1>'
+    const [, token0, token1] = poolIdentifier.split('_');
+    const pair = await this.findPair(
+      { address: token0, decimals: 0 },
+      { address: token1, decimals: 0 },
+    );
+    if (!(pair && pair.exchange)) return null;
+
+    const [pairState] = await this.getManyPoolReserves([pair], blockNumber);
+
+    const pool = await this.addPool(
+      pair,
+      pairState.reserves0,
+      pairState.reserves1,
+      pairState.feeCode,
+      blockNumber,
+    );
+
+    if (!pool) return null;
+
+    return pool.getState(blockNumber);
   }
 
   async getBuyPrice(
@@ -479,7 +514,9 @@ export class UniswapV2
           pairState.feeCode,
           blockNumber,
         );
-      } else pair.pool.setState(pairState, blockNumber);
+      } else {
+        // pair.pool.setState(pairState, blockNumber); // TEMP: temporarily disabled to prevent confusions with new system
+      }
     }
   }
 
@@ -525,6 +562,19 @@ export class UniswapV2
     };
   }
 
+  _getPoolIdentifier(_from: Token, _to: Token) {
+    const from = this.dexHelper.config.wrapETH(_from);
+    const to = this.dexHelper.config.wrapETH(_to);
+
+    const tokenAddress = [from.address.toLowerCase(), to.address.toLowerCase()]
+      .sort((a, b) => (a > b ? 1 : -1))
+      .join('_');
+
+    const poolIdentifier = `${this.dexKey}_${tokenAddress}`;
+
+    return poolIdentifier.toLowerCase();
+  }
+
   async getPoolIdentifiers(
     _from: Token,
     _to: Token,

package/src/dex/uniswap-v3/uniswap-v3-pool.ts

@@ -4,10 +4,7 @@ import { Interface } from '@ethersproject/abi';
 import { ethers } from 'ethers';
 import { assert, DeepReadonly } from 'ts-essentials';
 import { Log, Logger, BlockHeader, Address } from '../../types';
-import {
-  InitializeStateOptions,
-  StatefulEventSubscriber,
-} from '../../stateful-event-subscriber';
+import { InitializeStateOptions } from '../../stateful-event-subscriber';
 import { IDexHelper } from '../../dex-helper/idex-helper';
 import {
   PoolState,
@@ -27,8 +24,9 @@ import { TickBitMap } from './contract-math/TickBitMap';
 import { uint256ToBigInt } from '../../lib/decoders';
 import { decodeStateMultiCallResultWithRelativeBitmaps } from './utils';
 import { _reduceTickBitmap, _reduceTicks } from './contract-math/utils';
+import { StatefulDualSynchronizer } from '../../stateful-dual-synchronizer';
 
-export class UniswapV3EventPool extends StatefulEventSubscriber<PoolState> {
+export class UniswapV3EventPool extends StatefulDualSynchronizer<PoolState> {
   handlers: {
     [event: string]: (
       event: any,
@@ -79,7 +77,7 @@ export class UniswapV3EventPool extends StatefulEventSubscriber<PoolState> {
       poolKey = `${poolKey}_${tickSpacing}`;
     }
 
-    super(parentName, poolKey, dexHelper, logger, true, mapKey);
+    super(parentName, poolKey, dexHelper, logger);
     this.feeCodeAsString = feeCode.toString();
     this.token0 = token0.toLowerCase();
     this.token1 = token1.toLowerCase();

package/src/dex/uniswap-v3/uniswap-v3.ts

@@ -72,6 +72,7 @@ import { OptimalSwapExchange } from '@paraswap/core';
 import { OnPoolCreatedCallback, UniswapV3Factory } from './uniswap-v3-factory';
 import { hexConcat, hexlify, hexZeroPad, hexValue } from 'ethers/lib/utils';
 import { extractReturnAmountPosition } from '../../executor/utils';
+import { DexPoolNotFoundError } from '../../dex-utils';
 
 type PoolPairsInfo = {
   token0: Address;
@@ -321,7 +322,10 @@ export class UniswapV3
         },
       });
     } catch (e) {
-      if (e instanceof Error && e.message.endsWith('Pool does not exist')) {
+      if (
+        (e instanceof Error && e.message.endsWith('Pool does not exist')) ||
+        e instanceof DexPoolNotFoundError
+      ) {
         // no need to await we want the set to have the pool key but it's not blocking
         this.dexHelper.cache.zadd(
           this.notExistingPoolSetKey,
@@ -443,6 +447,28 @@ export class UniswapV3
     return true;
   }
 
+  async addPoolGenerateState({
+    poolIdentifier,
+    blockNumber,
+  }: {
+    poolIdentifier: string;
+    blockNumber: number;
+  }): Promise<PoolState | null> {
+    const [token0, token1, fee, tickSpacing] = poolIdentifier.split('_');
+
+    const pool = await this.getPool(
+      token0,
+      token1,
+      BigInt(fee),
+      blockNumber,
+      tickSpacing !== undefined ? BigInt(tickSpacing) : undefined,
+    );
+
+    if (!pool) return null;
+
+    return pool.getState(blockNumber);
+  }
+
   async getPoolIdentifiers(
     srcToken: Token,
     destToken: Token,
@@ -763,7 +789,7 @@ export class UniswapV3
           if (state.liquidity <= 0n) {
             if (state.liquidity < 0) {
               this.logger.error(
-                `${this.dexKey}-${this.network}: ${pool.poolAddress} pool has negative liquidity: ${state.liquidity}. Find with key: ${pool.mapKey}`,
+                `${this.dexKey}-${this.network}: ${pool.poolAddress} pool has negative liquidity: ${state.liquidity}. Find with key: ${pool.poolIdentifier}`,
               );
             }
             this.logger.trace(`pool have 0 liquidity`);

package/src/dex-helper/dummy-dex-helper.ts

@@ -299,6 +299,8 @@ export class DummyDexHelper implements IDexHelper {
   getLogger: LoggerConstructor;
   web3Provider: Web3;
   getTokenUSDPrice: (token: Token, amount: bigint) => Promise<number>;
+  dexStatePublisher: any; // FIXME
+  dexStateSubscriber: any; // FIXME
 
   constructor(network: number, rpcUrl?: string) {
     this.config = new ConfigHelper(false, generateConfig(network), 'is');