From a36800eb0bdfd5997240a5a6c8985c75757dc17a Mon Sep 17 00:00:00 2001 From: Pablo Suarez <2323608+pavlops@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:59:02 +0400 Subject: [PATCH] DEVOPS-1133: faucet-service migration to gcp (#319) * feat: DEVOPS-1133 faucet-service migration to gcp * feat: DEVOPS-1133 faucet-service migration to gcp * feat: DEVOPS-1133 faucet-service migration to gcp * feat: DEVOPS-1133 faucet-service migration to gcp * feat: DEVOPS-1133 faucet-service migration to gcp * feat: DEVOPS-1133 faucet-service migration to gcp * feat: DEVOPS-1133 faucet-service migration to gcp --- .github/workflows/cicd-prd.yml | 15 +- .github/workflows/cicd-stg.yml | 6 + products/faucet-service/.env.example | 9 + products/faucet-service/.gitignore | 4 + products/faucet-service/Dockerfile | 13 + products/faucet-service/LICENSE | 674 ++++++++++++++++++ products/faucet-service/Makefile | 37 + products/faucet-service/README.md | 373 ++++++++++ .../faucet-service/cd/base/deployment.yaml | 33 + products/faucet-service/cd/base/ingress.yaml | 20 + .../faucet-service/cd/base/kustomization.yaml | 9 + .../faucet-service/cd/base/namespace.yaml | 6 + products/faucet-service/cd/base/svc.yaml | 15 + .../cd/overlays/isolated-prd/app-secret.yaml | 20 + .../overlays/isolated-prd/backend-config.yaml | 11 + .../cd/overlays/isolated-prd/certificate.yaml | 9 + .../isolated-prd/frontend-config.yaml | 10 + .../overlays/isolated-prd/kustomization.yaml | 35 + .../cd/overlays/isolated-stg/app-secret.yaml | 20 + .../overlays/isolated-stg/backend-config.yaml | 11 + .../cd/overlays/isolated-stg/certificate.yaml | 9 + .../isolated-stg/frontend-config.yaml | 10 + .../overlays/isolated-stg/kustomization.yaml | 35 + .../cd/overlays/testnet-prd/app-secret.yaml | 20 + .../overlays/testnet-prd/backend-config.yaml | 11 + .../cd/overlays/testnet-prd/certificate.yaml | 9 + .../overlays/testnet-prd/frontend-config.yaml | 10 + .../overlays/testnet-prd/kustomization.yaml | 35 + .../cd/overlays/testnet-stg/app-secret.yaml | 20 + .../overlays/testnet-stg/backend-config.yaml | 11 + .../cd/overlays/testnet-stg/certificate.yaml | 9 + .../overlays/testnet-stg/frontend-config.yaml | 10 + .../overlays/testnet-stg/kustomization.yaml | 35 + products/faucet-service/cmd/main.go | 243 +++++++ products/faucet-service/go.mod | 35 + products/faucet-service/go.sum | 114 +++ .../internal/faucet/controller.go | 100 +++ .../internal/faucet/controller_test.go | 160 +++++ .../faucet-service/internal/faucet/service.go | 281 ++++++++ .../internal/faucet/service_test.go | 516 ++++++++++++++ .../internal/recaptcha/recaptcha.go | 91 +++ .../internal/zil/transaction.go | 87 +++ products/faucet-service/openapi.yml | 39 + .../overlays/xcad-production/app-secret.yaml | 10 - .../xcad-production/kustomization.yaml | 7 +- 45 files changed, 3221 insertions(+), 16 deletions(-) create mode 100644 products/faucet-service/.env.example create mode 100644 products/faucet-service/.gitignore create mode 100644 products/faucet-service/Dockerfile create mode 100644 products/faucet-service/LICENSE create mode 100644 products/faucet-service/Makefile create mode 100644 products/faucet-service/README.md create mode 100644 products/faucet-service/cd/base/deployment.yaml create mode 100644 products/faucet-service/cd/base/ingress.yaml create mode 100644 products/faucet-service/cd/base/kustomization.yaml create mode 100644 products/faucet-service/cd/base/namespace.yaml create mode 100644 products/faucet-service/cd/base/svc.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-prd/app-secret.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-prd/backend-config.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-prd/certificate.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-prd/frontend-config.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-prd/kustomization.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-stg/app-secret.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-stg/backend-config.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-stg/certificate.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-stg/frontend-config.yaml create mode 100644 products/faucet-service/cd/overlays/isolated-stg/kustomization.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-prd/app-secret.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-prd/backend-config.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-prd/certificate.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-prd/frontend-config.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-prd/kustomization.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-stg/app-secret.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-stg/backend-config.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-stg/certificate.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-stg/frontend-config.yaml create mode 100644 products/faucet-service/cd/overlays/testnet-stg/kustomization.yaml create mode 100644 products/faucet-service/cmd/main.go create mode 100644 products/faucet-service/go.mod create mode 100644 products/faucet-service/go.sum create mode 100644 products/faucet-service/internal/faucet/controller.go create mode 100644 products/faucet-service/internal/faucet/controller_test.go create mode 100644 products/faucet-service/internal/faucet/service.go create mode 100644 products/faucet-service/internal/faucet/service_test.go create mode 100644 products/faucet-service/internal/recaptcha/recaptcha.go create mode 100644 products/faucet-service/internal/zil/transaction.go create mode 100644 products/faucet-service/openapi.yml delete mode 100644 products/zilliqa-isolated-server/cd/overlays/xcad-production/app-secret.yaml diff --git a/.github/workflows/cicd-prd.yml b/.github/workflows/cicd-prd.yml index b8771ddaf..d8710b44f 100644 --- a/.github/workflows/cicd-prd.yml +++ b/.github/workflows/cicd-prd.yml @@ -20,12 +20,12 @@ jobs: strategy: fail-fast: false matrix: - application: - [ + application: [ bluebell-playground, developer-portal, devex, devex-apollo, + faucet-service eth-spout, governance-api, governance-snapshot, @@ -40,6 +40,11 @@ jobs: path: products/bluebell tag_length: 8 tag_latest: false + - application: developer-portal + image_name: developer-portal + path: products/developer-portal + tag_length: 8 + tag_latest: false - application: devex image_name: devex path: products/devex @@ -50,9 +55,9 @@ jobs: path: products/devex-apollo tag_length: 8 tag_latest: false - - application: developer-portal - image_name: developer-portal - path: products/developer-portal + - application: faucet-service + image_name: faucet-service + path: products/faucet-service tag_length: 8 tag_latest: false - application: eth-spout diff --git a/.github/workflows/cicd-stg.yml b/.github/workflows/cicd-stg.yml index 1f110aa72..d7a6e6b3f 100644 --- a/.github/workflows/cicd-stg.yml +++ b/.github/workflows/cicd-stg.yml @@ -26,6 +26,7 @@ jobs: developer-portal, devex, devex-apollo, + faucet-service, governance-api, governance-snapshot, neo-savant, @@ -49,6 +50,11 @@ jobs: path: products/devex-apollo tag_length: 8 tag_latest: false + - application: faucet-service + image_name: faucet-service + path: products/faucet-service + tag_length: 8 + tag_latest: false - application: neo-savant image_name: neo-savant path: products/neo-savant diff --git a/products/faucet-service/.env.example b/products/faucet-service/.env.example new file mode 100644 index 000000000..707423e0c --- /dev/null +++ b/products/faucet-service/.env.example @@ -0,0 +1,9 @@ +ENV_TYPE=dev +NODE_URL=https://zilliqa-isolated-server.zilliqa.com/ +CHAIN_ID=222 +AMOUNT_IN_ZIL=10 +BATCH_INTERVAL=15s +BATCH_LIMIT=10 +TTL=60 +PRIVATE_KEY=some +RECAPTCHA_SECRET=some diff --git a/products/faucet-service/.gitignore b/products/faucet-service/.gitignore new file mode 100644 index 000000000..543ceeac7 --- /dev/null +++ b/products/faucet-service/.gitignore @@ -0,0 +1,4 @@ +build +.DS_STORE +coverage.txt +.env \ No newline at end of file diff --git a/products/faucet-service/Dockerfile b/products/faucet-service/Dockerfile new file mode 100644 index 000000000..b6ffae97f --- /dev/null +++ b/products/faucet-service/Dockerfile @@ -0,0 +1,13 @@ +FROM golang:1.17.1 as build-stage +WORKDIR /app +COPY . /app +RUN go mod download && \ + CGO_ENABLED=0 GOOS=linux go build -o build/faucet-service ./cmd + + + +FROM alpine:3.10 as final +WORKDIR /app +COPY --from=build-stage /app/build/faucet-service . +EXPOSE 8080 +CMD ["./faucet-service"] diff --git a/products/faucet-service/LICENSE b/products/faucet-service/LICENSE new file mode 100644 index 000000000..f288702d2 --- /dev/null +++ b/products/faucet-service/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/products/faucet-service/Makefile b/products/faucet-service/Makefile new file mode 100644 index 000000000..8ed4b79b4 --- /dev/null +++ b/products/faucet-service/Makefile @@ -0,0 +1,37 @@ +GOBASE = $(shell pwd) +GOBIN = $(GOBASE)/build + +.PHONY: test cover deps build start + +.ONESHELL: +SHELL := /bin/bash +.SHELLFLAGS = -ec + +ENVIRONMENT ?= dev +VALID_ENVIRONMENTS := dev stg prd +IMAGE_TAG ?= localhost:5001/scilla-server:latest + +# Check if the ENVIRONMENT variable is in the list of valid environments +ifeq ($(filter $(ENVIRONMENT),$(VALID_ENVIRONMENTS)),) +$(error Invalid value for ENVIRONMENT. Valid values are dev, stg, or prd.) +endif + +deps: + go mod download + +test: + go test ./... -cover -covermode=atomic -coverprofile=coverage.txt + +cover: + go tool cover -html=coverage.txt + +build: + CGO_ENABLED=0 GOOS=linux go build -o $(GOBIN)/faucet-service ./cmd + +start: + docker build -t faucet-service . -f Dockerfile && docker run -p 8080:8080 --env-file ./.env faucet-service + +## Build and push the Docker image +image/build-and-push: + docker build --build-arg DEPLOY_ENV=${ENVIRONMENT} -t "${IMAGE_TAG}" . + docker push "${IMAGE_TAG}" diff --git a/products/faucet-service/README.md b/products/faucet-service/README.md new file mode 100644 index 000000000..085360631 --- /dev/null +++ b/products/faucet-service/README.md @@ -0,0 +1,373 @@ +# Faucet Service + +## Prerequisites + +- [Golang](https://golang.org) +- [Docker](https://www.docker.com/community-edition) + +## Environment Variables + +Create a `.env` file with the following variables + +| Name | Description | Type | Examples | +| ------------------ | -------------------------------------------------------- | ------------ | --------------------------------------------- | +| `ENV_TYPE` | Environment Type | String | `dev` | +| `NODE_URL` | Node URL | String | `https://zilliqa-isolated-server.zilliqa.com` | +| `CHAIN_ID` | Chain ID | String | `222` | +| `AMOUNT_IN_ZIL` | Fund amount in ZIL | String | `1000` | +| `BATCH_INTERVAL` | Batch interval. Valid time units are `ms`, `s`, `m`, `h` | String | `15s`, `5m` | +| `BATCH_LIMIT` | Batch limit | String | `1000` | +| `TTL` | Time To Live | String | `300` | +| `PRIVATE_KEY` | Private key of the account to be used for funding | SecureString | | +| `RECAPTCHA_SECRET` | reCAPTCHA secret | SecureString | | + +## Installation and Usage + +### `make deps` + +Installs dependencies. + +### `make build` + +Builds the project. + +### `make test` + +Runs tests. + +### `make cover` + +Shows an HTML presentation of the source code decorated with coverage information. + +### `make start` + +Runs Docker container. + +## API Documentation + +View documentation on https://editor.swagger.io/ by pasting openapi.yml from root directory (Recommended) +Or, install vscode plugins for openapi to be able to preview it using swaggerUI. + +## Database + +This service uses [go-memdb](https://github.com/hashicorp/go-memdb) which is a simple in-memory database built on [immutable radix trees](https://github.com/hashicorp/go-immutable-radix). + +## Workflow Visualization + +### Cron job + +The cron job runs the following 4 functions: + +- `Confirm()` +- `Expire()` +- `Retry()` +- `Send()` + +The following table contains sample items and we will see how the above 4 functions change the table. + +| Status | ID | CreatedAt | Address | TxID | +| ------ | --------- | ---------------------- | ----------- | --------- | +| ⌛️ | `...a4a0` | `2021-01-01T00:00:07Z` | `0x...9e79` | `...8e10` | +| ✅ | `...a4a1` | `2021-01-01T00:16:07Z` | `0x...9e79` | `...8e11` | +| ✅ | `...a4a2` | `2021-01-01T00:17:07Z` | `0x...9e79` | `...8e12` | +| ✅ | `...a4a3` | `2021-01-01T00:17:07Z` | `0x...9e79` | `...8e13` | +| 👁 | `...a4a4` | `2021-01-01T00:18:07Z` | `0x...9e79` | `...8e14` | +| 👁 | `...a4a5` | `2021-01-01T00:19:07Z` | `0x...9e79` | `...8e15` | +| 📦 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | | +| 📦 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | | + +Let's assume the following: + +- batch interval is `5 min`. +- estimated confirmation time is `3 min`. +- The batch interval is always longer than the estimated confirmation time. +- Time To Live is `30 min`. +- Now is `2021-01-01T00:31:07Z`. +- It's OK to remove the expired messages. +- It's OK to process a message more than once. + +Also, note that each item has one of the following status: + +- ✅ Confirmed +- ⌛️ Expired +- 👁 Unconfirmed (being tracked) +- 📦 Pending + +#### 1. `Confirm()` Deletes the confirmed items which are no longer needed + +| Status | ID | CreatedAt | Address | TxID | +| ------ | --------- | ---------------------- | ----------- | --------- | +| ⌛️ | `...a4a0` | `2021-01-01T00:00:07Z` | `0x...9e79` | `...8e10` | +| ✅ | `...a4a1` | `2021-01-01T00:16:07Z` | `0x...9e79` | `...8e11` | +| ✅ | `...a4a2` | `2021-01-01T00:17:07Z` | `0x...9e79` | `...8e12` | +| ✅ | `...a4a3` | `2021-01-01T00:17:07Z` | `0x...9e79` | `...8e13` | +| 👁 | `...a4a4` | `2021-01-01T00:18:07Z` | `0x...9e79` | `...8e14` | +| 👁 | `...a4a5` | `2021-01-01T00:19:07Z` | `0x...9e79` | `...8e15` | +| 📦 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | | +| 📦 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | | + +After `Confirm()` the table will be the following: + +| Status | ID | CreatedAt | Address | TxID | +| ------ | --------- | ---------------------- | ----------- | --------- | +| ⌛️ | `...a4a0` | `2021-01-01T00:00:07Z` | `0x...9e79` | `...8e10` | +| 👁 | `...a4a4` | `2021-01-01T00:18:07Z` | `0x...9e79` | `...8e14` | +| 👁 | `...a4a5` | `2021-01-01T00:19:07Z` | `0x...9e79` | `...8e15` | +| 📦 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | | +| 📦 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | | + +Note that the items with ✅ status have been deleted. + +#### 2. `Expire()` Reduces stored data volumes by expiring the old items + +| Status | ID | CreatedAt | Address | TxID | +| :----: | --------- | ---------------------- | ----------- | --------- | +| ⌛️ | `...a4a0` | `2021-01-01T00:00:07Z` | `0x...9e79` | `...8e10` | +| 👁 | `...a4a4` | `2021-01-01T00:18:07Z` | `0x...9e79` | `...8e14` | +| 👁 | `...a4a5` | `2021-01-01T00:19:07Z` | `0x...9e79` | `...8e15` | +| 📦 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | | +| 📦 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | | + +For some reason `...a4a0` is still not confirmed and it should be expired because of the following reasons: + +- `...a4a0` was created at `2021-01-01T00:00:07Z` +- Time To Live is `30 min` +- now is `2021-01-01T00:31:07Z` + +After `Expire()` the table will be the following: + +| Status | ID | CreatedAt | Address | TxID | +| :----: | --------- | ---------------------- | ----------- | --------- | +| 👁 | `...a4a4` | `2021-01-01T00:18:07Z` | `0x...9e79` | `...8e14` | +| 👁 | `...a4a5` | `2021-01-01T00:19:07Z` | `0x...9e79` | `...8e15` | +| 📦 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | | +| 📦 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | | + +Note that the items with ⌛️ status have been deleted. + +#### 3. `Retry()` Removes the old tx id + +| Status | ID | CreatedAt | Address | TxID | +| :----: | --------- | ---------------------- | ----------- | --------- | +| 👁 | `...a4a4` | `2021-01-01T00:18:07Z` | `0x...9e79` | `...8e14` | +| 👁 | `...a4a5` | `2021-01-01T00:19:07Z` | `0x...9e79` | `...8e15` | +| 📦 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | | +| 📦 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | | + +Note that it's at-least-once delivery. + +After `Retry()` the table will be the following: + +| Status | ID | CreatedAt | Address | TxID | +| :----: | --------- | ---------------------- | ----------- | ---- | +| 📦 | `...a4a4` | `2021-08-29T02:09:07Z` | `0x...9e79` | | +| 📦 | `...a4a5` | `2021-08-29T02:10:07Z` | `0x...9e79` | | +| 📦 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | | +| 📦 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | | + +Note that the items doesn't have the tx ID. + +#### 4. `Send()` Creates transactions + +| Status | ID | CreatedAt | Address | TxID | +| :----: | --------- | ---------------------- | ----------- | ---- | +| 📦 | `...a4a4` | `2021-08-29T02:09:07Z` | `0x...9e79` | | +| 📦 | `...a4a5` | `2021-08-29T02:10:07Z` | `0x...9e79` | | +| 📦 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | | +| 📦 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | | + +After `Send()` the table will be the following: + +| Status | ID | CreatedAt | Address | TxID | +| :----: | --------- | ---------------------- | ----------- | --------- | +| 👁 | `...a4a4` | `2021-08-29T02:09:07Z` | `0x...9e79` | `...0e10` | +| 👁 | `...a4a5` | `2021-08-29T02:10:07Z` | `0x...9e79` | `...0e11` | +| 👁 | `...a4a6` | `2021-01-01T00:25:07Z` | `0x...9e79` | `...0e12` | +| 👁 | `...a4a7` | `2021-01-01T00:26:07Z` | `0x...9e79` | `...0e13` | + +Note that each items have the new tx ID. + +## Licence + +You can view our [licence here](LICENSE). + +## Deploying applications with z + +`z` is the one-stop shop for the Zilliqa provisioning and deployment operations. To deploy applications with z ensure the `z` +binary is installed in your operative system PATH environment variable. For more details about `z` please refer to the [documentation](https://github.com/Zilliqa/devops/blob/main/docs/z2.md). + +## Deploying applications to staging + +To deploy the staging environment we need to clone the devops repository and execute `z` from there: + +```sh +git clone https://github.com/Zilliqa/devops.git +cd devops +source setenv +``` + +### Set the following environment variables + +- `Z_ENV` to the path in which your `z.yaml` resides. +- `ZQ_USER` to your username (the bit before `@` in your email address) +- `GITHUB_PAT` (if you are deploying staging or production apps) to a classic PAT with all the repo permissions ticked. + +for example: + +```sh +export Z_ENV=`pwd`/infra/live/gcp/non-production/prj-d-staging/z_ase1.yaml +export ZQ_USER=@zilliqa.com +export GITHUB_PAT= +``` + +### Login to Google Cloud + +```sh +z login +``` + +### Add the application to the staging `z.yaml` file. Skip this step if it is an existing application + +1. Create a branch: + + ```sh + git checkout -b users//add_faucet-service_to_staging_cluster + ``` + +2. In the file `infra/live/gcp/non-production/prj-d-staging/z_ase1.yaml` add the following: + + - in `apps` stanza add: + + ```yaml + clusters: + staging: + apps: + faucet-service: + repo: https://github.com/Zilliqa/zilliqa-developer + path: products/faucet-service/cd/overlays/staging + track: staging + type: kustomize + ``` + + - in `subdomains` stanza add: + + ```yaml + infrastructure: + dns: + vars: + subdomains: + faucet-service: {} + ``` + +3. Push the changes + + ```sh + git add . + git commit -m "Add faucet-service to staging cluster" + git push origin users//add_faucet-service_to_staging_cluster + ``` + +4. Open a Pull Request to the main branch + +5. Apply the changes + + ```sh + z plan + z apply + ``` + +### Deploy the application + +```sh +z app sync --cache-dir=.cache faucet-service +``` + +Verify your application is running correct from the staging URL and with `kubectl` commands (if required). + +## Deploying applications to production + +To deploy the production environment we need to clone the devops repository and execute `z` from there: + +```sh +git clone https://github.com/Zilliqa/devops.git +cd devops +source setenv +``` + +### Set the following environment variables + +- `Z_ENV` to the path in which your `z.yaml` resides. +- `ZQ_USER` to your username (the bit before `@` in your email address) +- `GITHUB_PAT` (if you are deploying staging or production apps) to a classic PAT with all the repo permissions ticked. + +for example: + +```sh +export Z_ENV=`pwd`/infra/live/gcp/production/prj-p-blockchain-infra/z_ase1.yaml +export ZQ_USER=@zilliqa.com +export GITHUB_PAT= +``` + +### Login to Google Cloud + +```sh +z login +``` + +### Add the application to the production `z.yaml` file. Skip this step if it is an existing application + +1. Create a branch: + + ```sh + git checkout -b users//add_faucet-service_to_production_cluster + ``` + +2. In the file `infra/live/gcp/production/prj-p-blockchain-infra/z_ase1.yaml` add the following: + + - in `apps` stanza add: + + ```yaml + clusters: + production: + apps: + faucet-service: + repo: https://github.com/Zilliqa/zilliqa-developer + path: products/faucet-service/cd/overlays/production + track: production + type: kustomize + ``` + + - in `subdomains` stanza add: + + ```yaml + infrastructure: + dns: + vars: + subdomains: + faucet-service: {} + ``` + +3. Push the changes + + ```sh + git add . + git commit -m "Add faucet-service to production cluster" + git push origin users//add_faucet-service_to_production_cluster + ``` + +4. Open a Pull Request to the main branch + +5. Apply the changes + + ```sh + z plan + z apply + ``` + +### Deploy the application + +```sh +z app sync --cache-dir=.cache faucet-service +``` + +Verify your application is running correct from the production URL and with `kubectl` commands (if required). diff --git a/products/faucet-service/cd/base/deployment.yaml b/products/faucet-service/cd/base/deployment.yaml new file mode 100644 index 000000000..146a9ed11 --- /dev/null +++ b/products/faucet-service/cd/base/deployment.yaml @@ -0,0 +1,33 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + replicas: 1 + selector: + matchLabels: + app.kubernetes.io/name: faucet-service + strategy: + type: RollingUpdate + template: + metadata: + labels: + app.kubernetes.io/name: faucet-service + spec: + containers: + - image: faucet-service + name: faucet-service + ports: + - containerPort: 8080 + envFrom: + - secretRef: + name: faucet-service + resources: + limits: + memory: 4000Mi + cpu: 1 + requests: + memory: 2000Mi + cpu: 0.5 diff --git a/products/faucet-service/cd/base/ingress.yaml b/products/faucet-service/cd/base/ingress.yaml new file mode 100644 index 000000000..36fa2fb38 --- /dev/null +++ b/products/faucet-service/cd/base/ingress.yaml @@ -0,0 +1,20 @@ +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service + annotations: + nginx.ingress.kubernetes.io/rewrite-target: /$2 +spec: + rules: + - host: localhost + http: + paths: + - path: / + pathType: Prefix + backend: + service: + name: faucet-service + port: + number: 8080 diff --git a/products/faucet-service/cd/base/kustomization.yaml b/products/faucet-service/cd/base/kustomization.yaml new file mode 100644 index 000000000..110015844 --- /dev/null +++ b/products/faucet-service/cd/base/kustomization.yaml @@ -0,0 +1,9 @@ +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization +resources: + - deployment.yaml + - ingress.yaml + - namespace.yaml + - svc.yaml + +namespace: faucet-service diff --git a/products/faucet-service/cd/base/namespace.yaml b/products/faucet-service/cd/base/namespace.yaml new file mode 100644 index 000000000..84f7648ef --- /dev/null +++ b/products/faucet-service/cd/base/namespace.yaml @@ -0,0 +1,6 @@ +apiVersion: v1 +kind: Namespace +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service diff --git a/products/faucet-service/cd/base/svc.yaml b/products/faucet-service/cd/base/svc.yaml new file mode 100644 index 000000000..7afb63e7b --- /dev/null +++ b/products/faucet-service/cd/base/svc.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + type: ClusterIP + ports: + - port: 8080 + targetPort: 8080 + protocol: TCP + name: http + selector: + app.kubernetes.io/name: faucet-service diff --git a/products/faucet-service/cd/overlays/isolated-prd/app-secret.yaml b/products/faucet-service/cd/overlays/isolated-prd/app-secret.yaml new file mode 100644 index 000000000..a55f98ebe --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-prd/app-secret.yaml @@ -0,0 +1,20 @@ +apiVersion: v1 +kind: Secret +metadata: + name: faucet-service + namespace: faucet-service + labels: + app.kubernetes.io/name: faucet-service + annotations: + zilliqa.com/autofill: prj-p-blockchain-infra +type: Opaque +data: + AMOUNT_IN_ZIL: "zilliqa-isolated-faucet/AMOUNT_IN_ZIL" + BATCH_INTERVAL: "zilliqa-isolated-faucet/BATCH_INTERVAL" + BATCH_LIMIT: "zilliqa-isolated-faucet/BATCH_LIMIT" + CHAIN_ID: "zilliqa-isolated-faucet/CHAIN_ID" + ENV_TYPE: "zilliqa-isolated-faucet/ENV_TYPE" + NODE_URL: "zilliqa-isolated-faucet/NODE_URL" + PRIVATE_KEY: "zilliqa-isolated-faucet/PRIVATE_KEY" + RECAPTCHA_SECRET: "zilliqa-isolated-faucet/RECAPTCHA_SECRET" + TTL: "zilliqa-isolated-faucet/TTL" diff --git a/products/faucet-service/cd/overlays/isolated-prd/backend-config.yaml b/products/faucet-service/cd/overlays/isolated-prd/backend-config.yaml new file mode 100644 index 000000000..480fa750f --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-prd/backend-config.yaml @@ -0,0 +1,11 @@ +apiVersion: cloud.google.com/v1 +kind: BackendConfig +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + timeoutSec: 30 + healthCheck: + requestPath: /livez + port: 8080 diff --git a/products/faucet-service/cd/overlays/isolated-prd/certificate.yaml b/products/faucet-service/cd/overlays/isolated-prd/certificate.yaml new file mode 100644 index 000000000..c7862f1b7 --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-prd/certificate.yaml @@ -0,0 +1,9 @@ +apiVersion: networking.gke.io/v1 +kind: ManagedCertificate +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + domains: + - zilliqa-isolated-faucet.zilliqa.com diff --git a/products/faucet-service/cd/overlays/isolated-prd/frontend-config.yaml b/products/faucet-service/cd/overlays/isolated-prd/frontend-config.yaml new file mode 100644 index 000000000..116562c86 --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-prd/frontend-config.yaml @@ -0,0 +1,10 @@ +apiVersion: networking.gke.io/v1beta1 +kind: FrontendConfig +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + redirectToHttps: + enabled: true + responseCodeName: RESPONSE_CODE diff --git a/products/faucet-service/cd/overlays/isolated-prd/kustomization.yaml b/products/faucet-service/cd/overlays/isolated-prd/kustomization.yaml new file mode 100644 index 000000000..b27caed97 --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-prd/kustomization.yaml @@ -0,0 +1,35 @@ +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +namespace: zilliqa-isolated-faucet-prd + +resources: + - ../../base + - app-secret.yaml + - certificate.yaml + - backend-config.yaml + - frontend-config.yaml + +patches: + - target: + kind: Ingress + name: faucet-service + patch: |- + - op: replace + path: "/spec/rules/0/host" + value: zilliqa-isolated-faucet.zilliqa.com + - op: replace + path: /metadata/annotations + value: + kubernetes.io/ingress.class: gce + kubernetes.io/ingress.global-static-ip-name: zilliqa-isolated-faucet-zilliqa-com + networking.gke.io/managed-certificates: faucet-service + networking.gke.io/v1beta1.FrontendConfig: faucet-service + - target: + kind: Service + name: faucet-service + patch: |- + - op: add + path: /metadata/annotations + value: + beta.cloud.google.com/backend-config: '{"default": "faucet-service"}' diff --git a/products/faucet-service/cd/overlays/isolated-stg/app-secret.yaml b/products/faucet-service/cd/overlays/isolated-stg/app-secret.yaml new file mode 100644 index 000000000..2ebf4e520 --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-stg/app-secret.yaml @@ -0,0 +1,20 @@ +apiVersion: v1 +kind: Secret +metadata: + name: faucet-service + namespace: faucet-service + labels: + app.kubernetes.io/name: faucet-service + annotations: + zilliqa.com/autofill: prj-d-staging +type: Opaque +data: + AMOUNT_IN_ZIL: "zilliqa-isolated-faucet/AMOUNT_IN_ZIL" + BATCH_INTERVAL: "zilliqa-isolated-faucet/BATCH_INTERVAL" + BATCH_LIMIT: "zilliqa-isolated-faucet/BATCH_LIMIT" + CHAIN_ID: "zilliqa-isolated-faucet/CHAIN_ID" + ENV_TYPE: "zilliqa-isolated-faucet/ENV_TYPE" + NODE_URL: "zilliqa-isolated-faucet/NODE_URL" + PRIVATE_KEY: "zilliqa-isolated-faucet/PRIVATE_KEY" + RECAPTCHA_SECRET: "zilliqa-isolated-faucet/RECAPTCHA_SECRET" + TTL: "zilliqa-isolated-faucet/TTL" diff --git a/products/faucet-service/cd/overlays/isolated-stg/backend-config.yaml b/products/faucet-service/cd/overlays/isolated-stg/backend-config.yaml new file mode 100644 index 000000000..480fa750f --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-stg/backend-config.yaml @@ -0,0 +1,11 @@ +apiVersion: cloud.google.com/v1 +kind: BackendConfig +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + timeoutSec: 30 + healthCheck: + requestPath: /livez + port: 8080 diff --git a/products/faucet-service/cd/overlays/isolated-stg/certificate.yaml b/products/faucet-service/cd/overlays/isolated-stg/certificate.yaml new file mode 100644 index 000000000..dc5a6aff7 --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-stg/certificate.yaml @@ -0,0 +1,9 @@ +apiVersion: networking.gke.io/v1 +kind: ManagedCertificate +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + domains: + - stg-zilliqa-isolated-faucet.zilliqa.com diff --git a/products/faucet-service/cd/overlays/isolated-stg/frontend-config.yaml b/products/faucet-service/cd/overlays/isolated-stg/frontend-config.yaml new file mode 100644 index 000000000..116562c86 --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-stg/frontend-config.yaml @@ -0,0 +1,10 @@ +apiVersion: networking.gke.io/v1beta1 +kind: FrontendConfig +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + redirectToHttps: + enabled: true + responseCodeName: RESPONSE_CODE diff --git a/products/faucet-service/cd/overlays/isolated-stg/kustomization.yaml b/products/faucet-service/cd/overlays/isolated-stg/kustomization.yaml new file mode 100644 index 000000000..608a6ee65 --- /dev/null +++ b/products/faucet-service/cd/overlays/isolated-stg/kustomization.yaml @@ -0,0 +1,35 @@ +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +namespace: zilliqa-isolated-faucet-stg + +resources: + - ../../base + - app-secret.yaml + - certificate.yaml + - backend-config.yaml + - frontend-config.yaml + +patches: + - target: + kind: Ingress + name: faucet-service + patch: |- + - op: replace + path: "/spec/rules/0/host" + value: stg-zilliqa-isolated-faucet.zilliqa.com + - op: replace + path: /metadata/annotations + value: + kubernetes.io/ingress.class: gce + kubernetes.io/ingress.global-static-ip-name: stg-zilliqa-isolated-faucet-zilliqa-com + networking.gke.io/managed-certificates: faucet-service + networking.gke.io/v1beta1.FrontendConfig: faucet-service + - target: + kind: Service + name: faucet-service + patch: |- + - op: add + path: /metadata/annotations + value: + beta.cloud.google.com/backend-config: '{"default": "faucet-service"}' diff --git a/products/faucet-service/cd/overlays/testnet-prd/app-secret.yaml b/products/faucet-service/cd/overlays/testnet-prd/app-secret.yaml new file mode 100644 index 000000000..cdeb8ff39 --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-prd/app-secret.yaml @@ -0,0 +1,20 @@ +apiVersion: v1 +kind: Secret +metadata: + name: faucet-service + namespace: faucet-service + labels: + app.kubernetes.io/name: faucet-service + annotations: + zilliqa.com/autofill: prj-p-blockchain-infra +type: Opaque +data: + AMOUNT_IN_ZIL: "testnet-faucet/AMOUNT_IN_ZIL" + BATCH_INTERVAL: "testnet-faucet/BATCH_INTERVAL" + BATCH_LIMIT: "testnet-faucet/BATCH_LIMIT" + CHAIN_ID: "testnet-faucet/CHAIN_ID" + ENV_TYPE: "testnet-faucet/ENV_TYPE" + NODE_URL: "testnet-faucet/NODE_URL" + PRIVATE_KEY: "testnet-faucet/PRIVATE_KEY" + RECAPTCHA_SECRET: "testnet-faucet/RECAPTCHA_SECRET" + TTL: "testnet-faucet/TTL" diff --git a/products/faucet-service/cd/overlays/testnet-prd/backend-config.yaml b/products/faucet-service/cd/overlays/testnet-prd/backend-config.yaml new file mode 100644 index 000000000..480fa750f --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-prd/backend-config.yaml @@ -0,0 +1,11 @@ +apiVersion: cloud.google.com/v1 +kind: BackendConfig +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + timeoutSec: 30 + healthCheck: + requestPath: /livez + port: 8080 diff --git a/products/faucet-service/cd/overlays/testnet-prd/certificate.yaml b/products/faucet-service/cd/overlays/testnet-prd/certificate.yaml new file mode 100644 index 000000000..5d4a65add --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-prd/certificate.yaml @@ -0,0 +1,9 @@ +apiVersion: networking.gke.io/v1 +kind: ManagedCertificate +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + domains: + - testnet-faucet.zilliqa.com diff --git a/products/faucet-service/cd/overlays/testnet-prd/frontend-config.yaml b/products/faucet-service/cd/overlays/testnet-prd/frontend-config.yaml new file mode 100644 index 000000000..116562c86 --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-prd/frontend-config.yaml @@ -0,0 +1,10 @@ +apiVersion: networking.gke.io/v1beta1 +kind: FrontendConfig +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + redirectToHttps: + enabled: true + responseCodeName: RESPONSE_CODE diff --git a/products/faucet-service/cd/overlays/testnet-prd/kustomization.yaml b/products/faucet-service/cd/overlays/testnet-prd/kustomization.yaml new file mode 100644 index 000000000..fe21a89db --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-prd/kustomization.yaml @@ -0,0 +1,35 @@ +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +namespace: testnet-faucet-prd + +resources: + - ../../base + - app-secret.yaml + - certificate.yaml + - backend-config.yaml + - frontend-config.yaml + +patches: + - target: + kind: Ingress + name: faucet-service + patch: |- + - op: replace + path: "/spec/rules/0/host" + value: testnet-faucet.zilliqa.com + - op: replace + path: /metadata/annotations + value: + kubernetes.io/ingress.class: gce + kubernetes.io/ingress.global-static-ip-name: testnet-faucet-zilliqa-com + networking.gke.io/managed-certificates: faucet-service + networking.gke.io/v1beta1.FrontendConfig: faucet-service + - target: + kind: Service + name: faucet-service + patch: |- + - op: add + path: /metadata/annotations + value: + beta.cloud.google.com/backend-config: '{"default": "faucet-service"}' diff --git a/products/faucet-service/cd/overlays/testnet-stg/app-secret.yaml b/products/faucet-service/cd/overlays/testnet-stg/app-secret.yaml new file mode 100644 index 000000000..3dc1ba105 --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-stg/app-secret.yaml @@ -0,0 +1,20 @@ +apiVersion: v1 +kind: Secret +metadata: + name: faucet-service + namespace: faucet-service + labels: + app.kubernetes.io/name: faucet-service + annotations: + zilliqa.com/autofill: prj-d-staging +type: Opaque +data: + AMOUNT_IN_ZIL: "testnet-faucet/AMOUNT_IN_ZIL" + BATCH_INTERVAL: "testnet-faucet/BATCH_INTERVAL" + BATCH_LIMIT: "testnet-faucet/BATCH_LIMIT" + CHAIN_ID: "testnet-faucet/CHAIN_ID" + ENV_TYPE: "testnet-faucet/ENV_TYPE" + NODE_URL: "testnet-faucet/NODE_URL" + PRIVATE_KEY: "testnet-faucet/PRIVATE_KEY" + RECAPTCHA_SECRET: "testnet-faucet/RECAPTCHA_SECRET" + TTL: "testnet-faucet/TTL" diff --git a/products/faucet-service/cd/overlays/testnet-stg/backend-config.yaml b/products/faucet-service/cd/overlays/testnet-stg/backend-config.yaml new file mode 100644 index 000000000..480fa750f --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-stg/backend-config.yaml @@ -0,0 +1,11 @@ +apiVersion: cloud.google.com/v1 +kind: BackendConfig +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + timeoutSec: 30 + healthCheck: + requestPath: /livez + port: 8080 diff --git a/products/faucet-service/cd/overlays/testnet-stg/certificate.yaml b/products/faucet-service/cd/overlays/testnet-stg/certificate.yaml new file mode 100644 index 000000000..f1714ed5f --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-stg/certificate.yaml @@ -0,0 +1,9 @@ +apiVersion: networking.gke.io/v1 +kind: ManagedCertificate +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + domains: + - stg-testnet-faucet.zilliqa.com diff --git a/products/faucet-service/cd/overlays/testnet-stg/frontend-config.yaml b/products/faucet-service/cd/overlays/testnet-stg/frontend-config.yaml new file mode 100644 index 000000000..116562c86 --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-stg/frontend-config.yaml @@ -0,0 +1,10 @@ +apiVersion: networking.gke.io/v1beta1 +kind: FrontendConfig +metadata: + name: faucet-service + labels: + app.kubernetes.io/name: faucet-service +spec: + redirectToHttps: + enabled: true + responseCodeName: RESPONSE_CODE diff --git a/products/faucet-service/cd/overlays/testnet-stg/kustomization.yaml b/products/faucet-service/cd/overlays/testnet-stg/kustomization.yaml new file mode 100644 index 000000000..5219da238 --- /dev/null +++ b/products/faucet-service/cd/overlays/testnet-stg/kustomization.yaml @@ -0,0 +1,35 @@ +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization + +namespace: testnet-faucet-stg + +resources: + - ../../base + - app-secret.yaml + - certificate.yaml + - backend-config.yaml + - frontend-config.yaml + +patches: + - target: + kind: Ingress + name: faucet-service + patch: |- + - op: replace + path: "/spec/rules/0/host" + value: stg-testnet-faucet.zilliqa.com + - op: replace + path: /metadata/annotations + value: + kubernetes.io/ingress.class: gce + kubernetes.io/ingress.global-static-ip-name: stg-testnet-faucet-zilliqa-com + networking.gke.io/managed-certificates: faucet-service + networking.gke.io/v1beta1.FrontendConfig: faucet-service + - target: + kind: Service + name: faucet-service + patch: |- + - op: add + path: /metadata/annotations + value: + beta.cloud.google.com/backend-config: '{"default": "faucet-service"}' diff --git a/products/faucet-service/cmd/main.go b/products/faucet-service/cmd/main.go new file mode 100644 index 000000000..2b131bb9c --- /dev/null +++ b/products/faucet-service/cmd/main.go @@ -0,0 +1,243 @@ +// Copyright (C) 2021 Zilliqa +// +// This file is part of faucet-service. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +package main + +import ( + "faucet-service/internal/faucet" + "faucet-service/internal/recaptcha" + "faucet-service/internal/zil" + "net/http" + "os" + "strconv" + "time" + + "github.com/Zilliqa/gozilliqa-sdk/account" + "github.com/Zilliqa/gozilliqa-sdk/provider" + "github.com/Zilliqa/gozilliqa-sdk/util" + "github.com/gin-gonic/gin" + "github.com/robfig/cron/v3" + log "github.com/sirupsen/logrus" +) + +func cors() gin.HandlerFunc { + return func(c *gin.Context) { + c.Writer.Header().Set("Access-Control-Allow-Origin", "*") + c.Writer.Header().Set("Access-Control-Allow-Methods", "POST, GET, OPTIONS, PUT, DELETE, PATCH") + c.Writer.Header().Set("Access-Control-Allow-Headers", "Accept, Authorization, Content-Type, Content-Length, Cache-Control, pragma, Expires, Origin, x-request-id") + c.Writer.Header().Set("Access-Control-Expose-Headers", "Content-Length") + c.Writer.Header().Set("Cache-Control", "no-store, no-cache, must-revalidate, proxy-revalidate") + c.Writer.Header().Set("pragma", "no-cache") + c.Writer.Header().Set("expires", "0") + c.Writer.Header().Set("x-content-type-options", "nosniff") + c.Writer.Header().Set("x-frame-options", "DENY") + c.Writer.Header().Set("x-xss-protection", "1; mode=block") + + if c.Request.Method == "OPTIONS" { + c.AbortWithStatus(http.StatusOK) + return + } + c.Next() + } +} + +const ScanAction = "SCAN" +const ConfirmAction = "CONFIRM" +const ExpireAction = "EXPIRE" +const RetryAction = "RETRY" +const SendAction = "SEND" + +func main() { + envType := os.Getenv("ENV_TYPE") + nodeURL := os.Getenv("NODE_URL") + chainIDStr := os.Getenv("CHAIN_ID") + amountInZil := os.Getenv("AMOUNT_IN_ZIL") + batchInterval := os.Getenv("BATCH_INTERVAL") + batchLimitStr := os.Getenv("BATCH_LIMIT") + ttlStr := os.Getenv("TTL") + privKey := os.Getenv("PRIVATE_KEY") + secret := os.Getenv("RECAPTCHA_SECRET") + + envVars := []string{ + envType, + nodeURL, + chainIDStr, + amountInZil, + batchInterval, + batchLimitStr, + ttlStr, + privKey, + secret, + } + for _, envVar := range envVars { + if envVar == "" { + panic("💥Invalid environment variables") + } + } + chainID, err := strconv.Atoi(chainIDStr) + if err != nil { + panic(err) + } + ttl, err := strconv.Atoi(ttlStr) + if err != nil { + panic(err) + } + batchLimit, err := strconv.Atoi(batchLimitStr) + if err != nil { + panic(err) + } + + // Create the DB schema + mdb, err := faucet.NewMemDB("req") + if err != nil { + panic(err) + } + + // Use release mode for staging and prod + if envType != "dev" { + gin.SetMode(gin.ReleaseMode) + } + + logger := log.WithFields(log.Fields{"env_type": envType}) + + wallet := account.NewWallet() + wallet.AddByPrivateKey(privKey) + curProvider := provider.NewProvider(nodeURL) + msgVersion := 1 + version := strconv.FormatInt(int64(util.Pack(chainID, msgVersion)), 10) + + logger.Infof("🚀NodeURL:%v ChainID:%v Amount:%v BatchInterval:%v", + nodeURL, + chainID, + amountInZil, + batchInterval, + ) + + batchConfirmTx := zil.BatchConfirmer(curProvider) + batchSendTx := zil.BatchSender( + curProvider, + wallet, + amountInZil, + version, + ) + + // Funcs are invoked in their own goroutine, asynchronously. + c := cron.New() + c.AddFunc("@every 10s", func() { + t0 := time.Now() + total, totalReq, totalTx, err := mdb.Scan() + if err != nil { + logger.Error(err) + return + } + elapsed := time.Since(t0).Milliseconds() + logger.WithFields(log.Fields{ + "action": ScanAction, + "duration": elapsed, + "count": total, + "count_req": totalReq, + "count_tx": totalTx, + }).Infof("📡Total:%d Req:%d Tx:%d", + total, + totalReq, + totalTx, + ) + }) + + c.AddFunc("@every "+batchInterval, func() { + + t0 := time.Now() + // Deletes the confirmed items which are no longer needed. + countConfirmed, err := mdb.Confirm(batchConfirmTx, batchLimit) + if err != nil { + logger.Error(err) + return + } + duration := time.Since(t0).Milliseconds() + logger.WithFields(log.Fields{ + "action": ConfirmAction, + "duration": duration, + "count": countConfirmed, + }).Infof("✅Confirmed:%d", countConfirmed) + + t0 = time.Now() + // Reduce stored data volumes by expiring the old items. + // which are either pending or unconfirmed. + countExpired, err := mdb.Expire(t0.Unix(), ttl) + if err != nil { + logger.Error(err) + return + } + duration = time.Since(t0).Milliseconds() + logger.WithFields(log.Fields{ + "action": ExpireAction, + "duration": duration, + "count": countExpired, + }).Infof("⌛️Expired:%d", countExpired) + + t0 = time.Now() + // Retry unconfirmed items by removing the old tx id. + // Note that it's at-least-once delivery. + countRetry, err := mdb.Retry() + if err != nil { + logger.Error(err) + return + } + duration = time.Since(t0).Milliseconds() + logger.WithFields(log.Fields{ + "action": RetryAction, + "duration": duration, + "count": countRetry, + }).Infof("🔸Retry:%d", countRetry) + + t0 = time.Now() + // Send transactions + countBatch, err := mdb.Send(batchSendTx, batchLimit) + if err != nil { + logger.Error(err) + return + } + duration = time.Since(t0).Milliseconds() + logger.WithFields(log.Fields{ + "action": SendAction, + "duration": duration, + "count": countBatch, + }).Infof("🔹Batch:%d", countBatch) + + }) + c.Start() + + r := gin.New() + r.Use(cors(), gin.Recovery()) + + r.GET("/livez", func(c *gin.Context) { c.String(http.StatusOK, "") }) + + verifyToken := recaptcha.Verifier(secret) + // Mock verifyToken for dev + if envType == "dev" { + verifyToken = func(l *log.Entry, x, y string) error { + return nil + } + } + + r.POST("api/v1/faucet", faucet.Controller( + verifyToken, + mdb.Insert, + )) + + r.Run("0.0.0.0:8080") +} diff --git a/products/faucet-service/go.mod b/products/faucet-service/go.mod new file mode 100644 index 000000000..d34d521b5 --- /dev/null +++ b/products/faucet-service/go.mod @@ -0,0 +1,35 @@ +module faucet-service + +go 1.17 + +require ( + github.com/Zilliqa/gozilliqa-sdk v1.2.0 + github.com/gin-gonic/gin v1.7.4 + github.com/google/uuid v1.3.0 + github.com/hashicorp/go-memdb v1.3.2 + github.com/robfig/cron/v3 v3.0.0 + github.com/sirupsen/logrus v1.7.0 +) + +require ( + github.com/btcsuite/btcd v0.0.0-20190315201642-aa6e0f35703c // indirect + github.com/btcsuite/btcutil v0.0.0-20190425235716-9e5f4b9a998d // indirect + github.com/gin-contrib/sse v0.1.0 // indirect + github.com/go-playground/locales v0.13.0 // indirect + github.com/go-playground/universal-translator v0.17.0 // indirect + github.com/go-playground/validator/v10 v10.4.1 // indirect + github.com/golang/protobuf v1.3.3 // indirect + github.com/hashicorp/go-immutable-radix v1.3.0 // indirect + github.com/hashicorp/golang-lru v0.5.4 // indirect + github.com/json-iterator/go v1.1.9 // indirect + github.com/leodido/go-urn v1.2.0 // indirect + github.com/mattn/go-isatty v0.0.12 // indirect + github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect + github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 // indirect + github.com/tyler-smith/go-bip39 v1.0.2 // indirect + github.com/ugorji/go/codec v1.1.7 // indirect + github.com/ybbus/jsonrpc v2.1.2+incompatible // indirect + golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9 // indirect + golang.org/x/sys v0.0.0-20200116001909-b77594299b42 // indirect + gopkg.in/yaml.v2 v2.2.8 // indirect +) diff --git a/products/faucet-service/go.sum b/products/faucet-service/go.sum new file mode 100644 index 000000000..102bc7fa6 --- /dev/null +++ b/products/faucet-service/go.sum @@ -0,0 +1,114 @@ +github.com/Zilliqa/gozilliqa-sdk v1.2.0 h1:pxINq2woI80BQkMb8dnIVsHw0pk6AkEnZ7DNE94bDMo= +github.com/Zilliqa/gozilliqa-sdk v1.2.0/go.mod h1:eSYp2T6f0apnuW8TzhV3f6Aff2SE8Dwio++U4ha4yEM= +github.com/aead/siphash v1.0.1/go.mod h1:Nywa3cDsYNNK3gaciGTWPwHt0wlpNV15vwmswBAUSII= +github.com/btcsuite/btcd v0.0.0-20190315201642-aa6e0f35703c h1:5N/b57wo2KfeHCGGdcXtOPsHqkPD+veLZhK/bMg2anQ= +github.com/btcsuite/btcd v0.0.0-20190315201642-aa6e0f35703c/go.mod h1:DrZx5ec/dmnfpw9KyYoQyYo7d0KEvTkk/5M/vbZjAr8= +github.com/btcsuite/btclog v0.0.0-20170628155309-84c8d2346e9f/go.mod h1:TdznJufoqS23FtqVCzL0ZqgP5MqXbb4fg/WgDys70nA= +github.com/btcsuite/btcutil v0.0.0-20190207003914-4c204d697803/go.mod h1:+5NJ2+qvTyV9exUAL/rxXi3DcLg2Ts+ymUAY5y4NvMg= +github.com/btcsuite/btcutil v0.0.0-20190425235716-9e5f4b9a998d h1:yJzD/yFppdVCf6ApMkVy8cUxV0XrxdP9rVf6D87/Mng= +github.com/btcsuite/btcutil v0.0.0-20190425235716-9e5f4b9a998d/go.mod h1:+5NJ2+qvTyV9exUAL/rxXi3DcLg2Ts+ymUAY5y4NvMg= +github.com/btcsuite/go-socks v0.0.0-20170105172521-4720035b7bfd/go.mod h1:HHNXQzUsZCxOoE+CPiyCTO6x34Zs86zZUiwtpXoGdtg= +github.com/btcsuite/goleveldb v0.0.0-20160330041536-7834afc9e8cd/go.mod h1:F+uVaaLLH7j4eDXPRvw78tMflu7Ie2bzYOH4Y8rRKBY= +github.com/btcsuite/snappy-go v0.0.0-20151229074030-0bdef8d06723/go.mod h1:8woku9dyThutzjeg+3xrA5iCpBRH8XEEg3lh6TiUghc= +github.com/btcsuite/websocket v0.0.0-20150119174127-31079b680792/go.mod h1:ghJtEyQwv5/p4Mg4C0fgbePVuGr935/5ddU9Z3TmDRY= +github.com/btcsuite/winsvc v1.0.0/go.mod h1:jsenWakMcC0zFBFurPLEAyrnc/teJEM1O46fmI40EZs= +github.com/davecgh/go-spew v0.0.0-20171005155431-ecdeabc65495/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= +github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE= +github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI= +github.com/gin-gonic/gin v1.7.4 h1:QmUZXrvJ9qZ3GfWvQ+2wnW/1ePrTEJqPKMYEU3lD/DM= +github.com/gin-gonic/gin v1.7.4/go.mod h1:jD2toBW3GZUr5UMcdrwQA10I7RuaFOl/SGeDjXkfUtY= +github.com/go-playground/assert/v2 v2.0.1 h1:MsBgLAaY856+nPRTKrp3/OZK38U/wa0CcBYNjji3q3A= +github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= +github.com/go-playground/locales v0.13.0 h1:HyWk6mgj5qFqCT5fjGBuRArbVDfE4hi8+e8ceBS/t7Q= +github.com/go-playground/locales v0.13.0/go.mod h1:taPMhCMXrRLJO55olJkUXHZBHCxTMfnGwq/HNwmWNS8= +github.com/go-playground/universal-translator v0.17.0 h1:icxd5fm+REJzpZx7ZfpaD876Lmtgy7VtROAbHHXk8no= +github.com/go-playground/universal-translator v0.17.0/go.mod h1:UkSxE5sNxxRwHyU+Scu5vgOQjsIJAF8j9muTVoKLVtA= +github.com/go-playground/validator/v10 v10.4.1 h1:pH2c5ADXtd66mxoE0Zm9SUhxE20r7aM3F26W0hOn+GE= +github.com/go-playground/validator/v10 v10.4.1/go.mod h1:nlOn6nFhuKACm19sB/8EGNn9GlaMV7XkbRSipzJ0Ii4= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.3 h1:gyjaxf+svBWX08ZjK86iN9geUJF0H6gp2IRKX6Nf6/I= +github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= +github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/hashicorp/go-immutable-radix v1.3.0 h1:8exGP7ego3OmkfksihtSouGMZ+hQrhxx+FVELeXpVPE= +github.com/hashicorp/go-immutable-radix v1.3.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60= +github.com/hashicorp/go-memdb v1.3.2 h1:RBKHOsnSszpU6vxq80LzC2BaQjuuvoyaQbkLTf7V7g8= +github.com/hashicorp/go-memdb v1.3.2/go.mod h1:Mluclgwib3R93Hk5fxEfiRhB+6Dar64wWh71LpNSe3g= +github.com/hashicorp/go-uuid v1.0.0 h1:RS8zrF7PhGwyNPOtxSClXXj9HA8feRnJzgnI1RJCSnM= +github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= +github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= +github.com/hashicorp/golang-lru v0.5.4 h1:YDjusn29QI/Das2iO9M0BHnIbxPeyuCHsjMW+lJfyTc= +github.com/hashicorp/golang-lru v0.5.4/go.mod h1:iADmTwqILo4mZ8BN3D2Q6+9jd8WM5uGBxy+E8yxSoD4= +github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= +github.com/jessevdk/go-flags v0.0.0-20141203071132-1679536dcc89/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= +github.com/jrick/logrotate v1.0.0/go.mod h1:LNinyqDIJnpAur+b8yyulnQw/wDuN1+BYKlTRt3OuAQ= +github.com/json-iterator/go v1.1.9 h1:9yzud/Ht36ygwatGx56VwCZtlI/2AD15T1X2sjSuGns= +github.com/json-iterator/go v1.1.9/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4= +github.com/kkdai/bstream v0.0.0-20161212061736-f391b8402d23/go.mod h1:J+Gs4SYgM6CZQHDETBtE9HaSEkGmuNXF86RwHhHUvq4= +github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y= +github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII= +github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY= +github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLDQ0W1YjYsBW+p8U2u7vzgW2SQVmlNazg= +github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= +github.com/onsi/gomega v1.4.3 h1:RE1xgDvH7imwFD45h+u2SgIfERHlS2yNG4DObb5BSKU= +github.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/robfig/cron/v3 v3.0.0 h1:kQ6Cb7aHOHTSzNVNEhmp8EcWKLb4CbiMW9h9VyIhO4E= +github.com/robfig/cron/v3 v3.0.0/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro= +github.com/sirupsen/logrus v1.7.0 h1:ShrD1U9pZB12TX0cVy0DtePoCH97K8EtX+mg7ZARUtM= +github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4= +github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= +github.com/tyler-smith/go-bip39 v1.0.2 h1:+t3w+KwLXO6154GNJY+qUtIxLTmFjfUmpguQT1OlOT8= +github.com/tyler-smith/go-bip39 v1.0.2/go.mod h1:sJ5fKU0s6JVwZjjcUEX2zFOnvq0ASQ2K9Zr6cf67kNs= +github.com/ugorji/go v1.1.7 h1:/68gy2h+1mWMrwZFeD1kQialdSzAb432dtpeJ42ovdo= +github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw= +github.com/ugorji/go/codec v1.1.7 h1:2SvQaVZ1ouYrrKKwoSk2pzd4A9evlKJb9oTL+OaLUSs= +github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY= +github.com/ybbus/jsonrpc v2.1.2+incompatible h1:V4mkE9qhbDQ92/MLMIhlhMSbz8jNXdagC3xBR5NDwaQ= +github.com/ybbus/jsonrpc v2.1.2+incompatible/go.mod h1:XJrh1eMSzdIYFbM08flv0wp5G35eRniyeGut1z+LSiE= +golang.org/x/crypto v0.0.0-20170930174604-9419663f5a44/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190426145343-a29dc8fdc734/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9 h1:psW17arqaxU48Z5kZ0CQnkZWQJsqcURM6tKiBApRjXI= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3 h1:0GoQqolDA55aaLxZyTzK/Y2ePZzZTUrRacwib7cNsYQ= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200116001909-b77594299b42 h1:vEOn+mP2zCOVzKckCZy6YsCtDblrpj/w7B9nxGNELpg= +golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= +golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= +gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= +gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/products/faucet-service/internal/faucet/controller.go b/products/faucet-service/internal/faucet/controller.go new file mode 100644 index 000000000..7bb2721fa --- /dev/null +++ b/products/faucet-service/internal/faucet/controller.go @@ -0,0 +1,100 @@ +// Copyright (C) 2021 Zilliqa +// +// This file is part of faucet-service. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +package faucet + +import ( + "net/http" + "time" + + "github.com/Zilliqa/gozilliqa-sdk/bech32" + "github.com/Zilliqa/gozilliqa-sdk/util" + "github.com/Zilliqa/gozilliqa-sdk/validator" + "github.com/gin-gonic/gin" + "github.com/google/uuid" + log "github.com/sirupsen/logrus" +) + +// Model binding and validation +// https://github.com/gin-gonic/gin#model-binding-and-validation + +type BodyParams struct { + Address string `form:"address" json:"address" binding:"required"` + Token string `form:"token" json:"token" binding:"required"` +} + +func Controller( + verify func(*log.Entry, string, string) error, + insert func(*FundRequest) error, +) func(c *gin.Context) { + return func(c *gin.Context) { + body := BodyParams{} + remoteIP := c.ClientIP() + requestID := c.GetHeader("x-request-id") + userAgent := c.Request.UserAgent() + + if err := c.ShouldBindJSON(&body); err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) + return + } + + address := body.Address + + // Support Bech32 + if validator.IsBech32(address) { + address, _ = bech32.FromBech32Addr(address) + } + + // Validate ByStr20 address + if !validator.IsAddress(address) { + c.JSON(http.StatusBadRequest, gin.H{"error": "Invalid address"}) + return + } + address = util.ToCheckSumAddress(address) + + reqLogger := log.WithFields( + log.Fields{ + "request_id": requestID, + "remote_ip": remoteIP, + "user_agent": userAgent, + }, + ) + + reqLogger.Info("body: ", body) + + err := verify(reqLogger, body.Token, remoteIP) + if err != nil { + c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) + return + } + + item := FundRequest{ + ID: uuid.New().String(), + CreatedAt: time.Now().Format(time.RFC3339), + Address: address, + TxID: "", + } + + err = insert(&item) + if err != nil { + c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) + return + } + reqLogger.Info(http.StatusOK) + c.JSON(http.StatusOK, nil) + } +} diff --git a/products/faucet-service/internal/faucet/controller_test.go b/products/faucet-service/internal/faucet/controller_test.go new file mode 100644 index 000000000..f28e14d37 --- /dev/null +++ b/products/faucet-service/internal/faucet/controller_test.go @@ -0,0 +1,160 @@ +// Copyright (C) 2021 Zilliqa +// +// This file is part of faucet-service. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +package faucet + +import ( + "bytes" + "encoding/json" + "errors" + "net/http" + "net/http/httptest" + "testing" + + "github.com/gin-gonic/gin" + log "github.com/sirupsen/logrus" +) + +func TestControler(t *testing.T) { + verifyTokenNoop := func(l *log.Entry, token string, remoteIP string) error { + return nil + } + verifyTokenErr := func(l *log.Entry, token string, remoteIP string) error { + return errors.New("Negative Testing") + } + insertNoop := func(*FundRequest) error { + return nil + } + insertNoopErr := func(*FundRequest) error { + return errors.New("Negative Testing") + } + + testCases := []struct { + body BodyParams + mockVerify func(*log.Entry, string, string) error + mockInsert func(*FundRequest) error + wantStatusCode int + }{ + // 400 for invalid body + { + BodyParams{ + Address: "", + }, + verifyTokenNoop, + insertNoop, + 400, + }, + { + BodyParams{ + Address: "", + Token: "test", + }, + verifyTokenNoop, + insertNoop, + 400, + }, + { + BodyParams{ + Address: "A09e79", + Token: "test", + }, + verifyTokenNoop, + insertNoop, + 400, + }, + + // 400 for invalid token + { + BodyParams{ + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + Token: "test", + }, + verifyTokenErr, + insertNoop, + http.StatusBadRequest, + }, + + // 500 for insertion failure + { + BodyParams{ + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + Token: "test", + }, + verifyTokenNoop, + insertNoopErr, + http.StatusInternalServerError, + }, + + // 200 + { + BodyParams{ + Address: "zil1kkgy7ph9cfzalpg3ygwryk5prqd432jc48yz5k", + Token: "test", + }, + verifyTokenNoop, + insertNoop, + http.StatusOK, + }, + { + BodyParams{ + Address: "0334995e2CFc53CF785C554839F6e845A3A09e79", + Token: "test", + }, + verifyTokenNoop, + insertNoop, + http.StatusOK, + }, + { + BodyParams{ + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + Token: "test", + }, + verifyTokenNoop, + insertNoop, + http.StatusOK, + }, + } + for i, testCase := range testCases { + setupServer := func() *gin.Engine { + r := gin.Default() + r.POST("/test", Controller( + testCase.mockVerify, + testCase.mockInsert, + )) + return r + } + testServer := httptest.NewServer(setupServer()) + defer testServer.Close() + + out, err := json.Marshal(testCase.body) + if err != nil { + panic(err) + } + + resp, err := http.Post( + testServer.URL+"/test", + "application/json", + bytes.NewBufferString(string(out)), + ) + if err != nil { + t.Errorf("%v", err) + } + if resp.StatusCode != testCase.wantStatusCode { + t.Errorf("index:%d, %#v; want %#v", i, resp.StatusCode, testCase.wantStatusCode) + } + } +} diff --git a/products/faucet-service/internal/faucet/service.go b/products/faucet-service/internal/faucet/service.go new file mode 100644 index 000000000..addfea972 --- /dev/null +++ b/products/faucet-service/internal/faucet/service.go @@ -0,0 +1,281 @@ +// Copyright (C) 2021 Zilliqa +// +// This file is part of faucet-service. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +package faucet + +import ( + "time" + + "github.com/hashicorp/go-memdb" +) + +type FundRequest struct { + ID string + CreatedAt string + Address string + TxID string +} + +type MDB struct { + DB *memdb.MemDB + TableName string +} + +func NewMemDB(tableName string) (*MDB, error) { + mdb := MDB{} + schema := &memdb.DBSchema{ + Tables: map[string]*memdb.TableSchema{ + (tableName): { + Name: tableName, + Indexes: map[string]*memdb.IndexSchema{ + "id": { + Name: "id", + Unique: true, + Indexer: &memdb.StringFieldIndex{Field: "ID"}, + }, + "created_at": { + Name: "created_at", + Unique: false, + Indexer: &memdb.StringFieldIndex{Field: "CreatedAt"}, + }, + }, + }, + }, + } + newDb, err := memdb.NewMemDB(schema) + if err != nil { + return nil, err + } + mdb.DB = newDb + mdb.TableName = tableName + return &mdb, nil +} + +func (mdb *MDB) Insert(item *FundRequest) error { + // Create a write transaction + db := mdb.DB + tableName := mdb.TableName + txn := db.Txn(true) + + if err := txn.Insert(tableName, item); err != nil { + txn.Abort() + return err + } + + // Commit the transaction + txn.Commit() + return nil +} + +func (mdb *MDB) Scan() (int, int, int, error) { + db := mdb.DB + tableName := mdb.TableName + + txn := db.Txn(false) + defer txn.Abort() + + total := 0 + totalReq := 0 + totalTx := 0 + + it, err := txn.Get(tableName, "id") + if err != nil { + return total, totalReq, totalTx, err + } + + for obj := it.Next(); obj != nil; obj = it.Next() { + cur := obj.(*FundRequest) + + total++ + if cur.TxID == "" { + totalReq++ + } else { + totalTx++ + } + } + + return total, totalReq, totalTx, nil +} + +func (mdb *MDB) Confirm( + batchConfirmTx func([]string) ([]bool, error), + batchLimit int, +) (int, error) { + db := mdb.DB + tableName := mdb.TableName + + count := 0 + txn := db.Txn(true) + it, err := txn.Get(tableName, "id") + if err != nil { + txn.Abort() + return count, err + } + + reqs := []*FundRequest{} + txIDs := []string{} + for obj := it.Next(); obj != nil; obj = it.Next() { + if len(txIDs) >= batchLimit { + break + } + cur := obj.(*FundRequest) + if cur.TxID != "" { + reqs = append(reqs, cur) + txIDs = append(txIDs, cur.TxID) + } + } + if len(txIDs) == 0 { + txn.Abort() + return count, nil + } + + result, err := batchConfirmTx(txIDs) + if err != nil { + txn.Abort() + return count, err + } + + for i, v := range result { + if v { + txn.Delete(tableName, reqs[i]) + count++ + } + } + + txn.Commit() + return count, nil +} + +func (mdb *MDB) Expire(now int64, ttl int) (int, error) { + db := mdb.DB + tableName := mdb.TableName + + count := 0 + txn := db.Txn(true) + it, err := txn.Get(tableName, "id") + if err != nil { + txn.Abort() + return count, err + } + + for obj := it.Next(); obj != nil; obj = it.Next() { + cur := obj.(*FundRequest) + + t, _ := time.Parse(time.RFC3339, cur.CreatedAt) + createdAt := t.Unix() + + isExpired := int(createdAt) < int(now)-ttl + if isExpired { + txn.Delete(tableName, cur) + count++ + } + } + txn.Commit() + return count, nil +} + +func (mdb *MDB) Retry() (int, error) { + db := mdb.DB + tableName := mdb.TableName + + count := 0 + txn := db.Txn(true) + it, err := txn.Get(tableName, "id") + if err != nil { + txn.Abort() + return count, err + } + + for obj := it.Next(); obj != nil; obj = it.Next() { + cur := obj.(*FundRequest) + + // Note that items are the fresh ones here as we assume that + // Expire() is executed before Retry() + // + // Retry the batch job for the FRESH and UNCONFIRMED items. + // The ones with the tx id are unconfirmed one as we assume that + // Confirm() is executed before Retry(), + hasTxID := cur.TxID != "" + if hasTxID { + newItem := &FundRequest{ + ID: cur.ID, + CreatedAt: cur.CreatedAt, + Address: cur.Address, + TxID: "", + } + txn.Insert(tableName, newItem) + count++ + } + } + txn.Commit() + return count, nil +} + +func (mdb *MDB) Send( + sendBatchTx func([]*FundRequest) (*[]string, error), + batchLimit int, +) (int, error) { + db := mdb.DB + tableName := mdb.TableName + + count := 0 + txn := db.Txn(true) + it, err := txn.Get(tableName, "id") + if err != nil { + txn.Abort() + return count, err + } + + reqsWithoutTxID := []*FundRequest{} + // Filter items without txID + + for obj := it.Next(); obj != nil; obj = it.Next() { + if len(reqsWithoutTxID) >= batchLimit { + break + } + + cur := obj.(*FundRequest) + if cur.TxID == "" { + reqsWithoutTxID = append(reqsWithoutTxID, cur) + + } + } + + if len(reqsWithoutTxID) == 0 { + txn.Abort() + } else { + txIDs, err := sendBatchTx(reqsWithoutTxID) + if err != nil { + txn.Abort() + return count, err + } + for i, cur := range reqsWithoutTxID { + count++ + // When updating an object, the obj provided should be a copy + // rather than a value updated in-place. + newItem := &FundRequest{ + ID: cur.ID, + CreatedAt: cur.CreatedAt, + Address: cur.Address, + TxID: (*txIDs)[i], + } + txn.Insert(tableName, newItem) + } + txn.Commit() + } + return count, nil +} diff --git a/products/faucet-service/internal/faucet/service_test.go b/products/faucet-service/internal/faucet/service_test.go new file mode 100644 index 000000000..a42cf23d1 --- /dev/null +++ b/products/faucet-service/internal/faucet/service_test.go @@ -0,0 +1,516 @@ +// Copyright (C) 2021 Zilliqa +// +// This file is part of faucet-service. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +package faucet + +import ( + "errors" + "testing" + "time" +) + +func TestScan(t *testing.T) { + mdb, err := NewMemDB("test") + if err != nil { + panic(err) + } + + testCases := []struct { + items []*FundRequest + wantTotal int + wantReq int + wantTx int + wantErr error + }{ + { + []*FundRequest{}, + 0, + 0, + 0, + nil, + }, + } + for _, testCase := range testCases { + total, req, tx, err := mdb.Scan() + if total != testCase.wantTotal { + t.Errorf("%#v; want %#v", total, testCase.wantTotal) + } + if req != testCase.wantReq { + t.Errorf("%#v; want %#v", req, testCase.wantReq) + } + if tx != testCase.wantTx { + t.Errorf("%#v; want %#v", tx, testCase.wantTx) + } + if err != testCase.wantErr { + t.Errorf("%#v; want %#v", err, testCase.wantErr) + } + } + + samples := []*FundRequest{ + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a1", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "b56281dc5dd8b44f37fc44bb12d3cc170616eeef121abd364369b15b9b8473a3", + }, + { + ID: "22db01c2-2e3b-4ec2-9ce7-77f0372a50b2", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "9bb742ccb83de0689fee2e8f7967ced7e0d60f1577d94a08c770e8e49838e187", + }, + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a3", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + } + for _, v := range samples { + mdb.Insert(v) + } + + testCases = []struct { + items []*FundRequest + wantTotal int + wantReq int + wantTx int + wantErr error + }{ + { + []*FundRequest{}, + 3, + 1, + 2, + nil, + }, + } + for _, testCase := range testCases { + total, req, tx, err := mdb.Scan() + if total != testCase.wantTotal { + t.Errorf("%#v; want %#v", total, testCase.wantTotal) + } + if req != testCase.wantReq { + t.Errorf("%#v; want %#v", req, testCase.wantReq) + } + if tx != testCase.wantTx { + t.Errorf("%#v; want %#v", tx, testCase.wantTx) + } + if err != testCase.wantErr { + t.Errorf("%#v; want %#v", err, testCase.wantErr) + } + } +} + +func TestConfirm(t *testing.T) { + mdb, err := NewMemDB("test") + if err != nil { + panic(err) + } + // Mock batchConfirmTx() + batchConfirmTx := func(txIDs []string) ([]bool, error) { + result := []bool{} + for range txIDs { + result = append(result, true) + } + return result, nil + } + + count, _ := mdb.Confirm(batchConfirmTx, 10) + if count != 0 { + t.Errorf("%#v", count) + } + + samples := []*FundRequest{ + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a0", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "b56281dc5dd8b44f37fc44bb12d3cc170616eeef121abd364369b15b9b8473a1", + }, + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a1", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "b56281dc5dd8b44f37fc44bb12d3cc170616eeef121abd364369b15b9b8473a2", + }, + { + ID: "22db01c2-2e3b-4ec2-9ce7-77f0372a50b2", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "9bb742ccb83de0689fee2e8f7967ced7e0d60f1577d94a08c770e8e49838e183", + }, + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a3", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + } + for _, v := range samples { + mdb.Insert(v) + } + + mdb.Confirm(batchConfirmTx, 2) + + testCases := []struct { + items []*FundRequest + wantTotal int + wantReq int + wantTx int + wantErr error + }{ + { + []*FundRequest{}, + 2, + 1, + 1, + nil, + }, + } + for _, testCase := range testCases { + total, req, tx, err := mdb.Scan() + if total != testCase.wantTotal { + t.Errorf("%#v; want %#v", total, testCase.wantTotal) + } + if req != testCase.wantReq { + t.Errorf("%#v; want %#v", req, testCase.wantReq) + } + if tx != testCase.wantTx { + t.Errorf("%#v; want %#v", tx, testCase.wantTx) + } + if err != testCase.wantErr { + t.Errorf("%#v; want %#v", err, testCase.wantErr) + } + } +} + +func TestCleanup(t *testing.T) { + mdb, err := NewMemDB("test") + if err != nil { + panic(err) + } + samples := []*FundRequest{ + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a1", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + { + ID: "22db01c2-2e3b-4ec2-9ce7-77f0372a50b2", + CreatedAt: "2021-08-29T04:02:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a3", + CreatedAt: "2021-08-29T04:04:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + } + + for _, v := range samples { + mdb.Insert(v) + } + + now, _ := time.Parse(time.RFC3339, "2021-08-29T04:04:07Z") + nowUnix := now.Unix() + ttl := 60 * 3 + mdb.Expire(nowUnix, ttl) + + testCases := []struct { + items []*FundRequest + wantTotal int + wantReq int + wantTx int + wantErr error + }{ + { + []*FundRequest{}, + 2, + 2, + 0, + nil, + }, + } + for _, testCase := range testCases { + total, req, tx, err := mdb.Scan() + if total != testCase.wantTotal { + t.Errorf("%#v; want %#v", total, testCase.wantTotal) + } + if req != testCase.wantReq { + t.Errorf("%#v; want %#v", req, testCase.wantReq) + } + if tx != testCase.wantTx { + t.Errorf("%#v; want %#v", tx, testCase.wantTx) + } + if err != testCase.wantErr { + t.Errorf("%#v; want %#v", err, testCase.wantErr) + } + } +} + +func TestRetry(t *testing.T) { + mdb, err := NewMemDB("test") + if err != nil { + panic(err) + } + samples := []*FundRequest{ + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a1", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "b56281dc5dd8b44f37fc44bb12d3cc170616eeef121abd364369b15b9b8473a1", + }, + { + ID: "22db01c2-2e3b-4ec2-9ce7-77f0372a50b2", + CreatedAt: "2021-08-29T04:02:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "b56281dc5dd8b44f37fc44bb12d3cc170616eeef121abd364369b15b9b8473a2", + }, + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a3", + CreatedAt: "2021-08-29T04:04:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + } + + for _, v := range samples { + mdb.Insert(v) + } + + mdb.Retry() + + testCases := []struct { + items []*FundRequest + wantTotal int + wantReq int + wantTx int + wantErr error + }{ + { + []*FundRequest{}, + 3, + 3, + 0, + nil, + }, + } + for _, testCase := range testCases { + total, req, tx, err := mdb.Scan() + if total != testCase.wantTotal { + t.Errorf("%#v; want %#v", total, testCase.wantTotal) + } + if req != testCase.wantReq { + t.Errorf("%#v; want %#v", req, testCase.wantReq) + } + if tx != testCase.wantTx { + t.Errorf("%#v; want %#v", tx, testCase.wantTx) + } + if err != testCase.wantErr { + t.Errorf("%#v; want %#v", err, testCase.wantErr) + } + } +} + +func TestBatchErr(t *testing.T) { + mdb, err := NewMemDB("test") + if err != nil { + panic(err) + } + samples := []*FundRequest{ + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a1", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + { + ID: "22db01c2-2e3b-4ec2-9ce7-77f0372a50b2", + CreatedAt: "2021-08-29T04:02:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a3", + CreatedAt: "2021-08-29T04:04:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + } + + for _, v := range samples { + mdb.Insert(v) + } + + // Mock sendBatchTx() + sendBatchTxErr := func(reqs []*FundRequest) (*[]string, error) { + return nil, errors.New("Negative Testing") + } + + _, err = mdb.Send(sendBatchTxErr, 10) + if err.Error() != "Negative Testing" { + t.Errorf("%#v", err.Error()) + } +} +func TestBatchNoop(t *testing.T) { + mdb, err := NewMemDB("test") + if err != nil { + panic(err) + } + samples := []*FundRequest{ + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a1", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "b56281dc5dd8b44f37fc44bb12d3cc170616eeef121abd364369b15b9b8473a1", + }, + { + ID: "22db01c2-2e3b-4ec2-9ce7-77f0372a50b2", + CreatedAt: "2021-08-29T04:02:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "b56281dc5dd8b44f37fc44bb12d3cc170616eeef121abd364369b15b9b8473a2", + }, + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a3", + CreatedAt: "2021-08-29T04:04:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "b56281dc5dd8b44f37fc44bb12d3cc170616eeef121abd364369b15b9b8473a3", + }, + } + + for _, v := range samples { + mdb.Insert(v) + } + + // Mock sendBatchTx() + sendBatchTx := func(reqs []*FundRequest) (*[]string, error) { + txIDs := []string{} + for _, v := range reqs { + txIDs = append(txIDs, v.ID) + } + return &txIDs, nil + } + + mdb.Send(sendBatchTx, 10) + + testCases := []struct { + items []*FundRequest + wantTotal int + wantReq int + wantTx int + wantErr error + }{ + { + []*FundRequest{}, + 3, + 0, + 3, + nil, + }, + } + for _, testCase := range testCases { + total, req, tx, err := mdb.Scan() + if total != testCase.wantTotal { + t.Errorf("%#v; want %#v", total, testCase.wantTotal) + } + if req != testCase.wantReq { + t.Errorf("%#v; want %#v", req, testCase.wantReq) + } + if tx != testCase.wantTx { + t.Errorf("%#v; want %#v", tx, testCase.wantTx) + } + if err != testCase.wantErr { + t.Errorf("%#v; want %#v", err, testCase.wantErr) + } + } +} + +func TestBatch(t *testing.T) { + mdb, err := NewMemDB("test") + if err != nil { + panic(err) + } + samples := []*FundRequest{ + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a1", + CreatedAt: "2021-08-29T04:00:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + { + ID: "22db01c2-2e3b-4ec2-9ce7-77f0372a50b2", + CreatedAt: "2021-08-29T04:02:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + { + ID: "1e1413cc-f604-44db-969d-eb3b40fea4a3", + CreatedAt: "2021-08-29T04:04:07Z", + Address: "0x0334995e2CFc53CF785C554839F6e845A3A09e79", + TxID: "", + }, + } + + for _, v := range samples { + mdb.Insert(v) + } + + // Mock sendBatchTx() + sendBatchTx := func(reqs []*FundRequest) (*[]string, error) { + txIDs := []string{} + for _, v := range reqs { + txIDs = append(txIDs, v.ID) + } + return &txIDs, nil + } + mdb.Send(sendBatchTx, 2) + + testCases := []struct { + items []*FundRequest + wantTotal int + wantReq int + wantTx int + wantErr error + }{ + { + []*FundRequest{}, + 3, + 1, + 2, + nil, + }, + } + for _, testCase := range testCases { + total, req, tx, err := mdb.Scan() + if total != testCase.wantTotal { + t.Errorf("%#v; want %#v", total, testCase.wantTotal) + } + if req != testCase.wantReq { + t.Errorf("%#v; want %#v", req, testCase.wantReq) + } + if tx != testCase.wantTx { + t.Errorf("%#v; want %#v", tx, testCase.wantTx) + } + if err != testCase.wantErr { + t.Errorf("%#v; want %#v", err, testCase.wantErr) + } + } +} diff --git a/products/faucet-service/internal/recaptcha/recaptcha.go b/products/faucet-service/internal/recaptcha/recaptcha.go new file mode 100644 index 000000000..53c93f8ee --- /dev/null +++ b/products/faucet-service/internal/recaptcha/recaptcha.go @@ -0,0 +1,91 @@ +// Copyright (C) 2021 Zilliqa +// +// This file is part of faucet-service. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +package recaptcha + +import ( + "encoding/json" + "errors" + "io/ioutil" + "net/http" + "strings" + + log "github.com/sirupsen/logrus" +) + +// https://developers.google.com/recaptcha/docs/verify#api_request + +type Response struct { + Success bool `json:"success"` + + // timestamp of the challenge load (ISO format yyyy-MM-dd'T'HH:mm:ssZZ) + ChallengeTs string `json:"challenge_ts"` + + // the hostname of the site where the reCAPTCHA was solved + Hostname string `json:"hostname"` + + // Error code reference + ErrorCodes []string `json:"error-codes"` + // + // missing-input-secret The secret parameter is missing. + // invalid-input-secret The secret parameter is invalid or malformed. + // missing-input-response The response parameter is missing. + // invalid-input-response The response parameter is invalid or malformed. + // bad-request The request is invalid or malformed. + // timeout-or-duplicate The response is no longer valid: either is too old or has been used previously. + // + // https://developers.google.com/recaptcha/docs/verify#error_code_reference +} + +// Verifier returns verify function +func Verifier(secret string) func(*log.Entry, string, string) error { + return func(logger *log.Entry, token string, remoteIP string) error { + url := "https://www.google.com/recaptcha/api/siteverify" + + "?secret=" + secret + + "&response=" + token + + "&remoteip=" + remoteIP + + req, err := http.NewRequest(http.MethodPost, url, nil) + if err != nil { + return err + } + + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") + resp, err := http.DefaultClient.Do(req) + if err != nil { + return err + } + + defer resp.Body.Close() + logger.Info("recaptcha status code: ", resp.StatusCode) + + body, _ := ioutil.ReadAll(resp.Body) + res := Response{} + err = json.Unmarshal(body, &res) + if err != nil { + return err + } + logger.Info("recaptcha body: ", res) + + if !res.Success { + errorCodes := strings.Join(res.ErrorCodes, ",") + return errors.New(errorCodes) + } + + return nil + } +} diff --git a/products/faucet-service/internal/zil/transaction.go b/products/faucet-service/internal/zil/transaction.go new file mode 100644 index 000000000..c821193fd --- /dev/null +++ b/products/faucet-service/internal/zil/transaction.go @@ -0,0 +1,87 @@ +// Copyright (C) 2021 Zilliqa +// +// This file is part of faucet-service. +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +package zil + +import ( + "faucet-service/internal/faucet" + + "github.com/Zilliqa/gozilliqa-sdk/account" + "github.com/Zilliqa/gozilliqa-sdk/provider" + "github.com/Zilliqa/gozilliqa-sdk/transaction" +) + +func BatchConfirmer( + provider *provider.Provider, +) func([]string) ([]bool, error) { + return func(txIDs []string) ([]bool, error) { + responses, err := provider.GetTransactionBatch(txIDs) + if err != nil { + return nil, err + } + result := []bool{} + for _, v := range responses { + result = append(result, v.Receipt.Success) + } + return result, nil + } +} + +func BatchSender( + provider *provider.Provider, + wallet *account.Wallet, + amountInZil string, + version string, +) func([]*faucet.FundRequest) (*[]string, error) { + amount := amountInZil + "000000000000" + return func(reqs []*faucet.FundRequest) (*[]string, error) { + gasPrice, err := provider.GetMinimumGasPrice() + if err != nil { + return nil, err + } + + txs := []*transaction.Transaction{} + for _, cur := range reqs { + tx := &transaction.Transaction{ + Version: version, + ToAddr: cur.Address, + Amount: amount, + GasPrice: gasPrice, + GasLimit: "50", + Code: "", + Data: "", + Priority: false, + } + txs = append(txs, tx) + } + + err = wallet.SignBatch(txs, *provider) + if err != nil { + return nil, err + } + result, err := wallet.SendBatchOneGo(txs, *provider) + if err != nil { + return nil, err + } + + txIDs := []string{} + for _, v := range result { + txIDs = append(txIDs, v.Hash) + } + return &txIDs, nil + } +} diff --git a/products/faucet-service/openapi.yml b/products/faucet-service/openapi.yml new file mode 100644 index 000000000..f373c2466 --- /dev/null +++ b/products/faucet-service/openapi.yml @@ -0,0 +1,39 @@ +openapi: "3.0.2" +info: + title: Faucet Service + version: "1.0" +servers: + - url: https://isolated-server-faucet.api.zilliqa.com/api/v1 + - url: https://testnet-faucet.api.zilliqa.com/api/v1 +paths: + /faucet: + post: + summary: Requests funds + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + address: + type: string + example: d1F9288cE6e645AB758366964D51ba5C001517d5 + token: + type: string + example: + required: + - address + - token + examples: + example: + value: + address: d1F9288cE6e645AB758366964D51ba5C001517d5 + token: + responses: + "200": + description: OK + "400": + description: Bad Request + "429": + description: Too many requests diff --git a/products/zilliqa-isolated-server/cd/overlays/xcad-production/app-secret.yaml b/products/zilliqa-isolated-server/cd/overlays/xcad-production/app-secret.yaml deleted file mode 100644 index ada30d2cd..000000000 --- a/products/zilliqa-isolated-server/cd/overlays/xcad-production/app-secret.yaml +++ /dev/null @@ -1,10 +0,0 @@ -apiVersion: v1 -kind: Secret -metadata: - name: zilliqa-isolated-server - namespace: zilliqa-isolated-server - labels: - app.kubernetes.io/name: zilliqa-isolated-server -type: Opaque -data: - UUID: "" diff --git a/products/zilliqa-isolated-server/cd/overlays/xcad-production/kustomization.yaml b/products/zilliqa-isolated-server/cd/overlays/xcad-production/kustomization.yaml index 8c46be446..f22a44ed3 100644 --- a/products/zilliqa-isolated-server/cd/overlays/xcad-production/kustomization.yaml +++ b/products/zilliqa-isolated-server/cd/overlays/xcad-production/kustomization.yaml @@ -6,7 +6,6 @@ namespace: xcad-isolated-server-prd resources: - ../../base - configmap.yaml - - app-secret.yaml - certificate.yaml - backend-config.yaml - frontend-config.yaml @@ -34,3 +33,9 @@ patches: path: /metadata/annotations value: beta.cloud.google.com/backend-config: '{"default": "zilliqa-isolated-server"}' + - target: + kind: Deployment + name: zilliqa-isolated-server + patch: |- + - op: remove + path: "/spec/template/spec/containers/1/envFrom/1"