@swapkit/helpers 4.4.5 → 4.5.2

package/src/api/thornode/endpoints.ts

@@ -0,0 +1,105 @@
+import { AssetValue, RequestClient, SKConfig } from "@swapkit/helpers";
+import { MAYAConfig, StagenetMAYAConfig, StagenetTHORConfig, THORConfig } from "@swapkit/types";
+import type {
+  InboundAddressesItem,
+  LastBlockItem,
+  MimirData,
+  NodeItem,
+  RunePoolInfo,
+  RunePoolProviderInfo,
+  TCYClaimerResponse,
+  TCYClaimersResponse,
+  TCYStakerResponse,
+  TCYStakersResponse,
+  THORNodeTNSDetails,
+  THORNodeType,
+} from "./types";
+
+function baseUrl(type?: THORNodeType) {
+  const { isStagenet } = SKConfig.get("envs");
+
+  switch (type) {
+    case "mayachain": {
+      const nodeUrl = isStagenet ? StagenetMAYAConfig.nodeUrl : MAYAConfig.nodeUrl;
+      return `${nodeUrl}/mayachain`;
+    }
+    default: {
+      const nodeUrl = isStagenet ? StagenetTHORConfig.nodeUrl : THORConfig.nodeUrl;
+
+      return `${nodeUrl}/thorchain`;
+    }
+  }
+}
+
+function getNameServiceBaseUrl(type?: THORNodeType) {
+  const nsType = type === "mayachain" ? "mayaname" : "thorname";
+
+  return `${baseUrl(type)}/${nsType}`;
+}
+
+export function getLastBlock<T extends THORNodeType = "thorchain">(type: T = "thorchain" as T) {
+  return RequestClient.get<LastBlockItem<T>[]>(`${baseUrl(type)}/lastblock`);
+}
+
+export function getThorchainQueue(type?: THORNodeType) {
+  return RequestClient.get(`${baseUrl(type)}/queue`);
+}
+
+export function getNodes(type?: THORNodeType) {
+  return RequestClient.get<NodeItem[]>(`${baseUrl(type)}/nodes`);
+}
+
+export function getMimirInfo(type?: THORNodeType) {
+  return RequestClient.get<MimirData>(`${baseUrl(type)}/mimir`);
+}
+
+export function getInboundAddresses(type?: THORNodeType) {
+  return RequestClient.get<InboundAddressesItem[]>(`${baseUrl(type)}/inbound_addresses`);
+}
+
+export async function getTHORNodeTNSDetails({
+  type,
+  name,
+}: {
+  type?: THORNodeType;
+  name: string;
+}): Promise<THORNodeTNSDetails> {
+  try {
+    const result = await RequestClient.get<THORNodeTNSDetails>(`${getNameServiceBaseUrl(type)}/${name}`);
+    return result;
+  } catch {
+    return { affiliate_collector_rune: "", aliases: [], expire_block_height: 0, name, owner: "", preferred_asset: "" };
+  }
+}
+
+export async function getTNSPreferredAsset({ type, tns }: { type?: THORNodeType; tns: string }) {
+  const tnsDetails = await getTHORNodeTNSDetails({ name: tns, type });
+
+  if (!tnsDetails.preferred_asset || tnsDetails.preferred_asset === ".") return undefined;
+
+  return AssetValue.from({ asset: tnsDetails.preferred_asset, asyncTokenLookup: true });
+}
+
+export function getRunePoolInfo(type?: THORNodeType) {
+  return RequestClient.get<RunePoolInfo>(`${baseUrl(type)}/runepool`);
+}
+
+export function getRunePoolProviderInfo({ type, thorAddress }: { type?: THORNodeType; thorAddress: string }) {
+  return RequestClient.get<RunePoolProviderInfo>(`${baseUrl(type)}/rune_provider/${thorAddress}`);
+}
+
+export function getTcyStaker({ type, address }: { type?: THORNodeType; address: string }) {
+  return RequestClient.get<TCYStakerResponse>(`${baseUrl(type)}/tcy_staker/${address}`);
+}
+
+export function getTcyStakers(type?: THORNodeType) {
+  return RequestClient.get<TCYStakersResponse>(`${baseUrl(type)}/tcy_stakers`);
+}
+
+export function getTcyClaimer({ type, address }: { type?: THORNodeType; address: string }) {
+  return RequestClient.get<TCYClaimerResponse>(`${baseUrl(type)}/tcy_claimer/${address}`);
+}
+
+export function getTcyClaimers(type?: THORNodeType) {
+  return RequestClient.get<TCYClaimersResponse>(`${baseUrl(type)}/tcy_claimers`);
+}

package/src/api/thornode/types.ts

@@ -0,0 +1,247 @@
+export type THORNodeType = "thorchain" | "mayachain";
+
+export type THORNodeTNSDetails = {
+  name: string;
+  expire_block_height: number;
+  owner: string;
+  preferred_asset: string;
+  affiliate_collector_rune: string;
+  aliases: { chain: string; address: string }[];
+};
+
+export type InboundAddressesItem = {
+  address: string;
+  chain: string;
+  gas_rate?: string;
+  halted: boolean;
+  pub_key: string;
+  router?: string;
+  global_trading_paused: boolean;
+  chain_trading_paused: boolean;
+  chain_lp_actions_paused: boolean;
+  observed_fee_rate?: string;
+  gas_rate_units: string;
+  outbound_tx_size: string;
+  outbound_fee: string;
+  dust_threshold: string;
+};
+
+export type LastBlockItem<T extends THORNodeType = "thorchain"> = {
+  chain: string;
+  last_observed_in: number;
+  last_signed_out: number;
+} & {
+  [K in T]: number;
+};
+
+export type NodeItem = {
+  active_block_height: number;
+  bond_address: string;
+  current_award: string;
+  forced_to_leave: boolean;
+  ip_address: string;
+  leave_height: number;
+  node_address: string;
+  requested_to_leave: boolean;
+  signer_membership: string[];
+  slash_points: number;
+  status: string;
+  status_since: number;
+  total_bond: string;
+  validator_cons_pub_key: string;
+  version: string;
+  jail: any;
+  preflight_status: any;
+  pub_key_set: any;
+  observe_chains: { chain: string; height: number }[];
+};
+
+export type MimirData = {
+  ADR012: number;
+  ASGARDSIZE: number;
+  BADVALIDATORREDLINE: number;
+  BURNSYNTHS: number;
+  CHURNINTERVAL: number;
+  CLOUTLIMIT: number;
+  CONFMULTIPLIERBASISPOINTS: number;
+  DEPRECATEILP: number;
+  DERIVEDDEPTHBASISPTS: number;
+  DERIVEDMINDEPTH: number;
+  DESIREDVALIDATORSET: number;
+  DYNAMICMAXANCHORTARGET: number;
+  EMISSIONCURVE: number;
+  ENABLEAVAXCHAIN: number;
+  ENABLEBSC: number;
+  ENABLESAVINGSVAULTS: number;
+  FULLIMPLOSSPROTECTIONBLOCKS: number;
+  FUNDMIGRATIONINTERVAL: number;
+  HALTAVAXCHAIN: number;
+  HALTAVAXTRADING: number;
+  HALTBCHCHAIN: number;
+  HALTBCHTRADING: number;
+  HALTBSCCHAIN: number;
+  HALTBSCTRADING: number;
+  HALTBTCCHAIN: number;
+  HALTBTCTRADING: number;
+  HALTCHAINGLOBAL: number;
+  HALTCHURNING: number;
+  HALTDOGECHAIN: number;
+  HALTDOGETRADING: number;
+  HALTETHCHAIN: number;
+  HALTETHTRADING: number;
+  HALTGAIACHAIN: number;
+  HALTGAIATRADING: number;
+  HALTLTCCHAIN: number;
+  HALTLTCTRADING: number;
+  HALTSIGNING: number;
+  HALTSIGNINGAVAX: number;
+  HALTSIGNINGBCH: number;
+  HALTSIGNINGBSC: number;
+  HALTSIGNINGBTC: number;
+  HALTSIGNINGDOGE: number;
+  HALTSIGNINGETH: number;
+  HALTSIGNINGGAIA: number;
+  HALTSIGNINGLTC: number;
+  HALTSIGNINGTERRA: number;
+  HALTTERRACHAIN: number;
+  HALTTERRATRADING: number;
+  HALTTHORCHAIN: number;
+  HALTTRADING: number;
+  ILPCUTOFF: number;
+  KEYGENRETRYINTERVAL: number;
+  KILLSWITCHSTART: number;
+  "LENDING-THOR-BTC": number;
+  "LENDING-THOR-ETH": number;
+  LENDINGLEVER: number;
+  LOANREPAYMENTMATURITY: number;
+  LOANSTREAMINGSWAPSINTERVAL: number;
+  MAXANCHORBLOCKS: number;
+  MAXANCHORSLIP: number;
+  MAXBONDPROVIDERS: number;
+  MAXCONFIRMATIONS: number;
+  MAXCR: number;
+  MAXIMUMLIQUIDITYRUNE: number;
+  MAXNODETOCHURNOUTFORLOWVERSION: number;
+  MAXOUTBOUNDATTEMPTS: number;
+  MAXOUTBOUNDFEEMULTIPLIERBASISPOINTS: number;
+  MAXRUNESUPPLY: number;
+  MAXSYNTHPERPOOLDEPTH: number;
+  MAXSYNTHSFORSAVERSYIELD: number;
+  MAXUTXOSTOSPEND: number;
+  MINCR: number;
+  MINIMUMBONDINRUNE: number;
+  MINIMUML1OUTBOUNDFEEUSD: number;
+  MINOUTBOUNDFEEMULTIPLIERBASISPOINTS: number;
+  MINRUNEPOOLDEPTH: number;
+  MINTSYNTHS: number;
+  NODEOPERATORFEE: number;
+  NODEPAUSECHAINGLOBAL: number;
+  NUMBEROFNEWNODESPERCHURN: number;
+  OBSERVATIONDELAYFLEXIBILITY: number;
+  "PAUSEASYMWITHDRAWAL-TERRA": number;
+  PAUSELOANS: number;
+  PAUSELP: number;
+  PAUSELPAVAX: number;
+  PAUSELPBCH: number;
+  PAUSELPBSC: number;
+  PAUSELPBTC: number;
+  PAUSELPDOGE: number;
+  PAUSELPETH: number;
+  PAUSELPGAIA: number;
+  PAUSELPLTC: number;
+  PAUSELPTERRA: number;
+  PAUSEUNBOND: number;
+  PENDINGLIQUIDITYAGELIMIT: number;
+  "POL-AVAX-AVAX": number;
+  "POL-AVAX-USDC-0XB97EF9EF8734C71904D8002F8B6BC66DD9C48A6E": number;
+  "POL-BCH-BCH": number;
+  "POL-BSC-USDC-0X8AC76A51CC950D9822D68B83FE1AD97B32CD580D": number;
+  "POL-BTC-BTC": number;
+  "POL-DOGE-DOGE": number;
+  "POL-ETH-DAI-0X6B175474E89094C44DA98B954EEDEAC495271D0F": number;
+  "POL-ETH-ETH": number;
+  "POL-ETH-USDC-0XA0B86991C6218B36C1D19D4A2E9EB0CE3606EB48": number;
+  "POL-ETH-USDT-0XDAC17F958D2EE523A2206206994597C13D831EC7": number;
+  "POL-GAIA-ATOM": number;
+  "POL-LTC-LTC": number;
+  POLBUFFER: number;
+  POLMAXNETWORKDEPOSIT: number;
+  POLMAXPOOLMOVEMENT: number;
+  POLTARGETSYNTHPERPOOLDEPTH: number;
+  POOLCYCLE: number;
+  POOLDEPTHFORYGGFUNDINGMIN: number;
+  PREFERREDASSETOUTBOUNDFEEMULTIPLIER: number;
+  RESCHEDULECOALESCEBLOCKS: number;
+  SAVERSSTREAMINGSWAPSINTERVAL: number;
+  SIGNERCONCURRENCY: number;
+  SLASHPENALTY: number;
+  SOLVENCYHALTAVAXCHAIN: number;
+  SOLVENCYHALTBCHCHAIN: number;
+  SOLVENCYHALTBSCCHAIN: number;
+  SOLVENCYHALTDOGECHAIN: number;
+  SOLVENCYHALTETHCHAIN: number;
+  SOLVENCYHALTGAIACHAIN: number;
+  SOLVENCYHALTTERRACHAIN: number;
+  STOPFUNDYGGDRASIL: number;
+  STOPSOLVENCYCHECK: number;
+  STOPSOLVENCYCHECKAVAX: number;
+  STOPSOLVENCYCHECKBSC: number;
+  STOPSOLVENCYCHECKDOGE: number;
+  STOPSOLVENCYCHECKETH: number;
+  STOPSOLVENCYCHECKGAIA: number;
+  STOPSOLVENCYCHECKTERRA: number;
+  STREAMINGSWAPMINBPFEE: number;
+  SYNTHYIELDBASISPOINTS: number;
+  THORNAMES: number;
+  "TORANCHOR-AVAX-USDC-0XB97EF9EF8734C71904D8002F8B6BC66DD9C48A6E": number;
+  "TORANCHOR-AVAX-USDT-0X9702230A8EA53601F5CD2DC00FDBC13D4DF4A8C7": number;
+  "TORANCHOR-BSC-USDC-0X8AC76A51CC950D9822D68B83FE1AD97B32CD580D": number;
+  "TORANCHOR-ETH-DAI-0X6B175474E89094C44DA98B954EEDEAC495271D0F": number;
+  "TORANCHOR-ETH-USDC-0XA0B86991C6218B36C1D19D4A2E9EB0CE3606EB48": number;
+  "TORANCHOR-ETH-USDT-0XDAC17F958D2EE523A2206206994597C13D831EC7": number;
+  TXOUTDELAYRATE: number;
+  VIRTUALMULTSYNTHS: number;
+  VOTEDOFM: number;
+  VOTELENDING: number;
+  VOTEMAXSYNTHSFORSAVERSYIELD: number;
+  YGGFUNDLIMIT: number;
+  YGGFUNDRETRY: number;
+};
+
+export type RunePoolInfo = {
+  pol: { rune_deposited: string; rune_withdrawn: string; value: string; pnl: string; current_deposit: string };
+  providers: {
+    units: string;
+    pending_units: string;
+    pending_rune: string;
+    value: string;
+    pnl: string;
+    current_deposit: string;
+  };
+  reserve: { units: string; value: string; pnl: string; current_deposit: string };
+};
+
+export type RunePoolProviderInfo = {
+  rune_address: string;
+  units: string;
+  value: string;
+  pnl: string;
+  deposit_amount: string;
+  withdraw_amount: string;
+  last_deposit_height: number;
+  last_withdraw_height: number;
+};
+
+export type TCYStakerSummary = { amount: string };
+
+export type TCYStaker = { address?: string; amount: string };
+
+export type TCYStakerResponse = TCYStaker;
+export type TCYStakersResponse = TCYStakerSummary[];
+
+export type TCYClaimerSummary = { amount: string; asset: string };
+
+export type TCYClaimer = { l1_address?: string; amount: string; asset: string };
+
+export type TCYClaimerResponse = TCYClaimer;
+export type TCYClaimersResponse = TCYClaimerSummary[];

package/src/contracts.ts

@@ -0,0 +1 @@
+export * from "@swapkit/contracts";

package/src/index.ts

@@ -0,0 +1,28 @@
+export * from "@swapkit/tokens";
+export * from "@swapkit/types";
+/**
+ * Modules
+ */
+export * from "./modules/assetValue";
+export * from "./modules/bigIntArithmetics";
+export * from "./modules/feeMultiplier";
+export * from "./modules/requestClient";
+export * from "./modules/swapKitConfig";
+export * from "./modules/swapKitError";
+export * from "./modules/swapKitNumber";
+/**
+ * Types
+ */
+export * from "./types";
+/**
+ * Utils
+ */
+export * from "./utils/asset";
+export * from "./utils/chains";
+export * from "./utils/derivationPath";
+export * from "./utils/explorerUrls";
+export * from "./utils/liquidity";
+export * from "./utils/memo";
+export * from "./utils/others";
+export * from "./utils/validators";
+export * from "./utils/wallets";