@kasufinance/kasu-sdk 1.0.2 → 1.0.4

package/src/contracts/factories/SwapperAbi__factory.ts

@@ -0,0 +1,167 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+
+import { Contract, Signer, utils } from "ethers";
+import type { Provider } from "@ethersproject/providers";
+import type { SwapperAbi, SwapperAbiInterface } from "../SwapperAbi";
+
+const _abi = [
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "address",
+        name: "exchange",
+        type: "address",
+      },
+      {
+        indexed: false,
+        internalType: "bool",
+        name: "isAllowed",
+        type: "bool",
+      },
+    ],
+    name: "ExchangeAllowlistUpdated",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: true,
+        internalType: "address",
+        name: "receiver",
+        type: "address",
+      },
+      {
+        indexed: false,
+        internalType: "address[]",
+        name: "tokensIn",
+        type: "address[]",
+      },
+      {
+        indexed: false,
+        internalType: "address",
+        name: "tokenOut",
+        type: "address",
+      },
+      {
+        indexed: false,
+        internalType: "uint256[]",
+        name: "amountsIn",
+        type: "uint256[]",
+      },
+      {
+        indexed: false,
+        internalType: "uint256",
+        name: "amountOut",
+        type: "uint256",
+      },
+    ],
+    name: "Swapped",
+    type: "event",
+  },
+  {
+    inputs: [
+      {
+        internalType: "address",
+        name: "exchange",
+        type: "address",
+      },
+    ],
+    name: "isExchangeAllowed",
+    outputs: [
+      {
+        internalType: "bool",
+        name: "isAllowed",
+        type: "bool",
+      },
+    ],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "address[]",
+        name: "tokensIn",
+        type: "address[]",
+      },
+      {
+        components: [
+          {
+            internalType: "address",
+            name: "swapTarget",
+            type: "address",
+          },
+          {
+            internalType: "address",
+            name: "token",
+            type: "address",
+          },
+          {
+            internalType: "bytes",
+            name: "swapCallData",
+            type: "bytes",
+          },
+        ],
+        internalType: "struct SwapInfo[]",
+        name: "swapInfo",
+        type: "tuple[]",
+      },
+      {
+        internalType: "address",
+        name: "tokenOut",
+        type: "address",
+      },
+      {
+        internalType: "address",
+        name: "receiver",
+        type: "address",
+      },
+    ],
+    name: "swap",
+    outputs: [
+      {
+        internalType: "uint256",
+        name: "amountOut",
+        type: "uint256",
+      },
+    ],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      {
+        internalType: "address[]",
+        name: "exchanges",
+        type: "address[]",
+      },
+      {
+        internalType: "bool[]",
+        name: "allowed",
+        type: "bool[]",
+      },
+    ],
+    name: "updateExchangeAllowlist",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+] as const;
+
+export class SwapperAbi__factory {
+  static readonly abi = _abi;
+  static createInterface(): SwapperAbiInterface {
+    return new utils.Interface(_abi) as SwapperAbiInterface;
+  }
+  static connect(
+    address: string,
+    signerOrProvider: Signer | Provider
+  ): SwapperAbi {
+    return new Contract(address, _abi, signerOrProvider) as SwapperAbi;
+  }
+}

package/src/contracts/factories/index.ts

@@ -0,0 +1,21 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+export { IClearingCoordinatorAbi__factory } from "./IClearingCoordinatorAbi__factory";
+export { IERC20MetadataAbi__factory } from "./IERC20MetadataAbi__factory";
+export { IFeeManagerAbi__factory } from "./IFeeManagerAbi__factory";
+export { IKSULockingAbi__factory } from "./IKSULockingAbi__factory";
+export { IKasuAllowListAbi__factory } from "./IKasuAllowListAbi__factory";
+export { IKasuControllerAbi__factory } from "./IKasuControllerAbi__factory";
+export { IKasuNFTsAbi__factory } from "./IKasuNFTsAbi__factory";
+export { IKsuPriceAbi__factory } from "./IKsuPriceAbi__factory";
+export { ILendingPoolAbi__factory } from "./ILendingPoolAbi__factory";
+export { ILendingPoolFactoryAbi__factory } from "./ILendingPoolFactoryAbi__factory";
+export { ILendingPoolManagerAbi__factory } from "./ILendingPoolManagerAbi__factory";
+export { ILendingPoolTrancheAbi__factory } from "./ILendingPoolTrancheAbi__factory";
+export { ISystemVariablesAbi__factory } from "./ISystemVariablesAbi__factory";
+export { IUserLoyaltyRewardsAbi__factory } from "./IUserLoyaltyRewardsAbi__factory";
+export { IUserManagerAbi__factory } from "./IUserManagerAbi__factory";
+export { KSULockBonusAbi__factory } from "./KSULockBonusAbi__factory";
+export { KasuPoolExternalTVLAbi__factory } from "./KasuPoolExternalTVLAbi__factory";
+export { SwapperAbi__factory } from "./SwapperAbi__factory";

package/src/contracts/index.ts

@@ -0,0 +1,40 @@
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+export type { IClearingCoordinatorAbi } from "./IClearingCoordinatorAbi";
+export type { IERC20MetadataAbi } from "./IERC20MetadataAbi";
+export type { IFeeManagerAbi } from "./IFeeManagerAbi";
+export type { IKSULockingAbi } from "./IKSULockingAbi";
+export type { IKasuAllowListAbi } from "./IKasuAllowListAbi";
+export type { IKasuControllerAbi } from "./IKasuControllerAbi";
+export type { IKasuNFTsAbi } from "./IKasuNFTsAbi";
+export type { IKsuPriceAbi } from "./IKsuPriceAbi";
+export type { ILendingPoolAbi } from "./ILendingPoolAbi";
+export type { ILendingPoolFactoryAbi } from "./ILendingPoolFactoryAbi";
+export type { ILendingPoolManagerAbi } from "./ILendingPoolManagerAbi";
+export type { ILendingPoolTrancheAbi } from "./ILendingPoolTrancheAbi";
+export type { ISystemVariablesAbi } from "./ISystemVariablesAbi";
+export type { IUserLoyaltyRewardsAbi } from "./IUserLoyaltyRewardsAbi";
+export type { IUserManagerAbi } from "./IUserManagerAbi";
+export type { KSULockBonusAbi } from "./KSULockBonusAbi";
+export type { KasuPoolExternalTVLAbi } from "./KasuPoolExternalTVLAbi";
+export type { SwapperAbi } from "./SwapperAbi";
+export * as factories from "./factories";
+export { IClearingCoordinatorAbi__factory } from "./factories/IClearingCoordinatorAbi__factory";
+export { IERC20MetadataAbi__factory } from "./factories/IERC20MetadataAbi__factory";
+export { IFeeManagerAbi__factory } from "./factories/IFeeManagerAbi__factory";
+export { IKasuAllowListAbi__factory } from "./factories/IKasuAllowListAbi__factory";
+export { IKasuControllerAbi__factory } from "./factories/IKasuControllerAbi__factory";
+export { IKasuNFTsAbi__factory } from "./factories/IKasuNFTsAbi__factory";
+export { IKSULockingAbi__factory } from "./factories/IKSULockingAbi__factory";
+export { IKsuPriceAbi__factory } from "./factories/IKsuPriceAbi__factory";
+export { ILendingPoolAbi__factory } from "./factories/ILendingPoolAbi__factory";
+export { ILendingPoolFactoryAbi__factory } from "./factories/ILendingPoolFactoryAbi__factory";
+export { ILendingPoolManagerAbi__factory } from "./factories/ILendingPoolManagerAbi__factory";
+export { ILendingPoolTrancheAbi__factory } from "./factories/ILendingPoolTrancheAbi__factory";
+export { ISystemVariablesAbi__factory } from "./factories/ISystemVariablesAbi__factory";
+export { IUserLoyaltyRewardsAbi__factory } from "./factories/IUserLoyaltyRewardsAbi__factory";
+export { IUserManagerAbi__factory } from "./factories/IUserManagerAbi__factory";
+export { KasuPoolExternalTVLAbi__factory } from "./factories/KasuPoolExternalTVLAbi__factory";
+export { KSULockBonusAbi__factory } from "./factories/KSULockBonusAbi__factory";
+export { SwapperAbi__factory } from "./factories/SwapperAbi__factory";

package/src/services/Portfolio/portfolio.ts

@@ -8,11 +8,28 @@ import {
     IKasuNFTsAbi__factory,
     ISystemVariablesAbi,
     ISystemVariablesAbi__factory,
+    IUserLoyaltyRewardsAbi__factory,
 } from '../../contracts';
 import { SdkConfig } from '../../sdk-config';
 import { DataService } from '../DataService/data-service';
+import {
+    getAllTrancheConfigurationsQuery,
+    getAllTranchesQuery,
+} from '../DataService/queries';
+import {
+    TrancheConfigurationSubgraphResult,
+    TrancheSubgraphResult,
+} from '../DataService/subgraph-types';
 import { PoolOverview } from '../DataService/types';
 import { KSULocking } from '../Locking/locking';
+import {
+    getSystemVariablesQuery,
+    lockingSummariesQuery,
+} from '../Locking/queries';
+import {
+    LockingSummarySubgraphResult,
+    SystemVariables,
+} from '../Locking/types';
 import { UserLending } from '../UserLending/user-lending';
 
 import { lendingPortfolioQuery } from './queries';
@@ -33,6 +50,9 @@ export class Portfolio {
     private readonly _graph: GraphQLClient;
 
     private _systemVariablesAbi: ISystemVariablesAbi;
+    private _userLoyaltyRewardsAbi: ReturnType<
+        typeof IUserLoyaltyRewardsAbi__factory.connect
+    >;
     private _kasuNftContract: IKasuNFTsAbi;
     readonly _signerOrProvider: Signer | Provider;
 
@@ -47,6 +67,10 @@ export class Portfolio {
             _kasuConfig.contracts.SystemVariables,
             signerOrProvider,
         );
+        this._userLoyaltyRewardsAbi = IUserLoyaltyRewardsAbi__factory.connect(
+            _kasuConfig.contracts.UserLoyaltyRewards,
+            signerOrProvider,
+        );
         this._userLendingService = new UserLending(
             _kasuConfig,
             signerOrProvider,
@@ -58,49 +82,17 @@ export class Portfolio {
         this._graph = new GraphQLClient(_kasuConfig.subgraphUrl);
     }
 
-    async getPortfolioRewards(userAddress: string): Promise<PortfolioRewards> {
-        const userLockingData =
-            await this._lockingService.getUserBonusData(userAddress);
-        const lockingRewards =
-            await this._lockingService.getLockingRewards(userAddress);
-        const ksuLaunchBonus =
-            await this._lockingService.getUserTotalBonusAmount(userAddress);
-        return {
-            bonusYieldEarnings: {
-                claimableBalance: {
-                    ksuAmount: userLockingData.ksuBonusAndRewards,
-                },
-                lifeTime: {
-                    ksuAmount: userLockingData.ksuBonusAndRewardsLifetime,
-                },
-            },
-            protocolFees: {
-                claimableBalance: {
-                    usdcAmount: lockingRewards.claimableRewards,
-                },
-                lifeTime: { usdcAmount: lockingRewards.lifeTimeRewards },
-            },
-            ksuLaunchBonus: { lifeTime: { ksuAmount: ksuLaunchBonus } },
-        };
-    }
-
-    async getUserNfts(userAddress: string): Promise<number[]> {
-        const usernfts = await this._kasuNftContract.tokensOfOwner(userAddress);
-
-        return usernfts.map((nft) => nft.toNumber());
-    }
-
-    async getPortfolioSummary(
-        userAddress: string,
+    private computeYieldMetrics(
         portfolioLendingPools: PortfolioLendingPool[],
-    ): Promise<PortfolioSummary> {
-        const userLockingData =
-            await this._lockingService.getUserBonusData(userAddress);
+    ): {
+        totalInvestments: number;
+        totalYieldEarned: number;
+        weightedApy: number;
+        weeklyYieldEarnings: number;
+    } {
         let totalInvestments = 0;
-
-        let weightedApy = 0;
         let totalYieldEarned = 0;
-
+        let weightedApy = 0;
         let weeklyYieldEarnings = 0;
 
         for (const pool of portfolioLendingPools) {
@@ -139,6 +131,233 @@ export class Portfolio {
             }
         }
 
+        return {
+            totalInvestments,
+            totalYieldEarned,
+            weightedApy,
+            weeklyYieldEarnings,
+        };
+    }
+
+    /**
+     * Calculate aggregate yield metrics for a set of portfolio lending pools.
+     * Accepts pre-fetched pool data and returns totals without performing any network calls.
+     */
+    public calculateYieldMetrics(
+        portfolioLendingPools: PortfolioLendingPool[],
+    ): {
+        totalInvestments: number;
+        totalYieldEarned: number;
+        weightedApy: number;
+        weeklyYieldEarnings: number;
+    } {
+        return this.computeYieldMetrics(portfolioLendingPools);
+    }
+
+    /**
+     * Calculate the user's weekly protocol fee share (USDC) given tranche balances/configs,
+     * system variables and locking summary. All inputs are expected to be pre-fetched.
+     */
+    public calculateWeeklyProtocolFees(params: {
+        trancheBalances: TrancheSubgraphResult;
+        trancheConfigurations: TrancheConfigurationSubgraphResult;
+        systemVariables: SystemVariables;
+        lockingSummary: LockingSummarySubgraphResult;
+        userRksuAmount: string;
+    }): number {
+        const {
+            trancheBalances,
+            trancheConfigurations,
+            systemVariables,
+            lockingSummary,
+            userRksuAmount,
+        } = params;
+
+        const totalRKsuAmount = parseFloat(
+            lockingSummary.lockingSummaries[0]?.totalRKsuAmount ?? '0',
+        );
+        const userRKsuAmount = parseFloat(userRksuAmount || '0');
+
+        const performanceFee =
+            parseFloat(systemVariables.systemVariables.performanceFee) / 100;
+        const ecosystemFeeRate =
+            parseFloat(systemVariables.systemVariables.ecosystemFeeRate) / 100;
+
+        if (
+            totalRKsuAmount <= 0 ||
+            userRKsuAmount <= 0 ||
+            performanceFee <= 0 ||
+            ecosystemFeeRate <= 0
+        ) {
+            return 0;
+        }
+
+        let totalWeeklyEcosystemFees = 0;
+
+        for (const tranche of trancheBalances.lendingPoolTranches) {
+            const trancheConfig =
+                trancheConfigurations.lendingPoolTrancheConfigurations.find(
+                    (config) => config.id === tranche.id,
+                );
+
+            if (!trancheConfig) continue;
+
+            const interestUpdates =
+                trancheConfig.lendingPoolTrancheInterestRateUpdates;
+
+            const interestRate = interestUpdates.length
+                ? interestUpdates[0].epochInterestRate
+                : trancheConfig.interestRate;
+
+            totalWeeklyEcosystemFees +=
+                parseFloat(tranche.balance) *
+                parseFloat(interestRate) *
+                performanceFee *
+                ecosystemFeeRate;
+        }
+
+        return (
+            (totalWeeklyEcosystemFees * userRKsuAmount) / totalRKsuAmount
+        );
+    }
+
+    /**
+     * Calculate the user's weekly KASU bonus rewards (KASU) based on current deposits,
+     * loyalty level, reward rate, and KSU epoch price. Inputs should be pre-fetched.
+     */
+    public async calculateWeeklyKsuBonusRewards(params: {
+        userAddress: string;
+        userRksuAmount: string;
+        userDepositAmounts: [BigNumber, BigNumber];
+        ksuEpochPrice: { price: BigNumber; decimals: number };
+    }): Promise<number> {
+        const { userAddress, userRksuAmount, userDepositAmounts, ksuEpochPrice } =
+            params;
+
+        const totalUserDeposits = userDepositAmounts[0].add(
+            userDepositAmounts[1],
+        );
+
+        if (totalUserDeposits.isZero()) return 0;
+
+        const rKSUtoUSDCRatio = await this._lockingService.getRKSUvsUSDCRatio(
+            userRksuAmount,
+            userAddress,
+        );
+        const { loyaltyLevel } =
+            this._lockingService.getLoyaltyLevelAndApyBonusFromRatio(
+                rKSUtoUSDCRatio,
+            );
+
+        const loyaltyRewardRate =
+            await this._userLoyaltyRewardsAbi.loyaltyEpochRewardRates(
+                loyaltyLevel,
+            );
+
+        if (loyaltyRewardRate.isZero() || ksuEpochPrice.price.isZero()) {
+            return 0;
+        }
+
+        const reward = totalUserDeposits
+            .mul(loyaltyRewardRate)
+            .mul(BigNumber.from(10).pow(12))
+            .div(ksuEpochPrice.price);
+
+        return parseFloat(formatEther(reward));
+    }
+
+    async getPortfolioRewards(userAddress: string): Promise<PortfolioRewards> {
+        const userLockingData =
+            await this._lockingService.getUserBonusData(userAddress);
+        const lockingRewards =
+            await this._lockingService.getLockingRewards(userAddress);
+        const ksuLaunchBonus =
+            await this._lockingService.getUserTotalBonusAmount(userAddress);
+        return {
+            bonusYieldEarnings: {
+                claimableBalance: {
+                    ksuAmount: userLockingData.ksuBonusAndRewards,
+                },
+                lifeTime: {
+                    ksuAmount: userLockingData.ksuBonusAndRewardsLifetime,
+                },
+            },
+            protocolFees: {
+                claimableBalance: {
+                    usdcAmount: lockingRewards.claimableRewards,
+                },
+                lifeTime: { usdcAmount: lockingRewards.lifeTimeRewards },
+            },
+            ksuLaunchBonus: { lifeTime: { ksuAmount: ksuLaunchBonus } },
+        };
+    }
+
+    async getUserNfts(userAddress: string): Promise<number[]> {
+        const usernfts = await this._kasuNftContract.tokensOfOwner(userAddress);
+
+        return usernfts.map((nft) => nft.toNumber());
+    }
+
+    async getPortfolioSummary(
+        userAddress: string,
+        portfolioLendingPools: PortfolioLendingPool[],
+        currentEpoch: string,
+    ): Promise<PortfolioSummary> {
+        const epochId = currentEpoch.toString();
+        const [
+            userLockingData,
+            userRksuAmount,
+            lockingSummary,
+            systemVariables,
+            trancheBalances,
+            trancheConfigurations,
+            userDepositAmounts,
+            ksuEpochPrice,
+        ] = await Promise.all([
+            this._lockingService.getUserBonusData(userAddress),
+            this._lockingService.getUserEarnedrKsu(userAddress),
+            this._graph.request<LockingSummarySubgraphResult>(
+                lockingSummariesQuery,
+            ),
+            this._graph.request<SystemVariables>(getSystemVariablesQuery),
+            this._graph.request<TrancheSubgraphResult>(getAllTranchesQuery, {
+                unusedPools: this._kasuConfig.UNUSED_LENDING_POOL_IDS,
+            }),
+            this._graph.request<TrancheConfigurationSubgraphResult>(
+                getAllTrancheConfigurationsQuery,
+                {
+                    unusedPools: this._kasuConfig.UNUSED_LENDING_POOL_IDS,
+                    epochId,
+                },
+            ),
+            this._userLendingService.getUserTotalPendingAndActiveDepositedAmountForCurrentEpoch(
+                userAddress,
+            ),
+            this._lockingService.getKasuEpochTokenPrice(),
+        ]);
+        const {
+            totalInvestments,
+            totalYieldEarned,
+            weightedApy,
+            weeklyYieldEarnings,
+        } = this.computeYieldMetrics(portfolioLendingPools);
+
+        const weeklyProtocolFeesEarned = this.calculateWeeklyProtocolFees({
+            trancheBalances,
+            trancheConfigurations,
+            systemVariables,
+            lockingSummary,
+            userRksuAmount,
+        });
+
+        const weeklyKsuBonusRewards =
+            await this.calculateWeeklyKsuBonusRewards({
+                userAddress,
+                userRksuAmount,
+                userDepositAmounts,
+                ksuEpochPrice,
+            });
+
         return {
             current: {
                 totalKsuLocked: userLockingData.totalLockedAmount,
@@ -153,8 +372,8 @@ export class Portfolio {
             },
             weekly: {
                 yieldEarnings: weeklyYieldEarnings.toString(),
-                protocolFeesEarned: '0',
-                ksuBonusRewards: '0',
+                protocolFeesEarned: weeklyProtocolFeesEarned.toString(),
+                ksuBonusRewards: weeklyKsuBonusRewards.toString(),
             },
             lifetime: {
                 yieldEarnings: totalYieldEarned.toString(),
@@ -269,9 +488,6 @@ export class Portfolio {
                 ({ poolId }) => poolId === poolOverview.id,
             );
             if (!userPoolBalance) {
-                console.warn(
-                    `Could not find user pool balance for ${poolOverview.id}`,
-                );
                 continue;
             }
             totalInvestments = userPoolBalance.balance.add(totalInvestments);

package/tsconfig.json

@@ -6,7 +6,7 @@
         "target": "es6",
         "module": "esnext",
         "lib": ["es6", "dom", "dom.iterable", "esnext", "es2020"],
-        "sourceMap": false,
+        "sourceMap": true,
         "allowJs": true,
         "outDir": "./dist",
         "rootDir": "src",