Merge pull request #225 from Axis-Fi/periphery-migration

Migrate callbacks to axis-periphery

.solhintignore

@@ -1,6 +1,6 @@
 lib/**
+dependencies/**
 src/modules/Modules.sol
 src/modules/Keycode.sol
-src/lib/**
-test/lib/uniswap-v2/*.sol
-test/lib/uniswap-v3/*.sol
+src/lib/clones/**
+src/lib/permit2/**

README.md

@@ -71,9 +71,8 @@ Many of the contracts (e.g. callbacks) require a specific address prefix or have
 
 - The code of a callback contract has been changed
   - This requires re-generating the salt for the contract. See the [test_salts.sh](/script/salts/test/test_salts.sh) script.
-- There has been a change to the dependencies under `/lib`. The dependencies affect the build output, so any changes will affect the bytecode generated by the Solidity compiler.
-  - If the submodule change was inadvertent, this can be fixed by running `pnpm run full-install` to reset the changes.
-  - In some cases, such as the `g-uni-v1-core` dependency, installing npm packages will result in the remappings being changed. It is best to remove the dependency's respective dependencies in order to fix this.
+- There has been a change to the dependencies under `/lib` or `/dependencies`. The dependencies affect the build output, so any changes will affect the bytecode generated by the Solidity compiler.
+  - If the change was inadvertent, this can be fixed by running `pnpm install` to reset the changes.
   - If the change to dependencies and invalidation of salts is expected, then new salts must be generated. In some cases (such as Uniswap V2 and V3 factories), the new addresses must be recorded in the `Constants.sol` file.
 
 ### Format
@@ -102,6 +101,18 @@ Deployments are listed in the [env.json file](/script/env.json) and periodically
 
 [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.
 
+NOTE: The import path of each dependency is versioned. This ensures that any changes to the dependency version result in clear errors to highlight the potentially-breaking change.
+
+#### Updating Dependencies
+
+When updating the version of a dependency provided through soldeer, the following must be performed:
+
+1. Update the version of the dependency in `foundry.toml` or through `forge soldeer`
+2. Re-run the [installation script](#first-run)
+3. If the version number has changed:
+    - Change the existing entry in [remappings.txt](remappings.txt) to point to the new dependency version
+    - Update imports to use the new remapping
+
 ### Packaging
 
 To publish a new package version to soldeer, run the following:

foundry.toml

@@ -1,7 +1,6 @@
 [profile.default]
 src = "src"
 out = "out"
-# libs = ["lib"]
 fs_permissions = [{access = "read-write", path = "./bytecode/"}, {access = "read", path = "./script/"}, {access = "read-write", path = "./deployments/"}]
 ffi = true
 solc_version = "0.8.19"
@@ -21,7 +20,6 @@ quote_style = "double"
 number_underscore = "thousands"
 wrap_comments = false
 ignore = [
-  "lib/**",
   "src/lib/**",
 ]
 
@@ -32,7 +30,4 @@ 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" }