diff --git a/.env.example b/.env.example index d591125..5a94918 100644 --- a/.env.example +++ b/.env.example @@ -2,4 +2,5 @@ BITCOIN_RPC_URL=http://192.168.1.100 BITCOIN_RPC_USER= BITCOIN_RPC_PASSWORD= BITCOIN_RPC_PORT=8332 -BITCOIN_RPC_TIMEOUT=10000 \ No newline at end of file +BITCOIN_RPC_TIMEOUT=10000 +PORT=3333 \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt index 0b76b8a..e72bfdd 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,21 +1,674 @@ -MIT License + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Copyright (c) 2023 johnny9 + 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. -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: + Preamble -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. + The GNU General Public License is a free, copyleft license for +software and other kinds of works. -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. + 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 +. \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index d8efb6c..72f3542 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,6 +22,7 @@ "class-transformer": "^0.5.1", "class-validator": "^0.14.0", "merkletreejs": "^0.3.10", + "promise-socket": "^7.0.0", "reflect-metadata": "^0.1.13", "rpc-bitcoin": "^2.0.0", "rxjs": "^7.2.0", @@ -3962,6 +3963,16 @@ "integrity": "sha512-LDx6oHrK+PhzLKJU9j5S7/Y3jM/mUHvD/DeI1WQmJn652iPC5Y4TBzC9l+5OMOXlyTTA+SmVUPm0HQUwpD5Jqw==", "dev": true }, + "node_modules/core-js": { + "version": "3.31.0", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.31.0.tgz", + "integrity": "sha512-NIp2TQSGfR6ba5aalZD+ZQ1fSxGhDo/s1w0nx3RYzf2pnJxt7YynxFlFScP6eV7+GZsKO95NSjGxyJsU3DZgeQ==", + "hasInstallScript": true, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/core-js" + } + }, "node_modules/core-util-is": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", @@ -8265,12 +8276,36 @@ "resolved": "https://registry.npmjs.org/process-warning/-/process-warning-2.2.0.tgz", "integrity": "sha512-/1WZ8+VQjR6avWOgHeEPd7SDQmFQ1B5mC1eRXsCm5TarlNmx/wCsa5GEaxGm05BORRtyG/Ex/3xq3TuRvq57qg==" }, + "node_modules/promise-duplex": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/promise-duplex/-/promise-duplex-6.0.0.tgz", + "integrity": "sha512-ZL7rquzjTFzInDBeWYcsT+qddolNvzigahk6MI6qLSbQvlyRRCJkU3JztgaVunzvkH28smRa2Qu/cY9RXtSkgA==", + "dependencies": { + "core-js": "^3.6.5", + "promise-readable": "^6.0.0", + "promise-writable": "^6.0.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, "node_modules/promise-inflight": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/promise-inflight/-/promise-inflight-1.0.1.tgz", "integrity": "sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==", "optional": true }, + "node_modules/promise-readable": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/promise-readable/-/promise-readable-6.0.0.tgz", + "integrity": "sha512-5NxtmUswijvX5cAM0zPSy6yiCXH/eKBpiiBq6JfAUrmngMquMbzcBhF2qA+ocs4rYYKdvAfv3cOvZxADLtL1CA==", + "dependencies": { + "core-js": "^3.6.5" + }, + "engines": { + "node": ">=10.0.0" + } + }, "node_modules/promise-retry": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", @@ -8284,6 +8319,26 @@ "node": ">=10" } }, + "node_modules/promise-socket": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/promise-socket/-/promise-socket-7.0.0.tgz", + "integrity": "sha512-Oic9BrxmcHOPEnzKp2Js+ehFyvsbd0WxsE5khweCTHuRvdzbXjHUZmSDT6F9TW8SIkAJ0lCzoHjMYnb0WQJPiw==", + "dependencies": { + "promise-duplex": "^6.0.0", + "tslib": "^2.0.1" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/promise-writable": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/promise-writable/-/promise-writable-6.0.0.tgz", + "integrity": "sha512-b81zre/itgJFS7dwWzIdKNVVqvLiUxYRS/wolUB0H1YY/tAaS146XGKa4Q/5wCbsnXLyn0MCeV6f8HHe4iUHLg==", + "engines": { + "node": ">=10.0.0" + } + }, "node_modules/prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -13439,6 +13494,11 @@ "integrity": "sha512-LDx6oHrK+PhzLKJU9j5S7/Y3jM/mUHvD/DeI1WQmJn652iPC5Y4TBzC9l+5OMOXlyTTA+SmVUPm0HQUwpD5Jqw==", "dev": true }, + "core-js": { + "version": "3.31.0", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.31.0.tgz", + "integrity": "sha512-NIp2TQSGfR6ba5aalZD+ZQ1fSxGhDo/s1w0nx3RYzf2pnJxt7YynxFlFScP6eV7+GZsKO95NSjGxyJsU3DZgeQ==" + }, "core-util-is": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", @@ -16750,12 +16810,30 @@ "resolved": "https://registry.npmjs.org/process-warning/-/process-warning-2.2.0.tgz", "integrity": "sha512-/1WZ8+VQjR6avWOgHeEPd7SDQmFQ1B5mC1eRXsCm5TarlNmx/wCsa5GEaxGm05BORRtyG/Ex/3xq3TuRvq57qg==" }, + "promise-duplex": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/promise-duplex/-/promise-duplex-6.0.0.tgz", + "integrity": "sha512-ZL7rquzjTFzInDBeWYcsT+qddolNvzigahk6MI6qLSbQvlyRRCJkU3JztgaVunzvkH28smRa2Qu/cY9RXtSkgA==", + "requires": { + "core-js": "^3.6.5", + "promise-readable": "^6.0.0", + "promise-writable": "^6.0.0" + } + }, "promise-inflight": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/promise-inflight/-/promise-inflight-1.0.1.tgz", "integrity": "sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==", "optional": true }, + "promise-readable": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/promise-readable/-/promise-readable-6.0.0.tgz", + "integrity": "sha512-5NxtmUswijvX5cAM0zPSy6yiCXH/eKBpiiBq6JfAUrmngMquMbzcBhF2qA+ocs4rYYKdvAfv3cOvZxADLtL1CA==", + "requires": { + "core-js": "^3.6.5" + } + }, "promise-retry": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", @@ -16766,6 +16844,20 @@ "retry": "^0.12.0" } }, + "promise-socket": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/promise-socket/-/promise-socket-7.0.0.tgz", + "integrity": "sha512-Oic9BrxmcHOPEnzKp2Js+ehFyvsbd0WxsE5khweCTHuRvdzbXjHUZmSDT6F9TW8SIkAJ0lCzoHjMYnb0WQJPiw==", + "requires": { + "promise-duplex": "^6.0.0", + "tslib": "^2.0.1" + } + }, + "promise-writable": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/promise-writable/-/promise-writable-6.0.0.tgz", + "integrity": "sha512-b81zre/itgJFS7dwWzIdKNVVqvLiUxYRS/wolUB0H1YY/tAaS146XGKa4Q/5wCbsnXLyn0MCeV6f8HHe4iUHLg==" + }, "prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", diff --git a/package.json b/package.json index 1be334a..7a43d44 100644 --- a/package.json +++ b/package.json @@ -33,6 +33,7 @@ "class-transformer": "^0.5.1", "class-validator": "^0.14.0", "merkletreejs": "^0.3.10", + "promise-socket": "^7.0.0", "reflect-metadata": "^0.1.13", "rpc-bitcoin": "^2.0.0", "rxjs": "^7.2.0", diff --git a/src/ORM/client-statistics/client-statistics.entity.ts b/src/ORM/client-statistics/client-statistics.entity.ts index 35632f8..00ca477 100644 --- a/src/ORM/client-statistics/client-statistics.entity.ts +++ b/src/ORM/client-statistics/client-statistics.entity.ts @@ -1,4 +1,4 @@ -import { Column, Entity, Index, PrimaryGeneratedColumn } from 'typeorm'; +import { Column, Entity, Index, PrimaryColumn } from 'typeorm'; import { DateTimeTransformer } from '../utils/DateTimeTransformer'; import { TrackedEntity } from '../utils/TrackedEntity.entity'; @@ -6,8 +6,8 @@ import { TrackedEntity } from '../utils/TrackedEntity.entity'; @Entity() export class ClientStatisticsEntity extends TrackedEntity { - @PrimaryGeneratedColumn() - id: number; + @PrimaryColumn({ length: 64, type: 'varchar' }) + submissionHash: string; @Column({ length: 62, type: 'varchar' }) address: string; diff --git a/src/main.ts b/src/main.ts index 648ecab..c32f304 100644 --- a/src/main.ts +++ b/src/main.ts @@ -6,6 +6,12 @@ import { AppModule } from './app.module'; async function bootstrap() { + if (process.env.PORT == null) { + console.error('It appears your environment is not configured, create and populate an .env file.'); + return; + } + + const app = await NestFactory.create(AppModule, new FastifyAdapter()); app.setGlobalPrefix('api') app.useGlobalPipes( diff --git a/src/models/MiningJob.ts b/src/models/MiningJob.ts index 5214624..7ac6668 100644 --- a/src/models/MiningJob.ts +++ b/src/models/MiningJob.ts @@ -12,17 +12,18 @@ interface AddressObject { } export class MiningJob { + private coinbasePart1: string; + private coinbasePart2: string; + private merkle_branch: string[]; // List of hashes, will be used for calculation of merkle root. This is not a list of all transactions, it only contains prepared hashes of steps of merkle tree algorithm. public jobId: string; // ID of the job. Use this ID while submitting share generated from this job. - public response: string; public block: bitcoinjs.Block = new bitcoinjs.Block(); public networkDifficulty: number; constructor(id: string, payoutInformation: AddressObject[], public blockTemplate: IBlockTemplate, public clean_jobs: boolean) { this.jobId = id; - //this.target = blockTemplate.target; this.block.prevHash = this.convertToLittleEndian(blockTemplate.previousblockhash); this.block.version = blockTemplate.version; @@ -51,7 +52,8 @@ export class MiningJob { // 32-byte - Commitment hash: Double-SHA256(witness root hash|witness reserved value) const commitmentHash = this.sha256(this.sha256(this.block.witnessCommit)); // 39th byte onwards: Optional data with no consensus meaning - coinbaseTransaction.ins[0].script = bitcoinjs.script.compile([bitcoinjs.opcodes.OP_RETURN, Buffer.concat([blockHeightScript, segwitMagicBits, commitmentHash, Buffer.from('00000000' + '00000000', 'hex')])]); + coinbaseTransaction.ins[0].script = bitcoinjs.script.compile([bitcoinjs.opcodes.OP_RETURN, Buffer.concat([blockHeightScript, Buffer.from('00000000' + '00000000', 'hex')])]); + coinbaseTransaction.addOutput(bitcoinjs.script.compile([bitcoinjs.opcodes.OP_RETURN, Buffer.concat([segwitMagicBits, commitmentHash])]), 0); // get the non-witness coinbase tx //@ts-ignore @@ -63,8 +65,8 @@ export class MiningJob { const coinbasePart1 = serializedCoinbaseTx.slice(0, partOneIndex); const coinbasePart2 = serializedCoinbaseTx.slice(partOneIndex); - const coinb1 = coinbasePart1.slice(0, coinbasePart1.length - 16); - const coinb2 = coinbasePart2; + this.coinbasePart1 = coinbasePart1.slice(0, coinbasePart1.length - 16); + this.coinbasePart2 = coinbasePart2; // Calculate merkle branch @@ -75,18 +77,15 @@ export class MiningJob { this.block.transactions[0] = coinbaseTransaction; - this.constructResponse(coinb1, coinb2); - } - public copyAndUpdateBlock(versionMaskString: number, nonce: number, extraNonce: string, extraNonce2: string, timestamp: number): bitcoinjs.Block { + public copyAndUpdateBlock(versionMask: number, nonce: number, extraNonce: string, extraNonce2: string, timestamp: number): bitcoinjs.Block { const testBlock = bitcoinjs.Block.fromBuffer(this.block.toBuffer()); testBlock.nonce = nonce; // recompute version mask - const versionMask = versionMaskString; if (versionMask !== undefined && versionMask != 0) { testBlock.version = (testBlock.version ^ versionMask); } @@ -131,8 +130,6 @@ export class MiningJob { // Set the version of the transaction coinbaseTransaction.version = 2; - - // Add the coinbase input (input with no previous output) coinbaseTransaction.addInput(Buffer.from('0000000000000000000000000000000000000000000000000000000000000000', 'hex'), 0xffffffff, 0xffffffff); @@ -145,7 +142,7 @@ export class MiningJob { coinbaseTransaction.addOutput(this.getPaymentScript(recipientAddress.address), amount); }) - //Add any remaining sats from the Math.floor + //Add any remaining sats from the Math.floor coinbaseTransaction.outs[0].value += rewardBalance; const segwitWitnessReservedValue = Buffer.alloc(32, 0); @@ -160,7 +157,7 @@ export class MiningJob { const addressInfo = getAddressInfo(address); switch (addressInfo.type) { case AddressType.p2wpkh: { - return bitcoinjs.payments.p2wpkh({ address, network: bitcoinjs.networks.testnet }).output; + return bitcoinjs.payments.p2wpkh({ address }).output; } case AddressType.p2pkh: { return bitcoinjs.payments.p2pkh({ address }).output; @@ -185,7 +182,7 @@ export class MiningJob { } - private constructResponse(coinb1: string, coinb2: string) { + public response(): string { const job = { id: null, @@ -193,8 +190,8 @@ export class MiningJob { params: [ this.jobId, this.swapEndianWords(this.block.prevHash).toString('hex'), - coinb1, - coinb2, + this.coinbasePart1, + this.coinbasePart2, this.merkle_branch, this.block.version.toString(16), this.block.bits.toString(16), @@ -203,7 +200,7 @@ export class MiningJob { ] }; - this.response = JSON.stringify(job); + return JSON.stringify(job) + '\n'; } diff --git a/src/models/StratumV1Client.ts b/src/models/StratumV1Client.ts index 975e6cb..c6ee444 100644 --- a/src/models/StratumV1Client.ts +++ b/src/models/StratumV1Client.ts @@ -3,6 +3,7 @@ import { plainToInstance } from 'class-transformer'; import { validate, ValidatorOptions } from 'class-validator'; import * as crypto from 'crypto'; import { Socket } from 'net'; +import PromiseSocket from 'promise-socket'; import { combineLatest, firstValueFrom, interval, startWith, takeUntil } from 'rxjs'; import { ClientStatisticsService } from '../ORM/client-statistics/client-statistics.service'; @@ -11,7 +12,7 @@ import { ClientService } from '../ORM/client/client.service'; import { BitcoinRpcService } from '../services/bitcoin-rpc.service'; import { BlockTemplateService } from '../services/block-template.service'; import { StratumV1JobsService } from '../services/stratum-v1-jobs.service'; -import { EasyUnsubscribe } from '../utils/AutoUnsubscribe'; +import { EasyUnsubscribe } from '../utils/EasyUnsubscribe'; import { IBlockTemplate } from './bitcoin-rpc/IBlockTemplate'; import { eRequestMethod } from './enums/eRequestMethod'; import { eResponseMethod } from './enums/eResponseMethod'; @@ -25,8 +26,6 @@ import { SubscriptionMessage } from './stratum-messages/SubscriptionMessage'; import { SuggestDifficulty } from './stratum-messages/SuggestDifficultyMessage'; import { StratumV1ClientStatistics } from './StratumV1ClientStatistics'; - - export class StratumV1Client extends EasyUnsubscribe { private clientSubscription: SubscriptionMessage; @@ -43,7 +42,7 @@ export class StratumV1Client extends EasyUnsubscribe { public extraNonce: string; constructor( - public readonly socket: Socket, + public readonly promiseSocket: PromiseSocket, private readonly stratumV1JobsService: StratumV1JobsService, private readonly blockTemplateService: BlockTemplateService, private readonly bitcoinRpcService: BitcoinRpcService, @@ -57,7 +56,12 @@ export class StratumV1Client extends EasyUnsubscribe { console.log(`New client ID: : ${this.extraNonce}`); - this.socket.on('data', this.handleData.bind(this, this.socket)); + this.promiseSocket.socket.on('data', (data: Buffer) => { + data.toString() + .split('\n') + .filter(m => m.length > 0) + .forEach(m => this.handleMessage(m)) + }); } @@ -68,17 +72,8 @@ export class StratumV1Client extends EasyUnsubscribe { return hexString; } - private async handleData(socket: Socket, data: Buffer) { - const message = data.toString(); - message.split('\n') - .filter(m => m.length > 0) - .forEach(this.handleMessage.bind(this, socket)); - - } - - - private async handleMessage(socket: Socket, message: string) { + private async handleMessage(message: string) { console.log('Received:', message); // Parse the message and check if it's the initial subscription message @@ -87,7 +82,7 @@ export class StratumV1Client extends EasyUnsubscribe { parsedMessage = JSON.parse(message); } catch (e) { console.log(e); - this.socket.end(); + this.promiseSocket.end(); } switch (parsedMessage.method) { @@ -107,18 +102,15 @@ export class StratumV1Client extends EasyUnsubscribe { if (errors.length === 0) { this.clientSubscription = subscriptionMessage; - socket.write(JSON.stringify(this.clientSubscription.response(this.extraNonce)) + '\n'); + await this.promiseSocket.write(JSON.stringify(this.clientSubscription.response(this.extraNonce)) + '\n'); } else { - const err = new StratumErrorMessage( subscriptionMessage.id, eStratumErrorCode.OtherUnknown, 'Subscription error', errors).response(); - console.error(err); - socket.write(err); - + await this.promiseSocket.write(err); } break; @@ -140,9 +132,15 @@ export class StratumV1Client extends EasyUnsubscribe { if (errors.length === 0) { this.clientConfiguration = configurationMessage; //const response = this.buildSubscriptionResponse(configurationMessage.id); - socket.write(JSON.stringify(this.clientConfiguration.response()) + '\n'); + await this.promiseSocket.write(JSON.stringify(this.clientConfiguration.response()) + '\n'); } else { - console.error(errors); + const err = new StratumErrorMessage( + configurationMessage.id, + eStratumErrorCode.OtherUnknown, + 'Configuration error', + errors).response(); + console.error(err); + await this.promiseSocket.write(err); } break; @@ -164,9 +162,15 @@ export class StratumV1Client extends EasyUnsubscribe { this.clientAuthorization = authorizationMessage; //const response = this.buildSubscriptionResponse(authorizationMessage.id); - socket.write(JSON.stringify(this.clientAuthorization.response()) + '\n'); + await this.promiseSocket.write(JSON.stringify(this.clientAuthorization.response()) + '\n'); } else { - console.error(errors); + const err = new StratumErrorMessage( + authorizationMessage.id, + eStratumErrorCode.OtherUnknown, + 'Authorization error', + errors).response(); + console.error(err); + await this.promiseSocket.write(err); } break; @@ -192,10 +196,16 @@ export class StratumV1Client extends EasyUnsubscribe { this.clientSuggestedDifficulty = suggestDifficultyMessage; this.sessionDifficulty = suggestDifficultyMessage.suggestedDifficulty; - socket.write(JSON.stringify(this.clientSuggestedDifficulty.response(this.sessionDifficulty)) + '\n'); + await this.promiseSocket.write(JSON.stringify(this.clientSuggestedDifficulty.response(this.sessionDifficulty)) + '\n'); this.usedSuggestedDifficulty = true; } else { - console.error(errors); + const err = new StratumErrorMessage( + suggestDifficultyMessage.id, + eStratumErrorCode.OtherUnknown, + 'Suggest difficulty error', + errors).response(); + console.error(err); + await this.promiseSocket.write(err); } break; } @@ -214,11 +224,17 @@ export class StratumV1Client extends EasyUnsubscribe { if (errors.length === 0) { await this.handleMiningSubmission(miningSubmitMessage); - socket.write(JSON.stringify(miningSubmitMessage.response()) + '\n'); + await this.promiseSocket.write(JSON.stringify(miningSubmitMessage.response()) + '\n'); } else { - console.error(errors); + const err = new StratumErrorMessage( + miningSubmitMessage.id, + eStratumErrorCode.OtherUnknown, + 'Suggest difficulty error', + errors).response(); + console.error(err); + await this.promiseSocket.write(err); } break; } @@ -233,7 +249,7 @@ export class StratumV1Client extends EasyUnsubscribe { if (this.clientSuggestedDifficulty == null) { console.log(`Setting difficulty to ${this.sessionDifficulty}`) const setDifficulty = JSON.stringify(new SuggestDifficulty().response(this.sessionDifficulty)); - this.socket.write(setDifficulty + '\n'); + await this.promiseSocket.write(setDifficulty + '\n'); } this.stratumInitialized = true; @@ -264,7 +280,7 @@ export class StratumV1Client extends EasyUnsubscribe { lastIntervalCount = interValCount; - this.sendNewMiningJob(blockTemplate, clearJobs); + await this.sendNewMiningJob(blockTemplate, clearJobs); await this.checkDifficulty(); @@ -274,7 +290,7 @@ export class StratumV1Client extends EasyUnsubscribe { } } - private sendNewMiningJob(blockTemplate: IBlockTemplate, clearJobs: boolean) { + private async sendNewMiningJob(blockTemplate: IBlockTemplate, clearJobs: boolean) { // const payoutInformation = [ // { address: 'bc1q99n3pu025yyu0jlywpmwzalyhm36tg5u37w20d', percent: 1.8 }, @@ -288,10 +304,9 @@ export class StratumV1Client extends EasyUnsubscribe { const job = new MiningJob(this.stratumV1JobsService.getNextId(), payoutInformation, blockTemplate, clearJobs); this.stratumV1JobsService.addJob(job, clearJobs); + ; - const data = job.response + '\n'; - - this.socket.write(data); + await this.promiseSocket.write(job.response()); console.log(`Sent new job to ${this.extraNonce}. (clearJobs: ${clearJobs})`) @@ -301,9 +316,14 @@ export class StratumV1Client extends EasyUnsubscribe { private async handleMiningSubmission(submission: MiningSubmitMessage) { const job = this.stratumV1JobsService.getJobById(submission.jobId); - // a miner may submit a job that doesn't exist anymore if it was removed by a new block notification + // a miner may submit a job that doesn't exist anymore if it was removed by a new block notification if (job == null) { - console.log('job not found') + const err = new StratumErrorMessage( + submission.id, + eStratumErrorCode.JobNotFound, + 'Job not found').response(); + console.error(err); + await this.promiseSocket.write(err); return; } const updatedJobBlock = job.copyAndUpdateBlock( @@ -313,7 +333,7 @@ export class StratumV1Client extends EasyUnsubscribe { submission.extraNonce2, parseInt(submission.ntime, 16) ); - const submissionDifficulty = this.calculateDifficulty(updatedJobBlock.toBuffer(true)); + const { submissionDifficulty, submissionHash } = this.calculateDifficulty(updatedJobBlock.toBuffer(true)); console.log(`DIFF: ${Math.round(submissionDifficulty)} of ${this.sessionDifficulty} from ${this.clientAuthorization.worker + '.' + this.extraNonce}`); @@ -324,15 +344,30 @@ export class StratumV1Client extends EasyUnsubscribe { const blockHex = updatedJobBlock.toHex(false); this.bitcoinRpcService.SUBMIT_BLOCK(blockHex); } + try { + await this.statistics.addSubmission(this.entity, submissionHash, this.sessionDifficulty); + } catch (e) { + const err = new StratumErrorMessage( + submission.id, + eStratumErrorCode.DuplicateShare, + 'Duplicate share').response(); + console.error(err); + await this.promiseSocket.write(err); - await this.statistics.addSubmission(this.entity, this.sessionDifficulty); - if (submissionDifficulty > this.entity.bestDifficulty) { - await this.clientService.updateBestDifficulty(this.extraNonce, submissionDifficulty); - this.entity.bestDifficulty = submissionDifficulty; + if (submissionDifficulty > this.entity.bestDifficulty) { + await this.clientService.updateBestDifficulty(this.extraNonce, submissionDifficulty); + this.entity.bestDifficulty = submissionDifficulty; + } } } else { - console.log(`Difficulty too low`); + const err = new StratumErrorMessage( + submission.id, + eStratumErrorCode.LowDifficultyShare, + 'Difficulty too low').response(); + console.error(err); + await this.promiseSocket.write(err); + } await this.checkDifficulty(); @@ -355,19 +390,16 @@ export class StratumV1Client extends EasyUnsubscribe { params: [targetDiff] }) + '\n'; - this.socket.write(data); + await this.promiseSocket.write(data); // we need to clear the jobs so that the difficulty set takes effect. Otherwise the different miner implementations can cause issues const { blockTemplate } = await firstValueFrom(this.blockTemplateService.currentBlockTemplate$); - this.sendNewMiningJob(blockTemplate, true); - - - + await this.sendNewMiningJob(blockTemplate, true); } } - public calculateDifficulty(header: Buffer): number { + public calculateDifficulty(header: Buffer): { submissionDifficulty: number, submissionHash: string } { const hashBuffer: Buffer = crypto.createHash('sha256').update(header).digest(); const hashResult: Buffer = crypto.createHash('sha256').update(hashBuffer).digest(); @@ -375,7 +407,8 @@ export class StratumV1Client extends EasyUnsubscribe { let s64 = this.le256todouble(hashResult); const truediffone = Big('26959535291011309493156476344723991336010898738574164086137773096960'); - return truediffone.div(s64.toString()).toNumber(); + const difficulty = truediffone.div(s64.toString()).toNumber(); + return { submissionDifficulty: difficulty, submissionHash: hashResult.toString('hex') }; } diff --git a/src/models/StratumV1ClientStatistics.ts b/src/models/StratumV1ClientStatistics.ts index e18aaa8..74a1ba9 100644 --- a/src/models/StratumV1ClientStatistics.ts +++ b/src/models/StratumV1ClientStatistics.ts @@ -12,7 +12,7 @@ export class StratumV1ClientStatistics { this.submissionCacheStart = new Date(); } - public async addSubmission(client: ClientEntity, targetDifficulty: number) { + public async addSubmission(client: ClientEntity, submissionHash: string, targetDifficulty: number) { if (this.submissionCache.length > CACHE_SIZE) { this.submissionCache.shift(); @@ -29,6 +29,7 @@ export class StratumV1ClientStatistics { address: client.address, clientName: client.clientName, sessionId: client.sessionId, + submissionHash }); } @@ -37,7 +38,7 @@ export class StratumV1ClientStatistics { // miner hasn't submitted shares in one minute if (this.submissionCache.length == 0 && (new Date().getTime() - this.submissionCacheStart.getTime()) / 1000 > 60) { - return this.blpo2(clientDifficulty >> 1); + return this.nearestPowerOfTwo(clientDifficulty >> 1); } if (this.submissionCache.length < CACHE_SIZE) { @@ -55,15 +56,14 @@ export class StratumV1ClientStatistics { const targetDifficulty = difficultyPerSecond * TARGET_SUBMISSION_PER_SECOND; if (clientDifficulty << 1 < targetDifficulty || clientDifficulty >> 1 > targetDifficulty) { - return this.blpo2(targetDifficulty) + return this.nearestPowerOfTwo(targetDifficulty) } return null; - } - private blpo2(val) { + private nearestPowerOfTwo(val) { let x = val | (val >> 1); x = x | (x >> 2); x = x | (x >> 4); @@ -86,5 +86,4 @@ export class StratumV1ClientStatistics { return res; } - } \ No newline at end of file diff --git a/src/models/stratum-messages/StratumErrorMessage.ts b/src/models/stratum-messages/StratumErrorMessage.ts index 8cddc75..4b789de 100644 --- a/src/models/stratum-messages/StratumErrorMessage.ts +++ b/src/models/stratum-messages/StratumErrorMessage.ts @@ -8,7 +8,7 @@ export class StratumErrorMessage { private id: number = null, private errorCode: eStratumErrorCode, private errorMessage: string, - private validationErrors: ValidationError[] + private validationErrors: ValidationError[] = [] ) { } diff --git a/src/services/bitcoin-rpc.service.ts b/src/services/bitcoin-rpc.service.ts index 49260e3..9073ae3 100644 --- a/src/services/bitcoin-rpc.service.ts +++ b/src/services/bitcoin-rpc.service.ts @@ -6,8 +6,6 @@ import { BehaviorSubject, filter } from 'rxjs'; import { IBlockTemplate } from '../models/bitcoin-rpc/IBlockTemplate'; import { IMiningInfo } from '../models/bitcoin-rpc/IMiningInfo'; - - @Injectable() export class BitcoinRpcService { @@ -25,10 +23,8 @@ export class BitcoinRpcService { this.client = new RPCClient({ url, port, timeout, user, pass }); - console.log('Bitcoin RPC connected'); - // Maybe use ZeroMQ ? setInterval(async () => { const miningInfo = await this.getMiningInfo(); @@ -37,16 +33,12 @@ export class BitcoinRpcService { this._newBlock$.next(miningInfo); this.blockHeight = miningInfo.blocks; - } }, 500); - } - - public async getBlockTemplate(): Promise { const result: IBlockTemplate = await this.client.getblocktemplate({ diff --git a/src/services/stratum-v1.service.ts b/src/services/stratum-v1.service.ts index 2c6bd76..8e6c3ad 100644 --- a/src/services/stratum-v1.service.ts +++ b/src/services/stratum-v1.service.ts @@ -1,5 +1,6 @@ import { Injectable, OnModuleInit } from '@nestjs/common'; import { Server, Socket } from 'net'; +import { PromiseSocket } from 'promise-socket'; import { StratumV1Client } from '../models/StratumV1Client'; import { ClientStatisticsService } from '../ORM/client-statistics/client-statistics.service'; @@ -12,8 +13,6 @@ import { StratumV1JobsService } from './stratum-v1-jobs.service'; @Injectable() export class StratumV1Service implements OnModuleInit { - // public clients: StratumV1Client[] = []; - constructor( private readonly bitcoinRpcService: BitcoinRpcService, private readonly blockTemplateService: BlockTemplateService, @@ -29,38 +28,36 @@ export class StratumV1Service implements OnModuleInit { await this.clientService.deleteAll(); this.startSocketServer(); - } private startSocketServer() { - new Server(async (socket: Socket) => { + new Server(async (s: Socket) => { + const promiseSocket = new PromiseSocket(s); - const client = new StratumV1Client(socket, new StratumV1JobsService(), this.blockTemplateService, this.bitcoinRpcService, this.clientService, this.clientStatisticsService); + const client = new StratumV1Client(promiseSocket, new StratumV1JobsService(), this.blockTemplateService, this.bitcoinRpcService, this.clientService, this.clientStatisticsService); const clientCount = await this.clientService.connectedClientCount(); - //this.clients.push(client); + console.log(`New client connected: ${promiseSocket.socket.remoteAddress}, ${clientCount} total clients`); - console.log(`New client connected: ${socket.remoteAddress}, ${clientCount} total clients`); - - socket.on('end', async () => { + promiseSocket.socket.on('end', async (error: Error) => { // Handle socket disconnection client.destroy(); await this.clientService.delete(client.extraNonce); const clientCount = await this.clientService.connectedClientCount(); - console.log(`Client disconnected: ${socket.remoteAddress}, ${clientCount} total clients`); + console.log(`Client disconnected: ${promiseSocket.socket.remoteAddress}, ${clientCount} total clients`); }); - socket.on('error', async (error: Error) => { + promiseSocket.socket.on('error', async (error: Error) => { client.destroy(); await this.clientService.delete(client.extraNonce); const clientCount = await this.clientService.connectedClientCount(); console.error(`Socket error:`, error); - console.log(`Client disconnected: ${socket.remoteAddress}, ${clientCount} total clients`); + console.log(`Client disconnected: ${promiseSocket.socket.remoteAddress}, ${clientCount} total clients`); }); @@ -70,6 +67,4 @@ export class StratumV1Service implements OnModuleInit { } - - } \ No newline at end of file diff --git a/src/utils/AutoUnsubscribe.ts b/src/utils/EasyUnsubscribe.ts similarity index 100% rename from src/utils/AutoUnsubscribe.ts rename to src/utils/EasyUnsubscribe.ts