@defisaver/sdk 0.1.11 → 0.1.12

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,7 +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>Array.&lt;\*&gt;</code>
+    * [.getAccessList()](#Action+getAccessList) ⇒ [<code>AccessList</code>](#AccessList)
 
 <a name="new_Action_new"></a>
 
@@ -200,7 +205,7 @@ ETH value to be sent with transaction
 **Returns**: <code>Promise.&lt;string&gt;</code> - ETH value in wei  
 <a name="Action+getAccessList"></a>
 
-### action.getAccessList() ⇒ <code>Array.&lt;\*&gt;</code>
+### action.getAccessList() ⇒ [<code>AccessList</code>](#AccessList)
 Access list for single action
 
 **Kind**: instance method of [<code>Action</code>](#Action)  
@@ -218,7 +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>Array.&lt;\*&gt;</code>
+    * [.getAccessList()](#Recipe+getAccessList) ⇒ [<code>AccessList</code>](#AccessList)
 
 <a name="new_Recipe_new"></a>
 
@@ -265,7 +270,7 @@ ETH value to be sent with transaction
 **Returns**: <code>Promise.&lt;string&gt;</code> - ETH value in wei  
 <a name="Recipe+getAccessList"></a>
 
-### recipe.getAccessList() ⇒ <code>Array.&lt;\*&gt;</code>
+### recipe.getAccessList() ⇒ [<code>AccessList</code>](#AccessList)
 Generates an access list for the recipe
 
 **Kind**: instance method of [<code>Recipe</code>](#Recipe)  
@@ -281,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.11",
+  "version": "0.1.12",
   "description": "",
   "main": "index.js",
   "scripts": {

package/src/Action.js

@@ -1,5 +1,5 @@
 const AbiCoder = require('web3-eth-abi');
-const Web3Utils = require('web3-utils');
+const { keccak256, padLeft, toHex } = require('web3-utils');
 
 const ActionAbi = require('./abis/Action.json');
 
@@ -32,7 +32,7 @@ class Action {
    * @private
    */
   _getId() {
-    return Web3Utils.keccak256(this.name);
+    return keccak256(this.name);
   }
 
   /**
@@ -137,13 +137,16 @@ class Action {
 
   /**
    * Access list for single action
-   * @returns {Array<*>}
+   * @returns {AccessList}
    */
   getAccessList() {
     return [
       [this.contractAddress, []],
       ...(AccessLists[this.name] || []),
-    ]
+    ].map(([address, storageKeys]) => ({
+      address: address,
+      storageKeys: storageKeys.map(num => padLeft(toHex(num), 64)),
+    }));
   }
 }
 

package/src/Recipe.js

@@ -103,7 +103,7 @@ class Recipe {
 
   /**
    * Generates an access list for the recipe
-   * @returns {Array<*>}
+   * @returns {AccessList}
    */
   getAccessList() {
     const addressMapping = {
@@ -112,11 +112,14 @@ class Recipe {
     };
     this.actions.forEach((action) => {
       const accessList = action.getAccessList();
-      accessList.forEach(([address, memoryLocations]) => {
-        addressMapping[address] = new Set([...memoryLocations, ...(addressMapping[address] || [])]);
+      accessList.forEach(({ address, storageKeys }) => {
+        addressMapping[address] = new Set([...storageKeys, ...(addressMapping[address] || [])]);
       })
     });
-    return Object.keys(addressMapping).map((addr) => [addr, [...addressMapping[addr]]]);
+    return Object.keys(addressMapping).map((address) => ({
+      address,
+      storageKeys: [...addressMapping[address]],
+    }));
   }
 }
 

package/src/types.js

@@ -7,3 +7,14 @@
  * Maker vault ID
  * @typedef {(string|number)} VaultId
  */
+
+/**
+ * Access list item
+ * @typedef {Object} AccessListItem
+ * @property {string} address
+ * @property {Array<string>} storageKeys
+ */
+
+/**
+ * @typedef {Array<AccessListItem>} AccessList
+ */

package/test/accessLists/Recipe.js

@@ -1,5 +1,5 @@
 const AbiCoder = require('web3-eth-abi');
-const { BN } = require('web3-utils');
+const { BN, padLeft, toHex } = require('web3-utils');
 const {getAssetInfo, utils: {compare}} = require("@defisaver/tokens");
 const Action = require('../../src/Action');
 const {getAddr} = require('../../src/addresses');
@@ -103,7 +103,7 @@ class Recipe {
 
   /**
    * Generates an access list for the recipe
-   * @returns {Array<*>}
+   * @returns {AccessList}
    */
   getAccessList() {
     const addressMapping = {
@@ -111,12 +111,15 @@ class Recipe {
       [getAddr('DFSRegistry')]: [],
     };
     this.actions.forEach((action) => {
-      const accessList = MockAccessLists[action.name];
-      accessList.forEach(([address, memoryLocations]) => {
-        addressMapping[address] = new Set([...memoryLocations, ...(addressMapping[address] || [])]);
+      const accessList = MockAccessLists[action.name].map(([address, storageKeys]) => ({ address, storageKeys: storageKeys.map(num => padLeft(toHex(num), 64)) }));
+      accessList.forEach(({ address, storageKeys }) => {
+        addressMapping[address] = new Set([...storageKeys, ...(addressMapping[address] || [])]);
       })
     });
-    return Object.keys(addressMapping).map((addr) => [addr, [...addressMapping[addr]]]);
+    return Object.keys(addressMapping).map((address) => ({
+      address,
+      storageKeys: [...addressMapping[address]],
+    }));
   }
 }
 

package/test/accessLists/access-lists.js

@@ -2,18 +2,19 @@ const { assert } = require("chai");
 const dfs = require("../../index.js");
 const Recipe = require("./Recipe");
 const MockAccessLists = require('./MockAccessLists');
+const { padLeft, toHex } = require('web3-utils');
 
 const testDuplicates = (accessList) => {
     const contractAddrs = accessList.map((entry) => {
         assert(
-            entry[1].length == [...new Set(entry[1])].length,
+            entry.storageKeys.length === [...new Set(entry.storageKeys)].length,
             'Duplicate storage address found',
         );
-        return entry[0];
+        return entry.address;
     })
 
     assert(
-        accessList.length == [...new Set(contractAddrs)].length,
+        accessList.length === [...new Set(contractAddrs)].length,
         'Duplicate contract address found',
     );
 
@@ -22,15 +23,20 @@ const testDuplicates = (accessList) => {
 
 const testInclusion = (recipe, accessList) => {
     const actions = recipe.actions;
-    const addressMapping = Object.fromEntries(accessList);
+    const addressMapping = accessList.reduce((list, current) => {
+      list[current.address] = current.storageKeys;
+      return list;
+    }, {});
     actions.forEach((action) => {
-        MockAccessLists[action.name].forEach((entry) => {
-            const storageAddrs = new Set(addressMapping[entry[0]]);
+        MockAccessLists[action.name]
+          .map(([address, storageKeys]) => ({ address, storageKeys: storageKeys.map(num => padLeft(toHex(num), 64)) }))
+          .forEach((entry) => {
+            const storageAddrs = new Set(addressMapping[entry.address]);
             assert(
                 storageAddrs,
                 'Access list missing a contract address',
             );
-            entry[1].forEach((addr) => {
+            entry.storageKeys.forEach((addr) => {
                 assert(
                     storageAddrs.has(addr),
                     'Access list missing a storage address',
@@ -79,7 +85,8 @@ describe('Access-Lists', () => {
     sampleRecipes.forEach((recipe) => {
         it(`... should make an access list for recipe ${recipe.name}`, () => {
             const recipeAccessList = recipe.getAccessList();
-            testDuplicates(recipeAccessList);
+          console.log(recipeAccessList);
+          testDuplicates(recipeAccessList);
             testInclusion(recipe, recipeAccessList);
         });
     });