Sats-connect NPM

logo

Sats connect is a simple javascript library that connects apps to Bitcoin wallets like Xverse to retrieve user wallet addresses and sign transactions (PSBTs).

Developers building apps on the Bitcoin ecosystem can use Sats connect to interact with users' wallets:

Retrieve users' wallet address(es)
Request the signature of arbitrary messages for authentication purposes
Request the signature of partially signed Bitcoin transactions (PSBT)
Request BTC or Stacks transfers to one or multiple recipients
Request Stacks contract interactions and deployments
Inscribe sats with arbitrary content for ordinals & BRC-20 use cases

Quick start

npm i sats-connect

Usage

import

import Wallet from 'sats-connect';

Connect Wallet

const response = await Wallet.request('getAccounts', {
  purposes: [AddressPurpose.Payment, AddressPurpose.Ordinals, AddressPurpose.Stacks],
  message: 'Cool app wants to know your addresses!',
});

Request a wallet action

await Wallet.request('sendTransfer', {...});

Disconnect Wallet

await Wallet.disconnect();

Documentation

For full documentation, visit docs.xverse.app.

Development

Build the package

npm run build

Run example app

npm run dev:example

@sats-connect/make-default-provider-config @sats-connect/ui @sats-connect/core

6 days ago

5 days ago

5 days ago

6 days ago

6 days ago

6 days ago

13 days ago

24 days ago

24 days ago

23 days ago

24 days ago

23 days ago

24 days ago

24 days ago

24 days ago

23 days ago

24 days ago

25 days ago

25 days ago

25 days ago

25 days ago

25 days ago

27 days ago

27 days ago

27 days ago

27 days ago

28 days ago

28 days ago

28 days ago

28 days ago

28 days ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

6 months ago

6 months ago

6 months ago

7 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

8 months ago

9 months ago

9 months ago

9 months ago

10 months ago

9 months ago

9 months ago

10 months ago

8 months ago

9 months ago

9 months ago

10 months ago

8 months ago

8 months ago

8 months ago

9 months ago

9 months ago

10 months ago

8 months ago

9 months ago

10 months ago

9 months ago

9 months ago

10 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

10 months ago

9 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago