Package Exports
- sats-connect
- sats-connect/dist/index.mjs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sats-connect) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
API Docs β’ Example App β’ Discord β’ Xverse
π Introduction
Sats Connect is a simple javascript library that connects apps to Bitcoin, Spark, Starknet, Stacks, and other Bitcoin Layer 2 wallets like Xverse.
Itβs already powering apps across the BitcoinFi ecosystem, with close to 2 million downloads β making it one of the most widely used ways for developers to integrate Bitcoin wallets today.
β¨ What you can do with Sats Connect
Developers building on Bitcoin and its L2s can use Sats Connect to interact directly with usersβ wallets:
- π Retrieve wallet addresses for Bitcoin, Spark, Starknet, Stacks, and more
- βοΈ Request signatures of messages for authentication or verification
- π Sign & send transactions:
- Bitcoin PSBTs
- Spark BTC & token transfers
- Starknet & Stacks transfers & contract calls
- πΌοΈπ²πͺ Ordinals, Runes & BRC-20:
- Track balances across assets
- Transfer tokens and inscriptions
- Inscribe sats with arbitrary content, create and mint tokens
π οΈ Why Sats Connect?
- Wallet-first β every interaction happens directly in the userβs wallet, with explicit approval
- Bitcoin-native & multi-asset β supports Bitcoin L1 (BTC, Ordinals, Runes, BRC-20) as well as emerging L2s like Spark, Starknet, and Stacks
- Comprehensive toolkit β from simple address retrieval to advanced features like signing PSBTs, transferring Spark tokens, or inscribing Ordinals
- Battle-tested β trusted by leading BitcoinFi apps, with close to 2M downloads and a growing developer ecosystem
π Get started
npm i sats-connect@4.2.xThen request a wallet connection β and explore the docs to unlock the full Bitcoin stack: Bitcoin L1, Spark, Starknet, Stacks, and the assets built on top.
π» Usage
import
import { request } from 'sats-connect';Connect Wallet
const response = await request('getAccounts', {
purposes: [AddressPurpose.Payment, AddressPurpose.Ordinals, AddressPurpose.Stacks],
message: 'Cool app wants to know your addresses!',
});Request a wallet action
await request('sendTransfer', {...});Disconnect Wallet
await Wallet.disconnect();π» Development
Build the package
npm run buildRun example app
npm run dev:exampleπ Documentation
For full documentation, visit docs.xverse.app.
β‘ Power your Bitcoin apps with plug-and-play infra
Sats Connect lets your app connect directly to usersβ wallets.
The Xverse API gives you plug-and-play access to Bitcoin data and infrastructure β Ordinals, Runes, mempool, balances, transactions, collections, and more β without running your own nodes or indexers.
Together, they remove the heavy lifting so you can focus on building the next generation of Bitcoin apps.
π€ Join the community
If youβre building with Sats Connect or Xverse API and need help with integration, join our developer forum to connect with the community and the Xverse team.