Builds on the previous commit, which correctly identified the race and the shape
of the answer. Three things needed to change before it could ship, and the reason
each matters is easy to miss.
DEFER THE TEARDOWN, NOT THE REGISTRY
The previous commit moved everything into clean(), including
this.connections.delete() and the connectionsChanged emit. That leaves the
connection in the map until the publish settles, so after disconnect() returns:
- getConnections() still lists a connection the user just disconnected;
- connect() matches by URI at the top of the function, so reconnecting to the
same URI hands back the dying connection — which clean() then deletes,
leaving the caller holding an id for something already gone.
Registry removal is now synchronous and only conn.cleanup() — the transport
teardown, the part that was killing the in-flight publish — is deferred.
BOUND THE WAIT
There was no timeout: if relay() never settles, clean() never runs and the
interval, the socket and the map entry leak permanently. That is not a corner
case. relay() enqueues rather than publishes when the client is not ready, so
disconnecting while the relay is unreachable — precisely when a user reaches for
disconnect — can hang forever. DISCONNECT_PUBLISH_TIMEOUT_MS bounds it: an
undelivered courtesy message is a smaller problem than a socket that never
closes.
RESTORE THE TYPES
doDisconnect had lost its parameter annotations and its `private` modifier, and
the message literal its DisconnectMessage type. Under "strict": true that is
TS7006 on both parameters — the package does not compile — and dropping `private`
widened the public API by accident. Formatting is back to the repo's prettier
config.
TESTS
None of the above is visible from the wallet's side: its own state is correct
either way and only the peer notices, which is how the original bug shipped.
disconnect.test.ts only ever covered dapp -> wallet.
disconnect-delivery.test.ts covers wallet -> dapp over a live relay. Verified by
reverting the fix: the two delivery tests time out after 20s, and the two
invariant tests — immediate registry removal, and reconnecting on the same URI —
pass either way, which is precisely why they are there.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
||
|---|---|---|
| contrib | ||
| docs | ||
| linters | ||
| packages | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| CLAUDE.md | ||
| eslint.config.cjs | ||
| LICENSE.txt | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.base.json | ||
| zensical.toml | ||
WizardConnect
A dapp-to-wallet protocol built for Bitcoin Cash.
WizardConnect lets a dapp scan a wallet's QR code and immediately start deriving addresses, constructing transactions, and requesting signatures — no seed phrases, no trusted servers, no round trips.
Why not WalletConnect?
WalletConnect was built for Ethereum, where a wallet is a single address. BCH wallets are HD wallets with thousands of addresses for privacy. Forcing an Ethereum protocol onto BCH means:
- One address per session. WalletConnect gives the dapp a single address. That breaks the HD wallet model and destroys the privacy that multiple addresses provide.
- Unreliable on BCH. BCH support in WalletConnect is a second-class citizen — a bridge on top of an Ethereum-native protocol. Connections drop, sessions fail to restore, and there's no community maintaining it for BCH.
WizardConnect replaces all of this with a protocol designed from the ground up for UTXO chains and HD wallets.
How it works
Wallet Relay Dapp
│ │ │
│ ◄───── QR code scan ────── │ ◄──── shows QR (wiz://...) │
│ │ │
│ wallet_ready ──────────────►│──────────────────────────────►│
│ (xpubs + key exchange) │ │
│ │ derive addresses │
│ │ locally from xpubs │
│ │ (no more round trips)│
│ │ │
│ ◄──────────────────────────│◄──── sign_transaction_request │
│ user approves on wallet │ │
│ sign_transaction_response──►│──────────────────────────────►│
│ │ broadcast │
- The dapp generates a
wiz://URI and displays it as a QR code. - The wallet scans the QR, connects to the relay, and sends its xpubs.
- The dapp derives all addresses locally — no further contact with the wallet needed for address generation.
- When the dapp needs a signature, it sends a request. The user approves on the wallet. The signed transaction comes back.
All communication is end-to-end encrypted via Nostr NIP-17 gift wrap. The relay sees only ciphertext.
Key features
Full HD wallet support. The wallet shares BIP32 xpubs for specific derivation paths (receive, change, DeFi). The dapp derives unlimited addresses locally. No more single-address sessions.
Zero round trips for addresses. After the initial handshake, the dapp never needs to ask the wallet for a public key. It derives them on demand from the xpubs, in microseconds.
Decentralized transport. Built on Nostr — an open protocol with hundreds of public relays. No proprietary bridge server. Users can point to any relay for additional privacy or self-host their own.
Reconnection-proof. Both sides can disconnect and reconnect independently (app switch, browser refresh, network drop) and converge back to a live session without user action.
Extensible. The protocol negotiates capabilities during the handshake.
hdwalletv1 is the first protocol; future protocols (multisig, post-quantum,
token-aware) can be added without breaking existing connections.
Open source (LGPL-3.0). Free to use in commercial and non-commercial applications. Modifications to the library itself must be shared back.
Packages
npm install @wizardconnect/core # transport, protocol types, key exchange
npm install @wizardconnect/dapp # dapp-side session + address derivation
npm install @wizardconnect/wallet # wallet-side connection + signing
| Package | Description |
|---|---|
@wizardconnect/core |
Relay client, NIP-17 encryption, URI encoding, protocol message types |
@wizardconnect/dapp |
DappConnectionManager, DappPubkeyStateManager — session management and on-demand pubkey derivation |
@wizardconnect/wallet |
WalletConnectionManager, WalletAdapter interface — multi-connection management and sign request dispatch |
Quick start: dapp
import { initiateDappRelay } from "@wizardconnect/core";
import { DappConnectionManager } from "@wizardconnect/dapp";
const dapp = new DappConnectionManager("My Dapp", "https://example.com/icon.png");
const relay = initiateDappRelay(
(payload) => dapp.updateConnection(payload.client, payload.status),
{ explicitRelayUrls: ["wss://relay.riften.net:443"] },
);
// Display relay.uri as a QR code for the wallet to scan
dapp.on("walletready", () => {
// Connected! Derive addresses locally:
const receivePubkey = dapp.getPubkey(0, 0n); // receive path, index 0
const changePubkey = dapp.getPubkey(1, 0n); // change path, index 0
});
Quick start: wallet
import { WalletConnectionManager } from "@wizardconnect/wallet";
const manager = new WalletConnectionManager(myWalletAdapter);
// When the user scans a dapp's QR code:
const connectionId = manager.connect("wiz://?p=...&s=...");
// When a sign request arrives, show it to the user:
manager.on("pendingSignRequest", async ({ connectionId, request }) => {
const approved = await showApprovalUI(request);
if (approved) {
await manager.sendSignResponse(connectionId, request.sequence, signedTxHex);
} else {
await manager.sendSignError(connectionId, request.sequence, "User rejected");
}
});
See wallet integration guide for WalletAdapter implementation details.
Privacy model
WizardConnect shares xpubs at the chain level, not the account level. A dapp receiving the receive xpub can derive receive addresses but cannot derive change addresses or any other internal wallet activity. This is the same level of key material used by watch-only wallets.
For wallets that want stronger isolation, the protocol supports per-session xpub rotation — the dapp sees only the xpub node, never the derivation path.
See xpub sharing: why it's safe for a full discussion.
Security
- Private keys never leave the wallet. Signing happens on-device.
- All relay traffic is end-to-end encrypted (NIP-17 gift wrap). The relay cannot read messages.
- Key exchange includes an 8-byte shared secret (embedded in the QR code) for MITM prevention.
- No trusted intermediary. The relay is a dumb message broker — compromise it and you get ciphertext.
Documentation
| Topic | Link |
|---|---|
| Protocol messages and handshake | protocol.md |
| Connection URI and key exchange | connection-uri.md |
| Relay transport and encryption | transport.md |
| Wallet integration guide | wallet.md |
| Dapp integration guide | dapp.md |
| xpub delivery and derivation | pubkey-derivation.md |
| xpub sharing: why it's safe | xpub-sharing.md |
Building
npm install
npm run build # builds all packages in dependency order
npm run test # unit tests (fast, no network)
Integration tests hit a live relay:
cd packages/wallet && npm run test:integration
License
LGPL-3.0-or-later. Free for commercial and non-commercial use. Modifications to the library must be released under the same license.
Built by Riften Labs.