@defisaver/sdk 1.3.5 → 1.3.6-dev.1

package/esm/src/Recipe.js

@@ -1,206 +1,206 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _Recipe_instances, _Recipe__encodeForCall;
-import AbiCoder from 'web3-eth-abi';
-import { toBN } from 'web3-utils';
-import { getAssetInfo, compare } from '@defisaver/tokens';
-import { Action } from './Action';
-import { getAddr } from './addresses';
-import RecipeAbi from './abis/Recipe.json';
-import { CONFIG, actionsWithSwap, txSaverSupportedActions, } from './config';
-/**
- * Set of Actions to be performed sequentially in a single transaction
- *
- * @category Base Classes
- */
-export class Recipe {
-    /**
-     * @param name
-     * @param actions
-     */
-    constructor(name, actions = []) {
-        _Recipe_instances.add(this);
-        actions.forEach((action) => {
-            if (!(action instanceof Action))
-                throw new TypeError('Supplied action does not inherit Action');
-        });
-        this.name = name;
-        this.actions = actions;
-        this.extraGas = 0;
-        this.recipeExecutorAddress = getAddr('RecipeExecutor', CONFIG.chainId);
-    }
-    /**
-     * @param action
-     */
-    addAction(action) {
-        if (!(action instanceof Action))
-            throw new TypeError('Supplied action does not inherit Action');
-        this.actions.push(action);
-        return this;
-    }
-    /**
-     * Encode arguments for calling the action set via DsProxy
-     * @returns `address` & `data` to be passed on to DSProxy's `execute(address _target, bytes memory _data)`
-     */
-    encodeForDsProxyCall() {
-        const executeTaskAbi = RecipeAbi.find(({ name }) => name === 'executeRecipe');
-        const encoded = __classPrivateFieldGet(this, _Recipe_instances, "m", _Recipe__encodeForCall).call(this);
-        return [
-            this.recipeExecutorAddress,
-            // @ts-expect-error Interface of AbiCoder is wrong :(
-            AbiCoder.encodeFunctionCall(executeTaskAbi, encoded),
-        ];
-    }
-    /**
-     * Finds all actions from recipe that have a swap.
-     */
-    getSwapActions() {
-        return this.actions.filter((action) => !!actionsWithSwap.find(({ name }) => action.name === name));
-    }
-    getTxSaverSupportedSwapActions() {
-        return this.actions.filter((action) => !!txSaverSupportedActions.find(({ name }) => action.name === name));
-    }
-    getTxSaverOrderData() {
-        var _a;
-        const actionsWithOrder = this.getTxSaverSupportedSwapActions();
-        if (actionsWithOrder.length !== 1) {
-            throw new Error('TxSaver order data error: Only recipes with one sell action are supported for taking fee from position.');
-        }
-        const action = actionsWithOrder[0];
-        const orderDataParamIndex = (_a = actionsWithSwap.find(({ name }) => action.name === name)) === null || _a === void 0 ? void 0 : _a.swapArgIndex;
-        const orderData = action.args[orderDataParamIndex];
-        const fromAsset = orderData[0];
-        const toAsset = orderData[1];
-        const fromAmount = orderData[2];
-        return {
-            fromAsset,
-            toAsset,
-            fromAmount,
-        };
-    }
-    /**
-     * Check if recipe can be encoded for taking fee from position in TxSaver tx
-     * @returns boolean
-     */
-    canEncodeForTxSaverCall() {
-        const actionsWithOrder = this.getTxSaverSupportedSwapActions();
-        return actionsWithOrder.length === 1;
-    }
-    /**
-     * Encode arguments for calling tx saver functions inside recipe executor
-     * @param data tx saver user signed data
-     * @returns recipe executor addr and 'data' to be passed to Safe
-     */
-    encodeForTxSaverCall(data) {
-        if (data.shouldTakeFeeFromPosition) {
-            if (!this.canEncodeForTxSaverCall()) {
-                throw new Error('TxSaver encoding error: Only recipes with sell actions are supported for taking fee from position.');
-            }
-        }
-        const executeTaskAbi = RecipeAbi.find(({ name }) => name === 'executeRecipeFromTxSaver');
-        const encodedRecipe = __classPrivateFieldGet(this, _Recipe_instances, "m", _Recipe__encodeForCall).call(this)[0];
-        const encodedTxSaverData = [
-            data.maxTxCostInFeeToken,
-            data.feeToken,
-            data.tokenPriceInEth,
-            data.deadline,
-            data.shouldTakeFeeFromPosition,
-        ];
-        return [
-            this.recipeExecutorAddress,
-            // @ts-expect-error Interface of AbiCoder is wrong :(
-            AbiCoder.encodeFunctionCall(executeTaskAbi, [encodedRecipe, encodedTxSaverData]),
-        ];
-    }
-    /**
-     * Logs parameter mapping in verbose format for validation. Used for testing in development.
-     */
-    _validateParamMappings() {
-        this.actions.forEach((action, i) => {
-            action._getArgumentMapping().forEach((source, j) => {
-                if (source)
-                    console.log(`${this.actions[i].name} takes argument #${j + 1} from ${this.actions[source - 1].name} (action #${source})`);
-            });
-        });
-    }
-    /**
-     * Assets requiring approval to be used by DsProxy
-     * Approval is done from owner to DsProxy
-     */
-    getAssetsToApprove() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const uniqueAssetOwnerPairs = [];
-            const assetOwnerPairs = yield Promise.all(this.actions.map(a => a.getAssetsToApprove()));
-            for (const pairsPerAction of assetOwnerPairs) {
-                for (const pair of pairsPerAction) {
-                    const isNft = !pair.asset;
-                    if (!uniqueAssetOwnerPairs.find(_pair => _pair.owner === pair.owner && (isNft ? _pair.tokenId === pair.tokenId : _pair.asset === pair.asset))) {
-                        if (isNft) {
-                            uniqueAssetOwnerPairs.push({
-                                owner: pair.owner,
-                                nft: pair.nft,
-                                tokenId: pair.tokenId,
-                                specialApproveLabel: pair.specialApproveLabel,
-                            });
-                        }
-                        else {
-                            uniqueAssetOwnerPairs.push({ owner: pair.owner, asset: pair.asset, specialApproveLabel: pair.specialApproveLabel });
-                        }
-                    }
-                }
-            }
-            return uniqueAssetOwnerPairs.filter(({ asset }) => !compare(asset, getAssetInfo('ETH').address));
-        });
-    }
-    /**
-     * ETH value to be sent with transaction
-     * @returns ETH value in wei
-     */
-    getEthValue() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return (yield Promise.all(this.actions.map(a => a.getEthValue())))
-                .reduce((acc, val) => acc.add(toBN(val)), toBN(0))
-                .toString();
-        });
-    }
-    /**
-     * Generates an access list for the recipe
-     */
-    getAccessList() {
-        const addressMapping = {
-            [getAddr('RecipeExecutor', CONFIG.chainId)]: [],
-            [getAddr('DFSRegistry', CONFIG.chainId)]: [],
-        };
-        this.actions.forEach((action) => {
-            const accessList = action.getAccessList(CONFIG.chainId);
-            accessList.forEach(({ address, storageKeys }) => {
-                addressMapping[address] = new Set([...storageKeys, ...(addressMapping[address] || [])]);
-            });
-        });
-        return Object.keys(addressMapping).map((address) => ({
-            address,
-            storageKeys: [...addressMapping[address]],
-        }));
-    }
-}
-_Recipe_instances = new WeakSet(), _Recipe__encodeForCall = function _Recipe__encodeForCall() {
-    const encoded = this.actions.map(action => action.encodeForRecipe());
-    const transposed = encoded[0].map((_, colIndex) => encoded.map(row => row[colIndex]));
-    const taskStruct = [
-        this.name,
-        ...transposed,
-    ];
-    return [taskStruct];
-};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Recipe_instances, _Recipe__encodeForCall;
+import AbiCoder from 'web3-eth-abi';
+import { toBN } from 'web3-utils';
+import { getAssetInfo, compare } from '@defisaver/tokens';
+import { Action } from './Action';
+import { getAddr } from './addresses';
+import RecipeAbi from './abis/Recipe.json';
+import { CONFIG, actionsWithSwap, txSaverSupportedActions, } from './config';
+/**
+ * Set of Actions to be performed sequentially in a single transaction
+ *
+ * @category Base Classes
+ */
+export class Recipe {
+    /**
+     * @param name
+     * @param actions
+     */
+    constructor(name, actions = []) {
+        _Recipe_instances.add(this);
+        actions.forEach((action) => {
+            if (!(action instanceof Action))
+                throw new TypeError('Supplied action does not inherit Action');
+        });
+        this.name = name;
+        this.actions = actions;
+        this.extraGas = 0;
+        this.recipeExecutorAddress = getAddr('RecipeExecutor', CONFIG.chainId);
+    }
+    /**
+     * @param action
+     */
+    addAction(action) {
+        if (!(action instanceof Action))
+            throw new TypeError('Supplied action does not inherit Action');
+        this.actions.push(action);
+        return this;
+    }
+    /**
+     * Encode arguments for calling the action set via DsProxy
+     * @returns `address` & `data` to be passed on to DSProxy's `execute(address _target, bytes memory _data)`
+     */
+    encodeForDsProxyCall() {
+        const executeTaskAbi = RecipeAbi.find(({ name }) => name === 'executeRecipe');
+        const encoded = __classPrivateFieldGet(this, _Recipe_instances, "m", _Recipe__encodeForCall).call(this);
+        return [
+            this.recipeExecutorAddress,
+            // @ts-expect-error Interface of AbiCoder is wrong :(
+            AbiCoder.encodeFunctionCall(executeTaskAbi, encoded),
+        ];
+    }
+    /**
+     * Finds all actions from recipe that have a swap.
+     */
+    getSwapActions() {
+        return this.actions.filter((action) => !!actionsWithSwap.find(({ name }) => action.name === name));
+    }
+    getTxSaverSupportedSwapActions() {
+        return this.actions.filter((action) => !!txSaverSupportedActions.find(({ name }) => action.name === name));
+    }
+    getTxSaverOrderData() {
+        var _a;
+        const actionsWithOrder = this.getTxSaverSupportedSwapActions();
+        if (actionsWithOrder.length !== 1) {
+            throw new Error('TxSaver order data error: Only recipes with one sell action are supported for taking fee from position.');
+        }
+        const action = actionsWithOrder[0];
+        const orderDataParamIndex = (_a = actionsWithSwap.find(({ name }) => action.name === name)) === null || _a === void 0 ? void 0 : _a.swapArgIndex;
+        const orderData = action.args[orderDataParamIndex];
+        const fromAsset = orderData[0];
+        const toAsset = orderData[1];
+        const fromAmount = orderData[2];
+        return {
+            fromAsset,
+            toAsset,
+            fromAmount,
+        };
+    }
+    /**
+     * Check if recipe can be encoded for taking fee from position in TxSaver tx
+     * @returns boolean
+     */
+    canEncodeForTxSaverCall() {
+        const actionsWithOrder = this.getTxSaverSupportedSwapActions();
+        return actionsWithOrder.length === 1;
+    }
+    /**
+     * Encode arguments for calling tx saver functions inside recipe executor
+     * @param data tx saver user signed data
+     * @returns recipe executor addr and 'data' to be passed to Safe
+     */
+    encodeForTxSaverCall(data) {
+        if (data.shouldTakeFeeFromPosition) {
+            if (!this.canEncodeForTxSaverCall()) {
+                throw new Error('TxSaver encoding error: Only recipes with sell actions are supported for taking fee from position.');
+            }
+        }
+        const executeTaskAbi = RecipeAbi.find(({ name }) => name === 'executeRecipeFromTxSaver');
+        const encodedRecipe = __classPrivateFieldGet(this, _Recipe_instances, "m", _Recipe__encodeForCall).call(this)[0];
+        const encodedTxSaverData = [
+            data.maxTxCostInFeeToken,
+            data.feeToken,
+            data.tokenPriceInEth,
+            data.deadline,
+            data.shouldTakeFeeFromPosition,
+        ];
+        return [
+            this.recipeExecutorAddress,
+            // @ts-expect-error Interface of AbiCoder is wrong :(
+            AbiCoder.encodeFunctionCall(executeTaskAbi, [encodedRecipe, encodedTxSaverData]),
+        ];
+    }
+    /**
+     * Logs parameter mapping in verbose format for validation. Used for testing in development.
+     */
+    _validateParamMappings() {
+        this.actions.forEach((action, i) => {
+            action._getArgumentMapping().forEach((source, j) => {
+                if (source)
+                    console.log(`${this.actions[i].name} takes argument #${j + 1} from ${this.actions[source - 1].name} (action #${source})`);
+            });
+        });
+    }
+    /**
+     * Assets requiring approval to be used by DsProxy
+     * Approval is done from owner to DsProxy
+     */
+    getAssetsToApprove() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const uniqueAssetOwnerPairs = [];
+            const assetOwnerPairs = yield Promise.all(this.actions.map(a => a.getAssetsToApprove()));
+            for (const pairsPerAction of assetOwnerPairs) {
+                for (const pair of pairsPerAction) {
+                    const isNft = !pair.asset;
+                    if (!uniqueAssetOwnerPairs.find(_pair => _pair.owner === pair.owner && (isNft ? _pair.tokenId === pair.tokenId : _pair.asset === pair.asset))) {
+                        if (isNft) {
+                            uniqueAssetOwnerPairs.push({
+                                owner: pair.owner,
+                                nft: pair.nft,
+                                tokenId: pair.tokenId,
+                                specialApproveLabel: pair.specialApproveLabel,
+                            });
+                        }
+                        else {
+                            uniqueAssetOwnerPairs.push({ owner: pair.owner, asset: pair.asset, specialApproveLabel: pair.specialApproveLabel });
+                        }
+                    }
+                }
+            }
+            return uniqueAssetOwnerPairs.filter(({ asset }) => !compare(asset, getAssetInfo('ETH').address));
+        });
+    }
+    /**
+     * ETH value to be sent with transaction
+     * @returns ETH value in wei
+     */
+    getEthValue() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield Promise.all(this.actions.map(a => a.getEthValue())))
+                .reduce((acc, val) => acc.add(toBN(val)), toBN(0))
+                .toString();
+        });
+    }
+    /**
+     * Generates an access list for the recipe
+     */
+    getAccessList() {
+        const addressMapping = {
+            [getAddr('RecipeExecutor', CONFIG.chainId)]: [],
+            [getAddr('DFSRegistry', CONFIG.chainId)]: [],
+        };
+        this.actions.forEach((action) => {
+            const accessList = action.getAccessList(CONFIG.chainId);
+            accessList.forEach(({ address, storageKeys }) => {
+                addressMapping[address] = new Set([...storageKeys, ...(addressMapping[address] || [])]);
+            });
+        });
+        return Object.keys(addressMapping).map((address) => ({
+            address,
+            storageKeys: [...addressMapping[address]],
+        }));
+    }
+}
+_Recipe_instances = new WeakSet(), _Recipe__encodeForCall = function _Recipe__encodeForCall() {
+    const encoded = this.actions.map(action => action.encodeForRecipe());
+    const transposed = encoded[0].map((_, colIndex) => encoded.map(row => row[colIndex]));
+    const taskStruct = [
+        this.name,
+        ...transposed,
+    ];
+    return [taskStruct];
+};

package/esm/src/Strategy.d.ts

@@ -1,19 +1,19 @@
-import { Action } from './Action';
-/**
- *
- * @category Base Classes
- */
-export declare class Strategy {
-    name: string;
-    subSlots: any;
-    actions: Array<Action>;
-    triggers: Array<Action>;
-    numSubSlots: number;
-    constructor(name: string);
-    addSubSlot(name: string, type: string): void;
-    addTrigger(newTrigger: Action): void;
-    addAction(newAction: Action): void;
-    print(): void;
-    getSubSlots(): any;
-    encodeForDsProxyCall(): (string | string[] | number[][])[];
-}
+import { Action } from './Action';
+/**
+ *
+ * @category Base Classes
+ */
+export declare class Strategy {
+    name: string;
+    subSlots: any;
+    actions: Array<Action>;
+    triggers: Array<Action>;
+    numSubSlots: number;
+    constructor(name: string);
+    addSubSlot(name: string, type: string): void;
+    addTrigger(newTrigger: Action): void;
+    addAction(newAction: Action): void;
+    print(): void;
+    getSubSlots(): any;
+    encodeForDsProxyCall(): (string | string[] | number[][])[];
+}

package/esm/src/Strategy.js

@@ -1,47 +1,47 @@
-/**
- *
- * @category Base Classes
- */
-export 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;
-    }
-    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,
-        ];
-    }
-}
+/**
+ *
+ * @category Base Classes
+ */
+export 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;
+    }
+    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,
+        ];
+    }
+}