diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..6c0ae4a --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,29 @@ +name: goreleaser + +on: + push: + tags: + - '*' + +jobs: + goreleaser: + runs-on: ubuntu-latest + steps: + - + name: Checkout + uses: actions/checkout@v2 + with: + fetch-depth: 0 + - + name: Set up Go + uses: actions/setup-go@v2 + with: + go-version: 1.16 + - + name: Run GoReleaser + uses: goreleaser/goreleaser-action@v2 + with: + version: latest + args: release --rm-dist + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.goreleaser.yml b/.goreleaser.yml new file mode 100644 index 0000000..8f5efec --- /dev/null +++ b/.goreleaser.yml @@ -0,0 +1,36 @@ +before: + hooks: + - go mod download + +builds: + - main: ./cli/node/main.go + binary: node + id: node + goos: + - linux + - darwin + - windows + hooks: + pre: make migration-pack + post: make migration-clean + +archives: + - replacements: + darwin: Darwin + linux: Linux + windows: Windows + 386: i386 + amd64: x86_64 + +checksum: + name_template: 'checksums.txt' + +snapshot: + name_template: "{{ .Tag }}-next" + +changelog: + sort: asc + filters: + exclude: + - '^docs:' + - '^test:' diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..29ebfa5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. \ No newline at end of file diff --git a/Makefile b/Makefile index 9544cc3..97489e0 100644 --- a/Makefile +++ b/Makefile @@ -3,8 +3,8 @@ # Project variables. PACKAGE := github.com/hermeznetwork/hermez-node VERSION := $(shell git describe --tags --always) -BUILD := $(shell git rev-parse --short HEAD) -BUILD_DATE := $(shell date +%Y-%m-%dT%H:%M:%S%z) +COMMIT := $(shell git rev-parse --short HEAD) +DATE := $(shell date +%Y-%m-%dT%H:%M:%S%z) PROJECT_NAME := $(shell basename "$(PWD)") # Go related variables. @@ -23,7 +23,7 @@ CONFIG ?= $(GOBASE)/cli/node/cfg.buidler.toml POSTGRES_PASS ?= yourpasswordhere # Use linker flags to provide version/build settings. -LDFLAGS=-ldflags "-X=main.Version=$(VERSION) -X=main.Build=$(BUILD) -X=main.Date=$(BUILD_DATE)" +LDFLAGS=-ldflags "-X main.version=$(VERSION) -X main.commit=$(COMMIT) -X main.date=$(DATE)" # PID file will keep the process id of the server. PID_PROOF_MOCK := /tmp/.$(PROJECT_NAME).proof.pid @@ -94,11 +94,11 @@ install: @echo " > Checking if there is any missing dependencies..." $(GOENVVARS) go get $(GOCMD)/... $(get) -## run: Run Hermez node. -run: +## run-node: Run Hermez node. +run-node: @bash -c "$(MAKE) clean build" @echo " > Running $(PROJECT_NAME)" - @$(GOBIN)/$(GOBINARY) --mode $(MODE) --cfg $(CONFIG) run + @$(GOBIN)/$(GOBINARY) run --mode $(MODE) --cfg $(CONFIG) ## run-proof-mock: Run proof server mock API. run-proof-mock: stop-proof-mock diff --git a/README.md b/README.md index 12b0a21..38e0673 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,13 @@ there are more information about the config file into [cli/node/README.md](cli/n After setting the config, you can build and run the Hermez Node as a synchronizer: ```shell -$ make run +$ make run-node ``` Or build and run as a coordinator, and also passing the config file from other location: ```shell -$ MODE=sync CONFIG=cli/node/cfg.buidler.toml make run +$ MODE=sync CONFIG=cli/node/cfg.buidler.toml make run-node ``` To check the useful make commands: diff --git a/cli/node/README.md b/cli/node/README.md index 82756c7..0b8a8a9 100644 --- a/cli/node/README.md +++ b/cli/node/README.md @@ -24,6 +24,7 @@ COMMANDS: genbjj Generate a new BabyJubJub key wipesql Wipe the SQL DB (HistoryDB and L2DB) and the StateDBs, leaving the DB in a clean state run Run the hermez-node in the indicated mode + serveapi Serve the API only discard Discard blocks up to a specified block number help, h Shows a list of commands or help for one command @@ -54,6 +55,10 @@ To read the documentation of each configuration parameter, please check the with `Coordinator` are only used in coord mode, and don't need to be defined when running the coordinator in sync mode +When running the API in standalone mode, the required configuration is a subset +of the node configuration. Please, check the `type APIServer` at +[config/config.go](../../config/config.go) to learn about all the parametes. + ### Notes - The private key corresponding to the parameter `Coordinator.ForgerAddress` needs to be imported in the ethereum keystore @@ -68,6 +73,9 @@ when running the coordinator in sync mode monitor the size of the folder to avoid running out of space. - The node requires a PostgreSQL database. The parameters of the server and database must be set in the `PostgreSQL` section. +- The node requires a web3 RPC server to work. The node has only been tested + with geth and may not work correctly with other ethereum nodes + implementations. ## Building @@ -107,6 +115,14 @@ Run the node in mode coordinator: ./node run --mode coord --cfg cfg.buidler.toml ``` +Serve the API in standalone mode. This command allows serving the API just +with access to the PostgreSQL database that a node is using. Several instances +of `serveapi` can be running at the same time with a single PostgreSQL +database: +```shell +./node serveapi --mode coord --cfg cfg.buidler.toml +``` + Import an ethereum private key into the keystore: ```shell ./node importkey --mode coord --cfg cfg.buidler.toml --privatekey 0x618b35096c477aab18b11a752be619f0023a539bb02dd6c813477a6211916cde diff --git a/cli/node/load-sk-example.sh b/cli/node/load-sk-example.sh index 03f5ad7..3f99342 100755 --- a/cli/node/load-sk-example.sh +++ b/cli/node/load-sk-example.sh @@ -1,10 +1,10 @@ #!/bin/sh # Non-Boot Coordinator -go run . --mode coord --cfg cfg.buidler.toml importkey --privatekey 0x30f5fddb34cd4166adb2c6003fa6b18f380fd2341376be42cf1c7937004ac7a3 +go run . importkey --mode coord --cfg cfg.buidler.toml --privatekey 0x30f5fddb34cd4166adb2c6003fa6b18f380fd2341376be42cf1c7937004ac7a3 # Boot Coordinator -go run . --mode coord --cfg cfg.buidler.toml importkey --privatekey 0xa8a54b2d8197bc0b19bb8a084031be71835580a01e70a45a13babd16c9bc1563 +go run . importkey --mode coord --cfg cfg.buidler.toml --privatekey 0xa8a54b2d8197bc0b19bb8a084031be71835580a01e70a45a13babd16c9bc1563 # FeeAccount -go run . --mode coord --cfg cfg.buidler.toml importkey --privatekey 0x3a9270c020e169097808da4b02e8d9100be0f8a38cfad3dcfc0b398076381fdd +go run . importkey --mode coord --cfg cfg.buidler.toml --privatekey 0x3a9270c020e169097808da4b02e8d9100be0f8a38cfad3dcfc0b398076381fdd diff --git a/cli/node/main.go b/cli/node/main.go index 9261fb7..619dbab 100644 --- a/cli/node/main.go +++ b/cli/node/main.go @@ -35,18 +35,18 @@ const ( ) var ( - // Version represents the program based on the git tag - Version = "v0.1.0" - // Build represents the program based on the git commit - Build = "dev" - // Date represents the date of application was built - Date = "" + // version represents the program based on the git tag + version = "v0.1.0" + // commit represents the program based on the git commit + commit = "dev" + // date represents the date of application was built + date = "" ) func cmdVersion(c *cli.Context) error { - fmt.Printf("Version = \"%v\"\n", Version) - fmt.Printf("Build = \"%v\"\n", Build) - fmt.Printf("Date = \"%v\"\n", Date) + fmt.Printf("Version = \"%v\"\n", version) + fmt.Printf("Build = \"%v\"\n", commit) + fmt.Printf("Date = \"%v\"\n", date) return nil } @@ -421,7 +421,7 @@ func getConfigAPIServer(c *cli.Context) (*ConfigAPIServer, error) { func main() { app := cli.NewApp() app.Name = "hermez-node" - app.Version = Version + app.Version = version flags := []cli.Flag{ &cli.StringFlag{ Name: flagMode, @@ -485,6 +485,7 @@ func main() { Aliases: []string{}, Usage: "Serve the API only", Action: cmdServeAPI, + Flags: flags, }, { Name: "discard", diff --git a/config/config.go b/config/config.go index 77807f7..419617f 100644 --- a/config/config.go +++ b/config/config.go @@ -299,7 +299,8 @@ type Node struct { } `validate:"required"` PostgreSQL PostgreSQL `validate:"required"` Web3 struct { - // URL is the URL of the web3 ethereum-node RPC server + // URL is the URL of the web3 ethereum-node RPC server. Only + // geth is officially supported. URL string `validate:"required"` } `validate:"required"` Synchronizer struct { diff --git a/coordinator/coordinator.go b/coordinator/coordinator.go index a5a60ed..29e2c65 100644 --- a/coordinator/coordinator.go +++ b/coordinator/coordinator.go @@ -1,3 +1,43 @@ +/* +Package coordinator handles all the logic related to forging batches as a +coordinator in the hermez network. + +The forging of batches is done with a pipeline in order to allow multiple +batches being forged in parallel. The maximum number of batches that can be +forged in parallel is determined by the number of available proof servers. + +The Coordinator begins with the pipeline stopped. The main Coordinator +goroutine keeps listening for synchronizer events sent by the node package, +which allow the coordinator to determine if the configured forger address is +allowed to forge at the current block or not. When the forger address becomes +allowed to forge, the pipeline is started, and when it terminates being allowed +to forge, the pipeline is stopped. + +The Pipeline consists of two goroutines. The first one is in charge of +preparing a batch internally, which involves making a selection of transactions +and calculating the ZKInputs for the batch proof, and sending these ZKInputs to +an idle proof server. This goroutine will keep preparing batches while there +are idle proof servers, if the forging policy determines that a batch should be +forged in the current state. The second goroutine is in charge of waiting for +the proof server to finish computing the proof, retreiving it, prepare the +arguments for the `forgeBatch` Rollup transaction, and sending the result to +the TxManager. All the batch information moves between functions and +goroutines via the BatchInfo struct. + +Finally, the TxManager contains a single goroutine that makes forgeBatch +ethereum transactions for the batches sent by the Pipeline, and keeps them in a +list to check them periodically. In the periodic checks, the ethereum +transaction is checked for successfulness, and it's only forgotten after a +number of confirmation blocks have passed after being successfully mined. At +any point if a transaction failure is detected, the TxManager can signal the +Coordinator to reset the Pipeline in order to reforge the failed batches. + +The Coordinator goroutine acts as a manager. The synchronizer events (which +notify about new blocks and associated new state) that it receives are +broadcasted to the Pipeline and the TxManager. This allows the Coordinator, +Pipeline and TxManager to have a copy of the current hermez network state +required to perform their duties. +*/ package coordinator import ( diff --git a/eth/auction.go b/eth/auction.go index 0c439df..c47ad74 100644 --- a/eth/auction.go +++ b/eth/auction.go @@ -260,7 +260,7 @@ type AuctionInterface interface { AuctionConstants() (*common.AuctionConstants, error) AuctionEventsByBlock(blockNum int64, blockHash *ethCommon.Hash) (*AuctionEvents, error) - AuctionEventInit() (*AuctionEventInitialize, int64, error) + AuctionEventInit(genesisBlockNum int64) (*AuctionEventInitialize, int64, error) } // @@ -809,12 +809,14 @@ var ( ) // AuctionEventInit returns the initialize event with its corresponding block number -func (c *AuctionClient) AuctionEventInit() (*AuctionEventInitialize, int64, error) { +func (c *AuctionClient) AuctionEventInit(genesisBlockNum int64) (*AuctionEventInitialize, int64, error) { query := ethereum.FilterQuery{ Addresses: []ethCommon.Address{ c.address, }, - Topics: [][]ethCommon.Hash{{logAuctionInitialize}}, + FromBlock: big.NewInt(max(0, genesisBlockNum-blocksPerDay)), + ToBlock: big.NewInt(genesisBlockNum), + Topics: [][]ethCommon.Hash{{logAuctionInitialize}}, } logs, err := c.client.client.FilterLogs(context.Background(), query) if err != nil { diff --git a/eth/auction_test.go b/eth/auction_test.go index 27a2f1c..2ae8520 100644 --- a/eth/auction_test.go +++ b/eth/auction_test.go @@ -28,7 +28,7 @@ func TestAuctionGetCurrentSlotNumber(t *testing.T) { } func TestAuctionEventInit(t *testing.T) { - auctionInit, blockNum, err := auctionClientTest.AuctionEventInit() + auctionInit, blockNum, err := auctionClientTest.AuctionEventInit(genesisBlock) require.NoError(t, err) assert.Equal(t, int64(18), blockNum) assert.Equal(t, donationAddressConst, auctionInit.DonationAddress) diff --git a/eth/client.go b/eth/client.go index c67ff46..85c0201 100644 --- a/eth/client.go +++ b/eth/client.go @@ -12,6 +12,17 @@ import ( var errTODO = fmt.Errorf("TODO: Not implemented yet") +const ( + blocksPerDay = (3600 * 24) / 15 +) + +func max(x, y int64) int64 { + if x > y { + return x + } + return y +} + // ClientInterface is the eth Client interface used by hermez-node modules to // interact with Ethereum Blockchain and smart contracts. type ClientInterface interface { diff --git a/eth/rollup.go b/eth/rollup.go index 183d07a..9cdfe27 100644 --- a/eth/rollup.go +++ b/eth/rollup.go @@ -273,7 +273,7 @@ type RollupInterface interface { RollupConstants() (*common.RollupConstants, error) RollupEventsByBlock(blockNum int64, blockHash *ethCommon.Hash) (*RollupEvents, error) RollupForgeBatchArgs(ethCommon.Hash, uint16) (*RollupForgeBatchArgs, *ethCommon.Address, error) - RollupEventInit() (*RollupEventInitialize, int64, error) + RollupEventInit(genesisBlockNum int64) (*RollupEventInitialize, int64, error) } // @@ -749,12 +749,14 @@ var ( ) // RollupEventInit returns the initialize event with its corresponding block number -func (c *RollupClient) RollupEventInit() (*RollupEventInitialize, int64, error) { +func (c *RollupClient) RollupEventInit(genesisBlockNum int64) (*RollupEventInitialize, int64, error) { query := ethereum.FilterQuery{ Addresses: []ethCommon.Address{ c.address, }, - Topics: [][]ethCommon.Hash{{logHermezInitialize}}, + FromBlock: big.NewInt(max(0, genesisBlockNum-blocksPerDay)), + ToBlock: big.NewInt(genesisBlockNum), + Topics: [][]ethCommon.Hash{{logHermezInitialize}}, } logs, err := c.client.client.FilterLogs(context.Background(), query) if err != nil { diff --git a/eth/rollup_test.go b/eth/rollup_test.go index 8a16b94..9799933 100644 --- a/eth/rollup_test.go +++ b/eth/rollup_test.go @@ -56,7 +56,7 @@ func genKeysBjj(i int64) *keys { } func TestRollupEventInit(t *testing.T) { - rollupInit, blockNum, err := rollupClient.RollupEventInit() + rollupInit, blockNum, err := rollupClient.RollupEventInit(genesisBlock) require.NoError(t, err) assert.Equal(t, int64(19), blockNum) assert.Equal(t, uint8(10), rollupInit.ForgeL1L2BatchTimeout) diff --git a/eth/wdelayer.go b/eth/wdelayer.go index a583893..a2869f8 100644 --- a/eth/wdelayer.go +++ b/eth/wdelayer.go @@ -137,7 +137,7 @@ type WDelayerInterface interface { WDelayerEventsByBlock(blockNum int64, blockHash *ethCommon.Hash) (*WDelayerEvents, error) WDelayerConstants() (*common.WDelayerConstants, error) - WDelayerEventInit() (*WDelayerEventInitialize, int64, error) + WDelayerEventInit(genesisBlockNum int64) (*WDelayerEventInitialize, int64, error) } // @@ -415,12 +415,14 @@ var ( ) // WDelayerEventInit returns the initialize event with its corresponding block number -func (c *WDelayerClient) WDelayerEventInit() (*WDelayerEventInitialize, int64, error) { +func (c *WDelayerClient) WDelayerEventInit(genesisBlockNum int64) (*WDelayerEventInitialize, int64, error) { query := ethereum.FilterQuery{ Addresses: []ethCommon.Address{ c.address, }, - Topics: [][]ethCommon.Hash{{logWDelayerInitialize}}, + FromBlock: big.NewInt(max(0, genesisBlockNum-blocksPerDay)), + ToBlock: big.NewInt(genesisBlockNum), + Topics: [][]ethCommon.Hash{{logWDelayerInitialize}}, } logs, err := c.client.client.FilterLogs(context.Background(), query) if err != nil { diff --git a/eth/wdelayer_test.go b/eth/wdelayer_test.go index 54e1862..a04ab00 100644 --- a/eth/wdelayer_test.go +++ b/eth/wdelayer_test.go @@ -18,7 +18,7 @@ var maxEmergencyModeTime = time.Hour * 24 * 7 * 26 var maxWithdrawalDelay = time.Hour * 24 * 7 * 2 func TestWDelayerInit(t *testing.T) { - wDelayerInit, blockNum, err := wdelayerClientTest.WDelayerEventInit() + wDelayerInit, blockNum, err := wdelayerClientTest.WDelayerEventInit(genesisBlock) require.NoError(t, err) assert.Equal(t, int64(16), blockNum) assert.Equal(t, uint64(initWithdrawalDelay), wDelayerInit.InitialWithdrawalDelay) diff --git a/node/node.go b/node/node.go index 61bea3f..3445933 100644 --- a/node/node.go +++ b/node/node.go @@ -1,3 +1,18 @@ +/* +Package node does the initialization of all the required objects to either run +as a synchronizer or as a coordinator. + +The Node contains several goroutines that run in the background or that +periodically perform tasks. One of this goroutines periodically calls the +`Synchronizer.Sync` function, allowing the synchronization of one block at a +time. After every call to `Synchronizer.Sync`, the Node sends a message to the +Coordinator to notify it about the new synced block (and associated state) or +reorg (and resetted state) in case one happens. + +Other goroutines perform tasks such as: updating the token prices, update +metrics stored in the historyDB, update recommended fee stored in the +historyDB, run the http API server, run the debug http API server, etc. +*/ package node import ( diff --git a/synchronizer/synchronizer.go b/synchronizer/synchronizer.go index 3a7e009..b9fb5fe 100644 --- a/synchronizer/synchronizer.go +++ b/synchronizer/synchronizer.go @@ -1,3 +1,35 @@ +/* +Package synchronizer synchronizes the hermez network state by querying events +emitted by the three smart contracts: `Hermez.sol` (referred as Rollup here), +`HermezAuctionProtocol.sol` (referred as Auction here) and +`WithdrawalDelayer.sol` (referred as WDelayer here). + +The main entry point for synchronization is the `Sync` function, which at most +will synchronize one ethereum block, and all the hermez events that happened in +that block. During a `Sync` call, a reorg can be detected; in such case, uncle +blocks will be discarded, and only in a future `Sync` call correct blocks will +be synced. + +The synchronization of the events in each smart contracts are done +in the methods `rollupSync`, `auctionSync` and `wdelayerSync`, which in turn +use the interface code to read each smart contract state and events found in +"github.com/hermeznetwork/hermez-node/eth". After these three methods are +called, an object of type `common.BlockData` is built containing all the +updates and events that happened in that block, and it is inserted in the +HistoryDB in a single SQL transaction. + +`rollupSync` is the method that synchronizes batches sent via the `forgeBatch` +transaction in `Hermez.sol`. In `rollupSync`, for every batch, the accounts +state is updated in the StateDB by processing all transactions that have been +forged in that batch. + +The consistency of the stored data is guaranteed by the HistoryDB: All the +block information is inserted in a single SQL transaction at the end of the +`Sync` method, once the StateDB has been updated. And every time the +Synchronizer starts, it continues from the last block in the HistoryDB. The +StateDB stores updates organized by checkpoints for every batch, and each batch +is only accessed if it appears in the HistoryDB. +*/ package synchronizer import ( @@ -704,15 +736,15 @@ func (s *Synchronizer) reorg(uncleBlock *common.Block) (int64, error) { func getInitialVariables(ethClient eth.ClientInterface, consts *common.SCConsts) (*common.SCVariables, *StartBlockNums, error) { - rollupInit, rollupInitBlock, err := ethClient.RollupEventInit() + rollupInit, rollupInitBlock, err := ethClient.RollupEventInit(consts.Auction.GenesisBlockNum) if err != nil { return nil, nil, tracerr.Wrap(fmt.Errorf("RollupEventInit: %w", err)) } - auctionInit, auctionInitBlock, err := ethClient.AuctionEventInit() + auctionInit, auctionInitBlock, err := ethClient.AuctionEventInit(consts.Auction.GenesisBlockNum) if err != nil { return nil, nil, tracerr.Wrap(fmt.Errorf("AuctionEventInit: %w", err)) } - wDelayerInit, wDelayerInitBlock, err := ethClient.WDelayerEventInit() + wDelayerInit, wDelayerInitBlock, err := ethClient.WDelayerEventInit(consts.Auction.GenesisBlockNum) if err != nil { return nil, nil, tracerr.Wrap(fmt.Errorf("WDelayerEventInit: %w", err)) } diff --git a/test/ethclient.go b/test/ethclient.go index 650627e..d2d2762 100644 --- a/test/ethclient.go +++ b/test/ethclient.go @@ -1152,7 +1152,7 @@ func (c *Client) RollupEventsByBlock(blockNum int64, } // RollupEventInit returns the initialize event with its corresponding block number -func (c *Client) RollupEventInit() (*eth.RollupEventInitialize, int64, error) { +func (c *Client) RollupEventInit(genesisBlockNum int64) (*eth.RollupEventInitialize, int64, error) { vars := c.blocks[0].Rollup.Vars return ð.RollupEventInitialize{ ForgeL1L2BatchTimeout: uint8(vars.ForgeL1L2BatchTimeout), @@ -1628,7 +1628,7 @@ func (c *Client) AuctionEventsByBlock(blockNum int64, } // AuctionEventInit returns the initialize event with its corresponding block number -func (c *Client) AuctionEventInit() (*eth.AuctionEventInitialize, int64, error) { +func (c *Client) AuctionEventInit(genesisBlockNum int64) (*eth.AuctionEventInitialize, int64, error) { vars := c.blocks[0].Auction.Vars return ð.AuctionEventInitialize{ DonationAddress: vars.DonationAddress, @@ -1863,7 +1863,7 @@ func (c *Client) WDelayerConstants() (*common.WDelayerConstants, error) { } // WDelayerEventInit returns the initialize event with its corresponding block number -func (c *Client) WDelayerEventInit() (*eth.WDelayerEventInitialize, int64, error) { +func (c *Client) WDelayerEventInit(genesisBlockNum int64) (*eth.WDelayerEventInitialize, int64, error) { vars := c.blocks[0].WDelayer.Vars return ð.WDelayerEventInitialize{ InitialWithdrawalDelay: vars.WithdrawalDelay,