feat: initial commit
This commit is contained in:
commit
43e1e113f4
|
@ -0,0 +1,2 @@
|
|||
extends:
|
||||
- "@commitlint/config-conventional"
|
|
@ -0,0 +1,19 @@
|
|||
# EditorConfig http://EditorConfig.org
|
||||
|
||||
# top-most EditorConfig file
|
||||
root = true
|
||||
|
||||
# All files
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
indent_size = 2
|
||||
indent_style = space
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.{sol,toml}]
|
||||
indent_size = 4
|
||||
|
||||
[*.tree]
|
||||
indent_size = 1
|
|
@ -0,0 +1,3 @@
|
|||
export ETH_FROM="YOUR_DEFAULT_SENDER_ACCOUNT"
|
||||
export ETH_RPC_URL="https://rinkeby.infura.io/v3/INFURA_API_KEY"
|
||||
export PRIVATE_KEY="YOUR_PRIVATE_KEY"
|
|
@ -0,0 +1,59 @@
|
|||
name: "CI"
|
||||
|
||||
env:
|
||||
FOUNDRY_PROFILE: "ci"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- "main"
|
||||
push:
|
||||
branches:
|
||||
- "main"
|
||||
|
||||
jobs:
|
||||
ci:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- name: "Check out the repo"
|
||||
uses: "actions/checkout@v3"
|
||||
with:
|
||||
submodules: "recursive"
|
||||
|
||||
- name: "Install Foundry"
|
||||
uses: "onbjerg/foundry-toolchain@v1"
|
||||
with:
|
||||
version: "nightly"
|
||||
|
||||
- name: "Install Node.js"
|
||||
uses: "actions/setup-node@v3"
|
||||
with:
|
||||
cache: "yarn"
|
||||
node-version: "16"
|
||||
|
||||
- name: "Install the Node.js dependencies"
|
||||
run: "yarn install --immutable"
|
||||
|
||||
- name: "Lint the contracts"
|
||||
run: "yarn lint"
|
||||
|
||||
- name: "Add lint summary"
|
||||
run: |
|
||||
echo "## Lint" >> $GITHUB_STEP_SUMMARY
|
||||
echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
- name: "Show the Foundry config"
|
||||
run: "forge config"
|
||||
|
||||
- name: "Run the tests"
|
||||
run: "forge test"
|
||||
|
||||
- name: "Build the contracts"
|
||||
run: |
|
||||
forge --version
|
||||
forge build --sizes
|
||||
|
||||
- name: "Add test summary"
|
||||
run: |
|
||||
echo "## Tests" >> $GITHUB_STEP_SUMMARY
|
||||
echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
|
|
@ -0,0 +1,23 @@
|
|||
# directories
|
||||
.yarn/*
|
||||
!.yarn/patches
|
||||
!.yarn/releases
|
||||
!.yarn/plugins
|
||||
!.yarn/sdks
|
||||
!.yarn/versions
|
||||
**/cache
|
||||
**/node_modules
|
||||
**/out
|
||||
|
||||
# files
|
||||
*.env
|
||||
*.log
|
||||
.DS_Store
|
||||
.pnp.*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# broadcasts
|
||||
!/broadcast
|
||||
/broadcast/*
|
||||
/broadcast/*/31337/
|
|
@ -0,0 +1,8 @@
|
|||
[submodule "lib/forge-std"]
|
||||
branch = "master"
|
||||
path = "lib/forge-std"
|
||||
url = "https://github.com/foundry-rs/forge-std"
|
||||
[submodule "lib/prb-test"]
|
||||
branch = "0.1.2"
|
||||
path = "lib/prb-test"
|
||||
url = "https://github.com/paulrberg/prb-test"
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"*.{json,md,sol,yml}": [
|
||||
"prettier --config ./.prettierrc.yml --write"
|
||||
]
|
||||
}
|
|
@ -0,0 +1,15 @@
|
|||
# directories
|
||||
.yarn/
|
||||
**/broadcast
|
||||
**/cache
|
||||
**/lib
|
||||
**/out
|
||||
**/node_modules
|
||||
|
||||
# files
|
||||
*.env
|
||||
*.log
|
||||
.pnp.*
|
||||
coverage.json
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
|
@ -0,0 +1,15 @@
|
|||
arrowParens: "avoid"
|
||||
bracketSpacing: true
|
||||
endOfLine: "auto"
|
||||
printWidth: 120
|
||||
singleQuote: false
|
||||
tabWidth: 2
|
||||
trailingComma: "all"
|
||||
|
||||
overrides:
|
||||
- files: ["*.sol"]
|
||||
options:
|
||||
compiler: "0.8.15"
|
||||
- files: ["*.sol", "*.toml"]
|
||||
options:
|
||||
tabWidth: 4
|
|
@ -0,0 +1,18 @@
|
|||
{
|
||||
"extends": "solhint:recommended",
|
||||
"plugins": ["prettier"],
|
||||
"rules": {
|
||||
"code-complexity": ["error", 8],
|
||||
"compiler-version": ["error", ">=0.8.4"],
|
||||
"func-visibility": ["error", { "ignoreConstructors": true }],
|
||||
"max-line-length": ["error", 120],
|
||||
"not-rely-on-time": "off",
|
||||
"prettier/prettier": [
|
||||
"error",
|
||||
{
|
||||
"endOfLine": "auto"
|
||||
}
|
||||
],
|
||||
"reason-string": ["warn", { "maxLength": 64 }]
|
||||
}
|
||||
}
|
|
@ -0,0 +1,3 @@
|
|||
# directories
|
||||
**/lib
|
||||
**/node_modules
|
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
@ -0,0 +1,7 @@
|
|||
nodeLinker: "node-modules"
|
||||
|
||||
plugins:
|
||||
- path: ".yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs"
|
||||
spec: "@yarnpkg/plugin-interactive-tools"
|
||||
|
||||
yarnPath: ".yarn/releases/yarn-3.2.1.cjs"
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2022 Paul Razvan Berg
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
|
@ -0,0 +1,166 @@
|
|||
# Foundry Template [![Github Actions][gha-badge]][gha] [![Foundry][foundry-badge]][foundry] [![License: MIT][license-badge]][license]
|
||||
|
||||
[gha]: https://github.com/paulrberg/foundry-template/actions
|
||||
[gha-badge]: https://github.com/paulrberg/foundry-template/actions/workflows/ci.yml/badge.svg
|
||||
[foundry]: https://getfoundry.sh/
|
||||
[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
|
||||
[license]: https://opensource.org/licenses/MIT
|
||||
[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg
|
||||
|
||||
A Foundry-based template for developing Solidity smart contracts, with sensible defaults.
|
||||
|
||||
## What's Inside
|
||||
|
||||
- [Forge](https://github.com/foundry-rs/foundry/blob/master/forge): compile and test smart contracts
|
||||
- [PRBTest](https://github.com/paulrberg/prb-math): modern collection of testing assertions and logging utilities
|
||||
- [Forge Std](https://github.com/foundry-rs/forge-std): collection of helpful contracts and cheatcodes for testing
|
||||
- [Solhint](https://github.com/protofire/solhint): code linter
|
||||
- [Prettier Plugin Solidity](https://github.com/prettier-solidity/prettier-plugin-solidity): code formatter
|
||||
|
||||
## Getting Started
|
||||
|
||||
Click the [`Use this template`](https://github.com/paulrberg/foundry-template/generate) button at the top of the page to create a new repository with this repo as the initial state.
|
||||
|
||||
Or, if you prefer to install the template manually:
|
||||
|
||||
```sh
|
||||
forge init my-project --template https://github.com/paulrberg/foundry-template
|
||||
cd my-project
|
||||
yarn install # install solhint and prettier and other goodies
|
||||
```
|
||||
|
||||
If this is your first time with Foundry, check out the [installation](https://github.com/foundry-rs/foundry#installation) instructions.
|
||||
|
||||
## Features
|
||||
|
||||
This template builds upon the frameworks and libraries mentioned above, so for details about their specific features, please consult their respective documentations.
|
||||
|
||||
For example, for Foundry, you can refer to the [Foundry Book](https://book.getfoundry.sh/). You might be in particular interested in reading the [Writing Tests](https://book.getfoundry.sh/forge/writing-tests.html) guide.
|
||||
|
||||
### Sensible Defaults
|
||||
|
||||
This template comes with sensible default configurations in the following files:
|
||||
|
||||
```text
|
||||
├── .commitlintrc.yml
|
||||
├── .editorconfig
|
||||
├── .gitignore
|
||||
├── .prettierignore
|
||||
├── .prettierrc.yml
|
||||
├── .solhintignore
|
||||
├── .solhint.json
|
||||
├── .yarnrc.yml
|
||||
├── foundry.toml
|
||||
└── remappings.txt
|
||||
```
|
||||
|
||||
### GitHub Actions
|
||||
|
||||
This template comes with GitHub Actions pre-configured. Your contracts will be linted and tested on every push and pull
|
||||
request made to the `main` branch.
|
||||
|
||||
You can edit the CI script in [.github/workflows/ci.yml](./.github/workflows/ci.yml).
|
||||
|
||||
### Conventional Commits
|
||||
|
||||
This template enforces the [Conventional Commits](https://www.conventionalcommits.org/) standard for git commit messages.
|
||||
This is a lightweight convention that creates an explicit commit history, which makes it easier to write automated
|
||||
tools on top of.
|
||||
|
||||
### Git Hooks
|
||||
|
||||
This template uses [Husky](https://github.com/typicode/husky) to run automated checks on commit messages, and [Lint Staged](https://github.com/okonet/lint-staged) to automatically format the code with Prettier when making a git commit.
|
||||
|
||||
## Writing Tests
|
||||
|
||||
To write a new test contract, you start by importing [PRBTest](https://github.com/paulrberg/prb-test) and inherit from it in your test contract. PRBTest comes with a
|
||||
pre-instantiated [cheatcodes](https://book.getfoundry.sh/cheatcodes/) environment accessible via the `vm` property. You can also use [console.log](https://book.getfoundry.sh/faq?highlight=console.log#how-do-i-use-consolelog), whose logs you can see in the terminal output by adding the `-vvvv` flag.
|
||||
|
||||
This template comes with an example test contract [Foo.t.sol](./test/Foo.t.sol).
|
||||
|
||||
## Usage
|
||||
|
||||
Here's a list of the most frequently needed commands.
|
||||
|
||||
### Build
|
||||
|
||||
Build the contracts:
|
||||
|
||||
```sh
|
||||
$ forge build
|
||||
```
|
||||
|
||||
### Clean
|
||||
|
||||
Delete the build artifacts and cache directories:
|
||||
|
||||
```sh
|
||||
$ forge clean
|
||||
```
|
||||
|
||||
### Compile
|
||||
|
||||
Compile the contracts:
|
||||
|
||||
```sh
|
||||
$ forge build
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
||||
Deploy to Anvil:
|
||||
|
||||
```sh
|
||||
$ forge script script/Foo.s.sol:FooScript --fork-url http://localhost:8545 \
|
||||
--broadcast --private-key $PRIVATE_KEY
|
||||
```
|
||||
|
||||
For instructions on how to deploy to a testnet or mainnet, check out the [Solidity Scripting tutorial](https://book.getfoundry.sh/tutorials/solidity-scripting.html).
|
||||
|
||||
### Format
|
||||
|
||||
Format the contracts with Prettier:
|
||||
|
||||
```sh
|
||||
$ yarn prettier
|
||||
```
|
||||
|
||||
### Gas Usage
|
||||
|
||||
Get a gas report:
|
||||
|
||||
```sh
|
||||
$ forge test --gas-report
|
||||
```
|
||||
|
||||
### Lint
|
||||
|
||||
Lint the contracts:
|
||||
|
||||
```sh
|
||||
$ yarn lint
|
||||
```
|
||||
|
||||
### Test
|
||||
|
||||
Run the tests:
|
||||
|
||||
```sh
|
||||
$ forge test
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
1. Foundry piggybacks off [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to manage dependencies. There's a [guide](https://book.getfoundry.sh/projects/dependencies.html) about how to work with dependencies in the book.
|
||||
2. You don't have to create a `.env` file, but filling in the environment variables may be useful when debugging and testing against a mainnet fork.
|
||||
|
||||
## Related Efforts
|
||||
|
||||
- [abigger87/femplate](https://github.com/abigger87/femplate)
|
||||
- [cleanunicorn/ethereum-smartcontract-template](https://github.com/cleanunicorn/ethereum-smartcontract-template)
|
||||
- [foundry-rs/forge-template](https://github.com/foundry-rs/forge-template)
|
||||
- [FrankieIsLost/forge-template](https://github.com/FrankieIsLost/forge-template)
|
||||
|
||||
## License
|
||||
|
||||
[MIT](./LICENSE.md) © Paul Razvan Berg
|
|
@ -0,0 +1,17 @@
|
|||
# Full reference https://github.com/foundry-rs/foundry/tree/master/config
|
||||
|
||||
[profile.default]
|
||||
auto_detect_solc = false
|
||||
fuzz_runs = 256
|
||||
libs = ["lib"]
|
||||
gas_reports = ["*"]
|
||||
optimizer = true
|
||||
optimizer_runs = 10_000
|
||||
out = "out"
|
||||
solc = "0.8.15"
|
||||
src = "src"
|
||||
test = "test"
|
||||
|
||||
[profile.ci]
|
||||
fuzz_runs = 10_000
|
||||
verbosity = 4
|
|
@ -0,0 +1,26 @@
|
|||
name: Tests
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
check:
|
||||
name: Foundry project
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
- name: Install Foundry
|
||||
uses: onbjerg/foundry-toolchain@v1
|
||||
with:
|
||||
version: nightly
|
||||
|
||||
- name: Install dependencies
|
||||
run: forge install
|
||||
- name: Run tests
|
||||
run: forge test -vvv
|
||||
- name: Build Test with older solc versions
|
||||
run: |
|
||||
forge build --contracts src/Test.sol --use solc:0.8.0
|
||||
forge build --contracts src/Test.sol --use solc:0.7.0
|
||||
forge build --contracts src/Test.sol --use solc:0.6.0
|
|
@ -0,0 +1,4 @@
|
|||
cache/
|
||||
out/
|
||||
.vscode
|
||||
.idea
|
|
@ -0,0 +1,3 @@
|
|||
[submodule "lib/ds-test"]
|
||||
path = lib/ds-test
|
||||
url = https://github.com/dapphub/ds-test
|
|
@ -0,0 +1,203 @@
|
|||
Copyright (c) 2021 Brock Elmore
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
|
@ -0,0 +1,25 @@
|
|||
Copyright (c) 2021 Brock Elmore
|
||||
|
||||
Permission is hereby granted, free of charge, to any
|
||||
person obtaining a copy of this software and associated
|
||||
documentation files (the "Software"), to deal in the
|
||||
Software without restriction, including without
|
||||
limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software
|
||||
is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice
|
||||
shall be included in all copies or substantial portions
|
||||
of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
|
||||
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
|
||||
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
|
||||
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
|
||||
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
|
||||
IN CONNECTION WITH THE SOFTWARE O THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.R
|
|
@ -0,0 +1,246 @@
|
|||
# Forge Standard Library • [![tests](https://github.com/brockelmore/forge-std/actions/workflows/tests.yml/badge.svg)](https://github.com/brockelmore/forge-std/actions/workflows/tests.yml)
|
||||
|
||||
Forge Standard Library is a collection of helpful contracts 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.
|
||||
|
||||
**Learn how to use Forge Std with the [📖 Foundry Book (Forge Std Guide)](https://book.getfoundry.sh/forge/forge-std.html).**
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
forge install foundry-rs/forge-std
|
||||
```
|
||||
|
||||
## Contracts
|
||||
### stdError
|
||||
|
||||
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.
|
||||
|
||||
See the contract itself for all error codes.
|
||||
|
||||
#### Example usage
|
||||
|
||||
```solidity
|
||||
|
||||
import "forge-std/Test.sol";
|
||||
|
||||
contract TestContract is Test {
|
||||
ErrorsTest test;
|
||||
|
||||
function setUp() public {
|
||||
test = new ErrorsTest();
|
||||
}
|
||||
|
||||
function testExpectArithmetic() public {
|
||||
vm.expectRevert(stdError.arithmeticError);
|
||||
test.arithmeticError(10);
|
||||
}
|
||||
}
|
||||
|
||||
contract ErrorsTest {
|
||||
function arithmeticError(uint256 a) public {
|
||||
uint256 a = a - 100;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### stdStorage
|
||||
|
||||
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)`).
|
||||
|
||||
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.
|
||||
|
||||
I.e.:
|
||||
```solidity
|
||||
struct T {
|
||||
// depth 0
|
||||
uint256 a;
|
||||
// depth 1
|
||||
uint256 b;
|
||||
}
|
||||
```
|
||||
|
||||
#### Example usage
|
||||
|
||||
```solidity
|
||||
import "forge-std/Test.sol";
|
||||
|
||||
contract TestContract is Test {
|
||||
using stdStorage for StdStorage;
|
||||
|
||||
Storage test;
|
||||
|
||||
function setUp() public {
|
||||
test = new Storage();
|
||||
}
|
||||
|
||||
function testFindExists() public {
|
||||
// Lets say we want to find the slot for the public
|
||||
// variable `exists`. We just pass in the function selector
|
||||
// to the `find` command
|
||||
uint256 slot = stdstore.target(address(test)).sig("exists()").find();
|
||||
assertEq(slot, 0);
|
||||
}
|
||||
|
||||
function testWriteExists() public {
|
||||
// Lets say we want to write to the slot for the public
|
||||
// variable `exists`. We just pass in the function selector
|
||||
// to the `checked_write` command
|
||||
stdstore.target(address(test)).sig("exists()").checked_write(100);
|
||||
assertEq(test.exists(), 100);
|
||||
}
|
||||
|
||||
// It supports arbitrary storage layouts, like assembly based storage locations
|
||||
function testFindHidden() public {
|
||||
// `hidden` is a random hash of a bytes, iteration through slots would
|
||||
// not find it. Our mechanism does
|
||||
// Also, you can use the selector instead of a string
|
||||
uint256 slot = stdstore.target(address(test)).sig(test.hidden.selector).find();
|
||||
assertEq(slot, uint256(keccak256("my.random.var")));
|
||||
}
|
||||
|
||||
// If targeting a mapping, you have to pass in the keys necessary to perform the find
|
||||
// i.e.:
|
||||
function testFindMapping() public {
|
||||
uint256 slot = stdstore
|
||||
.target(address(test))
|
||||
.sig(test.map_addr.selector)
|
||||
.with_key(address(this))
|
||||
.find();
|
||||
// in the `Storage` constructor, we wrote that this address' value was 1 in the map
|
||||
// so when we load the slot, we expect it to be 1
|
||||
assertEq(uint(vm.load(address(test), bytes32(slot))), 1);
|
||||
}
|
||||
|
||||
// If the target is a struct, you can specify the field depth:
|
||||
function testFindStruct() public {
|
||||
// NOTE: see the depth parameter - 0 means 0th field, 1 means 1st field, etc.
|
||||
uint256 slot_for_a_field = stdstore
|
||||
.target(address(test))
|
||||
.sig(test.basicStruct.selector)
|
||||
.depth(0)
|
||||
.find();
|
||||
|
||||
uint256 slot_for_b_field = stdstore
|
||||
.target(address(test))
|
||||
.sig(test.basicStruct.selector)
|
||||
.depth(1)
|
||||
.find();
|
||||
|
||||
assertEq(uint(vm.load(address(test), bytes32(slot_for_a_field))), 1);
|
||||
assertEq(uint(vm.load(address(test), bytes32(slot_for_b_field))), 2);
|
||||
}
|
||||
}
|
||||
|
||||
// A complex storage contract
|
||||
contract Storage {
|
||||
struct UnpackedStruct {
|
||||
uint256 a;
|
||||
uint256 b;
|
||||
}
|
||||
|
||||
constructor() {
|
||||
map_addr[msg.sender] = 1;
|
||||
}
|
||||
|
||||
uint256 public exists = 1;
|
||||
mapping(address => uint256) public map_addr;
|
||||
// mapping(address => Packed) public map_packed;
|
||||
mapping(address => UnpackedStruct) public map_struct;
|
||||
mapping(address => mapping(address => uint256)) public deep_map;
|
||||
mapping(address => mapping(address => UnpackedStruct)) public deep_map_struct;
|
||||
UnpackedStruct public basicStruct = UnpackedStruct({
|
||||
a: 1,
|
||||
b: 2
|
||||
});
|
||||
|
||||
function hidden() public view returns (bytes32 t) {
|
||||
// an extremely hidden storage slot
|
||||
bytes32 slot = keccak256("my.random.var");
|
||||
assembly {
|
||||
t := sload(slot)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### stdCheats
|
||||
|
||||
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.
|
||||
|
||||
|
||||
#### Example usage:
|
||||
```solidity
|
||||
|
||||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity ^0.8.0;
|
||||
|
||||
import "forge-std/Test.sol";
|
||||
|
||||
// Inherit the stdCheats
|
||||
contract StdCheatsTest is Test {
|
||||
Bar test;
|
||||
function setUp() public {
|
||||
test = new Bar();
|
||||
}
|
||||
|
||||
function testHoax() public {
|
||||
// we call `hoax`, which gives the target address
|
||||
// eth and then calls `prank`
|
||||
hoax(address(1337));
|
||||
test.bar{value: 100}(address(1337));
|
||||
|
||||
// overloaded to allow you to specify how much eth to
|
||||
// initialize the address with
|
||||
hoax(address(1337), 1);
|
||||
test.bar{value: 1}(address(1337));
|
||||
}
|
||||
|
||||
function testStartHoax() public {
|
||||
// we call `startHoax`, which gives the target address
|
||||
// eth and then calls `startPrank`
|
||||
//
|
||||
// it is also overloaded so that you can specify an eth amount
|
||||
startHoax(address(1337));
|
||||
test.bar{value: 100}(address(1337));
|
||||
test.bar{value: 100}(address(1337));
|
||||
vm.stopPrank();
|
||||
test.bar(address(this));
|
||||
}
|
||||
}
|
||||
|
||||
contract Bar {
|
||||
function bar(address expectedSender) public payable {
|
||||
require(msg.sender == expectedSender, "!prank");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Std Assertions
|
||||
|
||||
Expand upon the assertion functions from the `DSTest` library.
|
||||
|
||||
### `console.log`
|
||||
|
||||
Usage follows the same format as [Hardhat](https://hardhat.org/hardhat-network/reference/#console-log).
|
||||
It's recommended to use `console2.sol` as shown below, as this will show the decoded logs in Forge traces.
|
||||
|
||||
```solidity
|
||||
// import it indirectly via Test.sol
|
||||
import "forge-std/Test.sol";
|
||||
// or directly import it
|
||||
import "forge-std/console2.sol";
|
||||
...
|
||||
console2.log(someValue);
|
||||
```
|
||||
|
||||
If you need compatibility with Hardhat, you must use the standard `console.sol` instead.
|
||||
Due to a bug in `console.sol`, logs that use `uint256` or `int256` types will not be properly decoded in Forge traces.
|
||||
|
||||
```solidity
|
||||
// import it indirectly via Test.sol
|
||||
import "forge-std/Test.sol";
|
||||
// or directly import it
|
||||
import "forge-std/console.sol";
|
||||
...
|
||||
console.log(someValue);
|
||||
```
|
|
@ -0,0 +1,3 @@
|
|||
/.dapple
|
||||
/build
|
||||
/out
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
@ -0,0 +1,14 @@
|
|||
all:; dapp build
|
||||
|
||||
test:
|
||||
-dapp --use solc:0.4.23 build
|
||||
-dapp --use solc:0.4.26 build
|
||||
-dapp --use solc:0.5.17 build
|
||||
-dapp --use solc:0.6.12 build
|
||||
-dapp --use solc:0.7.5 build
|
||||
|
||||
demo:
|
||||
DAPP_SRC=demo dapp --use solc:0.7.5 build
|
||||
-hevm dapp-test --verbose 3
|
||||
|
||||
.PHONY: test demo
|
|
@ -0,0 +1,4 @@
|
|||
{ solidityPackage, dappsys }: solidityPackage {
|
||||
name = "ds-test";
|
||||
src = ./src;
|
||||
}
|
|
@ -0,0 +1,222 @@
|
|||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
pragma solidity >=0.5.0;
|
||||
|
||||
import "../src/test.sol";
|
||||
|
||||
contract DemoTest is DSTest {
|
||||
function test_this() public pure {
|
||||
require(true);
|
||||
}
|
||||
function test_logs() public {
|
||||
emit log("-- log(string)");
|
||||
emit log("a string");
|
||||
|
||||
emit log("-- log_named_uint(string, uint)");
|
||||
emit log_named_uint("uint", 512);
|
||||
|
||||
emit log("-- log_named_int(string, int)");
|
||||
emit log_named_int("int", -512);
|
||||
|
||||
emit log("-- log_named_address(string, address)");
|
||||
emit log_named_address("address", address(this));
|
||||
|
||||
emit log("-- log_named_bytes32(string, bytes32)");
|
||||
emit log_named_bytes32("bytes32", "a string");
|
||||
|
||||
emit log("-- log_named_bytes(string, bytes)");
|
||||
emit log_named_bytes("bytes", hex"cafefe");
|
||||
|
||||
emit log("-- log_named_string(string, string)");
|
||||
emit log_named_string("string", "a string");
|
||||
|
||||
emit log("-- log_named_decimal_uint(string, uint, uint)");
|
||||
emit log_named_decimal_uint("decimal uint", 1.0e18, 18);
|
||||
|
||||
emit log("-- log_named_decimal_int(string, int, uint)");
|
||||
emit log_named_decimal_int("decimal int", -1.0e18, 18);
|
||||
}
|
||||
event log_old_named_uint(bytes32,uint);
|
||||
function test_old_logs() public {
|
||||
emit log_old_named_uint("key", 500);
|
||||
emit log_named_bytes32("bkey", "val");
|
||||
}
|
||||
function test_trace() public view {
|
||||
this.echo("string 1", "string 2");
|
||||
}
|
||||
function test_multiline() public {
|
||||
emit log("a multiline\\nstring");
|
||||
emit log("a multiline string");
|
||||
emit log_bytes("a string");
|
||||
emit log_bytes("a multiline\nstring");
|
||||
emit log_bytes("a multiline\\nstring");
|
||||
emit logs(hex"0000");
|
||||
emit log_named_bytes("0x0000", hex"0000");
|
||||
emit logs(hex"ff");
|
||||
}
|
||||
function echo(string memory s1, string memory s2) public pure
|
||||
returns (string memory, string memory)
|
||||
{
|
||||
return (s1, s2);
|
||||
}
|
||||
|
||||
function prove_this(uint x) public {
|
||||
emit log_named_uint("sym x", x);
|
||||
assertGt(x + 1, 0);
|
||||
}
|
||||
|
||||
function test_logn() public {
|
||||
assembly {
|
||||
log0(0x01, 0x02)
|
||||
log1(0x01, 0x02, 0x03)
|
||||
log2(0x01, 0x02, 0x03, 0x04)
|
||||
log3(0x01, 0x02, 0x03, 0x04, 0x05)
|
||||
}
|
||||
}
|
||||
|
||||
event MyEvent(uint, uint indexed, uint, uint indexed);
|
||||
function test_events() public {
|
||||
emit MyEvent(1, 2, 3, 4);
|
||||
}
|
||||
|
||||
function test_asserts() public {
|
||||
string memory err = "this test has failed!";
|
||||
emit log("## assertTrue(bool)\n");
|
||||
assertTrue(false);
|
||||
emit log("\n");
|
||||
assertTrue(false, err);
|
||||
|
||||
emit log("\n## assertEq(address,address)\n");
|
||||
assertEq(address(this), msg.sender);
|
||||
emit log("\n");
|
||||
assertEq(address(this), msg.sender, err);
|
||||
|
||||
emit log("\n## assertEq32(bytes32,bytes32)\n");
|
||||
assertEq32("bytes 1", "bytes 2");
|
||||
emit log("\n");
|
||||
assertEq32("bytes 1", "bytes 2", err);
|
||||
|
||||
emit log("\n## assertEq(bytes32,bytes32)\n");
|
||||
assertEq32("bytes 1", "bytes 2");
|
||||
emit log("\n");
|
||||
assertEq32("bytes 1", "bytes 2", err);
|
||||
|
||||
emit log("\n## assertEq(uint,uint)\n");
|
||||
assertEq(uint(0), 1);
|
||||
emit log("\n");
|
||||
assertEq(uint(0), 1, err);
|
||||
|
||||
emit log("\n## assertEq(int,int)\n");
|
||||
assertEq(-1, -2);
|
||||
emit log("\n");
|
||||
assertEq(-1, -2, err);
|
||||
|
||||
emit log("\n## assertEqDecimal(int,int,uint)\n");
|
||||
assertEqDecimal(-1.0e18, -1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertEqDecimal(-1.0e18, -1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertEqDecimal(uint,uint,uint)\n");
|
||||
assertEqDecimal(uint(1.0e18), 1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertEqDecimal(uint(1.0e18), 1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertGt(uint,uint)\n");
|
||||
assertGt(uint(0), 0);
|
||||
emit log("\n");
|
||||
assertGt(uint(0), 0, err);
|
||||
|
||||
emit log("\n## assertGt(int,int)\n");
|
||||
assertGt(-1, -1);
|
||||
emit log("\n");
|
||||
assertGt(-1, -1, err);
|
||||
|
||||
emit log("\n## assertGtDecimal(int,int,uint)\n");
|
||||
assertGtDecimal(-2.0e18, -1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertGtDecimal(-2.0e18, -1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertGtDecimal(uint,uint,uint)\n");
|
||||
assertGtDecimal(uint(1.0e18), 1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertGtDecimal(uint(1.0e18), 1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertGe(uint,uint)\n");
|
||||
assertGe(uint(0), 1);
|
||||
emit log("\n");
|
||||
assertGe(uint(0), 1, err);
|
||||
|
||||
emit log("\n## assertGe(int,int)\n");
|
||||
assertGe(-1, 0);
|
||||
emit log("\n");
|
||||
assertGe(-1, 0, err);
|
||||
|
||||
emit log("\n## assertGeDecimal(int,int,uint)\n");
|
||||
assertGeDecimal(-2.0e18, -1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertGeDecimal(-2.0e18, -1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertGeDecimal(uint,uint,uint)\n");
|
||||
assertGeDecimal(uint(1.0e18), 1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertGeDecimal(uint(1.0e18), 1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertLt(uint,uint)\n");
|
||||
assertLt(uint(0), 0);
|
||||
emit log("\n");
|
||||
assertLt(uint(0), 0, err);
|
||||
|
||||
emit log("\n## assertLt(int,int)\n");
|
||||
assertLt(-1, -1);
|
||||
emit log("\n");
|
||||
assertLt(-1, -1, err);
|
||||
|
||||
emit log("\n## assertLtDecimal(int,int,uint)\n");
|
||||
assertLtDecimal(-1.0e18, -1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertLtDecimal(-1.0e18, -1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertLtDecimal(uint,uint,uint)\n");
|
||||
assertLtDecimal(uint(2.0e18), 1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertLtDecimal(uint(2.0e18), 1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertLe(uint,uint)\n");
|
||||
assertLe(uint(1), 0);
|
||||
emit log("\n");
|
||||
assertLe(uint(1), 0, err);
|
||||
|
||||
emit log("\n## assertLe(int,int)\n");
|
||||
assertLe(0, -1);
|
||||
emit log("\n");
|
||||
assertLe(0, -1, err);
|
||||
|
||||
emit log("\n## assertLeDecimal(int,int,uint)\n");
|
||||
assertLeDecimal(-1.0e18, -1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertLeDecimal(-1.0e18, -1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertLeDecimal(uint,uint,uint)\n");
|
||||
assertLeDecimal(uint(2.0e18), 1.1e18, 18);
|
||||
emit log("\n");
|
||||
assertLeDecimal(uint(2.0e18), 1.1e18, 18, err);
|
||||
|
||||
emit log("\n## assertEq(string,string)\n");
|
||||
string memory s1 = "string 1";
|
||||
string memory s2 = "string 2";
|
||||
assertEq(s1, s2);
|
||||
emit log("\n");
|
||||
assertEq(s1, s2, err);
|
||||
|
||||
emit log("\n## assertEq0(bytes,bytes)\n");
|
||||
assertEq0(hex"abcdef01", hex"abcdef02");
|
||||
emit log("\n");
|
||||
assertEq0(hex"abcdef01", hex"abcdef02", err);
|
||||
}
|
||||
}
|
||||
|
||||
contract DemoTestWithSetUp {
|
||||
function setUp() public {
|
||||
}
|
||||
function test_pass() public pure {
|
||||
}
|
||||
}
|
|
@ -0,0 +1,664 @@
|
|||
// SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
pragma solidity >=0.5.0;
|
||||
|
||||
contract DSTest {
|
||||
event log(string);
|
||||
event logs(bytes);
|
||||
|
||||
event log_address(address);
|
||||
event log_bytes32(bytes32);
|
||||
event log_int(int256);
|
||||
event log_uint(uint256);
|
||||
event log_bytes(bytes);
|
||||
event log_string(string);
|
||||
|
||||
event log_named_address(string key, address val);
|
||||
event log_named_bytes32(string key, bytes32 val);
|
||||
event log_named_decimal_int(string key, int256 val, uint256 decimals);
|
||||
event log_named_decimal_uint(string key, uint256 val, uint256 decimals);
|
||||
event log_named_int(string key, int256 val);
|
||||
event log_named_uint(string key, uint256 val);
|
||||
event log_named_bytes(string key, bytes val);
|
||||
event log_named_string(string key, string val);
|
||||
|
||||
bool public IS_TEST = true;
|
||||
bool private _failed;
|
||||
|
||||
address constant HEVM_ADDRESS = address(bytes20(uint160(uint256(keccak256("hevm cheat code")))));
|
||||
|
||||
modifier mayRevert() {
|
||||
_;
|
||||
}
|
||||
modifier testopts(string memory) {
|
||||
_;
|
||||
}
|
||||
|
||||
function failed() public returns (bool) {
|
||||
if (_failed) {
|
||||
return _failed;
|
||||
} else {
|
||||
bool globalFailed = false;
|
||||
if (hasHEVMContext()) {
|
||||
(, bytes memory retdata) = HEVM_ADDRESS.call(
|
||||
abi.encodePacked(
|
||||
bytes4(keccak256("load(address,bytes32)")),
|
||||
abi.encode(HEVM_ADDRESS, bytes32("failed"))
|
||||
)
|
||||
);
|
||||
globalFailed = abi.decode(retdata, (bool));
|
||||
}
|
||||
return globalFailed;
|
||||
}
|
||||
}
|
||||
|
||||
function fail() internal {
|
||||
if (hasHEVMContext()) {
|
||||
(bool status, ) = HEVM_ADDRESS.call(
|
||||
abi.encodePacked(
|
||||
bytes4(keccak256("store(address,bytes32,bytes32)")),
|
||||
abi.encode(HEVM_ADDRESS, bytes32("failed"), bytes32(uint256(0x01)))
|
||||
)
|
||||
);
|
||||
status; // Silence compiler warnings
|
||||
}
|
||||
_failed = true;
|
||||
}
|
||||
|
||||
function hasHEVMContext() internal view returns (bool) {
|
||||
uint256 hevmCodeSize = 0;
|
||||
assembly {
|
||||
hevmCodeSize := extcodesize(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D)
|
||||
}
|
||||
return hevmCodeSize > 0;
|
||||
}
|
||||
|
||||
modifier logs_gas() {
|
||||
uint256 startGas = gasleft();
|
||||
_;
|
||||
uint256 endGas = gasleft();
|
||||
emit log_named_uint("gas", startGas - endGas);
|
||||
}
|
||||
|
||||
function assertTrue(bool condition) internal {
|
||||
if (!condition) {
|
||||
emit log("Error: Assertion Failed");
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertTrue(bool condition, string memory err) internal {
|
||||
if (!condition) {
|
||||
emit log_named_string("Error", err);
|
||||
assertTrue(condition);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(address a, address b) internal {
|
||||
if (a != b) {
|
||||
emit log("Error: a == b not satisfied [address]");
|
||||
emit log_named_address(" Expected", b);
|
||||
emit log_named_address(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(
|
||||
address a,
|
||||
address b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a != b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(bytes32 a, bytes32 b) internal {
|
||||
if (a != b) {
|
||||
emit log("Error: a == b not satisfied [bytes32]");
|
||||
emit log_named_bytes32(" Expected", b);
|
||||
emit log_named_bytes32(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(
|
||||
bytes32 a,
|
||||
bytes32 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a != b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq32(bytes32 a, bytes32 b) internal {
|
||||
assertEq(a, b);
|
||||
}
|
||||
|
||||
function assertEq32(
|
||||
bytes32 a,
|
||||
bytes32 b,
|
||||
string memory err
|
||||
) internal {
|
||||
assertEq(a, b, err);
|
||||
}
|
||||
|
||||
function assertEq(int256 a, int256 b) internal {
|
||||
if (a != b) {
|
||||
emit log("Error: a == b not satisfied [int]");
|
||||
emit log_named_int(" Expected", b);
|
||||
emit log_named_int(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(
|
||||
int256 a,
|
||||
int256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a != b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(uint256 a, uint256 b) internal {
|
||||
if (a != b) {
|
||||
emit log("Error: a == b not satisfied [uint]");
|
||||
emit log_named_uint(" Expected", b);
|
||||
emit log_named_uint(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a != b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEqDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a != b) {
|
||||
emit log("Error: a == b not satisfied [decimal int]");
|
||||
emit log_named_decimal_int(" Expected", b, decimals);
|
||||
emit log_named_decimal_int(" Actual", a, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEqDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a != b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEqDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEqDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a != b) {
|
||||
emit log("Error: a == b not satisfied [decimal uint]");
|
||||
emit log_named_decimal_uint(" Expected", b, decimals);
|
||||
emit log_named_decimal_uint(" Actual", a, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEqDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a != b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEqDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertGt(uint256 a, uint256 b) internal {
|
||||
if (a <= b) {
|
||||
emit log("Error: a > b not satisfied [uint]");
|
||||
emit log_named_uint(" Value a", a);
|
||||
emit log_named_uint(" Value b", b);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertGt(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a <= b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGt(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertGt(int256 a, int256 b) internal {
|
||||
if (a <= b) {
|
||||
emit log("Error: a > b not satisfied [int]");
|
||||
emit log_named_int(" Value a", a);
|
||||
emit log_named_int(" Value b", b);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertGt(
|
||||
int256 a,
|
||||
int256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a <= b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGt(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertGtDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a <= b) {
|
||||
emit log("Error: a > b not satisfied [decimal int]");
|
||||
emit log_named_decimal_int(" Value a", a, decimals);
|
||||
emit log_named_decimal_int(" Value b", b, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertGtDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a <= b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGtDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertGtDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a <= b) {
|
||||
emit log("Error: a > b not satisfied [decimal uint]");
|
||||
emit log_named_decimal_uint(" Value a", a, decimals);
|
||||
emit log_named_decimal_uint(" Value b", b, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertGtDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a <= b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGtDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertGe(uint256 a, uint256 b) internal {
|
||||
if (a < b) {
|
||||
emit log("Error: a >= b not satisfied [uint]");
|
||||
emit log_named_uint(" Value a", a);
|
||||
emit log_named_uint(" Value b", b);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertGe(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a < b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGe(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertGe(int256 a, int256 b) internal {
|
||||
if (a < b) {
|
||||
emit log("Error: a >= b not satisfied [int]");
|
||||
emit log_named_int(" Value a", a);
|
||||
emit log_named_int(" Value b", b);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertGe(
|
||||
int256 a,
|
||||
int256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a < b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGe(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertGeDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a < b) {
|
||||
emit log("Error: a >= b not satisfied [decimal int]");
|
||||
emit log_named_decimal_int(" Value a", a, decimals);
|
||||
emit log_named_decimal_int(" Value b", b, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertGeDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a < b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGeDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertGeDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a < b) {
|
||||
emit log("Error: a >= b not satisfied [decimal uint]");
|
||||
emit log_named_decimal_uint(" Value a", a, decimals);
|
||||
emit log_named_decimal_uint(" Value b", b, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertGeDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a < b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGeDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertLt(uint256 a, uint256 b) internal {
|
||||
if (a >= b) {
|
||||
emit log("Error: a < b not satisfied [uint]");
|
||||
emit log_named_uint(" Value a", a);
|
||||
emit log_named_uint(" Value b", b);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertLt(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a >= b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertLt(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertLt(int256 a, int256 b) internal {
|
||||
if (a >= b) {
|
||||
emit log("Error: a < b not satisfied [int]");
|
||||
emit log_named_int(" Value a", a);
|
||||
emit log_named_int(" Value b", b);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertLt(
|
||||
int256 a,
|
||||
int256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a >= b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertLt(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertLtDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a >= b) {
|
||||
emit log("Error: a < b not satisfied [decimal int]");
|
||||
emit log_named_decimal_int(" Value a", a, decimals);
|
||||
emit log_named_decimal_int(" Value b", b, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertLtDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a >= b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertLtDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertLtDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a >= b) {
|
||||
emit log("Error: a < b not satisfied [decimal uint]");
|
||||
emit log_named_decimal_uint(" Value a", a, decimals);
|
||||
emit log_named_decimal_uint(" Value b", b, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertLtDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a >= b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertLtDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertLe(uint256 a, uint256 b) internal {
|
||||
if (a > b) {
|
||||
emit log("Error: a <= b not satisfied [uint]");
|
||||
emit log_named_uint(" Value a", a);
|
||||
emit log_named_uint(" Value b", b);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertLe(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a > b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertLe(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertLe(int256 a, int256 b) internal {
|
||||
if (a > b) {
|
||||
emit log("Error: a <= b not satisfied [int]");
|
||||
emit log_named_int(" Value a", a);
|
||||
emit log_named_int(" Value b", b);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertLe(
|
||||
int256 a,
|
||||
int256 b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a > b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertLe(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertLeDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a > b) {
|
||||
emit log("Error: a <= b not satisfied [decimal int]");
|
||||
emit log_named_decimal_int(" Value a", a, decimals);
|
||||
emit log_named_decimal_int(" Value b", b, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertLeDecimal(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a > b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertLeDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertLeDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals
|
||||
) internal {
|
||||
if (a > b) {
|
||||
emit log("Error: a <= b not satisfied [decimal uint]");
|
||||
emit log_named_decimal_uint(" Value a", a, decimals);
|
||||
emit log_named_decimal_uint(" Value b", b, decimals);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertLeDecimal(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 decimals,
|
||||
string memory err
|
||||
) internal {
|
||||
if (a > b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertGeDecimal(a, b, decimals);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(string memory a, string memory b) internal {
|
||||
if (keccak256(abi.encodePacked(a)) != keccak256(abi.encodePacked(b))) {
|
||||
emit log("Error: a == b not satisfied [string]");
|
||||
emit log_named_string(" Expected", b);
|
||||
emit log_named_string(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(
|
||||
string memory a,
|
||||
string memory b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (keccak256(abi.encodePacked(a)) != keccak256(abi.encodePacked(b))) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function checkEq0(bytes memory a, bytes memory b) internal pure returns (bool ok) {
|
||||
ok = true;
|
||||
if (a.length == b.length) {
|
||||
for (uint256 i = 0; i < a.length; i++) {
|
||||
if (a[i] != b[i]) {
|
||||
ok = false;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
ok = false;
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq0(bytes memory a, bytes memory b) internal {
|
||||
if (!checkEq0(a, b)) {
|
||||
emit log("Error: a == b not satisfied [bytes]");
|
||||
emit log_named_bytes(" Expected", b);
|
||||
emit log_named_bytes(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq0(
|
||||
bytes memory a,
|
||||
bytes memory b,
|
||||
string memory err
|
||||
) internal {
|
||||
if (!checkEq0(a, b)) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq0(a, b);
|
||||
}
|
||||
}
|
||||
}
|
|
@ -0,0 +1,39 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.6.0 <0.9.0;
|
||||
|
||||
import "./Vm.sol";
|
||||
import "./console.sol";
|
||||
import "./console2.sol";
|
||||
|
||||
abstract contract Script {
|
||||
bool public IS_SCRIPT = true;
|
||||
address constant private VM_ADDRESS =
|
||||
address(bytes20(uint160(uint256(keccak256('hevm cheat code')))));
|
||||
|
||||
Vm public constant vm = Vm(VM_ADDRESS);
|
||||
|
||||
/// @dev Compute the address a contract will be deployed at for a given deployer address and nonce
|
||||
/// @notice adapated from Solmate implementation (https://github.com/Rari-Capital/solmate/blob/main/src/utils/LibRLP.sol)
|
||||
function computeCreateAddress(address deployer, uint256 nonce) internal pure returns (address) {
|
||||
// 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.
|
||||
// A one byte integer uses its own value as its length prefix, there is no additional "0x80 + length" prefix that comes before it.
|
||||
if (nonce == 0x00) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd6), bytes1(0x94), deployer, bytes1(0x80))));
|
||||
if (nonce <= 0x7f) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd6), bytes1(0x94), deployer, uint8(nonce))));
|
||||
|
||||
// Nonces greater than 1 byte all follow a consistent encoding scheme, where each value is preceded by a prefix of 0x80 + length.
|
||||
if (nonce <= 2**8 - 1) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd7), bytes1(0x94), deployer, bytes1(0x81), uint8(nonce))));
|
||||
if (nonce <= 2**16 - 1) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd8), bytes1(0x94), deployer, bytes1(0x82), uint16(nonce))));
|
||||
if (nonce <= 2**24 - 1) return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xd9), bytes1(0x94), deployer, bytes1(0x83), uint24(nonce))));
|
||||
|
||||
// More details about RLP encoding can be found here: https://eth.wiki/fundamentals/rlp
|
||||
// 0xda = 0xc0 (short RLP prefix) + 0x16 (length of: 0x94 ++ proxy ++ 0x84 ++ nonce)
|
||||
// 0x94 = 0x80 + 0x14 (0x14 = the length of an address, 20 bytes, in hex)
|
||||
// 0x84 = 0x80 + 0x04 (0x04 = the bytes length of the nonce, 4 bytes, in hex)
|
||||
// We assume nobody can have a nonce large enough to require more than 32 bytes.
|
||||
return addressFromLast20Bytes(keccak256(abi.encodePacked(bytes1(0xda), bytes1(0x94), deployer, bytes1(0x84), uint32(nonce))));
|
||||
}
|
||||
|
||||
function addressFromLast20Bytes(bytes32 bytesValue) internal pure returns (address) {
|
||||
return address(uint160(uint256(bytesValue)));
|
||||
}
|
||||
}
|
|
@ -0,0 +1,733 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.6.0 <0.9.0;
|
||||
|
||||
import "./Script.sol";
|
||||
import "ds-test/test.sol";
|
||||
|
||||
// Wrappers around Cheatcodes to avoid footguns
|
||||
abstract contract Test is DSTest, Script {
|
||||
using stdStorage for StdStorage;
|
||||
|
||||
uint256 internal constant UINT256_MAX =
|
||||
115792089237316195423570985008687907853269984665640564039457584007913129639935;
|
||||
|
||||
StdStorage internal stdstore;
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
STD-LOGS
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
event log_array(uint256[] val);
|
||||
event log_array(int256[] val);
|
||||
event log_array(address[] val);
|
||||
event log_named_array(string key, uint256[] val);
|
||||
event log_named_array(string key, int256[] val);
|
||||
event log_named_array(string key, address[] val);
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
STD-CHEATS
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
// Skip forward or rewind time by the specified number of seconds
|
||||
function skip(uint256 time) public {
|
||||
vm.warp(block.timestamp + time);
|
||||
}
|
||||
|
||||
function rewind(uint256 time) public {
|
||||
vm.warp(block.timestamp - time);
|
||||
}
|
||||
|
||||
// Setup a prank from an address that has some ether
|
||||
function hoax(address who) public {
|
||||
vm.deal(who, 1 << 128);
|
||||
vm.prank(who);
|
||||
}
|
||||
|
||||
function hoax(address who, uint256 give) public {
|
||||
vm.deal(who, give);
|
||||
vm.prank(who);
|
||||
}
|
||||
|
||||
function hoax(address who, address origin) public {
|
||||
vm.deal(who, 1 << 128);
|
||||
vm.prank(who, origin);
|
||||
}
|
||||
|
||||
function hoax(address who, address origin, uint256 give) public {
|
||||
vm.deal(who, give);
|
||||
vm.prank(who, origin);
|
||||
}
|
||||
|
||||
// Start perpetual prank from an address that has some ether
|
||||
function startHoax(address who) public {
|
||||
vm.deal(who, 1 << 128);
|
||||
vm.startPrank(who);
|
||||
}
|
||||
|
||||
function startHoax(address who, uint256 give) public {
|
||||
vm.deal(who, give);
|
||||
vm.startPrank(who);
|
||||
}
|
||||
|
||||
// Start perpetual prank from an address that has some ether
|
||||
// tx.origin is set to the origin parameter
|
||||
function startHoax(address who, address origin) public {
|
||||
vm.deal(who, 1 << 128);
|
||||
vm.startPrank(who, origin);
|
||||
}
|
||||
|
||||
function startHoax(address who, address origin, uint256 give) public {
|
||||
vm.deal(who, give);
|
||||
vm.startPrank(who, origin);
|
||||
}
|
||||
|
||||
function changePrank(address who) internal {
|
||||
vm.stopPrank();
|
||||
vm.startPrank(who);
|
||||
}
|
||||
|
||||
// DEPRECATED: Use `deal` instead
|
||||
function tip(address token, address to, uint256 give) public {
|
||||
emit log_named_string("WARNING", "Test tip(address,address,uint256): The `tip` stdcheat has been deprecated. Use `deal` instead.");
|
||||
stdstore
|
||||
.target(token)
|
||||
.sig(0x70a08231)
|
||||
.with_key(to)
|
||||
.checked_write(give);
|
||||
}
|
||||
|
||||
// The same as Vm's `deal`
|
||||
// Use the alternative signature for ERC20 tokens
|
||||
function deal(address to, uint256 give) public {
|
||||
vm.deal(to, give);
|
||||
}
|
||||
|
||||
// Set the balance of an account for any ERC20 token
|
||||
// Use the alternative signature to update `totalSupply`
|
||||
function deal(address token, address to, uint256 give) public {
|
||||
deal(token, to, give, false);
|
||||
}
|
||||
|
||||
function deal(address token, address to, uint256 give, bool adjust) public {
|
||||
// get current balance
|
||||
(, bytes memory balData) = token.call(abi.encodeWithSelector(0x70a08231, to));
|
||||
uint256 prevBal = abi.decode(balData, (uint256));
|
||||
|
||||
// update balance
|
||||
stdstore
|
||||
.target(token)
|
||||
.sig(0x70a08231)
|
||||
.with_key(to)
|
||||
.checked_write(give);
|
||||
|
||||
// update total supply
|
||||
if(adjust){
|
||||
(, bytes memory totSupData) = token.call(abi.encodeWithSelector(0x18160ddd));
|
||||
uint256 totSup = abi.decode(totSupData, (uint256));
|
||||
if(give < prevBal) {
|
||||
totSup -= (prevBal - give);
|
||||
} else {
|
||||
totSup += (give - prevBal);
|
||||
}
|
||||
stdstore
|
||||
.target(token)
|
||||
.sig(0x18160ddd)
|
||||
.checked_write(totSup);
|
||||
}
|
||||
}
|
||||
|
||||
function bound(uint256 x, uint256 min, uint256 max) internal virtual returns (uint256 result) {
|
||||
require(min <= max, "Test bound(uint256,uint256,uint256): Max is less than min.");
|
||||
|
||||
uint256 size = max - min;
|
||||
|
||||
if (size == 0)
|
||||
{
|
||||
result = min;
|
||||
}
|
||||
else if (size == UINT256_MAX)
|
||||
{
|
||||
result = x;
|
||||
}
|
||||
else
|
||||
{
|
||||
++size; // make `max` inclusive
|
||||
uint256 mod = x % size;
|
||||
result = min + mod;
|
||||
}
|
||||
|
||||
emit log_named_uint("Bound Result", result);
|
||||
}
|
||||
|
||||
// Deploy a contract by fetching the contract bytecode from
|
||||
// the artifacts directory
|
||||
// e.g. `deployCode(code, abi.encode(arg1,arg2,arg3))`
|
||||
function deployCode(string memory what, bytes memory args)
|
||||
public
|
||||
returns (address addr)
|
||||
{
|
||||
bytes memory bytecode = abi.encodePacked(vm.getCode(what), args);
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
addr := create(0, add(bytecode, 0x20), mload(bytecode))
|
||||
}
|
||||
|
||||
require(
|
||||
addr != address(0),
|
||||
"Test deployCode(string,bytes): Deployment failed."
|
||||
);
|
||||
}
|
||||
|
||||
function deployCode(string memory what)
|
||||
public
|
||||
returns (address addr)
|
||||
{
|
||||
bytes memory bytecode = vm.getCode(what);
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
addr := create(0, add(bytecode, 0x20), mload(bytecode))
|
||||
}
|
||||
|
||||
require(
|
||||
addr != address(0),
|
||||
"Test deployCode(string): Deployment failed."
|
||||
);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
STD-ASSERTIONS
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function fail(string memory err) internal virtual {
|
||||
emit log_named_string("Error", err);
|
||||
fail();
|
||||
}
|
||||
|
||||
function assertFalse(bool data) internal virtual {
|
||||
assertTrue(!data);
|
||||
}
|
||||
|
||||
function assertFalse(bool data, string memory err) internal virtual {
|
||||
assertTrue(!data, err);
|
||||
}
|
||||
|
||||
function assertEq(bool a, bool b) internal {
|
||||
if (a != b) {
|
||||
emit log ("Error: a == b not satisfied [bool]");
|
||||
emit log_named_string (" Expected", b ? "true" : "false");
|
||||
emit log_named_string (" Actual", a ? "true" : "false");
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(bool a, bool b, string memory err) internal {
|
||||
if (a != b) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(bytes memory a, bytes memory b) internal {
|
||||
assertEq0(a, b);
|
||||
}
|
||||
|
||||
function assertEq(bytes memory a, bytes memory b, string memory err) internal {
|
||||
assertEq0(a, b, err);
|
||||
}
|
||||
|
||||
function assertEq(uint256[] memory a, uint256[] memory b) internal {
|
||||
if (keccak256(abi.encode(a)) != keccak256(abi.encode(b))) {
|
||||
emit log("Error: a == b not satisfied [uint[]]");
|
||||
emit log_named_array(" Expected", b);
|
||||
emit log_named_array(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(int256[] memory a, int256[] memory b) internal {
|
||||
if (keccak256(abi.encode(a)) != keccak256(abi.encode(b))) {
|
||||
emit log("Error: a == b not satisfied [int[]]");
|
||||
emit log_named_array(" Expected", b);
|
||||
emit log_named_array(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(address[] memory a, address[] memory b) internal {
|
||||
if (keccak256(abi.encode(a)) != keccak256(abi.encode(b))) {
|
||||
emit log("Error: a == b not satisfied [address[]]");
|
||||
emit log_named_array(" Expected", b);
|
||||
emit log_named_array(" Actual", a);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(uint256[] memory a, uint256[] memory b, string memory err) internal {
|
||||
if (keccak256(abi.encode(a)) != keccak256(abi.encode(b))) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertEq(int256[] memory a, int256[] memory b, string memory err) internal {
|
||||
if (keccak256(abi.encode(a)) != keccak256(abi.encode(b))) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
function assertEq(address[] memory a, address[] memory b, string memory err) internal {
|
||||
if (keccak256(abi.encode(a)) != keccak256(abi.encode(b))) {
|
||||
emit log_named_string("Error", err);
|
||||
assertEq(a, b);
|
||||
}
|
||||
}
|
||||
|
||||
function assertApproxEqAbs(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 maxDelta
|
||||
) internal virtual {
|
||||
uint256 delta = stdMath.delta(a, b);
|
||||
|
||||
if (delta > maxDelta) {
|
||||
emit log ("Error: a ~= b not satisfied [uint]");
|
||||
emit log_named_uint (" Expected", b);
|
||||
emit log_named_uint (" Actual", a);
|
||||
emit log_named_uint (" Max Delta", maxDelta);
|
||||
emit log_named_uint (" Delta", delta);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertApproxEqAbs(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 maxDelta,
|
||||
string memory err
|
||||
) internal virtual {
|
||||
uint256 delta = stdMath.delta(a, b);
|
||||
|
||||
if (delta > maxDelta) {
|
||||
emit log_named_string ("Error", err);
|
||||
assertApproxEqAbs(a, b, maxDelta);
|
||||
}
|
||||
}
|
||||
|
||||
function assertApproxEqAbs(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 maxDelta
|
||||
) internal virtual {
|
||||
uint256 delta = stdMath.delta(a, b);
|
||||
|
||||
if (delta > maxDelta) {
|
||||
emit log ("Error: a ~= b not satisfied [int]");
|
||||
emit log_named_int (" Expected", b);
|
||||
emit log_named_int (" Actual", a);
|
||||
emit log_named_uint (" Max Delta", maxDelta);
|
||||
emit log_named_uint (" Delta", delta);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertApproxEqAbs(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 maxDelta,
|
||||
string memory err
|
||||
) internal virtual {
|
||||
uint256 delta = stdMath.delta(a, b);
|
||||
|
||||
if (delta > maxDelta) {
|
||||
emit log_named_string ("Error", err);
|
||||
assertApproxEqAbs(a, b, maxDelta);
|
||||
}
|
||||
}
|
||||
|
||||
function assertApproxEqRel(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 maxPercentDelta // An 18 decimal fixed point number, where 1e18 == 100%
|
||||
) internal virtual {
|
||||
if (b == 0) return assertEq(a, b); // If the expected is 0, actual must be too.
|
||||
|
||||
uint256 percentDelta = stdMath.percentDelta(a, b);
|
||||
|
||||
if (percentDelta > maxPercentDelta) {
|
||||
emit log ("Error: a ~= b not satisfied [uint]");
|
||||
emit log_named_uint (" Expected", b);
|
||||
emit log_named_uint (" Actual", a);
|
||||
emit log_named_decimal_uint (" Max % Delta", maxPercentDelta, 18);
|
||||
emit log_named_decimal_uint (" % Delta", percentDelta, 18);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertApproxEqRel(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 maxPercentDelta, // An 18 decimal fixed point number, where 1e18 == 100%
|
||||
string memory err
|
||||
) internal virtual {
|
||||
if (b == 0) return assertEq(a, b); // If the expected is 0, actual must be too.
|
||||
|
||||
uint256 percentDelta = stdMath.percentDelta(a, b);
|
||||
|
||||
if (percentDelta > maxPercentDelta) {
|
||||
emit log_named_string ("Error", err);
|
||||
assertApproxEqRel(a, b, maxPercentDelta);
|
||||
}
|
||||
}
|
||||
|
||||
function assertApproxEqRel(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 maxPercentDelta
|
||||
) internal virtual {
|
||||
if (b == 0) return assertEq(a, b); // If the expected is 0, actual must be too.
|
||||
|
||||
uint256 percentDelta = stdMath.percentDelta(a, b);
|
||||
|
||||
if (percentDelta > maxPercentDelta) {
|
||||
emit log ("Error: a ~= b not satisfied [int]");
|
||||
emit log_named_int (" Expected", b);
|
||||
emit log_named_int (" Actual", a);
|
||||
emit log_named_decimal_uint(" Max % Delta", maxPercentDelta, 18);
|
||||
emit log_named_decimal_uint(" % Delta", percentDelta, 18);
|
||||
fail();
|
||||
}
|
||||
}
|
||||
|
||||
function assertApproxEqRel(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 maxPercentDelta,
|
||||
string memory err
|
||||
) internal virtual {
|
||||
if (b == 0) return assertEq(a, b); // If the expected is 0, actual must be too.
|
||||
|
||||
uint256 percentDelta = stdMath.percentDelta(a, b);
|
||||
|
||||
if (percentDelta > maxPercentDelta) {
|
||||
emit log_named_string ("Error", err);
|
||||
assertApproxEqRel(a, b, maxPercentDelta);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
STD-ERRORS
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
library stdError {
|
||||
bytes public constant assertionError = abi.encodeWithSignature("Panic(uint256)", 0x01);
|
||||
bytes public constant arithmeticError = abi.encodeWithSignature("Panic(uint256)", 0x11);
|
||||
bytes public constant divisionError = abi.encodeWithSignature("Panic(uint256)", 0x12);
|
||||
bytes public constant enumConversionError = abi.encodeWithSignature("Panic(uint256)", 0x21);
|
||||
bytes public constant encodeStorageError = abi.encodeWithSignature("Panic(uint256)", 0x22);
|
||||
bytes public constant popError = abi.encodeWithSignature("Panic(uint256)", 0x31);
|
||||
bytes public constant indexOOBError = abi.encodeWithSignature("Panic(uint256)", 0x32);
|
||||
bytes public constant memOverflowError = abi.encodeWithSignature("Panic(uint256)", 0x41);
|
||||
bytes public constant zeroVarError = abi.encodeWithSignature("Panic(uint256)", 0x51);
|
||||
// DEPRECATED: Use Vm's `expectRevert` without any arguments instead
|
||||
bytes public constant lowLevelError = bytes(""); // `0x`
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
STD-STORAGE
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
struct StdStorage {
|
||||
mapping (address => mapping(bytes4 => mapping(bytes32 => uint256))) slots;
|
||||
mapping (address => mapping(bytes4 => mapping(bytes32 => bool))) finds;
|
||||
|
||||
bytes32[] _keys;
|
||||
bytes4 _sig;
|
||||
uint256 _depth;
|
||||
address _target;
|
||||
bytes32 _set;
|
||||
}
|
||||
|
||||
library stdStorage {
|
||||
event SlotFound(address who, bytes4 fsig, bytes32 keysHash, uint slot);
|
||||
event WARNING_UninitedSlot(address who, uint slot);
|
||||
|
||||
uint256 private constant UINT256_MAX = 115792089237316195423570985008687907853269984665640564039457584007913129639935;
|
||||
int256 private constant INT256_MAX = 57896044618658097711785492504343953926634992332820282019728792003956564819967;
|
||||
|
||||
Vm private constant vm_std_store = Vm(address(uint160(uint256(keccak256('hevm cheat code')))));
|
||||
|
||||
function sigs(
|
||||
string memory sigStr
|
||||
)
|
||||
internal
|
||||
pure
|
||||
returns (bytes4)
|
||||
{
|
||||
return bytes4(keccak256(bytes(sigStr)));
|
||||
}
|
||||
|
||||
/// @notice find an arbitrary storage slot given a function sig, input data, address of the contract and a value to check against
|
||||
// slot complexity:
|
||||
// if flat, will be bytes32(uint256(uint));
|
||||
// if map, will be keccak256(abi.encode(key, uint(slot)));
|
||||
// if deep map, will be keccak256(abi.encode(key1, keccak256(abi.encode(key0, uint(slot)))));
|
||||
// if map struct, will be bytes32(uint256(keccak256(abi.encode(key1, keccak256(abi.encode(key0, uint(slot)))))) + structFieldDepth);
|
||||
function find(
|
||||
StdStorage storage self
|
||||
)
|
||||
internal
|
||||
returns (uint256)
|
||||
{
|
||||
address who = self._target;
|
||||
bytes4 fsig = self._sig;
|
||||
uint256 field_depth = self._depth;
|
||||
bytes32[] memory ins = self._keys;
|
||||
|
||||
// calldata to test against
|
||||
if (self.finds[who][fsig][keccak256(abi.encodePacked(ins, field_depth))]) {
|
||||
return self.slots[who][fsig][keccak256(abi.encodePacked(ins, field_depth))];
|
||||
}
|
||||
bytes memory cald = abi.encodePacked(fsig, flatten(ins));
|
||||
vm_std_store.record();
|
||||
bytes32 fdat;
|
||||
{
|
||||
(, bytes memory rdat) = who.staticcall(cald);
|
||||
fdat = bytesToBytes32(rdat, 32*field_depth);
|
||||
}
|
||||
|
||||
(bytes32[] memory reads, ) = vm_std_store.accesses(address(who));
|
||||
if (reads.length == 1) {
|
||||
bytes32 curr = vm_std_store.load(who, reads[0]);
|
||||
if (curr == bytes32(0)) {
|
||||
emit WARNING_UninitedSlot(who, uint256(reads[0]));
|
||||
}
|
||||
if (fdat != curr) {
|
||||
require(false, "stdStorage find(StdStorage): Packed slot. This would cause dangerous overwriting and currently isn't supported.");
|
||||
}
|
||||
emit SlotFound(who, fsig, keccak256(abi.encodePacked(ins, field_depth)), uint256(reads[0]));
|
||||
self.slots[who][fsig][keccak256(abi.encodePacked(ins, field_depth))] = uint256(reads[0]);
|
||||
self.finds[who][fsig][keccak256(abi.encodePacked(ins, field_depth))] = true;
|
||||
} else if (reads.length > 1) {
|
||||
for (uint256 i = 0; i < reads.length; i++) {
|
||||
bytes32 prev = vm_std_store.load(who, reads[i]);
|
||||
if (prev == bytes32(0)) {
|
||||
emit WARNING_UninitedSlot(who, uint256(reads[i]));
|
||||
}
|
||||
// store
|
||||
vm_std_store.store(who, reads[i], bytes32(hex"1337"));
|
||||
bool success;
|
||||
bytes memory rdat;
|
||||
{
|
||||
(success, rdat) = who.staticcall(cald);
|
||||
fdat = bytesToBytes32(rdat, 32*field_depth);
|
||||
}
|
||||
|
||||
if (success && fdat == bytes32(hex"1337")) {
|
||||
// we found which of the slots is the actual one
|
||||
emit SlotFound(who, fsig, keccak256(abi.encodePacked(ins, field_depth)), uint256(reads[i]));
|
||||
self.slots[who][fsig][keccak256(abi.encodePacked(ins, field_depth))] = uint256(reads[i]);
|
||||
self.finds[who][fsig][keccak256(abi.encodePacked(ins, field_depth))] = true;
|
||||
vm_std_store.store(who, reads[i], prev);
|
||||
break;
|
||||
}
|
||||
vm_std_store.store(who, reads[i], prev);
|
||||
}
|
||||
} else {
|
||||
require(false, "stdStorage find(StdStorage): No storage use detected for target.");
|
||||
}
|
||||
|
||||
require(self.finds[who][fsig][keccak256(abi.encodePacked(ins, field_depth))], "stdStorage find(StdStorage): Slot(s) not found.");
|
||||
|
||||
delete self._target;
|
||||
delete self._sig;
|
||||
delete self._keys;
|
||||
delete self._depth;
|
||||
|
||||
return self.slots[who][fsig][keccak256(abi.encodePacked(ins, field_depth))];
|
||||
}
|
||||
|
||||
function target(StdStorage storage self, address _target) internal returns (StdStorage storage) {
|
||||
self._target = _target;
|
||||
return self;
|
||||
}
|
||||
|
||||
function sig(StdStorage storage self, bytes4 _sig) internal returns (StdStorage storage) {
|
||||
self._sig = _sig;
|
||||
return self;
|
||||
}
|
||||
|
||||
function sig(StdStorage storage self, string memory _sig) internal returns (StdStorage storage) {
|
||||
self._sig = sigs(_sig);
|
||||
return self;
|
||||
}
|
||||
|
||||
function with_key(StdStorage storage self, address who) internal returns (StdStorage storage) {
|
||||
self._keys.push(bytes32(uint256(uint160(who))));
|
||||
return self;
|
||||
}
|
||||
|
||||
function with_key(StdStorage storage self, uint256 amt) internal returns (StdStorage storage) {
|
||||
self._keys.push(bytes32(amt));
|
||||
return self;
|
||||
}
|
||||
function with_key(StdStorage storage self, bytes32 key) internal returns (StdStorage storage) {
|
||||
self._keys.push(key);
|
||||
return self;
|
||||
}
|
||||
|
||||
function depth(StdStorage storage self, uint256 _depth) internal returns (StdStorage storage) {
|
||||
self._depth = _depth;
|
||||
return self;
|
||||
}
|
||||
|
||||
function checked_write(StdStorage storage self, address who) internal {
|
||||
checked_write(self, bytes32(uint256(uint160(who))));
|
||||
}
|
||||
|
||||
function checked_write(StdStorage storage self, uint256 amt) internal {
|
||||
checked_write(self, bytes32(amt));
|
||||
}
|
||||
|
||||
function checked_write(StdStorage storage self, bool write) internal {
|
||||
bytes32 t;
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
t := write
|
||||
}
|
||||
checked_write(self, t);
|
||||
}
|
||||
|
||||
function checked_write(
|
||||
StdStorage storage self,
|
||||
bytes32 set
|
||||
) internal {
|
||||
address who = self._target;
|
||||
bytes4 fsig = self._sig;
|
||||
uint256 field_depth = self._depth;
|
||||
bytes32[] memory ins = self._keys;
|
||||
|
||||
bytes memory cald = abi.encodePacked(fsig, flatten(ins));
|
||||
if (!self.finds[who][fsig][keccak256(abi.encodePacked(ins, field_depth))]) {
|
||||
find(self);
|
||||
}
|
||||
bytes32 slot = bytes32(self.slots[who][fsig][keccak256(abi.encodePacked(ins, field_depth))]);
|
||||
|
||||
bytes32 fdat;
|
||||
{
|
||||
(, bytes memory rdat) = who.staticcall(cald);
|
||||
fdat = bytesToBytes32(rdat, 32*field_depth);
|
||||
}
|
||||
bytes32 curr = vm_std_store.load(who, slot);
|
||||
|
||||
if (fdat != curr) {
|
||||
require(false, "stdStorage find(StdStorage): Packed slot. This would cause dangerous overwriting and currently isn't supported.");
|
||||
}
|
||||
vm_std_store.store(who, slot, set);
|
||||
delete self._target;
|
||||
delete self._sig;
|
||||
delete self._keys;
|
||||
delete self._depth;
|
||||
}
|
||||
|
||||
function read(StdStorage storage self) private returns (bytes memory) {
|
||||
address t = self._target;
|
||||
uint256 s = find(self);
|
||||
return abi.encode(vm_std_store.load(t, bytes32(s)));
|
||||
}
|
||||
|
||||
function read_bytes32(StdStorage storage self) internal returns (bytes32) {
|
||||
return abi.decode(read(self), (bytes32));
|
||||
}
|
||||
|
||||
|
||||
function read_bool(StdStorage storage self) internal returns (bool) {
|
||||
int256 v = read_int(self);
|
||||
if (v == 0) return false;
|
||||
if (v == 1) return true;
|
||||
revert("stdStorage read_bool(StdStorage): Cannot decode. Make sure you are reading a bool.");
|
||||
}
|
||||
|
||||
function read_address(StdStorage storage self) internal returns (address) {
|
||||
return abi.decode(read(self), (address));
|
||||
}
|
||||
|
||||
function read_uint(StdStorage storage self) internal returns (uint256) {
|
||||
return abi.decode(read(self), (uint256));
|
||||
}
|
||||
|
||||
function read_int(StdStorage storage self) internal returns (int256) {
|
||||
return abi.decode(read(self), (int256));
|
||||
}
|
||||
|
||||
function bytesToBytes32(bytes memory b, uint offset) public pure returns (bytes32) {
|
||||
bytes32 out;
|
||||
|
||||
uint256 max = b.length > 32 ? 32 : b.length;
|
||||
for (uint i = 0; i < max; i++) {
|
||||
out |= bytes32(b[offset + i] & 0xFF) >> (i * 8);
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
function flatten(bytes32[] memory b) private pure returns (bytes memory)
|
||||
{
|
||||
bytes memory result = new bytes(b.length * 32);
|
||||
for (uint256 i = 0; i < b.length; i++) {
|
||||
bytes32 k = b[i];
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
mstore(add(result, add(32, mul(32, i))), k)
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
STD-MATH
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
library stdMath {
|
||||
int256 private constant INT256_MIN = -57896044618658097711785492504343953926634992332820282019728792003956564819968;
|
||||
|
||||
function abs(int256 a) internal pure returns (uint256) {
|
||||
// Required or it will fail when `a = type(int256).min`
|
||||
if (a == INT256_MIN)
|
||||
return 57896044618658097711785492504343953926634992332820282019728792003956564819968;
|
||||
|
||||
return uint256(a >= 0 ? a : -a);
|
||||
}
|
||||
|
||||
function delta(uint256 a, uint256 b) internal pure returns (uint256) {
|
||||
return a > b
|
||||
? a - b
|
||||
: b - a;
|
||||
}
|
||||
|
||||
function delta(int256 a, int256 b) internal pure returns (uint256) {
|
||||
// a and b are of the same sign
|
||||
if (a >= 0 && b >= 0 || a < 0 && b < 0) {
|
||||
return delta(abs(a), abs(b));
|
||||
}
|
||||
|
||||
// a and b are of opposite signs
|
||||
return abs(a) + abs(b);
|
||||
}
|
||||
|
||||
function percentDelta(uint256 a, uint256 b) internal pure returns (uint256) {
|
||||
uint256 absDelta = delta(a, b);
|
||||
|
||||
return absDelta * 1e18 / b;
|
||||
}
|
||||
|
||||
function percentDelta(int256 a, int256 b) internal pure returns (uint256) {
|
||||
uint256 absDelta = delta(a, b);
|
||||
uint256 absB = abs(b);
|
||||
|
||||
return absDelta * 1e18 / absB;
|
||||
}
|
||||
}
|
|
@ -0,0 +1,171 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.6.0;
|
||||
pragma experimental ABIEncoderV2;
|
||||
|
||||
interface Vm {
|
||||
struct Log {
|
||||
bytes32[] topics;
|
||||
bytes data;
|
||||
}
|
||||
|
||||
// Sets block.timestamp (newTimestamp)
|
||||
function warp(uint256) external;
|
||||
// Sets block.height (newHeight)
|
||||
function roll(uint256) external;
|
||||
// Sets block.basefee (newBasefee)
|
||||
function fee(uint256) external;
|
||||
// Sets block.chainid
|
||||
function chainId(uint256) external;
|
||||
// Loads a storage slot from an address (who, slot)
|
||||
function load(address,bytes32) external returns (bytes32);
|
||||
// Stores a value to an address' storage slot, (who, slot, value)
|
||||
function store(address,bytes32,bytes32) external;
|
||||
// Signs data, (privateKey, digest) => (v, r, s)
|
||||
function sign(uint256,bytes32) external returns (uint8,bytes32,bytes32);
|
||||
// Gets the address for a given private key, (privateKey) => (address)
|
||||
function addr(uint256) external returns (address);
|
||||
// Gets the nonce of an account
|
||||
function getNonce(address) external returns (uint64);
|
||||
// Sets the nonce of an account; must be higher than the current nonce of the account
|
||||
function setNonce(address, uint64) external;
|
||||
// Performs a foreign function call via the terminal, (stringInputs) => (result)
|
||||
function ffi(string[] calldata) external returns (bytes memory);
|
||||
// Sets environment variables, (name, value)
|
||||
function setEnv(string calldata, string calldata) external;
|
||||
// Reads environment variables, (name) => (value)
|
||||
function envBool(string calldata) external returns (bool);
|
||||
function envUint(string calldata) external returns (uint256);
|
||||
function envInt(string calldata) external returns (int256);
|
||||
function envAddress(string calldata) external returns (address);
|
||||
function envBytes32(string calldata) external returns (bytes32);
|
||||
function envString(string calldata) external returns (string memory);
|
||||
function envBytes(string calldata) external returns (bytes memory);
|
||||
// Reads environment variables as arrays, (name, delim) => (value[])
|
||||
function envBool(string calldata, string calldata) external returns (bool[] memory);
|
||||
function envUint(string calldata, string calldata) external returns (uint256[] memory);
|
||||
function envInt(string calldata, string calldata) external returns (int256[] memory);
|
||||
function envAddress(string calldata, string calldata) external returns (address[] memory);
|
||||
function envBytes32(string calldata, string calldata) external returns (bytes32[] memory);
|
||||
function envString(string calldata, string calldata) external returns (string[] memory);
|
||||
function envBytes(string calldata, string calldata) external returns (bytes[] memory);
|
||||
// Sets the *next* call's msg.sender to be the input address
|
||||
function prank(address) external;
|
||||
// Sets all subsequent calls' msg.sender to be the input address until `stopPrank` is called
|
||||
function startPrank(address) external;
|
||||
// Sets the *next* call's msg.sender to be the input address, and the tx.origin to be the second input
|
||||
function prank(address,address) external;
|
||||
// Sets all subsequent calls' msg.sender to be the input address until `stopPrank` is called, and the tx.origin to be the second input
|
||||
function startPrank(address,address) external;
|
||||
// Resets subsequent calls' msg.sender to be `address(this)`
|
||||
function stopPrank() external;
|
||||
// Sets an address' balance, (who, newBalance)
|
||||
function deal(address, uint256) external;
|
||||
// Sets an address' code, (who, newCode)
|
||||
function etch(address, bytes calldata) external;
|
||||
// Expects an error on next call
|
||||
function expectRevert(bytes calldata) external;
|
||||
function expectRevert(bytes4) external;
|
||||
function expectRevert() external;
|
||||
// Records all storage reads and writes
|
||||
function record() external;
|
||||
// Gets all accessed reads and write slot from a recording session, for a given address
|
||||
function accesses(address) external returns (bytes32[] memory reads, bytes32[] memory writes);
|
||||
// Prepare an expected log with (bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData).
|
||||
// Call this function, then emit an event, then call a function. Internally after the call, we check if
|
||||
// logs were emitted in the expected order with the expected topics and data (as specified by the booleans)
|
||||
function expectEmit(bool,bool,bool,bool) external;
|
||||
function expectEmit(bool,bool,bool,bool,address) external;
|
||||
// Mocks a call to an address, returning specified data.
|
||||
// Calldata can either be strict or a partial match, e.g. if you only
|
||||
// pass a Solidity selector to the expected calldata, then the entire Solidity
|
||||
// function will be mocked.
|
||||
function mockCall(address,bytes calldata,bytes calldata) external;
|
||||
// Mocks a call to an address with a specific msg.value, returning specified data.
|
||||
// Calldata match takes precedence over msg.value in case of ambiguity.
|
||||
function mockCall(address,uint256,bytes calldata,bytes calldata) external;
|
||||
// Clears all mocked calls
|
||||
function clearMockedCalls() external;
|
||||
// Expects a call to an address with the specified calldata.
|
||||
// Calldata can either be a strict or a partial match
|
||||
function expectCall(address,bytes calldata) external;
|
||||
// Expects a call to an address with the specified msg.value and calldata
|
||||
function expectCall(address,uint256,bytes calldata) external;
|
||||
// Gets the code from an artifact file. Takes in the relative path to the json file
|
||||
function getCode(string calldata) external returns (bytes memory);
|
||||
// Labels an address in call traces
|
||||
function label(address, string calldata) external;
|
||||
// If the condition is false, discard this run's fuzz inputs and generate new ones
|
||||
function assume(bool) external;
|
||||
// Sets block.coinbase (who)
|
||||
function coinbase(address) external;
|
||||
// Using the address that calls the test contract, has the next call (at this call depth only) create a transaction that can later be signed and sent onchain
|
||||
function broadcast() external;
|
||||
// Has the next call (at this call depth only) create a transaction with the address provided as the sender that can later be signed and sent onchain
|
||||
function broadcast(address) external;
|
||||
// Using the address that calls the test contract, has all subsequent calls (at this call depth only) create transactions that can later be signed and sent onchain
|
||||
function startBroadcast() external;
|
||||
// Has all subsequent calls (at this call depth only) create transactions that can later be signed and sent onchain
|
||||
function startBroadcast(address) external;
|
||||
// Stops collecting onchain transactions
|
||||
function stopBroadcast() external;
|
||||
// Reads the entire content of file to string, (path) => (data)
|
||||
function readFile(string calldata) external returns (string memory);
|
||||
// Reads next line of file to string, (path) => (line)
|
||||
function readLine(string calldata) external returns (string memory);
|
||||
// Writes data to file, creating a file if it does not exist, and entirely replacing its contents if it does.
|
||||
// (path, data) => ()
|
||||
function writeFile(string calldata, string calldata) external;
|
||||
// Writes line to file, creating a file if it does not exist.
|
||||
// (path, data) => ()
|
||||
function writeLine(string calldata, string calldata) external;
|
||||
// Closes file for reading, resetting the offset and allowing to read it from beginning with readLine.
|
||||
// (path) => ()
|
||||
function closeFile(string calldata) external;
|
||||
// Removes file. This cheatcode will revert in the following situations, but is not limited to just these cases:
|
||||
// - Path points to a directory.
|
||||
// - The file doesn't exist.
|
||||
// - The user lacks permissions to remove the file.
|
||||
// (path) => ()
|
||||
function removeFile(string calldata) external;
|
||||
// Convert values to a string, (value) => (stringified value)
|
||||
function toString(address) external returns(string memory);
|
||||
function toString(bytes calldata) external returns(string memory);
|
||||
function toString(bytes32) external returns(string memory);
|
||||
function toString(bool) external returns(string memory);
|
||||
function toString(uint256) external returns(string memory);
|
||||
function toString(int256) external returns(string memory);
|
||||
// Record all the transaction logs
|
||||
function recordLogs() external;
|
||||
// Gets all the recorded logs, () => (logs)
|
||||
function getRecordedLogs() external returns (Log[] memory);
|
||||
// Snapshot the current state of the evm.
|
||||
// Returns the id of the snapshot that was created.
|
||||
// To revert a snapshot use `revertTo`
|
||||
function snapshot() external returns(uint256);
|
||||
// Revert the state of the evm to a previous snapshot
|
||||
// Takes the snapshot id to revert to.
|
||||
// This deletes the snapshot and all snapshots taken after the given snapshot id.
|
||||
function revertTo(uint256) external returns(bool);
|
||||
// Creates a new fork with the given endpoint and block and returns the identifier of the fork
|
||||
function createFork(string calldata,uint256) external returns(uint256);
|
||||
// Creates a new fork with the given endpoint and the _latest_ block and returns the identifier of the fork
|
||||
function createFork(string calldata) external returns(uint256);
|
||||
// Creates _and_ also selects a new fork with the given endpoint and block and returns the identifier of the fork
|
||||
function createSelectFork(string calldata,uint256) external returns(uint256);
|
||||
// Creates _and_ also selects a new fork with the given endpoint and the latest block and returns the identifier of the fork
|
||||
function createSelectFork(string calldata) external returns(uint256);
|
||||
// Takes a fork identifier created by `createFork` and sets the corresponding forked state as active.
|
||||
function selectFork(uint256) external;
|
||||
/// Returns the currently active fork
|
||||
/// Reverts if no fork is currently active
|
||||
function activeFork() external returns(uint256);
|
||||
// Updates the currently active fork to given block number
|
||||
// This is similar to `roll` but for the currently active fork
|
||||
function rollFork(uint256) external;
|
||||
// Updates the given fork to given block number
|
||||
function rollFork(uint256 forkId, uint256 blockNumber) external;
|
||||
/// Returns the RPC url for the given alias
|
||||
function rpcUrl(string calldata) external returns(string memory);
|
||||
/// Returns all rpc urls and their aliases `[alias, url][]`
|
||||
function rpcUrls() external returns(string[2][] memory);
|
||||
}
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,12 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.7.0 <0.9.0;
|
||||
|
||||
import "../Test.sol";
|
||||
|
||||
contract ScriptTest is Test
|
||||
{
|
||||
function testGenerateCorrectAddress() external {
|
||||
address creation = computeCreateAddress(0x6C9FC64A53c1b71FB3f9Af64d1ae3A4931A5f4E9, 14);
|
||||
assertEq(creation, 0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc45);
|
||||
}
|
||||
}
|
|
@ -0,0 +1,599 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.7.0 <0.9.0;
|
||||
|
||||
import "../Test.sol";
|
||||
|
||||
contract StdAssertionsTest is Test
|
||||
{
|
||||
string constant CUSTOM_ERROR = "guh!";
|
||||
|
||||
bool constant EXPECT_PASS = false;
|
||||
bool constant EXPECT_FAIL = true;
|
||||
|
||||
TestTest t = new TestTest();
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
FAIL(STRING)
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testShouldFail() external {
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
t._fail(CUSTOM_ERROR);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
ASSERT_FALSE
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testAssertFalse_Pass() external {
|
||||
t._assertFalse(false, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertFalse_Fail() external {
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: Assertion Failed");
|
||||
t._assertFalse(true, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertFalse_Err_Pass() external {
|
||||
t._assertFalse(false, CUSTOM_ERROR, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertFalse_Err_Fail() external {
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
t._assertFalse(true, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
ASSERT_EQ(BOOL)
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testAssertEq_Bool_Pass(bool a, bool b) external {
|
||||
vm.assume(a == b);
|
||||
|
||||
t._assertEq(a, b, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertEq_Bool_Fail(bool a, bool b) external {
|
||||
vm.assume(a != b);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [bool]");
|
||||
t._assertEq(a, b, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_BoolErr_Pass(bool a, bool b) external {
|
||||
vm.assume(a == b);
|
||||
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertEq_BoolErr_Fail(bool a, bool b) external {
|
||||
vm.assume(a != b);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
ASSERT_EQ(BYTES)
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testAssertEq_Bytes_Pass(bytes calldata a, bytes calldata b) external {
|
||||
vm.assume(keccak256(a) == keccak256(b));
|
||||
|
||||
t._assertEq(a, b, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertEq_Bytes_Fail(bytes calldata a, bytes calldata b) external {
|
||||
vm.assume(keccak256(a) != keccak256(b));
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [bytes]");
|
||||
t._assertEq(a, b, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_BytesErr_Pass(bytes calldata a, bytes calldata b) external {
|
||||
vm.assume(keccak256(a) == keccak256(b));
|
||||
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertEq_BytesErr_Fail(bytes calldata a, bytes calldata b) external {
|
||||
vm.assume(keccak256(a) != keccak256(b));
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
ASSERT_EQ(ARRAY)
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testAssertEq_UintArr_Pass(uint256 e0, uint256 e1, uint256 e2) public {
|
||||
uint256[] memory a = new uint256[](3);
|
||||
a[0] = e0;
|
||||
a[1] = e1;
|
||||
a[2] = e2;
|
||||
uint256[] memory b = new uint256[](3);
|
||||
b[0] = e0;
|
||||
b[1] = e1;
|
||||
b[2] = e2;
|
||||
|
||||
t._assertEq(a, b, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertEq_IntArr_Pass(int256 e0, int256 e1, int256 e2) public {
|
||||
int256[] memory a = new int256[](3);
|
||||
a[0] = e0;
|
||||
a[1] = e1;
|
||||
a[2] = e2;
|
||||
int256[] memory b = new int256[](3);
|
||||
b[0] = e0;
|
||||
b[1] = e1;
|
||||
b[2] = e2;
|
||||
|
||||
t._assertEq(a, b, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertEq_AddressArr_Pass(address e0, address e1, address e2) public {
|
||||
address[] memory a = new address[](3);
|
||||
a[0] = e0;
|
||||
a[1] = e1;
|
||||
a[2] = e2;
|
||||
address[] memory b = new address[](3);
|
||||
b[0] = e0;
|
||||
b[1] = e1;
|
||||
b[2] = e2;
|
||||
|
||||
t._assertEq(a, b, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertEq_UintArr_FailEl(uint256 e1) public {
|
||||
vm.assume(e1 != 0);
|
||||
uint256[] memory a = new uint256[](3);
|
||||
uint256[] memory b = new uint256[](3);
|
||||
b[1] = e1;
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [uint[]]");
|
||||
t._assertEq(a, b, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_IntArr_FailEl(int256 e1) public {
|
||||
vm.assume(e1 != 0);
|
||||
int256[] memory a = new int256[](3);
|
||||
int256[] memory b = new int256[](3);
|
||||
b[1] = e1;
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [int[]]");
|
||||
t._assertEq(a, b, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
|
||||
function testAssertEq_AddressArr_FailEl(address e1) public {
|
||||
vm.assume(e1 != address(0));
|
||||
address[] memory a = new address[](3);
|
||||
address[] memory b = new address[](3);
|
||||
b[1] = e1;
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [address[]]");
|
||||
t._assertEq(a, b, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_UintArrErr_FailEl(uint256 e1) public {
|
||||
vm.assume(e1 != 0);
|
||||
uint256[] memory a = new uint256[](3);
|
||||
uint256[] memory b = new uint256[](3);
|
||||
b[1] = e1;
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [uint[]]");
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_IntArrErr_FailEl(int256 e1) public {
|
||||
vm.assume(e1 != 0);
|
||||
int256[] memory a = new int256[](3);
|
||||
int256[] memory b = new int256[](3);
|
||||
b[1] = e1;
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [int[]]");
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
|
||||
function testAssertEq_AddressArrErr_FailEl(address e1) public {
|
||||
vm.assume(e1 != address(0));
|
||||
address[] memory a = new address[](3);
|
||||
address[] memory b = new address[](3);
|
||||
b[1] = e1;
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [address[]]");
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_UintArr_FailLen(uint256 lenA, uint256 lenB) public {
|
||||
vm.assume(lenA != lenB);
|
||||
vm.assume(lenA <= 10000);
|
||||
vm.assume(lenB <= 10000);
|
||||
uint256[] memory a = new uint256[](lenA);
|
||||
uint256[] memory b = new uint256[](lenB);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [uint[]]");
|
||||
t._assertEq(a, b, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_IntArr_FailLen(uint256 lenA, uint256 lenB) public {
|
||||
vm.assume(lenA != lenB);
|
||||
vm.assume(lenA <= 10000);
|
||||
vm.assume(lenB <= 10000);
|
||||
int256[] memory a = new int256[](lenA);
|
||||
int256[] memory b = new int256[](lenB);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [int[]]");
|
||||
t._assertEq(a, b, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_AddressArr_FailLen(uint256 lenA, uint256 lenB) public {
|
||||
vm.assume(lenA != lenB);
|
||||
vm.assume(lenA <= 10000);
|
||||
vm.assume(lenB <= 10000);
|
||||
address[] memory a = new address[](lenA);
|
||||
address[] memory b = new address[](lenB);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [address[]]");
|
||||
t._assertEq(a, b, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_UintArrErr_FailLen(uint256 lenA, uint256 lenB) public {
|
||||
vm.assume(lenA != lenB);
|
||||
vm.assume(lenA <= 10000);
|
||||
vm.assume(lenB <= 10000);
|
||||
uint256[] memory a = new uint256[](lenA);
|
||||
uint256[] memory b = new uint256[](lenB);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [uint[]]");
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_IntArrErr_FailLen(uint256 lenA, uint256 lenB) public {
|
||||
vm.assume(lenA != lenB);
|
||||
vm.assume(lenA <= 10000);
|
||||
vm.assume(lenB <= 10000);
|
||||
int256[] memory a = new int256[](lenA);
|
||||
int256[] memory b = new int256[](lenB);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [int[]]");
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertEq_AddressArrErr_FailLen(uint256 lenA, uint256 lenB) public {
|
||||
vm.assume(lenA != lenB);
|
||||
vm.assume(lenA <= 10000);
|
||||
vm.assume(lenB <= 10000);
|
||||
address[] memory a = new address[](lenA);
|
||||
address[] memory b = new address[](lenB);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a == b not satisfied [address[]]");
|
||||
t._assertEq(a, b, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
APPROX_EQ_ABS(UINT)
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testAssertApproxEqAbs_Uint_Pass(uint256 a, uint256 b, uint256 maxDelta) external {
|
||||
vm.assume(stdMath.delta(a, b) <= maxDelta);
|
||||
|
||||
t._assertApproxEqAbs(a, b, maxDelta, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertApproxEqAbs_Uint_Fail(uint256 a, uint256 b, uint256 maxDelta) external {
|
||||
vm.assume(stdMath.delta(a, b) > maxDelta);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a ~= b not satisfied [uint]");
|
||||
t._assertApproxEqAbs(a, b, maxDelta, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertApproxEqAbs_UintErr_Pass(uint256 a, uint256 b, uint256 maxDelta) external {
|
||||
vm.assume(stdMath.delta(a, b) <= maxDelta);
|
||||
|
||||
t._assertApproxEqAbs(a, b, maxDelta, CUSTOM_ERROR, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertApproxEqAbs_UintErr_Fail(uint256 a, uint256 b, uint256 maxDelta) external {
|
||||
vm.assume(stdMath.delta(a, b) > maxDelta);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
t._assertApproxEqAbs(a, b, maxDelta, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
APPROX_EQ_ABS(INT)
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testAssertApproxEqAbs_Int_Pass(int256 a, int256 b, uint256 maxDelta) external {
|
||||
vm.assume(stdMath.delta(a, b) <= maxDelta);
|
||||
|
||||
t._assertApproxEqAbs(a, b, maxDelta, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertApproxEqAbs_Int_Fail(int256 a, int256 b, uint256 maxDelta) external {
|
||||
vm.assume(stdMath.delta(a, b) > maxDelta);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a ~= b not satisfied [int]");
|
||||
t._assertApproxEqAbs(a, b, maxDelta, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertApproxEqAbs_IntErr_Pass(int256 a, int256 b, uint256 maxDelta) external {
|
||||
vm.assume(stdMath.delta(a, b) <= maxDelta);
|
||||
|
||||
t._assertApproxEqAbs(a, b, maxDelta, CUSTOM_ERROR, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertApproxEqAbs_IntErr_Fail(int256 a, int256 b, uint256 maxDelta) external {
|
||||
vm.assume(stdMath.delta(a, b) > maxDelta);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
t._assertApproxEqAbs(a, b, maxDelta, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
APPROX_EQ_REL(UINT)
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testAssertApproxEqRel_Uint_Pass(uint256 a, uint256 b, uint256 maxPercentDelta) external {
|
||||
vm.assume(a < type(uint128).max && b < type(uint128).max && b != 0);
|
||||
vm.assume(stdMath.percentDelta(a, b) <= maxPercentDelta);
|
||||
|
||||
t._assertApproxEqRel(a, b, maxPercentDelta, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertApproxEqRel_Uint_Fail(uint256 a, uint256 b, uint256 maxPercentDelta) external {
|
||||
vm.assume(a < type(uint128).max && b < type(uint128).max && b != 0);
|
||||
vm.assume(stdMath.percentDelta(a, b) > maxPercentDelta);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a ~= b not satisfied [uint]");
|
||||
t._assertApproxEqRel(a, b, maxPercentDelta, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertApproxEqRel_UintErr_Pass(uint256 a, uint256 b, uint256 maxPercentDelta) external {
|
||||
vm.assume(a < type(uint128).max && b < type(uint128).max && b != 0);
|
||||
vm.assume(stdMath.percentDelta(a, b) <= maxPercentDelta);
|
||||
|
||||
t._assertApproxEqRel(a, b, maxPercentDelta, CUSTOM_ERROR, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertApproxEqRel_UintErr_Fail(uint256 a, uint256 b, uint256 maxPercentDelta) external {
|
||||
vm.assume(a < type(uint128).max && b < type(uint128).max && b != 0);
|
||||
vm.assume(stdMath.percentDelta(a, b) > maxPercentDelta);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
t._assertApproxEqRel(a, b, maxPercentDelta, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
APPROX_EQ_REL(INT)
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function testAssertApproxEqRel_Int_Pass(int128 a, int128 b, uint128 maxPercentDelta) external {
|
||||
vm.assume(b != 0);
|
||||
vm.assume(stdMath.percentDelta(a, b) <= maxPercentDelta);
|
||||
|
||||
t._assertApproxEqRel(a, b, maxPercentDelta, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertApproxEqRel_Int_Fail(int128 a, int128 b, uint128 maxPercentDelta) external {
|
||||
vm.assume(b != 0);
|
||||
vm.assume(stdMath.percentDelta(a, b) > maxPercentDelta);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log("Error: a ~= b not satisfied [int]");
|
||||
t._assertApproxEqRel(a, b, maxPercentDelta, EXPECT_FAIL);
|
||||
}
|
||||
|
||||
function testAssertApproxEqRel_IntErr_Pass(int128 a, int128 b, uint128 maxPercentDelta) external {
|
||||
vm.assume(b != 0);
|
||||
vm.assume(stdMath.percentDelta(a, b) <= maxPercentDelta);
|
||||
|
||||
t._assertApproxEqRel(a, b, maxPercentDelta, CUSTOM_ERROR, EXPECT_PASS);
|
||||
}
|
||||
|
||||
function testAssertApproxEqRel_IntErr_Fail(int128 a, int128 b, uint128 maxPercentDelta) external {
|
||||
vm.assume(b != 0);
|
||||
vm.assume(stdMath.percentDelta(a, b) > maxPercentDelta);
|
||||
|
||||
vm.expectEmit(false, false, false, true);
|
||||
emit log_named_string("Error", CUSTOM_ERROR);
|
||||
t._assertApproxEqRel(a, b, maxPercentDelta, CUSTOM_ERROR, EXPECT_FAIL);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
contract TestTest is Test
|
||||
{
|
||||
modifier expectFailure(bool expectFail) {
|
||||
bool preState = vm.load(HEVM_ADDRESS, bytes32("failed")) != bytes32(0x00);
|
||||
_;
|
||||
bool postState = vm.load(HEVM_ADDRESS, bytes32("failed")) != bytes32(0x00);
|
||||
|
||||
if (preState == true) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (expectFail) {
|
||||
require(postState == true, "expected failure not triggered");
|
||||
|
||||
// unwind the expected failure
|
||||
vm.store(HEVM_ADDRESS, bytes32("failed"), bytes32(uint256(0x00)));
|
||||
} else {
|
||||
require(postState == false, "unexpected failure was triggered");
|
||||
}
|
||||
}
|
||||
|
||||
function _fail(string memory err) external expectFailure(true) {
|
||||
fail(err);
|
||||
}
|
||||
|
||||
function _assertFalse(bool data, bool expectFail) external expectFailure(expectFail) {
|
||||
assertFalse(data);
|
||||
}
|
||||
|
||||
function _assertFalse(bool data, string memory err, bool expectFail) external expectFailure(expectFail) {
|
||||
assertFalse(data, err);
|
||||
}
|
||||
|
||||
function _assertEq(bool a, bool b, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b);
|
||||
}
|
||||
|
||||
function _assertEq(bool a, bool b, string memory err, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b, err);
|
||||
}
|
||||
|
||||
function _assertEq(bytes memory a, bytes memory b, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b);
|
||||
}
|
||||
|
||||
function _assertEq(bytes memory a,
|
||||
bytes memory b,
|
||||
string memory err,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertEq(a, b, err);
|
||||
}
|
||||
|
||||
function _assertEq(uint256[] memory a, uint256[] memory b, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b);
|
||||
}
|
||||
|
||||
function _assertEq(int256[] memory a, int256[] memory b, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b);
|
||||
}
|
||||
|
||||
function _assertEq(address[] memory a, address[] memory b, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b);
|
||||
}
|
||||
|
||||
function _assertEq(uint256[] memory a, uint256[] memory b, string memory err, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b, err);
|
||||
}
|
||||
|
||||
function _assertEq(int256[] memory a, int256[] memory b, string memory err, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b, err);
|
||||
}
|
||||
|
||||
function _assertEq(address[] memory a, address[] memory b, string memory err, bool expectFail) external expectFailure(expectFail) {
|
||||
assertEq(a, b, err);
|
||||
}
|
||||
|
||||
|
||||
function _assertApproxEqAbs(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 maxDelta,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertApproxEqAbs(a, b, maxDelta);
|
||||
}
|
||||
|
||||
function _assertApproxEqAbs(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 maxDelta,
|
||||
string memory err,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertApproxEqAbs(a, b, maxDelta, err);
|
||||
}
|
||||
|
||||
function _assertApproxEqAbs(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 maxDelta,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertApproxEqAbs(a, b, maxDelta);
|
||||
}
|
||||
|
||||
function _assertApproxEqAbs(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 maxDelta,
|
||||
string memory err,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertApproxEqAbs(a, b, maxDelta, err);
|
||||
}
|
||||
|
||||
function _assertApproxEqRel(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 maxPercentDelta,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertApproxEqRel(a, b, maxPercentDelta);
|
||||
}
|
||||
|
||||
function _assertApproxEqRel(
|
||||
uint256 a,
|
||||
uint256 b,
|
||||
uint256 maxPercentDelta,
|
||||
string memory err,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertApproxEqRel(a, b, maxPercentDelta, err);
|
||||
}
|
||||
|
||||
function _assertApproxEqRel(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 maxPercentDelta,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertApproxEqRel(a, b, maxPercentDelta);
|
||||
}
|
||||
|
||||
function _assertApproxEqRel(
|
||||
int256 a,
|
||||
int256 b,
|
||||
uint256 maxPercentDelta,
|
||||
string memory err,
|
||||
bool expectFail
|
||||
) external expectFailure(expectFail) {
|
||||
assertApproxEqRel(a, b, maxPercentDelta, err);
|
||||
}
|
||||
}
|
|
@ -0,0 +1,193 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.7.0 <0.9.0;
|
||||
|
||||
import "../Test.sol";
|
||||
|
||||
contract StdCheatsTest is Test {
|
||||
Bar test;
|
||||
|
||||
function setUp() public {
|
||||
test = new Bar();
|
||||
}
|
||||
|
||||
function testSkip() public {
|
||||
vm.warp(100);
|
||||
skip(25);
|
||||
assertEq(block.timestamp, 125);
|
||||
}
|
||||
|
||||
function testRewind() public {
|
||||
vm.warp(100);
|
||||
rewind(25);
|
||||
assertEq(block.timestamp, 75);
|
||||
}
|
||||
|
||||
function testHoax() public {
|
||||
hoax(address(1337));
|
||||
test.bar{value: 100}(address(1337));
|
||||
}
|
||||
|
||||
function testHoaxOrigin() public {
|
||||
hoax(address(1337), address(1337));
|
||||
test.origin{value: 100}(address(1337));
|
||||
}
|
||||
|
||||
function testHoaxDifferentAddresses() public {
|
||||
hoax(address(1337), address(7331));
|
||||
test.origin{value: 100}(address(1337), address(7331));
|
||||
}
|
||||
|
||||
function testStartHoax() public {
|
||||
startHoax(address(1337));
|
||||
test.bar{value: 100}(address(1337));
|
||||
test.bar{value: 100}(address(1337));
|
||||
vm.stopPrank();
|
||||
test.bar(address(this));
|
||||
}
|
||||
|
||||
function testStartHoaxOrigin() public {
|
||||
startHoax(address(1337), address(1337));
|
||||
test.origin{value: 100}(address(1337));
|
||||
test.origin{value: 100}(address(1337));
|
||||
vm.stopPrank();
|
||||
test.bar(address(this));
|
||||
}
|
||||
|
||||
function testChangePrank() public {
|
||||
vm.startPrank(address(1337));
|
||||
test.bar(address(1337));
|
||||
changePrank(address(0xdead));
|
||||
test.bar(address(0xdead));
|
||||
changePrank(address(1337));
|
||||
test.bar(address(1337));
|
||||
vm.stopPrank();
|
||||
}
|
||||
|
||||
function testDeal() public {
|
||||
deal(address(this), 1 ether);
|
||||
assertEq(address(this).balance, 1 ether);
|
||||
}
|
||||
|
||||
function testDealToken() public {
|
||||
Bar barToken = new Bar();
|
||||
address bar = address(barToken);
|
||||
deal(bar, address(this), 10000e18);
|
||||
assertEq(barToken.balanceOf(address(this)), 10000e18);
|
||||
}
|
||||
|
||||
function testDealTokenAdjustTS() public {
|
||||
Bar barToken = new Bar();
|
||||
address bar = address(barToken);
|
||||
deal(bar, address(this), 10000e18, true);
|
||||
assertEq(barToken.balanceOf(address(this)), 10000e18);
|
||||
assertEq(barToken.totalSupply(), 20000e18);
|
||||
deal(bar, address(this), 0, true);
|
||||
assertEq(barToken.balanceOf(address(this)), 0);
|
||||
assertEq(barToken.totalSupply(), 10000e18);
|
||||
}
|
||||
|
||||
function testBound() public {
|
||||
assertEq(bound(5, 0, 4), 0);
|
||||
assertEq(bound(0, 69, 69), 69);
|
||||
assertEq(bound(0, 68, 69), 68);
|
||||
assertEq(bound(10, 150, 190), 160);
|
||||
assertEq(bound(300, 2800, 3200), 3100);
|
||||
assertEq(bound(9999, 1337, 6666), 6006);
|
||||
}
|
||||
|
||||
function testCannotBoundMaxLessThanMin() public {
|
||||
vm.expectRevert(bytes("Test bound(uint256,uint256,uint256): Max is less than min."));
|
||||
bound(5, 100, 10);
|
||||
}
|
||||
|
||||
function testBound(
|
||||
uint256 num,
|
||||
uint256 min,
|
||||
uint256 max
|
||||
) public {
|
||||
if (min > max) (min, max) = (max, min);
|
||||
|
||||
uint256 bounded = bound(num, min, max);
|
||||
|
||||
assertGe(bounded, min);
|
||||
assertLe(bounded, max);
|
||||
}
|
||||
|
||||
function testBoundUint256Max() public {
|
||||
assertEq(bound(0, type(uint256).max - 1, type(uint256).max), type(uint256).max - 1);
|
||||
assertEq(bound(1, type(uint256).max - 1, type(uint256).max), type(uint256).max);
|
||||
}
|
||||
|
||||
function testCannotBoundMaxLessThanMin(
|
||||
uint256 num,
|
||||
uint256 min,
|
||||
uint256 max
|
||||
) public {
|
||||
vm.assume(min > max);
|
||||
vm.expectRevert(bytes("Test bound(uint256,uint256,uint256): Max is less than min."));
|
||||
bound(num, min, max);
|
||||
}
|
||||
|
||||
function testDeployCode() public {
|
||||
address deployed = deployCode("StdCheats.t.sol:StdCheatsTest", bytes(""));
|
||||
assertEq(string(getCode(deployed)), string(getCode(address(this))));
|
||||
}
|
||||
|
||||
function testDeployCodeNoArgs() public {
|
||||
address deployed = deployCode("StdCheats.t.sol:StdCheatsTest");
|
||||
assertEq(string(getCode(deployed)), string(getCode(address(this))));
|
||||
}
|
||||
|
||||
function testDeployCodeFail() public {
|
||||
vm.expectRevert(bytes("Test deployCode(string): Deployment failed."));
|
||||
this.deployCode("StdCheats.t.sol:RevertingContract");
|
||||
}
|
||||
|
||||
function getCode(address who) internal view returns (bytes memory o_code) {
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
// retrieve the size of the code, this needs assembly
|
||||
let size := extcodesize(who)
|
||||
// allocate output byte array - this could also be done without assembly
|
||||
// by using o_code = new bytes(size)
|
||||
o_code := mload(0x40)
|
||||
// new "memory end" including padding
|
||||
mstore(0x40, add(o_code, and(add(add(size, 0x20), 0x1f), not(0x1f))))
|
||||
// store length in memory
|
||||
mstore(o_code, size)
|
||||
// actually retrieve the code, this needs assembly
|
||||
extcodecopy(who, add(o_code, 0x20), 0, size)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
contract Bar {
|
||||
constructor() {
|
||||
/// `DEAL` STDCHEAT
|
||||
totalSupply = 10000e18;
|
||||
balanceOf[address(this)] = totalSupply;
|
||||
}
|
||||
|
||||
/// `HOAX` STDCHEATS
|
||||
function bar(address expectedSender) public payable {
|
||||
require(msg.sender == expectedSender, "!prank");
|
||||
}
|
||||
function origin(address expectedSender) public payable {
|
||||
require(msg.sender == expectedSender, "!prank");
|
||||
require(tx.origin == expectedSender, "!prank");
|
||||
}
|
||||
function origin(address expectedSender, address expectedOrigin) public payable {
|
||||
require(msg.sender == expectedSender, "!prank");
|
||||
require(tx.origin == expectedOrigin, "!prank");
|
||||
}
|
||||
|
||||
/// `DEAL` STDCHEAT
|
||||
mapping (address => uint256) public balanceOf;
|
||||
uint256 public totalSupply;
|
||||
}
|
||||
|
||||
contract RevertingContract {
|
||||
constructor() {
|
||||
revert();
|
||||
}
|
||||
}
|
|
@ -0,0 +1,124 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.8.10 <0.9.0;
|
||||
|
||||
import "../Test.sol";
|
||||
|
||||
contract StdErrorsTest is Test {
|
||||
ErrorsTest test;
|
||||
|
||||
function setUp() public {
|
||||
test = new ErrorsTest();
|
||||
}
|
||||
|
||||
function testExpectAssertion() public {
|
||||
vm.expectRevert(stdError.assertionError);
|
||||
test.assertionError();
|
||||
}
|
||||
|
||||
function testExpectArithmetic() public {
|
||||
vm.expectRevert(stdError.arithmeticError);
|
||||
test.arithmeticError(10);
|
||||
}
|
||||
|
||||
function testExpectDiv() public {
|
||||
vm.expectRevert(stdError.divisionError);
|
||||
test.divError(0);
|
||||
}
|
||||
|
||||
function testExpectMod() public {
|
||||
vm.expectRevert(stdError.divisionError);
|
||||
test.modError(0);
|
||||
}
|
||||
|
||||
function testExpectEnum() public {
|
||||
vm.expectRevert(stdError.enumConversionError);
|
||||
test.enumConversion(1);
|
||||
}
|
||||
|
||||
function testExpectEncodeStg() public {
|
||||
vm.expectRevert(stdError.encodeStorageError);
|
||||
test.encodeStgError();
|
||||
}
|
||||
|
||||
function testExpectPop() public {
|
||||
vm.expectRevert(stdError.popError);
|
||||
test.pop();
|
||||
}
|
||||
|
||||
function testExpectOOB() public {
|
||||
vm.expectRevert(stdError.indexOOBError);
|
||||
test.indexOOBError(1);
|
||||
}
|
||||
|
||||
function testExpectMem() public {
|
||||
vm.expectRevert(stdError.memOverflowError);
|
||||
test.mem();
|
||||
}
|
||||
|
||||
function testExpectIntern() public {
|
||||
vm.expectRevert(stdError.zeroVarError);
|
||||
test.intern();
|
||||
}
|
||||
|
||||
function testExpectLowLvl() public {
|
||||
vm.expectRevert(stdError.lowLevelError);
|
||||
test.someArr(0);
|
||||
}
|
||||
}
|
||||
|
||||
contract ErrorsTest {
|
||||
enum T {
|
||||
T1
|
||||
}
|
||||
|
||||
uint256[] public someArr;
|
||||
bytes someBytes;
|
||||
|
||||
function assertionError() public pure {
|
||||
assert(false);
|
||||
}
|
||||
|
||||
function arithmeticError(uint256 a) public pure {
|
||||
a -= 100;
|
||||
}
|
||||
|
||||
function divError(uint256 a) public pure {
|
||||
100 / a;
|
||||
}
|
||||
|
||||
function modError(uint256 a) public pure {
|
||||
100 % a;
|
||||
}
|
||||
|
||||
function enumConversion(uint256 a) public pure {
|
||||
T(a);
|
||||
}
|
||||
|
||||
function encodeStgError() public {
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
sstore(someBytes.slot, 1)
|
||||
}
|
||||
keccak256(someBytes);
|
||||
}
|
||||
|
||||
function pop() public {
|
||||
someArr.pop();
|
||||
}
|
||||
|
||||
function indexOOBError(uint256 a) public pure {
|
||||
uint256[] memory t = new uint256[](0);
|
||||
t[a];
|
||||
}
|
||||
|
||||
function mem() public pure {
|
||||
uint256 l = 2**256 / 32;
|
||||
new uint256[](l);
|
||||
}
|
||||
|
||||
function intern() public returns (uint256) {
|
||||
function(uint256) internal returns (uint256) x;
|
||||
x(2);
|
||||
return 7;
|
||||
}
|
||||
}
|
|
@ -0,0 +1,200 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.8.0 <0.9.0;
|
||||
|
||||
import "../Test.sol";
|
||||
|
||||
contract StdMathTest is Test
|
||||
{
|
||||
function testGetAbs() external {
|
||||
assertEq(stdMath.abs(-50), 50);
|
||||
assertEq(stdMath.abs(50), 50);
|
||||
assertEq(stdMath.abs(-1337), 1337);
|
||||
assertEq(stdMath.abs(0), 0);
|
||||
|
||||
assertEq(stdMath.abs(type(int256).min), (type(uint256).max >> 1) + 1);
|
||||
assertEq(stdMath.abs(type(int256).max), (type(uint256).max >> 1));
|
||||
}
|
||||
|
||||
function testGetAbs_Fuzz(int256 a) external {
|
||||
uint256 manualAbs = getAbs(a);
|
||||
|
||||
uint256 abs = stdMath.abs(a);
|
||||
|
||||
assertEq(abs, manualAbs);
|
||||
}
|
||||
|
||||
function testGetDelta_Uint() external {
|
||||
assertEq(stdMath.delta(uint256(0), uint256(0)), 0);
|
||||
assertEq(stdMath.delta(uint256(0), uint256(1337)), 1337);
|
||||
assertEq(stdMath.delta(uint256(0), type(uint64).max), type(uint64).max);
|
||||
assertEq(stdMath.delta(uint256(0), type(uint128).max), type(uint128).max);
|
||||
assertEq(stdMath.delta(uint256(0), type(uint256).max), type(uint256).max);
|
||||
|
||||
assertEq(stdMath.delta(0, uint256(0)), 0);
|
||||
assertEq(stdMath.delta(1337, uint256(0)), 1337);
|
||||
assertEq(stdMath.delta(type(uint64).max, uint256(0)), type(uint64).max);
|
||||
assertEq(stdMath.delta(type(uint128).max, uint256(0)), type(uint128).max);
|
||||
assertEq(stdMath.delta(type(uint256).max, uint256(0)), type(uint256).max);
|
||||
|
||||
assertEq(stdMath.delta(1337, uint256(1337)), 0);
|
||||
assertEq(stdMath.delta(type(uint256).max, type(uint256).max), 0);
|
||||
assertEq(stdMath.delta(5000, uint256(1250)), 3750);
|
||||
}
|
||||
|
||||
function testGetDelta_Uint_Fuzz(uint256 a, uint256 b) external {
|
||||
uint256 manualDelta;
|
||||
if (a > b) {
|
||||
manualDelta = a - b;
|
||||
} else {
|
||||
manualDelta = b - a;
|
||||
}
|
||||
|
||||
uint256 delta = stdMath.delta(a, b);
|
||||
|
||||
assertEq(delta, manualDelta);
|
||||
}
|
||||
|
||||
function testGetDelta_Int() external {
|
||||
assertEq(stdMath.delta(int256(0), int256(0)), 0);
|
||||
assertEq(stdMath.delta(int256(0), int256(1337)), 1337);
|
||||
assertEq(stdMath.delta(int256(0), type(int64).max), type(uint64).max >> 1);
|
||||
assertEq(stdMath.delta(int256(0), type(int128).max), type(uint128).max >> 1);
|
||||
assertEq(stdMath.delta(int256(0), type(int256).max), type(uint256).max >> 1);
|
||||
|
||||
assertEq(stdMath.delta(0, int256(0)), 0);
|
||||
assertEq(stdMath.delta(1337, int256(0)), 1337);
|
||||
assertEq(stdMath.delta(type(int64).max, int256(0)), type(uint64).max >> 1);
|
||||
assertEq(stdMath.delta(type(int128).max, int256(0)), type(uint128).max >> 1);
|
||||
assertEq(stdMath.delta(type(int256).max, int256(0)), type(uint256).max >> 1);
|
||||
|
||||
assertEq(stdMath.delta(-0, int256(0)), 0);
|
||||
assertEq(stdMath.delta(-1337, int256(0)), 1337);
|
||||
assertEq(stdMath.delta(type(int64).min, int256(0)), (type(uint64).max >> 1) + 1);
|
||||
assertEq(stdMath.delta(type(int128).min, int256(0)), (type(uint128).max >> 1) + 1);
|
||||
assertEq(stdMath.delta(type(int256).min, int256(0)), (type(uint256).max >> 1) + 1);
|
||||
|
||||
assertEq(stdMath.delta(int256(0), -0), 0);
|
||||
assertEq(stdMath.delta(int256(0), -1337), 1337);
|
||||
assertEq(stdMath.delta(int256(0), type(int64).min), (type(uint64).max >> 1) + 1);
|
||||
assertEq(stdMath.delta(int256(0), type(int128).min), (type(uint128).max >> 1) + 1);
|
||||
assertEq(stdMath.delta(int256(0), type(int256).min), (type(uint256).max >> 1) + 1);
|
||||
|
||||
assertEq(stdMath.delta(1337, int256(1337)), 0);
|
||||
assertEq(stdMath.delta(type(int256).max, type(int256).max), 0);
|
||||
assertEq(stdMath.delta(type(int256).min, type(int256).min), 0);
|
||||
assertEq(stdMath.delta(type(int256).min, type(int256).max), type(uint256).max);
|
||||
assertEq(stdMath.delta(5000, int256(1250)), 3750);
|
||||
}
|
||||
|
||||
function testGetDelta_Int_Fuzz(int256 a, int256 b) external {
|
||||
uint256 absA = getAbs(a);
|
||||
uint256 absB = getAbs(b);
|
||||
uint256 absDelta = absA > absB
|
||||
? absA - absB
|
||||
: absB - absA;
|
||||
|
||||
uint256 manualDelta;
|
||||
if ((a >= 0 && b >= 0) || (a < 0 && b < 0)) {
|
||||
manualDelta = absDelta;
|
||||
}
|
||||
// (a < 0 && b >= 0) || (a >= 0 && b < 0)
|
||||
else {
|
||||
manualDelta = absA + absB;
|
||||
}
|
||||
|
||||
uint256 delta = stdMath.delta(a, b);
|
||||
|
||||
assertEq(delta, manualDelta);
|
||||
}
|
||||
|
||||
function testGetPercentDelta_Uint() external {
|
||||
assertEq(stdMath.percentDelta(uint256(0), uint256(1337)), 1e18);
|
||||
assertEq(stdMath.percentDelta(uint256(0), type(uint64).max), 1e18);
|
||||
assertEq(stdMath.percentDelta(uint256(0), type(uint128).max), 1e18);
|
||||
assertEq(stdMath.percentDelta(uint256(0), type(uint192).max), 1e18);
|
||||
|
||||
assertEq(stdMath.percentDelta(1337, uint256(1337)), 0);
|
||||
assertEq(stdMath.percentDelta(type(uint192).max, type(uint192).max), 0);
|
||||
assertEq(stdMath.percentDelta(0, uint256(2500)), 1e18);
|
||||
assertEq(stdMath.percentDelta(2500, uint256(2500)), 0);
|
||||
assertEq(stdMath.percentDelta(5000, uint256(2500)), 1e18);
|
||||
assertEq(stdMath.percentDelta(7500, uint256(2500)), 2e18);
|
||||
|
||||
vm.expectRevert(stdError.divisionError);
|
||||
stdMath.percentDelta(uint256(1), 0);
|
||||
}
|
||||
|
||||
function testGetPercentDelta_Uint_Fuzz(uint192 a, uint192 b) external {
|
||||
vm.assume(b != 0);
|
||||
uint256 manualDelta;
|
||||
if (a > b) {
|
||||
manualDelta = a - b;
|
||||
} else {
|
||||
manualDelta = b - a;
|
||||
}
|
||||
|
||||
uint256 manualPercentDelta = manualDelta * 1e18 / b;
|
||||
uint256 percentDelta = stdMath.percentDelta(a, b);
|
||||
|
||||
assertEq(percentDelta, manualPercentDelta);
|
||||
}
|
||||
|
||||
function testGetPercentDelta_Int() external {
|
||||
assertEq(stdMath.percentDelta(int256(0), int256(1337)), 1e18);
|
||||
assertEq(stdMath.percentDelta(int256(0), -1337), 1e18);
|
||||
assertEq(stdMath.percentDelta(int256(0), type(int64).min), 1e18);
|
||||
assertEq(stdMath.percentDelta(int256(0), type(int128).min), 1e18);
|
||||
assertEq(stdMath.percentDelta(int256(0), type(int192).min), 1e18);
|
||||
assertEq(stdMath.percentDelta(int256(0), type(int64).max), 1e18);
|
||||
assertEq(stdMath.percentDelta(int256(0), type(int128).max), 1e18);
|
||||
assertEq(stdMath.percentDelta(int256(0), type(int192).max), 1e18);
|
||||
|
||||
assertEq(stdMath.percentDelta(1337, int256(1337)), 0);
|
||||
assertEq(stdMath.percentDelta(type(int192).max, type(int192).max), 0);
|
||||
assertEq(stdMath.percentDelta(type(int192).min, type(int192).min), 0);
|
||||
|
||||
assertEq(stdMath.percentDelta(type(int192).min, type(int192).max), 2e18); // rounds the 1 wei diff down
|
||||
assertEq(stdMath.percentDelta(type(int192).max, type(int192).min), 2e18 - 1); // rounds the 1 wei diff down
|
||||
assertEq(stdMath.percentDelta(0, int256(2500)), 1e18);
|
||||
assertEq(stdMath.percentDelta(2500, int256(2500)), 0);
|
||||
assertEq(stdMath.percentDelta(5000, int256(2500)), 1e18);
|
||||
assertEq(stdMath.percentDelta(7500, int256(2500)), 2e18);
|
||||
|
||||
vm.expectRevert(stdError.divisionError);
|
||||
stdMath.percentDelta(int256(1), 0);
|
||||
}
|
||||
|
||||
function testGetPercentDelta_Int_Fuzz(int192 a, int192 b) external {
|
||||
vm.assume(b != 0);
|
||||
uint256 absA = getAbs(a);
|
||||
uint256 absB = getAbs(b);
|
||||
uint256 absDelta = absA > absB
|
||||
? absA - absB
|
||||
: absB - absA;
|
||||
|
||||
uint256 manualDelta;
|
||||
if ((a >= 0 && b >= 0) || (a < 0 && b < 0)) {
|
||||
manualDelta = absDelta;
|
||||
}
|
||||
// (a < 0 && b >= 0) || (a >= 0 && b < 0)
|
||||
else {
|
||||
manualDelta = absA + absB;
|
||||
}
|
||||
|
||||
uint256 manualPercentDelta = manualDelta * 1e18 / absB;
|
||||
uint256 percentDelta = stdMath.percentDelta(a, b);
|
||||
|
||||
assertEq(percentDelta, manualPercentDelta);
|
||||
}
|
||||
|
||||
/*//////////////////////////////////////////////////////////////////////////
|
||||
HELPERS
|
||||
//////////////////////////////////////////////////////////////////////////*/
|
||||
|
||||
function getAbs(int256 a) private pure returns (uint256) {
|
||||
if (a < 0)
|
||||
return a == type(int256).min ? uint256(type(int256).max) + 1 : uint256(-a);
|
||||
|
||||
return uint256(a);
|
||||
}
|
||||
}
|
|
@ -0,0 +1,321 @@
|
|||
// SPDX-License-Identifier: Unlicense
|
||||
pragma solidity >=0.7.0 <0.9.0;
|
||||
|
||||
import "../Test.sol";
|
||||
|
||||
contract StdStorageTest is Test {
|
||||
using stdStorage for StdStorage;
|
||||
|
||||
StorageTest test;
|
||||
|
||||
function setUp() public {
|
||||
test = new StorageTest();
|
||||
}
|
||||
|
||||
function testStorageHidden() public {
|
||||
assertEq(uint256(keccak256("my.random.var")), stdstore.target(address(test)).sig("hidden()").find());
|
||||
}
|
||||
|
||||
function testStorageObvious() public {
|
||||
assertEq(uint256(0), stdstore.target(address(test)).sig("exists()").find());
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteHidden() public {
|
||||
stdstore.target(address(test)).sig(test.hidden.selector).checked_write(100);
|
||||
assertEq(uint256(test.hidden()), 100);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteObvious() public {
|
||||
stdstore.target(address(test)).sig(test.exists.selector).checked_write(100);
|
||||
assertEq(test.exists(), 100);
|
||||
}
|
||||
|
||||
function testStorageMapStructA() public {
|
||||
uint256 slot = stdstore
|
||||
.target(address(test))
|
||||
.sig(test.map_struct.selector)
|
||||
.with_key(address(this))
|
||||
.depth(0)
|
||||
.find();
|
||||
assertEq(uint256(keccak256(abi.encode(address(this), 4))), slot);
|
||||
}
|
||||
|
||||
function testStorageMapStructB() public {
|
||||
uint256 slot = stdstore
|
||||
.target(address(test))
|
||||
.sig(test.map_struct.selector)
|
||||
.with_key(address(this))
|
||||
.depth(1)
|
||||
.find();
|
||||
assertEq(uint256(keccak256(abi.encode(address(this), 4))) + 1, slot);
|
||||
}
|
||||
|
||||
function testStorageDeepMap() public {
|
||||
uint256 slot = stdstore
|
||||
.target(address(test))
|
||||
.sig(test.deep_map.selector)
|
||||
.with_key(address(this))
|
||||
.with_key(address(this))
|
||||
.find();
|
||||
assertEq(uint256(keccak256(abi.encode(address(this), keccak256(abi.encode(address(this), uint(5)))))), slot);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteDeepMap() public {
|
||||
stdstore
|
||||
.target(address(test))
|
||||
.sig(test.deep_map.selector)
|
||||
.with_key(address(this))
|
||||
.with_key(address(this))
|
||||
.checked_write(100);
|
||||
assertEq(100, test.deep_map(address(this), address(this)));
|
||||
}
|
||||
|
||||
function testStorageDeepMapStructA() public {
|
||||
uint256 slot = stdstore
|
||||
.target(address(test))
|
||||
.sig(test.deep_map_struct.selector)
|
||||
.with_key(address(this))
|
||||
.with_key(address(this))
|
||||
.depth(0)
|
||||
.find();
|
||||
assertEq(bytes32(uint256(keccak256(abi.encode(address(this), keccak256(abi.encode(address(this), uint(6)))))) + 0), bytes32(slot));
|
||||
}
|
||||
|
||||
function testStorageDeepMapStructB() public {
|
||||
uint256 slot = stdstore
|
||||
.target(address(test))
|
||||
.sig(test.deep_map_struct.selector)
|
||||
.with_key(address(this))
|
||||
.with_key(address(this))
|
||||
.depth(1)
|
||||
.find();
|
||||
assertEq(bytes32(uint256(keccak256(abi.encode(address(this), keccak256(abi.encode(address(this), uint(6)))))) + 1), bytes32(slot));
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteDeepMapStructA() public {
|
||||
stdstore
|
||||
.target(address(test))
|
||||
.sig(test.deep_map_struct.selector)
|
||||
.with_key(address(this))
|
||||
.with_key(address(this))
|
||||
.depth(0)
|
||||
.checked_write(100);
|
||||
(uint256 a, uint256 b) = test.deep_map_struct(address(this), address(this));
|
||||
assertEq(100, a);
|
||||
assertEq(0, b);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteDeepMapStructB() public {
|
||||
stdstore
|
||||
.target(address(test))
|
||||
.sig(test.deep_map_struct.selector)
|
||||
.with_key(address(this))
|
||||
.with_key(address(this))
|
||||
.depth(1)
|
||||
.checked_write(100);
|
||||
(uint256 a, uint256 b) = test.deep_map_struct(address(this), address(this));
|
||||
assertEq(0, a);
|
||||
assertEq(100, b);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteMapStructA() public {
|
||||
stdstore
|
||||
.target(address(test))
|
||||
.sig(test.map_struct.selector)
|
||||
.with_key(address(this))
|
||||
.depth(0)
|
||||
.checked_write(100);
|
||||
(uint256 a, uint256 b) = test.map_struct(address(this));
|
||||
assertEq(a, 100);
|
||||
assertEq(b, 0);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteMapStructB() public {
|
||||
stdstore
|
||||
.target(address(test))
|
||||
.sig(test.map_struct.selector)
|
||||
.with_key(address(this))
|
||||
.depth(1)
|
||||
.checked_write(100);
|
||||
(uint256 a, uint256 b) = test.map_struct(address(this));
|
||||
assertEq(a, 0);
|
||||
assertEq(b, 100);
|
||||
}
|
||||
|
||||
function testStorageStructA() public {
|
||||
uint256 slot = stdstore.target(address(test)).sig(test.basic.selector).depth(0).find();
|
||||
assertEq(uint256(7), slot);
|
||||
}
|
||||
|
||||
function testStorageStructB() public {
|
||||
uint256 slot = stdstore.target(address(test)).sig(test.basic.selector).depth(1).find();
|
||||
assertEq(uint256(7) + 1, slot);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteStructA() public {
|
||||
stdstore.target(address(test)).sig(test.basic.selector).depth(0).checked_write(100);
|
||||
(uint256 a, uint256 b) = test.basic();
|
||||
assertEq(a, 100);
|
||||
assertEq(b, 1337);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteStructB() public {
|
||||
stdstore.target(address(test)).sig(test.basic.selector).depth(1).checked_write(100);
|
||||
(uint256 a, uint256 b) = test.basic();
|
||||
assertEq(a, 1337);
|
||||
assertEq(b, 100);
|
||||
}
|
||||
|
||||
function testStorageMapAddrFound() public {
|
||||
uint256 slot = stdstore.target(address(test)).sig(test.map_addr.selector).with_key(address(this)).find();
|
||||
assertEq(uint256(keccak256(abi.encode(address(this), uint(1)))), slot);
|
||||
}
|
||||
|
||||
function testStorageMapUintFound() public {
|
||||
uint256 slot = stdstore.target(address(test)).sig(test.map_uint.selector).with_key(100).find();
|
||||
assertEq(uint256(keccak256(abi.encode(100, uint(2)))), slot);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteMapUint() public {
|
||||
stdstore.target(address(test)).sig(test.map_uint.selector).with_key(100).checked_write(100);
|
||||
assertEq(100, test.map_uint(100));
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteMapAddr() public {
|
||||
stdstore.target(address(test)).sig(test.map_addr.selector).with_key(address(this)).checked_write(100);
|
||||
assertEq(100, test.map_addr(address(this)));
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteMapBool() public {
|
||||
stdstore.target(address(test)).sig(test.map_bool.selector).with_key(address(this)).checked_write(true);
|
||||
assertTrue(test.map_bool(address(this)));
|
||||
}
|
||||
|
||||
function testFailStorageCheckedWriteMapPacked() public {
|
||||
// expect PackedSlot error but not external call so cant expectRevert
|
||||
stdstore.target(address(test)).sig(test.read_struct_lower.selector).with_key(address(uint160(1337))).checked_write(100);
|
||||
}
|
||||
|
||||
function testStorageCheckedWriteMapPackedSuccess() public {
|
||||
uint256 full = test.map_packed(address(1337));
|
||||
// keep upper 128, set lower 128 to 1337
|
||||
full = (full & (uint256((1 << 128) - 1) << 128)) | 1337;
|
||||
stdstore.target(address(test)).sig(test.map_packed.selector).with_key(address(uint160(1337))).checked_write(full);
|
||||
assertEq(1337, test.read_struct_lower(address(1337)));
|
||||
}
|
||||
|
||||
function testFailStorageConst() public {
|
||||
// vm.expectRevert(abi.encodeWithSignature("NotStorage(bytes4)", bytes4(keccak256("const()"))));
|
||||
stdstore.target(address(test)).sig("const()").find();
|
||||
}
|
||||
|
||||
function testFailStorageNativePack() public {
|
||||
stdstore.target(address(test)).sig(test.tA.selector).find();
|
||||
stdstore.target(address(test)).sig(test.tB.selector).find();
|
||||
|
||||
// these both would fail
|
||||
stdstore.target(address(test)).sig(test.tC.selector).find();
|
||||
stdstore.target(address(test)).sig(test.tD.selector).find();
|
||||
}
|
||||
|
||||
function testStorageReadBytes32() public {
|
||||
bytes32 val = stdstore.target(address(test)).sig(test.tE.selector).read_bytes32();
|
||||
assertEq(val, hex"1337");
|
||||
}
|
||||
|
||||
function testStorageReadBool_False() public {
|
||||
bool val = stdstore.target(address(test)).sig(test.tB.selector).read_bool();
|
||||
assertEq(val, false);
|
||||
}
|
||||
|
||||
function testStorageReadBool_True() public {
|
||||
bool val = stdstore.target(address(test)).sig(test.tH.selector).read_bool();
|
||||
assertEq(val, true);
|
||||
}
|
||||
|
||||
function testStorageReadBool_Revert() public {
|
||||
vm.expectRevert("stdStorage read_bool(StdStorage): Cannot decode. Make sure you are reading a bool.");
|
||||
this.readNonBoolValue();
|
||||
}
|
||||
|
||||
function readNonBoolValue() public {
|
||||
stdstore.target(address(test)).sig(test.tE.selector).read_bool();
|
||||
}
|
||||
|
||||
function testStorageReadAddress() public {
|
||||
address val = stdstore.target(address(test)).sig(test.tF.selector).read_address();
|
||||
assertEq(val, address(1337));
|
||||
}
|
||||
|
||||
function testStorageReadUint() public {
|
||||
uint256 val = stdstore.target(address(test)).sig(test.exists.selector).read_uint();
|
||||
assertEq(val, 1);
|
||||
}
|
||||
|
||||
function testStorageReadInt() public {
|
||||
int256 val = stdstore.target(address(test)).sig(test.tG.selector).read_int();
|
||||
assertEq(val, type(int256).min);
|
||||
}
|
||||
}
|
||||
|
||||
contract StorageTest {
|
||||
uint256 public exists = 1;
|
||||
mapping(address => uint256) public map_addr;
|
||||
mapping(uint256 => uint256) public map_uint;
|
||||
mapping(address => uint256) public map_packed;
|
||||
mapping(address => UnpackedStruct) public map_struct;
|
||||
mapping(address => mapping(address => uint256)) public deep_map;
|
||||
mapping(address => mapping(address => UnpackedStruct)) public deep_map_struct;
|
||||
UnpackedStruct public basic;
|
||||
|
||||
uint248 public tA;
|
||||
bool public tB;
|
||||
|
||||
|
||||
bool public tC = false;
|
||||
uint248 public tD = 1;
|
||||
|
||||
|
||||
struct UnpackedStruct {
|
||||
uint256 a;
|
||||
uint256 b;
|
||||
}
|
||||
|
||||
mapping(address => bool) public map_bool;
|
||||
|
||||
bytes32 public tE = hex"1337";
|
||||
address public tF = address(1337);
|
||||
int256 public tG = type(int256).min;
|
||||
bool public tH = true;
|
||||
|
||||
constructor() {
|
||||
basic = UnpackedStruct({
|
||||
a: 1337,
|
||||
b: 1337
|
||||
});
|
||||
|
||||
uint256 two = (1<<128) | 1;
|
||||
map_packed[msg.sender] = two;
|
||||
map_packed[address(bytes20(uint160(1337)))] = 1<<128;
|
||||
}
|
||||
|
||||
function read_struct_upper(address who) public view returns (uint256) {
|
||||
return map_packed[who] >> 128;
|
||||
}
|
||||
|
||||
function read_struct_lower(address who) public view returns (uint256) {
|
||||
return map_packed[who] & ((1 << 128) - 1);
|
||||
}
|
||||
|
||||
function hidden() public view returns (bytes32 t) {
|
||||
bytes32 slot = keccak256("my.random.var");
|
||||
/// @solidity memory-safe-assembly
|
||||
assembly {
|
||||
t := sload(slot)
|
||||
}
|
||||
}
|
||||
|
||||
function const() public pure returns (bytes32 t) {
|
||||
t = bytes32(hex"1337");
|
||||
}
|
||||
}
|
|
@ -0,0 +1 @@
|
|||
Subproject commit 548ab3c07ab4c60185667f04565861a25d2d6763
|
|
@ -0,0 +1,40 @@
|
|||
{
|
||||
"name": "@prb/foundry-template",
|
||||
"description": "Foundry-based template for developing Solidity smart contracts",
|
||||
"version": "1.0.0",
|
||||
"author": {
|
||||
"name": "Paul Razvan Berg",
|
||||
"url": "https://github.com/paulrberg"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "^17.0.3",
|
||||
"@commitlint/config-conventional": "^17.0.3",
|
||||
"commitizen": "^4.2.4",
|
||||
"cz-conventional-changelog": "^3.3.0",
|
||||
"husky": "^8.0.1",
|
||||
"lint-staged": "^13.0.3",
|
||||
"prettier": "^2.7.1",
|
||||
"prettier-plugin-solidity": "^1.0.0-dev.22",
|
||||
"solhint": "^3.3.7",
|
||||
"solhint-plugin-prettier": "^0.0.5"
|
||||
},
|
||||
"keywords": [
|
||||
"blockchain",
|
||||
"ethereum",
|
||||
"forge",
|
||||
"foundry",
|
||||
"smart-contracts",
|
||||
"solidity",
|
||||
"template"
|
||||
],
|
||||
"packageManager": "yarn@3.2.1",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"lint": "yarn solhint && yarn prettier:check",
|
||||
"lint:check": "yarn prettier:check && yarn solhint:check",
|
||||
"postinstall": "husky install",
|
||||
"prettier": "prettier --config \"./.prettierrc.yml\" --write \"**/*.{json,md,sol,yml}\"",
|
||||
"prettier:check": "prettier --config \"./.prettierrc.yml\" --check \"**/*.{json,md,sol,yml}\"",
|
||||
"solhint": "solhint --config \"./.solhint.json\" \"{src,test}/**/*.sol\""
|
||||
}
|
||||
}
|
|
@ -0,0 +1,2 @@
|
|||
@prb/test/=lib/prb-test/src/
|
||||
forge-std/=lib/forge-std/src/
|
|
@ -0,0 +1,16 @@
|
|||
// SPDX-License-Identifier: UNLICENSED
|
||||
pragma solidity >=0.8.4;
|
||||
|
||||
import { Script } from "forge-std/Script.sol";
|
||||
import { Foo } from "../src/Foo.sol";
|
||||
|
||||
/// @dev See the Solidity Scripting tutorial: https://book.getfoundry.sh/tutorials/solidity-scripting
|
||||
contract FooScript is Script {
|
||||
Foo internal foo;
|
||||
|
||||
function run() public {
|
||||
vm.startBroadcast();
|
||||
foo = new Foo();
|
||||
vm.stopBroadcast();
|
||||
}
|
||||
}
|
|
@ -0,0 +1,6 @@
|
|||
// SPDX-License-Identifier: UNLICENSED
|
||||
pragma solidity >=0.8.4;
|
||||
|
||||
contract Foo {
|
||||
// solhint-disable-previous-line no-empty-blocks
|
||||
}
|
|
@ -0,0 +1,19 @@
|
|||
// SPDX-License-Identifier: UNLICENSED
|
||||
pragma solidity >=0.8.4;
|
||||
|
||||
import { console } from "forge-std/console.sol";
|
||||
import { PRBTest } from "@prb/test/PRBTest.sol";
|
||||
|
||||
/// @dev See the "Writing Tests" section in the Foundry Book if this is your first time with Forge.
|
||||
/// https://book.getfoundry.sh/forge/writing-tests
|
||||
contract ContractTest is PRBTest {
|
||||
function setUp() public {
|
||||
// solhint-disable-previous-line no-empty-blocks
|
||||
}
|
||||
|
||||
/// @dev Run Forge with `-vvvv` to see console logs.
|
||||
function testExample() public {
|
||||
console.log("Hello World");
|
||||
assertTrue(true);
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue