@xoxno/sdk-js 1.0.213 → 1.0.214

package/dist/cjs/sdk/stellar/lending.d.ts

@@ -1,9 +1,10 @@
 /**
  * Stellar lending user-operation transaction builders.
  *
- * Each builder takes an `*Args` DTO from `@xoxno/types` plus a shared
- * `StellarBuilderOptions` ({ network, caller, sourceSequence, ... }) and returns
- * an unsigned transaction XDR string ready for wallet signing.
+ * Each builder takes a typed Stellar argument object plus shared
+ * `StellarLendingBuilderOptions` ({ network, caller, sourceSequence,
+ * controllerAddress, ... }) and returns
+ * unsigned transaction XDR that must be prepared before wallet signing.
  *
  * i128 values cross the boundary as decimal strings, encoded via
  * `new ScInt(str).toI128()`. Addresses (Stellar `G...` accounts and Soroban
@@ -16,14 +17,16 @@
  * fee) before handing the XDR to the wallet to sign.
  */
 import { xdr } from '@stellar/stellar-sdk';
-import { type StellarNetwork } from './contracts';
-import { type StellarSeizeModeInput, type StellarStrategySwapHopInput, type StellarStrategySwapInput, type StellarStrategySwapPathInput } from './scval-encode';
+import { type StellarNetwork } from './contracts.js';
+import { type StellarSeizeModeInput, type StellarStrategySwapHopInput, type StellarStrategySwapInput, type StellarStrategySwapPathInput } from './scval-encode.js';
 /**
  * Stellar `G...` public key of the caller (tx source account).
  */
 export type StellarAccountAddress = string;
 export interface StellarBuilderOptions {
+    /** Must match the API deployment, RPC and signing wallet. */
     network: StellarNetwork;
+    /** Transaction source and authorizing wallet public key (G...). */
     caller: StellarAccountAddress;
     /**
      * Current sequence number of the caller account, as a decimal string.
@@ -32,26 +35,23 @@ export interface StellarBuilderOptions {
      * makes builders sync-friendly, RPC-free, and deterministic for snapshot tests.
      */
     sourceSequence: string;
-    /**
-     * Override the controller contract address. Normally resolved from env via
-     * `getStellarLendingController(network)` — override is for tests and
-     * preview/staging deployments.
-     */
-    controllerAddress?: string;
-    /**
-     * Override the governance (timelock) contract address. Normally resolved from
-     * env via `getStellarGovernance(network)` — override is for tests and
-     * preview/staging deployments. Required (env or override) for the governance
-     * `propose_*` / `execute` / `execute_*` builders.
-     */
-    governanceAddress?: string;
     /** Base fee in stroops (default BASE_FEE = "100"). */
     fee?: string;
     /** Tx timeout in seconds (default 300). */
     timeoutSeconds?: number;
 }
+/** Shared options plus the lending controller contract selected by the host. */
+export interface StellarLendingBuilderOptions extends StellarBuilderOptions {
+    /** Soroban lending controller contract (C...). Supplied by the host app. */
+    controllerAddress: string;
+}
+/** Shared options plus the governance timelock contract selected by the host. */
+export interface StellarGovernanceBuilderOptions extends StellarBuilderOptions {
+    /** Soroban governance/timelock contract (C...). Supplied by the host app. */
+    governanceAddress: string;
+}
 export interface BuiltStellarTx {
-    /** Unsigned transaction XDR (base64) ready for wallet signing. */
+    /** Unsigned base64 XDR. Pass to prepareStellarBuiltTx before wallet signing. */
     xdr: string;
 }
 /**
@@ -68,7 +68,7 @@ export interface BuiltStellarTx {
 export type StellarSwapStepsInput = StellarStrategySwapInput;
 export type StellarSwapHopInput = StellarStrategySwapHopInput;
 export type StellarSwapPathInput = StellarStrategySwapPathInput;
-export type { StellarSeizeModeInput, StellarSwapVenue } from './scval-encode';
+export type { StellarSeizeModeInput, StellarSwapVenue } from './scval-encode.js';
 /**
  * Assemble an unsigned XDR that invokes a single Soroban contract method.
  *
@@ -77,39 +77,43 @@ export type { StellarSeizeModeInput, StellarSwapVenue } from './scval-encode';
  * footprint + auth entries + resource fees) before signing. The UI layer
  * does this via `rpc.Server.prepareTransaction`.
  */
-export declare function buildTx(opts: StellarBuilderOptions, method: string, params: xdr.ScVal[]): BuiltStellarTx;
+export declare function buildTx(opts: StellarLendingBuilderOptions, method: string, params: xdr.ScVal[]): BuiltStellarTx;
 /** A `(hub_id, asset)` coordinate — the `HubAssetKey` struct, builder-side. */
 export interface StellarHubAsset {
+    /** Liquidity hub from the selected reserve; independent of its risk spoke. */
     hubId: number;
+    /** Token contract address (C...), including SAC addresses for classic assets. */
     asset: string;
 }
-/** A `HubAssetKey` paired with an i128 decimal-string amount. */
+/** A hub/token coordinate with a token base-unit amount. */
 export interface StellarHubAssetAmount extends StellarHubAsset {
+    /** i128 decimal string in token base units; e.g. 1 token at 7 decimals is "10000000". */
     amount: string;
 }
 export interface StellarSupplyArgs extends StellarHubAssetAmount {
-    /** Existing account id; omit / `0` opens a new account. */
-    accountNonce?: number;
-    /** Risk spoke the (new) account binds to; defaults to the canonical spoke 0. */
-    spokeId?: number;
+    /** Lending account ID, distinct from the Stellar sequence. Prefer decimal strings; omit / 0 opens an account. */
+    accountNonce?: number | string;
+    /** Positive risk-spoke ID. Must match the existing account when topping up. */
+    spokeId: number;
 }
 export interface StellarSupplyBatchArgs {
-    accountNonce?: number;
-    spokeId?: number;
+    accountNonce?: number | string;
+    /** Positive risk-spoke ID; never inferred from the asset or hub. */
+    spokeId: number;
     assets: ReadonlyArray<StellarHubAssetAmount>;
 }
 export interface StellarBorrowArgs extends StellarHubAssetAmount {
-    accountNonce: number;
+    accountNonce: number | string;
     /** Optional recipient override (`C...`/`G...`); debt is recorded on the account. */
     to?: string;
 }
 export interface StellarBorrowBatchArgs {
-    accountNonce: number;
+    accountNonce: number | string;
     borrows: ReadonlyArray<StellarHubAssetAmount>;
     to?: string;
 }
 export interface StellarWithdrawArgs extends StellarHubAssetAmount {
-    accountNonce: number;
+    accountNonce: number | string;
     /**
      * Optional recipient override (`C...` or `G...`). The pool pays the
      * withdrawn tokens to this address instead of the caller. Omit for the
@@ -119,19 +123,19 @@ export interface StellarWithdrawArgs extends StellarHubAssetAmount {
     to?: string;
 }
 export interface StellarWithdrawBatchArgs {
-    accountNonce: number;
+    accountNonce: number | string;
     withdrawals: ReadonlyArray<StellarHubAssetAmount>;
     to?: string;
 }
 export interface StellarRepayArgs extends StellarHubAssetAmount {
-    accountNonce: number;
+    accountNonce: number | string;
 }
 export interface StellarRepayBatchArgs {
-    accountNonce: number;
+    accountNonce: number | string;
     payments: ReadonlyArray<StellarHubAssetAmount>;
 }
 export interface StellarLiquidateArgs {
-    accountNonce: number;
+    accountNonce: number | string;
     debtPayments: ReadonlyArray<StellarHubAssetAmount>;
     /**
      * How the liquidator takes delivery of the seized collateral. Defaults to
@@ -147,33 +151,34 @@ export interface StellarFlashLoanArgs extends StellarHubAsset {
     data: string | Uint8Array;
 }
 export interface StellarMultiplyArgs {
-    accountNonce?: number;
-    spokeId?: number;
+    accountNonce?: number | string;
+    /** Positive risk-spoke ID. Must match the existing account when reusing it. */
+    spokeId: number;
     collateral: StellarHubAsset;
     debtToFlashLoan: string;
     debt: StellarHubAsset;
-    /** `PositionMode` repr(u32). */
+    /** Stellar PositionMode: 0 normal, 1 multiply, 2 long, 3 short. */
     mode: number;
     steps: StellarSwapStepsInput;
     initialPayment?: StellarHubAssetAmount;
     convertSwap?: StellarSwapStepsInput;
 }
 export interface StellarSwapDebtArgs {
-    accountNonce: number;
+    accountNonce: number | string;
     existingDebt: StellarHubAsset;
     newDebtAmount: string;
     newDebt: StellarHubAsset;
     steps: StellarSwapStepsInput;
 }
 export interface StellarSwapCollateralArgs {
-    accountNonce: number;
+    accountNonce: number | string;
     current: StellarHubAsset;
     fromAmount: string;
     newCollateral: StellarHubAsset;
     steps: StellarSwapStepsInput;
 }
 export interface StellarRepayDebtWithCollateralArgs {
-    accountNonce: number;
+    accountNonce: number | string;
     collateral: StellarHubAsset;
     collateralAmount: string;
     debt: StellarHubAsset;
@@ -183,7 +188,7 @@ export interface StellarRepayDebtWithCollateralArgs {
 /**
  * `migrate_from_blend` references the *Blend* pool's bare-`Address` assets, so
  * collateral / supply / debt stay token-keyed; only the account's risk spoke
- * (`spoke_id`) crosses on the XOXNO side.
+ * and destination liquidity hub cross on the XOXNO side.
  */
 export interface StellarMigrateFromBlendArgs {
     accountId: number | string;
@@ -199,32 +204,68 @@ export interface StellarMigrateFromBlendArgs {
 }
 /**
  * supply(caller, account_id: u64, spoke_id: u32, assets: Vec<(HubAssetKey, i128)>)
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
+ */
+export declare function buildStellarSupplyBatchTx(opts: StellarLendingBuilderOptions, args: StellarSupplyBatchArgs): BuiltStellarTx;
+/** Single-asset `supply` — wraps the asset in a 1-element batch.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarSupplyBatchTx(opts: StellarBuilderOptions, args: StellarSupplyBatchArgs): BuiltStellarTx;
-/** Single-asset `supply` — wraps the asset in a 1-element batch. */
-export declare function buildStellarSupplyTx(opts: StellarBuilderOptions, args: StellarSupplyArgs): BuiltStellarTx;
+export declare function buildStellarSupplyTx(opts: StellarLendingBuilderOptions, args: StellarSupplyArgs): BuiltStellarTx;
 /**
  * borrow(caller, account_id: u64, borrows: Vec<(HubAssetKey, i128)>,
  * to: Option<Address>) — `to` is always sent; absent means the caller
  * receives the funds.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarBorrowBatchTx(opts: StellarBuilderOptions, args: StellarBorrowBatchArgs): BuiltStellarTx;
-/** Single-asset `borrow`. */
-export declare function buildStellarBorrowTx(opts: StellarBuilderOptions, args: StellarBorrowArgs): BuiltStellarTx;
+export declare function buildStellarBorrowBatchTx(opts: StellarLendingBuilderOptions, args: StellarBorrowBatchArgs): BuiltStellarTx;
+/** Single-asset `borrow`.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
+ */
+export declare function buildStellarBorrowTx(opts: StellarLendingBuilderOptions, args: StellarBorrowArgs): BuiltStellarTx;
 /**
  * withdraw(caller, account_id: u64, withdrawals: Vec<(HubAssetKey, i128)>,
  * to: Option<Address>) — `to` is always sent; absent means the caller
  * receives the funds.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
+ */
+export declare function buildStellarWithdrawBatchTx(opts: StellarLendingBuilderOptions, args: StellarWithdrawBatchArgs): BuiltStellarTx;
+/** Single-asset `withdraw`. Amount "0" withdraws the full supplied position.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarWithdrawBatchTx(opts: StellarBuilderOptions, args: StellarWithdrawBatchArgs): BuiltStellarTx;
-/** Single-asset `withdraw`. */
-export declare function buildStellarWithdrawTx(opts: StellarBuilderOptions, args: StellarWithdrawArgs): BuiltStellarTx;
+export declare function buildStellarWithdrawTx(opts: StellarLendingBuilderOptions, args: StellarWithdrawArgs): BuiltStellarTx;
 /**
  * repay(caller, account_id: u64, payments: Vec<(HubAssetKey, i128)>)
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
+ */
+export declare function buildStellarRepayBatchTx(opts: StellarLendingBuilderOptions, args: StellarRepayBatchArgs): BuiltStellarTx;
+/** Single-asset `repay`.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarRepayBatchTx(opts: StellarBuilderOptions, args: StellarRepayBatchArgs): BuiltStellarTx;
-/** Single-asset `repay`. */
-export declare function buildStellarRepayTx(opts: StellarBuilderOptions, args: StellarRepayArgs): BuiltStellarTx;
+export declare function buildStellarRepayTx(opts: StellarLendingBuilderOptions, args: StellarRepayArgs): BuiltStellarTx;
 /**
  * liquidate(liquidator, account_id: u64, debt_payments: Vec<(HubAssetKey, i128)>,
  *           seize_mode: SeizeMode) -> u64
@@ -233,8 +274,12 @@ export declare function buildStellarRepayTx(opts: StellarBuilderOptions, args: S
  * `SeizeMode::Credit` (freshly opened when `Credit(0)` was passed), and `0`
  * under `SeizeMode::Transfer`. Read it from the simulation / tx result with
  * `decodeStellarLiquidateReturn`.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarLiquidateTx(opts: StellarBuilderOptions, args: StellarLiquidateArgs): BuiltStellarTx;
+export declare function buildStellarLiquidateTx(opts: StellarLendingBuilderOptions, args: StellarLiquidateArgs): BuiltStellarTx;
 /**
  * Decode `liquidate`'s `u64` return value from its base64 XDR — the receiving
  * account id, as a decimal string. `'0'` means `SeizeMode::Transfer` (the
@@ -247,22 +292,32 @@ export declare function buildStellarLiquidateTx(opts: StellarBuilderOptions, arg
 export declare function decodeStellarLiquidateReturn(returnValueB64: string): string;
 /**
  * flash_loan(caller, asset: HubAssetKey, amount: i128, receiver, data: Bytes)
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarFlashLoanTx(opts: StellarBuilderOptions, args: StellarFlashLoanArgs): BuiltStellarTx;
+export declare function buildStellarFlashLoanTx(opts: StellarLendingBuilderOptions, args: StellarFlashLoanArgs): BuiltStellarTx;
 /**
  * Build a `migrate_from_blend` controller invocation: atomically moves a Blend
  * V2 position (collateral + supply + debt) into XOXNO at zero flash-loan fee.
  *
- * ABI: `migrate_from_blend(caller, account_id, spoke_id, blend_pool,
+ * ABI: `migrate_from_blend(caller, account_id, spoke_id, hub_id, blend_pool,
  * collateral_assets, supply_assets, debt_caps: Vec<(Address, i128)>)`. Pass
  * `accountId = "0"` to open a new account. Each debt cap should slightly exceed
  * the live Blend debt — Blend refunds the excess, reconciled on-chain.
  *
  * Like every builder this emits an unsigned invoke; the nested `submit(from =
  * user)` authorization is materialized by `prepareTransaction` (simulation) and
- * signed by the wallet over the whole envelope.
+ * signed by the wallet over the whole envelope. The Blend pool must be approved
+ * by the controller. Use an explicit destination hub and spoke; this operation
+ * does not consume aggregator route bytes.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarMigrateFromBlendTx(opts: StellarBuilderOptions, args: StellarMigrateFromBlendArgs): BuiltStellarTx;
+export declare function buildStellarMigrateFromBlendTx(opts: StellarLendingBuilderOptions, args: StellarMigrateFromBlendArgs): BuiltStellarTx;
 /**
  * multiply(caller, account_id, spoke_id, collateral: HubAssetKey,
  *          debt_to_flash_loan: i128, debt: HubAssetKey, mode: PositionMode,
@@ -272,21 +327,37 @@ export declare function buildStellarMigrateFromBlendTx(opts: StellarBuilderOptio
  * `mode` is a repr(u32) `PositionMode` → encoded as `scvU32`. The two trailing
  * `Option`s seed an optional initial collateral payment and a secondary swap
  * converting it into the collateral token; both omit to Soroban `Void`.
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarMultiplyTx(opts: StellarBuilderOptions, args: StellarMultiplyArgs): BuiltStellarTx;
+export declare function buildStellarMultiplyTx(opts: StellarLendingBuilderOptions, args: StellarMultiplyArgs): BuiltStellarTx;
 /**
  * swap_debt(caller, account_id, existing_debt: HubAssetKey, amount: i128,
  *           new_debt: HubAssetKey, swap: Bytes)
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarSwapDebtTx(opts: StellarBuilderOptions, args: StellarSwapDebtArgs): BuiltStellarTx;
+export declare function buildStellarSwapDebtTx(opts: StellarLendingBuilderOptions, args: StellarSwapDebtArgs): BuiltStellarTx;
 /**
  * swap_collateral(caller, account_id, current: HubAssetKey, amount: i128,
  *                 new: HubAssetKey, swap: Bytes)
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarSwapCollateralTx(opts: StellarBuilderOptions, args: StellarSwapCollateralArgs): BuiltStellarTx;
+export declare function buildStellarSwapCollateralTx(opts: StellarLendingBuilderOptions, args: StellarSwapCollateralArgs): BuiltStellarTx;
 /**
  * repay_debt_with_collateral(caller, account_id, collateral: HubAssetKey,
  *                            collateral_amount: i128, debt: HubAssetKey,
  *                            swap: Bytes, close_position: bool)
+ * @param opts - Network, caller, current source sequence and deployment addresses.
+ * @param args - Operation arguments; token amounts are decimal base-unit strings.
+ * @returns Unsigned XDR; prepare with prepareStellarBuiltTx before wallet signing.
+ * @category Lending transactions
  */
-export declare function buildStellarRepayDebtWithCollateralTx(opts: StellarBuilderOptions, args: StellarRepayDebtWithCollateralArgs): BuiltStellarTx;
+export declare function buildStellarRepayDebtWithCollateralTx(opts: StellarLendingBuilderOptions, args: StellarRepayDebtWithCollateralArgs): BuiltStellarTx;

package/dist/cjs/sdk/stellar/prepare.d.ts

@@ -1,5 +1,13 @@
 import type { FeeBumpTransaction, Transaction } from '@stellar/stellar-sdk';
-import type { BuiltStellarTx } from './lending';
+import type { BuiltStellarTx } from './lending.js';
+import { type StellarNetwork } from './contracts.js';
+/** Options for preparing unsigned XDR. The wallet must sign on this network. */
+export interface StellarPrepareOptions {
+    /** Selected Stellar network. Omission preserves the legacy unsigned-XDR API. */
+    network?: StellarNetwork;
+    /** Contract used to qualify errors before mapping controller/pool error codes. */
+    invokedContractId?: string;
+}
 /**
  * The single `rpc.Server` capability the prepare helpers need. Declared
  * structurally instead of `Pick<rpc.Server, 'prepareTransaction'>` so the
@@ -16,10 +24,22 @@ export declare function tagStellarInvokedContractError(contractId: string, error
  * Simulate a built Soroban envelope (footprint, auth, resource fee) and return
  * prepared base64 XDR. Optionally tag failures with the invoked contract id so
  * UIs can map `Error(Contract, #N)` codes to the right ABI.
+ * @param server - Host application's RPC server on the selected network.
+ * @param xdr - Unsigned builder output, not a signed transaction.
+ * @param opts - Pass `network` explicitly; it must match the RPC and wallet.
+ * @returns Prepared, unsigned base64 XDR for wallet signing.
+ * @remarks This helper does not sign, submit, or wait for confirmation. Existing
+ * calls without `network` retain a neutral hash domain because XDR contains no
+ * passphrase; always select the actual network when the wallet signs.
+ * @category Transaction preparation
  */
-export declare function prepareStellarTxXdr(server: StellarTxPreparer, xdr: string, opts?: {
-    invokedContractId?: string;
-}): Promise<string>;
-export declare function prepareStellarBuiltTx(server: StellarTxPreparer, built: BuiltStellarTx, opts?: {
-    invokedContractId?: string;
-}): Promise<string>;
+export declare function prepareStellarTxXdr(server: StellarTxPreparer, xdr: string, opts?: StellarPrepareOptions): Promise<string>;
+/**
+ * Prepare {@link BuiltStellarTx} before wallet signing.
+ * @param server - Host RPC server for the selected deployment.
+ * @param built - Unsigned output of any Stellar transaction builder.
+ * @param opts - Network and optional contract context for error mapping.
+ * @returns Prepared unsigned base64 XDR; sign this result, then submit it.
+ * @category Transaction preparation
+ */
+export declare function prepareStellarBuiltTx(server: StellarTxPreparer, built: BuiltStellarTx, opts?: StellarPrepareOptions): Promise<string>;

package/dist/cjs/sdk/stellar/quote.d.ts

@@ -12,7 +12,7 @@
  * after the SDK encoder rewrites field names.
  */
 import type { StellarAggregatorQuoteRequestDto, StellarAggregatorQuoteResponseDto, StellarTokenKind } from '@xoxno/types';
-import { type StellarNetwork } from './contracts';
+import type { StellarNetwork } from './contracts.js';
 /**
  * Resolved token entry returned by the quote server's tokens endpoint.
  * Mirrors the indexer's `TokenEntry` JSON exactly.
@@ -31,10 +31,10 @@ export interface StellarQuoteToken {
     degree: number;
 }
 export interface StellarQuoteFetchOptions {
-    /** Network selects which base URL to hit. */
-    network: StellarNetwork;
-    /** Override the resolved base URL (useful for tests / preview). */
-    baseUrl?: string;
+    /** Quote-server base URL selected by the host application. */
+    baseUrl: string;
+    /** @deprecated The URL is explicit; network is retained for source compatibility. */
+    network?: StellarNetwork;
     /** Per-call fetch options (signal, headers, etc.). */
     fetchOptions?: RequestInit;
 }
@@ -45,14 +45,21 @@ export interface StellarQuoteFetchOptions {
  * `amountOut`. Reverse mode: pass `amountOut` to compute the minimum
  * `amountIn` that delivers at least that output.
  *
- * Pass both `sender` (G-strkey) and `router` (C-strkey) to receive a
- * ready-to-sign envelope under `transaction.envelopeXdr`. The caller
- * must still run `simulateTransaction` to attach Soroban resource fees
- * before signing.
+ * For lending strategies, pass the quote's `routeXdr` to the builder's
+ * `steps`. Amounts are token base-unit decimal strings. Requote after changes
+ * to amount, direction or slippage; preparation is the execution check.
+ *
+ * Passing both `sender` (G...) and `router` (C...) may return a direct-swap
+ * envelope under `transaction.envelopeXdr`. Prepare it before wallet signing.
+ * @param request - Exactly one of amountIn or amountOut; optional referralId is forwarded unchanged.
+ * @param opts - Quote-server URL and optional fetch options supplied by the host.
+ * @returns Quote estimates and opaque route bytes; does not execute a swap.
+ * @category Strategy quotes
  */
 export declare function getStellarAggregatorQuote(request: StellarAggregatorQuoteRequestDto, opts: StellarQuoteFetchOptions): Promise<StellarAggregatorQuoteResponseDto>;
 /**
  * List tokens currently indexed by the quote server. Useful to populate
  * pickers or validate that a user-supplied token has on-chain liquidity.
+ * @category Strategy quotes
  */
 export declare function getStellarQuoteTokens(opts: StellarQuoteFetchOptions): Promise<StellarQuoteToken[]>;

package/dist/cjs/sdk/stellar/swap.d.ts

@@ -11,18 +11,17 @@
  * opaque route bytes to the controller, which forwards them to the aggregator.
  */
 import type { StellarAggregatorQuoteResponseDto } from '@xoxno/types';
-import type { BuiltStellarTx, StellarBuilderOptions } from './lending';
-import { type StellarStrategyPayloadInput, type StellarStrategySwapHopInput, type StellarStrategySwapInput, type StellarStrategySwapPathInput } from './scval-encode';
+import type { BuiltStellarTx, StellarBuilderOptions } from './lending.js';
+import { type StellarStrategyPayloadInput, type StellarStrategySwapHopInput, type StellarStrategySwapInput, type StellarStrategySwapPathInput } from './scval-encode.js';
 export type StellarStrategyPayload = StellarStrategyPayloadInput;
 export type StellarStrategySwap = StellarStrategySwapInput;
 export type StellarStrategySwapHop = StellarStrategySwapHopInput;
 export type StellarStrategySwapPath = StellarStrategySwapPathInput;
 export interface StellarExecuteStrategyBuilderOptions extends StellarBuilderOptions {
     /**
-     * Override the resolved aggregator router contract address. Normally
-     * resolved from `STELLAR_AGGREGATOR_ROUTER[network]`.
+     * Aggregator router contract (C...) selected by the host application.
      */
-    routerAddress?: string;
+    routerAddress: string;
     /**
      * Total input amount passed to `execute_strategy` (i128 decimal string).
      * For a quote-derived swap, pass `quote.amountIn`.

package/dist/cjs/sdk/stellar-schema.d.ts

@@ -0,0 +1,5 @@
+/** Build-time OpenAPI renderer for the Stellar lending read contracts. */
+export declare function stellarSchemaTypes(source: Record<string, any>): {
+    type: (schema: any, prefix?: string) => string;
+    render(): string;
+};