@stablechain/sdk 1.0.2 → 1.0.4

package/dist/index.d.cts

@@ -17,6 +17,13 @@ interface StableConfig {
     walletClient?: WalletClient;
     /** Earn (Morpho V2 vault) configuration — required to use stable.earn.* methods. */
     earn?: EarnConfig;
+    /**
+     * Base URL for the Merkl rewards API (default: https://api.merkl.xyz).
+     * Override when calling from a browser to proxy through your own server and
+     * avoid CORS restrictions — Merkl does not send Access-Control-Allow-Origin
+     * headers for all chains.
+     */
+    merklApiBase?: string;
 }
 /**
  * Unified result for transfer, bridge, and swap.
@@ -88,7 +95,20 @@ declare enum Network {
 interface BridgeQuote {
     /** Estimated output amount on the destination chain */
     toAmount?: number;
+    /** LayerZero native messaging fee (wei) — only present for USDT0→USDT0 (OFT) routes */
+    nativeFee?: bigint;
+    /** LayerZero fee paid in LZ token (wei) — only present for USDT0→USDT0 (OFT) routes */
+    lzTokenFee?: bigint;
 }
+/**
+ * Bridge route selection:
+ * - `"usdt0"` — force the USDT0 LayerZero OFT path (no protocol fee, just gas + LZ
+ *   messaging fee; slower). Throws if the chain pair has no USDT0 adapter.
+ * - `"lifi"` — force the LI.FI aggregator path (fast, charges a fee).
+ * - `"auto"` — use USDT0 when both chains support it and tokens match, else LI.FI.
+ *   This is the default.
+ */
+type BridgeRoute = "auto" | "usdt0" | "lifi";
 interface BridgeParams {
     fromChain: Chain;
     toChain: Chain;
@@ -101,6 +121,11 @@ interface BridgeParams {
     fromDecimals?: number;
     /** Recipient address — defaults to the signer */
     recipient?: string;
+    /**
+     * Which bridge to use. Defaults to "auto" (USDT0 OFT when available, else LI.FI).
+     * See {@link BridgeRoute}.
+     */
+    route?: BridgeRoute;
     /** Pre-fetched quote from quoteBridge() — skips the quote fetch when passed to bridge() */
     quote?: BridgeQuote;
 }
@@ -145,6 +170,21 @@ interface EarnResult {
     txHash: string;
     idempotencyKey?: string;
 }
+interface EarnDepositCalldata {
+    /** Ordered transactions to send: optional token approval followed by the deposit */
+    steps: Array<{
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    chainId: number;
+}
+interface EarnWithdrawCalldata {
+    to: string;
+    data: string;
+    value: bigint;
+    chainId: number;
+}
 type BulkEarnResultItem = {
     status: "fulfilled";
     txHash: string;
@@ -221,6 +261,38 @@ interface ForceRedeemParams {
     /** Deduplication key */
     idempotencyKey?: string;
 }
+interface MerklRewardToken {
+    address: string;
+    symbol: string;
+    decimals: number;
+}
+interface MerklReward {
+    token: MerklRewardToken;
+    /** Raw cumulative claimable amount as a string (pass to BigInt for contract args) */
+    rawAmount: string;
+    /** Human-readable cumulative claimable amount */
+    amount: number;
+    /** Merkle proofs required for on-chain claiming */
+    proofs: string[];
+}
+interface MerklRewardsResult {
+    chainId: number;
+    rewards: MerklReward[];
+}
+interface MerklClaimResult {
+    txHash: string;
+    /** Number of distinct reward tokens claimed */
+    tokenCount: number;
+}
+interface MerklClaimCalldata {
+    /** Distributor contract to send the transaction to */
+    to: string;
+    /** ABI-encoded calldata for the claim function */
+    data: string;
+    chainId: number;
+    /** Rewards included in this calldata */
+    rewards: MerklReward[];
+}
 interface VaultYieldReward {
     /** Reward token symbol (e.g. "MORPHO") */
     symbol: string;
@@ -278,6 +350,8 @@ interface StableReaderConfig {
     earn?: EarnConfig;
     /** Address of the user whose position to read */
     address: string;
+    /** Base URL for the Merkl rewards API — see StableConfig.merklApiBase */
+    merklApiBase?: string;
 }
 
 interface StableClient {
@@ -294,6 +368,15 @@ interface StableClient {
         redeem(params: EarnRedeemParams): Promise<EarnResult>;
         forceWithdraw(params: ForceWithdrawParams): Promise<EarnResult>;
         forceRedeem(params: ForceRedeemParams): Promise<EarnResult>;
+        prepareDepositCalldata(params: EarnDepositParams): Promise<EarnDepositCalldata>;
+        prepareWithdrawCalldata(params: EarnWithdrawParams): Promise<EarnWithdrawCalldata>;
+        prepareRedeemCalldata(params: EarnRedeemParams): Promise<EarnWithdrawCalldata>;
+        incentiveRewards: {
+            /** Fetch pending Merkl rewards for the signer's address on the configured chain. */
+            fetch(): Promise<MerklRewardsResult>;
+            /** Claim all pending Merkl rewards for the signer on the configured chain. */
+            claim(): Promise<MerklClaimResult>;
+        };
     };
 }
 interface StableReader {
@@ -312,9 +395,13 @@ interface StableReader {
             amount: number;
             tokenDecimals?: number;
         }): Promise<WithdrawStatus>;
+        incentiveRewards: {
+            /** Fetch pending Merkl rewards for the configured address on the configured chain. */
+            fetch(): Promise<MerklRewardsResult>;
+        };
     };
 }
-declare function createStable({ network, rpc: rpcOverride, account, transport, walletClient, earn: earnConfig, }: StableConfig): StableClient;
+declare function createStable({ network, rpc: rpcOverride, account, transport, walletClient, earn: earnConfig, merklApiBase, }: StableConfig): StableClient;
 declare function createStableReader(config: StableReaderConfig): StableReader;
 
 interface ChainConfig {
@@ -326,6 +413,15 @@ interface ChainConfig {
 }
 declare const CHAIN_CONFIGS: Partial<Record<Chain, ChainConfig>>;
 
+interface BridgeChainConfig extends ChainConfig {
+    lzEid: number;
+    /** Only set on source chains that have an OFT Adapter deployed */
+    oftAdapter?: Address;
+    /** False when the OFT adapter exists but has no outbound send pathways configured */
+    lzOutbound?: boolean;
+}
+declare const BRIDGE_CHAIN_CONFIGS: Partial<Record<Chain, BridgeChainConfig>>;
+
 declare const STABLE_USDT_ADDRESS: Address;
 declare const STABLE_VAULT_ADDRESS: Address;
 
@@ -386,4 +482,4 @@ declare class StableBulkError extends StableError {
     });
 }
 
-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 };
+export { BRIDGE_CHAIN_CONFIGS, type BridgeChainConfig, type BridgeParams, type BridgeQuote, type BridgeRoute, type BulkDepositOptions, type BulkEarnResult, type BulkEarnResultItem, type BulkWithdrawOptions, CHAIN_CONFIGS, Chain, type ChainConfig, type EarnConfig, type EarnDepositCalldata, type EarnDepositParams, type EarnRedeemParams, type EarnResult, type EarnWithdrawCalldata, type EarnWithdrawParams, type ForceDeallocation, type ForceRedeemParams, type ForceWithdrawParams, type MerklClaimCalldata, type MerklClaimResult, type MerklReward, type MerklRewardToken, type MerklRewardsResult, 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

@@ -17,6 +17,13 @@ interface StableConfig {
     walletClient?: WalletClient;
     /** Earn (Morpho V2 vault) configuration — required to use stable.earn.* methods. */
     earn?: EarnConfig;
+    /**
+     * Base URL for the Merkl rewards API (default: https://api.merkl.xyz).
+     * Override when calling from a browser to proxy through your own server and
+     * avoid CORS restrictions — Merkl does not send Access-Control-Allow-Origin
+     * headers for all chains.
+     */
+    merklApiBase?: string;
 }
 /**
  * Unified result for transfer, bridge, and swap.
@@ -88,7 +95,20 @@ declare enum Network {
 interface BridgeQuote {
     /** Estimated output amount on the destination chain */
     toAmount?: number;
+    /** LayerZero native messaging fee (wei) — only present for USDT0→USDT0 (OFT) routes */
+    nativeFee?: bigint;
+    /** LayerZero fee paid in LZ token (wei) — only present for USDT0→USDT0 (OFT) routes */
+    lzTokenFee?: bigint;
 }
+/**
+ * Bridge route selection:
+ * - `"usdt0"` — force the USDT0 LayerZero OFT path (no protocol fee, just gas + LZ
+ *   messaging fee; slower). Throws if the chain pair has no USDT0 adapter.
+ * - `"lifi"` — force the LI.FI aggregator path (fast, charges a fee).
+ * - `"auto"` — use USDT0 when both chains support it and tokens match, else LI.FI.
+ *   This is the default.
+ */
+type BridgeRoute = "auto" | "usdt0" | "lifi";
 interface BridgeParams {
     fromChain: Chain;
     toChain: Chain;
@@ -101,6 +121,11 @@ interface BridgeParams {
     fromDecimals?: number;
     /** Recipient address — defaults to the signer */
     recipient?: string;
+    /**
+     * Which bridge to use. Defaults to "auto" (USDT0 OFT when available, else LI.FI).
+     * See {@link BridgeRoute}.
+     */
+    route?: BridgeRoute;
     /** Pre-fetched quote from quoteBridge() — skips the quote fetch when passed to bridge() */
     quote?: BridgeQuote;
 }
@@ -145,6 +170,21 @@ interface EarnResult {
     txHash: string;
     idempotencyKey?: string;
 }
+interface EarnDepositCalldata {
+    /** Ordered transactions to send: optional token approval followed by the deposit */
+    steps: Array<{
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    chainId: number;
+}
+interface EarnWithdrawCalldata {
+    to: string;
+    data: string;
+    value: bigint;
+    chainId: number;
+}
 type BulkEarnResultItem = {
     status: "fulfilled";
     txHash: string;
@@ -221,6 +261,38 @@ interface ForceRedeemParams {
     /** Deduplication key */
     idempotencyKey?: string;
 }
+interface MerklRewardToken {
+    address: string;
+    symbol: string;
+    decimals: number;
+}
+interface MerklReward {
+    token: MerklRewardToken;
+    /** Raw cumulative claimable amount as a string (pass to BigInt for contract args) */
+    rawAmount: string;
+    /** Human-readable cumulative claimable amount */
+    amount: number;
+    /** Merkle proofs required for on-chain claiming */
+    proofs: string[];
+}
+interface MerklRewardsResult {
+    chainId: number;
+    rewards: MerklReward[];
+}
+interface MerklClaimResult {
+    txHash: string;
+    /** Number of distinct reward tokens claimed */
+    tokenCount: number;
+}
+interface MerklClaimCalldata {
+    /** Distributor contract to send the transaction to */
+    to: string;
+    /** ABI-encoded calldata for the claim function */
+    data: string;
+    chainId: number;
+    /** Rewards included in this calldata */
+    rewards: MerklReward[];
+}
 interface VaultYieldReward {
     /** Reward token symbol (e.g. "MORPHO") */
     symbol: string;
@@ -278,6 +350,8 @@ interface StableReaderConfig {
     earn?: EarnConfig;
     /** Address of the user whose position to read */
     address: string;
+    /** Base URL for the Merkl rewards API — see StableConfig.merklApiBase */
+    merklApiBase?: string;
 }
 
 interface StableClient {
@@ -294,6 +368,15 @@ interface StableClient {
         redeem(params: EarnRedeemParams): Promise<EarnResult>;
         forceWithdraw(params: ForceWithdrawParams): Promise<EarnResult>;
         forceRedeem(params: ForceRedeemParams): Promise<EarnResult>;
+        prepareDepositCalldata(params: EarnDepositParams): Promise<EarnDepositCalldata>;
+        prepareWithdrawCalldata(params: EarnWithdrawParams): Promise<EarnWithdrawCalldata>;
+        prepareRedeemCalldata(params: EarnRedeemParams): Promise<EarnWithdrawCalldata>;
+        incentiveRewards: {
+            /** Fetch pending Merkl rewards for the signer's address on the configured chain. */
+            fetch(): Promise<MerklRewardsResult>;
+            /** Claim all pending Merkl rewards for the signer on the configured chain. */
+            claim(): Promise<MerklClaimResult>;
+        };
     };
 }
 interface StableReader {
@@ -312,9 +395,13 @@ interface StableReader {
             amount: number;
             tokenDecimals?: number;
         }): Promise<WithdrawStatus>;
+        incentiveRewards: {
+            /** Fetch pending Merkl rewards for the configured address on the configured chain. */
+            fetch(): Promise<MerklRewardsResult>;
+        };
     };
 }
-declare function createStable({ network, rpc: rpcOverride, account, transport, walletClient, earn: earnConfig, }: StableConfig): StableClient;
+declare function createStable({ network, rpc: rpcOverride, account, transport, walletClient, earn: earnConfig, merklApiBase, }: StableConfig): StableClient;
 declare function createStableReader(config: StableReaderConfig): StableReader;
 
 interface ChainConfig {
@@ -326,6 +413,15 @@ interface ChainConfig {
 }
 declare const CHAIN_CONFIGS: Partial<Record<Chain, ChainConfig>>;
 
+interface BridgeChainConfig extends ChainConfig {
+    lzEid: number;
+    /** Only set on source chains that have an OFT Adapter deployed */
+    oftAdapter?: Address;
+    /** False when the OFT adapter exists but has no outbound send pathways configured */
+    lzOutbound?: boolean;
+}
+declare const BRIDGE_CHAIN_CONFIGS: Partial<Record<Chain, BridgeChainConfig>>;
+
 declare const STABLE_USDT_ADDRESS: Address;
 declare const STABLE_VAULT_ADDRESS: Address;
 
@@ -386,4 +482,4 @@ declare class StableBulkError extends StableError {
     });
 }
 
-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 };
+export { BRIDGE_CHAIN_CONFIGS, type BridgeChainConfig, type BridgeParams, type BridgeQuote, type BridgeRoute, type BulkDepositOptions, type BulkEarnResult, type BulkEarnResultItem, type BulkWithdrawOptions, CHAIN_CONFIGS, Chain, type ChainConfig, type EarnConfig, type EarnDepositCalldata, type EarnDepositParams, type EarnRedeemParams, type EarnResult, type EarnWithdrawCalldata, type EarnWithdrawParams, type ForceDeallocation, type ForceRedeemParams, type ForceWithdrawParams, type MerklClaimCalldata, type MerklClaimResult, type MerklReward, type MerklRewardToken, type MerklRewardsResult, 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 };