sats-connect 4.2.1 → 4.3.0-2b92219

package/README.md

@@ -12,70 +12,101 @@ It’s already powering apps across the BitcoinFi ecosystem, with close to **2 m
 
 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
+- 🔑 **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
+- **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();
 ```
 
+### Build a PSBT input from address metadata
+
+Wallets can return the scripts needed to construct an input. Decode them before passing the input to `@scure/btc-signer`:
+
+```ts
+const decoded = decodeAddressPsbtData(address);
+
+tx.addInput({
+  txid,
+  index,
+  witnessUtxo: { script: decoded.scriptPubKey, amount },
+  ...decoded.unlockDefinition,
+});
+```
+
 ## 💻 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. 

package/dist/index.d.mts

@@ -1,6 +1,25 @@
-import { SupportedWallet, Requests, Params, RpcResult, AddListener } from '@sats-connect/core';
+import { Address, SupportedWallet, Method, RpcRequestParams, RequestReturn, AddListener } from '@sats-connect/core';
 export * from '@sats-connect/core';
 import { Config } from '@sats-connect/ui';
+import { TaprootControlBlock } from '@scure/btc-signer';
+
+type TaprootControlBlockValue = ReturnType<typeof TaprootControlBlock.decode>;
+type DecodedAddressPsbtData = {
+    scriptPubKey: Uint8Array;
+    unlockDefinition: Record<string, never> | {
+        redeemScript: Uint8Array;
+    } | {
+        tapInternalKey: Uint8Array;
+    } | {
+        witnessScript: Uint8Array;
+    } | {
+        tapLeafScript: Array<[TaprootControlBlockValue, Uint8Array]>;
+    };
+};
+declare class DecodeAddressPsbtDataError extends Error {
+    readonly name = "DecodeAddressPsbtDataError";
+}
+declare const decodeAddressPsbtData: (address: Pick<Address, "scriptPubKey" | "unlockDefinition">) => DecodedAddressPsbtData;
 
 declare class Wallet {
     private providerId;
@@ -10,10 +29,10 @@ declare class Wallet {
     setCreateCustomConfig(createCustomConfig: (providers: SupportedWallet[]) => Config): void;
     selectProvider(): Promise<void>;
     disconnect(): Promise<void>;
-    request<Method extends keyof Requests>(method: Method, params: Params<Method>): Promise<RpcResult<Method>>;
+    request<M extends Method>(method: M, params: RpcRequestParams<M>): Promise<RequestReturn<M>>;
     addListener: AddListener;
 }
 
 declare const _default: Wallet;
 
-export { _default as default };
+export { DecodeAddressPsbtDataError, type DecodedAddressPsbtData, decodeAddressPsbtData, _default as default };

package/dist/index.mjs

@@ -17,6 +17,113 @@ import {
   walletOpen
 } from "@sats-connect/ui";
 export * from "@sats-connect/core";
+
+// src/decodeAddressPsbtData.ts
+import { hex } from "@scure/base";
+import { TaprootControlBlock } from "@scure/btc-signer";
+var DecodeAddressPsbtDataError = class extends Error {
+  name = "DecodeAddressPsbtDataError";
+};
+var malformed = (field, cause) => new DecodeAddressPsbtDataError(`${field} is malformed`, { cause });
+var decodeHex = (value, field) => {
+  if (typeof value !== "string" || !/^(?:[0-9a-f]{2})+$/.test(value)) {
+    throw malformed(field);
+  }
+  try {
+    return hex.decode(value);
+  } catch (error) {
+    throw malformed(field, error);
+  }
+};
+var parseUnlockDefinition = (value) => {
+  if (!value || typeof value !== "object" || !("type" in value)) {
+    throw malformed("unlockDefinition");
+  }
+  const definition = value;
+  switch (definition.type) {
+    case "p2wpkh":
+      return { type: "p2wpkh" };
+    case "p2sh-p2wpkh":
+      decodeHex(definition.redeemScript, "redeemScript");
+      return definition;
+    case "p2tr-key-path":
+      if (decodeHex(definition.tapInternalKey, "tapInternalKey").length !== 32) {
+        throw malformed("tapInternalKey");
+      }
+      return definition;
+    case "p2wsh":
+      decodeHex(definition.witnessScript, "witnessScript");
+      return definition;
+    case "p2tr-script-path": {
+      if (!Array.isArray(definition.tapLeafScript) || definition.tapLeafScript.length === 0) {
+        throw malformed("tapLeafScript");
+      }
+      for (const leaf of definition.tapLeafScript) {
+        if (!leaf || typeof leaf !== "object") throw malformed("tapLeafScript");
+        const { controlBlock, script } = leaf;
+        const controlBlockBytes = decodeHex(controlBlock, "controlBlock");
+        const scriptBytes = decodeHex(script, "script");
+        if (controlBlockBytes.length < 33 || controlBlockBytes.length > 33 + 32 * 128 || (controlBlockBytes.length - 33) % 32 !== 0) {
+          throw malformed("controlBlock");
+        }
+        if (scriptBytes.at(-1) !== (controlBlockBytes[0] & 254)) {
+          throw malformed("tapLeafScript");
+        }
+      }
+      return definition;
+    }
+    default:
+      throw malformed("unlockDefinition");
+  }
+};
+var decodeAddressPsbtData = (address) => {
+  if (!address || typeof address !== "object") throw malformed("address");
+  if (address.scriptPubKey === void 0 || address.unlockDefinition === void 0) {
+    throw new DecodeAddressPsbtDataError("scriptPubKey and unlockDefinition are required");
+  }
+  const scriptPubKey = decodeHex(address.scriptPubKey, "scriptPubKey");
+  const definition = parseUnlockDefinition(address.unlockDefinition);
+  switch (definition.type) {
+    case "p2wpkh":
+      return { scriptPubKey, unlockDefinition: {} };
+    case "p2sh-p2wpkh":
+      return {
+        scriptPubKey,
+        unlockDefinition: { redeemScript: decodeHex(definition.redeemScript, "redeemScript") }
+      };
+    case "p2tr-key-path":
+      return {
+        scriptPubKey,
+        unlockDefinition: {
+          tapInternalKey: decodeHex(definition.tapInternalKey, "tapInternalKey")
+        }
+      };
+    case "p2wsh":
+      return {
+        scriptPubKey,
+        unlockDefinition: {
+          witnessScript: decodeHex(definition.witnessScript, "witnessScript")
+        }
+      };
+    case "p2tr-script-path":
+      try {
+        return {
+          scriptPubKey,
+          unlockDefinition: {
+            tapLeafScript: definition.tapLeafScript.map(({ controlBlock, script }) => [
+              TaprootControlBlock.decode(decodeHex(controlBlock, "controlBlock")),
+              decodeHex(script, "script")
+            ])
+          }
+        };
+      } catch (error) {
+        if (error instanceof DecodeAddressPsbtDataError) throw error;
+        throw malformed("controlBlock", error);
+      }
+  }
+};
+
+// src/index.ts
 var Wallet = class {
   providerId;
   defaultAdapters = defaultAdapters;
@@ -117,5 +224,7 @@ var Wallet = class {
 };
 var index_default = new Wallet();
 export {
+  DecodeAddressPsbtDataError,
+  decodeAddressPsbtData,
   index_default as default
 };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "sats-connect",
-  "version": "4.2.1",
+  "version": "4.3.0-2b92219",
   "main": "dist/index.mjs",
   "files": [
     "dist"
   ],
   "scripts": {
-    "test": "jest",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "build": "npm run clean && tsup src/index.ts --format esm --dts",
     "build:watch": "npm run clean && tsup src/index.ts --format esm --dts --watch",
     "dev:build": "tsup src/index.ts --format esm --dts --watch",
@@ -24,13 +24,17 @@
     ]
   },
   "dependencies": {
-    "@sats-connect/core": "0.10.0",
+    "@sats-connect/core": "0.18.2-263ae91",
     "@sats-connect/make-default-provider-config": "0.0.10",
     "@sats-connect/ui": "0.0.7",
-    "valibot": "1.1.0"
+    "@scure/base": "2.4.0",
+    "@scure/btc-signer": "2.4.1",
+    "valibot": "1.2.0"
   },
   "devDependencies": {
+    "@types/jest": "29.5.14",
     "husky": "9.1.7",
+    "jest": "29.7.0",
     "lint-staged": "16.1.5",
     "prettier": "3.6.2",
     "prettier-plugin-organize-imports": "4.2.0",