diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..4f4b989 --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,2 @@ +- 0.1.0 + * Factor out from eth-monitor diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/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/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..e705e7e --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include *requirements.txt diff --git a/eth_cache/account.py b/eth_cache/account.py deleted file mode 100644 index d6a96f7..0000000 --- a/eth_cache/account.py +++ /dev/null @@ -1,45 +0,0 @@ -# external imports -from hexathon import strip_0x - - -class AccountRegistry: - - def __init__(self): - self.senders = {} - self.recipients = {} - - - def __normalize_address(self, address): - return bytes.fromhex(strip_0x(address)) - - def add(self, address, label): - self.add_sender(address, label) - self.add_recipient(address, label) - - - def add_sender(self, address, label): - a = self.__normalize_address(address) - self.senders[a] = label - - - def add_recipient(self, address, label): - a = self.__normalize_address(address) - self.recipients[a] = label - - - def have(self, address): - if self.get_sender(address) != None: - return True - if self.get_recipient(address) != None: - return True - return False - - - def get_sender(self, address): - a = self.__normalize_address(address) - return self.senders.get(a) - - - def get_recipient(self, address): - a = self.__normalize_address(address) - return self.recipients.get(a) diff --git a/eth_cache/filter.py b/eth_cache/filter.py deleted file mode 100644 index e889a8d..0000000 --- a/eth_cache/filter.py +++ /dev/null @@ -1,7 +0,0 @@ -class GasFilter: - - def __init__(self, store): - - - def filter(self, conn, block, tx, session): - self.store.put() diff --git a/eth_cache/rpc.py b/eth_cache/rpc.py new file mode 100644 index 0000000..1e5f5b7 --- /dev/null +++ b/eth_cache/rpc.py @@ -0,0 +1,81 @@ +# standard imports +import json +import logging + +# external imports +from jsonrpc_std.parse import jsonrpc_from_dict +from hexathon import strip_0x + +logg = logging.getLogger(__name__) + +class CacheRPC: + + def __init__(self, rpc, store): + self.rpc = rpc + self.store = store + + + def do(self, o): + req = jsonrpc_from_dict(o) + r = None + if req['method'] == 'eth_getBlockByNumber': + block_number = req['params'][0] + v = int(strip_0x(block_number), 16) + try: + j = self.store.get_block_number(v) + r = json.loads(j) + logg.debug('using cached block {} -> {}'.format(v, r['hash'])) + except FileNotFoundError: + pass + elif req['method'] == 'eth_getBlockByHash': + block_hash = req['params'][0] + v = strip_0x(block_hash) + try: + j = self.store.get_block(v) + r = json.loads(j) + logg.debug('using cached block {}'.format(r['hash'])) + except FileNotFoundError as e: + logg.debug('not found {}'.format(e)) + pass + elif req['method'] == 'eth_getTransactionReceipt': + tx_hash = req['params'][0] + j = None + try: + tx_hash = strip_0x(tx_hash) + j = self.store.get_rcpt(tx_hash) + r = json.loads(j) + logg.debug('using cached rcpt {}'.format(tx_hash)) + except FileNotFoundError as e: + logg.debug('no file {}'.format(e)) + pass + +# elif req['method'] == 'eth_getTransactionByHash': +# raise ValueError(o) +# elif req['method'] == 'eth_getTransactionByBlockHashAndIndex': +# logg.debug('trying tx index {}'.format(o)) +# v = req['params'][0] +# j = None +# try: +# j = self.store.get_block(v) +# except FileNotFoundError: +# pass +# +# if j != None: +# o = json.loads(j) +# idx = int(req['params'][1], 16) +# v = r['transactions'][idx] +# j = None +# try: +# j = self.store.get_tx(v) +# except FileNotFoundError: +# pass +# +# if j != None: +# r = json.loads(j) +# logg.debug('using cached tx {} -> {}'.format(req['params'], r['hash'])) + + if r == None: + logg.debug('passthru {}'.format(o)) + r = self.rpc.do(o) + + return r diff --git a/eth_cache/runnable/get.py b/eth_cache/runnable/get.py deleted file mode 100644 index 4daf1d7..0000000 --- a/eth_cache/runnable/get.py +++ /dev/null @@ -1,93 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -# standard imports -import sys -import os -import argparse -import logging -import select - -# external imports -from chainlib.chain import ChainSpec -from chainlib.eth.connection import EthHTTPConnection -from chainlib.eth.tx import ( - pack, - receipt, - transaction, - Tx, - ) -from chainlib.eth.block import ( - Block, - block_by_hash, - ) -from hexathon import strip_0x - -# local imports -from eth_cache.store import ( - PointerHexDir, - TxFileStore, - ) - -logging.basicConfig(level=logging.WARNING) -logg = logging.getLogger() - -default_eth_provider = os.environ.get('ETH_PROVIDER', 'http://localhost:8545') -default_data_dir = os.path.realpath(os.path.join(os.environ.get('HOME', ''), '.eth_cache')) - -def stdin_arg(t=0): - h = select.select([sys.stdin], [], [], t) - if len(h[0]) > 0: - v = h[0][0].read() - return v.rstrip() - return None - - -argparser = argparse.ArgumentParser('eth-get', description='display information about an Ethereum address or transaction', epilog='address/transaction can be provided as an argument or from standard input') -argparser.add_argument('-p', '--provider', dest='p', default=default_eth_provider, type=str, help='Web3 provider url (http only)') -argparser.add_argument('-i', '--chain-spec', dest='i', type=str, default='evm:ethereum:1', help='Chain specification string') -argparser.add_argument('-v', action='store_true', help='Be verbose') -argparser.add_argument('-vv', action='store_true', help='Be more verbose') -argparser.add_argument('--data-dir', dest='data_dir', type=str, help='Be more verbose') -argparser.add_argument('tx_hash', nargs='?', default=stdin_arg(), type=str, help='Item to get information for (address og transaction)') -args = argparser.parse_args() - - -if args.vv: - logg.setLevel(logging.DEBUG) -elif args.v: - logg.setLevel(logging.INFO) - -tx_hash = args.tx_hash -if tx_hash == None: - tx_hash = stdin_arg(t=None) - if tx_hash == None: - argparser.error('need first positional argument or value from stdin') - -chain_spec = ChainSpec.from_chain_str(args.i) -data_dir = args.data_dir -if data_dir == None: - data_dir = os.path.join(default_data_dir, str(chain_spec)) -rpc_provider = args.p - -if __name__ == '__main__': - rpc = EthHTTPConnection(rpc_provider) - o = transaction(tx_hash) - r = rpc.do(o) - tx = Tx(r) - tx_raw = pack(tx.src, chain_spec) - - o = receipt(tx_hash) - r = rpc.do(o) - tx.apply_receipt(r) - - rcpt = Tx.src_normalize(r) - o = block_by_hash(rcpt['block_hash']) - r = rpc.do(o) - block = Block(r) - tx.apply_block(block) - - store_backend = PointerHexDir(data_dir, 32) - store_backend.register_pointer('address') - store = TxFileStore(chain_spec, store_backend) - #store_backend.add(bytes.fromhex(strip_0x(tx_hash)), tx_raw) - store.put(block, tx, []) diff --git a/eth_cache/store.py b/eth_cache/store.py deleted file mode 100644 index 14ebbd6..0000000 --- a/eth_cache/store.py +++ /dev/null @@ -1,70 +0,0 @@ -# standard imports -import logging -import os - -# external imports -from hexdir import HexDir -from chainlib.eth.tx import pack -from hexathon import strip_0x - -logg = logging.getLogger(__name__) - - -class PointerHexDir(HexDir): - - def __init__(self, root_path, key_length, levels=2, prefix_length=0): - super(PointerHexDir, self).__init__(root_path, key_length, levels, prefix_length) - self.pointers = {} - - - def register_pointer(self, label, dir_name=None): - if dir_name == None: - dir_name = label - pointer_dir = os.path.join(self.path, dir_name) - os.makedirs(pointer_dir, exist_ok=True) - - label_file = os.path.join(pointer_dir, '.label') - try: - os.stat(label_file) - except FileNotFoundError: - f = open(label_file, 'w') - f.write(label) - f.close() - - self.pointers[label] = pointer_dir - - - def add_pointer(self, pointer, pointer_relpath, destination_path): - if isinstance(pointer_relpath, list): - link_path = os.path.join(self.pointers[pointer], *pointer_relpath) - else: - link_path = os.path.join(self.pointers[pointer], pointer_relpath) - os.makedirs(os.path.dirname(link_path), exist_ok=True) - os.symlink(destination_path, link_path) - logg.debug('added link {} -> {}'.format(link_path, destination_path)) - - - def add(self, key, content, prefix=b'', pointers={}): - (c, entry_path) = super(PointerHexDir, self).add(key, content, prefix=prefix) - for k in pointers.keys(): - self.add_pointer(k, pointers[k], entry_path) - - -class TxFileStore: - - def __init__(self, chain_spec, backend): - self.backend = backend - self.chain_spec = chain_spec - - - def put(self, block, tx, addresses=[], attrs={}): - tx_src = tx.as_dict() - tx_raw = pack(tx_src, self.chain_spec) - - if len(addresses) == 0: - self.backend.add(bytes.fromhex(tx.hash), tx_raw, pointers={}) - return - - for address in addresses: - filename = '{}_{}_{}'.format(block.number, tx.index, strip_0x(tx.hash)) - self.backend.add(bytes.fromhex(tx.hash), tx_raw, pointers={'address': [strip_0x(address),filename]}) diff --git a/eth_cache/store/file.py b/eth_cache/store/file.py new file mode 100644 index 0000000..750d0b4 --- /dev/null +++ b/eth_cache/store/file.py @@ -0,0 +1,154 @@ +# standard imports +import os +import json +import logging + +# external imports +from hexathon import strip_0x +from chainlib.eth.tx import ( + Tx, + pack, + ) +from leveldir.numeric import NumDir +from leveldir.hex import HexDir + +logg = logging.getLogger(__name__) + +default_base_dir = '/var/lib' + + +def chain_dir_for(chain_spec, base_dir=default_base_dir): + chain_dir = os.path.join(base_dir, str(chain_spec).replace(':', '/')) + return os.path.join(chain_dir, 'eth_cache') + + +class FileStore: + + def put_tx(self, tx, include_data=False): + raw = pack(tx.src(), self.chain_spec) + tx_hash_dirnormal = strip_0x(tx.hash).upper() + tx_hash_bytes = bytes.fromhex(tx_hash_dirnormal) + self.tx_raw_dir.add(tx_hash_bytes, raw) + if self.address_rules != None: + for a in tx.outputs + tx.inputs: + if self.address_rules.apply_rules_addresses(a, a, tx.hash): + a_hex = strip_0x(a).upper() + a = bytes.fromhex(a_hex) + self.address_dir.add_dir(tx_hash_dirnormal, a, b'') + dirpath = self.address_dir.to_filepath(a_hex) + fp = os.path.join(dirpath, '.start') + num = tx.block.number + num_compare = 0 + try: + f = open(fp, 'rb') + r = f.read(8) + f.close() + num_compare = int.from_bytes(r, 'big') + except FileNotFoundError: + pass + + if num_compare == 0 or num < num_compare: + logg.debug('recoding new start block {} for {}'.format(num, a)) + num_bytes = num.to_bytes(8, 'big') + f = open(fp, 'wb') + f.write(num_bytes) + f.close() + + if include_data: + src = json.dumps(tx.src()).encode('utf-8') + self.tx_dir.add(bytes.fromhex(strip_0x(tx.hash)), src) + + rcpt_src = tx.rcpt_src() + logg.debug('rcpt {}'.format(rcpt_src)) + if rcpt_src != None: + rcpt_src = json.dumps(rcpt_src).encode('utf-8') + self.rcpt_dir.add(bytes.fromhex(strip_0x(tx.hash)), rcpt_src) + + + + def put_block(self, block, include_data=False): + hash_bytes = bytes.fromhex(strip_0x(block.hash)) + self.block_num_dir.add(block.number, hash_bytes) + num_bytes = block.number.to_bytes(8, 'big') + self.block_hash_dir.add(hash_bytes, num_bytes) + if include_data: + src = json.dumps(block.src()).encode('utf-8') + self.block_src_dir.add(hash_bytes, src) + + + def get_block_number(self, block_number): + fp = self.block_num_dir.to_filepath(block_number) + f = open(fp, 'rb') + r = f.read() + f.close() + return self.get_block(r.hex()) + + + def get_block(self, block_hash): + fp = self.block_src_dir.to_filepath(block_hash) + f = open(fp, 'rb') + r = f.read() + f.close() + return r + + + def get_tx(self, tx_hash): + fp = self.tx_dir.to_filepath(tx_hash) + f = open(fp, 'rb') + r = f.read() + f.close() + return r + + + def get_rcpt(self, tx_hash): + fp = self.rcpt_dir.to_filepath(tx_hash) + f = open(fp, 'rb') + r = f.read() + f.close() + return r + + + def get_address_tx(self, address): + fp = self.address_dir.to_filepath(address) + tx_hashes = [] + for tx_hash in os.listdir(fp): + if tx_hash[0] == '.': + continue + tx_hashes.append(tx_hash) + return tx_hashes + + + def __init__(self, chain_spec, cache_root=default_base_dir, address_rules=None): +# self.cache_root = os.path.join( +# cache_root, +# 'eth_cache', +# chain_spec.engine(), +# chain_spec.fork(), +# str(chain_spec.chain_id()), +# ) + #self.cache_root = os.path.realpath(self.cache_root) + #self.chain_dir = chain_dir_for(chain_spec, self.cache_root) + self.chain_dir = chain_dir_for(chain_spec, cache_root) + self.cache_dir = self.chain_dir + self.block_src_path = os.path.join(self.cache_dir, 'block', 'src') + self.block_src_dir = HexDir(self.block_src_path, 32, levels=2) + self.block_num_path = os.path.join(self.cache_dir, 'block', 'num') + self.block_num_dir = NumDir(self.block_num_path, [100000, 1000]) + self.block_hash_path = os.path.join(self.cache_dir, 'block', 'hash') + self.block_hash_dir = HexDir(self.block_hash_path, 32, levels=2) + self.tx_path = os.path.join(self.cache_dir, 'tx', 'src') + self.tx_raw_path = os.path.join(self.cache_dir, 'tx', 'raw') + self.tx_dir = HexDir(self.tx_path, 32, levels=2) + self.tx_raw_dir = HexDir(self.tx_raw_path, 32, levels=2) + self.rcpt_path = os.path.join(self.cache_dir, 'rcpt', 'src') + self.rcpt_raw_path = os.path.join(self.cache_dir, 'rcpt', 'raw') + self.rcpt_dir = HexDir(self.rcpt_path, 32, levels=2) + self.rcpt_raw_dir = HexDir(self.rcpt_raw_path, 32, levels=2) + self.address_path = os.path.join(self.cache_dir, 'address') + self.address_dir = HexDir(self.address_path, 20, levels=2) + self.chain_spec = chain_spec + self.address_rules = address_rules + + + def __str__(self): + return 'FileStore: root {}'.format(self.cache_root) diff --git a/eth_cache/store/null.py b/eth_cache/store/null.py new file mode 100644 index 0000000..ac9ced5 --- /dev/null +++ b/eth_cache/store/null.py @@ -0,0 +1,40 @@ +# standard imports +import os +import logging +import json + +logg = logging.getLogger(__name__) + + +class NullStore: + + def put_tx(self, tx, include_data=False): + pass + + + def put_block(self, block, include_data=False): + pass + + + def get_block_number(self, v): + raise FileNotFoundError(v) + + + def get_block(self, v): + raise FileNotFoundError(v) + + + def get_tx(self, v): + raise FileNotFoundError(v) + + + def get_rcpt(self, v): + raise FileNotFoundError(v) + + + def __init__(self): + self.chain_dir = '/dev/null' + + + def __str__(self): + return "Nullstore" diff --git a/examples/dump.py b/examples/dump.py deleted file mode 100644 index 13ddd51..0000000 --- a/examples/dump.py +++ /dev/null @@ -1,155 +0,0 @@ -# standard imports -import tempfile -import os -import logging -import sys - -# external imports -from chainlib.chain import ChainSpec -from chainlib.eth.connection import EthHTTPConnection -from chainlib.eth.block import ( - block_by_number, - block_by_hash, - block_latest, - Block, - ) -from chainlib.eth.tx import ( - Tx, - transaction, - receipt, - ) -from chainlib.interface import ChainInterface -from chainsyncer.backend.memory import MemBackend -from chainsyncer.driver.threadpool import ThreadPoolHistorySyncer -from chainsyncer.filter import SyncFilter - -# local imports -from eth_cache.account import AccountRegistry -from eth_cache.store import TxFileStore -from eth_cache.store import PointerHexDir - -logging.basicConfig(level=logging.INFO) -logg = logging.getLogger() -logging.getLogger('eth_cache.store').setLevel(logging.DEBUG) -#logging.getLogger('chainsyncer.filter').setLevel(logging.DEBUG) -logging.getLogger('chainsyncer.driver.threadpool').setLevel(logging.DEBUG) -#logging.getLogger('chainsyncer.driver.head').setLevel(logging.DEBUG) -#logging.getLogger('chainsyncer.backend.memory').setLevel(logging.DEBUG) - -root_dir = tempfile.mkdtemp(dir=os.path.join('/tmp/ethsync')) -data_dir = os.path.join(root_dir, 'store') -logg.info('using data dir {}'.format(data_dir)) - -chain_interface = ChainInterface() -chain_interface.set('block_by_number', block_by_number) -chain_interface.set('block_by_hash', block_by_hash) -chain_interface.set('block_latest', block_latest) -chain_interface.set('block_from_src', Block.from_src) -chain_interface.set('tx_from_src', Tx.from_src) -chain_interface.set('tx_by_hash', transaction) -chain_interface.set('tx_receipt', receipt) -chain_interface.set('src_normalize', Tx.src_normalize) - -chain_spec = ChainSpec('evm', 'ethereum', 1) -backend = PointerHexDir(data_dir, 32) -backend.register_pointer('address') -store = TxFileStore(chain_spec, backend) - -def conn_factory(): - return EthHTTPConnection('http://localhost:8545') - #return EthHTTPConnection('http://localhost:63545') -rpc = conn_factory() - -#start = 8534365 -start = 12423900 -#start = 0 - -#o = block_latest() -#r = rpc.do(o) -#stop = int(r, 16) -stop = start + 10 - -syncer_backend = MemBackend(chain_spec, None, target_block=stop) -syncer_backend.set(start, 0) - -#o = block_by_number(12423955, include_tx=False) -#r = rpc.do(o) -##o = block_by_hash(r) -##r = rpc.do(o) -#block = Block(r) -# -#tx_hash = block.txs[308] -#logg.debug('tx_ahsh {}'.format(tx_hash)) -#o = transaction(tx_hash) -#tx_src = rpc.do(o) -#o = receipt(tx_hash) -#rcpt = rpc.do(o) -#tx = Tx(tx_src, block=block) - -account_registry = AccountRegistry() -account_registry.add('0x6bd8cb96bbc58a73d5360301b7791457bc93da24', 'money') - - -def apply_one_async(fltr, idx, conn, block, tx, session): - logg.error('>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> apply async') - fltr.filter(conn, block, tx, session) - return (block.number, tx.index,) - - - - -class ThreadedSyncFilter(SyncFilter): - - def __init__(self, pool, backend): - super(ThreadedSyncFilter, self).__init__(backend) - self.pool = pool - - - def apply_one(self, fltr, idx, conn, block, tx, session): - logg.error('applyone  {} {}'.format(fltr, self.pool)) - #self.pool.apply_async(apply_one_async, (fltr, idx, conn, block, tx, session, self.backend.complete_filter,)) - self.pool.apply(fltr, (idx, conn, block, tx, session,), {}, self.backend.complete_filter) - logg.debug('applyone end') - - -class StoreFilter: - - def __init__(self, store, registry): - self.registry = registry - self.store = store - - - def filter(self, conn, block, tx, session=None): - addresses = [] - if account_registry.have(tx.inputs[0]): - addresses.append(tx.inputs[0]) - if account_registry.have(tx.outputs[0]): - addresses.append(tx.outputs[0]) - store.put(block, tx, addresses) - - -class MonitorFilter: - - def __init__(self, name='sync'): - self.name = name - - - def filter(self, rpc, block, tx, session=None): - logg.error('foozzzzzzzzzz') - logg.debug('foo') - if tx == None: - s = '{} sync block error in tx lookup ({})'.format(self.name, block.number, len(block.txs)) - else: - s = '{} sync block {} tx {}/{}'.format(self.name, block.number, tx.index, len(block.txs)) - sys.stdout.write('{:<100s}\r'.format(s)) - - -fltr = StoreFilter(store, account_registry) - -if __name__ == '__main__': - ThreadPoolHistorySyncer.yield_delay = 0 - syncer = ThreadPoolHistorySyncer(conn_factory, 2, syncer_backend, chain_interface) - syncer.add_filter(MonitorFilter()) - syncer.add_filter(fltr) - syncer.filter = ThreadedSyncFilter(syncer.worker_pool, syncer_backend) - syncer.loop(0, rpc) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..47f99c0 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +hexathon~=0.1.5 +jsonrpc-std~=0.1.0 +leveldir~=0.3.0 +chainlib-eth>=0.1.0b3,<=0.1.0 diff --git a/run_tests.sh b/run_tests.sh new file mode 100644 index 0000000..b8e4beb --- /dev/null +++ b/run_tests.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +set -a +set -e +set -x +default_pythonpath=$PYTHONPATH:. +export PYTHONPATH=${default_pythonpath:-.} +>&2 echo using pythonpath $PYTHONPATH +for f in `ls tests/*.py`; do + python $f +done +set +x +set +e +set +a diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..21a04fb --- /dev/null +++ b/setup.cfg @@ -0,0 +1,36 @@ +[metadata] +name = eth-cache +version = 0.1.0 +description = Ethereum chain data caching tools +author = Louis Holbrook +author_email = dev@holbrook.no +url = https://git.defalsify.org/eth-monitor +keywords = + dlt + blockchain + cryptocurrency + ethereum +classifiers = + Programming Language :: Python :: 3 + Operating System :: OS Independent + Development Status :: 3 - Alpha + Topic :: Software Development :: Libraries + Environment :: Console + Intended Audience :: Developers + License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) + Topic :: Internet +# Topic :: Blockchain :: EVM +license = GPL3 +licence_files = + LICENSE + +[options] +include_package_data = True +python_requires = >= 3.7 +packages = + eth_cache + eth_cache.store + +[options.entry_points] +console_scripts = + eth-cache-list = eth_cache.runnable.list:main diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..c481db7 --- /dev/null +++ b/setup.py @@ -0,0 +1,28 @@ +from setuptools import setup +import configparser +import os + + +requirements = [] +f = open('requirements.txt', 'r') +while True: + l = f.readline() + if l == '': + break + requirements.append(l.rstrip()) +f.close() + +test_requirements = [] +f = open('test_requirements.txt', 'r') +while True: + l = f.readline() + if l == '': + break + test_requirements.append(l.rstrip()) +f.close() + + +setup( + install_requires=requirements, + tests_require=test_requirements, + ) diff --git a/test_requirements.txt b/test_requirements.txt new file mode 100644 index 0000000..0783771 --- /dev/null +++ b/test_requirements.txt @@ -0,0 +1,5 @@ +eth_tester==0.5.0b3 +py-evm==0.3.0a20 +rlp==2.0.1 +pytest==6.0.1 +coverage==5.5 diff --git a/tests/test_basic.py b/tests/test_basic.py new file mode 100644 index 0000000..72381b6 --- /dev/null +++ b/tests/test_basic.py @@ -0,0 +1,86 @@ +# standard imports +import tempfile +import shutil +import unittest +import logging +import json + +# external imports +from chainlib.chain import ChainSpec +from chainlib.eth.gas import ( + Gas, + OverrideGasOracle, + ) +from chainlib.eth.nonce import RPCNonceOracle +from chainlib.eth.unittest.ethtester import EthTesterCase +from chainlib.eth.tx import ( + transaction, + receipt, + TxFormat, + Tx, + ) +from chainlib.eth.block import ( + block_by_hash, + Block, + ) +from chainlib.eth.address import is_same_address +from hexathon import strip_0x + +# local imports +from eth_cache.store.file import FileStore + +logging.basicConfig(level=logging.DEBUG) +logg = logging.getLogger() + + +class TestCache(EthTesterCase): + + def setUp(self): + super(TestCache, self).setUp() + fp = tempfile.mkdtemp() + self.cache_dir = fp + self.store = FileStore(self.chain_spec, cache_root=self.cache_dir) + nonce_oracle = RPCNonceOracle(self.accounts[0], self.rpc) + gas_oracle = OverrideGasOracle(price=100000000000, limit=30000) + c = Gas(self.chain_spec, signer=self.signer, nonce_oracle=nonce_oracle, gas_oracle=gas_oracle) + (tx_hash, o) = c.create(self.accounts[0], self.accounts[1], 1024) + r = self.rpc.do(o) + + o = transaction(tx_hash) + tx_src = self.rpc.do(o) + + o = receipt(tx_hash) + rcpt_src = self.rpc.do(o) + + o = block_by_hash(tx_src['block_hash']) + block_src = self.rpc.do(o) + + self.block = Block(block_src) + self.tx = Tx(tx_src, block=self.block, rcpt=rcpt_src) + + + def tearDown(self): + shutil.rmtree(self.cache_dir) + + + def test_tx(self): + logg.debug('tx {}'.format(self.tx)) + self.store.put_tx(self.tx, include_data=True) + j = self.store.get_tx(self.tx.hash) + tx = json.loads(j) + self.assertTrue(is_same_address(tx['hash'], self.tx.hash)) + + + def test_block(self): + logg.debug('tx {}'.format(self.tx)) + self.store.put_block(self.block, include_data=True) + block_hash = strip_0x(self.block.hash) + j = self.store.get_block(block_hash) + block = json.loads(j) + retrieved_block_hash = strip_0x(block['hash']) + self.assertEqual(retrieved_block_hash, block_hash) + + +if __name__ == '__main__': + unittest.main() +