diff --git a/packages/codegen/README.md b/packages/codegen/README.md index da6826539..fe4da1f17 100644 --- a/packages/codegen/README.md +++ b/packages/codegen/README.md @@ -52,6 +52,10 @@ Steps: # Watcher server port (default: 3008). port: 3008 + # Solc version to use (optional) + # If not defined, uses solc version listed in dependencies + solc: v0.8.0+commit.c7dfd78e + # Flatten the input contract file(s) [true | false] (default: true). flatten: true @@ -72,6 +76,8 @@ Steps: * `config-file`(alias: `c`): Watcher generation config file path (yaml) (required). + * `continue-on-error` (alias: `e`): To continue generation if any unhandled data type is encountered (optional). + Example: * Generate code using a config file `config.yaml`: @@ -80,6 +86,12 @@ Steps: yarn codegen --config-file ./config.yaml ``` + * Generate code ignoring any unhandled data types: + + ```bash + yarn codegen --config-file ./config.yaml --continue-on-error + ``` + This will create a folder containing the generated code at the path provided in config. Follow the steps in [Run Generated Watcher](#run-generated-watcher) to setup and run the generated watcher. ## Development diff --git a/packages/codegen/src/assets/.gitignore b/packages/codegen/src/assets/.gitignore new file mode 100644 index 000000000..0b4cc3f66 --- /dev/null +++ b/packages/codegen/src/assets/.gitignore @@ -0,0 +1,6 @@ +node_modules/ +dist/ +out/ + +.vscode +.idea diff --git a/packages/codegen/src/assets/LICENSE b/packages/codegen/src/assets/LICENSE new file mode 100644 index 000000000..331f7cfab --- /dev/null +++ b/packages/codegen/src/assets/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/packages/codegen/src/client.ts b/packages/codegen/src/client.ts index 960c6b8d2..80e5cdab6 100644 --- a/packages/codegen/src/client.ts +++ b/packages/codegen/src/client.ts @@ -10,8 +10,9 @@ import { Writable } from 'stream'; import _ from 'lodash'; import { gqlGenerate } from 'gql-generator'; -import { getTsForSol } from './utils/type-mappings'; +import { getGqlForSol, getTsForGql } from './utils/type-mappings'; import { Param } from './utils/types'; +import { getBaseType } from './utils/helpers'; const TEMPLATE_FILE = './templates/client-template.handlebars'; @@ -30,12 +31,15 @@ export class Client { * @param params Parameters to the query. * @param returnType Return type for the query. */ - addQuery (name: string, params: Array, returnType: string): void { + addQuery (name: string, params: Array, typeName: any): void { // Check if the query is already added. if (this._queries.some(query => query.name === name)) { return; } + const returnType = getBaseType(typeName); + assert(returnType); + const queryObject = { name, getQueryName: '', @@ -48,13 +52,17 @@ export class Client { : `get${name.charAt(0).toUpperCase()}${name.slice(1)}`; queryObject.params = queryObject.params.map((param) => { - const tsParamType = getTsForSol(param.type); + const gqlParamType = getGqlForSol(param.type); + assert(gqlParamType); + const tsParamType = getTsForGql(gqlParamType); assert(tsParamType); param.type = tsParamType; return param; }); - const tsReturnType = getTsForSol(returnType); + const gqlReturnType = getGqlForSol(returnType); + assert(gqlReturnType); + const tsReturnType = getTsForGql(gqlReturnType); assert(tsReturnType); queryObject.returnType = tsReturnType; diff --git a/packages/codegen/src/database.ts b/packages/codegen/src/database.ts index 86b2819f9..b586d6877 100644 --- a/packages/codegen/src/database.ts +++ b/packages/codegen/src/database.ts @@ -9,8 +9,9 @@ import Handlebars from 'handlebars'; import { Writable } from 'stream'; import _ from 'lodash'; -import { getTsForSol } from './utils/type-mappings'; +import { getGqlForSol, getTsForGql } from './utils/type-mappings'; import { Param } from './utils/types'; +import { getBaseType } from './utils/helpers'; const TEMPLATE_FILE = './templates/database-template.handlebars'; @@ -31,12 +32,15 @@ export class Database { * @param params Parameters to the query. * @param returnType Return type for the query. */ - addQuery (name: string, params: Array, returnType: string): void { + addQuery (name: string, params: Array, typeName: any): void { // Check if the query is already added. if (this._queries.some(query => query.name === name)) { return; } + const returnType = getBaseType(typeName); + assert(returnType); + const queryObject = { name, entityName: '', @@ -61,16 +65,20 @@ export class Database { } queryObject.params = queryObject.params.map((param) => { - const tsParamType = getTsForSol(param.type); + const gqlParamType = getGqlForSol(param.type); + assert(gqlParamType); + const tsParamType = getTsForGql(gqlParamType); assert(tsParamType); param.type = tsParamType; return param; }); - const tsReturnType = getTsForSol(returnType); + const gqlReturnType = getGqlForSol(returnType); + assert(gqlReturnType); + const tsReturnType = getTsForGql(gqlReturnType); assert(tsReturnType); - queryObject.returnType = tsReturnType; + queryObject.returnType = tsReturnType; this._queries.push(queryObject); } diff --git a/packages/codegen/src/entity.ts b/packages/codegen/src/entity.ts index 5180f6481..2338f2957 100644 --- a/packages/codegen/src/entity.ts +++ b/packages/codegen/src/entity.ts @@ -9,9 +9,10 @@ import yaml from 'js-yaml'; import Handlebars from 'handlebars'; import { Writable } from 'stream'; -import { getTsForSol, getPgForTs, getTsForGql } from './utils/type-mappings'; +import { getPgForTs, getTsForGql, getGqlForSol } from './utils/type-mappings'; import { Param } from './utils/types'; import { getFieldType } from './utils/subgraph'; +import { getBaseType } from './utils/helpers'; const TEMPLATE_FILE = './templates/entity-template.handlebars'; const TABLES_DIR = './data/entities'; @@ -31,7 +32,7 @@ export class Entity { * @param params Parameters to the query. * @param returnType Return type for the query. */ - addQuery (name: string, params: Array, returnType: string): void { + addQuery (name: string, params: Array, typeName: any): void { // Check if the query is already added. if (this._entities.some(entity => entity.className.toLowerCase() === name.toLowerCase())) { return; @@ -109,9 +110,10 @@ export class Entity { params.map((param) => { const name = param.name; - const tsType = getTsForSol(param.type); + const gqlType = getGqlForSol(param.type); + assert(gqlType); + const tsType = getTsForGql(gqlType); assert(tsType); - const pgType = getPgForTs(tsType); assert(pgType); @@ -136,9 +138,13 @@ export class Entity { }) ); - const tsReturnType = getTsForSol(returnType); - assert(tsReturnType); + const baseType = getBaseType(typeName); + assert(baseType); + const gqlReturnType = getGqlForSol(baseType); + assert(gqlReturnType); + const tsReturnType = getTsForGql(gqlReturnType); + assert(tsReturnType); const pgReturnType = getPgForTs(tsReturnType); assert(pgReturnType); diff --git a/packages/codegen/src/generate-code.ts b/packages/codegen/src/generate-code.ts index 74ac5f4fb..d2ed4a4a4 100644 --- a/packages/codegen/src/generate-code.ts +++ b/packages/codegen/src/generate-code.ts @@ -38,6 +38,9 @@ import { getSubgraphConfig } from './utils/subgraph'; import { exportIndexBlock } from './index-block'; import { exportSubscriber } from './subscriber'; import { exportReset } from './reset'; +import { writeFileToStream } from './utils/helpers'; + +const ASSET_DIR = path.resolve(__dirname, 'assets'); const main = async (): Promise => { const argv = await yargs(hideBin(process.argv)) @@ -234,6 +237,16 @@ function generateWatcher (visitor: Visitor, contracts: any[], config: any) { : process.stdout; exportReadme(path.basename(outputDir), config.port, outStream); + outStream = outputDir + ? fs.createWriteStream(path.join(outputDir, 'LICENSE')) + : process.stdout; + writeFileToStream(path.join(ASSET_DIR, 'LICENSE'), outStream); + + outStream = outputDir + ? fs.createWriteStream(path.join(outputDir, '.gitignore')) + : process.stdout; + writeFileToStream(path.join(ASSET_DIR, '.gitignore'), outStream); + outStream = outputDir ? fs.createWriteStream(path.join(outputDir, 'src/job-runner.ts')) : process.stdout; diff --git a/packages/codegen/src/indexer.ts b/packages/codegen/src/indexer.ts index 3b1aa6633..8bcea1404 100644 --- a/packages/codegen/src/indexer.ts +++ b/packages/codegen/src/indexer.ts @@ -9,10 +9,11 @@ import Handlebars from 'handlebars'; import { Writable } from 'stream'; import _ from 'lodash'; -import { getTsForSol } from './utils/type-mappings'; +import { getGqlForSol, getTsForGql } from './utils/type-mappings'; import { Param } from './utils/types'; import { MODE_ETH_CALL, MODE_STORAGE } from './utils/constants'; import { getFieldType } from './utils/subgraph'; +import { getBaseType, isArrayType } from './utils/helpers'; const TEMPLATE_FILE = './templates/indexer-template.handlebars'; @@ -37,22 +38,35 @@ export class Indexer { * @param returnType Return type for the query. * @param stateVariableType Type of the state variable in case of state variable query. */ - addQuery (contract: string, mode: string, name: string, params: Array, returnType: string, stateVariableType?: string): void { + addQuery (contract: string, mode: string, name: string, params: Array, typeName: any, stateVariableType?: string): void { // Check if the query is already added. if (this._queries.some(query => query.name === name)) { return; } + const baseType = getBaseType(typeName); + assert(baseType); + const gqlReturnType = getGqlForSol(baseType); + assert(gqlReturnType); + let tsReturnType = getTsForGql(gqlReturnType); + assert(tsReturnType); + + const isArray = isArrayType(typeName); + if (isArray) { + tsReturnType = tsReturnType.concat('[]'); + } + const queryObject = { name, entityName: '', getQueryName: '', saveQueryName: '', params: _.cloneDeep(params), - returnType, + returnType: tsReturnType, mode, stateVariableType, - contract + contract, + disableCaching: isArray }; if (name.charAt(0) === '_') { @@ -68,16 +82,14 @@ export class Indexer { } queryObject.params = queryObject.params.map((param) => { - const tsParamType = getTsForSol(param.type); + const gqlParamType = getGqlForSol(param.type); + assert(gqlParamType); + const tsParamType = getTsForGql(gqlParamType); assert(tsParamType); param.type = tsParamType; return param; }); - const tsReturnType = getTsForSol(returnType); - assert(tsReturnType); - queryObject.returnType = tsReturnType; - if (stateVariableType) { queryObject.stateVariableType = stateVariableType; } diff --git a/packages/codegen/src/resolvers.ts b/packages/codegen/src/resolvers.ts index d77b87d72..701dfedf3 100644 --- a/packages/codegen/src/resolvers.ts +++ b/packages/codegen/src/resolvers.ts @@ -9,8 +9,9 @@ import Handlebars from 'handlebars'; import assert from 'assert'; import _ from 'lodash'; -import { getTsForSol } from './utils/type-mappings'; +import { getGqlForSol, getTsForGql } from './utils/type-mappings'; import { Param } from './utils/types'; +import { getBaseType } from './utils/helpers'; const TEMPLATE_FILE = './templates/resolvers-template.handlebars'; @@ -31,11 +32,13 @@ export class Resolvers { * @param params Parameters to the query. * @param returnType Return type for the query. */ - addQuery (name: string, params: Array, returnType: string): void { + addQuery (name: string, params: Array, typeName: any): void { // Check if the query is already added. if (this._queries.some(query => query.name === name)) { return; } + const returnType = getBaseType(typeName); + assert(returnType); const queryObject = { name, @@ -44,7 +47,9 @@ export class Resolvers { }; queryObject.params = queryObject.params.map((param) => { - const tsParamType = getTsForSol(param.type); + const gqlParamType = getGqlForSol(param.type); + assert(gqlParamType); + const tsParamType = getTsForGql(gqlParamType); assert(tsParamType); param.type = tsParamType; return param; diff --git a/packages/codegen/src/schema.ts b/packages/codegen/src/schema.ts index 004baea56..0c5f77942 100644 --- a/packages/codegen/src/schema.ts +++ b/packages/codegen/src/schema.ts @@ -8,8 +8,9 @@ import { ObjectTypeComposer, ObjectTypeComposerDefinition, ObjectTypeComposerFie import { Writable } from 'stream'; import { utils } from 'ethers'; -import { getTsForSol, getGqlForTs } from './utils/type-mappings'; +import { getGqlForTs, getGqlForSol } from './utils/type-mappings'; import { Param } from './utils/types'; +import { getBaseType, isArrayType } from './utils/helpers'; export class Schema { _composer: SchemaComposer; @@ -29,20 +30,26 @@ export class Schema { * @param params Parameters to the query. * @param returnType Return type for the query. */ - addQuery (name: string, params: Array, returnType: string): void { + addQuery (name: string, params: Array, typeName: any): void { // Check if the query is already added. if (this._composer.Query.hasField(name)) { return; } // TODO: Handle cases where returnType/params type is an array. - const tsReturnType = getTsForSol(returnType); - assert(tsReturnType, `ts type for sol type ${returnType} for ${name} not found`); + const isReturnTypeArray = isArrayType(typeName); + const baseTypeName = getBaseType(typeName); + assert(baseTypeName); + + const gqlReturnType = getGqlForSol(baseTypeName); + assert(gqlReturnType, `gql type for sol type ${baseTypeName} for ${name} not found`); + + const objectTC = this._getOrCreateResultType(gqlReturnType, isReturnTypeArray); const queryObject: { [key: string]: any; } = {}; queryObject[name] = { // Get type composer object for return type from the schema composer. - type: this._composer.getOTC(`Result${getGqlForTs(tsReturnType)}`).NonNull, + type: objectTC.NonNull, args: { blockHash: 'String!', contractAddress: 'String!' @@ -51,13 +58,10 @@ export class Schema { if (params.length > 0) { queryObject[name].args = params.reduce((acc, curr) => { - const tsCurrType = getTsForSol(curr.type); - assert(tsCurrType, `ts type for sol type ${curr.type} for ${curr.name} not found`); - acc[curr.name] = `${getGqlForTs(tsCurrType)}!`; + acc[curr.name] = `${getGqlForSol(curr.type)}!`; return acc; }, queryObject[name].args); } - // Add a query to the schema composer using queryObject. this._composer.Query.addFields(queryObject); } @@ -221,43 +225,6 @@ export class Schema { }); this._composer.addSchemaMustHaveType(typeComposer); - typeComposer = this._composer.createObjectTC({ - name: 'ResultBoolean', - fields: { - value: 'Boolean!', - proof: () => this._composer.getOTC('Proof') - } - }); - this._composer.addSchemaMustHaveType(typeComposer); - - typeComposer = this._composer.createObjectTC({ - name: 'ResultString', - fields: { - value: 'String!', - proof: () => this._composer.getOTC('Proof') - } - }); - this._composer.addSchemaMustHaveType(typeComposer); - - typeComposer = this._composer.createObjectTC({ - name: 'ResultInt', - fields: { - value: () => 'Int!', - proof: () => this._composer.getOTC('Proof') - } - }); - this._composer.addSchemaMustHaveType(typeComposer); - - typeComposer = this._composer.createObjectTC({ - name: 'ResultBigInt', - fields: { - // Get type composer object for BigInt scalar from the schema composer. - value: () => this._composer.getSTC('BigInt').NonNull, - proof: () => this._composer.getOTC('Proof') - } - }); - this._composer.addSchemaMustHaveType(typeComposer); - // Create the Block type. typeComposer = this._composer.createObjectTC({ name: '_Block_', @@ -272,6 +239,28 @@ export class Schema { this._composer.addSchemaMustHaveType(typeComposer); } + /** + * Adds Result types to the schema and typemapping. + */ + _getOrCreateResultType (typeName: string, isArray = false): ObjectTypeComposer { + const value = `${typeName}!`; + + let objectTCName = `Result${typeName}`; + if (isArray) { + objectTCName = objectTCName.concat('Array'); + } + + const typeComposer = this._composer.getOrCreateOTC( + objectTCName, + (tc) => { + tc.addFields({ + value: (isArray) ? `[${value}]!` : value, + proof: () => this._composer.getOTC('Proof') + }); + }); + return typeComposer; + } + _addGQLCacheTypes (): void { // Create a enum type composer to add enum CacheControlScope in the schema composer. const enumTypeComposer = this._composer.createEnumTC(` @@ -476,9 +465,7 @@ export class Schema { const newFields: any = {}; params.forEach((param: Param) => { if (!commonFields.includes(param.name)) { - const tsCurrType = getTsForSol(param.type); - assert(tsCurrType, `ts type for sol type ${param.type} for ${param.name} not found`); - newFields[param.name] = `${getGqlForTs(tsCurrType)}`; + newFields[param.name] = `${getGqlForTs(param.type)}`; } }); @@ -530,8 +517,6 @@ export class Schema { return [this._getObjectTypeField(param.arrayChildren)]; } - const tsCurrType = getTsForSol(param.type); - assert(tsCurrType, `ts type for sol type ${param.type} for ${param.name} not found`); - return `${getGqlForTs(tsCurrType)}!`; + return `${getGqlForSol(param.type)}!`; } } diff --git a/packages/codegen/src/templates/indexer-template.handlebars b/packages/codegen/src/templates/indexer-template.handlebars index 787e2d4e6..82ee4f790 100644 --- a/packages/codegen/src/templates/indexer-template.handlebars +++ b/packages/codegen/src/templates/indexer-template.handlebars @@ -166,6 +166,7 @@ export class Indexer implements IndexerInterface { {{else~}} ): Promise { {{/if}} + {{#unless query.disableCaching}} const entity = await this._db.{{query.getQueryName}}({ blockHash, contractAddress {{~#each query.params}}, {{this.name~}} {{~/each}} }); if (entity) { @@ -177,6 +178,7 @@ export class Indexer implements IndexerInterface { }; } + {{/unless}} log('{{query.name}}: db miss, fetching from upstream server'); const { block: { number } } = await this._ethClient.getBlockByHash(blockHash); @@ -193,9 +195,16 @@ export class Indexer implements IndexerInterface { value = value.toString(); value = BigInt(value); {{else}} + {{!-- Using nested if-else to avoid indentation issue --}} + {{#if (compare query.returnType 'bigint[]')}} + let value = await contract.{{query.name}}( + {{~#each query.params}}{{this.name}}, {{/each}}{ blockTag: blockHash }); + value = value.map((val: ethers.BigNumber) => ethers.BigNumber.from(val).toBigInt()); + {{else}} const value = await contract.{{query.name}}( {{~#each query.params}}{{this.name}}, {{/each}}{ blockTag: blockHash }); {{/if}} + {{/if}} const result: ValueResult = { value }; {{/if}} @@ -215,9 +224,11 @@ export class Indexer implements IndexerInterface { ); {{/if}} + {{#unless disableCaching}} await this._db.{{query.saveQueryName}}({ blockHash, blockNumber, contractAddress {{~#each query.params}}, {{this.name~}} {{/each}}, value: result.value, proof: JSONbigNative.stringify(result.proof) }); + {{/unless}} {{#if query.stateVariableType}} {{#if (compare query.stateVariableType 'Mapping')}} if (diff) { diff --git a/packages/codegen/src/utils/helpers.ts b/packages/codegen/src/utils/helpers.ts new file mode 100644 index 000000000..857afb9a1 --- /dev/null +++ b/packages/codegen/src/utils/helpers.ts @@ -0,0 +1,24 @@ +// +// Copyright 2021 Vulcanize, Inc. +// + +import fs from 'fs'; +import { Writable } from 'stream'; + +const isElementaryType = (typeName: any): boolean => (typeName.type === 'ElementaryTypeName'); +export const isArrayType = (typeName: any): boolean => (typeName.type === 'ArrayTypeName'); + +export const getBaseType = (typeName: any): string | undefined => { + if (isElementaryType(typeName)) { + return typeName.name; + } else if (isArrayType(typeName)) { + return getBaseType(typeName.baseTypeName); + } else { + return undefined; + } +}; + +export function writeFileToStream (pathToFile: string, outStream: Writable): void { + const fileStream = fs.createReadStream(pathToFile); + fileStream.pipe(outStream); +} diff --git a/packages/codegen/src/utils/solToGql.ts b/packages/codegen/src/utils/solToGql.ts new file mode 100644 index 000000000..1feae260c --- /dev/null +++ b/packages/codegen/src/utils/solToGql.ts @@ -0,0 +1,112 @@ +// +// Copyright 2022 Vulcanize, Inc. +// + +const solToGql: Map = new Map(); + +// Solidity to GraphQL type-mapping. +solToGql.set('string', 'String'); +solToGql.set('address', 'String'); +solToGql.set('bool', 'Boolean'); + +solToGql.set('int8', 'Int'); +solToGql.set('int16', 'Int'); +solToGql.set('int24', 'Int'); +solToGql.set('int32', 'Int'); +solToGql.set('int48', 'BigInt'); +solToGql.set('int56', 'BigInt'); +solToGql.set('int64', 'BigInt'); +solToGql.set('int72', 'BigInt'); +solToGql.set('int80', 'BigInt'); +solToGql.set('int88', 'BigInt'); +solToGql.set('int96', 'BigInt'); +solToGql.set('int104', 'BigInt'); +solToGql.set('int112', 'BigInt'); +solToGql.set('int120', 'BigInt'); +solToGql.set('int128', 'BigInt'); +solToGql.set('int136', 'BigInt'); +solToGql.set('int144', 'BigInt'); +solToGql.set('int152', 'BigInt'); +solToGql.set('int160', 'BigInt'); +solToGql.set('int168', 'BigInt'); +solToGql.set('int176', 'BigInt'); +solToGql.set('int184', 'BigInt'); +solToGql.set('int192', 'BigInt'); +solToGql.set('int200', 'BigInt'); +solToGql.set('int208', 'BigInt'); +solToGql.set('int216', 'BigInt'); +solToGql.set('int224', 'BigInt'); +solToGql.set('int232', 'BigInt'); +solToGql.set('int240', 'BigInt'); +solToGql.set('int248', 'BigInt'); +solToGql.set('int256', 'BigInt'); +solToGql.set('int', 'BigInt'); + +solToGql.set('uint8', 'Int'); +solToGql.set('uint16', 'Int'); +solToGql.set('uint24', 'Int'); +solToGql.set('uint32', 'BigInt'); +solToGql.set('uint48', 'BigInt'); +solToGql.set('uint56', 'BigInt'); +solToGql.set('uint64', 'BigInt'); +solToGql.set('uint72', 'BigInt'); +solToGql.set('uint80', 'BigInt'); +solToGql.set('uint88', 'BigInt'); +solToGql.set('uint96', 'BigInt'); +solToGql.set('uint104', 'BigInt'); +solToGql.set('uint112', 'BigInt'); +solToGql.set('uint120', 'BigInt'); +solToGql.set('uint128', 'BigInt'); +solToGql.set('uint136', 'BigInt'); +solToGql.set('uint144', 'BigInt'); +solToGql.set('uint152', 'BigInt'); +solToGql.set('uint160', 'BigInt'); +solToGql.set('uint168', 'BigInt'); +solToGql.set('uint176', 'BigInt'); +solToGql.set('uint184', 'BigInt'); +solToGql.set('uint192', 'BigInt'); +solToGql.set('uint200', 'BigInt'); +solToGql.set('uint208', 'BigInt'); +solToGql.set('uint216', 'BigInt'); +solToGql.set('uint224', 'BigInt'); +solToGql.set('uint232', 'BigInt'); +solToGql.set('uint240', 'BigInt'); +solToGql.set('uint248', 'BigInt'); +solToGql.set('uint256', 'BigInt'); +solToGql.set('uint', 'BigInt'); + +solToGql.set('bytes', 'String'); +solToGql.set('bytes1', 'String'); +solToGql.set('bytes2', 'String'); +solToGql.set('bytes3', 'String'); +solToGql.set('bytes4', 'String'); +solToGql.set('bytes5', 'String'); +solToGql.set('bytes6', 'String'); +solToGql.set('bytes7', 'String'); +solToGql.set('bytes8', 'String'); +solToGql.set('bytes9', 'String'); +solToGql.set('bytes10', 'String'); +solToGql.set('bytes11', 'String'); +solToGql.set('bytes12', 'String'); +solToGql.set('bytes13', 'String'); +solToGql.set('bytes14', 'String'); +solToGql.set('bytes15', 'String'); +solToGql.set('bytes16', 'String'); +solToGql.set('bytes17', 'String'); +solToGql.set('bytes18', 'String'); +solToGql.set('bytes19', 'String'); +solToGql.set('bytes20', 'String'); +solToGql.set('bytes21', 'String'); +solToGql.set('bytes22', 'String'); +solToGql.set('bytes23', 'String'); +solToGql.set('bytes24', 'String'); +solToGql.set('bytes25', 'String'); +solToGql.set('bytes26', 'String'); +solToGql.set('bytes27', 'String'); +solToGql.set('bytes28', 'String'); +solToGql.set('bytes29', 'String'); +solToGql.set('bytes30', 'String'); +solToGql.set('bytes31', 'String'); +solToGql.set('bytes32', 'String'); + +export { solToGql }; diff --git a/packages/codegen/src/utils/solToTs.ts b/packages/codegen/src/utils/solToTs.ts deleted file mode 100644 index 8170ee70e..000000000 --- a/packages/codegen/src/utils/solToTs.ts +++ /dev/null @@ -1,112 +0,0 @@ -// -// Copyright 2022 Vulcanize, Inc. -// - -const solToTs: Map = new Map(); - -// Solidity to Typescript type-mapping. -solToTs.set('string', 'string'); -solToTs.set('address', 'string'); -solToTs.set('bool', 'boolean'); - -solToTs.set('int8', 'number'); -solToTs.set('int16', 'number'); -solToTs.set('int24', 'number'); -solToTs.set('int32', 'number'); -solToTs.set('int48', 'number'); -solToTs.set('int56', 'bigint'); -solToTs.set('int64', 'bigint'); -solToTs.set('int72', 'bigint'); -solToTs.set('int80', 'bigint'); -solToTs.set('int88', 'bigint'); -solToTs.set('int96', 'bigint'); -solToTs.set('int104', 'bigint'); -solToTs.set('int112', 'bigint'); -solToTs.set('int120', 'bigint'); -solToTs.set('int128', 'bigint'); -solToTs.set('int136', 'bigint'); -solToTs.set('int144', 'bigint'); -solToTs.set('int152', 'bigint'); -solToTs.set('int160', 'bigint'); -solToTs.set('int168', 'bigint'); -solToTs.set('int176', 'bigint'); -solToTs.set('int184', 'bigint'); -solToTs.set('int192', 'bigint'); -solToTs.set('int200', 'bigint'); -solToTs.set('int208', 'bigint'); -solToTs.set('int216', 'bigint'); -solToTs.set('int224', 'bigint'); -solToTs.set('int232', 'bigint'); -solToTs.set('int240', 'bigint'); -solToTs.set('int248', 'bigint'); -solToTs.set('int256', 'bigint'); -solToTs.set('int', 'bigint'); - -solToTs.set('uint8', 'number'); -solToTs.set('uint16', 'number'); -solToTs.set('uint24', 'number'); -solToTs.set('uint32', 'number'); -solToTs.set('uint48', 'number'); -solToTs.set('uint56', 'bigint'); -solToTs.set('uint64', 'bigint'); -solToTs.set('uint72', 'bigint'); -solToTs.set('uint80', 'bigint'); -solToTs.set('uint88', 'bigint'); -solToTs.set('uint96', 'bigint'); -solToTs.set('uint104', 'bigint'); -solToTs.set('uint112', 'bigint'); -solToTs.set('uint120', 'bigint'); -solToTs.set('uint128', 'bigint'); -solToTs.set('uint136', 'bigint'); -solToTs.set('uint144', 'bigint'); -solToTs.set('uint152', 'bigint'); -solToTs.set('uint160', 'bigint'); -solToTs.set('uint168', 'bigint'); -solToTs.set('uint176', 'bigint'); -solToTs.set('uint184', 'bigint'); -solToTs.set('uint192', 'bigint'); -solToTs.set('uint200', 'bigint'); -solToTs.set('uint208', 'bigint'); -solToTs.set('uint216', 'bigint'); -solToTs.set('uint224', 'bigint'); -solToTs.set('uint232', 'bigint'); -solToTs.set('uint240', 'bigint'); -solToTs.set('uint248', 'bigint'); -solToTs.set('uint256', 'bigint'); -solToTs.set('uint', 'bigint'); - -solToTs.set('bytes', 'string'); -solToTs.set('bytes1', 'string'); -solToTs.set('bytes2', 'string'); -solToTs.set('bytes3', 'string'); -solToTs.set('bytes4', 'string'); -solToTs.set('bytes5', 'string'); -solToTs.set('bytes6', 'string'); -solToTs.set('bytes7', 'string'); -solToTs.set('bytes8', 'string'); -solToTs.set('bytes9', 'string'); -solToTs.set('bytes10', 'string'); -solToTs.set('bytes11', 'string'); -solToTs.set('bytes12', 'string'); -solToTs.set('bytes13', 'string'); -solToTs.set('bytes14', 'string'); -solToTs.set('bytes15', 'string'); -solToTs.set('bytes16', 'string'); -solToTs.set('bytes17', 'string'); -solToTs.set('bytes18', 'string'); -solToTs.set('bytes19', 'string'); -solToTs.set('bytes20', 'string'); -solToTs.set('bytes21', 'string'); -solToTs.set('bytes22', 'string'); -solToTs.set('bytes23', 'string'); -solToTs.set('bytes24', 'string'); -solToTs.set('bytes25', 'string'); -solToTs.set('bytes26', 'string'); -solToTs.set('bytes27', 'string'); -solToTs.set('bytes28', 'string'); -solToTs.set('bytes29', 'string'); -solToTs.set('bytes30', 'string'); -solToTs.set('bytes31', 'string'); -solToTs.set('bytes32', 'string'); - -export { solToTs }; diff --git a/packages/codegen/src/utils/type-mappings.ts b/packages/codegen/src/utils/type-mappings.ts index f35a15567..a4d0c316a 100644 --- a/packages/codegen/src/utils/type-mappings.ts +++ b/packages/codegen/src/utils/type-mappings.ts @@ -2,7 +2,7 @@ // Copyright 2021 Vulcanize, Inc. // -import { solToTs } from './solToTs'; +import { solToGql } from './solToGql'; const _tsToGql: Map = new Map(); const _tsToPg: Map = new Map(); @@ -29,8 +29,8 @@ _gqlToTs.set('Boolean', 'boolean'); _gqlToTs.set('BigDecimal', 'Decimal'); _gqlToTs.set('Bytes', 'string'); -function getTsForSol (solType: string): string | undefined { - return solToTs.get(solType); +function getGqlForSol (solType: string): string | undefined { + return solToGql.get(solType); } function getGqlForTs (tsType: string): string | undefined { @@ -45,4 +45,4 @@ function getTsForGql (gqlType: string): string | undefined { return _gqlToTs.get(gqlType); } -export { getTsForSol, getGqlForTs, getPgForTs, getTsForGql }; +export { getGqlForTs, getGqlForSol, getPgForTs, getTsForGql }; diff --git a/packages/codegen/src/visitor.ts b/packages/codegen/src/visitor.ts index 83de3c430..28bd38908 100644 --- a/packages/codegen/src/visitor.ts +++ b/packages/codegen/src/visitor.ts @@ -65,29 +65,24 @@ export class Visitor { } else { const typeName = node.returnParameters[0].typeName; switch (typeName.type) { - case 'ElementaryTypeName': { - const returnType = typeName.name; + case 'ElementaryTypeName': + this._entity.addQuery(name, params, typeName); + this._database.addQuery(name, params, typeName); + this._client.addQuery(name, params, typeName); + // falls through - this._schema.addQuery(name, params, returnType); - this._resolvers.addQuery(name, params, returnType); - this._entity.addQuery(name, params, returnType); - this._database.addQuery(name, params, returnType); - this._client.addQuery(name, params, returnType); + case 'ArrayTypeName': + this._schema.addQuery(name, params, typeName); + this._resolvers.addQuery(name, params, typeName); assert(this._contract); - this._indexer.addQuery(this._contract.name, MODE_ETH_CALL, name, params, returnType); - + this._indexer.addQuery(this._contract.name, MODE_ETH_CALL, name, params, typeName); break; - } case 'UserDefinedTypeName': errorMessage = `No support in codegen for user defined return type from method "${node.name}"`; break; - case 'ArrayTypeName': - errorMessage = `No support in codegen for return type "${typeName.baseTypeName.name}[]" from method "${node.name}"`; - break; - default: errorMessage = `No support in codegen for return type "${typeName.type}" from method "${node.name}"`; } @@ -133,21 +128,42 @@ export class Visitor { numParams++; } - if (['UserDefinedTypeName', 'ArrayTypeName'].includes(typeName.type)) { - // Skip in case of UserDefinedTypeName | ArrayTypeName. - return; - } + let errorMessage = ''; + + switch (typeName.type) { + case 'ElementaryTypeName': { + this._schema.addQuery(name, params, typeName); + this._resolvers.addQuery(name, params, typeName); + this._entity.addQuery(name, params, typeName); + this._database.addQuery(name, params, typeName); + this._client.addQuery(name, params, typeName); - const returnType = typeName.name; + assert(this._contract); + this._indexer.addQuery(this._contract.name, MODE_STORAGE, name, params, typeName, stateVariableType); - this._schema.addQuery(name, params, returnType); - this._resolvers.addQuery(name, params, returnType); - this._entity.addQuery(name, params, returnType); - this._database.addQuery(name, params, returnType); - this._client.addQuery(name, params, returnType); + break; + } + + case 'UserDefinedTypeName': + errorMessage = `No support in codegen for user defined return type from method "${name}"`; + break; + + case 'ArrayTypeName': + errorMessage = `No support in codegen for return type "${typeName.baseTypeName.name}[]" from method "${name}"`; + break; + + default: + errorMessage = `No support in codegen for return type "${typeName.type}" from method "${name}"`; + } + + if (errorMessage !== '') { + if (this._continueOnError) { + console.log(errorMessage); + return; + } - assert(this._contract); - this._indexer.addQuery(this._contract.name, MODE_STORAGE, name, params, returnType, stateVariableType); + throw new Error(errorMessage); + } } /** diff --git a/packages/util/src/misc.ts b/packages/util/src/misc.ts index 10fc2331e..7395b9b3e 100644 --- a/packages/util/src/misc.ts +++ b/packages/util/src/misc.ts @@ -37,14 +37,14 @@ export const wait = async (time: number): Promise => new Promise(resolve = */ export const graphDecimalTransformer: ValueTransformer = { to: (value?: GraphDecimal) => { - if (value) { + if (value !== undefined) { return value.toFixed(); } return value; }, from: (value?: string) => { - if (value) { + if (value !== undefined) { return new GraphDecimal(value); } @@ -57,14 +57,14 @@ export const graphDecimalTransformer: ValueTransformer = { */ export const decimalTransformer: ValueTransformer = { to: (value?: Decimal) => { - if (value) { + if (value !== undefined) { return value.toString(); } return value; }, from: (value?: string) => { - if (value) { + if (value !== undefined) { return new Decimal(value); } @@ -77,14 +77,14 @@ export const decimalTransformer: ValueTransformer = { */ export const bigintTransformer: ValueTransformer = { to: (value?: bigint) => { - if (value) { + if (value !== undefined) { return value.toString(); } return value; }, from: (value?: string) => { - if (value) { + if (value !== undefined) { return BigInt(value); } @@ -94,14 +94,14 @@ export const bigintTransformer: ValueTransformer = { export const bigintArrayTransformer: ValueTransformer = { to: (valueArray?: bigint[]) => { - if (valueArray) { + if (valueArray !== undefined) { return valueArray.map(value => bigintTransformer.to(value)); } return valueArray; }, from: (valueArray?: string[]) => { - if (valueArray) { + if (valueArray !== undefined) { return valueArray.map(value => bigintTransformer.from(value)); } @@ -111,14 +111,14 @@ export const bigintArrayTransformer: ValueTransformer = { export const decimalArrayTransformer: ValueTransformer = { to: (valueArray?: Decimal[]) => { - if (valueArray) { + if (valueArray !== undefined) { return valueArray.map(value => decimalTransformer.to(value)); } return valueArray; }, from: (valueArray?: string[]) => { - if (valueArray) { + if (valueArray !== undefined) { return valueArray.map(value => decimalTransformer.from(value)); }