@kasufinance/kasu-sdk 2.10.2 → 2.11.0

package/README.md

@@ -149,6 +149,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 +170,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 +567,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

package/dist/bundle.cjs.js

@@ -24219,9 +24219,10 @@ class SdkConfig {
 }
 
 /**
- * The single-call `LendingPoolManager` requests a sponsored relay may carry,
- * encoded by the SDK so no application hand-builds calldata or hand-maps the
- * relay's `kind` for them.
+ * The single-call requests a sponsored relay may carry — the four
+ * `LendingPoolManager` requests, plus the stable asset's own `transfer` (P2P
+ * Send) — encoded by the SDK so no application hand-builds calldata or
+ * hand-maps the relay's `kind` for them.
  *
  * Every function here is PURE: addresses and ids in, `{ kind, call }` out.
  * Reading the chain (the shares a withdrawal is for) is the facade's job —
@@ -24249,6 +24250,11 @@ const SPONSORED_CALL_KINDS = [
     'cancel_withdrawal',
     /** `LendingPoolManager.requestFixedTermDepositWithdrawal(pool, lockId)`. */
     'withdraw_at_expiry',
+    /**
+     * `stableAsset.transfer(to, amount)` — P2P Send, to the chain's stable
+     * asset rather than the manager. See {@link encodeStableTransfer}.
+     */
+    'transfer',
 ];
 /**
  * Widened to the plain `Interface`: the typechain one overloads
@@ -24256,7 +24262,9 @@ const SPONSORED_CALL_KINDS = [
  * `FUNCTION_OF`.
  */
 const LENDING_POOL_MANAGER$2 = ILendingPoolManagerAbi__factory.createInterface();
-/** The `LendingPoolManager` function behind each kind. */
+/** The generated ERC-20 interface — the `transfer` kind's one function. */
+const ERC20$2 = IERC20MetadataAbi__factory.createInterface();
+/** The `LendingPoolManager` function behind each manager kind. */
 const FUNCTION_OF = Object.freeze({
     withdrawal: 'requestWithdrawal',
     cancel_deposit: 'cancelDepositRequest',
@@ -24265,14 +24273,16 @@ const FUNCTION_OF = Object.freeze({
 });
 /**
  * The 4-byte selector of each kind's function, DERIVED from the generated
- * `ILendingPoolManager` ABI — never typed in by hand, so an ABI change moves
- * it and the cross-check spec against the relay's own pins goes red.
+ * ABIs (`ILendingPoolManager`, and `IERC20Metadata` for `transfer`) — never
+ * typed in by hand, so an ABI change moves it and the cross-check spec
+ * against the relay's own pins goes red.
  */
 const SPONSORED_CALL_SELECTORS = Object.freeze({
     withdrawal: LENDING_POOL_MANAGER$2.getSighash(FUNCTION_OF.withdrawal),
     cancel_deposit: LENDING_POOL_MANAGER$2.getSighash(FUNCTION_OF.cancel_deposit),
     cancel_withdrawal: LENDING_POOL_MANAGER$2.getSighash(FUNCTION_OF.cancel_withdrawal),
     withdraw_at_expiry: LENDING_POOL_MANAGER$2.getSighash(FUNCTION_OF.withdraw_at_expiry),
+    transfer: ERC20$2.getSighash('transfer'),
 });
 /**
  * What an encoder throws for an input it will not encode. `code` names the
@@ -24371,6 +24381,53 @@ function encodeWithdrawAtExpiryCall(lendingPoolManager, poolId, fixedTermDeposit
         toUint256(fixedTermDepositId, 'lock-id'),
     ]);
 }
+/**
+ * `stableAsset.transfer(to, amount)` — `transfer`: P2P Send of the chain's
+ * stable asset from the sender's own account (`msg.sender`) to `to`.
+ *
+ * `amount` is in the token's BASE units (6 decimals for USDC), and must be
+ * greater than zero. `to` must be a well-formed, non-zero address (a
+ * mixed-case one with a valid EIP-55 checksum). That is
+ * ALL this encoder judges, because it is all a pure function can know.
+ *
+ * The recipient POLICY is the relay's job and is deliberately not restated
+ * here: it refuses the sender's own account, the stable asset, the
+ * `LendingPoolManager`, the precompile range, any address with contract code
+ * (read on chain at submission), a sender our identity store does not hold
+ * as verified, and anything over the sender's daily count and amount caps.
+ * A call this encoder accepts can therefore still be refused — the app maps
+ * the relay's refusal codes to its own words.
+ *
+ * Pass `stableAsset` from the chain config (`CHAIN_CONFIGS[chain].stableAsset
+ * .address`) — the relay compares `to` against its own configured token and
+ * refuses any other contract.
+ */
+function encodeStableTransfer(input) {
+    assertAddress(input.stableAsset, 'stable-asset');
+    assertAddress(input.to, 'recipient');
+    // A mixed-case recipient carries an EIP-55 checksum, and one that does not
+    // match is a mistyped address: refuse it as `recipient` here rather than
+    // let the ABI coder throw its own error at the encode below.
+    try {
+        ethers.utils.getAddress(input.to);
+    }
+    catch (_a) {
+        throw new SponsoredCallInputError('recipient');
+    }
+    if (ethers.BigNumber.from(input.to).isZero()) {
+        throw new SponsoredCallInputError('zero-recipient');
+    }
+    const amount = toUint256(input.amount, 'amount');
+    if (amount.isZero())
+        throw new SponsoredCallInputError('zero-amount');
+    return {
+        kind: 'transfer',
+        call: {
+            to: input.stableAsset,
+            data: ERC20$2.encodeFunctionData('transfer', [input.to, amount]),
+        },
+    };
+}
 
 const ADDRESS_RE$1 = /^0x[0-9a-fA-F]{40}$/;
 /**
@@ -25602,7 +25659,10 @@ function checkBatchOutcome(transactionId, expect, ports) {
         }
         if (read.kind === 'reverted')
             return 'not-deposited';
-        if (read.kind !== 'mined' || typeof read.txHash !== 'string') {
+        // An empty hash is not an answer — `waitForMined` reads it the same way.
+        if (read.kind !== 'mined' ||
+            typeof read.txHash !== 'string' ||
+            read.txHash === '') {
             return 'unknown';
         }
         try {
@@ -25619,10 +25679,60 @@ function checkBatchOutcome(transactionId, expect, ports) {
         }
     });
 }
+// ---------------------------------------------------------------------------
+// One sponsored call — withdraw, cancel, withdraw at expiry, transfer
+// ---------------------------------------------------------------------------
+/**
+ * `checkBatchOutcome` for ONE sponsored call — ONE status read, no polling —
+ * for an app's guard against sending the same request twice (a P2P transfer
+ * whose earlier submission ended PENDING, say):
+ *
+ * - `executed` — mined, and the receipt proves the sender's operation
+ *   succeeded (`proveUserOperationInReceipt`);
+ * - `not-executed` — definitively reverted (vendor status or the operation's
+ *   own flag);
+ * - `unknown` — anything else, including a read or receipt that failed, or a
+ *   receipt that does not show the sender's operation.
+ *
+ * Only `not-executed` may let a new attempt proceed unprompted; `executed`
+ * means the earlier one landed and the user should be told.
+ */
+function checkSponsoredCallOutcome(transactionId, expect, ports) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        let read;
+        try {
+            read = yield ports.getStatus(transactionId);
+        }
+        catch (_b) {
+            return 'unknown';
+        }
+        if (read.kind === 'reverted')
+            return 'not-executed';
+        // An empty hash is not an answer — `waitForMined` reads it the same way.
+        if (read.kind !== 'mined' ||
+            typeof read.txHash !== 'string' ||
+            read.txHash === '') {
+            return 'unknown';
+        }
+        try {
+            const receipt = yield ports.getReceipt(read.txHash);
+            const proof = proveUserOperationInReceipt(receipt, Object.assign(Object.assign({}, expect), { userOperationHash: (_a = read.userOperationHash) !== null && _a !== void 0 ? _a : null }));
+            if (proof.kind === 'executed')
+                return 'executed';
+            if (proof.kind === 'reverted')
+                return 'not-executed';
+            return 'unknown';
+        }
+        catch (_c) {
+            return 'unknown';
+        }
+    });
+}
 /**
- * `submitBatch` for ONE sponsored `LendingPoolManager` call — the body of a
- * `WithdrawFlow` `submitCall` port, and of an app's cancel or
- * withdraw-at-expiry action. Same post, same polling policy, same outcome
+ * `submitBatch` for ONE sponsored call — the body of a `WithdrawFlow`
+ * `submitCall` port, of an app's cancel or withdraw-at-expiry action, and of
+ * a P2P transfer (`encodeStableTransfer`). Same post, same polling policy, same outcome
  * table; the proof is `proveUserOperationInReceipt` (the sender's operation
  * succeeded) instead of the deposit proof, and an unproven receipt is
  * `call_unproven:<reason>`.
@@ -25638,7 +25748,8 @@ function checkBatchOutcome(transactionId, expect, ports) {
  * The call is checked against its kind before anything is posted — a known
  * kind, exactly `{ to, data }`, and `data` opening with that kind's selector —
  * and a mismatch is `BatchSubmissionError('call_mismatch', 'failed')`: nothing
- * was sent. Build calls with `kasu.calls`, and this never fires.
+ * was sent. Build calls with `kasu.calls` (or `encodeStableTransfer`), and
+ * this never fires.
  *
  * As on the deposit path, nothing after the post ever produces `failed`.
  */
@@ -27434,6 +27545,82 @@ function maxNetRateCeiling(pools, feePercent) {
     return rate;
 }
 
+/**
+ * A strategy's SHORT blurb, as plain text: the CMS `liteDescription` first,
+ * else the first paragraph of the long `description`, else nothing.
+ *
+ * Lifted from kasu-ui (`pickShortDescription`, its deposit dialog and landing
+ * strategy card) so every app shows the same line, and pinned to its output
+ * for every live CMS row. The rules are facts about how the CMS is authored,
+ * not formatting preferences:
+ *
+ *   - `liteDescription` IS THE SHORT ONE. `description` is the credit
+ *     originator's several-paragraph profile; on a card it is a wall.
+ *   - `"Not Available"` IS A PLACEHOLDER, not editorial. Several rows carry it
+ *     verbatim, and it must read as missing, not print. Matched on the whole
+ *     trimmed value, case-insensitively. It applies to `liteDescription` only.
+ *   - EMPTY OR BLANK IS MISSING. The service maps a pool with no CMS record to
+ *     `''`.
+ *   - THE FIELDS HOLD MARKDOWN. `liteDescription` can open with a `**bold**`
+ *     lead, and the surfaces this feeds render plain text, so the markers are
+ *     stripped (bold, then italic, then inline code).
+ *   - AND HARD NEWLINES. Every run of whitespace becomes one space, so a
+ *     paragraph break inside the value is not a gap in a one-line slot.
+ *   - NOT SANITISED. "Plain text" means text to render AS text. HTML tags,
+ *     entities and link syntax (`<script>`, `&lt;`, `[a](javascript:…)`) pass
+ *     through unchanged, and removing markers can join fragments into a tag
+ *     (`<scr**i**pt>` becomes `<script>`). Render it as a text node, never as
+ *     HTML or markdown.
+ *
+ * Two refinements over the kasu-ui original, neither reachable by any live
+ * row: the cleaned text is trimmed (a CRLF value no longer ends in a space),
+ * and a `liteDescription` that cleans to nothing (`** **`) counts as missing,
+ * so the result is never a blank string.
+ *
+ * This authors no string of its own. It selects and cleans editorial the CMS
+ * already holds, and an absent blurb is `undefined`, never a fallback sentence:
+ * what "no blurb" means is the render site's decision.
+ *
+ * Pure. A value that is not a string reads as missing.
+ */
+function pickShortDescription(source) {
+    var _a;
+    const lite = asTrimmed(source.liteDescription);
+    if (lite && !NOT_AVAILABLE.test(lite)) {
+        const summary = toOneLine(lite);
+        if (summary)
+            return summary;
+    }
+    const long = asTrimmed(source.description);
+    if (long) {
+        const firstParagraph = (_a = long.split(PARAGRAPH_BREAK, 1)[0]) !== null && _a !== void 0 ? _a : long;
+        return toOneLine(firstParagraph) || undefined;
+    }
+    return undefined;
+}
+const NOT_AVAILABLE = /^not available$/i;
+const PARAGRAPH_BREAK = /\n\s*\n/;
+function asTrimmed(value) {
+    return typeof value === 'string' ? value.trim() : '';
+}
+/** Markers off, whitespace runs to one space, ends trimmed. `''` when nothing is left. */
+function toOneLine(text) {
+    return stripInlineMarkdown(text).replace(/\s+/gu, ' ').trim();
+}
+/**
+ * Inline markdown markers off, in the order bold → italic → code. The bold
+ * passes consume every `**` / `__` pair first, so the italic patterns can match
+ * a lone `*` / `_` without lookarounds.
+ */
+function stripInlineMarkdown(input) {
+    return input
+        .replace(/\*\*(.+?)\*\*/g, '$1')
+        .replace(/__(.+?)__/g, '$1')
+        .replace(/\*(.+?)\*/g, '$1')
+        .replace(/_(.+?)_/g, '$1')
+        .replace(/`([^`]+)`/g, '$1');
+}
+
 /**
  * High-level facade for browsing Kasu lending strategies (pools).
  *
@@ -27617,7 +27804,10 @@ class StrategiesFacade {
         return {
             id: pool.id,
             name: pool.poolName,
+            subheading: nonEmptyOrUndefined(pool.subheading),
             description: pool.description,
+            liteDescription: nonEmptyOrUndefined(pool.liteDescription),
+            summary: pickShortDescription(pool),
             isActive: pool.isActive,
             apy: pool.apy,
             tvl: pool.totalValueLocked,
@@ -27632,6 +27822,16 @@ class StrategiesFacade {
         };
     }
 }
+/**
+ * A CMS text field as a string, or `undefined` when it is absent, not a
+ * string, or empty (blank included) — the CMS stores an emptied field as `''`, and an empty
+ * subheading must read as "none", not render an empty line.
+ */
+function nonEmptyOrUndefined(value) {
+    return typeof value === 'string' && value.trim().length > 0
+        ? value
+        : undefined;
+}
 /**
  * A CMS "numeric" field as a finite number, or `null`. An empty or blank
  * string is UNAUTHORED, not zero.
@@ -29032,6 +29232,7 @@ exports.buildLoanAgreementSignMessage = buildLoanAgreementSignMessage;
 exports.cancelDeadline = cancelDeadline;
 exports.ceilToCents = ceilToCents;
 exports.checkBatchOutcome = checkBatchOutcome;
+exports.checkSponsoredCallOutcome = checkSponsoredCallOutcome;
 exports.classifyWalletFailure = classifyWalletFailure;
 exports.compareTrancheSeniority = compareTrancheSeniority;
 exports.computeSettlementWindow = computeSettlementWindow;
@@ -29045,6 +29246,7 @@ exports.encodeCancelDepositCall = encodeCancelDepositCall;
 exports.encodeCancelWithdrawalCall = encodeCancelWithdrawalCall;
 exports.encodeDepositData = encodeDepositData;
 exports.encodeRequestWithdrawalCall = encodeRequestWithdrawalCall;
+exports.encodeStableTransfer = encodeStableTransfer;
 exports.encodeWithdrawAtExpiryCall = encodeWithdrawAtExpiryCall;
 exports.epochRateToApy = epochRateToApy;
 exports.explorerAddressUrl = explorerAddressUrl;
@@ -29078,6 +29280,7 @@ exports.parseMinorUnits = parseMinorUnits;
 exports.parseTrancheBound = parseTrancheBound;
 exports.pickDefaultTrancheId = pickDefaultTrancheId;
 exports.pickHighestYieldTranche = pickHighestYieldTranche;
+exports.pickShortDescription = pickShortDescription;
 exports.poolAllTranchesFull = poolAllTranchesFull;
 exports.poolMaxApy = poolMaxApy;
 exports.projectedAnnualEarnings = projectedAnnualEarnings;