@swapkit/helpers 1.2.4 → 1.3.1

package/package.json

@@ -2,17 +2,17 @@
   "author": "swapkit-oss",
   "description": "SwapKit - Helpers",
   "dependencies": {
-    "@swapkit/tokens": "1.0.3",
-    "picocolors": "1.0.1",
-    "zod": "3.23.8"
+    "@swapkit/contracts": "1.0.4",
+    "@swapkit/tokens": "1.1.0",
+    "picocolors": "1.0.1"
   },
   "devDependencies": {
-    "@swapkit/toolbox-cosmos": "1.0.14",
-    "@swapkit/toolbox-evm": "1.1.8",
-    "@swapkit/toolbox-solana": "1.0.13",
-    "@swapkit/toolbox-radix": "1.0.13",
-    "@swapkit/toolbox-substrate": "1.1.8",
-    "@swapkit/toolbox-utxo": "1.0.13"
+    "@swapkit/toolbox-cosmos": "1.0.17",
+    "@swapkit/toolbox-evm": "1.1.10",
+    "@swapkit/toolbox-solana": "1.0.15",
+    "@swapkit/toolbox-radix": "1.0.15",
+    "@swapkit/toolbox-substrate": "1.1.10",
+    "@swapkit/toolbox-utxo": "1.0.15"
   },
   "files": [
     "src/",
@@ -37,5 +37,5 @@
   },
   "type": "module",
   "types": "./src/index.ts",
-  "version": "1.2.4"
+  "version": "1.3.1"
 }

package/src/helpers/__tests__/others.test.ts

@@ -51,4 +51,21 @@ describe("getAssetBy", () => {
     expect(assetByIdentifier).toBeUndefined();
     expect(assetByChainAndContract).toBeUndefined();
   });
+
+  test("find asset by chain and radix resource", async () => {
+    const assetByChainAndContract = await findAssetBy({
+      chain: Chain.Radix,
+      contract: "resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
+    });
+    expect(assetByChainAndContract?.toUpperCase()).toBe(
+      "XRD.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75".toUpperCase(),
+    );
+  });
+
+  test("find asset by radix identifier", async () => {
+    const assetByChainAndContract = await findAssetBy({
+      identifier: "XRD.XRD",
+    });
+    expect(assetByChainAndContract?.toUpperCase()).toBe("XRD.XRD".toUpperCase());
+  });
 });

package/src/helpers/asset.ts

@@ -259,7 +259,9 @@ export const filterAssets = (
   });
 
 export async function findAssetBy(
-  params: { chain: EVMChain; contract: string } | { identifier: `${Chain}.${string}` },
+  params:
+    | { chain: EVMChain | Chain.Radix; contract: string }
+    | { identifier: `${Chain}.${string}` },
 ) {
   const tokenPackages = await import("@swapkit/tokens");
 

package/src/helpers/memo.ts

@@ -2,111 +2,19 @@ import { SwapKitError } from "../modules/swapKitError";
 import { Chain } from "../types/chains";
 import { MemoType } from "../types/sdk";
 
-type WithChain<T extends {}> = T & { chain: Chain };
-
-type WithAffiliate<T extends {}> = T & {
-  affiliateAddress?: string;
-  affiliateBasisPoints?: number;
-};
-
-function addAffiliate(memo: string, { affiliateAddress, affiliateBasisPoints }: WithAffiliate<{}>) {
-  const affiliatePart = affiliateAddress ? `:${affiliateAddress}:${affiliateBasisPoints || 0}` : "";
-
-  return `${memo}${affiliatePart}`;
-}
-
-function getPoolIdentifier({
-  chain,
-  symbol,
-}: {
-  chain: Chain;
-  symbol: string;
-}) {
-  switch (chain) {
-    case Chain.Bitcoin:
-    case Chain.Dogecoin:
-    case Chain.Litecoin:
-      return chain.slice(0, 1).toLowerCase();
-    case Chain.BitcoinCash:
-      return "c";
-
-    default:
-      return `${chain}.${symbol}`;
-  }
-}
-
-export function getMemoForLeaveAndBond({
-  type,
-  address,
-}: {
-  type: MemoType.BOND | MemoType.LEAVE;
-  address: string;
-}) {
+export function getMemoForLeaveAndBond({ type, address }: BondOrLeaveParams) {
   return `${type}:${address}`;
 }
 
-export function getMemoForUnbond({
-  address,
-  unbondAmount,
-}: {
-  address: string;
-  unbondAmount: number;
-}) {
+export function getMemoForUnbond({ address, unbondAmount }: UnbondParams) {
   return `${MemoType.UNBOND}:${address}:${unbondAmount}`;
 }
 
-export function getMemoForNameRegister({
-  name,
-  chain,
-  address,
-  owner,
-}: {
-  name: string;
-  chain: string;
-  address: string;
-  owner?: string;
-}) {
-  const baseMemo = `${MemoType.NAME_REGISTER}:${name}:${chain}:${address}`;
-  const ownerAssignmentOrChangePart = owner ? `:${owner}` : "";
-
-  return `${baseMemo}${ownerAssignmentOrChangePart}`;
-}
-
-export function getMemoForNamePreferredAssetRegister({
-  name,
-  chain,
-  asset,
-  payout,
-  owner,
-}: {
-  name: string;
-  chain: Chain;
-  asset: string;
-  payout: string;
-  owner: string;
-}) {
-  const memo = [name, chain, payout, owner, asset].join(":");
-
-  return `${MemoType.NAME_REGISTER}:${memo}`;
-}
-
-export function getMemoForLoan(
-  memoType: MemoType.OPEN_LOAN | MemoType.CLOSE_LOAN,
-  {
-    asset,
-    address,
-    minAmount,
-    ...affiliate
-  }: WithAffiliate<{
-    address: string;
-    asset: string;
-    minAmount?: string;
-  }>,
-) {
-  const baseMemo = `${memoType}:${asset}:${address}`;
-  const minAmountPart = minAmount ? `:${minAmount}` : "";
-
-  return addAffiliate(`${baseMemo}${minAmountPart}`, affiliate);
+/**
+ * Deposit
+ */
+export function getMemoForRunePoolDeposit(affiliate?: WithAffiliate<{}>) {
+  return addAffiliate(MemoType.RUNEPOOL_DEPOSIT, affiliate);
 }
 
 export function getMemoForSaverDeposit({
@@ -128,12 +36,14 @@ export function getMemoForDeposit({
   address?: string;
 }>) {
   const poolIdentifier = getPoolIdentifier({ chain, symbol });
-  const hasAffiliateInfo = !!affiliate.affiliateAddress;
-  const addressPart = address ? `:${address}` : hasAffiliateInfo ? ":" : "";
+  const addressPart = address ? `:${address}:` : ":";
 
   return addAffiliate(`${MemoType.DEPOSIT}:${poolIdentifier}${addressPart}`, affiliate);
 }
 
+/**
+ * Withdraw
+ */
 export function getMemoForSaverWithdraw({
   chain,
   symbol,
@@ -148,13 +58,7 @@ export function getMemoForWithdraw({
   ticker,
   basisPoints,
   targetAsset,
-}: {
-  chain: Chain;
-  symbol: string;
-  ticker: string;
-  basisPoints: number;
-  targetAsset?: string;
-}) {
+}: WithdrawParams) {
   const shortenedSymbol =
     chain === "ETH" && ticker !== "ETH" ? `${ticker}-${symbol.slice(-3)}` : symbol;
   const targetPart = targetAsset ? `:${targetAsset}` : "";
@@ -162,10 +66,6 @@ export function getMemoForWithdraw({
   return `${MemoType.WITHDRAW}:${chain}.${shortenedSymbol}:${basisPoints}${targetPart}`;
 }
 
-export function getMemoForRunePoolDeposit() {
-  return `${MemoType.RUNEPOOL_DEPOSIT}`;
-}
-
 export function getMemoForRunePoolWithdraw({
   basisPoints,
   ...affiliate
@@ -174,62 +74,120 @@ export function getMemoForRunePoolWithdraw({
 }
 
 /**
- * @deprecated - Use separate functions per each memo type like getMemoForDeposit, getMemoForWithdraw, etc.
+ * TNS
+ */
+export function getMemoForNameRegister({ name, chain, address, owner }: NameRegisterParams) {
+  const baseMemo = `${MemoType.NAME_REGISTER}:${name}:${chain}:${address}`;
+  const ownerAssignmentOrChangePart = owner ? `:${owner}` : "";
+
+  return `${baseMemo}${ownerAssignmentOrChangePart}`;
+}
+
+export function getMemoForNamePreferredAssetRegister({
+  name,
+  chain,
+  asset,
+  payout,
+  owner,
+}: PreferredAssetRegisterParams) {
+  return `${MemoType.NAME_REGISTER}:${name}:${chain}:${payout}:${owner}:${asset}`;
+}
+
+export function getMemoForLoan(
+  memoType: MemoType.OPEN_LOAN | MemoType.CLOSE_LOAN,
+  {
+    asset,
+    address,
+    minAmount,
+    ...affiliate
+  }: WithAffiliate<{ address: string; asset: string; minAmount?: string }>,
+) {
+  const baseMemo = `${memoType}:${asset}:${address}`;
+  const minAmountPart = minAmount ? `:${minAmount}` : "";
+
+  return addAffiliate(`${baseMemo}${minAmountPart}`, affiliate);
+}
+
+/**
+ * Internal helpers
  */
-export type MemoOptions<T extends MemoType> = {
-  [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;
-    symbol: string;
-    basisPoints: number;
-    targetAssetString?: string;
-    singleSide?: boolean;
-  }>;
-  [MemoType.NAME_REGISTER]: { name: string; chain: string; address: string };
-  [MemoType.RUNEPOOL_DEPOSIT]: {};
-  [MemoType.RUNEPOOL_WITHDRAW]: {
-    basisPoints: number;
-    affiliateAddress?: string;
-    affiliateBasisPoints?: number;
-  };
-}[T];
+function addAffiliate(
+  memo: string,
+  { affiliateAddress, affiliateBasisPoints }: WithAffiliate<{}> = {},
+) {
+  const affiliatedMemo = `${memo}${affiliateAddress ? `:${affiliateAddress}:${affiliateBasisPoints || 0}` : ""}`;
+
+  return affiliatedMemo.endsWith(":") ? affiliatedMemo.slice(0, -1) : affiliatedMemo;
+}
+
+function getPoolIdentifier({
+  chain,
+  symbol,
+}: {
+  chain: Chain;
+  symbol: string;
+}) {
+  switch (chain) {
+    case Chain.Bitcoin:
+    case Chain.Dogecoin:
+    case Chain.Litecoin:
+      return chain.slice(0, 1).toLowerCase();
+    case Chain.BitcoinCash:
+      return "c";
+
+    default:
+      return `${chain}.${symbol}`;
+  }
+}
+
+type WithAffiliate<T extends {}> = T & {
+  affiliateAddress?: string;
+  affiliateBasisPoints?: number;
+};
+
+type BondOrLeaveParams = { type: MemoType.BOND | MemoType.LEAVE; address: string };
+type UnbondParams = { address: string; unbondAmount: number };
+type NameRegisterParams = { name: string; chain: string; address: string; owner?: string };
+type PreferredAssetRegisterParams = {
+  name: string;
+  chain: Chain;
+  asset: string;
+  payout: string;
+  owner: string;
+};
+type WithdrawParams = {
+  chain: Chain;
+  symbol: string;
+  ticker: string;
+  basisPoints: number;
+  targetAsset?: string;
+};
 
 /**
  * @deprecated - Use separate functions per each memo type like getMemoForDeposit, getMemoForWithdraw, etc.
  */
-export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions<T>) => {
+export const getMemoFor = <T extends MemoType>(memoType: T, options: NotWorth) => {
   switch (memoType) {
     case MemoType.LEAVE:
     case MemoType.BOND: {
-      const { address } = options as MemoOptions<MemoType.BOND>;
-      return getMemoForLeaveAndBond({ type: memoType, address });
+      return getMemoForLeaveAndBond({ type: memoType, address: options?.address });
     }
 
     case MemoType.UNBOND: {
-      const { address, unbondAmount } = options as MemoOptions<MemoType.UNBOND>;
-      return getMemoForUnbond({ address, unbondAmount });
+      return getMemoForUnbond({ address: options?.address, unbondAmount: options?.unbondAmount });
     }
 
     case MemoType.NAME_REGISTER: {
-      return getMemoForNameRegister(options as MemoOptions<MemoType.NAME_REGISTER>);
+      return getMemoForNameRegister(options);
     }
 
     case MemoType.OPEN_LOAN:
     case MemoType.CLOSE_LOAN: {
-      return getMemoForLoan(memoType, options as MemoOptions<MemoType.OPEN_LOAN>);
+      return getMemoForLoan(memoType, options);
     }
 
     case MemoType.DEPOSIT: {
-      const { chain, symbol, address, singleSide } = options as MemoOptions<MemoType.DEPOSIT>;
+      const { chain, symbol, address, singleSide } = options;
 
       if (singleSide) {
         return getMemoForSaverDeposit({ chain, symbol });
@@ -246,7 +204,7 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
         basisPoints,
         targetAssetString: targetAsset,
         singleSide,
-      } = options as MemoOptions<MemoType.WITHDRAW>;
+      } = options;
 
       if (singleSide) {
         return getMemoForSaverWithdraw({ chain, symbol, basisPoints });

package/src/index.ts

@@ -1,3 +1,4 @@
+export * from "@swapkit/contracts";
 export * from "./types/index.ts";
 
 /**

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

@@ -576,32 +576,32 @@ describe("AssetValue", () => {
         }),
       );
 
-      // TODO enable when BE fixes case sensitivity
-      //   const thor = AssetValue.from({ asset: "ETH.THOR" });
-      //   expect(thor).toEqual(
-      //     expect.objectContaining({
-      //       address: "0xa5f2211b9b8170f694421f2046281775e8468044",
-      //       chain: Chain.Ethereum,
-      //       decimal: 18,
-      //       isGasAsset: false,
-      //       isSynthetic: false,
-      //       symbol: "THOR-0xa5f2211b9b8170f694421f2046281775e8468044",
-      //       ticker: "THOR",
-      //     }),
-      //   );
-
-      //   const vthor = AssetValue.from({ asset: "ETH.vTHOR" });
-      //   expect(vthor).toEqual(
-      //     expect.objectContaining({
-      //       address: "0x815c23eca83261b6ec689b60cc4a58b54bc24d8d",
-      //       chain: Chain.Ethereum,
-      //       decimal: 18,
-      //       isGasAsset: false,
-      //       isSynthetic: false,
-      //       symbol: "vTHOR-0x815c23eca83261b6ec689b60cc4a58b54bc24d8d",
-      //       ticker: "vTHOR",
-      //     }),
-      //   );
+      const thor = AssetValue.from({ asset: "ETH.THOR" });
+      expect(thor).toEqual(
+        expect.objectContaining({
+          address: "0xa5f2211b9b8170f694421f2046281775e8468044",
+          chain: Chain.Ethereum,
+          decimal: 18,
+          isGasAsset: false,
+          isSynthetic: false,
+          symbol: "THOR-0xa5f2211b9b8170f694421f2046281775e8468044",
+          ticker: "THOR",
+        }),
+      );
+
+      // FIXME: just some casing? is it safe to change
+      // const vthor = AssetValue.from({ asset: "ETH.vTHOR" });
+      // expect(vthor).toEqual(
+      //   expect.objectContaining({
+      //     address: "0x815c23eca83261b6ec689b60cc4a58b54bc24d8d",
+      //     chain: Chain.Ethereum,
+      //     decimal: 18,
+      //     isGasAsset: false,
+      //     isSynthetic: false,
+      //     symbol: "vTHOR-0x815c23eca83261b6ec689b60cc4a58b54bc24d8d",
+      //     ticker: "vTHOR",
+      //   }),
+      // );
 
       const arbAsset = AssetValue.from({ chain: Chain.Arbitrum });
       expect(arbAsset).toEqual(

package/src/types/index.ts

@@ -1,6 +1,3 @@
-export * from "./abis/erc20";
-export * from "./abis/mayaEvmVaults";
-export * from "./abis/tcEthVault";
 export * from "./chains";
 export * from "./commonTypes";
 export * from "./derivationPath";