@xoxno/sdk-js 1.0.220 → 1.0.222

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

@@ -0,0 +1 @@
+export {};

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

@@ -1,3 +1,4 @@
+import { rpc } from '@stellar/stellar-sdk';
 import type { FeeBumpTransaction, Transaction } from '@stellar/stellar-sdk';
 import type { BuiltStellarTx } from './lending.js';
 import { type StellarNetwork } from './contracts.js';
@@ -7,17 +8,21 @@ export interface StellarPrepareOptions {
     network?: StellarNetwork;
     /** Contract used to qualify errors before mapping controller/pool error codes. */
     invokedContractId?: string;
+    /**
+     * Extra CPU instructions requested from simulation (default 20,000,000).
+     * Covers the measured ~11.84M instruction increase across a ledger boundary
+     * for a ten-position accrual flow, with headroom.
+     * Must be an integer from 0 to 4294967295. Increase for measured execution
+     * variance; this margin does not guarantee coverage of later state changes
+     * or maximum-position flows. The resulting resources must fit network limits.
+     */
+    instructionLeeway?: number;
 }
-/**
- * The single `rpc.Server` capability the prepare helpers need. Declared
- * structurally instead of `Pick<rpc.Server, 'prepareTransaction'>` so the
- * published `.d.ts` references stellar-sdk's concrete `Transaction` exports
- * rather than its `rpc` namespace — the namespaced form trips
- * `dts-bundle-generator`'s external-type resolution under stellar-sdk v16. A
- * real `rpc.Server` satisfies this structurally, so call sites are unchanged.
- */
+/** The simulation capability the prepare helpers need from `rpc.Server`. */
 export interface StellarTxPreparer {
-    prepareTransaction(tx: Transaction | FeeBumpTransaction): Promise<Transaction>;
+    simulateTransaction(tx: Transaction | FeeBumpTransaction, resources?: {
+        cpuInstructions?: number;
+    }): Promise<rpc.Api.SimulateTransactionResponse>;
 }
 export declare function tagStellarInvokedContractError(contractId: string, error: unknown): Error;
 /**

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

@@ -11,25 +11,86 @@
  * the wire shape is camelCase, the Soroban contract receives snake_case
  * after the SDK encoder rewrites field names.
  */
-import type { StellarAggregatorQuoteRequestDto, StellarAggregatorQuoteResponseDto, StellarTokenKind } from '@xoxno/types';
+import type { StellarAggregatorQuoteRequestDto, StellarAggregatorQuoteResponseDto, StellarQuoteTransactionPayloadDto } from '@xoxno/types';
 import type { StellarNetwork } from './contracts.js';
 /**
- * Resolved token entry returned by the quote server's tokens endpoint.
- * Mirrors the indexer's `TokenEntry` JSON exactly.
+ * Token entry returned by `GET /api/v1/tokens`. Mirrors the service's
+ * `TokenEntry` schema exactly.
  */
 export interface StellarQuoteToken {
-    /** Canonical token id. `C…` for Soroban contracts; `CODE:GISSUER…`
-     *  for Classic; `XLM` for native. */
+    /** Canonical Soroban token contract id (`C…`). `XLM` and `CODE:ISSUER`
+     *  forms are rejected by the service. */
     id: string;
-    kind: StellarTokenKind;
+    /** Decimal places: divide atomic amounts by 10^decimals for display. */
     decimals: number;
-    /** Soroban Asset Contract peer for Classic assets (null otherwise). */
-    sacPeer: string | null;
-    /** Classic asset code (for Classic / SAC entries; null for Soroban). */
-    code: string | null;
-    /** Number of pools touching this token in the current snapshot. */
-    degree: number;
+    /** `true` for a pool share token; quoting from/to it is a liquidity route. */
+    lp: boolean;
+    /** Venues the token appears on, sorted. For an LP token, the issuing venue. */
+    dexes: string[];
+    /** LP only: the pool contract that issued the shares. */
+    pool?: string | null;
+    /** LP only: constituent token ids in pool order. */
+    assets?: string[] | null;
+    /** @deprecated Not returned by the service; always `undefined`. */
+    kind?: never;
+    /** @deprecated Not returned by the service; always `undefined`. */
+    sacPeer?: never;
+    /** @deprecated Not returned by the service; always `undefined`. */
+    code?: never;
+    /** @deprecated Not returned by the service; always `undefined`. */
+    degree?: never;
 }
+/** Liquidity snapshot the route was searched against. */
+export interface StellarQuoteSnapshot {
+    ledger: number;
+    ageSeconds: number;
+    /** Live ledger compared against; present only when `fresh=true`. */
+    checkedLiveLedger?: number | null;
+}
+/** Set when the route was reduced to fit the simulation budget. */
+export interface StellarQuoteDegraded {
+    requestedMaxSplits: number;
+    effectiveMaxSplits: number;
+    requestedMaxHops: number;
+    effectiveMaxHops: number;
+    fallbackAttempts: number;
+    reason: string;
+}
+export interface StellarQuoteLpConstituent {
+    token: string;
+    tokenKind: string;
+    /** Raw u128 amount as a string. */
+    amount: string;
+    amountShort: number;
+}
+/** Liquidity breakdown for add/remove/convert-liquidity quotes. Informational. */
+export interface StellarQuoteLp {
+    pool: string;
+    dex: string;
+    kind: string;
+    feeBps: number;
+    shareToken: string;
+    amounts: StellarQuoteLpConstituent[];
+    refunded?: StellarQuoteLpConstituent[];
+    preSwap?: unknown;
+}
+/**
+ * Quote response as the service returns it. Extends the `@xoxno/types` DTO with
+ * fields the DTO does not yet declare. `alternatives` is still on the DTO but
+ * the service no longer returns it.
+ */
+export type StellarQuoteResponse = StellarAggregatorQuoteResponseDto & {
+    snapshot?: StellarQuoteSnapshot | null;
+    degraded?: StellarQuoteDegraded | null;
+    lp?: StellarQuoteLp | null;
+    /** Ordered LP-conversion steps; mutually exclusive with `transaction`. */
+    transactions?: StellarQuoteTransactionPayloadDto[] | null;
+};
+/** Quote request; adds `simulate`, which the DTO does not yet declare. */
+export type StellarQuoteRequest = StellarAggregatorQuoteRequestDto & {
+    /** With `sender`: simulate and prepare resource data (service default `true`). */
+    simulate?: boolean;
+};
 export interface StellarQuoteFetchOptions {
     /** Quote-server base URL selected by the host application. */
     baseUrl: string;
@@ -49,14 +110,17 @@ export interface StellarQuoteFetchOptions {
  * `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.
+ * Passing `sender` (G...) together with `slippage` returns a direct-swap
+ * envelope under `transaction.envelopeXdr`. The router comes from the service's
+ * `/api/v1/config`; the `router` request field is ignored by the service and is
+ * no longer sent. Prepare the envelope before wallet signing unless
+ * `transaction.simulated` is true.
  * @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>;
+export declare function getStellarAggregatorQuote(request: StellarQuoteRequest, opts: StellarQuoteFetchOptions): Promise<StellarQuoteResponse>;
 /**
  * List tokens currently indexed by the quote server. Useful to populate
  * pickers or validate that a user-supplied token has on-chain liquidity.