From 6fb3595cf7e4d98d048254ee1e07cd9a7e1f6019 Mon Sep 17 00:00:00 2001
From: akiraonstarknet <zkdice@proton.me>
Date: Mon, 5 Aug 2024 17:00:01 +0530
Subject: [PATCH] add strkfarm tvl

---
 projects/strkfarm/erc4626.js | 47 +++++++++++++++++++++
 projects/strkfarm/index.js   | 79 ++++++++++++++++++++++++++++++++++++
 projects/strkfarm/sensei.js  | 41 +++++++++++++++++++
 3 files changed, 167 insertions(+)
 create mode 100644 projects/strkfarm/erc4626.js
 create mode 100644 projects/strkfarm/index.js
 create mode 100644 projects/strkfarm/sensei.js

diff --git a/projects/strkfarm/erc4626.js b/projects/strkfarm/erc4626.js
new file mode 100644
index 000000000000..95195f63aafe
--- /dev/null
+++ b/projects/strkfarm/erc4626.js
@@ -0,0 +1,47 @@
+const ERC4626Abi = [   
+    {
+        "name": "asset",
+        "type": "function",
+        "inputs": [],
+        "outputs": [
+          {
+            "type": "core::starknet::contract_address::ContractAddress"
+          }
+        ],
+        "state_mutability": "view"
+    },
+    {
+        "name": "balanceOf",
+        "type": "function",
+        "inputs": [
+          {
+            "name": "account",
+            "type": "core::starknet::contract_address::ContractAddress"
+          }
+        ],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
+    },
+    {
+        "name": "total_assets",
+        "type": "function",
+        "inputs": [],
+        "outputs": [
+          {
+            "type": "core::integer::u256"
+          }
+        ],
+        "state_mutability": "view"
+    }
+]
+
+const ERC4626AbiMap = {}
+ERC4626Abi.forEach(i => ERC4626AbiMap[i.name] = i)
+
+module.exports = {
+  ERC4626AbiMap
+}
\ No newline at end of file
diff --git a/projects/strkfarm/index.js b/projects/strkfarm/index.js
new file mode 100644
index 000000000000..759e6c8f5c7e
--- /dev/null
+++ b/projects/strkfarm/index.js
@@ -0,0 +1,79 @@
+/**
+ * STRKFarm is a yield aggregator and strategy builder on Starknet
+ * - We use various DeFi protocols on starknet to design yield strategies
+ */
+
+const { multiCall } = require("../helper/chain/starknet");
+const ADDRESSES = require('../helper/coreAssets.json');
+const { ERC4626AbiMap } = require('./erc4626');
+const { ERC721StratAbiMap } = require('./sensei');
+
+const STRATEGIES = {
+    "AutoCompounding": [{ // auto-compounds user tokens (e.g. STRK) by investing in zkLend
+        address: "0x00541681b9ad63dff1b35f79c78d8477f64857de29a27902f7298f7b620838ea", // STRK Auto-compounding
+        token: ADDRESSES.starknet.STRK
+    }, {
+        address: "0x016912b22d5696e95ffde888ede4bd69fbbc60c5f873082857a47c543172694f", // USDC Auto-compounding
+        token: ADDRESSES.starknet.USDC
+    }],
+    "Sensei": [{ // strategy using delta neutral looping across zklend and nostra protocols
+        address: "0x020d5fc4c9df4f943ebb36078e703369c04176ed00accf290e8295b659d2cea6", // STRK Sensei
+        token: ADDRESSES.starknet.STRK,
+        zToken: '0x06d8fa671ef84f791b7f601fa79fea8f6ceb70b5fa84189e3159d532162efc21'
+    }, {
+        address: "0x04937b58e05a3a2477402d1f74e66686f58a61a5070fcc6f694fb9a0b3bae422",
+        token: ADDRESSES.starknet.USDC, // USDC Sensei
+        zToken: '0x047ad51726d891f972e74e4ad858a261b43869f7126ce7436ee0b2529a98f486'
+    }]
+}
+
+// returns tvl and token of the AutoCompounding strategies
+async function computeAutoCompoundingTVL(api) {
+    const contracts = STRATEGIES.AutoCompounding;
+    // though these will be zToken (i.e. zkLend token, e.g. zUSDC), 
+    // according to zkLend, 1zToken = 1 underlying token
+    // so, 1 zSTRK == 1 STRK, 1 zUSDC == 1 USDC
+    const totalAssets = await multiCall({
+        calls: contracts.map(c => c.address),
+        abi: ERC4626AbiMap.total_assets
+    });
+
+    api.addTokens(contracts.map(c => c.token), totalAssets);
+}
+
+// returns tvl and token of the Sensei strategies
+async function computeSenseiTVL(api) {
+    // Sensei strategies contain multiple LP tokens in each contract bcz of looping and borrow,
+    // but we only consider the zToken bal divided by a factor (to offset looping) as TVL
+    // - This is bcz any deposit by user first gets deposited into zkLend for zToken
+    const contracts = STRATEGIES.Sensei;
+    const settings = await multiCall({
+        calls: contracts.map(c => c.address),
+        abi: ERC721StratAbiMap.get_settings
+    });
+
+    const DENOMINATOR_FACTOR = 1000000n;
+    const offsetFactors = settings.map(s => s.coefs_sum2); // The factor is in 10**6 terms
+    const balances = await multiCall({
+        calls: contracts.map(c => ({
+            target: c.zToken,
+            params: [c.address],
+            abi: ERC4626AbiMap.balanceOf
+        }))
+    });
+
+    const adjustedBalances = balances.map((b, i) => (b * DENOMINATOR_FACTOR) / (DENOMINATOR_FACTOR + BigInt(offsetFactors[i])));
+    api.addTokens(contracts.map(c => c.token), adjustedBalances);
+}
+
+async function tvl(api) {
+  await computeAutoCompoundingTVL(api);
+  await computeSenseiTVL(api);
+}
+
+module.exports = {
+  methodology: "The TVL is calculated as a sum of total assets deposited into strategies",
+  starknet: {
+    tvl,
+  },
+};
\ No newline at end of file
diff --git a/projects/strkfarm/sensei.js b/projects/strkfarm/sensei.js
new file mode 100644
index 000000000000..a3ede93e6849
--- /dev/null
+++ b/projects/strkfarm/sensei.js
@@ -0,0 +1,41 @@
+const ERC721StratAbi = [
+    {
+        "name": "get_settings",
+        "type": "function",
+        "inputs": [],
+        "outputs": [
+            {
+                "name": "fee_percent",
+                "type": "core::integer::u128"
+            },
+            {
+                "name": "fee_receiver",
+                "type": "core::starknet::contract_address::ContractAddress"
+            },
+            {
+                "name": "min_health_factor",
+                "type": "core::integer::u32"
+            },
+            {
+                "name": "target_health_factor",
+                "type": "core::integer::u32"
+            },
+            {
+                "name": "coefs_sum1",
+                "type": "core::integer::u128"
+            },
+            {
+                "name": "coefs_sum2",
+                "type": "core::integer::u128"
+            }
+        ],
+        "state_mutability": "view"
+    }
+]
+
+const ERC721StratAbiMap = {}
+ERC721StratAbi.forEach(i => ERC721StratAbiMap[i.name] = i)
+
+module.exports = {
+    ERC721StratAbiMap
+}
\ No newline at end of file