Compare dev > main

.github/workflows/export-abis.yml

@@ -11,6 +11,9 @@ jobs:
   generate_interfaces:
     if: github.repository == 'open-dollar/od-contracts'
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        export_type: ['interfaces', 'contracts']
 
     steps:
       - uses: actions/checkout@v3
@@ -32,22 +35,24 @@ jobs:
       - name: Build project and generate out directory
         run: yarn build
 
-      - name: Add typechain to install dependencies
-        run: yarn add typechain @typechain/web3-v1 @typechain/ethers-v6
+      - name: Generate canary tag
+        if: github.ref_name != 'main'
+        run: yarn version --new-version "0.0.0-${GITHUB_SHA::8}" --no-git-tag-version
 
-      - name: Run Interface Exporter Action
-        uses: open-dollar/solidity-exporter-action@v1.0.1
+      - name: Export Solidity - ${{ matrix.export_type }}
+        uses: open-dollar/solidity-exporter-action@v2.0.17
         with:
-          out_dir: "out"
-          typing_type: "ethers-v6"
-          package_name: "@opendollar/abis"
-          destination_dir: "abis-package"
+          package_name: '@opendollar'
+          out: 'out'
+          interfaces: 'src/interfaces'
+          contracts: 'src/contracts'
+          libraries: 'src/libraries'
+          scripts: 'script'
+          tests: 'test'
 
-      - name: Generate canary tag
-        if: github.ref_name != 'main'
-        run: cd abis-package && yarn version --new-version "0.0.0-${GITHUB_SHA::8}" --no-git-tag-version
+          export_type: '${{ matrix.export_type }}'
 
       - name: Publish
-        run: cd abis-package && npm publish --access public
+        run: cd export/@opendollar/${{ matrix.export_type }} && npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -37,6 +37,11 @@ jobs:
   forge:
     name: Run Unit and E2E Tests
     runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+
     steps:
       - uses: actions/checkout@v3
         with:
@@ -46,15 +51,16 @@ jobs:
         uses: foundry-rs/foundry-toolchain@v1
         with:
           version: nightly
+          cache: true
 
       - name: Install forge dependencies
         run: forge install
 
       - name: Install yarn dependencies
         run: yarn install --frozen-lockfile
 
-      - name: Precompile using 0.8.19 and via-ir=false
-        run: yarn build
+      - name: Build 
+        run: forge build
 
       - name: "Create env file"
         run: |
@@ -68,30 +74,3 @@ jobs:
       - name: Run tests
         shell: bash
         run: yarn test
-
-  # coverage:
-  #   name: Run Coverage Tests
-  #   runs-on: ubuntu-latest
-
-  #   strategy:
-  #     matrix:
-  #       node-version: [16.x]
-
-  #   steps:
-  #     - uses: actions/checkout@v3
-  #     - name: Use Node.js
-  #       uses: actions/setup-node@v3
-  #       with:
-  #         node-version: ${{ matrix.node-version }}
-  #         cache: "yarn"
-  #     - name: Install Foundry
-  #       uses: foundry-rs/foundry-toolchain@v1
-  #       with:
-  #         version: nightly
-  #     - run: yarn install
-  #     - run: yarn build
-  #     - run: yarn coverage
-  #     - uses: codecov/codecov-action@v3
-  #       with:
-  #         files: ./coverage/lcov.info
-  #         flags: production

.gitignore

@@ -2,6 +2,7 @@
 yarn-error.log
 node_modules
 .DS_STORE
+.nvmrc
 
 # Foundry files
 cache
@@ -21,6 +22,7 @@ lcov.info
 !/**/.gitkeep
 .vscode/
 
+
 # Docs build files
 docs/book
 docs/src/src/

.gitmodules

@@ -1,13 +1,6 @@
 [submodule "lib/ds-test"]
-		path = lib/ds-test
-		url = https://github.com/dapphub/ds-test
-[submodule "lib/isolmate"]
-		path = lib/isolmate
-		url = https://github.com/defi-wonderland/isolmate
-[submodule "lib/prb-test"]
-		path = lib/prb-test
-		url = https://github.com/paulrberg/prb-test
-	    branch = 0.5.5
+	path = lib/ds-test
+	url = https://github.com/dapphub/ds-test
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std

LICENSE.md

@@ -5,6 +5,7 @@ Copyright (C) 2020 Maker Ecosystem Growth Holdings, INC.
 Copyright (C) 2020 Reflexer Labs, INC.
 Copyright (C) 2015-2020 DappHub, LLC
 Copyright (C) 2023 Reflexer Labs, INC.
+Copyright (C) 2024 OpenFi Foundation
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by

README.md

@@ -11,6 +11,8 @@
   </a>
 </p>
 
+[![codecov](https://codecov.io/gh/open-dollar/od-contracts/graph/badge.svg?token=SDTNS69Q36)](https://codecov.io/gh/open-dollar/od-contracts)
+
 This repository contains the core smart contract code for Open Dollar.
 
 # Resources
@@ -22,21 +24,23 @@ This repository contains the core smart contract code for Open Dollar.
 
 **Contract Deployments**
 
-Addresses for testnet can be found in the app: https://app.dev.opendollar.com/stats
+Addresses for can be found in the app: https://app.opendollar.com/stats
 
 **Tools**
 
 - `@opendollar/abis` - ABI interfaces are published automatically from this repo, on merge to `main` https://www.npmjs.com/package/@opendollar/abis
 - `@opendollar/sdk` - Library to interact with Open Dollar smart contracts https://github.com/open-dollar/od-sdk
 
-# Audits 
+# Audits
+
+| Audit     | Date          | Auditor                                       | Commit                                                                | Changes Since Audit                                                                | Report                                                                                                                                  |
+| --------- | ------------- | --------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| contracts | October, 2023 | [Cod4rena](https://code4rena.com)             | [f401eb5](https://github.com/open-dollar/od-contracts/commit/f401eb5) | [View Changes](https://github.com/open-dollar/od-contracts/compare/f401eb5...main) | [View Report](https://code4rena.com/reports/2023-10-opendollar)                                                                         |
+| app       | March, 2024   | [Quantstamp](https://www.quantstamp.com/)     | [7c9b18c](https://github.com/open-dollar/od-app/commit/7c9b18c)       | [View Changes](https://github.com/open-dollar/od-app/compare/7c9b18c...main)       | [View Report](https://certificate.quantstamp.com/full/open-dollar-d-app/f0ff4333-535d-4de6-96e0-8573623c18bf/index.html)                |
+| contracts | April, 2024   | [Quantstamp](https://www.quantstamp.com/)     | [6cdc848](https://github.com/open-dollar/od-contracts/commit/6cdc848) | [View Changes](https://github.com/open-dollar/od-contracts/compare/6cdc848...main) | [View Report](https://certificate.quantstamp.com/full/open-dollar-smart-contract-audit/202828fa-eb09-4d33-beab-c1ebee11ebd1/index.html) |
+| relayer   | April, 2024   | [Pashov Audit Group](https://www.pashov.net/) | [453222d](https://github.com/open-dollar/od-relayer/commit/453222d)   | [View Changes](https://github.com/open-dollar/od-relayer/compare/453222d...main)   | [View Report](https://github.com/pashov/audits/blob/master/team/pdf/OpenDollar-security-review.pdf)                                     |
 
-| Audit Number | Date | Auditor | Commit | Changes Since Audit | Report |
-|--------------|------|---------|--------|---------------------|--------|
-| 1 | October, 2023 | [Cod4rena](https://code4rena.com) | [f401eb5](https://github.com/open-dollar/od-contracts/commit/f401eb5) | [View Changes](https://github.com/open-dollar/od-contracts/compare/f401eb5...main) | [View Report](https://code4rena.com/reports/2023-10-opendollar) |
-| 2 | March, 2024 | [Quantstamp](https://www.trailofbits.com/) | [39d1a1c](https://github.com/open-dollar/od-contracts/commit/39d1a1c) | [View Changes](https://github.com/open-dollar/od-contracts/compare/39d1a1c...main) | Report to be published |
-| 3 | April, 2024 | [Pessimistic](https://pessimistic.io/) | [a0b7640](https://github.com/open-dollar/od-contracts/commit/a0b7640) | [View Changes](https://github.com/open-dollar/od-contracts/compare/a0b7640...main) | Report to be published |
-| 4 | April, 2024 | [Pashov Audit Group](https://www.pashov.net/) | [453222d](https://github.com/open-dollar/od-relayer/commit/453222d) | [View Changes](https://github.com/open-dollar/od-relayer/compare/453222d...main) | Report to be published |
+A Security Scan was performed by [Pessimistic](https://pessimistic.io/) April, 2024 at [a0b7640](https://github.com/open-dollar/od-contracts/commit/a0b7640). ([View Report](https://github.com/pessimistic-io/scans/blob/main/Open%20Dollar%20Security%20Scan%20Results.pdf))
 
 Additional audits completed prior to forking this codebase can be found here: https://github.com/hai-on-op/audit-reports
 
@@ -53,171 +57,6 @@ Run:
 
 When running `forge`, you can specify the profile to use using the FOUNDRY_PROFILE environment variable. e.g. `export FOUNDRY_PROFILE=test && forge test`. Alternatively, you can add `FOUNDRY_PROFILE=test` to `.env` and run `source .env`.
 
-## Governance Actions
-
-OpenDollar governance follows the common pattern of:
-
-- proposing a governance action
-- queuing the governance action
-- executing the governance action
-
-We include a set of governance scripts in `script/testScripts/gov` which allow DAO members to propose, queue and execute different governance actions.
-
-> NOTE: It is important that you use the `governance` profile when running the different scripts otherwise the reading and writing of JSON files will not work.
-
-### Overview
-
-#### General Files
-
-- [`JSONScript.s.sol`](script/testScripts/gov/JSONScript.s.sol): provides functionality for building JSON objects for proposing governance actions, parsing the proposal id for queuing proposals and parsing JSON objects for execution of the proposals.
-
-#### Proposing Governance Actions
-
-The current list of governance operations that can be proposed:
-
-- Add Collateral: Adding a new collateral type to the system which can be borrowed against
-- Update NFT Renderer: Sets the canonical NFT Renderer contract on Vault721
-
-The input for the proposal is specific to the proposal and what that proposal requires.
-
-The output is always a JSON file which includes at least the following `proposalParams`:
-
-```
-{
-    "proposalId": uint256,
-    "targets": address[],
-    "values": uint256[]
-    "calldatas": bytes[],
-    "description": string,
-    "descriptionHash": bytes32
-}
-```
-
-The JSON output may also include some extra params just for informative purposes.
-
-##### Add Collateral
-
-[`ProposeAddCollateral.s.sol`](script/testScripts/gov/AddCollateralAction/ProposeAddCollateral.s.sol)
-
-**Required env vars:**
-
-- `GOV_EXECUTOR_PK`: private key of the governance executor
-- `GOVERNANCE_ADDRESS`: address of OD Governance
-- `GLOBAL_SETTLEMENT_ADDRESS`: address of the global settlement contract
-- `ADD_COLLATERAL_NEW_COLLATERAL_TYPE`: bytes32 value of the new collateral type
-- `ADD_COLLATERAL_NEW_COLLATERAL_ADDRESS`: address of the new collateral address
-- `ADD_COLLATERAL_MINIMUM_BID`: minimum bid for the collateral auctions (wad)
-- `ADD_COLLATERAL_MIN_DISCOUNT`: minimum discount for the collateral auctions (wad %)
-- `ADD_COLLATERAL_MAX_DISCOUNT`: maximum discount for the collateral auctions (wad %)
-- `ADD_COLLATERAL_PER_SECOND_DISCOUNT_UPDATE_RATE`: Per second rate at which the discount is updated (ray)
-
-This script proposes adding a new collateral to the system (deploys new contracts via the collateral join and collateral auction house factories).
-
-##### Update NFT Renderer
-
-[`ProposeUpdateNFTRenderer.s.sol`](script/testScripts/gov/UpdateNFTRendererAction/ProposeUpdateNFTRenderer.s.sol)
-
-**Required env vars:**
-
-- `GOV_EXECUTOR_PK`: private key of the governance executor
-- `GOVERNANCE_ADDRESS`: address of OD Governance
-- `VAULT_721_ADDRESS`: address of the Vault721 contract
-- `ORACLE_RELAYER_ADDRESS`: address of the oracle relayer
-- `TAX_COLLECTOR_ADDRESS`: address of the tax collector
-- `COLLATERAL_JOIN_FACTORY_ADDRESS`: address of the collateral join factory
-
-This script proposes setting a new NFTRenderer contract on the Vault721 contract (deploys new NFTRenderer contract).
-
-##### Update Block Delay
-
-[`ProposeUpdateBlockDelay.s.sol`](script/testScripts/gov/UpdateBlockDelayAction/ProposeUpdateBlockDelay.s.sol)
-
-**Required env vars:**
-
-- `GOV_EXECUTOR_PK`: private key of the governance executor
-- `GOVERNANCE_ADDRESS`: address of OD Governance
-- `VAULT_721_ADDRESS`: address of the Vault721 contract
-- `BLOCK_DELAY`: the number of blocks to wait before being able to transfer after collateral or debt has been updated for allowlisted addresses
-
-This script proposes setting a new block delay on the Vault721 contract.
-
-##### Update Time Delay
-
-[`ProposeUpdateTimeDelay.s.sol`](script/testScripts/gov/UpdateTimeDelayAction/ProposeUpdateTimeDelay.s.sol)
-
-**Required env vars:**
-
-- `GOV_EXECUTOR_PK`: private key of the governance executor
-- `GOVERNANCE_ADDRESS`: address of OD Governance
-- `VAULT_721_ADDRESS`: address of the Vault721 contract
-- `TIME_DELAY`: the amount of time to wait before being able to transfer after collateral or debt has been updated for non-allowlisted addresses
-
-This script proposes setting a new time delay on the Vault721 contract.
-
-##### Update PIDController Params
-
-[`ProposeUpdatePidController.s.sol`](script/testScripts/gov/UpdatePidControllerAction/ProposeUpdatePidController.s.sol)
-
-**Required env vars:**
-
-- `GOV_EXECUTOR_PK`: private key of the governance executor
-- `GOVERNANCE_ADDRESS`: address of OD Governance
-- `PID_CONTROLLER_ADDRESS`: address of PID controller
-- `SEED_PROPOSER`: new seed proposer address
-- `NOISE_BARRIER`: new noise barrier value
-- `INTEGRAL_PERIOD_SIZE`: new integral period size value
-- `FEEDBACK_OUTPUT_UPPER_BOUND`: new feedback output upper bound value
-- `FEEDBACK_OUTPUT_LOWER_BOUND`: new feedback output lower bound value
-- `PER_SECOND_CUMULATIVE_LEAK`: new per second cumulative leak value
-- `KP`: new kp value
-- `KI`: new ki value
-- `PRICE_DEVIATION_CUMULATIVE`: new deviation observation integral value
-
-> NOTE: see [`IPIDController.sol`](src/interfaces/IPIDController.sol) for more information about this.
-
-This script proposes updating params on the PIDController contract.
-
-#### Queuing Governance Actions
-
-**Required env vars:**
-
-- `GOVERNANCE_ADDRESS`: address of OD Governance
-- `JSON_FILE_PATH`: the path to the desired JSON proposal file
-- `GOV_EXECUTOR_PK`: the private key of the queuer of the governance action
-
-[`QueueProposal.s.sol`](script/testScripts/gov/QueueProposal.s.sol) is used to queue a proposal given the path of the JSON file which you want, e.g. `export JSON_FILE_PATH=gov-output/1-add-collateral-proposal.json`.
-
-This script extracts the proposal id and queues the proposal via the OD governance contract. This script can be used arbitrarily for any proposal.
-
-#### Executing Governance Actions
-
-**Required env vars:**
-
-- `GOVERNANCE_ADDRESS`: address of OD Governance
-- `JSON_FILE_PATH`: the path to the desired JSON proposal file
-- `GOV_EXECUTOR_PK`: the private key of the executor of the governance action
-
-[`ExecuteProposal.s.sol`](script/testScripts/gov/ExecuteProposal.s.sol) is used to execute a proposal given the path of the JSON file you want, e.g. `export JSON_FILE_PATH=gov-output/1-add-collateral-proposal.json`.
-
-The script extracts the necessary execution params from the JSON-the same params used during the proposal and executes the proposal. This script can be used arbitrarily for any proposal.
-
-##### ERC20 Transfer
-
-[`ProposeERC20Transfer.s.sol`](script/testScripts/gov/ProposeERC20Transfer.s.sol)
-
-> NOTE: This script uses `transferFrom` to allow the governance to manage transfers from governance balance but also to allow the governance to transfer tokens from any address to any address
-
-**Required env vars:**
-
-- `GOV_EXECUTOR_PK`: private key of the governance executor
-- `GOVERNANCE_ADDRESS`: address of OD Governance
-- `ERC20_TRANSFER_TOKEN_ADDRESS`: address of the ERC20 contract
-- `ERC20_TRANSFER_FROM_ADDRESS`: address of the sender of the ERC20 tokens
-- `ERC20_TRANSFER_RECEIVER_ADDRESS`: address of the receiver of the ERC20 tokens
-- `ERC20_TRANSFER_AMOUNT`: amount to be transferred
-
-This script proposes transferring ERC20 tokens from one address to another.
-
 # Development
 
 ## Anvil