@kasufinance/kasu-sdk 1.0.4 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/.claude/settings.local.json +15 -0
  2. package/CLAUDE.md +410 -0
  3. package/README.md +179 -12
  4. package/dist/bundle.cjs.js +616 -67
  5. package/dist/bundle.esm.js +612 -69
  6. package/dist/facade/chain-configs.d.ts +11 -0
  7. package/dist/facade/chain-configs.js +84 -0
  8. package/dist/facade/chain-configs.js.map +1 -0
  9. package/dist/facade/deposits.d.ts +56 -0
  10. package/dist/facade/deposits.js +87 -0
  11. package/dist/facade/deposits.js.map +1 -0
  12. package/dist/facade/index.d.ts +6 -0
  13. package/dist/facade/index.js +9 -0
  14. package/dist/facade/index.js.map +1 -0
  15. package/dist/facade/kasu.d.ts +71 -0
  16. package/dist/facade/kasu.js +101 -0
  17. package/dist/facade/kasu.js.map +1 -0
  18. package/dist/facade/strategies.d.ts +37 -0
  19. package/dist/facade/strategies.js +112 -0
  20. package/dist/facade/strategies.js.map +1 -0
  21. package/dist/facade/types.d.ts +127 -0
  22. package/dist/facade/types.js +2 -0
  23. package/dist/facade/types.js.map +1 -0
  24. package/dist/facade/user-portfolio.d.ts +35 -0
  25. package/dist/facade/user-portfolio.js +53 -0
  26. package/dist/facade/user-portfolio.js.map +1 -0
  27. package/dist/index.d.ts +9 -17
  28. package/dist/index.js +9 -16
  29. package/dist/index.js.map +1 -1
  30. package/dist/kasu-sdk.d.ts +17 -0
  31. package/dist/kasu-sdk.js +17 -0
  32. package/dist/kasu-sdk.js.map +1 -0
  33. package/dist/sdk-config.d.ts +28 -4
  34. package/dist/sdk-config.js +8 -6
  35. package/dist/sdk-config.js.map +1 -1
  36. package/dist/services/DataService/data-service.d.ts +9 -2
  37. package/dist/services/DataService/data-service.js +90 -52
  38. package/dist/services/DataService/data-service.js.map +1 -1
  39. package/dist/services/DataService/queries.d.ts +0 -1
  40. package/dist/services/DataService/queries.js +0 -8
  41. package/dist/services/DataService/queries.js.map +1 -1
  42. package/dist/services/DataService/subgraph-types.d.ts +0 -6
  43. package/dist/services/DataService/types.d.ts +0 -1
  44. package/dist/services/Locking/locking.d.ts +4 -2
  45. package/dist/services/Locking/locking.js +89 -7
  46. package/dist/services/Locking/locking.js.map +1 -1
  47. package/dist/services/Portfolio/portfolio.d.ts +1 -0
  48. package/dist/services/Portfolio/portfolio.js +9 -1
  49. package/dist/services/Portfolio/portfolio.js.map +1 -1
  50. package/dist/tests/facade.test.d.ts +1 -0
  51. package/dist/tests/facade.test.js +196 -0
  52. package/dist/tests/facade.test.js.map +1 -0
  53. package/dist/tests/sample.test.js +19 -14
  54. package/dist/tests/sample.test.js.map +1 -1
  55. package/dist/utils/deployment-mode.d.ts +6 -0
  56. package/dist/utils/deployment-mode.js +8 -0
  57. package/dist/utils/deployment-mode.js.map +1 -0
  58. package/package.json +2 -2
  59. package/src/facade/chain-configs.ts +93 -0
  60. package/src/facade/deposits.ts +102 -0
  61. package/src/facade/index.ts +26 -0
  62. package/src/facade/kasu.ts +144 -0
  63. package/src/facade/strategies.ts +119 -0
  64. package/src/facade/types.ts +168 -0
  65. package/src/facade/user-portfolio.ts +73 -0
  66. package/src/index.ts +59 -25
  67. package/src/kasu-sdk.ts +27 -0
  68. package/src/sdk-config.ts +36 -15
  69. package/src/services/DataService/data-service.ts +105 -65
  70. package/src/services/DataService/queries.ts +0 -9
  71. package/src/services/DataService/subgraph-types.ts +0 -7
  72. package/src/services/DataService/types.ts +0 -1
  73. package/src/services/Locking/locking.ts +113 -12
  74. package/src/services/Portfolio/portfolio.ts +15 -5
  75. package/src/tests/facade.test.ts +245 -0
  76. package/src/tests/sample.test.ts +7 -9
  77. package/src/utils/deployment-mode.ts +9 -0
@@ -13,20 +13,25 @@ import { SdkConfig } from '../sdk-config';
13
13
  test('subgraphCall', () => __awaiter(void 0, void 0, void 0, function* () {
14
14
  const provider = new ethers.providers.JsonRpcProvider('https://sepolia.base.org');
15
15
  const wallet = new ethers.Wallet('dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd', provider);
16
- const config = new SdkConfig('https://api.studio.thegraph.com/query/63245/kasu-wip-sepolia/version/latest', 'https://api.goldsky.com/api/public/project_cm9t3064xeuyn01tgctdo3c17/subgraphs/kasu-plume/prod/gn', {
17
- IKSULocking: '0x529A81c11ab6176c5E88670d293BB771800066a2',
18
- IKSULockBonus: '0xBBfFd5F744156FFc526df12F5e09dC7b208Be740',
19
- KSUToken: '0xa0f698Feb9Bc2BeA6E85eb071D5E3F59dc5bC56b',
20
- UserManager: '0xA788e9223fDd7c9Db91Ef133BbeB73515c174773',
21
- LendingPoolManager: '0xc074Aaf2565aae18db2c7498ee1387610a809F40',
22
- KasuAllowList: '0xaE94F9D187c9eA649ADd4966340831F7cc62B69c',
23
- SystemVariables: '0xB174a3240B23e595e90bC2736A5b8ec674Cba73A',
24
- UserLoyaltyRewards: '0x259631CE76FD9F65296549Cd81232aa59D53Dd0c',
25
- KsuPrice: '0x2027192aCFB4810Ad734A212F19d7030F698aCE3',
26
- ClearingCoordinator: '0x2027192aCFB4810Ad734A212F19d7030F698aCE3',
27
- KasuNFTs: '0x0000000000000000000000000000000000000000',
28
- ExternalTVL: '0x0000000000000000000000000000000000000000',
29
- }, 'https://kasu-finance.directus.app', ['']);
16
+ const config = new SdkConfig({
17
+ subgraphUrl: 'https://api.studio.thegraph.com/query/63245/kasu-wip-sepolia/version/latest',
18
+ contracts: {
19
+ IKSULocking: '0x529A81c11ab6176c5E88670d293BB771800066a2',
20
+ IKSULockBonus: '0xBBfFd5F744156FFc526df12F5e09dC7b208Be740',
21
+ KSUToken: '0xa0f698Feb9Bc2BeA6E85eb071D5E3F59dc5bC56b',
22
+ UserManager: '0xA788e9223fDd7c9Db91Ef133BbeB73515c174773',
23
+ LendingPoolManager: '0xc074Aaf2565aae18db2c7498ee1387610a809F40',
24
+ KasuAllowList: '0xaE94F9D187c9eA649ADd4966340831F7cc62B69c',
25
+ SystemVariables: '0xB174a3240B23e595e90bC2736A5b8ec674Cba73A',
26
+ UserLoyaltyRewards: '0x259631CE76FD9F65296549Cd81232aa59D53Dd0c',
27
+ KsuPrice: '0x2027192aCFB4810Ad734A212F19d7030F698aCE3',
28
+ ClearingCoordinator: '0x2027192aCFB4810Ad734A212F19d7030F698aCE3',
29
+ KasuNFTs: '0x0000000000000000000000000000000000000000',
30
+ ExternalTVL: '0x0000000000000000000000000000000000000000',
31
+ },
32
+ directusUrl: 'https://kasu-finance.directus.app',
33
+ UNUSED_LENDING_POOL_IDS: [''],
34
+ });
30
35
  const sdk = new KasuSdk(config, wallet);
31
36
  console.log(yield sdk.UserLending.getUserApyBonus('0xef38c432682ab49095e00442aaa354e955ac03a5'));
32
37
  }));
@@ -1 +1 @@
1
- {"version":3,"file":"sample.test.js","sourceRoot":"","sources":["../../src/tests/sample.test.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,IAAI,CAAC,cAAc,EAAE,GAAS,EAAE;IAC5B,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,eAAe,CACjD,0BAA0B,CAC7B,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAC5B,kEAAkE,EAClE,QAAQ,CACX,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,SAAS,CACxB,6EAA6E,EAC7E,mGAAmG,EACnG;QACI,WAAW,EAAE,4CAA4C;QACzD,aAAa,EAAE,4CAA4C;QAC3D,QAAQ,EAAE,4CAA4C;QACtD,WAAW,EAAE,4CAA4C;QACzD,kBAAkB,EAAE,4CAA4C;QAChE,aAAa,EAAE,4CAA4C;QAC3D,eAAe,EAAE,4CAA4C;QAC7D,kBAAkB,EAAE,4CAA4C;QAChE,QAAQ,EAAE,4CAA4C;QACtD,mBAAmB,EAAE,4CAA4C;QACjE,QAAQ,EAAE,4CAA4C;QACtD,WAAW,EAAE,4CAA4C;KAC5D,EAED,mCAAmC,EAEnC,CAAC,EAAE,CAAC,CACP,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC,OAAO,CAAC,GAAG,CACP,MAAM,GAAG,CAAC,WAAW,CAAC,eAAe,CACjC,4CAA4C,CAC/C,CACJ,CAAC;AACN,CAAC,CAAA,CAAC,CAAC"}
1
+ {"version":3,"file":"sample.test.js","sourceRoot":"","sources":["../../src/tests/sample.test.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C,IAAI,CAAC,cAAc,EAAE,GAAS,EAAE;IAC5B,MAAM,QAAQ,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,eAAe,CACjD,0BAA0B,CAC7B,CAAC;IAEF,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAC5B,kEAAkE,EAClE,QAAQ,CACX,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QACzB,WAAW,EACP,6EAA6E;QACjF,SAAS,EAAE;YACP,WAAW,EAAE,4CAA4C;YACzD,aAAa,EAAE,4CAA4C;YAC3D,QAAQ,EAAE,4CAA4C;YACtD,WAAW,EAAE,4CAA4C;YACzD,kBAAkB,EAAE,4CAA4C;YAChE,aAAa,EAAE,4CAA4C;YAC3D,eAAe,EAAE,4CAA4C;YAC7D,kBAAkB,EAAE,4CAA4C;YAChE,QAAQ,EAAE,4CAA4C;YACtD,mBAAmB,EAAE,4CAA4C;YACjE,QAAQ,EAAE,4CAA4C;YACtD,WAAW,EAAE,4CAA4C;SAC5D;QACD,WAAW,EAAE,mCAAmC;QAChD,uBAAuB,EAAE,CAAC,EAAE,CAAC;KAChC,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC,OAAO,CAAC,GAAG,CACP,MAAM,GAAG,CAAC,WAAW,CAAC,eAAe,CACjC,4CAA4C,CAC/C,CACJ,CAAC;AACN,CAAC,CAAA,CAAC,CAAC"}
@@ -0,0 +1,6 @@
1
+ import { SdkConfig } from '../sdk-config';
2
+ /**
3
+ * Check if the SDK is configured for a Lite deployment.
4
+ * Lite deployments don't have KSU token, locking, or loyalty features.
5
+ */
6
+ export declare function isLiteDeployment(config: SdkConfig): boolean;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Check if the SDK is configured for a Lite deployment.
3
+ * Lite deployments don't have KSU token, locking, or loyalty features.
4
+ */
5
+ export function isLiteDeployment(config) {
6
+ return config.isLiteDeployment;
7
+ }
8
+ //# sourceMappingURL=deployment-mode.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deployment-mode.js","sourceRoot":"","sources":["../../src/utils/deployment-mode.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAiB;IAC9C,OAAO,MAAM,CAAC,gBAAgB,CAAC;AACnC,CAAC"}
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@kasufinance/kasu-sdk",
3
- "version": "1.0.4",
3
+ "version": "2.1.0",
4
4
  "description": "",
5
5
  "main": "dist/bundle.cjs.js",
6
6
  "module": "dist/bundle.esm.js",
7
- "types": "dist/types/index.d.ts",
7
+ "types": "dist/index.d.ts",
8
8
  "scripts": {
9
9
  "test": "jest --config=jest-config.ts",
10
10
  "build-tc": "typechain --target ethers-v5 --out-dir src/contracts './abis/*.json'",
@@ -0,0 +1,93 @@
1
+ import { ChainConfigEntry } from './types';
2
+
3
+ /**
4
+ * Built-in chain configurations for Kasu-supported networks.
5
+ *
6
+ * Usage:
7
+ * ```ts
8
+ * import { CHAIN_CONFIGS } from '@kasufinance/kasu-sdk';
9
+ * const base = CHAIN_CONFIGS.base;
10
+ * ```
11
+ */
12
+ export const CHAIN_CONFIGS: Record<'base' | 'xdc' | 'plume', ChainConfigEntry> = {
13
+ base: {
14
+ chainId: 8453,
15
+ name: 'Base Mainnet',
16
+ isLiteDeployment: false,
17
+ contracts: {
18
+ KSUToken: '0x5D9b878744dbe721a3f33A60a6b102E289CeADBA',
19
+ IKSULocking: '0xB145C061684C701c2C018A3f322aa14F5A553CE1',
20
+ IKSULockBonus: '0xEEDE30AcF16caFf49c1a48F75185C67Be2e20B40',
21
+ LendingPoolManager: '0xE1Be322323a412579b4A09fB08ff4bfcA12096B5',
22
+ UserManager: '0x5Dc8D315a80fd99AbEF0f327B9a52a3FBC3C93f3',
23
+ KasuAllowList: '0x807A7e119EBf0282420b5Ca0e0056c0525cBf8BB',
24
+ SystemVariables: '0x193Bb02A24F5562b58fEB86550e6f09Bb6c41f69',
25
+ KsuPrice: '0x221a54CbbD5f490Bd8e77CF36acBA4B1304E5c1b',
26
+ UserLoyaltyRewards: '0xB4784f69Bb1F1076F50907cB0a815908a719D635',
27
+ ClearingCoordinator: '0x2cF12A6d91fa4bEB5a4C17589a03e78F88f57DE2',
28
+ KasuNFTs: '0x4946fF5f1a6550524C425479022D50446AA2968E',
29
+ ExternalTVL: '0x662379FEBb3e4F91400B5f7d4f7F7ce4699F3c9F',
30
+ },
31
+ subgraphUrl:
32
+ 'https://api.goldsky.com/api/public/project_cmgzlpxm300765np2a19421om/subgraphs/kasu-base/v1.0.13/gn',
33
+ directusUrl: 'https://kasu-finance.directus.app/',
34
+ unusedPoolIds: [],
35
+ poolMetadataMapping: undefined,
36
+ },
37
+
38
+ xdc: {
39
+ chainId: 50,
40
+ name: 'XDC Mainnet',
41
+ isLiteDeployment: true,
42
+ contracts: {
43
+ // No KSUToken on Lite deployments
44
+ IKSULocking: '0x7fF469f8c5fba92A9051B8D28794CBb891760e81',
45
+ IKSULockBonus: '0x7cc1434EfA50301Fdd56B7c5c6fF7e30Dc20C55c',
46
+ LendingPoolManager: '0xa46143db92aBe5bB1f61d13d8C1cCd50fc40Ca10',
47
+ UserManager: '0x9b57dF89e59235f0481A5Fae942302c8831e1B81',
48
+ KasuAllowList: '0x32c1Ff5FbBe6D28503ddc46E5001C0D13d6E9B2A',
49
+ SystemVariables: '0x34d17c9DD1f31Fb34757DE923EC083601d0eDFFe',
50
+ KsuPrice: '0x666b589933965bF8B378eD973f0404b6cae0eb52',
51
+ UserLoyaltyRewards: '0xb95834C5610A178be9065Dd1EF78258D29879CDb',
52
+ ClearingCoordinator: '0xAF0a66953Eba1c5353eB7425b398B213Bb2c6121',
53
+ // No KasuNFTs on Lite deployments
54
+ ExternalTVL: '0xCCB4156964377CF36441f3775A2A800dbeCB8094',
55
+ },
56
+ subgraphUrl:
57
+ 'https://api.goldsky.com/api/public/project_cmgzlpxm300765np2a19421om/subgraphs/kasu-xdc/v1.0.0/gn',
58
+ directusUrl: 'https://kasu-finance.directus.app/',
59
+ unusedPoolIds: [],
60
+ poolMetadataMapping: {
61
+ '0x20f42fb45f91657acf9528b99a5a16d0229c7800':
62
+ '0xc987350716fe4a7d674c3591c391d29eba26b8ce',
63
+ '0x3b7cb493aa22f731db2ab424d918e7375e00f6a9':
64
+ '0x03f93c8caa9a82e000d35673ba34a4c0e6e117a2',
65
+ '0xeda50c91a8c4ca8a83652b8542c0b3bd00a71fad':
66
+ '0xc347a9e4aec8c8d11a149d2907deb2bf23b81c6f',
67
+ },
68
+ },
69
+
70
+ plume: {
71
+ chainId: 98866,
72
+ name: 'Plume Mainnet',
73
+ isLiteDeployment: true,
74
+ contracts: {
75
+ // Placeholder — update when Plume contracts are deployed
76
+ IKSULocking: '',
77
+ IKSULockBonus: '',
78
+ LendingPoolManager: '',
79
+ UserManager: '',
80
+ KasuAllowList: '',
81
+ SystemVariables: '',
82
+ KsuPrice: '',
83
+ UserLoyaltyRewards: '',
84
+ ClearingCoordinator: '',
85
+ ExternalTVL: '',
86
+ },
87
+ subgraphUrl:
88
+ 'https://api.goldsky.com/api/public/project_cmgzlpxm300765np2a19421om/subgraphs/kasu-plume/prod',
89
+ directusUrl: 'https://kasu-finance.directus.app/',
90
+ unusedPoolIds: [],
91
+ poolMetadataMapping: undefined,
92
+ },
93
+ };
@@ -0,0 +1,102 @@
1
+ import { ContractTransaction } from 'ethers';
2
+
3
+ import { UserLending } from '../services/UserLending/user-lending';
4
+
5
+ import { DepositParams, KycParams, WithdrawParams } from './types';
6
+
7
+ /**
8
+ * High-level facade for deposit and withdrawal operations.
9
+ *
10
+ * Integrators use this to submit on-chain transactions without
11
+ * worrying about internal encoding details.
12
+ */
13
+ export class DepositsFacade {
14
+ constructor(
15
+ private _userLending: UserLending,
16
+ private _chainId: string,
17
+ ) {}
18
+
19
+ /**
20
+ * Submit a deposit request.
21
+ *
22
+ * The integrator must first obtain a KYC signature via the Nexera flow
23
+ * using the params from `buildKycParams()`.
24
+ *
25
+ * ```ts
26
+ * const kycParams = kasu.deposits.buildKycParams('0xUser...');
27
+ * // ... obtain kycSignature from your backend via Nexera ...
28
+ * const tx = await kasu.deposits.deposit({
29
+ * poolId: '0x...',
30
+ * trancheId: '0x...',
31
+ * amount: parseUnits('1000', 6),
32
+ * kycSignature: { blockExpiration, signature },
33
+ * });
34
+ * ```
35
+ */
36
+ async deposit(params: DepositParams): Promise<ContractTransaction> {
37
+ return await this._userLending.requestDepositWithKyc(
38
+ params.poolId,
39
+ params.trancheId,
40
+ params.amount,
41
+ params.swapData ?? '0x',
42
+ params.fixedTermConfigId ?? 0,
43
+ params.depositData ?? '0x',
44
+ params.kycSignature,
45
+ params.ethValue ?? '0',
46
+ );
47
+ }
48
+
49
+ /**
50
+ * Submit a withdrawal request for a specific USDC amount.
51
+ */
52
+ async withdraw(params: WithdrawParams): Promise<ContractTransaction> {
53
+ return await this._userLending.requestWithdrawalInUSDC(
54
+ params.poolId,
55
+ params.trancheId,
56
+ params.amount,
57
+ );
58
+ }
59
+
60
+ /**
61
+ * Withdraw the entire balance from a tranche.
62
+ */
63
+ async withdrawMax(
64
+ poolId: string,
65
+ trancheId: string,
66
+ userAddress: string,
67
+ ): Promise<ContractTransaction> {
68
+ return await this._userLending.requestWithdrawalMax(
69
+ poolId,
70
+ trancheId,
71
+ userAddress,
72
+ );
73
+ }
74
+
75
+ /**
76
+ * Build KYC signature parameters for the Nexera verification flow.
77
+ *
78
+ * The integrator is responsible for sending these to their backend,
79
+ * which obtains the signature from Nexera's signing service.
80
+ */
81
+ buildKycParams(userAddress: `0x${string}`): KycParams {
82
+ return this._userLending.buildKycSignatureParams(
83
+ userAddress,
84
+ this._chainId,
85
+ );
86
+ }
87
+
88
+ /**
89
+ * Check whether the pool is currently in a clearing period
90
+ * (deposits/withdrawals are temporarily paused).
91
+ */
92
+ async isClearingPending(poolId: string): Promise<boolean> {
93
+ return await this._userLending.isClearingPending(poolId);
94
+ }
95
+
96
+ /**
97
+ * Get the current epoch number.
98
+ */
99
+ async getCurrentEpoch(): Promise<string> {
100
+ return await this._userLending.getCurrentEpoch();
101
+ }
102
+ }
@@ -0,0 +1,26 @@
1
+ // Main entry point
2
+ export { Kasu } from './kasu';
3
+
4
+ // Individual facades (for advanced composition)
5
+ export { StrategiesFacade } from './strategies';
6
+ export { DepositsFacade } from './deposits';
7
+ export { PortfolioFacade } from './user-portfolio';
8
+
9
+ // Chain configurations
10
+ export { CHAIN_CONFIGS } from './chain-configs';
11
+
12
+ // All facade types
13
+ export type {
14
+ SupportedChain,
15
+ ChainConfigEntry,
16
+ KasuOptions,
17
+ Strategy,
18
+ StrategyTranche,
19
+ FixedTermOption,
20
+ DepositParams,
21
+ WithdrawParams,
22
+ DepositLimits,
23
+ KycParams,
24
+ UserPositions,
25
+ PlatformStats,
26
+ } from './types';
@@ -0,0 +1,144 @@
1
+ import { KasuSdk } from '../kasu-sdk';
2
+ import { SdkConfig } from '../sdk-config';
3
+
4
+ import { CHAIN_CONFIGS } from './chain-configs';
5
+ import { DepositsFacade } from './deposits';
6
+ import { StrategiesFacade } from './strategies';
7
+ import { ChainConfigEntry, KasuOptions, SupportedChain } from './types';
8
+ import { PortfolioFacade } from './user-portfolio';
9
+
10
+ /**
11
+ * High-level entry point for external integrators.
12
+ *
13
+ * Provides three domain facades — `strategies`, `deposits`, `portfolio` — and
14
+ * exposes the underlying `KasuSdk` services via `.services` for power-users.
15
+ *
16
+ * ```ts
17
+ * import { Kasu } from '@kasufinance/kasu-sdk';
18
+ *
19
+ * const kasu = Kasu.create({ chain: 'base', signerOrProvider: provider });
20
+ *
21
+ * // Browse strategies
22
+ * const strategies = await kasu.strategies.getAll();
23
+ *
24
+ * // Deposit
25
+ * const tx = await kasu.deposits.deposit({ poolId, trancheId, amount, kycSignature });
26
+ *
27
+ * // User positions
28
+ * const positions = await kasu.portfolio.getPositions(userAddress);
29
+ * ```
30
+ */
31
+ export class Kasu {
32
+ /** Browse lending strategies, APY, capacity. */
33
+ public readonly strategies: StrategiesFacade;
34
+ /** Deposit, withdraw, KYC helpers. */
35
+ public readonly deposits: DepositsFacade;
36
+ /** User positions, yields, transaction history. */
37
+ public readonly portfolio: PortfolioFacade;
38
+
39
+ private readonly _sdk: KasuSdk;
40
+ private readonly _chainConfig: ChainConfigEntry;
41
+
42
+ private constructor(
43
+ sdk: KasuSdk,
44
+ chainConfig: ChainConfigEntry,
45
+ ) {
46
+ this._sdk = sdk;
47
+ this._chainConfig = chainConfig;
48
+
49
+ this.strategies = new StrategiesFacade(
50
+ sdk.DataService,
51
+ sdk.UserLending,
52
+ );
53
+
54
+ this.deposits = new DepositsFacade(
55
+ sdk.UserLending,
56
+ chainConfig.chainId.toString(),
57
+ );
58
+
59
+ this.portfolio = new PortfolioFacade(
60
+ sdk.DataService,
61
+ sdk.UserLending,
62
+ sdk.Portfolio,
63
+ );
64
+ }
65
+
66
+ /**
67
+ * Create a Kasu instance with built-in chain config.
68
+ *
69
+ * ```ts
70
+ * // Minimal setup — uses built-in Base mainnet config
71
+ * const kasu = Kasu.create({ chain: 'base', signerOrProvider: provider });
72
+ *
73
+ * // Custom config override
74
+ * const kasu = Kasu.create({
75
+ * chain: 'base',
76
+ * signerOrProvider: signer,
77
+ * configOverrides: { UNUSED_LENDING_POOL_IDS: ['0x...'] },
78
+ * });
79
+ *
80
+ * // Fully custom chain
81
+ * const kasu = Kasu.create({
82
+ * chain: { chainId: 123, name: 'MyChain', ... },
83
+ * signerOrProvider: provider,
84
+ * });
85
+ * ```
86
+ */
87
+ static create(options: KasuOptions): Kasu {
88
+ const chainConfig = resolveChainConfig(options.chain);
89
+ const overrides = options.configOverrides ?? {};
90
+
91
+ const sdkConfig = new SdkConfig({
92
+ subgraphUrl: overrides.subgraphUrl ?? chainConfig.subgraphUrl,
93
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
94
+ contracts: overrides.contracts ?? chainConfig.contracts,
95
+ directusUrl:
96
+ overrides.directusUrl ?? chainConfig.directusUrl,
97
+ UNUSED_LENDING_POOL_IDS:
98
+ overrides.UNUSED_LENDING_POOL_IDS ??
99
+ chainConfig.unusedPoolIds,
100
+ isLiteDeployment:
101
+ overrides.isLiteDeployment ?? chainConfig.isLiteDeployment,
102
+ poolMetadataMapping:
103
+ overrides.poolMetadataMapping ??
104
+ chainConfig.poolMetadataMapping,
105
+ });
106
+
107
+ const sdk = new KasuSdk(sdkConfig, options.signerOrProvider);
108
+ return new Kasu(sdk, chainConfig);
109
+ }
110
+
111
+ /**
112
+ * Access the underlying `KasuSdk` services for advanced use cases.
113
+ *
114
+ * ```ts
115
+ * const locks = await kasu.services.Locking.getUserLocks(address);
116
+ * ```
117
+ */
118
+ get services(): KasuSdk {
119
+ return this._sdk;
120
+ }
121
+
122
+ /** The resolved chain configuration. */
123
+ get chainConfig(): ChainConfigEntry {
124
+ return this._chainConfig;
125
+ }
126
+
127
+ /** Whether this deployment has KSU token / locking features. */
128
+ get isLiteDeployment(): boolean {
129
+ return this._chainConfig.isLiteDeployment;
130
+ }
131
+ }
132
+
133
+ // ---------------------------------------------------------------------------
134
+ // Helpers
135
+ // ---------------------------------------------------------------------------
136
+
137
+ function resolveChainConfig(
138
+ chain: SupportedChain | ChainConfigEntry,
139
+ ): ChainConfigEntry {
140
+ if (typeof chain === 'string') {
141
+ return CHAIN_CONFIGS[chain];
142
+ }
143
+ return chain;
144
+ }
@@ -0,0 +1,119 @@
1
+ import { DataService } from '../services/DataService/data-service';
2
+ import { PoolOverview } from '../services/DataService/types';
3
+ import { UserLending } from '../services/UserLending/user-lending';
4
+
5
+ import {
6
+ DepositLimits,
7
+ FixedTermOption,
8
+ PlatformStats,
9
+ Strategy,
10
+ StrategyTranche,
11
+ } from './types';
12
+
13
+ /**
14
+ * High-level facade for browsing Kasu lending strategies (pools).
15
+ *
16
+ * Handles epoch fetching internally so callers never need to know about epochs.
17
+ */
18
+ export class StrategiesFacade {
19
+ constructor(
20
+ private _dataService: DataService,
21
+ private _userLending: UserLending,
22
+ ) {}
23
+
24
+ /**
25
+ * Fetch all active lending strategies.
26
+ *
27
+ * ```ts
28
+ * const strategies = await kasu.strategies.getAll();
29
+ * ```
30
+ */
31
+ async getAll(poolIds?: string[]): Promise<Strategy[]> {
32
+ const epochId = await this._userLending.getCurrentEpoch();
33
+ const pools = await this._dataService.getPoolOverview(epochId, poolIds);
34
+ return pools.map((pool) => this.mapPoolToStrategy(pool));
35
+ }
36
+
37
+ /**
38
+ * Fetch a single strategy by pool ID. Returns `null` if not found.
39
+ */
40
+ async getById(poolId: string): Promise<Strategy | null> {
41
+ const results = await this.getAll([poolId]);
42
+ return results[0] ?? null;
43
+ }
44
+
45
+ /**
46
+ * Aggregate platform statistics (TVL, loans, yield, loss rate).
47
+ */
48
+ async getPlatformStats(): Promise<PlatformStats> {
49
+ const epochId = await this._userLending.getCurrentEpoch();
50
+ const pools = await this._dataService.getPoolOverview(epochId);
51
+ return await this._dataService.getLendingTotals(pools);
52
+ }
53
+
54
+ /**
55
+ * Calculate deposit limits for a specific tranche.
56
+ *
57
+ * @param tranche - A `StrategyTranche` from `getAll()` or `getById()`.
58
+ * @returns min/max/capacity in ether-formatted USDC strings.
59
+ */
60
+ calculateDepositLimits(tranche: StrategyTranche): DepositLimits {
61
+ const raw = tranche._raw;
62
+ const min =
63
+ parseFloat(raw.minimumDeposit) < 1
64
+ ? '1'
65
+ : raw.minimumDeposit;
66
+
67
+ const max = parseFloat(raw.maximumDeposit) > parseFloat(raw.poolCapacity)
68
+ ? raw.poolCapacity
69
+ : raw.maximumDeposit;
70
+
71
+ return {
72
+ min,
73
+ max,
74
+ availableCapacity: raw.poolCapacity,
75
+ };
76
+ }
77
+
78
+ // ------------------------------------------------------------------
79
+ // Private helpers
80
+ // ------------------------------------------------------------------
81
+
82
+ private mapPoolToStrategy(pool: PoolOverview): Strategy {
83
+ const tranches: StrategyTranche[] = pool.tranches.map((t) => ({
84
+ id: t.id,
85
+ name: t.name,
86
+ apy: parseFloat(t.apy),
87
+ minApy: parseFloat(t.minApy),
88
+ maxApy: parseFloat(t.maxApy),
89
+ minimumDeposit: t.minimumDeposit,
90
+ maximumDeposit: t.maximumDeposit,
91
+ availableCapacity: t.poolCapacity,
92
+ fixedTermOptions: t.fixedTermConfig.map(
93
+ (ftd): FixedTermOption => ({
94
+ configId: ftd.configId,
95
+ apy: parseFloat(ftd.apy),
96
+ epochLockDuration: ftd.epochLockDuration,
97
+ }),
98
+ ),
99
+ _raw: t,
100
+ }));
101
+
102
+ return {
103
+ id: pool.id,
104
+ name: pool.poolName,
105
+ description: pool.description,
106
+ isActive: pool.isActive,
107
+ apy: pool.apy,
108
+ tvl: pool.totalValueLocked,
109
+ availableCapacity: pool.poolCapacity,
110
+ capacityUtilisation: pool.poolCapacityPercentage,
111
+ tranches,
112
+ assetClass: pool.assetClass,
113
+ apyStructure: pool.poolApyStructure,
114
+ thumbnailUrl: pool.thumbnailImageUrl,
115
+ bannerUrl: pool.bannerImageUrl,
116
+ _raw: pool,
117
+ };
118
+ }
119
+ }