@relayprotocol/relay-kit-ui 9.1.4 → 10.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relayprotocol/relay-kit-ui",
-  "version": "9.1.4",
+  "version": "10.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/relayprotocol/relay-kit.git",
@@ -89,8 +89,8 @@
     "qrcode.react": "^4.1.0",
     "tailwind-merge": "^3.0.0",
     "usehooks-ts": "^3.1.0",
-    "@relayprotocol/relay-kit-hooks": "3.0.24",
-    "@relayprotocol/relay-sdk": "6.1.3"
+    "@relayprotocol/relay-sdk": "7.0.0",
+    "@relayprotocol/relay-kit-hooks": "4.0.0"
   },
   "keywords": [
     "eth",

package/readme.md

@@ -7,6 +7,20 @@ Head over to the <a href="https://docs.relay.link/references/sdk/getting-started
 </br>
 </br>
 
+## Requirements: Relay API key + proxy
+
+Relay Kit reads transaction history from the Requests API, which was upgraded to `GET /requests/v3`. **v3 requires a Relay API key** ([how to get one](https://docs.relay.link/references/api/api-keys#how-to-get-an-api-key)) sent via the `x-api-key` header.
+
+Because Relay Kit's hooks (`useRequests`, `useDepositAddressStatus`) run in the browser, the API key must **not** be shipped to the client. Instead, run a lightweight proxy that injects the `x-api-key` header server-side and point Relay Kit at it via `baseApiUrl`:
+
+```ts
+createClient({
+  // your proxy forwards requests to https://api.relay.link and adds `x-api-key`
+  baseApiUrl: 'https://your-app.com/api/relay',
+  source: 'YOUR-SOURCE'
+})
+```
+
 ## Contributing
 
 Your contributions are what make the community great. We encourage you to be a part of it. Here are some important notes for contributors: