v2.4

.github/workflows/gas_report_and_code_size.yml

@@ -0,0 +1,104 @@
+name: Gas Report and Code Size
+
+on: [pull_request]
+
+jobs:
+  gas-report-and-code-size:
+    permissions:
+      pull-requests: write
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.19
+
+      - name: Checkout Base Branch
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.base_ref }}
+
+      - name: Install packages
+        run: yarn --frozen-lockfile
+
+      - name: Compile
+        run: yarn workspaces run compile
+
+      - name: Run gas report script for base branch
+        env:
+            MAINNET_NODE_URL: ${{ secrets.MAINNET_NODE_URL }}
+        run: yarn workspace @perennial/v2-core run gasReport
+
+      - name: Upload cache folder
+        uses: actions/upload-artifact@v4
+        with:
+          name: perennial-cache
+          path: packages/core/cache
+          if-no-files-found: error
+          retention-days: 1
+          include-hidden-files: true
+
+      - name: Checkout PR branch
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Download cache folder
+        uses: actions/download-artifact@v4
+        with:
+          name: perennial-cache
+          path: packages/core/cache
+
+      - name: Install packages
+        run: yarn --frozen-lockfile
+
+      - name: Compile and get code size diff
+        run: ./code-size.sh
+
+      - name: Run Gas Report Script for PR branch and get gas diff
+        env:
+            MAINNET_NODE_URL: ${{ secrets.MAINNET_NODE_URL }}
+        run: ./gas-report.sh
+
+      - name: Comment PR with code size and gas report
+        uses: actions/github-script@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const fs = require('fs');
+            const prNumber = context.payload.pull_request.number;
+
+            const isWorkflowComment = (comment) => {
+              return (comment.body.includes('### Code Size Diff:') || comment.body.includes('### Gas Report Diff:'));   
+            };
+
+            const { data: comments } = await github.rest.issues.listComments({
+              ...context.repo,
+              issue_number: prNumber,
+            });
+
+            for (const comment of comments) {
+              if (isWorkflowComment(comment)) {
+                await github.rest.issues.deleteComment({
+                  ...context.repo,
+                  comment_id: comment.id,
+                });
+              }
+            }
+
+            const code_size = fs.readFileSync('code_size.txt', 'utf8');
+            const gas_report = fs.readFileSync('gas_report.txt', 'utf8');
+
+            // Post the Code Size comment
+            await github.rest.issues.createComment({
+              ...context.repo,
+              issue_number: prNumber,
+              body: `### Code Size Diff:\n\n${code_size}\n`
+            });
+
+            // Post the Gas Report comment
+            await github.rest.issues.createComment({
+              ...context.repo,
+              issue_number: prNumber,
+              body: `### Gas Report Diff:\n\n${gas_report}\n`
+            });

.gitignore

@@ -6,3 +6,4 @@ node_modules
 .vscode
 
 **/.env
+**/docs

README.md

@@ -10,7 +10,7 @@
 | ----------------------- | :-------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------: |
 | `@perennial/core`       | Core perennial smart contracts.   |                                 [![npm version](https://badge.fury.io/js/@perennial%2Fcore.svg)](https://badge.fury.io/js/@perennial%2Fcore) |
 | `@perennial/deploy`     | Deployment scripts and artifacts. |         [![npm version](https://badge.fury.io/js/@perennial%2Fperennial/deploy.svg)](https://badge.fury.io/js/@perennial%2Fperennial/deploy) |
-| `@perennial/extensions` | Extension smart contracts.        | [![npm version](https://badge.fury.io/js/@perennial%2Fperennial/extensions.svg)](https://badge.fury.io/js/@perennial%2Fperennial/extensions) |
+| `@perennial/periphery`  | MultiInvoker and extension contracts. | [![npm version](https://badge.fury.io/js/@perennial%2Fperennial/periphery.svg)](https://badge.fury.io/js/@perennial%2Fperennial/periphery) |
 | `@perennial/oracle`     | Oracle provider smart contracts.  |         [![npm version](https://badge.fury.io/js/@perennial%2Fperennial/oracle.svg)](https://badge.fury.io/js/@perennial%2Fperennial/oracle) |
 | `@perennial/vault`      | Vault smart contracts.            |           [![npm version](https://badge.fury.io/js/@perennial%2Fperennial/vault.svg)](https://badge.fury.io/js/@perennial%2Fperennial/vault) |
 
@@ -36,16 +36,23 @@ Compile the smart contracts for each package with Hardhat:
 $ yarn workspaces run compile
 ```
 
-This also generates the Typechain types
+This also generates the Typechain types.
 
-### Test
+### Docs
+
+Perennial has 4 logic packages: `core`, `deploy`, `periphery`, `oracle`, and `vault`
+
+To compile code documentation for a specific package:
+```sh
+$ yarn workspace @perennial/<package-name> run doc
+```
 
-Perennial has 4 logic packages: `core`, `deploy`, `extensions`, `oracle`, and `vault`
+### Test
 
 Run the Mocha unit tests a specific package:
 
 ```sh
-$ yarn workspace @equilibria/<package-name> run test
+$ yarn workspace @perennial/<package-name> run test
 ```
 
 For example, to run the tests for the core package:
@@ -57,7 +64,7 @@ $ yarn workspace @perennial/core run test
 To run tests against a Mainnet fork, set your `MAINNET_NODE_URL` in the root `.env` and run
 
 ```sh
-$ yarn workspace run @equilibria/<package-name> test:integration
+$ yarn workspace run @perennial/<package-name> test:integration
 ```
 
 For example, to run the integration tests for the core package:
@@ -78,4 +85,4 @@ The vast majority of the Perennial V2 codebase is licensed under the Apache 2.0
 | License      | License                                                                               |
 | ------------ | :------------------------------------------------------------------------------------ |
 | `Apache-2.0` | All, unless stated otherwise.                                                         |
-| `BUSL-1.1`   | Smart contracts: `Market.sol` and `MarketFactory.sol` in the `@perennial-v2` package. |
+| `BUSL-1.1`   | Smart contracts: `Market.sol` and `MarketFactory.sol` in the `@perennial/core` package. |

code-size.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Output file path
+output_file="code_size.txt"
+
+# Run the command and filter lines that start with '|' or '·', removing color codes
+filtered_output=$(yarn workspaces run build | grep -E '^\s*(\||·)' | sed -r 's/\x1B\[[0-9;]*[mK]//g')
+
+# Extract only the core contracts table
+core_code_size_table=$(echo "$filtered_output" | awk '
+    /·--/ {
+        # Capture first table starting and ending with ·--
+        if (capturing) {
+            print
+            exit
+        }
+        capturing = 1
+    }
+    capturing {
+        print
+    }
+')
+
+# Format the captured table for GitHub comment with collapsible section
+formatted_core_code_size_table="<details>\n<summary>View Report</summary>\n\n\`\`\`\n$core_code_size_table\n\`\`\`\n</details>"
+
+# Write the formatted table to the output file
+printf "%b" "$formatted_core_code_size_table" > "$output_file"

gas-report.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# Run the gas report command and filter lines that start with optional spaces followed by '|' or '·'
+filtered_output=$(yarn workspace @perennial/v2-core run gasReport | grep -E '^\s*(\||·)' | sed -r 's/\x1B\[[0-9;]*[mK]//g')
+
+# Function to extract the gas report
+extract_gas_report() {
+    echo "$filtered_output" | awk '
+    /·--/ { 
+        table_count++           # Increment table count at each boundary
+        if (table_count == 4) {  # Start capturing when reaching the third table
+            capturing = 1
+        }
+        next
+    }
+    capturing { print }         # Print only lines within the third table
+    '
+}
+
+# Capture the gas report table output
+gas_report_output=$(extract_gas_report)
+
+# Format the gas report table output for a GitHub comment collapse section
+formatted_gas_report_output="<details>\n<summary>View Report</summary>\n\n\`\`\`\n$gas_report_output\n\`\`\`\n</details>"
+
+# Write the formatted gas report table output to a file
+printf "%b" "$formatted_gas_report_output" > gas_report.txt

package.json

@@ -39,7 +39,7 @@
     "hardhat-contract-sizer": "^2.10.0",
     "hardhat-dependency-compiler": "1.1.3",
     "hardhat-deploy": "0.11.31",
-    "hardhat-gas-reporter": "1.0.9",
+    "hardhat-gas-reporter": "2.2.1",
     "hardhat-tracer": "2.5.1",
     "husky": ">=6",
     "lerna": "^4.0.0",
@@ -51,6 +51,7 @@
     "solhint": "^3.4.1",
     "solhint-plugin-prettier": "0.0.5",
     "solidity-coverage": "0.8.3",
+    "solidity-docgen": "^0.6.0-beta.36",
     "ts-generator": "^0.1.1",
     "ts-node": "^9.0.0",
     "typechain": "^8.1.0",

packages/common/hardhat.default.config.ts

@@ -10,6 +10,7 @@ import 'hardhat-deploy'
 import 'hardhat-dependency-compiler'
 import 'hardhat-tracer'
 import 'solidity-coverage'
+import 'solidity-docgen'
 
 import { getChainId, isArbitrum, isBase, isOptimism, SupportedChain } from './testutil/network'
 
@@ -130,7 +131,7 @@ export default function defaultConfig({
           : undefined,
         chainId: getChainId('hardhat'),
         allowUnlimitedContractSize: true,
-        blockGasLimit: 32000000,
+        blockGasLimit: 32_000_000,
         mining: NODE_INTERVAL_MINING
           ? {
               interval: NODE_INTERVAL_MINING,
@@ -210,6 +211,7 @@ export default function defaultConfig({
       currency: 'USD',
       gasPrice: 100,
       enabled: process.env.REPORT_GAS ? true : false,
+      trackGasDeltas: true,
     },
     typechain: {
       outDir: 'types/generated',
@@ -222,6 +224,9 @@ export default function defaultConfig({
       timeout: 4800000,
       retries: Number(MOCHA_RETRY_COUNT),
     },
+    docgen: {
+      pages: 'files',
+    },
     contractSizer: {
       alphaSort: true,
       disambiguatePaths: false,

packages/core/contracts/InsuranceFund.sol

@@ -0,0 +1,52 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity 0.8.24;
+
+import { Ownable } from "@equilibria/root/attribute/Ownable.sol";
+import { Token18 } from "@equilibria/root/token/types/Token18.sol";
+import { Fixed6, Fixed6Lib } from "@equilibria/root/number/types/Fixed6.sol";
+import { IFactory } from "@equilibria/root/attribute/interfaces/IFactory.sol";
+import { IInstance } from "@equilibria/root/attribute/interfaces/IInstance.sol";
+
+import { IInsuranceFund } from "./interfaces/IInsuranceFund.sol";
+import { IMarket } from "./interfaces/IMarket.sol";
+
+/// @title InsuranceFund
+/// @notice This contract manages the protocol fee and shortfalls for markets.
+contract InsuranceFund is IInsuranceFund, Ownable {
+
+    /// @dev The address of the market factory
+    IFactory public immutable marketFactory;
+
+    /// @dev The address of token
+    Token18 public immutable token;
+
+    constructor(IFactory _marketFactory, Token18 _token) {
+        marketFactory = _marketFactory;
+        token = _token;
+    }
+
+    /// @inheritdoc IInsuranceFund
+    function initialize() external initializer(1) {
+        __Ownable__initialize();
+    }
+
+    /// @inheritdoc IInsuranceFund
+    function claim(IMarket market) external isMarketInstance(market) {
+        market.claimFee(marketFactory.owner());
+    }
+
+    /// @inheritdoc IInsuranceFund
+    function resolve(IMarket market, address account) external onlyOwner isMarketInstance(market) {
+        token.approve(address(market));
+        market.settle(account);
+        Fixed6 resolutionAmount = market.locals(account).collateral.mul(Fixed6Lib.NEG_ONE);
+        market.update(account, Fixed6Lib.ZERO, resolutionAmount, address(0));
+    }
+
+    /// @notice Validates that a market was created by the market factory
+    /// @param market Market to validate
+    modifier isMarketInstance(IMarket market) {
+        if (!marketFactory.instances(IInstance(market))) revert InsuranceFundInvalidInstanceError();
+        _;
+    }
+}