├── .gitattributes ├── .github ├── CODEOWNERS ├── PULL_REQUEST_TEMPLATE.md └── workflows │ ├── pull-request.yml │ ├── push-to-main.yml │ └── slither.yaml ├── .gitignore ├── .gitmodules ├── LICENSE ├── Makefile ├── README.md ├── build.sh ├── contracts ├── ERC20.sol ├── interfaces │ └── IERC20.sol └── test │ ├── ERC20.t.sol │ ├── accounts │ └── ERC20User.sol │ └── mocks │ └── MockERC20.sol ├── foundry.toml ├── package.yaml ├── release.sh └── test.sh /.gitattributes: -------------------------------------------------------------------------------- 1 | *.sol linguist-language=Solidity 2 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # These owners will be the default owners for everything in the repo. 2 | * @maple-labs/smart-contracts-admin 3 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | # Integrations Checklist 4 | 5 | - [ ] Have any function signatures changed? If yes, outline below. 6 | - [ ] Have any features changed or been added? If yes, outline below. 7 | - [ ] Have any events changed or been added? If yes, outline below. 8 | - [ ] Has all documentation been updated? 9 | 10 | # Changelog 11 | 12 | ## Function Signature Changes 13 | 14 | ## Features 15 | 16 | ## Events 17 | -------------------------------------------------------------------------------- /.github/workflows/pull-request.yml: -------------------------------------------------------------------------------- 1 | name: Basic PR Tests 2 | 3 | on: [pull_request] 4 | 5 | jobs: 6 | run-ci: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v2 10 | 11 | - name: Install Foundry 12 | uses: onbjerg/foundry-toolchain@v1 13 | with: 14 | version: nightly 15 | 16 | - name: Install submodules 17 | run: | 18 | git config --global url."https://github.com/".insteadOf "git@github.com:" 19 | git submodule update --init --recursive 20 | 21 | - name: Run forge tests 22 | run: ./test.sh -p deep 23 | -------------------------------------------------------------------------------- /.github/workflows/push-to-main.yml: -------------------------------------------------------------------------------- 1 | name: 50k fuzz run test on push to main 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | run-ci: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v2 13 | 14 | - name: Install Foundry 15 | uses: onbjerg/foundry-toolchain@v1 16 | with: 17 | version: nightly 18 | 19 | - name: Install submodules 20 | run: | 21 | git config --global url."https://github.com/".insteadOf "git@github.com:" 22 | git submodule update --init --recursive 23 | 24 | - name: Run forge tests 25 | run: ./test.sh -p super_deep 26 | -------------------------------------------------------------------------------- /.github/workflows/slither.yaml: -------------------------------------------------------------------------------- 1 | name: Static Analysis 2 | on: 3 | push: 4 | branches: "*" 5 | 6 | jobs: 7 | build: 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v2 12 | 13 | - name: Set up Python ${{ matrix.python-version }} 14 | uses: actions/setup-python@v2 15 | with: 16 | python-version: 3.8 17 | 18 | - name: Install dependencies 19 | run: | 20 | sudo snap install solc 21 | python -m pip install --upgrade pip 22 | pip install slither-analyzer==0.8.2 solc-select==0.2.1 23 | solc-select install 0.8.7 24 | solc-select use 0.8.7 25 | 26 | - name: Install submodules 27 | run: | 28 | git config --global url."https://github.com/".insteadOf "git@github.com:" 29 | git submodule update --init --recursive 30 | 31 | - name: Summary of static analysis 32 | run: | 33 | slither contracts --print human-summary 34 | 35 | - name: Contract summary of static analysis 36 | run: | 37 | slither contracts --print contract-summary 38 | 39 | - name: Function summary 40 | run: | 41 | slither contracts --print function-summary 42 | 43 | - name: Inheritance 44 | run: | 45 | slither contracts --print inheritance 46 | 47 | - name: Data dependency 48 | run: | 49 | slither contracts --print data-dependency 50 | 51 | - name: Static Analysis 52 | run: | 53 | slither contracts 54 | continue-on-error: true 55 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | out/* 2 | hevm* 3 | .vscode/* 4 | artifacts/* 5 | docs/* 6 | metadata.json 7 | /out 8 | /cache 9 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "modules/forge-std"] 2 | path = modules/forge-std 3 | url = https://github.com/foundry-rs/forge-std 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all :; make prod 2 | prod :; ./build.sh -c ./config/prod.json 3 | dev :; ./build.sh -c ./config/dev.json 4 | ci :; ./build.sh -c ./config/ci.json 5 | clean :; dapp clean 6 | test :; ./test.sh 7 | release :; ./release.sh 8 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ERC-20 2 | 3 | ![Foundry CI](https://github.com/maple-labs/erc20/actions/workflows/push-to-main.yml/badge.svg) [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0) 4 | 5 | ## Overview 6 | 7 | Basic ERC-20 contract designed to be inherited and extended. Leveraging native overflow checks in solc 0.8 to simplify ERC-20 implementation. It should be noted that this ERC-20 implementation does not include some functionality that is commonly used in other tokens, such as: 8 | - `address(0)` checks on `_transfer` 9 | - `push` 10 | - `pull` 11 | 12 | This was intentional, as this ERC-20 was intended to have the minimum functionality necessary, allowing for maximum extendability and customizability. 13 | 14 | This token implementation includes ERC-2612 [permit](https://eips.ethereum.org/EIPS/eip-2612) capability as well as `increaseAllowance` and `decreaseAllowance` functions. 15 | 16 | ## Setup 17 | 18 | This project was built using [Foundry](https://book.getfoundry.sh/). Refer to installation instructions [here](https://github.com/foundry-rs/foundry#installation). 19 | 20 | ```sh 21 | git clone git@github.com:maple-labs/erc20.git 22 | cd erc20 23 | forge install 24 | ``` 25 | 26 | ## Running Tests 27 | 28 | - To run all tests: `forge test` 29 | - To run specific tests: `forge test --match ` 30 | 31 | `./scripts/test.sh` is used to enable Foundry profile usage with the `-p` flag. Profiles are used to specify the number of fuzz runs. 32 | 33 | ## Acknowledgements 34 | These contracts were inspired by and/or directly modified from the following sources: 35 | - [Solmate](https://github.com/Rari-Capital/solmate) 36 | - [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts) 37 | - [DSS](https://github.com/makerdao/dss) 38 | 39 | ## Audit Reports 40 | | Auditor | Report link | 41 | |---|---| 42 | | Trail of Bits | [ToB Report - April 12, 2022](https://docs.google.com/viewer?url=https://github.com/maple-labs/maple-core/files/8507237/Maple.Finance.-.Final.Report.-.Fixes.pdf) | 43 | | Code 4rena | [C4 Report - April 20, 2022](https://code4rena.com/reports/2022-03-maple/) | 44 | 45 | ## Bug Bounty 46 | 47 | For all information related to the ongoing bug bounty for these contracts run by [Immunefi](https://immunefi.com/), please visit this [site](https://immunefi.com/bounty/maple/). 48 | 49 | ## About Maple 50 | Maple is a decentralized corporate credit market. Maple provides capital to institutional borrowers through globally accessible fixed-income yield opportunities. 51 | 52 | For all technical documentation related to the Maple protocol, please refer to the GitHub [wiki](https://github.com/maple-labs/maple-core-v2/wiki). 53 | 54 | --- 55 | 56 |

57 | 58 |

59 | -------------------------------------------------------------------------------- /build.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | while getopts t:r:b:v:c: flag 5 | do 6 | case "${flag}" in 7 | c) config=${OPTARG};; 8 | esac 9 | done 10 | 11 | config=$([ -z "$config" ] && echo "./config/prod.json" || echo "$config") 12 | 13 | export DAPP_SOLC_VERSION=0.8.7 14 | export DAPP_LINK_TEST_LIBRARIES=0 15 | export DAPP_STANDARD_JSON=$config 16 | 17 | dapp build 18 | -------------------------------------------------------------------------------- /contracts/ERC20.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-only 2 | pragma solidity ^0.8.7; 3 | 4 | import { IERC20 } from "./interfaces/IERC20.sol"; 5 | 6 | /* 7 | ███████╗██████╗ ██████╗ ██████╗ ██████╗ 8 | ██╔════╝██╔══██╗██╔════╝ ╚════██╗██╔═████╗ 9 | █████╗ ██████╔╝██║ █████╔╝██║██╔██║ 10 | ██╔══╝ ██╔══██╗██║ ██╔═══╝ ████╔╝██║ 11 | ███████╗██║ ██║╚██████╗ ███████╗╚██████╔╝ 12 | ╚══════╝╚═╝ ╚═╝ ╚═════╝ ╚══════╝ ╚═════╝ 13 | */ 14 | 15 | /** 16 | * @title Modern ERC-20 implementation. 17 | * @dev Acknowledgements to Solmate, OpenZeppelin, and DSS for inspiring this code. 18 | */ 19 | contract ERC20 is IERC20 { 20 | 21 | /**************************************************************************************************************************************/ 22 | /*** ERC-20 ***/ 23 | /**************************************************************************************************************************************/ 24 | 25 | string public override name; 26 | string public override symbol; 27 | 28 | uint8 public immutable override decimals; 29 | 30 | uint256 public override totalSupply; 31 | 32 | mapping(address => uint256) public override balanceOf; 33 | 34 | mapping(address => mapping(address => uint256)) public override allowance; 35 | 36 | /**************************************************************************************************************************************/ 37 | /*** ERC-2612 ***/ 38 | /**************************************************************************************************************************************/ 39 | 40 | // PERMIT_TYPEHASH = keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)"); 41 | bytes32 public constant override PERMIT_TYPEHASH = 0x6e71edae12b1b97f4d1f60370fef10105fa2faae0126114a169c64845d6126c9; 42 | 43 | mapping(address => uint256) public override nonces; 44 | 45 | /** 46 | * @param name_ The name of the token. 47 | * @param symbol_ The symbol of the token. 48 | * @param decimals_ The decimal precision used by the token. 49 | */ 50 | constructor(string memory name_, string memory symbol_, uint8 decimals_) { 51 | name = name_; 52 | symbol = symbol_; 53 | decimals = decimals_; 54 | } 55 | 56 | /**************************************************************************************************************************************/ 57 | /*** External Functions ***/ 58 | /**************************************************************************************************************************************/ 59 | 60 | function approve(address spender_, uint256 amount_) public virtual override returns (bool success_) { 61 | _approve(msg.sender, spender_, amount_); 62 | return true; 63 | } 64 | 65 | function decreaseAllowance(address spender_, uint256 subtractedAmount_) public virtual override returns (bool success_) { 66 | _decreaseAllowance(msg.sender, spender_, subtractedAmount_); 67 | return true; 68 | } 69 | 70 | function increaseAllowance(address spender_, uint256 addedAmount_) public virtual override returns (bool success_) { 71 | _approve(msg.sender, spender_, allowance[msg.sender][spender_] + addedAmount_); 72 | return true; 73 | } 74 | 75 | function permit(address owner_, address spender_, uint256 amount_, uint256 deadline_, uint8 v_, bytes32 r_, bytes32 s_) 76 | public virtual override 77 | { 78 | require(deadline_ >= block.timestamp, "ERC20:P:EXPIRED"); 79 | 80 | // Appendix F in the Ethereum Yellow paper (https://ethereum.github.io/yellowpaper/paper.pdf), defines 81 | // the valid range for s in (301): 0 < s < secp256k1n ÷ 2 + 1, and for v in (302): v ∈ {27, 28}. 82 | require( 83 | uint256(s_) <= uint256(0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0) && 84 | (v_ == 27 || v_ == 28), 85 | "ERC20:P:MALLEABLE" 86 | ); 87 | 88 | // Nonce realistically cannot overflow. 89 | unchecked { 90 | bytes32 digest_ = keccak256( 91 | abi.encodePacked( 92 | "\x19\x01", 93 | DOMAIN_SEPARATOR(), 94 | keccak256(abi.encode(PERMIT_TYPEHASH, owner_, spender_, amount_, nonces[owner_]++, deadline_)) 95 | ) 96 | ); 97 | 98 | address recoveredAddress_ = ecrecover(digest_, v_, r_, s_); 99 | 100 | require(recoveredAddress_ == owner_ && owner_ != address(0), "ERC20:P:INVALID_SIGNATURE"); 101 | } 102 | 103 | _approve(owner_, spender_, amount_); 104 | } 105 | 106 | function transfer(address recipient_, uint256 amount_) public virtual override returns (bool success_) { 107 | _transfer(msg.sender, recipient_, amount_); 108 | return true; 109 | } 110 | 111 | function transferFrom(address owner_, address recipient_, uint256 amount_) public virtual override returns (bool success_) { 112 | _decreaseAllowance(owner_, msg.sender, amount_); 113 | _transfer(owner_, recipient_, amount_); 114 | return true; 115 | } 116 | 117 | /**************************************************************************************************************************************/ 118 | /*** View Functions ***/ 119 | /**************************************************************************************************************************************/ 120 | 121 | function DOMAIN_SEPARATOR() public view override returns (bytes32 domainSeparator_) { 122 | return keccak256( 123 | abi.encode( 124 | keccak256("EIP712Domain(string name,string version,uint256 chainId,address verifyingContract)"), 125 | keccak256(bytes(name)), 126 | keccak256(bytes("1")), 127 | block.chainid, 128 | address(this) 129 | ) 130 | ); 131 | } 132 | 133 | /**************************************************************************************************************************************/ 134 | /*** Internal Functions ***/ 135 | /**************************************************************************************************************************************/ 136 | 137 | function _approve(address owner_, address spender_, uint256 amount_) internal { 138 | emit Approval(owner_, spender_, allowance[owner_][spender_] = amount_); 139 | } 140 | 141 | function _burn(address owner_, uint256 amount_) internal { 142 | balanceOf[owner_] -= amount_; 143 | 144 | // Cannot underflow because a user's balance will never be larger than the total supply. 145 | unchecked { totalSupply -= amount_; } 146 | 147 | emit Transfer(owner_, address(0), amount_); 148 | } 149 | 150 | function _decreaseAllowance(address owner_, address spender_, uint256 subtractedAmount_) internal { 151 | uint256 spenderAllowance = allowance[owner_][spender_]; // Cache to memory. 152 | 153 | if (spenderAllowance != type(uint256).max) { 154 | _approve(owner_, spender_, spenderAllowance - subtractedAmount_); 155 | } 156 | } 157 | 158 | function _mint(address recipient_, uint256 amount_) internal { 159 | totalSupply += amount_; 160 | 161 | // Cannot overflow because totalSupply would first overflow in the statement above. 162 | unchecked { balanceOf[recipient_] += amount_; } 163 | 164 | emit Transfer(address(0), recipient_, amount_); 165 | } 166 | 167 | function _transfer(address owner_, address recipient_, uint256 amount_) internal { 168 | balanceOf[owner_] -= amount_; 169 | 170 | // Cannot overflow because minting prevents overflow of totalSupply, and sum of user balances == totalSupply. 171 | unchecked { balanceOf[recipient_] += amount_; } 172 | 173 | emit Transfer(owner_, recipient_, amount_); 174 | } 175 | 176 | } 177 | -------------------------------------------------------------------------------- /contracts/interfaces/IERC20.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-only 2 | pragma solidity ^0.8.7; 3 | 4 | /// @title Interface of the ERC20 standard as defined in the EIP, including EIP-2612 permit functionality. 5 | interface IERC20 { 6 | 7 | /**************************************************************************************************************************************/ 8 | /*** Events ***/ 9 | /**************************************************************************************************************************************/ 10 | 11 | /** 12 | * @dev Emitted when one account has set the allowance of another account over their tokens. 13 | * @param owner_ Account that tokens are approved from. 14 | * @param spender_ Account that tokens are approved for. 15 | * @param amount_ Amount of tokens that have been approved. 16 | */ 17 | event Approval(address indexed owner_, address indexed spender_, uint256 amount_); 18 | 19 | /** 20 | * @dev Emitted when tokens have moved from one account to another. 21 | * @param owner_ Account that tokens have moved from. 22 | * @param recipient_ Account that tokens have moved to. 23 | * @param amount_ Amount of tokens that have been transferred. 24 | */ 25 | event Transfer(address indexed owner_, address indexed recipient_, uint256 amount_); 26 | 27 | /**************************************************************************************************************************************/ 28 | /*** External Functions ***/ 29 | /**************************************************************************************************************************************/ 30 | 31 | /** 32 | * @dev Function that allows one account to set the allowance of another account over their tokens. 33 | * Emits an {Approval} event. 34 | * @param spender_ Account that tokens are approved for. 35 | * @param amount_ Amount of tokens that have been approved. 36 | * @return success_ Boolean indicating whether the operation succeeded. 37 | */ 38 | function approve(address spender_, uint256 amount_) external returns (bool success_); 39 | 40 | /** 41 | * @dev Function that allows one account to decrease the allowance of another account over their tokens. 42 | * Emits an {Approval} event. 43 | * @param spender_ Account that tokens are approved for. 44 | * @param subtractedAmount_ Amount to decrease approval by. 45 | * @return success_ Boolean indicating whether the operation succeeded. 46 | */ 47 | function decreaseAllowance(address spender_, uint256 subtractedAmount_) external returns (bool success_); 48 | 49 | /** 50 | * @dev Function that allows one account to increase the allowance of another account over their tokens. 51 | * Emits an {Approval} event. 52 | * @param spender_ Account that tokens are approved for. 53 | * @param addedAmount_ Amount to increase approval by. 54 | * @return success_ Boolean indicating whether the operation succeeded. 55 | */ 56 | function increaseAllowance(address spender_, uint256 addedAmount_) external returns (bool success_); 57 | 58 | /** 59 | * @dev Approve by signature. 60 | * @param owner_ Owner address that signed the permit. 61 | * @param spender_ Spender of the permit. 62 | * @param amount_ Permit approval spend limit. 63 | * @param deadline_ Deadline after which the permit is invalid. 64 | * @param v_ ECDSA signature v component. 65 | * @param r_ ECDSA signature r component. 66 | * @param s_ ECDSA signature s component. 67 | */ 68 | function permit(address owner_, address spender_, uint amount_, uint deadline_, uint8 v_, bytes32 r_, bytes32 s_) external; 69 | 70 | /** 71 | * @dev Moves an amount of tokens from `msg.sender` to a specified account. 72 | * Emits a {Transfer} event. 73 | * @param recipient_ Account that receives tokens. 74 | * @param amount_ Amount of tokens that are transferred. 75 | * @return success_ Boolean indicating whether the operation succeeded. 76 | */ 77 | function transfer(address recipient_, uint256 amount_) external returns (bool success_); 78 | 79 | /** 80 | * @dev Moves a pre-approved amount of tokens from a sender to a specified account. 81 | * Emits a {Transfer} event. 82 | * Emits an {Approval} event. 83 | * @param owner_ Account that tokens are moving from. 84 | * @param recipient_ Account that receives tokens. 85 | * @param amount_ Amount of tokens that are transferred. 86 | * @return success_ Boolean indicating whether the operation succeeded. 87 | */ 88 | function transferFrom(address owner_, address recipient_, uint256 amount_) external returns (bool success_); 89 | 90 | /**************************************************************************************************************************************/ 91 | /*** View Functions ***/ 92 | /**************************************************************************************************************************************/ 93 | 94 | /** 95 | * @dev Returns the allowance that one account has given another over their tokens. 96 | * @param owner_ Account that tokens are approved from. 97 | * @param spender_ Account that tokens are approved for. 98 | * @return allowance_ Allowance that one account has given another over their tokens. 99 | */ 100 | function allowance(address owner_, address spender_) external view returns (uint256 allowance_); 101 | 102 | /** 103 | * @dev Returns the amount of tokens owned by a given account. 104 | * @param account_ Account that owns the tokens. 105 | * @return balance_ Amount of tokens owned by a given account. 106 | */ 107 | function balanceOf(address account_) external view returns (uint256 balance_); 108 | 109 | /** 110 | * @dev Returns the decimal precision used by the token. 111 | * @return decimals_ The decimal precision used by the token. 112 | */ 113 | function decimals() external view returns (uint8 decimals_); 114 | 115 | /** 116 | * @dev Returns the signature domain separator. 117 | * @return domainSeparator_ The signature domain separator. 118 | */ 119 | function DOMAIN_SEPARATOR() external view returns (bytes32 domainSeparator_); 120 | 121 | /** 122 | * @dev Returns the name of the token. 123 | * @return name_ The name of the token. 124 | */ 125 | function name() external view returns (string memory name_); 126 | 127 | /** 128 | * @dev Returns the nonce for the given owner. 129 | * @param owner_ The address of the owner account. 130 | * @return nonce_ The nonce for the given owner. 131 | */ 132 | function nonces(address owner_) external view returns (uint256 nonce_); 133 | 134 | /** 135 | * @dev Returns the permit type hash. 136 | * @return permitTypehash_ The permit type hash. 137 | */ 138 | function PERMIT_TYPEHASH() external view returns (bytes32 permitTypehash_); 139 | 140 | /** 141 | * @dev Returns the symbol of the token. 142 | * @return symbol_ The symbol of the token. 143 | */ 144 | function symbol() external view returns (string memory symbol_); 145 | 146 | /** 147 | * @dev Returns the total amount of tokens in existence. 148 | * @return totalSupply_ The total amount of tokens in existence. 149 | */ 150 | function totalSupply() external view returns (uint256 totalSupply_); 151 | 152 | } 153 | -------------------------------------------------------------------------------- /contracts/test/ERC20.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-only 2 | pragma solidity ^0.8.7; 3 | 4 | import { Test } from "../../modules/forge-std/src/Test.sol"; 5 | 6 | import { IERC20 } from "../interfaces/IERC20.sol"; 7 | 8 | import { ERC20 } from "../ERC20.sol"; 9 | 10 | import { ERC20User } from "./accounts/ERC20User.sol"; 11 | import { MockERC20 } from "./mocks/MockERC20.sol"; 12 | 13 | contract ERC20BaseTest is Test { 14 | 15 | address internal immutable self = address(this); 16 | 17 | bytes internal constant ARITHMETIC_ERROR = abi.encodeWithSignature("Panic(uint256)", 0x11); 18 | 19 | MockERC20 internal _token; 20 | 21 | function setUp() public virtual { 22 | _token = new MockERC20("Token", "TKN", 18); 23 | } 24 | 25 | function invariant_metadata() public { 26 | assertEq(_token.name(), "Token"); 27 | assertEq(_token.symbol(), "TKN"); 28 | assertEq(_token.decimals(), 18); 29 | } 30 | 31 | function testFuzz_metadata(string memory name_, string memory symbol_, uint8 decimals_) public { 32 | MockERC20 mockToken = new MockERC20(name_, symbol_, decimals_); 33 | 34 | assertEq(mockToken.name(), name_); 35 | assertEq(mockToken.symbol(), symbol_); 36 | assertEq(mockToken.decimals(), decimals_); 37 | } 38 | 39 | function testFuzz_mint(address account_, uint256 amount_) public { 40 | _token.mint(account_, amount_); 41 | 42 | assertEq(_token.totalSupply(), amount_); 43 | assertEq(_token.balanceOf(account_), amount_); 44 | } 45 | 46 | function testFuzz_burn(address account_, uint256 amount0_, uint256 amount1_) public { 47 | if (amount1_ > amount0_) return; // Mint amount must exceed burn amount. 48 | 49 | _token.mint(account_, amount0_); 50 | _token.burn(account_, amount1_); 51 | 52 | assertEq(_token.totalSupply(), amount0_ - amount1_); 53 | assertEq(_token.balanceOf(account_), amount0_ - amount1_); 54 | } 55 | 56 | function testFuzz_approve(address account_, uint256 amount_) public { 57 | assertTrue(_token.approve(account_, amount_)); 58 | 59 | assertEq(_token.allowance(self, account_), amount_); 60 | } 61 | 62 | function testFuzz_increaseAllowance(address account_, uint256 initialAmount_, uint256 addedAmount_) public { 63 | initialAmount_ = bound(initialAmount_, 0, type(uint256).max / 2); 64 | addedAmount_ = bound(addedAmount_, 0, type(uint256).max / 2); 65 | 66 | _token.approve(account_, initialAmount_); 67 | 68 | assertEq(_token.allowance(self, account_), initialAmount_); 69 | 70 | assertTrue(_token.increaseAllowance(account_, addedAmount_)); 71 | 72 | assertEq(_token.allowance(self, account_), initialAmount_ + addedAmount_); 73 | } 74 | 75 | function testFuzz_decreaseAllowance_infiniteApproval(address account_, uint256 subtractedAmount_) public { 76 | uint256 MAX_UINT256 = type(uint256).max; 77 | 78 | subtractedAmount_ = bound(subtractedAmount_, 0, MAX_UINT256); 79 | 80 | _token.approve(account_, MAX_UINT256); 81 | 82 | assertEq(_token.allowance(self, account_), MAX_UINT256); 83 | 84 | assertTrue(_token.decreaseAllowance(account_, subtractedAmount_)); 85 | 86 | assertEq(_token.allowance(self, account_), MAX_UINT256); 87 | } 88 | 89 | function testFuzz_decreaseAllowance_nonInfiniteApproval(address account_, uint256 initialAmount_, uint256 subtractedAmount_) public { 90 | initialAmount_ = bound(initialAmount_, 0, type(uint256).max - 1); 91 | subtractedAmount_ = bound(subtractedAmount_, 0, initialAmount_); 92 | 93 | _token.approve(account_, initialAmount_); 94 | 95 | assertEq(_token.allowance(self, account_), initialAmount_); 96 | 97 | assertTrue(_token.decreaseAllowance(account_, subtractedAmount_)); 98 | 99 | assertEq(_token.allowance(self, account_), initialAmount_ - subtractedAmount_); 100 | } 101 | 102 | function testFuzz_transfer(address account_, uint256 amount_) public { 103 | _token.mint(self, amount_); 104 | 105 | assertTrue(_token.transfer(account_, amount_)); 106 | 107 | assertEq(_token.totalSupply(), amount_); 108 | 109 | if (self == account_) { 110 | assertEq(_token.balanceOf(self), amount_); 111 | } else { 112 | assertEq(_token.balanceOf(self), 0); 113 | assertEq(_token.balanceOf(account_), amount_); 114 | } 115 | } 116 | 117 | function testFuzz_transferFrom(address recipient_, uint256 approval_, uint256 amount_) public { 118 | approval_ = bound(approval_, 0, type(uint256).max - 1); 119 | amount_ = bound(amount_, 0, approval_); 120 | 121 | ERC20User owner = new ERC20User(); 122 | 123 | _token.mint(address(owner), amount_); 124 | owner.erc20_approve(address(_token), self, approval_); 125 | 126 | assertTrue(_token.transferFrom(address(owner), recipient_, amount_)); 127 | 128 | assertEq(_token.totalSupply(), amount_); 129 | 130 | approval_ = address(owner) == self ? approval_ : approval_ - amount_; 131 | 132 | assertEq(_token.allowance(address(owner), self), approval_); 133 | 134 | if (address(owner) == recipient_) { 135 | assertEq(_token.balanceOf(address(owner)), amount_); 136 | } else { 137 | assertEq(_token.balanceOf(address(owner)), 0); 138 | assertEq(_token.balanceOf(recipient_), amount_); 139 | } 140 | } 141 | 142 | function testFuzz_transferFrom_infiniteApproval(address recipient_, uint256 amount_) public { 143 | uint256 MAX_UINT256 = type(uint256).max; 144 | 145 | amount_ = bound(amount_, 0, MAX_UINT256); 146 | 147 | ERC20User owner = new ERC20User(); 148 | 149 | _token.mint(address(owner), amount_); 150 | owner.erc20_approve(address(_token), self, MAX_UINT256); 151 | 152 | assertEq(_token.balanceOf(address(owner)), amount_); 153 | assertEq(_token.totalSupply(), amount_); 154 | assertEq(_token.allowance(address(owner), self), MAX_UINT256); 155 | 156 | assertTrue(_token.transferFrom(address(owner), recipient_, amount_)); 157 | 158 | assertEq(_token.totalSupply(), amount_); 159 | assertEq(_token.allowance(address(owner), self), MAX_UINT256); 160 | 161 | if (address(owner) == recipient_) { 162 | assertEq(_token.balanceOf(address(owner)), amount_); 163 | } else { 164 | assertEq(_token.balanceOf(address(owner)), 0); 165 | assertEq(_token.balanceOf(recipient_), amount_); 166 | } 167 | } 168 | 169 | function testFuzz_transfer_insufficientBalance(address recipient_, uint256 amount_) public { 170 | amount_ = amount_ == 0 ? 1 : amount_; 171 | 172 | ERC20User account = new ERC20User(); 173 | 174 | _token.mint(address(account), amount_ - 1); 175 | 176 | vm.expectRevert(ARITHMETIC_ERROR); 177 | account.erc20_transfer(address(_token), recipient_, amount_); 178 | 179 | _token.mint(address(account), 1); 180 | account.erc20_transfer(address(_token), recipient_, amount_); 181 | 182 | assertEq(_token.balanceOf(recipient_), amount_); 183 | } 184 | 185 | function testFuzz_transferFrom_insufficientAllowance(address recipient_, uint256 amount_) public { 186 | amount_ = amount_ == 0 ? 1 : amount_; 187 | 188 | ERC20User owner = new ERC20User(); 189 | 190 | _token.mint(address(owner), amount_); 191 | 192 | owner.erc20_approve(address(_token), self, amount_ - 1); 193 | 194 | vm.expectRevert(ARITHMETIC_ERROR); 195 | _token.transferFrom(address(owner), recipient_, amount_); 196 | 197 | owner.erc20_approve(address(_token), self, amount_); 198 | _token.transferFrom(address(owner), recipient_, amount_); 199 | 200 | assertEq(_token.balanceOf(recipient_), amount_); 201 | } 202 | 203 | function testFuzz_transferFrom_insufficientBalance(address recipient_, uint256 amount_) public { 204 | amount_ = amount_ == 0 ? 1 : amount_; 205 | 206 | ERC20User owner = new ERC20User(); 207 | 208 | _token.mint(address(owner), amount_ - 1); 209 | owner.erc20_approve(address(_token), self, amount_); 210 | 211 | vm.expectRevert(ARITHMETIC_ERROR); 212 | _token.transferFrom(address(owner), recipient_, amount_); 213 | 214 | _token.mint(address(owner), 1); 215 | _token.transferFrom(address(owner), recipient_, amount_); 216 | 217 | assertEq(_token.balanceOf(recipient_), amount_); 218 | } 219 | 220 | } 221 | 222 | contract ERC20PermitTest is Test { 223 | 224 | bytes internal constant ARITHMETIC_ERROR = abi.encodeWithSignature("Panic(uint256)", 0x11); 225 | 226 | uint256 internal constant S_VALUE_INCLUSIVE_UPPER_BOUND = uint256(0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF5D576E7357A4501DDFE92F46681B20A0); 227 | uint256 internal constant WAD = 10 ** 18; 228 | 229 | address internal _owner; 230 | address internal _spender; 231 | 232 | uint256 internal _skOwner = 1; 233 | uint256 internal _skSpender = 2; 234 | uint256 internal _nonce = 0; 235 | uint256 internal _deadline = 5_000_000_000; // Timestamp far in the future 236 | 237 | ERC20 internal _token; 238 | ERC20User internal _user; 239 | 240 | function setUp() public virtual { 241 | _owner = vm.addr(_skOwner); 242 | _spender = vm.addr(_skSpender); 243 | 244 | vm.warp(_deadline - 52 weeks); 245 | 246 | _token = new ERC20("Maple Token", "MPL", 18); 247 | _user = new ERC20User(); 248 | } 249 | 250 | function test_typehash() external { 251 | assertEq(_token.PERMIT_TYPEHASH(), keccak256("Permit(address owner,address spender,uint256 value,uint256 nonce,uint256 deadline)")); 252 | } 253 | 254 | // NOTE: Virtual so inheriting tests can override with different DOMAIN_SEPARATORs because of different addresses 255 | function test_domainSeparator() public virtual { 256 | assertEq(_token.DOMAIN_SEPARATOR(), 0x4b8187b77163c02c27b65aa9de86b76c6e4e236f6432e5656ec164ea1e87ba87); 257 | } 258 | 259 | function test_initialState() public { 260 | assertEq(_token.nonces(_owner), 0); 261 | assertEq(_token.allowance(_owner, _spender), 0); 262 | } 263 | 264 | function testFuzz_permit(uint256 amount_) public { 265 | uint256 startingNonce = _token.nonces(_owner); 266 | uint256 expectedNonce = startingNonce + 1; 267 | 268 | ( 269 | uint8 v, 270 | bytes32 r, 271 | bytes32 s 272 | ) = _getValidPermitSignature(address(_token), _owner, _spender, amount_, startingNonce, _deadline, _skOwner); 273 | 274 | _user.erc20_permit(address(_token), _owner, _spender, amount_, _deadline, v, r, s); 275 | 276 | assertEq(_token.nonces(_owner), expectedNonce); 277 | assertEq(_token.allowance(_owner, _spender), amount_); 278 | } 279 | 280 | function testFuzz_permit_multiple(bytes32 seed_) public { 281 | for (uint256 i; i < 10; ++i) { 282 | testFuzz_permit(uint256(keccak256(abi.encodePacked(seed_, i)))); 283 | } 284 | } 285 | 286 | function test_permit_zeroAddress() public { 287 | ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 0, _deadline, _skOwner); 288 | 289 | vm.expectRevert("ERC20:P:INVALID_SIGNATURE"); 290 | _user.erc20_permit(address(_token), address(0), _spender, 1000, _deadline, v, r, s); 291 | } 292 | 293 | function test_permit_differentSpender() public { 294 | ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, address(1111), 1000, 0, _deadline, _skOwner); 295 | 296 | // Using permit with unintended spender should fail. 297 | vm.expectRevert("ERC20:P:INVALID_SIGNATURE"); 298 | _user.erc20_permit(address(_token), _owner, _spender, 1000, _deadline, v, r, s); 299 | } 300 | 301 | function test_permit_ownerSignerMismatch() public { 302 | ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 0, _deadline, _skSpender); 303 | 304 | vm.expectRevert("ERC20:P:INVALID_SIGNATURE"); 305 | _user.erc20_permit(address(_token), _owner, _spender, 1000, _deadline, v, r, s); 306 | } 307 | 308 | function test_permit_withExpiry() public { 309 | uint256 expiry = 482112000 + 1 hours; 310 | 311 | // Expired permit should fail 312 | vm.warp(482112000 + 1 hours + 1); 313 | 314 | assertEq(block.timestamp, 482112000 + 1 hours + 1); 315 | 316 | ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 0, expiry, _skOwner); 317 | 318 | vm.expectRevert("ERC20:P:EXPIRED"); 319 | _user.erc20_permit(address(_token), _owner, _spender, 1000, expiry, v, r, s); 320 | 321 | assertEq(_token.allowance(_owner, _spender), 0); 322 | assertEq(_token.nonces(_owner), 0); 323 | 324 | // Valid permit should succeed 325 | vm.warp(482112000 + 1 hours); 326 | 327 | assertEq(block.timestamp, 482112000 + 1 hours); 328 | 329 | ( v, r, s ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 0, expiry, _skOwner); 330 | 331 | _user.erc20_permit(address(_token), _owner, _spender, 1000, expiry, v, r, s); 332 | 333 | assertEq(_token.allowance(_owner, _spender), 1000); 334 | assertEq(_token.nonces(_owner), 1); 335 | } 336 | 337 | function test_permit_replay() public { 338 | ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 0, _deadline, _skOwner); 339 | 340 | // First time should succeed 341 | _user.erc20_permit(address(_token), _owner, _spender, 1000, _deadline, v, r, s); 342 | 343 | // Second time nonce has been consumed and should fail 344 | vm.expectRevert("ERC20:P:INVALID_SIGNATURE"); 345 | _user.erc20_permit(address(_token), _owner, _spender, 1000, _deadline, v, r, s); 346 | } 347 | 348 | function test_permit_earlyNonce() public { 349 | ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 1, _deadline, _skOwner); 350 | 351 | // Previous nonce of 0 has not been consumed yet, so nonce of 1 should fail. 352 | vm.expectRevert("ERC20:P:INVALID_SIGNATURE"); 353 | _user.erc20_permit(address(_token), _owner, _spender, 1000, _deadline, v, r, s); 354 | } 355 | 356 | function test_permit_differentVerifier() public { 357 | address someToken = address(new ERC20("Some Token", "ST", 18)); 358 | 359 | ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(someToken, _owner, _spender, 1000, 0, _deadline, _skOwner); 360 | 361 | // Using permit with unintended verifier should fail. 362 | vm.expectRevert("ERC20:P:INVALID_SIGNATURE"); 363 | _user.erc20_permit(address(_token), _owner, _spender, 1000, _deadline, v, r, s); 364 | } 365 | 366 | function test_permit_badS() public { 367 | ( uint8 v, bytes32 r, ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 0, _deadline, _skOwner); 368 | 369 | // Send in an s that is above the upper bound. 370 | bytes32 badS = bytes32(S_VALUE_INCLUSIVE_UPPER_BOUND + 1); 371 | vm.expectRevert("ERC20:P:MALLEABLE"); 372 | _user.erc20_permit(address(_token), _owner, _spender, 1000, _deadline, v, r, badS); 373 | } 374 | 375 | function test_permit_badV() public { 376 | // Get valid signature. The `v` value is the expected v value that will cause `permit` to succeed, and must be 27 or 28. 377 | // Any other value should fail. 378 | // If v is 27, then 28 should make it past the MALLEABLE require, but should result in an invalid signature, 379 | // and vice versa when v is 28. 380 | ( uint8 v, bytes32 r, bytes32 s ) = _getValidPermitSignature(address(_token), _owner, _spender, 1000, 0, _deadline, _skOwner); 381 | 382 | for (uint8 i; i <= type(uint8).max; i++) { 383 | if (i == type(uint8).max) { 384 | break; 385 | } else if (i != 27 && i != 28) { 386 | vm.expectRevert("ERC20:P:MALLEABLE"); 387 | } else { 388 | if (i == v) continue; 389 | 390 | // Should get past the Malleable require check as 27 or 28 are valid values for s. 391 | vm.expectRevert("ERC20:P:INVALID_SIGNATURE"); 392 | } 393 | 394 | _user.erc20_permit(address(_token), _owner, _spender, 1000, _deadline, i, r, s); 395 | } 396 | } 397 | 398 | // Returns an ERC-2612 `permit` digest for the `owner` to sign 399 | function _getDigest(address token_, address owner_, address spender_, uint256 amount_, uint256 nonce_, uint256 deadline_) 400 | internal view returns (bytes32 digest_) 401 | { 402 | return keccak256( 403 | abi.encodePacked( 404 | '\x19\x01', 405 | IERC20(token_).DOMAIN_SEPARATOR(), 406 | keccak256(abi.encode(IERC20(token_).PERMIT_TYPEHASH(), owner_, spender_, amount_, nonce_, deadline_)) 407 | ) 408 | ); 409 | } 410 | 411 | // Returns a valid `permit` signature signed by this contract's `owner` address 412 | function _getValidPermitSignature( 413 | address token_, 414 | address owner_, 415 | address spender_, 416 | uint256 amount_, 417 | uint256 nonce_, 418 | uint256 deadline_, 419 | uint256 ownerSk_ 420 | ) 421 | internal returns (uint8 v_, bytes32 r_, bytes32 s_) 422 | { 423 | return vm.sign(ownerSk_, _getDigest(token_, owner_, spender_, amount_, nonce_, deadline_)); 424 | } 425 | 426 | } 427 | 428 | contract ERC20Invariants is Test { 429 | 430 | BalanceSum internal _balanceSum; 431 | 432 | function setUp() public { 433 | _balanceSum = new BalanceSum(); 434 | 435 | targetContract(address(_balanceSum)); 436 | } 437 | 438 | function invariant_balanceSum() public { 439 | assertEq(_balanceSum.token().totalSupply(), _balanceSum.sum()); 440 | } 441 | 442 | } 443 | 444 | contract BalanceSum { 445 | 446 | MockERC20 public token = new MockERC20("Token", "TKN", 18); 447 | 448 | uint256 public sum; 449 | 450 | function mint(address recipient_, uint256 amount_) public { 451 | token.mint(recipient_, amount_); 452 | sum += amount_; 453 | } 454 | 455 | function burn(address owner_, uint256 amount_) public { 456 | token.burn(owner_, amount_); 457 | sum -= amount_; 458 | } 459 | 460 | function approve(address spender_, uint256 amount_) public { 461 | token.approve(spender_, amount_); 462 | } 463 | 464 | function transferFrom(address owner_, address recipient_, uint256 amount_) public { 465 | token.transferFrom(owner_, recipient_, amount_); 466 | } 467 | 468 | function transfer(address recipient_, uint256 amount_) public { 469 | token.transfer(recipient_, amount_); 470 | } 471 | 472 | } 473 | -------------------------------------------------------------------------------- /contracts/test/accounts/ERC20User.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-only 2 | pragma solidity ^0.8.7; 3 | 4 | import { IERC20 } from "../../interfaces/IERC20.sol"; 5 | 6 | contract ERC20User { 7 | 8 | function erc20_approve(address token_, address spender_, uint256 amount_) external { 9 | IERC20(token_).approve(spender_, amount_); 10 | } 11 | 12 | function erc20_permit( 13 | address token_, 14 | address owner_, 15 | address spender_, 16 | uint256 amount_, 17 | uint256 deadline_, 18 | uint8 v_, 19 | bytes32 r_, 20 | bytes32 s_ 21 | ) 22 | external 23 | { 24 | IERC20(token_).permit(owner_, spender_, amount_, deadline_, v_, r_, s_); 25 | } 26 | 27 | function erc20_transfer(address token_, address recipient_, uint256 amount_) external returns (bool success_) { 28 | return IERC20(token_).transfer(recipient_, amount_); 29 | } 30 | 31 | function erc20_transferFrom(address token_, address owner_, address recipient_, uint256 amount_) external returns (bool success_) { 32 | return IERC20(token_).transferFrom(owner_, recipient_, amount_); 33 | } 34 | 35 | } 36 | -------------------------------------------------------------------------------- /contracts/test/mocks/MockERC20.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: AGPL-3.0-only 2 | pragma solidity ^0.8.7; 3 | 4 | import { ERC20 } from "../../ERC20.sol"; 5 | 6 | contract MockERC20 is ERC20 { 7 | 8 | constructor(string memory name_, string memory symbol_, uint8 decimals_) ERC20(name_, symbol_, decimals_) {} 9 | 10 | function mint(address recipient_, uint256 amount_) external { 11 | _mint(recipient_, amount_); 12 | } 13 | 14 | function burn(address owner_, uint256 amount_) external { 15 | _burn(owner_, amount_); 16 | } 17 | 18 | } 19 | -------------------------------------------------------------------------------- /foundry.toml: -------------------------------------------------------------------------------- 1 | [default] 2 | contracts = 'contracts' # The source directory 3 | libs = ['modules'] # A list of library directories 4 | solc_version = '0.8.7' # Override for the solc version (setting this ignores `auto_detect_solc`) 5 | optimizer = true # Enable or disable the solc optimizer 6 | optimizer_runs = 200 # The number of optimizer runs 7 | verbosity = 2 # The verbosity of tests 8 | 9 | [local] 10 | fuzz_runs = 100 11 | 12 | [deep] 13 | fuzz_runs = 50000 14 | 15 | [super_deep] 16 | fuzz_runs = 500000 17 | -------------------------------------------------------------------------------- /package.yaml: -------------------------------------------------------------------------------- 1 | name: erc20 2 | version: 1.0.0 3 | source: src 4 | packages: 5 | - path: src/ERC20.sol 6 | contractName: ERC20 7 | customChecksum: 0xc98bdfa894c6adc0616f92279032e0230473ab4077f221f8c3539c5a807cb147 8 | customDescription: ERC-20 Artifacts and ABIs 9 | -------------------------------------------------------------------------------- /release.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | version=$(cat ./package.yaml | grep "version: " | sed -r 's/.{9}//') 5 | name=$(cat ./package.yaml | grep "name: " | sed -r 's/.{6}//') 6 | customDescription=$(cat ./package.yaml | grep "customDescription: " | sed -r 's/.{19}//') 7 | 8 | ./build.sh -c ./config/prod.json 9 | 10 | rm -rf ./package 11 | mkdir -p package 12 | 13 | echo "{ 14 | \"name\": \"@maplelabs/${name}\", 15 | \"version\": \"${version}\", 16 | \"description\": \"${customDescription}\", 17 | \"author\": \"Maple Labs\", 18 | \"license\": \"AGPLv3\", 19 | \"repository\": { 20 | \"type\": \"git\", 21 | \"url\": \"https://github.com/maple-labs/${name}.git\" 22 | }, 23 | \"bugs\": { 24 | \"url\": \"https://github.com/maple-labs/${name}/issues\" 25 | }, 26 | \"homepage\": \"https://github.com/maple-labs/${name}\" 27 | }" > package/package.json 28 | 29 | mkdir -p package/artifacts 30 | mkdir -p package/abis 31 | 32 | paths=($(cat ./package.yaml | grep " - path:" | sed -r 's/.{10}//')) 33 | names=($(cat ./package.yaml | grep " contractName:" | sed -r 's/.{18}//')) 34 | 35 | for i in "${!paths[@]}"; do 36 | cat ./out/dapp.sol.json | jq ".contracts | .\"${paths[i]}\" | .${names[i]}" > package/artifacts/${names[i]}.json 37 | cat ./out/dapp.sol.json | jq ".contracts | .\"${paths[i]}\" | .${names[i]} | .abi" > package/abis/${names[i]}.json 38 | done 39 | 40 | npm publish ./package --access public 41 | 42 | rm -rf ./package 43 | -------------------------------------------------------------------------------- /test.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | while getopts t:p: flag 5 | do 6 | case "${flag}" in 7 | t) test=${OPTARG};; 8 | p) profile=${OPTARG};; 9 | esac 10 | done 11 | 12 | export FOUNDRY_PROFILE=$profile 13 | 14 | if [ -z "$test" ]; then match="[contracts/test/*.t.sol]"; else match=$test; fi 15 | 16 | forge test --match-test "$match" -vvv 17 | --------------------------------------------------------------------------------