El repositorio de Smart Contracts de NFTs es parte del ecosistema de Galdappagos, una iniciativa que busca incentivar las donaciones a las Islas Galápagos utilizando tecnología blockchain y tokens no fungibles (NFTs).
Este repositorio contiene los contratos inteligentes que permiten la emisión, transferencia y gestión de NFTs vinculados a donaciones específicas. Los NFTs representan activos digitales únicos que pueden ser adquiridos por los donantes como recompensa por su contribución a la conservación de las Islas Galápagos. Las contribuciones se esperan que, en algún futuro, puedan estar directamente relacionadas con entidades u organizaciones sin fines de lucro existentes que cuentan con experiencia y apoyo previo al desarrollo de este proyecto.
- 📄 Descripción
- 💡 Contratos Inteligentes
- 🆔 Galdappagos
- 🆔 UserRegistry
- 🆔 Donation
- 🆔 Organization
- 📖 Uso
- 🌟 Ejemplos de Uso
- 🚀 Desarrollo
- 🤝 Contribución
- ✔️ Pruebas
- 📡 Despliegue
- 📜 Licencia
- 👤 Autor
- 🙏 Agradecimientos
Galdappagos es un proyecto basado en blockchain cuyo objetivo principal es la creación de una plataforma transparente y segura que le permita a sus usuarios donar directamente desde su billetera (concepto wallet de Web3) la cantidad que desse de criptomonedas o dinero tradicional para la conservación de las Islas Galápagos. A diferencia de páginas tradicionales de crowdfunding, esta propuesta le permitirá a sus donantes recibir NFT's como una recompensa y prueba tangible de su apoyo a la casua, incentivando así su constante y activa participación.
Dentro de este repositorio, se encuentran los contratos inteligentes que darán pie a la implementación de la plataforma. Estos siguen los estándares ERC721 y emplean la biblioteca OpenZeppelin con el fin de garantizar la funcionalidad y seguridad estándar esperada de los NFT's emitidos. Así mismo, se incluyen ejemplos y/o desarrollo completo de las pruebas unitarias correspondientes a cada componente de software.
Contrato inteligente que implementa un token no fungible (NFT) utilizando el estándar ERC721 de OpenZeppelin.
Este contrato permite la emisión segura de nuevos tokens NFT a través de la función safeMint, restringida únicamente al propietario del contrato. Además, hereda y utiliza varios contratos base de OpenZeppelin, como ERC721, ERC721Enumerable y ERC721URIStorage, para proporcionar funcionalidades adicionales relacionadas con la enumeración de tokens y el almacenamiento de metadatos URI.
El contrato también incluye funciones de anulación requeridas por Solidity para personalizar el comportamiento en ciertos casos, como antes de transferir tokens (_beforeTokenTransfer), durante la eliminación de un token (_burn), para obtener la URI de un token específico (tokenURI), y para verificar la compatibilidad de interfaces (supportsInterface).
El Smart Contract "Galdappagos" tiene las siguientes dependencias importadas desde la biblioteca de contratos de OpenZeppelin:
- ERC721: Contrato base que implementa el estándar ERC721 para tokens no fungibles.
- ERC721Enumerable: Contrato que extiende ERC721 y proporciona funcionalidad adicional para la enumeración de tokens.
- ERC721URIStorage: Contrato que extiende ERC721 y agrega capacidad para almacenar y recuperar metadatos URI para cada token.
- Ownable: Contrato que proporciona funcionalidad de control de acceso restringida al propietario del contrato.
- Counters: Biblioteca utilizada para llevar un registro del contador de tokens.
Estas dependencias se importan mediante las siguientes instrucciones de importación:
import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/token/ERC721/extensions/ERC721Enumerable.sol";
import "@openzeppelin/contracts/token/ERC721/extensions/ERC721URIStorage.sol";
import "@openzeppelin/contracts/access/Ownable.sol";
import "@openzeppelin/contracts/utils/Counters.sol";A continuación, se detallan los pasos y requisitos necesarios para configurar y utilizar el contrato inteligente:
- Versión de Solidity: El contrato inteligente Galdappagos está desarrollado en Solidity y requiere una versión igual o superior a 0.8.9.
-
Clona el repositorio de los smart contracts de Galdappagos en tu entorno local.
-
Asegúrate de tener instalado el entorno de desarrollo de Ethereum, que incluye el compilador de Solidity (solc) y el entorno de ejecución de Ethereum (por ejemplo, Ganache o una red de prueba de Ethereum).
-
Abre el archivo del contrato inteligente Galdappagos.sol en tu editor de código preferido.
-
Asegúrate de tener todas las dependencias requeridas instaladas. El contrato inteligente Galdappagos importa diferentes contratos de la biblioteca OpenZeppelin, por lo que debes asegurarte de tener instalada la biblioteca y sus dependencias. Puedes instalar las dependencias ejecutando el siguiente comando en la terminal:
npm install @openzeppelin/contracts- Realiza las modificaciones necesarias en el contrato inteligente según tus requisitos específicos. Puedes ajustar los nombres y símbolos del token, así como personalizar las funcionalidades adicionales según tus necesidades.
Contrato inteligente que permite el registro de un nuevo usuario a la plataforma a través de la relación de su perfil y su billetera -wallet-.
Este contrato maneja el registro de un usuario nuevo, así como la asociación de su billetera con su cuenta. Almacena la información pertinente (dirección de la billetera, y nombre de perfil). De igual forma, valida que las wallet sean completamente única por usuario al revisar si una dirección ya está asociada a alguna cuenta.
A continuación, se detallan los pasos y requisitos necesarios para configurar y utilizar el contrato inteligente:
- Versión de Solidity: El contrato inteligente Galdappagos está desarrollado en Solidity y requiere una versión igual o superior a 0.8.9.
-
Clona el repositorio de los smart contracts de Galdappagos en tu entorno local.
-
Asegúrate de tener instalado el entorno de desarrollo de Ethereum, que incluye el compilador de Solidity (solc) y el entorno de ejecución de Ethereum (por ejemplo, Ganache o una red de prueba de Ethereum).
-
Abre el archivo del contrato inteligente UserRegistry.sol en tu editor de código preferido.
-
Realiza las modificaciones necesarias en el contrato inteligente según tus requisitos específicos.
Contrato inteligente que regula/realiza las transacciones de activos (cripto o monedas tradicionales) a la causa.
Este contrato se maneja el proceso de donación de un usuario hacia la causa de las Islas Galápagos. Concretamente, almacena la información de la doncación (cantidad donada y el perfil del donante) y distribuye, a partir del contrato Galdappagos, los NFT a los usuarios.
Tener en el mismo directorio el archivo Galdappagos.sol que DonationContract.sol para poder correctamente realizar el proceso:
// Import esto importa a Galdappagos.sol como un símbolo global en el archivo
import * as NFT_Emition_Process from "./Galdappagos.sol";
A continuación, se detallan los pasos y requisitos necesarios para configurar y utilizar el contrato inteligente:
- Versión de Solidity: El contrato inteligente Galdappagos está desarrollado en Solidity y requiere una versión igual o superior a 0.8.9.
-
Clona el repositorio de los smart contracts de Galdappagos en tu entorno local.
-
Asegúrate de tener instalado el entorno de desarrollo de Ethereum, que incluye el compilador de Solidity (solc) y el entorno de ejecución de Ethereum (por ejemplo, Ganache o una red de prueba de Ethereum).
-
Abre el archivo del contrato inteligente Donation.sol en tu editor de código preferido.
-
Realiza las modificaciones necesarias en el contrato inteligente según tus requisitos específicos.
Contrato inteligente que funje como la organización. Éste regula/realiza el proceso de registro de usuarios y donaciones.
Este contrato sirve como el eje central de la aplicación ya que controla los procesos de registro de usuarios y donativos hacia la causa.
Tener en el mismo directorio los archivos Donations.sol y UserRegistry.sol que Organization.sol para poder correctamente realizar el proceso:
// Import esto importa ambos archivos como un símbolo global en el archivo
import * as Donation_Process from "./Donations.sol";
import * as Registry_Process from "./UserRegistry.sol";
A continuación, se detallan los pasos y requisitos necesarios para configurar y utilizar el contrato inteligente:
- Versión de Solidity: El contrato inteligente Galdappagos está desarrollado en Solidity y requiere una versión igual o superior a 0.8.9.
-
Clona el repositorio de los smart contracts de Galdappagos en tu entorno local.
-
Asegúrate de tener instalado el entorno de desarrollo de Ethereum, que incluye el compilador de Solidity (solc) y el entorno de ejecución de Ethereum (por ejemplo, Ganache o una red de prueba de Ethereum).
-
Abre el archivo del contrato inteligente Donation.sol en tu editor de código preferido.
-
Realiza las modificaciones necesarias en el contrato inteligente según tus requisitos específicos.
Para hacer uso/pruebas de cada uno de los contratos presentados, es necesario seguir las siguientes instrucciones:
-
Compila el contrato inteligente utilizando el compilador de Solidity. Puedes utilizar herramientas como Truffle o Remix para compilar el contrato.
-
Despliega el contrato inteligente en una red de prueba de Ethereum o en la red principal. Asegúrate de contar con los fondos necesarios para realizar la transacción de despliegue.
-
Una vez desplegado, el contrato inteligente estará listo para su uso. Puedes interactuar con él mediante transacciones desde direcciones que tengan los permisos adecuados.
Ejemplos prácticos de cómo interactuar con el contrato inteligente en diferentes escenarios.
A continuación, se presentan ejemplos prácticos de cómo interactuar con el contrato inteligente Galdappagos en diferentes escenarios:
// Dirección del propietario del contrato
address owner = 0x1234567890123456789012345678901234567890;
// Emisión segura de un nuevo NFT por el propietario del contrato
function emitNFT(address recipient, string memory tokenURI) public {
require(msg.sender == owner, "Only the contract owner can emit NFTs.");
safeMint(recipient, tokenURI);
}En este ejemplo, el propietario del contrato, identificado por su dirección de Ethereum, tiene el privilegio de emitir nuevos NFTs de Galdappagos. Llamando a la función emitNFT y proporcionando la dirección del destinatario y la URI del token, el propietario puede crear y asignar un nuevo NFT a un destinatario específico.
// Consulta la URI de un NFT específico
function getNFTURI(uint256 tokenId) public view returns (string memory) {
require(_exists(tokenId), "Token does not exist.");
return tokenURI(tokenId);
}En este ejemplo, se muestra cómo consultar la URI de un NFT específico dentro del contrato Galdappagos. Al llamar a la función getNFTURI y proporcionar el ID de token, se verifica si el token existe y se devuelve la URI asociada a ese NFT en particular. Esto permite a los usuarios obtener la información y los metadatos vinculados a un NFT específico.
// Transferencia segura de un NFT a otro propietario
function transferNFT(uint256 tokenId, address recipient) public {
require(_isApprovedOrOwner(msg.sender, tokenId), "You are not the owner of the token.");
_safeTransfer(msg.sender, recipient, tokenId, "");
}En este ejemplo, se demuestra cómo transferir de forma segura la propiedad de un NFT a otro propietario. Al llamar a la función transferNFT y proporcionar el ID del token y la dirección del destinatario, el propietario actual del NFT puede transferir la propiedad a otro usuario. Se verifica si el remitente es el propietario o tiene los permisos necesarios para transferir el token, y luego se realiza la transferencia.
Información relevante para desarrolladores interesados en contribuir o colaborar con el proyecto.
Pautas y reglas para la contribución al proyecto, incluyendo instrucciones sobre cómo clonar el repositorio, configurar el entorno de desarrollo y enviar solicitudes de extracción.
Para la realización de pruebas, no se limita el uso de herramientas o librerías (eg. HardHat y Truffle). El objetivo final de cada prueba unitaria es la cobertura de casos y/o escenarios en donde el contrato pueda fallar para poder asegurar su robustez.
Un ejemplo, usando Truffle se muestra a continuación de una prueba unitaria para el contrato UserRegistry:
contract UserRegistryTest {
UserRegistry userRegistry;
function beforeEach() public {
userRegistry = new UserRegistry();
}
function testRegisterUser() public {
// Register a user
address wallet = address(0x123);
userRegistry.registerUser(wallet);
// Verify the user is registered
address registeredUser = userRegistry.walletToUser(wallet);
Assert.equal(registeredUser, msg.sender, "User should be registered");
}
}
Instrucciones sobre cómo desplegar el contrato inteligente en una red blockchain específica, incluyendo consideraciones de seguridad y gas.
Información sobre la licencia utilizada para el proyecto.
Información sobre el autor o autores del proyecto.
Agradecimientos y reconocimientos a personas o proyectos que han contribuido o inspirado el desarrollo del proyecto.