@swapkit/helpers 1.0.0-rc.6 → 1.0.0-rc.61

package/src/modules/bigIntArithmetics.ts

@@ -1,3 +1,5 @@
+import { BaseDecimal } from '@swapkit/types';
+
 import type { SwapKitNumber } from './swapKitNumber.ts';
 
 type NumberPrimitivesType = {
@@ -5,10 +7,11 @@ type NumberPrimitivesType = {
   number: number;
   string: string;
 };
-type NumberPrimitives = bigint | number | 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);
@@ -23,6 +26,7 @@ export function formatBigIntToSafeValue({
   bigIntDecimal?: number;
   decimal?: number;
 }) {
+  if (decimal === 0) return value.toString();
   const isNegative = value < 0n;
   let valueString = value.toString().substring(isNegative ? 1 : 0);
 
@@ -69,47 +73,30 @@ export class BigIntArithmetics {
     from,
     to,
   }: {
-    value: InitialisationValueType;
+    value: InstanceType<typeof SwapKitNumber>;
     from: number;
     to: number;
   }) {
-    return BigIntArithmetics.fromBigInt(
-      (new BigIntArithmetics(value).bigIntValue * toMultiplier(to)) / toMultiplier(from),
+    return this.fromBigInt(
+      (value.getBaseValue('bigint') * toMultiplier(to)) / toMultiplier(from),
       to,
     );
   }
 
   constructor(params: SKBigIntParams) {
     const value = getStringValue(params);
-    this.decimal = typeof params === 'object' ? params.decimal : undefined;
+    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 = toMultiplier(
-      Math.max(this.#getFloatDecimals(this.#toSafeValue(value)), this.decimal || 0),
-    );
+    this.decimalMultiplier =
+      isComplex && 'decimalMultiplier' in params
+        ? params.decimalMultiplier
+        : toMultiplier(Math.max(getFloatDecimals(toSafeValue(value)), this.decimal || 0));
     this.#setValue(value);
   }
 
-  /**
-   * @deprecated Use `getBaseValue('string')` instead
-   */
-  get baseValue() {
-    return this.getBaseValue('string') as string;
-  }
-  /**
-   * @deprecated Use `getBaseValue('number')` instead
-   */
-  get baseValueNumber() {
-    return this.getBaseValue('number') as number;
-  }
-  /**
-   * @deprecated Use `getBaseValue('bigint')` instead
-   */
-  get baseValueBigInt() {
-    return this.getBaseValue('bigint') as bigint;
-  }
-
-  set(value: SKBigIntParams) {
+  set(value: SKBigIntParams): this {
     // @ts-expect-error False positive
     return new this.constructor({ decimal: this.decimal, value, identifier: this.toString() });
   }
@@ -126,22 +113,23 @@ export class BigIntArithmetics {
     return this.#arithmetics('div', ...args);
   }
   gt(value: InitialisationValueType) {
-    return this.bigIntValue > this.getBigIntValue(value);
+    return this.#comparison('gt', value);
   }
   gte(value: InitialisationValueType) {
-    return this.bigIntValue >= this.getBigIntValue(value);
+    return this.#comparison('gte', value);
   }
   lt(value: InitialisationValueType) {
-    return this.bigIntValue < this.getBigIntValue(value);
+    return this.#comparison('lt', value);
   }
   lte(value: InitialisationValueType) {
-    return this.bigIntValue <= this.getBigIntValue(value);
+    return this.#comparison('lte', value);
   }
   eqValue(value: InitialisationValueType) {
-    return this.bigIntValue === this.getBigIntValue(value);
+    return this.#comparison('eqValue', value);
   }
 
-  getValue<T extends 'number' | 'string' | 'bigint'>(type: T): NumberPrimitivesType[T] {
+  // @ts-expect-error False positive
+  getValue<T extends AllowedNumberTypes>(type: T): NumberPrimitivesType[T] {
     const value = this.formatBigIntToSafeValue(
       this.bigIntValue,
       this.decimal || decimalFromMultiplier(this.decimalMultiplier),
@@ -149,38 +137,125 @@ export class BigIntArithmetics {
 
     switch (type) {
       case 'number':
-        // @ts-expect-error False positive
-        return Number(value);
+        return Number(value) as NumberPrimitivesType[T];
       case 'string':
-        // @ts-expect-error False positive
-        return value;
-      default:
-        // @ts-expect-error False positive
-        return this.bigIntValue;
+        return value as NumberPrimitivesType[T];
+      case 'bigint':
+        return ((this.bigIntValue * 10n ** BigInt(this.decimal || 8n)) /
+          this.decimalMultiplier) as NumberPrimitivesType[T];
     }
   }
 
-  getBaseValue<T extends 'number' | 'string' | 'bigint'>(type: T): NumberPrimitivesType[T] {
-    const divisor = this.decimalMultiplier / toMultiplier(this.decimal || 0);
+  // @ts-expect-error
+  getBaseValue<T extends AllowedNumberTypes>(type: T): NumberPrimitivesType[T] {
+    const divisor = this.decimalMultiplier / toMultiplier(this.decimal || BaseDecimal.THOR);
     const baseValue = this.bigIntValue / divisor;
 
     switch (type) {
       case 'number':
-        // @ts-expect-error False positive
-        return Number(baseValue);
+        return Number(baseValue) as NumberPrimitivesType[T];
       case 'string':
-        // @ts-expect-error False positive
-        return baseValue.toString();
-      default:
-        // @ts-expect-error False positive
-        return this.bigIntValue;
+        return baseValue.toString() as NumberPrimitivesType[T];
+      case 'bigint':
+        return baseValue as NumberPrimitivesType[T];
     }
   }
 
   getBigIntValue(value: InitialisationValueType, decimal?: number) {
     if (!decimal && typeof value === 'object') return value.bigIntValue;
 
-    return this.#toBigInt(this.#toSafeValue(getStringValue(value)), decimal);
+    const stringValue = getStringValue(value);
+    const safeValue = toSafeValue(stringValue);
+
+    if (safeValue === '0' || safeValue === 'undefined') return 0n;
+    return this.#toBigInt(safeValue, decimal);
+  }
+
+  toSignificant(significantDigits: number = 6) {
+    const [int, dec] = this.getValue('string').split('.');
+    const integer = int || '';
+    const decimal = dec || '';
+    const valueLength = 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 (parseInt(integer)) {
+      return `${integer}.${decimal.slice(0, significantDigits - integer.length)}`.padEnd(
+        significantDigits - integer.length,
+        '0',
+      );
+    }
+
+    const trimmedDecimal = parseInt(decimal);
+    const slicedDecimal = `${trimmedDecimal}`.slice(0, significantDigits);
+
+    return `0.${slicedDecimal.padStart(
+      decimal.length - `${trimmedDecimal}`.length + slicedDecimal.length,
+      '0',
+    )}`;
+  }
+
+  toFixed(fixedDigits: number = 6) {
+    const [int, dec] = this.getValue('string').split('.');
+    const integer = int || '';
+    const decimal = dec || '';
+
+    if (parseInt(integer)) {
+      return `${integer}.${decimal.slice(0, fixedDigits)}`.padEnd(fixedDigits, '0');
+    }
+
+    const trimmedDecimal = 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
+        ? '0.00'
+        : int === '0'
+          ? `${parseFloat(`0.${dec}`)}`.replace('.', decimalSeparator)
+          : `${integer}${parseInt(dec) ? `${decimalSeparator}${dec.slice(0, decimal)}` : ''}`;
+
+    return `${currencyPosition === 'start' ? currency : ''}${parsedValue}${
+      currencyPosition === 'end' ? currency : ''
+    }`;
   }
 
   formatBigIntToSafeValue(value: bigint, decimal?: number) {
@@ -216,43 +291,14 @@ export class BigIntArithmetics {
     )}.${decimalString}`.replace(/\.?0*$/, '');
   }
 
-  toSignificant(significantDigits: number = 6) {
-    const [int, dec] = this.getValue('string').split('.');
-    const integer = int || '';
-    const decimal = dec || '';
-    const valueLength = 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 (parseInt(integer)) {
-      return `${integer}.${decimal.slice(0, significantDigits - integer.length)}`.padEnd(
-        valueLength - significantDigits,
-        '0',
-      );
-    }
-
-    const trimmedDecimal = parseInt(decimal);
-    const slicedDecimal = `${trimmedDecimal}`.slice(0, significantDigits);
-
-    return `0.${slicedDecimal.padStart(
-      decimal.length - `${trimmedDecimal}`.length + slicedDecimal.length,
-      '0',
-    )}`;
-  }
-
   #arithmetics(method: 'add' | 'sub' | 'mul' | 'div', ...args: InitialisationValueType[]): this {
     const precisionDecimal = this.#retrievePrecisionDecimal(this, ...args);
-    const precisionDecimalMultiplier = toMultiplier(precisionDecimal);
+    const decimal = Math.max(precisionDecimal, decimalFromMultiplier(this.decimalMultiplier));
+    const precisionDecimalMultiplier = toMultiplier(decimal);
 
     const result = args.reduce(
       (acc: bigint, arg) => {
-        const value = this.getBigIntValue(arg, precisionDecimal);
+        const value = this.getBigIntValue(arg, decimal);
 
         switch (method) {
           case 'add':
@@ -282,65 +328,92 @@ export class BigIntArithmetics {
     );
 
     const value = formatBigIntToSafeValue({
-      bigIntDecimal: precisionDecimal,
-      decimal: Math.max(precisionDecimal, decimalFromMultiplier(this.decimalMultiplier)),
+      bigIntDecimal: decimal,
+      decimal,
       value: result,
     });
 
     // @ts-expect-error False positive
-    return new this.constructor({ decimal: this.decimal, value, identifier: this.toString() });
+    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], 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;
+    }
   }
 
   #setValue(value: InitialisationValueType) {
-    const safeValue = this.#toSafeValue(value) || '0';
+    const safeValue = toSafeValue(value) || '0';
     this.bigIntValue = this.#toBigInt(safeValue);
   }
 
   #retrievePrecisionDecimal(...args: InitialisationValueType[]) {
     const decimals = args
-      .map((arg) =>
-        typeof arg === 'object'
+      .map((arg) => {
+        const isObject = typeof arg === 'object';
+        const value = isObject
           ? arg.decimal || decimalFromMultiplier(arg.decimalMultiplier)
-          : this.#getFloatDecimals(this.#toSafeValue(arg)),
-      )
+          : 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('.');
+    const [integerPart = '', decimalPart = ''] = value.split('.');
 
     return BigInt(`${integerPart}${decimalPart.padEnd(padDecimal, '0')}`);
   }
+}
 
-  #toSafeValue(value: InitialisationValueType) {
-    const parsedValue =
-      typeof value === 'number'
-        ? Number(value).toLocaleString('fullwide', {
-            useGrouping: false,
-            maximumFractionDigits: 20,
-          })
-        : getStringValue(value);
-
-    const splitValue = `${parsedValue}`.replaceAll(',', '.').split('.');
-
-    return splitValue.length > 1
-      ? `${splitValue.slice(0, -1).join('')}.${splitValue.at(-1)}`
-      : splitValue[0];
-  }
+const numberFormatter = Intl.NumberFormat('fullwide', {
+  useGrouping: false,
+  maximumFractionDigits: 20,
+});
 
-  #getFloatDecimals(value: string) {
-    const decimals = value.split('.')[1]?.length || 0;
-    return Math.max(decimals, DEFAULT_DECIMAL);
-  }
+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];
+}
+
+function getFloatDecimals(value: string) {
+  const decimals = value.split('.')[1]?.length || 0;
+  return Math.max(decimals, DEFAULT_DECIMAL);
 }
 
-function getStringValue(value: SKBigIntParams) {
-  return typeof value === 'object'
-    ? 'getValue' in value
-      ? value.getValue('string')
-      : value.value
-    : value;
+function getStringValue(param: SKBigIntParams) {
+  return typeof param === 'object'
+    ? 'getValue' in param
+      ? param.getValue('string')
+      : param.value
+    : param;
 }

package/src/modules/swapKitError.ts

@@ -45,6 +45,7 @@ const errorMessages = {
   core_transaction_deposit_to_pool_error: 10310,
   core_transaction_deposit_insufficient_funds_error: 10311,
   core_transaction_deposit_gas_error: 10312,
+  core_transaction_invalid_sender_address: 10313,
   core_transaction_deposit_server_error: 10313,
 
   /**
@@ -62,7 +63,7 @@ export type Keys = keyof typeof errorMessages;
 
 export class SwapKitError extends Error {
   constructor(errorKey: Keys, sourceError?: any) {
-    console.error(sourceError);
+    console.error(sourceError, { stack: sourceError?.stack, message: sourceError?.message });
 
     super(errorKey, { cause: { code: errorMessages[errorKey], message: errorKey } });
     Object.setPrototypeOf(this, SwapKitError.prototype);

package/src/modules/swapKitNumber.ts

@@ -1,4 +1,4 @@
-import { BigIntArithmetics } from './bigIntArithmetics.ts';
+import { BigIntArithmetics, formatBigIntToSafeValue } from './bigIntArithmetics.ts';
 
 export type SwapKitValueType = BigIntArithmetics | string | number;
 
@@ -6,4 +6,11 @@ export class SwapKitNumber extends BigIntArithmetics {
   eq(value: SwapKitValueType) {
     return this.eqValue(value);
   }
+
+  static fromBigInt(value: bigint, decimal?: number) {
+    return new SwapKitNumber({
+      decimal,
+      value: formatBigIntToSafeValue({ value, bigIntDecimal: decimal, decimal }),
+    });
+  }
 }

package/src/types.ts

@@ -0,0 +1,28 @@
+import type {
+  CoinGeckoList,
+  MayaList,
+  PancakeswapETHList,
+  PancakeswapList,
+  PangolinList,
+  StargateARBList,
+  SushiswapList,
+  ThorchainList,
+  TraderjoeList,
+  UniswapList,
+  WoofiList,
+} from '@swapkit/tokens';
+
+export type TokenTax = { buy: number; sell: number };
+
+export type TokenNames =
+  | (typeof ThorchainList)['tokens'][number]['identifier']
+  | (typeof CoinGeckoList)['tokens'][number]['identifier']
+  | (typeof MayaList)['tokens'][number]['identifier']
+  | (typeof PancakeswapETHList)['tokens'][number]['identifier']
+  | (typeof PancakeswapList)['tokens'][number]['identifier']
+  | (typeof PangolinList)['tokens'][number]['identifier']
+  | (typeof StargateARBList)['tokens'][number]['identifier']
+  | (typeof SushiswapList)['tokens'][number]['identifier']
+  | (typeof TraderjoeList)['tokens'][number]['identifier']
+  | (typeof WoofiList)['tokens'][number]['identifier']
+  | (typeof UniswapList)['tokens'][number]['identifier'];