Skip to content

Latest commit

Β 

History

History
294 lines (214 loc) Β· 6.33 KB

File metadata and controls

294 lines (214 loc) Β· 6.33 KB

πŸš€ Get Started with ΞTHΞ›URΞ›

Welcome to ΞTHΞ›URΞ›! This guide will help you get started in just a few minutes.

πŸ“‹ What You'll Need

  • 5 minutes of your time
  • Computer with macOS, Linux, or Windows (WSL)
  • Internet connection
  • Modern browser (Chrome, Safari, Edge, or Firefox)

🎯 What You'll Build

By the end of this guide, you'll have:

  • βœ… A working development environment
  • βœ… Smart contracts deployed to Sepolia testnet
  • βœ… A passkey-based smart wallet
  • βœ… The ability to send transactions with biometric authentication

πŸ“š Choose Your Path

πŸƒ Quick Start (5 minutes)

Best for: First-time users who want to see it working ASAP

πŸ‘‰ Follow QUICKSTART.md

πŸŽ“ Full Tutorial (15 minutes)

Best for: Developers who want to understand everything

πŸ‘‰ Follow DEPLOYMENT.md

πŸ”§ Developer Setup (30 minutes)

Best for: Contributors who want to modify the code

πŸ‘‰ Follow CONTRIBUTING.md

🎬 Quick Start Summary

Step 1: Install Tools

# Install Foundry
curl -L https://foundry.paradigm.xyz | bash
foundryup

# Install Node.js (if not already installed)
# Visit https://nodejs.org/

Step 2: Clone & Setup

git clone https://github.com/yourusername/ethaura.git
cd ethaura
./scripts/setup.sh

Step 3: Configure

# Edit .env with your settings
cp .env.example .env
nano .env

Step 4: Deploy

# Deploy to Sepolia
make deploy-sepolia

Step 5: Run Frontend

# Start the demo
make frontend

Step 6: Try It!

  1. Open http://localhost:3000
  2. Create a passkey
  3. Deploy an account
  4. Send a transaction

πŸ“– Documentation Map

For Users

For Developers

For Deployment

Reference

🎯 Learning Path

Beginner

  1. Read README.md
  2. Follow QUICKSTART.md
  3. Try the demo
  4. Read FAQ.md

Intermediate

  1. Read ARCHITECTURE.md
  2. Review smart contracts
  3. Run tests locally
  4. Explore frontend code

Advanced

  1. Read DEPLOYMENT.md
  2. Deploy your own instance
  3. Modify contracts
  4. Contribute improvements

πŸ› οΈ Common Commands

# Setup
make install          # Install dependencies
make build           # Build contracts
make test            # Run tests

# Development
make test-gas        # Gas report
make coverage        # Test coverage
make format          # Format code

# Deployment
make deploy-sepolia  # Deploy to Sepolia

# Frontend
make frontend        # Run dev server
make frontend-build  # Build for production

# Utilities
make clean           # Clean artifacts
make help            # Show all commands

πŸŽ“ Key Concepts

What is Account Abstraction?

Account Abstraction (ERC-4337) allows smart contracts to act as user accounts, enabling features like:

  • Custom signature schemes (like P-256)
  • Gas sponsorship
  • Batch transactions
  • Social recovery

What is P-256?

P-256 (secp256r1) is a cryptographic curve widely supported by:

  • Hardware security modules
  • Secure enclaves (Touch ID, Face ID)
  • WebAuthn/Passkeys
  • TPM chips

What is EIP-7951?

EIP-7951 adds a precompile for P-256 signature verification, making it:

  • Gas-efficient (~6,900 gas)
  • Native to Ethereum
  • Available on Sepolia testnet

What are Passkeys?

Passkeys are a modern authentication method that:

  • Use biometrics (fingerprint, face)
  • Store keys in secure hardware
  • Work across devices
  • Replace passwords

πŸ” Troubleshooting

Issue: Command not found

Solution: Install the required tool

Issue: Tests failing

Solution: Check you're on the right network

forge test --fork-url $SEPOLIA_RPC_URL

Issue: Frontend won't start

Solution: Install dependencies

cd frontend
npm install
npm run dev

Issue: Deployment fails

Solution: Check your .env file

  • Valid RPC URL
  • Funded private key
  • Correct network

πŸ’‘ Tips

1. Use the Makefile

All common commands are in the Makefile:

make help

2. Read Error Messages

Error messages usually tell you exactly what's wrong.

3. Check Documentation

Most questions are answered in the docs.

4. Ask for Help

  • GitHub Discussions
  • Discord community
  • Open an issue

πŸŽ‰ Success Checklist

After setup, you should be able to:

  • Build contracts (make build)
  • Run tests (make test)
  • Deploy to Sepolia (make deploy-sepolia)
  • Run frontend (make frontend)
  • Create a passkey
  • Deploy an account
  • Send a transaction

🌟 What's Next?

Explore

  • Try different features
  • Read the code
  • Experiment with modifications

Learn

  • Study the architecture
  • Understand the flow
  • Read EIP-7951 and ERC-4337

Build

  • Create your own dApp
  • Add new features
  • Integrate with other protocols

Contribute

  • Fix bugs
  • Add features
  • Improve documentation
  • Help others

πŸ“ž Get Help

Resources

Community

🎊 Welcome!

You're now ready to start building with ΞTHΞ›URΞ›!

Next step: Choose your path above and get started! πŸš€


Questions? Check the FAQ or ask in Discussions.

Found a bug? Open an issue.

Want to contribute? Read CONTRIBUTING.md.


Built with ❀️ by the ΞTHΞ›URΞ› team