diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..dfb6e8e --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,26 @@ +name: CI +on: + push: + branches: + - main + pull_request: + +env: + FOUNDRY_PROFILE: ci + +jobs: + run-ci: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Install Foundry + uses: foundry-rs/foundry-toolchain@v1 + with: + version: nightly + + - name: Install deps + run: forge install + + - name: Run tests + run: forge test diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..757dc9e --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +out/ +cache/ +.vscode/ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..e21df20 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,12 @@ +[submodule "lib/forge-std"] + path = lib/forge-std + url = https://github.com/foundry-rs/forge-std +[submodule "lib/ds-token"] + path = lib/ds-token + url = https://github.com/dapphub/ds-token +[submodule "lib/ds-note"] + path = lib/ds-note + url = https://github.com/dapphub/ds-note +[submodule "lib/ds-auth"] + path = lib/ds-auth + url = https://github.com/dapphub/ds-auth diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..52d6e18 --- /dev/null +++ b/README.md @@ -0,0 +1,139 @@ +# Decentralized Summation System + +This repository contains the core smart contract code for the Decentralized +Summation System (`dss`). This is a high level description of the system, assuming +familiarity with the basic counting mechanics as described in the +whitepaper. + +## System Diagram + +![DSS System Diagram](/doc/dss-diagram.png?raw=true) + +## Design Considerations + +- Client agnostic + - system doesn't care about the implementation of external contracts + - can operate entirely independently of other systems + +- Verifiable + - designed from the bottom up to be amenable to formal verification + - the core ICV and counter database makes *no* external calls and + contains *no* precision loss (i.e. no division) + +- Modular + - multi contract core system is made to be very adaptable to changing + requirements. + - allows for the addition of novel counter types (e.g. count-by-threes, fibonacci) + +## Usage + +See the test cases in [`dss.t.sol`](https://github.com/counterdao/dss/blob/aa7809965a314a5c8fdf7e6b5d39a92bf0901c3f/test/dss.t.sol#L76) for annotated examples that demonstrate how to interact with `dss` from your own contracts. + +## Sum — Counter Engine + +The `Sum` is the core Counter engine of `dss`. It stores Counters and tracks +all the associated values. It also defines the rules by which Counters and values +can be manipulated. The rules defined in the `Sum` are immutable, so in some +sense, the rules in the `Sum` can be viewed as the constitution of `dss`. + +Within the `Sum` an `Inc` represents a stored ICV (Integer Counter Value). The +attributes of an `Inc` are: +- `net`: The counter value. +- `tab`: The sum of all counter increments. +- `tax`: The sum of all counter decrements. +- `num`: Total number of counter operations, i.e. sum of increments, decrements, and resets. +- `hop`: The counter's increment unit. + +Functions: +- `boot`: Register a new Counter. +- `zero`: Reset a Counter. +- `frob`: General function for manipulating a Counter. + - `sinc`: "Sign of increment." 1 for increment, -1 for decrement. +- `wish`: Check whether an address is allowed to modify another address's Counter. + - `hope`: enable `wish` for a pair of addresses. + - `nope`: disable `wish` for a pair of addresses. + +## Hitter — Increment module + +The `Hitter` is used to increment an initialized Counter. + +Functions: +- `hit`: Increases a Counter's `net` and `tab` by one `hop`. Increments `num`. + +## Dipper — Decrement module + +The `Dipper` is used to decrement an initialized Counter. + +Functions: +- `dip`: Decreases a Counter's `net` and `tax` by one `hop`. Increments `num`. + +## Nil — Reset module + +`Nil` is used to reset an initialized counter. + +Functions: +- `nil`: Resets a Counter's `net`, `tab`, and `tax` to zero. Increments `num`. + +## Spy — Counter read module + +The `Spy` is used to read counter values. + +Functions: +- `see`: Returns a Counter's `net`. View only function. + +## DSS — Protocol interface module + +The `DSS` module is an interface contract that composes other modules in +the `dss` system and provides a unified interface to the protocol. + +Functions: +- `build`: Create a new `DSSProxy` with this `DSS` module as its target implementation. Authorizes + `msg.sender` to interact with the proxy. + - `wit`: A `bytes32` salt for the `create2` constructor. + - `god`: Proxy owner address, authorized to update the implementation and manage `wards`. +- `bless`: Authorize the core `dss` modules (`Use`, `Hitter`, `Dipper`, and `Nil`). +- `use`: Create a new Counter. +- `see`: Read a Counter value. +- `hit`: Increment a Counter. +- `dip`: Decrement a Counter. +- `nil`: Reset a Counter. +- `hope`: Authorize a module to manipulate a Counter. +- `nope`: Revoke a module's authorization. This may be used to customize Counter + behavior, e.g. disabling decrements and resets. + +In most cases users should not interact directly with the `DSS` module, but instead use a `DSSProxy`. + +## DSSProxy — Execute DSS actions + +A `DSSProxy` is a transparent proxy contract that targets the `DSS` interface module as its +implementation. This enables callers to execute DSS actions through a persistent identity. +In most cases, users should create and interact with Counters through a `DSSProxy`. + +In the event of a protocol upgrade, the `DSSProxy` owner may choose to `upgrade` their proxy to +target the latest `DSS` interface module. + +`DSSProxy` includes a flexible authorization mechanism that allows multiple callers to interact +with a Counter through the proxy's persistent identity. This enables the creation of Counters +that may be shared by multiple contracts simultaneously, or used by many different contracts +over time. + +Functions: +- `upgrade`: Set a new address as the target implementation. Only callable by the proxy `owner` +- `rely`: Authorize an address to call the proxy and interact with a Counter. +- `deny`: Revoke authorization from an address. + +## System parameters + +CTR token holders govern the core parameter of the DSS protocol, namely `One`. +The value of `One` represents the global counter increment unit. Newly initialized Counters +store the active `One` as their `hop` at creation time. + +**Note:** The value of `One` is a **critical** system parameter and **must be set carefully by governance**. +An incorrect value of `One` may have unintended and far reaching consequences for +the DSS protocol and the systems that depend on it. + +## Acknowledgments + +- [shrugs](https://github.com/shrugs), author of the one and only[`Counters.sol`](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/utils/Counters.sol). +- [karmacoma](https://github.com/karmacoma-eth), for creating [`enterprise-counters`](https://github.com/karmacoma-eth/enterprise-counters) and putting me up to this. +- [dapphub](https://github.com/dapphub) and [Maker](https://github.com/makerdao) for the greatest contracts of all time. diff --git a/doc/dss-diagram.png b/doc/dss-diagram.png new file mode 100644 index 0000000..0a4e8bb Binary files /dev/null and b/doc/dss-diagram.png differ diff --git a/foundry.toml b/foundry.toml new file mode 100644 index 0000000..90a2b8c --- /dev/null +++ b/foundry.toml @@ -0,0 +1,6 @@ +[profile.default] +src = 'src' +out = 'out' +libs = ['lib'] + +# See more config options https://github.com/foundry-rs/foundry/tree/master/config diff --git a/lib/ds-auth b/lib/ds-auth new file mode 160000 index 0000000..a51e7ca --- /dev/null +++ b/lib/ds-auth @@ -0,0 +1 @@ +Subproject commit a51e7caa1f03eeffed66d67f3b38605e0f1f881d diff --git a/lib/ds-note b/lib/ds-note new file mode 160000 index 0000000..832591b --- /dev/null +++ b/lib/ds-note @@ -0,0 +1 @@ +Subproject commit 832591b2d7dfb13dd513a72d0ff5a64c23b4e327 diff --git a/lib/ds-token b/lib/ds-token new file mode 160000 index 0000000..16f187a --- /dev/null +++ b/lib/ds-token @@ -0,0 +1 @@ +Subproject commit 16f187acc15dd839589be60173ad1ebd0716eb82 diff --git a/lib/forge-std b/lib/forge-std new file mode 160000 index 0000000..27e14b7 --- /dev/null +++ b/lib/forge-std @@ -0,0 +1 @@ +Subproject commit 27e14b7f2448e5f5ac32719f51fe652aa0b0733e diff --git a/src/dip.sol b/src/dip.sol new file mode 100644 index 0000000..aa7576c --- /dev/null +++ b/src/dip.sol @@ -0,0 +1,39 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// dip.sol -- Counter decrement module + +// Copyright (C) 2022 Horsefacts +// +// 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.15; + +interface SumLike { + function frob(address,int) external; +} + +contract Dipper { + // --- Data --- + SumLike immutable public sum; + + // --- Init --- + constructor(address sum_) { + sum = SumLike(sum_); + } + + // --- Counter Decrement --- + function dip() external { + sum.frob(msg.sender, -1); + } +} diff --git a/src/dss.sol b/src/dss.sol new file mode 100644 index 0000000..3e9af31 --- /dev/null +++ b/src/dss.sol @@ -0,0 +1,125 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// dss.sol -- Decentralized Summation System + +// Copyright (C) 2022 Horsefacts +// +// 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.15; + +import {DSSProxy} from "./proxy/proxy.sol"; + +interface DSSLike { + function use() external; + function see() external view returns (uint256); + function hit() external; + function dip() external; + function nil() external; + function hope(address) external; + function nope(address) external; + function bless() external; +} + +interface SumLike { + function hope(address) external; + function nope(address) external; +} + +interface UseLike { + function use() external; +} + +interface SpyLike { + function see() external view returns (uint256); +} + +interface HitterLike { + function hit() external; +} + +interface DipperLike { + function dip() external; +} + +interface NilLike { + function nil() external; +} + +contract DSS { + // --- Data --- + SumLike immutable public _sum; + UseLike immutable public _use; + SpyLike immutable public _spy; + HitterLike immutable public _hitter; + DipperLike immutable public _dipper; + NilLike immutable public _nil; + + // --- Init --- + constructor( + address sum_, + address use_, + address spy_, + address hitter_, + address dipper_, + address nil_) + { + _sum = SumLike(sum_); // Core ICV engine + _use = UseLike(use_); // Creation module + _spy = SpyLike(spy_); // Read module + _hitter = HitterLike(hitter_); // Increment module + _dipper = DipperLike(dipper_); // Decrement module + _nil = NilLike(nil_); // Reset module + } + + // --- DSS Operations --- + function use() external { + _use.use(); + } + + function see() external view returns (uint256) { + return _spy.see(); + } + + function hit() external { + _hitter.hit(); + } + + function dip() external { + _dipper.dip(); + } + + function nil() external { + _nil.nil(); + } + + function hope(address usr) external { + _sum.hope(usr); + } + + function nope(address usr) external { + _sum.nope(usr); + } + + function bless() external { + _sum.hope(address(_use)); + _sum.hope(address(_hitter)); + _sum.hope(address(_dipper)); + _sum.hope(address(_nil)); + } + + function build(bytes32 wit, address god) external returns (address proxy) { + proxy = address(new DSSProxy{ salt: wit }(address(this), msg.sender, god)); + } +} diff --git a/src/gov/ctr.sol b/src/gov/ctr.sol new file mode 100644 index 0000000..9def81b --- /dev/null +++ b/src/gov/ctr.sol @@ -0,0 +1,32 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// ctr.sol -- Counter governance token + +// Copyright (C) 2022 Horsefacts +// Copyright (C) 2015, 2016, 2017 DappHub, LLC +// +// 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.4.23 <0.7.0; + +import {DSToken} from "ds-token/token.sol"; + +contract CTR is DSToken { + + constructor() DSToken("CTR") public { + setName("Counter"); + mint(msg.sender, 1_000_000 ether); + } + +} diff --git a/src/hit.sol b/src/hit.sol new file mode 100644 index 0000000..5b3b617 --- /dev/null +++ b/src/hit.sol @@ -0,0 +1,39 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// hit.sol -- Counter increment module + +// Copyright (C) 2022 Horsefacts +// +// 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.15; + +interface SumLike { + function frob(address,int) external; +} + +contract Hitter { + // --- Data --- + SumLike immutable public sum; + + // --- Init --- + constructor(address sum_) { + sum = SumLike(sum_); + } + + // --- Counter Increment --- + function hit() external { + sum.frob(msg.sender, 1); + } +} diff --git a/src/nil.sol b/src/nil.sol new file mode 100644 index 0000000..416b9ac --- /dev/null +++ b/src/nil.sol @@ -0,0 +1,39 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// nil.sol -- Counter reset module + +// Copyright (C) 2022 Horsefacts +// +// 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.15; + +interface SumLike { + function zero(address) external; +} + +contract Nil { + // --- Data --- + SumLike immutable public sum; + + // --- Init --- + constructor(address sum_) { + sum = SumLike(sum_); + } + + // --- Counter Reset --- + function nil() external { + sum.zero(msg.sender); + } +} diff --git a/src/proxy/proxy.sol b/src/proxy/proxy.sol new file mode 100644 index 0000000..d539f8a --- /dev/null +++ b/src/proxy/proxy.sol @@ -0,0 +1,67 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// proxy.sol -- Execute DSS actions through the proxy's identity + +// Copyright (C) 2022 Horsefacts +// +// 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.15; + +import {DSAuth} from "ds-auth/auth.sol"; +import {DSNote} from "ds-note/note.sol"; + +contract DSSProxy is DSAuth, DSNote { + // --- Data --- + address public dss; + + // --- Auth --- + mapping (address => uint) public wards; + function rely(address usr) external auth note { wards[usr] = 1; } + function deny(address usr) external auth note { wards[usr] = 0; } + modifier ward { + require(wards[msg.sender] == 1, "DSSProxy/not-authorized"); + require(msg.sender != owner, "DSSProxy/owner-not-ward"); + _; + } + + // --- Init --- + constructor(address dss_, address usr, address god) { + dss = dss_; + wards[usr] = 1; + setOwner(god); + } + + // --- Upgrade --- + function upgrade(address dss_) external auth note { + dss = dss_; + } + + // --- Proxy --- + fallback() external ward note { + address _dss = dss; + assembly { + calldatacopy(0, 0, calldatasize()) + let result := delegatecall(gas(), _dss, 0, calldatasize(), 0, 0) + returndatacopy(0, 0, returndatasize()) + switch result + case 0 { + revert(0, returndatasize()) + } + default { + return(0, returndatasize()) + } + } + } +} diff --git a/src/spy.sol b/src/spy.sol new file mode 100644 index 0000000..59e5470 --- /dev/null +++ b/src/spy.sol @@ -0,0 +1,39 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// spy.sol -- Counter read module + +// Copyright (C) 2022 Horsefacts +// +// 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.15; + +interface SumLike { + function incs(address) external view returns (uint256,uint256,uint256,uint256); +} + +contract Spy { + // --- Data --- + SumLike immutable public sum; + + // --- Init --- + constructor(address sum_) { + sum = SumLike(sum_); + } + + // --- Counter Read --- + function see() external view returns (uint256 net) { + (net,,,) = sum.incs(msg.sender); + } +} diff --git a/src/sum.sol b/src/sum.sol new file mode 100644 index 0000000..048fa6a --- /dev/null +++ b/src/sum.sol @@ -0,0 +1,150 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// sum.sol -- Integer counter value (ICV) database + +// Copyright (C) 2022 Horsefacts +// Copyright (C) 2018 Rain +// +// 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.15; + +import {DSNote} from "ds-note/note.sol"; + +contract Sum is DSNote { + // --- Auth --- + mapping (address => uint) public wards; + function rely(address usr) external auth note { require(live == 1, "Sum/not-live"); wards[usr] = 1; } + function deny(address usr) external auth note { require(live == 1, "Sum/not-live"); wards[usr] = 0; } + modifier auth { + require(wards[msg.sender] == 1, "Sum/not-authorized"); + _; + } + + mapping(address => mapping (address => uint)) public can; + function hope(address usr) external note { can[msg.sender][usr] = 1; } + function nope(address usr) external note { can[msg.sender][usr] = 0; } + function wish(address bit, address usr) internal view returns (bool) { + return either(bit == usr, can[bit][usr] == 1); + } + + // --- Data --- + struct Inc { + uint256 net; // Net counter value + uint256 tab; // Sum of increments + uint256 tax; // Sum of decrements + uint256 num; // Total counter operations + uint256 hop; // Counter increment unit + } + + mapping (address => Inc) public incs; + + uint256 public One; // Global increment parameter + uint256 public live; // Active Flag + + // --- Init --- + constructor() { + wards[msg.sender] = 1; + One = 1; + live = 1; + } + + // --- Math --- + function add(uint x, uint y) internal pure returns (uint z) { + require((z = x + y) >= x); + } + function sub(uint x, uint y) internal pure returns (uint z) { + require((z = x - y) <= x); + } + + // --- Administration --- + function file(bytes32 what, uint data) external note auth { + require(live == 1, "Sum/not-live"); + if (what == "One") { + if (data != 0) One = data; + else revert("Sum/not-allowed-one"); + } + else revert("Sum/file-unrecognized-param"); + } + function cage() external note auth { + live = 0; + } + + function either(bool x, bool y) internal pure returns (bool z) { + assembly{ z := or(x, y)} + } + + // --- ICV Creation --- + function boot(address i) external note { + // system is live + require(live == 1, "Sum/not-live"); + + // caller is allowed + require(wish(i, msg.sender), "Sum/not-allowed"); + + // inc has not been initialised + require(incs[i].hop == 0, "Sum/inc-already-init"); + + incs[i].hop = One; + } + + // --- ICV Reset --- + function zero(address i) external note { + // system is live + require(live == 1, "Sum/not-live"); + + // caller is allowed + require(wish(i, msg.sender), "Sum/not-allowed"); + + Inc memory inc = incs[i]; + // inc has been initialised + require(inc.hop != 0, "Sum/inc-not-init"); + + inc.net = 0; + inc.tab = 0; + inc.tax = 0; + inc.num = add(inc.num, 1); + incs[i] = inc; + } + + // --- ICV Manipulation --- + function frob(address i, int sinc) external note { + // system is live + require(live == 1, "Sum/not-live"); + + // caller is allowed + require(wish(i, msg.sender), "Sum/not-allowed"); + + // sinc is allowed + require(either(sinc == 1, sinc == -1), "Sum/not-allowed-sinc"); + + Inc memory inc = incs[i]; + // inc has been initialised + require(inc.hop != 0, "Sum/inc-not-init"); + + // hop is safe + require(either(sinc == 1, inc.net >= inc.hop), "Sum/not-safe-hop"); + + if (sinc == 1) { + inc.net = add(inc.net, inc.hop); + inc.tab = add(inc.tab, inc.hop); + } + if (sinc == -1) { + inc.net = sub(inc.net, inc.hop); + inc.tax = add(inc.tax, inc.hop); + } + inc.num = add(inc.num, 1); + incs[i] = inc; + } +} diff --git a/src/use.sol b/src/use.sol new file mode 100644 index 0000000..de965fd --- /dev/null +++ b/src/use.sol @@ -0,0 +1,39 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +/// use.sol -- Counter creation module + +// Copyright (C) 2022 Horsefacts +// +// 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.15; + +interface SumLike { + function boot(address) external; +} + +contract Use { + // --- Data --- + SumLike immutable public sum; + + // --- Init --- + constructor(address sum_) { + sum = SumLike(sum_); + } + + // --- Counter Read --- + function use() external{ + sum.boot(msg.sender); + } +} diff --git a/test/dip.t.sol b/test/dip.t.sol new file mode 100644 index 0000000..b4382ef --- /dev/null +++ b/test/dip.t.sol @@ -0,0 +1,102 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Copyright (C) 2022 Horsefacts +// +// 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.13; + +import "forge-std/Test.sol"; + +import {Sum} from "../src/sum.sol"; +import {Dipper} from "../src/dip.sol"; + +contract TestDip is Test { + Sum internal sum; + Dipper internal dipper; + + address me = address(this); + + function setUp() public { + sum = new Sum(); + dipper = new Dipper(address(sum)); + + sum.boot(me); + sum.hope(address(dipper)); + } + + function test_dip() public { + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 5); + assertEq(tab, 5); + assertEq(tax, 0); + assertEq(num, 5); + assertEq(hop, 1); + + dipper.dip(); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 4); + assertEq(tab, 5); + assertEq(tax, 1); + assertEq(num, 6); + assertEq(hop, 1); + + dipper.dip(); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 3); + assertEq(tab, 5); + assertEq(tax, 2); + assertEq(num, 7); + assertEq(hop, 1); + + dipper.dip(); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 2); + assertEq(tab, 5); + assertEq(tax, 3); + assertEq(num, 8); + assertEq(hop, 1); + + dipper.dip(); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 1); + assertEq(tab, 5); + assertEq(tax, 4); + assertEq(num, 9); + assertEq(hop, 1); + + dipper.dip(); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 0); + assertEq(tab, 5); + assertEq(tax, 5); + assertEq(num, 10); + assertEq(hop, 1); + + vm.expectRevert("Sum/not-safe-hop"); + dipper.dip(); + } +} diff --git a/test/dss.t.sol b/test/dss.t.sol new file mode 100644 index 0000000..da36b39 --- /dev/null +++ b/test/dss.t.sol @@ -0,0 +1,484 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Copyright (C) 2022 Horsefacts +// +// 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.13; + +import "forge-std/Test.sol"; + +import {DSS, DSSProxy, DSSLike} from "../src/dss.sol"; +import {Sum} from "../src/sum.sol"; +import {Use} from "../src/use.sol"; +import {Hitter} from "../src/hit.sol"; +import {Dipper} from "../src/dip.sol"; +import {Nil} from "../src/nil.sol"; +import {Spy} from "../src/spy.sol"; + +contract DSSTest is Test { + Sum internal sum; + Use internal use; + Nil internal nil; + Spy internal spy; + + Hitter internal hitter; + Dipper internal dipper; + + DSS internal dss; + + address me = address(this); + address guy = mkaddr('guy'); + address alice = mkaddr('alice'); + address bob = mkaddr('bob'); + address carol = mkaddr('carol'); + address dan = mkaddr('dan'); + address eve = mkaddr('eve'); + + function mkaddr(string memory name) public returns (address addr) { + addr = address(uint160(uint256(keccak256(abi.encodePacked(name))))); + vm.label(addr, name); + } + + function setUp() public { + vm.startPrank(guy); + sum = new Sum(); + use = new Use(address(sum)); + nil = new Nil(address(sum)); + spy = new Spy(address(sum)); + + hitter = new Hitter(address(sum)); + dipper = new Dipper(address(sum)); + + dss = new DSS( + address(sum), + address(use), + address(spy), + address(hitter), + address(dipper), + address(nil) + ); + vm.stopPrank(); + } +} + +contract Examples is DSSTest { + + function test_example_create_basic_counter() public { + // This example demonstrates creating a + // basic counter. + + // Deploy a DSSProxy with Bob as admin + address proxy = dss.build("", bob); + + // Our current address is authorized + // to call the proxy and interact with + // the DSS protocol. We can now create + // a Counter. + DSSLike inc = DSSLike(proxy); + + // First we call bless to authorize + // core DSS modules to call the Sum + // on our behalf. + inc.bless(); + + // Next, we create a new counter. + inc.use(); + + // Our counter starts at zero. + assertEq(inc.see(), 0); + + // We can increment: + inc.hit(); + inc.hit(); + inc.hit(); + assertEq(inc.see(), 3); + + // And decrement: + inc.dip(); + assertEq(inc.see(), 2); + + // As well as reset to zero: + inc.nil(); + assertEq(inc.see(), 0); + } + + function test_example_create_custom_counter_up_only() public { + // This example demonstrates creating a + // custom counter that cannot be decremnted + // or reset. + + // Deploy a DSSProxy with Bob as admin + address proxy = dss.build("", bob); + + // Our current address is authorized + // to call the proxy and interact with + // the DSS protocol. We can now create + // a Counter. + DSSLike inc = DSSLike(proxy); + + // First we call bless to authorize + // core DSS modules to call the Sum + // on our behalf. + inc.bless(); + + // Disable the decrement module + inc.nope(address(dipper)); + + // Disable the reset module + inc.nope(address(nil)); + + // Create a new counter. + inc.use(); + + // Our counter starts at zero. + assertEq(inc.see(), 0); + + // We can increment: + inc.hit(); + inc.hit(); + inc.hit(); + assertEq(inc.see(), 3); + + // We cannot decrement: + vm.expectRevert('Sum/not-allowed'); + inc.dip(); + + // Nor reset to zero: + vm.expectRevert('Sum/not-allowed'); + inc.nil(); + } + + function test_example_proxy_authorization() public { + // This example demonstrates proxy auth. + // The proxy owner may authorize multiple + // callers to interact with DSS. + + // Deploy a DSSProxy with Bob as admin + address proxy = dss.build("", bob); + + // Our current address is authorized + // to call the proxy and interact with + // the DSS protocol. We can now create + // a Counter. + DSSLike inc = DSSLike(proxy); + + // First we call bless to authorize + // core DSS modules to call the Sum + // on our behalf. + inc.bless(); + + // Next, we create a new counter. + inc.use(); + + // Our counter starts at zero. + assertEq(inc.see(), 0); + + // We can increment: + inc.hit(); + assertEq(inc.see(), 1); + + // As the owner of our DSSProxy, Bob + // can authorize other addressess to + // interact with our Counter. However, + // he must use a DSSProxy interface to + // access the authorization functions. + DSSProxy admin = DSSProxy(proxy); + + // Bob grants access to Alice's address + vm.prank(bob); + admin.rely(alice); + + // Now Alice may also increment our Counter. + vm.prank(alice); + inc.hit(); + assertEq(inc.see(), 2); + + // This flexible multi-owner authentication + // system can enable us to create immutable but + // modular contracts that interact with our + // Counter. + } +} + +contract TestDSS is DSSTest { + + function test_dss() public { + // Authorize core modules + dss.bless(); + + // Create a new Counter + dss.use(); + + // Read counter + assertEq(dss.see(), 0); + + // Increment counter + dss.hit(); + assertEq(dss.see(), 1); + + dss.hit(); + assertEq(dss.see(), 2); + + dss.hit(); + assertEq(dss.see(), 3); + + // Reset counter + dss.nil(); + assertEq(dss.see(), 0); + + // Increment counter + dss.hit(); + assertEq(dss.see(), 1); + + dss.hit(); + assertEq(dss.see(), 2); + + // Decrement counter + dss.dip(); + assertEq(dss.see(), 1); + + dss.dip(); + assertEq(dss.see(), 0); + + vm.expectRevert("Sum/not-safe-hop"); + dss.dip(); + } + + function test_nope_hitter() public { + // Authorize core modules + dss.bless(); + + // Create a new Counter + dss.use(); + + // Revoke Hitter + dss.nope(address(hitter)); + + vm.expectRevert("Sum/not-allowed"); + dss.hit(); + } + + function test_nope_dipper() public { + // Authorize core modules + dss.bless(); + + // Create a new Counter + dss.use(); + + // Revoke Hitter + dss.nope(address(dipper)); + + vm.expectRevert("Sum/not-allowed"); + dss.dip(); + } + + function test_nope_nil() public { + // Authorize core modules + dss.bless(); + + // Create a new Counter + dss.use(); + + // Revoke Hitter + dss.nope(address(nil)); + + vm.expectRevert("Sum/not-allowed"); + dss.nil(); + } + + function test_dss_proxy() public { + // Alice is proxy usr, Bob is proxy god + vm.startPrank(alice); + address proxyAddr = dss.build("", bob); + DSSProxy proxy = DSSProxy(proxyAddr); + DSSLike inc = DSSLike(address(proxy)); + vm.stopPrank(); + + // Bob cannot call fallback + vm.prank(bob); + vm.expectRevert("DSSProxy/not-authorized"); + inc.bless(); + + // Eve cannot call fallback + vm.prank(eve); + vm.expectRevert("DSSProxy/not-authorized"); + inc.bless(); + + // Alice can call fallback as ward + vm.startPrank(alice); + + // Authorize core modules + inc.bless(); + + // Create a new Counter + inc.use(); + + // Read counter + assertEq(inc.see(), 0); + + // Increment counter + inc.hit(); + assertEq(inc.see(), 1); + + inc.hit(); + assertEq(inc.see(), 2); + + inc.hit(); + assertEq(inc.see(), 3); + + // Reset counter + inc.nil(); + assertEq(inc.see(), 0); + + // Increment counter + inc.hit(); + assertEq(inc.see(), 1); + + inc.hit(); + assertEq(inc.see(), 2); + + // Decrement counter + inc.dip(); + assertEq(inc.see(), 1); + + inc.dip(); + assertEq(inc.see(), 0); + + vm.expectRevert("Sum/not-safe-hop"); + inc.dip(); + + vm.stopPrank(); + + // Deploy new DSS module + DSS upgraded = new DSS( + address(sum), + address(use), + address(spy), + address(hitter), + address(dipper), + address(nil) + ); + + // Alice cannot upgrade + vm.expectRevert("ds-auth-unauthorized"); + vm.prank(alice); + proxy.upgrade(address(upgraded)); + + // Eve cannot upgrade + vm.expectRevert("ds-auth-unauthorized"); + vm.prank(eve); + proxy.upgrade(address(upgraded)); + + // Bob can upgrade + vm.prank(bob); + proxy.upgrade(address(upgraded)); + + // Allow access + + // Alice cannot add ward + vm.expectRevert("ds-auth-unauthorized"); + vm.prank(alice); + proxy.rely(carol); + + // Eve cannot upgrade + vm.expectRevert("ds-auth-unauthorized"); + vm.prank(eve); + proxy.rely(carol); + + // Bob can add ward + vm.prank(bob); + proxy.rely(carol); + + // Carol can interact with counter + vm.startPrank(carol); + assertEq(inc.see(), 0); + + inc.hit(); + assertEq(inc.see(), 1); + + inc.nil(); + assertEq(inc.see(), 0); + + inc.hit(); + assertEq(inc.see(), 1); + + inc.dip(); + assertEq(inc.see(), 0); + + vm.stopPrank(); + + // Alice can interact with counter + vm.startPrank(alice); + assertEq(inc.see(), 0); + + inc.hit(); + assertEq(inc.see(), 1); + + vm.stopPrank(); + + // Eve cannot interact with counter + vm.expectRevert("DSSProxy/not-authorized"); + vm.prank(eve); + inc.hit(); + + // Revoke Alice's access + vm.prank(bob); + proxy.deny(alice); + + // Alice cannot interact with counter + vm.expectRevert("DSSProxy/not-authorized"); + vm.prank(alice); + inc.hit(); + + // Carol can still interact with counter + vm.startPrank(carol); + + inc.hit(); + assertEq(inc.see(), 2); + + vm.stopPrank(); + + // Proxy ownership transfer + + // Alice cannot transfer + vm.prank(alice); + vm.expectRevert("ds-auth-unauthorized"); + proxy.setOwner(dan); + + // Eve cannot transfer + vm.prank(eve); + vm.expectRevert("ds-auth-unauthorized"); + proxy.setOwner(dan); + + // Bob can transfer + vm.prank(bob); + proxy.setOwner(dan); + + // Dan is now owner + assertEq(proxy.owner(), dan); + + // Bob cannot transfer + vm.prank(bob); + vm.expectRevert("ds-auth-unauthorized"); + proxy.setOwner(bob); + + // Dan can transfer + vm.prank(dan); + proxy.setOwner(bob); + + // Bob is now owner + assertEq(proxy.owner(), bob); + } +} diff --git a/test/gov/ctr.t.sol b/test/gov/ctr.t.sol new file mode 100644 index 0000000..6c32337 --- /dev/null +++ b/test/gov/ctr.t.sol @@ -0,0 +1,46 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Copyright (C) 2022 Horsefacts +// +// 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.4.23 <0.7.0; + +import "forge-std/Test.sol"; + +import {CTR} from "../../src/gov/ctr.sol"; + +contract TestCTR is Test { + CTR internal ctr; + + address me = address(this); + + function setUp() public { + ctr = new CTR(); + } + + function test_symbol() public { + assertEq(ctr.symbol(), "CTR"); + } + + function test_name() public { + assertEq(ctr.name(), "Counter"); + } + + function test_supply() public { + assertEq(ctr.balanceOf(me), ctr.totalSupply()); + assertEq(ctr.totalSupply(), 1_000_000 ether); + } + +} diff --git a/test/hit.t.sol b/test/hit.t.sol new file mode 100644 index 0000000..0354653 --- /dev/null +++ b/test/hit.t.sol @@ -0,0 +1,67 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Copyright (C) 2022 Horsefacts +// +// 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.13; + +import "forge-std/Test.sol"; + +import {Sum} from "../src/sum.sol"; +import {Hitter} from "../src/hit.sol"; + +contract TestHit is Test { + Sum internal sum; + Hitter internal hitter; + + address me = address(this); + + function setUp() public { + sum = new Sum(); + hitter = new Hitter(address(sum)); + + sum.boot(me); + sum.hope(address(hitter)); + } + + function test_hit() public { + hitter.hit(); + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 1); + assertEq(tab, 1); + assertEq(tax, 0); + assertEq(num, 1); + assertEq(hop, 1); + + hitter.hit(); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 2); + assertEq(tab, 2); + assertEq(tax, 0); + assertEq(num, 2); + assertEq(hop, 1); + + hitter.hit(); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 3); + assertEq(tab, 3); + assertEq(tax, 0); + assertEq(num, 3); + assertEq(hop, 1); + } +} diff --git a/test/nil.t.sol b/test/nil.t.sol new file mode 100644 index 0000000..d421ce5 --- /dev/null +++ b/test/nil.t.sol @@ -0,0 +1,63 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Copyright (C) 2022 Horsefacts +// +// 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.13; + +import "forge-std/Test.sol"; + +import {Sum} from "../src/sum.sol"; +import {Nil} from "../src/nil.sol"; + +contract TestNil is Test { + Sum internal sum; + Nil internal nil; + + address me = address(this); + + function setUp() public { + sum = new Sum(); + nil = new Nil(address(sum)); + + sum.boot(me); + sum.hope(address(nil)); + } + + function test_nil() public { + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 5); + assertEq(tab, 5); + assertEq(tax, 0); + assertEq(num, 5); + assertEq(hop, 1); + + nil.nil(); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 0); + assertEq(tab, 0); + assertEq(tax, 0); + assertEq(num, 6); + assertEq(hop, 1); + } +} diff --git a/test/spy.t.sol b/test/spy.t.sol new file mode 100644 index 0000000..20c51a1 --- /dev/null +++ b/test/spy.t.sol @@ -0,0 +1,57 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Copyright (C) 2022 Horsefacts +// +// 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.13; + +import "forge-std/Test.sol"; + +import {Sum} from "../src/sum.sol"; +import {Spy} from "../src/spy.sol"; + +contract TestNil is Test { + Sum internal sum; + Spy internal spy; + + address me = address(this); + + function setUp() public { + sum = new Sum(); + spy = new Spy(address(sum)); + + sum.boot(me); + } + + function test_spy() public { + sum.frob(me, 1); + assertEq(spy.see(), 1); + + sum.frob(me, 1); + assertEq(spy.see(), 2); + + sum.frob(me, 1); + assertEq(spy.see(), 3); + + sum.frob(me, -1); + assertEq(spy.see(), 2); + + sum.frob(me, -1); + assertEq(spy.see(), 1); + + sum.frob(me, -1); + assertEq(spy.see(), 0); + } +} diff --git a/test/sum.t.sol b/test/sum.t.sol new file mode 100644 index 0000000..ce1c073 --- /dev/null +++ b/test/sum.t.sol @@ -0,0 +1,260 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Copyright (C) 2022 Horsefacts +// +// 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.13; + +import "forge-std/Test.sol"; + +import {Sum} from "../src/sum.sol"; + +contract TestSum is Test { + Sum internal sum; + + address me = address(this); + + function setUp() public { + sum = new Sum(); + } + + function test_boot() public { + sum.boot(me); + + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 0); + assertEq(tab, 0); + assertEq(tax, 0); + assertEq(num, 0); + assertEq(hop, 1); + } + + function test_boot_already_init() public { + sum.boot(me); + + vm.expectRevert("Sum/inc-already-init"); + sum.boot(me); + } + + function test_frob_inc() public { + sum.boot(me); + + sum.frob(me, 1); + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 1); + assertEq(tab, 1); + assertEq(tax, 0); + assertEq(num, 1); + assertEq(hop, 1); + + sum.frob(me, 1); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 2); + assertEq(tab, 2); + assertEq(tax, 0); + assertEq(num, 2); + assertEq(hop, 1); + + sum.frob(me, 1); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 3); + assertEq(tab, 3); + assertEq(tax, 0); + assertEq(num, 3); + assertEq(hop, 1); + } + + function test_frob_dec_underflow() public { + sum.boot(me); + + vm.expectRevert("Sum/not-safe-hop"); + sum.frob(me, -1); + } + + function test_frob_dec() public { + sum.boot(me); + + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + sum.frob(me, 1); + + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 5); + assertEq(tab, 5); + assertEq(tax, 0); + assertEq(num, 5); + assertEq(hop, 1); + + sum.frob(me, -1); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 4); + assertEq(tab, 5); + assertEq(tax, 1); + assertEq(num, 6); + assertEq(hop, 1); + + sum.frob(me, -1); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 3); + assertEq(tab, 5); + assertEq(tax, 2); + assertEq(num, 7); + assertEq(hop, 1); + + sum.frob(me, -1); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 2); + assertEq(tab, 5); + assertEq(tax, 3); + assertEq(num, 8); + assertEq(hop, 1); + + sum.frob(me, -1); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 1); + assertEq(tab, 5); + assertEq(tax, 4); + assertEq(num, 9); + assertEq(hop, 1); + + sum.frob(me, -1); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 0); + assertEq(tab, 5); + assertEq(tax, 5); + assertEq(num, 10); + assertEq(hop, 1); + + vm.expectRevert("Sum/not-safe-hop"); + sum.frob(me, -1); + } + + function test_frob_uninitialized_inc() public { + vm.expectRevert("Sum/inc-not-init"); + sum.frob(me, 1); + } + + function test_frob_invalid_sinc(int sinc) public { + vm.assume(sinc != 1); + vm.assume(sinc != -1); + + vm.expectRevert("Sum/not-allowed-sinc"); + sum.frob(me, sinc); + } + + function test_zero() public { + sum.boot(me); + + sum.frob(me, 1); + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 1); + assertEq(tab, 1); + assertEq(tax, 0); + assertEq(num, 1); + assertEq(hop, 1); + + sum.zero(me); + (net, tab, tax, num, hop) = sum.incs(me); + + assertEq(net, 0); + assertEq(tab, 0); + assertEq(tax, 0); + assertEq(num, 2); + assertEq(hop, 1); + } + + function test_file_one() public { + sum.file("One", 2); + + sum.boot(me); + sum.frob(me, 1); + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 2); + assertEq(tab, 2); + assertEq(tax, 0); + assertEq(num, 1); + assertEq(hop, 2); + } + + function test_file_invalid_one() public { + vm.expectRevert("Sum/not-allowed-one"); + sum.file("One", 0); + } + + function test_file_unrecognized_param() public { + vm.expectRevert("Sum/file-unrecognized-param"); + sum.file("Wat", 0); + } + + function test_cage() public { + sum.boot(me); + + sum.cage(); + + vm.expectRevert("Sum/not-live"); + sum.file("One", 1); + + vm.expectRevert("Sum/not-live"); + sum.boot(me); + + vm.expectRevert("Sum/not-live"); + sum.zero(me); + + vm.expectRevert("Sum/not-live"); + sum.frob(me, 1); + + vm.expectRevert("Sum/not-live"); + sum.rely(me); + + vm.expectRevert("Sum/not-live"); + sum.deny(me); + } + + function test_rely_deny() public { + address guy = address(1); + + sum.rely(guy); + assertEq(sum.wards(me), 1); + + sum.deny(guy); + assertEq(sum.wards(guy), 0); + } + + function test_deny_unauthorized() public { + sum.deny(me); + + vm.expectRevert("Sum/not-authorized"); + sum.rely(me); + } + + function test_default_parameters() public { + assertEq(sum.One(), 1); + assertEq(sum.live(), 1); + } +} diff --git a/test/use.t.sol b/test/use.t.sol new file mode 100644 index 0000000..2b190bb --- /dev/null +++ b/test/use.t.sol @@ -0,0 +1,50 @@ +// SPDX-License-Identifier: AGPL-3.0-or-later + +// Copyright (C) 2022 Horsefacts +// +// 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.13; + +import "forge-std/Test.sol"; + +import {Sum} from "../src/sum.sol"; +import {Use} from "../src/use.sol"; + +contract TestUse is Test { + Sum internal sum; + Use internal use; + + address me = address(this); + + function setUp() public { + sum = new Sum(); + use = new Use(address(sum)); + + sum.hope(address(use)); + } + + function test_use() public { + use.use(); + + sum.frob(me, 1); + (uint256 net, uint256 tab, uint256 tax, uint256 num, uint256 hop) = sum.incs(me); + + assertEq(net, 1); + assertEq(tab, 1); + assertEq(tax, 0); + assertEq(num, 1); + assertEq(hop, 1); + } +}