TIPE ME es una aplicación diseñada para facilitar a los usuarios del ecosistema de NEAR la acción de dar y recibir propinas en reconocimiento a su participación en foros, creación de componentes, y otras actividades similares.
La plataforma se integra de manera sencilla en diversas plataformas a través de un botón específico, permitiendo a los usuarios expresar su aprecio y premiar a otros por su destacado trabajo.
El desarrollo de TIPE ME se enmarca en la iniciativa piloto BOS de Open Web Academy, la cual tiene como objetivo explorar las diversas oportunidades que ofrece la tecnología de BOS.
Cabe destacar que TIPE ME está construido exclusivamente utilizando componentes de BOS, lo que asegura una integración coherente y eficiente en el entorno NEAR.
TIPE está hecho en su totalidad con componentes de BOS
FRONT END
El FrontEnd está diseñado cómo una landing page minimalista hecho con componentes hechos de 0 basado en la documentación de Bootstrap y con otros componentes de la biblioteca de componentes de BOS.
Componentes de la interfaz
La interfaz cuenta con un navbar, un par de cajas con sombras que permiten al puedes enviar las donaciones y visualizar el registro de los ultimos 5 donantes
El landing se puede referenciar en este archivo Y los componentes se pueden ver por partes en la carpeta de componentes de este repositorio.
Este documento proporciona información sobre el backend del contrato inteligente diseñado para gestionar donaciones en la red de prueba Aurora, adaptado para la certificación BOS en Open Web Academy.
El contrato inteligente es un adaptación de donación, permitiendo registrar la sección de blog o post que recibió la donación en lugar de simplemente un café.
**getCoffeeLog**
- Descripción: Retorna las últimas 5 donaciones realizadas, incluyendo detalles como la marca de tiempo, título, remitente, nombre, mensaje y calificación.
- Tipo de retorno: Array de estructuras
Coffee.
**getCoffeeQTY**
- Descripción: Retorna la cantidad total de donaciones realizadas.
- Tipo de retorno: Entero (uint256).
**donateCoffee**
- Descripción: Método principal que permite realizar una donación, registrando la sección de blog o post que recibirá la donación.
- Parámetros:
_title: Título de la sección de blog o post.destination: Dirección del destinatario de la donación._name: Nombre del remitente._message: Mensaje asociado a la donación._rating: Calificación de la donación.
- Requiere: La cantidad de la donación debe ser mayor a 0.
El contrato permite donar fondos a una dirección específica, registrando la información de la donación y limitando el registro a las últimas 5 donaciones.
La integración con BOS se realiza mediante Ether.js para facilitar la comunicación entre el frontend y el contrato inteligente. Se utilizan las funciones getCoffeeLog y getCoffeeQTY para lecturas, y donateCoffee para realizar una donación.
# Documentación Desglosada del Contrato Inteligente para Donaciones
A continuación se presenta un desglose línea por línea del contrato inteligente para donaciones, adaptado para la certificación BOS en Open Web Academy.
```solidity
// Contrato adaptado para BOS certification en Open Web Academy
// Adaptación de donación con registro de la sección de blog o post
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.19;
contract Forwarder {
uint8 ratingIndex = 0; // Índice para agregar la última donación
uint256 coffeeQTY = 0; // Cantidad de donaciones hechas
// Estructura básica de la donación
struct Coffee {
uint256 timestamp;
string title;
address sender;
string name;
string message;
uint8 rating;
}
// Sólo se guardan las últimas 5 donaciones
Coffee[5] coffeeLog;
// Retorno de las últimas 5 donaciones
function getCoffeeLog() public view returns (Coffee[5] memory) {
return coffeeLog;
}
// Retorno de la cantidad de donaciones hechas
function getCoffeeQTY() public view returns (uint256) {
return coffeeQTY;
}
// Donación, por parámetro se reenvía el fondo enviado a la dirección indicada
function donateCoffee(
string memory _title,
address destination,
string memory _name,
string memory _message,
uint8 _rating
) public payable {
require(
msg.value > 0,
"Please send the quantity of a coffee or a little more :)"
);
if (ratingIndex > 4) {
ratingIndex = 0;
}
coffeeLog[ratingIndex] = Coffee(
block.timestamp,
_title,
msg.sender,
_name,
_message,
_rating
);
address payable owner = payable(destination);
(bool success, ) = owner.call{value: msg.value}("");
require(success == true, "Donation unsuccessful :(");
coffeeQTY = coffeeQTY + 1;
ratingIndex = ratingIndex + 1;
}
}
Este ABI describe las tres funciones principales del contrato inteligente: donateCoffee, getCoffeeLog, y getCoffeeQTY. Puedes utilizar este ABI junto con lib ethers para interactuar con el contrato desde el frontend y realizar operaciones como hacer donaciones, obtener el registro de donaciones y la cantidad total de donaciones realizadas. Si tienes alguna pregunta o inquietud, no dudes en preguntar. ¡Gracias por tu interés en el contrato inteligente para donaciones!
