{"id":24180013,"url":"https://github.com/azeem-0/kal-el-token","last_synced_at":"2025-03-02T19:16:43.085Z","repository":{"id":270070801,"uuid":"907654212","full_name":"Azeem-0/kal-el-token","owner":"Azeem-0","description":"The Kal-El Token is an ERC-20-like token with features such as minting, burning, pausing, and ownership transfer. It provides secure token management with a capped supply and ensures only the owner can perform critical operation","archived":false,"fork":false,"pushed_at":"2024-12-29T13:35:51.000Z","size":74,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-02T19:16:37.463Z","etag":null,"topics":["blockchain","erc20","hardhat","smart-contracts","solidity","testing"],"latest_commit_sha":null,"homepage":"","language":"Solidity","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Azeem-0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-24T04:51:08.000Z","updated_at":"2024-12-29T13:35:54.000Z","dependencies_parsed_at":"2024-12-28T07:29:06.769Z","dependency_job_id":"c7e57c7f-ef8b-4ec3-8886-a3f0746dc309","html_url":"https://github.com/Azeem-0/kal-el-token","commit_stats":null,"previous_names":["azeem-0/kal-el-token"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azeem-0%2Fkal-el-token","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azeem-0%2Fkal-el-token/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azeem-0%2Fkal-el-token/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azeem-0%2Fkal-el-token/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Azeem-0","download_url":"https://codeload.github.com/Azeem-0/kal-el-token/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241557183,"owners_count":19981881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","erc20","hardhat","smart-contracts","solidity","testing"],"created_at":"2025-01-13T06:11:32.721Z","updated_at":"2025-03-02T19:16:43.055Z","avatar_url":"https://github.com/Azeem-0.png","language":"Solidity","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kal-El Token Smart Contract\n\n## Overview\nThe KalEl Token is a capped, ERC-20-like token implemented in Solidity. It includes features like minting, burning, pausing, transferring ownership, and standard ERC-20 operations. The contract is designed to provide secure and efficient token management with additional functionalities.\n\n## Features\n- **Minting**: Only the owner can mint new tokens, respecting the capped supply limit.\n- **Burning**: Tokens can be burned to reduce the total supply, only the owner can burn tokens.\n- **Pausing**: The owner can pause or unpause token operations.\n- **Ownership Transfer**: Ownership of the contract can be transferred.\n- **ERC-20 Standard Operations**: Includes `transfer`, `approve`,`balanceOf`,`allowance` and `transferFrom` functions.\n\n## Prerequisites\n- Solidity ^0.8.28\n- An Ethereum development environment (e.g., Hardhat)\n- Node.js and npm (for testing and deployment)\n\n\n\n## Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/Azeem-0/kal-el-token.git\n   ```\n\n2. Navigate to the project directory:\n\n   ```bash\n   cd kal-el-token\n   ```\n\n3. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n4. Set up environment variables:\n\n   Create a `.env` file in the root directory and add the following:\n\n   ```env\n   PRIVATE_KEY=\u003cyour_private_key\u003e\n   INFURA_API_KEY=\u003cyour_infura_api_key\u003e\n   ```\n\n5. Compile the contract: \n\n   ```bash\n   npx hardhat compile\n   ```\n\n6. Run the tests:\n\n   ```bash\n   npx hardhat test   \n   ```\n6. Deploy the contract using Hardhat:\n\n   ```bash\n   npx hardhat run scripts/deploy.js --network \u003cyour_preferred_network\u003e  \n   ```\n\n\n\n\n## Deployment\n### Constructor Parameters\nThe constructor requires the following parameters:\n1. `uint256 initialSupply`: Initial supply of tokens.\n2. `string tokenName`: Name of the token.\n3. `string tokenSymbol`: Symbol of the token.\n4. `uint256 totalCappedSupply`: Maximum capped supply of tokens.\n5. `uint8 decimals`: Number of decimals for the token.\n\n#### Example:\n```solidity\nconstructor(\n    uint256 _initialSupply,\n    string memory _tokenName,\n    string memory _tokenSymbol,\n    uint256 _totalCappedSupply,\n    uint8 _decimals\n)\n```\n\n\n\n\n## Functions\n### Core ERC-20 Functions\n- `transfer(address to, uint256 amount)`: Transfer tokens to given address.\n- `approve(address spender, uint256 amount)`: Approve allowance to `spender` address.\n- `transferFrom(address from, address to, uint256 amount)`: Transfer from given `from` address to `to` address\n- `allowance(address owner, address spender)`: Check Allowance for `spender` from `owner` address\n\n### Owner-Only Functions\n- `mint(address to, uint256 amount)`: Mint new tokens into the given address.\n- `burn(address from, uint256 amount)`: Burn tokens from the given address.\n- `pause()`: Pause token operations.\n- `unpause()`: Unpause token operations.\n- `transferOwnership(address newOwner)`: Transfer owner to `newOwner` address.\n\n### View Functions\n- `name()`: Returns the name of the token.\n- `symbol()`: Returns the symbol of the token.\n- `getDecimals()`: Returns the number of decimals.\n- `getTotalSupply()`: Returns the total supply.\n- `getOwner()`: Returns the owner address.\n- `balanceOf(address account)`: Returns balance of the account.\n\n## Events\n- `Transfer(address indexed from, address indexed to, uint256 value)`\n- `Approval(address indexed owner, address indexed spender, uint256 value)`\n- `Paused(address account)`\n- `Unpaused(address account)`\n- `Mint(address indexed to, uint256 value)`\n- `Burn(address indexed from, uint256 value)`\n- `OwnershipTransferred(address indexed previousOwner, address indexed newOwner)`\n\n\n## Security Considerations\n- **Owner-Only Functions** : The functions that are intended to be restricted to the owner (such as minting, burning, pausing, and transferring ownership) are made public in this contract for testing purposes only. In a production environment, these functions should be restricted to the owner using modifiers like onlyOwner to prevent unauthorized access.\n- Proper checks are in place to ensure the capped supply limit is respected.\n- Address validation ensures no zero-address operations.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazeem-0%2Fkal-el-token","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fazeem-0%2Fkal-el-token","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fazeem-0%2Fkal-el-token/lists"}