# Blux Documentation

> The complete wallet infrastructure for Stellar dApps.

This is the default documentation entry for AI agents. Start here, then follow the Markdown links. Use `/llms-full.txt` when you need the entire corpus in one fetch. HTML docs for humans live at https://docs.blux.cc/.

## Docs

- [Introduction](https://docs.blux.cc/llms.mdx/content.md): The complete wallet infrastructure for Stellar dApps.
- [Getting Started](https://docs.blux.cc/llms.mdx/getting-started/content.md): From zero to a working Blux integration — the whole flow in one page.

## Configuration

- [Configuration](https://docs.blux.cc/llms.mdx/configuration/content.md): Customize and configure every aspect of your Blux integration.
- [Appearance](https://docs.blux.cc/llms.mdx/configuration/appearance/content.md): Customize the look and feel of the Blux modal to match your dApp's branding.
- [Exclude Wallets](https://docs.blux.cc/llms.mdx/configuration/exclude-wallets/content.md): Control which wallets appear in the Blux login modal.
- [Explorer](https://docs.blux.cc/llms.mdx/configuration/explorer/content.md): Configure which Stellar block explorer Blux uses for transaction links.
- [Language](https://docs.blux.cc/llms.mdx/configuration/language/content.md): Set the language used across the Blux modals and UI.
- [Login Methods](https://docs.blux.cc/llms.mdx/configuration/login-methods/content.md): Control which authentication methods are available in the Blux login modal.
- [Networks](https://docs.blux.cc/llms.mdx/configuration/networks/content.md): Configure which Stellar networks your app supports.
- [Order Wallets](https://docs.blux.cc/llms.mdx/configuration/order-wallets/content.md): Control the order wallets appear in the Blux login modal.
- [Transports](https://docs.blux.cc/llms.mdx/configuration/transports/content.md): Configure custom RPC endpoints for each network in your Blux app.
- [Trezor](https://docs.blux.cc/llms.mdx/configuration/trezor/content.md): Configure the Trezor hardware wallet integration.
- [Wallet Connect](https://docs.blux.cc/llms.mdx/configuration/walletConnect/content.md): Enable WalletConnect support in your Blux app.

## Dashboard

- [Dashboard](https://docs.blux.cc/llms.mdx/dashboard/content.md): Manage your app, users, and login settings from the Blux Dashboard.
- [Users & Analytics](https://docs.blux.cc/llms.mdx/dashboard/users/content.md): View, manage, and export your app's users, and track usage with analytics.
- [Access Control](https://docs.blux.cc/llms.mdx/dashboard/access-control/content.md): Control who can log in and from where — allowlists, blocklists, allowed origins, and test accounts.
- [Social Login](https://docs.blux.cc/llms.mdx/dashboard/socials/content.md): Enable and configure every social login provider available for your Blux app.

## Server API

- [Server API](https://docs.blux.cc/llms.mdx/api/content.md): Use your App Secret from a trusted backend to work with your Blux project and its users.
- [App Secret & Authentication](https://docs.blux.cc/llms.mdx/api/authentication/content.md): Authenticate Server API calls without exposing your project's App Secret.
- [Users](https://docs.blux.cc/llms.mdx/api/users/content.md): List, count, search, retrieve, and delete users with the Server API.
- [Verify a Wallet](https://docs.blux.cc/llms.mdx/api/verify-wallet/content.md): Confirm that a public address belongs to a user who authenticated with your Blux project.

## Javascript

- [Javascript](https://docs.blux.cc/llms.mdx/javascript/content.md): Integrate Blux into any JavaScript project using the core SDK.

### Core

- [Core](https://docs.blux.cc/llms.mdx/javascript/core/content.md): Low-level Stellar primitives available across all Blux integrations.
- [Address resolution and .xlm names](https://docs.blux.cc/llms.mdx/javascript/core/address-resolution/content.md): Use G, M, and C addresses, SEP-2 federation addresses, or human-readable .xlm names throughout the Blux SDK.
- [Fund Account](https://docs.blux.cc/llms.mdx/javascript/core/fundAccount/content.md): Fund an account with Friendbot on supported Stellar test networks.
- [Get Account](https://docs.blux.cc/llms.mdx/javascript/core/getAccount/content.md): Fetch details of a Stellar account using the Blux core SDK.
- [Get Accounts](https://docs.blux.cc/llms.mdx/javascript/core/getAccounts/content.md): Fetch a paginated list of Stellar accounts using the Blux core SDK.
- [Get Assets](https://docs.blux.cc/llms.mdx/javascript/core/getAssets/content.md): Fetch a paginated list of Stellar assets using the Blux core SDK.
- [Get Balances](https://docs.blux.cc/llms.mdx/javascript/core/getBalances/content.md): Fetch the balances of a Stellar account using the Blux core SDK.
- [Get Claimable Balances](https://docs.blux.cc/llms.mdx/javascript/core/getClaimableBalances/content.md): Fetch a paginated list of claimable balances using the Blux core SDK.
- [Get Effects](https://docs.blux.cc/llms.mdx/javascript/core/getEffects/content.md): Fetch a paginated list of Stellar effects using the Blux core SDK.
- [Get Ledgers](https://docs.blux.cc/llms.mdx/javascript/core/getLedgers/content.md): Fetch a paginated list of Stellar ledgers using the Blux core SDK.
- [Get Liquidity Pools](https://docs.blux.cc/llms.mdx/javascript/core/getLiquidityPools/content.md): Fetch a paginated list of Stellar liquidity pools using the Blux core SDK.
- [Get Network](https://docs.blux.cc/llms.mdx/javascript/core/getNetwork/content.md): Retrieve the currently active network in your Blux app.
- [Get Offers](https://docs.blux.cc/llms.mdx/javascript/core/getOffers/content.md): Fetch a paginated list of Stellar offers using the Blux core SDK.
- [Get Operations](https://docs.blux.cc/llms.mdx/javascript/core/getOperations/content.md): Fetch a paginated list of Stellar operations using the Blux core SDK.
- [Get Orderbook](https://docs.blux.cc/llms.mdx/javascript/core/getOrderbook/content.md): Fetch orderbook data using the Blux core SDK.
- [Get Payments](https://docs.blux.cc/llms.mdx/javascript/core/getPayments/content.md): Fetch a paginated list of Stellar payments using the Blux core SDK.
- [Get SAC Address](https://docs.blux.cc/llms.mdx/javascript/core/getSacAddress/content.md): Derive the Stellar Asset Contract (SAC) id of a classic asset — locally, with no network call.
- [Get Strict Receive Paths](https://docs.blux.cc/llms.mdx/javascript/core/getStrictReceivePaths/content.md): Fetch strict receive payment paths using the Blux core SDK.
- [Get Strict Send Paths](https://docs.blux.cc/llms.mdx/javascript/core/getStrictSendPaths/content.md): Fetch strict send payment paths using the Blux core SDK.
- [Get Token Metadata](https://docs.blux.cc/llms.mdx/javascript/core/getTokenMetadata/content.md): Read a SEP-41 token / Stellar Asset Contract's decimals, name, symbol, and owner by simulation — no account or fees.
- [Get Trade Aggregation](https://docs.blux.cc/llms.mdx/javascript/core/getTradeAggregation/content.md): Fetch trade aggregation data using the Blux core SDK.
- [Get Trades](https://docs.blux.cc/llms.mdx/javascript/core/getTrades/content.md): Fetch a paginated list of Stellar trades using the Blux core SDK.
- [Get Transactions](https://docs.blux.cc/llms.mdx/javascript/core/getTransactions/content.md): Fetch a paginated list of Stellar transactions using the Blux core SDK.
- [Networks](https://docs.blux.cc/llms.mdx/javascript/core/networks/content.md): Access the list of available Stellar networks from the Blux core SDK.
- [Read Contracts](https://docs.blux.cc/llms.mdx/javascript/core/readContracts/content.md): Read state from Soroban smart contracts by simulating contract calls.
- [resolveXlmName](https://docs.blux.cc/llms.mdx/javascript/core/resolveXlmName/content.md): Resolve an XLM Domains name to a validated Stellar account or Soroban contract record.
- [resolveXlmNameByAddress](https://docs.blux.cc/llms.mdx/javascript/core/resolveXlmNameByAddress/content.md): Find one verified XLM Domains name associated with a Stellar account.
- [Swap](https://docs.blux.cc/llms.mdx/javascript/core/swap/content.md): Trade one asset for another through the Stellar DEX and liquidity pools — Blux finds the best path and submits it for you.
- [Switch Network](https://docs.blux.cc/llms.mdx/javascript/core/switchNetwork/content.md): Switch the active network in your Blux app at runtime.
- [Transfer](https://docs.blux.cc/llms.mdx/javascript/core/transfer/content.md): Send XLM, issued assets, or SEP-41 tokens to any recipient — Blux picks the right operation for you.
- [Write Contract](https://docs.blux.cc/llms.mdx/javascript/core/writeContract/content.md): Invoke a Soroban smart contract method that changes on-chain state.

### Usage

- [Usage](https://docs.blux.cc/llms.mdx/javascript/usage/content.md): Everything you can do with the Blux core SDK once a user is connected.
- [Fund Me](https://docs.blux.cc/llms.mdx/javascript/usage/fund-me/content.md): Let users on-ramp fiat into crypto straight to their Stellar wallet.
- [Login](https://docs.blux.cc/llms.mdx/javascript/usage/login/content.md): Authenticate users in your Stellar dApp with Blux's built-in login flow.
- [Profile](https://docs.blux.cc/llms.mdx/javascript/usage/profile/content.md): Open the Blux profile modal for connected users to manage their account.
- [Send Transaction](https://docs.blux.cc/llms.mdx/javascript/usage/send-transaction/content.md): Sign and submit a transaction to the Stellar network using Blux.
- [Sign Auth Entry](https://docs.blux.cc/llms.mdx/javascript/usage/sign-auth-entry/content.md): Sign a Soroban authorization entry with the connected wallet using Blux.
- [Sign Message](https://docs.blux.cc/llms.mdx/javascript/usage/sign-message/content.md): Request a signed message from the connected user using Blux.
- [Sign Transaction](https://docs.blux.cc/llms.mdx/javascript/usage/sign-transaction/content.md): Sign a transaction with the connected wallet without submitting it.
- [White-label Login](https://docs.blux.cc/llms.mdx/javascript/usage/white-label-login/content.md): Build your own authentication UI with the headless login methods in @bluxcc/core.

## React

- [React](https://docs.blux.cc/llms.mdx/react/content.md): Integrate Blux into your React or Next.js application.

### Hooks

- [Hooks](https://docs.blux.cc/llms.mdx/react/hooks/content.md): React hooks for querying Stellar network data and managing wallet state.
- [useAccount](https://docs.blux.cc/llms.mdx/react/hooks/use-account/content.md): Fetch details of a Stellar account in your React app using the Blux SDK.
- [useAccounts](https://docs.blux.cc/llms.mdx/react/hooks/use-accounts/content.md): Fetch a filtered list of Stellar accounts in your React app using the Blux SDK.
- [useAssets](https://docs.blux.cc/llms.mdx/react/hooks/use-assets/content.md): Fetch a paginated list of Stellar assets in your React app using the Blux SDK.
- [useBalances](https://docs.blux.cc/llms.mdx/react/hooks/use-balances/content.md): Fetch the balances of a Stellar account in your React app using the Blux SDK.
- [useClaimableBalances](https://docs.blux.cc/llms.mdx/react/hooks/use-claimable-balances/content.md): Fetch a paginated list of claimable balances in your React app using the Blux SDK.
- [useEffects](https://docs.blux.cc/llms.mdx/react/hooks/use-effects/content.md): Fetch a paginated list of Stellar effects in your React app using the Blux SDK.
- [useLedgers](https://docs.blux.cc/llms.mdx/react/hooks/use-ledgers/content.md): Fetch a paginated list of Stellar ledgers in your React app using the Blux SDK.
- [useLiquidityPools](https://docs.blux.cc/llms.mdx/react/hooks/use-liquidity-pools/content.md): Fetch a paginated list of Stellar liquidity pools in your React app using the Blux SDK.
- [useNetwork](https://docs.blux.cc/llms.mdx/react/hooks/use-network/content.md): Retrieve the currently active network in your React app using the Blux SDK.
- [useOffers](https://docs.blux.cc/llms.mdx/react/hooks/use-offers/content.md): Fetch a paginated list of Stellar offers in your React app using the Blux SDK.
- [useOperations](https://docs.blux.cc/llms.mdx/react/hooks/use-operations/content.md): Fetch a paginated list of Stellar operations in your React app using the Blux SDK.
- [useOrderbook](https://docs.blux.cc/llms.mdx/react/hooks/use-orderbook/content.md): Fetch orderbook data for an asset pair in your React app using the Blux SDK.
- [usePayments](https://docs.blux.cc/llms.mdx/react/hooks/use-payments/content.md): Fetch a paginated list of Stellar payments in your React app using the Blux SDK.
- [useReadContracts](https://docs.blux.cc/llms.mdx/react/hooks/use-read-contracts/content.md): Read state from Soroban smart contracts in React, powered by TanStack Query.
- [useResolveXlmNameByAddress](https://docs.blux.cc/llms.mdx/react/hooks/use-resolve-xlm-name-by-address/content.md): Find a verified XLM Domains name for a Stellar account in React.
- [useResolveXlmName](https://docs.blux.cc/llms.mdx/react/hooks/use-resolve-xlm-name/content.md): Resolve an XLM Domains name in React with TanStack Query caching and status state.
- [useSacAddress](https://docs.blux.cc/llms.mdx/react/hooks/use-sac-address/content.md): Derive the Stellar Asset Contract (SAC) id of a classic asset in React — synchronous and memoized.
- [useStrictReceivePaths](https://docs.blux.cc/llms.mdx/react/hooks/use-strict-receive-paths/content.md): Fetch strict receive payment paths in your React app using the Blux SDK.
- [useStrictSendPaths](https://docs.blux.cc/llms.mdx/react/hooks/use-strict-send-paths/content.md): Fetch strict send payment paths in your React app using the Blux SDK.
- [useSwap](https://docs.blux.cc/llms.mdx/react/hooks/use-swap/content.md): Swap one asset for another from React, powered by a TanStack Query mutation.
- [useSwitchNetwork](https://docs.blux.cc/llms.mdx/react/hooks/use-switch-network/content.md): Change the active network in your React app using the Blux SDK.
- [useTokenMetadata](https://docs.blux.cc/llms.mdx/react/hooks/use-token-metadata/content.md): Read a SEP-41 token / Stellar Asset Contract's metadata in React, powered by TanStack Query.
- [useTradeAggregation](https://docs.blux.cc/llms.mdx/react/hooks/use-trade-aggregation/content.md): Fetch aggregated trade data for an asset pair in your React app using the Blux SDK.
- [useTrades](https://docs.blux.cc/llms.mdx/react/hooks/use-trades/content.md): Fetch a paginated list of Stellar trades in your React app using the Blux SDK.
- [useTransactions](https://docs.blux.cc/llms.mdx/react/hooks/use-transactions/content.md): Fetch a paginated list of Stellar transactions in your React app using the Blux SDK.
- [useTransfer](https://docs.blux.cc/llms.mdx/react/hooks/use-transfer/content.md): Send XLM, issued assets, or SEP-41 tokens from React.
- [useWriteContract](https://docs.blux.cc/llms.mdx/react/hooks/use-write-contract/content.md): Invoke state-changing Soroban contract methods from React, powered by TanStack Query.

### Usage

- [Usage](https://docs.blux.cc/llms.mdx/react/usage/content.md): Learn how to authenticate users, manage profiles, and submit transactions with Blux.
- [Fund Me](https://docs.blux.cc/llms.mdx/react/usage/fund-me/content.md): Let users on-ramp fiat into crypto straight to their Stellar wallet from React.
- [Login](https://docs.blux.cc/llms.mdx/react/usage/login/content.md): Authenticate users in your app with Blux's built-in login modal.
- [Profile](https://docs.blux.cc/llms.mdx/react/usage/profile/content.md): Display and manage the connected user's profile using the Blux SDK.
- [Send Transaction](https://docs.blux.cc/llms.mdx/react/usage/send-transaction/content.md): Sign and submit Stellar transactions from your React app using the Blux SDK.
- [Sign Auth Entry](https://docs.blux.cc/llms.mdx/react/usage/sign-auth-entry/content.md): Sign a Soroban authorization entry from your React app using the Blux SDK.
- [Sign Message](https://docs.blux.cc/llms.mdx/react/usage/sign-message/content.md): Request a signed message from the user's wallet using the Blux SDK.
- [Sign Transaction](https://docs.blux.cc/llms.mdx/react/usage/sign-transaction/content.md): Sign a transaction in your React app without submitting it, using the Blux SDK.
- [White-label Login](https://docs.blux.cc/llms.mdx/react/usage/white-label-login/content.md): Build a custom authentication UI with Blux's React login hooks.
- [Changelog](https://docs.blux.cc/llms.mdx/changelog/content.md): Release notes for @bluxcc/core and @bluxcc/react. Both packages ship at the same version.

## Optional

- [Full documentation](https://docs.blux.cc/llms-full.txt): Complete Blux docs in a single Markdown file for LLM ingestion.