@swapkit/helpers 2.7.7 → 2.8.0

package/src/helpers/liquidity.ts

@@ -95,8 +95,12 @@ export function getSymmetricPoolShare({
   assetDepth: string;
 }>) {
   return {
-    assetAmount: toTCSwapKitNumber(assetDepth).mul(liquidityUnits).div(poolUnits),
-    runeAmount: toTCSwapKitNumber(runeDepth).mul(liquidityUnits).div(poolUnits),
+    assetAmount: toTCSwapKitNumber(assetDepth)
+      .mul(liquidityUnits)
+      .div(poolUnits || "1"),
+    runeAmount: toTCSwapKitNumber(runeDepth)
+      .mul(liquidityUnits)
+      .div(poolUnits || "1"),
   };
 }
 

package/src/modules/__tests__/assetValue.test.ts

@@ -13,7 +13,7 @@ describe("AssetValue", () => {
         symbol: "USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
       });
       expect(fakeAvaxUSDCAsset.toString()).toBe(
-        "AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
+        "AVAX.USDC-0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
       );
 
       const ethSynth = new AssetValue({
@@ -79,13 +79,15 @@ describe("AssetValue", () => {
 
       expect(atomDerived.toString()).toBe("THOR.ATOM");
 
+      const value = 10;
       const mayaCacao = AssetValue.from({
         asset: "MAYA.CACAO",
-        value: 10,
+        value,
       });
 
       expect(mayaCacao.toString()).toBe("MAYA.CACAO");
-      expect(mayaCacao.getBaseValue("string")).toBe("1000000000");
+      const expectedValue = value * 10_000_000_000;
+      expect(mayaCacao.getBaseValue("string")).toBe(expectedValue.toString());
 
       const ethMayaSynth = AssetValue.from({
         asset: "MAYA.ETH/ETH",
@@ -105,29 +107,38 @@ describe("AssetValue", () => {
       expect(ethTCSynthFallback.toString({ includeSynthProtocol: true })).toBe("THOR.ETH/ETH");
       expect(ethTCSynthFallback.getBaseValue("string")).toBe("1000000000");
 
-      // TODO:
-      // const radixXWBTC = new AssetValue({
-      //   identifier:
-      //     "RADIX.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
-      //   decimal: 8,
-      //   value: 11112222,
-      // });
-
-      // expect(radixXWBTC.toString()).toBe(
-      //   "RADIX.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
-      // )
+      const solFromString = AssetValue.from({ asset: "SOL.SOL" });
+      expect(solFromString.toString()).toBe("SOL.SOL");
+    });
+
+    test("regres cases", () => {
+      const arbWeth = AssetValue.from({
+        asset: "ARB.WETH-0x82aF49447D8a07e3bd95BD0d56f35241523fBab1",
+      });
+      expect(arbWeth.toString()).toBe("ARB.WETH-0x82aF49447D8a07e3bd95BD0d56f35241523fBab1");
+
+      const baseAssetFromString = AssetValue.from({
+        asset: "BASE.USDC-0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
+      });
+      expect(baseAssetFromString.toString()).toBe(
+        "BASE.USDC-0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+      );
+
+      const avaxSolanaAsset = AssetValue.from({
+        asset: "AVAX.SOL-0XFE6B19286885A4F7F55ADAD09C3CD1F906D2478F",
+      });
+      expect(avaxSolanaAsset.toString()).toBe(
+        "AVAX.SOL-0xFE6B19286885a4F7F55AdAD09C3Cd1f906D2478F",
+      );
     });
   });
 
   describe("set", () => {
     test("get a copy of an assetValue with a new value", () => {
-      const btc = AssetValue.from({
-        asset: "BTC.BTC",
-      });
+      const btc = AssetValue.from({ asset: "BTC.BTC" });
 
       const btc2 = btc.set(10);
 
-      expect(btc2).toBeDefined();
       expect(btc2).toEqual(
         expect.objectContaining({
           chain: Chain.Bitcoin,
@@ -179,11 +190,11 @@ describe("AssetValue", () => {
         symbol: "USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
       });
       expect(fakeAvaxUSDCAsset.toUrl()).toBe(
-        "AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
+        "AVAX.USDC-0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
       );
 
       const thor = AssetValue.from({ asset: "ETH.THOR" });
-      expect(thor.toUrl()).toBe("ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044");
+      expect(thor.toUrl()).toBe("ETH.THOR-0xa5f2211B9b8170F694421f2046281775E8468044");
 
       const ethSynth = new AssetValue({
         chain: Chain.THORChain,
@@ -288,13 +299,21 @@ describe("AssetValue", () => {
         chain: Chain.Avalanche,
         symbol: "USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
       });
-      expect(avaxUSDCAsset.toString()).toBe("AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e");
+      expect(avaxUSDCAsset.toString()).toBe("AVAX.USDC-0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E");
 
       const thor = AssetValue.from({ asset: "ETH.THOR" });
-      expect(thor.toString()).toBe("ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044");
+      expect(thor.toString()).toBe("ETH.THOR-0xa5f2211B9b8170F694421f2046281775E8468044");
 
-      const ethSynth = await AssetValue.from({ asset: "ETH/ETH", asyncTokenLookup: true });
+      const ethSynth = await AssetValue.from({
+        asset: "ETH/ETH",
+        asyncTokenLookup: true,
+      });
       expect(ethSynth.toString()).toBe("ETH/ETH");
+
+      const ethFromChain = await AssetValue.from({
+        chain: Chain.Ethereum,
+      });
+      expect(ethFromChain.toString()).toBe("ETH.ETH");
     });
   });
 
@@ -307,12 +326,12 @@ describe("AssetValue", () => {
 
       expect(avaxUSDCAsset).toEqual(
         expect.objectContaining({
-          address: "0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
+          address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
           chain: Chain.Avalanche,
           decimal: 6,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
+          symbol: "USDC-0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
           ticker: "USDC",
         }),
       );
@@ -441,7 +460,7 @@ describe("AssetValue", () => {
 
       expect(synthETH.toString()).toBe("ETH/ETH");
       expect(eth.toString()).toBe("ETH.ETH");
-      expect(thor.toString()).toBe("ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044");
+      expect(thor.toString()).toBe("ETH.THOR-0xa5f2211B9b8170F694421f2046281775E8468044");
       expect(synthThor.toString()).toBe("ETH/THOR-0xa5f2211b9b8170f694421f2046281775e8468044");
       expect(synthDashes.toString()).toBe("ETH/PENDLE-LPT-0x1234");
     });
@@ -457,12 +476,12 @@ describe("AssetValue", () => {
       expect(thor).toBeDefined();
       expect(thor).toEqual(
         expect.objectContaining({
-          address: "0xfd086bc7cd5c481dcc9c85ebe478a1c0b69fcbb9",
+          address: "0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9",
           chain: Chain.Arbitrum,
           decimal: 6,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "USDT-0xfd086bc7cd5c481dcc9c85ebe478a1c0b69fcbb9",
+          symbol: "USDT-0xFd086bC7CD5C481DCC9C85ebE478A1C0b69FCbb9",
           ticker: "USDT",
         }),
       );
@@ -479,12 +498,12 @@ describe("AssetValue", () => {
       expect(thor).toBeDefined();
       expect(thor).toEqual(
         expect.objectContaining({
-          address: "0xa5f2211b9b8170f694421f2046281775e8468044",
+          address: "0xa5f2211B9b8170F694421f2046281775E8468044",
           chain: Chain.Ethereum,
           decimal: 18,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "THOR-0xa5f2211b9b8170f694421f2046281775e8468044",
+          symbol: "THOR-0xa5f2211B9b8170F694421f2046281775E8468044",
           ticker: "THOR",
         }),
       );
@@ -495,12 +514,12 @@ describe("AssetValue", () => {
       expect(usdc).toBeDefined();
       expect(usdc).toEqual(
         expect.objectContaining({
-          address: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+          address: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
           chain: Chain.Ethereum,
           decimal: 6,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "USDC-0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
+          symbol: "USDC-0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
           ticker: "USDC",
         }),
       );
@@ -509,7 +528,9 @@ describe("AssetValue", () => {
     test("returns safe decimals if string is not in `@swapkit/tokens` lists", async () => {
       await AssetValue.loadStaticAssets();
       const fakeAvaxUSDCAssetString = "AVAX.USDC-1234";
-      const fakeAvaxUSDCAsset = AssetValue.from({ asset: fakeAvaxUSDCAssetString });
+      const fakeAvaxUSDCAsset = AssetValue.from({
+        asset: fakeAvaxUSDCAssetString,
+      });
 
       expect(fakeAvaxUSDCAsset).toBeDefined();
       expect(fakeAvaxUSDCAsset).toEqual(
@@ -528,7 +549,9 @@ describe("AssetValue", () => {
     test("returns safe decimals if string is not in `@swapkit/tokens` lists with multiple dashes", async () => {
       await AssetValue.loadStaticAssets();
       const fakeAvaxUSDCAssetString = "AVAX.USDC-LPT-1234";
-      const fakeAvaxUSDCAsset2 = AssetValue.from({ asset: fakeAvaxUSDCAssetString });
+      const fakeAvaxUSDCAsset2 = AssetValue.from({
+        asset: fakeAvaxUSDCAssetString,
+      });
 
       expect(fakeAvaxUSDCAsset2).toBeDefined();
       expect(fakeAvaxUSDCAsset2).toEqual(
@@ -552,12 +575,12 @@ describe("AssetValue", () => {
       expect(AvaxBTCb).toBeDefined();
       expect(AvaxBTCb).toEqual(
         expect.objectContaining({
-          address: "0x152b9d0fdc40c096757f570a51e494bd4b943e50",
+          address: "0x152b9d0FdC40C096757F570A51E494bd4b943E50",
           chain: Chain.Avalanche,
           decimal: 8,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "BTC.b-0x152b9d0fdc40c096757f570a51e494bd4b943e50",
+          symbol: "BTC.B-0x152b9d0FdC40C096757F570A51E494bd4b943E50",
           ticker: "BTC.b",
         }),
       );
@@ -627,12 +650,12 @@ describe("AssetValue", () => {
       expect(AvaxUSDC).toBeDefined();
       expect(AvaxUSDC).toEqual(
         expect.objectContaining({
-          address: "0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
+          address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
           chain: Chain.Avalanche,
           decimal: 6,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
+          symbol: "USDC-0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
           ticker: "USDC",
         }),
       );
@@ -703,12 +726,12 @@ describe("AssetValue", () => {
       const thor = AssetValue.from({ asset: "ETH.THOR" });
       expect(thor).toEqual(
         expect.objectContaining({
-          address: "0xa5f2211b9b8170f694421f2046281775e8468044",
+          address: "0xa5f2211B9b8170F694421f2046281775E8468044",
           chain: Chain.Ethereum,
           decimal: 18,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "THOR-0xa5f2211b9b8170f694421f2046281775e8468044",
+          symbol: "THOR-0xa5f2211B9b8170F694421f2046281775E8468044",
           ticker: "THOR",
         }),
       );
@@ -758,12 +781,10 @@ describe("AssetValue", () => {
       const xrdAsset = AssetValue.from({ chain: Chain.Radix });
       expect(xrdAsset).toEqual(
         expect.objectContaining({
-          address: undefined,
           chain: Chain.Radix,
           decimal: BaseDecimal.XRD,
           isGasAsset: true,
           isSynthetic: false,
-          symbol: "XRD",
           ticker: "XRD",
           type: "Native",
         }),

package/src/modules/assetValue.ts

@@ -1,3 +1,4 @@
+import { getAddress } from "ethers";
 import {
   type CommonAssetString,
   CommonAssetStrings,
@@ -8,7 +9,14 @@ import {
 } from "../helpers/asset";
 import { warnOnce } from "../helpers/others";
 import { validateIdentifier } from "../helpers/validators";
-import { BaseDecimal, Chain, type ChainId, ChainToChainId } from "../types/chains";
+import {
+  BaseDecimal,
+  Chain,
+  type ChainId,
+  ChainToChainId,
+  type EVMChain,
+  EVMChains,
+} from "../types/chains";
 import type { TokenNames, TokenTax } from "../types/tokens";
 
 import type { NumberPrimitives } from "./bigIntArithmetics";
@@ -379,15 +387,28 @@ function getAssetInfo(identifier: string) {
 
   const address = chain === Chain.Solana ? unformattedAddress : unformattedAddress?.toLowerCase();
 
+  let formattedAddress: string | undefined;
+
+  try {
+    formattedAddress =
+      address && EVMChains.includes(chain as EVMChain) && getAddress(address)
+        ? getAddress(address)
+        : address;
+  } catch (_error) {
+    formattedAddress = address;
+  }
+
+  const formattedSymbol =
+    (isSynthOrTradeAsset ? `${synthChain}${assetSeperator}` : "") +
+    (formattedAddress ? `${ticker.toUpperCase()}-${formattedAddress ?? ""}` : symbol);
+
   return {
-    address,
+    address: formattedAddress,
     chain,
     isGasAsset: isGasAsset({ chain, symbol }),
     isSynthetic,
     isTradeAsset,
     ticker,
-    symbol:
-      (isSynthOrTradeAsset ? `${synthChain}${assetSeperator}` : "") +
-      (address ? `${ticker}-${address ?? ""}` : symbol),
+    symbol: formattedSymbol,
   };
 }