|
1 | 1 | # demo-wallet |
2 | 2 |
|
3 | | -## Note for Mac users |
| 3 | +An Aztec wallet application that allows dApps to interact with user accounts through a secure interface. |
| 4 | + |
| 5 | +## Development Setup |
| 6 | + |
| 7 | +### Prerequisites |
| 8 | + |
| 9 | +- Node.js v22 |
| 10 | +- yarn |
| 11 | +- A running Aztec local node (or access to a remote node) |
| 12 | + |
| 13 | +### Running in Development Mode |
| 14 | + |
| 15 | +Follow these steps to run the wallet in development mode: |
| 16 | + |
| 17 | +1. **Install dependencies** |
| 18 | + |
| 19 | + ```bash |
| 20 | + cd app |
| 21 | + yarn install |
| 22 | + ``` |
| 23 | + |
| 24 | +2. **Start the wallet application** |
| 25 | + |
| 26 | + ```bash |
| 27 | + yarn start |
| 28 | + ``` |
| 29 | + |
| 30 | +3. **Install and run the browser extension** |
| 31 | + |
| 32 | + ⚠️ **Important**: The browser extension must be running for the app to work properly. |
| 33 | + |
| 34 | + The extension is located at `extension`. To set it up: |
| 35 | + |
| 36 | + ```bash |
| 37 | + cd extension |
| 38 | + yarn install |
| 39 | + yarn dev |
| 40 | + ``` |
| 41 | + |
| 42 | + This will launch a browser with the extension preloaded |
| 43 | + |
| 44 | + **Loading the extension in your browser:** |
| 45 | + |
| 46 | + **For Chromium-based browsers (Chrome, Brave, Edge):** |
| 47 | + |
| 48 | + 1. Open your browser and navigate to the extensions page: |
| 49 | + - Chrome: `chrome://extensions` |
| 50 | + - Brave: `brave://extensions` |
| 51 | + - Edge: `edge://extensions` |
| 52 | + 2. Enable "Developer mode" (toggle in the top-right corner) |
| 53 | + 3. Click "Load unpacked" |
| 54 | + 4. Select the `extension/.output/chrome-mv3-*` directory |
| 55 | + |
| 56 | + **For Firefox:** |
| 57 | + |
| 58 | + ```bash |
| 59 | + yarn zip:firefox |
| 60 | + ``` |
| 61 | + |
| 62 | + 1. Navigate to `about:debugging#/runtime/this-firefox` |
| 63 | + 2. Click "Load Temporary Add-on" |
| 64 | + 3. Select the created .zip file under `extension/.output/*` |
| 65 | + |
| 66 | + The extension provides the interface between dApps and the wallet. |
| 67 | + |
| 68 | +### WebSocket Communication |
| 69 | + |
| 70 | +The wallet currently uses **WebSocket communication** for dApp-to-wallet messaging. |
| 71 | + |
| 72 | +⚠️ **Port Requirements**: |
| 73 | + |
| 74 | +- Ensure port **8765** is available on your machine |
| 75 | +- If port 8765 is in use, you'll need to modify the configuration in `app/src/workers/ws-worker.ts` |
| 76 | + |
| 77 | +📝 **Note**: This WebSocket-based communication is temporary. The architecture should ideally use the browser's native extension-to-native-app communication system (Native Messaging API) instead, which would eliminate the need for managing ports and provide better security. |
| 78 | + |
| 79 | +## Production Usage |
| 80 | + |
| 81 | +### Note for Mac users |
4 | 82 |
|
5 | 83 | After downloading a release, run: |
6 | 84 |
|
7 | | -`xattr -d com.apple.quarantine ./app.app` |
| 85 | +```bash |
| 86 | +xattr -d com.apple.quarantine ./app.app |
| 87 | +``` |
8 | 88 |
|
9 | | -To avoid the "this app is damaged" message |
| 89 | +To avoid the "this app is damaged" message. |
0 commit comments