feat(app-tokens): Add app token dataloader selector (Zapper-fi#1093)

src/app-toolkit/app-toolkit.interface.ts

@@ -5,6 +5,7 @@ import { ethers } from 'ethers';
 import { AppDefinition } from '~app/app.definition';
 import { IContractFactory } from '~contract/contracts';
 import { IMulticallWrapper } from '~multicall/multicall.interface';
+import { AppTokenSelector, CreateAppTokenSelectorOptions } from '~position/app-token-selector.interface';
 import { DefaultDataProps } from '~position/display.interface';
 import { AppTokenPosition, ContractPosition, NonFungibleToken } from '~position/position.interface';
 import { AppGroupsDefinition } from '~position/position.service';
@@ -40,6 +41,8 @@ export interface IAppToolkit {
 
   // Positions
 
+  getAppTokenSelector(opts?: CreateAppTokenSelectorOptions): AppTokenSelector;
+
   getAppTokenPositions<T = DefaultDataProps>(
     ...appTokenDefinition: AppGroupsDefinition[]
   ): Promise<AppTokenPosition<T>[]>;

src/app-toolkit/app-toolkit.service.ts

@@ -7,14 +7,15 @@ import { AppService } from '~app/app.service';
 import { ContractFactory } from '~contract';
 import { MulticallService } from '~multicall/multicall.service';
 import { NetworkProviderService } from '~network-provider/network-provider.service';
+import { CreateAppTokenSelectorOptions } from '~position/app-token-selector.interface';
+import { AppTokenSelectorService } from '~position/app-token-selector.service';
 import { DefaultDataProps } from '~position/display.interface';
 import { PositionKeyService } from '~position/position-key.service';
 import { AppTokenPosition, ContractPosition, NonFungibleToken } from '~position/position.interface';
 import { AppGroupsDefinition, PositionService } from '~position/position.service';
 import { BaseToken } from '~position/token.interface';
 import { PriceSelectorService } from '~token/price-selector.service';
 import { CreatePriceSelectorOptions } from '~token/token-price-selector.interface';
-import { TokenService } from '~token/token.service';
 import { Network } from '~types/network.interface';
 
 import { AppToolkitHelperRegistry } from './app-toolkit.helpers';
@@ -30,8 +31,8 @@ export class AppToolkit implements IAppToolkit {
     @Inject(NetworkProviderService) private readonly networkProviderService: NetworkProviderService,
     @Inject(PositionService) private readonly positionService: PositionService,
     @Inject(PositionKeyService) private readonly positionKeyService: PositionKeyService,
-    @Inject(TokenService) private readonly tokenService: TokenService,
     @Inject(PriceSelectorService) private readonly priceSelectorService: PriceSelectorService,
+    @Inject(AppTokenSelectorService) private readonly appTokenSelectorService: AppTokenSelectorService,
     @Inject(MulticallService) private readonly multicallService: MulticallService,
     @Inject(CACHE_MANAGER) private readonly cacheManager: Cache,
   ) {
@@ -78,6 +79,10 @@ export class AppToolkit implements IAppToolkit {
 
   // Positions
 
+  getAppTokenSelector(opts: CreateAppTokenSelectorOptions = {}) {
+    return this.appTokenSelectorService.create(opts);
+  }
+
   getAppTokenPositions<T = DefaultDataProps>(...appTokenDefinitions: AppGroupsDefinition[]) {
     return this.positionService.getAppTokenPositions<T>(...appTokenDefinitions);
   }

src/apps/metavault-trade/polygon/metavault-trade.mvlp.token-fetcher.ts

@@ -1,6 +1,5 @@
 import { Inject } from '@nestjs/common';
 
-
 import { Register } from '~app-toolkit/decorators';
 import { PositionFetcher } from '~position/position-fetcher.interface';
 import { AppTokenPosition } from '~position/position.interface';

src/apps/openleverage/contracts/index.ts

@@ -1,10 +1,11 @@
 import { Injectable, Inject } from '@nestjs/common';
+
 import { IAppToolkit, APP_TOOLKIT } from '~app-toolkit/app-toolkit.interface';
+import { ContractFactory } from '~contract/contracts';
 import { Network } from '~types/network.interface';
 
 import { OpenleverageFactory__factory } from './ethers';
 import { OpenleverageLpool__factory } from './ethers';
-import { ContractFactory } from '~contract/contracts';
 // eslint-disable-next-line
 type ContractOpts = { address: string; network: Network };
 

src/apps/openleverage/openleverage.definition.ts

@@ -11,7 +11,7 @@ export const OPENLEVERAGE_DEFINITION = appDefinition({
   url: 'https://openleverage.finance/',
   groups: {
     pool: { id: 'pool', type: GroupType.TOKEN, label: 'Pools' },
-    trade: { id: 'trade', type: GroupType.POSITION, label: 'Trade' }
+    trade: { id: 'trade', type: GroupType.POSITION, label: 'Trade' },
   },
   tags: [AppTag.DECENTRALIZED_EXCHANGE],
   keywords: [],

src/apps/qi-dao/optimism/qi-dao.balance-fetcher.ts

@@ -19,7 +19,7 @@ export class OptimismQiDaoBalanceFetcher implements BalanceFetcher {
     @Inject(QiDaoVaultPositionBalanceHelper)
     private readonly qiDaoVaultTokenBalanceHelper: QiDaoVaultPositionBalanceHelper,
     @Inject(QiDaoContractFactory) private readonly contractFactory: QiDaoContractFactory,
-  ) { }
+  ) {}
 
   async getVaultTokenBalances(address: string) {
     return this.qiDaoVaultTokenBalanceHelper.getPositionBalances({

src/apps/qi-dao/optimism/qi-dao.vault.position-fetcher.ts

@@ -16,7 +16,7 @@ const network = Network.OPTIMISM_MAINNET;
 export class OptimismQiDaoVaultPositionFetcher
   implements PositionFetcher<ContractPosition<QiDaoVaultPositionDataProps>>
 {
-  constructor(@Inject(QiDaoVaultPositionHelper) private readonly qiDaoVaultPositionHelper: QiDaoVaultPositionHelper) { }
+  constructor(@Inject(QiDaoVaultPositionHelper) private readonly qiDaoVaultPositionHelper: QiDaoVaultPositionHelper) {}
 
   getPositions() {
     return this.qiDaoVaultPositionHelper.getPositions({

src/position/app-token-selector.interface.ts

@@ -0,0 +1,19 @@
+import { Network } from '~types';
+
+import { AppTokenPosition } from './position.interface';
+
+export type LoggingTags = { network?: Network; context?: string };
+export type AppTokenSelectorKey = { network: Network; address: string };
+export type GetOne = (opts: AppTokenSelectorKey) => Promise<AppTokenPosition | null>;
+export type GetMany = (opts: AppTokenSelectorKey[]) => Promise<(AppTokenPosition | null)[]>;
+
+export interface AppTokenSelector {
+  getOne: GetOne;
+  getMany: GetMany;
+}
+
+export type CreateAppTokenSelectorOptions = { tags?: LoggingTags };
+
+export interface AppTokenSelectorFactory {
+  create: (opts: CreateAppTokenSelectorOptions) => AppTokenSelector;
+}

src/position/app-token-selector.service.ts

@@ -0,0 +1,39 @@
+import { Inject, Injectable } from '@nestjs/common';
+import DataLoader from 'dataloader';
+import { Mutable } from 'type-fest';
+
+import { AppTokenPosition } from '~position/position.interface';
+
+import {
+  AppTokenSelector,
+  AppTokenSelectorFactory,
+  AppTokenSelectorKey,
+  CreateAppTokenSelectorOptions,
+  GetMany,
+  GetOne,
+} from './app-token-selector.interface';
+import { ApiPositionSource } from './position-source/position-source.api';
+
+@Injectable()
+export class AppTokenSelectorService implements AppTokenSelectorFactory {
+  constructor(@Inject(ApiPositionSource) private readonly positionAPIClient: ApiPositionSource) {}
+
+  create(_opts: CreateAppTokenSelectorOptions): AppTokenSelector {
+    const tokenDataLoader = new DataLoader<AppTokenSelectorKey, AppTokenPosition | null>(
+      keys => this.positionAPIClient.getAppTokenBatch(keys as Mutable<AppTokenSelectorKey[]>),
+      { maxBatchSize: 100 },
+    );
+
+    return {
+      getOne: ({ network, address }: Parameters<GetOne>[0]) => tokenDataLoader.load({ network, address }),
+      getMany: async (queries: Parameters<GetMany>[0]) => {
+        const docs = await tokenDataLoader.loadMany(queries);
+
+        return docs.map(doc => {
+          if (doc instanceof Error) return null;
+          return doc;
+        });
+      },
+    };
+  }
+}

src/position/position-source/position-source.api.ts

@@ -4,9 +4,11 @@ import Axios, { AxiosInstance } from 'axios';
 import DataLoader from 'dataloader';
 import qs from 'qs';
 
+import { AppTokenSelectorKey } from '~position/app-token-selector.interface';
 import { ContractType } from '~position/contract.interface';
 import { AbstractPosition, AppTokenPosition, ContractPosition } from '~position/position.interface';
 import { AppGroupsDefinition } from '~position/position.service';
+import { Network } from '~types';
 
 import { PositionSource } from './position-source.interface';
 
@@ -62,4 +64,18 @@ export class ApiPositionSource implements PositionSource {
     const results = await Promise.all(definitions.map(v => loader.load(v))).then(v => v.flat());
     return results as any as T[];
   }
+
+  async getAppTokenBatch(queries: AppTokenSelectorKey[]) {
+    const addresses: string[] = [];
+    const networks: Network[] = [];
+
+    for (const q of queries) {
+      addresses.push(q.address);
+      networks.push(q.network);
+    }
+
+    const query = qs.stringify({ addresses, networks });
+    const { data } = await this.axios.get<(AppTokenPosition | null)[]>(`/v2/app-tokens/batch?${query}`);
+    return data;
+  }
 }

src/position/position.module.ts

@@ -3,6 +3,7 @@ import { DiscoveryModule } from '@nestjs/core';
 
 import { CacheModule } from '~cache/cache.module';
 
+import { AppTokenSelectorService } from './app-token-selector.service';
 import { PositionBalanceFetcherRegistry } from './position-balance-fetcher.registry';
 import { PositionFetcherRegistry } from './position-fetcher.registry';
 import { PositionKeyService } from './position-key.service';
@@ -14,12 +15,19 @@ import { PositionService } from './position.service';
   imports: [DiscoveryModule, CacheModule],
   providers: [
     ...PositionSources,
-    PositionService,
-    PositionFetcherRegistry,
+    AppTokenSelectorService,
     PositionBalanceFetcherRegistry,
+    PositionFetcherRegistry,
     PositionKeyService,
+    PositionService,
   ],
   controllers: [PositionController],
-  exports: [PositionService, PositionFetcherRegistry, PositionBalanceFetcherRegistry, PositionKeyService],
+  exports: [
+    AppTokenSelectorService,
+    PositionBalanceFetcherRegistry,
+    PositionFetcherRegistry,
+    PositionKeyService,
+    PositionService,
+  ],
 })
 export class PositionModule {}