@t2000/sdk 1.6.0 → 1.7.0

package/dist/index.d.cts

@@ -536,6 +536,56 @@ interface ComposeTxOptions {
      * `addSwapToTx`'s `input.overlayFee`.
      */
     overlayFee?: OverlayFeeConfig;
+    /**
+     * Optional fee-injection hooks for save_deposit + borrow. Fires inside
+     * the appender at the exact moment the user's coin is in hand and BEFORE
+     * the protocol step consumes (save) or the canonical transferObjects
+     * finalizes (borrow). Audric host uses this to inline `addFeeTransfer`
+     * for USDC SAVE_FEE_BPS / BORROW_FEE_BPS without ever leaving the
+     * canonical write contract — keeps the SDK fee-free per CLAUDE.md
+     * rule #9 while letting hosts charge their own overlay fees.
+     *
+     * Hooks are fire-and-forget (no return value). They mutate `tx` directly
+     * (e.g., `addFeeTransfer(tx, coin, ...)` splits the fee chunk off and
+     * appends a top-level `transferObjects` to the host's fee wallet — that
+     * recipient automatically appears in `derivedAllowedAddresses`).
+     */
+    feeHooks?: ComposeTxFeeHooks;
+}
+/**
+ * Per-tool fee-injection callbacks. Each hook fires at a tool-specific
+ * moment in the appender flow (see field JSDoc). Currently scoped to
+ * the 2 fee-eligible tools — extend if/when new ones land.
+ */
+interface ComposeTxFeeHooks {
+    /**
+     * Fires inside the `save_deposit` appender AFTER the user's USDC/USDsui
+     * coin is split into the deposit amount, BEFORE NAVI's `deposit` move
+     * call consumes the coin. Order matters: the `coin` reference passed in
+     * is the SAME `TransactionObjectArgument` that flows into the deposit,
+     * so any `splitCoins(coin, [feeAmount])` inside the hook reduces the
+     * deposit by exactly that fee.
+     */
+    save_deposit?: (ctx: ComposeTxFeeHookContext<SaveDepositInput>) => void | Promise<void>;
+    /**
+     * Fires inside the `borrow` appender AFTER NAVI returns the borrowed
+     * coin, BEFORE the canonical `transferObjects(coin, sender)` finalizes.
+     * The `coin` reference is the borrowed-and-not-yet-transferred output;
+     * splitting a fee here means the user receives the remainder.
+     */
+    borrow?: (ctx: ComposeTxFeeHookContext<BorrowInput>) => void | Promise<void>;
+}
+/**
+ * Context object passed to every fee hook. Carries the `tx` (mutate it),
+ * the in-flight `coin` (split fees off it), the resolved tool input
+ * (asset/amount for fee-policy decisions), and the sender (rarely needed
+ * but kept for symmetry with `AppenderContext`).
+ */
+interface ComposeTxFeeHookContext<TInput> {
+    tx: Transaction;
+    coin: TransactionObjectArgument;
+    input: TInput;
+    sender: string;
 }
 /** Per-step preview returned by each registry appender. Tool-specific shape. */
 type StepPreview = {
@@ -601,6 +651,7 @@ interface AppenderContext {
     sender: string;
     sponsoredContext: boolean;
     overlayFee?: OverlayFeeConfig;
+    feeHooks?: ComposeTxFeeHooks;
 }
 type AppenderFn<TInput, TPreview extends StepPreview> = (tx: Transaction, input: TInput, ctx: AppenderContext) => Promise<TPreview>;
 /**
@@ -803,4 +854,4 @@ declare function addUnstakeVSuiToTx(tx: Transaction, client: SuiJsonRpcClient, a
     effectiveAmountMist: bigint | 'all';
 }>;
 
-export { type AppenderContext, BalanceResponse, type BorrowInput, BorrowResult, type ClaimRewardsInput, ClaimRewardsResult, type CoinPage, type ComposeTxOptions, type ComposeTxResult, CompoundRewardsResult, ContactManager, DepositInfo, EarningsResult, FinancialSummary, type FinancialSummaryOptions, FundStatusResult, HF_CRITICAL_THRESHOLD, HF_WARN_THRESHOLD, HealthFactorResult, LendingAdapter, LendingRates, MaxBorrowResult, MaxWithdrawResult, OverlayFeeConfig, PayOptions, PayResult, PaymentRequest, PendingReward, PositionsResult, RatesResult, type RepayDebtInput, RepayResult, SafeguardConfig, SafeguardEnforcer, type SaveDepositInput, SaveResult, type SelectAndSplitResult, SendResult, type SendTransferInput, StakeVSuiResult, type StepPreview, SupportedAsset, type SwapExecuteInput, SwapQuoteResult, SwapResult, SwapRouteResult, T2000, T2000Error, T2000Options, TransactionRecord, TransactionSigner, TxMetadata, UnstakeVSuiResult, VOLO_METADATA, VOLO_PKG, VOLO_POOL, VSUI_TYPE, type VoloStakeInput, type VoloStats, type VoloUnstakeInput, WRITE_APPENDER_REGISTRY, type WithdrawInput, WithdrawResult, type WriteStep, type WriteToolName, ZkLoginProof, addSendToTx, addStakeVSuiToTx, addUnstakeVSuiToTx, buildClaimRewardsTx, buildSendTx, buildStakeVSuiTx, buildUnstakeVSuiTx, composeTx, deriveAllowedAddressesFromPtb, exportPrivateKey, fetchAllCoins, generateKeypair, getAddress, getFinancialSummary, getPendingRewards, getRates, getSwapQuote, getVoloStats, keypairFromPrivateKey, loadKey, saveKey, selectAndSplitCoin, selectSuiCoin, walletExists };
+export { type AppenderContext, BalanceResponse, type BorrowInput, BorrowResult, type ClaimRewardsInput, ClaimRewardsResult, type CoinPage, type ComposeTxFeeHookContext, type ComposeTxFeeHooks, type ComposeTxOptions, type ComposeTxResult, CompoundRewardsResult, ContactManager, DepositInfo, EarningsResult, FinancialSummary, type FinancialSummaryOptions, FundStatusResult, HF_CRITICAL_THRESHOLD, HF_WARN_THRESHOLD, HealthFactorResult, LendingAdapter, LendingRates, MaxBorrowResult, MaxWithdrawResult, OverlayFeeConfig, PayOptions, PayResult, PaymentRequest, PendingReward, PositionsResult, RatesResult, type RepayDebtInput, RepayResult, SafeguardConfig, SafeguardEnforcer, type SaveDepositInput, SaveResult, type SelectAndSplitResult, SendResult, type SendTransferInput, StakeVSuiResult, type StepPreview, SupportedAsset, type SwapExecuteInput, SwapQuoteResult, SwapResult, SwapRouteResult, T2000, T2000Error, T2000Options, TransactionRecord, TransactionSigner, TxMetadata, UnstakeVSuiResult, VOLO_METADATA, VOLO_PKG, VOLO_POOL, VSUI_TYPE, type VoloStakeInput, type VoloStats, type VoloUnstakeInput, WRITE_APPENDER_REGISTRY, type WithdrawInput, WithdrawResult, type WriteStep, type WriteToolName, ZkLoginProof, addSendToTx, addStakeVSuiToTx, addUnstakeVSuiToTx, buildClaimRewardsTx, buildSendTx, buildStakeVSuiTx, buildUnstakeVSuiTx, composeTx, deriveAllowedAddressesFromPtb, exportPrivateKey, fetchAllCoins, generateKeypair, getAddress, getFinancialSummary, getPendingRewards, getRates, getSwapQuote, getVoloStats, keypairFromPrivateKey, loadKey, saveKey, selectAndSplitCoin, selectSuiCoin, walletExists };

package/dist/index.d.ts

@@ -536,6 +536,56 @@ interface ComposeTxOptions {
      * `addSwapToTx`'s `input.overlayFee`.
      */
     overlayFee?: OverlayFeeConfig;
+    /**
+     * Optional fee-injection hooks for save_deposit + borrow. Fires inside
+     * the appender at the exact moment the user's coin is in hand and BEFORE
+     * the protocol step consumes (save) or the canonical transferObjects
+     * finalizes (borrow). Audric host uses this to inline `addFeeTransfer`
+     * for USDC SAVE_FEE_BPS / BORROW_FEE_BPS without ever leaving the
+     * canonical write contract — keeps the SDK fee-free per CLAUDE.md
+     * rule #9 while letting hosts charge their own overlay fees.
+     *
+     * Hooks are fire-and-forget (no return value). They mutate `tx` directly
+     * (e.g., `addFeeTransfer(tx, coin, ...)` splits the fee chunk off and
+     * appends a top-level `transferObjects` to the host's fee wallet — that
+     * recipient automatically appears in `derivedAllowedAddresses`).
+     */
+    feeHooks?: ComposeTxFeeHooks;
+}
+/**
+ * Per-tool fee-injection callbacks. Each hook fires at a tool-specific
+ * moment in the appender flow (see field JSDoc). Currently scoped to
+ * the 2 fee-eligible tools — extend if/when new ones land.
+ */
+interface ComposeTxFeeHooks {
+    /**
+     * Fires inside the `save_deposit` appender AFTER the user's USDC/USDsui
+     * coin is split into the deposit amount, BEFORE NAVI's `deposit` move
+     * call consumes the coin. Order matters: the `coin` reference passed in
+     * is the SAME `TransactionObjectArgument` that flows into the deposit,
+     * so any `splitCoins(coin, [feeAmount])` inside the hook reduces the
+     * deposit by exactly that fee.
+     */
+    save_deposit?: (ctx: ComposeTxFeeHookContext<SaveDepositInput>) => void | Promise<void>;
+    /**
+     * Fires inside the `borrow` appender AFTER NAVI returns the borrowed
+     * coin, BEFORE the canonical `transferObjects(coin, sender)` finalizes.
+     * The `coin` reference is the borrowed-and-not-yet-transferred output;
+     * splitting a fee here means the user receives the remainder.
+     */
+    borrow?: (ctx: ComposeTxFeeHookContext<BorrowInput>) => void | Promise<void>;
+}
+/**
+ * Context object passed to every fee hook. Carries the `tx` (mutate it),
+ * the in-flight `coin` (split fees off it), the resolved tool input
+ * (asset/amount for fee-policy decisions), and the sender (rarely needed
+ * but kept for symmetry with `AppenderContext`).
+ */
+interface ComposeTxFeeHookContext<TInput> {
+    tx: Transaction;
+    coin: TransactionObjectArgument;
+    input: TInput;
+    sender: string;
 }
 /** Per-step preview returned by each registry appender. Tool-specific shape. */
 type StepPreview = {
@@ -601,6 +651,7 @@ interface AppenderContext {
     sender: string;
     sponsoredContext: boolean;
     overlayFee?: OverlayFeeConfig;
+    feeHooks?: ComposeTxFeeHooks;
 }
 type AppenderFn<TInput, TPreview extends StepPreview> = (tx: Transaction, input: TInput, ctx: AppenderContext) => Promise<TPreview>;
 /**
@@ -803,4 +854,4 @@ declare function addUnstakeVSuiToTx(tx: Transaction, client: SuiJsonRpcClient, a
     effectiveAmountMist: bigint | 'all';
 }>;
 
-export { type AppenderContext, BalanceResponse, type BorrowInput, BorrowResult, type ClaimRewardsInput, ClaimRewardsResult, type CoinPage, type ComposeTxOptions, type ComposeTxResult, CompoundRewardsResult, ContactManager, DepositInfo, EarningsResult, FinancialSummary, type FinancialSummaryOptions, FundStatusResult, HF_CRITICAL_THRESHOLD, HF_WARN_THRESHOLD, HealthFactorResult, LendingAdapter, LendingRates, MaxBorrowResult, MaxWithdrawResult, OverlayFeeConfig, PayOptions, PayResult, PaymentRequest, PendingReward, PositionsResult, RatesResult, type RepayDebtInput, RepayResult, SafeguardConfig, SafeguardEnforcer, type SaveDepositInput, SaveResult, type SelectAndSplitResult, SendResult, type SendTransferInput, StakeVSuiResult, type StepPreview, SupportedAsset, type SwapExecuteInput, SwapQuoteResult, SwapResult, SwapRouteResult, T2000, T2000Error, T2000Options, TransactionRecord, TransactionSigner, TxMetadata, UnstakeVSuiResult, VOLO_METADATA, VOLO_PKG, VOLO_POOL, VSUI_TYPE, type VoloStakeInput, type VoloStats, type VoloUnstakeInput, WRITE_APPENDER_REGISTRY, type WithdrawInput, WithdrawResult, type WriteStep, type WriteToolName, ZkLoginProof, addSendToTx, addStakeVSuiToTx, addUnstakeVSuiToTx, buildClaimRewardsTx, buildSendTx, buildStakeVSuiTx, buildUnstakeVSuiTx, composeTx, deriveAllowedAddressesFromPtb, exportPrivateKey, fetchAllCoins, generateKeypair, getAddress, getFinancialSummary, getPendingRewards, getRates, getSwapQuote, getVoloStats, keypairFromPrivateKey, loadKey, saveKey, selectAndSplitCoin, selectSuiCoin, walletExists };
+export { type AppenderContext, BalanceResponse, type BorrowInput, BorrowResult, type ClaimRewardsInput, ClaimRewardsResult, type CoinPage, type ComposeTxFeeHookContext, type ComposeTxFeeHooks, type ComposeTxOptions, type ComposeTxResult, CompoundRewardsResult, ContactManager, DepositInfo, EarningsResult, FinancialSummary, type FinancialSummaryOptions, FundStatusResult, HF_CRITICAL_THRESHOLD, HF_WARN_THRESHOLD, HealthFactorResult, LendingAdapter, LendingRates, MaxBorrowResult, MaxWithdrawResult, OverlayFeeConfig, PayOptions, PayResult, PaymentRequest, PendingReward, PositionsResult, RatesResult, type RepayDebtInput, RepayResult, SafeguardConfig, SafeguardEnforcer, type SaveDepositInput, SaveResult, type SelectAndSplitResult, SendResult, type SendTransferInput, StakeVSuiResult, type StepPreview, SupportedAsset, type SwapExecuteInput, SwapQuoteResult, SwapResult, SwapRouteResult, T2000, T2000Error, T2000Options, TransactionRecord, TransactionSigner, TxMetadata, UnstakeVSuiResult, VOLO_METADATA, VOLO_PKG, VOLO_POOL, VSUI_TYPE, type VoloStakeInput, type VoloStats, type VoloUnstakeInput, WRITE_APPENDER_REGISTRY, type WithdrawInput, WithdrawResult, type WriteStep, type WriteToolName, ZkLoginProof, addSendToTx, addStakeVSuiToTx, addUnstakeVSuiToTx, buildClaimRewardsTx, buildSendTx, buildStakeVSuiTx, buildUnstakeVSuiTx, composeTx, deriveAllowedAddressesFromPtb, exportPrivateKey, fetchAllCoins, generateKeypair, getAddress, getFinancialSummary, getPendingRewards, getRates, getSwapQuote, getVoloStats, keypairFromPrivateKey, loadKey, saveKey, selectAndSplitCoin, selectSuiCoin, walletExists };

package/dist/index.js

@@ -7466,6 +7466,9 @@ var WRITE_APPENDER_REGISTRY = {
       assetInfo.type,
       rawAmount
     );
+    if (ctx.feeHooks?.save_deposit) {
+      await ctx.feeHooks.save_deposit({ tx, coin, input, sender: ctx.sender });
+    }
     await addSaveToTx(tx, ctx.client, ctx.sender, coin, { asset });
     return {
       toolName: "save_deposit",
@@ -7500,6 +7503,9 @@ var WRITE_APPENDER_REGISTRY = {
       input.amount,
       { asset, skipPythUpdate: ctx.sponsoredContext }
     );
+    if (ctx.feeHooks?.borrow) {
+      await ctx.feeHooks.borrow({ tx, coin, input, sender: ctx.sender });
+    }
     tx.transferObjects([coin], ctx.sender);
     return { toolName: "borrow", effectiveAmount: input.amount, asset };
   },
@@ -7647,7 +7653,8 @@ async function composeTx(opts) {
     client: opts.client,
     sender: opts.sender,
     sponsoredContext: opts.sponsoredContext ?? false,
-    overlayFee: opts.overlayFee
+    overlayFee: opts.overlayFee,
+    feeHooks: opts.feeHooks
   };
   const previews = [];
   for (const step of opts.steps) {