Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guspaz0/simpledefitokenfarm
Ethereum Defi smart contracts solidity project
https://github.com/guspaz0/simpledefitokenfarm
blockchain ethereum hardhat hardhat-deployment proxy smart-contracts solidity testing web3
Last synced: 24 days ago
JSON representation
Ethereum Defi smart contracts solidity project
- Host: GitHub
- URL: https://github.com/guspaz0/simpledefitokenfarm
- Owner: guspaz0
- Created: 2024-12-22T13:01:15.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-09T03:50:12.000Z (28 days ago)
- Last Synced: 2025-01-09T04:40:36.383Z (28 days ago)
- Topics: blockchain, ethereum, hardhat, hardhat-deployment, proxy, smart-contracts, solidity, testing, web3
- Language: TypeScript
- Homepage:
- Size: 132 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple Defi Token Farm Smart Contract
Este es un proyecto final para el curso de Blockchain de la alianza de ETH-KIPU con Henry, del cual eh tenido la oportunidad de ser becado.
Para mas informacion sobre contratos de farming, sirvase este sitio:
[Cómo usar Farms (Yield Farming) en PancakeSwap](https://docs.pancakeswap.finance/products/yield-farming/how-to-use-farms)
Para inicializar el proyecto debes tener el framework hardhat instalado:
```shell
# tener Node.js instalado
npm i --save-dev hardhat web3 @nomicfoundation/hardhat-toolbox @nomicfoundation/hardhat-web3-v4
npm i @openzeppelin/contracts @openzeppelin/contracts-upgradeable
```
Comando para ayuda de hardhat:
```shell
npx hardhat help
```
---
## TokenFarm "V1"
La version "original" del Smart Contract pero modificada para ser 'upgradeable' mediante un Proxy transparente y actualizable por el contracto "Proxy Admin" del mismo.
Esta Compuesto por 5 Smart Contracts:
- DappToken: Usado para que los usuarios "stakers" puedan cobrar sus recompensas.
- LpToken:Usado para que los usuarios realizen sus depositos al Stack.
- TokenFarm: el contrato Defi en si, con la logica del negocio.
- Proxy: contrato intermediario usado para interactuar con los usuarios y la logica del negocio, es decir con el TokenFarm.
- Proxy Admin: contrato usado para actualizar el proxy con las futuras nuevas versiones de TokenFarm.
Los test estan escritos todos con Web3 y libreria Chai
Comando para correr los tests:
```shell
npx hardhat test test/TokenFarm.test.ts
```
Comando para levantar el nodo local de hardhat y deployar:
```shell
#Levantar el nodo local
npx hardhat node
#Deploy de la version 1
npx hardhat ignition deploy ignition/modules/TokenFarm.ts --network localhost
```
Esto levantara el nodo local hardhat y hara el deploy de 5 Smart Contracts:
---
## TokenFarm "V2"
Ademas de toda la funcionalidad de la V1, en este Smart Contract se agrega la posibilidad de establecer una comision "fee", aplicada sobre las recompenzas que retiran los usuarios stakers, y que el propietario pueda retirar dichas comisiones.
Comando para correr los tests:
```shell
npx hardhat test test/TokenFarmV2.test.ts
```
Comando para levantar el nodo local de hardhat y deployar:
```shell
#Levantar el nodo local
npx hardhat node
#Deploy de la version 2
npx hardhat ignition deploy ignition/modules/TokenFarmV2.ts --network localhost
```
Este comando de deploy de ignition, utiliza el deploy de la V1 y ademas deployara TokenFarmV2 y hara la llamada "upgradeAndCall" al ProxyAdmin.
---
### Variables de entorno
Es posible deployar en la blockchain real de Ethereum, previamente editando el archivo hardhat-config.js y seteando las API keys correspondientes.
Para setear variables de entorno, se recomienda usar "vars" de hardhat, ya que las guarda encriptadas,
Ejemplos de codigo:
```shell
## algunos ejemplos de variables de entorno:
npx hardhat vars set ETHERSCAN_API_KEY
npx hardhat vars set SEPOLIA_API_KEY
npx hardhat vars set ALCHEMY_API_KEY
```
Donde:
- Etherscan es un sitio para deployar y verificar smart contracts.
- Sepolia es una red de pruebas ethereum.
- Alchemy es un servicio donde se puede deployar nuestro chain (nodo con hardhat) en la blockchain.