Merge pull request #589 from everclearorg/feat/monitor-message-status-prod

feat: check polymer message statuses in monitor

Author: preethamr

packages/agents/monitor/src/helpers/hyperlane.ts

@@ -5,14 +5,20 @@ import {
   createLoggingContext,
   HyperlaneMessageResponse,
   HyperlaneStatus,
+  isPolymerRoute,
   jsonifyError,
   Message,
   RequestContext,
   SOLANA_CHAINID,
 } from '@chimera-monorepo/utils';
 import { NoDispatchEventOnMessage, NoGatewayConfigured } from '../types';
 import { getContext } from '../context';
-import { getHyperlaneMessageStatus, getHyperlaneMsgDelivered, getMailboxInterface } from '../mockable';
+import {
+  getHyperlaneMessageStatus,
+  getHyperlaneMsgDelivered,
+  getMailboxInterface,
+  getPolymerMsgDelivered,
+} from '../mockable';
 import { WriteTransaction } from '@chimera-monorepo/chainservice';
 
 export const getMessageStatus = async (
@@ -46,6 +52,25 @@ export const getMessageStatus = async (
     return { status: 'none' };
   }
 
+  // For Polymer-routed messages, query the Polymer relayer API instead of on-chain mailbox
+  if (
+    message.originDomain &&
+    message.destinationDomain &&
+    isPolymerRoute(message.originDomain, message.destinationDomain)
+  ) {
+    try {
+      const status = await getPolymerMsgDelivered(id);
+      return { status };
+    } catch (e) {
+      logger.error('Failed to get Polymer message status', requestContext, methodContext, jsonifyError(e as Error), {
+        id,
+        originDomain: message.originDomain,
+        destinationDomain: message.destinationDomain,
+      });
+      return { status: 'pending' };
+    }
+  }
+
   // If the message is pending, check to see if it has been delivered onchain.
   // NOTE: graphql api returns `pending` if the message has been self-relayed.
   // Get the mailbox from the destination gateway contract and query directly.

packages/agents/monitor/src/mockable.ts

@@ -9,6 +9,7 @@ import {
   getTokenPriceFromUniV3 as _getTokenPriceFromUniV3,
   getHyperlaneMessageStatus as _getHyperlaneMessageStatus,
   getHyperlaneMsgDelivered as _getHyperlaneMsgDelivered,
+  getPolymerMsgDelivered as _getPolymerMsgDelivered,
   sendAlerts as _sendAlerts,
   resolveAlerts as _resolveAlerts,
   getSsmParameter as _getSsmParameter,
@@ -68,6 +69,7 @@ export const getTokenPriceFromChainlink = _getTokenPriceFromChainlink;
 export const getTokenPriceFromUniV2 = _getTokenPriceFromUniV2;
 export const getTokenPriceFromUniV3 = _getTokenPriceFromUniV3;
 export const getHyperlaneMsgDelivered = _getHyperlaneMsgDelivered;
+export const getPolymerMsgDelivered = _getPolymerMsgDelivered;
 export const sendAlerts = _sendAlerts;
 export const resolveAlerts = _resolveAlerts;
 export const getSsmParameter = _getSsmParameter;

packages/agents/monitor/test/helpers/hyperlane.spec.ts

@@ -1,5 +1,5 @@
 import { SinonStub, SinonStubbedInstance, stub } from 'sinon';
-import { expect, HyperlaneMessageResponse, HyperlaneStatus, Message, mkHash, chainWrapper } from '@chimera-monorepo/utils';
+import { expect, HyperlaneMessageResponse, HyperlaneStatus, Message, mkHash, chainWrapper, POLYMER_DOMAIN_PAIRS } from '@chimera-monorepo/utils';
 import * as Mockable from '../../src/mockable';
 
 import { getDispatchedMessage, getDispatchedMessageFromEvent, getMessageStatus } from '../../src/helpers';
@@ -138,6 +138,28 @@ describe('Helpers:hyperlane', () => {
       });
     });
 
+    it('should return delivered for polymer route when polymer API confirms delivery', async () => {
+      const [polymerOrigin, polymerDest] = POLYMER_DOMAIN_PAIRS[0]; // e.g. ['1', '25327']
+      database.getMessagesByIds.resolves([mock.message({ originDomain: polymerOrigin, destinationDomain: polymerDest })]);
+      const getPolymerMsgDeliveredStub = stub(Mockable, 'getPolymerMsgDelivered').resolves(HyperlaneStatus.delivered);
+      expect(await getMessageStatus(id)).to.be.deep.eq({ status: 'delivered' });
+      expect(getPolymerMsgDeliveredStub.calledOnceWith(id)).to.be.true;
+    });
+
+    it('should return pending for polymer route when polymer API returns pending', async () => {
+      const [polymerOrigin, polymerDest] = POLYMER_DOMAIN_PAIRS[0];
+      database.getMessagesByIds.resolves([mock.message({ originDomain: polymerOrigin, destinationDomain: polymerDest })]);
+      stub(Mockable, 'getPolymerMsgDelivered').resolves(HyperlaneStatus.pending);
+      expect(await getMessageStatus(id)).to.be.deep.eq({ status: 'pending' });
+    });
+
+    it('should return pending for polymer route when polymer API throws', async () => {
+      const [polymerOrigin, polymerDest] = POLYMER_DOMAIN_PAIRS[0];
+      database.getMessagesByIds.resolves([mock.message({ originDomain: polymerOrigin, destinationDomain: polymerDest })]);
+      stub(Mockable, 'getPolymerMsgDelivered').rejects(new Error('Polymer API error'));
+      expect(await getMessageStatus(id)).to.be.deep.eq({ status: 'pending' });
+    });
+
     it('should work if hyperlane api fails (derives from chain)', async () => {
       getHyperlaneMessageStatusStub.resolves(undefined);
       database.getMessagesByIds.resolves([mock.message()]);