BIP-X: Secure Beanstalk

.github/workflows/ci.protocol.yaml

@@ -7,14 +7,34 @@ on:
       - "protocol/**"
 
 jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+      - run: yarn add prettier prettier-plugin-solidity
+      # - run: shopt -s globstar; yarn dlx -p prettier prettier --write --config .prettierrc --plugin=prettier-plugin-solidity protocol/**/*.sol || true
+      - run: shopt -s globstar; yarn prettier --write --config .prettierrc --plugin=prettier-plugin-solidity protocol/**/*.sol || true
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: prettier auto formatting changes
+          branch: ${{ github.head_ref }}
+      - name: check format
+        run: shopt -s globstar; yarn prettier --check --config .prettierrc --plugin=prettier-plugin-solidity protocol/**/*.sol
   test:
+    needs: format
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - name: Protocol Tests
         uses: actions/setup-node@v3
         with:
-          node-version: "16"
+          node-version: "18"
       - name: Cache Node Modules
         id: node-modules-cache
         uses: actions/cache@v3
@@ -23,7 +43,7 @@ jobs:
           key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
       - name: Install Dependencies
         if: steps.node-modules-cache.outputs.cache-hit != 'true'
-        run: yarn install --no-immutable
+        run: yarn install --immutable
       - run: yarn generate
         working-directory: protocol
       - run: yarn test

.gitignore

@@ -42,4 +42,5 @@ node_modules
 # Local Netlify folder
 .netlify
 
-protocol/lib/forge-std
+# forge libraries.
+protocol/lib/

.gitmodules

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

.prettierrc

@@ -2,5 +2,20 @@
   "printWidth": 100,
   "singleQuote": false,
   "semi": true,
-  "trailingComma": "none"
-}
+  "trailingComma": "none",
+
+  "plugins": ["prettier-plugin-solidity"],
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "parser": "solidity-parse",
+        "printWidth": 100,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false
+      }
+    }
+  ]
+}

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "streetsidesoftware.code-spell-checker",
+        "esbenp.prettier-vscode",
+        "juanblanco.solidity"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "editor.formatOnSave": true,
+    "solidity.formatter": "prettier"
+}

package.json

@@ -13,7 +13,7 @@
     "jest": "29.2.2",
     "jest-serial-runner": "1.2.1",
     "lint-staged": "13.1.0",
-    "prettier": "2.7.1",
+    "prettier": "3.2.5",
     "ts-jest": "29.0.3",
     "ts-node": "10.9.1",
     "typescript": "4.8.4"
@@ -47,5 +47,8 @@
     "ex": "yarn workspace @beanstalk/examples x",
     "anvil": "anvil --fork-url https://eth-mainnet.g.alchemy.com/v2/5ubn94zT7v7DnB5bNW1VOnoIbX5-AG2N --chain-id 1337",
     "anvil4tests": "anvil --fork-url https://eth-mainnet.g.alchemy.com/v2/Kk7ktCQL5wz4v4AG8bR2Gun8TAASQ-qi  --chain-id 1337 --fork-block-number 18629000"
+  },
+  "dependencies": {
+    "prettier-plugin-solidity": "1.3.1"
   }
 }

projects/sdk/docs/README.md

@@ -134,21 +134,7 @@ Available contracts:
 ```javascript
 sdk.contracts = {
   beanstalk: Beanstalk,
-  curve: {
-    pools: {
-      pool3: Curve3Pool,
-      tricrypto2: CurveTriCrypto2Pool,
-      beanCrv3: CurveMetaPool,
-      [k: string]: BaseContract   // allows getting a contract by address
-    },
-    registries: {
-      poolRegistry: CurveRegistry,
-      metaFactory: CurveMetaFactory,
-      cryptoFactory: CurveCryptoFactory,
-      [k: string]: BaseContract,  // allows getting a contract by address
-    },
-    zap: CurveZap,
-  },
+  .....
 };
 ```
 

projects/sdk/src/lib/silo.test.ts

@@ -33,6 +33,7 @@ beforeAll(async () => {
 
   await sdk.silo.deposit(sdk.tokens.BEAN, sdk.tokens.BEAN, amount, 0.1, account);
 });
+
 describe("Silo Balance loading", () => {
   describe("getBalance", function () {
     it("returns an empty object", async () => {

projects/subgraph-beanstalk/src/FieldHandler.ts

@@ -1,6 +1,5 @@
 import { Address, BigDecimal, BigInt, log } from "@graphprotocol/graph-ts";
 import {
-  FundFundraiser,
   Harvest,
   PlotTransfer,
   Sow,
@@ -474,23 +473,6 @@ export function handleSupplyNeutral(event: SupplyNeutral): void {
   );
 }
 
-export function handleFundFundraiser(event: FundFundraiser): void {
-  // Account for the fact thta fundraiser sow using no soil.
-  let beanstalk = loadBeanstalk(event.address);
-  updateFieldTotals(
-    event.address,
-    beanstalk.lastSeason,
-    ZERO_BI,
-    ZERO_BI.minus(event.params.amount),
-    ZERO_BI,
-    ZERO_BI,
-    ZERO_BI,
-    ZERO_BI,
-    event.block.timestamp,
-    event.block.number
-  );
-}
-
 function updateFieldTotals(
   account: Address,
   season: i32,

projects/subgraph-beanstalk/subgraph.yaml

@@ -120,8 +120,6 @@ dataSources:
           handler: handleSupplyDecrease
         - event: SupplyNeutral(indexed uint256,int256)
           handler: handleSupplyNeutral
-        - event: FundFundraiser(indexed address,indexed uint32,uint256)
-          handler: handleFundFundraiser
       file: ./src/FieldHandler.ts
   - kind: ethereum/contract
     name: Season

projects/subgraph-beanstalk/tests/event-mocking/Field.ts

@@ -28,4 +28,3 @@ export function createPlotTransferEvent(from: string, to: string, id: BigInt, po
 export function createSupplyIncreaseEvent(season: BigInt, price: BigInt, newHarvestable: BigInt, newSilo: BigInt, issuedSoil: i32): void { }
 export function createSupplyDecreaseEvent(season: BigInt, price: BigInt, issuedSoil: i32): void { }
 export function createSupplyNeutralEvent(season: BigInt, issuedSoil: i32): void { }
-export function createFundFundraiserEvent(id: BigInt, fundraiser: string, token: string, amount: BigInt): void { }

protocol/.solcover.js

@@ -8,9 +8,7 @@ module.exports = {
     './libraries/LibSafeMath128.sol',
     './libraries/Decimal.sol',
     './libraries/LibDiamond.sol',
-    './facets/DiamondLoupeFacet.sol',
-    './libraries/Convert/LibPlainCurveConvert.sol',
-    './libraries/Curve/LibBeanLUSDCurve.sol'
+    './facets/DiamondLoupeFacet.sol'
   ]
 
 };

protocol/README.md

@@ -61,6 +61,7 @@ yarn hardhat compile
 
 ### Testing
 
+#### Hardhat
 1. Ensure you are in the `protocol` directory
 2. Have a [FORKING_RPC](https://hardhat.org/hardhat-network/docs/guides/forking-other-networks) as an [environment variable](https://www.npmjs.com/package/dotenv) pointing to ETH Mainnet.
    1. _We fork ETH Mainnet to run our test suite locally. Note, this will make a large number of API calls to your `FORKING_RPC`_
@@ -76,6 +77,12 @@ yarn test
 yarn hardhat coverage
 ```
 
+#### Foundry
+1. Ensure you are in the `protocol` directory
+2. Install foundry with `foundryup` - instructions [here](https://book.getfoundry.sh/getting-started/installation)
+3. `forge install foundry-rs/forge-std --no-commit`
+4. `forge test`
+
 ### Forking Mainnet Locally
 
 We elect to use `anvil` instead of `hardhat` for local node forking as `anvil` is considerably faster than `hardhat` and properly caches the blockchain locally.