Skip to content

blessedux/SozuPay

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SozuPay 💸

Whisper a Haiku. Claim in Silence. Settle in Gold.

A haiku-based secret money delivery system built on Stacks blockchain, where haikus act as passwords to claim funds.

📋 Smart Contract Information

Haiku-based Smart Contract: https://github.com/blessedux/haiku_contract

The core smart contract that powers SozuPay's haiku-based money delivery system can be found in the repository above. This contract handles haiku creation, fund locking, and claiming operations on the Stacks blockchain.

🎯 Deployed Contract

Contract Address: ST2EX94QMG4FEHYV9KRJRX9BGM313YJ9DAYKZKWFN
Contract Name: haiku-basic
Network: Stacks Testnet
Status: ✅ Deployed and Ready

🚀 Quick Start

  1. Read the Documentation: All technical documentation is in the /docs directory
  2. Deploy the Contract: Follow the Deployment Guide
  3. Test Functions: Use the Contract Testing Guide
  4. Run the Application: Start the backend and frontend services

📚 Documentation

All documentation has been organized in the /docs directory:

🏗️ Project Structure

SozuPay/
├── docs/                    # 📚 All documentation
├── backend/                 # 🔧 Backend services and API
├── frontend/                # 🎨 Next.js frontend application
├── haiku-project/          # 📜 Smart contract deployment
└── README.md               # 📖 This file

🎌 How It Works

  1. Create Haiku: User enters USD amount, system generates random haiku
  2. Fund Contract: STX equivalent is automatically funded to the contract
  3. Share Haiku: User shares the haiku with the recipient
  4. Claim Payment: Recipient uses the haiku to claim the STX
  5. Settle in Gold: Funds are transferred to the claimer's wallet

🔧 Development

Prerequisites

  • Node.js 18+
  • Stacks wallet with testnet STX
  • Git

Setup

# Clone the repository
git clone <repository-url>
cd SozuPay

# Install dependencies
cd backend && npm install
cd ../frontend && npm install

# Deploy contract (see docs/DEPLOYMENT_GUIDE.md)
cd ../haiku-project
# Follow deployment guide

# Start services
cd ../backend && npm run dev
cd ../frontend && npm run dev

🔗 Links

📄 License

This project is licensed under the MIT License.


Ready to whisper haikus and settle in gold? Check out the documentation to get started! 🎌✨

About

Seamless Bitcoin Claim Links via Turnkey + sBTC (Stacks)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published