sats-connect 4.2.0 → 4.2.1-03ca2b7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -28
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,71 +2,80 @@
|
|
|
2
2
|
|
|
3
3
|
**[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/)**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
# 👋 Introduction
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
[**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/). 
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
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.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
## ✨ What you can do with Sats Connect
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Developers building on Bitcoin and its L2s can use Sats Connect to interact directly with users’ wallets:
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
* 🔑 **Retrieve wallet addresses** for Bitcoin, Spark, Starknet, Stacks, and more
|
|
16
|
+
* ✍️ **Request signatures** of messages for authentication or verification
|
|
17
|
+
* 🔗 **Sign & send transactions**:
|
|
18
|
+
* Bitcoin PSBTs
|
|
19
|
+
* Spark BTC & token transfers
|
|
20
|
+
* Starknet & Stacks transfers & contract calls
|
|
21
|
+
* 🖼️🔲🪙 **Ordinals, Runes & BRC-20**:
|
|
22
|
+
* Track balances across assets
|
|
23
|
+
* Transfer tokens and inscriptions
|
|
24
|
+
* Inscribe sats with arbitrary content, create and mint tokens
|
|
16
25
|
|
|
17
|
-
|
|
26
|
+
## 🛠️ Why Sats Connect?
|
|
18
27
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
28
|
+
* **Wallet-first** – every interaction happens directly in the user’s wallet, with explicit approval
|
|
29
|
+
* **Bitcoin-native & multi-asset** – supports Bitcoin L1 (BTC, Ordinals, Runes, BRC-20) as well as emerging L2s like Spark, Starknet, and Stacks
|
|
30
|
+
* **Comprehensive toolkit** – from simple address retrieval to advanced features like signing PSBTs, transferring Spark tokens, or inscribing Ordinals
|
|
31
|
+
* **Battle-tested** – trusted by leading BitcoinFi apps, with close to **2M downloads** and a growing developer ecosystem
|
|
22
32
|
|
|
33
|
+
## 🚀 Get started
|
|
23
34
|
```bash
|
|
24
|
-
npm i sats-connect
|
|
35
|
+
npm i sats-connect@4.2.x
|
|
25
36
|
```
|
|
37
|
+
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.
|
|
26
38
|
|
|
27
|
-
## Usage
|
|
28
|
-
|
|
39
|
+
## 💻 Usage
|
|
29
40
|
### import
|
|
30
|
-
|
|
31
41
|
```ts
|
|
32
42
|
import { request } from 'sats-connect';
|
|
33
43
|
```
|
|
34
|
-
|
|
35
44
|
### Connect Wallet
|
|
36
|
-
|
|
37
45
|
```ts
|
|
38
46
|
const response = await request('getAccounts', {
|
|
39
47
|
purposes: [AddressPurpose.Payment, AddressPurpose.Ordinals, AddressPurpose.Stacks],
|
|
40
48
|
message: 'Cool app wants to know your addresses!',
|
|
41
49
|
});
|
|
42
50
|
```
|
|
43
|
-
|
|
44
51
|
### Request a wallet action
|
|
45
|
-
|
|
46
52
|
```ts
|
|
47
53
|
await request('sendTransfer', {...});
|
|
48
54
|
```
|
|
49
55
|
|
|
50
56
|
### Disconnect Wallet
|
|
51
|
-
|
|
52
57
|
```ts
|
|
53
58
|
await Wallet.disconnect();
|
|
54
59
|
```
|
|
55
60
|
|
|
56
|
-
##
|
|
57
|
-
|
|
58
|
-
For full documentation, visit [docs.xverse.app](https://docs.xverse.app/sats-connect/).
|
|
59
|
-
|
|
60
|
-
## Development
|
|
61
|
-
|
|
61
|
+
## 💻 Development
|
|
62
62
|
### Build the package
|
|
63
|
-
|
|
64
63
|
```bash
|
|
65
64
|
npm run build
|
|
66
65
|
```
|
|
67
|
-
|
|
68
66
|
### Run example app
|
|
69
|
-
|
|
70
67
|
```bash
|
|
71
68
|
npm run dev:example
|
|
72
69
|
```
|
|
70
|
+
|
|
71
|
+
## 📚 Documentation
|
|
72
|
+
For full documentation, visit [docs.xverse.app](https://docs.xverse.app/sats-connect/).
|
|
73
|
+
|
|
74
|
+
## ⚡ Power your Bitcoin apps with plug-and-play infra
|
|
75
|
+
Sats Connect lets your app connect directly to users’ wallets.\
|
|
76
|
+
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.
|
|
77
|
+
|
|
78
|
+
Together, they remove the heavy lifting so you can focus on building the next generation of Bitcoin apps.
|
|
79
|
+
|
|
80
|
+
## 🤝 Join the community
|
|
81
|
+
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. 
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sats-connect",
|
|
3
|
-
"version": "4.2.
|
|
3
|
+
"version": "4.2.1-03ca2b7",
|
|
4
4
|
"main": "dist/index.mjs",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist"
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
]
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@sats-connect/core": "0.
|
|
27
|
+
"@sats-connect/core": "^0.13.1-49d1c59",
|
|
28
28
|
"@sats-connect/make-default-provider-config": "0.0.10",
|
|
29
29
|
"@sats-connect/ui": "0.0.7",
|
|
30
30
|
"valibot": "1.1.0"
|