Skip to content

SIP Protocol Web Application - Privacy-first Web3 interface

Notifications You must be signed in to change notification settings

sip-protocol/sip-app

Repository files navigation

β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—      β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•—
β–ˆβ–ˆβ•”β•β•β•β•β• β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•—    β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•—β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•—β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•—
β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•— β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•”β•    β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•‘β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•”β•β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•”β•
β•šβ•β•β•β•β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•”β•β•β•β•     β–ˆβ–ˆβ•”β•β•β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•”β•β•β•β• β–ˆβ–ˆβ•”β•β•β•β•
β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘ β–ˆβ–ˆβ•‘         β–ˆβ–ˆβ•‘  β–ˆβ–ˆβ•‘β–ˆβ–ˆβ•‘     β–ˆβ–ˆβ•‘
β•šβ•β•β•β•β•β•β• β•šβ•β• β•šβ•β•         β•šβ•β•  β•šβ•β•β•šβ•β•     β•šβ•β•

SIP App

Privacy is not a feature. It's a right.

The Privacy Command Center for Web3 β€” enterprise-grade compliance, analytics & power user workflows

Private payments β€’ Wallet surveillance analyzer β€’ Viewing key disclosure β€’ Compliance dashboards

CI License: MIT Next.js React TypeScript Tailwind

Live: app.sip-protocol.org | Companion: SIP Privacy Mobile


Table of Contents


πŸ›‘οΈ What is SIP App?

SIP App is the flagship privacy application built on the SIP Protocol SDK. Like jup.ag is to Jupiter SDK, app.sip-protocol.org is to @sip-protocol/sdk β€” a world-class consumer application that showcases the full capabilities of cryptographic privacy.

SDK developers   β†’ See SIP App β†’ "I want this for my users" β†’ Integrate SDK
Enterprise users β†’ Use SIP App β†’ Compliance dashboards, audit trails, power tools

The app is the pitch. Quality sells the SDK.


πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Product Family

SIP has two companion products β€” same privacy, platform-optimized:

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  app.sip-protocol.org           β”‚   β”‚  SIP Privacy (Mobile)           β”‚
β”‚  ─────────────────────────────  β”‚   β”‚  ─────────────────────────────  β”‚
β”‚  "Privacy Command Center"       β”‚   β”‚  "Privacy in Your Pocket"       β”‚
β”‚                                 β”‚   β”‚                                 β”‚
β”‚  β€’ Power users / Enterprise     β”‚   β”‚  β€’ Consumers                    β”‚
β”‚  β€’ D3 visualizations            β”‚   β”‚  β€’ Quick payments / swaps       β”‚
β”‚  β€’ Compliance dashboards        β”‚   β”‚  β€’ Native key management        β”‚
β”‚  β€’ Audit trails / Reports       β”‚   β”‚  β€’ Biometric security           β”‚
β”‚  β€’ Multi-monitor workflows      β”‚   β”‚  β€’ On-the-go privacy            β”‚
β”‚                                 β”‚   β”‚                                 β”‚
β”‚  ← YOU ARE HERE                 β”‚   β”‚  β†’ sip-mobile repo              β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

NOT 1:1 clones β€” each optimized for its platform's strengths.


✨ Features

πŸ” Private Payments

Send and receive shielded payments with stealth addresses. Full privacy with one toggle.

Feature Description Status
Send Send SOL/tokens to stealth addresses βœ… Live
Receive Generate one-time stealth addresses βœ… Live
Scan Detect incoming payments to your keys βœ… Live
History View transaction history βœ… Live
Disclose Share viewing keys for compliance βœ… Live

πŸ“Š Privacy Score

Analyze any wallet's surveillance exposure with D3 visualizations.

  • Heuristic analysis of on-chain activity
  • Exchange interaction detection
  • Address clustering risk assessment
  • Privacy improvement recommendations

πŸ”‘ Viewing Key Disclosure

Selective disclosure for compliance without exposing spending keys.

  • Export viewing keys for specific time ranges
  • Track who you've shared with
  • Revoke access anytime
  • Audit-ready transaction proofs

🏒 Enterprise (Coming Soon)

Compliance dashboards and audit tools for institutions.

  • Batch transaction processing
  • Audit report generation
  • Multi-signature workflows
  • Regulatory compliance tools

πŸŽ₯ Live Demo

Try it now: app.sip-protocol.org

Screenshots

Hub Dashboard Private Payments Privacy Score
App overview with feature cards Send/receive shielded payments Wallet surveillance analyzer

πŸš€ Quick Start

Prerequisites

  • Node.js 20+
  • pnpm 9+

Installation

# Clone the repository
git clone https://github.com/sip-protocol/sip-app.git
cd sip-app

# Install dependencies
pnpm install

# Start development server
pnpm dev

# Open http://localhost:3000

Environment Variables

# .env.local
NEXT_PUBLIC_SOLANA_RPC_URL=https://api.mainnet-beta.solana.com
NEXT_PUBLIC_HELIUS_API_KEY=your-key  # For DAS API

πŸ—οΈ Architecture

Project Structure

sip-app/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ app/                      # Next.js App Router
β”‚   β”‚   β”œβ”€β”€ layout.tsx            # Root layout (nav/footer)
β”‚   β”‚   β”œβ”€β”€ page.tsx              # Hub dashboard
β”‚   β”‚   β”‚
β”‚   β”‚   β”œβ”€β”€ (payments)/           # Route group: Private Payments
β”‚   β”‚   β”‚   └── payments/
β”‚   β”‚   β”‚       β”œβ”€β”€ page.tsx      # Payments dashboard
β”‚   β”‚   β”‚       β”œβ”€β”€ send/         # Send shielded payment
β”‚   β”‚   β”‚       β”œβ”€β”€ receive/      # Generate stealth address
β”‚   β”‚   β”‚       β”œβ”€β”€ scan/         # Scan for incoming
β”‚   β”‚   β”‚       β”œβ”€β”€ history/      # Transaction history
β”‚   β”‚   β”‚       └── disclose/     # Viewing key disclosure
β”‚   β”‚   β”‚
β”‚   β”‚   β”œβ”€β”€ (wallet)/             # Route group: Wallet
β”‚   β”‚   β”‚   └── wallet/
β”‚   β”‚   β”‚       β”œβ”€β”€ page.tsx      # Wallet overview
β”‚   β”‚   β”‚       └── keys/         # Viewing key management
β”‚   β”‚   β”‚
β”‚   β”‚   β”œβ”€β”€ (dex)/                # Route group: DEX
β”‚   β”‚   β”‚   └── dex/
β”‚   β”‚   β”‚       β”œβ”€β”€ page.tsx      # Private swap interface
β”‚   β”‚   β”‚       └── jupiter/      # Jupiter integration
β”‚   β”‚   β”‚
β”‚   β”‚   β”œβ”€β”€ (enterprise)/         # Route group: Enterprise
β”‚   β”‚   β”‚   └── enterprise/
β”‚   β”‚   β”‚       β”œβ”€β”€ page.tsx      # Dashboard
β”‚   β”‚   β”‚       └── compliance/   # Compliance tools
β”‚   β”‚   β”‚
β”‚   β”‚   β”œβ”€β”€ privacy-score/        # Wallet analyzer
β”‚   β”‚   └── showcase/             # Hackathon showcases
β”‚   β”‚
β”‚   β”œβ”€β”€ components/
β”‚   β”‚   β”œβ”€β”€ ui/                   # Base components (Button, Card, Input)
β”‚   β”‚   β”œβ”€β”€ payments/             # Payment-specific components
β”‚   β”‚   β”œβ”€β”€ wallet/               # Wallet components
β”‚   β”‚   └── shared/               # Shared components
β”‚   β”‚
β”‚   β”œβ”€β”€ hooks/                    # Custom React hooks
β”‚   β”‚   β”œβ”€β”€ use-send-payment.ts
β”‚   β”‚   β”œβ”€β”€ use-scan-payments.ts
β”‚   β”‚   └── use-stealth-address.ts
β”‚   β”‚
β”‚   β”œβ”€β”€ stores/                   # Zustand stores
β”‚   β”‚   β”œβ”€β”€ wallet.ts
β”‚   β”‚   β”œβ”€β”€ privacy.ts
β”‚   β”‚   └── payments.ts
β”‚   β”‚
β”‚   β”œβ”€β”€ lib/                      # Utilities
β”‚   β”‚   β”œβ”€β”€ sip-client.ts         # SIP SDK integration
β”‚   β”‚   β”œβ”€β”€ solana.ts             # Solana connection
β”‚   β”‚   └── privacy/              # Privacy backends
β”‚   β”‚
β”‚   └── types/                    # TypeScript types
β”‚
β”œβ”€β”€ public/                       # Static assets
β”œβ”€β”€ tests/                        # Test suites
└── docker-compose.yml            # Production deployment

Data Flow

User Action β†’ React Component β†’ Custom Hook β†’ SIP SDK β†’ Solana
                                    β”‚
                                    β–Ό
                            Privacy Layer
                    β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
                    β”‚ β€’ Generate stealth addr  β”‚
                    β”‚ β€’ Create commitment      β”‚
                    β”‚ β€’ Sign transaction       β”‚
                    β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                                    β”‚
                                    β–Ό
                            On-Chain Execution

πŸ“ App Routes

Live Routes (8)

Route Purpose Status
/ Hub dashboard with app cards βœ… Live
/payments Private Payments dashboard βœ… Live
/payments/send Send shielded payment βœ… Live
/payments/receive Generate stealth address βœ… Live
/payments/scan Scan for incoming payments βœ… Live
/payments/history Transaction history βœ… Live
/payments/disclose Viewing key disclosure βœ… Live
/privacy-score Wallet surveillance analyzer βœ… Live

Scaffolded Routes (6)

Route Purpose Status
/wallet Wallet interface πŸ”² Scaffolded
/wallet/keys Viewing key management πŸ”² Scaffolded
/dex Private DEX πŸ”² Scaffolded
/dex/jupiter Jupiter integration πŸ”² Scaffolded
/enterprise Enterprise dashboard πŸ”² Scaffolded
/enterprise/compliance Compliance tools πŸ”² Scaffolded

πŸ› οΈ Tech Stack

Category Technology Purpose
Framework Next.js 16 (App Router) Full-stack React
UI React 19 Component library
Styling Tailwind CSS 4 Utility-first CSS
State Zustand 5 Client state management
Animations Framer Motion Micro-interactions
Visualization D3.js Privacy Score charts
Testing Vitest + Playwright Unit + E2E tests
Privacy SDK @sip-protocol/sdk Core privacy primitives
React Hooks @sip-protocol/react useSIP, useStealthAddress
Wallet @solana/wallet-adapter Phantom, Solflare, etc.

πŸ’» Development

Commands

pnpm dev              # Start development server
pnpm build            # Build for production
pnpm start            # Start production server
pnpm test             # Run tests in watch mode
pnpm test:run         # Run tests once
pnpm typecheck        # Type check with TypeScript
pnpm lint             # Lint with ESLint
pnpm format           # Format with Prettier
pnpm validate         # Run all checks

Testing

# Unit tests
pnpm test:run

# E2E tests
pnpm test:e2e

# With UI
pnpm test:e2e:ui

# Coverage
pnpm test:coverage

Key Components

Component Purpose
SendShieldedForm Form for sending private payments
StealthAddressGenerator Generate + display stealth meta-address
PaymentScanner Scan blockchain for incoming payments
ClaimPayment Claim received stealth payments
ViewingKeyDisclosure Reveal transaction to auditor
PrivacyToggle Privacy level selector
WalletConnect Solana wallet connection

πŸš€ Deployment

Docker (Production)

# Build Docker image
docker build -t sip-app .

# Run locally
docker run -p 3000:3000 sip-app

VPS Configuration

# docker-compose.yml
name: sip-app

services:
  app-blue:
    image: ghcr.io/sip-protocol/sip-app:latest
    container_name: sip-app-blue
    ports:
      - "5004:3000"
    restart: unless-stopped

  app-green:
    image: ghcr.io/sip-protocol/sip-app:green
    container_name: sip-app-green
    ports:
      - "5005:3000"
    restart: unless-stopped

CI/CD Pipeline

Push to main β†’ GitHub Actions β†’ Build Docker β†’ Push to GHCR β†’ SSH Deploy β†’ Live

🎨 Design Philosophy

Quality Standards

Aspect Standard
UX Delightful, intuitive, zero friction
Performance Sub-second interactions, optimistic UI
Design Clean, modern, professional
Reliability 99.9% uptime, graceful error handling
Accessibility WCAG 2.1 AA compliant
Mobile Mobile-first responsive design

Design Inspirations

App What to Learn
jup.ag Swap UX, token selection, transaction flow
phantom.app Wallet UX, onboarding, mobile experience
uniswap.org Clean design, professional feel
stripe.com Form design, error handling, trust signals
linear.app Speed, keyboard shortcuts, polish

Quality Benchmark

"Would this be acceptable on jup.ag?"

If no, raise the bar. The app sells the SDK.


πŸ”— Related Projects

Project Description Link
sip-protocol Core SDK (6,600+ tests) GitHub
sip-mobile Companion mobile app GitHub
sip-website Marketing website GitHub
docs-sip Documentation docs.sip-protocol.org

πŸ“„ License

MIT License β€” see LICENSE file for details.


Privacy Command Center for Web3

Privacy is not a feature. It's a right.

Live App Β· Documentation Β· Report Bug

Part of the SIP Protocol ecosystem

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages