Skip to main content

What is DolphinPay? 🚀

DolphinPay is a production-ready decentralized payment infrastructure built on the Sui blockchain, providing comprehensive payment solutions for Web3 applications.

🌟 Overview​

DolphinPay enables seamless cryptocurrency payments with enterprise-grade features:

  • ✅ One-time Payment Processing - Simple payment creation and execution
  • ✅ Merchant Management - Configurable fees, multi-currency support
  • ✅ Multi-currency Support - Batch payments & token operations
  • ✅ Fee Management - Platform fees + custom merchant fees
  • ✅ TypeScript SDK - Complete client library with comprehensive tests
  • ✅ Next.js Frontend - Modern, responsive UI with wallet integration
  • 🔄 Subscription & Recurring Payments (planned)
  • 🔄 Refund & Dispute Management (planned)
  • 🔄 Risk Control System (planned)

🏗️ Architecture​

DolphinPay is built with a modular architecture that ensures scalability, security, and developer experience:

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Frontend      │    │       SDK       │    │  Smart Contracts │
│   (Next.js)     │◄──►│  (TypeScript)   │◄──►│    (Move)       │
│                 │    │                 │    │                 │
│ - React UI      │    │ - Type Safety   │    │ - Payment Logic │
│ - Wallet Connect│    │ - Transaction   │    │ - Merchant Mgmt │
│ - Fee Calculator│    │   Building      │    │ - Fee Calculation│
└─────────────────┘    └─────────────────┘    └─────────────────┘
         │                       │                       │
         └───────────────────────┼───────────────────────┘
                                 │
                    ┌─────────────────┐
                    │  Sui Blockchain  │
                    │                 │
                    │ - High Throughput│
                    │ - Parallel Exec  │
                    │ - Low Latency    │
                    └─────────────────┘

🔑 Key Features​

For Merchants​

  • Easy Integration: Simple SDK integration with just a few lines of code
  • Multi-Currency: Accept payments in any Sui ecosystem token
  • Custom Fees: Configure your own merchant fees on top of platform fees
  • Real-time Analytics: Track payments, volume, and merchant performance
  • Webhook Support: Receive instant notifications for payment events

For Developers​

  • TypeScript SDK: Full type safety and excellent developer experience
  • Dry Run Testing: Test transactions without spending gas
  • Comprehensive Testing: 100+ integration tests covering all functionality
  • Multiple Client Libraries: React, Vue, and mobile SDKs available
  • Extensive Documentation: Complete guides and API references

For Users​

  • Wallet Integration: Support for all major Sui wallets
  • One-Click Payments: Seamless payment experience
  • Transaction Transparency: Full visibility into fees and transaction status
  • Multi-Device Support: Works on desktop, tablet, and mobile

🚀 Quick Start​

1. Install the SDK​

npm install @dolphinpay/sdk

2. Initialize Client​

import { createClient } from "@dolphinpay/sdk"

const client = createClient({
  packageId:
    "0x9c7ca262d020b005e0e6b6a5d083b329d58716e0d80c07b46804324074468f9c",
  network: "testnet",
})

3. Create a Payment​

import { suiToMist } from "@dolphinpay/sdk"

const payment = await client.payment.buildCreatePayment({
  merchant: "0xmerchant_address",
  amount: suiToMist(10), // 10 SUI
  currency: "SUI",
  description: "Premium subscription",
  expirySeconds: 3600, // 1 hour
})

// Execute the payment
await wallet.signAndExecuteTransactionBlock({
  transactionBlock: payment,
})

🌐 Live Deployment​

Testnet Package ID:

0x9c7ca262d020b005e0e6b6a5d083b329d58716e0d80c07b46804324074468f9c

Network: Sui Testnet Explorer: View on SuiVision

🛠️ Tech Stack​

  • Blockchain: Sui Network
  • Smart Contracts: Move Language
  • SDK: TypeScript with full type definitions
  • Frontend: Next.js 15 with App Router
  • Styling: Tailwind CSS
  • Wallet Integration: @mysten/dapp-kit
  • State Management: React Query
  • Testing: Comprehensive test suite with 100+ tests

📚 Documentation Structure​

This documentation is organized to help different audiences:

🏗️ Smart Contracts​

  • Core payment and merchant modules
  • Multi-currency and batch payment systems
  • Advanced features (subscriptions, DeFi integration, refunds)
  • Security and testing

🔧 SDK Integration​

  • TypeScript SDK setup and usage
  • React, Vue, and mobile integrations
  • API references and examples
  • Testing and development tools

💻 Frontend Application​

  • Next.js application architecture
  • UI components and design system
  • Deployment and configuration
  • Integration examples

👨‍💼 Merchant Integration​

  • Merchant registration and setup
  • Payment processing workflows
  • Analytics and reporting
  • Best practices and security

🤝 Contributing​

DolphinPay is an open-source project. We welcome contributions from the community:

  • Code Contributions: Submit pull requests for bug fixes and new features
  • Documentation: Help improve our guides and examples
  • Testing: Report issues and help expand test coverage
  • Community: Join discussions and help other developers

📄 License​

DolphinPay is released under the MIT License.

🔗 Links​

Ready to build the future of Web3 payments? Let's dive deeper into the documentation!