Merge pull request #222 from Axis-Fi/soldeer

Soldeer Packaging
Axis-Fi · Jul 17, 2024 · e19ca19 · e19ca19
2 parents 9d7ebd5 + 46102ff
commit e19ca19
Show file tree

Hide file tree

Showing 134 changed files with 439 additions and 815 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -22,7 +22,7 @@ jobs:
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
-            version: 8
+            version: 9
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
@@ -48,24 +48,25 @@ jobs:
       - name: Run sccache-cache
         uses: mozilla-actions/[email protected]
 
-      - name: Build local ecies-cli for use with testing
-        run: cd crates/ecies-cli && cargo build && cd ../..
-
-      - name: Repo Install Script
+      - name: Install Dependencies
         run: |
-          chmod +x ./install.sh
-          ./install.sh
+          pnpm install
         shell: bash
 
       - name: Run lint check
         run: pnpm run lint:check
 
-      - name: Run Forge build
+      - name: Build Solidity Contracts
         run: |
           forge --version
           forge build
         id: build
 
+      - name: Build ECIES CLI
+        run: |
+          pnpm run build:ecies-cli
+        id: build-ecies-cli
+
       - name: Run Forge tests
         run: |
           pnpm run test

diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,6 @@ node_modules/
 
 # Bytecode
 bytecode/
+
+# soldeer
+dependencies/
diff --git a/.gitmodules b/.gitmodules
@@ -1,27 +0,0 @@
-[submodule "lib/forge-std"]
-	path = lib/forge-std
-	url = https://github.com/foundry-rs/forge-std
-[submodule "lib/solady"]
-	path = lib/solady
-	url = https://github.com/vectorized/solady
-[submodule "lib/solmate"]
-	path = lib/solmate
-	url = https://github.com/transmissions11/solmate
-[submodule "lib/prb-math"]
-	path = lib/prb-math
-	url = https://github.com/PaulRBerg/prb-math
-[submodule "lib/uniswap-v3-periphery"]
-	path = lib/uniswap-v3-periphery
-	url = https://github.com/uniswap/v3-periphery
-[submodule "lib/uniswap-v3-core"]
-	path = lib/uniswap-v3-core
-	url = https://github.com/uniswap/v3-core
-[submodule "lib/openzeppelin-contracts"]
-	path = lib/openzeppelin-contracts
-	url = https://github.com/openzeppelin/openzeppelin-contracts
-[submodule "lib/openzeppelin-contracts-upgradeable"]
-	path = lib/openzeppelin-contracts-upgradeable
-	url = https://github.com/openzeppelin/openzeppelin-contracts-upgradeable
-[submodule "lib/uniswap-v2-core"]
-	path = lib/uniswap-v2-core
-	url = https://github.com/uniswap/v2-core

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,15 @@
+# Changelog
+
+## 0.5.1
+
+- Migrates all dependencies over to soldeer packages and away from git submodules (#222)
+- Removes redundant dependencies (prb-math, uniswap-v3-periphery) (#222)
+- Packages the repository as a soldeer package (#222)
+- Use implicit imports in interfaces (#223)
+- Improvements to constant and deployment addresses (#220)
+
+## 0.5.0
+
+- Adds SVG for derivative tokens deployed using the LinearVesting module (#210)
+- Define the referrer fee on a per-auction basis (#216)
+- Standardise percentages on 2 basis points (100% = 100e2)
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ Axis is built in Solidity using Foundry as the development and test environment.
 ### First-Run
 
 ```shell
-pnpm run full-install
+pnpm install
 ```
 
 ### Build
@@ -96,4 +96,20 @@ Scripts are written in Solidity using Foundry and are divided into `deploy`, `sa
 
 ### Deployments
 
-Deployments are listed in the [Axis documentation](https://docs.axis.finance/references/03-technical/).
+Deployments are listed in the [env.json file](/script/env.json) and periodically updated in the [Axis documentation](https://axis.finance/developer/reference/contract-addresses).
+
+### Dependencies
+
+[soldeer](https://soldeer.xyz/) is used as the dependency manager, as it solves many of the problems inherent in forge's use of git submodules. Soldeer is integrated into `forge`, so should not require any additional installations.
+
+### Packaging
+
+To publish a new package version to soldeer, run the following:
+
+```shell
+pnpm run publish <version>
+```
+
+On first run, this requires authentication with soldeer: `soldeer login`
+
+The [CHANGELOG](CHANGELOG.md) file should also be updated.
diff --git a/foundry.toml b/foundry.toml
@@ -26,3 +26,13 @@ ignore = [
 ]
 
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options
+
+[dependencies]
+forge-std = { version = "1.9.1" }
+solmate = { version = "6.7.0", url = "[email protected]:transmissions11/solmate.git", commit = "c892309933b25c03d32b1b0d674df7ae292ba925" }
+solady = { version = "0.0.124" }
+"@openzeppelin-contracts" = { version = "4.9.2" }
+"@openzeppelin-contracts-upgradeable" = { version = "4.9.2" }
+"@uniswap-v2-core" = { version = "1.0.1" }
+"@uniswap-v3-core" = { version = "1.0.1-solc-0.8-simulate" }
+clones-with-immutable-args = { version = "1.1.1", git = "[email protected]:wighawag/clones-with-immutable-args.git", rev = "f5ca191afea933d50a36d101009b5644dc28bc99" }
diff --git a/install.sh b/install.sh
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/g-uni-v1-core/contracts/GUniFactory.sol b/lib/g-uni-v1-core/contracts/GUniFactory.sol
@@ -3,7 +3,7 @@ pragma solidity 0.8.19;
 
 import {
     IUniswapV3Factory
-} from "@uniswap/v3-core/contracts/interfaces/IUniswapV3Factory.sol";
+} from "@uniswap-v3-core-1.0.1-solc-0.8-simulate/interfaces/IUniswapV3Factory.sol";
 import {IUniswapV3TickSpacing} from "./interfaces/IUniswapV3TickSpacing.sol";
 import {IGUniFactory} from "./interfaces/IGUniFactory.sol";
 import {IGUniPoolStorage} from "./interfaces/IGUniPoolStorage.sol";
@@ -12,10 +12,10 @@ import {EIP173Proxy} from "./vendor/proxy/EIP173Proxy.sol";
 import {IEIP173Proxy} from "./interfaces/IEIP173Proxy.sol";
 import {
     IERC20Metadata
-} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+} from "@openzeppelin-contracts-4.9.2/token/ERC20/extensions/IERC20Metadata.sol";
 import {
     EnumerableSet
-} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+} from "@openzeppelin-contracts-4.9.2/utils/structs/EnumerableSet.sol";
 
 contract GUniFactory is GUniFactoryStorage, IGUniFactory {
     using EnumerableSet for EnumerableSet.AddressSet;

diff --git a/lib/g-uni-v1-core/contracts/GUniPool.sol b/lib/g-uni-v1-core/contracts/GUniPool.sol
@@ -3,20 +3,20 @@ pragma solidity 0.8.19;
 
 import {
     IUniswapV3MintCallback
-} from "@uniswap/v3-core/contracts/interfaces/callback/IUniswapV3MintCallback.sol";
+} from "@uniswap-v3-core-1.0.1-solc-0.8-simulate/interfaces/callback/IUniswapV3MintCallback.sol";
 import {
     IUniswapV3SwapCallback
-} from "@uniswap/v3-core/contracts/interfaces/callback/IUniswapV3SwapCallback.sol";
+} from "@uniswap-v3-core-1.0.1-solc-0.8-simulate/interfaces/callback/IUniswapV3SwapCallback.sol";
 import {GUniPoolStorage} from "./abstract/GUniPoolStorage.sol";
 import {
     IUniswapV3Pool
-} from "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
+} from "@uniswap-v3-core-1.0.1-solc-0.8-simulate/interfaces/IUniswapV3Pool.sol";
 import {TickMath} from "./vendor/uniswap/TickMath.sol";
 import {
     IERC20,
     SafeERC20
-} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
-import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol";
+} from "@openzeppelin-contracts-4.9.2/token/ERC20/utils/SafeERC20.sol";
+import {SafeCast} from "@openzeppelin-contracts-4.9.2/utils/math/SafeCast.sol";
 import {
     FullMath,
     LiquidityAmounts

diff --git a/lib/g-uni-v1-core/contracts/__mocks__/MockERC20.sol b/lib/g-uni-v1-core/contracts/__mocks__/MockERC20.sol
@@ -3,7 +3,7 @@ pragma solidity 0.8.19;
 
 import {
     ERC20Upgradeable
-} from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
+} from "@openzeppelin-contracts-upgradeable-4.9.2/token/ERC20/ERC20Upgradeable.sol";
 
 contract MockERC20 is ERC20Upgradeable {
     constructor() {

diff --git a/lib/g-uni-v1-core/contracts/__mocks__/SwapTest.sol b/lib/g-uni-v1-core/contracts/__mocks__/SwapTest.sol
@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity 0.8.19;
 
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20} from "@openzeppelin-contracts-4.9.2/token/ERC20/IERC20.sol";
 import {
     IUniswapV3SwapCallback
-} from "@uniswap/v3-core/contracts/interfaces/callback/IUniswapV3SwapCallback.sol";
+} from "@uniswap-v3-core-1.0.1-solc-0.8-simulate/interfaces/callback/IUniswapV3SwapCallback.sol";
 import {
     IUniswapV3Pool
-} from "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
+} from "@uniswap-v3-core-1.0.1-solc-0.8-simulate/interfaces/IUniswapV3Pool.sol";
 
 contract SwapTest is IUniswapV3SwapCallback {
     function swap(

diff --git a/lib/g-uni-v1-core/contracts/abstract/GUniFactoryStorage.sol b/lib/g-uni-v1-core/contracts/abstract/GUniFactoryStorage.sol
@@ -7,7 +7,7 @@ import {
 } from "contracts/lib/Initializable.sol";
 import {
     EnumerableSet
-} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+} from "@openzeppelin-contracts-4.9.2/utils/structs/EnumerableSet.sol";
 
 // solhint-disable-next-line max-states-count
 contract GUniFactoryStorage is

diff --git a/lib/g-uni-v1-core/contracts/abstract/GUniPoolStorage.sol b/lib/g-uni-v1-core/contracts/abstract/GUniPoolStorage.sol
@@ -5,14 +5,14 @@ import {Gelatofied} from "./Gelatofied.sol";
 import {OwnableUninitialized} from "./OwnableUninitialized.sol";
 import {
     IUniswapV3Pool
-} from "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
-import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+} from "@uniswap-v3-core-1.0.1-solc-0.8-simulate/interfaces/IUniswapV3Pool.sol";
+import {IERC20} from "@openzeppelin-contracts-4.9.2/token/ERC20/IERC20.sol";
 import {
     ReentrancyGuardUpgradeable
-} from "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
+} from "@openzeppelin-contracts-upgradeable-4.9.2/security/ReentrancyGuardUpgradeable.sol";
 import {
     ERC20Upgradeable
-} from "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
+} from "@openzeppelin-contracts-upgradeable-4.9.2/token/ERC20/ERC20Upgradeable.sol";
 
 /// @dev Single Global upgradeable state var storage base: APPEND ONLY
 /// @dev Add all inherited contracts with state vars here: APPEND ONLY

diff --git a/lib/g-uni-v1-core/contracts/abstract/Gelatofied.sol b/lib/g-uni-v1-core/contracts/abstract/Gelatofied.sol
@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: GPL-3.0
 pragma solidity 0.8.19;
 
-import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+import {Address} from "@openzeppelin-contracts-4.9.2/utils/Address.sol";
 import {
     IERC20,
     SafeERC20
-} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+} from "@openzeppelin-contracts-4.9.2/token/ERC20/utils/SafeERC20.sol";
 
 /// @dev DO NOT ADD STATE VARIABLES - APPEND THEM TO GelatoUniV3PoolStorage
 /// @dev DO NOT ADD BASE CONTRACTS WITH STATE VARS - APPEND THEM TO GelatoUniV3PoolStorage

diff --git a/lib/g-uni-v1-core/contracts/vendor/uniswap/LiquidityAmounts.sol b/lib/g-uni-v1-core/contracts/vendor/uniswap/LiquidityAmounts.sol
@@ -2,7 +2,7 @@
 pragma solidity >=0.5.0;
 
 import {FullMath} from "./FullMath.sol";
-import "@uniswap/v3-core/contracts/libraries/FixedPoint96.sol";
+import "@uniswap-v3-core-1.0.1-solc-0.8-simulate/libraries/FixedPoint96.sol";
 
 /// @title Liquidity amount functions
 /// @notice Provides functions for computing liquidity amounts from token amounts and prices

diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts
diff --git a/lib/openzeppelin-contracts-upgradeable b/lib/openzeppelin-contracts-upgradeable
diff --git a/lib/prb-math b/lib/prb-math
diff --git a/lib/solady b/lib/solady
diff --git a/lib/solmate b/lib/solmate
diff --git a/lib/uniswap-v2-core b/lib/uniswap-v2-core
diff --git a/lib/uniswap-v2-periphery/contracts/UniswapV2Router02.sol b/lib/uniswap-v2-periphery/contracts/UniswapV2Router02.sol
@@ -1,6 +1,6 @@
 pragma solidity >=0.6.6;
 
-import "uniswap-v2-core/interfaces/IUniswapV2Factory.sol";
+import "@uniswap-v2-core-1.0.1/interfaces/IUniswapV2Factory.sol";
 import './libraries/TransferHelper.sol';
 
 import './interfaces/IUniswapV2Router02.sol';

diff --git a/lib/uniswap-v2-periphery/contracts/libraries/UniswapV2Library.sol b/lib/uniswap-v2-periphery/contracts/libraries/UniswapV2Library.sol
@@ -1,6 +1,6 @@
 pragma solidity >=0.5.0;
 
-import {IUniswapV2Pair} from "uniswap-v2-core/interfaces/IUniswapV2Pair.sol";
+import {IUniswapV2Pair} from "@uniswap-v2-core-1.0.1/interfaces/IUniswapV2Pair.sol";
 import "./SafeMath.sol";
 
 library UniswapV2Library {

diff --git a/lib/uniswap-v3-core b/lib/uniswap-v3-core
diff --git a/lib/uniswap-v3-periphery b/lib/uniswap-v3-periphery
diff --git a/package.json b/package.json
@@ -13,10 +13,11 @@
     "deploy": "./script/deploy/deploy.sh",
     "fmt:check": "forge fmt --check",
     "fmt": "forge fmt",
-    "full-install": "./install.sh",
     "lint:all": "pnpm run fmt && pnpm run solhint:all",
     "lint:check": "pnpm run fmt:check && pnpm run solhint:check",
     "lint": "pnpm run fmt && pnpm run solhint",
+    "postinstall": "./script/install.sh",
+    "publish": "./script/publish.sh",
     "salts": "./script/salts/write_salt.sh",
     "size": "forge clean && forge build --sizes --skip test --skip '*/Mock*.sol'",
     "solhint:all": "solhint --fix --config ./.solhint.json 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'",
@@ -26,7 +27,7 @@
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "BSL-1.1",
   "dependencies": {
     "solhint-community": "^3.7.0"
   }

diff --git a/remappings.txt b/remappings.txt
@@ -1,11 +1,9 @@
-ds-test/=lib/forge-std/lib/ds-test/src/
-forge-std/=lib/forge-std/src/
-solady/=lib/solady/src/
-solmate/=lib/solmate/src/
-uniswap-v2-core/=lib/uniswap-v2-core/contracts/
-uniswap-v3-core/=lib/uniswap-v3-core/contracts/
-uniswap-v3-periphery/=lib/uniswap-v3-periphery/contracts/
-@uniswap/v3-core/=lib/uniswap-v3-core/
-@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
-@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
 g-uni-v1-core/=lib/g-uni-v1-core/contracts/
+@forge-std-1.9.1=dependencies/forge-std-1.9.1/src
+@solmate-6.7.0=dependencies/solmate-6.7.0/src
+@solady-0.0.124=dependencies/solady-0.0.124/src
+@openzeppelin-contracts-4.9.2=dependencies/@openzeppelin-contracts-4.9.2
+@openzeppelin-contracts-upgradeable-4.9.2=dependencies/@openzeppelin-contracts-upgradeable-4.9.2
+@uniswap-v2-core-1.0.1=dependencies/@uniswap-v2-core-1.0.1/contracts
+@uniswap-v3-core-1.0.1-solc-0.8-simulate=dependencies/@uniswap-v3-core-1.0.1-solc-0.8-simulate/contracts
+@clones-with-immutable-args-1.1.1=dependencies/clones-with-immutable-args-1.1.1/src