@kasufinance/kasu-sdk 2.10.2 → 2.11.0

package/src/facade/strategies.ts

@@ -1,4 +1,5 @@
 import { selectVisiblePools } from '../domain/pools';
+import { pickShortDescription } from '../domain/strategy-summary';
 import { DataService } from '../services/DataService/data-service';
 import {
     PoolDelegateProfileAndHistory,
@@ -215,7 +216,10 @@ export 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,
@@ -231,6 +235,17 @@ export 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: unknown): string | undefined {
+    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.

package/src/facade/types.ts

@@ -1,7 +1,11 @@
 import { BigNumberish, BytesLike } from 'ethers';
 
 import { ContractAddresses, SdkConfigOptions } from '../sdk-config';
-import { LendingTotals, PoolOverview, TrancheData } from '../services/DataService/types';
+import {
+    LendingTotals,
+    PoolOverview,
+    TrancheData,
+} from '../services/DataService/types';
 import {
     PortfolioLendingPool,
     PortfolioSummary,
@@ -106,7 +110,30 @@ export interface KasuOptions {
 export interface Strategy {
     id: string;
     name: string;
+    /**
+     * The CMS subheading (the borrower type shown under the name). Absent when
+     * the record has none, or an empty one.
+     */
+    subheading?: string;
     description: string;
+    /**
+     * The CMS short description (`liteDescription`) for compact surfaces.
+     * Absent when the record has none, or an empty one.
+     */
+    liteDescription?: string;
+    /**
+     * The strategy's short blurb as ONE line of plain text, for cards and
+     * compact surfaces: `liteDescription` when it is usable, else the first
+     * paragraph of `description`, with inline markdown markers stripped and
+     * every run of whitespace collapsed to one space. The `"Not Available"`
+     * placeholder, an empty or blank value, and a missing one all count as
+     * absent. `undefined` when neither field yields a blurb; the SDK never
+     * substitutes a sentence of its own. See `pickShortDescription`.
+     *
+     * Not sanitised: HTML tags and link syntax pass through unchanged. Render
+     * it as text, never as HTML or markdown.
+     */
+    summary?: string;
     isActive: boolean;
     /** Weighted-average APY across tranches (decimal, e.g. 0.08 = 8 %). */
     apy: number;

package/src/flows/batch-submission.ts

@@ -349,7 +349,12 @@ export async function checkBatchOutcome<R extends ReceiptLike = ReceiptLike>(
         return 'unknown';
     }
     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 {
@@ -367,9 +372,60 @@ export async function checkBatchOutcome<R extends ReceiptLike = ReceiptLike>(
 }
 
 // ---------------------------------------------------------------------------
-// One sponsored call — withdraw, cancel, withdraw at expiry
+// 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.
+ */
+export async function checkSponsoredCallOutcome<
+    R extends ReceiptLike = ReceiptLike,
+>(
+    transactionId: string,
+    expect: Omit<UserOperationProofExpectation, 'userOperationHash'>,
+    ports: Pick<BatchSubmissionPorts<R>, 'getStatus' | 'getReceipt'>,
+): Promise<'executed' | 'not-executed' | 'unknown'> {
+    let read: BatchStatusRead;
+    try {
+        read = await ports.getStatus(transactionId);
+    } catch {
+        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 = await ports.getReceipt(read.txHash);
+        const proof = proveUserOperationInReceipt(receipt, {
+            ...expect,
+            userOperationHash: read.userOperationHash ?? null,
+        });
+        if (proof.kind === 'executed') return 'executed';
+        if (proof.kind === 'reverted') return 'not-executed';
+        return 'unknown';
+    } catch {
+        return 'unknown';
+    }
+}
+
 /**
  * `BatchSubmissionPorts` for ONE sponsored call: the same status, receipt and
  * clock ports — a relay client written for the deposit batch serves both —
@@ -409,9 +465,9 @@ export interface SponsoredCallSubmission<R extends ReceiptLike = ReceiptLike>
 }
 
 /**
- * `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>`.
@@ -427,7 +483,8 @@ export interface SponsoredCallSubmission<R extends ReceiptLike = ReceiptLike>
  * 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`.
  */

package/src/flows/index.ts

@@ -21,6 +21,7 @@ export type { BatchSubmissionOutcome } from './batch-errors';
 
 export {
     checkBatchOutcome,
+    checkSponsoredCallOutcome,
     DEFAULT_BATCH_POLLING_POLICY,
     submitBatch,
     submitSponsoredCall,