Skip to content

Commit

Permalink
Fix README.md formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Hamadiftikharr committed Nov 28, 2024
1 parent 2f1ac3b commit 057b135
Showing 1 changed file with 30 additions and 25 deletions.
55 changes: 30 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,48 @@
Foundry-ERC20
# Foundry-ERC20-F24

This project implements an ERC-20 token using OpenZeppelin contracts and provides additional features for deployment and testing.

Overview
## Overview

The project contains the following key components:

1. OurToken.sol
This is the main ERC-20 token contract.
Inherits the standard ERC-20 implementation from OpenZeppelin.
Implements all core functionalities of an ERC-20 token.
2. ManualToken.sol
A custom ERC-20 token implementation created manually for learning and experimentation purposes.
Provides a basic understanding of how ERC-20 tokens work without relying on libraries.
3. Tests
Comprehensive tests for the token contracts are included to ensure their correctness and security.
Uses Foundry for testing.
Covers standard ERC-20 functionalities like transfer, approve, and transferFrom.
4. Deployment Script
Includes a script to deploy the token contracts on the blockchain.
Script is flexible and supports deployment on test networks like Sepolia or local networks like Anvil.
How to Use
Install Dependencies
Make sure you have Foundry installed. If not, install it by following the instructions here.

Clone the Repository
bash
Copy code
### 1. **OurToken.sol**
- This is the main ERC-20 token contract.
- Inherits the standard ERC-20 implementation from [OpenZeppelin](https://openzeppelin.com/contracts/).
- Implements all core functionalities of an ERC-20 token.

### 2. **ManualToken.sol**
- A custom ERC-20 token implementation created manually for learning and experimentation purposes.
- Provides a basic understanding of how ERC-20 tokens work without relying on libraries.

### 3. **Tests**
- Comprehensive tests for the token contracts are included to ensure their correctness and security.
- Uses [Foundry](https://getfoundry.sh/) for testing.
- Covers standard ERC-20 functionalities like `transfer`, `approve`, and `transferFrom`.

### 4. **Deployment Script**
- Includes a script to deploy the token contracts on the blockchain.
- Script is flexible and supports deployment on test networks like Sepolia or local networks like Anvil.

## How to Use

### Install Dependencies
Make sure you have Foundry installed. If not, install it by following the instructions [here](https://book.getfoundry.sh/getting-started/installation.html).

### Clone the Repository
```bash
git clone https://github.com/Hamadiftikharr/foundry-erc20.git
cd foundry-erc20

Run Tests
To ensure everything is working as expected:

bash
Copy code
forge test
Deploy the Contract
To deploy the OurToken contract:

bash
Copy code
forge script script/DeployOurToken.s.sol:DeployOurToken --rpc-url <RPC_URL> --private-key <PRIVATE_KEY> --broadcast
Key Features
Reusable: Uses OpenZeppelin's highly tested and secure libraries for token implementation.
Expand Down

0 comments on commit 057b135

Please sign in to comment.