@defisaver/automation-sdk 3.0.4 → 3.0.5

package/src/services/utils.ts

@@ -1,104 +1,104 @@
-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, 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('-');
+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, 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('-');
 }

package/src/types/enums.ts

@@ -1,172 +1,174 @@
-export enum ChainId {
-  Ethereum = 1,
-  Optimism = 10,
-  Arbitrum = 42161,
-}
-
-export enum RatioState {
-  OVER = 0,
-  UNDER = 1,
-}
-
-export enum OrderType {
-  TAKE_PROFIT = 0,
-  STOP_LOSS = 1,
-}
-
-export enum BundleProtocols {
-  MStable = 'mstable',
-  Yearn = 'yearn',
-  Rari = 'rari',
-}
-
-/**
- * @dev Follow the naming convention:
- *      - Enum name consists of two parts, name and version
- *      - Name should be human-readable name of the protocol, it can include spaces or any characters needed
- *      - Version should be separated from the name with double underscores `__` (If there is no version leave it out)
- *      - Example `Name of ThePROTOCOL__v1` (Without version `Name of ThePROTOCOL`)
- */
-export namespace ProtocolIdentifiers {
-  export enum StrategiesAutomation {
-    MakerDAO = 'MakerDAO',
-    Liquity = 'Liquity',
-    ChickenBonds = 'Chicken Bonds',
-    CompoundV2 = 'Compound__V2',
-    CompoundV3 = 'Compound__V3',
-    AaveV2 = 'Aave__V2',
-    AaveV3 = 'Aave__V3',
-    MorphoAaveV2 = 'Morpho-Aave__V2',
-    Exchange = 'Exchange',
-    Spark = 'Spark',
-    CrvUSD = 'CurveUSD',
-    MorphoBlue = 'MorphoBlue',
-  }
-
-  export enum LegacyAutomation {
-    MakerDAO = 'MakerDAO',
-    CompoundV2 = 'Compound__V2',
-    AaveV2 = 'Aave__V2',
-  }
-}
-
-export namespace Strategies {
-  export enum MainnetIds {
-    MAKER_CLOSE_ON_PRICE_TO_DAI = 7,
-    MAKER_CLOSE_ON_PRICE_TO_COLL = 9,
-    LIQUITY_CLOSE_ON_PRICE_TO_COLL_DEPRECATED = 10, // replaced with 14
-    MAKER_TRAILING_STOP_LOSS_TO_COLL = 11,
-    MAKER_TRAILING_STOP_LOSS_TO_DAI = 12,
-    LIQUITY_TRAILING_STOP_LOSS_TO_COLL = 13,
-    LIQUITY_CLOSE_ON_PRICE_TO_COLL = 14,
-    CHICKEN_BONDS_REBOND = 31,
-    EXCHANGE_DCA = 46,
-    EXCHANGE_LIMIT_ORDER = 51,
-    LIQUITY_DSR_PAYBACK = 69,
-    LIQUITY_DSR_SUPPLY = 70,
-    LIQUITY_DEBT_IN_FRONT_REPAY = 75,
-    CURVEUSD_PAYBACK = 92,
-  }
-
-  export enum OptimismIds {
-    EXCHANGE_DCA = 8,
-    EXCHANGE_LIMIT_ORDER = 9,
-  }
-
-  export enum ArbitrumIds {
-    EXCHANGE_DCA = 8,
-    EXCHANGE_LIMIT_ORDER = 9,
-  }
-
-  export enum Identifiers {
-    SavingsLiqProtection = 'smart-savings-liquidation-protection',
-    SavingsDsrPayback = 'smart-savings-dsr-payback',
-    SavingsDsrSupply = 'smart-savings-dsr-supply',
-    Repay = 'repay',
-    EoaRepay = 'eoa-repay',
-    Boost = 'boost',
-    EoaBoost = 'eoa-boost',
-    CloseToDebt = 'close-to-debt',
-    CloseToDebtWithGasPrice = 'close-to-debt-with-gas-price',
-    CloseToCollateral = 'close-to-collateral',
-    CloseToCollateralWithGasPrice = 'close-to-collateral-with-gas-price',
-    CloseOnPriceToDebt = 'close-on-price-to-debt',
-    CloseOnPriceToColl = 'close-on-price-to-collateral',
-    TrailingStopToColl = 'trailing-stop-to-collateral',
-    TrailingStopToDebt = 'trailing-stop-to-debt',
-    Rebond = 'rebond',
-    Payback = 'payback',
-    BondProtection = 'bond-protection',
-    Dca = 'dca',
-    LimitOrder = 'limit-order',
-    DebtInFrontRepay = 'debt-in-front-repay',
-  }
-  export enum IdOverrides {
-    TakeProfit = 'take-profit',
-    StopLoss = 'stop-loss',
-    TakeProfitWithGasPrice = 'take-profit-with-gas-price',
-    StopLossWithGasPrice = 'stop-loss-with-gas-price',
-    TrailingStop = 'trailing-stop',
-    LeverageManagement = 'leverage-management',
-    EoaLeverageManagement = 'leverage-management-eoa',
-  }
-}
-
-export namespace Bundles {
-  export enum MainnetIds {
-    MAKER_REPAY_FROM_SMART_SAVINGS_YEARN = 0,
-    MAKER_REPAY_FROM_SMART_SAVINGS_MSTABLE = 1,
-    MAKER_REPAY_FROM_SMART_SAVINGS_RARI = 2,
-    COMP_V3_SW_REPAY_BUNDLE = 3,
-    COMP_V3_SW_BOOST_BUNDLE = 4,
-    COMP_V3_EOA_REPAY_BUNDLE = 5,
-    COMP_V3_EOA_BOOST_BUNDLE = 6,
-    LIQUITY_PAYBACK_USING_CHICKEN_BOND = 7,
-    AAVE_V3_REPAY = 8,
-    AAVE_V3_BOOST = 9,
-    MAKER_REPAY = 10,
-    MAKER_BOOST = 11,
-    AAVE_V3_CLOSE_TO_DEBT = 12,
-    AAVE_V3_CLOSE_TO_DEBT_WITH_GAS_PRICE = 24,
-    AAVE_V3_CLOSE_TO_COLLATERAL = 13,
-    AAVE_V3_CLOSE_TO_COLLATERAL_WITH_GAS_PRICE = 25,
-    MORPHO_AAVE_V2_REPAY = 14,
-    MORPHO_AAVE_V2_BOOST = 15,
-    LIQUITY_REPAY = 16,
-    LIQUITY_BOOST = 17,
-    SPARK_REPAY = 18,
-    SPARK_BOOST = 19,
-    SPARK_CLOSE_TO_DEBT = -21231230, // @dev This was never deployed
-    SPARK_CLOSE_TO_COLLATERAL = -21231231, // @dev This was never deployed
-    AAVE_V2_REPAY = 22,
-    AAVE_V2_BOOST = 23,
-    COMP_V2_REPAY = 20,
-    COMP_V2_BOOST = 21,
-    CRVUSD_REPAY = 26,
-    CRVUSD_BOOST = 27,
-    COMP_V3_SW_REPAY_V2_BUNDLE = 28,
-    COMP_V3_SW_BOOST_V2_BUNDLE = 29,
-    COMP_V3_EOA_REPAY_V2_BUNDLE = 30,
-    COMP_V3_EOA_BOOST_V2_BUNDLE = 31,
-    MORPHO_BLUE_REPAY = 32,
-    MORPHO_BLUE_BOOST = 33,
-  }
-
-  export enum OptimismIds {
-    AAVE_V3_REPAY = 0,
-    AAVE_V3_BOOST = 1,
-    AAVE_V3_CLOSE_TO_DEBT = 2,
-    AAVE_V3_CLOSE_TO_COLLATERAL = 3,
-  }
-
-  export enum ArbitrumIds {
-    AAVE_V3_REPAY = 0,
-    AAVE_V3_BOOST = 1,
-    AAVE_V3_CLOSE_TO_DEBT = 2,
-    AAVE_V3_CLOSE_TO_COLLATERAL = 3,
-    COMP_V3_SW_REPAY_BUNDLE = 4,
-    COMP_V3_SW_BOOST_BUNDLE = 5,
-  }
-}
-
-
+export enum ChainId {
+  Ethereum = 1,
+  Optimism = 10,
+  Arbitrum = 42161,
+}
+
+export enum RatioState {
+  OVER = 0,
+  UNDER = 1,
+}
+
+export enum OrderType {
+  TAKE_PROFIT = 0,
+  STOP_LOSS = 1,
+}
+
+export enum BundleProtocols {
+  MStable = 'mstable',
+  Yearn = 'yearn',
+  Rari = 'rari',
+}
+
+/**
+ * @dev Follow the naming convention:
+ *      - Enum name consists of two parts, name and version
+ *      - Name should be human-readable name of the protocol, it can include spaces or any characters needed
+ *      - Version should be separated from the name with double underscores `__` (If there is no version leave it out)
+ *      - Example `Name of ThePROTOCOL__v1` (Without version `Name of ThePROTOCOL`)
+ */
+export namespace ProtocolIdentifiers {
+  export enum StrategiesAutomation {
+    MakerDAO = 'MakerDAO',
+    Liquity = 'Liquity',
+    ChickenBonds = 'Chicken Bonds',
+    CompoundV2 = 'Compound__V2',
+    CompoundV3 = 'Compound__V3',
+    AaveV2 = 'Aave__V2',
+    AaveV3 = 'Aave__V3',
+    MorphoAaveV2 = 'Morpho-Aave__V2',
+    Exchange = 'Exchange',
+    Spark = 'Spark',
+    CrvUSD = 'CurveUSD',
+    MorphoBlue = 'MorphoBlue',
+  }
+
+  export enum LegacyAutomation {
+    MakerDAO = 'MakerDAO',
+    CompoundV2 = 'Compound__V2',
+    AaveV2 = 'Aave__V2',
+  }
+}
+
+export namespace Strategies {
+  export enum MainnetIds {
+    MAKER_CLOSE_ON_PRICE_TO_DAI = 7,
+    MAKER_CLOSE_ON_PRICE_TO_COLL = 9,
+    LIQUITY_CLOSE_ON_PRICE_TO_COLL_DEPRECATED = 10, // replaced with 14
+    MAKER_TRAILING_STOP_LOSS_TO_COLL = 11,
+    MAKER_TRAILING_STOP_LOSS_TO_DAI = 12,
+    LIQUITY_TRAILING_STOP_LOSS_TO_COLL = 13,
+    LIQUITY_CLOSE_ON_PRICE_TO_COLL = 14,
+    CHICKEN_BONDS_REBOND = 31,
+    EXCHANGE_DCA = 46,
+    EXCHANGE_LIMIT_ORDER = 51,
+    LIQUITY_DSR_PAYBACK = 69,
+    LIQUITY_DSR_SUPPLY = 70,
+    LIQUITY_DEBT_IN_FRONT_REPAY = 75,
+    CURVEUSD_PAYBACK = 92,
+  }
+
+  export enum OptimismIds {
+    EXCHANGE_DCA = 8,
+    EXCHANGE_LIMIT_ORDER = 9,
+  }
+
+  export enum ArbitrumIds {
+    EXCHANGE_DCA = 8,
+    EXCHANGE_LIMIT_ORDER = 9,
+  }
+
+  export enum Identifiers {
+    SavingsLiqProtection = 'smart-savings-liquidation-protection',
+    SavingsDsrPayback = 'smart-savings-dsr-payback',
+    SavingsDsrSupply = 'smart-savings-dsr-supply',
+    Repay = 'repay',
+    EoaRepay = 'eoa-repay',
+    Boost = 'boost',
+    EoaBoost = 'eoa-boost',
+    CloseToDebt = 'close-to-debt',
+    CloseToDebtWithGasPrice = 'close-to-debt-with-gas-price',
+    CloseToCollateral = 'close-to-collateral',
+    CloseToCollateralWithGasPrice = 'close-to-collateral-with-gas-price',
+    CloseOnPriceToDebt = 'close-on-price-to-debt',
+    CloseOnPriceToColl = 'close-on-price-to-collateral',
+    TrailingStopToColl = 'trailing-stop-to-collateral',
+    TrailingStopToDebt = 'trailing-stop-to-debt',
+    Rebond = 'rebond',
+    Payback = 'payback',
+    BondProtection = 'bond-protection',
+    Dca = 'dca',
+    LimitOrder = 'limit-order',
+    DebtInFrontRepay = 'debt-in-front-repay',
+  }
+  export enum IdOverrides {
+    TakeProfit = 'take-profit',
+    StopLoss = 'stop-loss',
+    TakeProfitWithGasPrice = 'take-profit-with-gas-price',
+    StopLossWithGasPrice = 'stop-loss-with-gas-price',
+    TrailingStop = 'trailing-stop',
+    LeverageManagement = 'leverage-management',
+    EoaLeverageManagement = 'leverage-management-eoa',
+  }
+}
+
+export namespace Bundles {
+  export enum MainnetIds {
+    MAKER_REPAY_FROM_SMART_SAVINGS_YEARN = 0,
+    MAKER_REPAY_FROM_SMART_SAVINGS_MSTABLE = 1,
+    MAKER_REPAY_FROM_SMART_SAVINGS_RARI = 2,
+    COMP_V3_SW_REPAY_BUNDLE = 3,
+    COMP_V3_SW_BOOST_BUNDLE = 4,
+    COMP_V3_EOA_REPAY_BUNDLE = 5,
+    COMP_V3_EOA_BOOST_BUNDLE = 6,
+    LIQUITY_PAYBACK_USING_CHICKEN_BOND = 7,
+    AAVE_V3_REPAY = 8,
+    AAVE_V3_BOOST = 9,
+    MAKER_REPAY = 10,
+    MAKER_BOOST = 11,
+    AAVE_V3_CLOSE_TO_DEBT = 12,
+    AAVE_V3_CLOSE_TO_DEBT_WITH_GAS_PRICE = 24,
+    AAVE_V3_CLOSE_TO_COLLATERAL = 13,
+    AAVE_V3_CLOSE_TO_COLLATERAL_WITH_GAS_PRICE = 25,
+    MORPHO_AAVE_V2_REPAY = 14,
+    MORPHO_AAVE_V2_BOOST = 15,
+    LIQUITY_REPAY = 16,
+    LIQUITY_BOOST = 17,
+    SPARK_REPAY = 18,
+    SPARK_BOOST = 19,
+    SPARK_CLOSE_TO_DEBT = -21231230, // @dev This was never deployed
+    SPARK_CLOSE_TO_COLLATERAL = -21231231, // @dev This was never deployed
+    AAVE_V2_REPAY = 22,
+    AAVE_V2_BOOST = 23,
+    COMP_V2_REPAY = 20,
+    COMP_V2_BOOST = 21,
+    CRVUSD_REPAY = 26,
+    CRVUSD_BOOST = 27,
+    COMP_V3_SW_REPAY_V2_BUNDLE = 28,
+    COMP_V3_SW_BOOST_V2_BUNDLE = 29,
+    COMP_V3_EOA_REPAY_V2_BUNDLE = 30,
+    COMP_V3_EOA_BOOST_V2_BUNDLE = 31,
+    MORPHO_BLUE_REPAY = 32,
+    MORPHO_BLUE_BOOST = 33,
+    MORPHO_BLUE_EOA_REPAY = 34,
+    MORPHO_BLUE_EOA_BOOST = 35,
+  }
+
+  export enum OptimismIds {
+    AAVE_V3_REPAY = 0,
+    AAVE_V3_BOOST = 1,
+    AAVE_V3_CLOSE_TO_DEBT = 2,
+    AAVE_V3_CLOSE_TO_COLLATERAL = 3,
+  }
+
+  export enum ArbitrumIds {
+    AAVE_V3_REPAY = 0,
+    AAVE_V3_BOOST = 1,
+    AAVE_V3_CLOSE_TO_DEBT = 2,
+    AAVE_V3_CLOSE_TO_COLLATERAL = 3,
+    COMP_V3_SW_REPAY_BUNDLE = 4,
+    COMP_V3_SW_BOOST_BUNDLE = 5,
+  }
+}
+
+