Welcome to ΞTHΞURΞ! This guide will help you get started in just a few minutes.
- 5 minutes of your time
- Computer with macOS, Linux, or Windows (WSL)
- Internet connection
- Modern browser (Chrome, Safari, Edge, or Firefox)
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
Best for: First-time users who want to see it working ASAP
π Follow QUICKSTART.md
Best for: Developers who want to understand everything
π Follow DEPLOYMENT.md
Best for: Contributors who want to modify the code
π Follow CONTRIBUTING.md
# Install Foundry
curl -L https://foundry.paradigm.xyz | bash
foundryup
# Install Node.js (if not already installed)
# Visit https://nodejs.org/git clone https://github.com/yourusername/ethaura.git
cd ethaura
./scripts/setup.sh# Edit .env with your settings
cp .env.example .env
nano .env# Deploy to Sepolia
make deploy-sepolia# Start the demo
make frontend- Open http://localhost:3000
- Create a passkey
- Deploy an account
- Send a transaction
- README.md - Project overview
- QUICKSTART.md - 5-minute guide
- FAQ.md - Common questions
- ARCHITECTURE.md - Technical design
- PROJECT_STRUCTURE.md - Code organization
- CONTRIBUTING.md - How to contribute
- DEPLOYMENT.md - Deployment guide
- SECURITY.md - Security considerations
- CHANGELOG.md - Version history
- SUMMARY.md - Project summary
- Read README.md
- Follow QUICKSTART.md
- Try the demo
- Read FAQ.md
- Read ARCHITECTURE.md
- Review smart contracts
- Run tests locally
- Explore frontend code
- Read DEPLOYMENT.md
- Deploy your own instance
- Modify contracts
- Contribute improvements
# 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 commandsAccount 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
P-256 (secp256r1) is a cryptographic curve widely supported by:
- Hardware security modules
- Secure enclaves (Touch ID, Face ID)
- WebAuthn/Passkeys
- TPM chips
EIP-7951 adds a precompile for P-256 signature verification, making it:
- Gas-efficient (~6,900 gas)
- Native to Ethereum
- Available on Sepolia testnet
Passkeys are a modern authentication method that:
- Use biometrics (fingerprint, face)
- Store keys in secure hardware
- Work across devices
- Replace passwords
Solution: Install the required tool
- Foundry: https://getfoundry.sh/
- Node.js: https://nodejs.org/
Solution: Check you're on the right network
forge test --fork-url $SEPOLIA_RPC_URLSolution: Install dependencies
cd frontend
npm install
npm run devSolution: Check your .env file
- Valid RPC URL
- Funded private key
- Correct network
All common commands are in the Makefile:
make helpError messages usually tell you exactly what's wrong.
Most questions are answered in the docs.
- GitHub Discussions
- Discord community
- Open an issue
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
- Try different features
- Read the code
- Experiment with modifications
- Study the architecture
- Understand the flow
- Read EIP-7951 and ERC-4337
- Create your own dApp
- Add new features
- Integrate with other protocols
- Fix bugs
- Add features
- Improve documentation
- Help others
- π Documentation
- π¬ GitHub Discussions
- π Report Issues
- Discord: discord.gg/ethaura
- Twitter: @ethaura
- Email: hello@ethaura.example.com
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