@cetusprotocol/aggregator-sdk 1.6.0 → 1.6.1

package/README.md

@@ -27,6 +27,8 @@ Easy Integration: The aggregator is designed to be simple and easy to integrate.
 
 Multi-Platform Support: Currently, we have integrated multiple mainstream DEXs on the Sui chain, including cetus, deepbook, kriya, flowx, aftermath, afsui, haedal, volo, turbos etc, allowing users to enjoy a diversified trading experience on a single platform.
 
+Sponsored Transactions: The SDK can build swap PTBs that do not use the user's gas coin, allowing a separate sponsor account to pay transaction gas.
+
 By using our aggregator, you can trade more efficiently and securely on the Sui blockchain, fully leveraging the various opportunities brought by decentralized finance (DeFi).
 
 # Aggregator SDK
@@ -55,7 +57,7 @@ const from = "0x2::sui::SUI"
 const target =
   "0x06864a6f921804860930db6ddbe2e16acdf8504495ea7481637a1c8b9a8fe54b::cetus::CETUS"
 
-const routers = await client.findRouters({
+const routerRes = await client.findRouters({
   from,
   target,
   amount,
@@ -70,7 +72,7 @@ const txb = new Transaction()
 
 if (routerRes != null) {
   await client.fastRouterSwap({
-    routers,
+    router: routerRes,
     txb,
     slippage: 0.01,
   })
@@ -85,7 +87,83 @@ if (routerRes != null) {
 }
 ```
 
-### 4. Build PTB and return target coin
+### 4. Sponsored transaction: sponsor pays gas
+
+Set `sponsored: true` when building the swap. In this mode the swap does not use `txb.gas` as input or output, because the gas coin belongs to the sponsor.
+
+```typescript
+import { Transaction } from "@mysten/sui/transactions"
+import { SUI_TYPE_ARG } from "@mysten/sui/utils"
+
+const sender = userSigner.toSuiAddress()
+const sponsor = sponsorSigner.toSuiAddress()
+const txb = new Transaction()
+
+await client.fastRouterSwap({
+  router: routerRes,
+  txb,
+  slippage: 0.01,
+  sponsored: true,
+})
+
+// Build command-only bytes. Pass sender so CoinWithBalance can resolve
+// the user's input coins before the sponsor adds gas data.
+const txKindBytes = await client.buildTransactionKind(txb, sender)
+
+const { objects: gasCoins } = await client.client.listCoins({
+  owner: sponsor,
+  coinType: SUI_TYPE_ARG,
+  limit: 1,
+})
+
+const sponsorCoins = gasCoins.map((coin) => ({
+  objectId: coin.objectId,
+  version: coin.version,
+  digest: coin.digest,
+}))
+
+const sponsoredTx = client.buildSponsoredTransaction({
+  txKindBytes,
+  sender,
+  sponsor,
+  sponsorCoins,
+  gasBudget: "100000000",
+})
+
+const result = await client.signAndExecuteSponsoredTransaction(
+  sponsoredTx,
+  userSigner,
+  sponsorSigner
+)
+```
+
+For a gas-station integration, the same flow is split across two parties: the user builds `txKindBytes`, the sponsor sets `gasOwner` and `gasPayment`, then both parties sign the same full transaction bytes.
+
+#### Sponsor secret for the real transaction test
+
+The real sponsored transaction test reuses the existing wallet secret as the user/sender and adds one sponsor secret:
+
+```bash
+SUI_WALLET_SECRET="user_base64_secret" \
+SUI_SPONSOR_SECRET="sponsor_base64_secret" \
+npx vitest run tests/unit/sponsored.test.ts
+```
+
+`SUI_WALLET_SECRET` owns the swap input coins and signs as the transaction sender. `SUI_SPONSOR_SECRET` owns the gas coin and signs as the gas sponsor. Use two different accounts; the sponsor account only needs enough SUI to cover `SPONSORED_GAS_BUDGET` (`100000000` MIST by default).
+
+Optional test variables:
+
+```bash
+SPONSORED_SWAP_AMOUNT=1000000
+SPONSORED_GAS_BUDGET=100000000
+SUI_RPC="https://fullnode.mainnet.sui.io:443"
+```
+
+If either secret is missing, `tests/unit/sponsored.test.ts` is skipped and no transaction is submitted.
+
+Keep both secrets in your local shell or `.env` file, and do not commit them.
+
+### 5. Build PTB and return target coin
 
 ```typescript
 const txb = new Transaction()
@@ -93,7 +171,7 @@ const byAmountIn = true
 
 if (routerRes != null) {
   const targetCoin = await client.routerSwap({
-    routers,
+    router: routerRes,
     txb,
     inputCoin,
     slippage: 0.01,

package/dist/index.cjs

@@ -3416,7 +3416,7 @@ var AGGREGATOR_V3_CONFIG = {
 };
 
 // src/api.ts
-var SDK_VERSION = 1010600;
+var SDK_VERSION = 1010601;
 function parseRouterResponse(data, byAmountIn) {
   let packages = /* @__PURE__ */ new Map();
   if (data.packages) {
@@ -9589,7 +9589,15 @@ var _AggregatorClient = class _AggregatorClient {
   // auto build input coin
   // auto merge, transfer or destory target coin.
   async fastRouterSwap(params) {
-    const { router, slippage, txb, partner, cetusDlmmPartner, payDeepFeeAmount } = params;
+    const {
+      router,
+      slippage,
+      txb,
+      partner,
+      cetusDlmmPartner,
+      payDeepFeeAmount,
+      sponsored = false
+    } = params;
     const fromCoinType = router.paths[0].from;
     const targetCoinType = router.paths[router.paths.length - 1].target;
     const byAmountIn = router.byAmountIn;
@@ -9614,7 +9622,7 @@ var _AggregatorClient = class _AggregatorClient {
     const amount = byAmountIn ? expectedAmountIn : amountLimit;
     let inputCoin = transactions.coinWithBalance({
       balance: BigInt(amount.toString()),
-      useGasCoin: true,
+      useGasCoin: !sponsored,
       type: fromCoinType
     });
     let deepCoin;
@@ -9634,22 +9642,46 @@ var _AggregatorClient = class _AggregatorClient {
       deepbookv3DeepFee: deepCoin
     };
     const targetCoin = await this.routerSwap(routerSwapParams);
+    await this.deliverTargetCoin(
+      txb,
+      targetCoin,
+      targetCoinType,
+      router.packages,
+      sponsored
+    );
+  }
+  // Delivers a swap's output coin. In sponsored mode the SDK must not query or touch
+  // coins through `this.signer`, because the transaction sender may be different from
+  // the SDK instance signer. Let the router transfer helper deliver the output to the
+  // transaction sender instead.
+  async deliverTargetCoin(txb, targetCoin, targetCoinType, packages, sponsored) {
+    if (sponsored) {
+      transferOrDestroyCoin(
+        {
+          coin: targetCoin,
+          coinType: targetCoinType,
+          packages
+        },
+        txb
+      );
+      return;
+    }
     if (CoinUtils.isSuiCoin(targetCoinType)) {
       txb.mergeCoins(txb.gas, [targetCoin]);
+      return;
+    }
+    const targetCoinObjID = await this.getOneCoinUsedToMerge(targetCoinType);
+    if (targetCoinObjID != null) {
+      txb.mergeCoins(txb.object(targetCoinObjID), [targetCoin]);
     } else {
-      const targetCoinObjID = await this.getOneCoinUsedToMerge(targetCoinType);
-      if (targetCoinObjID != null) {
-        txb.mergeCoins(txb.object(targetCoinObjID), [targetCoin]);
-      } else {
-        transferOrDestroyCoin(
-          {
-            coin: targetCoin,
-            coinType: targetCoinType,
-            packages: router.packages
-          },
-          txb
-        );
-      }
+      transferOrDestroyCoin(
+        {
+          coin: targetCoin,
+          coinType: targetCoinType,
+          packages
+        },
+        txb
+      );
     }
   }
   async mergeSwap(params) {
@@ -9698,7 +9730,7 @@ var _AggregatorClient = class _AggregatorClient {
     return finalOutputCoin;
   }
   async fastMergeSwap(params) {
-    const { router, slippage, txb, partner } = params;
+    const { router, slippage, txb, partner, sponsored = false } = params;
     if (!router || !router.allRoutes || router.allRoutes.length === 0) {
       throw new Error("Invalid router: no routes found");
     }
@@ -9714,7 +9746,7 @@ var _AggregatorClient = class _AggregatorClient {
       coinTypeSet.add(firstCoinType);
       const coin = transactions.coinWithBalance({
         balance: BigInt(route.amountIn.toString()),
-        useGasCoin: CoinUtils.isSuiCoin(firstCoinType),
+        useGasCoin: !sponsored && CoinUtils.isSuiCoin(firstCoinType),
         type: firstCoinType
       });
       inputCoins.push({ coinType: firstCoinType, coin });
@@ -9727,23 +9759,13 @@ var _AggregatorClient = class _AggregatorClient {
       partner: partner ?? this.partner
     };
     const targetCoin = await this.mergeSwap(mergeSwapParams);
-    if (CoinUtils.isSuiCoin(targetCoinType)) {
-      txb.mergeCoins(txb.gas, [targetCoin]);
-    } else {
-      const targetCoinObjID = await this.getOneCoinUsedToMerge(targetCoinType);
-      if (targetCoinObjID != null) {
-        txb.mergeCoins(txb.object(targetCoinObjID), [targetCoin]);
-      } else {
-        transferOrDestroyCoin(
-          {
-            coin: targetCoin,
-            coinType: targetCoinType,
-            packages: router.packages
-          },
-          txb
-        );
-      }
-    }
+    await this.deliverTargetCoin(
+      txb,
+      targetCoin,
+      targetCoinType,
+      router.packages,
+      sponsored
+    );
   }
   async fixableRouterSwapV3(params) {
     const { router, inputCoin, slippage, txb, partner } = params;
@@ -9942,6 +9964,70 @@ var _AggregatorClient = class _AggregatorClient {
     });
     return res;
   }
+  // ---------------------------------------------------------------------------
+  // Sponsored transactions
+  //
+  // A sponsored transaction lets a sponsor (gas station) pay gas for a transaction
+  // whose commands are authored by a different sender. The sender and the sponsor both
+  // sign the same transaction bytes, and the transaction is submitted with both
+  // signatures. See: https://docs.sui.io/concepts/transactions/sponsored-transactions
+  //
+  // Build the swap with `sponsored: true` (e.g. `fastRouterSwap`/`fastMergeSwap`) so the
+  // gas coin is never used, then:
+  //   - Remote gas station: `buildTransactionKind(txb, sender)` -> station assembles gas
+  //     data with `buildSponsoredTransaction` -> station builds/signs full bytes -> user
+  //     signs the same bytes -> `executeWithSignatures`.
+  //   - Local sponsor (both keypairs available): `signAndExecuteSponsoredTransaction`.
+  // ---------------------------------------------------------------------------
+  // Builds the TransactionKind bytes (commands only, no gas data) to hand to a sponsor /
+  // gas station. Pass `sender` when the transaction contains CoinWithBalance intents,
+  // because those are resolved while building the kind.
+  async buildTransactionKind(txb, sender) {
+    if (sender) {
+      txb.setSender(sender);
+    }
+    return txb.build({ client: this.client, onlyTransactionKind: true });
+  }
+  // Assembles a sponsored transaction from TransactionKind bytes plus the gas data
+  // provided by the sponsor. The returned transaction is ready to be built and signed by
+  // both the sender and the sponsor.
+  buildSponsoredTransaction(params) {
+    const { txKindBytes, sender, sponsor, sponsorCoins, gasBudget, gasPrice } = params;
+    const tx = transactions.Transaction.fromKind(txKindBytes);
+    tx.setSender(sender);
+    tx.setGasOwner(sponsor);
+    tx.setGasPayment(sponsorCoins);
+    if (gasBudget != null) {
+      tx.setGasBudget(gasBudget);
+    }
+    if (gasPrice != null) {
+      tx.setGasPrice(gasPrice);
+    }
+    return tx;
+  }
+  // Builds the full transaction bytes (including gas data) that both parties must sign.
+  // Returns the exact bytes the signatures must be produced over.
+  async buildTransactionBytes(txb) {
+    return txb.build({ client: this.client });
+  }
+  // Executes a transaction from pre-built bytes plus the collected signatures. The
+  // signatures MUST be produced over exactly these `bytes` (see `buildTransactionBytes`).
+  async executeWithSignatures(bytes, signatures) {
+    return this.client.executeTransaction({
+      transaction: bytes,
+      signatures,
+      include: { effects: true, events: true, balanceChanges: true }
+    });
+  }
+  // Convenience for the local dual-key case: signs the transaction with both the user's
+  // and the sponsor's signer and executes it. `txb` must already have its sender, gas
+  // owner and gas payment set (e.g. via `buildSponsoredTransaction`).
+  async signAndExecuteSponsoredTransaction(txb, userSigner, sponsorSigner) {
+    const bytes = await txb.build({ client: this.client });
+    const { signature: sponsorSig } = await sponsorSigner.signTransaction(bytes);
+    const { signature: userSig } = await userSigner.signTransaction(bytes);
+    return this.executeWithSignatures(bytes, [userSig, sponsorSig]);
+  }
 };
 _AggregatorClient.CONFIG = {
   [1 /* Testnet */]: {

package/dist/index.d.cts

@@ -21,10 +21,6 @@ interface MergeSwapFromCoin {
     coinType: string;
     amount: BN | string | number | bigint;
 }
-interface MergeSwapFromCoin {
-    coinType: string;
-    amount: BN | string | number | bigint;
-}
 interface MergeSwapParams {
     target: string;
     byAmountIn: boolean;
@@ -32,17 +28,6 @@ interface MergeSwapParams {
     providers?: string[];
     froms: MergeSwapFromCoin[];
 }
-interface MergeSwapParams {
-    target: string;
-    byAmountIn: boolean;
-    depth?: number;
-    providers?: string[];
-    froms: MergeSwapFromCoin[];
-}
-interface MergeSwapInputCoin {
-    coinType: string;
-    coin: TransactionObjectArgument;
-}
 interface MergeSwapInputCoin {
     coinType: string;
     coin: TransactionObjectArgument;
@@ -54,26 +39,13 @@ interface BuildMergeSwapParams {
     txb: Transaction;
     partner?: string;
 }
-interface BuildMergeSwapParams {
-    router: MergeSwapRouterData;
-    inputCoins: MergeSwapInputCoin[];
-    slippage: number;
-    txb: Transaction;
-    partner?: string;
-}
-interface BuildFastMergeSwapParams {
-    router: MergeSwapRouterData;
-    slippage: number;
-    txb: Transaction;
-    partner?: string;
-    payDeepFeeAmount?: number;
-}
 interface BuildFastMergeSwapParams {
     router: MergeSwapRouterData;
     slippage: number;
     txb: Transaction;
     partner?: string;
     payDeepFeeAmount?: number;
+    sponsored?: boolean;
 }
 interface PreSwapLpChangeParams {
     poolID: string;
@@ -386,6 +358,19 @@ type BuildFastRouterSwapParamsV3 = {
     cetusDlmmPartner?: string;
     refreshAllCoins?: boolean;
     payDeepFeeAmount?: number;
+    sponsored?: boolean;
+};
+type BuildSponsoredTransactionParams = {
+    txKindBytes: Uint8Array | string;
+    sender: string;
+    sponsor: string;
+    sponsorCoins: {
+        objectId: string;
+        version: string | number;
+        digest: string;
+    }[];
+    gasBudget?: number | bigint | string;
+    gasPrice?: number | bigint | string;
 };
 interface SwapInPoolsParams {
     from: string;
@@ -463,6 +448,7 @@ declare class AggregatorClient {
         maxAmountIn: BN;
     }): Promise<TransactionObjectArgument>;
     fastRouterSwap(params: BuildFastRouterSwapParamsV3): Promise<void>;
+    private deliverTargetCoin;
     mergeSwap(params: BuildMergeSwapParams): Promise<TransactionObjectArgument>;
     fastMergeSwap(params: BuildFastMergeSwapParams): Promise<void>;
     fixableRouterSwapV3(params: BuildRouterSwapParamsV3): Promise<TransactionObjectArgument>;
@@ -477,6 +463,19 @@ declare class AggregatorClient {
         events: true;
         balanceChanges: true;
     }>>;
+    buildTransactionKind(txb: Transaction, sender?: string): Promise<Uint8Array>;
+    buildSponsoredTransaction(params: BuildSponsoredTransactionParams): Transaction;
+    buildTransactionBytes(txb: Transaction): Promise<Uint8Array>;
+    executeWithSignatures(bytes: Uint8Array, signatures: string[]): Promise<_mysten_sui_client.SuiClientTypes.TransactionResult<{
+        effects: true;
+        events: true;
+        balanceChanges: true;
+    }>>;
+    signAndExecuteSponsoredTransaction(txb: Transaction, userSigner: Signer, sponsorSigner: Signer): Promise<_mysten_sui_client.SuiClientTypes.TransactionResult<{
+        effects: true;
+        events: true;
+        balanceChanges: true;
+    }>>;
 }
 
 /**
@@ -1177,4 +1176,4 @@ declare class CoinUtils {
     static calculateTotalBalance(coins: CoinAsset[]): bigint;
 }
 
-export { AFSUI, AFTERMATH, AFTERMATH_AMM, AFTERMATH_MODULE, AGGREGATOR, AGGREGATOR_V3_CONFIG, ALL_DEXES, ALPHAFI, AggregatorClient, type AggregatorClientParams, AggregatorConfig, AggregatorError, type AggregatorErrorCode, type AggregatorResponse, AggregatorServerErrorCode, BLUEFIN, BLUEMOVE, BOLT, type BigNumber, type BuildCoinResult, type BuildFastMergeSwapParams, type BuildFastRouterSwapParams, type BuildFastRouterSwapParamsV2, type BuildFastRouterSwapParamsV3, type BuildMergeSwapParams, type BuildRouterSwapParams, type BuildRouterSwapParamsV2, type BuildRouterSwapParamsV3, CETUS, CETUSDLMM, CETUS_DEX, CETUS_MODULE, CETUS_PUBLISHED_AT, CHECK_COINS_THRESHOLD_FUNC, CLIENT_CONFIG, CLOCK_ADDRESS, type CoinAsset, CoinInfoAddress, CoinStoreAddress, CoinUtils, type ComparisonResult, ConfigErrorCode, DEEPBOOKV2, DEEPBOOKV3, DEEPBOOK_CLOB_V2_MODULE, DEEPBOOK_CUSTODIAN_V2_MODULE, DEEPBOOK_DEX, DEEPBOOK_MODULE, DEEPBOOK_PACKAGE_ID, DEEPBOOK_PUBLISHED_AT, DEEPBOOK_V3_DEEP_FEE_TYPES, DEFAULT_AGG_V2_ENDPOINT, DEFAULT_AGG_V3_ENDPOINT, DEFAULT_ENDPOINT, DEFAULT_GAS_BUDGET_FOR_MERGE, DEFAULT_GAS_BUDGET_FOR_SPLIT, DEFAULT_GAS_BUDGET_FOR_STAKE, DEFAULT_GAS_BUDGET_FOR_TRANSFER, DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI, DEFAULT_NFT_TRANSFER_GAS_FEE, type DeepbookV3Config, type DeepbookV3ConfigResponse, type Dex, Env, type ExtendedDetails, FERRACLMM, FERRADLMM, FLOWXV2, FLOWXV3, FLOWX_AMM, FLOWX_AMM_MODULE, FULLSAIL, type FindRouterParams, FlashSwapA2BFunc, FlashSwapB2AFunc, FlashSwapFunc, FlashSwapWithPartnerA2BFunc, FlashSwapWithPartnerB2AFunc, FlashSwapWithPartnerFunc, type FlattenedPath, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, type GasMetrics, type GetOrCreateAccountCapResult, HAEDAL, HAEDALHMMV2, HAEDALPMM, HAEDALPROPAMM, HAWAL, INTEGRATE, JOIN_FUNC, KRIYA, KRIYAV3, KRIYA_DEX, KRIYA_MODULE, MAGMA, MAGMAPROPAMM, MAINNET_AFTERMATH_INSURANCE_FUND_ID, MAINNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, MAINNET_AFTERMATH_REFERRAL_VAULT_ID, MAINNET_AFTERMATH_REGISTRY_ID, MAINNET_AFTERMATH_TREASURY_ID, MAINNET_CETUS_V3_PUBLISHED_AT, MAINNET_FLOWX_AMM_CONTAINER_ID, METASTABLE, MOMENTUM, type MergeRoute, type MergeSwapFromCoin, type MergeSwapInputCoin, type MergeSwapParams, type MergeSwapRouterData, type NFT, OBRIC, ONE, PACKAGE_NAMES, PAY_MODULE, POOL_MODULT, PUBLISHED_ADDRESSES, PYTH_CONFIG, PYTH_PRELUDE_CALLS, type Package, type Path, type PathV2, type PreSwapLpChangeParams, type ProcessedRouterData, type PythConfig, REPAY_FLASH_SWAP_A2B_FUNC, REPAY_FLASH_SWAP_B2A_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_A2B_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_B2A_FUNC, RepayFalshSwapFunc, RepayFlashSwapWithPartnerFunc, type Router, type RouterData, type RouterDataV2, type RouterDataV3, type RouterError, type RouterV2, SCALLOP, SEVENK, SPRINGSUI, STEAMM, STEAMM_OMM, STEAMM_OMM_V2, SUILEND, SUI_SYSTEM_STATE_OBJECT_ID, SWAP_A2B_FUNC, SWAP_B2A_FUNC, SWAP_GAS_BUDGET_TABLE, type SimulateTransactionResult, type SuiAddress, type SuiBasicTypes, type SuiInputTypes, type SuiMoveObject, type SuiObjectIdType, type SuiResource, type SuiStructTag, type SuiTxArg, SuiZeroCoinFn, type SwapGasAnalysis, type SwapInPoolsParams, type SwapInPoolsResultV3, TEN_POW_NINE, TESTNET_AFTERMATH_INSURANCE_FUND_ID, TESTNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, TESTNET_AFTERMATH_REFERRAL_VAULT_ID, TESTNET_AFTERMATH_REGISTRY_ID, TESTNET_AFTERMATH_TREASURY_ID, TESTNET_CETUS_V3_PUBLISHED_AT, TESTNET_FLOWX_AMM_CONTAINER_ID, TRANSFER_ACCOUNT_CAP, TRANSFER_OR_DESTORY_COIN_FUNC, TURBOS, TURBOS_DEX, TURBOS_MODULE, TURBOS_VERSIONED, TWO, TransactionErrorCode, TypesErrorCode, U128, U64_MAX, U64_MAX_BN, UTILS_MODULE, VOLO, ZERO, buildInputCoin, calculateGasEfficiency, calculatePriceImpact, checkInvalidSuiAddress, compareCoins, compareGasMetrics, completionCoin, composeType, createTarget, dealWithFastRouterSwapParamsForMsafe, estimateSwapGasBudget, exportToCSV, exportToJSON, extractAddressFromType, extractGasMetrics, extractStructTagFromType, extractTimestampFromDowngradeUuid6, fixSuiObjectId, formatGasMetrics, generateDowngradeUuid6, generateSimpleDowngradeUuid6, getAggregatorServerErrorMessage, getAggregatorV2Extend2PublishedAt, getAggregatorV2ExtendPublishedAt, getAggregatorV2PublishedAt, getAllProviders, getDeepbookV3Config, getDefaultSuiInputType, getMergeSwapResult, getOrCreateAccountCap, getProvidersExcluding, getProvidersIncluding, getRouterResult, hasPythPrelude, isSortedSymbols, isValidDowngradeUuid6, lookupGasBudget, mintZeroCoin, normalizeCoinType, parseAftermathFeeType, parseTurbosPoolFeeType, patchFixSuiObjectId, printTransaction, processEndpoint, processFlattenRoutes, restituteMsafeFastRouterSwapParams };
+export { AFSUI, AFTERMATH, AFTERMATH_AMM, AFTERMATH_MODULE, AGGREGATOR, AGGREGATOR_V3_CONFIG, ALL_DEXES, ALPHAFI, AggregatorClient, type AggregatorClientParams, AggregatorConfig, AggregatorError, type AggregatorErrorCode, type AggregatorResponse, AggregatorServerErrorCode, BLUEFIN, BLUEMOVE, BOLT, type BigNumber, type BuildCoinResult, type BuildFastMergeSwapParams, type BuildFastRouterSwapParams, type BuildFastRouterSwapParamsV2, type BuildFastRouterSwapParamsV3, type BuildMergeSwapParams, type BuildRouterSwapParams, type BuildRouterSwapParamsV2, type BuildRouterSwapParamsV3, type BuildSponsoredTransactionParams, CETUS, CETUSDLMM, CETUS_DEX, CETUS_MODULE, CETUS_PUBLISHED_AT, CHECK_COINS_THRESHOLD_FUNC, CLIENT_CONFIG, CLOCK_ADDRESS, type CoinAsset, CoinInfoAddress, CoinStoreAddress, CoinUtils, type ComparisonResult, ConfigErrorCode, DEEPBOOKV2, DEEPBOOKV3, DEEPBOOK_CLOB_V2_MODULE, DEEPBOOK_CUSTODIAN_V2_MODULE, DEEPBOOK_DEX, DEEPBOOK_MODULE, DEEPBOOK_PACKAGE_ID, DEEPBOOK_PUBLISHED_AT, DEEPBOOK_V3_DEEP_FEE_TYPES, DEFAULT_AGG_V2_ENDPOINT, DEFAULT_AGG_V3_ENDPOINT, DEFAULT_ENDPOINT, DEFAULT_GAS_BUDGET_FOR_MERGE, DEFAULT_GAS_BUDGET_FOR_SPLIT, DEFAULT_GAS_BUDGET_FOR_STAKE, DEFAULT_GAS_BUDGET_FOR_TRANSFER, DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI, DEFAULT_NFT_TRANSFER_GAS_FEE, type DeepbookV3Config, type DeepbookV3ConfigResponse, type Dex, Env, type ExtendedDetails, FERRACLMM, FERRADLMM, FLOWXV2, FLOWXV3, FLOWX_AMM, FLOWX_AMM_MODULE, FULLSAIL, type FindRouterParams, FlashSwapA2BFunc, FlashSwapB2AFunc, FlashSwapFunc, FlashSwapWithPartnerA2BFunc, FlashSwapWithPartnerB2AFunc, FlashSwapWithPartnerFunc, type FlattenedPath, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, type GasMetrics, type GetOrCreateAccountCapResult, HAEDAL, HAEDALHMMV2, HAEDALPMM, HAEDALPROPAMM, HAWAL, INTEGRATE, JOIN_FUNC, KRIYA, KRIYAV3, KRIYA_DEX, KRIYA_MODULE, MAGMA, MAGMAPROPAMM, MAINNET_AFTERMATH_INSURANCE_FUND_ID, MAINNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, MAINNET_AFTERMATH_REFERRAL_VAULT_ID, MAINNET_AFTERMATH_REGISTRY_ID, MAINNET_AFTERMATH_TREASURY_ID, MAINNET_CETUS_V3_PUBLISHED_AT, MAINNET_FLOWX_AMM_CONTAINER_ID, METASTABLE, MOMENTUM, type MergeRoute, type MergeSwapFromCoin, type MergeSwapInputCoin, type MergeSwapParams, type MergeSwapRouterData, type NFT, OBRIC, ONE, PACKAGE_NAMES, PAY_MODULE, POOL_MODULT, PUBLISHED_ADDRESSES, PYTH_CONFIG, PYTH_PRELUDE_CALLS, type Package, type Path, type PathV2, type PreSwapLpChangeParams, type ProcessedRouterData, type PythConfig, REPAY_FLASH_SWAP_A2B_FUNC, REPAY_FLASH_SWAP_B2A_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_A2B_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_B2A_FUNC, RepayFalshSwapFunc, RepayFlashSwapWithPartnerFunc, type Router, type RouterData, type RouterDataV2, type RouterDataV3, type RouterError, type RouterV2, SCALLOP, SEVENK, SPRINGSUI, STEAMM, STEAMM_OMM, STEAMM_OMM_V2, SUILEND, SUI_SYSTEM_STATE_OBJECT_ID, SWAP_A2B_FUNC, SWAP_B2A_FUNC, SWAP_GAS_BUDGET_TABLE, type SimulateTransactionResult, type SuiAddress, type SuiBasicTypes, type SuiInputTypes, type SuiMoveObject, type SuiObjectIdType, type SuiResource, type SuiStructTag, type SuiTxArg, SuiZeroCoinFn, type SwapGasAnalysis, type SwapInPoolsParams, type SwapInPoolsResultV3, TEN_POW_NINE, TESTNET_AFTERMATH_INSURANCE_FUND_ID, TESTNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, TESTNET_AFTERMATH_REFERRAL_VAULT_ID, TESTNET_AFTERMATH_REGISTRY_ID, TESTNET_AFTERMATH_TREASURY_ID, TESTNET_CETUS_V3_PUBLISHED_AT, TESTNET_FLOWX_AMM_CONTAINER_ID, TRANSFER_ACCOUNT_CAP, TRANSFER_OR_DESTORY_COIN_FUNC, TURBOS, TURBOS_DEX, TURBOS_MODULE, TURBOS_VERSIONED, TWO, TransactionErrorCode, TypesErrorCode, U128, U64_MAX, U64_MAX_BN, UTILS_MODULE, VOLO, ZERO, buildInputCoin, calculateGasEfficiency, calculatePriceImpact, checkInvalidSuiAddress, compareCoins, compareGasMetrics, completionCoin, composeType, createTarget, dealWithFastRouterSwapParamsForMsafe, estimateSwapGasBudget, exportToCSV, exportToJSON, extractAddressFromType, extractGasMetrics, extractStructTagFromType, extractTimestampFromDowngradeUuid6, fixSuiObjectId, formatGasMetrics, generateDowngradeUuid6, generateSimpleDowngradeUuid6, getAggregatorServerErrorMessage, getAggregatorV2Extend2PublishedAt, getAggregatorV2ExtendPublishedAt, getAggregatorV2PublishedAt, getAllProviders, getDeepbookV3Config, getDefaultSuiInputType, getMergeSwapResult, getOrCreateAccountCap, getProvidersExcluding, getProvidersIncluding, getRouterResult, hasPythPrelude, isSortedSymbols, isValidDowngradeUuid6, lookupGasBudget, mintZeroCoin, normalizeCoinType, parseAftermathFeeType, parseTurbosPoolFeeType, patchFixSuiObjectId, printTransaction, processEndpoint, processFlattenRoutes, restituteMsafeFastRouterSwapParams };

package/dist/index.d.ts

@@ -21,10 +21,6 @@ interface MergeSwapFromCoin {
     coinType: string;
     amount: BN | string | number | bigint;
 }
-interface MergeSwapFromCoin {
-    coinType: string;
-    amount: BN | string | number | bigint;
-}
 interface MergeSwapParams {
     target: string;
     byAmountIn: boolean;
@@ -32,17 +28,6 @@ interface MergeSwapParams {
     providers?: string[];
     froms: MergeSwapFromCoin[];
 }
-interface MergeSwapParams {
-    target: string;
-    byAmountIn: boolean;
-    depth?: number;
-    providers?: string[];
-    froms: MergeSwapFromCoin[];
-}
-interface MergeSwapInputCoin {
-    coinType: string;
-    coin: TransactionObjectArgument;
-}
 interface MergeSwapInputCoin {
     coinType: string;
     coin: TransactionObjectArgument;
@@ -54,26 +39,13 @@ interface BuildMergeSwapParams {
     txb: Transaction;
     partner?: string;
 }
-interface BuildMergeSwapParams {
-    router: MergeSwapRouterData;
-    inputCoins: MergeSwapInputCoin[];
-    slippage: number;
-    txb: Transaction;
-    partner?: string;
-}
-interface BuildFastMergeSwapParams {
-    router: MergeSwapRouterData;
-    slippage: number;
-    txb: Transaction;
-    partner?: string;
-    payDeepFeeAmount?: number;
-}
 interface BuildFastMergeSwapParams {
     router: MergeSwapRouterData;
     slippage: number;
     txb: Transaction;
     partner?: string;
     payDeepFeeAmount?: number;
+    sponsored?: boolean;
 }
 interface PreSwapLpChangeParams {
     poolID: string;
@@ -386,6 +358,19 @@ type BuildFastRouterSwapParamsV3 = {
     cetusDlmmPartner?: string;
     refreshAllCoins?: boolean;
     payDeepFeeAmount?: number;
+    sponsored?: boolean;
+};
+type BuildSponsoredTransactionParams = {
+    txKindBytes: Uint8Array | string;
+    sender: string;
+    sponsor: string;
+    sponsorCoins: {
+        objectId: string;
+        version: string | number;
+        digest: string;
+    }[];
+    gasBudget?: number | bigint | string;
+    gasPrice?: number | bigint | string;
 };
 interface SwapInPoolsParams {
     from: string;
@@ -463,6 +448,7 @@ declare class AggregatorClient {
         maxAmountIn: BN;
     }): Promise<TransactionObjectArgument>;
     fastRouterSwap(params: BuildFastRouterSwapParamsV3): Promise<void>;
+    private deliverTargetCoin;
     mergeSwap(params: BuildMergeSwapParams): Promise<TransactionObjectArgument>;
     fastMergeSwap(params: BuildFastMergeSwapParams): Promise<void>;
     fixableRouterSwapV3(params: BuildRouterSwapParamsV3): Promise<TransactionObjectArgument>;
@@ -477,6 +463,19 @@ declare class AggregatorClient {
         events: true;
         balanceChanges: true;
     }>>;
+    buildTransactionKind(txb: Transaction, sender?: string): Promise<Uint8Array>;
+    buildSponsoredTransaction(params: BuildSponsoredTransactionParams): Transaction;
+    buildTransactionBytes(txb: Transaction): Promise<Uint8Array>;
+    executeWithSignatures(bytes: Uint8Array, signatures: string[]): Promise<_mysten_sui_client.SuiClientTypes.TransactionResult<{
+        effects: true;
+        events: true;
+        balanceChanges: true;
+    }>>;
+    signAndExecuteSponsoredTransaction(txb: Transaction, userSigner: Signer, sponsorSigner: Signer): Promise<_mysten_sui_client.SuiClientTypes.TransactionResult<{
+        effects: true;
+        events: true;
+        balanceChanges: true;
+    }>>;
 }
 
 /**
@@ -1177,4 +1176,4 @@ declare class CoinUtils {
     static calculateTotalBalance(coins: CoinAsset[]): bigint;
 }
 
-export { AFSUI, AFTERMATH, AFTERMATH_AMM, AFTERMATH_MODULE, AGGREGATOR, AGGREGATOR_V3_CONFIG, ALL_DEXES, ALPHAFI, AggregatorClient, type AggregatorClientParams, AggregatorConfig, AggregatorError, type AggregatorErrorCode, type AggregatorResponse, AggregatorServerErrorCode, BLUEFIN, BLUEMOVE, BOLT, type BigNumber, type BuildCoinResult, type BuildFastMergeSwapParams, type BuildFastRouterSwapParams, type BuildFastRouterSwapParamsV2, type BuildFastRouterSwapParamsV3, type BuildMergeSwapParams, type BuildRouterSwapParams, type BuildRouterSwapParamsV2, type BuildRouterSwapParamsV3, CETUS, CETUSDLMM, CETUS_DEX, CETUS_MODULE, CETUS_PUBLISHED_AT, CHECK_COINS_THRESHOLD_FUNC, CLIENT_CONFIG, CLOCK_ADDRESS, type CoinAsset, CoinInfoAddress, CoinStoreAddress, CoinUtils, type ComparisonResult, ConfigErrorCode, DEEPBOOKV2, DEEPBOOKV3, DEEPBOOK_CLOB_V2_MODULE, DEEPBOOK_CUSTODIAN_V2_MODULE, DEEPBOOK_DEX, DEEPBOOK_MODULE, DEEPBOOK_PACKAGE_ID, DEEPBOOK_PUBLISHED_AT, DEEPBOOK_V3_DEEP_FEE_TYPES, DEFAULT_AGG_V2_ENDPOINT, DEFAULT_AGG_V3_ENDPOINT, DEFAULT_ENDPOINT, DEFAULT_GAS_BUDGET_FOR_MERGE, DEFAULT_GAS_BUDGET_FOR_SPLIT, DEFAULT_GAS_BUDGET_FOR_STAKE, DEFAULT_GAS_BUDGET_FOR_TRANSFER, DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI, DEFAULT_NFT_TRANSFER_GAS_FEE, type DeepbookV3Config, type DeepbookV3ConfigResponse, type Dex, Env, type ExtendedDetails, FERRACLMM, FERRADLMM, FLOWXV2, FLOWXV3, FLOWX_AMM, FLOWX_AMM_MODULE, FULLSAIL, type FindRouterParams, FlashSwapA2BFunc, FlashSwapB2AFunc, FlashSwapFunc, FlashSwapWithPartnerA2BFunc, FlashSwapWithPartnerB2AFunc, FlashSwapWithPartnerFunc, type FlattenedPath, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, type GasMetrics, type GetOrCreateAccountCapResult, HAEDAL, HAEDALHMMV2, HAEDALPMM, HAEDALPROPAMM, HAWAL, INTEGRATE, JOIN_FUNC, KRIYA, KRIYAV3, KRIYA_DEX, KRIYA_MODULE, MAGMA, MAGMAPROPAMM, MAINNET_AFTERMATH_INSURANCE_FUND_ID, MAINNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, MAINNET_AFTERMATH_REFERRAL_VAULT_ID, MAINNET_AFTERMATH_REGISTRY_ID, MAINNET_AFTERMATH_TREASURY_ID, MAINNET_CETUS_V3_PUBLISHED_AT, MAINNET_FLOWX_AMM_CONTAINER_ID, METASTABLE, MOMENTUM, type MergeRoute, type MergeSwapFromCoin, type MergeSwapInputCoin, type MergeSwapParams, type MergeSwapRouterData, type NFT, OBRIC, ONE, PACKAGE_NAMES, PAY_MODULE, POOL_MODULT, PUBLISHED_ADDRESSES, PYTH_CONFIG, PYTH_PRELUDE_CALLS, type Package, type Path, type PathV2, type PreSwapLpChangeParams, type ProcessedRouterData, type PythConfig, REPAY_FLASH_SWAP_A2B_FUNC, REPAY_FLASH_SWAP_B2A_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_A2B_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_B2A_FUNC, RepayFalshSwapFunc, RepayFlashSwapWithPartnerFunc, type Router, type RouterData, type RouterDataV2, type RouterDataV3, type RouterError, type RouterV2, SCALLOP, SEVENK, SPRINGSUI, STEAMM, STEAMM_OMM, STEAMM_OMM_V2, SUILEND, SUI_SYSTEM_STATE_OBJECT_ID, SWAP_A2B_FUNC, SWAP_B2A_FUNC, SWAP_GAS_BUDGET_TABLE, type SimulateTransactionResult, type SuiAddress, type SuiBasicTypes, type SuiInputTypes, type SuiMoveObject, type SuiObjectIdType, type SuiResource, type SuiStructTag, type SuiTxArg, SuiZeroCoinFn, type SwapGasAnalysis, type SwapInPoolsParams, type SwapInPoolsResultV3, TEN_POW_NINE, TESTNET_AFTERMATH_INSURANCE_FUND_ID, TESTNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, TESTNET_AFTERMATH_REFERRAL_VAULT_ID, TESTNET_AFTERMATH_REGISTRY_ID, TESTNET_AFTERMATH_TREASURY_ID, TESTNET_CETUS_V3_PUBLISHED_AT, TESTNET_FLOWX_AMM_CONTAINER_ID, TRANSFER_ACCOUNT_CAP, TRANSFER_OR_DESTORY_COIN_FUNC, TURBOS, TURBOS_DEX, TURBOS_MODULE, TURBOS_VERSIONED, TWO, TransactionErrorCode, TypesErrorCode, U128, U64_MAX, U64_MAX_BN, UTILS_MODULE, VOLO, ZERO, buildInputCoin, calculateGasEfficiency, calculatePriceImpact, checkInvalidSuiAddress, compareCoins, compareGasMetrics, completionCoin, composeType, createTarget, dealWithFastRouterSwapParamsForMsafe, estimateSwapGasBudget, exportToCSV, exportToJSON, extractAddressFromType, extractGasMetrics, extractStructTagFromType, extractTimestampFromDowngradeUuid6, fixSuiObjectId, formatGasMetrics, generateDowngradeUuid6, generateSimpleDowngradeUuid6, getAggregatorServerErrorMessage, getAggregatorV2Extend2PublishedAt, getAggregatorV2ExtendPublishedAt, getAggregatorV2PublishedAt, getAllProviders, getDeepbookV3Config, getDefaultSuiInputType, getMergeSwapResult, getOrCreateAccountCap, getProvidersExcluding, getProvidersIncluding, getRouterResult, hasPythPrelude, isSortedSymbols, isValidDowngradeUuid6, lookupGasBudget, mintZeroCoin, normalizeCoinType, parseAftermathFeeType, parseTurbosPoolFeeType, patchFixSuiObjectId, printTransaction, processEndpoint, processFlattenRoutes, restituteMsafeFastRouterSwapParams };
+export { AFSUI, AFTERMATH, AFTERMATH_AMM, AFTERMATH_MODULE, AGGREGATOR, AGGREGATOR_V3_CONFIG, ALL_DEXES, ALPHAFI, AggregatorClient, type AggregatorClientParams, AggregatorConfig, AggregatorError, type AggregatorErrorCode, type AggregatorResponse, AggregatorServerErrorCode, BLUEFIN, BLUEMOVE, BOLT, type BigNumber, type BuildCoinResult, type BuildFastMergeSwapParams, type BuildFastRouterSwapParams, type BuildFastRouterSwapParamsV2, type BuildFastRouterSwapParamsV3, type BuildMergeSwapParams, type BuildRouterSwapParams, type BuildRouterSwapParamsV2, type BuildRouterSwapParamsV3, type BuildSponsoredTransactionParams, CETUS, CETUSDLMM, CETUS_DEX, CETUS_MODULE, CETUS_PUBLISHED_AT, CHECK_COINS_THRESHOLD_FUNC, CLIENT_CONFIG, CLOCK_ADDRESS, type CoinAsset, CoinInfoAddress, CoinStoreAddress, CoinUtils, type ComparisonResult, ConfigErrorCode, DEEPBOOKV2, DEEPBOOKV3, DEEPBOOK_CLOB_V2_MODULE, DEEPBOOK_CUSTODIAN_V2_MODULE, DEEPBOOK_DEX, DEEPBOOK_MODULE, DEEPBOOK_PACKAGE_ID, DEEPBOOK_PUBLISHED_AT, DEEPBOOK_V3_DEEP_FEE_TYPES, DEFAULT_AGG_V2_ENDPOINT, DEFAULT_AGG_V3_ENDPOINT, DEFAULT_ENDPOINT, DEFAULT_GAS_BUDGET_FOR_MERGE, DEFAULT_GAS_BUDGET_FOR_SPLIT, DEFAULT_GAS_BUDGET_FOR_STAKE, DEFAULT_GAS_BUDGET_FOR_TRANSFER, DEFAULT_GAS_BUDGET_FOR_TRANSFER_SUI, DEFAULT_NFT_TRANSFER_GAS_FEE, type DeepbookV3Config, type DeepbookV3ConfigResponse, type Dex, Env, type ExtendedDetails, FERRACLMM, FERRADLMM, FLOWXV2, FLOWXV3, FLOWX_AMM, FLOWX_AMM_MODULE, FULLSAIL, type FindRouterParams, FlashSwapA2BFunc, FlashSwapB2AFunc, FlashSwapFunc, FlashSwapWithPartnerA2BFunc, FlashSwapWithPartnerB2AFunc, FlashSwapWithPartnerFunc, type FlattenedPath, GAS_SYMBOL, GAS_TYPE_ARG, GAS_TYPE_ARG_LONG, type GasMetrics, type GetOrCreateAccountCapResult, HAEDAL, HAEDALHMMV2, HAEDALPMM, HAEDALPROPAMM, HAWAL, INTEGRATE, JOIN_FUNC, KRIYA, KRIYAV3, KRIYA_DEX, KRIYA_MODULE, MAGMA, MAGMAPROPAMM, MAINNET_AFTERMATH_INSURANCE_FUND_ID, MAINNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, MAINNET_AFTERMATH_REFERRAL_VAULT_ID, MAINNET_AFTERMATH_REGISTRY_ID, MAINNET_AFTERMATH_TREASURY_ID, MAINNET_CETUS_V3_PUBLISHED_AT, MAINNET_FLOWX_AMM_CONTAINER_ID, METASTABLE, MOMENTUM, type MergeRoute, type MergeSwapFromCoin, type MergeSwapInputCoin, type MergeSwapParams, type MergeSwapRouterData, type NFT, OBRIC, ONE, PACKAGE_NAMES, PAY_MODULE, POOL_MODULT, PUBLISHED_ADDRESSES, PYTH_CONFIG, PYTH_PRELUDE_CALLS, type Package, type Path, type PathV2, type PreSwapLpChangeParams, type ProcessedRouterData, type PythConfig, REPAY_FLASH_SWAP_A2B_FUNC, REPAY_FLASH_SWAP_B2A_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_A2B_FUNC, REPAY_FLASH_SWAP_WITH_PARTNER_B2A_FUNC, RepayFalshSwapFunc, RepayFlashSwapWithPartnerFunc, type Router, type RouterData, type RouterDataV2, type RouterDataV3, type RouterError, type RouterV2, SCALLOP, SEVENK, SPRINGSUI, STEAMM, STEAMM_OMM, STEAMM_OMM_V2, SUILEND, SUI_SYSTEM_STATE_OBJECT_ID, SWAP_A2B_FUNC, SWAP_B2A_FUNC, SWAP_GAS_BUDGET_TABLE, type SimulateTransactionResult, type SuiAddress, type SuiBasicTypes, type SuiInputTypes, type SuiMoveObject, type SuiObjectIdType, type SuiResource, type SuiStructTag, type SuiTxArg, SuiZeroCoinFn, type SwapGasAnalysis, type SwapInPoolsParams, type SwapInPoolsResultV3, TEN_POW_NINE, TESTNET_AFTERMATH_INSURANCE_FUND_ID, TESTNET_AFTERMATH_PROTOCOL_FEE_VAULT_ID, TESTNET_AFTERMATH_REFERRAL_VAULT_ID, TESTNET_AFTERMATH_REGISTRY_ID, TESTNET_AFTERMATH_TREASURY_ID, TESTNET_CETUS_V3_PUBLISHED_AT, TESTNET_FLOWX_AMM_CONTAINER_ID, TRANSFER_ACCOUNT_CAP, TRANSFER_OR_DESTORY_COIN_FUNC, TURBOS, TURBOS_DEX, TURBOS_MODULE, TURBOS_VERSIONED, TWO, TransactionErrorCode, TypesErrorCode, U128, U64_MAX, U64_MAX_BN, UTILS_MODULE, VOLO, ZERO, buildInputCoin, calculateGasEfficiency, calculatePriceImpact, checkInvalidSuiAddress, compareCoins, compareGasMetrics, completionCoin, composeType, createTarget, dealWithFastRouterSwapParamsForMsafe, estimateSwapGasBudget, exportToCSV, exportToJSON, extractAddressFromType, extractGasMetrics, extractStructTagFromType, extractTimestampFromDowngradeUuid6, fixSuiObjectId, formatGasMetrics, generateDowngradeUuid6, generateSimpleDowngradeUuid6, getAggregatorServerErrorMessage, getAggregatorV2Extend2PublishedAt, getAggregatorV2ExtendPublishedAt, getAggregatorV2PublishedAt, getAllProviders, getDeepbookV3Config, getDefaultSuiInputType, getMergeSwapResult, getOrCreateAccountCap, getProvidersExcluding, getProvidersIncluding, getRouterResult, hasPythPrelude, isSortedSymbols, isValidDowngradeUuid6, lookupGasBudget, mintZeroCoin, normalizeCoinType, parseAftermathFeeType, parseTurbosPoolFeeType, patchFixSuiObjectId, printTransaction, processEndpoint, processFlattenRoutes, restituteMsafeFastRouterSwapParams };

package/dist/index.js

@@ -3410,7 +3410,7 @@ var AGGREGATOR_V3_CONFIG = {
 };
 
 // src/api.ts
-var SDK_VERSION = 1010600;
+var SDK_VERSION = 1010601;
 function parseRouterResponse(data, byAmountIn) {
   let packages = /* @__PURE__ */ new Map();
   if (data.packages) {
@@ -9583,7 +9583,15 @@ var _AggregatorClient = class _AggregatorClient {
   // auto build input coin
   // auto merge, transfer or destory target coin.
   async fastRouterSwap(params) {
-    const { router, slippage, txb, partner, cetusDlmmPartner, payDeepFeeAmount } = params;
+    const {
+      router,
+      slippage,
+      txb,
+      partner,
+      cetusDlmmPartner,
+      payDeepFeeAmount,
+      sponsored = false
+    } = params;
     const fromCoinType = router.paths[0].from;
     const targetCoinType = router.paths[router.paths.length - 1].target;
     const byAmountIn = router.byAmountIn;
@@ -9608,7 +9616,7 @@ var _AggregatorClient = class _AggregatorClient {
     const amount = byAmountIn ? expectedAmountIn : amountLimit;
     let inputCoin = coinWithBalance({
       balance: BigInt(amount.toString()),
-      useGasCoin: true,
+      useGasCoin: !sponsored,
       type: fromCoinType
     });
     let deepCoin;
@@ -9628,22 +9636,46 @@ var _AggregatorClient = class _AggregatorClient {
       deepbookv3DeepFee: deepCoin
     };
     const targetCoin = await this.routerSwap(routerSwapParams);
+    await this.deliverTargetCoin(
+      txb,
+      targetCoin,
+      targetCoinType,
+      router.packages,
+      sponsored
+    );
+  }
+  // Delivers a swap's output coin. In sponsored mode the SDK must not query or touch
+  // coins through `this.signer`, because the transaction sender may be different from
+  // the SDK instance signer. Let the router transfer helper deliver the output to the
+  // transaction sender instead.
+  async deliverTargetCoin(txb, targetCoin, targetCoinType, packages, sponsored) {
+    if (sponsored) {
+      transferOrDestroyCoin(
+        {
+          coin: targetCoin,
+          coinType: targetCoinType,
+          packages
+        },
+        txb
+      );
+      return;
+    }
     if (CoinUtils.isSuiCoin(targetCoinType)) {
       txb.mergeCoins(txb.gas, [targetCoin]);
+      return;
+    }
+    const targetCoinObjID = await this.getOneCoinUsedToMerge(targetCoinType);
+    if (targetCoinObjID != null) {
+      txb.mergeCoins(txb.object(targetCoinObjID), [targetCoin]);
     } else {
-      const targetCoinObjID = await this.getOneCoinUsedToMerge(targetCoinType);
-      if (targetCoinObjID != null) {
-        txb.mergeCoins(txb.object(targetCoinObjID), [targetCoin]);
-      } else {
-        transferOrDestroyCoin(
-          {
-            coin: targetCoin,
-            coinType: targetCoinType,
-            packages: router.packages
-          },
-          txb
-        );
-      }
+      transferOrDestroyCoin(
+        {
+          coin: targetCoin,
+          coinType: targetCoinType,
+          packages
+        },
+        txb
+      );
     }
   }
   async mergeSwap(params) {
@@ -9692,7 +9724,7 @@ var _AggregatorClient = class _AggregatorClient {
     return finalOutputCoin;
   }
   async fastMergeSwap(params) {
-    const { router, slippage, txb, partner } = params;
+    const { router, slippage, txb, partner, sponsored = false } = params;
     if (!router || !router.allRoutes || router.allRoutes.length === 0) {
       throw new Error("Invalid router: no routes found");
     }
@@ -9708,7 +9740,7 @@ var _AggregatorClient = class _AggregatorClient {
       coinTypeSet.add(firstCoinType);
       const coin = coinWithBalance({
         balance: BigInt(route.amountIn.toString()),
-        useGasCoin: CoinUtils.isSuiCoin(firstCoinType),
+        useGasCoin: !sponsored && CoinUtils.isSuiCoin(firstCoinType),
         type: firstCoinType
       });
       inputCoins.push({ coinType: firstCoinType, coin });
@@ -9721,23 +9753,13 @@ var _AggregatorClient = class _AggregatorClient {
       partner: partner ?? this.partner
     };
     const targetCoin = await this.mergeSwap(mergeSwapParams);
-    if (CoinUtils.isSuiCoin(targetCoinType)) {
-      txb.mergeCoins(txb.gas, [targetCoin]);
-    } else {
-      const targetCoinObjID = await this.getOneCoinUsedToMerge(targetCoinType);
-      if (targetCoinObjID != null) {
-        txb.mergeCoins(txb.object(targetCoinObjID), [targetCoin]);
-      } else {
-        transferOrDestroyCoin(
-          {
-            coin: targetCoin,
-            coinType: targetCoinType,
-            packages: router.packages
-          },
-          txb
-        );
-      }
-    }
+    await this.deliverTargetCoin(
+      txb,
+      targetCoin,
+      targetCoinType,
+      router.packages,
+      sponsored
+    );
   }
   async fixableRouterSwapV3(params) {
     const { router, inputCoin, slippage, txb, partner } = params;
@@ -9936,6 +9958,70 @@ var _AggregatorClient = class _AggregatorClient {
     });
     return res;
   }
+  // ---------------------------------------------------------------------------
+  // Sponsored transactions
+  //
+  // A sponsored transaction lets a sponsor (gas station) pay gas for a transaction
+  // whose commands are authored by a different sender. The sender and the sponsor both
+  // sign the same transaction bytes, and the transaction is submitted with both
+  // signatures. See: https://docs.sui.io/concepts/transactions/sponsored-transactions
+  //
+  // Build the swap with `sponsored: true` (e.g. `fastRouterSwap`/`fastMergeSwap`) so the
+  // gas coin is never used, then:
+  //   - Remote gas station: `buildTransactionKind(txb, sender)` -> station assembles gas
+  //     data with `buildSponsoredTransaction` -> station builds/signs full bytes -> user
+  //     signs the same bytes -> `executeWithSignatures`.
+  //   - Local sponsor (both keypairs available): `signAndExecuteSponsoredTransaction`.
+  // ---------------------------------------------------------------------------
+  // Builds the TransactionKind bytes (commands only, no gas data) to hand to a sponsor /
+  // gas station. Pass `sender` when the transaction contains CoinWithBalance intents,
+  // because those are resolved while building the kind.
+  async buildTransactionKind(txb, sender) {
+    if (sender) {
+      txb.setSender(sender);
+    }
+    return txb.build({ client: this.client, onlyTransactionKind: true });
+  }
+  // Assembles a sponsored transaction from TransactionKind bytes plus the gas data
+  // provided by the sponsor. The returned transaction is ready to be built and signed by
+  // both the sender and the sponsor.
+  buildSponsoredTransaction(params) {
+    const { txKindBytes, sender, sponsor, sponsorCoins, gasBudget, gasPrice } = params;
+    const tx = Transaction.fromKind(txKindBytes);
+    tx.setSender(sender);
+    tx.setGasOwner(sponsor);
+    tx.setGasPayment(sponsorCoins);
+    if (gasBudget != null) {
+      tx.setGasBudget(gasBudget);
+    }
+    if (gasPrice != null) {
+      tx.setGasPrice(gasPrice);
+    }
+    return tx;
+  }
+  // Builds the full transaction bytes (including gas data) that both parties must sign.
+  // Returns the exact bytes the signatures must be produced over.
+  async buildTransactionBytes(txb) {
+    return txb.build({ client: this.client });
+  }
+  // Executes a transaction from pre-built bytes plus the collected signatures. The
+  // signatures MUST be produced over exactly these `bytes` (see `buildTransactionBytes`).
+  async executeWithSignatures(bytes, signatures) {
+    return this.client.executeTransaction({
+      transaction: bytes,
+      signatures,
+      include: { effects: true, events: true, balanceChanges: true }
+    });
+  }
+  // Convenience for the local dual-key case: signs the transaction with both the user's
+  // and the sponsor's signer and executes it. `txb` must already have its sender, gas
+  // owner and gas payment set (e.g. via `buildSponsoredTransaction`).
+  async signAndExecuteSponsoredTransaction(txb, userSigner, sponsorSigner) {
+    const bytes = await txb.build({ client: this.client });
+    const { signature: sponsorSig } = await sponsorSigner.signTransaction(bytes);
+    const { signature: userSig } = await userSigner.signTransaction(bytes);
+    return this.executeWithSignatures(bytes, [userSig, sponsorSig]);
+  }
 };
 _AggregatorClient.CONFIG = {
   [1 /* Testnet */]: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cetusprotocol/aggregator-sdk",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "type": "module",
   "sideEffects": false,
   "main": "dist/index.js",