Skip to content

The TokenSwap project is a blockchain-based initiative that allows for the seamless swapping of tokens. It involves two ERC-20 compliant tokens. This project employs smart contracts deployed on the Ethereum network and is developed using Solidity, along with the Hardhat development environment.

Notifications You must be signed in to change notification settings

maxion-tech/token-swap-contracts

Repository files navigation

🔄 Maxion TokenSwap Project

MythXBadge

The TokenSwap project is a blockchain-based initiative that allows for the seamless swapping of tokens. It involves two ERC-20 compliant tokens. This project employs smart contracts deployed on the Ethereum network and is developed using Solidity, along with the Hardhat development environment.

🌟 Features

  • 🔄 Token Swapping: Enables the exchange of TransferToken for MintableToken and vice versa.
  • 🛠️ Flexible Fee Structure: Offers adjustable fee structures for both minting and transferring tokens.
  • 🌐 Decentralized: Runs on the Ethereum blockchain, ensuring transparency and security.
  • 🔒 Owner Privileges: Allows the owner to grant roles and adjust fee structures.

🛠️ Technologies Used

  • Solidity
  • Hardhat
  • Ethers.js
  • Chai

🚀 Getting Started

Prerequisites

  • Node.js >= 14.0.0
  • npm >= 6.0.0
  • Hardhat

Installation

  1. Clone the repository:
git clone https://github.com/maxion-tech/token-swap-contracts.git
  1. Navigate to the project directory:
cd token-swap-contracts
  1. Install the dependencies:
npm install

Deployment

  1. Compile the contracts:
npx hardhat compile
  1. Deploy the contracts to the local Hardhat network:
npx hardhat run scripts/deploy.js --network localhost

🧪 Running Tests

To run the test suite, use the following command:

npx hardhat test

📜 Smart Contracts

  • ERC20MintableBurnable: Defines the basic ERC-20 compliant token with additional mint and burn functionalities.
  • TokenSwap: The main contract that handles the token swapping logic, rate adjustments, and fee implementations.

🙏 Acknowledgements

License

Distributed under the MIT License. See LICENSE for more information.

About

The TokenSwap project is a blockchain-based initiative that allows for the seamless swapping of tokens. It involves two ERC-20 compliant tokens. This project employs smart contracts deployed on the Ethereum network and is developed using Solidity, along with the Hardhat development environment.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published