fccoelho / fccoelho/Curso_Blockchain

Entrega da A1: Depósito de tokens para remuneração de revisores (Dpublish)

Open
#45 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
HTML
Stars
204
Forks
55
PR merge metrics
No merged PRs in 30d

Description

# Plano de trabalho - Depósito de tokens para remuneração de revisores (Dpublish)

### Introdução
Esse arquivo tem por objetivo documentar o plano de trabalho de desenvolvimento de método(s) para depósito de tokens para remuneração de revisores na plataforma [Dpublish](https://github.com/fccoelho/Dpublish).

### Estratégia
A lógica básica para o processo de revisão é: após sucessivos ciclos de sugestões (dadas pelo revisor) e correções dadas pelo autor, o artigo fica em um estágio intermediário, aguardando que a revisão feita seja classificada por um número mínimo de outros revisores, editores, autores e até leitores em geral (que possuam um papel mínimo no sistema que permita realizar essa revisão).
Se essa classificação for acima de um classificação mínima, então o revisor recebe sua remuneração através de tokens ERC-721. Esse token irá conter a classificação que a revisão feita recebeu.

Dessa forma, será implementado um método que deve:
- Identificar qual classificação uma determinada revisão recebeu;
- Identificar que essa classificação foi acima da classificação mínima. Se não, o método não retornará tokens.
- Depositar ao agente _revisor_ tokens ERC-721, de forma proporcional a classificação recebida.

O método será implementado no contrato _ReviewToken.sol_.

Os testes unitários para esse contrato serão implementados em Javascript em um novo arquivo _ReviewToken.test.js_ no pacote _test_.

### Requisitos
Como requisitos, deveremos ter:
- Definição da classificação mínima para o artigo receber status de aprovado.
- Conhecimento acerca de contratos com padrões ERC-721.

### Cronograma
- 25/09 - Entrega do plano de trabalho.
- (01/10 a 15/10) - Estudos acerca de contratos no padrão ERC-721.
- (15/10 a 29/10) - Implementação do método em _ReviewToken.sol_.
- (31/10 a 05/11) - Validação da lógica desenvolvidada e resolução de possíveis débitos com colegas e professor.
- (07/11 a 20/11) - Implementação dos testes unitários e possíveis outros testes funcionais ou _end-to-end_ que possam existir, incluindo suas correções.
- (21/11 a 28/11) - A2: entrega do trabalho.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading ReviewToken.sol and the repository's existing contract and test structure to understand how review ratings, the minimum approval rating, and ERC-721 tokens are represented. Create the named test/ReviewToken.test.js test file and use it to verify that qualifying reviews pay the reviewer proportionally, while reviews below the threshold receive no tokens.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, solidity
Domain
blockchain, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.