# sats-connect

> ![logo](/example/public/sats-connect.svg)

Latest version **4.2.1** (published 2025-10-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install sats-connect
pnpm add sats-connect
yarn add sats-connect
bun add sats-connect
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 4.2.1 |
| Published | 2025-10-28 |
| First published | 2023-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 10.1 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 144 |
| Author | Secret Key Labs |
| Maintainers | yknl |

## Links

- npm: https://www.npmjs.com/package/sats-connect
- Repository: https://github.com/secretkeylabs/sats-connect
- Homepage: https://github.com/secretkeylabs/sats-connect#readme
- Issues: https://github.com/secretkeylabs/sats-connect/issues
- npm.io page: https://npm.io/package/sats-connect

## Dependencies (4)

- [valibot](https://npm.io/package/valibot.md) 1.1.0
- [@sats-connect/ui](https://npm.io/package/@sats-connect/ui.md) 0.0.7
- [@sats-connect/core](https://npm.io/package/@sats-connect/core.md) 0.10.0
- [@sats-connect/make-default-provider-config](https://npm.io/package/@sats-connect/make-default-provider-config.md) 0.0.10

## Recent versions

- 4.2.1 (latest) — 2025-10-28
- 4.3.0-a55c116 (pr) — 2026-09-25
- 3.6.1 (prerelease) — 2025-07-26
- 4.3.0-1764f8f — 2026-09-23
- 4.3.0-2b92219 — 2026-09-23
- 4.3.0-890747b — 2026-09-22
- 4.3.0-b449ffd — 2026-09-21
- 4.3.0-dbdf506 — 2026-09-17
- 4.3.0-c6b8987 — 2026-09-14
- 4.3.0-277c74c — 2026-09-14
- 4.3.0-3dd716c — 2026-09-14
- 4.3.0-af1cc87 — 2026-09-14
- 4.2.1-61152bc — 2026-09-10
- 4.2.1-a89aff0 — 2026-09-10
- 4.2.1-2ed9f15 — 2026-06-23
- … 448 more at https://npm.io/package/sats-connect/versions

## README

![logo](/example/public/sats-connect.svg)

**[API Docs](https://docs.xverse.app/sats-connect) • [Example App](https://sats-connect.netlify.app/) • [Discord](https://discord.gg/tN84HhSDrz) • [Xverse](https://www.xverse.app/)**

# 👋 Introduction

[**Sats Connect**](https://github.com/secretkeylabs/sats-connect) is a simple javascript library that connects apps to **Bitcoin**, **Spark**, **Starknet**, **Stacks**, and other **Bitcoin Layer 2 wallets** like [**Xverse**](https://www.xverse.app/). 

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
```bash
npm i sats-connect@4.2.x
```
Then request a [wallet connection ](https://docs.xverse.app/sats-connect/connecting-to-the-wallet/connect-to-xverse-wallet)— and explore the docs to unlock the full Bitcoin stack: Bitcoin L1, Spark, Starknet, Stacks, and the assets built on top.

## 💻 Usage
### import
```ts
import { request } from 'sats-connect';
```
### Connect Wallet
```ts
const response = await request('getAccounts', {
  purposes: [AddressPurpose.Payment, AddressPurpose.Ordinals, AddressPurpose.Stacks],
  message: 'Cool app wants to know your addresses!',
});
```
### Request a wallet action
```ts
await request('sendTransfer', {...});
```

### Disconnect Wallet
```ts
await Wallet.disconnect();
```

## 💻 Development
### Build the package
```bash
npm run build
```
### Run example app
```bash
npm run dev:example
```

## 📚 Documentation
For full documentation, visit [docs.xverse.app](https://docs.xverse.app/sats-connect/).

## ⚡ Power your Bitcoin apps with plug-and-play infra
Sats Connect lets your app connect directly to users’ wallets.\
The [Xverse API](https://docs.xverse.app/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](https://discord.gg/tN84HhSDrz) to connect with the community and the Xverse team. 

---
_Source: https://npm.io/package/sats-connect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._