Skip to content

api_requirements_BurnAndMintToken.md

Latest commit

 

History

History
76 lines (62 loc) · 2.79 KB

api_requirements_BurnAndMintToken.md

File metadata and controls

76 lines (62 loc) · 2.79 KB

API Requirements for BurnAndMintToken (BMT)

Overview

This document outlines the requirements for developing a basic token dashboard API for the BurnAndMintToken (BMT) project. The API will facilitate user balances, token transfers, burn/mint tracking, and integration with Web3 wallets.

1. Basic Token Dashboard API

1.1 User Balances

  • Endpoint: /api/balances
  • Method: GET
  • Description: Retrieve the token balance for a specific user.
  • Parameters:
    • address: The wallet address of the user.

1.2 Token Transfers

  • Endpoint: /api/transfer
  • Method: POST
  • Description: Facilitate token transfers between users.
  • Parameters:
    • from: The sender's wallet address.
    • to: The recipient's wallet address.
    • amount: The amount of tokens to transfer.

1.3 Burn/Mint Tracking

  • Endpoint: /api/burn-mint
  • Method: GET
  • Description: Track burn and mint events.
  • Parameters:
    • type: Specify whether to track burns or mints.

2. Web3 Wallet & Explorer Integration

2.1 Wallet Connection

  • Objective: Enable users to connect their wallets (MetaMask, TrustWallet) to the application.
  • Implementation: Use libraries like ethers.js and web3modal for wallet integration.

2.2 Explorer Integration

  • Objective: Allow users to view transaction history and token details on blockchain explorers.
  • Implementation: Provide links to Etherscan or similar services for transaction tracking.

3. Simple Admin Panel

3.1 Token Supply Overview

  • Endpoint: /api/supply
  • Method: GET
  • Description: Retrieve the total supply of BMT tokens.

3.2 Transaction Log

  • Endpoint: /api/transactions
  • Method: GET
  • Description: Fetch a log of all transactions involving the BMT token.

3.3 Governance Actions

  • Endpoint: /api/governance
  • Method: GET
  • Description: Retrieve active governance proposals and voting results.

4. Required Team

4.1 Backend Developer

  • Estimated Hours: 200 hours
  • Responsibilities: API development and database integration.

4.2 Blockchain Developer

  • Estimated Hours: 100 hours
  • Responsibilities: Web3 integration and smart contract interactions.

4.3 DevOps Engineer

  • Estimated Hours: 50 hours
  • Responsibilities: Hosting and deployment of the API and web application.

Conclusion

This API requirements document serves as a roadmap for developing the backend infrastructure necessary for the BurnAndMintToken project. By focusing on user balances, token transfers, and governance actions, we aim to create a robust and user-friendly experience.

Contact Information

For more information about the API requirements, please contact:

  • Ewuzie Azuka
  • Founder, BMT
  • Email: [Your Email]
  • Website: [Your Website]