feat(dopex): add voting escrow (#1080)

Author: pwele

src/apps/dopex/arbitrum/dopex.balance-fetcher.ts

@@ -5,6 +5,7 @@ import Web3 from 'web3';
 import { APP_TOOLKIT, IAppToolkit } from '~app-toolkit/app-toolkit.interface';
 import { Register } from '~app-toolkit/decorators';
 import { presentBalanceFetcherResponse } from '~app-toolkit/helpers/presentation/balance-fetcher-response.present';
+import { CurveVotingEscrowContractPositionBalanceHelper } from '~apps/curve/helpers/curve.voting-escrow.contract-position-balance-helper';
 import { BalanceFetcher } from '~balance/balance-fetcher.interface';
 import { Network } from '~types/network.interface';
 
@@ -16,15 +17,18 @@ import {
   DopexGOhmSsov,
   DopexRdpxSsov,
   DopexStaking,
+  DopexVotingEscrow,
+  DopexVotingEscrowRewards,
 } from '../contracts';
 import { DOPEX_DEFINITION } from '../dopex.definition';
 import { DopexSsovClaimableBalancesStrategy } from '../helpers/dopex.ssov.claimable-balances-strategy';
 import { DopexSsovContractPositionBalanceHelper } from '../helpers/dopex.ssov.contract-position-balance-helper';
 import { DopexSsovDepositBalanceStrategy } from '../helpers/dopex.ssov.deposit-balance-strategy';
 
 const network = Network.ARBITRUM_MAINNET;
+const appId = DOPEX_DEFINITION.id;
 
-@Register.BalanceFetcher(DOPEX_DEFINITION.id, network)
+@Register.BalanceFetcher(appId, network)
 export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
   constructor(
     @Inject(APP_TOOLKIT) private readonly appToolkit: IAppToolkit,
@@ -36,13 +40,15 @@ export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
     private readonly dopexSsovDepositBalanceStrategy: DopexSsovDepositBalanceStrategy,
     @Inject(DopexSsovClaimableBalancesStrategy)
     private readonly dopexSsovClaimableBalancesStrategy: DopexSsovClaimableBalancesStrategy,
+    @Inject(CurveVotingEscrowContractPositionBalanceHelper)
+    private readonly curveVotingEscrowContractPositionBalanceHelper: CurveVotingEscrowContractPositionBalanceHelper,
   ) {}
 
   private async getSsovBalances(address: string) {
     return Promise.all([
       this.dopexSsovContractPositionBalanceHelper.getBalances<DopexDpxSsov>({
         address,
-        appId: DOPEX_DEFINITION.id,
+        appId,
         groupId: DOPEX_DEFINITION.groups.dpxSsov.id,
         network,
         resolveSsovContract: ({ address, network }) => this.dopexContractFactory.dopexDpxSsov({ address, network }),
@@ -61,7 +67,7 @@ export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
       }),
       this.dopexSsovContractPositionBalanceHelper.getBalances<DopexRdpxSsov>({
         address,
-        appId: DOPEX_DEFINITION.id,
+        appId,
         groupId: DOPEX_DEFINITION.groups.rdpxSsov.id,
         network,
         resolveSsovContract: ({ address, network }) => this.dopexContractFactory.dopexRdpxSsov({ address, network }),
@@ -80,7 +86,7 @@ export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
       }),
       this.dopexSsovContractPositionBalanceHelper.getBalances<DopexEthSsov>({
         address,
-        appId: DOPEX_DEFINITION.id,
+        appId,
         groupId: DOPEX_DEFINITION.groups.ethSsov.id,
         network,
         resolveSsovContract: ({ address, network }) => this.dopexContractFactory.dopexEthSsov({ address, network }),
@@ -109,7 +115,7 @@ export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
       }),
       this.dopexSsovContractPositionBalanceHelper.getBalances<DopexGOhmSsov>({
         address,
-        appId: DOPEX_DEFINITION.id,
+        appId,
         groupId: DOPEX_DEFINITION.groups.gohmSsov.id,
         network,
         resolveSsovContract: ({ address, network }) => this.dopexContractFactory.dopexGOhmSsov({ address, network }),
@@ -122,7 +128,7 @@ export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
       }),
       this.dopexSsovContractPositionBalanceHelper.getBalances<DopexGmxSsov>({
         address,
-        appId: DOPEX_DEFINITION.id,
+        appId,
         groupId: DOPEX_DEFINITION.groups.gmxSsov.id,
         network,
         resolveSsovContract: ({ address, network }) => this.dopexContractFactory.dopexGmxSsov({ address, network }),
@@ -157,7 +163,7 @@ export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
   private async getStakedBalances(address: string) {
     return this.appToolkit.helpers.singleStakingContractPositionBalanceHelper.getBalances<DopexStaking>({
       address,
-      appId: DOPEX_DEFINITION.id,
+      appId,
       groupId: DOPEX_DEFINITION.groups.farm.id,
       network,
       resolveContract: ({ address, network }) => this.dopexContractFactory.dopexStaking({ address, network }),
@@ -170,10 +176,31 @@ export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
     });
   }
 
+  private async getVotingEscrowBalances(address: string) {
+    return this.curveVotingEscrowContractPositionBalanceHelper.getBalances<DopexVotingEscrow, DopexVotingEscrowRewards>(
+      {
+        address,
+        appId,
+        groupId: DOPEX_DEFINITION.groups.votingEscrow.id,
+        network,
+        resolveContract: ({ address }) => this.dopexContractFactory.dopexVotingEscrow({ network, address }),
+        resolveRewardContract: ({ address }) =>
+          this.dopexContractFactory.dopexVotingEscrowRewards({ network, address }),
+        resolveLockedTokenBalance: ({ contract, multicall }) =>
+          multicall
+            .wrap(contract)
+            .locked(address)
+            .then(v => v.amount),
+        resolveRewardTokenBalance: ({ contract, multicall }) => multicall.wrap(contract).earned(address),
+      },
+    );
+  }
+
   async getBalances(address: string) {
-    const [ssovBalances, stakedBalances] = await Promise.all([
+    const [ssovBalances, stakedBalances, votingEscrowBalances] = await Promise.all([
       this.getSsovBalances(address),
       this.getStakedBalances(address),
+      this.getVotingEscrowBalances(address),
     ]);
 
     return presentBalanceFetcherResponse([
@@ -185,6 +212,10 @@ export class ArbitrumDopexBalanceFetcher implements BalanceFetcher {
         label: 'Staking',
         assets: [...stakedBalances],
       },
+      {
+        label: 'Voting Escrow',
+        assets: votingEscrowBalances,
+      },
     ]);
   }
 }

src/apps/dopex/arbitrum/dopex.voting-escrow.contract-position-fetcher.ts

@@ -0,0 +1,41 @@
+import { Inject } from '@nestjs/common';
+
+import { Register } from '~app-toolkit/decorators';
+import { CurveVotingEscrowContractPositionHelper } from '~apps/curve/helpers/curve.voting-escrow.contract-position-helper';
+import { PositionFetcher } from '~position/position-fetcher.interface';
+import { ContractPosition } from '~position/position.interface';
+import { Network } from '~types/network.interface';
+
+import { DopexContractFactory, DopexVotingEscrow, DopexVotingEscrowRewards } from '../contracts';
+import { DOPEX_DEFINITION } from '../dopex.definition';
+
+const appId = DOPEX_DEFINITION.id;
+const groupId = DOPEX_DEFINITION.groups.votingEscrow.id;
+const network = Network.ARBITRUM_MAINNET;
+
+@Register.ContractPositionFetcher({ appId, groupId, network })
+export class ArbitrumDopexVotingEscrowContractPositionFetcher implements PositionFetcher<ContractPosition> {
+  constructor(
+    @Inject(DopexContractFactory)
+    private readonly dopexContractFactory: DopexContractFactory,
+    @Inject(CurveVotingEscrowContractPositionHelper)
+    private readonly curveVotingEscrowContractPositionHelper: CurveVotingEscrowContractPositionHelper,
+  ) {}
+
+  async getPositions() {
+    return this.curveVotingEscrowContractPositionHelper.getContractPositions<
+      DopexVotingEscrow,
+      DopexVotingEscrowRewards
+    >({
+      votingEscrowAddress: '0x80789d252a288e93b01d82373d767d71a75d9f16',
+      votingEscrowRewardAddress: '0xcbbfb7e0e6782df0d3e91f8d785a5bf9e8d9775f',
+      appId,
+      groupId,
+      network,
+      resolveContract: ({ address }) => this.dopexContractFactory.dopexVotingEscrow({ network, address }),
+      resolveRewardContract: ({ address }) => this.dopexContractFactory.dopexVotingEscrowRewards({ network, address }),
+      resolveLockedTokenAddress: ({ contract, multicall }) => multicall.wrap(contract).token(),
+      resolveRewardTokenAddress: ({ contract, multicall }) => multicall.wrap(contract).emittedToken(),
+    });
+  }
+}