├── .github └── workflows │ └── test.yml ├── .gitignore ├── bin └── cov-html ├── foundry.toml ├── lib └── ds-test │ ├── .gitignore │ ├── LICENSE │ ├── Makefile │ ├── default.nix │ ├── demo │ └── demo.sol │ └── src │ └── test.sol ├── src ├── Contract.sol └── Contract2.sol └── test └── Contract.t.sol /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: 4 | push: 5 | branches: [master] 6 | 7 | env: 8 | FOUNDRY_PROFILE: ci 9 | 10 | jobs: 11 | check: 12 | strategy: 13 | fail-fast: true 14 | 15 | name: Foundry project 16 | runs-on: ubuntu-latest 17 | steps: 18 | - uses: actions/checkout@v3 19 | with: 20 | submodules: recursive 21 | 22 | - name: Install Foundry 23 | uses: foundry-rs/foundry-toolchain@v1 24 | with: 25 | version: nightly 26 | 27 | - name: Run Forge build 28 | run: | 29 | forge --version 30 | forge build --sizes 31 | id: build 32 | 33 | - name: Run Forge tests 34 | run: | 35 | forge test -vvv 36 | id: test 37 | 38 | - name: Coverage 39 | run: | 40 | forge coverage --report lcov 41 | id: coverage 42 | 43 | - uses: codecov/codecov-action@v2 44 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | cache/ 2 | out/ 3 | report/ 4 | lcov.info 5 | -------------------------------------------------------------------------------- /bin/cov-html: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | forge coverage --report lcov 3 | genhtml lcov.info -o report --branch-coverage -------------------------------------------------------------------------------- /foundry.toml: -------------------------------------------------------------------------------- 1 | [profile.default] 2 | src = 'src' 3 | out = 'out' 4 | libs = ['lib'] 5 | 6 | # See more config options https://github.com/gakonst/foundry/tree/master/config -------------------------------------------------------------------------------- /lib/ds-test/.gitignore: -------------------------------------------------------------------------------- 1 | /.dapple 2 | /build 3 | /out 4 | -------------------------------------------------------------------------------- /lib/ds-test/LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /lib/ds-test/Makefile: -------------------------------------------------------------------------------- 1 | all:; dapp build 2 | 3 | test: 4 | -dapp --use solc:0.4.23 build 5 | -dapp --use solc:0.4.26 build 6 | -dapp --use solc:0.5.17 build 7 | -dapp --use solc:0.6.12 build 8 | -dapp --use solc:0.7.5 build 9 | 10 | demo: 11 | DAPP_SRC=demo dapp --use solc:0.7.5 build 12 | -hevm dapp-test --verbose 3 13 | 14 | .PHONY: test demo 15 | -------------------------------------------------------------------------------- /lib/ds-test/default.nix: -------------------------------------------------------------------------------- 1 | { solidityPackage, dappsys }: solidityPackage { 2 | name = "ds-test"; 3 | src = ./src; 4 | } 5 | -------------------------------------------------------------------------------- /lib/ds-test/demo/demo.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: GPL-3.0-or-later 2 | pragma solidity >=0.4.23; 3 | 4 | import "../src/test.sol"; 5 | 6 | contract DemoTest is DSTest { 7 | function test_this() public pure { 8 | require(true); 9 | } 10 | function test_logs() public { 11 | emit log("-- log(string)"); 12 | emit log("a string"); 13 | 14 | emit log("-- log_named_uint(string, uint)"); 15 | log_named_uint("uint", 512); 16 | 17 | emit log("-- log_named_int(string, int)"); 18 | log_named_int("int", -512); 19 | 20 | emit log("-- log_named_address(string, address)"); 21 | log_named_address("address", address(this)); 22 | 23 | emit log("-- log_named_bytes32(string, bytes32)"); 24 | log_named_bytes32("bytes32", "a string"); 25 | 26 | emit log("-- log_named_bytes(string, bytes)"); 27 | log_named_bytes("bytes", hex"cafefe"); 28 | 29 | emit log("-- log_named_string(string, string)"); 30 | log_named_string("string", "a string"); 31 | 32 | emit log("-- log_named_decimal_uint(string, uint, uint)"); 33 | log_named_decimal_uint("decimal uint", 1.0e18, 18); 34 | 35 | emit log("-- log_named_decimal_int(string, int, uint)"); 36 | log_named_decimal_int("decimal int", -1.0e18, 18); 37 | } 38 | event log_old_named_uint(bytes32,uint); 39 | function test_old_logs() public { 40 | log_old_named_uint("key", 500); 41 | log_named_bytes32("bkey", "val"); 42 | } 43 | function test_trace() public view { 44 | this.echo("string 1", "string 2"); 45 | } 46 | function test_multiline() public { 47 | emit log("a multiline\\n" "string"); 48 | emit log("a multiline " "string"); 49 | log_bytes("a string"); 50 | log_bytes("a multiline\n" "string"); 51 | log_bytes("a multiline\\n" "string"); 52 | emit log(unicode"Ώ"); 53 | logs(hex"0000"); 54 | log_named_bytes("0x0000", hex"0000"); 55 | logs(hex"ff"); 56 | } 57 | function echo(string memory s1, string memory s2) public pure 58 | returns (string memory, string memory) 59 | { 60 | return (s1, s2); 61 | } 62 | 63 | function prove_this(uint x) public { 64 | log_named_uint("sym x", x); 65 | assertGt(x + 1, 0); 66 | } 67 | 68 | function test_logn() public { 69 | assembly { 70 | log0(0x01, 0x02) 71 | log1(0x01, 0x02, 0x03) 72 | log2(0x01, 0x02, 0x03, 0x04) 73 | log3(0x01, 0x02, 0x03, 0x04, 0x05) 74 | } 75 | } 76 | 77 | event MyEvent(uint, uint indexed, uint, uint indexed); 78 | function test_events() public { 79 | emit MyEvent(1, 2, 3, 4); 80 | } 81 | 82 | function test_asserts() public { 83 | string memory err = "this test has failed!"; 84 | emit log("## assertTrue(bool)\n"); 85 | assertTrue(false); 86 | emit log("\n"); 87 | assertTrue(false, err); 88 | 89 | emit log("\n## assertEq(address,address)\n"); 90 | assertEq(address(this), msg.sender); 91 | emit log("\n"); 92 | assertEq(address(this), msg.sender, err); 93 | 94 | emit log("\n## assertEq32(bytes32,bytes32)\n"); 95 | assertEq32("bytes 1", "bytes 2"); 96 | emit log("\n"); 97 | assertEq32("bytes 1", "bytes 2", err); 98 | 99 | emit log("\n## assertEq(bytes32,bytes32)\n"); 100 | assertEq32("bytes 1", "bytes 2"); 101 | emit log("\n"); 102 | assertEq32("bytes 1", "bytes 2", err); 103 | 104 | emit log("\n## assertEq(uint,uint)\n"); 105 | assertEq(uint(0), 1); 106 | emit log("\n"); 107 | assertEq(uint(0), 1, err); 108 | 109 | emit log("\n## assertEq(int,int)\n"); 110 | assertEq(-1, -2); 111 | emit log("\n"); 112 | assertEq(-1, -2, err); 113 | 114 | emit log("\n## assertEqDecimal(int,int,uint)\n"); 115 | assertEqDecimal(-1.0e18, -1.1e18, 18); 116 | emit log("\n"); 117 | assertEqDecimal(-1.0e18, -1.1e18, 18, err); 118 | 119 | emit log("\n## assertEqDecimal(uint,uint,uint)\n"); 120 | assertEqDecimal(uint(1.0e18), 1.1e18, 18); 121 | emit log("\n"); 122 | assertEqDecimal(uint(1.0e18), 1.1e18, 18, err); 123 | 124 | emit log("\n## assertGt(uint,uint)\n"); 125 | assertGt(uint(0), 0); 126 | emit log("\n"); 127 | assertGt(uint(0), 0, err); 128 | 129 | emit log("\n## assertGt(int,int)\n"); 130 | assertGt(-1, -1); 131 | emit log("\n"); 132 | assertGt(-1, -1, err); 133 | 134 | emit log("\n## assertGtDecimal(int,int,uint)\n"); 135 | assertGtDecimal(-2.0e18, -1.1e18, 18); 136 | emit log("\n"); 137 | assertGtDecimal(-2.0e18, -1.1e18, 18, err); 138 | 139 | emit log("\n## assertGtDecimal(uint,uint,uint)\n"); 140 | assertGtDecimal(uint(1.0e18), 1.1e18, 18); 141 | emit log("\n"); 142 | assertGtDecimal(uint(1.0e18), 1.1e18, 18, err); 143 | 144 | emit log("\n## assertGe(uint,uint)\n"); 145 | assertGe(uint(0), 1); 146 | emit log("\n"); 147 | assertGe(uint(0), 1, err); 148 | 149 | emit log("\n## assertGe(int,int)\n"); 150 | assertGe(-1, 0); 151 | emit log("\n"); 152 | assertGe(-1, 0, err); 153 | 154 | emit log("\n## assertGeDecimal(int,int,uint)\n"); 155 | assertGeDecimal(-2.0e18, -1.1e18, 18); 156 | emit log("\n"); 157 | assertGeDecimal(-2.0e18, -1.1e18, 18, err); 158 | 159 | emit log("\n## assertGeDecimal(uint,uint,uint)\n"); 160 | assertGeDecimal(uint(1.0e18), 1.1e18, 18); 161 | emit log("\n"); 162 | assertGeDecimal(uint(1.0e18), 1.1e18, 18, err); 163 | 164 | emit log("\n## assertLt(uint,uint)\n"); 165 | assertLt(uint(0), 0); 166 | emit log("\n"); 167 | assertLt(uint(0), 0, err); 168 | 169 | emit log("\n## assertLt(int,int)\n"); 170 | assertLt(-1, -1); 171 | emit log("\n"); 172 | assertLt(-1, -1, err); 173 | 174 | emit log("\n## assertLtDecimal(int,int,uint)\n"); 175 | assertLtDecimal(-1.0e18, -1.1e18, 18); 176 | emit log("\n"); 177 | assertLtDecimal(-1.0e18, -1.1e18, 18, err); 178 | 179 | emit log("\n## assertLtDecimal(uint,uint,uint)\n"); 180 | assertLtDecimal(uint(2.0e18), 1.1e18, 18); 181 | emit log("\n"); 182 | assertLtDecimal(uint(2.0e18), 1.1e18, 18, err); 183 | 184 | emit log("\n## assertLe(uint,uint)\n"); 185 | assertLe(uint(1), 0); 186 | emit log("\n"); 187 | assertLe(uint(1), 0, err); 188 | 189 | emit log("\n## assertLe(int,int)\n"); 190 | assertLe(0, -1); 191 | emit log("\n"); 192 | assertLe(0, -1, err); 193 | 194 | emit log("\n## assertLeDecimal(int,int,uint)\n"); 195 | assertLeDecimal(-1.0e18, -1.1e18, 18); 196 | emit log("\n"); 197 | assertLeDecimal(-1.0e18, -1.1e18, 18, err); 198 | 199 | emit log("\n## assertLeDecimal(uint,uint,uint)\n"); 200 | assertLeDecimal(uint(2.0e18), 1.1e18, 18); 201 | emit log("\n"); 202 | assertLeDecimal(uint(2.0e18), 1.1e18, 18, err); 203 | 204 | emit log("\n## assertEq(string,string)\n"); 205 | string memory s1 = "string 1"; 206 | string memory s2 = "string 2"; 207 | assertEq(s1, s2); 208 | emit log("\n"); 209 | assertEq(s1, s2, err); 210 | 211 | emit log("\n## assertEq0(bytes,bytes)\n"); 212 | assertEq0(hex"abcdef01", hex"abcdef02"); 213 | log("\n"); 214 | assertEq0(hex"abcdef01", hex"abcdef02", err); 215 | } 216 | } 217 | 218 | contract DemoTestWithSetUp { 219 | function setUp() public { 220 | } 221 | function test_pass() public pure { 222 | } 223 | } 224 | -------------------------------------------------------------------------------- /lib/ds-test/src/test.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: GPL-3.0-or-later 2 | 3 | // This program is free software: you can redistribute it and/or modify 4 | // it under the terms of the GNU General Public License as published by 5 | // the Free Software Foundation, either version 3 of the License, or 6 | // (at your option) any later version. 7 | 8 | // This program is distributed in the hope that it will be useful, 9 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 11 | // GNU General Public License for more details. 12 | 13 | // You should have received a copy of the GNU General Public License 14 | // along with this program. If not, see . 15 | 16 | pragma solidity >=0.5.0; 17 | 18 | contract DSTest { 19 | event log (string); 20 | event logs (bytes); 21 | 22 | event log_address (address); 23 | event log_bytes32 (bytes32); 24 | event log_int (int); 25 | event log_uint (uint); 26 | event log_bytes (bytes); 27 | event log_string (string); 28 | 29 | event log_named_address (string key, address val); 30 | event log_named_bytes32 (string key, bytes32 val); 31 | event log_named_decimal_int (string key, int val, uint decimals); 32 | event log_named_decimal_uint (string key, uint val, uint decimals); 33 | event log_named_int (string key, int val); 34 | event log_named_uint (string key, uint val); 35 | event log_named_bytes (string key, bytes val); 36 | event log_named_string (string key, string val); 37 | 38 | bool public IS_TEST = true; 39 | bool private _failed; 40 | 41 | address constant HEVM_ADDRESS = 42 | address(bytes20(uint160(uint256(keccak256('hevm cheat code'))))); 43 | 44 | modifier mayRevert() { _; } 45 | modifier testopts(string memory) { _; } 46 | 47 | function failed() public returns (bool) { 48 | if (_failed) { 49 | return _failed; 50 | } else { 51 | bool globalFailed = false; 52 | if (hasHEVMContext()) { 53 | (, bytes memory retdata) = HEVM_ADDRESS.call( 54 | abi.encodePacked( 55 | bytes4(keccak256("load(address,bytes32)")), 56 | abi.encode(HEVM_ADDRESS, bytes32("failed")) 57 | ) 58 | ); 59 | globalFailed = abi.decode(retdata, (bool)); 60 | } 61 | return globalFailed; 62 | } 63 | } 64 | 65 | function fail() internal { 66 | if (hasHEVMContext()) { 67 | (bool status, ) = HEVM_ADDRESS.call( 68 | abi.encodePacked( 69 | bytes4(keccak256("store(address,bytes32,bytes32)")), 70 | abi.encode(HEVM_ADDRESS, bytes32("failed"), bytes32(uint256(0x01))) 71 | ) 72 | ); 73 | status; // Silence compiler warnings 74 | } 75 | _failed = true; 76 | } 77 | 78 | function hasHEVMContext() internal view returns (bool) { 79 | uint256 hevmCodeSize = 0; 80 | assembly { 81 | hevmCodeSize := extcodesize(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D) 82 | } 83 | return hevmCodeSize > 0; 84 | } 85 | 86 | modifier logs_gas() { 87 | uint startGas = gasleft(); 88 | _; 89 | uint endGas = gasleft(); 90 | emit log_named_uint("gas", startGas - endGas); 91 | } 92 | 93 | function assertTrue(bool condition) internal { 94 | if (!condition) { 95 | emit log("Error: Assertion Failed"); 96 | fail(); 97 | } 98 | } 99 | 100 | function assertTrue(bool condition, string memory err) internal { 101 | if (!condition) { 102 | emit log_named_string("Error", err); 103 | assertTrue(condition); 104 | } 105 | } 106 | 107 | function assertEq(address a, address b) internal { 108 | if (a != b) { 109 | emit log("Error: a == b not satisfied [address]"); 110 | emit log_named_address(" Expected", b); 111 | emit log_named_address(" Actual", a); 112 | fail(); 113 | } 114 | } 115 | function assertEq(address a, address b, string memory err) internal { 116 | if (a != b) { 117 | emit log_named_string ("Error", err); 118 | assertEq(a, b); 119 | } 120 | } 121 | 122 | function assertEq(bytes32 a, bytes32 b) internal { 123 | if (a != b) { 124 | emit log("Error: a == b not satisfied [bytes32]"); 125 | emit log_named_bytes32(" Expected", b); 126 | emit log_named_bytes32(" Actual", a); 127 | fail(); 128 | } 129 | } 130 | function assertEq(bytes32 a, bytes32 b, string memory err) internal { 131 | if (a != b) { 132 | emit log_named_string ("Error", err); 133 | assertEq(a, b); 134 | } 135 | } 136 | function assertEq32(bytes32 a, bytes32 b) internal { 137 | assertEq(a, b); 138 | } 139 | function assertEq32(bytes32 a, bytes32 b, string memory err) internal { 140 | assertEq(a, b, err); 141 | } 142 | 143 | function assertEq(int a, int b) internal { 144 | if (a != b) { 145 | emit log("Error: a == b not satisfied [int]"); 146 | emit log_named_int(" Expected", b); 147 | emit log_named_int(" Actual", a); 148 | fail(); 149 | } 150 | } 151 | function assertEq(int a, int b, string memory err) internal { 152 | if (a != b) { 153 | emit log_named_string("Error", err); 154 | assertEq(a, b); 155 | } 156 | } 157 | function assertEq(uint a, uint b) internal { 158 | if (a != b) { 159 | emit log("Error: a == b not satisfied [uint]"); 160 | emit log_named_uint(" Expected", b); 161 | emit log_named_uint(" Actual", a); 162 | fail(); 163 | } 164 | } 165 | function assertEq(uint a, uint b, string memory err) internal { 166 | if (a != b) { 167 | emit log_named_string("Error", err); 168 | assertEq(a, b); 169 | } 170 | } 171 | function assertEqDecimal(int a, int b, uint decimals) internal { 172 | if (a != b) { 173 | emit log("Error: a == b not satisfied [decimal int]"); 174 | emit log_named_decimal_int(" Expected", b, decimals); 175 | emit log_named_decimal_int(" Actual", a, decimals); 176 | fail(); 177 | } 178 | } 179 | function assertEqDecimal(int a, int b, uint decimals, string memory err) internal { 180 | if (a != b) { 181 | emit log_named_string("Error", err); 182 | assertEqDecimal(a, b, decimals); 183 | } 184 | } 185 | function assertEqDecimal(uint a, uint b, uint decimals) internal { 186 | if (a != b) { 187 | emit log("Error: a == b not satisfied [decimal uint]"); 188 | emit log_named_decimal_uint(" Expected", b, decimals); 189 | emit log_named_decimal_uint(" Actual", a, decimals); 190 | fail(); 191 | } 192 | } 193 | function assertEqDecimal(uint a, uint b, uint decimals, string memory err) internal { 194 | if (a != b) { 195 | emit log_named_string("Error", err); 196 | assertEqDecimal(a, b, decimals); 197 | } 198 | } 199 | 200 | function assertGt(uint a, uint b) internal { 201 | if (a <= b) { 202 | emit log("Error: a > b not satisfied [uint]"); 203 | emit log_named_uint(" Value a", a); 204 | emit log_named_uint(" Value b", b); 205 | fail(); 206 | } 207 | } 208 | function assertGt(uint a, uint b, string memory err) internal { 209 | if (a <= b) { 210 | emit log_named_string("Error", err); 211 | assertGt(a, b); 212 | } 213 | } 214 | function assertGt(int a, int b) internal { 215 | if (a <= b) { 216 | emit log("Error: a > b not satisfied [int]"); 217 | emit log_named_int(" Value a", a); 218 | emit log_named_int(" Value b", b); 219 | fail(); 220 | } 221 | } 222 | function assertGt(int a, int b, string memory err) internal { 223 | if (a <= b) { 224 | emit log_named_string("Error", err); 225 | assertGt(a, b); 226 | } 227 | } 228 | function assertGtDecimal(int a, int b, uint decimals) internal { 229 | if (a <= b) { 230 | emit log("Error: a > b not satisfied [decimal int]"); 231 | emit log_named_decimal_int(" Value a", a, decimals); 232 | emit log_named_decimal_int(" Value b", b, decimals); 233 | fail(); 234 | } 235 | } 236 | function assertGtDecimal(int a, int b, uint decimals, string memory err) internal { 237 | if (a <= b) { 238 | emit log_named_string("Error", err); 239 | assertGtDecimal(a, b, decimals); 240 | } 241 | } 242 | function assertGtDecimal(uint a, uint b, uint decimals) internal { 243 | if (a <= b) { 244 | emit log("Error: a > b not satisfied [decimal uint]"); 245 | emit log_named_decimal_uint(" Value a", a, decimals); 246 | emit log_named_decimal_uint(" Value b", b, decimals); 247 | fail(); 248 | } 249 | } 250 | function assertGtDecimal(uint a, uint b, uint decimals, string memory err) internal { 251 | if (a <= b) { 252 | emit log_named_string("Error", err); 253 | assertGtDecimal(a, b, decimals); 254 | } 255 | } 256 | 257 | function assertGe(uint a, uint b) internal { 258 | if (a < b) { 259 | emit log("Error: a >= b not satisfied [uint]"); 260 | emit log_named_uint(" Value a", a); 261 | emit log_named_uint(" Value b", b); 262 | fail(); 263 | } 264 | } 265 | function assertGe(uint a, uint b, string memory err) internal { 266 | if (a < b) { 267 | emit log_named_string("Error", err); 268 | assertGe(a, b); 269 | } 270 | } 271 | function assertGe(int a, int b) internal { 272 | if (a < b) { 273 | emit log("Error: a >= b not satisfied [int]"); 274 | emit log_named_int(" Value a", a); 275 | emit log_named_int(" Value b", b); 276 | fail(); 277 | } 278 | } 279 | function assertGe(int a, int b, string memory err) internal { 280 | if (a < b) { 281 | emit log_named_string("Error", err); 282 | assertGe(a, b); 283 | } 284 | } 285 | function assertGeDecimal(int a, int b, uint decimals) internal { 286 | if (a < b) { 287 | emit log("Error: a >= b not satisfied [decimal int]"); 288 | emit log_named_decimal_int(" Value a", a, decimals); 289 | emit log_named_decimal_int(" Value b", b, decimals); 290 | fail(); 291 | } 292 | } 293 | function assertGeDecimal(int a, int b, uint decimals, string memory err) internal { 294 | if (a < b) { 295 | emit log_named_string("Error", err); 296 | assertGeDecimal(a, b, decimals); 297 | } 298 | } 299 | function assertGeDecimal(uint a, uint b, uint decimals) internal { 300 | if (a < b) { 301 | emit log("Error: a >= b not satisfied [decimal uint]"); 302 | emit log_named_decimal_uint(" Value a", a, decimals); 303 | emit log_named_decimal_uint(" Value b", b, decimals); 304 | fail(); 305 | } 306 | } 307 | function assertGeDecimal(uint a, uint b, uint decimals, string memory err) internal { 308 | if (a < b) { 309 | emit log_named_string("Error", err); 310 | assertGeDecimal(a, b, decimals); 311 | } 312 | } 313 | 314 | function assertLt(uint a, uint b) internal { 315 | if (a >= b) { 316 | emit log("Error: a < b not satisfied [uint]"); 317 | emit log_named_uint(" Value a", a); 318 | emit log_named_uint(" Value b", b); 319 | fail(); 320 | } 321 | } 322 | function assertLt(uint a, uint b, string memory err) internal { 323 | if (a >= b) { 324 | emit log_named_string("Error", err); 325 | assertLt(a, b); 326 | } 327 | } 328 | function assertLt(int a, int b) internal { 329 | if (a >= b) { 330 | emit log("Error: a < b not satisfied [int]"); 331 | emit log_named_int(" Value a", a); 332 | emit log_named_int(" Value b", b); 333 | fail(); 334 | } 335 | } 336 | function assertLt(int a, int b, string memory err) internal { 337 | if (a >= b) { 338 | emit log_named_string("Error", err); 339 | assertLt(a, b); 340 | } 341 | } 342 | function assertLtDecimal(int a, int b, uint decimals) internal { 343 | if (a >= b) { 344 | emit log("Error: a < b not satisfied [decimal int]"); 345 | emit log_named_decimal_int(" Value a", a, decimals); 346 | emit log_named_decimal_int(" Value b", b, decimals); 347 | fail(); 348 | } 349 | } 350 | function assertLtDecimal(int a, int b, uint decimals, string memory err) internal { 351 | if (a >= b) { 352 | emit log_named_string("Error", err); 353 | assertLtDecimal(a, b, decimals); 354 | } 355 | } 356 | function assertLtDecimal(uint a, uint b, uint decimals) internal { 357 | if (a >= b) { 358 | emit log("Error: a < b not satisfied [decimal uint]"); 359 | emit log_named_decimal_uint(" Value a", a, decimals); 360 | emit log_named_decimal_uint(" Value b", b, decimals); 361 | fail(); 362 | } 363 | } 364 | function assertLtDecimal(uint a, uint b, uint decimals, string memory err) internal { 365 | if (a >= b) { 366 | emit log_named_string("Error", err); 367 | assertLtDecimal(a, b, decimals); 368 | } 369 | } 370 | 371 | function assertLe(uint a, uint b) internal { 372 | if (a > b) { 373 | emit log("Error: a <= b not satisfied [uint]"); 374 | emit log_named_uint(" Value a", a); 375 | emit log_named_uint(" Value b", b); 376 | fail(); 377 | } 378 | } 379 | function assertLe(uint a, uint b, string memory err) internal { 380 | if (a > b) { 381 | emit log_named_string("Error", err); 382 | assertLe(a, b); 383 | } 384 | } 385 | function assertLe(int a, int b) internal { 386 | if (a > b) { 387 | emit log("Error: a <= b not satisfied [int]"); 388 | emit log_named_int(" Value a", a); 389 | emit log_named_int(" Value b", b); 390 | fail(); 391 | } 392 | } 393 | function assertLe(int a, int b, string memory err) internal { 394 | if (a > b) { 395 | emit log_named_string("Error", err); 396 | assertLe(a, b); 397 | } 398 | } 399 | function assertLeDecimal(int a, int b, uint decimals) internal { 400 | if (a > b) { 401 | emit log("Error: a <= b not satisfied [decimal int]"); 402 | emit log_named_decimal_int(" Value a", a, decimals); 403 | emit log_named_decimal_int(" Value b", b, decimals); 404 | fail(); 405 | } 406 | } 407 | function assertLeDecimal(int a, int b, uint decimals, string memory err) internal { 408 | if (a > b) { 409 | emit log_named_string("Error", err); 410 | assertLeDecimal(a, b, decimals); 411 | } 412 | } 413 | function assertLeDecimal(uint a, uint b, uint decimals) internal { 414 | if (a > b) { 415 | emit log("Error: a <= b not satisfied [decimal uint]"); 416 | emit log_named_decimal_uint(" Value a", a, decimals); 417 | emit log_named_decimal_uint(" Value b", b, decimals); 418 | fail(); 419 | } 420 | } 421 | function assertLeDecimal(uint a, uint b, uint decimals, string memory err) internal { 422 | if (a > b) { 423 | emit log_named_string("Error", err); 424 | assertGeDecimal(a, b, decimals); 425 | } 426 | } 427 | 428 | function assertEq(string memory a, string memory b) internal { 429 | if (keccak256(abi.encodePacked(a)) != keccak256(abi.encodePacked(b))) { 430 | emit log("Error: a == b not satisfied [string]"); 431 | emit log_named_string(" Value a", a); 432 | emit log_named_string(" Value b", b); 433 | fail(); 434 | } 435 | } 436 | function assertEq(string memory a, string memory b, string memory err) internal { 437 | if (keccak256(abi.encodePacked(a)) != keccak256(abi.encodePacked(b))) { 438 | emit log_named_string("Error", err); 439 | assertEq(a, b); 440 | } 441 | } 442 | 443 | function checkEq0(bytes memory a, bytes memory b) internal pure returns (bool ok) { 444 | ok = true; 445 | if (a.length == b.length) { 446 | for (uint i = 0; i < a.length; i++) { 447 | if (a[i] != b[i]) { 448 | ok = false; 449 | } 450 | } 451 | } else { 452 | ok = false; 453 | } 454 | } 455 | function assertEq0(bytes memory a, bytes memory b) internal { 456 | if (!checkEq0(a, b)) { 457 | emit log("Error: a == b not satisfied [bytes]"); 458 | emit log_named_bytes(" Expected", a); 459 | emit log_named_bytes(" Actual", b); 460 | fail(); 461 | } 462 | } 463 | function assertEq0(bytes memory a, bytes memory b, string memory err) internal { 464 | if (!checkEq0(a, b)) { 465 | emit log_named_string("Error", err); 466 | assertEq0(a, b); 467 | } 468 | } 469 | } 470 | -------------------------------------------------------------------------------- /src/Contract.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: UNLICENSED 2 | pragma solidity >=0.8.15; 3 | 4 | /// Expected: 5 | /// - Functions: 6 6 | /// - Branches: 6, 14 paths(?) 7 | /// - Statements: 14(?) 8 | /// - Lines: 19 9 | /// - Coverage: 100% 10 | contract Branches { 11 | event Branch(uint256 n); 12 | 13 | function branchRequire(bool increment) external { 14 | // Should be treated as a branch 15 | require(increment); 16 | 17 | emit Branch(2); 18 | } 19 | 20 | function branchAssert(bool increment) external { 21 | // Should be treated as a branch 22 | assert(increment); 23 | 24 | emit Branch(2); 25 | } 26 | 27 | function branchIf(bool increment) external { 28 | // Should be treated as a branch 29 | if (!increment) { 30 | revert(); 31 | } 32 | 33 | emit Branch(2); 34 | } 35 | 36 | function branchIfElse(bool increment) external { 37 | if (increment) { 38 | emit Branch(1); 39 | } else { 40 | revert(); 41 | } 42 | } 43 | 44 | function branchIfElseIf(bool a, bool b) external { 45 | if (a) { 46 | emit Branch(1); 47 | } else if (b) { 48 | emit Branch(2); 49 | } 50 | } 51 | 52 | function branchIfElseIfElse(bool a, bool b) external { 53 | if (a) { 54 | emit Branch(1); 55 | } else if (b) { 56 | emit Branch(2); 57 | } else { 58 | emit Branch(3); 59 | } 60 | } 61 | 62 | function complexBranch(bool a, uint256 b) external { 63 | if (a && b < 100) { 64 | // Uncovered 65 | emit Branch(1); 66 | } else if (a && b < 200) { 67 | // Uncovered 68 | emit Branch(2); 69 | } else if (!a) { 70 | // Covered 71 | emit Branch(3); 72 | } 73 | } 74 | } 75 | 76 | /// Expected: 77 | /// - Functions: 1 78 | /// - Branches: 1, 2 paths 79 | /// - Statements: 7 80 | /// - Lines: 6 81 | /// - Coverage: 100% 82 | contract Loop { 83 | function oddEven() external pure { 84 | // Should be executed once 85 | uint256 count = 0; 86 | 87 | for (uint256 i = 0; i < 10; i++) { 88 | if (i % 2 == 0) { 89 | // Should be executed 5 times 90 | count += 1; 91 | } else { 92 | // Should be executed 5 times 93 | count -= 1; 94 | } 95 | } 96 | } 97 | } 98 | 99 | /// Expected: 100 | /// - Functions: 1 101 | /// - Branches: 1, 2 paths 102 | /// - Statements: 4 103 | /// - Lines: 5 104 | /// - Coverage: 0% 105 | contract Uncovered { 106 | function dontCallMe(uint256 a, uint256 b) external pure { 107 | uint256 c = a + b; 108 | uint256 d = a - b; 109 | uint256 e = a + b * 2; 110 | 111 | // I know this should have been checked earlier don't look t11s 112 | if (c < 10) { 113 | revert(); 114 | } 115 | } 116 | } 117 | 118 | contract PartiallyCovered { 119 | event Branch(uint256 n); 120 | 121 | function allBranches(bool a) external { 122 | // Should be partially covered 123 | require(a); 124 | // Should be partially covered 125 | assert(a); 126 | 127 | if (!a) { 128 | // Should not be covered 129 | revert(); 130 | } 131 | 132 | if (a) { 133 | // Should be covered 134 | emit Branch(1); 135 | } else { 136 | // Should not be covered 137 | revert(); 138 | } 139 | 140 | if (a) { 141 | // Should be covered 142 | emit Branch(2); 143 | } else if (1 + 2 == 1) { 144 | // Should not be covered 145 | emit Branch(3); 146 | 147 | // There is an implicit "else" here that should not be covered 148 | } 149 | 150 | if (a) { 151 | // Should be covered 152 | emit Branch(2); 153 | } else if (1 + 2 == 1) { 154 | // Should not be covered 155 | emit Branch(3); 156 | } else { 157 | // Should not be covered 158 | emit Branch(4); 159 | } 160 | } 161 | } 162 | 163 | // Note: Shouldn't break anymore 164 | contract StuffThatBreaks { 165 | uint256 x = 0; 166 | 167 | function justReturns() external returns (uint256) { 168 | // should be covered 169 | return 1; 170 | } 171 | 172 | function isInternal(bool a, bool b) internal { 173 | // should be covered 174 | if (a && b) { 175 | x = x + 1; 176 | } 177 | } 178 | 179 | // should not generate coverage data 180 | function emptyBody() external {} 181 | 182 | function someInternalFunc(bool a) external { 183 | // should be covered 184 | isInternal(a, a); 185 | } 186 | } 187 | 188 | contract Fuzz { 189 | function eq(bool a, bool b) external returns (bool) { 190 | // should be run 256 times and be covered 191 | return a == b; 192 | } 193 | } 194 | 195 | library InternalLibrary { 196 | function addLtTen(uint256 a, uint256 b) internal { 197 | // should be marked as covered (fully) 198 | require(a + b <= 10, "too much"); 199 | } 200 | 201 | function subPlusOne(uint256 a, uint256 b) internal returns (uint256) { 202 | // should be marked as covered 203 | return a - b + 1; 204 | } 205 | } 206 | 207 | library ExternalLibrary { 208 | function addGtTen(uint256 a, uint256 b) external { 209 | // should be marked as covered (partially) 210 | require(a + b > 10, "too little"); 211 | } 212 | } 213 | 214 | contract InternalLibraryUser { 215 | function run() external { 216 | // should be marked as covered 217 | InternalLibrary.addLtTen(1, 2); 218 | } 219 | } 220 | 221 | contract ExternalLibraryUser { 222 | function run() external { 223 | // should be marked as covered 224 | ExternalLibrary.addGtTen(10, 10); 225 | } 226 | } 227 | 228 | contract UsingForLibraryUser { 229 | using InternalLibrary for uint256; 230 | 231 | function tenMinusArgPlusOne(uint256 b) external returns (uint256) { 232 | // should be marked as covered 233 | uint256 c = 10; 234 | return c.subPlusOne(b); 235 | } 236 | } 237 | -------------------------------------------------------------------------------- /src/Contract2.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: UNLICENSED 2 | pragma solidity >=0.8.15; 3 | 4 | import "src/Contract.sol"; 5 | 6 | contract ImportedLibraryUser { 7 | // junk so the identifier works 8 | function asdfghjklmnopqrstuvwxyz() external { 9 | // should be marked as covered 10 | InternalLibrary.addLtTen(5, 6); 11 | } 12 | 13 | function askfjdlasfklasjgfklsdjgsdklgjskldgjksdlgjk() external { 14 | // should not be covered 15 | revert("yooooooooooooooooooooooo"); 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /test/Contract.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: UNLICENSED 2 | pragma solidity >=0.8.15; 3 | 4 | import "ds-test/test.sol"; 5 | import "src/Contract.sol"; 6 | import "src/Contract2.sol"; 7 | 8 | interface Cheats { 9 | function expectRevert() external; 10 | function expectRevert(bytes calldata) external; 11 | } 12 | 13 | contract BranchTest is DSTest { 14 | Cheats internal constant cheats = Cheats(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D); 15 | Branches fixture; 16 | 17 | function setUp() external { 18 | fixture = new Branches(); 19 | } 20 | 21 | function testBranchRequire() public { 22 | fixture.branchRequire(true); 23 | cheats.expectRevert(); 24 | fixture.branchRequire(false); 25 | } 26 | 27 | function testBranchAssert() public { 28 | fixture.branchAssert(true); 29 | cheats.expectRevert(abi.encodeWithSignature("Panic(uint256)", 0x01)); 30 | fixture.branchAssert(false); 31 | } 32 | 33 | function testBranchIf() public { 34 | fixture.branchIf(true); 35 | cheats.expectRevert(); 36 | fixture.branchIf(false); 37 | } 38 | 39 | function testBranchIfElse() public { 40 | fixture.branchIfElse(true); 41 | cheats.expectRevert(); 42 | fixture.branchIfElse(false); 43 | } 44 | 45 | function testBranchIfElseIf() public { 46 | fixture.branchIfElseIf(true, true); 47 | fixture.branchIfElseIf(false, true); 48 | fixture.branchIfElseIf(true, false); 49 | fixture.branchIfElseIf(false, false); 50 | } 51 | 52 | function testBranchIfElseIfElse() public { 53 | fixture.branchIfElseIfElse(true, true); 54 | fixture.branchIfElseIfElse(false, true); 55 | fixture.branchIfElseIfElse(true, false); 56 | fixture.branchIfElseIfElse(false, false); 57 | } 58 | 59 | function testComplexBranch() public { 60 | fixture.complexBranch(false, 300); 61 | } 62 | } 63 | 64 | contract LoopTest is DSTest { 65 | Loop fixture; 66 | 67 | function setUp() external { 68 | fixture = new Loop(); 69 | } 70 | 71 | function testOddEven() external view { 72 | fixture.oddEven(); 73 | } 74 | } 75 | 76 | contract PartiallyCoveredTest is DSTest { 77 | PartiallyCovered fixture; 78 | 79 | function setUp() external { 80 | fixture = new PartiallyCovered(); 81 | } 82 | 83 | function testPartiallyCovered() external { 84 | fixture.allBranches(true); 85 | } 86 | } 87 | 88 | // Note: Shouldn't break 89 | contract StuffThatBreaksTest is DSTest { 90 | StuffThatBreaks fixture; 91 | 92 | function setUp() external { 93 | fixture = new StuffThatBreaks(); 94 | } 95 | 96 | function testJustReturns() external { 97 | assertEq(fixture.justReturns(), 1); 98 | } 99 | 100 | function testSomeInternalFunc() external { 101 | fixture.someInternalFunc(true); 102 | } 103 | } 104 | 105 | contract FuzzTest is DSTest { 106 | Fuzz fixture; 107 | 108 | function setUp() external { 109 | fixture = new Fuzz(); 110 | } 111 | 112 | function testFuzz(bool a) external { 113 | assert(fixture.eq(a, a)); 114 | } 115 | } 116 | 117 | contract InternalLibraryUserTest is DSTest { 118 | InternalLibraryUser fixture; 119 | 120 | function setUp() external { 121 | fixture = new InternalLibraryUser(); 122 | } 123 | 124 | function testRun() external { 125 | fixture.run(); 126 | } 127 | } 128 | 129 | contract ExternalLibraryUserTest is DSTest { 130 | ExternalLibraryUser fixture; 131 | 132 | function setUp() external { 133 | fixture = new ExternalLibraryUser(); 134 | } 135 | 136 | function testRun() external { 137 | fixture.run(); 138 | } 139 | } 140 | 141 | contract ImportedLibraryUserTest is DSTest { 142 | Cheats internal constant cheats = Cheats(0x7109709ECfa91a80626fF3989D68f67F5b1DD12D); 143 | ImportedLibraryUser fixture; 144 | 145 | function setUp() external { 146 | fixture = new ImportedLibraryUser(); 147 | } 148 | 149 | function testRun() external { 150 | cheats.expectRevert("too much"); 151 | fixture.asdfghjklmnopqrstuvwxyz(); 152 | } 153 | } 154 | 155 | contract UsingForLibraryUserTest is DSTest { 156 | UsingForLibraryUser fixture; 157 | 158 | function setUp() external { 159 | fixture = new UsingForLibraryUser(); 160 | } 161 | 162 | function testTenMinusArgPlusOne() external { 163 | assertEq(fixture.tenMinusArgPlusOne(10), 1); 164 | } 165 | } 166 | --------------------------------------------------------------------------------