@swapkit/helpers 2.5.0 → 3.0.0-beta.0

package/src/api/thornode/endpoints.ts

@@ -0,0 +1,78 @@
+import { AssetValue, Chain, RequestClient, SKConfig, StagenetChain } from "@swapkit/helpers";
+import type {
+  InboundAddressesItem,
+  LastBlockItem,
+  MimirData,
+  NodeItem,
+  RunePoolInfo,
+  RunePoolProviderInfo,
+  THORNodeTNSDetails,
+  THORNodeType,
+} from "./types";
+
+function baseUrl(type?: THORNodeType) {
+  const { isStagenet } = SKConfig.get("envs");
+  const nodeUrls = SKConfig.get("nodeUrls");
+
+  switch (type) {
+    case "mayachain": {
+      const mayaNodeUrl = nodeUrls[isStagenet ? StagenetChain.Maya : Chain.Maya];
+
+      return `${mayaNodeUrl}/mayachain`;
+    }
+    default: {
+      const thorNodeUrl = nodeUrls[isStagenet ? StagenetChain.THORChain : Chain.THORChain];
+
+      return `${thorNodeUrl}/thorchain`;
+    }
+  }
+}
+
+function getNameServiceBaseUrl(type?: THORNodeType) {
+  const nsType = type === "mayachain" ? "mayaname" : "thorname";
+
+  return `${baseUrl(type)}/${nsType}`;
+}
+
+export function getLastBlock(type?: THORNodeType) {
+  return RequestClient.get<LastBlockItem[]>(`${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 function getTHORNodeTNSDetails({ type, name }: { type?: THORNodeType; name: string }) {
+  return RequestClient.get<THORNodeTNSDetails>(`${getNameServiceBaseUrl(type)}/${name}`);
+}
+
+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({ asyncTokenLookup: true, asset: tnsDetails.preferred_asset });
+}
+
+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}`);
+}

package/src/api/thornode/types.ts

@@ -0,0 +1,241 @@
+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;
+};
+
+export type LastBlockItem = {
+  chain: string;
+  last_observed_in: number;
+  last_signed_out: number;
+  thorchain: 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;
+};

package/src/api/thorswapStatic/endpoints.ts

@@ -0,0 +1,30 @@
+import { AssetValue, type ProviderName, RequestClient, getChainIdentifier } from "@swapkit/helpers";
+
+import { getTokenListProviders } from "../swapkitApi/endpoints";
+import type { TokenListProvidersResponse } from "../swapkitApi/types";
+import type { TokensResponse } from "./types";
+
+const baseUrl = "https://static.thorswap.net";
+
+export function getStaticTokenList(tokenListName: string) {
+  return RequestClient.get<TokensResponse>(`${baseUrl}/token-list/${tokenListName}.json`);
+}
+
+export function getLogoForAsset(assetString: string) {
+  return `${baseUrl}/token-list/images/${assetString.toLowerCase()}.png`;
+}
+
+export function getChainLogoForAsset(assetString: string) {
+  const { chain } = AssetValue.from({ asset: assetString });
+  const chainIdentifier = getChainIdentifier(chain).toLowerCase();
+
+  return `${baseUrl}/token-list/images/${chainIdentifier}.png`;
+}
+
+let providerData: TokenListProvidersResponse;
+
+export async function getProviderLogo(providerName: ProviderName | string) {
+  providerData ||= await getTokenListProviders();
+
+  return providerData.find((p) => p.name === providerName)?.url;
+}

package/src/api/thorswapStatic/types.ts

@@ -0,0 +1,18 @@
+export type Token = {
+  address?: string;
+  chain: string;
+  chainId: string;
+  decimals?: number;
+  identifier: string;
+  logoURL?: string;
+  ticker: string;
+  tokenlist: string;
+};
+
+export type TokensResponse = {
+  keywords: string[];
+  name: string;
+  timestamp: string;
+  version: { major: number; minor: number; patch: number };
+  tokens: Token[];
+};

package/src/contracts/abis/avaxGeneric.ts

@@ -0,0 +1,92 @@
+export const avaxGeneric = [
+  {
+    inputs: [{ internalType: "address", name: "_ttp", type: "address" }],
+    stateMutability: "nonpayable",
+    type: "constructor",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: false, internalType: "uint256", name: "fee", type: "uint256" },
+      { indexed: false, internalType: "address", name: "feeRecipient", type: "address" },
+    ],
+    name: "FeeSet",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "address", name: "owner", type: "address" },
+      { indexed: false, internalType: "bool", name: "active", type: "bool" },
+    ],
+    name: "OwnerSet",
+    type: "event",
+  },
+  {
+    inputs: [],
+    name: "fee",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "feeRecipient",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "", type: "address" }],
+    name: "owners",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint256", name: "_fee", type: "uint256" },
+      { internalType: "address", name: "_feeRecipient", type: "address" },
+    ],
+    name: "setFee",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "owner", type: "address" },
+      { internalType: "bool", name: "active", type: "bool" },
+    ],
+    name: "setOwner",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "tcRouter", type: "address" },
+      { internalType: "address", name: "tcVault", type: "address" },
+      { internalType: "string", name: "tcMemo", type: "string" },
+      { internalType: "address", name: "token", type: "address" },
+      { internalType: "uint256", name: "amount", type: "uint256" },
+      { internalType: "address", name: "router", type: "address" },
+      { internalType: "bytes", name: "data", type: "bytes" },
+      { internalType: "uint256", name: "deadline", type: "uint256" },
+    ],
+    name: "swapIn",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "tokenTransferProxy",
+    outputs: [
+      { internalType: "contract TSAggregatorTokenTransferProxy", name: "", type: "address" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  { stateMutability: "payable", type: "receive" },
+];

package/src/contracts/abis/avaxWoofi.ts

@@ -0,0 +1,145 @@
+export const avaxWoofi = [
+  {
+    inputs: [
+      { internalType: "address", name: "_ttp", type: "address" },
+      { internalType: "address", name: "_weth", type: "address" },
+      { internalType: "address", name: "_swapRouter", type: "address" },
+    ],
+    stateMutability: "nonpayable",
+    type: "constructor",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: false, internalType: "uint256", name: "fee", type: "uint256" },
+      { indexed: false, internalType: "address", name: "feeRecipient", type: "address" },
+    ],
+    name: "FeeSet",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "address", name: "owner", type: "address" },
+      { indexed: false, internalType: "bool", name: "active", type: "bool" },
+    ],
+    name: "OwnerSet",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: false, internalType: "address", name: "from", type: "address" },
+      { indexed: false, internalType: "address", name: "token", type: "address" },
+      { indexed: false, internalType: "uint256", name: "amount", type: "uint256" },
+      { indexed: false, internalType: "uint256", name: "out", type: "uint256" },
+      { indexed: false, internalType: "uint256", name: "fee", type: "uint256" },
+      { indexed: false, internalType: "address", name: "vault", type: "address" },
+      { indexed: false, internalType: "string", name: "memo", type: "string" },
+    ],
+    name: "SwapIn",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: false, internalType: "address", name: "to", type: "address" },
+      { indexed: false, internalType: "address", name: "token", type: "address" },
+      { indexed: false, internalType: "uint256", name: "amount", type: "uint256" },
+      { indexed: false, internalType: "uint256", name: "fee", type: "uint256" },
+    ],
+    name: "SwapOut",
+    type: "event",
+  },
+  {
+    inputs: [],
+    name: "fee",
+    outputs: [{ internalType: "uint256", name: "", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "feeRecipient",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "", type: "address" }],
+    name: "owners",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "uint256", name: "_fee", type: "uint256" },
+      { internalType: "address", name: "_feeRecipient", type: "address" },
+    ],
+    name: "setFee",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "owner", type: "address" },
+      { internalType: "bool", name: "active", type: "bool" },
+    ],
+    name: "setOwner",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "router", type: "address" },
+      { internalType: "address", name: "vault", type: "address" },
+      { internalType: "string", name: "memo", type: "string" },
+      { internalType: "address", name: "token", type: "address" },
+      { internalType: "uint256", name: "amount", type: "uint256" },
+      { internalType: "uint256", name: "amountOutMin", type: "uint256" },
+      { internalType: "uint256", name: "deadline", type: "uint256" },
+    ],
+    name: "swapIn",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "token", type: "address" },
+      { internalType: "address", name: "to", type: "address" },
+      { internalType: "uint256", name: "amountOutMin", type: "uint256" },
+    ],
+    name: "swapOut",
+    outputs: [],
+    stateMutability: "payable",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "swapRouter",
+    outputs: [{ internalType: "contract IWoofi", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "tokenTransferProxy",
+    outputs: [
+      { internalType: "contract TSAggregatorTokenTransferProxy", name: "", type: "address" },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "weth",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  { stateMutability: "payable", type: "receive" },
+];