@drift-labs/common 1.0.0

package/lib/types/remote-configs.d.ts

@@ -0,0 +1,61 @@
+import { PerpMarketConfig, SpotMarketConfig } from '@drift-labs/sdk';
+export interface IPredictionMarketConfig {
+    title: string;
+    shortTitle: string;
+    category?: string;
+    symbol: string;
+    imgSrc: string;
+    previewImgSrc?: string;
+    devnetMarketIndex?: number;
+    mainnetMarketIndex?: number;
+    production?: boolean;
+    endingSoonThresholdDays?: number;
+    resolutionDateUnknown?: boolean;
+    resolutionDate: Date;
+    newUntilTs?: number;
+}
+export type SerializedPredictionMarketConfig = Omit<IPredictionMarketConfig, 'resolutionDate'> & {
+    resolutionDateUnix: number;
+};
+export type SerializedSpotMarketConfig = Omit<SpotMarketConfig, 'oracle' | 'mint' | 'oracleSource' | 'precision' | 'precisionExp' | 'serumMarket' | 'phoenixMarket' | 'openbookMarket'> & {
+    oracle: string;
+    mint: string;
+    oracleSource: string;
+    precision: number;
+    precisionExp: number;
+    serumMarket?: string;
+    phoenixMarket?: string;
+    openbookMarket?: string;
+    production?: boolean;
+};
+export type SerializedPerpMarketConfig = Omit<PerpMarketConfig, 'oracle' | 'oracleSource'> & {
+    oracle: string;
+    oracleSource: string;
+    production?: boolean;
+};
+export type SerializedRemoteConfigs = {
+    marketConfigs: {
+        devnet: {
+            spot: SerializedSpotMarketConfig[];
+            perp: SerializedPerpMarketConfig[];
+        };
+        mainnet: {
+            spot: SerializedSpotMarketConfig[];
+            perp: SerializedPerpMarketConfig[];
+        };
+    };
+    predictionMarkets: SerializedPredictionMarketConfig[];
+};
+export type RemoteConfigs = {
+    marketConfigs: {
+        devnet: {
+            spot: SpotMarketConfig[];
+            perp: PerpMarketConfig[];
+        };
+        mainnet: {
+            spot: SpotMarketConfig[];
+            perp: PerpMarketConfig[];
+        };
+    };
+    predictionMarkets: IPredictionMarketConfig[];
+};

package/lib/types/remote-configs.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remote-configs.js.map

package/lib/types/remote-configs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-configs.js","sourceRoot":"","sources":["../../src/types/remote-configs.ts"],"names":[],"mappings":"","sourcesContent":["import { PerpMarketConfig, SpotMarketConfig } from '@drift-labs/sdk';\n\nexport interface IPredictionMarketConfig {\n\ttitle: string;\n\tshortTitle: string;\n\tcategory?: string;\n\tsymbol: string;\n\timgSrc: string;\n\tpreviewImgSrc?: string;\n\tdevnetMarketIndex?: number;\n\tmainnetMarketIndex?: number;\n\tproduction?: boolean;\n\tendingSoonThresholdDays?: number;\n\tresolutionDateUnknown?: boolean;\n\tresolutionDate: Date;\n\tnewUntilTs?: number;\n}\n\nexport type SerializedPredictionMarketConfig = Omit<\n\tIPredictionMarketConfig,\n\t'resolutionDate'\n> & {\n\tresolutionDateUnix: number;\n};\n\nexport type SerializedSpotMarketConfig = Omit<\n\tSpotMarketConfig,\n\t| 'oracle'\n\t| 'mint'\n\t| 'oracleSource'\n\t| 'precision'\n\t| 'precisionExp'\n\t| 'serumMarket'\n\t| 'phoenixMarket'\n\t| 'openbookMarket'\n> & {\n\toracle: string;\n\tmint: string;\n\toracleSource: string;\n\tprecision: number;\n\tprecisionExp: number;\n\tserumMarket?: string;\n\tphoenixMarket?: string;\n\topenbookMarket?: string;\n\tproduction?: boolean;\n};\n\nexport type SerializedPerpMarketConfig = Omit<\n\tPerpMarketConfig,\n\t'oracle' | 'oracleSource'\n> & {\n\toracle: string;\n\toracleSource: string;\n\tproduction?: boolean;\n};\n\nexport type SerializedRemoteConfigs = {\n\tmarketConfigs: {\n\t\tdevnet: {\n\t\t\tspot: SerializedSpotMarketConfig[];\n\t\t\tperp: SerializedPerpMarketConfig[];\n\t\t};\n\t\tmainnet: {\n\t\t\tspot: SerializedSpotMarketConfig[];\n\t\t\tperp: SerializedPerpMarketConfig[];\n\t\t};\n\t};\n\tpredictionMarkets: SerializedPredictionMarketConfig[];\n};\n\nexport type RemoteConfigs = {\n\tmarketConfigs: {\n\t\tdevnet: {\n\t\t\tspot: SpotMarketConfig[];\n\t\t\tperp: PerpMarketConfig[];\n\t\t};\n\t\tmainnet: {\n\t\t\tspot: SpotMarketConfig[];\n\t\t\tperp: PerpMarketConfig[];\n\t\t};\n\t};\n\tpredictionMarkets: IPredictionMarketConfig[];\n};\n"]}

package/lib/types/trade.d.ts

@@ -0,0 +1,18 @@
+import { BN, OrderType } from '@drift-labs/sdk';
+export type TradeOffsetPrice = 'worst' | 'best' | 'oracle' | 'mark' | 'entry' | 'bestOffer';
+export type UIOrderType = 'market' | 'limit' | 'stopMarket' | 'stopLimit' | 'takeProfitMarket' | 'takeProfitLimit' | 'oracle' | 'oracleLimit' | 'scaledOrders';
+export type UIOrderTypeValue = {
+    label: string;
+    value: UIOrderType;
+    orderType: OrderType;
+    description?: string;
+};
+export type UIOrderTypeLookup = {
+    [key in UIOrderType]: UIOrderTypeValue;
+};
+export type AuctionParams = {
+    auctionStartPrice: BN;
+    auctionEndPrice: BN;
+    auctionDuration: number;
+    constrainedBySlippage?: boolean;
+};

package/lib/types/trade.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=trade.js.map

package/lib/types/trade.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trade.js","sourceRoot":"","sources":["../../src/types/trade.ts"],"names":[],"mappings":"","sourcesContent":["import { BN, OrderType } from '@drift-labs/sdk';\n\nexport type TradeOffsetPrice =\n\t| 'worst'\n\t| 'best'\n\t| 'oracle'\n\t| 'mark'\n\t| 'entry'\n\t| 'bestOffer';\n\nexport type UIOrderType =\n\t| 'market'\n\t| 'limit'\n\t| 'stopMarket'\n\t| 'stopLimit'\n\t| 'takeProfitMarket'\n\t| 'takeProfitLimit'\n\t| 'oracle'\n\t| 'oracleLimit'\n\t| 'scaledOrders';\n\nexport type UIOrderTypeValue = {\n\tlabel: string;\n\tvalue: UIOrderType;\n\torderType: OrderType;\n\tdescription?: string;\n};\n\nexport type UIOrderTypeLookup = {\n\t[key in UIOrderType]: UIOrderTypeValue;\n};\n\nexport type AuctionParams = {\n\tauctionStartPrice: BN;\n\tauctionEndPrice: BN;\n\tauctionDuration: number;\n\tconstrainedBySlippage?: boolean; // flag to tell the UI that end price is constrained by max slippage tolerance\n};\n"]}

package/lib/types/user.d.ts

@@ -0,0 +1,40 @@
+import { BN, PublicKey, SpotPosition } from '@drift-labs/sdk';
+export type OpenPosition = {
+    marketIndex: number;
+    marketSymbol: string;
+    direction: 'short' | 'long';
+    notional: BN;
+    baseSize: BN;
+    entryPrice: BN;
+    exitPrice: BN;
+    liqPrice: BN;
+    pnlVsOracle: BN;
+    pnlVsMark: BN;
+    quoteAssetNotionalAmount: BN;
+    quoteEntryAmount: BN;
+    quoteBreakEvenAmount: BN;
+    unrealizedFundingPnl: BN;
+    feesAndFundingPnl: BN;
+    lastCumulativeFundingRate: BN;
+    openOrders: number;
+    /**
+     * This is the unsettled pnl that is claimable. Naming is a bit confusing here.
+     */
+    unsettledPnl: BN;
+    unsettledFundingPnl: BN;
+    /**
+     * This is the total of unsettled pnl and unsettled funding.
+     */
+    totalUnrealizedPnl: BN;
+    costBasis: BN;
+    realizedPnl: BN;
+    lpShares: BN;
+    pnlIsClaimable: boolean;
+    remainderBaseAmount?: number;
+    lpDeriskPrice?: BN;
+};
+export type BankBalanceUI = SpotPosition & {
+    accountId: number;
+    accountName: string;
+    accountAuthority: PublicKey;
+};

package/lib/types/user.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user.js.map

package/lib/types/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../src/types/user.ts"],"names":[],"mappings":"","sourcesContent":["import { BN, PublicKey, SpotPosition } from '@drift-labs/sdk';\n\nexport type OpenPosition = {\n\tmarketIndex: number;\n\tmarketSymbol: string;\n\tdirection: 'short' | 'long';\n\tnotional: BN;\n\tbaseSize: BN;\n\tentryPrice: BN;\n\texitPrice: BN;\n\tliqPrice: BN;\n\tpnlVsOracle: BN;\n\tpnlVsMark: BN;\n\tquoteAssetNotionalAmount: BN;\n\tquoteEntryAmount: BN;\n\tquoteBreakEvenAmount: BN;\n\tunrealizedFundingPnl: BN;\n\tfeesAndFundingPnl: BN;\n\tlastCumulativeFundingRate: BN;\n\topenOrders: number;\n\t/**\n\t * This is the unsettled pnl that is claimable. Naming is a bit confusing here.\n\t */\n\tunsettledPnl: BN;\n\tunsettledFundingPnl: BN;\n\t/**\n\t * This is the total of unsettled pnl and unsettled funding.\n\t */\n\ttotalUnrealizedPnl: BN;\n\tcostBasis: BN;\n\trealizedPnl: BN;\n\tlpShares: BN;\n\tpnlIsClaimable: boolean;\n\tremainderBaseAmount?: number; // LP only\n\tlpDeriskPrice?: BN; //LP only\n};\n\nexport type BankBalanceUI = SpotPosition & {\n\taccountId: number;\n\taccountName: string;\n\taccountAuthority: PublicKey;\n};\n"]}

package/lib/types/utility.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This is a utility type that is used to create opaque types.
+ *
+ * E.g.
+ * ```ts
+ * type MyOpaqueType = Opaque<"MyOpaqueType", string>;
+ * ```
+ *
+ * This will create a type that is a string, but will not allow you to assign any other type to it.
+ *
+ * ```ts
+ */
+export type Opaque<K, T> = T & {
+    __TYPE__: K;
+};

package/lib/types/utility.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=utility.js.map

package/lib/types/utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.js","sourceRoot":"","sources":["../../src/types/utility.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * This is a utility type that is used to create opaque types.\n *\n * E.g.\n * ```ts\n * type MyOpaqueType = Opaque<\"MyOpaqueType\", string>;\n * ```\n *\n * This will create a type that is a string, but will not allow you to assign any other type to it.\n *\n * ```ts\n */\nexport type Opaque<K, T> = T & { __TYPE__: K };\n"]}

package/lib/utils/CircularBuffers/CircularBuffer.d.ts

@@ -0,0 +1,22 @@
+declare class Node<T> {
+    readonly value: T;
+    next: Node<T> | null;
+    constructor(value: T, next?: Node<T> | null);
+}
+export declare class CircularBuffer<T> {
+    protected _head: Node<T> | null;
+    protected _tail: Node<T> | null;
+    protected _size: number;
+    private readonly _capacity;
+    constructor(capacity: number);
+    protected get head(): Node<T> | null;
+    protected set head(value: Node<T> | null);
+    protected get tail(): Node<T> | null;
+    protected set tail(value: Node<T> | null);
+    get size(): number;
+    protected set size(value: number);
+    get capacity(): number;
+    add(value: T): T | null;
+    toArray(): T[];
+}
+export {};

package/lib/utils/CircularBuffers/CircularBuffer.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CircularBuffer = void 0;
+class Node {
+    constructor(value, next = null) {
+        this.value = value;
+        this.next = next;
+    }
+}
+class CircularBuffer {
+    constructor(capacity) {
+        this._head = null;
+        this._tail = null;
+        this._size = 0;
+        this._capacity = capacity;
+    }
+    get head() {
+        return this._head;
+    }
+    set head(value) {
+        this._head = value;
+    }
+    get tail() {
+        return this._tail;
+    }
+    set tail(value) {
+        this._tail = value;
+    }
+    get size() {
+        return this._size;
+    }
+    set size(value) {
+        this._size = value;
+    }
+    get capacity() {
+        return this._capacity;
+    }
+    add(value) {
+        const newNode = new Node(value);
+        let removedValue = null;
+        if (this._size === 0) {
+            this._head = this._tail = newNode;
+            newNode.next = newNode;
+        }
+        else {
+            newNode.next = this._head;
+            this._tail.next = newNode;
+            this._tail = newNode;
+        }
+        this._size++;
+        if (this._size > this._capacity) {
+            removedValue = this._head.value;
+            this._head = this._head.next;
+            this._tail.next = this._head;
+            this._size--;
+        }
+        return removedValue;
+    }
+    toArray() {
+        if (!this._head)
+            return [];
+        const result = [];
+        let current = this._head;
+        do {
+            result.push(current.value);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            current = current.next;
+        } while (current !== this._head);
+        return result;
+    }
+}
+exports.CircularBuffer = CircularBuffer;
+//# sourceMappingURL=CircularBuffer.js.map

package/lib/utils/CircularBuffers/CircularBuffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CircularBuffer.js","sourceRoot":"","sources":["../../../src/utils/CircularBuffers/CircularBuffer.ts"],"names":[],"mappings":";;;AAAA,MAAM,IAAI;IACT,YAA4B,KAAQ,EAAS,OAAuB,IAAI;QAA5C,UAAK,GAAL,KAAK,CAAG;QAAS,SAAI,GAAJ,IAAI,CAAuB;IAAG,CAAC;CAC5E;AAED,MAAa,cAAc;IAM1B,YAAY,QAAgB;QALlB,UAAK,GAAmB,IAAI,CAAC;QAC7B,UAAK,GAAmB,IAAI,CAAC;QAC7B,UAAK,GAAG,CAAC,CAAC;QAInB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,IAAc,IAAI;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,IAAc,IAAI,CAAC,KAAqB;QACvC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACpB,CAAC;IAED,IAAc,IAAI;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,IAAc,IAAI,CAAC,KAAqB;QACvC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,IAAc,IAAI,CAAC,KAAa;QAC/B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED,GAAG,CAAC,KAAQ;QACX,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,YAAY,GAAa,IAAI,CAAC;QAElC,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;YAClC,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC;QACxB,CAAC;aAAM,CAAC;YACP,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;QACtB,CAAC;QAED,IAAI,CAAC,KAAK,EAAE,CAAC;QAEb,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;YAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;QACd,CAAC;QAED,OAAO,YAAY,CAAC;IACrB,CAAC;IAED,OAAO;QACN,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QAC3B,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;QACzB,GAAG,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC3B,oEAAoE;YACpE,OAAO,GAAG,OAAO,CAAC,IAAK,CAAC;QACzB,CAAC,QAAQ,OAAO,KAAK,IAAI,CAAC,KAAK,EAAE;QACjC,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AA1ED,wCA0EC","sourcesContent":["class Node<T> {\n\tconstructor(public readonly value: T, public next: Node<T> | null = null) {}\n}\n\nexport class CircularBuffer<T> {\n\tprotected _head: Node<T> | null = null;\n\tprotected _tail: Node<T> | null = null;\n\tprotected _size = 0;\n\tprivate readonly _capacity: number;\n\n\tconstructor(capacity: number) {\n\t\tthis._capacity = capacity;\n\t}\n\n\tprotected get head(): Node<T> | null {\n\t\treturn this._head;\n\t}\n\n\tprotected set head(value: Node<T> | null) {\n\t\tthis._head = value;\n\t}\n\n\tprotected get tail(): Node<T> | null {\n\t\treturn this._tail;\n\t}\n\n\tprotected set tail(value: Node<T> | null) {\n\t\tthis._tail = value;\n\t}\n\n\tpublic get size(): number {\n\t\treturn this._size;\n\t}\n\n\tprotected set size(value: number) {\n\t\tthis._size = value;\n\t}\n\n\tpublic get capacity(): number {\n\t\treturn this._capacity;\n\t}\n\n\tadd(value: T): T | null {\n\t\tconst newNode = new Node(value);\n\t\tlet removedValue: T | null = null;\n\n\t\tif (this._size === 0) {\n\t\t\tthis._head = this._tail = newNode;\n\t\t\tnewNode.next = newNode;\n\t\t} else {\n\t\t\tnewNode.next = this._head;\n\t\t\tthis._tail.next = newNode;\n\t\t\tthis._tail = newNode;\n\t\t}\n\n\t\tthis._size++;\n\n\t\tif (this._size > this._capacity) {\n\t\t\tremovedValue = this._head.value;\n\t\t\tthis._head = this._head.next;\n\t\t\tthis._tail.next = this._head;\n\t\t\tthis._size--;\n\t\t}\n\n\t\treturn removedValue;\n\t}\n\n\ttoArray(): T[] {\n\t\tif (!this._head) return [];\n\t\tconst result: T[] = [];\n\t\tlet current = this._head;\n\t\tdo {\n\t\t\tresult.push(current.value);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tcurrent = current.next!;\n\t\t} while (current !== this._head);\n\t\treturn result;\n\t}\n}\n"]}

package/lib/utils/CircularBuffers/UniqueCircularBuffer.d.ts

@@ -0,0 +1,19 @@
+import { CircularBuffer } from './CircularBuffer';
+/**
+ * A circular buffer that only allows unique elements based on a key generator function.
+ * When adding an element, if its generated key already exists in the buffer, the element
+ * is not added and the add operation returns false. When the buffer is full and a new
+ * unique element is added, the oldest element is removed to make space.
+ */
+export declare class UniqueCircularBuffer<T> extends CircularBuffer<T> {
+    private uniquenessKeyGenerator;
+    private uniqueKeys;
+    constructor(capacity: number, uniquenessKeyGenerator: (value: T) => string);
+    /**
+     * Try add an element to the buffer. Returns true if the element was added, false if it was already in the buffer.
+     * @param value
+     * @returns
+     */
+    add(value: T): boolean;
+    toArray(): T[];
+}

package/lib/utils/CircularBuffers/UniqueCircularBuffer.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UniqueCircularBuffer = void 0;
+const CircularBuffer_1 = require("./CircularBuffer");
+class Node {
+    constructor(value, next = null) {
+        this.value = value;
+        this.next = next;
+    }
+}
+/**
+ * A circular buffer that only allows unique elements based on a key generator function.
+ * When adding an element, if its generated key already exists in the buffer, the element
+ * is not added and the add operation returns false. When the buffer is full and a new
+ * unique element is added, the oldest element is removed to make space.
+ */
+class UniqueCircularBuffer extends CircularBuffer_1.CircularBuffer {
+    constructor(capacity, uniquenessKeyGenerator) {
+        super(capacity);
+        this.uniquenessKeyGenerator = uniquenessKeyGenerator;
+        this.uniqueKeys = new Set();
+    }
+    /**
+     * Try add an element to the buffer. Returns true if the element was added, false if it was already in the buffer.
+     * @param value
+     * @returns
+     */
+    // @ts-expect-error :: we're reimplementing add from CircularBuffer but with a different interface. This is fine.
+    add(value) {
+        const key = this.uniquenessKeyGenerator(value);
+        if (this.uniqueKeys.has(key)) {
+            return false;
+        }
+        const newNode = new Node(value);
+        if (this.size === 0) {
+            // If the buffer is empty, set the head and tail to the new node
+            this.tail = newNode;
+            this.head = this.tail;
+            newNode.next = newNode;
+        }
+        else {
+            // Point the new node to the head
+            newNode.next = this.head;
+            // Point the current tail to the new node
+            this.tail.next = newNode;
+            // Update the tail to the new node
+            this.tail = newNode;
+        }
+        this.size++;
+        this.uniqueKeys.add(key);
+        if (this.size > this.capacity) {
+            // If the buffer is full, remove the head
+            const nodeToRemove = this.head;
+            // Update the head to the element after the head
+            this.head = this.head.next;
+            // Point the tail to the new head
+            this.tail.next = this.head;
+            this.size--;
+            const removedKey = this.uniquenessKeyGenerator(nodeToRemove.value);
+            this.uniqueKeys.delete(removedKey);
+        }
+        return true;
+    }
+    toArray() {
+        if (!this.head)
+            return [];
+        const result = [];
+        let current = this.head;
+        do {
+            result.push(current.value);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            current = current.next;
+        } while (current !== this.head);
+        return result;
+    }
+}
+exports.UniqueCircularBuffer = UniqueCircularBuffer;
+//# sourceMappingURL=UniqueCircularBuffer.js.map

package/lib/utils/CircularBuffers/UniqueCircularBuffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UniqueCircularBuffer.js","sourceRoot":"","sources":["../../../src/utils/CircularBuffers/UniqueCircularBuffer.ts"],"names":[],"mappings":";;;AAAA,qDAAkD;AAElD,MAAM,IAAI;IACT,YAAmB,KAAQ,EAAS,OAAuB,IAAI;QAA5C,UAAK,GAAL,KAAK,CAAG;QAAS,SAAI,GAAJ,IAAI,CAAuB;IAAG,CAAC;CACnE;AAED;;;;;GAKG;AACH,MAAa,oBAAwB,SAAQ,+BAAiB;IAG7D,YACC,QAAgB,EACR,sBAA4C;QAEpD,KAAK,CAAC,QAAQ,CAAC,CAAC;QAFR,2BAAsB,GAAtB,sBAAsB,CAAsB;QAJ7C,eAAU,GAAgB,IAAI,GAAG,EAAE,CAAC;IAO5C,CAAC;IAED;;;;OAIG;IACH,iHAAiH;IACjH,GAAG,CAAC,KAAQ;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;QAEhC,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACrB,gEAAgE;YAChE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;YACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;YACtB,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC;QACxB,CAAC;aAAM,CAAC;YACP,iCAAiC;YACjC,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;YACzB,yCAAyC;YACzC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;YACzB,kCAAkC;YAClC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;QACrB,CAAC;QAED,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEzB,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC/B,yCAAyC;YACzC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC;YAC/B,gDAAgD;YAChD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3B,iCAAiC;YACjC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;YAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YAEZ,MAAM,UAAU,GAAG,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO;QACN,IAAI,CAAC,IAAI,CAAC,IAAI;YAAE,OAAO,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;QACxB,GAAG,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC3B,oEAAoE;YACpE,OAAO,GAAG,OAAO,CAAC,IAAK,CAAC;QACzB,CAAC,QAAQ,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE;QAChC,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AArED,oDAqEC","sourcesContent":["import { CircularBuffer } from './CircularBuffer';\n\nclass Node<T> {\n\tconstructor(public value: T, public next: Node<T> | null = null) {}\n}\n\n/**\n * A circular buffer that only allows unique elements based on a key generator function.\n * When adding an element, if its generated key already exists in the buffer, the element\n * is not added and the add operation returns false. When the buffer is full and a new\n * unique element is added, the oldest element is removed to make space.\n */\nexport class UniqueCircularBuffer<T> extends CircularBuffer<T> {\n\tprivate uniqueKeys: Set<string> = new Set();\n\n\tconstructor(\n\t\tcapacity: number,\n\t\tprivate uniquenessKeyGenerator: (value: T) => string\n\t) {\n\t\tsuper(capacity);\n\t}\n\n\t/**\n\t * Try add an element to the buffer. Returns true if the element was added, false if it was already in the buffer.\n\t * @param value\n\t * @returns\n\t */\n\t// @ts-expect-error :: we're reimplementing add from CircularBuffer but with a different interface. This is fine.\n\tadd(value: T): boolean {\n\t\tconst key = this.uniquenessKeyGenerator(value);\n\n\t\tif (this.uniqueKeys.has(key)) {\n\t\t\treturn false;\n\t\t}\n\n\t\tconst newNode = new Node(value);\n\n\t\tif (this.size === 0) {\n\t\t\t// If the buffer is empty, set the head and tail to the new node\n\t\t\tthis.tail = newNode;\n\t\t\tthis.head = this.tail;\n\t\t\tnewNode.next = newNode;\n\t\t} else {\n\t\t\t// Point the new node to the head\n\t\t\tnewNode.next = this.head;\n\t\t\t// Point the current tail to the new node\n\t\t\tthis.tail.next = newNode;\n\t\t\t// Update the tail to the new node\n\t\t\tthis.tail = newNode;\n\t\t}\n\n\t\tthis.size++;\n\t\tthis.uniqueKeys.add(key);\n\n\t\tif (this.size > this.capacity) {\n\t\t\t// If the buffer is full, remove the head\n\t\t\tconst nodeToRemove = this.head;\n\t\t\t// Update the head to the element after the head\n\t\t\tthis.head = this.head.next;\n\t\t\t// Point the tail to the new head\n\t\t\tthis.tail.next = this.head;\n\t\t\tthis.size--;\n\n\t\t\tconst removedKey = this.uniquenessKeyGenerator(nodeToRemove.value);\n\t\t\tthis.uniqueKeys.delete(removedKey);\n\t\t}\n\n\t\treturn true;\n\t}\n\n\ttoArray(): T[] {\n\t\tif (!this.head) return [];\n\t\tconst result: T[] = [];\n\t\tlet current = this.head;\n\t\tdo {\n\t\t\tresult.push(current.value);\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-non-null-assertion\n\t\t\tcurrent = current.next!;\n\t\t} while (current !== this.head);\n\t\treturn result;\n\t}\n}\n"]}

package/lib/utils/CircularBuffers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './CircularBuffer';
+export * from './UniqueCircularBuffer';

package/lib/utils/CircularBuffers/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./CircularBuffer"), exports);
+__exportStar(require("./UniqueCircularBuffer"), exports);
+//# sourceMappingURL=index.js.map

package/lib/utils/CircularBuffers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/CircularBuffers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,yDAAuC","sourcesContent":["export * from './CircularBuffer';\nexport * from './UniqueCircularBuffer';\n"]}

package/lib/utils/MultiplexWebSocket.d.ts

@@ -0,0 +1,95 @@
+/// <reference types="ws" />
+import { Subject, Subscription } from 'rxjs';
+import WebSocket from 'isomorphic-ws';
+type WebSocketMessage<T = Record<string, unknown>> = T;
+type WebSocketSubscriptionProps<T = Record<string, unknown>> = {
+    wsUrl: string;
+    subscriptionId: string;
+    subscribeMessage: string;
+    unsubscribeMessage: string;
+    onError: (err?: any) => void;
+    onMessage: (message: WebSocketMessage<T>) => void;
+    messageFilter: (message: WebSocketMessage<T>) => boolean;
+    errorMessageFilter: (message: WebSocketMessage<T>) => boolean;
+    onClose?: () => void;
+    enableHeartbeatMonitoring?: boolean;
+};
+type WebSocketSubscriptionState<T = Record<string, unknown>> = WebSocketSubscriptionProps<T> & {
+    hasSentSubscribeMessage?: boolean;
+    subjectSubscription?: Subscription;
+};
+type WebSocketUrl = string;
+type SubscriptionId = string;
+declare enum WebSocketConnectionState {
+    CONNECTING = 0,
+    CONNECTED = 1,
+    DISCONNECTING = 2,
+    DISCONNECTED = 3
+}
+type IMultiplexWebSocket<T = Record<string, unknown>> = {
+    wsUrl: WebSocketUrl;
+    webSocket: WebSocket;
+    customConnectionState: WebSocketConnectionState;
+    subject: Subject<WebSocketMessage<T>>;
+    subscriptions: Map<SubscriptionId, Omit<WebSocketSubscriptionProps<T>, 'wsUrl' | 'subscriptionId'>>;
+};
+/**
+ * MultiplexWebSocket allows for multiple subscriptions to a single websocket of the same URL, improving efficiency and reducing the number of open connections.
+ *
+ * This implementation assumes the following:
+ * - All websocket streams are treated equally - reconnection attempts are performed at the same standards
+ * - All messages returned are in the `WebSocketMessage` format
+ * - A single instance of the websocket manager is created for each websocket URL - this means all subscriptions to the same websocket URL will share the same websocket instance
+ *
+ * Internal implementation details:
+ * - The websocket is closed when the number of subscriptions is 0
+ * - The websocket will be refreshed (new instance) when it disconnects unexpectedly or errors, until it reaches the maximum number of reconnect attempts
+ */
+export declare class MultiplexWebSocket<T = Record<string, unknown>> implements IMultiplexWebSocket<T> {
+    #private;
+    /**
+     * A lookup of all websockets by their URL.
+     */
+    private static URL_TO_WEBSOCKETS_LOOKUP;
+    /**
+     * A lookup from websocket URL to all subscription IDs for that URL.
+     */
+    private static URL_TO_SUBSCRIPTION_IDS_LOOKUP;
+    wsUrl: WebSocketUrl;
+    customConnectionState: WebSocketConnectionState;
+    subject: Subject<WebSocketMessage<T>>;
+    subscriptions: Map<SubscriptionId, Omit<WebSocketSubscriptionState<T>, 'wsUrl' | 'subscriptionId'>>;
+    private reconnectionManager;
+    private closeTimeout;
+    private heartbeatTimeout;
+    private heartbeatMonitoringEnabled;
+    private constructor();
+    /**
+     * Creates a new virtual websocket subscription. If an existing websocket for the given URL exists, the subscription will be added to the existing websocket.
+     * Returns a function that can be called to unsubscribe from the subscription.
+     */
+    static createWebSocketSubscription<T = Record<string, unknown>>(props: WebSocketSubscriptionProps<T>): {
+        unsubscribe: () => void;
+    };
+    private static handleNewSubForNewWsUrl;
+    private static handleNewSubForExistingWsUrl;
+    get webSocket(): WebSocket;
+    /**
+     * Setting the WebSocket instance will automatically add event handlers to the WebSocket instance.
+     * When the WebSocket is connected, all existing subscriptions will be subscribed to.
+     */
+    set webSocket(webSocket: WebSocket);
+    private subscribeToWebSocket;
+    private subscribe;
+    private unsubscribe;
+    private scheduleDelayedClose;
+    private cancelDelayedClose;
+    private close;
+    private startHeartbeatMonitoring;
+    private stopHeartbeatMonitoring;
+    private resetHeartbeatTimeout;
+    private isHeartbeatMessage;
+    private handleHeartbeat;
+    private refreshWebSocket;
+}
+export {};