Smart Contract Guide

🚀 Quick Start

To run the smart contract, you need run the following command

1. Clone and Install

git clone https://github.com/your-org/gelap-contracts
cd gelap-contracts
forge install

2. Run Tests

forge test

3. Deploy

# Set up environment
cp .env.example .env
# Edit .env with your configuration

# Deploy to testnet
forge script script/DeployGelap.s.sol --rpc-url $RPC_URL --broadcast

🏗️ Project Structure

gelap-contracts/
├── src/
│   └── GelapShieldedAccount.sol    # Main contract
├── test/
│   ├── Deposit.t.sol               # Deposit tests
│   ├── Transact.t.sol              # Transaction tests
│   ├── Withdraw.t.sol              # Withdrawal tests
│   └── mocks/
│       └── MockSP1Verifier.sol     # Mock verifier
├── script/
│   └── DeployGelap.s.sol           # Deployment script
├── docs/                           # Documentation
└── lib/                            # Dependencies

🔑 Key Features

• Privacy: Hide transaction amounts and participants

• Zero-Knowledge Proofs: Powered by SP1 zkVM

• ERC20 Support: Works with any ERC20 token

• Merkle Tree: Efficient state management

• Double-Spend Protection: Nullifier tracking

📖 Core Concepts

Commitments

Private notes representing token ownership. Each commitment contains:

• Token address

• Amount

• Owner's public key

• Blinding factor (randomness)

Nullifiers

Unique identifiers that prevent double-spending without revealing which note was spent.

Merkle Tree

A 32-level tree storing all commitments. The root represents the current state.

SP1 zkVM

Zero-knowledge virtual machine that proves correct state transitions off-chain.

🔗 Links

• GitHub: gelap-contracts

• SP1 Docs: docs.succinct.xyz

• Foundry: book.getfoundry.sh

🤝 Contributing

Contributions are welcome! Please read our contributing guidelines before submitting PRs.

📄 License

MIT License - see LICENSE file for details

🆘 Support

• Issues: GitHub Issues

• Discord: Join our Discord

• Email: [e-mail]

⚠️ Disclaimer

This software is in active development and has not been audited. Use at your own risk. Do not use in production without a professional security audit.