Skip to content

docs: add wallet support matrix (#43) #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
satoshai-dev merged 2 commits into from
Mar 5, 2026
Merged

docs: add wallet support matrix (#43) #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e21ddaa
docs: add wallet support matrix to README (#43)
satoshai-dev Mar 5, 2026
eccb36b
docs: wallet support matrix with per-wallet research (#43)
satoshai-dev Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wallet-support-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@satoshai/kit": patch
---

Add wallet support matrix to README documenting which RPC methods each wallet supports
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,29 @@ All 6 wallets work with both headless (`connect('xverse')`) and modal (`connect(
| WalletConnect | `wallet-connect` |
| OKX | `okx` |

### Wallet Support Matrix

| Hook | Xverse | Leather | Asigna | Fordefi | WalletConnect | OKX |
|------|--------|---------|--------|---------|---------------|-----|
| `useConnect` | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| `useSignMessage` | ✓ | ✓ | ? | ? | ~ | ✓ |
| `useSignStructuredMessage` | ✓ | ✓ | ? | ? | ~ | ✗ |
| `useSignTransaction` | ✓ | ✓ | ? | ? | ~ | ✗ |
| `useWriteContract` | ✓ | ✓ | ✓ | ✓ | ~ | ✓ |
| `useTransferSTX` | ✓ | ✓ | ✓ | ✓ | ~ | ✓ |

✓ Confirmed supported | ✗ Unsupported (throws error) | ? Unverified | ~ Depends on the connected wallet

**Notes:**

- **OKX** uses a proprietary API (`window.okxwallet.stacks`) instead of the standard `@stacks/connect` RPC. `useSignStructuredMessage` and `useSignTransaction` are explicitly unsupported and will throw.
- **Asigna** is a multisig wallet. Transaction-based hooks (`useWriteContract`, `useTransferSTX`) work, but message signing hooks may be limited since there is no multisig message signature standard on Stacks.
- **Fordefi** supports transactions and contract calls on Stacks, but their [supported blockchains](https://docs.fordefi.com/docs/supported-blockchains) page does not list Stacks under message signing capabilities.
- **WalletConnect** is a relay protocol — all methods are forwarded, but actual support depends on the wallet on the other end.
- **Xverse** and **Leather** implement the full [SIP-030](https://github.com/janniks/sips/blob/main/sips/sip-030/sip-030-wallet-interface.md) interface.

This matrix was compiled from wallet documentation as of March 2026. Sources: [Xverse Sats Connect docs](https://docs.xverse.app/sats-connect/stacks-methods), [Leather developer docs](https://leather.gitbook.io/developers), [Asigna docs](https://asigna.gitbook.io/asigna), [Fordefi docs](https://docs.fordefi.com/docs/supported-blockchains), [@stacks/connect WalletConnect source](https://github.com/stx-labs/connect/tree/main/packages/connect/src/walletconnect).

## Peer Dependencies

- `react` ^18 or ^19
Expand Down