@swapkit/helpers 1.0.0-rc.4 → 1.0.0-rc.40

package/package.json

@@ -1,20 +1,23 @@
 {
   "author": "swapkit-oss-team",
   "description": "SwapKit Lib swapkit-helpers",
+  "dependencies": {
+    "ky": "1.1.3"
+  },
   "devDependencies": {
-    "@vitest/coverage-istanbul": "0.34.4",
-    "vite": "4.4.9",
-    "vitest": "0.34.4",
-    "@internal/config": "0.0.0-internal.0",
-    "@swapkit/tokens": "1.0.0-rc.3",
-    "@swapkit/types": "1.0.0-rc.3"
+    "@vitest/coverage-istanbul": "0.34.6",
+    "vite": "4.5.0",
+    "vitest": "0.34.6",
+    "@internal/config": "0.0.0-rc.6",
+    "@swapkit/tokens": "1.0.0-rc.21",
+    "@swapkit/types": "1.0.0-rc.20"
   },
   "eslintConfig": {
     "extends": "../../../internal/eslint-config"
   },
   "peerDependencies": {
-    "@swapkit/tokens": "1.0.0-rc.3",
-    "@swapkit/types": "1.0.0-rc.3"
+    "@swapkit/tokens": "1.0.0-rc.21",
+    "@swapkit/types": "1.0.0-rc.20"
   },
   "exports": {
     ".": {
@@ -39,7 +42,7 @@
   "repository": "https://github.com/thorswap/SwapKit.git",
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "1.0.0-rc.4",
+  "version": "1.0.0-rc.40",
   "scripts": {
     "build": "vite build",
     "clean": "rm -rf dist vite.config.ts.* .turbo node_modules",

package/src/helpers/asset.ts

@@ -1,7 +1,7 @@
 import type { EVMChain } from '@swapkit/types';
-import { BaseDecimal, Chain, ChainToRPC, FeeOption } from '@swapkit/types';
+import { BaseDecimal, Chain, ChainToRPC, EVMChainList, FeeOption } from '@swapkit/types';
 
-import { postRequest } from './others.ts';
+import { RequestClient } from '../index.ts';
 
 const getDecimalMethodHex = '0x313ce567';
 
@@ -9,19 +9,19 @@ export type CommonAssetString = 'MAYA.MAYA' | 'ETH.THOR' | 'ETH.vTHOR' | Chain;
 
 const getContractDecimals = async ({ chain, to }: { chain: EVMChain; to: string }) => {
   try {
-    const response = await postRequest<string>(
-      ChainToRPC[chain],
-      JSON.stringify({
-        method: 'eth_call',
-        params: [{ to: to.toLowerCase(), data: getDecimalMethodHex }, 'latest'],
+    const { result } = await RequestClient.post<{ result: string }>(ChainToRPC[chain], {
+      headers: {
+        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'],
       }),
-      { accept: '*/*', 'cache-control': 'no-cache', 'content-type': 'application/json' },
-      true,
-    );
-
-    const { result } = JSON.parse(response) as { result: string };
+    });
 
     return parseInt(BigInt(result).toString());
   } catch (error) {
@@ -152,9 +152,9 @@ export const getAssetType = ({ chain, symbol }: { chain: Chain; symbol: string }
       return 'Native';
 
     case Chain.Cosmos:
-      return symbol === 'ATOM' ? 'Native' : 'GAIA';
+      return symbol === 'ATOM' ? 'Native' : Chain.Cosmos;
     case Chain.Kujira:
-      return symbol === 'KUJI' ? 'Native' : 'KUJI';
+      return symbol === Chain.Kujira ? 'Native' : Chain.Kujira;
     case Chain.Binance:
       return symbol === Chain.Binance ? 'Native' : 'BEP2';
     case Chain.BinanceSmartChain:
@@ -162,7 +162,7 @@ export const getAssetType = ({ chain, symbol }: { chain: Chain; symbol: string }
     case Chain.Ethereum:
       return symbol === Chain.Ethereum ? 'Native' : 'ERC20';
     case Chain.Avalanche:
-      return symbol === Chain.Avalanche ? 'Native' : 'AVAX';
+      return symbol === Chain.Avalanche ? 'Native' : Chain.Avalanche;
     case Chain.Polygon:
       return symbol === Chain.Polygon ? 'Native' : 'POLYGON';
 
@@ -181,3 +181,34 @@ export const assetFromString = (assetString: string) => {
 
   return { chain, symbol, ticker, synth };
 };
+
+const potentialScamRegex = new RegExp(
+  /(.)\1{6}|\.ORG|\.NET|\.FINANCE|\.COM|WWW|HTTP|\\\\|\/\/|[\s$%:[\]]/,
+  '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?];
+
+  return isGasAsset({ chain: chain as Chain, symbol }) || !!address;
+};
+
+export const filterAssets = (
+  tokens: {
+    value: string;
+    decimal: number;
+    chain: Chain;
+    symbol: string;
+  }[],
+) =>
+  tokens.filter((token) => {
+    const assetString = `${token.chain}.${token.symbol}`;
+
+    return (
+      !potentialScamRegex.test(assetString) &&
+      evmAssetHasAddress(assetString) &&
+      token.value !== '0'
+    );
+  });

package/src/helpers/liquidity.ts

@@ -81,7 +81,7 @@ export const getAsymmetricAssetWithdrawAmount = ({
   getAsymmetricAssetShare({ assetDepth, liquidityUnits, poolUnits }).mul(percent);
 
 const toTCSwapKitNumber = (value: string) =>
-  new SwapKitNumber({ value, decimal: BaseDecimal.THOR });
+  SwapKitNumber.fromBigInt(BigInt(value), BaseDecimal.THOR);
 
 export const getSymmetricPoolShare = ({
   liquidityUnits,
@@ -126,11 +126,11 @@ export const getEstimatedPoolShare = ({
   runeDepth: string;
   assetDepth: string;
 }>) => {
-  const R = toTCSwapKitNumber(runeDepth);
-  const A = toTCSwapKitNumber(assetDepth);
-  const P = toTCSwapKitNumber(poolUnits);
-  const runeAddAmount = toTCSwapKitNumber(runeAmount);
-  const assetAddAmount = toTCSwapKitNumber(assetAmount);
+  const R = new SwapKitNumber({ value: runeDepth, decimal: 8 });
+  const A = new SwapKitNumber({ value: assetDepth, decimal: 8 });
+  const P = new SwapKitNumber({ value: poolUnits, decimal: 8 });
+  const runeAddAmount = new SwapKitNumber({ value: runeAmount, decimal: 8 });
+  const assetAddAmount = new SwapKitNumber({ value: assetAmount, decimal: 8 });
 
   // liquidityUnits = P * (r*A + a*R + 2*r*a) / (r*A + a*R + 2*R*A)
   const rA = runeAddAmount.mul(A);
@@ -142,14 +142,14 @@ export const getEstimatedPoolShare = ({
   const liquidityUnitsAfterAdd = numerator.div(denominator);
   const estimatedLiquidityUnits = toTCSwapKitNumber(liquidityUnits).add(liquidityUnitsAfterAdd);
 
-  if (liquidityUnitsAfterAdd.baseValueNumber === 0) {
-    return estimatedLiquidityUnits.div(P).baseValueNumber;
+  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).baseValueNumber;
+  return estimatedLiquidityUnits.div(newPoolUnits).getBaseValue('number');
 };
 
 export const getLiquiditySlippage = ({
@@ -158,6 +158,8 @@ export const getLiquiditySlippage = ({
   runeDepth,
   assetDepth,
 }: PoolParams) => {
+  if (runeAmount === '0' || assetAmount === '0' || runeDepth === '0' || assetDepth === '0')
+    return 0;
   // formula: (t * R - T * r)/ (T*r + R*T)
   const R = toTCSwapKitNumber(runeDepth);
   const T = toTCSwapKitNumber(assetDepth);
@@ -168,5 +170,5 @@ export const getLiquiditySlippage = ({
   const denominator = T.mul(runeAddAmount).add(R.mul(T));
 
   // set absolute value of percent, no negative allowed
-  return Math.abs(numerator.div(denominator).baseValueNumber);
+  return Math.abs(numerator.div(denominator).getBaseValue('number'));
 };

package/src/helpers/others.ts

@@ -18,51 +18,3 @@ export const derivationPathToString = ([network, chainId, account, change, index
 
   return `${network}'/${chainId}'/${account}'/${change}${shortPath ? '' : `/${index}`}`;
 };
-
-export const getRequest = async <T>(
-  url: string,
-  params?: { [key in string]?: any },
-): Promise<T> => {
-  try {
-    const queryParams = Object.entries(params || {}).reduce(
-      (acc, [key, value]) => {
-        if (value) {
-          acc[key] = value;
-        }
-
-        return acc;
-      },
-      {} as { [key in string]: any },
-    );
-
-    const response = await fetch(
-      `${url}${params ? `?${new URLSearchParams(queryParams).toString()}` : ''}`,
-      { method: 'GET', mode: 'cors', credentials: 'omit', referrer: 'https://sk.thorswap.net' },
-    );
-
-    return response.json();
-  } catch (error) {
-    console.error(error);
-    return {} as T;
-  }
-};
-
-export const postRequest = async <T>(
-  url: string,
-  body: string,
-  headers?: Record<string, string>,
-  parseAsString = false,
-): Promise<T> => {
-  try {
-    const response = await fetch(`${url}`, {
-      body,
-      headers,
-      method: 'POST',
-      referrer: 'https://sk.thorswap.net',
-    });
-
-    return parseAsString ? response.text() : response.json();
-  } catch (error) {
-    return {} as T;
-  }
-};

package/src/helpers/request.ts

@@ -0,0 +1,15 @@
+import type { Options } from 'ky';
+import ky from 'ky';
+
+const headers =
+  typeof window !== 'undefined'
+    ? {}
+    : { referrer: 'https://sk.thorswap.net', referer: 'https://sk.thorswap.net' };
+
+const kyClient = ky.create({ headers });
+
+export const RequestClient = {
+  get: <T>(url: string | URL | Request, options?: Options) => kyClient.get(url, options).json<T>(),
+  post: <T>(url: string | URL | Request, options?: Options) =>
+    kyClient.post(url, options).json<T>(),
+};

package/src/index.ts

@@ -5,6 +5,7 @@ export * from './helpers/asset.ts';
 export * from './helpers/liquidity.ts';
 export * from './helpers/memo.ts';
 export * from './helpers/others.ts';
+export * from './helpers/request.ts';
 
 /**
  * Modules

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

@@ -1,7 +1,7 @@
 import { BaseDecimal, Chain } from '@swapkit/types';
 import { describe, expect, test } from 'vitest';
 
-import { AssetValue } from '../assetValue.ts';
+import { AssetValue, getMinAmountByChain } from '../assetValue.ts';
 
 describe('AssetValue', () => {
   describe('assetValue', () => {
@@ -12,10 +12,13 @@ describe('AssetValue', () => {
         chain: Chain.Avalanche,
         symbol: 'USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
       });
-      expect(fakeAvaxUSDCAsset.assetValue).toBe('1234567890 USDC');
+      expect(fakeAvaxUSDCAsset.toString(true)).toBe('USDC');
+      expect(fakeAvaxUSDCAsset.toString()).toBe(
+        'AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
+      );
 
       const thor = AssetValue.fromChainOrSignature('ETH.THOR');
-      expect(thor.assetValue).toBe('0 THOR');
+      expect(thor.toString(true)).toBe('THOR');
 
       const ethSynth = new AssetValue({
         chain: Chain.THORChain,
@@ -24,8 +27,22 @@ describe('AssetValue', () => {
         value: 1234567890,
       });
 
-      expect(ethSynth.assetValue).toBe('1234567890 ETH/ETH');
       expect(ethSynth.toString()).toBe('THOR.ETH/ETH');
+      expect(ethSynth.toString(true)).toBe('ETH/ETH');
+      expect(ethSynth.mul(21.37).getValue('string')).toBe('26382715809.3');
+
+      const ethThorSynth = new AssetValue({
+        chain: Chain.THORChain,
+        symbol: 'ETH/THOR-0xa5f2211b9b8170f694421f2046281775e8468044',
+        decimal: 8,
+        value: 1234567890,
+      });
+      expect(ethThorSynth.toString()).toBe(
+        'THOR.ETH/THOR-0xa5f2211b9b8170f694421f2046281775e8468044',
+      );
+      expect(ethThorSynth.toString(true)).toBe(
+        'ETH/THOR-0xa5f2211b9b8170f694421f2046281775e8468044',
+      );
 
       const atomDerived = new AssetValue({
         identifier: 'THOR.ATOM',
@@ -33,11 +50,44 @@ describe('AssetValue', () => {
         value: 123456789,
       });
 
-      expect(atomDerived.assetValue).toBe('123456789 ATOM');
+      expect(atomDerived.toString(true)).toBe('ATOM');
       expect(atomDerived.toString()).toBe('THOR.ATOM');
     });
   });
 
+  describe('toUrl', () => {
+    test('returns asset compliance with url', () => {
+      const fakeAvaxUSDCAsset = new AssetValue({
+        decimal: 6,
+        value: 1234567890,
+        chain: Chain.Avalanche,
+        symbol: 'USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
+      });
+      expect(fakeAvaxUSDCAsset.toUrl()).toBe(
+        'AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
+      );
+
+      const thor = AssetValue.fromChainOrSignature('ETH.THOR');
+      expect(thor.toUrl()).toBe('ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044');
+
+      const ethSynth = new AssetValue({
+        chain: Chain.THORChain,
+        symbol: 'ETH/ETH',
+        decimal: 8,
+        value: 1234567890,
+      });
+      expect(ethSynth.toUrl()).toBe('THOR.ETH.ETH');
+
+      const ethThorSynth = new AssetValue({
+        chain: Chain.THORChain,
+        symbol: 'ETH/THOR-0xa5f2211b9b8170f694421f2046281775e8468044',
+        decimal: 8,
+        value: 1234567890,
+      });
+      expect(ethThorSynth.toUrl()).toBe('THOR.ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044');
+    });
+  });
+
   describe('eq', () => {
     test('checks if assets are same chain and symbol', () => {
       const firstThor = AssetValue.fromChainOrSignature('ETH.THOR');
@@ -70,17 +120,25 @@ describe('AssetValue', () => {
     });
   });
 
+  describe('from bigint', () => {
+    test('returns asset value with correct decimal', async () => {
+      const avaxUSDCAsset = await AssetValue.fromIdentifier(
+        `${Chain.Avalanche}.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e`,
+        1234567800n,
+      );
+      expect(avaxUSDCAsset.getValue('string')).toBe('1234.5678');
+    });
+  });
+
   describe('toString', () => {
     test('returns asset value string/identifier', async () => {
-      const fakeAvaxUSDCAsset = new AssetValue({
+      const avaxUSDCAsset = new AssetValue({
         decimal: 6,
         value: 1234567890,
         chain: Chain.Avalanche,
         symbol: 'USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
       });
-      expect(fakeAvaxUSDCAsset.toString()).toBe(
-        'AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
-      );
+      expect(avaxUSDCAsset.toString()).toBe('AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e');
 
       const thor = AssetValue.fromChainOrSignature('ETH.THOR');
       expect(thor.toString()).toBe('ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044');
@@ -92,10 +150,11 @@ describe('AssetValue', () => {
 
   describe('fromIdentifier', () => {
     test('creates AssetValue from string', async () => {
-      const fakeAvaxUSDCAssetString = 'AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e';
-      const fakeAvaxUSDCAsset = await AssetValue.fromIdentifier(fakeAvaxUSDCAssetString);
+      const avaxUSDCAsset = await AssetValue.fromIdentifier(
+        'AVAX.USDC-0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
+      );
 
-      expect(fakeAvaxUSDCAsset).toEqual(
+      expect(avaxUSDCAsset).toEqual(
         expect.objectContaining({
           address: '0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e',
           chain: Chain.Avalanche,
@@ -293,3 +352,22 @@ describe('AssetValue', () => {
     });
   });
 });
+
+describe('getMinAmountByChain', () => {
+  test('returns min amount for chain', () => {
+    expect(getMinAmountByChain(Chain.THORChain).getValue('string')).toBe('0');
+    expect(getMinAmountByChain(Chain.Maya).getValue('string')).toBe('0');
+    expect(getMinAmountByChain(Chain.Cosmos).getValue('string')).toBe('0');
+
+    expect(getMinAmountByChain(Chain.Bitcoin).getValue('string')).toBe('0.00010001');
+    expect(getMinAmountByChain(Chain.Litecoin).getValue('string')).toBe('0.00010001');
+    expect(getMinAmountByChain(Chain.BitcoinCash).getValue('string')).toBe('0.00010001');
+    expect(getMinAmountByChain(Chain.Dogecoin).getValue('string')).toBe('1.00000001');
+
+    expect(getMinAmountByChain(Chain.BinanceSmartChain).getValue('string')).toBe('0.00000001');
+    expect(getMinAmountByChain(Chain.Ethereum).getValue('string')).toBe('0.00000001');
+    expect(getMinAmountByChain(Chain.Avalanche).getValue('string')).toBe('0.00000001');
+    expect(getMinAmountByChain(Chain.Arbitrum).getValue('string')).toBe('0.00000001');
+    expect(getMinAmountByChain(Chain.Optimism).getValue('string')).toBe('0.00000001');
+  });
+});