Initial commit

Author: github-classroom[bot]

.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Show Forge version
+        run: |
+          forge --version
+
+      - name: Run Forge fmt
+        run: |
+          forge fmt --check
+        id: fmt
+
+      - name: Run Forge build
+        run: |
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

README.md

@@ -0,0 +1,28 @@
+
+# Description
+
+In this assignment, you have a solidity contract. This contract has gaps and comments to guide you on what to implement.
+
+
+The assignment covers Solidity concepts. It focuses on:
+- Global variables
+- Solidity modifiers
+- Events and logs
+- Conversions and type casting
+- Error handling
+
+
+# Instructions
+
+Open the contract file located at `src/Assignment6.sol` and follow the comments to implement the missing logic.
+
+## Run Tests:
+
+`forge test`
+
+## Submission
+
+Once all tests pass, commit all your changes to the repo.
+
+Good luck and happy coding!
+

foundry.toml

@@ -0,0 +1,6 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

lib/forge-std

@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+contract Assignment6 {
+    // 1. Declare an event called `FundsDeposited` with parameters: `sender` and `amount`
+
+    // 2. Declare an event called `FundsWithdrawn` with parameters: `receiver` and `amount`
+
+    // 3. Create a public mapping called `balances` to tracker users balances
+
+    // Modifier to check if sender has enough balance
+    modifier hasEnoughBalance(uint amount) {
+        // Fill in the logic using require
+        _;
+    }
+
+    // Function to deposit Ether
+    // This function should:
+    // - Be external and payable
+    // - Emit the `FundsDeposited` event
+    function deposit() {
+        // increment user balance in balances mapping 
+
+        // emit suitable event
+    }
+
+    // Function to withdraw Ether
+    // This function should:
+    // - Be external
+    // - Take one parameter: `amount`
+    // - Use the `hasEnoughBalance` modifier
+    // - Emit the `FundsWithdrawn` event
+    function withdraw() {
+        // decrement user balance from balances mapping 
+
+        // send tokens to the caller
+
+        // emit suitable event
+
+    }
+
+    // Function to check the contract balance
+    // This function should:
+    // - Be public and view
+    // - Return the contract's balance
+    function getContractBalance() {
+        // return the balance of the contract
+
+    }
+}

src/Assignment6.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import {Test, console} from "forge-std/Test.sol";
+import {Assignment6} from "../src/Assignment6.sol";
+
+contract Assignment6Test is Test {
+    Assignment6 assignment;
+
+    function setUp() public {
+        assignment = new Assignment6();
+    }
+
+    function testDeposit() public {
+        vm.deal(address(this), 1 ether);
+        vm.expectEmit(true, true, false, true);
+        emit Assignment6.FundsDeposited(address(this), 1 ether);
+        assignment.deposit{value: 1 ether}();
+        uint balance = assignment.balances(address(this));
+        assertEq(balance, 1 ether, "Balance should be 1 ether");
+    }
+
+    function testWithdraw() public {
+        vm.deal(address(this), 1 ether);
+        assignment.deposit{value: 1 ether}();
+        vm.expectEmit(true, true, false, true); // Match receiver and amount
+        emit Assignment6.FundsWithdrawn(address(this), 0.5 ether);
+        assignment.withdraw(0.5 ether);
+        uint balance = assignment.balances(address(this));
+        assertEq(balance, 0.5 ether, "Balance should be 0.5 ether");
+    }
+
+    function testContractBalance() public {
+        vm.deal(address(this), 1 ether);
+        assignment.deposit{value: 1 ether}();
+        uint contractBalance = assignment.getContractBalance();
+        assertEq(contractBalance, 1 ether, "Contract balance should be 1 ether");
+    }
+
+    receive() external payable {}
+}