Mattupham/fe 725 porfolio v3 variants detected popup

packages/server/src/queries/complex/portfolio/__tests__/allocation.spec.ts

@@ -1,6 +1,9 @@
+import { Asset } from "@osmosis-labs/types";
+
 import { AssetLists as assetLists } from "../../../../queries/__tests__/mock-asset-lists";
 import { AllocationResponse } from "../../../sidecar/allocation";
 import { calculatePercentAndFiatValues, getAll } from "../allocation";
+import { checkHasAssetVariants } from "../allocation";
 
 const MOCK_DATA: AllocationResponse = {
   categories: {
@@ -185,3 +188,211 @@ describe("Allocation Functions", () => {
     });
   });
 });
+
+const ASSET_OSMO: Asset = {
+  chainName: "osmosis",
+  sourceDenom: "uosmo",
+  coinMinimalDenom: "uosmo",
+  symbol: "OSMO",
+  decimals: 6,
+  logoURIs: {
+    png: "https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/images/osmo.png",
+    svg: "https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/images/osmo.svg",
+  },
+  coingeckoId: "osmosis",
+  price: {
+    poolId: "1464",
+    denom:
+      "ibc/498A0751C798A0D9A389AA3691123DADA57DAA4FE165D5C75894505B876BA6E4",
+  },
+  categories: ["defi"],
+  transferMethods: [],
+  counterparty: [],
+  variantGroupKey: "uosmo",
+  name: "Osmosis",
+  isAlloyed: false,
+  verified: true,
+  unstable: false,
+  disabled: false,
+  preview: false,
+  relative_image_url: "/tokens/generated/osmo.svg",
+};
+
+const ASSET_SAIL: Asset = {
+  chainName: "osmosis",
+  sourceDenom:
+    "factory/osmo1rckme96ptawr4zwexxj5g5gej9s2dmud8r2t9j0k0prn5mch5g4snzzwjv/sail",
+  coinMinimalDenom:
+    "factory/osmo1rckme96ptawr4zwexxj5g5gej9s2dmud8r2t9j0k0prn5mch5g4snzzwjv/sail",
+  symbol: "SAIL",
+  decimals: 6,
+  logoURIs: {
+    png: "https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/images/sail.png",
+  },
+  coingeckoId: "sail-dao",
+  price: {
+    poolId: "1745",
+    denom: "uosmo",
+  },
+  categories: ["sail_initiative"],
+  transferMethods: [],
+  counterparty: [],
+  variantGroupKey:
+    "factory/osmo1rckme96ptawr4zwexxj5g5gej9s2dmud8r2t9j0k0prn5mch5g4snzzwjv/sail",
+  name: "Sail",
+  isAlloyed: false,
+  verified: true,
+  unstable: false,
+  disabled: false,
+  preview: false,
+  listingDate: "2024-03-14T22:20:00.000Z",
+  relative_image_url: "/tokens/generated/sail.png",
+};
+
+const ASSET_ETH_AXL: Asset = {
+  chainName: "axelar",
+  sourceDenom: "weth-wei",
+  coinMinimalDenom:
+    "ibc/EA1D43981D5C9A1C4AAEA9C23BB1D4FA126BA9BC7020A25E0AE4AA841EA25DC5",
+  symbol: "ETH.axl",
+  decimals: 18,
+  logoURIs: {
+    png: "https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/images/eth.axl.png",
+    svg: "https://raw.githubusercontent.com/cosmos/chain-registry/master/osmosis/images/eth.axl.svg",
+  },
+  price: {
+    poolId: "1431",
+    denom:
+      "ibc/2F21E6D4271DE3F561F20A02CD541DAF7405B1E9CB3B9B07E3C2AC7D8A4338A5",
+  },
+  categories: [],
+  transferMethods: [
+    {
+      name: "Satellite",
+      type: "external_interface",
+      depositUrl:
+        "https://satellite.money/?source=ethereum&destination=osmosis&asset_denom=weth-wei",
+      withdrawUrl:
+        "https://satellite.money/?source=osmosis&destination=ethereum&asset_denom=weth-wei",
+    },
+    {
+      name: "Osmosis IBC Transfer",
+      type: "ibc",
+      counterparty: {
+        chainName: "axelar",
+        chainId: "axelar-dojo-1",
+        sourceDenom: "weth-wei",
+        port: "transfer",
+        channelId: "channel-3",
+      },
+      chain: {
+        port: "transfer",
+        channelId: "channel-208",
+        path: "transfer/channel-208/weth-wei",
+      },
+    },
+  ],
+  counterparty: [
+    {
+      chainName: "axelar",
+      sourceDenom: "weth-wei",
+      chainType: "cosmos",
+      chainId: "axelar-dojo-1",
+      symbol: "WETH",
+      decimals: 18,
+      logoURIs: {
+        png: "https://raw.githubusercontent.com/cosmos/chain-registry/master/axelar/images/weth.png",
+      },
+    },
+    {
+      chainName: "ethereum",
+      sourceDenom: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
+      chainType: "evm",
+      chainId: 1,
+      address: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
+      symbol: "WETH",
+      decimals: 18,
+      logoURIs: {
+        svg: "https://raw.githubusercontent.com/cosmos/chain-registry/master/_non-cosmos/ethereum/images/weth.svg",
+      },
+    },
+    {
+      chainName: "ethereum",
+      sourceDenom: "wei",
+      chainType: "evm",
+      chainId: 1,
+      address: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
+      symbol: "ETH",
+      decimals: 18,
+      logoURIs: {
+        png: "https://raw.githubusercontent.com/cosmos/chain-registry/master/_non-cosmos/ethereum/images/eth-white.png",
+        svg: "https://raw.githubusercontent.com/cosmos/chain-registry/master/_non-cosmos/ethereum/images/eth-white.svg",
+      },
+    },
+  ],
+  variantGroupKey:
+    "factory/osmo1k6c8jln7ejuqwtqmay3yvzrg3kueaczl96pk067ldg8u835w0yhsw27twm/alloyed/allETH",
+  name: "Ethereum (Axelar)",
+  isAlloyed: false,
+  verified: true,
+  unstable: false,
+  disabled: false,
+  preview: false,
+  sortWith: {
+    chainName: "axelar",
+    sourceDenom: "uaxl",
+  },
+  relative_image_url: "/tokens/generated/eth.axl.svg",
+};
+
+describe("Has Asset Variants", () => {
+  it("should return true when there are asset variants", () => {
+    const userCoinMinimalDenoms = [
+      "ibc/498A0751C798A0D9A389AA3691123DADA57DAA4FE165D5C75894505B876BA6E4", // OSMO
+      "factory/osmo1rckme96ptawr4zwexxj5g5gej9s2dmud8r2t9j0k0prn5mch5g4snzzwjv/sail", // SAIL
+      "ibc/EA1D43981D5C9A1C4AAEA9C23BB1D4FA126BA9BC7020A25E0AE4AA841EA25DC5", // ETH.axl <- this is the variant
+    ];
+    const assetListAssets: Asset[] = [
+      ASSET_OSMO, // OSMO
+      ASSET_SAIL, // SAIL
+      ASSET_ETH_AXL, // <- this is the variant
+    ];
+
+    const result = checkHasAssetVariants(
+      userCoinMinimalDenoms,
+      assetListAssets
+    );
+    expect(result).toBe(true);
+  });
+
+  it("should return false when there are no asset variants", () => {
+    const userCoinMinimalDenoms = [
+      "ibc/498A0751C798A0D9A389AA3691123DADA57DAA4FE165D5C75894505B876BA6E4", // OSMO
+      "factory/osmo1rckme96ptawr4zwexxj5g5gej9s2dmud8r2t9j0k0prn5mch5g4snzzwjv/sail", // SAIL
+    ];
+    const assetListAssets: Asset[] = [
+      ASSET_OSMO, // OSMO
+      ASSET_SAIL, // SAIL
+    ];
+
+    const result = checkHasAssetVariants(
+      userCoinMinimalDenoms,
+      assetListAssets
+    );
+    expect(result).toBe(false);
+  });
+
+  it("should return false when user has no assets", () => {
+    const userCoinMinimalDenoms: string[] = [];
+    const assetListAssets: Asset[] = [
+      ASSET_OSMO, // OSMO
+      ASSET_SAIL, // SAIL
+    ];
+
+    const result = checkHasAssetVariants(
+      userCoinMinimalDenoms,
+      assetListAssets
+    );
+    expect(result).toBe(false);
+  });
+});

packages/server/src/queries/complex/portfolio/allocation.ts

@@ -1,6 +1,6 @@
 import { CoinPretty, PricePretty } from "@keplr-wallet/unit";
 import { Dec, RatePretty } from "@keplr-wallet/unit";
-import { AssetList } from "@osmosis-labs/types";
+import { Asset, AssetList } from "@osmosis-labs/types";
 import { sort } from "@osmosis-labs/utils";
 
 import { DEFAULT_VS_CURRENCY } from "../../../queries/complex/assets/config";
@@ -173,3 +173,47 @@ export async function getAllocation({
     totalCap,
   };
 }
+
+export function checkHasAssetVariants(
+  userCoinMinimalDenoms: string[],
+  assetListAssets: Asset[]
+): boolean {
+  const assetMap = new Map(
+    assetListAssets.map((asset) => [asset.coinMinimalDenom, asset])
+  );
+
+  return userCoinMinimalDenoms.some((coinMinimalDenom) => {
+    const matchingAsset = assetMap.get(coinMinimalDenom);
+
+    return (
+      matchingAsset &&
+      matchingAsset.coinMinimalDenom !== matchingAsset.variantGroupKey
+    );
+  });
+}
+
+export async function getHasAssetVariants({
+  address,
+  assetLists,
+}: {
+  address: string;
+  assetLists: AssetList[];
+}): Promise<{ hasAssetVariants: boolean }> {
+  const data = await queryAllocation({
+    address,
+  });
+
+  const userCoinMinimalDenoms =
+    data?.categories?.["user-balances"]?.account_coins_result?.map(
+      (result) => result.coin.denom
+    ) ?? [];
+
+  const assetListAssets = assetLists.flatMap((list) => list.assets);
+
+  const hasAssetVariants = checkHasAssetVariants(
+    userCoinMinimalDenoms,
+    assetListAssets
+  );
+
+  return { hasAssetVariants };
+}

packages/trpc/src/portfolio.ts

@@ -1,5 +1,5 @@
 import { getPortfolioOverTime } from "@osmosis-labs/server";
-import { getAllocation } from "@osmosis-labs/server";
+import { getAllocation, getHasAssetVariants } from "@osmosis-labs/server";
 import { ChartPortfolioOverTimeResponse } from "@osmosis-labs/server/src/queries/complex/portfolio/portfolio";
 import { z } from "zod";
 
@@ -37,4 +37,18 @@ export const portfolioRouter = createTRPCRouter({
       });
       return res;
     }),
+
+  getHasAssetVariants: publicProcedure
+    .input(
+      z.object({
+        address: z.string(),
+      })
+    )
+    .query(async ({ input: { address }, ctx }) => {
+      const res = await getHasAssetVariants({
+        address,
+        assetLists: ctx.assetLists,
+      });
+      return res;
+    }),
 });