@kasufinance/kasu-sdk 2.10.3 → 2.12.0

package/README.md

@@ -118,7 +118,7 @@ You can also pass a whole `ChainConfigEntry` instead of a chain key.
 | ----------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
 | `kasu.strategies` | `getAll()`, `getVisible()`, `getById()`, `getPlatformStats()`, `getPerformanceFeePercent()`, `calculateDepositLimits()`, `getRiskPerformance(poolId)`, `getOriginator(poolId)` | Browse pools, APY, capacity, risk, originator |
 | `kasu.deposits`   | `deposit()`, `withdraw()`, `withdrawMax()`, `buildKycParams()`, `isClearingPending()`                                   | Submit transactions             |
-| `kasu.portfolio`  | `getPositions()`, `getTransactionHistory()`, `getRequestStates()`                                                       | Lender balances, yield, history |
+| `kasu.portfolio`  | `getPositions()`, `getYieldHistory()`, `getTransactionHistory()`, `getRequestStates()`                                  | Lender balances, yield, per-cycle earnings (net, in the chain's own stable token), history |
 | `kasu.flows`      | `deposit(ports)`, `withdraw(ports?)`                                                                                    | Headless transaction pipelines  |
 | `kasu.calls`      | `requestWithdrawal(params)`, `cancelDepositRequest(poolId, dNftId)`, `cancelWithdrawalRequest(poolId, wNftId)`, `withdrawAtExpiry(poolId, lockId)` | Encoded calls for a sponsored relay (read, then encode — never sends) |
 
@@ -132,6 +132,16 @@ return an empty list; pass it straight through. `SdkConfig` normalises an empty
 exclusion list to `['']`, because the subgraph reads `id_not_in: []` as "match
 nothing" and would otherwise hide every pool.
 
+`kasu.portfolio.getYieldHistory(user, { fromEpoch?, count? })` returns one
+`{ epochId, epochEnd, poolId, trancheId, netYield }` per settled cycle the
+lender held shares in; `aggregateYieldHistory(entries, { poolId? })` turns it
+into chart bars. `netYield` is NET of the performance fee and in the
+deployment's own stable token (AUDD on XDC AUDD — convert before showing USD);
+`epochEnd` is unix seconds. For a fixed-term lock holder the bars can sum to
+slightly more than lifetime interest (up to about 0.2 %, top-ups are valued at
+today's share price), so show "earned to date" from the lifetime figure, not
+from the sum of the bars.
+
 ## Domain helpers
 
 Pure functions shared by every Kasu frontend. They return **numbers and codes,
@@ -149,6 +159,7 @@ application formats them in its own design system and language.
 | Yields               | `weeklyInterest`, `dailyInterest`, `accruedInterest`, `projectedAnnualEarnings`, `weightedAverageApy`, `SECONDS_PER_WEEK` — NET of the performance fee                                               |
 | Batch proof          | `validateDepositBatchCalls`, `proveDepositInReceipt`, `DepositBatchMismatchError`, `ENTRY_POINT_V07`                                                                                                   |
 | Tranche display name | `getTrancheDisplayName`, `UPPER_MEZZANINE`                                                                                                                                                               |
+| Strategy summary     | `pickShortDescription` — the CMS short blurb as one line of plain text, or `undefined` (also on every `Strategy` as `summary`)                                                                            |
 | Requests             | `deriveRequestState`, `submissionEvents`, `countSubmissions`, `firstSubmissionTimestamp`, `isCycleClosed`                                                                                                |
 | Settlement           | `computeSettlementWindow`, `nextCycleBoundary`, `deriveCycleDates`, `CLEARING_WINDOW_SECONDS`                                                                                                            |
 | Loan contract        | `encodeDepositData`, `buildContractVersionType`, `buildLoanAgreementSignMessage`, `buildLegacyContractRequestMessage`, `buildFullNameRequestMessage`, `formatSignTimestampUtc`, `parseFormattedMessage`, `asContractType` |
@@ -169,6 +180,14 @@ Three rules worth knowing:
   wrong number when an input is out of domain. Render that as "no rate", never
   as zero, and never substitute a fee of `0` for one you have not loaded — a
   fee-less rate overstates what a lender earns.
+- **`Strategy.summary` is CMS editorial, cleaned, never authored.** It is
+  `liteDescription` when usable, else the first paragraph of `description`,
+  with inline markdown markers stripped and whitespace collapsed to one line.
+  The `"Not Available"` placeholder and a blank value count as missing, and an
+  absent blurb is `undefined`: what to show instead is the app's decision.
+  `liteDescription` and `description` stay the raw CMS values. It is NOT
+  sanitised: HTML tags and link syntax pass through unchanged, so render it
+  as text, never as HTML or markdown.
 - **The tranche rename is display-only.** `getTrancheDisplayName` maps the
   `Senior` tranche to "Upper Mezzanine" on Apxium strategies, because the true
   senior position is held by an institutional lender. Call it at the view
@@ -558,6 +577,14 @@ network problem cannot fail a pull request that did not touch the network.
 CI runs `build-tc`, `build`, `test:unit` and `rollup-build` on every pull
 request.
 
+`npm ci` also installs a **pre-push hook** (`.githooks/pre-push`) that runs the
+same steps locally before every `git push`: first a lockfile check
+(`npm ci --dry-run`, which fails when `package.json` and `package-lock.json`
+disagree), then `build-tc`, `build`, `test:unit` and `rollup-build`. It stops at
+the first failing step and names it. It checks the working tree, not the pushed
+commits, so commit first. `SKIP_PREPUSH=1 git push` skips it with a warning; CI
+is still the gate.
+
 ## Versioning & publishing
 
 The package follows semantic versioning. The published runtime entry is the