` with inline `{ [K in keyof T]: T[K] }` where it improves readability
-- [ ] Consider using `Simplify` from `type-fest` instead of rolling our own
-- [ ] Add type-level tests (`*.test-d.ts`) for all public types
-
-### Stronger Connector Typing
-- [ ] Make connector `getProvider()` return type more specific (not just `unknown`)
-- [ ] Type the `request()` method with a discriminated union of method names and params
-- [ ] Explore using branded types for addresses (Bitcoin address vs Lightning address)
-
-## 5. Dependency Modernization
-
-### Current Dependencies to Watch
-| Package | Current | Notes |
-|---------|---------|-------|
-| `eventemitter3` | 5.0.1 | Consider `mitt` (200B) or native EventTarget |
-| `zustand` | 5.0.0 | Keep updated, evaluate at Phase 2 |
-| `use-sync-external-store` | 1.4.0 | May be removable with React 19's `useSyncExternalStore` built-in |
-| `@tanstack/react-query` | ^5.x | Keep updated |
-
-### Planned Changes
-- [ ] Replace `eventemitter3` with `mitt` (saves ~3KB, simpler API)
-- [ ] Drop `use-sync-external-store` shim once we require React 19+
-- [ ] Evaluate `valibot` (used by sats-connect) as our validation library
-- [ ] Add `type-fest` for common utility types
-
-## 6. Code Quality & Tooling
-
-### Linting/Formatting
-- [ ] Ensure Biome covers all files (currently configured)
-- [ ] Add `biome check` to pre-commit hook
-- [ ] Consider enabling `noBarrelFile` globally (we currently suppress it for entrypoints)
-
-### CI/CD Pipeline
-- [ ] GitHub Actions workflow: lint, type-check, test, build
-- [ ] Automated npm publishing via changesets
-- [ ] Bundle size tracking (size-limit)
-- [ ] Renovate/Dependabot for dependency updates
-
-### Documentation
-- [ ] JSDoc comments on all public APIs
-- [ ] Auto-generated API docs (TypeDoc or similar)
-- [ ] VitePress documentation site (like wagmi.sh)
-
-## 7. Architecture Divergences from WAGMI
-
-Things we intentionally do differently:
-
-### No Chain Abstraction
-WAGMI's `chains` array and chain switching is designed for multi-chain EVM. We use a single
-`network` (mainnet/testnet) since Spark is one network. This simplifies:
-- Config creation (no transport mapping per chain)
-- Connection state (no chainId tracking)
-- No `switchChain` action needed
-
-### No ABI/Contract System
-WAGMI has extensive ABI encoding, contract read/write, and multicall support. We don't need
-any of this since Spark doesn't use smart contracts in the EVM sense.
-
-### Payment-First Actions
-Instead of `sendTransaction` with hex data, we have:
-- `sendPayment` - Lightning/Spark payments
-- `createInvoice` - Generate payment requests
-- `waitForPayment` - Subscribe to incoming payments
-
-These are higher-level abstractions matching how Bitcoin/Lightning apps actually work.
-
-### Simpler Connector Interface
-Our connectors don't need:
-- `switchChain` - Single network
-- `getChainId` - No chains
-- `rdns` / EIP-6963 - Bitcoin wallets don't use this standard (yet)
-- `getClient` - No viem client concept
-
-This makes writing new connectors significantly simpler than WAGMI connectors.
diff --git a/plans/readme-and-examples.md b/plans/readme-and-examples.md
deleted file mode 100644
index 58483e6..0000000
--- a/plans/readme-and-examples.md
+++ /dev/null
@@ -1,193 +0,0 @@
-# README & Usage Examples Plan
-
-## README.md Structure
-
-### Header
-- Project name + tagline: "MBGA - React Hooks for Spark"
-- Badges: npm version, CI status, codecov, license
-- One-sentence description: "Type-safe React hooks and vanilla JS actions for connecting to Spark wallets"
-
-### Quick Start
-```tsx
-import { createConfig, MbgaProvider, sparkMainnet } from 'mbga'
-import { satsConnect } from 'mbga/connectors'
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
-
-const config = createConfig({
- network: sparkMainnet,
- connectors: [satsConnect()],
-})
-
-const queryClient = new QueryClient()
-
-function App() {
- return (
-
-
-
-
-
- )
-}
-
-function WalletConnect() {
- const { connect, connectors } = useConnect()
- const { disconnect } = useDisconnect()
- const { isConnected, accounts } = useConnection()
-
- if (isConnected) {
- return (
-
-
Connected: {accounts[0]}
-
-
- {connectors.map((connector) => (
-
- ))}
-
- )
-}
-```
-
-### Installation
-```bash
-pnpm add mbga @tanstack/react-query
-# or
-npm install mbga @tanstack/react-query
-```
-
-### Sections to include
-1. **Features** - Bullet list: type-safe, SSR-ready, multiple connectors, React hooks, vanilla JS core
-2. **Packages** - Table of `@mbga/core`, `@mbga/connectors`, `mbga` with descriptions
-3. **Configuration** - `createConfig` options (network, connectors, storage, ssr)
-4. **Hooks reference** - Brief table of all hooks with one-line descriptions
-5. **Core actions** - Brief table of vanilla JS actions for non-React usage
-6. **Connectors** - List of available connectors and how to use each
-7. **TypeScript** - Note on type inference, `Register` interface for augmentation
-8. **Contributing** - Link to CONTRIBUTING.md (future)
-9. **License** - MIT
-
-## Usage Examples
-
-### Example 1: Basic Connect/Disconnect (`examples/basic/`)
-Minimal Vite + React app showing connect and disconnect flow.
-
-### Example 2: Display Balance (`examples/balance/`)
-```tsx
-function Balance() {
- const { data, isLoading, error } = useBalance()
-
- if (isLoading) return Loading balance...
- if (error) return Error: {error.message}
- if (!data) return null
-
- return Balance: {data.formatted} {data.symbol}
-}
-```
-
-### Example 3: Send Payment (`examples/send-payment/`)
-```tsx
-function SendPayment() {
- const { sendPayment, isPending, isSuccess, error } = useSendPayment()
-
- const handleSend = () => {
- sendPayment({
- to: 'sp1recipient...',
- amount: 1000n, // 1000 sats
- })
- }
-
- return (
-
-
- {isSuccess &&
Payment sent!
}
- {error &&
Error: {error.message}
}
-
-
- {data &&
Signature: {data.signature}
}
-
Build Bitcoin apps with lightweight, composable, and type-safe modules that interface with Spark
Get started
- GitHub
+ GitHub
@@ -131,9 +131,9 @@ mbga supports all these features out-of-the-box:
Check out the following places for more mbga-related content:
-- Join the [discussions on GitHub](https://github.com/quantumlyy/mbga/discussions)
-- Check out the [example apps](https://github.com/quantumlyy/mbga/tree/main/examples)
-- Read the [contributing guide](https://github.com/quantumlyy/mbga/blob/main/.github/CONTRIBUTING.md)
+- Join the [discussions on GitHub](https://github.com/refrakts/mbga/discussions)
+- Check out the [example apps](https://github.com/refrakts/mbga/tree/main/examples)
+- Read the [contributing guide](https://github.com/refrakts/mbga/blob/main/.github/CONTRIBUTING.md)
diff --git a/site/vocs.config.ts b/site/vocs.config.ts
index c0ce67c..7aecd70 100644
--- a/site/vocs.config.ts
+++ b/site/vocs.config.ts
@@ -11,12 +11,12 @@ export default defineConfig({
titleTemplate: '%s – MBGA',
accentColor: 'light-dark(#f7931a, #ffc517)',
editLink: {
- link: 'https://github.com/quantumlyy/mbga/edit/main/site/pages/:path',
+ link: 'https://github.com/refrakts/mbga/edit/main/site/pages/:path',
text: 'Suggest changes to this page',
},
mcp: {
enabled: true,
- sources: [McpSource.github({ name: 'mbga', repo: 'quantumlyy/mbga' })],
+ sources: [McpSource.github({ name: 'mbga', repo: 'refrakts/mbga' })],
},
topNav: [
{
@@ -31,11 +31,11 @@ export default defineConfig({
items: [
{
text: 'Changelog',
- link: 'https://github.com/quantumlyy/mbga/blob/main/CHANGELOG.md',
+ link: 'https://github.com/refrakts/mbga/blob/main/CHANGELOG.md',
},
{
text: 'Contributing',
- link: 'https://github.com/quantumlyy/mbga/blob/main/.github/CONTRIBUTING.md',
+ link: 'https://github.com/refrakts/mbga/blob/main/.github/CONTRIBUTING.md',
},
],
},
@@ -50,5 +50,5 @@ export default defineConfig({
'/examples': sidebar,
'/acknowledgments': sidebar,
},
- socials: [{ icon: 'github', link: 'https://github.com/quantumlyy/mbga' }],
+ socials: [{ icon: 'github', link: 'https://github.com/refrakts/mbga' }],
})