@defisaver/sdk 0.1.21 → 0.1.24

package/src/Strategy.js

@@ -0,0 +1,63 @@
+const Action = require('./Action');
+
+// TODO: Code is a prototype should be cleaned up before use in prod.
+
+class Strategy {
+
+  constructor(name) {
+    this.name = name;
+    this.subSlots = {};
+    this.actions = [];
+    this.triggers = [];
+    this.numSubSlots = 0;
+  }
+
+  addSubSlot(name, type) {
+    this.subSlots[name] = { type, index:  this.numSubSlots + 128 };
+    this.numSubSlots++;
+  }
+
+  addTrigger(newTrigger) {
+    this.triggers.push(newTrigger);
+  }
+
+  addAction(newAction) {
+    this.actions.push(newAction);
+  }
+
+  print() {
+    console.log(`Name: ${this.name }`);
+    console.log(`Slots: ${this.subSlots }`);
+    console.log(`Action: ${this.actions[0]}`);
+  }
+
+  getSubSlots() {
+    return this.subSlots;
+  }
+
+  // TODO: Probably should be tied into Recipe obj. not directly with actions
+  encodeForDsProxyCall() {
+    const triggerIds = this.triggers.map((trigger) => trigger.getId());
+
+    const paramMappings = [];
+    const actionIds = [];
+
+    this.actions.forEach(action => {
+      const actionEncoded = action.encodeForStrategy(this.subSlots);
+
+      actionIds.push(actionEncoded[0]);
+      paramMappings.push(actionEncoded[1]);
+    });
+
+    return [
+      this.name,
+      triggerIds,
+      actionIds,
+      paramMappings
+    ];
+  }
+
+}
+
+module.exports = Strategy;
+

package/src/abis/Action.json

@@ -1,4 +1,55 @@
 [
+  {
+    "inputs": [],
+    "name": "NonContractCall",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ReturnIndexValueError",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "SenderNotAdmin",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "SenderNotOwner",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "SubIndexValueError",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ADMIN_VAULT_ADDR",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "NO_PARAM_MAPPING",
+    "outputs": [
+      {
+        "internalType": "uint8",
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "REGISTRY_ADDR",
@@ -12,6 +63,58 @@
     "stateMutability": "view",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "RETURN_MAX_INDEX_VALUE",
+    "outputs": [
+      {
+        "internalType": "uint8",
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "RETURN_MIN_INDEX_VALUE",
+    "outputs": [
+      {
+        "internalType": "uint8",
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "SUB_MAX_INDEX_VALUE",
+    "outputs": [
+      {
+        "internalType": "uint8",
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "SUB_MIN_INDEX_VALUE",
+    "outputs": [
+      {
+        "internalType": "uint8",
+        "name": "",
+        "type": "uint8"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "actionType",
@@ -26,25 +129,38 @@
     "type": "function"
   },
   {
-    "inputs": [
+    "inputs": [],
+    "name": "adminVault",
+    "outputs": [
       {
-        "internalType": "bytes[]",
+        "internalType": "contract AdminVault",
         "name": "",
-        "type": "bytes[]"
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "bytes",
+        "name": "_callData",
+        "type": "bytes"
       },
       {
-        "internalType": "bytes[]",
-        "name": "",
-        "type": "bytes[]"
+        "internalType": "bytes32[]",
+        "name": "_subData",
+        "type": "bytes32[]"
       },
       {
         "internalType": "uint8[]",
-        "name": "",
+        "name": "_paramMapping",
         "type": "uint8[]"
       },
       {
         "internalType": "bytes32[]",
-        "name": "",
+        "name": "_returnValues",
         "type": "bytes32[]"
       }
     ],
@@ -62,9 +178,9 @@
   {
     "inputs": [
       {
-        "internalType": "bytes[]",
+        "internalType": "bytes",
         "name": "_callData",
-        "type": "bytes[]"
+        "type": "bytes"
       }
     ],
     "name": "executeActionDirect",
@@ -72,6 +188,13 @@
     "stateMutability": "payable",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "kill",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "logger",
@@ -97,5 +220,28 @@
     ],
     "stateMutability": "view",
     "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "_token",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "_receiver",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "_amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "withdrawStuckFunds",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
   }
-]
+]

package/src/abis/Recipe.json

@@ -1,4 +1,32 @@
 [
+  {
+    "inputs": [],
+    "name": "NonContractCall",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "SenderNotAdmin",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "SenderNotOwner",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ADMIN_VAULT_ADDR",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "DEFISAVER_LOGGER",
@@ -48,19 +76,19 @@
             "type": "string"
           },
           {
-            "internalType": "bytes[][]",
+            "internalType": "bytes[]",
             "name": "callData",
-            "type": "bytes[][]"
+            "type": "bytes[]"
           },
           {
-            "internalType": "bytes[][]",
+            "internalType": "bytes32[]",
             "name": "subData",
-            "type": "bytes[][]"
+            "type": "bytes32[]"
           },
           {
-            "internalType": "bytes32[]",
-            "name": "ids",
-            "type": "bytes32[]"
+            "internalType": "bytes4[]",
+            "name": "actionIds",
+            "type": "bytes4[]"
           },
           {
             "internalType": "uint8[][]",
@@ -68,8 +96,8 @@
             "type": "uint8[][]"
           }
         ],
-        "internalType": "struct StrategyData.Task",
-        "name": "_currTask",
+        "internalType": "struct StrategyModel.Recipe",
+        "name": "_currRecipe",
         "type": "tuple"
       },
       {
@@ -85,10 +113,10 @@
   },
   {
     "inputs": [],
-    "name": "chiToken",
+    "name": "adminVault",
     "outputs": [
       {
-        "internalType": "contract IGasToken",
+        "internalType": "contract AdminVault",
         "name": "",
         "type": "address"
       }
@@ -96,24 +124,6 @@
     "stateMutability": "view",
     "type": "function"
   },
-  {
-    "inputs": [
-      {
-        "internalType": "uint256",
-        "name": "_strategyId",
-        "type": "uint256"
-      },
-      {
-        "internalType": "bytes[][]",
-        "name": "_actionCallData",
-        "type": "bytes[][]"
-      }
-    ],
-    "name": "executeStrategyTask",
-    "outputs": [],
-    "stateMutability": "payable",
-    "type": "function"
-  },
   {
     "inputs": [
       {
@@ -124,19 +134,19 @@
             "type": "string"
           },
           {
-            "internalType": "bytes[][]",
+            "internalType": "bytes[]",
             "name": "callData",
-            "type": "bytes[][]"
+            "type": "bytes[]"
           },
           {
-            "internalType": "bytes[][]",
+            "internalType": "bytes32[]",
             "name": "subData",
-            "type": "bytes[][]"
+            "type": "bytes32[]"
           },
           {
-            "internalType": "bytes32[]",
-            "name": "ids",
-            "type": "bytes32[]"
+            "internalType": "bytes4[]",
+            "name": "actionIds",
+            "type": "bytes4[]"
           },
           {
             "internalType": "uint8[][]",
@@ -144,27 +154,32 @@
             "type": "uint8[][]"
           }
         ],
-        "internalType": "struct StrategyData.Task",
-        "name": "currTask",
+        "internalType": "struct StrategyModel.Recipe",
+        "name": "_currRecipe",
         "type": "tuple"
       }
     ],
-    "name": "executeTask",
+    "name": "executeRecipe",
     "outputs": [],
     "stateMutability": "payable",
     "type": "function"
   },
   {
-    "inputs": [],
-    "name": "gasToken",
-    "outputs": [
+    "inputs": [
       {
-        "internalType": "contract IGasToken",
-        "name": "",
-        "type": "address"
+        "internalType": "uint256",
+        "name": "_subId",
+        "type": "uint256"
+      },
+      {
+        "internalType": "bytes[]",
+        "name": "_actionCallData",
+        "type": "bytes[]"
       }
     ],
-    "stateMutability": "view",
+    "name": "executeRecipeFromStrategy",
+    "outputs": [],
+    "stateMutability": "payable",
     "type": "function"
   },
   {
@@ -180,6 +195,13 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "kill",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "registry",
@@ -205,5 +227,28 @@
     "outputs": [],
     "stateMutability": "nonpayable",
     "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "_token",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "_receiver",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "_amount",
+        "type": "uint256"
+      }
+    ],
+    "name": "withdrawStuckFunds",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
   }
-]
+]

package/src/actions/aave/AaveBorrowAction.js

@@ -19,9 +19,18 @@ class AaveBorrowAction extends Action {
     super(
       'AaveBorrow',
       getAddr('AaveBorrow'),
-      ['address', 'address', 'uint256', 'uint256', 'address', 'address'],
-      [market, tokenAddr, amount, rateMode, to, onBehalf],
+      [['address', 'address', 'uint256', 'uint256', 'address', 'address']],
+      [[market, tokenAddr, amount, rateMode, to, onBehalf]],
     );
+
+    this.mappableArgs = [
+      this.args[0][0],
+      this.args[0][1],
+      this.args[0][2],
+      this.args[0][3],
+      this.args[0][4],
+      this.args[0][5],
+    ];
   }
 }
 

package/src/actions/aave/AavePaybackAction.js

@@ -17,9 +17,18 @@ class AavePaybackAction extends Action {
   constructor(market, tokenAddr, amount, rateMode, from, onBehalf = getAddr('Empty')) {
     super('AavePayback',
       getAddr('AavePayback'),
-      ['address', 'address', 'uint256', 'uint256', 'address', 'address'],
-      [market, tokenAddr, amount, rateMode, from, onBehalf],
+      [['address', 'address', 'uint256', 'uint256', 'address', 'address']],
+      [[market, tokenAddr, amount, rateMode, from, onBehalf]],
     );
+
+    this.mappableArgs = [
+      this.args[0][0],
+      this.args[0][1],
+      this.args[0][2],
+      this.args[0][3],
+      this.args[0][4],
+      this.args[0][5],
+    ];
   }
 
   async getAssetsToApprove() {

package/src/actions/aave/AaveSupplyAction.js

@@ -15,7 +15,15 @@ class AaveSupplyAction extends Action {
    * @param enableAsColl {boolean} If we need to enable asset as collateral
    */
   constructor(market, tokenAddr, amount, from, onBehalf = getAddr('Empty'), enableAsColl) {
-    super('AaveSupply', getAddr('AaveSupply'), ['address','address','uint256','address','address','bool'], [market, tokenAddr, amount, from, onBehalf, enableAsColl]);
+    super('AaveSupply', getAddr('AaveSupply'), [['address','address','uint256','address','address','bool']], [[market, tokenAddr, amount, from, onBehalf, enableAsColl]]);
+
+    this.mappableArgs = [
+      this.args[0][0],
+      this.args[0][1],
+      this.args[0][2],
+      this.args[0][3],
+      this.args[0][4],
+    ];
   }
 
   async getAssetsToApprove() {

package/src/actions/aave/AaveWithdrawAction.js

@@ -14,7 +14,14 @@ class AaveWithdrawAction extends Action {
    */
   constructor(market, tokenAddr, amount, to) {
     requireAddress(to);
-    super('AaveWithdraw', getAddr('AaveWithdraw'), ['address','address','uint256','address'], [...arguments]);
+    super('AaveWithdraw', getAddr('AaveWithdraw'), [['address','address','uint256','address']], [[...arguments]]);
+
+    this.mappableArgs = [
+      this.args[0][0],
+      this.args[0][1],
+      this.args[0][2],
+      this.args[0][3],
+    ];
   }
 }
 

package/src/actions/aaveV3/AaveV3ATokenPaybackAction.js

@@ -0,0 +1,53 @@
+const L2Action = require("../../L2Action");
+const {getAssetInfoByAddress} = require("@defisaver/tokens");
+const { getAddr } = require('../../addresses.js');
+
+/**
+ * AaveV3ATokenPaybackAction - Repay Aave V3 debt using aTokens
+ */
+class AaveV3ATokenPaybackAction extends L2Action {
+  /**
+   * @param market {EthAddress} Address provider for specific market
+   * @param amount {string} Amount of tokens to be payed back (uint.max for full debt)
+   * @param from {EthAddress} Where are we pulling the payback aTokens from
+   * @param rateMode {number} Type of borrow debt [Stable: 1, Variable: 2]
+   * @param aTokenAddr {EthAddress} address of the aToken to be pulled
+   * @param assetId {number} The id of the underlying asset to be repaid
+   */
+  constructor(market, amount, from, rateMode, aTokenAddr, assetId) {
+    super('AaveV3Payback', getAddr('AaveV3Payback'),
+    [['address','uint256','address','uint8','uint16']],
+    [[market, amount, from, rateMode, assetId]]
+    );
+
+    this.mappableArgs = [
+      this.args[0][0],
+      this.args[0][1],
+      this.args[0][2],
+    ];
+    this.addressForApproval = aTokenAddr;
+  }
+
+  async getAssetsToApprove() {
+    const asset = getAssetInfoByAddress(this.addressForApproval);
+    if (asset.symbol !== 'ETH') return [{asset: this.addressForApproval, owner: this.args[0][2]}];
+    return [];
+  }
+  encodeInputs() {
+    // executeActionDirectL2
+    let encodedInput = "0x2895f3aa";
+    // market
+    encodedInput = encodedInput.concat(this.addressToBytes20(this.args[0][0]));
+    // amount
+    encodedInput = encodedInput.concat(this.numberToBytes32(this.args[0][1]));
+    // from
+    encodedInput = encodedInput.concat(this.addressToBytes20(this.args[0][2]));
+    // rateMode
+    encodedInput = encodedInput.concat(this.numberToBytes1(this.args[0][3]));
+    // assetId
+    encodedInput = encodedInput.concat(this.numberToBytes2(this.args[0][4]));
+    return encodedInput;
+  }
+}
+
+module.exports = AaveV3ATokenPaybackAction;

package/src/actions/aaveV3/AaveV3BorrowAction.js

@@ -0,0 +1,54 @@
+const L2Action = require("../../L2Action");
+const { getAddr } = require('../../addresses.js');
+
+/**
+ * AaveV3BorrowAction - Borrow a token from AaveV3
+ */
+class AaveV3BorrowAction extends L2Action {
+   /**
+   * @param market {EthAddress} Address provider for specific market
+   * @param amount {string} Amount of tokens to be borrowed
+   * @param to {EthAddress} The address we are sending the borrowed tokens to
+   * @param rateMode {number} Type of borrow debt [Stable: 1, Variable: 2]
+   * @param assetId {number} The id of the token to be borrowed
+   * @param useOnBehalf {boolean} use on behalf or default to proxy
+   * @param onBehalf {EthAddress} On whose behalf we borrow the tokens, defaults to proxy
+   */
+  constructor(market, amount, to, rateMode, assetId, useOnBehalf , onBehalf = getAddr('Empty')) {
+    super('AaveV3Borrow', getAddr('AaveV3Borrow'),
+    [['address','uint256','address','uint8','uint16','bool', 'address']],
+    [[market, amount, to, rateMode, assetId, useOnBehalf, onBehalf]]
+    );
+
+    this.mappableArgs = [
+      this.args[0][0],
+      this.args[0][1],
+      this.args[0][2],
+      this.args[0][6],
+    ];
+  }
+
+  encodeInputs() {
+    // executeActionDirectL2
+    let encodedInput = "0x2895f3aa";
+    // market
+    encodedInput = encodedInput.concat(this.addressToBytes20(this.args[0][0]));
+    // amount
+    encodedInput = encodedInput.concat(this.numberToBytes32(this.args[0][1]));
+    // to
+    encodedInput = encodedInput.concat(this.addressToBytes20(this.args[0][2]));
+    // rateMode
+    encodedInput = encodedInput.concat(this.numberToBytes1(this.args[0][3]));
+    // assetId
+    encodedInput = encodedInput.concat(this.numberToBytes2(this.args[0][4]));
+    // useOnBehalf
+    encodedInput = encodedInput.concat(this.boolToBytes1(this.args[0][5]));
+    if (this.args[0][5]) {
+      // onBehalf
+      encodedInput = encodedInput.concat(this.addressToBytes20(this.args[0][6]));
+    }
+    return encodedInput;
+  }
+}
+
+module.exports = AaveV3BorrowAction;