Update smart contract calculation, testing, and readme docs

.env.example

@@ -0,0 +1,2 @@
+MAINNET_RPC_URL=https://eth-mainnet.g.alchemy.com/v2/account_key_xxx
+FORK_BLOCK_NUMBER=21272472

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts

README.md

@@ -1,66 +1,105 @@
-## Foundry
+## Eduena Frontend
 
-**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+[Eduena Frontend](https://github.com/Eduena-Endownment-Fund/eduena-web)
 
-Foundry consists of:
+## Smart Contract Functionality
 
--   **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.
+The `Eduena` contract in [`src/Eduena.sol`](src/Eduena.sol)
 
-## Documentation
+### Functions
 
-https://book.getfoundry.sh/
+- **deposit(uint256 amount)**: Allows users to deposit a specified amount of USDe tokens and it immediately staked to sUSDe. The equivalent amount of Eduena tokens (EDN) is minted and assigned to the user.
+- **withdraw(uint256 shares)**: Allows users to withdraw a specified amount of Eduena tokens (EDN). The equivalent amount of sUSDe tokens is transferred back to the user.
+- **distribute(address recipient, uint256 shares)**: Distributes a specified amount of yield to a recipient.
+- **accrueYield()**: Updates the yield based on the current asset value in USDe.
 
-## Usage
+### Events
 
-### Build
+- **DepositAndStake(address indexed user, uint256 amount)**: Emitted when a deposit is made and staked.
+- **Withdraw(address indexed recipient, uint256 amount)**: Emitted when a withdrawal is made.
+- **Distribute(address indexed recipient, uint256 amount)**: Emitted when yield is distributed.
+- **YieldAccrued(uint256 newAssetValueInUSDe, uint256 yield)**: Emitted when the yield is updated.
 
-```shell
-$ forge build
-```
+### Errors
 
-### Test
+- **InsufficientBalance()**: Thrown when a user tries to withdraw more than their balance.
+- **DepositAmountZero()**: Thrown when a deposit amount is zero.
+- **ExceedsUnclaimedYield()**: Thrown when the amount exceeds the unclaimed yield.
 
-```shell
-$ forge test
-```
+## Testing
+
+The `EduenaTest` contract in [`test/Eduena.t.sol`](test/Eduena.t.sol) includes tests for the deposit and withdrawal functionalities.
 
-### Format
+### Example Test Functions
 
-```shell
-$ forge fmt
+```solidity
+function testDepositAndWithdraw() public {
+    // Test deposit and withdrawal functionality
+}
+
+function testAccrueYield() public {
+    // Test yield accrual functionality
+}
 ```
 
-### Gas Snapshots
+### Setting Up Environment Variables
+
+To run the tests, you need to set up the following environment variables in a `.env` file:
 
-```shell
-$ forge snapshot
+```env
+MAINNET_RPC_URL=https://eth-mainnet.g.alchemy.com/v2/account_key_xxx
+FORK_BLOCK_NUMBER=21272472
 ```
 
-### Anvil
+Running the Tests
+To run the tests using Foundry, use the following command:
 
-```shell
-$ anvil
 ```
+forge test
+```
+
+### Deployment
 
-### Deploy
+The Eduena contract is deployed on [Tenderly](https://tenderly.co/) for testing purposes.
 
-```shell
-$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
+```
+echo "
+unknown_chain = { key = \"${TENDERLY_ACCESS_KEY}\", chain = 1, url = \"$TENDERLY_RPC_URL\" }" >> foundry.toml
+
+forge create Eduena \
+--private-key $PRIVATE_KEY \
+--rpc-url $TENDERLY_RPC_URL \
+--etherscan-api-key $TENDERLY_ACCESS_KEY \
+--verify \
+--verifier-url $TENDERLY_RPC_URL/verify/etherscan \
+--constructor-args 0x4c9EDD5852cd905f086C759E8383e09bff1E68B3 0x9D39A5DE30e57443BfF2A8307A4256c8797A3497
 ```
 
-### Cast
+Fund account for gas fee
 
-```shell
-$ cast <subcommand>
+```
+curl "$TENDERLY_RPC_URL" \
+-X POST \
+-H "Content-Type: application/json" \
+-d '{
+    "jsonrpc": "2.0",
+    "method": "tenderly_setBalance",
+    "params": [["0xE58b9ee93700A616b50509C8292977FA7a0f8ce1"], "0xDE0B6B3A7640000"]
+}'
 ```
 
-### Help
+Fund your account with USDe for testing Eduena deposits. The first parameter is the USDe contract address, the second parameter is your wallet address, and the third parameter is a 32-byte hash representing the token amount in wei. The example below sets a balance of $100,000 USDe to the user's address.
 
-```shell
-$ forge --help
-$ anvil --help
-$ cast --help
+```
+curl --location '${TENDERLY_RPC_URL}' \
+--header 'Content-Type: application/json' \
+--data '{
+    "jsonrpc": "2.0",
+    "method": "tenderly_setErc20Balance",
+    "params": [
+        "0x4c9EDD5852cd905f086C759E8383e09bff1E68B3",
+        "{{$USER_WALLET_ADDRESS}}",
+        "0x152d02c7e14af6000000"
+    ]
+}'
 ```

foundry.toml

@@ -4,3 +4,5 @@ out = "out"
 libs = ["lib"]
 
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
+
+unknown_chain = { key = "{{TENDERLY_ACCESS_KEY}}", chain = 1, url = "{{TENDERLY_RPC_URL}}" }

remappings.txt

@@ -0,0 +1 @@
+@openzeppelin/contracts=lib/openzeppelin-contracts/contracts