@owney/sdk 0.7.25-beta.6 → 0.7.25-beta.8

package/README.md

@@ -16,11 +16,7 @@ import { OwneySDK } from "@owney/sdk";
 // Create the SDK instance
 const sdk = new OwneySDK({
   apiKey: "your-owney-api-key",
-  rpcUrls: {
-    1: "https://eth-mainnet.g.alchemy.com/v2/<key>",
-    8453: "https://base-mainnet.g.alchemy.com/v2/<key>",
-    42161: "https://arb-mainnet.g.alchemy.com/v2/<key>",
-  },
+  routingApiBaseUrl: "https://your-routing-api.example",
 });
 
 // Connect with an EIP-1193 wallet provider
@@ -42,6 +38,7 @@ Create a new SDK instance.
 | Param                                   | Type                                                        | Description                                                                                       |
 | --------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
 | `config.apiKey`                         | `string`                                                    | Your Owney API key, used to authenticate with the routing API and fetch agent-specific keys       |
+| `config.routingApiBaseUrl`              | `string` (optional)                                         | Routing API URL; required for proxy reads unless the SDK build has `OWNEY_ROUTING_API_BASE_URL` or all `rpcUrls` are set |
 | `config.rpcUrls`                        | `{ 1?: string; 8453?: string; 42161?: string }` (optional)  | Per-chain RPC overrides used by agent reads and transaction-receipt polling                       |
 | `config.zyfaiRpcUrls`                   | Same as `rpcUrls` (deprecated)                              | Legacy Zyfai-only override; use `rpcUrls` for all application-owned reads                         |
 
@@ -50,11 +47,7 @@ import { OwneySDK } from "@owney/sdk";
 
 const sdk = new OwneySDK({
   apiKey: "your-owney-api-key",
-  rpcUrls: {
-    1: "https://eth-mainnet.g.alchemy.com/v2/<key>",
-    8453: "https://base-mainnet.g.alchemy.com/v2/<key>",
-    42161: "https://arb-mainnet.g.alchemy.com/v2/<key>",
-  },
+  routingApiBaseUrl: "https://your-routing-api.example",
 });
 ```
 
@@ -68,16 +61,18 @@ switching, signatures, and transaction submission.
 supported chain using this precedence:
 
 1. The caller-provided `rpcUrls[chainId]`, when present and non-empty.
-2. The Owney SDK default URL for that chain.
+2. The Owney routing API read-only RPC proxy for that chain.
 
-The SDK defaults are Owney-managed Alchemy endpoints embedded in the SDK. They
-keep zero-configuration integrations working, but their capacity is shared by
-every consumer that does not provide an override.
+The Alchemy credential stays on the routing API server. The SDK sends its
+existing organization key to the proxy for per-organization rate limiting.
+The proxy base URL must be provided through `routingApiBaseUrl` or the SDK
+build's `OWNEY_ROUTING_API_BASE_URL`; there is no hardcoded production fallback.
 
 ```typescript
-// Zero configuration: all supported chains use Owney SDK defaults.
+// All supported chains use the Owney routing API proxy.
 const sdk = new OwneySDK({
   apiKey: "your-owney-api-key",
+  routingApiBaseUrl: "https://your-routing-api.example",
 });
 ```
 
@@ -86,9 +81,10 @@ Overrides can be complete or partial:
 ```typescript
 const sdk = new OwneySDK({
   apiKey: "your-owney-api-key",
+  routingApiBaseUrl: "https://your-routing-api.example",
   rpcUrls: {
-    // Ethereum and Arbitrum continue using Owney SDK defaults.
-    8453: "https://base-mainnet.g.alchemy.com/v2/<key>",
+    // Ethereum and Arbitrum continue using the routing API proxy.
+    8453: "https://your-own-rpc.example/rpc",
   },
 });
 ```
@@ -106,12 +102,10 @@ The resolved URLs are shared across Owney-owned reads and agent integrations:
 
 Notes:
 
-- Owney mini-apps should continue passing explicit environment-specific URLs,
-  even though the SDK defaults provide a fallback.
-- Production SDK consumers should provide their own endpoints for quota
-  isolation, origin restrictions, and predictable capacity.
-- Partial maps override only the supplied chains; missing chains retain Owney
-  SDK defaults.
+- Owney mini-apps pass the same routing API proxy URLs to Wagmi and the SDK.
+- SDK consumers may override endpoints if they operate their own RPC provider.
+- Partial maps override only the supplied chains; missing chains use Owney's
+  routing API proxy.
 - HTTP reads use bounded retries and honor provider `Retry-After` responses.
 - `zyfaiRpcUrls` remains available for compatibility but applies only to Zyfai.