Ft combined l2

.env.example

@@ -0,0 +1,7 @@
+ALCHEMY_KEY=
+ETHERSCAN_API_KEY=
+TENDERLY_FORK_ID=
+QUICKNODE_OPTIMISM_URL=
+OPTIMISM_BLOCK_NUMBER=
+BLOCK_NUMBER=
+FORK_OPTIMISM=

.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+name: Run Tests on Push
+
+on: push
+
+env:
+  ALCHEMY_KEY: ${{ secrets.ALCHEMY_KEY }}
+  ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
+  TENDERLY_FORK_ID: ${{ secrets.TENDERLY_FORK_ID }}
+  QUICKNODE_OPTIMISM_URL: ${{ secrets.QUICKNODE_OPTIMISM_URL }}
+  OPTIMISM_BLOCK_NUMBER: ${{ secrets.OPTIMISM_BLOCK_NUMBER }}
+  BLOCK_NUMBER: ${{ secrets.BLOCK_NUMBER }}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Install
+        run: npm install
+
+      - name: Compile
+        run: npx hardhat compile
+
+      - name: Test Mainnet 🚨
+        env:
+          FORK_OPTIMISM: ${{ secrets.FORK_OPTIMISM_MAINNET }}
+        run: npx hardhat test test/mainnet/*
+
+      - name: Test Optimism 🚨
+        env:
+          FORK_OPTIMISM: ${{ secrets.FORK_OPTIMISM }}
+        run: npx hardhat test test/optimism/*

.gitignore

@@ -1,6 +1,8 @@
 .env
 node_modules/*
-
+coverage/*
 artifacts/
 cache/
-types/
+types/
+src/
+coverage.json

README.md

@@ -1,50 +1,30 @@
-# Starter Hardhat Template for advanced users
-
-This project demonstrates an advanced Hardhat use case, integrating other tools commonly used alongside Hardhat in the ecosystem.
-
-Some of the pre-included features: 
-
-- Preconfigured Forking
-- Gas Estimates
-- Contract size alert on compilation
-- Automatic typedef generation for contracts
-- Easy to use `.env` file for configuration
-
-```shell
-npx hardhat accounts
-npx hardhat compile
-npx hardhat clean
-npx hardhat test
-npx hardhat node
-npx hardhat help
-REPORT_GAS=true npx hardhat test
-npx hardhat coverage
-npx hardhat run scripts/deploy.ts
-TS_NODE_FILES=true npx ts-node scripts/deploy.ts
-npx eslint '**/*.{js,ts}'
-npx eslint '**/*.{js,ts}' --fix
-npx prettier '**/*.{json,sol,md}' --check
-npx prettier '**/*.{json,sol,md}' --write
-npx solhint 'contracts/**/*.sol'
-npx solhint 'contracts/**/*.sol' --fix
-```
+# Brahma
 
-# Etherscan verification
+[![MythXBadge](https://badgen.net/https/api.mythx.io/v1/projects/35f819a5-d41f-46be-b931-56d6db199881/badge/data?cache=300&icon=https://raw.githubusercontent.com/ConsenSys/mythx-github-badge/main/logo_white.svg)](https://dashboard.mythx.io/#/console/projects/35f819a5-d41f-46be-b931-56d6db199881)
 
-To try out Etherscan verification, you first need to deploy a contract to an Ethereum network that's supported by Etherscan, such as Ropsten.
+This repository contains the smart contracts source code and configuration for Brahma Vaults. The repository uses Hardhat as development environment for compilation, testing and deployment tasks. The repository mainly hosts the source file for protected moonshot vault.
 
-In this project, copy the .env.example file to a file named .env, and then edit it to fill in the details. Enter your Etherscan API key, your Ropsten node URL (eg from Alchemy), and the private key of the account which will send the deployment transaction. With a valid .env file in place, first deploy your contract:
+## What is Protected MoonShot Vault?
 
-```shell
-hardhat run --network ropsten scripts/sample-script.ts
-```
+The Protected Moonshot DegenVault aims to achieve to hold stables but still take leveraged positions to maximise the base yield.
 
-Then, copy the deployment address and paste it in to replace `DEPLOYED_CONTRACT_ADDRESS` in this command:
+## Structure
 
-```shell
-npx hardhat verify --network ropsten DEPLOYED_CONTRACT_ADDRESS "Hello, Hardhat!"
-```
+[contracts](./contracts): Contains all the source code of contracts used for protected moonshot vault. <br>
+[docs](./docs): Contains all the documentation related core contracts.
+
+## Connect with the community
 
-# Performance optimizations
+You can join at the [Discord](https://discord.gg/brahma) channel for asking questions about the protocol or talk about new defi strategies.
 
-For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable `TS_NODE_TRANSPILE_ONLY` to `1` in hardhat's environment. For more details see [the documentation](https://hardhat.org/guides/typescript.html#performance-optimizations).
+## Setup
+
+You can install `hardhat` as an NPM package to get started with contracts. Setup an `.env` as shown in [.env_example](./env_example).
+You can run the full test suite with the following commands:
+
+```
+# In one terminal
+npx hardhat test test/mainnet/*
+export FORK_OPTIMISM = 1
+npx hardhat test test/optimism/*
+```

contracts/BaseTradeExecutor.sol

@@ -0,0 +1,84 @@
+//SPDX-License-Identifier: GPL-3.0-only
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+import "../interfaces/ITradeExecutor.sol";
+import "../interfaces/IVault.sol";
+
+abstract contract BaseTradeExecutor is ITradeExecutor {
+    uint256 constant MAX_INT = 2**256 - 1;
+
+    ActionStatus public override depositStatus;
+    ActionStatus public override withdrawalStatus;
+
+    address public override vault;
+
+    constructor(address _vault) {
+        vault = _vault;
+        IERC20(vaultWantToken()).approve(vault, MAX_INT);
+    }
+
+    function vaultWantToken() public view returns (address) {
+        return IVault(vault).wantToken();
+    }
+
+    function governance() public view returns (address) {
+        return IVault(vault).governance();
+    }
+
+    function keeper() public view returns (address) {
+        return IVault(vault).keeper();
+    }
+
+    modifier onlyGovernance() {
+        require(msg.sender == governance(), "access :: Governance");
+        _;
+    }
+
+    modifier onlyKeeper() {
+        require(msg.sender == keeper(), "access :: Keeper");
+        _;
+    }
+
+    function sweep(address _token) public onlyGovernance {
+        IERC20(_token).transfer(
+            governance(),
+            IERC20(_token).balanceOf(address(this))
+        );
+    }
+
+    function initiateDeposit(bytes calldata _data) public override onlyKeeper {
+        require(!depositStatus.inProcess, "Deposit already in process");
+        depositStatus.inProcess = true;
+        _initateDeposit(_data);
+    }
+
+    function confirmDeposit() public override onlyKeeper {
+        require(depositStatus.inProcess, "No Deposit Pending");
+        _confirmDeposit();
+        depositStatus.inProcess = false;
+    }
+
+    function initateWithdraw(bytes calldata _data) public override onlyKeeper {
+        require(!withdrawalStatus.inProcess, "Withdraw already in process");
+        withdrawalStatus.inProcess = true;
+        _initiateWithdraw(_data);
+    }
+
+    function confirmWithdraw() public override onlyKeeper {
+        require(withdrawalStatus.inProcess, "No Withdraw Pending");
+        _confirmWithdraw();
+        withdrawalStatus.inProcess = false;
+    }
+
+    /// Internal Funcs
+
+    function _initateDeposit(bytes calldata _data) internal virtual;
+
+    function _confirmDeposit() internal virtual;
+
+    function _initiateWithdraw(bytes calldata _data) internal virtual;
+
+    function _confirmWithdraw() internal virtual;
+}