-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
650913c
commit 48346ff
Showing
1 changed file
with
6 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,16 @@ | ||
# BunToken Documentations | ||
Development of $BUN, an ERC20 token build on Base | ||
|
||
## BunToken.sol | ||
This smart contract, named BunToken, inherits from Ownable2Step and ERC20. Let’s break down its key features: | ||
## BunCoin.sol | ||
This smart contract, named BunCoin, inherits from Ownable and ERC20. Let’s break down its key features: | ||
|
||
### Token Information: | ||
- Name: `Bun Coin` | ||
- Symbol: `BUN` | ||
- Total supply: `1,000,000,000 $BUN` tokens | ||
|
||
### Functionality: | ||
- `burn(uint256 amount)`: Allows token holders to burn (destroy) a specified amount of their own tokens. | ||
- `launch()`: Can only be called by the contract owner to mark the token as launched. | ||
- `excludeFromLimits(address[] calldata accounts, bool value)`: Excludes specified accounts from certain limits. | ||
- `setBots(address[] calldata accounts, bool value)`: Sets specified accounts as bots. | ||
- `_beforeTokenTransfer(...)`: Internal function that checks various conditions before token transfers. | ||
### Contract Address: | ||
[0x4b3A5ed554dE7A5DA38728DCBC4124e602A1cF2b](https://basescan.org/address/0x4b3a5ed554de7a5da38728dcbc4124e602a1cf2b) | ||
|
||
### Mappings: | ||
- `isBot`: Maps addresses to a boolean indicating whether they are considered bots. | ||
- `isExcludedFromLimits`: Maps addresses to a boolean indicating whether they are excluded from certain limits. | ||
|
||
### Events: | ||
- `Launch()`: Emitted when the token is launched. | ||
- `ExcludeFromLimits(address indexed account, bool value)`: Emitted when an account is excluded from limits. | ||
### Website: | ||
<https://www.mb-guild.xyz/bun> |