@stablechain/sdk 1.0.0 → 1.0.2

package/dist/index.d.cts

@@ -118,6 +118,12 @@ interface EarnDepositParams {
     slippageTolerance?: number;
     /** Deduplication key: if an operation with this key is already in flight, the same Promise is returned. */
     idempotencyKey?: string;
+    /**
+     * Maximum fraction of the vault's idle liquidity that this deposit may consume (e.g. 0.8 = 80%).
+     * The SDK throws StableValidationError before sending the transaction if the amount exceeds the cap.
+     * Must be > 0 and ≤ 1. Omit to disable the check.
+     */
+    depositBuffer?: number;
 }
 interface EarnWithdrawParams {
     /** Amount of underlying assets to withdraw (human-readable) */
@@ -167,6 +173,15 @@ interface BulkDepositOptions {
      */
     stopOnError?: boolean;
 }
+interface BulkWithdrawOptions {
+    /** Batch-level deduplication key — if this batch is already in flight, the same Promise is returned. */
+    idempotencyKey?: string;
+    /**
+     * When true, the batch halts on the first failure and rejects.
+     * When false (default), all withdrawals are attempted and partial results are returned.
+     */
+    stopOnError?: boolean;
+}
 /**
  * A single adapter position to forcibly deallocate before a force withdraw/redeem.
  * `amount` is in underlying asset units (human-readable).
@@ -206,6 +221,26 @@ interface ForceRedeemParams {
     /** Deduplication key */
     idempotencyKey?: string;
 }
+interface VaultYieldReward {
+    /** Reward token symbol (e.g. "MORPHO") */
+    symbol: string;
+    /** Reward token contract address */
+    address: string;
+    /** APR contribution from this reward token as a decimal (e.g. 0.02 = 2%) */
+    apr: number;
+}
+interface VaultYield {
+    /** Total net APY after all fees, including rewards, as a decimal (e.g. 0.05 = 5%) */
+    apy: number;
+    /** Native yield component — underlying market rates after fees, excluding reward boosts */
+    native: number;
+    /** Per-token reward boosts */
+    rewards: VaultYieldReward[];
+    /** Performance fee as a decimal (e.g. 0.1 = 10%) */
+    performanceFee: number;
+    /** Management fee as a decimal */
+    managementFee: number;
+}
 interface VaultPosition {
     /** Raw vault share balance */
     shares: bigint;
@@ -255,6 +290,7 @@ interface StableClient {
         deposit(params: EarnDepositParams): Promise<EarnResult>;
         bulkDeposit(items: EarnDepositParams[], options?: BulkDepositOptions): Promise<BulkEarnResult>;
         withdraw(params: EarnWithdrawParams): Promise<EarnResult>;
+        bulkWithdraw(items: EarnWithdrawParams[], options?: BulkWithdrawOptions): Promise<BulkEarnResult>;
         redeem(params: EarnRedeemParams): Promise<EarnResult>;
         forceWithdraw(params: ForceWithdrawParams): Promise<EarnResult>;
         forceRedeem(params: ForceRedeemParams): Promise<EarnResult>;
@@ -262,6 +298,8 @@ interface StableClient {
 }
 interface StableReader {
     earn: {
+        /** Current net APY for the configured vault. */
+        getYield(): Promise<VaultYield>;
         /** Current vault position (shares + asset value) for the configured user address. */
         position(): Promise<VaultPosition>;
         /** Projected yield over a given horizon, using Morpho's live net APY. */
@@ -348,4 +386,4 @@ declare class StableBulkError extends StableError {
     });
 }
 
-export { type BridgeParams, type BridgeQuote, type BulkDepositOptions, type BulkEarnResult, type BulkEarnResultItem, CHAIN_CONFIGS, Chain, type ChainConfig, type EarnConfig, type EarnDepositParams, type EarnRedeemParams, type EarnResult, type EarnWithdrawParams, type ForceDeallocation, type ForceRedeemParams, type ForceWithdrawParams, Network, type OperationResult, STABLE_USDT_ADDRESS, STABLE_VAULT_ADDRESS, StableBulkError, type StableClient, type StableConfig, StableError, StableNetworkError, StableQuoteError, type StableReader, type StableReaderConfig, StableTransactionError, StableValidationError, type SwapParams, type SwapQuote, type TransferParams, type VaultPosition, type WithdrawStatus, type YieldPreview, createStable, createStableReader };
+export { type BridgeParams, type BridgeQuote, type BulkDepositOptions, type BulkEarnResult, type BulkEarnResultItem, type BulkWithdrawOptions, CHAIN_CONFIGS, Chain, type ChainConfig, type EarnConfig, type EarnDepositParams, type EarnRedeemParams, type EarnResult, type EarnWithdrawParams, type ForceDeallocation, type ForceRedeemParams, type ForceWithdrawParams, Network, type OperationResult, STABLE_USDT_ADDRESS, STABLE_VAULT_ADDRESS, StableBulkError, type StableClient, type StableConfig, StableError, StableNetworkError, StableQuoteError, type StableReader, type StableReaderConfig, StableTransactionError, StableValidationError, type SwapParams, type SwapQuote, type TransferParams, type VaultPosition, type VaultYield, type VaultYieldReward, type WithdrawStatus, type YieldPreview, createStable, createStableReader };

package/dist/index.d.ts

@@ -118,6 +118,12 @@ interface EarnDepositParams {
     slippageTolerance?: number;
     /** Deduplication key: if an operation with this key is already in flight, the same Promise is returned. */
     idempotencyKey?: string;
+    /**
+     * Maximum fraction of the vault's idle liquidity that this deposit may consume (e.g. 0.8 = 80%).
+     * The SDK throws StableValidationError before sending the transaction if the amount exceeds the cap.
+     * Must be > 0 and ≤ 1. Omit to disable the check.
+     */
+    depositBuffer?: number;
 }
 interface EarnWithdrawParams {
     /** Amount of underlying assets to withdraw (human-readable) */
@@ -167,6 +173,15 @@ interface BulkDepositOptions {
      */
     stopOnError?: boolean;
 }
+interface BulkWithdrawOptions {
+    /** Batch-level deduplication key — if this batch is already in flight, the same Promise is returned. */
+    idempotencyKey?: string;
+    /**
+     * When true, the batch halts on the first failure and rejects.
+     * When false (default), all withdrawals are attempted and partial results are returned.
+     */
+    stopOnError?: boolean;
+}
 /**
  * A single adapter position to forcibly deallocate before a force withdraw/redeem.
  * `amount` is in underlying asset units (human-readable).
@@ -206,6 +221,26 @@ interface ForceRedeemParams {
     /** Deduplication key */
     idempotencyKey?: string;
 }
+interface VaultYieldReward {
+    /** Reward token symbol (e.g. "MORPHO") */
+    symbol: string;
+    /** Reward token contract address */
+    address: string;
+    /** APR contribution from this reward token as a decimal (e.g. 0.02 = 2%) */
+    apr: number;
+}
+interface VaultYield {
+    /** Total net APY after all fees, including rewards, as a decimal (e.g. 0.05 = 5%) */
+    apy: number;
+    /** Native yield component — underlying market rates after fees, excluding reward boosts */
+    native: number;
+    /** Per-token reward boosts */
+    rewards: VaultYieldReward[];
+    /** Performance fee as a decimal (e.g. 0.1 = 10%) */
+    performanceFee: number;
+    /** Management fee as a decimal */
+    managementFee: number;
+}
 interface VaultPosition {
     /** Raw vault share balance */
     shares: bigint;
@@ -255,6 +290,7 @@ interface StableClient {
         deposit(params: EarnDepositParams): Promise<EarnResult>;
         bulkDeposit(items: EarnDepositParams[], options?: BulkDepositOptions): Promise<BulkEarnResult>;
         withdraw(params: EarnWithdrawParams): Promise<EarnResult>;
+        bulkWithdraw(items: EarnWithdrawParams[], options?: BulkWithdrawOptions): Promise<BulkEarnResult>;
         redeem(params: EarnRedeemParams): Promise<EarnResult>;
         forceWithdraw(params: ForceWithdrawParams): Promise<EarnResult>;
         forceRedeem(params: ForceRedeemParams): Promise<EarnResult>;
@@ -262,6 +298,8 @@ interface StableClient {
 }
 interface StableReader {
     earn: {
+        /** Current net APY for the configured vault. */
+        getYield(): Promise<VaultYield>;
         /** Current vault position (shares + asset value) for the configured user address. */
         position(): Promise<VaultPosition>;
         /** Projected yield over a given horizon, using Morpho's live net APY. */
@@ -348,4 +386,4 @@ declare class StableBulkError extends StableError {
     });
 }
 
-export { type BridgeParams, type BridgeQuote, type BulkDepositOptions, type BulkEarnResult, type BulkEarnResultItem, CHAIN_CONFIGS, Chain, type ChainConfig, type EarnConfig, type EarnDepositParams, type EarnRedeemParams, type EarnResult, type EarnWithdrawParams, type ForceDeallocation, type ForceRedeemParams, type ForceWithdrawParams, Network, type OperationResult, STABLE_USDT_ADDRESS, STABLE_VAULT_ADDRESS, StableBulkError, type StableClient, type StableConfig, StableError, StableNetworkError, StableQuoteError, type StableReader, type StableReaderConfig, StableTransactionError, StableValidationError, type SwapParams, type SwapQuote, type TransferParams, type VaultPosition, type WithdrawStatus, type YieldPreview, createStable, createStableReader };
+export { type BridgeParams, type BridgeQuote, type BulkDepositOptions, type BulkEarnResult, type BulkEarnResultItem, type BulkWithdrawOptions, CHAIN_CONFIGS, Chain, type ChainConfig, type EarnConfig, type EarnDepositParams, type EarnRedeemParams, type EarnResult, type EarnWithdrawParams, type ForceDeallocation, type ForceRedeemParams, type ForceWithdrawParams, Network, type OperationResult, STABLE_USDT_ADDRESS, STABLE_VAULT_ADDRESS, StableBulkError, type StableClient, type StableConfig, StableError, StableNetworkError, StableQuoteError, type StableReader, type StableReaderConfig, StableTransactionError, StableValidationError, type SwapParams, type SwapQuote, type TransferParams, type VaultPosition, type VaultYield, type VaultYieldReward, type WithdrawStatus, type YieldPreview, createStable, createStableReader };