Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thomgabriel committed Nov 22, 2023
1 parent 6f48470 commit 24e1317
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
34 changes: 26 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,33 @@
# Basic Sample Hardhat Project
# Lyra Loans 🌌🔭
[![Lint](https://github.com/pollum-io/lyra-contracts/actions/workflows/lint.yml/badge.svg)](https://github.com/pollum-io/lyra-contracts/actions/workflows/lint.yml)
[![Tests](https://github.com/pollum-io/lyra-contracts/actions/workflows/tests.yml/badge.svg)](https://github.com/pollum-io/lyra-contracts/actions/workflows/tests.yml)

This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts.
<p align="center"> <img src="img/lyra.png" width="300" alt="Lyra Loans"> </p>

Try running some of the following tasks:
## Overview
O Lyra Loans é um protocolo de empréstimos descentralizado desenvolvido para o HACKATHON: Web3 – Tokenização do Tesouro Nacional.

O protocolo permite que instituições depositem títulos públicos como garantia para tomar empréstimos em DREX de forma sobrecolateralizada. Os usuários podem emprestar seu DREX nessas pools para obter rendimentos lastreados nesses títulos.

## Contratos
Breve explicação sobre os contratos

## Quick Start
Primeiro, clone o repositório e instale as dependências:
```shell
git clone https://github.com/pollum-io/lyra-contracts
cd lyra-contracts
yarn install
```

Para compilar os contratos:
```shell
npx hardhat accounts
npx hardhat compile
npx hardhat clean
```
Isso irá gerar os arquivos compilados na pasta artifacts.

Para executar os testes:
```shell
npx hardhat test
npx hardhat node
node scripts/sample-script.js
npx hardhat help
```
Os testes executarão uma instância local da blockchain e testarão os contratos nessa rede de teste temporária.
Binary file added img/lyra.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 24e1317

Please sign in to comment.