refactor(payment detection): thegraph retriever (#947)

Author: benjlevesque

packages/currency/src/currencyManager.ts

@@ -129,6 +129,13 @@ export class CurrencyManager<TMeta = unknown> implements ICurrencyManager<TMeta>
     );
   }
 
+  fromHash(hash: string, network?: string): CurrencyDefinition<TMeta> | undefined {
+    return this.knownCurrencies.find(
+      (x) =>
+        x.hash.toLowerCase() === hash.toLowerCase() &&
+        ((x.type === ISO4217 && !network) || ('network' in x && x.network === network) || !network),
+    );
+  }
   /**
    * Retrieves a currency given its storage format (ICurrency)
    */

packages/currency/src/types.ts

@@ -99,6 +99,7 @@ export interface ICurrencyManager<TMeta = unknown> {
   from(symbolOrAddress: string, network?: string): CurrencyDefinition<TMeta> | undefined;
   fromAddress(address: string, network?: string): CurrencyDefinition<TMeta> | undefined;
   fromSymbol(symbol: string, network?: string): CurrencyDefinition<TMeta> | undefined;
+  fromHash(hash: string, network?: string): CurrencyDefinition<TMeta> | undefined;
   fromStorageCurrency(currency: StorageCurrency): CurrencyDefinition<TMeta> | undefined;
   getNativeCurrency(
     type: NativeCurrencyType,

packages/integration-test/test/scheduled/erc20-fee-proxy.test.ts

@@ -18,6 +18,7 @@ const erc20FeeProxy = new Erc20PaymentNetwork.ERC20FeeProxyPaymentDetector({
   // FIXME: the mocked advanced logic is address based
   advancedLogic: mockAdvancedLogic,
   currencyManager: CurrencyManager.getDefault(),
+  getSubgraphClient: jest.fn(),
 });
 
 describe('ERC20 Fee Proxy detection test-suite', () => {

packages/integration-test/test/scheduled/erc20-proxy.test.ts

@@ -3,6 +3,7 @@ import { PaymentTypes, RequestLogicTypes } from '@requestnetwork/types';
 
 import { mockAdvancedLogic } from './mocks';
 import { Types, Utils } from '@requestnetwork/request-client.js';
+import { CurrencyManager } from '@requestnetwork/currency';
 import {
   erc20requestCreationHash,
   localErc20PaymentNetworkParams,
@@ -14,6 +15,8 @@ import {
 
 const erc20ProxyAddressedBased = new Erc20PaymentNetwork.ERC20ProxyPaymentDetector({
   advancedLogic: mockAdvancedLogic,
+  currencyManager: CurrencyManager.getDefault(),
+  getSubgraphClient: jest.fn(),
 });
 
 describe('ERC20 Proxy detection test-suite', () => {

packages/integration-test/test/scheduled/erc777-stream.test.ts

@@ -5,6 +5,7 @@ import {
   PaymentTypes,
   RequestLogicTypes,
 } from '@requestnetwork/types';
+import { CurrencyManager } from '@requestnetwork/currency';
 
 import { mockAdvancedLogic } from './mocks';
 
@@ -47,6 +48,7 @@ const createMockRequest = ({
 
 const detector = new SuperFluidPaymentDetector({
   advancedLogic: mockAdvancedLogic,
+  currencyManager: CurrencyManager.getDefault(),
 });
 
 describe('ERC777 SuperFluid detection test-suite', () => {

packages/integration-test/test/scheduled/escrow-detector.test.ts

@@ -6,6 +6,7 @@ import { mockAdvancedLogic } from './mocks';
 const feeProxyDetector = new Erc20PaymentNetwork.ERC20FeeProxyPaymentDetector({
   advancedLogic: mockAdvancedLogic,
   currencyManager: CurrencyManager.getDefault(),
+  getSubgraphClient: jest.fn(),
 });
 
 describe('ERC20 with Escrow detection test-suite', () => {

packages/integration-test/test/scheduled/eth-input-data.test.ts

@@ -1,5 +1,6 @@
 import { EthInputDataPaymentDetector } from '@requestnetwork/payment-detection';
 import { RequestLogicTypes } from '@requestnetwork/types';
+import { CurrencyManager } from '@requestnetwork/currency';
 
 import { mockAdvancedLogic } from './mocks';
 import { Types, Utils } from '@requestnetwork/request-client.js';
@@ -14,6 +15,9 @@ import {
 
 const ethInputContract = new EthInputDataPaymentDetector({
   advancedLogic: mockAdvancedLogic,
+  currencyManager: CurrencyManager.getDefault(),
+  explorerApiKeys: {},
+  getSubgraphClient: jest.fn(),
 });
 
 describe('ETH Fee proxy detection test-suite', () => {

packages/payment-detection/package.json

@@ -50,6 +50,7 @@
     "graphql": "15.5.1",
     "graphql-request": "3.4.0",
     "graphql-tag": "2.12.4",
+    "lodash": "4.17.21",
     "satoshi-bitcoin": "1.0.4",
     "tslib": "2.3.1"
   },
@@ -62,6 +63,7 @@
     "@graphql-codegen/typescript-resolvers": "1.19.2",
     "@requestnetwork/advanced-logic": "0.34.0",
     "@types/jest": "26.0.13",
+    "@types/lodash": "4.14.161",
     "jest": "26.4.2",
     "nyc": "15.1.0",
     "shx": "0.3.2",

packages/payment-detection/src/any-to-any-detector.ts

@@ -18,9 +18,9 @@ export abstract class AnyToAnyDetector<
   public constructor(
     paymentNetworkId: PaymentTypes.PAYMENT_NETWORK_ID,
     extension: TExtension,
-    protected currencyManager: ICurrencyManager,
+    currencyManager: ICurrencyManager,
   ) {
-    super(paymentNetworkId, extension);
+    super(paymentNetworkId, extension, currencyManager);
   }
 
   /**

packages/payment-detection/src/any/any-to-erc20-proxy.ts

@@ -1,17 +1,11 @@
 import { erc20ConversionProxy } from '@requestnetwork/smart-contracts';
-import {
-  AdvancedLogicTypes,
-  ExtensionTypes,
-  PaymentTypes,
-  RequestLogicTypes,
-} from '@requestnetwork/types';
+import { ExtensionTypes, PaymentTypes, RequestLogicTypes } from '@requestnetwork/types';
 import Utils from '@requestnetwork/utils';
-import { ICurrencyManager } from '@requestnetwork/currency';
 import { ERC20FeeProxyPaymentDetectorBase } from '../erc20/fee-proxy-contract';
 import { AnyToErc20InfoRetriever } from './retrievers/any-to-erc20-proxy';
-import { TheGraphConversionRetriever } from './retrievers/thegraph';
-import { networkSupportsTheGraph } from '../thegraph';
+import { TheGraphInfoRetriever } from '../thegraph';
 import { makeGetDeploymentInformation } from '../utils';
+import { PaymentNetworkOptions, ReferenceBasedDetectorOptions } from '../types';
 
 const PROXY_CONTRACT_ADDRESS_MAP = {
   ['0.1.0']: '0.1.0',
@@ -24,22 +18,23 @@ export class AnyToERC20PaymentDetector extends ERC20FeeProxyPaymentDetectorBase<
   ExtensionTypes.PnAnyToErc20.IAnyToERC20,
   PaymentTypes.IERC20FeePaymentEventParameters
 > {
+  private readonly getSubgraphClient: PaymentNetworkOptions['getSubgraphClient'];
+
   /**
    * @param extension The advanced logic payment network extensions
    */
 
   public constructor({
     advancedLogic,
     currencyManager,
-  }: {
-    advancedLogic: AdvancedLogicTypes.IAdvancedLogic;
-    currencyManager: ICurrencyManager;
-  }) {
+    getSubgraphClient,
+  }: ReferenceBasedDetectorOptions & Pick<PaymentNetworkOptions, 'getSubgraphClient'>) {
     super(
       PaymentTypes.PAYMENT_NETWORK_ID.ANY_TO_ERC20_PROXY,
       advancedLogic.extensions.anyToErc20Proxy,
       currencyManager,
     );
+    this.getSubgraphClient = getSubgraphClient;
   }
 
   /**
@@ -81,13 +76,13 @@ export class AnyToERC20PaymentDetector extends ERC20FeeProxyPaymentDetectorBase<
    */
   protected async extractEvents(
     eventName: PaymentTypes.EVENTS_NAMES,
-    address: string | undefined,
+    toAddress: string | undefined,
     paymentReference: string,
     requestCurrency: RequestLogicTypes.ICurrency,
     paymentChain: string,
     paymentNetwork: ExtensionTypes.IState<ExtensionTypes.PnAnyToErc20.ICreationParameters>,
   ): Promise<PaymentTypes.AllNetworkEvents<PaymentTypes.IERC20FeePaymentEventParameters>> {
-    if (!address) {
+    if (!toAddress) {
       return {
         paymentEvents: [],
       };
@@ -103,30 +98,32 @@ export class AnyToERC20PaymentDetector extends ERC20FeeProxyPaymentDetectorBase<
 
     const currency = await this.getCurrency(requestCurrency);
 
-    const infoRetriever = networkSupportsTheGraph(paymentChain)
-      ? new TheGraphConversionRetriever(
-          currency,
-          paymentReference,
-          conversionProxyContractAddress,
-          address,
-          eventName,
-          paymentChain,
-          acceptedTokens,
-          maxRateTimespan,
-        )
-      : new AnyToErc20InfoRetriever(
-          currency,
-          paymentReference,
-          conversionProxyContractAddress,
-          conversionProxyCreationBlockNumber,
-          conversionProxyAbi,
-          address,
-          eventName,
-          paymentChain,
-          acceptedTokens,
-          maxRateTimespan,
-        );
+    const subgraphClient = this.getSubgraphClient(paymentChain);
+    if (subgraphClient) {
+      const infoRetriever = new TheGraphInfoRetriever(subgraphClient, this.currencyManager);
+      return await infoRetriever.getTransferEvents({
+        paymentReference,
+        contractAddress: conversionProxyContractAddress,
+        toAddress,
+        eventName,
+        paymentChain,
+        acceptedTokens,
+        maxRateTimespan,
+      });
+    }
 
+    const infoRetriever = new AnyToErc20InfoRetriever(
+      currency,
+      paymentReference,
+      conversionProxyContractAddress,
+      conversionProxyCreationBlockNumber,
+      conversionProxyAbi,
+      toAddress,
+      eventName,
+      paymentChain,
+      acceptedTokens,
+      maxRateTimespan,
+    );
     const paymentEvents =
       (await infoRetriever.getTransferEvents()) as PaymentTypes.IPaymentNetworkEvent<PaymentTypes.IERC20FeePaymentEventParameters>[];
     return {