diff --git a/LICENSE b/LICENSE index 674daf4..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -MIT License - -Copyright (c) 2022 Giveth - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + 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/config/test.env b/config/test.env index a699c35..ac7cf6d 100644 --- a/config/test.env +++ b/config/test.env @@ -23,6 +23,9 @@ GIVETH_IO_THIRD_PARTY_MICRO_SERVICE=givethio GIV_ECONOMY_THIRD_PARTY_SECRET=secret GIV_ECONOMY_THIRD_PARTY_MICRO_SERVICE=giveconomy-notification-service +NOTIFY_REWARD_THIRD_PARTY_SECRET=secret +NOTIFY_REWARD_THIRD_PARTY_MICRO_SERVICE=notifyreward + # OPTIONAL - force logging to stdout when the value is true LOG_STDOUT=false diff --git a/funding.json b/funding.json new file mode 100644 index 0000000..668d358 --- /dev/null +++ b/funding.json @@ -0,0 +1,5 @@ +{ + "opRetro": { + "projectId": "0xe434930e189c807b137ff0d8e2fa6a95eaa57dde574143a02ca0d7fb31a40bea" + } +} diff --git a/migrations/1718888344202-seedNotificationTypeForNotifyRewardAmount.ts b/migrations/1718888344202-seedNotificationTypeForNotifyRewardAmount.ts new file mode 100644 index 0000000..5e4a341 --- /dev/null +++ b/migrations/1718888344202-seedNotificationTypeForNotifyRewardAmount.ts @@ -0,0 +1,27 @@ +import { MigrationInterface, QueryRunner } from "typeorm" +import { NOTIFICATION_CATEGORY, NOTIFICATION_TYPE_NAMES } from '../src/types/general'; +import { MICRO_SERVICES } from '../src/utils/utils'; +import { NotificationType, SCHEMA_VALIDATORS_NAMES } from '../src/entities/notificationType'; + +const NotifyRewardAmountNotificationType = [ + { + name: NOTIFICATION_TYPE_NAMES.NOTIFY_REWARD_AMOUNT, + description: NOTIFICATION_TYPE_NAMES.NOTIFY_REWARD_AMOUNT, + microService: MICRO_SERVICES.givethio, + category: NOTIFICATION_CATEGORY.GENERAL, + schemaValidator: SCHEMA_VALIDATORS_NAMES.NOTIFY_REWARD_AMOUNT, + title: "Notify reward report", + } +] + +export class seedNotificationTypeForNotifyRewardAmount1718888344202 implements MigrationInterface { + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.manager.save(NotificationType, NotifyRewardAmountNotificationType); + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query( + `DELETE FROM notification_type WHERE "name" = ${NOTIFICATION_TYPE_NAMES.NOTIFY_REWARD_AMOUNT};`, + ); + } +} diff --git a/migrations/1719224595366-seedNotificationTypeForSendEmailConfirmation.ts b/migrations/1719224595366-seedNotificationTypeForSendEmailConfirmation.ts new file mode 100644 index 0000000..6d956f2 --- /dev/null +++ b/migrations/1719224595366-seedNotificationTypeForSendEmailConfirmation.ts @@ -0,0 +1,27 @@ +import { MigrationInterface, QueryRunner } from "typeorm" +import { NOTIFICATION_CATEGORY } from '../src/types/general'; +import { MICRO_SERVICES } from '../src/utils/utils'; +import { NotificationType, SCHEMA_VALIDATORS_NAMES } from '../src/entities/notificationType'; +import { NOTIFICATIONS_EVENT_NAMES } from '../src/types/notifications'; + +const EmailConfirmationNotificationType = [ + { + name: NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION, + description: NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION, + microService: MICRO_SERVICES.givethio, + category: NOTIFICATION_CATEGORY.ORTTO, + schemaValidator: SCHEMA_VALIDATORS_NAMES.SEND_EMAIL_CONFIRMATION, + } +] + +export class seedNotificationTypeForSendEmailConfirmation1719224595366 implements MigrationInterface { + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.manager.save(NotificationType, EmailConfirmationNotificationType); + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query( + `DELETE FROM notification_type WHERE "name" = 'Send email confirmation';`, + ); + } +} diff --git a/migrations/1719410008992-seedNotificationTypeForOnboardingGuide.ts b/migrations/1719410008992-seedNotificationTypeForOnboardingGuide.ts new file mode 100644 index 0000000..4e07f60 --- /dev/null +++ b/migrations/1719410008992-seedNotificationTypeForOnboardingGuide.ts @@ -0,0 +1,26 @@ +import { MigrationInterface, QueryRunner } from "typeorm" +import { NotificationType, SCHEMA_VALIDATORS_NAMES } from '../src/entities/notificationType'; +import { NOTIFICATION_CATEGORY, NOTIFICATION_TYPE_NAMES } from '../src/types/general'; +import { MICRO_SERVICES } from '../src/utils/utils'; + +const OnboardingNotificationType = [ + { + name: NOTIFICATION_TYPE_NAMES.SUBSCRIBE_ONBOARDING, + description: NOTIFICATION_TYPE_NAMES.SUBSCRIBE_ONBOARDING, + microService: MICRO_SERVICES.givethio, + category: NOTIFICATION_CATEGORY.ORTTO, + schemaValidator: SCHEMA_VALIDATORS_NAMES.SUBSCRIBE_ONBOARDING, + } +] + +export class seedNotificationTypeForOnboardingGuide1719410008992 implements MigrationInterface { + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.manager.save(NotificationType, OnboardingNotificationType); + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query( + `DELETE FROM notification_type WHERE "name" = 'Subscribe onboarding';`, + ); + } +} diff --git a/migrations/1720553769343-changeMicroserviceAndCategoryOfNotifyRewardNotificationType.ts b/migrations/1720553769343-changeMicroserviceAndCategoryOfNotifyRewardNotificationType.ts new file mode 100644 index 0000000..d83a425 --- /dev/null +++ b/migrations/1720553769343-changeMicroserviceAndCategoryOfNotifyRewardNotificationType.ts @@ -0,0 +1,23 @@ +import { MigrationInterface, QueryRunner } from "typeorm"; +import { MICRO_SERVICES } from '../src/utils/utils'; +import { NOTIFICATION_CATEGORY } from '../src/types/general'; + +export class changeMicroserviceAndCategoryOfNotifyRewardNotificationType1720553769343 implements MigrationInterface { + public async up(queryRunner: QueryRunner): Promise { + await queryRunner.query(` + UPDATE notification_type + SET "microService" = '${MICRO_SERVICES.notifyReward}', + category = '${NOTIFICATION_CATEGORY.ORTTO}' + WHERE name = 'Notify reward amount'; + `); + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query(` + UPDATE notification_type + SET "microService" = '${MICRO_SERVICES.givethio}', + categoty = '${NOTIFICATION_CATEGORY.GENERAL}' + WHERE name = 'Notify reward amount'; + `); + } +} diff --git a/migrations/1720828190666-seedThirdPartyForNotifyReward.ts b/migrations/1720828190666-seedThirdPartyForNotifyReward.ts new file mode 100644 index 0000000..14b8d51 --- /dev/null +++ b/migrations/1720828190666-seedThirdPartyForNotifyReward.ts @@ -0,0 +1,27 @@ +import { MigrationInterface, QueryRunner } from "typeorm" + +export class seedThirdPartyForNotifyReward1720828190666 implements MigrationInterface { + public async up(queryRunner: QueryRunner): Promise { + if ( + process.env.NODE_ENV === 'test' || + process.env.NODE_ENV === 'development' + ) { + // Create third part record for notifyreward in development and test ENVs + await queryRunner.query(` + INSERT INTO third_party( + "microService", secret, "isActive") + VALUES + ('notifyreward', 'secret', true) + ; + `); + } + } + + public async down(queryRunner: QueryRunner): Promise { + await queryRunner.query(` + DELETE FROM third_party + WHERE "microService" = 'notifyreward'; + `); + } + +} diff --git a/package.json b/package.json index f62701e..c1c4d87 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "notification-venter", - "version": "2.2.0", + "version": "2.3.0", "description": "", "main": "index.js", "scripts": { diff --git a/src/entities/notificationType.ts b/src/entities/notificationType.ts index 888600d..fa12850 100644 --- a/src/entities/notificationType.ts +++ b/src/entities/notificationType.ts @@ -4,19 +4,17 @@ import { CreateDateColumn, Entity, Index, - JoinTable, - ManyToOne, OneToMany, PrimaryGeneratedColumn, - RelationId, UpdateDateColumn, } from 'typeorm'; -import { NOTIFICATION_CATEGORY } from '../types/general'; import { NotificationSetting } from './notificationSetting'; // Export Object with Schemas to N1 lookup export const SCHEMA_VALIDATORS_NAMES = { + SEND_EMAIL_CONFIRMATION: 'sendEmailConfirmation', CREATE_ORTTO_PROFILE: 'createOrttoProfile', + SUBSCRIBE_ONBOARDING: 'subscribeOnboarding', SUPERFLUID: 'userSuperTokensCritical', ADMIN_MESSAGE: 'adminMessage', RAW_HTML_BROADCAST: 'rawHtmlBroadcast', @@ -68,6 +66,8 @@ export const SCHEMA_VALIDATORS_NAMES = { PROJECT_HAS_A_NEW_RANK: 'projectHasANewRank', PROJECT_HAS_RISEN_IN_THE_RANK: 'projectHasRisenInTheRank', YOUR_PROJECT_GOT_A_RANK: 'yourProjectGotARank', + + NOTIFY_REWARD_AMOUNT: 'notifyRewardAmount', }; export type HtmlTemplate = { type: string; content: string; href?: string }[]; diff --git a/src/routes/v1/notificationRouter.test.ts b/src/routes/v1/notificationRouter.test.ts index 387c745..6e15a0a 100644 --- a/src/routes/v1/notificationRouter.test.ts +++ b/src/routes/v1/notificationRouter.test.ts @@ -5,6 +5,7 @@ import { getAccessTokenForMockAuthMicroService, getGivEconomyBasicAuth, getGivethIoBasicAuth, + getNotifyRewardBasicAuth, serverUrl, sleep, } from '../../../test/testUtils'; @@ -2092,6 +2093,77 @@ function sendNotificationTestCases() { const createdNotification = await findNotificationByTrackId(trackId); assert.equal(createdNotification?.createdAt.getTime(), creationTime); }); + + it('should create *Notify reward amount* notification, success', async () => { + const data = { + eventName: "Notify reward amount", + sendEmail: true, + sendSegment: true, + creationTime: 1667992708000, + email: "aliebrahimi2079@gmail.com", + segment: { + payload: { + round: 10, + date: "1667992708000", + amount: "12134", + contractAddress: "0xsfglsjfdflk", + farm: "test farm", + message: "test message", + network: "ethereum", + script: "test script", + transactionHash: "test txhash" + } + } + }; + + const result = await axios.post(sendNotificationUrl, data, { + headers: { + authorization: getNotifyRewardBasicAuth(), + }, + }); + + assert.equal(result.status, 200); + assert.isOk(result.data); + assert.isTrue(result.data.success); + }); + it('should create *Notify reward amount* notification, failed invalid payload', async () => { + try { + const data = { + eventName: "Notify reward amount", + sendEmail: true, + sendSegment: true, + creationTime: 1667992708000, + email: "aliebrahimi2079@gmail.com", + segment: { + payload: { + round: 10, + date: "1667992708000", + amount: "12134", + contractAddress: "0xsfglsjfdflk", + farm: "test farm", + message: "test message", + network: "ethereum", + script: "test script", + transactionHash: "test txhash", + invalidField: "invalid data" + } + } + }; + await axios.post(sendNotificationUrl, data, { + headers: { + authorization: getNotifyRewardBasicAuth(), + }, + }); + // If request doesn't fail, it means this test failed + assert.isTrue(false); + } catch (e: any) { + assert.equal( + e.response.data.message, + errorMessagesEnum.IMPACT_GRAPH_VALIDATION_ERROR.message, + ); + assert.equal(e.response.data.description, '"segment.payload.invalidField" is not allowed'); + } + }); } function sendBulkNotificationsTestCases() { diff --git a/src/routes/v1/notificationRouter.ts b/src/routes/v1/notificationRouter.ts index d34263e..440799a 100644 --- a/src/routes/v1/notificationRouter.ts +++ b/src/routes/v1/notificationRouter.ts @@ -5,6 +5,7 @@ import { } from '../../middlewares/authentication'; import { NotificationsController } from '../../controllers/v1/notificationsController'; import { sendStandardResponse } from '../../utils/responseUtils'; +import { logger } from '../../utils/logger'; import { createNewUserAddressIfNotExists } from '../../repositories/userAddressRepository'; export const notificationRouter = express.Router(); @@ -22,6 +23,7 @@ notificationRouter.post( }); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('/thirdParty/notifications error', e); next(e); } }, @@ -41,6 +43,7 @@ notificationRouter.post( ); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('/thirdParty/notificationsBulk error', e); next(e); } }, @@ -65,6 +68,7 @@ notificationRouter.get( ); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('/notifications error', e); next(e); } }, @@ -85,6 +89,7 @@ notificationRouter.put( ); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('/notifications/read/:notificationId error', e); next(e); } }, @@ -100,6 +105,7 @@ notificationRouter.get( ); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('/notifications/countUnread/:walletAddress error', e); next(e); } }, @@ -120,6 +126,7 @@ notificationRouter.put( ); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('/notifications/readAll error', e); next(e); } }, diff --git a/src/routes/v1/notificationSettingsRouter.ts b/src/routes/v1/notificationSettingsRouter.ts index 38924a9..d950253 100644 --- a/src/routes/v1/notificationSettingsRouter.ts +++ b/src/routes/v1/notificationSettingsRouter.ts @@ -2,6 +2,7 @@ import express, { Request, Response } from 'express'; import { validateAuthMicroserviceJwt } from '../../middlewares/authentication'; import { NotificationSettingsController } from '../../controllers/v1/notificationSettingsController'; import { sendStandardResponse } from '../../utils/responseUtils'; +import { logger } from '../../utils/logger'; export const notificationSettingsRouter = express.Router(); @@ -25,6 +26,7 @@ notificationSettingsRouter.get( ); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('get /notification_settings error', e); next(e); } }, @@ -47,6 +49,7 @@ notificationSettingsRouter.put( ); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('/notification_settings/:id error', e); next(e); } }, @@ -68,6 +71,7 @@ notificationSettingsRouter.put( ); return sendStandardResponse({ res, result }); } catch (e) { + logger.error('put /notification_settings error', e); next(e); } }, diff --git a/src/services/notificationService.test.ts b/src/services/notificationService.test.ts new file mode 100644 index 0000000..9f5a5ce --- /dev/null +++ b/src/services/notificationService.test.ts @@ -0,0 +1,43 @@ +import { activityCreator } from './notificationService'; +import { NOTIFICATIONS_EVENT_NAMES } from '../types/notifications'; +import { expect } from 'chai'; + +describe('activityCreator', () => { + it('should create attributes for NOTIFY_REWARD_AMOUNT', () => { + const payload = { + round: 1, + date: '2024-06-01', + amount: '1000', + contractAddress: '0x123', + farm: 'Test Farm', + message: 'Test Message', + network: 'Test Network', + script: 'Test Script', + transactionHash: '0xabc', + email: 'test@example.com' + }; + const result = activityCreator(payload, NOTIFICATIONS_EVENT_NAMES.NOTIFY_REWARD_AMOUNT); + expect(JSON.stringify(result)).equal(JSON.stringify({ + activities: [ + { + activity_id: "act:cm:notify-reward-amount", + attributes: { + 'int:cm:round': payload.round, + 'str:cm:date': payload.date, + 'str:cm:amount': payload.amount, + 'str:cm:contractaddress': payload.contractAddress, + 'str:cm:farm': payload.farm, + 'str:cm:message': payload.message, + 'str:cm:network': payload.network, + 'str:cm:script': payload.script, + 'str:cm:transactionhash': payload.transactionHash, + }, + fields: { + 'str::email': payload.email, + }, + }, + ], + merge_by: ['str::email'], + })); + }) +}); diff --git a/src/services/notificationService.ts b/src/services/notificationService.ts index 3b159aa..09d0bf1 100644 --- a/src/services/notificationService.ts +++ b/src/services/notificationService.ts @@ -13,15 +13,20 @@ import { NOTIFICATIONS_EVENT_NAMES, ORTTO_EVENT_NAMES } from '../types/notificat import { getEmailAdapter } from '../adapters/adapterFactory'; import { NOTIFICATION_CATEGORY } from '../types/general'; -const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES) : any=> { - const fields = { - "str::email": payload.email, - } - if (process.env.ENVIRONMENT === 'production') { - fields['str:cm:user-id'] = payload.userId?.toString() - } +export const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES) : any=> { let attributes; switch (orttoEventName) { + case NOTIFICATIONS_EVENT_NAMES.SUBSCRIBE_ONBOARDING: + attributes = { + "str:cm:email": payload.email, + } + break; + case NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION: + attributes = { + "str:cm:email": payload.email, + "str:cm:verificationlink": payload.verificationLink, + } + break; case NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE: attributes = { "str:cm:email": payload.email, @@ -126,6 +131,7 @@ const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES "str:cm:email": payload.email, "str:cm:projectlink": payload.projectLink, "str:cm:verified-status": 'rejected', + "txt:cm:reason": payload.verificationRejectedReason, "str:cm:userid": payload.userId?.toString(), }; break @@ -163,6 +169,19 @@ const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES "str:cm:userid": payload.userId?.toString(), } break + case NOTIFICATIONS_EVENT_NAMES.NOTIFY_REWARD_AMOUNT: + attributes = { + "int:cm:round": payload.round, + "str:cm:date": payload.date, + "str:cm:amount": payload.amount, + "str:cm:contractaddress": payload.contractAddress, + "str:cm:farm": payload.farm, + "str:cm:message": payload.message, + "str:cm:network": payload.network, + "str:cm:script": payload.script, + "str:cm:transactionhash": payload.transactionHash, + } + break default: logger.debug('activityCreator() invalid event name', orttoEventName) return; @@ -171,8 +190,12 @@ const activityCreator = (payload: any, orttoEventName: NOTIFICATIONS_EVENT_NAMES logger.debug('activityCreator() invalid ORTTO_EVENT_NAMES', orttoEventName) return; } + const fields = { + "str::email": payload.email, + } const merge_by = []; - if (process.env.ENVIRONMENT === 'production') { + if (process.env.ENVIRONMENT === 'production' && orttoEventName !== NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION) { + fields['str:cm:user-id'] = payload.userId?.toString() merge_by.push("str:cm:user-id") } else { merge_by.push("str::email") @@ -204,9 +227,7 @@ export const sendNotification = async ( message: errorMessages.DUPLICATED_TRACK_ID, }; } - const userAddress = await createNewUserAddressIfNotExists( - userWalletAddress as string, - ); + const notificationType = await getNotificationTypeByEventNameAndMicroservice({ eventName: body.eventName, microService, @@ -221,10 +242,14 @@ export const sendNotification = async ( const isOrttoSpecific = notificationType.category === NOTIFICATION_CATEGORY.ORTTO + const userAddress = isOrttoSpecific ? undefined : await createNewUserAddressIfNotExists( + userWalletAddress as string, + ); + const notificationSetting = isOrttoSpecific ? null : await findNotificationSettingByNotificationTypeAndUserAddress({ notificationTypeId: notificationType.id, - userAddressId: userAddress.id, + userAddressId: userAddress?.id as number }); const shouldSendEmail = diff --git a/src/types/general.ts b/src/types/general.ts index 62516a5..c0e3059 100644 --- a/src/types/general.ts +++ b/src/types/general.ts @@ -11,7 +11,7 @@ export enum NOTIFICATION_CATEGORY { GIV_ECONOMY = 'givEconomy', SUPPORTED_PROJECTS = 'supportedProjects', GIV_POWER = 'givPower', - ORTTO = 'ortto' + ORTTO = 'ortto', } export enum NOTIFICATION_TYPE_NAMES { @@ -51,5 +51,8 @@ export enum NOTIFICATION_TYPE_NAMES { PROJECT_HAS_A_NEW_RANK = 'Your project has a new rank', PROJECT_HAS_RISEN_IN_THE_RANK = 'Your Project has risen in the rank', YOUR_PROJECT_GOT_A_RANK = 'Your project got a rank', + SUBSCRIBE_ONBOARDING = 'Subscribe onboarding', CREATE_ORTTO_PROFILE = 'Create Ortto profile', + + NOTIFY_REWARD_AMOUNT = 'Notify reward amount', } diff --git a/src/types/notifications.ts b/src/types/notifications.ts index b7c85bd..4247a02 100644 --- a/src/types/notifications.ts +++ b/src/types/notifications.ts @@ -48,6 +48,9 @@ export enum NOTIFICATIONS_EVENT_NAMES { SUPER_TOKENS_BALANCE_MONTH = 'One month left in stream balance', SUPER_TOKENS_BALANCE_DEPLETED = 'Stream balance depleted', CREATE_ORTTO_PROFILE = 'Create Ortto profile', + SEND_EMAIL_CONFIRMATION = 'Send email confirmation', + SUBSCRIBE_ONBOARDING = 'Subscribe onboarding', + NOTIFY_REWARD_AMOUNT = 'Notify reward amount', } export const ORTTO_EVENT_NAMES = { @@ -66,5 +69,8 @@ export const ORTTO_EVENT_NAMES = { [NOTIFICATIONS_EVENT_NAMES.VERIFICATION_FORM_REJECTED]: 'project-verification', [NOTIFICATIONS_EVENT_NAMES.PROJECT_BADGE_REVOKE_WARNING]: 'first-update-warning', [NOTIFICATIONS_EVENT_NAMES.PROJECT_BADGE_REVOKE_LAST_WARNING]: 'second-update-warning', - [NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE]: 'created-profile' + [NOTIFICATIONS_EVENT_NAMES.CREATE_ORTTO_PROFILE]: 'created-profile', + [NOTIFICATIONS_EVENT_NAMES.SEND_EMAIL_CONFIRMATION]: 'verification-form-email-verification', + [NOTIFICATIONS_EVENT_NAMES.NOTIFY_REWARD_AMOUNT]: 'notify-reward-amount', + [NOTIFICATIONS_EVENT_NAMES.SUBSCRIBE_ONBOARDING]: 'onboarding-form', } \ No newline at end of file diff --git a/src/utils/utils.ts b/src/utils/utils.ts index 674ee1a..1d8c328 100644 --- a/src/utils/utils.ts +++ b/src/utils/utils.ts @@ -19,6 +19,7 @@ export const MICRO_SERVICES = { givethio: 'givethio', givEconomyNotificationMicroService: 'giveconomy-notification-service', trace: 'trace', + notifyReward: 'notifyreward', }; // Need to define trace, blockchain and miscellaneos events diff --git a/src/utils/validators/segmentAndMetadataValidators.ts b/src/utils/validators/segmentAndMetadataValidators.ts index c932ca1..a4ccd88 100644 --- a/src/utils/validators/segmentAndMetadataValidators.ts +++ b/src/utils/validators/segmentAndMetadataValidators.ts @@ -30,6 +30,7 @@ const projectRelatedTrackerSchema = Joi.object({ slug: Joi.string().required(), projectLink: Joi.string().allow(null).allow(''), + verificationRejectedReason: Joi.string().allow(null, ''), // it's for project updates update: Joi.string().allow(null, ''), }); @@ -159,6 +160,10 @@ const superFluidTokenSegmentSchema = Joi.object({ isEnded: Joi.boolean(), }); +const subscribeOnboardingSchema = Joi.object({ + email: Joi.string().required(), +}) + const createOrttoProfileSegmentSchema = Joi.object({ email: Joi.string().required(), firstName: Joi.string().required(), @@ -166,16 +171,41 @@ const createOrttoProfileSegmentSchema = Joi.object({ userId: Joi.number().required() }) +const sendEmailConfirmationSchema = Joi.object({ + email: Joi.string().required(), + verificationLink: Joi.string().required(), +}); + +const notifyRewardAmountSegmentSchema = Joi.object({ + round: Joi.number().required(), + date: Joi.string().required(), + amount: Joi.string().required(), + contractAddress: Joi.string().required(), + farm: Joi.string().required(), + message: Joi.string().required(), + network: Joi.string().required(), + script: Joi.string().required(), + transactionHash: Joi.string().required(), +}) + export const SEGMENT_METADATA_SCHEMA_VALIDATOR: { [key: string]: { segment: ObjectSchema | null; metadata: ObjectSchema | null; }; } = { + sendEmailConfirmation: { + metadata: null, + segment: sendEmailConfirmationSchema, + }, createOrttoProfile: { segment: createOrttoProfileSegmentSchema, metadata: null }, + subscribeOnboarding: { + segment: subscribeOnboardingSchema, + metadata: null + }, userSuperTokensCritical: { metadata: superFluidTokenMetadataSchema, segment: superFluidTokenSegmentSchema, @@ -248,10 +278,6 @@ export const SEGMENT_METADATA_SCHEMA_VALIDATOR: { metadata: projectTitleProjectLinkSchema, segment: null, }, - sendEmailConfirmation: { - metadata: null, - segment: projectRelatedTrackerSchema, - }, madeDonation: { metadata: projectTitleProjectLinkSchema, segment: donationTrackerSchema, @@ -335,6 +361,10 @@ export const SEGMENT_METADATA_SCHEMA_VALIDATOR: { metadata: projectTitleProjectLinkSchema, segment: null, }, + notifyRewardAmount: { + metadata: null, + segment: notifyRewardAmountSegmentSchema, + }, }; function throwHttpErrorIfJoiValidatorFails( diff --git a/src/validators/schemaValidators.ts b/src/validators/schemaValidators.ts index 7540433..34b07a4 100644 --- a/src/validators/schemaValidators.ts +++ b/src/validators/schemaValidators.ts @@ -60,6 +60,12 @@ export const sendNotificationValidator = Joi.object({ userId: Joi.number(), projectLink: Joi.string().allow(null).allow(''), + // Email confirmation + verificationLink: Joi.string().allow(null).allow(''), + + // Verification form + verificationRejectedReason: Joi.string().allow(null, ''), + // Donation related attributes amount: Joi.number(), token: Joi.string().allow(null, ''), @@ -86,6 +92,16 @@ export const sendNotificationValidator = Joi.object({ // Project update update: Joi.string(), + + // Notify reward attributes + round: Joi.number(), + date: Joi.string(), + contractAddress: Joi.string(), + farm: Joi.string(), + message: Joi.string(), + network: Joi.string(), + script: Joi.string(), + transactionHash: Joi.string(), }), }), }); diff --git a/test/testUtils.ts b/test/testUtils.ts index 9890c5d..96b744b 100644 --- a/test/testUtils.ts +++ b/test/testUtils.ts @@ -112,6 +112,13 @@ export const getGivEconomyBasicAuth = () => { }); }; +export const getNotifyRewardBasicAuth = () => { + return createBasicAuthentication({ + secret: process.env.NOTIFY_REWARD_THIRD_PARTY_SECRET as string, + username: process.env.NOTIFY_REWARD_THIRD_PARTY_MICRO_SERVICE as string, + }); +}; + export const getAccessTokenForMockAuthMicroService = ( walletAddress: string, ) => {