Examples: Streaming Payments and Events

The Quicksilver SDK empowers developers to implement real-time financial flows, such as streaming payments and event-driven interactions. This example demonstrates how to leverage these capabilities to build dynamic monetization and notification systems.

This page builds upon the concepts introduced in Getting Started and utilizes components detailed in the API Reference: Transaction Model and API Reference: QuicksilverClient.

Code Example: examples/5-streaming-and-events.ts

What This Example Demonstrates

This example showcases the powerful real-time capabilities of the Quicksilver SDK for managing streaming payments and integrating with event-driven workflows:

1. Creating Streaming Transactions: It demonstrates how to establish "Stream" type transactions, which are designed for continuous, real-time value transfer (e.g., pay-per-second, pay-per-word).
2. Subscribing to Real-Time Events: The SDK allows subscribing to Server-Sent Events (SSE) for individual streams or accounts. This enables applications to react instantly to changes in stream status or batch payments.
3. Stream Control Operations: It illustrates how to interact with active streams, including pausing, resuming, and permanently stopping them. It also shows how to update streaming parameters like the rate.
4. Stream Analytics and Monitoring: The example retrieves current stream information, including accumulated amounts and rates, providing insights into ongoing financial flows.
5. Conditional Streaming: It briefly introduces how conditional logic can be applied to streaming transactions, allowing for dynamic adjustments or triggers based on predefined events (e.g., viewer engagement, content quality).

Role of StreamConnection

The StreamConnection class (src/realtime/sse.ts) is a crucial component that provides a high-level, event-driven interface for interacting with the Quicksilver Engine's Server-Sent Events (SSE) stream.

• Real-time Updates: It abstracts away the complexities of managing SSE connections, allowing your application to receive real-time notifications about stream status changes (stream_event) and actual fund transfers (batch_created).
• EventEmitter-like Interface: StreamConnection extends Node.js's EventEmitter, making it intuitive to set up listeners for various events (e.g., 'open', 'error', 'close', 'stream_event', 'batch_created').
• Automatic Reconnection: It includes built-in logic for handling disconnections and attempting to reconnect with an exponential backoff strategy, ensuring robustness in dynamic network environments.
• API Key Integration: It automatically appends the API key to the SSE URL if provided, ensuring secure authentication for real-time data streams.

By using StreamConnection, developers can easily build responsive user interfaces, trigger backend logic, or update internal states in real-time as money flows through their applications. This enables dynamic monetization models, live dashboards, and immediate feedback mechanisms for both senders and receivers in the agent economy.