feat(cask): Support Cask vault token on all networks (#1929)

src/apps/cask-protocol/arbitrum/cask-protocol.wallet.token-fetcher.ts

@@ -0,0 +1,15 @@
+import { Register } from '~app-toolkit/decorators';
+import { CaskProtocolWalletTokenFetcher } from '../common/cask-protocol.wallet.token-fetcher';
+import { Network } from '~types/network.interface';
+
+import { CASK_PROTOCOL_DEFINITION } from '../cask-protocol.definition';
+
+const appId = CASK_PROTOCOL_DEFINITION.id;
+const groupId = CASK_PROTOCOL_DEFINITION.groups.wallet.id;
+const network = Network.ARBITRUM_MAINNET;
+
+@Register.TokenPositionFetcher({ appId, groupId, network })
+export class ArbitrumCaskProtocolWalletTokenFetcher extends CaskProtocolWalletTokenFetcher {
+  caskVaultContractAddress = '0x20151ff7fdd720b85063d02081aa5b7876adff7b';
+  caskNetwork = Network.ARBITRUM_MAINNET;
+}

src/apps/cask-protocol/aurora/cask-protocol.wallet.token-fetcher.ts

@@ -0,0 +1,15 @@
+import { Register } from '~app-toolkit/decorators';
+import { CaskProtocolWalletTokenFetcher } from '../common/cask-protocol.wallet.token-fetcher';
+import { Network } from '~types/network.interface';
+
+import { CASK_PROTOCOL_DEFINITION } from '../cask-protocol.definition';
+
+const appId = CASK_PROTOCOL_DEFINITION.id;
+const groupId = CASK_PROTOCOL_DEFINITION.groups.wallet.id;
+const network = Network.AURORA_MAINNET;
+
+@Register.TokenPositionFetcher({ appId, groupId, network })
+export class AuroraCaskProtocolWalletTokenFetcher extends CaskProtocolWalletTokenFetcher {
+  caskVaultContractAddress = '0x3b2b4b547dAEEbf3A703288CB43650f0F287b9ff';
+  caskNetwork = Network.AURORA_MAINNET;
+}

src/apps/cask-protocol/avalanche/cask-protocol.wallet.token-fetcher.ts

@@ -0,0 +1,15 @@
+import { Register } from '~app-toolkit/decorators';
+import { CaskProtocolWalletTokenFetcher } from '../common/cask-protocol.wallet.token-fetcher';
+import { Network } from '~types/network.interface';
+
+import { CASK_PROTOCOL_DEFINITION } from '../cask-protocol.definition';
+
+const appId = CASK_PROTOCOL_DEFINITION.id;
+const groupId = CASK_PROTOCOL_DEFINITION.groups.wallet.id;
+const network = Network.AVALANCHE_MAINNET;
+
+@Register.TokenPositionFetcher({ appId, groupId, network })
+export class AvalancheCaskProtocolWalletTokenFetcher extends CaskProtocolWalletTokenFetcher {
+  caskVaultContractAddress = '0x3b2b4b547dAEEbf3A703288CB43650f0F287b9ff';
+  caskNetwork = Network.AVALANCHE_MAINNET;
+}

src/apps/cask-protocol/binance-smart-chain/cask-protocol.wallet.token-fetcher.ts

@@ -0,0 +1,15 @@
+import { Register } from '~app-toolkit/decorators';
+import { CaskProtocolWalletTokenFetcher } from '../common/cask-protocol.wallet.token-fetcher';
+import { Network } from '~types/network.interface';
+
+import { CASK_PROTOCOL_DEFINITION } from '../cask-protocol.definition';
+
+const appId = CASK_PROTOCOL_DEFINITION.id;
+const groupId = CASK_PROTOCOL_DEFINITION.groups.wallet.id;
+const network = Network.BINANCE_SMART_CHAIN_MAINNET;
+
+@Register.TokenPositionFetcher({ appId, groupId, network })
+export class BNBChainCaskProtocolWalletTokenFetcher extends CaskProtocolWalletTokenFetcher {
+  caskVaultContractAddress = '0x3b2b4b547dAEEbf3A703288CB43650f0F287b9ff';
+  caskNetwork = Network.BINANCE_SMART_CHAIN_MAINNET;
+}

src/apps/cask-protocol/cask-protocol.definition.ts

@@ -0,0 +1,44 @@
+import { Register } from '~app-toolkit/decorators';
+import { appDefinition, AppDefinition } from '~app/app.definition';
+import { AppAction, AppTag, GroupType } from '~app/app.interface';
+import { Network } from '~types/network.interface';
+
+export const CASK_PROTOCOL_DEFINITION = appDefinition({
+  id: 'cask-protocol',
+  name: 'Cask Protocol',
+  description: 'Automation protocol for web3, including subscriptions, auto-investing and protocol top-ups.',
+  url: 'https://app.cask.fi/',
+
+  groups: {
+    wallet: {
+      id: 'wallet',
+      type: GroupType.TOKEN,
+      label: 'Cask Wallet',
+    },
+  },
+
+  tags: [AppTag.PAYMENTS],
+  keywords: [],
+  links: {},
+
+  supportedNetworks: {
+    [Network.POLYGON_MAINNET]: [AppAction.VIEW],
+    [Network.OPTIMISM_MAINNET]: [AppAction.VIEW],
+    [Network.GNOSIS_MAINNET]: [AppAction.VIEW],
+    [Network.BINANCE_SMART_CHAIN_MAINNET]: [AppAction.VIEW],
+    [Network.FANTOM_OPERA_MAINNET]: [AppAction.VIEW],
+    [Network.AVALANCHE_MAINNET]: [AppAction.VIEW],
+    [Network.ARBITRUM_MAINNET]: [AppAction.VIEW],
+    [Network.CELO_MAINNET]: [AppAction.VIEW],
+    [Network.AURORA_MAINNET]: [AppAction.VIEW],
+  },
+
+  primaryColor: '#fff',
+});
+
+@Register.AppDefinition(CASK_PROTOCOL_DEFINITION.id)
+export class CaskProtocolAppDefinition extends AppDefinition {
+  constructor() {
+    super(CASK_PROTOCOL_DEFINITION);
+  }
+}

src/apps/cask-protocol/cask-protocol.module.ts

@@ -0,0 +1,34 @@
+import { Register } from '~app-toolkit/decorators';
+import { AbstractApp } from '~app/app.dynamic-module';
+
+import { ArbitrumCaskProtocolWalletTokenFetcher } from './arbitrum/cask-protocol.wallet.token-fetcher';
+import { AuroraCaskProtocolWalletTokenFetcher } from './aurora/cask-protocol.wallet.token-fetcher';
+import { AvalancheCaskProtocolWalletTokenFetcher } from './avalanche/cask-protocol.wallet.token-fetcher';
+import { BNBChainCaskProtocolWalletTokenFetcher } from './binance-smart-chain/cask-protocol.wallet.token-fetcher';
+import { CeloCaskProtocolWalletTokenFetcher } from './celo/cask-protocol.wallet.token-fetcher';
+import { FantomCaskProtocolWalletTokenFetcher } from './fantom/cask-protocol.wallet.token-fetcher';
+import { GnosisCaskProtocolWalletTokenFetcher } from './gnosis/cask-protocol.wallet.token-fetcher';
+import { OptimismCaskProtocolWalletTokenFetcher } from './optimism/cask-protocol.wallet.token-fetcher';
+import { PolygonCaskProtocolWalletTokenFetcher } from './polygon/cask-protocol.wallet.token-fetcher';
+
+import { CaskProtocolAppDefinition, CASK_PROTOCOL_DEFINITION } from './cask-protocol.definition';
+import { CaskProtocolContractFactory } from './contracts';
+
+@Register.AppModule({
+  appId: CASK_PROTOCOL_DEFINITION.id,
+  providers: [
+      ArbitrumCaskProtocolWalletTokenFetcher,
+      AuroraCaskProtocolWalletTokenFetcher,
+      AvalancheCaskProtocolWalletTokenFetcher,
+      BNBChainCaskProtocolWalletTokenFetcher,
+      CeloCaskProtocolWalletTokenFetcher,
+      FantomCaskProtocolWalletTokenFetcher,
+      GnosisCaskProtocolWalletTokenFetcher,
+      OptimismCaskProtocolWalletTokenFetcher,
+      PolygonCaskProtocolWalletTokenFetcher,
+
+      CaskProtocolAppDefinition,
+      CaskProtocolContractFactory
+  ],
+})
+export class CaskProtocolAppModule extends AbstractApp() {}

src/apps/cask-protocol/celo/cask-protocol.wallet.token-fetcher.ts

@@ -0,0 +1,15 @@
+import { Register } from '~app-toolkit/decorators';
+import { CaskProtocolWalletTokenFetcher } from '../common/cask-protocol.wallet.token-fetcher';
+import { Network } from '~types/network.interface';
+
+import { CASK_PROTOCOL_DEFINITION } from '../cask-protocol.definition';
+
+const appId = CASK_PROTOCOL_DEFINITION.id;
+const groupId = CASK_PROTOCOL_DEFINITION.groups.wallet.id;
+const network = Network.CELO_MAINNET;
+
+@Register.TokenPositionFetcher({ appId, groupId, network })
+export class CeloCaskProtocolWalletTokenFetcher extends CaskProtocolWalletTokenFetcher {
+  caskVaultContractAddress = '0xBCcDbB0806Acc914F6746DE592f924B374190710';
+  caskNetwork = Network.CELO_MAINNET;
+}

src/apps/cask-protocol/common/cask-protocol.wallet.token-fetcher.ts

@@ -0,0 +1,42 @@
+import { Inject } from '@nestjs/common';
+
+import { IAppToolkit, APP_TOOLKIT } from '~app-toolkit/app-toolkit.interface';
+import { PositionFetcher } from '~position/position-fetcher.interface';
+import { AppTokenPosition } from '~position/position.interface';
+import { Network } from '~types/network.interface';
+
+import { CASK_PROTOCOL_DEFINITION } from '../cask-protocol.definition';
+import {CaskProtocolContractFactory, CaskVaultToken} from '../contracts';
+
+export class CaskProtocolWalletTokenFetcher implements PositionFetcher<AppTokenPosition> {
+  caskVaultContractAddress: string;
+  caskNetwork: Network;
+
+  constructor(
+    @Inject(APP_TOOLKIT) private readonly appToolkit: IAppToolkit,
+    @Inject(CaskProtocolContractFactory) private readonly caskProtocolContractFactory: CaskProtocolContractFactory,
+  ) {}
+
+  async getPositions() {
+    return this.appToolkit.helpers.vaultTokenHelper.getTokens<CaskVaultToken>({
+      appId: CASK_PROTOCOL_DEFINITION.id,
+      groupId: CASK_PROTOCOL_DEFINITION.groups.wallet.id,
+      network: this.caskNetwork,
+      resolveContract: ({ address, network }) =>
+          this.caskProtocolContractFactory.caskVaultToken({ address, network }),
+      resolveVaultAddresses: () => [this.caskVaultContractAddress],
+      resolveUnderlyingTokenAddress: ({ contract, multicall }) =>
+          multicall.wrap(contract).getBaseAsset(),
+      resolveReserve: async ({ contract, underlyingToken, multicall}) =>
+        multicall
+            .wrap(contract)
+            .totalValue()
+            .then((v) => Number(v) / 10 ** underlyingToken.decimals),
+      resolvePricePerShare: ({ contract, underlyingToken, multicall }) =>
+          multicall
+              .wrap(contract)
+              .pricePerShare()
+              .then((v) => Number(v) / 10 ** underlyingToken.decimals),
+    });
+  }
+}