electrum-obelisk

Electrum server using libbitcoin as its backend
git clone https://git.parazyd.org/electrum-obelisk
Log | Files | Refs | README | LICENSE

commit 091685a9e22b3c6b5f910355be90674f8478b9c1
Author: parazyd <parazyd@dyne.org>
Date:   Fri, 19 Feb 2021 00:08:51 +0100

First commit.

Diffstat:
A.gitignore | 2++
ALICENSE | 661+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
AREADME.md | 91+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Acerts/cert.crt | 19+++++++++++++++++++
Acerts/cert.key | 27+++++++++++++++++++++++++++
Aconfig.ini | 27+++++++++++++++++++++++++++
Aelectrumobelisk/__init__.py | 0
Aelectrumobelisk/bx.py | 66++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Aelectrumobelisk/hash.py | 39+++++++++++++++++++++++++++++++++++++++
Aelectrumobelisk/helpers.py | 74++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Aelectrumobelisk/merkle.py | 80+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Aelectrumobelisk/protocol.py | 340+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Aelectrumobelisk/query.py | 78++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Aobelisk | 232+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Ares/obelisk.png | 0
15 files changed, 1736 insertions(+), 0 deletions(-)

diff --git a/.gitignore b/.gitignore @@ -0,0 +1 @@ +*.pyc+ \ No newline at end of file diff --git a/LICENSE b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <http://www.gnu.org/licenses/>. + +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 +<http://www.gnu.org/licenses/>. diff --git a/README.md b/README.md @@ -0,0 +1,91 @@ +electrum-obelisk +================ + +![electrum-obelisk](res/obelisk.png) + +A **work-in-progress** implementation of an Electrum server using +[libbitcoin](https://libbitcoin.info) as a backend. + +TODO +---- + +* Better (and more) error handling +* More testing +* git grep -E "TODO:|BUG:" + + +Usage +----- + +Install `bx` and `bs` + +* https://github.com/libbitcoin/libbitcoin-explorer/ +* https://github.com/libbitcoin/libbitcoin-server/ + +Configure them per your needs and sync the node. Following this, +configure `config.ini` to use with obelisk. + +Now you can run `./obelisk config.ini` to start the server. + +Connect Electrum with: + +``` +electrum --oneserver --server 127.0.0.1:50002:s +``` + +Talk +---- + +`#libbitcoin` on freenode. + + +License +------- + +electrum-obelisk is licensed [AGPL-3](LICENSE.md). + +``` +electrum-obelisk +Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org> + +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 <http://www.gnu.org/licenses/>. +``` + +This software is heavily inspired by, and certain parts of the code +are copied from Chris Belcher's implementation of +[electrum-personal-server](https://github.com/chris-belcher/electrum-personal-server] +and are copyrighted under the MIT license: + +``` +The MIT License (MIT) + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +``` diff --git a/certs/cert.crt b/certs/cert.crt @@ -0,0 +1,19 @@ +-----BEGIN CERTIFICATE----- +MIIDBjCCAe4CCQDRr9lL8wL3+jANBgkqhkiG9w0BAQsFADBFMQswCQYDVQQGEwJB +VTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0 +cyBQdHkgTHRkMB4XDTE4MDMxMzAwMDc1OFoXDTIzMDMxMjAwMDc1OFowRTELMAkG +A1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0 +IFdpZGdpdHMgUHR5IEx0ZDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB +ALvqB0SrsncAhIkvmkLhhE4GW0MKGQognd1Vm67gnOZ4rC2+HwF3xS1xpJDZIjRJ +Tump6bp4dFoyty2vsrWJzzBib3xPh6yx37cqkQkLS7mlvl5J+VaV3vefW9Jt84Me +hT2xH62haZ6gyAI2OItyoC57uiKGJ/4TNcXZRchc3Ee1R29q5evMjJRBG6QLfHmc +btsSquPwIoGxaTICNZmmZlHKct+6bBGGbJ1tJttWCeLQe//rW9KBs+Ip3heNxZpQ +RZgPYwxFhZg4g4nv0CmIeMCC8KBZE82P4SRjMirVZD0YH/nNYQTEGwutZZ8F0K8Z +pWR1/HDXLQVeF66SreRxp98CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEATELegjEF +03r1SWSsJ2Jhg4gLDLi3tORqHFzu3S8JECi57geZKmF7NmhJHXd0vemusX9P8IRh +A0B9mEU8e92k2fenqxj/t71rm+e71PBU2GwXsE5vtkX/AGmsk6KhAsbe56A3IUGK +JvS3HZ2JS9MmwoUI3cHB5ExBisk4YkDripA6cIkF4i9ctQbk3bzN7FhCbj9wrKBR +Lg48tbswQw4UUUZ70U5uW3pt9pPbDErSifBv6UMoY8A2s4RqiyXDyI/cxVFsY71A +c+tInksyG4KAeDo919/Y0bNjgzOCt267ApQE96j4lnGCx/KSwduWBNMng6qeTecx +ZOyPoABtFZcv1g== +-----END CERTIFICATE----- diff --git a/certs/cert.key b/certs/cert.key @@ -0,0 +1,27 @@ +-----BEGIN RSA PRIVATE KEY----- +MIIEogIBAAKCAQEAu+oHRKuydwCEiS+aQuGETgZbQwoZCiCd3VWbruCc5nisLb4f +AXfFLXGkkNkiNElO6anpunh0WjK3La+ytYnPMGJvfE+HrLHftyqRCQtLuaW+Xkn5 +VpXe959b0m3zgx6FPbEfraFpnqDIAjY4i3KgLnu6IoYn/hM1xdlFyFzcR7VHb2rl +68yMlEEbpAt8eZxu2xKq4/AigbFpMgI1maZmUcpy37psEYZsnW0m21YJ4tB7/+tb +0oGz4ineF43FmlBFmA9jDEWFmDiDie/QKYh4wILwoFkTzY/hJGMyKtVkPRgf+c1h +BMQbC61lnwXQrxmlZHX8cNctBV4XrpKt5HGn3wIDAQABAoIBAHjQSuH8nZ3i6FMn +Fr+/LAfaEFy2pkiblcNSoeg6IsYOeWxjWp3f+hZwhQRXhaUmKKUUB+BKR0wiZSDr +YDNVKa8K6nB61VjTd2jU5jBxYbs284C9gKAJdTOw8iEFbdU0DygNs7c3GqfQ6SZ6 +47nL9W5NP+uoYxf4E89jFHlwMnOq3n2vW3TUIys0Op3RG40VqKEhU/XsOIjU5B7C +HN2wMKMol3N62t8rbX/J7PaWxR3O017kim1Xz0fSbYA+nHk6SvA2rXMdShACcBRz +t/DK4TzjwUL3a7P8Lvw8cfe0C6pBQD1sAcUxw4CQBcCs/PMCModJWoUmCflZZTqe ++WdDA9kCgYEA8yvQyVhK4xMAWzCzaRjBNpFpFJAX6XAHjMmhnOCLNe2m7SQdi5p4 +/j65P9pjRv+nD07cv/7mrYAWXFXkLgz3WWObR4A5eWjA0gnyIHJGNa9NQ7vCWu6g +aQpI+hnnwShakxuQ7w9w1WKAXh0rvnWO4hOxHlr5ve7UpEN18s7uzQMCgYEAxdPu +b38Qb2tGUXWQOBYsJNvhdwevO8EPggP044ENJvQW0gmJuVsF/Yrua0TNrUv+ETYd +mgK6MhNlxR6v3STwDg/OpM+MvgBafKRX2PeBJTf6k3Yx7ykxhLNPmuL6RCVv3ou9 +F064UzzyM9ApyWna7b0+1R1XPS+VttWZliLefPUCgYAb0iV/A7T9qczeogHEwmpI +nfZRvfKeaIzUlLUCx8Xlk50HgJxIvpGdNPvozEmTc+hfHfyvkrA9pWvpgIIsqpsa +BQVc9tSciVmWLkEfaTOTLM1ANJkV4jtECUM0KgaT2NQUBJFeaHvWTgC1w8yfa7+/ +KdWXzXzJOCvn5zf1Yat8lQKBgGgsfP+rqqzxkZrtzJ8sVdynCSiUHFvcA12U1c1D +tPhRSv8Z1LON0i68jWZhWemq/cR0ecwTKZebDVlrGnLas6rD+i5huRyItR2zsSro +0tIVk1c5w3vMdm4Jup62bdGa4TkQ3uc6Jeh3TJeqQ4bzvjy5DjBNfhYTS8R24KTm +AcFNAoGAPF4fOuTeFwy+a+LZ5ZTSHTiQ5YZYmnu27mM4YS0KjWCs2UKYKr47tOhf +96kuaN6zcE7gqawMTDGW+77DxTwKpbIEvKRb03PfqGnD8SHQmAQCjLOlnhW816n/ ++AtLlzWB7dBtgO/cW9lFIzyPCVlXRcbsn3RKS5HnLgIkuXn/kZI= +-----END RSA PRIVATE KEY----- diff --git a/config.ini b/config.ini @@ -0,0 +1,27 @@ +# Configuration file for electrum-obelisk + +[electrum-obelisk] +# 0.0.0.0 to bind to any IP, 127.0.0.1 to bind to localhost +host = 127.0.0.1 +port = 50002 + +# Which chain should electrum-obelisk be using (mainnet/regtest/testnet) +chain = mainnet + +# Endpoints served by bs. +bs_query = tcp://localhost:9091 +bs_heartbeat = tcp://localhost:9092 +bs_block = tcp://localhost:9093 +bs_transaction = tcp://localhost:9094 + +# Space-separated whitelist of IP addresses +# Accepts CIDR notation, e.g. 192.169.0.0/16 or 2a01:4f8:1f1::/120 +# Star (*) means all are accepted (Generally requires host to be 0.0.0.0) +ip_whitelist = * + +# TLS certificate +# Uses the default one, which is fine because by default nobody should be +# allowed to connect to your server or scan your packets. +# To generate another certificate use openssl. +certfile = certs/cert.crt +keyfile = certs/cert.key diff --git a/electrumobelisk/__init__.py b/electrumobelisk/__init__.py diff --git a/electrumobelisk/bx.py b/electrumobelisk/bx.py @@ -0,0 +1,66 @@ +#!/usr/bin/env python3 +# electrum-obelisk +# Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org> +# +# 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 <http://www.gnu.org/licenses/>. +""" Module for interfacing with the bx/bs command """ +import sys +from subprocess import run, CalledProcessError +from logging import getLogger +from json import loads +from json.decoder import JSONDecodeError + + +def bx_json(args): + """ Get JSON data using bx """ + cmd = ['bx', args[0], '--format', 'json'] + cmd.extend(args[1:]) + try: + output = run(cmd, check=True, capture_output=True) + except CalledProcessError: + log = getLogger('electrum-obelisk') + log.warning('bx_json (%s) failed', cmd) + return None + try: + return loads(output.stdout) + except JSONDecodeError: + return None + + +def bx_raw(args): + """ Get raw data using bx """ + cmd = ['bx'] + cmd.extend(args) + try: + output = run(cmd, check=True, capture_output=True) + except CalledProcessError: + log = getLogger('electrum-obelisk') + log.warning('bx_raw (%s) failed', cmd) + return None + if output.stdout: + return output.stdout[:-1] + return None + + +def bs_version(): + """ Get output of bs -v """ + try: + output = run(['bs', '-v'], capture_output=True, check=False) + return output.stdout.decode()[:-1] + except FileNotFoundError: + log = getLogger('electrum-obelisk') + log.error('Error: bs is not installed.') + # TODO: Reenable this + #sys.exit(1) + return "" diff --git a/electrumobelisk/hash.py b/electrumobelisk/hash.py @@ -0,0 +1,39 @@ +#!/usr/bin/env python3 +# electrum-obelisk +# Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org> +# Copyright (C) 2016-2018 Neil Booth (MIT License) +# +# 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 <http://www.gnu.org/licenses/>. +""" Cryptographic hash functions and helpers """ +import hashlib + + +_sha256 = hashlib.sha256 + + +def sha256(inp): + """ Simple wrapper of hashlib sha256. """ + return _sha256(inp).digest() + + +def double_sha256(inp): + """ sha256 of sha256, as used extensively in bitcoin """ + return sha256(sha256(inp)) + + +def hash_to_hex_str(inp): + """ Convert a big-endian binary hash to displayed hex string. + Display form of a binary hash is reversed and converted to hex. + """ + return bytes(reversed(inp)).hex() diff --git a/electrumobelisk/helpers.py b/electrumobelisk/helpers.py @@ -0,0 +1,74 @@ +#!/usr/bin/env python3 +# electrum-obelisk +# Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org> +# Copyright (c) 2018-2020 Chris Belcher (MIT License) +# +# 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 <http://www.gnu.org/licenses/>. +""" Useful helper functions """ +from binascii import hexlify + +code_strings = { + 2: '01', + 10: '0123456789', + 16: '0123456789abcdef', + 32: 'abcdefghijklmnopqrstuvwxyz234567', + 58: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz', + 256: ''.join([chr(x) for x in range(256)]), +} + + +def get_code_string(base): + """ Get valid characters for base """ + if base in code_strings: + return code_strings[base] + raise ValueError('Invalid base!') + + +def encode(val, base, minlen=0): + """ Encoding for serialization """ + base, minlen = int(base), int(minlen) + code_string = get_code_string(base) + result_bytes = bytes() + while val > 0: + curcode = code_string[val % base] + result_bytes = bytes([ord(curcode)]) + result_bytes + val //= base + + pad_size = minlen - len(result_bytes) + + padding_element = b'\x00' if base == 256 else b'1' \ + if base == 58 else b'0' + if pad_size > 0: + result_bytes = padding_element * pad_size + result_bytes + + result_string = ''.join([chr(y) for y in result_bytes]) + result = result_bytes if base == 256 else result_string + return result + + +def safe_hexlify(_str): + """ hexlify and return a string """ + return str(hexlify(_str), 'utf-8') + + +def num_to_var_int(num): + """ number to bytes """ + num = int(num) + if num < 253: + return bytes([num]) + if num < 65536: + return bytes([253]) + encode(num, 256, 2)[::-1] + if num < 4294967296: + return bytes([254]) + encode(num, 256, 4)[::-1] + return bytes([255]) + encode(num, 256, 8)[::-1] diff --git a/electrumobelisk/merkle.py b/electrumobelisk/merkle.py @@ -0,0 +1,80 @@ +#!/usr/bin/env python3 +# electrum-obelisk +# Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org> +# Copyright (C) 2018 Neil Booth (MIT License) +# +# 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 <http://www.gnu.org/licenses/>. +""" Merkle trees, branches, proofs and roots """ +from binascii import unhexlify +from math import ceil, log + +from electrumobelisk.bx import bx_json +from electrumobelisk.hash import double_sha256, hash_to_hex_str + + +def branch_length(hash_count): + """ Return the length of a merkle branch given the number of hashes """ + return ceil(log(hash_count, 2)) + + +def merkle_branch_and_root(hashes, index): + """ Return a (merkle branch, merkle_root) pair given hashes, and the + index of one of those hashes. """ + hashes = list(hashes) + if not isinstance(index, int): + raise TypeError('index must be an integer') + # This also asserts hashes is not empty + if not 0 <= index < len(hashes): + raise ValueError('index out of range') + length = branch_length(len(hashes)) + + branch = [] + for _ in range(length): + if len(hashes) & 1: + hashes.append(hashes[-1]) + branch.append(hashes[index ^ 1]) + index >>= 1 + hashes = [double_sha256(hashes[n] + hashes[n+1]) + for n in range(0, len(hashes), 2)] + return branch, hashes[0] + +def _merkle_branch(tx_hashes, tx_pos): + branch, _root = merkle_branch_and_root(tx_hashes, tx_pos) + branch = [hash_to_hex_str(hash) for hash in branch] + return branch + +def merkle_branch_for_tx_hash(height, tx_hash): + """ Return merkle branch and tx_position for given height/tx_hash """ + metadata = bx_json(['fetch-tx-index', tx_hash]) + if not metadata: + return None, None + tx_pos = int(metadata['metadata']['index']) + block = bx_json(['fetch-block', '--height', str(height)]) + if not block: + return None, None + #tx_hashes = [i['hash'] for i in block['block']['transactions']] + tx_hashes = [unhexlify(i['hash'])[::-1] + for i in block['block']['transactions']] + return _merkle_branch(tx_hashes, tx_pos), tx_pos + + +def merkle_branch_for_tx_pos(height, tx_pos): + """ Return merkle branch for given height/tx_pos """ + block = bx_json(['fetch-block', '--height', str(height)]) + if not block: + return None, None + txid = block['block']['transactions'][tx_pos] + tx_hashes = [reversed(unhexlify(i['hash'])) + for i in block['block']['transactions']] + return _merkle_branch(tx_hashes, tx_pos), txid diff --git a/electrumobelisk/protocol.py b/electrumobelisk/protocol.py @@ -0,0 +1,340 @@ +#!/usr/bin/env python3 +# electrum-obelisk +# Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org> +# Copyright (C) 2018-2020 Chris Belcher (MIT License) +# +# 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 <http://www.gnu.org/licenses/>. +""" non-strict electrum protocol implementation """ +from struct import unpack +from binascii import unhexlify +from threading import Thread + +import zmq + +from electrumobelisk.bx import bx_json, bx_raw, bs_version +from electrumobelisk.hash import sha256 +from electrumobelisk.helpers import safe_hexlify +from electrumobelisk.merkle import (merkle_branch_for_tx_hash, + merkle_branch_for_tx_pos) +from electrumobelisk.query import (q_fetch_header_by_height, + q_fetch_headers_by_height_count, + q_fetch_tx_by_txid) + + +VERSION = '0.0' +SERVER_PROTO_MIN = '1.4' +SERVER_PROTO_MAX = '1.4.2' +DONATION_ADDR = 'bc1q7an9p5pz6pjwjk4r48zke2yfaevafzpglg26mz' +__certfile__ = 'certs/cert.crt' +__keyfile__ = 'certs/cert.key' + +BANNER = """ +Welcome to electrum-obelisk + +"Tools for The People" +%s +electrum-obelisk version: %s + +electrum-obelisk is a server that uses libbitcoin-server as its backend. +Source code can be found at: https://github.com/parazyd/electrum-obelisk + +Please consider donating: %s + +""" % (bs_version(), VERSION, DONATION_ADDR) + + +def fetch_scripthash_history(scripthash): + """ Fetch transaction history for given scripthash and return a list """ + # BUG: fetch-history sometimes returns duplicates, so below in the + # loop it is necessary to check if we have already added the element. + hist = [] + data = bx_json(['fetch-history', scripthash]) + for i in data['transfers']: + # print(data) + if 'received' in i: + entr = {'height': int(i['received']['height']), + 'tx_hash': i['received']['hash']} + if entr not in hist: + hist.append(entr) + if 'spent' in i: + entr = {'height': int(i['spent']['height']), + 'tx_hash': i['spent']['hash']} + if entr not in hist: + hist.append(entr) + return hist + + +def electrum_scripthash_status(hist): + """ Encode scripthash status into the protocol format """ + if len(hist) < 1: + return None + ret = "" + for i in hist: + ret += '%s:%d:' % (i['tx_hash'], i['height']) + return safe_hexlify(sha256(bytes(ret.encode('ascii')))) + + +class ElectrumProtocol(): + """ + Class which implements the Electrum protocol for a single connection. + It does not handle the actual sockets, which could be any combination + if blocking/non-blocking, asyncio, twisted, etc. + This class may be instantized multiple times if the server accepts + multiple client connections at once. + """ + def __init__(self, log, chain, endpoints): + self.log = log + self.send_reply_fun = None + self.version_called = False + self.subscribed_to_headers = False + self.subscribed_scripthash = {} + self.endpoints = endpoints + + if chain == 'mainnet': + self.genesis = \ + '000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f' + elif chain == 'regtest': + self.genesis = \ + '0f9188f13cb7b2c71f2a335e3a4fc328bf5beb436012afca590b1a11466e2206' + elif chain == 'testnet': + self.genesis = \ + '000000000933ea01ad0ee984209779baaec3ced90fa3f408719526f8d77f4943' + else: + raise ValueError('Invalid chain "%s"' % chain) + + def _send_response(self, query, result): + response = {'jsonrpc': '2.0', 'result': result, 'id': query['id']} + self.send_reply_fun(response) + + def _send_update(self, update): + update['jsonrpc'] = '2.0' + self.send_reply_fun(update) + + def _send_error(self, nid, error): + payload = {'error': error, 'jsonrpc': '2.0', 'id': nid} + self.send_reply_fun(payload) + + def set_send_reply_fun(self, send_reply_fun): + """ Function to set a reply function """ + self.send_reply_fun = send_reply_fun + + def on_disconnect(self): + """ Used to clean up when client is disconnected """ + self.log.debug('on_disconnect') + self.subscribed_to_headers = False + self.version_called = False + self.subscribed_scripthash = {} + + def _subscribe_to_blocks(self): + if not self.subscribed_to_headers: + context = zmq.Context() + socket = context.socket(zmq.SUB) # pylint: disable=E1101 + socket.connect(self.endpoints['query']) + socket.setsockopt_string(zmq.SUBSCRIBE, '') # pylint: disable=E1101 + socket.setsockopt(zmq.TCP_KEEPALIVE, 1) # pylint: disable=E1101 + self.subscribed_to_headers = True + while self.subscribed_to_headers: + _ = unpack('<H', socket.recv())[0] + height = unpack('<I', socket.recv())[0] + block = socket.recv() + header = {'hex': safe_hexlify(block), 'height': int(height)} + update = {'method': 'blockchain.headers.subscribe', + 'params': header} + self._send_update(update) + + def _subscribe_to_scripthash(self, scripthash): + # TODO: subscribe_to_scripthash() + # Append to hist list from self.subscribed_scripthash and send + # update notification/method. + return + +# https://electrumx-spesmilo.readthedocs.io/en/latest/protocol-methods.html + def handle_query(self, query): + """ Electrum protocol method handlers """ + if 'method' not in query: + raise IOError('Bad client query, no "method"') + method = query['method'] + + if method == 'blockchain.block.header': + # TODO: cp_height + height = int(query['params'][0]) + header = q_fetch_header_by_height(self.endpoints['query'], height) + if not header: + error = {'message': 'block at height %d not found' % height} + self._send_error(query['id'], error) + return + self._send_response(query, safe_hexlify(header)) + + elif method == 'blockchain.block.headers': + # TODO: cp_height + # Electrum doesn't allow max_chunk_size to be less than 2016. + # gopher://bitreich.org/9/memecache/convenience-store.mkv + max_chunk_size = 2016 + start_height = query['params'][0] + count = int(query['params'][1]) + count = min(count, max_chunk_size) + headers = q_fetch_headers_by_height_count(self.endpoints['query'], + start_height, count) + self._send_response(query, {'hex': safe_hexlify(headers), + 'count': len(headers)//80, + 'max': max_chunk_size}) + + elif method == 'blockchain.estimatefee': + self._send_response(query, -1) + + elif method == 'blockchain.headers.subscribe': + if not self.subscribed_to_headers: + Thread(target=self._subscribe_to_blocks).start() + height = int(bx_raw(['fetch-height'])) + header = q_fetch_header_by_height(self.endpoints['query'], height) + self._send_response(query, {'height': height, + 'hex': safe_hexlify(header)}) + + elif method == 'blockchain.relayfee': + self._send_response(query, 0.00001) + + elif method == 'blockchain.scripthash.get_balance': + self._send_error(query['id'], {'message': 'Not implemented'}) + + elif method == 'blockchain.scripthash.get_history': + # BUG: Either in Electrum or libbitcoin scripthash is reversed + scripthash = safe_hexlify(unhexlify(query['params'][0])[::-1]) + hist = fetch_scripthash_history(scripthash) + self._send_response(query, hist) + + elif method == 'blockchain.scripthash.get_mempool': + # TODO: blockchain.scripthash.get_mempool + self._send_error(query['id'], {'message': 'Not implemented'}) + + elif method == 'blockchain.scripthash.list_unspent': + # TODO: blockchain.scripthash.list_unspent + self._send_error(query['id'], {'message': 'Not implemented'}) + + elif method == 'blockchain.scripthash.subscribe': + # BUG: Either in Electrum or libbitcoin scripthash is reversed + scripthash = safe_hexlify(unhexlify(query['params'][0])[::-1]) + hist = fetch_scripthash_history(scripthash) + self.subscribed_scripthash[scripthash] = (True, hist) + # TODO: Thread for watching + self._send_response(query, electrum_scripthash_status(hist)) + + elif method == 'blockchain.scripthash.unsubscribe': + scripthash = query['params'][0] + if self.subscribed_scripthash.get(scripthash) is True: + self.subscribed_scripthash[scripthash] = False + self._send_response(query, True) + return + self._send_response(query, False) + + elif method == 'blockchain.transaction.broadcast': + txhex = query['params'][0] + _tx = bx_json(['decode-tx', txhex])['transaction'] + self.log.info('Broadcasting txid %s', _tx['hash']) + bx_raw(['broadcast-tx', txhex]) + self._send_response(query, _tx['hash']) + + elif method == 'blockchain.transaction.get': + txid = query['params'][0] + verbose = query['params'][1] if len(query['params']) > 1 else False + rawtx = q_fetch_tx_by_txid(self.endpoints['query'], txid) + if not rawtx: + error = {'message': 'txid %s not found' % txid} + self._send_error(query['id'], error) + return + _tx = safe_hexlify(rawtx) + if not verbose: + self._send_response(query, _tx) + return + # TODO: Implement with verbose=true + error = {'message': 'Not implemented with verbose=True'} + self._send_error(query['id'], error) + + elif method == 'blockchain.transaction.get_merkle': + txid = query['params'][0] + height = query['params'][1] + branch, tx_pos = merkle_branch_for_tx_hash(height, txid) + if not branch or not tx_pos: + self._send_error(query['id'], {'message': 'txid not found'}) + self._send_response(query, {'merkle': branch, 'pos': int(tx_pos), + 'block_height': int(height)}) + + elif method == 'blockchain.transaction.id_from_pos': + height = query['params'][0] + tx_pos = int(query['params'][1]) + merkle = query['params'][2] if len(query['params']) > 2 else False + branch, txid = merkle_branch_for_tx_pos(height, tx_pos) + if not txid: + error = {'message': 'could not find txid'} + self._send_error(query['id'], error) + return + if not merkle: + self._send_response(query, txid) + return + self._send_response(query, {'tx_hash': txid, 'merkle': branch}) + + elif method == 'mempool.get_fee_histogram': + # TODO: Implement mempool.get_fee_histogram + self._send_response(query, [[0, 0]]) + + elif method == 'server.add_peer': + self._send_response(query, False) + + elif method == 'server.banner': + self._send_response(query, BANNER) + + elif method == 'server.donation_address': + self._send_response(query, DONATION_ADDR) + + elif method == 'server.features': + ret = { + 'genesis_hash': self.genesis, + 'hosts': { + 'localhost': {'tcp_port': None, 'ssl_port': 50002}, + }, + 'protocol_max': SERVER_PROTO_MAX, + 'protocol_min': SERVER_PROTO_MIN, + 'pruning': None, + 'server_version': 'electrum-obelisk %s' % VERSION, + 'hash_function': 'sha256', + } + self._send_response(query, ret) + + elif method == 'server.peers.subscribe': + # No peers to report + self._send_response(query, []) + + elif method == 'server.ping': + self._send_response(query, None) + + elif method == 'server.version': + if self.version_called: + self.log.warning('Got a subsequent %s call', method) + return + client_ver = query['params'][1] + if isinstance(client_ver, list): + client_min, client_max = client_ver[0], client_ver[1] + else: + client_min = client_max = client_ver + version = min(client_max, SERVER_PROTO_MAX) + if version < max(client_min, SERVER_PROTO_MIN): + self.log.error("Client protocol version %s not supported.", + str(client_ver)) + raise ConnectionRefusedError() + # self.version_called = True + self._send_response(query, ['electrum-obelisk %s' % VERSION, + version]) + + else: + self.log.error('BUG: Not handling method: "%s" query=%s', + method, query) diff --git a/electrumobelisk/query.py b/electrumobelisk/query.py @@ -0,0 +1,78 @@ +#!/usr/bin/env python3 +# electrum-obelisk +# Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org> +# +# 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 <http://www.gnu.org/licenses/>. +""" zmq interfacing """ +from binascii import unhexlify +from struct import pack, unpack + +import zmq + + +def q_fetch_header_by_height(endp, height): + """ Fetch and return a block header at height as raw bytes """ + context = zmq.Context() + socket = context.socket(zmq.REQ) # pylint: disable=E1101 + socket.connect(endp) + socket.send(b'blockchain.fetch_block_header', zmq.SNDMORE) + socket.send(pack('I', 42), zmq.SNDMORE) + socket.send(pack('I', int(height))) + _ = socket.recv() + _ = socket.recv() + response_body = socket.recv() + _ec = unpack('<I', response_body[0:4])[0] + if _ec != 0: + return None + return response_body[4:] + + +def q_fetch_headers_by_height_count(endp, start_height, count): + """ Fetch and return count concatenated headers by height as raw bytes """ + # Implemented to reuse the socket rather than opening a new one + # for each header requested (e.g. by looping q_fetch_header_by_height()). + context = zmq.Context() + socket = context.socket(zmq.REQ) # pylint: disable=E1101 + socket.connect(endp) + _id = 42 + res = bytearray() + for i in range(count): + socket.send(b'blockchain.fetch_block_header', zmq.SNDMORE) + socket.send(pack('I', _id), zmq.SNDMORE) + socket.send(pack('I', start_height+i)) + _ = socket.recv() + _ = socket.recv() + response_body = socket.recv() + _ec = unpack('<I', response_body[0:4])[0] + if not response_body or _ec != 0: + break + res.extend(response_body[4:]) + return res + + +def q_fetch_tx_by_txid(endp, txid): + """ Fetch and return a transaction by txid as raw bytes """ + context = zmq.Context() + socket = context.socket(zmq.REQ) # pylint: disable=E1101 + socket.connect(endp) + socket.send(b'blockchain.fetch_transaction2', zmq.SNDMORE) + socket.send(pack('I', 42), zmq.SNDMORE) + socket.send(unhexlify(txid)[::-1]) + _ = socket.recv() + _ = socket.recv() + response_body = socket.recv() + _ec = unpack('<I', response_body[0:4])[0] + if _ec != 0: + return None + return response_body[4:] diff --git a/obelisk b/obelisk @@ -0,0 +1,232 @@ +#!/usr/bin/env python3 +# electrum-obelisk +# Copyright (C) 2020-2021 Ivan J. <parazyd@dyne.org> +# Copyright (C) 2018-2020 Chris Belcher (MIT License) +# +# 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 <http://www.gnu.org/licenses/>. +""" +Main module for electrum-obelisk server +""" +import ssl +import sys +import socket +from os.path import join, exists +from json import dumps, loads +from json.decoder import JSONDecodeError +from ipaddress import ip_network, ip_address +from tempfile import gettempdir +from configparser import RawConfigParser, NoSectionError +from logging import getLogger, FileHandler, Formatter, StreamHandler, DEBUG +from argparse import ArgumentParser + +from pkg_resources import resource_filename + +from electrumobelisk.bx import bx_raw +from electrumobelisk.protocol import (VERSION, ElectrumProtocol, DONATION_ADDR) + + +def logger_config(log, config): + """ Setup logging """ + fmt = Formatter(config.get('logging', 'log_format', + fallback='%(asctime)s\t%(levelname)s\t%(message)s')) + logstream = StreamHandler() + logstream.setFormatter(fmt) + logstream.setLevel(config.get('logging', 'log_level_stdout', + fallback='DEBUG')) + log.addHandler(logstream) + filename = config.get('logging', 'log_file_location', fallback='') + if len(filename.strip()) == 0: + filename = join(gettempdir(), 'obelisk.log') + logfile = FileHandler(filename, mode=('a' if config.get( + 'logging', 'append_log', fallback='false') else 'w')) + logfile.setFormatter(fmt) + logfile.setLevel(DEBUG) + log.addHandler(logfile) + log.setLevel(DEBUG) + return log, filename + + + +def get_certs(config): + """ Get filepaths to TLS certificate and key """ + certfile = config.get('electrum-obelisk', 'certfile', fallback=None) + keyfile = config.get('electrum-obelisk', 'keyfile', fallback=None) + if (certfile and keyfile) and (exists(certfile) and exists(keyfile)): + return certfile, keyfile + + certfile = resource_filename('electrumobelisk', 'certs/cert.crt') + keyfile = resource_filename('electrumobelisk', 'certs/cert.key') + if exists(certfile) and exists(keyfile): + return certfile, keyfile + + raise ValueError('invalid cert: %s, key: %s' % (certfile, keyfile)) + + +def create_server_socket(hostport): + """ Set up listen socket """ + log = getLogger('electrum-obelisk') + server_sock = socket.socket() + server_sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) + server_sock.bind(hostport) + server_sock.listen(1) + log.info('Listening for clients on %s', str(hostport)) + log.info('Consider donating to electrum-obelisk: %s', DONATION_ADDR) + return server_sock + + +def fill_ip_whitelist(config): + """ Parses configuration option(s) for IP address whitelist """ + ip_w = [] + for i in config.get('electrum-obelisk', 'ip_whitelist').split(' '): + if i == '*': + # Matches everything + ip_w.append(ip_network('0.0.0.0/0')) + ip_w.append(ip_network('::0/0')) + else: + ip_w.append(ip_network(i, strict=False)) + return ip_w + + +def run_electrum_server(config, chain): + """ Basic TLS socket server """ + log = getLogger('electrum-obelisk') + hostport = (config.get('electrum-obelisk', 'host'), + int(config.get('electrum-obelisk', 'port'))) + ip_whitelist = fill_ip_whitelist(config) + + if config.getboolean('electrum-obelisk', 'usetls', fallback=True): + certfile, keyfile = get_certs(config) + log.debug('Using cert: %s, key: %s', certfile, keyfile) + + broadcast_method = config.get('electrum-obelisk', 'broadcast_method', + fallback='own-node') + tor_host = config.get('electrum-obelisk', 'tor_host', fallback='localhost') + tor_port = int(config.get('electrum-obelisk', 'tor_port', fallback=9050)) + tor_hostport = (tor_host, tor_port) + + endpoints = {} + endpoints['query'] = config.get('electrum-obelisk', 'bs_query') + endpoints['heartbeat'] = config.get('electrum-obelisk', 'bs_heartbeat') + endpoints['block'] = config.get('electrum-obelisk', 'bs_block') + endpoints['transaction'] = config.get('electrum-obelisk', 'bs_transaction') + + protocol = ElectrumProtocol(log, chain, endpoints) + + server_sock = create_server_socket(hostport) + # server_sock.settimeout(30) + + while True: + sock = None + while sock is None: + try: + sock, addr = server_sock.accept() + if not any([ip_address(addr[0]) in ipnet + for ipnet in ip_whitelist]): + log.debug('%s not in whitelist. Closing...', str(addr[0])) + raise ConnectionRefusedError() + if config.getboolean('electrum-obelisk', 'usetls', + fallback=True): + sock = ssl.wrap_socket(sock, server_side=True, + certfile=certfile, keyfile=keyfile, + ssl_version=ssl.PROTOCOL_TLS) + log.debug('sock.accept') + except (ConnectionRefusedError, ssl.SSLError, IOError): + sock.close() + sock = None + log.debug('Client connected from %s', str(addr[0])) + + def send_reply_fun(reply): + line = dumps(reply) + sock.sendall(line.encode('utf-8') + b'\n') + log.debug('<= %s', line) + protocol.set_send_reply_fun(send_reply_fun) + + try: + #sock.settimeout(5) + recv_buffer = bytearray() + while True: + # Loop for replying to client queries + try: + recv_data = sock.recv(4096) + if not recv_data or len(recv_data) == 0: + raise EOFError() + recv_buffer.extend(recv_data) + _lb = recv_buffer.find(b'\n') + if _lb == -1: + continue + while _lb != -1: + line = recv_buffer[:_lb].rstrip() + recv_buffer = recv_buffer[_lb + 1:] + _lb = recv_buffer.find(b'\n') + try: + line = line.decode('utf-8') + query = loads(line) + except (UnicodeDecodeError, JSONDecodeError) as err: + raise IOError from repr(err) + log.debug('=> %s', line) + protocol.handle_query(query) + except socket.timeout: + log.debug('Socket timeout reached') + except(IOError, EOFError) as err: + if isinstance(err, (EOFError, ConnectionRefusedError)): + log.debug('Client disconnected') + else: + log.debug('IOError: %s', repr(err)) + try: + if sock is not None: + sock.close() + except IOError: + pass + protocol.on_disconnect() + +def main(): + """ Main orchestration """ + parser = ArgumentParser(description='electrum-obelisk %s' % VERSION) + parser.add_argument('config_file', help='Path to config file') + parser.add_argument('-v', '--version', action='version', + version='electrum-obelisk %s' % VERSION) + args = parser.parse_args() + + try: + config = RawConfigParser() + config.read(args.config_file) + config.options('electrum-obelisk') + except NoSectionError: + print(f'Error: Nonexistent config file {args.config_file}') + return 1 + + log = getLogger('electrum-obelisk') + log, logfilename = logger_config(log, config) + log.info('Starting electrum-obelisk %s' % VERSION) + log.info('Logging to %s' % logfilename) + + chain = config.get('electrum-obelisk', 'chain') + if chain not in ['mainnet', 'regtest', 'testnet']: + log.error('"chain" is not one of "mainnet", "regtest", or "testnet"') + return 1 + + if not bx_raw(['fetch-height']): + log.error("Couldn't use bx fetch-height. Please check your bx config") + return 1 + + try: + run_electrum_server(config, chain) + except KeyboardInterrupt: + log.info('Got KeyboardInterrupt, exiting...') + return 1 + return 0 + + +if __name__ == '__main__': + sys.exit(main()) diff --git a/res/obelisk.png b/res/obelisk.png Binary files differ.