@swapkit/helpers 2.4.3 → 3.0.0-beta.0

package/package.json

@@ -1,17 +1,34 @@
 {
   "author": "swapkit-oss",
-  "description": "SwapKit - Helpers",
   "dependencies": {
-    "@swapkit/contracts": "1.1.0",
-    "@swapkit/tokens": "2.2.2"
+    "zod": "3.24.2",
+    "zustand": "5.0.3"
   },
+  "description": "SwapKit - Helpers",
   "devDependencies": {
-    "@swapkit/toolbox-cosmos": "1.8.5",
-    "@swapkit/toolbox-evm": "1.8.7",
-    "@swapkit/toolbox-radix": "1.2.33",
-    "@swapkit/toolbox-solana": "1.4.5",
-    "@swapkit/toolbox-substrate": "1.3.17",
-    "@swapkit/toolbox-utxo": "1.2.17"
+    "@swapkit/toolboxes": "1.0.0-beta.0"
+  },
+  "exports": {
+    ".": {
+      "default": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./src/index.ts"
+    },
+    "./api": {
+      "default": "./dist/api/index.js",
+      "require": "./dist/api/index.cjs",
+      "types": "./src/api/index.ts"
+    },
+    "./contracts": {
+      "default": "./dist/contracts/index.js",
+      "require": "./dist/contracts/index.cjs",
+      "types": "./src/contracts/index.ts"
+    },
+    "./tokens": {
+      "default": "./dist/tokens/index.js",
+      "require": "./dist/tokens/index.cjs",
+      "types": "./src/tokens/index.ts"
+    }
   },
   "files": [
     "src/",
@@ -19,7 +36,6 @@
   ],
   "homepage": "https://github.com/thorswap/SwapKit",
   "license": "Apache-2.0",
-  "main": "./dist/index.js",
   "name": "@swapkit/helpers",
   "repository": {
     "type": "git",
@@ -28,12 +44,12 @@
   "scripts": {
     "build": "bun run ./build.ts",
     "clean": "rm -rf dist node_modules *.tsbuildinfo",
-    "lint": "biome check --diagnostic-level=error --write ./src",
+    "lint": "biome check --write ./src",
+    "generate-tokens": "bun --bun ./fetchTokenLists.ts",
     "test": "bun test",
-    "test:coverage": "bun test --coverage",
+    "test:ci": "bun test --coverage",
     "type-check": "tsc --noEmit"
   },
   "type": "module",
-  "types": "./src/index.ts",
-  "version": "2.4.3"
-}
+  "version": "3.0.0-beta.0"
+}

package/src/api/index.ts

@@ -0,0 +1,19 @@
+import * as microgard from "./microgard/endpoints";
+import { mayachainMidgard, thorchainMidgard } from "./midgard/endpoints";
+import * as swapkit from "./swapkitApi/endpoints";
+import * as thornode from "./thornode/endpoints";
+import * as tsStatic from "./thorswapStatic/endpoints";
+
+export * from "./microgard/types";
+export * from "./thorswapStatic/types";
+export * from "./thornode/types";
+export * from "./swapkitApi/types";
+
+export const SwapKitApi = {
+  ...swapkit,
+  ...tsStatic,
+  mayachainMidgard,
+  microgard,
+  thorchainMidgard,
+  thornode,
+};

package/src/api/microgard/endpoints.ts

@@ -0,0 +1,83 @@
+import {
+  AssetValue,
+  BaseDecimal,
+  type Chain,
+  RequestClient,
+  SwapKitNumber,
+} from "@swapkit/helpers";
+import type { LiquidityPositionRaw, PoolDetail, PoolPeriod, THORNameDetails } from "./types";
+
+/**
+ * TODO: Move to SKConfig under midgardUrls.microgard
+ */
+const baseUrl = "https://mu.thorswap.net";
+
+export function getTHORNameDetails(thorname: string) {
+  return RequestClient.get<THORNameDetails>(`${baseUrl}/thorname/lookup/${thorname}`);
+}
+
+export function getTHORNamesByOwner(owner: string) {
+  return RequestClient.get<string[]>(`${baseUrl}/thorname/owner/${owner}`);
+}
+
+export function getTHORNamesByAddress(address: string) {
+  return RequestClient.get<string[]>(`${baseUrl}/thorname/address/${address}`);
+}
+
+export function getTHORChainPools(period: PoolPeriod) {
+  return RequestClient.get<PoolDetail[]>(`${baseUrl}/pools`, { searchParams: { period } });
+}
+
+export function getLiquidityPositionsRaw(addresses: string[]) {
+  return RequestClient.get<LiquidityPositionRaw[]>(
+    `${baseUrl}/fullmember?address=${addresses.join(",")}`,
+  );
+}
+
+export async function getTNSChainAddress({ chain, tns }: { chain: Chain; tns: string }) {
+  const tnsDetails = await getTHORNameDetails(tns);
+
+  return tnsDetails?.entries?.find((e) => e.chain.toLowerCase() === chain.toLowerCase())?.address;
+}
+
+export async function getLiquidityPositions(addresses: string[]) {
+  const rawLiquidityPositions = await getLiquidityPositionsRaw(addresses);
+
+  return rawLiquidityPositions.map((p) => ({
+    assetRegisteredAddress: p.assetAddress,
+    asset: AssetValue.from({
+      asset: p.pool,
+      value: p.assetAdded,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    assetPending: AssetValue.from({
+      asset: p.pool,
+      value: p.assetPending,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    assetWithdrawn: AssetValue.from({
+      asset: p.pool,
+      value: p.assetWithdrawn,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    runeRegisteredAddress: p.runeAddress,
+    rune: AssetValue.from({
+      asset: "THOR.RUNE",
+      value: p.runeAdded,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    runePending: AssetValue.from({
+      asset: "THOR.RUNE",
+      value: p.runePending,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    runeWithdrawn: AssetValue.from({
+      asset: "THOR.RUNE",
+      value: p.runeWithdrawn,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    poolShare: new SwapKitNumber(p.sharedUnits).div(p.poolUnits),
+    dateLastAdded: p.dateLastAdded,
+    dateFirstAdded: p.dateFirstAdded,
+  }));
+}

package/src/api/microgard/types.ts

@@ -0,0 +1,60 @@
+import type { AssetValue, SwapKitNumber } from "@swapkit/helpers";
+
+export type THORNameDetails = {
+  entries: Array<{ address: string; chain: string }>;
+  owner: string;
+  expire: string;
+};
+
+export type PoolPeriod = "1h" | "24h" | "7d" | "30d" | "90d" | "100d" | "180d" | "365d";
+
+export type PoolDetail = {
+  annualPercentageRate: string;
+  asset: string;
+  assetDepth: string;
+  assetPrice: string;
+  assetPriceUSD: string;
+  liquidityUnits: string;
+  poolAPY: string;
+  runeDepth: string;
+  saversAPR: string;
+  saversDepth: string;
+  saversUnits: string;
+  status: string;
+  synthSupply: string;
+  synthUnits: string;
+  units: string;
+  volume24h: string;
+};
+
+export type LiquidityPositionRaw = {
+  assetAdded: string;
+  assetAddress: string;
+  assetPending: string;
+  assetWithdrawn: string;
+  dateFirstAdded: string;
+  dateLastAdded: string;
+  pool: string;
+  poolAssetDepth: string;
+  poolRuneDepth: string;
+  poolUnits: string;
+  runeAdded: string;
+  runeAddress: string;
+  runePending: string;
+  runeWithdrawn: string;
+  sharedUnits: string;
+};
+
+export type LiquidityPosition = {
+  asset: AssetValue;
+  assetPending: AssetValue;
+  assetWithdrawn: AssetValue;
+  assetAddress: string;
+  native: AssetValue;
+  nativeAddress: string;
+  nativePending: AssetValue;
+  nativeWithdrawn: AssetValue;
+  dateFirstAdded: string;
+  dateLastAdded: string;
+  poolShare: SwapKitNumber;
+};

package/src/api/midgard/endpoints.ts

@@ -0,0 +1,166 @@
+import { AssetValue, BaseDecimal, Chain, RequestClient, SwapKitNumber } from "@swapkit/helpers";
+import type {
+  BorrowerDetails,
+  MemberDetailsMayachain,
+  MemberDetailsThorchain,
+  SaverDetails,
+  THORNameDetails,
+} from "./types";
+
+// TODO: question: Move to SKConfig under midgardUrls
+// also - shouldn't that be named `isThorchain`?
+// As we default to TC and this is the only place that checks for opposite
+function getMidgardBaseUrl(isMayachain = false) {
+  return isMayachain ? "https://midgard.mayachain.info" : "https://midgard.ninerealms.com";
+}
+
+function getNameServiceBaseUrl(isMayachain = false) {
+  return isMayachain
+    ? `${getMidgardBaseUrl(isMayachain)}/v2/mayaname`
+    : `${getMidgardBaseUrl(isMayachain)}/v2/thorname`;
+}
+
+export function getBorrowerDetailRaw(address: string, isMayachain = false) {
+  return RequestClient.get<BorrowerDetails>(
+    `${getMidgardBaseUrl(isMayachain)}/v2/borrower/${address}`,
+  );
+}
+
+export function getSaverDetailRaw(address: string, isMayachain = false) {
+  return RequestClient.get<SaverDetails>(`${getMidgardBaseUrl(isMayachain)}/v2/saver/${address}`);
+}
+
+export function getLiquidityPositionRaw<T extends boolean = false>(
+  address: string,
+  isMayachain?: T,
+) {
+  return RequestClient.get<T extends true ? MemberDetailsMayachain : MemberDetailsThorchain>(
+    `${getMidgardBaseUrl(isMayachain)}/v2/member/${address}`,
+  );
+}
+
+export function getNameDetails(name: string, isMayachain = false) {
+  return RequestClient.get<THORNameDetails>(`${getNameServiceBaseUrl(isMayachain)}/lookup/${name}`);
+}
+
+export function getNamesByAddress(address: string, isMayachain = false) {
+  return RequestClient.get<THORNameDetails>(
+    `${getNameServiceBaseUrl(isMayachain)}/rlookup/${address}`,
+  );
+}
+
+export function getNamesByOwner(address: string, isMayachain = false) {
+  return RequestClient.get<THORNameDetails>(
+    `${getNameServiceBaseUrl(isMayachain)}/owner/${address}`,
+  );
+}
+
+export async function getBorrowerDetail(address: string, isMayachain = false) {
+  const rawBorrowerDetail = await getBorrowerDetailRaw(address, isMayachain);
+
+  return rawBorrowerDetail.pools.map((p) => ({
+    collateral_deposited: AssetValue.from({
+      asset: p.collateral_asset,
+      value: p.collateral_deposited,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    collateral_withdrawn: AssetValue.from({
+      asset: p.collateral_asset,
+      value: p.collateral_withdrawn,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    debt_issued_tor: SwapKitNumber.fromBigInt(BigInt(p.debt_issued_tor), BaseDecimal.THOR),
+    debt_repaid_tor: SwapKitNumber.fromBigInt(BigInt(p.debt_repaid_tor), BaseDecimal.THOR),
+    last_open_loan_timestamp: p.last_open_loan_timestamp,
+    last_repay_loan_timestamp: p.last_repay_loan_timestamp,
+    target_assets: p.target_assets.map((asset) => AssetValue.from({ asset })),
+  }));
+}
+
+export async function getSaverDetail(address: string, isMayachain = false) {
+  const rawSaverPositions = await getSaverDetailRaw(address, isMayachain);
+
+  return rawSaverPositions.pools.map((p) => ({
+    assetRegisteredAddress: p.assetAddress,
+    assetAdded: AssetValue.from({
+      asset: p.pool,
+      value: p.assetAdded,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    assetDeposit: AssetValue.from({
+      asset: p.pool,
+      value: p.assetDeposit,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    assetRedeem: AssetValue.from({
+      asset: p.pool,
+      value: p.assetRedeem,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    assetWithdrawn: AssetValue.from({
+      asset: p.pool,
+      value: p.assetWithdrawn,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    dateLastAdded: p.dateLastAdded,
+    dateFirstAdded: p.dateFirstAdded,
+  }));
+}
+
+export async function getLiquidityPosition(address: string, isMayachain = false) {
+  const rawLiquidityPositions = await getLiquidityPositionRaw(address, isMayachain);
+
+  return rawLiquidityPositions.pools.map((p) => ({
+    assetRegisteredAddress: p.assetAddress,
+    asset: AssetValue.from({
+      asset: p.pool,
+      value: p.assetAdded,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    assetPending: AssetValue.from({
+      asset: p.pool,
+      value: p.assetPending,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    assetWithdrawn: AssetValue.from({
+      asset: p.pool,
+      value: p.assetWithdrawn,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    [`${isMayachain ? "cacao" : "rune"}RegisteredAddress`]: p.runeAddress,
+    [`${isMayachain ? "cacao" : "rune"}`]: AssetValue.from({
+      asset: "THOR.RUNE",
+      value: p.runeAdded,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    [`${isMayachain ? "cacao" : "rune"}Pending`]: AssetValue.from({
+      asset: "THOR.RUNE",
+      value: p.runePending,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    [`${isMayachain ? "cacao" : "rune"}Withdrawn`]: AssetValue.from({
+      asset: "THOR.RUNE",
+      value: p.runeWithdrawn,
+      fromBaseDecimal: BaseDecimal.THOR,
+    }),
+    poolShare: new SwapKitNumber(p.liquidityUnits).div(p.pool),
+    dateLastAdded: p.dateLastAdded,
+    dateFirstAdded: p.dateFirstAdded,
+  }));
+}
+
+const getMidgardMethodsForProtocol = (chain: Chain.THORChain | Chain.Maya) => ({
+  getBorrowerDetail: (address: string) => getBorrowerDetail(address, chain === Chain.Maya),
+  getBorrowerDetailRaw: (address: string) => getBorrowerDetailRaw(address, chain === Chain.Maya),
+  getSaversDetail: (address: string) => getSaverDetail(address, chain === Chain.Maya),
+  getSaverDetailRaw: (address: string) => getSaverDetailRaw(address, chain === Chain.Maya),
+  getLiquidityPosition: (address: string) => getLiquidityPosition(address, chain === Chain.Maya),
+  getLiquidityPositionRaw: (address: string) =>
+    getLiquidityPositionRaw(address, chain === Chain.Maya),
+  getNameDetails: (name: string) => getNameDetails(name, chain === Chain.Maya),
+  getNamesByAddress: (address: string) => getNamesByAddress(address, chain === Chain.Maya),
+  getNamesByOwner: (address: string) => getNamesByOwner(address, chain === Chain.Maya),
+});
+
+export const thorchainMidgard = getMidgardMethodsForProtocol(Chain.THORChain);
+export const mayachainMidgard = getMidgardMethodsForProtocol(Chain.Maya);

package/src/api/midgard/types.ts

@@ -0,0 +1,155 @@
+export type BorrowerDetails = {
+  /** @description List details of all the loans identified with the given address */
+  pools: BorrowerPool[];
+};
+
+export type BorrowerPool = {
+  /** @description The asset that the borrower used as collateral */
+  collateral_asset: string;
+  /** @description Int64(e8), The total amount of collateral that user deposited */
+  collateral_deposited: string;
+  /** @description Int64(e8), The total amount of collateral the system paid back to the user */
+  collateral_withdrawn: string;
+  /** @description Int64(e8), The total amount of debt issued as debt for user. denominated in TOR. */
+  debt_issued_tor: string;
+  /** @description Int64(e8), The total amount of debt that the user paid back. denominated in TOR. */
+  debt_repaid_tor: string;
+  /** @description Int64, Unix timestamp for the last time borrower opened a loan */
+  last_open_loan_timestamp: string;
+  /** @description Int64, Unix timestamp for the last time borrower repayment occurred */
+  last_repay_loan_timestamp: string;
+  target_assets: string[];
+};
+
+export type SaverDetails = {
+  /** @description List details of all the savers identified with the given address */
+  pools: SaverPool[];
+};
+
+export type SaverPool = {
+  /** @description Int64(e8), total asset added in the saver pool by member */
+  assetAdded: string;
+  /** @description saver address used by the member */
+  assetAddress: string;
+  /** @description Int64(e8), total asset that is currently deposited by the member */
+  assetDeposit: string;
+  /** @description Int64(e8), total asset can be redeemed from the saver pool by member */
+  assetRedeem: string;
+  /** @description Int64(e8), total asset withdrawn from the saver pool by member */
+  assetWithdrawn: string;
+  /** @description Int64, Unix timestamp for the first time member deposited into the saver pool */
+  dateFirstAdded: string;
+  /** @description Int64, Unix timestamp for the last time member deposited into the saver pool */
+  dateLastAdded: string;
+  /** @description The Pool rest of the data are refering to (only those pools can show up which have a corresponding saver pool) */
+  pool: string;
+  /** @description Int64, saver liquidity units that belong the the member */
+  saverUnits: string;
+};
+
+export type MemberDetailsMayachain = {
+  /** @MemberPool List details of all the liquidity providers identified with the given address */
+  pools: MemberPoolMayachain[];
+};
+
+export type MemberPoolMayachain = {
+  /** @description Int64(e8), total asset added to the pool by member */
+  assetAdded: string;
+  /** @description asset address used by the member */
+  assetAddress: string;
+  /** @description Int64(e8), total asset that is currently deposited to the pool by member.
+   *     This field is same as the `asset_deposit_value` field in thornode. Mainly can be used
+   *     for tracking, mainly Growth Percentage
+   *      */
+  assetDeposit: string;
+  /** @description Int64(e8), asset sent but not added yet, it will be added when the rune pair arrives
+   *      */
+  assetPending: string;
+  /** @description Int64(e8), total asset withdrawn from the pool by member */
+  assetWithdrawn: string;
+  /** @description Int64(e8), total Cacao that is currently deposited to the pool by member.
+   *     This field is same as the `rune_deposit_value` field in thornode. Mainly can be used
+   *     for tracking, mainly Growth Percentage
+   *      */
+  cacaoDeposit: string;
+  /** @description Int64, Unix timestamp for the first time member deposited into the pool */
+  dateFirstAdded: string;
+  /** @description Int64, Unix timestamp for the last time member deposited into the pool */
+  dateLastAdded: string;
+  /** @description Int64, pool liquidity units that belong the the member */
+  liquidityUnits: string;
+  /** @description Pool rest of the data refers to */
+  pool: string;
+  /** @description Int64(e8), total Rune added to the pool by member */
+  runeAdded: string;
+  /** @description Rune address used by the member */
+  runeAddress: string;
+  /** @description Int64(e8), Rune sent but not added yet, it will be added when the asset pair arrives
+   *      */
+  runePending: string;
+  /** @description Int64(e8), total Rune withdrawn from the pool by member */
+  runeWithdrawn: string;
+};
+
+export type MemberDetailsThorchain = {
+  /** @MemberPool List details of all the liquidity providers identified with the given address */
+  pools: MemberPoolThorchain[];
+};
+
+export type MemberPoolThorchain = {
+  /** @description Int64(e8), total asset added to the pool by member */
+  assetAdded: string;
+  /** @description asset address used by the member */
+  assetAddress: string;
+  /** @description Int64(e8), total asset that is currently deposited to the pool by member.
+   *     This field is same as the `asset_deposit_value` field in thornode. Mainly can be used
+   *     for tracking, mainly Growth Percentage
+   *      */
+  assetDeposit: string;
+  /** @description Int64(e8), asset sent but not added yet, it will be added when the rune pair arrives
+   *      */
+  assetPending: string;
+  /** @description Int64(e8), total asset withdrawn from the pool by member */
+  assetWithdrawn: string;
+  /** @description Int64(e8), total Rune that is currently deposited to the pool by member.
+   *     This field is same as the `rune_deposit_value` field in thornode. Mainly can be used
+   *     for tracking, mainly Growth Percentage
+   *      */
+  runeDeposit: string;
+  /** @description Int64, Unix timestamp for the first time member deposited into the pool */
+  dateFirstAdded: string;
+  /** @description Int64, Unix timestamp for the last time member deposited into the pool */
+  dateLastAdded: string;
+  /** @description Int64, pool liquidity units that belong the the member */
+  liquidityUnits: string;
+  /** @description Pool rest of the data refers to */
+  pool: string;
+  /** @description Int64(e8), total Rune added to the pool by member */
+  runeAdded: string;
+  /** @description Rune address used by the member */
+  runeAddress: string;
+  /** @description Int64(e8), Rune sent but not added yet, it will be added when the asset pair arrives
+   *      */
+  runePending: string;
+  /** @description Int64(e8), total Rune withdrawn from the pool by member */
+  runeWithdrawn: string;
+};
+
+export type THORNameDetails = {
+  /** @description List details of all chains and their addresses for a given THORName */
+  entries: THORNameEntry[];
+  /** @description Int64, THORChain block height in which THORName expires */
+  expire: string;
+  /**
+   * @description owner's THOR address
+   * @example thor102y0m3uptg0vvudeyh00r2fnz70wq7d8y7mu2g
+   */
+  owner: string;
+};
+
+export type THORNameEntry = {
+  /** @description address on blockchain */
+  address: string;
+  /** @description blockchain */
+  chain: string;
+};