Skip to content

INTEGRATION_GUIDE.md

Latest commit

 

History

History
76 lines (57 loc) · 2.8 KB

INTEGRATION_GUIDE.md

File metadata and controls

76 lines (57 loc) · 2.8 KB
Raw

StableStream USDC Platform - Integration Guide

This guide provides comprehensive documentation for backend and smart contract developers to integrate with the StableStream USDC payment streaming platform.

Table of Contents

  1. Overview
  2. Architecture
  3. Smart Contract Requirements
  4. API Endpoints
  5. Data Models
  6. Authentication
  7. Real-time Updates
  8. Environment Variables
  9. Testing
  10. Deployment

Overview

StableStream is a USDC payment streaming platform that allows users to create continuous payment streams that flow by the second. The platform consists of:

  • Frontend: Next.js 16 application with React 19
  • Smart Contracts: Solidity contracts for managing payment streams
  • Backend API: RESTful API for user data and analytics
  • WebSocket: Real-time updates for stream balances

Architecture

``` ┌─────────────┐ ┌──────────────┐ ┌─────────────┐ │ Frontend │────▶│ Backend API │────▶│ Database │ │ (Next.js) │ │ (REST/WS) │ │ (PostgreSQL)│ └─────────────┘ └──────────────┘ └─────────────┘ │ │ │ │ ▼ ▼ ┌─────────────┐ ┌──────────────┐ │ Wallet │ │ Smart │ │ (RainbowKit)│────▶│ Contracts │ └─────────────┘ └──────────────┘ ```

Smart Contract Requirements

StreamManager Contract

The main contract should manage payment streams with the following functionality:

Core Functions

// Create a new payment stream
function createStream(
    address recipient,
    uint256 amount,
    uint256 startTime,
    uint256 endTime
) external returns (uint256 streamId);

// Pause an active stream
function pauseStream(uint256 streamId) external;

// Resume a paused stream
function resumeStream(uint256 streamId) external;

// Cancel a stream and refund remaining balance
function cancelStream(uint256 streamId) external returns (uint256 refundAmount);

// Withdraw available balance from a stream
function withdraw(uint256 streamId) external returns (uint256 amount);

// Get stream details
function getStream(uint256 streamId) external view returns (Stream memory);

// Calculate available balance for withdrawal
function balanceOf(uint256 streamId) external view returns (uint256);