Contratos escritos en solidity para el proyecto MetaPool. Siempre puedes comprobar el código original de MetaPool en GitHub y también revisar toda su información en su documentación.

PD. Este código es una modificación de ETH Volcano hacia el SDK de mpETH de Meta Pool para facilitar la interacción con el SDK y también desde el proyecto "mpBOT" del hackathon de Frutal Web House hicimos algunas modificaciones para que se pudieran desplegar con éxito los contratos en Sepolia Testnet.

Los principales cambios fueron:

• Copiar el archivo env sample y convertirlo en un .env agregando las variables de entorno NETWORK, RPC_ENDPOINT, ETHERSCAN_API_KEY, con su respectivo valor Sepolia, RPC de ALchemy y API KEY de Etherscan.
• En el contrato Withdrawal.sol quité/comenté toda la función completeWithdraw.

Comandos para interactuar (Windows):

• Compilar: npx hardhat compile
• Desplegar: npx hardhat run scripts/deploy.ts --network $NETWORK sepolia
• Verificar: npx hardhat verify --network $NETWORK sepolia
• Verificar contrato individual: npx hardhat verify --network $NETWORK sepolia {address del contrato}

Si es necesario desde Etherscan los contratos Proxy se deben verificar y guardar en la zona de contract, more options y en "its a proxy?".

• Introducción
• Contratos Desplegados en Sepolia
  • StakingProxy
  • StakingImpl
  • LiquidUnstakePoolProxy
  • LiquidUnstakePoolImpl
  • WithdrawalProxy
  • WithdrawalImpl
• Descripción de Contratos
  • Staking
  • LiquidUnstakePool
• Instalacion de dependencias
• Compilar contratos
• Configurar MNEMONIC
• Seguridad MNEMONIC
• Personalizando config MNEMONIC
• Configuración archivos .env
• Modificación de Contratos
• Comandos

Este proyecto está desarrollado bajo el contexto de la Hackathon de ETH Volcano, en el track de creación de contenido.

Podrás encontrar las instrucciones en este repositorio y en el repositorio del front-end. En el que se utiliza Scaffold-Eth para poder interactuar con los contratos.

El propósito del proyecto es poder explicar cómo funciona el proyecto MetaPool a nivel conceptual y también interactuar con los contratos para los desarrolladores que quieran entender cómo funciona el protocolo a nivel de contratos. Con el objetivo de tener los conocimientos para construir un proyecto sobre MetaPool.

El video consta de lo siguiente:

• Introducción a MetaPool y conceptos como PoS, Liquid Staking.
• Modificación, despliegue y verificación de contratos.
• Verificación de contratos Proxy y su respectiva implementación.
• Desarrollo de un Front-End para realizar las funciones de: stake, unstake, delayed unstake y stake en la liquidity pool.

Producto Metapool para apostar en Ethereum y recibir a cambio mpETH.

Permite a los usuarios apostar ETH o WETH, canje instantáneo de mpETH (con una pequeña tarifa) o canje retrasado (de 1 a 7 días) y agregar liquidez con ETH o WETH (para canje instantáneo).

A continuación se detalla una descripción breve de las funciones que cumplen cada uno de los contratos dentro del protocolo.

Contrato principal responsable de gestionar el staking de ETH/WETH y el canje de mpETH.

Pool de liquidez que permite a los usuarios intercambiar inmediatamente mpETH por ETH, sin ningún retraso pero con una pequeña comisión. Además, los usuarios pueden proporcionar liquidez con ETH o WETH. Este ETH se convertirá lentamente en mpETH a través de intercambios y el contrato de Staking también puede usar este ETH (con algunas limitaciones) para crear nuevos validadores, minteando nuevo mpETH para los proveedores de liquidez.

Gestiona el canje retrasado de mpETH de los usuarios. Envía ETH de las recompensas y desmonta a los validadores a los usuarios. Los usuarios solicitan el retiro en el contrato de Staking y, un epoch después (una semana), completan el retiro en este contrato.

El primer paso en nuestro proyecto será instalar las dependencias del proyecto. Para ello ejecutamos

yarn

Lo primero que deberíamos probar es la compilación de los contratos. El proyecto está configurado de manera tal que utilica la frase MNEMONIC para la compilación y despliegue de contratos.

Para compilar los contratos con éxito, es necesario configurar el MNEMONIC. Esto debe almacenarse en un archivo de texto siguiendo la ruta específica: ~/.config/mp-eth-mnemonic.txt. Esta configuración es crucial para el correcto funcionamiento del archivo de configuración de Hardhat (hardhat.config.ts). Sin esta configuración, ejecutar el comando npm run compile resultará en un error.

Nota: Se recomienda mantener el MNEMONIC fuera del proyecto para prevenir su exposición. En sistemas basados en UNIX/LINUX, es común almacenar valores de configuración sensibles en una carpeta .config en la raíz del servidor o en el directorio del usuario. Esto ayuda a centralizar de manera segura la configuración de seguridad.

Si lo prefieres, tienes la opción de modificar cómo se carga el MNEMONIC en el proyecto. Por defecto, el MNEMONIC se lee del archivo ~/.config/mp-eth-mnemonic.txt mencionado anteriormente, pero puedes cambiar esto para que se lea de una variable de entorno en su lugar. Para hacer esto, sigue los siguientes pasos:

1. Localiza el siguiente código

const mnemonic = fs.readFileSync(path.join(os.homedir(), ".config/mp-eth-mnemonic.txt")).toString()

en el archivo lib/env.ts.

2. Reemplaza el código del paso 1 por lo siguiente:

   const mnemonic = process.env.MNEMONIC

3. En el archivo .env debes agregar

   MNEMONIC="TU FRASE SEMILLA"

Nota: El archivo .env no está creado, debes crearlo por tu cuenta, siguiendo la estructura del archvivo .env.sample.

Este proyecto utiliza múltiples archivos .env

• .env para variables comunes a todas las redes
• .env.<network> para variables específicas de cada red

Para pruebas con cuentas generadas por hardhat el archivo .env solo requiere:

NETWORK="Red utilizada para todos los comandos"

Si NETWORK no está configurado, hardhat intentará usar la red Sepolia.

Para producción necesitarás variables adicionales. Consulta el archivo .env.sample para ver toda la lista de variables.

Además de esto, cada red requiere un archivo .env.<network> con las siguientes variables:

RPC_ENDPOINT="RPC endpoint URL"
BLOCK_NUMBER="Block number to fork"

Nota: Esta sección ha sido traducida pero cómo verás en el video no es necesario tenerla en cuenta.

Las siguientes modificaciones solo han sido hechas por motivos educativos, para poder probar las distintas funcionalidades del protocolo sin ningún inconveniente.

En el contrato Withdrawal.sol busca la función requestWithdraw.

Tenemos algunos comentarios dentro de la función indicando el código original y el código modificado con propósitos educativos. En el video podrás ver y comprender el porqué de estas modificaciones.

Verás el siguiente código. Quedémonos con el resultado final, esto nos permitirá solicitar el delayed withdraw sin problemas.

uint256 unlockEpoch = currentEpoch + 1; // Código Original

uint256 unlockEpoch = currentEpoch; // Modificación con propósitos educativos

Resultado final

//uint256 unlockEpoch = currentEpoch + 1; // Código Original
uint256 unlockEpoch = currentEpoch; // Modificación con propósitos educativos

Cuando veas el video también notarás lo siguiente. Dejé pendiente el completeWithdraw, y les propuse que revisaran el código y lo hicieran por ustedes mismos.

El proceso de delayedUnstake realiza una solicitud y cuando hayan transcurrido los epochs correspondientes se podrá completar el withdraw. De igual manera si quieres hacer una prueba de concepto y poder finalizar el proceso, puedes comentar las siguientes líneas en el contrato Withdrawal.

uint256 unlockTime = getEpochStartTime(_withdrawR.unlockEpoch) + validatorsDisassembleTime;
if (block.timestamp < unlockTime) revert ClaimTooSoon(unlockTime);

Nota: Todos los comandos también compilan los contratos.

npm run compile

npm test

Para desplegar los contratos en una red determinada debes tener en cuenta lo siguiente:

En la ruta lib/constants/network encontrarás archivos con nombres de algunas redes. Dentro de estos archivos existen algunos valores que debes configurar para el correcto despliegue de los contratos.

Desplegaremos los contratos en sepolia, y este archivo ya existe, pero si quisieras desplegarlos en alguna otra red, debes crear el archivo con el nombre de la red en esta misma ruta y adicionalmente agregar la configuración dentro del archivo hardhat.config.ts.

Nota: Dentro del archivo .env debes tener configurado la url del nodo en la variable RPC_ENDPOINT

npm run deploy <network>

npm run verify <network>

TARGET=Staking npm run upgrade <network>

npm run transfer_to_multisig <network>

Esto solo transfiere el permiso de administrador para actualizar las implementaciones de los contratos, no el ADMIN_ROLE.