diff --git a/.github/workflows/certora.yml b/.github/workflows/certora.yml new file mode 100644 index 0000000..aafc87f --- /dev/null +++ b/.github/workflows/certora.yml @@ -0,0 +1,41 @@ +name: Certora + +on: [push, pull_request] + +jobs: + certora: + name: Certora + runs-on: ubuntu-latest + strategy: + fail-fast: false + + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + submodules: recursive + + - uses: actions/setup-java@v2 + with: + distribution: 'zulu' + java-version: '11' + java-package: jre + + - name: Set up Python 3.13 + uses: actions/setup-python@v5 + with: + python-version: '3.13' + + - name: Install solc-select + run: pip3 install solc-select + + - name: Solc Select 0.8.24 + run: solc-select install 0.8.24 + + - name: Install Certora + run: pip3 install certora-cli-beta + + - name: Verify nfat + run: make certora-nfat results=1 + env: + CERTORAKEY: ${{ secrets.CERTORAKEY }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index b79c8d4..1ddebc7 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,38 +1,33 @@ -name: CI +name: test -permissions: {} - -on: - push: - pull_request: - workflow_dispatch: - -env: - FOUNDRY_PROFILE: ci +on: [push, pull_request] jobs: check: + strategy: + fail-fast: true + name: Foundry project runs-on: ubuntu-latest - permissions: - contents: read steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v3 with: - persist-credentials: false submodules: recursive - name: Install Foundry uses: foundry-rs/foundry-toolchain@v1 - - - name: Show Forge version - run: forge --version - - - name: Run Forge fmt - run: forge fmt --check + with: + version: stable - name: Run Forge build - run: forge build --sizes + run: | + forge --version + forge build --sizes + id: build - name: Run Forge tests - run: forge test -vvv + run: | + forge test -vvv + id: test + env: + ETH_RPC_URL: ${{ secrets.ETH_RPC_URL }} diff --git a/.gitignore b/.gitignore index 85198aa..8c30259 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,6 @@ docs/ # Dotenv file .env + +# Certora +.certora_internal diff --git a/.gitmodules b/.gitmodules index 888d42d..0c2405a 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,6 @@ -[submodule "lib/forge-std"] - path = lib/forge-std - url = https://github.com/foundry-rs/forge-std +[submodule "lib/dss-test"] + path = lib/dss-test + url = https://github.com/makerdao/dss-test +[submodule "lib/openzeppelin-contracts"] + path = lib/openzeppelin-contracts + url = https://github.com/OpenZeppelin/openzeppelin-contracts diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..29ebfa5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..de3bf02 --- /dev/null +++ b/Makefile @@ -0,0 +1,2 @@ +PATH := ~/.solc-select/artifacts/:~/.solc-select/artifacts/solc-0.8.24:$(PATH) +certora-nfat :; PATH=${PATH} certoraRun certora/NFATFacility.conf$(if $(rule), --rule $(rule),)$(if $(results), --wait_for_results all,) diff --git a/README.md b/README.md index e69de29..8401c07 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,15 @@ +# NFAT Facility + +An NFAT Facility manages bespoke capital deployment deals between depositors (Primes) and borrowers (Halos). + +- **Subscribe**: Depositors queue an asset (e.g. sUSDS) into the facility. +- **Withdraw**: Depositors can at any time withdraw queued funds not yet deployed. +- **Issue**: The operator deploys queued capital to the borrower and mints an ERC-721 Non-Fungible Allocation Token (NFAT) to the depositor, representing their claim on future repayments. +- **Repay**: The borrower repays into the facility against a given NFAT. +- **Collect**: The NFAT holder collects repayments (principal and interest). + +Deal terms (APY, maturity, payment frequency, etc) are tracked off-chain; the contract handles only capital flows. + +## Assumptions + +It is assumed that only simple, regular ERC-20 tokens will be used as `gem`. In particular, the supported tokens are assumed to revert on failure (instead of returning false), not to execute any hook or apply any fee on transfer, and not to execute any rebasing logic. diff --git a/certora/NFATFacility.conf b/certora/NFATFacility.conf new file mode 100644 index 0000000..bd90c2a --- /dev/null +++ b/certora/NFATFacility.conf @@ -0,0 +1,19 @@ +{ + "files": [ + "src/NFATFacility.sol", + "certora/harness/GemMock.sol", + "certora/harness/IdentityNetworkMock.sol" + ], + "verify": "NFATFacility:certora/NFATFacility.spec", + "link": ["NFATFacility:gem=GemMock"], + "solc": "solc-0.8.24", + "solc_evm_version": "cancun", + "packages": ["openzeppelin-contracts=lib/openzeppelin-contracts"], + "optimistic_loop": true, + "loop_iter": 3, + "rule_sanity": "basic", + "multi_assert_check": true, + "optimistic_hashing": true, + "parametric_contracts": ["NFATFacility"], + "msg": "NFATFacility" +} diff --git a/certora/NFATFacility.spec b/certora/NFATFacility.spec new file mode 100644 index 0000000..0d7aca2 --- /dev/null +++ b/certora/NFATFacility.spec @@ -0,0 +1,1014 @@ +// NFATFacility.spec — Certora formal verification specification + +using GemMock as gem; +using IdentityNetworkMock as identityNetwork; + +methods { + function wards(address) external returns (uint256) envfree; + function buds(address) external returns (uint256) envfree; + function cops(address) external returns (uint256) envfree; + function deposits(address) external returns (uint256) envfree; + function collectable(uint256) external returns (uint256) envfree; + function recipient() external returns (address) envfree; + function identityNetwork() external returns (address) envfree; + function stopped() external returns (bool) envfree; + function baseURI() external returns (string) envfree; + function balanceOf(address) external returns (uint256) envfree; + function ownerOf(uint256) external returns (address) envfree; + function getApproved(uint256) external returns (address) envfree; + function isApprovedForAll(address, address) external returns (bool) envfree; + // + function gem.totalSupply() external returns (uint256) envfree; + function gem.balanceOf(address) external returns (uint256) envfree; + function gem.allowance(address, address) external returns (uint256) envfree; + function identityNetwork.isMember(address) external returns (bool) envfree; + // + function _.isMember(address) external => DISPATCHER(true); + function _.transfer(address, uint256) external => DISPATCHER(true); + function _.transferFrom(address, address, uint256) external => DISPATCHER(true); + function _.onERC721Received(address, address, uint256, bytes) external => onERC721ReceivedSummary() expect (bytes4); +} + +definition RECIPIENT_KEY() returns bytes32 = to_bytes32(0x726563697069656e740000000000000000000000000000000000000000000000); +definition IDENTITY_NETWORK_KEY() returns bytes32 = to_bytes32(0x6964656e746974794e6574776f726b0000000000000000000000000000000000); +definition BASE_URI_KEY() returns bytes32 = to_bytes32(0x6261736555524900000000000000000000000000000000000000000000000000); + +persistent ghost bytes4 onERC721ReceivedRetVal; +function onERC721ReceivedSummary() returns (bytes4) { + return onERC721ReceivedRetVal; +} + +ghost mathint sumDeposits { + init_state axiom sumDeposits == 0; +} + +ghost mathint sumCollectable { + init_state axiom sumCollectable == 0; +} + +hook Sstore deposits[KEY address usr] uint256 newVal (uint256 oldVal) { + sumDeposits = sumDeposits + newVal - oldVal; + require sumDeposits >= 0; +} + +hook Sload uint256 val deposits[KEY address usr] { + require sumDeposits >= val; +} + +hook Sstore collectable[KEY uint256 tokenId] uint256 newVal (uint256 oldVal) { + sumCollectable = sumCollectable + newVal - oldVal; + require sumCollectable >= 0; +} + +hook Sload uint256 val collectable[KEY uint256 tokenId] { + require sumCollectable >= val; +} + +invariant wardsIsBinary(address usr) + wards(usr) == 0 || wards(usr) == 1; + +invariant budsIsBinary(address usr) + buds(usr) == 0 || buds(usr) == 1; + +invariant copsIsBinary(address usr) + cops(usr) == 0 || cops(usr) == 1; + +// Solvency invariant preserved by non-rescue functions +rule gemBalanceCoversObligations(method f) + filtered { + f -> !f.isView && + f.selector != sig:rescue(address,address,uint256).selector + } +{ + env e; + calldataarg args; + + require e.msg.sender != currentContract; + + require gem.balanceOf(currentContract) >= sumDeposits + sumCollectable; + + f(e, args); + + assert gem.balanceOf(currentContract) >= sumDeposits + sumCollectable, "Assert 1"; +} + +// approved/approvedForAll users cannot collect +rule collectIsOwnerOnly(uint256 tokenId, uint256 amount) { + env e; + + address owner = currentContract._owners[tokenId]; + require owner != 0; + require e.msg.sender != owner; + + collect@withrevert(e, tokenId, amount); + + // Must revert if caller is not the owner, regardless of approval status + assert lastReverted, "Assert 1"; +} + +// depositors can always exit +rule withdrawWorksWhenStopped(uint256 amount) { + env e; + + require e.msg.value == 0; + require stopped() == true; + require amount > 0; + require deposits(e.msg.sender) >= amount; + + // Ensure gem has sufficient balance and the contract is not the sender + require gem.balanceOf(currentContract) >= amount; + require gem.totalSupply() >= gem.balanceOf(currentContract) + gem.balanceOf(e.msg.sender); + require e.msg.sender != currentContract; + + withdraw@withrevert(e, amount); + + assert !lastReverted, "Assert 1"; +} + +// ERC721 transfer preserves financial state +rule transferDoesNotAffectFunds(address from, address to, uint256 tokenId) { + env e; + + mathint depositsFrom = deposits(from); + mathint depositsTo = deposits(to); + mathint collectableTokenId = collectable(tokenId); + + transferFrom(e, from, to, tokenId); + + assert deposits(from) == depositsFrom, "Assert 1"; + assert deposits(to) == depositsTo, "Assert 2"; + assert collectable(tokenId) == collectableTokenId, "Assert 3"; +} + +rule storageAffected(method f) { + env e; + + address anyAddr; + address anyAddr2; + uint256 anyUint256; + + mathint wardsBefore = wards(anyAddr); + mathint budsBefore = buds(anyAddr); + mathint copsBefore = cops(anyAddr); + mathint depositsBefore = deposits(anyAddr); + mathint collectableBefore = collectable(anyUint256); + address recipientBefore = recipient(); + address identityNetworkBefore = identityNetwork(); + bool stoppedBefore = stopped(); + mathint balanceOfBefore = balanceOf(anyAddr); + address ownerOfBefore = currentContract._owners[anyUint256]; + address tokenApprovalBefore = getApproved(anyUint256); + bool operatorApprovalBefore = isApprovedForAll(anyAddr, anyAddr2); + + calldataarg args; + f(e, args); + + mathint wardsAfter = wards(anyAddr); + mathint budsAfter = buds(anyAddr); + mathint copsAfter = cops(anyAddr); + mathint depositsAfter = deposits(anyAddr); + mathint collectableAfter = collectable(anyUint256); + address recipientAfter = recipient(); + address identityNetworkAfter = identityNetwork(); + bool stoppedAfter = stopped(); + mathint balanceOfAfter = balanceOf(anyAddr); + address ownerOfAfter = currentContract._owners[anyUint256]; + address tokenApprovalAfter = getApproved(anyUint256); + bool operatorApprovalAfter = isApprovedForAll(anyAddr, anyAddr2); + + assert wardsAfter != wardsBefore => + f.selector == sig:rely(address).selector || + f.selector == sig:deny(address).selector, "Assert 1"; + assert budsAfter != budsBefore => + f.selector == sig:kiss(address).selector || + f.selector == sig:diss(address).selector, "Assert 2"; + assert copsAfter != copsBefore => + f.selector == sig:addFreezer(address).selector || + f.selector == sig:removeFreezer(address).selector, "Assert 3"; + assert depositsAfter != depositsBefore => + f.selector == sig:subscribe(uint256,bytes).selector || + f.selector == sig:withdraw(uint256).selector || + f.selector == sig:issue(address,uint256,uint256).selector || + f.selector == sig:rescueDeposit(address,address,uint256).selector, "Assert 4"; + assert collectableAfter != collectableBefore => + f.selector == sig:repay(uint256,uint256).selector || + f.selector == sig:collect(uint256,uint256).selector || + f.selector == sig:rescueCollectable(uint256,address,uint256).selector, "Assert 5"; + assert recipientAfter != recipientBefore => + f.selector == sig:file(bytes32,address).selector, "Assert 6"; + assert identityNetworkAfter != identityNetworkBefore => + f.selector == sig:file(bytes32,address).selector, "Assert 7"; + assert stoppedAfter != stoppedBefore => + f.selector == sig:stop().selector || + f.selector == sig:start().selector, "Assert 8"; + assert balanceOfAfter != balanceOfBefore => + f.selector == sig:issue(address,uint256,uint256).selector || + f.selector == sig:transferFrom(address,address,uint256).selector || + f.selector == sig:safeTransferFrom(address,address,uint256).selector || + f.selector == sig:safeTransferFrom(address,address,uint256,bytes).selector, "Assert 9"; + assert ownerOfAfter != ownerOfBefore => + f.selector == sig:issue(address,uint256,uint256).selector || + f.selector == sig:transferFrom(address,address,uint256).selector || + f.selector == sig:safeTransferFrom(address,address,uint256).selector || + f.selector == sig:safeTransferFrom(address,address,uint256,bytes).selector, "Assert 10"; + assert tokenApprovalAfter != tokenApprovalBefore => + f.selector == sig:approve(address,uint256).selector || + f.selector == sig:issue(address,uint256,uint256).selector || + f.selector == sig:transferFrom(address,address,uint256).selector || + f.selector == sig:safeTransferFrom(address,address,uint256).selector || + f.selector == sig:safeTransferFrom(address,address,uint256,bytes).selector, "Assert 11"; + assert operatorApprovalAfter != operatorApprovalBefore => + f.selector == sig:setApprovalForAll(address,bool).selector, "Assert 12"; +} + +rule rely(address usr) { + env e; + + rely(e, usr); + + assert wards(usr) == 1, "Assert 1"; +} + +rule rely_revert(address usr) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + rely@withrevert(e, usr); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule deny(address usr) { + env e; + + deny(e, usr); + + assert wards(usr) == 0, "Assert 1"; +} + +rule deny_revert(address usr) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + deny@withrevert(e, usr); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule kiss(address usr) { + env e; + + kiss(e, usr); + + assert buds(usr) == 1, "Assert 1"; +} + +rule kiss_revert(address usr) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + kiss@withrevert(e, usr); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule diss(address usr) { + env e; + + diss(e, usr); + + assert buds(usr) == 0, "Assert 1"; +} + +rule diss_revert(address usr) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + diss@withrevert(e, usr); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule addFreezer(address usr) { + env e; + + addFreezer(e, usr); + + assert cops(usr) == 1, "Assert 1"; +} + +rule addFreezer_revert(address usr) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + addFreezer@withrevert(e, usr); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule removeFreezer(address usr) { + env e; + + removeFreezer(e, usr); + + assert cops(usr) == 0, "Assert 1"; +} + +rule removeFreezer_revert(address usr) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + removeFreezer@withrevert(e, usr); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule stop() { + env e; + + stop(e); + + assert stopped(), "Assert 1"; +} + +rule stop_revert() { + env e; + + mathint copsSender = cops(e.msg.sender); + + stop@withrevert(e); + + bool revert1 = e.msg.value > 0; + bool revert2 = copsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule start() { + env e; + + start(e); + + assert !stopped(), "Assert 1"; +} + +rule start_revert() { + env e; + + mathint wardsSender = wards(e.msg.sender); + + start@withrevert(e); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule file_address(bytes32 what, address data) { + env e; + + address recipientBefore = recipient(); + address identityNetworkBefore = identityNetwork(); + + file(e, what, data); + + assert what == RECIPIENT_KEY() => recipient() == data, "Assert 1"; + assert what != RECIPIENT_KEY() => recipient() == recipientBefore, "Assert 2"; + assert what == IDENTITY_NETWORK_KEY() => identityNetwork() == data, "Assert 3"; + assert what != IDENTITY_NETWORK_KEY() => identityNetwork() == identityNetworkBefore, "Assert 4"; +} + +rule file_address_revert(bytes32 what, address data) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + file@withrevert(e, what, data); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + bool revert3 = what != RECIPIENT_KEY() && what != IDENTITY_NETWORK_KEY(); + + assert lastReverted <=> revert1 || revert2 || revert3, "Revert rules failed"; +} + +rule file_string(bytes32 what, string data) { + env e; + + file(e, what, data); + + assert baseURI() == data, "Assert 1"; +} + +rule file_string_revert(bytes32 what, string data) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + baseURI(); // avoid exiting malformed string revert path + file@withrevert(e, what, data); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + bool revert3 = what != BASE_URI_KEY(); + + assert lastReverted <=> revert1 || revert2 || revert3, "Revert rules failed"; +} + +rule rescue(address token, address to, uint256 amount) { + env e; + + address anyUsr; + uint256 anyTokenId; + mathint depositsAnyBefore = deposits(anyUsr); + mathint collectableAnyBefore = collectable(anyTokenId); + + require token == gem; + mathint gemBalanceOfToBefore = gem.balanceOf(to); + mathint gemBalanceOfContractBefore = gem.balanceOf(currentContract); + + rescue(e, token, to, amount); + + assert deposits(anyUsr) == depositsAnyBefore, "Assert 1"; + assert collectable(anyTokenId) == collectableAnyBefore, "Assert 2"; + assert to != currentContract => gem.balanceOf(to) == gemBalanceOfToBefore + amount, "Assert 3"; + assert to != currentContract => gem.balanceOf(currentContract) == gemBalanceOfContractBefore - amount, "Assert 4"; +} + +rule rescue_revert(address token, address to, uint256 amount) { + env e; + + mathint wardsSender = wards(e.msg.sender); + + require token == gem; + require gem.balanceOf(currentContract) >= amount; + require gem.balanceOf(to) + amount <= max_uint256; + + rescue@withrevert(e, token, to, amount); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} + +rule rescueDeposit(address depositor, address to, uint256 amount) { + env e; + + address otherUsr; + require otherUsr != depositor; + + mathint depositsDepositorBefore = deposits(depositor); + mathint depositsOtherBefore = deposits(otherUsr); + mathint gemBalanceOfToBefore = gem.balanceOf(to); + mathint gemBalanceOfContractBefore = gem.balanceOf(currentContract); + + rescueDeposit(e, depositor, to, amount); + + assert deposits(depositor) == depositsDepositorBefore - amount, "Assert 1"; + assert deposits(otherUsr) == depositsOtherBefore, "Assert 2"; + assert to != currentContract => gem.balanceOf(to) == gemBalanceOfToBefore + amount, "Assert 3"; + assert to != currentContract => gem.balanceOf(currentContract) == gemBalanceOfContractBefore - amount, "Assert 4"; +} + +rule rescueDeposit_revert(address depositor, address to, uint256 amount) { + env e; + + mathint wardsSender = wards(e.msg.sender); + uint256 depositsDepositor = deposits(depositor); + + require gem.balanceOf(currentContract) >= amount; + require gem.balanceOf(to) + amount <= max_uint256; + + rescueDeposit@withrevert(e, depositor, to, amount); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + bool revert3 = depositsDepositor < amount; + + assert lastReverted <=> revert1 || revert2 || revert3, "Revert rules failed"; +} + +rule rescueCollectable(uint256 tokenId, address to, uint256 amount) { + env e; + + uint256 otherTokenId; + require otherTokenId != tokenId; + + mathint collectableTokenIdBefore = collectable(tokenId); + mathint collectableOtherBefore = collectable(otherTokenId); + mathint gemBalanceOfToBefore = gem.balanceOf(to); + mathint gemBalanceOfContractBefore = gem.balanceOf(currentContract); + + rescueCollectable(e, tokenId, to, amount); + + assert collectable(tokenId) == collectableTokenIdBefore - amount, "Assert 1"; + assert collectable(otherTokenId) == collectableOtherBefore, "Assert 2"; + assert to != currentContract => gem.balanceOf(to) == gemBalanceOfToBefore + amount, "Assert 3"; + assert to != currentContract => gem.balanceOf(currentContract) == gemBalanceOfContractBefore - amount, "Assert 4"; +} + +rule rescueCollectable_revert(uint256 tokenId, address to, uint256 amount) { + env e; + + mathint wardsSender = wards(e.msg.sender); + mathint collectableTokenId = collectable(tokenId); + + require gem.balanceOf(currentContract) >= amount; + require gem.balanceOf(to) + amount <= max_uint256; + + rescueCollectable@withrevert(e, tokenId, to, amount); + + bool revert1 = e.msg.value > 0; + bool revert2 = wardsSender != 1; + bool revert3 = collectableTokenId < amount; + + assert lastReverted <=> revert1 || revert2 || revert3, "Revert rules failed"; +} + +rule subscribe(uint256 amount, bytes data) { + env e; + + require e.msg.sender != currentContract; + + mathint depositsSenderBefore = deposits(e.msg.sender); + mathint gemBalanceOfSenderBefore = gem.balanceOf(e.msg.sender); + mathint gemBalanceOfContractBefore = gem.balanceOf(currentContract); + + subscribe(e, amount, data); + + assert deposits(e.msg.sender) == depositsSenderBefore + amount, "Assert 1"; + assert gem.balanceOf(e.msg.sender) == gemBalanceOfSenderBefore - amount, "Assert 2"; + assert gem.balanceOf(currentContract) == gemBalanceOfContractBefore + amount, "Assert 3"; +} + +rule subscribe_revert(uint256 amount, bytes data) { + env e; + + bool stopped = stopped(); + + require gem.balanceOf(e.msg.sender) >= amount; + require gem.allowance(e.msg.sender, currentContract) >= amount; + require gem.balanceOf(currentContract) + amount <= max_uint256; + + mathint depositsSender = deposits(e.msg.sender); + + subscribe@withrevert(e, amount, data); + + bool revert1 = e.msg.value > 0; + bool revert2 = stopped; + bool revert3 = depositsSender + amount > max_uint256; + + assert lastReverted <=> revert1 || revert2 || revert3, "Revert rules failed"; +} + +rule withdraw(uint256 amount) { + env e; + + require e.msg.sender != currentContract; + + mathint depositsSenderBefore = deposits(e.msg.sender); + mathint gemBalanceOfSenderBefore = gem.balanceOf(e.msg.sender); + mathint gemBalanceOfContractBefore = gem.balanceOf(currentContract); + + withdraw(e, amount); + + assert deposits(e.msg.sender) == depositsSenderBefore - amount, "Assert 1"; + assert gem.balanceOf(e.msg.sender) == gemBalanceOfSenderBefore + amount, "Assert 2"; + assert gem.balanceOf(currentContract) == gemBalanceOfContractBefore - amount, "Assert 3"; +} + +rule withdraw_revert(uint256 amount) { + env e; + + mathint depositsSender = deposits(e.msg.sender); + + require gem.balanceOf(currentContract) >= amount; + require gem.balanceOf(e.msg.sender) + amount <= max_uint256; + + withdraw@withrevert(e, amount); + + bool revert1 = e.msg.value > 0; + bool revert2 = amount == 0; + bool revert3 = depositsSender < amount; + + assert lastReverted <=> revert1 || revert2 || revert3, "Revert rules failed"; +} + +rule issue(address to, uint256 tokenId, uint256 amount) { + env e; + + mathint depositsToBefore = deposits(to); + address recipient = recipient(); + mathint gemBalanceOfRecipientBefore = gem.balanceOf(recipient); + mathint gemBalanceOfContractBefore = gem.balanceOf(currentContract); + + require recipient != currentContract; + + issue(e, to, tokenId, amount); + + assert deposits(to) == depositsToBefore - amount, "Assert 1"; + assert currentContract._owners[tokenId] == to, "Assert 2"; + assert gem.balanceOf(recipient) == gemBalanceOfRecipientBefore + amount, "Assert 3"; + assert gem.balanceOf(currentContract) == gemBalanceOfContractBefore - amount, "Assert 4"; +} + +rule issue_revert(address to, uint256 tokenId, uint256 amount) { + env e; + + require identityNetwork() == identityNetwork; + + uint256 budsSender = buds(e.msg.sender); + bool stopped = stopped(); + uint256 depositsTo = deposits(to); + address owner = currentContract._owners[tokenId]; + bool isMemberTo = identityNetwork.isMember(to); + + require gem.balanceOf(currentContract) >= amount; + require gem.balanceOf(recipient()) + amount <= max_uint256; + require balanceOf(to) + 1 <= max_uint256; + + issue@withrevert(e, to, tokenId, amount); + + bool revert1 = e.msg.value > 0; + bool revert2 = budsSender != 1; + bool revert3 = stopped; + bool revert4 = tokenId == 0; + bool revert5 = depositsTo < amount; + bool revert6 = owner != 0; + bool revert7 = to == 0; + bool revert8 = identityNetwork != 0 && !isMemberTo; + + assert lastReverted <=> revert1 || revert2 || revert3 || + revert4 || revert5 || revert6 || + revert7 || revert8, "Revert rules failed"; +} + +rule repay(uint256 tokenId, uint256 amount) { + env e; + + require e.msg.sender != currentContract; + + mathint collectableTokenIdBefore = collectable(tokenId); + mathint gemBalanceOfSenderBefore = gem.balanceOf(e.msg.sender); + mathint gemBalanceOfContractBefore = gem.balanceOf(currentContract); + + repay(e, tokenId, amount); + + assert collectable(tokenId) == collectableTokenIdBefore + amount, "Assert 1"; + assert gem.balanceOf(e.msg.sender) == gemBalanceOfSenderBefore - amount, "Assert 2"; + assert gem.balanceOf(currentContract) == gemBalanceOfContractBefore + amount, "Assert 3"; +} + +rule repay_revert(uint256 tokenId, uint256 amount) { + env e; + + bool stopped = stopped(); + address owner = currentContract._owners[tokenId]; + mathint collectableTokenId = collectable(tokenId); + + require gem.balanceOf(e.msg.sender) >= amount; + require gem.allowance(e.msg.sender, currentContract) >= amount; + require gem.balanceOf(currentContract) + amount <= max_uint256; + + repay@withrevert(e, tokenId, amount); + + bool revert1 = e.msg.value > 0; + bool revert2 = stopped; + bool revert3 = amount == 0; + bool revert4 = owner == 0; + bool revert5 = collectableTokenId + amount > max_uint256; + + assert lastReverted <=> revert1 || revert2 || revert3 || + revert4 || revert5, "Revert rules failed"; +} + +rule collect(uint256 tokenId, uint256 amount) { + env e; + + require e.msg.sender != currentContract; + + mathint collectableTokenIdBefore = collectable(tokenId); + mathint gemBalanceOfSenderBefore = gem.balanceOf(e.msg.sender); + mathint gemBalanceOfContractBefore = gem.balanceOf(currentContract); + + collect(e, tokenId, amount); + + assert collectable(tokenId) == collectableTokenIdBefore - amount, "Assert 1"; + assert gem.balanceOf(e.msg.sender) == gemBalanceOfSenderBefore + amount, "Assert 2"; + assert gem.balanceOf(currentContract) == gemBalanceOfContractBefore - amount, "Assert 3"; +} + +rule collect_revert(uint256 tokenId, uint256 amount) { + env e; + + require identityNetwork() == identityNetwork; + + bool stopped = stopped(); + mathint collectableTokenId = collectable(tokenId); + address owner = currentContract._owners[tokenId]; + bool isMemberSender = identityNetwork.isMember(e.msg.sender); + + require gem.balanceOf(currentContract) >= amount; + require gem.balanceOf(e.msg.sender) + amount <= max_uint256; + + collect@withrevert(e, tokenId, amount); + + bool revert1 = e.msg.value > 0; + bool revert2 = stopped; + bool revert3 = amount == 0; + bool revert4 = collectableTokenId < amount; + bool revert5 = e.msg.sender != owner; + bool revert6 = identityNetwork != 0 && !isMemberSender; + + assert lastReverted <=> revert1 || revert2 || revert3 || + revert4 || revert5 || revert6, "Revert rules failed"; +} + +rule transferFrom(address from, address to, uint256 tokenId) { + env e; + + address other; + require other != from && other != to; + uint256 otherTokenId; + require otherTokenId != tokenId; + + mathint balanceOfFromBefore = balanceOf(from); + mathint balanceOfToBefore = balanceOf(to); + mathint balanceOfOtherBefore = balanceOf(other); + address ownerOfOtherBefore = currentContract._owners[otherTokenId]; + address approvalOtherBefore = getApproved(otherTokenId); + + require balanceOfFromBefore >= 1; + require from != to => balanceOfToBefore <= max_uint256 - 1; + + transferFrom(e, from, to, tokenId); + + mathint balanceOfFromAfter = balanceOf(from); + mathint balanceOfToAfter = balanceOf(to); + mathint balanceOfOtherAfter = balanceOf(other); + address ownerOfTokenIdAfter = currentContract._owners[tokenId]; + address ownerOfOtherAfter = currentContract._owners[otherTokenId]; + address approvalTokenIdAfter = getApproved(tokenId); + address approvalOtherAfter = getApproved(otherTokenId); + + assert from != to => balanceOfFromAfter == balanceOfFromBefore - 1, "Assert 1"; + assert from != to => balanceOfToAfter == balanceOfToBefore + 1, "Assert 2"; + assert from == to => balanceOfFromAfter == balanceOfFromBefore, "Assert 3"; + assert balanceOfOtherAfter == balanceOfOtherBefore, "Assert 4"; + assert ownerOfTokenIdAfter == to, "Assert 5"; + assert ownerOfOtherAfter == ownerOfOtherBefore, "Assert 6"; + assert approvalTokenIdAfter == 0, "Assert 7"; + assert approvalOtherAfter == approvalOtherBefore, "Assert 8"; +} + +rule transferFrom_revert(address from, address to, uint256 tokenId) { + env e; + + require e.msg.sender != 0; + require identityNetwork() == identityNetwork; + + address owner = currentContract._owners[tokenId]; + address approved = getApproved(tokenId); + bool isOperator = isApprovedForAll(owner, e.msg.sender); + bool isMemberTo = identityNetwork.isMember(to); + + require balanceOf(to) + 1 <= max_uint256; + + transferFrom@withrevert(e, from, to, tokenId); + + bool revert1 = e.msg.value > 0; + bool revert2 = owner == 0; + bool revert3 = owner != from; + bool revert4 = to == 0; + bool revert5 = e.msg.sender != owner && e.msg.sender != approved && !isOperator; + bool revert6 = identityNetwork != 0 && !isMemberTo; + + assert lastReverted <=> revert1 || revert2 || revert3 || + revert4 || revert5 || revert6, "Revert rules failed"; +} + +rule safeTransferFrom(address from, address to, uint256 tokenId) { + env e; + + address other; + require other != from && other != to; + uint256 otherTokenId; + require otherTokenId != tokenId; + + mathint balanceOfFromBefore = balanceOf(from); + mathint balanceOfToBefore = balanceOf(to); + mathint balanceOfOtherBefore = balanceOf(other); + address ownerOfOtherBefore = currentContract._owners[otherTokenId]; + address approvalOtherBefore = getApproved(otherTokenId); + + require balanceOfFromBefore >= 1; + require from != to => balanceOfToBefore <= max_uint256 - 1; + + safeTransferFrom(e, from, to, tokenId); + + mathint balanceOfFromAfter = balanceOf(from); + mathint balanceOfToAfter = balanceOf(to); + mathint balanceOfOtherAfter = balanceOf(other); + address ownerOfTokenIdAfter = currentContract._owners[tokenId]; + address ownerOfOtherAfter = currentContract._owners[otherTokenId]; + address approvalTokenIdAfter = getApproved(tokenId); + address approvalOtherAfter = getApproved(otherTokenId); + + assert from != to => balanceOfFromAfter == balanceOfFromBefore - 1, "Assert 1"; + assert from != to => balanceOfToAfter == balanceOfToBefore + 1, "Assert 2"; + assert from == to => balanceOfFromAfter == balanceOfFromBefore, "Assert 3"; + assert balanceOfOtherAfter == balanceOfOtherBefore, "Assert 4"; + assert ownerOfTokenIdAfter == to, "Assert 5"; + assert ownerOfOtherAfter == ownerOfOtherBefore, "Assert 6"; + assert approvalTokenIdAfter == 0, "Assert 7"; + assert approvalOtherAfter == approvalOtherBefore, "Assert 8"; +} + +persistent ghost address to_; +persistent ghost uint256 toCodesize; +hook EXTCODESIZE(address addr) uint256 size { + if (addr == to_) { + toCodesize = size; + } +} + +rule safeTransferFrom_revert(address from, address to, uint256 tokenId) { + env e; + + require e.msg.sender != 0; + require identityNetwork() == identityNetwork; + + address owner = currentContract._owners[tokenId]; + address approved = getApproved(tokenId); + bool isOperator = isApprovedForAll(owner, e.msg.sender); + bool isMemberTo = identityNetwork.isMember(to); + + to_ = to; + + safeTransferFrom@withrevert(e, from, to, tokenId); + + bool revert1 = e.msg.value > 0; + bool revert2 = owner == 0; + bool revert3 = owner != from; + bool revert4 = to == 0; + bool revert5 = e.msg.sender != owner && e.msg.sender != approved && !isOperator; + bool revert6 = identityNetwork != 0 && !isMemberTo; + bool revert7 = toCodesize > 0 && onERC721ReceivedRetVal != to_bytes4(0x150b7a02); + + assert lastReverted <=> revert1 || revert2 || revert3 || + revert4 || revert5 || revert6 || + revert7, "Revert rules failed"; +} + +rule safeTransferFromWithData(address from, address to, uint256 tokenId, bytes data) { + env e; + + address other; + require other != from && other != to; + uint256 otherTokenId; + require otherTokenId != tokenId; + + mathint balanceOfFromBefore = balanceOf(from); + mathint balanceOfToBefore = balanceOf(to); + mathint balanceOfOtherBefore = balanceOf(other); + address ownerOfOtherBefore = currentContract._owners[otherTokenId]; + address approvalOtherBefore = getApproved(otherTokenId); + + require balanceOfFromBefore >= 1; + require from != to => balanceOfToBefore <= max_uint256 - 1; + + safeTransferFrom(e, from, to, tokenId, data); + + mathint balanceOfFromAfter = balanceOf(from); + mathint balanceOfToAfter = balanceOf(to); + mathint balanceOfOtherAfter = balanceOf(other); + address ownerOfTokenIdAfter = currentContract._owners[tokenId]; + address ownerOfOtherAfter = currentContract._owners[otherTokenId]; + address approvalTokenIdAfter = getApproved(tokenId); + address approvalOtherAfter = getApproved(otherTokenId); + + assert from != to => balanceOfFromAfter == balanceOfFromBefore - 1, "Assert 1"; + assert from != to => balanceOfToAfter == balanceOfToBefore + 1, "Assert 2"; + assert from == to => balanceOfFromAfter == balanceOfFromBefore, "Assert 3"; + assert balanceOfOtherAfter == balanceOfOtherBefore, "Assert 4"; + assert ownerOfTokenIdAfter == to, "Assert 5"; + assert ownerOfOtherAfter == ownerOfOtherBefore, "Assert 6"; + assert approvalTokenIdAfter == 0, "Assert 7"; + assert approvalOtherAfter == approvalOtherBefore, "Assert 8"; +} + +rule safeTransferFromWithData_revert(address from, address to, uint256 tokenId, bytes data) { + env e; + + require e.msg.sender != 0; + require identityNetwork() == identityNetwork; + + address owner = currentContract._owners[tokenId]; + address approved = getApproved(tokenId); + bool isOperator = isApprovedForAll(owner, e.msg.sender); + bool isMemberTo = identityNetwork.isMember(to); + + to_ = to; + + safeTransferFrom@withrevert(e, from, to, tokenId, data); + + bool revert1 = e.msg.value > 0; + bool revert2 = owner == 0; + bool revert3 = owner != from; + bool revert4 = to == 0; + bool revert5 = e.msg.sender != owner && e.msg.sender != approved && !isOperator; + bool revert6 = identityNetwork != 0 && !isMemberTo; + bool revert7 = toCodesize > 0 && onERC721ReceivedRetVal != to_bytes4(0x150b7a02); + + assert lastReverted <=> revert1 || revert2 || revert3 || + revert4 || revert5 || revert6 || + revert7, "Revert rules failed"; +} + +rule approve(address to, uint256 tokenId) { + env e; + + uint256 otherTokenId; + require otherTokenId != tokenId; + + address approvalOtherBefore = getApproved(otherTokenId); + + approve(e, to, tokenId); + + address approvalTokenIdAfter = getApproved(tokenId); + address approvalOtherAfter = getApproved(otherTokenId); + + assert approvalTokenIdAfter == to, "Assert 1"; + assert approvalOtherAfter == approvalOtherBefore, "Assert 2"; +} + +rule approve_revert(address to, uint256 tokenId) { + env e; + + require e.msg.sender != 0; + + address owner = currentContract._owners[tokenId]; + bool isOperator = isApprovedForAll(owner, e.msg.sender); + + approve@withrevert(e, to, tokenId); + + bool revert1 = e.msg.value > 0; + bool revert2 = owner == 0; + bool revert3 = e.msg.sender != owner && !isOperator; + + assert lastReverted <=> revert1 || revert2 || revert3, "Revert rules failed"; +} + +rule setApprovalForAll(address operator, bool approved) { + env e; + + address otherOwner; address otherOperator; + require otherOwner != e.msg.sender || otherOperator != operator; + + bool approvalOtherBefore = isApprovedForAll(otherOwner, otherOperator); + + setApprovalForAll(e, operator, approved); + + bool approvalOperatorAfter = isApprovedForAll(e.msg.sender, operator); + bool approvalOtherAfter = isApprovedForAll(otherOwner, otherOperator); + + assert approvalOperatorAfter == approved, "Assert 1"; + assert approvalOtherAfter == approvalOtherBefore, "Assert 2"; +} + +rule setApprovalForAll_revert(address operator, bool approved) { + env e; + + setApprovalForAll@withrevert(e, operator, approved); + + bool revert1 = e.msg.value > 0; + bool revert2 = operator == 0; + + assert lastReverted <=> revert1 || revert2, "Revert rules failed"; +} diff --git a/certora/harness/GemMock.sol b/certora/harness/GemMock.sol new file mode 100644 index 0000000..b81d6cd --- /dev/null +++ b/certora/harness/GemMock.sol @@ -0,0 +1,29 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later +pragma solidity ^0.8.24; + +contract GemMock { + mapping(address => uint256) public balanceOf; + mapping(address => mapping(address => uint256)) public allowance; + uint256 public totalSupply; + + function transfer(address to, uint256 amount) external { + require(balanceOf[msg.sender] >= amount, "GemMock/insufficient-balance"); + unchecked { balanceOf[msg.sender] -= amount; } + balanceOf[to] += amount; + } + + function transferFrom(address from, address to, uint256 amount) external { + require(balanceOf[from] >= amount, "GemMock/insufficient-balance"); + require(allowance[from][msg.sender] >= amount, "GemMock/insufficient-allowance"); + unchecked { + balanceOf[from] -= amount; + allowance[from][msg.sender] -= amount; + } + balanceOf[to] += amount; + } + + function approve(address spender, uint256 amount) external returns (bool) { + allowance[msg.sender][spender] = amount; + return true; + } +} diff --git a/certora/harness/IdentityNetworkMock.sol b/certora/harness/IdentityNetworkMock.sol new file mode 100644 index 0000000..8caa780 --- /dev/null +++ b/certora/harness/IdentityNetworkMock.sol @@ -0,0 +1,10 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later +pragma solidity ^0.8.24; + +contract IdentityNetworkMock { + mapping(address => bool) public members; + + function isMember(address usr) external view returns (bool) { + return members[usr]; + } +} diff --git a/deploy/NFATDeploy.sol b/deploy/NFATDeploy.sol new file mode 100644 index 0000000..9e0b984 --- /dev/null +++ b/deploy/NFATDeploy.sol @@ -0,0 +1,36 @@ +// SPDX-FileCopyrightText: © 2026 Dai Foundation +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +pragma solidity ^0.8.24; + +import "dss-interfaces/Interfaces.sol"; +import { ScriptTools } from "dss-test/ScriptTools.sol"; +import { NFATFacility } from "src/NFATFacility.sol"; + +library NFATDeploy { + + function deploy( + address deployer, + address owner, + string memory name, + string memory symbol + ) internal returns (address facility) { + ChainlogAbstract chainlog = ChainlogAbstract(0xdA0Ab1e0017DEbCd72Be8599041a2aa3bA7e740F); + + facility = address(new NFATFacility(chainlog.getAddress("SUSDS"), name, symbol)); + ScriptTools.switchOwner(facility, deployer, owner); + } +} diff --git a/deploy/NFATInit.sol b/deploy/NFATInit.sol new file mode 100644 index 0000000..8b0b151 --- /dev/null +++ b/deploy/NFATInit.sol @@ -0,0 +1,68 @@ +// SPDX-FileCopyrightText: © 2026 Dai Foundation +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +pragma solidity >=0.8.0; + +import { DssInstance } from "dss-test/MCD.sol"; + +interface NFATFacilityLike { + function gem() external view returns (address); + function name() external view returns (string memory); + function symbol() external view returns (string memory); + function file(bytes32, address) external; + function file(bytes32, string calldata) external; + function kiss(address) external; + function addFreezer(address) external; +} + +struct NFATConfig { + string name; + string symbol; + address almProxy; + address identityNetwork; + string baseURI; + address operator; + address[] freezers; + bytes32 facilityKey; +} + +// Note: deployment scripts assume L1; adapt for L2 +// Note: `stopped` is initially false +library NFATInit { + + function init( + DssInstance memory dss, + address facility_, + NFATConfig memory cfg + ) internal { + NFATFacilityLike facility = NFATFacilityLike(facility_); + + require(facility.gem() == dss.chainlog.getAddress("SUSDS"), "NFATInit/gem-mismatch"); + require(keccak256(bytes(facility.name())) == keccak256(bytes(cfg.name)), "NFATInit/name-mismatch"); + require(keccak256(bytes(facility.symbol())) == keccak256(bytes(cfg.symbol)), "NFATInit/symbol-mismatch"); + + facility.file("recipient", cfg.almProxy); + facility.file("identityNetwork", cfg.identityNetwork); + facility.file("baseURI", cfg.baseURI); + + facility.kiss(cfg.operator); + for (uint256 i = 0; i < cfg.freezers.length; ++i) { + facility.addFreezer(cfg.freezers[i]); + } + + dss.chainlog.setAddress(cfg.facilityKey, facility_); + } +} diff --git a/foundry.toml b/foundry.toml index 25b918f..b329cb6 100644 --- a/foundry.toml +++ b/foundry.toml @@ -2,5 +2,11 @@ src = "src" out = "out" libs = ["lib"] +solc = "0.8.24" +optimizer = true +optimizer_runs = 200 +evmVersion = "cancun" +verbosity = 1 -# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options +[lint] +lint_on_build = false diff --git a/lib/dss-test b/lib/dss-test new file mode 160000 index 0000000..61cf29f --- /dev/null +++ b/lib/dss-test @@ -0,0 +1 @@ +Subproject commit 61cf29fc0cf0c177a3b4072b433c43a7326ccd7b diff --git a/lib/forge-std b/lib/forge-std deleted file mode 160000 index ebc60f5..0000000 --- a/lib/forge-std +++ /dev/null @@ -1 +0,0 @@ -Subproject commit ebc60f500bc6870baaf321a0196fddc24d6edb03 diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts new file mode 160000 index 0000000..fcbae53 --- /dev/null +++ b/lib/openzeppelin-contracts @@ -0,0 +1 @@ +Subproject commit fcbae5394ae8ad52d8e580a3477db99814b9d565 diff --git a/src/NFATFacility.sol b/src/NFATFacility.sol new file mode 100644 index 0000000..1fb8a80 --- /dev/null +++ b/src/NFATFacility.sol @@ -0,0 +1,239 @@ +// SPDX-FileCopyrightText: © 2026 Dai Foundation +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +pragma solidity ^0.8.24; + +import { ERC721 } from "openzeppelin-contracts/contracts/token/ERC721/ERC721.sol"; + +interface GemLike { + function transferFrom(address from, address to, uint256 amount) external; + function transfer(address to, uint256 amount) external; +} + +interface IdentityNetworkLike { + function isMember(address usr) external view returns (bool); +} + +contract NFATFacility is ERC721 { + + mapping(address usr => uint256 allowed) public wards; + mapping(address usr => uint256 allowed) public buds; // Operator(s) + mapping(address usr => uint256 allowed) public cops; // Freezers + mapping(address depositor => uint256 amount) public deposits; + mapping(uint256 tokenId => uint256 amount) public collectable; + address public recipient; // Destination of funds claimed by the operator + IdentityNetworkLike public identityNetwork; + bool public stopped; + string public baseURI; + + GemLike public immutable gem; // Underlying asset + + event Rely(address indexed usr); + event Deny(address indexed usr); + event Kiss(address indexed usr); + event Diss(address indexed usr); + event AddFreezer(address indexed usr); + event RemoveFreezer(address indexed usr); + event Stop(); + event Start(); + event File(bytes32 indexed what, address data); + event File(bytes32 indexed what, string data); + event Rescue(address indexed token, address indexed to, uint256 amount); + event RescueDeposit(address indexed depositor, address indexed to, uint256 amount); + event RescueCollectable(uint256 indexed tokenId, address indexed to, uint256 amount); + event Subscribe(address indexed depositor, uint256 amount, bytes data); + event Withdraw(address indexed depositor, uint256 amount); + event Issue(address indexed to, uint256 indexed tokenId, uint256 amount); + event Repay(address indexed sender, uint256 indexed tokenId, uint256 amount); + event Collect(uint256 indexed tokenId, uint256 amount); + + // --- Modifiers --- + + modifier auth() { + require(wards[msg.sender] == 1, "NFATFacility/not-authorized"); + _; + } + + modifier toll() { + require(buds[msg.sender] == 1, "NFATFacility/not-operator"); + _; + } + + modifier cop() { + require(cops[msg.sender] == 1, "NFATFacility/not-freezer"); + _; + } + + modifier notStopped() { + require(!stopped, "NFATFacility/stopped"); + _; + } + + // --- Constructor --- + + constructor(address gem_, string memory name_, string memory symbol_) + ERC721(name_, symbol_) + { + gem = GemLike(gem_); + wards[msg.sender] = 1; + emit Rely(msg.sender); + } + + // --- auth & cop Functions --- + + function rely(address usr) external auth { + wards[usr] = 1; + emit Rely(usr); + } + + function deny(address usr) external auth { + wards[usr] = 0; + emit Deny(usr); + } + + function kiss(address usr) external auth { + buds[usr] = 1; + emit Kiss(usr); + } + + function diss(address usr) external auth { + buds[usr] = 0; + emit Diss(usr); + } + + function addFreezer(address usr) external auth { + cops[usr] = 1; + emit AddFreezer(usr); + } + + function removeFreezer(address usr) external auth { + cops[usr] = 0; + emit RemoveFreezer(usr); + } + + function stop() external cop { + stopped = true; + emit Stop(); + } + + function start() external auth { + stopped = false; + emit Start(); + } + + function file(bytes32 what, address data) external auth { + if (what == "recipient") recipient = data; + else if (what == "identityNetwork") identityNetwork = IdentityNetworkLike(data); + else revert("NFATFacility/file-unrecognized-param"); + emit File(what, data); + } + + function file(bytes32 what, string calldata data) external auth { + if (what == "baseURI") baseURI = data; + else revert("NFATFacility/file-unrecognized-param"); + emit File(what, data); + } + + // Note: In order to rescue gem balances tracked by the `deposits` or `collectable` mappings, prefer using rescueDeposit/rescueCollectable over this function + // Note: tokens that return false instead of reverting on failure may cause a Rescue event to be emitted without an actual transfer + function rescue(address token, address to, uint256 amount) external auth { + GemLike(token).transfer(to, amount); + emit Rescue(token, to, amount); + } + + function rescueDeposit(address depositor, address to, uint256 amount) external auth { + require(deposits[depositor] >= amount, "NFATFacility/insufficient-deposits"); + unchecked { deposits[depositor] -= amount; } + gem.transfer(to, amount); + emit RescueDeposit(depositor, to, amount); + } + + function rescueCollectable(uint256 tokenId, address to, uint256 amount) external auth { + require(collectable[tokenId] >= amount, "NFATFacility/insufficient-collectable"); + unchecked { collectable[tokenId] -= amount; } + gem.transfer(to, amount); + emit RescueCollectable(tokenId, to, amount); + } + + // --- Queue Functions --- + + // Note: amount = 0 is allowed to emit updated data without depositing; data is arbitrary and intended for off-chain agreements + // Note: subscribing does not guarantee eligibility to be issued an NFAT - issue() will revert if the subscriber is not in the identity network at issuance time + function subscribe(uint256 amount, bytes calldata data) external notStopped { + if (amount > 0) { + gem.transferFrom(msg.sender, address(this), amount); + deposits[msg.sender] += amount; + } + emit Subscribe(msg.sender, amount, data); + } + + function withdraw(uint256 amount) external { + require(amount > 0, "NFATFacility/zero-amount"); + require(deposits[msg.sender] >= amount, "NFATFacility/insufficient-deposits"); + unchecked { deposits[msg.sender] -= amount; } + gem.transfer(msg.sender, amount); + emit Withdraw(msg.sender, amount); + } + + // Note: amount = 0 is allowed (mint NFAT without moving funds) + // Note: _mint is used instead of _safeMint — `to` opted in via subscribe and is assumed to support ERC-721 + function issue(address to, uint256 tokenId, uint256 amount) external toll notStopped { + require(tokenId != 0, "NFATFacility/token-id-zero"); + require(deposits[to] >= amount, "NFATFacility/insufficient-deposits"); + unchecked { deposits[to] -= amount; } + _mint(to, tokenId); // identity network check in _update + if (amount > 0) gem.transfer(recipient, amount); + emit Issue(to, tokenId, amount); + } + + // --- Redemption Functions --- + + // Note: the recipient of a transferred NFAT is assumed aware of current and future planned repayments, including potential front-running + function repay(uint256 tokenId, uint256 amount) external notStopped { + require(amount > 0, "NFATFacility/zero-amount"); + require(_ownerOf(tokenId) != address(0), "NFATFacility/invalid-token"); + gem.transferFrom(msg.sender, address(this), amount); + collectable[tokenId] += amount; + emit Repay(msg.sender, tokenId, amount); + } + + // Note: only the NFAT owner can collect (token and operator approvals do not extend to this function); the owner is assumed to be able to call this function directly + function collect(uint256 tokenId, uint256 amount) external notStopped { + require(amount > 0, "NFATFacility/zero-amount"); + require(collectable[tokenId] >= amount, "NFATFacility/insufficient-collectable"); + require(msg.sender == _ownerOf(tokenId), "NFATFacility/not-owner"); + require(address(identityNetwork) == address(0) || identityNetwork.isMember(msg.sender), "NFATFacility/not-member"); + unchecked { collectable[tokenId] -= amount; } + gem.transfer(msg.sender, amount); + emit Collect(tokenId, amount); + } + + // --- ERC-721 Overrides --- + + function _baseURI() internal view override returns (string memory) { + return baseURI; + } + + // Note: `to` is guaranteed non-zero (OZ reverts before _update when to == address(0), and _burn is never invoked) + function _update(address to, uint256 tokenId, address auth_) internal override returns (address) { + require( + address(identityNetwork) == address(0) || identityNetwork.isMember(to), + "NFATFacility/not-member" + ); + return super._update(to, tokenId, auth_); + } + +} diff --git a/test/NFATFacility.t.sol b/test/NFATFacility.t.sol new file mode 100644 index 0000000..b268e5c --- /dev/null +++ b/test/NFATFacility.t.sol @@ -0,0 +1,791 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later +pragma solidity ^0.8.24; + +import "dss-test/DssTest.sol"; +import { NFATFacility } from "src/NFATFacility.sol"; +import { NFATDeploy } from "deploy/NFATDeploy.sol"; +import { NFATInit, NFATConfig } from "deploy/NFATInit.sol"; +import { IERC721Errors } from "openzeppelin-contracts/contracts/interfaces/draft-IERC6093.sol"; + +interface GemLike { + function balanceOf(address) external view returns (uint256); + function approve(address, uint256) external; +} + +contract IdentityNetworkMock { + mapping(address => bool) public members; + function setMember(address usr, bool status) external { members[usr] = status; } + function isMember(address usr) external view returns (bool) { return members[usr]; } +} + +contract ERC721ReceiverMock { + function onERC721Received(address, address, uint256, bytes calldata) external pure returns (bytes4) { + return this.onERC721Received.selector; + } +} + +contract BadReceiverMock { + function onERC721Received(address, address, uint256, bytes calldata) external pure returns (bytes4) { + return 0xdeadbeef; + } +} + +contract NFATFacilityTest is DssTest { + DssInstance dss; + address pauseProxy; + GemLike susds; + IdentityNetworkMock idNet; + ERC721ReceiverMock receiver; + BadReceiverMock badReceiver; + NFATFacility facility; + + address almProxy = address(0xA1); + address operator = address(0xC1); + address freezer = address(0xC2); + address prime1 = address(0xB1); + address prime2 = address(0xB2); + + event Kiss(address indexed usr); + event Diss(address indexed usr); + event AddFreezer(address indexed usr); + event RemoveFreezer(address indexed usr); + event Stop(); + event Start(); + event Rescue(address indexed token, address indexed to, uint256 amount); + event RescueDeposit(address indexed depositor, address indexed to, uint256 amount); + event RescueCollectable(uint256 indexed tokenId, address indexed to, uint256 amount); + event Subscribe(address indexed depositor, uint256 amount, bytes data); + event Withdraw(address indexed depositor, uint256 amount); + event Issue(address indexed to, uint256 indexed tokenId, uint256 amount); + event Repay(address indexed sender, uint256 indexed tokenId, uint256 amount); + event Collect(uint256 indexed tokenId, uint256 amount); + event Transfer(address indexed from, address indexed to, uint256 indexed tokenId); + event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId); + event ApprovalForAll(address indexed owner, address indexed operator, bool approved); + + function setUp() public { + vm.createSelectFork(vm.envString("ETH_RPC_URL")); + + dss = MCD.loadFromChainlog(0xdA0Ab1e0017DEbCd72Be8599041a2aa3bA7e740F); + pauseProxy = dss.chainlog.getAddress("MCD_PAUSE_PROXY"); + susds = GemLike(dss.chainlog.getAddress("SUSDS")); + + idNet = new IdentityNetworkMock(); + receiver = new ERC721ReceiverMock(); + badReceiver = new BadReceiverMock(); + + address facility_ = NFATDeploy.deploy(address(this), pauseProxy, "Non-Fungible Allocation Token - Halo1", "NFAT-HALO1"); + facility = NFATFacility(facility_); + + address[] memory _freezers = new address[](1); + _freezers[0] = freezer; + NFATConfig memory cfg = NFATConfig({ + name: "Non-Fungible Allocation Token - Halo1", + symbol: "NFAT-HALO1", + almProxy: almProxy, + identityNetwork: address(0), + baseURI: "", + operator: operator, + freezers: _freezers, + facilityKey: "NFAT_FAC_HALO1" + }); + vm.startPrank(pauseProxy); + NFATInit.init(dss, facility_, cfg); + vm.stopPrank(); + + deal(address(susds), prime1, 1000 ether); + deal(address(susds), prime2, 1000 ether); + vm.prank(prime1); susds.approve(address(facility), type(uint256).max); + vm.prank(prime2); susds.approve(address(facility), type(uint256).max); + } + + // --- Helpers --- + + function _subscribe(address who, uint256 amount) internal { + vm.prank(who); facility.subscribe(amount, ""); + } + + function _issue(address target, uint256 amount) internal returns (uint256 tokenId) { + tokenId = vm.randomUint(); + vm.prank(operator); facility.issue(target, tokenId, amount); + } + + function _repayToken(uint256 tokenId, uint256 amount) internal { + deal(address(susds), address(this), susds.balanceOf(address(this)) + amount); + susds.approve(address(facility), amount); + facility.repay(tokenId, amount); + } + + // --- Constructor --- + + function testConstructor() public { + vm.expectEmit(true, true, true, true); + emit Rely(address(this)); + NFATFacility f = new NFATFacility(address(0x111), "Name", "SYM"); + + assertEq(address(f.gem()), address(0x111)); + assertEq(f.name(), "Name"); + assertEq(f.symbol(), "SYM"); + assertEq(f.wards(address(this)), 1); + } + + // --- Deploy & Init --- + + function testDeployAndInit() public { + address f_ = NFATDeploy.deploy(address(this), pauseProxy, "SomeName", "SomeSymb"); + address[] memory cops = new address[](2); + cops[0] = address(0xff1); + cops[1] = address(0xff2); + NFATConfig memory cfg = NFATConfig({ + name: "SomeName", + symbol: "SomeSymb", + almProxy: address(0xaaa), + identityNetwork: address(0x111), + baseURI: "someURI", + operator: address(0xbbb), + freezers: cops, + facilityKey: "FAC_KEY" + }); + vm.startPrank(pauseProxy); + NFATInit.init(dss, f_, cfg); + vm.stopPrank(); + + NFATFacility f = NFATFacility(f_); + assertEq(address(f.gem()), address(susds)); + assertEq(f.name(), "SomeName"); + assertEq(f.symbol(), "SomeSymb"); + assertEq(f.wards(address(this)), 0); + assertEq(f.wards(pauseProxy), 1); + assertEq(f.recipient(), address(0xaaa)); + assertEq(address(f.identityNetwork()), address(0x111)); + assertEq(f.baseURI(), "someURI"); + assertEq(f.buds(address(0xbbb)), 1); + assertEq(f.cops(cops[0]), 1); + assertEq(f.cops(cops[1]), 1); + assertEq(dss.chainlog.getAddress("FAC_KEY"), f_); + } + + // --- Access Control --- + + function testAuth() public { + checkAuth(address(facility), "NFATFacility"); + } + + function testModifiers() public { + vm.startPrank(address(0xBEEF)); + checkModifier(address(facility), "NFATFacility/not-authorized", [ + facility.kiss.selector, + facility.diss.selector, + facility.addFreezer.selector, + facility.removeFreezer.selector, + facility.start.selector, + facility.rescue.selector, + facility.rescueDeposit.selector, + facility.rescueCollectable.selector + ]); + vm.stopPrank(); + + checkModifier(address(facility), "NFATFacility/not-operator", [ + facility.issue.selector + ]); + checkModifier(address(facility), "NFATFacility/not-freezer", [ + facility.stop.selector + ]); + } + + function testKissDiss() public { + address who = address(0xb0b); + assertEq(facility.buds(who), 0); + + vm.expectEmit(true, true, true, true); + emit Kiss(who); + vm.prank(pauseProxy); facility.kiss(who); + assertEq(facility.buds(who), 1); + + vm.expectEmit(true, true, true, true); + emit Diss(who); + vm.prank(pauseProxy); facility.diss(who); + assertEq(facility.buds(who), 0); + } + + function testAddRemoveFreezer() public { + address who = address(0xb0b); + assertEq(facility.cops(who), 0); + + vm.expectEmit(true, true, true, true); + emit AddFreezer(who); + vm.prank(pauseProxy); facility.addFreezer(who); + assertEq(facility.cops(who), 1); + + vm.expectEmit(true, true, true, true); + emit RemoveFreezer(who); + vm.prank(pauseProxy); facility.removeFreezer(who); + assertEq(facility.cops(who), 0); + } + + function testStopStart() public { + _subscribe(prime1, 100 ether); + vm.prank(operator); facility.issue(prime1, 1, 25 ether); + _repayToken(1, 50 ether); + + vm.expectEmit(true, true, true, true); + emit Stop(); + vm.prank(freezer); facility.stop(); + assertTrue(facility.stopped()); + + vm.expectRevert("NFATFacility/stopped"); + vm.prank(prime1); facility.subscribe(25 ether, ""); + vm.expectRevert("NFATFacility/stopped"); + vm.prank(operator); facility.issue(prime1, 2, 25 ether); + vm.expectRevert("NFATFacility/stopped"); + facility.repay(1, 10 ether); + vm.expectRevert("NFATFacility/stopped"); + vm.prank(prime1); facility.collect(1, 50 ether); + + vm.expectEmit(true, true, true, true); + emit Start(); + vm.prank(pauseProxy); facility.start(); + assertTrue(!facility.stopped()); + + _subscribe(prime1, 25 ether); + vm.prank(operator); facility.issue(prime1, 2, 25 ether); + _repayToken(2, 10 ether); + vm.prank(prime1); facility.collect(1, 50 ether); + } + + function testFile() public { + checkFileAddress(address(facility), "NFATFacility", ["recipient", "identityNetwork"]); + checkFileString(address(facility), "NFATFacility", ["baseURI"]); + } + + // --- Rescue --- + + function testRescue() public { + address rescueTo = address(0xBEEF); + + // Rescue gem surplus + deal(address(susds), address(facility), 100 ether); + + vm.expectEmit(true, true, true, true); + emit Rescue(address(susds), rescueTo, 100 ether); + vm.prank(pauseProxy); facility.rescue(address(susds), rescueTo, 100 ether); + + assertEq(susds.balanceOf(rescueTo), 100 ether); + assertEq(susds.balanceOf(address(facility)), 0); + + // Rescue non-gem token + address usds = dss.chainlog.getAddress("USDS"); + deal(usds, address(facility), 50 ether); + + vm.expectEmit(true, true, true, true); + emit Rescue(usds, rescueTo, 50 ether); + vm.prank(pauseProxy); facility.rescue(usds, rescueTo, 50 ether); + + assertEq(GemLike(usds).balanceOf(rescueTo), 50 ether); + assertEq(GemLike(usds).balanceOf(address(facility)), 0); + } + + function testRescueDeposit() public { + _subscribe(prime1, 100 ether); + + address rescueTo = address(0xBEEF); + + vm.expectEmit(true, true, true, true); + emit RescueDeposit(prime1, rescueTo, 60 ether); + vm.prank(pauseProxy); facility.rescueDeposit(prime1, rescueTo, 60 ether); + + assertEq(facility.deposits(prime1), 40 ether); + assertEq(susds.balanceOf(rescueTo), 60 ether); + assertEq(susds.balanceOf(address(facility)), 40 ether); + } + + function testRevertRescueDepositInsufficientDeposits() public { + _subscribe(prime1, 100 ether); + + vm.expectRevert("NFATFacility/insufficient-deposits"); + vm.prank(pauseProxy); facility.rescueDeposit(prime1, address(0xBEEF), 101 ether); + } + + function testRescueCollectable() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + _repayToken(tokenId, 80 ether); + + address rescueTo = address(0xBEEF); + + vm.expectEmit(true, true, true, true); + emit RescueCollectable(tokenId, rescueTo, 50 ether); + vm.prank(pauseProxy); facility.rescueCollectable(tokenId, rescueTo, 50 ether); + + assertEq(facility.collectable(tokenId), 30 ether); + assertEq(susds.balanceOf(rescueTo), 50 ether); + assertEq(susds.balanceOf(address(facility)), 30 ether); + } + + function testRevertRescueCollectableInsufficientCollectable() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + _repayToken(tokenId, 10 ether); + + vm.expectRevert("NFATFacility/insufficient-collectable"); + vm.prank(pauseProxy); facility.rescueCollectable(tokenId, address(0xBEEF), 11 ether); + } + + // --- Queue --- + + function testSubscribe() public { + vm.expectEmit(true, true, true, true); + emit Subscribe(prime1, 100 ether, ""); + _subscribe(prime1, 100 ether); + + assertEq(facility.deposits(prime1), 100 ether); + assertEq(susds.balanceOf(address(facility)), 100 ether); + + // Second subscribe adds up + _subscribe(prime1, 50 ether); + + assertEq(facility.deposits(prime1), 150 ether); + assertEq(susds.balanceOf(address(facility)), 150 ether); + } + + function testSubscribeZeroAmountWithData() public { + bytes memory data = bytes("sample terms"); + uint256 depositsBefore = facility.deposits(prime1); + + vm.expectEmit(true, true, true, true); + emit Subscribe(prime1, 0, data); + vm.prank(prime1); facility.subscribe(0, data); + + assertEq(facility.deposits(prime1), depositsBefore); + } + + function testWithdraw() public { + _subscribe(prime1, 100 ether); + + // Partial withdraw + vm.expectEmit(true, true, true, true); + emit Withdraw(prime1, 40 ether); + vm.prank(prime1); facility.withdraw(40 ether); + + assertEq(facility.deposits(prime1), 60 ether); + assertEq(susds.balanceOf(prime1), 940 ether); + + // Withdraw remainder + vm.prank(prime1); facility.withdraw(60 ether); + + assertEq(facility.deposits(prime1), 0); + assertEq(susds.balanceOf(prime1), 1000 ether); + } + + function testWithdrawWhenStopped() public { + _subscribe(prime1, 100 ether); + vm.prank(freezer); facility.stop(); + + vm.prank(prime1); facility.withdraw(100 ether); + + assertEq(facility.deposits(prime1), 0); + assertEq(susds.balanceOf(prime1), 1000 ether); + } + + function testRevertWithdrawZeroAmount() public { + vm.expectRevert("NFATFacility/zero-amount"); + vm.prank(prime1); facility.withdraw(0); + } + + function testRevertWithdrawInsufficientDeposits() public { + _subscribe(prime1, 100 ether); + + vm.expectRevert("NFATFacility/insufficient-deposits"); + vm.prank(prime1); facility.withdraw(101 ether); + } + + // --- Issue --- + + function testIssue() public { + _subscribe(prime1, 100 ether); + + // First issue + uint256 tokenId0 = vm.randomUint(); + vm.expectEmit(true, true, true, true); + emit Issue(prime1, tokenId0, 60 ether); + vm.prank(operator); facility.issue(prime1, tokenId0, 60 ether); + + assertEq(facility.ownerOf(tokenId0), prime1); + assertEq(facility.balanceOf(prime1), 1); + assertEq(facility.deposits(prime1), 40 ether); + assertEq(susds.balanceOf(almProxy), 60 ether); + + // Second issue + uint256 tokenId1 = _issue(prime1, 30 ether); + + assertEq(facility.ownerOf(tokenId1), prime1); + assertEq(facility.balanceOf(prime1), 2); + assertEq(facility.deposits(prime1), 10 ether); + } + + function testIssueZeroAmount() public { + uint256 depositsBefore = facility.deposits(prime1); + uint256 almBalBefore = susds.balanceOf(almProxy); + + vm.prank(operator); facility.issue(prime1, 1, 0 ether); + + assertEq(facility.ownerOf(1), prime1); + assertEq(facility.deposits(prime1), depositsBefore); + assertEq(susds.balanceOf(almProxy), almBalBefore); + } + + function testIssueWithIdentityNetwork() public { + vm.prank(pauseProxy); facility.file("identityNetwork", address(idNet)); + idNet.setMember(prime1, true); + + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 50 ether); + + assertEq(facility.ownerOf(tokenId), prime1); + } + + function testRevertIssueTokenIdZero() public { + _subscribe(prime1, 100 ether); + + vm.expectRevert("NFATFacility/token-id-zero"); + vm.prank(operator); facility.issue(prime1, 0, 50 ether); + } + + function testRevertIssueInsufficientDeposits() public { + _subscribe(prime1, 100 ether); + + vm.expectRevert("NFATFacility/insufficient-deposits"); + vm.prank(operator); facility.issue(prime1, 1, 101 ether); + } + + function testRevertIssueDuplicateTokenId() public { + _subscribe(prime1, 200 ether); + vm.prank(operator); facility.issue(prime1, 1, 50 ether); + + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidSender.selector, address(0))); + vm.prank(operator); facility.issue(prime1, 1, 50 ether); + } + + function testRevertIssueTargetNotMember() public { + vm.prank(pauseProxy); facility.file("identityNetwork", address(idNet)); + + _subscribe(prime1, 100 ether); + + vm.expectRevert("NFATFacility/not-member"); + vm.prank(operator); facility.issue(prime1, 1, 50 ether); + } + + // --- Repay --- + + function testRepay() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + // First repay + deal(address(susds), address(this), 50 ether); + susds.approve(address(facility), 50 ether); + + vm.expectEmit(true, true, true, true); + emit Repay(address(this), tokenId, 50 ether); + facility.repay(tokenId, 50 ether); + + assertEq(facility.collectable(tokenId), 50 ether); + + // Second repay accumulates + _repayToken(tokenId, 20 ether); + + assertEq(facility.collectable(tokenId), 70 ether); + } + + function testRevertRepayZeroAmount() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + vm.expectRevert("NFATFacility/zero-amount"); + facility.repay(tokenId, 0); + } + + function testRevertRepayInvalidToken() public { + vm.expectRevert("NFATFacility/invalid-token"); + facility.repay(999, 1 ether); + } + + // --- Collect --- + + function testCollect() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + _repayToken(tokenId, 80 ether); + + uint256 balBefore = susds.balanceOf(prime1); + + // Partial collect + vm.expectEmit(true, true, true, true); + emit Collect(tokenId, 30 ether); + vm.prank(prime1); facility.collect(tokenId, 30 ether); + + assertEq(facility.collectable(tokenId), 50 ether); + assertEq(susds.balanceOf(prime1), balBefore + 30 ether); + + // Collect remainder + vm.prank(prime1); facility.collect(tokenId, 50 ether); + + assertEq(facility.collectable(tokenId), 0); + assertEq(susds.balanceOf(prime1), balBefore + 80 ether); + } + + function testCollectAfterTransfer() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + _repayToken(tokenId, 50 ether); + + vm.prank(prime1); facility.transferFrom(prime1, prime2, tokenId); + + assertEq(facility.collectable(tokenId), 50 ether); + + uint256 balBefore = susds.balanceOf(prime2); + vm.prank(prime2); facility.collect(tokenId, 50 ether); + + assertEq(facility.collectable(tokenId), 0); + assertEq(susds.balanceOf(prime2), balBefore + 50 ether); + } + + function testCollectWithIdentityNetwork() public { + vm.prank(pauseProxy); facility.file("identityNetwork", address(idNet)); + idNet.setMember(prime1, true); + + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + _repayToken(tokenId, 50 ether); + + uint256 balBefore = susds.balanceOf(prime1); + vm.prank(prime1); facility.collect(tokenId, 50 ether); + + assertEq(facility.collectable(tokenId), 0); + assertEq(susds.balanceOf(prime1), balBefore + 50 ether); + } + + function testRevertCollectZeroAmount() public { + vm.expectRevert("NFATFacility/zero-amount"); + vm.prank(prime1); facility.collect(0, 0); + } + + function testRevertCollectInsufficientCollectable() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + _repayToken(tokenId, 10 ether); + + vm.expectRevert("NFATFacility/insufficient-collectable"); + vm.prank(prime1); facility.collect(tokenId, 11 ether); + } + + function testRevertCollectNotOwner() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + _repayToken(tokenId, 50 ether); + + vm.expectRevert("NFATFacility/not-owner"); + vm.prank(prime2); facility.collect(tokenId, 50 ether); + } + + function testRevertCollectNotMember() public { + vm.prank(pauseProxy); facility.file("identityNetwork", address(idNet)); + idNet.setMember(prime1, true); + + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + _repayToken(tokenId, 50 ether); + + idNet.setMember(prime1, false); + + vm.expectRevert("NFATFacility/not-member"); + vm.prank(prime1); facility.collect(tokenId, 50 ether); + } + + // --- ERC-721 --- + + function testTransferFrom() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + vm.expectEmit(true, true, true, true); + emit Transfer(prime1, prime2, tokenId); + vm.prank(prime1); facility.transferFrom(prime1, prime2, tokenId); + + assertEq(facility.ownerOf(tokenId), prime2); + assertEq(facility.balanceOf(prime1), 0); + assertEq(facility.balanceOf(prime2), 1); + } + + function testTransferFromWithApproval() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + vm.prank(prime1); facility.approve(prime2, tokenId); + assertEq(facility.getApproved(tokenId), prime2); + + vm.prank(prime2); facility.transferFrom(prime1, prime2, tokenId); + + assertEq(facility.ownerOf(tokenId), prime2); + assertEq(facility.getApproved(tokenId), address(0)); // approval cleared + } + + function testTransferFromWithOperatorApproval() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + vm.prank(prime1); facility.setApprovalForAll(prime2, true); + vm.prank(prime2); facility.transferFrom(prime1, prime2, tokenId); + + assertEq(facility.ownerOf(tokenId), prime2); + } + + function testRevertTransferFromNotAuthorized() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InsufficientApproval.selector, prime2, tokenId)); + vm.prank(prime2); facility.transferFrom(prime1, prime2, tokenId); + } + + function testRevertTransferFromWrongFrom() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721IncorrectOwner.selector, prime2, tokenId, prime1)); + vm.prank(prime1); facility.transferFrom(prime2, prime2, tokenId); + } + + function testRevertTransferFromZeroAddress() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidReceiver.selector, address(0))); + vm.prank(prime1); facility.transferFrom(prime1, address(0), tokenId); + } + + function testTransferFromWithIdentityNetwork() public { + vm.prank(pauseProxy); facility.file("identityNetwork", address(idNet)); + idNet.setMember(prime1, true); + idNet.setMember(prime2, true); + + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + idNet.setMember(prime2, false); + vm.expectRevert("NFATFacility/not-member"); + vm.prank(prime1); facility.transferFrom(prime1, prime2, tokenId); + + idNet.setMember(prime2, true); + vm.prank(prime1); facility.transferFrom(prime1, prime2, tokenId); + assertEq(facility.ownerOf(tokenId), prime2); + + // Sender membership is not checked + idNet.setMember(prime2, false); + vm.prank(prime2); facility.transferFrom(prime2, prime1, tokenId); + assertEq(facility.ownerOf(tokenId), prime1); + } + + function testSafeTransferFrom() public { + _subscribe(prime1, 100 ether); + + // To EOA + uint256 tokenId0 = _issue(prime1, 50 ether); + vm.prank(prime1); facility.safeTransferFrom(prime1, prime2, tokenId0); + assertEq(facility.ownerOf(tokenId0), prime2); + + // To contract implementing onERC721Received + uint256 tokenId1 = _issue(prime1, 50 ether); + vm.prank(prime1); facility.safeTransferFrom(prime1, address(receiver), tokenId1, "test data"); + assertEq(facility.ownerOf(tokenId1), address(receiver)); + } + + function testRevertSafeTransferFromUnsafeRecipient() public { + _subscribe(prime1, 100 ether); + + // Bad return value + uint256 tokenId0 = _issue(prime1, 50 ether); + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidReceiver.selector, address(badReceiver))); + vm.prank(prime1); facility.safeTransferFrom(prime1, address(badReceiver), tokenId0); + + // No onERC721Received at all + uint256 tokenId1 = _issue(prime1, 50 ether); + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidReceiver.selector, address(facility))); + vm.prank(prime1); facility.safeTransferFrom(prime1, address(facility), tokenId1); + } + + function testApprove() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + // Owner approves + vm.expectEmit(true, true, true, true); + emit Approval(prime1, prime2, tokenId); + vm.prank(prime1); facility.approve(prime2, tokenId); + assertEq(facility.getApproved(tokenId), prime2); + + // Operator approves + vm.prank(prime1); facility.setApprovalForAll(prime2, true); + vm.prank(prime2); facility.approve(operator, tokenId); + assertEq(facility.getApproved(tokenId), operator); + } + + function testRevertApproveNotAuthorized() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidApprover.selector, prime2)); + vm.prank(prime2); facility.approve(prime2, tokenId); + } + + function testSetApprovalForAll() public { + vm.expectEmit(true, true, true, true); + emit ApprovalForAll(prime1, prime2, true); + vm.prank(prime1); facility.setApprovalForAll(prime2, true); + + assertTrue(facility.isApprovedForAll(prime1, prime2)); + } + + function testRevertSetApprovalForAllZeroAddress() public { + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidOperator.selector, address(0))); + vm.prank(prime1); facility.setApprovalForAll(address(0), true); + } + + function testRevertOwnerOfInvalidToken() public { + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, uint256(999))); + facility.ownerOf(999); + } + + function testRevertBalanceOfZeroAddress() public { + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721InvalidOwner.selector, address(0))); + facility.balanceOf(address(0)); + } + + function testRevertGetApprovedInvalidToken() public { + vm.expectRevert(abi.encodeWithSelector(IERC721Errors.ERC721NonexistentToken.selector, uint256(999))); + facility.getApproved(999); + } + + // --- Metadata & ERC-165 --- + + function testTokenURI() public { + _subscribe(prime1, 100 ether); + uint256 tokenId = _issue(prime1, 100 ether); + assertEq(facility.baseURI(), ""); + assertEq(facility.tokenURI(tokenId), ""); + + vm.prank(pauseProxy); facility.file("baseURI", "https://example.com/nfat/"); + + assertEq(facility.baseURI(), "https://example.com/nfat/"); + assertEq(facility.tokenURI(tokenId), string.concat("https://example.com/nfat/", vm.toString(tokenId))); + } + + function testMetadataAndERC165() public view { + assertEq(facility.name(), "Non-Fungible Allocation Token - Halo1"); + assertEq(facility.symbol(), "NFAT-HALO1"); + assertTrue(facility.supportsInterface(0x01ffc9a7)); // ERC-165 + assertTrue(facility.supportsInterface(0x80ac58cd)); // ERC-721 + assertTrue(facility.supportsInterface(0x5b5e139f)); // ERC-721 Metadata + assertTrue(!facility.supportsInterface(0xdeadbeef)); // random + } +}