sats-connect 4.2.0-3ebfcf9 → 4.2.0-48ba1e2

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.
Files changed (2) hide show
  1. package/README.md +21 -28
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,71 +2,64 @@
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
- Sats connect is a simple javascript library that connects apps to Bitcoin wallets like Xverse to retrieve user wallet addresses and sign transactions (PSBTs).
5
+ [**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/). 
6
6
 
7
- Developers building apps on the Bitcoin ecosystem can use Sats connect to interact with users' wallets:
7
+ 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.
8
8
 
9
- 1. Retrieve users' wallet address(es)
9
+ Developers building on Bitcoin and its L2s can use Sats Connect to interact directly with users’ wallets:
10
10
 
11
- 2. Request the signature of arbitrary messages for authentication purposes
12
-
13
- 3. Request the signature of partially signed Bitcoin transactions (PSBT)
14
-
15
- 4. Request BTC or Stacks transfers to one or multiple recipients
16
-
17
- 5. Request Stacks contract interactions and deployments
18
-
19
- 6. Inscribe sats with arbitrary content for ordinals & BRC-20 use cases
11
+ * 🔑 **Retrieve wallet addresses** for Bitcoin, Spark, Starknet, Stacks, and more
12
+ * ✍️ **Request signatures** of messages for authentication or verification
13
+ * 🔗 **Sign & send transactions**:
14
+ * Bitcoin PSBTs
15
+ * Spark BTC & token transfers
16
+ * Starknet & Stacks transfers & contract calls
17
+ * 🖼️🔲🪙 **Ordinals, Runes & BRC-20**:
18
+ * Track balances across assets
19
+ * Transfer tokens and inscriptions
20
+ * Inscribe sats with arbitrary content, create and mint tokens
20
21
 
21
22
  ## Quick start
22
-
23
23
  ```bash
24
24
  npm i sats-connect
25
25
  ```
26
+ 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
27
 
27
28
  ## Usage
28
-
29
29
  ### import
30
-
31
30
  ```ts
32
31
  import { request } from 'sats-connect';
33
32
  ```
34
-
35
33
  ### Connect Wallet
36
-
37
34
  ```ts
38
35
  const response = await request('getAccounts', {
39
36
  purposes: [AddressPurpose.Payment, AddressPurpose.Ordinals, AddressPurpose.Stacks],
40
37
  message: 'Cool app wants to know your addresses!',
41
38
  });
42
39
  ```
43
-
44
40
  ### Request a wallet action
45
-
46
41
  ```ts
47
42
  await request('sendTransfer', {...});
48
43
  ```
49
44
 
50
45
  ### Disconnect Wallet
51
-
52
46
  ```ts
53
47
  await Wallet.disconnect();
54
48
  ```
55
49
 
56
- ## Documentation
57
-
58
- For full documentation, visit [docs.xverse.app](https://docs.xverse.app/sats-connect/).
59
-
60
50
  ## Development
61
-
62
51
  ### Build the package
63
-
64
52
  ```bash
65
53
  npm run build
66
54
  ```
67
-
68
55
  ### Run example app
69
-
70
56
  ```bash
71
57
  npm run dev:example
72
58
  ```
59
+
60
+ ## Power your Bitcoin apps with plug-and-play infra
61
+
62
+ Sats Connect lets your app connect directly to users’ wallets.\
63
+ 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.
64
+
65
+ Together, they remove the heavy lifting so you can focus on building the next generation of Bitcoin apps.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sats-connect",
3
- "version": "4.2.0-3ebfcf9",
3
+ "version": "4.2.0-48ba1e2",
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.11.0-44ab88e",
27
+ "@sats-connect/core": "0.10.0",
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"