@defisaver/automation-sdk 3.2.2 → 3.2.3

package/src/services/utils.ts

@@ -1,163 +1,163 @@
-import Dec from 'decimal.js';
-import * as web3Utils from 'web3-utils';
-import AbiCoder from 'web3-eth-abi';
-import { getAssetInfo, getAssetInfoByAddress } from '@defisaver/tokens';
-
-import type { EthereumAddress } from '../types';
-import {
-  ChainId, CloseStrategyType, CloseToAssetType, RatioState,
-} from '../types/enums';
-
-export function isDefined<T>(value: T): value is NonNullable<T> {
-  return value !== undefined && value !== null;
-}
-
-export function isUndefined(value: unknown): boolean {
-  return !isDefined(value);
-}
-
-export function compareAddresses(firstAddress: EthereumAddress, secondAddress: EthereumAddress): boolean {
-  return firstAddress.toLowerCase() === secondAddress.toLowerCase();
-}
-
-export function isAddress(address: EthereumAddress) {
-  return new RegExp(/0x[0-9a-fA-F]{40}/).test(address);
-}
-
-export function addToArrayIf(condition: boolean, ...items: any): Array<any> {
-  return (condition ? items : []);
-}
-
-export function addToObjectIf(condition: boolean, item: any): object {
-  return (condition ? item : {});
-}
-
-export function ethToWeth(maybeEth: string) {
-  return maybeEth?.replace(/^ETH$/, 'WETH');
-}
-
-export function wethToEth(maybeWeth: string) {
-  return maybeWeth?.replace(/^WETH$/, 'ETH');
-}
-
-export function wethToEthByAddress(maybeWethAddr: EthereumAddress, chainId: ChainId = ChainId.Ethereum): EthereumAddress {
-  return getAssetInfo(wethToEth(getAssetInfoByAddress(maybeWethAddr, chainId).symbol), chainId).address;
-}
-
-export function compareSubHashes(currentSubHash: string, newSubStructDecoded: object): boolean {
-  return currentSubHash === web3Utils.keccak256(AbiCoder.encodeParameter('(uint64,bool,bytes[],bytes32[])', newSubStructDecoded));
-}
-
-export function encodeSubId(subIdDec: string = '0') {
-  return new Dec(subIdDec).toHex().slice(2).padStart(8, '0');
-}
-
-export function ratioPercentageToWei(ratioPercentage: number) {
-  return web3Utils.toWei(new Dec(ratioPercentage).div(100).toString(), 'ether');
-}
-
-export function weiToRatioPercentage(ratioWei: string) {
-  return new Dec(web3Utils.fromWei(new Dec(ratioWei).mul(100).toString(), 'ether')).toNumber();
-}
-
-export function isRatioStateOver(ratioState: RatioState): boolean {
-  return ratioState === RatioState.OVER;
-}
-
-export function isRatioStateUnder(ratioState: RatioState): boolean {
-  return ratioState === RatioState.UNDER;
-}
-
-export function isEmptyBytes(string: string) {
-  return string === '0x0000000000000000000000000000000000000000';
-}
-
-export function requireAddress(address: EthereumAddress): void | never {
-  if (typeof address !== 'string') throw new Error('Address is not a string');
-  if (address === '') throw new Error('Address is empty string');
-  if (address.length < 42) throw new Error(`Address too short (${address.length} instead of 42)`);
-  if (isEmptyBytes(address)) throw new Error('Address is empty bytes');
-  if (!(new RegExp(/0x[0-9a-fA-F]{40}/).test(address))) throw new Error('Address invalid');
-}
-
-export function requireAddresses(addresses: EthereumAddress[]) {
-  addresses.forEach((address) => requireAddress(address));
-}
-
-export function getRatioStateInfoForAaveCloseStrategy(
-  currentRatioState: RatioState,
-  collAsset: EthereumAddress,
-  debtAsset: EthereumAddress,
-  chainId: ChainId,
-): { shouldFlip: boolean, ratioState: RatioState } {
-  // Flip only if stable/volatile to keep human-readable trigger price setting
-  const shouldFlip = getAssetInfoByAddress(collAsset, chainId).isStable && !getAssetInfoByAddress(debtAsset, chainId).isStable;
-  let ratioState = currentRatioState;
-  if (shouldFlip) {
-    ratioState = isRatioStateOver(currentRatioState)
-      ? ratioState = RatioState.UNDER
-      : ratioState = RatioState.OVER;
-  }
-  return { shouldFlip, ratioState };
-}
-
-export function getPositionId(...args: (number | string)[]) {
-  return args.map(arg => arg.toString().toLowerCase().split(' ').join('_')).join('-');
-}
-
-export function getCloseStrategyType(
-  stopLossPrice: number,
-  stopLossType: CloseToAssetType,
-  takeProfitPrice: number,
-  takeProfitType: CloseToAssetType,
-): CloseStrategyType {
-  const isStopLoss = stopLossPrice > 0;
-  const isTakeProfit = takeProfitPrice > 0;
-
-  if (!isStopLoss && !isTakeProfit) {
-    throw new Error('CloseOnPrice: At least one price must be defined');
-  }
-
-  if (isStopLoss && isTakeProfit) {
-    if (stopLossType === CloseToAssetType.COLLATERAL && takeProfitType === CloseToAssetType.COLLATERAL) {
-      return CloseStrategyType.TAKE_PROFIT_AND_STOP_LOSS_IN_COLLATERAL;
-    } if (stopLossType === CloseToAssetType.COLLATERAL) {
-      return CloseStrategyType.TAKE_PROFIT_IN_DEBT_AND_STOP_LOSS_IN_COLLATERAL;
-    } if (takeProfitType === CloseToAssetType.COLLATERAL) {
-      return CloseStrategyType.TAKE_PROFIT_IN_COLLATERAL_AND_STOP_LOSS_IN_DEBT;
-    }
-    return CloseStrategyType.TAKE_PROFIT_AND_STOP_LOSS_IN_DEBT;
-  } if (isStopLoss) {
-    return stopLossType === CloseToAssetType.COLLATERAL
-      ? CloseStrategyType.STOP_LOSS_IN_COLLATERAL
-      : CloseStrategyType.STOP_LOSS_IN_DEBT;
-  }
-  return takeProfitType === CloseToAssetType.COLLATERAL
-    ? CloseStrategyType.TAKE_PROFIT_IN_COLLATERAL
-    : CloseStrategyType.TAKE_PROFIT_IN_DEBT;
-}
-
-export function getStopLossAndTakeProfitTypeByCloseStrategyType(
-  closeStrategyType: CloseStrategyType,
-): { stopLossType: CloseToAssetType | undefined, takeProfitType: CloseToAssetType | undefined } {
-  switch (closeStrategyType) {
-    case CloseStrategyType.STOP_LOSS_IN_COLLATERAL:
-      return { stopLossType: CloseToAssetType.COLLATERAL, takeProfitType: undefined };
-    case CloseStrategyType.STOP_LOSS_IN_DEBT:
-      return { stopLossType: CloseToAssetType.DEBT, takeProfitType: undefined };
-    case CloseStrategyType.TAKE_PROFIT_IN_COLLATERAL:
-      return { stopLossType: undefined, takeProfitType: CloseToAssetType.COLLATERAL };
-    case CloseStrategyType.TAKE_PROFIT_IN_DEBT:
-      return { stopLossType: undefined, takeProfitType: CloseToAssetType.DEBT };
-    case CloseStrategyType.TAKE_PROFIT_IN_COLLATERAL_AND_STOP_LOSS_IN_DEBT:
-      return { stopLossType: CloseToAssetType.DEBT, takeProfitType: CloseToAssetType.COLLATERAL };
-    case CloseStrategyType.TAKE_PROFIT_IN_DEBT_AND_STOP_LOSS_IN_COLLATERAL:
-      return { stopLossType: CloseToAssetType.COLLATERAL, takeProfitType: CloseToAssetType.DEBT };
-    case CloseStrategyType.TAKE_PROFIT_AND_STOP_LOSS_IN_DEBT:
-      return { stopLossType: CloseToAssetType.DEBT, takeProfitType: CloseToAssetType.DEBT };
-    case CloseStrategyType.TAKE_PROFIT_AND_STOP_LOSS_IN_COLLATERAL:
-      return { stopLossType: CloseToAssetType.COLLATERAL, takeProfitType: CloseToAssetType.COLLATERAL };
-    default:
-      throw new Error('CloseStrategyType not supported');
-  }
+import Dec from 'decimal.js';
+import * as web3Utils from 'web3-utils';
+import AbiCoder from 'web3-eth-abi';
+import { getAssetInfo, getAssetInfoByAddress } from '@defisaver/tokens';
+
+import type { EthereumAddress } from '../types';
+import {
+  ChainId, CloseStrategyType, CloseToAssetType, RatioState,
+} from '../types/enums';
+
+export function isDefined<T>(value: T): value is NonNullable<T> {
+  return value !== undefined && value !== null;
+}
+
+export function isUndefined(value: unknown): boolean {
+  return !isDefined(value);
+}
+
+export function compareAddresses(firstAddress: EthereumAddress, secondAddress: EthereumAddress): boolean {
+  return firstAddress.toLowerCase() === secondAddress.toLowerCase();
+}
+
+export function isAddress(address: EthereumAddress) {
+  return new RegExp(/0x[0-9a-fA-F]{40}/).test(address);
+}
+
+export function addToArrayIf(condition: boolean, ...items: any): Array<any> {
+  return (condition ? items : []);
+}
+
+export function addToObjectIf(condition: boolean, item: any): object {
+  return (condition ? item : {});
+}
+
+export function ethToWeth(maybeEth: string) {
+  return maybeEth?.replace(/^ETH$/, 'WETH');
+}
+
+export function wethToEth(maybeWeth: string) {
+  return maybeWeth?.replace(/^WETH$/, 'ETH');
+}
+
+export function wethToEthByAddress(maybeWethAddr: EthereumAddress, chainId: ChainId = ChainId.Ethereum): EthereumAddress {
+  return getAssetInfo(wethToEth(getAssetInfoByAddress(maybeWethAddr, chainId).symbol), chainId).address;
+}
+
+export function compareSubHashes(currentSubHash: string, newSubStructDecoded: object): boolean {
+  return currentSubHash === web3Utils.keccak256(AbiCoder.encodeParameter('(uint64,bool,bytes[],bytes32[])', newSubStructDecoded));
+}
+
+export function encodeSubId(subIdDec: string = '0') {
+  return new Dec(subIdDec).toHex().slice(2).padStart(8, '0');
+}
+
+export function ratioPercentageToWei(ratioPercentage: number) {
+  return web3Utils.toWei(new Dec(ratioPercentage).div(100).toString(), 'ether');
+}
+
+export function weiToRatioPercentage(ratioWei: string) {
+  return new Dec(web3Utils.fromWei(new Dec(ratioWei).mul(100).toString(), 'ether')).toNumber();
+}
+
+export function isRatioStateOver(ratioState: RatioState): boolean {
+  return ratioState === RatioState.OVER;
+}
+
+export function isRatioStateUnder(ratioState: RatioState): boolean {
+  return ratioState === RatioState.UNDER;
+}
+
+export function isEmptyBytes(string: string) {
+  return string === '0x0000000000000000000000000000000000000000';
+}
+
+export function requireAddress(address: EthereumAddress): void | never {
+  if (typeof address !== 'string') throw new Error('Address is not a string');
+  if (address === '') throw new Error('Address is empty string');
+  if (address.length < 42) throw new Error(`Address too short (${address.length} instead of 42)`);
+  if (isEmptyBytes(address)) throw new Error('Address is empty bytes');
+  if (!(new RegExp(/0x[0-9a-fA-F]{40}/).test(address))) throw new Error('Address invalid');
+}
+
+export function requireAddresses(addresses: EthereumAddress[]) {
+  addresses.forEach((address) => requireAddress(address));
+}
+
+export function getRatioStateInfoForAaveCloseStrategy(
+  currentRatioState: RatioState,
+  collAsset: EthereumAddress,
+  debtAsset: EthereumAddress,
+  chainId: ChainId,
+): { shouldFlip: boolean, ratioState: RatioState } {
+  // Flip only if stable/volatile to keep human-readable trigger price setting
+  const shouldFlip = getAssetInfoByAddress(collAsset, chainId).isStable && !getAssetInfoByAddress(debtAsset, chainId).isStable;
+  let ratioState = currentRatioState;
+  if (shouldFlip) {
+    ratioState = isRatioStateOver(currentRatioState)
+      ? ratioState = RatioState.UNDER
+      : ratioState = RatioState.OVER;
+  }
+  return { shouldFlip, ratioState };
+}
+
+export function getPositionId(...args: (number | string)[]) {
+  return args.map(arg => arg.toString().toLowerCase().split(' ').join('_')).join('-');
+}
+
+export function getCloseStrategyType(
+  stopLossPrice: number,
+  stopLossType: CloseToAssetType,
+  takeProfitPrice: number,
+  takeProfitType: CloseToAssetType,
+): CloseStrategyType {
+  const isStopLoss = stopLossPrice > 0;
+  const isTakeProfit = takeProfitPrice > 0;
+
+  if (!isStopLoss && !isTakeProfit) {
+    throw new Error('CloseOnPrice: At least one price must be defined');
+  }
+
+  if (isStopLoss && isTakeProfit) {
+    if (stopLossType === CloseToAssetType.COLLATERAL && takeProfitType === CloseToAssetType.COLLATERAL) {
+      return CloseStrategyType.TAKE_PROFIT_AND_STOP_LOSS_IN_COLLATERAL;
+    } if (stopLossType === CloseToAssetType.COLLATERAL) {
+      return CloseStrategyType.TAKE_PROFIT_IN_DEBT_AND_STOP_LOSS_IN_COLLATERAL;
+    } if (takeProfitType === CloseToAssetType.COLLATERAL) {
+      return CloseStrategyType.TAKE_PROFIT_IN_COLLATERAL_AND_STOP_LOSS_IN_DEBT;
+    }
+    return CloseStrategyType.TAKE_PROFIT_AND_STOP_LOSS_IN_DEBT;
+  } if (isStopLoss) {
+    return stopLossType === CloseToAssetType.COLLATERAL
+      ? CloseStrategyType.STOP_LOSS_IN_COLLATERAL
+      : CloseStrategyType.STOP_LOSS_IN_DEBT;
+  }
+  return takeProfitType === CloseToAssetType.COLLATERAL
+    ? CloseStrategyType.TAKE_PROFIT_IN_COLLATERAL
+    : CloseStrategyType.TAKE_PROFIT_IN_DEBT;
+}
+
+export function getStopLossAndTakeProfitTypeByCloseStrategyType(
+  closeStrategyType: CloseStrategyType,
+): { stopLossType: CloseToAssetType | undefined, takeProfitType: CloseToAssetType | undefined } {
+  switch (closeStrategyType) {
+    case CloseStrategyType.STOP_LOSS_IN_COLLATERAL:
+      return { stopLossType: CloseToAssetType.COLLATERAL, takeProfitType: undefined };
+    case CloseStrategyType.STOP_LOSS_IN_DEBT:
+      return { stopLossType: CloseToAssetType.DEBT, takeProfitType: undefined };
+    case CloseStrategyType.TAKE_PROFIT_IN_COLLATERAL:
+      return { stopLossType: undefined, takeProfitType: CloseToAssetType.COLLATERAL };
+    case CloseStrategyType.TAKE_PROFIT_IN_DEBT:
+      return { stopLossType: undefined, takeProfitType: CloseToAssetType.DEBT };
+    case CloseStrategyType.TAKE_PROFIT_IN_COLLATERAL_AND_STOP_LOSS_IN_DEBT:
+      return { stopLossType: CloseToAssetType.DEBT, takeProfitType: CloseToAssetType.COLLATERAL };
+    case CloseStrategyType.TAKE_PROFIT_IN_DEBT_AND_STOP_LOSS_IN_COLLATERAL:
+      return { stopLossType: CloseToAssetType.COLLATERAL, takeProfitType: CloseToAssetType.DEBT };
+    case CloseStrategyType.TAKE_PROFIT_AND_STOP_LOSS_IN_DEBT:
+      return { stopLossType: CloseToAssetType.DEBT, takeProfitType: CloseToAssetType.DEBT };
+    case CloseStrategyType.TAKE_PROFIT_AND_STOP_LOSS_IN_COLLATERAL:
+      return { stopLossType: CloseToAssetType.COLLATERAL, takeProfitType: CloseToAssetType.COLLATERAL };
+    default:
+      throw new Error('CloseStrategyType not supported');
+  }
 }