@pimlico/alto 0.0.18 → 0.0.20

package/esm/handlers/eventManager.js

@@ -1,32 +1,71 @@
-import * as sentry from "@sentry/node";
-import Redis from "ioredis";
+import { asyncCallWithTimeout } from "../utils/index.js";
 import Queue from "bull";
+import Redis from "ioredis";
 export class EventManager {
     chainId;
     logger;
-    metrics;
     redisEventManagerQueue;
-    constructor({ config, metrics }) {
+    eventBuffer = [];
+    flushTimer;
+    constructor({ config }) {
         this.chainId = config.chainId;
+        const flushInterval = config.redisEventsQueueFlushInterval;
         this.logger = config.getLogger({ module: "event_manager" }, {
             level: config.logLevel
         });
-        this.metrics = metrics;
-        if (config.redisQueueEndpoint && config.redisEventManagerQueueName) {
-            this.logger.info(`Using redis with queue name ${config.redisEventManagerQueueName} for userOp event queue`);
-            const redis = new Redis(config.redisQueueEndpoint);
-            this.redisEventManagerQueue = new Queue(config.redisEventManagerQueueName, {
+        if (config.redisEventsQueueEndpoint && config.redisEventsQueueName) {
+            const queueName = config.redisEventsQueueName;
+            this.logger.info(`Using redis with queue name ${queueName} for userOp event queue (flush interval: ${flushInterval}ms)`);
+            const redis = new Redis(config.redisEventsQueueEndpoint);
+            this.redisEventManagerQueue = new Queue(queueName, {
                 createClient: () => {
                     return redis;
+                },
+                defaultJobOptions: {
+                    attempts: 3,
+                    backoff: {
+                        type: "fixed",
+                        delay: 30000
+                    },
+                    removeOnComplete: true,
+                    removeOnFail: true
                 }
             });
+            this.startFlushTimer(flushInterval);
+        }
+    }
+    startFlushTimer(flushInterval) {
+        // Don't start flush timer if redis is not configured.
+        if (!this.redisEventManagerQueue) {
             return;
         }
+        this.flushTimer = setInterval(() => {
+            this.flushEvents();
+        }, flushInterval);
+        // Allow process to exit even if interval is active.
+        if (this.flushTimer.unref) {
+            this.flushTimer.unref();
+        }
+    }
+    flushEvents() {
+        if (!this.redisEventManagerQueue || this.eventBuffer.length === 0) {
+            return;
+        }
+        const eventsToFlush = this.eventBuffer.splice(0);
+        const eventCount = eventsToFlush.length;
+        // Fire and forget - don't block the timer
+        asyncCallWithTimeout(this.redisEventManagerQueue.addBulk(eventsToFlush.map((entry) => ({
+            data: entry,
+            opts: { removeOnFail: true, removeOnComplete: true }
+        }))), 500 // 500ms timeout
+        ).catch((err) => {
+            this.logger.error({ err, eventCount }, "Failed to flush events to Redis");
+        });
     }
     // emits when the userOperation was mined onchain but reverted during the callphase
-    async emitExecutionRevertedOnChain(userOperationHash, transactionHash, reason, blockNumber) {
-        await this.emitEvent({
-            userOperationHash,
+    emitExecutionRevertedOnChain(userOpHash, transactionHash, reason, blockNumber) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "execution_reverted_onchain",
                 transactionHash,
@@ -38,9 +77,9 @@ export class EventManager {
         });
     }
     // emits when the userOperation was mined onchain but failed EntryPoint validation
-    async emitFailedOnChain(userOperationHash, transactionHash, blockNumber) {
-        await this.emitEvent({
-            userOperationHash,
+    emitFailedOnChain(userOpHash, transactionHash, blockNumber) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "failed_onchain",
                 transactionHash,
@@ -51,9 +90,9 @@ export class EventManager {
         });
     }
     // emits when the userOperation has been included onchain but bundled by a frontrunner
-    async emitFrontranOnChain(userOperationHash, transactionHash, blockNumber) {
-        await this.emitEvent({
-            userOperationHash,
+    emitFrontranOnChain(userOpHash, transactionHash, blockNumber) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "frontran_onchain",
                 transactionHash,
@@ -64,9 +103,9 @@ export class EventManager {
         });
     }
     // emits when the userOperation is included onchain
-    async emitIncludedOnChain(userOperationHash, transactionHash, blockNumber) {
-        await this.emitEvent({
-            userOperationHash,
+    emitIncludedOnChain(userOpHash, transactionHash, blockNumber) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "included_onchain",
                 transactionHash,
@@ -77,18 +116,18 @@ export class EventManager {
         });
     }
     // emits when the userOperation is placed in the nonce queue
-    async emitQueued(userOperationHash) {
-        await this.emitEvent({
-            userOperationHash,
+    emitQueued(userOpHash) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "queued"
             }
         });
     }
     // emits when the userOperation is first seen
-    async emitReceived(userOperationHash, timestamp) {
-        await this.emitEvent({
-            userOperationHash,
+    emitReceived(userOpHash, timestamp) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "received"
             },
@@ -96,9 +135,9 @@ export class EventManager {
         });
     }
     // emits when the userOperation failed to get added to the mempool
-    async emitFailedValidation(userOperationHash, reason, aaError) {
-        await this.emitEvent({
-            userOperationHash,
+    emitFailedValidation(userOpHash, reason, aaError) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "failed_validation",
                 data: {
@@ -109,10 +148,10 @@ export class EventManager {
         });
     }
     // emits when the userOperation has been submitted to the network
-    async emitSubmitted({ userOpHashes, transactionHash }) {
+    emitSubmitted({ userOpHashes, transactionHash }) {
         for (const hash of userOpHashes) {
-            await this.emitEvent({
-                userOperationHash: hash,
+            this.queueEvent({
+                userOpHash: hash,
                 event: {
                     eventType: "submitted",
                     transactionHash
@@ -121,9 +160,9 @@ export class EventManager {
         }
     }
     // emits when the userOperation was dropped from the internal mempool
-    async emitDropped(userOperationHash, reason, aaError) {
-        await this.emitEvent({
-            userOperationHash,
+    emitDropped(userOpHash, reason, aaError) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "dropped",
                 data: {
@@ -134,44 +173,25 @@ export class EventManager {
         });
     }
     // emits when the userOperation was added to the internal mempool
-    async emitAddedToMempool(userOperationHash) {
-        await this.emitEvent({
-            userOperationHash,
+    emitAddedToMempool(userOpHash) {
+        this.queueEvent({
+            userOpHash,
             event: {
                 eventType: "added_to_mempool"
             }
         });
     }
-    async emitEvent({ userOperationHash, event, timestamp }) {
+    queueEvent({ userOpHash, event, timestamp }) {
         if (!this.redisEventManagerQueue) {
             return;
         }
         const entry = {
-            userOperationHash,
+            userOperationHash: userOpHash,
             eventTimestamp: timestamp ?? Date.now(),
             chainId: this.chainId,
             ...event
         };
-        // log to redis here
-        let jobStatus;
-        try {
-            await this.redisEventManagerQueue.add(entry, {
-                removeOnComplete: true,
-                removeOnFail: true
-            });
-            jobStatus = "success";
-        }
-        catch (err) {
-            this.logger.error({ err }, "Failed to send userOperation status event");
-            sentry.captureException(err);
-            jobStatus = "failed";
-        }
-        this.metrics.emittedOpEvents
-            .labels({
-            event_type: event.eventType,
-            status: jobStatus
-        })
-            .inc();
+        this.eventBuffer.push(entry);
     }
 }
 //# sourceMappingURL=eventManager.js.map

package/esm/handlers/eventManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"eventManager.js","sourceRoot":"","sources":["../../handlers/eventManager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,MAAM,SAAS,CAAA;AAI3B,OAAO,KAAkC,MAAM,MAAM,CAAA;AAQrD,MAAM,OAAO,YAAY;IACb,OAAO,CAAQ;IACf,MAAM,CAAQ;IACd,OAAO,CAAS;IAChB,sBAAsB,CAA0B;IAExD,YAAY,EACR,MAAM,EACN,OAAO,EAIV;QACG,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAE7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAC1B,EAAE,MAAM,EAAE,eAAe,EAAE,EAC3B;YACI,KAAK,EAAE,MAAM,CAAC,QAAQ;SACzB,CACJ,CAAA;QACD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QAEtB,IAAI,MAAM,CAAC,kBAAkB,IAAI,MAAM,CAAC,0BAA0B,EAAE,CAAC;YACjE,IAAI,CAAC,MAAM,CAAC,IAAI,CACZ,+BAA+B,MAAM,CAAC,0BAA0B,yBAAyB,CAC5F,CAAA;YACD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAA;YAElD,IAAI,CAAC,sBAAsB,GAAG,IAAI,KAAK,CACnC,MAAM,CAAC,0BAA0B,EACjC;gBACI,YAAY,EAAE,GAAG,EAAE;oBACf,OAAO,KAAK,CAAA;gBAChB,CAAC;aACJ,CACJ,CAAA;YACD,OAAM;QACV,CAAC;IACL,CAAC;IAED,mFAAmF;IACnF,KAAK,CAAC,4BAA4B,CAC9B,iBAAsB,EACtB,eAAoB,EACpB,MAAW,EACX,WAAmB;QAEnB,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,4BAA4B;gBACvC,eAAe;gBACf,IAAI,EAAE;oBACF,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;oBAChC,MAAM;iBACT;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,kFAAkF;IAClF,KAAK,CAAC,iBAAiB,CACnB,iBAAsB,EACtB,eAAoB,EACpB,WAAmB;QAEnB,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,gBAAgB;gBAC3B,eAAe;gBACf,IAAI,EAAE;oBACF,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;iBACnC;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,sFAAsF;IACtF,KAAK,CAAC,mBAAmB,CACrB,iBAAsB,EACtB,eAAoB,EACpB,WAAmB;QAEnB,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,kBAAkB;gBAC7B,eAAe;gBACf,IAAI,EAAE;oBACF,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;iBACnC;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,mBAAmB,CACrB,iBAAsB,EACtB,eAAoB,EACpB,WAAmB;QAEnB,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,kBAAkB;gBAC7B,eAAe;gBACf,IAAI,EAAE;oBACF,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;iBACnC;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,UAAU,CAAC,iBAAsB;QACnC,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,QAAQ;aACtB;SACJ,CAAC,CAAA;IACN,CAAC;IAED,6CAA6C;IAC7C,KAAK,CAAC,YAAY,CAAC,iBAAsB,EAAE,SAAkB;QACzD,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,UAAU;aACxB;YACD,SAAS;SACZ,CAAC,CAAA;IACN,CAAC;IAED,kEAAkE;IAClE,KAAK,CAAC,oBAAoB,CACtB,iBAAsB,EACtB,MAAe,EACf,OAAgB;QAEhB,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,mBAAmB;gBAC9B,IAAI,EAAE;oBACF,MAAM;oBACN,OAAO;iBACV;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,aAAa,CAAC,EAChB,YAAY,EACZ,eAAe,EAC6B;QAC5C,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAC,SAAS,CAAC;gBACjB,iBAAiB,EAAE,IAAI;gBACvB,KAAK,EAAE;oBACH,SAAS,EAAE,WAAW;oBACtB,eAAe;iBAClB;aACJ,CAAC,CAAA;QACN,CAAC;IACL,CAAC;IAED,qEAAqE;IACrE,KAAK,CAAC,WAAW,CACb,iBAAsB,EACtB,MAAe,EACf,OAAgB;QAEhB,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,SAAS;gBACpB,IAAI,EAAE;oBACF,MAAM;oBACN,OAAO;iBACV;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,iEAAiE;IACjE,KAAK,CAAC,kBAAkB,CAAC,iBAAsB;QAC3C,MAAM,IAAI,CAAC,SAAS,CAAC;YACjB,iBAAiB;YACjB,KAAK,EAAE;gBACH,SAAS,EAAE,kBAAkB;aAChC;SACJ,CAAC,CAAA;IACN,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,EACpB,iBAAiB,EACjB,KAAK,EACL,SAAS,EAKZ;QACG,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC/B,OAAM;QACV,CAAC;QAED,MAAM,KAAK,GAAG;YACV,iBAAiB;YACjB,cAAc,EAAE,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE;YACvC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,KAAK;SACX,CAAA;QAED,oBAAoB;QACpB,IAAI,SAAiB,CAAA;QACrB,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE;gBACzC,gBAAgB,EAAE,IAAI;gBACtB,YAAY,EAAE,IAAI;aACrB,CAAC,CAAA;YACF,SAAS,GAAG,SAAS,CAAA;QACzB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,EAAE,GAAG,EAAE,EACP,2CAA2C,CAC9C,CAAA;YACD,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAA;YAC5B,SAAS,GAAG,QAAQ,CAAA;QACxB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,eAAe;aACvB,MAAM,CAAC;YACJ,UAAU,EAAE,KAAK,CAAC,SAAS;YAC3B,MAAM,EAAE,SAAS;SACpB,CAAC;aACD,GAAG,EAAE,CAAA;IACd,CAAC;CACJ"}
+{"version":3,"file":"eventManager.js","sourceRoot":"","sources":["../../handlers/eventManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAC/D,OAAO,KAAkC,MAAM,MAAM,CAAA;AACrD,OAAO,KAAK,MAAM,SAAS,CAAA;AAW3B,MAAM,OAAO,YAAY;IACJ,OAAO,CAAQ;IACf,MAAM,CAAQ;IACd,sBAAsB,CAA0B;IAChD,WAAW,GAAmB,EAAE,CAAA;IACzC,UAAU,CAAiB;IAEnC,YAAY,EACR,MAAM,EAGT;QACG,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;QAC7B,MAAM,aAAa,GAAG,MAAM,CAAC,6BAA6B,CAAA;QAE1D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,SAAS,CAC1B,EAAE,MAAM,EAAE,eAAe,EAAE,EAC3B;YACI,KAAK,EAAE,MAAM,CAAC,QAAQ;SACzB,CACJ,CAAA;QAED,IAAI,MAAM,CAAC,wBAAwB,IAAI,MAAM,CAAC,oBAAoB,EAAE,CAAC;YACjE,MAAM,SAAS,GAAG,MAAM,CAAC,oBAAoB,CAAA;YAC7C,IAAI,CAAC,MAAM,CAAC,IAAI,CACZ,+BAA+B,SAAS,4CAA4C,aAAa,KAAK,CACzG,CAAA;YACD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAA;YAExD,IAAI,CAAC,sBAAsB,GAAG,IAAI,KAAK,CAAe,SAAS,EAAE;gBAC7D,YAAY,EAAE,GAAG,EAAE;oBACf,OAAO,KAAK,CAAA;gBAChB,CAAC;gBACD,iBAAiB,EAAE;oBACf,QAAQ,EAAE,CAAC;oBACX,OAAO,EAAE;wBACL,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,KAAK;qBACf;oBACD,gBAAgB,EAAE,IAAI;oBACtB,YAAY,EAAE,IAAI;iBACrB;aACJ,CAAC,CAAA;YAEF,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAA;QACvC,CAAC;IACL,CAAC;IAEO,eAAe,CAAC,aAAqB;QACzC,sDAAsD;QACtD,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC/B,OAAM;QACV,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE;YAC/B,IAAI,CAAC,WAAW,EAAE,CAAA;QACtB,CAAC,EAAE,aAAa,CAAC,CAAA;QAEjB,oDAAoD;QACpD,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACxB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;QAC3B,CAAC;IACL,CAAC;IAEO,WAAW;QACf,IAAI,CAAC,IAAI,CAAC,sBAAsB,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChE,OAAM;QACV,CAAC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QAChD,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAA;QAEvC,0CAA0C;QAC1C,oBAAoB,CAChB,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAC/B,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC1B,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE;SACvD,CAAC,CAAC,CACN,EACD,GAAG,CAAC,gBAAgB;SACvB,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CACb,EAAE,GAAG,EAAE,UAAU,EAAE,EACnB,iCAAiC,CACpC,CAAA;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,mFAAmF;IACnF,4BAA4B,CACxB,UAAe,EACf,eAAoB,EACpB,MAAW,EACX,WAAmB;QAEnB,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,4BAA4B;gBACvC,eAAe;gBACf,IAAI,EAAE;oBACF,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;oBAChC,MAAM;iBACT;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,kFAAkF;IAClF,iBAAiB,CACb,UAAe,EACf,eAAoB,EACpB,WAAmB;QAEnB,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,gBAAgB;gBAC3B,eAAe;gBACf,IAAI,EAAE;oBACF,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;iBACnC;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,sFAAsF;IACtF,mBAAmB,CACf,UAAe,EACf,eAAoB,EACpB,WAAmB;QAEnB,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,kBAAkB;gBAC7B,eAAe;gBACf,IAAI,EAAE;oBACF,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;iBACnC;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,mDAAmD;IACnD,mBAAmB,CACf,UAAe,EACf,eAAoB,EACpB,WAAmB;QAEnB,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,kBAAkB;gBAC7B,eAAe;gBACf,IAAI,EAAE;oBACF,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC;iBACnC;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,4DAA4D;IAC5D,UAAU,CAAC,UAAe;QACtB,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,QAAQ;aACtB;SACJ,CAAC,CAAA;IACN,CAAC;IAED,6CAA6C;IAC7C,YAAY,CAAC,UAAe,EAAE,SAAkB;QAC5C,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,UAAU;aACxB;YACD,SAAS;SACZ,CAAC,CAAA;IACN,CAAC;IAED,kEAAkE;IAClE,oBAAoB,CAAC,UAAe,EAAE,MAAe,EAAE,OAAgB;QACnE,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,mBAAmB;gBAC9B,IAAI,EAAE;oBACF,MAAM;oBACN,OAAO;iBACV;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,iEAAiE;IACjE,aAAa,CAAC,EACV,YAAY,EACZ,eAAe,EAC6B;QAC5C,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;YAC9B,IAAI,CAAC,UAAU,CAAC;gBACZ,UAAU,EAAE,IAAI;gBAChB,KAAK,EAAE;oBACH,SAAS,EAAE,WAAW;oBACtB,eAAe;iBAClB;aACJ,CAAC,CAAA;QACN,CAAC;IACL,CAAC;IAED,qEAAqE;IACrE,WAAW,CAAC,UAAe,EAAE,MAAe,EAAE,OAAgB;QAC1D,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,SAAS;gBACpB,IAAI,EAAE;oBACF,MAAM;oBACN,OAAO;iBACV;aACJ;SACJ,CAAC,CAAA;IACN,CAAC;IAED,iEAAiE;IACjE,kBAAkB,CAAC,UAAe;QAC9B,IAAI,CAAC,UAAU,CAAC;YACZ,UAAU;YACV,KAAK,EAAE;gBACH,SAAS,EAAE,kBAAkB;aAChC;SACJ,CAAC,CAAA;IACN,CAAC;IAEO,UAAU,CAAC,EACf,UAAU,EACV,KAAK,EACL,SAAS,EAKZ;QACG,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAC/B,OAAM;QACV,CAAC;QAED,MAAM,KAAK,GAAiB;YACxB,iBAAiB,EAAE,UAAU;YAC7B,cAAc,EAAE,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE;YACvC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,KAAK;SACX,CAAA;QAED,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;CACJ"}

package/esm/handlers/gasPriceManager.d.ts

@@ -5,23 +5,22 @@ import { MantleManager } from "./mantleGasPriceManager.js";
 import { OptimismManager } from "./optimismManager.js";
 export declare class GasPriceManager {
     private readonly config;
-    private baseFeePerGasQueue;
-    private maxFeePerGasQueue;
-    private maxPriorityFeePerGasQueue;
-    private logger;
-    arbitrumManager: ArbitrumManager;
-    mantleManager: MantleManager;
-    optimismManager: OptimismManager;
+    private readonly baseFeePerGasQueue;
+    private readonly maxFeePerGasQueue;
+    private readonly maxPriorityFeePerGasQueue;
+    private readonly logger;
+    readonly arbitrumManager: ArbitrumManager;
+    readonly mantleManager: MantleManager;
+    readonly optimismManager: OptimismManager;
     constructor(config: AltoConfig);
     init(): Promise<void>;
-    private getDefaultGasFee;
     private getPolygonGasPriceParameters;
     private bumpTheGasPrice;
     private getFallBackMaxPriorityFeePerGas;
     private getLegacyTransactionGasPrice;
     private estimateGasPrice;
     private innerGetGasPrice;
-    private updateBaseFee;
+    private tryUpdateBaseFee;
     getBaseFee(): Promise<bigint>;
     private tryUpdateGasPrice;
     getGasPrice(): Promise<GasPriceParameters>;
@@ -31,6 +30,9 @@ export declare class GasPriceManager {
     getHighestMaxPriorityFeePerGas(): Promise<bigint>;
     private getMinMaxFeePerGas;
     private getMinMaxPriorityFeePerGas;
-    validateGasPrice(gasPrice: GasPriceParameters): Promise<void>;
+    getLowestValidGasPrices(): Promise<{
+        lowestMaxFeePerGas: bigint;
+        lowestMaxPriorityFeePerGas: bigint;
+    }>;
 }
 //# sourceMappingURL=gasPriceManager.d.ts.map

package/esm/handlers/gasPriceManager.js

@@ -1,30 +1,11 @@
 import { RpcError, gasStationResult } from "../types/index.js";
-import { maxBigInt, minBigInt } from "../utils/index.js";
+import { maxBigInt, minBigInt, scaleBigIntByPercent } from "../utils/index.js";
 import * as sentry from "@sentry/node";
-import { parseGwei } from "viem";
-import { avalanche, celo, celoAlfajores, dfk, polygon, polygonMumbai } from "viem/chains";
+import { polygon } from "viem/chains";
 import { createMinMaxQueue } from "../utils/minMaxQueue/index.js";
 import { ArbitrumManager } from "./arbitrumGasPriceManager.js";
 import { MantleManager } from "./mantleGasPriceManager.js";
 import { OptimismManager } from "./optimismManager.js";
-var ChainId;
-(function (ChainId) {
-    ChainId[ChainId["Goerli"] = 5] = "Goerli";
-    ChainId[ChainId["Polygon"] = 137] = "Polygon";
-    ChainId[ChainId["Mumbai"] = 80001] = "Mumbai";
-    ChainId[ChainId["LineaTestnet"] = 59140] = "LineaTestnet";
-    ChainId[ChainId["Linea"] = 59144] = "Linea";
-})(ChainId || (ChainId = {}));
-const MIN_POLYGON_GAS_PRICE = parseGwei("31");
-const MIN_MUMBAI_GAS_PRICE = parseGwei("1");
-function getGasStationUrl(chainId) {
-    switch (chainId) {
-        case ChainId.Polygon:
-            return "https://gasstation.polygon.technology/v2";
-        case ChainId.Mumbai:
-            return "https://gasstation-testnet.polygon.technology/v2";
-    }
-}
 export class GasPriceManager {
     config;
     baseFeePerGasQueue;
@@ -41,24 +22,24 @@ export class GasPriceManager {
         });
         this.baseFeePerGasQueue = createMinMaxQueue({
             config,
-            keyPrefix: "base-fee-per-gas-queue"
+            queueName: "base-fee-per-gas-queue"
         });
         this.maxFeePerGasQueue = createMinMaxQueue({
             config,
-            keyPrefix: "max-fee-per-gas-queue"
+            queueName: "max-fee-per-gas-queue"
         });
         this.maxPriorityFeePerGasQueue = createMinMaxQueue({
             config,
-            keyPrefix: "max-priority-fee-per-gas-queue"
+            queueName: "max-priority-fee-per-gas-queue"
         });
         // Periodically update gas prices if specified
         if (this.config.gasPriceRefreshInterval > 0) {
-            setInterval(() => {
+            setInterval(async () => {
                 try {
                     if (this.config.legacyTransactions === false) {
-                        this.updateBaseFee();
+                        await this.tryUpdateBaseFee();
                     }
-                    this.tryUpdateGasPrice();
+                    await this.tryUpdateGasPrice();
                 }
                 catch (error) {
                     this.logger.error({ error }, "Error updating gas prices in interval");
@@ -75,26 +56,16 @@ export class GasPriceManager {
             await Promise.all([
                 this.tryUpdateGasPrice(),
                 this.config.legacyTransactions === false
-                    ? this.updateBaseFee()
+                    ? this.tryUpdateBaseFee()
                     : Promise.resolve()
             ]);
         }
-        catch (error) {
-            this.logger.error(error, "Error during gas price initialization");
-        }
-    }
-    getDefaultGasFee(chainId) {
-        switch (chainId) {
-            case ChainId.Polygon:
-                return MIN_POLYGON_GAS_PRICE;
-            case ChainId.Mumbai:
-                return MIN_MUMBAI_GAS_PRICE;
-            default:
-                return 0n;
+        catch (err) {
+            this.logger.error({ err }, "Error during gas price initialization");
         }
     }
     async getPolygonGasPriceParameters() {
-        const gasStationUrl = getGasStationUrl(this.config.chainId);
+        const gasStationUrl = "https://gasstation.polygon.technology/v2";
         try {
             const data = await (await fetch(gasStationUrl)).json();
             // take the standard speed here, SDK options will define the extra tip
@@ -107,39 +78,25 @@ export class GasPriceManager {
         }
     }
     bumpTheGasPrice(gasPriceParameters) {
-        const bumpAmount = this.config.gasPriceBump;
-        const maxPriorityFeePerGas = maxBigInt(gasPriceParameters.maxPriorityFeePerGas, this.getDefaultGasFee(this.config.chainId));
-        const maxFeePerGas = maxBigInt(gasPriceParameters.maxFeePerGas, maxPriorityFeePerGas);
-        const result = {
-            maxFeePerGas: (maxFeePerGas * bumpAmount) / 100n,
-            maxPriorityFeePerGas: (maxPriorityFeePerGas * bumpAmount) / 100n
-        };
-        if (this.config.chainId === celo.id ||
-            this.config.chainId === celoAlfajores.id) {
-            const maxFee = maxBigInt(result.maxFeePerGas, result.maxPriorityFeePerGas);
-            return {
-                maxFeePerGas: maxFee,
-                maxPriorityFeePerGas: maxFee
-            };
-        }
-        if (this.config.chainId == dfk.id) {
-            const maxFeePerGas = maxBigInt(5000000000n, result.maxFeePerGas);
-            const maxPriorityFeePerGas = maxBigInt(5000000000n, result.maxPriorityFeePerGas);
-            return {
-                maxFeePerGas,
-                maxPriorityFeePerGas
-            };
+        let [maxFeePerGas, maxPriorityFeePerGas] = [
+            gasPriceParameters.maxFeePerGas,
+            gasPriceParameters.maxPriorityFeePerGas
+        ];
+        // Apply bump percentage
+        maxPriorityFeePerGas = scaleBigIntByPercent(maxPriorityFeePerGas, this.config.gasPriceBump);
+        maxFeePerGas = scaleBigIntByPercent(maxFeePerGas, this.config.gasPriceBump);
+        // Apply floor values if configured
+        if (this.config.floorMaxPriorityFeePerGas) {
+            maxPriorityFeePerGas = maxBigInt(this.config.floorMaxPriorityFeePerGas, maxPriorityFeePerGas);
+        }
+        if (this.config.floorMaxFeePerGas) {
+            maxFeePerGas = maxBigInt(this.config.floorMaxFeePerGas, maxFeePerGas);
         }
-        // set a minimum maxPriorityFee & maxFee to 1.5gwei on avalanche (because eth_maxPriorityFeePerGas returns 0)
-        if (this.config.chainId == avalanche.id) {
-            const maxFeePerGas = maxBigInt(parseGwei("1.5"), result.maxFeePerGas);
-            const maxPriorityFeePerGas = maxBigInt(parseGwei("1.5"), result.maxPriorityFeePerGas);
-            return {
-                maxFeePerGas,
-                maxPriorityFeePerGas
-            };
-        }
-        return result;
+        return {
+            // Ensure that maxFeePerGas is always greater or equal than maxPriorityFeePerGas
+            maxFeePerGas: maxBigInt(maxFeePerGas, maxPriorityFeePerGas),
+            maxPriorityFeePerGas
+        };
     }
     async getFallBackMaxPriorityFeePerGas(publicClient, gasPrice) {
         const feeHistory = await publicClient.getFeeHistory({
@@ -164,7 +121,7 @@ export class GasPriceManager {
         }
         catch (e) {
             sentry.captureException(e);
-            this.logger.error("failed to fetch legacy gasPrices from estimateFeesPerGas", { error: e });
+            this.logger.error({ error: e }, "failed to fetch legacy gasPrices from estimateFeesPerGas");
             gasPrice = undefined;
         }
         if (gasPrice === undefined) {
@@ -186,16 +143,28 @@ export class GasPriceManager {
     async estimateGasPrice() {
         let maxFeePerGas;
         let maxPriorityFeePerGas;
+        const { publicClient, staticMaxPriorityFeePerGas } = this.config;
         try {
-            const fees = await this.config.publicClient.estimateFeesPerGas({
-                chain: this.config.publicClient.chain
+            let chain;
+            // If staticMaxPriorityFeePerGas is set, use it as a static value instead of RPC estimation.
+            if (staticMaxPriorityFeePerGas) {
+                chain = {
+                    ...publicClient.chain,
+                    fees: {
+                        ...publicClient.chain.fees,
+                        maxPriorityFeePerGas: staticMaxPriorityFeePerGas
+                    }
+                };
+            }
+            const fees = await publicClient.estimateFeesPerGas({
+                chain
             });
             maxFeePerGas = fees.maxFeePerGas;
             maxPriorityFeePerGas = fees.maxPriorityFeePerGas;
         }
         catch (e) {
             sentry.captureException(e);
-            this.logger.error("failed to fetch eip-1559 gasPrices from estimateFeesPerGas", { error: e });
+            this.logger.error({ error: e }, "failed to fetch eip-1559 gasPrices from estimateFeesPerGas");
             maxFeePerGas = undefined;
             maxPriorityFeePerGas = undefined;
         }
@@ -203,7 +172,7 @@ export class GasPriceManager {
             this.logger.warn("maxPriorityFeePerGas is undefined, using fallback value");
             try {
                 maxPriorityFeePerGas =
-                    await this.getFallBackMaxPriorityFeePerGas(this.config.publicClient, maxFeePerGas ?? 0n);
+                    await this.getFallBackMaxPriorityFeePerGas(publicClient, maxFeePerGas ?? 0n);
             }
             catch (e) {
                 this.logger.error("failed to get fallback maxPriorityFeePerGas");
@@ -215,8 +184,7 @@ export class GasPriceManager {
             this.logger.warn("maxFeePerGas is undefined, using fallback value");
             try {
                 maxFeePerGas =
-                    (await this.config.publicClient.getGasPrice()) +
-                        maxPriorityFeePerGas;
+                    (await publicClient.getGasPrice()) + maxPriorityFeePerGas;
             }
             catch (e) {
                 this.logger.error("failed to get fallback maxFeePerGas");
@@ -231,42 +199,21 @@ export class GasPriceManager {
     }
     // This method throws if it can't get a valid RPC response.
     async innerGetGasPrice() {
-        let maxFeePerGas = 0n;
-        let maxPriorityFeePerGas = 0n;
-        if (this.config.chainId === polygon.id ||
-            this.config.chainId === polygonMumbai.id) {
+        if (this.config.chainId === polygon.id) {
             const polygonEstimate = await this.getPolygonGasPriceParameters();
             if (polygonEstimate) {
-                const gasPrice = this.bumpTheGasPrice({
-                    maxFeePerGas: polygonEstimate.maxFeePerGas,
-                    maxPriorityFeePerGas: polygonEstimate.maxPriorityFeePerGas
-                });
-                return {
-                    maxFeePerGas: maxBigInt(gasPrice.maxFeePerGas, maxFeePerGas),
-                    maxPriorityFeePerGas: maxBigInt(gasPrice.maxPriorityFeePerGas, maxPriorityFeePerGas)
-                };
+                return this.bumpTheGasPrice(polygonEstimate);
             }
         }
         if (this.config.legacyTransactions) {
-            const gasPrice = this.bumpTheGasPrice(await this.getLegacyTransactionGasPrice());
-            return {
-                maxFeePerGas: maxBigInt(gasPrice.maxFeePerGas, maxFeePerGas),
-                maxPriorityFeePerGas: maxBigInt(gasPrice.maxPriorityFeePerGas, maxPriorityFeePerGas)
-            };
+            const legacyGasPrice = await this.getLegacyTransactionGasPrice();
+            return this.bumpTheGasPrice(legacyGasPrice);
         }
-        const estimatedPrice = await this.estimateGasPrice();
-        maxFeePerGas = estimatedPrice.maxFeePerGas;
-        maxPriorityFeePerGas = estimatedPrice.maxPriorityFeePerGas;
-        const gasPrice = this.bumpTheGasPrice({
-            maxFeePerGas,
-            maxPriorityFeePerGas
-        });
-        return {
-            maxFeePerGas: maxBigInt(gasPrice.maxFeePerGas, maxFeePerGas),
-            maxPriorityFeePerGas: maxBigInt(gasPrice.maxPriorityFeePerGas, maxPriorityFeePerGas)
-        };
+        const estimatedGasPrice = await this.estimateGasPrice();
+        return this.bumpTheGasPrice(estimatedGasPrice);
     }
-    async updateBaseFee() {
+    // This method throws if it can't get a valid RPC response.
+    async tryUpdateBaseFee() {
         try {
             const latestBlock = await this.config.publicClient.getBlock();
             if (latestBlock.baseFeePerGas === null) {
@@ -278,26 +225,29 @@ export class GasPriceManager {
         }
         catch (e) {
             this.logger.error(e, "Failed to update base fee");
+            sentry.captureException(e);
             throw e;
         }
     }
     async getBaseFee() {
         try {
             if (this.config.legacyTransactions) {
-                throw new RpcError("baseFee is not available for legacy transactions");
+                return 0n;
             }
             if (this.config.gasPriceRefreshInterval === 0) {
-                return await this.updateBaseFee();
+                return await this.tryUpdateBaseFee();
             }
             let baseFee = await this.baseFeePerGasQueue.getLatestValue();
             if (!baseFee) {
-                baseFee = await this.updateBaseFee();
+                baseFee = await this.tryUpdateBaseFee();
             }
             return baseFee;
         }
         catch (e) {
-            this.logger.error(e, "Failed to get base fee");
-            throw new RpcError("Failed to get base fee");
+            this.logger.error(e, "Failed to get base fee, returning 0n");
+            // Save 0n to the queue for the missing baseFee case
+            this.baseFeePerGasQueue.saveValue(0n);
+            return 0n;
         }
     }
     // This method throws if it can't get a valid RPC response.
@@ -340,11 +290,17 @@ export class GasPriceManager {
         return await this.innerGetGasPrice();
     }
     async getMaxBaseFeePerGas() {
-        let maxBaseFeePerGas = await this.baseFeePerGasQueue.getMaxValue();
-        if (!maxBaseFeePerGas) {
-            maxBaseFeePerGas = await this.getBaseFee();
+        try {
+            let maxBaseFeePerGas = await this.baseFeePerGasQueue.getMaxValue();
+            if (!maxBaseFeePerGas) {
+                maxBaseFeePerGas = await this.getBaseFee();
+            }
+            return maxBaseFeePerGas;
+        }
+        catch (e) {
+            this.logger.error(e, "Failed to get max base fee per gas, returning 0n");
+            return 0n;
         }
-        return maxBaseFeePerGas;
     }
     async getHighestMaxFeePerGas() {
         let highestMaxFeePerGas = await this.maxFeePerGasQueue.getMaxValue();
@@ -378,19 +334,17 @@ export class GasPriceManager {
         }
         return minMaxPriorityFeePerGas;
     }
-    async validateGasPrice(gasPrice) {
+    async getLowestValidGasPrices() {
         let lowestMaxFeePerGas = await this.getMinMaxFeePerGas();
         let lowestMaxPriorityFeePerGas = await this.getMinMaxPriorityFeePerGas();
         if (this.config.chainType === "hedera") {
             lowestMaxFeePerGas /= 10n ** 9n;
             lowestMaxPriorityFeePerGas /= 10n ** 9n;
         }
-        if (gasPrice.maxFeePerGas < lowestMaxFeePerGas) {
-            throw new RpcError(`maxFeePerGas must be at least ${lowestMaxFeePerGas} (current maxFeePerGas: ${gasPrice.maxFeePerGas}) - use pimlico_getUserOperationGasPrice to get the current gas price`);
-        }
-        if (gasPrice.maxPriorityFeePerGas < lowestMaxPriorityFeePerGas) {
-            throw new RpcError(`maxPriorityFeePerGas must be at least ${lowestMaxPriorityFeePerGas} (current maxPriorityFeePerGas: ${gasPrice.maxPriorityFeePerGas}) - use pimlico_getUserOperationGasPrice to get the current gas price`);
-        }
+        return {
+            lowestMaxFeePerGas,
+            lowestMaxPriorityFeePerGas
+        };
     }
 }
 //# sourceMappingURL=gasPriceManager.js.map