@paraswap/dex-lib 2.14.0 → 2.14.2

package/src/lib/stateful-rpc-poller/stateful-rpc-poller.ts

@@ -0,0 +1,604 @@
+import { Logger, LogLevels } from '../../types';
+import { IDexHelper } from '../../dex-helper';
+import {
+  IStatefulRpcPoller,
+  ObjWithUpdateInfo,
+  PollingManagerControllersCb,
+  StateSources,
+} from './types';
+import { MultiCallParams, MultiResult } from '../multi-wrapper';
+import { CACHE_PREFIX } from '../../constants';
+import { uint256DecodeToNumber } from '../decoders';
+import { assert } from 'ts-essentials';
+import { LogMessagesSuppressor, MessageInfo } from '../log-messages-suppressor';
+import { Utils } from '../../utils';
+import { getIdentifierKeyForRpcPoller } from './utils';
+
+const StatefulRPCPollerMessages = {
+  ERROR_FETCHING_STATE_FROM_CACHE: `Unexpected error while fetching state from Cache`,
+  ERROR_FETCHING_STATE_FROM_RPC: `Unexpected error while fetching state from RPC`,
+  ERROR_SAVING_LIQUIDITY_IN_CACHE: `Unexpected error while saving liquidity in Cache`,
+  ERROR_SAVING_STATE_IN_CACHE: `Unexpected error while saving state in Cache`,
+
+  FALLBACK_TO_RPC: `Failed to retrieve updated state from cache. Falling back to RPC`,
+
+  LIQUIDITY_INFO_IS_OUTDATED:
+    `Liquidity info in USD is outdated. Wil be updating ` +
+    `every pool that is outdated to not degrade performance`,
+} as const;
+
+const DEFAULT_LIQUIDITY_UPDATE_PERIOD_MS = 2 * 60 * 1000;
+const DEFAULT_STATE_INIT_RETRY_MS = 1000;
+
+export abstract class StatefulRpcPoller<State, M>
+  implements IStatefulRpcPoller<State, M>
+{
+  static StatefulRPCPollerMessages: Record<
+    keyof typeof StatefulRPCPollerMessages,
+    MessageInfo<typeof StatefulRPCPollerMessages>
+  > = {
+    ERROR_FETCHING_STATE_FROM_CACHE: {
+      key: 'ERROR_FETCHING_STATE_FROM_CACHE',
+      message: StatefulRPCPollerMessages.ERROR_FETCHING_STATE_FROM_CACHE,
+      logLevel: 'error',
+    },
+    ERROR_FETCHING_STATE_FROM_RPC: {
+      key: 'ERROR_FETCHING_STATE_FROM_RPC',
+      message: StatefulRPCPollerMessages.ERROR_FETCHING_STATE_FROM_RPC,
+      logLevel: 'error',
+    },
+    ERROR_SAVING_LIQUIDITY_IN_CACHE: {
+      key: 'ERROR_SAVING_LIQUIDITY_IN_CACHE',
+      message: StatefulRPCPollerMessages.ERROR_SAVING_LIQUIDITY_IN_CACHE,
+      logLevel: 'error',
+    },
+    ERROR_SAVING_STATE_IN_CACHE: {
+      key: 'ERROR_SAVING_STATE_IN_CACHE',
+      message: StatefulRPCPollerMessages.ERROR_SAVING_STATE_IN_CACHE,
+      logLevel: 'error',
+    },
+    LIQUIDITY_INFO_IS_OUTDATED: {
+      key: 'LIQUIDITY_INFO_IS_OUTDATED',
+      message: StatefulRPCPollerMessages.LIQUIDITY_INFO_IS_OUTDATED,
+      logLevel: 'error',
+    },
+    FALLBACK_TO_RPC: {
+      key: 'FALLBACK_TO_RPC',
+      message: StatefulRPCPollerMessages.FALLBACK_TO_RPC,
+      logLevel: 'warn',
+    },
+  };
+
+  // The current state and its block number
+  // Derived classes should not set these directly, and instead use setState()
+  protected _stateWithUpdateInfo?: ObjWithUpdateInfo<State>;
+
+  // This values is used to determine if current pool will participate in update or not
+  // We don't want to keep track of state for pools without liquidity
+  protected _liquidityInUSDWithUpdateInfo: ObjWithUpdateInfo<number> = {
+    value: 0,
+    blockNumber: 0,
+    lastUpdatedAtMs: 0,
+  };
+
+  readonly cacheStateKey: string;
+  readonly cacheLiquidityMapKey: string;
+
+  // Store here encoded calls for blockNumber, blockTimestamp etc.
+  protected _cachedMultiCallData?: [
+    MultiCallParams<number>,
+    ...MultiCallParams<M>[],
+  ];
+
+  protected _getBlockNumberMultiCall: MultiCallParams<number>;
+
+  readonly entityName: string;
+
+  protected logMessagesSuppressor: LogMessagesSuppressor<
+    typeof StatefulRPCPollerMessages
+  >;
+
+  // This flag is changed only via isPoolParticipateInUpdates setter
+  // It is used to determine if we should update state or not
+  protected _isPoolParticipateInUpdates: boolean = true;
+
+  protected _isPoolInTheMiddleOfUpdate: boolean = false;
+
+  readonly identifierKey: string;
+
+  protected logger: Logger;
+
+  constructor(
+    readonly dexKey: string,
+    poolIdentifier: string,
+    protected dexHelper: IDexHelper,
+
+    // If liquidity is less than this value, we will not update state
+    protected liquidityThresholdForUpdate: number,
+    // If for some reason liquidity update is broken, for this delay we will still
+    // continue to serve update state
+    protected liquidityUpdateAllowedDelayMs: number,
+
+    // For some pools we don't worry about liquidity and want always to keep state updated
+    protected isLiquidityTracked: boolean,
+
+    // Polling manager callbacks. They are useful when you want
+    // to give some change information in reverse way.
+    // For example, you changed liquidity state, notify manager to
+    // not poll that particular pools
+    protected managerCbControllers: PollingManagerControllersCb,
+
+    // If the state is outdated more than this amount of blocks, we will not use this state anymore
+    protected maxAllowedStateDelayInBlocks: number = dexHelper.config.data
+      .rpcPollingMaxAllowedStateDelayInBlocks,
+
+    // When cross this threshold we will trigger update. The idea is this number is less than
+    // maxAllowedStateDelayToUpdate, so we trigger update before state become invalid.
+    // If blocksBackToTriggerUpdate = maxAllowedStateDelayInBlocks, we will do our best
+    // effort to keep up with a tip of chain: trigger update on every new block
+    protected blocksBackToTriggerUpdate: number = dexHelper.config.data
+      .rpcPollingBlocksBackToTriggerUpdate,
+
+    protected liquidityUpdatePeriodMs = DEFAULT_LIQUIDITY_UPDATE_PERIOD_MS,
+  ) {
+    // Don't make it too custom, like adding poolIdentifier. It will break log suppressor
+    // If we are really need to do that, update log Suppressor to handle that case
+    // The idea is to have one entity name per Dex level, not pool level
+    this.entityName = `StatefulPoller-${this.dexKey}-${this.dexHelper.config.data.network}`;
+
+    // I made it a little bit different from poolIdentifier, because usually
+    // pool identifier doesn't contain network information and it may occasionally
+    // collide across chains, though that scenario is very unlikely to happen
+    // For consumers they still can use poolIdentifier to get instance, but since
+    // we always give network information, it is better we can hide this implementation detail
+    this.identifierKey = getIdentifierKeyForRpcPoller(
+      poolIdentifier,
+      this.network,
+    );
+
+    this.cacheLiquidityMapKey =
+      `${CACHE_PREFIX}_${this.network}_${this.dexKey}_liquidity_usd`.toLowerCase();
+    this.cacheStateKey =
+      `${CACHE_PREFIX}_${this.network}_${this.dexKey}_states`.toLowerCase();
+
+    this.logger = this.dexHelper.getLogger(`${this.entityName}`);
+
+    assert(
+      this.maxAllowedStateDelayInBlocks >= 0,
+      `${this.dexKey}-${this.network}-${this.identifierKey}: ` +
+        `Max allowed state delay must be >= 0. Received ${this.maxAllowedStateDelayInBlocks}`,
+    );
+
+    assert(
+      this.blocksBackToTriggerUpdate >= 0,
+      `${this.dexKey}-${this.network}-${this.identifierKey}: ` +
+        `Blocks back to trigger update must be >= 0. Received ${this.blocksBackToTriggerUpdate}`,
+    );
+
+    // You can not go more blocks back than you allow to be delayed
+    assert(
+      this.blocksBackToTriggerUpdate <= this.maxAllowedStateDelayInBlocks,
+      `${this.dexKey}-${this.network}-${this.identifierKey}: ` +
+        `Blocks back to trigger update must be <= maxAllowedStateDelayInBlocks. ` +
+        `Received ${this.blocksBackToTriggerUpdate} > ${this.maxAllowedStateDelayInBlocks}`,
+    );
+
+    this._getBlockNumberMultiCall = {
+      target: this.dexHelper.multiContract.options.address,
+      callData: this.dexHelper.multiContract.methods
+        .getBlockNumber()
+        .encodeABI(),
+      decodeFunction: uint256DecodeToNumber,
+    };
+
+    this.logMessagesSuppressor = LogMessagesSuppressor.getLogSuppressorInstance<
+      typeof StatefulRPCPollerMessages
+    >(
+      this.entityName,
+      StatefulRpcPoller.StatefulRPCPollerMessages,
+      this.logger,
+    );
+
+    // This is done to not rely on manual initialize pool call.
+    // Any time new pool initialized, it is already automatically registered in polling manager
+    this.managerCbControllers.registerPendingPool(this);
+  }
+
+  get network() {
+    return this.dexHelper.config.data.network;
+  }
+
+  protected get isMaster() {
+    return !this.dexHelper.config.isSlave;
+  }
+
+  protected _isStateOutdated(
+    checkForBlockNumber: number,
+    stateValidBlockNumber: number,
+    stateValidityBlockNumDelay: number,
+  ): boolean {
+    return (
+      checkForBlockNumber - stateValidBlockNumber > stateValidityBlockNumDelay
+    );
+  }
+
+  protected _isStateOutdatedForUse(
+    checkForBlockNumber: number,
+    stateValidBlockNumber: number,
+  ): boolean {
+    return this._isStateOutdated(
+      checkForBlockNumber,
+      stateValidBlockNumber,
+      this.maxAllowedStateDelayInBlocks,
+    );
+  }
+
+  isTimeToTriggerUpdate(blocknumber: number): boolean {
+    return this._isStateOutdated(
+      blocknumber,
+      this._stateWithUpdateInfo?.blockNumber || 0,
+      this.blocksBackToTriggerUpdate,
+    );
+  }
+
+  protected async _retrieveStateWithChecks(
+    retriever: () => Promise<ObjWithUpdateInfo<State> | null>,
+    blockNumber: number | 'latest',
+    source: StateSources,
+  ) {
+    const state = await retriever();
+
+    if (state) {
+      if (
+        blockNumber === 'latest' ||
+        !this._isStateOutdatedForUse(blockNumber, state.blockNumber)
+      ) {
+        return state;
+      } else {
+        this._immediateLogMessage(
+          `State from ${source} is outdated. Valid for number ${
+            state.blockNumber
+          }, but requested for ${blockNumber}. Diff ${
+            blockNumber - state.blockNumber
+          } blocks`,
+          'trace',
+        );
+      }
+    } else {
+      if (source === StateSources.LOCAL_MEMORY) {
+        this._immediateLogMessage(
+          `State is not initialized in memory`,
+          'error',
+        );
+      } else {
+        this._immediateLogMessage(
+          `State from ${source} is not available`,
+          'trace',
+        );
+      }
+    }
+    return null;
+  }
+
+  async getState(
+    blockNumber: number | 'latest' = 'latest',
+    forInitialization: boolean = false,
+    // If we found that state in memory is outdated, then we save it for future use
+    saveInMemory: boolean = true,
+  ): Promise<ObjWithUpdateInfo<State> | null> {
+    // If it is for initialization purposes, we for sure doesn't have state in memory
+    if (!forInitialization) {
+      // Try to get with least effort from local memory
+      const localState = await this._retrieveStateWithChecks(
+        async () => this._stateWithUpdateInfo ?? null,
+        blockNumber,
+        StateSources.LOCAL_MEMORY,
+      );
+      if (localState !== null) {
+        return localState;
+      }
+    }
+
+    // If we failed to get from memory. Try to fetch state from cache
+    try {
+      const cacheState = await this._retrieveStateWithChecks(
+        async () => (await this.fetchStateFromCache()) ?? null,
+        blockNumber,
+        StateSources.CACHE,
+      );
+      if (cacheState !== null) {
+        if (saveInMemory) {
+          // We want to save latest available state in memory for future use
+          // This await shouldn't slow down because if we are slave, we won't save state in cache
+          await this.setState(
+            cacheState.value,
+            cacheState.blockNumber,
+            cacheState.lastUpdatedAtMs,
+          );
+        }
+        return cacheState;
+      }
+    } catch (e) {
+      this._logMessageWithSuppression(`ERROR_FETCHING_STATE_FROM_CACHE`, e);
+    }
+
+    this._logMessageWithSuppression('FALLBACK_TO_RPC');
+
+    // As a last step. If we failed everything above, try to fetch from RPC
+    try {
+      const rpcState = await this._retrieveStateWithChecks(
+        async () => (await this.fetchLatestStateFromRpc()) ?? null,
+        blockNumber,
+        StateSources.RPC,
+      );
+      if (rpcState !== null) {
+        if (saveInMemory) {
+          // We want to save latest available state in memory for future use
+          // This await shouldn't slow down because if we are slave, we won't save state in cache
+          await this.setState(
+            rpcState.value,
+            rpcState.blockNumber,
+            rpcState.lastUpdatedAtMs,
+          );
+          return rpcState;
+        }
+      }
+    } catch (e) {
+      this._logMessageWithSuppression('ERROR_FETCHING_STATE_FROM_RPC', e);
+    }
+
+    // If nothing works, then we can not do anything here and skip this pool
+    return null;
+  }
+
+  protected _logMessageWithSuppression(
+    msgKey: keyof typeof StatefulRPCPollerMessages,
+    ...args: unknown[]
+  ) {
+    this.logMessagesSuppressor.logMessage(msgKey, this.identifierKey, ...args);
+  }
+
+  protected _immediateLogMessage(
+    message: string,
+    level: LogLevels,
+    ...args: unknown[]
+  ) {
+    this.logger[level](
+      `${message}. ${args.map(a => Utils.Serialize(a)).join('.')}`,
+    );
+  }
+
+  get isPoolParticipateInUpdates(): boolean {
+    return this._isPoolParticipateInUpdates;
+  }
+
+  set isPoolParticipateInUpdates(value: boolean) {
+    // If we change state update status, we always keep relevant info in manager
+    value
+      ? this.managerCbControllers.enableStateTracking(this.identifierKey)
+      : this.managerCbControllers.disableStateTracking(this.identifierKey);
+
+    this._isPoolParticipateInUpdates = value;
+  }
+
+  get isPoolInTheMiddleOfUpdate(): boolean {
+    return this._isPoolInTheMiddleOfUpdate;
+  }
+
+  set isPoolInTheMiddleOfUpdate(value: boolean) {
+    this._isPoolInTheMiddleOfUpdate = value;
+  }
+
+  // For the time of implementing this class, I don't need multi step state fetch,
+  // when we need to sequentially fetch data to get full state. This is true for CurveV1Factory and WooFi
+  // Later we may consider having more complicated generateState mechanism.
+  protected abstract _getFetchStateMultiCalls(): MultiCallParams<M>[];
+
+  getFetchStateWithBlockInfoMultiCalls(): [
+    MultiCallParams<number>,
+    ...MultiCallParams<M>[],
+  ] {
+    if (this._cachedMultiCallData === undefined) {
+      const stateMultiCalls = this._getFetchStateMultiCalls();
+      this._cachedMultiCallData = [
+        this._getBlockNumberMultiCall,
+        ...stateMultiCalls,
+      ];
+    }
+
+    return this._cachedMultiCallData;
+  }
+
+  protected abstract _parseStateFromMultiResults(multiOutputs: M[]): State;
+
+  parseStateFromMultiResultsWithBlockInfo(
+    multiOutputs: [MultiResult<number>, ...MultiResult<M>[]],
+    lastUpdatedAtMs: number,
+  ): ObjWithUpdateInfo<State> {
+    // By abstract I mean for abstract method which must be implemented
+    const [blockNumber, ...outputsForAbstract] = multiOutputs.map((m, i) => {
+      if (!m.success) {
+        throw new Error(
+          `${this.entityName} failed to get multicall with index ${i}`,
+        );
+      }
+
+      return m.returnData;
+    }) as [number, ...M[]];
+
+    return {
+      value: this._parseStateFromMultiResults(outputsForAbstract),
+      blockNumber,
+      lastUpdatedAtMs,
+    };
+  }
+
+  async fetchLatestStateFromRpc(): Promise<ObjWithUpdateInfo<State> | null> {
+    const multiCalls = this.getFetchStateWithBlockInfoMultiCalls();
+    try {
+      const lastUpdatedAtMs = Date.now();
+      const aggregatedResults = (await this.dexHelper.multiWrapper.tryAggregate<
+        number | M
+      >(true, multiCalls as MultiCallParams<M | number>[])) as [
+        MultiResult<number>,
+        ...MultiResult<M>[],
+      ];
+
+      return this.parseStateFromMultiResultsWithBlockInfo(
+        aggregatedResults,
+        lastUpdatedAtMs,
+      );
+    } catch (e) {
+      this._logMessageWithSuppression('ERROR_FETCHING_STATE_FROM_RPC', e);
+    }
+
+    return null;
+  }
+
+  async setState(
+    state: State,
+    blockNumber: number,
+    lastUpdatedAtMs: number,
+  ): Promise<void> {
+    if (this._stateWithUpdateInfo === undefined) {
+      this._stateWithUpdateInfo = {
+        value: state,
+        blockNumber,
+        lastUpdatedAtMs,
+      };
+    } else {
+      this._stateWithUpdateInfo.value = state;
+      this._stateWithUpdateInfo.blockNumber = blockNumber;
+      this._stateWithUpdateInfo.lastUpdatedAtMs = lastUpdatedAtMs;
+    }
+
+    // Master version must keep cache up to date
+    if (this.isMaster) {
+      await this._saveStateInCache();
+    }
+  }
+
+  protected async _saveStateInCache(): Promise<boolean> {
+    try {
+      await this.dexHelper.cache.hset(
+        this.cacheStateKey,
+        this.identifierKey,
+        Utils.Serialize(this._stateWithUpdateInfo),
+      );
+      this._immediateLogMessage(
+        `State successfully saved in cache hashmap: ${this.cacheStateKey}, key=${this.identifierKey}`,
+        'debug',
+      );
+      return true;
+    } catch (e) {
+      this._logMessageWithSuppression('ERROR_SAVING_STATE_IN_CACHE', e);
+    }
+    return false;
+  }
+
+  protected async _saveLiquidityInCache(): Promise<boolean> {
+    try {
+      await this.dexHelper.cache.setex(
+        this.dexKey,
+        this.network,
+        this.cacheLiquidityMapKey,
+        this._getExpiryTimeForCachedLiquidity(),
+        JSON.stringify(this._liquidityInUSDWithUpdateInfo),
+      );
+      return true;
+    } catch (e) {
+      this._logMessageWithSuppression('ERROR_SAVING_LIQUIDITY_IN_CACHE', e);
+    }
+    return false;
+  }
+
+  async fetchStateFromCache(): Promise<ObjWithUpdateInfo<State> | null> {
+    const resultUnparsed = await this.dexHelper.cache.hget(
+      this.cacheStateKey,
+      this.identifierKey,
+    );
+
+    if (resultUnparsed !== null) {
+      return Utils.Parse(resultUnparsed) as ObjWithUpdateInfo<State>;
+    }
+
+    return null;
+  }
+
+  protected async _fetchLiquidityFromCache(): Promise<ObjWithUpdateInfo<number> | null> {
+    const resultUnparsed = await this.dexHelper.cache.get(
+      this.dexKey,
+      this.network,
+      this.cacheStateKey,
+    );
+
+    if (resultUnparsed !== null) {
+      return Utils.Parse(resultUnparsed) as ObjWithUpdateInfo<number>;
+    }
+
+    return null;
+  }
+
+  async setLiquidity(
+    newLiquidityInUSD: number,
+    lastUpdatedAtMs: number,
+    blockNumber?: number,
+  ): Promise<void> {
+    this._liquidityInUSDWithUpdateInfo.value = newLiquidityInUSD;
+    this._liquidityInUSDWithUpdateInfo.lastUpdatedAtMs = lastUpdatedAtMs;
+    this._liquidityInUSDWithUpdateInfo.blockNumber = blockNumber || 0;
+
+    this._adjustIsStateToBeUpdated();
+
+    if (this.isMaster) {
+      await this._saveLiquidityInCache();
+    }
+  }
+
+  protected _adjustIsStateToBeUpdated() {
+    if (this.isLiquidityTracked) {
+      if (
+        Date.now() - this._liquidityInUSDWithUpdateInfo.lastUpdatedAtMs >
+        this.liquidityUpdateAllowedDelayMs
+      ) {
+        this._logMessageWithSuppression(
+          'LIQUIDITY_INFO_IS_OUTDATED',
+          `Last updated at ${this._liquidityInUSDWithUpdateInfo.lastUpdatedAtMs}`,
+        );
+        this.isPoolParticipateInUpdates = true;
+      } else {
+        this.isPoolParticipateInUpdates =
+          this._liquidityInUSDWithUpdateInfo.value >=
+          this.liquidityThresholdForUpdate;
+      }
+    }
+  }
+
+  protected _getExpiryTimeForCachedLiquidity() {
+    // Give it 10 minutes margin to recover
+    return Math.floor(this.liquidityUpdatePeriodMs / 1000) + 10 * 60 * 1000;
+  }
+
+  async initializeState(): Promise<void> {
+    try {
+      const state = await this.fetchLatestStateFromRpc();
+
+      if (state === null) {
+        this._immediateLogMessage(
+          `initializePool: pool=${this.identifierKey} from ${this.dexKey} state is null. Retry in ${DEFAULT_STATE_INIT_RETRY_MS} ms`,
+          'error',
+        );
+      } else {
+        this.setState(state.value, state.blockNumber, state.lastUpdatedAtMs);
+        return;
+      }
+    } catch (e) {
+      this._immediateLogMessage(
+        `initializePool: pool=${this.identifierKey} from ${this.dexKey} failed to initialize state from RPC. Retry in ${DEFAULT_STATE_INIT_RETRY_MS} ms`,
+        'error',
+      );
+    }
+
+    setTimeout(() => this.initializeState(), DEFAULT_STATE_INIT_RETRY_MS);
+  }
+}

package/src/lib/stateful-rpc-poller/types.ts

@@ -0,0 +1,66 @@
+import { MultiCallParams, MultiResult } from '../multi-wrapper';
+
+export type ObjWithUpdateInfo<T> = {
+  value: T;
+  blockNumber: number;
+  lastUpdatedAtMs: number;
+};
+
+export interface IStatefulRpcPoller<State, M> {
+  identifierKey: string;
+  dexKey: string;
+
+  // For example, if particular pool has enough liquidity, or maybe it is paused?
+  isPoolParticipateInUpdates: boolean;
+
+  isPoolInTheMiddleOfUpdate: boolean;
+
+  network: number;
+
+  isTimeToTriggerUpdate(blockNumber: number): boolean;
+
+  getFetchStateWithBlockInfoMultiCalls(): [
+    MultiCallParams<number>,
+    ...MultiCallParams<M>[],
+  ];
+
+  parseStateFromMultiResultsWithBlockInfo(
+    multiOutputs: [MultiResult<number>, ...MultiResult<M>[]],
+    lastUpdatedAtMs: number,
+  ): ObjWithUpdateInfo<State>;
+
+  setState(
+    state: State,
+    blockNumber: number,
+    lastUpdatedAtMs: number,
+  ): Promise<void>;
+
+  fetchStateFromCache(): Promise<ObjWithUpdateInfo<State> | null>;
+
+  fetchLatestStateFromRpc(): Promise<ObjWithUpdateInfo<State> | null>;
+
+  // This function must not throw any errors
+  initializeState(): Promise<void>;
+
+  getState(blockNumber: number): Promise<ObjWithUpdateInfo<State> | null>;
+
+  setLiquidity(
+    newLiquidityInUSD: number,
+    lastUpdatedAtMs: number,
+    blockNumber?: number,
+  ): Promise<void>;
+}
+
+export type PollingManagerControllersCb = {
+  enableStateTracking: (identifierKey: string) => void;
+  disableStateTracking: (identifierKey: string) => void;
+  registerPendingPool: <T, M>(
+    statefulRpcPoller: IStatefulRpcPoller<T, M>,
+  ) => void;
+};
+
+export enum StateSources {
+  LOCAL_MEMORY = 'local_memory',
+  CACHE = 'cache',
+  RPC = 'rpc',
+}

package/src/lib/stateful-rpc-poller/utils.ts

@@ -0,0 +1,23 @@
+import type { StatePollingManager } from './state-polling-manager';
+import { PollingManagerControllersCb } from './types';
+
+export function getIdentifierKeyForRpcPoller(
+  poolIdentifier: string,
+  network: number,
+): string {
+  return `${network}_${poolIdentifier}`.toLowerCase();
+}
+
+// Helper function to extract relevant call backs for later use
+export function pollingManagerCbExtractor(
+  statePollingManager: StatePollingManager,
+): PollingManagerControllersCb {
+  return {
+    enableStateTracking:
+      statePollingManager.enableStateTracking.bind(statePollingManager),
+    disableStateTracking:
+      statePollingManager.disableStateTracking.bind(statePollingManager),
+    registerPendingPool:
+      statePollingManager.registerPendingPool.bind(statePollingManager),
+  };
+}