@defisaver/sdk 0.1.8 → 0.1.12

package/AccessLists/ReflexerAccessLists.js

@@ -0,0 +1,53 @@
+const ReflexerAccessLists = {
+    ReflexerOpen: [
+        ['0xEfe0B4cA532769a3AE758fD82E1426a03A94F185', []], // GebSafeManager
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    ReflexerSupply: [
+        ['0xCC88a9d330da1133Df3A7bD823B95e52511A6962', []], // SAFEEngine
+        ['0xEfe0B4cA532769a3AE758fD82E1426a03A94F185', []], // GebSafeManager
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    ReflexerWithdraw: [
+        ['0xEfe0B4cA532769a3AE758fD82E1426a03A94F185', []], // GebSafeManager
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    ReflexerGenerate: [
+        ['0xCC88a9d330da1133Df3A7bD823B95e52511A6962', []], // SAFEEngine
+        ['0xEfe0B4cA532769a3AE758fD82E1426a03A94F185', []], // GebSafeManager
+        ['0x0A5653CCa4DB1B6E265F47CAf6969e64f1CFdC45', []], // CoinJoin
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    ReflexerPayback: [
+        ['0xCC88a9d330da1133Df3A7bD823B95e52511A6962', []], // SAFEEngine
+        ['0xEfe0B4cA532769a3AE758fD82E1426a03A94F185', []], // GebSafeManager
+        ['0x0A5653CCa4DB1B6E265F47CAf6969e64f1CFdC45', []], // CoinJoin
+        ['0x03ab458634910AaD20eF5f1C8ee96F1D6ac54919', []], // Rai
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    ReflexerNativeUniV2SaviourDeposit: [
+        ['0xEfe0B4cA532769a3AE758fD82E1426a03A94F185', []], // GebSafeManager
+        ['0xA9402De5ce3F1E03Be28871b914F77A4dd5e4364', []], // NativeUnderlyingUniswapV2SafeSaviour
+        ['0x8aE720a71622e824F576b4A8C03031066548A3B1', []], // UNIV2_RAI_WETH_ADDRESS
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    ReflexerNativeUniV2SaviourWithdraw: [
+        ['0xA9402De5ce3F1E03Be28871b914F77A4dd5e4364', []], // NativeUnderlyingUniswapV2SafeSaviour
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    ReflexerNativeUniV2SaviourGetReserves: [
+        ['0xA9402De5ce3F1E03Be28871b914F77A4dd5e4364', []], // NativeUnderlyingUniswapV2SafeSaviour
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+};
+
+module.exports = {
+    ReflexerAccessLists,
+};

package/AccessLists/UniswapAccessLists.js

@@ -0,0 +1,41 @@
+const UniswapAccessLists = {
+    UniSupply: [
+        ['0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D', []], // UniV2Router02
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    UniWithdraw: [
+        ['0x5C69bEe701ef814a2B6a3EDD4B1652CB9cc5aA6f', []], // UniV2Factory
+        ['0x7a250d5630B4cF539739dF2C5dAcb4c659F2488D', []], // UniV2Router02
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    UniMintV3: [
+        ['0xC36442b4a4522E871399CD717aBDD847Ab11FE88', []], // NonfungiblePositionManager
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    UniSupplyV3: [
+        ['0xC36442b4a4522E871399CD717aBDD847Ab11FE88', []], // NonfungiblePositionManager
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    UniWithdrawV3: [
+        ['0xC36442b4a4522E871399CD717aBDD847Ab11FE88', []], // NonfungiblePositionManager
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    UniCollectV3: [
+        ['0xC36442b4a4522E871399CD717aBDD847Ab11FE88', []], // NonfungiblePositionManager
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    UniCreatePoolV3: [
+        ['0xC36442b4a4522E871399CD717aBDD847Ab11FE88', []], // NonfungiblePositionManager
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+};
+
+module.exports = {
+    UniswapAccessLists,
+};

package/AccessLists/UtilsAccessLists.js

@@ -0,0 +1,41 @@
+const UtilsAccessLists = {
+    WrapEth: [
+        ['0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', []], // WETH
+    ],
+
+    UnwrapEth: [
+        ['0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2', []], // WETH
+    ],
+
+    DFSSell: [
+        ['0x25dd3F51e0C3c3Ff164DDC02A8E4D65Bb9cBB12D', []], // SaverExchangeRegistry
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    DFSBuy: [
+        ['0x25dd3F51e0C3c3Ff164DDC02A8E4D65Bb9cBB12D', []], // SaverExchangeRegistry
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    SendToken: [],
+
+    PullToken: [],
+
+    SumInputs: [],
+
+    SubInputs: [],
+
+    ChangeProxyOwner: [
+        ['0xF8f8B3C98Cf2E63Df3041b73f80F362a4cf3A576', []], // DFSProxyRegistryController
+    ],
+
+    TokenBalance: [],
+
+    AutomationV2Unsub: [
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+};
+
+module.exports = {
+    UtilsAccessLists,
+};

package/AccessLists/YearnAccessLists.js

@@ -0,0 +1,14 @@
+const YearnAccessLists = {
+    YearnSupply: [
+        ['0x50c1a2eA0a861A967D9d0FFE2AE4012c2E053804', []], // YearnV2Registry
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+
+    YearnWithdraw: [
+        ['0x5c55B921f590a89C1Ebe84dF170E655a82b62126', []], // DefisaverLogger
+    ],
+};
+
+module.exports = {
+    YearnAccessLists,
+};

package/AccessLists/index.js

@@ -0,0 +1,41 @@
+const { MakerAccessLists } = require('./MakerAccessLists');
+const { AaveAccessLists } = require('./AaveAccessLists');
+const { BalancerAccessLists } = require('./BalancerAccessLists');
+const { CompoundAccessLists } = require('./CompoundAccessLists');
+const { ReflexerAccessLists } = require('./ReflexerAccessLists');
+const { YearnAccessLists } = require('./YearnAccessLists');
+const { RariAccessLists } = require('./RariAccessLists');
+const { MStableAccessLists } = require('./MStableAccessLists');
+const { DyDxAccessLists } = require('./DyDxAccessLists');
+const { LidoAccessLists } = require('./LidoAccessLists');
+const { GuniAccessLists } = require('./GuniAccessLists');
+const { UniswapAccessLists } = require('./UniswapAccessLists');
+const { InstaAccessLists } = require('./InstaAccessLists');
+const { LiquityAccessLists } = require('./LiquityAccessLists');
+
+const { FlashLoanAccessLists } = require('./FlashLoanAccessLists');
+const { UtilsAccessLists } = require('./UtilsAccessLists');
+
+const AccessLists = {
+    ...MakerAccessLists,
+    ...AaveAccessLists,
+    ...BalancerAccessLists,
+    ...CompoundAccessLists,
+    ...ReflexerAccessLists,
+    ...YearnAccessLists,
+    ...RariAccessLists,
+    ...MStableAccessLists,
+    ...DyDxAccessLists,
+    ...LidoAccessLists,
+    ...GuniAccessLists,
+    ...UniswapAccessLists,
+    ...InstaAccessLists,
+    ...LiquityAccessLists,
+
+    ...FlashLoanAccessLists,
+    ...UtilsAccessLists,
+};
+
+module.exports = {
+    AccessLists,
+};

package/DEV.md

@@ -29,6 +29,11 @@
 <dt><a href="#VaultId">VaultId</a> : <code>string</code> | <code>number</code></dt>
 <dd><p>Maker vault ID</p>
 </dd>
+<dt><a href="#AccessListItem">AccessListItem</a> : <code>Object</code></dt>
+<dd><p>Access list item</p>
+</dd>
+<dt><a href="#AccessList">AccessList</a> : <code><a href="#AccessListItem">Array.&lt;AccessListItem&gt;</a></code></dt>
+<dd></dd>
 </dl>
 
 <a name="utils.module_uniswapLP"></a>
@@ -159,6 +164,7 @@ Single action that can be executed directly, or combined into a set (ie. supply
     * [.encodeForRecipe()](#Action+encodeForRecipe) ⇒ <code>Array.&lt;string&gt;</code>
     * [.getAssetsToApprove()](#Action+getAssetsToApprove) ⇒ <code>Promise.&lt;Array.&lt;{owner: string, asset: string}&gt;&gt;</code>
     * [.getEthValue()](#Action+getEthValue) ⇒ <code>Promise.&lt;string&gt;</code>
+    * [.getAccessList()](#Action+getAccessList) ⇒ [<code>AccessList</code>](#AccessList)
 
 <a name="new_Action_new"></a>
 
@@ -197,6 +203,12 @@ ETH value to be sent with transaction
 
 **Kind**: instance method of [<code>Action</code>](#Action)  
 **Returns**: <code>Promise.&lt;string&gt;</code> - ETH value in wei  
+<a name="Action+getAccessList"></a>
+
+### action.getAccessList() ⇒ [<code>AccessList</code>](#AccessList)
+Access list for single action
+
+**Kind**: instance method of [<code>Action</code>](#Action)  
 <a name="Recipe"></a>
 
 ## Recipe
@@ -211,6 +223,7 @@ Set of Actions to be performed sequentially in a single transaction
     * [._validateParamMappings()](#Recipe+_validateParamMappings)
     * [.getAssetsToApprove()](#Recipe+getAssetsToApprove) ⇒ <code>Promise.&lt;Array.&lt;{owner: string, asset: string}&gt;&gt;</code>
     * [.getEthValue()](#Recipe+getEthValue) ⇒ <code>Promise.&lt;string&gt;</code>
+    * [.getAccessList()](#Recipe+getAccessList) ⇒ [<code>AccessList</code>](#AccessList)
 
 <a name="new_Recipe_new"></a>
 
@@ -255,6 +268,12 @@ ETH value to be sent with transaction
 
 **Kind**: instance method of [<code>Recipe</code>](#Recipe)  
 **Returns**: <code>Promise.&lt;string&gt;</code> - ETH value in wei  
+<a name="Recipe+getAccessList"></a>
+
+### recipe.getAccessList() ⇒ [<code>AccessList</code>](#AccessList)
+Generates an access list for the recipe
+
+**Kind**: instance method of [<code>Recipe</code>](#Recipe)  
 <a name="EthAddress"></a>
 
 ## EthAddress : <code>string</code>
@@ -267,3 +286,20 @@ Ethereum address
 Maker vault ID
 
 **Kind**: global typedef  
+<a name="AccessListItem"></a>
+
+## AccessListItem : <code>Object</code>
+Access list item
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| address | <code>string</code> | 
+| storageKeys | <code>Array.&lt;string&gt;</code> | 
+
+<a name="AccessList"></a>
+
+## AccessList : [<code>Array.&lt;AccessListItem&gt;</code>](#AccessListItem)
+**Kind**: global typedef  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defisaver/sdk",
-  "version": "0.1.8",
+  "version": "0.1.12",
   "description": "",
   "main": "index.js",
   "scripts": {

package/src/Action.js

@@ -1,8 +1,10 @@
 const AbiCoder = require('web3-eth-abi');
-const Web3Utils = require('web3-utils');
+const { keccak256, padLeft, toHex } = require('web3-utils');
 
 const ActionAbi = require('./abis/Action.json');
 
+const { AccessLists } = require('../AccessLists');
+
 /**
  * Single action that can be executed directly, or combined into a set (ie. supply a vault)
  */
@@ -30,7 +32,7 @@ class Action {
    * @private
    */
   _getId() {
-    return Web3Utils.keccak256(this.name);
+    return keccak256(this.name);
   }
 
   /**
@@ -132,6 +134,20 @@ class Action {
   async getEthValue() {
     return '0';
   }
+
+  /**
+   * Access list for single action
+   * @returns {AccessList}
+   */
+  getAccessList() {
+    return [
+      [this.contractAddress, []],
+      ...(AccessLists[this.name] || []),
+    ].map(([address, storageKeys]) => ({
+      address: address,
+      storageKeys: storageKeys.map(num => padLeft(toHex(num), 64)),
+    }));
+  }
 }
 
 module.exports = Action;

package/src/Recipe.js

@@ -4,6 +4,7 @@ const {getAssetInfo, utils: {compare}} = require("@defisaver/tokens");
 const Action = require('./Action');
 const {getAddr} = require('./addresses');
 const RecipeAbi = require('./abis/Recipe.json');
+const { AccessLists } = require('../AccessLists');
 
 /**
  * Set of Actions to be performed sequentially in a single transaction
@@ -99,6 +100,27 @@ class Recipe {
       .reduce((acc, val) => acc.add(new BN(val)), new BN(0))
       .toString();
   }
+
+  /**
+   * Generates an access list for the recipe
+   * @returns {AccessList}
+   */
+  getAccessList() {
+    const addressMapping = {
+      [getAddr('TaskExecutor')]: [],
+      [getAddr('DFSRegistry')]: [],
+    };
+    this.actions.forEach((action) => {
+      const accessList = action.getAccessList();
+      accessList.forEach(({ address, storageKeys }) => {
+        addressMapping[address] = new Set([...storageKeys, ...(addressMapping[address] || [])]);
+      })
+    });
+    return Object.keys(addressMapping).map((address) => ({
+      address,
+      storageKeys: [...addressMapping[address]],
+    }));
+  }
 }
 
 module.exports = Recipe;

package/src/actions/aave/index.js

@@ -2,7 +2,6 @@ const AaveBorrowAction = require('./AaveBorrowAction');
 const AaveSupplyAction = require('./AaveSupplyAction');
 const AavePaybackAction = require('./AavePaybackAction');
 const AaveWithdrawAction = require('./AaveWithdrawAction');
-const AaveMigrateLendAction = require('./AaveMigrateLendAction');
 const AaveClaimStkAaveAction = require('./AaveClaimStkAaveAction');
 const AaveCollateralSwitchAction = require('./AaveCollateralSwitchAction');
 
@@ -11,7 +10,6 @@ module.exports = {
   AaveSupplyAction,
   AavePaybackAction,
   AaveWithdrawAction,
-  AaveMigrateLendAction,
   AaveClaimStkAaveAction,
   AaveCollateralSwitchAction
 };

package/src/actions/basic/AutomationV2Unsub.js

@@ -1,5 +1,5 @@
-const Action = require("@defisaver/sdk/src/Action");
-const { getAddr } = require('@defisaver/sdk/src/addresses');
+const Action = require("../../Action");
+const {getAddr} = require("../../addresses.js");
 
 class AutomationV2Unsub extends Action {
   constructor(protocol, cdpId = 0) {

package/src/actions/flashloan/BalancerFlashLoanAction.js

@@ -1,5 +1,5 @@
-const Action = require("@defisaver/sdk/src/Action");
-const { getAddr } = require('@defisaver/sdk/src/addresses');
+const Action = require("../../Action");
+const { getAddr } = require('../../addresses.js');
 
 /**
  * Gets a flashloan from Balancer

package/src/actions/flashloan/BalancerFlashLoanPaybackAction.js

@@ -1,5 +1,5 @@
-const SendTokenAction = require("@defisaver/sdk/src/actions/basic/SendTokenAction");
-const { getAddr } = require('@defisaver/sdk/src/addresses');
+const SendTokenAction = require("../basic/SendTokenAction");
+const { getAddr } = require('../../addresses.js');
 
 /**
  * Pays back a flashloan from Balancer

package/src/actions/flashloan/MakerFlashLoanPaybackAction.js

@@ -1,5 +1,5 @@
-const SendTokenAction = require("@defisaver/sdk/src/actions/basic/SendTokenAction");
-const { getAddr } = require('@defisaver/sdk/src/addresses');
+const SendTokenAction = require("../basic/SendTokenAction");
+const { getAddr } = require('../../addresses.js');
 
 /**
  * Pays back a flashloan from Maker

package/src/actions/guni/GUniDeposit.js

@@ -0,0 +1,43 @@
+const Action = require("../../Action");
+const { getAssetInfo } = require("@defisaver/tokens");
+const { getAddr } = require('../../addresses.js');
+
+/**
+ * Action that adds liquidity to G-UNI pool of interest (mints G-UNI LP tokens)
+*/
+class GUniDeposit extends Action {
+    /// @param pool address of G-UNI pool to add liquidity to
+    /// @param token0 address of token0
+    /// @param token1 address of token1
+    /// @param amount0Max the maximum amount of token0 msg.sender willing to input
+    /// @param amount1Max the maximum amount of token1 msg.sender willing to input
+    /// @param amount0Min the minimum amount of token0 actually input (slippage protection)
+    /// @param amount1Min the minimum amount of token1 actually input (slippage protection)
+    /// @param to account to receive minted G-UNI tokens
+    /// @param from account from which to pull underlying tokens from
+  constructor(pool, token0, token1, amount0Max, amount1max, amount0Min, amount1Min, to, from) {
+    super(
+        'GUniDeposit',
+        getAddr('GUniDeposit'),
+        [['address', 'address', 'address', 'uint256', 'uint256', 'uint256', 'uint256', 'address', 'address']],
+        [[pool, token0, token1, amount0Max, amount1max, amount0Min, amount1Min, to, from]]
+    );
+    this.mappableArgs = [
+        this.args[0][3],
+        this.args[0][4],
+        this.args[0][5],
+        this.args[0][6],
+    ];
+  }
+
+  async getAssetsToApprove() {
+    const approveArr = [];
+
+    approveArr.push({asset: this.args[0][1], owner: this.args[0][8]});
+    approveArr.push({asset: this.args[0][2], owner: this.args[0][8]});
+
+    return approveArr;
+  }
+}
+
+module.exports = GUniDeposit;

package/src/actions/guni/GUniWithdraw.js

@@ -0,0 +1,32 @@
+const Action = require("../../Action");
+const { getAssetInfo } = require("@defisaver/tokens");
+const { getAddr } = require('../../addresses.js');
+
+/**
+ * Action that removes liquidity from a G-UNI pool and burns G-UNI LP tokens
+*/
+class GUniWithdraw extends Action {
+    /// @param pool address of G-UNI pool to remove liquidity from
+    /// @param burnAmount The number of G-UNI tokens to burn
+    /// @param amount0Min Minimum amount of token0 received after burn (slippage protection)
+    /// @param amount1Min Minimum amount of token1 received after burn (slippage protection)
+    /// @param to The account to receive the underlying amounts of token0 and token1
+    /// @param from Account from which to pull G-Uni LP tokens
+  constructor(pool, burnAmount, amount0Min, amount1Min, to, from) {
+    super(
+        'GUniWithdraw',
+        getAddr('GUniWithdraw'),
+        [['address', 'uint256', 'uint256', 'uint256', 'address', 'address']],
+        [[pool, burnAmount, amount0Min, amount1Min, to, from]]
+    );
+    this.mappableArgs = [
+        this.args[0][1],
+    ];
+  }
+
+  async getAssetsToApprove() {
+    return [{asset: this.args[0][0], owner: this.args[0][5]}];
+  }
+}
+
+module.exports = GUniWithdraw;

package/src/actions/guni/index.js

@@ -0,0 +1,6 @@
+const GUniDeposit = require('./GUniDeposit');
+const GUniWithdraw = require('./GUniWithdraw.js');
+module.exports = {
+    GUniDeposit,
+    GUniWithdraw,
+}

package/src/actions/index.js

@@ -12,6 +12,9 @@ const yearn = require('./yearn');
 const lido = require('./lido');
 const insta = require('./insta');
 const balancer = require('./balancer');
+const guni = require('./guni');
+const mstable = require('./mstable');
+const rari = require('./rari');
 
 module.exports = {
   maker,
@@ -28,4 +31,7 @@ module.exports = {
   lido,
   insta,
   balancer,
+  guni,
+  mstable,
+  rari,
 };

package/src/actions/mstable/MStableClaimAction.js

@@ -0,0 +1,38 @@
+const Action = require("../../Action");
+const {requireAddress} = require("../../utils/general");
+const { getAddr } = require('../../addresses.js');
+
+/**
+ * MStableClaimAction
+ */
+class MStableClaimAction extends Action {
+    /**
+     * @param vaultAddress
+     * @param to
+     * @param first
+     * @param last
+     */
+    constructor(
+        vaultAddress,
+        to,
+        first,
+        last,
+    ) {
+        requireAddress(vaultAddress);
+        requireAddress(to);
+
+        super(
+            'MStableClaim',
+            getAddr('MStableClaim'),
+            [['address', 'address', 'uint256', 'uint256']],
+            [[...arguments]],
+        );
+
+        this.mappableArgs = [
+            this.args[0][0],
+            this.args[0][1],
+        ];
+    }
+}
+
+module.exports = MStableClaimAction;

package/src/actions/mstable/MStableDepositAction.js

@@ -0,0 +1,63 @@
+const Action = require("../../Action");
+const {requireAddress} = require("../../utils/general");
+const { getAddr } = require('../../addresses.js');
+
+/**
+ * MStableDepositAction
+ */
+class MStableDepositAction extends Action {
+    /**
+     * @param bAsset
+     * @param mAsset
+     * @param saveAddress
+     * @param vaultAddress
+     * @param from
+     * @param to
+     * @param amount
+     * @param minOut
+     * @param stake
+     */
+    constructor(
+        bAsset,
+        mAsset,
+        saveAddress,
+        vaultAddress,
+        from,
+        to,
+        amount,
+        minOut,
+        stake,
+    ) {
+        requireAddress(bAsset);
+        requireAddress(mAsset);
+        requireAddress(saveAddress);
+        requireAddress(vaultAddress);
+        requireAddress(from);
+        requireAddress(to);
+
+        super(
+            'MStableDeposit',
+            getAddr('MStableDeposit'),
+            [['address', 'address', 'address', 'address', 'address', 'address', 'uint256', 'uint256', 'bool']],
+            [[...arguments]],
+        );
+
+        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],
+            this.args[0][6],
+            this.args[0][7],
+            this.args[0][8],
+        ];
+    }
+
+    async getAssetsToApprove() {
+        return [{ asset: this.args[0][0], owner: this.args[0][4]}];
+    }
+}
+
+module.exports = MStableDepositAction;