Quick Start

🚀 Attention Developers: Upgrade to the New Sats Connect! 🚀

A new version of Sats Connect has launched, now supporting Bitcoin & Stacks! While the legacy version documented here remains supported, we urge you to upgrade for access to the latest features and improvements.

Why Upgrade?

  • Access Bitcoin & Stacks through a single wallet API

  • Enjoy improved API methods

  • Further features coming soon to support the Bitcoin App & Layer 2 ecosystems

Upgrade Now -> Visit our new documentation portal for easy upgrade instructions!

Sats Connect is a simple javascript library that connects apps to Bitcoin wallets like Xverse to retrieve user wallet addresses and request the signing of transactions (PSBTs).

In this quick start guide, we'll go over the basic steps to:

  1. Retrieve the user's wallet address(es)

  2. Request signing of a partially signed Bitcoin transaction.

  3. Request Signing of an arbitrary message

  4. Request a BTC transaction to one or multiple recipients

  5. Inscribe sats with arbitrary content

To get started, import sats-connect into your project.

npm install sats-connect

Last updated