├── .github └── workflows │ └── test.yml ├── .gitignore ├── .gitmodules ├── .vscode └── settings.json ├── README.md ├── foundry.toml ├── lib ├── forge-std │ ├── .github │ │ └── workflows │ │ │ ├── ci.yml │ │ │ └── sync.yml │ ├── .gitignore │ ├── .gitmodules │ ├── LICENSE-APACHE │ ├── LICENSE-MIT │ ├── README.md │ ├── foundry.toml │ ├── lib │ │ └── ds-test │ │ │ ├── .github │ │ │ └── workflows │ │ │ │ └── build.yml │ │ │ ├── .gitignore │ │ │ ├── LICENSE │ │ │ ├── Makefile │ │ │ ├── default.nix │ │ │ ├── demo │ │ │ └── demo.sol │ │ │ ├── package.json │ │ │ └── src │ │ │ ├── test.sol │ │ │ └── test.t.sol │ ├── package.json │ ├── src │ │ ├── Base.sol │ │ ├── Script.sol │ │ ├── StdAssertions.sol │ │ ├── StdChains.sol │ │ ├── StdCheats.sol │ │ ├── StdError.sol │ │ ├── StdInvariant.sol │ │ ├── StdJson.sol │ │ ├── StdMath.sol │ │ ├── StdStorage.sol │ │ ├── StdStyle.sol │ │ ├── StdUtils.sol │ │ ├── Test.sol │ │ ├── Vm.sol │ │ ├── console.sol │ │ ├── console2.sol │ │ ├── interfaces │ │ │ ├── IERC1155.sol │ │ │ ├── IERC165.sol │ │ │ ├── IERC20.sol │ │ │ ├── IERC4626.sol │ │ │ ├── IERC721.sol │ │ │ └── IMulticall3.sol │ │ └── safeconsole.sol │ └── test │ │ ├── StdAssertions.t.sol │ │ ├── StdChains.t.sol │ │ ├── StdCheats.t.sol │ │ ├── StdError.t.sol │ │ ├── StdMath.t.sol │ │ ├── StdStorage.t.sol │ │ ├── StdStyle.t.sol │ │ ├── StdUtils.t.sol │ │ ├── compilation │ │ ├── CompilationScript.sol │ │ ├── CompilationScriptBase.sol │ │ ├── CompilationTest.sol │ │ └── CompilationTestBase.sol │ │ └── fixtures │ │ └── broadcast.log.json └── solpretty │ ├── .github │ └── workflows │ │ └── test.yml │ ├── .gitignore │ ├── .gitmodules │ ├── .vscode │ └── settings.json │ ├── README.md │ ├── foundry.toml │ ├── src │ └── SolPretty.sol │ └── test │ └── SolPretty.t.sol ├── script └── Counter.s.sol ├── src ├── LibMemArray.sol └── LibMemDict.sol └── test ├── LibMemArray.t.sol └── LibMemDict.t.sol /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: workflow_dispatch 4 | 5 | env: 6 | FOUNDRY_PROFILE: ci 7 | 8 | jobs: 9 | check: 10 | strategy: 11 | fail-fast: true 12 | 13 | name: Foundry project 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/checkout@v3 17 | with: 18 | submodules: recursive 19 | 20 | - name: Install Foundry 21 | uses: foundry-rs/foundry-toolchain@v1 22 | with: 23 | version: nightly 24 | 25 | - name: Run Forge build 26 | run: | 27 | forge --version 28 | forge build --sizes 29 | id: build 30 | 31 | - name: Run Forge tests 32 | run: | 33 | forge test -vvv 34 | id: test 35 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiler files 2 | cache/ 3 | out/ 4 | 5 | # Ignores development broadcast logs 6 | !/broadcast 7 | /broadcast/*/31337/ 8 | /broadcast/**/dry-run/ 9 | 10 | # Docs 11 | docs/ 12 | 13 | # Dotenv file 14 | .env 15 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "lib/forge-std"] 2 | path = lib/forge-std 3 | url = https://github.com/foundry-rs/forge-std 4 | [submodule "lib/solpretty"] 5 | path = lib/solpretty 6 | url = https://github.com/devtooligan/solpretty 7 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | 2 | 3 | { 4 | "workbench.colorCustomizations": { 5 | "titleBar.activeForeground": "#000000", 6 | "titleBar.inactiveForeground": "#000000", 7 | "titleBar.activeBackground": "#8ccbfe", 8 | "titleBar.inactiveBackground": "#8ccbfe" 9 | }, 10 | "editor.tokenColorCustomizations": { 11 | "textMateRules": [ 12 | { 13 | "scope": [ 14 | "comment", 15 | ], 16 | "settings": { 17 | "fontStyle": "", 18 | } 19 | } 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## MemoryStrux 2 | 3 | **Optimized, in-memory, memory safe data structures.** 4 | 5 | __This is a proof of concept for you to build on, not fully tested or production ready__ 6 | 7 | 8 | - [MemArray](#MemArray): Dynamic resizing uint array. 9 | - [MemDict](#MemDict): Dictionary type data structure with import/export to storage mappings. 10 | 11 | ## Usage 12 | 13 | ### MemArray 14 | 15 | _Optimized, memory-safe, dynamically resizing, in-memory array._ 16 | 17 | ```solidity 18 | type MemArray is bytes32; 19 | 20 | MemArray myArray = LibMemArray.create(); 21 | 22 | // push, pop, get 23 | myArray.push(0x69); // [0x69] 24 | myArray.push(0x420); // [0x69, 0x420] 25 | myArray.get(1); // 0x420 26 | myArray.pop(); // (returns 0x420) [0x69] 27 | 28 | // to/from legacy array 29 | uint[] memory legacyArray = myArray.toArray(); 30 | MemArray myOtherArray = legacyArray.fromArray(); 31 | 32 | ``` 33 | 34 | ### MemDict 35 | _Optimized, memory-safe, dynamically resizing, in-memory dictionary like data structure._ 36 | 37 | Note: This is _not_ a hash map and lookup times are O(n). However, due to gas, for smaller dictionaries the cost is less than a O(1) lookup in a storage mapping. 38 | 39 | ```solidity 40 | type MemDict is bytes32; 41 | 42 | MemDict myDict = LibMemDict.create(); 43 | myDict.set(0x01, 0x999); 44 | myDict.get(0x01); 45 | ``` 46 | 47 | In addition to basic functionality, MemDict can be imported from or exported to a storage mapping: 48 | 49 | ```solidity 50 | mapping(uint -> uint) public myMapping; 51 | 52 | uint[] keys = new uint[](3); 53 | keys[0] = 1 54 | keys[1] = 2 55 | keys[2] = 3 56 | 57 | MemDict myDict = LibMemDict.create(); 58 | myDict.set(keys[0], 0x69); 59 | myDict.set(keys[1], 0x6969); 60 | myDict.set(keys[2], 0x696969); 61 | 62 | myDict.toMapping(myMapping); // sets values of 3 keys on storage mapping 63 | 64 | MemDict myOtherDict = LibMemDict.createFromMapping(myMapping, keys); // creates new MemDict based on storage values for selected keys 65 | 66 | ``` 67 | 68 | ## Future Direction 69 | 70 | - [x] Uint MemArray 71 | - [ ] Int MemArray 72 | - [ ] Bytes32 MemArray 73 | - [x] Dictionary 74 | - [ ] Set 75 | - [ ] Queue 76 | - [ ] Stack 77 | - [x] Linked List (TODO: separate LL logic from MemArray) 78 | - [ ] Tree 79 | - [ ] Graph 80 | -------------------------------------------------------------------------------- /foundry.toml: -------------------------------------------------------------------------------- 1 | [profile.default] 2 | src = "src" 3 | out = "out" 4 | libs = ["lib"] 5 | 6 | # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options 7 | -------------------------------------------------------------------------------- /lib/forge-std/.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | push: 7 | branches: 8 | - master 9 | 10 | jobs: 11 | build: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v3 15 | 16 | - name: Install Foundry 17 | uses: onbjerg/foundry-toolchain@v1 18 | with: 19 | version: nightly 20 | 21 | - name: Print forge version 22 | run: forge --version 23 | 24 | # Backwards compatibility checks: 25 | # - the oldest and newest version of each supported minor version 26 | # - versions with specific issues 27 | - name: Check compatibility with latest 28 | if: always() 29 | run: | 30 | output=$(forge build --skip test) 31 | 32 | if echo "$output" | grep -q "Warning"; then 33 | echo "$output" 34 | exit 1 35 | fi 36 | 37 | - name: Check compatibility with 0.8.0 38 | if: always() 39 | run: | 40 | output=$(forge build --skip test --use solc:0.8.0) 41 | 42 | if echo "$output" | grep -q "Warning"; then 43 | echo "$output" 44 | exit 1 45 | fi 46 | 47 | - name: Check compatibility with 0.7.6 48 | if: always() 49 | run: | 50 | output=$(forge build --skip test --use solc:0.7.6) 51 | 52 | if echo "$output" | grep -q "Warning"; then 53 | echo "$output" 54 | exit 1 55 | fi 56 | 57 | - name: Check compatibility with 0.7.0 58 | if: always() 59 | run: | 60 | output=$(forge build --skip test --use solc:0.7.0) 61 | 62 | if echo "$output" | grep -q "Warning"; then 63 | echo "$output" 64 | exit 1 65 | fi 66 | 67 | - name: Check compatibility with 0.6.12 68 | if: always() 69 | run: | 70 | output=$(forge build --skip test --use solc:0.6.12) 71 | 72 | if echo "$output" | grep -q "Warning"; then 73 | echo "$output" 74 | exit 1 75 | fi 76 | 77 | - name: Check compatibility with 0.6.2 78 | if: always() 79 | run: | 80 | output=$(forge build --skip test --use solc:0.6.2) 81 | 82 | if echo "$output" | grep -q "Warning"; then 83 | echo "$output" 84 | exit 1 85 | fi 86 | 87 | # via-ir compilation time checks. 88 | - name: Measure compilation time of Test with 0.8.17 --via-ir 89 | if: always() 90 | run: forge build --skip test --contracts test/compilation/CompilationTest.sol --use solc:0.8.17 --via-ir 91 | 92 | - name: Measure compilation time of TestBase with 0.8.17 --via-ir 93 | if: always() 94 | run: forge build --skip test --contracts test/compilation/CompilationTestBase.sol --use solc:0.8.17 --via-ir 95 | 96 | - name: Measure compilation time of Script with 0.8.17 --via-ir 97 | if: always() 98 | run: forge build --skip test --contracts test/compilation/CompilationScript.sol --use solc:0.8.17 --via-ir 99 | 100 | - name: Measure compilation time of ScriptBase with 0.8.17 --via-ir 101 | if: always() 102 | run: forge build --skip test --contracts test/compilation/CompilationScriptBase.sol --use solc:0.8.17 --via-ir 103 | 104 | test: 105 | runs-on: ubuntu-latest 106 | steps: 107 | - uses: actions/checkout@v3 108 | 109 | - name: Install Foundry 110 | uses: onbjerg/foundry-toolchain@v1 111 | with: 112 | version: nightly 113 | 114 | - name: Print forge version 115 | run: forge --version 116 | 117 | - name: Run tests 118 | run: forge test -vvv 119 | 120 | fmt: 121 | runs-on: ubuntu-latest 122 | steps: 123 | - uses: actions/checkout@v3 124 | 125 | - name: Install Foundry 126 | uses: onbjerg/foundry-toolchain@v1 127 | with: 128 | version: nightly 129 | 130 | - name: Print forge version 131 | run: forge --version 132 | 133 | - name: Check formatting 134 | run: forge fmt --check 135 | -------------------------------------------------------------------------------- /lib/forge-std/.github/workflows/sync.yml: -------------------------------------------------------------------------------- 1 | name: Sync Release Branch 2 | 3 | on: 4 | release: 5 | types: 6 | - created 7 | 8 | jobs: 9 | sync-release-branch: 10 | runs-on: ubuntu-latest 11 | if: startsWith(github.event.release.tag_name, 'v1') 12 | steps: 13 | - name: Check out the repo 14 | uses: actions/checkout@v3 15 | with: 16 | fetch-depth: 0 17 | ref: v1 18 | 19 | - name: Configure Git 20 | run: | 21 | git config user.name github-actions[bot] 22 | git config user.email 41898282+github-actions[bot]@users.noreply.github.com 23 | 24 | - name: Sync Release Branch 25 | run: | 26 | git fetch --tags 27 | git checkout v1 28 | git reset --hard ${GITHUB_REF} 29 | git push --force 30 | -------------------------------------------------------------------------------- /lib/forge-std/.gitignore: -------------------------------------------------------------------------------- 1 | cache/ 2 | out/ 3 | .vscode 4 | .idea 5 | -------------------------------------------------------------------------------- /lib/forge-std/.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "lib/ds-test"] 2 | path = lib/ds-test 3 | url = https://github.com/dapphub/ds-test 4 | -------------------------------------------------------------------------------- /lib/forge-std/LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Copyright Contributors to Forge Standard Library 2 | 3 | Apache License 4 | Version 2.0, January 2004 5 | http://www.apache.org/licenses/ 6 | 7 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 8 | 9 | 1. Definitions. 10 | 11 | "License" shall mean the terms and conditions for use, reproduction, 12 | and distribution as defined by Sections 1 through 9 of this document. 13 | 14 | "Licensor" shall mean the copyright owner or entity authorized by 15 | the copyright owner that is granting the License. 16 | 17 | "Legal Entity" shall mean the union of the acting entity and all 18 | other entities that control, are controlled by, or are under common 19 | control with that entity. For the purposes of this definition, 20 | "control" means (i) the power, direct or indirect, to cause the 21 | direction or management of such entity, whether by contract or 22 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 23 | outstanding shares, or (iii) beneficial ownership of such entity. 24 | 25 | "You" (or "Your") shall mean an individual or Legal Entity 26 | exercising permissions granted by this License. 27 | 28 | "Source" form shall mean the preferred form for making modifications, 29 | including but not limited to software source code, documentation 30 | source, and configuration files. 31 | 32 | "Object" form shall mean any form resulting from mechanical 33 | transformation or translation of a Source form, including but 34 | not limited to compiled object code, generated documentation, 35 | and conversions to other media types. 36 | 37 | "Work" shall mean the work of authorship, whether in Source or 38 | Object form, made available under the License, as indicated by a 39 | copyright notice that is included in or attached to the work 40 | (an example is provided in the Appendix below). 41 | 42 | "Derivative Works" shall mean any work, whether in Source or Object 43 | form, that is based on (or derived from) the Work and for which the 44 | editorial revisions, annotations, elaborations, or other modifications 45 | represent, as a whole, an original work of authorship. For the purposes 46 | of this License, Derivative Works shall not include works that remain 47 | separable from, or merely link (or bind by name) to the interfaces of, 48 | the Work and Derivative Works thereof. 49 | 50 | "Contribution" shall mean any work of authorship, including 51 | the original version of the Work and any modifications or additions 52 | to that Work or Derivative Works thereof, that is intentionally 53 | submitted to Licensor for inclusion in the Work by the copyright owner 54 | or by an individual or Legal Entity authorized to submit on behalf of 55 | the copyright owner. For the purposes of this definition, "submitted" 56 | means any form of electronic, verbal, or written communication sent 57 | to the Licensor or its representatives, including but not limited to 58 | communication on electronic mailing lists, source code control systems, 59 | and issue tracking systems that are managed by, or on behalf of, the 60 | Licensor for the purpose of discussing and improving the Work, but 61 | excluding communication that is conspicuously marked or otherwise 62 | designated in writing by the copyright owner as "Not a Contribution." 63 | 64 | "Contributor" shall mean Licensor and any individual or Legal Entity 65 | on behalf of whom a Contribution has been received by Licensor and 66 | subsequently incorporated within the Work. 67 | 68 | 2. Grant of Copyright License. Subject to the terms and conditions of 69 | this License, each Contributor hereby grants to You a perpetual, 70 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 71 | copyright license to reproduce, prepare Derivative Works of, 72 | publicly display, publicly perform, sublicense, and distribute the 73 | Work and such Derivative Works in Source or Object form. 74 | 75 | 3. Grant of Patent License. Subject to the terms and conditions of 76 | this License, each Contributor hereby grants to You a perpetual, 77 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 78 | (except as stated in this section) patent license to make, have made, 79 | use, offer to sell, sell, import, and otherwise transfer the Work, 80 | where such license applies only to those patent claims licensable 81 | by such Contributor that are necessarily infringed by their 82 | Contribution(s) alone or by combination of their Contribution(s) 83 | with the Work to which such Contribution(s) was submitted. If You 84 | institute patent litigation against any entity (including a 85 | cross-claim or counterclaim in a lawsuit) alleging that the Work 86 | or a Contribution incorporated within the Work constitutes direct 87 | or contributory patent infringement, then any patent licenses 88 | granted to You under this License for that Work shall terminate 89 | as of the date such litigation is filed. 90 | 91 | 4. Redistribution. You may reproduce and distribute copies of the 92 | Work or Derivative Works thereof in any medium, with or without 93 | modifications, and in Source or Object form, provided that You 94 | meet the following conditions: 95 | 96 | (a) You must give any other recipients of the Work or 97 | Derivative Works a copy of this License; and 98 | 99 | (b) You must cause any modified files to carry prominent notices 100 | stating that You changed the files; and 101 | 102 | (c) You must retain, in the Source form of any Derivative Works 103 | that You distribute, all copyright, patent, trademark, and 104 | attribution notices from the Source form of the Work, 105 | excluding those notices that do not pertain to any part of 106 | the Derivative Works; and 107 | 108 | (d) If the Work includes a "NOTICE" text file as part of its 109 | distribution, then any Derivative Works that You distribute must 110 | include a readable copy of the attribution notices contained 111 | within such NOTICE file, excluding those notices that do not 112 | pertain to any part of the Derivative Works, in at least one 113 | of the following places: within a NOTICE text file distributed 114 | as part of the Derivative Works; within the Source form or 115 | documentation, if provided along with the Derivative Works; or, 116 | within a display generated by the Derivative Works, if and 117 | wherever such third-party notices normally appear. The contents 118 | of the NOTICE file are for informational purposes only and 119 | do not modify the License. You may add Your own attribution 120 | notices within Derivative Works that You distribute, alongside 121 | or as an addendum to the NOTICE text from the Work, provided 122 | that such additional attribution notices cannot be construed 123 | as modifying the License. 124 | 125 | You may add Your own copyright statement to Your modifications and 126 | may provide additional or different license terms and conditions 127 | for use, reproduction, or distribution of Your modifications, or 128 | for any such Derivative Works as a whole, provided Your use, 129 | reproduction, and distribution of the Work otherwise complies with 130 | the conditions stated in this License. 131 | 132 | 5. Submission of Contributions. Unless You explicitly state otherwise, 133 | any Contribution intentionally submitted for inclusion in the Work 134 | by You to the Licensor shall be under the terms and conditions of 135 | this License, without any additional terms or conditions. 136 | Notwithstanding the above, nothing herein shall supersede or modify 137 | the terms of any separate license agreement you may have executed 138 | with Licensor regarding such Contributions. 139 | 140 | 6. Trademarks. This License does not grant permission to use the trade 141 | names, trademarks, service marks, or product names of the Licensor, 142 | except as required for reasonable and customary use in describing the 143 | origin of the Work and reproducing the content of the NOTICE file. 144 | 145 | 7. Disclaimer of Warranty. Unless required by applicable law or 146 | agreed to in writing, Licensor provides the Work (and each 147 | Contributor provides its Contributions) on an "AS IS" BASIS, 148 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 149 | implied, including, without limitation, any warranties or conditions 150 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 151 | PARTICULAR PURPOSE. You are solely responsible for determining the 152 | appropriateness of using or redistributing the Work and assume any 153 | risks associated with Your exercise of permissions under this License. 154 | 155 | 8. Limitation of Liability. In no event and under no legal theory, 156 | whether in tort (including negligence), contract, or otherwise, 157 | unless required by applicable law (such as deliberate and grossly 158 | negligent acts) or agreed to in writing, shall any Contributor be 159 | liable to You for damages, including any direct, indirect, special, 160 | incidental, or consequential damages of any character arising as a 161 | result of this License or out of the use or inability to use the 162 | Work (including but not limited to damages for loss of goodwill, 163 | work stoppage, computer failure or malfunction, or any and all 164 | other commercial damages or losses), even if such Contributor 165 | has been advised of the possibility of such damages. 166 | 167 | 9. Accepting Warranty or Additional Liability. While redistributing 168 | the Work or Derivative Works thereof, You may choose to offer, 169 | and charge a fee for, acceptance of support, warranty, indemnity, 170 | or other liability obligations and/or rights consistent with this 171 | License. However, in accepting such obligations, You may act only 172 | on Your own behalf and on Your sole responsibility, not on behalf 173 | of any other Contributor, and only if You agree to indemnify, 174 | defend, and hold each Contributor harmless for any liability 175 | incurred by, or claims asserted against, such Contributor by reason 176 | of your accepting any such warranty or additional liability. 177 | 178 | END OF TERMS AND CONDITIONS 179 | 180 | APPENDIX: How to apply the Apache License to your work. 181 | 182 | To apply the Apache License to your work, attach the following 183 | boilerplate notice, with the fields enclosed by brackets "[]" 184 | replaced with your own identifying information. (Don't include 185 | the brackets!) The text should be enclosed in the appropriate 186 | comment syntax for the file format. We also recommend that a 187 | file or class name and description of purpose be included on the 188 | same "printed page" as the copyright notice for easier 189 | identification within third-party archives. 190 | 191 | Copyright [yyyy] [name of copyright owner] 192 | 193 | Licensed under the Apache License, Version 2.0 (the "License"); 194 | you may not use this file except in compliance with the License. 195 | You may obtain a copy of the License at 196 | 197 | http://www.apache.org/licenses/LICENSE-2.0 198 | 199 | Unless required by applicable law or agreed to in writing, software 200 | distributed under the License is distributed on an "AS IS" BASIS, 201 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 202 | See the License for the specific language governing permissions and 203 | limitations under the License. 204 | -------------------------------------------------------------------------------- /lib/forge-std/LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Copyright Contributors to Forge Standard Library 2 | 3 | Permission is hereby granted, free of charge, to any 4 | person obtaining a copy of this software and associated 5 | documentation files (the "Software"), to deal in the 6 | Software without restriction, including without 7 | limitation the rights to use, copy, modify, merge, 8 | publish, distribute, sublicense, and/or sell copies of 9 | the Software, and to permit persons to whom the Software 10 | is furnished to do so, subject to the following 11 | conditions: 12 | 13 | The above copyright notice and this permission notice 14 | shall be included in all copies or substantial portions 15 | of the Software. 16 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 18 | ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 19 | TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 20 | PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT 21 | SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 22 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 24 | IN CONNECTION WITH THE SOFTWARE O THE USE OR OTHER 25 | DEALINGS IN THE SOFTWARE.R 26 | -------------------------------------------------------------------------------- /lib/forge-std/README.md: -------------------------------------------------------------------------------- 1 | # Forge Standard Library • [![CI status](https://github.com/foundry-rs/forge-std/actions/workflows/ci.yml/badge.svg)](https://github.com/foundry-rs/forge-std/actions/workflows/ci.yml) 2 | 3 | Forge Standard Library is a collection of helpful contracts and libraries for use with [Forge and Foundry](https://github.com/foundry-rs/foundry). It leverages Forge's cheatcodes to make writing tests easier and faster, while improving the UX of cheatcodes. 4 | 5 | **Learn how to use Forge-Std with the [📖 Foundry Book (Forge-Std Guide)](https://book.getfoundry.sh/forge/forge-std.html).** 6 | 7 | ## Install 8 | 9 | ```bash 10 | forge install foundry-rs/forge-std 11 | ``` 12 | 13 | ## Contracts 14 | ### stdError 15 | 16 | This is a helper contract for errors and reverts. In Forge, this contract is particularly helpful for the `expectRevert` cheatcode, as it provides all compiler builtin errors. 17 | 18 | See the contract itself for all error codes. 19 | 20 | #### Example usage 21 | 22 | ```solidity 23 | 24 | import "forge-std/Test.sol"; 25 | 26 | contract TestContract is Test { 27 | ErrorsTest test; 28 | 29 | function setUp() public { 30 | test = new ErrorsTest(); 31 | } 32 | 33 | function testExpectArithmetic() public { 34 | vm.expectRevert(stdError.arithmeticError); 35 | test.arithmeticError(10); 36 | } 37 | } 38 | 39 | contract ErrorsTest { 40 | function arithmeticError(uint256 a) public { 41 | uint256 a = a - 100; 42 | } 43 | } 44 | ``` 45 | 46 | ### stdStorage 47 | 48 | This is a rather large contract due to all of the overloading to make the UX decent. Primarily, it is a wrapper around the `record` and `accesses` cheatcodes. It can *always* find and write the storage slot(s) associated with a particular variable without knowing the storage layout. The one _major_ caveat to this is while a slot can be found for packed storage variables, we can't write to that variable safely. If a user tries to write to a packed slot, the execution throws an error, unless it is uninitialized (`bytes32(0)`). 49 | 50 | This works by recording all `SLOAD`s and `SSTORE`s during a function call. If there is a single slot read or written to, it immediately returns the slot. Otherwise, behind the scenes, we iterate through and check each one (assuming the user passed in a `depth` parameter). If the variable is a struct, you can pass in a `depth` parameter which is basically the field depth. 51 | 52 | I.e.: 53 | ```solidity 54 | struct T { 55 | // depth 0 56 | uint256 a; 57 | // depth 1 58 | uint256 b; 59 | } 60 | ``` 61 | 62 | #### Example usage 63 | 64 | ```solidity 65 | import "forge-std/Test.sol"; 66 | 67 | contract TestContract is Test { 68 | using stdStorage for StdStorage; 69 | 70 | Storage test; 71 | 72 | function setUp() public { 73 | test = new Storage(); 74 | } 75 | 76 | function testFindExists() public { 77 | // Lets say we want to find the slot for the public 78 | // variable `exists`. We just pass in the function selector 79 | // to the `find` command 80 | uint256 slot = stdstore.target(address(test)).sig("exists()").find(); 81 | assertEq(slot, 0); 82 | } 83 | 84 | function testWriteExists() public { 85 | // Lets say we want to write to the slot for the public 86 | // variable `exists`. We just pass in the function selector 87 | // to the `checked_write` command 88 | stdstore.target(address(test)).sig("exists()").checked_write(100); 89 | assertEq(test.exists(), 100); 90 | } 91 | 92 | // It supports arbitrary storage layouts, like assembly based storage locations 93 | function testFindHidden() public { 94 | // `hidden` is a random hash of a bytes, iteration through slots would 95 | // not find it. Our mechanism does 96 | // Also, you can use the selector instead of a string 97 | uint256 slot = stdstore.target(address(test)).sig(test.hidden.selector).find(); 98 | assertEq(slot, uint256(keccak256("my.random.var"))); 99 | } 100 | 101 | // If targeting a mapping, you have to pass in the keys necessary to perform the find 102 | // i.e.: 103 | function testFindMapping() public { 104 | uint256 slot = stdstore 105 | .target(address(test)) 106 | .sig(test.map_addr.selector) 107 | .with_key(address(this)) 108 | .find(); 109 | // in the `Storage` constructor, we wrote that this address' value was 1 in the map 110 | // so when we load the slot, we expect it to be 1 111 | assertEq(uint(vm.load(address(test), bytes32(slot))), 1); 112 | } 113 | 114 | // If the target is a struct, you can specify the field depth: 115 | function testFindStruct() public { 116 | // NOTE: see the depth parameter - 0 means 0th field, 1 means 1st field, etc. 117 | uint256 slot_for_a_field = stdstore 118 | .target(address(test)) 119 | .sig(test.basicStruct.selector) 120 | .depth(0) 121 | .find(); 122 | 123 | uint256 slot_for_b_field = stdstore 124 | .target(address(test)) 125 | .sig(test.basicStruct.selector) 126 | .depth(1) 127 | .find(); 128 | 129 | assertEq(uint(vm.load(address(test), bytes32(slot_for_a_field))), 1); 130 | assertEq(uint(vm.load(address(test), bytes32(slot_for_b_field))), 2); 131 | } 132 | } 133 | 134 | // A complex storage contract 135 | contract Storage { 136 | struct UnpackedStruct { 137 | uint256 a; 138 | uint256 b; 139 | } 140 | 141 | constructor() { 142 | map_addr[msg.sender] = 1; 143 | } 144 | 145 | uint256 public exists = 1; 146 | mapping(address => uint256) public map_addr; 147 | // mapping(address => Packed) public map_packed; 148 | mapping(address => UnpackedStruct) public map_struct; 149 | mapping(address => mapping(address => uint256)) public deep_map; 150 | mapping(address => mapping(address => UnpackedStruct)) public deep_map_struct; 151 | UnpackedStruct public basicStruct = UnpackedStruct({ 152 | a: 1, 153 | b: 2 154 | }); 155 | 156 | function hidden() public view returns (bytes32 t) { 157 | // an extremely hidden storage slot 158 | bytes32 slot = keccak256("my.random.var"); 159 | assembly { 160 | t := sload(slot) 161 | } 162 | } 163 | } 164 | ``` 165 | 166 | ### stdCheats 167 | 168 | This is a wrapper over miscellaneous cheatcodes that need wrappers to be more dev friendly. Currently there are only functions related to `prank`. In general, users may expect ETH to be put into an address on `prank`, but this is not the case for safety reasons. Explicitly this `hoax` function should only be used for address that have expected balances as it will get overwritten. If an address already has ETH, you should just use `prank`. If you want to change that balance explicitly, just use `deal`. If you want to do both, `hoax` is also right for you. 169 | 170 | 171 | #### Example usage: 172 | ```solidity 173 | 174 | // SPDX-License-Identifier: MIT 175 | pragma solidity ^0.8.0; 176 | 177 | import "forge-std/Test.sol"; 178 | 179 | // Inherit the stdCheats 180 | contract StdCheatsTest is Test { 181 | Bar test; 182 | function setUp() public { 183 | test = new Bar(); 184 | } 185 | 186 | function testHoax() public { 187 | // we call `hoax`, which gives the target address 188 | // eth and then calls `prank` 189 | hoax(address(1337)); 190 | test.bar{value: 100}(address(1337)); 191 | 192 | // overloaded to allow you to specify how much eth to 193 | // initialize the address with 194 | hoax(address(1337), 1); 195 | test.bar{value: 1}(address(1337)); 196 | } 197 | 198 | function testStartHoax() public { 199 | // we call `startHoax`, which gives the target address 200 | // eth and then calls `startPrank` 201 | // 202 | // it is also overloaded so that you can specify an eth amount 203 | startHoax(address(1337)); 204 | test.bar{value: 100}(address(1337)); 205 | test.bar{value: 100}(address(1337)); 206 | vm.stopPrank(); 207 | test.bar(address(this)); 208 | } 209 | } 210 | 211 | contract Bar { 212 | function bar(address expectedSender) public payable { 213 | require(msg.sender == expectedSender, "!prank"); 214 | } 215 | } 216 | ``` 217 | 218 | ### Std Assertions 219 | 220 | Expand upon the assertion functions from the `DSTest` library. 221 | 222 | ### `console.log` 223 | 224 | Usage follows the same format as [Hardhat](https://hardhat.org/hardhat-network/reference/#console-log). 225 | It's recommended to use `console2.sol` as shown below, as this will show the decoded logs in Forge traces. 226 | 227 | ```solidity 228 | // import it indirectly via Test.sol 229 | import "forge-std/Test.sol"; 230 | // or directly import it 231 | import "forge-std/console2.sol"; 232 | ... 233 | console2.log(someValue); 234 | ``` 235 | 236 | If you need compatibility with Hardhat, you must use the standard `console.sol` instead. 237 | Due to a bug in `console.sol`, logs that use `uint256` or `int256` types will not be properly decoded in Forge traces. 238 | 239 | ```solidity 240 | // import it indirectly via Test.sol 241 | import "forge-std/Test.sol"; 242 | // or directly import it 243 | import "forge-std/console.sol"; 244 | ... 245 | console.log(someValue); 246 | ``` 247 | 248 | ## License 249 | 250 | Forge Standard Library is offered under either [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE) license. 251 | -------------------------------------------------------------------------------- /lib/forge-std/foundry.toml: -------------------------------------------------------------------------------- 1 | [profile.default] 2 | fs_permissions = [{ access = "read-write", path = "./"}] 3 | 4 | [rpc_endpoints] 5 | # The RPC URLs are modified versions of the default for testing initialization. 6 | mainnet = "https://mainnet.infura.io/v3/b1d3925804e74152b316ca7da97060d3" # Different API key. 7 | optimism_goerli = "https://goerli.optimism.io/" # Adds a trailing slash. 8 | arbitrum_one_goerli = "https://goerli-rollup.arbitrum.io/rpc/" # Adds a trailing slash. 9 | needs_undefined_env_var = "${UNDEFINED_RPC_URL_PLACEHOLDER}" 10 | 11 | [fmt] 12 | # These are all the `forge fmt` defaults. 13 | line_length = 120 14 | tab_width = 4 15 | bracket_spacing = false 16 | int_types = 'long' 17 | multiline_func_header = 'attributes_first' 18 | quote_style = 'double' 19 | number_underscore = 'preserve' 20 | single_line_statement_blocks = 'preserve' 21 | ignore = ["src/console.sol", "src/console2.sol"] -------------------------------------------------------------------------------- /lib/forge-std/lib/ds-test/.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: "Build" 2 | on: 3 | pull_request: 4 | push: 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v3 10 | - uses: cachix/install-nix-action@v20 11 | with: 12 | nix_path: nixpkgs=channel:nixos-unstable 13 | extra_nix_config: | 14 | access-tokens = github.com=${{ secrets.GITHUB_TOKEN }} 15 | 16 | - name: setup dapp binary cache 17 | uses: cachix/cachix-action@v12 18 | with: 19 | name: dapp 20 | 21 | - name: install dapptools 22 | run: nix profile install github:dapphub/dapptools#dapp --accept-flake-config 23 | 24 | - name: install foundry 25 | uses: foundry-rs/foundry-toolchain@v1 26 | 27 | - name: test with solc-0.5.17 28 | run: dapp --use solc-0.5.17 test -v 29 | 30 | - name: test with solc-0.6.11 31 | run: dapp --use solc-0.6.11 test -v 32 | 33 | - name: test with solc-0.7.6 34 | run: dapp --use solc-0.7.6 test -v 35 | 36 | - name: test with solc-0.8.18 37 | run: dapp --use solc-0.8.18 test -v 38 | 39 | - name: Run tests with foundry 40 | run: forge test -vvv 41 | 42 | -------------------------------------------------------------------------------- /lib/forge-std/lib/ds-test/.gitignore: -------------------------------------------------------------------------------- 1 | /.dapple 2 | /build 3 | /out 4 | /cache/ 5 | -------------------------------------------------------------------------------- /lib/forge-std/lib/ds-test/Makefile: -------------------------------------------------------------------------------- 1 | all:; dapp build 2 | 3 | test: 4 | -dapp --use solc:0.4.23 build 5 | -dapp --use solc:0.4.26 build 6 | -dapp --use solc:0.5.17 build 7 | -dapp --use solc:0.6.12 build 8 | -dapp --use solc:0.7.5 build 9 | 10 | demo: 11 | DAPP_SRC=demo dapp --use solc:0.7.5 build 12 | -hevm dapp-test --verbose 3 13 | 14 | .PHONY: test demo 15 | -------------------------------------------------------------------------------- /lib/forge-std/lib/ds-test/default.nix: -------------------------------------------------------------------------------- 1 | { solidityPackage, dappsys }: solidityPackage { 2 | name = "ds-test"; 3 | src = ./src; 4 | } 5 | -------------------------------------------------------------------------------- /lib/forge-std/lib/ds-test/demo/demo.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: GPL-3.0-or-later 2 | pragma solidity >=0.5.0; 3 | 4 | import "../src/test.sol"; 5 | 6 | contract DemoTest is DSTest { 7 | function test_this() public pure { 8 | require(true); 9 | } 10 | function test_logs() public { 11 | emit log("-- log(string)"); 12 | emit log("a string"); 13 | 14 | emit log("-- log_named_uint(string, uint)"); 15 | emit log_named_uint("uint", 512); 16 | 17 | emit log("-- log_named_int(string, int)"); 18 | emit log_named_int("int", -512); 19 | 20 | emit log("-- log_named_address(string, address)"); 21 | emit log_named_address("address", address(this)); 22 | 23 | emit log("-- log_named_bytes32(string, bytes32)"); 24 | emit log_named_bytes32("bytes32", "a string"); 25 | 26 | emit log("-- log_named_bytes(string, bytes)"); 27 | emit log_named_bytes("bytes", hex"cafefe"); 28 | 29 | emit log("-- log_named_string(string, string)"); 30 | emit log_named_string("string", "a string"); 31 | 32 | emit log("-- log_named_decimal_uint(string, uint, uint)"); 33 | emit log_named_decimal_uint("decimal uint", 1.0e18, 18); 34 | 35 | emit log("-- log_named_decimal_int(string, int, uint)"); 36 | emit log_named_decimal_int("decimal int", -1.0e18, 18); 37 | } 38 | event log_old_named_uint(bytes32,uint); 39 | function test_old_logs() public { 40 | emit log_old_named_uint("key", 500); 41 | emit log_named_bytes32("bkey", "val"); 42 | } 43 | function test_trace() public view { 44 | this.echo("string 1", "string 2"); 45 | } 46 | function test_multiline() public { 47 | emit log("a multiline\\nstring"); 48 | emit log("a multiline string"); 49 | emit log_bytes("a string"); 50 | emit log_bytes("a multiline\nstring"); 51 | emit log_bytes("a multiline\\nstring"); 52 | emit logs(hex"0000"); 53 | emit log_named_bytes("0x0000", hex"0000"); 54 | emit logs(hex"ff"); 55 | } 56 | function echo(string memory s1, string memory s2) public pure 57 | returns (string memory, string memory) 58 | { 59 | return (s1, s2); 60 | } 61 | 62 | function prove_this(uint x) public { 63 | emit log_named_uint("sym x", x); 64 | assertGt(x + 1, 0); 65 | } 66 | 67 | function test_logn() public { 68 | assembly { 69 | log0(0x01, 0x02) 70 | log1(0x01, 0x02, 0x03) 71 | log2(0x01, 0x02, 0x03, 0x04) 72 | log3(0x01, 0x02, 0x03, 0x04, 0x05) 73 | } 74 | } 75 | 76 | event MyEvent(uint, uint indexed, uint, uint indexed); 77 | function test_events() public { 78 | emit MyEvent(1, 2, 3, 4); 79 | } 80 | 81 | function test_asserts() public { 82 | string memory err = "this test has failed!"; 83 | emit log("## assertTrue(bool)\n"); 84 | assertTrue(false); 85 | emit log("\n"); 86 | assertTrue(false, err); 87 | 88 | emit log("\n## assertEq(address,address)\n"); 89 | assertEq(address(this), msg.sender); 90 | emit log("\n"); 91 | assertEq(address(this), msg.sender, err); 92 | 93 | emit log("\n## assertEq32(bytes32,bytes32)\n"); 94 | assertEq32("bytes 1", "bytes 2"); 95 | emit log("\n"); 96 | assertEq32("bytes 1", "bytes 2", err); 97 | 98 | emit log("\n## assertEq(bytes32,bytes32)\n"); 99 | assertEq32("bytes 1", "bytes 2"); 100 | emit log("\n"); 101 | assertEq32("bytes 1", "bytes 2", err); 102 | 103 | emit log("\n## assertEq(uint,uint)\n"); 104 | assertEq(uint(0), 1); 105 | emit log("\n"); 106 | assertEq(uint(0), 1, err); 107 | 108 | emit log("\n## assertEq(int,int)\n"); 109 | assertEq(-1, -2); 110 | emit log("\n"); 111 | assertEq(-1, -2, err); 112 | 113 | emit log("\n## assertEqDecimal(int,int,uint)\n"); 114 | assertEqDecimal(-1.0e18, -1.1e18, 18); 115 | emit log("\n"); 116 | assertEqDecimal(-1.0e18, -1.1e18, 18, err); 117 | 118 | emit log("\n## assertEqDecimal(uint,uint,uint)\n"); 119 | assertEqDecimal(uint(1.0e18), 1.1e18, 18); 120 | emit log("\n"); 121 | assertEqDecimal(uint(1.0e18), 1.1e18, 18, err); 122 | 123 | emit log("\n## assertGt(uint,uint)\n"); 124 | assertGt(uint(0), 0); 125 | emit log("\n"); 126 | assertGt(uint(0), 0, err); 127 | 128 | emit log("\n## assertGt(int,int)\n"); 129 | assertGt(-1, -1); 130 | emit log("\n"); 131 | assertGt(-1, -1, err); 132 | 133 | emit log("\n## assertGtDecimal(int,int,uint)\n"); 134 | assertGtDecimal(-2.0e18, -1.1e18, 18); 135 | emit log("\n"); 136 | assertGtDecimal(-2.0e18, -1.1e18, 18, err); 137 | 138 | emit log("\n## assertGtDecimal(uint,uint,uint)\n"); 139 | assertGtDecimal(uint(1.0e18), 1.1e18, 18); 140 | emit log("\n"); 141 | assertGtDecimal(uint(1.0e18), 1.1e18, 18, err); 142 | 143 | emit log("\n## assertGe(uint,uint)\n"); 144 | assertGe(uint(0), 1); 145 | emit log("\n"); 146 | assertGe(uint(0), 1, err); 147 | 148 | emit log("\n## assertGe(int,int)\n"); 149 | assertGe(-1, 0); 150 | emit log("\n"); 151 | assertGe(-1, 0, err); 152 | 153 | emit log("\n## assertGeDecimal(int,int,uint)\n"); 154 | assertGeDecimal(-2.0e18, -1.1e18, 18); 155 | emit log("\n"); 156 | assertGeDecimal(-2.0e18, -1.1e18, 18, err); 157 | 158 | emit log("\n## assertGeDecimal(uint,uint,uint)\n"); 159 | assertGeDecimal(uint(1.0e18), 1.1e18, 18); 160 | emit log("\n"); 161 | assertGeDecimal(uint(1.0e18), 1.1e18, 18, err); 162 | 163 | emit log("\n## assertLt(uint,uint)\n"); 164 | assertLt(uint(0), 0); 165 | emit log("\n"); 166 | assertLt(uint(0), 0, err); 167 | 168 | emit log("\n## assertLt(int,int)\n"); 169 | assertLt(-1, -1); 170 | emit log("\n"); 171 | assertLt(-1, -1, err); 172 | 173 | emit log("\n## assertLtDecimal(int,int,uint)\n"); 174 | assertLtDecimal(-1.0e18, -1.1e18, 18); 175 | emit log("\n"); 176 | assertLtDecimal(-1.0e18, -1.1e18, 18, err); 177 | 178 | emit log("\n## assertLtDecimal(uint,uint,uint)\n"); 179 | assertLtDecimal(uint(2.0e18), 1.1e18, 18); 180 | emit log("\n"); 181 | assertLtDecimal(uint(2.0e18), 1.1e18, 18, err); 182 | 183 | emit log("\n## assertLe(uint,uint)\n"); 184 | assertLe(uint(1), 0); 185 | emit log("\n"); 186 | assertLe(uint(1), 0, err); 187 | 188 | emit log("\n## assertLe(int,int)\n"); 189 | assertLe(0, -1); 190 | emit log("\n"); 191 | assertLe(0, -1, err); 192 | 193 | emit log("\n## assertLeDecimal(int,int,uint)\n"); 194 | assertLeDecimal(-1.0e18, -1.1e18, 18); 195 | emit log("\n"); 196 | assertLeDecimal(-1.0e18, -1.1e18, 18, err); 197 | 198 | emit log("\n## assertLeDecimal(uint,uint,uint)\n"); 199 | assertLeDecimal(uint(2.0e18), 1.1e18, 18); 200 | emit log("\n"); 201 | assertLeDecimal(uint(2.0e18), 1.1e18, 18, err); 202 | 203 | emit log("\n## assertEq(string,string)\n"); 204 | string memory s1 = "string 1"; 205 | string memory s2 = "string 2"; 206 | assertEq(s1, s2); 207 | emit log("\n"); 208 | assertEq(s1, s2, err); 209 | 210 | emit log("\n## assertEq0(bytes,bytes)\n"); 211 | assertEq0(hex"abcdef01", hex"abcdef02"); 212 | emit log("\n"); 213 | assertEq0(hex"abcdef01", hex"abcdef02", err); 214 | } 215 | } 216 | 217 | contract DemoTestWithSetUp { 218 | function setUp() public { 219 | } 220 | function test_pass() public pure { 221 | } 222 | } 223 | -------------------------------------------------------------------------------- /lib/forge-std/lib/ds-test/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ds-test", 3 | "version": "1.0.0", 4 | "description": "Assertions, equality checks and other test helpers ", 5 | "bugs": "https://github.com/dapphub/ds-test/issues", 6 | "license": "GPL-3.0", 7 | "author": "Contributors to ds-test", 8 | "files": [ 9 | "src/*" 10 | ], 11 | "repository": { 12 | "type": "git", 13 | "url": "https://github.com/dapphub/ds-test.git" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /lib/forge-std/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "forge-std", 3 | "version": "1.6.0", 4 | "description": "Forge Standard Library is a collection of helpful contracts and libraries for use with Forge and Foundry.", 5 | "homepage": "https://book.getfoundry.sh/forge/forge-std", 6 | "bugs": "https://github.com/foundry-rs/forge-std/issues", 7 | "license": "(Apache-2.0 OR MIT)", 8 | "author": "Contributors to Forge Standard Library", 9 | "files": [ 10 | "src/**/*" 11 | ], 12 | "repository": { 13 | "type": "git", 14 | "url": "https://github.com/foundry-rs/forge-std.git" 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /lib/forge-std/src/Base.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | import {StdStorage} from "./StdStorage.sol"; 5 | import {Vm, VmSafe} from "./Vm.sol"; 6 | 7 | abstract contract CommonBase { 8 | // Cheat code address, 0x7109709ECfa91a80626fF3989D68f67F5b1DD12D. 9 | address internal constant VM_ADDRESS = address(uint160(uint256(keccak256("hevm cheat code")))); 10 | // console.sol and console2.sol work by executing a staticcall to this address. 11 | address internal constant CONSOLE = 0x000000000000000000636F6e736F6c652e6c6f67; 12 | // Used when deploying with create2, https://github.com/Arachnid/deterministic-deployment-proxy. 13 | address internal constant CREATE2_FACTORY = 0x4e59b44847b379578588920cA78FbF26c0B4956C; 14 | // Default address for tx.origin and msg.sender, 0x1804c8AB1F12E6bbf3894d4083f33e07309d1f38. 15 | address internal constant DEFAULT_SENDER = address(uint160(uint256(keccak256("foundry default caller")))); 16 | // Address of the test contract, deployed by the DEFAULT_SENDER. 17 | address internal constant DEFAULT_TEST_CONTRACT = 0x5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72f; 18 | // Deterministic deployment address of the Multicall3 contract. 19 | address internal constant MULTICALL3_ADDRESS = 0xcA11bde05977b3631167028862bE2a173976CA11; 20 | // The order of the secp256k1 curve. 21 | uint256 internal constant SECP256K1_ORDER = 22 | 115792089237316195423570985008687907852837564279074904382605163141518161494337; 23 | 24 | uint256 internal constant UINT256_MAX = 25 | 115792089237316195423570985008687907853269984665640564039457584007913129639935; 26 | 27 | Vm internal constant vm = Vm(VM_ADDRESS); 28 | StdStorage internal stdstore; 29 | } 30 | 31 | abstract contract TestBase is CommonBase {} 32 | 33 | abstract contract ScriptBase is CommonBase { 34 | VmSafe internal constant vmSafe = VmSafe(VM_ADDRESS); 35 | } 36 | -------------------------------------------------------------------------------- /lib/forge-std/src/Script.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | // 💬 ABOUT 5 | // Forge Std's default Script. 6 | 7 | // 🧩 MODULES 8 | import {console} from "./console.sol"; 9 | import {console2} from "./console2.sol"; 10 | import {safeconsole} from "./safeconsole.sol"; 11 | import {StdChains} from "./StdChains.sol"; 12 | import {StdCheatsSafe} from "./StdCheats.sol"; 13 | import {stdJson} from "./StdJson.sol"; 14 | import {stdMath} from "./StdMath.sol"; 15 | import {StdStorage, stdStorageSafe} from "./StdStorage.sol"; 16 | import {StdStyle} from "./StdStyle.sol"; 17 | import {StdUtils} from "./StdUtils.sol"; 18 | import {VmSafe} from "./Vm.sol"; 19 | 20 | // 📦 BOILERPLATE 21 | import {ScriptBase} from "./Base.sol"; 22 | 23 | // ⭐️ SCRIPT 24 | abstract contract Script is ScriptBase, StdChains, StdCheatsSafe, StdUtils { 25 | // Note: IS_SCRIPT() must return true. 26 | bool public IS_SCRIPT = true; 27 | } 28 | -------------------------------------------------------------------------------- /lib/forge-std/src/StdChains.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | import {VmSafe} from "./Vm.sol"; 5 | 6 | /** 7 | * StdChains provides information about EVM compatible chains that can be used in scripts/tests. 8 | * For each chain, the chain's name, chain ID, and a default RPC URL are provided. Chains are 9 | * identified by their alias, which is the same as the alias in the `[rpc_endpoints]` section of 10 | * the `foundry.toml` file. For best UX, ensure the alias in the `foundry.toml` file match the 11 | * alias used in this contract, which can be found as the first argument to the 12 | * `setChainWithDefaultRpcUrl` call in the `initializeStdChains` function. 13 | * 14 | * There are two main ways to use this contract: 15 | * 1. Set a chain with `setChain(string memory chainAlias, ChainData memory chain)` or 16 | * `setChain(string memory chainAlias, Chain memory chain)` 17 | * 2. Get a chain with `getChain(string memory chainAlias)` or `getChain(uint256 chainId)`. 18 | * 19 | * The first time either of those are used, chains are initialized with the default set of RPC URLs. 20 | * This is done in `initializeStdChains`, which uses `setChainWithDefaultRpcUrl`. Defaults are recorded in 21 | * `defaultRpcUrls`. 22 | * 23 | * The `setChain` function is straightforward, and it simply saves off the given chain data. 24 | * 25 | * The `getChain` methods use `getChainWithUpdatedRpcUrl` to return a chain. For example, let's say 26 | * we want to retrieve the RPC URL for `mainnet`: 27 | * - If you have specified data with `setChain`, it will return that. 28 | * - If you have configured a mainnet RPC URL in `foundry.toml`, it will return the URL, provided it 29 | * is valid (e.g. a URL is specified, or an environment variable is given and exists). 30 | * - If neither of the above conditions is met, the default data is returned. 31 | * 32 | * Summarizing the above, the prioritization hierarchy is `setChain` -> `foundry.toml` -> environment variable -> defaults. 33 | */ 34 | abstract contract StdChains { 35 | VmSafe private constant vm = VmSafe(address(uint160(uint256(keccak256("hevm cheat code"))))); 36 | 37 | bool private stdChainsInitialized; 38 | 39 | struct ChainData { 40 | string name; 41 | uint256 chainId; 42 | string rpcUrl; 43 | } 44 | 45 | struct Chain { 46 | // The chain name. 47 | string name; 48 | // The chain's Chain ID. 49 | uint256 chainId; 50 | // The chain's alias. (i.e. what gets specified in `foundry.toml`). 51 | string chainAlias; 52 | // A default RPC endpoint for this chain. 53 | // NOTE: This default RPC URL is included for convenience to facilitate quick tests and 54 | // experimentation. Do not use this RPC URL for production test suites, CI, or other heavy 55 | // usage as you will be throttled and this is a disservice to others who need this endpoint. 56 | string rpcUrl; 57 | } 58 | 59 | // Maps from the chain's alias (matching the alias in the `foundry.toml` file) to chain data. 60 | mapping(string => Chain) private chains; 61 | // Maps from the chain's alias to it's default RPC URL. 62 | mapping(string => string) private defaultRpcUrls; 63 | // Maps from a chain ID to it's alias. 64 | mapping(uint256 => string) private idToAlias; 65 | 66 | bool private fallbackToDefaultRpcUrls = true; 67 | 68 | // The RPC URL will be fetched from config or defaultRpcUrls if possible. 69 | function getChain(string memory chainAlias) internal virtual returns (Chain memory chain) { 70 | require(bytes(chainAlias).length != 0, "StdChains getChain(string): Chain alias cannot be the empty string."); 71 | 72 | initializeStdChains(); 73 | chain = chains[chainAlias]; 74 | require( 75 | chain.chainId != 0, 76 | string(abi.encodePacked("StdChains getChain(string): Chain with alias \"", chainAlias, "\" not found.")) 77 | ); 78 | 79 | chain = getChainWithUpdatedRpcUrl(chainAlias, chain); 80 | } 81 | 82 | function getChain(uint256 chainId) internal virtual returns (Chain memory chain) { 83 | require(chainId != 0, "StdChains getChain(uint256): Chain ID cannot be 0."); 84 | initializeStdChains(); 85 | string memory chainAlias = idToAlias[chainId]; 86 | 87 | chain = chains[chainAlias]; 88 | 89 | require( 90 | chain.chainId != 0, 91 | string(abi.encodePacked("StdChains getChain(uint256): Chain with ID ", vm.toString(chainId), " not found.")) 92 | ); 93 | 94 | chain = getChainWithUpdatedRpcUrl(chainAlias, chain); 95 | } 96 | 97 | // set chain info, with priority to argument's rpcUrl field. 98 | function setChain(string memory chainAlias, ChainData memory chain) internal virtual { 99 | require( 100 | bytes(chainAlias).length != 0, 101 | "StdChains setChain(string,ChainData): Chain alias cannot be the empty string." 102 | ); 103 | 104 | require(chain.chainId != 0, "StdChains setChain(string,ChainData): Chain ID cannot be 0."); 105 | 106 | initializeStdChains(); 107 | string memory foundAlias = idToAlias[chain.chainId]; 108 | 109 | require( 110 | bytes(foundAlias).length == 0 || keccak256(bytes(foundAlias)) == keccak256(bytes(chainAlias)), 111 | string( 112 | abi.encodePacked( 113 | "StdChains setChain(string,ChainData): Chain ID ", 114 | vm.toString(chain.chainId), 115 | " already used by \"", 116 | foundAlias, 117 | "\"." 118 | ) 119 | ) 120 | ); 121 | 122 | uint256 oldChainId = chains[chainAlias].chainId; 123 | delete idToAlias[oldChainId]; 124 | 125 | chains[chainAlias] = 126 | Chain({name: chain.name, chainId: chain.chainId, chainAlias: chainAlias, rpcUrl: chain.rpcUrl}); 127 | idToAlias[chain.chainId] = chainAlias; 128 | } 129 | 130 | // set chain info, with priority to argument's rpcUrl field. 131 | function setChain(string memory chainAlias, Chain memory chain) internal virtual { 132 | setChain(chainAlias, ChainData({name: chain.name, chainId: chain.chainId, rpcUrl: chain.rpcUrl})); 133 | } 134 | 135 | function _toUpper(string memory str) private pure returns (string memory) { 136 | bytes memory strb = bytes(str); 137 | bytes memory copy = new bytes(strb.length); 138 | for (uint256 i = 0; i < strb.length; i++) { 139 | bytes1 b = strb[i]; 140 | if (b >= 0x61 && b <= 0x7A) { 141 | copy[i] = bytes1(uint8(b) - 32); 142 | } else { 143 | copy[i] = b; 144 | } 145 | } 146 | return string(copy); 147 | } 148 | 149 | // lookup rpcUrl, in descending order of priority: 150 | // current -> config (foundry.toml) -> environment variable -> default 151 | function getChainWithUpdatedRpcUrl(string memory chainAlias, Chain memory chain) private returns (Chain memory) { 152 | if (bytes(chain.rpcUrl).length == 0) { 153 | try vm.rpcUrl(chainAlias) returns (string memory configRpcUrl) { 154 | chain.rpcUrl = configRpcUrl; 155 | } catch (bytes memory err) { 156 | string memory envName = string(abi.encodePacked(_toUpper(chainAlias), "_RPC_URL")); 157 | if (fallbackToDefaultRpcUrls) { 158 | chain.rpcUrl = vm.envOr(envName, defaultRpcUrls[chainAlias]); 159 | } else { 160 | chain.rpcUrl = vm.envString(envName); 161 | } 162 | // distinguish 'not found' from 'cannot read' 163 | bytes memory notFoundError = 164 | abi.encodeWithSignature("CheatCodeError", string(abi.encodePacked("invalid rpc url ", chainAlias))); 165 | if (keccak256(notFoundError) != keccak256(err) || bytes(chain.rpcUrl).length == 0) { 166 | /// @solidity memory-safe-assembly 167 | assembly { 168 | revert(add(32, err), mload(err)) 169 | } 170 | } 171 | } 172 | } 173 | return chain; 174 | } 175 | 176 | function setFallbackToDefaultRpcUrls(bool useDefault) internal { 177 | fallbackToDefaultRpcUrls = useDefault; 178 | } 179 | 180 | function initializeStdChains() private { 181 | if (stdChainsInitialized) return; 182 | 183 | stdChainsInitialized = true; 184 | 185 | // If adding an RPC here, make sure to test the default RPC URL in `testRpcs` 186 | setChainWithDefaultRpcUrl("anvil", ChainData("Anvil", 31337, "http://127.0.0.1:8545")); 187 | setChainWithDefaultRpcUrl( 188 | "mainnet", ChainData("Mainnet", 1, "https://mainnet.infura.io/v3/b9794ad1ddf84dfb8c34d6bb5dca2001") 189 | ); 190 | setChainWithDefaultRpcUrl( 191 | "goerli", ChainData("Goerli", 5, "https://goerli.infura.io/v3/b9794ad1ddf84dfb8c34d6bb5dca2001") 192 | ); 193 | setChainWithDefaultRpcUrl( 194 | "sepolia", ChainData("Sepolia", 11155111, "https://sepolia.infura.io/v3/b9794ad1ddf84dfb8c34d6bb5dca2001") 195 | ); 196 | setChainWithDefaultRpcUrl("optimism", ChainData("Optimism", 10, "https://mainnet.optimism.io")); 197 | setChainWithDefaultRpcUrl("optimism_goerli", ChainData("Optimism Goerli", 420, "https://goerli.optimism.io")); 198 | setChainWithDefaultRpcUrl("arbitrum_one", ChainData("Arbitrum One", 42161, "https://arb1.arbitrum.io/rpc")); 199 | setChainWithDefaultRpcUrl( 200 | "arbitrum_one_goerli", ChainData("Arbitrum One Goerli", 421613, "https://goerli-rollup.arbitrum.io/rpc") 201 | ); 202 | setChainWithDefaultRpcUrl("arbitrum_nova", ChainData("Arbitrum Nova", 42170, "https://nova.arbitrum.io/rpc")); 203 | setChainWithDefaultRpcUrl("polygon", ChainData("Polygon", 137, "https://polygon-rpc.com")); 204 | setChainWithDefaultRpcUrl( 205 | "polygon_mumbai", ChainData("Polygon Mumbai", 80001, "https://rpc-mumbai.maticvigil.com") 206 | ); 207 | setChainWithDefaultRpcUrl("avalanche", ChainData("Avalanche", 43114, "https://api.avax.network/ext/bc/C/rpc")); 208 | setChainWithDefaultRpcUrl( 209 | "avalanche_fuji", ChainData("Avalanche Fuji", 43113, "https://api.avax-test.network/ext/bc/C/rpc") 210 | ); 211 | setChainWithDefaultRpcUrl( 212 | "bnb_smart_chain", ChainData("BNB Smart Chain", 56, "https://bsc-dataseed1.binance.org") 213 | ); 214 | setChainWithDefaultRpcUrl( 215 | "bnb_smart_chain_testnet", 216 | ChainData("BNB Smart Chain Testnet", 97, "https://rpc.ankr.com/bsc_testnet_chapel") 217 | ); 218 | setChainWithDefaultRpcUrl("gnosis_chain", ChainData("Gnosis Chain", 100, "https://rpc.gnosischain.com")); 219 | setChainWithDefaultRpcUrl("moonbeam", ChainData("Moonbeam", 1284, "https://rpc.api.moonbeam.network")); 220 | setChainWithDefaultRpcUrl( 221 | "moonriver", ChainData("Moonriver", 1285, "https://rpc.api.moonriver.moonbeam.network") 222 | ); 223 | setChainWithDefaultRpcUrl("moonbase", ChainData("Moonbase", 1287, "https://rpc.testnet.moonbeam.network")); 224 | setChainWithDefaultRpcUrl("base_goerli", ChainData("Base Goerli", 84531, "https://goerli.base.org")); 225 | setChainWithDefaultRpcUrl("base", ChainData("Base", 8453, "https://mainnet.base.org")); 226 | } 227 | 228 | // set chain info, with priority to chainAlias' rpc url in foundry.toml 229 | function setChainWithDefaultRpcUrl(string memory chainAlias, ChainData memory chain) private { 230 | string memory rpcUrl = chain.rpcUrl; 231 | defaultRpcUrls[chainAlias] = rpcUrl; 232 | chain.rpcUrl = ""; 233 | setChain(chainAlias, chain); 234 | chain.rpcUrl = rpcUrl; // restore argument 235 | } 236 | } 237 | -------------------------------------------------------------------------------- /lib/forge-std/src/StdError.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | // Panics work for versions >=0.8.0, but we lowered the pragma to make this compatible with Test 3 | pragma solidity >=0.6.2 <0.9.0; 4 | 5 | library stdError { 6 | bytes public constant assertionError = abi.encodeWithSignature("Panic(uint256)", 0x01); 7 | bytes public constant arithmeticError = abi.encodeWithSignature("Panic(uint256)", 0x11); 8 | bytes public constant divisionError = abi.encodeWithSignature("Panic(uint256)", 0x12); 9 | bytes public constant enumConversionError = abi.encodeWithSignature("Panic(uint256)", 0x21); 10 | bytes public constant encodeStorageError = abi.encodeWithSignature("Panic(uint256)", 0x22); 11 | bytes public constant popError = abi.encodeWithSignature("Panic(uint256)", 0x31); 12 | bytes public constant indexOOBError = abi.encodeWithSignature("Panic(uint256)", 0x32); 13 | bytes public constant memOverflowError = abi.encodeWithSignature("Panic(uint256)", 0x41); 14 | bytes public constant zeroVarError = abi.encodeWithSignature("Panic(uint256)", 0x51); 15 | } 16 | -------------------------------------------------------------------------------- /lib/forge-std/src/StdInvariant.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | abstract contract StdInvariant { 7 | struct FuzzSelector { 8 | address addr; 9 | bytes4[] selectors; 10 | } 11 | 12 | struct FuzzInterface { 13 | address addr; 14 | string[] artifacts; 15 | } 16 | 17 | address[] private _excludedContracts; 18 | address[] private _excludedSenders; 19 | address[] private _targetedContracts; 20 | address[] private _targetedSenders; 21 | 22 | string[] private _excludedArtifacts; 23 | string[] private _targetedArtifacts; 24 | 25 | FuzzSelector[] private _targetedArtifactSelectors; 26 | FuzzSelector[] private _targetedSelectors; 27 | 28 | FuzzInterface[] private _targetedInterfaces; 29 | 30 | // Functions for users: 31 | // These are intended to be called in tests. 32 | 33 | function excludeContract(address newExcludedContract_) internal { 34 | _excludedContracts.push(newExcludedContract_); 35 | } 36 | 37 | function excludeSender(address newExcludedSender_) internal { 38 | _excludedSenders.push(newExcludedSender_); 39 | } 40 | 41 | function excludeArtifact(string memory newExcludedArtifact_) internal { 42 | _excludedArtifacts.push(newExcludedArtifact_); 43 | } 44 | 45 | function targetArtifact(string memory newTargetedArtifact_) internal { 46 | _targetedArtifacts.push(newTargetedArtifact_); 47 | } 48 | 49 | function targetArtifactSelector(FuzzSelector memory newTargetedArtifactSelector_) internal { 50 | _targetedArtifactSelectors.push(newTargetedArtifactSelector_); 51 | } 52 | 53 | function targetContract(address newTargetedContract_) internal { 54 | _targetedContracts.push(newTargetedContract_); 55 | } 56 | 57 | function targetSelector(FuzzSelector memory newTargetedSelector_) internal { 58 | _targetedSelectors.push(newTargetedSelector_); 59 | } 60 | 61 | function targetSender(address newTargetedSender_) internal { 62 | _targetedSenders.push(newTargetedSender_); 63 | } 64 | 65 | function targetInterface(FuzzInterface memory newTargetedInterface_) internal { 66 | _targetedInterfaces.push(newTargetedInterface_); 67 | } 68 | 69 | // Functions for forge: 70 | // These are called by forge to run invariant tests and don't need to be called in tests. 71 | 72 | function excludeArtifacts() public view returns (string[] memory excludedArtifacts_) { 73 | excludedArtifacts_ = _excludedArtifacts; 74 | } 75 | 76 | function excludeContracts() public view returns (address[] memory excludedContracts_) { 77 | excludedContracts_ = _excludedContracts; 78 | } 79 | 80 | function excludeSenders() public view returns (address[] memory excludedSenders_) { 81 | excludedSenders_ = _excludedSenders; 82 | } 83 | 84 | function targetArtifacts() public view returns (string[] memory targetedArtifacts_) { 85 | targetedArtifacts_ = _targetedArtifacts; 86 | } 87 | 88 | function targetArtifactSelectors() public view returns (FuzzSelector[] memory targetedArtifactSelectors_) { 89 | targetedArtifactSelectors_ = _targetedArtifactSelectors; 90 | } 91 | 92 | function targetContracts() public view returns (address[] memory targetedContracts_) { 93 | targetedContracts_ = _targetedContracts; 94 | } 95 | 96 | function targetSelectors() public view returns (FuzzSelector[] memory targetedSelectors_) { 97 | targetedSelectors_ = _targetedSelectors; 98 | } 99 | 100 | function targetSenders() public view returns (address[] memory targetedSenders_) { 101 | targetedSenders_ = _targetedSenders; 102 | } 103 | 104 | function targetInterfaces() public view returns (FuzzInterface[] memory targetedInterfaces_) { 105 | targetedInterfaces_ = _targetedInterfaces; 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /lib/forge-std/src/StdJson.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.0 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | import {VmSafe} from "./Vm.sol"; 7 | 8 | // Helpers for parsing and writing JSON files 9 | // To parse: 10 | // ``` 11 | // using stdJson for string; 12 | // string memory json = vm.readFile("some_peth"); 13 | // json.parseUint(""); 14 | // ``` 15 | // To write: 16 | // ``` 17 | // using stdJson for string; 18 | // string memory json = "deploymentArtifact"; 19 | // Contract contract = new Contract(); 20 | // json.serialize("contractAddress", address(contract)); 21 | // json = json.serialize("deploymentTimes", uint(1)); 22 | // // store the stringified JSON to the 'json' variable we have been using as a key 23 | // // as we won't need it any longer 24 | // string memory json2 = "finalArtifact"; 25 | // string memory final = json2.serialize("depArtifact", json); 26 | // final.write(""); 27 | // ``` 28 | 29 | library stdJson { 30 | VmSafe private constant vm = VmSafe(address(uint160(uint256(keccak256("hevm cheat code"))))); 31 | 32 | function parseRaw(string memory json, string memory key) internal pure returns (bytes memory) { 33 | return vm.parseJson(json, key); 34 | } 35 | 36 | function readUint(string memory json, string memory key) internal pure returns (uint256) { 37 | return vm.parseJsonUint(json, key); 38 | } 39 | 40 | function readUintArray(string memory json, string memory key) internal pure returns (uint256[] memory) { 41 | return vm.parseJsonUintArray(json, key); 42 | } 43 | 44 | function readInt(string memory json, string memory key) internal pure returns (int256) { 45 | return vm.parseJsonInt(json, key); 46 | } 47 | 48 | function readIntArray(string memory json, string memory key) internal pure returns (int256[] memory) { 49 | return vm.parseJsonIntArray(json, key); 50 | } 51 | 52 | function readBytes32(string memory json, string memory key) internal pure returns (bytes32) { 53 | return vm.parseJsonBytes32(json, key); 54 | } 55 | 56 | function readBytes32Array(string memory json, string memory key) internal pure returns (bytes32[] memory) { 57 | return vm.parseJsonBytes32Array(json, key); 58 | } 59 | 60 | function readString(string memory json, string memory key) internal pure returns (string memory) { 61 | return vm.parseJsonString(json, key); 62 | } 63 | 64 | function readStringArray(string memory json, string memory key) internal pure returns (string[] memory) { 65 | return vm.parseJsonStringArray(json, key); 66 | } 67 | 68 | function readAddress(string memory json, string memory key) internal pure returns (address) { 69 | return vm.parseJsonAddress(json, key); 70 | } 71 | 72 | function readAddressArray(string memory json, string memory key) internal pure returns (address[] memory) { 73 | return vm.parseJsonAddressArray(json, key); 74 | } 75 | 76 | function readBool(string memory json, string memory key) internal pure returns (bool) { 77 | return vm.parseJsonBool(json, key); 78 | } 79 | 80 | function readBoolArray(string memory json, string memory key) internal pure returns (bool[] memory) { 81 | return vm.parseJsonBoolArray(json, key); 82 | } 83 | 84 | function readBytes(string memory json, string memory key) internal pure returns (bytes memory) { 85 | return vm.parseJsonBytes(json, key); 86 | } 87 | 88 | function readBytesArray(string memory json, string memory key) internal pure returns (bytes[] memory) { 89 | return vm.parseJsonBytesArray(json, key); 90 | } 91 | 92 | function serialize(string memory jsonKey, string memory key, bool value) internal returns (string memory) { 93 | return vm.serializeBool(jsonKey, key, value); 94 | } 95 | 96 | function serialize(string memory jsonKey, string memory key, bool[] memory value) 97 | internal 98 | returns (string memory) 99 | { 100 | return vm.serializeBool(jsonKey, key, value); 101 | } 102 | 103 | function serialize(string memory jsonKey, string memory key, uint256 value) internal returns (string memory) { 104 | return vm.serializeUint(jsonKey, key, value); 105 | } 106 | 107 | function serialize(string memory jsonKey, string memory key, uint256[] memory value) 108 | internal 109 | returns (string memory) 110 | { 111 | return vm.serializeUint(jsonKey, key, value); 112 | } 113 | 114 | function serialize(string memory jsonKey, string memory key, int256 value) internal returns (string memory) { 115 | return vm.serializeInt(jsonKey, key, value); 116 | } 117 | 118 | function serialize(string memory jsonKey, string memory key, int256[] memory value) 119 | internal 120 | returns (string memory) 121 | { 122 | return vm.serializeInt(jsonKey, key, value); 123 | } 124 | 125 | function serialize(string memory jsonKey, string memory key, address value) internal returns (string memory) { 126 | return vm.serializeAddress(jsonKey, key, value); 127 | } 128 | 129 | function serialize(string memory jsonKey, string memory key, address[] memory value) 130 | internal 131 | returns (string memory) 132 | { 133 | return vm.serializeAddress(jsonKey, key, value); 134 | } 135 | 136 | function serialize(string memory jsonKey, string memory key, bytes32 value) internal returns (string memory) { 137 | return vm.serializeBytes32(jsonKey, key, value); 138 | } 139 | 140 | function serialize(string memory jsonKey, string memory key, bytes32[] memory value) 141 | internal 142 | returns (string memory) 143 | { 144 | return vm.serializeBytes32(jsonKey, key, value); 145 | } 146 | 147 | function serialize(string memory jsonKey, string memory key, bytes memory value) internal returns (string memory) { 148 | return vm.serializeBytes(jsonKey, key, value); 149 | } 150 | 151 | function serialize(string memory jsonKey, string memory key, bytes[] memory value) 152 | internal 153 | returns (string memory) 154 | { 155 | return vm.serializeBytes(jsonKey, key, value); 156 | } 157 | 158 | function serialize(string memory jsonKey, string memory key, string memory value) 159 | internal 160 | returns (string memory) 161 | { 162 | return vm.serializeString(jsonKey, key, value); 163 | } 164 | 165 | function serialize(string memory jsonKey, string memory key, string[] memory value) 166 | internal 167 | returns (string memory) 168 | { 169 | return vm.serializeString(jsonKey, key, value); 170 | } 171 | 172 | function write(string memory jsonKey, string memory path) internal { 173 | vm.writeJson(jsonKey, path); 174 | } 175 | 176 | function write(string memory jsonKey, string memory path, string memory valueKey) internal { 177 | vm.writeJson(jsonKey, path, valueKey); 178 | } 179 | } 180 | -------------------------------------------------------------------------------- /lib/forge-std/src/StdMath.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | library stdMath { 5 | int256 private constant INT256_MIN = -57896044618658097711785492504343953926634992332820282019728792003956564819968; 6 | 7 | function abs(int256 a) internal pure returns (uint256) { 8 | // Required or it will fail when `a = type(int256).min` 9 | if (a == INT256_MIN) { 10 | return 57896044618658097711785492504343953926634992332820282019728792003956564819968; 11 | } 12 | 13 | return uint256(a > 0 ? a : -a); 14 | } 15 | 16 | function delta(uint256 a, uint256 b) internal pure returns (uint256) { 17 | return a > b ? a - b : b - a; 18 | } 19 | 20 | function delta(int256 a, int256 b) internal pure returns (uint256) { 21 | // a and b are of the same sign 22 | // this works thanks to two's complement, the left-most bit is the sign bit 23 | if ((a ^ b) > -1) { 24 | return delta(abs(a), abs(b)); 25 | } 26 | 27 | // a and b are of opposite signs 28 | return abs(a) + abs(b); 29 | } 30 | 31 | function percentDelta(uint256 a, uint256 b) internal pure returns (uint256) { 32 | uint256 absDelta = delta(a, b); 33 | 34 | return absDelta * 1e18 / b; 35 | } 36 | 37 | function percentDelta(int256 a, int256 b) internal pure returns (uint256) { 38 | uint256 absDelta = delta(a, b); 39 | uint256 absB = abs(b); 40 | 41 | return absDelta * 1e18 / absB; 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /lib/forge-std/src/StdStyle.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.4.22 <0.9.0; 3 | 4 | import {VmSafe} from "./Vm.sol"; 5 | 6 | library StdStyle { 7 | VmSafe private constant vm = VmSafe(address(uint160(uint256(keccak256("hevm cheat code"))))); 8 | 9 | string constant RED = "\u001b[91m"; 10 | string constant GREEN = "\u001b[92m"; 11 | string constant YELLOW = "\u001b[93m"; 12 | string constant BLUE = "\u001b[94m"; 13 | string constant MAGENTA = "\u001b[95m"; 14 | string constant CYAN = "\u001b[96m"; 15 | string constant BOLD = "\u001b[1m"; 16 | string constant DIM = "\u001b[2m"; 17 | string constant ITALIC = "\u001b[3m"; 18 | string constant UNDERLINE = "\u001b[4m"; 19 | string constant INVERSE = "\u001b[7m"; 20 | string constant RESET = "\u001b[0m"; 21 | 22 | function styleConcat(string memory style, string memory self) private pure returns (string memory) { 23 | return string(abi.encodePacked(style, self, RESET)); 24 | } 25 | 26 | function red(string memory self) internal pure returns (string memory) { 27 | return styleConcat(RED, self); 28 | } 29 | 30 | function red(uint256 self) internal pure returns (string memory) { 31 | return red(vm.toString(self)); 32 | } 33 | 34 | function red(int256 self) internal pure returns (string memory) { 35 | return red(vm.toString(self)); 36 | } 37 | 38 | function red(address self) internal pure returns (string memory) { 39 | return red(vm.toString(self)); 40 | } 41 | 42 | function red(bool self) internal pure returns (string memory) { 43 | return red(vm.toString(self)); 44 | } 45 | 46 | function redBytes(bytes memory self) internal pure returns (string memory) { 47 | return red(vm.toString(self)); 48 | } 49 | 50 | function redBytes32(bytes32 self) internal pure returns (string memory) { 51 | return red(vm.toString(self)); 52 | } 53 | 54 | function green(string memory self) internal pure returns (string memory) { 55 | return styleConcat(GREEN, self); 56 | } 57 | 58 | function green(uint256 self) internal pure returns (string memory) { 59 | return green(vm.toString(self)); 60 | } 61 | 62 | function green(int256 self) internal pure returns (string memory) { 63 | return green(vm.toString(self)); 64 | } 65 | 66 | function green(address self) internal pure returns (string memory) { 67 | return green(vm.toString(self)); 68 | } 69 | 70 | function green(bool self) internal pure returns (string memory) { 71 | return green(vm.toString(self)); 72 | } 73 | 74 | function greenBytes(bytes memory self) internal pure returns (string memory) { 75 | return green(vm.toString(self)); 76 | } 77 | 78 | function greenBytes32(bytes32 self) internal pure returns (string memory) { 79 | return green(vm.toString(self)); 80 | } 81 | 82 | function yellow(string memory self) internal pure returns (string memory) { 83 | return styleConcat(YELLOW, self); 84 | } 85 | 86 | function yellow(uint256 self) internal pure returns (string memory) { 87 | return yellow(vm.toString(self)); 88 | } 89 | 90 | function yellow(int256 self) internal pure returns (string memory) { 91 | return yellow(vm.toString(self)); 92 | } 93 | 94 | function yellow(address self) internal pure returns (string memory) { 95 | return yellow(vm.toString(self)); 96 | } 97 | 98 | function yellow(bool self) internal pure returns (string memory) { 99 | return yellow(vm.toString(self)); 100 | } 101 | 102 | function yellowBytes(bytes memory self) internal pure returns (string memory) { 103 | return yellow(vm.toString(self)); 104 | } 105 | 106 | function yellowBytes32(bytes32 self) internal pure returns (string memory) { 107 | return yellow(vm.toString(self)); 108 | } 109 | 110 | function blue(string memory self) internal pure returns (string memory) { 111 | return styleConcat(BLUE, self); 112 | } 113 | 114 | function blue(uint256 self) internal pure returns (string memory) { 115 | return blue(vm.toString(self)); 116 | } 117 | 118 | function blue(int256 self) internal pure returns (string memory) { 119 | return blue(vm.toString(self)); 120 | } 121 | 122 | function blue(address self) internal pure returns (string memory) { 123 | return blue(vm.toString(self)); 124 | } 125 | 126 | function blue(bool self) internal pure returns (string memory) { 127 | return blue(vm.toString(self)); 128 | } 129 | 130 | function blueBytes(bytes memory self) internal pure returns (string memory) { 131 | return blue(vm.toString(self)); 132 | } 133 | 134 | function blueBytes32(bytes32 self) internal pure returns (string memory) { 135 | return blue(vm.toString(self)); 136 | } 137 | 138 | function magenta(string memory self) internal pure returns (string memory) { 139 | return styleConcat(MAGENTA, self); 140 | } 141 | 142 | function magenta(uint256 self) internal pure returns (string memory) { 143 | return magenta(vm.toString(self)); 144 | } 145 | 146 | function magenta(int256 self) internal pure returns (string memory) { 147 | return magenta(vm.toString(self)); 148 | } 149 | 150 | function magenta(address self) internal pure returns (string memory) { 151 | return magenta(vm.toString(self)); 152 | } 153 | 154 | function magenta(bool self) internal pure returns (string memory) { 155 | return magenta(vm.toString(self)); 156 | } 157 | 158 | function magentaBytes(bytes memory self) internal pure returns (string memory) { 159 | return magenta(vm.toString(self)); 160 | } 161 | 162 | function magentaBytes32(bytes32 self) internal pure returns (string memory) { 163 | return magenta(vm.toString(self)); 164 | } 165 | 166 | function cyan(string memory self) internal pure returns (string memory) { 167 | return styleConcat(CYAN, self); 168 | } 169 | 170 | function cyan(uint256 self) internal pure returns (string memory) { 171 | return cyan(vm.toString(self)); 172 | } 173 | 174 | function cyan(int256 self) internal pure returns (string memory) { 175 | return cyan(vm.toString(self)); 176 | } 177 | 178 | function cyan(address self) internal pure returns (string memory) { 179 | return cyan(vm.toString(self)); 180 | } 181 | 182 | function cyan(bool self) internal pure returns (string memory) { 183 | return cyan(vm.toString(self)); 184 | } 185 | 186 | function cyanBytes(bytes memory self) internal pure returns (string memory) { 187 | return cyan(vm.toString(self)); 188 | } 189 | 190 | function cyanBytes32(bytes32 self) internal pure returns (string memory) { 191 | return cyan(vm.toString(self)); 192 | } 193 | 194 | function bold(string memory self) internal pure returns (string memory) { 195 | return styleConcat(BOLD, self); 196 | } 197 | 198 | function bold(uint256 self) internal pure returns (string memory) { 199 | return bold(vm.toString(self)); 200 | } 201 | 202 | function bold(int256 self) internal pure returns (string memory) { 203 | return bold(vm.toString(self)); 204 | } 205 | 206 | function bold(address self) internal pure returns (string memory) { 207 | return bold(vm.toString(self)); 208 | } 209 | 210 | function bold(bool self) internal pure returns (string memory) { 211 | return bold(vm.toString(self)); 212 | } 213 | 214 | function boldBytes(bytes memory self) internal pure returns (string memory) { 215 | return bold(vm.toString(self)); 216 | } 217 | 218 | function boldBytes32(bytes32 self) internal pure returns (string memory) { 219 | return bold(vm.toString(self)); 220 | } 221 | 222 | function dim(string memory self) internal pure returns (string memory) { 223 | return styleConcat(DIM, self); 224 | } 225 | 226 | function dim(uint256 self) internal pure returns (string memory) { 227 | return dim(vm.toString(self)); 228 | } 229 | 230 | function dim(int256 self) internal pure returns (string memory) { 231 | return dim(vm.toString(self)); 232 | } 233 | 234 | function dim(address self) internal pure returns (string memory) { 235 | return dim(vm.toString(self)); 236 | } 237 | 238 | function dim(bool self) internal pure returns (string memory) { 239 | return dim(vm.toString(self)); 240 | } 241 | 242 | function dimBytes(bytes memory self) internal pure returns (string memory) { 243 | return dim(vm.toString(self)); 244 | } 245 | 246 | function dimBytes32(bytes32 self) internal pure returns (string memory) { 247 | return dim(vm.toString(self)); 248 | } 249 | 250 | function italic(string memory self) internal pure returns (string memory) { 251 | return styleConcat(ITALIC, self); 252 | } 253 | 254 | function italic(uint256 self) internal pure returns (string memory) { 255 | return italic(vm.toString(self)); 256 | } 257 | 258 | function italic(int256 self) internal pure returns (string memory) { 259 | return italic(vm.toString(self)); 260 | } 261 | 262 | function italic(address self) internal pure returns (string memory) { 263 | return italic(vm.toString(self)); 264 | } 265 | 266 | function italic(bool self) internal pure returns (string memory) { 267 | return italic(vm.toString(self)); 268 | } 269 | 270 | function italicBytes(bytes memory self) internal pure returns (string memory) { 271 | return italic(vm.toString(self)); 272 | } 273 | 274 | function italicBytes32(bytes32 self) internal pure returns (string memory) { 275 | return italic(vm.toString(self)); 276 | } 277 | 278 | function underline(string memory self) internal pure returns (string memory) { 279 | return styleConcat(UNDERLINE, self); 280 | } 281 | 282 | function underline(uint256 self) internal pure returns (string memory) { 283 | return underline(vm.toString(self)); 284 | } 285 | 286 | function underline(int256 self) internal pure returns (string memory) { 287 | return underline(vm.toString(self)); 288 | } 289 | 290 | function underline(address self) internal pure returns (string memory) { 291 | return underline(vm.toString(self)); 292 | } 293 | 294 | function underline(bool self) internal pure returns (string memory) { 295 | return underline(vm.toString(self)); 296 | } 297 | 298 | function underlineBytes(bytes memory self) internal pure returns (string memory) { 299 | return underline(vm.toString(self)); 300 | } 301 | 302 | function underlineBytes32(bytes32 self) internal pure returns (string memory) { 303 | return underline(vm.toString(self)); 304 | } 305 | 306 | function inverse(string memory self) internal pure returns (string memory) { 307 | return styleConcat(INVERSE, self); 308 | } 309 | 310 | function inverse(uint256 self) internal pure returns (string memory) { 311 | return inverse(vm.toString(self)); 312 | } 313 | 314 | function inverse(int256 self) internal pure returns (string memory) { 315 | return inverse(vm.toString(self)); 316 | } 317 | 318 | function inverse(address self) internal pure returns (string memory) { 319 | return inverse(vm.toString(self)); 320 | } 321 | 322 | function inverse(bool self) internal pure returns (string memory) { 323 | return inverse(vm.toString(self)); 324 | } 325 | 326 | function inverseBytes(bytes memory self) internal pure returns (string memory) { 327 | return inverse(vm.toString(self)); 328 | } 329 | 330 | function inverseBytes32(bytes32 self) internal pure returns (string memory) { 331 | return inverse(vm.toString(self)); 332 | } 333 | } 334 | -------------------------------------------------------------------------------- /lib/forge-std/src/StdUtils.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | import {IMulticall3} from "./interfaces/IMulticall3.sol"; 7 | import {VmSafe} from "./Vm.sol"; 8 | 9 | abstract contract StdUtils { 10 | /*////////////////////////////////////////////////////////////////////////// 11 | CONSTANTS 12 | //////////////////////////////////////////////////////////////////////////*/ 13 | 14 | IMulticall3 private constant multicall = IMulticall3(0xcA11bde05977b3631167028862bE2a173976CA11); 15 | VmSafe private constant vm = VmSafe(address(uint160(uint256(keccak256("hevm cheat code"))))); 16 | address private constant CONSOLE2_ADDRESS = 0x000000000000000000636F6e736F6c652e6c6f67; 17 | uint256 private constant INT256_MIN_ABS = 18 | 57896044618658097711785492504343953926634992332820282019728792003956564819968; 19 | uint256 private constant SECP256K1_ORDER = 20 | 115792089237316195423570985008687907852837564279074904382605163141518161494337; 21 | uint256 private constant UINT256_MAX = 22 | 115792089237316195423570985008687907853269984665640564039457584007913129639935; 23 | 24 | // Used by default when deploying with create2, https://github.com/Arachnid/deterministic-deployment-proxy. 25 | address private constant CREATE2_FACTORY = 0x4e59b44847b379578588920cA78FbF26c0B4956C; 26 | 27 | /*////////////////////////////////////////////////////////////////////////// 28 | INTERNAL FUNCTIONS 29 | //////////////////////////////////////////////////////////////////////////*/ 30 | 31 | function _bound(uint256 x, uint256 min, uint256 max) internal pure virtual returns (uint256 result) { 32 | require(min <= max, "StdUtils bound(uint256,uint256,uint256): Max is less than min."); 33 | // If x is between min and max, return x directly. This is to ensure that dictionary values 34 | // do not get shifted if the min is nonzero. More info: https://github.com/foundry-rs/forge-std/issues/188 35 | if (x >= min && x <= max) return x; 36 | 37 | uint256 size = max - min + 1; 38 | 39 | // If the value is 0, 1, 2, 3, wrap that to min, min+1, min+2, min+3. Similarly for the UINT256_MAX side. 40 | // This helps ensure coverage of the min/max values. 41 | if (x <= 3 && size > x) return min + x; 42 | if (x >= UINT256_MAX - 3 && size > UINT256_MAX - x) return max - (UINT256_MAX - x); 43 | 44 | // Otherwise, wrap x into the range [min, max], i.e. the range is inclusive. 45 | if (x > max) { 46 | uint256 diff = x - max; 47 | uint256 rem = diff % size; 48 | if (rem == 0) return max; 49 | result = min + rem - 1; 50 | } else if (x < min) { 51 | uint256 diff = min - x; 52 | uint256 rem = diff % size; 53 | if (rem == 0) return min; 54 | result = max - rem + 1; 55 | } 56 | } 57 | 58 | function bound(uint256 x, uint256 min, uint256 max) internal view virtual returns (uint256 result) { 59 | result = _bound(x, min, max); 60 | console2_log("Bound Result", result); 61 | } 62 | 63 | function _bound(int256 x, int256 min, int256 max) internal pure virtual returns (int256 result) { 64 | require(min <= max, "StdUtils bound(int256,int256,int256): Max is less than min."); 65 | 66 | // Shifting all int256 values to uint256 to use _bound function. The range of two types are: 67 | // int256 : -(2**255) ~ (2**255 - 1) 68 | // uint256: 0 ~ (2**256 - 1) 69 | // So, add 2**255, INT256_MIN_ABS to the integer values. 70 | // 71 | // If the given integer value is -2**255, we cannot use `-uint256(-x)` because of the overflow. 72 | // So, use `~uint256(x) + 1` instead. 73 | uint256 _x = x < 0 ? (INT256_MIN_ABS - ~uint256(x) - 1) : (uint256(x) + INT256_MIN_ABS); 74 | uint256 _min = min < 0 ? (INT256_MIN_ABS - ~uint256(min) - 1) : (uint256(min) + INT256_MIN_ABS); 75 | uint256 _max = max < 0 ? (INT256_MIN_ABS - ~uint256(max) - 1) : (uint256(max) + INT256_MIN_ABS); 76 | 77 | uint256 y = _bound(_x, _min, _max); 78 | 79 | // To move it back to int256 value, subtract INT256_MIN_ABS at here. 80 | result = y < INT256_MIN_ABS ? int256(~(INT256_MIN_ABS - y) + 1) : int256(y - INT256_MIN_ABS); 81 | } 82 | 83 | function bound(int256 x, int256 min, int256 max) internal view virtual returns (int256 result) { 84 | result = _bound(x, min, max); 85 | console2_log("Bound result", vm.toString(result)); 86 | } 87 | 88 | function boundPrivateKey(uint256 privateKey) internal pure virtual returns (uint256 result) { 89 | result = _bound(privateKey, 1, SECP256K1_ORDER - 1); 90 | } 91 | 92 | function bytesToUint(bytes memory b) internal pure virtual returns (uint256) { 93 | require(b.length <= 32, "StdUtils bytesToUint(bytes): Bytes length exceeds 32."); 94 | return abi.decode(abi.encodePacked(new bytes(32 - b.length), b), (uint256)); 95 | } 96 | 97 | /// @dev Compute the address a contract will be deployed at for a given deployer address and nonce 98 | /// @notice adapted from Solmate implementation (https://github.com/Rari-Capital/solmate/blob/main/src/utils/LibRLP.sol) 99 | function computeCreateAddress(address deployer, uint256 nonce) internal pure virtual returns (address) { 100 | // forgefmt: disable-start 101 | // The integer zero is treated as an empty byte string, and as a result it only has a length prefix, 0x80, computed via 0x80 + 0. 102 | // A one byte integer uses its own value as its length prefix, there is no additional "0x80 + length" prefix that comes before it. 103 | if (nonce == 0x00) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd6), bytes1(0x94), deployer, bytes1(0x80)))); 104 | if (nonce <= 0x7f) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd6), bytes1(0x94), deployer, uint8(nonce)))); 105 | 106 | // Nonces greater than 1 byte all follow a consistent encoding scheme, where each value is preceded by a prefix of 0x80 + length. 107 | if (nonce <= 2**8 - 1) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd7), bytes1(0x94), deployer, bytes1(0x81), uint8(nonce)))); 108 | if (nonce <= 2**16 - 1) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd8), bytes1(0x94), deployer, bytes1(0x82), uint16(nonce)))); 109 | if (nonce <= 2**24 - 1) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd9), bytes1(0x94), deployer, bytes1(0x83), uint24(nonce)))); 110 | // forgefmt: disable-end 111 | 112 | // More details about RLP encoding can be found here: https://eth.wiki/fundamentals/rlp 113 | // 0xda = 0xc0 (short RLP prefix) + 0x16 (length of: 0x94 ++ proxy ++ 0x84 ++ nonce) 114 | // 0x94 = 0x80 + 0x14 (0x14 = the length of an address, 20 bytes, in hex) 115 | // 0x84 = 0x80 + 0x04 (0x04 = the bytes length of the nonce, 4 bytes, in hex) 116 | // We assume nobody can have a nonce large enough to require more than 32 bytes. 117 | return addressFromLast20Bytes( 118 | keccak256(abi.encodePacked(bytes1(0xda), bytes1(0x94), deployer, bytes1(0x84), uint32(nonce))) 119 | ); 120 | } 121 | 122 | function computeCreate2Address(bytes32 salt, bytes32 initcodeHash, address deployer) 123 | internal 124 | pure 125 | virtual 126 | returns (address) 127 | { 128 | return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xff), deployer, salt, initcodeHash))); 129 | } 130 | 131 | /// @dev returns the address of a contract created with CREATE2 using the default CREATE2 deployer 132 | function computeCreate2Address(bytes32 salt, bytes32 initCodeHash) internal pure returns (address) { 133 | return computeCreate2Address(salt, initCodeHash, CREATE2_FACTORY); 134 | } 135 | 136 | /// @dev returns the hash of the init code (creation code + no args) used in CREATE2 with no constructor arguments 137 | /// @param creationCode the creation code of a contract C, as returned by type(C).creationCode 138 | function hashInitCode(bytes memory creationCode) internal pure returns (bytes32) { 139 | return hashInitCode(creationCode, ""); 140 | } 141 | 142 | /// @dev returns the hash of the init code (creation code + ABI-encoded args) used in CREATE2 143 | /// @param creationCode the creation code of a contract C, as returned by type(C).creationCode 144 | /// @param args the ABI-encoded arguments to the constructor of C 145 | function hashInitCode(bytes memory creationCode, bytes memory args) internal pure returns (bytes32) { 146 | return keccak256(abi.encodePacked(creationCode, args)); 147 | } 148 | 149 | // Performs a single call with Multicall3 to query the ERC-20 token balances of the given addresses. 150 | function getTokenBalances(address token, address[] memory addresses) 151 | internal 152 | virtual 153 | returns (uint256[] memory balances) 154 | { 155 | uint256 tokenCodeSize; 156 | assembly { 157 | tokenCodeSize := extcodesize(token) 158 | } 159 | require(tokenCodeSize > 0, "StdUtils getTokenBalances(address,address[]): Token address is not a contract."); 160 | 161 | // ABI encode the aggregate call to Multicall3. 162 | uint256 length = addresses.length; 163 | IMulticall3.Call[] memory calls = new IMulticall3.Call[](length); 164 | for (uint256 i = 0; i < length; ++i) { 165 | // 0x70a08231 = bytes4("balanceOf(address)")) 166 | calls[i] = IMulticall3.Call({target: token, callData: abi.encodeWithSelector(0x70a08231, (addresses[i]))}); 167 | } 168 | 169 | // Make the aggregate call. 170 | (, bytes[] memory returnData) = multicall.aggregate(calls); 171 | 172 | // ABI decode the return data and return the balances. 173 | balances = new uint256[](length); 174 | for (uint256 i = 0; i < length; ++i) { 175 | balances[i] = abi.decode(returnData[i], (uint256)); 176 | } 177 | } 178 | 179 | /*////////////////////////////////////////////////////////////////////////// 180 | PRIVATE FUNCTIONS 181 | //////////////////////////////////////////////////////////////////////////*/ 182 | 183 | function addressFromLast20Bytes(bytes32 bytesValue) private pure returns (address) { 184 | return address(uint160(uint256(bytesValue))); 185 | } 186 | 187 | // Used to prevent the compilation of console, which shortens the compilation time when console is not used elsewhere. 188 | 189 | function console2_log(string memory p0, uint256 p1) private view { 190 | (bool status,) = address(CONSOLE2_ADDRESS).staticcall(abi.encodeWithSignature("log(string,uint256)", p0, p1)); 191 | status; 192 | } 193 | 194 | function console2_log(string memory p0, string memory p1) private view { 195 | (bool status,) = address(CONSOLE2_ADDRESS).staticcall(abi.encodeWithSignature("log(string,string)", p0, p1)); 196 | status; 197 | } 198 | } 199 | -------------------------------------------------------------------------------- /lib/forge-std/src/Test.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | // 💬 ABOUT 7 | // Forge Std's default Test. 8 | 9 | // 🧩 MODULES 10 | import {console} from "./console.sol"; 11 | import {console2} from "./console2.sol"; 12 | import {safeconsole} from "./safeconsole.sol"; 13 | import {StdAssertions} from "./StdAssertions.sol"; 14 | import {StdChains} from "./StdChains.sol"; 15 | import {StdCheats} from "./StdCheats.sol"; 16 | import {stdError} from "./StdError.sol"; 17 | import {StdInvariant} from "./StdInvariant.sol"; 18 | import {stdJson} from "./StdJson.sol"; 19 | import {stdMath} from "./StdMath.sol"; 20 | import {StdStorage, stdStorage} from "./StdStorage.sol"; 21 | import {StdStyle} from "./StdStyle.sol"; 22 | import {StdUtils} from "./StdUtils.sol"; 23 | import {Vm} from "./Vm.sol"; 24 | 25 | // 📦 BOILERPLATE 26 | import {TestBase} from "./Base.sol"; 27 | import {DSTest} from "ds-test/test.sol"; 28 | 29 | // ⭐️ TEST 30 | abstract contract Test is TestBase, DSTest, StdAssertions, StdChains, StdCheats, StdInvariant, StdUtils { 31 | // Note: IS_TEST() must return true. 32 | // Note: Must have failure system, https://github.com/dapphub/ds-test/blob/cd98eff28324bfac652e63a239a60632a761790b/src/test.sol#L39-L76. 33 | } 34 | -------------------------------------------------------------------------------- /lib/forge-std/src/interfaces/IERC1155.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2; 3 | 4 | import "./IERC165.sol"; 5 | 6 | /// @title ERC-1155 Multi Token Standard 7 | /// @dev See https://eips.ethereum.org/EIPS/eip-1155 8 | /// Note: The ERC-165 identifier for this interface is 0xd9b67a26. 9 | interface IERC1155 is IERC165 { 10 | /// @dev 11 | /// - Either `TransferSingle` or `TransferBatch` MUST emit when tokens are transferred, including zero value transfers as well as minting or burning (see "Safe Transfer Rules" section of the standard). 12 | /// - The `_operator` argument MUST be the address of an account/contract that is approved to make the transfer (SHOULD be msg.sender). 13 | /// - The `_from` argument MUST be the address of the holder whose balance is decreased. 14 | /// - The `_to` argument MUST be the address of the recipient whose balance is increased. 15 | /// - The `_id` argument MUST be the token type being transferred. 16 | /// - The `_value` argument MUST be the number of tokens the holder balance is decreased by and match what the recipient balance is increased by. 17 | /// - When minting/creating tokens, the `_from` argument MUST be set to `0x0` (i.e. zero address). 18 | /// - When burning/destroying tokens, the `_to` argument MUST be set to `0x0` (i.e. zero address). 19 | event TransferSingle( 20 | address indexed _operator, address indexed _from, address indexed _to, uint256 _id, uint256 _value 21 | ); 22 | 23 | /// @dev 24 | /// - Either `TransferSingle` or `TransferBatch` MUST emit when tokens are transferred, including zero value transfers as well as minting or burning (see "Safe Transfer Rules" section of the standard). 25 | /// - The `_operator` argument MUST be the address of an account/contract that is approved to make the transfer (SHOULD be msg.sender). 26 | /// - The `_from` argument MUST be the address of the holder whose balance is decreased. 27 | /// - The `_to` argument MUST be the address of the recipient whose balance is increased. 28 | /// - The `_ids` argument MUST be the list of tokens being transferred. 29 | /// - The `_values` argument MUST be the list of number of tokens (matching the list and order of tokens specified in _ids) the holder balance is decreased by and match what the recipient balance is increased by. 30 | /// - When minting/creating tokens, the `_from` argument MUST be set to `0x0` (i.e. zero address). 31 | /// - When burning/destroying tokens, the `_to` argument MUST be set to `0x0` (i.e. zero address). 32 | event TransferBatch( 33 | address indexed _operator, address indexed _from, address indexed _to, uint256[] _ids, uint256[] _values 34 | ); 35 | 36 | /// @dev MUST emit when approval for a second party/operator address to manage all tokens for an owner address is enabled or disabled (absence of an event assumes disabled). 37 | event ApprovalForAll(address indexed _owner, address indexed _operator, bool _approved); 38 | 39 | /// @dev MUST emit when the URI is updated for a token ID. URIs are defined in RFC 3986. 40 | /// The URI MUST point to a JSON file that conforms to the "ERC-1155 Metadata URI JSON Schema". 41 | event URI(string _value, uint256 indexed _id); 42 | 43 | /// @notice Transfers `_value` amount of an `_id` from the `_from` address to the `_to` address specified (with safety call). 44 | /// @dev Caller must be approved to manage the tokens being transferred out of the `_from` account (see "Approval" section of the standard). 45 | /// - MUST revert if `_to` is the zero address. 46 | /// - MUST revert if balance of holder for token `_id` is lower than the `_value` sent. 47 | /// - MUST revert on any other error. 48 | /// - MUST emit the `TransferSingle` event to reflect the balance change (see "Safe Transfer Rules" section of the standard). 49 | /// - After the above conditions are met, this function MUST check if `_to` is a smart contract (e.g. code size > 0). If so, it MUST call `onERC1155Received` on `_to` and act appropriately (see "Safe Transfer Rules" section of the standard). 50 | /// @param _from Source address 51 | /// @param _to Target address 52 | /// @param _id ID of the token type 53 | /// @param _value Transfer amount 54 | /// @param _data Additional data with no specified format, MUST be sent unaltered in call to `onERC1155Received` on `_to` 55 | function safeTransferFrom(address _from, address _to, uint256 _id, uint256 _value, bytes calldata _data) external; 56 | 57 | /// @notice Transfers `_values` amount(s) of `_ids` from the `_from` address to the `_to` address specified (with safety call). 58 | /// @dev Caller must be approved to manage the tokens being transferred out of the `_from` account (see "Approval" section of the standard). 59 | /// - MUST revert if `_to` is the zero address. 60 | /// - MUST revert if length of `_ids` is not the same as length of `_values`. 61 | /// - MUST revert if any of the balance(s) of the holder(s) for token(s) in `_ids` is lower than the respective amount(s) in `_values` sent to the recipient. 62 | /// - MUST revert on any other error. 63 | /// - MUST emit `TransferSingle` or `TransferBatch` event(s) such that all the balance changes are reflected (see "Safe Transfer Rules" section of the standard). 64 | /// - Balance changes and events MUST follow the ordering of the arrays (_ids[0]/_values[0] before _ids[1]/_values[1], etc). 65 | /// - After the above conditions for the transfer(s) in the batch are met, this function MUST check if `_to` is a smart contract (e.g. code size > 0). If so, it MUST call the relevant `ERC1155TokenReceiver` hook(s) on `_to` and act appropriately (see "Safe Transfer Rules" section of the standard). 66 | /// @param _from Source address 67 | /// @param _to Target address 68 | /// @param _ids IDs of each token type (order and length must match _values array) 69 | /// @param _values Transfer amounts per token type (order and length must match _ids array) 70 | /// @param _data Additional data with no specified format, MUST be sent unaltered in call to the `ERC1155TokenReceiver` hook(s) on `_to` 71 | function safeBatchTransferFrom( 72 | address _from, 73 | address _to, 74 | uint256[] calldata _ids, 75 | uint256[] calldata _values, 76 | bytes calldata _data 77 | ) external; 78 | 79 | /// @notice Get the balance of an account's tokens. 80 | /// @param _owner The address of the token holder 81 | /// @param _id ID of the token 82 | /// @return The _owner's balance of the token type requested 83 | function balanceOf(address _owner, uint256 _id) external view returns (uint256); 84 | 85 | /// @notice Get the balance of multiple account/token pairs 86 | /// @param _owners The addresses of the token holders 87 | /// @param _ids ID of the tokens 88 | /// @return The _owner's balance of the token types requested (i.e. balance for each (owner, id) pair) 89 | function balanceOfBatch(address[] calldata _owners, uint256[] calldata _ids) 90 | external 91 | view 92 | returns (uint256[] memory); 93 | 94 | /// @notice Enable or disable approval for a third party ("operator") to manage all of the caller's tokens. 95 | /// @dev MUST emit the ApprovalForAll event on success. 96 | /// @param _operator Address to add to the set of authorized operators 97 | /// @param _approved True if the operator is approved, false to revoke approval 98 | function setApprovalForAll(address _operator, bool _approved) external; 99 | 100 | /// @notice Queries the approval status of an operator for a given owner. 101 | /// @param _owner The owner of the tokens 102 | /// @param _operator Address of authorized operator 103 | /// @return True if the operator is approved, false if not 104 | function isApprovedForAll(address _owner, address _operator) external view returns (bool); 105 | } 106 | -------------------------------------------------------------------------------- /lib/forge-std/src/interfaces/IERC165.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2; 3 | 4 | interface IERC165 { 5 | /// @notice Query if a contract implements an interface 6 | /// @param interfaceID The interface identifier, as specified in ERC-165 7 | /// @dev Interface identification is specified in ERC-165. This function 8 | /// uses less than 30,000 gas. 9 | /// @return `true` if the contract implements `interfaceID` and 10 | /// `interfaceID` is not 0xffffffff, `false` otherwise 11 | function supportsInterface(bytes4 interfaceID) external view returns (bool); 12 | } 13 | -------------------------------------------------------------------------------- /lib/forge-std/src/interfaces/IERC20.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2; 3 | 4 | /// @dev Interface of the ERC20 standard as defined in the EIP. 5 | /// @dev This includes the optional name, symbol, and decimals metadata. 6 | interface IERC20 { 7 | /// @dev Emitted when `value` tokens are moved from one account (`from`) to another (`to`). 8 | event Transfer(address indexed from, address indexed to, uint256 value); 9 | 10 | /// @dev Emitted when the allowance of a `spender` for an `owner` is set, where `value` 11 | /// is the new allowance. 12 | event Approval(address indexed owner, address indexed spender, uint256 value); 13 | 14 | /// @notice Returns the amount of tokens in existence. 15 | function totalSupply() external view returns (uint256); 16 | 17 | /// @notice Returns the amount of tokens owned by `account`. 18 | function balanceOf(address account) external view returns (uint256); 19 | 20 | /// @notice Moves `amount` tokens from the caller's account to `to`. 21 | function transfer(address to, uint256 amount) external returns (bool); 22 | 23 | /// @notice Returns the remaining number of tokens that `spender` is allowed 24 | /// to spend on behalf of `owner` 25 | function allowance(address owner, address spender) external view returns (uint256); 26 | 27 | /// @notice Sets `amount` as the allowance of `spender` over the caller's tokens. 28 | /// @dev Be aware of front-running risks: https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 29 | function approve(address spender, uint256 amount) external returns (bool); 30 | 31 | /// @notice Moves `amount` tokens from `from` to `to` using the allowance mechanism. 32 | /// `amount` is then deducted from the caller's allowance. 33 | function transferFrom(address from, address to, uint256 amount) external returns (bool); 34 | 35 | /// @notice Returns the name of the token. 36 | function name() external view returns (string memory); 37 | 38 | /// @notice Returns the symbol of the token. 39 | function symbol() external view returns (string memory); 40 | 41 | /// @notice Returns the decimals places of the token. 42 | function decimals() external view returns (uint8); 43 | } 44 | -------------------------------------------------------------------------------- /lib/forge-std/src/interfaces/IERC4626.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2; 3 | 4 | import "./IERC20.sol"; 5 | 6 | /// @dev Interface of the ERC4626 "Tokenized Vault Standard", as defined in 7 | /// https://eips.ethereum.org/EIPS/eip-4626 8 | interface IERC4626 is IERC20 { 9 | event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares); 10 | 11 | event Withdraw( 12 | address indexed sender, address indexed receiver, address indexed owner, uint256 assets, uint256 shares 13 | ); 14 | 15 | /// @notice Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing. 16 | /// @dev 17 | /// - MUST be an ERC-20 token contract. 18 | /// - MUST NOT revert. 19 | function asset() external view returns (address assetTokenAddress); 20 | 21 | /// @notice Returns the total amount of the underlying asset that is “managed” by Vault. 22 | /// @dev 23 | /// - SHOULD include any compounding that occurs from yield. 24 | /// - MUST be inclusive of any fees that are charged against assets in the Vault. 25 | /// - MUST NOT revert. 26 | function totalAssets() external view returns (uint256 totalManagedAssets); 27 | 28 | /// @notice Returns the amount of shares that the Vault would exchange for the amount of assets provided, in an ideal 29 | /// scenario where all the conditions are met. 30 | /// @dev 31 | /// - MUST NOT be inclusive of any fees that are charged against assets in the Vault. 32 | /// - MUST NOT show any variations depending on the caller. 33 | /// - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange. 34 | /// - MUST NOT revert. 35 | /// 36 | /// NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the 37 | /// “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and 38 | /// from. 39 | function convertToShares(uint256 assets) external view returns (uint256 shares); 40 | 41 | /// @notice Returns the amount of assets that the Vault would exchange for the amount of shares provided, in an ideal 42 | /// scenario where all the conditions are met. 43 | /// @dev 44 | /// - MUST NOT be inclusive of any fees that are charged against assets in the Vault. 45 | /// - MUST NOT show any variations depending on the caller. 46 | /// - MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange. 47 | /// - MUST NOT revert. 48 | /// 49 | /// NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the 50 | /// “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and 51 | /// from. 52 | function convertToAssets(uint256 shares) external view returns (uint256 assets); 53 | 54 | /// @notice Returns the maximum amount of the underlying asset that can be deposited into the Vault for the receiver, 55 | /// through a deposit call. 56 | /// @dev 57 | /// - MUST return a limited value if receiver is subject to some deposit limit. 58 | /// - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited. 59 | /// - MUST NOT revert. 60 | function maxDeposit(address receiver) external view returns (uint256 maxAssets); 61 | 62 | /// @notice Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given 63 | /// current on-chain conditions. 64 | /// @dev 65 | /// - MUST return as close to and no more than the exact amount of Vault shares that would be minted in a deposit 66 | /// call in the same transaction. I.e. deposit should return the same or more shares as previewDeposit if called 67 | /// in the same transaction. 68 | /// - MUST NOT account for deposit limits like those returned from maxDeposit and should always act as though the 69 | /// deposit would be accepted, regardless if the user has enough tokens approved, etc. 70 | /// - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees. 71 | /// - MUST NOT revert. 72 | /// 73 | /// NOTE: any unfavorable discrepancy between convertToShares and previewDeposit SHOULD be considered slippage in 74 | /// share price or some other type of condition, meaning the depositor will lose assets by depositing. 75 | function previewDeposit(uint256 assets) external view returns (uint256 shares); 76 | 77 | /// @notice Mints shares Vault shares to receiver by depositing exactly amount of underlying tokens. 78 | /// @dev 79 | /// - MUST emit the Deposit event. 80 | /// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the 81 | /// deposit execution, and are accounted for during deposit. 82 | /// - MUST revert if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not 83 | /// approving enough underlying tokens to the Vault contract, etc). 84 | /// 85 | /// NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token. 86 | function deposit(uint256 assets, address receiver) external returns (uint256 shares); 87 | 88 | /// @notice Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call. 89 | /// @dev 90 | /// - MUST return a limited value if receiver is subject to some mint limit. 91 | /// - MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted. 92 | /// - MUST NOT revert. 93 | function maxMint(address receiver) external view returns (uint256 maxShares); 94 | 95 | /// @notice Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given 96 | /// current on-chain conditions. 97 | /// @dev 98 | /// - MUST return as close to and no fewer than the exact amount of assets that would be deposited in a mint call 99 | /// in the same transaction. I.e. mint should return the same or fewer assets as previewMint if called in the 100 | /// same transaction. 101 | /// - MUST NOT account for mint limits like those returned from maxMint and should always act as though the mint 102 | /// would be accepted, regardless if the user has enough tokens approved, etc. 103 | /// - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees. 104 | /// - MUST NOT revert. 105 | /// 106 | /// NOTE: any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in 107 | /// share price or some other type of condition, meaning the depositor will lose assets by minting. 108 | function previewMint(uint256 shares) external view returns (uint256 assets); 109 | 110 | /// @notice Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens. 111 | /// @dev 112 | /// - MUST emit the Deposit event. 113 | /// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint 114 | /// execution, and are accounted for during mint. 115 | /// - MUST revert if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not 116 | /// approving enough underlying tokens to the Vault contract, etc). 117 | /// 118 | /// NOTE: most implementations will require pre-approval of the Vault with the Vault’s underlying asset token. 119 | function mint(uint256 shares, address receiver) external returns (uint256 assets); 120 | 121 | /// @notice Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the 122 | /// Vault, through a withdraw call. 123 | /// @dev 124 | /// - MUST return a limited value if owner is subject to some withdrawal limit or timelock. 125 | /// - MUST NOT revert. 126 | function maxWithdraw(address owner) external view returns (uint256 maxAssets); 127 | 128 | /// @notice Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block, 129 | /// given current on-chain conditions. 130 | /// @dev 131 | /// - MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw 132 | /// call in the same transaction. I.e. withdraw should return the same or fewer shares as previewWithdraw if 133 | /// called 134 | /// in the same transaction. 135 | /// - MUST NOT account for withdrawal limits like those returned from maxWithdraw and should always act as though 136 | /// the withdrawal would be accepted, regardless if the user has enough shares, etc. 137 | /// - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees. 138 | /// - MUST NOT revert. 139 | /// 140 | /// NOTE: any unfavorable discrepancy between convertToShares and previewWithdraw SHOULD be considered slippage in 141 | /// share price or some other type of condition, meaning the depositor will lose assets by depositing. 142 | function previewWithdraw(uint256 assets) external view returns (uint256 shares); 143 | 144 | /// @notice Burns shares from owner and sends exactly assets of underlying tokens to receiver. 145 | /// @dev 146 | /// - MUST emit the Withdraw event. 147 | /// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the 148 | /// withdraw execution, and are accounted for during withdraw. 149 | /// - MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner 150 | /// not having enough shares, etc). 151 | /// 152 | /// Note that some implementations will require pre-requesting to the Vault before a withdrawal may be performed. 153 | /// Those methods should be performed separately. 154 | function withdraw(uint256 assets, address receiver, address owner) external returns (uint256 shares); 155 | 156 | /// @notice Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault, 157 | /// through a redeem call. 158 | /// @dev 159 | /// - MUST return a limited value if owner is subject to some withdrawal limit or timelock. 160 | /// - MUST return balanceOf(owner) if owner is not subject to any withdrawal limit or timelock. 161 | /// - MUST NOT revert. 162 | function maxRedeem(address owner) external view returns (uint256 maxShares); 163 | 164 | /// @notice Allows an on-chain or off-chain user to simulate the effects of their redeemption at the current block, 165 | /// given current on-chain conditions. 166 | /// @dev 167 | /// - MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call 168 | /// in the same transaction. I.e. redeem should return the same or more assets as previewRedeem if called in the 169 | /// same transaction. 170 | /// - MUST NOT account for redemption limits like those returned from maxRedeem and should always act as though the 171 | /// redemption would be accepted, regardless if the user has enough shares, etc. 172 | /// - MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees. 173 | /// - MUST NOT revert. 174 | /// 175 | /// NOTE: any unfavorable discrepancy between convertToAssets and previewRedeem SHOULD be considered slippage in 176 | /// share price or some other type of condition, meaning the depositor will lose assets by redeeming. 177 | function previewRedeem(uint256 shares) external view returns (uint256 assets); 178 | 179 | /// @notice Burns exactly shares from owner and sends assets of underlying tokens to receiver. 180 | /// @dev 181 | /// - MUST emit the Withdraw event. 182 | /// - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the 183 | /// redeem execution, and are accounted for during redeem. 184 | /// - MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner 185 | /// not having enough shares, etc). 186 | /// 187 | /// NOTE: some implementations will require pre-requesting to the Vault before a withdrawal may be performed. 188 | /// Those methods should be performed separately. 189 | function redeem(uint256 shares, address receiver, address owner) external returns (uint256 assets); 190 | } 191 | -------------------------------------------------------------------------------- /lib/forge-std/src/interfaces/IERC721.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2; 3 | 4 | import "./IERC165.sol"; 5 | 6 | /// @title ERC-721 Non-Fungible Token Standard 7 | /// @dev See https://eips.ethereum.org/EIPS/eip-721 8 | /// Note: the ERC-165 identifier for this interface is 0x80ac58cd. 9 | interface IERC721 is IERC165 { 10 | /// @dev This emits when ownership of any NFT changes by any mechanism. 11 | /// This event emits when NFTs are created (`from` == 0) and destroyed 12 | /// (`to` == 0). Exception: during contract creation, any number of NFTs 13 | /// may be created and assigned without emitting Transfer. At the time of 14 | /// any transfer, the approved address for that NFT (if any) is reset to none. 15 | event Transfer(address indexed _from, address indexed _to, uint256 indexed _tokenId); 16 | 17 | /// @dev This emits when the approved address for an NFT is changed or 18 | /// reaffirmed. The zero address indicates there is no approved address. 19 | /// When a Transfer event emits, this also indicates that the approved 20 | /// address for that NFT (if any) is reset to none. 21 | event Approval(address indexed _owner, address indexed _approved, uint256 indexed _tokenId); 22 | 23 | /// @dev This emits when an operator is enabled or disabled for an owner. 24 | /// The operator can manage all NFTs of the owner. 25 | event ApprovalForAll(address indexed _owner, address indexed _operator, bool _approved); 26 | 27 | /// @notice Count all NFTs assigned to an owner 28 | /// @dev NFTs assigned to the zero address are considered invalid, and this 29 | /// function throws for queries about the zero address. 30 | /// @param _owner An address for whom to query the balance 31 | /// @return The number of NFTs owned by `_owner`, possibly zero 32 | function balanceOf(address _owner) external view returns (uint256); 33 | 34 | /// @notice Find the owner of an NFT 35 | /// @dev NFTs assigned to zero address are considered invalid, and queries 36 | /// about them do throw. 37 | /// @param _tokenId The identifier for an NFT 38 | /// @return The address of the owner of the NFT 39 | function ownerOf(uint256 _tokenId) external view returns (address); 40 | 41 | /// @notice Transfers the ownership of an NFT from one address to another address 42 | /// @dev Throws unless `msg.sender` is the current owner, an authorized 43 | /// operator, or the approved address for this NFT. Throws if `_from` is 44 | /// not the current owner. Throws if `_to` is the zero address. Throws if 45 | /// `_tokenId` is not a valid NFT. When transfer is complete, this function 46 | /// checks if `_to` is a smart contract (code size > 0). If so, it calls 47 | /// `onERC721Received` on `_to` and throws if the return value is not 48 | /// `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`. 49 | /// @param _from The current owner of the NFT 50 | /// @param _to The new owner 51 | /// @param _tokenId The NFT to transfer 52 | /// @param data Additional data with no specified format, sent in call to `_to` 53 | function safeTransferFrom(address _from, address _to, uint256 _tokenId, bytes calldata data) external payable; 54 | 55 | /// @notice Transfers the ownership of an NFT from one address to another address 56 | /// @dev This works identically to the other function with an extra data parameter, 57 | /// except this function just sets data to "". 58 | /// @param _from The current owner of the NFT 59 | /// @param _to The new owner 60 | /// @param _tokenId The NFT to transfer 61 | function safeTransferFrom(address _from, address _to, uint256 _tokenId) external payable; 62 | 63 | /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE 64 | /// TO CONFIRM THAT `_to` IS CAPABLE OF RECEIVING NFTS OR ELSE 65 | /// THEY MAY BE PERMANENTLY LOST 66 | /// @dev Throws unless `msg.sender` is the current owner, an authorized 67 | /// operator, or the approved address for this NFT. Throws if `_from` is 68 | /// not the current owner. Throws if `_to` is the zero address. Throws if 69 | /// `_tokenId` is not a valid NFT. 70 | /// @param _from The current owner of the NFT 71 | /// @param _to The new owner 72 | /// @param _tokenId The NFT to transfer 73 | function transferFrom(address _from, address _to, uint256 _tokenId) external payable; 74 | 75 | /// @notice Change or reaffirm the approved address for an NFT 76 | /// @dev The zero address indicates there is no approved address. 77 | /// Throws unless `msg.sender` is the current NFT owner, or an authorized 78 | /// operator of the current owner. 79 | /// @param _approved The new approved NFT controller 80 | /// @param _tokenId The NFT to approve 81 | function approve(address _approved, uint256 _tokenId) external payable; 82 | 83 | /// @notice Enable or disable approval for a third party ("operator") to manage 84 | /// all of `msg.sender`'s assets 85 | /// @dev Emits the ApprovalForAll event. The contract MUST allow 86 | /// multiple operators per owner. 87 | /// @param _operator Address to add to the set of authorized operators 88 | /// @param _approved True if the operator is approved, false to revoke approval 89 | function setApprovalForAll(address _operator, bool _approved) external; 90 | 91 | /// @notice Get the approved address for a single NFT 92 | /// @dev Throws if `_tokenId` is not a valid NFT. 93 | /// @param _tokenId The NFT to find the approved address for 94 | /// @return The approved address for this NFT, or the zero address if there is none 95 | function getApproved(uint256 _tokenId) external view returns (address); 96 | 97 | /// @notice Query if an address is an authorized operator for another address 98 | /// @param _owner The address that owns the NFTs 99 | /// @param _operator The address that acts on behalf of the owner 100 | /// @return True if `_operator` is an approved operator for `_owner`, false otherwise 101 | function isApprovedForAll(address _owner, address _operator) external view returns (bool); 102 | } 103 | 104 | /// @dev Note: the ERC-165 identifier for this interface is 0x150b7a02. 105 | interface IERC721TokenReceiver { 106 | /// @notice Handle the receipt of an NFT 107 | /// @dev The ERC721 smart contract calls this function on the recipient 108 | /// after a `transfer`. This function MAY throw to revert and reject the 109 | /// transfer. Return of other than the magic value MUST result in the 110 | /// transaction being reverted. 111 | /// Note: the contract address is always the message sender. 112 | /// @param _operator The address which called `safeTransferFrom` function 113 | /// @param _from The address which previously owned the token 114 | /// @param _tokenId The NFT identifier which is being transferred 115 | /// @param _data Additional data with no specified format 116 | /// @return `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))` 117 | /// unless throwing 118 | function onERC721Received(address _operator, address _from, uint256 _tokenId, bytes calldata _data) 119 | external 120 | returns (bytes4); 121 | } 122 | 123 | /// @title ERC-721 Non-Fungible Token Standard, optional metadata extension 124 | /// @dev See https://eips.ethereum.org/EIPS/eip-721 125 | /// Note: the ERC-165 identifier for this interface is 0x5b5e139f. 126 | interface IERC721Metadata is IERC721 { 127 | /// @notice A descriptive name for a collection of NFTs in this contract 128 | function name() external view returns (string memory _name); 129 | 130 | /// @notice An abbreviated name for NFTs in this contract 131 | function symbol() external view returns (string memory _symbol); 132 | 133 | /// @notice A distinct Uniform Resource Identifier (URI) for a given asset. 134 | /// @dev Throws if `_tokenId` is not a valid NFT. URIs are defined in RFC 135 | /// 3986. The URI may point to a JSON file that conforms to the "ERC721 136 | /// Metadata JSON Schema". 137 | function tokenURI(uint256 _tokenId) external view returns (string memory); 138 | } 139 | 140 | /// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension 141 | /// @dev See https://eips.ethereum.org/EIPS/eip-721 142 | /// Note: the ERC-165 identifier for this interface is 0x780e9d63. 143 | interface IERC721Enumerable is IERC721 { 144 | /// @notice Count NFTs tracked by this contract 145 | /// @return A count of valid NFTs tracked by this contract, where each one of 146 | /// them has an assigned and queryable owner not equal to the zero address 147 | function totalSupply() external view returns (uint256); 148 | 149 | /// @notice Enumerate valid NFTs 150 | /// @dev Throws if `_index` >= `totalSupply()`. 151 | /// @param _index A counter less than `totalSupply()` 152 | /// @return The token identifier for the `_index`th NFT, 153 | /// (sort order not specified) 154 | function tokenByIndex(uint256 _index) external view returns (uint256); 155 | 156 | /// @notice Enumerate NFTs assigned to an owner 157 | /// @dev Throws if `_index` >= `balanceOf(_owner)` or if 158 | /// `_owner` is the zero address, representing invalid NFTs. 159 | /// @param _owner An address where we are interested in NFTs owned by them 160 | /// @param _index A counter less than `balanceOf(_owner)` 161 | /// @return The token identifier for the `_index`th NFT assigned to `_owner`, 162 | /// (sort order not specified) 163 | function tokenOfOwnerByIndex(address _owner, uint256 _index) external view returns (uint256); 164 | } 165 | -------------------------------------------------------------------------------- /lib/forge-std/src/interfaces/IMulticall3.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | interface IMulticall3 { 7 | struct Call { 8 | address target; 9 | bytes callData; 10 | } 11 | 12 | struct Call3 { 13 | address target; 14 | bool allowFailure; 15 | bytes callData; 16 | } 17 | 18 | struct Call3Value { 19 | address target; 20 | bool allowFailure; 21 | uint256 value; 22 | bytes callData; 23 | } 24 | 25 | struct Result { 26 | bool success; 27 | bytes returnData; 28 | } 29 | 30 | function aggregate(Call[] calldata calls) 31 | external 32 | payable 33 | returns (uint256 blockNumber, bytes[] memory returnData); 34 | 35 | function aggregate3(Call3[] calldata calls) external payable returns (Result[] memory returnData); 36 | 37 | function aggregate3Value(Call3Value[] calldata calls) external payable returns (Result[] memory returnData); 38 | 39 | function blockAndAggregate(Call[] calldata calls) 40 | external 41 | payable 42 | returns (uint256 blockNumber, bytes32 blockHash, Result[] memory returnData); 43 | 44 | function getBasefee() external view returns (uint256 basefee); 45 | 46 | function getBlockHash(uint256 blockNumber) external view returns (bytes32 blockHash); 47 | 48 | function getBlockNumber() external view returns (uint256 blockNumber); 49 | 50 | function getChainId() external view returns (uint256 chainid); 51 | 52 | function getCurrentBlockCoinbase() external view returns (address coinbase); 53 | 54 | function getCurrentBlockDifficulty() external view returns (uint256 difficulty); 55 | 56 | function getCurrentBlockGasLimit() external view returns (uint256 gaslimit); 57 | 58 | function getCurrentBlockTimestamp() external view returns (uint256 timestamp); 59 | 60 | function getEthBalance(address addr) external view returns (uint256 balance); 61 | 62 | function getLastBlockHash() external view returns (bytes32 blockHash); 63 | 64 | function tryAggregate(bool requireSuccess, Call[] calldata calls) 65 | external 66 | payable 67 | returns (Result[] memory returnData); 68 | 69 | function tryBlockAndAggregate(bool requireSuccess, Call[] calldata calls) 70 | external 71 | payable 72 | returns (uint256 blockNumber, bytes32 blockHash, Result[] memory returnData); 73 | } 74 | -------------------------------------------------------------------------------- /lib/forge-std/test/StdChains.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.7.0 <0.9.0; 3 | 4 | import "../src/Test.sol"; 5 | 6 | contract StdChainsMock is Test { 7 | function exposed_getChain(string memory chainAlias) public returns (Chain memory) { 8 | return getChain(chainAlias); 9 | } 10 | 11 | function exposed_getChain(uint256 chainId) public returns (Chain memory) { 12 | return getChain(chainId); 13 | } 14 | 15 | function exposed_setChain(string memory chainAlias, ChainData memory chainData) public { 16 | setChain(chainAlias, chainData); 17 | } 18 | 19 | function exposed_setFallbackToDefaultRpcUrls(bool useDefault) public { 20 | setFallbackToDefaultRpcUrls(useDefault); 21 | } 22 | } 23 | 24 | contract StdChainsTest is Test { 25 | function test_ChainRpcInitialization() public { 26 | // RPCs specified in `foundry.toml` should be updated. 27 | assertEq(getChain(1).rpcUrl, "https://mainnet.infura.io/v3/b1d3925804e74152b316ca7da97060d3"); 28 | assertEq(getChain("optimism_goerli").rpcUrl, "https://goerli.optimism.io/"); 29 | assertEq(getChain("arbitrum_one_goerli").rpcUrl, "https://goerli-rollup.arbitrum.io/rpc/"); 30 | 31 | // Environment variables should be the next fallback 32 | assertEq(getChain("arbitrum_nova").rpcUrl, "https://nova.arbitrum.io/rpc"); 33 | vm.setEnv("ARBITRUM_NOVA_RPC_URL", "myoverride"); 34 | assertEq(getChain("arbitrum_nova").rpcUrl, "myoverride"); 35 | vm.setEnv("ARBITRUM_NOVA_RPC_URL", "https://nova.arbitrum.io/rpc"); 36 | 37 | // Cannot override RPCs defined in `foundry.toml` 38 | vm.setEnv("MAINNET_RPC_URL", "myoverride2"); 39 | assertEq(getChain("mainnet").rpcUrl, "https://mainnet.infura.io/v3/b1d3925804e74152b316ca7da97060d3"); 40 | 41 | // Other RPCs should remain unchanged. 42 | assertEq(getChain(31337).rpcUrl, "http://127.0.0.1:8545"); 43 | assertEq(getChain("sepolia").rpcUrl, "https://sepolia.infura.io/v3/b9794ad1ddf84dfb8c34d6bb5dca2001"); 44 | } 45 | 46 | function testFuzz_Rpc(string memory rpcAlias) internal { 47 | string memory rpcUrl = getChain(rpcAlias).rpcUrl; 48 | vm.createSelectFork(rpcUrl); 49 | } 50 | 51 | // Ensure we can connect to the default RPC URL for each chain. 52 | // function testRpcs() public { 53 | // testRpc("mainnet"); 54 | // testRpc("goerli"); 55 | // testRpc("sepolia"); 56 | // testRpc("optimism"); 57 | // testRpc("optimism_goerli"); 58 | // testRpc("arbitrum_one"); 59 | // testRpc("arbitrum_one_goerli"); 60 | // testRpc("arbitrum_nova"); 61 | // testRpc("polygon"); 62 | // testRpc("polygon_mumbai"); 63 | // testRpc("avalanche"); 64 | // testRpc("avalanche_fuji"); 65 | // testRpc("bnb_smart_chain"); 66 | // testRpc("bnb_smart_chain_testnet"); 67 | // testRpc("gnosis_chain"); 68 | // testRpc("moonbeam"); 69 | // testRpc("moonriver"); 70 | // testRpc("moonbase"); 71 | // testRpc("base_goerli"); 72 | // testRpc("base"); 73 | // } 74 | 75 | function test_ChainNoDefault() public { 76 | // We deploy a mock to properly test the revert. 77 | StdChainsMock stdChainsMock = new StdChainsMock(); 78 | 79 | vm.expectRevert("StdChains getChain(string): Chain with alias \"does_not_exist\" not found."); 80 | stdChainsMock.exposed_getChain("does_not_exist"); 81 | } 82 | 83 | function test_SetChainFirstFails() public { 84 | // We deploy a mock to properly test the revert. 85 | StdChainsMock stdChainsMock = new StdChainsMock(); 86 | 87 | vm.expectRevert("StdChains setChain(string,ChainData): Chain ID 31337 already used by \"anvil\"."); 88 | stdChainsMock.exposed_setChain("anvil2", ChainData("Anvil", 31337, "URL")); 89 | } 90 | 91 | function test_ChainBubbleUp() public { 92 | // We deploy a mock to properly test the revert. 93 | StdChainsMock stdChainsMock = new StdChainsMock(); 94 | 95 | stdChainsMock.exposed_setChain("needs_undefined_env_var", ChainData("", 123456789, "")); 96 | vm.expectRevert( 97 | "Failed to resolve env var `UNDEFINED_RPC_URL_PLACEHOLDER` in `${UNDEFINED_RPC_URL_PLACEHOLDER}`: environment variable not found" 98 | ); 99 | stdChainsMock.exposed_getChain("needs_undefined_env_var"); 100 | } 101 | 102 | function test_CannotSetChain_ChainIdExists() public { 103 | // We deploy a mock to properly test the revert. 104 | StdChainsMock stdChainsMock = new StdChainsMock(); 105 | 106 | stdChainsMock.exposed_setChain("custom_chain", ChainData("Custom Chain", 123456789, "https://custom.chain/")); 107 | 108 | vm.expectRevert('StdChains setChain(string,ChainData): Chain ID 123456789 already used by "custom_chain".'); 109 | 110 | stdChainsMock.exposed_setChain("another_custom_chain", ChainData("", 123456789, "")); 111 | } 112 | 113 | function test_SetChain() public { 114 | setChain("custom_chain", ChainData("Custom Chain", 123456789, "https://custom.chain/")); 115 | Chain memory customChain = getChain("custom_chain"); 116 | assertEq(customChain.name, "Custom Chain"); 117 | assertEq(customChain.chainId, 123456789); 118 | assertEq(customChain.chainAlias, "custom_chain"); 119 | assertEq(customChain.rpcUrl, "https://custom.chain/"); 120 | Chain memory chainById = getChain(123456789); 121 | assertEq(chainById.name, customChain.name); 122 | assertEq(chainById.chainId, customChain.chainId); 123 | assertEq(chainById.chainAlias, customChain.chainAlias); 124 | assertEq(chainById.rpcUrl, customChain.rpcUrl); 125 | customChain.name = "Another Custom Chain"; 126 | customChain.chainId = 987654321; 127 | setChain("another_custom_chain", customChain); 128 | Chain memory anotherCustomChain = getChain("another_custom_chain"); 129 | assertEq(anotherCustomChain.name, "Another Custom Chain"); 130 | assertEq(anotherCustomChain.chainId, 987654321); 131 | assertEq(anotherCustomChain.chainAlias, "another_custom_chain"); 132 | assertEq(anotherCustomChain.rpcUrl, "https://custom.chain/"); 133 | // Verify the first chain data was not overwritten 134 | chainById = getChain(123456789); 135 | assertEq(chainById.name, "Custom Chain"); 136 | assertEq(chainById.chainId, 123456789); 137 | } 138 | 139 | function test_SetNoEmptyAlias() public { 140 | // We deploy a mock to properly test the revert. 141 | StdChainsMock stdChainsMock = new StdChainsMock(); 142 | 143 | vm.expectRevert("StdChains setChain(string,ChainData): Chain alias cannot be the empty string."); 144 | stdChainsMock.exposed_setChain("", ChainData("", 123456789, "")); 145 | } 146 | 147 | function test_SetNoChainId0() public { 148 | // We deploy a mock to properly test the revert. 149 | StdChainsMock stdChainsMock = new StdChainsMock(); 150 | 151 | vm.expectRevert("StdChains setChain(string,ChainData): Chain ID cannot be 0."); 152 | stdChainsMock.exposed_setChain("alias", ChainData("", 0, "")); 153 | } 154 | 155 | function test_GetNoChainId0() public { 156 | // We deploy a mock to properly test the revert. 157 | StdChainsMock stdChainsMock = new StdChainsMock(); 158 | 159 | vm.expectRevert("StdChains getChain(uint256): Chain ID cannot be 0."); 160 | stdChainsMock.exposed_getChain(0); 161 | } 162 | 163 | function test_GetNoEmptyAlias() public { 164 | // We deploy a mock to properly test the revert. 165 | StdChainsMock stdChainsMock = new StdChainsMock(); 166 | 167 | vm.expectRevert("StdChains getChain(string): Chain alias cannot be the empty string."); 168 | stdChainsMock.exposed_getChain(""); 169 | } 170 | 171 | function test_ChainIdNotFound() public { 172 | // We deploy a mock to properly test the revert. 173 | StdChainsMock stdChainsMock = new StdChainsMock(); 174 | 175 | vm.expectRevert("StdChains getChain(string): Chain with alias \"no_such_alias\" not found."); 176 | stdChainsMock.exposed_getChain("no_such_alias"); 177 | } 178 | 179 | function test_ChainAliasNotFound() public { 180 | // We deploy a mock to properly test the revert. 181 | StdChainsMock stdChainsMock = new StdChainsMock(); 182 | 183 | vm.expectRevert("StdChains getChain(uint256): Chain with ID 321 not found."); 184 | 185 | stdChainsMock.exposed_getChain(321); 186 | } 187 | 188 | function test_SetChain_ExistingOne() public { 189 | // We deploy a mock to properly test the revert. 190 | StdChainsMock stdChainsMock = new StdChainsMock(); 191 | 192 | setChain("custom_chain", ChainData("Custom Chain", 123456789, "https://custom.chain/")); 193 | assertEq(getChain(123456789).chainId, 123456789); 194 | 195 | setChain("custom_chain", ChainData("Modified Chain", 999999999, "https://modified.chain/")); 196 | vm.expectRevert("StdChains getChain(uint256): Chain with ID 123456789 not found."); 197 | stdChainsMock.exposed_getChain(123456789); 198 | 199 | Chain memory modifiedChain = getChain(999999999); 200 | assertEq(modifiedChain.name, "Modified Chain"); 201 | assertEq(modifiedChain.chainId, 999999999); 202 | assertEq(modifiedChain.rpcUrl, "https://modified.chain/"); 203 | } 204 | 205 | function test_DontUseDefaultRpcUrl() public { 206 | // We deploy a mock to properly test the revert. 207 | StdChainsMock stdChainsMock = new StdChainsMock(); 208 | 209 | // Should error if default RPCs flag is set to false. 210 | stdChainsMock.exposed_setFallbackToDefaultRpcUrls(false); 211 | vm.expectRevert( 212 | "Failed to get environment variable `ANVIL_RPC_URL` as type `string`: environment variable not found" 213 | ); 214 | stdChainsMock.exposed_getChain(31337); 215 | vm.expectRevert( 216 | "Failed to get environment variable `SEPOLIA_RPC_URL` as type `string`: environment variable not found" 217 | ); 218 | stdChainsMock.exposed_getChain("sepolia"); 219 | } 220 | } 221 | -------------------------------------------------------------------------------- /lib/forge-std/test/StdError.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.8.0 <0.9.0; 3 | 4 | import "../src/StdError.sol"; 5 | import "../src/Test.sol"; 6 | 7 | contract StdErrorsTest is Test { 8 | ErrorsTest test; 9 | 10 | function setUp() public { 11 | test = new ErrorsTest(); 12 | } 13 | 14 | function test_ExpectAssertion() public { 15 | vm.expectRevert(stdError.assertionError); 16 | test.assertionError(); 17 | } 18 | 19 | function test_ExpectArithmetic() public { 20 | vm.expectRevert(stdError.arithmeticError); 21 | test.arithmeticError(10); 22 | } 23 | 24 | function test_ExpectDiv() public { 25 | vm.expectRevert(stdError.divisionError); 26 | test.divError(0); 27 | } 28 | 29 | function test_ExpectMod() public { 30 | vm.expectRevert(stdError.divisionError); 31 | test.modError(0); 32 | } 33 | 34 | function test_ExpectEnum() public { 35 | vm.expectRevert(stdError.enumConversionError); 36 | test.enumConversion(1); 37 | } 38 | 39 | function test_ExpectEncodeStg() public { 40 | vm.expectRevert(stdError.encodeStorageError); 41 | test.encodeStgError(); 42 | } 43 | 44 | function test_ExpectPop() public { 45 | vm.expectRevert(stdError.popError); 46 | test.pop(); 47 | } 48 | 49 | function test_ExpectOOB() public { 50 | vm.expectRevert(stdError.indexOOBError); 51 | test.indexOOBError(1); 52 | } 53 | 54 | function test_ExpectMem() public { 55 | vm.expectRevert(stdError.memOverflowError); 56 | test.mem(); 57 | } 58 | 59 | function test_ExpectIntern() public { 60 | vm.expectRevert(stdError.zeroVarError); 61 | test.intern(); 62 | } 63 | } 64 | 65 | contract ErrorsTest { 66 | enum T {T1} 67 | 68 | uint256[] public someArr; 69 | bytes someBytes; 70 | 71 | function assertionError() public pure { 72 | assert(false); 73 | } 74 | 75 | function arithmeticError(uint256 a) public pure { 76 | a -= 100; 77 | } 78 | 79 | function divError(uint256 a) public pure { 80 | 100 / a; 81 | } 82 | 83 | function modError(uint256 a) public pure { 84 | 100 % a; 85 | } 86 | 87 | function enumConversion(uint256 a) public pure { 88 | T(a); 89 | } 90 | 91 | function encodeStgError() public { 92 | /// @solidity memory-safe-assembly 93 | assembly { 94 | sstore(someBytes.slot, 1) 95 | } 96 | keccak256(someBytes); 97 | } 98 | 99 | function pop() public { 100 | someArr.pop(); 101 | } 102 | 103 | function indexOOBError(uint256 a) public pure { 104 | uint256[] memory t = new uint256[](0); 105 | t[a]; 106 | } 107 | 108 | function mem() public pure { 109 | uint256 l = 2 ** 256 / 32; 110 | new uint256[](l); 111 | } 112 | 113 | function intern() public returns (uint256) { 114 | function(uint256) internal returns (uint256) x; 115 | x(2); 116 | return 7; 117 | } 118 | } 119 | -------------------------------------------------------------------------------- /lib/forge-std/test/StdMath.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.8.0 <0.9.0; 3 | 4 | import "../src/StdMath.sol"; 5 | import "../src/Test.sol"; 6 | 7 | contract StdMathMock is Test { 8 | function exposed_percentDelta(uint256 a, uint256 b) public pure returns (uint256) { 9 | return stdMath.percentDelta(a, b); 10 | } 11 | 12 | function exposed_percentDelta(int256 a, int256 b) public pure returns (uint256) { 13 | return stdMath.percentDelta(a, b); 14 | } 15 | } 16 | 17 | contract StdMathTest is Test { 18 | function test_GetAbs() external { 19 | assertEq(stdMath.abs(-50), 50); 20 | assertEq(stdMath.abs(50), 50); 21 | assertEq(stdMath.abs(-1337), 1337); 22 | assertEq(stdMath.abs(0), 0); 23 | 24 | assertEq(stdMath.abs(type(int256).min), (type(uint256).max >> 1) + 1); 25 | assertEq(stdMath.abs(type(int256).max), (type(uint256).max >> 1)); 26 | } 27 | 28 | function testFuzz_GetAbs(int256 a) external { 29 | uint256 manualAbs = getAbs(a); 30 | 31 | uint256 abs = stdMath.abs(a); 32 | 33 | assertEq(abs, manualAbs); 34 | } 35 | 36 | function test_GetDelta_Uint() external { 37 | assertEq(stdMath.delta(uint256(0), uint256(0)), 0); 38 | assertEq(stdMath.delta(uint256(0), uint256(1337)), 1337); 39 | assertEq(stdMath.delta(uint256(0), type(uint64).max), type(uint64).max); 40 | assertEq(stdMath.delta(uint256(0), type(uint128).max), type(uint128).max); 41 | assertEq(stdMath.delta(uint256(0), type(uint256).max), type(uint256).max); 42 | 43 | assertEq(stdMath.delta(0, uint256(0)), 0); 44 | assertEq(stdMath.delta(1337, uint256(0)), 1337); 45 | assertEq(stdMath.delta(type(uint64).max, uint256(0)), type(uint64).max); 46 | assertEq(stdMath.delta(type(uint128).max, uint256(0)), type(uint128).max); 47 | assertEq(stdMath.delta(type(uint256).max, uint256(0)), type(uint256).max); 48 | 49 | assertEq(stdMath.delta(1337, uint256(1337)), 0); 50 | assertEq(stdMath.delta(type(uint256).max, type(uint256).max), 0); 51 | assertEq(stdMath.delta(5000, uint256(1250)), 3750); 52 | } 53 | 54 | function testFuzz_GetDelta_Uint(uint256 a, uint256 b) external { 55 | uint256 manualDelta; 56 | if (a > b) { 57 | manualDelta = a - b; 58 | } else { 59 | manualDelta = b - a; 60 | } 61 | 62 | uint256 delta = stdMath.delta(a, b); 63 | 64 | assertEq(delta, manualDelta); 65 | } 66 | 67 | function test_GetDelta_Int() external { 68 | assertEq(stdMath.delta(int256(0), int256(0)), 0); 69 | assertEq(stdMath.delta(int256(0), int256(1337)), 1337); 70 | assertEq(stdMath.delta(int256(0), type(int64).max), type(uint64).max >> 1); 71 | assertEq(stdMath.delta(int256(0), type(int128).max), type(uint128).max >> 1); 72 | assertEq(stdMath.delta(int256(0), type(int256).max), type(uint256).max >> 1); 73 | 74 | assertEq(stdMath.delta(0, int256(0)), 0); 75 | assertEq(stdMath.delta(1337, int256(0)), 1337); 76 | assertEq(stdMath.delta(type(int64).max, int256(0)), type(uint64).max >> 1); 77 | assertEq(stdMath.delta(type(int128).max, int256(0)), type(uint128).max >> 1); 78 | assertEq(stdMath.delta(type(int256).max, int256(0)), type(uint256).max >> 1); 79 | 80 | assertEq(stdMath.delta(-0, int256(0)), 0); 81 | assertEq(stdMath.delta(-1337, int256(0)), 1337); 82 | assertEq(stdMath.delta(type(int64).min, int256(0)), (type(uint64).max >> 1) + 1); 83 | assertEq(stdMath.delta(type(int128).min, int256(0)), (type(uint128).max >> 1) + 1); 84 | assertEq(stdMath.delta(type(int256).min, int256(0)), (type(uint256).max >> 1) + 1); 85 | 86 | assertEq(stdMath.delta(int256(0), -0), 0); 87 | assertEq(stdMath.delta(int256(0), -1337), 1337); 88 | assertEq(stdMath.delta(int256(0), type(int64).min), (type(uint64).max >> 1) + 1); 89 | assertEq(stdMath.delta(int256(0), type(int128).min), (type(uint128).max >> 1) + 1); 90 | assertEq(stdMath.delta(int256(0), type(int256).min), (type(uint256).max >> 1) + 1); 91 | 92 | assertEq(stdMath.delta(1337, int256(1337)), 0); 93 | assertEq(stdMath.delta(type(int256).max, type(int256).max), 0); 94 | assertEq(stdMath.delta(type(int256).min, type(int256).min), 0); 95 | assertEq(stdMath.delta(type(int256).min, type(int256).max), type(uint256).max); 96 | assertEq(stdMath.delta(5000, int256(1250)), 3750); 97 | } 98 | 99 | function testFuzz_GetDelta_Int(int256 a, int256 b) external { 100 | uint256 absA = getAbs(a); 101 | uint256 absB = getAbs(b); 102 | uint256 absDelta = absA > absB ? absA - absB : absB - absA; 103 | 104 | uint256 manualDelta; 105 | if ((a >= 0 && b >= 0) || (a < 0 && b < 0)) { 106 | manualDelta = absDelta; 107 | } 108 | // (a < 0 && b >= 0) || (a >= 0 && b < 0) 109 | else { 110 | manualDelta = absA + absB; 111 | } 112 | 113 | uint256 delta = stdMath.delta(a, b); 114 | 115 | assertEq(delta, manualDelta); 116 | } 117 | 118 | function test_GetPercentDelta_Uint() external { 119 | StdMathMock stdMathMock = new StdMathMock(); 120 | 121 | assertEq(stdMath.percentDelta(uint256(0), uint256(1337)), 1e18); 122 | assertEq(stdMath.percentDelta(uint256(0), type(uint64).max), 1e18); 123 | assertEq(stdMath.percentDelta(uint256(0), type(uint128).max), 1e18); 124 | assertEq(stdMath.percentDelta(uint256(0), type(uint192).max), 1e18); 125 | 126 | assertEq(stdMath.percentDelta(1337, uint256(1337)), 0); 127 | assertEq(stdMath.percentDelta(type(uint192).max, type(uint192).max), 0); 128 | assertEq(stdMath.percentDelta(0, uint256(2500)), 1e18); 129 | assertEq(stdMath.percentDelta(2500, uint256(2500)), 0); 130 | assertEq(stdMath.percentDelta(5000, uint256(2500)), 1e18); 131 | assertEq(stdMath.percentDelta(7500, uint256(2500)), 2e18); 132 | 133 | vm.expectRevert(stdError.divisionError); 134 | stdMathMock.exposed_percentDelta(uint256(1), 0); 135 | } 136 | 137 | function testFuzz_GetPercentDelta_Uint(uint192 a, uint192 b) external { 138 | vm.assume(b != 0); 139 | uint256 manualDelta; 140 | if (a > b) { 141 | manualDelta = a - b; 142 | } else { 143 | manualDelta = b - a; 144 | } 145 | 146 | uint256 manualPercentDelta = manualDelta * 1e18 / b; 147 | uint256 percentDelta = stdMath.percentDelta(a, b); 148 | 149 | assertEq(percentDelta, manualPercentDelta); 150 | } 151 | 152 | function test_GetPercentDelta_Int() external { 153 | // We deploy a mock version so we can properly test the revert. 154 | StdMathMock stdMathMock = new StdMathMock(); 155 | 156 | assertEq(stdMath.percentDelta(int256(0), int256(1337)), 1e18); 157 | assertEq(stdMath.percentDelta(int256(0), -1337), 1e18); 158 | assertEq(stdMath.percentDelta(int256(0), type(int64).min), 1e18); 159 | assertEq(stdMath.percentDelta(int256(0), type(int128).min), 1e18); 160 | assertEq(stdMath.percentDelta(int256(0), type(int192).min), 1e18); 161 | assertEq(stdMath.percentDelta(int256(0), type(int64).max), 1e18); 162 | assertEq(stdMath.percentDelta(int256(0), type(int128).max), 1e18); 163 | assertEq(stdMath.percentDelta(int256(0), type(int192).max), 1e18); 164 | 165 | assertEq(stdMath.percentDelta(1337, int256(1337)), 0); 166 | assertEq(stdMath.percentDelta(type(int192).max, type(int192).max), 0); 167 | assertEq(stdMath.percentDelta(type(int192).min, type(int192).min), 0); 168 | 169 | assertEq(stdMath.percentDelta(type(int192).min, type(int192).max), 2e18); // rounds the 1 wei diff down 170 | assertEq(stdMath.percentDelta(type(int192).max, type(int192).min), 2e18 - 1); // rounds the 1 wei diff down 171 | assertEq(stdMath.percentDelta(0, int256(2500)), 1e18); 172 | assertEq(stdMath.percentDelta(2500, int256(2500)), 0); 173 | assertEq(stdMath.percentDelta(5000, int256(2500)), 1e18); 174 | assertEq(stdMath.percentDelta(7500, int256(2500)), 2e18); 175 | 176 | vm.expectRevert(stdError.divisionError); 177 | stdMathMock.exposed_percentDelta(int256(1), 0); 178 | } 179 | 180 | function testFuzz_GetPercentDelta_Int(int192 a, int192 b) external { 181 | vm.assume(b != 0); 182 | uint256 absA = getAbs(a); 183 | uint256 absB = getAbs(b); 184 | uint256 absDelta = absA > absB ? absA - absB : absB - absA; 185 | 186 | uint256 manualDelta; 187 | if ((a >= 0 && b >= 0) || (a < 0 && b < 0)) { 188 | manualDelta = absDelta; 189 | } 190 | // (a < 0 && b >= 0) || (a >= 0 && b < 0) 191 | else { 192 | manualDelta = absA + absB; 193 | } 194 | 195 | uint256 manualPercentDelta = manualDelta * 1e18 / absB; 196 | uint256 percentDelta = stdMath.percentDelta(a, b); 197 | 198 | assertEq(percentDelta, manualPercentDelta); 199 | } 200 | 201 | /*////////////////////////////////////////////////////////////////////////// 202 | HELPERS 203 | //////////////////////////////////////////////////////////////////////////*/ 204 | 205 | function getAbs(int256 a) private pure returns (uint256) { 206 | if (a < 0) { 207 | return a == type(int256).min ? uint256(type(int256).max) + 1 : uint256(-a); 208 | } 209 | 210 | return uint256(a); 211 | } 212 | } 213 | -------------------------------------------------------------------------------- /lib/forge-std/test/StdStorage.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.7.0 <0.9.0; 3 | 4 | import "../src/StdStorage.sol"; 5 | import "../src/Test.sol"; 6 | 7 | contract StdStorageTest is Test { 8 | using stdStorage for StdStorage; 9 | 10 | StorageTest internal test; 11 | 12 | function setUp() public { 13 | test = new StorageTest(); 14 | } 15 | 16 | function test_StorageHidden() public { 17 | assertEq(uint256(keccak256("my.random.var")), stdstore.target(address(test)).sig("hidden()").find()); 18 | } 19 | 20 | function test_StorageObvious() public { 21 | assertEq(uint256(0), stdstore.target(address(test)).sig("exists()").find()); 22 | } 23 | 24 | function test_StorageExtraSload() public { 25 | assertEq(16, stdstore.target(address(test)).sig(test.extra_sload.selector).find()); 26 | } 27 | 28 | function test_StorageCheckedWriteHidden() public { 29 | stdstore.target(address(test)).sig(test.hidden.selector).checked_write(100); 30 | assertEq(uint256(test.hidden()), 100); 31 | } 32 | 33 | function test_StorageCheckedWriteObvious() public { 34 | stdstore.target(address(test)).sig(test.exists.selector).checked_write(100); 35 | assertEq(test.exists(), 100); 36 | } 37 | 38 | function test_StorageCheckedWriteSignedIntegerHidden() public { 39 | stdstore.target(address(test)).sig(test.hidden.selector).checked_write_int(-100); 40 | assertEq(int256(uint256(test.hidden())), -100); 41 | } 42 | 43 | function test_StorageCheckedWriteSignedIntegerObvious() public { 44 | stdstore.target(address(test)).sig(test.tG.selector).checked_write_int(-100); 45 | assertEq(test.tG(), -100); 46 | } 47 | 48 | function test_StorageMapStructA() public { 49 | uint256 slot = 50 | stdstore.target(address(test)).sig(test.map_struct.selector).with_key(address(this)).depth(0).find(); 51 | assertEq(uint256(keccak256(abi.encode(address(this), 4))), slot); 52 | } 53 | 54 | function test_StorageMapStructB() public { 55 | uint256 slot = 56 | stdstore.target(address(test)).sig(test.map_struct.selector).with_key(address(this)).depth(1).find(); 57 | assertEq(uint256(keccak256(abi.encode(address(this), 4))) + 1, slot); 58 | } 59 | 60 | function test_StorageDeepMap() public { 61 | uint256 slot = stdstore.target(address(test)).sig(test.deep_map.selector).with_key(address(this)).with_key( 62 | address(this) 63 | ).find(); 64 | assertEq(uint256(keccak256(abi.encode(address(this), keccak256(abi.encode(address(this), uint256(5)))))), slot); 65 | } 66 | 67 | function test_StorageCheckedWriteDeepMap() public { 68 | stdstore.target(address(test)).sig(test.deep_map.selector).with_key(address(this)).with_key(address(this)) 69 | .checked_write(100); 70 | assertEq(100, test.deep_map(address(this), address(this))); 71 | } 72 | 73 | function test_StorageDeepMapStructA() public { 74 | uint256 slot = stdstore.target(address(test)).sig(test.deep_map_struct.selector).with_key(address(this)) 75 | .with_key(address(this)).depth(0).find(); 76 | assertEq( 77 | bytes32(uint256(keccak256(abi.encode(address(this), keccak256(abi.encode(address(this), uint256(6)))))) + 0), 78 | bytes32(slot) 79 | ); 80 | } 81 | 82 | function test_StorageDeepMapStructB() public { 83 | uint256 slot = stdstore.target(address(test)).sig(test.deep_map_struct.selector).with_key(address(this)) 84 | .with_key(address(this)).depth(1).find(); 85 | assertEq( 86 | bytes32(uint256(keccak256(abi.encode(address(this), keccak256(abi.encode(address(this), uint256(6)))))) + 1), 87 | bytes32(slot) 88 | ); 89 | } 90 | 91 | function test_StorageCheckedWriteDeepMapStructA() public { 92 | stdstore.target(address(test)).sig(test.deep_map_struct.selector).with_key(address(this)).with_key( 93 | address(this) 94 | ).depth(0).checked_write(100); 95 | (uint256 a, uint256 b) = test.deep_map_struct(address(this), address(this)); 96 | assertEq(100, a); 97 | assertEq(0, b); 98 | } 99 | 100 | function test_StorageCheckedWriteDeepMapStructB() public { 101 | stdstore.target(address(test)).sig(test.deep_map_struct.selector).with_key(address(this)).with_key( 102 | address(this) 103 | ).depth(1).checked_write(100); 104 | (uint256 a, uint256 b) = test.deep_map_struct(address(this), address(this)); 105 | assertEq(0, a); 106 | assertEq(100, b); 107 | } 108 | 109 | function test_StorageCheckedWriteMapStructA() public { 110 | stdstore.target(address(test)).sig(test.map_struct.selector).with_key(address(this)).depth(0).checked_write(100); 111 | (uint256 a, uint256 b) = test.map_struct(address(this)); 112 | assertEq(a, 100); 113 | assertEq(b, 0); 114 | } 115 | 116 | function test_StorageCheckedWriteMapStructB() public { 117 | stdstore.target(address(test)).sig(test.map_struct.selector).with_key(address(this)).depth(1).checked_write(100); 118 | (uint256 a, uint256 b) = test.map_struct(address(this)); 119 | assertEq(a, 0); 120 | assertEq(b, 100); 121 | } 122 | 123 | function test_StorageStructA() public { 124 | uint256 slot = stdstore.target(address(test)).sig(test.basic.selector).depth(0).find(); 125 | assertEq(uint256(7), slot); 126 | } 127 | 128 | function test_StorageStructB() public { 129 | uint256 slot = stdstore.target(address(test)).sig(test.basic.selector).depth(1).find(); 130 | assertEq(uint256(7) + 1, slot); 131 | } 132 | 133 | function test_StorageCheckedWriteStructA() public { 134 | stdstore.target(address(test)).sig(test.basic.selector).depth(0).checked_write(100); 135 | (uint256 a, uint256 b) = test.basic(); 136 | assertEq(a, 100); 137 | assertEq(b, 1337); 138 | } 139 | 140 | function test_StorageCheckedWriteStructB() public { 141 | stdstore.target(address(test)).sig(test.basic.selector).depth(1).checked_write(100); 142 | (uint256 a, uint256 b) = test.basic(); 143 | assertEq(a, 1337); 144 | assertEq(b, 100); 145 | } 146 | 147 | function test_StorageMapAddrFound() public { 148 | uint256 slot = stdstore.target(address(test)).sig(test.map_addr.selector).with_key(address(this)).find(); 149 | assertEq(uint256(keccak256(abi.encode(address(this), uint256(1)))), slot); 150 | } 151 | 152 | function test_StorageMapAddrRoot() public { 153 | (uint256 slot, bytes32 key) = 154 | stdstore.target(address(test)).sig(test.map_addr.selector).with_key(address(this)).parent(); 155 | assertEq(address(uint160(uint256(key))), address(this)); 156 | assertEq(uint256(1), slot); 157 | slot = stdstore.target(address(test)).sig(test.map_addr.selector).with_key(address(this)).root(); 158 | assertEq(uint256(1), slot); 159 | } 160 | 161 | function test_StorageMapUintFound() public { 162 | uint256 slot = stdstore.target(address(test)).sig(test.map_uint.selector).with_key(100).find(); 163 | assertEq(uint256(keccak256(abi.encode(100, uint256(2)))), slot); 164 | } 165 | 166 | function test_StorageCheckedWriteMapUint() public { 167 | stdstore.target(address(test)).sig(test.map_uint.selector).with_key(100).checked_write(100); 168 | assertEq(100, test.map_uint(100)); 169 | } 170 | 171 | function test_StorageCheckedWriteMapAddr() public { 172 | stdstore.target(address(test)).sig(test.map_addr.selector).with_key(address(this)).checked_write(100); 173 | assertEq(100, test.map_addr(address(this))); 174 | } 175 | 176 | function test_StorageCheckedWriteMapBool() public { 177 | stdstore.target(address(test)).sig(test.map_bool.selector).with_key(address(this)).checked_write(true); 178 | assertTrue(test.map_bool(address(this))); 179 | } 180 | 181 | function testFail_StorageCheckedWriteMapPacked() public { 182 | // expect PackedSlot error but not external call so cant expectRevert 183 | stdstore.target(address(test)).sig(test.read_struct_lower.selector).with_key(address(uint160(1337))) 184 | .checked_write(100); 185 | } 186 | 187 | function test_StorageCheckedWriteMapPackedSuccess() public { 188 | uint256 full = test.map_packed(address(1337)); 189 | // keep upper 128, set lower 128 to 1337 190 | full = (full & (uint256((1 << 128) - 1) << 128)) | 1337; 191 | stdstore.target(address(test)).sig(test.map_packed.selector).with_key(address(uint160(1337))).checked_write( 192 | full 193 | ); 194 | assertEq(1337, test.read_struct_lower(address(1337))); 195 | } 196 | 197 | function testFail_StorageConst() public { 198 | // vm.expectRevert(abi.encodeWithSignature("NotStorage(bytes4)", bytes4(keccak256("const()")))); 199 | stdstore.target(address(test)).sig("const()").find(); 200 | } 201 | 202 | function testFail_StorageNativePack() public { 203 | stdstore.target(address(test)).sig(test.tA.selector).find(); 204 | stdstore.target(address(test)).sig(test.tB.selector).find(); 205 | 206 | // these both would fail 207 | stdstore.target(address(test)).sig(test.tC.selector).find(); 208 | stdstore.target(address(test)).sig(test.tD.selector).find(); 209 | } 210 | 211 | function test_StorageReadBytes32() public { 212 | bytes32 val = stdstore.target(address(test)).sig(test.tE.selector).read_bytes32(); 213 | assertEq(val, hex"1337"); 214 | } 215 | 216 | function test_StorageReadBool_False() public { 217 | bool val = stdstore.target(address(test)).sig(test.tB.selector).read_bool(); 218 | assertEq(val, false); 219 | } 220 | 221 | function test_StorageReadBool_True() public { 222 | bool val = stdstore.target(address(test)).sig(test.tH.selector).read_bool(); 223 | assertEq(val, true); 224 | } 225 | 226 | function test_StorageReadBool_Revert() public { 227 | vm.expectRevert("stdStorage read_bool(StdStorage): Cannot decode. Make sure you are reading a bool."); 228 | this.readNonBoolValue(); 229 | } 230 | 231 | function readNonBoolValue() public { 232 | stdstore.target(address(test)).sig(test.tE.selector).read_bool(); 233 | } 234 | 235 | function test_StorageReadAddress() public { 236 | address val = stdstore.target(address(test)).sig(test.tF.selector).read_address(); 237 | assertEq(val, address(1337)); 238 | } 239 | 240 | function test_StorageReadUint() public { 241 | uint256 val = stdstore.target(address(test)).sig(test.exists.selector).read_uint(); 242 | assertEq(val, 1); 243 | } 244 | 245 | function test_StorageReadInt() public { 246 | int256 val = stdstore.target(address(test)).sig(test.tG.selector).read_int(); 247 | assertEq(val, type(int256).min); 248 | } 249 | } 250 | 251 | contract StorageTest { 252 | uint256 public exists = 1; 253 | mapping(address => uint256) public map_addr; 254 | mapping(uint256 => uint256) public map_uint; 255 | mapping(address => uint256) public map_packed; 256 | mapping(address => UnpackedStruct) public map_struct; 257 | mapping(address => mapping(address => uint256)) public deep_map; 258 | mapping(address => mapping(address => UnpackedStruct)) public deep_map_struct; 259 | UnpackedStruct public basic; 260 | 261 | uint248 public tA; 262 | bool public tB; 263 | 264 | bool public tC = false; 265 | uint248 public tD = 1; 266 | 267 | struct UnpackedStruct { 268 | uint256 a; 269 | uint256 b; 270 | } 271 | 272 | mapping(address => bool) public map_bool; 273 | 274 | bytes32 public tE = hex"1337"; 275 | address public tF = address(1337); 276 | int256 public tG = type(int256).min; 277 | bool public tH = true; 278 | bytes32 private tI = ~bytes32(hex"1337"); 279 | 280 | constructor() { 281 | basic = UnpackedStruct({a: 1337, b: 1337}); 282 | 283 | uint256 two = (1 << 128) | 1; 284 | map_packed[msg.sender] = two; 285 | map_packed[address(uint160(1337))] = 1 << 128; 286 | } 287 | 288 | function read_struct_upper(address who) public view returns (uint256) { 289 | return map_packed[who] >> 128; 290 | } 291 | 292 | function read_struct_lower(address who) public view returns (uint256) { 293 | return map_packed[who] & ((1 << 128) - 1); 294 | } 295 | 296 | function hidden() public view returns (bytes32 t) { 297 | bytes32 slot = keccak256("my.random.var"); 298 | /// @solidity memory-safe-assembly 299 | assembly { 300 | t := sload(slot) 301 | } 302 | } 303 | 304 | function const() public pure returns (bytes32 t) { 305 | t = bytes32(hex"1337"); 306 | } 307 | 308 | function extra_sload() public view returns (bytes32 t) { 309 | // trigger read on slot `tE`, and make a staticcall to make sure compiler doesn't optimize this SLOAD away 310 | assembly { 311 | pop(staticcall(gas(), sload(tE.slot), 0, 0, 0, 0)) 312 | } 313 | t = tI; 314 | } 315 | } 316 | -------------------------------------------------------------------------------- /lib/forge-std/test/StdStyle.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.7.0 <0.9.0; 3 | 4 | import "../src/Test.sol"; 5 | 6 | contract StdStyleTest is Test { 7 | function test_StyleColor() public pure { 8 | console2.log(StdStyle.red("StdStyle.red String Test")); 9 | console2.log(StdStyle.red(uint256(10e18))); 10 | console2.log(StdStyle.red(int256(-10e18))); 11 | console2.log(StdStyle.red(true)); 12 | console2.log(StdStyle.red(address(0))); 13 | console2.log(StdStyle.redBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 14 | console2.log(StdStyle.redBytes32("StdStyle.redBytes32")); 15 | console2.log(StdStyle.green("StdStyle.green String Test")); 16 | console2.log(StdStyle.green(uint256(10e18))); 17 | console2.log(StdStyle.green(int256(-10e18))); 18 | console2.log(StdStyle.green(true)); 19 | console2.log(StdStyle.green(address(0))); 20 | console2.log(StdStyle.greenBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 21 | console2.log(StdStyle.greenBytes32("StdStyle.greenBytes32")); 22 | console2.log(StdStyle.yellow("StdStyle.yellow String Test")); 23 | console2.log(StdStyle.yellow(uint256(10e18))); 24 | console2.log(StdStyle.yellow(int256(-10e18))); 25 | console2.log(StdStyle.yellow(true)); 26 | console2.log(StdStyle.yellow(address(0))); 27 | console2.log(StdStyle.yellowBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 28 | console2.log(StdStyle.yellowBytes32("StdStyle.yellowBytes32")); 29 | console2.log(StdStyle.blue("StdStyle.blue String Test")); 30 | console2.log(StdStyle.blue(uint256(10e18))); 31 | console2.log(StdStyle.blue(int256(-10e18))); 32 | console2.log(StdStyle.blue(true)); 33 | console2.log(StdStyle.blue(address(0))); 34 | console2.log(StdStyle.blueBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 35 | console2.log(StdStyle.blueBytes32("StdStyle.blueBytes32")); 36 | console2.log(StdStyle.magenta("StdStyle.magenta String Test")); 37 | console2.log(StdStyle.magenta(uint256(10e18))); 38 | console2.log(StdStyle.magenta(int256(-10e18))); 39 | console2.log(StdStyle.magenta(true)); 40 | console2.log(StdStyle.magenta(address(0))); 41 | console2.log(StdStyle.magentaBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 42 | console2.log(StdStyle.magentaBytes32("StdStyle.magentaBytes32")); 43 | console2.log(StdStyle.cyan("StdStyle.cyan String Test")); 44 | console2.log(StdStyle.cyan(uint256(10e18))); 45 | console2.log(StdStyle.cyan(int256(-10e18))); 46 | console2.log(StdStyle.cyan(true)); 47 | console2.log(StdStyle.cyan(address(0))); 48 | console2.log(StdStyle.cyanBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 49 | console2.log(StdStyle.cyanBytes32("StdStyle.cyanBytes32")); 50 | } 51 | 52 | function test_StyleFontWeight() public pure { 53 | console2.log(StdStyle.bold("StdStyle.bold String Test")); 54 | console2.log(StdStyle.bold(uint256(10e18))); 55 | console2.log(StdStyle.bold(int256(-10e18))); 56 | console2.log(StdStyle.bold(address(0))); 57 | console2.log(StdStyle.bold(true)); 58 | console2.log(StdStyle.boldBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 59 | console2.log(StdStyle.boldBytes32("StdStyle.boldBytes32")); 60 | console2.log(StdStyle.dim("StdStyle.dim String Test")); 61 | console2.log(StdStyle.dim(uint256(10e18))); 62 | console2.log(StdStyle.dim(int256(-10e18))); 63 | console2.log(StdStyle.dim(address(0))); 64 | console2.log(StdStyle.dim(true)); 65 | console2.log(StdStyle.dimBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 66 | console2.log(StdStyle.dimBytes32("StdStyle.dimBytes32")); 67 | console2.log(StdStyle.italic("StdStyle.italic String Test")); 68 | console2.log(StdStyle.italic(uint256(10e18))); 69 | console2.log(StdStyle.italic(int256(-10e18))); 70 | console2.log(StdStyle.italic(address(0))); 71 | console2.log(StdStyle.italic(true)); 72 | console2.log(StdStyle.italicBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 73 | console2.log(StdStyle.italicBytes32("StdStyle.italicBytes32")); 74 | console2.log(StdStyle.underline("StdStyle.underline String Test")); 75 | console2.log(StdStyle.underline(uint256(10e18))); 76 | console2.log(StdStyle.underline(int256(-10e18))); 77 | console2.log(StdStyle.underline(address(0))); 78 | console2.log(StdStyle.underline(true)); 79 | console2.log(StdStyle.underlineBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 80 | console2.log(StdStyle.underlineBytes32("StdStyle.underlineBytes32")); 81 | console2.log(StdStyle.inverse("StdStyle.inverse String Test")); 82 | console2.log(StdStyle.inverse(uint256(10e18))); 83 | console2.log(StdStyle.inverse(int256(-10e18))); 84 | console2.log(StdStyle.inverse(address(0))); 85 | console2.log(StdStyle.inverse(true)); 86 | console2.log(StdStyle.inverseBytes(hex"7109709ECfa91a80626fF3989D68f67F5b1DD12D")); 87 | console2.log(StdStyle.inverseBytes32("StdStyle.inverseBytes32")); 88 | } 89 | 90 | function test_StyleCombined() public pure { 91 | console2.log(StdStyle.red(StdStyle.bold("Red Bold String Test"))); 92 | console2.log(StdStyle.green(StdStyle.dim(uint256(10e18)))); 93 | console2.log(StdStyle.yellow(StdStyle.italic(int256(-10e18)))); 94 | console2.log(StdStyle.blue(StdStyle.underline(address(0)))); 95 | console2.log(StdStyle.magenta(StdStyle.inverse(true))); 96 | } 97 | 98 | function test_StyleCustom() public pure { 99 | console2.log(h1("Custom Style 1")); 100 | console2.log(h2("Custom Style 2")); 101 | } 102 | 103 | function h1(string memory a) private pure returns (string memory) { 104 | return StdStyle.cyan(StdStyle.inverse(StdStyle.bold(a))); 105 | } 106 | 107 | function h2(string memory a) private pure returns (string memory) { 108 | return StdStyle.magenta(StdStyle.bold(StdStyle.underline(a))); 109 | } 110 | } 111 | -------------------------------------------------------------------------------- /lib/forge-std/test/compilation/CompilationScript.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | import "../../src/Script.sol"; 7 | 8 | // The purpose of this contract is to benchmark compilation time to avoid accidentally introducing 9 | // a change that results in very long compilation times with via-ir. See https://github.com/foundry-rs/forge-std/issues/207 10 | contract CompilationScript is Script {} 11 | -------------------------------------------------------------------------------- /lib/forge-std/test/compilation/CompilationScriptBase.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | import "../../src/Script.sol"; 7 | 8 | // The purpose of this contract is to benchmark compilation time to avoid accidentally introducing 9 | // a change that results in very long compilation times with via-ir. See https://github.com/foundry-rs/forge-std/issues/207 10 | contract CompilationScriptBase is ScriptBase {} 11 | -------------------------------------------------------------------------------- /lib/forge-std/test/compilation/CompilationTest.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | import "../../src/Test.sol"; 7 | 8 | // The purpose of this contract is to benchmark compilation time to avoid accidentally introducing 9 | // a change that results in very long compilation times with via-ir. See https://github.com/foundry-rs/forge-std/issues/207 10 | contract CompilationTest is Test {} 11 | -------------------------------------------------------------------------------- /lib/forge-std/test/compilation/CompilationTestBase.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity >=0.6.2 <0.9.0; 3 | 4 | pragma experimental ABIEncoderV2; 5 | 6 | import "../../src/Test.sol"; 7 | 8 | // The purpose of this contract is to benchmark compilation time to avoid accidentally introducing 9 | // a change that results in very long compilation times with via-ir. See https://github.com/foundry-rs/forge-std/issues/207 10 | contract CompilationTestBase is TestBase {} 11 | -------------------------------------------------------------------------------- /lib/forge-std/test/fixtures/broadcast.log.json: -------------------------------------------------------------------------------- 1 | { 2 | "transactions": [ 3 | { 4 | "hash": "0xc6006863c267735a11476b7f15b15bc718e117e2da114a2be815dd651e1a509f", 5 | "type": "CALL", 6 | "contractName": "Test", 7 | "contractAddress": "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512", 8 | "function": "multiple_arguments(uint256,address,uint256[]):(uint256)", 9 | "arguments": ["1", "0000000000000000000000000000000000001337", "[3,4]"], 10 | "tx": { 11 | "type": "0x02", 12 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 13 | "to": "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512", 14 | "gas": "0x73b9", 15 | "value": "0x0", 16 | "data": "0x23e99187000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000013370000000000000000000000000000000000000000000000000000000000000060000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000030000000000000000000000000000000000000000000000000000000000000004", 17 | "nonce": "0x3", 18 | "accessList": [] 19 | } 20 | }, 21 | { 22 | "hash": "0xedf2b38d8d896519a947a1acf720f859bb35c0c5ecb8dd7511995b67b9853298", 23 | "type": "CALL", 24 | "contractName": "Test", 25 | "contractAddress": "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512", 26 | "function": "inc():(uint256)", 27 | "arguments": [], 28 | "tx": { 29 | "type": "0x02", 30 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 31 | "to": "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512", 32 | "gas": "0xdcb2", 33 | "value": "0x0", 34 | "data": "0x371303c0", 35 | "nonce": "0x4", 36 | "accessList": [] 37 | } 38 | }, 39 | { 40 | "hash": "0xa57e8e3981a6c861442e46c9471bd19cb3e21f9a8a6c63a72e7b5c47c6675a7c", 41 | "type": "CALL", 42 | "contractName": "Test", 43 | "contractAddress": "0x7c6b4bbe207d642d98d5c537142d85209e585087", 44 | "function": "t(uint256):(uint256)", 45 | "arguments": ["1"], 46 | "tx": { 47 | "type": "0x02", 48 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 49 | "to": "0x7c6b4bbe207d642d98d5c537142d85209e585087", 50 | "gas": "0x8599", 51 | "value": "0x0", 52 | "data": "0xafe29f710000000000000000000000000000000000000000000000000000000000000001", 53 | "nonce": "0x5", 54 | "accessList": [] 55 | } 56 | } 57 | ], 58 | "receipts": [ 59 | { 60 | "transactionHash": "0x481dc86e40bba90403c76f8e144aa9ff04c1da2164299d0298573835f0991181", 61 | "transactionIndex": "0x0", 62 | "blockHash": "0xef0730448490304e5403be0fa8f8ce64f118e9adcca60c07a2ae1ab921d748af", 63 | "blockNumber": "0x1", 64 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 65 | "to": null, 66 | "cumulativeGasUsed": "0x13f3a", 67 | "gasUsed": "0x13f3a", 68 | "contractAddress": "0x5fbdb2315678afecb367f032d93f642f64180aa3", 69 | "logs": [], 70 | "status": "0x1", 71 | "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", 72 | "effectiveGasPrice": "0xee6b2800" 73 | }, 74 | { 75 | "transactionHash": "0x6a187183545b8a9e7f1790e847139379bf5622baff2cb43acf3f5c79470af782", 76 | "transactionIndex": "0x0", 77 | "blockHash": "0xf3acb96a90071640c2a8c067ae4e16aad87e634ea8d8bbbb5b352fba86ba0148", 78 | "blockNumber": "0x2", 79 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 80 | "to": null, 81 | "cumulativeGasUsed": "0x45d80", 82 | "gasUsed": "0x45d80", 83 | "contractAddress": "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512", 84 | "logs": [], 85 | "status": "0x1", 86 | "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", 87 | "effectiveGasPrice": "0xee6b2800" 88 | }, 89 | { 90 | "transactionHash": "0x064ad173b4867bdef2fb60060bbdaf01735fbf10414541ea857772974e74ea9d", 91 | "transactionIndex": "0x0", 92 | "blockHash": "0x8373d02109d3ee06a0225f23da4c161c656ccc48fe0fcee931d325508ae73e58", 93 | "blockNumber": "0x3", 94 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 95 | "to": "0x4e59b44847b379578588920ca78fbf26c0b4956c", 96 | "cumulativeGasUsed": "0x45feb", 97 | "gasUsed": "0x45feb", 98 | "contractAddress": null, 99 | "logs": [], 100 | "status": "0x1", 101 | "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", 102 | "effectiveGasPrice": "0xee6b2800" 103 | }, 104 | { 105 | "transactionHash": "0xc6006863c267735a11476b7f15b15bc718e117e2da114a2be815dd651e1a509f", 106 | "transactionIndex": "0x0", 107 | "blockHash": "0x16712fae5c0e18f75045f84363fb6b4d9a9fe25e660c4ce286833a533c97f629", 108 | "blockNumber": "0x4", 109 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 110 | "to": "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512", 111 | "cumulativeGasUsed": "0x5905", 112 | "gasUsed": "0x5905", 113 | "contractAddress": null, 114 | "logs": [], 115 | "status": "0x1", 116 | "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", 117 | "effectiveGasPrice": "0xee6b2800" 118 | }, 119 | { 120 | "transactionHash": "0xedf2b38d8d896519a947a1acf720f859bb35c0c5ecb8dd7511995b67b9853298", 121 | "transactionIndex": "0x0", 122 | "blockHash": "0x156b88c3eb9a1244ba00a1834f3f70de735b39e3e59006dd03af4fe7d5480c11", 123 | "blockNumber": "0x5", 124 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 125 | "to": "0xe7f1725e7734ce288f8367e1bb143e90bb3f0512", 126 | "cumulativeGasUsed": "0xa9c4", 127 | "gasUsed": "0xa9c4", 128 | "contractAddress": null, 129 | "logs": [], 130 | "status": "0x1", 131 | "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", 132 | "effectiveGasPrice": "0xee6b2800" 133 | }, 134 | { 135 | "transactionHash": "0xa57e8e3981a6c861442e46c9471bd19cb3e21f9a8a6c63a72e7b5c47c6675a7c", 136 | "transactionIndex": "0x0", 137 | "blockHash": "0xcf61faca67dbb2c28952b0b8a379e53b1505ae0821e84779679390cb8571cadb", 138 | "blockNumber": "0x6", 139 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 140 | "to": "0x7c6b4bbe207d642d98d5c537142d85209e585087", 141 | "cumulativeGasUsed": "0x66c5", 142 | "gasUsed": "0x66c5", 143 | "contractAddress": null, 144 | "logs": [ 145 | { 146 | "address": "0x7c6b4bbe207d642d98d5c537142d85209e585087", 147 | "topics": [ 148 | "0x0b2e13ff20ac7b474198655583edf70dedd2c1dc980e329c4fbb2fc0748b796b" 149 | ], 150 | "data": "0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000046865726500000000000000000000000000000000000000000000000000000000", 151 | "blockHash": "0xcf61faca67dbb2c28952b0b8a379e53b1505ae0821e84779679390cb8571cadb", 152 | "blockNumber": "0x6", 153 | "transactionHash": "0xa57e8e3981a6c861442e46c9471bd19cb3e21f9a8a6c63a72e7b5c47c6675a7c", 154 | "transactionIndex": "0x1", 155 | "logIndex": "0x0", 156 | "transactionLogIndex": "0x0", 157 | "removed": false 158 | } 159 | ], 160 | "status": "0x1", 161 | "logsBloom": "0x00000000000800000000000000000010000000000000000000000000000180000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100", 162 | "effectiveGasPrice": "0xee6b2800" 163 | }, 164 | { 165 | "transactionHash": "0x11fbb10230c168ca1e36a7e5c69a6dbcd04fd9e64ede39d10a83e36ee8065c16", 166 | "transactionIndex": "0x0", 167 | "blockHash": "0xf1e0ed2eda4e923626ec74621006ed50b3fc27580dc7b4cf68a07ca77420e29c", 168 | "blockNumber": "0x7", 169 | "from": "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266", 170 | "to": "0x0000000000000000000000000000000000001337", 171 | "cumulativeGasUsed": "0x5208", 172 | "gasUsed": "0x5208", 173 | "contractAddress": null, 174 | "logs": [], 175 | "status": "0x1", 176 | "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", 177 | "effectiveGasPrice": "0xee6b2800" 178 | } 179 | ], 180 | "libraries": [ 181 | "src/Broadcast.t.sol:F:0x5fbdb2315678afecb367f032d93f642f64180aa3" 182 | ], 183 | "pending": [], 184 | "path": "broadcast/Broadcast.t.sol/31337/run-latest.json", 185 | "returns": {}, 186 | "timestamp": 1655140035 187 | } 188 | -------------------------------------------------------------------------------- /lib/solpretty/.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: workflow_dispatch 4 | 5 | env: 6 | FOUNDRY_PROFILE: ci 7 | 8 | jobs: 9 | check: 10 | strategy: 11 | fail-fast: true 12 | 13 | name: Foundry project 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/checkout@v3 17 | with: 18 | submodules: recursive 19 | 20 | - name: Install Foundry 21 | uses: foundry-rs/foundry-toolchain@v1 22 | with: 23 | version: nightly 24 | 25 | - name: Run Forge build 26 | run: | 27 | forge --version 28 | forge build --sizes 29 | id: build 30 | 31 | - name: Run Forge tests 32 | run: | 33 | forge test -vvv 34 | id: test 35 | -------------------------------------------------------------------------------- /lib/solpretty/.gitignore: -------------------------------------------------------------------------------- 1 | # Compiler files 2 | cache/ 3 | out/ 4 | 5 | # Ignores development broadcast logs 6 | !/broadcast 7 | /broadcast/*/31337/ 8 | /broadcast/**/dry-run/ 9 | 10 | # Docs 11 | docs/ 12 | 13 | # Dotenv file 14 | .env 15 | 16 | # foundry deps 17 | lib -------------------------------------------------------------------------------- /lib/solpretty/.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "lib/forge-std"] 2 | path = lib/forge-std 3 | url = https://github.com/foundry-rs/forge-std 4 | [submodule "lib/solady"] 5 | path = lib/solady 6 | url = https://github.com/vectorized/solady 7 | [submodule "lib/openzeppelin-contracts"] 8 | path = lib/openzeppelin-contracts 9 | url = https://github.com/openzeppelin/openzeppelin-contracts 10 | -------------------------------------------------------------------------------- /lib/solpretty/.vscode/settings.json: -------------------------------------------------------------------------------- 1 | 2 | 3 | { 4 | "workbench.colorCustomizations": { 5 | "titleBar.activeForeground": "#860303", 6 | "titleBar.inactiveForeground": "#860303", 7 | "titleBar.activeBackground": "#e1e1e1", 8 | "titleBar.inactiveBackground": "#e1e1e1" 9 | }, 10 | "editor.tokenColorCustomizations": { 11 | "textMateRules": [ 12 | { 13 | "scope": [ 14 | "comment", 15 | ], 16 | "settings": { 17 | "fontStyle": "", 18 | } 19 | } 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /lib/solpretty/README.md: -------------------------------------------------------------------------------- 1 | ## solpretty 2 | ![Solidity][solidity-shield] 3 | 4 | A library for pretty printing numbers in Solidity 5 | 6 | built on [Solady](https://github.com/Vectorized/solady) 7 | 8 | ## Installation 9 | To install with [**Foundry**](https://github.com/gakonst/foundry): 10 | 11 | ```sh 12 | forge install devtooligan/solpretty 13 | ``` 14 | 15 | ## Usage 16 | 17 | ### pp 18 | - pp(uint256 value) 19 | - pp(uint256 value, uint256 fixedDecimals) 20 | - pp(uint256 value, uint256 fixedDecimals, uint256 displayDecimals) 21 | - pp(uint256 value, uint256 fixedDecimals, uint256 displayDecimals, uint256 fixedWidth) 22 | - pp(uint256 value, memory SolPrettyOptions) 23 | 24 | ```solidity 25 | import {pp} from "solpretty/solpretty.sol"; 26 | 27 | pp(123123123123) // -> "123,123,123,123" // default 28 | pp(123123123123, 6) // -> "123,123.123123" // fixedDecimals = 6 29 | pp(123123123123, 6, 2) // -> "123,123.12" // displayDecimals = 2 30 | pp(123123123123, 6, 0, 15) // -> " 123,123" // fixedWidth = 15 31 | ``` 32 | 33 | Customizeable options: 34 | 35 | ```solidity 36 | 37 | SolPrettyOptions memory solPrettyOptions = getDefaultOptions(); 38 | 39 | SolPrettyOptions.fixedDecimals = 6; 40 | SolPrettyOptions.fixedWidth = 20; 41 | SolPrettyOptions.decimalDelimeter = bytes1("*"); 42 | SolPrettyOptions.integerDelimeter = bytes1(" "); 43 | 44 | pp(123123123123, solPrettyOptions); // -> " 123 123*123123" 45 | 46 | struct SolPrettyOptions { 47 | uint256 fixedDecimals; // default 0 48 | uint256 displayDecimals; // default type(uint256).max 49 | bytes1 decimalDelimter; // default "." 50 | bytes1 fractionalDelimiter; // default " " 51 | uint256 fractionalGroupingSize; // default 0 52 | bytes1 integerDelimiter; // default "," 53 | uint256 integerGroupingSize; // default 3 54 | uint256 fixedWidth; // default 0 (automatic) 55 | } 56 | 57 | ``` 58 | 59 | ### concat 60 | - concat(string memory left, string memory right) 61 | - concat(string[] memory parts) 62 | 63 | ```solidity 64 | pp(1234).concat(" Alice's balance"); // -> "1,234 Alice's Balance"; 65 | 66 | string[] memory strings = new string[](3); 67 | strings[0] = "a"; 68 | strings[1] = "b"; 69 | strings[2] = "c"; 70 | concat(strings); // -> "abc" 71 | 72 | ``` 73 | 74 | ### log 75 | - log(string memory message) 76 | - log(string[] memory messages) 77 | 78 | ```solidity 79 | using SolPretty for string; 80 | 81 | log("hoagies"); // console2.log("hoagies"); 82 | pp(1234).log(); // console2.log("1,234") 83 | pp(1234).concat(" Alice's balance").log(); // console2.log("1,234 Alice's balance") 84 | 85 | ``` 86 | 87 | [solidity-shield]: https://img.shields.io/badge/solidity-%3E=0.8.4%20%3C=0.8.19-aa6746 88 | -------------------------------------------------------------------------------- /lib/solpretty/foundry.toml: -------------------------------------------------------------------------------- 1 | [profile.default] 2 | src = "src" 3 | out = "out" 4 | libs = ["lib"] 5 | remappings = [ 6 | ] 7 | 8 | 9 | # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options 10 | -------------------------------------------------------------------------------- /lib/solpretty/test/SolPretty.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: MIT 2 | pragma solidity ^0.8.19; 3 | 4 | import {Test, console2 as console} from "forge-std/Test.sol"; 5 | import {LibString as Solady} from "solady/src/utils/LibString.sol"; 6 | import "../src/SolPretty.sol"; 7 | 8 | using SolPretty for uint256; 9 | using SolPretty for string; 10 | 11 | contract SolPrettyTest is Test { 12 | function setUp() public {} 13 | 14 | function test_fractional1() public { 15 | uint256 target = 0.95e18; 16 | string memory expected = "0.9500"; 17 | string memory result = pp(target, 18, 4); 18 | assertTrue(result.log().eq(expected)); 19 | } 20 | 21 | function test_fractional2() public { 22 | uint256 target = 0.0000095e18; 23 | string memory expected = "0.0000"; 24 | string memory result = pp(target, 18, 4); 25 | assertTrue(result.log().eq(expected)); 26 | } 27 | 28 | function test_fractional3() public { 29 | uint256 target = 9.5e18; 30 | string memory expected = "9.5000"; 31 | string memory result = pp(target, 18, 4); 32 | assertTrue(result.log().eq(expected)); 33 | } 34 | 35 | function test_fractional4() public { 36 | uint256 target = 0.0095e18; 37 | string memory expected = "0.009"; 38 | string memory result = pp(target, 18, 3); 39 | assertTrue(result.log().eq(expected)); 40 | } 41 | 42 | function test_geeb() public { 43 | uint256 target = 1000.5e18; 44 | string memory expected = "1,000.50"; 45 | string memory result = pp(target, 18, 2); 46 | assertTrue(result.log().eq(expected)); 47 | } 48 | 49 | function test_benaadams() public { 50 | uint256 target = 0; 51 | string memory expected = "0.00"; 52 | string memory result = pp(target, 18, 2); 53 | require(result.log().eq(expected)); 54 | // assertTrue(result.log().eq(expected)); 55 | 56 | SolPretty.SolPrettyOptions memory opts = SolPretty.SolPrettyOptions({ 57 | fixedDecimals: 18, 58 | displayDecimals: 5, // if this is less than fixedDecimals, value will be truncated 59 | decimalDelimter: ".", 60 | fractionalDelimiter: " ", 61 | fractionalGroupingSize: 3, 62 | integerDelimiter: ",", 63 | integerGroupingSize: 1, 64 | fixedWidth: 0 65 | }); 66 | target = uint256(0.000001 ether); 67 | result = pp(target, opts); 68 | expected = "0.000 00"; 69 | assertTrue(result.log().eq(expected)); 70 | } 71 | 72 | function test_pp_default() public { 73 | string memory expected = "123,456,789"; 74 | uint256 target = 123456789; 75 | assertTrue(pp(target).log().eq(expected)); 76 | } 77 | 78 | function test_pp_fp() public { 79 | string memory expected = "123,456,789.987654321987654321"; 80 | uint256 target = 123456789987654321987654321; 81 | assertTrue(pp(target, 18).log().eq(expected)); 82 | } 83 | 84 | function test_pp_displaydecimals() public { 85 | string memory expected = "123,456,789.9876"; 86 | uint256 target = 123456789987654321987654321; 87 | assertTrue(pp(target, 18, 4).log().eq(expected)); 88 | } 89 | 90 | function test_pp_displaydecimals2() public { 91 | string memory expected = "123,456,789"; 92 | uint256 target = 123456789987654321987654321; 93 | assertTrue(pp(target, 18, 0).log().eq(expected)); 94 | } 95 | 96 | function test_pp_fixedwidth() public { 97 | string memory expected = " 123,456,789.9876"; 98 | uint256 target = 123456789987654321987654321; 99 | assertTrue(pp(target, 18, 4, 20).log().eq(expected)); 100 | } 101 | 102 | function test_pp_opts1() public { 103 | uint256 target = 123456789987654321987654321; 104 | string memory expected = "1|2|3|4|5|6|7|8|9X9876 5432 19"; 105 | SolPretty.SolPrettyOptions memory opts = SolPretty.SolPrettyOptions({ 106 | fixedDecimals: 18, 107 | displayDecimals: 10, // if this is less than fixedDecimals, value will be truncated 108 | decimalDelimter: "X", 109 | fractionalDelimiter: " ", 110 | fractionalGroupingSize: 4, 111 | integerDelimiter: "|", 112 | integerGroupingSize: 1, 113 | fixedWidth: 0 114 | }); 115 | assertTrue(pp(target, opts).log().eq(expected)); 116 | } 117 | 118 | function test_pp_opts2() public { 119 | uint256 target = 123456789987654321987654321; 120 | string memory expected = "1,234,567,899,876,543,219,876,543-21"; 121 | SolPretty.SolPrettyOptions memory opts = SolPretty.SolPrettyOptions({ 122 | fixedDecimals: 2, 123 | displayDecimals: 10, // if this is less than fixedDecimals, value will be truncated 124 | decimalDelimter: "-", 125 | fractionalDelimiter: " ", 126 | fractionalGroupingSize: 0, 127 | integerDelimiter: ",", 128 | integerGroupingSize: 3, 129 | fixedWidth: 0 130 | }); 131 | assertTrue(pp(target, opts).log().eq(expected)); 132 | } 133 | 134 | function test_pp_opts3() public { 135 | uint256 target = 123456789987654321987654321; 136 | string memory expected = "123456789987654321O987X654X321"; 137 | SolPretty.SolPrettyOptions memory opts = SolPretty.SolPrettyOptions({ 138 | fixedDecimals: 9, 139 | displayDecimals: 10, 140 | decimalDelimter: "O", 141 | fractionalDelimiter: "X", 142 | fractionalGroupingSize: 3, 143 | integerDelimiter: "", 144 | integerGroupingSize: 3, 145 | fixedWidth: 0 146 | }); 147 | assertTrue(pp(target, opts).log().eq(expected)); 148 | } 149 | 150 | function testWithoutSolPretty() public { 151 | console.log(uint256(12300000000000000000)); 152 | console.log("from pool:"); 153 | console.log(uint256(127000000000000000000)); 154 | console.log(uint256(128000000000000000000)); 155 | console.log(uint256(7000000000000000000)); 156 | console.log("here"); 157 | console.logBytes(abi.encode(1)); 158 | console.log(uint256(7332330000000000000)); 159 | console.log(uint256(25650003)); 160 | console.log(uint256(25750004)); 161 | console.log(uint256(25750005)); 162 | revert("sucker"); 163 | } 164 | 165 | function testFixedWidth() public { 166 | SolPretty.SolPrettyOptions memory optsWETH = SolPretty.SolPrettyOptions({ 167 | fixedDecimals: 18, 168 | displayDecimals: 4, 169 | decimalDelimter: ".", 170 | fractionalDelimiter: "", 171 | fractionalGroupingSize: 0, 172 | integerDelimiter: ",", 173 | integerGroupingSize: 3, 174 | fixedWidth: 20 175 | }); 176 | string memory result = pp(1500000000000000000, optsWETH).log(); 177 | assertTrue(result.eq(" 1.5000")); 178 | } 179 | 180 | function testSolPrettytestWithoutSolPretty() public { 181 | SolPretty.SolPrettyOptions memory optsWETH = SolPretty.SolPrettyOptions({ 182 | fixedDecimals: 18, 183 | displayDecimals: 4, 184 | decimalDelimter: ".", 185 | fractionalDelimiter: "", 186 | fractionalGroupingSize: 0, 187 | integerDelimiter: ",", 188 | integerGroupingSize: 3, 189 | fixedWidth: 20 190 | }); 191 | 192 | SolPretty.SolPrettyOptions memory optsUSDC = SolPretty.SolPrettyOptions({ 193 | fixedDecimals: 6, 194 | displayDecimals: 4, 195 | decimalDelimter: ".", 196 | fractionalDelimiter: "", 197 | fractionalGroupingSize: 0, 198 | integerDelimiter: ",", 199 | integerGroupingSize: 3, 200 | fixedWidth: 20 201 | }); 202 | 203 | pp(uint256(12300000000000000000), optsWETH).concat(" Alice's WETH balance before").log(); 204 | pp(uint256(127000000000000000000), optsWETH).concat(" Alice's WETH balance during").log(); 205 | pp(uint256(128000000000000000000), optsWETH).concat(" Alice's WETH balance after").log(); 206 | pp(uint256(7000000000000000000), optsWETH).concat(" Bob's WETH balance before").log(); 207 | pp(uint256(7332330000000000000), optsWETH).concat(" Bob's WETH balance after").log(); 208 | pp(uint256(25650003), optsUSDC).concat(" Alice USDC final balance").log(); 209 | pp(uint256(25750004), optsUSDC).concat(" Alice USDC final balance").log(); 210 | pp(uint256(25750005), optsUSDC).concat(" Alice USDC final balance").log(); 211 | } 212 | 213 | function testConcatList() public { 214 | string[] memory list = new string[](3); 215 | list[0] = "a"; 216 | list[1] = "b"; 217 | list[2] = "c"; 218 | string memory expected = "abc"; 219 | string memory result = SolPretty.concat(list); 220 | assertTrue(result.eq(expected)); 221 | } 222 | 223 | function testLogList() public { 224 | string[] memory list = new string[](3); 225 | list[0] = "a"; 226 | list[1] = "b"; 227 | list[2] = "c"; 228 | SolPretty.log(list); 229 | } 230 | 231 | function test_prettyPrint() public { 232 | string memory hi = "hi"; 233 | assertTrue(hi.echo().eq("hi")); 234 | } 235 | } 236 | -------------------------------------------------------------------------------- /script/Counter.s.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: UNLICENSED 2 | pragma solidity ^0.8.20; 3 | 4 | import {Script, console2} from "forge-std/Script.sol"; 5 | 6 | contract CounterScript is Script { 7 | function setUp() public {} 8 | 9 | function run() public { 10 | vm.broadcast(); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/LibMemArray.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: UNLICENSED 2 | pragma solidity ^0.8.20; 3 | 4 | 5 | /** 6 | 7 | Example: MemArray myArray = [0x123, 0x456] 8 | 9 | ┌───────────────────────────────────────┬───────────────────────┬───────────────────────────┬────────────────────────┬───────────────────────┐ 10 | │MemArray myArray │myArray │ x-x-x-x-x-x-x-x-x-x-x-x- │myArray[0] = 0x123 │myArray[1] = 0x456 │ 11 | │LINKED LIST │NODE - HEAD │ MEMORY USED BY SOMETHING │NODE - CUTOFF │NODE - TAIL │ 12 | │ │contains no value │ ELSE - UNRELATED TO THIS │ │tail has no next │ 13 | ├─────────────┬─────────────┬───────────┼─────────────┬─────────┼─────────────┬─────────────┼─────────────┬──────────┼───────────┬───────────┤ 14 | │0x080 │0x0a0 │0x0c0 │0x0e0 │0x100 │0x120 │0x140 │0x160 │0x180 │0x1a0 │ 0x1c0 │ 15 | │ │ │ │ │ │ │ │ │ │ │ │ 16 | │ length: │ head: │ tail: │ next: │ value: │ │ │ next: │ value: │ next: │ value: │ 17 | │ │ │ │ │ │ │ │ │ │ │ │ 18 | │ 2 │ 0x0e0 │ 0x1a0 │ 0x160 │ 0x00 │ │ │ 0x1a0 │ 0x123 │ 0x00 │ 0x456 │ 19 | └─────────────┴──────┬──────┴─────┬─────┴─────────┬───┴─────────┴─────────────┴─────────────┴─────────┬───┴──────────┴───────────┴───────────┘ 20 | │ │ ▲ │ ▲ ▲ │ ▲ ▲ 21 | │ │ │ │ │ │ │ │ │ 22 | └────────────┼────────┘ └───────────────────────────────────────────┘ │ │ │ │ 23 | │ │ │ │ │ 24 | │ │ │ │ │ 25 | ├──────────────────────────────────────────────────────────────┘ └──────────────────┘ │ 26 | │ │ 27 | │ │ 28 | └─────────────────────────────────────────────────────────────────────────────────────────┘ */ 29 | 30 | 31 | type MemArray is bytes32; // this is a ptr 32 | 33 | /// @notice An optimized, in-memory, memory-safe, dynamically resizing array. 34 | /// @author @devtooligan 35 | library LibMemArray { 36 | struct Node { 37 | bytes32 next; 38 | uint256 value; 39 | } 40 | 41 | struct LinkedList { 42 | uint256 size; 43 | Node head; // memloc of head node 44 | Node tail; // memloc of tail node 45 | } 46 | 47 | function create() internal pure returns (MemArray newArray) { 48 | // linked lists always have a head node which does not contain a value 49 | // the tail, on the other hand, represents the last node (or head if size == 0) 50 | assembly { 51 | // Grab some free memory for the linked list fat pointer 52 | let ptr := mload(0x40) 53 | // Grab some free memory for the head node fat pointer 54 | let head := add(ptr, 0x60) 55 | // On initialization, the head and the tail point to the allocated head. 56 | mstore(add(ptr, 0x20), head) 57 | mstore(add(ptr, 0x40), head) 58 | // Update the free memory pointer after 160 bytes of allocation 59 | mstore(0x40, add(ptr, 0xA0)) 60 | // Return the linked list fat pointer 61 | newArray := ptr 62 | } 63 | } 64 | 65 | // @dev This operation is O(1) because we have a tail pointer 66 | function push(MemArray ptr, uint256 value) internal pure returns (MemArray) { 67 | // get linked list 68 | LinkedList memory linkedList; 69 | assembly { 70 | linkedList := ptr 71 | } 72 | 73 | // create new node 74 | Node memory newNode = Node({next: 0, value: value}); 75 | bytes32 newNodePtr; 76 | assembly { 77 | newNodePtr := newNode 78 | } 79 | 80 | // attach new node to tail 81 | Node memory tail = linkedList.tail; 82 | tail.next = newNodePtr; 83 | 84 | // update length 85 | unchecked { 86 | ++linkedList.size; 87 | } 88 | 89 | // update tail pointer 90 | linkedList.tail = newNode; 91 | 92 | return ptr; 93 | } 94 | 95 | // @dev This operation is O(n) because we have to traverse the list to find the second to last node 96 | function pop(MemArray ptr) internal pure returns (uint256 value) { 97 | // get linked list 98 | LinkedList memory linkedList; 99 | assembly { 100 | linkedList := ptr 101 | } 102 | require(linkedList.size > 0, "list is empty"); 103 | 104 | // detach tail 105 | Node memory tail = linkedList.tail; 106 | if (linkedList.size == 1) { 107 | // if there is only one node, zero out head.next 108 | linkedList.head.next = 0x0; 109 | linkedList.tail = linkedList.head; 110 | } else { 111 | // else get the second to last node and zero out its .next 112 | Node memory cutoff = _getNode(linkedList.head, linkedList.size - 2); 113 | cutoff.next = 0x0; 114 | linkedList.tail = cutoff; 115 | } 116 | 117 | // retain detached tail value for return 118 | value = tail.value; 119 | 120 | // update linked list length 121 | unchecked { 122 | --linkedList.size; 123 | } 124 | } 125 | 126 | /// @dev This operation is O(n) because we have to traverse the list to find the node 127 | function set(MemArray ptr, uint256 index, uint256 value) internal pure returns (MemArray) { 128 | // get linked list 129 | LinkedList memory linkedList; 130 | assembly { 131 | linkedList := ptr 132 | } 133 | require(linkedList.size > index, "out of bounds"); 134 | 135 | // get node 136 | Node memory node = _getNode(linkedList.head, index); 137 | 138 | // set node 139 | node.value = value; 140 | 141 | return ptr; 142 | } 143 | 144 | /// @dev This operation is O(n) because we have to traverse the list to find the node 145 | function get(MemArray head, uint256 index) internal pure returns (uint256) { 146 | // get linked list 147 | LinkedList memory linkedList; 148 | assembly { 149 | linkedList := head 150 | } 151 | require(linkedList.size > index, "out of bounds"); 152 | 153 | // get node 154 | Node memory node = _getNode(linkedList.head, index); 155 | 156 | return node.value; 157 | } 158 | 159 | function size(MemArray ptr) internal pure returns (uint256) { 160 | // get linked list 161 | LinkedList memory linkedList; 162 | assembly { 163 | linkedList := ptr 164 | } 165 | return linkedList.size; 166 | } 167 | 168 | function toArray(MemArray head) internal pure returns (uint256[] memory arr) { 169 | // get linked list 170 | LinkedList memory linkedList; 171 | assembly { 172 | linkedList := head 173 | } 174 | 175 | // create array 176 | arr = new uint256[](linkedList.size); 177 | 178 | // iterate through linked list and populate the legacy array 179 | bytes32 zeroNodePtr = linkedList.head.next; 180 | Node memory node; 181 | assembly { 182 | node := zeroNodePtr 183 | } 184 | for (uint256 i = 0; i < linkedList.size; i++) { 185 | arr[i] = node.value; 186 | assembly { 187 | node := mload(node) // node = node.next 188 | } 189 | } 190 | } 191 | 192 | function fromArray(uint256[] memory arr) internal pure returns (MemArray newArray) { 193 | // create linked list 194 | newArray = create(); 195 | 196 | // Because we've allocated a new linked list, we can safely assume that the contiguous 197 | // memory following it is clean. Iterate through the array and directly copy the values 198 | // into the linked list. 199 | assembly { 200 | // Cache the free memory pointer 201 | let freeMem := mload(0x40) 202 | 203 | // Grab the pointer of the current tail in memory. 204 | let tailPtr := add(newArray, 0x40) 205 | 206 | // Grab the length of the array. 207 | let arrLen := mload(arr) 208 | 209 | // Grab the pointer to the data within `arr` 210 | let arrData := add(arr, 0x20) 211 | 212 | // Loop through each element in `arr` and copy it into the linked list. 213 | for { 214 | let i := 0x00 215 | let curNodePtr := add(tailPtr, 0x20) 216 | } lt(i, arrLen) { 217 | i := add(i, 0x01) 218 | curNodePtr := add(curNodePtr, 0x40) 219 | } { 220 | // Allocate a new node and assign the value from `arr` to it. 221 | let nextNodePtr := add(curNodePtr, 0x40) 222 | mstore(add(nextNodePtr, 0x20), mload(add(arrData, shl(0x05, i)))) 223 | 224 | // Update the previous node's `next` word to the newly allocated node's ptr. 225 | mstore(curNodePtr, nextNodePtr) 226 | 227 | // Update the tail pointer's value to the newly allocated node's ptr. 228 | mstore(tailPtr, nextNodePtr) 229 | } 230 | 231 | // Update the length of the linked list. 232 | mstore(newArray, arrLen) 233 | 234 | // Update the free memory pointer to account for the memory allocated above. Note that 235 | // `create()` updates the free memory pointer as well by 160 bytes (the size of the 236 | // linked list fat pointer). 237 | mstore(0x40, add(freeMem, shl(0x06, arrLen))) 238 | } 239 | } 240 | 241 | // internal functions ***************************************************** 242 | 243 | function _getNode(Node memory head, uint256 index) internal pure returns (Node memory node) { 244 | node = head; 245 | require(head.next != 0x0, "empty list"); 246 | assembly { 247 | node := mload(node) // node = node.next 248 | let counter := 0x0 249 | for {} iszero(eq(counter, index)) {} { 250 | // while counter != index 251 | if eq(node, 0x0) { 252 | // if node.next == 0 253 | revert(0, 0) // revert TODO: pretty error 254 | } 255 | node := mload(node) // node = node.next 256 | counter := add(counter, 0x1) // counter++ 257 | } 258 | } 259 | } 260 | 261 | function _hasNode(Node memory head, uint256 index) internal pure returns (bool success, Node memory node) { 262 | node = head; 263 | if (head.next == 0x0) return (false, head); 264 | bool finished = false; 265 | assembly { 266 | node := mload(node) // node = node.next 267 | let counter := 0x0 268 | for {} iszero(eq(counter, index)) {} { 269 | // while counter != index 270 | if eq(node, 0x0) { 271 | finished := 1 272 | break 273 | 274 | } 275 | node := mload(node) // node = node.next 276 | counter := add(counter, 0x1) // counter++ 277 | } 278 | } 279 | } 280 | 281 | function _getNodePtr(Node memory head, uint256 index) internal pure returns (bytes32 nodePtr) { 282 | require(head.next != 0x0, "empty list"); 283 | assembly { 284 | nodePtr := mload(head) // node = node.next 285 | let counter := 0x0 286 | for {} iszero(eq(counter, index)) {} { 287 | // while counter != index 288 | if eq(nodePtr, 0x0) { 289 | // if node.next == 0 290 | revert(0, 0) // revert TODO: pretty error 291 | } 292 | nodePtr := mload(nodePtr) // node = node.next 293 | counter := add(counter, 0x1) // counter++ 294 | } 295 | } 296 | } 297 | } 298 | -------------------------------------------------------------------------------- /src/LibMemDict.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: UNLICENSED 2 | pragma solidity ^0.8.20; 3 | 4 | import {console2 as console} from "forge-std/Test.sol"; 5 | 6 | type MemDict is bytes32; // this is a ptr 7 | 8 | /// @notice An optimized, in-memory, memory-safe, dictionary data structure. 9 | /// @author @devtooligan 10 | library LibMemDict { 11 | struct DictNode { 12 | bytes32 next; 13 | uint256 key; 14 | uint256 value; 15 | } 16 | 17 | struct LinkedList { 18 | uint256 keysLength; 19 | DictNode head; // memloc of head node 20 | DictNode tail; // memloc of tail node 21 | } 22 | 23 | function create() internal pure returns (MemDict newDict) { 24 | // linked lists always have a head node which does not contain a value 25 | DictNode memory head; 26 | LinkedList memory list = LinkedList({keysLength: 0, head: head, tail: head}); 27 | assembly { 28 | newDict := list 29 | } 30 | } 31 | 32 | /// @dev there is no protection against duplicate keys 33 | function addKey(MemDict ptr, uint256 key) internal pure returns (MemDict newDict) { 34 | LinkedList memory linkedList = getLinkList(ptr); 35 | _addKey(linkedList, key); 36 | return ptr; 37 | } 38 | 39 | 40 | function set(MemDict ptr, uint256 key, uint256 value) internal pure returns (MemDict) { 41 | LinkedList memory linkedList = getLinkList(ptr); 42 | DictNode memory node = _getOrAddDictNode(linkedList, key); 43 | node.value = value; 44 | return ptr; 45 | } 46 | 47 | /// @dev like set() but it adds the value to the existing value 48 | function sum(MemDict ptr, uint256 key, uint256 value) internal pure returns (MemDict) { 49 | LinkedList memory linkedList = getLinkList(ptr); 50 | DictNode memory node = _getOrAddDictNode(linkedList, key); 51 | node.value += value; 52 | return ptr; 53 | } 54 | 55 | function getLinkList(MemDict ptr) internal pure returns (LinkedList memory linkedList) { 56 | assembly { 57 | linkedList := ptr 58 | } 59 | return linkedList; 60 | } 61 | 62 | function get(MemDict ptr, uint256 key) internal pure returns (uint256) { 63 | LinkedList memory linkedList = getLinkList(ptr); 64 | require(linkedList.keysLength > 0, "out of bounds"); 65 | (bool success, DictNode memory node) = _getNodeByKey(linkedList.head, key); 66 | require(success, "key not found"); 67 | return node.value; 68 | } 69 | 70 | function clear(MemDict ptr, uint256 key) internal pure { 71 | LinkedList memory linkedList = getLinkList(ptr); 72 | (bool success, DictNode memory node) = _getNodeByKey(linkedList.head, key); 73 | require(success, "key not found"); 74 | node.value = 0; 75 | } 76 | 77 | function keysLength(MemDict ptr) internal pure returns (uint256) { 78 | LinkedList memory linkedList = getLinkList(ptr); 79 | return linkedList.keysLength; 80 | } 81 | 82 | function toMapping(MemDict ptr, mapping(uint => uint) storage mappingTarget) internal { 83 | LinkedList memory linkedList = getLinkList(ptr); 84 | DictNode memory node = linkedList.head; 85 | for (uint i = 0; i < linkedList.keysLength; i++) { 86 | assembly { 87 | node := mload(node) // node = node.next 88 | } 89 | mappingTarget[node.key] = node.value; 90 | } 91 | } 92 | 93 | function importFromMapping(MemDict ptr, mapping(uint => uint) storage mappingTarget, uint[] memory keys) internal view { 94 | LinkedList memory linkedList = getLinkList(ptr); 95 | for (uint i = 0; i < keys.length; i++) { 96 | uint key = keys[i]; 97 | uint value = mappingTarget[key]; 98 | if (value != 0) { 99 | DictNode memory node = _getOrAddDictNode(linkedList, key); 100 | node.value = value; 101 | } 102 | } 103 | } 104 | 105 | // same as importFromMapping but it doesn't check if the key exists before setting the value 106 | function createFromMapping(mapping(uint => uint) storage mappingTarget, uint[] memory keys) internal view returns (MemDict ptr) { 107 | ptr = create(); 108 | LinkedList memory linkedList = getLinkList(ptr); 109 | for (uint i = 0; i < keys.length; i++) { 110 | uint key = keys[i]; 111 | uint value = mappingTarget[key]; 112 | if (value != 0) { 113 | DictNode memory node = _addKey(linkedList, key); 114 | node.value = value; 115 | } 116 | } 117 | } 118 | 119 | 120 | 121 | // internal functions ***************************************************** 122 | 123 | function _getOrAddDictNode(LinkedList memory linkedList, uint256 key) private pure returns (DictNode memory) { 124 | (bool success, DictNode memory node) = _getNodeByKey(linkedList.head, key); 125 | if (success) { 126 | return node; 127 | } else { 128 | return _addKey(linkedList, key); 129 | } 130 | } 131 | 132 | 133 | /// @notice does not check for duplicate keys 134 | function _addKey(LinkedList memory linkedList, uint256 key) private pure returns (DictNode memory newNode) { 135 | // create new node 136 | newNode.key = key; 137 | bytes32 newNodePtr; 138 | assembly { 139 | newNodePtr := newNode 140 | } 141 | 142 | // attach new node to tail 143 | DictNode memory tail = linkedList.tail; 144 | tail.next = newNodePtr; 145 | 146 | // update linked list tail 147 | linkedList.tail = newNode; 148 | 149 | // update linked list length 150 | unchecked { 151 | ++linkedList.keysLength; 152 | } 153 | } 154 | 155 | /// @dev does not revert on key error 156 | /// @param success true if key exists 157 | /// @param node the node with the given key if found, else head 158 | function _getNodeByKey(DictNode memory head, uint256 key) 159 | internal 160 | pure 161 | returns (bool success, DictNode memory node) 162 | { 163 | node = head; 164 | 165 | while (node.next != 0x0) { 166 | assembly { 167 | node := mload(node) // node = node.next 168 | } 169 | if (node.key == key) { 170 | return (true, node); 171 | } 172 | } 173 | return (false, node); 174 | } 175 | } 176 | -------------------------------------------------------------------------------- /test/LibMemArray.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: UNLICENSED 2 | pragma solidity ^0.8.20; 3 | 4 | import {Test, console2 as console} from "forge-std/Test.sol"; 5 | import "../src/LibMemArray.sol"; 6 | 7 | contract LibMemArrayTest is Test { 8 | using LibMemArray for *; 9 | 10 | function testArr() public pure { 11 | MemArray arr = LibMemArray.create(); 12 | arr.push(0x69); 13 | require(arr.get(0) == 0x69, "get 0"); 14 | require(arr.size() == 1, "size 1"); 15 | arr.push(0x269); 16 | require(arr.get(1) == 0x269, "get 1"); 17 | require(arr.size() == 2, "size 2"); 18 | arr.push(0x369); 19 | require(arr.get(2) == 0x369, "get 2"); 20 | require(arr.size() == 3, "size 3"); 21 | 22 | uint[] memory out = arr.toArray(); 23 | require(out.length == 3, "legacy length"); 24 | require(out[0] == 0x69, "legacy 0"); 25 | require(out[1] == 0x269, "legacy 1"); 26 | require(out[2] == 0x369, "legacy 2"); 27 | 28 | uint x0 = arr.pop(); 29 | console.log("x0", x0); 30 | 31 | uint[] memory legacy = new uint[](3); 32 | legacy[0] = 0x6000; 33 | legacy[1] = 0x6111; 34 | legacy[2] = 0x6222; 35 | MemArray arr2 = legacy.fromArray(); 36 | require(arr2.size() == 3, "legacy size"); 37 | require(arr2.get(0) == 0x6000, "legacy get 0"); 38 | require(arr2.get(1) == 0x6111, "legacy get 1"); 39 | require(arr2.get(2) == 0x6222, "legacy get 2"); 40 | } 41 | 42 | function testFuzz_fromArrayMemorySafety(uint256[] memory _from) public { 43 | // Grab the size of the array 44 | uint256 size = _from.length; 45 | 46 | // Grab the free memory pointer 47 | uint64 freeMemPtr; 48 | assembly { 49 | freeMemPtr := mload(0x40) 50 | } 51 | 52 | // The following operation should expand memory by: 53 | // 1. 96 bytes for the linked list fat pointer 54 | // 2. 64 bytes for the head node 55 | // 3. 64 * N bytes for the array elements. 56 | // Totaling 96 + 64 + 64 * N bytes. 57 | // 58 | // The only memory that this operation should be allowed to touch is in 59 | // the range [free_mem_ptr, free_mem_ptr + 96 + 64 + 64 * N). 60 | vm.expectSafeMemory(freeMemPtr, freeMemPtr + 96 + 64 + 64 * uint64(size)); 61 | _from.fromArray(); 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /test/LibMemDict.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: UNLICENSED 2 | pragma solidity ^0.8.20; 3 | 4 | import {Test, console2 as console} from "forge-std/Test.sol"; 5 | import "../src/LibMemDict.sol"; 6 | 7 | contract LibMemDictTest is Test { 8 | using LibMemDict for *; 9 | 10 | mapping(uint => uint) public someMap; 11 | 12 | function testMemDict() public { 13 | MemDict myDict = LibMemDict.create(); 14 | myDict.set(0x69, 0x420); 15 | require(myDict.get(0x69) == 0x420, "get 0x69"); 16 | 17 | myDict.set(0x01, 0x02); 18 | myDict.sum(0x01, 0x02); 19 | require(myDict.get(0x01) == 0x04, "2 + 2 != 4"); 20 | 21 | myDict.clear(0x01); 22 | require(myDict.get(0x01) == 0x00, "clear"); 23 | 24 | 25 | // test create from mapping 26 | uint256[] memory someKeys = new uint256[](3); 27 | someKeys[0] = 0x2; 28 | someKeys[1] = 0x3; 29 | someKeys[2] = 0x4; 30 | 31 | uint256[] memory someValues = new uint256[](3); 32 | someValues[0] = 0x22; 33 | someValues[1] = 0x33; 34 | someValues[2] = 0x44; 35 | 36 | someMap[someKeys[0]] = someValues[0]; 37 | someMap[someKeys[1]] = someValues[1]; 38 | someMap[someKeys[2]] = someValues[2]; 39 | 40 | MemDict myOtherDict = LibMemDict.createFromMapping(someMap, someKeys); 41 | require(myOtherDict.get(someKeys[0]) == someValues[0], "cfm get 0"); 42 | require(myOtherDict.get(someKeys[1]) == someValues[1], "cfm get 1"); 43 | require(myOtherDict.get(someKeys[2]) == someValues[2], "cfm get 2"); 44 | 45 | myOtherDict.clear(someKeys[0]); 46 | myOtherDict.clear(someKeys[1]); 47 | myOtherDict.clear(someKeys[2]); 48 | 49 | // test import from mapping 50 | myOtherDict.importFromMapping(someMap, someKeys); 51 | require(myOtherDict.get(someKeys[0]) == someValues[0], "ifm get 0"); 52 | require(myOtherDict.get(someKeys[1]) == someValues[1], "ifm get 1"); 53 | require(myOtherDict.get(someKeys[2]) == someValues[2], "ifm get 2"); 54 | 55 | // test toMapping 56 | someMap[someKeys[0]] = 0x0; 57 | someMap[someKeys[1]] = 0x0; 58 | someMap[someKeys[2]] = 0x0; 59 | 60 | myOtherDict.toMapping(someMap); 61 | 62 | require(someMap[someKeys[0]] == someValues[0], "tm get 0"); 63 | require(someMap[someKeys[1]] == someValues[1], "tm get 1"); 64 | require(someMap[someKeys[2]] == someValues[2], "tm get 2"); 65 | 66 | 67 | 68 | } 69 | } 70 | --------------------------------------------------------------------------------