@gearbox-protocol/sdk 0.0.110 → 1.0.0

package/src/utils/errors.ts

@@ -1,11 +0,0 @@
-interface IMetamaskError {
-  code: number;
-  message: string;
-}
-
-export const isMetamaskError = (e: any): e is IMetamaskError => {
-  if (!e) return false;
-  if (typeof e !== "object") return false;
-  if (typeof e.code !== "number" || typeof e.message !== "string") return false;
-  return true;
-};

package/src/utils/extracter.ts

@@ -1,30 +0,0 @@
-import { PoolData } from "../core/pool";
-
-export interface PoolTokens {
-  dieselToken: string | undefined;
-  underlyingToken: string | undefined;
-}
-
-export function getPoolTokens(pool: PoolData | undefined | Error): PoolTokens {
-  const safePool = pool instanceof Error ? undefined : pool;
-  const { dieselToken, underlyingToken } = safePool || {};
-
-  return {
-    dieselToken,
-    underlyingToken
-  };
-}
-
-interface WithUnderlyingToken {
-  readonly underlyingToken: string;
-}
-
-export function getUnderlyingToken(
-  c: WithUnderlyingToken | undefined | Error
-): string | undefined {
-  if (!c || c instanceof Error) {
-    return undefined;
-  }
-
-  return c.underlyingToken;
-}

package/src/utils/formatter.ts

@@ -1,146 +0,0 @@
-import { BigNumber, BigNumberish } from "ethers";
-import Decimal from "decimal.js-light";
-import { PERCENTAGE_FACTOR, RAY, LEVERAGE_DECIMALS } from "../core/constants";
-
-export function rayToNumber(num: BigNumberish): number {
-  return (
-    BigNumber.from(num).div(BigNumber.from(10).pow(21)).toNumber() / 1000000
-  );
-}
-
-export function formatRAY(num?: BigNumber): string {
-  return toSignificant(num || BigNumber.from(0), 27);
-}
-
-export function formatBN(
-  numArg: BigNumberish | undefined,
-  decimals: number,
-  precisionArg?: number
-): string {
-  let num = numArg;
-  let precision = precisionArg;
-
-  if (!num) return "-";
-
-  // if (BigNumber.from(num).gt(BigNumber.from(10).pow(37))) {
-  //   return "MAX";
-  // }
-
-  if (!precision && BigNumber.from(num).gt(BigNumber.from(10).pow(21))) {
-    precision = 2;
-  }
-
-  if (!precision && BigNumber.from(num).gt(BigNumber.from(10).pow(24))) {
-    precision = 0;
-  }
-
-  if (BigNumber.from(num).lte(2)) {
-    num = BigNumber.from(0);
-  }
-
-  const number = BigNumber.from(num).div(
-    BigNumber.from(10).pow((decimals || 18) - 6)
-  );
-
-  if (number.lte(10000) && !number.isZero()) {
-    precision = 3;
-  }
-
-  if (number.lte(1000) && !number.isZero()) {
-    precision = 4;
-  }
-
-  if (number.lte(100) && !number.isZero()) {
-    precision = 5;
-  }
-
-  if (number.lte(10) && !number.isZero()) {
-    precision = 6;
-  }
-
-  return toHumanFormat(number, precision);
-}
-
-export function formatBn4dig(num: BigNumber, precision: number = 2): string {
-  if (precision > 6) throw new Error("Incorrect precision");
-
-  let numStr = num.toString();
-  if (numStr.length < 6) numStr = "0".repeat(6 - numStr.length) + numStr;
-  return numStr.length <= 6
-    ? `0.${numStr.slice(0, precision)}`
-    : `${numStr.slice(0, numStr.length - 6)}.${numStr.slice(
-        numStr.length - 6,
-        numStr.length - 6 + precision
-      )}`;
-}
-
-export function toHumanFormat(num: BigNumber, precision: number = 2): string {
-  if (num.gte(1e15)) {
-    return `${formatBn4dig(num.div(1e9), precision)}Bn`;
-  }
-
-  if (num.gte(1e12)) {
-    return `${formatBn4dig(num.div(1e6), precision)}M`;
-  }
-
-  if (num.gte(1e9)) {
-    return `${formatBn4dig(num.div(1e3), precision)}K`;
-  }
-
-  return formatBn4dig(num, precision);
-}
-
-export function toSignificant(num: BigNumber, decimals: number): string {
-  if (num.toString() === "1") return "0";
-  const divider = new Decimal(10).toPower(decimals);
-  const number = new Decimal(num.toString()).div(divider);
-  return number.toSignificantDigits(6, 4).toString();
-}
-
-export function toBN(num: string, decimals: number): BigNumber {
-  if (num === "") return BigNumber.from(0);
-  const multiplier = new Decimal(10).toPower(decimals);
-  const number = new Decimal(num).mul(multiplier);
-  return BigNumber.from(number.toFixed(0));
-}
-
-export function shortAddress(address?: string): string {
-  return address === undefined
-    ? ""
-    : `${address.substr(0, 6)}...${address.substr(38, 4)}`;
-}
-
-export function shortHash(address?: string): string {
-  return address === undefined ? "" : `${address.substr(0, 5)}...`;
-}
-
-export const formatRate = (rate: BigNumberish | undefined) =>
-  rate
-    ? `${(
-        BigNumber.from(rate)
-          .mul(PERCENTAGE_FACTOR)
-          .mul(100)
-          .div(RAY)
-          .toNumber() / PERCENTAGE_FACTOR
-      ).toFixed(2)}%`
-    : "0.00%";
-
-export function formatDate(date: Date): string {
-  const d = new Date(date);
-  let month = `${d.getMonth() + 1}`;
-  let day = `${d.getDate()}`;
-  const year = d.getFullYear();
-
-  if (month.length < 2) month = `0${month}`;
-  if (day.length < 2) day = `0${day}`;
-
-  return [year, month, day].join("-");
-}
-
-export function formatHf(healthFactor: number): string {
-  return (healthFactor / 10000).toFixed(2);
-}
-
-export function formatLeverage(leverage: number, decimals: number = 2) {
-  return (leverage / LEVERAGE_DECIMALS).toFixed(decimals);
-}

package/src/utils/loading.ts

@@ -1,17 +0,0 @@
-const isLoaded = (v: unknown) => v !== undefined;
-
-export function allLoaded(itemsToLoad: Array<unknown>): boolean {
-  return itemsToLoad.reduce<boolean>(
-    (acc, item) => acc && isLoaded(item),
-    true
-  );
-}
-
-export function loadingProgress(itemsToLoad: Array<unknown>): number {
-  const loaded = itemsToLoad.reduce<number>(
-    (acc, item) => (isLoaded(item) ? acc + 1 : acc),
-    0
-  );
-
-  return Math.floor((loaded / itemsToLoad.length) * 100);
-}

package/src/utils/mappers.ts

@@ -1,32 +0,0 @@
-type SupportedValue = string | number;
-
-const objectEntries = <K extends SupportedValue, T>(
-  o: Record<K, T>
-): Array<[K, T]> => Object.entries(o) as Array<[K, T]>;
-
-const swapKeyValue = <K extends SupportedValue, T extends SupportedValue>(
-  o: Record<K, T>
-): Record<T, K> =>
-  objectEntries(o).reduce(
-    (acc, [key, value]) => ({ ...acc, [value]: key }),
-    {} as Record<T, K>
-  );
-
-const keyToLowercase = <K extends SupportedValue, T>(
-  o: Record<K, T>
-): Record<K, T> =>
-  objectEntries(o).reduce((acc, [key, value]) => {
-    const keyTransformed = typeof key === "string" ? key.toLowerCase() : key;
-    return { ...acc, [keyTransformed]: value };
-  }, {} as Record<K, T>);
-
-const filterEmptyKeys = <K extends SupportedValue, T>(
-  o: Record<K, T>
-): Record<K, T> =>
-  objectEntries(o).reduce(
-    (acc, [key, value]) => (key ? { ...acc, [key]: value } : acc),
-    {} as Record<K, T>
-  );
-
-export type { SupportedValue };
-export { objectEntries, swapKeyValue, keyToLowercase, filterEmptyKeys };

package/src/utils/math.ts

@@ -1,42 +0,0 @@
-import { BigNumber } from "ethers";
-import { halfRAY, PERCENTAGE_FACTOR, RAY } from "../core/constants";
-
-const ONE = BigNumber.from(1);
-const TWO = BigNumber.from(2);
-
-export function revertRay(num?: BigNumber): BigNumber | undefined {
-  if (!num) return undefined;
-  return RAY.mul(RAY).div(num);
-}
-
-export function rayMul(a: BigNumber, b: BigNumber): BigNumber {
-  if (a.isZero() || b.isZero()) {
-    return BigNumber.from(0);
-  }
-
-  return a.mul(b).add(halfRAY).div(RAY);
-}
-
-export function rayDiv(a: BigNumber, b: BigNumber): BigNumber {
-  const halfB = b.div(2);
-
-  return a.mul(RAY).add(halfB).div(b);
-}
-
-export function percentMul(a: BigNumber, b: number): BigNumber {
-  if (a.isZero() || b === 0) return BigNumber.from(0);
-  return a
-    .mul(b)
-    .add(PERCENTAGE_FACTOR / 2)
-    .div(PERCENTAGE_FACTOR);
-}
-
-export function sqrt(x: BigNumber) {
-  let z = x.add(ONE).div(TWO);
-  let y = x;
-  while (z.sub(y).isNegative()) {
-    y = z;
-    z = x.div(z).add(z).div(TWO);
-  }
-  return y;
-}

package/src/utils/multicall.ts

@@ -1,80 +0,0 @@
-import { ethers } from "ethers";
-import { MULTICALL_ADDRESS } from "../config";
-import { Multicall2, Multicall2__factory } from "../types";
-
-export interface CallData<T extends ethers.utils.Interface> {
-  method: keyof T["functions"];
-  params?: any;
-}
-
-export interface MCall<T extends ethers.utils.Interface> {
-  address: string;
-  interface: T;
-  method: keyof T["functions"];
-  params?: any;
-}
-
-export async function multicall<R extends Array<any>>(
-  calls: Array<MCall<any>>,
-  p: ethers.providers.Provider
-): Promise<R> {
-  const multiCallContract = Multicall2__factory.connect(MULTICALL_ADDRESS, p);
-
-  const { returnData } = await multiCallContract.callStatic.aggregate(
-    calls.map(c => ({
-      target: c.address,
-      callData: c.interface.encodeFunctionData(c.method as string, c.params)
-    }))
-  );
-
-  return returnData
-    .map((d, num) =>
-      calls[num].interface.decodeFunctionResult(calls[num].method as string, d)
-    )
-    .map(r => (Array.isArray(r) && r.length <= 1 ? r[0] : r)) as R;
-}
-
-export class MultiCallContract<T extends ethers.utils.Interface> {
-  private readonly _address: string;
-
-  private readonly _interface: T;
-
-  protected _multiCall: Multicall2;
-
-  constructor(
-    address: string,
-    intrerface: T,
-    provider: ethers.providers.Provider
-  ) {
-    this._address = address;
-    this._interface = intrerface;
-
-    this._multiCall = Multicall2__factory.connect(MULTICALL_ADDRESS, provider);
-  }
-
-  async call<R extends Array<any>>(data: Array<CallData<T>>): Promise<R> {
-    const { returnData } = await this._multiCall.callStatic.aggregate(
-      data.map(c => ({
-        target: this._address,
-        callData: this._interface.encodeFunctionData(
-          c.method as string,
-          c.params
-        )
-      }))
-    );
-
-    return returnData
-      .map((d, num) =>
-        this._interface.decodeFunctionResult(data[num].method as string, d)
-      )
-      .map(r => r[0]) as R;
-  }
-
-  get address(): string {
-    return this._address;
-  }
-
-  get interface(): T {
-    return this._interface;
-  }
-}

package/src/utils/network.ts

@@ -1,28 +0,0 @@
-import { ethers } from "ethers";
-import { tokenDataByNetwork } from "../tokens/token";
-import { ERC20__factory } from "../types";
-import { ADDRESS_0X0, NetworkType } from "../core/constants";
-
-export async function detectNetwork(
-  provider: ethers.providers.Provider
-): Promise<NetworkType> {
-  try {
-    const usdcMainnet = ERC20__factory.connect(
-      tokenDataByNetwork.Mainnet.USDC,
-      provider
-    );
-    await usdcMainnet.balanceOf(ADDRESS_0X0);
-    return "Mainnet";
-  } catch {
-    try {
-      const usdcMainnet = ERC20__factory.connect(
-        tokenDataByNetwork.Kovan.USDC,
-        provider
-      );
-      await usdcMainnet.balanceOf(ADDRESS_0X0);
-      return "Kovan";
-    } catch {
-      throw new Error("Unknown network");
-    }
-  }
-}

package/src/utils/price.ts

@@ -1,33 +0,0 @@
-import { BigNumber } from "ethers";
-import { WAD, PRICE_DECIMALS } from "../core/constants";
-
-export const calcTotalPrice = (
-  price: BigNumber,
-  amount: BigNumber,
-  decimals: number = 18
-) =>
-  amount
-    .mul(WAD)
-    .mul(price)
-    .div(BigNumber.from(10).pow(decimals))
-    .div(PRICE_DECIMALS);
-
-interface Target {
-  price: BigNumber;
-  decimals: number | undefined;
-}
-
-export function convertByPrice(
-  totalMoney: BigNumber,
-  { price: targetPrice, decimals: targetDecimals = 18 }: Target
-) {
-  const isWrongTargetPrice = targetPrice.isZero() || targetPrice.isNegative();
-
-  return isWrongTargetPrice
-    ? BigNumber.from(0)
-    : totalMoney
-        .mul(BigNumber.from(10).pow(targetDecimals))
-        .mul(PRICE_DECIMALS)
-        .div(targetPrice)
-        .div(WAD);
-}

package/src/utils/repeater.ts

@@ -1,18 +0,0 @@
-import { MetamaskError } from "../core/errors";
-
-export async function callRepeater<T>(
-  call: () => Promise<T>,
-  step: number = 0
-): Promise<T> {
-  return new Promise<T>((resolve, reject) => {
-    try {
-      call().then(r => resolve(r));
-    } catch (e) {
-      console.error(`Error ${step}: ${e}`);
-      if (step > 5 || (e as MetamaskError).code !== -32000) reject(e);
-      else {
-        setTimeout(() => resolve(callRepeater(call, step + 1)), 200);
-      }
-    }
-  });
-}

package/src/utils/types.ts

@@ -1,7 +0,0 @@
-export type PartialRecord<K extends keyof any, T> = {
-  [P in K]?: T;
-};
-
-export type AwaitedRes<T extends (...args: any) => any> = Awaited<
-  ReturnType<T>
->;

package/src/utils/validate.ts

@@ -1,8 +0,0 @@
-export function isPositiveFloat(val: string): boolean {
-  const floatRegex = /^\d+(?:[.,]\d*?)?$/;
-  if (!floatRegex.test(val)) return false;
-
-  const valF = parseFloat(val);
-  if (Number.isNaN(valF)) return false;
-  return true;
-}

package/tsconfig.json

@@ -1,62 +0,0 @@
-
-{
-  "compilerOptions": {
-    /* Basic Options */
-    "target": "es5",                       /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    "lib": ["dom", "dom.iterable", "esnext"],                           /* Specify library files to be included in the compilation. */
-    "allowJs": true,                          /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./lib/",                        /* Redirect output structure to the directory. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    //  "noEmit": true,                           /* Do not emit outputs. */
-    // "incremental": true,                   /* Enable incremental compilation */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    "isolatedModules": true,                  /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-     "strictNullChecks": true,              /* Enable strict null checks. */
-    "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    "noUnusedLocals": true,                /* Report errors on unused locals. */
-    "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    "resolveJsonModule": true,
-    "moduleResolution": "node",               /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    "baseUrl": "./",                          /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    "allowSyntheticDefaultImports": true,     /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    "skipLibCheck": true,
-    /* Source Map Options */
-    // "sourceRoot": "./",                    /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "./",                       /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-  },
-  "exclude": [
-    "node_modules", "jest.config.js", "lib", "babel.config.js"
-  ]
-}