@kasufinance/kasu-sdk 2.1.0 → 2.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kasufinance/kasu-sdk",
-    "version": "2.1.0",
+    "version": "2.2.1",
     "description": "",
     "main": "dist/bundle.cjs.js",
     "module": "dist/bundle.esm.js",

package/src/facade/chain-configs.ts

@@ -9,7 +9,7 @@ import { ChainConfigEntry } from './types';
  * const base = CHAIN_CONFIGS.base;
  * ```
  */
-export const CHAIN_CONFIGS: Record<'base' | 'xdc' | 'plume', ChainConfigEntry> = {
+export const CHAIN_CONFIGS: Record<'base' | 'xdc' | 'xdc-usdc' | 'plume', ChainConfigEntry> = {
     base: {
         chainId: 8453,
         name: 'Base Mainnet',
@@ -67,6 +67,31 @@ export const CHAIN_CONFIGS: Record<'base' | 'xdc' | 'plume', ChainConfigEntry> =
         },
     },
 
+    'xdc-usdc': {
+        chainId: 50,
+        name: 'XDC Mainnet (USDC)',
+        isLiteDeployment: true,
+        contracts: {
+            // No KSUToken on Lite deployments
+            IKSULocking: '0x47e7C147955FAC86c4AeAe5a8691C1A702A9C4FA',
+            IKSULockBonus: '0xe99c77d800E1065f2f1Ab23A6D70cBc7D1102943',
+            LendingPoolManager: '0x5ba223175F61221fbc795F71a41f52Bff825C68b',
+            UserManager: '0xFd407a09049C4d60a81C708E5587B8C7b6Cf6BdD',
+            KasuAllowList: '0xaf911547FD38686a88fc26B2A722F870426bCD6D',
+            SystemVariables: '0xb73Ebe67c8597d55A5F4FCc2C1638eDd5512BfBb',
+            KsuPrice: '0xA622DE9d439C05266C63EfeA3B7853792aD61f45',
+            UserLoyaltyRewards: '0x8e2033DcF9C6D3B9D3B24C651a03c0Af65A113b8',
+            ClearingCoordinator: '0x84022117eAD4C22D8A01bC7Fc9743dd101C6a882',
+            // No KasuNFTs on Lite deployments
+            ExternalTVL: '0xb2367F0B074Ec1788b28283A8af953aaA498d779',
+        },
+        subgraphUrl:
+            'https://api.goldsky.com/api/public/project_cmgzlpxm300765np2a19421om/subgraphs/kasu-xdc-usdc/v1.0.0/gn',
+        directusUrl: 'https://kasu-finance.directus.app/',
+        unusedPoolIds: [],
+        poolMetadataMapping: undefined,
+    },
+
     plume: {
         chainId: 98866,
         name: 'Plume Mainnet',

package/src/facade/deposits.ts

@@ -28,7 +28,7 @@ export class DepositsFacade {
      * const tx = await kasu.deposits.deposit({
      *   poolId: '0x...',
      *   trancheId: '0x...',
-     *   amount: parseUnits('1000', 6),
+     *   amount: parseUnits('1000', 6), // 6 decimals for USDC/AUDD; use token's actual decimals
      *   kycSignature: { blockExpiration, signature },
      * });
      * ```
@@ -47,10 +47,10 @@ export class DepositsFacade {
     }
 
     /**
-     * Submit a withdrawal request for a specific USDC amount.
+     * Submit a withdrawal request for a specific stable asset amount.
      */
     async withdraw(params: WithdrawParams): Promise<ContractTransaction> {
-        return await this._userLending.requestWithdrawalInUSDC(
+        return await this._userLending.requestWithdrawalInAsset(
             params.poolId,
             params.trancheId,
             params.amount,

package/src/facade/types.ts

@@ -11,7 +11,7 @@ import {
 // Chain & SDK Configuration
 // ---------------------------------------------------------------------------
 
-export type SupportedChain = 'base' | 'xdc' | 'plume';
+export type SupportedChain = 'base' | 'xdc' | 'xdc-usdc' | 'plume';
 
 export interface ChainConfigEntry {
     chainId: number;
@@ -74,9 +74,9 @@ export interface StrategyTranche {
     apy: number;
     minApy: number;
     maxApy: number;
-    /** Minimum deposit in USDC (ether-formatted string). */
+    /** Minimum deposit in stable asset units (ether-formatted string). */
     minimumDeposit: string;
-    /** Maximum deposit in USDC (ether-formatted string). */
+    /** Maximum deposit in stable asset units (ether-formatted string). */
     maximumDeposit: string;
     /** Remaining tranche capacity (ether-formatted string). */
     availableCapacity: string;
@@ -101,7 +101,7 @@ export interface FixedTermOption {
 export interface DepositParams {
     poolId: string;
     trancheId: string;
-    /** Amount in USDC base units (BigNumberish). */
+    /** Amount in stable asset base units (BigNumberish). */
     amount: BigNumberish;
     /** KYC signature obtained from the Nexera flow. */
     kycSignature: {
@@ -112,7 +112,7 @@ export interface DepositParams {
     depositData?: BytesLike;
     /** Fixed-term config ID. Pass `0` for variable deposits. */
     fixedTermConfigId?: BigNumberish;
-    /** Swap calldata. Pass `'0x'` when depositing USDC directly. */
+    /** Swap calldata. Pass `'0x'` when depositing the stable asset directly. */
     swapData?: BytesLike;
     /** Native token value to send (e.g. for gas on some chains). Defaults to `'0'`. */
     ethValue?: string;
@@ -121,18 +121,18 @@ export interface DepositParams {
 export interface WithdrawParams {
     poolId: string;
     trancheId: string;
-    /** USDC amount to withdraw, or `'max'` to withdraw entire balance. */
+    /** Stable asset amount to withdraw, or `'max'` to withdraw entire balance. */
     amount: BigNumberish;
     /** Required when `amount` is `'max'`. */
     userAddress?: string;
 }
 
 export interface DepositLimits {
-    /** Minimum deposit (ether-formatted USDC). */
+    /** Minimum deposit (ether-formatted stable asset amount). */
     min: string;
-    /** Maximum deposit (ether-formatted USDC). */
+    /** Maximum deposit (ether-formatted stable asset amount). */
     max: string;
-    /** Remaining tranche capacity (ether-formatted USDC). */
+    /** Remaining tranche capacity (ether-formatted stable asset amount). */
     availableCapacity: string;
 }
 

package/src/sdk-config.ts

@@ -34,6 +34,11 @@ export interface SdkConfigOptions {
      * Value: pool address in Directus / Base pool (lowercase)
      */
     poolMetadataMapping?: Record<string, string>;
+    /**
+     * Decimals of the stable asset used by lending pools (e.g. 6 for USDC/AUDD).
+     * @default 6
+     */
+    stableAssetDecimals?: number;
 }
 
 export class SdkConfig {
@@ -44,6 +49,7 @@ export class SdkConfig {
     UNUSED_LENDING_POOL_IDS: string[];
     isLiteDeployment: boolean;
     poolMetadataMapping: Record<string, string>;
+    stableAssetDecimals: number;
 
     constructor(options: SdkConfigOptions) {
         this.subgraphUrl = options.subgraphUrl;
@@ -52,5 +58,6 @@ export class SdkConfig {
         this.UNUSED_LENDING_POOL_IDS = options.UNUSED_LENDING_POOL_IDS;
         this.isLiteDeployment = options.isLiteDeployment ?? false;
         this.poolMetadataMapping = options.poolMetadataMapping ?? {};
+        this.stableAssetDecimals = options.stableAssetDecimals ?? 6;
     }
 }

package/src/services/DataService/data-service.ts

@@ -199,7 +199,7 @@ export class DataService {
             );
 
             for (const [id, tvl] of results) {
-                tvlMap.set(id, formatUnits(tvl, 6));
+                tvlMap.set(id, formatUnits(tvl, this._kasuConfig.stableAssetDecimals));
             }
         } catch (error) {
             console.error('getOffChainTvl :', error);

package/src/services/Locking/locking.ts

@@ -280,17 +280,17 @@ export class KSULocking {
         });
         const resultPromises = result.userLocks.map(async (userLock) => {
             const [, id] = userLock.id.split('-');
-            const rKSUtoUSDCRatio = await this.getRKSUvsUSDCRatio(
+            const rKSUtoStableRatio = await this.getRKSUvsStableRatio(
                 userLock.rKSUAmount,
                 userAddress,
             );
             const loyaltyStatus =
-                this.getLoyaltyLevelAndApyBonusFromRatio(rKSUtoUSDCRatio);
+                this.getLoyaltyLevelAndApyBonusFromRatio(rKSUtoStableRatio);
             return {
                 id: BigNumber.from(id),
                 lockedAmount: userLock.ksuAmount,
                 rKSUAmount: userLock.rKSUAmount,
-                rKSUtoUSDCRatio: rKSUtoUSDCRatio,
+                rKSUtoStableRatio: rKSUtoStableRatio,
                 apyBonus: loyaltyStatus.apyBonus,
                 loyaltyLevel: loyaltyStatus.loyaltyLevel,
                 startTime: parseFloat(userLock.startTimestamp),
@@ -367,7 +367,7 @@ export class KSULocking {
         };
     }
 
-    getLoyaltyLevelAndApyBonusFromRatio(rKSUtoUSDCRatio: number): {
+    getLoyaltyLevelAndApyBonusFromRatio(rKSUtoStableRatio: number): {
         loyaltyLevel: number;
         apyBonus: number;
     } {
@@ -376,15 +376,15 @@ export class KSULocking {
             return { loyaltyLevel: 0, apyBonus: 0 };
         }
 
-        if (rKSUtoUSDCRatio < 0.01) {
+        if (rKSUtoStableRatio < 0.01) {
             return { loyaltyLevel: 0, apyBonus: this.apyBonuses[0] };
-        } else if (rKSUtoUSDCRatio < 0.05) {
+        } else if (rKSUtoStableRatio < 0.05) {
             return { loyaltyLevel: 1, apyBonus: this.apyBonuses[1] };
         }
         return { loyaltyLevel: 2, apyBonus: this.apyBonuses[2] };
     }
 
-    async getRKSUvsUSDCRatio(
+    async getRKSUvsStableRatio(
         rKSUAmount: string,
         userAddress: string,
     ): Promise<number> {
@@ -403,15 +403,25 @@ export class KSULocking {
             18,
         );
 
-        const totalUserUsdcAmount =
+        const totalUserStableAmount =
             depositedAmount.toNumber() + pendingAmount.toNumber();
 
-        const rKSUInUSDC = rKSUAmountBignumber
+        // Convert rKSU value to stable asset units: rKSU * ksuPrice / 1e18 / 1e(18 - stableDecimals)
+        const decimalDiff = 18 - this._kasuConfig.stableAssetDecimals;
+        const rKSUInStable = rKSUAmountBignumber
             .mul(ksuPrice)
             .div(ethers.utils.parseUnits('1', 18))
-            .div(ethers.utils.parseUnits('1', 12));
+            .div(ethers.utils.parseUnits('1', decimalDiff));
 
-        return rKSUInUSDC.toNumber() / totalUserUsdcAmount;
+        return rKSUInStable.toNumber() / totalUserStableAmount;
+    }
+
+    /** @deprecated Use `getRKSUvsStableRatio` instead. */
+    async getRKSUvsUSDCRatio(
+        rKSUAmount: string,
+        userAddress: string,
+    ): Promise<number> {
+        return this.getRKSUvsStableRatio(rKSUAmount, userAddress);
     }
 
     async getClaimableRewards(userAddress: string): Promise<BigNumber> {
@@ -554,7 +564,7 @@ export class KSULocking {
             };
         }
 
-        const rewardDecimals = 6;
+        const rewardDecimals = this._kasuConfig.stableAssetDecimals;
 
         const claimableRewards = await this.getClaimableRewards(userAddress);
 
@@ -636,7 +646,12 @@ export class KSULocking {
         return '10.00';
     }
 
-    getProjectedUSDC(): string {
+    getProjectedStableAmount(): string {
         return '20.00';
     }
+
+    /** @deprecated Use `getProjectedStableAmount` instead. */
+    getProjectedUSDC(): string {
+        return this.getProjectedStableAmount();
+    }
 }

package/src/services/Locking/types.ts

@@ -25,7 +25,7 @@ export interface UserLock {
     id: BigNumber;
     lockedAmount: string;
     rKSUAmount: string;
-    rKSUtoUSDCRatio: number;
+    rKSUtoStableRatio: number;
     apyBonus: number;
     startTime: EpochTimeStamp;
     endTime: EpochTimeStamp;

package/src/services/Portfolio/portfolio.ts

@@ -160,8 +160,8 @@ export class Portfolio {
     }
 
     /**
-     * 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.
+     * Calculate the user's weekly protocol fee share (in stable asset units) given tranche
+     * balances/configs, system variables and locking summary. All inputs are expected to be pre-fetched.
      */
     public calculateWeeklyProtocolFees(params: {
         trancheBalances: TrancheSubgraphResult;
@@ -245,13 +245,13 @@ export class Portfolio {
 
         if (totalUserDeposits.isZero()) return 0;
 
-        const rKSUtoUSDCRatio = await this._lockingService.getRKSUvsUSDCRatio(
+        const rKSUtoStableRatio = await this._lockingService.getRKSUvsStableRatio(
             userRksuAmount,
             userAddress,
         );
         const { loyaltyLevel } =
             this._lockingService.getLoyaltyLevelAndApyBonusFromRatio(
-                rKSUtoUSDCRatio,
+                rKSUtoStableRatio,
             );
 
         const loyaltyRewardRate =
@@ -289,9 +289,9 @@ export class Portfolio {
             },
             protocolFees: {
                 claimableBalance: {
-                    usdcAmount: lockingRewards.claimableRewards,
+                    stableAmount: lockingRewards.claimableRewards,
                 },
-                lifeTime: { usdcAmount: lockingRewards.lifeTimeRewards },
+                lifeTime: { stableAmount: lockingRewards.lifeTimeRewards },
             },
             ksuLaunchBonus: { lifeTime: { ksuAmount: ksuLaunchBonus } },
         };

package/src/services/Portfolio/types.ts

@@ -16,10 +16,10 @@ export interface PortfolioRewards {
     };
     protocolFees: {
         claimableBalance: {
-            usdcAmount: string;
+            stableAmount: string;
         };
         lifeTime: {
-            usdcAmount: string;
+            stableAmount: string;
         };
     };
 }

package/src/services/UserLending/user-lending.ts

@@ -287,17 +287,17 @@ export class UserLending {
         );
     }
 
-    async requestWithdrawalInUSDC(
+    async requestWithdrawalInAsset(
         lendingPool: string,
         tranche: string,
-        usdcAmount: BigNumberish,
+        assetAmount: BigNumberish,
     ): Promise<ContractTransaction> {
         const trancheContract: ILendingPoolTrancheAbi =
             ILendingPoolTrancheAbi__factory.connect(
                 tranche,
                 this._signerOrProvider,
             );
-        const shareAmount = await trancheContract.convertToShares(usdcAmount);
+        const shareAmount = await trancheContract.convertToShares(assetAmount);
 
         return await this._lendingPoolManagerAbi.requestWithdrawal(
             lendingPool,
@@ -306,6 +306,15 @@ export class UserLending {
         );
     }
 
+    /** @deprecated Use `requestWithdrawalInAsset` instead. */
+    async requestWithdrawalInUSDC(
+        lendingPool: string,
+        tranche: string,
+        amount: BigNumberish,
+    ): Promise<ContractTransaction> {
+        return this.requestWithdrawalInAsset(lendingPool, tranche, amount);
+    }
+
     async requestWithdrawalMax(
         lendingPool: string,
         tranche: string,
@@ -775,7 +784,7 @@ export class UserLending {
                 return {
                     poolId: lendingPool.id,
                     yieldEarned:
-                        parseFloat(ethers.utils.formatUnits(balance, 6)) -
+                        parseFloat(ethers.utils.formatUnits(balance, this._kasuConfig.stableAssetDecimals)) -
                         parseFloat(totalAcceptedDeposits) -
                         -parseFloat(totalAcceptedWithdrawnAmount),
                     balance,

package/.claude/settings.local.json

@@ -1,15 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npx tsc:*)",
-      "Bash(npm run build:*)",
-      "Bash(npm test:*)",
-      "Bash(find:*)",
-      "Bash(npx jest:*)",
-      "Bash(npm run rollup-build:*)",
-      "Bash(npm publish:*)",
-      "Bash(npm whoami:*)",
-      "Bash(npm config get:*)"
-    ]
-  }
-}