@pioneer-platform/helpers 0.0.0-development.112

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 THORSwap
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,38 @@
+{
+  "dependencies": {
+    "@pioneer-platform/swapkit-entities": "1.0.0-development.120",
+    "@pioneer-platform/types": "1.0.0-development.106"
+  },
+  "description": "THORSwap Lib - Helper library for THORSwap",
+  "devDependencies": {
+    "@ethersproject/bignumber": "5.7.0",
+    "@vitest/coverage-istanbul": "0.34.3",
+    "bignumber.js": "9.1.2",
+    "vite": "4.4.9",
+    "vitest": "0.34.3",
+    "@internal/config": "0.0.1-development.3"
+  },
+  "eslintConfig": {
+    "extends": "../eslint-config-thorswap"
+  },
+  "files": [
+    "src/"
+  ],
+  "homepage": "https://github.com/thorswap/SwapKit",
+  "license": "MIT",
+  "main": "./src/index.ts",
+  "name": "@pioneer-platform/helpers",
+  "peerDependencies": {
+    "@ethersproject/bignumber": "^5.7.0",
+    "bignumber.js": "^9.1.2"
+  },
+  "type": "module",
+  "version": "0.0.0-development.112",
+  "scripts": {
+    "build": "vite build",
+    "clean": "rm -rf dist .turbo node_modules",
+    "lint": "eslint --ext .ts,.tsx --fix; tsc --noEmit",
+    "test": "vitest --run",
+    "test:coverage": "vitest run --coverage"
+  }
+}

package/src/__tests__/asset.test.ts

@@ -0,0 +1,33 @@
+import { describe, it, expect } from 'vitest';
+import { assetFromString, assetToString } from '../asset.ts';
+import { Chain } from '@pioneer-platform/types';
+
+describe('assetToString', () => {
+  it('should return the correct string representation of an asset', () => {
+    const asset = { chain: Chain.Ethereum, symbol: 'USDT' };
+    expect(assetToString(asset)).toBe('ETH.USDT');
+
+    const synthAsset = { chain: Chain.THORChain, symbol: 'BNB/BNB' };
+    expect(assetToString(synthAsset)).toBe('THOR.BNB/BNB');
+  });
+});
+
+describe('assetFromString', () => {
+  it('should return the correct asset object from a string', () => {
+    const assetString = 'ETH.USDT';
+    const expectedAsset = { chain: Chain.Ethereum, symbol: 'USDT', ticker: 'USDT', synth: false };
+    expect(assetFromString(assetString)).toEqual(expectedAsset);
+  });
+
+  it('should return the correct asset object from a synth string', () => {
+    const assetString = 'THOR.BNB/BNB';
+    const expectedAsset = { chain: Chain.THORChain, symbol: 'BNB/BNB', ticker: 'BNB/BNB', synth: true };
+    expect(assetFromString(assetString)).toEqual(expectedAsset);
+  });
+
+  it('should return the correct asset object from a string with a hyphen', () => {
+    const assetString = 'ETH.USDT-0XA3910454BF2CB59B8B3A401589A3BACC5CA42306';
+    const expectedAsset = { chain: Chain.Ethereum, symbol: 'USDT-0XA3910454BF2CB59B8B3A401589A3BACC5CA42306', ticker: 'USDT', synth: false };
+    expect(assetFromString(assetString)).toEqual(expectedAsset);
+  });
+});

package/src/__tests__/derivationPath.test.ts

@@ -0,0 +1,16 @@
+import { describe, it, expect } from 'vitest';
+import { derivationPathToString } from '../derivationPath.ts';
+
+describe('derivationPathToString', () => {
+  it('should return the correct string for a full path', () => {
+    const path = [1, 2, 3, 4, 5];
+    const result = derivationPathToString(path);
+    expect(result).toEqual("1'/2'/3'/4/5");
+  });
+
+  it('should return the correct string for a short path', () => {
+    const path = [1, 2, 3, 4];
+    const result = derivationPathToString(path);
+    expect(result).toEqual("1'/2'/3'/4");
+  });
+});

package/src/amount.ts

@@ -0,0 +1,29 @@
+import { BigNumber, BigNumberish } from '@ethersproject/bignumber';
+import type { AmountWithBaseDenom } from '@pioneer-platform/types';
+
+type Value = BigNumberish | AmountWithBaseDenom;
+
+const isBigNumberValue = (v: unknown): v is BigNumberish =>
+  typeof v === 'string' || typeof v === 'number' || v instanceof BigNumber;
+
+export const baseAmount = (value?: BigNumberish, decimal: number = 8): AmountWithBaseDenom => {
+  const amount = BigNumber.from(value || 0);
+
+  return {
+    amount: () => amount,
+    plus: (v: Value, d: number = decimal) =>
+      baseAmount(amount.add(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()), d),
+    minus: (v: Value, d: number = decimal) =>
+      baseAmount(amount.sub(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()), d),
+    times: (v: Value, d: number = decimal) =>
+      baseAmount(amount.mul(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()), d),
+    div: (v: Value, d: number = decimal) =>
+      baseAmount(amount.div(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()), d),
+    lt: (v: Value) => amount.lt(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()),
+    lte: (v: Value) => amount.lte(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()),
+    gt: (v: Value) => amount.gt(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()),
+    gte: (v: Value) => amount.gte(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()),
+    eq: (v: Value) => amount.eq(isBigNumberValue(v) ? v : (v as AmountWithBaseDenom).amount()),
+    decimal,
+  };
+};

package/src/asset.ts

@@ -0,0 +1,13 @@
+import { Chain } from '@pioneer-platform/types';
+
+export const assetToString = ({ chain, symbol }: { chain: Chain; symbol: string }) =>
+  `${chain}.${symbol}`;
+
+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];
+
+  return { chain, symbol, ticker, synth };
+};

package/src/derivationPath.ts

@@ -0,0 +1,5 @@
+export const derivationPathToString = ([network, chainId, account, change, index]: number[]) => {
+  const shortPath = typeof index !== 'number';
+
+  return `${network}'/${chainId}'/${account}'/${change}${shortPath ? '' : `/${index}`}`;
+};

package/src/exceptions/SwapKitError.ts

@@ -0,0 +1,62 @@
+const errorMessages = {
+  /**
+   * Core
+   */
+  core_wallet_connection_not_found: 10001,
+  core_estimated_max_spendable_chain_not_supported: 10002,
+  core_extend_error: 10003,
+  core_inbound_data_not_found: 10004,
+  core_approve_asset_address_or_from_not_found: 10005,
+  core_chain_halted: 10099,
+  /**
+   * Core - Wallet Connection
+   */
+  core_wallet_xdefi_not_installed: 10101,
+  core_wallet_evmwallet_not_installed: 10102,
+  core_wallet_walletconnect_not_installed: 10103,
+  core_wallet_keystore_not_installed: 10104,
+  core_wallet_ledger_not_installed: 10105,
+  core_wallet_trezor_not_installed: 10106,
+  core_wallet_keplr_not_installed: 10107,
+  core_wallet_okx_not_installed: 10108,
+  /**
+   * Core - Swap
+   */
+  core_swap_invalid_params: 10200,
+  core_swap_route_not_complete: 10201,
+  core_swap_asset_not_recognized: 10202,
+  core_swap_contract_not_found: 10203,
+  core_swap_route_transaction_not_found: 10204,
+  core_swap_contract_not_supported: 10205,
+  core_swap_transaction_error: 10206,
+  core_swap_quote_mode_not_supported: 10207,
+  /**
+   * Core - Transaction
+   */
+  core_transaction_deposit_error: 10301,
+  core_transaction_create_liquidity_rune_error: 10302,
+  core_transaction_create_liquidity_asset_error: 10303,
+  core_transaction_create_liquidity_invalid_params: 10304,
+  core_transaction_add_liquidity_invalid_params: 10305,
+  core_transaction_add_liquidity_no_rune_address: 10306,
+  core_transaction_add_liquidity_rune_error: 10307,
+  core_transaction_add_liquidity_asset_error: 10308,
+  core_transaction_withdraw_error: 10309,
+  core_transaction_deposit_to_pool_error: 10310,
+
+  /**
+   * Wallets
+   */
+  wallet_ledger_connection_error: 2001,
+} as const;
+
+type Keys = keyof typeof errorMessages;
+
+export class SwapKitError extends Error {
+  constructor(errorKey: Keys, sourceError?: any) {
+    console.error(sourceError);
+
+    super(errorKey, { cause: { code: errorMessages[errorKey], message: errorKey } });
+    Object.setPrototypeOf(this, SwapKitError.prototype);
+  }
+}

package/src/exceptions/index.ts

@@ -0,0 +1 @@
+export * from './SwapKitError.ts';

package/src/fees.ts

@@ -0,0 +1,13 @@
+import { type AmountWithBaseDenom, FeeOption } from '@pioneer-platform/types';
+
+export const singleFee = (fee: AmountWithBaseDenom): Record<FeeOption, AmountWithBaseDenom> => ({
+  [FeeOption.Average]: fee,
+  [FeeOption.Fast]: fee,
+  [FeeOption.Fastest]: fee,
+});
+
+export const gasFeeMultiplier: Record<FeeOption, number> = {
+  [FeeOption.Average]: 1.2,
+  [FeeOption.Fast]: 1.5,
+  [FeeOption.Fastest]: 2,
+};

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './amount.ts';
+export * from './asset.ts';
+export * from './derivationPath.ts';
+export * from './exceptions/index.ts';
+export * from './fees.ts';
+export * from './request.ts';

package/src/request.ts

@@ -0,0 +1,34 @@
+export const getRequest = async <T>(
+  url: string,
+  params?: { [key in string]?: any },
+): Promise<T> => {
+  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' },
+  );
+
+  return response.json();
+};
+
+export const postRequest = async <T>(
+  url: string,
+  data: string,
+  headers?: Record<string, string>,
+  parseAsString = false,
+): Promise<T> => {
+  const response = await fetch(`${url}`, {
+    method: 'POST',
+    headers,
+    body: data,
+  });
+
+  return parseAsString ? response.text() : response.json();
+};