@swapkit/helpers 1.0.0-rc.71 → 1.0.0-rc.72

package/src/helpers/asset.ts

@@ -1,8 +1,8 @@
-import { RequestClient } from '@swapkit/api';
-import type { EVMChain } from '@swapkit/types';
-import { BaseDecimal, Chain, ChainToRPC, EVMChainList, FeeOption } from '@swapkit/types';
+import { RequestClient } from "@swapkit/api";
+import type { EVMChain } from "@swapkit/types";
+import { BaseDecimal, Chain, ChainToRPC, EVMChains, FeeOption } from "@swapkit/types";
 
-const getDecimalMethodHex = '0x313ce567';
+const getDecimalMethodHex = "0x313ce567";
 
 export type CommonAssetString =
   | `${Chain.Maya}.MAYA`
@@ -15,15 +15,15 @@ const getContractDecimals = async ({ chain, to }: { chain: EVMChain; to: string
   try {
     const { result } = await RequestClient.post<{ result: string }>(ChainToRPC[chain], {
       headers: {
-        accept: '*/*',
-        'content-type': 'application/json',
-        'cache-control': 'no-cache',
+        accept: "*/*",
+        "content-type": "application/json",
+        "cache-control": "no-cache",
       },
       body: JSON.stringify({
         id: 44,
-        jsonrpc: '2.0',
-        method: 'eth_call',
-        params: [{ to: to.toLowerCase(), data: getDecimalMethodHex }, 'latest'],
+        jsonrpc: "2.0",
+        method: "eth_call",
+        params: [{ to: to.toLowerCase(), data: getDecimalMethodHex }, "latest"],
       }),
     });
 
@@ -34,30 +34,30 @@ const getContractDecimals = async ({ chain, to }: { chain: EVMChain; to: string
   }
 };
 
-const getETHAssetDecimal = async (symbol: string) => {
+const getETHAssetDecimal = (symbol: string) => {
   if (symbol === Chain.Ethereum) return BaseDecimal.ETH;
-  const [, address] = symbol.split('-');
+  const [, address] = symbol.split("-");
 
-  return address?.startsWith('0x')
+  return address?.startsWith("0x")
     ? getContractDecimals({ chain: Chain.Ethereum, to: address })
     : BaseDecimal.ETH;
 };
 
-const getAVAXAssetDecimal = async (symbol: string) => {
-  const [, address] = symbol.split('-');
+const getAVAXAssetDecimal = (symbol: string) => {
+  const [, address] = symbol.split("-");
 
-  return address?.startsWith('0x')
+  return address?.startsWith("0x")
     ? getContractDecimals({ chain: Chain.Avalanche, to: address.toLowerCase() })
     : BaseDecimal.AVAX;
 };
 
-const getBSCAssetDecimal = async (symbol: string) => {
+const getBSCAssetDecimal = (symbol: string) => {
   if (symbol === Chain.BinanceSmartChain) return BaseDecimal.BSC;
 
   return BaseDecimal.BSC;
 };
 
-export const getDecimal = async ({ chain, symbol }: { chain: Chain; symbol: string }) => {
+export const getDecimal = ({ chain, symbol }: { chain: Chain; symbol: string }) => {
   switch (chain) {
     case Chain.Ethereum:
       return getETHAssetDecimal(symbol);
@@ -80,19 +80,19 @@ export const isGasAsset = ({ chain, symbol }: { chain: Chain; symbol: string })
   switch (chain) {
     case Chain.Arbitrum:
     case Chain.Optimism:
-      return symbol === 'ETH';
+      return symbol === "ETH";
     case Chain.Maya:
-      return symbol === 'CACAO';
+      return symbol === "CACAO";
     case Chain.Kujira:
-      return symbol === 'KUJI';
+      return symbol === "KUJI";
     case Chain.Cosmos:
-      return symbol === 'ATOM';
+      return symbol === "ATOM";
     case Chain.Polygon:
-      return symbol === 'MATIC';
+      return symbol === "MATIC";
     case Chain.BinanceSmartChain:
-      return symbol === 'BNB';
+      return symbol === "BNB";
     case Chain.THORChain:
-      return symbol === 'RUNE';
+      return symbol === "RUNE";
 
     default:
       return symbol === chain;
@@ -104,20 +104,20 @@ export const getCommonAssetInfo = (
 ): { identifier: string; decimal: number } => {
   switch (assetString) {
     case `${Chain.Ethereum}.THOR`:
-      return { identifier: 'ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044', decimal: 18 };
+      return { identifier: "ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044", decimal: 18 };
     case `${Chain.Ethereum}.vTHOR`:
-      return { identifier: 'ETH.vTHOR-0x815c23eca83261b6ec689b60cc4a58b54bc24d8d', decimal: 18 };
+      return { identifier: "ETH.vTHOR-0x815c23eca83261b6ec689b60cc4a58b54bc24d8d", decimal: 18 };
 
     case Chain.Cosmos:
-      return { identifier: 'GAIA.ATOM', decimal: BaseDecimal[assetString] };
+      return { identifier: "GAIA.ATOM", decimal: BaseDecimal[assetString] };
     case Chain.THORChain:
-      return { identifier: 'THOR.RUNE', decimal: BaseDecimal[assetString] };
+      return { identifier: "THOR.RUNE", decimal: BaseDecimal[assetString] };
     case Chain.BinanceSmartChain:
-      return { identifier: 'BSC.BNB', decimal: BaseDecimal[assetString] };
+      return { identifier: "BSC.BNB", decimal: BaseDecimal[assetString] };
     case Chain.Maya:
-      return { identifier: 'MAYA.CACAO', decimal: BaseDecimal.MAYA };
+      return { identifier: "MAYA.CACAO", decimal: BaseDecimal.MAYA };
     case `${Chain.Maya}.MAYA`:
-      return { identifier: 'MAYA.MAYA', decimal: 4 };
+      return { identifier: "MAYA.MAYA", decimal: 4 };
 
     case `${Chain.Kujira}.USK`:
       return { identifier: `${Chain.Kujira}.USK`, decimal: 6 };
@@ -127,53 +127,54 @@ export const getCommonAssetInfo = (
   }
 };
 
+// biome-ignore lint/complexity/noExcessiveCognitiveComplexity: TODO: Refactor
 export const getAssetType = ({ chain, symbol }: { chain: Chain; symbol: string }) => {
-  if (symbol.includes('/')) return 'Synth';
+  if (symbol.includes("/")) return "Synth";
 
   switch (chain) {
     case Chain.Cosmos:
-      return symbol === 'ATOM' ? 'Native' : Chain.Cosmos;
+      return symbol === "ATOM" ? "Native" : Chain.Cosmos;
     case Chain.Kujira:
-      return symbol === Chain.Kujira ? 'Native' : Chain.Kujira;
+      return symbol === Chain.Kujira ? "Native" : Chain.Kujira;
     case Chain.Binance:
-      return symbol === Chain.Binance ? 'Native' : 'BEP2';
+      return symbol === Chain.Binance ? "Native" : "BEP2";
     case Chain.BinanceSmartChain:
-      return symbol === Chain.Binance ? 'Native' : 'BEP20';
+      return symbol === Chain.Binance ? "Native" : "BEP20";
     case Chain.Ethereum:
-      return symbol === Chain.Ethereum ? 'Native' : 'ERC20';
+      return symbol === Chain.Ethereum ? "Native" : "ERC20";
     case Chain.Avalanche:
-      return symbol === Chain.Avalanche ? 'Native' : Chain.Avalanche;
+      return symbol === Chain.Avalanche ? "Native" : Chain.Avalanche;
     case Chain.Polygon:
-      return symbol === Chain.Polygon ? 'Native' : 'POLYGON';
+      return symbol === Chain.Polygon ? "Native" : "POLYGON";
 
     case Chain.Arbitrum:
-      return [Chain.Ethereum, Chain.Arbitrum].includes(symbol as Chain) ? 'Native' : 'ARBITRUM';
+      return [Chain.Ethereum, Chain.Arbitrum].includes(symbol as Chain) ? "Native" : "ARBITRUM";
     case Chain.Optimism:
-      return [Chain.Ethereum, Chain.Optimism].includes(symbol as Chain) ? 'Native' : 'OPTIMISM';
+      return [Chain.Ethereum, Chain.Optimism].includes(symbol as Chain) ? "Native" : "OPTIMISM";
 
     default:
-      return 'Native';
+      return "Native";
   }
 };
 
 export const assetFromString = (assetString: string) => {
-  const [chain, ...symbolArray] = assetString.split('.') as [Chain, ...(string | undefined)[]];
-  const synth = assetString.includes('/');
-  const symbol = symbolArray.join('.');
-  const ticker = symbol?.split('-')?.[0];
+  const [chain, ...symbolArray] = assetString.split(".") as [Chain, ...(string | undefined)[]];
+  const synth = assetString.includes("/");
+  const symbol = symbolArray.join(".");
+  const ticker = symbol?.split("-")?.[0];
 
   return { chain, symbol, ticker, synth };
 };
 
 const potentialScamRegex = new RegExp(
   /(.)\1{6}|\.ORG|\.NET|\.FINANCE|\.COM|WWW|HTTP|\\\\|\/\/|[\s$%:[\]]/,
-  'gmi',
+  "gmi",
 );
 
 const evmAssetHasAddress = (assetString: string) => {
-  const [chain, symbol] = assetString.split('.') as [EVMChain, string];
-  if (!EVMChainList.includes(chain as EVMChain)) return true;
-  const [, address] = symbol.split('-') as [string, string?];
+  const [chain, symbol] = assetString.split(".") as [EVMChain, string];
+  if (!EVMChains.includes(chain as EVMChain)) return true;
+  const [, address] = symbol.split("-") as [string, string?];
 
   return isGasAsset({ chain: chain as Chain, symbol }) || !!address;
 };
@@ -190,6 +191,6 @@ export const filterAssets = (
     const assetString = `${chain}.${symbol}`;
 
     return (
-      !potentialScamRegex.test(assetString) && evmAssetHasAddress(assetString) && value !== '0'
+      !potentialScamRegex.test(assetString) && evmAssetHasAddress(assetString) && value !== "0"
     );
   });

package/src/helpers/liquidity.ts

@@ -1,13 +1,13 @@
-import { BaseDecimal } from '@swapkit/types';
+import { BaseDecimal } from "@swapkit/types";
 
-import { SwapKitNumber } from '../index.ts';
+import { SwapKitNumber } from "../index.ts";
 
-type ShareParams<T = {}> = T & {
+type ShareParams<T extends {}> = T & {
   liquidityUnits: string;
   poolUnits: string;
 };
 
-type PoolParams<T = {}> = T & {
+type PoolParams = {
   runeAmount: string;
   assetAmount: string;
   runeDepth: string;
@@ -148,14 +148,14 @@ export function getEstimatedPoolShare({
   const liquidityUnitsAfterAdd = numerator.div(denominator);
   const estimatedLiquidityUnits = toTCSwapKitNumber(liquidityUnits).add(liquidityUnitsAfterAdd);
 
-  if (liquidityUnitsAfterAdd.getBaseValue('number') === 0) {
-    return estimatedLiquidityUnits.div(P).getBaseValue('number');
+  if (liquidityUnitsAfterAdd.getBaseValue("number") === 0) {
+    return estimatedLiquidityUnits.div(P).getBaseValue("number");
   }
 
   // get pool units after add
   const newPoolUnits = P.add(estimatedLiquidityUnits);
 
-  return estimatedLiquidityUnits.div(newPoolUnits).getBaseValue('number');
+  return estimatedLiquidityUnits.div(newPoolUnits).getBaseValue("number");
 }
 
 export function getLiquiditySlippage({
@@ -164,7 +164,7 @@ export function getLiquiditySlippage({
   runeDepth,
   assetDepth,
 }: PoolParams) {
-  if (runeAmount === '0' || assetAmount === '0' || runeDepth === '0' || assetDepth === '0')
+  if (runeAmount === "0" || assetAmount === "0" || runeDepth === "0" || assetDepth === "0")
     return 0;
   // formula: (t * R - T * r)/ (T*r + R*T)
   const R = toTCSwapKitNumber(runeDepth);
@@ -176,5 +176,5 @@ export function getLiquiditySlippage({
   const denominator = T.mul(runeAddAmount).add(R.mul(T));
 
   // set absolute value of percent, no negative allowed
-  return Math.abs(numerator.div(denominator).getBaseValue('number'));
+  return Math.abs(numerator.div(denominator).getBaseValue("number"));
 }

package/src/helpers/memo.ts

@@ -1,4 +1,4 @@
-import { Chain, MemoType } from '@swapkit/types';
+import { Chain, MemoType } from "@swapkit/types";
 
 export type ThornameRegisterParam = {
   name: string;
@@ -9,15 +9,14 @@ export type ThornameRegisterParam = {
   expiryBlock?: string;
 };
 
-type WithAddress<T = {}> = T & { address: string };
-type WithChain<T = {}> = T & { chain: Chain };
+type WithChain<T extends {}> = T & { chain: Chain };
 
 export type MemoOptions<T extends MemoType> = {
-  [MemoType.BOND]: WithAddress;
-  [MemoType.LEAVE]: WithAddress;
-  [MemoType.CLOSE_LOAN]: WithAddress<{ asset: string; minAmount?: string }>;
-  [MemoType.OPEN_LOAN]: WithAddress<{ asset: string; minAmount?: string }>;
-  [MemoType.UNBOND]: WithAddress<{ unbondAmount: number }>;
+  [MemoType.BOND]: { address: string };
+  [MemoType.LEAVE]: { address: string };
+  [MemoType.CLOSE_LOAN]: { address: string; asset: string; minAmount?: string };
+  [MemoType.OPEN_LOAN]: { address: string; asset: string; minAmount?: string };
+  [MemoType.UNBOND]: { address: string; unbondAmount: number };
   [MemoType.DEPOSIT]: WithChain<{ symbol: string; address?: string; singleSide?: boolean }>;
   [MemoType.WITHDRAW]: WithChain<{
     ticker: string;
@@ -26,7 +25,7 @@ export type MemoOptions<T extends MemoType> = {
     targetAssetString?: string;
     singleSide?: boolean;
   }>;
-  [MemoType.THORNAME_REGISTER]: Omit<ThornameRegisterParam, 'preferredAsset' | 'expiryBlock'>;
+  [MemoType.THORNAME_REGISTER]: Omit<ThornameRegisterParam, "preferredAsset" | "expiryBlock">;
 }[T];
 
 export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions<T>) => {
@@ -44,7 +43,7 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
 
     case MemoType.THORNAME_REGISTER: {
       const { name, chain, address, owner } = options as MemoOptions<MemoType.THORNAME_REGISTER>;
-      return `${memoType}:${name}:${chain}:${address}${owner ? `:${owner}` : ''}`;
+      return `${memoType}:${name}:${chain}:${address}${owner ? `:${owner}` : ""}`;
     }
 
     case MemoType.DEPOSIT: {
@@ -53,11 +52,11 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
       const getPoolIdentifier = (chain: Chain, symbol: string): string => {
         switch (chain) {
           case Chain.Litecoin:
-            return 'l';
+            return "l";
           case Chain.Dogecoin:
-            return 'd';
+            return "d";
           case Chain.BitcoinCash:
-            return 'c';
+            return "c";
           default:
             return `${chain}.${symbol}`;
         }
@@ -65,7 +64,7 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
 
       return singleSide
         ? `${memoType}:${chain}/${symbol}`
-        : `${memoType}:${getPoolIdentifier(chain, symbol)}:${address || ''}`;
+        : `${memoType}:${getPoolIdentifier(chain, symbol)}:${address || ""}`;
     }
 
     case MemoType.WITHDRAW: {
@@ -73,9 +72,9 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
         options as MemoOptions<MemoType.WITHDRAW>;
 
       const shortenedSymbol =
-        chain === 'ETH' && ticker !== 'ETH' ? `${ticker}-${symbol.slice(-3)}` : symbol;
-      const target = !singleSide && targetAssetString ? `:${targetAssetString}` : '';
-      const assetDivider = singleSide ? '/' : '.';
+        chain === "ETH" && ticker !== "ETH" ? `${ticker}-${symbol.slice(-3)}` : symbol;
+      const target = !singleSide && targetAssetString ? `:${targetAssetString}` : "";
+      const assetDivider = singleSide ? "/" : ".";
 
       return `${memoType}:${chain}${assetDivider}${shortenedSymbol}:${basisPoints}${target}`;
     }
@@ -88,6 +87,6 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
     }
 
     default:
-      return '';
+      return "";
   }
 };

package/src/helpers/others.ts

@@ -1,7 +1,7 @@
 // 10 rune for register, 1 rune per year
 // MINIMUM_REGISTRATION_FEE = 11
 export function getTHORNameCost(year: number) {
-  if (year < 0) throw new Error('Invalid number of year');
+  if (year < 0) throw new Error("Invalid number of year");
   return 10 + year;
 }
 
@@ -14,7 +14,7 @@ export function validateTHORName(name: string) {
 }
 
 export function derivationPathToString([network, chainId, account, change, index]: number[]) {
-  const shortPath = typeof index !== 'number';
+  const shortPath = typeof index !== "number";
 
-  return `${network}'/${chainId}'/${account}'/${change}${shortPath ? '' : `/${index}`}`;
+  return `${network}'/${chainId}'/${account}'/${change}${shortPath ? "" : `/${index}`}`;
 }

package/src/helpers/validators.ts

@@ -1,15 +1,15 @@
-import { Chain } from '@swapkit/types';
+import { Chain } from "@swapkit/types";
 
 // Backward compatibility
-const supportedChains = [...Object.values(Chain), 'TERRA'];
+const supportedChains = [...Object.values(Chain), "TERRA"];
 
-export function validateIdentifier(identifier = '') {
+export function validateIdentifier(identifier = "") {
   const uppercasedIdentifier = identifier.toUpperCase();
 
-  const [chain] = uppercasedIdentifier.split('.') as [Chain, string];
+  const [chain] = uppercasedIdentifier.split(".") as [Chain, string];
   if (supportedChains.includes(chain)) return true;
 
-  const [synthChain] = uppercasedIdentifier.split('/') as [Chain, string];
+  const [synthChain] = uppercasedIdentifier.split("/") as [Chain, string];
   if (supportedChains.includes(synthChain)) return true;
 
   throw new Error(

package/src/index.ts

@@ -1,17 +1,17 @@
-export * from '@swapkit/api';
+export * from "@swapkit/api";
 
 /**
  * Helpers
  */
-export * from './helpers/asset.ts';
-export * from './helpers/liquidity.ts';
-export * from './helpers/memo.ts';
-export * from './helpers/others.ts';
+export * from "./helpers/asset.ts";
+export * from "./helpers/liquidity.ts";
+export * from "./helpers/memo.ts";
+export * from "./helpers/others.ts";
 
 /**
  * Modules
  */
-export * from './modules/assetValue.ts';
-export * from './modules/bigIntArithmetics.ts';
-export * from './modules/swapKitError.ts';
-export * from './modules/swapKitNumber.ts';
+export * from "./modules/assetValue.ts";
+export * from "./modules/bigIntArithmetics.ts";
+export * from "./modules/swapKitError.ts";
+export * from "./modules/swapKitNumber.ts";