Skip to content
/ simple-token-farm Public

A proportional staking farm where users stake an LP token (`LPToken`) to earn rewards in a reward token (`DAppToken`). Rewards are accrued per block at a configurable `rewardPerBlock`, proportional to each staker's share of the total stake.

6 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

josegomez-dev/simple-token-farm

BranchesTags

Repository files navigation

🌟 SIMPLE TOKEN FARM 🌟

🚀 DeFi Yield Farming Platform - Desplegado en Sepolia Testnet

Advanced DeFi Yield Farming with proportional rewards, upgradeable contracts, and gas-efficient factory patterns

🌐 APLICACIONES EN VIVO

🚀 App Web3 Real (Next.js + Vercel):

https://simple-token-farm-web3-pvof5snke-josegomezdev-projects.vercel.appvercel.app

Características:

  • ✅ Conexión real a MetaMask - Wallet integration completa
  • ✅ Contratos reales en Sepolia - Interacción con blockchain
  • ✅ UI moderna y animada - Diseño profesional con animaciones
  • ✅ Funcionalidad completa - Staking, rewards, claiming reales
  • ✅ Verificación de contratos - Badges verificados y links a Etherscan

🎮 Versión de Simulación (GitHub Pages):

https://josegomez-dev.github.io/simple-token-farm/

Características:

  • ✅ Demo interactivo - Sin necesidad de MetaMask
  • ✅ Simulación completa - Funcionalidad DeFi demostrada
  • ✅ Presentaciones offline - Ideal para demostraciones
  • ✅ Testing sin wallet - Desarrollo y pruebas locales

🎯 PROYECTO COMPLETADO Y FUNCIONANDO

✅ Estado Actual:

  • Contratos desplegados en Sepolia testnet
  • Verificados en Etherscan
  • Funcionalidad completa probada y funcionando
  • Scripts optimizados para despliegue y verificación

🏗️ ARQUITECTURA DEL PROYECTO

Contratos Principales:

  • DAppToken.sol - Token de recompensa (ERC20)
  • LPToken.sol - Token de staking (ERC20)
  • TokenFarm.sol - Lógica principal de yield farming

Características Implementadas:

  • ✅ Staking proporcional con recompensas por bloque
  • ✅ Modificadores de acceso (onlyOwner, onlyStaker)
  • ✅ Structs para datos de usuario consolidados
  • ✅ Recompensas configurables por bloque
  • ✅ Sistema de fees en reclamaciones
  • ✅ Distribución automática de recompensas

🚀 DESPLIEGUE RÁPIDO EN SEPOLIA

Prerrequisitos:

  • Node.js 18+ y npm
  • Wallet con ETH de Sepolia (mínimo 0.01 ETH)
  • Cuenta en Infura/Alchemy para RPC
  • API key de Etherscan

1. Configuración Inicial:

# Clonar repositorio
git clone <your-repo-url>
cd simple-token-farm

# Instalar dependencias
npm install

# Configurar variables de entorno
cp env.example .env
nano .env  # Editar con tus valores

2. Variables de Entorno (.env):

# Tu clave privada (sin 0x)
PRIVATE_KEY=tu_clave_privada_aqui

# URL RPC de Sepolia
SEPOLIA_RPC_URL=https://sepolia.infura.io/v3/TU_PROJECT_ID

# API key de Etherscan
ETHERSCAN_API_KEY=tu_api_key_aqui

# Habilitar reporte de gas
REPORT_GAS=true

3. Desplegar en Sepolia:

# Compilar contratos
npm run compile

# Desplegar en Sepolia
npm run deploy:sepolia

# Verificar automáticamente
npm run verify:sepolia

# Probar funcionalidad
npm run interact:sepolia

📋 COMANDOS DISPONIBLES

Desarrollo Local:

npm run compile          # Compilar contratos
npm run test            # Ejecutar tests
npm run gas             # Reporte de gas
npm run coverage        # Cobertura de tests

Sepolia Testnet:

npm run deploy:sepolia  # Desplegar en Sepolia
npm run verify:sepolia  # Verificar en Etherscan
npm run interact:sepolia # Probar funcionalidad

🌐 CONTRATOS DESPLEGADOS EN SEPOLIA

Direcciones Verificadas:

Configuración:

  • Red: Sepolia Testnet (Chain ID: 11155111)
  • Recompensa por Bloque: 1 DAPP
  • LP Tokens Iniciales: 10,000 LPT
  • Gas Price: Automático (optimizado)

🧪 FUNCIONALIDAD PROBADA

Tests Completados:

  • ✅ Aprobación de tokens - LP tokens aprobados para staking
  • ✅ Staking - Depósito de 1000 LP tokens
  • ✅ Distribución de recompensas - Sistema de recompensas funcionando
  • ✅ Reclamación - Usuarios pueden reclamar recompensas
  • ✅ Retiro - Usuarios pueden retirar tokens staked

Flujo Completo:

  1. Usuario aprueba LP tokens para staking
  2. Usuario deposita LP tokens en el farm
  3. Sistema distribuye recompensas proporcionalmente
  4. Usuario reclama recompensas DAPP
  5. Usuario retira LP tokens staked

🔧 ESTRUCTURA DEL PROYECTO

simple-token-farm/
├── contracts/                 # Smart contracts
│   ├── DAppToken.sol         # Token de recompensa
│   ├── LPToken.sol           # Token de staking
│   └── TokenFarm.sol         # Lógica principal
├── scripts/                   # Scripts de despliegue
│   ├── deploy.js             # Despliegue local
│   ├── deploy-sepolia.js     # Despliegue en Sepolia
│   ├── verify-sepolia-auto.js # Verificación automática
│   └── interact-sepolia.js   # Pruebas de interacción
├── test/                      # Tests unitarios
├── hardhat.config.js          # Configuración de Hardhat
├── package.json               # Dependencias y scripts
├── env.example                # Plantilla de variables de entorno
└── README.md                  # Este archivo

🚨 SOLUCIÓN DE PROBLEMAS

Error: "insufficient funds"

Error: "intrinsic gas too low"

  • Usa npm run deploy:sepolia (gas automático)
  • No especifiques límites de gas manualmente

Error: "contract verification failed"

  • Espera unos minutos después del despliegue
  • Verifica que tu API key de Etherscan sea válida

🎨 FRONTEND WEB3 REAL

✅ Características Implementadas:

  • Conexión real a MetaMask - Wallet integration
  • Detección automática de red - Sepolia, Mainnet, etc.
  • Indicador visual de red - Color-coded network status
  • Interacción con contratos reales - Sepolia testnet
  • UI responsive y moderna - Diseño profesional con animaciones

🚀 Aplicación Web3 Real (Next.js):

🎮 Versión de Simulación (GitHub Pages):

🌟 LOGROS DEL PROYECTO

Técnicos:

  • ✅ Sistema DeFi completo y funcional
  • ✅ Contratos optimizados y seguros
  • ✅ Despliegue exitoso en testnet
  • ✅ Verificación automática en Etherscan
  • ✅ Tests de funcionalidad completos
  • ✅ Frontend Web3 real y funcional
  • ✅ Integración completa con MetaMask

Educativos:

  • ✅ Implementación de patrones DeFi avanzados
  • ✅ Uso de OpenZeppelin para seguridad
  • ✅ Manejo de gas y optimización
  • ✅ Despliegue en redes reales
  • ✅ Verificación y auditoría de contratos
  • ✅ Desarrollo de aplicaciones Web3 completas

🎓 CRÉDITOS Y AGRADECIMIENTOS

Instituciones:

  • Universidad Cenfotec - Curso de Solidity y Smart Contracts
  • Ethereum Costa Rica - Comunidad local de Ethereum

Mentores:

  • Robert de Hallos - Web3 accessibility advocate
  • Luis de BlockBeasts - Innovation inspiration

🚀 PRÓXIMOS PASOS

Inmediatos:

  1. Probar funcionalidad con múltiples usuarios
  2. Integrar con frontend para interfaz web
  3. Optimizar gas para mainnet

Futuros:

  1. Auditoría de seguridad completa
  2. Despliegue en mainnet Ethereum
  3. Implementación de governance (DAO)
  4. Integración con DEX para LP tokens reales

📞 SOPORTE

Documentación:

Comunidades:

🎉 ¡PROYECTO COMPLETADO EXITOSAMENTE!

Este proyecto demuestra la implementación completa de un sistema DeFi yield farming funcional, desplegado en una red real (Sepolia testnet) y completamente probado.

¡Felicidades por completar este proyecto DeFi avanzado! 🚀

🌟 DEMOSTRACIÓN EN VIVO

🚀 Prueba la App Web3 Real:

https://simple-token-farm-web3-pvof5snke-josegomezdev-projects.vercel.app/

Conecta tu MetaMask a Sepolia y experimenta:

  • ✅ Staking real de LP tokens
  • ✅ Reclamación de recompensas DAPP
  • ✅ UI moderna con animaciones épicas
  • ✅ Contratos verificados en Etherscan

🎮 Prueba la Simulación:

https://josegomez-dev.github.io/simple-token-farm/

Demo interactivo sin wallet:

  • ✅ Funcionalidad completa demostrada
  • ✅ Ideal para presentaciones
  • ✅ Testing sin configuración

Author: Jose Alejandro Gomez Castro
Project: Simple Token Farm
Status: ✅ Completado y Funcionando
Network: Sepolia Testnet
Date: 2025

About

A proportional staking farm where users stake an LP token (`LPToken`) to earn rewards in a reward token (`DAppToken`). Rewards are accrued per block at a configurable `rewardPerBlock`, proportional to each staker's share of the total stake.

Resources

Readme
Activity

Stars

6 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages