@defisaver/automation-sdk 3.3.10 → 3.3.11

package/src/services/strategySubService.test.ts

@@ -21,6 +21,7 @@ import {
   crvUSDEncode,
   compoundV3L2Encode,
   morphoBlueEncode,
+  sparkEncode,
 } from './strategySubService';
 
 describe('Feature: strategySubService.ts', () => {
@@ -1730,4 +1731,165 @@ describe('Feature: strategySubService.ts', () => {
       });
     });
   });
+
+  describe('When testing strategySubService.sparkEncode', () => {
+    describe('leverageManagement()', () => {
+      const examples: Array<[string, [number, number, number, number, boolean]]> = [
+        [
+          '0x0000000000000000136dcc951d8c00000000000000000000214e8348c4f0000000000000000000001d24b2dfac52000000000000000000001a5e27eef13e000001',
+          [140,240,210,190,true]
+        ],
+        [
+          '0x0000000000000000130337bdce49000000000000000000001988fe4052b800000000000000000000281b57b028e1000000000000000000002223acf76376000000',
+          [137, 184, 289, 246, false]
+        ]
+      ];
+
+      examples.forEach(([expected, actual]) => {
+        it(`Given ${actual} should return expected value: ${JSON.stringify(expected)}`, () => {
+          expect(sparkEncode.leverageManagement(...actual)).to.eql(expected);
+        });
+      });
+    });
+
+    describe('leverageManagementOnPrice()', () => {
+      const examples: Array<[[StrategyOrBundleIds, boolean, TriggerData, SubData], 
+      [
+        strategyOrBundleId: number, 
+        isBundle: boolean, 
+        triggerData: { baseTokenAddr: EthereumAddress, quoteTokenAddr: EthereumAddress, price: number, ratioState: RatioState }, 
+        subData: { collAsset: EthereumAddress, collAssetId: number, debtAsset: EthereumAddress, debtAssetId: number, marketAddr: EthereumAddress, targetRatio: number }
+      ]]> = [
+        [
+          [
+            Bundles.MainnetIds.SPARK_REPAY_ON_PRICE,
+            true,
+            ['0x000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb480000000000000000000000000000000000000000000000000000003a352944000000000000000000000000000000000000000000000000000000000000000001'],
+            ['0x000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+             '0x0000000000000000000000000000000000000000000000000000000000000000',
+             '0x000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+             '0x0000000000000000000000000000000000000000000000000000000000000001',
+             '0x00000000000000000000000002c3ea4e34c0cbd694d2adfa2c690eecbc1793ee',
+             '0x0000000000000000000000000000000000000000000000001bc16d674ec80000',
+             '0x0000000000000000000000000000000000000000000000000000000000000000',
+            ],
+          ],
+          [
+            59,
+            true,
+            {
+              baseTokenAddr: web3Utils.toChecksumAddress(getAssetInfo('WETH', ChainId.Ethereum).address),
+              quoteTokenAddr: web3Utils.toChecksumAddress(getAssetInfo('USDC', ChainId.Ethereum).address),
+              price: 2500,
+              ratioState: RatioState.UNDER,
+            },
+            {
+              collAsset: web3Utils.toChecksumAddress(getAssetInfo('WETH', ChainId.Ethereum).address),
+              collAssetId: 0,
+              debtAsset: web3Utils.toChecksumAddress(getAssetInfo('USDC', ChainId.Ethereum).address),
+              debtAssetId: 1,
+              marketAddr: web3Utils.toChecksumAddress('0x02C3eA4e34C0cBd694D2adFa2c690EECbC1793eE'),
+              targetRatio: 200,
+            },
+          ]
+        ],
+        [
+          [
+            Bundles.MainnetIds.SPARK_BOOST_ON_PRICE,
+            true,
+            ['0x0000000000000000000000002260fac5e5542a773aa44fbcfedf7c193bc2c5990000000000000000000000006b175474e89094c44da98b954eedeac495271d0f00000000000000000000000000000000000000000000000000000417bce6c8000000000000000000000000000000000000000000000000000000000000000000'],
+            [
+              '0x0000000000000000000000002260fac5e5542a773aa44fbcfedf7c193bc2c599',
+              '0x0000000000000000000000000000000000000000000000000000000000000002',
+              '0x0000000000000000000000006b175474e89094c44da98b954eedeac495271d0f',
+              '0x0000000000000000000000000000000000000000000000000000000000000004',
+              '0x00000000000000000000000002c3ea4e34c0cbd694d2adfa2c690eecbc1793ee',
+              '0x00000000000000000000000000000000000000000000000022b1c8c1227a0000',
+              '0x0000000000000000000000000000000000000000000000000000000000000000',
+            ]
+          ],
+          [
+            60,
+            true,
+            {
+              baseTokenAddr: web3Utils.toChecksumAddress(getAssetInfo('WBTC', ChainId.Ethereum).address),
+              quoteTokenAddr: web3Utils.toChecksumAddress(getAssetInfo('DAI', ChainId.Ethereum).address),
+              price: 45000,
+              ratioState: RatioState.OVER,
+            },
+            {
+              collAsset: web3Utils.toChecksumAddress(getAssetInfo('WBTC', ChainId.Ethereum).address),
+              collAssetId: 2,
+              debtAsset: web3Utils.toChecksumAddress(getAssetInfo('DAI', ChainId.Ethereum).address),
+              debtAssetId: 4,
+              marketAddr: web3Utils.toChecksumAddress('0x02C3eA4e34C0cBd694D2adFa2c690EECbC1793eE'),
+              targetRatio: 250,
+            },
+          ]
+        ]
+      ];
+
+      examples.forEach(([expected, actual]) => {
+        it(`Given ${actual} should return expected value: ${JSON.stringify(expected)}`, () => {
+          expect(sparkEncode.leverageManagementOnPrice(...actual)).to.eql(expected);
+        });
+      });
+    });
+
+    describe('closeOnPrice()', () => {
+      const examples: Array<[
+        [StrategyOrBundleIds, boolean, TriggerData, SubData],
+        [
+          strategyOrBundleId: number,
+          collAsset: EthereumAddress,
+          collAssetId: number,
+          debtAsset: EthereumAddress,
+          debtAssetId: number,
+          marketAddr: EthereumAddress,
+          user: EthereumAddress,
+          stopLossPrice: number,
+          stopLossType: CloseToAssetType,
+          takeProfitPrice: number,
+          takeProfitType: CloseToAssetType,
+        ]
+      ] > = 
+      [
+        [
+          [
+            Bundles.MainnetIds.SPARK_CLOSE,
+            true,
+            ['0x0000000000000000000000002260fac5e5542a773aa44fbcfedf7c193bc2c5990000000000000000000000006b175474e89094c44da98b954eedeac495271d0f000000000000000000000000000000000000000000000000000003a35294400000000000000000000000000000000000000000000000000000000574fbde6000'],
+            [
+              '0x0000000000000000000000002260fac5e5542a773aa44fbcfedf7c193bc2c599',
+              '0x0000000000000000000000000000000000000000000000000000000000000002',
+              '0x0000000000000000000000006b175474e89094c44da98b954eedeac495271d0f',
+              '0x0000000000000000000000000000000000000000000000000000000000000004',
+              '0x0000000000000000000000000000000000000000000000000000000000000005',
+              '0x00000000000000000000000002c3ea4e34c0cbd694d2adfa2c690eecbc1793ee',
+              '0x0000000000000000000000001234567890123456789012345678901234567890',
+            ]
+          ],
+          [
+            57,
+            web3Utils.toChecksumAddress(getAssetInfo('WBTC', ChainId.Ethereum).address),
+            2,
+            web3Utils.toChecksumAddress(getAssetInfo('DAI', ChainId.Ethereum).address),
+            4,
+            web3Utils.toChecksumAddress('0x02C3eA4e34C0cBd694D2adFa2c690EECbC1793eE'),
+            web3Utils.toChecksumAddress('0x1234567890123456789012345678901234567890'),
+            40000,
+            CloseToAssetType.DEBT,
+            60000,
+            CloseToAssetType.COLLATERAL,
+          ]
+        ],
+      ]
+
+      examples.forEach(([expected, actual]) => {
+        it(`Given ${actual} should return expected value: ${JSON.stringify(expected)}`, () => {
+          expect(sparkEncode.closeOnPriceGeneric(...actual)).to.eql(expected);
+        });
+      });
+    });
+  });
 });

package/src/services/strategySubService.ts

@@ -581,6 +581,28 @@ export const sparkEncode = {
 
     return subInput;
   },
+  leverageManagementOnPrice(
+    strategyOrBundleId: number,
+    isBundle: boolean = true,
+    triggerData: {
+      baseTokenAddr: EthereumAddress, quoteTokenAddr: EthereumAddress, price: number, ratioState: RatioState
+    },
+    subData: {
+      collAsset: EthereumAddress, collAssetId: number, debtAsset: EthereumAddress, debtAssetId: number, marketAddr: EthereumAddress, targetRatio: number,
+    },
+  ) {
+    const {
+      collAsset, collAssetId, debtAsset, debtAssetId, marketAddr, targetRatio,
+    } = subData;
+    const subDataEncoded = subDataService.sparkLeverageManagementOnPriceSubData.encode(collAsset, collAssetId, debtAsset, debtAssetId, marketAddr, targetRatio);
+
+    const {
+      baseTokenAddr, quoteTokenAddr, price, ratioState,
+    } = triggerData;
+    const triggerDataEncoded = triggerService.sparkQuotePriceTrigger.encode(baseTokenAddr, quoteTokenAddr, price, ratioState);
+
+    return [strategyOrBundleId, isBundle, triggerDataEncoded, subDataEncoded];
+  },
   closeOnPriceGeneric(
     strategyOrBundleId: number,
     collAsset: EthereumAddress,

package/src/services/subDataService.test.ts

@@ -2263,4 +2263,71 @@ describe('Feature: subDataService.ts', () => {
       });
     });
   });
+  describe('When testing subDataService.sparkLeverageManagementOnPriceSubData', () => {
+    describe('encode()', () => {
+      const examples: Array<[SubData, [collAsset: EthereumAddress, collAssetId: number, debtAsset: EthereumAddress, debtAssetId: number, marketAddr: EthereumAddress, targetRatio: number]] > = 
+      [
+        [
+          [
+            '0x000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2',
+            '0x0000000000000000000000000000000000000000000000000000000000000000',
+            '0x000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+            '0x0000000000000000000000000000000000000000000000000000000000000001',
+            '0x00000000000000000000000002c3ea4e34c0cbd694d2adfa2c690eecbc1793ee',
+            '0x0000000000000000000000000000000000000000000000001bc16d674ec80000',
+            '0x0000000000000000000000000000000000000000000000000000000000000000',
+          ],
+          [
+            web3Utils.toChecksumAddress(getAssetInfo('WETH', ChainId.Ethereum).address),
+            0,
+            web3Utils.toChecksumAddress(getAssetInfo('USDC', ChainId.Ethereum).address),
+            1,
+            web3Utils.toChecksumAddress('0x02C3eA4e34C0cBd694D2adFa2c690EECbC1793eE'),
+            200,
+          ]
+        ]
+      ];
+
+      examples.forEach(([expected, actual]) => {
+        it(`Given ${JSON.stringify(
+          actual
+        )} should return expected value: ${JSON.stringify(expected)}`, () => {
+          expect(subDataService.sparkLeverageManagementOnPriceSubData.encode(...actual)).to.eql(expected);
+        });
+      });
+    });
+
+    describe('decode()', () => {
+      const examples: Array<[{ collAsset: EthereumAddress, collAssetId: number, debtAsset: EthereumAddress, debtAssetId: number, marketAddr: EthereumAddress, targetRatio: number}, SubData]> = 
+      [
+        [
+          {
+            collAsset: web3Utils.toChecksumAddress(getAssetInfo('WBTC', ChainId.Ethereum).address),
+            collAssetId: 2,
+            debtAsset: web3Utils.toChecksumAddress(getAssetInfo('DAI', ChainId.Ethereum).address),
+            debtAssetId: 4,
+            marketAddr: web3Utils.toChecksumAddress('0x02C3eA4e34C0cBd694D2adFa2c690EECbC1793eE'),
+            targetRatio: 175
+          }
+        , 
+          [
+            '0x0000000000000000000000002260fac5e5542a773aa44fbcfedf7c193bc2c599',
+            '0x0000000000000000000000000000000000000000000000000000000000000002',
+            '0x0000000000000000000000006b175474e89094c44da98b954eedeac495271d0f',
+            '0x0000000000000000000000000000000000000000000000000000000000000004',
+            '0x00000000000000000000000002c3ea4e34c0cbd694d2adfa2c690eecbc1793ee',
+            '0x00000000000000000000000000000000000000000000000018493fba64ef0000'
+          ]
+        ]
+      ];
+
+      examples.forEach(([expected, actual]) => {
+        it(`Given ${JSON.stringify(
+          actual
+        )} should return expected value: ${JSON.stringify(expected)}`, () => {
+          expect(subDataService.sparkLeverageManagementOnPriceSubData.decode(actual)).to.eql(expected);
+        });
+      });
+    });
+  });
 });

package/src/services/subDataService.ts

@@ -1292,3 +1292,42 @@ export const morphoBlueCloseOnPriceSubData = {
     };
   },
 };
+
+export const sparkLeverageManagementOnPriceSubData = {
+  encode(
+    collAsset: EthereumAddress,
+    collAssetId: number,
+    debtAsset: EthereumAddress,
+    debtAssetId: number,
+    marketAddr: EthereumAddress,
+    targetRatio: number,
+  ): SubData {
+    const encodedColl = AbiCoder.encodeParameter('address', collAsset);
+    const encodedCollId = AbiCoder.encodeParameter('uint16', collAssetId);
+    const encodedDebt = AbiCoder.encodeParameter('address', debtAsset);
+    const encodedDebtId = AbiCoder.encodeParameter('uint16', debtAssetId);
+    const encodedMarket = AbiCoder.encodeParameter('address', marketAddr);
+    const encodedTargetRatio = AbiCoder.encodeParameter('uint256', ratioPercentageToWei(targetRatio));
+    const useOnBehalfEncoded = AbiCoder.encodeParameter('bool', false);
+    return [encodedColl, encodedCollId, encodedDebt, encodedDebtId, encodedMarket, encodedTargetRatio, useOnBehalfEncoded];
+  },
+  decode(subData: SubData): {
+    collAsset: EthereumAddress,
+    collAssetId: number,
+    debtAsset: EthereumAddress,
+    debtAssetId: number,
+    marketAddr: EthereumAddress,
+    targetRatio: number,
+  } {
+    const collAsset = AbiCoder.decodeParameter('address', subData[0]) as unknown as EthereumAddress;
+    const collAssetId = Number(AbiCoder.decodeParameter('uint16', subData[1]));
+    const debtAsset = AbiCoder.decodeParameter('address', subData[2]) as unknown as EthereumAddress;
+    const debtAssetId = Number(AbiCoder.decodeParameter('uint16', subData[3]));
+    const marketAddr = AbiCoder.decodeParameter('address', subData[4]) as unknown as EthereumAddress;
+    const weiRatio = AbiCoder.decodeParameter('uint256', subData[5]) as any as string;
+    const targetRatio = weiToRatioPercentage(weiRatio);
+    return {
+      collAsset, collAssetId, debtAsset, debtAssetId, marketAddr, targetRatio,
+    };
+  },
+};

package/src/services/triggerService.test.ts

@@ -32,6 +32,7 @@ import {
   compoundV3PriceRangeTrigger,
   aaveV3QuotePriceRangeTrigger,
   morphoBluePriceRangeTrigger,
+  sparkQuotePriceTrigger,
 } from './triggerService';
 
 describe('Feature: triggerService.ts', () => {
@@ -1283,4 +1284,54 @@ describe('Feature: triggerService.ts', () => {
       });
     });
   });
+
+  describe('When testing triggerService.sparkQuotePriceTrigger', () => {
+    describe('encode()', () => {
+      const examples: Array<[[string], [baseTokenAddr: EthereumAddress, quoteTokenAddr: EthereumAddress, price: number, ratioState: RatioState]]> = [
+        [
+          ['0x000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb480000000000000000000000000000000000000000000000000000003a352944000000000000000000000000000000000000000000000000000000000000000001'],
+          [web3Utils.toChecksumAddress(getAssetInfo('WETH', ChainId.Ethereum).address), web3Utils.toChecksumAddress(getAssetInfo('USDC', ChainId.Ethereum).address), 2500, RatioState.UNDER]
+        ],
+        [
+          ['0x000000000000000000000000dac17f958d2ee523a2206206994597c13d831ec70000000000000000000000002260fac5e5542a773aa44fbcfedf7c193bc2c5990000000000000000000000000000000000000000000000000000000000000c1c0000000000000000000000000000000000000000000000000000000000000000'],
+          [web3Utils.toChecksumAddress(getAssetInfo('USDT', ChainId.Ethereum).address), web3Utils.toChecksumAddress(getAssetInfo('WBTC', ChainId.Ethereum).address), 0.000031, RatioState.OVER]
+        ],
+      ];
+
+      examples.forEach(([expected, actual]) => {
+        it(`Given ${actual} should return expected value: ${expected}`, () => {
+          expect(sparkQuotePriceTrigger.encode(...actual)).to.eql(expected);
+        });
+      });
+    });
+    
+     describe('decode()', () => {
+       const examples: Array<[{ baseTokenAddr: EthereumAddress, quoteTokenAddr: EthereumAddress, price: string, ratioState: RatioState }, TriggerData]> = [
+         [
+           { 
+             baseTokenAddr: web3Utils.toChecksumAddress(getAssetInfo('WETH', ChainId.Ethereum).address), 
+             quoteTokenAddr: web3Utils.toChecksumAddress(getAssetInfo('USDC', ChainId.Ethereum).address), 
+             price: '2500', 
+             ratioState: RatioState.UNDER
+           },
+           ['0x000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc2000000000000000000000000a0b86991c6218b36c1d19d4a2e9eb0ce3606eb480000000000000000000000000000000000000000000000000000003a352944000000000000000000000000000000000000000000000000000000000000000001']
+         ],
+         [
+           {
+             baseTokenAddr: web3Utils.toChecksumAddress(getAssetInfo('USDT', ChainId.Ethereum).address), 
+             quoteTokenAddr: web3Utils.toChecksumAddress(getAssetInfo('WBTC', ChainId.Ethereum).address), 
+             price: '0.000031', 
+             ratioState: RatioState.OVER
+           },
+           ['0x000000000000000000000000dac17f958d2ee523a2206206994597c13d831ec70000000000000000000000002260fac5e5542a773aa44fbcfedf7c193bc2c5990000000000000000000000000000000000000000000000000000000000000c1c0000000000000000000000000000000000000000000000000000000000000000']
+         ]
+       ];
+
+      examples.forEach(([expected, actual]) => {
+        it(`Given ${actual} should return expected value: ${JSON.stringify(expected)}`, () => {
+          expect(sparkQuotePriceTrigger.decode(actual)).to.eql(expected);
+        });
+      });
+    });
+  });
 });

package/src/services/triggerService.ts

@@ -720,4 +720,27 @@ export const morphoBluePriceRangeTrigger = {
       upperPrice: new Dec(decodedData[4] as string).div(1e8).toString(),
     };
   },
+};
+
+export const sparkQuotePriceTrigger = {
+  encode(
+    baseTokenAddr: EthereumAddress,
+    quoteTokenAddr: EthereumAddress,
+    price: number,
+    ratioState: RatioState,
+  ) {
+    const _price = new Dec(price.toString()).mul(1e8).floor().toString();
+    return [AbiCoder.encodeParameters(['address', 'address', 'uint256', 'uint8'], [baseTokenAddr, quoteTokenAddr, _price, ratioState])];
+  },
+  decode(
+    triggerData: TriggerData,
+  ) {
+    const decodedData = AbiCoder.decodeParameters(['address', 'address', 'uint256', 'uint8'], triggerData[0]);
+    return {
+      baseTokenAddr: decodedData[0] as EthereumAddress,
+      quoteTokenAddr: decodedData[1] as EthereumAddress,
+      price: new Dec(decodedData[2] as string).div(1e8).toString(),
+      ratioState: Number(decodedData[3]),
+    };
+  },
 };

package/src/types/enums.ts

@@ -223,6 +223,8 @@ export namespace Bundles {
     AAVE_V3_EOA_CLOSE = 56,
     SPARK_CLOSE = 57,
     MORPHO_BLUE_CLOSE = 58,
+    SPARK_REPAY_ON_PRICE = 59,
+    SPARK_BOOST_ON_PRICE = 60,
   }
 
   export enum OptimismIds {

package/src/types/index.ts

@@ -236,6 +236,18 @@ export declare namespace Position {
       stopLossType: CloseToAssetType | undefined,
       takeProfitType: CloseToAssetType | undefined,
     }
+
+    interface SparkOnPrice extends Base {
+      collAsset: EthereumAddress,
+      collAssetId: number,
+      debtAsset: EthereumAddress,
+      debtAssetId: number,
+      baseToken: EthereumAddress,
+      quoteToken: EthereumAddress,
+      price: string,
+      ratioState: RatioState,
+      ratio: number,
+    }
   }
 
   type SpecificAny =
@@ -253,7 +265,8 @@ export declare namespace Position {
     | Specific.PaybackLiquityV2
     | Specific.CompoundV3LeverageManagementOnPrice
     | Specific.CompoundV3CloseOnPrice
-    | Specific.AaveV3CloseOnPriceGeneric;
+    | Specific.AaveV3CloseOnPriceGeneric
+    | Specific.SparkOnPrice;
 
   export interface Automated {
     chainId: ChainId,