@swapkit/helpers 3.0.0-beta.0 → 3.0.0-beta.1

package/src/modules/swapKitError.ts

@@ -28,6 +28,7 @@ const errorCodes = {
   core_wallet_talisman_not_installed: 10110,
   core_wallet_not_keypair_wallet: 10111,
   core_wallet_sign_message_not_supported: 10110,
+  core_wallet_connection_failed: 10112,
   /**
    * Core - Swap
    */
@@ -95,6 +96,10 @@ const errorCodes = {
   wallet_keepkey_send_transaction_no_address: 20903,
   wallet_bitkeep_not_found: 21001,
   wallet_exodus_sign_transaction_error: 21100,
+  wallet_keystore_invalid_password: 29900,
+  wallet_keystore_unsupported_version: 29901,
+  wallet_onekey_not_found: 21200,
+  wallet_onekey_sign_transaction_error: 21201,
   /**
    * Chainflip
    */
@@ -143,6 +148,13 @@ const errorCodes = {
   toolbox_evm_error_estimating_gas_limit: 90211,
   toolbox_evm_error_sending_transaction: 90212,
   toolbox_radix_signer_not_defined: 90301,
+  toolbox_solana_no_signer: 90401,
+  toolbox_solana_fee_estimation_failed: 90402,
+  toolbox_ripple_rpc_not_configured: 90501,
+  toolbox_ripple_signer_not_found: 90502,
+  toolbox_ripple_asset_not_supported: 90503,
+  toolbox_ripple_broadcast_error: 90504,
+  toolbox_ripple_get_balance_error: 90505,
   /**
    * Helpers
    */
@@ -167,24 +179,19 @@ export class SwapKitError extends Error {
 
   constructor(
     errorOrErrorKey: ErrorKeys | { errorKey: ErrorKeys; info?: Record<string, any> },
-    sourceError?: any,
+    sourceErrorOrInfo?: any,
   ) {
     const isErrorString = typeof errorOrErrorKey === "string";
     const errorKey = isErrorString ? errorOrErrorKey : errorOrErrorKey.errorKey;
-    super(errorKey);
+    const message = `${errorKey}${isErrorString ? "" : `: ${JSON.stringify(errorOrErrorKey.info)}`}`;
 
-    if (sourceError) {
-      console.error(sourceError, {
-        stack: sourceError?.stack,
-        message: sourceError?.message,
-      });
+    if (sourceErrorOrInfo) {
+      console.error(sourceErrorOrInfo);
     }
 
-    console.error(errorKey, {
-      code: SwapKitError.ErrorCode[errorKey],
-      message: `${errorKey}${isErrorString ? "" : `: ${JSON.stringify(errorOrErrorKey.info)}`}`,
-    });
+    console.error(errorKey, { code: SwapKitError.ErrorCode[errorKey], message });
 
+    super(errorKey);
     Object.setPrototypeOf(this, SwapKitError.prototype);
   }
 }

package/src/tokens/lists/index.ts

@@ -1,3 +1,4 @@
+export { list as CamelotV3List } from "./camelot_v3";
 export { list as CaviarV1List } from "./caviar_v1";
 export { list as ChainflipList } from "./chainflip";
 export { list as JupiterList } from "./jupiter";

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,
@@ -212,7 +223,7 @@ 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.BitcoinCash]: "https://node-router.thorswap.net/bitcoin-cash",
@@ -223,13 +234,15 @@ export const RPC_URLS: Record<Chain | StagenetChain, string> = {
   [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.Maya]: "https://stagenet.tendermint.mayachain.info",
@@ -271,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",
@@ -282,6 +296,7 @@ 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.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"],
@@ -303,10 +318,12 @@ 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",
 };

package/src/types/commonTypes.ts

@@ -2,7 +2,7 @@ import type { Chain } from "./chains";
 import type { ChainWallet, CryptoChain } from "./wallet";
 
 export type AddChainType<M = { [key in string]: any }> = <T extends CryptoChain>(
-  params: ChainWallet<T> & M,
+  params: Omit<ChainWallet<T>, "balance"> & M,
 ) => void;
 
 export type Witness = {

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/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

@@ -27,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",

package/src/types/tokens.ts

@@ -2,19 +2,16 @@ 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"];

package/src/types/wallet.ts

@@ -1,14 +1,16 @@
 import type { CosmosWallets, ThorchainWallets } from "@swapkit/toolboxes/cosmos";
-import type { EVMWallets } from "@swapkit/toolboxes/evm";
-import type { RadixWallets } from "@swapkit/toolboxes/radix";
-import type { SolanaWallets } from "@swapkit/toolboxes/solana";
-import type { SubstrateWallets } from "@swapkit/toolboxes/substrate";
-import type { UTXOWallets } from "@swapkit/toolboxes/utxo";
+import type { EVMToolboxes } from "@swapkit/toolboxes/evm";
+import type { RadixWallet } from "@swapkit/toolboxes/radix";
+import type { RippleWallet } from "@swapkit/toolboxes/ripple";
+import type { SolanaWallet } from "@swapkit/toolboxes/solana";
+import type { SubstrateToolboxes } from "@swapkit/toolboxes/substrate";
+import type { UTXOToolboxes } from "@swapkit/toolboxes/utxo";
 import type { BrowserProvider } from "ethers";
 import type { Eip1193Provider } from "ethers";
 
 import type { AssetValue } from "../modules/assetValue";
-import type { Chain, ChainId } from "./chains";
+import { Chain, type ChainId } from "./chains";
+import type { FeeOption } from "./sdk";
 
 declare global {
   interface WindowEventMap {
@@ -27,7 +29,10 @@ export type EthereumWindowProvider = BrowserProvider & {
   isTalisman?: boolean;
   on: (event: string, callback?: () => void) => void;
   overrideIsMetaMask?: boolean;
-  request: <T = unknown>(args: { method: string; params?: unknown[] }) => Promise<T>;
+  request: <T = unknown>(args: {
+    method: string;
+    params?: unknown[];
+  }) => Promise<T>;
   selectedProvider?: EthereumWindowProvider;
 };
 
@@ -43,15 +48,6 @@ export type NetworkParams = {
   blockExplorerUrls: string[];
 };
 
-export type {
-  CosmosWallets,
-  ThorchainWallets,
-  EVMWallets,
-  SubstrateWallets,
-  UTXOWallets,
-  SolanaWallets,
-};
-
 export enum WalletOption {
   BITGET = "BITGET",
   BRAVE = "BRAVE",
@@ -70,6 +66,7 @@ export enum WalletOption {
   METAMASK = "METAMASK",
   OKX = "OKX",
   OKX_MOBILE = "OKX_MOBILE",
+  ONEKEY = "ONEKEY",
   PHANTOM = "PHANTOM",
   POLKADOT_JS = "POLKADOT_JS",
   RADIX_WALLET = "RADIX_WALLET",
@@ -102,13 +99,15 @@ export type BaseWallet<T extends EmptyWallet | Record<string, unknown>> = {
 };
 
 export type FullWallet = BaseWallet<
-  EVMWallets &
-    UTXOWallets &
+  EVMToolboxes &
+    UTXOToolboxes &
     CosmosWallets &
     ThorchainWallets &
-    SubstrateWallets &
-    SolanaWallets &
-    RadixWallets
+    SubstrateToolboxes & {
+      [Chain.Radix]: RadixWallet;
+      [Chain.Ripple]: RippleWallet;
+      [Chain.Solana]: SolanaWallet;
+    }
 >;
 
 export type SwapKitPluginParams = {
@@ -136,3 +135,25 @@ export type EIP6963Provider = {
 export type EIP6963AnnounceProviderEvent = Event & {
   detail: EIP6963Provider;
 };
+
+export type ChainSigner<T, S> = {
+  signTransaction: (params: T) => Promise<S>;
+  getAddress: () => Promise<string>;
+  sign?: (message: string) => Promise<string>;
+};
+
+export type GenericTransferParams = {
+  recipient: string;
+  assetValue: AssetValue;
+  memo?: string;
+  feeRate?: number;
+  feeOptionKey?: FeeOption;
+};
+
+export type GenericCreateTransactionParams = Omit<
+  GenericTransferParams,
+  "feeOptionKey" & "feeRate"
+> & {
+  sender: string;
+  feeRate: number;
+};