@bluxcc/core 0.2.6 → 0.2.8

package/dist/exports/blux.d.ts

@@ -1,18 +1,66 @@
 import { IUser } from '../store';
+/**
+ * Internal login driver. Prefer the public {@link login}.
+ *
+ * @param isSilent - When `true`, tries to restore a recent session without opening the modal.
+ * @returns A promise that resolves to the authenticated user.
+ */
 export declare const _login: (isSilent: boolean) => Promise<IUser>;
+/**
+ * Opens the Blux modal so the user can connect a wallet or sign in, resolving
+ * once authenticated. Waits for the SDK to finish initializing first.
+ *
+ * @returns The authenticated user.
+ */
 export declare const login: () => Promise<IUser>;
+/**
+ * Signs a transaction XDR with the connected wallet, without submitting it.
+ *
+ * @param xdr - The transaction envelope XDR to sign.
+ * @param options - Optional network passphrase override.
+ * @returns The signed transaction XDR.
+ * @throws If the user is not authenticated or the Blux modal is open elsewhere.
+ */
 export declare const signTransaction: (xdr: string, options?: {
     network: string;
 }) => Promise<unknown>;
+/**
+ * Signs a transaction XDR with the connected wallet and submits it to the network.
+ *
+ * @param xdr - The transaction envelope XDR to sign and submit.
+ * @param options - Optional network passphrase override.
+ * @returns The submitted transaction result (an {@link ISubmittedTransaction}).
+ * @throws If the user is not authenticated or the Blux modal is open elsewhere.
+ */
 export declare const sendTransaction: (xdr: string, options?: {
     network: string;
 }) => Promise<unknown>;
+/**
+ * Signs an arbitrary message with the connected wallet.
+ *
+ * @param message - The message to sign.
+ * @param options - Optional network passphrase override.
+ * @returns The signature.
+ * @throws If the user is not authenticated or the Blux modal is open elsewhere.
+ */
 export declare const signMessage: (message: string, options?: {
     network: string;
 }) => Promise<unknown>;
+/**
+ * Signs a Soroban authorization entry with the connected wallet.
+ *
+ * @param authEntry - The base64 authorization entry to sign.
+ * @param options - Optional network passphrase override.
+ * @returns The signed authorization entry.
+ * @throws If the user is not authenticated or the Blux modal is open elsewhere.
+ */
 export declare const signAuthEntry: (authEntry: string, options?: {
     network: string;
 }) => Promise<unknown>;
+/**
+ * The Blux client: authentication, wallet signing, and account UI entry points.
+ * Each method carries its own documentation; the getters expose live auth state.
+ */
 export declare const blux: {
     login: () => Promise<IUser>;
     logout: () => void;
@@ -30,7 +78,10 @@ export declare const blux: {
     sendTransaction: (xdr: string, options?: {
         network: string;
     }) => Promise<unknown>;
+    /** Whether the SDK has finished initializing and is ready to use. */
     readonly isReady: boolean;
+    /** Whether a user is currently authenticated. */
     readonly isAuthenticated: boolean;
+    /** The currently authenticated user, or `undefined` when logged out. */
     readonly user: IUser | undefined;
 };

package/dist/exports/core/callBuilder.d.ts

@@ -1,19 +1,19 @@
-import { Asset } from "@stellar/stellar-sdk";
-import { AccountCallBuilder } from "@stellar/stellar-sdk/lib/horizon/account_call_builder";
-import { ClaimableBalanceCallBuilder } from "@stellar/stellar-sdk/lib/horizon/claimable_balances_call_builder";
-import { LedgerCallBuilder } from "@stellar/stellar-sdk/lib/horizon/ledger_call_builder";
-import { PathCallBuilder } from "@stellar/stellar-sdk/lib/horizon/path_call_builder";
-import { LiquidityPoolCallBuilder } from "@stellar/stellar-sdk/lib/horizon/liquidity_pool_call_builder";
-import { OperationCallBuilder } from "@stellar/stellar-sdk/lib/horizon/operation_call_builder";
-import { OrderbookCallBuilder } from "@stellar/stellar-sdk/lib/horizon/orderbook_call_builder";
-import { OfferCallBuilder } from "@stellar/stellar-sdk/lib/horizon/offer_call_builder";
-import { TransactionCallBuilder } from "@stellar/stellar-sdk/lib/horizon/transaction_call_builder";
-import { TradesCallBuilder } from "@stellar/stellar-sdk/lib/horizon/trades_call_builder";
-import { TradeAggregationCallBuilder } from "@stellar/stellar-sdk/lib/horizon/trade_aggregation_call_builder";
-import { EffectCallBuilder } from "@stellar/stellar-sdk/lib/horizon/effect_call_builder";
-import { PaymentCallBuilder } from "@stellar/stellar-sdk/lib/horizon/payment_call_builder";
-import { AssetsCallBuilder } from "@stellar/stellar-sdk/lib/horizon/assets_call_builder";
-import { CallBuilderOptions } from "../utils";
+import { Asset } from '@stellar/stellar-sdk';
+import { CallBuilderOptions } from '../utils';
+import { AccountCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/account_call_builder';
+import { ClaimableBalanceCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/claimable_balances_call_builder';
+import { LedgerCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/ledger_call_builder';
+import { TransactionCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/transaction_call_builder';
+import { OfferCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/offer_call_builder';
+import { TradesCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/trades_call_builder';
+import { OperationCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/operation_call_builder';
+import { LiquidityPoolCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/liquidity_pool_call_builder';
+import { OrderbookCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/orderbook_call_builder';
+import { PathCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/path_call_builder';
+import { TradeAggregationCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/trade_aggregation_call_builder';
+import { AssetsCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/assets_call_builder';
+import { EffectCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/effect_call_builder';
+import { PaymentCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/payment_call_builder';
 type CallBuilderMap = {
     accounts: [[], AccountCallBuilder];
     claimableBalances: [[], ClaimableBalanceCallBuilder];
@@ -55,5 +55,14 @@ type CallBuilderMap = {
         TradeAggregationCallBuilder
     ];
 };
+/**
+ * Internal helper: creates the Horizon call builder named `callName`, applies the
+ * shared cursor/limit/order paging from `params`, and returns it ready to call.
+ *
+ * @param callName - Which Horizon collection to query.
+ * @param args - Positional arguments specific to that collection (already resolved to `Asset`s / account ids).
+ * @param params - Pagination and network options.
+ * @returns The configured Horizon call builder for `callName`.
+ */
 export declare const callBuilder: <C extends keyof CallBuilderMap>(callName: C, args: CallBuilderMap[C][0], params: CallBuilderOptions) => CallBuilderMap[C][1];
 export {};

package/dist/exports/core/fundAccount.d.ts

@@ -0,0 +1,34 @@
+/** Outcome of a single Friendbot funding attempt. */
+export type FundAccountStatus = 'funded' | 'already_funded' | 'failed';
+/** Options for {@link fundAccount}. */
+export type FundAccountOptions = {
+    /**
+     * Network(s) to fund on, by passphrase or friendly name (`testnet` /
+     * `futurenet`). Defaults to both testnet and futurenet. Friendbot is only
+     * available on those networks.
+     */
+    network?: string | string[];
+};
+/** Result of funding one network. */
+export type FundAccountResult = {
+    /** Friendly network name (e.g. `testnet`), or the passphrase if unnamed. */
+    network: string;
+    /** Network passphrase that was funded. */
+    passphrase: string;
+    /** Whether the account was funded, was already funded, or the attempt failed. */
+    status: FundAccountStatus;
+    /** Hash of the funding transaction, when Friendbot returned one. */
+    hash?: string;
+    /** Failure reason, present only when `status` is `failed`. */
+    error?: string;
+};
+/**
+ * Funds an account with test lumens via Friendbot. Resolves federated addresses
+ * first and funds each requested network independently.
+ *
+ * @param address - Account to fund (address or federated address). Defaults to the logged-in account.
+ * @param options - Which network(s) to fund on.
+ * @returns One {@link FundAccountResult} per requested network.
+ * @throws If the address cannot be resolved, or a requested network is not fundable by Friendbot.
+ */
+export declare const fundAccount: (address?: string, options?: FundAccountOptions) => Promise<FundAccountResult[]>;

package/dist/exports/core/getAccount.d.ts

@@ -1,7 +1,21 @@
 import { Horizon } from '@stellar/stellar-sdk';
+/** Options for {@link getAccount}. */
 export type GetAccountOptions = {
+    /**
+     * Account to load: a Stellar address (`G...`/`M...`) or a SEP-2 federated
+     * address (`name*domain.com`). Defaults to the logged-in account.
+     */
     address?: string;
+    /** Network passphrase to query. Defaults to the active network. */
     network?: string;
 };
+/** The loaded account, or `null` when it does not exist on-chain. */
 export type GetAccountResult = Horizon.AccountResponse | null;
+/**
+ * Loads a single account from Horizon, resolving federated addresses first.
+ *
+ * @param options - Which account to load and on which network.
+ * @returns The account record, or `null` if it is not found / not yet funded.
+ * @throws If `address` is neither a valid Stellar address nor a resolvable federated address.
+ */
 export declare const getAccount: (options: GetAccountOptions) => Promise<GetAccountResult>;

package/dist/exports/core/getAccounts.d.ts

@@ -1,34 +1,38 @@
-import { Asset, Horizon } from '@stellar/stellar-sdk';
-import { AccountCallBuilder } from '@stellar/stellar-sdk/lib/horizon/account_call_builder';
+import { Horizon } from '@stellar/stellar-sdk';
+import { AccountCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/account_call_builder';
+import { type AssetArg } from './helpers';
 import { CallBuilderOptions } from '../utils';
-type GetAccountsOptionsA = {
-    forSigner: string;
-    forAsset?: Asset;
-    sponsor?: string;
-    forLiquidityPool?: string;
-};
-type GetAccountsOptionsB = {
+/** Filter fields for {@link getAccounts}; at least one must be provided. */
+type GetAccountsFilters = {
+    /** Accounts that list this key as a signer (address or federated address). */
     forSigner?: string;
-    forAsset: Asset;
+    /** Accounts holding a trustline to this asset (`'xlm'`, `'CODE:ISSUER'`, or an `Asset`). */
+    forAsset?: AssetArg;
+    /** Accounts sponsored by this account id. */
     sponsor?: string;
+    /** Accounts participating in this liquidity pool id. */
     forLiquidityPool?: string;
 };
-type GetAccountsOptionsC = {
-    forSigner?: string;
-    forAsset?: Asset;
-    sponsor: string;
-    forLiquidityPool?: string;
-};
-type GetAccountsOptionsD = {
-    forSigner?: string;
-    forAsset?: Asset;
-    sponsor?: string;
-    forLiquidityPool: string;
-};
-export type GetAccountsOptions = CallBuilderOptions & (GetAccountsOptionsA | GetAccountsOptionsB | GetAccountsOptionsC | GetAccountsOptionsD);
+/**
+ * Requires at least one key of `T` to be present while keeping the rest
+ * optional — Horizon's `/accounts` endpoint must be filtered by something.
+ */
+type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Omit<T, K>>;
+}[keyof T];
+/** Options for {@link getAccounts}: pagination plus at least one filter. */
+export type GetAccountsOptions = CallBuilderOptions & RequireAtLeastOne<GetAccountsFilters>;
+/** The Horizon call builder plus the first page of accounts. */
 export type GetAccountsResult = {
     builder: AccountCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.AccountRecord>;
 };
+/**
+ * Lists accounts filtered by signer, asset trustline, sponsor, or liquidity
+ * pool. At least one filter is required by Horizon.
+ *
+ * @param options - At least one filter, plus pagination and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getAccounts: (options: GetAccountsOptions) => Promise<GetAccountsResult>;
 export {};

package/dist/exports/core/getAssets.d.ts

@@ -1,12 +1,22 @@
 import { Horizon } from '@stellar/stellar-sdk';
-import { AssetsCallBuilder } from '@stellar/stellar-sdk/lib/horizon/assets_call_builder';
+import { AssetsCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/assets_call_builder';
 import { CallBuilderOptions } from '../utils';
+/** Options for {@link getAssets}. Extends the shared {@link CallBuilderOptions}. */
 export type GetAssetsOptions = CallBuilderOptions & {
+    /** Filter to a single asset code (e.g. `USDC`). */
     forCode?: string;
+    /** Filter to assets issued by this account id. */
     forIssuer?: string;
 };
+/** The Horizon call builder plus the first page of matching issued assets. */
 export type GetAssetsResult = {
     builder: AssetsCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.AssetRecord>;
 };
+/**
+ * Lists issued assets known to Horizon, optionally filtered by code and/or issuer.
+ *
+ * @param options - Filters, pagination, and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getAssets: (options: GetAssetsOptions) => Promise<GetAssetsResult>;

package/dist/exports/core/getBalances.d.ts

@@ -1,8 +1,23 @@
 import { Horizon } from '@stellar/stellar-sdk';
+/** Options for {@link getBalances}. */
 export type GetBalancesOptions = {
+    /**
+     * Account whose balances to read: a Stellar address (`G...`/`M...`) or a SEP-2
+     * federated address. Defaults to the logged-in account.
+     */
     address?: string;
+    /** Network passphrase to query. Defaults to the active network. */
     network?: string;
+    /** Keep balance lines whose balance is exactly zero. Defaults to `false`. */
     includeZeroBalances?: boolean;
 };
+/** The account's balance lines, with the native (XLM) line first when present. */
 export type GetBalancesResult = Horizon.HorizonApi.BalanceLine[];
+/**
+ * Reads an account's asset balances, resolving federated addresses first.
+ *
+ * @param options - Which account to read and on which network.
+ * @returns The balance lines (native first), or an empty array if the account is not found.
+ * @throws If `address` is neither a valid Stellar address nor a resolvable federated address.
+ */
 export declare const getBalances: (options: GetBalancesOptions) => Promise<GetBalancesResult>;

package/dist/exports/core/getClaimableBalances.d.ts

@@ -1,13 +1,26 @@
-import { Asset, Horizon } from '@stellar/stellar-sdk';
-import { ClaimableBalanceCallBuilder } from '@stellar/stellar-sdk/lib/horizon/claimable_balances_call_builder';
+import { Horizon } from '@stellar/stellar-sdk';
+import { ClaimableBalanceCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/claimable_balances_call_builder';
+import { type AssetArg } from './helpers';
 import { CallBuilderOptions } from '../utils';
+/** Options for {@link getClaimableBalances}. Extends the shared {@link CallBuilderOptions}. */
 export type GetClaimableBalancesOptions = CallBuilderOptions & {
-    asset: Asset;
+    /** Only balances of this asset (`'xlm'`, `'CODE:ISSUER'`, or an `Asset`). */
+    asset: AssetArg;
+    /** Only balances sponsored by this account id. */
     sponsor?: string;
+    /** Only balances claimable by this account (address or federated address). */
     claimant: string;
 };
+/** The Horizon call builder plus the first page of claimable balances. */
 export type GetClaimableBalancesResult = {
     builder: ClaimableBalanceCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.ClaimableBalanceRecord>;
 };
+/**
+ * Lists claimable balances, scoped by asset and claimant (and optionally
+ * sponsor).
+ *
+ * @param options - Filters, pagination, and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getClaimableBalances: (options: GetClaimableBalancesOptions) => Promise<GetClaimableBalancesResult>;

package/dist/exports/core/getEffects.d.ts

@@ -1,15 +1,29 @@
 import { Horizon } from '@stellar/stellar-sdk';
-import { EffectCallBuilder } from '@stellar/stellar-sdk/lib/horizon/effect_call_builder';
+import { EffectCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/effect_call_builder';
 import { CallBuilderOptions } from '../utils';
+/** Options for {@link getEffects}. Extends the shared {@link CallBuilderOptions}. */
 export type GetEffectsOptions = CallBuilderOptions & {
+    /** Only effects touching this account (address or federated address). */
     forAccount?: string;
+    /** Only effects in this ledger, by sequence number. */
     forLedger?: string | number;
+    /** Only effects in this transaction, by hash. */
     forTransaction?: string;
+    /** Only effects produced by this operation id. */
     forOperation?: string;
+    /** Only effects for this liquidity pool id. */
     forLiquidityPool?: string;
 };
+/** The Horizon call builder plus the first page of effects. */
 export type GetEffectsResult = {
     builder: EffectCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.EffectRecord>;
 };
+/**
+ * Lists effects (the granular ledger changes operations produce), optionally
+ * scoped to an account, ledger, transaction, operation, or liquidity pool.
+ *
+ * @param options - Filters, pagination, and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getEffects: (options: GetEffectsOptions) => Promise<GetEffectsResult>;

package/dist/exports/core/getLedgers.d.ts

@@ -1,11 +1,20 @@
 import { Horizon } from '@stellar/stellar-sdk';
-import { LedgerCallBuilder } from '@stellar/stellar-sdk/lib/horizon/ledger_call_builder';
+import { LedgerCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/ledger_call_builder';
 import { CallBuilderOptions } from '../utils';
+/** Options for {@link getLedgers}. Extends the shared {@link CallBuilderOptions}. */
 export type GetLedgersOptions = CallBuilderOptions & {
+    /** Fetch a single ledger by its sequence number. */
     ledger?: number | string;
 };
+/** The Horizon call builder plus the first page of ledgers. */
 export type GetLedgersResult = {
     builder: LedgerCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.LedgerRecord>;
 };
+/**
+ * Lists ledgers, or fetches a single ledger when `ledger` is given.
+ *
+ * @param options - Optional ledger selector, pagination, and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getLedgers: (options: GetLedgersOptions) => Promise<GetLedgersResult>;

package/dist/exports/core/getLiquidityPools.d.ts

@@ -1,12 +1,24 @@
-import { Asset, Horizon } from '@stellar/stellar-sdk';
-import { LiquidityPoolCallBuilder } from '@stellar/stellar-sdk/lib/horizon/liquidity_pool_call_builder';
+import { Horizon } from '@stellar/stellar-sdk';
+import { LiquidityPoolCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/liquidity_pool_call_builder';
+import { type AssetArg } from './helpers';
 import { CallBuilderOptions } from '../utils';
+/** Options for {@link getLiquidityPools}. Extends the shared {@link CallBuilderOptions}. */
 export type GetLiquidityPoolsOptions = CallBuilderOptions & {
-    forAssets?: Array<Asset>;
+    /** Only pools made up of exactly these reserve assets (`'xlm'`, `'CODE:ISSUER'`, or `Asset`). */
+    forAssets?: Array<AssetArg>;
+    /** Only pools this account holds shares in (address or federated address). */
     forAccount?: string;
 };
+/** The Horizon call builder plus the first page of liquidity pools. */
 export type GetLiquidityPoolsResult = {
     builder: LiquidityPoolCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.LiquidityPoolRecord>;
 };
+/**
+ * Lists liquidity pools, optionally scoped to a set of reserve assets or a
+ * participating account.
+ *
+ * @param options - Filters, pagination, and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getLiquidityPools: (options: GetLiquidityPoolsOptions) => Promise<GetLiquidityPoolsResult>;

package/dist/exports/core/getNetwork.d.ts

@@ -1 +1,7 @@
+/**
+ * Returns the passphrase of the currently active network.
+ *
+ * @returns The active network passphrase, or an empty string if none is set.
+ * @throws If called before {@link createConfig}.
+ */
 export declare const getNetwork: () => string;

package/dist/exports/core/getOffers.d.ts

@@ -1,15 +1,30 @@
-import { Asset, Horizon } from '@stellar/stellar-sdk';
-import { OfferCallBuilder } from '@stellar/stellar-sdk/lib/horizon/offer_call_builder';
+import { Horizon } from '@stellar/stellar-sdk';
+import { OfferCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/offer_call_builder';
+import { type AssetArg } from './helpers';
 import { CallBuilderOptions } from '../utils';
+/** Options for {@link getOffers}. Extends the shared {@link CallBuilderOptions}. */
 export type GetOffersOptions = CallBuilderOptions & {
+    /** Only offers owned by this account (address or federated address). */
     forAccount?: string;
-    buying?: Asset;
-    selling?: Asset;
+    /** Only offers buying this asset (`'xlm'`, `'CODE:ISSUER'`, or an `Asset`). */
+    buying?: AssetArg;
+    /** Only offers selling this asset (`'xlm'`, `'CODE:ISSUER'`, or an `Asset`). */
+    selling?: AssetArg;
+    /** Only offers sponsored by this account id. */
     sponsor?: string;
+    /** Only offers created by this seller (address or federated address). */
     seller?: string;
 };
+/** The Horizon call builder plus the first page of offers. */
 export type GetOffersResult = {
     builder: OfferCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.OfferRecord>;
 };
+/**
+ * Lists open DEX offers, optionally scoped by owner, buying/selling asset,
+ * sponsor, or seller.
+ *
+ * @param options - Filters, pagination, and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getOffers: (options: GetOffersOptions) => Promise<GetOffersResult>;

package/dist/exports/core/getOperations.d.ts

@@ -1,16 +1,31 @@
 import { Horizon } from '@stellar/stellar-sdk';
-import { OperationCallBuilder } from '@stellar/stellar-sdk/lib/horizon/operation_call_builder';
+import { OperationCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/operation_call_builder';
 import { CallBuilderOptions } from '../utils';
+/** Options for {@link getOperations}. Extends the shared {@link CallBuilderOptions}. */
 export type GetOperationsOptions = CallBuilderOptions & {
+    /** Only operations touching this account (address or federated address). */
     forAccount?: string;
+    /** Only operations for this claimable balance id. */
     forClaimableBalance?: string;
+    /** Only operations in this ledger, by sequence number. */
     forLedger?: string | number;
+    /** Only operations in this transaction, by hash. */
     forTransaction?: string;
+    /** Only operations for this liquidity pool id. */
     forLiquidityPool?: string;
+    /** Include operations from failed transactions. Defaults to `false`. */
     includeFailed?: boolean;
 };
+/** The Horizon call builder plus the first page of operations. */
 export type GetOperationsResult = {
     builder: OperationCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.OperationRecord>;
 };
+/**
+ * Lists operations, optionally scoped to an account, ledger, transaction,
+ * claimable balance, or liquidity pool.
+ *
+ * @param options - Filters, pagination, and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getOperations: (options: GetOperationsOptions) => Promise<GetOperationsResult>;

package/dist/exports/core/getOrderbook.d.ts

@@ -1,8 +1,17 @@
-import { Asset, Horizon } from '@stellar/stellar-sdk';
-import { OrderbookCallBuilder } from '@stellar/stellar-sdk/lib/horizon/orderbook_call_builder';
+import { Horizon } from '@stellar/stellar-sdk';
+import { OrderbookCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/orderbook_call_builder';
+import { type AssetArg } from './helpers';
 import { CallBuilderOptions } from '../utils';
+/** The Horizon call builder plus the current order book snapshot. */
 export type GetOrderbookResult = {
     builder: OrderbookCallBuilder;
     response: Horizon.ServerApi.OrderbookRecord;
 };
-export declare const getOrderbook: (args: [selling: Asset, buying: Asset], options: CallBuilderOptions) => Promise<GetOrderbookResult>;
+/**
+ * Fetches the DEX order book for a `selling`/`buying` asset pair.
+ *
+ * @param args - `[selling, buying]`; each accepts `'xlm'`, `'CODE:ISSUER'`, or an `Asset`.
+ * @param options - Pagination and network.
+ * @returns The `builder` and the order book `response`.
+ */
+export declare const getOrderbook: (args: [selling: AssetArg, buying: AssetArg], options: CallBuilderOptions) => Promise<GetOrderbookResult>;

package/dist/exports/core/getPayments.d.ts

@@ -1,11 +1,23 @@
 import { CallBuilderOptions } from '../utils';
+/** Options for {@link getPayments}. Extends the shared {@link CallBuilderOptions}. */
 export type GetPaymentsOptions = CallBuilderOptions & {
+    /** Only payments touching this account (address or federated address). */
     forAccount?: string;
+    /** Only payments in this ledger, by sequence number. */
     forLedger?: string | number;
+    /** Only payments in this transaction, by hash. */
     forTransaction?: string;
+    /** Include payments from failed transactions. Defaults to `false`. */
     includeFailed?: boolean;
 };
+/**
+ * Lists payment operations, optionally scoped to an account, ledger, or
+ * transaction.
+ *
+ * @param options - Filters, pagination, and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
 export declare const getPayments: (options: GetPaymentsOptions) => Promise<{
-    builder: import("@stellar/stellar-sdk/lib/horizon/payment_call_builder").PaymentCallBuilder;
-    response: import("@stellar/stellar-sdk/lib/horizon").ServerApi.CollectionPage<import("@stellar/stellar-sdk/lib/horizon").ServerApi.CreateAccountOperationRecord | import("@stellar/stellar-sdk/lib/horizon").ServerApi.PaymentOperationRecord | import("@stellar/stellar-sdk/lib/horizon").ServerApi.PathPaymentOperationRecord | import("@stellar/stellar-sdk/lib/horizon").ServerApi.AccountMergeOperationRecord | import("@stellar/stellar-sdk/lib/horizon").ServerApi.PathPaymentStrictSendOperationRecord | import("@stellar/stellar-sdk/lib/horizon").ServerApi.InvokeHostFunctionOperationRecord>;
+    builder: import("@stellar/stellar-sdk/lib/esm/horizon/payment_call_builder").PaymentCallBuilder;
+    response: import("@stellar/stellar-sdk/lib/esm/horizon").ServerApi.CollectionPage<import("@stellar/stellar-sdk/lib/esm/horizon").ServerApi.CreateAccountOperationRecord | import("@stellar/stellar-sdk/lib/esm/horizon").ServerApi.PaymentOperationRecord | import("@stellar/stellar-sdk/lib/esm/horizon").ServerApi.PathPaymentOperationRecord | import("@stellar/stellar-sdk/lib/esm/horizon").ServerApi.AccountMergeOperationRecord | import("@stellar/stellar-sdk/lib/esm/horizon").ServerApi.PathPaymentStrictSendOperationRecord | import("@stellar/stellar-sdk/lib/esm/horizon").ServerApi.InvokeHostFunctionOperationRecord>;
 }>;

package/dist/exports/core/getSacAddress.d.ts

@@ -0,0 +1,18 @@
+import { type AssetArg } from './helpers';
+/**
+ * Computes the Stellar Asset Contract (SAC) address of a classic asset.
+ *
+ * Every classic asset — native XLM or a `CODE:ISSUER` pair — has a deterministic
+ * Soroban contract id derived from the asset plus the network passphrase. That
+ * contract (the SAC) is what lets Soroban contracts hold and move the asset. The
+ * id is computed locally with no network call, so it is returned whether or not
+ * the SAC has actually been deployed yet. Feed the result into
+ * {@link getTokenMetadata}, {@link transfer}'s `token` option, or
+ * {@link readContracts} / {@link writeContract}.
+ *
+ * @param asset - The asset: `'xlm'` / `'native'`, a `CODE:ISSUER` string, or an `Asset`.
+ * @param network - Network passphrase to derive against. Defaults to the active network.
+ * @returns The SAC contract id (`C...`).
+ * @throws If the asset is invalid, or no network is given and there is no active network.
+ */
+export declare const getSacAddress: (asset: AssetArg, network?: string) => string;

package/dist/exports/core/getStrictReceivePaths.d.ts

@@ -1,8 +1,20 @@
-import { Asset, Horizon } from '@stellar/stellar-sdk';
-import { PathCallBuilder } from '@stellar/stellar-sdk/lib/horizon/path_call_builder';
+import { Horizon } from '@stellar/stellar-sdk';
+import { PathCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/path_call_builder';
+import { type AssetArg } from './helpers';
 import { CallBuilderOptions } from '../utils';
+/** The Horizon call builder plus the first page of payment paths. */
 export type GetPaymentPathResult = {
     builder: PathCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.PaymentPathRecord>;
 };
-export declare const getStrictReceivePaths: (args: [source: string | Asset[], destinationAsset: Asset, destinationAmount: string], options: CallBuilderOptions) => Promise<GetPaymentPathResult>;
+/**
+ * Finds payment paths for a fixed amount received (strict-receive): "the
+ * destination must receive exactly X — what could the source send?".
+ *
+ * @param args - `[source, destinationAsset, destinationAmount]`. `source` is
+ *   either the paying account (address or federated address) or an array of
+ *   candidate source assets; `destinationAsset` accepts `'xlm'`/`'CODE:ISSUER'`/`Asset`.
+ * @param options - Pagination and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
+export declare const getStrictReceivePaths: (args: [source: string | AssetArg[], destinationAsset: AssetArg, destinationAmount: string], options: CallBuilderOptions) => Promise<GetPaymentPathResult>;

package/dist/exports/core/getStrictSendPaths.d.ts

@@ -1,8 +1,20 @@
-import { Asset, Horizon } from '@stellar/stellar-sdk';
-import { PathCallBuilder } from '@stellar/stellar-sdk/lib/horizon/path_call_builder';
+import { Horizon } from '@stellar/stellar-sdk';
+import { PathCallBuilder } from '@stellar/stellar-sdk/lib/esm/horizon/path_call_builder';
+import { type AssetArg } from './helpers';
 import { CallBuilderOptions } from '../utils';
+/** The Horizon call builder plus the first page of payment paths. */
 export type GetPaymentPathResult = {
     builder: PathCallBuilder;
     response: Horizon.ServerApi.CollectionPage<Horizon.ServerApi.PaymentPathRecord>;
 };
-export declare const getStrictSendPaths: (args: [sourceAsset: Asset, sourceAmount: string, destination: string | Asset[]], options: CallBuilderOptions) => Promise<GetPaymentPathResult>;
+/**
+ * Finds payment paths for a fixed amount sent (strict-send): "I will send
+ * exactly X of the source asset — what can the destination receive?".
+ *
+ * @param args - `[sourceAsset, sourceAmount, destination]`. `sourceAsset` accepts
+ *   `'xlm'`/`'CODE:ISSUER'`/`Asset`; `destination` is either a recipient account
+ *   (address or federated address) or an array of candidate destination assets.
+ * @param options - Pagination and network.
+ * @returns The `builder` (for further paging) and the first-page `response`.
+ */
+export declare const getStrictSendPaths: (args: [sourceAsset: AssetArg, sourceAmount: string, destination: string | AssetArg[]], options: CallBuilderOptions) => Promise<GetPaymentPathResult>;