@defisaver/positions-sdk 0.0.181 → 0.0.182

package/.mocharc.json

@@ -1,4 +1,4 @@
-{
-    "require": "ts-node/register",
-    "extension": ["ts"]
-}
+{
+    "require": "ts-node/register",
+    "extension": ["ts"]
+}

package/.nvmrc

@@ -1 +1 @@
-v20.17.0
+v20.17.0

package/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Attach by Process ID",
+      "processId": "${command:PickProcess}",
+      "request": "attach",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "type": "node"
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,37 @@
+{
+  "workbench.colorCustomizations": {
+    "activityBar.activeBackground": "#f2255a",
+    "activityBar.background": "#f2255a",
+    "activityBar.foreground": "#e7e7e7",
+    "activityBar.inactiveForeground": "#e7e7e799",
+    "activityBarBadge.background": "#40d30d",
+    "activityBarBadge.foreground": "#15202b",
+    "commandCenter.border": "#e7e7e799",
+    "sash.hoverBorder": "#f2255a",
+    "statusBar.background": "#d70d41",
+    "statusBar.foreground": "#e7e7e7",
+    "statusBarItem.hoverBackground": "#f2255a",
+    "statusBarItem.remoteBackground": "#d70d41",
+    "statusBarItem.remoteForeground": "#e7e7e7",
+    "titleBar.activeBackground": "#d70d41",
+    "titleBar.activeForeground": "#e7e7e7",
+    "titleBar.inactiveBackground": "#d70d4199",
+    "titleBar.inactiveForeground": "#e7e7e799"
+  },
+  "peacock.color": "#d70d41",
+  "editor.defaultFormatter": "dbaeumer.vscode-eslint",
+  "eslint.format.enable": true,
+
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  }
+}

package/README.md

@@ -1,69 +1,69 @@
-# DeFi Saver Positions SDK
-
-Supported protocols: 
-- [Maker](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/maker)
-- [Spark](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/spark)
-- [CrvUSD](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/curveUsd)
-- [Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV2)
-- [Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV3)
-- [Morpho Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/morphoAaveV2)
-- [Morpho Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/morphoAaveV3)
-- [Compound V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV2)
-- [Compound V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV3)
-- [Liquity](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/liquity)
-- [Chicken Bonds](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/chickenBonds)
-
-## Setup
-Supported Node version is v10.
-
-- run `npm install` (first time)
-- run `npm run build`
-
-`build` command will generate contracts and build ejs and esm folders
-
-## How to use
-[All available imports](https://github.com/defisaver/defisaver-positions-sdk/blob/main/src/index.ts)
-
-This is a Compound V3 example, and every other protocol is similar
-```js
-import Web3 from 'web3';
-import { compoundV3 } from '@defisaver/positions-sdk';
-
-
-// every protocol has market data and user data getters
-const {
-    getCompoundV3MarketsData,
-    getCompoundV3AccountData,
-} = compoundV3;
-
-const provider = 'Your RPC provider';
-const web3 = new Web3(provider);
-
-const user = '0x123...';
-
-const { assetsData } = await getCompoundV3MarketsData(
-    web3, // rpc for the network you are using (note: can be tenderly or any other testnet rpc)
-    1, // network
-    selectedMarket, // market object like in /src/markets/compound/index.ts
-    web3, // this must be mainnet rpc - used for getting prices onchain and calculating apys
-);
-
-const userData = await getCompoundV3AccountData(
-    web3,
-    1, // network
-    userAddress, // EOA or DSProxy
-    '', // proxy address of the user, or just empty string if checking for EOA
-    {
-        selectedMarket, // market object as in /src/markets/compound/index.ts
-        assetsData,
-    }
-);
-```
-
-More examples found [here](https://github.com/defisaver/defisaver-positions-sdk/tree/main/tests)
-
-## Testing
-
-`npm run test` - Run all tests
-
-`npm run test-single --name=your_test_name` - Run single test for specified name e.g. for MyTest.js test name is MyTest
+# DeFi Saver Positions SDK
+
+Supported protocols: 
+- [Maker](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/maker)
+- [Spark](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/spark)
+- [CrvUSD](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/curveUsd)
+- [Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV2)
+- [Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/aaveV3)
+- [Morpho Aave V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/morphoAaveV2)
+- [Morpho Aave V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/morphoAaveV3)
+- [Compound V2](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV2)
+- [Compound V3](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/compoundV3)
+- [Liquity](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/liquity)
+- [Chicken Bonds](https://github.com/defisaver/defisaver-positions-sdk/tree/main/src/chickenBonds)
+
+## Setup
+Supported Node version is v10.
+
+- run `npm install` (first time)
+- run `npm run build`
+
+`build` command will generate contracts and build ejs and esm folders
+
+## How to use
+[All available imports](https://github.com/defisaver/defisaver-positions-sdk/blob/main/src/index.ts)
+
+This is a Compound V3 example, and every other protocol is similar
+```js
+import Web3 from 'web3';
+import { compoundV3 } from '@defisaver/positions-sdk';
+
+
+// every protocol has market data and user data getters
+const {
+    getCompoundV3MarketsData,
+    getCompoundV3AccountData,
+} = compoundV3;
+
+const provider = 'Your RPC provider';
+const web3 = new Web3(provider);
+
+const user = '0x123...';
+
+const { assetsData } = await getCompoundV3MarketsData(
+    web3, // rpc for the network you are using (note: can be tenderly or any other testnet rpc)
+    1, // network
+    selectedMarket, // market object like in /src/markets/compound/index.ts
+    web3, // this must be mainnet rpc - used for getting prices onchain and calculating apys
+);
+
+const userData = await getCompoundV3AccountData(
+    web3,
+    1, // network
+    userAddress, // EOA or DSProxy
+    '', // proxy address of the user, or just empty string if checking for EOA
+    {
+        selectedMarket, // market object as in /src/markets/compound/index.ts
+        assetsData,
+    }
+);
+```
+
+More examples found [here](https://github.com/defisaver/defisaver-positions-sdk/tree/main/tests)
+
+## Testing
+
+`npm run test` - Run all tests
+
+`npm run test-single --name=your_test_name` - Run single test for specified name e.g. for MyTest.js test name is MyTest

package/cjs/aaveV3/index.js

@@ -198,6 +198,7 @@ function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                 _market.supplyIncentives.push({
                     apy: _market.incentiveSupplyApy || '0',
                     token: _market.symbol,
+                    incentiveKind: 'staking',
                 });
             }
             if (_market.canBeBorrowed && _market.incentiveSupplyApy) {
@@ -209,6 +210,7 @@ function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                 _market.borrowIncentives.push({
                     apy: _market.incentiveBorrowApy,
                     token: _market.incentiveBorrowToken,
+                    incentiveKind: 'reward',
                 });
             }
             if (!rewardForMarket)
@@ -238,6 +240,7 @@ function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                     _market.supplyIncentives.push({
                         token: supplyRewardData.rewardTokenSymbol,
                         apy: rewardApy,
+                        incentiveKind: 'reward',
                     });
                 }
             });
@@ -265,6 +268,7 @@ function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                     _market.borrowIncentives.push({
                         token: borrowRewardData.rewardTokenSymbol,
                         apy: rewardApy,
+                        incentiveKind: 'reward',
                     });
                 }
             });

package/cjs/types/aave.d.ts

@@ -76,6 +76,7 @@ export interface MorphoAaveV2AssetData extends AaveV2AssetData {
 export interface IncentiveData {
     token: string;
     apy: string;
+    incentiveKind?: 'staking' | 'reward';
 }
 export interface AaveV3AssetData extends AaveAssetData {
     isIsolated: boolean;

package/esm/aaveV3/index.js

@@ -189,6 +189,7 @@ export function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                 _market.supplyIncentives.push({
                     apy: _market.incentiveSupplyApy || '0',
                     token: _market.symbol,
+                    incentiveKind: 'staking',
                 });
             }
             if (_market.canBeBorrowed && _market.incentiveSupplyApy) {
@@ -200,6 +201,7 @@ export function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                 _market.borrowIncentives.push({
                     apy: _market.incentiveBorrowApy,
                     token: _market.incentiveBorrowToken,
+                    incentiveKind: 'reward',
                 });
             }
             if (!rewardForMarket)
@@ -229,6 +231,7 @@ export function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                     _market.supplyIncentives.push({
                         token: supplyRewardData.rewardTokenSymbol,
                         apy: rewardApy,
+                        incentiveKind: 'reward',
                     });
                 }
             });
@@ -256,6 +259,7 @@ export function getAaveV3MarketData(web3, network, market, defaultWeb3) {
                     _market.borrowIncentives.push({
                         token: borrowRewardData.rewardTokenSymbol,
                         apy: rewardApy,
+                        incentiveKind: 'reward',
                     });
                 }
             });

package/esm/types/aave.d.ts

@@ -76,6 +76,7 @@ export interface MorphoAaveV2AssetData extends AaveV2AssetData {
 export interface IncentiveData {
     token: string;
     apy: string;
+    incentiveKind?: 'staking' | 'reward';
 }
 export interface AaveV3AssetData extends AaveAssetData {
     isIsolated: boolean;

package/package.json

@@ -1,49 +1,49 @@
-{
-  "name": "@defisaver/positions-sdk",
-  "version": "0.0.181",
-  "description": "",
-  "main": "./cjs/index.js",
-  "module": "./esm/index.js",
-  "types": "./esm/index.d.ts",
-  "scripts": {
-    "build:esm": "rm -rf esm && tsc -p tsconfig.esm.json",
-    "build:cjs": "rm -rf cjs && tsc -p tsconfig.cjs.json",
-    "build": "npm run lint && npm run generate-contracts && npm run build:cjs && npm run build:esm",
-    "dev": "npm run generate-contracts && tsc -p tsconfig.json --watch",
-    "lint": "eslint src/ --fix",
-    "lint-check": "eslint src/",
-    "generate-contracts": "node scripts/generateContracts.js",
-    "test": "mocha tests/*",
-    "test-single": "mocha ./tests/$npm_config_name.ts",
-    "test:debugger": "mocha --inspect-brk tests/*",
-    "build-test": "npm run build && npm run test",
-    "version-bump": "git commit -am \"Version bump to $(npm version patch | cut -c 2-)\""
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@defisaver/tokens": "^1.5.50",
-    "@ethersproject/bignumber": "^5.7.0",
-    "@morpho-org/morpho-aave-v3-sdk": "^1.5.3",
-    "decimal.js": "^10.4.3"
-  },
-  "devDependencies": {
-    "@defisaver/eslint-config": "^1.0.1",
-    "@types/chai": "^5.0.0",
-    "@types/mocha": "^10.0.9",
-    "@types/web3": "^1.0.20",
-    "chai": "^4.3.8",
-    "dotenv": "^16.3.1",
-    "eslint": "^8.49.0",
-    "eslint-plugin-import": "^2.31.0",
-    "mocha": "^10.2.0",
-    "ts-node": "^10.9.2",
-    "typechain": "^8.3.1",
-    "typechain-target-web3-v1-3mihai3": "^6.0.2",
-    "typescript": "^5.2.2"
-  },
-  "peerDependencies": {
-    "web3": "^1.10.2"
-  }
-}
+{
+  "name": "@defisaver/positions-sdk",
+  "version": "0.0.182",
+  "description": "",
+  "main": "./cjs/index.js",
+  "module": "./esm/index.js",
+  "types": "./esm/index.d.ts",
+  "scripts": {
+    "build:esm": "rm -rf esm && tsc -p tsconfig.esm.json",
+    "build:cjs": "rm -rf cjs && tsc -p tsconfig.cjs.json",
+    "build": "npm run lint && npm run generate-contracts && npm run build:cjs && npm run build:esm",
+    "dev": "npm run generate-contracts && tsc -p tsconfig.json --watch",
+    "lint": "eslint src/ --fix",
+    "lint-check": "eslint src/",
+    "generate-contracts": "node scripts/generateContracts.js",
+    "test": "mocha tests/*",
+    "test-single": "mocha ./tests/$npm_config_name.ts",
+    "test:debugger": "mocha --inspect-brk tests/*",
+    "build-test": "npm run build && npm run test",
+    "version-bump": "git commit -am \"Version bump to $(npm version patch | cut -c 2-)\""
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@defisaver/tokens": "^1.5.50",
+    "@ethersproject/bignumber": "^5.7.0",
+    "@morpho-org/morpho-aave-v3-sdk": "^1.5.3",
+    "decimal.js": "^10.4.3"
+  },
+  "devDependencies": {
+    "@defisaver/eslint-config": "^1.0.1",
+    "@types/chai": "^5.0.0",
+    "@types/mocha": "^10.0.9",
+    "@types/web3": "^1.0.20",
+    "chai": "^4.3.8",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.49.0",
+    "eslint-plugin-import": "^2.31.0",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.9.2",
+    "typechain": "^8.3.1",
+    "typechain-target-web3-v1-3mihai3": "^6.0.2",
+    "typescript": "^5.2.2"
+  },
+  "peerDependencies": {
+    "web3": "^1.10.2"
+  }
+}