@swapkit/helpers 2.6.0 → 3.0.0-beta.1

package/src/types/chains.ts

@@ -13,11 +13,13 @@ export enum Chain {
   Kujira = "KUJI",
   Litecoin = "LTC",
   Maya = "MAYA",
+  Near = "NEAR",
   Optimism = "OP",
   Polkadot = "DOT",
   Chainflip = "FLIP",
   Polygon = "MATIC",
   Radix = "XRD",
+  Ripple = "XRP",
   THORChain = "THOR",
   Solana = "SOL",
 }
@@ -49,12 +51,14 @@ export enum ChainId {
   Litecoin = "litecoin",
   Maya = "mayachain-mainnet-v1",
   MayaStagenet = "mayachain-stagenet-v1",
+  Near = "near",
   Optimism = "10",
   OptimismHex = "0xa",
   Polkadot = "polkadot",
   Polygon = "137",
   PolygonHex = "0x89",
   Radix = "radix-mainnet",
+  Ripple = "ripple",
   THORChain = "thorchain-1",
   THORChainStagenet = "thorchain-stagenet-v2",
   Solana = "solana",
@@ -76,21 +80,23 @@ export const ChainIdToChain: Record<ChainId, Chain> = {
   [ChainId.Dash]: Chain.Dash,
   [ChainId.Dogecoin]: Chain.Dogecoin,
   [ChainId.EthereumHex]: Chain.Ethereum,
+  [ChainId.Ethereum]: Chain.Ethereum,
   [ChainId.Fiat]: Chain.Fiat,
   [ChainId.Kujira]: Chain.Kujira,
-  [ChainId.Ethereum]: Chain.Ethereum,
   [ChainId.Litecoin]: Chain.Litecoin,
   [ChainId.MayaStagenet]: Chain.Maya,
   [ChainId.Maya]: Chain.Maya,
+  [ChainId.Near]: Chain.Near,
   [ChainId.OptimismHex]: Chain.Optimism,
   [ChainId.Optimism]: Chain.Optimism,
   [ChainId.Polkadot]: Chain.Polkadot,
   [ChainId.PolygonHex]: Chain.Polygon,
   [ChainId.Polygon]: Chain.Polygon,
   [ChainId.Radix]: Chain.Radix,
+  [ChainId.Ripple]: Chain.Ripple,
+  [ChainId.Solana]: Chain.Solana,
   [ChainId.THORChainStagenet]: Chain.THORChain,
   [ChainId.THORChain]: Chain.THORChain,
-  [ChainId.Solana]: Chain.Solana,
 };
 
 type ChainNameType = keyof typeof Chain;
@@ -115,10 +121,12 @@ export const BaseDecimal: Record<Chain, number> = {
   LTC: 8,
   MATIC: 18,
   MAYA: 8,
+  NEAR: 24,
   OP: 18,
   SOL: 9,
   THOR: 8,
   XRD: 18,
+  XRP: 6,
 };
 
 export const BlockTimes: Record<Partial<Chain>, number> = {
@@ -137,10 +145,12 @@ export const BlockTimes: Record<Partial<Chain>, number> = {
   [Chain.Kujira]: 2.2,
   [Chain.Litecoin]: 150,
   [Chain.Maya]: 6,
+  [Chain.Near]: 1,
   [Chain.Optimism]: 2,
   [Chain.Polkadot]: 6,
   [Chain.Polygon]: 2.1,
   [Chain.Radix]: 5,
+  [Chain.Ripple]: 5,
   [Chain.Solana]: 0.4,
   [Chain.THORChain]: 6,
 };
@@ -156,6 +166,7 @@ export type EVMChain =
   | Chain.Ethereum
   | Chain.Optimism
   | Chain.Polygon;
+
 export const EVMChains = [
   Chain.Arbitrum,
   Chain.Avalanche,
@@ -182,6 +193,12 @@ export const UTXOChains = [
 
 export type CosmosChain = Chain.Cosmos | Chain.THORChain | Chain.Maya | Chain.Kujira;
 export const CosmosChains = [Chain.Cosmos, Chain.THORChain, Chain.Maya, Chain.Kujira] as const;
+export const CosmosChainPrefixes = {
+  [Chain.Cosmos]: "cosmos",
+  [Chain.THORChain]: "thor",
+  [Chain.Maya]: "maya",
+  [Chain.Kujira]: "kujira",
+} as Record<CosmosChain, string>;
 
 export const TCSupportedChains = [
   Chain.Avalanche,
@@ -206,28 +223,40 @@ export const MAYASupportedChains = [
 
 export const RPC_URLS: Record<Chain | StagenetChain, string> = {
   [Chain.Arbitrum]: "https://arb1.arbitrum.io/rpc",
-  [Chain.Avalanche]: "https://avalanche-c-chain-rpc.publicnode.com",
+  [Chain.Avalanche]: "https://api.avax.network/ext/bc/C/rpc",
   [Chain.Base]: "https://base-rpc.publicnode.com",
   [Chain.BinanceSmartChain]: "https://bsc-dataseed.binance.org",
-  [Chain.Bitcoin]: "https://bitcoin-rpc.publicnode.com",
   [Chain.BitcoinCash]: "https://node-router.thorswap.net/bitcoin-cash",
+  [Chain.Bitcoin]: "https://bitcoin-rpc.publicnode.com",
   [Chain.Chainflip]: "wss://mainnet-archive.chainflip.io",
   [Chain.Cosmos]: "https://node-router.thorswap.net/cosmos/rpc",
   [Chain.Dash]: "https://dash-rpc.publicnode.com",
   [Chain.Dogecoin]: "https://node-router.thorswap.net/dogecoin",
   [Chain.Ethereum]: "https://ethereum-rpc.publicnode.com",
   [Chain.Fiat]: "",
-  [Chain.Kujira]: "https://rpc-kujira.synergynodes.com/",
+  [Chain.Kujira]: "https://kujira-rpc.ibs.team",
   [Chain.Litecoin]: "https://node-router.thorswap.net/litecoin",
   [Chain.Maya]: "https://tendermint.mayachain.info",
+  [Chain.Near]: "https://rpc.ankr.com/near",
   [Chain.Optimism]: "https://mainnet.optimism.io",
   [Chain.Polkadot]: "wss://rpc.polkadot.io",
   [Chain.Polygon]: "https://polygon-rpc.com",
   [Chain.Radix]: "https://radix-mainnet.rpc.grove.city/v1/326002fc/core",
+  [Chain.Ripple]: "wss://xrpl.ws/",
+  [Chain.Solana]: "https://solana-rpc.publicnode.com",
   [Chain.THORChain]: "https://rpc.thorswap.net",
-  [StagenetChain.THORChain]: "https://stagenet-rpc.ninerealms.com",
   [StagenetChain.Maya]: "https://stagenet.tendermint.mayachain.info",
-  [Chain.Solana]: "https://solana-rpc.publicnode.com",
+  [StagenetChain.THORChain]: "https://stagenet-rpc.ninerealms.com",
+};
+
+export const NODE_URLS: Record<
+  Chain.THORChain | Chain.Maya | StagenetChain.THORChain | StagenetChain.Maya,
+  string
+> = {
+  [Chain.THORChain]: "https://thornode.thorswap.net",
+  [Chain.Maya]: "https://mayanode.mayachain.info",
+  [StagenetChain.THORChain]: "https://stagenet-thornode.ninerealms.com",
+  [StagenetChain.Maya]: "https://stagenet.mayanode.mayachain.info",
 };
 
 export const FALLBACK_URLS: Record<Chain | StagenetChain, string[]> = {
@@ -255,10 +284,11 @@ export const FALLBACK_URLS: Record<Chain | StagenetChain, string[]> = {
   [Chain.Dogecoin]: ["https://doge.getblock.io/mainnet", "https://dogecoin.publicnode.com"],
   [Chain.Ethereum]: ["https://eth.llamarpc.com", "https://rpc.ankr.com/eth"],
   [Chain.Fiat]: [],
-  [Chain.Kujira]: ["https://kujira-rpc.polkachu.com", "https://kujira-rpc.ibs.team"],
+  [Chain.Kujira]: ["https://kujira-rpc.polkachu.com", "https://rpc-kujira.synergynodes.com/"],
   [Chain.Litecoin]: ["https://ltc.getblock.io/mainnet", "https://litecoin.publicnode.com"],
   [Chain.Maya]: ["https://tendermint.mayachain.info", "https://maya-tendermint.publicnode.com"],
   [StagenetChain.Maya]: [],
+  [Chain.Near]: ["https://1rpc.io/near"],
   [Chain.Optimism]: ["https://optimism.llamarpc.com", "https://1rpc.io/op"],
   [Chain.Polkadot]: [
     "wss://polkadot-rpc.dwellir.com",
@@ -266,7 +296,8 @@ export const FALLBACK_URLS: Record<Chain | StagenetChain, string[]> = {
   ],
   [Chain.Polygon]: ["https://polygon.llamarpc.com", "https://rpc.ankr.com/polygon"],
   [Chain.Radix]: ["https://mainnet.radixdlt.com", "https://radix-mainnet.rpc.grove.city/v1"],
-  [Chain.THORChain]: ["https://thornode.ninerealms.com", "https://thornode.thorswap.net"],
+  [Chain.Ripple]: ["wss://s1.ripple.com/", "wss://s2.ripple.com/"],
+  [Chain.THORChain]: ["https://thornode.ninerealms.com", NODE_URLS[Chain.THORChain]],
   [StagenetChain.THORChain]: [],
   [Chain.Solana]: ["https://api.mainnet-beta.solana.com", "https://rpc.ankr.com/solana"],
 };
@@ -287,20 +318,18 @@ export const EXPLORER_URLS: Record<Chain, string> = {
   [Chain.Kujira]: "https://finder.kujira.network/kaiyo-1",
   [Chain.Litecoin]: "https://blockchair.com/litecoin",
   [Chain.Maya]: "https://www.mayascan.org",
+  [Chain.Near]: "https://nearblocks.io",
   [Chain.Optimism]: "https://optimistic.etherscan.io",
   [Chain.Polkadot]: "https://polkadot.subscan.io",
   [Chain.Polygon]: "https://polygonscan.com",
   [Chain.Radix]: "https://dashboard.radixdlt.com",
+  [Chain.Ripple]: "https://livenet.xrpl.org/",
   [Chain.THORChain]: "https://runescan.io",
   [Chain.Solana]: "https://solscan.io",
 };
 
 let RPCUrlsMerged = RPC_URLS;
 
-export const getRPCUrl = (chain: Chain | StagenetChain) => {
-  return RPCUrlsMerged[chain];
-};
-
 const getRpcBody = (chain: Chain | StagenetChain) => {
   switch (chain) {
     case Chain.Arbitrum:
@@ -310,50 +339,26 @@ const getRpcBody = (chain: Chain | StagenetChain) => {
     case Chain.Ethereum:
     case Chain.Optimism:
     case Chain.Polygon:
-      return {
-        jsonrpc: "2.0",
-        method: "eth_blockNumber",
-        params: [],
-        id: 1,
-      };
+      return { id: 1, jsonrpc: "2.0", method: "eth_blockNumber", params: [] };
     case Chain.Bitcoin:
     case Chain.Dogecoin:
     case Chain.BitcoinCash:
     case Chain.Dash:
     case Chain.Litecoin:
-      return {
-        jsonrpc: "1.0",
-        id: "test",
-        method: "getblockchaininfo",
-        params: [],
-      };
+      return { id: "test", jsonrpc: "1.0", method: "getblockchaininfo", params: [] };
     case Chain.Cosmos:
     case Chain.Kujira:
     case Chain.Maya:
     case Chain.THORChain:
     case StagenetChain.Maya:
     case StagenetChain.THORChain:
-      return {
-        id: 1,
-        jsonrpc: "2.0",
-        method: "status",
-        params: {},
-      };
+      return { id: 1, jsonrpc: "2.0", method: "status", params: {} };
     case Chain.Polkadot:
-      return {
-        jsonrpc: "2.0",
-        id: 1,
-        method: "system_health",
-        params: [],
-      };
+      return { id: 1, jsonrpc: "2.0", method: "system_health", params: [] };
+    case Chain.Solana:
+      return { id: 1, jsonrpc: "2.0", method: "getHealth" };
     case Chain.Radix:
       return "";
-    case Chain.Solana:
-      return {
-        jsonrpc: "2.0",
-        id: 1,
-        method: "getHealth",
-      };
     default:
       throw new Error(`Unsupported chain: ${chain}`);
   }
@@ -437,14 +442,6 @@ export const ChainToChainId = chains.reduce(
   {} as { [key in Chain]: ChainId },
 );
 
-export const ChainToRPC = chains.reduce(
-  (acc, chain) => {
-    acc[chain] = getRPCUrl(chain);
-    return acc;
-  },
-  {} as { [key in Chain]: string },
-);
-
 export const ChainToHexChainId = chains.reduce(
   (acc, chain) => {
     const chainString = `${ChainToChainName[chain]}Hex` as keyof typeof ChainId;

package/src/types/commonTypes.ts

@@ -1,96 +1,9 @@
-import type { RadixNetwork } from "@swapkit/toolbox-radix";
 import type { Chain } from "./chains";
-import type { ChainApis } from "./sdk";
 import type { ChainWallet, CryptoChain } from "./wallet";
 
-/**
- * @optional for swapkit API access
- */
-export type SwapkitConfig = {
-  swapkitConfig?: {
-    isDev?: boolean;
-    swapkitApiKey?: string;
-    useHashedApiKey?: boolean;
-    referer?: string;
-  };
-  swapkitApiKey?: string;
-};
-
-export type ConnectConfig = SwapkitConfig & {
-  stagenet?: boolean;
-  /**
-   * @required
-   */
-  thorswapApiKey?: string;
-  /**
-   * @optional for non ETH EVM chains - if not set you must use alchemyApi
-   */
-  covalentApiKey?: string;
-  /**
-   * @required for ETH
-   */
-  ethplorerApiKey?: string;
-  /**
-   * @required for BTC, BCH, LTC, DOGE
-   */
-  blockchairApiKey?: string;
-  /**
-   * @required for Walletconnect
-   */
-  walletConnectProjectId?: string;
-  /**
-   * @optional for Trezor config
-   */
-  trezorManifest?: {
-    email: string;
-    appUrl: string;
-  };
-  /**
-   * @optional for KeepKey config
-   */
-  keepkeyConfig?: {
-    apiKey: string;
-    pairingInfo: {
-      name: string;
-      imageUrl: string;
-      basePath: string;
-      url: string;
-    };
-  };
-  /**
-   * @deprecated use chainflipBrokerConfig
-   * @optional for setting the chainflip broker url
-   */
-  chainflipBrokerUrl?: string;
-  /**
-   * @optional for setting the chainflip broker url
-   */
-  chainflipBrokerConfig?: {
-    useChainflipSDKBroker?: boolean;
-    chainflipBrokerUrl: string;
-  };
-  /**
-   * @optional for setting the radix wallet
-   */
-  radixDappConfig?: {
-    dAppDefinitionAddress: string;
-    applicationName: string;
-    applicationVersion: string;
-    network: RadixNetwork;
-  };
-
-  /**
-   * @optional for setting the kado api key
-   */
-  kadoApiKey?: string;
-};
-
-export type ConnectWalletParams<M = { [key in string]: any }> = {
-  addChain: <T extends CryptoChain>(params: ChainWallet<T> & M) => void;
-  apis: ChainApis;
-  config: ConnectConfig;
-  rpcUrls: { [chain in CryptoChain]?: string };
-};
+export type AddChainType<M = { [key in string]: any }> = <T extends CryptoChain>(
+  params: Omit<ChainWallet<T>, "balance"> & M,
+) => void;
 
 export type Witness = {
   value: number;

package/src/types/derivationPath.ts

@@ -1,3 +1,4 @@
+import { derivationPathToString } from "../utils/derivationPath";
 import type { Chain } from "./chains";
 
 export enum ContractAddress {
@@ -10,30 +11,6 @@ export enum ContractAddress {
   OP = "0x4200000000000000000000000000000000000042",
 }
 
-export enum DerivationPath {
-  ARB = "m/44'/60'/0'/0",
-  AVAX = "m/44'/60'/0'/0",
-  BASE = "m/44'/60'/0'/0",
-  BCH = "m/44'/145'/0'/0",
-  BSC = "m/44'/60'/0'/0",
-  BTC = "m/84'/0'/0'/0",
-  DASH = "m/44'/5'/0'/0",
-  DOGE = "m/44'/3'/0'/0",
-  DOT = "////",
-  ETH = "m/44'/60'/0'/0",
-  FLIP = "////",
-  GAIA = "m/44'/118'/0'/0",
-  KUJI = "m/44'/118'/0'/0",
-  LTC = "m/84'/2'/0'/0",
-  MATIC = "m/44'/60'/0'/0",
-  MAYA = "m/44'/931'/0'/0",
-  OP = "m/44'/60'/0'/0",
-  SOL = "m/44'/501'/0'/0",
-  THOR = "m/44'/931'/0'/0",
-  XRD = "////",
-  FIAT = "////",
-}
-
 export type DerivationPathArray = [number, number, number, number, number?];
 
 export const NetworkDerivationPath: Record<Chain, DerivationPathArray> = {
@@ -51,6 +28,7 @@ export const NetworkDerivationPath: Record<Chain, DerivationPathArray> = {
   LTC: [84, 2, 0, 0, 0],
   MATIC: [44, 60, 0, 0, 0],
   MAYA: [44, 931, 0, 0, 0],
+  NEAR: [44, 397, 0, 0, 0],
   OP: [44, 60, 0, 0, 0],
   SOL: [44, 501, 0, 0, 0],
   THOR: [44, 931, 0, 0, 0],
@@ -60,4 +38,13 @@ export const NetworkDerivationPath: Record<Chain, DerivationPathArray> = {
   FIAT: [0, 0, 0, 0, 0],
   FLIP: [0, 0, 0, 0, 0],
   XRD: [0, 0, 0, 0, 0],
+  XRP: [44, 144, 0, 0, 0],
 };
+
+export const DerivationPath: Record<Chain, string> = Object.keys(NetworkDerivationPath).reduce(
+  (acc, key) => {
+    acc[key as Chain] = derivationPathToString(NetworkDerivationPath[key as Chain]);
+    return acc;
+  },
+  {} as Record<Chain, string>,
+);

package/src/types/index.ts

@@ -1,9 +1,8 @@
 export * from "./chains";
 export * from "./commonTypes";
 export * from "./derivationPath";
-export * from "./network";
-export * from "./tokens";
-export * from "./wallet";
-export * from "./sdk";
 export * from "./quotes";
 export * from "./radix";
+export * from "./sdk";
+export * from "./tokens";
+export * from "./wallet";

package/src/types/quotes.ts

@@ -170,5 +170,4 @@ export enum FeeTypeEnum {
   AFFILIATE = "affiliate",
   TAX = "tax",
   PRIORITY = "priority",
-  SERVICE = "service",
 }

package/src/types/radix.ts

@@ -1,5 +1,5 @@
 export type RadixCoreStateResourceDTO = {
-  at_ledger_state?: any; // not needed
+  at_ledger_state?: any;
   manager: {
     resource_type: string;
     divisibility: {
@@ -10,5 +10,5 @@ export type RadixCoreStateResourceDTO = {
       };
     };
   };
-  owner_role?: any; // not needed
+  owner_role?: any;
 };

package/src/types/sdk.ts

@@ -1,34 +1,4 @@
-import type { CovalentApiType, EthplorerApiType } from "@swapkit/toolbox-evm";
-import type { BlockchairApiType } from "@swapkit/toolbox-utxo";
-
-import type { AlchemyApiType } from "@swapkit/toolbox-evm/src/api/alchemyApi";
 import type { AssetValue } from "../modules/assetValue";
-import type { Chain, CosmosChain, UTXOChain } from "./chains";
-
-type NonEthEvmChains =
-  | Chain.Base
-  | Chain.BinanceSmartChain
-  | Chain.Polygon
-  | Chain.Avalanche
-  | Chain.Arbitrum
-  | Chain.Optimism;
-
-export type ChainApis = { [key in NonEthEvmChains]?: CovalentApiType | AlchemyApiType } & {
-  [key in Chain.Ethereum]?: EthplorerApiType;
-} & {
-  [key in UTXOChain]?: BlockchairApiType;
-} & {
-  [key in CosmosChain | Chain.Solana | Chain.Radix | Chain.Polkadot | Chain.Chainflip]?: string;
-} & {
-  [key in Chain.Fiat]?: undefined;
-};
-
-export type ChainApi =
-  | EthplorerApiType
-  | CovalentApiType
-  | AlchemyApiType
-  | BlockchairApiType
-  | string;
 
 export type GenericSwapParams<T = unknown> = {
   buyAsset?: AssetValue;
@@ -57,13 +27,6 @@ export type ApproveReturnType<T extends ApproveMode> = T extends "checkOnly"
   ? Promise<boolean>
   : Promise<string>;
 
-export type WalletTxParams = {
-  feeOptionKey?: FeeOption;
-  from?: string;
-  memo?: string; // optional memo to pass
-  recipient: string;
-};
-
 export enum MemoType {
   NAME_REGISTER = "~",
   BOND = "BOND",
@@ -75,7 +38,4 @@ export enum MemoType {
   CLOSE_LOAN = "$-",
   RUNEPOOL_DEPOSIT = "POOL+",
   RUNEPOOL_WITHDRAW = "POOL-",
-  CLAIM_TCY = "tcy",
-  STAKE_TCY = "tcy+",
-  UNSTAKE_TCY = "tcy-",
 }

package/src/types/tokens.ts

@@ -1,20 +1,17 @@
-import type { tokenLists } from "@swapkit/tokens";
+import type { tokenLists } from "@swapkit/helpers/tokens";
 
 export type TokenTax = { buy: number; sell: number };
 
-export type TokenNames =
-  | (typeof tokenLists)["CaviarV1List"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["ChainflipList"]["tokens"][number]["identifier"]
-  //   | (typeof tokenLists)["JupiterList"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["KadoList"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["MayaList"]["tokens"][number]["identifier"]
-  // | (typeof tokenLists)['OciswapV1List']["tokens"][number]["identifier"]
-  | (typeof tokenLists)["OneInchList"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["OpenOceanV2List"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["PancakeswapList"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["PangolinList"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["SushiswapList"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["ThorchainList"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["TraderjoeV2List"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["UniswapV2List"]["tokens"][number]["identifier"]
-  | (typeof tokenLists)["UniswapV3List"]["tokens"][number]["identifier"];
+type ListOfTokens = Exclude<
+  keyof typeof tokenLists,
+  | "JupiterList"
+  | "CamelotV3List"
+  | "OneInchList"
+  | "OpenOceanV2List"
+  | "PancakeswapList"
+  | "PangolinList"
+  | "SushiswapList"
+  | "TraderjoeV2List"
+>;
+
+export type TokenNames = (typeof tokenLists)[ListOfTokens]["tokens"][number]["identifier"];