|
1 | 1 | --- |
2 | 2 | title: Browser Extension SDK |
3 | | -description: Lightweight SDK for integrating Reclaim verification flows into browser extensions and websites with Chrome Manifest V3 support |
| 3 | +description: Seamlessly integrate Reclaim Protocol verification into your Chrome browser extension |
4 | 4 | --- |
5 | 5 |
|
6 | 6 | ## Overview |
7 | 7 |
|
8 | | -Lightweight SDK for integrating Reclaim verification into browser extensions and websites. Handles content-background communication, provider tab management, WebAssembly proof generation, and completion events. |
| 8 | +Build browser extensions with Reclaim Protocol verification capabilities. This SDK handles Chrome extension architecture (MV3, service workers, offscreen documents), WebAssembly proof generation, and provider tab management. |
9 | 9 |
|
10 | 10 | ### Key Features |
11 | 11 |
|
12 | | -- 🔌 **Dual Integration**: Build extensions or integrate from web apps |
13 | 12 | - 🛡️ **Manifest V3 Compatible**: Full Chrome MV3 support |
14 | 13 | - ⚡ **WebAssembly Proofs**: High-performance cryptographic proof generation |
15 | 14 | - 🔄 **Event-Driven**: Real-time updates via clean event API |
16 | 15 | - 📦 **Pre-built Bundles**: No re-bundling required |
17 | | -- 🎯 **Auto Provider Management**: Automatic tab orchestration |
18 | | -- 🔐 **Network Monitoring**: Built-in request interception |
19 | 16 |
|
20 | 17 | ## Two Integration Paths |
21 | 18 |
|
22 | | -### 1. Extension Integration (Primary) |
| 19 | +### 1. Extension Integration (Standalone) |
23 | 20 |
|
24 | | -**Build a browser extension** with Reclaim verification in popup/sidepanel: |
25 | | -- Users trigger verification from your extension UI |
| 21 | +**Build a standalone browser extension** with Reclaim verification: |
| 22 | + |
| 23 | +- Complete extension that users install from Chrome Web Store |
| 24 | +- Users trigger verification directly from your extension popup/sidepanel |
| 25 | +- No website required - extension works independently |
26 | 26 | - Full control over extension experience |
27 | 27 | - SDK handles all Chrome extension complexity |
28 | | -- Manifest V3, offscreen documents, service workers |
29 | 28 |
|
30 | 29 | [Get Started with Extension Integration →](/browser-extension/extension-integration) |
31 | 30 |
|
32 | | -### 2. Web Integration (Optional) |
33 | | - |
34 | | -**Trigger verification from your website** through a compatible extension: |
35 | | -- For websites that want to use an extension built with this SDK |
36 | | -- Users verify without leaving your site |
37 | | -- Extension handles verification, you control website UI |
38 | | -- Requires users to install compatible extension |
39 | | - |
40 | | -[Learn About Web Integration →](/browser-extension/web-integration) |
41 | | - |
42 | | -## How It Works |
43 | | - |
44 | | -Multi-layer architecture for secure verification: |
45 | | - |
46 | | -1. **Content Script Bridge** - Communication between pages and extension |
47 | | -2. **Background Service Worker** - Manages offscreen docs and provider tabs |
48 | | -3. **Offscreen Document** - WebAssembly proof generation |
49 | | -4. **Network Interceptor** - Captures network requests during verification |
| 31 | +### 2. Web Integration (Website + Extension) |
50 | 32 |
|
51 | | -```mermaid |
52 | | -graph LR |
53 | | - A[Web Page / Extension Popup] --> B[Content Script] |
54 | | - B --> C[Background Service Worker] |
55 | | - C --> D[Offscreen Document] |
56 | | - C --> E[Provider Tab] |
57 | | - D --> F[WebAssembly Proof Generation] |
58 | | - E --> G[Network Interceptor] |
59 | | -``` |
| 33 | +**Trigger verification from your website** using a compatible extension: |
60 | 34 |
|
61 | | -## Compatibility |
| 35 | +- Requires BOTH: your website + a compatible extension installed by users |
| 36 | +- Users verify directly on your website without leaving the page |
| 37 | +- Extension (built with this SDK) handles verification in background |
| 38 | +- Website maintains control over UI/UX |
| 39 | +- Users must install the extension first |
62 | 40 |
|
63 | | -**Browsers**: Chrome 93+, Edge 93+, Brave, Opera (Chromium-based) |
64 | | - |
65 | | -**Requirements**: Node.js 14.x+, npm 6.x+ or yarn 1.22.x+, Manifest V3 |
66 | | - |
67 | | -## Next Steps |
68 | | - |
69 | | -Choose your integration path: |
70 | | - |
71 | | -1. **[Installation](/browser-extension/installation)** - Install the SDK and set up assets |
72 | | -2. **[Extension Integration](/browser-extension/extension-integration)** - Build a browser extension with Reclaim |
73 | | -3. **[Web Integration](/browser-extension/web-integration)** - Integrate from your website |
74 | | -4. **[Troubleshooting](/browser-extension/troubleshooting)** - Common issues and solutions |
75 | | - |
76 | | -## Get an API Key |
77 | | - |
78 | | -Before integrating, you'll need API credentials. Follow the [Get API Key guide](/api-key) to set up your Reclaim Protocol project. |
| 41 | +[Learn About Web Integration →](/browser-extension/web-integration) |
0 commit comments