@gvnrdao/dh-sdk 0.0.149 → 0.0.151

package/README.md

@@ -58,6 +58,7 @@ if (result.success) {
 - ✅ **PKP Integration**: Secure key management with LIT Protocol
 - ✅ **Smart Contract Integration**: Direct interaction with Diamond Hands contracts
 - ✅ **Bitcoin Operations**: Support for Bitcoin deposit verification
+- ✅ **Telegram Notifications**: Optional event notifications (Node.js only)
 
 ## API Reference
 
@@ -72,6 +73,50 @@ if (result.success) {
 
 See the full API documentation for detailed configuration options and method signatures.
 
+## Telegram Notifications
+
+The SDK supports optional Telegram notifications for loan events (minting, payments, renewals, etc.). These notifications only work in Node.js environments due to browser security restrictions.
+
+### Enabling Telegram Notifications
+
+Add the `telegram` configuration when initializing the SDK:
+
+```typescript
+const sdk = new DiamondHandsSDK({
+  mode: "service",
+  serviceEndpoint: "http://localhost:3001",
+  telegram: {
+    chatId: "your-chat-id",
+    chatToken: "your-bot-token",
+    threadId: 123 // Optional: for group threads
+  },
+  // ... other config
+});
+```
+
+### Browser Behavior
+
+**Important**: Telegram notifications are automatically disabled in browser environments to avoid CORS errors. The SDK detects browser environments and silently skips notification attempts without breaking your application flow.
+
+- ✅ **Node.js**: Notifications sent via Telegram Bot API
+- ✅ **Browser**: Notifications silently skipped (no errors)
+- ✅ **Development**: Console logs in localhost for debugging
+
+### Supported Events
+
+The SDK sends notifications for:
+- Loan creation
+- UCD minting
+- Partial payments
+- Loan renewals
+- Balance confirmations
+- BTC withdrawals
+- Operation failures
+
+### Security Note
+
+Never expose your Telegram bot token in frontend code. If you need notifications from browser applications, use a backend webhook endpoint instead.
+
 ## License
 
 MIT