@kasufinance/kasu-sdk 2.6.0 → 2.7.1

package/src/facade/kasu.ts

@@ -1,11 +1,14 @@
 import { Provider } from '@ethersproject/providers';
 import { providers, Signer } from 'ethers';
 
+import { IERC20MetadataAbi__factory } from '../contracts';
+import type { IERC20MetadataAbi } from '../contracts';
 import { KasuSdk } from '../kasu-sdk';
 import { SdkConfig, SdkConfigOptions } from '../sdk-config';
 
 import { CHAIN_CONFIGS } from './chain-configs';
 import { DepositsFacade } from './deposits';
+import { FlowsFacade } from './flows';
 import { StrategiesFacade } from './strategies';
 import {
     ChainConfigEntry,
@@ -18,8 +21,9 @@ import { PortfolioFacade } from './user-portfolio';
 /**
  * High-level entry point for external integrators.
  *
- * Provides three domain facades — `strategies`, `deposits`, `portfolio` — and
- * exposes the underlying `KasuSdk` services via `.services` for power-users.
+ * Provides four domain facades — `strategies`, `deposits`, `portfolio`,
+ * `flows` — and exposes the underlying `KasuSdk` services via `.services` for
+ * power-users.
  *
  * ```ts
  * import { Kasu } from '@kasufinance/kasu-sdk';
@@ -43,6 +47,8 @@ export class Kasu {
     public readonly deposits: DepositsFacade;
     /** User positions, yields, transaction history. */
     public readonly portfolio: PortfolioFacade;
+    /** Headless deposit / withdraw state machines. */
+    public readonly flows: FlowsFacade;
 
     private readonly _sdk: KasuSdk;
     private readonly _chainConfig: ChainConfigEntry;
@@ -70,10 +76,15 @@ export class Kasu {
             sdk.UserLending,
         );
 
+        // Derived ONCE and handed to every facade that needs it. Each of them
+        // re-deriving `Signer.isSigner` is how two facades come to disagree
+        // about whether the same instance can write.
+        const isReadOnly = !Signer.isSigner(signerOrProvider);
+
         this.deposits = new DepositsFacade(
             sdk.UserLending,
             chainConfig.chainId.toString(),
-            !Signer.isSigner(signerOrProvider),
+            isReadOnly,
         );
 
         this.portfolio = new PortfolioFacade(
@@ -81,6 +92,13 @@ export class Kasu {
             sdk.UserLending,
             sdk.Portfolio,
         );
+
+        this.flows = new FlowsFacade(
+            this.deposits,
+            () => erc20Of(chainConfig, signerOrProvider),
+            isReadOnly,
+            chainConfig.contracts.LendingPoolManager,
+        );
     }
 
     /**
@@ -241,6 +259,28 @@ function rpcUrlsOf(chainConfig: ChainConfigEntry): string[] {
     return (chainConfig as { rpcUrls?: string[] }).rpcUrls ?? [];
 }
 
+/**
+ * The chain's stable token, bound to whatever this instance holds.
+ *
+ * Built per call rather than cached: it is one `new Contract`, and a cached
+ * binding would outlive the signer a `connect()` replaced. A config with no
+ * `stableAsset` (a hand-written entry from before 2.5.0) throws here rather
+ * than inside ethers, naming the two ports that make the flow work without
+ * one.
+ */
+function erc20Of(
+    chainConfig: ChainConfigEntry,
+    signerOrProvider: Provider | Signer,
+): IERC20MetadataAbi {
+    const address = stableAssetOf(chainConfig)?.address;
+    if (!address) {
+        throw new Error(
+            'Kasu: this chain config has no stableAsset; pass readAllowance and approve ports explicitly',
+        );
+    }
+    return IERC20MetadataAbi__factory.connect(address, signerOrProvider);
+}
+
 /**
  * The read-only provider used when the caller passes no `signerOrProvider`.
  *

package/src/facade/read-only.ts

@@ -0,0 +1,13 @@
+/**
+ * The refusal every write path shares when the instance holds a Provider
+ * rather than a Signer.
+ *
+ * One constant, because the message's job is to name the fix — `kasu.connect`
+ * — and three near-identical wordings across the facades would be three
+ * different pieces of advice for one problem. ethers' own
+ * "sending a transaction requires a signer" arrives several frames deeper,
+ * after the params have been encoded, and says nothing about how to get a
+ * signer onto THIS object.
+ */
+export const READ_ONLY_MESSAGE =
+    'Kasu: this instance is read-only; call kasu.connect(signer) first';