dracoder-web3-package v2.0.2

web3-integration-package

Resumen

Paquete utilizado para la integración del proveedor web3 entre el lado del cliente y la API.

Este repositorio proporciona las herramientas necesarias para conectar a los usuarios con el ecosistema blockchain de manera fluida y segura. Facilita la integración de funcionalidades de firma de transacciones blockchain en aplicaciones cliente, permitiendo que la información y los registros generados se comuniquen eficientemente con los endpoints de la API necesarios.

Índice

• Instalación
• Funciones

Instalación

npm install dracoder-web3-package

Funciones

isMetamaskInstalled

Verifica si Metamask está instalado en el navegador del usuario.

Uso

const { isMetamaskInstalled } = require("dracoder-web3-package");
console.log(isMetamaskInstalled());

Retorno

• { "ok": true, "message": "Metamask is installed" } si Metamask está instalado.
• { "ok": false, "message": "You don't have Metamask installed." } si Metamask no está instalado.

getMetamaskAccount

Obtiene la cuenta de Metamask conectada actualmente.

Uso

const { getMetamaskAccount } = require("dracoder-web3-package");
getMetamaskAccount().then(console.log).catch(console.error);

Retorno

• { "ok": true, "message": "Connected successfully.", "account": "0x..." } si se obtiene la cuenta con éxito.
• { "ok": false, "message": "Error message } en caso de error.

clientTokenTransfer

Realiza una transferencia de tokens desde la cuenta conectada a una dirección específica.

Parametros

• walletAddressToTransferTo : Dirección de la billetera receptora.
• tokenAddress : Dirección del contrato del token.
• amount : Cantidad de tokens a transferir.

Uso

const { clientTokenTransfer } = require("dracoder-web3-package");
clientTokenTransfer(walletAddressToTransferTo, tokenAddress, amount)
  .then(console.log)
  .catch(console.error);

Retorno

• { "ok": true, "message": "Transfer successful", "transactionHash": "0x..." } si la transferencia es exitosa.
• { "ok": false, "message": "Transfer failed", "error": error } si falla la transferencia.

sendTokenToWallet

Intenta añadir un token a Metamask.

Parametros

• tokenAddress : Dirección del contrato del token.

Uso

const { sendTokenToWallet } = require("dracoder-web3-package");
sendTokenToWallet(tokenAddress).then(console.log).catch(console.error);

Retorno

• { true } si el token se añadió correctamente.
• { [Objeto] de error } si falla la operación.

checkWalletFormat

Verifica si una dirección de billetera tiene el formato correcto.

Parametros

• account : Dirección de la billetera a verificar.

Uso

const { checkWalletFormat } = require("dracoder-web3-package");
console.log(checkWalletFormat(account));

Retorno

• { "ok": true, "message": "Proper address format" } si el formato es correcto.
• { "ok": false, "message": "Wrong address format" } si el formato es incorrecto.

selectOrAddPolygonMainNetwork

Selecciona o añade la red principal de Polygon en Metamask.

Uso

const { selectOrAddPolygonMainNetwork } = require("dracoder-web3-package");
selectOrAddPolygonMainNetwork().then(console.log).catch(console.error);

Retorno

• { "ok": true, "message": "Already on polygon main network" } si ya está en la red principal de Polygon.
• { "ok": true, "message": "Matic MainNet added successfully", "response": response } si se añade la red de Polygon con éxito.
• { "ok": false, "message": "Matic MainNet cannot be added", "response": error } si no se puede añadir la red.