blockintel-gate-sdk 0.3.1 → 0.3.3

package/README.md

@@ -341,10 +341,11 @@ The SDK includes a **Heartbeat Manager** that automatically acquires and refresh
 
 ### How It Works
 
-1. **Automatic Token Acquisition**: The SDK automatically starts a background heartbeat refresher when the `GateClient` is initialized
-2. **Token Refresh**: Heartbeat tokens are refreshed every 10 seconds (configurable) to maintain a valid token
+1. **Automatic Token Acquisition**: The SDK automatically starts a background heartbeat refresher when the `GateClient` is initialized. This continuously sends heartbeats to the Control Plane, keeping the signer status active in the UI.
+2. **Token Refresh**: Heartbeat tokens are refreshed every 10 seconds (configurable via `heartbeatRefreshIntervalSeconds`) to maintain a valid token
 3. **Signing Enforcement**: Before any `evaluate()` call, the SDK checks for a valid heartbeat token. If missing or expired, it throws `HEARTBEAT_MISSING` error
 4. **Token Inclusion**: The heartbeat token is automatically included in the `signingContext` of every evaluation request
+5. **No Manual Scripts Needed**: The SDK handles all heartbeat management automatically - no need for separate heartbeat scripts
 
 ### Configuration
 
@@ -358,7 +359,8 @@ const gate = new GateClient({
   // Heartbeat manager uses baseUrl to infer Control Plane URL
   // Or explicitly set controlPlaneUrl if different
   controlPlaneUrl: 'https://control-plane.blockintelai.net',  // Optional
-  defaultSignerId: 'my-signer-id',  // Optional: default signerId for heartbeat
+  signerId: 'my-signer-id',  // Optional: signerId for heartbeat (if known upfront)
+  heartbeatRefreshIntervalSeconds: 10,  // Optional: heartbeat refresh interval (default: 10s)
 });
 ```