diff --git a/.gitignore b/.gitignore index 1bb15bc..c9acb5b 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,7 @@ # Rendered outputs /tmp +/outputs # AGENTS.md file /AGENTS.md @@ -34,4 +35,3 @@ assets/fonts/**/* !assets/fonts/**/LICENSE !assets/fonts/**/*.ttf - diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index f395843..a9d854d 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,122 @@ -# biscuit +
+ Biscuit + Biscuit +

Biscuit

+

Ethereum smart contracts that generate on-chain metadata

+ CI + License + Solidity + Hardhat + TypeScript + Node + pnpm + Network +
-This repository is initialized with environment setup only. Contract code will be added in subsequent PRs. +--- -## Requirements +## What is Biscuit? -- Node.js 22.10+ (LTS) -- pnpm +Biscuit is a project that generates pseudo mnemonic codes on-chain inspired by [BIP39](https://bips.dev/39/) and turns them into NFTs. -## Setup +BIP39 describes how to add a checksum to entropy and map it to words from a fixed wordlist (commonly used as 12/24-word phrases). + +

⚠️ Warning: This project is for entertainment purposes only. Do not use it to generate real wallet mnemonics. The authors assume no responsibility for any losses resulting from use of this repository.

+

Note: Some SVG previews may render correctly only in Chromium-based browsers.

+ +
+ Biscuit.svg +
+ +## Quick Start ```shell corepack enable +./start.sh +``` + +Manual steps: + +```shell pnpm install +pnpm fonts:prepare +pnpm hardhat compile +pnpm hardhat run scripts/render-svg.mjs ``` -## Environment variables +Outputs are written to `outputs/`. + +## Config Copy `.env.example` to `.env` and fill: - `SEPOLIA_RPC_URL` -- `SEPOLIA_PRIVATE_KEY` - Hardhat loads `.env` automatically via `dotenv/config`. +- `SEPOLIA_PRIVATE_KEY` (never commit this or use a wallet with real funds) -## Lint and format +Hardhat loads `.env` automatically via `dotenv/config`. -```shell -pnpm lint -pnpm lint:sol -pnpm format -pnpm format:check -``` +## Architecture -## Tests +
biscuit/
+├── .github/          # GitHub configuration
+│   └── workflows/    # CI workflows
+├── artifacts/        # Hardhat build artifacts
+├── assets/           # Fonts, wordlists, and branding assets
+│   ├── branding/     # README images
+│   ├── fonts/        # Font sources and subsets
+│   │   ├── caveat/   # Caveat font files
+│   │   └── inter/    # Inter font files
+│   └── mnemonic/     # Wordlists for mnemonic generation
+├── cache/            # Hardhat compiler cache
+├── contracts/        # Solidity contracts and libraries
+│   ├── interfaces/   # Contract interfaces
+│   ├── libs/         # Shared libraries (rendering, utils)
+│   └── test/         # Solidity test harnesses
+├── ignition/         # Hardhat Ignition modules
+├── scripts/          # Node/Hardhat scripts
+├── test/             # TypeScript/Node tests
+│   └── integration/  # Integration tests
+└── outputs/          # Local outputs (generated SVGs, scratch files)
+
-```shell -pnpm test -pnpm test:solidity -pnpm test:node +## Sequence + +```mermaid +sequenceDiagram + actor Operator + actor Client + participant Fonts as Font prep + participant Font as BiscuitFont + participant Mnemonic as Mnemonic + participant Builder as BiscuitBuilder + participant Meta as BiscuitMetadata + participant Renderer as BiscuitRenderer + + Operator->>Fonts: prepare font chunks + Operator->>Font: deploy and upload chunks + Operator->>Mnemonic: deploy and set wordlist + Operator->>Builder: deploy with Font and Mnemonic + Operator->>Builder: lock Font and Mnemonic + + opt Generate seed optional + Client->>Builder: generateSeed tokenId + Builder-->>Client: Seed mnemonicSeed and mnemonicStrength + end + + Client->>Builder: tokenURI tokenId and seed + Builder->>Font: letters + Font-->>Builder: letters bytes + Builder->>Font: digits + Font-->>Builder: digits bytes + Builder->>Mnemonic: generateMnemonic strength and seed + Mnemonic-->>Builder: words + Builder->>Meta: tokenURI with SVG params + Meta->>Renderer: generate SVG + Renderer-->>Meta: raw SVG + Meta-->>Builder: base64 JSON data URI + Builder-->>Client: tokenURI data URI ``` -## Notes +## License -- Solidity contracts and Ignition modules will be added after initial setup. +GPL-3.0 - see [LICENSE](LICENSE). diff --git a/assets/branding/biscuit-caveat-tight.dark.svg b/assets/branding/biscuit-caveat-tight.dark.svg new file mode 100644 index 0000000..9cc445a --- /dev/null +++ b/assets/branding/biscuit-caveat-tight.dark.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/assets/branding/biscuit-caveat-tight.light.svg b/assets/branding/biscuit-caveat-tight.light.svg new file mode 100644 index 0000000..4292dbf --- /dev/null +++ b/assets/branding/biscuit-caveat-tight.light.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/assets/branding/biscuit.svg b/assets/branding/biscuit.svg new file mode 100644 index 0000000..9eaa82a --- /dev/null +++ b/assets/branding/biscuit.svg @@ -0,0 +1,724 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/contracts/BiscuitBuilder.sol b/contracts/BiscuitBuilder.sol index ad02335..16714f4 100644 --- a/contracts/BiscuitBuilder.sol +++ b/contracts/BiscuitBuilder.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; diff --git a/contracts/BiscuitFont.sol b/contracts/BiscuitFont.sol index f14ff13..b5df992 100644 --- a/contracts/BiscuitFont.sol +++ b/contracts/BiscuitFont.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; diff --git a/contracts/BiscuitToken.sol b/contracts/BiscuitToken.sol index 830c6f3..aa017bd 100644 --- a/contracts/BiscuitToken.sol +++ b/contracts/BiscuitToken.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; diff --git a/contracts/DESIGN.md b/contracts/DESIGN.md new file mode 100644 index 0000000..b368a60 --- /dev/null +++ b/contracts/DESIGN.md @@ -0,0 +1,67 @@ +# Contracts Design + +## Purpose + +This directory contains the on-chain system for the Biscuit NFT. It provides: + +- An ERC-721A token contract with mint/burn controls. +- Deterministic seed generation per token. +- SVG rendering and JSON metadata generation entirely on-chain. +- Font and mnemonic wordlist storage optimized for gas. + +## Core Components + +- `BiscuitToken.sol` + - ERC721A token with max supply and fixed mint price. + - Stores a seed per token at mint time. + - Delegates metadata/SVG rendering to the builder. + - Owner-controlled mint/burn toggles and royalty settings. +- `BiscuitBuilder.sol` + - Holds references to `BiscuitFont` and `Mnemonic`. + - Generates token seeds and assembles SVG/metadata via libraries. + - Supports locking font/mnemonic references to prevent changes. +- `BiscuitFont.sol` + - Stores font data in SSTORE2-backed pages for letters and digits. + - Concatenates pages on read to serve woff2 payloads. +- `Mnemonic.sol` + - Stores a BIP-39 wordlist and exposes mnemonic generation. + - Locks wordlist when complete to prevent mutation. + +## Libraries and Interfaces + +- `libs/BiscuitRenderer.sol` + - Pure SVG generator for the 4x6 mnemonic grid. +- `libs/BiscuitMetadata.sol` + - Builds base64 JSON metadata with SVG image and attributes. +- `libs/BIP39.sol`, `libs/BIP39Storage.sol` + - Wordlist storage and mnemonic derivation. +- `libs/SSTORE2.sol`, `libs/Memory.sol` + - Optimized storage and memory copy utilities. +- `interfaces/*` + - Narrow interfaces to avoid coupling and simplify testing. + +## Data Flow + +1. `BiscuitToken.safeMint` generates and stores a seed for each token. +2. `BiscuitToken.tokenURI` calls `BiscuitBuilder.tokenURI` with the seed. +3. `BiscuitBuilder` pulls font/mnemonic data and renders SVG + metadata. +4. `BiscuitMetadata` base64-encodes the SVG and JSON response. + +## Invariants and Controls + +- `MAX_SUPPLY` and `PRICE` are constants enforced at mint time. +- Minting and burning are gated by owner toggles. +- Builder, font, and mnemonic references can be locked permanently. +- Wordlist can be locked only when complete (2048 words). + +## Security Considerations + +- Minting uses `ReentrancyGuard` for ETH safety. +- Rendering is pure/read-only and does not mutate state. +- External calls are limited to known contracts and libraries. + +## Extending + +- Keep SVG rendering in libraries to avoid contract bloat. +- New traits or visual elements should be added in `BiscuitRenderer` and + surfaced through `BiscuitMetadata` attributes. diff --git a/contracts/Mnemonic.sol b/contracts/Mnemonic.sol index 69f8607..4a96576 100644 --- a/contracts/Mnemonic.sol +++ b/contracts/Mnemonic.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; diff --git a/contracts/interfaces/DESIGN.md b/contracts/interfaces/DESIGN.md new file mode 100644 index 0000000..bd784ae --- /dev/null +++ b/contracts/interfaces/DESIGN.md @@ -0,0 +1,23 @@ +# Interfaces Design + +## Purpose + +Defines the minimal public surfaces for the core contracts. These interfaces +reduce coupling and enable testing/mocking without full contract imports. + +## Contents + +- `IBiscuitBuilder.sol` + - Builder entry points for SVG/metadata generation and seed handling. +- `IBiscuitFont.sol` + - Font storage and retrieval API for letters/digits. +- `IBiscuitToken.sol` + - Token-facing interface for builder integration. +- `IMnemonic.sol` + - Mnemonic generation interface used by the builder. + +## Guidelines + +- Keep interfaces minimal and stable. +- Use interfaces in contracts and tests to avoid circular dependencies. +- When adding new external functions, update the interface first. diff --git a/contracts/interfaces/IBiscuitBuilder.sol b/contracts/interfaces/IBiscuitBuilder.sol index a38ebb2..7df4644 100644 --- a/contracts/interfaces/IBiscuitBuilder.sol +++ b/contracts/interfaces/IBiscuitBuilder.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; interface IBiscuitBuilder { diff --git a/contracts/interfaces/IBiscuitFont.sol b/contracts/interfaces/IBiscuitFont.sol index 40fd784..9ccb749 100644 --- a/contracts/interfaces/IBiscuitFont.sol +++ b/contracts/interfaces/IBiscuitFont.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; interface IBiscuitFont { diff --git a/contracts/interfaces/IBiscuitToken.sol b/contracts/interfaces/IBiscuitToken.sol index 39e1aee..290dc39 100644 --- a/contracts/interfaces/IBiscuitToken.sol +++ b/contracts/interfaces/IBiscuitToken.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; interface IBiscuitToken { diff --git a/contracts/interfaces/IMnemonic.sol b/contracts/interfaces/IMnemonic.sol index efe85cf..f43ebeb 100644 --- a/contracts/interfaces/IMnemonic.sol +++ b/contracts/interfaces/IMnemonic.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; interface IMnemonic { diff --git a/contracts/libs/BIP39.sol b/contracts/libs/BIP39.sol index 4c90736..17f3899 100644 --- a/contracts/libs/BIP39.sol +++ b/contracts/libs/BIP39.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {BIP39Storage} from "./BIP39Storage.sol"; diff --git a/contracts/libs/BIP39Storage.sol b/contracts/libs/BIP39Storage.sol index d466237..2bb0c24 100644 --- a/contracts/libs/BIP39Storage.sol +++ b/contracts/libs/BIP39Storage.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {SSTORE2} from "./SSTORE2.sol"; diff --git a/contracts/libs/BiscuitRenderer.sol b/contracts/libs/BiscuitRenderer.sol index da86640..d0ef598 100644 --- a/contracts/libs/BiscuitRenderer.sol +++ b/contracts/libs/BiscuitRenderer.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; // solhint-disable quotes @@ -15,13 +15,16 @@ library BiscuitRenderer { uint256 private constant _ROWS = 6; /// @notice Horizontal offset when duplicating columns - uint256 private constant _STEP_X = 103; + uint256 private constant _STEP_X = 110; /// @notice Vertical offset when duplicating rows uint256 private constant _STEP_Y = 24; /// @notice Offset in X direction from index number to start drawing word - uint256 private constant _LETTERS_START_OFFSET_X = 10; + uint256 private constant _LETTERS_START_OFFSET_X = 8; + + /// @notice Vertical offset for lines and mnemonic baseline relative to index + uint256 private constant _LINE_AND_WORD_OFFSET_Y = 2; struct SVGParams { bytes letters; // Caveat Font (base64) @@ -37,7 +40,7 @@ library BiscuitRenderer { string( // prettier-ignore abi.encodePacked( - '', + '', '', '', - '', + '', _generatePathRow(), '', - '', - '', + '', + '', _generatePathColumn(), _generateArt(params.mnemonic), '', @@ -93,7 +99,11 @@ library BiscuitRenderer { '', (idx + 1).toString(), ". ", - '', + '', idx < dataLength ? data[idx] : "", "" ); @@ -130,7 +140,7 @@ library BiscuitRenderer { // prettier-ignore colPaths = abi.encodePacked( colPaths, - '' + '' ); } return abi.encodePacked('', colPaths, ""); diff --git a/contracts/libs/DESIGN.md b/contracts/libs/DESIGN.md new file mode 100644 index 0000000..3493b82 --- /dev/null +++ b/contracts/libs/DESIGN.md @@ -0,0 +1,33 @@ +# Libraries Design + +## Purpose + +Provides reusable, mostly pure utilities used across the contracts. Libraries +keep core contracts small and make functionality easier to test in isolation. + +## Contents + +- `BiscuitRenderer.sol` + - SVG layout generator for the mnemonic grid. +- `BiscuitMetadata.sol` + - JSON metadata construction and base64 encoding. +- `BIP39.sol` and `BIP39Storage.sol` + - Mnemonic derivation and wordlist storage helpers. +- `SSTORE2.sol` + - Minimal storage contract for cheap byte persistence. +- `Memory.sol` + - Memory copy utilities for concatenation. +- `Utils.sol` + - Small helper utilities (randomness, formatting, etc.). + +## Design Notes + +- Libraries are used by contracts via `internal` calls to avoid external calls. +- Rendering is purely functional and deterministic given input parameters. +- Storage helpers are optimized for gas and on-chain byte assembly. + +## Guidelines + +- Keep new functionality pure when possible. +- Avoid stateful logic in libraries; prefer contracts for state. +- Add harness contracts under `contracts/test/` for library testing. diff --git a/contracts/libs/Utils.sol b/contracts/libs/Utils.sol index 32ef53c..e3b518f 100644 --- a/contracts/libs/Utils.sol +++ b/contracts/libs/Utils.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; library Utils { diff --git a/contracts/test/BIP39Harness.sol b/contracts/test/BIP39Harness.sol index d3a8a18..4c72c26 100644 --- a/contracts/test/BIP39Harness.sol +++ b/contracts/test/BIP39Harness.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {BIP39} from "../libs/BIP39.sol"; diff --git a/contracts/test/BIP39StorageHarness.sol b/contracts/test/BIP39StorageHarness.sol index bc2a7ee..a9e469e 100644 --- a/contracts/test/BIP39StorageHarness.sol +++ b/contracts/test/BIP39StorageHarness.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {BIP39Storage} from "../libs/BIP39Storage.sol"; diff --git a/contracts/test/BiscuitRendererHarness.sol b/contracts/test/BiscuitRendererHarness.sol index 8099550..91c0128 100644 --- a/contracts/test/BiscuitRendererHarness.sol +++ b/contracts/test/BiscuitRendererHarness.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {BiscuitRenderer} from "../libs/BiscuitRenderer.sol"; diff --git a/contracts/test/DESIGN.md b/contracts/test/DESIGN.md new file mode 100644 index 0000000..21187d4 --- /dev/null +++ b/contracts/test/DESIGN.md @@ -0,0 +1,26 @@ +# Contract Test Harnesses Design + +## Purpose + +This directory holds Solidity harnesses and mocks used by the TypeScript test +suite. They expose internal library functions or simulate edge cases that are +hard to reach through production contracts. + +## Contents + +- `BiscuitRendererHarness.sol` and `BiscuitMetadataHarness.sol` + - Surface library functions for SVG/metadata tests. +- `BIP39Harness.sol` and `BIP39StorageHarness.sol` + - Exercise mnemonic logic and wordlist storage. +- `SSTORE2Harness.sol`, `UtilsHarness.sol` + - Validate helper libraries in isolation. +- `MockMnemonic.sol` + - Minimal mnemonic implementation for unit tests. +- `StopCode.sol` + - Utility contract used by SSTORE2 tests. + +## Guidelines + +- Harnesses should be minimal and deterministic. +- Avoid adding production logic here. +- Prefer explicit, narrow test helpers over general-purpose mocks. diff --git a/contracts/test/MockMnemonic.sol b/contracts/test/MockMnemonic.sol index 1f4b986..a892b70 100644 --- a/contracts/test/MockMnemonic.sol +++ b/contracts/test/MockMnemonic.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {IMnemonic} from "../interfaces/IMnemonic.sol"; diff --git a/contracts/test/SSTORE2Harness.sol b/contracts/test/SSTORE2Harness.sol index 1ab86a7..f8aeb75 100644 --- a/contracts/test/SSTORE2Harness.sol +++ b/contracts/test/SSTORE2Harness.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {SSTORE2} from "../libs/SSTORE2.sol"; diff --git a/contracts/test/StopCode.sol b/contracts/test/StopCode.sol index 6ab05c1..f799bda 100644 --- a/contracts/test/StopCode.sol +++ b/contracts/test/StopCode.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; /// @title STOP Code Contract diff --git a/contracts/test/UtilsHarness.sol b/contracts/test/UtilsHarness.sol index 7a258d5..589e0e1 100644 --- a/contracts/test/UtilsHarness.sol +++ b/contracts/test/UtilsHarness.sol @@ -1,4 +1,4 @@ -// SPDX-License-Identifier: MIT +// SPDX-License-Identifier: GPL-3.0 pragma solidity ^0.8.28; import {Utils} from "../libs/Utils.sol"; diff --git a/scripts/DESIGN.md b/scripts/DESIGN.md new file mode 100644 index 0000000..022a026 --- /dev/null +++ b/scripts/DESIGN.md @@ -0,0 +1,45 @@ +# Scripts Design + +## Purpose + +This directory contains Node/Hardhat utilities used to prepare assets, deploy +supporting contracts, and generate SVG outputs for local verification. + +## Script Inventory + +- `prepare-fonts.mjs` + - Subsets and chunks the font files used by the renderer. + - Produces JSON chunk files in `assets/fonts/*`. +- `deploy-fonts.mjs` + - Deploys `BiscuitFont` and uploads letter/digit chunks. + - Can also append chunks to an existing `BiscuitFont` address. +- `render-svg.mjs` + - Deploys a renderer harness and writes a simple SVG to `outputs/`. +- `render-svg-fake-mnemonic.mjs` + - Deploys `Mnemonic`, `BiscuitFont`, and `BiscuitBuilder` on a local network. + - Loads a fake wordlist and renders a mnemonic SVG to `outputs/`. +- `generate-fake-mnemonic-wordlist.mjs` + - Builds a deterministic fake 2048-word list for local tests. +- `check-data-uri.mjs` + - Sanity-checks data URIs produced by metadata/image renderers. +- `lint-sol.mjs` + - Runs `solhint` with repo configuration. + +## Inputs and Outputs + +- Inputs: font assets under `assets/fonts/*` and wordlists under + `assets/mnemonic/*`. +- Outputs: SVG files under `outputs/` and chunked fonts under `assets/fonts/*`. + +## Network Assumptions + +- Many scripts use `hardhat`'s in-process network by default. +- For a persistent local node, start it with `pnpm hardhat node` and run + scripts with `--network localhost`. + +## Notes + +- When Solidity changes, run `pnpm hardhat compile` before running + render/deploy scripts to avoid stale artifacts. +- `render-svg-fake-mnemonic.mjs` uses random seeds, so output is non-deterministic + unless the script is modified to accept a fixed seed. diff --git a/scripts/render-svg-fake-mnemonic.mjs b/scripts/render-svg-fake-mnemonic.mjs index fd2a657..d98dffd 100644 --- a/scripts/render-svg-fake-mnemonic.mjs +++ b/scripts/render-svg-fake-mnemonic.mjs @@ -2,6 +2,7 @@ import { network } from "hardhat"; import { readFile, mkdir, writeFile } from "node:fs/promises"; import { dirname } from "node:path"; import { randomBytes } from "node:crypto"; +import { fileURLToPath } from "node:url"; import { keccak256, stringToHex, toHex } from "viem"; const WORDLIST_PATH = new URL("../assets/mnemonic/fake-wordlist.json", import.meta.url); @@ -13,7 +14,8 @@ const DIGITS_CHUNKS_PATH = new URL( "../assets/fonts/inter/Inter.subset.chunks.json", import.meta.url, ); -const OUT_PATH = "/Users/xx/Developer/biscuit/tmp/fake-mnemonic.svg"; +const OUT_URL = new URL("../outputs/fake-mnemonic.svg", import.meta.url); +const OUT_PATH = fileURLToPath(OUT_URL); const loadWordlist = async () => { const raw = await readFile(WORDLIST_PATH, "utf8"); diff --git a/scripts/render-svg.mjs b/scripts/render-svg.mjs index cbf7ac8..e717e12 100644 --- a/scripts/render-svg.mjs +++ b/scripts/render-svg.mjs @@ -1,18 +1,59 @@ import { network } from "hardhat"; import { stringToHex } from "viem"; -import { mkdir, writeFile } from "node:fs/promises"; +import { mkdir, writeFile, readFile } from "node:fs/promises"; import { dirname } from "node:path"; +import { fileURLToPath } from "node:url"; +import { randomInt } from "node:crypto"; const { viem } = await network.connect(); const renderer = await viem.deployContract("BiscuitRendererHarness"); -const letters = stringToHex("QUJD"); -const digits = stringToHex("REVG"); -const mnemonic = ["alpha", "beta", "gamma", "delta"]; +const LETTERS_WOFF2 = new URL("../assets/fonts/caveat/Caveat-Bold.subset.woff2", import.meta.url); +const DIGITS_WOFF2 = new URL("../assets/fonts/inter/Inter.subset.woff2", import.meta.url); +const WORDLIST = new URL("../assets/mnemonic/fake-wordlist.json", import.meta.url); + +const loadBase64 = async (path, label) => { + let raw; + try { + raw = await readFile(path); + } catch (err) { + throw new Error(`${label} font missing. Run "pnpm fonts:prepare" to generate woff2 files.`, { + cause: err, + }); + } + return raw.toString("base64"); +}; + +const loadWordlist = async () => { + const raw = await readFile(WORDLIST, "utf8"); + const list = JSON.parse(raw); + if (!Array.isArray(list)) { + throw new Error("fake-wordlist.json must be an array"); + } + if (list.length < 24) { + throw new Error(`fake-wordlist.json must have at least 24 entries (got ${list.length})`); + } + return list.map((word) => String(word)); +}; + +const pickRandomWords = (words, count) => { + const selection = words.slice(); + for (let i = selection.length - 1; i > 0; i -= 1) { + const j = randomInt(i + 1); + [selection[i], selection[j]] = [selection[j], selection[i]]; + } + return selection.slice(0, count); +}; + +const letters = stringToHex(await loadBase64(LETTERS_WOFF2, "Letters")); +const digits = stringToHex(await loadBase64(DIGITS_WOFF2, "Digits")); +const wordCount = (randomInt(8) + 1) * 3; +const mnemonic = pickRandomWords(await loadWordlist(), wordCount); const svg = await renderer.read.generateSVG([letters, digits, mnemonic]); -const outPath = "/Users/xx/Developer/biscuit/tmp/biscuit.svg"; +const outUrl = new URL("../outputs/biscuit.svg", import.meta.url); +const outPath = fileURLToPath(outUrl); await mkdir(dirname(outPath), { recursive: true }); await writeFile(outPath, svg, "utf8"); diff --git a/start.sh b/start.sh new file mode 100755 index 0000000..5fc7f29 --- /dev/null +++ b/start.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash +set -euo pipefail + +ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +cd "$ROOT_DIR" + +if [ ! -f .env ]; then + if [ -f .env.example ]; then + cp .env.example .env + echo "Created .env from .env.example" + else + echo "No .env.example found; skipping .env creation" + fi +fi + +pnpm install +pnpm fonts:prepare +pnpm hardhat compile +pnpm hardhat run scripts/render-svg.mjs diff --git a/test/DESIGN.md b/test/DESIGN.md new file mode 100644 index 0000000..746c249 --- /dev/null +++ b/test/DESIGN.md @@ -0,0 +1,41 @@ +# Test Design + +## Purpose + +Tests validate the on-chain components and supporting libraries. Coverage is +split between contract unit tests and broader integration checks. + +## Layout + +- Root `test/` files focus on unit-level behavior for each contract or library. +- `test/integration/` contains end-to-end scenarios that exercise deployment + and cross-contract interactions. + +## Current Test Areas + +- `biscuit-token.test.ts` + - Mint/burn flows, royalties, and metadata delegation. +- `biscuit-builder.test.ts` + - Seed handling, SVG/metadata generation, and lock behavior. +- `biscuit-font.test.ts` + - Chunk storage, concatenation, and edge cases. +- `mnemonic.test.ts` and `bip39*.test.ts` + - Wordlist management, mnemonic generation, and validation. +- `biscuit-renderer.test.ts` and `biscuit-metadata.test.ts` + - SVG output shape, attribute generation, and data URI formatting. +- `utils.test.ts` + - Supporting helper behaviors. + +## Execution + +- Run all tests: `pnpm test` +- Solidity-focused: `pnpm test:solidity` +- Node-focused: `pnpm test:node` + +## Principles + +- Tests should avoid network dependencies outside the Hardhat local runtime. +- Rendering tests should assert stable structural output rather than brittle + string matches when possible. +- Integration tests should validate that the full pipeline + (seed -> SVG -> metadata) works end to end. diff --git a/test/biscuit-renderer.test.ts b/test/biscuit-renderer.test.ts index eb4370c..d2515ae 100644 --- a/test/biscuit-renderer.test.ts +++ b/test/biscuit-renderer.test.ts @@ -15,9 +15,9 @@ describe("BiscuitRenderer (unit)", async () => { assert.equal((rowStr.match(/href="#path"/g) || []).length, 4); assert.ok(rowStr.includes('x="0"')); - assert.ok(rowStr.includes('x="103"')); - assert.ok(rowStr.includes('x="206"')); - assert.ok(rowStr.includes('x="309"')); + assert.ok(rowStr.includes('x="110"')); + assert.ok(rowStr.includes('x="220"')); + assert.ok(rowStr.includes('x="330"')); }); it("generatePathColumn: renders 6 row uses", async () => { @@ -26,12 +26,12 @@ describe("BiscuitRenderer (unit)", async () => { const columnStr = hexToUtf8(column); assert.equal((columnStr.match(/href="#row"/g) || []).length, 6); - assert.ok(columnStr.includes('y="0"')); - assert.ok(columnStr.includes('y="24"')); - assert.ok(columnStr.includes('y="48"')); - assert.ok(columnStr.includes('y="72"')); - assert.ok(columnStr.includes('y="96"')); - assert.ok(columnStr.includes('y="120"')); + assert.ok(columnStr.includes('y="2"')); + assert.ok(columnStr.includes('y="26"')); + assert.ok(columnStr.includes('y="50"')); + assert.ok(columnStr.includes('y="74"')); + assert.ok(columnStr.includes('y="98"')); + assert.ok(columnStr.includes('y="122"')); }); it("generateArt: renders 24 indices and supplied words", async () => { diff --git a/test/integration/DESIGN.md b/test/integration/DESIGN.md new file mode 100644 index 0000000..322d76e --- /dev/null +++ b/test/integration/DESIGN.md @@ -0,0 +1,18 @@ +# Integration Tests Design + +## Purpose + +Integration tests validate that multiple contracts work together as a system. +They focus on deployment flow, cross-contract wiring, and end-to-end rendering. + +## Coverage + +- Full stack deployments with builder, font, and mnemonic contracts. +- Rendering pipelines from seed to SVG and metadata. +- Font upload and retrieval behavior under realistic usage. + +## Guidelines + +- Keep test setup explicit and reproducible. +- Prefer realistic data flows over heavy mocking. +- Assert on structural output instead of full string equality when possible. diff --git a/test/integration/biscuit-font-render.test.ts b/test/integration/biscuit-font-render.test.ts index 65b67a0..767f269 100644 --- a/test/integration/biscuit-font-render.test.ts +++ b/test/integration/biscuit-font-render.test.ts @@ -72,8 +72,8 @@ describe("BiscuitFont (integration, real fonts)", async () => { const json = JSON.parse(decodeBase64(encoded)) as { image: string; name: string }; assert.equal(json.name, "Biscuit #1"); - await mkdir("tmp", { recursive: true }); - await writeFile("tmp/biscuit-font-real.svg", svg, "utf8"); - await writeFile("tmp/biscuit-font-real.json", JSON.stringify(json, null, 2), "utf8"); + await mkdir("outputs", { recursive: true }); + await writeFile("outputs/biscuit-font-real.svg", svg, "utf8"); + await writeFile("outputs/biscuit-font-real.json", JSON.stringify(json, null, 2), "utf8"); }); });