@swapkit/helpers 4.0.0-beta.33 → 4.0.0-beta.35

package/src/modules/bigIntArithmetics.ts

@@ -1,436 +0,0 @@
-import { BaseDecimal } from "../types/chains";
-import type { SwapKitNumber } from "./swapKitNumber";
-
-type NumberPrimitivesType = {
-  bigint: bigint;
-  number: number;
-  string: string;
-};
-export type NumberPrimitives = bigint | number | string;
-type InitialisationValueType = NumberPrimitives | BigIntArithmetics | SwapKitNumber;
-
-type SKBigIntParams = InitialisationValueType | { decimal?: number; value: number | string };
-type AllowedNumberTypes = "bigint" | "number" | "string";
-
-const DEFAULT_DECIMAL = 8;
-const toMultiplier = (decimal: number) => 10n ** BigInt(decimal);
-const decimalFromMultiplier = (multiplier: bigint) =>
-  Math.log10(Number.parseFloat(multiplier.toString()));
-
-export function formatBigIntToSafeValue({
-  value,
-  bigIntDecimal = DEFAULT_DECIMAL,
-  decimal = DEFAULT_DECIMAL,
-}: {
-  value: bigint;
-  bigIntDecimal?: number;
-  decimal?: number;
-}) {
-  if (decimal === 0) return value.toString();
-  const isNegative = value < 0n;
-  let valueString = value.toString().substring(isNegative ? 1 : 0);
-
-  const padLength = decimal - (valueString.length - 1);
-
-  if (padLength > 0) {
-    valueString = "0".repeat(padLength) + valueString;
-  }
-
-  const decimalIndex = valueString.length - decimal;
-  let decimalString = valueString.slice(-decimal);
-
-  // Check if we need to round up
-  if (Number.parseInt(decimalString[bigIntDecimal] || "0") >= 5) {
-    // Increment the last decimal place and slice off the rest
-    decimalString = `${decimalString.substring(0, bigIntDecimal - 1)}${(Number.parseInt(decimalString[bigIntDecimal - 1] || "0") + 1).toString()}`;
-  } else {
-    // Just slice off the extra digits
-    decimalString = decimalString.substring(0, bigIntDecimal);
-  }
-
-  return `${isNegative ? "-" : ""}${valueString.slice(0, decimalIndex)}.${decimalString}`.replace(
-    /\.?0*$/,
-    "",
-  );
-}
-
-function divideBigIntWithRounding(n: bigint, d: bigint) {
-  if (d === 0n) {
-    throw new Error("Cannot divide by zero");
-  }
-  const half = d / 2n;
-  if ((n >= 0n && d >= 0n) || (n < 0n && d < 0n)) {
-    return (n + half) / d;
-  }
-  return (n - half) / d;
-}
-
-export class BigIntArithmetics {
-  decimalMultiplier: bigint = 10n ** 8n;
-  bigIntValue = 0n;
-  decimal?: number;
-
-  static fromBigInt(value: bigint, decimal?: number) {
-    return new BigIntArithmetics({
-      decimal,
-      value: formatBigIntToSafeValue({ value, bigIntDecimal: decimal, decimal }),
-    });
-  }
-
-  static shiftDecimals({
-    value,
-    from,
-    to,
-  }: {
-    value: InstanceType<typeof SwapKitNumber>;
-    from: number;
-    to: number;
-  }) {
-    return BigIntArithmetics.fromBigInt(
-      (value.getBaseValue("bigint") * toMultiplier(to)) / toMultiplier(from),
-      to,
-    );
-  }
-
-  constructor(params: SKBigIntParams) {
-    const value = getStringValue(params);
-    const isComplex = typeof params === "object";
-    this.decimal = isComplex ? params.decimal : undefined;
-
-    // use the multiplier to keep track of decimal point - defaults to 8 if lower than 8
-    this.decimalMultiplier =
-      isComplex && "decimalMultiplier" in params
-        ? params.decimalMultiplier
-        : toMultiplier(Math.max(getFloatDecimals(toSafeValue(value)), this.decimal || 0));
-    this.#setValue(value);
-  }
-
-  set(value: SKBigIntParams): this {
-    // @ts-expect-error False positive
-    return new this.constructor({
-      decimal: this.decimal,
-      value,
-      // @ts-expect-error False positive
-      identifier: this.toString({ includeSynthProtocol: true }),
-    });
-  }
-  add(...args: InitialisationValueType[]) {
-    return this.#arithmetics("add", ...args);
-  }
-  sub(...args: InitialisationValueType[]) {
-    return this.#arithmetics("sub", ...args);
-  }
-  mul(...args: InitialisationValueType[]) {
-    return this.#arithmetics("mul", ...args);
-  }
-  div(...args: InitialisationValueType[]) {
-    return this.#arithmetics("div", ...args);
-  }
-  gt(value: InitialisationValueType) {
-    return this.#comparison("gt", value);
-  }
-  gte(value: InitialisationValueType) {
-    return this.#comparison("gte", value);
-  }
-  lt(value: InitialisationValueType) {
-    return this.#comparison("lt", value);
-  }
-  lte(value: InitialisationValueType) {
-    return this.#comparison("lte", value);
-  }
-  eqValue(value: InitialisationValueType) {
-    return this.#comparison("eqValue", value);
-  }
-
-  getValue<T extends AllowedNumberTypes>(type: T, decimal?: number): NumberPrimitivesType[T] {
-    const value = this.formatBigIntToSafeValue(
-      this.bigIntValue,
-      decimal || this.decimal || decimalFromMultiplier(this.decimalMultiplier),
-    );
-
-    switch (type) {
-      case "number":
-        return Number(value) as NumberPrimitivesType[T];
-      case "string":
-        return value as NumberPrimitivesType[T];
-      case "bigint":
-        return ((this.bigIntValue * 10n ** BigInt(this.decimal || 8n)) /
-          this.decimalMultiplier) as NumberPrimitivesType[T];
-      default:
-        return value as NumberPrimitivesType[T];
-    }
-  }
-
-  getBaseValue<T extends AllowedNumberTypes>(type: T, decimal?: number): NumberPrimitivesType[T] {
-    const divisor =
-      this.decimalMultiplier / toMultiplier(decimal || this.decimal || BaseDecimal.THOR);
-    const baseValue = divideBigIntWithRounding(this.bigIntValue, divisor);
-
-    switch (type) {
-      case "number":
-        return Number(baseValue) as NumberPrimitivesType[T];
-      case "string":
-        return baseValue.toString() as NumberPrimitivesType[T];
-      case "bigint":
-        return baseValue as NumberPrimitivesType[T];
-      default:
-        return baseValue as NumberPrimitivesType[T];
-    }
-  }
-
-  getBigIntValue(value: InitialisationValueType, decimal?: number) {
-    if (!decimal && typeof value === "object") return value.bigIntValue;
-
-    const stringValue = getStringValue(value);
-    const safeValue = toSafeValue(stringValue);
-
-    if (safeValue === "0" || safeValue === "undefined") return 0n;
-    return this.#toBigInt(safeValue, decimal);
-  }
-
-  toSignificant(significantDigits = 6) {
-    const [int, dec] = this.getValue("string").split(".");
-    const integer = int || "";
-    const decimal = dec || "";
-    const valueLength = Number.parseInt(integer) ? integer.length + decimal.length : decimal.length;
-
-    if (valueLength <= significantDigits) {
-      return this.getValue("string");
-    }
-
-    if (integer.length >= significantDigits) {
-      return integer.slice(0, significantDigits).padEnd(integer.length, "0");
-    }
-
-    if (Number.parseInt(integer)) {
-      return `${integer}.${decimal.slice(0, significantDigits - integer.length)}`.padEnd(
-        significantDigits - integer.length,
-        "0",
-      );
-    }
-
-    const trimmedDecimal = Number.parseInt(decimal);
-    const slicedDecimal = `${trimmedDecimal}`.slice(0, significantDigits);
-
-    return `0.${slicedDecimal.padStart(
-      decimal.length - `${trimmedDecimal}`.length + slicedDecimal.length,
-      "0",
-    )}`;
-  }
-
-  toFixed(fixedDigits = 6) {
-    const [int, dec] = this.getValue("string").split(".");
-    const integer = int || "";
-    const decimal = dec || "";
-
-    if (Number.parseInt(integer)) {
-      return `${integer}.${decimal.slice(0, fixedDigits)}`.padEnd(fixedDigits, "0");
-    }
-
-    const trimmedDecimal = Number.parseInt(decimal);
-    const slicedDecimal = `${trimmedDecimal}`.slice(0, fixedDigits);
-
-    return `0.${slicedDecimal.padStart(
-      decimal.length - `${trimmedDecimal}`.length + slicedDecimal.length,
-      "0",
-    )}`;
-  }
-
-  toAbbreviation(digits = 2) {
-    const value = this.getValue("number");
-    const abbreviations = ["", "K", "M", "B", "T", "Q", "Qi", "S"];
-    const tier = Math.floor(Math.log10(Math.abs(value)) / 3);
-    const suffix = abbreviations[tier];
-
-    if (!suffix) return this.getValue("string");
-
-    const scale = 10 ** (tier * 3);
-    const scaled = value / scale;
-
-    return `${scaled.toFixed(digits)}${suffix}`;
-  }
-
-  toCurrency(
-    currency = "$",
-    {
-      currencyPosition = "start",
-      decimal = 2,
-      decimalSeparator = ".",
-      thousandSeparator = ",",
-    } = {},
-  ) {
-    const value = this.getValue("number");
-    const [int = "", dec = ""] = value.toFixed(6).split(".");
-    const integer = int.replace(/\B(?=(\d{3})+(?!\d))/g, thousandSeparator);
-
-    const parsedValue =
-      int || dec
-        ? int === "0"
-          ? `${Number.parseFloat(`0.${dec}`)}`.replace(".", decimalSeparator)
-          : `${integer}${Number.parseInt(dec) ? `${decimalSeparator}${dec.slice(0, decimal)}` : ""}`
-        : "0.00";
-
-    return `${currencyPosition === "start" ? currency : ""}${parsedValue}${
-      currencyPosition === "end" ? currency : ""
-    }`;
-  }
-
-  formatBigIntToSafeValue(value: bigint, decimal?: number) {
-    const bigIntDecimal = decimal || this.decimal || DEFAULT_DECIMAL;
-    const decimalToUseForConversion = Math.max(
-      bigIntDecimal,
-      decimalFromMultiplier(this.decimalMultiplier),
-    );
-    const isNegative = value < 0n;
-
-    const valueString = value.toString().substring(isNegative ? 1 : 0);
-    const padLength = decimalToUseForConversion - (valueString.length - 1);
-
-    const parsedValueString = padLength > 0 ? "0".repeat(padLength) + valueString : valueString;
-
-    const decimalIndex = parsedValueString.length - decimalToUseForConversion;
-    let decimalString = parsedValueString.slice(-decimalToUseForConversion);
-
-    // Check if we need to round up
-    if (Number.parseInt(decimalString[bigIntDecimal] || "0") >= 5) {
-      // Increment the last decimal place and slice off the rest
-      decimalString = `${decimalString.substring(0, bigIntDecimal - 1)}${(Number.parseInt(decimalString[bigIntDecimal - 1] || "0") + 1).toString()}`;
-    } else {
-      // Just slice off the extra digits
-      decimalString = decimalString.substring(0, bigIntDecimal);
-    }
-
-    return `${isNegative ? "-" : ""}${parsedValueString.slice(
-      0,
-      decimalIndex,
-    )}.${decimalString}`.replace(/\.?0*$/, "");
-  }
-
-  #arithmetics(method: "add" | "sub" | "mul" | "div", ...args: InitialisationValueType[]): this {
-    const precisionDecimal = this.#retrievePrecisionDecimal(this, ...args);
-    const decimal = Math.max(precisionDecimal, decimalFromMultiplier(this.decimalMultiplier));
-    const precisionDecimalMultiplier = toMultiplier(decimal);
-
-    const result = args.reduce(
-      (acc: bigint, arg) => {
-        const value = this.getBigIntValue(arg, decimal);
-
-        switch (method) {
-          case "add":
-            return acc + value;
-          case "sub":
-            return acc - value;
-          /**
-           * Multiplication & division would end up with wrong result if we don't adjust the value
-           * 200000000n * 200000000n => 40000000000000000n
-           * 200000000n / 200000000n => 1n
-           * So we do the following:
-           * 200000000n * 200000000n = 40000000000000000n / 100000000n (decimals) => 400000000n
-           * (200000000n * 100000000n (decimals)) / 200000000n => 100000000n
-           */
-          case "mul":
-            return (acc * value) / precisionDecimalMultiplier;
-          case "div": {
-            if (value === 0n) throw new RangeError("Division by zero");
-            return (acc * precisionDecimalMultiplier) / value;
-          }
-          default:
-            return acc;
-        }
-      },
-      //normalize is to precision multiplier base
-      (this.bigIntValue * precisionDecimalMultiplier) / this.decimalMultiplier,
-    );
-
-    const value = formatBigIntToSafeValue({
-      bigIntDecimal: decimal,
-      decimal,
-      value: result,
-    });
-
-    // @ts-expect-error False positive
-    return new this.constructor({
-      decimalMultiplier: toMultiplier(decimal),
-      decimal: this.decimal,
-      value,
-      identifier: this.toString(),
-    });
-  }
-
-  #comparison(method: "gt" | "gte" | "lt" | "lte" | "eqValue", ...args: InitialisationValueType[]) {
-    const decimal = this.#retrievePrecisionDecimal(this, ...args);
-    const value = this.getBigIntValue(args[0] || "0", decimal);
-    const compareToValue = this.getBigIntValue(this, decimal);
-
-    switch (method) {
-      case "gt":
-        return compareToValue > value;
-      case "gte":
-        return compareToValue >= value;
-      case "lt":
-        return compareToValue < value;
-      case "lte":
-        return compareToValue <= value;
-      case "eqValue":
-        return compareToValue === value;
-      default:
-        return false;
-    }
-  }
-
-  #setValue(value: InitialisationValueType) {
-    const safeValue = toSafeValue(value) || "0";
-    this.bigIntValue = this.#toBigInt(safeValue);
-  }
-
-  #retrievePrecisionDecimal(...args: InitialisationValueType[]) {
-    const decimals = args
-      .map((arg) => {
-        const isObject = typeof arg === "object";
-        const value = isObject
-          ? arg.decimal || decimalFromMultiplier(arg.decimalMultiplier)
-          : getFloatDecimals(toSafeValue(arg));
-
-        return value;
-      })
-      .filter(Boolean) as number[];
-
-    return Math.max(...decimals, DEFAULT_DECIMAL);
-  }
-
-  #toBigInt(value: string, decimal?: number) {
-    const multiplier = decimal ? toMultiplier(decimal) : this.decimalMultiplier;
-    const padDecimal = decimalFromMultiplier(multiplier);
-    const [integerPart = "", decimalPart = ""] = value.split(".");
-
-    return BigInt(`${integerPart}${decimalPart.padEnd(padDecimal, "0")}`);
-  }
-}
-
-const numberFormatter = Intl.NumberFormat("fullwide", {
-  useGrouping: false,
-  maximumFractionDigits: 20,
-});
-
-function toSafeValue(value: InitialisationValueType) {
-  const parsedValue =
-    typeof value === "number" ? numberFormatter.format(value) : getStringValue(value);
-  const splitValue = `${parsedValue}`.replaceAll(",", ".").split(".");
-
-  return splitValue.length > 1
-    ? `${splitValue.slice(0, -1).join("")}.${splitValue.at(-1)}`
-    : splitValue[0] || "0";
-}
-
-function getFloatDecimals(value: string) {
-  const decimals = value.split(".")[1]?.length || 0;
-  return Math.max(decimals, DEFAULT_DECIMAL);
-}
-
-function getStringValue(param: SKBigIntParams) {
-  return typeof param === "object"
-    ? "getValue" in param
-      ? param.getValue("string")
-      : param.value
-    : param;
-}

package/src/modules/feeMultiplier.ts

@@ -1,87 +0,0 @@
-import { FeeOption } from "../types";
-import { SKConfig } from "./swapKitConfig";
-
-export interface FeeMultiplierConfig {
-  [FeeOption.Average]: number;
-  [FeeOption.Fast]: number;
-  [FeeOption.Fastest]: number;
-}
-
-const DEFAULT_FEE_MULTIPLIERS: FeeMultiplierConfig = {
-  [FeeOption.Average]: 1.0,
-  [FeeOption.Fast]: 1.5,
-  [FeeOption.Fastest]: 2.0,
-};
-
-/**
- * Get fee multiplier for the given fee option.
- * Checks SKConfig for custom multipliers first, then falls back to defaults.
- *
- * @param feeOption - The fee option (Average, Fast, Fastest)
- * @returns The fee multiplier as a number
- */
-export function getFeeMultiplier(feeOption: FeeOption = FeeOption.Average): number {
-  const customMultipliers = SKConfig.get("feeMultipliers");
-
-  if (customMultipliers && customMultipliers[feeOption] !== undefined) {
-    return customMultipliers[feeOption];
-  }
-
-  return DEFAULT_FEE_MULTIPLIERS[feeOption];
-}
-
-/**
- * Get fee multiplier as BigInt for EVM calculations.
- * Returns numerator and denominator for precise BigInt arithmetic.
- *
- * @param feeOption - The fee option (Average, Fast, Fastest)
- * @returns Object with numerator and denominator for BigInt calculations
- */
-export function getFeeMultiplierAsBigInt(feeOption: FeeOption = FeeOption.Average): {
-  numerator: bigint;
-  denominator: bigint;
-} {
-  const multiplier = getFeeMultiplier(feeOption);
-
-  // Convert decimal multiplier to fraction for precise BigInt arithmetic
-  // e.g., 1.5 -> 15/10, 2.0 -> 20/10
-  const denominator = 10n;
-  const numerator = BigInt(Math.round(multiplier * 10));
-
-  return { numerator, denominator };
-}
-
-/**
- * Apply fee multiplier to a BigInt value (for EVM chains).
- *
- * @param value - The base fee value as BigInt
- * @param feeOption - The fee option (Average, Fast, Fastest)
- * @returns The multiplied fee value as BigInt
- */
-export function applyFeeMultiplierToBigInt(
-  value: bigint,
-  feeOption: FeeOption = FeeOption.Average,
-): bigint {
-  const { numerator, denominator } = getFeeMultiplierAsBigInt(feeOption);
-  return (value * numerator) / denominator;
-}
-
-/**
- * Apply fee multiplier to a number value (for non-EVM chains).
- *
- * @param value - The base fee value as number
- * @param feeOption - The fee option (Average, Fast, Fastest)
- * @param floor - Whether to floor the result (default: false)
- * @returns The multiplied fee value as number
- */
-export function applyFeeMultiplier(
-  value: number,
-  feeOption: FeeOption = FeeOption.Average,
-  floor = false,
-): number {
-  const multiplier = getFeeMultiplier(feeOption);
-  const result = value * multiplier;
-  return floor ? Math.floor(result) : result;
-}
-
-export { DEFAULT_FEE_MULTIPLIERS };

package/src/modules/requestClient.ts

@@ -1,83 +0,0 @@
-import { SwapKitError } from "./swapKitError";
-
-type Options = RequestInit & {
-  /**
-   * @deprecated Use onSuccess instead - will be removed in next major @MarkedV4
-   */
-  responseHandler?: (response: any) => any;
-  json?: unknown;
-  onError?: (error: any) => any;
-  onSuccess?: (response: any) => any;
-  searchParams?: Record<string, string>;
-  dynamicHeader?: () => Record<string, string> | {};
-};
-
-export const RequestClient = {
-  get: fetchWithConfig("GET"),
-  post: fetchWithConfig("POST"),
-  extend: (extendOptions: Options) => ({
-    get: fetchWithConfig("GET", extendOptions),
-    post: fetchWithConfig("POST", extendOptions),
-    extend: (newOptions: Options) => RequestClient.extend({ ...extendOptions, ...newOptions }),
-  }),
-};
-
-function fetchWithConfig(method: "GET" | "POST", extendOptions: Options = {}) {
-  return async <T>(url: string, options: Options = {}): Promise<T> => {
-    const {
-      searchParams,
-      json,
-      body,
-      headers: headersOptions,
-      dynamicHeader,
-    } = { ...extendOptions, ...options };
-
-    const isJson = !!json || url.endsWith(".json");
-    const bodyToSend = isJson ? JSON.stringify(json) : body;
-
-    try {
-      const requestUrl = buildUrl(url, searchParams);
-      const headers = buildHeaders(isJson, {
-        ...headersOptions,
-        ...dynamicHeader?.(),
-      });
-
-      const response = await fetch(requestUrl, { ...options, method, body: bodyToSend, headers });
-
-      if (!response.ok) {
-        const message = await response.text();
-        throw new SwapKitError("helpers_invalid_response", {
-          status: response.status,
-          statusText: response.statusText,
-          message,
-        });
-      }
-
-      const body = await response.json();
-
-      return options.onSuccess?.(body) || options.responseHandler?.(body) || body;
-    } catch (error) {
-      if (options.onError) {
-        return options.onError(error);
-      }
-      throw error;
-    }
-  };
-}
-
-function buildHeaders(isJson: boolean, headersOptions?: HeadersInit) {
-  return {
-    ...headersOptions,
-    ...(isJson ? { "Content-Type": "application/json" } : {}),
-  };
-}
-
-function buildUrl(url: string, searchParams?: Record<string, string>) {
-  const urlInstance = new URL(url);
-
-  if (searchParams) {
-    urlInstance.search = new URLSearchParams(searchParams).toString();
-  }
-
-  return urlInstance.toString();
-}