Merge dev into main

CodesenSys · CodesenSys · commit e14847cb4e1a · 2026-02-16T18:11:48.000+05:00
diff --git a/.github/workflows/.github/workflows/ci.yml b/.github/workflows/.github/workflows/ci.yml
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,38 @@
+name: CI
+
+permissions: {}
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    name: Foundry project
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Show Forge version
+        run: forge --version
+
+      - name: Run Forge fmt
+        run: forge fmt --check
+
+      - name: Run Forge build
+        run: forge build --sizes
+
+      - name: Run Forge tests
+        run: forge test -vvv
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,12 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/solady"]
+	path = lib/solady
+	url = https://github.com/vectorized/solady
+[submodule "lib/prb-test"]
+	path = lib/prb-test
+	url = https://github.com/PaulRBerg/prb-test
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
diff --git a/README.md b/README.md
@@ -1,3 +1,4 @@
+<<<<<<< HEAD
 # CodesenSys ERC20 Implementation (Foundry | Solady)
 
 A production-grade, security-first ERC20 token implementation built by **CodesenSys** using **Foundry**.  
@@ -163,3 +164,71 @@ Governance voting power
 Bridging adapters
 Upgradeable proxies
 Without modifying the core accounting engine.
+=======
+## Foundry
+
+**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+
+Foundry consists of:
+
+- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
+- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
+- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
+- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+
+## Documentation
+
+https://book.getfoundry.sh/
+
+## Usage
+
+### Build
+
+```shell
+$ forge build
+```
+
+### Test
+
+```shell
+$ forge test
+```
+
+### Format
+
+```shell
+$ forge fmt
+```
+
+### Gas Snapshots
+
+```shell
+$ forge snapshot
+```
+
+### Anvil
+
+```shell
+$ anvil
+```
+
+### Deploy
+
+```shell
+$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
+```
+
+### Cast
+
+```shell
+$ cast <subcommand>
+```
+
+### Help
+
+```shell
+$ forge --help
+$ anvil --help
+$ cast --help
+```
+>>>>>>> dev
diff --git a/foundry.lock b/foundry.lock
@@ -0,0 +1,26 @@
+{
+  "lib/forge-std": {
+    "tag": {
+      "name": "v1.14.0",
+      "rev": "1801b0541f4fda118a10798fd3486bb7051c5dd6"
+    }
+  },
+  "lib/openzeppelin-contracts": {
+    "tag": {
+      "name": "v5.5.0",
+      "rev": "fcbae5394ae8ad52d8e580a3477db99814b9d565"
+    }
+  },
+  "lib/prb-test": {
+    "tag": {
+      "name": "v0.6.5",
+      "rev": "2ece8755d9afe7d66440ef9ca19b8a9dab40164b"
+    }
+  },
+  "lib/solady": {
+    "tag": {
+      "name": "v0.1.26",
+      "rev": "acd959aa4bd04720d640bf4e6a5c71037510cc4b"
+    }
+  }
+}
diff --git a/foundry.toml b/foundry.toml
@@ -0,0 +1,17 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+remappings = [
+    "forge-std/=lib/forge-std/src/",
+    "solady/=lib/solady/src/",
+    "@solady-utils/=lib/solady/src/utils/",
+]
+
+[rpc_endpoints]
+sepolia = "${SEPOLIA_RPC_URL}"
+ 
+[etherscan]
+sepolia = { key = "${ETHERSCAN_API_KEY}" }
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
diff --git a/lib/forge-std b/lib/forge-std
@@ -0,0 +1 @@
+Subproject commit 1801b0541f4fda118a10798fd3486bb7051c5dd6
diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts
@@ -0,0 +1 @@
+Subproject commit fcbae5394ae8ad52d8e580a3477db99814b9d565
diff --git a/lib/prb-test b/lib/prb-test
@@ -0,0 +1 @@
+Subproject commit 2ece8755d9afe7d66440ef9ca19b8a9dab40164b
diff --git a/lib/solady b/lib/solady
@@ -0,0 +1 @@
+Subproject commit acd959aa4bd04720d640bf4e6a5c71037510cc4b
diff --git a/script/Deploy.s.sol b/script/Deploy.s.sol
@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+import {Script} from "forge-std/Script.sol";
+import {CodesenSysToken} from  "../src/tokens/CodesenSysToken.sol"; 
+
+
+contract Deploy is Script {
+    function run() external {
+        // uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        // vm.startBroadcast(vm.envUint("DEPLOYER_PRIVATE_KEY"));
+        vm.startBroadcast();
+        new CodesenSysToken(msg.sender, 1_000_000e18);
+        vm.stopBroadcast();
+    }
+}
+
diff --git a/src/core/BaseERC20.sol b/src/core/BaseERC20.sol
@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+import {ERC20} from "solady/tokens/ERC20.sol";
+import {Errors} from "./Errors.sol";
+
+abstract contract BaseERC20 is ERC20 {
+    function name() public view virtual override returns (string memory);
+    function symbol() public view virtual override returns (string memory);
+
+    function _mintInternal(address to, uint256 amount) internal {
+        if (to == address(0)) revert Errors.ZeroAddress();
+        if (amount == 0) revert Errors.ZeroAmount();
+        _mint(to, amount);
+    }
+
+    function _burnInternal(address from, uint256 amount) internal {
+        if (from == address(0)) revert Errors.ZeroAddress();
+        if (amount == 0) revert Errors.ZeroAmount();
+        _burn(from, amount);
+    }
+}
diff --git a/src/core/Constants.sol b/src/core/Constants.sol
@@ -0,0 +1,2 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
diff --git a/src/core/Errors.sol b/src/core/Errors.sol
@@ -0,0 +1,6 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+library Errors {
+    error ZeroAddress();
+    error ZeroAmount();
+}
diff --git a/src/core/Modifiers.sol b/src/core/Modifiers.sol
@@ -0,0 +1,2 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
diff --git a/src/interfaces/IERC20.sol b/src/interfaces/IERC20.sol
@@ -0,0 +1,2 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
diff --git a/src/tokens/CodesenSysToken.sol b/src/tokens/CodesenSysToken.sol
@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+import {BaseERC20} from "../core/BaseERC20.sol";
+
+contract CodesenSysToken is BaseERC20 {
+    address public immutable OWNER;
+
+    constructor(address _owner, uint256 initialSupply) {
+        OWNER = _owner;
+        _mintInternal(_owner, initialSupply);
+    }
+
+    function name() public pure override returns (string memory) {
+        return "CodesenSys Token";
+    }
+
+    function symbol() public pure override returns (string memory) {
+        return "CSS";
+    }
+
+    function mint(address to, uint256 amount) external {
+        if (msg.sender != OWNER) revert("NOT_AUTHORIZED");
+        _mintInternal(to, amount);
+    }
+
+    function burn(uint256 amount) external {
+        _burnInternal(msg.sender, amount);
+    }
+}
diff --git a/test/invariant/ERC20Invariant.t.sol b/test/invariant/ERC20Invariant.t.sol
@@ -0,0 +1,2 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
diff --git a/test/unit/Allowance.t.sol b/test/unit/Allowance.t.sol
@@ -0,0 +1,2 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
diff --git a/test/unit/MintBurn.t.sol b/test/unit/MintBurn.t.sol
@@ -0,0 +1,90 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+import {Test} from "forge-std/Test.sol";
+import {CodesenSysToken} from "../../src/tokens/CodesenSysToken.sol";
+import {Errors} from "../../src/core/Errors.sol";
+
+
+contract CodesenSysTokenTest is Test {
+
+    CodesenSysToken public token; // type safty
+
+    address public immutable OWNER = 0x8C02Cadc32805F85037266206ce4FF347148bb98;
+    uint256 public initialMint = 1_000_000e18; 
+    address public user = 0x0D27fFDAa2fD7DA85f25d968FC03Fc6d8e261aB2;
+   
+    // Foundry Test Setup 
+    function setUp() public {
+        token = new CodesenSysToken(OWNER, initialMint);
+    }
+
+    // ============ Constructor Tests ============
+    
+    function test_Constructor_SetOwner() public view {
+        assertEq(token.OWNER(), OWNER);
+    }
+
+    function test_Constructor_MintInitialSupply() public view {
+        assertEq(token.balanceOf(OWNER), initialMint) ;
+        assertEq(token.totalSupply(), initialMint);
+    }
+
+    function test_Constructor_SetNameSymbol() public view {
+        assertEq(token.name(), "CodesenSys Token");
+        assertEq(token.symbol(), "CSS");
+    }
+
+    // ============ Mint Tests ============
+
+    function test_Mint_OwnerCanMint() public {
+        uint256 mintAmount = 1000e18;
+        vm.prank(OWNER);
+        token.mint(user, mintAmount);
+        
+        assertEq(token.balanceOf(user), mintAmount);
+        assertEq(token.totalSupply(), initialMint + mintAmount);
+    }
+
+    function test_Mint_RevertsWhenNotOwner() public  {
+        uint256 minAmount = 1000e18;
+        vm.prank(user);
+        vm.expectRevert("NOT_AUTHORIZED");
+        token.mint(user, minAmount);
+    }
+
+    function test_Mint_RevertsOnZeroAddress() public {
+        vm.prank(OWNER);
+        vm.expectRevert(Errors.ZeroAddress.selector);
+        token.mint(address(0), 1000e18);
+    }
+
+    function test_Mint_RevertsOnZeroAmount() public {
+        vm.prank(OWNER);
+        vm.expectRevert(Errors.ZeroAmount.selector);
+        token.mint(OWNER, 0);
+    }
+
+    function testFuzz_Mint_OwnerCanMintArbitraryAmounts(uint256 amount) public {
+        // Bound to reasonable values
+        amount = bound(amount, 1, type(uint128).max);
+        
+        vm.prank(OWNER);
+        token.mint(user, amount);
+        
+        assertEq(token.balanceOf(user), amount);
+    }
+
+    // ============ Burn Tests ============
+
+    // function test_Burn_UserCanBurnOwnTokens() public {
+    // uint256  _amount = 1000e18;
+    // vm.prank(user);
+    // token.burn(_amount);
+    // assertEq(token.balanceOf(user), _amount);  
+    // assertEq(token.totalSupply(), initialMint - _amount);  
+    // }
+
+
+   
+
+}
diff --git a/test/unit/Transfer.t.sol b/test/unit/Transfer.t.sol
@@ -0,0 +1,2 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
