(Deposit/Withdrawal) Fetch Bridge Provider Quote

packages/bridge/src/axelar/__tests__/axelar-bridge-provider.spec.ts

@@ -4,14 +4,14 @@ import {
   AxelarQueryAPI,
 } from "@axelar-network/axelarjs-sdk";
 import { estimateGasFee } from "@osmosis-labs/tx";
+import { NativeEVMTokenConstantAddress } from "@osmosis-labs/utils";
 import { CacheEntry } from "cachified";
 import { LRUCache } from "lru-cache";
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { rest } from "msw";
 
 import { MockAssetLists } from "../../__tests__/mock-asset-lists";
 import { server } from "../../__tests__/msw";
-import { NativeEVMTokenConstantAddress } from "../../ethereum";
 import { BridgeProviderContext } from "../../interface";
 import { AxelarBridgeProvider } from "../index";
 import {

packages/bridge/src/axelar/index.ts

@@ -8,9 +8,11 @@ import { ibcProtoRegistry } from "@osmosis-labs/proto-codecs";
 import { estimateGasFee } from "@osmosis-labs/tx";
 import type { IbcTransferMethod } from "@osmosis-labs/types";
 import {
+  EthereumChainInfo,
   getAssetFromAssetList,
   getKeyByValue,
   isNil,
+  NativeEVMTokenConstantAddress,
 } from "@osmosis-labs/utils";
 import { cachified } from "cachified";
 import {
@@ -23,7 +25,6 @@ import {
 } from "viem";
 
 import { BridgeQuoteError } from "../errors";
-import { EthereumChainInfo, NativeEVMTokenConstantAddress } from "../ethereum";
 import {
   BridgeAsset,
   BridgeChain,

packages/bridge/src/axelar/tokens.ts

@@ -1,10 +1,10 @@
-import { SourceChain } from "../chain";
-import { EthereumChainInfo } from "../ethereum";
+import { AxelarSourceChain, EthereumChainInfo } from "@osmosis-labs/utils";
+
 import { BridgeEnvironment } from "../interface";
 
 export type SourceChainTokenConfig = {
   /** Source Chain identifier. */
-  id: SourceChain;
+  id: AxelarSourceChain;
   chainId?: number;
   /** Address of origin ERC20 token for that origin chain. Leave blank to
    *  prefer native ETH currency if `id` is not a Cosmos chain in `ChainInfo`.

packages/bridge/src/index.ts

@@ -1,6 +1,5 @@
 export * from "./axelar";
 export * from "./bridge-providers";
-export * from "./chain";
 export * from "./errors";
 export * from "./interface";
 export * from "./skip";

packages/bridge/src/interface.ts

@@ -139,7 +139,10 @@ const evmChainSchema = z.object({
   chainType: z.literal("evm"),
 });
 
-const bridgeChainSchema = z.union([cosmosChainSchema, evmChainSchema]);
+export const bridgeChainSchema = z.discriminatedUnion("chainType", [
+  cosmosChainSchema,
+  evmChainSchema,
+]);
 
 export type BridgeChain = z.infer<typeof bridgeChainSchema>;
 
@@ -154,7 +157,7 @@ export interface BridgeStatus {
   maintenanceMessage?: string;
 }
 
-const bridgeAssetSchema = z.object({
+export const bridgeAssetSchema = z.object({
   /**
    * The denomination of the asset.
    */
@@ -176,7 +179,7 @@ const bridgeAssetSchema = z.object({
 
 export type BridgeAsset = z.infer<typeof bridgeAssetSchema>;
 
-const bridgeSupportedAssetsSchema = z.object({
+export const bridgeSupportedAssetsSchema = z.object({
   /**
    * The originating chain information.
    */

packages/bridge/src/skip/index.ts

@@ -4,7 +4,11 @@ import { CoinPretty } from "@keplr-wallet/unit";
 import { ibcProtoRegistry } from "@osmosis-labs/proto-codecs";
 import { estimateGasFee } from "@osmosis-labs/tx";
 import { CosmosCounterparty, EVMCounterparty } from "@osmosis-labs/types";
-import { isNil } from "@osmosis-labs/utils";
+import {
+  EthereumChainInfo,
+  isNil,
+  NativeEVMTokenConstantAddress,
+} from "@osmosis-labs/utils";
 import cachified from "cachified";
 import {
   Address,
@@ -19,7 +23,6 @@ import {
 } from "viem";
 
 import { BridgeQuoteError } from "../errors";
-import { EthereumChainInfo, NativeEVMTokenConstantAddress } from "../ethereum";
 import {
   BridgeAsset,
   BridgeChain,
@@ -331,6 +334,7 @@ export class SkipBridgeProvider implements BridgeProvider {
             ...chainInfo,
             address: sharedOriginAsset.denom,
             denom:
+              sharedOriginAsset.recommended_symbol ??
               sharedOriginAsset.symbol ??
               sharedOriginAsset.name ??
               sharedOriginAsset.denom,
@@ -773,9 +777,9 @@ export class SkipBridgeProvider implements BridgeProvider {
 
     const url = new URL("https://ibc.fun/");
     url.searchParams.set("src_chain", String(fromChain.chainId));
-    url.searchParams.set("src_asset", fromAsset.address);
+    url.searchParams.set("src_asset", fromAsset.address.toLowerCase());
     url.searchParams.set("dest_chain", String(toChain.chainId));
-    url.searchParams.set("dest_asset", toAsset.address);
+    url.searchParams.set("dest_asset", toAsset.address.toLowerCase());
 
     return { urlProviderName: "IBC.fun", url };
   }

packages/bridge/src/squid/index.ts

@@ -8,7 +8,13 @@ import {
 } from "@0xsquid/sdk";
 import { CoinPretty, Dec } from "@keplr-wallet/unit";
 import { CosmosCounterparty, EVMCounterparty } from "@osmosis-labs/types";
-import { apiClient, ApiClientError, isNil } from "@osmosis-labs/utils";
+import {
+  apiClient,
+  ApiClientError,
+  EthereumChainInfo,
+  isNil,
+  NativeEVMTokenConstantAddress,
+} from "@osmosis-labs/utils";
 import { cachified } from "cachified";
 import Long from "long";
 import {
@@ -21,7 +27,6 @@ import {
 } from "viem";
 
 import { BridgeQuoteError } from "../errors";
-import { EthereumChainInfo, NativeEVMTokenConstantAddress } from "../ethereum";
 import {
   BridgeAsset,
   BridgeChain,

packages/server/package.json

@@ -45,7 +45,8 @@
     "jest-util": "^29.7.0",
     "lru-cache": "^10.0.1",
     "superjson": "^2.2.1",
-    "zod": "^3.22.4"
+    "zod": "^3.22.4",
+    "viem": "2.13.3"
   },
   "devDependencies": {
     "@types/jest-in-case": "^1.0.6",

packages/server/src/queries/complex/assets/__tests__/assets.spec.ts

@@ -1,5 +1,5 @@
 import { AssetLists as MockAssetLists } from "../../../__tests__/mock-asset-lists";
-import { getAsset, getAssets } from "../index";
+import { getAsset, getAssets, getAssetWithVariants } from "../index";
 
 describe("getAssets", () => {
   describe("search", () => {
@@ -85,3 +85,134 @@ describe("getAsset", () => {
     ).toThrow();
   });
 });
+
+describe("getAssetWithVariants", () => {
+  it("should return the asset with its variants, with the canonical asset first", () => {
+    const result = getAssetWithVariants({
+      assetLists: MockAssetLists,
+      anyDenom: "USDC",
+    });
+
+    expect(result).toMatchInlineSnapshot(`
+      [
+        {
+          "coinDecimals": 6,
+          "coinDenom": "USDC",
+          "coinGeckoId": "usd-coin",
+          "coinImageUrl": "/tokens/generated/usdc.svg",
+          "coinMinimalDenom": "ibc/498A0751C798A0D9A389AA3691123DADA57DAA4FE165D5C75894505B876BA6E4",
+          "coinName": "USDC",
+          "isUnstable": false,
+          "isVerified": true,
+          "sourceDenom": "uusdc",
+          "variantGroupKey": "USDC",
+        },
+        {
+          "coinDecimals": 6,
+          "coinDenom": "USDC.axl",
+          "coinGeckoId": "axlusdc",
+          "coinImageUrl": "/tokens/generated/usdc.axl.svg",
+          "coinMinimalDenom": "ibc/D189335C6E4A68B513C10AB227BF1C1D38C746766278BA3EEB4FB14124F1D858",
+          "coinName": "USD Coin (Axelar)",
+          "isUnstable": false,
+          "isVerified": true,
+          "sourceDenom": "uusdc",
+          "variantGroupKey": "USDC",
+        },
+        {
+          "coinDecimals": 6,
+          "coinDenom": "polygon.USDC.axl",
+          "coinGeckoId": "usd-coin",
+          "coinImageUrl": "/tokens/generated/polygon.usdc.axl.svg",
+          "coinMinimalDenom": "ibc/231FD77ECCB2DB916D314019DA30FE013202833386B1908A191D16989AD80B5A",
+          "coinName": "USD Coin (Polygon)",
+          "isUnstable": false,
+          "isVerified": true,
+          "sourceDenom": "polygon-uusdc",
+          "variantGroupKey": "USDC",
+        },
+        {
+          "coinDecimals": 6,
+          "coinDenom": "avalanche.USDC.axl",
+          "coinGeckoId": "usd-coin",
+          "coinImageUrl": "/tokens/generated/avalanche.usdc.axl.svg",
+          "coinMinimalDenom": "ibc/F17C9CA112815613C5B6771047A093054F837C3020CBA59DFFD9D780A8B2984C",
+          "coinName": "USD Coin (Avalanche)",
+          "isUnstable": false,
+          "isVerified": true,
+          "sourceDenom": "avalanche-uusdc",
+          "variantGroupKey": "USDC",
+        },
+        {
+          "coinDecimals": 6,
+          "coinDenom": "USDC.grv",
+          "coinGeckoId": "gravity-bridge-usdc",
+          "coinImageUrl": "/tokens/generated/usdc.grv.svg",
+          "coinMinimalDenom": "ibc/9F9B07EF9AD291167CF5700628145DE1DEB777C2CFC7907553B24446515F6D0E",
+          "coinName": "USDC (Gravity Bridge)",
+          "isUnstable": false,
+          "isVerified": true,
+          "sourceDenom": "gravity0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+          "variantGroupKey": "USDC",
+        },
+        {
+          "coinDecimals": 6,
+          "coinDenom": "USDC.wh",
+          "coinGeckoId": undefined,
+          "coinImageUrl": "/tokens/generated/usdc.wh.svg",
+          "coinMinimalDenom": "ibc/6B99DB46AA9FF47162148C1726866919E44A6A5E0274B90912FD17E19A337695",
+          "coinName": "USD Coin (Wormhole)",
+          "isUnstable": false,
+          "isVerified": true,
+          "sourceDenom": "factory/wormhole14ejqjyq8um4p3xfqj74yld5waqljf88fz25yxnma0cngspxe3les00fpjx/GGh9Ufn1SeDGrhzEkMyRKt5568VbbxZK2yvWNsd6PbXt",
+          "variantGroupKey": "USDC",
+        },
+        {
+          "coinDecimals": 6,
+          "coinDenom": "solana.USDC.wh",
+          "coinGeckoId": undefined,
+          "coinImageUrl": "/tokens/generated/solana.usdc.wh.svg",
+          "coinMinimalDenom": "ibc/F08DE332018E8070CC4C68FE06E04E254F527556A614F5F8F9A68AF38D367E45",
+          "coinName": "Solana USD Coin (Wormhole)",
+          "isUnstable": false,
+          "isVerified": true,
+          "sourceDenom": "factory/wormhole14ejqjyq8um4p3xfqj74yld5waqljf88fz25yxnma0cngspxe3les00fpjx/HJk1XMDRNUbRrpKkNZYui7SwWDMjXZAsySzqgyNcQoU3",
+          "variantGroupKey": "USDC",
+        },
+      ]
+    `);
+  });
+
+  it("should throw an error if the asset is not found", () => {
+    expect(() =>
+      getAssetWithVariants({
+        assetLists: MockAssetLists,
+        anyDenom: "unotexist",
+      })
+    ).toThrow("unotexist not found in asset list");
+  });
+
+  it("Should still return assets even if they have no variants", () => {
+    expect(
+      getAssetWithVariants({
+        assetLists: MockAssetLists,
+        anyDenom: "ATOM",
+      })
+    ).toMatchInlineSnapshot(`
+      [
+        {
+          "coinDecimals": 6,
+          "coinDenom": "ATOM",
+          "coinGeckoId": "cosmos",
+          "coinImageUrl": "/tokens/generated/atom.svg",
+          "coinMinimalDenom": "ibc/27394FB092D2ECCD56123C74F36E4C1F926001CEADA9CA97EA622B25F41E5EB2",
+          "coinName": "Cosmos Hub",
+          "isUnstable": false,
+          "isVerified": true,
+          "sourceDenom": "uatom",
+          "variantGroupKey": "ATOM",
+        },
+      ]
+    `);
+  });
+});

packages/server/src/queries/complex/assets/bridge.ts

@@ -1,6 +1,8 @@
-import { Asset as AssetListAsset, AssetList } from "@osmosis-labs/types";
-
-import { Asset } from ".";
+import {
+  Asset as AssetListAsset,
+  AssetList,
+  MinimalAsset,
+} from "@osmosis-labs/types";
 
 /** A bridgeable asset. */
 export type BridgeAsset = {
@@ -11,7 +13,7 @@ export type BridgeAsset = {
 /** Appends bridge info to a given asset. If asset is not found in asset list, empty bridge info will be returned.
  *  @throws if a given asset is not found in asset list.
  */
-export function getBridgeAsset<TAsset extends Asset>(
+export function getBridgeAsset<TAsset extends MinimalAsset>(
   assetLists: AssetList[],
   asset: TAsset
 ): TAsset & BridgeAsset {

packages/server/src/queries/complex/assets/ethereum.ts

@@ -0,0 +1,40 @@
+import {
+  EthereumChainInfo,
+  NativeEVMTokenConstantAddress,
+} from "@osmosis-labs/utils";
+import { Address, createPublicClient, erc20Abi, http } from "viem";
+
+export async function getEvmBalance({
+  address,
+  userAddress,
+  chainId,
+}: {
+  address: string;
+  userAddress: string;
+  chainId: number;
+}) {
+  const evmChain = Object.values(EthereumChainInfo).find(
+    (chain) => String(chain.id) === String(chainId)
+  );
+
+  if (!evmChain) {
+    throw new Error(`Chain with id ${chainId} not found`);
+  }
+
+  const publicClient = createPublicClient({
+    chain: evmChain,
+    transport: http(evmChain.rpcUrls.default.http[0]),
+  });
+
+  const balance =
+    address === NativeEVMTokenConstantAddress
+      ? await publicClient.getBalance({ address: userAddress as Address })
+      : await publicClient.readContract({
+          abi: erc20Abi,
+          address: address as Address,
+          functionName: "balanceOf",
+          args: [userAddress as Address],
+        });
+
+  return balance;
+}