@snickerdoodlelabs/common-utils/src/interfaces/IBigNumberUtils.ts

Common utils classes used in snickerdoodlelabs projects

import {
  BigNumberString,
  DecimalString,
  HexString32,
} from "@snickerdoodlelabs/objects";

export interface IBigNumberUtils {
  //#region Math
  multiply(
    bn: bigint | BigNumberString,
    number: number,
    decimals?: number,
  ): bigint;
  divide(
    bn: bigint | BigNumberString,
    number: number,
    decimals?: number,
  ): bigint;
  //#endregion Math
  //#region DST
  DSToBN(decimalString: DecimalString, decimals?: number): bigint;
  DSToBNS(decimalString: DecimalString, decimals?: number): BigNumberString;
  //#endregion DST
  //#region BN
  BNtoBuffer(bigint: bigint): Buffer;
  BNToBNS(bigint: bigint): BigNumberString;
  BNToDS(bigint: bigint, decimals?: number): DecimalString;
  BNtoUint8Array(bigint: bigint): Uint8Array;
  //#endregion BN
  //#region BNS
  BNStoBuffer(bigNumberString: BigNumberString): Buffer;
  BNSToBN(bigNumberString: BigNumberString): bigint;
  BNSToDS(bigNumberString: BigNumberString, decimals?: number): DecimalString;
  BNStoHexString32(bigNumberString: BigNumberString): HexString32;
  BNStoHexString32NoPrefix(bigNumberString: BigNumberString): HexString32;
  BNStoUint8Array(bigNumberString: BigNumberString): Uint8Array;
  //#endregion BNS
  //#region Bytes
  // note that the buffer is assumed to be in big-endian format
  bufferToBN(buffer: Buffer): bigint;
  bufferToBNS(buffer: Buffer): BigNumberString;
  uint8ArrayToBN(uint8Array: Uint8Array): bigint;
  uint8ArrayToBNS(uint8Array: Uint8Array): BigNumberString;
  //#endregion Bytes
  //#region HexString32
  HexString32NoPrefixToBN(hexString: HexString32): bigint;
  HexString32NoPrefixToBNS(hexString: HexString32): BigNumberString;
  //#endregion HexString32
  //#region Validation
  validateBNS(bigNumberString: string): boolean;
  //#endregion Validation
}

export const IBigNumberUtilsType = Symbol.for("IBigNumberUtils");