Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-azra3l/eth-proof-beginner
This repo contains challenges and project undertaken during the solidity beginner course
https://github.com/m-azra3l/eth-proof-beginner
Last synced: 25 days ago
JSON representation
This repo contains challenges and project undertaken during the solidity beginner course
- Host: GitHub
- URL: https://github.com/m-azra3l/eth-proof-beginner
- Owner: m-azra3l
- License: mit
- Created: 2023-06-12T15:00:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-12T15:38:09.000Z (over 1 year ago)
- Last Synced: 2024-11-08T23:33:02.616Z (3 months ago)
- Language: Solidity
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EPBToken
`EPBToken` is a simple ERC20 token smart contract that allows minting and burning of tokens, this smart contract was written as a project of the Eth-Proof Beginner class
## Getting Started
### Requirements
1. Your contract will have public variables that store the details about your coin (Token Name, Token Abbrv., Total Supply)
2. Your contract will have a mapping of addresses to balances (address => uint)
3. You will have a mint function that takes two parameters: an address and a value. The function then increases the total supply by that number and increases the balance of the “sender” address by that amount
4. Your contract will have a burn function, which works the opposite of the mint function, as it will destroy tokens. It will take an address and value just like the mint functions. It will then deduct the value from the total supply and from the balance of the “sender”.
5. Lastly, your burn function should have conditionals to make sure the balance of "sender" is greater than or equal to the amount that is supposed to be burned.
### Executing program
To run this program, you can use Remix, an online Solidity IDE. To get started, go to the Remix website at [Remix IDE](https://remix.ethereum.org/).
Once you are on the Remix website, create a new file by clicking on the "+" icon in the left-hand sidebar. Save the file with a .sol extension (e.g., HelloWorld.sol). Copy and paste the code into the file.
### Usage
To use the `EPBToken` contract, you can deploy it to a network of your choice and interact with its functions using a web3 provider such as [MetaMask](https://metamask.io/) or a similar tool.
#### Constructor
The `EPBToken` contract has a constructor that takes three parameters:
- `name` (string): The name of the token.
- `symbol` (string): The symbol of the token.
- `totalSupply` (uint256): The total supply of the token.
The constructor initializes the `name`, `symbol`, and `totalSupply` variables, and sets the balance of the contract creator to the total supply.
#### Mint function
The `mint` function allows anyone to increase the total supply and the balance of a specified address. It takes two parameters:
- `_to` (address): The address to mint the tokens to.
- `_value` (uint256): The amount of tokens to mint.
#### Burn function
The `burn` function allows the contract creator to decrease the total supply and the balance of their own address, as long as they have sufficient balance. It takes one parameter:
- `_value` (uint256): The amount of tokens to burn.
The function checks that the contract creator has sufficient balance before burning the tokens.
## Author
[Michael](https://github.com/m-azra3l)
## License
This project is licensed under the [MIT License](LICENSE).