rysk-finance · kjr217 · Dec 13, 2024 · Dec 13, 2024 · Dec 13, 2024
diff --git a/.github/workflows/test.yml b/.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
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
diff --git a/README.md b/README.md
@@ -1,165 +1,66 @@
-# Gamma Protocol [![CircleCI](https://circleci.com/gh/opynfinance/GammaProtocol.svg?style=svg)](https://circleci.com/gh/opynfinance/GammaProtocol/tree/master) [![Coverage Status](https://coveralls.io/repos/github/opynfinance/GammaProtocol/badge.svg?branch=master)](https://coveralls.io/github/opynfinance/GammaProtocol?branch=master)
+## Foundry
 
-Gamma is a decentralized capital efficient option protocol that enables sellers to create spreads. 
-Gamma protocol enables any user to create arbitrary option tokens, that represent the right to buy or sell a certain asset in a predefined price (strike price) at or before expiry. 
-As the option seller in Gamma, you can reduce the amount of capital locked in the system by creating spreads. (e.g Instead of putting down 100 USDC and mint 1 ETH-USDC-100 Put, you can buy a ETH-USDC-50 Put, and only deposit 50 USDC as collateral)
-The oTokens created by Gamma are cash settled European option, means all the options will automatically be exercised at expiry. A holder can redeem the proceeds by sending the oTokens back, the system will pay the holder the cash value based on strike price and underlying spot price at expiry, instead of actually exchanging the underlying asset and the strike asset.
+**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
 
-## Documentation
-
-Our docs site is [here](https://opyn.gitbook.io/opyn/getting-started/introduction). It contains tutorials, explainers, and smart contract documentation. If you'd like to view these docs on github instead, check out [the docs folder](/docs) in the docs repo:
-
-- [Smart contracts documentation](SUMMARY.md)
-- [UML diagrams](/docs/uml)
-- [Control flow diagrams](/docs/control-flow)
-
-## Local Development Setup
+Foundry consists of:
 
-For local development it is recommended to use ganache to run a local development chain. Using the ganache simulator no full Ethereum node is required.
+-   **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.
 
-As a pre-requisite, you need:
-
-- Node.js (v10.18.0)
-- NPM
-
-Clone the project and install all dependencies:
+## Documentation
 
-```sh
-$ git clone https://github.com/opynfinance/GammaProtocol.git
-$ cd GammaProtocol
+https://book.getfoundry.sh/
 
-# install project dependencies
-$ npm i
-```
+## Usage
 
-Compile all contracts:
+### Build
 
-```sh
-$ npm run build
+```shell
+$ forge build
 ```
 
-In a new terminal, launch an Ethereum RPC client, we use the default ganache-cli command to configure and run a local development ganache:
+### Test
 
-```sh
-$ npm run ganache
+```shell
+$ forge test
 ```
 
-Switch back to your other terminal and deploy the contracts, and make sure to:
-- Add your infura key in `.infuraKey` file
-- Add your wallet mnemonic in `.secret` file
-- Setup the deployments parameters in `./migrations/deployment-config.json` file
-
-```sh
-# Local deployment
-$ npm run deploy:development
+### Format
 
-# Mainnet deployment
-$ npm run deploy:mainnet
+```shell
+$ forge fmt
 ```
 
-## Running Tests
+### Gas Snapshots
 
-Run all unit tests:
-
-```sh
-$ npm run test:unit
+```shell
+$ forge snapshot
 ```
 
-Run all integration tests:
+### Anvil
 
-```sh
-$ npm run test:integration
+```shell
+$ anvil
 ```
 
-## Linting
-
-Clean code is the best code, so we've provided tools to automatically lint your projects.
+### Deploy
 
-Lint all smart contracts:
-
-```sh
-$ npm run lint:sol
+```shell
+$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
 ```
 
-Lint all tests files:
+### Cast
 
-```sh
-$ npm run lint:tests
+```shell
+$ cast <subcommand>
 ```
 
-### Automatically Fixing Linting Issues
-
-We've also provided tools to make it possible to automatically fix any linting issues. It's much easier than trying to fix issues manually.
-
-Fix all smart contracts:
+### Help
 
-```sh
-$ npm run lint:sol:prettier:fix
+```shell
+$ forge --help
+$ anvil --help
+$ cast --help
 ```
-
-Fix all tests files:
-
-```sh
-$ npm run lint:tests:prettier:fix
-```
-
-## Coverage
-
-We use the [solidity-coverage](https://github.com/sc-forks/solidity-coverage) package to generate our coverage reports. You can find the coverage report at [coveralls](https://coveralls.io/github/opynfinance/GammaProtocol?branch=master). Otherwise, you can generate it locally by running:
-
-```sh
-$ npm run coverage
-```
-
-The full report can be viewed by opening the `coverage/index.html` file in a browser.
-
-## Testnet deployments
-
-deployer: 0x775d1377223c9338771CbF955A9a53147219ea4A
-
-
-weth: 0xE32513090f05ED2eE5F3c5819C9Cce6d020Fefe7
-
-
-usdc: 0x3C6c9B6b41B9E0d82FeD45d9502edFFD5eD3D737
-
-
-addressbook: 0x2d3E178FFd961BD8C0b035C926F9f2363a436DdC
-
-
-otokenFactory: 0xcBcC61d56bb2cD6076E2268Ea788F51309FA253B
-
-
-otoken: 0x07F00EB70837091b2D23c902561CE8D1b4df4702
-
-
-whitelist: 0x0cc0b0C984036e0942544F70A5708Ab16463cd31
-
-
-oracle: 0xe4d64aed5e76bCcE2C255f3c819f4C3817D42f19
-
-
-pool: 0xDD91EB7C3822552D89a5Cb8D4166B1EB19A36Ff2
-
-
-calculator: 0xa91B46bDDB891fED2cEE626FB03E2929702951A6
-
-
-vault: 0x15887BD136Cdc8F170B8564e2E4568ee19C035F7
-
-
-controller: 0xb2923CAbbC7dd78e9573D1D6d755E75dCB49CE47
-
-
-pricer: 0xFfe61399050D2ACABa00419248B8616A4Bf56F9E
-
-
-eth-pricer-bot: 0x282f13b62b4341801210657e3aa4ee1df69f4083
-
-
-## Security And Bug Bounty Program
-
-The security of the Opyn protocol is our highest priority. Our team has created a protocol that we believe is safe and dependable, and has been audited by OpenZeppelin. All smart contract code is publicly verifiable and we have a bug bounty for undiscovered vulnerabilities. 
-We encourage our users to be mindful of risk and only use funds they can afford to lose. Options are complex instruments that when understood correctly can be powerful hedges. Smart contracts are still new and experimental technology. We want to remind our users to be optimistic about innovation while remaining cautious about where they put their money. 
-
-Please see [here](https://opyn.gitbook.io/opyn/security) for details on our security audit and bug bounty program.
diff --git a/contracts/interfaces/AddressBookInterface.sol b/contracts/interfaces/AddressBookInterface.sol
@@ -22,6 +22,8 @@ interface AddressBookInterface {
 
     function getAddress(bytes32 _id) external view returns (address);
 
+    function getKeeper() external view returns (address);
+
     /* Setters */
 
     function setOtokenImpl(address _otokenImpl) external;