@swapkit/helpers 3.0.0-beta.11 → 3.0.0-beta.13

package/dist/tokens/index.js

@@ -1,3 +1,3 @@
-import{a as w}from"../chunk-ahpfxkx0.js";import{b as C}from"../chunk-xyczdrny.js";import{c as p}from"../chunk-q8xy3739.js";import{d as m}from"../chunk-z8emzpyc.js";import{e as x}from"../chunk-fr86y3rx.js";import{f}from"../chunk-tq87xn7m.js";import{g as l}from"../chunk-wmxwvv8c.js";import{h as L}from"../chunk-wrjh857m.js";import{i as e}from"../chunk-kdcsgh3q.js";import{j as V}from"../chunk-ekd1k975.js";import{k as t}from"../chunk-mmwvr2y8.js";import{l as a}from"../chunk-dbsrwnw2.js";import{m as i}from"../chunk-kr69v1tm.js";import{n as o}from"../chunk-6vvdbb6s.js";import{p as T}from"../chunk-3wnfcm30.js";var s={};T(s,{UniswapV3List:()=>C,UniswapV2List:()=>w,TraderjoeV2List:()=>V,ThorchainList:()=>e,SushiswapList:()=>L,PangolinList:()=>l,PancakeswapList:()=>f,OpenOceanV2List:()=>x,OneInchList:()=>m,MayaList:()=>p,JupiterList:()=>o,ChainflipList:()=>i,CaviarV1List:()=>a,CamelotV3List:()=>t});function B(O){for(let c of Object.values(s)){let r=c.tokens.find((P)=>P.identifier===O);if(r?.logoURI)return r.logoURI}return}export{s as tokenLists,B as getTokenIcon};
+import{e as w}from"../chunk-dzypg9sp.js";import{f as C}from"../chunk-vgg88vt8.js";import{g as p}from"../chunk-wssz50sc.js";import{h as m}from"../chunk-vadspc46.js";import{i as x}from"../chunk-jhmhh7ax.js";import{j as f}from"../chunk-tn4e7zrk.js";import{k as l}from"../chunk-ghdhtvtt.js";import{l as L}from"../chunk-rarep8vg.js";import{m as e}from"../chunk-bf0ph1bk.js";import{n as V}from"../chunk-nm1av1e6.js";import{o as t}from"../chunk-bh986mnf.js";import{p as a}from"../chunk-b8hashv0.js";import{q as i}from"../chunk-rr043vwc.js";import{r as o}from"../chunk-7shcm26h.js";import{t as T}from"../chunk-s82pm7xc.js";var s={};T(s,{UniswapV3List:()=>C,UniswapV2List:()=>w,TraderjoeV2List:()=>V,ThorchainList:()=>e,SushiswapList:()=>L,PangolinList:()=>l,PancakeswapList:()=>f,OpenOceanV2List:()=>x,OneInchList:()=>m,MayaList:()=>p,JupiterList:()=>o,ChainflipList:()=>i,CaviarV1List:()=>a,CamelotV3List:()=>t});function B(O){for(let c of Object.values(s)){let r=c.tokens.find((P)=>P.identifier===O);if(r?.logoURI)return r.logoURI}return}export{s as tokenLists,B as getTokenIcon};
 
-//# debugId=4914D9B24FD3F03364756E2164756E21
+//# debugId=3A5B936F2C5A6EC964756E2164756E21

package/dist/tokens/index.js.map

@@ -4,7 +4,7 @@
   "sourcesContent": [
     "import * as tokenLists from \"./lists\";\n\nexport function getTokenIcon(identifier: string): string | undefined {\n  // Search through all lists for a matching token\n  for (const list of Object.values(tokenLists)) {\n    const token = list.tokens.find((token) => token.identifier === identifier);\n    if (token?.logoURI) {\n      return token.logoURI;\n    }\n  }\n\n  return undefined;\n}\n\nexport { tokenLists };\n"
   ],
-  "mappings": "28BAEO,IAAS,JAAY,JAAC,HAAwC,JAEnE,GAAW,AAAQ,EAAO,EAAO,JAAU,HAAG,JAC5C,DAAM,HAAQ,EAAK,OAAO,KAAK,CAAC,IAAU,EAAM,aAAe,CAAU,EACzE,GAAI,GAAO,QACT,OAAO,EAAM,QAIjB",
-  "debugId": "4914D9B24FD3F03364756E2164756E21",
+  "mappings": "g9BAEO,IAAS,JAAY,JAAC,HAAwC,JAEnE,GAAW,AAAQ,EAAO,EAAO,JAAU,HAAG,JAC5C,DAAM,HAAQ,EAAK,OAAO,KAAK,CAAC,IAAU,EAAM,aAAe,CAAU,EACzE,GAAI,GAAO,QACT,OAAO,EAAM,QAIjB",
+  "debugId": "3A5B936F2C5A6EC964756E2164756E21",
   "names": []
 }

package/package.json

@@ -8,7 +8,7 @@
   },
   "description": "SwapKit - Helpers",
   "devDependencies": {
-    "@swapkit/toolboxes": "1.0.0-beta.16"
+    "@swapkit/toolboxes": "1.0.0-beta.18"
   },
   "exports": {
     ".": {
@@ -55,5 +55,5 @@
     "type-check:go": "tsgo"
   },
   "type": "module",
-  "version": "3.0.0-beta.11"
+  "version": "3.0.0-beta.13"
 }

package/src/api/microgard/types.ts

@@ -17,9 +17,6 @@ export type PoolDetail = {
   liquidityUnits: string;
   poolAPY: string;
   runeDepth: string;
-  saversAPR: string;
-  saversDepth: string;
-  saversUnits: string;
   status: string;
   synthSupply: string;
   synthUnits: string;

package/src/api/midgard/endpoints.ts

@@ -1,11 +1,5 @@
 import { AssetValue, BaseDecimal, Chain, RequestClient, SwapKitNumber } from "@swapkit/helpers";
-import type {
-  BorrowerDetails,
-  MemberDetailsMayachain,
-  MemberDetailsThorchain,
-  SaverDetails,
-  THORNameDetails,
-} from "./types";
+import type { MemberDetailsMayachain, MemberDetailsThorchain, THORNameDetails } from "./types";
 
 function getMidgardBaseUrl(isThorchain = true) {
   return isThorchain ? "https://midgard.ninerealms.com" : "https://midgard.mayachain.info";
@@ -16,18 +10,6 @@ function getNameServiceBaseUrl(isThorchain = true) {
   return isThorchain ? `${baseUrl}/v2/thorname` : `${baseUrl}/v2/mayaname`;
 }
 
-function getBorrowerDetailRaw(baseUrl: string) {
-  return function getBorrowerDetail(address: string) {
-    return RequestClient.get<BorrowerDetails>(`${baseUrl}/v2/borrower/${address}`);
-  };
-}
-
-function getSaverDetailRaw(baseUrl: string) {
-  return function getSaverDetail(address: string) {
-    return RequestClient.get<SaverDetails>(`${baseUrl}/v2/saver/${address}`);
-  };
-}
-
 function getLiquidityPositionRaw<Chain extends Chain.THORChain | Chain.Maya>(baseUrl: string) {
   return function getLiquidityPosition(
     address: string,
@@ -56,50 +38,10 @@ function getNamesByOwner(baseUrl: string) {
   };
 }
 
-function getBorrowerDetail(borrowerDetailGetter: ReturnType<typeof getBorrowerDetailRaw>) {
-  return async function getBorrowerDetail(address: string) {
-    const rawBorrowerDetail = await borrowerDetailGetter(address);
-
-    return rawBorrowerDetail.pools.map((p) => ({
-      collateral_deposited: AssetValue.from({
-        asset: p.collateral_asset,
-        value: p.collateral_deposited,
-        fromBaseDecimal: BaseDecimal.THOR,
-      }),
-      collateral_withdrawn: AssetValue.from({
-        asset: p.collateral_asset,
-        value: p.collateral_withdrawn,
-        fromBaseDecimal: BaseDecimal.THOR,
-      }),
-      debt_issued_tor: SwapKitNumber.fromBigInt(BigInt(p.debt_issued_tor), BaseDecimal.THOR),
-      debt_repaid_tor: SwapKitNumber.fromBigInt(BigInt(p.debt_repaid_tor), BaseDecimal.THOR),
-      last_open_loan_timestamp: p.last_open_loan_timestamp,
-      last_repay_loan_timestamp: p.last_repay_loan_timestamp,
-      target_assets: p.target_assets.map((asset) => AssetValue.from({ asset })),
-    }));
-  };
-}
-
 function getPoolAsset({ asset, value }: { asset: string; value: string }) {
   return AssetValue.from({ asset, value, fromBaseDecimal: BaseDecimal.THOR });
 }
 
-function getSaverDetail(saverDetailGetter: ReturnType<typeof getSaverDetailRaw>) {
-  return async function getSaverDetail(address: string) {
-    const rawSaverPositions = await saverDetailGetter(address);
-
-    return rawSaverPositions.pools.map((p) => ({
-      assetAdded: getPoolAsset({ asset: p.pool, value: p.assetAdded }),
-      assetDeposit: getPoolAsset({ asset: p.pool, value: p.assetDeposit }),
-      assetRedeem: getPoolAsset({ asset: p.pool, value: p.assetRedeem }),
-      assetWithdrawn: getPoolAsset({ asset: p.pool, value: p.assetWithdrawn }),
-      assetRegisteredAddress: p.assetAddress,
-      dateFirstAdded: p.dateFirstAdded,
-      dateLastAdded: p.dateLastAdded,
-    }));
-  };
-}
-
 function getLiquidityPosition<IsThorchain extends boolean = true>({
   liquidityPositionGetter,
   isThorchain,
@@ -134,15 +76,9 @@ function getMidgardMethodsForProtocol<T extends Chain.THORChain | Chain.Maya>(ch
   const midgardBaseUrl = getMidgardBaseUrl(isThorchain);
   const nameServiceBaseUrl = getNameServiceBaseUrl(isThorchain);
   const liquidityPositionGetter = getLiquidityPositionRaw<T>(midgardBaseUrl);
-  const borrowerDetailGetter = getBorrowerDetailRaw(midgardBaseUrl);
-  const saverDetailGetter = getSaverDetailRaw(midgardBaseUrl);
 
   return {
     getLiquidityPositionRaw: liquidityPositionGetter,
-    getBorrowerDetailRaw: borrowerDetailGetter,
-    getSaverDetailRaw: saverDetailGetter,
-    getBorrowerDetail: getBorrowerDetail(borrowerDetailGetter),
-    getSaversDetail: getSaverDetail(saverDetailGetter),
     getNameDetails: getNameDetails(nameServiceBaseUrl),
     getNamesByAddress: getNamesByAddress(nameServiceBaseUrl),
     getNamesByOwner: getNamesByOwner(nameServiceBaseUrl),

package/src/api/midgard/types.ts

@@ -1,52 +1,3 @@
-export type BorrowerDetails = {
-  /** @description List details of all the loans identified with the given address */
-  pools: BorrowerPool[];
-};
-
-export type BorrowerPool = {
-  /** @description The asset that the borrower used as collateral */
-  collateral_asset: string;
-  /** @description Int64(e8), The total amount of collateral that user deposited */
-  collateral_deposited: string;
-  /** @description Int64(e8), The total amount of collateral the system paid back to the user */
-  collateral_withdrawn: string;
-  /** @description Int64(e8), The total amount of debt issued as debt for user. denominated in TOR. */
-  debt_issued_tor: string;
-  /** @description Int64(e8), The total amount of debt that the user paid back. denominated in TOR. */
-  debt_repaid_tor: string;
-  /** @description Int64, Unix timestamp for the last time borrower opened a loan */
-  last_open_loan_timestamp: string;
-  /** @description Int64, Unix timestamp for the last time borrower repayment occurred */
-  last_repay_loan_timestamp: string;
-  target_assets: string[];
-};
-
-export type SaverDetails = {
-  /** @description List details of all the savers identified with the given address */
-  pools: SaverPool[];
-};
-
-export type SaverPool = {
-  /** @description Int64(e8), total asset added in the saver pool by member */
-  assetAdded: string;
-  /** @description saver address used by the member */
-  assetAddress: string;
-  /** @description Int64(e8), total asset that is currently deposited by the member */
-  assetDeposit: string;
-  /** @description Int64(e8), total asset can be redeemed from the saver pool by member */
-  assetRedeem: string;
-  /** @description Int64(e8), total asset withdrawn from the saver pool by member */
-  assetWithdrawn: string;
-  /** @description Int64, Unix timestamp for the first time member deposited into the saver pool */
-  dateFirstAdded: string;
-  /** @description Int64, Unix timestamp for the last time member deposited into the saver pool */
-  dateLastAdded: string;
-  /** @description The Pool rest of the data are refering to (only those pools can show up which have a corresponding saver pool) */
-  pool: string;
-  /** @description Int64, saver liquidity units that belong the the member */
-  saverUnits: string;
-};
-
 export type MemberDetailsMayachain = {
   /** @MemberPool List details of all the liquidity providers identified with the given address */
   pools: MemberPoolMayachain[];

package/src/api/swapkitApi/endpoints.ts

@@ -47,9 +47,8 @@ export async function getSwapQuote(json: QuoteRequest) {
     }
 
     return parsedResponse.data;
-  } catch (error) {
+  } catch (_error) {
     // throw new SwapKitError("api_v2_invalid_response", error);
-    console.warn(error);
     return response;
   }
 }

package/src/api/swapkitApi/types.ts

@@ -2,7 +2,6 @@ import {
   type AssetValue,
   Chain,
   ChainId,
-  ErrorCode,
   FeeTypeEnum,
   ProviderName,
   WarningCodeEnum,
@@ -20,6 +19,7 @@ import {
   unknown,
   type z,
 } from "zod";
+import { ErrorCode } from "../../types/quotes";
 
 export enum PriorityLabel {
   CHEAPEST = "CHEAPEST",

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

@@ -794,6 +794,32 @@ describe("AssetValue", () => {
           type: "Native",
         }),
       );
+
+      const trxAsset = AssetValue.from({ chain: Chain.Tron });
+      expect(trxAsset).toEqual(
+        expect.objectContaining({
+          chain: Chain.Tron,
+          decimal: BaseDecimal.TRX,
+          isGasAsset: true,
+          isSynthetic: false,
+          symbol: "TRX",
+          ticker: "TRX",
+          type: "Native",
+        }),
+      );
+
+      const trxAssetFromString = AssetValue.from({ asset: "TRX.TRX" });
+      expect(trxAssetFromString).toEqual(
+        expect.objectContaining({
+          chain: Chain.Tron,
+          decimal: BaseDecimal.TRX,
+          isGasAsset: true,
+          isSynthetic: false,
+          symbol: "TRX",
+          ticker: "TRX",
+          type: "Native",
+        }),
+      );
     });
 
     test("keep SOL address casing", () => {
@@ -811,6 +837,22 @@ describe("AssetValue", () => {
         }),
       );
     });
+
+    test("TRC20 tokens are not marked as gas assets", () => {
+      const tronUsdt = AssetValue.from({
+        asset: "TRX.USDT-TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t",
+      });
+      expect(tronUsdt).toEqual(
+        expect.objectContaining({
+          address: "tr7nhqjekqxgtci8q8zy4pl8otszgjlj6t",
+          chain: Chain.Tron,
+          isGasAsset: false,
+          isSynthetic: false,
+          symbol: "USDT-tr7nhqjekqxgtci8q8zy4pl8otszgjlj6t",
+          ticker: "USDT",
+        }),
+      );
+    });
   });
 });
 

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

@@ -27,11 +27,11 @@ describe("SwapKitNumber", () => {
 
       const skNumber5 = new SwapKitNumber({ value: 0.1005, decimal: 3 });
       expect(skNumber5.getValue("string")).toBe("0.101");
-      expect(skNumber5.getBaseValue("bigint")).toBe(100n);
+      expect(skNumber5.getBaseValue("bigint")).toBe(101n);
 
       const skNumber6 = new SwapKitNumber({ value: -0.1005, decimal: 3 });
       expect(skNumber6.getValue("string")).toBe("-0.101");
-      expect(skNumber6.getBaseValue("bigint")).toBe(-100n);
+      expect(skNumber6.getBaseValue("bigint")).toBe(-101n);
       expect(skNumber6.decimal).toBe(3);
       expect(skNumber6.getValue("number")).toBe(-0.101);
       expect(skNumber6.decimalMultiplier).toBe(100000000n);
@@ -355,9 +355,8 @@ describe("SwapKitNumber", () => {
 
       const result = skNumber1.mul(skNumber2);
 
-      // The exact result of 1.23 * 4.56 is 5.6088
       expect(result.getValue("string")).toBe("5.609");
-      expect(result.getBaseValue("bigint")).toBe(5608n);
+      expect(result.getBaseValue("bigint")).toBe(5609n);
 
       const skNumber3 = new SwapKitNumber({ decimal: 2, value: 1.23 });
       const skNumber4 = new SwapKitNumber(-1.234567891);
@@ -367,7 +366,7 @@ describe("SwapKitNumber", () => {
       // The exact result of 1.23 * -1.234567891 is -1,518518505
       // If we round it to 2 decimal places, we should get 5.61
       expect(result2.getValue("string")).toBe("-1.52");
-      expect(result2.getBaseValue("bigint")).toBe(-151n);
+      expect(result2.getBaseValue("bigint")).toBe(-152n);
     });
   });
 

package/src/modules/assetValue.ts

@@ -1,3 +1,6 @@
+import { getAddress } from "ethers";
+import { match } from "ts-pattern";
+
 import {
   BaseDecimal,
   Chain,
@@ -19,7 +22,6 @@ import { warnOnce } from "../utils/others";
 import { type TokenListName, loadTokenLists } from "../utils/tokens";
 import { validateIdentifier } from "../utils/validators";
 
-import { getAddress } from "ethers";
 import type { NumberPrimitives } from "./bigIntArithmetics";
 import { BigIntArithmetics, formatBigIntToSafeValue } from "./bigIntArithmetics";
 import { SwapKitError } from "./swapKitError";
@@ -213,33 +215,15 @@ or by passing asyncTokenLookup: true to the from() function, which will make it
 export function getMinAmountByChain(chain: Chain) {
   const asset = AssetValue.from({ chain });
 
-  switch (chain) {
-    case Chain.Bitcoin:
-    case Chain.Litecoin:
-    case Chain.BitcoinCash:
-    case Chain.Dash:
-      return asset.set(0.00010001);
-
-    case Chain.Dogecoin:
-      return asset.set(1.00000001);
-
-    case Chain.Avalanche:
-    case Chain.Ethereum:
-    case Chain.Arbitrum:
-    case Chain.BinanceSmartChain:
-      return asset.set(0.00000001);
-
-    case Chain.THORChain:
-    case Chain.Maya:
-      return asset.set(0);
-
-    case Chain.Cosmos:
-    case Chain.Kujira:
-      return asset.set(0.000001);
-
-    default:
-      return asset.set(0.00000001);
-  }
+  return match(chain)
+    .with(Chain.Bitcoin, Chain.Litecoin, Chain.BitcoinCash, Chain.Dash, () => asset.set(0.00010001))
+    .with(Chain.Dogecoin, () => asset.set(1.00000001))
+    .with(Chain.Avalanche, Chain.Ethereum, Chain.Arbitrum, Chain.BinanceSmartChain, () =>
+      asset.set(0.00000001),
+    )
+    .with(Chain.THORChain, Chain.Maya, () => asset.set(0))
+    .with(Chain.Cosmos, Chain.Kujira, () => asset.set(0.000001))
+    .otherwise(() => asset.set(0.00000001));
 }
 
 async function createAssetValue(identifier: string, value: NumberPrimitives = 0) {

package/src/modules/bigIntArithmetics.ts

@@ -54,6 +54,17 @@ export function formatBigIntToSafeValue({
   );
 }
 
+function divideBigIntWithRounding(n: bigint, d: bigint) {
+  if (d === 0n) {
+    throw new Error("Cannot divide by zero");
+  }
+  const half = d / 2n;
+  if ((n >= 0n && d >= 0n) || (n < 0n && d < 0n)) {
+    return (n + half) / d;
+  }
+  return (n - half) / d;
+}
+
 export class BigIntArithmetics {
   decimalMultiplier: bigint = 10n ** 8n;
   bigIntValue = 0n;
@@ -153,7 +164,7 @@ export class BigIntArithmetics {
   getBaseValue<T extends AllowedNumberTypes>(type: T, decimal?: number): NumberPrimitivesType[T] {
     const divisor =
       this.decimalMultiplier / toMultiplier(decimal || this.decimal || BaseDecimal.THOR);
-    const baseValue = this.bigIntValue / divisor;
+    const baseValue = divideBigIntWithRounding(this.bigIntValue, divisor);
 
     switch (type) {
       case "number":

package/src/modules/requestClient.ts

@@ -1,8 +1,9 @@
 import { SKConfig } from "./swapKitConfig";
+import { SwapKitError } from "./swapKitError";
 
 type Options = RequestInit & {
   /**
-   * @deprecated Use onSuccess instead
+   * @deprecated Use onSuccess instead - will be removed in next major @MarkedV4
    */
   responseHandler?: (response: any) => any;
   json?: unknown;
@@ -24,40 +25,53 @@ export const RequestClient = {
 function fetchWithConfig(method: "GET" | "POST", extendOptions: Options = {}) {
   return async <T>(url: string, options: Options = {}): Promise<T> => {
     const { searchParams, json, body, headers: headersOptions } = { ...extendOptions, ...options };
-    const { swapKit } = SKConfig.get("apiKeys");
 
-    const isJson = json || url.endsWith(".json");
+    const isJson = !!json || url.endsWith(".json");
     const bodyToSend = isJson ? JSON.stringify(json) : body;
-    const urlInstance = new URL(url);
-
-    if (searchParams) {
-      urlInstance.search = new URLSearchParams(searchParams).toString();
-    }
-
-    const headers = {
-      ...headersOptions,
-      ...(isJson ? { "Content-Type": "application/json" } : {}),
-      ...(swapKit ? { "x-api-key": swapKit } : {}),
-    };
 
     try {
-      const response = await fetch(urlInstance.toString(), {
-        ...options,
-        method,
-        body: bodyToSend,
-        headers,
-      });
+      const requestUrl = buildUrl(url, searchParams);
+      const headers = buildHeaders(isJson, headersOptions);
+
+      const response = await fetch(requestUrl, { ...options, method, body: bodyToSend, headers });
 
       if (!response.ok) {
         const message = await response.text();
-        throw new Error(`${response.statusText}(${response.status}): ${message}`);
+        throw new SwapKitError("helpers_invalid_response", {
+          status: response.status,
+          statusText: response.statusText,
+          message,
+        });
       }
 
       const body = await response.json();
 
       return options.onSuccess?.(body) || options.responseHandler?.(body) || body;
     } catch (error) {
-      return options.onError?.(error) || console.error(error);
+      if (options.onError) {
+        return options.onError(error);
+      }
+      throw error;
     }
   };
 }
+
+function buildHeaders(isJson: boolean, headersOptions?: HeadersInit) {
+  const { swapKit } = SKConfig.get("apiKeys");
+
+  return {
+    ...headersOptions,
+    ...(isJson ? { "Content-Type": "application/json" } : {}),
+    ...(swapKit ? { "x-api-key": swapKit } : {}),
+  };
+}
+
+function buildUrl(url: string, searchParams?: Record<string, string>) {
+  const urlInstance = new URL(url);
+
+  if (searchParams) {
+    urlInstance.search = new URLSearchParams(searchParams).toString();
+  }
+
+  return urlInstance.toString();
+}