Semaphore Stellar Boilerplate

🚧 Work In Progress: Stellar Integration 🚧

This boilerplate is currently transitioning from Ethereum to Stellar. The current version maintains Ethereum compatibility and will be updated to support Stellar once the Semaphore Stellar SDK is complete.

This repository is structured into two main components: a web app and smart contracts. The application enables users to create Semaphore identities, join groups, and send anonymous feedback (currently on Ethereum's Sepolia testnet).

🪧 About The Project

What is Semaphore?

Semaphore is a cutting-edge privacy layer leveraging zero-knowledge proofs to enable anonymous participation in group activities such as voting, signaling, and endorsements. Users can verify their membership in groups and perform activities without revealing their identity.

Why Stellar?

Stellar's rapidly growing ecosystem lacks privacy-preserving solutions that are already standard in many EVM chains. Integrating Semaphore with Stellar will bring proven zero-knowledge privacy technology to a new blockchain, empowering developers to build secure, private, and decentralized applications for Stellar's expanding user base.

🛠 Installation

1. Clone the repository:

git clone https://github.com/your-username/semaphore-stellar-boilerplate.git
cd semaphore-stellar-boilerplate

2. Install dependencies:

yarn

3. Set up environment:

cp .env.example .env

📜 Current Usage (Ethereum)

Local Development

Start the development server:

yarn dev

Deploy Contracts (Sepolia)

1. Navigate to contracts directory:

cd apps/contracts

2. Deploy the contract:

yarn deploy --semaphore <semaphore-address> --network sepolia

3. Configure web app:
   • Update apps/web-app/.env.production with your contract address
   • Copy artifacts from apps/contracts/artifacts/contracts to apps/web-app/contract-artifacts

Note

Find Semaphore contract addresses here

Verify Contracts

yarn verify <contract-address> <semaphore-address> --network sepolia

🗂️ Repository Features

• Modular Architecture: Easily extendable design for different use cases
• Development Tools: Complete testing and deployment setup
• Documentation: Comprehensive guides and resources
• Quality Assurance: Linting and formatting configurations

🌐 Related Repositories

The Semaphore Stellar ecosystem includes:

• Semaphore Stellar Docs
• Semaphore Stellar Contracts
• Semaphore Stellar SDK

💬 Community

Join our community:

• Semaphore Stellar Telegram
• Semaphore Community

🛠 Development

Code Quality

# Check formatting
yarn prettier

# Format code
yarn prettier:write

🤝 Contributing

We welcome contributions! Please review our Contributing Guidelines before submitting changes.

⭐ Acknowledgments

This project represents a bridge between Semaphore's privacy technology and Stellar's blockchain ecosystem. Special thanks to both the Semaphore and Stellar communities for their ongoing support and innovation.