@swapkit/helpers 1.0.0-rc.8 → 1.0.0-rc.81

package/src/helpers/memo.ts

@@ -1,5 +1,4 @@
-import type { Chain } from '@swapkit/types';
-import { MemoType } from '@swapkit/types';
+import { Chain, MemoType } from "@swapkit/types";
 
 export type ThornameRegisterParam = {
   name: string;
@@ -10,25 +9,14 @@ export type ThornameRegisterParam = {
   expiryBlock?: string;
 };
 
-const getShortenedSymbol = ({
-  symbol,
-  ticker,
-  chain,
-}: {
-  ticker: string;
-  symbol: string;
-  chain: string | Chain;
-}) => (chain === 'ETH' && ticker !== 'ETH' ? `${ticker}-${symbol.slice(-3)}` : symbol);
-
-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;
@@ -37,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>) => {
@@ -50,29 +38,43 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
 
     case MemoType.UNBOND: {
       const { address, unbondAmount } = options as MemoOptions<MemoType.UNBOND>;
-      return `${memoType}:${address}:${unbondAmount * 10 ** 8}`;
+      return `${memoType}:${address}:${unbondAmount}`;
     }
 
     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: {
       const { chain, symbol, address, singleSide } = options as MemoOptions<MemoType.DEPOSIT>;
 
+      const getPoolIdentifier = (chain: Chain, symbol: string): string => {
+        switch (chain) {
+          case Chain.Litecoin:
+            return "l";
+          case Chain.Dogecoin:
+            return "d";
+          case Chain.BitcoinCash:
+            return "c";
+          default:
+            return `${chain}.${symbol}`;
+        }
+      };
+
       return singleSide
-        ? `${memoType}:${chain}/${symbol}::t:0`
-        : `${memoType}:${chain}.${symbol}:${address || ''}:t:0`;
+        ? `${memoType}:${chain}/${symbol}`
+        : `${memoType}:${getPoolIdentifier(chain, symbol)}:${address || ""}`;
     }
 
     case MemoType.WITHDRAW: {
       const { chain, ticker, symbol, basisPoints, targetAssetString, singleSide } =
         options as MemoOptions<MemoType.WITHDRAW>;
 
-      const target = !singleSide && targetAssetString ? `:${targetAssetString}` : '';
-      const shortenedSymbol = getShortenedSymbol({ chain, symbol, ticker });
-      const assetDivider = singleSide ? '/' : '.';
+      const shortenedSymbol =
+        chain === "ETH" && ticker !== "ETH" ? `${ticker}-${symbol.slice(-3)}` : symbol;
+      const target = !singleSide && targetAssetString ? `:${targetAssetString}` : "";
+      const assetDivider = singleSide ? "/" : ".";
 
       return `${memoType}:${chain}${assetDivider}${shortenedSymbol}:${basisPoints}${target}`;
     }
@@ -85,6 +87,6 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
     }
 
     default:
-      return '';
+      return "";
   }
 };

package/src/helpers/others.ts

@@ -1,68 +1,42 @@
 // 10 rune for register, 1 rune per year
 // MINIMUM_REGISTRATION_FEE = 11
-export const getTHORNameCost = (year: number) => {
-  if (year < 0) throw new Error('Invalid number of year');
+export function getTHORNameCost(year: number) {
+  if (year < 0) throw new Error("Invalid number of year");
   return 10 + year;
-};
+}
 
-export const validateTHORName = (name: string) => {
+// 10 CACAO for register
+// 1.0512 CACAO per year
+export function getMAYANameCost(year: number) {
+  if (year < 0) throw new Error("Invalid number of year");
+  // round to max 10 decimals
+  return Math.round((10 + year * 1.0512) * 1e10) / 1e10;
+}
+
+export function validateTHORName(name: string) {
   if (name.length > 30) return false;
 
   const regex = /^[a-zA-Z0-9+_-]+$/g;
 
   return !!name.match(regex);
-};
-
-export const derivationPathToString = ([network, chainId, account, change, index]: number[]) => {
-  const shortPath = typeof index !== 'number';
-
-  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 function validateMAYAName(name: string) {
+  if (name.length > 30) return false;
 
-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',
-    });
+  const regex = /^[a-zA-Z0-9+_-]+$/g;
 
-    return parseAsString ? response.text() : response.json();
-  } catch (error) {
-    return {} as T;
-  }
-};
+  return !!name.match(regex);
+}
+
+export function derivationPathToString([network, chainId, account, change, index]: [
+  number,
+  number,
+  number,
+  number,
+  number | undefined,
+]) {
+  const shortPath = typeof index !== "number";
+
+  return `${network}'/${chainId}'/${account}'/${change}${shortPath ? "" : `/${index}`}`;
+}

package/src/helpers/validators.ts

@@ -1,17 +1,18 @@
-import { Chain } from '@swapkit/types';
+import { Chain } from "@swapkit/types";
 
-const supportedChains = Object.values(Chain);
+// Backward compatibility
+const supportedChains = [...Object.values(Chain), "TERRA"];
 
-export const validateIdentifier = (identifier: string = '') => {
+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(
     `Invalid identifier: ${identifier}. Expected format: <Chain>.<Ticker> or <Chain>.<Ticker>-<ContractAddress>`,
   );
-};
+}

package/src/index.ts

@@ -1,15 +1,17 @@
+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";