fix: mocks

Author: pcarranzav

packages/indexer-common/src/indexing-fees/__tests__/dips.test.ts

@@ -1,4 +1,3 @@
-jest.mock('../../allocations/escrow-accounts')
 import {
   DipsManager,
   GraphNode,
@@ -31,8 +30,6 @@ import { Sequelize } from 'sequelize'
 import { testNetworkSpecification } from '../../indexer-management/__tests__/util'
 import { BigNumber } from 'ethers'
 import { CollectPaymentStatus } from '@graphprotocol/dips-proto/generated/gateway'
-import { getEscrowSenderForSigner } from '../../allocations/escrow-accounts'
-import { GatewayDipsServiceMessages } from '../gateway-dips-service-client'
 
 // Make global Jest variables available
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -386,6 +383,7 @@ describe('DipsCollector', () => {
         network.tapCollector!,
         network.wallet,
         graphNode,
+        jest.fn(),
       )
       expect(dipsCollector).toBeDefined()
     })
@@ -398,6 +396,7 @@ describe('DipsCollector', () => {
         network.tapCollector!,
         network.wallet,
         graphNode,
+        jest.fn(),
       )
       expect(dipsCollector).toBeDefined()
       expect(startCollectionLoop).toHaveBeenCalled()
@@ -420,6 +419,7 @@ describe('DipsCollector', () => {
             network.tapCollector!,
             network.wallet,
             graphNode,
+            jest.fn(),
           ),
       ).toThrow('dipperEndpoint is not set')
     })
@@ -481,8 +481,8 @@ describe('DipsCollector', () => {
         status: CollectPaymentStatus.ACCEPT,
         tapReceipt: Buffer.from('1234', 'hex'),
       })
-      jest
-        .spyOn(GatewayDipsServiceMessages, 'decodeTapReceipt')
+      dipsCollector.gatewayDipsServiceMessagesCodec.decodeTapReceipt = jest
+        .fn()
         .mockImplementation(() => {
           logger.info('MOCK Decoding TAP receipt')
           return {
@@ -494,7 +494,8 @@ describe('DipsCollector', () => {
             value: '1000',
           }
         })
-      ;(getEscrowSenderForSigner as jest.Mock).mockImplementation(() => {
+      dipsCollector.escrowSenderGetter = jest.fn().mockImplementation(() => {
+        logger.info('MOCK Getting escrow sender for signer')
         return toAddress('0x123456df40c29949a75a6693c77834c00b8a5678')
       })
 
@@ -513,7 +514,7 @@ describe('DipsCollector', () => {
       })
       expect(receipt).not.toBeNull()
       expect(receipt?.signer_address).toBe(
-        toAddress('0x123456df40c29949a75a6693c77834c00b8a5678'),
+        toAddress('0xabcd56df41234949a75a6693c77834c00b8abbbb'),
       )
       expect(receipt?.value).toBe('1000')
     })

packages/indexer-common/src/indexing-fees/dips.ts

@@ -15,6 +15,7 @@ import {
   Network,
   QueryFeeModels,
   sequentialTimerMap,
+  SubgraphClient,
   SubgraphIdentifierType,
   TapCollector,
   upsertIndexingRule,
@@ -23,7 +24,7 @@ import { Op } from 'sequelize'
 
 import {
   createGatewayDipsServiceClient,
-  GatewayDipsServiceMessages,
+  GatewayDipsServiceMessagesCodec,
 } from './gateway-dips-service-client'
 import {
   CollectPaymentStatus,
@@ -43,9 +44,13 @@ const normalizeAddressForDB = (address: string) => {
   return toAddress(address).toLowerCase().replace('0x', '')
 }
 
+type GetEscrowSenderForSigner = (
+  tapSubgraph: SubgraphClient,
+  signer: Address,
+) => Promise<Address>
 export class DipsManager {
   declare gatewayDipsServiceClient: GatewayDipsServiceClientImpl
-
+  declare gatewayDipsServiceMessagesCodec: GatewayDipsServiceMessagesCodec
   constructor(
     private logger: Logger,
     private models: IndexerManagementModels,
@@ -58,6 +63,7 @@ export class DipsManager {
     this.gatewayDipsServiceClient = createGatewayDipsServiceClient(
       this.network.specification.indexerOptions.dipperEndpoint,
     )
+    this.gatewayDipsServiceMessagesCodec = new GatewayDipsServiceMessagesCodec()
   }
   // Cancel an agreement associated to an allocation if it exists
   async tryCancelAgreement(allocationId: string) {
@@ -71,7 +77,7 @@ export class DipsManager {
     if (agreement) {
       try {
         const cancellation =
-          await GatewayDipsServiceMessages.createSignedCancellationRequest(
+          await this.gatewayDipsServiceMessagesCodec.createSignedCancellationRequest(
             uuidToHex(agreement.id),
             this.network.wallet,
           )
@@ -176,6 +182,7 @@ export class DipsManager {
 
 export class DipsCollector {
   declare gatewayDipsServiceClient: GatewayDipsServiceClientImpl
+  declare gatewayDipsServiceMessagesCodec: GatewayDipsServiceMessagesCodec
   constructor(
     private logger: Logger,
     private managementModels: IndexerManagementModels,
@@ -184,13 +191,15 @@ export class DipsCollector {
     private tapCollector: TapCollector,
     private wallet: Wallet,
     private graphNode: GraphNode,
+    public escrowSenderGetter: GetEscrowSenderForSigner,
   ) {
     if (!this.specification.indexerOptions.dipperEndpoint) {
       throw new Error('dipperEndpoint is not set')
     }
     this.gatewayDipsServiceClient = createGatewayDipsServiceClient(
       this.specification.indexerOptions.dipperEndpoint,
     )
+    this.gatewayDipsServiceMessagesCodec = new GatewayDipsServiceMessagesCodec()
   }
 
   static create(
@@ -201,6 +210,7 @@ export class DipsCollector {
     tapCollector: TapCollector,
     wallet: Wallet,
     graphNode: GraphNode,
+    escrowSenderGetter?: GetEscrowSenderForSigner,
   ) {
     const collector = new DipsCollector(
       logger,
@@ -210,6 +220,7 @@ export class DipsCollector {
       tapCollector,
       wallet,
       graphNode,
+      escrowSenderGetter ?? getEscrowSenderForSigner,
     )
     collector.startCollectionLoop()
     return collector
@@ -260,12 +271,13 @@ export class DipsCollector {
       return
     }
     const entityCount = entityCounts[0]
-    const collection = await GatewayDipsServiceMessages.createSignedCollectionRequest(
-      uuidToHex(agreement.id),
-      agreement.last_allocation_id,
-      entityCount,
-      this.wallet,
-    )
+    const collection =
+      await this.gatewayDipsServiceMessagesCodec.createSignedCollectionRequest(
+        uuidToHex(agreement.id),
+        agreement.last_allocation_id,
+        entityCount,
+        this.wallet,
+      )
     try {
       this.logger.info(`Collecting payment for agreement ${agreement.id}`)
       const response = await this.gatewayDipsServiceClient.CollectPayment({
@@ -277,15 +289,15 @@ export class DipsCollector {
           throw new Error('TapCollector not initialized')
         }
         // Store the tap receipt in the database
-        this.logger.info(`Decoding TAP receipt for agreement`)
-        const tapReceipt = GatewayDipsServiceMessages.decodeTapReceipt(
+        this.logger.info('Decoding TAP receipt for agreement')
+        const tapReceipt = this.gatewayDipsServiceMessagesCodec.decodeTapReceipt(
           response.tapReceipt,
           this.tapCollector?.tapContracts.tapVerifier.address,
         )
-        // TODO: check that the signer of the TAP receipt is a signer
+        // Check that the signer of the TAP receipt is a signer
         // on the corresponding escrow account for the payer (sender) of the
         // indexing agreement
-        const escrowSender = await getEscrowSenderForSigner(
+        const escrowSender = await this.escrowSenderGetter(
           this.tapCollector?.tapSubgraph,
           tapReceipt.signer_address,
         )

packages/indexer-common/src/indexing-fees/gateway-dips-service-client.ts

@@ -43,11 +43,11 @@ export const collectPaymentsTypes = {
   ],
 }
 
-export class GatewayDipsServiceMessages {
-  static createSignedCancellationRequest = async (
+export class GatewayDipsServiceMessagesCodec {
+  async createSignedCancellationRequest(
     agreementId: string,
     wallet: Wallet,
-  ): Promise<Uint8Array> => {
+  ): Promise<Uint8Array> {
     const signature = await wallet._signTypedData(
       cancelAgreementDomain,
       cancelAgreementTypes,
@@ -58,12 +58,12 @@ export class GatewayDipsServiceMessages {
     )
   }
 
-  static createSignedCollectionRequest = async (
+  async createSignedCollectionRequest(
     agreementId: string,
     allocationId: string,
     entityCount: number,
     wallet: Wallet,
-  ): Promise<Uint8Array> => {
+  ): Promise<Uint8Array> {
     const signature = await wallet._signTypedData(
       collectPaymentsDomain,
       collectPaymentsTypes,
@@ -81,7 +81,7 @@ export class GatewayDipsServiceMessages {
     )
   }
 
-  static decodeTapReceipt = (receipt: Uint8Array, verifyingContract: string) => {
+  decodeTapReceipt(receipt: Uint8Array, verifyingContract: string) {
     const [message, signature] = defaultAbiCoder.decode(
       ['tuple(address,uint64,uint64,uint128)', 'bytes'],
       receipt,