├── .github └── workflows │ └── test.yml ├── .gitignore ├── .gitmodules ├── LICENSE ├── README.md ├── foundry.toml ├── src ├── Add1.huff ├── BasicBank.huff ├── CallValue.huff ├── CalldataLength.huff ├── CountTime.huff ├── Create.huff ├── Distributor.huff ├── Donations.huff ├── Emitter.huff ├── FooBar.huff ├── Keccak.huff ├── MaxOfArray.huff ├── Multiply.huff ├── MyCreator.huff ├── MyEtherBalance.huff ├── NonPayable.huff ├── Return1.huff ├── RevertCustom.huff ├── RevertString.huff ├── SendEther.huff ├── SimpleStore.huff ├── SimulateArray.huff ├── SumArray.huff └── TimeAndBlock.huff └── test ├── Add1.t.sol ├── BasicBank.t.sol ├── CallValue.t.sol ├── CalldataLength.t.sol ├── CountTime.t.sol ├── Create.t.sol ├── Distribute.t.sol ├── Donations.t.sol ├── Emitter.t.sol ├── FooBar.t.sol ├── Keccak.t.sol ├── MaxOfArray.t.sol ├── Multiply.t.sol ├── MyCreator.t.sol ├── MyEtherBalance.t.sol ├── NonPayable.t.sol ├── Return1.t.sol ├── RevertCustom.t.sol ├── RevertString.t.sol ├── SendEther.t.sol ├── SimpleStore.t.sol ├── SimulateArray.t.sol ├── SumArray.t.sol ├── TimeAndBlock.t.sol └── test-utils └── NonMatchingSelectorHelper.sol /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | 3 | on: workflow_dispatch 4 | 5 | env: 6 | FOUNDRY_PROFILE: ci 7 | 8 | jobs: 9 | check: 10 | strategy: 11 | fail-fast: true 12 | 13 | name: Foundry project 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/checkout@v3 17 | with: 18 | submodules: recursive 19 | 20 | - name: Install Foundry 21 | uses: foundry-rs/foundry-toolchain@v1 22 | with: 23 | version: nightly 24 | 25 | - name: Run Forge build 26 | run: | 27 | forge --version 28 | forge build --sizes 29 | id: build 30 | 31 | - name: Run Forge tests 32 | run: | 33 | forge test -vvv 34 | id: test 35 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiler files 2 | cache/ 3 | out/ 4 | 5 | # Ignores development broadcast logs 6 | !/broadcast 7 | /broadcast/*/31337/ 8 | /broadcast/**/dry-run/ 9 | 10 | # Docs 11 | docs/ 12 | 13 | # Dotenv file 14 | .env 15 | 16 | solutions/ 17 | src2/ 18 | 19 | .DS_Store -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "lib/forge-std"] 2 | path = lib/forge-std 3 | url = https://github.com/foundry-rs/forge-std 4 | [submodule "lib/foundry-huff"] 5 | path = lib/foundry-huff 6 | url = https://github.com/huff-language/foundry-huff 7 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # huff-puzzles by [RareSkills](https://www.rareskills.io) 2 | 3 | A series of puzzles that go from very easy to more difficult so that you can have a hands-on introduction to the [huff language](https://huff.sh) and learn EVM bytecode while doing it. 4 | 5 | ## Pre-requisites 6 | 7 | Make sure you've installed the Huff Compiler as outlined in the [Huff Docs](https://docs.huff.sh/get-started/installing/#installing-huff). 8 | 9 | TLDR: 10 | 11 | curl -L get.huff.sh | bash 12 | 13 | then: 14 | 15 | huffup 16 | 17 | To verify your installation, run `huffc --help`. This should print a list of available commands for the huff compiler cli. 18 | 19 | ## Installation 20 | 21 | To install dependencies, run: 22 | 23 | forge install 24 | 25 | ## How to play 26 | 27 | Go to [Return1.huff](https://github.com/rareskills/huff-puzzles/blob/main/src/Return1.huff) in the src folder and edit it as follows 28 | 29 | ```c 30 | #define macro MAIN() = takes(0) returns(0) { 31 | // store 1 in memory at offset 0 32 | 0x01 // [1] 33 | 0x00 // [0, 1] 34 | mstore // [] 35 | 36 | // return 1 37 | // return 32 bytes of memory starting at offset 0 38 | 0x20 // [32] 39 | 0x00 // [0, 32] 40 | return // [] 41 | } 42 | ``` 43 | 44 | Then run the test with 45 | 46 | forge test -vvv --mc Return1Test 47 | 48 | You should see something like this 49 | 50 | Running 1 test for test/Return1.t.sol:Return1Test 51 | [PASS] testReturn1() (gas: 5358) 52 | Test result: ok. 1 passed; 0 failed; finished in 4.56s 53 | 54 | ## Suggested order for other exercises 55 | 56 | - [CallValue](https://github.com/rareskills/huff-puzzles/blob/main/src/CallValue.huff) 57 | - [CalldataLength](https://github.com/rareskills/huff-puzzles/blob/main/src/CalldataLength.huff) 58 | - [TimeAndBlock](https://github.com/rareskills/huff-puzzles/blob/main/src/TimeAndBlock.huff) 59 | - [MyEtherBalance](https://github.com/rareskills/huff-puzzles/blob/main/src/MyEtherBalance.huff) 60 | - [Add1](https://github.com/rareskills/huff-puzzles/blob/main/src/Add1.huff) 61 | - [Multiply](https://github.com/rareskills/huff-puzzles/blob/main/src/Multiply.huff) 62 | - [CountTime](https://github.com/rareskills/huff-puzzles/blob/main/src/CountTime.huff) 63 | - [NonPayable](https://github.com/rareskills/huff-puzzles/blob/main/src/NonPayable.huff) 64 | - [FooBar](https://github.com/rareskills/huff-puzzles/blob/main/src/FooBar.huff) 65 | - [MyCreator](https://github.com/rareskills/huff-puzzles/blob/main/src/MyCreator.huff) 66 | - [SimpleStore](https://github.com/rareskills/huff-puzzles/blob/main/src/SimpleStore.huff) 67 | - [RevertCustom](https://github.com/rareskills/huff-puzzles/blob/main/src/RevertCustom.huff) 68 | - [RevertString](https://github.com/rareskills/huff-puzzles/blob/main/src/RevertString.huff) 69 | - [SumArray](https://github.com/rareskills/huff-puzzles/blob/main/src/SumArray.huff) 70 | - [Keccak](https://github.com/rareskills/huff-puzzles/blob/main/src/Keccak.huff) 71 | - [MaxOfArray](https://github.com/rareskills/huff-puzzles/blob/main/src/MaxOfArray.huff) 72 | - [Create](https://github.com/rareskills/huff-puzzles/blob/main/src/Create.huff) 73 | - [Emitter](https://github.com/rareskills/huff-puzzles/blob/main/src/Emitter.huff) 74 | - [Donations](https://github.com/rareskills/huff-puzzles/blob/main/src/Donations.huff) 75 | - [SendEther](https://github.com/rareskills/huff-puzzles/blob/main/src/SendEther.huff) 76 | - [BasicBank](https://github.com/rareskills/huff-puzzles/blob/main/src/BasicBank.huff) 77 | - [Distribute](https://github.com/rareskills/huff-puzzles/blob/main/src/Distributor.huff) 78 | - [SimulateArray](https://github.com/rareskills/huff-puzzles/blob/main/src/SimulateArray.huff) 79 | 80 | ## More resources 81 | 82 | - [Huff Documentation 🐴](https://docs.huff.sh/) 83 | - [Evm codes](https://evm.codes) 84 | - [Huffmate](https://github.com/huff-language/huffmate) 85 | - [Huff Console.log](https://github.com/AmadiMichael/Huff-Console) 86 | 87 | ## Contributors 88 | 89 | - [Michael Amadi](https://github.com/AmadiMichael) 90 | - [Jesse Raymond](https://github.com/jesserc) 91 | -------------------------------------------------------------------------------- /foundry.toml: -------------------------------------------------------------------------------- 1 | [profile.default] 2 | src = 'src' 3 | out = 'out' 4 | libs = ['lib'] 5 | ffi = true 6 | evm_version = 'shanghai' 7 | # See more config options https://github.com/foundry-rs/foundry/tree/master/config 8 | 9 | remappings = [ 10 | "forge-std/=lib/forge-std/src/", 11 | "foundry-huff/=lib/foundry-huff/src/", 12 | ] -------------------------------------------------------------------------------- /src/Add1.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * ADD HUFF EXERCISE 4 | * 5 | * When writing solidity, we most times have to perform some mathematical operations like addition etc 6 | * 7 | * The task is to write within the `MAIN` macro below, a function that takes in a uint256, adds 1 to it and returns the new value 8 | * 9 | * NOTICE: The contract should revert when an unrecognized function is called 10 | */ 11 | 12 | #define function add1(uint256) payable returns(uint256) 13 | 14 | 15 | #define macro MAIN() = takes(0) returns(0) { 16 | 17 | } -------------------------------------------------------------------------------- /src/BasicBank.huff: -------------------------------------------------------------------------------- 1 | /** 2 | * BASIC_BANK HUFF EXERCISE 3 | * 4 | * The task is to create a basic bank with huff 5 | * functionalities include 6 | * - depositing tokens via similar to how solidity's `receive` function works 7 | * - withdrawing tokens 8 | * - keeping track of and viewing balance 9 | */ 10 | 11 | #define function balanceOf(address) payable returns(uint256) 12 | #define function withdraw(uint256) payable returns() 13 | 14 | #define macro MAIN() = takes(0) returns(0) { 15 | 16 | } 17 | -------------------------------------------------------------------------------- /src/CallValue.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * CALL_VALUE HUFF EXERCISE 4 | * 5 | * 6 | * When a user sends a transaction to a smart contract, they can include value (ether). msg.value in solidity 7 | * 8 | * The task is to write within the `MAIN` macro below, huff code to get and return the amount of ether sent as part of that call 9 | */ 10 | 11 | #define macro MAIN() = takes(0) returns(0) { 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/CalldataLength.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * CALLDATA_LENGTH HUFF EXERCISE 4 | * 5 | * 6 | * When a user sends a transaction to a smart contract, they can include additional data, known as calldata, which the smart contract can use to execute its logic. 7 | * 8 | * The task is to write within the `MAIN` macro below, huff code to get and return the length of this calldata, 9 | */ 10 | 11 | #define macro MAIN() = takes(0) returns(0) { 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/CountTime.huff: -------------------------------------------------------------------------------- 1 | /** 2 | * COUNT_TIME HUFF EXERCISE 3 | * 4 | * The task is to write within the `MAIN` macro below, functions named `getTimeElapsed` and `getTimeUntil`. 5 | * 6 | * `getTimeElapsed` receives the uint256 parameter (_timestamp) and counts how much time elapsed since the provided _timestamp, it should return 0 if the provided timestamp is in the future 7 | * `getTimeUntil` receives uint256 parameter (_timestamp) and counts how much time remains until the provided _timestamp, it should return 0 if the provided timestamp is in the past 8 | * 9 | * NOTICE: The contract should revert when an unrecognized function is called 10 | */ 11 | 12 | #define function getTimeElapsed(uint256) payable returns(uint256) 13 | #define function getTimeUntil(uint256) payable returns(uint256) 14 | 15 | 16 | #define macro MAIN() = takes(0) returns(0) { 17 | 18 | } -------------------------------------------------------------------------------- /src/Create.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * CREATE HUFF EXERCISE 4 | * 5 | * The task is to deploy this contract with a function `makeContract()` which when called creates a contract 6 | * that when called with any data returns `0xcaffe`. 7 | * The call to `makeContract` should return the address of the newly created contract. 8 | * 9 | * NOTICE: The contract should revert when an unrecognized function is called 10 | */ 11 | 12 | #define function makeContract() payable returns(address) 13 | 14 | 15 | #define macro MAIN() = takes(0) returns(0) { 16 | 17 | } -------------------------------------------------------------------------------- /src/Distributor.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * DISTRIBUTE HUFF EXERCISE 4 | * 5 | * The task is to enable this contract, when called with function `distribute(address[])` to 6 | * distribute the value sent with the call to each address in the address array as evenly. 7 | * Revert if array length is 0 8 | * Assume that array length would always be less than or equal to msg.value 9 | * 10 | * NOTICE: The contract should revert when an unrecognized function is called 11 | */ 12 | 13 | #define function distribute(address[]) payable returns() 14 | 15 | 16 | #define macro MAIN() = takes(0) returns(0) { 17 | 18 | } -------------------------------------------------------------------------------- /src/Donations.huff: -------------------------------------------------------------------------------- 1 | /** 2 | * DONATIONS HUFF EXERCISE 3 | * 4 | * The task is to Implement solidity's "receive" functionality which allows sending ether to a smart contract without any calldata 5 | * also have a getter function that returns how much an address has donated. Addresses can donate several times 6 | */ 7 | 8 | #define function donated(address) payable returns(uint256) 9 | 10 | #define macro MAIN() = takes(0) returns(0) { 11 | 12 | } -------------------------------------------------------------------------------- /src/Emitter.huff: -------------------------------------------------------------------------------- 1 | /** 2 | * EMITTER HUFF EXERCISE 3 | * 4 | * The task is to enable this contract, when the function `value(uint256, uint256)` is called, should 5 | * emit an event named `Value(uint256 indexed, uint256)` 6 | * 7 | * NOTICE: The contract should revert when an unrecognized function is called 8 | */ 9 | 10 | #define function value(uint256, uint256) payable returns() 11 | 12 | #define event Value(uint256 indexed, uint256) 13 | 14 | 15 | #define macro MAIN() = takes(0) returns(0) { 16 | 17 | } 18 | -------------------------------------------------------------------------------- /src/FooBar.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * FOO_BAR HUFF EXERCISE 4 | * 5 | * Majority of ethereum contracts hold logic divide this logic into functions which users can specify and call to execute a particular logic without clashing into the other 6 | * 7 | * The task is to write within the `MAIN` macro below, huff code that mimics 2 solidity functions. 8 | * - One named `foo()` that simply returns 2, 9 | * - the second named `bar()` that simply returns 3. 10 | * 11 | * NOTICE: The contract should revert when an unrecognized function is called 12 | */ 13 | 14 | #define function foo() payable returns(uint256) 15 | #define function bar() payable returns(uint256) 16 | 17 | 18 | #define macro MAIN() = takes(0) returns(0) { 19 | 20 | } -------------------------------------------------------------------------------- /src/Keccak.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * KECCAK HUFF EXERCISE 4 | * 5 | * When writing solidity, we some times have to perform hashing operations like keccak256 etc 6 | * 7 | * The task is to write within the `MAIN` macro below, a function that returns the keccak256 of the calldata. Should handle zero calldata 8 | */ 9 | 10 | 11 | #define macro MAIN() = takes(0) returns(0) { 12 | 13 | } -------------------------------------------------------------------------------- /src/MaxOfArray.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * MAX_OF_ARRAY HUFF EXERCISE 4 | * 5 | * In this task, Given an abi encoded array of uint256, return its maximum value. Revert if the array is empty. 6 | * 7 | * NOTICE: The contract should revert when an unrecognized function is called 8 | */ 9 | 10 | #define function maxOfArray(uint256[]) payable returns(uint256) 11 | 12 | #define macro MAIN() = takes(0) returns(0) { 13 | 14 | } -------------------------------------------------------------------------------- /src/Multiply.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * MULTIPLY HUFF EXERCISE 4 | * 5 | * When writing solidity, we most times have to perform some mathematical operations like multiplication etc 6 | * 7 | * The task is to write within the `MAIN` macro below, a function named `multiply` that takes in 2 uint256s, and returns their product. Be sure to revert on overflow 8 | * 9 | * NOTICE: The contract should revert when an unrecognized function is called 10 | */ 11 | 12 | #define function multiply(uint256, uint256) payable returns(uint256) 13 | 14 | 15 | #define macro MAIN() = takes(0) returns(0) { 16 | 17 | } -------------------------------------------------------------------------------- /src/MyCreator.huff: -------------------------------------------------------------------------------- 1 | /** 2 | * MY_CREATOR HUFF EXERCISE 3 | * 4 | * The task is to write within the `MAIN` and `CONSTRUCTOR` macros below. 5 | * 6 | * `CONSTRUCTOR` stores the deployer's address in the state variable. 7 | * `MAIN` returns the address of its deployer. 8 | * 9 | * NOTICE: The contract should revert when an unrecognized function is called 10 | */ 11 | 12 | #define function getMyCreator() payable returns(address) 13 | 14 | 15 | // STORAGE 16 | #define constant DEPLOYER = FREE_STORAGE_POINTER() 17 | 18 | 19 | #define macro CONSTRUCTOR() = takes(0) returns(0) { 20 | 21 | } 22 | 23 | #define macro MAIN() = takes(0) returns(0) { 24 | 25 | } 26 | -------------------------------------------------------------------------------- /src/MyEtherBalance.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * MY ETHER BALANCE HUFF EXERCISE 4 | * 5 | * Every Ethereum account has an ether balance associated with it, which represents the amount of ether that the account currently holds. 6 | * 7 | * The task is to write within the `MAIN` macro below, huff code that retrieves the ether balance of the address that sent the transaction, also known as msg.sender in solidity. 8 | */ 9 | 10 | #define macro MAIN() = takes(0) returns(0) { 11 | 12 | } -------------------------------------------------------------------------------- /src/NonPayable.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * NON PAYABLE HUFF EXERCISE 4 | * 5 | * When a user sends a transaction to a smart contract, they can include ether with the transaction. 6 | * In solidity we denote that we wish to accept this ether by either marking the function as payable or adding a payable fallback/receive function to our contract 7 | * 8 | * The task is to write within the `MAIN` macro below, huff code that reverts if ether is sent with the transaction. 9 | */ 10 | 11 | #define macro MAIN() = takes(0) returns(0) { 12 | 13 | } -------------------------------------------------------------------------------- /src/Return1.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * EXAMPLE HUFF EXERCISE - RETURN 1 () 4 | * 5 | * This huff contract simply returns 1 whenever it is called with/without data and with/without ether 6 | */ 7 | 8 | 9 | #define macro MAIN() = takes(0) returns(0) { 10 | 11 | } -------------------------------------------------------------------------------- /src/RevertCustom.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * REVERT_CUSTOM HUFF EXERCISE 4 | * 5 | * 6 | * When a transaction is being executed within a smart contract, based on the logic of that contract, it can revert if a preset condition is not met. 7 | * They're 2 main ways to revert in solidity, 8 | * - using a string error message e,g (`require(x != 0, "Only values above 0");`) 9 | * - reverting with a custom error e.g (`if(x == 0) revert OnlyValuesAbove0();`) 10 | * 11 | * The task is to write within the `MAIN` macro below, huff code that reverts (all the time) with the custom error `OnlyHuff()` 12 | */ 13 | 14 | #define error OnlyHuff() 15 | 16 | #define macro MAIN() = takes(0) returns(0) { 17 | 18 | } 19 | -------------------------------------------------------------------------------- /src/RevertString.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * REVERT_STRING HUFF EXERCISE 4 | * 5 | * 6 | * When a transaction is being executed within a smart contract, based on the logic of that contract, it can revert if a preset condition is not met. 7 | * They're 2 main ways to revert in solidity, 8 | * - using a string error message e,g (`require(x != 0, "Only values above 0");`) 9 | * - reverting with a custom error e.g (`if(x == 0) revert OnlyValuesAbove0();`) 10 | * 11 | * The task is to write within the `MAIN` macro below, huff code that reverts (all the time) with the string error message `Only Huff` 12 | */ 13 | 14 | 15 | #define macro MAIN() = takes(0) returns(0) { 16 | 17 | } 18 | -------------------------------------------------------------------------------- /src/SendEther.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * SEND_ETHER HUFF EXERCISE 4 | * 5 | * The task is to enable this contract, when called with function `sendEther(address)` to 6 | * transfer the value sent with the call to the address in the argument. 7 | * 8 | * NOTICE: The contract should revert when an unrecognized function is called 9 | */ 10 | 11 | #define function sendEther(address) payable returns() 12 | 13 | 14 | #define macro MAIN() = takes(0) returns(0) { 15 | 16 | } -------------------------------------------------------------------------------- /src/SimpleStore.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * SIMPLE_STORE HUFF EXERCISE 4 | * 5 | * One of the storage locations available to devs when writing smart contracts is Storage. Its persistent and expensive 6 | * 7 | * The task is to write within the `MAIN` macro below, 2 functions... 8 | * - One named `store()` that takes one function argument and stores it in storage slot 0, 9 | * - the second named `read()` that simply returns what is stored at storage slot 0. 10 | * 11 | * NOTICE: The contract should revert when an unrecognized function is called 12 | */ 13 | 14 | #define function store(uint256) payable returns() 15 | #define function read() payable returns(uint256) 16 | 17 | 18 | #define macro MAIN() = takes(0) returns(0) { 19 | 20 | } -------------------------------------------------------------------------------- /src/SimulateArray.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * SUM_ARRAY HUFF EXERCISE 4 | * 5 | * In this puzzle, the task is to simulate an array in Huff using the "exact" storage pattern as solidity. Expected functions can; 6 | * - Push numbers onto a array, 7 | * - Pop the last index from the array, 8 | * - View what's stored at an index, 9 | * - Gets the length of the array, 10 | * - Write to an index if it is valid. 11 | * 12 | * - Writes and reads outside of length revert. 13 | * - Popping off a zero length array reverts. 14 | * 15 | * NOTICE: The contract should revert when an unrecognized function is called 16 | */ 17 | 18 | #define function pushh(uint256 num) payable returns() 19 | #define function popp() payable returns() 20 | #define function read(uint256 index) payable returns(uint256) 21 | #define function length() payable returns(uint256) 22 | #define function write(uint256 index, uint256 num) payable returns() 23 | 24 | #define error OutOfBounds() 25 | #define error ZeroArray() 26 | 27 | #define macro MAIN() = takes(0) returns(0) { 28 | 29 | } -------------------------------------------------------------------------------- /src/SumArray.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * SUM_ARRAY HUFF EXERCISE 4 | * 5 | * 6 | * The task is to write within the `MAIN` macro below, write a functionality that takes an array of uint256 as an argument and returns the sum of all the numbers 7 | * 8 | * NOTICE: The contract should revert when an unrecognized function is called 9 | */ 10 | 11 | #define function sumArray(uint256[]) payable returns(uint256) 12 | 13 | 14 | #define macro MAIN() = takes(0) returns(0) { 15 | 16 | } -------------------------------------------------------------------------------- /src/TimeAndBlock.huff: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * TIME_AND_BLOCK HUFF EXERCISE 4 | * 5 | * The task is to write within the `MAIN` macro below, a function named `getTimeAndBlock` that and returns current timestamp and block number. 6 | * 7 | * NOTICE: The contract should revert when an unrecognized function is called 8 | */ 9 | 10 | #define function getTimeAndBlock() payable returns(uint256, uint256) 11 | 12 | 13 | #define macro MAIN() = takes(0) returns(0) { 14 | 15 | } -------------------------------------------------------------------------------- /test/Add1.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface Add1 { 9 | function add1(uint256 num) external pure returns (uint256); 10 | } 11 | 12 | contract Add1Test is Test, NonMatchingSelectorHelper { 13 | Add1 public add1; 14 | 15 | function setUp() public { 16 | add1 = Add1(HuffDeployer.config().deploy("Add1")); 17 | } 18 | 19 | function testAdd1(uint256 n) public { 20 | unchecked { 21 | assertEq(add1.add1(n), n + 1, "Wrong return number"); 22 | } 23 | } 24 | 25 | /// @notice Test that a non-matching selector reverts 26 | function testNonMatchingSelector(bytes32 callData) public { 27 | bytes4[] memory func_selectors = new bytes4[](1); 28 | func_selectors[0] = Add1.add1.selector; 29 | 30 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(add1)); 31 | assert(!success); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /test/BasicBank.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | interface BasicBank { 8 | function balanceOf(address user) external view returns (uint256); 9 | 10 | function withdraw(uint256 amount) external; 11 | } 12 | 13 | contract BasicBankTest is Test { 14 | BasicBank public basicBank; 15 | 16 | function setUp() public { 17 | basicBank = BasicBank(HuffDeployer.config().deploy("BasicBank")); 18 | } 19 | 20 | function testDeposit(uint256 value) external { 21 | vm.deal(address(this), value); 22 | (bool success,) = address(basicBank).call{value: value}(""); 23 | require(success, "deposit failed"); 24 | assertEq(address(basicBank).balance, value, "Wrong balance of basic bank contract"); 25 | assertEq(basicBank.balanceOf(address(this)), value, "Wrong balance of depositor"); 26 | } 27 | 28 | function testRemoveEther(uint256 value) external { 29 | vm.deal(address(this), value); 30 | (bool success,) = address(basicBank).call{value: value}(""); 31 | require(success, "deposit failed"); 32 | basicBank.withdraw(value); 33 | assertEq(address(this).balance, value, "Wrong balance of depositor"); 34 | assertEq(basicBank.balanceOf(address(this)), 0 ether, "Balance of basic bank contract should be 0"); 35 | } 36 | 37 | function testWithdrawRevertWithoutDeposit(uint256 value) external { 38 | vm.assume(value > 0); 39 | vm.expectRevert(); 40 | basicBank.withdraw(value); 41 | } 42 | 43 | receive() external payable {} 44 | } 45 | -------------------------------------------------------------------------------- /test/CallValue.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | interface CallValue {} 8 | 9 | contract CallValueTest is Test { 10 | CallValue public callValue; 11 | 12 | function setUp() public { 13 | callValue = CallValue(HuffDeployer.config().deploy("CallValue")); 14 | } 15 | 16 | function testCallValue(uint256 value) public { 17 | vm.deal(address(this), value); 18 | (bool success, bytes memory retdata) = address(callValue).call{value: value}(""); 19 | require(success, "call failed"); 20 | assertEq(abi.decode(retdata, (uint256)), value, "Wrong retdata"); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /test/CalldataLength.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | interface CalldataLength {} 8 | 9 | contract CalldataLengthTest is Test { 10 | CalldataLength public calldataLength; 11 | 12 | function setUp() public { 13 | calldataLength = CalldataLength(HuffDeployer.config().deploy("CalldataLength")); 14 | } 15 | 16 | function testCalldataLength(bytes memory data) public { 17 | (bool success, bytes memory retdata) = address(calldataLength).call(data); 18 | require(success, "call failed"); 19 | assertEq(abi.decode(retdata, (uint256)), data.length, "Expected retdata to be the length of data sent"); 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /test/CountTime.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface CountTime { 9 | function getTimeElapsed(uint256) external returns (uint256); 10 | function getTimeUntil(uint256) external returns (uint256); 11 | } 12 | 13 | contract CountTimeTest is Test, NonMatchingSelectorHelper { 14 | CountTime public countTime; 15 | 16 | function setUp() public { 17 | countTime = CountTime(HuffDeployer.config().deploy("CountTime")); 18 | } 19 | 20 | function testCountTime(uint256 skipBlocks, uint256 timestamp) external { 21 | vm.assume(skipBlocks < type(uint256).max); 22 | skip(skipBlocks); 23 | 24 | uint256 timeElapsed = countTime.getTimeElapsed(timestamp); 25 | uint256 expectedTimeElapsed = (block.timestamp > timestamp ? block.timestamp - timestamp : 0); 26 | assertEq( 27 | timeElapsed, 28 | expectedTimeElapsed, 29 | string.concat( 30 | "The returned timeElapsed differs from the correct: ", 31 | vm.toString(timeElapsed), 32 | " != ", 33 | vm.toString(expectedTimeElapsed) 34 | ) 35 | ); 36 | 37 | uint256 timeUntil = countTime.getTimeUntil(timestamp); 38 | uint256 expectedTimeUntil = (block.timestamp < timestamp ? timestamp - block.timestamp : 0); 39 | assertEq( 40 | timeUntil, 41 | expectedTimeUntil, 42 | string.concat( 43 | "The returned timeUntil differs from the correct: ", 44 | vm.toString(timeUntil), 45 | " != ", 46 | vm.toString(expectedTimeUntil) 47 | ) 48 | ); 49 | } 50 | 51 | /// @notice Test that a non-matching selector reverts 52 | function testNonMatchingSelector(bytes32 callData) public { 53 | bytes4[] memory func_selectors = new bytes4[](2); 54 | func_selectors[0] = CountTime.getTimeElapsed.selector; 55 | func_selectors[1] = CountTime.getTimeUntil.selector; 56 | 57 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(countTime)); 58 | assert(!success); 59 | } 60 | } 61 | -------------------------------------------------------------------------------- /test/Create.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface Create { 9 | function makeContract() external returns (address); 10 | } 11 | 12 | contract CreateTest is Test, NonMatchingSelectorHelper { 13 | Create public create; 14 | 15 | function setUp() public { 16 | create = Create(HuffDeployer.config().deploy("Create")); 17 | } 18 | 19 | function testCreate() external { 20 | address newContract = create.makeContract(); 21 | assertEq(newContract != address(0), true, "new contract cannot be address 0"); 22 | 23 | (bool success, bytes memory data) = newContract.call(""); 24 | require(success, "check return of new contract failed"); 25 | assertEq( 26 | abi.decode(data, (bytes32)), 27 | 0x00000000000000000000000000000000000000000000000000000000000caffe, 28 | "expected new contract call to return 0xcaffe" 29 | ); 30 | } 31 | 32 | /// @notice Test that a non-matching selector reverts 33 | function testNonMatchingSelector(bytes32 callData) public { 34 | bytes4[] memory func_selectors = new bytes4[](1); 35 | func_selectors[0] = Create.makeContract.selector; 36 | 37 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(create)); 38 | assert(!success); 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /test/Distribute.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.17; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface Distributor { 9 | function distribute(address[] calldata) external payable; 10 | } 11 | 12 | contract DistributeTest is Test, NonMatchingSelectorHelper { 13 | address[16] precompiles_and_foundry_helper_addresses = [ 14 | address(1), 15 | address(2), 16 | address(3), 17 | address(4), 18 | address(5), 19 | address(6), 20 | address(7), 21 | address(8), 22 | address(9), 23 | address(uint160(uint256(keccak256("hevm cheat code")))), // VM_ADDRESS 24 | 0x000000000000000000636F6e736F6c652e6c6f67, // console address 25 | 0x4e59b44847b379578588920cA78FbF26c0B4956C, // create2 factory 26 | 0x1804c8AB1F12E6bbf3894d4083f33e07309d1f38, // default sender 27 | 0x5615dEB798BB3E4dFa0139dFa1b3D433Cc23b72f, // default test contract 28 | 0xcA11bde05977b3631167028862bE2a173976CA11, // multicall3 address 29 | address(this) 30 | ]; 31 | Distributor public distributor; 32 | 33 | function setUp() public { 34 | distributor = Distributor(HuffDeployer.config().deploy("Distributor")); 35 | } 36 | 37 | function testDistribute(uint256 value, address[] memory receivers) public { 38 | vm.deal(address(this), value); 39 | if (receivers.length == 0) vm.expectRevert(); 40 | 41 | // foundry only accepts a max 2**16 of vm.assumes in a test run so assert the length of recievers * precompiles_and_foundry_helper_addresses is within the limit 42 | // also subtract 3 to account for the other assumes below 43 | vm.assume(receivers.length < (2 ** 16 / precompiles_and_foundry_helper_addresses.length) - 3); 44 | assume_not_precompile_or_foundry_helper_address(receivers); 45 | 46 | distributor.distribute{value: value}(receivers); 47 | for (uint256 i; i < receivers.length; ++i) { 48 | uint256 size; 49 | address receiver = receivers[i]; 50 | assembly { 51 | size := extcodesize(receiver) 52 | } 53 | vm.assume(size == 0); 54 | assertGe(receiver.balance, value / receivers.length, "Wrong balance of receiver"); 55 | } 56 | } 57 | 58 | /// @notice Test that a non-matching selector reverts 59 | function testNonMatchingSelector(bytes32 callData) public { 60 | bytes4[] memory func_selectors = new bytes4[](1); 61 | func_selectors[0] = Distributor.distribute.selector; 62 | 63 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(distributor)); 64 | assert(!success); 65 | } 66 | 67 | function assume_not_precompile_or_foundry_helper_address(address[] memory addresses) private view { 68 | for (uint256 i; i < addresses.length; ++i) { 69 | for (uint256 j; j < precompiles_and_foundry_helper_addresses.length; ++j) { 70 | vm.assume(addresses[i] != precompiles_and_foundry_helper_addresses[j]); 71 | } 72 | } 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /test/Donations.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | interface Donations { 8 | function donated(address user) external view returns (uint256); 9 | } 10 | 11 | contract DonationsTest is Test { 12 | Donations public donations; 13 | 14 | function setUp() public { 15 | donations = Donations(HuffDeployer.config().deploy("Donations")); 16 | } 17 | 18 | function testDonations(uint256[] memory amounts) public { 19 | uint256 sum; 20 | for (uint256 i; i < amounts.length;) { 21 | vm.deal(address(this), amounts[i]); 22 | sum += amounts[i]; 23 | (bool success,) = address(donations).call{value: amounts[i]}(""); 24 | require(success, "call failed"); 25 | assertEq(donations.donated(address(this)), sum, "Wrong expected donated balance"); 26 | unchecked { 27 | if (amounts.length == ++i || sum + amounts[i] < sum) break; 28 | } 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /test/Emitter.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.17; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface Emitter { 9 | function value(uint256, uint256) external; 10 | } 11 | 12 | contract EmitterTest is Test, NonMatchingSelectorHelper { 13 | Emitter public emitter; 14 | 15 | event Value(uint256 indexed, uint256); 16 | 17 | function setUp() public { 18 | emitter = Emitter(HuffDeployer.config().deploy("Emitter")); 19 | } 20 | 21 | function testEmitter() public { 22 | vm.expectEmit(true, true, false, true); 23 | emit Value(42, 24); 24 | emitter.value(42, 24); 25 | } 26 | 27 | /// @notice Test that a non-matching selector reverts 28 | function testNonMatchingSelector(bytes32 callData) public { 29 | bytes4[] memory func_selectors = new bytes4[](1); 30 | func_selectors[0] = Emitter.value.selector; 31 | 32 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(emitter)); 33 | assert(!success); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /test/FooBar.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface FooBar { 9 | function foo() external pure returns (uint256); 10 | 11 | function bar() external pure returns (uint256); 12 | } 13 | 14 | contract FooBarTest is Test, NonMatchingSelectorHelper { 15 | FooBar public fooBar; 16 | 17 | function setUp() public { 18 | fooBar = FooBar(HuffDeployer.config().deploy("FooBar")); 19 | } 20 | 21 | function testFooBar() public { 22 | assertEq(fooBar.foo(), 2, "Foo expected to return 2"); 23 | assertEq(fooBar.bar(), 3, "Bar expected to return 3"); 24 | } 25 | 26 | /// @notice Test that a non-matching selector reverts 27 | function testNonMatchingSelector(bytes32 callData) public { 28 | bytes4[] memory func_selectors = new bytes4[](2); 29 | func_selectors[0] = FooBar.foo.selector; 30 | func_selectors[1] = FooBar.bar.selector; 31 | 32 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(fooBar)); 33 | assert(!success); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /test/Keccak.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | contract KeccakTest is Test { 8 | address public keccak; 9 | 10 | function setUp() public { 11 | keccak = HuffDeployer.config().deploy("Keccak"); 12 | } 13 | 14 | function testKeccak(bytes memory data) public 15 | { 16 | vm.assume(data.length < 33 && data.length > 0); 17 | bytes32 expectedHash = keccak256(abi.encode(data)); 18 | 19 | (bool success, bytes memory res) = keccak.call(abi.encode(data)); 20 | require(success, "call failed"); 21 | assertEq(expectedHash, abi.decode(res, (bytes32)), "huff keccak hash != expectedHash"); 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /test/MaxOfArray.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface MaxOfArray { 9 | function maxOfArray(uint256[] calldata nums) external pure returns (uint256); 10 | } 11 | 12 | contract MaxOfArrayTest is Test, NonMatchingSelectorHelper { 13 | MaxOfArray public maxOfArray; 14 | 15 | function setUp() public { 16 | maxOfArray = MaxOfArray(HuffDeployer.config().deploy("MaxOfArray")); 17 | } 18 | 19 | function testMaxOfArray() external { 20 | uint256[] memory arr = new uint256[](10); 21 | arr[0] = 2; 22 | arr[1] = 4; 23 | arr[2] = 262; 24 | arr[3] = 8; 25 | arr[4] = 4; 26 | arr[5] = 1; 27 | arr[6] = 0; 28 | arr[7] = 17; 29 | arr[8] = 67251781; 30 | arr[9] = 27; 31 | 32 | uint256 x = maxOfArray.maxOfArray(arr); 33 | assertEq(x, 67251781, "expected max of arr to be 67251781"); 34 | 35 | uint256[] memory arr2 = new uint256[](0); 36 | vm.expectRevert(); 37 | maxOfArray.maxOfArray(arr2); 38 | 39 | uint256[] memory arr3 = new uint256[](5); 40 | arr3[0] = 2; 41 | arr3[1] = 7; 42 | arr3[2] = 7; 43 | arr3[3] = 5; 44 | arr3[4] = 4; 45 | x = maxOfArray.maxOfArray(arr3); 46 | assertEq(x, 7, "expected max of arr to be 7"); 47 | } 48 | 49 | /// @notice Test that a non-matching selector reverts 50 | function testNonMatchingSelector(bytes32 callData) public { 51 | bytes4[] memory func_selectors = new bytes4[](1); 52 | func_selectors[0] = MaxOfArray.maxOfArray.selector; 53 | 54 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(maxOfArray)); 55 | assert(!success); 56 | } 57 | } 58 | -------------------------------------------------------------------------------- /test/Multiply.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface Multiply { 9 | function multiply(uint256 num1, uint256 num2) external pure returns (uint256); 10 | } 11 | 12 | contract MultiplyTest is Test, NonMatchingSelectorHelper { 13 | Multiply public multiply; 14 | 15 | function setUp() public { 16 | multiply = Multiply(HuffDeployer.config().deploy("Multiply")); 17 | } 18 | 19 | function testMultiply(uint256 a, uint256 b) public { 20 | unchecked { 21 | if (b == 0 || a == (a * b) / b) { 22 | assertEq(multiply.multiply(a, b), a * b, "Wrong result for Multiply(a, b)"); 23 | } else { 24 | vm.expectRevert(); 25 | multiply.multiply(a, b); 26 | } 27 | } 28 | } 29 | 30 | /// @notice Test that a non-matching selector reverts 31 | function testNonMatchingSelector(bytes32 callData) public { 32 | bytes4[] memory func_selectors = new bytes4[](1); 33 | func_selectors[0] = Multiply.multiply.selector; 34 | 35 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(multiply)); 36 | assert(!success); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /test/MyCreator.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer, HuffConfig} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface MyCreator { 9 | function getMyCreator() external returns (address); 10 | } 11 | 12 | contract MyCreatorTest is Test, NonMatchingSelectorHelper { 13 | MyCreator public myCreator; 14 | HuffConfig public config; 15 | 16 | function setUp() public { 17 | config = HuffDeployer.config(); 18 | myCreator = MyCreator(config.deploy("MyCreator")); 19 | } 20 | 21 | function testMyCreator() public { 22 | address returnedCreator = myCreator.getMyCreator(); 23 | 24 | assertEq( 25 | returnedCreator, 26 | address(config), 27 | string.concat( 28 | "The returned creator address differs from the correct: ", 29 | vm.toString(returnedCreator), 30 | " != ", 31 | vm.toString(address(config)) 32 | ) 33 | ); 34 | } 35 | 36 | /// @notice Test that a non-matching selector reverts 37 | function testNonMatchingSelector(bytes32 callData) public { 38 | bytes4[] memory func_selectors = new bytes4[](1); 39 | func_selectors[0] = MyCreator.getMyCreator.selector; 40 | 41 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(myCreator)); 42 | assert(!success); 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /test/MyEtherBalance.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | interface MyEtherBalance {} 8 | 9 | contract MyEtherBalanceTest is Test { 10 | MyEtherBalance public myEtherBalance; 11 | 12 | function setUp() public { 13 | myEtherBalance = MyEtherBalance(HuffDeployer.config().deploy("MyEtherBalance")); 14 | } 15 | 16 | function testMyEtherBalance(uint256 balance) public { 17 | vm.startPrank(address(this), address(this)); 18 | (bool success, bytes memory data) = address(myEtherBalance).call(""); 19 | vm.deal(address(this), balance); 20 | (success, data) = address(myEtherBalance).call(""); 21 | require(success, "call failed"); 22 | assertEq(abi.decode(data, (uint256)), balance, "Wrong returned balance of caller"); 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /test/NonPayable.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | interface NonPayable {} 8 | 9 | contract NonPayableTest is Test { 10 | NonPayable public nonPayable; 11 | 12 | function setUp() public { 13 | nonPayable = NonPayable(HuffDeployer.config().deploy("NonPayable")); 14 | } 15 | 16 | function testNonPayable(uint256 value) public { 17 | vm.deal(address(this), value); 18 | 19 | bool expected; 20 | if (value == 0) { 21 | expected = true; 22 | } 23 | 24 | (bool success,) = address(nonPayable).call{value: value}(""); 25 | assertEq(success, expected, "call did not pass as expected"); 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /test/Return1.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | contract Return1Test is Test { 8 | address public return1; 9 | 10 | function setUp() public { 11 | return1 = HuffDeployer.config().deploy("Return1"); 12 | } 13 | 14 | function testReturn1() public { 15 | (bool success, bytes memory ret) = return1.call(""); 16 | require(success, "call to return1 address failed"); 17 | assertEq(abi.decode(ret, (uint256)), 1, "Expected a call to return1 address to return 1"); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /test/RevertCustom.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | interface RevertCustom {} 8 | 9 | contract RevertCustomTest is Test { 10 | RevertCustom public revertCustom; 11 | 12 | function setUp() public { 13 | revertCustom = RevertCustom(HuffDeployer.config().deploy("RevertCustom")); 14 | } 15 | 16 | function testRevertCustom() public { 17 | (bool success, bytes memory revertMessage) = address(revertCustom).call(""); 18 | assertEq(success, false, "Call expected to revert but it didn't"); 19 | assertEq( 20 | keccak256(abi.encode(bytes4(revertMessage))), 21 | keccak256(abi.encode(bytes4(keccak256("OnlyHuff()")))), 22 | "Expected the call to revert with custom error 'OnlyHuff()' but it didn't " 23 | ); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /test/RevertString.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | 7 | interface RevertString {} 8 | 9 | contract RevertStringTest is Test { 10 | RevertString public revertString; 11 | 12 | function setUp() public { 13 | revertString = RevertString(HuffDeployer.config().deploy("RevertString")); 14 | } 15 | 16 | function testRevertString() public { 17 | (bool success, bytes memory revertData) = address(revertString).call(""); 18 | require(!success, "call expected to fail"); 19 | assertEq( 20 | keccak256(bytes("Only Huff")), 21 | keccak256(abi.decode(revertData, (bytes))), 22 | "Expected the call to revert with custom error 'Only Huff' but it didn't " 23 | ); 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /test/SendEther.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.17; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface SendEther { 9 | function sendEther(address) external payable; 10 | } 11 | 12 | contract SendEtherTest is Test, NonMatchingSelectorHelper { 13 | SendEther public sendEther; 14 | 15 | function setUp() public { 16 | sendEther = SendEther(HuffDeployer.config().deploy("SendEther")); 17 | } 18 | 19 | function testSendEther(uint256 value, address receiver) public { 20 | vm.deal(address(this), value); 21 | uint256 size; 22 | assembly { 23 | size := extcodesize(receiver) 24 | } 25 | vm.assume(size == 0); 26 | 27 | uint256 _balance = receiver.balance; 28 | sendEther.sendEther{value: value}(receiver); 29 | uint256 balance_ = receiver.balance; 30 | 31 | assertEq(balance_ - _balance, value, "balance of address(0xDEAD) is not 1 ether"); 32 | } 33 | 34 | /// @notice Test that a non-matching selector reverts 35 | function testNonMatchingSelector(bytes32 callData) public { 36 | bytes4[] memory func_selectors = new bytes4[](1); 37 | func_selectors[0] = SendEther.sendEther.selector; 38 | 39 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(sendEther)); 40 | assert(!success); 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /test/SimpleStore.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface SimpleStore { 9 | function store(uint256 num) external; 10 | 11 | function read() external view returns (uint256); 12 | } 13 | 14 | contract SimpleStoreTest is Test, NonMatchingSelectorHelper { 15 | SimpleStore public simpleStore; 16 | 17 | function setUp() public { 18 | simpleStore = SimpleStore(HuffDeployer.config().deploy("SimpleStore")); 19 | } 20 | 21 | function testSimpleStore(uint256 value) public { 22 | simpleStore.store(value); 23 | assertEq(simpleStore.read(), value, "read() returns the wrong value"); 24 | } 25 | 26 | /// @notice Test that a non-matching selector reverts 27 | function testNonMatchingSelector(bytes32 callData) public { 28 | bytes4[] memory func_selectors = new bytes4[](2); 29 | func_selectors[0] = SimpleStore.store.selector; 30 | func_selectors[1] = SimpleStore.read.selector; 31 | 32 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(simpleStore)); 33 | assert(!success); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /test/SimulateArray.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface SimulateArray { 9 | function pushh(uint256 num) external; 10 | 11 | function popp() external; 12 | 13 | function read(uint256 index) external view returns (uint256); 14 | 15 | function length() external view returns (uint256); 16 | 17 | function write(uint256 index, uint256 num) external; 18 | } 19 | 20 | contract SimulateArrayTest is Test, NonMatchingSelectorHelper { 21 | SimulateArray public simulateArray; 22 | 23 | function setUp() public { 24 | simulateArray = SimulateArray(HuffDeployer.config().deploy("SimulateArray")); 25 | } 26 | 27 | function testSimulateArray(uint256[] memory array) external { 28 | vm.expectRevert(bytes4(keccak256("ZeroArray()"))); 29 | simulateArray.popp(); 30 | 31 | assertEq(simulateArray.length(), 0, "length is initially meant to be 0"); 32 | 33 | for (uint256 i; i < array.length; ++i) { 34 | simulateArray.pushh(array[i]); 35 | assertEq(simulateArray.read(i), array[i], "Wrong value"); 36 | uint256 writeIndex = bound(array.length, 0, i); 37 | simulateArray.write(writeIndex, array[i]); 38 | assertEq(simulateArray.read(writeIndex), array[i], "Wrong value"); 39 | assertEq(simulateArray.length(), i + 1, "Wrong length"); 40 | } 41 | 42 | for (uint256 i = array.length; i > 0; --i) { 43 | simulateArray.popp(); 44 | vm.expectRevert(bytes4(keccak256("OutOfBounds()"))); 45 | simulateArray.read(i - 1); 46 | vm.expectRevert(bytes4(keccak256("OutOfBounds()"))); 47 | simulateArray.write(i - 1, array[i - 1]); 48 | assertEq(simulateArray.length(), i - 1, "Wrong length"); 49 | } 50 | 51 | vm.expectRevert(bytes4(keccak256("ZeroArray()"))); 52 | simulateArray.popp(); 53 | } 54 | 55 | /// @notice Test that a non-matching selector reverts 56 | function testNonMatchingSelector(bytes32 callData) public { 57 | bytes4[] memory func_selectors = new bytes4[](5); 58 | func_selectors[0] = SimulateArray.pushh.selector; 59 | func_selectors[1] = SimulateArray.popp.selector; 60 | func_selectors[2] = SimulateArray.read.selector; 61 | func_selectors[3] = SimulateArray.length.selector; 62 | func_selectors[4] = SimulateArray.write.selector; 63 | 64 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(simulateArray)); 65 | assert(!success); 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /test/SumArray.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface SumArray { 9 | function sumArray(uint256[] calldata nums) external pure returns (uint256); 10 | } 11 | 12 | contract SumArrayTest is Test, NonMatchingSelectorHelper { 13 | SumArray public sumArray; 14 | 15 | function setUp() public { 16 | sumArray = SumArray(HuffDeployer.config().deploy("SumArray")); 17 | } 18 | 19 | function testSumArray(uint256[] memory array) external { 20 | uint256 expected; 21 | for (uint256 i; i < array.length; ++i) { 22 | unchecked { 23 | expected += array[i]; 24 | } 25 | } 26 | 27 | uint256 sum = sumArray.sumArray(array); 28 | assertEq(sum, expected, "Wrong sum of array"); 29 | } 30 | 31 | /// @notice Test that a non-matching selector reverts 32 | function testNonMatchingSelector(bytes32 callData) public { 33 | bytes4[] memory func_selectors = new bytes4[](1); 34 | func_selectors[0] = SumArray.sumArray.selector; 35 | 36 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(sumArray)); 37 | assert(!success); 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /test/TimeAndBlock.t.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.19; 3 | 4 | import "forge-std/Test.sol"; 5 | import {HuffDeployer} from "foundry-huff/HuffDeployer.sol"; 6 | import {NonMatchingSelectorHelper} from "./test-utils/NonMatchingSelectorHelper.sol"; 7 | 8 | interface TimeAndBlock { 9 | function getTimeAndBlock() external returns (uint256, uint256); 10 | } 11 | 12 | contract TimeAndBlockTest is Test, NonMatchingSelectorHelper { 13 | TimeAndBlock public timeAndBlock; 14 | 15 | function setUp() public { 16 | timeAndBlock = TimeAndBlock(HuffDeployer.config().deploy("TimeAndBlock")); 17 | } 18 | 19 | function testTimeAndBlock(uint256 skipBlocks) external { 20 | vm.assume(skipBlocks < type(uint256).max); 21 | skip(skipBlocks); 22 | (uint256 timestamp, uint256 blockNumber) = timeAndBlock.getTimeAndBlock(); 23 | 24 | assertEq( 25 | timestamp, 26 | block.timestamp, 27 | string.concat( 28 | "The returned timestamp differs from the current: ", 29 | vm.toString(timestamp), 30 | " != ", 31 | vm.toString(block.timestamp) 32 | ) 33 | ); 34 | assertEq( 35 | blockNumber, 36 | block.number, 37 | string.concat( 38 | "The returned block number differs from the current: ", 39 | vm.toString(blockNumber), 40 | " != ", 41 | vm.toString(block.number) 42 | ) 43 | ); 44 | } 45 | 46 | /// @notice Test that a non-matching selector reverts 47 | function testNonMatchingSelector(bytes32 callData) public { 48 | bytes4[] memory func_selectors = new bytes4[](1); 49 | func_selectors[0] = TimeAndBlock.getTimeAndBlock.selector; 50 | 51 | bool success = nonMatchingSelectorHelper(func_selectors, callData, address(timeAndBlock)); 52 | assert(!success); 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /test/test-utils/NonMatchingSelectorHelper.sol: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: BUSL-1.1 2 | pragma solidity ^0.8.15; 3 | 4 | abstract contract NonMatchingSelectorHelper { 5 | /// @dev Expected to return false. 6 | function nonMatchingSelectorHelper(bytes4[] memory func_selectors, bytes32 callData, address target) 7 | internal 8 | returns (bool) 9 | { 10 | bytes4 func_selector = bytes4(callData); 11 | 12 | for (uint256 i = 0; i < func_selectors.length; i++) { 13 | if (func_selector == func_selectors[i]) { 14 | return false; 15 | } 16 | } 17 | 18 | bool success = false; 19 | assembly { 20 | mstore(0x80, callData) 21 | // if its a state changing call this will return 0 22 | success := staticcall(gas(), target, 0x80, 0x20, 0, 0) 23 | 24 | if iszero(success) { success := call(gas(), target, 0, 0x80, 0x20, 0, 0) } 25 | } 26 | return success; 27 | } 28 | } 29 | --------------------------------------------------------------------------------