@kasufinance/kasu-sdk 2.4.2 → 2.6.0

package/src/services/Locking/calculate-apy.test.ts

@@ -0,0 +1,52 @@
+import { providers } from 'ethers';
+
+import { apyToEpochRate, epochRateToApy } from '../../domain/rates';
+import { CHAIN_CONFIGS } from '../../facade/chain-configs';
+import { SdkConfig } from '../../sdk-config';
+
+import { KSULocking } from './locking';
+
+// Offline: the constructor only builds contract instances. Nothing here calls
+// the RPC or the subgraph.
+function locking(): KSULocking {
+    const chain = CHAIN_CONFIGS.base;
+    const config = new SdkConfig({
+        subgraphUrl: 'https://example.invalid/subgraph',
+        contracts: chain.contracts,
+        UNUSED_LENDING_POOL_IDS: [''],
+    });
+    return new KSULocking(
+        config,
+        new providers.StaticJsonRpcProvider(chain.rpcUrls[0], chain.chainId),
+    );
+}
+
+describe('KSULocking.calculateApy', () => {
+    it('compounds the epoch rate instead of XOR-ing it', () => {
+        // The old body was `(1 + r) ^ (EPOCHS_IN_YEAR - 1)` — bitwise XOR on
+        // int32 operands, so every realistic rate returned the constant 50.
+        for (const r of [0.001, 0.0025, 0.003, 0.005]) {
+            expect(locking().calculateApy(r)).toBe(epochRateToApy(r));
+            expect(locking().calculateApy(r)).not.toBe(50);
+        }
+    });
+
+    it('lands on the APYs the platform actually quotes', () => {
+        // Every live tranche APY, back through its own per-epoch rate.
+        for (const apy of [0.1, 0.12, 0.14, 0.16, 0.22, 0.3]) {
+            expect(locking().calculateApy(apyToEpochRate(apy))).toBeCloseTo(
+                apy,
+                10,
+            );
+        }
+        expect(locking().calculateApy(0)).toBe(0);
+    });
+
+    it('agrees with DataService.calculateApyForTranche', () => {
+        // The two used to carry separate copies of the constant AND separate
+        // (one of them wrong) formulas.
+        for (const r of [0.001, 0.003, 0.01]) {
+            expect(locking().calculateApy(r)).toBe(epochRateToApy(r));
+        }
+    });
+});

package/src/services/Locking/locking.ts

@@ -17,6 +17,7 @@ import {
     IUserManagerAbi,
     IUserManagerAbi__factory,
 } from '../../contracts';
+import { epochRateToApy } from '../../domain/rates';
 import { SdkConfig } from '../../sdk-config';
 import {
     getAllTrancheConfigurationsQuery,
@@ -265,9 +266,22 @@ export class KSULocking {
         );
     }
 
+    /**
+     * A per-epoch interest rate compounded into an APY.
+     *
+     * This used to read `(1 + epochInterestRate) ^ (EPOCHS_IN_YEAR - 1)`.
+     * `^` is JavaScript's BITWISE XOR, not exponentiation: both operands were
+     * coerced to int32, so for a realistic epoch rate of ~0.003 it computed
+     * `1 ^ 51` and returned the constant 50 — a 5000% APY — for every tranche,
+     * regardless of its rate. Its only caller,
+     * `calculateUserLockProjectedProtocolFeeRewards`, multiplied that by each
+     * tranche balance, so its projection was nonsense rather than merely
+     * imprecise.
+     *
+     * Now the same compounding every other rate in the SDK uses.
+     */
     calculateApy(epochInterestRate: number): number {
-        const EPOCHS_IN_YEAR = 52.17857;
-        return (1 + epochInterestRate) ^ (EPOCHS_IN_YEAR - 1);
+        return epochRateToApy(epochInterestRate);
     }
 
     async getUserLocks(userAddress: string): Promise<UserLock[]> {

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

@@ -1,12 +1,4 @@
-import {
-    authentication,
-    AuthenticationClient,
-    createDirectus,
-    DirectusClient,
-    readItems,
-    rest,
-    RestClient,
-} from '@directus/sdk';
+import { readItems } from '@directus/sdk';
 import { Provider } from '@ethersproject/providers';
 import {
     BigNumber,
@@ -43,7 +35,10 @@ import {
 } from '../../contracts';
 import { SdkConfig } from '../../sdk-config';
 import { DataService } from '../DataService/data-service';
-import { DirectusSchema } from '../DataService/directus-types';
+import {
+    createDirectusClient,
+    KasuDirectusClient,
+} from '../DataService/directus-client';
 
 import { mapUserRequestEventType } from './helper';
 import {
@@ -78,9 +73,7 @@ import {
 export class UserLending {
     private readonly _graph: GraphQLClient;
 
-    private readonly _directus: DirectusClient<DirectusSchema> &
-        AuthenticationClient<DirectusSchema> &
-        RestClient<DirectusSchema>;
+    private readonly _directus: KasuDirectusClient;
     private _dataService: DataService;
     private readonly _userManagerAbi: IUserManagerAbi;
     private readonly _lendingPoolManagerAbi: ILendingPoolManagerAbi;
@@ -117,9 +110,7 @@ export class UserLending {
             signerOrProvider,
         );
         this._dataService = new DataService(_kasuConfig, signerOrProvider);
-        this._directus = createDirectus<DirectusSchema>(_kasuConfig.directusUrl)
-            .with(authentication())
-            .with(rest());
+        this._directus = createDirectusClient(_kasuConfig.directusUrl);
     }
 
     async getUserTotalPendingAndActiveDepositedAmount(
@@ -372,11 +363,16 @@ export class UserLending {
                 unusedPools: this._kasuConfig.UNUSED_LENDING_POOL_IDS,
                 epochId,
             }),
-            this._directus.request(
-                readItems('PoolOverview', {
-                    fields: ['id', 'poolName', 'subheading'],
-                }),
-            ),
+            // Directus supplies the display pool NAME only; without it the
+            // raw subgraph name is used, which is what the fallback below
+            // already does for a pool with no CMS entry.
+            this._kasuConfig.directusUrl
+                ? this._directus.request(
+                      readItems('PoolOverview', {
+                          fields: ['id', 'poolName', 'subheading'],
+                      }),
+                  )
+                : [],
         ]);
 
         const retn: UserRequest[] = [];

package/src/tests/sample.test.ts

@@ -1,42 +1,63 @@
+/**
+ * Live-network spec. It talks to a real subgraph and a real RPC, so it is
+ * OPT-IN: it runs only under `LIVE_TESTS=1` (`npm run test:live`) and is
+ * skipped by `npm test` and `npm run test:unit`. A network problem must never
+ * be able to fail a pull request that did not touch the network.
+ *
+ * Known state: the stack it points at (`kasu-wip-sepolia` on The Graph Studio,
+ * with Base Sepolia addresses) is decommissioned, so `npm run test:live` fails
+ * on a missing deployment. That is pre-existing and unrelated to the gate; the
+ * spec needs retargeting at a live deployment before it means anything.
+ */
 import * as ethers from 'ethers';
 
 import { KasuSdk } from '..';
 import { SdkConfig } from '../sdk-config';
 
-test('subgraphCall', async () => {
-    const provider = new ethers.providers.JsonRpcProvider(
-        'https://sepolia.base.org',
-    );
+const live = process.env.LIVE_TESTS === '1';
 
-    const wallet = new ethers.Wallet(
-        'dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd',
-        provider,
-    );
-    const config = new SdkConfig({
-        subgraphUrl:
-            'https://api.studio.thegraph.com/query/63245/kasu-wip-sepolia/version/latest',
-        contracts: {
-            IKSULocking: '0x529A81c11ab6176c5E88670d293BB771800066a2',
-            IKSULockBonus: '0xBBfFd5F744156FFc526df12F5e09dC7b208Be740',
-            KSUToken: '0xa0f698Feb9Bc2BeA6E85eb071D5E3F59dc5bC56b',
-            UserManager: '0xA788e9223fDd7c9Db91Ef133BbeB73515c174773',
-            LendingPoolManager: '0xc074Aaf2565aae18db2c7498ee1387610a809F40',
-            KasuAllowList: '0xaE94F9D187c9eA649ADd4966340831F7cc62B69c',
-            SystemVariables: '0xB174a3240B23e595e90bC2736A5b8ec674Cba73A',
-            UserLoyaltyRewards: '0x259631CE76FD9F65296549Cd81232aa59D53Dd0c',
-            KsuPrice: '0x2027192aCFB4810Ad734A212F19d7030F698aCE3',
-            ClearingCoordinator: '0x2027192aCFB4810Ad734A212F19d7030F698aCE3',
-            KasuNFTs: '0x0000000000000000000000000000000000000000',
-            ExternalTVL: '0x0000000000000000000000000000000000000000',
-        },
-        directusUrl: 'https://kasu-finance.directus.app',
-        UNUSED_LENDING_POOL_IDS: [''],
-    });
-    const sdk = new KasuSdk(config, wallet);
+(live ? describe : describe.skip)('live network — subgraph read', () => {
+    it('reads a user APY bonus through the subgraph', async () => {
+        const provider = new ethers.providers.JsonRpcProvider(
+            'https://sepolia.base.org',
+        );
+
+        // Generated per run. This spec only reads, so the wallet never needs
+        // funds or a key that outlives the process — and a public repository
+        // must never carry one.
+        const wallet = ethers.Wallet.createRandom().connect(provider);
+
+        const config = new SdkConfig({
+            subgraphUrl:
+                'https://api.studio.thegraph.com/query/63245/kasu-wip-sepolia/version/latest',
+            contracts: {
+                IKSULocking: '0x529A81c11ab6176c5E88670d293BB771800066a2',
+                IKSULockBonus: '0xBBfFd5F744156FFc526df12F5e09dC7b208Be740',
+                // The allow below is for a public Base Sepolia contract
+                // address, not a secret: the generic-api-key rule fires on a
+                // "Token" key name sitting next to a long hex literal.
+                KSUToken: '0xa0f698Feb9Bc2BeA6E85eb071D5E3F59dc5bC56b', // gitleaks:allow
+                UserManager: '0xA788e9223fDd7c9Db91Ef133BbeB73515c174773',
+                LendingPoolManager: '0xc074Aaf2565aae18db2c7498ee1387610a809F40',
+                KasuAllowList: '0xaE94F9D187c9eA649ADd4966340831F7cc62B69c',
+                SystemVariables: '0xB174a3240B23e595e90bC2736A5b8ec674Cba73A',
+                UserLoyaltyRewards:
+                    '0x259631CE76FD9F65296549Cd81232aa59D53Dd0c',
+                KsuPrice: '0x2027192aCFB4810Ad734A212F19d7030F698aCE3',
+                ClearingCoordinator:
+                    '0x2027192aCFB4810Ad734A212F19d7030F698aCE3',
+                KasuNFTs: '0x0000000000000000000000000000000000000000',
+                ExternalTVL: '0x0000000000000000000000000000000000000000',
+            },
+            directusUrl: 'https://kasu-finance.directus.app',
+            UNUSED_LENDING_POOL_IDS: [''],
+        });
+        const sdk = new KasuSdk(config, wallet);
 
-    console.log(
-        await sdk.UserLending.getUserApyBonus(
+        const bonus = await sdk.UserLending.getUserApyBonus(
             '0xef38c432682ab49095e00442aaa354e955ac03a5',
-        ),
-    );
+        );
+
+        expect(bonus).toBeDefined();
+    });
 });

package/.eslintignore

@@ -1,3 +0,0 @@
-/**/*.js
-src/contracts/**
-jest-config.ts

package/.eslintrc.json

@@ -1,90 +0,0 @@
-{
-    "extends": [
-        "plugin:@typescript-eslint/strict-type-checked",
-        "plugin:@typescript-eslint/stylistic-type-checked",
-        "plugin:import/errors",
-        "plugin:import/warnings",
-        "plugin:import/typescript",
-        "prettier"
-    ],
-    "settings": {
-        "import/resolver": {
-            "node": {
-                "extensions": [".js", ".jsx", ".ts", ".tsx", ".d.ts"], // add .d.ts here
-                "moduleDirectory": ["src", "node_modules"]
-            }
-        }
-    },
-    "parserOptions": {
-        "project": ["./tsconfig.json"] // Specify it only for TypeScript files
-    },
-    "ignorePatterns": [
-        "node_modules",
-        "src/contracts",
-        "index.ts",
-        "dist/**/*"
-    ],
-    "rules": {
-        "@typescript-eslint/no-non-null-assertion": "warn",
-        "@typescript-eslint/prefer-ts-expect-error": "warn",
-        "@typescript-eslint/restrict-plus-operands": "warn",
-        "@typescript-eslint/ban-ts-comment": [
-            "warn",
-            {
-                "ts-expect-error": "allow-with-description",
-                "ts-ignore": "allow-with-description"
-            }
-        ],
-        "@typescript-eslint/ban-tslint-comment": "warn",
-        "@typescript-eslint/no-explicit-any": "warn",
-        "testing-library/prefer-screen-queries": "off",
-        "@typescript-eslint/no-unused-vars": [
-            "warn",
-            {
-                "argsIgnorePattern": "^_",
-                "varsIgnorePattern": "^_"
-            }
-        ],
-        "sort-imports": [
-            "warn",
-            {
-                "ignoreCase": true,
-                "ignoreDeclarationSort": true
-            }
-        ],
-        "import/order": [
-            "error",
-            {
-                "groups": [
-                    "builtin",
-                    "external",
-                    "internal",
-                    "parent",
-                    "sibling",
-                    "index"
-                ],
-                "pathGroups": [
-                    {
-                        "pattern": "src/**",
-                        "group": "internal",
-                        "position": "before"
-                    },
-                    {
-                        "pattern": "test/**",
-                        "group": "internal",
-                        "position": "before"
-                    }
-                ],
-                "pathGroupsExcludedImportTypes": ["builtin", "external"],
-                "newlines-between": "always",
-                "alphabetize": {
-                    "order": "asc",
-                    "caseInsensitive": true
-                }
-            }
-        ],
-        "@typescript-eslint/explicit-function-return-type": "error",
-        "@typescript-eslint/explicit-module-boundary-types": "error"
-    },
-    "plugins": ["@typescript-eslint", "import"]
-}

package/.github/workflows/ci.yml

@@ -1,39 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-      - develop
-  pull_request:
-    branches:
-      - main
-      - develop
-
-permissions:
-  contents: read
-
-jobs:
-  quality-checks:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Generate contract typings
-        run: npm run build-tc
-
-      - name: Lint & type-check
-        run: npm run build
-
-      - name: Bundle library
-        run: npm run rollup-build

package/.github/workflows/gitleaks.yml

@@ -1,22 +0,0 @@
-name: gitleaks
-
-on:
-  push:
-    branches: [main, master, develop]
-  pull_request:
-
-permissions:
-  contents: read
-
-jobs:
-  gitleaks:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Run gitleaks
-        run: |
-          curl -sSfL https://github.com/gitleaks/gitleaks/releases/download/v8.30.1/gitleaks_8.30.1_linux_x64.tar.gz | tar -xz gitleaks
-          ./gitleaks git --redact --no-banner .

package/.github/workflows/main.yml

@@ -1,41 +0,0 @@
-name: Verify release tag
-
-# npm publishes are intentionally manual (policy: always run `npm publish`
-# locally as a kasu_finance org member). This workflow only verifies the
-# pushed tag matches package.json — it does NOT publish.
-
-on:
-  push:
-    tags:
-      - 'v[0-9]+.[0-9]+.[0-9]+'
-
-  workflow_dispatch:
-
-jobs:
-  verify:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Get tag version
-        id: tag_version
-        run: |
-          RAW_TAG="${GITHUB_REF#refs/tags/}"
-          echo "TAG_VERSION=${RAW_TAG#v}" >> "$GITHUB_OUTPUT"
-
-      - name: Read package version
-        id: package_version
-        run: |
-          PKG_VERSION=$(node -p "require('./package.json').version")
-          echo "PACKAGE_VERSION=$PKG_VERSION" >> "$GITHUB_OUTPUT"
-
-      - name: Ensure tag matches package.json
-        run: |
-          if [ "${{ steps.tag_version.outputs.TAG_VERSION }}" != "${{ steps.package_version.outputs.PACKAGE_VERSION }}" ]; then
-            echo "Tag ${{ steps.tag_version.outputs.TAG_VERSION }} does not match package.json ${{ steps.package_version.outputs.PACKAGE_VERSION }}."
-            exit 1
-          fi
-          echo "Tag ${{ steps.tag_version.outputs.TAG_VERSION }} matches package.json. Run 'npm publish' locally to release."

package/.gitleaksignore

@@ -1,19 +0,0 @@
-# Baseline: historical findings triaged 2026-08-11 (real ones rotated, rest false positives).
-# New findings will still fail CI. Format: commit:file:rule:line
-0a13e5c82c4b0dea51a1bca2bcffd4dbe7d9e9c8:src/config/sdk/mainnet.config.ts:generic-api-key:9
-0a13e5c82c4b0dea51a1bca2bcffd4dbe7d9e9c8:src/config/sdk/testnet.config.ts:generic-api-key:9
-1a0e64886602fdbb0789b72e3be80460dfb2a9bc:src/tests/sample.test.ts:generic-api-key:18
-41992e186efdd602e49a07a9cfaa17a046194afd:src/tests/sample.test.ts:generic-api-key:20
-61345a2c016dd28bd3fe647b01ae92321f4e6797:src/config/sdk/mainnet.config.ts:generic-api-key:9
-61345a2c016dd28bd3fe647b01ae92321f4e6797:src/config/sdk/testnet.config.ts:generic-api-key:9
-678e94f28e9894246569775e06b7bfc145c90db9:src/config/sdk/mainnet.config.ts:generic-api-key:9
-678e94f28e9894246569775e06b7bfc145c90db9:src/config/sdk/testnet.config.ts:generic-api-key:9
-76241c92f25050ca6b73e77ce0514abc8c5038d8:src/config/sdk/mainnet.config.ts:generic-api-key:9
-76241c92f25050ca6b73e77ce0514abc8c5038d8:src/config/sdk/testnet.config.ts:generic-api-key:9
-aa4522559522cf1f207b834fbd0318ef96f1f635:src/app/api/kyc-challenge/route.ts:generic-api-key:5
-c65a422c4f96ba302c047fe1a4e3d6d74dcc2744:src/facade/chain-configs.ts:generic-api-key:18
-cee7050d62ae95f1b6d88592de8eaff576719d28:src/tests/sample.test.ts:generic-api-key:18
-f085d18b3b818f5853a934aee12ce1611afc738e:src/config/sdk/mainnet.config.ts:generic-api-key:9
-f085d18b3b818f5853a934aee12ce1611afc738e:src/config/sdk/testnet.config.ts:generic-api-key:9
-f92e12c74df7990a519eec7c4940a655cbaa3160:src/actions/getTokenPrice.ts:generic-api-key:52
-fc75e2491f414032d69a352f7a0e1fcd3f515f99:.env.local:generic-api-key:2

package/.prettierignore

@@ -1,3 +0,0 @@
-.nyc_output
-package-lock.json
-src/contracts/**

package/.prettierrc

@@ -1,28 +0,0 @@
-{
-    "arrowParens": "always",
-    "singleQuote": true,
-    "tabWidth": 4,
-    "semi": true,
-    "trailingComma": "all",
-    "endOfLine": "auto",
-    "overrides": [
-        {
-            "files": ".prettierrc",
-            "options": {
-                "parser": "json"
-            }
-        },
-        {
-            "files": ["*.ts", "*.mts"],
-            "options": {
-                "parser": "typescript"
-            }
-        },
-        {
-            "files": ["*.yml", "*.yaml"],
-            "options": {
-                "tabWidth": 2
-            }
-        }
-    ]
-}