@defisaver/sdk 1.0.57 → 1.0.59

package/DEV.md

@@ -0,0 +1,43 @@
+# DeFi Saver SDK
+
+Every specific action is a class that has to extend base class [Action](https://github.com/defisaver/defisaver-sdk/blob/master/src/Action.ts) or [ActionWithL2](https://github.com/defisaver/defisaver-sdk/blob/master/src/ActionWithL2.ts)
+
+When using an action in a recipe, you can pipe an output of an action used before it by putting $ and then the number of action which output you want to use (starting from 1, not 0)
+e.g.
+
+```js
+const recipe = new Recipe('exampleLiquitySupply', [
+  // pull 1 WETH from user address
+  new dfs.actions.basic.PullToken('0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', '0x123..', 1000000000000000000),
+  // $1 will use the output of the first action as that argument - in this case, it will be 1 WETH
+  new dfs.actions.liquity.LiquitySupplyAction('$1', '0xProxy', 'upperHint', 'lowerHint'),
+]);
+```
+## Action
+
+- ```constructor``` - here you should sanity check arguments, and call ```super(actionName, addressOfAction, types, args)``` where types are used for encoding args
+- ```mappableArgs``` - if needed, have to be defined in ```constructor```
+- ```getAssetsToApprove``` - if action pulls tokens from the address, this should return an array of tokens that need to be approved (erc20 and/or nfts). [Return type object](https://github.com/defisaver/defisaver-sdk/blob/29aa14835240b977ceb053dfc947faae5d19ff9d/src/Action.ts#L195) is defined here.
+- ```getEthValue``` - needed if action is using pure ETH, then value is required when sending a tx
+- ```encodeInputs``` - if Action extends ActionWithL2, it can have custom function for gas savings e.g. pack address as 20 bytes instead od 32
+- ```encodeForDsProxyCall```
+- ```encodeForL2DsProxyCall```
+- ```encodeForRecipe```
+- ```encodeForL2Recipe```
+- ```encodeForStrategy```
+
+## Recipe
+
+- ```constructor(name, actions)``` - name of the recipe is required, actions are optional
+- ```addAction``` - add Action to Recipe
+- ```getAssetsToApprove``` - returns an array of all unique token approvals from all actions from the recipe
+- ```getEthValue``` - sum of values from all actions
+- ```encodeForDsProxyCall```
+
+## Addresses
+
+All contract addresses can be found [here](https://github.com/defisaver/defisaver-sdk/blob/master/src/addresses.ts)
+
+## Examples
+
+Examples and tests can be found [here](https://github.com/defisaver/defisaver-sdk/tree/master/test)

package/esm/src/Action.d.ts

@@ -1,6 +1,6 @@
 import { AccessListItem, EthAddress } from './types';
-declare type ParamTypes = Array<string | Array<any>>;
-declare type Args = Array<any>;
+type ParamTypes = Array<string | Array<any>>;
+type Args = Array<any>;
 /**
  * Single action that can be executed directly, or combined into a set (ie. supply a vault)
  *

package/esm/src/addresses.d.ts

@@ -370,6 +370,13 @@ export declare const actionAddresses: {
         AaveV3Supply: string;
         AaveV3SwapBorrowRateMode: string;
         AaveV3Withdraw: string;
+        CompV3Allow: string;
+        CompV3Borrow: string;
+        CompV3Claim: string;
+        CompV3Payback: string;
+        CompV3Supply: string;
+        CompV3Transfer: string;
+        CompV3Withdraw: string;
         FLAaveV3NoFee: string;
         FLAaveV3: string;
         FLBalancer: string;
@@ -507,13 +514,6 @@ export declare const actionAddresses: {
         CBChickenOut?: undefined;
         CBCreateRebondSub?: undefined;
         FetchBondId?: undefined;
-        CompV3Allow?: undefined;
-        CompV3Borrow?: undefined;
-        CompV3Claim?: undefined;
-        CompV3Payback?: undefined;
-        CompV3Supply?: undefined;
-        CompV3Transfer?: undefined;
-        CompV3Withdraw?: undefined;
         CurveUsdBorrow?: undefined;
         CurveUsdCreate?: undefined;
         CurveUsdPayback?: undefined;

package/esm/src/addresses.js

@@ -259,6 +259,14 @@ export const actionAddresses = {
         AaveV3Supply: '0xF159c79077001E2a2C1a178BE68DB7F69a6Da486',
         AaveV3SwapBorrowRateMode: '0x738042389A8d6B0F6D6ab009c42dfF84ebB737C0',
         AaveV3Withdraw: '0xbf492F869DdB1A18BB4F41b6c3059D9f882Fe7ff',
+        // CompV3
+        CompV3Allow: '0x0380E8e13CdE0499c720999930CaA07A5744887c',
+        CompV3Borrow: '0x1C0eCc794fDA7c29aBd19E0b2F7dA166C237d616',
+        CompV3Claim: '0xDa135F74a24FE2B23ECc35De227f5d3b000c5AdA',
+        CompV3Payback: '0xeA8b80944a70e6C290eb00Ae0298d2953aD3aA0C',
+        CompV3Supply: '0x82bf73d2083e69344747fff0d51816059db0113c',
+        CompV3Transfer: '0x9EB98fA05E89a598288B0386e66052Ba0d0B9911',
+        CompV3Withdraw: '0xb6c2dC95201630cAF7568cBdF434d787CD84dB79',
         // flashloan
         FLAaveV3NoFee: '0x219ac6dA971dE6d943cffD1BD62abde71525d382',
         FLAaveV3: '0x53953aCEe438c083e4299F7976f03Ff3cb862161',
@@ -282,7 +290,7 @@ export const actionAddresses = {
         PullToken: '0x5B0B7E38C2a8e46CfAe13c360BC5927570BeEe94',
         TokenBalance: '0xc44bcE580B1b3339fE9272D3bC3d6566083ea59C',
         // Flashloan
-        FLAaveV3: '0x04ce4b2a9F524d976a8eD8a49B9313C5a2C3ccAD',
+        FLAaveV3: '0x79Eb9cEe432Cd3e7b09A9eFdB21A733A6d7b4c3A',
         FLBalancer: '0x862E533198C9656B75bB6A5dDF0953F7ED5E8507',
         FLUniV3: '0x1bA6082D2ef1aB92a55B96264c72Eb8049C964Ce',
         // AaveV3

package/esm/src/index.d.ts

@@ -381,6 +381,13 @@ declare const actionAddressesAllChains: {
         AaveV3Supply: string;
         AaveV3SwapBorrowRateMode: string;
         AaveV3Withdraw: string;
+        CompV3Allow: string;
+        CompV3Borrow: string;
+        CompV3Claim: string;
+        CompV3Payback: string;
+        CompV3Supply: string;
+        CompV3Transfer: string;
+        CompV3Withdraw: string;
         FLAaveV3NoFee: string;
         FLAaveV3: string;
         FLBalancer: string;
@@ -518,13 +525,6 @@ declare const actionAddressesAllChains: {
         CBChickenOut?: undefined;
         CBCreateRebondSub?: undefined;
         FetchBondId?: undefined;
-        CompV3Allow?: undefined;
-        CompV3Borrow?: undefined;
-        CompV3Claim?: undefined;
-        CompV3Payback?: undefined;
-        CompV3Supply?: undefined;
-        CompV3Transfer?: undefined;
-        CompV3Withdraw?: undefined;
         CurveUsdBorrow?: undefined;
         CurveUsdCreate?: undefined;
         CurveUsdPayback?: undefined;
@@ -1087,6 +1087,13 @@ declare const actionAddresses: (chainId?: null) => {
     AaveV3Supply: string;
     AaveV3SwapBorrowRateMode: string;
     AaveV3Withdraw: string;
+    CompV3Allow: string;
+    CompV3Borrow: string;
+    CompV3Claim: string;
+    CompV3Payback: string;
+    CompV3Supply: string;
+    CompV3Transfer: string;
+    CompV3Withdraw: string;
     FLAaveV3NoFee: string;
     FLAaveV3: string;
     FLBalancer: string;
@@ -1224,13 +1231,6 @@ declare const actionAddresses: (chainId?: null) => {
     CBChickenOut?: undefined;
     CBCreateRebondSub?: undefined;
     FetchBondId?: undefined;
-    CompV3Allow?: undefined;
-    CompV3Borrow?: undefined;
-    CompV3Claim?: undefined;
-    CompV3Payback?: undefined;
-    CompV3Supply?: undefined;
-    CompV3Transfer?: undefined;
-    CompV3Withdraw?: undefined;
     CurveUsdBorrow?: undefined;
     CurveUsdCreate?: undefined;
     CurveUsdPayback?: undefined;
@@ -1936,6 +1936,13 @@ declare const _default: {
         AaveV3Supply: string;
         AaveV3SwapBorrowRateMode: string;
         AaveV3Withdraw: string;
+        CompV3Allow: string;
+        CompV3Borrow: string;
+        CompV3Claim: string;
+        CompV3Payback: string;
+        CompV3Supply: string;
+        CompV3Transfer: string;
+        CompV3Withdraw: string;
         FLAaveV3NoFee: string;
         FLAaveV3: string;
         FLBalancer: string;
@@ -2073,13 +2080,6 @@ declare const _default: {
         CBChickenOut?: undefined;
         CBCreateRebondSub?: undefined;
         FetchBondId?: undefined;
-        CompV3Allow?: undefined;
-        CompV3Borrow?: undefined;
-        CompV3Claim?: undefined;
-        CompV3Payback?: undefined;
-        CompV3Supply?: undefined;
-        CompV3Transfer?: undefined;
-        CompV3Withdraw?: undefined;
         CurveUsdBorrow?: undefined;
         CurveUsdCreate?: undefined;
         CurveUsdPayback?: undefined;
@@ -2642,6 +2642,13 @@ declare const _default: {
             AaveV3Supply: string;
             AaveV3SwapBorrowRateMode: string;
             AaveV3Withdraw: string;
+            CompV3Allow: string;
+            CompV3Borrow: string;
+            CompV3Claim: string;
+            CompV3Payback: string;
+            CompV3Supply: string;
+            CompV3Transfer: string;
+            CompV3Withdraw: string;
             FLAaveV3NoFee: string;
             FLAaveV3: string;
             FLBalancer: string;
@@ -2779,13 +2786,6 @@ declare const _default: {
             CBChickenOut?: undefined;
             CBCreateRebondSub?: undefined;
             FetchBondId?: undefined;
-            CompV3Allow?: undefined;
-            CompV3Borrow?: undefined;
-            CompV3Claim?: undefined;
-            CompV3Payback?: undefined;
-            CompV3Supply?: undefined;
-            CompV3Transfer?: undefined;
-            CompV3Withdraw?: undefined;
             CurveUsdBorrow?: undefined;
             CurveUsdCreate?: undefined;
             CurveUsdPayback?: undefined;

package/esm/src/types.d.ts

@@ -1,17 +1,17 @@
-declare type AccessListItem = {
+type AccessListItem = {
     address: EthAddress;
     storageKeys: Array<any>;
 };
-declare type AccessList = Array<Array<any>>;
-declare type AccessLists = {
+type AccessList = Array<Array<any>>;
+type AccessLists = {
     [key: string]: AccessList;
 };
-declare type Config = {
+type Config = {
     chainId: number;
     testingMode: boolean;
     [key: string]: any;
 };
-declare type Network = {
+type Network = {
     chainId: number;
     chainName: string;
     blockExplorerUrls: Array<string>;
@@ -23,24 +23,24 @@ declare type Network = {
         symbol: string;
     };
 };
-declare type Networks = {
+type Networks = {
     ethereum: Network;
     optimism: Network;
     arbitrum: Network;
     base: Network;
 };
-declare type EthAddress = string;
-declare type bytes32 = string;
-declare type bytes = string | Array<any>;
-declare type uint256 = string;
-declare type uint32 = string;
-declare type uint160 = string;
-declare type uint128 = string;
-declare type uint80 = string;
-declare type uint64 = string;
-declare type uint24 = string;
-declare type uint16 = string;
-declare type uint8 = string;
-declare type int256 = string;
-declare type int24 = string;
+type EthAddress = string;
+type bytes32 = string;
+type bytes = string | Array<any>;
+type uint256 = string;
+type uint32 = string;
+type uint160 = string;
+type uint128 = string;
+type uint80 = string;
+type uint64 = string;
+type uint24 = string;
+type uint16 = string;
+type uint8 = string;
+type int256 = string;
+type int24 = string;
 export { AccessList, AccessListItem, AccessLists, Config, Network, Networks, EthAddress, bytes32, bytes, uint256, uint160, uint32, uint128, uint80, uint64, uint24, uint16, uint8, int256, int24, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defisaver/sdk",
-  "version": "1.0.57",
+  "version": "1.0.59",
   "description": "",
   "main": "./umd/index.js",
   "module": "./esm/src/index.js",

package/src/addresses.ts

@@ -302,6 +302,15 @@ export const actionAddresses = {
     AaveV3SwapBorrowRateMode: '0x738042389A8d6B0F6D6ab009c42dfF84ebB737C0',
     AaveV3Withdraw: '0xbf492F869DdB1A18BB4F41b6c3059D9f882Fe7ff',
 
+    // CompV3
+    CompV3Allow: '0x0380E8e13CdE0499c720999930CaA07A5744887c',
+    CompV3Borrow: '0x1C0eCc794fDA7c29aBd19E0b2F7dA166C237d616',
+    CompV3Claim: '0xDa135F74a24FE2B23ECc35De227f5d3b000c5AdA',
+    CompV3Payback: '0xeA8b80944a70e6C290eb00Ae0298d2953aD3aA0C',
+    CompV3Supply: '0x82bf73d2083e69344747fff0d51816059db0113c',
+    CompV3Transfer: '0x9EB98fA05E89a598288B0386e66052Ba0d0B9911',
+    CompV3Withdraw: '0xb6c2dC95201630cAF7568cBdF434d787CD84dB79',
+
     // flashloan
     FLAaveV3NoFee: '0x219ac6dA971dE6d943cffD1BD62abde71525d382',
     FLAaveV3: '0x53953aCEe438c083e4299F7976f03Ff3cb862161',
@@ -328,7 +337,7 @@ export const actionAddresses = {
     TokenBalance: '0xc44bcE580B1b3339fE9272D3bC3d6566083ea59C',
 
     // Flashloan
-    FLAaveV3: '0x04ce4b2a9F524d976a8eD8a49B9313C5a2C3ccAD',
+    FLAaveV3: '0x79Eb9cEe432Cd3e7b09A9eFdB21A733A6d7b4c3A',
     FLBalancer: '0x862E533198C9656B75bB6A5dDF0953F7ED5E8507',
     FLUniV3: '0x1bA6082D2ef1aB92a55B96264c72Eb8049C964Ce',