diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f01a4f54..d34ed0c9 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -30,6 +30,8 @@ version: #image: python:3.7-stretch image: registry.gitlab.com/grassrootseconomics/cic-base-images/ci-version:b01318ae stage: version + tags: + - integration script: - mkdir -p ~/.ssh && chmod 700 ~/.ssh - ssh-keyscan gitlab.com >> ~/.ssh/known_hosts && chmod 644 ~/.ssh/known_hosts diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..c3b211d6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,83 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq + + + + +...Try to keep in mind the immortal +words of Bill and Ted, "Be excellent to each other." + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..73d76c43 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +Hello and welcome to the CIC Stack repository. Targeted for use with the ethereum virtual machine and a ussd capable telecom provider. + +__To request a change to the code please fork this repository and sumbit a merge request.__ + +__If there is a Grassroots Economics Kanban Issue please include that in our MR it will help us track contributions. Karibu sana!__ + +__Visit the Development Kanban board here: https://gitlab.com/grassrootseconomics/cic-internal-integration/-/boards/2419764__ + +__Ask a question in our dev chat:__ + +[Mattermost](https://chat.grassrootseconomics.net/cic/channels/dev) + +[Discord](https://discord.gg/XWunwAsX) + +[Matrix, IRC soon?] + diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..5c74bbd4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + cic-internal-integration + Copyright (C) 2021 Grassroots Economics + + 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/apps/cic-ussd/cic_ussd/account/balance.py b/apps/cic-ussd/cic_ussd/account/balance.py index ad9e7ba3..b2bb5ce2 100644 --- a/apps/cic-ussd/cic_ussd/account/balance.py +++ b/apps/cic-ussd/cic_ussd/account/balance.py @@ -2,7 +2,7 @@ import json import logging -from typing import Optional +from typing import Union, Optional # third-party imports from cic_eth.api import Api @@ -14,7 +14,7 @@ from cic_ussd.account.transaction import from_wei from cic_ussd.cache import cache_data_key, get_cached_data from cic_ussd.error import CachedDataNotFoundError -logg = logging.getLogger() +logg = logging.getLogger(__file__) def get_balances(address: str, @@ -43,7 +43,7 @@ def get_balances(address: str, :return: A list containing balance data if called synchronously. | None :rtype: list | None """ - logg.debug(f'retrieving balance for address: {address}') + logg.debug(f'retrieving {token_symbol} balance for address: {address}') if asynchronous: cic_eth_api = Api( chain_str=chain_str, @@ -60,11 +60,13 @@ def get_balances(address: str, return balance_request_task.get() -def calculate_available_balance(balances: dict) -> float: +def calculate_available_balance(balances: dict, decimals: int) -> float: """This function calculates an account's balance at a specific point in time by computing the difference from the outgoing balance and the sum of the incoming and network balances. :param balances: incoming, network and outgoing balances. :type balances: dict + :param decimals: + :type decimals: int :return: Token value of the available balance. :rtype: float """ @@ -73,7 +75,7 @@ def calculate_available_balance(balances: dict) -> float: network_balance = balances.get('balance_network') available_balance = (network_balance + incoming_balance) - outgoing_balance - return from_wei(value=available_balance) + return from_wei(decimals=decimals, value=available_balance) def get_adjusted_balance(balance: int, chain_str: str, timestamp: int, token_symbol: str): @@ -94,24 +96,25 @@ def get_adjusted_balance(balance: int, chain_str: str, timestamp: int, token_sym return demurrage_api.get_adjusted_balance(token_symbol, balance, timestamp).result -def get_cached_available_balance(blockchain_address: str) -> float: +def get_cached_available_balance(decimals: int, identifier: Union[list, bytes]) -> float: """This function attempts to retrieve balance data from the redis cache. - :param blockchain_address: Ethereum address of an account. - :type blockchain_address: str + :param decimals: + :type decimals: int + :param identifier: An identifier needed to create a unique pointer to a balances resource. + :type identifier: bytes | list :raises CachedDataNotFoundError: No cached balance data could be found. :return: Operational balance of an account. :rtype: float """ - identifier = bytes.fromhex(blockchain_address) - key = cache_data_key(identifier, salt=MetadataPointer.BALANCES) + key = cache_data_key(identifier=identifier, salt=MetadataPointer.BALANCES) cached_balances = get_cached_data(key=key) if cached_balances: - return calculate_available_balance(json.loads(cached_balances)) + return calculate_available_balance(balances=json.loads(cached_balances), decimals=decimals) else: - raise CachedDataNotFoundError(f'No cached available balance for address: {blockchain_address}') + raise CachedDataNotFoundError(f'No cached available balance at {key}') -def get_cached_adjusted_balance(identifier: bytes): +def get_cached_adjusted_balance(identifier: Union[list, bytes]): """ :param identifier: :type identifier: @@ -120,3 +123,22 @@ def get_cached_adjusted_balance(identifier: bytes): """ key = cache_data_key(identifier, MetadataPointer.BALANCES_ADJUSTED) return get_cached_data(key) + + +def get_account_tokens_balance(blockchain_address: str, chain_str: str, token_symbols_list: list): + """ + :param blockchain_address: + :type blockchain_address: + :param chain_str: + :type chain_str: + :param token_symbols_list: + :type token_symbols_list: + :return: + :rtype: + """ + for token_symbol in token_symbols_list: + get_balances(address=blockchain_address, + chain_str=chain_str, + token_symbol=token_symbol, + asynchronous=True, + callback_param=f'{blockchain_address},{token_symbol}') diff --git a/apps/cic-ussd/cic_ussd/account/statement.py b/apps/cic-ussd/cic_ussd/account/statement.py index 3dff2693..df0e1b02 100644 --- a/apps/cic-ussd/cic_ussd/account/statement.py +++ b/apps/cic-ussd/cic_ussd/account/statement.py @@ -69,7 +69,8 @@ def parse_statement_transactions(statement: list): parsed_transactions = [] for transaction in statement: action_tag = transaction.get('action_tag') - amount = from_wei(transaction.get('token_value')) + decimals = transaction.get('token_decimals') + amount = from_wei(decimals, transaction.get('token_value')) direction_tag = transaction.get('direction_tag') token_symbol = transaction.get('token_symbol') metadata_id = transaction.get('metadata_id') diff --git a/apps/cic-ussd/cic_ussd/account/tokens.py b/apps/cic-ussd/cic_ussd/account/tokens.py index f49bd835..4ffeb57b 100644 --- a/apps/cic-ussd/cic_ussd/account/tokens.py +++ b/apps/cic-ussd/cic_ussd/account/tokens.py @@ -1,19 +1,115 @@ # standard imports +import hashlib import json import logging -from typing import Dict, Optional +from typing import Optional, Union # external imports from cic_eth.api import Api from cic_types.condiments import MetadataPointer # local imports +from cic_ussd.account.balance import get_cached_available_balance from cic_ussd.account.chain import Chain -from cic_ussd.cache import cache_data_key, get_cached_data -from cic_ussd.error import SeppukuError +from cic_ussd.cache import cache_data, cache_data_key, get_cached_data +from cic_ussd.error import CachedDataNotFoundError, SeppukuError +from cic_ussd.metadata.tokens import query_token_info, query_token_metadata +from cic_ussd.processor.util import wait_for_cache +from cic_ussd.translation import translation_for + +logg = logging.getLogger(__file__) -logg = logging.getLogger(__name__) +def collate_token_metadata(token_info: dict, token_metadata: dict) -> dict: + """ + :param token_info: + :type token_info: + :param token_metadata: + :type token_metadata: + :return: + :rtype: + """ + logg.debug(f'Collating token info: {token_info} and token metadata: {token_metadata}') + description = token_info.get('description') + issuer = token_info.get('issuer') + location = token_metadata.get('location') + contact = token_metadata.get('contact') + return { + 'description': description, + 'issuer': issuer, + 'location': location, + 'contact': contact + } + + +def create_account_tokens_list(blockchain_address: str): + """ + :param blockchain_address: + :type blockchain_address: + :return: + :rtype: + """ + token_symbols_list = get_cached_token_symbol_list(blockchain_address=blockchain_address) + token_list_entries = [] + if token_symbols_list: + logg.debug(f'Token symbols: {token_symbols_list} for account: {blockchain_address}') + for token_symbol in token_symbols_list: + entry = {} + logg.debug(f'Processing token data for: {token_symbol}') + key = cache_data_key([bytes.fromhex(blockchain_address), token_symbol.encode('utf-8')], MetadataPointer.TOKEN_DATA) + token_data = get_cached_data(key) + token_data = json.loads(token_data) + logg.debug(f'Retrieved token data: {token_data} for: {token_symbol}') + token_name = token_data.get('name') + entry['name'] = token_name + token_symbol = token_data.get('symbol') + entry['symbol'] = token_symbol + token_issuer = token_data.get('issuer') + entry['issuer'] = token_issuer + token_contact = token_data['contact'].get('phone') + entry['contact'] = token_contact + token_location = token_data.get('location') + entry['location'] = token_location + decimals = token_data.get('decimals') + identifier = [bytes.fromhex(blockchain_address), token_symbol.encode('utf-8')] + wait_for_cache(identifier, f'Cached available balance for token: {token_symbol}', MetadataPointer.BALANCES) + token_balance = get_cached_available_balance(decimals=decimals, identifier=identifier) + entry['balance'] = token_balance + token_list_entries.append(entry) + account_tokens_list = order_account_tokens_list(token_list_entries, bytes.fromhex(blockchain_address)) + key = cache_data_key(bytes.fromhex(blockchain_address), MetadataPointer.TOKEN_DATA_LIST) + cache_data(key, json.dumps(account_tokens_list)) + + +def get_active_token_symbol(blockchain_address: str): + """ + :param blockchain_address: + :type blockchain_address: + :return: + :rtype: + """ + identifier = bytes.fromhex(blockchain_address) + key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_ACTIVE) + active_token_symbol = get_cached_data(key) + if not active_token_symbol: + raise CachedDataNotFoundError('No active token set.') + return active_token_symbol + + +def get_cached_token_data(blockchain_address: str, token_symbol: str): + """ + :param blockchain_address: + :type blockchain_address: + :param token_symbol: + :type token_symbol: + :return: + :rtype: + """ + identifier = [bytes.fromhex(blockchain_address), token_symbol.encode('utf-8')] + key = cache_data_key(identifier, MetadataPointer.TOKEN_DATA) + logg.debug(f'Retrieving token data for: {token_symbol} at: {key}') + token_data = get_cached_data(key) + return json.loads(token_data) def get_cached_default_token(chain_str: str) -> Optional[str]: @@ -49,6 +145,132 @@ def get_default_token_symbol(): raise SeppukuError(f'Could not retrieve default token for: {chain_str}') +def get_cached_token_symbol_list(blockchain_address: str) -> Optional[list]: + """ + :param blockchain_address: + :type blockchain_address: + :return: + :rtype: + """ + key = cache_data_key(identifier=bytes.fromhex(blockchain_address), salt=MetadataPointer.TOKEN_SYMBOLS_LIST) + token_symbols_list = get_cached_data(key) + if token_symbols_list: + return json.loads(token_symbols_list) + return token_symbols_list + + +def get_cached_token_data_list(blockchain_address: str) -> Optional[list]: + """ + :param blockchain_address: + :type blockchain_address: + :return: + :rtype: + """ + key = cache_data_key(bytes.fromhex(blockchain_address), MetadataPointer.TOKEN_DATA_LIST) + token_data_list = get_cached_data(key) + if token_data_list: + return json.loads(token_data_list) + return token_data_list + + +def handle_token_symbol_list(blockchain_address: str, token_symbol: str): + """ + :param blockchain_address: + :type blockchain_address: + :param token_symbol: + :type token_symbol: + :return: + :rtype: + """ + token_symbol_list = get_cached_token_symbol_list(blockchain_address) + if token_symbol_list: + if token_symbol not in token_symbol_list: + token_symbol_list.append(token_symbol) + else: + token_symbol_list = [token_symbol] + + identifier = bytes.fromhex(blockchain_address) + key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_SYMBOLS_LIST) + data = json.dumps(token_symbol_list) + cache_data(key, data) + + +def hashed_token_proof(token_proof: Union[dict, str]) -> str: + """ + :param token_proof: + :type token_proof: + :return: + :rtype: + """ + if isinstance(token_proof, dict): + token_proof = json.dumps(token_proof) + logg.debug(f'Hashing token proof: {token_proof}') + hash_object = hashlib.new("sha256") + hash_object.update(token_proof.encode('utf-8')) + return hash_object.digest().hex() + + +def order_account_tokens_list(account_tokens_list: list, identifier: bytes) -> list: + """ + :param account_tokens_list: + :type account_tokens_list: + :param identifier: + :type identifier: + :return: + :rtype: + """ + ordered_tokens_list = [] + # get last sent token + key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_LAST_SENT) + last_sent_token_symbol = get_cached_data(key) + + # get last received token + key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_LAST_RECEIVED) + last_received_token_symbol = get_cached_data(key) + + last_sent_token_data, remaining_accounts_token_list = remove_from_account_tokens_list(account_tokens_list, last_sent_token_symbol) + if last_sent_token_data: + ordered_tokens_list.append(last_sent_token_data[0]) + + last_received_token_data, remaining_accounts_token_list = remove_from_account_tokens_list(remaining_accounts_token_list, last_received_token_symbol) + if last_received_token_data: + ordered_tokens_list.append(last_received_token_data[0]) + + # order the by balance + ordered_by_balance = sorted(remaining_accounts_token_list, key=lambda d: d['balance'], reverse=True) + return ordered_tokens_list + ordered_by_balance + + +def parse_token_list(account_token_list: list): + parsed_token_list = [] + for i in range(len(account_token_list)): + token_symbol = account_token_list[i].get('symbol') + token_balance = account_token_list[i].get('balance') + token_data_repr = f'{i+1}. {token_symbol} {token_balance}' + parsed_token_list.append(token_data_repr) + return parsed_token_list + + +def process_token_data(blockchain_address: str, token_symbol: str): + """ + + :param blockchain_address: + :type blockchain_address: + :param token_symbol: + :type token_symbol: + :return: + :rtype: + """ + logg.debug(f'Processing token data for token: {token_symbol}') + identifier = token_symbol.encode('utf-8') + query_token_metadata(identifier=identifier) + token_info = query_token_info(identifier=identifier) + hashed_token_info = hashed_token_proof(token_proof=token_info) + query_token_data(blockchain_address=blockchain_address, + hashed_proofs=[hashed_token_info], + token_symbols=[token_symbol]) + + def query_default_token(chain_str: str): """This function synchronously queries cic-eth for the deployed system's default token. :param chain_str: Chain name and network id. @@ -60,3 +282,60 @@ def query_default_token(chain_str: str): cic_eth_api = Api(chain_str=chain_str) default_token_request_task = cic_eth_api.default_token() return default_token_request_task.get() + + +def query_token_data(blockchain_address: str, hashed_proofs: list, token_symbols: list): + """""" + logg.debug(f'Retrieving token metadata for tokens: {", ".join(token_symbols)}') + api = Api(callback_param=blockchain_address, + callback_queue='cic-ussd', + chain_str=Chain.spec.__str__(), + callback_task='cic_ussd.tasks.callback_handler.token_data_callback') + api.tokens(token_symbols=token_symbols, proof=hashed_proofs) + + +def remove_from_account_tokens_list(account_tokens_list: list, token_symbol: str): + """ + :param account_tokens_list: + :type account_tokens_list: + :param token_symbol: + :type token_symbol: + :return: + :rtype: + """ + removed_token_data = [] + for i in range(len(account_tokens_list)): + if account_tokens_list[i]['symbol'] == token_symbol: + removed_token_data.append(account_tokens_list[i]) + del account_tokens_list[i] + break + return removed_token_data, account_tokens_list + + +def set_active_token(blockchain_address: str, token_symbol: str): + """ + :param blockchain_address: + :type blockchain_address: + :param token_symbol: + :type token_symbol: + :return: + :rtype: + """ + logg.info(f'Active token set to: {token_symbol}') + key = cache_data_key(identifier=bytes.fromhex(blockchain_address), salt=MetadataPointer.TOKEN_ACTIVE) + cache_data(key=key, data=token_symbol) + + +def token_list_set(preferred_language: str, token_data_reprs: list): + """ + :param preferred_language: + :type preferred_language: + :param token_data_reprs: + :type token_data_reprs: + :return: + :rtype: + """ + if not token_data_reprs: + return translation_for('helpers.no_tokens_list', preferred_language) + return ''.join(f'{token_data_repr}\n' for token_data_repr in token_data_reprs) + diff --git a/apps/cic-ussd/cic_ussd/account/transaction.py b/apps/cic-ussd/cic_ussd/account/transaction.py index 980aae42..3844c8c2 100644 --- a/apps/cic-ussd/cic_ussd/account/transaction.py +++ b/apps/cic-ussd/cic_ussd/account/transaction.py @@ -1,7 +1,6 @@ # standard import -import decimal -import json import logging +from math import trunc from typing import Dict, Tuple # external import @@ -9,8 +8,6 @@ from cic_eth.api import Api from sqlalchemy.orm.session import Session # local import -from cic_ussd.account.chain import Chain -from cic_ussd.account.tokens import get_cached_default_token from cic_ussd.db.models.account import Account from cic_ussd.db.models.base import SessionBase from cic_ussd.error import UnknownUssdRecipient @@ -55,32 +52,32 @@ def aux_transaction_data(preferred_language: str, transaction: dict) -> dict: return transaction -def from_wei(value: int) -> float: +def from_wei(decimals: int, value: int) -> float: """This function converts values in Wei to a token in the cic network. + :param decimals: The decimals required for wei values. + :type decimals: int :param value: Value in Wei :type value: int :return: SRF equivalent of value in Wei :rtype: float """ - cached_token_data = json.loads(get_cached_default_token(Chain.spec.__str__())) - token_decimals: int = cached_token_data.get('decimals') - value = float(value) / (10**token_decimals) + value = float(value) / (10**decimals) return truncate(value=value, decimals=2) -def to_wei(value: int) -> int: +def to_wei(decimals: int, value: int) -> int: """This functions converts values from a token in the cic network to Wei. + :param decimals: The decimals required for wei values. + :type decimals: int :param value: Value in SRF :type value: int :return: Wei equivalent of value in SRF :rtype: int """ - cached_token_data = json.loads(get_cached_default_token(Chain.spec.__str__())) - token_decimals: int = cached_token_data.get('decimals') - return int(value * (10**token_decimals)) + return int(value * (10**decimals)) -def truncate(value: float, decimals: int): +def truncate(value: float, decimals: int) -> float: """This function truncates a value to a specified number of decimals places. :param value: The value to be truncated. :type value: float @@ -89,9 +86,8 @@ def truncate(value: float, decimals: int): :return: The truncated value. :rtype: int """ - decimal.getcontext().rounding = decimal.ROUND_DOWN - contextualized_value = decimal.Decimal(value) - return round(contextualized_value, decimals) + stepper = 10.0**decimals + return trunc(stepper*value) / stepper def transaction_actors(transaction: dict) -> Tuple[Dict, Dict]: @@ -104,14 +100,17 @@ def transaction_actors(transaction: dict) -> Tuple[Dict, Dict]: """ destination_token_symbol = transaction.get('destination_token_symbol') destination_token_value = transaction.get('destination_token_value') or transaction.get('to_value') + destination_token_decimals = transaction.get('destination_token_decimals') recipient_blockchain_address = transaction.get('recipient') sender_blockchain_address = transaction.get('sender') source_token_symbol = transaction.get('source_token_symbol') source_token_value = transaction.get('source_token_value') or transaction.get('from_value') + source_token_decimals = transaction.get('source_token_decimals') recipient_transaction_data = { "token_symbol": destination_token_symbol, "token_value": destination_token_value, + "token_decimals": destination_token_decimals, "blockchain_address": recipient_blockchain_address, "role": "recipient", } @@ -119,6 +118,7 @@ def transaction_actors(transaction: dict) -> Tuple[Dict, Dict]: "blockchain_address": sender_blockchain_address, "token_symbol": source_token_symbol, "token_value": source_token_value, + "token_decimals": source_token_decimals, "role": "sender", } return recipient_transaction_data, sender_transaction_data @@ -166,14 +166,16 @@ class OutgoingTransaction: self.from_address = from_address self.to_address = to_address - def transfer(self, amount: int, token_symbol: str): + def transfer(self, amount: int, decimals: int, token_symbol: str): """This function initiates standard transfers between one account to another :param amount: The amount of tokens to be sent :type amount: int + :param decimals: The decimals for the token being transferred. + :type decimals: int :param token_symbol: ERC20 token symbol of token to send :type token_symbol: str """ self.cic_eth_api.transfer(from_address=self.from_address, to_address=self.to_address, - value=to_wei(value=amount), + value=to_wei(decimals=decimals, value=amount), token_symbol=token_symbol) diff --git a/apps/cic-ussd/cic_ussd/cache.py b/apps/cic-ussd/cic_ussd/cache.py index 70689826..2faa46d9 100644 --- a/apps/cic-ussd/cic_ussd/cache.py +++ b/apps/cic-ussd/cic_ussd/cache.py @@ -1,12 +1,13 @@ # standard imports import hashlib import logging +from typing import Union # external imports from cic_types.condiments import MetadataPointer from redis import Redis -logg = logging.getLogger() +logg = logging.getLogger(__file__) class Cache: @@ -39,7 +40,7 @@ def get_cached_data(key: str): return cache.get(name=key) -def cache_data_key(identifier: bytes, salt: MetadataPointer): +def cache_data_key(identifier: Union[list, bytes], salt: MetadataPointer): """ :param identifier: :type identifier: @@ -49,6 +50,10 @@ def cache_data_key(identifier: bytes, salt: MetadataPointer): :rtype: """ hash_object = hashlib.new("sha256") - hash_object.update(identifier) + if isinstance(identifier, list): + for identity in identifier: + hash_object.update(identity) + else: + hash_object.update(identifier) hash_object.update(salt.value.encode(encoding="utf-8")) return hash_object.digest().hex() diff --git a/apps/cic-ussd/cic_ussd/db/migrations/default/versions/f289e8510444_.py b/apps/cic-ussd/cic_ussd/db/migrations/default/versions/f289e8510444_.py index b871cc9c..0bec677a 100644 --- a/apps/cic-ussd/cic_ussd/db/migrations/default/versions/f289e8510444_.py +++ b/apps/cic-ussd/cic_ussd/db/migrations/default/versions/f289e8510444_.py @@ -24,6 +24,8 @@ def upgrade(): sa.Column('preferred_language', sa.String(), nullable=True), sa.Column('password_hash', sa.String(), nullable=True), sa.Column('failed_pin_attempts', sa.Integer(), nullable=False), + sa.Column('guardians', sa.String(), nullable=True), + sa.Column('guardian_quora', sa.Integer(), nullable=False), sa.Column('status', sa.Integer(), nullable=False), sa.Column('created', sa.DateTime(), nullable=False), sa.Column('updated', sa.DateTime(), nullable=False), diff --git a/apps/cic-ussd/cic_ussd/db/models/account.py b/apps/cic-ussd/cic_ussd/db/models/account.py index fe0fe21c..505f822b 100644 --- a/apps/cic-ussd/cic_ussd/db/models/account.py +++ b/apps/cic-ussd/cic_ussd/db/models/account.py @@ -4,6 +4,8 @@ import json # external imports from cic_eth.api import Api from cic_types.condiments import MetadataPointer +from sqlalchemy import Column, Integer, String +from sqlalchemy.orm.session import Session # local imports from cic_ussd.account.metadata import get_cached_preferred_language, parse_account_metadata @@ -12,8 +14,9 @@ from cic_ussd.db.enum import AccountStatus from cic_ussd.db.models.base import SessionBase from cic_ussd.db.models.task_tracker import TaskTracker from cic_ussd.encoder import check_password_hash, create_password_hash -from sqlalchemy import Column, Integer, String -from sqlalchemy.orm.session import Session +from cic_ussd.phone_number import Support + +support_phone = Support.phone_number class Account(SessionBase): @@ -29,12 +32,16 @@ class Account(SessionBase): failed_pin_attempts = Column(Integer) status = Column(Integer) preferred_language = Column(String) + guardians = Column(String) + guardian_quora = Column(Integer) def __init__(self, blockchain_address, phone_number): self.blockchain_address = blockchain_address self.phone_number = phone_number self.password_hash = None self.failed_pin_attempts = 0 + # self.guardians = f'{support_phone}' if support_phone else None + self.guardian_quora = 1 self.status = AccountStatus.PENDING.value def __repr__(self): @@ -45,6 +52,28 @@ class Account(SessionBase): self.failed_pin_attempts = 0 self.status = AccountStatus.ACTIVE.value + def add_guardian(self, phone_number: str): + set_guardians = phone_number + if self.guardians: + set_guardians = self.guardians.split(',') + set_guardians.append(phone_number) + ','.join(set_guardians) + self.guardians = set_guardians + + def remove_guardian(self, phone_number: str): + set_guardians = self.guardians.split(',') + set_guardians.remove(phone_number) + if len(set_guardians) > 1: + self.guardians = ','.join(set_guardians) + else: + self.guardians = set_guardians[0] + + def get_guardians(self) -> list: + return self.guardians.split(',') if self.guardians else [] + + def set_guardian_quora(self, quora: int): + self.guardian_quora = quora + def create_password(self, password): """This method takes a password value and hashes the value before assigning it to the corresponding `hashed_password` attribute in the user record. diff --git a/apps/cic-ussd/cic_ussd/db/ussd_menu.json b/apps/cic-ussd/cic_ussd/db/ussd_menu.json index bbb23d74..a176f952 100644 --- a/apps/cic-ussd/cic_ussd/db/ussd_menu.json +++ b/apps/cic-ussd/cic_ussd/db/ussd_menu.json @@ -287,7 +287,132 @@ "display_key": "ussd.kenya.dob_edit_pin_authorization", "name": "dob_edit_pin_authorization", "parent": "metadata_management" + }, + "49": { + "description": "Menu to display first set of tokens in the account's token list.", + "display_key": "ussd.kenya.first_account_tokens_set", + "name": "first_account_tokens_set", + "parent": null + }, + "50": { + "description": "Menu to display middle set of tokens in the account's token list.", + "display_key": "ussd.kenya.middle_account_tokens_set", + "name": "middle_account_tokens_set", + "parent": null + }, + "51": { + "description": "Menu to display last set of tokens in the account's token list.", + "display_key": "ussd.kenya.last_account_tokens_set", + "name": "last_account_tokens_set", + "parent": null + }, + "52": { + "description": "Pin entry menu for setting an active token.", + "display_key": "ussd.kenya.token_selection_pin_authorization", + "name": "token_selection_pin_authorization", + "parent": null + }, + "53": { + "description": "Exit following a successful active token setting.", + "display_key": "ussd.kenya.exit_successful_token_selection", + "name": "exit_successful_token_selection", + "parent": null + }, + "54": { + "description": "Pin management menu for operations related to an account's pin.", + "display_key": "ussd.kenya.pin_management", + "name": "pin_management", + "parent": "start" + }, + "55": { + "description": "Phone number entry for account whose pin is being reset.", + "display_key": "ussd.kenya.reset_guarded_pin", + "name": "reset_guarded_pin", + "parent": "pin_management" + }, + "56": { + "description": "Pin entry for initiating request to reset an account's pin.", + "display_key": "ussd.kenya.reset_guarded_pin_authorization", + "name": "reset_guarded_pin_authorization", + "parent": "pin_management" + }, + "57": { + "description": "Exit menu following successful pin reset initiation.", + "display_key": "ussd.kenya.exit_pin_reset_initiated_success", + "name": "exit_pin_reset_initiated_success", + "parent": "pin_management" + }, + "58": { + "description": "Exit menu in the event that an account is not a set guardian.", + "display_key": "ussd.kenya.exit_not_authorized_for_pin_reset", + "name": "exit_not_authorized_for_pin_reset", + "parent": "pin_management" + }, + "59": { + "description": "Pin guard menu for handling guardianship operations.", + "display_key": "ussd.kenya.guard_pin", + "name": "guard_pin", + "parent": "pin_management" + }, + "60": { + "description": "Pin entry to display a list of set guardians.", + "display_key": "ussd.kenya.guardian_list_pin_authorization", + "name": "guardian_list_pin_authorization", + "parent": "guard_pin" + }, + "61": { + "description": "Menu to display list of set guardians.", + "display_key": "ussd.kenya.guardian_list", + "name": "guardian_list", + "parent": "guard_pin" + }, + "62": { + "description": "Phone number entry to add an account as a guardian to reset pin.", + "display_key": "ussd.kenya.add_guardian", + "name": "add_guardian", + "parent": "guard_pin" + }, + "63": { + "description": "Pin entry to confirm addition of an account as a guardian.", + "display_key": "ussd.kenya.add_guardian_pin_authorization", + "name": "add_guardian_pin_authorization", + "parent": "guard_pin" + }, + "64": { + "description": "Exit menu when an account is successfully added as pin reset guardian.", + "display_key": "ussd.kenya.exit_guardian_addition_success", + "name": "exit_guardian_addition_success", + "parent": "guard_pin" + }, + "65": { + "description": "Phone number entry to remove an account as a guardian to reset pin.", + "display_key": "ussd.kenya.remove_guardian", + "name": "remove_guardian", + "parent": "guard_pin" + }, + "66": { + "description": "Pin entry to confirm removal of an account as a guardian.", + "display_key": "ussd.kenya.remove_guardian_pin_authorization", + "name": "remove_guardian_pin_authorization", + "parent": "guard_pin" + }, + "67": { + "description": "Exit menu when an account is successfully removed as pin reset guardian.", + "display_key": "ussd.kenya.exit_guardian_removal_success", + "name": "exit_guardian_removal_success", + "parent": "guard_pin" + }, + "68": { + "description": "Exit menu when invalid phone number entry for guardian addition. ", + "display_key": "ussd.kenya.exit_invalid_guardian_addition", + "name": "exit_invalid_guardian_addition", + "parent": "guard_pin" + }, + "69": { + "description": "Exit menu when invalid phone number entry for guardian removal. ", + "display_key": "ussd.kenya.exit_invalid_guardian_removal", + "name": "exit_invalid_guardian_removal", + "parent": "guard_pin" } - } } \ No newline at end of file diff --git a/apps/cic-ussd/cic_ussd/metadata/base.py b/apps/cic-ussd/cic_ussd/metadata/base.py index acba2655..d75dbf23 100644 --- a/apps/cic-ussd/cic_ussd/metadata/base.py +++ b/apps/cic-ussd/cic_ussd/metadata/base.py @@ -13,7 +13,7 @@ logg = logging.getLogger(__file__) class UssdMetadataHandler(MetadataRequestsHandler): - def __init__(self, cic_type: MetadataPointer, identifier: bytes): + def __init__(self, identifier: bytes, cic_type: MetadataPointer = None): super().__init__(cic_type, identifier) def cache_metadata(self, data: str): diff --git a/apps/cic-ussd/cic_ussd/metadata/tokens.py b/apps/cic-ussd/cic_ussd/metadata/tokens.py new file mode 100644 index 00000000..f3b1c26b --- /dev/null +++ b/apps/cic-ussd/cic_ussd/metadata/tokens.py @@ -0,0 +1,54 @@ +# standard imports +from typing import Dict, Optional + +# external imports +import json + +from cic_types.condiments import MetadataPointer + +# local imports +from .base import UssdMetadataHandler +from cic_ussd.cache import cache_data +from cic_ussd.error import MetadataNotFoundError + + +class TokenMetadata(UssdMetadataHandler): + def __init__(self, identifier: bytes, **kwargs): + super(TokenMetadata, self).__init__(identifier=identifier, **kwargs) + + +def token_metadata_handler(metadata_client: TokenMetadata) -> Optional[Dict]: + """ + :param metadata_client: + :type metadata_client: + :return: + :rtype: + """ + result = metadata_client.query() + token_metadata = result.json() + if not token_metadata: + raise MetadataNotFoundError(f'No metadata found at: {metadata_client.metadata_pointer} for: {metadata_client.identifier.decode("utf-8")}') + cache_data(metadata_client.metadata_pointer, json.dumps(token_metadata)) + return token_metadata + + +def query_token_metadata(identifier: bytes): + """ + :param identifier: + :type identifier: + :return: + :rtype: + """ + token_metadata_client = TokenMetadata(identifier=identifier, cic_type=MetadataPointer.TOKEN_META_SYMBOL) + return token_metadata_handler(token_metadata_client) + + +def query_token_info(identifier: bytes): + """ + :param identifier: + :type identifier: + :return: + :rtype: + """ + token_info_client = TokenMetadata(identifier=identifier, cic_type=MetadataPointer.TOKEN_PROOF_SYMBOL) + return token_metadata_handler(token_info_client) diff --git a/apps/cic-ussd/cic_ussd/phone_number.py b/apps/cic-ussd/cic_ussd/phone_number.py index 0bb0a9cb..4541b69b 100644 --- a/apps/cic-ussd/cic_ussd/phone_number.py +++ b/apps/cic-ussd/cic_ussd/phone_number.py @@ -5,7 +5,6 @@ from typing import Optional import phonenumbers # local imports -from cic_ussd.db.models.account import Account class E164Format: diff --git a/apps/cic-ussd/cic_ussd/processor/menu.py b/apps/cic-ussd/cic_ussd/processor/menu.py index 24006a6c..5346a35d 100644 --- a/apps/cic-ussd/cic_ussd/processor/menu.py +++ b/apps/cic-ussd/cic_ussd/processor/menu.py @@ -9,6 +9,7 @@ from cic_types.condiments import MetadataPointer # local imports from cic_ussd.account.balance import (calculate_available_balance, + get_account_tokens_balance, get_adjusted_balance, get_balances, get_cached_adjusted_balance, @@ -21,13 +22,20 @@ from cic_ussd.account.statement import ( query_statement, statement_transaction_set ) -from cic_ussd.account.tokens import get_default_token_symbol +from cic_ussd.account.tokens import (create_account_tokens_list, + get_active_token_symbol, + get_cached_token_data, + get_cached_token_symbol_list, + get_cached_token_data_list, + parse_token_list, + token_list_set) from cic_ussd.account.transaction import from_wei, to_wei from cic_ussd.cache import cache_data_key, cache_data from cic_ussd.db.models.account import Account from cic_ussd.metadata import PersonMetadata from cic_ussd.phone_number import Support from cic_ussd.processor.util import parse_person_metadata +from cic_ussd.session.ussd_session import save_session_data from cic_ussd.translation import translation_for from sqlalchemy.orm.session import Session @@ -48,22 +56,27 @@ class MenuProcessor: :return: :rtype: """ - available_balance = get_cached_available_balance(self.account.blockchain_address) + adjusted_balance = get_cached_adjusted_balance(self.identifier) - token_symbol = get_default_token_symbol() + token_symbol = get_active_token_symbol(self.account.blockchain_address) + token_data = get_cached_token_data(self.account.blockchain_address, token_symbol) preferred_language = get_cached_preferred_language(self.account.blockchain_address) if not preferred_language: preferred_language = i18n.config.get('fallback') with_available_balance = f'{self.display_key}.available_balance' with_fees = f'{self.display_key}.with_fees' + decimals = token_data.get('decimals') + available_balance = get_cached_available_balance(decimals, [self.identifier, token_symbol.encode('utf-8')]) if not adjusted_balance: return translation_for(key=with_available_balance, preferred_language=preferred_language, available_balance=available_balance, token_symbol=token_symbol) + adjusted_balance = json.loads(adjusted_balance) - tax_wei = to_wei(int(available_balance)) - int(adjusted_balance) - tax = from_wei(int(tax_wei)) + + tax_wei = to_wei(decimals, int(available_balance)) - int(adjusted_balance) + tax = from_wei(decimals, int(tax_wei)) return translation_for(key=with_fees, preferred_language=preferred_language, available_balance=available_balance, @@ -76,21 +89,25 @@ class MenuProcessor: :rtype: """ cached_statement = get_cached_statement(self.account.blockchain_address) - statement = json.loads(cached_statement) - statement_transactions = parse_statement_transactions(statement) - transaction_sets = [statement_transactions[tx:tx + 3] for tx in range(0, len(statement_transactions), 3)] + transaction_sets = [] + if cached_statement: + statement = json.loads(cached_statement) + statement_transactions = parse_statement_transactions(statement) + transaction_sets = [statement_transactions[tx:tx + 3] for tx in range(0, len(statement_transactions), 3)] preferred_language = get_cached_preferred_language(self.account.blockchain_address) if not preferred_language: preferred_language = i18n.config.get('fallback') - first_transaction_set = [] - middle_transaction_set = [] - last_transaction_set = [] + no_transaction_history = statement_transaction_set(preferred_language, transaction_sets) + first_transaction_set = no_transaction_history + middle_transaction_set = no_transaction_history + last_transaction_set = no_transaction_history if transaction_sets: first_transaction_set = statement_transaction_set(preferred_language, transaction_sets[0]) if len(transaction_sets) >= 2: middle_transaction_set = statement_transaction_set(preferred_language, transaction_sets[1]) if len(transaction_sets) >= 3: last_transaction_set = statement_transaction_set(preferred_language, transaction_sets[2]) + if self.display_key == 'ussd.kenya.first_transaction_set': return translation_for( self.display_key, preferred_language, first_transaction_set=first_transaction_set @@ -104,7 +121,63 @@ class MenuProcessor: self.display_key, preferred_language, last_transaction_set=last_transaction_set ) - def help(self): + def add_guardian_pin_authorization(self): + guardian_information = self.guardian_metadata() + return self.pin_authorization(guardian_information=guardian_information) + + def guardian_list(self): + preferred_language = get_cached_preferred_language(self.account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + set_guardians = self.account.get_guardians() + if set_guardians: + guardians_list = '' + guardians_list_header = translation_for('helpers.guardians_list_header', preferred_language) + for phone_number in set_guardians: + guardian = Account.get_by_phone_number(phone_number, self.session) + guardian_information = guardian.standard_metadata_id() + guardians_list += f'{guardian_information}\n' + guardians_list = guardians_list_header + '\n' + guardians_list + else: + guardians_list = translation_for('helpers.no_guardians_list', preferred_language) + return translation_for(self.display_key, preferred_language, guardians_list=guardians_list) + + def account_tokens(self) -> str: + cached_token_data_list = get_cached_token_data_list(self.account.blockchain_address) + token_data_list = parse_token_list(cached_token_data_list) + token_list_sets = [token_data_list[tds:tds + 3] for tds in range(0, len(token_data_list), 3)] + preferred_language = get_cached_preferred_language(self.account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + no_token_list = token_list_set(preferred_language, []) + first_account_tokens_set = no_token_list + middle_account_tokens_set = no_token_list + last_account_tokens_set = no_token_list + if token_list_sets: + data = { + 'account_tokens_list': cached_token_data_list + } + save_session_data(data=data, queue='cic-ussd', session=self.session, ussd_session=self.ussd_session) + first_account_tokens_set = token_list_set(preferred_language, token_list_sets[0]) + + if len(token_list_sets) >= 2: + middle_account_tokens_set = token_list_set(preferred_language, token_list_sets[1]) + if len(token_list_sets) >= 3: + last_account_tokens_set = token_list_set(preferred_language, token_list_sets[2]) + if self.display_key == 'ussd.kenya.first_account_tokens_set': + return translation_for( + self.display_key, preferred_language, first_account_tokens_set=first_account_tokens_set + ) + if self.display_key == 'ussd.kenya.middle_account_tokens_set': + return translation_for( + self.display_key, preferred_language, middle_account_tokens_set=middle_account_tokens_set + ) + if self.display_key == 'ussd.kenya.last_account_tokens_set': + return translation_for( + self.display_key, preferred_language, last_account_tokens_set=last_account_tokens_set + ) + + def help(self) -> str: preferred_language = get_cached_preferred_language(self.account.blockchain_address) if not preferred_language: preferred_language = i18n.config.get('fallback') @@ -155,30 +228,48 @@ class MenuProcessor: f'{self.display_key}.retry', preferred_language, retry_pin_entry=retry_pin_entry ) + def guarded_account_metadata(self): + guarded_account_phone_number = self.ussd_session.get('data').get('guarded_account_phone_number') + guarded_account = Account.get_by_phone_number(guarded_account_phone_number, self.session) + return guarded_account.standard_metadata_id() + + def guardian_metadata(self): + guardian_phone_number = self.ussd_session.get('data').get('guardian_phone_number') + guardian = Account.get_by_phone_number(guardian_phone_number, self.session) + return guardian.standard_metadata_id() + + def reset_guarded_pin_authorization(self): + guarded_account_information = self.guarded_account_metadata() + return self.pin_authorization(guarded_account_information=guarded_account_information) + def start_menu(self): """ :return: :rtype: """ chain_str = Chain.spec.__str__() - token_symbol = get_default_token_symbol() + token_symbol = get_active_token_symbol(self.account.blockchain_address) + token_data = get_cached_token_data(self.account.blockchain_address, token_symbol) + decimals = token_data.get('decimals') blockchain_address = self.account.blockchain_address balances = get_balances(blockchain_address, chain_str, token_symbol, False)[0] - key = cache_data_key(self.identifier, MetadataPointer.BALANCES) + key = cache_data_key([self.identifier, token_symbol.encode('utf-8')], MetadataPointer.BALANCES) cache_data(key, json.dumps(balances)) - available_balance = calculate_available_balance(balances) + available_balance = calculate_available_balance(balances, decimals) now = datetime.now() if (now - self.account.created).days >= 30: if available_balance <= 0: logg.info(f'Not retrieving adjusted balance, available balance: {available_balance} is insufficient.') else: timestamp = int((now - timedelta(30)).timestamp()) - adjusted_balance = get_adjusted_balance(to_wei(int(available_balance)), chain_str, timestamp, token_symbol) - key = cache_data_key(self.identifier, MetadataPointer.BALANCES_ADJUSTED) + adjusted_balance = get_adjusted_balance(to_wei(decimals, int(available_balance)), chain_str, timestamp, token_symbol) + key = cache_data_key([self.identifier, token_symbol.encode('utf-8')], MetadataPointer.BALANCES_ADJUSTED) cache_data(key, json.dumps(adjusted_balance)) query_statement(blockchain_address) - + token_symbols_list = get_cached_token_symbol_list(blockchain_address) + get_account_tokens_balance(blockchain_address, chain_str, token_symbols_list) + create_account_tokens_list(blockchain_address) preferred_language = get_cached_preferred_language(self.account.blockchain_address) if not preferred_language: preferred_language = i18n.config.get('fallback') @@ -186,6 +277,20 @@ class MenuProcessor: self.display_key, preferred_language, account_balance=available_balance, account_token_name=token_symbol ) + def token_selection_pin_authorization(self) -> str: + """ + :return: + :rtype: + """ + selected_token = self.ussd_session.get('data').get('selected_token') + token_name = selected_token.get('name') + token_symbol = selected_token.get('symbol') + token_issuer = selected_token.get('issuer') + token_contact = selected_token.get('contact') + token_location = selected_token.get('location') + token_data = f'{token_name} ({token_symbol})\n{token_issuer}\n{token_contact}\n{token_location}\n' + return self.pin_authorization(token_data=token_data) + def transaction_pin_authorization(self) -> str: """ :return: @@ -195,36 +300,81 @@ class MenuProcessor: recipient = Account.get_by_phone_number(recipient_phone_number, self.session) tx_recipient_information = recipient.standard_metadata_id() tx_sender_information = self.account.standard_metadata_id() - token_symbol = get_default_token_symbol() + token_symbol = get_active_token_symbol(self.account.blockchain_address) + token_data = get_cached_token_data(self.account.blockchain_address, token_symbol) user_input = self.ussd_session.get('data').get('transaction_amount') - transaction_amount = to_wei(value=int(user_input)) + decimals = token_data.get('decimals') + transaction_amount = to_wei(decimals=decimals, value=int(user_input)) return self.pin_authorization( recipient_information=tx_recipient_information, - transaction_amount=from_wei(transaction_amount), + transaction_amount=from_wei(decimals, transaction_amount), token_symbol=token_symbol, sender_information=tx_sender_information ) + def exit_guardian_addition_success(self) -> str: + guardian_information = self.guardian_metadata() + preferred_language = get_cached_preferred_language(self.account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + return translation_for(self.display_key, + preferred_language, + guardian_information=guardian_information) + + def exit_guardian_removal_success(self): + guardian_information = self.guardian_metadata() + preferred_language = get_cached_preferred_language(self.account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + return translation_for(self.display_key, + preferred_language, + guardian_information=guardian_information) + + def exit_invalid_guardian_addition(self): + failure_reason = self.ussd_session.get('data').get('failure_reason') + preferred_language = get_cached_preferred_language(self.account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + return translation_for(self.display_key, preferred_language, error_exit=failure_reason) + + def exit_invalid_guardian_removal(self): + failure_reason = self.ussd_session.get('data').get('failure_reason') + preferred_language = get_cached_preferred_language(self.account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + return translation_for(self.display_key, preferred_language, error_exit=failure_reason) + + def exit_pin_reset_initiated_success(self): + guarded_account_information = self.guarded_account_metadata() + preferred_language = get_cached_preferred_language(self.account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + return translation_for(self.display_key, + preferred_language, + guarded_account_information=guarded_account_information) + def exit_insufficient_balance(self): """ :return: :rtype: """ - available_balance = get_cached_available_balance(self.account.blockchain_address) preferred_language = get_cached_preferred_language(self.account.blockchain_address) if not preferred_language: preferred_language = i18n.config.get('fallback') session_data = self.ussd_session.get('data') + token_symbol = get_active_token_symbol(self.account.blockchain_address) + token_data = get_cached_token_data(self.account.blockchain_address, token_symbol) + decimals = token_data.get('decimals') + available_balance = get_cached_available_balance(decimals, [self.identifier, token_symbol.encode('utf-8')]) transaction_amount = session_data.get('transaction_amount') - transaction_amount = to_wei(value=int(transaction_amount)) - token_symbol = get_default_token_symbol() + transaction_amount = to_wei(decimals=decimals, value=int(transaction_amount)) recipient_phone_number = self.ussd_session.get('data').get('recipient_phone_number') recipient = Account.get_by_phone_number(recipient_phone_number, self.session) tx_recipient_information = recipient.standard_metadata_id() return translation_for( self.display_key, preferred_language, - amount=from_wei(transaction_amount), + amount=from_wei(decimals, transaction_amount), token_symbol=token_symbol, recipient_information=tx_recipient_information, token_balance=available_balance @@ -242,6 +392,14 @@ class MenuProcessor: preferred_language = i18n.config.get('fallback') return translation_for('ussd.kenya.exit_pin_blocked', preferred_language, support_phone=Support.phone_number) + def exit_successful_token_selection(self) -> str: + selected_token = self.ussd_session.get('data').get('selected_token') + token_symbol = selected_token.get('symbol') + preferred_language = get_cached_preferred_language(self.account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + return translation_for(self.display_key,preferred_language,token_symbol=token_symbol) + def exit_successful_transaction(self): """ :return: @@ -251,8 +409,10 @@ class MenuProcessor: preferred_language = get_cached_preferred_language(self.account.blockchain_address) if not preferred_language: preferred_language = i18n.config.get('fallback') - transaction_amount = to_wei(amount) - token_symbol = get_default_token_symbol() + token_symbol = get_active_token_symbol(self.account.blockchain_address) + token_data = get_cached_token_data(self.account.blockchain_address, token_symbol) + decimals = token_data.get('decimals') + transaction_amount = to_wei(decimals, amount) recipient_phone_number = self.ussd_session.get('data').get('recipient_phone_number') recipient = Account.get_by_phone_number(phone_number=recipient_phone_number, session=self.session) tx_recipient_information = recipient.standard_metadata_id() @@ -260,7 +420,7 @@ class MenuProcessor: return translation_for( self.display_key, preferred_language, - transaction_amount=from_wei(transaction_amount), + transaction_amount=from_wei(decimals, transaction_amount), token_symbol=token_symbol, recipient_information=tx_recipient_information, sender_information=tx_sender_information @@ -294,15 +454,42 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio if menu_name == 'transaction_pin_authorization': return menu_processor.transaction_pin_authorization() + if menu_name == 'token_selection_pin_authorization': + return menu_processor.token_selection_pin_authorization() + if menu_name == 'exit_insufficient_balance': return menu_processor.exit_insufficient_balance() + if menu_name == 'exit_invalid_guardian_addition': + return menu_processor.exit_invalid_guardian_addition() + + if menu_name == 'exit_invalid_guardian_removal': + return menu_processor.exit_invalid_guardian_removal() + if menu_name == 'exit_successful_transaction': return menu_processor.exit_successful_transaction() + if menu_name == 'exit_guardian_addition_success': + return menu_processor.exit_guardian_addition_success() + + if menu_name == 'exit_guardian_removal_success': + return menu_processor.exit_guardian_removal_success() + + if menu_name == 'exit_pin_reset_initiated_success': + return menu_processor.exit_pin_reset_initiated_success() + if menu_name == 'account_balances': return menu_processor.account_balances() + if menu_name == 'guardian_list': + return menu_processor.guardian_list() + + if menu_name == 'add_guardian_pin_authorization': + return menu_processor.add_guardian_pin_authorization() + + if menu_name == 'reset_guarded_pin_authorization': + return menu_processor.reset_guarded_pin_authorization() + if 'pin_authorization' in menu_name: return menu_processor.pin_authorization() @@ -312,6 +499,9 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio if 'transaction_set' in menu_name: return menu_processor.account_statement() + if 'account_tokens_set' in menu_name: + return menu_processor.account_tokens() + if menu_name == 'display_user_metadata': return menu_processor.person_metadata() @@ -321,6 +511,9 @@ def response(account: Account, display_key: str, menu_name: str, session: Sessio if menu_name == 'exit_pin_blocked': return menu_processor.exit_pin_blocked() + if menu_name == 'exit_successful_token_selection': + return menu_processor.exit_successful_token_selection() + preferred_language = get_cached_preferred_language(account.blockchain_address) return translation_for(display_key, preferred_language) diff --git a/apps/cic-ussd/cic_ussd/processor/util.py b/apps/cic-ussd/cic_ussd/processor/util.py index 83b4c600..b2baf261 100644 --- a/apps/cic-ussd/cic_ussd/processor/util.py +++ b/apps/cic-ussd/cic_ussd/processor/util.py @@ -1,15 +1,22 @@ # standard imports import datetime import json +import logging +import time +from typing import Union # external imports +from cic_types.condiments import MetadataPointer from cic_types.models.person import get_contact_data_from_vcard from tinydb.table import Document # local imports +from cic_ussd.cache import cache_data_key, get_cached_data from cic_ussd.menu.ussd_menu import UssdMenu from cic_ussd.translation import translation_for +logg = logging.getLogger(__file__) + def latest_input(user_input: str) -> str: """ @@ -76,3 +83,66 @@ def resume_last_ussd_session(last_state: str) -> Document: if last_state in non_reusable_states: return UssdMenu.find_by_name('start') return UssdMenu.find_by_name(last_state) + + +def wait_for_cache(identifier: Union[list, bytes], resource_name: str, salt: MetadataPointer, interval: int = 1, max_retry: int = 5): + """ + :param identifier: + :type identifier: + :param interval: + :type interval: + :param resource_name: + :type resource_name: + :param salt: + :type salt: + :param max_retry: + :type max_retry: + :return: + :rtype: + """ + key = cache_data_key(identifier=identifier, salt=salt) + resource = get_cached_data(key) + counter = 0 + while resource is None: + logg.debug(f'Waiting for: {resource_name} at: {key}. Checking after: {interval} ...') + time.sleep(interval) + counter += 1 + resource = get_cached_data(key) + if resource is not None: + logg.debug(f'{resource_name} now available.') + break + else: + if counter == max_retry: + logg.debug(f'Could not find: {resource_name} within: {max_retry}') + break + + +def wait_for_session_data(resource_name: str, session_data_key: str, ussd_session: dict, interval: int = 1, max_retry: int = 5): + """ + :param interval: + :type interval: + :param resource_name: + :type resource_name: + :param session_data_key: + :type session_data_key: + :param ussd_session: + :type ussd_session: + :param max_retry: + :type max_retry: + :return: + :rtype: + """ + session_data = ussd_session.get('data').get(session_data_key) + counter = 0 + while session_data is None: + logg.debug(f'Waiting for: {resource_name}. Checking after: {interval} ...') + time.sleep(interval) + counter += 1 + session_data = ussd_session.get('data').get(session_data_key) + if session_data is not None: + logg.debug(f'{resource_name} now available.') + break + else: + if counter == max_retry: + logg.debug(f'Could not find: {resource_name} within: {max_retry}') + break diff --git a/apps/cic-ussd/cic_ussd/runnable/client.py b/apps/cic-ussd/cic_ussd/runnable/client.py index 37a62898..17beae7b 100644 --- a/apps/cic-ussd/cic_ussd/runnable/client.py +++ b/apps/cic-ussd/cic_ussd/runnable/client.py @@ -63,7 +63,6 @@ elif ssl == 0: else: ssl = True -valid_service_codes = config.get('USSD_SERVICE_CODE').split(",") def main(): # TODO: improve url building @@ -79,7 +78,7 @@ def main(): session = uuid.uuid4().hex data = { 'sessionId': session, - 'serviceCode': valid_service_codes[0], + 'serviceCode': config.get('USSD_SERVICE_CODE'), 'phoneNumber': args.phone, 'text': "", } diff --git a/apps/cic-ussd/cic_ussd/session/ussd_session.py b/apps/cic-ussd/cic_ussd/session/ussd_session.py index 9df54afa..92d9323f 100644 --- a/apps/cic-ussd/cic_ussd/session/ussd_session.py +++ b/apps/cic-ussd/cic_ussd/session/ussd_session.py @@ -13,7 +13,7 @@ from cic_ussd.cache import Cache from cic_ussd.db.models.base import SessionBase from cic_ussd.db.models.ussd_session import UssdSession as DbUssdSession -logg = logging.getLogger() +logg = logging.getLogger(__file__) class UssdSession: @@ -239,11 +239,16 @@ def save_session_data(queue: Optional[str], session: Session, data: dict, ussd_s :param ussd_session: A ussd session passed to the state machine. :type ussd_session: UssdSession """ + logg.debug(f'Saving: {data} session data to: {ussd_session}') cache = Cache.store external_session_id = ussd_session.get('external_session_id') existing_session_data = ussd_session.get('data') if existing_session_data: - data = {**existing_session_data, **data} + # replace session data entry + keys = data.keys() + for key in keys: + existing_session_data[key] = data[key] + data = existing_session_data in_redis_ussd_session = cache.get(external_session_id) in_redis_ussd_session = json.loads(in_redis_ussd_session) create_or_update_session( diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/menu.py b/apps/cic-ussd/cic_ussd/state_machine/logic/menu.py index e8c80fce..cf2b127b 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/menu.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/menu.py @@ -81,6 +81,18 @@ def menu_six_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> return user_input == '6' +def menu_nine_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: + """ + This function checks that user input matches a string with value '6' + :param state_machine_data: A tuple containing user input, a ussd session and user object. + :type state_machine_data: tuple + :return: A user input's match with '6' + :rtype: bool + """ + user_input, ussd_session, account, session = state_machine_data + return user_input == '9' + + def menu_zero_zero_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """ This function checks that user input matches a string with value '00' @@ -93,6 +105,30 @@ def menu_zero_zero_selected(state_machine_data: Tuple[str, dict, Account, Sessio return user_input == '00' +def menu_eleven_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: + """ + This function checks that user input matches a string with value '11' + :param state_machine_data: A tuple containing user input, a ussd session and user object. + :type state_machine_data: tuple + :return: A user input's match with '99' + :rtype: bool + """ + user_input, ussd_session, account, session = state_machine_data + return user_input == '11' + + +def menu_twenty_two_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: + """ + This function checks that user input matches a string with value '22' + :param state_machine_data: A tuple containing user input, a ussd session and user object. + :type state_machine_data: tuple + :return: A user input's match with '99' + :rtype: bool + """ + user_input, ussd_session, account, session = state_machine_data + return user_input == '22' + + def menu_ninety_nine_selected(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """ This function checks that user input matches a string with value '99' diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/pin.py b/apps/cic-ussd/cic_ussd/state_machine/logic/pin.py index 50f9be12..b00cea0a 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/pin.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/pin.py @@ -3,7 +3,6 @@ user's pin. """ # standard imports -import json import logging import re from typing import Tuple @@ -16,6 +15,7 @@ from cic_ussd.db.models.account import Account from cic_ussd.db.models.base import SessionBase from cic_ussd.db.enum import AccountStatus from cic_ussd.encoder import create_password_hash, check_password_hash +from cic_ussd.processor.util import wait_for_session_data from cic_ussd.session.ussd_session import create_or_update_session, persist_ussd_session @@ -31,11 +31,8 @@ def is_valid_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool :rtype: bool """ user_input, ussd_session, account, session = state_machine_data - pin_is_valid = False matcher = r'^\d{4}$' - if re.match(matcher, user_input): - pin_is_valid = True - return pin_is_valid + return bool(re.match(matcher, user_input)) def is_authorized_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: @@ -68,7 +65,7 @@ def save_initial_pin_to_session_data(state_machine_data: Tuple[str, dict, Accoun :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user, session = state_machine_data + user_input, ussd_session, account, session = state_machine_data initial_pin = create_password_hash(user_input) if ussd_session.get('data'): data = ussd_session.get('data') @@ -97,7 +94,8 @@ def pins_match(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: :return: A match between two pin values. :rtype: bool """ - user_input, ussd_session, user, session = state_machine_data + user_input, ussd_session, account, session = state_machine_data + wait_for_session_data('Initial pin', session_data_key='initial_pin', ussd_session=ussd_session) initial_pin = ussd_session.get('data').get('initial_pin') return check_password_hash(user_input, initial_pin) @@ -107,11 +105,12 @@ def complete_pin_change(state_machine_data: Tuple[str, dict, Account, Session]): :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user, session = state_machine_data + user_input, ussd_session, account, session = state_machine_data session = SessionBase.bind_session(session=session) + wait_for_session_data('Initial pin', session_data_key='initial_pin', ussd_session=ussd_session) password_hash = ussd_session.get('data').get('initial_pin') - user.password_hash = password_hash - session.add(user) + account.password_hash = password_hash + session.add(account) session.flush() SessionBase.release_session(session=session) @@ -134,6 +133,6 @@ def is_valid_new_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> :return: A match between two pin values. :rtype: bool """ - user_input, ussd_session, user, session = state_machine_data - is_old_pin = user.verify_password(password=user_input) + user_input, ussd_session, account, session = state_machine_data + is_old_pin = account.verify_password(password=user_input) return is_valid_pin(state_machine_data=state_machine_data) and not is_old_pin diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/pin_guard.py b/apps/cic-ussd/cic_ussd/state_machine/logic/pin_guard.py new file mode 100644 index 00000000..4e87e473 --- /dev/null +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/pin_guard.py @@ -0,0 +1,200 @@ +# standard imports +import logging +from typing import Tuple + +# external imports +import celery +import i18n +from phonenumbers.phonenumberutil import NumberParseException +from sqlalchemy.orm.session import Session + +# local imports +from cic_ussd.account.metadata import get_cached_preferred_language +from cic_ussd.db.models.account import Account +from cic_ussd.db.models.base import SessionBase +from cic_ussd.phone_number import process_phone_number, E164Format +from cic_ussd.session.ussd_session import save_session_data +from cic_ussd.translation import translation_for + + +logg = logging.getLogger(__file__) + + +def save_guardian_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + session_data = ussd_session.get('data') or {} + guardian_phone_number = process_phone_number(phone_number=user_input, region=E164Format.region) + session_data['guardian_phone_number'] = guardian_phone_number + save_session_data('cic-ussd', session, session_data, ussd_session) + + +def save_guarded_account_session_data(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + session_data = ussd_session.get('data') or {} + guarded_account_phone_number = process_phone_number(phone_number=user_input, region=E164Format.region) + session_data['guarded_account_phone_number'] = guarded_account_phone_number + save_session_data('cic-ussd', session, session_data, ussd_session) + + +def retrieve_person_metadata(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + guardian_phone_number = process_phone_number(user_input, E164Format.region) + guardian = Account.get_by_phone_number(guardian_phone_number, session) + blockchain_address = guardian.blockchain_address + s_query_person_metadata = celery.signature( + 'cic_ussd.tasks.metadata.query_person_metadata', [blockchain_address], queue='cic-ussd') + s_query_person_metadata.apply_async() + + +def is_valid_guardian_addition(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + try: + phone_number = process_phone_number(user_input, E164Format.region) + except NumberParseException: + phone_number = None + + preferred_language = get_cached_preferred_language(account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + + is_valid_account = Account.get_by_phone_number(phone_number, session) is not None + is_initiator = phone_number == account.phone_number + is_existent_guardian = phone_number in account.get_guardians() + + failure_reason = '' + if not is_valid_account: + failure_reason = translation_for('helpers.error.no_matching_account', preferred_language) + + if is_initiator: + failure_reason = translation_for('helpers.error.is_initiator', preferred_language) + + if is_existent_guardian: + failure_reason = translation_for('helpers.error.is_existent_guardian', preferred_language) + + if failure_reason: + session_data = ussd_session.get('data') or {} + session_data['failure_reason'] = failure_reason + save_session_data('cic-ussd', session, session_data, ussd_session) + + return phone_number is not None and is_valid_account and not is_existent_guardian and not is_initiator + + +def add_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + guardian_phone_number = ussd_session.get('data').get('guardian_phone_number') + account.add_guardian(guardian_phone_number) + session.add(account) + session.flush() + SessionBase.release_session(session=session) + + +def is_set_pin_guardian(account: Account, checked_number: str, preferred_language: str, session: Session, ussd_session: dict): + """""" + failure_reason = '' + set_guardians = [] + if account: + set_guardians = account.get_guardians() + else: + failure_reason = translation_for('helpers.error.no_matching_account', preferred_language) + + is_set_guardian = checked_number in set_guardians + is_initiator = checked_number == account.phone_number + + if not is_set_guardian: + failure_reason = translation_for('helpers.error.is_not_existent_guardian', preferred_language) + + if is_initiator: + failure_reason = translation_for('helpers.error.is_initiator', preferred_language) + + if failure_reason: + session_data = ussd_session.get('data') or {} + session_data['failure_reason'] = failure_reason + save_session_data('cic-ussd', session, session_data, ussd_session) + + return is_set_guardian and not is_initiator + + +def is_dialers_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]): + user_input, ussd_session, account, session = state_machine_data + phone_number = process_phone_number(phone_number=user_input, region=E164Format.region) + preferred_language = get_cached_preferred_language(account.blockchain_address) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + return is_set_pin_guardian(account, phone_number, preferred_language, session, ussd_session) + + +def is_others_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]): + user_input, ussd_session, account, session = state_machine_data + preferred_language = get_cached_preferred_language(account.blockchain_address) + phone_number = process_phone_number(phone_number=user_input, region=E164Format.region) + guarded_account = Account.get_by_phone_number(phone_number, session) + if not preferred_language: + preferred_language = i18n.config.get('fallback') + return is_set_pin_guardian(guarded_account, account.phone_number, preferred_language, session, ussd_session) + + +def remove_pin_guardian(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + guardian_phone_number = ussd_session.get('data').get('guardian_phone_number') + account.remove_guardian(guardian_phone_number) + session.add(account) + session.flush() + SessionBase.release_session(session=session) + + +def initiate_pin_reset(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + session_data = ussd_session.get('data') + quorum_count = session_data['quorum_count'] if session_data.get('quorum_count') else 0 + quorum_count += 1 + session_data['quorum_count'] = quorum_count + save_session_data('cic-ussd', session, session_data, ussd_session) + guarded_account_phone_number = session_data.get('guarded_account_phone_number') + guarded_account = Account.get_by_phone_number(guarded_account_phone_number, session) + if quorum_count >= guarded_account.guardian_quora: + guarded_account.reset_pin(session) + logg.debug(f'Reset initiated for: {guarded_account.phone_number}') + session_data['quorum_count'] = 0 + save_session_data('cic-ussd', session, session_data, ussd_session) diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/sms.py b/apps/cic-ussd/cic_ussd/state_machine/logic/sms.py index 7988a06c..7bf582f6 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/sms.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/sms.py @@ -6,7 +6,7 @@ from sqlalchemy.orm.session import Session # local imports from cic_ussd.account.metadata import get_cached_preferred_language -from cic_ussd.account.tokens import get_default_token_symbol +from cic_ussd.account.tokens import get_active_token_symbol from cic_ussd.db.models.account import Account from cic_ussd.notifications import Notifier from cic_ussd.phone_number import Support @@ -18,7 +18,7 @@ def upsell_unregistered_recipient(state_machine_data: Tuple[str, dict, Account, notifier = Notifier() phone_number = ussd_session.get('data')['recipient_phone_number'] preferred_language = get_cached_preferred_language(account.blockchain_address) - token_symbol = get_default_token_symbol() + token_symbol = get_active_token_symbol(account.blockchain_address) tx_sender_information = account.standard_metadata_id() notifier.send_sms_notification('sms.upsell_unregistered_recipient', phone_number, diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/tokens.py b/apps/cic-ussd/cic_ussd/state_machine/logic/tokens.py new file mode 100644 index 00000000..7f4c2398 --- /dev/null +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/tokens.py @@ -0,0 +1,69 @@ +# standard imports +from typing import Tuple + +# external imports +from sqlalchemy.orm.session import Session + +# local imports +from cic_ussd.account.tokens import set_active_token +from cic_ussd.db.models.account import Account +from cic_ussd.processor.util import wait_for_session_data +from cic_ussd.session.ussd_session import save_session_data + + +def is_valid_token_selection(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + session_data = ussd_session.get('data') + account_tokens_list = session_data.get('account_tokens_list') + if not account_tokens_list: + wait_for_session_data('Account token list', session_data_key='account_tokens_list', ussd_session=ussd_session) + if user_input not in ['00', '22']: + try: + user_input = int(user_input) + return user_input <= len(account_tokens_list) + except ValueError: + user_input = user_input.upper() + return any(token_data['symbol'] == user_input for token_data in account_tokens_list) + + +def process_token_selection(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + account_tokens_list = ussd_session.get('data').get('account_tokens_list') + try: + user_input = int(user_input) + selected_token = account_tokens_list[user_input-1] + except ValueError: + user_input = user_input.upper() + selected_token = next(token_data for token_data in account_tokens_list if token_data['symbol'] == user_input) + data = { + 'selected_token': selected_token + } + save_session_data(queue='cic-ussd', session=session, data=data, ussd_session=ussd_session) + + +def set_selected_active_token(state_machine_data: Tuple[str, dict, Account, Session]): + """ + :param state_machine_data: + :type state_machine_data: + :return: + :rtype: + """ + user_input, ussd_session, account, session = state_machine_data + wait_for_session_data(resource_name='Selected token', session_data_key='selected_token', ussd_session=ussd_session) + selected_token = ussd_session.get('data').get('selected_token') + token_symbol = selected_token.get('symbol') + set_active_token(blockchain_address=account.blockchain_address, token_symbol=token_symbol) + + diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/transaction.py b/apps/cic-ussd/cic_ussd/state_machine/logic/transaction.py index 1667908d..84658815 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/transaction.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/transaction.py @@ -5,18 +5,17 @@ from typing import Tuple # third party imports import celery from phonenumbers.phonenumberutil import NumberParseException +from sqlalchemy.orm.session import Session # local imports from cic_ussd.account.balance import get_cached_available_balance from cic_ussd.account.chain import Chain -from cic_ussd.account.tokens import get_default_token_symbol +from cic_ussd.account.tokens import get_active_token_symbol, get_cached_token_data from cic_ussd.account.transaction import OutgoingTransaction -from cic_ussd.db.enum import AccountStatus from cic_ussd.db.models.account import Account -from cic_ussd.db.models.base import SessionBase from cic_ussd.phone_number import process_phone_number, E164Format from cic_ussd.session.ussd_session import save_session_data -from sqlalchemy.orm.session import Session + logg = logging.getLogger(__file__) @@ -63,7 +62,11 @@ def has_sufficient_balance(state_machine_data: Tuple[str, dict, Account, Session :rtype: bool """ user_input, ussd_session, account, session = state_machine_data - return int(user_input) <= get_cached_available_balance(account.blockchain_address) + identifier = bytes.fromhex(account.blockchain_address) + token_symbol = get_active_token_symbol(account.blockchain_address) + token_data = get_cached_token_data(account.blockchain_address, token_symbol) + decimals = token_data.get('decimals') + return int(user_input) <= get_cached_available_balance(decimals, [identifier, token_symbol.encode('utf-8')]) def save_recipient_phone_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]): @@ -122,9 +125,10 @@ def process_transaction_request(state_machine_data: Tuple[str, dict, Account, Se to_address = recipient.blockchain_address from_address = account.blockchain_address amount = int(ussd_session.get('data').get('transaction_amount')) - token_symbol = get_default_token_symbol() - + token_symbol = get_active_token_symbol(account.blockchain_address) + token_data = get_cached_token_data(account.blockchain_address, token_symbol) + decimals = token_data.get('decimals') outgoing_tx_processor = OutgoingTransaction(chain_str=chain_str, from_address=from_address, to_address=to_address) - outgoing_tx_processor.transfer(amount=amount, token_symbol=token_symbol) + outgoing_tx_processor.transfer(amount=amount, decimals=decimals, token_symbol=token_symbol) diff --git a/apps/cic-ussd/cic_ussd/tasks/callback_handler.py b/apps/cic-ussd/cic_ussd/tasks/callback_handler.py index 9a13bf74..08bd56fa 100644 --- a/apps/cic-ussd/cic_ussd/tasks/callback_handler.py +++ b/apps/cic-ussd/cic_ussd/tasks/callback_handler.py @@ -1,4 +1,5 @@ # standard imports + import json import logging from datetime import timedelta @@ -7,7 +8,6 @@ from datetime import timedelta import celery from cic_types.condiments import MetadataPointer - # local imports from cic_ussd.account.balance import get_balances, calculate_available_balance from cic_ussd.account.statement import generate @@ -15,8 +15,15 @@ from cic_ussd.cache import Cache, cache_data, cache_data_key, get_cached_data from cic_ussd.account.chain import Chain from cic_ussd.db.models.base import SessionBase from cic_ussd.db.models.account import Account +from cic_ussd.processor.util import wait_for_cache from cic_ussd.account.statement import filter_statement_transactions from cic_ussd.account.transaction import transaction_actors +from cic_ussd.account.tokens import (collate_token_metadata, + get_cached_token_data, + get_default_token_symbol, + handle_token_symbol_list, + process_token_data, + set_active_token) from cic_ussd.error import AccountCreationDataNotFound from cic_ussd.tasks.base import CriticalSQLAlchemyTask @@ -58,6 +65,9 @@ def account_creation_callback(self, result: str, url: str, status_code: int): session.close() logg.debug(f'recorded account with identifier: {result}') + token_symbol = get_default_token_symbol() + set_active_token(blockchain_address=result, token_symbol=token_symbol) + queue = self.request.delivery_info.get('routing_key') s_phone_pointer = celery.signature( 'cic_ussd.tasks.metadata.add_phone_pointer', [result, phone_number], queue=queue @@ -88,8 +98,16 @@ def balances_callback(result: list, param: str, status_code: int): raise ValueError(f'Unexpected status code: {status_code}.') balances = result[0] - identifier = bytes.fromhex(param) - key = cache_data_key(identifier, MetadataPointer.BALANCES) + identifier = [] + param = param.split(',') + for identity in param: + try: + i = bytes.fromhex(identity) + identifier.append(i) + except ValueError: + i = identity.encode('utf-8') + identifier.append(i) + key = cache_data_key(identifier=identifier, salt=MetadataPointer.BALANCES) cache_data(key, json.dumps(balances)) @@ -122,6 +140,38 @@ def statement_callback(self, result, param: str, status_code: int): generate(param, queue, sender_transaction) +@celery_app.task +def token_data_callback(result: dict, param: str, status_code: int): + """ + :param result: + :type result: + :param param: + :type param: + :param status_code: + :type status_code: + :return: + :rtype: + """ + + if status_code != 0: + raise ValueError(f'Unexpected status code: {status_code}.') + + token = result[0] + token_symbol = token.get('symbol') + identifier = token_symbol.encode('utf-8') + token_meta_key = cache_data_key(identifier, MetadataPointer.TOKEN_META_SYMBOL) + token_info_key = cache_data_key(identifier, MetadataPointer.TOKEN_PROOF_SYMBOL) + token_meta = get_cached_data(token_meta_key) + token_meta = json.loads(token_meta) + token_info = get_cached_data(token_info_key) + token_info = json.loads(token_info) + token_data = collate_token_metadata(token_info=token_info, token_metadata=token_meta) + token_data = {**token_data, **token} + token_data_key = cache_data_key([bytes.fromhex(param), identifier], MetadataPointer.TOKEN_DATA) + cache_data(token_data_key, json.dumps(token_data)) + handle_token_symbol_list(blockchain_address=param, token_symbol=token_symbol) + + @celery_app.task(bind=True) def transaction_balances_callback(self, result: list, param: dict, status_code: int): """ @@ -138,10 +188,15 @@ def transaction_balances_callback(self, result: list, param: dict, status_code: """ if status_code != 0: raise ValueError(f'Unexpected status code: {status_code}.') - balances_data = result[0] - available_balance = calculate_available_balance(balances_data) transaction = param + token_symbol = transaction.get('token_symbol') + blockchain_address = transaction.get('blockchain_address') + identifier = [bytes.fromhex(blockchain_address), token_symbol.encode('utf-8')] + wait_for_cache(identifier, f'Cached token data for: {token_symbol}', MetadataPointer.TOKEN_DATA) + token_data = get_cached_token_data(blockchain_address, token_symbol) + decimals = token_data.get('decimals') + available_balance = calculate_available_balance(balances_data, decimals) transaction['available_balance'] = available_balance queue = self.request.delivery_info.get('routing_key') @@ -175,6 +230,8 @@ def transaction_callback(result: dict, param: str, status_code: int): source_token_symbol = result.get('source_token_symbol') source_token_value = result.get('source_token_value') + process_token_data(blockchain_address=recipient_blockchain_address, token_symbol=destination_token_symbol) + recipient_metadata = { "alt_blockchain_address": sender_blockchain_address, "blockchain_address": recipient_blockchain_address, diff --git a/apps/cic-ussd/cic_ussd/tasks/notifications.py b/apps/cic-ussd/cic_ussd/tasks/notifications.py index 8cab098e..277bc1e0 100644 --- a/apps/cic-ussd/cic_ussd/tasks/notifications.py +++ b/apps/cic-ussd/cic_ussd/tasks/notifications.py @@ -6,6 +6,7 @@ import logging import celery # local imports +from cic_ussd.account.tokens import get_cached_token_data from cic_ussd.account.transaction import from_wei from cic_ussd.notifications import Notifier from cic_ussd.phone_number import Support @@ -25,11 +26,15 @@ def transaction(notification_data: dict): """ role = notification_data.get('role') token_value = notification_data.get('token_value') - amount = token_value if token_value == 0 else from_wei(token_value) + token_symbol = notification_data.get('token_symbol') + blockchain_address = notification_data.get('blockchain_address') + token_data = get_cached_token_data(blockchain_address, token_symbol) + decimals = token_data.get('decimals') + amount = token_value if token_value == 0 else from_wei(decimals, token_value) balance = notification_data.get('available_balance') phone_number = notification_data.get('phone_number') preferred_language = notification_data.get('preferred_language') - token_symbol = notification_data.get('token_symbol') + alt_metadata_id = notification_data.get('alt_metadata_id') metadata_id = notification_data.get('metadata_id') transaction_type = notification_data.get('transaction_type') diff --git a/apps/cic-ussd/cic_ussd/tasks/processor.py b/apps/cic-ussd/cic_ussd/tasks/processor.py index 599938ab..9916d4d5 100644 --- a/apps/cic-ussd/cic_ussd/tasks/processor.py +++ b/apps/cic-ussd/cic_ussd/tasks/processor.py @@ -47,7 +47,8 @@ def cache_statement(parsed_transaction: dict, querying_party: str): statement_transactions = [] if cached_statement: statement_transactions = json.loads(cached_statement) - statement_transactions.append(parsed_transaction) + if parsed_transaction not in statement_transactions: + statement_transactions.append(parsed_transaction) data = json.dumps(statement_transactions) identifier = bytes.fromhex(querying_party) key = cache_data_key(identifier, MetadataPointer.STATEMENT) @@ -74,6 +75,14 @@ def parse_transaction(transaction: dict) -> dict: role = transaction.get('role') alt_blockchain_address = transaction.get('alt_blockchain_address') blockchain_address = transaction.get('blockchain_address') + identifier = bytes.fromhex(blockchain_address) + token_symbol = transaction.get('token_symbol') + if role == 'recipient': + key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_LAST_RECEIVED) + cache_data(key, token_symbol) + if role == 'sender': + key = cache_data_key(identifier=identifier, salt=MetadataPointer.TOKEN_LAST_SENT) + cache_data(key, token_symbol) account = validate_transaction_account(blockchain_address, role, session) alt_account = session.query(Account).filter_by(blockchain_address=alt_blockchain_address).first() if alt_account: diff --git a/apps/cic-ussd/requirements.txt b/apps/cic-ussd/requirements.txt index a519ed96..5dbd7aed 100644 --- a/apps/cic-ussd/requirements.txt +++ b/apps/cic-ussd/requirements.txt @@ -6,7 +6,7 @@ celery==4.4.7 cffi==1.14.6 cic-eth~=0.12.5a1 cic-notify~=0.4.0a11 -cic-types~=0.2.1a2 +cic-types~=0.2.1a7 confini>=0.3.6rc4,<0.5.0 phonenumbers==8.12.12 psycopg2==2.8.6 diff --git a/apps/cic-ussd/states/exit_states.json b/apps/cic-ussd/states/exit_states.json index 982e6b3a..6060a732 100644 --- a/apps/cic-ussd/states/exit_states.json +++ b/apps/cic-ussd/states/exit_states.json @@ -11,5 +11,7 @@ "account_creation_prompt", "exit_successful_transaction", "exit_insufficient_balance", + "exit_invalid_guardian_addition", + "exit_invalid_guardian_removal", "complete" ] \ No newline at end of file diff --git a/apps/cic-ussd/states/pin_management_states.json b/apps/cic-ussd/states/pin_management_states.json new file mode 100644 index 00000000..fe4548f3 --- /dev/null +++ b/apps/cic-ussd/states/pin_management_states.json @@ -0,0 +1,16 @@ +[ + "pin_management", + "reset_guarded_pin", + "reset_guarded_pin_authorization", + "exit_pin_reset_initiated_success", + "exit_not_authorized_for_pin_reset", + "guard_pin", + "guardian_list_pin_authorization", + "guardian_list", + "add_guardian", + "add_guardian_pin_authorization", + "exit_guardian_addition_success", + "remove_guardian", + "remove_guardian_pin_authorization", + "exit_guardian_removal_success" +] \ No newline at end of file diff --git a/apps/cic-ussd/states/token_management_states.json b/apps/cic-ussd/states/token_management_states.json new file mode 100644 index 00000000..c1007ef1 --- /dev/null +++ b/apps/cic-ussd/states/token_management_states.json @@ -0,0 +1,7 @@ +[ + "first_account_tokens_set", + "middle_account_tokens_set", + "last_account_tokens_set", + "token_selection_pin_authorization", + "exit_successful_token_selection" +] \ No newline at end of file diff --git a/apps/cic-ussd/transitions/account_management_transitions.json b/apps/cic-ussd/transitions/account_management_transitions.json index 535e83dc..11691e83 100644 --- a/apps/cic-ussd/transitions/account_management_transitions.json +++ b/apps/cic-ussd/transitions/account_management_transitions.json @@ -50,7 +50,7 @@ { "trigger": "scan_data", "source": "account_management", - "dest": "enter_current_pin", + "dest": "pin_management", "conditions": "cic_ussd.state_machine.logic.menu.menu_five_selected" }, { diff --git a/apps/cic-ussd/transitions/account_statement_transitions.json b/apps/cic-ussd/transitions/account_statement_transitions.json index 1568d9b5..a20de9e3 100644 --- a/apps/cic-ussd/transitions/account_statement_transitions.json +++ b/apps/cic-ussd/transitions/account_statement_transitions.json @@ -8,7 +8,7 @@ { "trigger": "scan_data", "source": "first_transaction_set", - "dest": "start", + "dest": "exit", "conditions": "cic_ussd.state_machine.logic.menu.menu_zero_zero_selected" }, { @@ -31,7 +31,7 @@ { "trigger": "scan_data", "source": "middle_transaction_set", - "dest": "start", + "dest": "exit", "conditions": "cic_ussd.state_machine.logic.menu.menu_zero_zero_selected" }, { @@ -48,7 +48,7 @@ { "trigger": "scan_data", "source": "last_transaction_set", - "dest": "start", + "dest": "exit", "conditions": "cic_ussd.state_machine.logic.menu.menu_zero_zero_selected" }, { diff --git a/apps/cic-ussd/transitions/exit_transitions.json b/apps/cic-ussd/transitions/exit_transitions.json index 54661a03..975dd14c 100644 --- a/apps/cic-ussd/transitions/exit_transitions.json +++ b/apps/cic-ussd/transitions/exit_transitions.json @@ -58,5 +58,17 @@ "source": "exit_successful_transaction", "dest": "exit", "conditions": "cic_ussd.state_machine.logic.menu.menu_ninety_nine_selected" + }, + { + "trigger": "scan_data", + "source": "exit_successful_token_selection", + "dest": "start", + "conditions": "cic_ussd.state_machine.logic.menu.menu_zero_zero_selected" + }, + { + "trigger": "scan_data", + "source": "exit_successful_token_selection", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_ninety_nine_selected" } ] \ No newline at end of file diff --git a/apps/cic-ussd/transitions/pin_guard_transitions.json b/apps/cic-ussd/transitions/pin_guard_transitions.json new file mode 100644 index 00000000..fb77fba3 --- /dev/null +++ b/apps/cic-ussd/transitions/pin_guard_transitions.json @@ -0,0 +1,119 @@ +[ + { + "trigger": "scan_data", + "source": "guard_pin", + "dest": "guardian_list_pin_authorization", + "conditions": "cic_ussd.state_machine.logic.menu.menu_one_selected" + }, + { + "trigger": "scan_data", + "source": "guardian_list_pin_authorization", + "dest": "guardian_list", + "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin" + }, + { + "trigger": "scan_data", + "source": "guardian_list_pin_authorization", + "dest": "exit_pin_blocked", + "conditions": "cic_ussd.state_machine.logic.pin.is_blocked_pin" + }, + { + "trigger": "scan_data", + "source": "guard_pin", + "dest": "add_guardian", + "conditions": "cic_ussd.state_machine.logic.menu.menu_two_selected" + }, + { + "trigger": "scan_data", + "source": "add_guardian", + "dest": "add_guardian_pin_authorization", + "after": [ + "cic_ussd.state_machine.logic.pin_guard.save_guardian_to_session_data", + "cic_ussd.state_machine.logic.pin_guard.retrieve_person_metadata" + ], + "conditions": "cic_ussd.state_machine.logic.pin_guard.is_valid_guardian_addition" + }, + { + "trigger": "scan_data", + "source": "add_guardian", + "dest": "exit_invalid_guardian_addition", + "unless": "cic_ussd.state_machine.logic.pin_guard.is_valid_guardian_addition" + }, + { + "trigger": "scan_data", + "source": "add_guardian_pin_authorization", + "dest": "exit_guardian_addition_success", + "after": "cic_ussd.state_machine.logic.pin_guard.add_pin_guardian", + "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin" + }, + { + "trigger": "scan_data", + "source": "add_guardian_pin_authorization", + "dest": "exit_pin_blocked", + "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account" + }, + { + "trigger": "scan_data", + "source": "guard_pin", + "dest": "remove_guardian", + "conditions": "cic_ussd.state_machine.logic.menu.menu_three_selected" + }, + { + "trigger": "scan_data", + "source": "remove_guardian", + "dest": "remove_guardian_pin_authorization", + "after": [ + "cic_ussd.state_machine.logic.pin_guard.save_guardian_to_session_data", + "cic_ussd.state_machine.logic.pin_guard.retrieve_person_metadata" + ], + "conditions": "cic_ussd.state_machine.logic.pin_guard.is_dialers_pin_guardian" + }, + { + "trigger": "scan_data", + "source": "remove_guardian", + "dest": "exit_invalid_guardian_removal", + "unless": "cic_ussd.state_machine.logic.pin_guard.is_dialers_pin_guardian" + }, + { + "trigger": "scan_data", + "source": "remove_guardian_pin_authorization", + "dest": "exit_guardian_removal_success", + "after": "cic_ussd.state_machine.logic.pin_guard.remove_pin_guardian", + "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin" + }, + { + "trigger": "scan_data", + "source": "remove_guardian_pin_authorization", + "dest": "exit_pin_blocked", + "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account" + }, + { + "trigger": "scan_data", + "source": "exit_guardian_removal_success", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_nine_selected" + }, + { + "trigger": "scan_data", + "source": "exit_invalid_guardian_addition", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_nine_selected" + }, + { + "trigger": "scan_data", + "source": "exit_invalid_guardian_removal", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_nine_selected" + }, + { + "trigger": "scan_data", + "source": "guardian_list", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_nine_selected" + }, + { + "trigger": "scan_data", + "source": "guard_pin", + "dest": "exit_invalid_menu_option" + } +] \ No newline at end of file diff --git a/apps/cic-ussd/transitions/pin_management_transitions.json b/apps/cic-ussd/transitions/pin_management_transitions.json new file mode 100644 index 00000000..45cd9986 --- /dev/null +++ b/apps/cic-ussd/transitions/pin_management_transitions.json @@ -0,0 +1,20 @@ +[ + { + "trigger": "scan_data", + "source": "pin_management", + "dest": "enter_current_pin", + "conditions": "cic_ussd.state_machine.logic.menu.menu_one_selected" + }, + { + "trigger": "scan_data", + "source": "pin_management", + "dest": "reset_guarded_pin", + "conditions": "cic_ussd.state_machine.logic.menu.menu_two_selected" + }, + { + "trigger": "scan_data", + "source": "pin_management", + "dest": "guard_pin", + "conditions": "cic_ussd.state_machine.logic.menu.menu_three_selected" + } +] \ No newline at end of file diff --git a/apps/cic-ussd/transitions/pin_reset_transitions.json b/apps/cic-ussd/transitions/pin_reset_transitions.json new file mode 100644 index 00000000..f0c2b2ce --- /dev/null +++ b/apps/cic-ussd/transitions/pin_reset_transitions.json @@ -0,0 +1,43 @@ +[ + { + "trigger": "scan_data", + "source": "reset_guarded_pin", + "dest": "reset_guarded_pin_authorization", + "after": [ + "cic_ussd.state_machine.logic.pin_guard.save_guarded_account_session_data", + "cic_ussd.state_machine.logic.pin_guard.retrieve_person_metadata" + ], + "conditions": "cic_ussd.state_machine.logic.pin_guard.is_others_pin_guardian" + }, + { + "trigger": "scan_data", + "source": "reset_guarded_pin_authorization", + "dest": "exit_pin_reset_initiated_success", + "after": "cic_ussd.state_machine.logic.pin_guard.initiate_pin_reset", + "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin" + }, + { + "trigger": "scan_data", + "source": "exit_pin_reset_initiated_success", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_nine_selected" + }, + { + "trigger": "scan_data", + "source": "reset_guarded_pin_authorization", + "dest": "exit_pin_blocked", + "conditions": "cic_ussd.state_machine.logic.pin.is_locked_account" + }, + { + "trigger": "scan_data", + "source": "reset_guarded_pin", + "dest": "exit_not_authorized_for_pin_reset", + "unless": "cic_ussd.state_machine.logic.pin_guard.is_others_pin_guardian" + }, + { + "trigger": "scan_data", + "source": "exit_not_authorized_for_pin_reset", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_nine_selected" + } +] \ No newline at end of file diff --git a/apps/cic-ussd/transitions/start_menu_transitions.json b/apps/cic-ussd/transitions/start_menu_transitions.json index a62c777f..e309d4f4 100644 --- a/apps/cic-ussd/transitions/start_menu_transitions.json +++ b/apps/cic-ussd/transitions/start_menu_transitions.json @@ -8,15 +8,21 @@ { "trigger": "scan_data", "source": "start", - "dest": "account_management", + "dest": "first_account_tokens_set", "conditions": "cic_ussd.state_machine.logic.menu.menu_two_selected" }, { "trigger": "scan_data", "source": "start", - "dest": "help", + "dest": "account_management", "conditions": "cic_ussd.state_machine.logic.menu.menu_three_selected" }, + { + "trigger": "scan_data", + "source": "start", + "dest": "help", + "conditions": "cic_ussd.state_machine.logic.menu.menu_four_selected" + }, { "trigger": "scan_data", "source": "start", diff --git a/apps/cic-ussd/transitions/token_management_transitions.json b/apps/cic-ussd/transitions/token_management_transitions.json new file mode 100644 index 00000000..31e276dd --- /dev/null +++ b/apps/cic-ussd/transitions/token_management_transitions.json @@ -0,0 +1,93 @@ +[ + { + "trigger": "scan_data", + "source": "first_account_tokens_set", + "dest": "middle_account_tokens_set", + "conditions": "cic_ussd.state_machine.logic.menu.menu_eleven_selected" + }, + { + "trigger": "scan_data", + "source": "first_account_tokens_set", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_zero_zero_selected" + }, + { + "trigger": "scan_data", + "source": "first_account_tokens_set", + "dest": "token_selection_pin_authorization", + "conditions": "cic_ussd.state_machine.logic.tokens.is_valid_token_selection", + "after": "cic_ussd.state_machine.logic.tokens.process_token_selection" + }, + { + "trigger": "scan_data", + "source": "first_account_tokens_set", + "dest": "exit_invalid_menu_option" + }, + { + "trigger": "scan_data", + "source": "middle_account_tokens_set", + "dest": "last_account_tokens_set", + "conditions": "cic_ussd.state_machine.logic.menu.menu_eleven_selected" + }, + { + "trigger": "scan_data", + "source": "middle_account_tokens_set", + "dest": "first_account_tokens_set", + "conditions": "cic_ussd.state_machine.logic.menu.menu_twenty_two_selected" + }, + { + "trigger": "scan_data", + "source": "middle_account_tokens_set", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_zero_zero_selected" + }, + { + "trigger": "scan_data", + "source": "middle_account_tokens_set", + "dest": "token_selection_pin_authorization", + "conditions": "cic_ussd.state_machine.logic.tokens.is_valid_token_selection", + "after": "cic_ussd.state_machine.logic.tokens.process_token_selection" + }, + { + "trigger": "scan_data", + "source": "middle_account_tokens_set", + "dest": "exit_invalid_menu_option" + }, + { + "trigger": "scan_data", + "source": "last_account_tokens_set", + "dest": "middle_account_tokens_set", + "conditions": "cic_ussd.state_machine.logic.menu.menu_twenty_two_selected" + }, + { + "trigger": "scan_data", + "source": "last_account_tokens_set", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_zero_zero_selected" + }, + { + "trigger": "scan_data", + "source": "last_account_tokens_set", + "dest": "token_selection_pin_authorization", + "conditions": "cic_ussd.state_machine.logic.tokens.is_valid_token_selection", + "after": "cic_ussd.state_machine.logic.tokens.process_token_selection" + }, + { + "trigger": "scan_data", + "source": "last_account_tokens_set", + "dest": "exit_invalid_menu_option" + }, + { + "trigger": "scan_data", + "source": "token_selection_pin_authorization", + "dest": "exit_successful_token_selection", + "conditions": "cic_ussd.state_machine.logic.pin.is_authorized_pin", + "after": "cic_ussd.state_machine.logic.tokens.set_selected_active_token" + }, + { + "trigger": "scan_data", + "source": "token_selection_pin_authorization", + "dest": "exit", + "conditions": "cic_ussd.state_machine.logic.menu.menu_zero_zero_selected" + } +] \ No newline at end of file diff --git a/apps/cic-ussd/var/lib/locale/helpers.en.yml b/apps/cic-ussd/var/lib/locale/helpers.en.yml index 2ac7333e..70b344df 100644 --- a/apps/cic-ussd/var/lib/locale/helpers.en.yml +++ b/apps/cic-ussd/var/lib/locale/helpers.en.yml @@ -9,6 +9,8 @@ en: Not provided no_transaction_history: |- No transaction history + no_tokens_list: |- + No tokens to list other: |- Other received: |- @@ -16,4 +18,19 @@ en: sent: |- Sent to: |- - To \ No newline at end of file + To + guardians_list_header: |- + Walinzi uliowaongeza ni: + no_guardians_list: |- + No guardians set + error: + no_phone_number_provided: |- + No phone number was provided. + no_matching_account: |- + The number provided is not registered. + is_initiator: |- + Phone number cannot be your own. + is_existent_guardian: |- + This phone number is is already added as a guardian. + is_not_existent_guardian: |- + Phone number not set as PIN reset guardian. \ No newline at end of file diff --git a/apps/cic-ussd/var/lib/locale/helpers.sw.yml b/apps/cic-ussd/var/lib/locale/helpers.sw.yml index f6781fc3..cace30c9 100644 --- a/apps/cic-ussd/var/lib/locale/helpers.sw.yml +++ b/apps/cic-ussd/var/lib/locale/helpers.sw.yml @@ -9,6 +9,8 @@ sw: Haijawekwa no_transaction_history: |- Hamna ripoti ya matumizi + no_tokens_list: |- + Hamna sarafu nyingine other: |- Nyingine received: |- @@ -16,4 +18,19 @@ sw: sent: |- Ulituma to: |- - Kwa \ No newline at end of file + Kwa + guardians_list_header: |- + Your set guardians are: + no_guardians_list: |- + Hamna walinzi walioongezwa + error: + no_phone_number_provided: |- + Namabari ya simu haijawekwa. + no_matching_account: |- + Nambari uliyoweka haijasajiliwa. + is_initiator: |- + Nambari yafaa kuwa tofauti na yako. + is_existent_guardian: |- + Namabari hii tayari imeongezwa kama mlinzi wa nambari ya siri. + is_not_existent_guardian: |- + Nambari hii haijaongezwa kama mlinzi wa nambari ya siri. \ No newline at end of file diff --git a/apps/cic-ussd/var/lib/locale/ussd.en.yml b/apps/cic-ussd/var/lib/locale/ussd.en.yml index 70ae54fd..40985fed 100644 --- a/apps/cic-ussd/var/lib/locale/ussd.en.yml +++ b/apps/cic-ussd/var/lib/locale/ussd.en.yml @@ -33,21 +33,44 @@ en: start: |- CON Balance %{account_balance} %{account_token_name} 1. Send - 2. My Account - 3. Help + 2. My Sarafu + 3. My Account + 4. Help enter_transaction_recipient: |- CON Enter phone number 0. Back enter_transaction_amount: |- CON Enter amount 0. Back + first_account_tokens_set: |- + CON Choose a number or symbol from your balances: + %{first_account_tokens_set} + 11. Next + 00. Exit + middle_account_tokens_set: |- + CON Choose a number or symbol from your balances: + %{middle_account_tokens_set} + 11. Next + 22. Previous + 00. Exit + last_account_tokens_set: |- + CON Choose a number or symbol from your balances: + %{last_account_tokens_set} + 22. Previous + 00. Exit + token_selection_pin_authorization: + first: |- + CON %{token_data} + Enter pin to select: + retry: |- + %{retry_pin_entry} account_management: |- CON My account 1. My profile 2. Change language 3. Check balance 4. Check statement - 5. Change PIN + 5. PIN options 0. Back metadata_management: |- CON My profile @@ -74,6 +97,12 @@ en: retry_pin_entry: |- CON Incorrect PIN entered, please try again. You have %{remaining_attempts} attempts remaining. 0. Back + pin_management: |- + CON Pin options + 1. Change PIN + 2. Reset PIN + 3. Guard PIN + 0. Back enter_current_pin: first: |- CON Enter current PIN. @@ -86,6 +115,73 @@ en: new_pin_confirmation: |- CON Enter your new four number PIN again 0. Back + reset_guarded_pin: |- + CON Enter phone number you are the guardian to reset their pin + 0. Back + reset_guarded_pin_authorization: + first: |- + CON Enter YOUR pin to confirm %{guarded_account_information}'s reset + 0. Back + retry: |- + %{retry_pin_entry} + exit_pin_reset_initiated_success: |- + CON Success: You have initiated a PIN reset for %{guarded_account_information} + 0. Back + 9. Exit + exit_not_authorized_for_pin_reset: |- + CON Failure: You are not authorized to reset that PIN. You must be a guardian! + 0. Back + 9. Exit + guard_pin: |- + CON Pin guard + 1. View guardians + 2. Add guardian + 3. Remove guardian + 0. Back + guardian_list_pin_authorization: + first: |- + CON Enter your pin to view set guardians + 0. Back + retry: |- + %{retry_pin_entry} + guardian_list: |- + CON %{guardians_list} + 0. Back + 9. Exit + add_guardian: |- + CON Enter phone number to add as pin reset guardian + 0. Back + add_guardian_pin_authorization: + first: |- + CON Enter your pin to add %{guardian_information} as your PIN reset guardian + 0. Back + retry: |- + %{retry_pin_entry} + exit_guardian_addition_success: |- + CON Success: %{guardian_information} can now reset your PIN + 0. Back + 9. Exit + exit_invalid_guardian_addition: |- + CON %{error_exit} + 0. Back + 9. Exit + remove_guardian: |- + CON Enter phone number to revoke guardianship: + 0. Back + remove_guardian_pin_authorization: + first: |- + CON Enter your pin to remove %{guardian_information} as your PIN reset guardian + 0. Back + retry: |- + %{retry_pin_entry} + exit_guardian_removal_success: |- + CON Success: %{guardian_information} PIN reset guardianship is revoked + 0. Back + 9. Exit + exit_invalid_guardian_removal: |- + CON %{error_exit} + 0. Back + 9. Exit transaction_pin_authorization: first: |- CON %{recipient_information} will receive %{transaction_amount} %{token_symbol} from %{sender_information}. @@ -203,6 +299,10 @@ en: Your Sarafu-Network balances is: %{token_balance} 00. Back 99. Exit + exit_successful_token_selection: |- + CON Success! %{token_symbol} is your active Sarafu. + 00. Back + 99. Exit invalid_service_code: |- Please dial %{valid_service_code} to access Sarafu Network help: |- diff --git a/apps/cic-ussd/var/lib/locale/ussd.sw.yml b/apps/cic-ussd/var/lib/locale/ussd.sw.yml index 4b74df49..89bf9e71 100644 --- a/apps/cic-ussd/var/lib/locale/ussd.sw.yml +++ b/apps/cic-ussd/var/lib/locale/ussd.sw.yml @@ -32,21 +32,44 @@ sw: start: |- CON Salio %{account_balance} %{account_token_name} 1. Tuma - 2. Akaunti yangu - 3. Usaidizi + 2. Sarafu yangu + 3. Akaunti yangu + 4. Usaidizi enter_transaction_recipient: |- CON Weka nambari ya simu 0. Nyuma enter_transaction_amount: |- CON Weka kiwango 0. Nyuma + first_account_tokens_set: |- + CON Chagua nambari au ishara kutoka kwa salio zako: + %{first_account_tokens_set} + 11. Mbele + 00. Ondoka + middle_account_tokens_set: |- + CON Chagua nambari au ishara kutoka kwa salio zako: + %{middle_account_tokens_set} + 11. Mbele + 22. Nyuma + 00. Ondoka + last_account_tokens_set: |- + CON Chagua nambari au ishara kutoka kwa salio zako: + %{last_account_tokens_set} + 22. Nyuma + 00. Ondoka + token_selection_pin_authorization: + first: |- + CON %{token_data} + Weka nambari ya siri kuchagua: + retry: |- + %{retry_pin_entry} account_management: |- CON Akaunti yangu 1. Wasifu wangu 2. Chagua lugha utakayotumia 3. Angalia salio 4. Angalia taarifa ya matumizi - 5. Badilisha nambari ya siri + 5. Mipangilio ya nambari ya siri 0. Nyuma metadata_management: |- CON Wasifu wangu @@ -72,7 +95,13 @@ sw: 0. Nyuma retry_pin_entry: |- CON Nambari uliyoweka si sahihi, jaribu tena. Una majaribio %{remaining_attempts} yaliyobaki. - 0. Back + 0. Nyuma + pin_management: |- + CON Pin options + 1. Badilisha nambari yangu ya siri + 2. Tuma ombili la kubadilisha nambari ya siri + 3. Linda nambari ya siri + 0. Nyuma enter_current_pin: first: |- CON Weka nambari ya siri. @@ -85,6 +114,73 @@ sw: new_pin_confirmation: |- CON Weka nambari yako ya siri tena 0. Nyuma + reset_guarded_pin: |- + CON Weka nambari ya simu ili kutuma ombi la kubalisha nambari ya siri. + 0. Nyuma + reset_guarded_pin_authorization: + first: |- + CON Weka nambari YAKO ya siri ili kudhibitisha ombi la kubadilisha nambari ya siri ya %{guarded_account_information}. + 0. Nyuma + retry: |- + %{retry_pin_entry} + exit_pin_reset_initiated_success: |- + CON Ombi lako la kubadili nambari ya siri ya %{guarded_account_information} limetumwa. + 0. Nyuma + 9. Ondoka + exit_not_authorized_for_pin_reset: |- + CON Huruhusiwi kutuma ombi la kubadilisha nambari ya siri. + 0. Nyuma + 9. Ondoka + guard_pin: |- + CON Linda nambari ya siri + 1. Walinzi wa namabari ya siri + 2. Ongeza mlinzi + 3. Ondoa mlinzi + 0. Nyuma + guardian_list_pin_authorization: + first: |- + CON Weka nambari yako ya siri ili kuona walinzi uliowaongeza + 0. Nyuma + retry: |- + %{retry_pin_entry} + guardian_list: |- + CON %{guardians_list} + 0. Nyuma + 9. Ondoka + add_guardian: |- + CON Weka nambari ya simu ili kuongeza mlinzi + 0. Nyuma + add_guardian_pin_authorization: + first: |- + CON Weka nambari YAKO ya siri ili kumwongeza %{guardian_information} kama mlinzi + 0. Nyuma + retry: |- + %{retry_pin_entry} + exit_guardian_addition_success: |- + CON Ombi lako la kumwongeza: %{guardian_information} kama mlinzi limefanikiwa + 0. Nyuma + 9. Ondoka + exit_invalid_guardian_addition: |- + CON %{error_exit} + 0. Nyuma + 9. Ondoka + remove_guardian: |- + CON Weka nambari ya simu ili kuondoa mlinzi + 0. Nyuma + remove_guardian_pin_authorization: + first: |- + CON Weka nambari YAKO ya siri ili kumwondoa %{guardian_information} kama mlinzi + 0. Nyuma + retry: |- + %{retry_pin_entry} + exit_guardian_removal_success: |- + CON Ombi lako la kumwondoa: %{guardian_information} kama mlinzi limefanikiwa + 0. Nyuma + 9. Ondoka + exit_invalid_guardian_removal: |- + CON %{error_exit} + 0. Nyuma + 9. Ondoka transaction_pin_authorization: first: |- CON %{recipient_information} atapokea %{transaction_amount} %{token_symbol} kutoka kwa %{sender_information}. @@ -202,6 +298,10 @@ sw: Akaunti yako ya Sarafu ina salio ifuatayo: %{token_balance} 00. Nyuma 99. Ondoka + exit_successful_token_selection: |- + CON Chaguo lako limekamilika, %{token_symbol} ni sarafu itakayotumika. + 00. Nyuma + 99. Ondoka invalid_service_code: |- Bonyeza %{valid_service_code} kutumia mtandao wa Sarafu help: |- diff --git a/apps/contract-migration/scripts/proofs.py b/apps/contract-migration/scripts/proofs.py index 7ab65e82..2d35d5bf 100644 --- a/apps/contract-migration/scripts/proofs.py +++ b/apps/contract-migration/scripts/proofs.py @@ -64,7 +64,8 @@ def wrapper(chain_spec: ChainSpec, rpc: EthHTTPConnection) -> Declarator: return Declarator(chain_spec, gas_oracle=gas_oracle, nonce_oracle=nonce_oracle, signer=signer) -def write_to_declarator(contract_address: hex, contract_wrapper: Declarator, proof: any, rpc: EthHTTPConnection, signer_address: hex, token_address: hex): +def write_to_declarator(contract_address: hex, contract_wrapper: Declarator, proof: any, rpc: EthHTTPConnection, + signer_address: hex, token_address: hex): operation = contract_wrapper.add_declaration(contract_address, signer_address, token_address, proof) results = rpc.do(operation[1]) rpc.wait(results) @@ -90,13 +91,15 @@ if __name__ == '__main__': token_meta_writer = MetadataRequestsHandler(cic_type=MetadataPointer.TOKEN_META, identifier=token_address_bytes) write_metadata(token_meta_writer, token_meta_data) - token_meta_symbol_writer = MetadataRequestsHandler(cic_type=MetadataPointer.TOKEN_META_SYMBOL, identifier=token_symbol_bytes) + token_meta_symbol_writer = MetadataRequestsHandler(cic_type=MetadataPointer.TOKEN_META_SYMBOL, + identifier=token_symbol_bytes) write_metadata(token_meta_symbol_writer, token_meta_data) token_proof_writer = MetadataRequestsHandler(cic_type=MetadataPointer.TOKEN_PROOF, identifier=token_address_bytes) write_metadata(token_proof_writer, token_proof_data) - token_proof_symbol_writer = MetadataRequestsHandler(cic_type=MetadataPointer.TOKEN_PROOF_SYMBOL, identifier=token_symbol_bytes) + token_proof_symbol_writer = MetadataRequestsHandler(cic_type=MetadataPointer.TOKEN_PROOF_SYMBOL, + identifier=token_symbol_bytes) write_metadata(token_proof_symbol_writer, token_proof_data) rpc = EthHTTPConnection(url=config.get('RPC_PROVIDER'), chain_spec=chain_spec) @@ -112,3 +115,13 @@ if __name__ == '__main__': rpc=rpc, signer_address=args.signer_address, token_address=args.e) + + hashed_token_proof = hash_proof(args.token_symbol.encode('utf-8')) + identifier = bytes.fromhex(hashed_token_proof) + token_immutable_proof_writer = MetadataRequestsHandler(cic_type=MetadataPointer.NONE, identifier=identifier) + write_to_declarator(contract_address=args.address_declarator, + contract_wrapper=contract_wrapper, + proof=identifier, + rpc=rpc, + signer_address=args.signer_address, + token_address=args.e) diff --git a/docker-compose.yml b/docker-compose.yml index 6e1f3de9..20a669a8 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -6,13 +6,9 @@ volumes: bloxberg-data: {} contract-config: {} -networks: - default: - name: cic-network - services: evm: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics}/bloxberg-node:${TAG:-latest} + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/bloxberg-node:${TAG:-latest} build: context: apps/bloxbergValidatorSetup restart: unless-stopped @@ -37,14 +33,14 @@ services: - postgres-db:/var/lib/postgresql/data redis: - image: ${DEV_DOCKER_REGISTRY:-docker.io}/redis:6.0.9-alpine + image: ${IMAGE_BASE_URL:-docker.io}/redis:6.0.9-alpine ports: - ${DEV_REDIS_PORT:-63379}:6379 command: "--loglevel verbose" bootstrap: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics}/contract-migration:${TAG:-latest} + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/contract-migration:${TAG:-latest} build: context: apps/contract-migration dockerfile: docker/Dockerfile @@ -97,8 +93,8 @@ services: cic-signer: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/funga-eth:${TAG:-latest} - build: + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/funga-eth:${TAG:-latest} + build: context: apps/cic-signer dockerfile: Dockerfile args: @@ -127,8 +123,8 @@ services: # queue handling for outgoing transactions and incoming transactions cic-eth-tasker: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-eth:${TAG:-latest} - build: + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-eth:${TAG:-latest} + build: context: apps/cic-eth dockerfile: docker/Dockerfile args: @@ -229,8 +225,8 @@ services: --pyargv "-vv" cic-eth-tracker: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-eth:${TAG:-latest} - build: + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-eth:${TAG:-latest} + build: context: apps/cic-eth dockerfile: docker/Dockerfile args: @@ -277,8 +273,8 @@ services: cic-eth-dispatcher: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-eth:${TAG:-latest} - build: + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-eth:${TAG:-latest} + build: context: apps/cic-eth dockerfile: docker/Dockerfile args: @@ -321,8 +317,8 @@ services: cic-eth-retrier: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-eth:${TAG:-latest} - build: + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-eth:${TAG:-latest} + build: context: apps/cic-eth dockerfile: docker/Dockerfile args: @@ -368,8 +364,8 @@ services: cic-cache-tracker: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-cache:${TAG:-latest} - build: + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-cache:${TAG:-latest} + build: context: apps/cic-cache dockerfile: docker/Dockerfile args: @@ -416,8 +412,8 @@ services: cic-cache-tasker: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-cache:${TAG:-latest} - build: + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-cache:${TAG:-latest} + build: context: apps/cic-cache dockerfile: docker/Dockerfile args: @@ -464,8 +460,8 @@ services: cic-cache-server: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-cache:${TAG:-latest} - build: + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-cache:${TAG:-latest} + build: context: apps/cic-cache dockerfile: docker/Dockerfile args: @@ -508,7 +504,7 @@ services: # metadata replacement server for swarm cic-meta-server: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics}/cic-meta:${TAG:-latest} + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-meta:${TAG:-latest} hostname: meta build: context: apps/cic-meta @@ -546,7 +542,7 @@ services: cic-user-tasker: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics}/cic-user:${TAG:-latest} + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-user:${TAG:-latest} build: context: apps/cic-ussd dockerfile: docker/Dockerfile @@ -562,6 +558,7 @@ services: DATABASE_DRIVER: ${DATABASE_DRIVER:-psycopg2} DATABASE_DEBUG: ${DATABASE_DEBUG:-0} DATABASE_POOL_SIZE: 0 + APP_PASSWORD_PEPPER: ${APP_PASSWORD_PEPPER:-QYbzKff6NhiQzY3ygl2BkiKOpER8RE/Upqs/5aZWW+I=} CELERY_BROKER_URL: ${CELERY_BROKER_URL:-redis://redis} CELERY_RESULT_URL: ${CELERY_BROKER_URL:-redis://redis} CHAIN_SPEC: ${CHAIN_SPEC:-evm:byzantium:8996:bloxberg} @@ -582,7 +579,7 @@ services: cic-user-server: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics}/cic-user:${TAG:-latest} + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-user:${TAG:-latest} build: context: apps/cic-ussd dockerfile: docker/Dockerfile @@ -601,6 +598,7 @@ services: DATABASE_DRIVER: ${DATABASE_DRIVER:-psycopg2} DATABASE_DEBUG: ${DATABASE_DEBUG:-0} DATABASE_POOL_SIZE: 0 + SERVER_PORT: 9500 restart: on-failure ports: - ${DEV_CIC_USER_SERVER_PORT:-63415}:9500 @@ -611,7 +609,7 @@ services: cic-user-ussd-server: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics}/cic-user:${TAG:-latest} + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-user:${TAG:-latest} build: context: apps/cic-ussd dockerfile: docker/Dockerfile @@ -630,11 +628,13 @@ services: DATABASE_DRIVER: ${DATABASE_DRIVER:-psycopg2} DATABASE_DEBUG: ${DATABASE_DEBUG:-0} DATABASE_POOL_SIZE: 0 + APP_PASSWORD_PEPPER: ${APP_PASSWORD_PEPPER:-QYbzKff6NhiQzY3ygl2BkiKOpER8RE/Upqs/5aZWW+I=} CHAIN_SPEC: ${CHAIN_SPEC:-evm:byzantium:8996:bloxberg} CELERY_BROKER_URL: ${CELERY_BROKER_URL:-redis://redis} CELERY_RESULT_URL: ${CELERY_RESULT_URL:-redis://redis} REDIS_PORT: 6379 REDIS_HOST: redis + SERVER_PORT: 9000 restart: on-failure depends_on: - postgres @@ -642,14 +642,14 @@ services: - cic-eth-tasker - cic-cache-tasker ports: - - ${DEV_CIC_USER_USSD_SERVER_PORT:-63315}:9500 + - ${DEV_CIC_USER_USSD_SERVER_PORT:-63315}:9000 volumes: - ./apps/contract-migration/testdata/pgp/:/usr/src/secrets/ command: "/root/start_cic_user_ussd_server.sh -vv" cic-notify-tasker: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics}/cic-notify:${TAG:-latest} + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/cic-notify:${TAG:-latest} build: context: apps/cic-notify dockerfile: docker/Dockerfile @@ -680,56 +680,57 @@ services: command: "/root/start_tasker.sh -q cic-notify -vv" data-seeding: - image: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/data-seeding:${TAG:-latest} - build: - context: apps/data-seeding - dockerfile: docker/Dockerfile - args: - DOCKER_REGISTRY: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics} - PIP_INDEX_URL: ${PIP_INDEX_URL:-https://pypi.org/simple} - EXTRA_PIP_INDEX_URL: ${EXTRA_PIP_INDEX_URL:-https://pip.grassrootseconomics.net:8433} - EXTRA_PIP_ARGS: $EXTRA_PIP_ARGS - environment: - DATABASE_HOST: ${DATABASE_HOST:-postgres} - DATABASE_PORT: ${DATABASE_PORT:-5432} - DATABASE_NAME: ${DATABASE_NAME:-cic_ussd} - DATABASE_PASSWORD: ${DATABASE_PASSWORD:-tralala} - DATABASE_USER: ${DATABASE_USER:-grassroots} - DATABASE_ENGINE: ${DATABASE_ENGINE:-postgres} - DATABASE_DRIVER: ${DATABASE_DRIVER:-psycopg2} - DATABASE_DEBUG: ${DATABASE_DEBUG:-0} - DATABASE_POOL_SIZE: 0 - CELERY_BROKER_URL: ${CELERY_BROKER_URL:-redis://redis:6379} - CELERY_RESULT_URL: ${CELERY_RESULT_URL:-redis://redis:6379} - CIC_REGISTRY_ADDRESS: $CIC_REGISTRY_ADDRESS - RPC_PROVIDER: ${RPC_PROVIDER:-http://evm:8545} - OUT_DIR: out - NUMBER_OF_USERS: 10 - CONFIG: config - CHAIN_SPEC: ${CHAIN_SPEC:-evm:byzantium:8996:bloxberg} - TOKEN_SYMBOL: GFT - KEYSTORE_PATH: keystore/UTC--2021-01-08T17-18-44.521011372Z--eb3907ecad74a0013c259d5874ae7f22dcbcc95c - USSD_HOST: cic-user-ussd-server - USSD_PORT: 9000 - INCLUDE_BALANCES: y - USSD_SSL: n - NOTIFY_DATABASE_NAME: cic_notify - REDIS_HOST: redis - REDIS_PORT: 6379 - REDIS_DB: 0 - META_HOST: meta - META_PORT: 8000 - META_URL: http://meta:8000 - USSD_PROVIDER: http://cic-user-ussd-server:9000 - CELERY_QUEUE: cic-import-ussd - EXCLUSIONS: ussd - command: - - /bin/bash - - -c - - | - set -a - if [[ -f /tmp/cic/config/env_reset ]]; then source /tmp/cic/config/env_reset; fi - set +a - ./import_ussd.sh - volumes: - - contract-config:/tmp/cic/config/:ro + image: ${IMAGE_BASE_URL:-registry.gitlab.com/grassrootseconomics/cic-internal-integration}/data-seeding:${TAG:-latest} + build: + context: apps/data-seeding + dockerfile: docker/Dockerfile + args: + DOCKER_REGISTRY: ${DEV_DOCKER_REGISTRY:-registry.gitlab.com/grassrootseconomics} + PIP_INDEX_URL: ${PIP_INDEX_URL:-https://pypi.org/simple} + EXTRA_PIP_INDEX_URL: ${EXTRA_PIP_INDEX_URL:-https://pip.grassrootseconomics.net:8433} + EXTRA_PIP_ARGS: $EXTRA_PIP_ARGS + environment: + DATABASE_HOST: ${DATABASE_HOST:-postgres} + DATABASE_PORT: ${DATABASE_PORT:-5432} + DATABASE_NAME: ${DATABASE_NAME:-cic_ussd} + DATABASE_PASSWORD: ${DATABASE_PASSWORD:-tralala} + DATABASE_USER: ${DATABASE_USER:-grassroots} + DATABASE_ENGINE: ${DATABASE_ENGINE:-postgres} + DATABASE_DRIVER: ${DATABASE_DRIVER:-psycopg2} + DATABASE_DEBUG: ${DATABASE_DEBUG:-0} + DATABASE_POOL_SIZE: 0 + CELERY_BROKER_URL: ${CELERY_BROKER_URL:-redis://redis:6379} + CELERY_RESULT_URL: ${CELERY_RESULT_URL:-redis://redis:6379} + CIC_REGISTRY_ADDRESS: $CIC_REGISTRY_ADDRESS + RPC_PROVIDER: ${RPC_PROVIDER:-http://evm:8545} + OUT_DIR: out + NUMBER_OF_USERS: 10 + CONFIG: config + CHAIN_SPEC: ${CHAIN_SPEC:-evm:byzantium:8996:bloxberg} + TOKEN_SYMBOL: GFT + #KEYSTORE_PATH: keystore/UTC--2021-01-08T17-18-44.521011372Z--eb3907ecad74a0013c259d5874ae7f22dcbcc95c + WALLET_KEY_FILE: ${WALLET_KEY_FILE:-/root/keystore/UTC--2021-01-08T17-18-44.521011372Z--eb3907ecad74a0013c259d5874ae7f22dcbcc95c} + USSD_HOST: cic-user-ussd-server + USSD_PORT: 9000 + INCLUDE_BALANCES: y + USSD_SSL: n + NOTIFY_DATABASE_NAME: cic_notify + REDIS_HOST: redis + REDIS_PORT: 6379 + REDIS_DB: 0 + META_HOST: meta + META_PORT: 8000 + META_URL: http://meta:8000 + USSD_PROVIDER: http://cic-user-ussd-server:9000 + CELERY_QUEUE: cic-import-ussd + EXCLUSIONS: ussd + command: + - /bin/bash + - -c + - | + set -a + if [[ -f /tmp/cic/config/env_reset ]]; then source /tmp/cic/config/env_reset; fi + set +a + ./import_ussd.sh + volumes: + - contract-config:/tmp/cic/config/:ro