@tomo-inc/wallet-connect-protocol 0.0.8 → 0.0.9

package/MIGRATION.md

@@ -0,0 +1,101 @@
+# Migration Guide: Pure JavaScript Version
+
+## 📝 Overview
+
+`@tomo-inc/wallet-connect-protocol` has been refactored to be a **pure JavaScript / framework-agnostic** SDK. All React-specific code has been removed.
+
+## 🔄 What Changed
+
+### Removed
+
+- ❌ React Context Provider (`WalletConnectProvider`)
+- ❌ React Hooks (`useWalletConnect`, `useConnect`, `useQRCode`, `useSession`, `useSiwe`)
+- ❌ React dependencies (`react`, `react-dom`)
+- ❌ `/vanilla` export path
+
+### Kept
+
+- ✅ Core `WalletConnectClient` class
+- ✅ All utility functions
+- ✅ Multi-chain support
+- ✅ SIWE authentication
+- ✅ Wallet discovery API
+- ✅ TypeScript types
+
+## 📦 Import Changes
+
+### Before (v0.0.7 and earlier)
+
+```typescript
+// React version (OLD)
+import {
+  WalletConnectProvider,
+  useWalletConnect,
+} from "@tomo-inc/wallet-connect-protocol";
+
+// Vanilla JS version (OLD)
+import { WalletConnectClient } from "@tomo-inc/wallet-connect-protocol/vanilla";
+```
+
+### After (v0.0.8+)
+
+```typescript
+// Pure JavaScript (NEW - works everywhere)
+import { WalletConnectClient } from "@tomo-inc/wallet-connect-protocol";
+```
+
+## 🚀 Migration Steps
+
+### If you were using React hooks
+
+**Option 1: Use the core client directly**
+
+```typescript
+// Before
+const { connect, uri, generateQRCode } = useWalletConnect();
+
+// After
+const [client] = useState(() => new WalletConnectClient(config));
+const [uri, setUri] = useState<string | null>(null);
+
+useEffect(() => {
+  client.initialize();
+}, []);
+
+const handleConnect = async () => {
+  const connectionUri = await client.connect();
+  setUri(connectionUri);
+  const qr = await client.generateQRCode(connectionUri);
+  // Use qr...
+};
+```
+
+**Option 2: Build your own React wrapper**
+
+Create your own hooks based on the core client (see examples in README).
+
+### If you were using `/vanilla` export
+
+```typescript
+// Before
+import { WalletConnectClient } from "@tomo-inc/wallet-connect-protocol/vanilla";
+
+// After (just remove /vanilla)
+import { WalletConnectClient } from "@tomo-inc/wallet-connect-protocol";
+```
+
+## 💡 Benefits
+
+1. **Smaller bundle size** - No React dependencies
+2. **Framework agnostic** - Works with any framework
+3. **Simpler API** - One consistent API for all use cases
+4. **Better tree-shaking** - Only import what you need
+
+## 📚 Resources
+
+- [README.md](./README.md) - Complete usage guide with examples for all frameworks
+- [Examples](./README.md#-usage-examples) - Vanilla JS, Vue, Angular, Svelte, React examples
+
+## 🤝 Support
+
+If you need help migrating, please [open an issue](https://github.com/tomo-inc/tomo-wallet/issues).